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)
185 put_device(tty->dev);
186 kfree(tty->write_buf);
187 tty_buffer_free_all(tty);
191 static inline struct tty_struct *file_tty(struct file *file)
193 return ((struct tty_file_private *)file->private_data)->tty;
196 int tty_alloc_file(struct file *file)
198 struct tty_file_private *priv;
200 priv = kmalloc(sizeof(*priv), GFP_KERNEL);
204 file->private_data = priv;
209 /* Associate a new file with the tty structure */
210 void tty_add_file(struct tty_struct *tty, struct file *file)
212 struct tty_file_private *priv = file->private_data;
217 spin_lock(&tty_files_lock);
218 list_add(&priv->list, &tty->tty_files);
219 spin_unlock(&tty_files_lock);
223 * tty_free_file - free file->private_data
225 * This shall be used only for fail path handling when tty_add_file was not
228 void tty_free_file(struct file *file)
230 struct tty_file_private *priv = file->private_data;
232 file->private_data = NULL;
236 /* Delete file from its tty */
237 void tty_del_file(struct file *file)
239 struct tty_file_private *priv = file->private_data;
241 spin_lock(&tty_files_lock);
242 list_del(&priv->list);
243 spin_unlock(&tty_files_lock);
248 #define TTY_NUMBER(tty) ((tty)->index + (tty)->driver->name_base)
251 * tty_name - return tty naming
252 * @tty: tty structure
253 * @buf: buffer for output
255 * Convert a tty structure into a name. The name reflects the kernel
256 * naming policy and if udev is in use may not reflect user space
261 char *tty_name(struct tty_struct *tty, char *buf)
263 if (!tty) /* Hmm. NULL pointer. That's fun. */
264 strcpy(buf, "NULL tty");
266 strcpy(buf, tty->name);
270 EXPORT_SYMBOL(tty_name);
272 int tty_paranoia_check(struct tty_struct *tty, struct inode *inode,
275 #ifdef TTY_PARANOIA_CHECK
278 "null TTY for (%d:%d) in %s\n",
279 imajor(inode), iminor(inode), routine);
282 if (tty->magic != TTY_MAGIC) {
284 "bad magic number for tty struct (%d:%d) in %s\n",
285 imajor(inode), iminor(inode), routine);
292 static int check_tty_count(struct tty_struct *tty, const char *routine)
294 #ifdef CHECK_TTY_COUNT
298 spin_lock(&tty_files_lock);
299 list_for_each(p, &tty->tty_files) {
302 spin_unlock(&tty_files_lock);
303 if (tty->driver->type == TTY_DRIVER_TYPE_PTY &&
304 tty->driver->subtype == PTY_TYPE_SLAVE &&
305 tty->link && tty->link->count)
307 if (tty->count != count) {
308 printk(KERN_WARNING "Warning: dev (%s) tty->count(%d) "
309 "!= #fd's(%d) in %s\n",
310 tty->name, tty->count, count, routine);
318 * get_tty_driver - find device of a tty
319 * @dev_t: device identifier
320 * @index: returns the index of the tty
322 * This routine returns a tty driver structure, given a device number
323 * and also passes back the index number.
325 * Locking: caller must hold tty_mutex
328 static struct tty_driver *get_tty_driver(dev_t device, int *index)
330 struct tty_driver *p;
332 list_for_each_entry(p, &tty_drivers, tty_drivers) {
333 dev_t base = MKDEV(p->major, p->minor_start);
334 if (device < base || device >= base + p->num)
336 *index = device - base;
337 return tty_driver_kref_get(p);
342 #ifdef CONFIG_CONSOLE_POLL
345 * tty_find_polling_driver - find device of a polled tty
346 * @name: name string to match
347 * @line: pointer to resulting tty line nr
349 * This routine returns a tty driver structure, given a name
350 * and the condition that the tty driver is capable of polled
353 struct tty_driver *tty_find_polling_driver(char *name, int *line)
355 struct tty_driver *p, *res = NULL;
360 for (str = name; *str; str++)
361 if ((*str >= '0' && *str <= '9') || *str == ',')
367 tty_line = simple_strtoul(str, &str, 10);
369 mutex_lock(&tty_mutex);
370 /* Search through the tty devices to look for a match */
371 list_for_each_entry(p, &tty_drivers, tty_drivers) {
372 if (strncmp(name, p->name, len) != 0)
380 if (tty_line >= 0 && tty_line < p->num && p->ops &&
381 p->ops->poll_init && !p->ops->poll_init(p, tty_line, stp)) {
382 res = tty_driver_kref_get(p);
387 mutex_unlock(&tty_mutex);
391 EXPORT_SYMBOL_GPL(tty_find_polling_driver);
395 * tty_check_change - check for POSIX terminal changes
398 * If we try to write to, or set the state of, a terminal and we're
399 * not in the foreground, send a SIGTTOU. If the signal is blocked or
400 * ignored, go ahead and perform the operation. (POSIX 7.2)
405 int tty_check_change(struct tty_struct *tty)
410 if (current->signal->tty != tty)
413 spin_lock_irqsave(&tty->ctrl_lock, flags);
416 printk(KERN_WARNING "tty_check_change: tty->pgrp == NULL!\n");
419 if (task_pgrp(current) == tty->pgrp)
421 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
422 if (is_ignored(SIGTTOU))
424 if (is_current_pgrp_orphaned()) {
428 kill_pgrp(task_pgrp(current), SIGTTOU, 1);
429 set_thread_flag(TIF_SIGPENDING);
434 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
438 EXPORT_SYMBOL(tty_check_change);
440 static ssize_t hung_up_tty_read(struct file *file, char __user *buf,
441 size_t count, loff_t *ppos)
446 static ssize_t hung_up_tty_write(struct file *file, const char __user *buf,
447 size_t count, loff_t *ppos)
452 /* No kernel lock held - none needed ;) */
453 static unsigned int hung_up_tty_poll(struct file *filp, poll_table *wait)
455 return POLLIN | POLLOUT | POLLERR | POLLHUP | POLLRDNORM | POLLWRNORM;
458 static long hung_up_tty_ioctl(struct file *file, unsigned int cmd,
461 return cmd == TIOCSPGRP ? -ENOTTY : -EIO;
464 static long hung_up_tty_compat_ioctl(struct file *file,
465 unsigned int cmd, unsigned long arg)
467 return cmd == TIOCSPGRP ? -ENOTTY : -EIO;
470 static const struct file_operations tty_fops = {
475 .unlocked_ioctl = tty_ioctl,
476 .compat_ioctl = tty_compat_ioctl,
478 .release = tty_release,
479 .fasync = tty_fasync,
482 static const struct file_operations console_fops = {
485 .write = redirected_tty_write,
487 .unlocked_ioctl = tty_ioctl,
488 .compat_ioctl = tty_compat_ioctl,
490 .release = tty_release,
491 .fasync = tty_fasync,
494 static const struct file_operations hung_up_tty_fops = {
496 .read = hung_up_tty_read,
497 .write = hung_up_tty_write,
498 .poll = hung_up_tty_poll,
499 .unlocked_ioctl = hung_up_tty_ioctl,
500 .compat_ioctl = hung_up_tty_compat_ioctl,
501 .release = tty_release,
504 static DEFINE_SPINLOCK(redirect_lock);
505 static struct file *redirect;
508 * tty_wakeup - request more data
511 * Internal and external helper for wakeups of tty. This function
512 * informs the line discipline if present that the driver is ready
513 * to receive more output data.
516 void tty_wakeup(struct tty_struct *tty)
518 struct tty_ldisc *ld;
520 if (test_bit(TTY_DO_WRITE_WAKEUP, &tty->flags)) {
521 ld = tty_ldisc_ref(tty);
523 if (ld->ops->write_wakeup)
524 ld->ops->write_wakeup(tty);
528 wake_up_interruptible_poll(&tty->write_wait, POLLOUT);
531 EXPORT_SYMBOL_GPL(tty_wakeup);
534 * __tty_hangup - actual handler for hangup events
537 * This can be called by the "eventd" kernel thread. That is process
538 * synchronous but doesn't hold any locks, so we need to make sure we
539 * have the appropriate locks for what we're doing.
541 * The hangup event clears any pending redirections onto the hung up
542 * device. It ensures future writes will error and it does the needed
543 * line discipline hangup and signal delivery. The tty object itself
548 * redirect lock for undoing redirection
549 * file list lock for manipulating list of ttys
550 * tty_ldisc_lock from called functions
551 * termios_mutex resetting termios data
552 * tasklist_lock to walk task list for hangup event
553 * ->siglock to protect ->signal/->sighand
555 void __tty_hangup(struct tty_struct *tty)
557 struct file *cons_filp = NULL;
558 struct file *filp, *f = NULL;
559 struct task_struct *p;
560 struct tty_file_private *priv;
561 int closecount = 0, n;
569 spin_lock(&redirect_lock);
570 if (redirect && file_tty(redirect) == tty) {
574 spin_unlock(&redirect_lock);
578 /* some functions below drop BTM, so we need this bit */
579 set_bit(TTY_HUPPING, &tty->flags);
581 /* inuse_filps is protected by the single tty lock,
582 this really needs to change if we want to flush the
583 workqueue with the lock held */
584 check_tty_count(tty, "tty_hangup");
586 spin_lock(&tty_files_lock);
587 /* This breaks for file handles being sent over AF_UNIX sockets ? */
588 list_for_each_entry(priv, &tty->tty_files, list) {
590 if (filp->f_op->write == redirected_tty_write)
592 if (filp->f_op->write != tty_write)
595 __tty_fasync(-1, filp, 0); /* can't block */
596 filp->f_op = &hung_up_tty_fops;
598 spin_unlock(&tty_files_lock);
601 * it drops BTM and thus races with reopen
602 * we protect the race by TTY_HUPPING
604 tty_ldisc_hangup(tty);
606 read_lock(&tasklist_lock);
608 do_each_pid_task(tty->session, PIDTYPE_SID, p) {
609 spin_lock_irq(&p->sighand->siglock);
610 if (p->signal->tty == tty) {
611 p->signal->tty = NULL;
612 /* We defer the dereferences outside fo
616 if (!p->signal->leader) {
617 spin_unlock_irq(&p->sighand->siglock);
620 __group_send_sig_info(SIGHUP, SEND_SIG_PRIV, p);
621 __group_send_sig_info(SIGCONT, SEND_SIG_PRIV, p);
622 put_pid(p->signal->tty_old_pgrp); /* A noop */
623 spin_lock_irqsave(&tty->ctrl_lock, flags);
625 p->signal->tty_old_pgrp = get_pid(tty->pgrp);
626 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
627 spin_unlock_irq(&p->sighand->siglock);
628 } while_each_pid_task(tty->session, PIDTYPE_SID, p);
630 read_unlock(&tasklist_lock);
632 spin_lock_irqsave(&tty->ctrl_lock, flags);
633 clear_bit(TTY_THROTTLED, &tty->flags);
634 clear_bit(TTY_PUSH, &tty->flags);
635 clear_bit(TTY_DO_WRITE_WAKEUP, &tty->flags);
636 put_pid(tty->session);
640 tty->ctrl_status = 0;
641 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
643 /* Account for the p->signal references we killed */
648 * If one of the devices matches a console pointer, we
649 * cannot just call hangup() because that will cause
650 * tty->count and state->count to go out of sync.
651 * So we just call close() the right number of times.
655 for (n = 0; n < closecount; n++)
656 tty->ops->close(tty, cons_filp);
657 } else if (tty->ops->hangup)
658 (tty->ops->hangup)(tty);
660 * We don't want to have driver/ldisc interactions beyond
661 * the ones we did here. The driver layer expects no
662 * calls after ->hangup() from the ldisc side. However we
663 * can't yet guarantee all that.
665 set_bit(TTY_HUPPED, &tty->flags);
666 clear_bit(TTY_HUPPING, &tty->flags);
667 tty_ldisc_enable(tty);
675 static void do_tty_hangup(struct work_struct *work)
677 struct tty_struct *tty =
678 container_of(work, struct tty_struct, hangup_work);
684 * tty_hangup - trigger a hangup event
685 * @tty: tty to hangup
687 * A carrier loss (virtual or otherwise) has occurred on this like
688 * schedule a hangup sequence to run after this event.
691 void tty_hangup(struct tty_struct *tty)
693 #ifdef TTY_DEBUG_HANGUP
695 printk(KERN_DEBUG "%s hangup...\n", tty_name(tty, buf));
697 schedule_work(&tty->hangup_work);
700 EXPORT_SYMBOL(tty_hangup);
703 * tty_vhangup - process vhangup
704 * @tty: tty to hangup
706 * The user has asked via system call for the terminal to be hung up.
707 * We do this synchronously so that when the syscall returns the process
708 * is complete. That guarantee is necessary for security reasons.
711 void tty_vhangup(struct tty_struct *tty)
713 #ifdef TTY_DEBUG_HANGUP
716 printk(KERN_DEBUG "%s vhangup...\n", tty_name(tty, buf));
721 EXPORT_SYMBOL(tty_vhangup);
725 * tty_vhangup_self - process vhangup for own ctty
727 * Perform a vhangup on the current controlling tty
730 void tty_vhangup_self(void)
732 struct tty_struct *tty;
734 tty = get_current_tty();
742 * tty_hung_up_p - was tty hung up
743 * @filp: file pointer of tty
745 * Return true if the tty has been subject to a vhangup or a carrier
749 int tty_hung_up_p(struct file *filp)
751 return (filp->f_op == &hung_up_tty_fops);
754 EXPORT_SYMBOL(tty_hung_up_p);
756 static void session_clear_tty(struct pid *session)
758 struct task_struct *p;
759 do_each_pid_task(session, PIDTYPE_SID, p) {
761 } while_each_pid_task(session, PIDTYPE_SID, p);
765 * disassociate_ctty - disconnect controlling tty
766 * @on_exit: true if exiting so need to "hang up" the session
768 * This function is typically called only by the session leader, when
769 * it wants to disassociate itself from its controlling tty.
771 * It performs the following functions:
772 * (1) Sends a SIGHUP and SIGCONT to the foreground process group
773 * (2) Clears the tty from being controlling the session
774 * (3) Clears the controlling tty for all processes in the
777 * The argument on_exit is set to 1 if called when a process is
778 * exiting; it is 0 if called by the ioctl TIOCNOTTY.
781 * BTM is taken for hysterical raisins, and held when
782 * called from no_tty().
783 * tty_mutex is taken to protect tty
784 * ->siglock is taken to protect ->signal/->sighand
785 * tasklist_lock is taken to walk process list for sessions
786 * ->siglock is taken to protect ->signal/->sighand
789 void disassociate_ctty(int on_exit)
791 struct tty_struct *tty;
793 if (!current->signal->leader)
796 tty = get_current_tty();
798 struct pid *tty_pgrp = get_pid(tty->pgrp);
800 if (tty->driver->type != TTY_DRIVER_TYPE_PTY)
805 kill_pgrp(tty_pgrp, SIGHUP, on_exit);
807 kill_pgrp(tty_pgrp, SIGCONT, on_exit);
810 } else if (on_exit) {
811 struct pid *old_pgrp;
812 spin_lock_irq(¤t->sighand->siglock);
813 old_pgrp = current->signal->tty_old_pgrp;
814 current->signal->tty_old_pgrp = NULL;
815 spin_unlock_irq(¤t->sighand->siglock);
817 kill_pgrp(old_pgrp, SIGHUP, on_exit);
818 kill_pgrp(old_pgrp, SIGCONT, on_exit);
824 spin_lock_irq(¤t->sighand->siglock);
825 put_pid(current->signal->tty_old_pgrp);
826 current->signal->tty_old_pgrp = NULL;
827 spin_unlock_irq(¤t->sighand->siglock);
829 tty = get_current_tty();
832 spin_lock_irqsave(&tty->ctrl_lock, flags);
833 put_pid(tty->session);
837 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
840 #ifdef TTY_DEBUG_HANGUP
841 printk(KERN_DEBUG "error attempted to write to tty [0x%p]"
846 /* Now clear signal->tty under the lock */
847 read_lock(&tasklist_lock);
848 session_clear_tty(task_session(current));
849 read_unlock(&tasklist_lock);
854 * no_tty - Ensure the current process does not have a controlling tty
858 /* FIXME: Review locking here. The tty_lock never covered any race
859 between a new association and proc_clear_tty but possible we need
860 to protect against this anyway */
861 struct task_struct *tsk = current;
862 disassociate_ctty(0);
868 * stop_tty - propagate flow control
871 * Perform flow control to the driver. For PTY/TTY pairs we
872 * must also propagate the TIOCKPKT status. May be called
873 * on an already stopped device and will not re-call the driver
876 * This functionality is used by both the line disciplines for
877 * halting incoming flow and by the driver. It may therefore be
878 * called from any context, may be under the tty atomic_write_lock
882 * Uses the tty control lock internally
885 void stop_tty(struct tty_struct *tty)
888 spin_lock_irqsave(&tty->ctrl_lock, flags);
890 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
894 if (tty->link && tty->link->packet) {
895 tty->ctrl_status &= ~TIOCPKT_START;
896 tty->ctrl_status |= TIOCPKT_STOP;
897 wake_up_interruptible_poll(&tty->link->read_wait, POLLIN);
899 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
901 (tty->ops->stop)(tty);
904 EXPORT_SYMBOL(stop_tty);
907 * start_tty - propagate flow control
910 * Start a tty that has been stopped if at all possible. Perform
911 * any necessary wakeups and propagate the TIOCPKT status. If this
912 * is the tty was previous stopped and is being started then the
913 * driver start method is invoked and the line discipline woken.
919 void start_tty(struct tty_struct *tty)
922 spin_lock_irqsave(&tty->ctrl_lock, flags);
923 if (!tty->stopped || tty->flow_stopped) {
924 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
928 if (tty->link && tty->link->packet) {
929 tty->ctrl_status &= ~TIOCPKT_STOP;
930 tty->ctrl_status |= TIOCPKT_START;
931 wake_up_interruptible_poll(&tty->link->read_wait, POLLIN);
933 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
935 (tty->ops->start)(tty);
936 /* If we have a running line discipline it may need kicking */
940 EXPORT_SYMBOL(start_tty);
943 * tty_read - read method for tty device files
944 * @file: pointer to tty file
946 * @count: size of user buffer
949 * Perform the read system call function on this terminal device. Checks
950 * for hung up devices before calling the line discipline method.
953 * Locks the line discipline internally while needed. Multiple
954 * read calls may be outstanding in parallel.
957 static ssize_t tty_read(struct file *file, char __user *buf, size_t count,
961 struct inode *inode = file->f_path.dentry->d_inode;
962 struct tty_struct *tty = file_tty(file);
963 struct tty_ldisc *ld;
965 if (tty_paranoia_check(tty, inode, "tty_read"))
967 if (!tty || (test_bit(TTY_IO_ERROR, &tty->flags)))
970 /* We want to wait for the line discipline to sort out in this
972 ld = tty_ldisc_ref_wait(tty);
974 i = (ld->ops->read)(tty, file, buf, count);
979 inode->i_atime = current_fs_time(inode->i_sb);
983 void tty_write_unlock(struct tty_struct *tty)
984 __releases(&tty->atomic_write_lock)
986 mutex_unlock(&tty->atomic_write_lock);
987 wake_up_interruptible_poll(&tty->write_wait, POLLOUT);
990 int tty_write_lock(struct tty_struct *tty, int ndelay)
991 __acquires(&tty->atomic_write_lock)
993 if (!mutex_trylock(&tty->atomic_write_lock)) {
996 if (mutex_lock_interruptible(&tty->atomic_write_lock))
1003 * Split writes up in sane blocksizes to avoid
1004 * denial-of-service type attacks
1006 static inline ssize_t do_tty_write(
1007 ssize_t (*write)(struct tty_struct *, struct file *, const unsigned char *, size_t),
1008 struct tty_struct *tty,
1010 const char __user *buf,
1013 ssize_t ret, written = 0;
1016 ret = tty_write_lock(tty, file->f_flags & O_NDELAY);
1021 * We chunk up writes into a temporary buffer. This
1022 * simplifies low-level drivers immensely, since they
1023 * don't have locking issues and user mode accesses.
1025 * But if TTY_NO_WRITE_SPLIT is set, we should use a
1028 * The default chunk-size is 2kB, because the NTTY
1029 * layer has problems with bigger chunks. It will
1030 * claim to be able to handle more characters than
1033 * FIXME: This can probably go away now except that 64K chunks
1034 * are too likely to fail unless switched to vmalloc...
1037 if (test_bit(TTY_NO_WRITE_SPLIT, &tty->flags))
1042 /* write_buf/write_cnt is protected by the atomic_write_lock mutex */
1043 if (tty->write_cnt < chunk) {
1044 unsigned char *buf_chunk;
1049 buf_chunk = kmalloc(chunk, GFP_KERNEL);
1054 kfree(tty->write_buf);
1055 tty->write_cnt = chunk;
1056 tty->write_buf = buf_chunk;
1059 /* Do the write .. */
1061 size_t size = count;
1065 if (copy_from_user(tty->write_buf, buf, size))
1067 ret = write(tty, file, tty->write_buf, size);
1076 if (signal_pending(current))
1081 struct inode *inode = file->f_path.dentry->d_inode;
1082 inode->i_mtime = current_fs_time(inode->i_sb);
1086 tty_write_unlock(tty);
1091 * tty_write_message - write a message to a certain tty, not just the console.
1092 * @tty: the destination tty_struct
1093 * @msg: the message to write
1095 * This is used for messages that need to be redirected to a specific tty.
1096 * We don't put it into the syslog queue right now maybe in the future if
1099 * We must still hold the BTM and test the CLOSING flag for the moment.
1102 void tty_write_message(struct tty_struct *tty, char *msg)
1105 mutex_lock(&tty->atomic_write_lock);
1107 if (tty->ops->write && !test_bit(TTY_CLOSING, &tty->flags)) {
1109 tty->ops->write(tty, msg, strlen(msg));
1112 tty_write_unlock(tty);
1119 * tty_write - write method for tty device file
1120 * @file: tty file pointer
1121 * @buf: user data to write
1122 * @count: bytes to write
1125 * Write data to a tty device via the line discipline.
1128 * Locks the line discipline as required
1129 * Writes to the tty driver are serialized by the atomic_write_lock
1130 * and are then processed in chunks to the device. The line discipline
1131 * write method will not be invoked in parallel for each device.
1134 static ssize_t tty_write(struct file *file, const char __user *buf,
1135 size_t count, loff_t *ppos)
1137 struct inode *inode = file->f_path.dentry->d_inode;
1138 struct tty_struct *tty = file_tty(file);
1139 struct tty_ldisc *ld;
1142 if (tty_paranoia_check(tty, inode, "tty_write"))
1144 if (!tty || !tty->ops->write ||
1145 (test_bit(TTY_IO_ERROR, &tty->flags)))
1147 /* Short term debug to catch buggy drivers */
1148 if (tty->ops->write_room == NULL)
1149 printk(KERN_ERR "tty driver %s lacks a write_room method.\n",
1151 ld = tty_ldisc_ref_wait(tty);
1152 if (!ld->ops->write)
1155 ret = do_tty_write(ld->ops->write, tty, file, buf, count);
1156 tty_ldisc_deref(ld);
1160 ssize_t redirected_tty_write(struct file *file, const char __user *buf,
1161 size_t count, loff_t *ppos)
1163 struct file *p = NULL;
1165 spin_lock(&redirect_lock);
1170 spin_unlock(&redirect_lock);
1174 res = vfs_write(p, buf, count, &p->f_pos);
1178 return tty_write(file, buf, count, ppos);
1181 static char ptychar[] = "pqrstuvwxyzabcde";
1184 * pty_line_name - generate name for a pty
1185 * @driver: the tty driver in use
1186 * @index: the minor number
1187 * @p: output buffer of at least 6 bytes
1189 * Generate a name from a driver reference and write it to the output
1194 static void pty_line_name(struct tty_driver *driver, int index, char *p)
1196 int i = index + driver->name_base;
1197 /* ->name is initialized to "ttyp", but "tty" is expected */
1198 sprintf(p, "%s%c%x",
1199 driver->subtype == PTY_TYPE_SLAVE ? "tty" : driver->name,
1200 ptychar[i >> 4 & 0xf], i & 0xf);
1204 * tty_line_name - generate name for a tty
1205 * @driver: the tty driver in use
1206 * @index: the minor number
1207 * @p: output buffer of at least 7 bytes
1209 * Generate a name from a driver reference and write it to the output
1214 static void tty_line_name(struct tty_driver *driver, int index, char *p)
1216 sprintf(p, "%s%d", driver->name, index + driver->name_base);
1220 * tty_driver_lookup_tty() - find an existing tty, if any
1221 * @driver: the driver for the tty
1222 * @idx: the minor number
1224 * Return the tty, if found or ERR_PTR() otherwise.
1226 * Locking: tty_mutex must be held. If tty is found, the mutex must
1227 * be held until the 'fast-open' is also done. Will change once we
1228 * have refcounting in the driver and per driver locking
1230 static struct tty_struct *tty_driver_lookup_tty(struct tty_driver *driver,
1231 struct inode *inode, int idx)
1233 if (driver->ops->lookup)
1234 return driver->ops->lookup(driver, inode, idx);
1236 return driver->ttys[idx];
1240 * tty_init_termios - helper for termios setup
1241 * @tty: the tty to set up
1243 * Initialise the termios structures for this tty. Thus runs under
1244 * the tty_mutex currently so we can be relaxed about ordering.
1247 int tty_init_termios(struct tty_struct *tty)
1249 struct ktermios *tp;
1250 int idx = tty->index;
1252 if (tty->driver->flags & TTY_DRIVER_RESET_TERMIOS)
1253 tty->termios = tty->driver->init_termios;
1255 /* Check for lazy saved data */
1256 tp = tty->driver->termios[idx];
1260 tty->termios = tty->driver->init_termios;
1262 /* Compatibility until drivers always set this */
1263 tty->termios.c_ispeed = tty_termios_input_baud_rate(&tty->termios);
1264 tty->termios.c_ospeed = tty_termios_baud_rate(&tty->termios);
1267 EXPORT_SYMBOL_GPL(tty_init_termios);
1269 int tty_standard_install(struct tty_driver *driver, struct tty_struct *tty)
1271 int ret = tty_init_termios(tty);
1275 tty_driver_kref_get(driver);
1277 driver->ttys[tty->index] = tty;
1280 EXPORT_SYMBOL_GPL(tty_standard_install);
1283 * tty_driver_install_tty() - install a tty entry in the driver
1284 * @driver: the driver for the tty
1287 * Install a tty object into the driver tables. The tty->index field
1288 * will be set by the time this is called. This method is responsible
1289 * for ensuring any need additional structures are allocated and
1292 * Locking: tty_mutex for now
1294 static int tty_driver_install_tty(struct tty_driver *driver,
1295 struct tty_struct *tty)
1297 return driver->ops->install ? driver->ops->install(driver, tty) :
1298 tty_standard_install(driver, tty);
1302 * tty_driver_remove_tty() - remove a tty from the driver tables
1303 * @driver: the driver for the tty
1304 * @idx: the minor number
1306 * Remvoe a tty object from the driver tables. The tty->index field
1307 * will be set by the time this is called.
1309 * Locking: tty_mutex for now
1311 void tty_driver_remove_tty(struct tty_driver *driver, struct tty_struct *tty)
1313 if (driver->ops->remove)
1314 driver->ops->remove(driver, tty);
1316 driver->ttys[tty->index] = NULL;
1320 * tty_reopen() - fast re-open of an open tty
1321 * @tty - the tty to open
1323 * Return 0 on success, -errno on error.
1325 * Locking: tty_mutex must be held from the time the tty was found
1326 * till this open completes.
1328 static int tty_reopen(struct tty_struct *tty)
1330 struct tty_driver *driver = tty->driver;
1332 if (test_bit(TTY_CLOSING, &tty->flags) ||
1333 test_bit(TTY_HUPPING, &tty->flags) ||
1334 test_bit(TTY_LDISC_CHANGING, &tty->flags))
1337 if (driver->type == TTY_DRIVER_TYPE_PTY &&
1338 driver->subtype == PTY_TYPE_MASTER) {
1340 * special case for PTY masters: only one open permitted,
1341 * and the slave side open count is incremented as well.
1350 mutex_lock(&tty->ldisc_mutex);
1351 WARN_ON(!test_bit(TTY_LDISC, &tty->flags));
1352 mutex_unlock(&tty->ldisc_mutex);
1358 * tty_init_dev - initialise a tty device
1359 * @driver: tty driver we are opening a device on
1360 * @idx: device index
1361 * @ret_tty: returned tty structure
1363 * Prepare a tty device. This may not be a "new" clean device but
1364 * could also be an active device. The pty drivers require special
1365 * handling because of this.
1368 * The function is called under the tty_mutex, which
1369 * protects us from the tty struct or driver itself going away.
1371 * On exit the tty device has the line discipline attached and
1372 * a reference count of 1. If a pair was created for pty/tty use
1373 * and the other was a pty master then it too has a reference count of 1.
1375 * WSH 06/09/97: Rewritten to remove races and properly clean up after a
1376 * failed open. The new code protects the open with a mutex, so it's
1377 * really quite straightforward. The mutex locking can probably be
1378 * relaxed for the (most common) case of reopening a tty.
1381 struct tty_struct *tty_init_dev(struct tty_driver *driver, int idx)
1383 struct tty_struct *tty;
1387 * First time open is complex, especially for PTY devices.
1388 * This code guarantees that either everything succeeds and the
1389 * TTY is ready for operation, or else the table slots are vacated
1390 * and the allocated memory released. (Except that the termios
1391 * and locked termios may be retained.)
1394 if (!try_module_get(driver->owner))
1395 return ERR_PTR(-ENODEV);
1397 tty = alloc_tty_struct();
1400 goto err_module_put;
1402 initialize_tty_struct(tty, driver, idx);
1404 retval = tty_driver_install_tty(driver, tty);
1406 goto err_deinit_tty;
1409 tty->port = driver->ports[idx];
1412 * Structures all installed ... call the ldisc open routines.
1413 * If we fail here just call release_tty to clean up. No need
1414 * to decrement the use counts, as release_tty doesn't care.
1416 retval = tty_ldisc_setup(tty, tty->link);
1418 goto err_release_tty;
1422 deinitialize_tty_struct(tty);
1423 free_tty_struct(tty);
1425 module_put(driver->owner);
1426 return ERR_PTR(retval);
1428 /* call the tty release_tty routine to clean out this slot */
1430 printk_ratelimited(KERN_INFO "tty_init_dev: ldisc open failed, "
1431 "clearing slot %d\n", idx);
1432 release_tty(tty, idx);
1433 return ERR_PTR(retval);
1436 void tty_free_termios(struct tty_struct *tty)
1438 struct ktermios *tp;
1439 int idx = tty->index;
1441 /* If the port is going to reset then it has no termios to save */
1442 if (tty->driver->flags & TTY_DRIVER_RESET_TERMIOS)
1445 /* Stash the termios data */
1446 tp = tty->driver->termios[idx];
1448 tp = kmalloc(sizeof(struct ktermios), GFP_KERNEL);
1450 pr_warn("tty: no memory to save termios state.\n");
1456 EXPORT_SYMBOL(tty_free_termios);
1460 * release_one_tty - release tty structure memory
1461 * @kref: kref of tty we are obliterating
1463 * Releases memory associated with a tty structure, and clears out the
1464 * driver table slots. This function is called when a device is no longer
1465 * in use. It also gets called when setup of a device fails.
1468 * takes the file list lock internally when working on the list
1469 * of ttys that the driver keeps.
1471 * This method gets called from a work queue so that the driver private
1472 * cleanup ops can sleep (needed for USB at least)
1474 static void release_one_tty(struct work_struct *work)
1476 struct tty_struct *tty =
1477 container_of(work, struct tty_struct, hangup_work);
1478 struct tty_driver *driver = tty->driver;
1480 if (tty->ops->cleanup)
1481 tty->ops->cleanup(tty);
1484 tty_driver_kref_put(driver);
1485 module_put(driver->owner);
1487 spin_lock(&tty_files_lock);
1488 list_del_init(&tty->tty_files);
1489 spin_unlock(&tty_files_lock);
1492 put_pid(tty->session);
1493 free_tty_struct(tty);
1496 static void queue_release_one_tty(struct kref *kref)
1498 struct tty_struct *tty = container_of(kref, struct tty_struct, kref);
1500 /* The hangup queue is now free so we can reuse it rather than
1501 waste a chunk of memory for each port */
1502 INIT_WORK(&tty->hangup_work, release_one_tty);
1503 schedule_work(&tty->hangup_work);
1507 * tty_kref_put - release a tty kref
1510 * Release a reference to a tty device and if need be let the kref
1511 * layer destruct the object for us
1514 void tty_kref_put(struct tty_struct *tty)
1517 kref_put(&tty->kref, queue_release_one_tty);
1519 EXPORT_SYMBOL(tty_kref_put);
1522 * release_tty - release tty structure memory
1524 * Release both @tty and a possible linked partner (think pty pair),
1525 * and decrement the refcount of the backing module.
1529 * takes the file list lock internally when working on the list
1530 * of ttys that the driver keeps.
1533 static void release_tty(struct tty_struct *tty, int idx)
1535 /* This should always be true but check for the moment */
1536 WARN_ON(tty->index != idx);
1537 WARN_ON(!mutex_is_locked(&tty_mutex));
1538 if (tty->ops->shutdown)
1539 tty->ops->shutdown(tty);
1540 tty_free_termios(tty);
1541 tty_driver_remove_tty(tty->driver, tty);
1544 tty_kref_put(tty->link);
1549 * tty_release_checks - check a tty before real release
1550 * @tty: tty to check
1551 * @o_tty: link of @tty (if any)
1552 * @idx: index of the tty
1554 * Performs some paranoid checking before true release of the @tty.
1555 * This is a no-op unless TTY_PARANOIA_CHECK is defined.
1557 static int tty_release_checks(struct tty_struct *tty, struct tty_struct *o_tty,
1560 #ifdef TTY_PARANOIA_CHECK
1561 if (idx < 0 || idx >= tty->driver->num) {
1562 printk(KERN_DEBUG "%s: bad idx when trying to free (%s)\n",
1563 __func__, tty->name);
1567 /* not much to check for devpts */
1568 if (tty->driver->flags & TTY_DRIVER_DEVPTS_MEM)
1571 if (tty != tty->driver->ttys[idx]) {
1572 printk(KERN_DEBUG "%s: driver.table[%d] not tty for (%s)\n",
1573 __func__, idx, tty->name);
1576 if (tty->driver->other) {
1577 if (o_tty != tty->driver->other->ttys[idx]) {
1578 printk(KERN_DEBUG "%s: other->table[%d] not o_tty for (%s)\n",
1579 __func__, idx, tty->name);
1582 if (o_tty->link != tty) {
1583 printk(KERN_DEBUG "%s: bad pty pointers\n", __func__);
1592 * tty_release - vfs callback for close
1593 * @inode: inode of tty
1594 * @filp: file pointer for handle to tty
1596 * Called the last time each file handle is closed that references
1597 * this tty. There may however be several such references.
1600 * Takes bkl. See tty_release_dev
1602 * Even releasing the tty structures is a tricky business.. We have
1603 * to be very careful that the structures are all released at the
1604 * same time, as interrupts might otherwise get the wrong pointers.
1606 * WSH 09/09/97: rewritten to avoid some nasty race conditions that could
1607 * lead to double frees or releasing memory still in use.
1610 int tty_release(struct inode *inode, struct file *filp)
1612 struct tty_struct *tty = file_tty(filp);
1613 struct tty_struct *o_tty;
1614 int pty_master, tty_closing, o_tty_closing, do_sleep;
1619 if (tty_paranoia_check(tty, inode, __func__))
1623 check_tty_count(tty, __func__);
1625 __tty_fasync(-1, filp, 0);
1628 pty_master = (tty->driver->type == TTY_DRIVER_TYPE_PTY &&
1629 tty->driver->subtype == PTY_TYPE_MASTER);
1630 devpts = (tty->driver->flags & TTY_DRIVER_DEVPTS_MEM) != 0;
1633 if (tty_release_checks(tty, o_tty, idx)) {
1638 #ifdef TTY_DEBUG_HANGUP
1639 printk(KERN_DEBUG "%s: %s (tty count=%d)...\n", __func__,
1640 tty_name(tty, buf), tty->count);
1643 if (tty->ops->close)
1644 tty->ops->close(tty, filp);
1648 * Sanity check: if tty->count is going to zero, there shouldn't be
1649 * any waiters on tty->read_wait or tty->write_wait. We test the
1650 * wait queues and kick everyone out _before_ actually starting to
1651 * close. This ensures that we won't block while releasing the tty
1654 * The test for the o_tty closing is necessary, since the master and
1655 * slave sides may close in any order. If the slave side closes out
1656 * first, its count will be one, since the master side holds an open.
1657 * Thus this test wouldn't be triggered at the time the slave closes,
1660 * Note that it's possible for the tty to be opened again while we're
1661 * flushing out waiters. By recalculating the closing flags before
1662 * each iteration we avoid any problems.
1665 /* Guard against races with tty->count changes elsewhere and
1666 opens on /dev/tty */
1668 mutex_lock(&tty_mutex);
1670 tty_closing = tty->count <= 1;
1671 o_tty_closing = o_tty &&
1672 (o_tty->count <= (pty_master ? 1 : 0));
1676 if (waitqueue_active(&tty->read_wait)) {
1677 wake_up_poll(&tty->read_wait, POLLIN);
1680 if (waitqueue_active(&tty->write_wait)) {
1681 wake_up_poll(&tty->write_wait, POLLOUT);
1685 if (o_tty_closing) {
1686 if (waitqueue_active(&o_tty->read_wait)) {
1687 wake_up_poll(&o_tty->read_wait, POLLIN);
1690 if (waitqueue_active(&o_tty->write_wait)) {
1691 wake_up_poll(&o_tty->write_wait, POLLOUT);
1698 printk(KERN_WARNING "%s: %s: read/write wait queue active!\n",
1699 __func__, tty_name(tty, buf));
1701 mutex_unlock(&tty_mutex);
1706 * The closing flags are now consistent with the open counts on
1707 * both sides, and we've completed the last operation that could
1708 * block, so it's safe to proceed with closing.
1710 * We must *not* drop the tty_mutex until we ensure that a further
1711 * entry into tty_open can not pick up this tty.
1714 if (--o_tty->count < 0) {
1715 printk(KERN_WARNING "%s: bad pty slave count (%d) for %s\n",
1716 __func__, o_tty->count, tty_name(o_tty, buf));
1720 if (--tty->count < 0) {
1721 printk(KERN_WARNING "%s: bad tty->count (%d) for %s\n",
1722 __func__, tty->count, tty_name(tty, buf));
1727 * We've decremented tty->count, so we need to remove this file
1728 * descriptor off the tty->tty_files list; this serves two
1730 * - check_tty_count sees the correct number of file descriptors
1731 * associated with this tty.
1732 * - do_tty_hangup no longer sees this file descriptor as
1733 * something that needs to be handled for hangups.
1738 * Perform some housekeeping before deciding whether to return.
1740 * Set the TTY_CLOSING flag if this was the last open. In the
1741 * case of a pty we may have to wait around for the other side
1742 * to close, and TTY_CLOSING makes sure we can't be reopened.
1745 set_bit(TTY_CLOSING, &tty->flags);
1747 set_bit(TTY_CLOSING, &o_tty->flags);
1750 * If _either_ side is closing, make sure there aren't any
1751 * processes that still think tty or o_tty is their controlling
1754 if (tty_closing || o_tty_closing) {
1755 read_lock(&tasklist_lock);
1756 session_clear_tty(tty->session);
1758 session_clear_tty(o_tty->session);
1759 read_unlock(&tasklist_lock);
1762 mutex_unlock(&tty_mutex);
1764 /* At this point the TTY_CLOSING flag should ensure a dead tty
1765 cannot be re-opened by a racing opener */
1767 /* check whether both sides are closing ... */
1768 if (!tty_closing || (o_tty && !o_tty_closing))
1771 #ifdef TTY_DEBUG_HANGUP
1772 printk(KERN_DEBUG "%s: freeing tty structure...\n", __func__);
1775 * Ask the line discipline code to release its structures
1777 tty_ldisc_release(tty, o_tty);
1779 * The release_tty function takes care of the details of clearing
1780 * the slots and preserving the termios structure.
1782 mutex_lock(&tty_mutex);
1783 release_tty(tty, idx);
1784 mutex_unlock(&tty_mutex);
1786 /* Make this pty number available for reallocation */
1788 devpts_kill_index(inode, idx);
1794 * tty_open_current_tty - get tty of current task for open
1795 * @device: device number
1796 * @filp: file pointer to tty
1797 * @return: tty of the current task iff @device is /dev/tty
1799 * We cannot return driver and index like for the other nodes because
1800 * devpts will not work then. It expects inodes to be from devpts FS.
1802 * We need to move to returning a refcounted object from all the lookup
1803 * paths including this one.
1805 static struct tty_struct *tty_open_current_tty(dev_t device, struct file *filp)
1807 struct tty_struct *tty;
1809 if (device != MKDEV(TTYAUX_MAJOR, 0))
1812 tty = get_current_tty();
1814 return ERR_PTR(-ENXIO);
1816 filp->f_flags |= O_NONBLOCK; /* Don't let /dev/tty block */
1819 /* FIXME: we put a reference and return a TTY! */
1820 /* This is only safe because the caller holds tty_mutex */
1825 * tty_lookup_driver - lookup a tty driver for a given device file
1826 * @device: device number
1827 * @filp: file pointer to tty
1828 * @noctty: set if the device should not become a controlling tty
1829 * @index: index for the device in the @return driver
1830 * @return: driver for this inode (with increased refcount)
1832 * If @return is not erroneous, the caller is responsible to decrement the
1833 * refcount by tty_driver_kref_put.
1835 * Locking: tty_mutex protects get_tty_driver
1837 static struct tty_driver *tty_lookup_driver(dev_t device, struct file *filp,
1838 int *noctty, int *index)
1840 struct tty_driver *driver;
1844 case MKDEV(TTY_MAJOR, 0): {
1845 extern struct tty_driver *console_driver;
1846 driver = tty_driver_kref_get(console_driver);
1847 *index = fg_console;
1852 case MKDEV(TTYAUX_MAJOR, 1): {
1853 struct tty_driver *console_driver = console_device(index);
1854 if (console_driver) {
1855 driver = tty_driver_kref_get(console_driver);
1857 /* Don't let /dev/console block */
1858 filp->f_flags |= O_NONBLOCK;
1863 return ERR_PTR(-ENODEV);
1866 driver = get_tty_driver(device, index);
1868 return ERR_PTR(-ENODEV);
1875 * tty_open - open a tty device
1876 * @inode: inode of device file
1877 * @filp: file pointer to tty
1879 * tty_open and tty_release keep up the tty count that contains the
1880 * number of opens done on a tty. We cannot use the inode-count, as
1881 * different inodes might point to the same tty.
1883 * Open-counting is needed for pty masters, as well as for keeping
1884 * track of serial lines: DTR is dropped when the last close happens.
1885 * (This is not done solely through tty->count, now. - Ted 1/27/92)
1887 * The termios state of a pty is reset on first open so that
1888 * settings don't persist across reuse.
1890 * Locking: tty_mutex protects tty, tty_lookup_driver and tty_init_dev.
1891 * tty->count should protect the rest.
1892 * ->siglock protects ->signal/->sighand
1895 static int tty_open(struct inode *inode, struct file *filp)
1897 struct tty_struct *tty;
1899 struct tty_driver *driver = NULL;
1901 dev_t device = inode->i_rdev;
1902 unsigned saved_flags = filp->f_flags;
1904 nonseekable_open(inode, filp);
1907 retval = tty_alloc_file(filp);
1911 noctty = filp->f_flags & O_NOCTTY;
1915 mutex_lock(&tty_mutex);
1918 tty = tty_open_current_tty(device, filp);
1920 retval = PTR_ERR(tty);
1923 driver = tty_lookup_driver(device, filp, &noctty, &index);
1924 if (IS_ERR(driver)) {
1925 retval = PTR_ERR(driver);
1929 /* check whether we're reopening an existing tty */
1930 tty = tty_driver_lookup_tty(driver, inode, index);
1932 retval = PTR_ERR(tty);
1938 retval = tty_reopen(tty);
1940 tty = ERR_PTR(retval);
1942 tty = tty_init_dev(driver, index);
1944 mutex_unlock(&tty_mutex);
1946 tty_driver_kref_put(driver);
1949 retval = PTR_ERR(tty);
1953 tty_add_file(tty, filp);
1955 check_tty_count(tty, __func__);
1956 if (tty->driver->type == TTY_DRIVER_TYPE_PTY &&
1957 tty->driver->subtype == PTY_TYPE_MASTER)
1959 #ifdef TTY_DEBUG_HANGUP
1960 printk(KERN_DEBUG "%s: opening %s...\n", __func__, tty->name);
1963 retval = tty->ops->open(tty, filp);
1966 filp->f_flags = saved_flags;
1968 if (!retval && test_bit(TTY_EXCLUSIVE, &tty->flags) &&
1969 !capable(CAP_SYS_ADMIN))
1973 #ifdef TTY_DEBUG_HANGUP
1974 printk(KERN_DEBUG "%s: error %d in opening %s...\n", __func__,
1977 tty_unlock(); /* need to call tty_release without BTM */
1978 tty_release(inode, filp);
1979 if (retval != -ERESTARTSYS)
1982 if (signal_pending(current))
1987 * Need to reset f_op in case a hangup happened.
1990 if (filp->f_op == &hung_up_tty_fops)
1991 filp->f_op = &tty_fops;
1998 mutex_lock(&tty_mutex);
2000 spin_lock_irq(¤t->sighand->siglock);
2002 current->signal->leader &&
2003 !current->signal->tty &&
2004 tty->session == NULL)
2005 __proc_set_tty(current, tty);
2006 spin_unlock_irq(¤t->sighand->siglock);
2008 mutex_unlock(&tty_mutex);
2012 mutex_unlock(&tty_mutex);
2013 /* after locks to avoid deadlock */
2014 if (!IS_ERR_OR_NULL(driver))
2015 tty_driver_kref_put(driver);
2017 tty_free_file(filp);
2024 * tty_poll - check tty status
2025 * @filp: file being polled
2026 * @wait: poll wait structures to update
2028 * Call the line discipline polling method to obtain the poll
2029 * status of the device.
2031 * Locking: locks called line discipline but ldisc poll method
2032 * may be re-entered freely by other callers.
2035 static unsigned int tty_poll(struct file *filp, poll_table *wait)
2037 struct tty_struct *tty = file_tty(filp);
2038 struct tty_ldisc *ld;
2041 if (tty_paranoia_check(tty, filp->f_path.dentry->d_inode, "tty_poll"))
2044 ld = tty_ldisc_ref_wait(tty);
2046 ret = (ld->ops->poll)(tty, filp, wait);
2047 tty_ldisc_deref(ld);
2051 static int __tty_fasync(int fd, struct file *filp, int on)
2053 struct tty_struct *tty = file_tty(filp);
2054 unsigned long flags;
2057 if (tty_paranoia_check(tty, filp->f_path.dentry->d_inode, "tty_fasync"))
2060 retval = fasync_helper(fd, filp, on, &tty->fasync);
2067 if (!waitqueue_active(&tty->read_wait))
2068 tty->minimum_to_wake = 1;
2069 spin_lock_irqsave(&tty->ctrl_lock, flags);
2072 type = PIDTYPE_PGID;
2074 pid = task_pid(current);
2078 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
2079 retval = __f_setown(filp, pid, type, 0);
2084 if (!tty->fasync && !waitqueue_active(&tty->read_wait))
2085 tty->minimum_to_wake = N_TTY_BUF_SIZE;
2092 static int tty_fasync(int fd, struct file *filp, int on)
2096 retval = __tty_fasync(fd, filp, on);
2102 * tiocsti - fake input character
2103 * @tty: tty to fake input into
2104 * @p: pointer to character
2106 * Fake input to a tty device. Does the necessary locking and
2109 * FIXME: does not honour flow control ??
2112 * Called functions take tty_ldisc_lock
2113 * current->signal->tty check is safe without locks
2115 * FIXME: may race normal receive processing
2118 static int tiocsti(struct tty_struct *tty, char __user *p)
2121 struct tty_ldisc *ld;
2123 if ((current->signal->tty != tty) && !capable(CAP_SYS_ADMIN))
2125 if (get_user(ch, p))
2127 tty_audit_tiocsti(tty, ch);
2128 ld = tty_ldisc_ref_wait(tty);
2129 ld->ops->receive_buf(tty, &ch, &mbz, 1);
2130 tty_ldisc_deref(ld);
2135 * tiocgwinsz - implement window query ioctl
2137 * @arg: user buffer for result
2139 * Copies the kernel idea of the window size into the user buffer.
2141 * Locking: tty->termios_mutex is taken to ensure the winsize data
2145 static int tiocgwinsz(struct tty_struct *tty, struct winsize __user *arg)
2149 mutex_lock(&tty->termios_mutex);
2150 err = copy_to_user(arg, &tty->winsize, sizeof(*arg));
2151 mutex_unlock(&tty->termios_mutex);
2153 return err ? -EFAULT: 0;
2157 * tty_do_resize - resize event
2158 * @tty: tty being resized
2159 * @rows: rows (character)
2160 * @cols: cols (character)
2162 * Update the termios variables and send the necessary signals to
2163 * peform a terminal resize correctly
2166 int tty_do_resize(struct tty_struct *tty, struct winsize *ws)
2169 unsigned long flags;
2172 mutex_lock(&tty->termios_mutex);
2173 if (!memcmp(ws, &tty->winsize, sizeof(*ws)))
2175 /* Get the PID values and reference them so we can
2176 avoid holding the tty ctrl lock while sending signals */
2177 spin_lock_irqsave(&tty->ctrl_lock, flags);
2178 pgrp = get_pid(tty->pgrp);
2179 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
2182 kill_pgrp(pgrp, SIGWINCH, 1);
2187 mutex_unlock(&tty->termios_mutex);
2192 * tiocswinsz - implement window size set ioctl
2193 * @tty; tty side of tty
2194 * @arg: user buffer for result
2196 * Copies the user idea of the window size to the kernel. Traditionally
2197 * this is just advisory information but for the Linux console it
2198 * actually has driver level meaning and triggers a VC resize.
2201 * Driver dependent. The default do_resize method takes the
2202 * tty termios mutex and ctrl_lock. The console takes its own lock
2203 * then calls into the default method.
2206 static int tiocswinsz(struct tty_struct *tty, struct winsize __user *arg)
2208 struct winsize tmp_ws;
2209 if (copy_from_user(&tmp_ws, arg, sizeof(*arg)))
2212 if (tty->ops->resize)
2213 return tty->ops->resize(tty, &tmp_ws);
2215 return tty_do_resize(tty, &tmp_ws);
2219 * tioccons - allow admin to move logical console
2220 * @file: the file to become console
2222 * Allow the administrator to move the redirected console device
2224 * Locking: uses redirect_lock to guard the redirect information
2227 static int tioccons(struct file *file)
2229 if (!capable(CAP_SYS_ADMIN))
2231 if (file->f_op->write == redirected_tty_write) {
2233 spin_lock(&redirect_lock);
2236 spin_unlock(&redirect_lock);
2241 spin_lock(&redirect_lock);
2243 spin_unlock(&redirect_lock);
2248 spin_unlock(&redirect_lock);
2253 * fionbio - non blocking ioctl
2254 * @file: file to set blocking value
2255 * @p: user parameter
2257 * Historical tty interfaces had a blocking control ioctl before
2258 * the generic functionality existed. This piece of history is preserved
2259 * in the expected tty API of posix OS's.
2261 * Locking: none, the open file handle ensures it won't go away.
2264 static int fionbio(struct file *file, int __user *p)
2268 if (get_user(nonblock, p))
2271 spin_lock(&file->f_lock);
2273 file->f_flags |= O_NONBLOCK;
2275 file->f_flags &= ~O_NONBLOCK;
2276 spin_unlock(&file->f_lock);
2281 * tiocsctty - set controlling tty
2282 * @tty: tty structure
2283 * @arg: user argument
2285 * This ioctl is used to manage job control. It permits a session
2286 * leader to set this tty as the controlling tty for the session.
2289 * Takes tty_mutex() to protect tty instance
2290 * Takes tasklist_lock internally to walk sessions
2291 * Takes ->siglock() when updating signal->tty
2294 static int tiocsctty(struct tty_struct *tty, int arg)
2297 if (current->signal->leader && (task_session(current) == tty->session))
2300 mutex_lock(&tty_mutex);
2302 * The process must be a session leader and
2303 * not have a controlling tty already.
2305 if (!current->signal->leader || current->signal->tty) {
2312 * This tty is already the controlling
2313 * tty for another session group!
2315 if (arg == 1 && capable(CAP_SYS_ADMIN)) {
2319 read_lock(&tasklist_lock);
2320 session_clear_tty(tty->session);
2321 read_unlock(&tasklist_lock);
2327 proc_set_tty(current, tty);
2329 mutex_unlock(&tty_mutex);
2334 * tty_get_pgrp - return a ref counted pgrp pid
2337 * Returns a refcounted instance of the pid struct for the process
2338 * group controlling the tty.
2341 struct pid *tty_get_pgrp(struct tty_struct *tty)
2343 unsigned long flags;
2346 spin_lock_irqsave(&tty->ctrl_lock, flags);
2347 pgrp = get_pid(tty->pgrp);
2348 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
2352 EXPORT_SYMBOL_GPL(tty_get_pgrp);
2355 * tiocgpgrp - get process group
2356 * @tty: tty passed by user
2357 * @real_tty: tty side of the tty passed by the user if a pty else the tty
2360 * Obtain the process group of the tty. If there is no process group
2363 * Locking: none. Reference to current->signal->tty is safe.
2366 static int tiocgpgrp(struct tty_struct *tty, struct tty_struct *real_tty, pid_t __user *p)
2371 * (tty == real_tty) is a cheap way of
2372 * testing if the tty is NOT a master pty.
2374 if (tty == real_tty && current->signal->tty != real_tty)
2376 pid = tty_get_pgrp(real_tty);
2377 ret = put_user(pid_vnr(pid), p);
2383 * tiocspgrp - attempt to set process group
2384 * @tty: tty passed by user
2385 * @real_tty: tty side device matching tty passed by user
2388 * Set the process group of the tty to the session passed. Only
2389 * permitted where the tty session is our session.
2391 * Locking: RCU, ctrl lock
2394 static int tiocspgrp(struct tty_struct *tty, struct tty_struct *real_tty, pid_t __user *p)
2398 int retval = tty_check_change(real_tty);
2399 unsigned long flags;
2405 if (!current->signal->tty ||
2406 (current->signal->tty != real_tty) ||
2407 (real_tty->session != task_session(current)))
2409 if (get_user(pgrp_nr, p))
2414 pgrp = find_vpid(pgrp_nr);
2419 if (session_of_pgrp(pgrp) != task_session(current))
2422 spin_lock_irqsave(&tty->ctrl_lock, flags);
2423 put_pid(real_tty->pgrp);
2424 real_tty->pgrp = get_pid(pgrp);
2425 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
2432 * tiocgsid - get session id
2433 * @tty: tty passed by user
2434 * @real_tty: tty side of the tty passed by the user if a pty else the tty
2435 * @p: pointer to returned session id
2437 * Obtain the session id of the tty. If there is no session
2440 * Locking: none. Reference to current->signal->tty is safe.
2443 static int tiocgsid(struct tty_struct *tty, struct tty_struct *real_tty, pid_t __user *p)
2446 * (tty == real_tty) is a cheap way of
2447 * testing if the tty is NOT a master pty.
2449 if (tty == real_tty && current->signal->tty != real_tty)
2451 if (!real_tty->session)
2453 return put_user(pid_vnr(real_tty->session), p);
2457 * tiocsetd - set line discipline
2459 * @p: pointer to user data
2461 * Set the line discipline according to user request.
2463 * Locking: see tty_set_ldisc, this function is just a helper
2466 static int tiocsetd(struct tty_struct *tty, int __user *p)
2471 if (get_user(ldisc, p))
2474 ret = tty_set_ldisc(tty, ldisc);
2480 * send_break - performed time break
2481 * @tty: device to break on
2482 * @duration: timeout in mS
2484 * Perform a timed break on hardware that lacks its own driver level
2485 * timed break functionality.
2488 * atomic_write_lock serializes
2492 static int send_break(struct tty_struct *tty, unsigned int duration)
2496 if (tty->ops->break_ctl == NULL)
2499 if (tty->driver->flags & TTY_DRIVER_HARDWARE_BREAK)
2500 retval = tty->ops->break_ctl(tty, duration);
2502 /* Do the work ourselves */
2503 if (tty_write_lock(tty, 0) < 0)
2505 retval = tty->ops->break_ctl(tty, -1);
2508 if (!signal_pending(current))
2509 msleep_interruptible(duration);
2510 retval = tty->ops->break_ctl(tty, 0);
2512 tty_write_unlock(tty);
2513 if (signal_pending(current))
2520 * tty_tiocmget - get modem status
2522 * @file: user file pointer
2523 * @p: pointer to result
2525 * Obtain the modem status bits from the tty driver if the feature
2526 * is supported. Return -EINVAL if it is not available.
2528 * Locking: none (up to the driver)
2531 static int tty_tiocmget(struct tty_struct *tty, int __user *p)
2533 int retval = -EINVAL;
2535 if (tty->ops->tiocmget) {
2536 retval = tty->ops->tiocmget(tty);
2539 retval = put_user(retval, p);
2545 * tty_tiocmset - set modem status
2547 * @cmd: command - clear bits, set bits or set all
2548 * @p: pointer to desired bits
2550 * Set the modem status bits from the tty driver if the feature
2551 * is supported. Return -EINVAL if it is not available.
2553 * Locking: none (up to the driver)
2556 static int tty_tiocmset(struct tty_struct *tty, unsigned int cmd,
2560 unsigned int set, clear, val;
2562 if (tty->ops->tiocmset == NULL)
2565 retval = get_user(val, p);
2581 set &= TIOCM_DTR|TIOCM_RTS|TIOCM_OUT1|TIOCM_OUT2|TIOCM_LOOP;
2582 clear &= TIOCM_DTR|TIOCM_RTS|TIOCM_OUT1|TIOCM_OUT2|TIOCM_LOOP;
2583 return tty->ops->tiocmset(tty, set, clear);
2586 static int tty_tiocgicount(struct tty_struct *tty, void __user *arg)
2588 int retval = -EINVAL;
2589 struct serial_icounter_struct icount;
2590 memset(&icount, 0, sizeof(icount));
2591 if (tty->ops->get_icount)
2592 retval = tty->ops->get_icount(tty, &icount);
2595 if (copy_to_user(arg, &icount, sizeof(icount)))
2600 struct tty_struct *tty_pair_get_tty(struct tty_struct *tty)
2602 if (tty->driver->type == TTY_DRIVER_TYPE_PTY &&
2603 tty->driver->subtype == PTY_TYPE_MASTER)
2607 EXPORT_SYMBOL(tty_pair_get_tty);
2609 struct tty_struct *tty_pair_get_pty(struct tty_struct *tty)
2611 if (tty->driver->type == TTY_DRIVER_TYPE_PTY &&
2612 tty->driver->subtype == PTY_TYPE_MASTER)
2616 EXPORT_SYMBOL(tty_pair_get_pty);
2619 * Split this up, as gcc can choke on it otherwise..
2621 long tty_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
2623 struct tty_struct *tty = file_tty(file);
2624 struct tty_struct *real_tty;
2625 void __user *p = (void __user *)arg;
2627 struct tty_ldisc *ld;
2628 struct inode *inode = file->f_dentry->d_inode;
2630 if (tty_paranoia_check(tty, inode, "tty_ioctl"))
2633 real_tty = tty_pair_get_tty(tty);
2636 * Factor out some common prep work
2644 retval = tty_check_change(tty);
2647 if (cmd != TIOCCBRK) {
2648 tty_wait_until_sent(tty, 0);
2649 if (signal_pending(current))
2660 return tiocsti(tty, p);
2662 return tiocgwinsz(real_tty, p);
2664 return tiocswinsz(real_tty, p);
2666 return real_tty != tty ? -EINVAL : tioccons(file);
2668 return fionbio(file, p);
2670 set_bit(TTY_EXCLUSIVE, &tty->flags);
2673 clear_bit(TTY_EXCLUSIVE, &tty->flags);
2676 if (current->signal->tty != tty)
2681 return tiocsctty(tty, arg);
2683 return tiocgpgrp(tty, real_tty, p);
2685 return tiocspgrp(tty, real_tty, p);
2687 return tiocgsid(tty, real_tty, p);
2689 return put_user(tty->ldisc->ops->num, (int __user *)p);
2691 return tiocsetd(tty, p);
2693 if (!capable(CAP_SYS_ADMIN))
2699 unsigned int ret = new_encode_dev(tty_devnum(real_tty));
2700 return put_user(ret, (unsigned int __user *)p);
2705 case TIOCSBRK: /* Turn break on, unconditionally */
2706 if (tty->ops->break_ctl)
2707 return tty->ops->break_ctl(tty, -1);
2709 case TIOCCBRK: /* Turn break off, unconditionally */
2710 if (tty->ops->break_ctl)
2711 return tty->ops->break_ctl(tty, 0);
2713 case TCSBRK: /* SVID version: non-zero arg --> no break */
2714 /* non-zero arg means wait for all output data
2715 * to be sent (performed above) but don't send break.
2716 * This is used by the tcdrain() termios function.
2719 return send_break(tty, 250);
2721 case TCSBRKP: /* support for POSIX tcsendbreak() */
2722 return send_break(tty, arg ? arg*100 : 250);
2725 return tty_tiocmget(tty, p);
2729 return tty_tiocmset(tty, cmd, p);
2731 retval = tty_tiocgicount(tty, p);
2732 /* For the moment allow fall through to the old method */
2733 if (retval != -EINVAL)
2740 /* flush tty buffer and allow ldisc to process ioctl */
2741 tty_buffer_flush(tty);
2746 if (tty->ops->ioctl) {
2747 retval = (tty->ops->ioctl)(tty, cmd, arg);
2748 if (retval != -ENOIOCTLCMD)
2751 ld = tty_ldisc_ref_wait(tty);
2753 if (ld->ops->ioctl) {
2754 retval = ld->ops->ioctl(tty, file, cmd, arg);
2755 if (retval == -ENOIOCTLCMD)
2758 tty_ldisc_deref(ld);
2762 #ifdef CONFIG_COMPAT
2763 static long tty_compat_ioctl(struct file *file, unsigned int cmd,
2766 struct inode *inode = file->f_dentry->d_inode;
2767 struct tty_struct *tty = file_tty(file);
2768 struct tty_ldisc *ld;
2769 int retval = -ENOIOCTLCMD;
2771 if (tty_paranoia_check(tty, inode, "tty_ioctl"))
2774 if (tty->ops->compat_ioctl) {
2775 retval = (tty->ops->compat_ioctl)(tty, cmd, arg);
2776 if (retval != -ENOIOCTLCMD)
2780 ld = tty_ldisc_ref_wait(tty);
2781 if (ld->ops->compat_ioctl)
2782 retval = ld->ops->compat_ioctl(tty, file, cmd, arg);
2784 retval = n_tty_compat_ioctl_helper(tty, file, cmd, arg);
2785 tty_ldisc_deref(ld);
2792 * This implements the "Secure Attention Key" --- the idea is to
2793 * prevent trojan horses by killing all processes associated with this
2794 * tty when the user hits the "Secure Attention Key". Required for
2795 * super-paranoid applications --- see the Orange Book for more details.
2797 * This code could be nicer; ideally it should send a HUP, wait a few
2798 * seconds, then send a INT, and then a KILL signal. But you then
2799 * have to coordinate with the init process, since all processes associated
2800 * with the current tty must be dead before the new getty is allowed
2803 * Now, if it would be correct ;-/ The current code has a nasty hole -
2804 * it doesn't catch files in flight. We may send the descriptor to ourselves
2805 * via AF_UNIX socket, close it and later fetch from socket. FIXME.
2807 * Nasty bug: do_SAK is being called in interrupt context. This can
2808 * deadlock. We punt it up to process context. AKPM - 16Mar2001
2810 void __do_SAK(struct tty_struct *tty)
2815 struct task_struct *g, *p;
2816 struct pid *session;
2819 struct fdtable *fdt;
2823 session = tty->session;
2825 tty_ldisc_flush(tty);
2827 tty_driver_flush_buffer(tty);
2829 read_lock(&tasklist_lock);
2830 /* Kill the entire session */
2831 do_each_pid_task(session, PIDTYPE_SID, p) {
2832 printk(KERN_NOTICE "SAK: killed process %d"
2833 " (%s): task_session(p)==tty->session\n",
2834 task_pid_nr(p), p->comm);
2835 send_sig(SIGKILL, p, 1);
2836 } while_each_pid_task(session, PIDTYPE_SID, p);
2837 /* Now kill any processes that happen to have the
2840 do_each_thread(g, p) {
2841 if (p->signal->tty == tty) {
2842 printk(KERN_NOTICE "SAK: killed process %d"
2843 " (%s): task_session(p)==tty->session\n",
2844 task_pid_nr(p), p->comm);
2845 send_sig(SIGKILL, p, 1);
2851 * We don't take a ref to the file, so we must
2852 * hold ->file_lock instead.
2854 spin_lock(&p->files->file_lock);
2855 fdt = files_fdtable(p->files);
2856 for (i = 0; i < fdt->max_fds; i++) {
2857 filp = fcheck_files(p->files, i);
2860 if (filp->f_op->read == tty_read &&
2861 file_tty(filp) == tty) {
2862 printk(KERN_NOTICE "SAK: killed process %d"
2863 " (%s): fd#%d opened to the tty\n",
2864 task_pid_nr(p), p->comm, i);
2865 force_sig(SIGKILL, p);
2869 spin_unlock(&p->files->file_lock);
2872 } while_each_thread(g, p);
2873 read_unlock(&tasklist_lock);
2877 static void do_SAK_work(struct work_struct *work)
2879 struct tty_struct *tty =
2880 container_of(work, struct tty_struct, SAK_work);
2885 * The tq handling here is a little racy - tty->SAK_work may already be queued.
2886 * Fortunately we don't need to worry, because if ->SAK_work is already queued,
2887 * the values which we write to it will be identical to the values which it
2888 * already has. --akpm
2890 void do_SAK(struct tty_struct *tty)
2894 schedule_work(&tty->SAK_work);
2897 EXPORT_SYMBOL(do_SAK);
2899 static int dev_match_devt(struct device *dev, void *data)
2902 return dev->devt == *devt;
2905 /* Must put_device() after it's unused! */
2906 static struct device *tty_get_device(struct tty_struct *tty)
2908 dev_t devt = tty_devnum(tty);
2909 return class_find_device(tty_class, NULL, &devt, dev_match_devt);
2914 * initialize_tty_struct
2915 * @tty: tty to initialize
2917 * This subroutine initializes a tty structure that has been newly
2920 * Locking: none - tty in question must not be exposed at this point
2923 void initialize_tty_struct(struct tty_struct *tty,
2924 struct tty_driver *driver, int idx)
2926 memset(tty, 0, sizeof(struct tty_struct));
2927 kref_init(&tty->kref);
2928 tty->magic = TTY_MAGIC;
2929 tty_ldisc_init(tty);
2930 tty->session = NULL;
2932 tty->overrun_time = jiffies;
2933 tty_buffer_init(tty);
2934 mutex_init(&tty->termios_mutex);
2935 mutex_init(&tty->ldisc_mutex);
2936 init_waitqueue_head(&tty->write_wait);
2937 init_waitqueue_head(&tty->read_wait);
2938 INIT_WORK(&tty->hangup_work, do_tty_hangup);
2939 mutex_init(&tty->atomic_read_lock);
2940 mutex_init(&tty->atomic_write_lock);
2941 mutex_init(&tty->output_lock);
2942 mutex_init(&tty->echo_lock);
2943 spin_lock_init(&tty->read_lock);
2944 spin_lock_init(&tty->ctrl_lock);
2945 INIT_LIST_HEAD(&tty->tty_files);
2946 INIT_WORK(&tty->SAK_work, do_SAK_work);
2948 tty->driver = driver;
2949 tty->ops = driver->ops;
2951 tty_line_name(driver, idx, tty->name);
2952 tty->dev = tty_get_device(tty);
2956 * deinitialize_tty_struct
2957 * @tty: tty to deinitialize
2959 * This subroutine deinitializes a tty structure that has been newly
2960 * allocated but tty_release cannot be called on that yet.
2962 * Locking: none - tty in question must not be exposed at this point
2964 void deinitialize_tty_struct(struct tty_struct *tty)
2966 tty_ldisc_deinit(tty);
2970 * tty_put_char - write one character to a tty
2974 * Write one byte to the tty using the provided put_char method
2975 * if present. Returns the number of characters successfully output.
2977 * Note: the specific put_char operation in the driver layer may go
2978 * away soon. Don't call it directly, use this method
2981 int tty_put_char(struct tty_struct *tty, unsigned char ch)
2983 if (tty->ops->put_char)
2984 return tty->ops->put_char(tty, ch);
2985 return tty->ops->write(tty, &ch, 1);
2987 EXPORT_SYMBOL_GPL(tty_put_char);
2989 struct class *tty_class;
2992 * tty_register_device - register a tty device
2993 * @driver: the tty driver that describes the tty device
2994 * @index: the index in the tty driver for this tty device
2995 * @device: a struct device that is associated with this tty device.
2996 * This field is optional, if there is no known struct device
2997 * for this tty device it can be set to NULL safely.
2999 * Returns a pointer to the struct device for this tty device
3000 * (or ERR_PTR(-EFOO) on error).
3002 * This call is required to be made to register an individual tty device
3003 * if the tty driver's flags have the TTY_DRIVER_DYNAMIC_DEV bit set. If
3004 * that bit is not set, this function should not be called by a tty
3010 struct device *tty_register_device(struct tty_driver *driver, unsigned index,
3011 struct device *device)
3014 dev_t dev = MKDEV(driver->major, driver->minor_start) + index;
3016 if (index >= driver->num) {
3017 printk(KERN_ERR "Attempt to register invalid tty line number "
3019 return ERR_PTR(-EINVAL);
3022 if (driver->type == TTY_DRIVER_TYPE_PTY)
3023 pty_line_name(driver, index, name);
3025 tty_line_name(driver, index, name);
3027 return device_create(tty_class, device, dev, NULL, name);
3029 EXPORT_SYMBOL(tty_register_device);
3032 * tty_unregister_device - unregister a tty device
3033 * @driver: the tty driver that describes the tty device
3034 * @index: the index in the tty driver for this tty device
3036 * If a tty device is registered with a call to tty_register_device() then
3037 * this function must be called when the tty device is gone.
3042 void tty_unregister_device(struct tty_driver *driver, unsigned index)
3044 device_destroy(tty_class,
3045 MKDEV(driver->major, driver->minor_start) + index);
3047 EXPORT_SYMBOL(tty_unregister_device);
3049 struct tty_driver *__alloc_tty_driver(int lines, struct module *owner)
3051 struct tty_driver *driver;
3053 driver = kzalloc(sizeof(struct tty_driver), GFP_KERNEL);
3055 kref_init(&driver->kref);
3056 driver->magic = TTY_DRIVER_MAGIC;
3057 driver->num = lines;
3058 driver->owner = owner;
3059 /* later we'll move allocation of tables here */
3063 EXPORT_SYMBOL(__alloc_tty_driver);
3065 static void destruct_tty_driver(struct kref *kref)
3067 struct tty_driver *driver = container_of(kref, struct tty_driver, kref);
3069 struct ktermios *tp;
3072 if (driver->flags & TTY_DRIVER_INSTALLED) {
3074 * Free the termios and termios_locked structures because
3075 * we don't want to get memory leaks when modular tty
3076 * drivers are removed from the kernel.
3078 for (i = 0; i < driver->num; i++) {
3079 tp = driver->termios[i];
3081 driver->termios[i] = NULL;
3084 if (!(driver->flags & TTY_DRIVER_DYNAMIC_DEV))
3085 tty_unregister_device(driver, i);
3088 proc_tty_unregister_driver(driver);
3089 driver->ttys = NULL;
3090 driver->termios = NULL;
3092 cdev_del(&driver->cdev);
3094 kfree(driver->ports);
3098 void tty_driver_kref_put(struct tty_driver *driver)
3100 kref_put(&driver->kref, destruct_tty_driver);
3102 EXPORT_SYMBOL(tty_driver_kref_put);
3104 void tty_set_operations(struct tty_driver *driver,
3105 const struct tty_operations *op)
3109 EXPORT_SYMBOL(tty_set_operations);
3111 void put_tty_driver(struct tty_driver *d)
3113 tty_driver_kref_put(d);
3115 EXPORT_SYMBOL(put_tty_driver);
3118 * Called by a tty driver to register itself.
3120 int tty_register_driver(struct tty_driver *driver)
3128 if (!(driver->flags & TTY_DRIVER_DEVPTS_MEM) && driver->num) {
3129 p = kzalloc(driver->num * 2 * sizeof(void *), GFP_KERNEL);
3134 * There is too many lines in PTY and we won't need the array there
3135 * since it has an ->install hook where it assigns ports properly.
3137 if (driver->type != TTY_DRIVER_TYPE_PTY) {
3138 driver->ports = kcalloc(driver->num, sizeof(struct tty_port *),
3140 if (!driver->ports) {
3146 if (!driver->major) {
3147 error = alloc_chrdev_region(&dev, driver->minor_start,
3148 driver->num, driver->name);
3150 driver->major = MAJOR(dev);
3151 driver->minor_start = MINOR(dev);
3154 dev = MKDEV(driver->major, driver->minor_start);
3155 error = register_chrdev_region(dev, driver->num, driver->name);
3161 driver->ttys = (struct tty_struct **)p;
3162 driver->termios = (struct ktermios **)(p + driver->num);
3164 driver->ttys = NULL;
3165 driver->termios = NULL;
3168 cdev_init(&driver->cdev, &tty_fops);
3169 driver->cdev.owner = driver->owner;
3170 error = cdev_add(&driver->cdev, dev, driver->num);
3172 goto err_unreg_char;
3174 mutex_lock(&tty_mutex);
3175 list_add(&driver->tty_drivers, &tty_drivers);
3176 mutex_unlock(&tty_mutex);
3178 if (!(driver->flags & TTY_DRIVER_DYNAMIC_DEV)) {
3179 for (i = 0; i < driver->num; i++) {
3180 d = tty_register_device(driver, i, NULL);
3187 proc_tty_register_driver(driver);
3188 driver->flags |= TTY_DRIVER_INSTALLED;
3192 for (i--; i >= 0; i--)
3193 tty_unregister_device(driver, i);
3195 mutex_lock(&tty_mutex);
3196 list_del(&driver->tty_drivers);
3197 mutex_unlock(&tty_mutex);
3200 unregister_chrdev_region(dev, driver->num);
3201 driver->ttys = NULL;
3202 driver->termios = NULL;
3203 err_free_p: /* destruct_tty_driver will free driver->ports */
3207 EXPORT_SYMBOL(tty_register_driver);
3210 * Called by a tty driver to unregister itself.
3212 int tty_unregister_driver(struct tty_driver *driver)
3216 if (driver->refcount)
3219 unregister_chrdev_region(MKDEV(driver->major, driver->minor_start),
3221 mutex_lock(&tty_mutex);
3222 list_del(&driver->tty_drivers);
3223 mutex_unlock(&tty_mutex);
3227 EXPORT_SYMBOL(tty_unregister_driver);
3229 dev_t tty_devnum(struct tty_struct *tty)
3231 return MKDEV(tty->driver->major, tty->driver->minor_start) + tty->index;
3233 EXPORT_SYMBOL(tty_devnum);
3235 void proc_clear_tty(struct task_struct *p)
3237 unsigned long flags;
3238 struct tty_struct *tty;
3239 spin_lock_irqsave(&p->sighand->siglock, flags);
3240 tty = p->signal->tty;
3241 p->signal->tty = NULL;
3242 spin_unlock_irqrestore(&p->sighand->siglock, flags);
3246 /* Called under the sighand lock */
3248 static void __proc_set_tty(struct task_struct *tsk, struct tty_struct *tty)
3251 unsigned long flags;
3252 /* We should not have a session or pgrp to put here but.... */
3253 spin_lock_irqsave(&tty->ctrl_lock, flags);
3254 put_pid(tty->session);
3256 tty->pgrp = get_pid(task_pgrp(tsk));
3257 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
3258 tty->session = get_pid(task_session(tsk));
3259 if (tsk->signal->tty) {
3260 printk(KERN_DEBUG "tty not NULL!!\n");
3261 tty_kref_put(tsk->signal->tty);
3264 put_pid(tsk->signal->tty_old_pgrp);
3265 tsk->signal->tty = tty_kref_get(tty);
3266 tsk->signal->tty_old_pgrp = NULL;
3269 static void proc_set_tty(struct task_struct *tsk, struct tty_struct *tty)
3271 spin_lock_irq(&tsk->sighand->siglock);
3272 __proc_set_tty(tsk, tty);
3273 spin_unlock_irq(&tsk->sighand->siglock);
3276 struct tty_struct *get_current_tty(void)
3278 struct tty_struct *tty;
3279 unsigned long flags;
3281 spin_lock_irqsave(¤t->sighand->siglock, flags);
3282 tty = tty_kref_get(current->signal->tty);
3283 spin_unlock_irqrestore(¤t->sighand->siglock, flags);
3286 EXPORT_SYMBOL_GPL(get_current_tty);
3288 void tty_default_fops(struct file_operations *fops)
3294 * Initialize the console device. This is called *early*, so
3295 * we can't necessarily depend on lots of kernel help here.
3296 * Just do some early initializations, and do the complex setup
3299 void __init console_init(void)
3303 /* Setup the default TTY line discipline. */
3307 * set up the console device so that later boot sequences can
3308 * inform about problems etc..
3310 call = __con_initcall_start;
3311 while (call < __con_initcall_end) {
3317 static char *tty_devnode(struct device *dev, umode_t *mode)
3321 if (dev->devt == MKDEV(TTYAUX_MAJOR, 0) ||
3322 dev->devt == MKDEV(TTYAUX_MAJOR, 2))
3327 static int __init tty_class_init(void)
3329 tty_class = class_create(THIS_MODULE, "tty");
3330 if (IS_ERR(tty_class))
3331 return PTR_ERR(tty_class);
3332 tty_class->devnode = tty_devnode;
3336 postcore_initcall(tty_class_init);
3338 /* 3/2004 jmc: why do these devices exist? */
3339 static struct cdev tty_cdev, console_cdev;
3341 static ssize_t show_cons_active(struct device *dev,
3342 struct device_attribute *attr, char *buf)
3344 struct console *cs[16];
3350 for_each_console(c) {
3355 if ((c->flags & CON_ENABLED) == 0)
3358 if (i >= ARRAY_SIZE(cs))
3362 count += sprintf(buf + count, "%s%d%c",
3363 cs[i]->name, cs[i]->index, i ? ' ':'\n');
3368 static DEVICE_ATTR(active, S_IRUGO, show_cons_active, NULL);
3370 static struct device *consdev;
3372 void console_sysfs_notify(void)
3375 sysfs_notify(&consdev->kobj, NULL, "active");
3379 * Ok, now we can initialize the rest of the tty devices and can count
3380 * on memory allocations, interrupts etc..
3382 int __init tty_init(void)
3384 cdev_init(&tty_cdev, &tty_fops);
3385 if (cdev_add(&tty_cdev, MKDEV(TTYAUX_MAJOR, 0), 1) ||
3386 register_chrdev_region(MKDEV(TTYAUX_MAJOR, 0), 1, "/dev/tty") < 0)
3387 panic("Couldn't register /dev/tty driver\n");
3388 device_create(tty_class, NULL, MKDEV(TTYAUX_MAJOR, 0), NULL, "tty");
3390 cdev_init(&console_cdev, &console_fops);
3391 if (cdev_add(&console_cdev, MKDEV(TTYAUX_MAJOR, 1), 1) ||
3392 register_chrdev_region(MKDEV(TTYAUX_MAJOR, 1), 1, "/dev/console") < 0)
3393 panic("Couldn't register /dev/console driver\n");
3394 consdev = device_create(tty_class, NULL, MKDEV(TTYAUX_MAJOR, 1), NULL,
3396 if (IS_ERR(consdev))
3399 WARN_ON(device_create_file(consdev, &dev_attr_active) < 0);
3402 vty_init(&console_fops);