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
110 #define TTY_PARANOIA_CHECK 1
111 #define CHECK_TTY_COUNT 1
113 struct ktermios tty_std_termios = { /* for the benefit of tty drivers */
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,
124 EXPORT_SYMBOL(tty_std_termios);
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
130 LIST_HEAD(tty_drivers); /* linked list of tty drivers */
132 /* Mutex to protect creating and releasing a tty. This is shared with
133 vt.c for deeply disgusting hack reasons */
134 DEFINE_MUTEX(tty_mutex);
135 EXPORT_SYMBOL(tty_mutex);
137 /* Spinlock to protect the tty->tty_files list */
138 DEFINE_SPINLOCK(tty_files_lock);
140 static ssize_t tty_read(struct file *, char __user *, size_t, loff_t *);
141 static ssize_t tty_write(struct file *, const char __user *, size_t, loff_t *);
142 ssize_t redirected_tty_write(struct file *, const char __user *,
144 static unsigned int tty_poll(struct file *, poll_table *);
145 static int tty_open(struct inode *, struct file *);
146 long tty_ioctl(struct file *file, unsigned int cmd, unsigned long arg);
148 static long tty_compat_ioctl(struct file *file, unsigned int cmd,
151 #define tty_compat_ioctl NULL
153 static int __tty_fasync(int fd, struct file *filp, int on);
154 static int tty_fasync(int fd, struct file *filp, int on);
155 static void release_tty(struct tty_struct *tty, int idx);
156 static void __proc_set_tty(struct task_struct *tsk, struct tty_struct *tty);
157 static void proc_set_tty(struct task_struct *tsk, struct tty_struct *tty);
160 * alloc_tty_struct - allocate a tty object
162 * Return a new empty tty structure. The data fields have not
163 * been initialized in any way but has been zeroed
168 struct tty_struct *alloc_tty_struct(void)
170 return kzalloc(sizeof(struct tty_struct), GFP_KERNEL);
174 * free_tty_struct - free a disused tty
175 * @tty: tty struct to free
177 * Free the write buffers, tty queue and tty memory itself.
179 * Locking: none. Must be called after tty is definitely unused
182 void free_tty_struct(struct tty_struct *tty)
187 put_device(tty->dev);
188 kfree(tty->write_buf);
189 tty->magic = 0xDEADDEAD;
193 static inline struct tty_struct *file_tty(struct file *file)
195 return ((struct tty_file_private *)file->private_data)->tty;
198 int tty_alloc_file(struct file *file)
200 struct tty_file_private *priv;
202 priv = kmalloc(sizeof(*priv), GFP_KERNEL);
206 file->private_data = priv;
211 /* Associate a new file with the tty structure */
212 void tty_add_file(struct tty_struct *tty, struct file *file)
214 struct tty_file_private *priv = file->private_data;
219 spin_lock(&tty_files_lock);
220 list_add(&priv->list, &tty->tty_files);
221 spin_unlock(&tty_files_lock);
225 * tty_free_file - free file->private_data
227 * This shall be used only for fail path handling when tty_add_file was not
230 void tty_free_file(struct file *file)
232 struct tty_file_private *priv = file->private_data;
234 file->private_data = NULL;
238 /* Delete file from its tty */
239 static void tty_del_file(struct file *file)
241 struct tty_file_private *priv = file->private_data;
243 spin_lock(&tty_files_lock);
244 list_del(&priv->list);
245 spin_unlock(&tty_files_lock);
250 #define TTY_NUMBER(tty) ((tty)->index + (tty)->driver->name_base)
253 * tty_name - return tty naming
254 * @tty: tty structure
255 * @buf: buffer for output
257 * Convert a tty structure into a name. The name reflects the kernel
258 * naming policy and if udev is in use may not reflect user space
263 char *tty_name(struct tty_struct *tty, char *buf)
265 if (!tty) /* Hmm. NULL pointer. That's fun. */
266 strcpy(buf, "NULL tty");
268 strcpy(buf, tty->name);
272 EXPORT_SYMBOL(tty_name);
274 int tty_paranoia_check(struct tty_struct *tty, struct inode *inode,
277 #ifdef TTY_PARANOIA_CHECK
280 "null TTY for (%d:%d) in %s\n",
281 imajor(inode), iminor(inode), routine);
284 if (tty->magic != TTY_MAGIC) {
286 "bad magic number for tty struct (%d:%d) in %s\n",
287 imajor(inode), iminor(inode), routine);
294 static int check_tty_count(struct tty_struct *tty, const char *routine)
296 #ifdef CHECK_TTY_COUNT
300 spin_lock(&tty_files_lock);
301 list_for_each(p, &tty->tty_files) {
304 spin_unlock(&tty_files_lock);
305 if (tty->driver->type == TTY_DRIVER_TYPE_PTY &&
306 tty->driver->subtype == PTY_TYPE_SLAVE &&
307 tty->link && tty->link->count)
309 if (tty->count != count) {
310 printk(KERN_WARNING "Warning: dev (%s) tty->count(%d) "
311 "!= #fd's(%d) in %s\n",
312 tty->name, tty->count, count, routine);
320 * get_tty_driver - find device of a tty
321 * @dev_t: device identifier
322 * @index: returns the index of the tty
324 * This routine returns a tty driver structure, given a device number
325 * and also passes back the index number.
327 * Locking: caller must hold tty_mutex
330 static struct tty_driver *get_tty_driver(dev_t device, int *index)
332 struct tty_driver *p;
334 list_for_each_entry(p, &tty_drivers, tty_drivers) {
335 dev_t base = MKDEV(p->major, p->minor_start);
336 if (device < base || device >= base + p->num)
338 *index = device - base;
339 return tty_driver_kref_get(p);
344 #ifdef CONFIG_CONSOLE_POLL
347 * tty_find_polling_driver - find device of a polled tty
348 * @name: name string to match
349 * @line: pointer to resulting tty line nr
351 * This routine returns a tty driver structure, given a name
352 * and the condition that the tty driver is capable of polled
355 struct tty_driver *tty_find_polling_driver(char *name, int *line)
357 struct tty_driver *p, *res = NULL;
362 for (str = name; *str; str++)
363 if ((*str >= '0' && *str <= '9') || *str == ',')
369 tty_line = simple_strtoul(str, &str, 10);
371 mutex_lock(&tty_mutex);
372 /* Search through the tty devices to look for a match */
373 list_for_each_entry(p, &tty_drivers, tty_drivers) {
374 if (strncmp(name, p->name, len) != 0)
382 if (tty_line >= 0 && tty_line < p->num && p->ops &&
383 p->ops->poll_init && !p->ops->poll_init(p, tty_line, stp)) {
384 res = tty_driver_kref_get(p);
389 mutex_unlock(&tty_mutex);
393 EXPORT_SYMBOL_GPL(tty_find_polling_driver);
397 * tty_check_change - check for POSIX terminal changes
400 * If we try to write to, or set the state of, a terminal and we're
401 * not in the foreground, send a SIGTTOU. If the signal is blocked or
402 * ignored, go ahead and perform the operation. (POSIX 7.2)
407 int tty_check_change(struct tty_struct *tty)
412 if (current->signal->tty != tty)
415 spin_lock_irqsave(&tty->ctrl_lock, flags);
418 printk(KERN_WARNING "tty_check_change: tty->pgrp == NULL!\n");
421 if (task_pgrp(current) == tty->pgrp)
423 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
424 if (is_ignored(SIGTTOU))
426 if (is_current_pgrp_orphaned()) {
430 kill_pgrp(task_pgrp(current), SIGTTOU, 1);
431 set_thread_flag(TIF_SIGPENDING);
436 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
440 EXPORT_SYMBOL(tty_check_change);
442 static ssize_t hung_up_tty_read(struct file *file, char __user *buf,
443 size_t count, loff_t *ppos)
448 static ssize_t hung_up_tty_write(struct file *file, const char __user *buf,
449 size_t count, loff_t *ppos)
454 /* No kernel lock held - none needed ;) */
455 static unsigned int hung_up_tty_poll(struct file *filp, poll_table *wait)
457 return POLLIN | POLLOUT | POLLERR | POLLHUP | POLLRDNORM | POLLWRNORM;
460 static long hung_up_tty_ioctl(struct file *file, unsigned int cmd,
463 return cmd == TIOCSPGRP ? -ENOTTY : -EIO;
466 static long hung_up_tty_compat_ioctl(struct file *file,
467 unsigned int cmd, unsigned long arg)
469 return cmd == TIOCSPGRP ? -ENOTTY : -EIO;
472 static const struct file_operations tty_fops = {
477 .unlocked_ioctl = tty_ioctl,
478 .compat_ioctl = tty_compat_ioctl,
480 .release = tty_release,
481 .fasync = tty_fasync,
484 static const struct file_operations console_fops = {
487 .write = redirected_tty_write,
489 .unlocked_ioctl = tty_ioctl,
490 .compat_ioctl = tty_compat_ioctl,
492 .release = tty_release,
493 .fasync = tty_fasync,
496 static const struct file_operations hung_up_tty_fops = {
498 .read = hung_up_tty_read,
499 .write = hung_up_tty_write,
500 .poll = hung_up_tty_poll,
501 .unlocked_ioctl = hung_up_tty_ioctl,
502 .compat_ioctl = hung_up_tty_compat_ioctl,
503 .release = tty_release,
506 static DEFINE_SPINLOCK(redirect_lock);
507 static struct file *redirect;
510 * tty_wakeup - request more data
513 * Internal and external helper for wakeups of tty. This function
514 * informs the line discipline if present that the driver is ready
515 * to receive more output data.
518 void tty_wakeup(struct tty_struct *tty)
520 struct tty_ldisc *ld;
522 if (test_bit(TTY_DO_WRITE_WAKEUP, &tty->flags)) {
523 ld = tty_ldisc_ref(tty);
525 if (ld->ops->write_wakeup)
526 ld->ops->write_wakeup(tty);
530 wake_up_interruptible_poll(&tty->write_wait, POLLOUT);
533 EXPORT_SYMBOL_GPL(tty_wakeup);
536 * tty_signal_session_leader - sends SIGHUP to session leader
537 * @tty controlling tty
538 * @exit_session if non-zero, signal all foreground group processes
540 * Send SIGHUP and SIGCONT to the session leader and its process group.
541 * Optionally, signal all processes in the foreground process group.
543 * Returns the number of processes in the session with this tty
544 * as their controlling terminal. This value is used to drop
545 * tty references for those processes.
547 static int tty_signal_session_leader(struct tty_struct *tty, int exit_session)
549 struct task_struct *p;
551 struct pid *tty_pgrp = NULL;
553 read_lock(&tasklist_lock);
555 do_each_pid_task(tty->session, PIDTYPE_SID, p) {
556 spin_lock_irq(&p->sighand->siglock);
557 if (p->signal->tty == tty) {
558 p->signal->tty = NULL;
559 /* We defer the dereferences outside fo
563 if (!p->signal->leader) {
564 spin_unlock_irq(&p->sighand->siglock);
567 __group_send_sig_info(SIGHUP, SEND_SIG_PRIV, p);
568 __group_send_sig_info(SIGCONT, SEND_SIG_PRIV, p);
569 put_pid(p->signal->tty_old_pgrp); /* A noop */
570 spin_lock(&tty->ctrl_lock);
571 tty_pgrp = get_pid(tty->pgrp);
573 p->signal->tty_old_pgrp = get_pid(tty->pgrp);
574 spin_unlock(&tty->ctrl_lock);
575 spin_unlock_irq(&p->sighand->siglock);
576 } while_each_pid_task(tty->session, PIDTYPE_SID, p);
578 read_unlock(&tasklist_lock);
582 kill_pgrp(tty_pgrp, SIGHUP, exit_session);
590 * __tty_hangup - actual handler for hangup events
593 * This can be called by a "kworker" kernel thread. That is process
594 * synchronous but doesn't hold any locks, so we need to make sure we
595 * have the appropriate locks for what we're doing.
597 * The hangup event clears any pending redirections onto the hung up
598 * device. It ensures future writes will error and it does the needed
599 * line discipline hangup and signal delivery. The tty object itself
604 * redirect lock for undoing redirection
605 * file list lock for manipulating list of ttys
606 * tty_ldisc_lock from called functions
607 * termios_mutex resetting termios data
608 * tasklist_lock to walk task list for hangup event
609 * ->siglock to protect ->signal/->sighand
611 static void __tty_hangup(struct tty_struct *tty, int exit_session)
613 struct file *cons_filp = NULL;
614 struct file *filp, *f = NULL;
615 struct tty_file_private *priv;
616 int closecount = 0, n;
623 spin_lock(&redirect_lock);
624 if (redirect && file_tty(redirect) == tty) {
628 spin_unlock(&redirect_lock);
632 if (test_bit(TTY_HUPPED, &tty->flags)) {
637 /* some functions below drop BTM, so we need this bit */
638 set_bit(TTY_HUPPING, &tty->flags);
640 /* inuse_filps is protected by the single tty lock,
641 this really needs to change if we want to flush the
642 workqueue with the lock held */
643 check_tty_count(tty, "tty_hangup");
645 spin_lock(&tty_files_lock);
646 /* This breaks for file handles being sent over AF_UNIX sockets ? */
647 list_for_each_entry(priv, &tty->tty_files, list) {
649 if (filp->f_op->write == redirected_tty_write)
651 if (filp->f_op->write != tty_write)
654 __tty_fasync(-1, filp, 0); /* can't block */
655 filp->f_op = &hung_up_tty_fops;
657 spin_unlock(&tty_files_lock);
659 refs = tty_signal_session_leader(tty, exit_session);
660 /* Account for the p->signal references we killed */
665 * it drops BTM and thus races with reopen
666 * we protect the race by TTY_HUPPING
668 tty_ldisc_hangup(tty);
670 spin_lock_irq(&tty->ctrl_lock);
671 clear_bit(TTY_THROTTLED, &tty->flags);
672 clear_bit(TTY_DO_WRITE_WAKEUP, &tty->flags);
673 put_pid(tty->session);
677 tty->ctrl_status = 0;
678 spin_unlock_irq(&tty->ctrl_lock);
681 * If one of the devices matches a console pointer, we
682 * cannot just call hangup() because that will cause
683 * tty->count and state->count to go out of sync.
684 * So we just call close() the right number of times.
688 for (n = 0; n < closecount; n++)
689 tty->ops->close(tty, cons_filp);
690 } else if (tty->ops->hangup)
691 (tty->ops->hangup)(tty);
693 * We don't want to have driver/ldisc interactions beyond
694 * the ones we did here. The driver layer expects no
695 * calls after ->hangup() from the ldisc side. However we
696 * can't yet guarantee all that.
698 set_bit(TTY_HUPPED, &tty->flags);
699 clear_bit(TTY_HUPPING, &tty->flags);
707 static void do_tty_hangup(struct work_struct *work)
709 struct tty_struct *tty =
710 container_of(work, struct tty_struct, hangup_work);
712 __tty_hangup(tty, 0);
716 * tty_hangup - trigger a hangup event
717 * @tty: tty to hangup
719 * A carrier loss (virtual or otherwise) has occurred on this like
720 * schedule a hangup sequence to run after this event.
723 void tty_hangup(struct tty_struct *tty)
725 #ifdef TTY_DEBUG_HANGUP
727 printk(KERN_DEBUG "%s hangup...\n", tty_name(tty, buf));
729 schedule_work(&tty->hangup_work);
732 EXPORT_SYMBOL(tty_hangup);
735 * tty_vhangup - process vhangup
736 * @tty: tty to hangup
738 * The user has asked via system call for the terminal to be hung up.
739 * We do this synchronously so that when the syscall returns the process
740 * is complete. That guarantee is necessary for security reasons.
743 void tty_vhangup(struct tty_struct *tty)
745 #ifdef TTY_DEBUG_HANGUP
748 printk(KERN_DEBUG "%s vhangup...\n", tty_name(tty, buf));
750 __tty_hangup(tty, 0);
753 EXPORT_SYMBOL(tty_vhangup);
757 * tty_vhangup_self - process vhangup for own ctty
759 * Perform a vhangup on the current controlling tty
762 void tty_vhangup_self(void)
764 struct tty_struct *tty;
766 tty = get_current_tty();
774 * tty_vhangup_session - hangup session leader exit
775 * @tty: tty to hangup
777 * The session leader is exiting and hanging up its controlling terminal.
778 * Every process in the foreground process group is signalled SIGHUP.
780 * We do this synchronously so that when the syscall returns the process
781 * is complete. That guarantee is necessary for security reasons.
784 static void tty_vhangup_session(struct tty_struct *tty)
786 #ifdef TTY_DEBUG_HANGUP
789 printk(KERN_DEBUG "%s vhangup session...\n", tty_name(tty, buf));
791 __tty_hangup(tty, 1);
795 * tty_hung_up_p - was tty hung up
796 * @filp: file pointer of tty
798 * Return true if the tty has been subject to a vhangup or a carrier
802 int tty_hung_up_p(struct file *filp)
804 return (filp->f_op == &hung_up_tty_fops);
807 EXPORT_SYMBOL(tty_hung_up_p);
809 static void session_clear_tty(struct pid *session)
811 struct task_struct *p;
812 do_each_pid_task(session, PIDTYPE_SID, p) {
814 } while_each_pid_task(session, PIDTYPE_SID, p);
818 * disassociate_ctty - disconnect controlling tty
819 * @on_exit: true if exiting so need to "hang up" the session
821 * This function is typically called only by the session leader, when
822 * it wants to disassociate itself from its controlling tty.
824 * It performs the following functions:
825 * (1) Sends a SIGHUP and SIGCONT to the foreground process group
826 * (2) Clears the tty from being controlling the session
827 * (3) Clears the controlling tty for all processes in the
830 * The argument on_exit is set to 1 if called when a process is
831 * exiting; it is 0 if called by the ioctl TIOCNOTTY.
834 * BTM is taken for hysterical raisins, and held when
835 * called from no_tty().
836 * tty_mutex is taken to protect tty
837 * ->siglock is taken to protect ->signal/->sighand
838 * tasklist_lock is taken to walk process list for sessions
839 * ->siglock is taken to protect ->signal/->sighand
842 void disassociate_ctty(int on_exit)
844 struct tty_struct *tty;
846 if (!current->signal->leader)
849 tty = get_current_tty();
851 if (on_exit && tty->driver->type != TTY_DRIVER_TYPE_PTY) {
852 tty_vhangup_session(tty);
854 struct pid *tty_pgrp = tty_get_pgrp(tty);
856 kill_pgrp(tty_pgrp, SIGHUP, on_exit);
858 kill_pgrp(tty_pgrp, SIGCONT, on_exit);
864 } else if (on_exit) {
865 struct pid *old_pgrp;
866 spin_lock_irq(¤t->sighand->siglock);
867 old_pgrp = current->signal->tty_old_pgrp;
868 current->signal->tty_old_pgrp = NULL;
869 spin_unlock_irq(¤t->sighand->siglock);
871 kill_pgrp(old_pgrp, SIGHUP, on_exit);
872 kill_pgrp(old_pgrp, SIGCONT, on_exit);
878 spin_lock_irq(¤t->sighand->siglock);
879 put_pid(current->signal->tty_old_pgrp);
880 current->signal->tty_old_pgrp = NULL;
881 spin_unlock_irq(¤t->sighand->siglock);
883 tty = get_current_tty();
886 spin_lock_irqsave(&tty->ctrl_lock, flags);
887 put_pid(tty->session);
891 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
894 #ifdef TTY_DEBUG_HANGUP
895 printk(KERN_DEBUG "error attempted to write to tty [0x%p]"
900 /* Now clear signal->tty under the lock */
901 read_lock(&tasklist_lock);
902 session_clear_tty(task_session(current));
903 read_unlock(&tasklist_lock);
908 * no_tty - Ensure the current process does not have a controlling tty
912 /* FIXME: Review locking here. The tty_lock never covered any race
913 between a new association and proc_clear_tty but possible we need
914 to protect against this anyway */
915 struct task_struct *tsk = current;
916 disassociate_ctty(0);
922 * stop_tty - propagate flow control
925 * Perform flow control to the driver. For PTY/TTY pairs we
926 * must also propagate the TIOCKPKT status. May be called
927 * on an already stopped device and will not re-call the driver
930 * This functionality is used by both the line disciplines for
931 * halting incoming flow and by the driver. It may therefore be
932 * called from any context, may be under the tty atomic_write_lock
936 * Uses the tty control lock internally
939 void stop_tty(struct tty_struct *tty)
942 spin_lock_irqsave(&tty->ctrl_lock, flags);
944 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
948 if (tty->link && tty->link->packet) {
949 tty->ctrl_status &= ~TIOCPKT_START;
950 tty->ctrl_status |= TIOCPKT_STOP;
951 wake_up_interruptible_poll(&tty->link->read_wait, POLLIN);
953 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
955 (tty->ops->stop)(tty);
958 EXPORT_SYMBOL(stop_tty);
961 * start_tty - propagate flow control
964 * Start a tty that has been stopped if at all possible. Perform
965 * any necessary wakeups and propagate the TIOCPKT status. If this
966 * is the tty was previous stopped and is being started then the
967 * driver start method is invoked and the line discipline woken.
973 void start_tty(struct tty_struct *tty)
976 spin_lock_irqsave(&tty->ctrl_lock, flags);
977 if (!tty->stopped || tty->flow_stopped) {
978 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
982 if (tty->link && tty->link->packet) {
983 tty->ctrl_status &= ~TIOCPKT_STOP;
984 tty->ctrl_status |= TIOCPKT_START;
985 wake_up_interruptible_poll(&tty->link->read_wait, POLLIN);
987 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
989 (tty->ops->start)(tty);
990 /* If we have a running line discipline it may need kicking */
994 EXPORT_SYMBOL(start_tty);
996 /* We limit tty time update visibility to every 8 seconds or so. */
997 static void tty_update_time(struct timespec *time)
999 unsigned long sec = get_seconds() & ~7;
1000 if ((long)(sec - time->tv_sec) > 0)
1005 * tty_read - read method for tty device files
1006 * @file: pointer to tty file
1008 * @count: size of user buffer
1011 * Perform the read system call function on this terminal device. Checks
1012 * for hung up devices before calling the line discipline method.
1015 * Locks the line discipline internally while needed. Multiple
1016 * read calls may be outstanding in parallel.
1019 static ssize_t tty_read(struct file *file, char __user *buf, size_t count,
1023 struct inode *inode = file_inode(file);
1024 struct tty_struct *tty = file_tty(file);
1025 struct tty_ldisc *ld;
1027 if (tty_paranoia_check(tty, inode, "tty_read"))
1029 if (!tty || (test_bit(TTY_IO_ERROR, &tty->flags)))
1032 /* We want to wait for the line discipline to sort out in this
1034 ld = tty_ldisc_ref_wait(tty);
1036 i = (ld->ops->read)(tty, file, buf, count);
1039 tty_ldisc_deref(ld);
1042 tty_update_time(&inode->i_atime);
1047 void tty_write_unlock(struct tty_struct *tty)
1048 __releases(&tty->atomic_write_lock)
1050 mutex_unlock(&tty->atomic_write_lock);
1051 wake_up_interruptible_poll(&tty->write_wait, POLLOUT);
1054 int tty_write_lock(struct tty_struct *tty, int ndelay)
1055 __acquires(&tty->atomic_write_lock)
1057 if (!mutex_trylock(&tty->atomic_write_lock)) {
1060 if (mutex_lock_interruptible(&tty->atomic_write_lock))
1061 return -ERESTARTSYS;
1067 * Split writes up in sane blocksizes to avoid
1068 * denial-of-service type attacks
1070 static inline ssize_t do_tty_write(
1071 ssize_t (*write)(struct tty_struct *, struct file *, const unsigned char *, size_t),
1072 struct tty_struct *tty,
1074 const char __user *buf,
1077 ssize_t ret, written = 0;
1080 ret = tty_write_lock(tty, file->f_flags & O_NDELAY);
1085 * We chunk up writes into a temporary buffer. This
1086 * simplifies low-level drivers immensely, since they
1087 * don't have locking issues and user mode accesses.
1089 * But if TTY_NO_WRITE_SPLIT is set, we should use a
1092 * The default chunk-size is 2kB, because the NTTY
1093 * layer has problems with bigger chunks. It will
1094 * claim to be able to handle more characters than
1097 * FIXME: This can probably go away now except that 64K chunks
1098 * are too likely to fail unless switched to vmalloc...
1101 if (test_bit(TTY_NO_WRITE_SPLIT, &tty->flags))
1106 /* write_buf/write_cnt is protected by the atomic_write_lock mutex */
1107 if (tty->write_cnt < chunk) {
1108 unsigned char *buf_chunk;
1113 buf_chunk = kmalloc(chunk, GFP_KERNEL);
1118 kfree(tty->write_buf);
1119 tty->write_cnt = chunk;
1120 tty->write_buf = buf_chunk;
1123 /* Do the write .. */
1125 size_t size = count;
1129 if (copy_from_user(tty->write_buf, buf, size))
1131 ret = write(tty, file, tty->write_buf, size);
1140 if (signal_pending(current))
1145 tty_update_time(&file_inode(file)->i_mtime);
1149 tty_write_unlock(tty);
1154 * tty_write_message - write a message to a certain tty, not just the console.
1155 * @tty: the destination tty_struct
1156 * @msg: the message to write
1158 * This is used for messages that need to be redirected to a specific tty.
1159 * We don't put it into the syslog queue right now maybe in the future if
1162 * We must still hold the BTM and test the CLOSING flag for the moment.
1165 void tty_write_message(struct tty_struct *tty, char *msg)
1168 mutex_lock(&tty->atomic_write_lock);
1170 if (tty->ops->write && !test_bit(TTY_CLOSING, &tty->flags)) {
1172 tty->ops->write(tty, msg, strlen(msg));
1175 tty_write_unlock(tty);
1182 * tty_write - write method for tty device file
1183 * @file: tty file pointer
1184 * @buf: user data to write
1185 * @count: bytes to write
1188 * Write data to a tty device via the line discipline.
1191 * Locks the line discipline as required
1192 * Writes to the tty driver are serialized by the atomic_write_lock
1193 * and are then processed in chunks to the device. The line discipline
1194 * write method will not be invoked in parallel for each device.
1197 static ssize_t tty_write(struct file *file, const char __user *buf,
1198 size_t count, loff_t *ppos)
1200 struct tty_struct *tty = file_tty(file);
1201 struct tty_ldisc *ld;
1204 if (tty_paranoia_check(tty, file_inode(file), "tty_write"))
1206 if (!tty || !tty->ops->write ||
1207 (test_bit(TTY_IO_ERROR, &tty->flags)))
1209 /* Short term debug to catch buggy drivers */
1210 if (tty->ops->write_room == NULL)
1211 printk(KERN_ERR "tty driver %s lacks a write_room method.\n",
1213 ld = tty_ldisc_ref_wait(tty);
1214 if (!ld->ops->write)
1217 ret = do_tty_write(ld->ops->write, tty, file, buf, count);
1218 tty_ldisc_deref(ld);
1222 ssize_t redirected_tty_write(struct file *file, const char __user *buf,
1223 size_t count, loff_t *ppos)
1225 struct file *p = NULL;
1227 spin_lock(&redirect_lock);
1229 p = get_file(redirect);
1230 spin_unlock(&redirect_lock);
1234 res = vfs_write(p, buf, count, &p->f_pos);
1238 return tty_write(file, buf, count, ppos);
1241 static char ptychar[] = "pqrstuvwxyzabcde";
1244 * pty_line_name - generate name for a pty
1245 * @driver: the tty driver in use
1246 * @index: the minor number
1247 * @p: output buffer of at least 6 bytes
1249 * Generate a name from a driver reference and write it to the output
1254 static void pty_line_name(struct tty_driver *driver, int index, char *p)
1256 int i = index + driver->name_base;
1257 /* ->name is initialized to "ttyp", but "tty" is expected */
1258 sprintf(p, "%s%c%x",
1259 driver->subtype == PTY_TYPE_SLAVE ? "tty" : driver->name,
1260 ptychar[i >> 4 & 0xf], i & 0xf);
1264 * tty_line_name - generate name for a tty
1265 * @driver: the tty driver in use
1266 * @index: the minor number
1267 * @p: output buffer of at least 7 bytes
1269 * Generate a name from a driver reference and write it to the output
1274 static ssize_t tty_line_name(struct tty_driver *driver, int index, char *p)
1276 if (driver->flags & TTY_DRIVER_UNNUMBERED_NODE)
1277 return sprintf(p, "%s", driver->name);
1279 return sprintf(p, "%s%d", driver->name,
1280 index + driver->name_base);
1284 * tty_driver_lookup_tty() - find an existing tty, if any
1285 * @driver: the driver for the tty
1286 * @idx: the minor number
1288 * Return the tty, if found or ERR_PTR() otherwise.
1290 * Locking: tty_mutex must be held. If tty is found, the mutex must
1291 * be held until the 'fast-open' is also done. Will change once we
1292 * have refcounting in the driver and per driver locking
1294 static struct tty_struct *tty_driver_lookup_tty(struct tty_driver *driver,
1295 struct inode *inode, int idx)
1297 if (driver->ops->lookup)
1298 return driver->ops->lookup(driver, inode, idx);
1300 return driver->ttys[idx];
1304 * tty_init_termios - helper for termios setup
1305 * @tty: the tty to set up
1307 * Initialise the termios structures for this tty. Thus runs under
1308 * the tty_mutex currently so we can be relaxed about ordering.
1311 int tty_init_termios(struct tty_struct *tty)
1313 struct ktermios *tp;
1314 int idx = tty->index;
1316 if (tty->driver->flags & TTY_DRIVER_RESET_TERMIOS)
1317 tty->termios = tty->driver->init_termios;
1319 /* Check for lazy saved data */
1320 tp = tty->driver->termios[idx];
1324 tty->termios = tty->driver->init_termios;
1326 /* Compatibility until drivers always set this */
1327 tty->termios.c_ispeed = tty_termios_input_baud_rate(&tty->termios);
1328 tty->termios.c_ospeed = tty_termios_baud_rate(&tty->termios);
1331 EXPORT_SYMBOL_GPL(tty_init_termios);
1333 int tty_standard_install(struct tty_driver *driver, struct tty_struct *tty)
1335 int ret = tty_init_termios(tty);
1339 tty_driver_kref_get(driver);
1341 driver->ttys[tty->index] = tty;
1344 EXPORT_SYMBOL_GPL(tty_standard_install);
1347 * tty_driver_install_tty() - install a tty entry in the driver
1348 * @driver: the driver for the tty
1351 * Install a tty object into the driver tables. The tty->index field
1352 * will be set by the time this is called. This method is responsible
1353 * for ensuring any need additional structures are allocated and
1356 * Locking: tty_mutex for now
1358 static int tty_driver_install_tty(struct tty_driver *driver,
1359 struct tty_struct *tty)
1361 return driver->ops->install ? driver->ops->install(driver, tty) :
1362 tty_standard_install(driver, tty);
1366 * tty_driver_remove_tty() - remove a tty from the driver tables
1367 * @driver: the driver for the tty
1368 * @idx: the minor number
1370 * Remvoe a tty object from the driver tables. The tty->index field
1371 * will be set by the time this is called.
1373 * Locking: tty_mutex for now
1375 void tty_driver_remove_tty(struct tty_driver *driver, struct tty_struct *tty)
1377 if (driver->ops->remove)
1378 driver->ops->remove(driver, tty);
1380 driver->ttys[tty->index] = NULL;
1384 * tty_reopen() - fast re-open of an open tty
1385 * @tty - the tty to open
1387 * Return 0 on success, -errno on error.
1389 * Locking: tty_mutex must be held from the time the tty was found
1390 * till this open completes.
1392 static int tty_reopen(struct tty_struct *tty)
1394 struct tty_driver *driver = tty->driver;
1396 if (test_bit(TTY_CLOSING, &tty->flags) ||
1397 test_bit(TTY_HUPPING, &tty->flags))
1400 if (driver->type == TTY_DRIVER_TYPE_PTY &&
1401 driver->subtype == PTY_TYPE_MASTER) {
1403 * special case for PTY masters: only one open permitted,
1404 * and the slave side open count is incremented as well.
1413 WARN_ON(!tty->ldisc);
1419 * tty_init_dev - initialise a tty device
1420 * @driver: tty driver we are opening a device on
1421 * @idx: device index
1422 * @ret_tty: returned tty structure
1424 * Prepare a tty device. This may not be a "new" clean device but
1425 * could also be an active device. The pty drivers require special
1426 * handling because of this.
1429 * The function is called under the tty_mutex, which
1430 * protects us from the tty struct or driver itself going away.
1432 * On exit the tty device has the line discipline attached and
1433 * a reference count of 1. If a pair was created for pty/tty use
1434 * and the other was a pty master then it too has a reference count of 1.
1436 * WSH 06/09/97: Rewritten to remove races and properly clean up after a
1437 * failed open. The new code protects the open with a mutex, so it's
1438 * really quite straightforward. The mutex locking can probably be
1439 * relaxed for the (most common) case of reopening a tty.
1442 struct tty_struct *tty_init_dev(struct tty_driver *driver, int idx)
1444 struct tty_struct *tty;
1448 * First time open is complex, especially for PTY devices.
1449 * This code guarantees that either everything succeeds and the
1450 * TTY is ready for operation, or else the table slots are vacated
1451 * and the allocated memory released. (Except that the termios
1452 * and locked termios may be retained.)
1455 if (!try_module_get(driver->owner))
1456 return ERR_PTR(-ENODEV);
1458 tty = alloc_tty_struct();
1461 goto err_module_put;
1463 initialize_tty_struct(tty, driver, idx);
1466 retval = tty_driver_install_tty(driver, tty);
1468 goto err_deinit_tty;
1471 tty->port = driver->ports[idx];
1473 WARN_RATELIMIT(!tty->port,
1474 "%s: %s driver does not set tty->port. This will crash the kernel later. Fix the driver!\n",
1475 __func__, tty->driver->name);
1477 tty->port->itty = tty;
1480 * Structures all installed ... call the ldisc open routines.
1481 * If we fail here just call release_tty to clean up. No need
1482 * to decrement the use counts, as release_tty doesn't care.
1484 retval = tty_ldisc_setup(tty, tty->link);
1486 goto err_release_tty;
1487 /* Return the tty locked so that it cannot vanish under the caller */
1492 deinitialize_tty_struct(tty);
1493 free_tty_struct(tty);
1495 module_put(driver->owner);
1496 return ERR_PTR(retval);
1498 /* call the tty release_tty routine to clean out this slot */
1501 printk_ratelimited(KERN_INFO "tty_init_dev: ldisc open failed, "
1502 "clearing slot %d\n", idx);
1503 release_tty(tty, idx);
1504 return ERR_PTR(retval);
1507 void tty_free_termios(struct tty_struct *tty)
1509 struct ktermios *tp;
1510 int idx = tty->index;
1512 /* If the port is going to reset then it has no termios to save */
1513 if (tty->driver->flags & TTY_DRIVER_RESET_TERMIOS)
1516 /* Stash the termios data */
1517 tp = tty->driver->termios[idx];
1519 tp = kmalloc(sizeof(struct ktermios), GFP_KERNEL);
1521 pr_warn("tty: no memory to save termios state.\n");
1524 tty->driver->termios[idx] = tp;
1528 EXPORT_SYMBOL(tty_free_termios);
1531 * tty_flush_works - flush all works of a tty
1532 * @tty: tty device to flush works for
1534 * Sync flush all works belonging to @tty.
1536 static void tty_flush_works(struct tty_struct *tty)
1538 flush_work(&tty->SAK_work);
1539 flush_work(&tty->hangup_work);
1543 * release_one_tty - release tty structure memory
1544 * @kref: kref of tty we are obliterating
1546 * Releases memory associated with a tty structure, and clears out the
1547 * driver table slots. This function is called when a device is no longer
1548 * in use. It also gets called when setup of a device fails.
1551 * takes the file list lock internally when working on the list
1552 * of ttys that the driver keeps.
1554 * This method gets called from a work queue so that the driver private
1555 * cleanup ops can sleep (needed for USB at least)
1557 static void release_one_tty(struct work_struct *work)
1559 struct tty_struct *tty =
1560 container_of(work, struct tty_struct, hangup_work);
1561 struct tty_driver *driver = tty->driver;
1563 if (tty->ops->cleanup)
1564 tty->ops->cleanup(tty);
1567 tty_driver_kref_put(driver);
1568 module_put(driver->owner);
1570 spin_lock(&tty_files_lock);
1571 list_del_init(&tty->tty_files);
1572 spin_unlock(&tty_files_lock);
1575 put_pid(tty->session);
1576 free_tty_struct(tty);
1579 static void queue_release_one_tty(struct kref *kref)
1581 struct tty_struct *tty = container_of(kref, struct tty_struct, kref);
1583 /* The hangup queue is now free so we can reuse it rather than
1584 waste a chunk of memory for each port */
1585 INIT_WORK(&tty->hangup_work, release_one_tty);
1586 schedule_work(&tty->hangup_work);
1590 * tty_kref_put - release a tty kref
1593 * Release a reference to a tty device and if need be let the kref
1594 * layer destruct the object for us
1597 void tty_kref_put(struct tty_struct *tty)
1600 kref_put(&tty->kref, queue_release_one_tty);
1602 EXPORT_SYMBOL(tty_kref_put);
1605 * release_tty - release tty structure memory
1607 * Release both @tty and a possible linked partner (think pty pair),
1608 * and decrement the refcount of the backing module.
1612 * takes the file list lock internally when working on the list
1613 * of ttys that the driver keeps.
1616 static void release_tty(struct tty_struct *tty, int idx)
1618 /* This should always be true but check for the moment */
1619 WARN_ON(tty->index != idx);
1620 WARN_ON(!mutex_is_locked(&tty_mutex));
1621 if (tty->ops->shutdown)
1622 tty->ops->shutdown(tty);
1623 tty_free_termios(tty);
1624 tty_driver_remove_tty(tty->driver, tty);
1625 tty->port->itty = NULL;
1627 tty->link->port->itty = NULL;
1628 cancel_work_sync(&tty->port->buf.work);
1631 tty_kref_put(tty->link);
1636 * tty_release_checks - check a tty before real release
1637 * @tty: tty to check
1638 * @o_tty: link of @tty (if any)
1639 * @idx: index of the tty
1641 * Performs some paranoid checking before true release of the @tty.
1642 * This is a no-op unless TTY_PARANOIA_CHECK is defined.
1644 static int tty_release_checks(struct tty_struct *tty, struct tty_struct *o_tty,
1647 #ifdef TTY_PARANOIA_CHECK
1648 if (idx < 0 || idx >= tty->driver->num) {
1649 printk(KERN_DEBUG "%s: bad idx when trying to free (%s)\n",
1650 __func__, tty->name);
1654 /* not much to check for devpts */
1655 if (tty->driver->flags & TTY_DRIVER_DEVPTS_MEM)
1658 if (tty != tty->driver->ttys[idx]) {
1659 printk(KERN_DEBUG "%s: driver.table[%d] not tty for (%s)\n",
1660 __func__, idx, tty->name);
1663 if (tty->driver->other) {
1664 if (o_tty != tty->driver->other->ttys[idx]) {
1665 printk(KERN_DEBUG "%s: other->table[%d] not o_tty for (%s)\n",
1666 __func__, idx, tty->name);
1669 if (o_tty->link != tty) {
1670 printk(KERN_DEBUG "%s: bad pty pointers\n", __func__);
1679 * tty_release - vfs callback for close
1680 * @inode: inode of tty
1681 * @filp: file pointer for handle to tty
1683 * Called the last time each file handle is closed that references
1684 * this tty. There may however be several such references.
1687 * Takes bkl. See tty_release_dev
1689 * Even releasing the tty structures is a tricky business.. We have
1690 * to be very careful that the structures are all released at the
1691 * same time, as interrupts might otherwise get the wrong pointers.
1693 * WSH 09/09/97: rewritten to avoid some nasty race conditions that could
1694 * lead to double frees or releasing memory still in use.
1697 int tty_release(struct inode *inode, struct file *filp)
1699 struct tty_struct *tty = file_tty(filp);
1700 struct tty_struct *o_tty;
1701 int pty_master, tty_closing, o_tty_closing, do_sleep;
1706 if (tty_paranoia_check(tty, inode, __func__))
1710 check_tty_count(tty, __func__);
1712 __tty_fasync(-1, filp, 0);
1715 pty_master = (tty->driver->type == TTY_DRIVER_TYPE_PTY &&
1716 tty->driver->subtype == PTY_TYPE_MASTER);
1717 /* Review: parallel close */
1720 if (tty_release_checks(tty, o_tty, idx)) {
1725 #ifdef TTY_DEBUG_HANGUP
1726 printk(KERN_DEBUG "%s: %s (tty count=%d)...\n", __func__,
1727 tty_name(tty, buf), tty->count);
1730 if (tty->ops->close)
1731 tty->ops->close(tty, filp);
1735 * Sanity check: if tty->count is going to zero, there shouldn't be
1736 * any waiters on tty->read_wait or tty->write_wait. We test the
1737 * wait queues and kick everyone out _before_ actually starting to
1738 * close. This ensures that we won't block while releasing the tty
1741 * The test for the o_tty closing is necessary, since the master and
1742 * slave sides may close in any order. If the slave side closes out
1743 * first, its count will be one, since the master side holds an open.
1744 * Thus this test wouldn't be triggered at the time the slave closes,
1747 * Note that it's possible for the tty to be opened again while we're
1748 * flushing out waiters. By recalculating the closing flags before
1749 * each iteration we avoid any problems.
1752 /* Guard against races with tty->count changes elsewhere and
1753 opens on /dev/tty */
1755 mutex_lock(&tty_mutex);
1756 tty_lock_pair(tty, o_tty);
1757 tty_closing = tty->count <= 1;
1758 o_tty_closing = o_tty &&
1759 (o_tty->count <= (pty_master ? 1 : 0));
1763 if (waitqueue_active(&tty->read_wait)) {
1764 wake_up_poll(&tty->read_wait, POLLIN);
1767 if (waitqueue_active(&tty->write_wait)) {
1768 wake_up_poll(&tty->write_wait, POLLOUT);
1772 if (o_tty_closing) {
1773 if (waitqueue_active(&o_tty->read_wait)) {
1774 wake_up_poll(&o_tty->read_wait, POLLIN);
1777 if (waitqueue_active(&o_tty->write_wait)) {
1778 wake_up_poll(&o_tty->write_wait, POLLOUT);
1785 printk(KERN_WARNING "%s: %s: read/write wait queue active!\n",
1786 __func__, tty_name(tty, buf));
1787 tty_unlock_pair(tty, o_tty);
1788 mutex_unlock(&tty_mutex);
1789 schedule_timeout_killable(timeout);
1790 if (timeout < 120 * HZ)
1791 timeout = 2 * timeout + 1;
1793 timeout = MAX_SCHEDULE_TIMEOUT;
1797 * The closing flags are now consistent with the open counts on
1798 * both sides, and we've completed the last operation that could
1799 * block, so it's safe to proceed with closing.
1801 * We must *not* drop the tty_mutex until we ensure that a further
1802 * entry into tty_open can not pick up this tty.
1805 if (--o_tty->count < 0) {
1806 printk(KERN_WARNING "%s: bad pty slave count (%d) for %s\n",
1807 __func__, o_tty->count, tty_name(o_tty, buf));
1811 if (--tty->count < 0) {
1812 printk(KERN_WARNING "%s: bad tty->count (%d) for %s\n",
1813 __func__, tty->count, tty_name(tty, buf));
1818 * We've decremented tty->count, so we need to remove this file
1819 * descriptor off the tty->tty_files list; this serves two
1821 * - check_tty_count sees the correct number of file descriptors
1822 * associated with this tty.
1823 * - do_tty_hangup no longer sees this file descriptor as
1824 * something that needs to be handled for hangups.
1829 * Perform some housekeeping before deciding whether to return.
1831 * Set the TTY_CLOSING flag if this was the last open. In the
1832 * case of a pty we may have to wait around for the other side
1833 * to close, and TTY_CLOSING makes sure we can't be reopened.
1836 set_bit(TTY_CLOSING, &tty->flags);
1838 set_bit(TTY_CLOSING, &o_tty->flags);
1841 * If _either_ side is closing, make sure there aren't any
1842 * processes that still think tty or o_tty is their controlling
1845 if (tty_closing || o_tty_closing) {
1846 read_lock(&tasklist_lock);
1847 session_clear_tty(tty->session);
1849 session_clear_tty(o_tty->session);
1850 read_unlock(&tasklist_lock);
1853 mutex_unlock(&tty_mutex);
1854 tty_unlock_pair(tty, o_tty);
1855 /* At this point the TTY_CLOSING flag should ensure a dead tty
1856 cannot be re-opened by a racing opener */
1858 /* check whether both sides are closing ... */
1859 if (!tty_closing || (o_tty && !o_tty_closing))
1862 #ifdef TTY_DEBUG_HANGUP
1863 printk(KERN_DEBUG "%s: %s: final close\n", __func__, tty_name(tty, buf));
1866 * Ask the line discipline code to release its structures
1868 tty_ldisc_release(tty, o_tty);
1870 /* Wait for pending work before tty destruction commmences */
1871 tty_flush_works(tty);
1873 tty_flush_works(o_tty);
1875 #ifdef TTY_DEBUG_HANGUP
1876 printk(KERN_DEBUG "%s: %s: freeing structure...\n", __func__, tty_name(tty, buf));
1879 * The release_tty function takes care of the details of clearing
1880 * the slots and preserving the termios structure. The tty_unlock_pair
1881 * should be safe as we keep a kref while the tty is locked (so the
1882 * unlock never unlocks a freed tty).
1884 mutex_lock(&tty_mutex);
1885 release_tty(tty, idx);
1886 mutex_unlock(&tty_mutex);
1892 * tty_open_current_tty - get tty of current task for open
1893 * @device: device number
1894 * @filp: file pointer to tty
1895 * @return: tty of the current task iff @device is /dev/tty
1897 * We cannot return driver and index like for the other nodes because
1898 * devpts will not work then. It expects inodes to be from devpts FS.
1900 * We need to move to returning a refcounted object from all the lookup
1901 * paths including this one.
1903 static struct tty_struct *tty_open_current_tty(dev_t device, struct file *filp)
1905 struct tty_struct *tty;
1907 if (device != MKDEV(TTYAUX_MAJOR, 0))
1910 tty = get_current_tty();
1912 return ERR_PTR(-ENXIO);
1914 filp->f_flags |= O_NONBLOCK; /* Don't let /dev/tty block */
1917 /* FIXME: we put a reference and return a TTY! */
1918 /* This is only safe because the caller holds tty_mutex */
1923 * tty_lookup_driver - lookup a tty driver for a given device file
1924 * @device: device number
1925 * @filp: file pointer to tty
1926 * @noctty: set if the device should not become a controlling tty
1927 * @index: index for the device in the @return driver
1928 * @return: driver for this inode (with increased refcount)
1930 * If @return is not erroneous, the caller is responsible to decrement the
1931 * refcount by tty_driver_kref_put.
1933 * Locking: tty_mutex protects get_tty_driver
1935 static struct tty_driver *tty_lookup_driver(dev_t device, struct file *filp,
1936 int *noctty, int *index)
1938 struct tty_driver *driver;
1942 case MKDEV(TTY_MAJOR, 0): {
1943 extern struct tty_driver *console_driver;
1944 driver = tty_driver_kref_get(console_driver);
1945 *index = fg_console;
1950 case MKDEV(TTYAUX_MAJOR, 1): {
1951 struct tty_driver *console_driver = console_device(index);
1952 if (console_driver) {
1953 driver = tty_driver_kref_get(console_driver);
1955 /* Don't let /dev/console block */
1956 filp->f_flags |= O_NONBLOCK;
1961 return ERR_PTR(-ENODEV);
1964 driver = get_tty_driver(device, index);
1966 return ERR_PTR(-ENODEV);
1973 * tty_open - open a tty device
1974 * @inode: inode of device file
1975 * @filp: file pointer to tty
1977 * tty_open and tty_release keep up the tty count that contains the
1978 * number of opens done on a tty. We cannot use the inode-count, as
1979 * different inodes might point to the same tty.
1981 * Open-counting is needed for pty masters, as well as for keeping
1982 * track of serial lines: DTR is dropped when the last close happens.
1983 * (This is not done solely through tty->count, now. - Ted 1/27/92)
1985 * The termios state of a pty is reset on first open so that
1986 * settings don't persist across reuse.
1988 * Locking: tty_mutex protects tty, tty_lookup_driver and tty_init_dev.
1989 * tty->count should protect the rest.
1990 * ->siglock protects ->signal/->sighand
1992 * Note: the tty_unlock/lock cases without a ref are only safe due to
1996 static int tty_open(struct inode *inode, struct file *filp)
1998 struct tty_struct *tty;
2000 struct tty_driver *driver = NULL;
2002 dev_t device = inode->i_rdev;
2003 unsigned saved_flags = filp->f_flags;
2005 nonseekable_open(inode, filp);
2008 retval = tty_alloc_file(filp);
2012 noctty = filp->f_flags & O_NOCTTY;
2016 mutex_lock(&tty_mutex);
2017 /* This is protected by the tty_mutex */
2018 tty = tty_open_current_tty(device, filp);
2020 retval = PTR_ERR(tty);
2023 driver = tty_lookup_driver(device, filp, &noctty, &index);
2024 if (IS_ERR(driver)) {
2025 retval = PTR_ERR(driver);
2029 /* check whether we're reopening an existing tty */
2030 tty = tty_driver_lookup_tty(driver, inode, index);
2032 retval = PTR_ERR(tty);
2039 retval = tty_reopen(tty);
2042 tty = ERR_PTR(retval);
2044 } else /* Returns with the tty_lock held for now */
2045 tty = tty_init_dev(driver, index);
2047 mutex_unlock(&tty_mutex);
2049 tty_driver_kref_put(driver);
2051 retval = PTR_ERR(tty);
2055 tty_add_file(tty, filp);
2057 check_tty_count(tty, __func__);
2058 if (tty->driver->type == TTY_DRIVER_TYPE_PTY &&
2059 tty->driver->subtype == PTY_TYPE_MASTER)
2061 #ifdef TTY_DEBUG_HANGUP
2062 printk(KERN_DEBUG "%s: opening %s...\n", __func__, tty->name);
2065 retval = tty->ops->open(tty, filp);
2068 filp->f_flags = saved_flags;
2070 if (!retval && test_bit(TTY_EXCLUSIVE, &tty->flags) &&
2071 !capable(CAP_SYS_ADMIN))
2075 #ifdef TTY_DEBUG_HANGUP
2076 printk(KERN_DEBUG "%s: error %d in opening %s...\n", __func__,
2079 tty_unlock(tty); /* need to call tty_release without BTM */
2080 tty_release(inode, filp);
2081 if (retval != -ERESTARTSYS)
2084 if (signal_pending(current))
2089 * Need to reset f_op in case a hangup happened.
2091 if (filp->f_op == &hung_up_tty_fops)
2092 filp->f_op = &tty_fops;
2095 clear_bit(TTY_HUPPED, &tty->flags);
2099 mutex_lock(&tty_mutex);
2101 spin_lock_irq(¤t->sighand->siglock);
2103 current->signal->leader &&
2104 !current->signal->tty &&
2105 tty->session == NULL)
2106 __proc_set_tty(current, tty);
2107 spin_unlock_irq(¤t->sighand->siglock);
2109 mutex_unlock(&tty_mutex);
2112 mutex_unlock(&tty_mutex);
2113 /* after locks to avoid deadlock */
2114 if (!IS_ERR_OR_NULL(driver))
2115 tty_driver_kref_put(driver);
2117 tty_free_file(filp);
2124 * tty_poll - check tty status
2125 * @filp: file being polled
2126 * @wait: poll wait structures to update
2128 * Call the line discipline polling method to obtain the poll
2129 * status of the device.
2131 * Locking: locks called line discipline but ldisc poll method
2132 * may be re-entered freely by other callers.
2135 static unsigned int tty_poll(struct file *filp, poll_table *wait)
2137 struct tty_struct *tty = file_tty(filp);
2138 struct tty_ldisc *ld;
2141 if (tty_paranoia_check(tty, file_inode(filp), "tty_poll"))
2144 pr_debug("[TTY_DEBUG tty_poll]pid %d\n",current->pid);
2146 ld = tty_ldisc_ref_wait(tty);
2148 ret = (ld->ops->poll)(tty, filp, wait);
2149 tty_ldisc_deref(ld);
2153 static int __tty_fasync(int fd, struct file *filp, int on)
2155 struct tty_struct *tty = file_tty(filp);
2156 struct tty_ldisc *ldisc;
2157 unsigned long flags;
2160 if (tty_paranoia_check(tty, file_inode(filp), "tty_fasync"))
2163 retval = fasync_helper(fd, filp, on, &tty->fasync);
2167 ldisc = tty_ldisc_ref(tty);
2169 if (ldisc->ops->fasync)
2170 ldisc->ops->fasync(tty, on);
2171 tty_ldisc_deref(ldisc);
2178 spin_lock_irqsave(&tty->ctrl_lock, flags);
2181 type = PIDTYPE_PGID;
2183 pid = task_pid(current);
2187 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
2188 retval = __f_setown(filp, pid, type, 0);
2195 static int tty_fasync(int fd, struct file *filp, int on)
2197 struct tty_struct *tty = file_tty(filp);
2201 retval = __tty_fasync(fd, filp, on);
2208 * tiocsti - fake input character
2209 * @tty: tty to fake input into
2210 * @p: pointer to character
2212 * Fake input to a tty device. Does the necessary locking and
2215 * FIXME: does not honour flow control ??
2218 * Called functions take tty_ldisc_lock
2219 * current->signal->tty check is safe without locks
2221 * FIXME: may race normal receive processing
2224 static int tiocsti(struct tty_struct *tty, char __user *p)
2227 struct tty_ldisc *ld;
2229 if ((current->signal->tty != tty) && !capable(CAP_SYS_ADMIN))
2231 if (get_user(ch, p))
2233 tty_audit_tiocsti(tty, ch);
2234 ld = tty_ldisc_ref_wait(tty);
2235 ld->ops->receive_buf(tty, &ch, &mbz, 1);
2236 tty_ldisc_deref(ld);
2241 * tiocgwinsz - implement window query ioctl
2243 * @arg: user buffer for result
2245 * Copies the kernel idea of the window size into the user buffer.
2247 * Locking: tty->termios_mutex is taken to ensure the winsize data
2251 static int tiocgwinsz(struct tty_struct *tty, struct winsize __user *arg)
2255 mutex_lock(&tty->winsize_mutex);
2256 err = copy_to_user(arg, &tty->winsize, sizeof(*arg));
2257 mutex_unlock(&tty->winsize_mutex);
2259 return err ? -EFAULT: 0;
2263 * tty_do_resize - resize event
2264 * @tty: tty being resized
2265 * @rows: rows (character)
2266 * @cols: cols (character)
2268 * Update the termios variables and send the necessary signals to
2269 * peform a terminal resize correctly
2272 int tty_do_resize(struct tty_struct *tty, struct winsize *ws)
2275 unsigned long flags;
2278 mutex_lock(&tty->winsize_mutex);
2279 if (!memcmp(ws, &tty->winsize, sizeof(*ws)))
2281 /* Get the PID values and reference them so we can
2282 avoid holding the tty ctrl lock while sending signals */
2283 spin_lock_irqsave(&tty->ctrl_lock, flags);
2284 pgrp = get_pid(tty->pgrp);
2285 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
2288 kill_pgrp(pgrp, SIGWINCH, 1);
2293 mutex_unlock(&tty->winsize_mutex);
2296 EXPORT_SYMBOL(tty_do_resize);
2299 * tiocswinsz - implement window size set ioctl
2300 * @tty; tty side of tty
2301 * @arg: user buffer for result
2303 * Copies the user idea of the window size to the kernel. Traditionally
2304 * this is just advisory information but for the Linux console it
2305 * actually has driver level meaning and triggers a VC resize.
2308 * Driver dependent. The default do_resize method takes the
2309 * tty termios mutex and ctrl_lock. The console takes its own lock
2310 * then calls into the default method.
2313 static int tiocswinsz(struct tty_struct *tty, struct winsize __user *arg)
2315 struct winsize tmp_ws;
2316 if (copy_from_user(&tmp_ws, arg, sizeof(*arg)))
2319 if (tty->ops->resize)
2320 return tty->ops->resize(tty, &tmp_ws);
2322 return tty_do_resize(tty, &tmp_ws);
2326 * tioccons - allow admin to move logical console
2327 * @file: the file to become console
2329 * Allow the administrator to move the redirected console device
2331 * Locking: uses redirect_lock to guard the redirect information
2334 static int tioccons(struct file *file)
2336 if (!capable(CAP_SYS_ADMIN))
2338 if (file->f_op->write == redirected_tty_write) {
2340 spin_lock(&redirect_lock);
2343 spin_unlock(&redirect_lock);
2348 spin_lock(&redirect_lock);
2350 spin_unlock(&redirect_lock);
2353 redirect = get_file(file);
2354 spin_unlock(&redirect_lock);
2359 * fionbio - non blocking ioctl
2360 * @file: file to set blocking value
2361 * @p: user parameter
2363 * Historical tty interfaces had a blocking control ioctl before
2364 * the generic functionality existed. This piece of history is preserved
2365 * in the expected tty API of posix OS's.
2367 * Locking: none, the open file handle ensures it won't go away.
2370 static int fionbio(struct file *file, int __user *p)
2374 if (get_user(nonblock, p))
2377 spin_lock(&file->f_lock);
2379 file->f_flags |= O_NONBLOCK;
2381 file->f_flags &= ~O_NONBLOCK;
2382 spin_unlock(&file->f_lock);
2387 * tiocsctty - set controlling tty
2388 * @tty: tty structure
2389 * @arg: user argument
2391 * This ioctl is used to manage job control. It permits a session
2392 * leader to set this tty as the controlling tty for the session.
2395 * Takes tty_mutex() to protect tty instance
2396 * Takes tasklist_lock internally to walk sessions
2397 * Takes ->siglock() when updating signal->tty
2400 static int tiocsctty(struct tty_struct *tty, int arg)
2403 if (current->signal->leader && (task_session(current) == tty->session))
2406 mutex_lock(&tty_mutex);
2408 * The process must be a session leader and
2409 * not have a controlling tty already.
2411 if (!current->signal->leader || current->signal->tty) {
2418 * This tty is already the controlling
2419 * tty for another session group!
2421 if (arg == 1 && capable(CAP_SYS_ADMIN)) {
2425 read_lock(&tasklist_lock);
2426 session_clear_tty(tty->session);
2427 read_unlock(&tasklist_lock);
2433 proc_set_tty(current, tty);
2435 mutex_unlock(&tty_mutex);
2440 * tty_get_pgrp - return a ref counted pgrp pid
2443 * Returns a refcounted instance of the pid struct for the process
2444 * group controlling the tty.
2447 struct pid *tty_get_pgrp(struct tty_struct *tty)
2449 unsigned long flags;
2452 spin_lock_irqsave(&tty->ctrl_lock, flags);
2453 pgrp = get_pid(tty->pgrp);
2454 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
2458 EXPORT_SYMBOL_GPL(tty_get_pgrp);
2461 * tiocgpgrp - get process group
2462 * @tty: tty passed by user
2463 * @real_tty: tty side of the tty passed by the user if a pty else the tty
2466 * Obtain the process group of the tty. If there is no process group
2469 * Locking: none. Reference to current->signal->tty is safe.
2472 static int tiocgpgrp(struct tty_struct *tty, struct tty_struct *real_tty, pid_t __user *p)
2477 * (tty == real_tty) is a cheap way of
2478 * testing if the tty is NOT a master pty.
2480 if (tty == real_tty && current->signal->tty != real_tty)
2482 pid = tty_get_pgrp(real_tty);
2483 ret = put_user(pid_vnr(pid), p);
2489 * tiocspgrp - attempt to set process group
2490 * @tty: tty passed by user
2491 * @real_tty: tty side device matching tty passed by user
2494 * Set the process group of the tty to the session passed. Only
2495 * permitted where the tty session is our session.
2497 * Locking: RCU, ctrl lock
2500 static int tiocspgrp(struct tty_struct *tty, struct tty_struct *real_tty, pid_t __user *p)
2504 int retval = tty_check_change(real_tty);
2505 unsigned long flags;
2511 if (!current->signal->tty ||
2512 (current->signal->tty != real_tty) ||
2513 (real_tty->session != task_session(current)))
2515 if (get_user(pgrp_nr, p))
2520 pgrp = find_vpid(pgrp_nr);
2525 if (session_of_pgrp(pgrp) != task_session(current))
2528 spin_lock_irqsave(&tty->ctrl_lock, flags);
2529 put_pid(real_tty->pgrp);
2530 real_tty->pgrp = get_pid(pgrp);
2531 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
2538 * tiocgsid - get session id
2539 * @tty: tty passed by user
2540 * @real_tty: tty side of the tty passed by the user if a pty else the tty
2541 * @p: pointer to returned session id
2543 * Obtain the session id of the tty. If there is no session
2546 * Locking: none. Reference to current->signal->tty is safe.
2549 static int tiocgsid(struct tty_struct *tty, struct tty_struct *real_tty, pid_t __user *p)
2552 * (tty == real_tty) is a cheap way of
2553 * testing if the tty is NOT a master pty.
2555 if (tty == real_tty && current->signal->tty != real_tty)
2557 if (!real_tty->session)
2559 return put_user(pid_vnr(real_tty->session), p);
2563 * tiocsetd - set line discipline
2565 * @p: pointer to user data
2567 * Set the line discipline according to user request.
2569 * Locking: see tty_set_ldisc, this function is just a helper
2572 static int tiocsetd(struct tty_struct *tty, int __user *p)
2577 if (get_user(ldisc, p))
2580 ret = tty_set_ldisc(tty, ldisc);
2586 * send_break - performed time break
2587 * @tty: device to break on
2588 * @duration: timeout in mS
2590 * Perform a timed break on hardware that lacks its own driver level
2591 * timed break functionality.
2594 * atomic_write_lock serializes
2598 static int send_break(struct tty_struct *tty, unsigned int duration)
2602 if (tty->ops->break_ctl == NULL)
2605 if (tty->driver->flags & TTY_DRIVER_HARDWARE_BREAK)
2606 retval = tty->ops->break_ctl(tty, duration);
2608 /* Do the work ourselves */
2609 if (tty_write_lock(tty, 0) < 0)
2611 retval = tty->ops->break_ctl(tty, -1);
2614 if (!signal_pending(current))
2615 msleep_interruptible(duration);
2616 retval = tty->ops->break_ctl(tty, 0);
2618 tty_write_unlock(tty);
2619 if (signal_pending(current))
2626 * tty_tiocmget - get modem status
2628 * @file: user file pointer
2629 * @p: pointer to result
2631 * Obtain the modem status bits from the tty driver if the feature
2632 * is supported. Return -EINVAL if it is not available.
2634 * Locking: none (up to the driver)
2637 static int tty_tiocmget(struct tty_struct *tty, int __user *p)
2639 int retval = -EINVAL;
2641 if (tty->ops->tiocmget) {
2642 retval = tty->ops->tiocmget(tty);
2645 retval = put_user(retval, p);
2651 * tty_tiocmset - set modem status
2653 * @cmd: command - clear bits, set bits or set all
2654 * @p: pointer to desired bits
2656 * Set the modem status bits from the tty driver if the feature
2657 * is supported. Return -EINVAL if it is not available.
2659 * Locking: none (up to the driver)
2662 static int tty_tiocmset(struct tty_struct *tty, unsigned int cmd,
2666 unsigned int set, clear, val;
2668 if (tty->ops->tiocmset == NULL)
2671 retval = get_user(val, p);
2687 set &= TIOCM_DTR|TIOCM_RTS|TIOCM_OUT1|TIOCM_OUT2|TIOCM_LOOP;
2688 clear &= TIOCM_DTR|TIOCM_RTS|TIOCM_OUT1|TIOCM_OUT2|TIOCM_LOOP;
2689 return tty->ops->tiocmset(tty, set, clear);
2692 static int tty_tiocgicount(struct tty_struct *tty, void __user *arg)
2694 int retval = -EINVAL;
2695 struct serial_icounter_struct icount;
2696 memset(&icount, 0, sizeof(icount));
2697 if (tty->ops->get_icount)
2698 retval = tty->ops->get_icount(tty, &icount);
2701 if (copy_to_user(arg, &icount, sizeof(icount)))
2706 struct tty_struct *tty_pair_get_tty(struct tty_struct *tty)
2708 if (tty->driver->type == TTY_DRIVER_TYPE_PTY &&
2709 tty->driver->subtype == PTY_TYPE_MASTER)
2713 EXPORT_SYMBOL(tty_pair_get_tty);
2715 struct tty_struct *tty_pair_get_pty(struct tty_struct *tty)
2717 if (tty->driver->type == TTY_DRIVER_TYPE_PTY &&
2718 tty->driver->subtype == PTY_TYPE_MASTER)
2722 EXPORT_SYMBOL(tty_pair_get_pty);
2725 * Split this up, as gcc can choke on it otherwise..
2727 long tty_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
2729 struct tty_struct *tty = file_tty(file);
2730 struct tty_struct *real_tty;
2731 void __user *p = (void __user *)arg;
2733 struct tty_ldisc *ld;
2735 if (tty_paranoia_check(tty, file_inode(file), "tty_ioctl"))
2738 real_tty = tty_pair_get_tty(tty);
2741 * Factor out some common prep work
2749 retval = tty_check_change(tty);
2752 if (cmd != TIOCCBRK) {
2753 tty_wait_until_sent(tty, 0);
2754 if (signal_pending(current))
2765 return tiocsti(tty, p);
2767 return tiocgwinsz(real_tty, p);
2769 return tiocswinsz(real_tty, p);
2771 return real_tty != tty ? -EINVAL : tioccons(file);
2773 return fionbio(file, p);
2775 set_bit(TTY_EXCLUSIVE, &tty->flags);
2778 clear_bit(TTY_EXCLUSIVE, &tty->flags);
2782 int excl = test_bit(TTY_EXCLUSIVE, &tty->flags);
2783 return put_user(excl, (int __user *)p);
2786 if (current->signal->tty != tty)
2791 return tiocsctty(tty, arg);
2793 return tiocgpgrp(tty, real_tty, p);
2795 return tiocspgrp(tty, real_tty, p);
2797 return tiocgsid(tty, real_tty, p);
2799 return put_user(tty->ldisc->ops->num, (int __user *)p);
2801 return tiocsetd(tty, p);
2803 if (!capable(CAP_SYS_ADMIN))
2809 unsigned int ret = new_encode_dev(tty_devnum(real_tty));
2810 return put_user(ret, (unsigned int __user *)p);
2815 case TIOCSBRK: /* Turn break on, unconditionally */
2816 if (tty->ops->break_ctl)
2817 return tty->ops->break_ctl(tty, -1);
2819 case TIOCCBRK: /* Turn break off, unconditionally */
2820 if (tty->ops->break_ctl)
2821 return tty->ops->break_ctl(tty, 0);
2823 case TCSBRK: /* SVID version: non-zero arg --> no break */
2824 /* non-zero arg means wait for all output data
2825 * to be sent (performed above) but don't send break.
2826 * This is used by the tcdrain() termios function.
2829 return send_break(tty, 250);
2831 case TCSBRKP: /* support for POSIX tcsendbreak() */
2832 return send_break(tty, arg ? arg*100 : 250);
2835 return tty_tiocmget(tty, p);
2839 return tty_tiocmset(tty, cmd, p);
2841 retval = tty_tiocgicount(tty, p);
2842 /* For the moment allow fall through to the old method */
2843 if (retval != -EINVAL)
2850 /* flush tty buffer and allow ldisc to process ioctl */
2851 tty_buffer_flush(tty);
2856 if (tty->ops->ioctl) {
2857 retval = (tty->ops->ioctl)(tty, cmd, arg);
2858 if (retval != -ENOIOCTLCMD)
2861 ld = tty_ldisc_ref_wait(tty);
2863 if (ld->ops->ioctl) {
2864 retval = ld->ops->ioctl(tty, file, cmd, arg);
2865 if (retval == -ENOIOCTLCMD)
2868 tty_ldisc_deref(ld);
2872 #ifdef CONFIG_COMPAT
2873 static long tty_compat_ioctl(struct file *file, unsigned int cmd,
2876 struct tty_struct *tty = file_tty(file);
2877 struct tty_ldisc *ld;
2878 int retval = -ENOIOCTLCMD;
2880 if (tty_paranoia_check(tty, file_inode(file), "tty_ioctl"))
2883 if (tty->ops->compat_ioctl) {
2884 retval = (tty->ops->compat_ioctl)(tty, cmd, arg);
2885 if (retval != -ENOIOCTLCMD)
2889 ld = tty_ldisc_ref_wait(tty);
2890 if (ld->ops->compat_ioctl)
2891 retval = ld->ops->compat_ioctl(tty, file, cmd, arg);
2893 retval = n_tty_compat_ioctl_helper(tty, file, cmd, arg);
2894 tty_ldisc_deref(ld);
2900 static int this_tty(const void *t, struct file *file, unsigned fd)
2902 if (likely(file->f_op->read != tty_read))
2904 return file_tty(file) != t ? 0 : fd + 1;
2908 * This implements the "Secure Attention Key" --- the idea is to
2909 * prevent trojan horses by killing all processes associated with this
2910 * tty when the user hits the "Secure Attention Key". Required for
2911 * super-paranoid applications --- see the Orange Book for more details.
2913 * This code could be nicer; ideally it should send a HUP, wait a few
2914 * seconds, then send a INT, and then a KILL signal. But you then
2915 * have to coordinate with the init process, since all processes associated
2916 * with the current tty must be dead before the new getty is allowed
2919 * Now, if it would be correct ;-/ The current code has a nasty hole -
2920 * it doesn't catch files in flight. We may send the descriptor to ourselves
2921 * via AF_UNIX socket, close it and later fetch from socket. FIXME.
2923 * Nasty bug: do_SAK is being called in interrupt context. This can
2924 * deadlock. We punt it up to process context. AKPM - 16Mar2001
2926 void __do_SAK(struct tty_struct *tty)
2931 struct task_struct *g, *p;
2932 struct pid *session;
2937 session = tty->session;
2939 tty_ldisc_flush(tty);
2941 tty_driver_flush_buffer(tty);
2943 read_lock(&tasklist_lock);
2944 /* Kill the entire session */
2945 do_each_pid_task(session, PIDTYPE_SID, p) {
2946 printk(KERN_NOTICE "SAK: killed process %d"
2947 " (%s): task_session(p)==tty->session\n",
2948 task_pid_nr(p), p->comm);
2949 send_sig(SIGKILL, p, 1);
2950 } while_each_pid_task(session, PIDTYPE_SID, p);
2951 /* Now kill any processes that happen to have the
2954 do_each_thread(g, p) {
2955 if (p->signal->tty == tty) {
2956 printk(KERN_NOTICE "SAK: killed process %d"
2957 " (%s): task_session(p)==tty->session\n",
2958 task_pid_nr(p), p->comm);
2959 send_sig(SIGKILL, p, 1);
2963 i = iterate_fd(p->files, 0, this_tty, tty);
2965 printk(KERN_NOTICE "SAK: killed process %d"
2966 " (%s): fd#%d opened to the tty\n",
2967 task_pid_nr(p), p->comm, i - 1);
2968 force_sig(SIGKILL, p);
2971 } while_each_thread(g, p);
2972 read_unlock(&tasklist_lock);
2976 static void do_SAK_work(struct work_struct *work)
2978 struct tty_struct *tty =
2979 container_of(work, struct tty_struct, SAK_work);
2984 * The tq handling here is a little racy - tty->SAK_work may already be queued.
2985 * Fortunately we don't need to worry, because if ->SAK_work is already queued,
2986 * the values which we write to it will be identical to the values which it
2987 * already has. --akpm
2989 void do_SAK(struct tty_struct *tty)
2993 schedule_work(&tty->SAK_work);
2996 EXPORT_SYMBOL(do_SAK);
2998 static int dev_match_devt(struct device *dev, const void *data)
3000 const dev_t *devt = data;
3001 return dev->devt == *devt;
3004 /* Must put_device() after it's unused! */
3005 static struct device *tty_get_device(struct tty_struct *tty)
3007 dev_t devt = tty_devnum(tty);
3008 return class_find_device(tty_class, NULL, &devt, dev_match_devt);
3013 * initialize_tty_struct
3014 * @tty: tty to initialize
3016 * This subroutine initializes a tty structure that has been newly
3019 * Locking: none - tty in question must not be exposed at this point
3022 void initialize_tty_struct(struct tty_struct *tty,
3023 struct tty_driver *driver, int idx)
3025 memset(tty, 0, sizeof(struct tty_struct));
3026 kref_init(&tty->kref);
3027 tty->magic = TTY_MAGIC;
3028 tty_ldisc_init(tty);
3029 tty->session = NULL;
3031 mutex_init(&tty->legacy_mutex);
3032 mutex_init(&tty->throttle_mutex);
3033 init_rwsem(&tty->termios_rwsem);
3034 mutex_init(&tty->winsize_mutex);
3035 init_ldsem(&tty->ldisc_sem);
3036 init_waitqueue_head(&tty->write_wait);
3037 init_waitqueue_head(&tty->read_wait);
3038 INIT_WORK(&tty->hangup_work, do_tty_hangup);
3039 mutex_init(&tty->atomic_write_lock);
3040 spin_lock_init(&tty->ctrl_lock);
3041 INIT_LIST_HEAD(&tty->tty_files);
3042 INIT_WORK(&tty->SAK_work, do_SAK_work);
3044 tty->driver = driver;
3045 tty->ops = driver->ops;
3047 tty_line_name(driver, idx, tty->name);
3048 tty->dev = tty_get_device(tty);
3052 * deinitialize_tty_struct
3053 * @tty: tty to deinitialize
3055 * This subroutine deinitializes a tty structure that has been newly
3056 * allocated but tty_release cannot be called on that yet.
3058 * Locking: none - tty in question must not be exposed at this point
3060 void deinitialize_tty_struct(struct tty_struct *tty)
3062 tty_ldisc_deinit(tty);
3066 * tty_put_char - write one character to a tty
3070 * Write one byte to the tty using the provided put_char method
3071 * if present. Returns the number of characters successfully output.
3073 * Note: the specific put_char operation in the driver layer may go
3074 * away soon. Don't call it directly, use this method
3077 int tty_put_char(struct tty_struct *tty, unsigned char ch)
3079 if (tty->ops->put_char)
3080 return tty->ops->put_char(tty, ch);
3081 return tty->ops->write(tty, &ch, 1);
3083 EXPORT_SYMBOL_GPL(tty_put_char);
3085 struct class *tty_class;
3087 static int tty_cdev_add(struct tty_driver *driver, dev_t dev,
3088 unsigned int index, unsigned int count)
3090 /* init here, since reused cdevs cause crashes */
3091 cdev_init(&driver->cdevs[index], &tty_fops);
3092 driver->cdevs[index].owner = driver->owner;
3093 return cdev_add(&driver->cdevs[index], dev, count);
3097 * tty_register_device - register a tty device
3098 * @driver: the tty driver that describes the tty device
3099 * @index: the index in the tty driver for this tty device
3100 * @device: a struct device that is associated with this tty device.
3101 * This field is optional, if there is no known struct device
3102 * for this tty device it can be set to NULL safely.
3104 * Returns a pointer to the struct device for this tty device
3105 * (or ERR_PTR(-EFOO) on error).
3107 * This call is required to be made to register an individual tty device
3108 * if the tty driver's flags have the TTY_DRIVER_DYNAMIC_DEV bit set. If
3109 * that bit is not set, this function should not be called by a tty
3115 struct device *tty_register_device(struct tty_driver *driver, unsigned index,
3116 struct device *device)
3118 return tty_register_device_attr(driver, index, device, NULL, NULL);
3120 EXPORT_SYMBOL(tty_register_device);
3122 static void tty_device_create_release(struct device *dev)
3124 pr_debug("device: '%s': %s\n", dev_name(dev), __func__);
3129 * tty_register_device_attr - register a tty device
3130 * @driver: the tty driver that describes the tty device
3131 * @index: the index in the tty driver for this tty device
3132 * @device: a struct device that is associated with this tty device.
3133 * This field is optional, if there is no known struct device
3134 * for this tty device it can be set to NULL safely.
3135 * @drvdata: Driver data to be set to device.
3136 * @attr_grp: Attribute group to be set on device.
3138 * Returns a pointer to the struct device for this tty device
3139 * (or ERR_PTR(-EFOO) on error).
3141 * This call is required to be made to register an individual tty device
3142 * if the tty driver's flags have the TTY_DRIVER_DYNAMIC_DEV bit set. If
3143 * that bit is not set, this function should not be called by a tty
3148 struct device *tty_register_device_attr(struct tty_driver *driver,
3149 unsigned index, struct device *device,
3151 const struct attribute_group **attr_grp)
3154 dev_t devt = MKDEV(driver->major, driver->minor_start) + index;
3155 struct device *dev = NULL;
3156 int retval = -ENODEV;
3159 if (index >= driver->num) {
3160 printk(KERN_ERR "Attempt to register invalid tty line number "
3162 return ERR_PTR(-EINVAL);
3165 if (driver->type == TTY_DRIVER_TYPE_PTY)
3166 pty_line_name(driver, index, name);
3168 tty_line_name(driver, index, name);
3170 if (!(driver->flags & TTY_DRIVER_DYNAMIC_ALLOC)) {
3171 retval = tty_cdev_add(driver, devt, index, 1);
3177 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
3184 dev->class = tty_class;
3185 dev->parent = device;
3186 dev->release = tty_device_create_release;
3187 dev_set_name(dev, "%s", name);
3188 dev->groups = attr_grp;
3189 dev_set_drvdata(dev, drvdata);
3191 retval = device_register(dev);
3200 cdev_del(&driver->cdevs[index]);
3201 return ERR_PTR(retval);
3203 EXPORT_SYMBOL_GPL(tty_register_device_attr);
3206 * tty_unregister_device - unregister a tty device
3207 * @driver: the tty driver that describes the tty device
3208 * @index: the index in the tty driver for this tty device
3210 * If a tty device is registered with a call to tty_register_device() then
3211 * this function must be called when the tty device is gone.
3216 void tty_unregister_device(struct tty_driver *driver, unsigned index)
3218 device_destroy(tty_class,
3219 MKDEV(driver->major, driver->minor_start) + index);
3220 if (!(driver->flags & TTY_DRIVER_DYNAMIC_ALLOC))
3221 cdev_del(&driver->cdevs[index]);
3223 EXPORT_SYMBOL(tty_unregister_device);
3226 * __tty_alloc_driver -- allocate tty driver
3227 * @lines: count of lines this driver can handle at most
3228 * @owner: module which is repsonsible for this driver
3229 * @flags: some of TTY_DRIVER_* flags, will be set in driver->flags
3231 * This should not be called directly, some of the provided macros should be
3232 * used instead. Use IS_ERR and friends on @retval.
3234 struct tty_driver *__tty_alloc_driver(unsigned int lines, struct module *owner,
3235 unsigned long flags)
3237 struct tty_driver *driver;
3238 unsigned int cdevs = 1;
3241 if (!lines || (flags & TTY_DRIVER_UNNUMBERED_NODE && lines > 1))
3242 return ERR_PTR(-EINVAL);
3244 driver = kzalloc(sizeof(struct tty_driver), GFP_KERNEL);
3246 return ERR_PTR(-ENOMEM);
3248 kref_init(&driver->kref);
3249 driver->magic = TTY_DRIVER_MAGIC;
3250 driver->num = lines;
3251 driver->owner = owner;
3252 driver->flags = flags;
3254 if (!(flags & TTY_DRIVER_DEVPTS_MEM)) {
3255 driver->ttys = kcalloc(lines, sizeof(*driver->ttys),
3257 driver->termios = kcalloc(lines, sizeof(*driver->termios),
3259 if (!driver->ttys || !driver->termios) {
3265 if (!(flags & TTY_DRIVER_DYNAMIC_ALLOC)) {
3266 driver->ports = kcalloc(lines, sizeof(*driver->ports),
3268 if (!driver->ports) {
3275 driver->cdevs = kcalloc(cdevs, sizeof(*driver->cdevs), GFP_KERNEL);
3276 if (!driver->cdevs) {
3283 kfree(driver->ports);
3284 kfree(driver->ttys);
3285 kfree(driver->termios);
3287 return ERR_PTR(err);
3289 EXPORT_SYMBOL(__tty_alloc_driver);
3291 static void destruct_tty_driver(struct kref *kref)
3293 struct tty_driver *driver = container_of(kref, struct tty_driver, kref);
3295 struct ktermios *tp;
3297 if (driver->flags & TTY_DRIVER_INSTALLED) {
3299 * Free the termios and termios_locked structures because
3300 * we don't want to get memory leaks when modular tty
3301 * drivers are removed from the kernel.
3303 for (i = 0; i < driver->num; i++) {
3304 tp = driver->termios[i];
3306 driver->termios[i] = NULL;
3309 if (!(driver->flags & TTY_DRIVER_DYNAMIC_DEV))
3310 tty_unregister_device(driver, i);
3312 proc_tty_unregister_driver(driver);
3313 if (driver->flags & TTY_DRIVER_DYNAMIC_ALLOC)
3314 cdev_del(&driver->cdevs[0]);
3316 kfree(driver->cdevs);
3317 kfree(driver->ports);
3318 kfree(driver->termios);
3319 kfree(driver->ttys);
3323 void tty_driver_kref_put(struct tty_driver *driver)
3325 kref_put(&driver->kref, destruct_tty_driver);
3327 EXPORT_SYMBOL(tty_driver_kref_put);
3329 void tty_set_operations(struct tty_driver *driver,
3330 const struct tty_operations *op)
3334 EXPORT_SYMBOL(tty_set_operations);
3336 void put_tty_driver(struct tty_driver *d)
3338 tty_driver_kref_put(d);
3340 EXPORT_SYMBOL(put_tty_driver);
3343 * Called by a tty driver to register itself.
3345 int tty_register_driver(struct tty_driver *driver)
3352 if (!driver->major) {
3353 error = alloc_chrdev_region(&dev, driver->minor_start,
3354 driver->num, driver->name);
3356 driver->major = MAJOR(dev);
3357 driver->minor_start = MINOR(dev);
3360 dev = MKDEV(driver->major, driver->minor_start);
3361 error = register_chrdev_region(dev, driver->num, driver->name);
3366 if (driver->flags & TTY_DRIVER_DYNAMIC_ALLOC) {
3367 error = tty_cdev_add(driver, dev, 0, driver->num);
3369 goto err_unreg_char;
3372 mutex_lock(&tty_mutex);
3373 list_add(&driver->tty_drivers, &tty_drivers);
3374 mutex_unlock(&tty_mutex);
3376 if (!(driver->flags & TTY_DRIVER_DYNAMIC_DEV)) {
3377 for (i = 0; i < driver->num; i++) {
3378 d = tty_register_device(driver, i, NULL);
3381 goto err_unreg_devs;
3385 proc_tty_register_driver(driver);
3386 driver->flags |= TTY_DRIVER_INSTALLED;
3390 for (i--; i >= 0; i--)
3391 tty_unregister_device(driver, i);
3393 mutex_lock(&tty_mutex);
3394 list_del(&driver->tty_drivers);
3395 mutex_unlock(&tty_mutex);
3398 unregister_chrdev_region(dev, driver->num);
3402 EXPORT_SYMBOL(tty_register_driver);
3405 * Called by a tty driver to unregister itself.
3407 int tty_unregister_driver(struct tty_driver *driver)
3411 if (driver->refcount)
3414 unregister_chrdev_region(MKDEV(driver->major, driver->minor_start),
3416 mutex_lock(&tty_mutex);
3417 list_del(&driver->tty_drivers);
3418 mutex_unlock(&tty_mutex);
3422 EXPORT_SYMBOL(tty_unregister_driver);
3424 dev_t tty_devnum(struct tty_struct *tty)
3426 return MKDEV(tty->driver->major, tty->driver->minor_start) + tty->index;
3428 EXPORT_SYMBOL(tty_devnum);
3430 void proc_clear_tty(struct task_struct *p)
3432 unsigned long flags;
3433 struct tty_struct *tty;
3434 spin_lock_irqsave(&p->sighand->siglock, flags);
3435 tty = p->signal->tty;
3436 p->signal->tty = NULL;
3437 spin_unlock_irqrestore(&p->sighand->siglock, flags);
3441 /* Called under the sighand lock */
3443 static void __proc_set_tty(struct task_struct *tsk, struct tty_struct *tty)
3446 unsigned long flags;
3447 /* We should not have a session or pgrp to put here but.... */
3448 spin_lock_irqsave(&tty->ctrl_lock, flags);
3449 put_pid(tty->session);
3451 tty->pgrp = get_pid(task_pgrp(tsk));
3452 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
3453 tty->session = get_pid(task_session(tsk));
3454 if (tsk->signal->tty) {
3455 printk(KERN_DEBUG "tty not NULL!!\n");
3456 tty_kref_put(tsk->signal->tty);
3459 put_pid(tsk->signal->tty_old_pgrp);
3460 tsk->signal->tty = tty_kref_get(tty);
3461 tsk->signal->tty_old_pgrp = NULL;
3464 static void proc_set_tty(struct task_struct *tsk, struct tty_struct *tty)
3466 spin_lock_irq(&tsk->sighand->siglock);
3467 __proc_set_tty(tsk, tty);
3468 spin_unlock_irq(&tsk->sighand->siglock);
3471 struct tty_struct *get_current_tty(void)
3473 struct tty_struct *tty;
3474 unsigned long flags;
3476 spin_lock_irqsave(¤t->sighand->siglock, flags);
3477 tty = tty_kref_get(current->signal->tty);
3478 spin_unlock_irqrestore(¤t->sighand->siglock, flags);
3481 EXPORT_SYMBOL_GPL(get_current_tty);
3483 void tty_default_fops(struct file_operations *fops)
3489 * Initialize the console device. This is called *early*, so
3490 * we can't necessarily depend on lots of kernel help here.
3491 * Just do some early initializations, and do the complex setup
3494 void __init console_init(void)
3498 /* Setup the default TTY line discipline. */
3502 * set up the console device so that later boot sequences can
3503 * inform about problems etc..
3505 call = __con_initcall_start;
3506 while (call < __con_initcall_end) {
3512 static char *tty_devnode(struct device *dev, umode_t *mode)
3516 if (dev->devt == MKDEV(TTYAUX_MAJOR, 0) ||
3517 dev->devt == MKDEV(TTYAUX_MAJOR, 2))
3522 static int __init tty_class_init(void)
3524 tty_class = class_create(THIS_MODULE, "tty");
3525 if (IS_ERR(tty_class))
3526 return PTR_ERR(tty_class);
3527 tty_class->devnode = tty_devnode;
3531 postcore_initcall(tty_class_init);
3533 /* 3/2004 jmc: why do these devices exist? */
3534 static struct cdev tty_cdev, console_cdev;
3536 static ssize_t show_cons_active(struct device *dev,
3537 struct device_attribute *attr, char *buf)
3539 struct console *cs[16];
3545 for_each_console(c) {
3550 if ((c->flags & CON_ENABLED) == 0)
3553 if (i >= ARRAY_SIZE(cs))
3557 int index = cs[i]->index;
3558 struct tty_driver *drv = cs[i]->device(cs[i], &index);
3560 /* don't resolve tty0 as some programs depend on it */
3561 if (drv && (cs[i]->index > 0 || drv->major != TTY_MAJOR))
3562 count += tty_line_name(drv, index, buf + count);
3564 count += sprintf(buf + count, "%s%d",
3565 cs[i]->name, cs[i]->index);
3567 count += sprintf(buf + count, "%c", i ? ' ':'\n');
3573 static DEVICE_ATTR(active, S_IRUGO, show_cons_active, NULL);
3575 static struct device *consdev;
3577 void console_sysfs_notify(void)
3580 sysfs_notify(&consdev->kobj, NULL, "active");
3584 * Ok, now we can initialize the rest of the tty devices and can count
3585 * on memory allocations, interrupts etc..
3587 int __init tty_init(void)
3589 cdev_init(&tty_cdev, &tty_fops);
3590 if (cdev_add(&tty_cdev, MKDEV(TTYAUX_MAJOR, 0), 1) ||
3591 register_chrdev_region(MKDEV(TTYAUX_MAJOR, 0), 1, "/dev/tty") < 0)
3592 panic("Couldn't register /dev/tty driver\n");
3593 device_create(tty_class, NULL, MKDEV(TTYAUX_MAJOR, 0), NULL, "tty");
3595 cdev_init(&console_cdev, &console_fops);
3596 if (cdev_add(&console_cdev, MKDEV(TTYAUX_MAJOR, 1), 1) ||
3597 register_chrdev_region(MKDEV(TTYAUX_MAJOR, 1), 1, "/dev/console") < 0)
3598 panic("Couldn't register /dev/console driver\n");
3599 consdev = device_create(tty_class, NULL, MKDEV(TTYAUX_MAJOR, 1), NULL,
3601 if (IS_ERR(consdev))
3604 WARN_ON(device_create_file(consdev, &dev_attr_active) < 0);
3607 vty_init(&console_fops);