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