2 * Copyright (C) 1991, 1992 Linus Torvalds
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.
9 * Kill-line thanks to John T Kohl, who also corrected VMIN = VTIME = 0.
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.
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
20 * makes for cleaner and more compact code. -TYT, 9/17/92
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).
26 * NOTE: pay no attention to the line discipline code (yet); its
27 * interface is still subject to change in this version...
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.
34 * Rewrote canonical mode and added more termios flags.
35 * -- julian@uhunix.uhcc.hawaii.edu (J. Cowley), 13Jan94
37 * Reorganized FASYNC support so mouse code can share it.
38 * -- ctm@ardi.com, 9Sep95
40 * New TIOCLINUX variants added.
41 * -- mj@k332.feld.cvut.cz, 19-Nov-95
43 * Restrict vt switching via ioctl()
44 * -- grif@cs.ucr.edu, 5-Dec-95
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
50 * Rewrote tty_init_dev and tty_release_dev to eliminate races.
51 * -- Bill Hawes <whawes@star.net>, June 97
53 * Added devfs support.
54 * -- C. Scott Ananian <cananian@alumni.princeton.edu>, 13-Jan-1998
56 * Added support for a Unix98-style ptmx device.
57 * -- C. Scott Ananian <cananian@alumni.princeton.edu>, 14-Jan-1998
59 * Reduced memory usage for older ARM systems
60 * -- Russell King <rmk@arm.linux.org.uk>
62 * Move do_SAK() into process context. Less stack use in devfs functions.
63 * alloc_tty_struct() always uses kmalloc()
64 * -- Andrew Morton <andrewm@uow.edu.eu> 17Mar01
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>
79 #include <linux/fdtable.h>
80 #include <linux/console.h>
81 #include <linux/timer.h>
82 #include <linux/ctype.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>
91 #include <linux/device.h>
92 #include <linux/wait.h>
93 #include <linux/bitops.h>
94 #include <linux/delay.h>
95 #include <linux/seq_file.h>
96 #include <linux/serial.h>
97 #include <linux/ratelimit.h>
99 #include <linux/uaccess.h>
101 #include <linux/kbd_kern.h>
102 #include <linux/vt_kern.h>
103 #include <linux/selection.h>
105 #include <linux/kmod.h>
106 #include <linux/nsproxy.h>
108 #undef TTY_DEBUG_HANGUP
109 #ifdef TTY_DEBUG_HANGUP
110 # define tty_debug_hangup(tty, f, args...) tty_debug(tty, f, ##args)
112 # define tty_debug_hangup(tty, f, args...) do { } while (0)
115 #define TTY_PARANOIA_CHECK 1
116 #define CHECK_TTY_COUNT 1
118 struct ktermios tty_std_termios = { /* for the benefit of tty drivers */
119 .c_iflag = ICRNL | IXON,
120 .c_oflag = OPOST | ONLCR,
121 .c_cflag = B38400 | CS8 | CREAD | HUPCL,
122 .c_lflag = ISIG | ICANON | ECHO | ECHOE | ECHOK |
123 ECHOCTL | ECHOKE | IEXTEN,
129 EXPORT_SYMBOL(tty_std_termios);
131 /* This list gets poked at by procfs and various bits of boot up code. This
132 could do with some rationalisation such as pulling the tty proc function
135 LIST_HEAD(tty_drivers); /* linked list of tty drivers */
137 /* Mutex to protect creating and releasing a tty. This is shared with
138 vt.c for deeply disgusting hack reasons */
139 DEFINE_MUTEX(tty_mutex);
140 EXPORT_SYMBOL(tty_mutex);
142 /* Spinlock to protect the tty->tty_files list */
143 DEFINE_SPINLOCK(tty_files_lock);
145 static ssize_t tty_read(struct file *, char __user *, size_t, loff_t *);
146 static ssize_t tty_write(struct file *, const char __user *, size_t, loff_t *);
147 ssize_t redirected_tty_write(struct file *, const char __user *,
149 static unsigned int tty_poll(struct file *, poll_table *);
150 static int tty_open(struct inode *, struct file *);
151 long tty_ioctl(struct file *file, unsigned int cmd, unsigned long arg);
153 static long tty_compat_ioctl(struct file *file, unsigned int cmd,
156 #define tty_compat_ioctl NULL
158 static int __tty_fasync(int fd, struct file *filp, int on);
159 static int tty_fasync(int fd, struct file *filp, int on);
160 static void release_tty(struct tty_struct *tty, int idx);
163 * free_tty_struct - free a disused tty
164 * @tty: tty struct to free
166 * Free the write buffers, tty queue and tty memory itself.
168 * Locking: none. Must be called after tty is definitely unused
171 void free_tty_struct(struct tty_struct *tty)
175 put_device(tty->dev);
176 kfree(tty->write_buf);
177 tty->magic = 0xDEADDEAD;
181 static inline struct tty_struct *file_tty(struct file *file)
183 return ((struct tty_file_private *)file->private_data)->tty;
186 int tty_alloc_file(struct file *file)
188 struct tty_file_private *priv;
190 priv = kmalloc(sizeof(*priv), GFP_KERNEL);
194 file->private_data = priv;
199 /* Associate a new file with the tty structure */
200 void tty_add_file(struct tty_struct *tty, struct file *file)
202 struct tty_file_private *priv = file->private_data;
207 spin_lock(&tty_files_lock);
208 list_add(&priv->list, &tty->tty_files);
209 spin_unlock(&tty_files_lock);
213 * tty_free_file - free file->private_data
215 * This shall be used only for fail path handling when tty_add_file was not
218 void tty_free_file(struct file *file)
220 struct tty_file_private *priv = file->private_data;
222 file->private_data = NULL;
226 /* Delete file from its tty */
227 static void tty_del_file(struct file *file)
229 struct tty_file_private *priv = file->private_data;
231 spin_lock(&tty_files_lock);
232 list_del(&priv->list);
233 spin_unlock(&tty_files_lock);
238 #define TTY_NUMBER(tty) ((tty)->index + (tty)->driver->name_base)
241 * tty_name - return tty naming
242 * @tty: tty structure
244 * Convert a tty structure into a name. The name reflects the kernel
245 * naming policy and if udev is in use may not reflect user space
250 const char *tty_name(const struct tty_struct *tty)
252 if (!tty) /* Hmm. NULL pointer. That's fun. */
257 EXPORT_SYMBOL(tty_name);
259 int tty_paranoia_check(struct tty_struct *tty, struct inode *inode,
262 #ifdef TTY_PARANOIA_CHECK
265 "null TTY for (%d:%d) in %s\n",
266 imajor(inode), iminor(inode), routine);
269 if (tty->magic != TTY_MAGIC) {
271 "bad magic number for tty struct (%d:%d) in %s\n",
272 imajor(inode), iminor(inode), routine);
279 /* Caller must hold tty_lock */
280 static int check_tty_count(struct tty_struct *tty, const char *routine)
282 #ifdef CHECK_TTY_COUNT
286 spin_lock(&tty_files_lock);
287 list_for_each(p, &tty->tty_files) {
290 spin_unlock(&tty_files_lock);
291 if (tty->driver->type == TTY_DRIVER_TYPE_PTY &&
292 tty->driver->subtype == PTY_TYPE_SLAVE &&
293 tty->link && tty->link->count)
295 if (tty->count != count) {
296 printk(KERN_WARNING "Warning: dev (%s) tty->count(%d) "
297 "!= #fd's(%d) in %s\n",
298 tty->name, tty->count, count, routine);
306 * get_tty_driver - find device of a tty
307 * @dev_t: device identifier
308 * @index: returns the index of the tty
310 * This routine returns a tty driver structure, given a device number
311 * and also passes back the index number.
313 * Locking: caller must hold tty_mutex
316 static struct tty_driver *get_tty_driver(dev_t device, int *index)
318 struct tty_driver *p;
320 list_for_each_entry(p, &tty_drivers, tty_drivers) {
321 dev_t base = MKDEV(p->major, p->minor_start);
322 if (device < base || device >= base + p->num)
324 *index = device - base;
325 return tty_driver_kref_get(p);
330 #ifdef CONFIG_CONSOLE_POLL
333 * tty_find_polling_driver - find device of a polled tty
334 * @name: name string to match
335 * @line: pointer to resulting tty line nr
337 * This routine returns a tty driver structure, given a name
338 * and the condition that the tty driver is capable of polled
341 struct tty_driver *tty_find_polling_driver(char *name, int *line)
343 struct tty_driver *p, *res = NULL;
348 for (str = name; *str; str++)
349 if ((*str >= '0' && *str <= '9') || *str == ',')
355 tty_line = simple_strtoul(str, &str, 10);
357 mutex_lock(&tty_mutex);
358 /* Search through the tty devices to look for a match */
359 list_for_each_entry(p, &tty_drivers, tty_drivers) {
360 if (strncmp(name, p->name, len) != 0)
368 if (tty_line >= 0 && tty_line < p->num && p->ops &&
369 p->ops->poll_init && !p->ops->poll_init(p, tty_line, stp)) {
370 res = tty_driver_kref_get(p);
375 mutex_unlock(&tty_mutex);
379 EXPORT_SYMBOL_GPL(tty_find_polling_driver);
383 * tty_check_change - check for POSIX terminal changes
386 * If we try to write to, or set the state of, a terminal and we're
387 * not in the foreground, send a SIGTTOU. If the signal is blocked or
388 * ignored, go ahead and perform the operation. (POSIX 7.2)
393 int __tty_check_change(struct tty_struct *tty, int sig)
396 struct pid *pgrp, *tty_pgrp;
399 if (current->signal->tty != tty)
403 pgrp = task_pgrp(current);
405 spin_lock_irqsave(&tty->ctrl_lock, flags);
406 tty_pgrp = tty->pgrp;
407 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
409 if (tty_pgrp && pgrp != tty->pgrp) {
410 if (is_ignored(sig)) {
413 } else if (is_current_pgrp_orphaned())
416 kill_pgrp(pgrp, sig, 1);
417 set_thread_flag(TIF_SIGPENDING);
424 pr_warn("%s: tty_check_change: sig=%d, tty->pgrp == NULL!\n",
431 int tty_check_change(struct tty_struct *tty)
433 return __tty_check_change(tty, SIGTTOU);
435 EXPORT_SYMBOL(tty_check_change);
437 static ssize_t hung_up_tty_read(struct file *file, char __user *buf,
438 size_t count, loff_t *ppos)
443 static ssize_t hung_up_tty_write(struct file *file, const char __user *buf,
444 size_t count, loff_t *ppos)
449 /* No kernel lock held - none needed ;) */
450 static unsigned int hung_up_tty_poll(struct file *filp, poll_table *wait)
452 return POLLIN | POLLOUT | POLLERR | POLLHUP | POLLRDNORM | POLLWRNORM;
455 static long hung_up_tty_ioctl(struct file *file, unsigned int cmd,
458 return cmd == TIOCSPGRP ? -ENOTTY : -EIO;
461 static long hung_up_tty_compat_ioctl(struct file *file,
462 unsigned int cmd, unsigned long arg)
464 return cmd == TIOCSPGRP ? -ENOTTY : -EIO;
467 static const struct file_operations tty_fops = {
472 .unlocked_ioctl = tty_ioctl,
473 .compat_ioctl = tty_compat_ioctl,
475 .release = tty_release,
476 .fasync = tty_fasync,
479 static const struct file_operations console_fops = {
482 .write = redirected_tty_write,
484 .unlocked_ioctl = tty_ioctl,
485 .compat_ioctl = tty_compat_ioctl,
487 .release = tty_release,
488 .fasync = tty_fasync,
491 static const struct file_operations hung_up_tty_fops = {
493 .read = hung_up_tty_read,
494 .write = hung_up_tty_write,
495 .poll = hung_up_tty_poll,
496 .unlocked_ioctl = hung_up_tty_ioctl,
497 .compat_ioctl = hung_up_tty_compat_ioctl,
498 .release = tty_release,
501 static DEFINE_SPINLOCK(redirect_lock);
502 static struct file *redirect;
505 void proc_clear_tty(struct task_struct *p)
508 struct tty_struct *tty;
509 spin_lock_irqsave(&p->sighand->siglock, flags);
510 tty = p->signal->tty;
511 p->signal->tty = NULL;
512 spin_unlock_irqrestore(&p->sighand->siglock, flags);
517 * proc_set_tty - set the controlling terminal
519 * Only callable by the session leader and only if it does not already have
520 * a controlling terminal.
522 * Caller must hold: tty_lock()
523 * a readlock on tasklist_lock
526 static void __proc_set_tty(struct tty_struct *tty)
530 spin_lock_irqsave(&tty->ctrl_lock, flags);
532 * The session and fg pgrp references will be non-NULL if
533 * tiocsctty() is stealing the controlling tty
535 put_pid(tty->session);
537 tty->pgrp = get_pid(task_pgrp(current));
538 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
539 tty->session = get_pid(task_session(current));
540 if (current->signal->tty) {
541 tty_debug(tty, "current tty %s not NULL!!\n",
542 current->signal->tty->name);
543 tty_kref_put(current->signal->tty);
545 put_pid(current->signal->tty_old_pgrp);
546 current->signal->tty = tty_kref_get(tty);
547 current->signal->tty_old_pgrp = NULL;
550 static void proc_set_tty(struct tty_struct *tty)
552 spin_lock_irq(¤t->sighand->siglock);
554 spin_unlock_irq(¤t->sighand->siglock);
557 struct tty_struct *get_current_tty(void)
559 struct tty_struct *tty;
562 spin_lock_irqsave(¤t->sighand->siglock, flags);
563 tty = tty_kref_get(current->signal->tty);
564 spin_unlock_irqrestore(¤t->sighand->siglock, flags);
567 EXPORT_SYMBOL_GPL(get_current_tty);
569 static void session_clear_tty(struct pid *session)
571 struct task_struct *p;
572 do_each_pid_task(session, PIDTYPE_SID, p) {
574 } while_each_pid_task(session, PIDTYPE_SID, p);
578 * tty_wakeup - request more data
581 * Internal and external helper for wakeups of tty. This function
582 * informs the line discipline if present that the driver is ready
583 * to receive more output data.
586 void tty_wakeup(struct tty_struct *tty)
588 struct tty_ldisc *ld;
590 if (test_bit(TTY_DO_WRITE_WAKEUP, &tty->flags)) {
591 ld = tty_ldisc_ref(tty);
593 if (ld->ops->write_wakeup)
594 ld->ops->write_wakeup(tty);
598 wake_up_interruptible_poll(&tty->write_wait, POLLOUT);
601 EXPORT_SYMBOL_GPL(tty_wakeup);
604 * tty_signal_session_leader - sends SIGHUP to session leader
605 * @tty controlling tty
606 * @exit_session if non-zero, signal all foreground group processes
608 * Send SIGHUP and SIGCONT to the session leader and its process group.
609 * Optionally, signal all processes in the foreground process group.
611 * Returns the number of processes in the session with this tty
612 * as their controlling terminal. This value is used to drop
613 * tty references for those processes.
615 static int tty_signal_session_leader(struct tty_struct *tty, int exit_session)
617 struct task_struct *p;
619 struct pid *tty_pgrp = NULL;
621 read_lock(&tasklist_lock);
623 do_each_pid_task(tty->session, PIDTYPE_SID, p) {
624 spin_lock_irq(&p->sighand->siglock);
625 if (p->signal->tty == tty) {
626 p->signal->tty = NULL;
627 /* We defer the dereferences outside fo
631 if (!p->signal->leader) {
632 spin_unlock_irq(&p->sighand->siglock);
635 __group_send_sig_info(SIGHUP, SEND_SIG_PRIV, p);
636 __group_send_sig_info(SIGCONT, SEND_SIG_PRIV, p);
637 put_pid(p->signal->tty_old_pgrp); /* A noop */
638 spin_lock(&tty->ctrl_lock);
639 tty_pgrp = get_pid(tty->pgrp);
641 p->signal->tty_old_pgrp = get_pid(tty->pgrp);
642 spin_unlock(&tty->ctrl_lock);
643 spin_unlock_irq(&p->sighand->siglock);
644 } while_each_pid_task(tty->session, PIDTYPE_SID, p);
646 read_unlock(&tasklist_lock);
650 kill_pgrp(tty_pgrp, SIGHUP, exit_session);
658 * __tty_hangup - actual handler for hangup events
661 * This can be called by a "kworker" kernel thread. That is process
662 * synchronous but doesn't hold any locks, so we need to make sure we
663 * have the appropriate locks for what we're doing.
665 * The hangup event clears any pending redirections onto the hung up
666 * device. It ensures future writes will error and it does the needed
667 * line discipline hangup and signal delivery. The tty object itself
672 * redirect lock for undoing redirection
673 * file list lock for manipulating list of ttys
674 * tty_ldiscs_lock from called functions
675 * termios_rwsem resetting termios data
676 * tasklist_lock to walk task list for hangup event
677 * ->siglock to protect ->signal/->sighand
679 static void __tty_hangup(struct tty_struct *tty, int exit_session)
681 struct file *cons_filp = NULL;
682 struct file *filp, *f = NULL;
683 struct tty_file_private *priv;
684 int closecount = 0, n;
691 spin_lock(&redirect_lock);
692 if (redirect && file_tty(redirect) == tty) {
696 spin_unlock(&redirect_lock);
700 if (test_bit(TTY_HUPPED, &tty->flags)) {
705 /* inuse_filps is protected by the single tty lock,
706 this really needs to change if we want to flush the
707 workqueue with the lock held */
708 check_tty_count(tty, "tty_hangup");
710 spin_lock(&tty_files_lock);
711 /* This breaks for file handles being sent over AF_UNIX sockets ? */
712 list_for_each_entry(priv, &tty->tty_files, list) {
714 if (filp->f_op->write == redirected_tty_write)
716 if (filp->f_op->write != tty_write)
719 __tty_fasync(-1, filp, 0); /* can't block */
720 filp->f_op = &hung_up_tty_fops;
722 spin_unlock(&tty_files_lock);
724 refs = tty_signal_session_leader(tty, exit_session);
725 /* Account for the p->signal references we killed */
729 tty_ldisc_hangup(tty);
731 spin_lock_irq(&tty->ctrl_lock);
732 clear_bit(TTY_THROTTLED, &tty->flags);
733 clear_bit(TTY_DO_WRITE_WAKEUP, &tty->flags);
734 put_pid(tty->session);
738 tty->ctrl_status = 0;
739 spin_unlock_irq(&tty->ctrl_lock);
742 * If one of the devices matches a console pointer, we
743 * cannot just call hangup() because that will cause
744 * tty->count and state->count to go out of sync.
745 * So we just call close() the right number of times.
749 for (n = 0; n < closecount; n++)
750 tty->ops->close(tty, cons_filp);
751 } else if (tty->ops->hangup)
752 tty->ops->hangup(tty);
754 * We don't want to have driver/ldisc interactions beyond
755 * the ones we did here. The driver layer expects no
756 * calls after ->hangup() from the ldisc side. However we
757 * can't yet guarantee all that.
759 set_bit(TTY_HUPPED, &tty->flags);
766 static void do_tty_hangup(struct work_struct *work)
768 struct tty_struct *tty =
769 container_of(work, struct tty_struct, hangup_work);
771 __tty_hangup(tty, 0);
775 * tty_hangup - trigger a hangup event
776 * @tty: tty to hangup
778 * A carrier loss (virtual or otherwise) has occurred on this like
779 * schedule a hangup sequence to run after this event.
782 void tty_hangup(struct tty_struct *tty)
784 tty_debug_hangup(tty, "\n");
785 schedule_work(&tty->hangup_work);
788 EXPORT_SYMBOL(tty_hangup);
791 * tty_vhangup - process vhangup
792 * @tty: tty to hangup
794 * The user has asked via system call for the terminal to be hung up.
795 * We do this synchronously so that when the syscall returns the process
796 * is complete. That guarantee is necessary for security reasons.
799 void tty_vhangup(struct tty_struct *tty)
801 tty_debug_hangup(tty, "\n");
802 __tty_hangup(tty, 0);
805 EXPORT_SYMBOL(tty_vhangup);
809 * tty_vhangup_self - process vhangup for own ctty
811 * Perform a vhangup on the current controlling tty
814 void tty_vhangup_self(void)
816 struct tty_struct *tty;
818 tty = get_current_tty();
826 * tty_vhangup_session - hangup session leader exit
827 * @tty: tty to hangup
829 * The session leader is exiting and hanging up its controlling terminal.
830 * Every process in the foreground process group is signalled SIGHUP.
832 * We do this synchronously so that when the syscall returns the process
833 * is complete. That guarantee is necessary for security reasons.
836 static void tty_vhangup_session(struct tty_struct *tty)
838 tty_debug_hangup(tty, "\n");
839 __tty_hangup(tty, 1);
843 * tty_hung_up_p - was tty hung up
844 * @filp: file pointer of tty
846 * Return true if the tty has been subject to a vhangup or a carrier
850 int tty_hung_up_p(struct file *filp)
852 return (filp->f_op == &hung_up_tty_fops);
855 EXPORT_SYMBOL(tty_hung_up_p);
858 * disassociate_ctty - disconnect controlling tty
859 * @on_exit: true if exiting so need to "hang up" the session
861 * This function is typically called only by the session leader, when
862 * it wants to disassociate itself from its controlling tty.
864 * It performs the following functions:
865 * (1) Sends a SIGHUP and SIGCONT to the foreground process group
866 * (2) Clears the tty from being controlling the session
867 * (3) Clears the controlling tty for all processes in the
870 * The argument on_exit is set to 1 if called when a process is
871 * exiting; it is 0 if called by the ioctl TIOCNOTTY.
874 * BTM is taken for hysterical raisins, and held when
875 * called from no_tty().
876 * tty_mutex is taken to protect tty
877 * ->siglock is taken to protect ->signal/->sighand
878 * tasklist_lock is taken to walk process list for sessions
879 * ->siglock is taken to protect ->signal/->sighand
882 void disassociate_ctty(int on_exit)
884 struct tty_struct *tty;
886 if (!current->signal->leader)
889 tty = get_current_tty();
891 if (on_exit && tty->driver->type != TTY_DRIVER_TYPE_PTY) {
892 tty_vhangup_session(tty);
894 struct pid *tty_pgrp = tty_get_pgrp(tty);
896 kill_pgrp(tty_pgrp, SIGHUP, on_exit);
898 kill_pgrp(tty_pgrp, SIGCONT, on_exit);
904 } else if (on_exit) {
905 struct pid *old_pgrp;
906 spin_lock_irq(¤t->sighand->siglock);
907 old_pgrp = current->signal->tty_old_pgrp;
908 current->signal->tty_old_pgrp = NULL;
909 spin_unlock_irq(¤t->sighand->siglock);
911 kill_pgrp(old_pgrp, SIGHUP, on_exit);
912 kill_pgrp(old_pgrp, SIGCONT, on_exit);
918 spin_lock_irq(¤t->sighand->siglock);
919 put_pid(current->signal->tty_old_pgrp);
920 current->signal->tty_old_pgrp = NULL;
922 tty = tty_kref_get(current->signal->tty);
925 spin_lock_irqsave(&tty->ctrl_lock, flags);
926 put_pid(tty->session);
930 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
933 tty_debug_hangup(tty, "no current tty\n");
935 spin_unlock_irq(¤t->sighand->siglock);
936 /* Now clear signal->tty under the lock */
937 read_lock(&tasklist_lock);
938 session_clear_tty(task_session(current));
939 read_unlock(&tasklist_lock);
944 * no_tty - Ensure the current process does not have a controlling tty
948 /* FIXME: Review locking here. The tty_lock never covered any race
949 between a new association and proc_clear_tty but possible we need
950 to protect against this anyway */
951 struct task_struct *tsk = current;
952 disassociate_ctty(0);
958 * stop_tty - propagate flow control
961 * Perform flow control to the driver. May be called
962 * on an already stopped device and will not re-call the driver
965 * This functionality is used by both the line disciplines for
966 * halting incoming flow and by the driver. It may therefore be
967 * called from any context, may be under the tty atomic_write_lock
974 void __stop_tty(struct tty_struct *tty)
983 void stop_tty(struct tty_struct *tty)
987 spin_lock_irqsave(&tty->flow_lock, flags);
989 spin_unlock_irqrestore(&tty->flow_lock, flags);
991 EXPORT_SYMBOL(stop_tty);
994 * start_tty - propagate flow control
997 * Start a tty that has been stopped if at all possible. If this
998 * tty was previous stopped and is now being started, the driver
999 * start method is invoked and the line discipline woken.
1005 void __start_tty(struct tty_struct *tty)
1007 if (!tty->stopped || tty->flow_stopped)
1010 if (tty->ops->start)
1011 tty->ops->start(tty);
1015 void start_tty(struct tty_struct *tty)
1017 unsigned long flags;
1019 spin_lock_irqsave(&tty->flow_lock, flags);
1021 spin_unlock_irqrestore(&tty->flow_lock, flags);
1023 EXPORT_SYMBOL(start_tty);
1025 static void tty_update_time(struct timespec *time)
1027 unsigned long sec = get_seconds();
1030 * We only care if the two values differ in anything other than the
1031 * lower three bits (i.e every 8 seconds). If so, then we can update
1032 * the time of the tty device, otherwise it could be construded as a
1033 * security leak to let userspace know the exact timing of the tty.
1035 if ((sec ^ time->tv_sec) & ~7)
1040 * tty_read - read method for tty device files
1041 * @file: pointer to tty file
1043 * @count: size of user buffer
1046 * Perform the read system call function on this terminal device. Checks
1047 * for hung up devices before calling the line discipline method.
1050 * Locks the line discipline internally while needed. Multiple
1051 * read calls may be outstanding in parallel.
1054 static ssize_t tty_read(struct file *file, char __user *buf, size_t count,
1058 struct inode *inode = file_inode(file);
1059 struct tty_struct *tty = file_tty(file);
1060 struct tty_ldisc *ld;
1062 if (tty_paranoia_check(tty, inode, "tty_read"))
1064 if (!tty || (test_bit(TTY_IO_ERROR, &tty->flags)))
1067 /* We want to wait for the line discipline to sort out in this
1069 ld = tty_ldisc_ref_wait(tty);
1071 i = ld->ops->read(tty, file, buf, count);
1074 tty_ldisc_deref(ld);
1077 tty_update_time(&inode->i_atime);
1082 static void tty_write_unlock(struct tty_struct *tty)
1084 mutex_unlock(&tty->atomic_write_lock);
1085 wake_up_interruptible_poll(&tty->write_wait, POLLOUT);
1088 static int tty_write_lock(struct tty_struct *tty, int ndelay)
1090 if (!mutex_trylock(&tty->atomic_write_lock)) {
1093 if (mutex_lock_interruptible(&tty->atomic_write_lock))
1094 return -ERESTARTSYS;
1100 * Split writes up in sane blocksizes to avoid
1101 * denial-of-service type attacks
1103 static inline ssize_t do_tty_write(
1104 ssize_t (*write)(struct tty_struct *, struct file *, const unsigned char *, size_t),
1105 struct tty_struct *tty,
1107 const char __user *buf,
1110 ssize_t ret, written = 0;
1113 ret = tty_write_lock(tty, file->f_flags & O_NDELAY);
1118 * We chunk up writes into a temporary buffer. This
1119 * simplifies low-level drivers immensely, since they
1120 * don't have locking issues and user mode accesses.
1122 * But if TTY_NO_WRITE_SPLIT is set, we should use a
1125 * The default chunk-size is 2kB, because the NTTY
1126 * layer has problems with bigger chunks. It will
1127 * claim to be able to handle more characters than
1130 * FIXME: This can probably go away now except that 64K chunks
1131 * are too likely to fail unless switched to vmalloc...
1134 if (test_bit(TTY_NO_WRITE_SPLIT, &tty->flags))
1139 /* write_buf/write_cnt is protected by the atomic_write_lock mutex */
1140 if (tty->write_cnt < chunk) {
1141 unsigned char *buf_chunk;
1146 buf_chunk = kmalloc(chunk, GFP_KERNEL);
1151 kfree(tty->write_buf);
1152 tty->write_cnt = chunk;
1153 tty->write_buf = buf_chunk;
1156 /* Do the write .. */
1158 size_t size = count;
1162 if (copy_from_user(tty->write_buf, buf, size))
1164 ret = write(tty, file, tty->write_buf, size);
1173 if (signal_pending(current))
1178 tty_update_time(&file_inode(file)->i_mtime);
1182 tty_write_unlock(tty);
1187 * tty_write_message - write a message to a certain tty, not just the console.
1188 * @tty: the destination tty_struct
1189 * @msg: the message to write
1191 * This is used for messages that need to be redirected to a specific tty.
1192 * We don't put it into the syslog queue right now maybe in the future if
1195 * We must still hold the BTM and test the CLOSING flag for the moment.
1198 void tty_write_message(struct tty_struct *tty, char *msg)
1201 mutex_lock(&tty->atomic_write_lock);
1203 if (tty->ops->write && tty->count > 0)
1204 tty->ops->write(tty, msg, strlen(msg));
1206 tty_write_unlock(tty);
1213 * tty_write - write method for tty device file
1214 * @file: tty file pointer
1215 * @buf: user data to write
1216 * @count: bytes to write
1219 * Write data to a tty device via the line discipline.
1222 * Locks the line discipline as required
1223 * Writes to the tty driver are serialized by the atomic_write_lock
1224 * and are then processed in chunks to the device. The line discipline
1225 * write method will not be invoked in parallel for each device.
1228 static ssize_t tty_write(struct file *file, const char __user *buf,
1229 size_t count, loff_t *ppos)
1231 struct tty_struct *tty = file_tty(file);
1232 struct tty_ldisc *ld;
1235 if (tty_paranoia_check(tty, file_inode(file), "tty_write"))
1237 if (!tty || !tty->ops->write ||
1238 (test_bit(TTY_IO_ERROR, &tty->flags)))
1240 /* Short term debug to catch buggy drivers */
1241 if (tty->ops->write_room == NULL)
1242 printk(KERN_ERR "tty driver %s lacks a write_room method.\n",
1244 ld = tty_ldisc_ref_wait(tty);
1245 if (!ld->ops->write)
1248 ret = do_tty_write(ld->ops->write, tty, file, buf, count);
1249 tty_ldisc_deref(ld);
1253 ssize_t redirected_tty_write(struct file *file, const char __user *buf,
1254 size_t count, loff_t *ppos)
1256 struct file *p = NULL;
1258 spin_lock(&redirect_lock);
1260 p = get_file(redirect);
1261 spin_unlock(&redirect_lock);
1265 res = vfs_write(p, buf, count, &p->f_pos);
1269 return tty_write(file, buf, count, ppos);
1273 * tty_send_xchar - send priority character
1275 * Send a high priority character to the tty even if stopped
1277 * Locking: none for xchar method, write ordering for write method.
1280 int tty_send_xchar(struct tty_struct *tty, char ch)
1282 int was_stopped = tty->stopped;
1284 if (tty->ops->send_xchar) {
1285 down_read(&tty->termios_rwsem);
1286 tty->ops->send_xchar(tty, ch);
1287 up_read(&tty->termios_rwsem);
1291 if (tty_write_lock(tty, 0) < 0)
1292 return -ERESTARTSYS;
1294 down_read(&tty->termios_rwsem);
1297 tty->ops->write(tty, &ch, 1);
1300 up_read(&tty->termios_rwsem);
1301 tty_write_unlock(tty);
1305 static char ptychar[] = "pqrstuvwxyzabcde";
1308 * pty_line_name - generate name for a pty
1309 * @driver: the tty driver in use
1310 * @index: the minor number
1311 * @p: output buffer of at least 6 bytes
1313 * Generate a name from a driver reference and write it to the output
1318 static void pty_line_name(struct tty_driver *driver, int index, char *p)
1320 int i = index + driver->name_base;
1321 /* ->name is initialized to "ttyp", but "tty" is expected */
1322 sprintf(p, "%s%c%x",
1323 driver->subtype == PTY_TYPE_SLAVE ? "tty" : driver->name,
1324 ptychar[i >> 4 & 0xf], i & 0xf);
1328 * tty_line_name - generate name for a tty
1329 * @driver: the tty driver in use
1330 * @index: the minor number
1331 * @p: output buffer of at least 7 bytes
1333 * Generate a name from a driver reference and write it to the output
1338 static ssize_t tty_line_name(struct tty_driver *driver, int index, char *p)
1340 if (driver->flags & TTY_DRIVER_UNNUMBERED_NODE)
1341 return sprintf(p, "%s", driver->name);
1343 return sprintf(p, "%s%d", driver->name,
1344 index + driver->name_base);
1348 * tty_driver_lookup_tty() - find an existing tty, if any
1349 * @driver: the driver for the tty
1350 * @idx: the minor number
1352 * Return the tty, if found. If not found, return NULL or ERR_PTR() if the
1353 * driver lookup() method returns an error.
1355 * Locking: tty_mutex must be held. If the tty is found, bump the tty kref.
1357 static struct tty_struct *tty_driver_lookup_tty(struct tty_driver *driver,
1358 struct inode *inode, int idx)
1360 struct tty_struct *tty;
1362 if (driver->ops->lookup)
1363 tty = driver->ops->lookup(driver, inode, idx);
1365 tty = driver->ttys[idx];
1373 * tty_init_termios - helper for termios setup
1374 * @tty: the tty to set up
1376 * Initialise the termios structures for this tty. Thus runs under
1377 * the tty_mutex currently so we can be relaxed about ordering.
1380 int tty_init_termios(struct tty_struct *tty)
1382 struct ktermios *tp;
1383 int idx = tty->index;
1385 if (tty->driver->flags & TTY_DRIVER_RESET_TERMIOS)
1386 tty->termios = tty->driver->init_termios;
1388 /* Check for lazy saved data */
1389 tp = tty->driver->termios[idx];
1393 tty->termios = tty->driver->init_termios;
1395 /* Compatibility until drivers always set this */
1396 tty->termios.c_ispeed = tty_termios_input_baud_rate(&tty->termios);
1397 tty->termios.c_ospeed = tty_termios_baud_rate(&tty->termios);
1400 EXPORT_SYMBOL_GPL(tty_init_termios);
1402 int tty_standard_install(struct tty_driver *driver, struct tty_struct *tty)
1404 int ret = tty_init_termios(tty);
1408 tty_driver_kref_get(driver);
1410 driver->ttys[tty->index] = tty;
1413 EXPORT_SYMBOL_GPL(tty_standard_install);
1416 * tty_driver_install_tty() - install a tty entry in the driver
1417 * @driver: the driver for the tty
1420 * Install a tty object into the driver tables. The tty->index field
1421 * will be set by the time this is called. This method is responsible
1422 * for ensuring any need additional structures are allocated and
1425 * Locking: tty_mutex for now
1427 static int tty_driver_install_tty(struct tty_driver *driver,
1428 struct tty_struct *tty)
1430 return driver->ops->install ? driver->ops->install(driver, tty) :
1431 tty_standard_install(driver, tty);
1435 * tty_driver_remove_tty() - remove a tty from the driver tables
1436 * @driver: the driver for the tty
1437 * @idx: the minor number
1439 * Remvoe a tty object from the driver tables. The tty->index field
1440 * will be set by the time this is called.
1442 * Locking: tty_mutex for now
1444 void tty_driver_remove_tty(struct tty_driver *driver, struct tty_struct *tty)
1446 if (driver->ops->remove)
1447 driver->ops->remove(driver, tty);
1449 driver->ttys[tty->index] = NULL;
1453 * tty_reopen() - fast re-open of an open tty
1454 * @tty - the tty to open
1456 * Return 0 on success, -errno on error.
1457 * Re-opens on master ptys are not allowed and return -EIO.
1459 * Locking: Caller must hold tty_lock
1461 static int tty_reopen(struct tty_struct *tty)
1463 struct tty_driver *driver = tty->driver;
1468 if (driver->type == TTY_DRIVER_TYPE_PTY &&
1469 driver->subtype == PTY_TYPE_MASTER)
1472 if (test_bit(TTY_EXCLUSIVE, &tty->flags) && !capable(CAP_SYS_ADMIN))
1477 WARN_ON(!tty->ldisc);
1483 * tty_init_dev - initialise a tty device
1484 * @driver: tty driver we are opening a device on
1485 * @idx: device index
1486 * @ret_tty: returned tty structure
1488 * Prepare a tty device. This may not be a "new" clean device but
1489 * could also be an active device. The pty drivers require special
1490 * handling because of this.
1493 * The function is called under the tty_mutex, which
1494 * protects us from the tty struct or driver itself going away.
1496 * On exit the tty device has the line discipline attached and
1497 * a reference count of 1. If a pair was created for pty/tty use
1498 * and the other was a pty master then it too has a reference count of 1.
1500 * WSH 06/09/97: Rewritten to remove races and properly clean up after a
1501 * failed open. The new code protects the open with a mutex, so it's
1502 * really quite straightforward. The mutex locking can probably be
1503 * relaxed for the (most common) case of reopening a tty.
1506 struct tty_struct *tty_init_dev(struct tty_driver *driver, int idx)
1508 struct tty_struct *tty;
1512 * First time open is complex, especially for PTY devices.
1513 * This code guarantees that either everything succeeds and the
1514 * TTY is ready for operation, or else the table slots are vacated
1515 * and the allocated memory released. (Except that the termios
1516 * and locked termios may be retained.)
1519 if (!try_module_get(driver->owner))
1520 return ERR_PTR(-ENODEV);
1522 tty = alloc_tty_struct(driver, idx);
1525 goto err_module_put;
1529 retval = tty_driver_install_tty(driver, tty);
1531 goto err_deinit_tty;
1534 tty->port = driver->ports[idx];
1536 WARN_RATELIMIT(!tty->port,
1537 "%s: %s driver does not set tty->port. This will crash the kernel later. Fix the driver!\n",
1538 __func__, tty->driver->name);
1540 tty->port->itty = tty;
1543 * Structures all installed ... call the ldisc open routines.
1544 * If we fail here just call release_tty to clean up. No need
1545 * to decrement the use counts, as release_tty doesn't care.
1547 retval = tty_ldisc_setup(tty, tty->link);
1549 goto err_release_tty;
1550 /* Return the tty locked so that it cannot vanish under the caller */
1555 deinitialize_tty_struct(tty);
1556 free_tty_struct(tty);
1558 module_put(driver->owner);
1559 return ERR_PTR(retval);
1561 /* call the tty release_tty routine to clean out this slot */
1564 printk_ratelimited(KERN_INFO "tty_init_dev: ldisc open failed, "
1565 "clearing slot %d\n", idx);
1566 release_tty(tty, idx);
1567 return ERR_PTR(retval);
1570 void tty_free_termios(struct tty_struct *tty)
1572 struct ktermios *tp;
1573 int idx = tty->index;
1575 /* If the port is going to reset then it has no termios to save */
1576 if (tty->driver->flags & TTY_DRIVER_RESET_TERMIOS)
1579 /* Stash the termios data */
1580 tp = tty->driver->termios[idx];
1582 tp = kmalloc(sizeof(struct ktermios), GFP_KERNEL);
1584 pr_warn("tty: no memory to save termios state.\n");
1587 tty->driver->termios[idx] = tp;
1591 EXPORT_SYMBOL(tty_free_termios);
1594 * tty_flush_works - flush all works of a tty/pty pair
1595 * @tty: tty device to flush works for (or either end of a pty pair)
1597 * Sync flush all works belonging to @tty (and the 'other' tty).
1599 static void tty_flush_works(struct tty_struct *tty)
1601 flush_work(&tty->SAK_work);
1602 flush_work(&tty->hangup_work);
1604 flush_work(&tty->link->SAK_work);
1605 flush_work(&tty->link->hangup_work);
1610 * release_one_tty - release tty structure memory
1611 * @kref: kref of tty we are obliterating
1613 * Releases memory associated with a tty structure, and clears out the
1614 * driver table slots. This function is called when a device is no longer
1615 * in use. It also gets called when setup of a device fails.
1618 * takes the file list lock internally when working on the list
1619 * of ttys that the driver keeps.
1621 * This method gets called from a work queue so that the driver private
1622 * cleanup ops can sleep (needed for USB at least)
1624 static void release_one_tty(struct work_struct *work)
1626 struct tty_struct *tty =
1627 container_of(work, struct tty_struct, hangup_work);
1628 struct tty_driver *driver = tty->driver;
1629 struct module *owner = driver->owner;
1631 if (tty->ops->cleanup)
1632 tty->ops->cleanup(tty);
1635 tty_driver_kref_put(driver);
1638 spin_lock(&tty_files_lock);
1639 list_del_init(&tty->tty_files);
1640 spin_unlock(&tty_files_lock);
1643 put_pid(tty->session);
1644 free_tty_struct(tty);
1647 static void queue_release_one_tty(struct kref *kref)
1649 struct tty_struct *tty = container_of(kref, struct tty_struct, kref);
1651 /* The hangup queue is now free so we can reuse it rather than
1652 waste a chunk of memory for each port */
1653 INIT_WORK(&tty->hangup_work, release_one_tty);
1654 schedule_work(&tty->hangup_work);
1658 * tty_kref_put - release a tty kref
1661 * Release a reference to a tty device and if need be let the kref
1662 * layer destruct the object for us
1665 void tty_kref_put(struct tty_struct *tty)
1668 kref_put(&tty->kref, queue_release_one_tty);
1670 EXPORT_SYMBOL(tty_kref_put);
1673 * release_tty - release tty structure memory
1675 * Release both @tty and a possible linked partner (think pty pair),
1676 * and decrement the refcount of the backing module.
1680 * takes the file list lock internally when working on the list
1681 * of ttys that the driver keeps.
1684 static void release_tty(struct tty_struct *tty, int idx)
1686 /* This should always be true but check for the moment */
1687 WARN_ON(tty->index != idx);
1688 WARN_ON(!mutex_is_locked(&tty_mutex));
1689 if (tty->ops->shutdown)
1690 tty->ops->shutdown(tty);
1691 tty_free_termios(tty);
1692 tty_driver_remove_tty(tty->driver, tty);
1693 tty->port->itty = NULL;
1695 tty->link->port->itty = NULL;
1696 tty_buffer_cancel_work(tty->port);
1698 tty_kref_put(tty->link);
1703 * tty_release_checks - check a tty before real release
1704 * @tty: tty to check
1705 * @o_tty: link of @tty (if any)
1706 * @idx: index of the tty
1708 * Performs some paranoid checking before true release of the @tty.
1709 * This is a no-op unless TTY_PARANOIA_CHECK is defined.
1711 static int tty_release_checks(struct tty_struct *tty, int idx)
1713 #ifdef TTY_PARANOIA_CHECK
1714 if (idx < 0 || idx >= tty->driver->num) {
1715 tty_debug(tty, "bad idx %d\n", idx);
1719 /* not much to check for devpts */
1720 if (tty->driver->flags & TTY_DRIVER_DEVPTS_MEM)
1723 if (tty != tty->driver->ttys[idx]) {
1724 tty_debug(tty, "bad driver table[%d] = %p\n",
1725 idx, tty->driver->ttys[idx]);
1728 if (tty->driver->other) {
1729 struct tty_struct *o_tty = tty->link;
1731 if (o_tty != tty->driver->other->ttys[idx]) {
1732 tty_debug(tty, "bad other table[%d] = %p\n",
1733 idx, tty->driver->other->ttys[idx]);
1736 if (o_tty->link != tty) {
1737 tty_debug(tty, "bad link = %p\n", o_tty->link);
1746 * tty_release - vfs callback for close
1747 * @inode: inode of tty
1748 * @filp: file pointer for handle to tty
1750 * Called the last time each file handle is closed that references
1751 * this tty. There may however be several such references.
1754 * Takes bkl. See tty_release_dev
1756 * Even releasing the tty structures is a tricky business.. We have
1757 * to be very careful that the structures are all released at the
1758 * same time, as interrupts might otherwise get the wrong pointers.
1760 * WSH 09/09/97: rewritten to avoid some nasty race conditions that could
1761 * lead to double frees or releasing memory still in use.
1764 int tty_release(struct inode *inode, struct file *filp)
1766 struct tty_struct *tty = file_tty(filp);
1767 struct tty_struct *o_tty = NULL;
1768 int do_sleep, final;
1773 if (tty_paranoia_check(tty, inode, __func__))
1777 check_tty_count(tty, __func__);
1779 __tty_fasync(-1, filp, 0);
1782 if (tty->driver->type == TTY_DRIVER_TYPE_PTY &&
1783 tty->driver->subtype == PTY_TYPE_MASTER)
1786 if (tty_release_checks(tty, idx)) {
1791 tty_debug_hangup(tty, "(tty count=%d)...\n", tty->count);
1793 if (tty->ops->close)
1794 tty->ops->close(tty, filp);
1796 /* If tty is pty master, lock the slave pty (stable lock order) */
1797 tty_lock_slave(o_tty);
1800 * Sanity check: if tty->count is going to zero, there shouldn't be
1801 * any waiters on tty->read_wait or tty->write_wait. We test the
1802 * wait queues and kick everyone out _before_ actually starting to
1803 * close. This ensures that we won't block while releasing the tty
1806 * The test for the o_tty closing is necessary, since the master and
1807 * slave sides may close in any order. If the slave side closes out
1808 * first, its count will be one, since the master side holds an open.
1809 * Thus this test wouldn't be triggered at the time the slave closed,
1815 if (tty->count <= 1) {
1816 if (waitqueue_active(&tty->read_wait)) {
1817 wake_up_poll(&tty->read_wait, POLLIN);
1820 if (waitqueue_active(&tty->write_wait)) {
1821 wake_up_poll(&tty->write_wait, POLLOUT);
1825 if (o_tty && o_tty->count <= 1) {
1826 if (waitqueue_active(&o_tty->read_wait)) {
1827 wake_up_poll(&o_tty->read_wait, POLLIN);
1830 if (waitqueue_active(&o_tty->write_wait)) {
1831 wake_up_poll(&o_tty->write_wait, POLLOUT);
1840 printk(KERN_WARNING "%s: %s: read/write wait queue active!\n",
1841 __func__, tty_name(tty));
1843 schedule_timeout_killable(timeout);
1844 if (timeout < 120 * HZ)
1845 timeout = 2 * timeout + 1;
1847 timeout = MAX_SCHEDULE_TIMEOUT;
1851 if (--o_tty->count < 0) {
1852 printk(KERN_WARNING "%s: bad pty slave count (%d) for %s\n",
1853 __func__, o_tty->count, tty_name(o_tty));
1857 if (--tty->count < 0) {
1858 printk(KERN_WARNING "%s: bad tty->count (%d) for %s\n",
1859 __func__, tty->count, tty_name(tty));
1864 * We've decremented tty->count, so we need to remove this file
1865 * descriptor off the tty->tty_files list; this serves two
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.
1875 * Perform some housekeeping before deciding whether to return.
1877 * If _either_ side is closing, make sure there aren't any
1878 * processes that still think tty or o_tty is their controlling
1882 read_lock(&tasklist_lock);
1883 session_clear_tty(tty->session);
1885 session_clear_tty(o_tty->session);
1886 read_unlock(&tasklist_lock);
1889 /* check whether both sides are closing ... */
1890 final = !tty->count && !(o_tty && o_tty->count);
1892 tty_unlock_slave(o_tty);
1895 /* At this point, the tty->count == 0 should ensure a dead tty
1896 cannot be re-opened by a racing opener */
1901 tty_debug_hangup(tty, "final close\n");
1903 * Ask the line discipline code to release its structures
1905 tty_ldisc_release(tty);
1907 /* Wait for pending work before tty destruction commmences */
1908 tty_flush_works(tty);
1910 tty_debug_hangup(tty, "freeing structure...\n");
1912 * The release_tty function takes care of the details of clearing
1913 * the slots and preserving the termios structure. The tty_unlock_pair
1914 * should be safe as we keep a kref while the tty is locked (so the
1915 * unlock never unlocks a freed tty).
1917 mutex_lock(&tty_mutex);
1918 release_tty(tty, idx);
1919 mutex_unlock(&tty_mutex);
1925 * tty_open_current_tty - get locked tty of current task
1926 * @device: device number
1927 * @filp: file pointer to tty
1928 * @return: locked tty of the current task iff @device is /dev/tty
1930 * Performs a re-open of the current task's controlling tty.
1932 * We cannot return driver and index like for the other nodes because
1933 * devpts will not work then. It expects inodes to be from devpts FS.
1935 static struct tty_struct *tty_open_current_tty(dev_t device, struct file *filp)
1937 struct tty_struct *tty;
1940 if (device != MKDEV(TTYAUX_MAJOR, 0))
1943 tty = get_current_tty();
1945 return ERR_PTR(-ENXIO);
1947 filp->f_flags |= O_NONBLOCK; /* Don't let /dev/tty block */
1950 tty_kref_put(tty); /* safe to drop the kref now */
1952 retval = tty_reopen(tty);
1955 tty = ERR_PTR(retval);
1961 * tty_lookup_driver - lookup a tty driver for a given device file
1962 * @device: device number
1963 * @filp: file pointer to tty
1964 * @noctty: set if the device should not become a controlling tty
1965 * @index: index for the device in the @return driver
1966 * @return: driver for this inode (with increased refcount)
1968 * If @return is not erroneous, the caller is responsible to decrement the
1969 * refcount by tty_driver_kref_put.
1971 * Locking: tty_mutex protects get_tty_driver
1973 static struct tty_driver *tty_lookup_driver(dev_t device, struct file *filp,
1974 int *noctty, int *index)
1976 struct tty_driver *driver;
1980 case MKDEV(TTY_MAJOR, 0): {
1981 extern struct tty_driver *console_driver;
1982 driver = tty_driver_kref_get(console_driver);
1983 *index = fg_console;
1988 case MKDEV(TTYAUX_MAJOR, 1): {
1989 struct tty_driver *console_driver = console_device(index);
1990 if (console_driver) {
1991 driver = tty_driver_kref_get(console_driver);
1993 /* Don't let /dev/console block */
1994 filp->f_flags |= O_NONBLOCK;
1999 return ERR_PTR(-ENODEV);
2002 driver = get_tty_driver(device, index);
2004 return ERR_PTR(-ENODEV);
2011 * tty_open - open a tty device
2012 * @inode: inode of device file
2013 * @filp: file pointer to tty
2015 * tty_open and tty_release keep up the tty count that contains the
2016 * number of opens done on a tty. We cannot use the inode-count, as
2017 * different inodes might point to the same tty.
2019 * Open-counting is needed for pty masters, as well as for keeping
2020 * track of serial lines: DTR is dropped when the last close happens.
2021 * (This is not done solely through tty->count, now. - Ted 1/27/92)
2023 * The termios state of a pty is reset on first open so that
2024 * settings don't persist across reuse.
2026 * Locking: tty_mutex protects tty, tty_lookup_driver and tty_init_dev.
2027 * tty->count should protect the rest.
2028 * ->siglock protects ->signal/->sighand
2030 * Note: the tty_unlock/lock cases without a ref are only safe due to
2034 static int tty_open(struct inode *inode, struct file *filp)
2036 struct tty_struct *tty;
2038 struct tty_driver *driver = NULL;
2040 dev_t device = inode->i_rdev;
2041 unsigned saved_flags = filp->f_flags;
2043 nonseekable_open(inode, filp);
2046 retval = tty_alloc_file(filp);
2050 noctty = filp->f_flags & O_NOCTTY;
2054 tty = tty_open_current_tty(device, filp);
2056 mutex_lock(&tty_mutex);
2057 driver = tty_lookup_driver(device, filp, &noctty, &index);
2058 if (IS_ERR(driver)) {
2059 retval = PTR_ERR(driver);
2063 /* check whether we're reopening an existing tty */
2064 tty = tty_driver_lookup_tty(driver, inode, index);
2066 retval = PTR_ERR(tty);
2071 mutex_unlock(&tty_mutex);
2073 /* safe to drop the kref from tty_driver_lookup_tty() */
2075 retval = tty_reopen(tty);
2078 tty = ERR_PTR(retval);
2080 } else { /* Returns with the tty_lock held for now */
2081 tty = tty_init_dev(driver, index);
2082 mutex_unlock(&tty_mutex);
2085 tty_driver_kref_put(driver);
2089 retval = PTR_ERR(tty);
2093 tty_add_file(tty, filp);
2095 check_tty_count(tty, __func__);
2096 if (tty->driver->type == TTY_DRIVER_TYPE_PTY &&
2097 tty->driver->subtype == PTY_TYPE_MASTER)
2100 tty_debug_hangup(tty, "(tty count=%d)\n", tty->count);
2103 retval = tty->ops->open(tty, filp);
2106 filp->f_flags = saved_flags;
2109 tty_debug_hangup(tty, "error %d, releasing...\n", retval);
2111 tty_unlock(tty); /* need to call tty_release without BTM */
2112 tty_release(inode, filp);
2113 if (retval != -ERESTARTSYS)
2116 if (signal_pending(current))
2121 * Need to reset f_op in case a hangup happened.
2123 if (tty_hung_up_p(filp))
2124 filp->f_op = &tty_fops;
2127 clear_bit(TTY_HUPPED, &tty->flags);
2130 read_lock(&tasklist_lock);
2131 spin_lock_irq(¤t->sighand->siglock);
2133 current->signal->leader &&
2134 !current->signal->tty &&
2135 tty->session == NULL) {
2137 * Don't let a process that only has write access to the tty
2138 * obtain the privileges associated with having a tty as
2139 * controlling terminal (being able to reopen it with full
2140 * access through /dev/tty, being able to perform pushback).
2141 * Many distributions set the group of all ttys to "tty" and
2142 * grant write-only access to all terminals for setgid tty
2143 * binaries, which should not imply full privileges on all ttys.
2145 * This could theoretically break old code that performs open()
2146 * on a write-only file descriptor. In that case, it might be
2147 * necessary to also permit this if
2148 * inode_permission(inode, MAY_READ) == 0.
2150 if (filp->f_mode & FMODE_READ)
2151 __proc_set_tty(tty);
2153 spin_unlock_irq(¤t->sighand->siglock);
2154 read_unlock(&tasklist_lock);
2158 mutex_unlock(&tty_mutex);
2159 /* after locks to avoid deadlock */
2160 if (!IS_ERR_OR_NULL(driver))
2161 tty_driver_kref_put(driver);
2163 tty_free_file(filp);
2170 * tty_poll - check tty status
2171 * @filp: file being polled
2172 * @wait: poll wait structures to update
2174 * Call the line discipline polling method to obtain the poll
2175 * status of the device.
2177 * Locking: locks called line discipline but ldisc poll method
2178 * may be re-entered freely by other callers.
2181 static unsigned int tty_poll(struct file *filp, poll_table *wait)
2183 struct tty_struct *tty = file_tty(filp);
2184 struct tty_ldisc *ld;
2187 if (tty_paranoia_check(tty, file_inode(filp), "tty_poll"))
2190 ld = tty_ldisc_ref_wait(tty);
2192 ret = ld->ops->poll(tty, filp, wait);
2193 tty_ldisc_deref(ld);
2197 static int __tty_fasync(int fd, struct file *filp, int on)
2199 struct tty_struct *tty = file_tty(filp);
2200 struct tty_ldisc *ldisc;
2201 unsigned long flags;
2204 if (tty_paranoia_check(tty, file_inode(filp), "tty_fasync"))
2207 retval = fasync_helper(fd, filp, on, &tty->fasync);
2211 ldisc = tty_ldisc_ref(tty);
2213 if (ldisc->ops->fasync)
2214 ldisc->ops->fasync(tty, on);
2215 tty_ldisc_deref(ldisc);
2222 spin_lock_irqsave(&tty->ctrl_lock, flags);
2225 type = PIDTYPE_PGID;
2227 pid = task_pid(current);
2231 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
2232 __f_setown(filp, pid, type, 0);
2240 static int tty_fasync(int fd, struct file *filp, int on)
2242 struct tty_struct *tty = file_tty(filp);
2246 retval = __tty_fasync(fd, filp, on);
2253 * tiocsti - fake input character
2254 * @tty: tty to fake input into
2255 * @p: pointer to character
2257 * Fake input to a tty device. Does the necessary locking and
2260 * FIXME: does not honour flow control ??
2263 * Called functions take tty_ldiscs_lock
2264 * current->signal->tty check is safe without locks
2266 * FIXME: may race normal receive processing
2269 static int tiocsti(struct tty_struct *tty, char __user *p)
2272 struct tty_ldisc *ld;
2274 if ((current->signal->tty != tty) && !capable(CAP_SYS_ADMIN))
2276 if (get_user(ch, p))
2278 tty_audit_tiocsti(tty, ch);
2279 ld = tty_ldisc_ref_wait(tty);
2280 ld->ops->receive_buf(tty, &ch, &mbz, 1);
2281 tty_ldisc_deref(ld);
2286 * tiocgwinsz - implement window query ioctl
2288 * @arg: user buffer for result
2290 * Copies the kernel idea of the window size into the user buffer.
2292 * Locking: tty->winsize_mutex is taken to ensure the winsize data
2296 static int tiocgwinsz(struct tty_struct *tty, struct winsize __user *arg)
2300 mutex_lock(&tty->winsize_mutex);
2301 err = copy_to_user(arg, &tty->winsize, sizeof(*arg));
2302 mutex_unlock(&tty->winsize_mutex);
2304 return err ? -EFAULT: 0;
2308 * tty_do_resize - resize event
2309 * @tty: tty being resized
2310 * @rows: rows (character)
2311 * @cols: cols (character)
2313 * Update the termios variables and send the necessary signals to
2314 * peform a terminal resize correctly
2317 int tty_do_resize(struct tty_struct *tty, struct winsize *ws)
2322 mutex_lock(&tty->winsize_mutex);
2323 if (!memcmp(ws, &tty->winsize, sizeof(*ws)))
2326 /* Signal the foreground process group */
2327 pgrp = tty_get_pgrp(tty);
2329 kill_pgrp(pgrp, SIGWINCH, 1);
2334 mutex_unlock(&tty->winsize_mutex);
2337 EXPORT_SYMBOL(tty_do_resize);
2340 * tiocswinsz - implement window size set ioctl
2341 * @tty; tty side of tty
2342 * @arg: user buffer for result
2344 * Copies the user idea of the window size to the kernel. Traditionally
2345 * this is just advisory information but for the Linux console it
2346 * actually has driver level meaning and triggers a VC resize.
2349 * Driver dependent. The default do_resize method takes the
2350 * tty termios mutex and ctrl_lock. The console takes its own lock
2351 * then calls into the default method.
2354 static int tiocswinsz(struct tty_struct *tty, struct winsize __user *arg)
2356 struct winsize tmp_ws;
2357 if (copy_from_user(&tmp_ws, arg, sizeof(*arg)))
2360 if (tty->ops->resize)
2361 return tty->ops->resize(tty, &tmp_ws);
2363 return tty_do_resize(tty, &tmp_ws);
2367 * tioccons - allow admin to move logical console
2368 * @file: the file to become console
2370 * Allow the administrator to move the redirected console device
2372 * Locking: uses redirect_lock to guard the redirect information
2375 static int tioccons(struct file *file)
2377 if (!capable(CAP_SYS_ADMIN))
2379 if (file->f_op->write == redirected_tty_write) {
2381 spin_lock(&redirect_lock);
2384 spin_unlock(&redirect_lock);
2389 spin_lock(&redirect_lock);
2391 spin_unlock(&redirect_lock);
2394 redirect = get_file(file);
2395 spin_unlock(&redirect_lock);
2400 * fionbio - non blocking ioctl
2401 * @file: file to set blocking value
2402 * @p: user parameter
2404 * Historical tty interfaces had a blocking control ioctl before
2405 * the generic functionality existed. This piece of history is preserved
2406 * in the expected tty API of posix OS's.
2408 * Locking: none, the open file handle ensures it won't go away.
2411 static int fionbio(struct file *file, int __user *p)
2415 if (get_user(nonblock, p))
2418 spin_lock(&file->f_lock);
2420 file->f_flags |= O_NONBLOCK;
2422 file->f_flags &= ~O_NONBLOCK;
2423 spin_unlock(&file->f_lock);
2428 * tiocsctty - set controlling tty
2429 * @tty: tty structure
2430 * @arg: user argument
2432 * This ioctl is used to manage job control. It permits a session
2433 * leader to set this tty as the controlling tty for the session.
2436 * Takes tty_lock() to serialize proc_set_tty() for this tty
2437 * Takes tasklist_lock internally to walk sessions
2438 * Takes ->siglock() when updating signal->tty
2441 static int tiocsctty(struct tty_struct *tty, struct file *file, int arg)
2446 read_lock(&tasklist_lock);
2448 if (current->signal->leader && (task_session(current) == tty->session))
2452 * The process must be a session leader and
2453 * not have a controlling tty already.
2455 if (!current->signal->leader || current->signal->tty) {
2462 * This tty is already the controlling
2463 * tty for another session group!
2465 if (arg == 1 && capable(CAP_SYS_ADMIN)) {
2469 session_clear_tty(tty->session);
2476 /* See the comment in tty_open(). */
2477 if ((file->f_mode & FMODE_READ) == 0 && !capable(CAP_SYS_ADMIN)) {
2484 read_unlock(&tasklist_lock);
2490 * tty_get_pgrp - return a ref counted pgrp pid
2493 * Returns a refcounted instance of the pid struct for the process
2494 * group controlling the tty.
2497 struct pid *tty_get_pgrp(struct tty_struct *tty)
2499 unsigned long flags;
2502 spin_lock_irqsave(&tty->ctrl_lock, flags);
2503 pgrp = get_pid(tty->pgrp);
2504 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
2508 EXPORT_SYMBOL_GPL(tty_get_pgrp);
2511 * This checks not only the pgrp, but falls back on the pid if no
2512 * satisfactory pgrp is found. I dunno - gdb doesn't work correctly
2515 * The caller must hold rcu lock or the tasklist lock.
2517 static struct pid *session_of_pgrp(struct pid *pgrp)
2519 struct task_struct *p;
2520 struct pid *sid = NULL;
2522 p = pid_task(pgrp, PIDTYPE_PGID);
2524 p = pid_task(pgrp, PIDTYPE_PID);
2526 sid = task_session(p);
2532 * tiocgpgrp - get process group
2533 * @tty: tty passed by user
2534 * @real_tty: tty side of the tty passed by the user if a pty else the tty
2537 * Obtain the process group of the tty. If there is no process group
2540 * Locking: none. Reference to current->signal->tty is safe.
2543 static int tiocgpgrp(struct tty_struct *tty, struct tty_struct *real_tty, pid_t __user *p)
2548 * (tty == real_tty) is a cheap way of
2549 * testing if the tty is NOT a master pty.
2551 if (tty == real_tty && current->signal->tty != real_tty)
2553 pid = tty_get_pgrp(real_tty);
2554 ret = put_user(pid_vnr(pid), p);
2560 * tiocspgrp - attempt to set process group
2561 * @tty: tty passed by user
2562 * @real_tty: tty side device matching tty passed by user
2565 * Set the process group of the tty to the session passed. Only
2566 * permitted where the tty session is our session.
2568 * Locking: RCU, ctrl lock
2571 static int tiocspgrp(struct tty_struct *tty, struct tty_struct *real_tty, pid_t __user *p)
2575 int retval = tty_check_change(real_tty);
2581 if (!current->signal->tty ||
2582 (current->signal->tty != real_tty) ||
2583 (real_tty->session != task_session(current)))
2585 if (get_user(pgrp_nr, p))
2590 pgrp = find_vpid(pgrp_nr);
2595 if (session_of_pgrp(pgrp) != task_session(current))
2598 spin_lock_irq(&tty->ctrl_lock);
2599 put_pid(real_tty->pgrp);
2600 real_tty->pgrp = get_pid(pgrp);
2601 spin_unlock_irq(&tty->ctrl_lock);
2608 * tiocgsid - get session id
2609 * @tty: tty passed by user
2610 * @real_tty: tty side of the tty passed by the user if a pty else the tty
2611 * @p: pointer to returned session id
2613 * Obtain the session id of the tty. If there is no session
2616 * Locking: none. Reference to current->signal->tty is safe.
2619 static int tiocgsid(struct tty_struct *tty, struct tty_struct *real_tty, pid_t __user *p)
2622 * (tty == real_tty) is a cheap way of
2623 * testing if the tty is NOT a master pty.
2625 if (tty == real_tty && current->signal->tty != real_tty)
2627 if (!real_tty->session)
2629 return put_user(pid_vnr(real_tty->session), p);
2633 * tiocsetd - set line discipline
2635 * @p: pointer to user data
2637 * Set the line discipline according to user request.
2639 * Locking: see tty_set_ldisc, this function is just a helper
2642 static int tiocsetd(struct tty_struct *tty, int __user *p)
2647 if (get_user(ldisc, p))
2650 ret = tty_set_ldisc(tty, ldisc);
2656 * send_break - performed time break
2657 * @tty: device to break on
2658 * @duration: timeout in mS
2660 * Perform a timed break on hardware that lacks its own driver level
2661 * timed break functionality.
2664 * atomic_write_lock serializes
2668 static int send_break(struct tty_struct *tty, unsigned int duration)
2672 if (tty->ops->break_ctl == NULL)
2675 if (tty->driver->flags & TTY_DRIVER_HARDWARE_BREAK)
2676 retval = tty->ops->break_ctl(tty, duration);
2678 /* Do the work ourselves */
2679 if (tty_write_lock(tty, 0) < 0)
2681 retval = tty->ops->break_ctl(tty, -1);
2684 if (!signal_pending(current))
2685 msleep_interruptible(duration);
2686 retval = tty->ops->break_ctl(tty, 0);
2688 tty_write_unlock(tty);
2689 if (signal_pending(current))
2696 * tty_tiocmget - get modem status
2698 * @file: user file pointer
2699 * @p: pointer to result
2701 * Obtain the modem status bits from the tty driver if the feature
2702 * is supported. Return -EINVAL if it is not available.
2704 * Locking: none (up to the driver)
2707 static int tty_tiocmget(struct tty_struct *tty, int __user *p)
2709 int retval = -EINVAL;
2711 if (tty->ops->tiocmget) {
2712 retval = tty->ops->tiocmget(tty);
2715 retval = put_user(retval, p);
2721 * tty_tiocmset - set modem status
2723 * @cmd: command - clear bits, set bits or set all
2724 * @p: pointer to desired bits
2726 * Set the modem status bits from the tty driver if the feature
2727 * is supported. Return -EINVAL if it is not available.
2729 * Locking: none (up to the driver)
2732 static int tty_tiocmset(struct tty_struct *tty, unsigned int cmd,
2736 unsigned int set, clear, val;
2738 if (tty->ops->tiocmset == NULL)
2741 retval = get_user(val, p);
2757 set &= TIOCM_DTR|TIOCM_RTS|TIOCM_OUT1|TIOCM_OUT2|TIOCM_LOOP;
2758 clear &= TIOCM_DTR|TIOCM_RTS|TIOCM_OUT1|TIOCM_OUT2|TIOCM_LOOP;
2759 return tty->ops->tiocmset(tty, set, clear);
2762 static int tty_tiocgicount(struct tty_struct *tty, void __user *arg)
2764 int retval = -EINVAL;
2765 struct serial_icounter_struct icount;
2766 memset(&icount, 0, sizeof(icount));
2767 if (tty->ops->get_icount)
2768 retval = tty->ops->get_icount(tty, &icount);
2771 if (copy_to_user(arg, &icount, sizeof(icount)))
2776 static void tty_warn_deprecated_flags(struct serial_struct __user *ss)
2778 static DEFINE_RATELIMIT_STATE(depr_flags,
2779 DEFAULT_RATELIMIT_INTERVAL,
2780 DEFAULT_RATELIMIT_BURST);
2781 char comm[TASK_COMM_LEN];
2784 if (get_user(flags, &ss->flags))
2787 flags &= ASYNC_DEPRECATED;
2789 if (flags && __ratelimit(&depr_flags))
2790 pr_warning("%s: '%s' is using deprecated serial flags (with no effect): %.8x\n",
2791 __func__, get_task_comm(comm, current), flags);
2795 * if pty, return the slave side (real_tty)
2796 * otherwise, return self
2798 static struct tty_struct *tty_pair_get_tty(struct tty_struct *tty)
2800 if (tty->driver->type == TTY_DRIVER_TYPE_PTY &&
2801 tty->driver->subtype == PTY_TYPE_MASTER)
2807 * Split this up, as gcc can choke on it otherwise..
2809 long tty_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
2811 struct tty_struct *tty = file_tty(file);
2812 struct tty_struct *real_tty;
2813 void __user *p = (void __user *)arg;
2815 struct tty_ldisc *ld;
2817 if (tty_paranoia_check(tty, file_inode(file), "tty_ioctl"))
2820 real_tty = tty_pair_get_tty(tty);
2823 * Factor out some common prep work
2831 retval = tty_check_change(tty);
2834 if (cmd != TIOCCBRK) {
2835 tty_wait_until_sent(tty, 0);
2836 if (signal_pending(current))
2847 return tiocsti(tty, p);
2849 return tiocgwinsz(real_tty, p);
2851 return tiocswinsz(real_tty, p);
2853 return real_tty != tty ? -EINVAL : tioccons(file);
2855 return fionbio(file, p);
2857 set_bit(TTY_EXCLUSIVE, &tty->flags);
2860 clear_bit(TTY_EXCLUSIVE, &tty->flags);
2864 int excl = test_bit(TTY_EXCLUSIVE, &tty->flags);
2865 return put_user(excl, (int __user *)p);
2868 if (current->signal->tty != tty)
2873 return tiocsctty(tty, file, arg);
2875 return tiocgpgrp(tty, real_tty, p);
2877 return tiocspgrp(tty, real_tty, p);
2879 return tiocgsid(tty, real_tty, p);
2881 return put_user(tty->ldisc->ops->num, (int __user *)p);
2883 return tiocsetd(tty, p);
2885 if (!capable(CAP_SYS_ADMIN))
2891 unsigned int ret = new_encode_dev(tty_devnum(real_tty));
2892 return put_user(ret, (unsigned int __user *)p);
2897 case TIOCSBRK: /* Turn break on, unconditionally */
2898 if (tty->ops->break_ctl)
2899 return tty->ops->break_ctl(tty, -1);
2901 case TIOCCBRK: /* Turn break off, unconditionally */
2902 if (tty->ops->break_ctl)
2903 return tty->ops->break_ctl(tty, 0);
2905 case TCSBRK: /* SVID version: non-zero arg --> no break */
2906 /* non-zero arg means wait for all output data
2907 * to be sent (performed above) but don't send break.
2908 * This is used by the tcdrain() termios function.
2911 return send_break(tty, 250);
2913 case TCSBRKP: /* support for POSIX tcsendbreak() */
2914 return send_break(tty, arg ? arg*100 : 250);
2917 return tty_tiocmget(tty, p);
2921 return tty_tiocmset(tty, cmd, p);
2923 retval = tty_tiocgicount(tty, p);
2924 /* For the moment allow fall through to the old method */
2925 if (retval != -EINVAL)
2932 /* flush tty buffer and allow ldisc to process ioctl */
2933 tty_buffer_flush(tty, NULL);
2938 tty_warn_deprecated_flags(p);
2941 if (tty->ops->ioctl) {
2942 retval = tty->ops->ioctl(tty, cmd, arg);
2943 if (retval != -ENOIOCTLCMD)
2946 ld = tty_ldisc_ref_wait(tty);
2948 if (ld->ops->ioctl) {
2949 retval = ld->ops->ioctl(tty, file, cmd, arg);
2950 if (retval == -ENOIOCTLCMD)
2953 tty_ldisc_deref(ld);
2957 #ifdef CONFIG_COMPAT
2958 static long tty_compat_ioctl(struct file *file, unsigned int cmd,
2961 struct tty_struct *tty = file_tty(file);
2962 struct tty_ldisc *ld;
2963 int retval = -ENOIOCTLCMD;
2965 if (tty_paranoia_check(tty, file_inode(file), "tty_ioctl"))
2968 if (tty->ops->compat_ioctl) {
2969 retval = tty->ops->compat_ioctl(tty, cmd, arg);
2970 if (retval != -ENOIOCTLCMD)
2974 ld = tty_ldisc_ref_wait(tty);
2975 if (ld->ops->compat_ioctl)
2976 retval = ld->ops->compat_ioctl(tty, file, cmd, arg);
2978 retval = n_tty_compat_ioctl_helper(tty, file, cmd, arg);
2979 tty_ldisc_deref(ld);
2985 static int this_tty(const void *t, struct file *file, unsigned fd)
2987 if (likely(file->f_op->read != tty_read))
2989 return file_tty(file) != t ? 0 : fd + 1;
2993 * This implements the "Secure Attention Key" --- the idea is to
2994 * prevent trojan horses by killing all processes associated with this
2995 * tty when the user hits the "Secure Attention Key". Required for
2996 * super-paranoid applications --- see the Orange Book for more details.
2998 * This code could be nicer; ideally it should send a HUP, wait a few
2999 * seconds, then send a INT, and then a KILL signal. But you then
3000 * have to coordinate with the init process, since all processes associated
3001 * with the current tty must be dead before the new getty is allowed
3004 * Now, if it would be correct ;-/ The current code has a nasty hole -
3005 * it doesn't catch files in flight. We may send the descriptor to ourselves
3006 * via AF_UNIX socket, close it and later fetch from socket. FIXME.
3008 * Nasty bug: do_SAK is being called in interrupt context. This can
3009 * deadlock. We punt it up to process context. AKPM - 16Mar2001
3011 void __do_SAK(struct tty_struct *tty)
3016 struct task_struct *g, *p;
3017 struct pid *session;
3022 session = tty->session;
3024 tty_ldisc_flush(tty);
3026 tty_driver_flush_buffer(tty);
3028 read_lock(&tasklist_lock);
3029 /* Kill the entire session */
3030 do_each_pid_task(session, PIDTYPE_SID, p) {
3031 printk(KERN_NOTICE "SAK: killed process %d"
3032 " (%s): task_session(p)==tty->session\n",
3033 task_pid_nr(p), p->comm);
3034 send_sig(SIGKILL, p, 1);
3035 } while_each_pid_task(session, PIDTYPE_SID, p);
3036 /* Now kill any processes that happen to have the
3039 do_each_thread(g, p) {
3040 if (p->signal->tty == tty) {
3041 printk(KERN_NOTICE "SAK: killed process %d"
3042 " (%s): task_session(p)==tty->session\n",
3043 task_pid_nr(p), p->comm);
3044 send_sig(SIGKILL, p, 1);
3048 i = iterate_fd(p->files, 0, this_tty, tty);
3050 printk(KERN_NOTICE "SAK: killed process %d"
3051 " (%s): fd#%d opened to the tty\n",
3052 task_pid_nr(p), p->comm, i - 1);
3053 force_sig(SIGKILL, p);
3056 } while_each_thread(g, p);
3057 read_unlock(&tasklist_lock);
3061 static void do_SAK_work(struct work_struct *work)
3063 struct tty_struct *tty =
3064 container_of(work, struct tty_struct, SAK_work);
3069 * The tq handling here is a little racy - tty->SAK_work may already be queued.
3070 * Fortunately we don't need to worry, because if ->SAK_work is already queued,
3071 * the values which we write to it will be identical to the values which it
3072 * already has. --akpm
3074 void do_SAK(struct tty_struct *tty)
3078 schedule_work(&tty->SAK_work);
3081 EXPORT_SYMBOL(do_SAK);
3083 static int dev_match_devt(struct device *dev, const void *data)
3085 const dev_t *devt = data;
3086 return dev->devt == *devt;
3089 /* Must put_device() after it's unused! */
3090 static struct device *tty_get_device(struct tty_struct *tty)
3092 dev_t devt = tty_devnum(tty);
3093 return class_find_device(tty_class, NULL, &devt, dev_match_devt);
3100 * This subroutine allocates and initializes a tty structure.
3102 * Locking: none - tty in question is not exposed at this point
3105 struct tty_struct *alloc_tty_struct(struct tty_driver *driver, int idx)
3107 struct tty_struct *tty;
3109 tty = kzalloc(sizeof(*tty), GFP_KERNEL);
3113 kref_init(&tty->kref);
3114 tty->magic = TTY_MAGIC;
3115 tty_ldisc_init(tty);
3116 tty->session = NULL;
3118 mutex_init(&tty->legacy_mutex);
3119 mutex_init(&tty->throttle_mutex);
3120 init_rwsem(&tty->termios_rwsem);
3121 mutex_init(&tty->winsize_mutex);
3122 init_ldsem(&tty->ldisc_sem);
3123 init_waitqueue_head(&tty->write_wait);
3124 init_waitqueue_head(&tty->read_wait);
3125 INIT_WORK(&tty->hangup_work, do_tty_hangup);
3126 mutex_init(&tty->atomic_write_lock);
3127 spin_lock_init(&tty->ctrl_lock);
3128 spin_lock_init(&tty->flow_lock);
3129 INIT_LIST_HEAD(&tty->tty_files);
3130 INIT_WORK(&tty->SAK_work, do_SAK_work);
3132 tty->driver = driver;
3133 tty->ops = driver->ops;
3135 tty_line_name(driver, idx, tty->name);
3136 tty->dev = tty_get_device(tty);
3142 * deinitialize_tty_struct
3143 * @tty: tty to deinitialize
3145 * This subroutine deinitializes a tty structure that has been newly
3146 * allocated but tty_release cannot be called on that yet.
3148 * Locking: none - tty in question must not be exposed at this point
3150 void deinitialize_tty_struct(struct tty_struct *tty)
3152 tty_ldisc_deinit(tty);
3156 * tty_put_char - write one character to a tty
3160 * Write one byte to the tty using the provided put_char method
3161 * if present. Returns the number of characters successfully output.
3163 * Note: the specific put_char operation in the driver layer may go
3164 * away soon. Don't call it directly, use this method
3167 int tty_put_char(struct tty_struct *tty, unsigned char ch)
3169 if (tty->ops->put_char)
3170 return tty->ops->put_char(tty, ch);
3171 return tty->ops->write(tty, &ch, 1);
3173 EXPORT_SYMBOL_GPL(tty_put_char);
3175 struct class *tty_class;
3177 static int tty_cdev_add(struct tty_driver *driver, dev_t dev,
3178 unsigned int index, unsigned int count)
3182 /* init here, since reused cdevs cause crashes */
3183 driver->cdevs[index] = cdev_alloc();
3184 if (!driver->cdevs[index])
3186 driver->cdevs[index]->ops = &tty_fops;
3187 driver->cdevs[index]->owner = driver->owner;
3188 err = cdev_add(driver->cdevs[index], dev, count);
3190 kobject_put(&driver->cdevs[index]->kobj);
3195 * tty_register_device - register a tty device
3196 * @driver: the tty driver that describes the tty device
3197 * @index: the index in the tty driver for this tty device
3198 * @device: a struct device that is associated with this tty device.
3199 * This field is optional, if there is no known struct device
3200 * for this tty device it can be set to NULL safely.
3202 * Returns a pointer to the struct device for this tty device
3203 * (or ERR_PTR(-EFOO) on error).
3205 * This call is required to be made to register an individual tty device
3206 * if the tty driver's flags have the TTY_DRIVER_DYNAMIC_DEV bit set. If
3207 * that bit is not set, this function should not be called by a tty
3213 struct device *tty_register_device(struct tty_driver *driver, unsigned index,
3214 struct device *device)
3216 return tty_register_device_attr(driver, index, device, NULL, NULL);
3218 EXPORT_SYMBOL(tty_register_device);
3220 static void tty_device_create_release(struct device *dev)
3222 pr_debug("device: '%s': %s\n", dev_name(dev), __func__);
3227 * tty_register_device_attr - register a tty device
3228 * @driver: the tty driver that describes the tty device
3229 * @index: the index in the tty driver for this tty device
3230 * @device: a struct device that is associated with this tty device.
3231 * This field is optional, if there is no known struct device
3232 * for this tty device it can be set to NULL safely.
3233 * @drvdata: Driver data to be set to device.
3234 * @attr_grp: Attribute group to be set on device.
3236 * Returns a pointer to the struct device for this tty device
3237 * (or ERR_PTR(-EFOO) on error).
3239 * This call is required to be made to register an individual tty device
3240 * if the tty driver's flags have the TTY_DRIVER_DYNAMIC_DEV bit set. If
3241 * that bit is not set, this function should not be called by a tty
3246 struct device *tty_register_device_attr(struct tty_driver *driver,
3247 unsigned index, struct device *device,
3249 const struct attribute_group **attr_grp)
3252 dev_t devt = MKDEV(driver->major, driver->minor_start) + index;
3253 struct device *dev = NULL;
3254 int retval = -ENODEV;
3257 if (index >= driver->num) {
3258 printk(KERN_ERR "Attempt to register invalid tty line number "
3260 return ERR_PTR(-EINVAL);
3263 if (driver->type == TTY_DRIVER_TYPE_PTY)
3264 pty_line_name(driver, index, name);
3266 tty_line_name(driver, index, name);
3268 if (!(driver->flags & TTY_DRIVER_DYNAMIC_ALLOC)) {
3269 retval = tty_cdev_add(driver, devt, index, 1);
3275 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
3282 dev->class = tty_class;
3283 dev->parent = device;
3284 dev->release = tty_device_create_release;
3285 dev_set_name(dev, "%s", name);
3286 dev->groups = attr_grp;
3287 dev_set_drvdata(dev, drvdata);
3289 retval = device_register(dev);
3298 cdev_del(driver->cdevs[index]);
3299 driver->cdevs[index] = NULL;
3301 return ERR_PTR(retval);
3303 EXPORT_SYMBOL_GPL(tty_register_device_attr);
3306 * tty_unregister_device - unregister a tty device
3307 * @driver: the tty driver that describes the tty device
3308 * @index: the index in the tty driver for this tty device
3310 * If a tty device is registered with a call to tty_register_device() then
3311 * this function must be called when the tty device is gone.
3316 void tty_unregister_device(struct tty_driver *driver, unsigned index)
3318 device_destroy(tty_class,
3319 MKDEV(driver->major, driver->minor_start) + index);
3320 if (!(driver->flags & TTY_DRIVER_DYNAMIC_ALLOC)) {
3321 cdev_del(driver->cdevs[index]);
3322 driver->cdevs[index] = NULL;
3325 EXPORT_SYMBOL(tty_unregister_device);
3328 * __tty_alloc_driver -- allocate tty driver
3329 * @lines: count of lines this driver can handle at most
3330 * @owner: module which is repsonsible for this driver
3331 * @flags: some of TTY_DRIVER_* flags, will be set in driver->flags
3333 * This should not be called directly, some of the provided macros should be
3334 * used instead. Use IS_ERR and friends on @retval.
3336 struct tty_driver *__tty_alloc_driver(unsigned int lines, struct module *owner,
3337 unsigned long flags)
3339 struct tty_driver *driver;
3340 unsigned int cdevs = 1;
3343 if (!lines || (flags & TTY_DRIVER_UNNUMBERED_NODE && lines > 1))
3344 return ERR_PTR(-EINVAL);
3346 driver = kzalloc(sizeof(struct tty_driver), GFP_KERNEL);
3348 return ERR_PTR(-ENOMEM);
3350 kref_init(&driver->kref);
3351 driver->magic = TTY_DRIVER_MAGIC;
3352 driver->num = lines;
3353 driver->owner = owner;
3354 driver->flags = flags;
3356 if (!(flags & TTY_DRIVER_DEVPTS_MEM)) {
3357 driver->ttys = kcalloc(lines, sizeof(*driver->ttys),
3359 driver->termios = kcalloc(lines, sizeof(*driver->termios),
3361 if (!driver->ttys || !driver->termios) {
3367 if (!(flags & TTY_DRIVER_DYNAMIC_ALLOC)) {
3368 driver->ports = kcalloc(lines, sizeof(*driver->ports),
3370 if (!driver->ports) {
3377 driver->cdevs = kcalloc(cdevs, sizeof(*driver->cdevs), GFP_KERNEL);
3378 if (!driver->cdevs) {
3385 kfree(driver->ports);
3386 kfree(driver->ttys);
3387 kfree(driver->termios);
3388 kfree(driver->cdevs);
3390 return ERR_PTR(err);
3392 EXPORT_SYMBOL(__tty_alloc_driver);
3394 static void destruct_tty_driver(struct kref *kref)
3396 struct tty_driver *driver = container_of(kref, struct tty_driver, kref);
3398 struct ktermios *tp;
3400 if (driver->flags & TTY_DRIVER_INSTALLED) {
3402 * Free the termios and termios_locked structures because
3403 * we don't want to get memory leaks when modular tty
3404 * drivers are removed from the kernel.
3406 for (i = 0; i < driver->num; i++) {
3407 tp = driver->termios[i];
3409 driver->termios[i] = NULL;
3412 if (!(driver->flags & TTY_DRIVER_DYNAMIC_DEV))
3413 tty_unregister_device(driver, i);
3415 proc_tty_unregister_driver(driver);
3416 if (driver->flags & TTY_DRIVER_DYNAMIC_ALLOC)
3417 cdev_del(driver->cdevs[0]);
3419 kfree(driver->cdevs);
3420 kfree(driver->ports);
3421 kfree(driver->termios);
3422 kfree(driver->ttys);
3426 void tty_driver_kref_put(struct tty_driver *driver)
3428 kref_put(&driver->kref, destruct_tty_driver);
3430 EXPORT_SYMBOL(tty_driver_kref_put);
3432 void tty_set_operations(struct tty_driver *driver,
3433 const struct tty_operations *op)
3437 EXPORT_SYMBOL(tty_set_operations);
3439 void put_tty_driver(struct tty_driver *d)
3441 tty_driver_kref_put(d);
3443 EXPORT_SYMBOL(put_tty_driver);
3446 * Called by a tty driver to register itself.
3448 int tty_register_driver(struct tty_driver *driver)
3455 if (!driver->major) {
3456 error = alloc_chrdev_region(&dev, driver->minor_start,
3457 driver->num, driver->name);
3459 driver->major = MAJOR(dev);
3460 driver->minor_start = MINOR(dev);
3463 dev = MKDEV(driver->major, driver->minor_start);
3464 error = register_chrdev_region(dev, driver->num, driver->name);
3469 if (driver->flags & TTY_DRIVER_DYNAMIC_ALLOC) {
3470 error = tty_cdev_add(driver, dev, 0, driver->num);
3472 goto err_unreg_char;
3475 mutex_lock(&tty_mutex);
3476 list_add(&driver->tty_drivers, &tty_drivers);
3477 mutex_unlock(&tty_mutex);
3479 if (!(driver->flags & TTY_DRIVER_DYNAMIC_DEV)) {
3480 for (i = 0; i < driver->num; i++) {
3481 d = tty_register_device(driver, i, NULL);
3484 goto err_unreg_devs;
3488 proc_tty_register_driver(driver);
3489 driver->flags |= TTY_DRIVER_INSTALLED;
3493 for (i--; i >= 0; i--)
3494 tty_unregister_device(driver, i);
3496 mutex_lock(&tty_mutex);
3497 list_del(&driver->tty_drivers);
3498 mutex_unlock(&tty_mutex);
3501 unregister_chrdev_region(dev, driver->num);
3505 EXPORT_SYMBOL(tty_register_driver);
3508 * Called by a tty driver to unregister itself.
3510 int tty_unregister_driver(struct tty_driver *driver)
3514 if (driver->refcount)
3517 unregister_chrdev_region(MKDEV(driver->major, driver->minor_start),
3519 mutex_lock(&tty_mutex);
3520 list_del(&driver->tty_drivers);
3521 mutex_unlock(&tty_mutex);
3525 EXPORT_SYMBOL(tty_unregister_driver);
3527 dev_t tty_devnum(struct tty_struct *tty)
3529 return MKDEV(tty->driver->major, tty->driver->minor_start) + tty->index;
3531 EXPORT_SYMBOL(tty_devnum);
3533 void tty_default_fops(struct file_operations *fops)
3539 * Initialize the console device. This is called *early*, so
3540 * we can't necessarily depend on lots of kernel help here.
3541 * Just do some early initializations, and do the complex setup
3544 void __init console_init(void)
3548 /* Setup the default TTY line discipline. */
3552 * set up the console device so that later boot sequences can
3553 * inform about problems etc..
3555 call = __con_initcall_start;
3556 while (call < __con_initcall_end) {
3562 static char *tty_devnode(struct device *dev, umode_t *mode)
3566 if (dev->devt == MKDEV(TTYAUX_MAJOR, 0) ||
3567 dev->devt == MKDEV(TTYAUX_MAJOR, 2))
3572 static int __init tty_class_init(void)
3574 tty_class = class_create(THIS_MODULE, "tty");
3575 if (IS_ERR(tty_class))
3576 return PTR_ERR(tty_class);
3577 tty_class->devnode = tty_devnode;
3581 postcore_initcall(tty_class_init);
3583 /* 3/2004 jmc: why do these devices exist? */
3584 static struct cdev tty_cdev, console_cdev;
3586 static ssize_t show_cons_active(struct device *dev,
3587 struct device_attribute *attr, char *buf)
3589 struct console *cs[16];
3595 for_each_console(c) {
3600 if ((c->flags & CON_ENABLED) == 0)
3603 if (i >= ARRAY_SIZE(cs))
3607 int index = cs[i]->index;
3608 struct tty_driver *drv = cs[i]->device(cs[i], &index);
3610 /* don't resolve tty0 as some programs depend on it */
3611 if (drv && (cs[i]->index > 0 || drv->major != TTY_MAJOR))
3612 count += tty_line_name(drv, index, buf + count);
3614 count += sprintf(buf + count, "%s%d",
3615 cs[i]->name, cs[i]->index);
3617 count += sprintf(buf + count, "%c", i ? ' ':'\n');
3623 static DEVICE_ATTR(active, S_IRUGO, show_cons_active, NULL);
3625 static struct attribute *cons_dev_attrs[] = {
3626 &dev_attr_active.attr,
3630 ATTRIBUTE_GROUPS(cons_dev);
3632 static struct device *consdev;
3634 void console_sysfs_notify(void)
3637 sysfs_notify(&consdev->kobj, NULL, "active");
3641 * Ok, now we can initialize the rest of the tty devices and can count
3642 * on memory allocations, interrupts etc..
3644 int __init tty_init(void)
3646 cdev_init(&tty_cdev, &tty_fops);
3647 if (cdev_add(&tty_cdev, MKDEV(TTYAUX_MAJOR, 0), 1) ||
3648 register_chrdev_region(MKDEV(TTYAUX_MAJOR, 0), 1, "/dev/tty") < 0)
3649 panic("Couldn't register /dev/tty driver\n");
3650 device_create(tty_class, NULL, MKDEV(TTYAUX_MAJOR, 0), NULL, "tty");
3652 cdev_init(&console_cdev, &console_fops);
3653 if (cdev_add(&console_cdev, MKDEV(TTYAUX_MAJOR, 1), 1) ||
3654 register_chrdev_region(MKDEV(TTYAUX_MAJOR, 1), 1, "/dev/console") < 0)
3655 panic("Couldn't register /dev/console driver\n");
3656 consdev = device_create_with_groups(tty_class, NULL,
3657 MKDEV(TTYAUX_MAJOR, 1), NULL,
3658 cons_dev_groups, "console");
3659 if (IS_ERR(consdev))
3663 vty_init(&console_fops);