blob: 6c817398232e45020a0e52d66c7b399efa94f028 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * linux/drivers/char/tty_io.c
3 *
4 * Copyright (C) 1991, 1992 Linus Torvalds
5 */
6
7/*
8 * 'tty_io.c' gives an orthogonal feeling to tty's, be they consoles
9 * or rs-channels. It also implements echoing, cooked mode etc.
10 *
11 * Kill-line thanks to John T Kohl, who also corrected VMIN = VTIME = 0.
12 *
13 * Modified by Theodore Ts'o, 9/14/92, to dynamically allocate the
14 * tty_struct and tty_queue structures. Previously there was an array
15 * of 256 tty_struct's which was statically allocated, and the
16 * tty_queue structures were allocated at boot time. Both are now
17 * dynamically allocated only when the tty is open.
18 *
19 * Also restructured routines so that there is more of a separation
20 * between the high-level tty routines (tty_io.c and tty_ioctl.c) and
21 * the low-level tty routines (serial.c, pty.c, console.c). This
Alan Cox37bdfb02008-02-08 04:18:47 -080022 * makes for cleaner and more compact code. -TYT, 9/17/92
Linus Torvalds1da177e2005-04-16 15:20:36 -070023 *
24 * Modified by Fred N. van Kempen, 01/29/93, to add line disciplines
25 * which can be dynamically activated and de-activated by the line
26 * discipline handling modules (like SLIP).
27 *
28 * NOTE: pay no attention to the line discipline code (yet); its
29 * interface is still subject to change in this version...
30 * -- TYT, 1/31/92
31 *
32 * Added functionality to the OPOST tty handling. No delays, but all
33 * other bits should be there.
34 * -- Nick Holloway <alfie@dcs.warwick.ac.uk>, 27th May 1993.
35 *
36 * Rewrote canonical mode and added more termios flags.
37 * -- julian@uhunix.uhcc.hawaii.edu (J. Cowley), 13Jan94
38 *
39 * Reorganized FASYNC support so mouse code can share it.
40 * -- ctm@ardi.com, 9Sep95
41 *
42 * New TIOCLINUX variants added.
43 * -- mj@k332.feld.cvut.cz, 19-Nov-95
Alan Cox37bdfb02008-02-08 04:18:47 -080044 *
Linus Torvalds1da177e2005-04-16 15:20:36 -070045 * Restrict vt switching via ioctl()
46 * -- grif@cs.ucr.edu, 5-Dec-95
47 *
48 * Move console and virtual terminal code to more appropriate files,
49 * implement CONFIG_VT and generalize console device interface.
50 * -- Marko Kohtala <Marko.Kohtala@hut.fi>, March 97
51 *
Alan Coxd81ed102008-10-13 10:41:42 +010052 * Rewrote tty_init_dev and tty_release_dev to eliminate races.
Linus Torvalds1da177e2005-04-16 15:20:36 -070053 * -- Bill Hawes <whawes@star.net>, June 97
54 *
55 * Added devfs support.
56 * -- C. Scott Ananian <cananian@alumni.princeton.edu>, 13-Jan-1998
57 *
58 * Added support for a Unix98-style ptmx device.
59 * -- C. Scott Ananian <cananian@alumni.princeton.edu>, 14-Jan-1998
60 *
61 * Reduced memory usage for older ARM systems
62 * -- Russell King <rmk@arm.linux.org.uk>
63 *
64 * Move do_SAK() into process context. Less stack use in devfs functions.
Alan Cox37bdfb02008-02-08 04:18:47 -080065 * alloc_tty_struct() always uses kmalloc()
66 * -- Andrew Morton <andrewm@uow.edu.eu> 17Mar01
Linus Torvalds1da177e2005-04-16 15:20:36 -070067 */
68
Linus Torvalds1da177e2005-04-16 15:20:36 -070069#include <linux/types.h>
70#include <linux/major.h>
71#include <linux/errno.h>
72#include <linux/signal.h>
73#include <linux/fcntl.h>
74#include <linux/sched.h>
75#include <linux/interrupt.h>
76#include <linux/tty.h>
77#include <linux/tty_driver.h>
78#include <linux/tty_flip.h>
79#include <linux/devpts_fs.h>
80#include <linux/file.h>
Al Viro9f3acc32008-04-24 07:44:08 -040081#include <linux/fdtable.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070082#include <linux/console.h>
83#include <linux/timer.h>
84#include <linux/ctype.h>
85#include <linux/kd.h>
86#include <linux/mm.h>
87#include <linux/string.h>
88#include <linux/slab.h>
89#include <linux/poll.h>
90#include <linux/proc_fs.h>
91#include <linux/init.h>
92#include <linux/module.h>
93#include <linux/smp_lock.h>
94#include <linux/device.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070095#include <linux/wait.h>
96#include <linux/bitops.h>
Domen Puncerb20f3ae2005-06-25 14:58:42 -070097#include <linux/delay.h>
Alan Coxa352def2008-07-16 21:53:12 +010098#include <linux/seq_file.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070099
Alan Coxa352def2008-07-16 21:53:12 +0100100#include <linux/uaccess.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700101#include <asm/system.h>
102
103#include <linux/kbd_kern.h>
104#include <linux/vt_kern.h>
105#include <linux/selection.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700106
107#include <linux/kmod.h>
Pavel Emelyanovb4888932007-10-18 23:40:14 -0700108#include <linux/nsproxy.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700109
110#undef TTY_DEBUG_HANGUP
111
112#define TTY_PARANOIA_CHECK 1
113#define CHECK_TTY_COUNT 1
114
Alan Coxedc6afc2006-12-08 02:38:44 -0800115struct ktermios tty_std_termios = { /* for the benefit of tty drivers */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700116 .c_iflag = ICRNL | IXON,
117 .c_oflag = OPOST | ONLCR,
118 .c_cflag = B38400 | CS8 | CREAD | HUPCL,
119 .c_lflag = ISIG | ICANON | ECHO | ECHOE | ECHOK |
120 ECHOCTL | ECHOKE | IEXTEN,
Alan Coxedc6afc2006-12-08 02:38:44 -0800121 .c_cc = INIT_C_CC,
122 .c_ispeed = 38400,
123 .c_ospeed = 38400
Linus Torvalds1da177e2005-04-16 15:20:36 -0700124};
125
126EXPORT_SYMBOL(tty_std_termios);
127
128/* This list gets poked at by procfs and various bits of boot up code. This
129 could do with some rationalisation such as pulling the tty proc function
130 into this file */
Alan Cox37bdfb02008-02-08 04:18:47 -0800131
Linus Torvalds1da177e2005-04-16 15:20:36 -0700132LIST_HEAD(tty_drivers); /* linked list of tty drivers */
133
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800134/* Mutex to protect creating and releasing a tty. This is shared with
Linus Torvalds1da177e2005-04-16 15:20:36 -0700135 vt.c for deeply disgusting hack reasons */
Ingo Molnar70522e12006-03-23 03:00:31 -0800136DEFINE_MUTEX(tty_mutex);
Alan Coxde2a84f2006-09-29 02:00:57 -0700137EXPORT_SYMBOL(tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700138
Linus Torvalds1da177e2005-04-16 15:20:36 -0700139static ssize_t tty_read(struct file *, char __user *, size_t, loff_t *);
140static ssize_t tty_write(struct file *, const char __user *, size_t, loff_t *);
Alan Cox37bdfb02008-02-08 04:18:47 -0800141ssize_t redirected_tty_write(struct file *, const char __user *,
142 size_t, loff_t *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700143static unsigned int tty_poll(struct file *, poll_table *);
144static int tty_open(struct inode *, struct file *);
145static int tty_release(struct inode *, struct file *);
Alan Cox04f378b2008-04-30 00:53:29 -0700146long tty_ioctl(struct file *file, unsigned int cmd, unsigned long arg);
Paul Fulghume10cc1d2007-05-10 22:22:50 -0700147#ifdef CONFIG_COMPAT
Alan Cox37bdfb02008-02-08 04:18:47 -0800148static long tty_compat_ioctl(struct file *file, unsigned int cmd,
Paul Fulghume10cc1d2007-05-10 22:22:50 -0700149 unsigned long arg);
150#else
151#define tty_compat_ioctl NULL
152#endif
Alan Cox37bdfb02008-02-08 04:18:47 -0800153static int tty_fasync(int fd, struct file *filp, int on);
Christoph Hellwigd5698c22007-02-10 01:46:46 -0800154static void release_tty(struct tty_struct *tty, int idx);
Eric W. Biederman2a65f1d2007-05-08 00:26:53 -0700155static void __proc_set_tty(struct task_struct *tsk, struct tty_struct *tty);
Eric W. Biederman98a27ba2007-05-08 00:26:56 -0700156static void proc_set_tty(struct task_struct *tsk, struct tty_struct *tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700157
Alan Coxaf9b8972006-08-27 01:24:01 -0700158/**
159 * alloc_tty_struct - allocate a tty object
160 *
161 * Return a new empty tty structure. The data fields have not
162 * been initialized in any way but has been zeroed
163 *
164 * Locking: none
Alan Coxaf9b8972006-08-27 01:24:01 -0700165 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700166
Alan Coxbf970ee2008-10-13 10:42:39 +0100167struct tty_struct *alloc_tty_struct(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700168{
Alan Cox1266b1e2006-09-29 02:00:40 -0700169 return kzalloc(sizeof(struct tty_struct), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700170}
171
Alan Coxaf9b8972006-08-27 01:24:01 -0700172/**
173 * free_tty_struct - free a disused tty
174 * @tty: tty struct to free
175 *
176 * Free the write buffers, tty queue and tty memory itself.
177 *
178 * Locking: none. Must be called after tty is definitely unused
179 */
180
Alan Coxbf970ee2008-10-13 10:42:39 +0100181void free_tty_struct(struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700182{
183 kfree(tty->write_buf);
Alan Cox33f0f882006-01-09 20:54:13 -0800184 tty_buffer_free_all(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700185 kfree(tty);
186}
187
188#define TTY_NUMBER(tty) ((tty)->index + (tty)->driver->name_base)
189
Alan Coxaf9b8972006-08-27 01:24:01 -0700190/**
191 * tty_name - return tty naming
192 * @tty: tty structure
193 * @buf: buffer for output
194 *
195 * Convert a tty structure into a name. The name reflects the kernel
196 * naming policy and if udev is in use may not reflect user space
197 *
198 * Locking: none
199 */
200
Linus Torvalds1da177e2005-04-16 15:20:36 -0700201char *tty_name(struct tty_struct *tty, char *buf)
202{
203 if (!tty) /* Hmm. NULL pointer. That's fun. */
204 strcpy(buf, "NULL tty");
205 else
206 strcpy(buf, tty->name);
207 return buf;
208}
209
210EXPORT_SYMBOL(tty_name);
211
Andrew Mortond769a662005-05-05 16:15:50 -0700212int tty_paranoia_check(struct tty_struct *tty, struct inode *inode,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700213 const char *routine)
214{
215#ifdef TTY_PARANOIA_CHECK
216 if (!tty) {
217 printk(KERN_WARNING
218 "null TTY for (%d:%d) in %s\n",
219 imajor(inode), iminor(inode), routine);
220 return 1;
221 }
222 if (tty->magic != TTY_MAGIC) {
223 printk(KERN_WARNING
224 "bad magic number for tty struct (%d:%d) in %s\n",
225 imajor(inode), iminor(inode), routine);
226 return 1;
227 }
228#endif
229 return 0;
230}
231
232static int check_tty_count(struct tty_struct *tty, const char *routine)
233{
234#ifdef CHECK_TTY_COUNT
235 struct list_head *p;
236 int count = 0;
Alan Cox37bdfb02008-02-08 04:18:47 -0800237
Linus Torvalds1da177e2005-04-16 15:20:36 -0700238 file_list_lock();
239 list_for_each(p, &tty->tty_files) {
240 count++;
241 }
242 file_list_unlock();
243 if (tty->driver->type == TTY_DRIVER_TYPE_PTY &&
244 tty->driver->subtype == PTY_TYPE_SLAVE &&
245 tty->link && tty->link->count)
246 count++;
247 if (tty->count != count) {
248 printk(KERN_WARNING "Warning: dev (%s) tty->count(%d) "
249 "!= #fd's(%d) in %s\n",
250 tty->name, tty->count, count, routine);
251 return count;
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800252 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700253#endif
254 return 0;
255}
256
Alan Coxaf9b8972006-08-27 01:24:01 -0700257/**
Alan Coxaf9b8972006-08-27 01:24:01 -0700258 * get_tty_driver - find device of a tty
259 * @dev_t: device identifier
260 * @index: returns the index of the tty
261 *
262 * This routine returns a tty driver structure, given a device number
263 * and also passes back the index number.
264 *
265 * Locking: caller must hold tty_mutex
Linus Torvalds1da177e2005-04-16 15:20:36 -0700266 */
Alan Coxaf9b8972006-08-27 01:24:01 -0700267
Linus Torvalds1da177e2005-04-16 15:20:36 -0700268static struct tty_driver *get_tty_driver(dev_t device, int *index)
269{
270 struct tty_driver *p;
271
272 list_for_each_entry(p, &tty_drivers, tty_drivers) {
273 dev_t base = MKDEV(p->major, p->minor_start);
274 if (device < base || device >= base + p->num)
275 continue;
276 *index = device - base;
Alan Cox7d7b93c2008-10-13 10:42:09 +0100277 return tty_driver_kref_get(p);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700278 }
279 return NULL;
280}
281
Jason Wesself2d937f2008-04-17 20:05:37 +0200282#ifdef CONFIG_CONSOLE_POLL
283
284/**
285 * tty_find_polling_driver - find device of a polled tty
286 * @name: name string to match
287 * @line: pointer to resulting tty line nr
288 *
289 * This routine returns a tty driver structure, given a name
290 * and the condition that the tty driver is capable of polled
291 * operation.
292 */
293struct tty_driver *tty_find_polling_driver(char *name, int *line)
294{
295 struct tty_driver *p, *res = NULL;
296 int tty_line = 0;
Jason Wessel0dca0fd2008-09-26 10:36:42 -0500297 int len;
Alan Cox5f0878a2009-06-11 12:46:41 +0100298 char *str, *stp;
Jason Wesself2d937f2008-04-17 20:05:37 +0200299
Jason Wessel0dca0fd2008-09-26 10:36:42 -0500300 for (str = name; *str; str++)
301 if ((*str >= '0' && *str <= '9') || *str == ',')
302 break;
303 if (!*str)
304 return NULL;
305
306 len = str - name;
307 tty_line = simple_strtoul(str, &str, 10);
308
Jason Wesself2d937f2008-04-17 20:05:37 +0200309 mutex_lock(&tty_mutex);
310 /* Search through the tty devices to look for a match */
311 list_for_each_entry(p, &tty_drivers, tty_drivers) {
Jason Wessel0dca0fd2008-09-26 10:36:42 -0500312 if (strncmp(name, p->name, len) != 0)
313 continue;
Alan Cox5f0878a2009-06-11 12:46:41 +0100314 stp = str;
315 if (*stp == ',')
316 stp++;
317 if (*stp == '\0')
318 stp = NULL;
Jason Wesself2d937f2008-04-17 20:05:37 +0200319
Alan Coxf34d7a52008-04-30 00:54:13 -0700320 if (tty_line >= 0 && tty_line <= p->num && p->ops &&
Alan Cox5f0878a2009-06-11 12:46:41 +0100321 p->ops->poll_init && !p->ops->poll_init(p, tty_line, stp)) {
Alan Cox7d7b93c2008-10-13 10:42:09 +0100322 res = tty_driver_kref_get(p);
Jason Wesself2d937f2008-04-17 20:05:37 +0200323 *line = tty_line;
324 break;
325 }
326 }
327 mutex_unlock(&tty_mutex);
328
329 return res;
330}
331EXPORT_SYMBOL_GPL(tty_find_polling_driver);
332#endif
333
Alan Coxaf9b8972006-08-27 01:24:01 -0700334/**
335 * tty_check_change - check for POSIX terminal changes
336 * @tty: tty to check
337 *
338 * If we try to write to, or set the state of, a terminal and we're
339 * not in the foreground, send a SIGTTOU. If the signal is blocked or
340 * ignored, go ahead and perform the operation. (POSIX 7.2)
341 *
Alan Cox978e5952008-04-30 00:53:59 -0700342 * Locking: ctrl_lock
Linus Torvalds1da177e2005-04-16 15:20:36 -0700343 */
Alan Coxaf9b8972006-08-27 01:24:01 -0700344
Alan Cox37bdfb02008-02-08 04:18:47 -0800345int tty_check_change(struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700346{
Alan Cox47f86832008-04-30 00:53:30 -0700347 unsigned long flags;
348 int ret = 0;
349
Linus Torvalds1da177e2005-04-16 15:20:36 -0700350 if (current->signal->tty != tty)
351 return 0;
Alan Cox47f86832008-04-30 00:53:30 -0700352
353 spin_lock_irqsave(&tty->ctrl_lock, flags);
354
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800355 if (!tty->pgrp) {
356 printk(KERN_WARNING "tty_check_change: tty->pgrp == NULL!\n");
Andrew Morton9ffee4c2008-05-14 16:05:58 -0700357 goto out_unlock;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700358 }
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800359 if (task_pgrp(current) == tty->pgrp)
Andrew Morton9ffee4c2008-05-14 16:05:58 -0700360 goto out_unlock;
361 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700362 if (is_ignored(SIGTTOU))
Alan Cox47f86832008-04-30 00:53:30 -0700363 goto out;
364 if (is_current_pgrp_orphaned()) {
365 ret = -EIO;
366 goto out;
367 }
Oleg Nesterov040b6362007-06-01 00:46:53 -0700368 kill_pgrp(task_pgrp(current), SIGTTOU, 1);
369 set_thread_flag(TIF_SIGPENDING);
Alan Cox47f86832008-04-30 00:53:30 -0700370 ret = -ERESTARTSYS;
371out:
Andrew Morton9ffee4c2008-05-14 16:05:58 -0700372 return ret;
373out_unlock:
Alan Cox47f86832008-04-30 00:53:30 -0700374 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
375 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700376}
377
378EXPORT_SYMBOL(tty_check_change);
379
Alan Cox37bdfb02008-02-08 04:18:47 -0800380static ssize_t hung_up_tty_read(struct file *file, char __user *buf,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700381 size_t count, loff_t *ppos)
382{
383 return 0;
384}
385
Alan Cox37bdfb02008-02-08 04:18:47 -0800386static ssize_t hung_up_tty_write(struct file *file, const char __user *buf,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700387 size_t count, loff_t *ppos)
388{
389 return -EIO;
390}
391
392/* No kernel lock held - none needed ;) */
Alan Cox37bdfb02008-02-08 04:18:47 -0800393static unsigned int hung_up_tty_poll(struct file *filp, poll_table *wait)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700394{
395 return POLLIN | POLLOUT | POLLERR | POLLHUP | POLLRDNORM | POLLWRNORM;
396}
397
Alan Cox04f378b2008-04-30 00:53:29 -0700398static long hung_up_tty_ioctl(struct file *file, unsigned int cmd,
399 unsigned long arg)
Paul Fulghum38ad2ed2007-06-16 10:15:55 -0700400{
401 return cmd == TIOCSPGRP ? -ENOTTY : -EIO;
402}
403
Alan Cox37bdfb02008-02-08 04:18:47 -0800404static long hung_up_tty_compat_ioctl(struct file *file,
Paul Fulghum38ad2ed2007-06-16 10:15:55 -0700405 unsigned int cmd, unsigned long arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700406{
407 return cmd == TIOCSPGRP ? -ENOTTY : -EIO;
408}
409
Arjan van de Ven62322d22006-07-03 00:24:21 -0700410static const struct file_operations tty_fops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700411 .llseek = no_llseek,
412 .read = tty_read,
413 .write = tty_write,
414 .poll = tty_poll,
Alan Cox04f378b2008-04-30 00:53:29 -0700415 .unlocked_ioctl = tty_ioctl,
Paul Fulghume10cc1d2007-05-10 22:22:50 -0700416 .compat_ioctl = tty_compat_ioctl,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700417 .open = tty_open,
418 .release = tty_release,
419 .fasync = tty_fasync,
420};
421
Arjan van de Ven62322d22006-07-03 00:24:21 -0700422static const struct file_operations console_fops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700423 .llseek = no_llseek,
424 .read = tty_read,
425 .write = redirected_tty_write,
426 .poll = tty_poll,
Alan Cox04f378b2008-04-30 00:53:29 -0700427 .unlocked_ioctl = tty_ioctl,
Paul Fulghume10cc1d2007-05-10 22:22:50 -0700428 .compat_ioctl = tty_compat_ioctl,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700429 .open = tty_open,
430 .release = tty_release,
431 .fasync = tty_fasync,
432};
433
Arjan van de Ven62322d22006-07-03 00:24:21 -0700434static const struct file_operations hung_up_tty_fops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700435 .llseek = no_llseek,
436 .read = hung_up_tty_read,
437 .write = hung_up_tty_write,
438 .poll = hung_up_tty_poll,
Alan Cox04f378b2008-04-30 00:53:29 -0700439 .unlocked_ioctl = hung_up_tty_ioctl,
Paul Fulghum38ad2ed2007-06-16 10:15:55 -0700440 .compat_ioctl = hung_up_tty_compat_ioctl,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700441 .release = tty_release,
442};
443
444static DEFINE_SPINLOCK(redirect_lock);
445static struct file *redirect;
446
447/**
448 * tty_wakeup - request more data
449 * @tty: terminal
450 *
451 * Internal and external helper for wakeups of tty. This function
452 * informs the line discipline if present that the driver is ready
453 * to receive more output data.
454 */
Alan Cox37bdfb02008-02-08 04:18:47 -0800455
Linus Torvalds1da177e2005-04-16 15:20:36 -0700456void tty_wakeup(struct tty_struct *tty)
457{
458 struct tty_ldisc *ld;
Alan Cox37bdfb02008-02-08 04:18:47 -0800459
Linus Torvalds1da177e2005-04-16 15:20:36 -0700460 if (test_bit(TTY_DO_WRITE_WAKEUP, &tty->flags)) {
461 ld = tty_ldisc_ref(tty);
Alan Cox37bdfb02008-02-08 04:18:47 -0800462 if (ld) {
Alan Coxa352def2008-07-16 21:53:12 +0100463 if (ld->ops->write_wakeup)
464 ld->ops->write_wakeup(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700465 tty_ldisc_deref(ld);
466 }
467 }
Davide Libenzi4b194492009-03-31 15:24:24 -0700468 wake_up_interruptible_poll(&tty->write_wait, POLLOUT);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700469}
470
471EXPORT_SYMBOL_GPL(tty_wakeup);
472
473/**
474 * tty_ldisc_flush - flush line discipline queue
475 * @tty: tty
476 *
477 * Flush the line discipline queue (if any) for this tty. If there
478 * is no line discipline active this is a no-op.
479 */
Alan Cox37bdfb02008-02-08 04:18:47 -0800480
Linus Torvalds1da177e2005-04-16 15:20:36 -0700481void tty_ldisc_flush(struct tty_struct *tty)
482{
483 struct tty_ldisc *ld = tty_ldisc_ref(tty);
Alan Cox37bdfb02008-02-08 04:18:47 -0800484 if (ld) {
Alan Coxa352def2008-07-16 21:53:12 +0100485 if (ld->ops->flush_buffer)
486 ld->ops->flush_buffer(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700487 tty_ldisc_deref(ld);
488 }
Paul Fulghumc5c34d42007-05-12 10:36:55 -0700489 tty_buffer_flush(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700490}
491
492EXPORT_SYMBOL_GPL(tty_ldisc_flush);
Alan Coxedc6afc2006-12-08 02:38:44 -0800493
494/**
495 * tty_reset_termios - reset terminal state
496 * @tty: tty to reset
497 *
498 * Restore a terminal to the driver default state
499 */
500
501static void tty_reset_termios(struct tty_struct *tty)
502{
503 mutex_lock(&tty->termios_mutex);
504 *tty->termios = tty->driver->init_termios;
505 tty->termios->c_ispeed = tty_termios_input_baud_rate(tty->termios);
506 tty->termios->c_ospeed = tty_termios_baud_rate(tty->termios);
507 mutex_unlock(&tty->termios_mutex);
508}
Alan Cox37bdfb02008-02-08 04:18:47 -0800509
Alan Coxaf9b8972006-08-27 01:24:01 -0700510/**
511 * do_tty_hangup - actual handler for hangup events
David Howells65f27f32006-11-22 14:55:48 +0000512 * @work: tty device
Alan Coxaf9b8972006-08-27 01:24:01 -0700513 *
Alan Cox1bad8792008-07-22 23:38:04 +0100514 * This can be called by the "eventd" kernel thread. That is process
Alan Coxaf9b8972006-08-27 01:24:01 -0700515 * synchronous but doesn't hold any locks, so we need to make sure we
516 * have the appropriate locks for what we're doing.
517 *
518 * The hangup event clears any pending redirections onto the hung up
519 * device. It ensures future writes will error and it does the needed
520 * line discipline hangup and signal delivery. The tty object itself
521 * remains intact.
522 *
523 * Locking:
524 * BKL
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800525 * redirect lock for undoing redirection
526 * file list lock for manipulating list of ttys
527 * tty_ldisc_lock from called functions
528 * termios_mutex resetting termios data
529 * tasklist_lock to walk task list for hangup event
530 * ->siglock to protect ->signal/->sighand
Linus Torvalds1da177e2005-04-16 15:20:36 -0700531 */
David Howells65f27f32006-11-22 14:55:48 +0000532static void do_tty_hangup(struct work_struct *work)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700533{
David Howells65f27f32006-11-22 14:55:48 +0000534 struct tty_struct *tty =
535 container_of(work, struct tty_struct, hangup_work);
Alan Cox37bdfb02008-02-08 04:18:47 -0800536 struct file *cons_filp = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700537 struct file *filp, *f = NULL;
538 struct task_struct *p;
539 struct tty_ldisc *ld;
540 int closecount = 0, n;
Alan Cox47f86832008-04-30 00:53:30 -0700541 unsigned long flags;
Alan Cox9c9f4de2008-10-13 10:37:26 +0100542 int refs = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700543
544 if (!tty)
545 return;
546
547 /* inuse_filps is protected by the single kernel lock */
548 lock_kernel();
549
550 spin_lock(&redirect_lock);
551 if (redirect && redirect->private_data == tty) {
552 f = redirect;
553 redirect = NULL;
554 }
555 spin_unlock(&redirect_lock);
Alan Cox37bdfb02008-02-08 04:18:47 -0800556
Linus Torvalds1da177e2005-04-16 15:20:36 -0700557 check_tty_count(tty, "do_tty_hangup");
558 file_list_lock();
559 /* This breaks for file handles being sent over AF_UNIX sockets ? */
Eric Dumazet2f512012005-10-30 15:02:16 -0800560 list_for_each_entry(filp, &tty->tty_files, f_u.fu_list) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700561 if (filp->f_op->write == redirected_tty_write)
562 cons_filp = filp;
563 if (filp->f_op->write != tty_write)
564 continue;
565 closecount++;
566 tty_fasync(-1, filp, 0); /* can't block */
567 filp->f_op = &hung_up_tty_fops;
568 }
569 file_list_unlock();
Alan Cox37bdfb02008-02-08 04:18:47 -0800570 /*
571 * FIXME! What are the locking issues here? This may me overdoing
572 * things... This question is especially important now that we've
573 * removed the irqlock.
574 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700575 ld = tty_ldisc_ref(tty);
Alan Cox37bdfb02008-02-08 04:18:47 -0800576 if (ld != NULL) {
577 /* We may have no line discipline at this point */
Alan Coxa352def2008-07-16 21:53:12 +0100578 if (ld->ops->flush_buffer)
579 ld->ops->flush_buffer(tty);
Alan Coxf34d7a52008-04-30 00:54:13 -0700580 tty_driver_flush_buffer(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700581 if ((test_bit(TTY_DO_WRITE_WAKEUP, &tty->flags)) &&
Alan Coxa352def2008-07-16 21:53:12 +0100582 ld->ops->write_wakeup)
583 ld->ops->write_wakeup(tty);
584 if (ld->ops->hangup)
585 ld->ops->hangup(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700586 }
Alan Cox37bdfb02008-02-08 04:18:47 -0800587 /*
588 * FIXME: Once we trust the LDISC code better we can wait here for
589 * ldisc completion and fix the driver call race
590 */
Davide Libenzi4b194492009-03-31 15:24:24 -0700591 wake_up_interruptible_poll(&tty->write_wait, POLLOUT);
592 wake_up_interruptible_poll(&tty->read_wait, POLLIN);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700593 /*
594 * Shutdown the current line discipline, and reset it to
595 * N_TTY.
596 */
597 if (tty->driver->flags & TTY_DRIVER_RESET_TERMIOS)
Alan Coxedc6afc2006-12-08 02:38:44 -0800598 tty_reset_termios(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700599 /* Defer ldisc switch */
600 /* tty_deferred_ldisc_switch(N_TTY);
Alan Cox37bdfb02008-02-08 04:18:47 -0800601
Linus Torvalds1da177e2005-04-16 15:20:36 -0700602 This should get done automatically when the port closes and
603 tty_release is called */
Alan Cox37bdfb02008-02-08 04:18:47 -0800604
Linus Torvalds1da177e2005-04-16 15:20:36 -0700605 read_lock(&tasklist_lock);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800606 if (tty->session) {
607 do_each_pid_task(tty->session, PIDTYPE_SID, p) {
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800608 spin_lock_irq(&p->sighand->siglock);
Alan Cox9c9f4de2008-10-13 10:37:26 +0100609 if (p->signal->tty == tty) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700610 p->signal->tty = NULL;
Alan Cox9c9f4de2008-10-13 10:37:26 +0100611 /* We defer the dereferences outside fo
612 the tasklist lock */
613 refs++;
614 }
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800615 if (!p->signal->leader) {
616 spin_unlock_irq(&p->sighand->siglock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700617 continue;
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800618 }
619 __group_send_sig_info(SIGHUP, SEND_SIG_PRIV, p);
620 __group_send_sig_info(SIGCONT, SEND_SIG_PRIV, p);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800621 put_pid(p->signal->tty_old_pgrp); /* A noop */
Alan Cox47f86832008-04-30 00:53:30 -0700622 spin_lock_irqsave(&tty->ctrl_lock, flags);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800623 if (tty->pgrp)
624 p->signal->tty_old_pgrp = get_pid(tty->pgrp);
Alan Cox47f86832008-04-30 00:53:30 -0700625 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800626 spin_unlock_irq(&p->sighand->siglock);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800627 } while_each_pid_task(tty->session, PIDTYPE_SID, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700628 }
629 read_unlock(&tasklist_lock);
630
Alan Cox47f86832008-04-30 00:53:30 -0700631 spin_lock_irqsave(&tty->ctrl_lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700632 tty->flags = 0;
Eric W. Biedermand9c1e9a2007-03-18 12:45:44 -0600633 put_pid(tty->session);
634 put_pid(tty->pgrp);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800635 tty->session = NULL;
636 tty->pgrp = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700637 tty->ctrl_status = 0;
Alan Cox47f86832008-04-30 00:53:30 -0700638 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
639
Alan Cox9c9f4de2008-10-13 10:37:26 +0100640 /* Account for the p->signal references we killed */
641 while (refs--)
642 tty_kref_put(tty);
643
Linus Torvalds1da177e2005-04-16 15:20:36 -0700644 /*
Alan Cox37bdfb02008-02-08 04:18:47 -0800645 * If one of the devices matches a console pointer, we
646 * cannot just call hangup() because that will cause
647 * tty->count and state->count to go out of sync.
648 * So we just call close() the right number of times.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700649 */
650 if (cons_filp) {
Alan Coxf34d7a52008-04-30 00:54:13 -0700651 if (tty->ops->close)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700652 for (n = 0; n < closecount; n++)
Alan Coxf34d7a52008-04-30 00:54:13 -0700653 tty->ops->close(tty, cons_filp);
654 } else if (tty->ops->hangup)
655 (tty->ops->hangup)(tty);
Alan Cox37bdfb02008-02-08 04:18:47 -0800656 /*
657 * We don't want to have driver/ldisc interactions beyond
658 * the ones we did here. The driver layer expects no
659 * calls after ->hangup() from the ldisc side. However we
660 * can't yet guarantee all that.
661 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700662 set_bit(TTY_HUPPED, &tty->flags);
663 if (ld) {
664 tty_ldisc_enable(tty);
665 tty_ldisc_deref(ld);
666 }
667 unlock_kernel();
668 if (f)
669 fput(f);
670}
671
Alan Coxaf9b8972006-08-27 01:24:01 -0700672/**
673 * tty_hangup - trigger a hangup event
674 * @tty: tty to hangup
675 *
676 * A carrier loss (virtual or otherwise) has occurred on this like
677 * schedule a hangup sequence to run after this event.
678 */
679
Alan Cox37bdfb02008-02-08 04:18:47 -0800680void tty_hangup(struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700681{
682#ifdef TTY_DEBUG_HANGUP
683 char buf[64];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700684 printk(KERN_DEBUG "%s hangup...\n", tty_name(tty, buf));
685#endif
686 schedule_work(&tty->hangup_work);
687}
688
689EXPORT_SYMBOL(tty_hangup);
690
Alan Coxaf9b8972006-08-27 01:24:01 -0700691/**
692 * tty_vhangup - process vhangup
693 * @tty: tty to hangup
694 *
695 * The user has asked via system call for the terminal to be hung up.
696 * We do this synchronously so that when the syscall returns the process
Robert P. J. Day3a4fa0a2007-10-19 23:10:43 +0200697 * is complete. That guarantee is necessary for security reasons.
Alan Coxaf9b8972006-08-27 01:24:01 -0700698 */
699
Alan Cox37bdfb02008-02-08 04:18:47 -0800700void tty_vhangup(struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700701{
702#ifdef TTY_DEBUG_HANGUP
703 char buf[64];
704
705 printk(KERN_DEBUG "%s vhangup...\n", tty_name(tty, buf));
706#endif
David Howells65f27f32006-11-22 14:55:48 +0000707 do_tty_hangup(&tty->hangup_work);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700708}
Alan Cox37bdfb02008-02-08 04:18:47 -0800709
Linus Torvalds1da177e2005-04-16 15:20:36 -0700710EXPORT_SYMBOL(tty_vhangup);
711
Alan Coxaf9b8972006-08-27 01:24:01 -0700712/**
Alan Cox2cb59982008-10-13 10:40:30 +0100713 * tty_vhangup_self - process vhangup for own ctty
714 *
715 * Perform a vhangup on the current controlling tty
716 */
717
718void tty_vhangup_self(void)
719{
720 struct tty_struct *tty;
721
Alan Cox2cb59982008-10-13 10:40:30 +0100722 tty = get_current_tty();
723 if (tty) {
724 tty_vhangup(tty);
725 tty_kref_put(tty);
726 }
Alan Cox2cb59982008-10-13 10:40:30 +0100727}
728
729/**
Alan Coxaf9b8972006-08-27 01:24:01 -0700730 * tty_hung_up_p - was tty hung up
731 * @filp: file pointer of tty
732 *
733 * Return true if the tty has been subject to a vhangup or a carrier
734 * loss
735 */
736
Alan Cox37bdfb02008-02-08 04:18:47 -0800737int tty_hung_up_p(struct file *filp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700738{
739 return (filp->f_op == &hung_up_tty_fops);
740}
741
742EXPORT_SYMBOL(tty_hung_up_p);
743
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800744static void session_clear_tty(struct pid *session)
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800745{
746 struct task_struct *p;
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800747 do_each_pid_task(session, PIDTYPE_SID, p) {
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800748 proc_clear_tty(p);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800749 } while_each_pid_task(session, PIDTYPE_SID, p);
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800750}
751
Alan Coxaf9b8972006-08-27 01:24:01 -0700752/**
753 * disassociate_ctty - disconnect controlling tty
754 * @on_exit: true if exiting so need to "hang up" the session
Linus Torvalds1da177e2005-04-16 15:20:36 -0700755 *
Alan Coxaf9b8972006-08-27 01:24:01 -0700756 * This function is typically called only by the session leader, when
757 * it wants to disassociate itself from its controlling tty.
758 *
759 * It performs the following functions:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700760 * (1) Sends a SIGHUP and SIGCONT to the foreground process group
761 * (2) Clears the tty from being controlling the session
762 * (3) Clears the controlling tty for all processes in the
763 * session group.
764 *
Alan Coxaf9b8972006-08-27 01:24:01 -0700765 * The argument on_exit is set to 1 if called when a process is
766 * exiting; it is 0 if called by the ioctl TIOCNOTTY.
767 *
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800768 * Locking:
Alan Coxaf9b8972006-08-27 01:24:01 -0700769 * BKL is taken for hysterical raisins
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800770 * tty_mutex is taken to protect tty
771 * ->siglock is taken to protect ->signal/->sighand
772 * tasklist_lock is taken to walk process list for sessions
773 * ->siglock is taken to protect ->signal/->sighand
Linus Torvalds1da177e2005-04-16 15:20:36 -0700774 */
Alan Coxaf9b8972006-08-27 01:24:01 -0700775
Linus Torvalds1da177e2005-04-16 15:20:36 -0700776void disassociate_ctty(int on_exit)
777{
778 struct tty_struct *tty;
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800779 struct pid *tty_pgrp = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700780
Linus Torvalds1da177e2005-04-16 15:20:36 -0700781
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800782 tty = get_current_tty();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700783 if (tty) {
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800784 tty_pgrp = get_pid(tty->pgrp);
Alan Cox452a00d2008-10-13 10:39:13 +0100785 lock_kernel();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700786 if (on_exit && tty->driver->type != TTY_DRIVER_TYPE_PTY)
787 tty_vhangup(tty);
Alan Cox04f378b2008-04-30 00:53:29 -0700788 unlock_kernel();
Alan Cox452a00d2008-10-13 10:39:13 +0100789 tty_kref_put(tty);
Eric W. Biederman680a9672007-02-12 00:52:52 -0800790 } else if (on_exit) {
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800791 struct pid *old_pgrp;
Eric W. Biederman680a9672007-02-12 00:52:52 -0800792 spin_lock_irq(&current->sighand->siglock);
793 old_pgrp = current->signal->tty_old_pgrp;
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800794 current->signal->tty_old_pgrp = NULL;
Eric W. Biederman680a9672007-02-12 00:52:52 -0800795 spin_unlock_irq(&current->sighand->siglock);
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800796 if (old_pgrp) {
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800797 kill_pgrp(old_pgrp, SIGHUP, on_exit);
798 kill_pgrp(old_pgrp, SIGCONT, on_exit);
799 put_pid(old_pgrp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700800 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700801 return;
802 }
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800803 if (tty_pgrp) {
804 kill_pgrp(tty_pgrp, SIGHUP, on_exit);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700805 if (!on_exit)
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800806 kill_pgrp(tty_pgrp, SIGCONT, on_exit);
807 put_pid(tty_pgrp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700808 }
809
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800810 spin_lock_irq(&current->sighand->siglock);
Eric W. Biederman2a65f1d2007-05-08 00:26:53 -0700811 put_pid(current->signal->tty_old_pgrp);
Randy Dunlap23cac8d2007-02-20 13:58:05 -0800812 current->signal->tty_old_pgrp = NULL;
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800813 spin_unlock_irq(&current->sighand->siglock);
814
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800815 tty = get_current_tty();
816 if (tty) {
Alan Cox47f86832008-04-30 00:53:30 -0700817 unsigned long flags;
818 spin_lock_irqsave(&tty->ctrl_lock, flags);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800819 put_pid(tty->session);
820 put_pid(tty->pgrp);
821 tty->session = NULL;
822 tty->pgrp = NULL;
Alan Cox47f86832008-04-30 00:53:30 -0700823 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
Alan Cox452a00d2008-10-13 10:39:13 +0100824 tty_kref_put(tty);
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800825 } else {
826#ifdef TTY_DEBUG_HANGUP
827 printk(KERN_DEBUG "error attempted to write to tty [0x%p]"
828 " = NULL", tty);
829#endif
830 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700831
832 /* Now clear signal->tty under the lock */
833 read_lock(&tasklist_lock);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800834 session_clear_tty(task_session(current));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700835 read_unlock(&tasklist_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700836}
837
Eric W. Biederman98a27ba2007-05-08 00:26:56 -0700838/**
839 *
840 * no_tty - Ensure the current process does not have a controlling tty
841 */
842void no_tty(void)
843{
844 struct task_struct *tsk = current;
Alan Cox04f378b2008-04-30 00:53:29 -0700845 lock_kernel();
Eric W. Biederman98a27ba2007-05-08 00:26:56 -0700846 if (tsk->signal->leader)
847 disassociate_ctty(0);
Alan Cox04f378b2008-04-30 00:53:29 -0700848 unlock_kernel();
Eric W. Biederman98a27ba2007-05-08 00:26:56 -0700849 proc_clear_tty(tsk);
850}
851
Alan Coxaf9b8972006-08-27 01:24:01 -0700852
853/**
Robert P. J. Daybeb7dd82007-05-09 07:14:03 +0200854 * stop_tty - propagate flow control
Alan Coxaf9b8972006-08-27 01:24:01 -0700855 * @tty: tty to stop
856 *
857 * Perform flow control to the driver. For PTY/TTY pairs we
Robert P. J. Daybeb7dd82007-05-09 07:14:03 +0200858 * must also propagate the TIOCKPKT status. May be called
Alan Coxaf9b8972006-08-27 01:24:01 -0700859 * on an already stopped device and will not re-call the driver
860 * method.
861 *
862 * This functionality is used by both the line disciplines for
863 * halting incoming flow and by the driver. It may therefore be
864 * called from any context, may be under the tty atomic_write_lock
865 * but not always.
866 *
867 * Locking:
Alan Cox04f378b2008-04-30 00:53:29 -0700868 * Uses the tty control lock internally
Alan Coxaf9b8972006-08-27 01:24:01 -0700869 */
870
Linus Torvalds1da177e2005-04-16 15:20:36 -0700871void stop_tty(struct tty_struct *tty)
872{
Alan Cox04f378b2008-04-30 00:53:29 -0700873 unsigned long flags;
874 spin_lock_irqsave(&tty->ctrl_lock, flags);
875 if (tty->stopped) {
876 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700877 return;
Alan Cox04f378b2008-04-30 00:53:29 -0700878 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700879 tty->stopped = 1;
880 if (tty->link && tty->link->packet) {
881 tty->ctrl_status &= ~TIOCPKT_START;
882 tty->ctrl_status |= TIOCPKT_STOP;
Davide Libenzi4b194492009-03-31 15:24:24 -0700883 wake_up_interruptible_poll(&tty->link->read_wait, POLLIN);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700884 }
Alan Cox04f378b2008-04-30 00:53:29 -0700885 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
Alan Coxf34d7a52008-04-30 00:54:13 -0700886 if (tty->ops->stop)
887 (tty->ops->stop)(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700888}
889
890EXPORT_SYMBOL(stop_tty);
891
Alan Coxaf9b8972006-08-27 01:24:01 -0700892/**
Robert P. J. Daybeb7dd82007-05-09 07:14:03 +0200893 * start_tty - propagate flow control
Alan Coxaf9b8972006-08-27 01:24:01 -0700894 * @tty: tty to start
895 *
896 * Start a tty that has been stopped if at all possible. Perform
Robert P. J. Day3a4fa0a2007-10-19 23:10:43 +0200897 * any necessary wakeups and propagate the TIOCPKT status. If this
Alan Coxaf9b8972006-08-27 01:24:01 -0700898 * is the tty was previous stopped and is being started then the
899 * driver start method is invoked and the line discipline woken.
900 *
901 * Locking:
Alan Cox04f378b2008-04-30 00:53:29 -0700902 * ctrl_lock
Alan Coxaf9b8972006-08-27 01:24:01 -0700903 */
904
Linus Torvalds1da177e2005-04-16 15:20:36 -0700905void start_tty(struct tty_struct *tty)
906{
Alan Cox04f378b2008-04-30 00:53:29 -0700907 unsigned long flags;
908 spin_lock_irqsave(&tty->ctrl_lock, flags);
909 if (!tty->stopped || tty->flow_stopped) {
910 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700911 return;
Alan Cox04f378b2008-04-30 00:53:29 -0700912 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700913 tty->stopped = 0;
914 if (tty->link && tty->link->packet) {
915 tty->ctrl_status &= ~TIOCPKT_STOP;
916 tty->ctrl_status |= TIOCPKT_START;
Davide Libenzi4b194492009-03-31 15:24:24 -0700917 wake_up_interruptible_poll(&tty->link->read_wait, POLLIN);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700918 }
Alan Cox04f378b2008-04-30 00:53:29 -0700919 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
Alan Coxf34d7a52008-04-30 00:54:13 -0700920 if (tty->ops->start)
921 (tty->ops->start)(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700922 /* If we have a running line discipline it may need kicking */
923 tty_wakeup(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700924}
925
926EXPORT_SYMBOL(start_tty);
927
Alan Coxaf9b8972006-08-27 01:24:01 -0700928/**
929 * tty_read - read method for tty device files
930 * @file: pointer to tty file
931 * @buf: user buffer
932 * @count: size of user buffer
933 * @ppos: unused
934 *
935 * Perform the read system call function on this terminal device. Checks
936 * for hung up devices before calling the line discipline method.
937 *
938 * Locking:
Alan Cox47f86832008-04-30 00:53:30 -0700939 * Locks the line discipline internally while needed. Multiple
940 * read calls may be outstanding in parallel.
Alan Coxaf9b8972006-08-27 01:24:01 -0700941 */
942
Alan Cox37bdfb02008-02-08 04:18:47 -0800943static ssize_t tty_read(struct file *file, char __user *buf, size_t count,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700944 loff_t *ppos)
945{
946 int i;
Alan Cox37bdfb02008-02-08 04:18:47 -0800947 struct tty_struct *tty;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700948 struct inode *inode;
949 struct tty_ldisc *ld;
950
951 tty = (struct tty_struct *)file->private_data;
Josef Sipeka7113a92006-12-08 02:36:55 -0800952 inode = file->f_path.dentry->d_inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700953 if (tty_paranoia_check(tty, inode, "tty_read"))
954 return -EIO;
955 if (!tty || (test_bit(TTY_IO_ERROR, &tty->flags)))
956 return -EIO;
957
958 /* We want to wait for the line discipline to sort out in this
959 situation */
960 ld = tty_ldisc_ref_wait(tty);
Alan Coxa352def2008-07-16 21:53:12 +0100961 if (ld->ops->read)
962 i = (ld->ops->read)(tty, file, buf, count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700963 else
964 i = -EIO;
965 tty_ldisc_deref(ld);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700966 if (i > 0)
967 inode->i_atime = current_fs_time(inode->i_sb);
968 return i;
969}
970
Alan Cox9c1729d2007-07-15 23:39:43 -0700971void tty_write_unlock(struct tty_struct *tty)
972{
973 mutex_unlock(&tty->atomic_write_lock);
Davide Libenzi4b194492009-03-31 15:24:24 -0700974 wake_up_interruptible_poll(&tty->write_wait, POLLOUT);
Alan Cox9c1729d2007-07-15 23:39:43 -0700975}
976
977int tty_write_lock(struct tty_struct *tty, int ndelay)
978{
979 if (!mutex_trylock(&tty->atomic_write_lock)) {
980 if (ndelay)
981 return -EAGAIN;
982 if (mutex_lock_interruptible(&tty->atomic_write_lock))
983 return -ERESTARTSYS;
984 }
985 return 0;
986}
987
Linus Torvalds1da177e2005-04-16 15:20:36 -0700988/*
989 * Split writes up in sane blocksizes to avoid
990 * denial-of-service type attacks
991 */
992static inline ssize_t do_tty_write(
993 ssize_t (*write)(struct tty_struct *, struct file *, const unsigned char *, size_t),
994 struct tty_struct *tty,
995 struct file *file,
996 const char __user *buf,
997 size_t count)
998{
Alan Cox9c1729d2007-07-15 23:39:43 -0700999 ssize_t ret, written = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001000 unsigned int chunk;
Alan Cox37bdfb02008-02-08 04:18:47 -08001001
Alan Cox9c1729d2007-07-15 23:39:43 -07001002 ret = tty_write_lock(tty, file->f_flags & O_NDELAY);
1003 if (ret < 0)
1004 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001005
1006 /*
1007 * We chunk up writes into a temporary buffer. This
1008 * simplifies low-level drivers immensely, since they
1009 * don't have locking issues and user mode accesses.
1010 *
1011 * But if TTY_NO_WRITE_SPLIT is set, we should use a
1012 * big chunk-size..
1013 *
1014 * The default chunk-size is 2kB, because the NTTY
1015 * layer has problems with bigger chunks. It will
1016 * claim to be able to handle more characters than
1017 * it actually does.
Alan Coxaf9b8972006-08-27 01:24:01 -07001018 *
1019 * FIXME: This can probably go away now except that 64K chunks
1020 * are too likely to fail unless switched to vmalloc...
Linus Torvalds1da177e2005-04-16 15:20:36 -07001021 */
1022 chunk = 2048;
1023 if (test_bit(TTY_NO_WRITE_SPLIT, &tty->flags))
1024 chunk = 65536;
1025 if (count < chunk)
1026 chunk = count;
1027
Ingo Molnar70522e12006-03-23 03:00:31 -08001028 /* write_buf/write_cnt is protected by the atomic_write_lock mutex */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001029 if (tty->write_cnt < chunk) {
Jason Wessel402fda92008-10-13 10:45:36 +01001030 unsigned char *buf_chunk;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001031
1032 if (chunk < 1024)
1033 chunk = 1024;
1034
Jason Wessel402fda92008-10-13 10:45:36 +01001035 buf_chunk = kmalloc(chunk, GFP_KERNEL);
1036 if (!buf_chunk) {
Alan Cox9c1729d2007-07-15 23:39:43 -07001037 ret = -ENOMEM;
1038 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001039 }
1040 kfree(tty->write_buf);
1041 tty->write_cnt = chunk;
Jason Wessel402fda92008-10-13 10:45:36 +01001042 tty->write_buf = buf_chunk;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001043 }
1044
1045 /* Do the write .. */
1046 for (;;) {
1047 size_t size = count;
1048 if (size > chunk)
1049 size = chunk;
1050 ret = -EFAULT;
1051 if (copy_from_user(tty->write_buf, buf, size))
1052 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001053 ret = write(tty, file, tty->write_buf, size);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001054 if (ret <= 0)
1055 break;
1056 written += ret;
1057 buf += ret;
1058 count -= ret;
1059 if (!count)
1060 break;
1061 ret = -ERESTARTSYS;
1062 if (signal_pending(current))
1063 break;
1064 cond_resched();
1065 }
1066 if (written) {
Josef Sipeka7113a92006-12-08 02:36:55 -08001067 struct inode *inode = file->f_path.dentry->d_inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001068 inode->i_mtime = current_fs_time(inode->i_sb);
1069 ret = written;
1070 }
Alan Cox9c1729d2007-07-15 23:39:43 -07001071out:
1072 tty_write_unlock(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001073 return ret;
1074}
1075
Alan Cox95f9bfc2008-10-13 10:39:23 +01001076/**
1077 * tty_write_message - write a message to a certain tty, not just the console.
1078 * @tty: the destination tty_struct
1079 * @msg: the message to write
1080 *
1081 * This is used for messages that need to be redirected to a specific tty.
1082 * We don't put it into the syslog queue right now maybe in the future if
1083 * really needed.
1084 *
1085 * We must still hold the BKL and test the CLOSING flag for the moment.
1086 */
1087
1088void tty_write_message(struct tty_struct *tty, char *msg)
1089{
1090 lock_kernel();
1091 if (tty) {
1092 mutex_lock(&tty->atomic_write_lock);
1093 if (tty->ops->write && !test_bit(TTY_CLOSING, &tty->flags))
1094 tty->ops->write(tty, msg, strlen(msg));
1095 tty_write_unlock(tty);
1096 }
1097 unlock_kernel();
1098 return;
1099}
1100
Linus Torvalds1da177e2005-04-16 15:20:36 -07001101
Alan Coxaf9b8972006-08-27 01:24:01 -07001102/**
1103 * tty_write - write method for tty device file
1104 * @file: tty file pointer
1105 * @buf: user data to write
1106 * @count: bytes to write
1107 * @ppos: unused
1108 *
1109 * Write data to a tty device via the line discipline.
1110 *
1111 * Locking:
1112 * Locks the line discipline as required
1113 * Writes to the tty driver are serialized by the atomic_write_lock
1114 * and are then processed in chunks to the device. The line discipline
Joe Petersona88a69c2009-01-02 13:40:53 +00001115 * write method will not be invoked in parallel for each device.
Alan Coxaf9b8972006-08-27 01:24:01 -07001116 */
1117
Alan Cox37bdfb02008-02-08 04:18:47 -08001118static ssize_t tty_write(struct file *file, const char __user *buf,
1119 size_t count, loff_t *ppos)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001120{
Alan Cox37bdfb02008-02-08 04:18:47 -08001121 struct tty_struct *tty;
Josef Sipeka7113a92006-12-08 02:36:55 -08001122 struct inode *inode = file->f_path.dentry->d_inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001123 ssize_t ret;
1124 struct tty_ldisc *ld;
Alan Cox37bdfb02008-02-08 04:18:47 -08001125
Linus Torvalds1da177e2005-04-16 15:20:36 -07001126 tty = (struct tty_struct *)file->private_data;
1127 if (tty_paranoia_check(tty, inode, "tty_write"))
1128 return -EIO;
Alan Coxf34d7a52008-04-30 00:54:13 -07001129 if (!tty || !tty->ops->write ||
Alan Cox37bdfb02008-02-08 04:18:47 -08001130 (test_bit(TTY_IO_ERROR, &tty->flags)))
1131 return -EIO;
Alan Coxf34d7a52008-04-30 00:54:13 -07001132 /* Short term debug to catch buggy drivers */
1133 if (tty->ops->write_room == NULL)
1134 printk(KERN_ERR "tty driver %s lacks a write_room method.\n",
1135 tty->driver->name);
Alan Cox37bdfb02008-02-08 04:18:47 -08001136 ld = tty_ldisc_ref_wait(tty);
Alan Coxa352def2008-07-16 21:53:12 +01001137 if (!ld->ops->write)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001138 ret = -EIO;
1139 else
Alan Coxa352def2008-07-16 21:53:12 +01001140 ret = do_tty_write(ld->ops->write, tty, file, buf, count);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001141 tty_ldisc_deref(ld);
1142 return ret;
1143}
1144
Alan Cox37bdfb02008-02-08 04:18:47 -08001145ssize_t redirected_tty_write(struct file *file, const char __user *buf,
1146 size_t count, loff_t *ppos)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001147{
1148 struct file *p = NULL;
1149
1150 spin_lock(&redirect_lock);
1151 if (redirect) {
1152 get_file(redirect);
1153 p = redirect;
1154 }
1155 spin_unlock(&redirect_lock);
1156
1157 if (p) {
1158 ssize_t res;
1159 res = vfs_write(p, buf, count, &p->f_pos);
1160 fput(p);
1161 return res;
1162 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001163 return tty_write(file, buf, count, ppos);
1164}
1165
1166static char ptychar[] = "pqrstuvwxyzabcde";
1167
Alan Coxaf9b8972006-08-27 01:24:01 -07001168/**
1169 * pty_line_name - generate name for a pty
1170 * @driver: the tty driver in use
1171 * @index: the minor number
1172 * @p: output buffer of at least 6 bytes
1173 *
1174 * Generate a name from a driver reference and write it to the output
1175 * buffer.
1176 *
1177 * Locking: None
1178 */
1179static void pty_line_name(struct tty_driver *driver, int index, char *p)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001180{
1181 int i = index + driver->name_base;
1182 /* ->name is initialized to "ttyp", but "tty" is expected */
1183 sprintf(p, "%s%c%x",
Alan Cox37bdfb02008-02-08 04:18:47 -08001184 driver->subtype == PTY_TYPE_SLAVE ? "tty" : driver->name,
1185 ptychar[i >> 4 & 0xf], i & 0xf);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001186}
1187
Alan Coxaf9b8972006-08-27 01:24:01 -07001188/**
Alan Cox8b0a88d2008-10-13 10:42:19 +01001189 * tty_line_name - generate name for a tty
Alan Coxaf9b8972006-08-27 01:24:01 -07001190 * @driver: the tty driver in use
1191 * @index: the minor number
1192 * @p: output buffer of at least 7 bytes
1193 *
1194 * Generate a name from a driver reference and write it to the output
1195 * buffer.
1196 *
1197 * Locking: None
1198 */
1199static void tty_line_name(struct tty_driver *driver, int index, char *p)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001200{
1201 sprintf(p, "%s%d", driver->name, index + driver->name_base);
1202}
1203
Alan Cox99f1fe12008-10-13 10:42:00 +01001204/**
1205 * tty_driver_lookup_tty() - find an existing tty, if any
1206 * @driver: the driver for the tty
1207 * @idx: the minor number
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001208 *
Alan Cox99f1fe12008-10-13 10:42:00 +01001209 * Return the tty, if found or ERR_PTR() otherwise.
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001210 *
Alan Cox99f1fe12008-10-13 10:42:00 +01001211 * Locking: tty_mutex must be held. If tty is found, the mutex must
1212 * be held until the 'fast-open' is also done. Will change once we
1213 * have refcounting in the driver and per driver locking
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001214 */
Jason Wessela47d5452009-01-02 13:43:04 +00001215static struct tty_struct *tty_driver_lookup_tty(struct tty_driver *driver,
Sukadev Bhattiprolu15f1a632008-10-13 10:42:59 +01001216 struct inode *inode, int idx)
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001217{
1218 struct tty_struct *tty;
1219
Alan Cox99f1fe12008-10-13 10:42:00 +01001220 if (driver->ops->lookup)
Sukadev Bhattiprolu15f1a632008-10-13 10:42:59 +01001221 return driver->ops->lookup(driver, inode, idx);
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001222
Alan Cox8b0a88d2008-10-13 10:42:19 +01001223 tty = driver->ttys[idx];
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001224 return tty;
1225}
1226
Alan Cox99f1fe12008-10-13 10:42:00 +01001227/**
Alan Coxbf970ee2008-10-13 10:42:39 +01001228 * tty_init_termios - helper for termios setup
1229 * @tty: the tty to set up
1230 *
1231 * Initialise the termios structures for this tty. Thus runs under
1232 * the tty_mutex currently so we can be relaxed about ordering.
1233 */
1234
1235int tty_init_termios(struct tty_struct *tty)
1236{
Alan Coxfe6e29f2008-10-13 10:44:08 +01001237 struct ktermios *tp;
Alan Coxbf970ee2008-10-13 10:42:39 +01001238 int idx = tty->index;
1239
1240 tp = tty->driver->termios[idx];
Alan Coxbf970ee2008-10-13 10:42:39 +01001241 if (tp == NULL) {
Alan Coxfe6e29f2008-10-13 10:44:08 +01001242 tp = kzalloc(sizeof(struct ktermios[2]), GFP_KERNEL);
1243 if (tp == NULL)
Alan Coxbf970ee2008-10-13 10:42:39 +01001244 return -ENOMEM;
Alan Coxbf970ee2008-10-13 10:42:39 +01001245 memcpy(tp, &tty->driver->init_termios,
1246 sizeof(struct ktermios));
1247 tty->driver->termios[idx] = tp;
Alan Coxbf970ee2008-10-13 10:42:39 +01001248 }
1249 tty->termios = tp;
Alan Coxfe6e29f2008-10-13 10:44:08 +01001250 tty->termios_locked = tp + 1;
Alan Coxbf970ee2008-10-13 10:42:39 +01001251
1252 /* Compatibility until drivers always set this */
1253 tty->termios->c_ispeed = tty_termios_input_baud_rate(tty->termios);
1254 tty->termios->c_ospeed = tty_termios_baud_rate(tty->termios);
1255 return 0;
1256}
1257
1258/**
Alan Cox8b0a88d2008-10-13 10:42:19 +01001259 * tty_driver_install_tty() - install a tty entry in the driver
1260 * @driver: the driver for the tty
1261 * @tty: the tty
1262 *
1263 * Install a tty object into the driver tables. The tty->index field
Alan Coxbf970ee2008-10-13 10:42:39 +01001264 * will be set by the time this is called. This method is responsible
1265 * for ensuring any need additional structures are allocated and
1266 * configured.
Alan Cox8b0a88d2008-10-13 10:42:19 +01001267 *
1268 * Locking: tty_mutex for now
1269 */
1270static int tty_driver_install_tty(struct tty_driver *driver,
1271 struct tty_struct *tty)
1272{
Alan Coxbf970ee2008-10-13 10:42:39 +01001273 int idx = tty->index;
1274
Alan Cox8b0a88d2008-10-13 10:42:19 +01001275 if (driver->ops->install)
1276 return driver->ops->install(driver, tty);
Alan Coxbf970ee2008-10-13 10:42:39 +01001277
1278 if (tty_init_termios(tty) == 0) {
1279 tty_driver_kref_get(driver);
1280 tty->count++;
1281 driver->ttys[idx] = tty;
1282 return 0;
1283 }
1284 return -ENOMEM;
Alan Cox8b0a88d2008-10-13 10:42:19 +01001285}
1286
1287/**
1288 * tty_driver_remove_tty() - remove a tty from the driver tables
1289 * @driver: the driver for the tty
1290 * @idx: the minor number
1291 *
1292 * Remvoe a tty object from the driver tables. The tty->index field
1293 * will be set by the time this is called.
1294 *
1295 * Locking: tty_mutex for now
1296 */
1297static void tty_driver_remove_tty(struct tty_driver *driver,
1298 struct tty_struct *tty)
1299{
1300 if (driver->ops->remove)
1301 driver->ops->remove(driver, tty);
1302 else
1303 driver->ttys[tty->index] = NULL;
1304}
1305
1306/*
1307 * tty_reopen() - fast re-open of an open tty
1308 * @tty - the tty to open
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001309 *
Alan Cox99f1fe12008-10-13 10:42:00 +01001310 * Return 0 on success, -errno on error.
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001311 *
Alan Cox99f1fe12008-10-13 10:42:00 +01001312 * Locking: tty_mutex must be held from the time the tty was found
1313 * till this open completes.
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001314 */
Alan Cox99f1fe12008-10-13 10:42:00 +01001315static int tty_reopen(struct tty_struct *tty)
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001316{
1317 struct tty_driver *driver = tty->driver;
1318
1319 if (test_bit(TTY_CLOSING, &tty->flags))
1320 return -EIO;
1321
1322 if (driver->type == TTY_DRIVER_TYPE_PTY &&
1323 driver->subtype == PTY_TYPE_MASTER) {
1324 /*
1325 * special case for PTY masters: only one open permitted,
1326 * and the slave side open count is incremented as well.
1327 */
1328 if (tty->count)
1329 return -EIO;
1330
1331 tty->link->count++;
1332 }
1333 tty->count++;
1334 tty->driver = driver; /* N.B. why do this every time?? */
1335
Alan Cox99f1fe12008-10-13 10:42:00 +01001336 WARN_ON(!test_bit(TTY_LDISC, &tty->flags));
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001337
1338 return 0;
1339}
1340
Alan Coxaf9b8972006-08-27 01:24:01 -07001341/**
Alan Coxd81ed102008-10-13 10:41:42 +01001342 * tty_init_dev - initialise a tty device
Alan Coxaf9b8972006-08-27 01:24:01 -07001343 * @driver: tty driver we are opening a device on
1344 * @idx: device index
Alan Cox15582d32008-10-13 10:41:03 +01001345 * @ret_tty: returned tty structure
1346 * @first_ok: ok to open a new device (used by ptmx)
Alan Coxaf9b8972006-08-27 01:24:01 -07001347 *
1348 * Prepare a tty device. This may not be a "new" clean device but
1349 * could also be an active device. The pty drivers require special
1350 * handling because of this.
1351 *
1352 * Locking:
1353 * The function is called under the tty_mutex, which
1354 * protects us from the tty struct or driver itself going away.
1355 *
1356 * On exit the tty device has the line discipline attached and
1357 * a reference count of 1. If a pair was created for pty/tty use
1358 * and the other was a pty master then it too has a reference count of 1.
1359 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07001360 * WSH 06/09/97: Rewritten to remove races and properly clean up after a
Ingo Molnar70522e12006-03-23 03:00:31 -08001361 * failed open. The new code protects the open with a mutex, so it's
1362 * really quite straightforward. The mutex locking can probably be
Linus Torvalds1da177e2005-04-16 15:20:36 -07001363 * relaxed for the (most common) case of reopening a tty.
1364 */
Alan Coxaf9b8972006-08-27 01:24:01 -07001365
Alan Cox73ec06f2008-10-13 10:42:29 +01001366struct tty_struct *tty_init_dev(struct tty_driver *driver, int idx,
1367 int first_ok)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001368{
Alan Coxbf970ee2008-10-13 10:42:39 +01001369 struct tty_struct *tty;
Alan Cox73ec06f2008-10-13 10:42:29 +01001370 int retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001371
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001372 /* Check if pty master is being opened multiple times */
Alan Cox15582d32008-10-13 10:41:03 +01001373 if (driver->subtype == PTY_TYPE_MASTER &&
Alan Cox73ec06f2008-10-13 10:42:29 +01001374 (driver->flags & TTY_DRIVER_DEVPTS_MEM) && !first_ok)
1375 return ERR_PTR(-EIO);
1376
Linus Torvalds1da177e2005-04-16 15:20:36 -07001377 /*
1378 * First time open is complex, especially for PTY devices.
1379 * This code guarantees that either everything succeeds and the
1380 * TTY is ready for operation, or else the table slots are vacated
Alan Cox37bdfb02008-02-08 04:18:47 -08001381 * and the allocated memory released. (Except that the termios
Linus Torvalds1da177e2005-04-16 15:20:36 -07001382 * and locked termios may be retained.)
1383 */
1384
Alan Cox73ec06f2008-10-13 10:42:29 +01001385 if (!try_module_get(driver->owner))
1386 return ERR_PTR(-ENODEV);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001387
Linus Torvalds1da177e2005-04-16 15:20:36 -07001388 tty = alloc_tty_struct();
Alan Cox37bdfb02008-02-08 04:18:47 -08001389 if (!tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001390 goto fail_no_mem;
Alan Coxbf970ee2008-10-13 10:42:39 +01001391 initialize_tty_struct(tty, driver, idx);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001392
Alan Cox73ec06f2008-10-13 10:42:29 +01001393 retval = tty_driver_install_tty(driver, tty);
Alan Coxbf970ee2008-10-13 10:42:39 +01001394 if (retval < 0) {
1395 free_tty_struct(tty);
1396 module_put(driver->owner);
1397 return ERR_PTR(retval);
1398 }
Alan Cox8b0a88d2008-10-13 10:42:19 +01001399
Alan Cox37bdfb02008-02-08 04:18:47 -08001400 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001401 * Structures all installed ... call the ldisc open routines.
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001402 * If we fail here just call release_tty to clean up. No need
1403 * to decrement the use counts, as release_tty doesn't care.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001404 */
1405
Alan Coxbf970ee2008-10-13 10:42:39 +01001406 retval = tty_ldisc_setup(tty, tty->link);
Alan Cox01e1abb2008-07-22 11:16:55 +01001407 if (retval)
1408 goto release_mem_out;
Alan Cox73ec06f2008-10-13 10:42:29 +01001409 return tty;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001410
Linus Torvalds1da177e2005-04-16 15:20:36 -07001411fail_no_mem:
1412 module_put(driver->owner);
Alan Cox73ec06f2008-10-13 10:42:29 +01001413 return ERR_PTR(-ENOMEM);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001414
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001415 /* call the tty release_tty routine to clean out this slot */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001416release_mem_out:
Akinobu Mita40509142006-09-29 02:01:27 -07001417 if (printk_ratelimit())
Alan Coxd81ed102008-10-13 10:41:42 +01001418 printk(KERN_INFO "tty_init_dev: ldisc open failed, "
Akinobu Mita40509142006-09-29 02:01:27 -07001419 "clearing slot %d\n", idx);
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001420 release_tty(tty, idx);
Alan Cox73ec06f2008-10-13 10:42:29 +01001421 return ERR_PTR(retval);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001422}
1423
Alan Coxfeebed62008-10-13 10:41:30 +01001424void tty_free_termios(struct tty_struct *tty)
1425{
1426 struct ktermios *tp;
1427 int idx = tty->index;
1428 /* Kill this flag and push into drivers for locking etc */
1429 if (tty->driver->flags & TTY_DRIVER_RESET_TERMIOS) {
1430 /* FIXME: Locking on ->termios array */
1431 tp = tty->termios;
1432 tty->driver->termios[idx] = NULL;
1433 kfree(tp);
Alan Coxfeebed62008-10-13 10:41:30 +01001434 }
1435}
1436EXPORT_SYMBOL(tty_free_termios);
1437
1438void tty_shutdown(struct tty_struct *tty)
1439{
Alan Cox8b0a88d2008-10-13 10:42:19 +01001440 tty_driver_remove_tty(tty->driver, tty);
Alan Coxfeebed62008-10-13 10:41:30 +01001441 tty_free_termios(tty);
1442}
1443EXPORT_SYMBOL(tty_shutdown);
1444
Alan Coxaf9b8972006-08-27 01:24:01 -07001445/**
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001446 * release_one_tty - release tty structure memory
Alan Cox9c9f4de2008-10-13 10:37:26 +01001447 * @kref: kref of tty we are obliterating
Alan Coxaf9b8972006-08-27 01:24:01 -07001448 *
1449 * Releases memory associated with a tty structure, and clears out the
1450 * driver table slots. This function is called when a device is no longer
1451 * in use. It also gets called when setup of a device fails.
1452 *
1453 * Locking:
1454 * tty_mutex - sometimes only
1455 * takes the file list lock internally when working on the list
1456 * of ttys that the driver keeps.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001457 */
Alan Cox9c9f4de2008-10-13 10:37:26 +01001458static void release_one_tty(struct kref *kref)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001459{
Alan Cox9c9f4de2008-10-13 10:37:26 +01001460 struct tty_struct *tty = container_of(kref, struct tty_struct, kref);
Alan Cox6f967f72008-10-13 10:37:36 +01001461 struct tty_driver *driver = tty->driver;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001462
Alan Coxfeebed62008-10-13 10:41:30 +01001463 if (tty->ops->shutdown)
1464 tty->ops->shutdown(tty);
1465 else
1466 tty_shutdown(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001467 tty->magic = 0;
Alan Cox7d7b93c2008-10-13 10:42:09 +01001468 tty_driver_kref_put(driver);
Alan Cox6f967f72008-10-13 10:37:36 +01001469 module_put(driver->owner);
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001470
Linus Torvalds1da177e2005-04-16 15:20:36 -07001471 file_list_lock();
1472 list_del_init(&tty->tty_files);
1473 file_list_unlock();
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001474
Linus Torvalds1da177e2005-04-16 15:20:36 -07001475 free_tty_struct(tty);
1476}
1477
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001478/**
Alan Cox9c9f4de2008-10-13 10:37:26 +01001479 * tty_kref_put - release a tty kref
1480 * @tty: tty device
1481 *
1482 * Release a reference to a tty device and if need be let the kref
1483 * layer destruct the object for us
1484 */
1485
1486void tty_kref_put(struct tty_struct *tty)
1487{
1488 if (tty)
1489 kref_put(&tty->kref, release_one_tty);
1490}
1491EXPORT_SYMBOL(tty_kref_put);
1492
1493/**
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001494 * release_tty - release tty structure memory
1495 *
1496 * Release both @tty and a possible linked partner (think pty pair),
1497 * and decrement the refcount of the backing module.
1498 *
1499 * Locking:
1500 * tty_mutex - sometimes only
1501 * takes the file list lock internally when working on the list
1502 * of ttys that the driver keeps.
1503 * FIXME: should we require tty_mutex is held here ??
Alan Cox9c9f4de2008-10-13 10:37:26 +01001504 *
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001505 */
1506static void release_tty(struct tty_struct *tty, int idx)
1507{
Alan Cox9c9f4de2008-10-13 10:37:26 +01001508 /* This should always be true but check for the moment */
1509 WARN_ON(tty->index != idx);
1510
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001511 if (tty->link)
Alan Cox9c9f4de2008-10-13 10:37:26 +01001512 tty_kref_put(tty->link);
1513 tty_kref_put(tty);
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001514}
1515
Linus Torvalds1da177e2005-04-16 15:20:36 -07001516/*
1517 * Even releasing the tty structures is a tricky business.. We have
1518 * to be very careful that the structures are all released at the
1519 * same time, as interrupts might otherwise get the wrong pointers.
1520 *
1521 * WSH 09/09/97: rewritten to avoid some nasty race conditions that could
1522 * lead to double frees or releasing memory still in use.
1523 */
Alan Coxd81ed102008-10-13 10:41:42 +01001524void tty_release_dev(struct file *filp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001525{
1526 struct tty_struct *tty, *o_tty;
1527 int pty_master, tty_closing, o_tty_closing, do_sleep;
Paul Fulghum14a62832006-04-10 22:54:19 -07001528 int devpts;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001529 int idx;
1530 char buf[64];
Sukadev Bhattiprolu15f1a632008-10-13 10:42:59 +01001531 struct inode *inode;
Alan Cox37bdfb02008-02-08 04:18:47 -08001532
Sukadev Bhattiprolu15f1a632008-10-13 10:42:59 +01001533 inode = filp->f_path.dentry->d_inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001534 tty = (struct tty_struct *)filp->private_data;
Sukadev Bhattiprolu15f1a632008-10-13 10:42:59 +01001535 if (tty_paranoia_check(tty, inode, "tty_release_dev"))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001536 return;
1537
Alan Coxd81ed102008-10-13 10:41:42 +01001538 check_tty_count(tty, "tty_release_dev");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001539
1540 tty_fasync(-1, filp, 0);
1541
1542 idx = tty->index;
1543 pty_master = (tty->driver->type == TTY_DRIVER_TYPE_PTY &&
1544 tty->driver->subtype == PTY_TYPE_MASTER);
1545 devpts = (tty->driver->flags & TTY_DRIVER_DEVPTS_MEM) != 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001546 o_tty = tty->link;
1547
1548#ifdef TTY_PARANOIA_CHECK
1549 if (idx < 0 || idx >= tty->driver->num) {
Alan Coxd81ed102008-10-13 10:41:42 +01001550 printk(KERN_DEBUG "tty_release_dev: bad idx when trying to "
Linus Torvalds1da177e2005-04-16 15:20:36 -07001551 "free (%s)\n", tty->name);
1552 return;
1553 }
Alan Cox8b0a88d2008-10-13 10:42:19 +01001554 if (!devpts) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001555 if (tty != tty->driver->ttys[idx]) {
Alan Coxd81ed102008-10-13 10:41:42 +01001556 printk(KERN_DEBUG "tty_release_dev: driver.table[%d] not tty "
Linus Torvalds1da177e2005-04-16 15:20:36 -07001557 "for (%s)\n", idx, tty->name);
1558 return;
1559 }
1560 if (tty->termios != tty->driver->termios[idx]) {
Alan Coxd81ed102008-10-13 10:41:42 +01001561 printk(KERN_DEBUG "tty_release_dev: driver.termios[%d] not termios "
Linus Torvalds1da177e2005-04-16 15:20:36 -07001562 "for (%s)\n",
1563 idx, tty->name);
1564 return;
1565 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001566 }
1567#endif
1568
1569#ifdef TTY_DEBUG_HANGUP
Alan Coxd81ed102008-10-13 10:41:42 +01001570 printk(KERN_DEBUG "tty_release_dev of %s (tty count=%d)...",
Linus Torvalds1da177e2005-04-16 15:20:36 -07001571 tty_name(tty, buf), tty->count);
1572#endif
1573
1574#ifdef TTY_PARANOIA_CHECK
1575 if (tty->driver->other &&
1576 !(tty->driver->flags & TTY_DRIVER_DEVPTS_MEM)) {
1577 if (o_tty != tty->driver->other->ttys[idx]) {
Alan Coxd81ed102008-10-13 10:41:42 +01001578 printk(KERN_DEBUG "tty_release_dev: other->table[%d] "
Linus Torvalds1da177e2005-04-16 15:20:36 -07001579 "not o_tty for (%s)\n",
1580 idx, tty->name);
1581 return;
1582 }
1583 if (o_tty->termios != tty->driver->other->termios[idx]) {
Alan Coxd81ed102008-10-13 10:41:42 +01001584 printk(KERN_DEBUG "tty_release_dev: other->termios[%d] "
Linus Torvalds1da177e2005-04-16 15:20:36 -07001585 "not o_termios for (%s)\n",
1586 idx, tty->name);
1587 return;
1588 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001589 if (o_tty->link != tty) {
Alan Coxd81ed102008-10-13 10:41:42 +01001590 printk(KERN_DEBUG "tty_release_dev: bad pty pointers\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001591 return;
1592 }
1593 }
1594#endif
Alan Coxf34d7a52008-04-30 00:54:13 -07001595 if (tty->ops->close)
1596 tty->ops->close(tty, filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001597
1598 /*
1599 * Sanity check: if tty->count is going to zero, there shouldn't be
1600 * any waiters on tty->read_wait or tty->write_wait. We test the
1601 * wait queues and kick everyone out _before_ actually starting to
1602 * close. This ensures that we won't block while releasing the tty
1603 * structure.
1604 *
1605 * The test for the o_tty closing is necessary, since the master and
1606 * slave sides may close in any order. If the slave side closes out
1607 * first, its count will be one, since the master side holds an open.
1608 * Thus this test wouldn't be triggered at the time the slave closes,
1609 * so we do it now.
1610 *
1611 * Note that it's possible for the tty to be opened again while we're
1612 * flushing out waiters. By recalculating the closing flags before
1613 * each iteration we avoid any problems.
1614 */
1615 while (1) {
1616 /* Guard against races with tty->count changes elsewhere and
1617 opens on /dev/tty */
Alan Cox37bdfb02008-02-08 04:18:47 -08001618
Ingo Molnar70522e12006-03-23 03:00:31 -08001619 mutex_lock(&tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001620 tty_closing = tty->count <= 1;
1621 o_tty_closing = o_tty &&
1622 (o_tty->count <= (pty_master ? 1 : 0));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001623 do_sleep = 0;
1624
1625 if (tty_closing) {
1626 if (waitqueue_active(&tty->read_wait)) {
Davide Libenzi4b194492009-03-31 15:24:24 -07001627 wake_up_poll(&tty->read_wait, POLLIN);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001628 do_sleep++;
1629 }
1630 if (waitqueue_active(&tty->write_wait)) {
Davide Libenzi4b194492009-03-31 15:24:24 -07001631 wake_up_poll(&tty->write_wait, POLLOUT);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001632 do_sleep++;
1633 }
1634 }
1635 if (o_tty_closing) {
1636 if (waitqueue_active(&o_tty->read_wait)) {
Davide Libenzi4b194492009-03-31 15:24:24 -07001637 wake_up_poll(&o_tty->read_wait, POLLIN);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001638 do_sleep++;
1639 }
1640 if (waitqueue_active(&o_tty->write_wait)) {
Davide Libenzi4b194492009-03-31 15:24:24 -07001641 wake_up_poll(&o_tty->write_wait, POLLOUT);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001642 do_sleep++;
1643 }
1644 }
1645 if (!do_sleep)
1646 break;
1647
Alan Coxd81ed102008-10-13 10:41:42 +01001648 printk(KERN_WARNING "tty_release_dev: %s: read/write wait queue "
Linus Torvalds1da177e2005-04-16 15:20:36 -07001649 "active!\n", tty_name(tty, buf));
Ingo Molnar70522e12006-03-23 03:00:31 -08001650 mutex_unlock(&tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001651 schedule();
Alan Cox37bdfb02008-02-08 04:18:47 -08001652 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001653
1654 /*
Alan Cox37bdfb02008-02-08 04:18:47 -08001655 * The closing flags are now consistent with the open counts on
1656 * both sides, and we've completed the last operation that could
Linus Torvalds1da177e2005-04-16 15:20:36 -07001657 * block, so it's safe to proceed with closing.
1658 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001659 if (pty_master) {
1660 if (--o_tty->count < 0) {
Alan Coxd81ed102008-10-13 10:41:42 +01001661 printk(KERN_WARNING "tty_release_dev: bad pty slave count "
Linus Torvalds1da177e2005-04-16 15:20:36 -07001662 "(%d) for %s\n",
1663 o_tty->count, tty_name(o_tty, buf));
1664 o_tty->count = 0;
1665 }
1666 }
1667 if (--tty->count < 0) {
Alan Coxd81ed102008-10-13 10:41:42 +01001668 printk(KERN_WARNING "tty_release_dev: bad tty->count (%d) for %s\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07001669 tty->count, tty_name(tty, buf));
1670 tty->count = 0;
1671 }
Alan Cox37bdfb02008-02-08 04:18:47 -08001672
Linus Torvalds1da177e2005-04-16 15:20:36 -07001673 /*
1674 * We've decremented tty->count, so we need to remove this file
1675 * descriptor off the tty->tty_files list; this serves two
1676 * purposes:
1677 * - check_tty_count sees the correct number of file descriptors
1678 * associated with this tty.
1679 * - do_tty_hangup no longer sees this file descriptor as
1680 * something that needs to be handled for hangups.
1681 */
1682 file_kill(filp);
1683 filp->private_data = NULL;
1684
1685 /*
1686 * Perform some housekeeping before deciding whether to return.
1687 *
1688 * Set the TTY_CLOSING flag if this was the last open. In the
1689 * case of a pty we may have to wait around for the other side
1690 * to close, and TTY_CLOSING makes sure we can't be reopened.
1691 */
Alan Cox37bdfb02008-02-08 04:18:47 -08001692 if (tty_closing)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001693 set_bit(TTY_CLOSING, &tty->flags);
Alan Cox37bdfb02008-02-08 04:18:47 -08001694 if (o_tty_closing)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001695 set_bit(TTY_CLOSING, &o_tty->flags);
1696
1697 /*
1698 * If _either_ side is closing, make sure there aren't any
1699 * processes that still think tty or o_tty is their controlling
1700 * tty.
1701 */
1702 if (tty_closing || o_tty_closing) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001703 read_lock(&tasklist_lock);
Peter Zijlstra24ec8392006-12-08 02:36:04 -08001704 session_clear_tty(tty->session);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001705 if (o_tty)
Peter Zijlstra24ec8392006-12-08 02:36:04 -08001706 session_clear_tty(o_tty->session);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001707 read_unlock(&tasklist_lock);
1708 }
1709
Ingo Molnar70522e12006-03-23 03:00:31 -08001710 mutex_unlock(&tty_mutex);
Paul Fulghumda965822006-02-14 13:53:00 -08001711
Linus Torvalds1da177e2005-04-16 15:20:36 -07001712 /* check whether both sides are closing ... */
1713 if (!tty_closing || (o_tty && !o_tty_closing))
1714 return;
Alan Cox37bdfb02008-02-08 04:18:47 -08001715
Linus Torvalds1da177e2005-04-16 15:20:36 -07001716#ifdef TTY_DEBUG_HANGUP
1717 printk(KERN_DEBUG "freeing tty structure...");
1718#endif
1719 /*
Alan Cox01e1abb2008-07-22 11:16:55 +01001720 * Ask the line discipline code to release its structures
Linus Torvalds1da177e2005-04-16 15:20:36 -07001721 */
Alan Cox01e1abb2008-07-22 11:16:55 +01001722 tty_ldisc_release(tty, o_tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001723 /*
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001724 * The release_tty function takes care of the details of clearing
Linus Torvalds1da177e2005-04-16 15:20:36 -07001725 * the slots and preserving the termios structure.
1726 */
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001727 release_tty(tty, idx);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001728
Linus Torvalds1da177e2005-04-16 15:20:36 -07001729 /* Make this pty number available for reallocation */
Sukadev Bhattiprolu718a9162008-04-30 00:54:21 -07001730 if (devpts)
Sukadev Bhattiprolu15f1a632008-10-13 10:42:59 +01001731 devpts_kill_index(inode, idx);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001732}
1733
Alan Coxaf9b8972006-08-27 01:24:01 -07001734/**
Alan Cox15582d32008-10-13 10:41:03 +01001735 * __tty_open - open a tty device
Alan Coxaf9b8972006-08-27 01:24:01 -07001736 * @inode: inode of device file
1737 * @filp: file pointer to tty
Linus Torvalds1da177e2005-04-16 15:20:36 -07001738 *
Alan Coxaf9b8972006-08-27 01:24:01 -07001739 * tty_open and tty_release keep up the tty count that contains the
1740 * number of opens done on a tty. We cannot use the inode-count, as
1741 * different inodes might point to the same tty.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001742 *
Alan Coxaf9b8972006-08-27 01:24:01 -07001743 * Open-counting is needed for pty masters, as well as for keeping
1744 * track of serial lines: DTR is dropped when the last close happens.
1745 * (This is not done solely through tty->count, now. - Ted 1/27/92)
1746 *
1747 * The termios state of a pty is reset on first open so that
1748 * settings don't persist across reuse.
1749 *
Alan Coxd81ed102008-10-13 10:41:42 +01001750 * Locking: tty_mutex protects tty, get_tty_driver and tty_init_dev work.
Peter Zijlstra24ec8392006-12-08 02:36:04 -08001751 * tty->count should protect the rest.
1752 * ->siglock protects ->signal/->sighand
Linus Torvalds1da177e2005-04-16 15:20:36 -07001753 */
Alan Coxaf9b8972006-08-27 01:24:01 -07001754
Jonathan Corbet39d95b92008-05-16 09:10:50 -06001755static int __tty_open(struct inode *inode, struct file *filp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001756{
Sukadev Bhattiprolu4a2b5fd2008-10-13 10:42:49 +01001757 struct tty_struct *tty = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001758 int noctty, retval;
1759 struct tty_driver *driver;
1760 int index;
1761 dev_t device = inode->i_rdev;
Andrew Morton846c1512009-04-02 16:56:36 -07001762 unsigned saved_flags = filp->f_flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001763
1764 nonseekable_open(inode, filp);
Alan Cox37bdfb02008-02-08 04:18:47 -08001765
Linus Torvalds1da177e2005-04-16 15:20:36 -07001766retry_open:
1767 noctty = filp->f_flags & O_NOCTTY;
1768 index = -1;
1769 retval = 0;
Alan Cox37bdfb02008-02-08 04:18:47 -08001770
Ingo Molnar70522e12006-03-23 03:00:31 -08001771 mutex_lock(&tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001772
Alan Cox37bdfb02008-02-08 04:18:47 -08001773 if (device == MKDEV(TTYAUX_MAJOR, 0)) {
Peter Zijlstra24ec8392006-12-08 02:36:04 -08001774 tty = get_current_tty();
1775 if (!tty) {
Ingo Molnar70522e12006-03-23 03:00:31 -08001776 mutex_unlock(&tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001777 return -ENXIO;
1778 }
Alan Cox7d7b93c2008-10-13 10:42:09 +01001779 driver = tty_driver_kref_get(tty->driver);
Peter Zijlstra24ec8392006-12-08 02:36:04 -08001780 index = tty->index;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001781 filp->f_flags |= O_NONBLOCK; /* Don't let /dev/tty block */
1782 /* noctty = 1; */
Alan Cox452a00d2008-10-13 10:39:13 +01001783 /* FIXME: Should we take a driver reference ? */
1784 tty_kref_put(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001785 goto got_driver;
1786 }
1787#ifdef CONFIG_VT
Alan Cox37bdfb02008-02-08 04:18:47 -08001788 if (device == MKDEV(TTY_MAJOR, 0)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001789 extern struct tty_driver *console_driver;
Alan Cox7d7b93c2008-10-13 10:42:09 +01001790 driver = tty_driver_kref_get(console_driver);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001791 index = fg_console;
1792 noctty = 1;
1793 goto got_driver;
1794 }
1795#endif
Alan Cox37bdfb02008-02-08 04:18:47 -08001796 if (device == MKDEV(TTYAUX_MAJOR, 1)) {
Will Newton296fa7f2008-12-01 11:36:06 +00001797 struct tty_driver *console_driver = console_device(&index);
1798 if (console_driver) {
1799 driver = tty_driver_kref_get(console_driver);
1800 if (driver) {
1801 /* Don't let /dev/console block */
1802 filp->f_flags |= O_NONBLOCK;
1803 noctty = 1;
1804 goto got_driver;
1805 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001806 }
Ingo Molnar70522e12006-03-23 03:00:31 -08001807 mutex_unlock(&tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001808 return -ENODEV;
1809 }
1810
1811 driver = get_tty_driver(device, &index);
1812 if (!driver) {
Ingo Molnar70522e12006-03-23 03:00:31 -08001813 mutex_unlock(&tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001814 return -ENODEV;
1815 }
1816got_driver:
Sukadev Bhattiprolu4a2b5fd2008-10-13 10:42:49 +01001817 if (!tty) {
1818 /* check whether we're reopening an existing tty */
Sukadev Bhattiprolu15f1a632008-10-13 10:42:59 +01001819 tty = tty_driver_lookup_tty(driver, inode, index);
Sukadev Bhattiprolu4a2b5fd2008-10-13 10:42:49 +01001820
Eric Paris808ffa32009-01-27 11:50:37 +00001821 if (IS_ERR(tty)) {
1822 mutex_unlock(&tty_mutex);
Sukadev Bhattiprolu4a2b5fd2008-10-13 10:42:49 +01001823 return PTR_ERR(tty);
Eric Paris808ffa32009-01-27 11:50:37 +00001824 }
Sukadev Bhattiprolu4a2b5fd2008-10-13 10:42:49 +01001825 }
1826
1827 if (tty) {
1828 retval = tty_reopen(tty);
1829 if (retval)
1830 tty = ERR_PTR(retval);
1831 } else
1832 tty = tty_init_dev(driver, index, 0);
1833
Ingo Molnar70522e12006-03-23 03:00:31 -08001834 mutex_unlock(&tty_mutex);
Alan Cox7d7b93c2008-10-13 10:42:09 +01001835 tty_driver_kref_put(driver);
Alan Cox73ec06f2008-10-13 10:42:29 +01001836 if (IS_ERR(tty))
1837 return PTR_ERR(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001838
1839 filp->private_data = tty;
1840 file_move(filp, &tty->tty_files);
1841 check_tty_count(tty, "tty_open");
1842 if (tty->driver->type == TTY_DRIVER_TYPE_PTY &&
1843 tty->driver->subtype == PTY_TYPE_MASTER)
1844 noctty = 1;
1845#ifdef TTY_DEBUG_HANGUP
1846 printk(KERN_DEBUG "opening %s...", tty->name);
1847#endif
1848 if (!retval) {
Alan Coxf34d7a52008-04-30 00:54:13 -07001849 if (tty->ops->open)
1850 retval = tty->ops->open(tty, filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001851 else
1852 retval = -ENODEV;
1853 }
1854 filp->f_flags = saved_flags;
1855
Alan Cox37bdfb02008-02-08 04:18:47 -08001856 if (!retval && test_bit(TTY_EXCLUSIVE, &tty->flags) &&
1857 !capable(CAP_SYS_ADMIN))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001858 retval = -EBUSY;
1859
1860 if (retval) {
1861#ifdef TTY_DEBUG_HANGUP
1862 printk(KERN_DEBUG "error %d in opening %s...", retval,
1863 tty->name);
1864#endif
Alan Coxd81ed102008-10-13 10:41:42 +01001865 tty_release_dev(filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001866 if (retval != -ERESTARTSYS)
1867 return retval;
1868 if (signal_pending(current))
1869 return retval;
1870 schedule();
1871 /*
1872 * Need to reset f_op in case a hangup happened.
1873 */
1874 if (filp->f_op == &hung_up_tty_fops)
1875 filp->f_op = &tty_fops;
1876 goto retry_open;
1877 }
Peter Zijlstra24ec8392006-12-08 02:36:04 -08001878
1879 mutex_lock(&tty_mutex);
1880 spin_lock_irq(&current->sighand->siglock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001881 if (!noctty &&
1882 current->signal->leader &&
1883 !current->signal->tty &&
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08001884 tty->session == NULL)
Eric W. Biederman2a65f1d2007-05-08 00:26:53 -07001885 __proc_set_tty(current, tty);
Peter Zijlstra24ec8392006-12-08 02:36:04 -08001886 spin_unlock_irq(&current->sighand->siglock);
1887 mutex_unlock(&tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001888 return 0;
1889}
1890
Jonathan Corbet39d95b92008-05-16 09:10:50 -06001891/* BKL pushdown: scary code avoidance wrapper */
1892static int tty_open(struct inode *inode, struct file *filp)
1893{
1894 int ret;
1895
1896 lock_kernel();
1897 ret = __tty_open(inode, filp);
1898 unlock_kernel();
1899 return ret;
1900}
1901
1902
1903
Linus Torvalds1da177e2005-04-16 15:20:36 -07001904
Alan Coxaf9b8972006-08-27 01:24:01 -07001905/**
1906 * tty_release - vfs callback for close
1907 * @inode: inode of tty
1908 * @filp: file pointer for handle to tty
1909 *
1910 * Called the last time each file handle is closed that references
1911 * this tty. There may however be several such references.
1912 *
1913 * Locking:
Alan Coxd81ed102008-10-13 10:41:42 +01001914 * Takes bkl. See tty_release_dev
Alan Coxaf9b8972006-08-27 01:24:01 -07001915 */
1916
Alan Cox37bdfb02008-02-08 04:18:47 -08001917static int tty_release(struct inode *inode, struct file *filp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001918{
1919 lock_kernel();
Alan Coxd81ed102008-10-13 10:41:42 +01001920 tty_release_dev(filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001921 unlock_kernel();
1922 return 0;
1923}
1924
Alan Coxaf9b8972006-08-27 01:24:01 -07001925/**
1926 * tty_poll - check tty status
1927 * @filp: file being polled
1928 * @wait: poll wait structures to update
1929 *
1930 * Call the line discipline polling method to obtain the poll
1931 * status of the device.
1932 *
1933 * Locking: locks called line discipline but ldisc poll method
1934 * may be re-entered freely by other callers.
1935 */
1936
Alan Cox37bdfb02008-02-08 04:18:47 -08001937static unsigned int tty_poll(struct file *filp, poll_table *wait)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001938{
Alan Cox37bdfb02008-02-08 04:18:47 -08001939 struct tty_struct *tty;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001940 struct tty_ldisc *ld;
1941 int ret = 0;
1942
1943 tty = (struct tty_struct *)filp->private_data;
Josef Sipeka7113a92006-12-08 02:36:55 -08001944 if (tty_paranoia_check(tty, filp->f_path.dentry->d_inode, "tty_poll"))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001945 return 0;
Alan Cox37bdfb02008-02-08 04:18:47 -08001946
Linus Torvalds1da177e2005-04-16 15:20:36 -07001947 ld = tty_ldisc_ref_wait(tty);
Alan Coxa352def2008-07-16 21:53:12 +01001948 if (ld->ops->poll)
1949 ret = (ld->ops->poll)(tty, filp, wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001950 tty_ldisc_deref(ld);
1951 return ret;
1952}
1953
Alan Cox37bdfb02008-02-08 04:18:47 -08001954static int tty_fasync(int fd, struct file *filp, int on)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001955{
Alan Cox37bdfb02008-02-08 04:18:47 -08001956 struct tty_struct *tty;
Alan Cox47f86832008-04-30 00:53:30 -07001957 unsigned long flags;
Jonathan Corbet5d1e3232008-06-19 16:04:53 -06001958 int retval = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001959
Jonathan Corbet5d1e3232008-06-19 16:04:53 -06001960 lock_kernel();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001961 tty = (struct tty_struct *)filp->private_data;
Josef Sipeka7113a92006-12-08 02:36:55 -08001962 if (tty_paranoia_check(tty, filp->f_path.dentry->d_inode, "tty_fasync"))
Jonathan Corbet5d1e3232008-06-19 16:04:53 -06001963 goto out;
Alan Cox37bdfb02008-02-08 04:18:47 -08001964
Linus Torvalds1da177e2005-04-16 15:20:36 -07001965 retval = fasync_helper(fd, filp, on, &tty->fasync);
1966 if (retval <= 0)
Jonathan Corbet5d1e3232008-06-19 16:04:53 -06001967 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001968
1969 if (on) {
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08001970 enum pid_type type;
1971 struct pid *pid;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001972 if (!waitqueue_active(&tty->read_wait))
1973 tty->minimum_to_wake = 1;
Alan Cox47f86832008-04-30 00:53:30 -07001974 spin_lock_irqsave(&tty->ctrl_lock, flags);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08001975 if (tty->pgrp) {
1976 pid = tty->pgrp;
1977 type = PIDTYPE_PGID;
1978 } else {
1979 pid = task_pid(current);
1980 type = PIDTYPE_PID;
1981 }
Alan Cox47f86832008-04-30 00:53:30 -07001982 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08001983 retval = __f_setown(filp, pid, type, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001984 if (retval)
Jonathan Corbet5d1e3232008-06-19 16:04:53 -06001985 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001986 } else {
1987 if (!tty->fasync && !waitqueue_active(&tty->read_wait))
1988 tty->minimum_to_wake = N_TTY_BUF_SIZE;
1989 }
Jonathan Corbet5d1e3232008-06-19 16:04:53 -06001990 retval = 0;
1991out:
1992 unlock_kernel();
1993 return retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001994}
1995
Alan Coxaf9b8972006-08-27 01:24:01 -07001996/**
1997 * tiocsti - fake input character
1998 * @tty: tty to fake input into
1999 * @p: pointer to character
2000 *
Robert P. J. Day3a4fa0a2007-10-19 23:10:43 +02002001 * Fake input to a tty device. Does the necessary locking and
Alan Coxaf9b8972006-08-27 01:24:01 -07002002 * input management.
2003 *
2004 * FIXME: does not honour flow control ??
2005 *
2006 * Locking:
2007 * Called functions take tty_ldisc_lock
2008 * current->signal->tty check is safe without locks
Alan Cox28298232006-09-29 02:00:58 -07002009 *
2010 * FIXME: may race normal receive processing
Alan Coxaf9b8972006-08-27 01:24:01 -07002011 */
2012
Linus Torvalds1da177e2005-04-16 15:20:36 -07002013static int tiocsti(struct tty_struct *tty, char __user *p)
2014{
2015 char ch, mbz = 0;
2016 struct tty_ldisc *ld;
Alan Cox37bdfb02008-02-08 04:18:47 -08002017
Linus Torvalds1da177e2005-04-16 15:20:36 -07002018 if ((current->signal->tty != tty) && !capable(CAP_SYS_ADMIN))
2019 return -EPERM;
2020 if (get_user(ch, p))
2021 return -EFAULT;
Al Viro1e641742008-12-09 09:23:33 +00002022 tty_audit_tiocsti(tty, ch);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002023 ld = tty_ldisc_ref_wait(tty);
Alan Coxa352def2008-07-16 21:53:12 +01002024 ld->ops->receive_buf(tty, &ch, &mbz, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002025 tty_ldisc_deref(ld);
2026 return 0;
2027}
2028
Alan Coxaf9b8972006-08-27 01:24:01 -07002029/**
2030 * tiocgwinsz - implement window query ioctl
2031 * @tty; tty
2032 * @arg: user buffer for result
2033 *
Alan Cox808a0d32006-09-29 02:00:40 -07002034 * Copies the kernel idea of the window size into the user buffer.
Alan Coxaf9b8972006-08-27 01:24:01 -07002035 *
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002036 * Locking: tty->termios_mutex is taken to ensure the winsize data
Alan Cox808a0d32006-09-29 02:00:40 -07002037 * is consistent.
Alan Coxaf9b8972006-08-27 01:24:01 -07002038 */
2039
Alan Cox37bdfb02008-02-08 04:18:47 -08002040static int tiocgwinsz(struct tty_struct *tty, struct winsize __user *arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002041{
Alan Cox808a0d32006-09-29 02:00:40 -07002042 int err;
2043
Arjan van de Ven5785c952006-09-29 02:00:43 -07002044 mutex_lock(&tty->termios_mutex);
Alan Cox808a0d32006-09-29 02:00:40 -07002045 err = copy_to_user(arg, &tty->winsize, sizeof(*arg));
Arjan van de Ven5785c952006-09-29 02:00:43 -07002046 mutex_unlock(&tty->termios_mutex);
Alan Cox808a0d32006-09-29 02:00:40 -07002047
2048 return err ? -EFAULT: 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002049}
2050
Alan Coxaf9b8972006-08-27 01:24:01 -07002051/**
Alan Cox8c9a9dd2008-08-15 10:39:38 +01002052 * tty_do_resize - resize event
2053 * @tty: tty being resized
Alan Cox8c9a9dd2008-08-15 10:39:38 +01002054 * @rows: rows (character)
2055 * @cols: cols (character)
Alan Coxaf9b8972006-08-27 01:24:01 -07002056 *
Alan Cox8c9a9dd2008-08-15 10:39:38 +01002057 * Update the termios variables and send the neccessary signals to
2058 * peform a terminal resize correctly
Alan Coxaf9b8972006-08-27 01:24:01 -07002059 */
2060
Alan Coxfc6f6232009-01-02 13:43:17 +00002061int tty_do_resize(struct tty_struct *tty, struct winsize *ws)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002062{
Alan Coxfc6f6232009-01-02 13:43:17 +00002063 struct pid *pgrp;
Alan Cox47f86832008-04-30 00:53:30 -07002064 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002065
Alan Coxfc6f6232009-01-02 13:43:17 +00002066 /* Lock the tty */
2067 mutex_lock(&tty->termios_mutex);
2068 if (!memcmp(ws, &tty->winsize, sizeof(*ws)))
Alan Coxca9bda02006-09-29 02:00:03 -07002069 goto done;
Alan Cox47f86832008-04-30 00:53:30 -07002070 /* Get the PID values and reference them so we can
2071 avoid holding the tty ctrl lock while sending signals */
2072 spin_lock_irqsave(&tty->ctrl_lock, flags);
2073 pgrp = get_pid(tty->pgrp);
Alan Cox47f86832008-04-30 00:53:30 -07002074 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
2075
2076 if (pgrp)
2077 kill_pgrp(pgrp, SIGWINCH, 1);
Alan Cox47f86832008-04-30 00:53:30 -07002078 put_pid(pgrp);
Alan Cox47f86832008-04-30 00:53:30 -07002079
Alan Cox8c9a9dd2008-08-15 10:39:38 +01002080 tty->winsize = *ws;
Alan Coxca9bda02006-09-29 02:00:03 -07002081done:
Alan Coxfc6f6232009-01-02 13:43:17 +00002082 mutex_unlock(&tty->termios_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002083 return 0;
2084}
2085
Alan Coxaf9b8972006-08-27 01:24:01 -07002086/**
Alan Cox8c9a9dd2008-08-15 10:39:38 +01002087 * tiocswinsz - implement window size set ioctl
Alan Coxfc6f6232009-01-02 13:43:17 +00002088 * @tty; tty side of tty
Alan Cox8c9a9dd2008-08-15 10:39:38 +01002089 * @arg: user buffer for result
2090 *
2091 * Copies the user idea of the window size to the kernel. Traditionally
2092 * this is just advisory information but for the Linux console it
2093 * actually has driver level meaning and triggers a VC resize.
2094 *
2095 * Locking:
2096 * Driver dependant. The default do_resize method takes the
2097 * tty termios mutex and ctrl_lock. The console takes its own lock
2098 * then calls into the default method.
2099 */
2100
Alan Coxfc6f6232009-01-02 13:43:17 +00002101static int tiocswinsz(struct tty_struct *tty, struct winsize __user *arg)
Alan Cox8c9a9dd2008-08-15 10:39:38 +01002102{
2103 struct winsize tmp_ws;
2104 if (copy_from_user(&tmp_ws, arg, sizeof(*arg)))
2105 return -EFAULT;
2106
2107 if (tty->ops->resize)
Alan Coxfc6f6232009-01-02 13:43:17 +00002108 return tty->ops->resize(tty, &tmp_ws);
Alan Cox8c9a9dd2008-08-15 10:39:38 +01002109 else
Alan Coxfc6f6232009-01-02 13:43:17 +00002110 return tty_do_resize(tty, &tmp_ws);
Alan Cox8c9a9dd2008-08-15 10:39:38 +01002111}
2112
2113/**
Alan Coxaf9b8972006-08-27 01:24:01 -07002114 * tioccons - allow admin to move logical console
2115 * @file: the file to become console
2116 *
2117 * Allow the adminstrator to move the redirected console device
2118 *
2119 * Locking: uses redirect_lock to guard the redirect information
2120 */
2121
Linus Torvalds1da177e2005-04-16 15:20:36 -07002122static int tioccons(struct file *file)
2123{
2124 if (!capable(CAP_SYS_ADMIN))
2125 return -EPERM;
2126 if (file->f_op->write == redirected_tty_write) {
2127 struct file *f;
2128 spin_lock(&redirect_lock);
2129 f = redirect;
2130 redirect = NULL;
2131 spin_unlock(&redirect_lock);
2132 if (f)
2133 fput(f);
2134 return 0;
2135 }
2136 spin_lock(&redirect_lock);
2137 if (redirect) {
2138 spin_unlock(&redirect_lock);
2139 return -EBUSY;
2140 }
2141 get_file(file);
2142 redirect = file;
2143 spin_unlock(&redirect_lock);
2144 return 0;
2145}
2146
Alan Coxaf9b8972006-08-27 01:24:01 -07002147/**
2148 * fionbio - non blocking ioctl
2149 * @file: file to set blocking value
2150 * @p: user parameter
2151 *
2152 * Historical tty interfaces had a blocking control ioctl before
2153 * the generic functionality existed. This piece of history is preserved
2154 * in the expected tty API of posix OS's.
2155 *
2156 * Locking: none, the open fle handle ensures it won't go away.
2157 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002158
2159static int fionbio(struct file *file, int __user *p)
2160{
2161 int nonblock;
2162
2163 if (get_user(nonblock, p))
2164 return -EFAULT;
2165
Jonathan Corbetdb1dd4d2009-02-06 15:25:24 -07002166 spin_lock(&file->f_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002167 if (nonblock)
2168 file->f_flags |= O_NONBLOCK;
2169 else
2170 file->f_flags &= ~O_NONBLOCK;
Jonathan Corbetdb1dd4d2009-02-06 15:25:24 -07002171 spin_unlock(&file->f_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002172 return 0;
2173}
2174
Alan Coxaf9b8972006-08-27 01:24:01 -07002175/**
2176 * tiocsctty - set controlling tty
2177 * @tty: tty structure
2178 * @arg: user argument
2179 *
2180 * This ioctl is used to manage job control. It permits a session
2181 * leader to set this tty as the controlling tty for the session.
2182 *
2183 * Locking:
Alan Cox28298232006-09-29 02:00:58 -07002184 * Takes tty_mutex() to protect tty instance
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002185 * Takes tasklist_lock internally to walk sessions
2186 * Takes ->siglock() when updating signal->tty
Alan Coxaf9b8972006-08-27 01:24:01 -07002187 */
2188
Linus Torvalds1da177e2005-04-16 15:20:36 -07002189static int tiocsctty(struct tty_struct *tty, int arg)
2190{
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002191 int ret = 0;
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08002192 if (current->signal->leader && (task_session(current) == tty->session))
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002193 return ret;
2194
2195 mutex_lock(&tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002196 /*
2197 * The process must be a session leader and
2198 * not have a controlling tty already.
2199 */
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002200 if (!current->signal->leader || current->signal->tty) {
2201 ret = -EPERM;
2202 goto unlock;
2203 }
2204
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08002205 if (tty->session) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002206 /*
2207 * This tty is already the controlling
2208 * tty for another session group!
2209 */
Alan Cox37bdfb02008-02-08 04:18:47 -08002210 if (arg == 1 && capable(CAP_SYS_ADMIN)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002211 /*
2212 * Steal it away
2213 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002214 read_lock(&tasklist_lock);
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002215 session_clear_tty(tty->session);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002216 read_unlock(&tasklist_lock);
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002217 } else {
2218 ret = -EPERM;
2219 goto unlock;
2220 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002221 }
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002222 proc_set_tty(current, tty);
2223unlock:
Alan Cox28298232006-09-29 02:00:58 -07002224 mutex_unlock(&tty_mutex);
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002225 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002226}
2227
Alan Coxaf9b8972006-08-27 01:24:01 -07002228/**
Alan Cox5d0fdf12008-04-30 00:53:31 -07002229 * tty_get_pgrp - return a ref counted pgrp pid
2230 * @tty: tty to read
2231 *
2232 * Returns a refcounted instance of the pid struct for the process
2233 * group controlling the tty.
2234 */
2235
2236struct pid *tty_get_pgrp(struct tty_struct *tty)
2237{
2238 unsigned long flags;
2239 struct pid *pgrp;
2240
2241 spin_lock_irqsave(&tty->ctrl_lock, flags);
2242 pgrp = get_pid(tty->pgrp);
2243 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
2244
2245 return pgrp;
2246}
2247EXPORT_SYMBOL_GPL(tty_get_pgrp);
2248
2249/**
Alan Coxaf9b8972006-08-27 01:24:01 -07002250 * tiocgpgrp - get process group
2251 * @tty: tty passed by user
2252 * @real_tty: tty side of the tty pased by the user if a pty else the tty
2253 * @p: returned pid
2254 *
2255 * Obtain the process group of the tty. If there is no process group
2256 * return an error.
2257 *
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002258 * Locking: none. Reference to current->signal->tty is safe.
Alan Coxaf9b8972006-08-27 01:24:01 -07002259 */
2260
Linus Torvalds1da177e2005-04-16 15:20:36 -07002261static int tiocgpgrp(struct tty_struct *tty, struct tty_struct *real_tty, pid_t __user *p)
2262{
Alan Cox5d0fdf12008-04-30 00:53:31 -07002263 struct pid *pid;
2264 int ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002265 /*
2266 * (tty == real_tty) is a cheap way of
2267 * testing if the tty is NOT a master pty.
2268 */
2269 if (tty == real_tty && current->signal->tty != real_tty)
2270 return -ENOTTY;
Alan Cox5d0fdf12008-04-30 00:53:31 -07002271 pid = tty_get_pgrp(real_tty);
2272 ret = put_user(pid_vnr(pid), p);
2273 put_pid(pid);
2274 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002275}
2276
Alan Coxaf9b8972006-08-27 01:24:01 -07002277/**
2278 * tiocspgrp - attempt to set process group
2279 * @tty: tty passed by user
2280 * @real_tty: tty side device matching tty passed by user
2281 * @p: pid pointer
2282 *
2283 * Set the process group of the tty to the session passed. Only
2284 * permitted where the tty session is our session.
2285 *
Alan Cox47f86832008-04-30 00:53:30 -07002286 * Locking: RCU, ctrl lock
Alan Coxaf9b8972006-08-27 01:24:01 -07002287 */
2288
Linus Torvalds1da177e2005-04-16 15:20:36 -07002289static int tiocspgrp(struct tty_struct *tty, struct tty_struct *real_tty, pid_t __user *p)
2290{
Eric W. Biederman04a2e6a2007-02-12 00:52:56 -08002291 struct pid *pgrp;
2292 pid_t pgrp_nr;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002293 int retval = tty_check_change(real_tty);
Alan Cox47f86832008-04-30 00:53:30 -07002294 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002295
2296 if (retval == -EIO)
2297 return -ENOTTY;
2298 if (retval)
2299 return retval;
2300 if (!current->signal->tty ||
2301 (current->signal->tty != real_tty) ||
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08002302 (real_tty->session != task_session(current)))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002303 return -ENOTTY;
Eric W. Biederman04a2e6a2007-02-12 00:52:56 -08002304 if (get_user(pgrp_nr, p))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002305 return -EFAULT;
Eric W. Biederman04a2e6a2007-02-12 00:52:56 -08002306 if (pgrp_nr < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002307 return -EINVAL;
Eric W. Biederman04a2e6a2007-02-12 00:52:56 -08002308 rcu_read_lock();
Pavel Emelyanovb4888932007-10-18 23:40:14 -07002309 pgrp = find_vpid(pgrp_nr);
Eric W. Biederman04a2e6a2007-02-12 00:52:56 -08002310 retval = -ESRCH;
2311 if (!pgrp)
2312 goto out_unlock;
2313 retval = -EPERM;
2314 if (session_of_pgrp(pgrp) != task_session(current))
2315 goto out_unlock;
2316 retval = 0;
Alan Cox47f86832008-04-30 00:53:30 -07002317 spin_lock_irqsave(&tty->ctrl_lock, flags);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08002318 put_pid(real_tty->pgrp);
2319 real_tty->pgrp = get_pid(pgrp);
Alan Cox47f86832008-04-30 00:53:30 -07002320 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
Eric W. Biederman04a2e6a2007-02-12 00:52:56 -08002321out_unlock:
2322 rcu_read_unlock();
2323 return retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002324}
2325
Alan Coxaf9b8972006-08-27 01:24:01 -07002326/**
2327 * tiocgsid - get session id
2328 * @tty: tty passed by user
2329 * @real_tty: tty side of the tty pased by the user if a pty else the tty
2330 * @p: pointer to returned session id
2331 *
2332 * Obtain the session id of the tty. If there is no session
2333 * return an error.
2334 *
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002335 * Locking: none. Reference to current->signal->tty is safe.
Alan Coxaf9b8972006-08-27 01:24:01 -07002336 */
2337
Linus Torvalds1da177e2005-04-16 15:20:36 -07002338static int tiocgsid(struct tty_struct *tty, struct tty_struct *real_tty, pid_t __user *p)
2339{
2340 /*
2341 * (tty == real_tty) is a cheap way of
2342 * testing if the tty is NOT a master pty.
2343 */
2344 if (tty == real_tty && current->signal->tty != real_tty)
2345 return -ENOTTY;
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08002346 if (!real_tty->session)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002347 return -ENOTTY;
Pavel Emelyanovb4888932007-10-18 23:40:14 -07002348 return put_user(pid_vnr(real_tty->session), p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002349}
2350
Alan Coxaf9b8972006-08-27 01:24:01 -07002351/**
2352 * tiocsetd - set line discipline
2353 * @tty: tty device
2354 * @p: pointer to user data
2355 *
2356 * Set the line discipline according to user request.
2357 *
2358 * Locking: see tty_set_ldisc, this function is just a helper
2359 */
2360
Linus Torvalds1da177e2005-04-16 15:20:36 -07002361static int tiocsetd(struct tty_struct *tty, int __user *p)
2362{
2363 int ldisc;
Alan Cox04f378b2008-04-30 00:53:29 -07002364 int ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002365
2366 if (get_user(ldisc, p))
2367 return -EFAULT;
Alan Cox04f378b2008-04-30 00:53:29 -07002368
2369 lock_kernel();
2370 ret = tty_set_ldisc(tty, ldisc);
2371 unlock_kernel();
2372
2373 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002374}
2375
Alan Coxaf9b8972006-08-27 01:24:01 -07002376/**
2377 * send_break - performed time break
2378 * @tty: device to break on
2379 * @duration: timeout in mS
2380 *
2381 * Perform a timed break on hardware that lacks its own driver level
2382 * timed break functionality.
2383 *
2384 * Locking:
Alan Cox28298232006-09-29 02:00:58 -07002385 * atomic_write_lock serializes
Alan Coxaf9b8972006-08-27 01:24:01 -07002386 *
Alan Coxaf9b8972006-08-27 01:24:01 -07002387 */
2388
Domen Puncerb20f3ae2005-06-25 14:58:42 -07002389static int send_break(struct tty_struct *tty, unsigned int duration)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002390{
Alan Cox9e989662008-07-22 11:18:03 +01002391 int retval;
2392
2393 if (tty->ops->break_ctl == NULL)
2394 return 0;
2395
2396 if (tty->driver->flags & TTY_DRIVER_HARDWARE_BREAK)
2397 retval = tty->ops->break_ctl(tty, duration);
2398 else {
2399 /* Do the work ourselves */
2400 if (tty_write_lock(tty, 0) < 0)
2401 return -EINTR;
2402 retval = tty->ops->break_ctl(tty, -1);
2403 if (retval)
2404 goto out;
2405 if (!signal_pending(current))
2406 msleep_interruptible(duration);
2407 retval = tty->ops->break_ctl(tty, 0);
2408out:
2409 tty_write_unlock(tty);
2410 if (signal_pending(current))
2411 retval = -EINTR;
2412 }
2413 return retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002414}
2415
Alan Coxaf9b8972006-08-27 01:24:01 -07002416/**
Alan Coxf34d7a52008-04-30 00:54:13 -07002417 * tty_tiocmget - get modem status
Alan Coxaf9b8972006-08-27 01:24:01 -07002418 * @tty: tty device
2419 * @file: user file pointer
2420 * @p: pointer to result
2421 *
2422 * Obtain the modem status bits from the tty driver if the feature
2423 * is supported. Return -EINVAL if it is not available.
2424 *
2425 * Locking: none (up to the driver)
2426 */
2427
2428static int tty_tiocmget(struct tty_struct *tty, struct file *file, int __user *p)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002429{
2430 int retval = -EINVAL;
2431
Alan Coxf34d7a52008-04-30 00:54:13 -07002432 if (tty->ops->tiocmget) {
2433 retval = tty->ops->tiocmget(tty, file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002434
2435 if (retval >= 0)
2436 retval = put_user(retval, p);
2437 }
2438 return retval;
2439}
2440
Alan Coxaf9b8972006-08-27 01:24:01 -07002441/**
Alan Coxf34d7a52008-04-30 00:54:13 -07002442 * tty_tiocmset - set modem status
Alan Coxaf9b8972006-08-27 01:24:01 -07002443 * @tty: tty device
2444 * @file: user file pointer
2445 * @cmd: command - clear bits, set bits or set all
2446 * @p: pointer to desired bits
2447 *
2448 * Set the modem status bits from the tty driver if the feature
2449 * is supported. Return -EINVAL if it is not available.
2450 *
2451 * Locking: none (up to the driver)
2452 */
2453
2454static int tty_tiocmset(struct tty_struct *tty, struct file *file, unsigned int cmd,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002455 unsigned __user *p)
2456{
Alan Coxae677512008-07-16 21:56:54 +01002457 int retval;
2458 unsigned int set, clear, val;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002459
Alan Coxae677512008-07-16 21:56:54 +01002460 if (tty->ops->tiocmset == NULL)
2461 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002462
Alan Coxae677512008-07-16 21:56:54 +01002463 retval = get_user(val, p);
2464 if (retval)
2465 return retval;
2466 set = clear = 0;
2467 switch (cmd) {
2468 case TIOCMBIS:
2469 set = val;
2470 break;
2471 case TIOCMBIC:
2472 clear = val;
2473 break;
2474 case TIOCMSET:
2475 set = val;
2476 clear = ~val;
2477 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002478 }
Alan Coxae677512008-07-16 21:56:54 +01002479 set &= TIOCM_DTR|TIOCM_RTS|TIOCM_OUT1|TIOCM_OUT2|TIOCM_LOOP;
2480 clear &= TIOCM_DTR|TIOCM_RTS|TIOCM_OUT1|TIOCM_OUT2|TIOCM_LOOP;
2481 return tty->ops->tiocmset(tty, file, set, clear);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002482}
2483
2484/*
2485 * Split this up, as gcc can choke on it otherwise..
2486 */
Alan Cox04f378b2008-04-30 00:53:29 -07002487long tty_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002488{
2489 struct tty_struct *tty, *real_tty;
2490 void __user *p = (void __user *)arg;
2491 int retval;
2492 struct tty_ldisc *ld;
Alan Cox04f378b2008-04-30 00:53:29 -07002493 struct inode *inode = file->f_dentry->d_inode;
Alan Cox37bdfb02008-02-08 04:18:47 -08002494
Linus Torvalds1da177e2005-04-16 15:20:36 -07002495 tty = (struct tty_struct *)file->private_data;
2496 if (tty_paranoia_check(tty, inode, "tty_ioctl"))
2497 return -EINVAL;
2498
2499 real_tty = tty;
2500 if (tty->driver->type == TTY_DRIVER_TYPE_PTY &&
2501 tty->driver->subtype == PTY_TYPE_MASTER)
2502 real_tty = tty->link;
2503
Linus Torvalds1da177e2005-04-16 15:20:36 -07002504
2505 /*
2506 * Factor out some common prep work
2507 */
2508 switch (cmd) {
2509 case TIOCSETD:
2510 case TIOCSBRK:
2511 case TIOCCBRK:
2512 case TCSBRK:
Alan Cox37bdfb02008-02-08 04:18:47 -08002513 case TCSBRKP:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002514 retval = tty_check_change(tty);
2515 if (retval)
2516 return retval;
2517 if (cmd != TIOCCBRK) {
2518 tty_wait_until_sent(tty, 0);
2519 if (signal_pending(current))
2520 return -EINTR;
2521 }
2522 break;
2523 }
2524
Alan Cox9e989662008-07-22 11:18:03 +01002525 /*
2526 * Now do the stuff.
2527 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002528 switch (cmd) {
Alan Cox37bdfb02008-02-08 04:18:47 -08002529 case TIOCSTI:
2530 return tiocsti(tty, p);
2531 case TIOCGWINSZ:
Alan Cox8f520022008-10-13 10:38:46 +01002532 return tiocgwinsz(real_tty, p);
Alan Cox37bdfb02008-02-08 04:18:47 -08002533 case TIOCSWINSZ:
Alan Coxfc6f6232009-01-02 13:43:17 +00002534 return tiocswinsz(real_tty, p);
Alan Cox37bdfb02008-02-08 04:18:47 -08002535 case TIOCCONS:
2536 return real_tty != tty ? -EINVAL : tioccons(file);
2537 case FIONBIO:
2538 return fionbio(file, p);
2539 case TIOCEXCL:
2540 set_bit(TTY_EXCLUSIVE, &tty->flags);
2541 return 0;
2542 case TIOCNXCL:
2543 clear_bit(TTY_EXCLUSIVE, &tty->flags);
2544 return 0;
2545 case TIOCNOTTY:
2546 if (current->signal->tty != tty)
2547 return -ENOTTY;
2548 no_tty();
2549 return 0;
2550 case TIOCSCTTY:
2551 return tiocsctty(tty, arg);
2552 case TIOCGPGRP:
2553 return tiocgpgrp(tty, real_tty, p);
2554 case TIOCSPGRP:
2555 return tiocspgrp(tty, real_tty, p);
2556 case TIOCGSID:
2557 return tiocgsid(tty, real_tty, p);
2558 case TIOCGETD:
Alan Coxa352def2008-07-16 21:53:12 +01002559 return put_user(tty->ldisc.ops->num, (int __user *)p);
Alan Cox37bdfb02008-02-08 04:18:47 -08002560 case TIOCSETD:
2561 return tiocsetd(tty, p);
Alan Cox37bdfb02008-02-08 04:18:47 -08002562 /*
2563 * Break handling
2564 */
2565 case TIOCSBRK: /* Turn break on, unconditionally */
Alan Coxf34d7a52008-04-30 00:54:13 -07002566 if (tty->ops->break_ctl)
Alan Cox9e989662008-07-22 11:18:03 +01002567 return tty->ops->break_ctl(tty, -1);
Alan Cox37bdfb02008-02-08 04:18:47 -08002568 return 0;
Alan Cox37bdfb02008-02-08 04:18:47 -08002569 case TIOCCBRK: /* Turn break off, unconditionally */
Alan Coxf34d7a52008-04-30 00:54:13 -07002570 if (tty->ops->break_ctl)
Alan Cox9e989662008-07-22 11:18:03 +01002571 return tty->ops->break_ctl(tty, 0);
Alan Cox37bdfb02008-02-08 04:18:47 -08002572 return 0;
2573 case TCSBRK: /* SVID version: non-zero arg --> no break */
2574 /* non-zero arg means wait for all output data
2575 * to be sent (performed above) but don't send break.
2576 * This is used by the tcdrain() termios function.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002577 */
Alan Cox37bdfb02008-02-08 04:18:47 -08002578 if (!arg)
2579 return send_break(tty, 250);
2580 return 0;
2581 case TCSBRKP: /* support for POSIX tcsendbreak() */
2582 return send_break(tty, arg ? arg*100 : 250);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002583
Alan Cox37bdfb02008-02-08 04:18:47 -08002584 case TIOCMGET:
2585 return tty_tiocmget(tty, file, p);
2586 case TIOCMSET:
2587 case TIOCMBIC:
2588 case TIOCMBIS:
2589 return tty_tiocmset(tty, file, cmd, p);
2590 case TCFLSH:
2591 switch (arg) {
2592 case TCIFLUSH:
2593 case TCIOFLUSH:
2594 /* flush tty buffer and allow ldisc to process ioctl */
2595 tty_buffer_flush(tty);
Paul Fulghumc5c34d42007-05-12 10:36:55 -07002596 break;
Alan Cox37bdfb02008-02-08 04:18:47 -08002597 }
2598 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002599 }
Alan Coxf34d7a52008-04-30 00:54:13 -07002600 if (tty->ops->ioctl) {
2601 retval = (tty->ops->ioctl)(tty, file, cmd, arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002602 if (retval != -ENOIOCTLCMD)
2603 return retval;
2604 }
2605 ld = tty_ldisc_ref_wait(tty);
2606 retval = -EINVAL;
Alan Coxa352def2008-07-16 21:53:12 +01002607 if (ld->ops->ioctl) {
2608 retval = ld->ops->ioctl(tty, file, cmd, arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002609 if (retval == -ENOIOCTLCMD)
2610 retval = -EINVAL;
2611 }
2612 tty_ldisc_deref(ld);
2613 return retval;
2614}
2615
Paul Fulghume10cc1d2007-05-10 22:22:50 -07002616#ifdef CONFIG_COMPAT
Alan Cox37bdfb02008-02-08 04:18:47 -08002617static long tty_compat_ioctl(struct file *file, unsigned int cmd,
Paul Fulghume10cc1d2007-05-10 22:22:50 -07002618 unsigned long arg)
2619{
2620 struct inode *inode = file->f_dentry->d_inode;
2621 struct tty_struct *tty = file->private_data;
2622 struct tty_ldisc *ld;
2623 int retval = -ENOIOCTLCMD;
2624
2625 if (tty_paranoia_check(tty, inode, "tty_ioctl"))
2626 return -EINVAL;
2627
Alan Coxf34d7a52008-04-30 00:54:13 -07002628 if (tty->ops->compat_ioctl) {
2629 retval = (tty->ops->compat_ioctl)(tty, file, cmd, arg);
Paul Fulghume10cc1d2007-05-10 22:22:50 -07002630 if (retval != -ENOIOCTLCMD)
2631 return retval;
2632 }
2633
2634 ld = tty_ldisc_ref_wait(tty);
Alan Coxa352def2008-07-16 21:53:12 +01002635 if (ld->ops->compat_ioctl)
2636 retval = ld->ops->compat_ioctl(tty, file, cmd, arg);
Paul Fulghume10cc1d2007-05-10 22:22:50 -07002637 tty_ldisc_deref(ld);
2638
2639 return retval;
2640}
2641#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07002642
2643/*
2644 * This implements the "Secure Attention Key" --- the idea is to
2645 * prevent trojan horses by killing all processes associated with this
2646 * tty when the user hits the "Secure Attention Key". Required for
2647 * super-paranoid applications --- see the Orange Book for more details.
Alan Cox37bdfb02008-02-08 04:18:47 -08002648 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07002649 * This code could be nicer; ideally it should send a HUP, wait a few
2650 * seconds, then send a INT, and then a KILL signal. But you then
2651 * have to coordinate with the init process, since all processes associated
2652 * with the current tty must be dead before the new getty is allowed
2653 * to spawn.
2654 *
2655 * Now, if it would be correct ;-/ The current code has a nasty hole -
2656 * it doesn't catch files in flight. We may send the descriptor to ourselves
2657 * via AF_UNIX socket, close it and later fetch from socket. FIXME.
2658 *
2659 * Nasty bug: do_SAK is being called in interrupt context. This can
2660 * deadlock. We punt it up to process context. AKPM - 16Mar2001
2661 */
Eric W. Biederman8b6312f2007-02-10 01:44:34 -08002662void __do_SAK(struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002663{
2664#ifdef TTY_SOFT_SAK
2665 tty_hangup(tty);
2666#else
Eric W. Biederman652486f2006-03-28 16:11:02 -08002667 struct task_struct *g, *p;
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08002668 struct pid *session;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002669 int i;
2670 struct file *filp;
Dipankar Sarmabadf1662005-09-09 13:04:10 -07002671 struct fdtable *fdt;
Alan Cox37bdfb02008-02-08 04:18:47 -08002672
Linus Torvalds1da177e2005-04-16 15:20:36 -07002673 if (!tty)
2674 return;
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002675 session = tty->session;
Alan Cox37bdfb02008-02-08 04:18:47 -08002676
Dan Carpenterb3f13de2006-12-13 00:35:09 -08002677 tty_ldisc_flush(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002678
Alan Coxf34d7a52008-04-30 00:54:13 -07002679 tty_driver_flush_buffer(tty);
Alan Cox37bdfb02008-02-08 04:18:47 -08002680
Linus Torvalds1da177e2005-04-16 15:20:36 -07002681 read_lock(&tasklist_lock);
Eric W. Biederman652486f2006-03-28 16:11:02 -08002682 /* Kill the entire session */
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08002683 do_each_pid_task(session, PIDTYPE_SID, p) {
Eric W. Biederman652486f2006-03-28 16:11:02 -08002684 printk(KERN_NOTICE "SAK: killed process %d"
Oleg Nesterov1b0f7ff2009-04-02 16:58:39 -07002685 " (%s): task_session(p)==tty->session\n",
Pavel Emelyanovba25f9d2007-10-18 23:40:40 -07002686 task_pid_nr(p), p->comm);
Eric W. Biederman652486f2006-03-28 16:11:02 -08002687 send_sig(SIGKILL, p, 1);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08002688 } while_each_pid_task(session, PIDTYPE_SID, p);
Eric W. Biederman652486f2006-03-28 16:11:02 -08002689 /* Now kill any processes that happen to have the
2690 * tty open.
2691 */
2692 do_each_thread(g, p) {
2693 if (p->signal->tty == tty) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002694 printk(KERN_NOTICE "SAK: killed process %d"
Oleg Nesterov1b0f7ff2009-04-02 16:58:39 -07002695 " (%s): task_session(p)==tty->session\n",
Pavel Emelyanovba25f9d2007-10-18 23:40:40 -07002696 task_pid_nr(p), p->comm);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002697 send_sig(SIGKILL, p, 1);
2698 continue;
2699 }
2700 task_lock(p);
2701 if (p->files) {
Dipankar Sarmaca99c1d2006-04-18 22:21:46 -07002702 /*
2703 * We don't take a ref to the file, so we must
2704 * hold ->file_lock instead.
2705 */
2706 spin_lock(&p->files->file_lock);
Dipankar Sarmabadf1662005-09-09 13:04:10 -07002707 fdt = files_fdtable(p->files);
Alan Cox37bdfb02008-02-08 04:18:47 -08002708 for (i = 0; i < fdt->max_fds; i++) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002709 filp = fcheck_files(p->files, i);
2710 if (!filp)
2711 continue;
2712 if (filp->f_op->read == tty_read &&
2713 filp->private_data == tty) {
2714 printk(KERN_NOTICE "SAK: killed process %d"
2715 " (%s): fd#%d opened to the tty\n",
Pavel Emelyanovba25f9d2007-10-18 23:40:40 -07002716 task_pid_nr(p), p->comm, i);
Eric W. Biederman20ac9432006-04-13 04:49:07 -06002717 force_sig(SIGKILL, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002718 break;
2719 }
2720 }
Dipankar Sarmaca99c1d2006-04-18 22:21:46 -07002721 spin_unlock(&p->files->file_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002722 }
2723 task_unlock(p);
Eric W. Biederman652486f2006-03-28 16:11:02 -08002724 } while_each_thread(g, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002725 read_unlock(&tasklist_lock);
2726#endif
2727}
2728
Eric W. Biederman8b6312f2007-02-10 01:44:34 -08002729static void do_SAK_work(struct work_struct *work)
2730{
2731 struct tty_struct *tty =
2732 container_of(work, struct tty_struct, SAK_work);
2733 __do_SAK(tty);
2734}
2735
Linus Torvalds1da177e2005-04-16 15:20:36 -07002736/*
2737 * The tq handling here is a little racy - tty->SAK_work may already be queued.
2738 * Fortunately we don't need to worry, because if ->SAK_work is already queued,
2739 * the values which we write to it will be identical to the values which it
2740 * already has. --akpm
2741 */
2742void do_SAK(struct tty_struct *tty)
2743{
2744 if (!tty)
2745 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002746 schedule_work(&tty->SAK_work);
2747}
2748
2749EXPORT_SYMBOL(do_SAK);
2750
Alan Coxaf9b8972006-08-27 01:24:01 -07002751/**
Alan Coxaf9b8972006-08-27 01:24:01 -07002752 * initialize_tty_struct
2753 * @tty: tty to initialize
2754 *
2755 * This subroutine initializes a tty structure that has been newly
2756 * allocated.
2757 *
2758 * Locking: none - tty in question must not be exposed at this point
Linus Torvalds1da177e2005-04-16 15:20:36 -07002759 */
Alan Coxaf9b8972006-08-27 01:24:01 -07002760
Alan Coxbf970ee2008-10-13 10:42:39 +01002761void initialize_tty_struct(struct tty_struct *tty,
2762 struct tty_driver *driver, int idx)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002763{
2764 memset(tty, 0, sizeof(struct tty_struct));
Alan Cox9c9f4de2008-10-13 10:37:26 +01002765 kref_init(&tty->kref);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002766 tty->magic = TTY_MAGIC;
Alan Cox01e1abb2008-07-22 11:16:55 +01002767 tty_ldisc_init(tty);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08002768 tty->session = NULL;
2769 tty->pgrp = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002770 tty->overrun_time = jiffies;
Alan Cox33f0f882006-01-09 20:54:13 -08002771 tty->buf.head = tty->buf.tail = NULL;
2772 tty_buffer_init(tty);
Arjan van de Ven5785c952006-09-29 02:00:43 -07002773 mutex_init(&tty->termios_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002774 init_waitqueue_head(&tty->write_wait);
2775 init_waitqueue_head(&tty->read_wait);
David Howells65f27f32006-11-22 14:55:48 +00002776 INIT_WORK(&tty->hangup_work, do_tty_hangup);
Ingo Molnar70522e12006-03-23 03:00:31 -08002777 mutex_init(&tty->atomic_read_lock);
2778 mutex_init(&tty->atomic_write_lock);
Joe Petersona88a69c2009-01-02 13:40:53 +00002779 mutex_init(&tty->output_lock);
2780 mutex_init(&tty->echo_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002781 spin_lock_init(&tty->read_lock);
Alan Cox04f378b2008-04-30 00:53:29 -07002782 spin_lock_init(&tty->ctrl_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002783 INIT_LIST_HEAD(&tty->tty_files);
Eric W. Biederman7f1f86a2007-02-13 14:38:58 -07002784 INIT_WORK(&tty->SAK_work, do_SAK_work);
Alan Coxbf970ee2008-10-13 10:42:39 +01002785
2786 tty->driver = driver;
2787 tty->ops = driver->ops;
2788 tty->index = idx;
2789 tty_line_name(driver, idx, tty->name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002790}
2791
Alan Coxf34d7a52008-04-30 00:54:13 -07002792/**
2793 * tty_put_char - write one character to a tty
2794 * @tty: tty
2795 * @ch: character
2796 *
2797 * Write one byte to the tty using the provided put_char method
2798 * if present. Returns the number of characters successfully output.
2799 *
2800 * Note: the specific put_char operation in the driver layer may go
2801 * away soon. Don't call it directly, use this method
Linus Torvalds1da177e2005-04-16 15:20:36 -07002802 */
Alan Coxaf9b8972006-08-27 01:24:01 -07002803
Alan Coxf34d7a52008-04-30 00:54:13 -07002804int tty_put_char(struct tty_struct *tty, unsigned char ch)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002805{
Alan Coxf34d7a52008-04-30 00:54:13 -07002806 if (tty->ops->put_char)
2807 return tty->ops->put_char(tty, ch);
2808 return tty->ops->write(tty, &ch, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002809}
Alan Coxf34d7a52008-04-30 00:54:13 -07002810EXPORT_SYMBOL_GPL(tty_put_char);
2811
Alan Coxd81ed102008-10-13 10:41:42 +01002812struct class *tty_class;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002813
2814/**
Alan Coxaf9b8972006-08-27 01:24:01 -07002815 * tty_register_device - register a tty device
2816 * @driver: the tty driver that describes the tty device
2817 * @index: the index in the tty driver for this tty device
2818 * @device: a struct device that is associated with this tty device.
2819 * This field is optional, if there is no known struct device
2820 * for this tty device it can be set to NULL safely.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002821 *
Greg Kroah-Hartman01107d32006-08-07 22:19:37 -07002822 * Returns a pointer to the struct device for this tty device
2823 * (or ERR_PTR(-EFOO) on error).
Hansjoerg Lipp1cdcb6b2006-04-22 18:36:53 +02002824 *
Alan Coxaf9b8972006-08-27 01:24:01 -07002825 * This call is required to be made to register an individual tty device
2826 * if the tty driver's flags have the TTY_DRIVER_DYNAMIC_DEV bit set. If
2827 * that bit is not set, this function should not be called by a tty
2828 * driver.
2829 *
2830 * Locking: ??
Linus Torvalds1da177e2005-04-16 15:20:36 -07002831 */
Alan Coxaf9b8972006-08-27 01:24:01 -07002832
Greg Kroah-Hartman01107d32006-08-07 22:19:37 -07002833struct device *tty_register_device(struct tty_driver *driver, unsigned index,
2834 struct device *device)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002835{
2836 char name[64];
2837 dev_t dev = MKDEV(driver->major, driver->minor_start) + index;
2838
2839 if (index >= driver->num) {
2840 printk(KERN_ERR "Attempt to register invalid tty line number "
2841 " (%d).\n", index);
Hansjoerg Lipp1cdcb6b2006-04-22 18:36:53 +02002842 return ERR_PTR(-EINVAL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002843 }
2844
Linus Torvalds1da177e2005-04-16 15:20:36 -07002845 if (driver->type == TTY_DRIVER_TYPE_PTY)
2846 pty_line_name(driver, index, name);
2847 else
2848 tty_line_name(driver, index, name);
Hansjoerg Lipp1cdcb6b2006-04-22 18:36:53 +02002849
Greg Kroah-Hartman03457cd2008-07-21 20:03:34 -07002850 return device_create(tty_class, device, dev, NULL, name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002851}
Alan Cox7d7b93c2008-10-13 10:42:09 +01002852EXPORT_SYMBOL(tty_register_device);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002853
2854/**
Alan Coxaf9b8972006-08-27 01:24:01 -07002855 * tty_unregister_device - unregister a tty device
2856 * @driver: the tty driver that describes the tty device
2857 * @index: the index in the tty driver for this tty device
Linus Torvalds1da177e2005-04-16 15:20:36 -07002858 *
Alan Coxaf9b8972006-08-27 01:24:01 -07002859 * If a tty device is registered with a call to tty_register_device() then
2860 * this function must be called when the tty device is gone.
2861 *
2862 * Locking: ??
Linus Torvalds1da177e2005-04-16 15:20:36 -07002863 */
Alan Coxaf9b8972006-08-27 01:24:01 -07002864
Linus Torvalds1da177e2005-04-16 15:20:36 -07002865void tty_unregister_device(struct tty_driver *driver, unsigned index)
2866{
Alan Cox37bdfb02008-02-08 04:18:47 -08002867 device_destroy(tty_class,
2868 MKDEV(driver->major, driver->minor_start) + index);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002869}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002870EXPORT_SYMBOL(tty_unregister_device);
2871
2872struct tty_driver *alloc_tty_driver(int lines)
2873{
2874 struct tty_driver *driver;
2875
Jean Delvare506eb992007-07-15 23:40:14 -07002876 driver = kzalloc(sizeof(struct tty_driver), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002877 if (driver) {
Alan Cox7d7b93c2008-10-13 10:42:09 +01002878 kref_init(&driver->kref);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002879 driver->magic = TTY_DRIVER_MAGIC;
2880 driver->num = lines;
2881 /* later we'll move allocation of tables here */
2882 }
2883 return driver;
2884}
Alan Cox7d7b93c2008-10-13 10:42:09 +01002885EXPORT_SYMBOL(alloc_tty_driver);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002886
Alan Cox7d7b93c2008-10-13 10:42:09 +01002887static void destruct_tty_driver(struct kref *kref)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002888{
Alan Cox7d7b93c2008-10-13 10:42:09 +01002889 struct tty_driver *driver = container_of(kref, struct tty_driver, kref);
2890 int i;
2891 struct ktermios *tp;
2892 void *p;
2893
2894 if (driver->flags & TTY_DRIVER_INSTALLED) {
2895 /*
2896 * Free the termios and termios_locked structures because
2897 * we don't want to get memory leaks when modular tty
2898 * drivers are removed from the kernel.
2899 */
2900 for (i = 0; i < driver->num; i++) {
2901 tp = driver->termios[i];
2902 if (tp) {
2903 driver->termios[i] = NULL;
2904 kfree(tp);
2905 }
Alan Cox7d7b93c2008-10-13 10:42:09 +01002906 if (!(driver->flags & TTY_DRIVER_DYNAMIC_DEV))
2907 tty_unregister_device(driver, i);
2908 }
2909 p = driver->ttys;
2910 proc_tty_unregister_driver(driver);
2911 driver->ttys = NULL;
Alan Coxfe6e29f2008-10-13 10:44:08 +01002912 driver->termios = NULL;
Alan Cox7d7b93c2008-10-13 10:42:09 +01002913 kfree(p);
2914 cdev_del(&driver->cdev);
2915 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002916 kfree(driver);
2917}
2918
Alan Cox7d7b93c2008-10-13 10:42:09 +01002919void tty_driver_kref_put(struct tty_driver *driver)
2920{
2921 kref_put(&driver->kref, destruct_tty_driver);
2922}
2923EXPORT_SYMBOL(tty_driver_kref_put);
2924
Jeff Dikeb68e31d2006-10-02 02:17:18 -07002925void tty_set_operations(struct tty_driver *driver,
2926 const struct tty_operations *op)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002927{
Alan Coxf34d7a52008-04-30 00:54:13 -07002928 driver->ops = op;
2929};
Linus Torvalds1da177e2005-04-16 15:20:36 -07002930EXPORT_SYMBOL(tty_set_operations);
2931
Alan Cox7d7b93c2008-10-13 10:42:09 +01002932void put_tty_driver(struct tty_driver *d)
2933{
2934 tty_driver_kref_put(d);
2935}
2936EXPORT_SYMBOL(put_tty_driver);
2937
Linus Torvalds1da177e2005-04-16 15:20:36 -07002938/*
2939 * Called by a tty driver to register itself.
2940 */
2941int tty_register_driver(struct tty_driver *driver)
2942{
2943 int error;
Alan Cox37bdfb02008-02-08 04:18:47 -08002944 int i;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002945 dev_t dev;
2946 void **p = NULL;
2947
Andy Whitcroft543691a62007-05-06 14:49:33 -07002948 if (!(driver->flags & TTY_DRIVER_DEVPTS_MEM) && driver->num) {
Alan Coxfe6e29f2008-10-13 10:44:08 +01002949 p = kzalloc(driver->num * 2 * sizeof(void *), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002950 if (!p)
2951 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002952 }
2953
2954 if (!driver->major) {
Alan Cox37bdfb02008-02-08 04:18:47 -08002955 error = alloc_chrdev_region(&dev, driver->minor_start,
2956 driver->num, driver->name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002957 if (!error) {
2958 driver->major = MAJOR(dev);
2959 driver->minor_start = MINOR(dev);
2960 }
2961 } else {
2962 dev = MKDEV(driver->major, driver->minor_start);
Geert Uytterhoevene5717c42007-02-20 15:45:21 +01002963 error = register_chrdev_region(dev, driver->num, driver->name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002964 }
2965 if (error < 0) {
2966 kfree(p);
2967 return error;
2968 }
2969
2970 if (p) {
2971 driver->ttys = (struct tty_struct **)p;
Alan Coxedc6afc2006-12-08 02:38:44 -08002972 driver->termios = (struct ktermios **)(p + driver->num);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002973 } else {
2974 driver->ttys = NULL;
2975 driver->termios = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002976 }
2977
2978 cdev_init(&driver->cdev, &tty_fops);
2979 driver->cdev.owner = driver->owner;
2980 error = cdev_add(&driver->cdev, dev, driver->num);
2981 if (error) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002982 unregister_chrdev_region(dev, driver->num);
2983 driver->ttys = NULL;
Alan Coxfe6e29f2008-10-13 10:44:08 +01002984 driver->termios = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002985 kfree(p);
2986 return error;
2987 }
2988
Alexey Dobriyanca509f62007-05-08 00:27:12 -07002989 mutex_lock(&tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002990 list_add(&driver->tty_drivers, &tty_drivers);
Alexey Dobriyanca509f62007-05-08 00:27:12 -07002991 mutex_unlock(&tty_mutex);
Alan Cox37bdfb02008-02-08 04:18:47 -08002992
2993 if (!(driver->flags & TTY_DRIVER_DYNAMIC_DEV)) {
2994 for (i = 0; i < driver->num; i++)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002995 tty_register_device(driver, i, NULL);
2996 }
2997 proc_tty_register_driver(driver);
Alan Cox7d7b93c2008-10-13 10:42:09 +01002998 driver->flags |= TTY_DRIVER_INSTALLED;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002999 return 0;
3000}
3001
3002EXPORT_SYMBOL(tty_register_driver);
3003
3004/*
3005 * Called by a tty driver to unregister itself.
3006 */
3007int tty_unregister_driver(struct tty_driver *driver)
3008{
Alan Cox7d7b93c2008-10-13 10:42:09 +01003009#if 0
3010 /* FIXME */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003011 if (driver->refcount)
3012 return -EBUSY;
Alan Cox7d7b93c2008-10-13 10:42:09 +01003013#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07003014 unregister_chrdev_region(MKDEV(driver->major, driver->minor_start),
3015 driver->num);
Alexey Dobriyanca509f62007-05-08 00:27:12 -07003016 mutex_lock(&tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003017 list_del(&driver->tty_drivers);
Alexey Dobriyanca509f62007-05-08 00:27:12 -07003018 mutex_unlock(&tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003019 return 0;
3020}
Alan Cox7d7b93c2008-10-13 10:42:09 +01003021
Linus Torvalds1da177e2005-04-16 15:20:36 -07003022EXPORT_SYMBOL(tty_unregister_driver);
3023
Peter Zijlstra24ec8392006-12-08 02:36:04 -08003024dev_t tty_devnum(struct tty_struct *tty)
3025{
3026 return MKDEV(tty->driver->major, tty->driver->minor_start) + tty->index;
3027}
3028EXPORT_SYMBOL(tty_devnum);
3029
3030void proc_clear_tty(struct task_struct *p)
3031{
Arjan van de Ven7c3b1dc2008-10-15 10:52:34 +01003032 unsigned long flags;
Alan Cox9c9f4de2008-10-13 10:37:26 +01003033 struct tty_struct *tty;
Arjan van de Ven7c3b1dc2008-10-15 10:52:34 +01003034 spin_lock_irqsave(&p->sighand->siglock, flags);
Alan Cox9c9f4de2008-10-13 10:37:26 +01003035 tty = p->signal->tty;
Peter Zijlstra24ec8392006-12-08 02:36:04 -08003036 p->signal->tty = NULL;
Arjan van de Ven7c3b1dc2008-10-15 10:52:34 +01003037 spin_unlock_irqrestore(&p->sighand->siglock, flags);
Alan Cox9c9f4de2008-10-13 10:37:26 +01003038 tty_kref_put(tty);
Peter Zijlstra24ec8392006-12-08 02:36:04 -08003039}
Peter Zijlstra24ec8392006-12-08 02:36:04 -08003040
Alan Cox47f86832008-04-30 00:53:30 -07003041/* Called under the sighand lock */
3042
Eric W. Biederman2a65f1d2007-05-08 00:26:53 -07003043static void __proc_set_tty(struct task_struct *tsk, struct tty_struct *tty)
Peter Zijlstra24ec8392006-12-08 02:36:04 -08003044{
3045 if (tty) {
Alan Cox47f86832008-04-30 00:53:30 -07003046 unsigned long flags;
3047 /* We should not have a session or pgrp to put here but.... */
3048 spin_lock_irqsave(&tty->ctrl_lock, flags);
Eric W. Biedermand9c1e9a2007-03-18 12:45:44 -06003049 put_pid(tty->session);
3050 put_pid(tty->pgrp);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08003051 tty->pgrp = get_pid(task_pgrp(tsk));
Alan Cox47f86832008-04-30 00:53:30 -07003052 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
3053 tty->session = get_pid(task_session(tsk));
Alan Cox9c9f4de2008-10-13 10:37:26 +01003054 if (tsk->signal->tty) {
3055 printk(KERN_DEBUG "tty not NULL!!\n");
3056 tty_kref_put(tsk->signal->tty);
3057 }
Peter Zijlstra24ec8392006-12-08 02:36:04 -08003058 }
Eric W. Biederman2a65f1d2007-05-08 00:26:53 -07003059 put_pid(tsk->signal->tty_old_pgrp);
Alan Cox9c9f4de2008-10-13 10:37:26 +01003060 tsk->signal->tty = tty_kref_get(tty);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08003061 tsk->signal->tty_old_pgrp = NULL;
Peter Zijlstra24ec8392006-12-08 02:36:04 -08003062}
3063
Eric W. Biederman98a27ba2007-05-08 00:26:56 -07003064static void proc_set_tty(struct task_struct *tsk, struct tty_struct *tty)
Peter Zijlstra24ec8392006-12-08 02:36:04 -08003065{
3066 spin_lock_irq(&tsk->sighand->siglock);
Eric W. Biederman2a65f1d2007-05-08 00:26:53 -07003067 __proc_set_tty(tsk, tty);
Peter Zijlstra24ec8392006-12-08 02:36:04 -08003068 spin_unlock_irq(&tsk->sighand->siglock);
3069}
3070
3071struct tty_struct *get_current_tty(void)
3072{
3073 struct tty_struct *tty;
Alan Cox934e6eb2008-10-13 10:40:43 +01003074 unsigned long flags;
3075
3076 spin_lock_irqsave(&current->sighand->siglock, flags);
Alan Cox452a00d2008-10-13 10:39:13 +01003077 tty = tty_kref_get(current->signal->tty);
Alan Cox934e6eb2008-10-13 10:40:43 +01003078 spin_unlock_irqrestore(&current->sighand->siglock, flags);
Peter Zijlstra24ec8392006-12-08 02:36:04 -08003079 return tty;
3080}
Heiko Carstensa311f742006-12-13 00:33:41 -08003081EXPORT_SYMBOL_GPL(get_current_tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003082
Alan Coxd81ed102008-10-13 10:41:42 +01003083void tty_default_fops(struct file_operations *fops)
3084{
3085 *fops = tty_fops;
3086}
3087
Linus Torvalds1da177e2005-04-16 15:20:36 -07003088/*
3089 * Initialize the console device. This is called *early*, so
3090 * we can't necessarily depend on lots of kernel help here.
3091 * Just do some early initializations, and do the complex setup
3092 * later.
3093 */
3094void __init console_init(void)
3095{
3096 initcall_t *call;
3097
3098 /* Setup the default TTY line discipline. */
Alan Cox01e1abb2008-07-22 11:16:55 +01003099 tty_ldisc_begin();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003100
3101 /*
Alan Cox37bdfb02008-02-08 04:18:47 -08003102 * set up the console device so that later boot sequences can
Linus Torvalds1da177e2005-04-16 15:20:36 -07003103 * inform about problems etc..
3104 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003105 call = __con_initcall_start;
3106 while (call < __con_initcall_end) {
3107 (*call)();
3108 call++;
3109 }
3110}
3111
Linus Torvalds1da177e2005-04-16 15:20:36 -07003112static int __init tty_class_init(void)
3113{
gregkh@suse.de7fe845d2005-03-15 14:23:15 -08003114 tty_class = class_create(THIS_MODULE, "tty");
Linus Torvalds1da177e2005-04-16 15:20:36 -07003115 if (IS_ERR(tty_class))
3116 return PTR_ERR(tty_class);
3117 return 0;
3118}
3119
3120postcore_initcall(tty_class_init);
3121
3122/* 3/2004 jmc: why do these devices exist? */
3123
3124static struct cdev tty_cdev, console_cdev;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003125
3126/*
3127 * Ok, now we can initialize the rest of the tty devices and can count
3128 * on memory allocations, interrupts etc..
3129 */
3130static int __init tty_init(void)
3131{
3132 cdev_init(&tty_cdev, &tty_fops);
3133 if (cdev_add(&tty_cdev, MKDEV(TTYAUX_MAJOR, 0), 1) ||
3134 register_chrdev_region(MKDEV(TTYAUX_MAJOR, 0), 1, "/dev/tty") < 0)
3135 panic("Couldn't register /dev/tty driver\n");
Alan Coxd81ed102008-10-13 10:41:42 +01003136 device_create(tty_class, NULL, MKDEV(TTYAUX_MAJOR, 0), NULL,
Greg Kroah-Hartman47aa5792008-05-21 12:52:33 -07003137 "tty");
Linus Torvalds1da177e2005-04-16 15:20:36 -07003138
3139 cdev_init(&console_cdev, &console_fops);
3140 if (cdev_add(&console_cdev, MKDEV(TTYAUX_MAJOR, 1), 1) ||
3141 register_chrdev_region(MKDEV(TTYAUX_MAJOR, 1), 1, "/dev/console") < 0)
3142 panic("Couldn't register /dev/console driver\n");
Alan Coxd81ed102008-10-13 10:41:42 +01003143 device_create(tty_class, NULL, MKDEV(TTYAUX_MAJOR, 1), NULL,
Greg Kroah-Hartman47aa5792008-05-21 12:52:33 -07003144 "console");
Linus Torvalds1da177e2005-04-16 15:20:36 -07003145
Linus Torvalds1da177e2005-04-16 15:20:36 -07003146#ifdef CONFIG_VT
Alan Coxd81ed102008-10-13 10:41:42 +01003147 vty_init(&console_fops);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003148#endif
3149 return 0;
3150}
3151module_init(tty_init);