blob: b5f57d0b30ee1bdb5e931825010c59ab0b2627a2 [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 *
52 * Rewrote init_dev and release_dev to eliminate races.
53 * -- Bill Hawes <whawes@star.net>, June 97
54 *
55 * Added devfs support.
56 * -- C. Scott Ananian <cananian@alumni.princeton.edu>, 13-Jan-1998
57 *
58 * Added support for a Unix98-style ptmx device.
59 * -- C. Scott Ananian <cananian@alumni.princeton.edu>, 14-Jan-1998
60 *
61 * Reduced memory usage for older ARM systems
62 * -- Russell King <rmk@arm.linux.org.uk>
63 *
64 * Move do_SAK() into process context. Less stack use in devfs functions.
Alan Cox37bdfb02008-02-08 04:18:47 -080065 * alloc_tty_struct() always uses kmalloc()
66 * -- Andrew Morton <andrewm@uow.edu.eu> 17Mar01
Linus Torvalds1da177e2005-04-16 15:20:36 -070067 */
68
Linus Torvalds1da177e2005-04-16 15:20:36 -070069#include <linux/types.h>
70#include <linux/major.h>
71#include <linux/errno.h>
72#include <linux/signal.h>
73#include <linux/fcntl.h>
74#include <linux/sched.h>
75#include <linux/interrupt.h>
76#include <linux/tty.h>
77#include <linux/tty_driver.h>
78#include <linux/tty_flip.h>
79#include <linux/devpts_fs.h>
80#include <linux/file.h>
Al Viro9f3acc32008-04-24 07:44:08 -040081#include <linux/fdtable.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070082#include <linux/console.h>
83#include <linux/timer.h>
84#include <linux/ctype.h>
85#include <linux/kd.h>
86#include <linux/mm.h>
87#include <linux/string.h>
88#include <linux/slab.h>
89#include <linux/poll.h>
90#include <linux/proc_fs.h>
91#include <linux/init.h>
92#include <linux/module.h>
93#include <linux/smp_lock.h>
94#include <linux/device.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070095#include <linux/wait.h>
96#include <linux/bitops.h>
Domen Puncerb20f3ae2005-06-25 14:58:42 -070097#include <linux/delay.h>
Alan Coxa352def2008-07-16 21:53:12 +010098#include <linux/seq_file.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070099
Alan Coxa352def2008-07-16 21:53:12 +0100100#include <linux/uaccess.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700101#include <asm/system.h>
102
103#include <linux/kbd_kern.h>
104#include <linux/vt_kern.h>
105#include <linux/selection.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700106
107#include <linux/kmod.h>
Pavel Emelyanovb4888932007-10-18 23:40:14 -0700108#include <linux/nsproxy.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700109
110#undef TTY_DEBUG_HANGUP
111
112#define TTY_PARANOIA_CHECK 1
113#define CHECK_TTY_COUNT 1
114
Alan Coxedc6afc2006-12-08 02:38:44 -0800115struct ktermios tty_std_termios = { /* for the benefit of tty drivers */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700116 .c_iflag = ICRNL | IXON,
117 .c_oflag = OPOST | ONLCR,
118 .c_cflag = B38400 | CS8 | CREAD | HUPCL,
119 .c_lflag = ISIG | ICANON | ECHO | ECHOE | ECHOK |
120 ECHOCTL | ECHOKE | IEXTEN,
Alan Coxedc6afc2006-12-08 02:38:44 -0800121 .c_cc = INIT_C_CC,
122 .c_ispeed = 38400,
123 .c_ospeed = 38400
Linus Torvalds1da177e2005-04-16 15:20:36 -0700124};
125
126EXPORT_SYMBOL(tty_std_termios);
127
128/* This list gets poked at by procfs and various bits of boot up code. This
129 could do with some rationalisation such as pulling the tty proc function
130 into this file */
Alan Cox37bdfb02008-02-08 04:18:47 -0800131
Linus Torvalds1da177e2005-04-16 15:20:36 -0700132LIST_HEAD(tty_drivers); /* linked list of tty drivers */
133
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800134/* Mutex to protect creating and releasing a tty. This is shared with
Linus Torvalds1da177e2005-04-16 15:20:36 -0700135 vt.c for deeply disgusting hack reasons */
Ingo Molnar70522e12006-03-23 03:00:31 -0800136DEFINE_MUTEX(tty_mutex);
Alan Coxde2a84f2006-09-29 02:00:57 -0700137EXPORT_SYMBOL(tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700138
139#ifdef CONFIG_UNIX98_PTYS
140extern struct tty_driver *ptm_driver; /* Unix98 pty masters; for /dev/ptmx */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700141static int ptmx_open(struct inode *, struct file *);
142#endif
143
Linus Torvalds1da177e2005-04-16 15:20:36 -0700144static void initialize_tty_struct(struct tty_struct *tty);
145
146static ssize_t tty_read(struct file *, char __user *, size_t, loff_t *);
147static ssize_t tty_write(struct file *, const char __user *, size_t, loff_t *);
Alan Cox37bdfb02008-02-08 04:18:47 -0800148ssize_t redirected_tty_write(struct file *, const char __user *,
149 size_t, loff_t *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700150static unsigned int tty_poll(struct file *, poll_table *);
151static int tty_open(struct inode *, struct file *);
152static int tty_release(struct inode *, struct file *);
Alan Cox04f378b2008-04-30 00:53:29 -0700153long tty_ioctl(struct file *file, unsigned int cmd, unsigned long arg);
Paul Fulghume10cc1d2007-05-10 22:22:50 -0700154#ifdef CONFIG_COMPAT
Alan Cox37bdfb02008-02-08 04:18:47 -0800155static long tty_compat_ioctl(struct file *file, unsigned int cmd,
Paul Fulghume10cc1d2007-05-10 22:22:50 -0700156 unsigned long arg);
157#else
158#define tty_compat_ioctl NULL
159#endif
Alan Cox37bdfb02008-02-08 04:18:47 -0800160static int tty_fasync(int fd, struct file *filp, int on);
Christoph Hellwigd5698c22007-02-10 01:46:46 -0800161static void release_tty(struct tty_struct *tty, int idx);
Eric W. Biederman2a65f1d2007-05-08 00:26:53 -0700162static void __proc_set_tty(struct task_struct *tsk, struct tty_struct *tty);
Eric W. Biederman98a27ba2007-05-08 00:26:56 -0700163static void proc_set_tty(struct task_struct *tsk, struct tty_struct *tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700164
Alan Coxaf9b8972006-08-27 01:24:01 -0700165/**
166 * alloc_tty_struct - allocate a tty object
167 *
168 * Return a new empty tty structure. The data fields have not
169 * been initialized in any way but has been zeroed
170 *
171 * Locking: none
Alan Coxaf9b8972006-08-27 01:24:01 -0700172 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700173
174static struct tty_struct *alloc_tty_struct(void)
175{
Alan Cox1266b1e2006-09-29 02:00:40 -0700176 return kzalloc(sizeof(struct tty_struct), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700177}
178
Alan Coxaf9b8972006-08-27 01:24:01 -0700179/**
180 * free_tty_struct - free a disused tty
181 * @tty: tty struct to free
182 *
183 * Free the write buffers, tty queue and tty memory itself.
184 *
185 * Locking: none. Must be called after tty is definitely unused
186 */
187
Linus Torvalds1da177e2005-04-16 15:20:36 -0700188static inline void free_tty_struct(struct tty_struct *tty)
189{
190 kfree(tty->write_buf);
Alan Cox33f0f882006-01-09 20:54:13 -0800191 tty_buffer_free_all(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700192 kfree(tty);
193}
194
195#define TTY_NUMBER(tty) ((tty)->index + (tty)->driver->name_base)
196
Alan Coxaf9b8972006-08-27 01:24:01 -0700197/**
198 * tty_name - return tty naming
199 * @tty: tty structure
200 * @buf: buffer for output
201 *
202 * Convert a tty structure into a name. The name reflects the kernel
203 * naming policy and if udev is in use may not reflect user space
204 *
205 * Locking: none
206 */
207
Linus Torvalds1da177e2005-04-16 15:20:36 -0700208char *tty_name(struct tty_struct *tty, char *buf)
209{
210 if (!tty) /* Hmm. NULL pointer. That's fun. */
211 strcpy(buf, "NULL tty");
212 else
213 strcpy(buf, tty->name);
214 return buf;
215}
216
217EXPORT_SYMBOL(tty_name);
218
Andrew Mortond769a662005-05-05 16:15:50 -0700219int tty_paranoia_check(struct tty_struct *tty, struct inode *inode,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700220 const char *routine)
221{
222#ifdef TTY_PARANOIA_CHECK
223 if (!tty) {
224 printk(KERN_WARNING
225 "null TTY for (%d:%d) in %s\n",
226 imajor(inode), iminor(inode), routine);
227 return 1;
228 }
229 if (tty->magic != TTY_MAGIC) {
230 printk(KERN_WARNING
231 "bad magic number for tty struct (%d:%d) in %s\n",
232 imajor(inode), iminor(inode), routine);
233 return 1;
234 }
235#endif
236 return 0;
237}
238
239static int check_tty_count(struct tty_struct *tty, const char *routine)
240{
241#ifdef CHECK_TTY_COUNT
242 struct list_head *p;
243 int count = 0;
Alan Cox37bdfb02008-02-08 04:18:47 -0800244
Linus Torvalds1da177e2005-04-16 15:20:36 -0700245 file_list_lock();
246 list_for_each(p, &tty->tty_files) {
247 count++;
248 }
249 file_list_unlock();
250 if (tty->driver->type == TTY_DRIVER_TYPE_PTY &&
251 tty->driver->subtype == PTY_TYPE_SLAVE &&
252 tty->link && tty->link->count)
253 count++;
254 if (tty->count != count) {
255 printk(KERN_WARNING "Warning: dev (%s) tty->count(%d) "
256 "!= #fd's(%d) in %s\n",
257 tty->name, tty->count, count, routine);
258 return count;
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800259 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700260#endif
261 return 0;
262}
263
Alan Coxaf9b8972006-08-27 01:24:01 -0700264/**
Alan Coxaf9b8972006-08-27 01:24:01 -0700265 * get_tty_driver - find device of a tty
266 * @dev_t: device identifier
267 * @index: returns the index of the tty
268 *
269 * This routine returns a tty driver structure, given a device number
270 * and also passes back the index number.
271 *
272 * Locking: caller must hold tty_mutex
Linus Torvalds1da177e2005-04-16 15:20:36 -0700273 */
Alan Coxaf9b8972006-08-27 01:24:01 -0700274
Linus Torvalds1da177e2005-04-16 15:20:36 -0700275static struct tty_driver *get_tty_driver(dev_t device, int *index)
276{
277 struct tty_driver *p;
278
279 list_for_each_entry(p, &tty_drivers, tty_drivers) {
280 dev_t base = MKDEV(p->major, p->minor_start);
281 if (device < base || device >= base + p->num)
282 continue;
283 *index = device - base;
284 return p;
285 }
286 return NULL;
287}
288
Jason Wesself2d937f2008-04-17 20:05:37 +0200289#ifdef CONFIG_CONSOLE_POLL
290
291/**
292 * tty_find_polling_driver - find device of a polled tty
293 * @name: name string to match
294 * @line: pointer to resulting tty line nr
295 *
296 * This routine returns a tty driver structure, given a name
297 * and the condition that the tty driver is capable of polled
298 * operation.
299 */
300struct tty_driver *tty_find_polling_driver(char *name, int *line)
301{
302 struct tty_driver *p, *res = NULL;
303 int tty_line = 0;
Jason Wessel0dca0fd2008-09-26 10:36:42 -0500304 int len;
Jason Wesself2d937f2008-04-17 20:05:37 +0200305 char *str;
306
Jason Wessel0dca0fd2008-09-26 10:36:42 -0500307 for (str = name; *str; str++)
308 if ((*str >= '0' && *str <= '9') || *str == ',')
309 break;
310 if (!*str)
311 return NULL;
312
313 len = str - name;
314 tty_line = simple_strtoul(str, &str, 10);
315
Jason Wesself2d937f2008-04-17 20:05:37 +0200316 mutex_lock(&tty_mutex);
317 /* Search through the tty devices to look for a match */
318 list_for_each_entry(p, &tty_drivers, tty_drivers) {
Jason Wessel0dca0fd2008-09-26 10:36:42 -0500319 if (strncmp(name, p->name, len) != 0)
320 continue;
Jason Wesself2d937f2008-04-17 20:05:37 +0200321 if (*str == ',')
322 str++;
323 if (*str == '\0')
Harvey Harrison8da56302008-04-28 14:13:20 -0700324 str = NULL;
Jason Wesself2d937f2008-04-17 20:05:37 +0200325
Alan Coxf34d7a52008-04-30 00:54:13 -0700326 if (tty_line >= 0 && tty_line <= p->num && p->ops &&
327 p->ops->poll_init && !p->ops->poll_init(p, tty_line, str)) {
Jason Wesself2d937f2008-04-17 20:05:37 +0200328 res = p;
329 *line = tty_line;
330 break;
331 }
332 }
333 mutex_unlock(&tty_mutex);
334
335 return res;
336}
337EXPORT_SYMBOL_GPL(tty_find_polling_driver);
338#endif
339
Alan Coxaf9b8972006-08-27 01:24:01 -0700340/**
341 * tty_check_change - check for POSIX terminal changes
342 * @tty: tty to check
343 *
344 * If we try to write to, or set the state of, a terminal and we're
345 * not in the foreground, send a SIGTTOU. If the signal is blocked or
346 * ignored, go ahead and perform the operation. (POSIX 7.2)
347 *
Alan Cox978e5952008-04-30 00:53:59 -0700348 * Locking: ctrl_lock
Linus Torvalds1da177e2005-04-16 15:20:36 -0700349 */
Alan Coxaf9b8972006-08-27 01:24:01 -0700350
Alan Cox37bdfb02008-02-08 04:18:47 -0800351int tty_check_change(struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700352{
Alan Cox47f86832008-04-30 00:53:30 -0700353 unsigned long flags;
354 int ret = 0;
355
Linus Torvalds1da177e2005-04-16 15:20:36 -0700356 if (current->signal->tty != tty)
357 return 0;
Alan Cox47f86832008-04-30 00:53:30 -0700358
359 spin_lock_irqsave(&tty->ctrl_lock, flags);
360
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800361 if (!tty->pgrp) {
362 printk(KERN_WARNING "tty_check_change: tty->pgrp == NULL!\n");
Andrew Morton9ffee4c2008-05-14 16:05:58 -0700363 goto out_unlock;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700364 }
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800365 if (task_pgrp(current) == tty->pgrp)
Andrew Morton9ffee4c2008-05-14 16:05:58 -0700366 goto out_unlock;
367 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700368 if (is_ignored(SIGTTOU))
Alan Cox47f86832008-04-30 00:53:30 -0700369 goto out;
370 if (is_current_pgrp_orphaned()) {
371 ret = -EIO;
372 goto out;
373 }
Oleg Nesterov040b6362007-06-01 00:46:53 -0700374 kill_pgrp(task_pgrp(current), SIGTTOU, 1);
375 set_thread_flag(TIF_SIGPENDING);
Alan Cox47f86832008-04-30 00:53:30 -0700376 ret = -ERESTARTSYS;
377out:
Andrew Morton9ffee4c2008-05-14 16:05:58 -0700378 return ret;
379out_unlock:
Alan Cox47f86832008-04-30 00:53:30 -0700380 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
381 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700382}
383
384EXPORT_SYMBOL(tty_check_change);
385
Alan Cox37bdfb02008-02-08 04:18:47 -0800386static ssize_t hung_up_tty_read(struct file *file, char __user *buf,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700387 size_t count, loff_t *ppos)
388{
389 return 0;
390}
391
Alan Cox37bdfb02008-02-08 04:18:47 -0800392static ssize_t hung_up_tty_write(struct file *file, const char __user *buf,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700393 size_t count, loff_t *ppos)
394{
395 return -EIO;
396}
397
398/* No kernel lock held - none needed ;) */
Alan Cox37bdfb02008-02-08 04:18:47 -0800399static unsigned int hung_up_tty_poll(struct file *filp, poll_table *wait)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700400{
401 return POLLIN | POLLOUT | POLLERR | POLLHUP | POLLRDNORM | POLLWRNORM;
402}
403
Alan Cox04f378b2008-04-30 00:53:29 -0700404static long hung_up_tty_ioctl(struct file *file, unsigned int cmd,
405 unsigned long arg)
Paul Fulghum38ad2ed2007-06-16 10:15:55 -0700406{
407 return cmd == TIOCSPGRP ? -ENOTTY : -EIO;
408}
409
Alan Cox37bdfb02008-02-08 04:18:47 -0800410static long hung_up_tty_compat_ioctl(struct file *file,
Paul Fulghum38ad2ed2007-06-16 10:15:55 -0700411 unsigned int cmd, unsigned long arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700412{
413 return cmd == TIOCSPGRP ? -ENOTTY : -EIO;
414}
415
Arjan van de Ven62322d22006-07-03 00:24:21 -0700416static const struct file_operations tty_fops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700417 .llseek = no_llseek,
418 .read = tty_read,
419 .write = tty_write,
420 .poll = tty_poll,
Alan Cox04f378b2008-04-30 00:53:29 -0700421 .unlocked_ioctl = tty_ioctl,
Paul Fulghume10cc1d2007-05-10 22:22:50 -0700422 .compat_ioctl = tty_compat_ioctl,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700423 .open = tty_open,
424 .release = tty_release,
425 .fasync = tty_fasync,
426};
427
428#ifdef CONFIG_UNIX98_PTYS
Arjan van de Ven62322d22006-07-03 00:24:21 -0700429static const struct file_operations ptmx_fops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700430 .llseek = no_llseek,
431 .read = tty_read,
432 .write = tty_write,
433 .poll = tty_poll,
Alan Cox04f378b2008-04-30 00:53:29 -0700434 .unlocked_ioctl = tty_ioctl,
Paul Fulghume10cc1d2007-05-10 22:22:50 -0700435 .compat_ioctl = tty_compat_ioctl,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700436 .open = ptmx_open,
437 .release = tty_release,
438 .fasync = tty_fasync,
439};
440#endif
441
Arjan van de Ven62322d22006-07-03 00:24:21 -0700442static const struct file_operations console_fops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700443 .llseek = no_llseek,
444 .read = tty_read,
445 .write = redirected_tty_write,
446 .poll = tty_poll,
Alan Cox04f378b2008-04-30 00:53:29 -0700447 .unlocked_ioctl = tty_ioctl,
Paul Fulghume10cc1d2007-05-10 22:22:50 -0700448 .compat_ioctl = tty_compat_ioctl,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700449 .open = tty_open,
450 .release = tty_release,
451 .fasync = tty_fasync,
452};
453
Arjan van de Ven62322d22006-07-03 00:24:21 -0700454static const struct file_operations hung_up_tty_fops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700455 .llseek = no_llseek,
456 .read = hung_up_tty_read,
457 .write = hung_up_tty_write,
458 .poll = hung_up_tty_poll,
Alan Cox04f378b2008-04-30 00:53:29 -0700459 .unlocked_ioctl = hung_up_tty_ioctl,
Paul Fulghum38ad2ed2007-06-16 10:15:55 -0700460 .compat_ioctl = hung_up_tty_compat_ioctl,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700461 .release = tty_release,
462};
463
464static DEFINE_SPINLOCK(redirect_lock);
465static struct file *redirect;
466
467/**
468 * tty_wakeup - request more data
469 * @tty: terminal
470 *
471 * Internal and external helper for wakeups of tty. This function
472 * informs the line discipline if present that the driver is ready
473 * to receive more output data.
474 */
Alan Cox37bdfb02008-02-08 04:18:47 -0800475
Linus Torvalds1da177e2005-04-16 15:20:36 -0700476void tty_wakeup(struct tty_struct *tty)
477{
478 struct tty_ldisc *ld;
Alan Cox37bdfb02008-02-08 04:18:47 -0800479
Linus Torvalds1da177e2005-04-16 15:20:36 -0700480 if (test_bit(TTY_DO_WRITE_WAKEUP, &tty->flags)) {
481 ld = tty_ldisc_ref(tty);
Alan Cox37bdfb02008-02-08 04:18:47 -0800482 if (ld) {
Alan Coxa352def2008-07-16 21:53:12 +0100483 if (ld->ops->write_wakeup)
484 ld->ops->write_wakeup(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700485 tty_ldisc_deref(ld);
486 }
487 }
488 wake_up_interruptible(&tty->write_wait);
489}
490
491EXPORT_SYMBOL_GPL(tty_wakeup);
492
493/**
494 * tty_ldisc_flush - flush line discipline queue
495 * @tty: tty
496 *
497 * Flush the line discipline queue (if any) for this tty. If there
498 * is no line discipline active this is a no-op.
499 */
Alan Cox37bdfb02008-02-08 04:18:47 -0800500
Linus Torvalds1da177e2005-04-16 15:20:36 -0700501void tty_ldisc_flush(struct tty_struct *tty)
502{
503 struct tty_ldisc *ld = tty_ldisc_ref(tty);
Alan Cox37bdfb02008-02-08 04:18:47 -0800504 if (ld) {
Alan Coxa352def2008-07-16 21:53:12 +0100505 if (ld->ops->flush_buffer)
506 ld->ops->flush_buffer(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700507 tty_ldisc_deref(ld);
508 }
Paul Fulghumc5c34d42007-05-12 10:36:55 -0700509 tty_buffer_flush(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700510}
511
512EXPORT_SYMBOL_GPL(tty_ldisc_flush);
Alan Coxedc6afc2006-12-08 02:38:44 -0800513
514/**
515 * tty_reset_termios - reset terminal state
516 * @tty: tty to reset
517 *
518 * Restore a terminal to the driver default state
519 */
520
521static void tty_reset_termios(struct tty_struct *tty)
522{
523 mutex_lock(&tty->termios_mutex);
524 *tty->termios = tty->driver->init_termios;
525 tty->termios->c_ispeed = tty_termios_input_baud_rate(tty->termios);
526 tty->termios->c_ospeed = tty_termios_baud_rate(tty->termios);
527 mutex_unlock(&tty->termios_mutex);
528}
Alan Cox37bdfb02008-02-08 04:18:47 -0800529
Alan Coxaf9b8972006-08-27 01:24:01 -0700530/**
531 * do_tty_hangup - actual handler for hangup events
David Howells65f27f32006-11-22 14:55:48 +0000532 * @work: tty device
Alan Coxaf9b8972006-08-27 01:24:01 -0700533 *
Alan Cox1bad8792008-07-22 23:38:04 +0100534 * This can be called by the "eventd" kernel thread. That is process
Alan Coxaf9b8972006-08-27 01:24:01 -0700535 * synchronous but doesn't hold any locks, so we need to make sure we
536 * have the appropriate locks for what we're doing.
537 *
538 * The hangup event clears any pending redirections onto the hung up
539 * device. It ensures future writes will error and it does the needed
540 * line discipline hangup and signal delivery. The tty object itself
541 * remains intact.
542 *
543 * Locking:
544 * BKL
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800545 * redirect lock for undoing redirection
546 * file list lock for manipulating list of ttys
547 * tty_ldisc_lock from called functions
548 * termios_mutex resetting termios data
549 * tasklist_lock to walk task list for hangup event
550 * ->siglock to protect ->signal/->sighand
Linus Torvalds1da177e2005-04-16 15:20:36 -0700551 */
David Howells65f27f32006-11-22 14:55:48 +0000552static void do_tty_hangup(struct work_struct *work)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700553{
David Howells65f27f32006-11-22 14:55:48 +0000554 struct tty_struct *tty =
555 container_of(work, struct tty_struct, hangup_work);
Alan Cox37bdfb02008-02-08 04:18:47 -0800556 struct file *cons_filp = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700557 struct file *filp, *f = NULL;
558 struct task_struct *p;
559 struct tty_ldisc *ld;
560 int closecount = 0, n;
Alan Cox47f86832008-04-30 00:53:30 -0700561 unsigned long flags;
Alan Cox9c9f4de2008-10-13 10:37:26 +0100562 int refs = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700563
564 if (!tty)
565 return;
566
567 /* inuse_filps is protected by the single kernel lock */
568 lock_kernel();
569
570 spin_lock(&redirect_lock);
571 if (redirect && redirect->private_data == tty) {
572 f = redirect;
573 redirect = NULL;
574 }
575 spin_unlock(&redirect_lock);
Alan Cox37bdfb02008-02-08 04:18:47 -0800576
Linus Torvalds1da177e2005-04-16 15:20:36 -0700577 check_tty_count(tty, "do_tty_hangup");
578 file_list_lock();
579 /* This breaks for file handles being sent over AF_UNIX sockets ? */
Eric Dumazet2f512012005-10-30 15:02:16 -0800580 list_for_each_entry(filp, &tty->tty_files, f_u.fu_list) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700581 if (filp->f_op->write == redirected_tty_write)
582 cons_filp = filp;
583 if (filp->f_op->write != tty_write)
584 continue;
585 closecount++;
586 tty_fasync(-1, filp, 0); /* can't block */
587 filp->f_op = &hung_up_tty_fops;
588 }
589 file_list_unlock();
Alan Cox37bdfb02008-02-08 04:18:47 -0800590 /*
591 * FIXME! What are the locking issues here? This may me overdoing
592 * things... This question is especially important now that we've
593 * removed the irqlock.
594 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700595 ld = tty_ldisc_ref(tty);
Alan Cox37bdfb02008-02-08 04:18:47 -0800596 if (ld != NULL) {
597 /* We may have no line discipline at this point */
Alan Coxa352def2008-07-16 21:53:12 +0100598 if (ld->ops->flush_buffer)
599 ld->ops->flush_buffer(tty);
Alan Coxf34d7a52008-04-30 00:54:13 -0700600 tty_driver_flush_buffer(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700601 if ((test_bit(TTY_DO_WRITE_WAKEUP, &tty->flags)) &&
Alan Coxa352def2008-07-16 21:53:12 +0100602 ld->ops->write_wakeup)
603 ld->ops->write_wakeup(tty);
604 if (ld->ops->hangup)
605 ld->ops->hangup(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700606 }
Alan Cox37bdfb02008-02-08 04:18:47 -0800607 /*
608 * FIXME: Once we trust the LDISC code better we can wait here for
609 * ldisc completion and fix the driver call race
610 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700611 wake_up_interruptible(&tty->write_wait);
612 wake_up_interruptible(&tty->read_wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700613 /*
614 * Shutdown the current line discipline, and reset it to
615 * N_TTY.
616 */
617 if (tty->driver->flags & TTY_DRIVER_RESET_TERMIOS)
Alan Coxedc6afc2006-12-08 02:38:44 -0800618 tty_reset_termios(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700619 /* Defer ldisc switch */
620 /* tty_deferred_ldisc_switch(N_TTY);
Alan Cox37bdfb02008-02-08 04:18:47 -0800621
Linus Torvalds1da177e2005-04-16 15:20:36 -0700622 This should get done automatically when the port closes and
623 tty_release is called */
Alan Cox37bdfb02008-02-08 04:18:47 -0800624
Linus Torvalds1da177e2005-04-16 15:20:36 -0700625 read_lock(&tasklist_lock);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800626 if (tty->session) {
627 do_each_pid_task(tty->session, PIDTYPE_SID, p) {
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800628 spin_lock_irq(&p->sighand->siglock);
Alan Cox9c9f4de2008-10-13 10:37:26 +0100629 if (p->signal->tty == tty) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700630 p->signal->tty = NULL;
Alan Cox9c9f4de2008-10-13 10:37:26 +0100631 /* We defer the dereferences outside fo
632 the tasklist lock */
633 refs++;
634 }
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800635 if (!p->signal->leader) {
636 spin_unlock_irq(&p->sighand->siglock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700637 continue;
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800638 }
639 __group_send_sig_info(SIGHUP, SEND_SIG_PRIV, p);
640 __group_send_sig_info(SIGCONT, SEND_SIG_PRIV, p);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800641 put_pid(p->signal->tty_old_pgrp); /* A noop */
Alan Cox47f86832008-04-30 00:53:30 -0700642 spin_lock_irqsave(&tty->ctrl_lock, flags);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800643 if (tty->pgrp)
644 p->signal->tty_old_pgrp = get_pid(tty->pgrp);
Alan Cox47f86832008-04-30 00:53:30 -0700645 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800646 spin_unlock_irq(&p->sighand->siglock);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800647 } while_each_pid_task(tty->session, PIDTYPE_SID, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700648 }
649 read_unlock(&tasklist_lock);
650
Alan Cox47f86832008-04-30 00:53:30 -0700651 spin_lock_irqsave(&tty->ctrl_lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700652 tty->flags = 0;
Eric W. Biedermand9c1e9a2007-03-18 12:45:44 -0600653 put_pid(tty->session);
654 put_pid(tty->pgrp);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800655 tty->session = NULL;
656 tty->pgrp = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700657 tty->ctrl_status = 0;
Alan Cox47f86832008-04-30 00:53:30 -0700658 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
659
Alan Cox9c9f4de2008-10-13 10:37:26 +0100660 /* Account for the p->signal references we killed */
661 while (refs--)
662 tty_kref_put(tty);
663
Linus Torvalds1da177e2005-04-16 15:20:36 -0700664 /*
Alan Cox37bdfb02008-02-08 04:18:47 -0800665 * If one of the devices matches a console pointer, we
666 * cannot just call hangup() because that will cause
667 * tty->count and state->count to go out of sync.
668 * So we just call close() the right number of times.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700669 */
670 if (cons_filp) {
Alan Coxf34d7a52008-04-30 00:54:13 -0700671 if (tty->ops->close)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700672 for (n = 0; n < closecount; n++)
Alan Coxf34d7a52008-04-30 00:54:13 -0700673 tty->ops->close(tty, cons_filp);
674 } else if (tty->ops->hangup)
675 (tty->ops->hangup)(tty);
Alan Cox37bdfb02008-02-08 04:18:47 -0800676 /*
677 * We don't want to have driver/ldisc interactions beyond
678 * the ones we did here. The driver layer expects no
679 * calls after ->hangup() from the ldisc side. However we
680 * can't yet guarantee all that.
681 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700682 set_bit(TTY_HUPPED, &tty->flags);
683 if (ld) {
684 tty_ldisc_enable(tty);
685 tty_ldisc_deref(ld);
686 }
687 unlock_kernel();
688 if (f)
689 fput(f);
690}
691
Alan Coxaf9b8972006-08-27 01:24:01 -0700692/**
693 * tty_hangup - trigger a hangup event
694 * @tty: tty to hangup
695 *
696 * A carrier loss (virtual or otherwise) has occurred on this like
697 * schedule a hangup sequence to run after this event.
698 */
699
Alan Cox37bdfb02008-02-08 04:18:47 -0800700void tty_hangup(struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700701{
702#ifdef TTY_DEBUG_HANGUP
703 char buf[64];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700704 printk(KERN_DEBUG "%s hangup...\n", tty_name(tty, buf));
705#endif
706 schedule_work(&tty->hangup_work);
707}
708
709EXPORT_SYMBOL(tty_hangup);
710
Alan Coxaf9b8972006-08-27 01:24:01 -0700711/**
712 * tty_vhangup - process vhangup
713 * @tty: tty to hangup
714 *
715 * The user has asked via system call for the terminal to be hung up.
716 * We do this synchronously so that when the syscall returns the process
Robert P. J. Day3a4fa0a2007-10-19 23:10:43 +0200717 * is complete. That guarantee is necessary for security reasons.
Alan Coxaf9b8972006-08-27 01:24:01 -0700718 */
719
Alan Cox37bdfb02008-02-08 04:18:47 -0800720void tty_vhangup(struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700721{
722#ifdef TTY_DEBUG_HANGUP
723 char buf[64];
724
725 printk(KERN_DEBUG "%s vhangup...\n", tty_name(tty, buf));
726#endif
David Howells65f27f32006-11-22 14:55:48 +0000727 do_tty_hangup(&tty->hangup_work);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700728}
Alan Cox37bdfb02008-02-08 04:18:47 -0800729
Linus Torvalds1da177e2005-04-16 15:20:36 -0700730EXPORT_SYMBOL(tty_vhangup);
731
Alan Coxaf9b8972006-08-27 01:24:01 -0700732/**
Alan Cox2cb59982008-10-13 10:40:30 +0100733 * tty_vhangup_self - process vhangup for own ctty
734 *
735 * Perform a vhangup on the current controlling tty
736 */
737
738void tty_vhangup_self(void)
739{
740 struct tty_struct *tty;
741
742 mutex_lock(&tty_mutex);
743 tty = get_current_tty();
744 if (tty) {
745 tty_vhangup(tty);
746 tty_kref_put(tty);
747 }
748 mutex_unlock(&tty_mutex);
749}
750
751/**
Alan Coxaf9b8972006-08-27 01:24:01 -0700752 * tty_hung_up_p - was tty hung up
753 * @filp: file pointer of tty
754 *
755 * Return true if the tty has been subject to a vhangup or a carrier
756 * loss
757 */
758
Alan Cox37bdfb02008-02-08 04:18:47 -0800759int tty_hung_up_p(struct file *filp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700760{
761 return (filp->f_op == &hung_up_tty_fops);
762}
763
764EXPORT_SYMBOL(tty_hung_up_p);
765
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800766static void session_clear_tty(struct pid *session)
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800767{
768 struct task_struct *p;
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800769 do_each_pid_task(session, PIDTYPE_SID, p) {
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800770 proc_clear_tty(p);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800771 } while_each_pid_task(session, PIDTYPE_SID, p);
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800772}
773
Alan Coxaf9b8972006-08-27 01:24:01 -0700774/**
775 * disassociate_ctty - disconnect controlling tty
776 * @on_exit: true if exiting so need to "hang up" the session
Linus Torvalds1da177e2005-04-16 15:20:36 -0700777 *
Alan Coxaf9b8972006-08-27 01:24:01 -0700778 * This function is typically called only by the session leader, when
779 * it wants to disassociate itself from its controlling tty.
780 *
781 * It performs the following functions:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700782 * (1) Sends a SIGHUP and SIGCONT to the foreground process group
783 * (2) Clears the tty from being controlling the session
784 * (3) Clears the controlling tty for all processes in the
785 * session group.
786 *
Alan Coxaf9b8972006-08-27 01:24:01 -0700787 * The argument on_exit is set to 1 if called when a process is
788 * exiting; it is 0 if called by the ioctl TIOCNOTTY.
789 *
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800790 * Locking:
Alan Coxaf9b8972006-08-27 01:24:01 -0700791 * BKL is taken for hysterical raisins
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800792 * tty_mutex is taken to protect tty
793 * ->siglock is taken to protect ->signal/->sighand
794 * tasklist_lock is taken to walk process list for sessions
795 * ->siglock is taken to protect ->signal/->sighand
Linus Torvalds1da177e2005-04-16 15:20:36 -0700796 */
Alan Coxaf9b8972006-08-27 01:24:01 -0700797
Linus Torvalds1da177e2005-04-16 15:20:36 -0700798void disassociate_ctty(int on_exit)
799{
800 struct tty_struct *tty;
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800801 struct pid *tty_pgrp = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700802
Linus Torvalds1da177e2005-04-16 15:20:36 -0700803
Ingo Molnar70522e12006-03-23 03:00:31 -0800804 mutex_lock(&tty_mutex);
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800805 tty = get_current_tty();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700806 if (tty) {
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800807 tty_pgrp = get_pid(tty->pgrp);
Christian Borntraeger000b9152008-08-11 09:02:49 +0100808 mutex_unlock(&tty_mutex);
Alan Cox452a00d2008-10-13 10:39:13 +0100809 lock_kernel();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700810 if (on_exit && tty->driver->type != TTY_DRIVER_TYPE_PTY)
811 tty_vhangup(tty);
Alan Cox04f378b2008-04-30 00:53:29 -0700812 unlock_kernel();
Alan Cox452a00d2008-10-13 10:39:13 +0100813 tty_kref_put(tty);
Eric W. Biederman680a9672007-02-12 00:52:52 -0800814 } else if (on_exit) {
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800815 struct pid *old_pgrp;
Eric W. Biederman680a9672007-02-12 00:52:52 -0800816 spin_lock_irq(&current->sighand->siglock);
817 old_pgrp = current->signal->tty_old_pgrp;
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800818 current->signal->tty_old_pgrp = NULL;
Eric W. Biederman680a9672007-02-12 00:52:52 -0800819 spin_unlock_irq(&current->sighand->siglock);
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800820 if (old_pgrp) {
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800821 kill_pgrp(old_pgrp, SIGHUP, on_exit);
822 kill_pgrp(old_pgrp, SIGCONT, on_exit);
823 put_pid(old_pgrp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700824 }
Ingo Molnar70522e12006-03-23 03:00:31 -0800825 mutex_unlock(&tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700826 return;
827 }
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800828 if (tty_pgrp) {
829 kill_pgrp(tty_pgrp, SIGHUP, on_exit);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700830 if (!on_exit)
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800831 kill_pgrp(tty_pgrp, SIGCONT, on_exit);
832 put_pid(tty_pgrp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700833 }
834
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800835 spin_lock_irq(&current->sighand->siglock);
Eric W. Biederman2a65f1d2007-05-08 00:26:53 -0700836 put_pid(current->signal->tty_old_pgrp);
Randy Dunlap23cac8d2007-02-20 13:58:05 -0800837 current->signal->tty_old_pgrp = NULL;
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800838 spin_unlock_irq(&current->sighand->siglock);
839
840 mutex_lock(&tty_mutex);
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800841 tty = get_current_tty();
842 if (tty) {
Alan Cox47f86832008-04-30 00:53:30 -0700843 unsigned long flags;
844 spin_lock_irqsave(&tty->ctrl_lock, flags);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800845 put_pid(tty->session);
846 put_pid(tty->pgrp);
847 tty->session = NULL;
848 tty->pgrp = NULL;
Alan Cox47f86832008-04-30 00:53:30 -0700849 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
Alan Cox452a00d2008-10-13 10:39:13 +0100850 tty_kref_put(tty);
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800851 } else {
852#ifdef TTY_DEBUG_HANGUP
853 printk(KERN_DEBUG "error attempted to write to tty [0x%p]"
854 " = NULL", tty);
855#endif
856 }
857 mutex_unlock(&tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700858
859 /* Now clear signal->tty under the lock */
860 read_lock(&tasklist_lock);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800861 session_clear_tty(task_session(current));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700862 read_unlock(&tasklist_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700863}
864
Eric W. Biederman98a27ba2007-05-08 00:26:56 -0700865/**
866 *
867 * no_tty - Ensure the current process does not have a controlling tty
868 */
869void no_tty(void)
870{
871 struct task_struct *tsk = current;
Alan Cox04f378b2008-04-30 00:53:29 -0700872 lock_kernel();
Eric W. Biederman98a27ba2007-05-08 00:26:56 -0700873 if (tsk->signal->leader)
874 disassociate_ctty(0);
Alan Cox04f378b2008-04-30 00:53:29 -0700875 unlock_kernel();
Eric W. Biederman98a27ba2007-05-08 00:26:56 -0700876 proc_clear_tty(tsk);
877}
878
Alan Coxaf9b8972006-08-27 01:24:01 -0700879
880/**
Robert P. J. Daybeb7dd82007-05-09 07:14:03 +0200881 * stop_tty - propagate flow control
Alan Coxaf9b8972006-08-27 01:24:01 -0700882 * @tty: tty to stop
883 *
884 * Perform flow control to the driver. For PTY/TTY pairs we
Robert P. J. Daybeb7dd82007-05-09 07:14:03 +0200885 * must also propagate the TIOCKPKT status. May be called
Alan Coxaf9b8972006-08-27 01:24:01 -0700886 * on an already stopped device and will not re-call the driver
887 * method.
888 *
889 * This functionality is used by both the line disciplines for
890 * halting incoming flow and by the driver. It may therefore be
891 * called from any context, may be under the tty atomic_write_lock
892 * but not always.
893 *
894 * Locking:
Alan Cox04f378b2008-04-30 00:53:29 -0700895 * Uses the tty control lock internally
Alan Coxaf9b8972006-08-27 01:24:01 -0700896 */
897
Linus Torvalds1da177e2005-04-16 15:20:36 -0700898void stop_tty(struct tty_struct *tty)
899{
Alan Cox04f378b2008-04-30 00:53:29 -0700900 unsigned long flags;
901 spin_lock_irqsave(&tty->ctrl_lock, flags);
902 if (tty->stopped) {
903 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700904 return;
Alan Cox04f378b2008-04-30 00:53:29 -0700905 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700906 tty->stopped = 1;
907 if (tty->link && tty->link->packet) {
908 tty->ctrl_status &= ~TIOCPKT_START;
909 tty->ctrl_status |= TIOCPKT_STOP;
910 wake_up_interruptible(&tty->link->read_wait);
911 }
Alan Cox04f378b2008-04-30 00:53:29 -0700912 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
Alan Coxf34d7a52008-04-30 00:54:13 -0700913 if (tty->ops->stop)
914 (tty->ops->stop)(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700915}
916
917EXPORT_SYMBOL(stop_tty);
918
Alan Coxaf9b8972006-08-27 01:24:01 -0700919/**
Robert P. J. Daybeb7dd82007-05-09 07:14:03 +0200920 * start_tty - propagate flow control
Alan Coxaf9b8972006-08-27 01:24:01 -0700921 * @tty: tty to start
922 *
923 * Start a tty that has been stopped if at all possible. Perform
Robert P. J. Day3a4fa0a2007-10-19 23:10:43 +0200924 * any necessary wakeups and propagate the TIOCPKT status. If this
Alan Coxaf9b8972006-08-27 01:24:01 -0700925 * is the tty was previous stopped and is being started then the
926 * driver start method is invoked and the line discipline woken.
927 *
928 * Locking:
Alan Cox04f378b2008-04-30 00:53:29 -0700929 * ctrl_lock
Alan Coxaf9b8972006-08-27 01:24:01 -0700930 */
931
Linus Torvalds1da177e2005-04-16 15:20:36 -0700932void start_tty(struct tty_struct *tty)
933{
Alan Cox04f378b2008-04-30 00:53:29 -0700934 unsigned long flags;
935 spin_lock_irqsave(&tty->ctrl_lock, flags);
936 if (!tty->stopped || tty->flow_stopped) {
937 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700938 return;
Alan Cox04f378b2008-04-30 00:53:29 -0700939 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700940 tty->stopped = 0;
941 if (tty->link && tty->link->packet) {
942 tty->ctrl_status &= ~TIOCPKT_STOP;
943 tty->ctrl_status |= TIOCPKT_START;
944 wake_up_interruptible(&tty->link->read_wait);
945 }
Alan Cox04f378b2008-04-30 00:53:29 -0700946 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
Alan Coxf34d7a52008-04-30 00:54:13 -0700947 if (tty->ops->start)
948 (tty->ops->start)(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700949 /* If we have a running line discipline it may need kicking */
950 tty_wakeup(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700951}
952
953EXPORT_SYMBOL(start_tty);
954
Alan Coxaf9b8972006-08-27 01:24:01 -0700955/**
956 * tty_read - read method for tty device files
957 * @file: pointer to tty file
958 * @buf: user buffer
959 * @count: size of user buffer
960 * @ppos: unused
961 *
962 * Perform the read system call function on this terminal device. Checks
963 * for hung up devices before calling the line discipline method.
964 *
965 * Locking:
Alan Cox47f86832008-04-30 00:53:30 -0700966 * Locks the line discipline internally while needed. Multiple
967 * read calls may be outstanding in parallel.
Alan Coxaf9b8972006-08-27 01:24:01 -0700968 */
969
Alan Cox37bdfb02008-02-08 04:18:47 -0800970static ssize_t tty_read(struct file *file, char __user *buf, size_t count,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700971 loff_t *ppos)
972{
973 int i;
Alan Cox37bdfb02008-02-08 04:18:47 -0800974 struct tty_struct *tty;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700975 struct inode *inode;
976 struct tty_ldisc *ld;
977
978 tty = (struct tty_struct *)file->private_data;
Josef Sipeka7113a92006-12-08 02:36:55 -0800979 inode = file->f_path.dentry->d_inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700980 if (tty_paranoia_check(tty, inode, "tty_read"))
981 return -EIO;
982 if (!tty || (test_bit(TTY_IO_ERROR, &tty->flags)))
983 return -EIO;
984
985 /* We want to wait for the line discipline to sort out in this
986 situation */
987 ld = tty_ldisc_ref_wait(tty);
Alan Coxa352def2008-07-16 21:53:12 +0100988 if (ld->ops->read)
989 i = (ld->ops->read)(tty, file, buf, count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700990 else
991 i = -EIO;
992 tty_ldisc_deref(ld);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700993 if (i > 0)
994 inode->i_atime = current_fs_time(inode->i_sb);
995 return i;
996}
997
Alan Cox9c1729d2007-07-15 23:39:43 -0700998void tty_write_unlock(struct tty_struct *tty)
999{
1000 mutex_unlock(&tty->atomic_write_lock);
1001 wake_up_interruptible(&tty->write_wait);
1002}
1003
1004int tty_write_lock(struct tty_struct *tty, int ndelay)
1005{
1006 if (!mutex_trylock(&tty->atomic_write_lock)) {
1007 if (ndelay)
1008 return -EAGAIN;
1009 if (mutex_lock_interruptible(&tty->atomic_write_lock))
1010 return -ERESTARTSYS;
1011 }
1012 return 0;
1013}
1014
Linus Torvalds1da177e2005-04-16 15:20:36 -07001015/*
1016 * Split writes up in sane blocksizes to avoid
1017 * denial-of-service type attacks
1018 */
1019static inline ssize_t do_tty_write(
1020 ssize_t (*write)(struct tty_struct *, struct file *, const unsigned char *, size_t),
1021 struct tty_struct *tty,
1022 struct file *file,
1023 const char __user *buf,
1024 size_t count)
1025{
Alan Cox9c1729d2007-07-15 23:39:43 -07001026 ssize_t ret, written = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001027 unsigned int chunk;
Alan Cox37bdfb02008-02-08 04:18:47 -08001028
Alan Cox9c1729d2007-07-15 23:39:43 -07001029 ret = tty_write_lock(tty, file->f_flags & O_NDELAY);
1030 if (ret < 0)
1031 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001032
1033 /*
1034 * We chunk up writes into a temporary buffer. This
1035 * simplifies low-level drivers immensely, since they
1036 * don't have locking issues and user mode accesses.
1037 *
1038 * But if TTY_NO_WRITE_SPLIT is set, we should use a
1039 * big chunk-size..
1040 *
1041 * The default chunk-size is 2kB, because the NTTY
1042 * layer has problems with bigger chunks. It will
1043 * claim to be able to handle more characters than
1044 * it actually does.
Alan Coxaf9b8972006-08-27 01:24:01 -07001045 *
1046 * FIXME: This can probably go away now except that 64K chunks
1047 * are too likely to fail unless switched to vmalloc...
Linus Torvalds1da177e2005-04-16 15:20:36 -07001048 */
1049 chunk = 2048;
1050 if (test_bit(TTY_NO_WRITE_SPLIT, &tty->flags))
1051 chunk = 65536;
1052 if (count < chunk)
1053 chunk = count;
1054
Ingo Molnar70522e12006-03-23 03:00:31 -08001055 /* write_buf/write_cnt is protected by the atomic_write_lock mutex */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001056 if (tty->write_cnt < chunk) {
1057 unsigned char *buf;
1058
1059 if (chunk < 1024)
1060 chunk = 1024;
1061
1062 buf = kmalloc(chunk, GFP_KERNEL);
1063 if (!buf) {
Alan Cox9c1729d2007-07-15 23:39:43 -07001064 ret = -ENOMEM;
1065 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001066 }
1067 kfree(tty->write_buf);
1068 tty->write_cnt = chunk;
1069 tty->write_buf = buf;
1070 }
1071
1072 /* Do the write .. */
1073 for (;;) {
1074 size_t size = count;
1075 if (size > chunk)
1076 size = chunk;
1077 ret = -EFAULT;
1078 if (copy_from_user(tty->write_buf, buf, size))
1079 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001080 ret = write(tty, file, tty->write_buf, size);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001081 if (ret <= 0)
1082 break;
1083 written += ret;
1084 buf += ret;
1085 count -= ret;
1086 if (!count)
1087 break;
1088 ret = -ERESTARTSYS;
1089 if (signal_pending(current))
1090 break;
1091 cond_resched();
1092 }
1093 if (written) {
Josef Sipeka7113a92006-12-08 02:36:55 -08001094 struct inode *inode = file->f_path.dentry->d_inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001095 inode->i_mtime = current_fs_time(inode->i_sb);
1096 ret = written;
1097 }
Alan Cox9c1729d2007-07-15 23:39:43 -07001098out:
1099 tty_write_unlock(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001100 return ret;
1101}
1102
Alan Cox95f9bfc2008-10-13 10:39:23 +01001103/**
1104 * tty_write_message - write a message to a certain tty, not just the console.
1105 * @tty: the destination tty_struct
1106 * @msg: the message to write
1107 *
1108 * This is used for messages that need to be redirected to a specific tty.
1109 * We don't put it into the syslog queue right now maybe in the future if
1110 * really needed.
1111 *
1112 * We must still hold the BKL and test the CLOSING flag for the moment.
1113 */
1114
1115void tty_write_message(struct tty_struct *tty, char *msg)
1116{
1117 lock_kernel();
1118 if (tty) {
1119 mutex_lock(&tty->atomic_write_lock);
1120 if (tty->ops->write && !test_bit(TTY_CLOSING, &tty->flags))
1121 tty->ops->write(tty, msg, strlen(msg));
1122 tty_write_unlock(tty);
1123 }
1124 unlock_kernel();
1125 return;
1126}
1127
Linus Torvalds1da177e2005-04-16 15:20:36 -07001128
Alan Coxaf9b8972006-08-27 01:24:01 -07001129/**
1130 * tty_write - write method for tty device file
1131 * @file: tty file pointer
1132 * @buf: user data to write
1133 * @count: bytes to write
1134 * @ppos: unused
1135 *
1136 * Write data to a tty device via the line discipline.
1137 *
1138 * Locking:
1139 * Locks the line discipline as required
1140 * Writes to the tty driver are serialized by the atomic_write_lock
1141 * and are then processed in chunks to the device. The line discipline
1142 * write method will not be involked in parallel for each device
1143 * The line discipline write method is called under the big
1144 * kernel lock for historical reasons. New code should not rely on this.
1145 */
1146
Alan Cox37bdfb02008-02-08 04:18:47 -08001147static ssize_t tty_write(struct file *file, const char __user *buf,
1148 size_t count, loff_t *ppos)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001149{
Alan Cox37bdfb02008-02-08 04:18:47 -08001150 struct tty_struct *tty;
Josef Sipeka7113a92006-12-08 02:36:55 -08001151 struct inode *inode = file->f_path.dentry->d_inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001152 ssize_t ret;
1153 struct tty_ldisc *ld;
Alan Cox37bdfb02008-02-08 04:18:47 -08001154
Linus Torvalds1da177e2005-04-16 15:20:36 -07001155 tty = (struct tty_struct *)file->private_data;
1156 if (tty_paranoia_check(tty, inode, "tty_write"))
1157 return -EIO;
Alan Coxf34d7a52008-04-30 00:54:13 -07001158 if (!tty || !tty->ops->write ||
Alan Cox37bdfb02008-02-08 04:18:47 -08001159 (test_bit(TTY_IO_ERROR, &tty->flags)))
1160 return -EIO;
Alan Coxf34d7a52008-04-30 00:54:13 -07001161 /* Short term debug to catch buggy drivers */
1162 if (tty->ops->write_room == NULL)
1163 printk(KERN_ERR "tty driver %s lacks a write_room method.\n",
1164 tty->driver->name);
Alan Cox37bdfb02008-02-08 04:18:47 -08001165 ld = tty_ldisc_ref_wait(tty);
Alan Coxa352def2008-07-16 21:53:12 +01001166 if (!ld->ops->write)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001167 ret = -EIO;
1168 else
Alan Coxa352def2008-07-16 21:53:12 +01001169 ret = do_tty_write(ld->ops->write, tty, file, buf, count);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001170 tty_ldisc_deref(ld);
1171 return ret;
1172}
1173
Alan Cox37bdfb02008-02-08 04:18:47 -08001174ssize_t redirected_tty_write(struct file *file, const char __user *buf,
1175 size_t count, loff_t *ppos)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001176{
1177 struct file *p = NULL;
1178
1179 spin_lock(&redirect_lock);
1180 if (redirect) {
1181 get_file(redirect);
1182 p = redirect;
1183 }
1184 spin_unlock(&redirect_lock);
1185
1186 if (p) {
1187 ssize_t res;
1188 res = vfs_write(p, buf, count, &p->f_pos);
1189 fput(p);
1190 return res;
1191 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001192 return tty_write(file, buf, count, ppos);
1193}
1194
1195static char ptychar[] = "pqrstuvwxyzabcde";
1196
Alan Coxaf9b8972006-08-27 01:24:01 -07001197/**
1198 * pty_line_name - generate name for a pty
1199 * @driver: the tty driver in use
1200 * @index: the minor number
1201 * @p: output buffer of at least 6 bytes
1202 *
1203 * Generate a name from a driver reference and write it to the output
1204 * buffer.
1205 *
1206 * Locking: None
1207 */
1208static void pty_line_name(struct tty_driver *driver, int index, char *p)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001209{
1210 int i = index + driver->name_base;
1211 /* ->name is initialized to "ttyp", but "tty" is expected */
1212 sprintf(p, "%s%c%x",
Alan Cox37bdfb02008-02-08 04:18:47 -08001213 driver->subtype == PTY_TYPE_SLAVE ? "tty" : driver->name,
1214 ptychar[i >> 4 & 0xf], i & 0xf);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001215}
1216
Alan Coxaf9b8972006-08-27 01:24:01 -07001217/**
1218 * pty_line_name - generate name for a tty
1219 * @driver: the tty driver in use
1220 * @index: the minor number
1221 * @p: output buffer of at least 7 bytes
1222 *
1223 * Generate a name from a driver reference and write it to the output
1224 * buffer.
1225 *
1226 * Locking: None
1227 */
1228static void tty_line_name(struct tty_driver *driver, int index, char *p)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001229{
1230 sprintf(p, "%s%d", driver->name, index + driver->name_base);
1231}
1232
Alan Coxaf9b8972006-08-27 01:24:01 -07001233/**
1234 * init_dev - initialise a tty device
1235 * @driver: tty driver we are opening a device on
1236 * @idx: device index
1237 * @tty: returned tty structure
1238 *
1239 * Prepare a tty device. This may not be a "new" clean device but
1240 * could also be an active device. The pty drivers require special
1241 * handling because of this.
1242 *
1243 * Locking:
1244 * The function is called under the tty_mutex, which
1245 * protects us from the tty struct or driver itself going away.
1246 *
1247 * On exit the tty device has the line discipline attached and
1248 * a reference count of 1. If a pair was created for pty/tty use
1249 * and the other was a pty master then it too has a reference count of 1.
1250 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07001251 * WSH 06/09/97: Rewritten to remove races and properly clean up after a
Ingo Molnar70522e12006-03-23 03:00:31 -08001252 * failed open. The new code protects the open with a mutex, so it's
1253 * really quite straightforward. The mutex locking can probably be
Linus Torvalds1da177e2005-04-16 15:20:36 -07001254 * relaxed for the (most common) case of reopening a tty.
1255 */
Alan Coxaf9b8972006-08-27 01:24:01 -07001256
Linus Torvalds1da177e2005-04-16 15:20:36 -07001257static int init_dev(struct tty_driver *driver, int idx,
1258 struct tty_struct **ret_tty)
1259{
1260 struct tty_struct *tty, *o_tty;
Alan Coxedc6afc2006-12-08 02:38:44 -08001261 struct ktermios *tp, **tp_loc, *o_tp, **o_tp_loc;
1262 struct ktermios *ltp, **ltp_loc, *o_ltp, **o_ltp_loc;
Alan Coxaf9b8972006-08-27 01:24:01 -07001263 int retval = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001264
1265 /* check whether we're reopening an existing tty */
1266 if (driver->flags & TTY_DRIVER_DEVPTS_MEM) {
1267 tty = devpts_get_tty(idx);
Aristeu Sergio Rozanski Filho5a39e8c2007-02-28 20:13:53 -08001268 /*
1269 * If we don't have a tty here on a slave open, it's because
1270 * the master already started the close process and there's
1271 * no relation between devpts file and tty anymore.
1272 */
1273 if (!tty && driver->subtype == PTY_TYPE_SLAVE) {
1274 retval = -EIO;
1275 goto end_init;
1276 }
1277 /*
1278 * It's safe from now on because init_dev() is called with
1279 * tty_mutex held and release_dev() won't change tty->count
1280 * or tty->flags without having to grab tty_mutex
1281 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001282 if (tty && driver->subtype == PTY_TYPE_MASTER)
1283 tty = tty->link;
1284 } else {
1285 tty = driver->ttys[idx];
1286 }
1287 if (tty) goto fast_track;
1288
1289 /*
1290 * First time open is complex, especially for PTY devices.
1291 * This code guarantees that either everything succeeds and the
1292 * TTY is ready for operation, or else the table slots are vacated
Alan Cox37bdfb02008-02-08 04:18:47 -08001293 * and the allocated memory released. (Except that the termios
Linus Torvalds1da177e2005-04-16 15:20:36 -07001294 * and locked termios may be retained.)
1295 */
1296
1297 if (!try_module_get(driver->owner)) {
1298 retval = -ENODEV;
1299 goto end_init;
1300 }
1301
1302 o_tty = NULL;
1303 tp = o_tp = NULL;
1304 ltp = o_ltp = NULL;
1305
1306 tty = alloc_tty_struct();
Alan Cox37bdfb02008-02-08 04:18:47 -08001307 if (!tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001308 goto fail_no_mem;
1309 initialize_tty_struct(tty);
1310 tty->driver = driver;
Alan Coxf34d7a52008-04-30 00:54:13 -07001311 tty->ops = driver->ops;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001312 tty->index = idx;
1313 tty_line_name(driver, idx, tty->name);
1314
1315 if (driver->flags & TTY_DRIVER_DEVPTS_MEM) {
1316 tp_loc = &tty->termios;
1317 ltp_loc = &tty->termios_locked;
1318 } else {
1319 tp_loc = &driver->termios[idx];
1320 ltp_loc = &driver->termios_locked[idx];
1321 }
1322
1323 if (!*tp_loc) {
Jesper Juhlabcb1ff32007-08-24 02:28:42 +02001324 tp = kmalloc(sizeof(struct ktermios), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001325 if (!tp)
1326 goto free_mem_out;
1327 *tp = driver->init_termios;
1328 }
1329
1330 if (!*ltp_loc) {
Jean Delvare506eb992007-07-15 23:40:14 -07001331 ltp = kzalloc(sizeof(struct ktermios), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001332 if (!ltp)
1333 goto free_mem_out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001334 }
1335
1336 if (driver->type == TTY_DRIVER_TYPE_PTY) {
1337 o_tty = alloc_tty_struct();
1338 if (!o_tty)
1339 goto free_mem_out;
Alan Cox6f967f72008-10-13 10:37:36 +01001340 if (!try_module_get(driver->other->owner)) {
1341 /* This cannot in fact currently happen */
1342 free_tty_struct(o_tty);
1343 o_tty = NULL;
1344 goto free_mem_out;
1345 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001346 initialize_tty_struct(o_tty);
1347 o_tty->driver = driver->other;
Alan Coxf34d7a52008-04-30 00:54:13 -07001348 o_tty->ops = driver->ops;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001349 o_tty->index = idx;
1350 tty_line_name(driver->other, idx, o_tty->name);
1351
1352 if (driver->flags & TTY_DRIVER_DEVPTS_MEM) {
1353 o_tp_loc = &o_tty->termios;
1354 o_ltp_loc = &o_tty->termios_locked;
1355 } else {
1356 o_tp_loc = &driver->other->termios[idx];
1357 o_ltp_loc = &driver->other->termios_locked[idx];
1358 }
1359
1360 if (!*o_tp_loc) {
Jesper Juhlabcb1ff32007-08-24 02:28:42 +02001361 o_tp = kmalloc(sizeof(struct ktermios), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001362 if (!o_tp)
1363 goto free_mem_out;
1364 *o_tp = driver->other->init_termios;
1365 }
1366
1367 if (!*o_ltp_loc) {
Jean Delvare506eb992007-07-15 23:40:14 -07001368 o_ltp = kzalloc(sizeof(struct ktermios), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001369 if (!o_ltp)
1370 goto free_mem_out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001371 }
1372
1373 /*
1374 * Everything allocated ... set up the o_tty structure.
1375 */
Alan Cox37bdfb02008-02-08 04:18:47 -08001376 if (!(driver->other->flags & TTY_DRIVER_DEVPTS_MEM))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001377 driver->other->ttys[idx] = o_tty;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001378 if (!*o_tp_loc)
1379 *o_tp_loc = o_tp;
1380 if (!*o_ltp_loc)
1381 *o_ltp_loc = o_ltp;
1382 o_tty->termios = *o_tp_loc;
1383 o_tty->termios_locked = *o_ltp_loc;
1384 driver->other->refcount++;
1385 if (driver->subtype == PTY_TYPE_MASTER)
1386 o_tty->count++;
1387
1388 /* Establish the links in both directions */
1389 tty->link = o_tty;
1390 o_tty->link = tty;
1391 }
1392
Alan Cox37bdfb02008-02-08 04:18:47 -08001393 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001394 * All structures have been allocated, so now we install them.
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001395 * Failures after this point use release_tty to clean up, so
Linus Torvalds1da177e2005-04-16 15:20:36 -07001396 * there's no need to null out the local pointers.
1397 */
Alan Cox37bdfb02008-02-08 04:18:47 -08001398 if (!(driver->flags & TTY_DRIVER_DEVPTS_MEM))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001399 driver->ttys[idx] = tty;
Alan Cox37bdfb02008-02-08 04:18:47 -08001400
Linus Torvalds1da177e2005-04-16 15:20:36 -07001401 if (!*tp_loc)
1402 *tp_loc = tp;
1403 if (!*ltp_loc)
1404 *ltp_loc = ltp;
1405 tty->termios = *tp_loc;
1406 tty->termios_locked = *ltp_loc;
Alan Coxedc6afc2006-12-08 02:38:44 -08001407 /* Compatibility until drivers always set this */
1408 tty->termios->c_ispeed = tty_termios_input_baud_rate(tty->termios);
1409 tty->termios->c_ospeed = tty_termios_baud_rate(tty->termios);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001410 driver->refcount++;
1411 tty->count++;
1412
Alan Cox37bdfb02008-02-08 04:18:47 -08001413 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001414 * Structures all installed ... call the ldisc open routines.
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001415 * If we fail here just call release_tty to clean up. No need
1416 * to decrement the use counts, as release_tty doesn't care.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001417 */
1418
Alan Cox01e1abb2008-07-22 11:16:55 +01001419 retval = tty_ldisc_setup(tty, o_tty);
1420
1421 if (retval)
1422 goto release_mem_out;
1423 goto success;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001424
1425 /*
1426 * This fast open can be used if the tty is already open.
1427 * No memory is allocated, and the only failures are from
1428 * attempting to open a closing tty or attempting multiple
1429 * opens on a pty master.
1430 */
1431fast_track:
1432 if (test_bit(TTY_CLOSING, &tty->flags)) {
1433 retval = -EIO;
1434 goto end_init;
1435 }
1436 if (driver->type == TTY_DRIVER_TYPE_PTY &&
1437 driver->subtype == PTY_TYPE_MASTER) {
1438 /*
Alan Cox37bdfb02008-02-08 04:18:47 -08001439 * special case for PTY masters: only one open permitted,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001440 * and the slave side open count is incremented as well.
1441 */
1442 if (tty->count) {
1443 retval = -EIO;
1444 goto end_init;
1445 }
1446 tty->link->count++;
1447 }
1448 tty->count++;
1449 tty->driver = driver; /* N.B. why do this every time?? */
1450
1451 /* FIXME */
Alan Cox37bdfb02008-02-08 04:18:47 -08001452 if (!test_bit(TTY_LDISC, &tty->flags))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001453 printk(KERN_ERR "init_dev but no ldisc\n");
1454success:
1455 *ret_tty = tty;
Alan Cox37bdfb02008-02-08 04:18:47 -08001456
Ingo Molnar70522e12006-03-23 03:00:31 -08001457 /* All paths come through here to release the mutex */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001458end_init:
1459 return retval;
1460
1461 /* Release locally allocated memory ... nothing placed in slots */
1462free_mem_out:
Jesper Juhl735d5662005-11-07 01:01:29 -08001463 kfree(o_tp);
Alan Cox6f967f72008-10-13 10:37:36 +01001464 if (o_tty) {
1465 module_put(o_tty->driver->owner);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001466 free_tty_struct(o_tty);
Alan Cox6f967f72008-10-13 10:37:36 +01001467 }
Jesper Juhl735d5662005-11-07 01:01:29 -08001468 kfree(ltp);
1469 kfree(tp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001470 free_tty_struct(tty);
1471
1472fail_no_mem:
1473 module_put(driver->owner);
1474 retval = -ENOMEM;
1475 goto end_init;
1476
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001477 /* call the tty release_tty routine to clean out this slot */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001478release_mem_out:
Akinobu Mita40509142006-09-29 02:01:27 -07001479 if (printk_ratelimit())
1480 printk(KERN_INFO "init_dev: ldisc open failed, "
1481 "clearing slot %d\n", idx);
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001482 release_tty(tty, idx);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001483 goto end_init;
1484}
1485
Alan Coxaf9b8972006-08-27 01:24:01 -07001486/**
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001487 * release_one_tty - release tty structure memory
Alan Cox9c9f4de2008-10-13 10:37:26 +01001488 * @kref: kref of tty we are obliterating
Alan Coxaf9b8972006-08-27 01:24:01 -07001489 *
1490 * Releases memory associated with a tty structure, and clears out the
1491 * driver table slots. This function is called when a device is no longer
1492 * in use. It also gets called when setup of a device fails.
1493 *
1494 * Locking:
1495 * tty_mutex - sometimes only
1496 * takes the file list lock internally when working on the list
1497 * of ttys that the driver keeps.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001498 */
Alan Cox9c9f4de2008-10-13 10:37:26 +01001499static void release_one_tty(struct kref *kref)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001500{
Alan Cox9c9f4de2008-10-13 10:37:26 +01001501 struct tty_struct *tty = container_of(kref, struct tty_struct, kref);
Alan Cox6f967f72008-10-13 10:37:36 +01001502 struct tty_driver *driver = tty->driver;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001503 int devpts = tty->driver->flags & TTY_DRIVER_DEVPTS_MEM;
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001504 struct ktermios *tp;
Alan Cox9c9f4de2008-10-13 10:37:26 +01001505 int idx = tty->index;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001506
1507 if (!devpts)
1508 tty->driver->ttys[idx] = NULL;
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001509
Linus Torvalds1da177e2005-04-16 15:20:36 -07001510 if (tty->driver->flags & TTY_DRIVER_RESET_TERMIOS) {
Alan Cox9c9f4de2008-10-13 10:37:26 +01001511 /* FIXME: Locking on ->termios array */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001512 tp = tty->termios;
1513 if (!devpts)
1514 tty->driver->termios[idx] = NULL;
1515 kfree(tp);
1516
1517 tp = tty->termios_locked;
1518 if (!devpts)
1519 tty->driver->termios_locked[idx] = NULL;
1520 kfree(tp);
1521 }
1522
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001523
Linus Torvalds1da177e2005-04-16 15:20:36 -07001524 tty->magic = 0;
Alan Cox9c9f4de2008-10-13 10:37:26 +01001525 /* FIXME: locking on tty->driver->refcount */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001526 tty->driver->refcount--;
Alan Cox6f967f72008-10-13 10:37:36 +01001527 module_put(driver->owner);
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001528
Linus Torvalds1da177e2005-04-16 15:20:36 -07001529 file_list_lock();
1530 list_del_init(&tty->tty_files);
1531 file_list_unlock();
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001532
Linus Torvalds1da177e2005-04-16 15:20:36 -07001533 free_tty_struct(tty);
1534}
1535
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001536/**
Alan Cox9c9f4de2008-10-13 10:37:26 +01001537 * tty_kref_put - release a tty kref
1538 * @tty: tty device
1539 *
1540 * Release a reference to a tty device and if need be let the kref
1541 * layer destruct the object for us
1542 */
1543
1544void tty_kref_put(struct tty_struct *tty)
1545{
1546 if (tty)
1547 kref_put(&tty->kref, release_one_tty);
1548}
1549EXPORT_SYMBOL(tty_kref_put);
1550
1551/**
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001552 * release_tty - release tty structure memory
1553 *
1554 * Release both @tty and a possible linked partner (think pty pair),
1555 * and decrement the refcount of the backing module.
1556 *
1557 * Locking:
1558 * tty_mutex - sometimes only
1559 * takes the file list lock internally when working on the list
1560 * of ttys that the driver keeps.
1561 * FIXME: should we require tty_mutex is held here ??
Alan Cox9c9f4de2008-10-13 10:37:26 +01001562 *
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001563 */
1564static void release_tty(struct tty_struct *tty, int idx)
1565{
Alan Cox9c9f4de2008-10-13 10:37:26 +01001566 /* This should always be true but check for the moment */
1567 WARN_ON(tty->index != idx);
1568
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001569 if (tty->link)
Alan Cox9c9f4de2008-10-13 10:37:26 +01001570 tty_kref_put(tty->link);
1571 tty_kref_put(tty);
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001572}
1573
Linus Torvalds1da177e2005-04-16 15:20:36 -07001574/*
1575 * Even releasing the tty structures is a tricky business.. We have
1576 * to be very careful that the structures are all released at the
1577 * same time, as interrupts might otherwise get the wrong pointers.
1578 *
1579 * WSH 09/09/97: rewritten to avoid some nasty race conditions that could
1580 * lead to double frees or releasing memory still in use.
1581 */
Alan Cox37bdfb02008-02-08 04:18:47 -08001582static void release_dev(struct file *filp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001583{
1584 struct tty_struct *tty, *o_tty;
1585 int pty_master, tty_closing, o_tty_closing, do_sleep;
Paul Fulghum14a62832006-04-10 22:54:19 -07001586 int devpts;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001587 int idx;
1588 char buf[64];
Alan Cox37bdfb02008-02-08 04:18:47 -08001589
Linus Torvalds1da177e2005-04-16 15:20:36 -07001590 tty = (struct tty_struct *)filp->private_data;
Alan Cox37bdfb02008-02-08 04:18:47 -08001591 if (tty_paranoia_check(tty, filp->f_path.dentry->d_inode,
1592 "release_dev"))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001593 return;
1594
1595 check_tty_count(tty, "release_dev");
1596
1597 tty_fasync(-1, filp, 0);
1598
1599 idx = tty->index;
1600 pty_master = (tty->driver->type == TTY_DRIVER_TYPE_PTY &&
1601 tty->driver->subtype == PTY_TYPE_MASTER);
1602 devpts = (tty->driver->flags & TTY_DRIVER_DEVPTS_MEM) != 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001603 o_tty = tty->link;
1604
1605#ifdef TTY_PARANOIA_CHECK
1606 if (idx < 0 || idx >= tty->driver->num) {
1607 printk(KERN_DEBUG "release_dev: bad idx when trying to "
1608 "free (%s)\n", tty->name);
1609 return;
1610 }
1611 if (!(tty->driver->flags & TTY_DRIVER_DEVPTS_MEM)) {
1612 if (tty != tty->driver->ttys[idx]) {
1613 printk(KERN_DEBUG "release_dev: driver.table[%d] not tty "
1614 "for (%s)\n", idx, tty->name);
1615 return;
1616 }
1617 if (tty->termios != tty->driver->termios[idx]) {
1618 printk(KERN_DEBUG "release_dev: driver.termios[%d] not termios "
1619 "for (%s)\n",
1620 idx, tty->name);
1621 return;
1622 }
1623 if (tty->termios_locked != tty->driver->termios_locked[idx]) {
1624 printk(KERN_DEBUG "release_dev: driver.termios_locked[%d] not "
1625 "termios_locked for (%s)\n",
1626 idx, tty->name);
1627 return;
1628 }
1629 }
1630#endif
1631
1632#ifdef TTY_DEBUG_HANGUP
1633 printk(KERN_DEBUG "release_dev of %s (tty count=%d)...",
1634 tty_name(tty, buf), tty->count);
1635#endif
1636
1637#ifdef TTY_PARANOIA_CHECK
1638 if (tty->driver->other &&
1639 !(tty->driver->flags & TTY_DRIVER_DEVPTS_MEM)) {
1640 if (o_tty != tty->driver->other->ttys[idx]) {
1641 printk(KERN_DEBUG "release_dev: other->table[%d] "
1642 "not o_tty for (%s)\n",
1643 idx, tty->name);
1644 return;
1645 }
1646 if (o_tty->termios != tty->driver->other->termios[idx]) {
1647 printk(KERN_DEBUG "release_dev: other->termios[%d] "
1648 "not o_termios for (%s)\n",
1649 idx, tty->name);
1650 return;
1651 }
Alan Cox37bdfb02008-02-08 04:18:47 -08001652 if (o_tty->termios_locked !=
Linus Torvalds1da177e2005-04-16 15:20:36 -07001653 tty->driver->other->termios_locked[idx]) {
1654 printk(KERN_DEBUG "release_dev: other->termios_locked["
1655 "%d] not o_termios_locked for (%s)\n",
1656 idx, tty->name);
1657 return;
1658 }
1659 if (o_tty->link != tty) {
1660 printk(KERN_DEBUG "release_dev: bad pty pointers\n");
1661 return;
1662 }
1663 }
1664#endif
Alan Coxf34d7a52008-04-30 00:54:13 -07001665 if (tty->ops->close)
1666 tty->ops->close(tty, filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001667
1668 /*
1669 * Sanity check: if tty->count is going to zero, there shouldn't be
1670 * any waiters on tty->read_wait or tty->write_wait. We test the
1671 * wait queues and kick everyone out _before_ actually starting to
1672 * close. This ensures that we won't block while releasing the tty
1673 * structure.
1674 *
1675 * The test for the o_tty closing is necessary, since the master and
1676 * slave sides may close in any order. If the slave side closes out
1677 * first, its count will be one, since the master side holds an open.
1678 * Thus this test wouldn't be triggered at the time the slave closes,
1679 * so we do it now.
1680 *
1681 * Note that it's possible for the tty to be opened again while we're
1682 * flushing out waiters. By recalculating the closing flags before
1683 * each iteration we avoid any problems.
1684 */
1685 while (1) {
1686 /* Guard against races with tty->count changes elsewhere and
1687 opens on /dev/tty */
Alan Cox37bdfb02008-02-08 04:18:47 -08001688
Ingo Molnar70522e12006-03-23 03:00:31 -08001689 mutex_lock(&tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001690 tty_closing = tty->count <= 1;
1691 o_tty_closing = o_tty &&
1692 (o_tty->count <= (pty_master ? 1 : 0));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001693 do_sleep = 0;
1694
1695 if (tty_closing) {
1696 if (waitqueue_active(&tty->read_wait)) {
1697 wake_up(&tty->read_wait);
1698 do_sleep++;
1699 }
1700 if (waitqueue_active(&tty->write_wait)) {
1701 wake_up(&tty->write_wait);
1702 do_sleep++;
1703 }
1704 }
1705 if (o_tty_closing) {
1706 if (waitqueue_active(&o_tty->read_wait)) {
1707 wake_up(&o_tty->read_wait);
1708 do_sleep++;
1709 }
1710 if (waitqueue_active(&o_tty->write_wait)) {
1711 wake_up(&o_tty->write_wait);
1712 do_sleep++;
1713 }
1714 }
1715 if (!do_sleep)
1716 break;
1717
1718 printk(KERN_WARNING "release_dev: %s: read/write wait queue "
1719 "active!\n", tty_name(tty, buf));
Ingo Molnar70522e12006-03-23 03:00:31 -08001720 mutex_unlock(&tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001721 schedule();
Alan Cox37bdfb02008-02-08 04:18:47 -08001722 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001723
1724 /*
Alan Cox37bdfb02008-02-08 04:18:47 -08001725 * The closing flags are now consistent with the open counts on
1726 * both sides, and we've completed the last operation that could
Linus Torvalds1da177e2005-04-16 15:20:36 -07001727 * block, so it's safe to proceed with closing.
1728 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001729 if (pty_master) {
1730 if (--o_tty->count < 0) {
1731 printk(KERN_WARNING "release_dev: bad pty slave count "
1732 "(%d) for %s\n",
1733 o_tty->count, tty_name(o_tty, buf));
1734 o_tty->count = 0;
1735 }
1736 }
1737 if (--tty->count < 0) {
1738 printk(KERN_WARNING "release_dev: bad tty->count (%d) for %s\n",
1739 tty->count, tty_name(tty, buf));
1740 tty->count = 0;
1741 }
Alan Cox37bdfb02008-02-08 04:18:47 -08001742
Linus Torvalds1da177e2005-04-16 15:20:36 -07001743 /*
1744 * We've decremented tty->count, so we need to remove this file
1745 * descriptor off the tty->tty_files list; this serves two
1746 * purposes:
1747 * - check_tty_count sees the correct number of file descriptors
1748 * associated with this tty.
1749 * - do_tty_hangup no longer sees this file descriptor as
1750 * something that needs to be handled for hangups.
1751 */
1752 file_kill(filp);
1753 filp->private_data = NULL;
1754
1755 /*
1756 * Perform some housekeeping before deciding whether to return.
1757 *
1758 * Set the TTY_CLOSING flag if this was the last open. In the
1759 * case of a pty we may have to wait around for the other side
1760 * to close, and TTY_CLOSING makes sure we can't be reopened.
1761 */
Alan Cox37bdfb02008-02-08 04:18:47 -08001762 if (tty_closing)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001763 set_bit(TTY_CLOSING, &tty->flags);
Alan Cox37bdfb02008-02-08 04:18:47 -08001764 if (o_tty_closing)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001765 set_bit(TTY_CLOSING, &o_tty->flags);
1766
1767 /*
1768 * If _either_ side is closing, make sure there aren't any
1769 * processes that still think tty or o_tty is their controlling
1770 * tty.
1771 */
1772 if (tty_closing || o_tty_closing) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001773 read_lock(&tasklist_lock);
Peter Zijlstra24ec8392006-12-08 02:36:04 -08001774 session_clear_tty(tty->session);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001775 if (o_tty)
Peter Zijlstra24ec8392006-12-08 02:36:04 -08001776 session_clear_tty(o_tty->session);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001777 read_unlock(&tasklist_lock);
1778 }
1779
Ingo Molnar70522e12006-03-23 03:00:31 -08001780 mutex_unlock(&tty_mutex);
Paul Fulghumda965822006-02-14 13:53:00 -08001781
Linus Torvalds1da177e2005-04-16 15:20:36 -07001782 /* check whether both sides are closing ... */
1783 if (!tty_closing || (o_tty && !o_tty_closing))
1784 return;
Alan Cox37bdfb02008-02-08 04:18:47 -08001785
Linus Torvalds1da177e2005-04-16 15:20:36 -07001786#ifdef TTY_DEBUG_HANGUP
1787 printk(KERN_DEBUG "freeing tty structure...");
1788#endif
1789 /*
Alan Cox01e1abb2008-07-22 11:16:55 +01001790 * Ask the line discipline code to release its structures
Linus Torvalds1da177e2005-04-16 15:20:36 -07001791 */
Alan Cox01e1abb2008-07-22 11:16:55 +01001792 tty_ldisc_release(tty, o_tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001793 /*
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001794 * The release_tty function takes care of the details of clearing
Linus Torvalds1da177e2005-04-16 15:20:36 -07001795 * the slots and preserving the termios structure.
1796 */
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001797 release_tty(tty, idx);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001798
Linus Torvalds1da177e2005-04-16 15:20:36 -07001799 /* Make this pty number available for reallocation */
Sukadev Bhattiprolu718a9162008-04-30 00:54:21 -07001800 if (devpts)
1801 devpts_kill_index(idx);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001802}
1803
Alan Coxaf9b8972006-08-27 01:24:01 -07001804/**
1805 * tty_open - open a tty device
1806 * @inode: inode of device file
1807 * @filp: file pointer to tty
Linus Torvalds1da177e2005-04-16 15:20:36 -07001808 *
Alan Coxaf9b8972006-08-27 01:24:01 -07001809 * tty_open and tty_release keep up the tty count that contains the
1810 * number of opens done on a tty. We cannot use the inode-count, as
1811 * different inodes might point to the same tty.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001812 *
Alan Coxaf9b8972006-08-27 01:24:01 -07001813 * Open-counting is needed for pty masters, as well as for keeping
1814 * track of serial lines: DTR is dropped when the last close happens.
1815 * (This is not done solely through tty->count, now. - Ted 1/27/92)
1816 *
1817 * The termios state of a pty is reset on first open so that
1818 * settings don't persist across reuse.
1819 *
Peter Zijlstra24ec8392006-12-08 02:36:04 -08001820 * Locking: tty_mutex protects tty, get_tty_driver and init_dev work.
1821 * tty->count should protect the rest.
1822 * ->siglock protects ->signal/->sighand
Linus Torvalds1da177e2005-04-16 15:20:36 -07001823 */
Alan Coxaf9b8972006-08-27 01:24:01 -07001824
Jonathan Corbet39d95b92008-05-16 09:10:50 -06001825static int __tty_open(struct inode *inode, struct file *filp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001826{
1827 struct tty_struct *tty;
1828 int noctty, retval;
1829 struct tty_driver *driver;
1830 int index;
1831 dev_t device = inode->i_rdev;
1832 unsigned short saved_flags = filp->f_flags;
1833
1834 nonseekable_open(inode, filp);
Alan Cox37bdfb02008-02-08 04:18:47 -08001835
Linus Torvalds1da177e2005-04-16 15:20:36 -07001836retry_open:
1837 noctty = filp->f_flags & O_NOCTTY;
1838 index = -1;
1839 retval = 0;
Alan Cox37bdfb02008-02-08 04:18:47 -08001840
Ingo Molnar70522e12006-03-23 03:00:31 -08001841 mutex_lock(&tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001842
Alan Cox37bdfb02008-02-08 04:18:47 -08001843 if (device == MKDEV(TTYAUX_MAJOR, 0)) {
Peter Zijlstra24ec8392006-12-08 02:36:04 -08001844 tty = get_current_tty();
1845 if (!tty) {
Ingo Molnar70522e12006-03-23 03:00:31 -08001846 mutex_unlock(&tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001847 return -ENXIO;
1848 }
Peter Zijlstra24ec8392006-12-08 02:36:04 -08001849 driver = tty->driver;
1850 index = tty->index;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001851 filp->f_flags |= O_NONBLOCK; /* Don't let /dev/tty block */
1852 /* noctty = 1; */
Alan Cox452a00d2008-10-13 10:39:13 +01001853 /* FIXME: Should we take a driver reference ? */
1854 tty_kref_put(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001855 goto got_driver;
1856 }
1857#ifdef CONFIG_VT
Alan Cox37bdfb02008-02-08 04:18:47 -08001858 if (device == MKDEV(TTY_MAJOR, 0)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001859 extern struct tty_driver *console_driver;
1860 driver = console_driver;
1861 index = fg_console;
1862 noctty = 1;
1863 goto got_driver;
1864 }
1865#endif
Alan Cox37bdfb02008-02-08 04:18:47 -08001866 if (device == MKDEV(TTYAUX_MAJOR, 1)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001867 driver = console_device(&index);
1868 if (driver) {
1869 /* Don't let /dev/console block */
1870 filp->f_flags |= O_NONBLOCK;
1871 noctty = 1;
1872 goto got_driver;
1873 }
Ingo Molnar70522e12006-03-23 03:00:31 -08001874 mutex_unlock(&tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001875 return -ENODEV;
1876 }
1877
1878 driver = get_tty_driver(device, &index);
1879 if (!driver) {
Ingo Molnar70522e12006-03-23 03:00:31 -08001880 mutex_unlock(&tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001881 return -ENODEV;
1882 }
1883got_driver:
1884 retval = init_dev(driver, index, &tty);
Ingo Molnar70522e12006-03-23 03:00:31 -08001885 mutex_unlock(&tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001886 if (retval)
1887 return retval;
1888
1889 filp->private_data = tty;
1890 file_move(filp, &tty->tty_files);
1891 check_tty_count(tty, "tty_open");
1892 if (tty->driver->type == TTY_DRIVER_TYPE_PTY &&
1893 tty->driver->subtype == PTY_TYPE_MASTER)
1894 noctty = 1;
1895#ifdef TTY_DEBUG_HANGUP
1896 printk(KERN_DEBUG "opening %s...", tty->name);
1897#endif
1898 if (!retval) {
Alan Coxf34d7a52008-04-30 00:54:13 -07001899 if (tty->ops->open)
1900 retval = tty->ops->open(tty, filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001901 else
1902 retval = -ENODEV;
1903 }
1904 filp->f_flags = saved_flags;
1905
Alan Cox37bdfb02008-02-08 04:18:47 -08001906 if (!retval && test_bit(TTY_EXCLUSIVE, &tty->flags) &&
1907 !capable(CAP_SYS_ADMIN))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001908 retval = -EBUSY;
1909
1910 if (retval) {
1911#ifdef TTY_DEBUG_HANGUP
1912 printk(KERN_DEBUG "error %d in opening %s...", retval,
1913 tty->name);
1914#endif
1915 release_dev(filp);
1916 if (retval != -ERESTARTSYS)
1917 return retval;
1918 if (signal_pending(current))
1919 return retval;
1920 schedule();
1921 /*
1922 * Need to reset f_op in case a hangup happened.
1923 */
1924 if (filp->f_op == &hung_up_tty_fops)
1925 filp->f_op = &tty_fops;
1926 goto retry_open;
1927 }
Peter Zijlstra24ec8392006-12-08 02:36:04 -08001928
1929 mutex_lock(&tty_mutex);
1930 spin_lock_irq(&current->sighand->siglock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001931 if (!noctty &&
1932 current->signal->leader &&
1933 !current->signal->tty &&
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08001934 tty->session == NULL)
Eric W. Biederman2a65f1d2007-05-08 00:26:53 -07001935 __proc_set_tty(current, tty);
Peter Zijlstra24ec8392006-12-08 02:36:04 -08001936 spin_unlock_irq(&current->sighand->siglock);
1937 mutex_unlock(&tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001938 return 0;
1939}
1940
Jonathan Corbet39d95b92008-05-16 09:10:50 -06001941/* BKL pushdown: scary code avoidance wrapper */
1942static int tty_open(struct inode *inode, struct file *filp)
1943{
1944 int ret;
1945
1946 lock_kernel();
1947 ret = __tty_open(inode, filp);
1948 unlock_kernel();
1949 return ret;
1950}
1951
1952
1953
Linus Torvalds1da177e2005-04-16 15:20:36 -07001954#ifdef CONFIG_UNIX98_PTYS
Alan Coxaf9b8972006-08-27 01:24:01 -07001955/**
1956 * ptmx_open - open a unix 98 pty master
1957 * @inode: inode of device file
1958 * @filp: file pointer to tty
1959 *
1960 * Allocate a unix98 pty master device from the ptmx driver.
1961 *
1962 * Locking: tty_mutex protects theinit_dev work. tty->count should
Alan Cox37bdfb02008-02-08 04:18:47 -08001963 * protect the rest.
Alan Coxaf9b8972006-08-27 01:24:01 -07001964 * allocated_ptys_lock handles the list of free pty numbers
1965 */
1966
Jonathan Corbet39d95b92008-05-16 09:10:50 -06001967static int __ptmx_open(struct inode *inode, struct file *filp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001968{
1969 struct tty_struct *tty;
1970 int retval;
1971 int index;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001972
1973 nonseekable_open(inode, filp);
1974
1975 /* find a device that is not in use. */
Sukadev Bhattiprolu718a9162008-04-30 00:54:21 -07001976 index = devpts_new_index();
1977 if (index < 0)
1978 return index;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001979
Ingo Molnar70522e12006-03-23 03:00:31 -08001980 mutex_lock(&tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001981 retval = init_dev(ptm_driver, index, &tty);
Ingo Molnar70522e12006-03-23 03:00:31 -08001982 mutex_unlock(&tty_mutex);
Alan Cox37bdfb02008-02-08 04:18:47 -08001983
Linus Torvalds1da177e2005-04-16 15:20:36 -07001984 if (retval)
1985 goto out;
1986
1987 set_bit(TTY_PTY_LOCK, &tty->flags); /* LOCK THE SLAVE */
1988 filp->private_data = tty;
1989 file_move(filp, &tty->tty_files);
1990
Sukadev Bhattiprolu4f8f9d62008-04-30 00:54:20 -07001991 retval = devpts_pty_new(tty->link);
1992 if (retval)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001993 goto out1;
1994
Hiroshi Shimamoto86a96532008-04-30 00:54:20 -07001995 check_tty_count(tty, "ptmx_open");
Alan Coxf34d7a52008-04-30 00:54:13 -07001996 retval = ptm_driver->ops->open(tty, filp);
Miloslav Trmac41126222008-04-18 13:30:14 -07001997 if (!retval)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001998 return 0;
1999out1:
2000 release_dev(filp);
Paul Fulghum9453a5a2006-04-10 22:54:18 -07002001 return retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002002out:
Sukadev Bhattiprolu718a9162008-04-30 00:54:21 -07002003 devpts_kill_index(index);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002004 return retval;
2005}
Jonathan Corbet39d95b92008-05-16 09:10:50 -06002006
2007static int ptmx_open(struct inode *inode, struct file *filp)
2008{
2009 int ret;
2010
2011 lock_kernel();
2012 ret = __ptmx_open(inode, filp);
2013 unlock_kernel();
2014 return ret;
2015}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002016#endif
2017
Alan Coxaf9b8972006-08-27 01:24:01 -07002018/**
2019 * tty_release - vfs callback for close
2020 * @inode: inode of tty
2021 * @filp: file pointer for handle to tty
2022 *
2023 * Called the last time each file handle is closed that references
2024 * this tty. There may however be several such references.
2025 *
2026 * Locking:
2027 * Takes bkl. See release_dev
2028 */
2029
Alan Cox37bdfb02008-02-08 04:18:47 -08002030static int tty_release(struct inode *inode, struct file *filp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002031{
2032 lock_kernel();
2033 release_dev(filp);
2034 unlock_kernel();
2035 return 0;
2036}
2037
Alan Coxaf9b8972006-08-27 01:24:01 -07002038/**
2039 * tty_poll - check tty status
2040 * @filp: file being polled
2041 * @wait: poll wait structures to update
2042 *
2043 * Call the line discipline polling method to obtain the poll
2044 * status of the device.
2045 *
2046 * Locking: locks called line discipline but ldisc poll method
2047 * may be re-entered freely by other callers.
2048 */
2049
Alan Cox37bdfb02008-02-08 04:18:47 -08002050static unsigned int tty_poll(struct file *filp, poll_table *wait)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002051{
Alan Cox37bdfb02008-02-08 04:18:47 -08002052 struct tty_struct *tty;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002053 struct tty_ldisc *ld;
2054 int ret = 0;
2055
2056 tty = (struct tty_struct *)filp->private_data;
Josef Sipeka7113a92006-12-08 02:36:55 -08002057 if (tty_paranoia_check(tty, filp->f_path.dentry->d_inode, "tty_poll"))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002058 return 0;
Alan Cox37bdfb02008-02-08 04:18:47 -08002059
Linus Torvalds1da177e2005-04-16 15:20:36 -07002060 ld = tty_ldisc_ref_wait(tty);
Alan Coxa352def2008-07-16 21:53:12 +01002061 if (ld->ops->poll)
2062 ret = (ld->ops->poll)(tty, filp, wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002063 tty_ldisc_deref(ld);
2064 return ret;
2065}
2066
Alan Cox37bdfb02008-02-08 04:18:47 -08002067static int tty_fasync(int fd, struct file *filp, int on)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002068{
Alan Cox37bdfb02008-02-08 04:18:47 -08002069 struct tty_struct *tty;
Alan Cox47f86832008-04-30 00:53:30 -07002070 unsigned long flags;
Jonathan Corbet5d1e3232008-06-19 16:04:53 -06002071 int retval = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002072
Jonathan Corbet5d1e3232008-06-19 16:04:53 -06002073 lock_kernel();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002074 tty = (struct tty_struct *)filp->private_data;
Josef Sipeka7113a92006-12-08 02:36:55 -08002075 if (tty_paranoia_check(tty, filp->f_path.dentry->d_inode, "tty_fasync"))
Jonathan Corbet5d1e3232008-06-19 16:04:53 -06002076 goto out;
Alan Cox37bdfb02008-02-08 04:18:47 -08002077
Linus Torvalds1da177e2005-04-16 15:20:36 -07002078 retval = fasync_helper(fd, filp, on, &tty->fasync);
2079 if (retval <= 0)
Jonathan Corbet5d1e3232008-06-19 16:04:53 -06002080 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002081
2082 if (on) {
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08002083 enum pid_type type;
2084 struct pid *pid;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002085 if (!waitqueue_active(&tty->read_wait))
2086 tty->minimum_to_wake = 1;
Alan Cox47f86832008-04-30 00:53:30 -07002087 spin_lock_irqsave(&tty->ctrl_lock, flags);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08002088 if (tty->pgrp) {
2089 pid = tty->pgrp;
2090 type = PIDTYPE_PGID;
2091 } else {
2092 pid = task_pid(current);
2093 type = PIDTYPE_PID;
2094 }
Alan Cox47f86832008-04-30 00:53:30 -07002095 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08002096 retval = __f_setown(filp, pid, type, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002097 if (retval)
Jonathan Corbet5d1e3232008-06-19 16:04:53 -06002098 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002099 } else {
2100 if (!tty->fasync && !waitqueue_active(&tty->read_wait))
2101 tty->minimum_to_wake = N_TTY_BUF_SIZE;
2102 }
Jonathan Corbet5d1e3232008-06-19 16:04:53 -06002103 retval = 0;
2104out:
2105 unlock_kernel();
2106 return retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002107}
2108
Alan Coxaf9b8972006-08-27 01:24:01 -07002109/**
2110 * tiocsti - fake input character
2111 * @tty: tty to fake input into
2112 * @p: pointer to character
2113 *
Robert P. J. Day3a4fa0a2007-10-19 23:10:43 +02002114 * Fake input to a tty device. Does the necessary locking and
Alan Coxaf9b8972006-08-27 01:24:01 -07002115 * input management.
2116 *
2117 * FIXME: does not honour flow control ??
2118 *
2119 * Locking:
2120 * Called functions take tty_ldisc_lock
2121 * current->signal->tty check is safe without locks
Alan Cox28298232006-09-29 02:00:58 -07002122 *
2123 * FIXME: may race normal receive processing
Alan Coxaf9b8972006-08-27 01:24:01 -07002124 */
2125
Linus Torvalds1da177e2005-04-16 15:20:36 -07002126static int tiocsti(struct tty_struct *tty, char __user *p)
2127{
2128 char ch, mbz = 0;
2129 struct tty_ldisc *ld;
Alan Cox37bdfb02008-02-08 04:18:47 -08002130
Linus Torvalds1da177e2005-04-16 15:20:36 -07002131 if ((current->signal->tty != tty) && !capable(CAP_SYS_ADMIN))
2132 return -EPERM;
2133 if (get_user(ch, p))
2134 return -EFAULT;
2135 ld = tty_ldisc_ref_wait(tty);
Alan Coxa352def2008-07-16 21:53:12 +01002136 ld->ops->receive_buf(tty, &ch, &mbz, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002137 tty_ldisc_deref(ld);
2138 return 0;
2139}
2140
Alan Coxaf9b8972006-08-27 01:24:01 -07002141/**
2142 * tiocgwinsz - implement window query ioctl
2143 * @tty; tty
2144 * @arg: user buffer for result
2145 *
Alan Cox808a0d32006-09-29 02:00:40 -07002146 * Copies the kernel idea of the window size into the user buffer.
Alan Coxaf9b8972006-08-27 01:24:01 -07002147 *
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002148 * Locking: tty->termios_mutex is taken to ensure the winsize data
Alan Cox808a0d32006-09-29 02:00:40 -07002149 * is consistent.
Alan Coxaf9b8972006-08-27 01:24:01 -07002150 */
2151
Alan Cox37bdfb02008-02-08 04:18:47 -08002152static int tiocgwinsz(struct tty_struct *tty, struct winsize __user *arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002153{
Alan Cox808a0d32006-09-29 02:00:40 -07002154 int err;
2155
Arjan van de Ven5785c952006-09-29 02:00:43 -07002156 mutex_lock(&tty->termios_mutex);
Alan Cox808a0d32006-09-29 02:00:40 -07002157 err = copy_to_user(arg, &tty->winsize, sizeof(*arg));
Arjan van de Ven5785c952006-09-29 02:00:43 -07002158 mutex_unlock(&tty->termios_mutex);
Alan Cox808a0d32006-09-29 02:00:40 -07002159
2160 return err ? -EFAULT: 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002161}
2162
Alan Coxaf9b8972006-08-27 01:24:01 -07002163/**
Alan Cox8c9a9dd2008-08-15 10:39:38 +01002164 * tty_do_resize - resize event
2165 * @tty: tty being resized
Alan Coxa152db72008-08-26 19:55:58 +01002166 * @real_tty: real tty (not the same as tty if using a pty/tty pair)
Alan Cox8c9a9dd2008-08-15 10:39:38 +01002167 * @rows: rows (character)
2168 * @cols: cols (character)
Alan Coxaf9b8972006-08-27 01:24:01 -07002169 *
Alan Cox8c9a9dd2008-08-15 10:39:38 +01002170 * Update the termios variables and send the neccessary signals to
2171 * peform a terminal resize correctly
Alan Coxaf9b8972006-08-27 01:24:01 -07002172 */
2173
Alan Cox8c9a9dd2008-08-15 10:39:38 +01002174int tty_do_resize(struct tty_struct *tty, struct tty_struct *real_tty,
2175 struct winsize *ws)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002176{
Alan Cox47f86832008-04-30 00:53:30 -07002177 struct pid *pgrp, *rpgrp;
2178 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002179
Alan Coxa152db72008-08-26 19:55:58 +01002180 /* For a PTY we need to lock the tty side */
2181 mutex_lock(&real_tty->termios_mutex);
Alan Coxf4d2a6c2008-10-13 10:39:01 +01002182 if (!memcmp(ws, &real_tty->winsize, sizeof(*ws)))
Alan Coxca9bda02006-09-29 02:00:03 -07002183 goto done;
Alan Cox47f86832008-04-30 00:53:30 -07002184 /* Get the PID values and reference them so we can
2185 avoid holding the tty ctrl lock while sending signals */
2186 spin_lock_irqsave(&tty->ctrl_lock, flags);
2187 pgrp = get_pid(tty->pgrp);
2188 rpgrp = get_pid(real_tty->pgrp);
2189 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
2190
2191 if (pgrp)
2192 kill_pgrp(pgrp, SIGWINCH, 1);
2193 if (rpgrp != pgrp && rpgrp)
2194 kill_pgrp(rpgrp, SIGWINCH, 1);
2195
2196 put_pid(pgrp);
2197 put_pid(rpgrp);
2198
Alan Cox8c9a9dd2008-08-15 10:39:38 +01002199 tty->winsize = *ws;
2200 real_tty->winsize = *ws;
Alan Coxca9bda02006-09-29 02:00:03 -07002201done:
Alan Coxa152db72008-08-26 19:55:58 +01002202 mutex_unlock(&real_tty->termios_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002203 return 0;
2204}
2205
Alan Coxaf9b8972006-08-27 01:24:01 -07002206/**
Alan Cox8c9a9dd2008-08-15 10:39:38 +01002207 * tiocswinsz - implement window size set ioctl
2208 * @tty; tty
2209 * @arg: user buffer for result
2210 *
2211 * Copies the user idea of the window size to the kernel. Traditionally
2212 * this is just advisory information but for the Linux console it
2213 * actually has driver level meaning and triggers a VC resize.
2214 *
2215 * Locking:
2216 * Driver dependant. The default do_resize method takes the
2217 * tty termios mutex and ctrl_lock. The console takes its own lock
2218 * then calls into the default method.
2219 */
2220
2221static int tiocswinsz(struct tty_struct *tty, struct tty_struct *real_tty,
2222 struct winsize __user *arg)
2223{
2224 struct winsize tmp_ws;
2225 if (copy_from_user(&tmp_ws, arg, sizeof(*arg)))
2226 return -EFAULT;
2227
2228 if (tty->ops->resize)
2229 return tty->ops->resize(tty, real_tty, &tmp_ws);
2230 else
2231 return tty_do_resize(tty, real_tty, &tmp_ws);
2232}
2233
2234/**
Alan Coxaf9b8972006-08-27 01:24:01 -07002235 * tioccons - allow admin to move logical console
2236 * @file: the file to become console
2237 *
2238 * Allow the adminstrator to move the redirected console device
2239 *
2240 * Locking: uses redirect_lock to guard the redirect information
2241 */
2242
Linus Torvalds1da177e2005-04-16 15:20:36 -07002243static int tioccons(struct file *file)
2244{
2245 if (!capable(CAP_SYS_ADMIN))
2246 return -EPERM;
2247 if (file->f_op->write == redirected_tty_write) {
2248 struct file *f;
2249 spin_lock(&redirect_lock);
2250 f = redirect;
2251 redirect = NULL;
2252 spin_unlock(&redirect_lock);
2253 if (f)
2254 fput(f);
2255 return 0;
2256 }
2257 spin_lock(&redirect_lock);
2258 if (redirect) {
2259 spin_unlock(&redirect_lock);
2260 return -EBUSY;
2261 }
2262 get_file(file);
2263 redirect = file;
2264 spin_unlock(&redirect_lock);
2265 return 0;
2266}
2267
Alan Coxaf9b8972006-08-27 01:24:01 -07002268/**
2269 * fionbio - non blocking ioctl
2270 * @file: file to set blocking value
2271 * @p: user parameter
2272 *
2273 * Historical tty interfaces had a blocking control ioctl before
2274 * the generic functionality existed. This piece of history is preserved
2275 * in the expected tty API of posix OS's.
2276 *
2277 * Locking: none, the open fle handle ensures it won't go away.
2278 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002279
2280static int fionbio(struct file *file, int __user *p)
2281{
2282 int nonblock;
2283
2284 if (get_user(nonblock, p))
2285 return -EFAULT;
2286
Alan Cox04f378b2008-04-30 00:53:29 -07002287 /* file->f_flags is still BKL protected in the fs layer - vomit */
2288 lock_kernel();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002289 if (nonblock)
2290 file->f_flags |= O_NONBLOCK;
2291 else
2292 file->f_flags &= ~O_NONBLOCK;
Alan Cox04f378b2008-04-30 00:53:29 -07002293 unlock_kernel();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002294 return 0;
2295}
2296
Alan Coxaf9b8972006-08-27 01:24:01 -07002297/**
2298 * tiocsctty - set controlling tty
2299 * @tty: tty structure
2300 * @arg: user argument
2301 *
2302 * This ioctl is used to manage job control. It permits a session
2303 * leader to set this tty as the controlling tty for the session.
2304 *
2305 * Locking:
Alan Cox28298232006-09-29 02:00:58 -07002306 * Takes tty_mutex() to protect tty instance
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002307 * Takes tasklist_lock internally to walk sessions
2308 * Takes ->siglock() when updating signal->tty
Alan Coxaf9b8972006-08-27 01:24:01 -07002309 */
2310
Linus Torvalds1da177e2005-04-16 15:20:36 -07002311static int tiocsctty(struct tty_struct *tty, int arg)
2312{
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002313 int ret = 0;
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08002314 if (current->signal->leader && (task_session(current) == tty->session))
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002315 return ret;
2316
2317 mutex_lock(&tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002318 /*
2319 * The process must be a session leader and
2320 * not have a controlling tty already.
2321 */
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002322 if (!current->signal->leader || current->signal->tty) {
2323 ret = -EPERM;
2324 goto unlock;
2325 }
2326
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08002327 if (tty->session) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002328 /*
2329 * This tty is already the controlling
2330 * tty for another session group!
2331 */
Alan Cox37bdfb02008-02-08 04:18:47 -08002332 if (arg == 1 && capable(CAP_SYS_ADMIN)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002333 /*
2334 * Steal it away
2335 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002336 read_lock(&tasklist_lock);
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002337 session_clear_tty(tty->session);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002338 read_unlock(&tasklist_lock);
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002339 } else {
2340 ret = -EPERM;
2341 goto unlock;
2342 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002343 }
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002344 proc_set_tty(current, tty);
2345unlock:
Alan Cox28298232006-09-29 02:00:58 -07002346 mutex_unlock(&tty_mutex);
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002347 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002348}
2349
Alan Coxaf9b8972006-08-27 01:24:01 -07002350/**
Alan Cox5d0fdf12008-04-30 00:53:31 -07002351 * tty_get_pgrp - return a ref counted pgrp pid
2352 * @tty: tty to read
2353 *
2354 * Returns a refcounted instance of the pid struct for the process
2355 * group controlling the tty.
2356 */
2357
2358struct pid *tty_get_pgrp(struct tty_struct *tty)
2359{
2360 unsigned long flags;
2361 struct pid *pgrp;
2362
2363 spin_lock_irqsave(&tty->ctrl_lock, flags);
2364 pgrp = get_pid(tty->pgrp);
2365 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
2366
2367 return pgrp;
2368}
2369EXPORT_SYMBOL_GPL(tty_get_pgrp);
2370
2371/**
Alan Coxaf9b8972006-08-27 01:24:01 -07002372 * tiocgpgrp - get process group
2373 * @tty: tty passed by user
2374 * @real_tty: tty side of the tty pased by the user if a pty else the tty
2375 * @p: returned pid
2376 *
2377 * Obtain the process group of the tty. If there is no process group
2378 * return an error.
2379 *
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002380 * Locking: none. Reference to current->signal->tty is safe.
Alan Coxaf9b8972006-08-27 01:24:01 -07002381 */
2382
Linus Torvalds1da177e2005-04-16 15:20:36 -07002383static int tiocgpgrp(struct tty_struct *tty, struct tty_struct *real_tty, pid_t __user *p)
2384{
Alan Cox5d0fdf12008-04-30 00:53:31 -07002385 struct pid *pid;
2386 int ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002387 /*
2388 * (tty == real_tty) is a cheap way of
2389 * testing if the tty is NOT a master pty.
2390 */
2391 if (tty == real_tty && current->signal->tty != real_tty)
2392 return -ENOTTY;
Alan Cox5d0fdf12008-04-30 00:53:31 -07002393 pid = tty_get_pgrp(real_tty);
2394 ret = put_user(pid_vnr(pid), p);
2395 put_pid(pid);
2396 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002397}
2398
Alan Coxaf9b8972006-08-27 01:24:01 -07002399/**
2400 * tiocspgrp - attempt to set process group
2401 * @tty: tty passed by user
2402 * @real_tty: tty side device matching tty passed by user
2403 * @p: pid pointer
2404 *
2405 * Set the process group of the tty to the session passed. Only
2406 * permitted where the tty session is our session.
2407 *
Alan Cox47f86832008-04-30 00:53:30 -07002408 * Locking: RCU, ctrl lock
Alan Coxaf9b8972006-08-27 01:24:01 -07002409 */
2410
Linus Torvalds1da177e2005-04-16 15:20:36 -07002411static int tiocspgrp(struct tty_struct *tty, struct tty_struct *real_tty, pid_t __user *p)
2412{
Eric W. Biederman04a2e6a2007-02-12 00:52:56 -08002413 struct pid *pgrp;
2414 pid_t pgrp_nr;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002415 int retval = tty_check_change(real_tty);
Alan Cox47f86832008-04-30 00:53:30 -07002416 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002417
2418 if (retval == -EIO)
2419 return -ENOTTY;
2420 if (retval)
2421 return retval;
2422 if (!current->signal->tty ||
2423 (current->signal->tty != real_tty) ||
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08002424 (real_tty->session != task_session(current)))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002425 return -ENOTTY;
Eric W. Biederman04a2e6a2007-02-12 00:52:56 -08002426 if (get_user(pgrp_nr, p))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002427 return -EFAULT;
Eric W. Biederman04a2e6a2007-02-12 00:52:56 -08002428 if (pgrp_nr < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002429 return -EINVAL;
Eric W. Biederman04a2e6a2007-02-12 00:52:56 -08002430 rcu_read_lock();
Pavel Emelyanovb4888932007-10-18 23:40:14 -07002431 pgrp = find_vpid(pgrp_nr);
Eric W. Biederman04a2e6a2007-02-12 00:52:56 -08002432 retval = -ESRCH;
2433 if (!pgrp)
2434 goto out_unlock;
2435 retval = -EPERM;
2436 if (session_of_pgrp(pgrp) != task_session(current))
2437 goto out_unlock;
2438 retval = 0;
Alan Cox47f86832008-04-30 00:53:30 -07002439 spin_lock_irqsave(&tty->ctrl_lock, flags);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08002440 put_pid(real_tty->pgrp);
2441 real_tty->pgrp = get_pid(pgrp);
Alan Cox47f86832008-04-30 00:53:30 -07002442 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
Eric W. Biederman04a2e6a2007-02-12 00:52:56 -08002443out_unlock:
2444 rcu_read_unlock();
2445 return retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002446}
2447
Alan Coxaf9b8972006-08-27 01:24:01 -07002448/**
2449 * tiocgsid - get session id
2450 * @tty: tty passed by user
2451 * @real_tty: tty side of the tty pased by the user if a pty else the tty
2452 * @p: pointer to returned session id
2453 *
2454 * Obtain the session id of the tty. If there is no session
2455 * return an error.
2456 *
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002457 * Locking: none. Reference to current->signal->tty is safe.
Alan Coxaf9b8972006-08-27 01:24:01 -07002458 */
2459
Linus Torvalds1da177e2005-04-16 15:20:36 -07002460static int tiocgsid(struct tty_struct *tty, struct tty_struct *real_tty, pid_t __user *p)
2461{
2462 /*
2463 * (tty == real_tty) is a cheap way of
2464 * testing if the tty is NOT a master pty.
2465 */
2466 if (tty == real_tty && current->signal->tty != real_tty)
2467 return -ENOTTY;
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08002468 if (!real_tty->session)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002469 return -ENOTTY;
Pavel Emelyanovb4888932007-10-18 23:40:14 -07002470 return put_user(pid_vnr(real_tty->session), p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002471}
2472
Alan Coxaf9b8972006-08-27 01:24:01 -07002473/**
2474 * tiocsetd - set line discipline
2475 * @tty: tty device
2476 * @p: pointer to user data
2477 *
2478 * Set the line discipline according to user request.
2479 *
2480 * Locking: see tty_set_ldisc, this function is just a helper
2481 */
2482
Linus Torvalds1da177e2005-04-16 15:20:36 -07002483static int tiocsetd(struct tty_struct *tty, int __user *p)
2484{
2485 int ldisc;
Alan Cox04f378b2008-04-30 00:53:29 -07002486 int ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002487
2488 if (get_user(ldisc, p))
2489 return -EFAULT;
Alan Cox04f378b2008-04-30 00:53:29 -07002490
2491 lock_kernel();
2492 ret = tty_set_ldisc(tty, ldisc);
2493 unlock_kernel();
2494
2495 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002496}
2497
Alan Coxaf9b8972006-08-27 01:24:01 -07002498/**
2499 * send_break - performed time break
2500 * @tty: device to break on
2501 * @duration: timeout in mS
2502 *
2503 * Perform a timed break on hardware that lacks its own driver level
2504 * timed break functionality.
2505 *
2506 * Locking:
Alan Cox28298232006-09-29 02:00:58 -07002507 * atomic_write_lock serializes
Alan Coxaf9b8972006-08-27 01:24:01 -07002508 *
Alan Coxaf9b8972006-08-27 01:24:01 -07002509 */
2510
Domen Puncerb20f3ae2005-06-25 14:58:42 -07002511static int send_break(struct tty_struct *tty, unsigned int duration)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002512{
Alan Cox9e989662008-07-22 11:18:03 +01002513 int retval;
2514
2515 if (tty->ops->break_ctl == NULL)
2516 return 0;
2517
2518 if (tty->driver->flags & TTY_DRIVER_HARDWARE_BREAK)
2519 retval = tty->ops->break_ctl(tty, duration);
2520 else {
2521 /* Do the work ourselves */
2522 if (tty_write_lock(tty, 0) < 0)
2523 return -EINTR;
2524 retval = tty->ops->break_ctl(tty, -1);
2525 if (retval)
2526 goto out;
2527 if (!signal_pending(current))
2528 msleep_interruptible(duration);
2529 retval = tty->ops->break_ctl(tty, 0);
2530out:
2531 tty_write_unlock(tty);
2532 if (signal_pending(current))
2533 retval = -EINTR;
2534 }
2535 return retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002536}
2537
Alan Coxaf9b8972006-08-27 01:24:01 -07002538/**
Alan Coxf34d7a52008-04-30 00:54:13 -07002539 * tty_tiocmget - get modem status
Alan Coxaf9b8972006-08-27 01:24:01 -07002540 * @tty: tty device
2541 * @file: user file pointer
2542 * @p: pointer to result
2543 *
2544 * Obtain the modem status bits from the tty driver if the feature
2545 * is supported. Return -EINVAL if it is not available.
2546 *
2547 * Locking: none (up to the driver)
2548 */
2549
2550static int tty_tiocmget(struct tty_struct *tty, struct file *file, int __user *p)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002551{
2552 int retval = -EINVAL;
2553
Alan Coxf34d7a52008-04-30 00:54:13 -07002554 if (tty->ops->tiocmget) {
2555 retval = tty->ops->tiocmget(tty, file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002556
2557 if (retval >= 0)
2558 retval = put_user(retval, p);
2559 }
2560 return retval;
2561}
2562
Alan Coxaf9b8972006-08-27 01:24:01 -07002563/**
Alan Coxf34d7a52008-04-30 00:54:13 -07002564 * tty_tiocmset - set modem status
Alan Coxaf9b8972006-08-27 01:24:01 -07002565 * @tty: tty device
2566 * @file: user file pointer
2567 * @cmd: command - clear bits, set bits or set all
2568 * @p: pointer to desired bits
2569 *
2570 * Set the modem status bits from the tty driver if the feature
2571 * is supported. Return -EINVAL if it is not available.
2572 *
2573 * Locking: none (up to the driver)
2574 */
2575
2576static int tty_tiocmset(struct tty_struct *tty, struct file *file, unsigned int cmd,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002577 unsigned __user *p)
2578{
Alan Coxae677512008-07-16 21:56:54 +01002579 int retval;
2580 unsigned int set, clear, val;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002581
Alan Coxae677512008-07-16 21:56:54 +01002582 if (tty->ops->tiocmset == NULL)
2583 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002584
Alan Coxae677512008-07-16 21:56:54 +01002585 retval = get_user(val, p);
2586 if (retval)
2587 return retval;
2588 set = clear = 0;
2589 switch (cmd) {
2590 case TIOCMBIS:
2591 set = val;
2592 break;
2593 case TIOCMBIC:
2594 clear = val;
2595 break;
2596 case TIOCMSET:
2597 set = val;
2598 clear = ~val;
2599 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002600 }
Alan Coxae677512008-07-16 21:56:54 +01002601 set &= TIOCM_DTR|TIOCM_RTS|TIOCM_OUT1|TIOCM_OUT2|TIOCM_LOOP;
2602 clear &= TIOCM_DTR|TIOCM_RTS|TIOCM_OUT1|TIOCM_OUT2|TIOCM_LOOP;
2603 return tty->ops->tiocmset(tty, file, set, clear);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002604}
2605
2606/*
2607 * Split this up, as gcc can choke on it otherwise..
2608 */
Alan Cox04f378b2008-04-30 00:53:29 -07002609long tty_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002610{
2611 struct tty_struct *tty, *real_tty;
2612 void __user *p = (void __user *)arg;
2613 int retval;
2614 struct tty_ldisc *ld;
Alan Cox04f378b2008-04-30 00:53:29 -07002615 struct inode *inode = file->f_dentry->d_inode;
Alan Cox37bdfb02008-02-08 04:18:47 -08002616
Linus Torvalds1da177e2005-04-16 15:20:36 -07002617 tty = (struct tty_struct *)file->private_data;
2618 if (tty_paranoia_check(tty, inode, "tty_ioctl"))
2619 return -EINVAL;
2620
2621 real_tty = tty;
2622 if (tty->driver->type == TTY_DRIVER_TYPE_PTY &&
2623 tty->driver->subtype == PTY_TYPE_MASTER)
2624 real_tty = tty->link;
2625
Linus Torvalds1da177e2005-04-16 15:20:36 -07002626
2627 /*
2628 * Factor out some common prep work
2629 */
2630 switch (cmd) {
2631 case TIOCSETD:
2632 case TIOCSBRK:
2633 case TIOCCBRK:
2634 case TCSBRK:
Alan Cox37bdfb02008-02-08 04:18:47 -08002635 case TCSBRKP:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002636 retval = tty_check_change(tty);
2637 if (retval)
2638 return retval;
2639 if (cmd != TIOCCBRK) {
2640 tty_wait_until_sent(tty, 0);
2641 if (signal_pending(current))
2642 return -EINTR;
2643 }
2644 break;
2645 }
2646
Alan Cox9e989662008-07-22 11:18:03 +01002647 /*
2648 * Now do the stuff.
2649 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002650 switch (cmd) {
Alan Cox37bdfb02008-02-08 04:18:47 -08002651 case TIOCSTI:
2652 return tiocsti(tty, p);
2653 case TIOCGWINSZ:
Alan Cox8f520022008-10-13 10:38:46 +01002654 return tiocgwinsz(real_tty, p);
Alan Cox37bdfb02008-02-08 04:18:47 -08002655 case TIOCSWINSZ:
2656 return tiocswinsz(tty, real_tty, p);
2657 case TIOCCONS:
2658 return real_tty != tty ? -EINVAL : tioccons(file);
2659 case FIONBIO:
2660 return fionbio(file, p);
2661 case TIOCEXCL:
2662 set_bit(TTY_EXCLUSIVE, &tty->flags);
2663 return 0;
2664 case TIOCNXCL:
2665 clear_bit(TTY_EXCLUSIVE, &tty->flags);
2666 return 0;
2667 case TIOCNOTTY:
2668 if (current->signal->tty != tty)
2669 return -ENOTTY;
2670 no_tty();
2671 return 0;
2672 case TIOCSCTTY:
2673 return tiocsctty(tty, arg);
2674 case TIOCGPGRP:
2675 return tiocgpgrp(tty, real_tty, p);
2676 case TIOCSPGRP:
2677 return tiocspgrp(tty, real_tty, p);
2678 case TIOCGSID:
2679 return tiocgsid(tty, real_tty, p);
2680 case TIOCGETD:
Alan Coxa352def2008-07-16 21:53:12 +01002681 return put_user(tty->ldisc.ops->num, (int __user *)p);
Alan Cox37bdfb02008-02-08 04:18:47 -08002682 case TIOCSETD:
2683 return tiocsetd(tty, p);
Alan Cox37bdfb02008-02-08 04:18:47 -08002684 /*
2685 * Break handling
2686 */
2687 case TIOCSBRK: /* Turn break on, unconditionally */
Alan Coxf34d7a52008-04-30 00:54:13 -07002688 if (tty->ops->break_ctl)
Alan Cox9e989662008-07-22 11:18:03 +01002689 return tty->ops->break_ctl(tty, -1);
Alan Cox37bdfb02008-02-08 04:18:47 -08002690 return 0;
Alan Cox37bdfb02008-02-08 04:18:47 -08002691 case TIOCCBRK: /* Turn break off, unconditionally */
Alan Coxf34d7a52008-04-30 00:54:13 -07002692 if (tty->ops->break_ctl)
Alan Cox9e989662008-07-22 11:18:03 +01002693 return tty->ops->break_ctl(tty, 0);
Alan Cox37bdfb02008-02-08 04:18:47 -08002694 return 0;
2695 case TCSBRK: /* SVID version: non-zero arg --> no break */
2696 /* non-zero arg means wait for all output data
2697 * to be sent (performed above) but don't send break.
2698 * This is used by the tcdrain() termios function.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002699 */
Alan Cox37bdfb02008-02-08 04:18:47 -08002700 if (!arg)
2701 return send_break(tty, 250);
2702 return 0;
2703 case TCSBRKP: /* support for POSIX tcsendbreak() */
2704 return send_break(tty, arg ? arg*100 : 250);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002705
Alan Cox37bdfb02008-02-08 04:18:47 -08002706 case TIOCMGET:
2707 return tty_tiocmget(tty, file, p);
2708 case TIOCMSET:
2709 case TIOCMBIC:
2710 case TIOCMBIS:
2711 return tty_tiocmset(tty, file, cmd, p);
2712 case TCFLSH:
2713 switch (arg) {
2714 case TCIFLUSH:
2715 case TCIOFLUSH:
2716 /* flush tty buffer and allow ldisc to process ioctl */
2717 tty_buffer_flush(tty);
Paul Fulghumc5c34d42007-05-12 10:36:55 -07002718 break;
Alan Cox37bdfb02008-02-08 04:18:47 -08002719 }
2720 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002721 }
Alan Coxf34d7a52008-04-30 00:54:13 -07002722 if (tty->ops->ioctl) {
2723 retval = (tty->ops->ioctl)(tty, file, cmd, arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002724 if (retval != -ENOIOCTLCMD)
2725 return retval;
2726 }
2727 ld = tty_ldisc_ref_wait(tty);
2728 retval = -EINVAL;
Alan Coxa352def2008-07-16 21:53:12 +01002729 if (ld->ops->ioctl) {
2730 retval = ld->ops->ioctl(tty, file, cmd, arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002731 if (retval == -ENOIOCTLCMD)
2732 retval = -EINVAL;
2733 }
2734 tty_ldisc_deref(ld);
2735 return retval;
2736}
2737
Paul Fulghume10cc1d2007-05-10 22:22:50 -07002738#ifdef CONFIG_COMPAT
Alan Cox37bdfb02008-02-08 04:18:47 -08002739static long tty_compat_ioctl(struct file *file, unsigned int cmd,
Paul Fulghume10cc1d2007-05-10 22:22:50 -07002740 unsigned long arg)
2741{
2742 struct inode *inode = file->f_dentry->d_inode;
2743 struct tty_struct *tty = file->private_data;
2744 struct tty_ldisc *ld;
2745 int retval = -ENOIOCTLCMD;
2746
2747 if (tty_paranoia_check(tty, inode, "tty_ioctl"))
2748 return -EINVAL;
2749
Alan Coxf34d7a52008-04-30 00:54:13 -07002750 if (tty->ops->compat_ioctl) {
2751 retval = (tty->ops->compat_ioctl)(tty, file, cmd, arg);
Paul Fulghume10cc1d2007-05-10 22:22:50 -07002752 if (retval != -ENOIOCTLCMD)
2753 return retval;
2754 }
2755
2756 ld = tty_ldisc_ref_wait(tty);
Alan Coxa352def2008-07-16 21:53:12 +01002757 if (ld->ops->compat_ioctl)
2758 retval = ld->ops->compat_ioctl(tty, file, cmd, arg);
Paul Fulghume10cc1d2007-05-10 22:22:50 -07002759 tty_ldisc_deref(ld);
2760
2761 return retval;
2762}
2763#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07002764
2765/*
2766 * This implements the "Secure Attention Key" --- the idea is to
2767 * prevent trojan horses by killing all processes associated with this
2768 * tty when the user hits the "Secure Attention Key". Required for
2769 * super-paranoid applications --- see the Orange Book for more details.
Alan Cox37bdfb02008-02-08 04:18:47 -08002770 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07002771 * This code could be nicer; ideally it should send a HUP, wait a few
2772 * seconds, then send a INT, and then a KILL signal. But you then
2773 * have to coordinate with the init process, since all processes associated
2774 * with the current tty must be dead before the new getty is allowed
2775 * to spawn.
2776 *
2777 * Now, if it would be correct ;-/ The current code has a nasty hole -
2778 * it doesn't catch files in flight. We may send the descriptor to ourselves
2779 * via AF_UNIX socket, close it and later fetch from socket. FIXME.
2780 *
2781 * Nasty bug: do_SAK is being called in interrupt context. This can
2782 * deadlock. We punt it up to process context. AKPM - 16Mar2001
2783 */
Eric W. Biederman8b6312f2007-02-10 01:44:34 -08002784void __do_SAK(struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002785{
2786#ifdef TTY_SOFT_SAK
2787 tty_hangup(tty);
2788#else
Eric W. Biederman652486f2006-03-28 16:11:02 -08002789 struct task_struct *g, *p;
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08002790 struct pid *session;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002791 int i;
2792 struct file *filp;
Dipankar Sarmabadf1662005-09-09 13:04:10 -07002793 struct fdtable *fdt;
Alan Cox37bdfb02008-02-08 04:18:47 -08002794
Linus Torvalds1da177e2005-04-16 15:20:36 -07002795 if (!tty)
2796 return;
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002797 session = tty->session;
Alan Cox37bdfb02008-02-08 04:18:47 -08002798
Dan Carpenterb3f13de2006-12-13 00:35:09 -08002799 tty_ldisc_flush(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002800
Alan Coxf34d7a52008-04-30 00:54:13 -07002801 tty_driver_flush_buffer(tty);
Alan Cox37bdfb02008-02-08 04:18:47 -08002802
Linus Torvalds1da177e2005-04-16 15:20:36 -07002803 read_lock(&tasklist_lock);
Eric W. Biederman652486f2006-03-28 16:11:02 -08002804 /* Kill the entire session */
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08002805 do_each_pid_task(session, PIDTYPE_SID, p) {
Eric W. Biederman652486f2006-03-28 16:11:02 -08002806 printk(KERN_NOTICE "SAK: killed process %d"
Pavel Emelianova47afb02007-10-18 23:39:46 -07002807 " (%s): task_session_nr(p)==tty->session\n",
Pavel Emelyanovba25f9d2007-10-18 23:40:40 -07002808 task_pid_nr(p), p->comm);
Eric W. Biederman652486f2006-03-28 16:11:02 -08002809 send_sig(SIGKILL, p, 1);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08002810 } while_each_pid_task(session, PIDTYPE_SID, p);
Eric W. Biederman652486f2006-03-28 16:11:02 -08002811 /* Now kill any processes that happen to have the
2812 * tty open.
2813 */
2814 do_each_thread(g, p) {
2815 if (p->signal->tty == tty) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002816 printk(KERN_NOTICE "SAK: killed process %d"
Pavel Emelianova47afb02007-10-18 23:39:46 -07002817 " (%s): task_session_nr(p)==tty->session\n",
Pavel Emelyanovba25f9d2007-10-18 23:40:40 -07002818 task_pid_nr(p), p->comm);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002819 send_sig(SIGKILL, p, 1);
2820 continue;
2821 }
2822 task_lock(p);
2823 if (p->files) {
Dipankar Sarmaca99c1d2006-04-18 22:21:46 -07002824 /*
2825 * We don't take a ref to the file, so we must
2826 * hold ->file_lock instead.
2827 */
2828 spin_lock(&p->files->file_lock);
Dipankar Sarmabadf1662005-09-09 13:04:10 -07002829 fdt = files_fdtable(p->files);
Alan Cox37bdfb02008-02-08 04:18:47 -08002830 for (i = 0; i < fdt->max_fds; i++) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002831 filp = fcheck_files(p->files, i);
2832 if (!filp)
2833 continue;
2834 if (filp->f_op->read == tty_read &&
2835 filp->private_data == tty) {
2836 printk(KERN_NOTICE "SAK: killed process %d"
2837 " (%s): fd#%d opened to the tty\n",
Pavel Emelyanovba25f9d2007-10-18 23:40:40 -07002838 task_pid_nr(p), p->comm, i);
Eric W. Biederman20ac9432006-04-13 04:49:07 -06002839 force_sig(SIGKILL, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002840 break;
2841 }
2842 }
Dipankar Sarmaca99c1d2006-04-18 22:21:46 -07002843 spin_unlock(&p->files->file_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002844 }
2845 task_unlock(p);
Eric W. Biederman652486f2006-03-28 16:11:02 -08002846 } while_each_thread(g, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002847 read_unlock(&tasklist_lock);
2848#endif
2849}
2850
Eric W. Biederman8b6312f2007-02-10 01:44:34 -08002851static void do_SAK_work(struct work_struct *work)
2852{
2853 struct tty_struct *tty =
2854 container_of(work, struct tty_struct, SAK_work);
2855 __do_SAK(tty);
2856}
2857
Linus Torvalds1da177e2005-04-16 15:20:36 -07002858/*
2859 * The tq handling here is a little racy - tty->SAK_work may already be queued.
2860 * Fortunately we don't need to worry, because if ->SAK_work is already queued,
2861 * the values which we write to it will be identical to the values which it
2862 * already has. --akpm
2863 */
2864void do_SAK(struct tty_struct *tty)
2865{
2866 if (!tty)
2867 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002868 schedule_work(&tty->SAK_work);
2869}
2870
2871EXPORT_SYMBOL(do_SAK);
2872
Alan Coxaf9b8972006-08-27 01:24:01 -07002873/**
Alan Coxaf9b8972006-08-27 01:24:01 -07002874 * initialize_tty_struct
2875 * @tty: tty to initialize
2876 *
2877 * This subroutine initializes a tty structure that has been newly
2878 * allocated.
2879 *
2880 * Locking: none - tty in question must not be exposed at this point
Linus Torvalds1da177e2005-04-16 15:20:36 -07002881 */
Alan Coxaf9b8972006-08-27 01:24:01 -07002882
Linus Torvalds1da177e2005-04-16 15:20:36 -07002883static void initialize_tty_struct(struct tty_struct *tty)
2884{
2885 memset(tty, 0, sizeof(struct tty_struct));
Alan Cox9c9f4de2008-10-13 10:37:26 +01002886 kref_init(&tty->kref);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002887 tty->magic = TTY_MAGIC;
Alan Cox01e1abb2008-07-22 11:16:55 +01002888 tty_ldisc_init(tty);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08002889 tty->session = NULL;
2890 tty->pgrp = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002891 tty->overrun_time = jiffies;
Alan Cox33f0f882006-01-09 20:54:13 -08002892 tty->buf.head = tty->buf.tail = NULL;
2893 tty_buffer_init(tty);
Arjan van de Ven5785c952006-09-29 02:00:43 -07002894 mutex_init(&tty->termios_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002895 init_waitqueue_head(&tty->write_wait);
2896 init_waitqueue_head(&tty->read_wait);
David Howells65f27f32006-11-22 14:55:48 +00002897 INIT_WORK(&tty->hangup_work, do_tty_hangup);
Ingo Molnar70522e12006-03-23 03:00:31 -08002898 mutex_init(&tty->atomic_read_lock);
2899 mutex_init(&tty->atomic_write_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002900 spin_lock_init(&tty->read_lock);
Alan Cox04f378b2008-04-30 00:53:29 -07002901 spin_lock_init(&tty->ctrl_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002902 INIT_LIST_HEAD(&tty->tty_files);
Eric W. Biederman7f1f86a2007-02-13 14:38:58 -07002903 INIT_WORK(&tty->SAK_work, do_SAK_work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002904}
2905
Alan Coxf34d7a52008-04-30 00:54:13 -07002906/**
2907 * tty_put_char - write one character to a tty
2908 * @tty: tty
2909 * @ch: character
2910 *
2911 * Write one byte to the tty using the provided put_char method
2912 * if present. Returns the number of characters successfully output.
2913 *
2914 * Note: the specific put_char operation in the driver layer may go
2915 * away soon. Don't call it directly, use this method
Linus Torvalds1da177e2005-04-16 15:20:36 -07002916 */
Alan Coxaf9b8972006-08-27 01:24:01 -07002917
Alan Coxf34d7a52008-04-30 00:54:13 -07002918int tty_put_char(struct tty_struct *tty, unsigned char ch)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002919{
Alan Coxf34d7a52008-04-30 00:54:13 -07002920 if (tty->ops->put_char)
2921 return tty->ops->put_char(tty, ch);
2922 return tty->ops->write(tty, &ch, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002923}
2924
Alan Coxf34d7a52008-04-30 00:54:13 -07002925EXPORT_SYMBOL_GPL(tty_put_char);
2926
gregkh@suse.de7fe845d2005-03-15 14:23:15 -08002927static struct class *tty_class;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002928
2929/**
Alan Coxaf9b8972006-08-27 01:24:01 -07002930 * tty_register_device - register a tty device
2931 * @driver: the tty driver that describes the tty device
2932 * @index: the index in the tty driver for this tty device
2933 * @device: a struct device that is associated with this tty device.
2934 * This field is optional, if there is no known struct device
2935 * for this tty device it can be set to NULL safely.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002936 *
Greg Kroah-Hartman01107d32006-08-07 22:19:37 -07002937 * Returns a pointer to the struct device for this tty device
2938 * (or ERR_PTR(-EFOO) on error).
Hansjoerg Lipp1cdcb6b2006-04-22 18:36:53 +02002939 *
Alan Coxaf9b8972006-08-27 01:24:01 -07002940 * This call is required to be made to register an individual tty device
2941 * if the tty driver's flags have the TTY_DRIVER_DYNAMIC_DEV bit set. If
2942 * that bit is not set, this function should not be called by a tty
2943 * driver.
2944 *
2945 * Locking: ??
Linus Torvalds1da177e2005-04-16 15:20:36 -07002946 */
Alan Coxaf9b8972006-08-27 01:24:01 -07002947
Greg Kroah-Hartman01107d32006-08-07 22:19:37 -07002948struct device *tty_register_device(struct tty_driver *driver, unsigned index,
2949 struct device *device)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002950{
2951 char name[64];
2952 dev_t dev = MKDEV(driver->major, driver->minor_start) + index;
2953
2954 if (index >= driver->num) {
2955 printk(KERN_ERR "Attempt to register invalid tty line number "
2956 " (%d).\n", index);
Hansjoerg Lipp1cdcb6b2006-04-22 18:36:53 +02002957 return ERR_PTR(-EINVAL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002958 }
2959
Linus Torvalds1da177e2005-04-16 15:20:36 -07002960 if (driver->type == TTY_DRIVER_TYPE_PTY)
2961 pty_line_name(driver, index, name);
2962 else
2963 tty_line_name(driver, index, name);
Hansjoerg Lipp1cdcb6b2006-04-22 18:36:53 +02002964
Greg Kroah-Hartman47aa5792008-05-21 12:52:33 -07002965 return device_create_drvdata(tty_class, device, dev, NULL, name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002966}
2967
2968/**
Alan Coxaf9b8972006-08-27 01:24:01 -07002969 * tty_unregister_device - unregister a tty device
2970 * @driver: the tty driver that describes the tty device
2971 * @index: the index in the tty driver for this tty device
Linus Torvalds1da177e2005-04-16 15:20:36 -07002972 *
Alan Coxaf9b8972006-08-27 01:24:01 -07002973 * If a tty device is registered with a call to tty_register_device() then
2974 * this function must be called when the tty device is gone.
2975 *
2976 * Locking: ??
Linus Torvalds1da177e2005-04-16 15:20:36 -07002977 */
Alan Coxaf9b8972006-08-27 01:24:01 -07002978
Linus Torvalds1da177e2005-04-16 15:20:36 -07002979void tty_unregister_device(struct tty_driver *driver, unsigned index)
2980{
Alan Cox37bdfb02008-02-08 04:18:47 -08002981 device_destroy(tty_class,
2982 MKDEV(driver->major, driver->minor_start) + index);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002983}
2984
2985EXPORT_SYMBOL(tty_register_device);
2986EXPORT_SYMBOL(tty_unregister_device);
2987
2988struct tty_driver *alloc_tty_driver(int lines)
2989{
2990 struct tty_driver *driver;
2991
Jean Delvare506eb992007-07-15 23:40:14 -07002992 driver = kzalloc(sizeof(struct tty_driver), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002993 if (driver) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002994 driver->magic = TTY_DRIVER_MAGIC;
2995 driver->num = lines;
2996 /* later we'll move allocation of tables here */
2997 }
2998 return driver;
2999}
3000
3001void put_tty_driver(struct tty_driver *driver)
3002{
3003 kfree(driver);
3004}
3005
Jeff Dikeb68e31d2006-10-02 02:17:18 -07003006void tty_set_operations(struct tty_driver *driver,
3007 const struct tty_operations *op)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003008{
Alan Coxf34d7a52008-04-30 00:54:13 -07003009 driver->ops = op;
3010};
Linus Torvalds1da177e2005-04-16 15:20:36 -07003011
3012EXPORT_SYMBOL(alloc_tty_driver);
3013EXPORT_SYMBOL(put_tty_driver);
3014EXPORT_SYMBOL(tty_set_operations);
3015
3016/*
3017 * Called by a tty driver to register itself.
3018 */
3019int tty_register_driver(struct tty_driver *driver)
3020{
3021 int error;
Alan Cox37bdfb02008-02-08 04:18:47 -08003022 int i;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003023 dev_t dev;
3024 void **p = NULL;
3025
3026 if (driver->flags & TTY_DRIVER_INSTALLED)
3027 return 0;
3028
Andy Whitcroft543691a62007-05-06 14:49:33 -07003029 if (!(driver->flags & TTY_DRIVER_DEVPTS_MEM) && driver->num) {
3030 p = kzalloc(driver->num * 3 * sizeof(void *), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003031 if (!p)
3032 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003033 }
3034
3035 if (!driver->major) {
Alan Cox37bdfb02008-02-08 04:18:47 -08003036 error = alloc_chrdev_region(&dev, driver->minor_start,
3037 driver->num, driver->name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003038 if (!error) {
3039 driver->major = MAJOR(dev);
3040 driver->minor_start = MINOR(dev);
3041 }
3042 } else {
3043 dev = MKDEV(driver->major, driver->minor_start);
Geert Uytterhoevene5717c42007-02-20 15:45:21 +01003044 error = register_chrdev_region(dev, driver->num, driver->name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003045 }
3046 if (error < 0) {
3047 kfree(p);
3048 return error;
3049 }
3050
3051 if (p) {
3052 driver->ttys = (struct tty_struct **)p;
Alan Coxedc6afc2006-12-08 02:38:44 -08003053 driver->termios = (struct ktermios **)(p + driver->num);
Alan Cox37bdfb02008-02-08 04:18:47 -08003054 driver->termios_locked = (struct ktermios **)
3055 (p + driver->num * 2);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003056 } else {
3057 driver->ttys = NULL;
3058 driver->termios = NULL;
3059 driver->termios_locked = NULL;
3060 }
3061
3062 cdev_init(&driver->cdev, &tty_fops);
3063 driver->cdev.owner = driver->owner;
3064 error = cdev_add(&driver->cdev, dev, driver->num);
3065 if (error) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07003066 unregister_chrdev_region(dev, driver->num);
3067 driver->ttys = NULL;
3068 driver->termios = driver->termios_locked = NULL;
3069 kfree(p);
3070 return error;
3071 }
3072
Alexey Dobriyanca509f62007-05-08 00:27:12 -07003073 mutex_lock(&tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003074 list_add(&driver->tty_drivers, &tty_drivers);
Alexey Dobriyanca509f62007-05-08 00:27:12 -07003075 mutex_unlock(&tty_mutex);
Alan Cox37bdfb02008-02-08 04:18:47 -08003076
3077 if (!(driver->flags & TTY_DRIVER_DYNAMIC_DEV)) {
3078 for (i = 0; i < driver->num; i++)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003079 tty_register_device(driver, i, NULL);
3080 }
3081 proc_tty_register_driver(driver);
3082 return 0;
3083}
3084
3085EXPORT_SYMBOL(tty_register_driver);
3086
3087/*
3088 * Called by a tty driver to unregister itself.
3089 */
3090int tty_unregister_driver(struct tty_driver *driver)
3091{
3092 int i;
Alan Coxedc6afc2006-12-08 02:38:44 -08003093 struct ktermios *tp;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003094 void *p;
3095
3096 if (driver->refcount)
3097 return -EBUSY;
3098
3099 unregister_chrdev_region(MKDEV(driver->major, driver->minor_start),
3100 driver->num);
Alexey Dobriyanca509f62007-05-08 00:27:12 -07003101 mutex_lock(&tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003102 list_del(&driver->tty_drivers);
Alexey Dobriyanca509f62007-05-08 00:27:12 -07003103 mutex_unlock(&tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003104
3105 /*
3106 * Free the termios and termios_locked structures because
3107 * we don't want to get memory leaks when modular tty
3108 * drivers are removed from the kernel.
3109 */
3110 for (i = 0; i < driver->num; i++) {
3111 tp = driver->termios[i];
3112 if (tp) {
3113 driver->termios[i] = NULL;
3114 kfree(tp);
3115 }
3116 tp = driver->termios_locked[i];
3117 if (tp) {
3118 driver->termios_locked[i] = NULL;
3119 kfree(tp);
3120 }
Greg Kroah-Hartman331b8312005-06-20 21:15:16 -07003121 if (!(driver->flags & TTY_DRIVER_DYNAMIC_DEV))
Linus Torvalds1da177e2005-04-16 15:20:36 -07003122 tty_unregister_device(driver, i);
3123 }
3124 p = driver->ttys;
3125 proc_tty_unregister_driver(driver);
3126 driver->ttys = NULL;
3127 driver->termios = driver->termios_locked = NULL;
3128 kfree(p);
3129 cdev_del(&driver->cdev);
3130 return 0;
3131}
Linus Torvalds1da177e2005-04-16 15:20:36 -07003132EXPORT_SYMBOL(tty_unregister_driver);
3133
Peter Zijlstra24ec8392006-12-08 02:36:04 -08003134dev_t tty_devnum(struct tty_struct *tty)
3135{
3136 return MKDEV(tty->driver->major, tty->driver->minor_start) + tty->index;
3137}
3138EXPORT_SYMBOL(tty_devnum);
3139
3140void proc_clear_tty(struct task_struct *p)
3141{
Alan Cox9c9f4de2008-10-13 10:37:26 +01003142 struct tty_struct *tty;
Peter Zijlstra24ec8392006-12-08 02:36:04 -08003143 spin_lock_irq(&p->sighand->siglock);
Alan Cox9c9f4de2008-10-13 10:37:26 +01003144 tty = p->signal->tty;
Peter Zijlstra24ec8392006-12-08 02:36:04 -08003145 p->signal->tty = NULL;
3146 spin_unlock_irq(&p->sighand->siglock);
Alan Cox9c9f4de2008-10-13 10:37:26 +01003147 tty_kref_put(tty);
Peter Zijlstra24ec8392006-12-08 02:36:04 -08003148}
Peter Zijlstra24ec8392006-12-08 02:36:04 -08003149
Alan Cox47f86832008-04-30 00:53:30 -07003150/* Called under the sighand lock */
3151
Eric W. Biederman2a65f1d2007-05-08 00:26:53 -07003152static void __proc_set_tty(struct task_struct *tsk, struct tty_struct *tty)
Peter Zijlstra24ec8392006-12-08 02:36:04 -08003153{
3154 if (tty) {
Alan Cox47f86832008-04-30 00:53:30 -07003155 unsigned long flags;
3156 /* We should not have a session or pgrp to put here but.... */
3157 spin_lock_irqsave(&tty->ctrl_lock, flags);
Eric W. Biedermand9c1e9a2007-03-18 12:45:44 -06003158 put_pid(tty->session);
3159 put_pid(tty->pgrp);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08003160 tty->pgrp = get_pid(task_pgrp(tsk));
Alan Cox47f86832008-04-30 00:53:30 -07003161 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
3162 tty->session = get_pid(task_session(tsk));
Alan Cox9c9f4de2008-10-13 10:37:26 +01003163 if (tsk->signal->tty) {
3164 printk(KERN_DEBUG "tty not NULL!!\n");
3165 tty_kref_put(tsk->signal->tty);
3166 }
Peter Zijlstra24ec8392006-12-08 02:36:04 -08003167 }
Eric W. Biederman2a65f1d2007-05-08 00:26:53 -07003168 put_pid(tsk->signal->tty_old_pgrp);
Alan Cox9c9f4de2008-10-13 10:37:26 +01003169 tsk->signal->tty = tty_kref_get(tty);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08003170 tsk->signal->tty_old_pgrp = NULL;
Peter Zijlstra24ec8392006-12-08 02:36:04 -08003171}
3172
Eric W. Biederman98a27ba2007-05-08 00:26:56 -07003173static void proc_set_tty(struct task_struct *tsk, struct tty_struct *tty)
Peter Zijlstra24ec8392006-12-08 02:36:04 -08003174{
3175 spin_lock_irq(&tsk->sighand->siglock);
Eric W. Biederman2a65f1d2007-05-08 00:26:53 -07003176 __proc_set_tty(tsk, tty);
Peter Zijlstra24ec8392006-12-08 02:36:04 -08003177 spin_unlock_irq(&tsk->sighand->siglock);
3178}
3179
3180struct tty_struct *get_current_tty(void)
3181{
3182 struct tty_struct *tty;
3183 WARN_ON_ONCE(!mutex_is_locked(&tty_mutex));
Alan Cox452a00d2008-10-13 10:39:13 +01003184 tty = tty_kref_get(current->signal->tty);
Peter Zijlstra24ec8392006-12-08 02:36:04 -08003185 /*
3186 * session->tty can be changed/cleared from under us, make sure we
3187 * issue the load. The obtained pointer, when not NULL, is valid as
3188 * long as we hold tty_mutex.
3189 */
3190 barrier();
3191 return tty;
3192}
Heiko Carstensa311f742006-12-13 00:33:41 -08003193EXPORT_SYMBOL_GPL(get_current_tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003194
3195/*
3196 * Initialize the console device. This is called *early*, so
3197 * we can't necessarily depend on lots of kernel help here.
3198 * Just do some early initializations, and do the complex setup
3199 * later.
3200 */
3201void __init console_init(void)
3202{
3203 initcall_t *call;
3204
3205 /* Setup the default TTY line discipline. */
Alan Cox01e1abb2008-07-22 11:16:55 +01003206 tty_ldisc_begin();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003207
3208 /*
Alan Cox37bdfb02008-02-08 04:18:47 -08003209 * set up the console device so that later boot sequences can
Linus Torvalds1da177e2005-04-16 15:20:36 -07003210 * inform about problems etc..
3211 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003212 call = __con_initcall_start;
3213 while (call < __con_initcall_end) {
3214 (*call)();
3215 call++;
3216 }
3217}
3218
Linus Torvalds1da177e2005-04-16 15:20:36 -07003219static int __init tty_class_init(void)
3220{
gregkh@suse.de7fe845d2005-03-15 14:23:15 -08003221 tty_class = class_create(THIS_MODULE, "tty");
Linus Torvalds1da177e2005-04-16 15:20:36 -07003222 if (IS_ERR(tty_class))
3223 return PTR_ERR(tty_class);
3224 return 0;
3225}
3226
3227postcore_initcall(tty_class_init);
3228
3229/* 3/2004 jmc: why do these devices exist? */
3230
3231static struct cdev tty_cdev, console_cdev;
3232#ifdef CONFIG_UNIX98_PTYS
3233static struct cdev ptmx_cdev;
3234#endif
3235#ifdef CONFIG_VT
3236static struct cdev vc0_cdev;
3237#endif
3238
3239/*
3240 * Ok, now we can initialize the rest of the tty devices and can count
3241 * on memory allocations, interrupts etc..
3242 */
3243static int __init tty_init(void)
3244{
3245 cdev_init(&tty_cdev, &tty_fops);
3246 if (cdev_add(&tty_cdev, MKDEV(TTYAUX_MAJOR, 0), 1) ||
3247 register_chrdev_region(MKDEV(TTYAUX_MAJOR, 0), 1, "/dev/tty") < 0)
3248 panic("Couldn't register /dev/tty driver\n");
Greg Kroah-Hartman47aa5792008-05-21 12:52:33 -07003249 device_create_drvdata(tty_class, NULL, MKDEV(TTYAUX_MAJOR, 0), NULL,
3250 "tty");
Linus Torvalds1da177e2005-04-16 15:20:36 -07003251
3252 cdev_init(&console_cdev, &console_fops);
3253 if (cdev_add(&console_cdev, MKDEV(TTYAUX_MAJOR, 1), 1) ||
3254 register_chrdev_region(MKDEV(TTYAUX_MAJOR, 1), 1, "/dev/console") < 0)
3255 panic("Couldn't register /dev/console driver\n");
Greg Kroah-Hartman47aa5792008-05-21 12:52:33 -07003256 device_create_drvdata(tty_class, NULL, MKDEV(TTYAUX_MAJOR, 1), NULL,
3257 "console");
Linus Torvalds1da177e2005-04-16 15:20:36 -07003258
3259#ifdef CONFIG_UNIX98_PTYS
3260 cdev_init(&ptmx_cdev, &ptmx_fops);
3261 if (cdev_add(&ptmx_cdev, MKDEV(TTYAUX_MAJOR, 2), 1) ||
3262 register_chrdev_region(MKDEV(TTYAUX_MAJOR, 2), 1, "/dev/ptmx") < 0)
3263 panic("Couldn't register /dev/ptmx driver\n");
Greg Kroah-Hartman47aa5792008-05-21 12:52:33 -07003264 device_create_drvdata(tty_class, NULL, MKDEV(TTYAUX_MAJOR, 2), NULL, "ptmx");
Linus Torvalds1da177e2005-04-16 15:20:36 -07003265#endif
3266
3267#ifdef CONFIG_VT
3268 cdev_init(&vc0_cdev, &console_fops);
3269 if (cdev_add(&vc0_cdev, MKDEV(TTY_MAJOR, 0), 1) ||
3270 register_chrdev_region(MKDEV(TTY_MAJOR, 0), 1, "/dev/vc/0") < 0)
3271 panic("Couldn't register /dev/tty0 driver\n");
Greg Kroah-Hartman47aa5792008-05-21 12:52:33 -07003272 device_create_drvdata(tty_class, NULL, MKDEV(TTY_MAJOR, 0), NULL, "tty0");
Linus Torvalds1da177e2005-04-16 15:20:36 -07003273
3274 vty_init();
3275#endif
3276 return 0;
3277}
3278module_init(tty_init);