TTY: add support for unnumbered device nodes
[linux-2.6-block.git] / drivers / tty / tty_io.c
CommitLineData
1da177e4 1/*
1da177e4
LT
2 * Copyright (C) 1991, 1992 Linus Torvalds
3 */
4
5/*
6 * 'tty_io.c' gives an orthogonal feeling to tty's, be they consoles
7 * or rs-channels. It also implements echoing, cooked mode etc.
8 *
9 * Kill-line thanks to John T Kohl, who also corrected VMIN = VTIME = 0.
10 *
11 * Modified by Theodore Ts'o, 9/14/92, to dynamically allocate the
12 * tty_struct and tty_queue structures. Previously there was an array
13 * of 256 tty_struct's which was statically allocated, and the
14 * tty_queue structures were allocated at boot time. Both are now
15 * dynamically allocated only when the tty is open.
16 *
17 * Also restructured routines so that there is more of a separation
18 * between the high-level tty routines (tty_io.c and tty_ioctl.c) and
19 * the low-level tty routines (serial.c, pty.c, console.c). This
37bdfb07 20 * makes for cleaner and more compact code. -TYT, 9/17/92
1da177e4
LT
21 *
22 * Modified by Fred N. van Kempen, 01/29/93, to add line disciplines
23 * which can be dynamically activated and de-activated by the line
24 * discipline handling modules (like SLIP).
25 *
26 * NOTE: pay no attention to the line discipline code (yet); its
27 * interface is still subject to change in this version...
28 * -- TYT, 1/31/92
29 *
30 * Added functionality to the OPOST tty handling. No delays, but all
31 * other bits should be there.
32 * -- Nick Holloway <alfie@dcs.warwick.ac.uk>, 27th May 1993.
33 *
34 * Rewrote canonical mode and added more termios flags.
35 * -- julian@uhunix.uhcc.hawaii.edu (J. Cowley), 13Jan94
36 *
37 * Reorganized FASYNC support so mouse code can share it.
38 * -- ctm@ardi.com, 9Sep95
39 *
40 * New TIOCLINUX variants added.
41 * -- mj@k332.feld.cvut.cz, 19-Nov-95
37bdfb07 42 *
1da177e4
LT
43 * Restrict vt switching via ioctl()
44 * -- grif@cs.ucr.edu, 5-Dec-95
45 *
46 * Move console and virtual terminal code to more appropriate files,
47 * implement CONFIG_VT and generalize console device interface.
48 * -- Marko Kohtala <Marko.Kohtala@hut.fi>, March 97
49 *
d81ed103 50 * Rewrote tty_init_dev and tty_release_dev to eliminate races.
1da177e4
LT
51 * -- Bill Hawes <whawes@star.net>, June 97
52 *
53 * Added devfs support.
54 * -- C. Scott Ananian <cananian@alumni.princeton.edu>, 13-Jan-1998
55 *
56 * Added support for a Unix98-style ptmx device.
57 * -- C. Scott Ananian <cananian@alumni.princeton.edu>, 14-Jan-1998
58 *
59 * Reduced memory usage for older ARM systems
60 * -- Russell King <rmk@arm.linux.org.uk>
61 *
62 * Move do_SAK() into process context. Less stack use in devfs functions.
37bdfb07
AC
63 * alloc_tty_struct() always uses kmalloc()
64 * -- Andrew Morton <andrewm@uow.edu.eu> 17Mar01
1da177e4
LT
65 */
66
1da177e4
LT
67#include <linux/types.h>
68#include <linux/major.h>
69#include <linux/errno.h>
70#include <linux/signal.h>
71#include <linux/fcntl.h>
72#include <linux/sched.h>
73#include <linux/interrupt.h>
74#include <linux/tty.h>
75#include <linux/tty_driver.h>
76#include <linux/tty_flip.h>
77#include <linux/devpts_fs.h>
78#include <linux/file.h>
9f3acc31 79#include <linux/fdtable.h>
1da177e4
LT
80#include <linux/console.h>
81#include <linux/timer.h>
82#include <linux/ctype.h>
83#include <linux/kd.h>
84#include <linux/mm.h>
85#include <linux/string.h>
86#include <linux/slab.h>
87#include <linux/poll.h>
88#include <linux/proc_fs.h>
89#include <linux/init.h>
90#include <linux/module.h>
1da177e4 91#include <linux/device.h>
1da177e4
LT
92#include <linux/wait.h>
93#include <linux/bitops.h>
b20f3ae5 94#include <linux/delay.h>
a352def2 95#include <linux/seq_file.h>
d281da7f 96#include <linux/serial.h>
5a3c6b25 97#include <linux/ratelimit.h>
1da177e4 98
a352def2 99#include <linux/uaccess.h>
1da177e4
LT
100
101#include <linux/kbd_kern.h>
102#include <linux/vt_kern.h>
103#include <linux/selection.h>
1da177e4
LT
104
105#include <linux/kmod.h>
b488893a 106#include <linux/nsproxy.h>
1da177e4
LT
107
108#undef TTY_DEBUG_HANGUP
109
110#define TTY_PARANOIA_CHECK 1
111#define CHECK_TTY_COUNT 1
112
edc6afc5 113struct ktermios tty_std_termios = { /* for the benefit of tty drivers */
1da177e4
LT
114 .c_iflag = ICRNL | IXON,
115 .c_oflag = OPOST | ONLCR,
116 .c_cflag = B38400 | CS8 | CREAD | HUPCL,
117 .c_lflag = ISIG | ICANON | ECHO | ECHOE | ECHOK |
118 ECHOCTL | ECHOKE | IEXTEN,
edc6afc5
AC
119 .c_cc = INIT_C_CC,
120 .c_ispeed = 38400,
121 .c_ospeed = 38400
1da177e4
LT
122};
123
124EXPORT_SYMBOL(tty_std_termios);
125
126/* This list gets poked at by procfs and various bits of boot up code. This
127 could do with some rationalisation such as pulling the tty proc function
128 into this file */
37bdfb07 129
1da177e4
LT
130LIST_HEAD(tty_drivers); /* linked list of tty drivers */
131
24ec839c 132/* Mutex to protect creating and releasing a tty. This is shared with
1da177e4 133 vt.c for deeply disgusting hack reasons */
70522e12 134DEFINE_MUTEX(tty_mutex);
de2a84f2 135EXPORT_SYMBOL(tty_mutex);
1da177e4 136
ee2ffa0d
NP
137/* Spinlock to protect the tty->tty_files list */
138DEFINE_SPINLOCK(tty_files_lock);
139
1da177e4
LT
140static ssize_t tty_read(struct file *, char __user *, size_t, loff_t *);
141static ssize_t tty_write(struct file *, const char __user *, size_t, loff_t *);
37bdfb07
AC
142ssize_t redirected_tty_write(struct file *, const char __user *,
143 size_t, loff_t *);
1da177e4
LT
144static unsigned int tty_poll(struct file *, poll_table *);
145static int tty_open(struct inode *, struct file *);
04f378b1 146long tty_ioctl(struct file *file, unsigned int cmd, unsigned long arg);
e10cc1df 147#ifdef CONFIG_COMPAT
37bdfb07 148static long tty_compat_ioctl(struct file *file, unsigned int cmd,
e10cc1df
PF
149 unsigned long arg);
150#else
151#define tty_compat_ioctl NULL
152#endif
ec79d605 153static int __tty_fasync(int fd, struct file *filp, int on);
37bdfb07 154static int tty_fasync(int fd, struct file *filp, int on);
d5698c28 155static void release_tty(struct tty_struct *tty, int idx);
2a65f1d9 156static void __proc_set_tty(struct task_struct *tsk, struct tty_struct *tty);
98a27ba4 157static void proc_set_tty(struct task_struct *tsk, struct tty_struct *tty);
1da177e4 158
af9b897e
AC
159/**
160 * alloc_tty_struct - allocate a tty object
161 *
162 * Return a new empty tty structure. The data fields have not
163 * been initialized in any way but has been zeroed
164 *
165 * Locking: none
af9b897e 166 */
1da177e4 167
bf970ee4 168struct tty_struct *alloc_tty_struct(void)
1da177e4 169{
1266b1e1 170 return kzalloc(sizeof(struct tty_struct), GFP_KERNEL);
1da177e4
LT
171}
172
af9b897e
AC
173/**
174 * free_tty_struct - free a disused tty
175 * @tty: tty struct to free
176 *
177 * Free the write buffers, tty queue and tty memory itself.
178 *
179 * Locking: none. Must be called after tty is definitely unused
180 */
181
bf970ee4 182void free_tty_struct(struct tty_struct *tty)
1da177e4 183{
dc6802a7
DC
184 if (!tty)
185 return;
30004ac9
DES
186 if (tty->dev)
187 put_device(tty->dev);
1da177e4 188 kfree(tty->write_buf);
33f0f88f 189 tty_buffer_free_all(tty);
89c8d91e 190 tty->magic = 0xDEADDEAD;
1da177e4
LT
191 kfree(tty);
192}
193
d996b62a
NP
194static inline struct tty_struct *file_tty(struct file *file)
195{
196 return ((struct tty_file_private *)file->private_data)->tty;
197}
198
fa90e1c9 199int tty_alloc_file(struct file *file)
d996b62a
NP
200{
201 struct tty_file_private *priv;
202
f573bd17
PE
203 priv = kmalloc(sizeof(*priv), GFP_KERNEL);
204 if (!priv)
205 return -ENOMEM;
d996b62a 206
fa90e1c9
JS
207 file->private_data = priv;
208
209 return 0;
210}
211
212/* Associate a new file with the tty structure */
213void tty_add_file(struct tty_struct *tty, struct file *file)
214{
215 struct tty_file_private *priv = file->private_data;
216
d996b62a
NP
217 priv->tty = tty;
218 priv->file = file;
d996b62a
NP
219
220 spin_lock(&tty_files_lock);
221 list_add(&priv->list, &tty->tty_files);
222 spin_unlock(&tty_files_lock);
fa90e1c9 223}
f573bd17 224
fa90e1c9
JS
225/**
226 * tty_free_file - free file->private_data
227 *
228 * This shall be used only for fail path handling when tty_add_file was not
229 * called yet.
230 */
231void tty_free_file(struct file *file)
232{
233 struct tty_file_private *priv = file->private_data;
234
235 file->private_data = NULL;
236 kfree(priv);
d996b62a
NP
237}
238
239/* Delete file from its tty */
240void tty_del_file(struct file *file)
241{
242 struct tty_file_private *priv = file->private_data;
243
244 spin_lock(&tty_files_lock);
245 list_del(&priv->list);
246 spin_unlock(&tty_files_lock);
fa90e1c9 247 tty_free_file(file);
d996b62a
NP
248}
249
250
1da177e4
LT
251#define TTY_NUMBER(tty) ((tty)->index + (tty)->driver->name_base)
252
af9b897e
AC
253/**
254 * tty_name - return tty naming
255 * @tty: tty structure
256 * @buf: buffer for output
257 *
258 * Convert a tty structure into a name. The name reflects the kernel
259 * naming policy and if udev is in use may not reflect user space
260 *
261 * Locking: none
262 */
263
1da177e4
LT
264char *tty_name(struct tty_struct *tty, char *buf)
265{
266 if (!tty) /* Hmm. NULL pointer. That's fun. */
267 strcpy(buf, "NULL tty");
268 else
269 strcpy(buf, tty->name);
270 return buf;
271}
272
273EXPORT_SYMBOL(tty_name);
274
d769a669 275int tty_paranoia_check(struct tty_struct *tty, struct inode *inode,
1da177e4
LT
276 const char *routine)
277{
278#ifdef TTY_PARANOIA_CHECK
279 if (!tty) {
280 printk(KERN_WARNING
281 "null TTY for (%d:%d) in %s\n",
282 imajor(inode), iminor(inode), routine);
283 return 1;
284 }
285 if (tty->magic != TTY_MAGIC) {
286 printk(KERN_WARNING
287 "bad magic number for tty struct (%d:%d) in %s\n",
288 imajor(inode), iminor(inode), routine);
289 return 1;
290 }
291#endif
292 return 0;
293}
294
295static int check_tty_count(struct tty_struct *tty, const char *routine)
296{
297#ifdef CHECK_TTY_COUNT
298 struct list_head *p;
299 int count = 0;
37bdfb07 300
ee2ffa0d 301 spin_lock(&tty_files_lock);
1da177e4
LT
302 list_for_each(p, &tty->tty_files) {
303 count++;
304 }
ee2ffa0d 305 spin_unlock(&tty_files_lock);
1da177e4
LT
306 if (tty->driver->type == TTY_DRIVER_TYPE_PTY &&
307 tty->driver->subtype == PTY_TYPE_SLAVE &&
308 tty->link && tty->link->count)
309 count++;
310 if (tty->count != count) {
311 printk(KERN_WARNING "Warning: dev (%s) tty->count(%d) "
312 "!= #fd's(%d) in %s\n",
313 tty->name, tty->count, count, routine);
314 return count;
24ec839c 315 }
1da177e4
LT
316#endif
317 return 0;
318}
319
af9b897e
AC
320/**
321 * get_tty_driver - find device of a tty
322 * @dev_t: device identifier
323 * @index: returns the index of the tty
324 *
325 * This routine returns a tty driver structure, given a device number
326 * and also passes back the index number.
327 *
328 * Locking: caller must hold tty_mutex
1da177e4 329 */
af9b897e 330
1da177e4
LT
331static struct tty_driver *get_tty_driver(dev_t device, int *index)
332{
333 struct tty_driver *p;
334
335 list_for_each_entry(p, &tty_drivers, tty_drivers) {
336 dev_t base = MKDEV(p->major, p->minor_start);
337 if (device < base || device >= base + p->num)
338 continue;
339 *index = device - base;
7d7b93c1 340 return tty_driver_kref_get(p);
1da177e4
LT
341 }
342 return NULL;
343}
344
f2d937f3
JW
345#ifdef CONFIG_CONSOLE_POLL
346
347/**
348 * tty_find_polling_driver - find device of a polled tty
349 * @name: name string to match
350 * @line: pointer to resulting tty line nr
351 *
352 * This routine returns a tty driver structure, given a name
353 * and the condition that the tty driver is capable of polled
354 * operation.
355 */
356struct tty_driver *tty_find_polling_driver(char *name, int *line)
357{
358 struct tty_driver *p, *res = NULL;
359 int tty_line = 0;
0dca0fd2 360 int len;
5f0878ac 361 char *str, *stp;
f2d937f3 362
0dca0fd2
JW
363 for (str = name; *str; str++)
364 if ((*str >= '0' && *str <= '9') || *str == ',')
365 break;
366 if (!*str)
367 return NULL;
368
369 len = str - name;
370 tty_line = simple_strtoul(str, &str, 10);
371
f2d937f3
JW
372 mutex_lock(&tty_mutex);
373 /* Search through the tty devices to look for a match */
374 list_for_each_entry(p, &tty_drivers, tty_drivers) {
0dca0fd2
JW
375 if (strncmp(name, p->name, len) != 0)
376 continue;
5f0878ac
AC
377 stp = str;
378 if (*stp == ',')
379 stp++;
380 if (*stp == '\0')
381 stp = NULL;
f2d937f3 382
6eb68d6f 383 if (tty_line >= 0 && tty_line < p->num && p->ops &&
5f0878ac 384 p->ops->poll_init && !p->ops->poll_init(p, tty_line, stp)) {
7d7b93c1 385 res = tty_driver_kref_get(p);
f2d937f3
JW
386 *line = tty_line;
387 break;
388 }
389 }
390 mutex_unlock(&tty_mutex);
391
392 return res;
393}
394EXPORT_SYMBOL_GPL(tty_find_polling_driver);
395#endif
396
af9b897e
AC
397/**
398 * tty_check_change - check for POSIX terminal changes
399 * @tty: tty to check
400 *
401 * If we try to write to, or set the state of, a terminal and we're
402 * not in the foreground, send a SIGTTOU. If the signal is blocked or
403 * ignored, go ahead and perform the operation. (POSIX 7.2)
404 *
978e595f 405 * Locking: ctrl_lock
1da177e4 406 */
af9b897e 407
37bdfb07 408int tty_check_change(struct tty_struct *tty)
1da177e4 409{
47f86834
AC
410 unsigned long flags;
411 int ret = 0;
412
1da177e4
LT
413 if (current->signal->tty != tty)
414 return 0;
47f86834
AC
415
416 spin_lock_irqsave(&tty->ctrl_lock, flags);
417
ab521dc0
EB
418 if (!tty->pgrp) {
419 printk(KERN_WARNING "tty_check_change: tty->pgrp == NULL!\n");
9ffee4cb 420 goto out_unlock;
1da177e4 421 }
ab521dc0 422 if (task_pgrp(current) == tty->pgrp)
9ffee4cb
AM
423 goto out_unlock;
424 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
1da177e4 425 if (is_ignored(SIGTTOU))
47f86834
AC
426 goto out;
427 if (is_current_pgrp_orphaned()) {
428 ret = -EIO;
429 goto out;
430 }
040b6362
ON
431 kill_pgrp(task_pgrp(current), SIGTTOU, 1);
432 set_thread_flag(TIF_SIGPENDING);
47f86834
AC
433 ret = -ERESTARTSYS;
434out:
9ffee4cb
AM
435 return ret;
436out_unlock:
47f86834
AC
437 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
438 return ret;
1da177e4
LT
439}
440
441EXPORT_SYMBOL(tty_check_change);
442
37bdfb07 443static ssize_t hung_up_tty_read(struct file *file, char __user *buf,
1da177e4
LT
444 size_t count, loff_t *ppos)
445{
446 return 0;
447}
448
37bdfb07 449static ssize_t hung_up_tty_write(struct file *file, const char __user *buf,
1da177e4
LT
450 size_t count, loff_t *ppos)
451{
452 return -EIO;
453}
454
455/* No kernel lock held - none needed ;) */
37bdfb07 456static unsigned int hung_up_tty_poll(struct file *filp, poll_table *wait)
1da177e4
LT
457{
458 return POLLIN | POLLOUT | POLLERR | POLLHUP | POLLRDNORM | POLLWRNORM;
459}
460
04f378b1
AC
461static long hung_up_tty_ioctl(struct file *file, unsigned int cmd,
462 unsigned long arg)
38ad2ed0
PF
463{
464 return cmd == TIOCSPGRP ? -ENOTTY : -EIO;
465}
466
37bdfb07 467static long hung_up_tty_compat_ioctl(struct file *file,
38ad2ed0 468 unsigned int cmd, unsigned long arg)
1da177e4
LT
469{
470 return cmd == TIOCSPGRP ? -ENOTTY : -EIO;
471}
472
62322d25 473static const struct file_operations tty_fops = {
1da177e4
LT
474 .llseek = no_llseek,
475 .read = tty_read,
476 .write = tty_write,
477 .poll = tty_poll,
04f378b1 478 .unlocked_ioctl = tty_ioctl,
e10cc1df 479 .compat_ioctl = tty_compat_ioctl,
1da177e4
LT
480 .open = tty_open,
481 .release = tty_release,
482 .fasync = tty_fasync,
483};
484
62322d25 485static const struct file_operations console_fops = {
1da177e4
LT
486 .llseek = no_llseek,
487 .read = tty_read,
488 .write = redirected_tty_write,
489 .poll = tty_poll,
04f378b1 490 .unlocked_ioctl = tty_ioctl,
e10cc1df 491 .compat_ioctl = tty_compat_ioctl,
1da177e4
LT
492 .open = tty_open,
493 .release = tty_release,
494 .fasync = tty_fasync,
495};
496
62322d25 497static const struct file_operations hung_up_tty_fops = {
1da177e4
LT
498 .llseek = no_llseek,
499 .read = hung_up_tty_read,
500 .write = hung_up_tty_write,
501 .poll = hung_up_tty_poll,
04f378b1 502 .unlocked_ioctl = hung_up_tty_ioctl,
38ad2ed0 503 .compat_ioctl = hung_up_tty_compat_ioctl,
1da177e4
LT
504 .release = tty_release,
505};
506
507static DEFINE_SPINLOCK(redirect_lock);
508static struct file *redirect;
509
510/**
511 * tty_wakeup - request more data
512 * @tty: terminal
513 *
514 * Internal and external helper for wakeups of tty. This function
515 * informs the line discipline if present that the driver is ready
516 * to receive more output data.
517 */
37bdfb07 518
1da177e4
LT
519void tty_wakeup(struct tty_struct *tty)
520{
521 struct tty_ldisc *ld;
37bdfb07 522
1da177e4
LT
523 if (test_bit(TTY_DO_WRITE_WAKEUP, &tty->flags)) {
524 ld = tty_ldisc_ref(tty);
37bdfb07 525 if (ld) {
a352def2
AC
526 if (ld->ops->write_wakeup)
527 ld->ops->write_wakeup(tty);
1da177e4
LT
528 tty_ldisc_deref(ld);
529 }
530 }
4b19449d 531 wake_up_interruptible_poll(&tty->write_wait, POLLOUT);
1da177e4
LT
532}
533
534EXPORT_SYMBOL_GPL(tty_wakeup);
535
af9b897e 536/**
11dbf203 537 * __tty_hangup - actual handler for hangup events
65f27f38 538 * @work: tty device
af9b897e 539 *
1bad879a 540 * This can be called by the "eventd" kernel thread. That is process
af9b897e
AC
541 * synchronous but doesn't hold any locks, so we need to make sure we
542 * have the appropriate locks for what we're doing.
543 *
544 * The hangup event clears any pending redirections onto the hung up
545 * device. It ensures future writes will error and it does the needed
546 * line discipline hangup and signal delivery. The tty object itself
547 * remains intact.
548 *
549 * Locking:
ec79d605 550 * BTM
24ec839c
PZ
551 * redirect lock for undoing redirection
552 * file list lock for manipulating list of ttys
553 * tty_ldisc_lock from called functions
554 * termios_mutex resetting termios data
555 * tasklist_lock to walk task list for hangup event
556 * ->siglock to protect ->signal/->sighand
1da177e4 557 */
11dbf203 558void __tty_hangup(struct tty_struct *tty)
1da177e4 559{
37bdfb07 560 struct file *cons_filp = NULL;
1da177e4
LT
561 struct file *filp, *f = NULL;
562 struct task_struct *p;
d996b62a 563 struct tty_file_private *priv;
1da177e4 564 int closecount = 0, n;
47f86834 565 unsigned long flags;
9c9f4ded 566 int refs = 0;
1da177e4
LT
567
568 if (!tty)
569 return;
570
1da177e4
LT
571
572 spin_lock(&redirect_lock);
d996b62a 573 if (redirect && file_tty(redirect) == tty) {
1da177e4
LT
574 f = redirect;
575 redirect = NULL;
576 }
577 spin_unlock(&redirect_lock);
37bdfb07 578
89c8d91e 579 tty_lock(tty);
11dbf203 580
acfa747b
JS
581 /* some functions below drop BTM, so we need this bit */
582 set_bit(TTY_HUPPING, &tty->flags);
583
ec79d605
AB
584 /* inuse_filps is protected by the single tty lock,
585 this really needs to change if we want to flush the
586 workqueue with the lock held */
11dbf203 587 check_tty_count(tty, "tty_hangup");
36ba782e 588
ee2ffa0d 589 spin_lock(&tty_files_lock);
1da177e4 590 /* This breaks for file handles being sent over AF_UNIX sockets ? */
d996b62a
NP
591 list_for_each_entry(priv, &tty->tty_files, list) {
592 filp = priv->file;
1da177e4
LT
593 if (filp->f_op->write == redirected_tty_write)
594 cons_filp = filp;
595 if (filp->f_op->write != tty_write)
596 continue;
597 closecount++;
ec79d605 598 __tty_fasync(-1, filp, 0); /* can't block */
1da177e4
LT
599 filp->f_op = &hung_up_tty_fops;
600 }
ee2ffa0d 601 spin_unlock(&tty_files_lock);
37bdfb07 602
acfa747b
JS
603 /*
604 * it drops BTM and thus races with reopen
605 * we protect the race by TTY_HUPPING
606 */
c65c9bc3 607 tty_ldisc_hangup(tty);
37bdfb07 608
1da177e4 609 read_lock(&tasklist_lock);
ab521dc0
EB
610 if (tty->session) {
611 do_each_pid_task(tty->session, PIDTYPE_SID, p) {
24ec839c 612 spin_lock_irq(&p->sighand->siglock);
9c9f4ded 613 if (p->signal->tty == tty) {
1da177e4 614 p->signal->tty = NULL;
9c9f4ded
AC
615 /* We defer the dereferences outside fo
616 the tasklist lock */
617 refs++;
618 }
24ec839c
PZ
619 if (!p->signal->leader) {
620 spin_unlock_irq(&p->sighand->siglock);
1da177e4 621 continue;
24ec839c
PZ
622 }
623 __group_send_sig_info(SIGHUP, SEND_SIG_PRIV, p);
624 __group_send_sig_info(SIGCONT, SEND_SIG_PRIV, p);
ab521dc0 625 put_pid(p->signal->tty_old_pgrp); /* A noop */
47f86834 626 spin_lock_irqsave(&tty->ctrl_lock, flags);
ab521dc0
EB
627 if (tty->pgrp)
628 p->signal->tty_old_pgrp = get_pid(tty->pgrp);
47f86834 629 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
24ec839c 630 spin_unlock_irq(&p->sighand->siglock);
ab521dc0 631 } while_each_pid_task(tty->session, PIDTYPE_SID, p);
1da177e4
LT
632 }
633 read_unlock(&tasklist_lock);
634
47f86834 635 spin_lock_irqsave(&tty->ctrl_lock, flags);
c65c9bc3
AC
636 clear_bit(TTY_THROTTLED, &tty->flags);
637 clear_bit(TTY_PUSH, &tty->flags);
638 clear_bit(TTY_DO_WRITE_WAKEUP, &tty->flags);
d9c1e9a8
EB
639 put_pid(tty->session);
640 put_pid(tty->pgrp);
ab521dc0
EB
641 tty->session = NULL;
642 tty->pgrp = NULL;
1da177e4 643 tty->ctrl_status = 0;
47f86834
AC
644 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
645
9c9f4ded
AC
646 /* Account for the p->signal references we killed */
647 while (refs--)
648 tty_kref_put(tty);
649
1da177e4 650 /*
37bdfb07
AC
651 * If one of the devices matches a console pointer, we
652 * cannot just call hangup() because that will cause
653 * tty->count and state->count to go out of sync.
654 * So we just call close() the right number of times.
1da177e4
LT
655 */
656 if (cons_filp) {
f34d7a5b 657 if (tty->ops->close)
1da177e4 658 for (n = 0; n < closecount; n++)
f34d7a5b
AC
659 tty->ops->close(tty, cons_filp);
660 } else if (tty->ops->hangup)
661 (tty->ops->hangup)(tty);
37bdfb07
AC
662 /*
663 * We don't want to have driver/ldisc interactions beyond
664 * the ones we did here. The driver layer expects no
665 * calls after ->hangup() from the ldisc side. However we
666 * can't yet guarantee all that.
667 */
1da177e4 668 set_bit(TTY_HUPPED, &tty->flags);
acfa747b 669 clear_bit(TTY_HUPPING, &tty->flags);
c65c9bc3 670 tty_ldisc_enable(tty);
11dbf203 671
89c8d91e 672 tty_unlock(tty);
11dbf203 673
1da177e4
LT
674 if (f)
675 fput(f);
676}
677
ddcd9fb6
AB
678static void do_tty_hangup(struct work_struct *work)
679{
680 struct tty_struct *tty =
681 container_of(work, struct tty_struct, hangup_work);
682
11dbf203 683 __tty_hangup(tty);
ddcd9fb6
AB
684}
685
af9b897e
AC
686/**
687 * tty_hangup - trigger a hangup event
688 * @tty: tty to hangup
689 *
690 * A carrier loss (virtual or otherwise) has occurred on this like
691 * schedule a hangup sequence to run after this event.
692 */
693
37bdfb07 694void tty_hangup(struct tty_struct *tty)
1da177e4
LT
695{
696#ifdef TTY_DEBUG_HANGUP
697 char buf[64];
1da177e4
LT
698 printk(KERN_DEBUG "%s hangup...\n", tty_name(tty, buf));
699#endif
700 schedule_work(&tty->hangup_work);
701}
702
703EXPORT_SYMBOL(tty_hangup);
704
af9b897e
AC
705/**
706 * tty_vhangup - process vhangup
707 * @tty: tty to hangup
708 *
709 * The user has asked via system call for the terminal to be hung up.
710 * We do this synchronously so that when the syscall returns the process
3a4fa0a2 711 * is complete. That guarantee is necessary for security reasons.
af9b897e
AC
712 */
713
37bdfb07 714void tty_vhangup(struct tty_struct *tty)
1da177e4
LT
715{
716#ifdef TTY_DEBUG_HANGUP
717 char buf[64];
718
719 printk(KERN_DEBUG "%s vhangup...\n", tty_name(tty, buf));
720#endif
11dbf203 721 __tty_hangup(tty);
1da177e4 722}
37bdfb07 723
1da177e4
LT
724EXPORT_SYMBOL(tty_vhangup);
725
11dbf203 726
2cb5998b
AC
727/**
728 * tty_vhangup_self - process vhangup for own ctty
729 *
730 * Perform a vhangup on the current controlling tty
731 */
732
733void tty_vhangup_self(void)
734{
735 struct tty_struct *tty;
736
2cb5998b
AC
737 tty = get_current_tty();
738 if (tty) {
739 tty_vhangup(tty);
740 tty_kref_put(tty);
741 }
2cb5998b
AC
742}
743
af9b897e
AC
744/**
745 * tty_hung_up_p - was tty hung up
746 * @filp: file pointer of tty
747 *
748 * Return true if the tty has been subject to a vhangup or a carrier
749 * loss
750 */
751
37bdfb07 752int tty_hung_up_p(struct file *filp)
1da177e4
LT
753{
754 return (filp->f_op == &hung_up_tty_fops);
755}
756
757EXPORT_SYMBOL(tty_hung_up_p);
758
ab521dc0 759static void session_clear_tty(struct pid *session)
24ec839c
PZ
760{
761 struct task_struct *p;
ab521dc0 762 do_each_pid_task(session, PIDTYPE_SID, p) {
24ec839c 763 proc_clear_tty(p);
ab521dc0 764 } while_each_pid_task(session, PIDTYPE_SID, p);
24ec839c
PZ
765}
766
af9b897e
AC
767/**
768 * disassociate_ctty - disconnect controlling tty
769 * @on_exit: true if exiting so need to "hang up" the session
1da177e4 770 *
af9b897e
AC
771 * This function is typically called only by the session leader, when
772 * it wants to disassociate itself from its controlling tty.
773 *
774 * It performs the following functions:
1da177e4
LT
775 * (1) Sends a SIGHUP and SIGCONT to the foreground process group
776 * (2) Clears the tty from being controlling the session
777 * (3) Clears the controlling tty for all processes in the
778 * session group.
779 *
af9b897e
AC
780 * The argument on_exit is set to 1 if called when a process is
781 * exiting; it is 0 if called by the ioctl TIOCNOTTY.
782 *
24ec839c 783 * Locking:
ec79d605
AB
784 * BTM is taken for hysterical raisins, and held when
785 * called from no_tty().
24ec839c
PZ
786 * tty_mutex is taken to protect tty
787 * ->siglock is taken to protect ->signal/->sighand
788 * tasklist_lock is taken to walk process list for sessions
789 * ->siglock is taken to protect ->signal/->sighand
1da177e4 790 */
af9b897e 791
1da177e4
LT
792void disassociate_ctty(int on_exit)
793{
794 struct tty_struct *tty;
1da177e4 795
5ec93d11
AC
796 if (!current->signal->leader)
797 return;
1da177e4 798
24ec839c 799 tty = get_current_tty();
1da177e4 800 if (tty) {
1411dc4a 801 struct pid *tty_pgrp = get_pid(tty->pgrp);
ddcd9fb6 802 if (on_exit) {
ddcd9fb6 803 if (tty->driver->type != TTY_DRIVER_TYPE_PTY)
11dbf203 804 tty_vhangup(tty);
ddcd9fb6 805 }
452a00d2 806 tty_kref_put(tty);
1411dc4a
JS
807 if (tty_pgrp) {
808 kill_pgrp(tty_pgrp, SIGHUP, on_exit);
809 if (!on_exit)
810 kill_pgrp(tty_pgrp, SIGCONT, on_exit);
811 put_pid(tty_pgrp);
812 }
680a9671 813 } else if (on_exit) {
ab521dc0 814 struct pid *old_pgrp;
680a9671
EB
815 spin_lock_irq(&current->sighand->siglock);
816 old_pgrp = current->signal->tty_old_pgrp;
ab521dc0 817 current->signal->tty_old_pgrp = NULL;
680a9671 818 spin_unlock_irq(&current->sighand->siglock);
24ec839c 819 if (old_pgrp) {
ab521dc0
EB
820 kill_pgrp(old_pgrp, SIGHUP, on_exit);
821 kill_pgrp(old_pgrp, SIGCONT, on_exit);
822 put_pid(old_pgrp);
1da177e4 823 }
1da177e4
LT
824 return;
825 }
1da177e4 826
24ec839c 827 spin_lock_irq(&current->sighand->siglock);
2a65f1d9 828 put_pid(current->signal->tty_old_pgrp);
23cac8de 829 current->signal->tty_old_pgrp = NULL;
24ec839c
PZ
830 spin_unlock_irq(&current->sighand->siglock);
831
24ec839c
PZ
832 tty = get_current_tty();
833 if (tty) {
47f86834
AC
834 unsigned long flags;
835 spin_lock_irqsave(&tty->ctrl_lock, flags);
ab521dc0
EB
836 put_pid(tty->session);
837 put_pid(tty->pgrp);
838 tty->session = NULL;
839 tty->pgrp = NULL;
47f86834 840 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
452a00d2 841 tty_kref_put(tty);
24ec839c
PZ
842 } else {
843#ifdef TTY_DEBUG_HANGUP
844 printk(KERN_DEBUG "error attempted to write to tty [0x%p]"
845 " = NULL", tty);
846#endif
847 }
1da177e4
LT
848
849 /* Now clear signal->tty under the lock */
850 read_lock(&tasklist_lock);
ab521dc0 851 session_clear_tty(task_session(current));
1da177e4 852 read_unlock(&tasklist_lock);
1da177e4
LT
853}
854
98a27ba4
EB
855/**
856 *
857 * no_tty - Ensure the current process does not have a controlling tty
858 */
859void no_tty(void)
860{
3af502b9
AC
861 /* FIXME: Review locking here. The tty_lock never covered any race
862 between a new association and proc_clear_tty but possible we need
863 to protect against this anyway */
98a27ba4 864 struct task_struct *tsk = current;
5ec93d11 865 disassociate_ctty(0);
98a27ba4
EB
866 proc_clear_tty(tsk);
867}
868
af9b897e
AC
869
870/**
beb7dd86 871 * stop_tty - propagate flow control
af9b897e
AC
872 * @tty: tty to stop
873 *
874 * Perform flow control to the driver. For PTY/TTY pairs we
beb7dd86 875 * must also propagate the TIOCKPKT status. May be called
af9b897e
AC
876 * on an already stopped device and will not re-call the driver
877 * method.
878 *
879 * This functionality is used by both the line disciplines for
880 * halting incoming flow and by the driver. It may therefore be
881 * called from any context, may be under the tty atomic_write_lock
882 * but not always.
883 *
884 * Locking:
04f378b1 885 * Uses the tty control lock internally
af9b897e
AC
886 */
887
1da177e4
LT
888void stop_tty(struct tty_struct *tty)
889{
04f378b1
AC
890 unsigned long flags;
891 spin_lock_irqsave(&tty->ctrl_lock, flags);
892 if (tty->stopped) {
893 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
1da177e4 894 return;
04f378b1 895 }
1da177e4
LT
896 tty->stopped = 1;
897 if (tty->link && tty->link->packet) {
898 tty->ctrl_status &= ~TIOCPKT_START;
899 tty->ctrl_status |= TIOCPKT_STOP;
4b19449d 900 wake_up_interruptible_poll(&tty->link->read_wait, POLLIN);
1da177e4 901 }
04f378b1 902 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
f34d7a5b
AC
903 if (tty->ops->stop)
904 (tty->ops->stop)(tty);
1da177e4
LT
905}
906
907EXPORT_SYMBOL(stop_tty);
908
af9b897e 909/**
beb7dd86 910 * start_tty - propagate flow control
af9b897e
AC
911 * @tty: tty to start
912 *
913 * Start a tty that has been stopped if at all possible. Perform
3a4fa0a2 914 * any necessary wakeups and propagate the TIOCPKT status. If this
af9b897e
AC
915 * is the tty was previous stopped and is being started then the
916 * driver start method is invoked and the line discipline woken.
917 *
918 * Locking:
04f378b1 919 * ctrl_lock
af9b897e
AC
920 */
921
1da177e4
LT
922void start_tty(struct tty_struct *tty)
923{
04f378b1
AC
924 unsigned long flags;
925 spin_lock_irqsave(&tty->ctrl_lock, flags);
926 if (!tty->stopped || tty->flow_stopped) {
927 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
1da177e4 928 return;
04f378b1 929 }
1da177e4
LT
930 tty->stopped = 0;
931 if (tty->link && tty->link->packet) {
932 tty->ctrl_status &= ~TIOCPKT_STOP;
933 tty->ctrl_status |= TIOCPKT_START;
4b19449d 934 wake_up_interruptible_poll(&tty->link->read_wait, POLLIN);
1da177e4 935 }
04f378b1 936 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
f34d7a5b
AC
937 if (tty->ops->start)
938 (tty->ops->start)(tty);
1da177e4
LT
939 /* If we have a running line discipline it may need kicking */
940 tty_wakeup(tty);
1da177e4
LT
941}
942
943EXPORT_SYMBOL(start_tty);
944
af9b897e
AC
945/**
946 * tty_read - read method for tty device files
947 * @file: pointer to tty file
948 * @buf: user buffer
949 * @count: size of user buffer
950 * @ppos: unused
951 *
952 * Perform the read system call function on this terminal device. Checks
953 * for hung up devices before calling the line discipline method.
954 *
955 * Locking:
47f86834
AC
956 * Locks the line discipline internally while needed. Multiple
957 * read calls may be outstanding in parallel.
af9b897e
AC
958 */
959
37bdfb07 960static ssize_t tty_read(struct file *file, char __user *buf, size_t count,
1da177e4
LT
961 loff_t *ppos)
962{
963 int i;
d996b62a
NP
964 struct inode *inode = file->f_path.dentry->d_inode;
965 struct tty_struct *tty = file_tty(file);
1da177e4
LT
966 struct tty_ldisc *ld;
967
1da177e4
LT
968 if (tty_paranoia_check(tty, inode, "tty_read"))
969 return -EIO;
970 if (!tty || (test_bit(TTY_IO_ERROR, &tty->flags)))
971 return -EIO;
972
973 /* We want to wait for the line discipline to sort out in this
974 situation */
975 ld = tty_ldisc_ref_wait(tty);
a352def2
AC
976 if (ld->ops->read)
977 i = (ld->ops->read)(tty, file, buf, count);
1da177e4
LT
978 else
979 i = -EIO;
980 tty_ldisc_deref(ld);
1da177e4
LT
981 if (i > 0)
982 inode->i_atime = current_fs_time(inode->i_sb);
983 return i;
984}
985
9c1729db 986void tty_write_unlock(struct tty_struct *tty)
83c67571 987 __releases(&tty->atomic_write_lock)
9c1729db
AC
988{
989 mutex_unlock(&tty->atomic_write_lock);
4b19449d 990 wake_up_interruptible_poll(&tty->write_wait, POLLOUT);
9c1729db
AC
991}
992
993int tty_write_lock(struct tty_struct *tty, int ndelay)
83c67571 994 __acquires(&tty->atomic_write_lock)
9c1729db
AC
995{
996 if (!mutex_trylock(&tty->atomic_write_lock)) {
997 if (ndelay)
998 return -EAGAIN;
999 if (mutex_lock_interruptible(&tty->atomic_write_lock))
1000 return -ERESTARTSYS;
1001 }
1002 return 0;
1003}
1004
1da177e4
LT
1005/*
1006 * Split writes up in sane blocksizes to avoid
1007 * denial-of-service type attacks
1008 */
1009static inline ssize_t do_tty_write(
1010 ssize_t (*write)(struct tty_struct *, struct file *, const unsigned char *, size_t),
1011 struct tty_struct *tty,
1012 struct file *file,
1013 const char __user *buf,
1014 size_t count)
1015{
9c1729db 1016 ssize_t ret, written = 0;
1da177e4 1017 unsigned int chunk;
37bdfb07 1018
9c1729db
AC
1019 ret = tty_write_lock(tty, file->f_flags & O_NDELAY);
1020 if (ret < 0)
1021 return ret;
1da177e4
LT
1022
1023 /*
1024 * We chunk up writes into a temporary buffer. This
1025 * simplifies low-level drivers immensely, since they
1026 * don't have locking issues and user mode accesses.
1027 *
1028 * But if TTY_NO_WRITE_SPLIT is set, we should use a
1029 * big chunk-size..
1030 *
1031 * The default chunk-size is 2kB, because the NTTY
1032 * layer has problems with bigger chunks. It will
1033 * claim to be able to handle more characters than
1034 * it actually does.
af9b897e
AC
1035 *
1036 * FIXME: This can probably go away now except that 64K chunks
1037 * are too likely to fail unless switched to vmalloc...
1da177e4
LT
1038 */
1039 chunk = 2048;
1040 if (test_bit(TTY_NO_WRITE_SPLIT, &tty->flags))
1041 chunk = 65536;
1042 if (count < chunk)
1043 chunk = count;
1044
70522e12 1045 /* write_buf/write_cnt is protected by the atomic_write_lock mutex */
1da177e4 1046 if (tty->write_cnt < chunk) {
402fda92 1047 unsigned char *buf_chunk;
1da177e4
LT
1048
1049 if (chunk < 1024)
1050 chunk = 1024;
1051
402fda92
JW
1052 buf_chunk = kmalloc(chunk, GFP_KERNEL);
1053 if (!buf_chunk) {
9c1729db
AC
1054 ret = -ENOMEM;
1055 goto out;
1da177e4
LT
1056 }
1057 kfree(tty->write_buf);
1058 tty->write_cnt = chunk;
402fda92 1059 tty->write_buf = buf_chunk;
1da177e4
LT
1060 }
1061
1062 /* Do the write .. */
1063 for (;;) {
1064 size_t size = count;
1065 if (size > chunk)
1066 size = chunk;
1067 ret = -EFAULT;
1068 if (copy_from_user(tty->write_buf, buf, size))
1069 break;
1da177e4 1070 ret = write(tty, file, tty->write_buf, size);
1da177e4
LT
1071 if (ret <= 0)
1072 break;
1073 written += ret;
1074 buf += ret;
1075 count -= ret;
1076 if (!count)
1077 break;
1078 ret = -ERESTARTSYS;
1079 if (signal_pending(current))
1080 break;
1081 cond_resched();
1082 }
1083 if (written) {
a7113a96 1084 struct inode *inode = file->f_path.dentry->d_inode;
1da177e4
LT
1085 inode->i_mtime = current_fs_time(inode->i_sb);
1086 ret = written;
1087 }
9c1729db
AC
1088out:
1089 tty_write_unlock(tty);
1da177e4
LT
1090 return ret;
1091}
1092
95f9bfc6
AC
1093/**
1094 * tty_write_message - write a message to a certain tty, not just the console.
1095 * @tty: the destination tty_struct
1096 * @msg: the message to write
1097 *
1098 * This is used for messages that need to be redirected to a specific tty.
1099 * We don't put it into the syslog queue right now maybe in the future if
1100 * really needed.
1101 *
ec79d605 1102 * We must still hold the BTM and test the CLOSING flag for the moment.
95f9bfc6
AC
1103 */
1104
1105void tty_write_message(struct tty_struct *tty, char *msg)
1106{
95f9bfc6
AC
1107 if (tty) {
1108 mutex_lock(&tty->atomic_write_lock);
89c8d91e 1109 tty_lock(tty);
eeb89d91 1110 if (tty->ops->write && !test_bit(TTY_CLOSING, &tty->flags)) {
89c8d91e 1111 tty_unlock(tty);
95f9bfc6 1112 tty->ops->write(tty, msg, strlen(msg));
eeb89d91 1113 } else
89c8d91e 1114 tty_unlock(tty);
95f9bfc6
AC
1115 tty_write_unlock(tty);
1116 }
95f9bfc6
AC
1117 return;
1118}
1119
1da177e4 1120
af9b897e
AC
1121/**
1122 * tty_write - write method for tty device file
1123 * @file: tty file pointer
1124 * @buf: user data to write
1125 * @count: bytes to write
1126 * @ppos: unused
1127 *
1128 * Write data to a tty device via the line discipline.
1129 *
1130 * Locking:
1131 * Locks the line discipline as required
1132 * Writes to the tty driver are serialized by the atomic_write_lock
1133 * and are then processed in chunks to the device. The line discipline
a88a69c9 1134 * write method will not be invoked in parallel for each device.
af9b897e
AC
1135 */
1136
37bdfb07
AC
1137static ssize_t tty_write(struct file *file, const char __user *buf,
1138 size_t count, loff_t *ppos)
1da177e4 1139{
a7113a96 1140 struct inode *inode = file->f_path.dentry->d_inode;
d996b62a
NP
1141 struct tty_struct *tty = file_tty(file);
1142 struct tty_ldisc *ld;
1da177e4 1143 ssize_t ret;
37bdfb07 1144
1da177e4
LT
1145 if (tty_paranoia_check(tty, inode, "tty_write"))
1146 return -EIO;
f34d7a5b 1147 if (!tty || !tty->ops->write ||
37bdfb07
AC
1148 (test_bit(TTY_IO_ERROR, &tty->flags)))
1149 return -EIO;
f34d7a5b
AC
1150 /* Short term debug to catch buggy drivers */
1151 if (tty->ops->write_room == NULL)
1152 printk(KERN_ERR "tty driver %s lacks a write_room method.\n",
1153 tty->driver->name);
37bdfb07 1154 ld = tty_ldisc_ref_wait(tty);
a352def2 1155 if (!ld->ops->write)
1da177e4
LT
1156 ret = -EIO;
1157 else
a352def2 1158 ret = do_tty_write(ld->ops->write, tty, file, buf, count);
1da177e4
LT
1159 tty_ldisc_deref(ld);
1160 return ret;
1161}
1162
37bdfb07
AC
1163ssize_t redirected_tty_write(struct file *file, const char __user *buf,
1164 size_t count, loff_t *ppos)
1da177e4
LT
1165{
1166 struct file *p = NULL;
1167
1168 spin_lock(&redirect_lock);
1169 if (redirect) {
1170 get_file(redirect);
1171 p = redirect;
1172 }
1173 spin_unlock(&redirect_lock);
1174
1175 if (p) {
1176 ssize_t res;
1177 res = vfs_write(p, buf, count, &p->f_pos);
1178 fput(p);
1179 return res;
1180 }
1da177e4
LT
1181 return tty_write(file, buf, count, ppos);
1182}
1183
1184static char ptychar[] = "pqrstuvwxyzabcde";
1185
af9b897e
AC
1186/**
1187 * pty_line_name - generate name for a pty
1188 * @driver: the tty driver in use
1189 * @index: the minor number
1190 * @p: output buffer of at least 6 bytes
1191 *
1192 * Generate a name from a driver reference and write it to the output
1193 * buffer.
1194 *
1195 * Locking: None
1196 */
1197static void pty_line_name(struct tty_driver *driver, int index, char *p)
1da177e4
LT
1198{
1199 int i = index + driver->name_base;
1200 /* ->name is initialized to "ttyp", but "tty" is expected */
1201 sprintf(p, "%s%c%x",
37bdfb07
AC
1202 driver->subtype == PTY_TYPE_SLAVE ? "tty" : driver->name,
1203 ptychar[i >> 4 & 0xf], i & 0xf);
1da177e4
LT
1204}
1205
af9b897e 1206/**
8b0a88d5 1207 * tty_line_name - generate name for a tty
af9b897e
AC
1208 * @driver: the tty driver in use
1209 * @index: the minor number
1210 * @p: output buffer of at least 7 bytes
1211 *
1212 * Generate a name from a driver reference and write it to the output
1213 * buffer.
1214 *
1215 * Locking: None
1216 */
1217static void tty_line_name(struct tty_driver *driver, int index, char *p)
1da177e4 1218{
0019b408
JS
1219 if (driver->flags & TTY_DRIVER_UNNUMBERED_NODE)
1220 strcpy(p, driver->name);
1221 else
1222 sprintf(p, "%s%d", driver->name, index + driver->name_base);
1da177e4
LT
1223}
1224
99f1fe18
AC
1225/**
1226 * tty_driver_lookup_tty() - find an existing tty, if any
1227 * @driver: the driver for the tty
1228 * @idx: the minor number
23499705 1229 *
99f1fe18 1230 * Return the tty, if found or ERR_PTR() otherwise.
23499705 1231 *
99f1fe18
AC
1232 * Locking: tty_mutex must be held. If tty is found, the mutex must
1233 * be held until the 'fast-open' is also done. Will change once we
1234 * have refcounting in the driver and per driver locking
23499705 1235 */
a47d545f 1236static struct tty_struct *tty_driver_lookup_tty(struct tty_driver *driver,
15f1a633 1237 struct inode *inode, int idx)
23499705 1238{
99f1fe18 1239 if (driver->ops->lookup)
15f1a633 1240 return driver->ops->lookup(driver, inode, idx);
23499705 1241
d4834267 1242 return driver->ttys[idx];
23499705
SB
1243}
1244
bf970ee4
AC
1245/**
1246 * tty_init_termios - helper for termios setup
1247 * @tty: the tty to set up
1248 *
1249 * Initialise the termios structures for this tty. Thus runs under
1250 * the tty_mutex currently so we can be relaxed about ordering.
1251 */
1252
1253int tty_init_termios(struct tty_struct *tty)
1254{
fe6e29fd 1255 struct ktermios *tp;
bf970ee4
AC
1256 int idx = tty->index;
1257
36b3c070
AC
1258 if (tty->driver->flags & TTY_DRIVER_RESET_TERMIOS)
1259 tty->termios = tty->driver->init_termios;
1260 else {
1261 /* Check for lazy saved data */
1262 tp = tty->driver->termios[idx];
1263 if (tp != NULL)
1264 tty->termios = *tp;
1265 else
1266 tty->termios = tty->driver->init_termios;
bf970ee4 1267 }
bf970ee4 1268 /* Compatibility until drivers always set this */
adc8d746
AC
1269 tty->termios.c_ispeed = tty_termios_input_baud_rate(&tty->termios);
1270 tty->termios.c_ospeed = tty_termios_baud_rate(&tty->termios);
bf970ee4
AC
1271 return 0;
1272}
fe1ae7fd 1273EXPORT_SYMBOL_GPL(tty_init_termios);
bf970ee4 1274
66d450e8
JS
1275int tty_standard_install(struct tty_driver *driver, struct tty_struct *tty)
1276{
1277 int ret = tty_init_termios(tty);
1278 if (ret)
1279 return ret;
1280
1281 tty_driver_kref_get(driver);
1282 tty->count++;
1283 driver->ttys[tty->index] = tty;
1284 return 0;
1285}
1286EXPORT_SYMBOL_GPL(tty_standard_install);
1287
99f1fe18 1288/**
8b0a88d5
AC
1289 * tty_driver_install_tty() - install a tty entry in the driver
1290 * @driver: the driver for the tty
1291 * @tty: the tty
1292 *
1293 * Install a tty object into the driver tables. The tty->index field
bf970ee4
AC
1294 * will be set by the time this is called. This method is responsible
1295 * for ensuring any need additional structures are allocated and
1296 * configured.
8b0a88d5
AC
1297 *
1298 * Locking: tty_mutex for now
1299 */
1300static int tty_driver_install_tty(struct tty_driver *driver,
1301 struct tty_struct *tty)
1302{
66d450e8
JS
1303 return driver->ops->install ? driver->ops->install(driver, tty) :
1304 tty_standard_install(driver, tty);
8b0a88d5
AC
1305}
1306
1307/**
1308 * tty_driver_remove_tty() - remove a tty from the driver tables
1309 * @driver: the driver for the tty
1310 * @idx: the minor number
1311 *
1312 * Remvoe a tty object from the driver tables. The tty->index field
1313 * will be set by the time this is called.
1314 *
1315 * Locking: tty_mutex for now
1316 */
24d406a6 1317void tty_driver_remove_tty(struct tty_driver *driver, struct tty_struct *tty)
8b0a88d5
AC
1318{
1319 if (driver->ops->remove)
1320 driver->ops->remove(driver, tty);
1321 else
1322 driver->ttys[tty->index] = NULL;
1323}
1324
1325/*
1326 * tty_reopen() - fast re-open of an open tty
1327 * @tty - the tty to open
23499705 1328 *
99f1fe18 1329 * Return 0 on success, -errno on error.
23499705 1330 *
99f1fe18
AC
1331 * Locking: tty_mutex must be held from the time the tty was found
1332 * till this open completes.
23499705 1333 */
99f1fe18 1334static int tty_reopen(struct tty_struct *tty)
23499705
SB
1335{
1336 struct tty_driver *driver = tty->driver;
1337
e2efafbf 1338 if (test_bit(TTY_CLOSING, &tty->flags) ||
acfa747b 1339 test_bit(TTY_HUPPING, &tty->flags) ||
e2efafbf 1340 test_bit(TTY_LDISC_CHANGING, &tty->flags))
23499705
SB
1341 return -EIO;
1342
1343 if (driver->type == TTY_DRIVER_TYPE_PTY &&
1344 driver->subtype == PTY_TYPE_MASTER) {
1345 /*
1346 * special case for PTY masters: only one open permitted,
1347 * and the slave side open count is incremented as well.
1348 */
1349 if (tty->count)
1350 return -EIO;
1351
1352 tty->link->count++;
1353 }
1354 tty->count++;
23499705 1355
1aa4bed8 1356 mutex_lock(&tty->ldisc_mutex);
99f1fe18 1357 WARN_ON(!test_bit(TTY_LDISC, &tty->flags));
1aa4bed8 1358 mutex_unlock(&tty->ldisc_mutex);
23499705
SB
1359
1360 return 0;
1361}
1362
af9b897e 1363/**
d81ed103 1364 * tty_init_dev - initialise a tty device
af9b897e
AC
1365 * @driver: tty driver we are opening a device on
1366 * @idx: device index
15582d36 1367 * @ret_tty: returned tty structure
af9b897e
AC
1368 *
1369 * Prepare a tty device. This may not be a "new" clean device but
1370 * could also be an active device. The pty drivers require special
1371 * handling because of this.
1372 *
1373 * Locking:
1374 * The function is called under the tty_mutex, which
1375 * protects us from the tty struct or driver itself going away.
1376 *
1377 * On exit the tty device has the line discipline attached and
1378 * a reference count of 1. If a pair was created for pty/tty use
1379 * and the other was a pty master then it too has a reference count of 1.
1380 *
1da177e4 1381 * WSH 06/09/97: Rewritten to remove races and properly clean up after a
70522e12
IM
1382 * failed open. The new code protects the open with a mutex, so it's
1383 * really quite straightforward. The mutex locking can probably be
1da177e4
LT
1384 * relaxed for the (most common) case of reopening a tty.
1385 */
af9b897e 1386
593a27c4 1387struct tty_struct *tty_init_dev(struct tty_driver *driver, int idx)
1da177e4 1388{
bf970ee4 1389 struct tty_struct *tty;
73ec06fc 1390 int retval;
1da177e4 1391
1da177e4
LT
1392 /*
1393 * First time open is complex, especially for PTY devices.
1394 * This code guarantees that either everything succeeds and the
1395 * TTY is ready for operation, or else the table slots are vacated
37bdfb07 1396 * and the allocated memory released. (Except that the termios
1da177e4
LT
1397 * and locked termios may be retained.)
1398 */
1399
73ec06fc
AC
1400 if (!try_module_get(driver->owner))
1401 return ERR_PTR(-ENODEV);
1da177e4 1402
1da177e4 1403 tty = alloc_tty_struct();
d5543503
JS
1404 if (!tty) {
1405 retval = -ENOMEM;
1406 goto err_module_put;
1407 }
bf970ee4 1408 initialize_tty_struct(tty, driver, idx);
1da177e4 1409
89c8d91e 1410 tty_lock(tty);
73ec06fc 1411 retval = tty_driver_install_tty(driver, tty);
d5543503 1412 if (retval < 0)
a9dccddb 1413 goto err_deinit_tty;
8b0a88d5 1414
04831dc1
JS
1415 if (!tty->port)
1416 tty->port = driver->ports[idx];
1417
37bdfb07 1418 /*
1da177e4 1419 * Structures all installed ... call the ldisc open routines.
d5698c28
CH
1420 * If we fail here just call release_tty to clean up. No need
1421 * to decrement the use counts, as release_tty doesn't care.
1da177e4 1422 */
bf970ee4 1423 retval = tty_ldisc_setup(tty, tty->link);
01e1abb2 1424 if (retval)
d5543503 1425 goto err_release_tty;
89c8d91e 1426 /* Return the tty locked so that it cannot vanish under the caller */
73ec06fc 1427 return tty;
1da177e4 1428
a9dccddb 1429err_deinit_tty:
89c8d91e 1430 tty_unlock(tty);
a9dccddb 1431 deinitialize_tty_struct(tty);
d5543503
JS
1432 free_tty_struct(tty);
1433err_module_put:
1da177e4 1434 module_put(driver->owner);
d5543503 1435 return ERR_PTR(retval);
1da177e4 1436
d5698c28 1437 /* call the tty release_tty routine to clean out this slot */
d5543503 1438err_release_tty:
89c8d91e 1439 tty_unlock(tty);
5a3c6b25 1440 printk_ratelimited(KERN_INFO "tty_init_dev: ldisc open failed, "
4050914f 1441 "clearing slot %d\n", idx);
d5698c28 1442 release_tty(tty, idx);
73ec06fc 1443 return ERR_PTR(retval);
1da177e4
LT
1444}
1445
feebed65
AC
1446void tty_free_termios(struct tty_struct *tty)
1447{
1448 struct ktermios *tp;
1449 int idx = tty->index;
36b3c070
AC
1450
1451 /* If the port is going to reset then it has no termios to save */
1452 if (tty->driver->flags & TTY_DRIVER_RESET_TERMIOS)
1453 return;
1454
1455 /* Stash the termios data */
1456 tp = tty->driver->termios[idx];
1457 if (tp == NULL) {
1458 tp = kmalloc(sizeof(struct ktermios), GFP_KERNEL);
1459 if (tp == NULL) {
1460 pr_warn("tty: no memory to save termios state.\n");
1461 return;
1462 }
4ac5d705 1463 tty->driver->termios[idx] = tp;
feebed65 1464 }
36b3c070 1465 *tp = tty->termios;
feebed65
AC
1466}
1467EXPORT_SYMBOL(tty_free_termios);
1468
feebed65 1469
af9b897e 1470/**
d5698c28 1471 * release_one_tty - release tty structure memory
9c9f4ded 1472 * @kref: kref of tty we are obliterating
af9b897e
AC
1473 *
1474 * Releases memory associated with a tty structure, and clears out the
1475 * driver table slots. This function is called when a device is no longer
1476 * in use. It also gets called when setup of a device fails.
1477 *
1478 * Locking:
af9b897e
AC
1479 * takes the file list lock internally when working on the list
1480 * of ttys that the driver keeps.
b50989dc
AC
1481 *
1482 * This method gets called from a work queue so that the driver private
f278a2f7 1483 * cleanup ops can sleep (needed for USB at least)
1da177e4 1484 */
b50989dc 1485static void release_one_tty(struct work_struct *work)
1da177e4 1486{
b50989dc
AC
1487 struct tty_struct *tty =
1488 container_of(work, struct tty_struct, hangup_work);
6f967f78 1489 struct tty_driver *driver = tty->driver;
d5698c28 1490
f278a2f7
DY
1491 if (tty->ops->cleanup)
1492 tty->ops->cleanup(tty);
1493
1da177e4 1494 tty->magic = 0;
7d7b93c1 1495 tty_driver_kref_put(driver);
6f967f78 1496 module_put(driver->owner);
d5698c28 1497
ee2ffa0d 1498 spin_lock(&tty_files_lock);
1da177e4 1499 list_del_init(&tty->tty_files);
ee2ffa0d 1500 spin_unlock(&tty_files_lock);
d5698c28 1501
6da8d866
ON
1502 put_pid(tty->pgrp);
1503 put_pid(tty->session);
1da177e4
LT
1504 free_tty_struct(tty);
1505}
1506
b50989dc
AC
1507static void queue_release_one_tty(struct kref *kref)
1508{
1509 struct tty_struct *tty = container_of(kref, struct tty_struct, kref);
f278a2f7 1510
b50989dc
AC
1511 /* The hangup queue is now free so we can reuse it rather than
1512 waste a chunk of memory for each port */
1513 INIT_WORK(&tty->hangup_work, release_one_tty);
1514 schedule_work(&tty->hangup_work);
1515}
1516
9c9f4ded
AC
1517/**
1518 * tty_kref_put - release a tty kref
1519 * @tty: tty device
1520 *
1521 * Release a reference to a tty device and if need be let the kref
1522 * layer destruct the object for us
1523 */
1524
1525void tty_kref_put(struct tty_struct *tty)
1526{
1527 if (tty)
b50989dc 1528 kref_put(&tty->kref, queue_release_one_tty);
9c9f4ded
AC
1529}
1530EXPORT_SYMBOL(tty_kref_put);
1531
d5698c28
CH
1532/**
1533 * release_tty - release tty structure memory
1534 *
1535 * Release both @tty and a possible linked partner (think pty pair),
1536 * and decrement the refcount of the backing module.
1537 *
1538 * Locking:
d155255a 1539 * tty_mutex
d5698c28
CH
1540 * takes the file list lock internally when working on the list
1541 * of ttys that the driver keeps.
9c9f4ded 1542 *
d5698c28
CH
1543 */
1544static void release_tty(struct tty_struct *tty, int idx)
1545{
9c9f4ded
AC
1546 /* This should always be true but check for the moment */
1547 WARN_ON(tty->index != idx);
d155255a 1548 WARN_ON(!mutex_is_locked(&tty_mutex));
36b3c070
AC
1549 if (tty->ops->shutdown)
1550 tty->ops->shutdown(tty);
1551 tty_free_termios(tty);
1552 tty_driver_remove_tty(tty->driver, tty);
1553
d5698c28 1554 if (tty->link)
9c9f4ded
AC
1555 tty_kref_put(tty->link);
1556 tty_kref_put(tty);
d5698c28
CH
1557}
1558
955787ca
JS
1559/**
1560 * tty_release_checks - check a tty before real release
1561 * @tty: tty to check
1562 * @o_tty: link of @tty (if any)
1563 * @idx: index of the tty
1564 *
1565 * Performs some paranoid checking before true release of the @tty.
1566 * This is a no-op unless TTY_PARANOIA_CHECK is defined.
1567 */
1568static int tty_release_checks(struct tty_struct *tty, struct tty_struct *o_tty,
1569 int idx)
1570{
1571#ifdef TTY_PARANOIA_CHECK
1572 if (idx < 0 || idx >= tty->driver->num) {
9de44bd6
JS
1573 printk(KERN_DEBUG "%s: bad idx when trying to free (%s)\n",
1574 __func__, tty->name);
955787ca
JS
1575 return -1;
1576 }
1577
1578 /* not much to check for devpts */
1579 if (tty->driver->flags & TTY_DRIVER_DEVPTS_MEM)
1580 return 0;
1581
1582 if (tty != tty->driver->ttys[idx]) {
9de44bd6
JS
1583 printk(KERN_DEBUG "%s: driver.table[%d] not tty for (%s)\n",
1584 __func__, idx, tty->name);
955787ca
JS
1585 return -1;
1586 }
955787ca
JS
1587 if (tty->driver->other) {
1588 if (o_tty != tty->driver->other->ttys[idx]) {
9de44bd6
JS
1589 printk(KERN_DEBUG "%s: other->table[%d] not o_tty for (%s)\n",
1590 __func__, idx, tty->name);
955787ca
JS
1591 return -1;
1592 }
955787ca 1593 if (o_tty->link != tty) {
9de44bd6 1594 printk(KERN_DEBUG "%s: bad pty pointers\n", __func__);
955787ca
JS
1595 return -1;
1596 }
1597 }
1598#endif
1599 return 0;
1600}
1601
eeb89d91
AC
1602/**
1603 * tty_release - vfs callback for close
1604 * @inode: inode of tty
1605 * @filp: file pointer for handle to tty
1606 *
1607 * Called the last time each file handle is closed that references
1608 * this tty. There may however be several such references.
1609 *
1610 * Locking:
1611 * Takes bkl. See tty_release_dev
1612 *
1da177e4
LT
1613 * Even releasing the tty structures is a tricky business.. We have
1614 * to be very careful that the structures are all released at the
1615 * same time, as interrupts might otherwise get the wrong pointers.
1616 *
1617 * WSH 09/09/97: rewritten to avoid some nasty race conditions that could
1618 * lead to double frees or releasing memory still in use.
1619 */
eeb89d91
AC
1620
1621int tty_release(struct inode *inode, struct file *filp)
1da177e4 1622{
d996b62a
NP
1623 struct tty_struct *tty = file_tty(filp);
1624 struct tty_struct *o_tty;
1da177e4 1625 int pty_master, tty_closing, o_tty_closing, do_sleep;
14a6283e 1626 int devpts;
1da177e4
LT
1627 int idx;
1628 char buf[64];
37bdfb07 1629
9de44bd6 1630 if (tty_paranoia_check(tty, inode, __func__))
eeb89d91 1631 return 0;
1da177e4 1632
89c8d91e 1633 tty_lock(tty);
9de44bd6 1634 check_tty_count(tty, __func__);
1da177e4 1635
ec79d605 1636 __tty_fasync(-1, filp, 0);
1da177e4
LT
1637
1638 idx = tty->index;
1639 pty_master = (tty->driver->type == TTY_DRIVER_TYPE_PTY &&
1640 tty->driver->subtype == PTY_TYPE_MASTER);
1641 devpts = (tty->driver->flags & TTY_DRIVER_DEVPTS_MEM) != 0;
89c8d91e 1642 /* Review: parallel close */
1da177e4
LT
1643 o_tty = tty->link;
1644
955787ca 1645 if (tty_release_checks(tty, o_tty, idx)) {
89c8d91e 1646 tty_unlock(tty);
eeb89d91 1647 return 0;
1da177e4 1648 }
1da177e4
LT
1649
1650#ifdef TTY_DEBUG_HANGUP
9de44bd6
JS
1651 printk(KERN_DEBUG "%s: %s (tty count=%d)...\n", __func__,
1652 tty_name(tty, buf), tty->count);
1da177e4
LT
1653#endif
1654
f34d7a5b
AC
1655 if (tty->ops->close)
1656 tty->ops->close(tty, filp);
1da177e4 1657
89c8d91e 1658 tty_unlock(tty);
1da177e4
LT
1659 /*
1660 * Sanity check: if tty->count is going to zero, there shouldn't be
1661 * any waiters on tty->read_wait or tty->write_wait. We test the
1662 * wait queues and kick everyone out _before_ actually starting to
1663 * close. This ensures that we won't block while releasing the tty
1664 * structure.
1665 *
1666 * The test for the o_tty closing is necessary, since the master and
1667 * slave sides may close in any order. If the slave side closes out
1668 * first, its count will be one, since the master side holds an open.
1669 * Thus this test wouldn't be triggered at the time the slave closes,
1670 * so we do it now.
1671 *
1672 * Note that it's possible for the tty to be opened again while we're
1673 * flushing out waiters. By recalculating the closing flags before
1674 * each iteration we avoid any problems.
1675 */
1676 while (1) {
1677 /* Guard against races with tty->count changes elsewhere and
1678 opens on /dev/tty */
37bdfb07 1679
70522e12 1680 mutex_lock(&tty_mutex);
89c8d91e 1681 tty_lock_pair(tty, o_tty);
1da177e4
LT
1682 tty_closing = tty->count <= 1;
1683 o_tty_closing = o_tty &&
1684 (o_tty->count <= (pty_master ? 1 : 0));
1da177e4
LT
1685 do_sleep = 0;
1686
1687 if (tty_closing) {
1688 if (waitqueue_active(&tty->read_wait)) {
4b19449d 1689 wake_up_poll(&tty->read_wait, POLLIN);
1da177e4
LT
1690 do_sleep++;
1691 }
1692 if (waitqueue_active(&tty->write_wait)) {
4b19449d 1693 wake_up_poll(&tty->write_wait, POLLOUT);
1da177e4
LT
1694 do_sleep++;
1695 }
1696 }
1697 if (o_tty_closing) {
1698 if (waitqueue_active(&o_tty->read_wait)) {
4b19449d 1699 wake_up_poll(&o_tty->read_wait, POLLIN);
1da177e4
LT
1700 do_sleep++;
1701 }
1702 if (waitqueue_active(&o_tty->write_wait)) {
4b19449d 1703 wake_up_poll(&o_tty->write_wait, POLLOUT);
1da177e4
LT
1704 do_sleep++;
1705 }
1706 }
1707 if (!do_sleep)
1708 break;
1709
9de44bd6
JS
1710 printk(KERN_WARNING "%s: %s: read/write wait queue active!\n",
1711 __func__, tty_name(tty, buf));
89c8d91e 1712 tty_unlock_pair(tty, o_tty);
70522e12 1713 mutex_unlock(&tty_mutex);
1da177e4 1714 schedule();
37bdfb07 1715 }
1da177e4
LT
1716
1717 /*
37bdfb07
AC
1718 * The closing flags are now consistent with the open counts on
1719 * both sides, and we've completed the last operation that could
1da177e4 1720 * block, so it's safe to proceed with closing.
d155255a
AC
1721 *
1722 * We must *not* drop the tty_mutex until we ensure that a further
1723 * entry into tty_open can not pick up this tty.
1da177e4 1724 */
1da177e4
LT
1725 if (pty_master) {
1726 if (--o_tty->count < 0) {
9de44bd6
JS
1727 printk(KERN_WARNING "%s: bad pty slave count (%d) for %s\n",
1728 __func__, o_tty->count, tty_name(o_tty, buf));
1da177e4
LT
1729 o_tty->count = 0;
1730 }
1731 }
1732 if (--tty->count < 0) {
9de44bd6
JS
1733 printk(KERN_WARNING "%s: bad tty->count (%d) for %s\n",
1734 __func__, tty->count, tty_name(tty, buf));
1da177e4
LT
1735 tty->count = 0;
1736 }
37bdfb07 1737
1da177e4
LT
1738 /*
1739 * We've decremented tty->count, so we need to remove this file
1740 * descriptor off the tty->tty_files list; this serves two
1741 * purposes:
1742 * - check_tty_count sees the correct number of file descriptors
1743 * associated with this tty.
1744 * - do_tty_hangup no longer sees this file descriptor as
1745 * something that needs to be handled for hangups.
1746 */
d996b62a 1747 tty_del_file(filp);
1da177e4
LT
1748
1749 /*
1750 * Perform some housekeeping before deciding whether to return.
1751 *
1752 * Set the TTY_CLOSING flag if this was the last open. In the
1753 * case of a pty we may have to wait around for the other side
1754 * to close, and TTY_CLOSING makes sure we can't be reopened.
1755 */
37bdfb07 1756 if (tty_closing)
1da177e4 1757 set_bit(TTY_CLOSING, &tty->flags);
37bdfb07 1758 if (o_tty_closing)
1da177e4
LT
1759 set_bit(TTY_CLOSING, &o_tty->flags);
1760
1761 /*
1762 * If _either_ side is closing, make sure there aren't any
1763 * processes that still think tty or o_tty is their controlling
1764 * tty.
1765 */
1766 if (tty_closing || o_tty_closing) {
1da177e4 1767 read_lock(&tasklist_lock);
24ec839c 1768 session_clear_tty(tty->session);
1da177e4 1769 if (o_tty)
24ec839c 1770 session_clear_tty(o_tty->session);
1da177e4
LT
1771 read_unlock(&tasklist_lock);
1772 }
1773
70522e12 1774 mutex_unlock(&tty_mutex);
89c8d91e 1775 tty_unlock_pair(tty, o_tty);
d155255a
AC
1776 /* At this point the TTY_CLOSING flag should ensure a dead tty
1777 cannot be re-opened by a racing opener */
da965822 1778
1da177e4 1779 /* check whether both sides are closing ... */
d155255a 1780 if (!tty_closing || (o_tty && !o_tty_closing))
eeb89d91 1781 return 0;
37bdfb07 1782
1da177e4 1783#ifdef TTY_DEBUG_HANGUP
9de44bd6 1784 printk(KERN_DEBUG "%s: freeing tty structure...\n", __func__);
1da177e4
LT
1785#endif
1786 /*
01e1abb2 1787 * Ask the line discipline code to release its structures
1da177e4 1788 */
01e1abb2 1789 tty_ldisc_release(tty, o_tty);
1da177e4 1790 /*
d5698c28 1791 * The release_tty function takes care of the details of clearing
89c8d91e
AC
1792 * the slots and preserving the termios structure. The tty_unlock_pair
1793 * should be safe as we keep a kref while the tty is locked (so the
1794 * unlock never unlocks a freed tty).
1da177e4 1795 */
d155255a 1796 mutex_lock(&tty_mutex);
d5698c28 1797 release_tty(tty, idx);
d155255a 1798 mutex_unlock(&tty_mutex);
1da177e4 1799
1da177e4 1800 /* Make this pty number available for reallocation */
718a9163 1801 if (devpts)
15f1a633 1802 devpts_kill_index(inode, idx);
eeb89d91 1803 return 0;
1da177e4
LT
1804}
1805
b82154ac
JS
1806/**
1807 * tty_open_current_tty - get tty of current task for open
1808 * @device: device number
1809 * @filp: file pointer to tty
1810 * @return: tty of the current task iff @device is /dev/tty
1811 *
1812 * We cannot return driver and index like for the other nodes because
1813 * devpts will not work then. It expects inodes to be from devpts FS.
3af502b9
AC
1814 *
1815 * We need to move to returning a refcounted object from all the lookup
1816 * paths including this one.
b82154ac
JS
1817 */
1818static struct tty_struct *tty_open_current_tty(dev_t device, struct file *filp)
1819{
1820 struct tty_struct *tty;
1821
1822 if (device != MKDEV(TTYAUX_MAJOR, 0))
1823 return NULL;
1824
1825 tty = get_current_tty();
1826 if (!tty)
1827 return ERR_PTR(-ENXIO);
1828
1829 filp->f_flags |= O_NONBLOCK; /* Don't let /dev/tty block */
1830 /* noctty = 1; */
1831 tty_kref_put(tty);
1832 /* FIXME: we put a reference and return a TTY! */
3af502b9 1833 /* This is only safe because the caller holds tty_mutex */
b82154ac
JS
1834 return tty;
1835}
1836
5b5e7040
JS
1837/**
1838 * tty_lookup_driver - lookup a tty driver for a given device file
1839 * @device: device number
1840 * @filp: file pointer to tty
1841 * @noctty: set if the device should not become a controlling tty
1842 * @index: index for the device in the @return driver
1843 * @return: driver for this inode (with increased refcount)
1844 *
1845 * If @return is not erroneous, the caller is responsible to decrement the
1846 * refcount by tty_driver_kref_put.
1847 *
1848 * Locking: tty_mutex protects get_tty_driver
1849 */
1850static struct tty_driver *tty_lookup_driver(dev_t device, struct file *filp,
1851 int *noctty, int *index)
1852{
1853 struct tty_driver *driver;
1854
2cd0050c 1855 switch (device) {
5b5e7040 1856#ifdef CONFIG_VT
2cd0050c 1857 case MKDEV(TTY_MAJOR, 0): {
5b5e7040
JS
1858 extern struct tty_driver *console_driver;
1859 driver = tty_driver_kref_get(console_driver);
1860 *index = fg_console;
1861 *noctty = 1;
2cd0050c 1862 break;
5b5e7040
JS
1863 }
1864#endif
2cd0050c 1865 case MKDEV(TTYAUX_MAJOR, 1): {
5b5e7040
JS
1866 struct tty_driver *console_driver = console_device(index);
1867 if (console_driver) {
1868 driver = tty_driver_kref_get(console_driver);
1869 if (driver) {
1870 /* Don't let /dev/console block */
1871 filp->f_flags |= O_NONBLOCK;
1872 *noctty = 1;
2cd0050c 1873 break;
5b5e7040
JS
1874 }
1875 }
1876 return ERR_PTR(-ENODEV);
1877 }
2cd0050c
JS
1878 default:
1879 driver = get_tty_driver(device, index);
1880 if (!driver)
1881 return ERR_PTR(-ENODEV);
1882 break;
1883 }
5b5e7040
JS
1884 return driver;
1885}
1886
af9b897e 1887/**
eeb89d91 1888 * tty_open - open a tty device
af9b897e
AC
1889 * @inode: inode of device file
1890 * @filp: file pointer to tty
1da177e4 1891 *
af9b897e
AC
1892 * tty_open and tty_release keep up the tty count that contains the
1893 * number of opens done on a tty. We cannot use the inode-count, as
1894 * different inodes might point to the same tty.
1da177e4 1895 *
af9b897e
AC
1896 * Open-counting is needed for pty masters, as well as for keeping
1897 * track of serial lines: DTR is dropped when the last close happens.
1898 * (This is not done solely through tty->count, now. - Ted 1/27/92)
1899 *
1900 * The termios state of a pty is reset on first open so that
1901 * settings don't persist across reuse.
1902 *
5b5e7040 1903 * Locking: tty_mutex protects tty, tty_lookup_driver and tty_init_dev.
24ec839c
PZ
1904 * tty->count should protect the rest.
1905 * ->siglock protects ->signal/->sighand
89c8d91e
AC
1906 *
1907 * Note: the tty_unlock/lock cases without a ref are only safe due to
1908 * tty_mutex
1da177e4 1909 */
af9b897e 1910
eeb89d91 1911static int tty_open(struct inode *inode, struct file *filp)
1da177e4 1912{
b82154ac 1913 struct tty_struct *tty;
1da177e4 1914 int noctty, retval;
b82154ac 1915 struct tty_driver *driver = NULL;
1da177e4
LT
1916 int index;
1917 dev_t device = inode->i_rdev;
846c151a 1918 unsigned saved_flags = filp->f_flags;
1da177e4
LT
1919
1920 nonseekable_open(inode, filp);
37bdfb07 1921
1da177e4 1922retry_open:
fa90e1c9
JS
1923 retval = tty_alloc_file(filp);
1924 if (retval)
1925 return -ENOMEM;
1926
1da177e4
LT
1927 noctty = filp->f_flags & O_NOCTTY;
1928 index = -1;
1929 retval = 0;
37bdfb07 1930
70522e12 1931 mutex_lock(&tty_mutex);
89c8d91e 1932 /* This is protected by the tty_mutex */
b82154ac
JS
1933 tty = tty_open_current_tty(device, filp);
1934 if (IS_ERR(tty)) {
ba5db448
JS
1935 retval = PTR_ERR(tty);
1936 goto err_unlock;
5b5e7040
JS
1937 } else if (!tty) {
1938 driver = tty_lookup_driver(device, filp, &noctty, &index);
1939 if (IS_ERR(driver)) {
ba5db448
JS
1940 retval = PTR_ERR(driver);
1941 goto err_unlock;
1da177e4 1942 }
1da177e4 1943
4a2b5fdd 1944 /* check whether we're reopening an existing tty */
15f1a633 1945 tty = tty_driver_lookup_tty(driver, inode, index);
808ffa3d 1946 if (IS_ERR(tty)) {
ba5db448
JS
1947 retval = PTR_ERR(tty);
1948 goto err_unlock;
808ffa3d 1949 }
4a2b5fdd
SB
1950 }
1951
1952 if (tty) {
89c8d91e 1953 tty_lock(tty);
4a2b5fdd 1954 retval = tty_reopen(tty);
89c8d91e
AC
1955 if (retval < 0) {
1956 tty_unlock(tty);
4a2b5fdd 1957 tty = ERR_PTR(retval);
89c8d91e
AC
1958 }
1959 } else /* Returns with the tty_lock held for now */
593a27c4 1960 tty = tty_init_dev(driver, index);
4a2b5fdd 1961
70522e12 1962 mutex_unlock(&tty_mutex);
b82154ac
JS
1963 if (driver)
1964 tty_driver_kref_put(driver);
eeb89d91 1965 if (IS_ERR(tty)) {
ba5db448
JS
1966 retval = PTR_ERR(tty);
1967 goto err_file;
eeb89d91 1968 }
1da177e4 1969
fa90e1c9 1970 tty_add_file(tty, filp);
d996b62a 1971
9de44bd6 1972 check_tty_count(tty, __func__);
1da177e4
LT
1973 if (tty->driver->type == TTY_DRIVER_TYPE_PTY &&
1974 tty->driver->subtype == PTY_TYPE_MASTER)
1975 noctty = 1;
1976#ifdef TTY_DEBUG_HANGUP
9de44bd6 1977 printk(KERN_DEBUG "%s: opening %s...\n", __func__, tty->name);
1da177e4 1978#endif
909bc774
HRK
1979 if (tty->ops->open)
1980 retval = tty->ops->open(tty, filp);
1981 else
1982 retval = -ENODEV;
1da177e4
LT
1983 filp->f_flags = saved_flags;
1984
37bdfb07
AC
1985 if (!retval && test_bit(TTY_EXCLUSIVE, &tty->flags) &&
1986 !capable(CAP_SYS_ADMIN))
1da177e4
LT
1987 retval = -EBUSY;
1988
1989 if (retval) {
1990#ifdef TTY_DEBUG_HANGUP
9de44bd6
JS
1991 printk(KERN_DEBUG "%s: error %d in opening %s...\n", __func__,
1992 retval, tty->name);
1da177e4 1993#endif
89c8d91e 1994 tty_unlock(tty); /* need to call tty_release without BTM */
eeb89d91 1995 tty_release(inode, filp);
64ba3dc3 1996 if (retval != -ERESTARTSYS)
1da177e4 1997 return retval;
64ba3dc3
AB
1998
1999 if (signal_pending(current))
1da177e4 2000 return retval;
64ba3dc3 2001
1da177e4
LT
2002 schedule();
2003 /*
2004 * Need to reset f_op in case a hangup happened.
2005 */
2006 if (filp->f_op == &hung_up_tty_fops)
2007 filp->f_op = &tty_fops;
2008 goto retry_open;
2009 }
89c8d91e 2010 tty_unlock(tty);
eeb89d91 2011
24ec839c
PZ
2012
2013 mutex_lock(&tty_mutex);
89c8d91e 2014 tty_lock(tty);
24ec839c 2015 spin_lock_irq(&current->sighand->siglock);
1da177e4
LT
2016 if (!noctty &&
2017 current->signal->leader &&
2018 !current->signal->tty &&
ab521dc0 2019 tty->session == NULL)
2a65f1d9 2020 __proc_set_tty(current, tty);
24ec839c 2021 spin_unlock_irq(&current->sighand->siglock);
89c8d91e 2022 tty_unlock(tty);
24ec839c 2023 mutex_unlock(&tty_mutex);
1da177e4 2024 return 0;
ba5db448 2025err_unlock:
ba5db448
JS
2026 mutex_unlock(&tty_mutex);
2027 /* after locks to avoid deadlock */
2028 if (!IS_ERR_OR_NULL(driver))
2029 tty_driver_kref_put(driver);
2030err_file:
2031 tty_free_file(filp);
2032 return retval;
1da177e4
LT
2033}
2034
39d95b9d
JC
2035
2036
af9b897e
AC
2037/**
2038 * tty_poll - check tty status
2039 * @filp: file being polled
2040 * @wait: poll wait structures to update
2041 *
2042 * Call the line discipline polling method to obtain the poll
2043 * status of the device.
2044 *
2045 * Locking: locks called line discipline but ldisc poll method
2046 * may be re-entered freely by other callers.
2047 */
2048
37bdfb07 2049static unsigned int tty_poll(struct file *filp, poll_table *wait)
1da177e4 2050{
d996b62a 2051 struct tty_struct *tty = file_tty(filp);
1da177e4
LT
2052 struct tty_ldisc *ld;
2053 int ret = 0;
2054
a7113a96 2055 if (tty_paranoia_check(tty, filp->f_path.dentry->d_inode, "tty_poll"))
1da177e4 2056 return 0;
37bdfb07 2057
1da177e4 2058 ld = tty_ldisc_ref_wait(tty);
a352def2
AC
2059 if (ld->ops->poll)
2060 ret = (ld->ops->poll)(tty, filp, wait);
1da177e4
LT
2061 tty_ldisc_deref(ld);
2062 return ret;
2063}
2064
ec79d605 2065static int __tty_fasync(int fd, struct file *filp, int on)
1da177e4 2066{
d996b62a 2067 struct tty_struct *tty = file_tty(filp);
47f86834 2068 unsigned long flags;
5d1e3230 2069 int retval = 0;
1da177e4 2070
a7113a96 2071 if (tty_paranoia_check(tty, filp->f_path.dentry->d_inode, "tty_fasync"))
5d1e3230 2072 goto out;
37bdfb07 2073
1da177e4
LT
2074 retval = fasync_helper(fd, filp, on, &tty->fasync);
2075 if (retval <= 0)
5d1e3230 2076 goto out;
1da177e4
LT
2077
2078 if (on) {
ab521dc0
EB
2079 enum pid_type type;
2080 struct pid *pid;
1da177e4
LT
2081 if (!waitqueue_active(&tty->read_wait))
2082 tty->minimum_to_wake = 1;
47f86834 2083 spin_lock_irqsave(&tty->ctrl_lock, flags);
ab521dc0
EB
2084 if (tty->pgrp) {
2085 pid = tty->pgrp;
2086 type = PIDTYPE_PGID;
2087 } else {
2088 pid = task_pid(current);
2089 type = PIDTYPE_PID;
2090 }
80e1e823 2091 get_pid(pid);
70362511 2092 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
80e1e823
LT
2093 retval = __f_setown(filp, pid, type, 0);
2094 put_pid(pid);
1da177e4 2095 if (retval)
5d1e3230 2096 goto out;
1da177e4
LT
2097 } else {
2098 if (!tty->fasync && !waitqueue_active(&tty->read_wait))
2099 tty->minimum_to_wake = N_TTY_BUF_SIZE;
2100 }
5d1e3230
JC
2101 retval = 0;
2102out:
ec79d605
AB
2103 return retval;
2104}
2105
2106static int tty_fasync(int fd, struct file *filp, int on)
2107{
89c8d91e 2108 struct tty_struct *tty = file_tty(filp);
ec79d605 2109 int retval;
89c8d91e
AC
2110
2111 tty_lock(tty);
ec79d605 2112 retval = __tty_fasync(fd, filp, on);
89c8d91e
AC
2113 tty_unlock(tty);
2114
5d1e3230 2115 return retval;
1da177e4
LT
2116}
2117
af9b897e
AC
2118/**
2119 * tiocsti - fake input character
2120 * @tty: tty to fake input into
2121 * @p: pointer to character
2122 *
3a4fa0a2 2123 * Fake input to a tty device. Does the necessary locking and
af9b897e
AC
2124 * input management.
2125 *
2126 * FIXME: does not honour flow control ??
2127 *
2128 * Locking:
2129 * Called functions take tty_ldisc_lock
2130 * current->signal->tty check is safe without locks
28298232
AC
2131 *
2132 * FIXME: may race normal receive processing
af9b897e
AC
2133 */
2134
1da177e4
LT
2135static int tiocsti(struct tty_struct *tty, char __user *p)
2136{
2137 char ch, mbz = 0;
2138 struct tty_ldisc *ld;
37bdfb07 2139
1da177e4
LT
2140 if ((current->signal->tty != tty) && !capable(CAP_SYS_ADMIN))
2141 return -EPERM;
2142 if (get_user(ch, p))
2143 return -EFAULT;
1e641743 2144 tty_audit_tiocsti(tty, ch);
1da177e4 2145 ld = tty_ldisc_ref_wait(tty);
a352def2 2146 ld->ops->receive_buf(tty, &ch, &mbz, 1);
1da177e4
LT
2147 tty_ldisc_deref(ld);
2148 return 0;
2149}
2150
af9b897e
AC
2151/**
2152 * tiocgwinsz - implement window query ioctl
2153 * @tty; tty
2154 * @arg: user buffer for result
2155 *
808a0d38 2156 * Copies the kernel idea of the window size into the user buffer.
af9b897e 2157 *
24ec839c 2158 * Locking: tty->termios_mutex is taken to ensure the winsize data
808a0d38 2159 * is consistent.
af9b897e
AC
2160 */
2161
37bdfb07 2162static int tiocgwinsz(struct tty_struct *tty, struct winsize __user *arg)
1da177e4 2163{
808a0d38
AC
2164 int err;
2165
5785c95b 2166 mutex_lock(&tty->termios_mutex);
808a0d38 2167 err = copy_to_user(arg, &tty->winsize, sizeof(*arg));
5785c95b 2168 mutex_unlock(&tty->termios_mutex);
808a0d38
AC
2169
2170 return err ? -EFAULT: 0;
1da177e4
LT
2171}
2172
af9b897e 2173/**
8c9a9dd0
AC
2174 * tty_do_resize - resize event
2175 * @tty: tty being resized
8c9a9dd0
AC
2176 * @rows: rows (character)
2177 * @cols: cols (character)
2178 *
3ad2f3fb 2179 * Update the termios variables and send the necessary signals to
8c9a9dd0 2180 * peform a terminal resize correctly
af9b897e
AC
2181 */
2182
fc6f6238 2183int tty_do_resize(struct tty_struct *tty, struct winsize *ws)
1da177e4 2184{
fc6f6238 2185 struct pid *pgrp;
47f86834 2186 unsigned long flags;
1da177e4 2187
fc6f6238
AC
2188 /* Lock the tty */
2189 mutex_lock(&tty->termios_mutex);
2190 if (!memcmp(ws, &tty->winsize, sizeof(*ws)))
ca9bda00 2191 goto done;
47f86834
AC
2192 /* Get the PID values and reference them so we can
2193 avoid holding the tty ctrl lock while sending signals */
2194 spin_lock_irqsave(&tty->ctrl_lock, flags);
2195 pgrp = get_pid(tty->pgrp);
47f86834
AC
2196 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
2197
2198 if (pgrp)
2199 kill_pgrp(pgrp, SIGWINCH, 1);
47f86834 2200 put_pid(pgrp);
47f86834 2201
8c9a9dd0 2202 tty->winsize = *ws;
ca9bda00 2203done:
fc6f6238 2204 mutex_unlock(&tty->termios_mutex);
1da177e4
LT
2205 return 0;
2206}
2207
8c9a9dd0
AC
2208/**
2209 * tiocswinsz - implement window size set ioctl
fc6f6238 2210 * @tty; tty side of tty
8c9a9dd0
AC
2211 * @arg: user buffer for result
2212 *
2213 * Copies the user idea of the window size to the kernel. Traditionally
2214 * this is just advisory information but for the Linux console it
2215 * actually has driver level meaning and triggers a VC resize.
2216 *
2217 * Locking:
25985edc 2218 * Driver dependent. The default do_resize method takes the
8c9a9dd0
AC
2219 * tty termios mutex and ctrl_lock. The console takes its own lock
2220 * then calls into the default method.
2221 */
2222
fc6f6238 2223static int tiocswinsz(struct tty_struct *tty, struct winsize __user *arg)
8c9a9dd0
AC
2224{
2225 struct winsize tmp_ws;
2226 if (copy_from_user(&tmp_ws, arg, sizeof(*arg)))
2227 return -EFAULT;
2228
2229 if (tty->ops->resize)
fc6f6238 2230 return tty->ops->resize(tty, &tmp_ws);
8c9a9dd0 2231 else
fc6f6238 2232 return tty_do_resize(tty, &tmp_ws);
8c9a9dd0
AC
2233}
2234
af9b897e
AC
2235/**
2236 * tioccons - allow admin to move logical console
2237 * @file: the file to become console
2238 *
25985edc 2239 * Allow the administrator to move the redirected console device
af9b897e
AC
2240 *
2241 * Locking: uses redirect_lock to guard the redirect information
2242 */
2243
1da177e4
LT
2244static int tioccons(struct file *file)
2245{
2246 if (!capable(CAP_SYS_ADMIN))
2247 return -EPERM;
2248 if (file->f_op->write == redirected_tty_write) {
2249 struct file *f;
2250 spin_lock(&redirect_lock);
2251 f = redirect;
2252 redirect = NULL;
2253 spin_unlock(&redirect_lock);
2254 if (f)
2255 fput(f);
2256 return 0;
2257 }
2258 spin_lock(&redirect_lock);
2259 if (redirect) {
2260 spin_unlock(&redirect_lock);
2261 return -EBUSY;
2262 }
2263 get_file(file);
2264 redirect = file;
2265 spin_unlock(&redirect_lock);
2266 return 0;
2267}
2268
af9b897e
AC
2269/**
2270 * fionbio - non blocking ioctl
2271 * @file: file to set blocking value
2272 * @p: user parameter
2273 *
2274 * Historical tty interfaces had a blocking control ioctl before
2275 * the generic functionality existed. This piece of history is preserved
2276 * in the expected tty API of posix OS's.
2277 *
6146b9af 2278 * Locking: none, the open file handle ensures it won't go away.
af9b897e 2279 */
1da177e4
LT
2280
2281static int fionbio(struct file *file, int __user *p)
2282{
2283 int nonblock;
2284
2285 if (get_user(nonblock, p))
2286 return -EFAULT;
2287
db1dd4d3 2288 spin_lock(&file->f_lock);
1da177e4
LT
2289 if (nonblock)
2290 file->f_flags |= O_NONBLOCK;
2291 else
2292 file->f_flags &= ~O_NONBLOCK;
db1dd4d3 2293 spin_unlock(&file->f_lock);
1da177e4
LT
2294 return 0;
2295}
2296
af9b897e
AC
2297/**
2298 * tiocsctty - set controlling tty
2299 * @tty: tty structure
2300 * @arg: user argument
2301 *
2302 * This ioctl is used to manage job control. It permits a session
2303 * leader to set this tty as the controlling tty for the session.
2304 *
2305 * Locking:
28298232 2306 * Takes tty_mutex() to protect tty instance
24ec839c
PZ
2307 * Takes tasklist_lock internally to walk sessions
2308 * Takes ->siglock() when updating signal->tty
af9b897e
AC
2309 */
2310
1da177e4
LT
2311static int tiocsctty(struct tty_struct *tty, int arg)
2312{
24ec839c 2313 int ret = 0;
ab521dc0 2314 if (current->signal->leader && (task_session(current) == tty->session))
24ec839c
PZ
2315 return ret;
2316
2317 mutex_lock(&tty_mutex);
1da177e4
LT
2318 /*
2319 * The process must be a session leader and
2320 * not have a controlling tty already.
2321 */
24ec839c
PZ
2322 if (!current->signal->leader || current->signal->tty) {
2323 ret = -EPERM;
2324 goto unlock;
2325 }
2326
ab521dc0 2327 if (tty->session) {
1da177e4
LT
2328 /*
2329 * This tty is already the controlling
2330 * tty for another session group!
2331 */
37bdfb07 2332 if (arg == 1 && capable(CAP_SYS_ADMIN)) {
1da177e4
LT
2333 /*
2334 * Steal it away
2335 */
1da177e4 2336 read_lock(&tasklist_lock);
24ec839c 2337 session_clear_tty(tty->session);
1da177e4 2338 read_unlock(&tasklist_lock);
24ec839c
PZ
2339 } else {
2340 ret = -EPERM;
2341 goto unlock;
2342 }
1da177e4 2343 }
24ec839c
PZ
2344 proc_set_tty(current, tty);
2345unlock:
28298232 2346 mutex_unlock(&tty_mutex);
24ec839c 2347 return ret;
1da177e4
LT
2348}
2349
5d0fdf1e
AC
2350/**
2351 * tty_get_pgrp - return a ref counted pgrp pid
2352 * @tty: tty to read
2353 *
2354 * Returns a refcounted instance of the pid struct for the process
2355 * group controlling the tty.
2356 */
2357
2358struct pid *tty_get_pgrp(struct tty_struct *tty)
2359{
2360 unsigned long flags;
2361 struct pid *pgrp;
2362
2363 spin_lock_irqsave(&tty->ctrl_lock, flags);
2364 pgrp = get_pid(tty->pgrp);
2365 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
2366
2367 return pgrp;
2368}
2369EXPORT_SYMBOL_GPL(tty_get_pgrp);
2370
af9b897e
AC
2371/**
2372 * tiocgpgrp - get process group
2373 * @tty: tty passed by user
25985edc 2374 * @real_tty: tty side of the tty passed by the user if a pty else the tty
af9b897e
AC
2375 * @p: returned pid
2376 *
2377 * Obtain the process group of the tty. If there is no process group
2378 * return an error.
2379 *
24ec839c 2380 * Locking: none. Reference to current->signal->tty is safe.
af9b897e
AC
2381 */
2382
1da177e4
LT
2383static int tiocgpgrp(struct tty_struct *tty, struct tty_struct *real_tty, pid_t __user *p)
2384{
5d0fdf1e
AC
2385 struct pid *pid;
2386 int ret;
1da177e4
LT
2387 /*
2388 * (tty == real_tty) is a cheap way of
2389 * testing if the tty is NOT a master pty.
2390 */
2391 if (tty == real_tty && current->signal->tty != real_tty)
2392 return -ENOTTY;
5d0fdf1e
AC
2393 pid = tty_get_pgrp(real_tty);
2394 ret = put_user(pid_vnr(pid), p);
2395 put_pid(pid);
2396 return ret;
1da177e4
LT
2397}
2398
af9b897e
AC
2399/**
2400 * tiocspgrp - attempt to set process group
2401 * @tty: tty passed by user
2402 * @real_tty: tty side device matching tty passed by user
2403 * @p: pid pointer
2404 *
2405 * Set the process group of the tty to the session passed. Only
2406 * permitted where the tty session is our session.
2407 *
47f86834 2408 * Locking: RCU, ctrl lock
af9b897e
AC
2409 */
2410
1da177e4
LT
2411static int tiocspgrp(struct tty_struct *tty, struct tty_struct *real_tty, pid_t __user *p)
2412{
04a2e6a5
EB
2413 struct pid *pgrp;
2414 pid_t pgrp_nr;
1da177e4 2415 int retval = tty_check_change(real_tty);
47f86834 2416 unsigned long flags;
1da177e4
LT
2417
2418 if (retval == -EIO)
2419 return -ENOTTY;
2420 if (retval)
2421 return retval;
2422 if (!current->signal->tty ||
2423 (current->signal->tty != real_tty) ||
ab521dc0 2424 (real_tty->session != task_session(current)))
1da177e4 2425 return -ENOTTY;
04a2e6a5 2426 if (get_user(pgrp_nr, p))
1da177e4 2427 return -EFAULT;
04a2e6a5 2428 if (pgrp_nr < 0)
1da177e4 2429 return -EINVAL;
04a2e6a5 2430 rcu_read_lock();
b488893a 2431 pgrp = find_vpid(pgrp_nr);
04a2e6a5
EB
2432 retval = -ESRCH;
2433 if (!pgrp)
2434 goto out_unlock;
2435 retval = -EPERM;
2436 if (session_of_pgrp(pgrp) != task_session(current))
2437 goto out_unlock;
2438 retval = 0;
47f86834 2439 spin_lock_irqsave(&tty->ctrl_lock, flags);
ab521dc0
EB
2440 put_pid(real_tty->pgrp);
2441 real_tty->pgrp = get_pid(pgrp);
47f86834 2442 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
04a2e6a5
EB
2443out_unlock:
2444 rcu_read_unlock();
2445 return retval;
1da177e4
LT
2446}
2447
af9b897e
AC
2448/**
2449 * tiocgsid - get session id
2450 * @tty: tty passed by user
25985edc 2451 * @real_tty: tty side of the tty passed by the user if a pty else the tty
af9b897e
AC
2452 * @p: pointer to returned session id
2453 *
2454 * Obtain the session id of the tty. If there is no session
2455 * return an error.
2456 *
24ec839c 2457 * Locking: none. Reference to current->signal->tty is safe.
af9b897e
AC
2458 */
2459
1da177e4
LT
2460static int tiocgsid(struct tty_struct *tty, struct tty_struct *real_tty, pid_t __user *p)
2461{
2462 /*
2463 * (tty == real_tty) is a cheap way of
2464 * testing if the tty is NOT a master pty.
2465 */
2466 if (tty == real_tty && current->signal->tty != real_tty)
2467 return -ENOTTY;
ab521dc0 2468 if (!real_tty->session)
1da177e4 2469 return -ENOTTY;
b488893a 2470 return put_user(pid_vnr(real_tty->session), p);
1da177e4
LT
2471}
2472
af9b897e
AC
2473/**
2474 * tiocsetd - set line discipline
2475 * @tty: tty device
2476 * @p: pointer to user data
2477 *
2478 * Set the line discipline according to user request.
2479 *
2480 * Locking: see tty_set_ldisc, this function is just a helper
2481 */
2482
1da177e4
LT
2483static int tiocsetd(struct tty_struct *tty, int __user *p)
2484{
2485 int ldisc;
04f378b1 2486 int ret;
1da177e4
LT
2487
2488 if (get_user(ldisc, p))
2489 return -EFAULT;
04f378b1 2490
04f378b1 2491 ret = tty_set_ldisc(tty, ldisc);
04f378b1
AC
2492
2493 return ret;
1da177e4
LT
2494}
2495
af9b897e
AC
2496/**
2497 * send_break - performed time break
2498 * @tty: device to break on
2499 * @duration: timeout in mS
2500 *
2501 * Perform a timed break on hardware that lacks its own driver level
2502 * timed break functionality.
2503 *
2504 * Locking:
28298232 2505 * atomic_write_lock serializes
af9b897e 2506 *
af9b897e
AC
2507 */
2508
b20f3ae5 2509static int send_break(struct tty_struct *tty, unsigned int duration)
1da177e4 2510{
9e98966c
AC
2511 int retval;
2512
2513 if (tty->ops->break_ctl == NULL)
2514 return 0;
2515
2516 if (tty->driver->flags & TTY_DRIVER_HARDWARE_BREAK)
2517 retval = tty->ops->break_ctl(tty, duration);
2518 else {
2519 /* Do the work ourselves */
2520 if (tty_write_lock(tty, 0) < 0)
2521 return -EINTR;
2522 retval = tty->ops->break_ctl(tty, -1);
2523 if (retval)
2524 goto out;
2525 if (!signal_pending(current))
2526 msleep_interruptible(duration);
2527 retval = tty->ops->break_ctl(tty, 0);
2528out:
2529 tty_write_unlock(tty);
2530 if (signal_pending(current))
2531 retval = -EINTR;
2532 }
2533 return retval;
1da177e4
LT
2534}
2535
af9b897e 2536/**
f34d7a5b 2537 * tty_tiocmget - get modem status
af9b897e
AC
2538 * @tty: tty device
2539 * @file: user file pointer
2540 * @p: pointer to result
2541 *
2542 * Obtain the modem status bits from the tty driver if the feature
2543 * is supported. Return -EINVAL if it is not available.
2544 *
2545 * Locking: none (up to the driver)
2546 */
2547
60b33c13 2548static int tty_tiocmget(struct tty_struct *tty, int __user *p)
1da177e4
LT
2549{
2550 int retval = -EINVAL;
2551
f34d7a5b 2552 if (tty->ops->tiocmget) {
60b33c13 2553 retval = tty->ops->tiocmget(tty);
1da177e4
LT
2554
2555 if (retval >= 0)
2556 retval = put_user(retval, p);
2557 }
2558 return retval;
2559}
2560
af9b897e 2561/**
f34d7a5b 2562 * tty_tiocmset - set modem status
af9b897e 2563 * @tty: tty device
af9b897e
AC
2564 * @cmd: command - clear bits, set bits or set all
2565 * @p: pointer to desired bits
2566 *
2567 * Set the modem status bits from the tty driver if the feature
2568 * is supported. Return -EINVAL if it is not available.
2569 *
2570 * Locking: none (up to the driver)
2571 */
2572
20b9d177 2573static int tty_tiocmset(struct tty_struct *tty, unsigned int cmd,
1da177e4
LT
2574 unsigned __user *p)
2575{
ae677517
AC
2576 int retval;
2577 unsigned int set, clear, val;
1da177e4 2578
ae677517
AC
2579 if (tty->ops->tiocmset == NULL)
2580 return -EINVAL;
1da177e4 2581
ae677517
AC
2582 retval = get_user(val, p);
2583 if (retval)
2584 return retval;
2585 set = clear = 0;
2586 switch (cmd) {
2587 case TIOCMBIS:
2588 set = val;
2589 break;
2590 case TIOCMBIC:
2591 clear = val;
2592 break;
2593 case TIOCMSET:
2594 set = val;
2595 clear = ~val;
2596 break;
2597 }
2598 set &= TIOCM_DTR|TIOCM_RTS|TIOCM_OUT1|TIOCM_OUT2|TIOCM_LOOP;
2599 clear &= TIOCM_DTR|TIOCM_RTS|TIOCM_OUT1|TIOCM_OUT2|TIOCM_LOOP;
20b9d177 2600 return tty->ops->tiocmset(tty, set, clear);
1da177e4
LT
2601}
2602
d281da7f
AC
2603static int tty_tiocgicount(struct tty_struct *tty, void __user *arg)
2604{
2605 int retval = -EINVAL;
2606 struct serial_icounter_struct icount;
2607 memset(&icount, 0, sizeof(icount));
2608 if (tty->ops->get_icount)
2609 retval = tty->ops->get_icount(tty, &icount);
2610 if (retval != 0)
2611 return retval;
2612 if (copy_to_user(arg, &icount, sizeof(icount)))
2613 return -EFAULT;
2614 return 0;
2615}
2616
e8b70e7d
AC
2617struct tty_struct *tty_pair_get_tty(struct tty_struct *tty)
2618{
2619 if (tty->driver->type == TTY_DRIVER_TYPE_PTY &&
2620 tty->driver->subtype == PTY_TYPE_MASTER)
2621 tty = tty->link;
2622 return tty;
2623}
2624EXPORT_SYMBOL(tty_pair_get_tty);
2625
2626struct tty_struct *tty_pair_get_pty(struct tty_struct *tty)
2627{
2628 if (tty->driver->type == TTY_DRIVER_TYPE_PTY &&
2629 tty->driver->subtype == PTY_TYPE_MASTER)
2630 return tty;
2631 return tty->link;
2632}
2633EXPORT_SYMBOL(tty_pair_get_pty);
2634
1da177e4
LT
2635/*
2636 * Split this up, as gcc can choke on it otherwise..
2637 */
04f378b1 2638long tty_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
1da177e4 2639{
d996b62a
NP
2640 struct tty_struct *tty = file_tty(file);
2641 struct tty_struct *real_tty;
1da177e4
LT
2642 void __user *p = (void __user *)arg;
2643 int retval;
2644 struct tty_ldisc *ld;
04f378b1 2645 struct inode *inode = file->f_dentry->d_inode;
37bdfb07 2646
1da177e4
LT
2647 if (tty_paranoia_check(tty, inode, "tty_ioctl"))
2648 return -EINVAL;
2649
e8b70e7d 2650 real_tty = tty_pair_get_tty(tty);
1da177e4
LT
2651
2652 /*
2653 * Factor out some common prep work
2654 */
2655 switch (cmd) {
2656 case TIOCSETD:
2657 case TIOCSBRK:
2658 case TIOCCBRK:
2659 case TCSBRK:
37bdfb07 2660 case TCSBRKP:
1da177e4
LT
2661 retval = tty_check_change(tty);
2662 if (retval)
2663 return retval;
2664 if (cmd != TIOCCBRK) {
2665 tty_wait_until_sent(tty, 0);
2666 if (signal_pending(current))
2667 return -EINTR;
2668 }
2669 break;
2670 }
2671
9e98966c
AC
2672 /*
2673 * Now do the stuff.
2674 */
1da177e4 2675 switch (cmd) {
37bdfb07
AC
2676 case TIOCSTI:
2677 return tiocsti(tty, p);
2678 case TIOCGWINSZ:
8f520021 2679 return tiocgwinsz(real_tty, p);
37bdfb07 2680 case TIOCSWINSZ:
fc6f6238 2681 return tiocswinsz(real_tty, p);
37bdfb07
AC
2682 case TIOCCONS:
2683 return real_tty != tty ? -EINVAL : tioccons(file);
2684 case FIONBIO:
2685 return fionbio(file, p);
2686 case TIOCEXCL:
2687 set_bit(TTY_EXCLUSIVE, &tty->flags);
2688 return 0;
2689 case TIOCNXCL:
2690 clear_bit(TTY_EXCLUSIVE, &tty->flags);
2691 return 0;
2692 case TIOCNOTTY:
2693 if (current->signal->tty != tty)
2694 return -ENOTTY;
2695 no_tty();
2696 return 0;
2697 case TIOCSCTTY:
2698 return tiocsctty(tty, arg);
2699 case TIOCGPGRP:
2700 return tiocgpgrp(tty, real_tty, p);
2701 case TIOCSPGRP:
2702 return tiocspgrp(tty, real_tty, p);
2703 case TIOCGSID:
2704 return tiocgsid(tty, real_tty, p);
2705 case TIOCGETD:
c65c9bc3 2706 return put_user(tty->ldisc->ops->num, (int __user *)p);
37bdfb07
AC
2707 case TIOCSETD:
2708 return tiocsetd(tty, p);
3c95c985
KS
2709 case TIOCVHANGUP:
2710 if (!capable(CAP_SYS_ADMIN))
2711 return -EPERM;
2712 tty_vhangup(tty);
2713 return 0;
b7b8de08
WF
2714 case TIOCGDEV:
2715 {
2716 unsigned int ret = new_encode_dev(tty_devnum(real_tty));
2717 return put_user(ret, (unsigned int __user *)p);
2718 }
37bdfb07
AC
2719 /*
2720 * Break handling
2721 */
2722 case TIOCSBRK: /* Turn break on, unconditionally */
f34d7a5b 2723 if (tty->ops->break_ctl)
9e98966c 2724 return tty->ops->break_ctl(tty, -1);
37bdfb07 2725 return 0;
37bdfb07 2726 case TIOCCBRK: /* Turn break off, unconditionally */
f34d7a5b 2727 if (tty->ops->break_ctl)
9e98966c 2728 return tty->ops->break_ctl(tty, 0);
37bdfb07
AC
2729 return 0;
2730 case TCSBRK: /* SVID version: non-zero arg --> no break */
2731 /* non-zero arg means wait for all output data
2732 * to be sent (performed above) but don't send break.
2733 * This is used by the tcdrain() termios function.
2734 */
2735 if (!arg)
2736 return send_break(tty, 250);
2737 return 0;
2738 case TCSBRKP: /* support for POSIX tcsendbreak() */
2739 return send_break(tty, arg ? arg*100 : 250);
2740
2741 case TIOCMGET:
60b33c13 2742 return tty_tiocmget(tty, p);
37bdfb07
AC
2743 case TIOCMSET:
2744 case TIOCMBIC:
2745 case TIOCMBIS:
20b9d177 2746 return tty_tiocmset(tty, cmd, p);
d281da7f
AC
2747 case TIOCGICOUNT:
2748 retval = tty_tiocgicount(tty, p);
2749 /* For the moment allow fall through to the old method */
2750 if (retval != -EINVAL)
2751 return retval;
2752 break;
37bdfb07
AC
2753 case TCFLSH:
2754 switch (arg) {
2755 case TCIFLUSH:
2756 case TCIOFLUSH:
2757 /* flush tty buffer and allow ldisc to process ioctl */
2758 tty_buffer_flush(tty);
c5c34d48 2759 break;
37bdfb07
AC
2760 }
2761 break;
1da177e4 2762 }
f34d7a5b 2763 if (tty->ops->ioctl) {
6caa76b7 2764 retval = (tty->ops->ioctl)(tty, cmd, arg);
1da177e4
LT
2765 if (retval != -ENOIOCTLCMD)
2766 return retval;
2767 }
2768 ld = tty_ldisc_ref_wait(tty);
2769 retval = -EINVAL;
a352def2
AC
2770 if (ld->ops->ioctl) {
2771 retval = ld->ops->ioctl(tty, file, cmd, arg);
1da177e4
LT
2772 if (retval == -ENOIOCTLCMD)
2773 retval = -EINVAL;
2774 }
2775 tty_ldisc_deref(ld);
2776 return retval;
2777}
2778
e10cc1df 2779#ifdef CONFIG_COMPAT
37bdfb07 2780static long tty_compat_ioctl(struct file *file, unsigned int cmd,
e10cc1df
PF
2781 unsigned long arg)
2782{
2783 struct inode *inode = file->f_dentry->d_inode;
d996b62a 2784 struct tty_struct *tty = file_tty(file);
e10cc1df
PF
2785 struct tty_ldisc *ld;
2786 int retval = -ENOIOCTLCMD;
2787
2788 if (tty_paranoia_check(tty, inode, "tty_ioctl"))
2789 return -EINVAL;
2790
f34d7a5b 2791 if (tty->ops->compat_ioctl) {
6caa76b7 2792 retval = (tty->ops->compat_ioctl)(tty, cmd, arg);
e10cc1df
PF
2793 if (retval != -ENOIOCTLCMD)
2794 return retval;
2795 }
2796
2797 ld = tty_ldisc_ref_wait(tty);
a352def2
AC
2798 if (ld->ops->compat_ioctl)
2799 retval = ld->ops->compat_ioctl(tty, file, cmd, arg);
8193c429
TM
2800 else
2801 retval = n_tty_compat_ioctl_helper(tty, file, cmd, arg);
e10cc1df
PF
2802 tty_ldisc_deref(ld);
2803
2804 return retval;
2805}
2806#endif
1da177e4
LT
2807
2808/*
2809 * This implements the "Secure Attention Key" --- the idea is to
2810 * prevent trojan horses by killing all processes associated with this
2811 * tty when the user hits the "Secure Attention Key". Required for
2812 * super-paranoid applications --- see the Orange Book for more details.
37bdfb07 2813 *
1da177e4
LT
2814 * This code could be nicer; ideally it should send a HUP, wait a few
2815 * seconds, then send a INT, and then a KILL signal. But you then
2816 * have to coordinate with the init process, since all processes associated
2817 * with the current tty must be dead before the new getty is allowed
2818 * to spawn.
2819 *
2820 * Now, if it would be correct ;-/ The current code has a nasty hole -
2821 * it doesn't catch files in flight. We may send the descriptor to ourselves
2822 * via AF_UNIX socket, close it and later fetch from socket. FIXME.
2823 *
2824 * Nasty bug: do_SAK is being called in interrupt context. This can
2825 * deadlock. We punt it up to process context. AKPM - 16Mar2001
2826 */
8b6312f4 2827void __do_SAK(struct tty_struct *tty)
1da177e4
LT
2828{
2829#ifdef TTY_SOFT_SAK
2830 tty_hangup(tty);
2831#else
652486fb 2832 struct task_struct *g, *p;
ab521dc0 2833 struct pid *session;
1da177e4
LT
2834 int i;
2835 struct file *filp;
badf1662 2836 struct fdtable *fdt;
37bdfb07 2837
1da177e4
LT
2838 if (!tty)
2839 return;
24ec839c 2840 session = tty->session;
37bdfb07 2841
b3f13deb 2842 tty_ldisc_flush(tty);
1da177e4 2843
f34d7a5b 2844 tty_driver_flush_buffer(tty);
37bdfb07 2845
1da177e4 2846 read_lock(&tasklist_lock);
652486fb 2847 /* Kill the entire session */
ab521dc0 2848 do_each_pid_task(session, PIDTYPE_SID, p) {
652486fb 2849 printk(KERN_NOTICE "SAK: killed process %d"
1b0f7ffd 2850 " (%s): task_session(p)==tty->session\n",
ba25f9dc 2851 task_pid_nr(p), p->comm);
652486fb 2852 send_sig(SIGKILL, p, 1);
ab521dc0 2853 } while_each_pid_task(session, PIDTYPE_SID, p);
652486fb
EB
2854 /* Now kill any processes that happen to have the
2855 * tty open.
2856 */
2857 do_each_thread(g, p) {
2858 if (p->signal->tty == tty) {
1da177e4 2859 printk(KERN_NOTICE "SAK: killed process %d"
1b0f7ffd 2860 " (%s): task_session(p)==tty->session\n",
ba25f9dc 2861 task_pid_nr(p), p->comm);
1da177e4
LT
2862 send_sig(SIGKILL, p, 1);
2863 continue;
2864 }
2865 task_lock(p);
2866 if (p->files) {
ca99c1da
DS
2867 /*
2868 * We don't take a ref to the file, so we must
2869 * hold ->file_lock instead.
2870 */
2871 spin_lock(&p->files->file_lock);
badf1662 2872 fdt = files_fdtable(p->files);
37bdfb07 2873 for (i = 0; i < fdt->max_fds; i++) {
1da177e4
LT
2874 filp = fcheck_files(p->files, i);
2875 if (!filp)
2876 continue;
2877 if (filp->f_op->read == tty_read &&
d996b62a 2878 file_tty(filp) == tty) {
1da177e4
LT
2879 printk(KERN_NOTICE "SAK: killed process %d"
2880 " (%s): fd#%d opened to the tty\n",
ba25f9dc 2881 task_pid_nr(p), p->comm, i);
20ac9437 2882 force_sig(SIGKILL, p);
1da177e4
LT
2883 break;
2884 }
2885 }
ca99c1da 2886 spin_unlock(&p->files->file_lock);
1da177e4
LT
2887 }
2888 task_unlock(p);
652486fb 2889 } while_each_thread(g, p);
1da177e4
LT
2890 read_unlock(&tasklist_lock);
2891#endif
2892}
2893
8b6312f4
EB
2894static void do_SAK_work(struct work_struct *work)
2895{
2896 struct tty_struct *tty =
2897 container_of(work, struct tty_struct, SAK_work);
2898 __do_SAK(tty);
2899}
2900
1da177e4
LT
2901/*
2902 * The tq handling here is a little racy - tty->SAK_work may already be queued.
2903 * Fortunately we don't need to worry, because if ->SAK_work is already queued,
2904 * the values which we write to it will be identical to the values which it
2905 * already has. --akpm
2906 */
2907void do_SAK(struct tty_struct *tty)
2908{
2909 if (!tty)
2910 return;
1da177e4
LT
2911 schedule_work(&tty->SAK_work);
2912}
2913
2914EXPORT_SYMBOL(do_SAK);
2915
30004ac9
DES
2916static int dev_match_devt(struct device *dev, void *data)
2917{
2918 dev_t *devt = data;
2919 return dev->devt == *devt;
2920}
2921
2922/* Must put_device() after it's unused! */
2923static struct device *tty_get_device(struct tty_struct *tty)
2924{
2925 dev_t devt = tty_devnum(tty);
2926 return class_find_device(tty_class, NULL, &devt, dev_match_devt);
2927}
2928
2929
af9b897e
AC
2930/**
2931 * initialize_tty_struct
2932 * @tty: tty to initialize
2933 *
2934 * This subroutine initializes a tty structure that has been newly
2935 * allocated.
2936 *
2937 * Locking: none - tty in question must not be exposed at this point
1da177e4 2938 */
af9b897e 2939
bf970ee4
AC
2940void initialize_tty_struct(struct tty_struct *tty,
2941 struct tty_driver *driver, int idx)
1da177e4
LT
2942{
2943 memset(tty, 0, sizeof(struct tty_struct));
9c9f4ded 2944 kref_init(&tty->kref);
1da177e4 2945 tty->magic = TTY_MAGIC;
01e1abb2 2946 tty_ldisc_init(tty);
ab521dc0
EB
2947 tty->session = NULL;
2948 tty->pgrp = NULL;
1da177e4 2949 tty->overrun_time = jiffies;
33f0f88f 2950 tty_buffer_init(tty);
89c8d91e 2951 mutex_init(&tty->legacy_mutex);
5785c95b 2952 mutex_init(&tty->termios_mutex);
c65c9bc3 2953 mutex_init(&tty->ldisc_mutex);
1da177e4
LT
2954 init_waitqueue_head(&tty->write_wait);
2955 init_waitqueue_head(&tty->read_wait);
65f27f38 2956 INIT_WORK(&tty->hangup_work, do_tty_hangup);
70522e12
IM
2957 mutex_init(&tty->atomic_read_lock);
2958 mutex_init(&tty->atomic_write_lock);
a88a69c9
JP
2959 mutex_init(&tty->output_lock);
2960 mutex_init(&tty->echo_lock);
1da177e4 2961 spin_lock_init(&tty->read_lock);
04f378b1 2962 spin_lock_init(&tty->ctrl_lock);
1da177e4 2963 INIT_LIST_HEAD(&tty->tty_files);
7f1f86a0 2964 INIT_WORK(&tty->SAK_work, do_SAK_work);
bf970ee4
AC
2965
2966 tty->driver = driver;
2967 tty->ops = driver->ops;
2968 tty->index = idx;
2969 tty_line_name(driver, idx, tty->name);
30004ac9 2970 tty->dev = tty_get_device(tty);
1da177e4
LT
2971}
2972
6716671d
JS
2973/**
2974 * deinitialize_tty_struct
2975 * @tty: tty to deinitialize
2976 *
2977 * This subroutine deinitializes a tty structure that has been newly
2978 * allocated but tty_release cannot be called on that yet.
2979 *
2980 * Locking: none - tty in question must not be exposed at this point
2981 */
2982void deinitialize_tty_struct(struct tty_struct *tty)
2983{
2984 tty_ldisc_deinit(tty);
2985}
2986
f34d7a5b
AC
2987/**
2988 * tty_put_char - write one character to a tty
2989 * @tty: tty
2990 * @ch: character
2991 *
2992 * Write one byte to the tty using the provided put_char method
2993 * if present. Returns the number of characters successfully output.
2994 *
2995 * Note: the specific put_char operation in the driver layer may go
2996 * away soon. Don't call it directly, use this method
1da177e4 2997 */
af9b897e 2998
f34d7a5b 2999int tty_put_char(struct tty_struct *tty, unsigned char ch)
1da177e4 3000{
f34d7a5b
AC
3001 if (tty->ops->put_char)
3002 return tty->ops->put_char(tty, ch);
3003 return tty->ops->write(tty, &ch, 1);
1da177e4 3004}
f34d7a5b
AC
3005EXPORT_SYMBOL_GPL(tty_put_char);
3006
d81ed103 3007struct class *tty_class;
1da177e4
LT
3008
3009/**
af9b897e
AC
3010 * tty_register_device - register a tty device
3011 * @driver: the tty driver that describes the tty device
3012 * @index: the index in the tty driver for this tty device
3013 * @device: a struct device that is associated with this tty device.
3014 * This field is optional, if there is no known struct device
3015 * for this tty device it can be set to NULL safely.
1da177e4 3016 *
01107d34
GKH
3017 * Returns a pointer to the struct device for this tty device
3018 * (or ERR_PTR(-EFOO) on error).
1cdcb6b4 3019 *
af9b897e
AC
3020 * This call is required to be made to register an individual tty device
3021 * if the tty driver's flags have the TTY_DRIVER_DYNAMIC_DEV bit set. If
3022 * that bit is not set, this function should not be called by a tty
3023 * driver.
3024 *
3025 * Locking: ??
1da177e4 3026 */
af9b897e 3027
01107d34
GKH
3028struct device *tty_register_device(struct tty_driver *driver, unsigned index,
3029 struct device *device)
1da177e4
LT
3030{
3031 char name[64];
3032 dev_t dev = MKDEV(driver->major, driver->minor_start) + index;
3033
3034 if (index >= driver->num) {
3035 printk(KERN_ERR "Attempt to register invalid tty line number "
3036 " (%d).\n", index);
1cdcb6b4 3037 return ERR_PTR(-EINVAL);
1da177e4
LT
3038 }
3039
1da177e4
LT
3040 if (driver->type == TTY_DRIVER_TYPE_PTY)
3041 pty_line_name(driver, index, name);
3042 else
3043 tty_line_name(driver, index, name);
1cdcb6b4 3044
03457cd4 3045 return device_create(tty_class, device, dev, NULL, name);
1da177e4 3046}
7d7b93c1 3047EXPORT_SYMBOL(tty_register_device);
1da177e4
LT
3048
3049/**
af9b897e
AC
3050 * tty_unregister_device - unregister a tty device
3051 * @driver: the tty driver that describes the tty device
3052 * @index: the index in the tty driver for this tty device
1da177e4 3053 *
af9b897e
AC
3054 * If a tty device is registered with a call to tty_register_device() then
3055 * this function must be called when the tty device is gone.
3056 *
3057 * Locking: ??
1da177e4 3058 */
af9b897e 3059
1da177e4
LT
3060void tty_unregister_device(struct tty_driver *driver, unsigned index)
3061{
37bdfb07
AC
3062 device_destroy(tty_class,
3063 MKDEV(driver->major, driver->minor_start) + index);
1da177e4 3064}
1da177e4
LT
3065EXPORT_SYMBOL(tty_unregister_device);
3066
7f0bc6a6
JS
3067/**
3068 * __tty_alloc_driver -- allocate tty driver
3069 * @lines: count of lines this driver can handle at most
3070 * @owner: module which is repsonsible for this driver
3071 * @flags: some of TTY_DRIVER_* flags, will be set in driver->flags
3072 *
3073 * This should not be called directly, some of the provided macros should be
3074 * used instead. Use IS_ERR and friends on @retval.
3075 */
3076struct tty_driver *__tty_alloc_driver(unsigned int lines, struct module *owner,
3077 unsigned long flags)
1da177e4
LT
3078{
3079 struct tty_driver *driver;
16a02081 3080 int err;
1da177e4 3081
0019b408 3082 if (!lines || (flags & TTY_DRIVER_UNNUMBERED_NODE && lines > 1))
7f0bc6a6
JS
3083 return ERR_PTR(-EINVAL);
3084
506eb99a 3085 driver = kzalloc(sizeof(struct tty_driver), GFP_KERNEL);
7f0bc6a6
JS
3086 if (!driver)
3087 return ERR_PTR(-ENOMEM);
3088
3089 kref_init(&driver->kref);
3090 driver->magic = TTY_DRIVER_MAGIC;
3091 driver->num = lines;
3092 driver->owner = owner;
3093 driver->flags = flags;
16a02081
JS
3094
3095 if (!(flags & TTY_DRIVER_DEVPTS_MEM)) {
3096 driver->ttys = kcalloc(lines, sizeof(*driver->ttys),
3097 GFP_KERNEL);
3098 driver->termios = kcalloc(lines, sizeof(*driver->termios),
3099 GFP_KERNEL);
3100 if (!driver->ttys || !driver->termios) {
3101 err = -ENOMEM;
3102 goto err_free_all;
3103 }
3104 }
3105
3106 if (!(flags & TTY_DRIVER_DYNAMIC_ALLOC)) {
3107 driver->ports = kcalloc(lines, sizeof(*driver->ports),
3108 GFP_KERNEL);
3109 if (!driver->ports) {
3110 err = -ENOMEM;
3111 goto err_free_all;
3112 }
3113 }
7f0bc6a6 3114
1da177e4 3115 return driver;
16a02081
JS
3116err_free_all:
3117 kfree(driver->ports);
3118 kfree(driver->ttys);
3119 kfree(driver->termios);
3120 kfree(driver);
3121 return ERR_PTR(err);
1da177e4 3122}
7f0bc6a6 3123EXPORT_SYMBOL(__tty_alloc_driver);
1da177e4 3124
7d7b93c1 3125static void destruct_tty_driver(struct kref *kref)
1da177e4 3126{
7d7b93c1
AC
3127 struct tty_driver *driver = container_of(kref, struct tty_driver, kref);
3128 int i;
3129 struct ktermios *tp;
7d7b93c1
AC
3130
3131 if (driver->flags & TTY_DRIVER_INSTALLED) {
3132 /*
3133 * Free the termios and termios_locked structures because
3134 * we don't want to get memory leaks when modular tty
3135 * drivers are removed from the kernel.
3136 */
3137 for (i = 0; i < driver->num; i++) {
3138 tp = driver->termios[i];
3139 if (tp) {
3140 driver->termios[i] = NULL;
3141 kfree(tp);
3142 }
7d7b93c1
AC
3143 if (!(driver->flags & TTY_DRIVER_DYNAMIC_DEV))
3144 tty_unregister_device(driver, i);
3145 }
7d7b93c1 3146 proc_tty_unregister_driver(driver);
7d7b93c1
AC
3147 cdev_del(&driver->cdev);
3148 }
04831dc1 3149 kfree(driver->ports);
16a02081
JS
3150 kfree(driver->termios);
3151 kfree(driver->ttys);
1da177e4
LT
3152 kfree(driver);
3153}
3154
7d7b93c1
AC
3155void tty_driver_kref_put(struct tty_driver *driver)
3156{
3157 kref_put(&driver->kref, destruct_tty_driver);
3158}
3159EXPORT_SYMBOL(tty_driver_kref_put);
3160
b68e31d0
JD
3161void tty_set_operations(struct tty_driver *driver,
3162 const struct tty_operations *op)
1da177e4 3163{
f34d7a5b
AC
3164 driver->ops = op;
3165};
7d7b93c1 3166EXPORT_SYMBOL(tty_set_operations);
1da177e4 3167
7d7b93c1
AC
3168void put_tty_driver(struct tty_driver *d)
3169{
3170 tty_driver_kref_put(d);
3171}
1da177e4 3172EXPORT_SYMBOL(put_tty_driver);
1da177e4
LT
3173
3174/*
3175 * Called by a tty driver to register itself.
3176 */
3177int tty_register_driver(struct tty_driver *driver)
3178{
3179 int error;
37bdfb07 3180 int i;
1da177e4 3181 dev_t dev;
b670bde0 3182 struct device *d;
1da177e4 3183
1da177e4 3184 if (!driver->major) {
37bdfb07
AC
3185 error = alloc_chrdev_region(&dev, driver->minor_start,
3186 driver->num, driver->name);
1da177e4
LT
3187 if (!error) {
3188 driver->major = MAJOR(dev);
3189 driver->minor_start = MINOR(dev);
3190 }
3191 } else {
3192 dev = MKDEV(driver->major, driver->minor_start);
e5717c48 3193 error = register_chrdev_region(dev, driver->num, driver->name);
1da177e4 3194 }
9bb8a3d4 3195 if (error < 0)
16a02081 3196 goto err;
1da177e4
LT
3197
3198 cdev_init(&driver->cdev, &tty_fops);
3199 driver->cdev.owner = driver->owner;
3200 error = cdev_add(&driver->cdev, dev, driver->num);
9bb8a3d4
JS
3201 if (error)
3202 goto err_unreg_char;
1da177e4 3203
ca509f69 3204 mutex_lock(&tty_mutex);
1da177e4 3205 list_add(&driver->tty_drivers, &tty_drivers);
ca509f69 3206 mutex_unlock(&tty_mutex);
37bdfb07
AC
3207
3208 if (!(driver->flags & TTY_DRIVER_DYNAMIC_DEV)) {
b670bde0
VK
3209 for (i = 0; i < driver->num; i++) {
3210 d = tty_register_device(driver, i, NULL);
3211 if (IS_ERR(d)) {
3212 error = PTR_ERR(d);
16a02081 3213 goto err_unreg_devs;
b670bde0
VK
3214 }
3215 }
1da177e4
LT
3216 }
3217 proc_tty_register_driver(driver);
7d7b93c1 3218 driver->flags |= TTY_DRIVER_INSTALLED;
1da177e4 3219 return 0;
b670bde0 3220
16a02081 3221err_unreg_devs:
b670bde0
VK
3222 for (i--; i >= 0; i--)
3223 tty_unregister_device(driver, i);
3224
3225 mutex_lock(&tty_mutex);
3226 list_del(&driver->tty_drivers);
3227 mutex_unlock(&tty_mutex);
3228
9bb8a3d4 3229err_unreg_char:
b670bde0 3230 unregister_chrdev_region(dev, driver->num);
16a02081 3231err:
b670bde0 3232 return error;
1da177e4 3233}
1da177e4
LT
3234EXPORT_SYMBOL(tty_register_driver);
3235
3236/*
3237 * Called by a tty driver to unregister itself.
3238 */
3239int tty_unregister_driver(struct tty_driver *driver)
3240{
7d7b93c1
AC
3241#if 0
3242 /* FIXME */
1da177e4
LT
3243 if (driver->refcount)
3244 return -EBUSY;
7d7b93c1 3245#endif
1da177e4
LT
3246 unregister_chrdev_region(MKDEV(driver->major, driver->minor_start),
3247 driver->num);
ca509f69 3248 mutex_lock(&tty_mutex);
1da177e4 3249 list_del(&driver->tty_drivers);
ca509f69 3250 mutex_unlock(&tty_mutex);
1da177e4
LT
3251 return 0;
3252}
7d7b93c1 3253
1da177e4
LT
3254EXPORT_SYMBOL(tty_unregister_driver);
3255
24ec839c
PZ
3256dev_t tty_devnum(struct tty_struct *tty)
3257{
3258 return MKDEV(tty->driver->major, tty->driver->minor_start) + tty->index;
3259}
3260EXPORT_SYMBOL(tty_devnum);
3261
3262void proc_clear_tty(struct task_struct *p)
3263{
7c3b1dcf 3264 unsigned long flags;
9c9f4ded 3265 struct tty_struct *tty;
7c3b1dcf 3266 spin_lock_irqsave(&p->sighand->siglock, flags);
9c9f4ded 3267 tty = p->signal->tty;
24ec839c 3268 p->signal->tty = NULL;
7c3b1dcf 3269 spin_unlock_irqrestore(&p->sighand->siglock, flags);
9c9f4ded 3270 tty_kref_put(tty);
24ec839c 3271}
24ec839c 3272
47f86834
AC
3273/* Called under the sighand lock */
3274
2a65f1d9 3275static void __proc_set_tty(struct task_struct *tsk, struct tty_struct *tty)
24ec839c
PZ
3276{
3277 if (tty) {
47f86834
AC
3278 unsigned long flags;
3279 /* We should not have a session or pgrp to put here but.... */
3280 spin_lock_irqsave(&tty->ctrl_lock, flags);
d9c1e9a8
EB
3281 put_pid(tty->session);
3282 put_pid(tty->pgrp);
ab521dc0 3283 tty->pgrp = get_pid(task_pgrp(tsk));
47f86834
AC
3284 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
3285 tty->session = get_pid(task_session(tsk));
9c9f4ded
AC
3286 if (tsk->signal->tty) {
3287 printk(KERN_DEBUG "tty not NULL!!\n");
3288 tty_kref_put(tsk->signal->tty);
3289 }
24ec839c 3290 }
2a65f1d9 3291 put_pid(tsk->signal->tty_old_pgrp);
9c9f4ded 3292 tsk->signal->tty = tty_kref_get(tty);
ab521dc0 3293 tsk->signal->tty_old_pgrp = NULL;
24ec839c
PZ
3294}
3295
98a27ba4 3296static void proc_set_tty(struct task_struct *tsk, struct tty_struct *tty)
24ec839c
PZ
3297{
3298 spin_lock_irq(&tsk->sighand->siglock);
2a65f1d9 3299 __proc_set_tty(tsk, tty);
24ec839c
PZ
3300 spin_unlock_irq(&tsk->sighand->siglock);
3301}
3302
3303struct tty_struct *get_current_tty(void)
3304{
3305 struct tty_struct *tty;
934e6ebf
AC
3306 unsigned long flags;
3307
3308 spin_lock_irqsave(&current->sighand->siglock, flags);
452a00d2 3309 tty = tty_kref_get(current->signal->tty);
934e6ebf 3310 spin_unlock_irqrestore(&current->sighand->siglock, flags);
24ec839c
PZ
3311 return tty;
3312}
a311f743 3313EXPORT_SYMBOL_GPL(get_current_tty);
1da177e4 3314
d81ed103
AC
3315void tty_default_fops(struct file_operations *fops)
3316{
3317 *fops = tty_fops;
3318}
3319
1da177e4
LT
3320/*
3321 * Initialize the console device. This is called *early*, so
3322 * we can't necessarily depend on lots of kernel help here.
3323 * Just do some early initializations, and do the complex setup
3324 * later.
3325 */
3326void __init console_init(void)
3327{
3328 initcall_t *call;
3329
3330 /* Setup the default TTY line discipline. */
01e1abb2 3331 tty_ldisc_begin();
1da177e4
LT
3332
3333 /*
37bdfb07 3334 * set up the console device so that later boot sequences can
1da177e4
LT
3335 * inform about problems etc..
3336 */
1da177e4
LT
3337 call = __con_initcall_start;
3338 while (call < __con_initcall_end) {
3339 (*call)();
3340 call++;
3341 }
3342}
3343
2c9ede55 3344static char *tty_devnode(struct device *dev, umode_t *mode)
e454cea2
KS
3345{
3346 if (!mode)
3347 return NULL;
3348 if (dev->devt == MKDEV(TTYAUX_MAJOR, 0) ||
3349 dev->devt == MKDEV(TTYAUX_MAJOR, 2))
3350 *mode = 0666;
3351 return NULL;
3352}
3353
1da177e4
LT
3354static int __init tty_class_init(void)
3355{
7fe845d1 3356 tty_class = class_create(THIS_MODULE, "tty");
1da177e4
LT
3357 if (IS_ERR(tty_class))
3358 return PTR_ERR(tty_class);
e454cea2 3359 tty_class->devnode = tty_devnode;
1da177e4
LT
3360 return 0;
3361}
3362
3363postcore_initcall(tty_class_init);
3364
3365/* 3/2004 jmc: why do these devices exist? */
1da177e4 3366static struct cdev tty_cdev, console_cdev;
1da177e4 3367
fbc92a34
KS
3368static ssize_t show_cons_active(struct device *dev,
3369 struct device_attribute *attr, char *buf)
3370{
3371 struct console *cs[16];
3372 int i = 0;
3373 struct console *c;
3374 ssize_t count = 0;
3375
ac751efa 3376 console_lock();
a2a6a822 3377 for_each_console(c) {
fbc92a34
KS
3378 if (!c->device)
3379 continue;
3380 if (!c->write)
3381 continue;
3382 if ((c->flags & CON_ENABLED) == 0)
3383 continue;
3384 cs[i++] = c;
3385 if (i >= ARRAY_SIZE(cs))
3386 break;
3387 }
3388 while (i--)
3389 count += sprintf(buf + count, "%s%d%c",
3390 cs[i]->name, cs[i]->index, i ? ' ':'\n');
ac751efa 3391 console_unlock();
fbc92a34
KS
3392
3393 return count;
3394}
3395static DEVICE_ATTR(active, S_IRUGO, show_cons_active, NULL);
3396
3397static struct device *consdev;
3398
3399void console_sysfs_notify(void)
3400{
3401 if (consdev)
3402 sysfs_notify(&consdev->kobj, NULL, "active");
3403}
3404
1da177e4
LT
3405/*
3406 * Ok, now we can initialize the rest of the tty devices and can count
3407 * on memory allocations, interrupts etc..
3408 */
31d1d48e 3409int __init tty_init(void)
1da177e4
LT
3410{
3411 cdev_init(&tty_cdev, &tty_fops);
3412 if (cdev_add(&tty_cdev, MKDEV(TTYAUX_MAJOR, 0), 1) ||
3413 register_chrdev_region(MKDEV(TTYAUX_MAJOR, 0), 1, "/dev/tty") < 0)
3414 panic("Couldn't register /dev/tty driver\n");
fbc92a34 3415 device_create(tty_class, NULL, MKDEV(TTYAUX_MAJOR, 0), NULL, "tty");
1da177e4
LT
3416
3417 cdev_init(&console_cdev, &console_fops);
3418 if (cdev_add(&console_cdev, MKDEV(TTYAUX_MAJOR, 1), 1) ||
3419 register_chrdev_region(MKDEV(TTYAUX_MAJOR, 1), 1, "/dev/console") < 0)
3420 panic("Couldn't register /dev/console driver\n");
fbc92a34 3421 consdev = device_create(tty_class, NULL, MKDEV(TTYAUX_MAJOR, 1), NULL,
47aa5793 3422 "console");
fbc92a34
KS
3423 if (IS_ERR(consdev))
3424 consdev = NULL;
3425 else
a2a6a822 3426 WARN_ON(device_create_file(consdev, &dev_attr_active) < 0);
1da177e4 3427
1da177e4 3428#ifdef CONFIG_VT
d81ed103 3429 vty_init(&console_fops);
1da177e4
LT
3430#endif
3431 return 0;
3432}
31d1d48e 3433