blob: 026bf2f6f5f282f87ad9201fa5cf3d698e8a1ea4 [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>
Linus Torvalds1da177e2005-04-16 15:20:36 -070093#include <linux/device.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070094#include <linux/wait.h>
95#include <linux/bitops.h>
Domen Puncerb20f3ae2005-06-25 14:58:42 -070096#include <linux/delay.h>
Alan Coxa352def2008-07-16 21:53:12 +010097#include <linux/seq_file.h>
Alan Coxd281da72010-09-16 18:21:24 +010098#include <linux/serial.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
Jiri Slabyacfa7472010-11-29 10:16:54 +0100561 /* some functions below drop BTM, so we need this bit */
562 set_bit(TTY_HUPPING, &tty->flags);
563
Arnd Bergmannec79d602010-06-01 22:53:01 +0200564 /* inuse_filps is protected by the single tty lock,
565 this really needs to change if we want to flush the
566 workqueue with the lock held */
Arnd Bergmann11dbf202010-06-18 14:58:07 +0200567 check_tty_count(tty, "tty_hangup");
Alan Cox36ba7822009-11-30 13:18:51 +0000568
Nick Pigginee2ffa02010-08-18 04:37:35 +1000569 spin_lock(&tty_files_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700570 /* This breaks for file handles being sent over AF_UNIX sockets ? */
Nick Piggind996b622010-08-18 04:37:36 +1000571 list_for_each_entry(priv, &tty->tty_files, list) {
572 filp = priv->file;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700573 if (filp->f_op->write == redirected_tty_write)
574 cons_filp = filp;
575 if (filp->f_op->write != tty_write)
576 continue;
577 closecount++;
Arnd Bergmannec79d602010-06-01 22:53:01 +0200578 __tty_fasync(-1, filp, 0); /* can't block */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700579 filp->f_op = &hung_up_tty_fops;
580 }
Nick Pigginee2ffa02010-08-18 04:37:35 +1000581 spin_unlock(&tty_files_lock);
Alan Cox37bdfb02008-02-08 04:18:47 -0800582
Jiri Slabyacfa7472010-11-29 10:16:54 +0100583 /*
584 * it drops BTM and thus races with reopen
585 * we protect the race by TTY_HUPPING
586 */
Alan Coxc65c9bc2009-06-11 12:50:12 +0100587 tty_ldisc_hangup(tty);
Alan Cox37bdfb02008-02-08 04:18:47 -0800588
Linus Torvalds1da177e2005-04-16 15:20:36 -0700589 read_lock(&tasklist_lock);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800590 if (tty->session) {
591 do_each_pid_task(tty->session, PIDTYPE_SID, p) {
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800592 spin_lock_irq(&p->sighand->siglock);
Alan Cox9c9f4de2008-10-13 10:37:26 +0100593 if (p->signal->tty == tty) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700594 p->signal->tty = NULL;
Alan Cox9c9f4de2008-10-13 10:37:26 +0100595 /* We defer the dereferences outside fo
596 the tasklist lock */
597 refs++;
598 }
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800599 if (!p->signal->leader) {
600 spin_unlock_irq(&p->sighand->siglock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700601 continue;
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800602 }
603 __group_send_sig_info(SIGHUP, SEND_SIG_PRIV, p);
604 __group_send_sig_info(SIGCONT, SEND_SIG_PRIV, p);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800605 put_pid(p->signal->tty_old_pgrp); /* A noop */
Alan Cox47f86832008-04-30 00:53:30 -0700606 spin_lock_irqsave(&tty->ctrl_lock, flags);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800607 if (tty->pgrp)
608 p->signal->tty_old_pgrp = get_pid(tty->pgrp);
Alan Cox47f86832008-04-30 00:53:30 -0700609 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800610 spin_unlock_irq(&p->sighand->siglock);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800611 } while_each_pid_task(tty->session, PIDTYPE_SID, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700612 }
613 read_unlock(&tasklist_lock);
614
Alan Cox47f86832008-04-30 00:53:30 -0700615 spin_lock_irqsave(&tty->ctrl_lock, flags);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100616 clear_bit(TTY_THROTTLED, &tty->flags);
617 clear_bit(TTY_PUSH, &tty->flags);
618 clear_bit(TTY_DO_WRITE_WAKEUP, &tty->flags);
Eric W. Biedermand9c1e9a2007-03-18 12:45:44 -0600619 put_pid(tty->session);
620 put_pid(tty->pgrp);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800621 tty->session = NULL;
622 tty->pgrp = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700623 tty->ctrl_status = 0;
Alan Cox47f86832008-04-30 00:53:30 -0700624 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
625
Alan Cox9c9f4de2008-10-13 10:37:26 +0100626 /* Account for the p->signal references we killed */
627 while (refs--)
628 tty_kref_put(tty);
629
Linus Torvalds1da177e2005-04-16 15:20:36 -0700630 /*
Alan Cox37bdfb02008-02-08 04:18:47 -0800631 * If one of the devices matches a console pointer, we
632 * cannot just call hangup() because that will cause
633 * tty->count and state->count to go out of sync.
634 * So we just call close() the right number of times.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700635 */
636 if (cons_filp) {
Alan Coxf34d7a52008-04-30 00:54:13 -0700637 if (tty->ops->close)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700638 for (n = 0; n < closecount; n++)
Alan Coxf34d7a52008-04-30 00:54:13 -0700639 tty->ops->close(tty, cons_filp);
640 } else if (tty->ops->hangup)
641 (tty->ops->hangup)(tty);
Alan Cox37bdfb02008-02-08 04:18:47 -0800642 /*
643 * We don't want to have driver/ldisc interactions beyond
644 * the ones we did here. The driver layer expects no
645 * calls after ->hangup() from the ldisc side. However we
646 * can't yet guarantee all that.
647 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700648 set_bit(TTY_HUPPED, &tty->flags);
Jiri Slabyacfa7472010-11-29 10:16:54 +0100649 clear_bit(TTY_HUPPING, &tty->flags);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100650 tty_ldisc_enable(tty);
Arnd Bergmann11dbf202010-06-18 14:58:07 +0200651
652 tty_unlock();
653
Linus Torvalds1da177e2005-04-16 15:20:36 -0700654 if (f)
655 fput(f);
656}
657
Arnd Bergmannddcd9fb2010-06-01 22:53:08 +0200658static void do_tty_hangup(struct work_struct *work)
659{
660 struct tty_struct *tty =
661 container_of(work, struct tty_struct, hangup_work);
662
Arnd Bergmann11dbf202010-06-18 14:58:07 +0200663 __tty_hangup(tty);
Arnd Bergmannddcd9fb2010-06-01 22:53:08 +0200664}
665
Alan Coxaf9b8972006-08-27 01:24:01 -0700666/**
667 * tty_hangup - trigger a hangup event
668 * @tty: tty to hangup
669 *
670 * A carrier loss (virtual or otherwise) has occurred on this like
671 * schedule a hangup sequence to run after this event.
672 */
673
Alan Cox37bdfb02008-02-08 04:18:47 -0800674void tty_hangup(struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700675{
676#ifdef TTY_DEBUG_HANGUP
677 char buf[64];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700678 printk(KERN_DEBUG "%s hangup...\n", tty_name(tty, buf));
679#endif
680 schedule_work(&tty->hangup_work);
681}
682
683EXPORT_SYMBOL(tty_hangup);
684
Alan Coxaf9b8972006-08-27 01:24:01 -0700685/**
686 * tty_vhangup - process vhangup
687 * @tty: tty to hangup
688 *
689 * The user has asked via system call for the terminal to be hung up.
690 * We do this synchronously so that when the syscall returns the process
Robert P. J. Day3a4fa0a2007-10-19 23:10:43 +0200691 * is complete. That guarantee is necessary for security reasons.
Alan Coxaf9b8972006-08-27 01:24:01 -0700692 */
693
Alan Cox37bdfb02008-02-08 04:18:47 -0800694void tty_vhangup(struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700695{
696#ifdef TTY_DEBUG_HANGUP
697 char buf[64];
698
699 printk(KERN_DEBUG "%s vhangup...\n", tty_name(tty, buf));
700#endif
Arnd Bergmann11dbf202010-06-18 14:58:07 +0200701 __tty_hangup(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700702}
Alan Cox37bdfb02008-02-08 04:18:47 -0800703
Linus Torvalds1da177e2005-04-16 15:20:36 -0700704EXPORT_SYMBOL(tty_vhangup);
705
Arnd Bergmann11dbf202010-06-18 14:58:07 +0200706
Alan Coxaf9b8972006-08-27 01:24:01 -0700707/**
Alan Cox2cb59982008-10-13 10:40:30 +0100708 * tty_vhangup_self - process vhangup for own ctty
709 *
710 * Perform a vhangup on the current controlling tty
711 */
712
713void tty_vhangup_self(void)
714{
715 struct tty_struct *tty;
716
Alan Cox2cb59982008-10-13 10:40:30 +0100717 tty = get_current_tty();
718 if (tty) {
719 tty_vhangup(tty);
720 tty_kref_put(tty);
721 }
Alan Cox2cb59982008-10-13 10:40:30 +0100722}
723
724/**
Alan Coxaf9b8972006-08-27 01:24:01 -0700725 * tty_hung_up_p - was tty hung up
726 * @filp: file pointer of tty
727 *
728 * Return true if the tty has been subject to a vhangup or a carrier
729 * loss
730 */
731
Alan Cox37bdfb02008-02-08 04:18:47 -0800732int tty_hung_up_p(struct file *filp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700733{
734 return (filp->f_op == &hung_up_tty_fops);
735}
736
737EXPORT_SYMBOL(tty_hung_up_p);
738
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800739static void session_clear_tty(struct pid *session)
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800740{
741 struct task_struct *p;
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800742 do_each_pid_task(session, PIDTYPE_SID, p) {
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800743 proc_clear_tty(p);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800744 } while_each_pid_task(session, PIDTYPE_SID, p);
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800745}
746
Alan Coxaf9b8972006-08-27 01:24:01 -0700747/**
748 * disassociate_ctty - disconnect controlling tty
749 * @on_exit: true if exiting so need to "hang up" the session
Linus Torvalds1da177e2005-04-16 15:20:36 -0700750 *
Alan Coxaf9b8972006-08-27 01:24:01 -0700751 * This function is typically called only by the session leader, when
752 * it wants to disassociate itself from its controlling tty.
753 *
754 * It performs the following functions:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700755 * (1) Sends a SIGHUP and SIGCONT to the foreground process group
756 * (2) Clears the tty from being controlling the session
757 * (3) Clears the controlling tty for all processes in the
758 * session group.
759 *
Alan Coxaf9b8972006-08-27 01:24:01 -0700760 * The argument on_exit is set to 1 if called when a process is
761 * exiting; it is 0 if called by the ioctl TIOCNOTTY.
762 *
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800763 * Locking:
Arnd Bergmannec79d602010-06-01 22:53:01 +0200764 * BTM is taken for hysterical raisins, and held when
765 * called from no_tty().
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800766 * tty_mutex is taken to protect tty
767 * ->siglock is taken to protect ->signal/->sighand
768 * tasklist_lock is taken to walk process list for sessions
769 * ->siglock is taken to protect ->signal/->sighand
Linus Torvalds1da177e2005-04-16 15:20:36 -0700770 */
Alan Coxaf9b8972006-08-27 01:24:01 -0700771
Linus Torvalds1da177e2005-04-16 15:20:36 -0700772void disassociate_ctty(int on_exit)
773{
774 struct tty_struct *tty;
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800775 struct pid *tty_pgrp = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700776
Alan Cox5ec93d12009-11-30 13:18:45 +0000777 if (!current->signal->leader)
778 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700779
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800780 tty = get_current_tty();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700781 if (tty) {
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800782 tty_pgrp = get_pid(tty->pgrp);
Arnd Bergmannddcd9fb2010-06-01 22:53:08 +0200783 if (on_exit) {
Arnd Bergmannddcd9fb2010-06-01 22:53:08 +0200784 if (tty->driver->type != TTY_DRIVER_TYPE_PTY)
Arnd Bergmann11dbf202010-06-18 14:58:07 +0200785 tty_vhangup(tty);
Arnd Bergmannddcd9fb2010-06-01 22:53:08 +0200786 }
Alan Cox452a00d2008-10-13 10:39:13 +0100787 tty_kref_put(tty);
Eric W. Biederman680a9672007-02-12 00:52:52 -0800788 } else if (on_exit) {
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800789 struct pid *old_pgrp;
Eric W. Biederman680a9672007-02-12 00:52:52 -0800790 spin_lock_irq(&current->sighand->siglock);
791 old_pgrp = current->signal->tty_old_pgrp;
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800792 current->signal->tty_old_pgrp = NULL;
Eric W. Biederman680a9672007-02-12 00:52:52 -0800793 spin_unlock_irq(&current->sighand->siglock);
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800794 if (old_pgrp) {
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800795 kill_pgrp(old_pgrp, SIGHUP, on_exit);
796 kill_pgrp(old_pgrp, SIGCONT, on_exit);
797 put_pid(old_pgrp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700798 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700799 return;
800 }
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800801 if (tty_pgrp) {
802 kill_pgrp(tty_pgrp, SIGHUP, on_exit);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700803 if (!on_exit)
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800804 kill_pgrp(tty_pgrp, SIGCONT, on_exit);
805 put_pid(tty_pgrp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700806 }
807
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800808 spin_lock_irq(&current->sighand->siglock);
Eric W. Biederman2a65f1d2007-05-08 00:26:53 -0700809 put_pid(current->signal->tty_old_pgrp);
Randy Dunlap23cac8d2007-02-20 13:58:05 -0800810 current->signal->tty_old_pgrp = NULL;
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800811 spin_unlock_irq(&current->sighand->siglock);
812
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800813 tty = get_current_tty();
814 if (tty) {
Alan Cox47f86832008-04-30 00:53:30 -0700815 unsigned long flags;
816 spin_lock_irqsave(&tty->ctrl_lock, flags);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800817 put_pid(tty->session);
818 put_pid(tty->pgrp);
819 tty->session = NULL;
820 tty->pgrp = NULL;
Alan Cox47f86832008-04-30 00:53:30 -0700821 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
Alan Cox452a00d2008-10-13 10:39:13 +0100822 tty_kref_put(tty);
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800823 } else {
824#ifdef TTY_DEBUG_HANGUP
825 printk(KERN_DEBUG "error attempted to write to tty [0x%p]"
826 " = NULL", tty);
827#endif
828 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700829
830 /* Now clear signal->tty under the lock */
831 read_lock(&tasklist_lock);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800832 session_clear_tty(task_session(current));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700833 read_unlock(&tasklist_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700834}
835
Eric W. Biederman98a27ba2007-05-08 00:26:56 -0700836/**
837 *
838 * no_tty - Ensure the current process does not have a controlling tty
839 */
840void no_tty(void)
841{
842 struct task_struct *tsk = current;
Arnd Bergmannec79d602010-06-01 22:53:01 +0200843 tty_lock();
Alan Cox5ec93d12009-11-30 13:18:45 +0000844 disassociate_ctty(0);
Arnd Bergmannec79d602010-06-01 22:53:01 +0200845 tty_unlock();
Eric W. Biederman98a27ba2007-05-08 00:26:56 -0700846 proc_clear_tty(tsk);
847}
848
Alan Coxaf9b8972006-08-27 01:24:01 -0700849
850/**
Robert P. J. Daybeb7dd82007-05-09 07:14:03 +0200851 * stop_tty - propagate flow control
Alan Coxaf9b8972006-08-27 01:24:01 -0700852 * @tty: tty to stop
853 *
854 * Perform flow control to the driver. For PTY/TTY pairs we
Robert P. J. Daybeb7dd82007-05-09 07:14:03 +0200855 * must also propagate the TIOCKPKT status. May be called
Alan Coxaf9b8972006-08-27 01:24:01 -0700856 * on an already stopped device and will not re-call the driver
857 * method.
858 *
859 * This functionality is used by both the line disciplines for
860 * halting incoming flow and by the driver. It may therefore be
861 * called from any context, may be under the tty atomic_write_lock
862 * but not always.
863 *
864 * Locking:
Alan Cox04f378b2008-04-30 00:53:29 -0700865 * Uses the tty control lock internally
Alan Coxaf9b8972006-08-27 01:24:01 -0700866 */
867
Linus Torvalds1da177e2005-04-16 15:20:36 -0700868void stop_tty(struct tty_struct *tty)
869{
Alan Cox04f378b2008-04-30 00:53:29 -0700870 unsigned long flags;
871 spin_lock_irqsave(&tty->ctrl_lock, flags);
872 if (tty->stopped) {
873 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700874 return;
Alan Cox04f378b2008-04-30 00:53:29 -0700875 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700876 tty->stopped = 1;
877 if (tty->link && tty->link->packet) {
878 tty->ctrl_status &= ~TIOCPKT_START;
879 tty->ctrl_status |= TIOCPKT_STOP;
Davide Libenzi4b194492009-03-31 15:24:24 -0700880 wake_up_interruptible_poll(&tty->link->read_wait, POLLIN);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700881 }
Alan Cox04f378b2008-04-30 00:53:29 -0700882 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
Alan Coxf34d7a52008-04-30 00:54:13 -0700883 if (tty->ops->stop)
884 (tty->ops->stop)(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700885}
886
887EXPORT_SYMBOL(stop_tty);
888
Alan Coxaf9b8972006-08-27 01:24:01 -0700889/**
Robert P. J. Daybeb7dd82007-05-09 07:14:03 +0200890 * start_tty - propagate flow control
Alan Coxaf9b8972006-08-27 01:24:01 -0700891 * @tty: tty to start
892 *
893 * Start a tty that has been stopped if at all possible. Perform
Robert P. J. Day3a4fa0a2007-10-19 23:10:43 +0200894 * any necessary wakeups and propagate the TIOCPKT status. If this
Alan Coxaf9b8972006-08-27 01:24:01 -0700895 * is the tty was previous stopped and is being started then the
896 * driver start method is invoked and the line discipline woken.
897 *
898 * Locking:
Alan Cox04f378b2008-04-30 00:53:29 -0700899 * ctrl_lock
Alan Coxaf9b8972006-08-27 01:24:01 -0700900 */
901
Linus Torvalds1da177e2005-04-16 15:20:36 -0700902void start_tty(struct tty_struct *tty)
903{
Alan Cox04f378b2008-04-30 00:53:29 -0700904 unsigned long flags;
905 spin_lock_irqsave(&tty->ctrl_lock, flags);
906 if (!tty->stopped || tty->flow_stopped) {
907 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700908 return;
Alan Cox04f378b2008-04-30 00:53:29 -0700909 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700910 tty->stopped = 0;
911 if (tty->link && tty->link->packet) {
912 tty->ctrl_status &= ~TIOCPKT_STOP;
913 tty->ctrl_status |= TIOCPKT_START;
Davide Libenzi4b194492009-03-31 15:24:24 -0700914 wake_up_interruptible_poll(&tty->link->read_wait, POLLIN);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700915 }
Alan Cox04f378b2008-04-30 00:53:29 -0700916 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
Alan Coxf34d7a52008-04-30 00:54:13 -0700917 if (tty->ops->start)
918 (tty->ops->start)(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700919 /* If we have a running line discipline it may need kicking */
920 tty_wakeup(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700921}
922
923EXPORT_SYMBOL(start_tty);
924
Alan Coxaf9b8972006-08-27 01:24:01 -0700925/**
926 * tty_read - read method for tty device files
927 * @file: pointer to tty file
928 * @buf: user buffer
929 * @count: size of user buffer
930 * @ppos: unused
931 *
932 * Perform the read system call function on this terminal device. Checks
933 * for hung up devices before calling the line discipline method.
934 *
935 * Locking:
Alan Cox47f86832008-04-30 00:53:30 -0700936 * Locks the line discipline internally while needed. Multiple
937 * read calls may be outstanding in parallel.
Alan Coxaf9b8972006-08-27 01:24:01 -0700938 */
939
Alan Cox37bdfb02008-02-08 04:18:47 -0800940static ssize_t tty_read(struct file *file, char __user *buf, size_t count,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700941 loff_t *ppos)
942{
943 int i;
Nick Piggind996b622010-08-18 04:37:36 +1000944 struct inode *inode = file->f_path.dentry->d_inode;
945 struct tty_struct *tty = file_tty(file);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700946 struct tty_ldisc *ld;
947
Linus Torvalds1da177e2005-04-16 15:20:36 -0700948 if (tty_paranoia_check(tty, inode, "tty_read"))
949 return -EIO;
950 if (!tty || (test_bit(TTY_IO_ERROR, &tty->flags)))
951 return -EIO;
952
953 /* We want to wait for the line discipline to sort out in this
954 situation */
955 ld = tty_ldisc_ref_wait(tty);
Alan Coxa352def2008-07-16 21:53:12 +0100956 if (ld->ops->read)
957 i = (ld->ops->read)(tty, file, buf, count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700958 else
959 i = -EIO;
960 tty_ldisc_deref(ld);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700961 if (i > 0)
962 inode->i_atime = current_fs_time(inode->i_sb);
963 return i;
964}
965
Alan Cox9c1729d2007-07-15 23:39:43 -0700966void tty_write_unlock(struct tty_struct *tty)
967{
968 mutex_unlock(&tty->atomic_write_lock);
Davide Libenzi4b194492009-03-31 15:24:24 -0700969 wake_up_interruptible_poll(&tty->write_wait, POLLOUT);
Alan Cox9c1729d2007-07-15 23:39:43 -0700970}
971
972int tty_write_lock(struct tty_struct *tty, int ndelay)
973{
974 if (!mutex_trylock(&tty->atomic_write_lock)) {
975 if (ndelay)
976 return -EAGAIN;
977 if (mutex_lock_interruptible(&tty->atomic_write_lock))
978 return -ERESTARTSYS;
979 }
980 return 0;
981}
982
Linus Torvalds1da177e2005-04-16 15:20:36 -0700983/*
984 * Split writes up in sane blocksizes to avoid
985 * denial-of-service type attacks
986 */
987static inline ssize_t do_tty_write(
988 ssize_t (*write)(struct tty_struct *, struct file *, const unsigned char *, size_t),
989 struct tty_struct *tty,
990 struct file *file,
991 const char __user *buf,
992 size_t count)
993{
Alan Cox9c1729d2007-07-15 23:39:43 -0700994 ssize_t ret, written = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700995 unsigned int chunk;
Alan Cox37bdfb02008-02-08 04:18:47 -0800996
Alan Cox9c1729d2007-07-15 23:39:43 -0700997 ret = tty_write_lock(tty, file->f_flags & O_NDELAY);
998 if (ret < 0)
999 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001000
1001 /*
1002 * We chunk up writes into a temporary buffer. This
1003 * simplifies low-level drivers immensely, since they
1004 * don't have locking issues and user mode accesses.
1005 *
1006 * But if TTY_NO_WRITE_SPLIT is set, we should use a
1007 * big chunk-size..
1008 *
1009 * The default chunk-size is 2kB, because the NTTY
1010 * layer has problems with bigger chunks. It will
1011 * claim to be able to handle more characters than
1012 * it actually does.
Alan Coxaf9b8972006-08-27 01:24:01 -07001013 *
1014 * FIXME: This can probably go away now except that 64K chunks
1015 * are too likely to fail unless switched to vmalloc...
Linus Torvalds1da177e2005-04-16 15:20:36 -07001016 */
1017 chunk = 2048;
1018 if (test_bit(TTY_NO_WRITE_SPLIT, &tty->flags))
1019 chunk = 65536;
1020 if (count < chunk)
1021 chunk = count;
1022
Ingo Molnar70522e12006-03-23 03:00:31 -08001023 /* write_buf/write_cnt is protected by the atomic_write_lock mutex */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001024 if (tty->write_cnt < chunk) {
Jason Wessel402fda92008-10-13 10:45:36 +01001025 unsigned char *buf_chunk;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001026
1027 if (chunk < 1024)
1028 chunk = 1024;
1029
Jason Wessel402fda92008-10-13 10:45:36 +01001030 buf_chunk = kmalloc(chunk, GFP_KERNEL);
1031 if (!buf_chunk) {
Alan Cox9c1729d2007-07-15 23:39:43 -07001032 ret = -ENOMEM;
1033 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001034 }
1035 kfree(tty->write_buf);
1036 tty->write_cnt = chunk;
Jason Wessel402fda92008-10-13 10:45:36 +01001037 tty->write_buf = buf_chunk;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001038 }
1039
1040 /* Do the write .. */
1041 for (;;) {
1042 size_t size = count;
1043 if (size > chunk)
1044 size = chunk;
1045 ret = -EFAULT;
1046 if (copy_from_user(tty->write_buf, buf, size))
1047 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001048 ret = write(tty, file, tty->write_buf, size);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001049 if (ret <= 0)
1050 break;
1051 written += ret;
1052 buf += ret;
1053 count -= ret;
1054 if (!count)
1055 break;
1056 ret = -ERESTARTSYS;
1057 if (signal_pending(current))
1058 break;
1059 cond_resched();
1060 }
1061 if (written) {
Josef Sipeka7113a92006-12-08 02:36:55 -08001062 struct inode *inode = file->f_path.dentry->d_inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001063 inode->i_mtime = current_fs_time(inode->i_sb);
1064 ret = written;
1065 }
Alan Cox9c1729d2007-07-15 23:39:43 -07001066out:
1067 tty_write_unlock(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001068 return ret;
1069}
1070
Alan Cox95f9bfc2008-10-13 10:39:23 +01001071/**
1072 * tty_write_message - write a message to a certain tty, not just the console.
1073 * @tty: the destination tty_struct
1074 * @msg: the message to write
1075 *
1076 * This is used for messages that need to be redirected to a specific tty.
1077 * We don't put it into the syslog queue right now maybe in the future if
1078 * really needed.
1079 *
Arnd Bergmannec79d602010-06-01 22:53:01 +02001080 * We must still hold the BTM and test the CLOSING flag for the moment.
Alan Cox95f9bfc2008-10-13 10:39:23 +01001081 */
1082
1083void tty_write_message(struct tty_struct *tty, char *msg)
1084{
Alan Cox95f9bfc2008-10-13 10:39:23 +01001085 if (tty) {
1086 mutex_lock(&tty->atomic_write_lock);
Arnd Bergmannec79d602010-06-01 22:53:01 +02001087 tty_lock();
Alan Coxeeb89d92009-11-30 13:18:29 +00001088 if (tty->ops->write && !test_bit(TTY_CLOSING, &tty->flags)) {
Arnd Bergmannec79d602010-06-01 22:53:01 +02001089 tty_unlock();
Alan Cox95f9bfc2008-10-13 10:39:23 +01001090 tty->ops->write(tty, msg, strlen(msg));
Alan Coxeeb89d92009-11-30 13:18:29 +00001091 } else
Arnd Bergmannec79d602010-06-01 22:53:01 +02001092 tty_unlock();
Alan Cox95f9bfc2008-10-13 10:39:23 +01001093 tty_write_unlock(tty);
1094 }
Alan Cox95f9bfc2008-10-13 10:39:23 +01001095 return;
1096}
1097
Linus Torvalds1da177e2005-04-16 15:20:36 -07001098
Alan Coxaf9b8972006-08-27 01:24:01 -07001099/**
1100 * tty_write - write method for tty device file
1101 * @file: tty file pointer
1102 * @buf: user data to write
1103 * @count: bytes to write
1104 * @ppos: unused
1105 *
1106 * Write data to a tty device via the line discipline.
1107 *
1108 * Locking:
1109 * Locks the line discipline as required
1110 * Writes to the tty driver are serialized by the atomic_write_lock
1111 * and are then processed in chunks to the device. The line discipline
Joe Petersona88a69c2009-01-02 13:40:53 +00001112 * write method will not be invoked in parallel for each device.
Alan Coxaf9b8972006-08-27 01:24:01 -07001113 */
1114
Alan Cox37bdfb02008-02-08 04:18:47 -08001115static ssize_t tty_write(struct file *file, const char __user *buf,
1116 size_t count, loff_t *ppos)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001117{
Josef Sipeka7113a92006-12-08 02:36:55 -08001118 struct inode *inode = file->f_path.dentry->d_inode;
Nick Piggind996b622010-08-18 04:37:36 +10001119 struct tty_struct *tty = file_tty(file);
1120 struct tty_ldisc *ld;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001121 ssize_t ret;
Alan Cox37bdfb02008-02-08 04:18:47 -08001122
Linus Torvalds1da177e2005-04-16 15:20:36 -07001123 if (tty_paranoia_check(tty, inode, "tty_write"))
1124 return -EIO;
Alan Coxf34d7a52008-04-30 00:54:13 -07001125 if (!tty || !tty->ops->write ||
Alan Cox37bdfb02008-02-08 04:18:47 -08001126 (test_bit(TTY_IO_ERROR, &tty->flags)))
1127 return -EIO;
Alan Coxf34d7a52008-04-30 00:54:13 -07001128 /* Short term debug to catch buggy drivers */
1129 if (tty->ops->write_room == NULL)
1130 printk(KERN_ERR "tty driver %s lacks a write_room method.\n",
1131 tty->driver->name);
Alan Cox37bdfb02008-02-08 04:18:47 -08001132 ld = tty_ldisc_ref_wait(tty);
Alan Coxa352def2008-07-16 21:53:12 +01001133 if (!ld->ops->write)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001134 ret = -EIO;
1135 else
Alan Coxa352def2008-07-16 21:53:12 +01001136 ret = do_tty_write(ld->ops->write, tty, file, buf, count);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001137 tty_ldisc_deref(ld);
1138 return ret;
1139}
1140
Alan Cox37bdfb02008-02-08 04:18:47 -08001141ssize_t redirected_tty_write(struct file *file, const char __user *buf,
1142 size_t count, loff_t *ppos)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001143{
1144 struct file *p = NULL;
1145
1146 spin_lock(&redirect_lock);
1147 if (redirect) {
1148 get_file(redirect);
1149 p = redirect;
1150 }
1151 spin_unlock(&redirect_lock);
1152
1153 if (p) {
1154 ssize_t res;
1155 res = vfs_write(p, buf, count, &p->f_pos);
1156 fput(p);
1157 return res;
1158 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001159 return tty_write(file, buf, count, ppos);
1160}
1161
1162static char ptychar[] = "pqrstuvwxyzabcde";
1163
Alan Coxaf9b8972006-08-27 01:24:01 -07001164/**
1165 * pty_line_name - generate name for a pty
1166 * @driver: the tty driver in use
1167 * @index: the minor number
1168 * @p: output buffer of at least 6 bytes
1169 *
1170 * Generate a name from a driver reference and write it to the output
1171 * buffer.
1172 *
1173 * Locking: None
1174 */
1175static void pty_line_name(struct tty_driver *driver, int index, char *p)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001176{
1177 int i = index + driver->name_base;
1178 /* ->name is initialized to "ttyp", but "tty" is expected */
1179 sprintf(p, "%s%c%x",
Alan Cox37bdfb02008-02-08 04:18:47 -08001180 driver->subtype == PTY_TYPE_SLAVE ? "tty" : driver->name,
1181 ptychar[i >> 4 & 0xf], i & 0xf);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001182}
1183
Alan Coxaf9b8972006-08-27 01:24:01 -07001184/**
Alan Cox8b0a88d2008-10-13 10:42:19 +01001185 * tty_line_name - generate name for a tty
Alan Coxaf9b8972006-08-27 01:24:01 -07001186 * @driver: the tty driver in use
1187 * @index: the minor number
1188 * @p: output buffer of at least 7 bytes
1189 *
1190 * Generate a name from a driver reference and write it to the output
1191 * buffer.
1192 *
1193 * Locking: None
1194 */
1195static void tty_line_name(struct tty_driver *driver, int index, char *p)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001196{
1197 sprintf(p, "%s%d", driver->name, index + driver->name_base);
1198}
1199
Alan Cox99f1fe12008-10-13 10:42:00 +01001200/**
1201 * tty_driver_lookup_tty() - find an existing tty, if any
1202 * @driver: the driver for the tty
1203 * @idx: the minor number
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001204 *
Alan Cox99f1fe12008-10-13 10:42:00 +01001205 * Return the tty, if found or ERR_PTR() otherwise.
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001206 *
Alan Cox99f1fe12008-10-13 10:42:00 +01001207 * Locking: tty_mutex must be held. If tty is found, the mutex must
1208 * be held until the 'fast-open' is also done. Will change once we
1209 * have refcounting in the driver and per driver locking
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001210 */
Jason Wessela47d5452009-01-02 13:43:04 +00001211static struct tty_struct *tty_driver_lookup_tty(struct tty_driver *driver,
Sukadev Bhattiprolu15f1a632008-10-13 10:42:59 +01001212 struct inode *inode, int idx)
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001213{
1214 struct tty_struct *tty;
1215
Alan Cox99f1fe12008-10-13 10:42:00 +01001216 if (driver->ops->lookup)
Sukadev Bhattiprolu15f1a632008-10-13 10:42:59 +01001217 return driver->ops->lookup(driver, inode, idx);
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001218
Alan Cox8b0a88d2008-10-13 10:42:19 +01001219 tty = driver->ttys[idx];
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001220 return tty;
1221}
1222
Alan Cox99f1fe12008-10-13 10:42:00 +01001223/**
Alan Coxbf970ee2008-10-13 10:42:39 +01001224 * tty_init_termios - helper for termios setup
1225 * @tty: the tty to set up
1226 *
1227 * Initialise the termios structures for this tty. Thus runs under
1228 * the tty_mutex currently so we can be relaxed about ordering.
1229 */
1230
1231int tty_init_termios(struct tty_struct *tty)
1232{
Alan Coxfe6e29f2008-10-13 10:44:08 +01001233 struct ktermios *tp;
Alan Coxbf970ee2008-10-13 10:42:39 +01001234 int idx = tty->index;
1235
1236 tp = tty->driver->termios[idx];
Alan Coxbf970ee2008-10-13 10:42:39 +01001237 if (tp == NULL) {
Alan Coxfe6e29f2008-10-13 10:44:08 +01001238 tp = kzalloc(sizeof(struct ktermios[2]), GFP_KERNEL);
1239 if (tp == NULL)
Alan Coxbf970ee2008-10-13 10:42:39 +01001240 return -ENOMEM;
Alan Coxbf970ee2008-10-13 10:42:39 +01001241 memcpy(tp, &tty->driver->init_termios,
1242 sizeof(struct ktermios));
1243 tty->driver->termios[idx] = tp;
Alan Coxbf970ee2008-10-13 10:42:39 +01001244 }
1245 tty->termios = tp;
Alan Coxfe6e29f2008-10-13 10:44:08 +01001246 tty->termios_locked = tp + 1;
Alan Coxbf970ee2008-10-13 10:42:39 +01001247
1248 /* Compatibility until drivers always set this */
1249 tty->termios->c_ispeed = tty_termios_input_baud_rate(tty->termios);
1250 tty->termios->c_ospeed = tty_termios_baud_rate(tty->termios);
1251 return 0;
1252}
Alan Coxfe1ae7f2009-09-19 13:13:33 -07001253EXPORT_SYMBOL_GPL(tty_init_termios);
Alan Coxbf970ee2008-10-13 10:42:39 +01001254
1255/**
Alan Cox8b0a88d2008-10-13 10:42:19 +01001256 * tty_driver_install_tty() - install a tty entry in the driver
1257 * @driver: the driver for the tty
1258 * @tty: the tty
1259 *
1260 * Install a tty object into the driver tables. The tty->index field
Alan Coxbf970ee2008-10-13 10:42:39 +01001261 * will be set by the time this is called. This method is responsible
1262 * for ensuring any need additional structures are allocated and
1263 * configured.
Alan Cox8b0a88d2008-10-13 10:42:19 +01001264 *
1265 * Locking: tty_mutex for now
1266 */
1267static int tty_driver_install_tty(struct tty_driver *driver,
1268 struct tty_struct *tty)
1269{
Alan Coxbf970ee2008-10-13 10:42:39 +01001270 int idx = tty->index;
Alan Coxeeb89d92009-11-30 13:18:29 +00001271 int ret;
Alan Coxbf970ee2008-10-13 10:42:39 +01001272
Alan Coxeeb89d92009-11-30 13:18:29 +00001273 if (driver->ops->install) {
Alan Coxeeb89d92009-11-30 13:18:29 +00001274 ret = driver->ops->install(driver, tty);
Alan Coxeeb89d92009-11-30 13:18:29 +00001275 return ret;
1276 }
Alan Coxbf970ee2008-10-13 10:42:39 +01001277
1278 if (tty_init_termios(tty) == 0) {
1279 tty_driver_kref_get(driver);
1280 tty->count++;
1281 driver->ttys[idx] = tty;
1282 return 0;
1283 }
1284 return -ENOMEM;
Alan Cox8b0a88d2008-10-13 10:42:19 +01001285}
1286
1287/**
1288 * tty_driver_remove_tty() - remove a tty from the driver tables
1289 * @driver: the driver for the tty
1290 * @idx: the minor number
1291 *
1292 * Remvoe a tty object from the driver tables. The tty->index field
1293 * will be set by the time this is called.
1294 *
1295 * Locking: tty_mutex for now
1296 */
1297static void tty_driver_remove_tty(struct tty_driver *driver,
1298 struct tty_struct *tty)
1299{
1300 if (driver->ops->remove)
1301 driver->ops->remove(driver, tty);
1302 else
1303 driver->ttys[tty->index] = NULL;
1304}
1305
1306/*
1307 * tty_reopen() - fast re-open of an open tty
1308 * @tty - the tty to open
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001309 *
Alan Cox99f1fe12008-10-13 10:42:00 +01001310 * Return 0 on success, -errno on error.
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001311 *
Alan Cox99f1fe12008-10-13 10:42:00 +01001312 * Locking: tty_mutex must be held from the time the tty was found
1313 * till this open completes.
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001314 */
Alan Cox99f1fe12008-10-13 10:42:00 +01001315static int tty_reopen(struct tty_struct *tty)
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001316{
1317 struct tty_driver *driver = tty->driver;
1318
Jiri Slabye2efafb2010-11-29 10:16:53 +01001319 if (test_bit(TTY_CLOSING, &tty->flags) ||
Jiri Slabyacfa7472010-11-29 10:16:54 +01001320 test_bit(TTY_HUPPING, &tty->flags) ||
Jiri Slabye2efafb2010-11-29 10:16:53 +01001321 test_bit(TTY_LDISC_CHANGING, &tty->flags))
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001322 return -EIO;
1323
1324 if (driver->type == TTY_DRIVER_TYPE_PTY &&
1325 driver->subtype == PTY_TYPE_MASTER) {
1326 /*
1327 * special case for PTY masters: only one open permitted,
1328 * and the slave side open count is incremented as well.
1329 */
1330 if (tty->count)
1331 return -EIO;
1332
1333 tty->link->count++;
1334 }
1335 tty->count++;
1336 tty->driver = driver; /* N.B. why do this every time?? */
1337
Alan Cox1aa4bed2009-06-16 17:01:33 +01001338 mutex_lock(&tty->ldisc_mutex);
Alan Cox99f1fe12008-10-13 10:42:00 +01001339 WARN_ON(!test_bit(TTY_LDISC, &tty->flags));
Alan Cox1aa4bed2009-06-16 17:01:33 +01001340 mutex_unlock(&tty->ldisc_mutex);
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001341
1342 return 0;
1343}
1344
Alan Coxaf9b8972006-08-27 01:24:01 -07001345/**
Alan Coxd81ed102008-10-13 10:41:42 +01001346 * tty_init_dev - initialise a tty device
Alan Coxaf9b8972006-08-27 01:24:01 -07001347 * @driver: tty driver we are opening a device on
1348 * @idx: device index
Alan Cox15582d32008-10-13 10:41:03 +01001349 * @ret_tty: returned tty structure
1350 * @first_ok: ok to open a new device (used by ptmx)
Alan Coxaf9b8972006-08-27 01:24:01 -07001351 *
1352 * Prepare a tty device. This may not be a "new" clean device but
1353 * could also be an active device. The pty drivers require special
1354 * handling because of this.
1355 *
1356 * Locking:
1357 * The function is called under the tty_mutex, which
1358 * protects us from the tty struct or driver itself going away.
1359 *
1360 * On exit the tty device has the line discipline attached and
1361 * a reference count of 1. If a pair was created for pty/tty use
1362 * and the other was a pty master then it too has a reference count of 1.
1363 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07001364 * WSH 06/09/97: Rewritten to remove races and properly clean up after a
Ingo Molnar70522e12006-03-23 03:00:31 -08001365 * failed open. The new code protects the open with a mutex, so it's
1366 * really quite straightforward. The mutex locking can probably be
Linus Torvalds1da177e2005-04-16 15:20:36 -07001367 * relaxed for the (most common) case of reopening a tty.
1368 */
Alan Coxaf9b8972006-08-27 01:24:01 -07001369
Alan Cox73ec06f2008-10-13 10:42:29 +01001370struct tty_struct *tty_init_dev(struct tty_driver *driver, int idx,
1371 int first_ok)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001372{
Alan Coxbf970ee2008-10-13 10:42:39 +01001373 struct tty_struct *tty;
Alan Cox73ec06f2008-10-13 10:42:29 +01001374 int retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001375
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001376 /* Check if pty master is being opened multiple times */
Alan Cox15582d32008-10-13 10:41:03 +01001377 if (driver->subtype == PTY_TYPE_MASTER &&
Alan Coxeeb89d92009-11-30 13:18:29 +00001378 (driver->flags & TTY_DRIVER_DEVPTS_MEM) && !first_ok) {
Alan Cox73ec06f2008-10-13 10:42:29 +01001379 return ERR_PTR(-EIO);
Alan Coxeeb89d92009-11-30 13:18:29 +00001380 }
Alan Cox73ec06f2008-10-13 10:42:29 +01001381
Linus Torvalds1da177e2005-04-16 15:20:36 -07001382 /*
1383 * First time open is complex, especially for PTY devices.
1384 * This code guarantees that either everything succeeds and the
1385 * TTY is ready for operation, or else the table slots are vacated
Alan Cox37bdfb02008-02-08 04:18:47 -08001386 * and the allocated memory released. (Except that the termios
Linus Torvalds1da177e2005-04-16 15:20:36 -07001387 * and locked termios may be retained.)
1388 */
1389
Alan Cox73ec06f2008-10-13 10:42:29 +01001390 if (!try_module_get(driver->owner))
1391 return ERR_PTR(-ENODEV);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001392
Linus Torvalds1da177e2005-04-16 15:20:36 -07001393 tty = alloc_tty_struct();
Jiri Slabyd5543502011-03-23 10:48:32 +01001394 if (!tty) {
1395 retval = -ENOMEM;
1396 goto err_module_put;
1397 }
Alan Coxbf970ee2008-10-13 10:42:39 +01001398 initialize_tty_struct(tty, driver, idx);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001399
Alan Cox73ec06f2008-10-13 10:42:29 +01001400 retval = tty_driver_install_tty(driver, tty);
Jiri Slabyd5543502011-03-23 10:48:32 +01001401 if (retval < 0)
1402 goto err_free_tty;
Alan Cox8b0a88d2008-10-13 10:42:19 +01001403
Alan Cox37bdfb02008-02-08 04:18:47 -08001404 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001405 * Structures all installed ... call the ldisc open routines.
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001406 * If we fail here just call release_tty to clean up. No need
1407 * to decrement the use counts, as release_tty doesn't care.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001408 */
Alan Coxbf970ee2008-10-13 10:42:39 +01001409 retval = tty_ldisc_setup(tty, tty->link);
Alan Cox01e1abb2008-07-22 11:16:55 +01001410 if (retval)
Jiri Slabyd5543502011-03-23 10:48:32 +01001411 goto err_release_tty;
Alan Cox73ec06f2008-10-13 10:42:29 +01001412 return tty;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001413
Jiri Slabyd5543502011-03-23 10:48:32 +01001414err_free_tty:
1415 free_tty_struct(tty);
1416err_module_put:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001417 module_put(driver->owner);
Jiri Slabyd5543502011-03-23 10:48:32 +01001418 return ERR_PTR(retval);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001419
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001420 /* call the tty release_tty routine to clean out this slot */
Jiri Slabyd5543502011-03-23 10:48:32 +01001421err_release_tty:
Akinobu Mita40509142006-09-29 02:01:27 -07001422 if (printk_ratelimit())
Alan Coxd81ed102008-10-13 10:41:42 +01001423 printk(KERN_INFO "tty_init_dev: ldisc open failed, "
Akinobu Mita40509142006-09-29 02:01:27 -07001424 "clearing slot %d\n", idx);
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001425 release_tty(tty, idx);
Alan Cox73ec06f2008-10-13 10:42:29 +01001426 return ERR_PTR(retval);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001427}
1428
Alan Coxfeebed62008-10-13 10:41:30 +01001429void tty_free_termios(struct tty_struct *tty)
1430{
1431 struct ktermios *tp;
1432 int idx = tty->index;
1433 /* Kill this flag and push into drivers for locking etc */
1434 if (tty->driver->flags & TTY_DRIVER_RESET_TERMIOS) {
1435 /* FIXME: Locking on ->termios array */
1436 tp = tty->termios;
1437 tty->driver->termios[idx] = NULL;
1438 kfree(tp);
Alan Coxfeebed62008-10-13 10:41:30 +01001439 }
1440}
1441EXPORT_SYMBOL(tty_free_termios);
1442
1443void tty_shutdown(struct tty_struct *tty)
1444{
Alan Cox8b0a88d2008-10-13 10:42:19 +01001445 tty_driver_remove_tty(tty->driver, tty);
Alan Coxfeebed62008-10-13 10:41:30 +01001446 tty_free_termios(tty);
1447}
1448EXPORT_SYMBOL(tty_shutdown);
1449
Alan Coxaf9b8972006-08-27 01:24:01 -07001450/**
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001451 * release_one_tty - release tty structure memory
Alan Cox9c9f4de2008-10-13 10:37:26 +01001452 * @kref: kref of tty we are obliterating
Alan Coxaf9b8972006-08-27 01:24:01 -07001453 *
1454 * Releases memory associated with a tty structure, and clears out the
1455 * driver table slots. This function is called when a device is no longer
1456 * in use. It also gets called when setup of a device fails.
1457 *
1458 * Locking:
1459 * tty_mutex - sometimes only
1460 * takes the file list lock internally when working on the list
1461 * of ttys that the driver keeps.
Alan Coxb50989d2009-09-19 13:13:22 -07001462 *
1463 * This method gets called from a work queue so that the driver private
Dave Youngf278a2f2009-09-27 16:00:42 +00001464 * cleanup ops can sleep (needed for USB at least)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001465 */
Alan Coxb50989d2009-09-19 13:13:22 -07001466static void release_one_tty(struct work_struct *work)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001467{
Alan Coxb50989d2009-09-19 13:13:22 -07001468 struct tty_struct *tty =
1469 container_of(work, struct tty_struct, hangup_work);
Alan Cox6f967f72008-10-13 10:37:36 +01001470 struct tty_driver *driver = tty->driver;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001471
Dave Youngf278a2f2009-09-27 16:00:42 +00001472 if (tty->ops->cleanup)
1473 tty->ops->cleanup(tty);
1474
Linus Torvalds1da177e2005-04-16 15:20:36 -07001475 tty->magic = 0;
Alan Cox7d7b93c2008-10-13 10:42:09 +01001476 tty_driver_kref_put(driver);
Alan Cox6f967f72008-10-13 10:37:36 +01001477 module_put(driver->owner);
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001478
Nick Pigginee2ffa02010-08-18 04:37:35 +10001479 spin_lock(&tty_files_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001480 list_del_init(&tty->tty_files);
Nick Pigginee2ffa02010-08-18 04:37:35 +10001481 spin_unlock(&tty_files_lock);
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001482
Oleg Nesterov6da8d862010-04-02 18:05:12 +02001483 put_pid(tty->pgrp);
1484 put_pid(tty->session);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001485 free_tty_struct(tty);
1486}
1487
Alan Coxb50989d2009-09-19 13:13:22 -07001488static void queue_release_one_tty(struct kref *kref)
1489{
1490 struct tty_struct *tty = container_of(kref, struct tty_struct, kref);
Dave Youngf278a2f2009-09-27 16:00:42 +00001491
1492 if (tty->ops->shutdown)
1493 tty->ops->shutdown(tty);
1494 else
1495 tty_shutdown(tty);
1496
Alan Coxb50989d2009-09-19 13:13:22 -07001497 /* The hangup queue is now free so we can reuse it rather than
1498 waste a chunk of memory for each port */
1499 INIT_WORK(&tty->hangup_work, release_one_tty);
1500 schedule_work(&tty->hangup_work);
1501}
1502
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001503/**
Alan Cox9c9f4de2008-10-13 10:37:26 +01001504 * tty_kref_put - release a tty kref
1505 * @tty: tty device
1506 *
1507 * Release a reference to a tty device and if need be let the kref
1508 * layer destruct the object for us
1509 */
1510
1511void tty_kref_put(struct tty_struct *tty)
1512{
1513 if (tty)
Alan Coxb50989d2009-09-19 13:13:22 -07001514 kref_put(&tty->kref, queue_release_one_tty);
Alan Cox9c9f4de2008-10-13 10:37:26 +01001515}
1516EXPORT_SYMBOL(tty_kref_put);
1517
1518/**
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001519 * release_tty - release tty structure memory
1520 *
1521 * Release both @tty and a possible linked partner (think pty pair),
1522 * and decrement the refcount of the backing module.
1523 *
1524 * Locking:
1525 * tty_mutex - sometimes only
1526 * takes the file list lock internally when working on the list
1527 * of ttys that the driver keeps.
1528 * FIXME: should we require tty_mutex is held here ??
Alan Cox9c9f4de2008-10-13 10:37:26 +01001529 *
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001530 */
1531static void release_tty(struct tty_struct *tty, int idx)
1532{
Alan Cox9c9f4de2008-10-13 10:37:26 +01001533 /* This should always be true but check for the moment */
1534 WARN_ON(tty->index != idx);
1535
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001536 if (tty->link)
Alan Cox9c9f4de2008-10-13 10:37:26 +01001537 tty_kref_put(tty->link);
1538 tty_kref_put(tty);
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001539}
1540
Alan Coxeeb89d92009-11-30 13:18:29 +00001541/**
1542 * tty_release - vfs callback for close
1543 * @inode: inode of tty
1544 * @filp: file pointer for handle to tty
1545 *
1546 * Called the last time each file handle is closed that references
1547 * this tty. There may however be several such references.
1548 *
1549 * Locking:
1550 * Takes bkl. See tty_release_dev
1551 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07001552 * Even releasing the tty structures is a tricky business.. We have
1553 * to be very careful that the structures are all released at the
1554 * same time, as interrupts might otherwise get the wrong pointers.
1555 *
1556 * WSH 09/09/97: rewritten to avoid some nasty race conditions that could
1557 * lead to double frees or releasing memory still in use.
1558 */
Alan Coxeeb89d92009-11-30 13:18:29 +00001559
1560int tty_release(struct inode *inode, struct file *filp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001561{
Nick Piggind996b622010-08-18 04:37:36 +10001562 struct tty_struct *tty = file_tty(filp);
1563 struct tty_struct *o_tty;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001564 int pty_master, tty_closing, o_tty_closing, do_sleep;
Paul Fulghum14a62832006-04-10 22:54:19 -07001565 int devpts;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001566 int idx;
1567 char buf[64];
Alan Cox37bdfb02008-02-08 04:18:47 -08001568
Sukadev Bhattiprolu15f1a632008-10-13 10:42:59 +01001569 if (tty_paranoia_check(tty, inode, "tty_release_dev"))
Alan Coxeeb89d92009-11-30 13:18:29 +00001570 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001571
Arnd Bergmannec79d602010-06-01 22:53:01 +02001572 tty_lock();
Alan Coxd81ed102008-10-13 10:41:42 +01001573 check_tty_count(tty, "tty_release_dev");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001574
Arnd Bergmannec79d602010-06-01 22:53:01 +02001575 __tty_fasync(-1, filp, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001576
1577 idx = tty->index;
1578 pty_master = (tty->driver->type == TTY_DRIVER_TYPE_PTY &&
1579 tty->driver->subtype == PTY_TYPE_MASTER);
1580 devpts = (tty->driver->flags & TTY_DRIVER_DEVPTS_MEM) != 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001581 o_tty = tty->link;
1582
1583#ifdef TTY_PARANOIA_CHECK
1584 if (idx < 0 || idx >= tty->driver->num) {
Alan Coxd81ed102008-10-13 10:41:42 +01001585 printk(KERN_DEBUG "tty_release_dev: bad idx when trying to "
Linus Torvalds1da177e2005-04-16 15:20:36 -07001586 "free (%s)\n", tty->name);
Arnd Bergmannec79d602010-06-01 22:53:01 +02001587 tty_unlock();
Alan Coxeeb89d92009-11-30 13:18:29 +00001588 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001589 }
Alan Cox8b0a88d2008-10-13 10:42:19 +01001590 if (!devpts) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001591 if (tty != tty->driver->ttys[idx]) {
Arnd Bergmannec79d602010-06-01 22:53:01 +02001592 tty_unlock();
Alan Coxd81ed102008-10-13 10:41:42 +01001593 printk(KERN_DEBUG "tty_release_dev: driver.table[%d] not tty "
Linus Torvalds1da177e2005-04-16 15:20:36 -07001594 "for (%s)\n", idx, tty->name);
Alan Coxeeb89d92009-11-30 13:18:29 +00001595 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001596 }
1597 if (tty->termios != tty->driver->termios[idx]) {
Arnd Bergmannec79d602010-06-01 22:53:01 +02001598 tty_unlock();
Alan Coxd81ed102008-10-13 10:41:42 +01001599 printk(KERN_DEBUG "tty_release_dev: driver.termios[%d] not termios "
Linus Torvalds1da177e2005-04-16 15:20:36 -07001600 "for (%s)\n",
1601 idx, tty->name);
Alan Coxeeb89d92009-11-30 13:18:29 +00001602 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001603 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001604 }
1605#endif
1606
1607#ifdef TTY_DEBUG_HANGUP
Alan Coxd81ed102008-10-13 10:41:42 +01001608 printk(KERN_DEBUG "tty_release_dev of %s (tty count=%d)...",
Linus Torvalds1da177e2005-04-16 15:20:36 -07001609 tty_name(tty, buf), tty->count);
1610#endif
1611
1612#ifdef TTY_PARANOIA_CHECK
1613 if (tty->driver->other &&
1614 !(tty->driver->flags & TTY_DRIVER_DEVPTS_MEM)) {
1615 if (o_tty != tty->driver->other->ttys[idx]) {
Arnd Bergmannec79d602010-06-01 22:53:01 +02001616 tty_unlock();
Alan Coxd81ed102008-10-13 10:41:42 +01001617 printk(KERN_DEBUG "tty_release_dev: other->table[%d] "
Linus Torvalds1da177e2005-04-16 15:20:36 -07001618 "not o_tty for (%s)\n",
1619 idx, tty->name);
Alan Coxeeb89d92009-11-30 13:18:29 +00001620 return 0 ;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001621 }
1622 if (o_tty->termios != tty->driver->other->termios[idx]) {
Arnd Bergmannec79d602010-06-01 22:53:01 +02001623 tty_unlock();
Alan Coxd81ed102008-10-13 10:41:42 +01001624 printk(KERN_DEBUG "tty_release_dev: other->termios[%d] "
Linus Torvalds1da177e2005-04-16 15:20:36 -07001625 "not o_termios for (%s)\n",
1626 idx, tty->name);
Alan Coxeeb89d92009-11-30 13:18:29 +00001627 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001628 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001629 if (o_tty->link != tty) {
Arnd Bergmannec79d602010-06-01 22:53:01 +02001630 tty_unlock();
Alan Coxd81ed102008-10-13 10:41:42 +01001631 printk(KERN_DEBUG "tty_release_dev: bad pty pointers\n");
Alan Coxeeb89d92009-11-30 13:18:29 +00001632 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001633 }
1634 }
1635#endif
Alan Coxf34d7a52008-04-30 00:54:13 -07001636 if (tty->ops->close)
1637 tty->ops->close(tty, filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001638
Arnd Bergmannec79d602010-06-01 22:53:01 +02001639 tty_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001640 /*
1641 * Sanity check: if tty->count is going to zero, there shouldn't be
1642 * any waiters on tty->read_wait or tty->write_wait. We test the
1643 * wait queues and kick everyone out _before_ actually starting to
1644 * close. This ensures that we won't block while releasing the tty
1645 * structure.
1646 *
1647 * The test for the o_tty closing is necessary, since the master and
1648 * slave sides may close in any order. If the slave side closes out
1649 * first, its count will be one, since the master side holds an open.
1650 * Thus this test wouldn't be triggered at the time the slave closes,
1651 * so we do it now.
1652 *
1653 * Note that it's possible for the tty to be opened again while we're
1654 * flushing out waiters. By recalculating the closing flags before
1655 * each iteration we avoid any problems.
1656 */
1657 while (1) {
1658 /* Guard against races with tty->count changes elsewhere and
1659 opens on /dev/tty */
Alan Cox37bdfb02008-02-08 04:18:47 -08001660
Ingo Molnar70522e12006-03-23 03:00:31 -08001661 mutex_lock(&tty_mutex);
Arnd Bergmannec79d602010-06-01 22:53:01 +02001662 tty_lock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001663 tty_closing = tty->count <= 1;
1664 o_tty_closing = o_tty &&
1665 (o_tty->count <= (pty_master ? 1 : 0));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001666 do_sleep = 0;
1667
1668 if (tty_closing) {
1669 if (waitqueue_active(&tty->read_wait)) {
Davide Libenzi4b194492009-03-31 15:24:24 -07001670 wake_up_poll(&tty->read_wait, POLLIN);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001671 do_sleep++;
1672 }
1673 if (waitqueue_active(&tty->write_wait)) {
Davide Libenzi4b194492009-03-31 15:24:24 -07001674 wake_up_poll(&tty->write_wait, POLLOUT);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001675 do_sleep++;
1676 }
1677 }
1678 if (o_tty_closing) {
1679 if (waitqueue_active(&o_tty->read_wait)) {
Davide Libenzi4b194492009-03-31 15:24:24 -07001680 wake_up_poll(&o_tty->read_wait, POLLIN);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001681 do_sleep++;
1682 }
1683 if (waitqueue_active(&o_tty->write_wait)) {
Davide Libenzi4b194492009-03-31 15:24:24 -07001684 wake_up_poll(&o_tty->write_wait, POLLOUT);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001685 do_sleep++;
1686 }
1687 }
1688 if (!do_sleep)
1689 break;
1690
Alan Coxd81ed102008-10-13 10:41:42 +01001691 printk(KERN_WARNING "tty_release_dev: %s: read/write wait queue "
Linus Torvalds1da177e2005-04-16 15:20:36 -07001692 "active!\n", tty_name(tty, buf));
Arnd Bergmannec79d602010-06-01 22:53:01 +02001693 tty_unlock();
Ingo Molnar70522e12006-03-23 03:00:31 -08001694 mutex_unlock(&tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001695 schedule();
Alan Cox37bdfb02008-02-08 04:18:47 -08001696 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001697
1698 /*
Alan Cox37bdfb02008-02-08 04:18:47 -08001699 * The closing flags are now consistent with the open counts on
1700 * both sides, and we've completed the last operation that could
Linus Torvalds1da177e2005-04-16 15:20:36 -07001701 * block, so it's safe to proceed with closing.
1702 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001703 if (pty_master) {
1704 if (--o_tty->count < 0) {
Alan Coxd81ed102008-10-13 10:41:42 +01001705 printk(KERN_WARNING "tty_release_dev: bad pty slave count "
Linus Torvalds1da177e2005-04-16 15:20:36 -07001706 "(%d) for %s\n",
1707 o_tty->count, tty_name(o_tty, buf));
1708 o_tty->count = 0;
1709 }
1710 }
1711 if (--tty->count < 0) {
Alan Coxd81ed102008-10-13 10:41:42 +01001712 printk(KERN_WARNING "tty_release_dev: bad tty->count (%d) for %s\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07001713 tty->count, tty_name(tty, buf));
1714 tty->count = 0;
1715 }
Alan Cox37bdfb02008-02-08 04:18:47 -08001716
Linus Torvalds1da177e2005-04-16 15:20:36 -07001717 /*
1718 * We've decremented tty->count, so we need to remove this file
1719 * descriptor off the tty->tty_files list; this serves two
1720 * purposes:
1721 * - check_tty_count sees the correct number of file descriptors
1722 * associated with this tty.
1723 * - do_tty_hangup no longer sees this file descriptor as
1724 * something that needs to be handled for hangups.
1725 */
Nick Piggind996b622010-08-18 04:37:36 +10001726 tty_del_file(filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001727
1728 /*
1729 * Perform some housekeeping before deciding whether to return.
1730 *
1731 * Set the TTY_CLOSING flag if this was the last open. In the
1732 * case of a pty we may have to wait around for the other side
1733 * to close, and TTY_CLOSING makes sure we can't be reopened.
1734 */
Alan Cox37bdfb02008-02-08 04:18:47 -08001735 if (tty_closing)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001736 set_bit(TTY_CLOSING, &tty->flags);
Alan Cox37bdfb02008-02-08 04:18:47 -08001737 if (o_tty_closing)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001738 set_bit(TTY_CLOSING, &o_tty->flags);
1739
1740 /*
1741 * If _either_ side is closing, make sure there aren't any
1742 * processes that still think tty or o_tty is their controlling
1743 * tty.
1744 */
1745 if (tty_closing || o_tty_closing) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001746 read_lock(&tasklist_lock);
Peter Zijlstra24ec8392006-12-08 02:36:04 -08001747 session_clear_tty(tty->session);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001748 if (o_tty)
Peter Zijlstra24ec8392006-12-08 02:36:04 -08001749 session_clear_tty(o_tty->session);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001750 read_unlock(&tasklist_lock);
1751 }
1752
Ingo Molnar70522e12006-03-23 03:00:31 -08001753 mutex_unlock(&tty_mutex);
Paul Fulghumda965822006-02-14 13:53:00 -08001754
Linus Torvalds1da177e2005-04-16 15:20:36 -07001755 /* check whether both sides are closing ... */
Alan Coxeeb89d92009-11-30 13:18:29 +00001756 if (!tty_closing || (o_tty && !o_tty_closing)) {
Arnd Bergmannec79d602010-06-01 22:53:01 +02001757 tty_unlock();
Alan Coxeeb89d92009-11-30 13:18:29 +00001758 return 0;
1759 }
Alan Cox37bdfb02008-02-08 04:18:47 -08001760
Linus Torvalds1da177e2005-04-16 15:20:36 -07001761#ifdef TTY_DEBUG_HANGUP
1762 printk(KERN_DEBUG "freeing tty structure...");
1763#endif
1764 /*
Alan Cox01e1abb2008-07-22 11:16:55 +01001765 * Ask the line discipline code to release its structures
Linus Torvalds1da177e2005-04-16 15:20:36 -07001766 */
Alan Cox01e1abb2008-07-22 11:16:55 +01001767 tty_ldisc_release(tty, o_tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001768 /*
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001769 * The release_tty function takes care of the details of clearing
Linus Torvalds1da177e2005-04-16 15:20:36 -07001770 * the slots and preserving the termios structure.
1771 */
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001772 release_tty(tty, idx);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001773
Linus Torvalds1da177e2005-04-16 15:20:36 -07001774 /* Make this pty number available for reallocation */
Sukadev Bhattiprolu718a9162008-04-30 00:54:21 -07001775 if (devpts)
Sukadev Bhattiprolu15f1a632008-10-13 10:42:59 +01001776 devpts_kill_index(inode, idx);
Arnd Bergmannec79d602010-06-01 22:53:01 +02001777 tty_unlock();
Alan Coxeeb89d92009-11-30 13:18:29 +00001778 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001779}
1780
Alan Coxaf9b8972006-08-27 01:24:01 -07001781/**
Alan Coxeeb89d92009-11-30 13:18:29 +00001782 * tty_open - open a tty device
Alan Coxaf9b8972006-08-27 01:24:01 -07001783 * @inode: inode of device file
1784 * @filp: file pointer to tty
Linus Torvalds1da177e2005-04-16 15:20:36 -07001785 *
Alan Coxaf9b8972006-08-27 01:24:01 -07001786 * tty_open and tty_release keep up the tty count that contains the
1787 * number of opens done on a tty. We cannot use the inode-count, as
1788 * different inodes might point to the same tty.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001789 *
Alan Coxaf9b8972006-08-27 01:24:01 -07001790 * Open-counting is needed for pty masters, as well as for keeping
1791 * track of serial lines: DTR is dropped when the last close happens.
1792 * (This is not done solely through tty->count, now. - Ted 1/27/92)
1793 *
1794 * The termios state of a pty is reset on first open so that
1795 * settings don't persist across reuse.
1796 *
Alan Coxd81ed102008-10-13 10:41:42 +01001797 * Locking: tty_mutex protects tty, get_tty_driver and tty_init_dev work.
Peter Zijlstra24ec8392006-12-08 02:36:04 -08001798 * tty->count should protect the rest.
1799 * ->siglock protects ->signal/->sighand
Linus Torvalds1da177e2005-04-16 15:20:36 -07001800 */
Alan Coxaf9b8972006-08-27 01:24:01 -07001801
Alan Coxeeb89d92009-11-30 13:18:29 +00001802static int tty_open(struct inode *inode, struct file *filp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001803{
Sukadev Bhattiprolu4a2b5fd2008-10-13 10:42:49 +01001804 struct tty_struct *tty = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001805 int noctty, retval;
1806 struct tty_driver *driver;
1807 int index;
1808 dev_t device = inode->i_rdev;
Andrew Morton846c1512009-04-02 16:56:36 -07001809 unsigned saved_flags = filp->f_flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001810
1811 nonseekable_open(inode, filp);
Alan Cox37bdfb02008-02-08 04:18:47 -08001812
Linus Torvalds1da177e2005-04-16 15:20:36 -07001813retry_open:
1814 noctty = filp->f_flags & O_NOCTTY;
1815 index = -1;
1816 retval = 0;
Alan Cox37bdfb02008-02-08 04:18:47 -08001817
Ingo Molnar70522e12006-03-23 03:00:31 -08001818 mutex_lock(&tty_mutex);
Arnd Bergmannec79d602010-06-01 22:53:01 +02001819 tty_lock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001820
Alan Cox37bdfb02008-02-08 04:18:47 -08001821 if (device == MKDEV(TTYAUX_MAJOR, 0)) {
Peter Zijlstra24ec8392006-12-08 02:36:04 -08001822 tty = get_current_tty();
1823 if (!tty) {
Arnd Bergmannec79d602010-06-01 22:53:01 +02001824 tty_unlock();
Ingo Molnar70522e12006-03-23 03:00:31 -08001825 mutex_unlock(&tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001826 return -ENXIO;
1827 }
Alan Cox7d7b93c2008-10-13 10:42:09 +01001828 driver = tty_driver_kref_get(tty->driver);
Peter Zijlstra24ec8392006-12-08 02:36:04 -08001829 index = tty->index;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001830 filp->f_flags |= O_NONBLOCK; /* Don't let /dev/tty block */
1831 /* noctty = 1; */
Alan Cox452a00d2008-10-13 10:39:13 +01001832 /* FIXME: Should we take a driver reference ? */
1833 tty_kref_put(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001834 goto got_driver;
1835 }
1836#ifdef CONFIG_VT
Alan Cox37bdfb02008-02-08 04:18:47 -08001837 if (device == MKDEV(TTY_MAJOR, 0)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001838 extern struct tty_driver *console_driver;
Alan Cox7d7b93c2008-10-13 10:42:09 +01001839 driver = tty_driver_kref_get(console_driver);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001840 index = fg_console;
1841 noctty = 1;
1842 goto got_driver;
1843 }
1844#endif
Alan Cox37bdfb02008-02-08 04:18:47 -08001845 if (device == MKDEV(TTYAUX_MAJOR, 1)) {
Will Newton296fa7f2008-12-01 11:36:06 +00001846 struct tty_driver *console_driver = console_device(&index);
1847 if (console_driver) {
1848 driver = tty_driver_kref_get(console_driver);
1849 if (driver) {
1850 /* Don't let /dev/console block */
1851 filp->f_flags |= O_NONBLOCK;
1852 noctty = 1;
1853 goto got_driver;
1854 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001855 }
Arnd Bergmannec79d602010-06-01 22:53:01 +02001856 tty_unlock();
Ingo Molnar70522e12006-03-23 03:00:31 -08001857 mutex_unlock(&tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001858 return -ENODEV;
1859 }
1860
1861 driver = get_tty_driver(device, &index);
1862 if (!driver) {
Arnd Bergmannec79d602010-06-01 22:53:01 +02001863 tty_unlock();
Ingo Molnar70522e12006-03-23 03:00:31 -08001864 mutex_unlock(&tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001865 return -ENODEV;
1866 }
1867got_driver:
Sukadev Bhattiprolu4a2b5fd2008-10-13 10:42:49 +01001868 if (!tty) {
1869 /* check whether we're reopening an existing tty */
Sukadev Bhattiprolu15f1a632008-10-13 10:42:59 +01001870 tty = tty_driver_lookup_tty(driver, inode, index);
Sukadev Bhattiprolu4a2b5fd2008-10-13 10:42:49 +01001871
Eric Paris808ffa32009-01-27 11:50:37 +00001872 if (IS_ERR(tty)) {
Arnd Bergmannec79d602010-06-01 22:53:01 +02001873 tty_unlock();
Eric Paris808ffa32009-01-27 11:50:37 +00001874 mutex_unlock(&tty_mutex);
Sukadev Bhattiprolu4a2b5fd2008-10-13 10:42:49 +01001875 return PTR_ERR(tty);
Eric Paris808ffa32009-01-27 11:50:37 +00001876 }
Sukadev Bhattiprolu4a2b5fd2008-10-13 10:42:49 +01001877 }
1878
1879 if (tty) {
1880 retval = tty_reopen(tty);
1881 if (retval)
1882 tty = ERR_PTR(retval);
1883 } else
1884 tty = tty_init_dev(driver, index, 0);
1885
Ingo Molnar70522e12006-03-23 03:00:31 -08001886 mutex_unlock(&tty_mutex);
Alan Cox7d7b93c2008-10-13 10:42:09 +01001887 tty_driver_kref_put(driver);
Alan Coxeeb89d92009-11-30 13:18:29 +00001888 if (IS_ERR(tty)) {
Arnd Bergmannec79d602010-06-01 22:53:01 +02001889 tty_unlock();
Alan Cox73ec06f2008-10-13 10:42:29 +01001890 return PTR_ERR(tty);
Alan Coxeeb89d92009-11-30 13:18:29 +00001891 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001892
Pekka Enbergf573bd12010-08-24 07:48:34 +03001893 retval = tty_add_file(tty, filp);
1894 if (retval) {
1895 tty_unlock();
1896 return retval;
1897 }
Nick Piggind996b622010-08-18 04:37:36 +10001898
Linus Torvalds1da177e2005-04-16 15:20:36 -07001899 check_tty_count(tty, "tty_open");
1900 if (tty->driver->type == TTY_DRIVER_TYPE_PTY &&
1901 tty->driver->subtype == PTY_TYPE_MASTER)
1902 noctty = 1;
1903#ifdef TTY_DEBUG_HANGUP
1904 printk(KERN_DEBUG "opening %s...", tty->name);
1905#endif
Herton Ronaldo Krzesinski909bc772011-03-31 15:35:31 -03001906 if (tty->ops->open)
1907 retval = tty->ops->open(tty, filp);
1908 else
1909 retval = -ENODEV;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001910 filp->f_flags = saved_flags;
1911
Alan Cox37bdfb02008-02-08 04:18:47 -08001912 if (!retval && test_bit(TTY_EXCLUSIVE, &tty->flags) &&
1913 !capable(CAP_SYS_ADMIN))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001914 retval = -EBUSY;
1915
1916 if (retval) {
1917#ifdef TTY_DEBUG_HANGUP
1918 printk(KERN_DEBUG "error %d in opening %s...", retval,
1919 tty->name);
1920#endif
Arnd Bergmann64ba3dc2010-06-01 22:53:02 +02001921 tty_unlock(); /* need to call tty_release without BTM */
Alan Coxeeb89d92009-11-30 13:18:29 +00001922 tty_release(inode, filp);
Arnd Bergmann64ba3dc2010-06-01 22:53:02 +02001923 if (retval != -ERESTARTSYS)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001924 return retval;
Arnd Bergmann64ba3dc2010-06-01 22:53:02 +02001925
1926 if (signal_pending(current))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001927 return retval;
Arnd Bergmann64ba3dc2010-06-01 22:53:02 +02001928
Linus Torvalds1da177e2005-04-16 15:20:36 -07001929 schedule();
1930 /*
1931 * Need to reset f_op in case a hangup happened.
1932 */
Arnd Bergmann64ba3dc2010-06-01 22:53:02 +02001933 tty_lock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001934 if (filp->f_op == &hung_up_tty_fops)
1935 filp->f_op = &tty_fops;
Arnd Bergmannec79d602010-06-01 22:53:01 +02001936 tty_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001937 goto retry_open;
1938 }
Arnd Bergmannec79d602010-06-01 22:53:01 +02001939 tty_unlock();
Alan Coxeeb89d92009-11-30 13:18:29 +00001940
Peter Zijlstra24ec8392006-12-08 02:36:04 -08001941
1942 mutex_lock(&tty_mutex);
Arnd Bergmannec79d602010-06-01 22:53:01 +02001943 tty_lock();
Peter Zijlstra24ec8392006-12-08 02:36:04 -08001944 spin_lock_irq(&current->sighand->siglock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001945 if (!noctty &&
1946 current->signal->leader &&
1947 !current->signal->tty &&
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08001948 tty->session == NULL)
Eric W. Biederman2a65f1d2007-05-08 00:26:53 -07001949 __proc_set_tty(current, tty);
Peter Zijlstra24ec8392006-12-08 02:36:04 -08001950 spin_unlock_irq(&current->sighand->siglock);
Arnd Bergmannec79d602010-06-01 22:53:01 +02001951 tty_unlock();
Peter Zijlstra24ec8392006-12-08 02:36:04 -08001952 mutex_unlock(&tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001953 return 0;
1954}
1955
Jonathan Corbet39d95b92008-05-16 09:10:50 -06001956
Linus Torvalds1da177e2005-04-16 15:20:36 -07001957
Alan Coxaf9b8972006-08-27 01:24:01 -07001958/**
1959 * tty_poll - check tty status
1960 * @filp: file being polled
1961 * @wait: poll wait structures to update
1962 *
1963 * Call the line discipline polling method to obtain the poll
1964 * status of the device.
1965 *
1966 * Locking: locks called line discipline but ldisc poll method
1967 * may be re-entered freely by other callers.
1968 */
1969
Alan Cox37bdfb02008-02-08 04:18:47 -08001970static unsigned int tty_poll(struct file *filp, poll_table *wait)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001971{
Nick Piggind996b622010-08-18 04:37:36 +10001972 struct tty_struct *tty = file_tty(filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001973 struct tty_ldisc *ld;
1974 int ret = 0;
1975
Josef Sipeka7113a92006-12-08 02:36:55 -08001976 if (tty_paranoia_check(tty, filp->f_path.dentry->d_inode, "tty_poll"))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001977 return 0;
Alan Cox37bdfb02008-02-08 04:18:47 -08001978
Linus Torvalds1da177e2005-04-16 15:20:36 -07001979 ld = tty_ldisc_ref_wait(tty);
Alan Coxa352def2008-07-16 21:53:12 +01001980 if (ld->ops->poll)
1981 ret = (ld->ops->poll)(tty, filp, wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001982 tty_ldisc_deref(ld);
1983 return ret;
1984}
1985
Arnd Bergmannec79d602010-06-01 22:53:01 +02001986static int __tty_fasync(int fd, struct file *filp, int on)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001987{
Nick Piggind996b622010-08-18 04:37:36 +10001988 struct tty_struct *tty = file_tty(filp);
Alan Cox47f86832008-04-30 00:53:30 -07001989 unsigned long flags;
Jonathan Corbet5d1e3232008-06-19 16:04:53 -06001990 int retval = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001991
Josef Sipeka7113a92006-12-08 02:36:55 -08001992 if (tty_paranoia_check(tty, filp->f_path.dentry->d_inode, "tty_fasync"))
Jonathan Corbet5d1e3232008-06-19 16:04:53 -06001993 goto out;
Alan Cox37bdfb02008-02-08 04:18:47 -08001994
Linus Torvalds1da177e2005-04-16 15:20:36 -07001995 retval = fasync_helper(fd, filp, on, &tty->fasync);
1996 if (retval <= 0)
Jonathan Corbet5d1e3232008-06-19 16:04:53 -06001997 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001998
1999 if (on) {
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08002000 enum pid_type type;
2001 struct pid *pid;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002002 if (!waitqueue_active(&tty->read_wait))
2003 tty->minimum_to_wake = 1;
Alan Cox47f86832008-04-30 00:53:30 -07002004 spin_lock_irqsave(&tty->ctrl_lock, flags);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08002005 if (tty->pgrp) {
2006 pid = tty->pgrp;
2007 type = PIDTYPE_PGID;
2008 } else {
2009 pid = task_pid(current);
2010 type = PIDTYPE_PID;
2011 }
Linus Torvalds80e1e822010-02-07 10:11:23 -08002012 get_pid(pid);
Greg Kroah-Hartman70362512009-12-17 07:07:19 -08002013 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
Linus Torvalds80e1e822010-02-07 10:11:23 -08002014 retval = __f_setown(filp, pid, type, 0);
2015 put_pid(pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002016 if (retval)
Jonathan Corbet5d1e3232008-06-19 16:04:53 -06002017 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002018 } else {
2019 if (!tty->fasync && !waitqueue_active(&tty->read_wait))
2020 tty->minimum_to_wake = N_TTY_BUF_SIZE;
2021 }
Jonathan Corbet5d1e3232008-06-19 16:04:53 -06002022 retval = 0;
2023out:
Arnd Bergmannec79d602010-06-01 22:53:01 +02002024 return retval;
2025}
2026
2027static int tty_fasync(int fd, struct file *filp, int on)
2028{
2029 int retval;
2030 tty_lock();
2031 retval = __tty_fasync(fd, filp, on);
2032 tty_unlock();
Jonathan Corbet5d1e3232008-06-19 16:04:53 -06002033 return retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002034}
2035
Alan Coxaf9b8972006-08-27 01:24:01 -07002036/**
2037 * tiocsti - fake input character
2038 * @tty: tty to fake input into
2039 * @p: pointer to character
2040 *
Robert P. J. Day3a4fa0a2007-10-19 23:10:43 +02002041 * Fake input to a tty device. Does the necessary locking and
Alan Coxaf9b8972006-08-27 01:24:01 -07002042 * input management.
2043 *
2044 * FIXME: does not honour flow control ??
2045 *
2046 * Locking:
2047 * Called functions take tty_ldisc_lock
2048 * current->signal->tty check is safe without locks
Alan Cox28298232006-09-29 02:00:58 -07002049 *
2050 * FIXME: may race normal receive processing
Alan Coxaf9b8972006-08-27 01:24:01 -07002051 */
2052
Linus Torvalds1da177e2005-04-16 15:20:36 -07002053static int tiocsti(struct tty_struct *tty, char __user *p)
2054{
2055 char ch, mbz = 0;
2056 struct tty_ldisc *ld;
Alan Cox37bdfb02008-02-08 04:18:47 -08002057
Linus Torvalds1da177e2005-04-16 15:20:36 -07002058 if ((current->signal->tty != tty) && !capable(CAP_SYS_ADMIN))
2059 return -EPERM;
2060 if (get_user(ch, p))
2061 return -EFAULT;
Al Viro1e641742008-12-09 09:23:33 +00002062 tty_audit_tiocsti(tty, ch);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002063 ld = tty_ldisc_ref_wait(tty);
Alan Coxa352def2008-07-16 21:53:12 +01002064 ld->ops->receive_buf(tty, &ch, &mbz, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002065 tty_ldisc_deref(ld);
2066 return 0;
2067}
2068
Alan Coxaf9b8972006-08-27 01:24:01 -07002069/**
2070 * tiocgwinsz - implement window query ioctl
2071 * @tty; tty
2072 * @arg: user buffer for result
2073 *
Alan Cox808a0d32006-09-29 02:00:40 -07002074 * Copies the kernel idea of the window size into the user buffer.
Alan Coxaf9b8972006-08-27 01:24:01 -07002075 *
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002076 * Locking: tty->termios_mutex is taken to ensure the winsize data
Alan Cox808a0d32006-09-29 02:00:40 -07002077 * is consistent.
Alan Coxaf9b8972006-08-27 01:24:01 -07002078 */
2079
Alan Cox37bdfb02008-02-08 04:18:47 -08002080static int tiocgwinsz(struct tty_struct *tty, struct winsize __user *arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002081{
Alan Cox808a0d32006-09-29 02:00:40 -07002082 int err;
2083
Arjan van de Ven5785c952006-09-29 02:00:43 -07002084 mutex_lock(&tty->termios_mutex);
Alan Cox808a0d32006-09-29 02:00:40 -07002085 err = copy_to_user(arg, &tty->winsize, sizeof(*arg));
Arjan van de Ven5785c952006-09-29 02:00:43 -07002086 mutex_unlock(&tty->termios_mutex);
Alan Cox808a0d32006-09-29 02:00:40 -07002087
2088 return err ? -EFAULT: 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002089}
2090
Alan Coxaf9b8972006-08-27 01:24:01 -07002091/**
Alan Cox8c9a9dd2008-08-15 10:39:38 +01002092 * tty_do_resize - resize event
2093 * @tty: tty being resized
Alan Cox8c9a9dd2008-08-15 10:39:38 +01002094 * @rows: rows (character)
2095 * @cols: cols (character)
Alan Coxaf9b8972006-08-27 01:24:01 -07002096 *
Daniel Mack3ad2f3f2010-02-03 08:01:28 +08002097 * Update the termios variables and send the necessary signals to
Alan Cox8c9a9dd2008-08-15 10:39:38 +01002098 * peform a terminal resize correctly
Alan Coxaf9b8972006-08-27 01:24:01 -07002099 */
2100
Alan Coxfc6f6232009-01-02 13:43:17 +00002101int tty_do_resize(struct tty_struct *tty, struct winsize *ws)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002102{
Alan Coxfc6f6232009-01-02 13:43:17 +00002103 struct pid *pgrp;
Alan Cox47f86832008-04-30 00:53:30 -07002104 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002105
Alan Coxfc6f6232009-01-02 13:43:17 +00002106 /* Lock the tty */
2107 mutex_lock(&tty->termios_mutex);
2108 if (!memcmp(ws, &tty->winsize, sizeof(*ws)))
Alan Coxca9bda02006-09-29 02:00:03 -07002109 goto done;
Alan Cox47f86832008-04-30 00:53:30 -07002110 /* Get the PID values and reference them so we can
2111 avoid holding the tty ctrl lock while sending signals */
2112 spin_lock_irqsave(&tty->ctrl_lock, flags);
2113 pgrp = get_pid(tty->pgrp);
Alan Cox47f86832008-04-30 00:53:30 -07002114 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
2115
2116 if (pgrp)
2117 kill_pgrp(pgrp, SIGWINCH, 1);
Alan Cox47f86832008-04-30 00:53:30 -07002118 put_pid(pgrp);
Alan Cox47f86832008-04-30 00:53:30 -07002119
Alan Cox8c9a9dd2008-08-15 10:39:38 +01002120 tty->winsize = *ws;
Alan Coxca9bda02006-09-29 02:00:03 -07002121done:
Alan Coxfc6f6232009-01-02 13:43:17 +00002122 mutex_unlock(&tty->termios_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002123 return 0;
2124}
2125
Alan Coxaf9b8972006-08-27 01:24:01 -07002126/**
Alan Cox8c9a9dd2008-08-15 10:39:38 +01002127 * tiocswinsz - implement window size set ioctl
Alan Coxfc6f6232009-01-02 13:43:17 +00002128 * @tty; tty side of tty
Alan Cox8c9a9dd2008-08-15 10:39:38 +01002129 * @arg: user buffer for result
2130 *
2131 * Copies the user idea of the window size to the kernel. Traditionally
2132 * this is just advisory information but for the Linux console it
2133 * actually has driver level meaning and triggers a VC resize.
2134 *
2135 * Locking:
Lucas De Marchi25985ed2011-03-30 22:57:33 -03002136 * Driver dependent. The default do_resize method takes the
Alan Cox8c9a9dd2008-08-15 10:39:38 +01002137 * tty termios mutex and ctrl_lock. The console takes its own lock
2138 * then calls into the default method.
2139 */
2140
Alan Coxfc6f6232009-01-02 13:43:17 +00002141static int tiocswinsz(struct tty_struct *tty, struct winsize __user *arg)
Alan Cox8c9a9dd2008-08-15 10:39:38 +01002142{
2143 struct winsize tmp_ws;
2144 if (copy_from_user(&tmp_ws, arg, sizeof(*arg)))
2145 return -EFAULT;
2146
2147 if (tty->ops->resize)
Alan Coxfc6f6232009-01-02 13:43:17 +00002148 return tty->ops->resize(tty, &tmp_ws);
Alan Cox8c9a9dd2008-08-15 10:39:38 +01002149 else
Alan Coxfc6f6232009-01-02 13:43:17 +00002150 return tty_do_resize(tty, &tmp_ws);
Alan Cox8c9a9dd2008-08-15 10:39:38 +01002151}
2152
2153/**
Alan Coxaf9b8972006-08-27 01:24:01 -07002154 * tioccons - allow admin to move logical console
2155 * @file: the file to become console
2156 *
Lucas De Marchi25985ed2011-03-30 22:57:33 -03002157 * Allow the administrator to move the redirected console device
Alan Coxaf9b8972006-08-27 01:24:01 -07002158 *
2159 * Locking: uses redirect_lock to guard the redirect information
2160 */
2161
Linus Torvalds1da177e2005-04-16 15:20:36 -07002162static int tioccons(struct file *file)
2163{
2164 if (!capable(CAP_SYS_ADMIN))
2165 return -EPERM;
2166 if (file->f_op->write == redirected_tty_write) {
2167 struct file *f;
2168 spin_lock(&redirect_lock);
2169 f = redirect;
2170 redirect = NULL;
2171 spin_unlock(&redirect_lock);
2172 if (f)
2173 fput(f);
2174 return 0;
2175 }
2176 spin_lock(&redirect_lock);
2177 if (redirect) {
2178 spin_unlock(&redirect_lock);
2179 return -EBUSY;
2180 }
2181 get_file(file);
2182 redirect = file;
2183 spin_unlock(&redirect_lock);
2184 return 0;
2185}
2186
Alan Coxaf9b8972006-08-27 01:24:01 -07002187/**
2188 * fionbio - non blocking ioctl
2189 * @file: file to set blocking value
2190 * @p: user parameter
2191 *
2192 * Historical tty interfaces had a blocking control ioctl before
2193 * the generic functionality existed. This piece of history is preserved
2194 * in the expected tty API of posix OS's.
2195 *
Alan Cox6146b9a2009-09-19 13:13:19 -07002196 * Locking: none, the open file handle ensures it won't go away.
Alan Coxaf9b8972006-08-27 01:24:01 -07002197 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002198
2199static int fionbio(struct file *file, int __user *p)
2200{
2201 int nonblock;
2202
2203 if (get_user(nonblock, p))
2204 return -EFAULT;
2205
Jonathan Corbetdb1dd4d2009-02-06 15:25:24 -07002206 spin_lock(&file->f_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002207 if (nonblock)
2208 file->f_flags |= O_NONBLOCK;
2209 else
2210 file->f_flags &= ~O_NONBLOCK;
Jonathan Corbetdb1dd4d2009-02-06 15:25:24 -07002211 spin_unlock(&file->f_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002212 return 0;
2213}
2214
Alan Coxaf9b8972006-08-27 01:24:01 -07002215/**
2216 * tiocsctty - set controlling tty
2217 * @tty: tty structure
2218 * @arg: user argument
2219 *
2220 * This ioctl is used to manage job control. It permits a session
2221 * leader to set this tty as the controlling tty for the session.
2222 *
2223 * Locking:
Alan Cox28298232006-09-29 02:00:58 -07002224 * Takes tty_mutex() to protect tty instance
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002225 * Takes tasklist_lock internally to walk sessions
2226 * Takes ->siglock() when updating signal->tty
Alan Coxaf9b8972006-08-27 01:24:01 -07002227 */
2228
Linus Torvalds1da177e2005-04-16 15:20:36 -07002229static int tiocsctty(struct tty_struct *tty, int arg)
2230{
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002231 int ret = 0;
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08002232 if (current->signal->leader && (task_session(current) == tty->session))
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002233 return ret;
2234
2235 mutex_lock(&tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002236 /*
2237 * The process must be a session leader and
2238 * not have a controlling tty already.
2239 */
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002240 if (!current->signal->leader || current->signal->tty) {
2241 ret = -EPERM;
2242 goto unlock;
2243 }
2244
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08002245 if (tty->session) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002246 /*
2247 * This tty is already the controlling
2248 * tty for another session group!
2249 */
Alan Cox37bdfb02008-02-08 04:18:47 -08002250 if (arg == 1 && capable(CAP_SYS_ADMIN)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002251 /*
2252 * Steal it away
2253 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002254 read_lock(&tasklist_lock);
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002255 session_clear_tty(tty->session);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002256 read_unlock(&tasklist_lock);
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002257 } else {
2258 ret = -EPERM;
2259 goto unlock;
2260 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002261 }
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002262 proc_set_tty(current, tty);
2263unlock:
Alan Cox28298232006-09-29 02:00:58 -07002264 mutex_unlock(&tty_mutex);
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002265 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002266}
2267
Alan Coxaf9b8972006-08-27 01:24:01 -07002268/**
Alan Cox5d0fdf12008-04-30 00:53:31 -07002269 * tty_get_pgrp - return a ref counted pgrp pid
2270 * @tty: tty to read
2271 *
2272 * Returns a refcounted instance of the pid struct for the process
2273 * group controlling the tty.
2274 */
2275
2276struct pid *tty_get_pgrp(struct tty_struct *tty)
2277{
2278 unsigned long flags;
2279 struct pid *pgrp;
2280
2281 spin_lock_irqsave(&tty->ctrl_lock, flags);
2282 pgrp = get_pid(tty->pgrp);
2283 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
2284
2285 return pgrp;
2286}
2287EXPORT_SYMBOL_GPL(tty_get_pgrp);
2288
2289/**
Alan Coxaf9b8972006-08-27 01:24:01 -07002290 * tiocgpgrp - get process group
2291 * @tty: tty passed by user
Lucas De Marchi25985ed2011-03-30 22:57:33 -03002292 * @real_tty: tty side of the tty passed by the user if a pty else the tty
Alan Coxaf9b8972006-08-27 01:24:01 -07002293 * @p: returned pid
2294 *
2295 * Obtain the process group of the tty. If there is no process group
2296 * return an error.
2297 *
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002298 * Locking: none. Reference to current->signal->tty is safe.
Alan Coxaf9b8972006-08-27 01:24:01 -07002299 */
2300
Linus Torvalds1da177e2005-04-16 15:20:36 -07002301static int tiocgpgrp(struct tty_struct *tty, struct tty_struct *real_tty, pid_t __user *p)
2302{
Alan Cox5d0fdf12008-04-30 00:53:31 -07002303 struct pid *pid;
2304 int ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002305 /*
2306 * (tty == real_tty) is a cheap way of
2307 * testing if the tty is NOT a master pty.
2308 */
2309 if (tty == real_tty && current->signal->tty != real_tty)
2310 return -ENOTTY;
Alan Cox5d0fdf12008-04-30 00:53:31 -07002311 pid = tty_get_pgrp(real_tty);
2312 ret = put_user(pid_vnr(pid), p);
2313 put_pid(pid);
2314 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002315}
2316
Alan Coxaf9b8972006-08-27 01:24:01 -07002317/**
2318 * tiocspgrp - attempt to set process group
2319 * @tty: tty passed by user
2320 * @real_tty: tty side device matching tty passed by user
2321 * @p: pid pointer
2322 *
2323 * Set the process group of the tty to the session passed. Only
2324 * permitted where the tty session is our session.
2325 *
Alan Cox47f86832008-04-30 00:53:30 -07002326 * Locking: RCU, ctrl lock
Alan Coxaf9b8972006-08-27 01:24:01 -07002327 */
2328
Linus Torvalds1da177e2005-04-16 15:20:36 -07002329static int tiocspgrp(struct tty_struct *tty, struct tty_struct *real_tty, pid_t __user *p)
2330{
Eric W. Biederman04a2e6a2007-02-12 00:52:56 -08002331 struct pid *pgrp;
2332 pid_t pgrp_nr;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002333 int retval = tty_check_change(real_tty);
Alan Cox47f86832008-04-30 00:53:30 -07002334 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002335
2336 if (retval == -EIO)
2337 return -ENOTTY;
2338 if (retval)
2339 return retval;
2340 if (!current->signal->tty ||
2341 (current->signal->tty != real_tty) ||
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08002342 (real_tty->session != task_session(current)))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002343 return -ENOTTY;
Eric W. Biederman04a2e6a2007-02-12 00:52:56 -08002344 if (get_user(pgrp_nr, p))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002345 return -EFAULT;
Eric W. Biederman04a2e6a2007-02-12 00:52:56 -08002346 if (pgrp_nr < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002347 return -EINVAL;
Eric W. Biederman04a2e6a2007-02-12 00:52:56 -08002348 rcu_read_lock();
Pavel Emelyanovb4888932007-10-18 23:40:14 -07002349 pgrp = find_vpid(pgrp_nr);
Eric W. Biederman04a2e6a2007-02-12 00:52:56 -08002350 retval = -ESRCH;
2351 if (!pgrp)
2352 goto out_unlock;
2353 retval = -EPERM;
2354 if (session_of_pgrp(pgrp) != task_session(current))
2355 goto out_unlock;
2356 retval = 0;
Alan Cox47f86832008-04-30 00:53:30 -07002357 spin_lock_irqsave(&tty->ctrl_lock, flags);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08002358 put_pid(real_tty->pgrp);
2359 real_tty->pgrp = get_pid(pgrp);
Alan Cox47f86832008-04-30 00:53:30 -07002360 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
Eric W. Biederman04a2e6a2007-02-12 00:52:56 -08002361out_unlock:
2362 rcu_read_unlock();
2363 return retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002364}
2365
Alan Coxaf9b8972006-08-27 01:24:01 -07002366/**
2367 * tiocgsid - get session id
2368 * @tty: tty passed by user
Lucas De Marchi25985ed2011-03-30 22:57:33 -03002369 * @real_tty: tty side of the tty passed by the user if a pty else the tty
Alan Coxaf9b8972006-08-27 01:24:01 -07002370 * @p: pointer to returned session id
2371 *
2372 * Obtain the session id of the tty. If there is no session
2373 * return an error.
2374 *
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002375 * Locking: none. Reference to current->signal->tty is safe.
Alan Coxaf9b8972006-08-27 01:24:01 -07002376 */
2377
Linus Torvalds1da177e2005-04-16 15:20:36 -07002378static int tiocgsid(struct tty_struct *tty, struct tty_struct *real_tty, pid_t __user *p)
2379{
2380 /*
2381 * (tty == real_tty) is a cheap way of
2382 * testing if the tty is NOT a master pty.
2383 */
2384 if (tty == real_tty && current->signal->tty != real_tty)
2385 return -ENOTTY;
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08002386 if (!real_tty->session)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002387 return -ENOTTY;
Pavel Emelyanovb4888932007-10-18 23:40:14 -07002388 return put_user(pid_vnr(real_tty->session), p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002389}
2390
Alan Coxaf9b8972006-08-27 01:24:01 -07002391/**
2392 * tiocsetd - set line discipline
2393 * @tty: tty device
2394 * @p: pointer to user data
2395 *
2396 * Set the line discipline according to user request.
2397 *
2398 * Locking: see tty_set_ldisc, this function is just a helper
2399 */
2400
Linus Torvalds1da177e2005-04-16 15:20:36 -07002401static int tiocsetd(struct tty_struct *tty, int __user *p)
2402{
2403 int ldisc;
Alan Cox04f378b2008-04-30 00:53:29 -07002404 int ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002405
2406 if (get_user(ldisc, p))
2407 return -EFAULT;
Alan Cox04f378b2008-04-30 00:53:29 -07002408
Alan Cox04f378b2008-04-30 00:53:29 -07002409 ret = tty_set_ldisc(tty, ldisc);
Alan Cox04f378b2008-04-30 00:53:29 -07002410
2411 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002412}
2413
Alan Coxaf9b8972006-08-27 01:24:01 -07002414/**
2415 * send_break - performed time break
2416 * @tty: device to break on
2417 * @duration: timeout in mS
2418 *
2419 * Perform a timed break on hardware that lacks its own driver level
2420 * timed break functionality.
2421 *
2422 * Locking:
Alan Cox28298232006-09-29 02:00:58 -07002423 * atomic_write_lock serializes
Alan Coxaf9b8972006-08-27 01:24:01 -07002424 *
Alan Coxaf9b8972006-08-27 01:24:01 -07002425 */
2426
Domen Puncerb20f3ae2005-06-25 14:58:42 -07002427static int send_break(struct tty_struct *tty, unsigned int duration)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002428{
Alan Cox9e989662008-07-22 11:18:03 +01002429 int retval;
2430
2431 if (tty->ops->break_ctl == NULL)
2432 return 0;
2433
2434 if (tty->driver->flags & TTY_DRIVER_HARDWARE_BREAK)
2435 retval = tty->ops->break_ctl(tty, duration);
2436 else {
2437 /* Do the work ourselves */
2438 if (tty_write_lock(tty, 0) < 0)
2439 return -EINTR;
2440 retval = tty->ops->break_ctl(tty, -1);
2441 if (retval)
2442 goto out;
2443 if (!signal_pending(current))
2444 msleep_interruptible(duration);
2445 retval = tty->ops->break_ctl(tty, 0);
2446out:
2447 tty_write_unlock(tty);
2448 if (signal_pending(current))
2449 retval = -EINTR;
2450 }
2451 return retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002452}
2453
Alan Coxaf9b8972006-08-27 01:24:01 -07002454/**
Alan Coxf34d7a52008-04-30 00:54:13 -07002455 * tty_tiocmget - get modem status
Alan Coxaf9b8972006-08-27 01:24:01 -07002456 * @tty: tty device
2457 * @file: user file pointer
2458 * @p: pointer to result
2459 *
2460 * Obtain the modem status bits from the tty driver if the feature
2461 * is supported. Return -EINVAL if it is not available.
2462 *
2463 * Locking: none (up to the driver)
2464 */
2465
Alan Cox60b33c12011-02-14 16:26:14 +00002466static int tty_tiocmget(struct tty_struct *tty, int __user *p)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002467{
2468 int retval = -EINVAL;
2469
Alan Coxf34d7a52008-04-30 00:54:13 -07002470 if (tty->ops->tiocmget) {
Alan Cox60b33c12011-02-14 16:26:14 +00002471 retval = tty->ops->tiocmget(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002472
2473 if (retval >= 0)
2474 retval = put_user(retval, p);
2475 }
2476 return retval;
2477}
2478
Alan Coxaf9b8972006-08-27 01:24:01 -07002479/**
Alan Coxf34d7a52008-04-30 00:54:13 -07002480 * tty_tiocmset - set modem status
Alan Coxaf9b8972006-08-27 01:24:01 -07002481 * @tty: tty device
Alan Coxaf9b8972006-08-27 01:24:01 -07002482 * @cmd: command - clear bits, set bits or set all
2483 * @p: pointer to desired bits
2484 *
2485 * Set the modem status bits from the tty driver if the feature
2486 * is supported. Return -EINVAL if it is not available.
2487 *
2488 * Locking: none (up to the driver)
2489 */
2490
Alan Cox20b9d172011-02-14 16:26:50 +00002491static int tty_tiocmset(struct tty_struct *tty, unsigned int cmd,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002492 unsigned __user *p)
2493{
Alan Coxae677512008-07-16 21:56:54 +01002494 int retval;
2495 unsigned int set, clear, val;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002496
Alan Coxae677512008-07-16 21:56:54 +01002497 if (tty->ops->tiocmset == NULL)
2498 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002499
Alan Coxae677512008-07-16 21:56:54 +01002500 retval = get_user(val, p);
2501 if (retval)
2502 return retval;
2503 set = clear = 0;
2504 switch (cmd) {
2505 case TIOCMBIS:
2506 set = val;
2507 break;
2508 case TIOCMBIC:
2509 clear = val;
2510 break;
2511 case TIOCMSET:
2512 set = val;
2513 clear = ~val;
2514 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002515 }
Alan Coxae677512008-07-16 21:56:54 +01002516 set &= TIOCM_DTR|TIOCM_RTS|TIOCM_OUT1|TIOCM_OUT2|TIOCM_LOOP;
2517 clear &= TIOCM_DTR|TIOCM_RTS|TIOCM_OUT1|TIOCM_OUT2|TIOCM_LOOP;
Alan Cox20b9d172011-02-14 16:26:50 +00002518 return tty->ops->tiocmset(tty, set, clear);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002519}
2520
Alan Coxd281da72010-09-16 18:21:24 +01002521static int tty_tiocgicount(struct tty_struct *tty, void __user *arg)
2522{
2523 int retval = -EINVAL;
2524 struct serial_icounter_struct icount;
2525 memset(&icount, 0, sizeof(icount));
2526 if (tty->ops->get_icount)
2527 retval = tty->ops->get_icount(tty, &icount);
2528 if (retval != 0)
2529 return retval;
2530 if (copy_to_user(arg, &icount, sizeof(icount)))
2531 return -EFAULT;
2532 return 0;
2533}
2534
Alan Coxe8b70e72009-06-11 12:48:02 +01002535struct tty_struct *tty_pair_get_tty(struct tty_struct *tty)
2536{
2537 if (tty->driver->type == TTY_DRIVER_TYPE_PTY &&
2538 tty->driver->subtype == PTY_TYPE_MASTER)
2539 tty = tty->link;
2540 return tty;
2541}
2542EXPORT_SYMBOL(tty_pair_get_tty);
2543
2544struct tty_struct *tty_pair_get_pty(struct tty_struct *tty)
2545{
2546 if (tty->driver->type == TTY_DRIVER_TYPE_PTY &&
2547 tty->driver->subtype == PTY_TYPE_MASTER)
2548 return tty;
2549 return tty->link;
2550}
2551EXPORT_SYMBOL(tty_pair_get_pty);
2552
Linus Torvalds1da177e2005-04-16 15:20:36 -07002553/*
2554 * Split this up, as gcc can choke on it otherwise..
2555 */
Alan Cox04f378b2008-04-30 00:53:29 -07002556long tty_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002557{
Nick Piggind996b622010-08-18 04:37:36 +10002558 struct tty_struct *tty = file_tty(file);
2559 struct tty_struct *real_tty;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002560 void __user *p = (void __user *)arg;
2561 int retval;
2562 struct tty_ldisc *ld;
Alan Cox04f378b2008-04-30 00:53:29 -07002563 struct inode *inode = file->f_dentry->d_inode;
Alan Cox37bdfb02008-02-08 04:18:47 -08002564
Linus Torvalds1da177e2005-04-16 15:20:36 -07002565 if (tty_paranoia_check(tty, inode, "tty_ioctl"))
2566 return -EINVAL;
2567
Alan Coxe8b70e72009-06-11 12:48:02 +01002568 real_tty = tty_pair_get_tty(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002569
2570 /*
2571 * Factor out some common prep work
2572 */
2573 switch (cmd) {
2574 case TIOCSETD:
2575 case TIOCSBRK:
2576 case TIOCCBRK:
2577 case TCSBRK:
Alan Cox37bdfb02008-02-08 04:18:47 -08002578 case TCSBRKP:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002579 retval = tty_check_change(tty);
2580 if (retval)
2581 return retval;
2582 if (cmd != TIOCCBRK) {
2583 tty_wait_until_sent(tty, 0);
2584 if (signal_pending(current))
2585 return -EINTR;
2586 }
2587 break;
2588 }
2589
Alan Cox9e989662008-07-22 11:18:03 +01002590 /*
2591 * Now do the stuff.
2592 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002593 switch (cmd) {
Alan Cox37bdfb02008-02-08 04:18:47 -08002594 case TIOCSTI:
2595 return tiocsti(tty, p);
2596 case TIOCGWINSZ:
Alan Cox8f520022008-10-13 10:38:46 +01002597 return tiocgwinsz(real_tty, p);
Alan Cox37bdfb02008-02-08 04:18:47 -08002598 case TIOCSWINSZ:
Alan Coxfc6f6232009-01-02 13:43:17 +00002599 return tiocswinsz(real_tty, p);
Alan Cox37bdfb02008-02-08 04:18:47 -08002600 case TIOCCONS:
2601 return real_tty != tty ? -EINVAL : tioccons(file);
2602 case FIONBIO:
2603 return fionbio(file, p);
2604 case TIOCEXCL:
2605 set_bit(TTY_EXCLUSIVE, &tty->flags);
2606 return 0;
2607 case TIOCNXCL:
2608 clear_bit(TTY_EXCLUSIVE, &tty->flags);
2609 return 0;
2610 case TIOCNOTTY:
2611 if (current->signal->tty != tty)
2612 return -ENOTTY;
2613 no_tty();
2614 return 0;
2615 case TIOCSCTTY:
2616 return tiocsctty(tty, arg);
2617 case TIOCGPGRP:
2618 return tiocgpgrp(tty, real_tty, p);
2619 case TIOCSPGRP:
2620 return tiocspgrp(tty, real_tty, p);
2621 case TIOCGSID:
2622 return tiocgsid(tty, real_tty, p);
2623 case TIOCGETD:
Alan Coxc65c9bc2009-06-11 12:50:12 +01002624 return put_user(tty->ldisc->ops->num, (int __user *)p);
Alan Cox37bdfb02008-02-08 04:18:47 -08002625 case TIOCSETD:
2626 return tiocsetd(tty, p);
Kay Sievers3c95c982011-02-17 18:39:28 +01002627 case TIOCVHANGUP:
2628 if (!capable(CAP_SYS_ADMIN))
2629 return -EPERM;
2630 tty_vhangup(tty);
2631 return 0;
Werner Finkb7b8de02010-12-03 12:48:23 +01002632 case TIOCGDEV:
2633 {
2634 unsigned int ret = new_encode_dev(tty_devnum(real_tty));
2635 return put_user(ret, (unsigned int __user *)p);
2636 }
Alan Cox37bdfb02008-02-08 04:18:47 -08002637 /*
2638 * Break handling
2639 */
2640 case TIOCSBRK: /* Turn break on, unconditionally */
Alan Coxf34d7a52008-04-30 00:54:13 -07002641 if (tty->ops->break_ctl)
Alan Cox9e989662008-07-22 11:18:03 +01002642 return tty->ops->break_ctl(tty, -1);
Alan Cox37bdfb02008-02-08 04:18:47 -08002643 return 0;
Alan Cox37bdfb02008-02-08 04:18:47 -08002644 case TIOCCBRK: /* Turn break off, unconditionally */
Alan Coxf34d7a52008-04-30 00:54:13 -07002645 if (tty->ops->break_ctl)
Alan Cox9e989662008-07-22 11:18:03 +01002646 return tty->ops->break_ctl(tty, 0);
Alan Cox37bdfb02008-02-08 04:18:47 -08002647 return 0;
2648 case TCSBRK: /* SVID version: non-zero arg --> no break */
2649 /* non-zero arg means wait for all output data
2650 * to be sent (performed above) but don't send break.
2651 * This is used by the tcdrain() termios function.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002652 */
Alan Cox37bdfb02008-02-08 04:18:47 -08002653 if (!arg)
2654 return send_break(tty, 250);
2655 return 0;
2656 case TCSBRKP: /* support for POSIX tcsendbreak() */
2657 return send_break(tty, arg ? arg*100 : 250);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002658
Alan Cox37bdfb02008-02-08 04:18:47 -08002659 case TIOCMGET:
Alan Cox60b33c12011-02-14 16:26:14 +00002660 return tty_tiocmget(tty, p);
Alan Cox37bdfb02008-02-08 04:18:47 -08002661 case TIOCMSET:
2662 case TIOCMBIC:
2663 case TIOCMBIS:
Alan Cox20b9d172011-02-14 16:26:50 +00002664 return tty_tiocmset(tty, cmd, p);
Alan Coxd281da72010-09-16 18:21:24 +01002665 case TIOCGICOUNT:
2666 retval = tty_tiocgicount(tty, p);
2667 /* For the moment allow fall through to the old method */
2668 if (retval != -EINVAL)
2669 return retval;
2670 break;
Alan Cox37bdfb02008-02-08 04:18:47 -08002671 case TCFLSH:
2672 switch (arg) {
2673 case TCIFLUSH:
2674 case TCIOFLUSH:
2675 /* flush tty buffer and allow ldisc to process ioctl */
2676 tty_buffer_flush(tty);
Paul Fulghumc5c34d42007-05-12 10:36:55 -07002677 break;
Alan Cox37bdfb02008-02-08 04:18:47 -08002678 }
2679 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002680 }
Alan Coxf34d7a52008-04-30 00:54:13 -07002681 if (tty->ops->ioctl) {
Alan Cox6caa76b2011-02-14 16:27:22 +00002682 retval = (tty->ops->ioctl)(tty, cmd, arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002683 if (retval != -ENOIOCTLCMD)
2684 return retval;
2685 }
2686 ld = tty_ldisc_ref_wait(tty);
2687 retval = -EINVAL;
Alan Coxa352def2008-07-16 21:53:12 +01002688 if (ld->ops->ioctl) {
2689 retval = ld->ops->ioctl(tty, file, cmd, arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002690 if (retval == -ENOIOCTLCMD)
2691 retval = -EINVAL;
2692 }
2693 tty_ldisc_deref(ld);
2694 return retval;
2695}
2696
Paul Fulghume10cc1d2007-05-10 22:22:50 -07002697#ifdef CONFIG_COMPAT
Alan Cox37bdfb02008-02-08 04:18:47 -08002698static long tty_compat_ioctl(struct file *file, unsigned int cmd,
Paul Fulghume10cc1d2007-05-10 22:22:50 -07002699 unsigned long arg)
2700{
2701 struct inode *inode = file->f_dentry->d_inode;
Nick Piggind996b622010-08-18 04:37:36 +10002702 struct tty_struct *tty = file_tty(file);
Paul Fulghume10cc1d2007-05-10 22:22:50 -07002703 struct tty_ldisc *ld;
2704 int retval = -ENOIOCTLCMD;
2705
2706 if (tty_paranoia_check(tty, inode, "tty_ioctl"))
2707 return -EINVAL;
2708
Alan Coxf34d7a52008-04-30 00:54:13 -07002709 if (tty->ops->compat_ioctl) {
Alan Cox6caa76b2011-02-14 16:27:22 +00002710 retval = (tty->ops->compat_ioctl)(tty, cmd, arg);
Paul Fulghume10cc1d2007-05-10 22:22:50 -07002711 if (retval != -ENOIOCTLCMD)
2712 return retval;
2713 }
2714
2715 ld = tty_ldisc_ref_wait(tty);
Alan Coxa352def2008-07-16 21:53:12 +01002716 if (ld->ops->compat_ioctl)
2717 retval = ld->ops->compat_ioctl(tty, file, cmd, arg);
Paul Fulghume10cc1d2007-05-10 22:22:50 -07002718 tty_ldisc_deref(ld);
2719
2720 return retval;
2721}
2722#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07002723
2724/*
2725 * This implements the "Secure Attention Key" --- the idea is to
2726 * prevent trojan horses by killing all processes associated with this
2727 * tty when the user hits the "Secure Attention Key". Required for
2728 * super-paranoid applications --- see the Orange Book for more details.
Alan Cox37bdfb02008-02-08 04:18:47 -08002729 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07002730 * This code could be nicer; ideally it should send a HUP, wait a few
2731 * seconds, then send a INT, and then a KILL signal. But you then
2732 * have to coordinate with the init process, since all processes associated
2733 * with the current tty must be dead before the new getty is allowed
2734 * to spawn.
2735 *
2736 * Now, if it would be correct ;-/ The current code has a nasty hole -
2737 * it doesn't catch files in flight. We may send the descriptor to ourselves
2738 * via AF_UNIX socket, close it and later fetch from socket. FIXME.
2739 *
2740 * Nasty bug: do_SAK is being called in interrupt context. This can
2741 * deadlock. We punt it up to process context. AKPM - 16Mar2001
2742 */
Eric W. Biederman8b6312f2007-02-10 01:44:34 -08002743void __do_SAK(struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002744{
2745#ifdef TTY_SOFT_SAK
2746 tty_hangup(tty);
2747#else
Eric W. Biederman652486f2006-03-28 16:11:02 -08002748 struct task_struct *g, *p;
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08002749 struct pid *session;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002750 int i;
2751 struct file *filp;
Dipankar Sarmabadf1662005-09-09 13:04:10 -07002752 struct fdtable *fdt;
Alan Cox37bdfb02008-02-08 04:18:47 -08002753
Linus Torvalds1da177e2005-04-16 15:20:36 -07002754 if (!tty)
2755 return;
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002756 session = tty->session;
Alan Cox37bdfb02008-02-08 04:18:47 -08002757
Dan Carpenterb3f13de2006-12-13 00:35:09 -08002758 tty_ldisc_flush(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002759
Alan Coxf34d7a52008-04-30 00:54:13 -07002760 tty_driver_flush_buffer(tty);
Alan Cox37bdfb02008-02-08 04:18:47 -08002761
Linus Torvalds1da177e2005-04-16 15:20:36 -07002762 read_lock(&tasklist_lock);
Eric W. Biederman652486f2006-03-28 16:11:02 -08002763 /* Kill the entire session */
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08002764 do_each_pid_task(session, PIDTYPE_SID, p) {
Eric W. Biederman652486f2006-03-28 16:11:02 -08002765 printk(KERN_NOTICE "SAK: killed process %d"
Oleg Nesterov1b0f7ff2009-04-02 16:58:39 -07002766 " (%s): task_session(p)==tty->session\n",
Pavel Emelyanovba25f9d2007-10-18 23:40:40 -07002767 task_pid_nr(p), p->comm);
Eric W. Biederman652486f2006-03-28 16:11:02 -08002768 send_sig(SIGKILL, p, 1);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08002769 } while_each_pid_task(session, PIDTYPE_SID, p);
Eric W. Biederman652486f2006-03-28 16:11:02 -08002770 /* Now kill any processes that happen to have the
2771 * tty open.
2772 */
2773 do_each_thread(g, p) {
2774 if (p->signal->tty == tty) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002775 printk(KERN_NOTICE "SAK: killed process %d"
Oleg Nesterov1b0f7ff2009-04-02 16:58:39 -07002776 " (%s): task_session(p)==tty->session\n",
Pavel Emelyanovba25f9d2007-10-18 23:40:40 -07002777 task_pid_nr(p), p->comm);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002778 send_sig(SIGKILL, p, 1);
2779 continue;
2780 }
2781 task_lock(p);
2782 if (p->files) {
Dipankar Sarmaca99c1d2006-04-18 22:21:46 -07002783 /*
2784 * We don't take a ref to the file, so we must
2785 * hold ->file_lock instead.
2786 */
2787 spin_lock(&p->files->file_lock);
Dipankar Sarmabadf1662005-09-09 13:04:10 -07002788 fdt = files_fdtable(p->files);
Alan Cox37bdfb02008-02-08 04:18:47 -08002789 for (i = 0; i < fdt->max_fds; i++) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002790 filp = fcheck_files(p->files, i);
2791 if (!filp)
2792 continue;
2793 if (filp->f_op->read == tty_read &&
Nick Piggind996b622010-08-18 04:37:36 +10002794 file_tty(filp) == tty) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002795 printk(KERN_NOTICE "SAK: killed process %d"
2796 " (%s): fd#%d opened to the tty\n",
Pavel Emelyanovba25f9d2007-10-18 23:40:40 -07002797 task_pid_nr(p), p->comm, i);
Eric W. Biederman20ac9432006-04-13 04:49:07 -06002798 force_sig(SIGKILL, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002799 break;
2800 }
2801 }
Dipankar Sarmaca99c1d2006-04-18 22:21:46 -07002802 spin_unlock(&p->files->file_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002803 }
2804 task_unlock(p);
Eric W. Biederman652486f2006-03-28 16:11:02 -08002805 } while_each_thread(g, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002806 read_unlock(&tasklist_lock);
2807#endif
2808}
2809
Eric W. Biederman8b6312f2007-02-10 01:44:34 -08002810static void do_SAK_work(struct work_struct *work)
2811{
2812 struct tty_struct *tty =
2813 container_of(work, struct tty_struct, SAK_work);
2814 __do_SAK(tty);
2815}
2816
Linus Torvalds1da177e2005-04-16 15:20:36 -07002817/*
2818 * The tq handling here is a little racy - tty->SAK_work may already be queued.
2819 * Fortunately we don't need to worry, because if ->SAK_work is already queued,
2820 * the values which we write to it will be identical to the values which it
2821 * already has. --akpm
2822 */
2823void do_SAK(struct tty_struct *tty)
2824{
2825 if (!tty)
2826 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002827 schedule_work(&tty->SAK_work);
2828}
2829
2830EXPORT_SYMBOL(do_SAK);
2831
Dmitry Eremin-Solenikov30004ac2010-08-09 18:22:49 +04002832static int dev_match_devt(struct device *dev, void *data)
2833{
2834 dev_t *devt = data;
2835 return dev->devt == *devt;
2836}
2837
2838/* Must put_device() after it's unused! */
2839static struct device *tty_get_device(struct tty_struct *tty)
2840{
2841 dev_t devt = tty_devnum(tty);
2842 return class_find_device(tty_class, NULL, &devt, dev_match_devt);
2843}
2844
2845
Alan Coxaf9b8972006-08-27 01:24:01 -07002846/**
Alan Coxaf9b8972006-08-27 01:24:01 -07002847 * initialize_tty_struct
2848 * @tty: tty to initialize
2849 *
2850 * This subroutine initializes a tty structure that has been newly
2851 * allocated.
2852 *
2853 * Locking: none - tty in question must not be exposed at this point
Linus Torvalds1da177e2005-04-16 15:20:36 -07002854 */
Alan Coxaf9b8972006-08-27 01:24:01 -07002855
Alan Coxbf970ee2008-10-13 10:42:39 +01002856void initialize_tty_struct(struct tty_struct *tty,
2857 struct tty_driver *driver, int idx)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002858{
2859 memset(tty, 0, sizeof(struct tty_struct));
Alan Cox9c9f4de2008-10-13 10:37:26 +01002860 kref_init(&tty->kref);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002861 tty->magic = TTY_MAGIC;
Alan Cox01e1abb2008-07-22 11:16:55 +01002862 tty_ldisc_init(tty);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08002863 tty->session = NULL;
2864 tty->pgrp = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002865 tty->overrun_time = jiffies;
Alan Cox33f0f882006-01-09 20:54:13 -08002866 tty->buf.head = tty->buf.tail = NULL;
2867 tty_buffer_init(tty);
Arjan van de Ven5785c952006-09-29 02:00:43 -07002868 mutex_init(&tty->termios_mutex);
Alan Coxc65c9bc2009-06-11 12:50:12 +01002869 mutex_init(&tty->ldisc_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002870 init_waitqueue_head(&tty->write_wait);
2871 init_waitqueue_head(&tty->read_wait);
David Howells65f27f32006-11-22 14:55:48 +00002872 INIT_WORK(&tty->hangup_work, do_tty_hangup);
Ingo Molnar70522e12006-03-23 03:00:31 -08002873 mutex_init(&tty->atomic_read_lock);
2874 mutex_init(&tty->atomic_write_lock);
Joe Petersona88a69c2009-01-02 13:40:53 +00002875 mutex_init(&tty->output_lock);
2876 mutex_init(&tty->echo_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002877 spin_lock_init(&tty->read_lock);
Alan Cox04f378b2008-04-30 00:53:29 -07002878 spin_lock_init(&tty->ctrl_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002879 INIT_LIST_HEAD(&tty->tty_files);
Eric W. Biederman7f1f86a2007-02-13 14:38:58 -07002880 INIT_WORK(&tty->SAK_work, do_SAK_work);
Alan Coxbf970ee2008-10-13 10:42:39 +01002881
2882 tty->driver = driver;
2883 tty->ops = driver->ops;
2884 tty->index = idx;
2885 tty_line_name(driver, idx, tty->name);
Dmitry Eremin-Solenikov30004ac2010-08-09 18:22:49 +04002886 tty->dev = tty_get_device(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002887}
2888
Alan Coxf34d7a52008-04-30 00:54:13 -07002889/**
2890 * tty_put_char - write one character to a tty
2891 * @tty: tty
2892 * @ch: character
2893 *
2894 * Write one byte to the tty using the provided put_char method
2895 * if present. Returns the number of characters successfully output.
2896 *
2897 * Note: the specific put_char operation in the driver layer may go
2898 * away soon. Don't call it directly, use this method
Linus Torvalds1da177e2005-04-16 15:20:36 -07002899 */
Alan Coxaf9b8972006-08-27 01:24:01 -07002900
Alan Coxf34d7a52008-04-30 00:54:13 -07002901int tty_put_char(struct tty_struct *tty, unsigned char ch)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002902{
Alan Coxf34d7a52008-04-30 00:54:13 -07002903 if (tty->ops->put_char)
2904 return tty->ops->put_char(tty, ch);
2905 return tty->ops->write(tty, &ch, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002906}
Alan Coxf34d7a52008-04-30 00:54:13 -07002907EXPORT_SYMBOL_GPL(tty_put_char);
2908
Alan Coxd81ed102008-10-13 10:41:42 +01002909struct class *tty_class;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002910
2911/**
Alan Coxaf9b8972006-08-27 01:24:01 -07002912 * tty_register_device - register a tty device
2913 * @driver: the tty driver that describes the tty device
2914 * @index: the index in the tty driver for this tty device
2915 * @device: a struct device that is associated with this tty device.
2916 * This field is optional, if there is no known struct device
2917 * for this tty device it can be set to NULL safely.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002918 *
Greg Kroah-Hartman01107d32006-08-07 22:19:37 -07002919 * Returns a pointer to the struct device for this tty device
2920 * (or ERR_PTR(-EFOO) on error).
Hansjoerg Lipp1cdcb6b2006-04-22 18:36:53 +02002921 *
Alan Coxaf9b8972006-08-27 01:24:01 -07002922 * This call is required to be made to register an individual tty device
2923 * if the tty driver's flags have the TTY_DRIVER_DYNAMIC_DEV bit set. If
2924 * that bit is not set, this function should not be called by a tty
2925 * driver.
2926 *
2927 * Locking: ??
Linus Torvalds1da177e2005-04-16 15:20:36 -07002928 */
Alan Coxaf9b8972006-08-27 01:24:01 -07002929
Greg Kroah-Hartman01107d32006-08-07 22:19:37 -07002930struct device *tty_register_device(struct tty_driver *driver, unsigned index,
2931 struct device *device)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002932{
2933 char name[64];
2934 dev_t dev = MKDEV(driver->major, driver->minor_start) + index;
2935
2936 if (index >= driver->num) {
2937 printk(KERN_ERR "Attempt to register invalid tty line number "
2938 " (%d).\n", index);
Hansjoerg Lipp1cdcb6b2006-04-22 18:36:53 +02002939 return ERR_PTR(-EINVAL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002940 }
2941
Linus Torvalds1da177e2005-04-16 15:20:36 -07002942 if (driver->type == TTY_DRIVER_TYPE_PTY)
2943 pty_line_name(driver, index, name);
2944 else
2945 tty_line_name(driver, index, name);
Hansjoerg Lipp1cdcb6b2006-04-22 18:36:53 +02002946
Greg Kroah-Hartman03457cd2008-07-21 20:03:34 -07002947 return device_create(tty_class, device, dev, NULL, name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002948}
Alan Cox7d7b93c2008-10-13 10:42:09 +01002949EXPORT_SYMBOL(tty_register_device);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002950
2951/**
Alan Coxaf9b8972006-08-27 01:24:01 -07002952 * tty_unregister_device - unregister a tty device
2953 * @driver: the tty driver that describes the tty device
2954 * @index: the index in the tty driver for this tty device
Linus Torvalds1da177e2005-04-16 15:20:36 -07002955 *
Alan Coxaf9b8972006-08-27 01:24:01 -07002956 * If a tty device is registered with a call to tty_register_device() then
2957 * this function must be called when the tty device is gone.
2958 *
2959 * Locking: ??
Linus Torvalds1da177e2005-04-16 15:20:36 -07002960 */
Alan Coxaf9b8972006-08-27 01:24:01 -07002961
Linus Torvalds1da177e2005-04-16 15:20:36 -07002962void tty_unregister_device(struct tty_driver *driver, unsigned index)
2963{
Alan Cox37bdfb02008-02-08 04:18:47 -08002964 device_destroy(tty_class,
2965 MKDEV(driver->major, driver->minor_start) + index);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002966}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002967EXPORT_SYMBOL(tty_unregister_device);
2968
2969struct tty_driver *alloc_tty_driver(int lines)
2970{
2971 struct tty_driver *driver;
2972
Jean Delvare506eb992007-07-15 23:40:14 -07002973 driver = kzalloc(sizeof(struct tty_driver), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002974 if (driver) {
Alan Cox7d7b93c2008-10-13 10:42:09 +01002975 kref_init(&driver->kref);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002976 driver->magic = TTY_DRIVER_MAGIC;
2977 driver->num = lines;
2978 /* later we'll move allocation of tables here */
2979 }
2980 return driver;
2981}
Alan Cox7d7b93c2008-10-13 10:42:09 +01002982EXPORT_SYMBOL(alloc_tty_driver);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002983
Alan Cox7d7b93c2008-10-13 10:42:09 +01002984static void destruct_tty_driver(struct kref *kref)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002985{
Alan Cox7d7b93c2008-10-13 10:42:09 +01002986 struct tty_driver *driver = container_of(kref, struct tty_driver, kref);
2987 int i;
2988 struct ktermios *tp;
2989 void *p;
2990
2991 if (driver->flags & TTY_DRIVER_INSTALLED) {
2992 /*
2993 * Free the termios and termios_locked structures because
2994 * we don't want to get memory leaks when modular tty
2995 * drivers are removed from the kernel.
2996 */
2997 for (i = 0; i < driver->num; i++) {
2998 tp = driver->termios[i];
2999 if (tp) {
3000 driver->termios[i] = NULL;
3001 kfree(tp);
3002 }
Alan Cox7d7b93c2008-10-13 10:42:09 +01003003 if (!(driver->flags & TTY_DRIVER_DYNAMIC_DEV))
3004 tty_unregister_device(driver, i);
3005 }
3006 p = driver->ttys;
3007 proc_tty_unregister_driver(driver);
3008 driver->ttys = NULL;
Alan Coxfe6e29f2008-10-13 10:44:08 +01003009 driver->termios = NULL;
Alan Cox7d7b93c2008-10-13 10:42:09 +01003010 kfree(p);
3011 cdev_del(&driver->cdev);
3012 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003013 kfree(driver);
3014}
3015
Alan Cox7d7b93c2008-10-13 10:42:09 +01003016void tty_driver_kref_put(struct tty_driver *driver)
3017{
3018 kref_put(&driver->kref, destruct_tty_driver);
3019}
3020EXPORT_SYMBOL(tty_driver_kref_put);
3021
Jeff Dikeb68e31d2006-10-02 02:17:18 -07003022void tty_set_operations(struct tty_driver *driver,
3023 const struct tty_operations *op)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003024{
Alan Coxf34d7a52008-04-30 00:54:13 -07003025 driver->ops = op;
3026};
Linus Torvalds1da177e2005-04-16 15:20:36 -07003027EXPORT_SYMBOL(tty_set_operations);
3028
Alan Cox7d7b93c2008-10-13 10:42:09 +01003029void put_tty_driver(struct tty_driver *d)
3030{
3031 tty_driver_kref_put(d);
3032}
3033EXPORT_SYMBOL(put_tty_driver);
3034
Linus Torvalds1da177e2005-04-16 15:20:36 -07003035/*
3036 * Called by a tty driver to register itself.
3037 */
3038int tty_register_driver(struct tty_driver *driver)
3039{
3040 int error;
Alan Cox37bdfb02008-02-08 04:18:47 -08003041 int i;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003042 dev_t dev;
3043 void **p = NULL;
Vasiliy Kulikovb670bde2010-09-05 22:32:22 +04003044 struct device *d;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003045
Andy Whitcroft543691a62007-05-06 14:49:33 -07003046 if (!(driver->flags & TTY_DRIVER_DEVPTS_MEM) && driver->num) {
Alan Coxfe6e29f2008-10-13 10:44:08 +01003047 p = kzalloc(driver->num * 2 * sizeof(void *), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003048 if (!p)
3049 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003050 }
3051
3052 if (!driver->major) {
Alan Cox37bdfb02008-02-08 04:18:47 -08003053 error = alloc_chrdev_region(&dev, driver->minor_start,
3054 driver->num, driver->name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003055 if (!error) {
3056 driver->major = MAJOR(dev);
3057 driver->minor_start = MINOR(dev);
3058 }
3059 } else {
3060 dev = MKDEV(driver->major, driver->minor_start);
Geert Uytterhoevene5717c42007-02-20 15:45:21 +01003061 error = register_chrdev_region(dev, driver->num, driver->name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003062 }
3063 if (error < 0) {
3064 kfree(p);
3065 return error;
3066 }
3067
3068 if (p) {
3069 driver->ttys = (struct tty_struct **)p;
Alan Coxedc6afc2006-12-08 02:38:44 -08003070 driver->termios = (struct ktermios **)(p + driver->num);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003071 } else {
3072 driver->ttys = NULL;
3073 driver->termios = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003074 }
3075
3076 cdev_init(&driver->cdev, &tty_fops);
3077 driver->cdev.owner = driver->owner;
3078 error = cdev_add(&driver->cdev, dev, driver->num);
3079 if (error) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07003080 unregister_chrdev_region(dev, driver->num);
3081 driver->ttys = NULL;
Alan Coxfe6e29f2008-10-13 10:44:08 +01003082 driver->termios = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003083 kfree(p);
3084 return error;
3085 }
3086
Alexey Dobriyanca509f62007-05-08 00:27:12 -07003087 mutex_lock(&tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003088 list_add(&driver->tty_drivers, &tty_drivers);
Alexey Dobriyanca509f62007-05-08 00:27:12 -07003089 mutex_unlock(&tty_mutex);
Alan Cox37bdfb02008-02-08 04:18:47 -08003090
3091 if (!(driver->flags & TTY_DRIVER_DYNAMIC_DEV)) {
Vasiliy Kulikovb670bde2010-09-05 22:32:22 +04003092 for (i = 0; i < driver->num; i++) {
3093 d = tty_register_device(driver, i, NULL);
3094 if (IS_ERR(d)) {
3095 error = PTR_ERR(d);
3096 goto err;
3097 }
3098 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003099 }
3100 proc_tty_register_driver(driver);
Alan Cox7d7b93c2008-10-13 10:42:09 +01003101 driver->flags |= TTY_DRIVER_INSTALLED;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003102 return 0;
Vasiliy Kulikovb670bde2010-09-05 22:32:22 +04003103
3104err:
3105 for (i--; i >= 0; i--)
3106 tty_unregister_device(driver, i);
3107
3108 mutex_lock(&tty_mutex);
3109 list_del(&driver->tty_drivers);
3110 mutex_unlock(&tty_mutex);
3111
3112 unregister_chrdev_region(dev, driver->num);
3113 driver->ttys = NULL;
3114 driver->termios = NULL;
3115 kfree(p);
3116 return error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003117}
3118
3119EXPORT_SYMBOL(tty_register_driver);
3120
3121/*
3122 * Called by a tty driver to unregister itself.
3123 */
3124int tty_unregister_driver(struct tty_driver *driver)
3125{
Alan Cox7d7b93c2008-10-13 10:42:09 +01003126#if 0
3127 /* FIXME */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003128 if (driver->refcount)
3129 return -EBUSY;
Alan Cox7d7b93c2008-10-13 10:42:09 +01003130#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07003131 unregister_chrdev_region(MKDEV(driver->major, driver->minor_start),
3132 driver->num);
Alexey Dobriyanca509f62007-05-08 00:27:12 -07003133 mutex_lock(&tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003134 list_del(&driver->tty_drivers);
Alexey Dobriyanca509f62007-05-08 00:27:12 -07003135 mutex_unlock(&tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003136 return 0;
3137}
Alan Cox7d7b93c2008-10-13 10:42:09 +01003138
Linus Torvalds1da177e2005-04-16 15:20:36 -07003139EXPORT_SYMBOL(tty_unregister_driver);
3140
Peter Zijlstra24ec8392006-12-08 02:36:04 -08003141dev_t tty_devnum(struct tty_struct *tty)
3142{
3143 return MKDEV(tty->driver->major, tty->driver->minor_start) + tty->index;
3144}
3145EXPORT_SYMBOL(tty_devnum);
3146
3147void proc_clear_tty(struct task_struct *p)
3148{
Arjan van de Ven7c3b1dc2008-10-15 10:52:34 +01003149 unsigned long flags;
Alan Cox9c9f4de2008-10-13 10:37:26 +01003150 struct tty_struct *tty;
Arjan van de Ven7c3b1dc2008-10-15 10:52:34 +01003151 spin_lock_irqsave(&p->sighand->siglock, flags);
Alan Cox9c9f4de2008-10-13 10:37:26 +01003152 tty = p->signal->tty;
Peter Zijlstra24ec8392006-12-08 02:36:04 -08003153 p->signal->tty = NULL;
Arjan van de Ven7c3b1dc2008-10-15 10:52:34 +01003154 spin_unlock_irqrestore(&p->sighand->siglock, flags);
Alan Cox9c9f4de2008-10-13 10:37:26 +01003155 tty_kref_put(tty);
Peter Zijlstra24ec8392006-12-08 02:36:04 -08003156}
Peter Zijlstra24ec8392006-12-08 02:36:04 -08003157
Alan Cox47f86832008-04-30 00:53:30 -07003158/* Called under the sighand lock */
3159
Eric W. Biederman2a65f1d2007-05-08 00:26:53 -07003160static void __proc_set_tty(struct task_struct *tsk, struct tty_struct *tty)
Peter Zijlstra24ec8392006-12-08 02:36:04 -08003161{
3162 if (tty) {
Alan Cox47f86832008-04-30 00:53:30 -07003163 unsigned long flags;
3164 /* We should not have a session or pgrp to put here but.... */
3165 spin_lock_irqsave(&tty->ctrl_lock, flags);
Eric W. Biedermand9c1e9a2007-03-18 12:45:44 -06003166 put_pid(tty->session);
3167 put_pid(tty->pgrp);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08003168 tty->pgrp = get_pid(task_pgrp(tsk));
Alan Cox47f86832008-04-30 00:53:30 -07003169 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
3170 tty->session = get_pid(task_session(tsk));
Alan Cox9c9f4de2008-10-13 10:37:26 +01003171 if (tsk->signal->tty) {
3172 printk(KERN_DEBUG "tty not NULL!!\n");
3173 tty_kref_put(tsk->signal->tty);
3174 }
Peter Zijlstra24ec8392006-12-08 02:36:04 -08003175 }
Eric W. Biederman2a65f1d2007-05-08 00:26:53 -07003176 put_pid(tsk->signal->tty_old_pgrp);
Alan Cox9c9f4de2008-10-13 10:37:26 +01003177 tsk->signal->tty = tty_kref_get(tty);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08003178 tsk->signal->tty_old_pgrp = NULL;
Peter Zijlstra24ec8392006-12-08 02:36:04 -08003179}
3180
Eric W. Biederman98a27ba2007-05-08 00:26:56 -07003181static void proc_set_tty(struct task_struct *tsk, struct tty_struct *tty)
Peter Zijlstra24ec8392006-12-08 02:36:04 -08003182{
3183 spin_lock_irq(&tsk->sighand->siglock);
Eric W. Biederman2a65f1d2007-05-08 00:26:53 -07003184 __proc_set_tty(tsk, tty);
Peter Zijlstra24ec8392006-12-08 02:36:04 -08003185 spin_unlock_irq(&tsk->sighand->siglock);
3186}
3187
3188struct tty_struct *get_current_tty(void)
3189{
3190 struct tty_struct *tty;
Alan Cox934e6eb2008-10-13 10:40:43 +01003191 unsigned long flags;
3192
3193 spin_lock_irqsave(&current->sighand->siglock, flags);
Alan Cox452a00d2008-10-13 10:39:13 +01003194 tty = tty_kref_get(current->signal->tty);
Alan Cox934e6eb2008-10-13 10:40:43 +01003195 spin_unlock_irqrestore(&current->sighand->siglock, flags);
Peter Zijlstra24ec8392006-12-08 02:36:04 -08003196 return tty;
3197}
Heiko Carstensa311f742006-12-13 00:33:41 -08003198EXPORT_SYMBOL_GPL(get_current_tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003199
Alan Coxd81ed102008-10-13 10:41:42 +01003200void tty_default_fops(struct file_operations *fops)
3201{
3202 *fops = tty_fops;
3203}
3204
Linus Torvalds1da177e2005-04-16 15:20:36 -07003205/*
3206 * Initialize the console device. This is called *early*, so
3207 * we can't necessarily depend on lots of kernel help here.
3208 * Just do some early initializations, and do the complex setup
3209 * later.
3210 */
3211void __init console_init(void)
3212{
3213 initcall_t *call;
3214
3215 /* Setup the default TTY line discipline. */
Alan Cox01e1abb2008-07-22 11:16:55 +01003216 tty_ldisc_begin();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003217
3218 /*
Alan Cox37bdfb02008-02-08 04:18:47 -08003219 * set up the console device so that later boot sequences can
Linus Torvalds1da177e2005-04-16 15:20:36 -07003220 * inform about problems etc..
3221 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003222 call = __con_initcall_start;
3223 while (call < __con_initcall_end) {
3224 (*call)();
3225 call++;
3226 }
3227}
3228
Kay Sieverse454cea2009-09-18 23:01:12 +02003229static char *tty_devnode(struct device *dev, mode_t *mode)
3230{
3231 if (!mode)
3232 return NULL;
3233 if (dev->devt == MKDEV(TTYAUX_MAJOR, 0) ||
3234 dev->devt == MKDEV(TTYAUX_MAJOR, 2))
3235 *mode = 0666;
3236 return NULL;
3237}
3238
Linus Torvalds1da177e2005-04-16 15:20:36 -07003239static int __init tty_class_init(void)
3240{
gregkh@suse.de7fe845d2005-03-15 14:23:15 -08003241 tty_class = class_create(THIS_MODULE, "tty");
Linus Torvalds1da177e2005-04-16 15:20:36 -07003242 if (IS_ERR(tty_class))
3243 return PTR_ERR(tty_class);
Kay Sieverse454cea2009-09-18 23:01:12 +02003244 tty_class->devnode = tty_devnode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003245 return 0;
3246}
3247
3248postcore_initcall(tty_class_init);
3249
3250/* 3/2004 jmc: why do these devices exist? */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003251static struct cdev tty_cdev, console_cdev;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003252
Kay Sieversfbc92a32010-12-01 18:51:05 +01003253static ssize_t show_cons_active(struct device *dev,
3254 struct device_attribute *attr, char *buf)
3255{
3256 struct console *cs[16];
3257 int i = 0;
3258 struct console *c;
3259 ssize_t count = 0;
3260
Torben Hohnac751ef2011-01-25 15:07:35 -08003261 console_lock();
Kay Sieversa2a6a822011-01-09 16:39:14 +01003262 for_each_console(c) {
Kay Sieversfbc92a32010-12-01 18:51:05 +01003263 if (!c->device)
3264 continue;
3265 if (!c->write)
3266 continue;
3267 if ((c->flags & CON_ENABLED) == 0)
3268 continue;
3269 cs[i++] = c;
3270 if (i >= ARRAY_SIZE(cs))
3271 break;
3272 }
3273 while (i--)
3274 count += sprintf(buf + count, "%s%d%c",
3275 cs[i]->name, cs[i]->index, i ? ' ':'\n');
Torben Hohnac751ef2011-01-25 15:07:35 -08003276 console_unlock();
Kay Sieversfbc92a32010-12-01 18:51:05 +01003277
3278 return count;
3279}
3280static DEVICE_ATTR(active, S_IRUGO, show_cons_active, NULL);
3281
3282static struct device *consdev;
3283
3284void console_sysfs_notify(void)
3285{
3286 if (consdev)
3287 sysfs_notify(&consdev->kobj, NULL, "active");
3288}
3289
Linus Torvalds1da177e2005-04-16 15:20:36 -07003290/*
3291 * Ok, now we can initialize the rest of the tty devices and can count
3292 * on memory allocations, interrupts etc..
3293 */
David Howells31d1d482010-08-06 16:34:43 +01003294int __init tty_init(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003295{
3296 cdev_init(&tty_cdev, &tty_fops);
3297 if (cdev_add(&tty_cdev, MKDEV(TTYAUX_MAJOR, 0), 1) ||
3298 register_chrdev_region(MKDEV(TTYAUX_MAJOR, 0), 1, "/dev/tty") < 0)
3299 panic("Couldn't register /dev/tty driver\n");
Kay Sieversfbc92a32010-12-01 18:51:05 +01003300 device_create(tty_class, NULL, MKDEV(TTYAUX_MAJOR, 0), NULL, "tty");
Linus Torvalds1da177e2005-04-16 15:20:36 -07003301
3302 cdev_init(&console_cdev, &console_fops);
3303 if (cdev_add(&console_cdev, MKDEV(TTYAUX_MAJOR, 1), 1) ||
3304 register_chrdev_region(MKDEV(TTYAUX_MAJOR, 1), 1, "/dev/console") < 0)
3305 panic("Couldn't register /dev/console driver\n");
Kay Sieversfbc92a32010-12-01 18:51:05 +01003306 consdev = device_create(tty_class, NULL, MKDEV(TTYAUX_MAJOR, 1), NULL,
Greg Kroah-Hartman47aa5792008-05-21 12:52:33 -07003307 "console");
Kay Sieversfbc92a32010-12-01 18:51:05 +01003308 if (IS_ERR(consdev))
3309 consdev = NULL;
3310 else
Kay Sieversa2a6a822011-01-09 16:39:14 +01003311 WARN_ON(device_create_file(consdev, &dev_attr_active) < 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003312
Linus Torvalds1da177e2005-04-16 15:20:36 -07003313#ifdef CONFIG_VT
Alan Coxd81ed102008-10-13 10:41:42 +01003314 vty_init(&console_fops);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003315#endif
3316 return 0;
3317}
David Howells31d1d482010-08-06 16:34:43 +01003318