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>
100 #include <asm/system.h>
102 #include <linux/kbd_kern.h>
103 #include <linux/vt_kern.h>
104 #include <linux/selection.h>
106 #include <linux/kmod.h>
107 #include <linux/nsproxy.h>
109 #undef TTY_DEBUG_HANGUP
111 #define TTY_PARANOIA_CHECK 1
112 #define CHECK_TTY_COUNT 1
114 struct ktermios tty_std_termios = { /* for the benefit of tty drivers */
115 .c_iflag = ICRNL | IXON,
116 .c_oflag = OPOST | ONLCR,
117 .c_cflag = B38400 | CS8 | CREAD | HUPCL,
118 .c_lflag = ISIG | ICANON | ECHO | ECHOE | ECHOK |
119 ECHOCTL | ECHOKE | IEXTEN,
125 EXPORT_SYMBOL(tty_std_termios);
127 /* This list gets poked at by procfs and various bits of boot up code. This
128 could do with some rationalisation such as pulling the tty proc function
131 LIST_HEAD(tty_drivers); /* linked list of tty drivers */
133 /* Mutex to protect creating and releasing a tty. This is shared with
134 vt.c for deeply disgusting hack reasons */
135 DEFINE_MUTEX(tty_mutex);
136 EXPORT_SYMBOL(tty_mutex);
138 /* Spinlock to protect the tty->tty_files list */
139 DEFINE_SPINLOCK(tty_files_lock);
141 static ssize_t tty_read(struct file *, char __user *, size_t, loff_t *);
142 static ssize_t tty_write(struct file *, const char __user *, size_t, loff_t *);
143 ssize_t redirected_tty_write(struct file *, const char __user *,
145 static unsigned int tty_poll(struct file *, poll_table *);
146 static int tty_open(struct inode *, struct file *);
147 long tty_ioctl(struct file *file, unsigned int cmd, unsigned long arg);
149 static long tty_compat_ioctl(struct file *file, unsigned int cmd,
152 #define tty_compat_ioctl NULL
154 static int __tty_fasync(int fd, struct file *filp, int on);
155 static int tty_fasync(int fd, struct file *filp, int on);
156 static void release_tty(struct tty_struct *tty, int idx);
157 static void __proc_set_tty(struct task_struct *tsk, struct tty_struct *tty);
158 static void proc_set_tty(struct task_struct *tsk, struct tty_struct *tty);
161 * alloc_tty_struct - allocate a tty object
163 * Return a new empty tty structure. The data fields have not
164 * been initialized in any way but has been zeroed
169 struct tty_struct *alloc_tty_struct(void)
171 return kzalloc(sizeof(struct tty_struct), GFP_KERNEL);
175 * free_tty_struct - free a disused tty
176 * @tty: tty struct to free
178 * Free the write buffers, tty queue and tty memory itself.
180 * Locking: none. Must be called after tty is definitely unused
183 void free_tty_struct(struct tty_struct *tty)
186 put_device(tty->dev);
187 kfree(tty->write_buf);
188 tty_buffer_free_all(tty);
192 static inline struct tty_struct *file_tty(struct file *file)
194 return ((struct tty_file_private *)file->private_data)->tty;
197 int tty_alloc_file(struct file *file)
199 struct tty_file_private *priv;
201 priv = kmalloc(sizeof(*priv), GFP_KERNEL);
205 file->private_data = priv;
210 /* Associate a new file with the tty structure */
211 void tty_add_file(struct tty_struct *tty, struct file *file)
213 struct tty_file_private *priv = file->private_data;
218 spin_lock(&tty_files_lock);
219 list_add(&priv->list, &tty->tty_files);
220 spin_unlock(&tty_files_lock);
224 * tty_free_file - free file->private_data
226 * This shall be used only for fail path handling when tty_add_file was not
229 void tty_free_file(struct file *file)
231 struct tty_file_private *priv = file->private_data;
233 file->private_data = NULL;
237 /* Delete file from its tty */
238 void tty_del_file(struct file *file)
240 struct tty_file_private *priv = file->private_data;
242 spin_lock(&tty_files_lock);
243 list_del(&priv->list);
244 spin_unlock(&tty_files_lock);
249 #define TTY_NUMBER(tty) ((tty)->index + (tty)->driver->name_base)
252 * tty_name - return tty naming
253 * @tty: tty structure
254 * @buf: buffer for output
256 * Convert a tty structure into a name. The name reflects the kernel
257 * naming policy and if udev is in use may not reflect user space
262 char *tty_name(struct tty_struct *tty, char *buf)
264 if (!tty) /* Hmm. NULL pointer. That's fun. */
265 strcpy(buf, "NULL tty");
267 strcpy(buf, tty->name);
271 EXPORT_SYMBOL(tty_name);
273 int tty_paranoia_check(struct tty_struct *tty, struct inode *inode,
276 #ifdef TTY_PARANOIA_CHECK
279 "null TTY for (%d:%d) in %s\n",
280 imajor(inode), iminor(inode), routine);
283 if (tty->magic != TTY_MAGIC) {
285 "bad magic number for tty struct (%d:%d) in %s\n",
286 imajor(inode), iminor(inode), routine);
293 static int check_tty_count(struct tty_struct *tty, const char *routine)
295 #ifdef CHECK_TTY_COUNT
299 spin_lock(&tty_files_lock);
300 list_for_each(p, &tty->tty_files) {
303 spin_unlock(&tty_files_lock);
304 if (tty->driver->type == TTY_DRIVER_TYPE_PTY &&
305 tty->driver->subtype == PTY_TYPE_SLAVE &&
306 tty->link && tty->link->count)
308 if (tty->count != count) {
309 printk(KERN_WARNING "Warning: dev (%s) tty->count(%d) "
310 "!= #fd's(%d) in %s\n",
311 tty->name, tty->count, count, routine);
319 * get_tty_driver - find device of a tty
320 * @dev_t: device identifier
321 * @index: returns the index of the tty
323 * This routine returns a tty driver structure, given a device number
324 * and also passes back the index number.
326 * Locking: caller must hold tty_mutex
329 static struct tty_driver *get_tty_driver(dev_t device, int *index)
331 struct tty_driver *p;
333 list_for_each_entry(p, &tty_drivers, tty_drivers) {
334 dev_t base = MKDEV(p->major, p->minor_start);
335 if (device < base || device >= base + p->num)
337 *index = device - base;
338 return tty_driver_kref_get(p);
343 #ifdef CONFIG_CONSOLE_POLL
346 * tty_find_polling_driver - find device of a polled tty
347 * @name: name string to match
348 * @line: pointer to resulting tty line nr
350 * This routine returns a tty driver structure, given a name
351 * and the condition that the tty driver is capable of polled
354 struct tty_driver *tty_find_polling_driver(char *name, int *line)
356 struct tty_driver *p, *res = NULL;
361 for (str = name; *str; str++)
362 if ((*str >= '0' && *str <= '9') || *str == ',')
368 tty_line = simple_strtoul(str, &str, 10);
370 mutex_lock(&tty_mutex);
371 /* Search through the tty devices to look for a match */
372 list_for_each_entry(p, &tty_drivers, tty_drivers) {
373 if (strncmp(name, p->name, len) != 0)
381 if (tty_line >= 0 && tty_line < p->num && p->ops &&
382 p->ops->poll_init && !p->ops->poll_init(p, tty_line, stp)) {
383 res = tty_driver_kref_get(p);
388 mutex_unlock(&tty_mutex);
392 EXPORT_SYMBOL_GPL(tty_find_polling_driver);
396 * tty_check_change - check for POSIX terminal changes
399 * If we try to write to, or set the state of, a terminal and we're
400 * not in the foreground, send a SIGTTOU. If the signal is blocked or
401 * ignored, go ahead and perform the operation. (POSIX 7.2)
406 int tty_check_change(struct tty_struct *tty)
411 if (current->signal->tty != tty)
414 spin_lock_irqsave(&tty->ctrl_lock, flags);
417 printk(KERN_WARNING "tty_check_change: tty->pgrp == NULL!\n");
420 if (task_pgrp(current) == tty->pgrp)
422 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
423 if (is_ignored(SIGTTOU))
425 if (is_current_pgrp_orphaned()) {
429 kill_pgrp(task_pgrp(current), SIGTTOU, 1);
430 set_thread_flag(TIF_SIGPENDING);
435 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
439 EXPORT_SYMBOL(tty_check_change);
441 static ssize_t hung_up_tty_read(struct file *file, char __user *buf,
442 size_t count, loff_t *ppos)
447 static ssize_t hung_up_tty_write(struct file *file, const char __user *buf,
448 size_t count, loff_t *ppos)
453 /* No kernel lock held - none needed ;) */
454 static unsigned int hung_up_tty_poll(struct file *filp, poll_table *wait)
456 return POLLIN | POLLOUT | POLLERR | POLLHUP | POLLRDNORM | POLLWRNORM;
459 static long hung_up_tty_ioctl(struct file *file, unsigned int cmd,
462 return cmd == TIOCSPGRP ? -ENOTTY : -EIO;
465 static long hung_up_tty_compat_ioctl(struct file *file,
466 unsigned int cmd, unsigned long arg)
468 return cmd == TIOCSPGRP ? -ENOTTY : -EIO;
471 static const struct file_operations tty_fops = {
476 .unlocked_ioctl = tty_ioctl,
477 .compat_ioctl = tty_compat_ioctl,
479 .release = tty_release,
480 .fasync = tty_fasync,
483 static const struct file_operations console_fops = {
486 .write = redirected_tty_write,
488 .unlocked_ioctl = tty_ioctl,
489 .compat_ioctl = tty_compat_ioctl,
491 .release = tty_release,
492 .fasync = tty_fasync,
495 static const struct file_operations hung_up_tty_fops = {
497 .read = hung_up_tty_read,
498 .write = hung_up_tty_write,
499 .poll = hung_up_tty_poll,
500 .unlocked_ioctl = hung_up_tty_ioctl,
501 .compat_ioctl = hung_up_tty_compat_ioctl,
502 .release = tty_release,
505 static DEFINE_SPINLOCK(redirect_lock);
506 static struct file *redirect;
509 * tty_wakeup - request more data
512 * Internal and external helper for wakeups of tty. This function
513 * informs the line discipline if present that the driver is ready
514 * to receive more output data.
517 void tty_wakeup(struct tty_struct *tty)
519 struct tty_ldisc *ld;
521 if (test_bit(TTY_DO_WRITE_WAKEUP, &tty->flags)) {
522 ld = tty_ldisc_ref(tty);
524 if (ld->ops->write_wakeup)
525 ld->ops->write_wakeup(tty);
529 wake_up_interruptible_poll(&tty->write_wait, POLLOUT);
532 EXPORT_SYMBOL_GPL(tty_wakeup);
535 * __tty_hangup - actual handler for hangup events
538 * This can be called by the "eventd" kernel thread. That is process
539 * synchronous but doesn't hold any locks, so we need to make sure we
540 * have the appropriate locks for what we're doing.
542 * The hangup event clears any pending redirections onto the hung up
543 * device. It ensures future writes will error and it does the needed
544 * line discipline hangup and signal delivery. The tty object itself
549 * redirect lock for undoing redirection
550 * file list lock for manipulating list of ttys
551 * tty_ldisc_lock from called functions
552 * termios_mutex resetting termios data
553 * tasklist_lock to walk task list for hangup event
554 * ->siglock to protect ->signal/->sighand
556 void __tty_hangup(struct tty_struct *tty)
558 struct file *cons_filp = NULL;
559 struct file *filp, *f = NULL;
560 struct task_struct *p;
561 struct tty_file_private *priv;
562 int closecount = 0, n;
570 spin_lock(&redirect_lock);
571 if (redirect && file_tty(redirect) == tty) {
575 spin_unlock(&redirect_lock);
579 /* some functions below drop BTM, so we need this bit */
580 set_bit(TTY_HUPPING, &tty->flags);
582 /* inuse_filps is protected by the single tty lock,
583 this really needs to change if we want to flush the
584 workqueue with the lock held */
585 check_tty_count(tty, "tty_hangup");
587 spin_lock(&tty_files_lock);
588 /* This breaks for file handles being sent over AF_UNIX sockets ? */
589 list_for_each_entry(priv, &tty->tty_files, list) {
591 if (filp->f_op->write == redirected_tty_write)
593 if (filp->f_op->write != tty_write)
596 __tty_fasync(-1, filp, 0); /* can't block */
597 filp->f_op = &hung_up_tty_fops;
599 spin_unlock(&tty_files_lock);
602 * it drops BTM and thus races with reopen
603 * we protect the race by TTY_HUPPING
605 tty_ldisc_hangup(tty);
607 read_lock(&tasklist_lock);
609 do_each_pid_task(tty->session, PIDTYPE_SID, p) {
610 spin_lock_irq(&p->sighand->siglock);
611 if (p->signal->tty == tty) {
612 p->signal->tty = NULL;
613 /* We defer the dereferences outside fo
617 if (!p->signal->leader) {
618 spin_unlock_irq(&p->sighand->siglock);
621 __group_send_sig_info(SIGHUP, SEND_SIG_PRIV, p);
622 __group_send_sig_info(SIGCONT, SEND_SIG_PRIV, p);
623 put_pid(p->signal->tty_old_pgrp); /* A noop */
624 spin_lock_irqsave(&tty->ctrl_lock, flags);
626 p->signal->tty_old_pgrp = get_pid(tty->pgrp);
627 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
628 spin_unlock_irq(&p->sighand->siglock);
629 } while_each_pid_task(tty->session, PIDTYPE_SID, p);
631 read_unlock(&tasklist_lock);
633 spin_lock_irqsave(&tty->ctrl_lock, flags);
634 clear_bit(TTY_THROTTLED, &tty->flags);
635 clear_bit(TTY_PUSH, &tty->flags);
636 clear_bit(TTY_DO_WRITE_WAKEUP, &tty->flags);
637 put_pid(tty->session);
641 tty->ctrl_status = 0;
642 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
644 /* Account for the p->signal references we killed */
649 * If one of the devices matches a console pointer, we
650 * cannot just call hangup() because that will cause
651 * tty->count and state->count to go out of sync.
652 * So we just call close() the right number of times.
656 for (n = 0; n < closecount; n++)
657 tty->ops->close(tty, cons_filp);
658 } else if (tty->ops->hangup)
659 (tty->ops->hangup)(tty);
661 * We don't want to have driver/ldisc interactions beyond
662 * the ones we did here. The driver layer expects no
663 * calls after ->hangup() from the ldisc side. However we
664 * can't yet guarantee all that.
666 set_bit(TTY_HUPPED, &tty->flags);
667 clear_bit(TTY_HUPPING, &tty->flags);
668 tty_ldisc_enable(tty);
676 static void do_tty_hangup(struct work_struct *work)
678 struct tty_struct *tty =
679 container_of(work, struct tty_struct, hangup_work);
685 * tty_hangup - trigger a hangup event
686 * @tty: tty to hangup
688 * A carrier loss (virtual or otherwise) has occurred on this like
689 * schedule a hangup sequence to run after this event.
692 void tty_hangup(struct tty_struct *tty)
694 #ifdef TTY_DEBUG_HANGUP
696 printk(KERN_DEBUG "%s hangup...\n", tty_name(tty, buf));
698 schedule_work(&tty->hangup_work);
701 EXPORT_SYMBOL(tty_hangup);
704 * tty_vhangup - process vhangup
705 * @tty: tty to hangup
707 * The user has asked via system call for the terminal to be hung up.
708 * We do this synchronously so that when the syscall returns the process
709 * is complete. That guarantee is necessary for security reasons.
712 void tty_vhangup(struct tty_struct *tty)
714 #ifdef TTY_DEBUG_HANGUP
717 printk(KERN_DEBUG "%s vhangup...\n", tty_name(tty, buf));
722 EXPORT_SYMBOL(tty_vhangup);
726 * tty_vhangup_self - process vhangup for own ctty
728 * Perform a vhangup on the current controlling tty
731 void tty_vhangup_self(void)
733 struct tty_struct *tty;
735 tty = get_current_tty();
743 * tty_hung_up_p - was tty hung up
744 * @filp: file pointer of tty
746 * Return true if the tty has been subject to a vhangup or a carrier
750 int tty_hung_up_p(struct file *filp)
752 return (filp->f_op == &hung_up_tty_fops);
755 EXPORT_SYMBOL(tty_hung_up_p);
757 static void session_clear_tty(struct pid *session)
759 struct task_struct *p;
760 do_each_pid_task(session, PIDTYPE_SID, p) {
762 } while_each_pid_task(session, PIDTYPE_SID, p);
766 * disassociate_ctty - disconnect controlling tty
767 * @on_exit: true if exiting so need to "hang up" the session
769 * This function is typically called only by the session leader, when
770 * it wants to disassociate itself from its controlling tty.
772 * It performs the following functions:
773 * (1) Sends a SIGHUP and SIGCONT to the foreground process group
774 * (2) Clears the tty from being controlling the session
775 * (3) Clears the controlling tty for all processes in the
778 * The argument on_exit is set to 1 if called when a process is
779 * exiting; it is 0 if called by the ioctl TIOCNOTTY.
782 * BTM is taken for hysterical raisins, and held when
783 * called from no_tty().
784 * tty_mutex is taken to protect tty
785 * ->siglock is taken to protect ->signal/->sighand
786 * tasklist_lock is taken to walk process list for sessions
787 * ->siglock is taken to protect ->signal/->sighand
790 void disassociate_ctty(int on_exit)
792 struct tty_struct *tty;
793 struct pid *tty_pgrp = NULL;
795 if (!current->signal->leader)
798 tty = get_current_tty();
800 tty_pgrp = get_pid(tty->pgrp);
802 if (tty->driver->type != TTY_DRIVER_TYPE_PTY)
806 } else if (on_exit) {
807 struct pid *old_pgrp;
808 spin_lock_irq(¤t->sighand->siglock);
809 old_pgrp = current->signal->tty_old_pgrp;
810 current->signal->tty_old_pgrp = NULL;
811 spin_unlock_irq(¤t->sighand->siglock);
813 kill_pgrp(old_pgrp, SIGHUP, on_exit);
814 kill_pgrp(old_pgrp, SIGCONT, on_exit);
820 kill_pgrp(tty_pgrp, SIGHUP, on_exit);
822 kill_pgrp(tty_pgrp, SIGCONT, on_exit);
826 spin_lock_irq(¤t->sighand->siglock);
827 put_pid(current->signal->tty_old_pgrp);
828 current->signal->tty_old_pgrp = NULL;
829 spin_unlock_irq(¤t->sighand->siglock);
831 tty = get_current_tty();
834 spin_lock_irqsave(&tty->ctrl_lock, flags);
835 put_pid(tty->session);
839 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
842 #ifdef TTY_DEBUG_HANGUP
843 printk(KERN_DEBUG "error attempted to write to tty [0x%p]"
848 /* Now clear signal->tty under the lock */
849 read_lock(&tasklist_lock);
850 session_clear_tty(task_session(current));
851 read_unlock(&tasklist_lock);
856 * no_tty - Ensure the current process does not have a controlling tty
860 struct task_struct *tsk = current;
862 disassociate_ctty(0);
869 * stop_tty - propagate flow control
872 * Perform flow control to the driver. For PTY/TTY pairs we
873 * must also propagate the TIOCKPKT status. May be called
874 * on an already stopped device and will not re-call the driver
877 * This functionality is used by both the line disciplines for
878 * halting incoming flow and by the driver. It may therefore be
879 * called from any context, may be under the tty atomic_write_lock
883 * Uses the tty control lock internally
886 void stop_tty(struct tty_struct *tty)
889 spin_lock_irqsave(&tty->ctrl_lock, flags);
891 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
895 if (tty->link && tty->link->packet) {
896 tty->ctrl_status &= ~TIOCPKT_START;
897 tty->ctrl_status |= TIOCPKT_STOP;
898 wake_up_interruptible_poll(&tty->link->read_wait, POLLIN);
900 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
902 (tty->ops->stop)(tty);
905 EXPORT_SYMBOL(stop_tty);
908 * start_tty - propagate flow control
911 * Start a tty that has been stopped if at all possible. Perform
912 * any necessary wakeups and propagate the TIOCPKT status. If this
913 * is the tty was previous stopped and is being started then the
914 * driver start method is invoked and the line discipline woken.
920 void start_tty(struct tty_struct *tty)
923 spin_lock_irqsave(&tty->ctrl_lock, flags);
924 if (!tty->stopped || tty->flow_stopped) {
925 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
929 if (tty->link && tty->link->packet) {
930 tty->ctrl_status &= ~TIOCPKT_STOP;
931 tty->ctrl_status |= TIOCPKT_START;
932 wake_up_interruptible_poll(&tty->link->read_wait, POLLIN);
934 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
936 (tty->ops->start)(tty);
937 /* If we have a running line discipline it may need kicking */
941 EXPORT_SYMBOL(start_tty);
944 * tty_read - read method for tty device files
945 * @file: pointer to tty file
947 * @count: size of user buffer
950 * Perform the read system call function on this terminal device. Checks
951 * for hung up devices before calling the line discipline method.
954 * Locks the line discipline internally while needed. Multiple
955 * read calls may be outstanding in parallel.
958 static ssize_t tty_read(struct file *file, char __user *buf, size_t count,
962 struct inode *inode = file->f_path.dentry->d_inode;
963 struct tty_struct *tty = file_tty(file);
964 struct tty_ldisc *ld;
966 if (tty_paranoia_check(tty, inode, "tty_read"))
968 if (!tty || (test_bit(TTY_IO_ERROR, &tty->flags)))
971 /* We want to wait for the line discipline to sort out in this
973 ld = tty_ldisc_ref_wait(tty);
975 i = (ld->ops->read)(tty, file, buf, count);
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))
1083 tty_write_unlock(tty);
1088 * tty_write_message - write a message to a certain tty, not just the console.
1089 * @tty: the destination tty_struct
1090 * @msg: the message to write
1092 * This is used for messages that need to be redirected to a specific tty.
1093 * We don't put it into the syslog queue right now maybe in the future if
1096 * We must still hold the BTM and test the CLOSING flag for the moment.
1099 void tty_write_message(struct tty_struct *tty, char *msg)
1102 mutex_lock(&tty->atomic_write_lock);
1104 if (tty->ops->write && !test_bit(TTY_CLOSING, &tty->flags)) {
1106 tty->ops->write(tty, msg, strlen(msg));
1109 tty_write_unlock(tty);
1116 * tty_write - write method for tty device file
1117 * @file: tty file pointer
1118 * @buf: user data to write
1119 * @count: bytes to write
1122 * Write data to a tty device via the line discipline.
1125 * Locks the line discipline as required
1126 * Writes to the tty driver are serialized by the atomic_write_lock
1127 * and are then processed in chunks to the device. The line discipline
1128 * write method will not be invoked in parallel for each device.
1131 static ssize_t tty_write(struct file *file, const char __user *buf,
1132 size_t count, loff_t *ppos)
1134 struct inode *inode = file->f_path.dentry->d_inode;
1135 struct tty_struct *tty = file_tty(file);
1136 struct tty_ldisc *ld;
1139 if (tty_paranoia_check(tty, inode, "tty_write"))
1141 if (!tty || !tty->ops->write ||
1142 (test_bit(TTY_IO_ERROR, &tty->flags)))
1144 /* Short term debug to catch buggy drivers */
1145 if (tty->ops->write_room == NULL)
1146 printk(KERN_ERR "tty driver %s lacks a write_room method.\n",
1148 ld = tty_ldisc_ref_wait(tty);
1149 if (!ld->ops->write)
1152 ret = do_tty_write(ld->ops->write, tty, file, buf, count);
1153 tty_ldisc_deref(ld);
1157 ssize_t redirected_tty_write(struct file *file, const char __user *buf,
1158 size_t count, loff_t *ppos)
1160 struct file *p = NULL;
1162 spin_lock(&redirect_lock);
1167 spin_unlock(&redirect_lock);
1171 res = vfs_write(p, buf, count, &p->f_pos);
1175 return tty_write(file, buf, count, ppos);
1178 static char ptychar[] = "pqrstuvwxyzabcde";
1181 * pty_line_name - generate name for a pty
1182 * @driver: the tty driver in use
1183 * @index: the minor number
1184 * @p: output buffer of at least 6 bytes
1186 * Generate a name from a driver reference and write it to the output
1191 static void pty_line_name(struct tty_driver *driver, int index, char *p)
1193 int i = index + driver->name_base;
1194 /* ->name is initialized to "ttyp", but "tty" is expected */
1195 sprintf(p, "%s%c%x",
1196 driver->subtype == PTY_TYPE_SLAVE ? "tty" : driver->name,
1197 ptychar[i >> 4 & 0xf], i & 0xf);
1201 * tty_line_name - generate name for a tty
1202 * @driver: the tty driver in use
1203 * @index: the minor number
1204 * @p: output buffer of at least 7 bytes
1206 * Generate a name from a driver reference and write it to the output
1211 static void tty_line_name(struct tty_driver *driver, int index, char *p)
1213 sprintf(p, "%s%d", driver->name, index + driver->name_base);
1217 * tty_driver_lookup_tty() - find an existing tty, if any
1218 * @driver: the driver for the tty
1219 * @idx: the minor number
1221 * Return the tty, if found or ERR_PTR() otherwise.
1223 * Locking: tty_mutex must be held. If tty is found, the mutex must
1224 * be held until the 'fast-open' is also done. Will change once we
1225 * have refcounting in the driver and per driver locking
1227 static struct tty_struct *tty_driver_lookup_tty(struct tty_driver *driver,
1228 struct inode *inode, int idx)
1230 struct tty_struct *tty;
1232 if (driver->ops->lookup)
1233 return driver->ops->lookup(driver, inode, idx);
1235 tty = 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 tp = tty->driver->termios[idx];
1254 tp = kzalloc(sizeof(struct ktermios[2]), GFP_KERNEL);
1257 memcpy(tp, &tty->driver->init_termios,
1258 sizeof(struct ktermios));
1259 tty->driver->termios[idx] = tp;
1262 tty->termios_locked = tp + 1;
1264 /* Compatibility until drivers always set this */
1265 tty->termios->c_ispeed = tty_termios_input_baud_rate(tty->termios);
1266 tty->termios->c_ospeed = tty_termios_baud_rate(tty->termios);
1269 EXPORT_SYMBOL_GPL(tty_init_termios);
1272 * tty_driver_install_tty() - install a tty entry in the driver
1273 * @driver: the driver for the tty
1276 * Install a tty object into the driver tables. The tty->index field
1277 * will be set by the time this is called. This method is responsible
1278 * for ensuring any need additional structures are allocated and
1281 * Locking: tty_mutex for now
1283 static int tty_driver_install_tty(struct tty_driver *driver,
1284 struct tty_struct *tty)
1286 int idx = tty->index;
1289 if (driver->ops->install) {
1290 ret = driver->ops->install(driver, tty);
1294 if (tty_init_termios(tty) == 0) {
1295 tty_driver_kref_get(driver);
1297 driver->ttys[idx] = tty;
1304 * tty_driver_remove_tty() - remove a tty from the driver tables
1305 * @driver: the driver for the tty
1306 * @idx: the minor number
1308 * Remvoe a tty object from the driver tables. The tty->index field
1309 * will be set by the time this is called.
1311 * Locking: tty_mutex for now
1313 void tty_driver_remove_tty(struct tty_driver *driver, struct tty_struct *tty)
1315 if (driver->ops->remove)
1316 driver->ops->remove(driver, tty);
1318 driver->ttys[tty->index] = NULL;
1322 * tty_reopen() - fast re-open of an open tty
1323 * @tty - the tty to open
1325 * Return 0 on success, -errno on error.
1327 * Locking: tty_mutex must be held from the time the tty was found
1328 * till this open completes.
1330 static int tty_reopen(struct tty_struct *tty)
1332 struct tty_driver *driver = tty->driver;
1334 if (test_bit(TTY_CLOSING, &tty->flags) ||
1335 test_bit(TTY_HUPPING, &tty->flags) ||
1336 test_bit(TTY_LDISC_CHANGING, &tty->flags))
1339 if (driver->type == TTY_DRIVER_TYPE_PTY &&
1340 driver->subtype == PTY_TYPE_MASTER) {
1342 * special case for PTY masters: only one open permitted,
1343 * and the slave side open count is incremented as well.
1351 tty->driver = driver; /* N.B. why do this every time?? */
1353 mutex_lock(&tty->ldisc_mutex);
1354 WARN_ON(!test_bit(TTY_LDISC, &tty->flags));
1355 mutex_unlock(&tty->ldisc_mutex);
1361 * tty_init_dev - initialise a tty device
1362 * @driver: tty driver we are opening a device on
1363 * @idx: device index
1364 * @ret_tty: returned tty structure
1365 * @first_ok: ok to open a new device (used by ptmx)
1367 * Prepare a tty device. This may not be a "new" clean device but
1368 * could also be an active device. The pty drivers require special
1369 * handling because of this.
1372 * The function is called under the tty_mutex, which
1373 * protects us from the tty struct or driver itself going away.
1375 * On exit the tty device has the line discipline attached and
1376 * a reference count of 1. If a pair was created for pty/tty use
1377 * and the other was a pty master then it too has a reference count of 1.
1379 * WSH 06/09/97: Rewritten to remove races and properly clean up after a
1380 * failed open. The new code protects the open with a mutex, so it's
1381 * really quite straightforward. The mutex locking can probably be
1382 * relaxed for the (most common) case of reopening a tty.
1385 struct tty_struct *tty_init_dev(struct tty_driver *driver, int idx,
1388 struct tty_struct *tty;
1391 /* Check if pty master is being opened multiple times */
1392 if (driver->subtype == PTY_TYPE_MASTER &&
1393 (driver->flags & TTY_DRIVER_DEVPTS_MEM) && !first_ok) {
1394 return ERR_PTR(-EIO);
1398 * First time open is complex, especially for PTY devices.
1399 * This code guarantees that either everything succeeds and the
1400 * TTY is ready for operation, or else the table slots are vacated
1401 * and the allocated memory released. (Except that the termios
1402 * and locked termios may be retained.)
1405 if (!try_module_get(driver->owner))
1406 return ERR_PTR(-ENODEV);
1408 tty = alloc_tty_struct();
1411 goto err_module_put;
1413 initialize_tty_struct(tty, driver, idx);
1415 retval = tty_driver_install_tty(driver, tty);
1417 goto err_deinit_tty;
1420 * Structures all installed ... call the ldisc open routines.
1421 * If we fail here just call release_tty to clean up. No need
1422 * to decrement the use counts, as release_tty doesn't care.
1424 retval = tty_ldisc_setup(tty, tty->link);
1426 goto err_release_tty;
1430 deinitialize_tty_struct(tty);
1431 free_tty_struct(tty);
1433 module_put(driver->owner);
1434 return ERR_PTR(retval);
1436 /* call the tty release_tty routine to clean out this slot */
1438 printk_ratelimited(KERN_INFO "tty_init_dev: ldisc open failed, "
1439 "clearing slot %d\n", idx);
1440 release_tty(tty, idx);
1441 return ERR_PTR(retval);
1444 void tty_free_termios(struct tty_struct *tty)
1446 struct ktermios *tp;
1447 int idx = tty->index;
1448 /* Kill this flag and push into drivers for locking etc */
1449 if (tty->driver->flags & TTY_DRIVER_RESET_TERMIOS) {
1450 /* FIXME: Locking on ->termios array */
1452 tty->driver->termios[idx] = NULL;
1456 EXPORT_SYMBOL(tty_free_termios);
1458 void tty_shutdown(struct tty_struct *tty)
1460 tty_driver_remove_tty(tty->driver, tty);
1461 tty_free_termios(tty);
1463 EXPORT_SYMBOL(tty_shutdown);
1466 * release_one_tty - release tty structure memory
1467 * @kref: kref of tty we are obliterating
1469 * Releases memory associated with a tty structure, and clears out the
1470 * driver table slots. This function is called when a device is no longer
1471 * in use. It also gets called when setup of a device fails.
1474 * tty_mutex - sometimes only
1475 * takes the file list lock internally when working on the list
1476 * of ttys that the driver keeps.
1478 * This method gets called from a work queue so that the driver private
1479 * cleanup ops can sleep (needed for USB at least)
1481 static void release_one_tty(struct work_struct *work)
1483 struct tty_struct *tty =
1484 container_of(work, struct tty_struct, hangup_work);
1485 struct tty_driver *driver = tty->driver;
1487 if (tty->ops->cleanup)
1488 tty->ops->cleanup(tty);
1491 tty_driver_kref_put(driver);
1492 module_put(driver->owner);
1494 spin_lock(&tty_files_lock);
1495 list_del_init(&tty->tty_files);
1496 spin_unlock(&tty_files_lock);
1499 put_pid(tty->session);
1500 free_tty_struct(tty);
1503 static void queue_release_one_tty(struct kref *kref)
1505 struct tty_struct *tty = container_of(kref, struct tty_struct, kref);
1507 if (tty->ops->shutdown)
1508 tty->ops->shutdown(tty);
1512 /* The hangup queue is now free so we can reuse it rather than
1513 waste a chunk of memory for each port */
1514 INIT_WORK(&tty->hangup_work, release_one_tty);
1515 schedule_work(&tty->hangup_work);
1519 * tty_kref_put - release a tty kref
1522 * Release a reference to a tty device and if need be let the kref
1523 * layer destruct the object for us
1526 void tty_kref_put(struct tty_struct *tty)
1529 kref_put(&tty->kref, queue_release_one_tty);
1531 EXPORT_SYMBOL(tty_kref_put);
1534 * release_tty - release tty structure memory
1536 * Release both @tty and a possible linked partner (think pty pair),
1537 * and decrement the refcount of the backing module.
1540 * tty_mutex - sometimes only
1541 * takes the file list lock internally when working on the list
1542 * of ttys that the driver keeps.
1543 * FIXME: should we require tty_mutex is held here ??
1546 static void release_tty(struct tty_struct *tty, int idx)
1548 /* This should always be true but check for the moment */
1549 WARN_ON(tty->index != idx);
1552 tty_kref_put(tty->link);
1557 * tty_release - vfs callback for close
1558 * @inode: inode of tty
1559 * @filp: file pointer for handle to tty
1561 * Called the last time each file handle is closed that references
1562 * this tty. There may however be several such references.
1565 * Takes bkl. See tty_release_dev
1567 * Even releasing the tty structures is a tricky business.. We have
1568 * to be very careful that the structures are all released at the
1569 * same time, as interrupts might otherwise get the wrong pointers.
1571 * WSH 09/09/97: rewritten to avoid some nasty race conditions that could
1572 * lead to double frees or releasing memory still in use.
1575 int tty_release(struct inode *inode, struct file *filp)
1577 struct tty_struct *tty = file_tty(filp);
1578 struct tty_struct *o_tty;
1579 int pty_master, tty_closing, o_tty_closing, do_sleep;
1584 if (tty_paranoia_check(tty, inode, "tty_release_dev"))
1588 check_tty_count(tty, "tty_release_dev");
1590 __tty_fasync(-1, filp, 0);
1593 pty_master = (tty->driver->type == TTY_DRIVER_TYPE_PTY &&
1594 tty->driver->subtype == PTY_TYPE_MASTER);
1595 devpts = (tty->driver->flags & TTY_DRIVER_DEVPTS_MEM) != 0;
1598 #ifdef TTY_PARANOIA_CHECK
1599 if (idx < 0 || idx >= tty->driver->num) {
1600 printk(KERN_DEBUG "tty_release_dev: bad idx when trying to "
1601 "free (%s)\n", tty->name);
1606 if (tty != tty->driver->ttys[idx]) {
1608 printk(KERN_DEBUG "tty_release_dev: driver.table[%d] not tty "
1609 "for (%s)\n", idx, tty->name);
1612 if (tty->termios != tty->driver->termios[idx]) {
1614 printk(KERN_DEBUG "tty_release_dev: driver.termios[%d] not termios "
1622 #ifdef TTY_DEBUG_HANGUP
1623 printk(KERN_DEBUG "tty_release_dev of %s (tty count=%d)...",
1624 tty_name(tty, buf), tty->count);
1627 #ifdef TTY_PARANOIA_CHECK
1628 if (tty->driver->other &&
1629 !(tty->driver->flags & TTY_DRIVER_DEVPTS_MEM)) {
1630 if (o_tty != tty->driver->other->ttys[idx]) {
1632 printk(KERN_DEBUG "tty_release_dev: other->table[%d] "
1633 "not o_tty for (%s)\n",
1637 if (o_tty->termios != tty->driver->other->termios[idx]) {
1639 printk(KERN_DEBUG "tty_release_dev: other->termios[%d] "
1640 "not o_termios for (%s)\n",
1644 if (o_tty->link != tty) {
1646 printk(KERN_DEBUG "tty_release_dev: bad pty pointers\n");
1651 if (tty->ops->close)
1652 tty->ops->close(tty, filp);
1656 * Sanity check: if tty->count is going to zero, there shouldn't be
1657 * any waiters on tty->read_wait or tty->write_wait. We test the
1658 * wait queues and kick everyone out _before_ actually starting to
1659 * close. This ensures that we won't block while releasing the tty
1662 * The test for the o_tty closing is necessary, since the master and
1663 * slave sides may close in any order. If the slave side closes out
1664 * first, its count will be one, since the master side holds an open.
1665 * Thus this test wouldn't be triggered at the time the slave closes,
1668 * Note that it's possible for the tty to be opened again while we're
1669 * flushing out waiters. By recalculating the closing flags before
1670 * each iteration we avoid any problems.
1673 /* Guard against races with tty->count changes elsewhere and
1674 opens on /dev/tty */
1676 mutex_lock(&tty_mutex);
1678 tty_closing = tty->count <= 1;
1679 o_tty_closing = o_tty &&
1680 (o_tty->count <= (pty_master ? 1 : 0));
1684 if (waitqueue_active(&tty->read_wait)) {
1685 wake_up_poll(&tty->read_wait, POLLIN);
1688 if (waitqueue_active(&tty->write_wait)) {
1689 wake_up_poll(&tty->write_wait, POLLOUT);
1693 if (o_tty_closing) {
1694 if (waitqueue_active(&o_tty->read_wait)) {
1695 wake_up_poll(&o_tty->read_wait, POLLIN);
1698 if (waitqueue_active(&o_tty->write_wait)) {
1699 wake_up_poll(&o_tty->write_wait, POLLOUT);
1706 printk(KERN_WARNING "tty_release_dev: %s: read/write wait queue "
1707 "active!\n", tty_name(tty, buf));
1709 mutex_unlock(&tty_mutex);
1714 * The closing flags are now consistent with the open counts on
1715 * both sides, and we've completed the last operation that could
1716 * block, so it's safe to proceed with closing.
1719 if (--o_tty->count < 0) {
1720 printk(KERN_WARNING "tty_release_dev: bad pty slave count "
1722 o_tty->count, tty_name(o_tty, buf));
1726 if (--tty->count < 0) {
1727 printk(KERN_WARNING "tty_release_dev: bad tty->count (%d) for %s\n",
1728 tty->count, tty_name(tty, buf));
1733 * We've decremented tty->count, so we need to remove this file
1734 * descriptor off the tty->tty_files list; this serves two
1736 * - check_tty_count sees the correct number of file descriptors
1737 * associated with this tty.
1738 * - do_tty_hangup no longer sees this file descriptor as
1739 * something that needs to be handled for hangups.
1744 * Perform some housekeeping before deciding whether to return.
1746 * Set the TTY_CLOSING flag if this was the last open. In the
1747 * case of a pty we may have to wait around for the other side
1748 * to close, and TTY_CLOSING makes sure we can't be reopened.
1751 set_bit(TTY_CLOSING, &tty->flags);
1753 set_bit(TTY_CLOSING, &o_tty->flags);
1756 * If _either_ side is closing, make sure there aren't any
1757 * processes that still think tty or o_tty is their controlling
1760 if (tty_closing || o_tty_closing) {
1761 read_lock(&tasklist_lock);
1762 session_clear_tty(tty->session);
1764 session_clear_tty(o_tty->session);
1765 read_unlock(&tasklist_lock);
1768 mutex_unlock(&tty_mutex);
1770 /* check whether both sides are closing ... */
1771 if (!tty_closing || (o_tty && !o_tty_closing)) {
1776 #ifdef TTY_DEBUG_HANGUP
1777 printk(KERN_DEBUG "freeing tty structure...");
1780 * Ask the line discipline code to release its structures
1782 tty_ldisc_release(tty, o_tty);
1784 * The release_tty function takes care of the details of clearing
1785 * the slots and preserving the termios structure.
1787 release_tty(tty, idx);
1789 /* Make this pty number available for reallocation */
1791 devpts_kill_index(inode, idx);
1797 * tty_open - open a tty device
1798 * @inode: inode of device file
1799 * @filp: file pointer to tty
1801 * tty_open and tty_release keep up the tty count that contains the
1802 * number of opens done on a tty. We cannot use the inode-count, as
1803 * different inodes might point to the same tty.
1805 * Open-counting is needed for pty masters, as well as for keeping
1806 * track of serial lines: DTR is dropped when the last close happens.
1807 * (This is not done solely through tty->count, now. - Ted 1/27/92)
1809 * The termios state of a pty is reset on first open so that
1810 * settings don't persist across reuse.
1812 * Locking: tty_mutex protects tty, get_tty_driver and tty_init_dev work.
1813 * tty->count should protect the rest.
1814 * ->siglock protects ->signal/->sighand
1817 static int tty_open(struct inode *inode, struct file *filp)
1819 struct tty_struct *tty = NULL;
1821 struct tty_driver *driver;
1823 dev_t device = inode->i_rdev;
1824 unsigned saved_flags = filp->f_flags;
1826 nonseekable_open(inode, filp);
1829 retval = tty_alloc_file(filp);
1833 noctty = filp->f_flags & O_NOCTTY;
1837 mutex_lock(&tty_mutex);
1840 if (device == MKDEV(TTYAUX_MAJOR, 0)) {
1841 tty = get_current_tty();
1844 mutex_unlock(&tty_mutex);
1845 tty_free_file(filp);
1848 driver = tty_driver_kref_get(tty->driver);
1850 filp->f_flags |= O_NONBLOCK; /* Don't let /dev/tty block */
1852 /* FIXME: Should we take a driver reference ? */
1857 if (device == MKDEV(TTY_MAJOR, 0)) {
1858 extern struct tty_driver *console_driver;
1859 driver = tty_driver_kref_get(console_driver);
1865 if (device == MKDEV(TTYAUX_MAJOR, 1)) {
1866 struct tty_driver *console_driver = console_device(&index);
1867 if (console_driver) {
1868 driver = tty_driver_kref_get(console_driver);
1870 /* Don't let /dev/console block */
1871 filp->f_flags |= O_NONBLOCK;
1877 mutex_unlock(&tty_mutex);
1878 tty_free_file(filp);
1882 driver = get_tty_driver(device, &index);
1885 mutex_unlock(&tty_mutex);
1886 tty_free_file(filp);
1891 /* check whether we're reopening an existing tty */
1892 tty = tty_driver_lookup_tty(driver, inode, index);
1896 mutex_unlock(&tty_mutex);
1897 tty_driver_kref_put(driver);
1898 tty_free_file(filp);
1899 return PTR_ERR(tty);
1904 retval = tty_reopen(tty);
1906 tty = ERR_PTR(retval);
1908 tty = tty_init_dev(driver, index, 0);
1910 mutex_unlock(&tty_mutex);
1911 tty_driver_kref_put(driver);
1914 tty_free_file(filp);
1915 return PTR_ERR(tty);
1918 tty_add_file(tty, filp);
1920 check_tty_count(tty, "tty_open");
1921 if (tty->driver->type == TTY_DRIVER_TYPE_PTY &&
1922 tty->driver->subtype == PTY_TYPE_MASTER)
1924 #ifdef TTY_DEBUG_HANGUP
1925 printk(KERN_DEBUG "opening %s...", tty->name);
1928 retval = tty->ops->open(tty, filp);
1931 filp->f_flags = saved_flags;
1933 if (!retval && test_bit(TTY_EXCLUSIVE, &tty->flags) &&
1934 !capable(CAP_SYS_ADMIN))
1938 #ifdef TTY_DEBUG_HANGUP
1939 printk(KERN_DEBUG "error %d in opening %s...", retval,
1942 tty_unlock(); /* need to call tty_release without BTM */
1943 tty_release(inode, filp);
1944 if (retval != -ERESTARTSYS)
1947 if (signal_pending(current))
1952 * Need to reset f_op in case a hangup happened.
1955 if (filp->f_op == &hung_up_tty_fops)
1956 filp->f_op = &tty_fops;
1963 mutex_lock(&tty_mutex);
1965 spin_lock_irq(¤t->sighand->siglock);
1967 current->signal->leader &&
1968 !current->signal->tty &&
1969 tty->session == NULL)
1970 __proc_set_tty(current, tty);
1971 spin_unlock_irq(¤t->sighand->siglock);
1973 mutex_unlock(&tty_mutex);
1980 * tty_poll - check tty status
1981 * @filp: file being polled
1982 * @wait: poll wait structures to update
1984 * Call the line discipline polling method to obtain the poll
1985 * status of the device.
1987 * Locking: locks called line discipline but ldisc poll method
1988 * may be re-entered freely by other callers.
1991 static unsigned int tty_poll(struct file *filp, poll_table *wait)
1993 struct tty_struct *tty = file_tty(filp);
1994 struct tty_ldisc *ld;
1997 if (tty_paranoia_check(tty, filp->f_path.dentry->d_inode, "tty_poll"))
2000 ld = tty_ldisc_ref_wait(tty);
2002 ret = (ld->ops->poll)(tty, filp, wait);
2003 tty_ldisc_deref(ld);
2007 static int __tty_fasync(int fd, struct file *filp, int on)
2009 struct tty_struct *tty = file_tty(filp);
2010 unsigned long flags;
2013 if (tty_paranoia_check(tty, filp->f_path.dentry->d_inode, "tty_fasync"))
2016 retval = fasync_helper(fd, filp, on, &tty->fasync);
2023 if (!waitqueue_active(&tty->read_wait))
2024 tty->minimum_to_wake = 1;
2025 spin_lock_irqsave(&tty->ctrl_lock, flags);
2028 type = PIDTYPE_PGID;
2030 pid = task_pid(current);
2034 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
2035 retval = __f_setown(filp, pid, type, 0);
2040 if (!tty->fasync && !waitqueue_active(&tty->read_wait))
2041 tty->minimum_to_wake = N_TTY_BUF_SIZE;
2048 static int tty_fasync(int fd, struct file *filp, int on)
2052 retval = __tty_fasync(fd, filp, on);
2058 * tiocsti - fake input character
2059 * @tty: tty to fake input into
2060 * @p: pointer to character
2062 * Fake input to a tty device. Does the necessary locking and
2065 * FIXME: does not honour flow control ??
2068 * Called functions take tty_ldisc_lock
2069 * current->signal->tty check is safe without locks
2071 * FIXME: may race normal receive processing
2074 static int tiocsti(struct tty_struct *tty, char __user *p)
2077 struct tty_ldisc *ld;
2079 if ((current->signal->tty != tty) && !capable(CAP_SYS_ADMIN))
2081 if (get_user(ch, p))
2083 tty_audit_tiocsti(tty, ch);
2084 ld = tty_ldisc_ref_wait(tty);
2085 ld->ops->receive_buf(tty, &ch, &mbz, 1);
2086 tty_ldisc_deref(ld);
2091 * tiocgwinsz - implement window query ioctl
2093 * @arg: user buffer for result
2095 * Copies the kernel idea of the window size into the user buffer.
2097 * Locking: tty->termios_mutex is taken to ensure the winsize data
2101 static int tiocgwinsz(struct tty_struct *tty, struct winsize __user *arg)
2105 mutex_lock(&tty->termios_mutex);
2106 err = copy_to_user(arg, &tty->winsize, sizeof(*arg));
2107 mutex_unlock(&tty->termios_mutex);
2109 return err ? -EFAULT: 0;
2113 * tty_do_resize - resize event
2114 * @tty: tty being resized
2115 * @rows: rows (character)
2116 * @cols: cols (character)
2118 * Update the termios variables and send the necessary signals to
2119 * peform a terminal resize correctly
2122 int tty_do_resize(struct tty_struct *tty, struct winsize *ws)
2125 unsigned long flags;
2128 mutex_lock(&tty->termios_mutex);
2129 if (!memcmp(ws, &tty->winsize, sizeof(*ws)))
2131 /* Get the PID values and reference them so we can
2132 avoid holding the tty ctrl lock while sending signals */
2133 spin_lock_irqsave(&tty->ctrl_lock, flags);
2134 pgrp = get_pid(tty->pgrp);
2135 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
2138 kill_pgrp(pgrp, SIGWINCH, 1);
2143 mutex_unlock(&tty->termios_mutex);
2148 * tiocswinsz - implement window size set ioctl
2149 * @tty; tty side of tty
2150 * @arg: user buffer for result
2152 * Copies the user idea of the window size to the kernel. Traditionally
2153 * this is just advisory information but for the Linux console it
2154 * actually has driver level meaning and triggers a VC resize.
2157 * Driver dependent. The default do_resize method takes the
2158 * tty termios mutex and ctrl_lock. The console takes its own lock
2159 * then calls into the default method.
2162 static int tiocswinsz(struct tty_struct *tty, struct winsize __user *arg)
2164 struct winsize tmp_ws;
2165 if (copy_from_user(&tmp_ws, arg, sizeof(*arg)))
2168 if (tty->ops->resize)
2169 return tty->ops->resize(tty, &tmp_ws);
2171 return tty_do_resize(tty, &tmp_ws);
2175 * tioccons - allow admin to move logical console
2176 * @file: the file to become console
2178 * Allow the administrator to move the redirected console device
2180 * Locking: uses redirect_lock to guard the redirect information
2183 static int tioccons(struct file *file)
2185 if (!capable(CAP_SYS_ADMIN))
2187 if (file->f_op->write == redirected_tty_write) {
2189 spin_lock(&redirect_lock);
2192 spin_unlock(&redirect_lock);
2197 spin_lock(&redirect_lock);
2199 spin_unlock(&redirect_lock);
2204 spin_unlock(&redirect_lock);
2209 * fionbio - non blocking ioctl
2210 * @file: file to set blocking value
2211 * @p: user parameter
2213 * Historical tty interfaces had a blocking control ioctl before
2214 * the generic functionality existed. This piece of history is preserved
2215 * in the expected tty API of posix OS's.
2217 * Locking: none, the open file handle ensures it won't go away.
2220 static int fionbio(struct file *file, int __user *p)
2224 if (get_user(nonblock, p))
2227 spin_lock(&file->f_lock);
2229 file->f_flags |= O_NONBLOCK;
2231 file->f_flags &= ~O_NONBLOCK;
2232 spin_unlock(&file->f_lock);
2237 * tiocsctty - set controlling tty
2238 * @tty: tty structure
2239 * @arg: user argument
2241 * This ioctl is used to manage job control. It permits a session
2242 * leader to set this tty as the controlling tty for the session.
2245 * Takes tty_mutex() to protect tty instance
2246 * Takes tasklist_lock internally to walk sessions
2247 * Takes ->siglock() when updating signal->tty
2250 static int tiocsctty(struct tty_struct *tty, int arg)
2253 if (current->signal->leader && (task_session(current) == tty->session))
2256 mutex_lock(&tty_mutex);
2258 * The process must be a session leader and
2259 * not have a controlling tty already.
2261 if (!current->signal->leader || current->signal->tty) {
2268 * This tty is already the controlling
2269 * tty for another session group!
2271 if (arg == 1 && capable(CAP_SYS_ADMIN)) {
2275 read_lock(&tasklist_lock);
2276 session_clear_tty(tty->session);
2277 read_unlock(&tasklist_lock);
2283 proc_set_tty(current, tty);
2285 mutex_unlock(&tty_mutex);
2290 * tty_get_pgrp - return a ref counted pgrp pid
2293 * Returns a refcounted instance of the pid struct for the process
2294 * group controlling the tty.
2297 struct pid *tty_get_pgrp(struct tty_struct *tty)
2299 unsigned long flags;
2302 spin_lock_irqsave(&tty->ctrl_lock, flags);
2303 pgrp = get_pid(tty->pgrp);
2304 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
2308 EXPORT_SYMBOL_GPL(tty_get_pgrp);
2311 * tiocgpgrp - get process group
2312 * @tty: tty passed by user
2313 * @real_tty: tty side of the tty passed by the user if a pty else the tty
2316 * Obtain the process group of the tty. If there is no process group
2319 * Locking: none. Reference to current->signal->tty is safe.
2322 static int tiocgpgrp(struct tty_struct *tty, struct tty_struct *real_tty, pid_t __user *p)
2327 * (tty == real_tty) is a cheap way of
2328 * testing if the tty is NOT a master pty.
2330 if (tty == real_tty && current->signal->tty != real_tty)
2332 pid = tty_get_pgrp(real_tty);
2333 ret = put_user(pid_vnr(pid), p);
2339 * tiocspgrp - attempt to set process group
2340 * @tty: tty passed by user
2341 * @real_tty: tty side device matching tty passed by user
2344 * Set the process group of the tty to the session passed. Only
2345 * permitted where the tty session is our session.
2347 * Locking: RCU, ctrl lock
2350 static int tiocspgrp(struct tty_struct *tty, struct tty_struct *real_tty, pid_t __user *p)
2354 int retval = tty_check_change(real_tty);
2355 unsigned long flags;
2361 if (!current->signal->tty ||
2362 (current->signal->tty != real_tty) ||
2363 (real_tty->session != task_session(current)))
2365 if (get_user(pgrp_nr, p))
2370 pgrp = find_vpid(pgrp_nr);
2375 if (session_of_pgrp(pgrp) != task_session(current))
2378 spin_lock_irqsave(&tty->ctrl_lock, flags);
2379 put_pid(real_tty->pgrp);
2380 real_tty->pgrp = get_pid(pgrp);
2381 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
2388 * tiocgsid - get session id
2389 * @tty: tty passed by user
2390 * @real_tty: tty side of the tty passed by the user if a pty else the tty
2391 * @p: pointer to returned session id
2393 * Obtain the session id of the tty. If there is no session
2396 * Locking: none. Reference to current->signal->tty is safe.
2399 static int tiocgsid(struct tty_struct *tty, struct tty_struct *real_tty, pid_t __user *p)
2402 * (tty == real_tty) is a cheap way of
2403 * testing if the tty is NOT a master pty.
2405 if (tty == real_tty && current->signal->tty != real_tty)
2407 if (!real_tty->session)
2409 return put_user(pid_vnr(real_tty->session), p);
2413 * tiocsetd - set line discipline
2415 * @p: pointer to user data
2417 * Set the line discipline according to user request.
2419 * Locking: see tty_set_ldisc, this function is just a helper
2422 static int tiocsetd(struct tty_struct *tty, int __user *p)
2427 if (get_user(ldisc, p))
2430 ret = tty_set_ldisc(tty, ldisc);
2436 * send_break - performed time break
2437 * @tty: device to break on
2438 * @duration: timeout in mS
2440 * Perform a timed break on hardware that lacks its own driver level
2441 * timed break functionality.
2444 * atomic_write_lock serializes
2448 static int send_break(struct tty_struct *tty, unsigned int duration)
2452 if (tty->ops->break_ctl == NULL)
2455 if (tty->driver->flags & TTY_DRIVER_HARDWARE_BREAK)
2456 retval = tty->ops->break_ctl(tty, duration);
2458 /* Do the work ourselves */
2459 if (tty_write_lock(tty, 0) < 0)
2461 retval = tty->ops->break_ctl(tty, -1);
2464 if (!signal_pending(current))
2465 msleep_interruptible(duration);
2466 retval = tty->ops->break_ctl(tty, 0);
2468 tty_write_unlock(tty);
2469 if (signal_pending(current))
2476 * tty_tiocmget - get modem status
2478 * @file: user file pointer
2479 * @p: pointer to result
2481 * Obtain the modem status bits from the tty driver if the feature
2482 * is supported. Return -EINVAL if it is not available.
2484 * Locking: none (up to the driver)
2487 static int tty_tiocmget(struct tty_struct *tty, int __user *p)
2489 int retval = -EINVAL;
2491 if (tty->ops->tiocmget) {
2492 retval = tty->ops->tiocmget(tty);
2495 retval = put_user(retval, p);
2501 * tty_tiocmset - set modem status
2503 * @cmd: command - clear bits, set bits or set all
2504 * @p: pointer to desired bits
2506 * Set the modem status bits from the tty driver if the feature
2507 * is supported. Return -EINVAL if it is not available.
2509 * Locking: none (up to the driver)
2512 static int tty_tiocmset(struct tty_struct *tty, unsigned int cmd,
2516 unsigned int set, clear, val;
2518 if (tty->ops->tiocmset == NULL)
2521 retval = get_user(val, p);
2537 set &= TIOCM_DTR|TIOCM_RTS|TIOCM_OUT1|TIOCM_OUT2|TIOCM_LOOP;
2538 clear &= TIOCM_DTR|TIOCM_RTS|TIOCM_OUT1|TIOCM_OUT2|TIOCM_LOOP;
2539 return tty->ops->tiocmset(tty, set, clear);
2542 static int tty_tiocgicount(struct tty_struct *tty, void __user *arg)
2544 int retval = -EINVAL;
2545 struct serial_icounter_struct icount;
2546 memset(&icount, 0, sizeof(icount));
2547 if (tty->ops->get_icount)
2548 retval = tty->ops->get_icount(tty, &icount);
2551 if (copy_to_user(arg, &icount, sizeof(icount)))
2556 struct tty_struct *tty_pair_get_tty(struct tty_struct *tty)
2558 if (tty->driver->type == TTY_DRIVER_TYPE_PTY &&
2559 tty->driver->subtype == PTY_TYPE_MASTER)
2563 EXPORT_SYMBOL(tty_pair_get_tty);
2565 struct tty_struct *tty_pair_get_pty(struct tty_struct *tty)
2567 if (tty->driver->type == TTY_DRIVER_TYPE_PTY &&
2568 tty->driver->subtype == PTY_TYPE_MASTER)
2572 EXPORT_SYMBOL(tty_pair_get_pty);
2575 * Split this up, as gcc can choke on it otherwise..
2577 long tty_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
2579 struct tty_struct *tty = file_tty(file);
2580 struct tty_struct *real_tty;
2581 void __user *p = (void __user *)arg;
2583 struct tty_ldisc *ld;
2584 struct inode *inode = file->f_dentry->d_inode;
2586 if (tty_paranoia_check(tty, inode, "tty_ioctl"))
2589 real_tty = tty_pair_get_tty(tty);
2592 * Factor out some common prep work
2600 retval = tty_check_change(tty);
2603 if (cmd != TIOCCBRK) {
2604 tty_wait_until_sent(tty, 0);
2605 if (signal_pending(current))
2616 return tiocsti(tty, p);
2618 return tiocgwinsz(real_tty, p);
2620 return tiocswinsz(real_tty, p);
2622 return real_tty != tty ? -EINVAL : tioccons(file);
2624 return fionbio(file, p);
2626 set_bit(TTY_EXCLUSIVE, &tty->flags);
2629 clear_bit(TTY_EXCLUSIVE, &tty->flags);
2632 if (current->signal->tty != tty)
2637 return tiocsctty(tty, arg);
2639 return tiocgpgrp(tty, real_tty, p);
2641 return tiocspgrp(tty, real_tty, p);
2643 return tiocgsid(tty, real_tty, p);
2645 return put_user(tty->ldisc->ops->num, (int __user *)p);
2647 return tiocsetd(tty, p);
2649 if (!capable(CAP_SYS_ADMIN))
2655 unsigned int ret = new_encode_dev(tty_devnum(real_tty));
2656 return put_user(ret, (unsigned int __user *)p);
2661 case TIOCSBRK: /* Turn break on, unconditionally */
2662 if (tty->ops->break_ctl)
2663 return tty->ops->break_ctl(tty, -1);
2665 case TIOCCBRK: /* Turn break off, unconditionally */
2666 if (tty->ops->break_ctl)
2667 return tty->ops->break_ctl(tty, 0);
2669 case TCSBRK: /* SVID version: non-zero arg --> no break */
2670 /* non-zero arg means wait for all output data
2671 * to be sent (performed above) but don't send break.
2672 * This is used by the tcdrain() termios function.
2675 return send_break(tty, 250);
2677 case TCSBRKP: /* support for POSIX tcsendbreak() */
2678 return send_break(tty, arg ? arg*100 : 250);
2681 return tty_tiocmget(tty, p);
2685 return tty_tiocmset(tty, cmd, p);
2687 retval = tty_tiocgicount(tty, p);
2688 /* For the moment allow fall through to the old method */
2689 if (retval != -EINVAL)
2696 /* flush tty buffer and allow ldisc to process ioctl */
2697 tty_buffer_flush(tty);
2702 if (tty->ops->ioctl) {
2703 retval = (tty->ops->ioctl)(tty, cmd, arg);
2704 if (retval != -ENOIOCTLCMD)
2707 ld = tty_ldisc_ref_wait(tty);
2709 if (ld->ops->ioctl) {
2710 retval = ld->ops->ioctl(tty, file, cmd, arg);
2711 if (retval == -ENOIOCTLCMD)
2714 tty_ldisc_deref(ld);
2718 #ifdef CONFIG_COMPAT
2719 static long tty_compat_ioctl(struct file *file, unsigned int cmd,
2722 struct inode *inode = file->f_dentry->d_inode;
2723 struct tty_struct *tty = file_tty(file);
2724 struct tty_ldisc *ld;
2725 int retval = -ENOIOCTLCMD;
2727 if (tty_paranoia_check(tty, inode, "tty_ioctl"))
2730 if (tty->ops->compat_ioctl) {
2731 retval = (tty->ops->compat_ioctl)(tty, cmd, arg);
2732 if (retval != -ENOIOCTLCMD)
2736 ld = tty_ldisc_ref_wait(tty);
2737 if (ld->ops->compat_ioctl)
2738 retval = ld->ops->compat_ioctl(tty, file, cmd, arg);
2740 retval = n_tty_compat_ioctl_helper(tty, file, cmd, arg);
2741 tty_ldisc_deref(ld);
2748 * This implements the "Secure Attention Key" --- the idea is to
2749 * prevent trojan horses by killing all processes associated with this
2750 * tty when the user hits the "Secure Attention Key". Required for
2751 * super-paranoid applications --- see the Orange Book for more details.
2753 * This code could be nicer; ideally it should send a HUP, wait a few
2754 * seconds, then send a INT, and then a KILL signal. But you then
2755 * have to coordinate with the init process, since all processes associated
2756 * with the current tty must be dead before the new getty is allowed
2759 * Now, if it would be correct ;-/ The current code has a nasty hole -
2760 * it doesn't catch files in flight. We may send the descriptor to ourselves
2761 * via AF_UNIX socket, close it and later fetch from socket. FIXME.
2763 * Nasty bug: do_SAK is being called in interrupt context. This can
2764 * deadlock. We punt it up to process context. AKPM - 16Mar2001
2766 void __do_SAK(struct tty_struct *tty)
2771 struct task_struct *g, *p;
2772 struct pid *session;
2775 struct fdtable *fdt;
2779 session = tty->session;
2781 tty_ldisc_flush(tty);
2783 tty_driver_flush_buffer(tty);
2785 read_lock(&tasklist_lock);
2786 /* Kill the entire session */
2787 do_each_pid_task(session, PIDTYPE_SID, p) {
2788 printk(KERN_NOTICE "SAK: killed process %d"
2789 " (%s): task_session(p)==tty->session\n",
2790 task_pid_nr(p), p->comm);
2791 send_sig(SIGKILL, p, 1);
2792 } while_each_pid_task(session, PIDTYPE_SID, p);
2793 /* Now kill any processes that happen to have the
2796 do_each_thread(g, p) {
2797 if (p->signal->tty == tty) {
2798 printk(KERN_NOTICE "SAK: killed process %d"
2799 " (%s): task_session(p)==tty->session\n",
2800 task_pid_nr(p), p->comm);
2801 send_sig(SIGKILL, p, 1);
2807 * We don't take a ref to the file, so we must
2808 * hold ->file_lock instead.
2810 spin_lock(&p->files->file_lock);
2811 fdt = files_fdtable(p->files);
2812 for (i = 0; i < fdt->max_fds; i++) {
2813 filp = fcheck_files(p->files, i);
2816 if (filp->f_op->read == tty_read &&
2817 file_tty(filp) == tty) {
2818 printk(KERN_NOTICE "SAK: killed process %d"
2819 " (%s): fd#%d opened to the tty\n",
2820 task_pid_nr(p), p->comm, i);
2821 force_sig(SIGKILL, p);
2825 spin_unlock(&p->files->file_lock);
2828 } while_each_thread(g, p);
2829 read_unlock(&tasklist_lock);
2833 static void do_SAK_work(struct work_struct *work)
2835 struct tty_struct *tty =
2836 container_of(work, struct tty_struct, SAK_work);
2841 * The tq handling here is a little racy - tty->SAK_work may already be queued.
2842 * Fortunately we don't need to worry, because if ->SAK_work is already queued,
2843 * the values which we write to it will be identical to the values which it
2844 * already has. --akpm
2846 void do_SAK(struct tty_struct *tty)
2850 schedule_work(&tty->SAK_work);
2853 EXPORT_SYMBOL(do_SAK);
2855 static int dev_match_devt(struct device *dev, void *data)
2858 return dev->devt == *devt;
2861 /* Must put_device() after it's unused! */
2862 static struct device *tty_get_device(struct tty_struct *tty)
2864 dev_t devt = tty_devnum(tty);
2865 return class_find_device(tty_class, NULL, &devt, dev_match_devt);
2870 * initialize_tty_struct
2871 * @tty: tty to initialize
2873 * This subroutine initializes a tty structure that has been newly
2876 * Locking: none - tty in question must not be exposed at this point
2879 void initialize_tty_struct(struct tty_struct *tty,
2880 struct tty_driver *driver, int idx)
2882 memset(tty, 0, sizeof(struct tty_struct));
2883 kref_init(&tty->kref);
2884 tty->magic = TTY_MAGIC;
2885 tty_ldisc_init(tty);
2886 tty->session = NULL;
2888 tty->overrun_time = jiffies;
2889 tty->buf.head = tty->buf.tail = NULL;
2890 tty_buffer_init(tty);
2891 mutex_init(&tty->termios_mutex);
2892 mutex_init(&tty->ldisc_mutex);
2893 init_waitqueue_head(&tty->write_wait);
2894 init_waitqueue_head(&tty->read_wait);
2895 INIT_WORK(&tty->hangup_work, do_tty_hangup);
2896 mutex_init(&tty->atomic_read_lock);
2897 mutex_init(&tty->atomic_write_lock);
2898 mutex_init(&tty->output_lock);
2899 mutex_init(&tty->echo_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);
2905 tty->driver = driver;
2906 tty->ops = driver->ops;
2908 tty_line_name(driver, idx, tty->name);
2909 tty->dev = tty_get_device(tty);
2913 * deinitialize_tty_struct
2914 * @tty: tty to deinitialize
2916 * This subroutine deinitializes a tty structure that has been newly
2917 * allocated but tty_release cannot be called on that yet.
2919 * Locking: none - tty in question must not be exposed at this point
2921 void deinitialize_tty_struct(struct tty_struct *tty)
2923 tty_ldisc_deinit(tty);
2927 * tty_put_char - write one character to a tty
2931 * Write one byte to the tty using the provided put_char method
2932 * if present. Returns the number of characters successfully output.
2934 * Note: the specific put_char operation in the driver layer may go
2935 * away soon. Don't call it directly, use this method
2938 int tty_put_char(struct tty_struct *tty, unsigned char ch)
2940 if (tty->ops->put_char)
2941 return tty->ops->put_char(tty, ch);
2942 return tty->ops->write(tty, &ch, 1);
2944 EXPORT_SYMBOL_GPL(tty_put_char);
2946 struct class *tty_class;
2949 * tty_register_device - register a tty device
2950 * @driver: the tty driver that describes the tty device
2951 * @index: the index in the tty driver for this tty device
2952 * @device: a struct device that is associated with this tty device.
2953 * This field is optional, if there is no known struct device
2954 * for this tty device it can be set to NULL safely.
2956 * Returns a pointer to the struct device for this tty device
2957 * (or ERR_PTR(-EFOO) on error).
2959 * This call is required to be made to register an individual tty device
2960 * if the tty driver's flags have the TTY_DRIVER_DYNAMIC_DEV bit set. If
2961 * that bit is not set, this function should not be called by a tty
2967 struct device *tty_register_device(struct tty_driver *driver, unsigned index,
2968 struct device *device)
2971 dev_t dev = MKDEV(driver->major, driver->minor_start) + index;
2973 if (index >= driver->num) {
2974 printk(KERN_ERR "Attempt to register invalid tty line number "
2976 return ERR_PTR(-EINVAL);
2979 if (driver->type == TTY_DRIVER_TYPE_PTY)
2980 pty_line_name(driver, index, name);
2982 tty_line_name(driver, index, name);
2984 return device_create(tty_class, device, dev, NULL, name);
2986 EXPORT_SYMBOL(tty_register_device);
2989 * tty_unregister_device - unregister a tty device
2990 * @driver: the tty driver that describes the tty device
2991 * @index: the index in the tty driver for this tty device
2993 * If a tty device is registered with a call to tty_register_device() then
2994 * this function must be called when the tty device is gone.
2999 void tty_unregister_device(struct tty_driver *driver, unsigned index)
3001 device_destroy(tty_class,
3002 MKDEV(driver->major, driver->minor_start) + index);
3004 EXPORT_SYMBOL(tty_unregister_device);
3006 struct tty_driver *alloc_tty_driver(int lines)
3008 struct tty_driver *driver;
3010 driver = kzalloc(sizeof(struct tty_driver), GFP_KERNEL);
3012 kref_init(&driver->kref);
3013 driver->magic = TTY_DRIVER_MAGIC;
3014 driver->num = lines;
3015 /* later we'll move allocation of tables here */
3019 EXPORT_SYMBOL(alloc_tty_driver);
3021 static void destruct_tty_driver(struct kref *kref)
3023 struct tty_driver *driver = container_of(kref, struct tty_driver, kref);
3025 struct ktermios *tp;
3028 if (driver->flags & TTY_DRIVER_INSTALLED) {
3030 * Free the termios and termios_locked structures because
3031 * we don't want to get memory leaks when modular tty
3032 * drivers are removed from the kernel.
3034 for (i = 0; i < driver->num; i++) {
3035 tp = driver->termios[i];
3037 driver->termios[i] = NULL;
3040 if (!(driver->flags & TTY_DRIVER_DYNAMIC_DEV))
3041 tty_unregister_device(driver, i);
3044 proc_tty_unregister_driver(driver);
3045 driver->ttys = NULL;
3046 driver->termios = NULL;
3048 cdev_del(&driver->cdev);
3053 void tty_driver_kref_put(struct tty_driver *driver)
3055 kref_put(&driver->kref, destruct_tty_driver);
3057 EXPORT_SYMBOL(tty_driver_kref_put);
3059 void tty_set_operations(struct tty_driver *driver,
3060 const struct tty_operations *op)
3064 EXPORT_SYMBOL(tty_set_operations);
3066 void put_tty_driver(struct tty_driver *d)
3068 tty_driver_kref_put(d);
3070 EXPORT_SYMBOL(put_tty_driver);
3073 * Called by a tty driver to register itself.
3075 int tty_register_driver(struct tty_driver *driver)
3083 if (!(driver->flags & TTY_DRIVER_DEVPTS_MEM) && driver->num) {
3084 p = kzalloc(driver->num * 2 * sizeof(void *), GFP_KERNEL);
3089 if (!driver->major) {
3090 error = alloc_chrdev_region(&dev, driver->minor_start,
3091 driver->num, driver->name);
3093 driver->major = MAJOR(dev);
3094 driver->minor_start = MINOR(dev);
3097 dev = MKDEV(driver->major, driver->minor_start);
3098 error = register_chrdev_region(dev, driver->num, driver->name);
3106 driver->ttys = (struct tty_struct **)p;
3107 driver->termios = (struct ktermios **)(p + driver->num);
3109 driver->ttys = NULL;
3110 driver->termios = NULL;
3113 cdev_init(&driver->cdev, &tty_fops);
3114 driver->cdev.owner = driver->owner;
3115 error = cdev_add(&driver->cdev, dev, driver->num);
3117 unregister_chrdev_region(dev, driver->num);
3118 driver->ttys = NULL;
3119 driver->termios = NULL;
3124 mutex_lock(&tty_mutex);
3125 list_add(&driver->tty_drivers, &tty_drivers);
3126 mutex_unlock(&tty_mutex);
3128 if (!(driver->flags & TTY_DRIVER_DYNAMIC_DEV)) {
3129 for (i = 0; i < driver->num; i++) {
3130 d = tty_register_device(driver, i, NULL);
3137 proc_tty_register_driver(driver);
3138 driver->flags |= TTY_DRIVER_INSTALLED;
3142 for (i--; i >= 0; i--)
3143 tty_unregister_device(driver, i);
3145 mutex_lock(&tty_mutex);
3146 list_del(&driver->tty_drivers);
3147 mutex_unlock(&tty_mutex);
3149 unregister_chrdev_region(dev, driver->num);
3150 driver->ttys = NULL;
3151 driver->termios = NULL;
3156 EXPORT_SYMBOL(tty_register_driver);
3159 * Called by a tty driver to unregister itself.
3161 int tty_unregister_driver(struct tty_driver *driver)
3165 if (driver->refcount)
3168 unregister_chrdev_region(MKDEV(driver->major, driver->minor_start),
3170 mutex_lock(&tty_mutex);
3171 list_del(&driver->tty_drivers);
3172 mutex_unlock(&tty_mutex);
3176 EXPORT_SYMBOL(tty_unregister_driver);
3178 dev_t tty_devnum(struct tty_struct *tty)
3180 return MKDEV(tty->driver->major, tty->driver->minor_start) + tty->index;
3182 EXPORT_SYMBOL(tty_devnum);
3184 void proc_clear_tty(struct task_struct *p)
3186 unsigned long flags;
3187 struct tty_struct *tty;
3188 spin_lock_irqsave(&p->sighand->siglock, flags);
3189 tty = p->signal->tty;
3190 p->signal->tty = NULL;
3191 spin_unlock_irqrestore(&p->sighand->siglock, flags);
3195 /* Called under the sighand lock */
3197 static void __proc_set_tty(struct task_struct *tsk, struct tty_struct *tty)
3200 unsigned long flags;
3201 /* We should not have a session or pgrp to put here but.... */
3202 spin_lock_irqsave(&tty->ctrl_lock, flags);
3203 put_pid(tty->session);
3205 tty->pgrp = get_pid(task_pgrp(tsk));
3206 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
3207 tty->session = get_pid(task_session(tsk));
3208 if (tsk->signal->tty) {
3209 printk(KERN_DEBUG "tty not NULL!!\n");
3210 tty_kref_put(tsk->signal->tty);
3213 put_pid(tsk->signal->tty_old_pgrp);
3214 tsk->signal->tty = tty_kref_get(tty);
3215 tsk->signal->tty_old_pgrp = NULL;
3218 static void proc_set_tty(struct task_struct *tsk, struct tty_struct *tty)
3220 spin_lock_irq(&tsk->sighand->siglock);
3221 __proc_set_tty(tsk, tty);
3222 spin_unlock_irq(&tsk->sighand->siglock);
3225 struct tty_struct *get_current_tty(void)
3227 struct tty_struct *tty;
3228 unsigned long flags;
3230 spin_lock_irqsave(¤t->sighand->siglock, flags);
3231 tty = tty_kref_get(current->signal->tty);
3232 spin_unlock_irqrestore(¤t->sighand->siglock, flags);
3235 EXPORT_SYMBOL_GPL(get_current_tty);
3237 void tty_default_fops(struct file_operations *fops)
3243 * Initialize the console device. This is called *early*, so
3244 * we can't necessarily depend on lots of kernel help here.
3245 * Just do some early initializations, and do the complex setup
3248 void __init console_init(void)
3252 /* Setup the default TTY line discipline. */
3256 * set up the console device so that later boot sequences can
3257 * inform about problems etc..
3259 call = __con_initcall_start;
3260 while (call < __con_initcall_end) {
3266 static char *tty_devnode(struct device *dev, mode_t *mode)
3270 if (dev->devt == MKDEV(TTYAUX_MAJOR, 0) ||
3271 dev->devt == MKDEV(TTYAUX_MAJOR, 2))
3276 static int __init tty_class_init(void)
3278 tty_class = class_create(THIS_MODULE, "tty");
3279 if (IS_ERR(tty_class))
3280 return PTR_ERR(tty_class);
3281 tty_class->devnode = tty_devnode;
3285 postcore_initcall(tty_class_init);
3287 /* 3/2004 jmc: why do these devices exist? */
3288 static struct cdev tty_cdev, console_cdev;
3290 static ssize_t show_cons_active(struct device *dev,
3291 struct device_attribute *attr, char *buf)
3293 struct console *cs[16];
3299 for_each_console(c) {
3304 if ((c->flags & CON_ENABLED) == 0)
3307 if (i >= ARRAY_SIZE(cs))
3311 count += sprintf(buf + count, "%s%d%c",
3312 cs[i]->name, cs[i]->index, i ? ' ':'\n');
3317 static DEVICE_ATTR(active, S_IRUGO, show_cons_active, NULL);
3319 static struct device *consdev;
3321 void console_sysfs_notify(void)
3324 sysfs_notify(&consdev->kobj, NULL, "active");
3328 * Ok, now we can initialize the rest of the tty devices and can count
3329 * on memory allocations, interrupts etc..
3331 int __init tty_init(void)
3333 cdev_init(&tty_cdev, &tty_fops);
3334 if (cdev_add(&tty_cdev, MKDEV(TTYAUX_MAJOR, 0), 1) ||
3335 register_chrdev_region(MKDEV(TTYAUX_MAJOR, 0), 1, "/dev/tty") < 0)
3336 panic("Couldn't register /dev/tty driver\n");
3337 device_create(tty_class, NULL, MKDEV(TTYAUX_MAJOR, 0), NULL, "tty");
3339 cdev_init(&console_cdev, &console_fops);
3340 if (cdev_add(&console_cdev, MKDEV(TTYAUX_MAJOR, 1), 1) ||
3341 register_chrdev_region(MKDEV(TTYAUX_MAJOR, 1), 1, "/dev/console") < 0)
3342 panic("Couldn't register /dev/console driver\n");
3343 consdev = device_create(tty_class, NULL, MKDEV(TTYAUX_MAJOR, 1), NULL,
3345 if (IS_ERR(consdev))
3348 WARN_ON(device_create_file(consdev, &dev_attr_active) < 0);
3351 vty_init(&console_fops);