2 * linux/drivers/char/tty_io.c
4 * Copyright (C) 1991, 1992 Linus Torvalds
8 * 'tty_io.c' gives an orthogonal feeling to tty's, be they consoles
9 * or rs-channels. It also implements echoing, cooked mode etc.
11 * Kill-line thanks to John T Kohl, who also corrected VMIN = VTIME = 0.
13 * Modified by Theodore Ts'o, 9/14/92, to dynamically allocate the
14 * tty_struct and tty_queue structures. Previously there was an array
15 * of 256 tty_struct's which was statically allocated, and the
16 * tty_queue structures were allocated at boot time. Both are now
17 * dynamically allocated only when the tty is open.
19 * Also restructured routines so that there is more of a separation
20 * between the high-level tty routines (tty_io.c and tty_ioctl.c) and
21 * the low-level tty routines (serial.c, pty.c, console.c). This
22 * makes for cleaner and more compact code. -TYT, 9/17/92
24 * Modified by Fred N. van Kempen, 01/29/93, to add line disciplines
25 * which can be dynamically activated and de-activated by the line
26 * discipline handling modules (like SLIP).
28 * NOTE: pay no attention to the line discipline code (yet); its
29 * interface is still subject to change in this version...
32 * Added functionality to the OPOST tty handling. No delays, but all
33 * other bits should be there.
34 * -- Nick Holloway <alfie@dcs.warwick.ac.uk>, 27th May 1993.
36 * Rewrote canonical mode and added more termios flags.
37 * -- julian@uhunix.uhcc.hawaii.edu (J. Cowley), 13Jan94
39 * Reorganized FASYNC support so mouse code can share it.
40 * -- ctm@ardi.com, 9Sep95
42 * New TIOCLINUX variants added.
43 * -- mj@k332.feld.cvut.cz, 19-Nov-95
45 * Restrict vt switching via ioctl()
46 * -- grif@cs.ucr.edu, 5-Dec-95
48 * Move console and virtual terminal code to more appropriate files,
49 * implement CONFIG_VT and generalize console device interface.
50 * -- Marko Kohtala <Marko.Kohtala@hut.fi>, March 97
52 * Rewrote init_dev and release_dev to eliminate races.
53 * -- Bill Hawes <whawes@star.net>, June 97
55 * Added devfs support.
56 * -- C. Scott Ananian <cananian@alumni.princeton.edu>, 13-Jan-1998
58 * Added support for a Unix98-style ptmx device.
59 * -- C. Scott Ananian <cananian@alumni.princeton.edu>, 14-Jan-1998
61 * Reduced memory usage for older ARM systems
62 * -- Russell King <rmk@arm.linux.org.uk>
64 * Move do_SAK() into process context. Less stack use in devfs functions.
65 * alloc_tty_struct() always uses kmalloc()
66 * -- Andrew Morton <andrewm@uow.edu.eu> 17Mar01
69 #include <linux/types.h>
70 #include <linux/major.h>
71 #include <linux/errno.h>
72 #include <linux/signal.h>
73 #include <linux/fcntl.h>
74 #include <linux/sched.h>
75 #include <linux/interrupt.h>
76 #include <linux/tty.h>
77 #include <linux/tty_driver.h>
78 #include <linux/tty_flip.h>
79 #include <linux/devpts_fs.h>
80 #include <linux/file.h>
81 #include <linux/fdtable.h>
82 #include <linux/console.h>
83 #include <linux/timer.h>
84 #include <linux/ctype.h>
87 #include <linux/string.h>
88 #include <linux/slab.h>
89 #include <linux/poll.h>
90 #include <linux/proc_fs.h>
91 #include <linux/init.h>
92 #include <linux/module.h>
93 #include <linux/smp_lock.h>
94 #include <linux/device.h>
95 #include <linux/wait.h>
96 #include <linux/bitops.h>
97 #include <linux/delay.h>
98 #include <linux/seq_file.h>
100 #include <linux/uaccess.h>
101 #include <asm/system.h>
103 #include <linux/kbd_kern.h>
104 #include <linux/vt_kern.h>
105 #include <linux/selection.h>
107 #include <linux/kmod.h>
108 #include <linux/nsproxy.h>
110 #undef TTY_DEBUG_HANGUP
112 #define TTY_PARANOIA_CHECK 1
113 #define CHECK_TTY_COUNT 1
115 struct ktermios tty_std_termios = { /* for the benefit of tty drivers */
116 .c_iflag = ICRNL | IXON,
117 .c_oflag = OPOST | ONLCR,
118 .c_cflag = B38400 | CS8 | CREAD | HUPCL,
119 .c_lflag = ISIG | ICANON | ECHO | ECHOE | ECHOK |
120 ECHOCTL | ECHOKE | IEXTEN,
126 EXPORT_SYMBOL(tty_std_termios);
128 /* This list gets poked at by procfs and various bits of boot up code. This
129 could do with some rationalisation such as pulling the tty proc function
132 LIST_HEAD(tty_drivers); /* linked list of tty drivers */
134 /* Mutex to protect creating and releasing a tty. This is shared with
135 vt.c for deeply disgusting hack reasons */
136 DEFINE_MUTEX(tty_mutex);
137 EXPORT_SYMBOL(tty_mutex);
139 #ifdef CONFIG_UNIX98_PTYS
140 extern struct tty_driver *ptm_driver; /* Unix98 pty masters; for /dev/ptmx */
141 static int ptmx_open(struct inode *, struct file *);
144 static void initialize_tty_struct(struct tty_struct *tty);
146 static ssize_t tty_read(struct file *, char __user *, size_t, loff_t *);
147 static ssize_t tty_write(struct file *, const char __user *, size_t, loff_t *);
148 ssize_t redirected_tty_write(struct file *, const char __user *,
150 static unsigned int tty_poll(struct file *, poll_table *);
151 static int tty_open(struct inode *, struct file *);
152 static int tty_release(struct inode *, struct file *);
153 long tty_ioctl(struct file *file, unsigned int cmd, unsigned long arg);
155 static long tty_compat_ioctl(struct file *file, unsigned int cmd,
158 #define tty_compat_ioctl NULL
160 static int tty_fasync(int fd, struct file *filp, int on);
161 static void release_tty(struct tty_struct *tty, int idx);
162 static void __proc_set_tty(struct task_struct *tsk, struct tty_struct *tty);
163 static void proc_set_tty(struct task_struct *tsk, struct tty_struct *tty);
166 * alloc_tty_struct - allocate a tty object
168 * Return a new empty tty structure. The data fields have not
169 * been initialized in any way but has been zeroed
174 static struct tty_struct *alloc_tty_struct(void)
176 return kzalloc(sizeof(struct tty_struct), GFP_KERNEL);
180 * free_tty_struct - free a disused tty
181 * @tty: tty struct to free
183 * Free the write buffers, tty queue and tty memory itself.
185 * Locking: none. Must be called after tty is definitely unused
188 static inline void free_tty_struct(struct tty_struct *tty)
190 kfree(tty->write_buf);
191 tty_buffer_free_all(tty);
195 #define TTY_NUMBER(tty) ((tty)->index + (tty)->driver->name_base)
198 * tty_name - return tty naming
199 * @tty: tty structure
200 * @buf: buffer for output
202 * Convert a tty structure into a name. The name reflects the kernel
203 * naming policy and if udev is in use may not reflect user space
208 char *tty_name(struct tty_struct *tty, char *buf)
210 if (!tty) /* Hmm. NULL pointer. That's fun. */
211 strcpy(buf, "NULL tty");
213 strcpy(buf, tty->name);
217 EXPORT_SYMBOL(tty_name);
219 int tty_paranoia_check(struct tty_struct *tty, struct inode *inode,
222 #ifdef TTY_PARANOIA_CHECK
225 "null TTY for (%d:%d) in %s\n",
226 imajor(inode), iminor(inode), routine);
229 if (tty->magic != TTY_MAGIC) {
231 "bad magic number for tty struct (%d:%d) in %s\n",
232 imajor(inode), iminor(inode), routine);
239 static int check_tty_count(struct tty_struct *tty, const char *routine)
241 #ifdef CHECK_TTY_COUNT
246 list_for_each(p, &tty->tty_files) {
250 if (tty->driver->type == TTY_DRIVER_TYPE_PTY &&
251 tty->driver->subtype == PTY_TYPE_SLAVE &&
252 tty->link && tty->link->count)
254 if (tty->count != count) {
255 printk(KERN_WARNING "Warning: dev (%s) tty->count(%d) "
256 "!= #fd's(%d) in %s\n",
257 tty->name, tty->count, count, routine);
265 * get_tty_driver - find device of a tty
266 * @dev_t: device identifier
267 * @index: returns the index of the tty
269 * This routine returns a tty driver structure, given a device number
270 * and also passes back the index number.
272 * Locking: caller must hold tty_mutex
275 static struct tty_driver *get_tty_driver(dev_t device, int *index)
277 struct tty_driver *p;
279 list_for_each_entry(p, &tty_drivers, tty_drivers) {
280 dev_t base = MKDEV(p->major, p->minor_start);
281 if (device < base || device >= base + p->num)
283 *index = device - base;
289 #ifdef CONFIG_CONSOLE_POLL
292 * tty_find_polling_driver - find device of a polled tty
293 * @name: name string to match
294 * @line: pointer to resulting tty line nr
296 * This routine returns a tty driver structure, given a name
297 * and the condition that the tty driver is capable of polled
300 struct tty_driver *tty_find_polling_driver(char *name, int *line)
302 struct tty_driver *p, *res = NULL;
307 for (str = name; *str; str++)
308 if ((*str >= '0' && *str <= '9') || *str == ',')
314 tty_line = simple_strtoul(str, &str, 10);
316 mutex_lock(&tty_mutex);
317 /* Search through the tty devices to look for a match */
318 list_for_each_entry(p, &tty_drivers, tty_drivers) {
319 if (strncmp(name, p->name, len) != 0)
326 if (tty_line >= 0 && tty_line <= p->num && p->ops &&
327 p->ops->poll_init && !p->ops->poll_init(p, tty_line, str)) {
333 mutex_unlock(&tty_mutex);
337 EXPORT_SYMBOL_GPL(tty_find_polling_driver);
341 * tty_check_change - check for POSIX terminal changes
344 * If we try to write to, or set the state of, a terminal and we're
345 * not in the foreground, send a SIGTTOU. If the signal is blocked or
346 * ignored, go ahead and perform the operation. (POSIX 7.2)
351 int tty_check_change(struct tty_struct *tty)
356 if (current->signal->tty != tty)
359 spin_lock_irqsave(&tty->ctrl_lock, flags);
362 printk(KERN_WARNING "tty_check_change: tty->pgrp == NULL!\n");
365 if (task_pgrp(current) == tty->pgrp)
367 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
368 if (is_ignored(SIGTTOU))
370 if (is_current_pgrp_orphaned()) {
374 kill_pgrp(task_pgrp(current), SIGTTOU, 1);
375 set_thread_flag(TIF_SIGPENDING);
380 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
384 EXPORT_SYMBOL(tty_check_change);
386 static ssize_t hung_up_tty_read(struct file *file, char __user *buf,
387 size_t count, loff_t *ppos)
392 static ssize_t hung_up_tty_write(struct file *file, const char __user *buf,
393 size_t count, loff_t *ppos)
398 /* No kernel lock held - none needed ;) */
399 static unsigned int hung_up_tty_poll(struct file *filp, poll_table *wait)
401 return POLLIN | POLLOUT | POLLERR | POLLHUP | POLLRDNORM | POLLWRNORM;
404 static long hung_up_tty_ioctl(struct file *file, unsigned int cmd,
407 return cmd == TIOCSPGRP ? -ENOTTY : -EIO;
410 static long hung_up_tty_compat_ioctl(struct file *file,
411 unsigned int cmd, unsigned long arg)
413 return cmd == TIOCSPGRP ? -ENOTTY : -EIO;
416 static const struct file_operations tty_fops = {
421 .unlocked_ioctl = tty_ioctl,
422 .compat_ioctl = tty_compat_ioctl,
424 .release = tty_release,
425 .fasync = tty_fasync,
428 #ifdef CONFIG_UNIX98_PTYS
429 static const struct file_operations ptmx_fops = {
434 .unlocked_ioctl = tty_ioctl,
435 .compat_ioctl = tty_compat_ioctl,
437 .release = tty_release,
438 .fasync = tty_fasync,
442 static const struct file_operations console_fops = {
445 .write = redirected_tty_write,
447 .unlocked_ioctl = tty_ioctl,
448 .compat_ioctl = tty_compat_ioctl,
450 .release = tty_release,
451 .fasync = tty_fasync,
454 static const struct file_operations hung_up_tty_fops = {
456 .read = hung_up_tty_read,
457 .write = hung_up_tty_write,
458 .poll = hung_up_tty_poll,
459 .unlocked_ioctl = hung_up_tty_ioctl,
460 .compat_ioctl = hung_up_tty_compat_ioctl,
461 .release = tty_release,
464 static DEFINE_SPINLOCK(redirect_lock);
465 static struct file *redirect;
468 * tty_wakeup - request more data
471 * Internal and external helper for wakeups of tty. This function
472 * informs the line discipline if present that the driver is ready
473 * to receive more output data.
476 void tty_wakeup(struct tty_struct *tty)
478 struct tty_ldisc *ld;
480 if (test_bit(TTY_DO_WRITE_WAKEUP, &tty->flags)) {
481 ld = tty_ldisc_ref(tty);
483 if (ld->ops->write_wakeup)
484 ld->ops->write_wakeup(tty);
488 wake_up_interruptible(&tty->write_wait);
491 EXPORT_SYMBOL_GPL(tty_wakeup);
494 * tty_ldisc_flush - flush line discipline queue
497 * Flush the line discipline queue (if any) for this tty. If there
498 * is no line discipline active this is a no-op.
501 void tty_ldisc_flush(struct tty_struct *tty)
503 struct tty_ldisc *ld = tty_ldisc_ref(tty);
505 if (ld->ops->flush_buffer)
506 ld->ops->flush_buffer(tty);
509 tty_buffer_flush(tty);
512 EXPORT_SYMBOL_GPL(tty_ldisc_flush);
515 * tty_reset_termios - reset terminal state
518 * Restore a terminal to the driver default state
521 static void tty_reset_termios(struct tty_struct *tty)
523 mutex_lock(&tty->termios_mutex);
524 *tty->termios = tty->driver->init_termios;
525 tty->termios->c_ispeed = tty_termios_input_baud_rate(tty->termios);
526 tty->termios->c_ospeed = tty_termios_baud_rate(tty->termios);
527 mutex_unlock(&tty->termios_mutex);
531 * do_tty_hangup - actual handler for hangup events
534 * This can be called by the "eventd" kernel thread. That is process
535 * synchronous but doesn't hold any locks, so we need to make sure we
536 * have the appropriate locks for what we're doing.
538 * The hangup event clears any pending redirections onto the hung up
539 * device. It ensures future writes will error and it does the needed
540 * line discipline hangup and signal delivery. The tty object itself
545 * redirect lock for undoing redirection
546 * file list lock for manipulating list of ttys
547 * tty_ldisc_lock from called functions
548 * termios_mutex resetting termios data
549 * tasklist_lock to walk task list for hangup event
550 * ->siglock to protect ->signal/->sighand
552 static void do_tty_hangup(struct work_struct *work)
554 struct tty_struct *tty =
555 container_of(work, struct tty_struct, hangup_work);
556 struct file *cons_filp = NULL;
557 struct file *filp, *f = NULL;
558 struct task_struct *p;
559 struct tty_ldisc *ld;
560 int closecount = 0, n;
567 /* inuse_filps is protected by the single kernel lock */
570 spin_lock(&redirect_lock);
571 if (redirect && redirect->private_data == tty) {
575 spin_unlock(&redirect_lock);
577 check_tty_count(tty, "do_tty_hangup");
579 /* This breaks for file handles being sent over AF_UNIX sockets ? */
580 list_for_each_entry(filp, &tty->tty_files, f_u.fu_list) {
581 if (filp->f_op->write == redirected_tty_write)
583 if (filp->f_op->write != tty_write)
586 tty_fasync(-1, filp, 0); /* can't block */
587 filp->f_op = &hung_up_tty_fops;
591 * FIXME! What are the locking issues here? This may me overdoing
592 * things... This question is especially important now that we've
593 * removed the irqlock.
595 ld = tty_ldisc_ref(tty);
597 /* We may have no line discipline at this point */
598 if (ld->ops->flush_buffer)
599 ld->ops->flush_buffer(tty);
600 tty_driver_flush_buffer(tty);
601 if ((test_bit(TTY_DO_WRITE_WAKEUP, &tty->flags)) &&
602 ld->ops->write_wakeup)
603 ld->ops->write_wakeup(tty);
605 ld->ops->hangup(tty);
608 * FIXME: Once we trust the LDISC code better we can wait here for
609 * ldisc completion and fix the driver call race
611 wake_up_interruptible(&tty->write_wait);
612 wake_up_interruptible(&tty->read_wait);
614 * Shutdown the current line discipline, and reset it to
617 if (tty->driver->flags & TTY_DRIVER_RESET_TERMIOS)
618 tty_reset_termios(tty);
619 /* Defer ldisc switch */
620 /* tty_deferred_ldisc_switch(N_TTY);
622 This should get done automatically when the port closes and
623 tty_release is called */
625 read_lock(&tasklist_lock);
627 do_each_pid_task(tty->session, PIDTYPE_SID, p) {
628 spin_lock_irq(&p->sighand->siglock);
629 if (p->signal->tty == tty) {
630 p->signal->tty = NULL;
631 /* We defer the dereferences outside fo
635 if (!p->signal->leader) {
636 spin_unlock_irq(&p->sighand->siglock);
639 __group_send_sig_info(SIGHUP, SEND_SIG_PRIV, p);
640 __group_send_sig_info(SIGCONT, SEND_SIG_PRIV, p);
641 put_pid(p->signal->tty_old_pgrp); /* A noop */
642 spin_lock_irqsave(&tty->ctrl_lock, flags);
644 p->signal->tty_old_pgrp = get_pid(tty->pgrp);
645 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
646 spin_unlock_irq(&p->sighand->siglock);
647 } while_each_pid_task(tty->session, PIDTYPE_SID, p);
649 read_unlock(&tasklist_lock);
651 spin_lock_irqsave(&tty->ctrl_lock, flags);
653 put_pid(tty->session);
657 tty->ctrl_status = 0;
658 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
660 /* Account for the p->signal references we killed */
665 * If one of the devices matches a console pointer, we
666 * cannot just call hangup() because that will cause
667 * tty->count and state->count to go out of sync.
668 * So we just call close() the right number of times.
672 for (n = 0; n < closecount; n++)
673 tty->ops->close(tty, cons_filp);
674 } else if (tty->ops->hangup)
675 (tty->ops->hangup)(tty);
677 * We don't want to have driver/ldisc interactions beyond
678 * the ones we did here. The driver layer expects no
679 * calls after ->hangup() from the ldisc side. However we
680 * can't yet guarantee all that.
682 set_bit(TTY_HUPPED, &tty->flags);
684 tty_ldisc_enable(tty);
693 * tty_hangup - trigger a hangup event
694 * @tty: tty to hangup
696 * A carrier loss (virtual or otherwise) has occurred on this like
697 * schedule a hangup sequence to run after this event.
700 void tty_hangup(struct tty_struct *tty)
702 #ifdef TTY_DEBUG_HANGUP
704 printk(KERN_DEBUG "%s hangup...\n", tty_name(tty, buf));
706 schedule_work(&tty->hangup_work);
709 EXPORT_SYMBOL(tty_hangup);
712 * tty_vhangup - process vhangup
713 * @tty: tty to hangup
715 * The user has asked via system call for the terminal to be hung up.
716 * We do this synchronously so that when the syscall returns the process
717 * is complete. That guarantee is necessary for security reasons.
720 void tty_vhangup(struct tty_struct *tty)
722 #ifdef TTY_DEBUG_HANGUP
725 printk(KERN_DEBUG "%s vhangup...\n", tty_name(tty, buf));
727 do_tty_hangup(&tty->hangup_work);
730 EXPORT_SYMBOL(tty_vhangup);
733 * tty_vhangup_self - process vhangup for own ctty
735 * Perform a vhangup on the current controlling tty
738 void tty_vhangup_self(void)
740 struct tty_struct *tty;
742 mutex_lock(&tty_mutex);
743 tty = get_current_tty();
748 mutex_unlock(&tty_mutex);
752 * tty_hung_up_p - was tty hung up
753 * @filp: file pointer of tty
755 * Return true if the tty has been subject to a vhangup or a carrier
759 int tty_hung_up_p(struct file *filp)
761 return (filp->f_op == &hung_up_tty_fops);
764 EXPORT_SYMBOL(tty_hung_up_p);
766 static void session_clear_tty(struct pid *session)
768 struct task_struct *p;
769 do_each_pid_task(session, PIDTYPE_SID, p) {
771 } while_each_pid_task(session, PIDTYPE_SID, p);
775 * disassociate_ctty - disconnect controlling tty
776 * @on_exit: true if exiting so need to "hang up" the session
778 * This function is typically called only by the session leader, when
779 * it wants to disassociate itself from its controlling tty.
781 * It performs the following functions:
782 * (1) Sends a SIGHUP and SIGCONT to the foreground process group
783 * (2) Clears the tty from being controlling the session
784 * (3) Clears the controlling tty for all processes in the
787 * The argument on_exit is set to 1 if called when a process is
788 * exiting; it is 0 if called by the ioctl TIOCNOTTY.
791 * BKL is taken for hysterical raisins
792 * tty_mutex is taken to protect tty
793 * ->siglock is taken to protect ->signal/->sighand
794 * tasklist_lock is taken to walk process list for sessions
795 * ->siglock is taken to protect ->signal/->sighand
798 void disassociate_ctty(int on_exit)
800 struct tty_struct *tty;
801 struct pid *tty_pgrp = NULL;
804 mutex_lock(&tty_mutex);
805 tty = get_current_tty();
807 tty_pgrp = get_pid(tty->pgrp);
808 mutex_unlock(&tty_mutex);
810 if (on_exit && tty->driver->type != TTY_DRIVER_TYPE_PTY)
814 } else if (on_exit) {
815 struct pid *old_pgrp;
816 spin_lock_irq(¤t->sighand->siglock);
817 old_pgrp = current->signal->tty_old_pgrp;
818 current->signal->tty_old_pgrp = NULL;
819 spin_unlock_irq(¤t->sighand->siglock);
821 kill_pgrp(old_pgrp, SIGHUP, on_exit);
822 kill_pgrp(old_pgrp, SIGCONT, on_exit);
825 mutex_unlock(&tty_mutex);
829 kill_pgrp(tty_pgrp, SIGHUP, on_exit);
831 kill_pgrp(tty_pgrp, SIGCONT, on_exit);
835 spin_lock_irq(¤t->sighand->siglock);
836 put_pid(current->signal->tty_old_pgrp);
837 current->signal->tty_old_pgrp = NULL;
838 spin_unlock_irq(¤t->sighand->siglock);
840 mutex_lock(&tty_mutex);
841 tty = get_current_tty();
844 spin_lock_irqsave(&tty->ctrl_lock, flags);
845 put_pid(tty->session);
849 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
852 #ifdef TTY_DEBUG_HANGUP
853 printk(KERN_DEBUG "error attempted to write to tty [0x%p]"
857 mutex_unlock(&tty_mutex);
859 /* Now clear signal->tty under the lock */
860 read_lock(&tasklist_lock);
861 session_clear_tty(task_session(current));
862 read_unlock(&tasklist_lock);
867 * no_tty - Ensure the current process does not have a controlling tty
871 struct task_struct *tsk = current;
873 if (tsk->signal->leader)
874 disassociate_ctty(0);
881 * stop_tty - propagate flow control
884 * Perform flow control to the driver. For PTY/TTY pairs we
885 * must also propagate the TIOCKPKT status. May be called
886 * on an already stopped device and will not re-call the driver
889 * This functionality is used by both the line disciplines for
890 * halting incoming flow and by the driver. It may therefore be
891 * called from any context, may be under the tty atomic_write_lock
895 * Uses the tty control lock internally
898 void stop_tty(struct tty_struct *tty)
901 spin_lock_irqsave(&tty->ctrl_lock, flags);
903 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
907 if (tty->link && tty->link->packet) {
908 tty->ctrl_status &= ~TIOCPKT_START;
909 tty->ctrl_status |= TIOCPKT_STOP;
910 wake_up_interruptible(&tty->link->read_wait);
912 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
914 (tty->ops->stop)(tty);
917 EXPORT_SYMBOL(stop_tty);
920 * start_tty - propagate flow control
923 * Start a tty that has been stopped if at all possible. Perform
924 * any necessary wakeups and propagate the TIOCPKT status. If this
925 * is the tty was previous stopped and is being started then the
926 * driver start method is invoked and the line discipline woken.
932 void start_tty(struct tty_struct *tty)
935 spin_lock_irqsave(&tty->ctrl_lock, flags);
936 if (!tty->stopped || tty->flow_stopped) {
937 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
941 if (tty->link && tty->link->packet) {
942 tty->ctrl_status &= ~TIOCPKT_STOP;
943 tty->ctrl_status |= TIOCPKT_START;
944 wake_up_interruptible(&tty->link->read_wait);
946 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
948 (tty->ops->start)(tty);
949 /* If we have a running line discipline it may need kicking */
953 EXPORT_SYMBOL(start_tty);
956 * tty_read - read method for tty device files
957 * @file: pointer to tty file
959 * @count: size of user buffer
962 * Perform the read system call function on this terminal device. Checks
963 * for hung up devices before calling the line discipline method.
966 * Locks the line discipline internally while needed. Multiple
967 * read calls may be outstanding in parallel.
970 static ssize_t tty_read(struct file *file, char __user *buf, size_t count,
974 struct tty_struct *tty;
976 struct tty_ldisc *ld;
978 tty = (struct tty_struct *)file->private_data;
979 inode = file->f_path.dentry->d_inode;
980 if (tty_paranoia_check(tty, inode, "tty_read"))
982 if (!tty || (test_bit(TTY_IO_ERROR, &tty->flags)))
985 /* We want to wait for the line discipline to sort out in this
987 ld = tty_ldisc_ref_wait(tty);
989 i = (ld->ops->read)(tty, file, buf, count);
994 inode->i_atime = current_fs_time(inode->i_sb);
998 void tty_write_unlock(struct tty_struct *tty)
1000 mutex_unlock(&tty->atomic_write_lock);
1001 wake_up_interruptible(&tty->write_wait);
1004 int tty_write_lock(struct tty_struct *tty, int ndelay)
1006 if (!mutex_trylock(&tty->atomic_write_lock)) {
1009 if (mutex_lock_interruptible(&tty->atomic_write_lock))
1010 return -ERESTARTSYS;
1016 * Split writes up in sane blocksizes to avoid
1017 * denial-of-service type attacks
1019 static inline ssize_t do_tty_write(
1020 ssize_t (*write)(struct tty_struct *, struct file *, const unsigned char *, size_t),
1021 struct tty_struct *tty,
1023 const char __user *buf,
1026 ssize_t ret, written = 0;
1029 ret = tty_write_lock(tty, file->f_flags & O_NDELAY);
1034 * We chunk up writes into a temporary buffer. This
1035 * simplifies low-level drivers immensely, since they
1036 * don't have locking issues and user mode accesses.
1038 * But if TTY_NO_WRITE_SPLIT is set, we should use a
1041 * The default chunk-size is 2kB, because the NTTY
1042 * layer has problems with bigger chunks. It will
1043 * claim to be able to handle more characters than
1046 * FIXME: This can probably go away now except that 64K chunks
1047 * are too likely to fail unless switched to vmalloc...
1050 if (test_bit(TTY_NO_WRITE_SPLIT, &tty->flags))
1055 /* write_buf/write_cnt is protected by the atomic_write_lock mutex */
1056 if (tty->write_cnt < chunk) {
1062 buf = kmalloc(chunk, GFP_KERNEL);
1067 kfree(tty->write_buf);
1068 tty->write_cnt = chunk;
1069 tty->write_buf = buf;
1072 /* Do the write .. */
1074 size_t size = count;
1078 if (copy_from_user(tty->write_buf, buf, size))
1080 ret = write(tty, file, tty->write_buf, size);
1089 if (signal_pending(current))
1094 struct inode *inode = file->f_path.dentry->d_inode;
1095 inode->i_mtime = current_fs_time(inode->i_sb);
1099 tty_write_unlock(tty);
1104 * tty_write_message - write a message to a certain tty, not just the console.
1105 * @tty: the destination tty_struct
1106 * @msg: the message to write
1108 * This is used for messages that need to be redirected to a specific tty.
1109 * We don't put it into the syslog queue right now maybe in the future if
1112 * We must still hold the BKL and test the CLOSING flag for the moment.
1115 void tty_write_message(struct tty_struct *tty, char *msg)
1119 mutex_lock(&tty->atomic_write_lock);
1120 if (tty->ops->write && !test_bit(TTY_CLOSING, &tty->flags))
1121 tty->ops->write(tty, msg, strlen(msg));
1122 tty_write_unlock(tty);
1130 * tty_write - write method for tty device file
1131 * @file: tty file pointer
1132 * @buf: user data to write
1133 * @count: bytes to write
1136 * Write data to a tty device via the line discipline.
1139 * Locks the line discipline as required
1140 * Writes to the tty driver are serialized by the atomic_write_lock
1141 * and are then processed in chunks to the device. The line discipline
1142 * write method will not be involked in parallel for each device
1143 * The line discipline write method is called under the big
1144 * kernel lock for historical reasons. New code should not rely on this.
1147 static ssize_t tty_write(struct file *file, const char __user *buf,
1148 size_t count, loff_t *ppos)
1150 struct tty_struct *tty;
1151 struct inode *inode = file->f_path.dentry->d_inode;
1153 struct tty_ldisc *ld;
1155 tty = (struct tty_struct *)file->private_data;
1156 if (tty_paranoia_check(tty, inode, "tty_write"))
1158 if (!tty || !tty->ops->write ||
1159 (test_bit(TTY_IO_ERROR, &tty->flags)))
1161 /* Short term debug to catch buggy drivers */
1162 if (tty->ops->write_room == NULL)
1163 printk(KERN_ERR "tty driver %s lacks a write_room method.\n",
1165 ld = tty_ldisc_ref_wait(tty);
1166 if (!ld->ops->write)
1169 ret = do_tty_write(ld->ops->write, tty, file, buf, count);
1170 tty_ldisc_deref(ld);
1174 ssize_t redirected_tty_write(struct file *file, const char __user *buf,
1175 size_t count, loff_t *ppos)
1177 struct file *p = NULL;
1179 spin_lock(&redirect_lock);
1184 spin_unlock(&redirect_lock);
1188 res = vfs_write(p, buf, count, &p->f_pos);
1192 return tty_write(file, buf, count, ppos);
1195 static char ptychar[] = "pqrstuvwxyzabcde";
1198 * pty_line_name - generate name for a pty
1199 * @driver: the tty driver in use
1200 * @index: the minor number
1201 * @p: output buffer of at least 6 bytes
1203 * Generate a name from a driver reference and write it to the output
1208 static void pty_line_name(struct tty_driver *driver, int index, char *p)
1210 int i = index + driver->name_base;
1211 /* ->name is initialized to "ttyp", but "tty" is expected */
1212 sprintf(p, "%s%c%x",
1213 driver->subtype == PTY_TYPE_SLAVE ? "tty" : driver->name,
1214 ptychar[i >> 4 & 0xf], i & 0xf);
1218 * pty_line_name - generate name for a tty
1219 * @driver: the tty driver in use
1220 * @index: the minor number
1221 * @p: output buffer of at least 7 bytes
1223 * Generate a name from a driver reference and write it to the output
1228 static void tty_line_name(struct tty_driver *driver, int index, char *p)
1230 sprintf(p, "%s%d", driver->name, index + driver->name_base);
1234 * init_dev - initialise a tty device
1235 * @driver: tty driver we are opening a device on
1236 * @idx: device index
1237 * @tty: returned tty structure
1239 * Prepare a tty device. This may not be a "new" clean device but
1240 * could also be an active device. The pty drivers require special
1241 * handling because of this.
1244 * The function is called under the tty_mutex, which
1245 * protects us from the tty struct or driver itself going away.
1247 * On exit the tty device has the line discipline attached and
1248 * a reference count of 1. If a pair was created for pty/tty use
1249 * and the other was a pty master then it too has a reference count of 1.
1251 * WSH 06/09/97: Rewritten to remove races and properly clean up after a
1252 * failed open. The new code protects the open with a mutex, so it's
1253 * really quite straightforward. The mutex locking can probably be
1254 * relaxed for the (most common) case of reopening a tty.
1257 static int init_dev(struct tty_driver *driver, int idx,
1258 struct tty_struct **ret_tty)
1260 struct tty_struct *tty, *o_tty;
1261 struct ktermios *tp, **tp_loc, *o_tp, **o_tp_loc;
1262 struct ktermios *ltp, **ltp_loc, *o_ltp, **o_ltp_loc;
1265 /* check whether we're reopening an existing tty */
1266 if (driver->flags & TTY_DRIVER_DEVPTS_MEM) {
1267 tty = devpts_get_tty(idx);
1269 * If we don't have a tty here on a slave open, it's because
1270 * the master already started the close process and there's
1271 * no relation between devpts file and tty anymore.
1273 if (!tty && driver->subtype == PTY_TYPE_SLAVE) {
1278 * It's safe from now on because init_dev() is called with
1279 * tty_mutex held and release_dev() won't change tty->count
1280 * or tty->flags without having to grab tty_mutex
1282 if (tty && driver->subtype == PTY_TYPE_MASTER)
1285 tty = driver->ttys[idx];
1287 if (tty) goto fast_track;
1290 * First time open is complex, especially for PTY devices.
1291 * This code guarantees that either everything succeeds and the
1292 * TTY is ready for operation, or else the table slots are vacated
1293 * and the allocated memory released. (Except that the termios
1294 * and locked termios may be retained.)
1297 if (!try_module_get(driver->owner)) {
1306 tty = alloc_tty_struct();
1309 initialize_tty_struct(tty);
1310 tty->driver = driver;
1311 tty->ops = driver->ops;
1313 tty_line_name(driver, idx, tty->name);
1315 if (driver->flags & TTY_DRIVER_DEVPTS_MEM) {
1316 tp_loc = &tty->termios;
1317 ltp_loc = &tty->termios_locked;
1319 tp_loc = &driver->termios[idx];
1320 ltp_loc = &driver->termios_locked[idx];
1324 tp = kmalloc(sizeof(struct ktermios), GFP_KERNEL);
1327 *tp = driver->init_termios;
1331 ltp = kzalloc(sizeof(struct ktermios), GFP_KERNEL);
1336 if (driver->type == TTY_DRIVER_TYPE_PTY) {
1337 o_tty = alloc_tty_struct();
1340 if (!try_module_get(driver->other->owner)) {
1341 /* This cannot in fact currently happen */
1342 free_tty_struct(o_tty);
1346 initialize_tty_struct(o_tty);
1347 o_tty->driver = driver->other;
1348 o_tty->ops = driver->ops;
1350 tty_line_name(driver->other, idx, o_tty->name);
1352 if (driver->flags & TTY_DRIVER_DEVPTS_MEM) {
1353 o_tp_loc = &o_tty->termios;
1354 o_ltp_loc = &o_tty->termios_locked;
1356 o_tp_loc = &driver->other->termios[idx];
1357 o_ltp_loc = &driver->other->termios_locked[idx];
1361 o_tp = kmalloc(sizeof(struct ktermios), GFP_KERNEL);
1364 *o_tp = driver->other->init_termios;
1368 o_ltp = kzalloc(sizeof(struct ktermios), GFP_KERNEL);
1374 * Everything allocated ... set up the o_tty structure.
1376 if (!(driver->other->flags & TTY_DRIVER_DEVPTS_MEM))
1377 driver->other->ttys[idx] = o_tty;
1382 o_tty->termios = *o_tp_loc;
1383 o_tty->termios_locked = *o_ltp_loc;
1384 driver->other->refcount++;
1385 if (driver->subtype == PTY_TYPE_MASTER)
1388 /* Establish the links in both directions */
1394 * All structures have been allocated, so now we install them.
1395 * Failures after this point use release_tty to clean up, so
1396 * there's no need to null out the local pointers.
1398 if (!(driver->flags & TTY_DRIVER_DEVPTS_MEM))
1399 driver->ttys[idx] = tty;
1405 tty->termios = *tp_loc;
1406 tty->termios_locked = *ltp_loc;
1407 /* Compatibility until drivers always set this */
1408 tty->termios->c_ispeed = tty_termios_input_baud_rate(tty->termios);
1409 tty->termios->c_ospeed = tty_termios_baud_rate(tty->termios);
1414 * Structures all installed ... call the ldisc open routines.
1415 * If we fail here just call release_tty to clean up. No need
1416 * to decrement the use counts, as release_tty doesn't care.
1419 retval = tty_ldisc_setup(tty, o_tty);
1422 goto release_mem_out;
1426 * This fast open can be used if the tty is already open.
1427 * No memory is allocated, and the only failures are from
1428 * attempting to open a closing tty or attempting multiple
1429 * opens on a pty master.
1432 if (test_bit(TTY_CLOSING, &tty->flags)) {
1436 if (driver->type == TTY_DRIVER_TYPE_PTY &&
1437 driver->subtype == PTY_TYPE_MASTER) {
1439 * special case for PTY masters: only one open permitted,
1440 * and the slave side open count is incremented as well.
1449 tty->driver = driver; /* N.B. why do this every time?? */
1452 if (!test_bit(TTY_LDISC, &tty->flags))
1453 printk(KERN_ERR "init_dev but no ldisc\n");
1457 /* All paths come through here to release the mutex */
1461 /* Release locally allocated memory ... nothing placed in slots */
1465 module_put(o_tty->driver->owner);
1466 free_tty_struct(o_tty);
1470 free_tty_struct(tty);
1473 module_put(driver->owner);
1477 /* call the tty release_tty routine to clean out this slot */
1479 if (printk_ratelimit())
1480 printk(KERN_INFO "init_dev: ldisc open failed, "
1481 "clearing slot %d\n", idx);
1482 release_tty(tty, idx);
1487 * release_one_tty - release tty structure memory
1488 * @kref: kref of tty we are obliterating
1490 * Releases memory associated with a tty structure, and clears out the
1491 * driver table slots. This function is called when a device is no longer
1492 * in use. It also gets called when setup of a device fails.
1495 * tty_mutex - sometimes only
1496 * takes the file list lock internally when working on the list
1497 * of ttys that the driver keeps.
1499 static void release_one_tty(struct kref *kref)
1501 struct tty_struct *tty = container_of(kref, struct tty_struct, kref);
1502 struct tty_driver *driver = tty->driver;
1503 int devpts = tty->driver->flags & TTY_DRIVER_DEVPTS_MEM;
1504 struct ktermios *tp;
1505 int idx = tty->index;
1508 tty->driver->ttys[idx] = NULL;
1510 if (tty->driver->flags & TTY_DRIVER_RESET_TERMIOS) {
1511 /* FIXME: Locking on ->termios array */
1514 tty->driver->termios[idx] = NULL;
1517 tp = tty->termios_locked;
1519 tty->driver->termios_locked[idx] = NULL;
1525 /* FIXME: locking on tty->driver->refcount */
1526 tty->driver->refcount--;
1527 module_put(driver->owner);
1530 list_del_init(&tty->tty_files);
1533 free_tty_struct(tty);
1537 * tty_kref_put - release a tty kref
1540 * Release a reference to a tty device and if need be let the kref
1541 * layer destruct the object for us
1544 void tty_kref_put(struct tty_struct *tty)
1547 kref_put(&tty->kref, release_one_tty);
1549 EXPORT_SYMBOL(tty_kref_put);
1552 * release_tty - release tty structure memory
1554 * Release both @tty and a possible linked partner (think pty pair),
1555 * and decrement the refcount of the backing module.
1558 * tty_mutex - sometimes only
1559 * takes the file list lock internally when working on the list
1560 * of ttys that the driver keeps.
1561 * FIXME: should we require tty_mutex is held here ??
1564 static void release_tty(struct tty_struct *tty, int idx)
1566 /* This should always be true but check for the moment */
1567 WARN_ON(tty->index != idx);
1570 tty_kref_put(tty->link);
1575 * Even releasing the tty structures is a tricky business.. We have
1576 * to be very careful that the structures are all released at the
1577 * same time, as interrupts might otherwise get the wrong pointers.
1579 * WSH 09/09/97: rewritten to avoid some nasty race conditions that could
1580 * lead to double frees or releasing memory still in use.
1582 static void release_dev(struct file *filp)
1584 struct tty_struct *tty, *o_tty;
1585 int pty_master, tty_closing, o_tty_closing, do_sleep;
1590 tty = (struct tty_struct *)filp->private_data;
1591 if (tty_paranoia_check(tty, filp->f_path.dentry->d_inode,
1595 check_tty_count(tty, "release_dev");
1597 tty_fasync(-1, filp, 0);
1600 pty_master = (tty->driver->type == TTY_DRIVER_TYPE_PTY &&
1601 tty->driver->subtype == PTY_TYPE_MASTER);
1602 devpts = (tty->driver->flags & TTY_DRIVER_DEVPTS_MEM) != 0;
1605 #ifdef TTY_PARANOIA_CHECK
1606 if (idx < 0 || idx >= tty->driver->num) {
1607 printk(KERN_DEBUG "release_dev: bad idx when trying to "
1608 "free (%s)\n", tty->name);
1611 if (!(tty->driver->flags & TTY_DRIVER_DEVPTS_MEM)) {
1612 if (tty != tty->driver->ttys[idx]) {
1613 printk(KERN_DEBUG "release_dev: driver.table[%d] not tty "
1614 "for (%s)\n", idx, tty->name);
1617 if (tty->termios != tty->driver->termios[idx]) {
1618 printk(KERN_DEBUG "release_dev: driver.termios[%d] not termios "
1623 if (tty->termios_locked != tty->driver->termios_locked[idx]) {
1624 printk(KERN_DEBUG "release_dev: driver.termios_locked[%d] not "
1625 "termios_locked for (%s)\n",
1632 #ifdef TTY_DEBUG_HANGUP
1633 printk(KERN_DEBUG "release_dev of %s (tty count=%d)...",
1634 tty_name(tty, buf), tty->count);
1637 #ifdef TTY_PARANOIA_CHECK
1638 if (tty->driver->other &&
1639 !(tty->driver->flags & TTY_DRIVER_DEVPTS_MEM)) {
1640 if (o_tty != tty->driver->other->ttys[idx]) {
1641 printk(KERN_DEBUG "release_dev: other->table[%d] "
1642 "not o_tty for (%s)\n",
1646 if (o_tty->termios != tty->driver->other->termios[idx]) {
1647 printk(KERN_DEBUG "release_dev: other->termios[%d] "
1648 "not o_termios for (%s)\n",
1652 if (o_tty->termios_locked !=
1653 tty->driver->other->termios_locked[idx]) {
1654 printk(KERN_DEBUG "release_dev: other->termios_locked["
1655 "%d] not o_termios_locked for (%s)\n",
1659 if (o_tty->link != tty) {
1660 printk(KERN_DEBUG "release_dev: bad pty pointers\n");
1665 if (tty->ops->close)
1666 tty->ops->close(tty, filp);
1669 * Sanity check: if tty->count is going to zero, there shouldn't be
1670 * any waiters on tty->read_wait or tty->write_wait. We test the
1671 * wait queues and kick everyone out _before_ actually starting to
1672 * close. This ensures that we won't block while releasing the tty
1675 * The test for the o_tty closing is necessary, since the master and
1676 * slave sides may close in any order. If the slave side closes out
1677 * first, its count will be one, since the master side holds an open.
1678 * Thus this test wouldn't be triggered at the time the slave closes,
1681 * Note that it's possible for the tty to be opened again while we're
1682 * flushing out waiters. By recalculating the closing flags before
1683 * each iteration we avoid any problems.
1686 /* Guard against races with tty->count changes elsewhere and
1687 opens on /dev/tty */
1689 mutex_lock(&tty_mutex);
1690 tty_closing = tty->count <= 1;
1691 o_tty_closing = o_tty &&
1692 (o_tty->count <= (pty_master ? 1 : 0));
1696 if (waitqueue_active(&tty->read_wait)) {
1697 wake_up(&tty->read_wait);
1700 if (waitqueue_active(&tty->write_wait)) {
1701 wake_up(&tty->write_wait);
1705 if (o_tty_closing) {
1706 if (waitqueue_active(&o_tty->read_wait)) {
1707 wake_up(&o_tty->read_wait);
1710 if (waitqueue_active(&o_tty->write_wait)) {
1711 wake_up(&o_tty->write_wait);
1718 printk(KERN_WARNING "release_dev: %s: read/write wait queue "
1719 "active!\n", tty_name(tty, buf));
1720 mutex_unlock(&tty_mutex);
1725 * The closing flags are now consistent with the open counts on
1726 * both sides, and we've completed the last operation that could
1727 * block, so it's safe to proceed with closing.
1730 if (--o_tty->count < 0) {
1731 printk(KERN_WARNING "release_dev: bad pty slave count "
1733 o_tty->count, tty_name(o_tty, buf));
1737 if (--tty->count < 0) {
1738 printk(KERN_WARNING "release_dev: bad tty->count (%d) for %s\n",
1739 tty->count, tty_name(tty, buf));
1744 * We've decremented tty->count, so we need to remove this file
1745 * descriptor off the tty->tty_files list; this serves two
1747 * - check_tty_count sees the correct number of file descriptors
1748 * associated with this tty.
1749 * - do_tty_hangup no longer sees this file descriptor as
1750 * something that needs to be handled for hangups.
1753 filp->private_data = NULL;
1756 * Perform some housekeeping before deciding whether to return.
1758 * Set the TTY_CLOSING flag if this was the last open. In the
1759 * case of a pty we may have to wait around for the other side
1760 * to close, and TTY_CLOSING makes sure we can't be reopened.
1763 set_bit(TTY_CLOSING, &tty->flags);
1765 set_bit(TTY_CLOSING, &o_tty->flags);
1768 * If _either_ side is closing, make sure there aren't any
1769 * processes that still think tty or o_tty is their controlling
1772 if (tty_closing || o_tty_closing) {
1773 read_lock(&tasklist_lock);
1774 session_clear_tty(tty->session);
1776 session_clear_tty(o_tty->session);
1777 read_unlock(&tasklist_lock);
1780 mutex_unlock(&tty_mutex);
1782 /* check whether both sides are closing ... */
1783 if (!tty_closing || (o_tty && !o_tty_closing))
1786 #ifdef TTY_DEBUG_HANGUP
1787 printk(KERN_DEBUG "freeing tty structure...");
1790 * Ask the line discipline code to release its structures
1792 tty_ldisc_release(tty, o_tty);
1794 * The release_tty function takes care of the details of clearing
1795 * the slots and preserving the termios structure.
1797 release_tty(tty, idx);
1799 /* Make this pty number available for reallocation */
1801 devpts_kill_index(idx);
1805 * tty_open - open a tty device
1806 * @inode: inode of device file
1807 * @filp: file pointer to tty
1809 * tty_open and tty_release keep up the tty count that contains the
1810 * number of opens done on a tty. We cannot use the inode-count, as
1811 * different inodes might point to the same tty.
1813 * Open-counting is needed for pty masters, as well as for keeping
1814 * track of serial lines: DTR is dropped when the last close happens.
1815 * (This is not done solely through tty->count, now. - Ted 1/27/92)
1817 * The termios state of a pty is reset on first open so that
1818 * settings don't persist across reuse.
1820 * Locking: tty_mutex protects tty, get_tty_driver and init_dev work.
1821 * tty->count should protect the rest.
1822 * ->siglock protects ->signal/->sighand
1825 static int __tty_open(struct inode *inode, struct file *filp)
1827 struct tty_struct *tty;
1829 struct tty_driver *driver;
1831 dev_t device = inode->i_rdev;
1832 unsigned short saved_flags = filp->f_flags;
1834 nonseekable_open(inode, filp);
1837 noctty = filp->f_flags & O_NOCTTY;
1841 mutex_lock(&tty_mutex);
1843 if (device == MKDEV(TTYAUX_MAJOR, 0)) {
1844 tty = get_current_tty();
1846 mutex_unlock(&tty_mutex);
1849 driver = tty->driver;
1851 filp->f_flags |= O_NONBLOCK; /* Don't let /dev/tty block */
1853 /* FIXME: Should we take a driver reference ? */
1858 if (device == MKDEV(TTY_MAJOR, 0)) {
1859 extern struct tty_driver *console_driver;
1860 driver = console_driver;
1866 if (device == MKDEV(TTYAUX_MAJOR, 1)) {
1867 driver = console_device(&index);
1869 /* Don't let /dev/console block */
1870 filp->f_flags |= O_NONBLOCK;
1874 mutex_unlock(&tty_mutex);
1878 driver = get_tty_driver(device, &index);
1880 mutex_unlock(&tty_mutex);
1884 retval = init_dev(driver, index, &tty);
1885 mutex_unlock(&tty_mutex);
1889 filp->private_data = tty;
1890 file_move(filp, &tty->tty_files);
1891 check_tty_count(tty, "tty_open");
1892 if (tty->driver->type == TTY_DRIVER_TYPE_PTY &&
1893 tty->driver->subtype == PTY_TYPE_MASTER)
1895 #ifdef TTY_DEBUG_HANGUP
1896 printk(KERN_DEBUG "opening %s...", tty->name);
1900 retval = tty->ops->open(tty, filp);
1904 filp->f_flags = saved_flags;
1906 if (!retval && test_bit(TTY_EXCLUSIVE, &tty->flags) &&
1907 !capable(CAP_SYS_ADMIN))
1911 #ifdef TTY_DEBUG_HANGUP
1912 printk(KERN_DEBUG "error %d in opening %s...", retval,
1916 if (retval != -ERESTARTSYS)
1918 if (signal_pending(current))
1922 * Need to reset f_op in case a hangup happened.
1924 if (filp->f_op == &hung_up_tty_fops)
1925 filp->f_op = &tty_fops;
1929 mutex_lock(&tty_mutex);
1930 spin_lock_irq(¤t->sighand->siglock);
1932 current->signal->leader &&
1933 !current->signal->tty &&
1934 tty->session == NULL)
1935 __proc_set_tty(current, tty);
1936 spin_unlock_irq(¤t->sighand->siglock);
1937 mutex_unlock(&tty_mutex);
1941 /* BKL pushdown: scary code avoidance wrapper */
1942 static int tty_open(struct inode *inode, struct file *filp)
1947 ret = __tty_open(inode, filp);
1954 #ifdef CONFIG_UNIX98_PTYS
1956 * ptmx_open - open a unix 98 pty master
1957 * @inode: inode of device file
1958 * @filp: file pointer to tty
1960 * Allocate a unix98 pty master device from the ptmx driver.
1962 * Locking: tty_mutex protects theinit_dev work. tty->count should
1964 * allocated_ptys_lock handles the list of free pty numbers
1967 static int __ptmx_open(struct inode *inode, struct file *filp)
1969 struct tty_struct *tty;
1973 nonseekable_open(inode, filp);
1975 /* find a device that is not in use. */
1976 index = devpts_new_index();
1980 mutex_lock(&tty_mutex);
1981 retval = init_dev(ptm_driver, index, &tty);
1982 mutex_unlock(&tty_mutex);
1987 set_bit(TTY_PTY_LOCK, &tty->flags); /* LOCK THE SLAVE */
1988 filp->private_data = tty;
1989 file_move(filp, &tty->tty_files);
1991 retval = devpts_pty_new(tty->link);
1995 check_tty_count(tty, "ptmx_open");
1996 retval = ptm_driver->ops->open(tty, filp);
2003 devpts_kill_index(index);
2007 static int ptmx_open(struct inode *inode, struct file *filp)
2012 ret = __ptmx_open(inode, filp);
2019 * tty_release - vfs callback for close
2020 * @inode: inode of tty
2021 * @filp: file pointer for handle to tty
2023 * Called the last time each file handle is closed that references
2024 * this tty. There may however be several such references.
2027 * Takes bkl. See release_dev
2030 static int tty_release(struct inode *inode, struct file *filp)
2039 * tty_poll - check tty status
2040 * @filp: file being polled
2041 * @wait: poll wait structures to update
2043 * Call the line discipline polling method to obtain the poll
2044 * status of the device.
2046 * Locking: locks called line discipline but ldisc poll method
2047 * may be re-entered freely by other callers.
2050 static unsigned int tty_poll(struct file *filp, poll_table *wait)
2052 struct tty_struct *tty;
2053 struct tty_ldisc *ld;
2056 tty = (struct tty_struct *)filp->private_data;
2057 if (tty_paranoia_check(tty, filp->f_path.dentry->d_inode, "tty_poll"))
2060 ld = tty_ldisc_ref_wait(tty);
2062 ret = (ld->ops->poll)(tty, filp, wait);
2063 tty_ldisc_deref(ld);
2067 static int tty_fasync(int fd, struct file *filp, int on)
2069 struct tty_struct *tty;
2070 unsigned long flags;
2074 tty = (struct tty_struct *)filp->private_data;
2075 if (tty_paranoia_check(tty, filp->f_path.dentry->d_inode, "tty_fasync"))
2078 retval = fasync_helper(fd, filp, on, &tty->fasync);
2085 if (!waitqueue_active(&tty->read_wait))
2086 tty->minimum_to_wake = 1;
2087 spin_lock_irqsave(&tty->ctrl_lock, flags);
2090 type = PIDTYPE_PGID;
2092 pid = task_pid(current);
2095 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
2096 retval = __f_setown(filp, pid, type, 0);
2100 if (!tty->fasync && !waitqueue_active(&tty->read_wait))
2101 tty->minimum_to_wake = N_TTY_BUF_SIZE;
2110 * tiocsti - fake input character
2111 * @tty: tty to fake input into
2112 * @p: pointer to character
2114 * Fake input to a tty device. Does the necessary locking and
2117 * FIXME: does not honour flow control ??
2120 * Called functions take tty_ldisc_lock
2121 * current->signal->tty check is safe without locks
2123 * FIXME: may race normal receive processing
2126 static int tiocsti(struct tty_struct *tty, char __user *p)
2129 struct tty_ldisc *ld;
2131 if ((current->signal->tty != tty) && !capable(CAP_SYS_ADMIN))
2133 if (get_user(ch, p))
2135 ld = tty_ldisc_ref_wait(tty);
2136 ld->ops->receive_buf(tty, &ch, &mbz, 1);
2137 tty_ldisc_deref(ld);
2142 * tiocgwinsz - implement window query ioctl
2144 * @arg: user buffer for result
2146 * Copies the kernel idea of the window size into the user buffer.
2148 * Locking: tty->termios_mutex is taken to ensure the winsize data
2152 static int tiocgwinsz(struct tty_struct *tty, struct winsize __user *arg)
2156 mutex_lock(&tty->termios_mutex);
2157 err = copy_to_user(arg, &tty->winsize, sizeof(*arg));
2158 mutex_unlock(&tty->termios_mutex);
2160 return err ? -EFAULT: 0;
2164 * tty_do_resize - resize event
2165 * @tty: tty being resized
2166 * @real_tty: real tty (not the same as tty if using a pty/tty pair)
2167 * @rows: rows (character)
2168 * @cols: cols (character)
2170 * Update the termios variables and send the neccessary signals to
2171 * peform a terminal resize correctly
2174 int tty_do_resize(struct tty_struct *tty, struct tty_struct *real_tty,
2177 struct pid *pgrp, *rpgrp;
2178 unsigned long flags;
2180 /* For a PTY we need to lock the tty side */
2181 mutex_lock(&real_tty->termios_mutex);
2182 if (!memcmp(ws, &real_tty->winsize, sizeof(*ws)))
2184 /* Get the PID values and reference them so we can
2185 avoid holding the tty ctrl lock while sending signals */
2186 spin_lock_irqsave(&tty->ctrl_lock, flags);
2187 pgrp = get_pid(tty->pgrp);
2188 rpgrp = get_pid(real_tty->pgrp);
2189 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
2192 kill_pgrp(pgrp, SIGWINCH, 1);
2193 if (rpgrp != pgrp && rpgrp)
2194 kill_pgrp(rpgrp, SIGWINCH, 1);
2200 real_tty->winsize = *ws;
2202 mutex_unlock(&real_tty->termios_mutex);
2207 * tiocswinsz - implement window size set ioctl
2209 * @arg: user buffer for result
2211 * Copies the user idea of the window size to the kernel. Traditionally
2212 * this is just advisory information but for the Linux console it
2213 * actually has driver level meaning and triggers a VC resize.
2216 * Driver dependant. The default do_resize method takes the
2217 * tty termios mutex and ctrl_lock. The console takes its own lock
2218 * then calls into the default method.
2221 static int tiocswinsz(struct tty_struct *tty, struct tty_struct *real_tty,
2222 struct winsize __user *arg)
2224 struct winsize tmp_ws;
2225 if (copy_from_user(&tmp_ws, arg, sizeof(*arg)))
2228 if (tty->ops->resize)
2229 return tty->ops->resize(tty, real_tty, &tmp_ws);
2231 return tty_do_resize(tty, real_tty, &tmp_ws);
2235 * tioccons - allow admin to move logical console
2236 * @file: the file to become console
2238 * Allow the adminstrator to move the redirected console device
2240 * Locking: uses redirect_lock to guard the redirect information
2243 static int tioccons(struct file *file)
2245 if (!capable(CAP_SYS_ADMIN))
2247 if (file->f_op->write == redirected_tty_write) {
2249 spin_lock(&redirect_lock);
2252 spin_unlock(&redirect_lock);
2257 spin_lock(&redirect_lock);
2259 spin_unlock(&redirect_lock);
2264 spin_unlock(&redirect_lock);
2269 * fionbio - non blocking ioctl
2270 * @file: file to set blocking value
2271 * @p: user parameter
2273 * Historical tty interfaces had a blocking control ioctl before
2274 * the generic functionality existed. This piece of history is preserved
2275 * in the expected tty API of posix OS's.
2277 * Locking: none, the open fle handle ensures it won't go away.
2280 static int fionbio(struct file *file, int __user *p)
2284 if (get_user(nonblock, p))
2287 /* file->f_flags is still BKL protected in the fs layer - vomit */
2290 file->f_flags |= O_NONBLOCK;
2292 file->f_flags &= ~O_NONBLOCK;
2298 * tiocsctty - set controlling tty
2299 * @tty: tty structure
2300 * @arg: user argument
2302 * This ioctl is used to manage job control. It permits a session
2303 * leader to set this tty as the controlling tty for the session.
2306 * Takes tty_mutex() to protect tty instance
2307 * Takes tasklist_lock internally to walk sessions
2308 * Takes ->siglock() when updating signal->tty
2311 static int tiocsctty(struct tty_struct *tty, int arg)
2314 if (current->signal->leader && (task_session(current) == tty->session))
2317 mutex_lock(&tty_mutex);
2319 * The process must be a session leader and
2320 * not have a controlling tty already.
2322 if (!current->signal->leader || current->signal->tty) {
2329 * This tty is already the controlling
2330 * tty for another session group!
2332 if (arg == 1 && capable(CAP_SYS_ADMIN)) {
2336 read_lock(&tasklist_lock);
2337 session_clear_tty(tty->session);
2338 read_unlock(&tasklist_lock);
2344 proc_set_tty(current, tty);
2346 mutex_unlock(&tty_mutex);
2351 * tty_get_pgrp - return a ref counted pgrp pid
2354 * Returns a refcounted instance of the pid struct for the process
2355 * group controlling the tty.
2358 struct pid *tty_get_pgrp(struct tty_struct *tty)
2360 unsigned long flags;
2363 spin_lock_irqsave(&tty->ctrl_lock, flags);
2364 pgrp = get_pid(tty->pgrp);
2365 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
2369 EXPORT_SYMBOL_GPL(tty_get_pgrp);
2372 * tiocgpgrp - get process group
2373 * @tty: tty passed by user
2374 * @real_tty: tty side of the tty pased by the user if a pty else the tty
2377 * Obtain the process group of the tty. If there is no process group
2380 * Locking: none. Reference to current->signal->tty is safe.
2383 static int tiocgpgrp(struct tty_struct *tty, struct tty_struct *real_tty, pid_t __user *p)
2388 * (tty == real_tty) is a cheap way of
2389 * testing if the tty is NOT a master pty.
2391 if (tty == real_tty && current->signal->tty != real_tty)
2393 pid = tty_get_pgrp(real_tty);
2394 ret = put_user(pid_vnr(pid), p);
2400 * tiocspgrp - attempt to set process group
2401 * @tty: tty passed by user
2402 * @real_tty: tty side device matching tty passed by user
2405 * Set the process group of the tty to the session passed. Only
2406 * permitted where the tty session is our session.
2408 * Locking: RCU, ctrl lock
2411 static int tiocspgrp(struct tty_struct *tty, struct tty_struct *real_tty, pid_t __user *p)
2415 int retval = tty_check_change(real_tty);
2416 unsigned long flags;
2422 if (!current->signal->tty ||
2423 (current->signal->tty != real_tty) ||
2424 (real_tty->session != task_session(current)))
2426 if (get_user(pgrp_nr, p))
2431 pgrp = find_vpid(pgrp_nr);
2436 if (session_of_pgrp(pgrp) != task_session(current))
2439 spin_lock_irqsave(&tty->ctrl_lock, flags);
2440 put_pid(real_tty->pgrp);
2441 real_tty->pgrp = get_pid(pgrp);
2442 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
2449 * tiocgsid - get session id
2450 * @tty: tty passed by user
2451 * @real_tty: tty side of the tty pased by the user if a pty else the tty
2452 * @p: pointer to returned session id
2454 * Obtain the session id of the tty. If there is no session
2457 * Locking: none. Reference to current->signal->tty is safe.
2460 static int tiocgsid(struct tty_struct *tty, struct tty_struct *real_tty, pid_t __user *p)
2463 * (tty == real_tty) is a cheap way of
2464 * testing if the tty is NOT a master pty.
2466 if (tty == real_tty && current->signal->tty != real_tty)
2468 if (!real_tty->session)
2470 return put_user(pid_vnr(real_tty->session), p);
2474 * tiocsetd - set line discipline
2476 * @p: pointer to user data
2478 * Set the line discipline according to user request.
2480 * Locking: see tty_set_ldisc, this function is just a helper
2483 static int tiocsetd(struct tty_struct *tty, int __user *p)
2488 if (get_user(ldisc, p))
2492 ret = tty_set_ldisc(tty, ldisc);
2499 * send_break - performed time break
2500 * @tty: device to break on
2501 * @duration: timeout in mS
2503 * Perform a timed break on hardware that lacks its own driver level
2504 * timed break functionality.
2507 * atomic_write_lock serializes
2511 static int send_break(struct tty_struct *tty, unsigned int duration)
2515 if (tty->ops->break_ctl == NULL)
2518 if (tty->driver->flags & TTY_DRIVER_HARDWARE_BREAK)
2519 retval = tty->ops->break_ctl(tty, duration);
2521 /* Do the work ourselves */
2522 if (tty_write_lock(tty, 0) < 0)
2524 retval = tty->ops->break_ctl(tty, -1);
2527 if (!signal_pending(current))
2528 msleep_interruptible(duration);
2529 retval = tty->ops->break_ctl(tty, 0);
2531 tty_write_unlock(tty);
2532 if (signal_pending(current))
2539 * tty_tiocmget - get modem status
2541 * @file: user file pointer
2542 * @p: pointer to result
2544 * Obtain the modem status bits from the tty driver if the feature
2545 * is supported. Return -EINVAL if it is not available.
2547 * Locking: none (up to the driver)
2550 static int tty_tiocmget(struct tty_struct *tty, struct file *file, int __user *p)
2552 int retval = -EINVAL;
2554 if (tty->ops->tiocmget) {
2555 retval = tty->ops->tiocmget(tty, file);
2558 retval = put_user(retval, p);
2564 * tty_tiocmset - set modem status
2566 * @file: user file pointer
2567 * @cmd: command - clear bits, set bits or set all
2568 * @p: pointer to desired bits
2570 * Set the modem status bits from the tty driver if the feature
2571 * is supported. Return -EINVAL if it is not available.
2573 * Locking: none (up to the driver)
2576 static int tty_tiocmset(struct tty_struct *tty, struct file *file, unsigned int cmd,
2580 unsigned int set, clear, val;
2582 if (tty->ops->tiocmset == NULL)
2585 retval = get_user(val, p);
2601 set &= TIOCM_DTR|TIOCM_RTS|TIOCM_OUT1|TIOCM_OUT2|TIOCM_LOOP;
2602 clear &= TIOCM_DTR|TIOCM_RTS|TIOCM_OUT1|TIOCM_OUT2|TIOCM_LOOP;
2603 return tty->ops->tiocmset(tty, file, set, clear);
2607 * Split this up, as gcc can choke on it otherwise..
2609 long tty_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
2611 struct tty_struct *tty, *real_tty;
2612 void __user *p = (void __user *)arg;
2614 struct tty_ldisc *ld;
2615 struct inode *inode = file->f_dentry->d_inode;
2617 tty = (struct tty_struct *)file->private_data;
2618 if (tty_paranoia_check(tty, inode, "tty_ioctl"))
2622 if (tty->driver->type == TTY_DRIVER_TYPE_PTY &&
2623 tty->driver->subtype == PTY_TYPE_MASTER)
2624 real_tty = tty->link;
2628 * Factor out some common prep work
2636 retval = tty_check_change(tty);
2639 if (cmd != TIOCCBRK) {
2640 tty_wait_until_sent(tty, 0);
2641 if (signal_pending(current))
2652 return tiocsti(tty, p);
2654 return tiocgwinsz(real_tty, p);
2656 return tiocswinsz(tty, real_tty, p);
2658 return real_tty != tty ? -EINVAL : tioccons(file);
2660 return fionbio(file, p);
2662 set_bit(TTY_EXCLUSIVE, &tty->flags);
2665 clear_bit(TTY_EXCLUSIVE, &tty->flags);
2668 if (current->signal->tty != tty)
2673 return tiocsctty(tty, arg);
2675 return tiocgpgrp(tty, real_tty, p);
2677 return tiocspgrp(tty, real_tty, p);
2679 return tiocgsid(tty, real_tty, p);
2681 return put_user(tty->ldisc.ops->num, (int __user *)p);
2683 return tiocsetd(tty, p);
2687 case TIOCSBRK: /* Turn break on, unconditionally */
2688 if (tty->ops->break_ctl)
2689 return tty->ops->break_ctl(tty, -1);
2691 case TIOCCBRK: /* Turn break off, unconditionally */
2692 if (tty->ops->break_ctl)
2693 return tty->ops->break_ctl(tty, 0);
2695 case TCSBRK: /* SVID version: non-zero arg --> no break */
2696 /* non-zero arg means wait for all output data
2697 * to be sent (performed above) but don't send break.
2698 * This is used by the tcdrain() termios function.
2701 return send_break(tty, 250);
2703 case TCSBRKP: /* support for POSIX tcsendbreak() */
2704 return send_break(tty, arg ? arg*100 : 250);
2707 return tty_tiocmget(tty, file, p);
2711 return tty_tiocmset(tty, file, cmd, p);
2716 /* flush tty buffer and allow ldisc to process ioctl */
2717 tty_buffer_flush(tty);
2722 if (tty->ops->ioctl) {
2723 retval = (tty->ops->ioctl)(tty, file, cmd, arg);
2724 if (retval != -ENOIOCTLCMD)
2727 ld = tty_ldisc_ref_wait(tty);
2729 if (ld->ops->ioctl) {
2730 retval = ld->ops->ioctl(tty, file, cmd, arg);
2731 if (retval == -ENOIOCTLCMD)
2734 tty_ldisc_deref(ld);
2738 #ifdef CONFIG_COMPAT
2739 static long tty_compat_ioctl(struct file *file, unsigned int cmd,
2742 struct inode *inode = file->f_dentry->d_inode;
2743 struct tty_struct *tty = file->private_data;
2744 struct tty_ldisc *ld;
2745 int retval = -ENOIOCTLCMD;
2747 if (tty_paranoia_check(tty, inode, "tty_ioctl"))
2750 if (tty->ops->compat_ioctl) {
2751 retval = (tty->ops->compat_ioctl)(tty, file, cmd, arg);
2752 if (retval != -ENOIOCTLCMD)
2756 ld = tty_ldisc_ref_wait(tty);
2757 if (ld->ops->compat_ioctl)
2758 retval = ld->ops->compat_ioctl(tty, file, cmd, arg);
2759 tty_ldisc_deref(ld);
2766 * This implements the "Secure Attention Key" --- the idea is to
2767 * prevent trojan horses by killing all processes associated with this
2768 * tty when the user hits the "Secure Attention Key". Required for
2769 * super-paranoid applications --- see the Orange Book for more details.
2771 * This code could be nicer; ideally it should send a HUP, wait a few
2772 * seconds, then send a INT, and then a KILL signal. But you then
2773 * have to coordinate with the init process, since all processes associated
2774 * with the current tty must be dead before the new getty is allowed
2777 * Now, if it would be correct ;-/ The current code has a nasty hole -
2778 * it doesn't catch files in flight. We may send the descriptor to ourselves
2779 * via AF_UNIX socket, close it and later fetch from socket. FIXME.
2781 * Nasty bug: do_SAK is being called in interrupt context. This can
2782 * deadlock. We punt it up to process context. AKPM - 16Mar2001
2784 void __do_SAK(struct tty_struct *tty)
2789 struct task_struct *g, *p;
2790 struct pid *session;
2793 struct fdtable *fdt;
2797 session = tty->session;
2799 tty_ldisc_flush(tty);
2801 tty_driver_flush_buffer(tty);
2803 read_lock(&tasklist_lock);
2804 /* Kill the entire session */
2805 do_each_pid_task(session, PIDTYPE_SID, p) {
2806 printk(KERN_NOTICE "SAK: killed process %d"
2807 " (%s): task_session_nr(p)==tty->session\n",
2808 task_pid_nr(p), p->comm);
2809 send_sig(SIGKILL, p, 1);
2810 } while_each_pid_task(session, PIDTYPE_SID, p);
2811 /* Now kill any processes that happen to have the
2814 do_each_thread(g, p) {
2815 if (p->signal->tty == tty) {
2816 printk(KERN_NOTICE "SAK: killed process %d"
2817 " (%s): task_session_nr(p)==tty->session\n",
2818 task_pid_nr(p), p->comm);
2819 send_sig(SIGKILL, p, 1);
2825 * We don't take a ref to the file, so we must
2826 * hold ->file_lock instead.
2828 spin_lock(&p->files->file_lock);
2829 fdt = files_fdtable(p->files);
2830 for (i = 0; i < fdt->max_fds; i++) {
2831 filp = fcheck_files(p->files, i);
2834 if (filp->f_op->read == tty_read &&
2835 filp->private_data == tty) {
2836 printk(KERN_NOTICE "SAK: killed process %d"
2837 " (%s): fd#%d opened to the tty\n",
2838 task_pid_nr(p), p->comm, i);
2839 force_sig(SIGKILL, p);
2843 spin_unlock(&p->files->file_lock);
2846 } while_each_thread(g, p);
2847 read_unlock(&tasklist_lock);
2851 static void do_SAK_work(struct work_struct *work)
2853 struct tty_struct *tty =
2854 container_of(work, struct tty_struct, SAK_work);
2859 * The tq handling here is a little racy - tty->SAK_work may already be queued.
2860 * Fortunately we don't need to worry, because if ->SAK_work is already queued,
2861 * the values which we write to it will be identical to the values which it
2862 * already has. --akpm
2864 void do_SAK(struct tty_struct *tty)
2868 schedule_work(&tty->SAK_work);
2871 EXPORT_SYMBOL(do_SAK);
2874 * initialize_tty_struct
2875 * @tty: tty to initialize
2877 * This subroutine initializes a tty structure that has been newly
2880 * Locking: none - tty in question must not be exposed at this point
2883 static void initialize_tty_struct(struct tty_struct *tty)
2885 memset(tty, 0, sizeof(struct tty_struct));
2886 kref_init(&tty->kref);
2887 tty->magic = TTY_MAGIC;
2888 tty_ldisc_init(tty);
2889 tty->session = NULL;
2891 tty->overrun_time = jiffies;
2892 tty->buf.head = tty->buf.tail = NULL;
2893 tty_buffer_init(tty);
2894 mutex_init(&tty->termios_mutex);
2895 init_waitqueue_head(&tty->write_wait);
2896 init_waitqueue_head(&tty->read_wait);
2897 INIT_WORK(&tty->hangup_work, do_tty_hangup);
2898 mutex_init(&tty->atomic_read_lock);
2899 mutex_init(&tty->atomic_write_lock);
2900 spin_lock_init(&tty->read_lock);
2901 spin_lock_init(&tty->ctrl_lock);
2902 INIT_LIST_HEAD(&tty->tty_files);
2903 INIT_WORK(&tty->SAK_work, do_SAK_work);
2907 * tty_put_char - write one character to a tty
2911 * Write one byte to the tty using the provided put_char method
2912 * if present. Returns the number of characters successfully output.
2914 * Note: the specific put_char operation in the driver layer may go
2915 * away soon. Don't call it directly, use this method
2918 int tty_put_char(struct tty_struct *tty, unsigned char ch)
2920 if (tty->ops->put_char)
2921 return tty->ops->put_char(tty, ch);
2922 return tty->ops->write(tty, &ch, 1);
2925 EXPORT_SYMBOL_GPL(tty_put_char);
2927 static struct class *tty_class;
2930 * tty_register_device - register a tty device
2931 * @driver: the tty driver that describes the tty device
2932 * @index: the index in the tty driver for this tty device
2933 * @device: a struct device that is associated with this tty device.
2934 * This field is optional, if there is no known struct device
2935 * for this tty device it can be set to NULL safely.
2937 * Returns a pointer to the struct device for this tty device
2938 * (or ERR_PTR(-EFOO) on error).
2940 * This call is required to be made to register an individual tty device
2941 * if the tty driver's flags have the TTY_DRIVER_DYNAMIC_DEV bit set. If
2942 * that bit is not set, this function should not be called by a tty
2948 struct device *tty_register_device(struct tty_driver *driver, unsigned index,
2949 struct device *device)
2952 dev_t dev = MKDEV(driver->major, driver->minor_start) + index;
2954 if (index >= driver->num) {
2955 printk(KERN_ERR "Attempt to register invalid tty line number "
2957 return ERR_PTR(-EINVAL);
2960 if (driver->type == TTY_DRIVER_TYPE_PTY)
2961 pty_line_name(driver, index, name);
2963 tty_line_name(driver, index, name);
2965 return device_create_drvdata(tty_class, device, dev, NULL, name);
2969 * tty_unregister_device - unregister a tty device
2970 * @driver: the tty driver that describes the tty device
2971 * @index: the index in the tty driver for this tty device
2973 * If a tty device is registered with a call to tty_register_device() then
2974 * this function must be called when the tty device is gone.
2979 void tty_unregister_device(struct tty_driver *driver, unsigned index)
2981 device_destroy(tty_class,
2982 MKDEV(driver->major, driver->minor_start) + index);
2985 EXPORT_SYMBOL(tty_register_device);
2986 EXPORT_SYMBOL(tty_unregister_device);
2988 struct tty_driver *alloc_tty_driver(int lines)
2990 struct tty_driver *driver;
2992 driver = kzalloc(sizeof(struct tty_driver), GFP_KERNEL);
2994 driver->magic = TTY_DRIVER_MAGIC;
2995 driver->num = lines;
2996 /* later we'll move allocation of tables here */
3001 void put_tty_driver(struct tty_driver *driver)
3006 void tty_set_operations(struct tty_driver *driver,
3007 const struct tty_operations *op)
3012 EXPORT_SYMBOL(alloc_tty_driver);
3013 EXPORT_SYMBOL(put_tty_driver);
3014 EXPORT_SYMBOL(tty_set_operations);
3017 * Called by a tty driver to register itself.
3019 int tty_register_driver(struct tty_driver *driver)
3026 if (driver->flags & TTY_DRIVER_INSTALLED)
3029 if (!(driver->flags & TTY_DRIVER_DEVPTS_MEM) && driver->num) {
3030 p = kzalloc(driver->num * 3 * sizeof(void *), GFP_KERNEL);
3035 if (!driver->major) {
3036 error = alloc_chrdev_region(&dev, driver->minor_start,
3037 driver->num, driver->name);
3039 driver->major = MAJOR(dev);
3040 driver->minor_start = MINOR(dev);
3043 dev = MKDEV(driver->major, driver->minor_start);
3044 error = register_chrdev_region(dev, driver->num, driver->name);
3052 driver->ttys = (struct tty_struct **)p;
3053 driver->termios = (struct ktermios **)(p + driver->num);
3054 driver->termios_locked = (struct ktermios **)
3055 (p + driver->num * 2);
3057 driver->ttys = NULL;
3058 driver->termios = NULL;
3059 driver->termios_locked = NULL;
3062 cdev_init(&driver->cdev, &tty_fops);
3063 driver->cdev.owner = driver->owner;
3064 error = cdev_add(&driver->cdev, dev, driver->num);
3066 unregister_chrdev_region(dev, driver->num);
3067 driver->ttys = NULL;
3068 driver->termios = driver->termios_locked = NULL;
3073 mutex_lock(&tty_mutex);
3074 list_add(&driver->tty_drivers, &tty_drivers);
3075 mutex_unlock(&tty_mutex);
3077 if (!(driver->flags & TTY_DRIVER_DYNAMIC_DEV)) {
3078 for (i = 0; i < driver->num; i++)
3079 tty_register_device(driver, i, NULL);
3081 proc_tty_register_driver(driver);
3085 EXPORT_SYMBOL(tty_register_driver);
3088 * Called by a tty driver to unregister itself.
3090 int tty_unregister_driver(struct tty_driver *driver)
3093 struct ktermios *tp;
3096 if (driver->refcount)
3099 unregister_chrdev_region(MKDEV(driver->major, driver->minor_start),
3101 mutex_lock(&tty_mutex);
3102 list_del(&driver->tty_drivers);
3103 mutex_unlock(&tty_mutex);
3106 * Free the termios and termios_locked structures because
3107 * we don't want to get memory leaks when modular tty
3108 * drivers are removed from the kernel.
3110 for (i = 0; i < driver->num; i++) {
3111 tp = driver->termios[i];
3113 driver->termios[i] = NULL;
3116 tp = driver->termios_locked[i];
3118 driver->termios_locked[i] = NULL;
3121 if (!(driver->flags & TTY_DRIVER_DYNAMIC_DEV))
3122 tty_unregister_device(driver, i);
3125 proc_tty_unregister_driver(driver);
3126 driver->ttys = NULL;
3127 driver->termios = driver->termios_locked = NULL;
3129 cdev_del(&driver->cdev);
3132 EXPORT_SYMBOL(tty_unregister_driver);
3134 dev_t tty_devnum(struct tty_struct *tty)
3136 return MKDEV(tty->driver->major, tty->driver->minor_start) + tty->index;
3138 EXPORT_SYMBOL(tty_devnum);
3140 void proc_clear_tty(struct task_struct *p)
3142 struct tty_struct *tty;
3143 spin_lock_irq(&p->sighand->siglock);
3144 tty = p->signal->tty;
3145 p->signal->tty = NULL;
3146 spin_unlock_irq(&p->sighand->siglock);
3150 /* Called under the sighand lock */
3152 static void __proc_set_tty(struct task_struct *tsk, struct tty_struct *tty)
3155 unsigned long flags;
3156 /* We should not have a session or pgrp to put here but.... */
3157 spin_lock_irqsave(&tty->ctrl_lock, flags);
3158 put_pid(tty->session);
3160 tty->pgrp = get_pid(task_pgrp(tsk));
3161 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
3162 tty->session = get_pid(task_session(tsk));
3163 if (tsk->signal->tty) {
3164 printk(KERN_DEBUG "tty not NULL!!\n");
3165 tty_kref_put(tsk->signal->tty);
3168 put_pid(tsk->signal->tty_old_pgrp);
3169 tsk->signal->tty = tty_kref_get(tty);
3170 tsk->signal->tty_old_pgrp = NULL;
3173 static void proc_set_tty(struct task_struct *tsk, struct tty_struct *tty)
3175 spin_lock_irq(&tsk->sighand->siglock);
3176 __proc_set_tty(tsk, tty);
3177 spin_unlock_irq(&tsk->sighand->siglock);
3180 struct tty_struct *get_current_tty(void)
3182 struct tty_struct *tty;
3183 WARN_ON_ONCE(!mutex_is_locked(&tty_mutex));
3184 tty = tty_kref_get(current->signal->tty);
3186 * session->tty can be changed/cleared from under us, make sure we
3187 * issue the load. The obtained pointer, when not NULL, is valid as
3188 * long as we hold tty_mutex.
3193 EXPORT_SYMBOL_GPL(get_current_tty);
3196 * Initialize the console device. This is called *early*, so
3197 * we can't necessarily depend on lots of kernel help here.
3198 * Just do some early initializations, and do the complex setup
3201 void __init console_init(void)
3205 /* Setup the default TTY line discipline. */
3209 * set up the console device so that later boot sequences can
3210 * inform about problems etc..
3212 call = __con_initcall_start;
3213 while (call < __con_initcall_end) {
3219 static int __init tty_class_init(void)
3221 tty_class = class_create(THIS_MODULE, "tty");
3222 if (IS_ERR(tty_class))
3223 return PTR_ERR(tty_class);
3227 postcore_initcall(tty_class_init);
3229 /* 3/2004 jmc: why do these devices exist? */
3231 static struct cdev tty_cdev, console_cdev;
3232 #ifdef CONFIG_UNIX98_PTYS
3233 static struct cdev ptmx_cdev;
3236 static struct cdev vc0_cdev;
3240 * Ok, now we can initialize the rest of the tty devices and can count
3241 * on memory allocations, interrupts etc..
3243 static int __init tty_init(void)
3245 cdev_init(&tty_cdev, &tty_fops);
3246 if (cdev_add(&tty_cdev, MKDEV(TTYAUX_MAJOR, 0), 1) ||
3247 register_chrdev_region(MKDEV(TTYAUX_MAJOR, 0), 1, "/dev/tty") < 0)
3248 panic("Couldn't register /dev/tty driver\n");
3249 device_create_drvdata(tty_class, NULL, MKDEV(TTYAUX_MAJOR, 0), NULL,
3252 cdev_init(&console_cdev, &console_fops);
3253 if (cdev_add(&console_cdev, MKDEV(TTYAUX_MAJOR, 1), 1) ||
3254 register_chrdev_region(MKDEV(TTYAUX_MAJOR, 1), 1, "/dev/console") < 0)
3255 panic("Couldn't register /dev/console driver\n");
3256 device_create_drvdata(tty_class, NULL, MKDEV(TTYAUX_MAJOR, 1), NULL,
3259 #ifdef CONFIG_UNIX98_PTYS
3260 cdev_init(&ptmx_cdev, &ptmx_fops);
3261 if (cdev_add(&ptmx_cdev, MKDEV(TTYAUX_MAJOR, 2), 1) ||
3262 register_chrdev_region(MKDEV(TTYAUX_MAJOR, 2), 1, "/dev/ptmx") < 0)
3263 panic("Couldn't register /dev/ptmx driver\n");
3264 device_create_drvdata(tty_class, NULL, MKDEV(TTYAUX_MAJOR, 2), NULL, "ptmx");
3268 cdev_init(&vc0_cdev, &console_fops);
3269 if (cdev_add(&vc0_cdev, MKDEV(TTY_MAJOR, 0), 1) ||
3270 register_chrdev_region(MKDEV(TTY_MAJOR, 0), 1, "/dev/vc/0") < 0)
3271 panic("Couldn't register /dev/tty0 driver\n");
3272 device_create_drvdata(tty_class, NULL, MKDEV(TTY_MAJOR, 0), NULL, "tty0");
3278 module_init(tty_init);