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/signal.h>
73 #include <linux/sched/task.h>
74 #include <linux/interrupt.h>
75 #include <linux/tty.h>
76 #include <linux/tty_driver.h>
77 #include <linux/tty_flip.h>
78 #include <linux/devpts_fs.h>
79 #include <linux/file.h>
80 #include <linux/fdtable.h>
81 #include <linux/console.h>
82 #include <linux/timer.h>
83 #include <linux/ctype.h>
86 #include <linux/string.h>
87 #include <linux/slab.h>
88 #include <linux/poll.h>
89 #include <linux/proc_fs.h>
90 #include <linux/init.h>
91 #include <linux/module.h>
92 #include <linux/device.h>
93 #include <linux/wait.h>
94 #include <linux/bitops.h>
95 #include <linux/delay.h>
96 #include <linux/seq_file.h>
97 #include <linux/serial.h>
98 #include <linux/ratelimit.h>
100 #include <linux/uaccess.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
110 #ifdef TTY_DEBUG_HANGUP
111 # define tty_debug_hangup(tty, f, args...) tty_debug(tty, f, ##args)
113 # define tty_debug_hangup(tty, f, args...) do { } while (0)
116 #define TTY_PARANOIA_CHECK 1
117 #define CHECK_TTY_COUNT 1
119 struct ktermios tty_std_termios
= { /* for the benefit of tty drivers */
120 .c_iflag
= ICRNL
| IXON
,
121 .c_oflag
= OPOST
| ONLCR
,
122 .c_cflag
= B38400
| CS8
| CREAD
| HUPCL
,
123 .c_lflag
= ISIG
| ICANON
| ECHO
| ECHOE
| ECHOK
|
124 ECHOCTL
| ECHOKE
| IEXTEN
,
128 /* .c_line = N_TTY, */
131 EXPORT_SYMBOL(tty_std_termios
);
133 /* This list gets poked at by procfs and various bits of boot up code. This
134 could do with some rationalisation such as pulling the tty proc function
137 LIST_HEAD(tty_drivers
); /* linked list of tty drivers */
139 /* Mutex to protect creating and releasing a tty */
140 DEFINE_MUTEX(tty_mutex
);
142 static ssize_t
tty_read(struct file
*, char __user
*, size_t, loff_t
*);
143 static ssize_t
tty_write(struct file
*, const char __user
*, size_t, loff_t
*);
144 ssize_t
redirected_tty_write(struct file
*, const char __user
*,
146 static unsigned int tty_poll(struct file
*, poll_table
*);
147 static int tty_open(struct inode
*, struct file
*);
148 long tty_ioctl(struct file
*file
, unsigned int cmd
, unsigned long arg
);
150 static long tty_compat_ioctl(struct file
*file
, unsigned int cmd
,
153 #define tty_compat_ioctl NULL
155 static int __tty_fasync(int fd
, struct file
*filp
, int on
);
156 static int tty_fasync(int fd
, struct file
*filp
, int on
);
157 static void release_tty(struct tty_struct
*tty
, int idx
);
160 * free_tty_struct - free a disused tty
161 * @tty: tty struct to free
163 * Free the write buffers, tty queue and tty memory itself.
165 * Locking: none. Must be called after tty is definitely unused
168 static void free_tty_struct(struct tty_struct
*tty
)
170 tty_ldisc_deinit(tty
);
171 put_device(tty
->dev
);
172 kfree(tty
->write_buf
);
173 tty
->magic
= 0xDEADDEAD;
177 static inline struct tty_struct
*file_tty(struct file
*file
)
179 return ((struct tty_file_private
*)file
->private_data
)->tty
;
182 int tty_alloc_file(struct file
*file
)
184 struct tty_file_private
*priv
;
186 priv
= kmalloc(sizeof(*priv
), GFP_KERNEL
);
190 file
->private_data
= priv
;
195 /* Associate a new file with the tty structure */
196 void tty_add_file(struct tty_struct
*tty
, struct file
*file
)
198 struct tty_file_private
*priv
= file
->private_data
;
203 spin_lock(&tty
->files_lock
);
204 list_add(&priv
->list
, &tty
->tty_files
);
205 spin_unlock(&tty
->files_lock
);
209 * tty_free_file - free file->private_data
211 * This shall be used only for fail path handling when tty_add_file was not
214 void tty_free_file(struct file
*file
)
216 struct tty_file_private
*priv
= file
->private_data
;
218 file
->private_data
= NULL
;
222 /* Delete file from its tty */
223 static void tty_del_file(struct file
*file
)
225 struct tty_file_private
*priv
= file
->private_data
;
226 struct tty_struct
*tty
= priv
->tty
;
228 spin_lock(&tty
->files_lock
);
229 list_del(&priv
->list
);
230 spin_unlock(&tty
->files_lock
);
235 * tty_name - return tty naming
236 * @tty: tty structure
238 * Convert a tty structure into a name. The name reflects the kernel
239 * naming policy and if udev is in use may not reflect user space
244 const char *tty_name(const struct tty_struct
*tty
)
246 if (!tty
) /* Hmm. NULL pointer. That's fun. */
251 EXPORT_SYMBOL(tty_name
);
253 const char *tty_driver_name(const struct tty_struct
*tty
)
255 if (!tty
|| !tty
->driver
)
257 return tty
->driver
->name
;
260 static int tty_paranoia_check(struct tty_struct
*tty
, struct inode
*inode
,
263 #ifdef TTY_PARANOIA_CHECK
265 pr_warn("(%d:%d): %s: NULL tty\n",
266 imajor(inode
), iminor(inode
), routine
);
269 if (tty
->magic
!= TTY_MAGIC
) {
270 pr_warn("(%d:%d): %s: bad magic number\n",
271 imajor(inode
), iminor(inode
), routine
);
278 /* Caller must hold tty_lock */
279 static int check_tty_count(struct tty_struct
*tty
, const char *routine
)
281 #ifdef CHECK_TTY_COUNT
283 int count
= 0, kopen_count
= 0;
285 spin_lock(&tty
->files_lock
);
286 list_for_each(p
, &tty
->tty_files
) {
289 spin_unlock(&tty
->files_lock
);
290 if (tty
->driver
->type
== TTY_DRIVER_TYPE_PTY
&&
291 tty
->driver
->subtype
== PTY_TYPE_SLAVE
&&
292 tty
->link
&& tty
->link
->count
)
294 if (tty_port_kopened(tty
->port
))
296 if (tty
->count
!= (count
+ kopen_count
)) {
297 tty_warn(tty
, "%s: tty->count(%d) != (#fd's(%d) + #kopen's(%d))\n",
298 routine
, tty
->count
, count
, kopen_count
);
299 return (count
+ kopen_count
);
306 * get_tty_driver - find device of a tty
307 * @dev_t: device identifier
308 * @index: returns the index of the tty
310 * This routine returns a tty driver structure, given a device number
311 * and also passes back the index number.
313 * Locking: caller must hold tty_mutex
316 static struct tty_driver
*get_tty_driver(dev_t device
, int *index
)
318 struct tty_driver
*p
;
320 list_for_each_entry(p
, &tty_drivers
, tty_drivers
) {
321 dev_t base
= MKDEV(p
->major
, p
->minor_start
);
322 if (device
< base
|| device
>= base
+ p
->num
)
324 *index
= device
- base
;
325 return tty_driver_kref_get(p
);
331 * tty_dev_name_to_number - return dev_t for device name
332 * @name: user space name of device under /dev
333 * @number: pointer to dev_t that this function will populate
335 * This function converts device names like ttyS0 or ttyUSB1 into dev_t
336 * like (4, 64) or (188, 1). If no corresponding driver is registered then
337 * the function returns -ENODEV.
339 * Locking: this acquires tty_mutex to protect the tty_drivers list from
340 * being modified while we are traversing it, and makes sure to
341 * release it before exiting.
343 int tty_dev_name_to_number(const char *name
, dev_t
*number
)
345 struct tty_driver
*p
;
347 int index
, prefix_length
= 0;
350 for (str
= name
; *str
&& !isdigit(*str
); str
++)
356 ret
= kstrtoint(str
, 10, &index
);
360 prefix_length
= str
- name
;
361 mutex_lock(&tty_mutex
);
363 list_for_each_entry(p
, &tty_drivers
, tty_drivers
)
364 if (prefix_length
== strlen(p
->name
) && strncmp(name
,
365 p
->name
, prefix_length
) == 0) {
366 if (index
< p
->num
) {
367 *number
= MKDEV(p
->major
, p
->minor_start
+ index
);
372 /* if here then driver wasn't found */
375 mutex_unlock(&tty_mutex
);
378 EXPORT_SYMBOL_GPL(tty_dev_name_to_number
);
380 #ifdef CONFIG_CONSOLE_POLL
383 * tty_find_polling_driver - find device of a polled tty
384 * @name: name string to match
385 * @line: pointer to resulting tty line nr
387 * This routine returns a tty driver structure, given a name
388 * and the condition that the tty driver is capable of polled
391 struct tty_driver
*tty_find_polling_driver(char *name
, int *line
)
393 struct tty_driver
*p
, *res
= NULL
;
398 for (str
= name
; *str
; str
++)
399 if ((*str
>= '0' && *str
<= '9') || *str
== ',')
405 tty_line
= simple_strtoul(str
, &str
, 10);
407 mutex_lock(&tty_mutex
);
408 /* Search through the tty devices to look for a match */
409 list_for_each_entry(p
, &tty_drivers
, tty_drivers
) {
410 if (strncmp(name
, p
->name
, len
) != 0)
418 if (tty_line
>= 0 && tty_line
< p
->num
&& p
->ops
&&
419 p
->ops
->poll_init
&& !p
->ops
->poll_init(p
, tty_line
, stp
)) {
420 res
= tty_driver_kref_get(p
);
425 mutex_unlock(&tty_mutex
);
429 EXPORT_SYMBOL_GPL(tty_find_polling_driver
);
432 static ssize_t
hung_up_tty_read(struct file
*file
, char __user
*buf
,
433 size_t count
, loff_t
*ppos
)
438 static ssize_t
hung_up_tty_write(struct file
*file
, const char __user
*buf
,
439 size_t count
, loff_t
*ppos
)
444 /* No kernel lock held - none needed ;) */
445 static unsigned int hung_up_tty_poll(struct file
*filp
, poll_table
*wait
)
447 return POLLIN
| POLLOUT
| POLLERR
| POLLHUP
| POLLRDNORM
| POLLWRNORM
;
450 static long hung_up_tty_ioctl(struct file
*file
, unsigned int cmd
,
453 return cmd
== TIOCSPGRP
? -ENOTTY
: -EIO
;
456 static long hung_up_tty_compat_ioctl(struct file
*file
,
457 unsigned int cmd
, unsigned long arg
)
459 return cmd
== TIOCSPGRP
? -ENOTTY
: -EIO
;
462 static int hung_up_tty_fasync(int fd
, struct file
*file
, int on
)
467 static void tty_show_fdinfo(struct seq_file
*m
, struct file
*file
)
469 struct tty_struct
*tty
= file_tty(file
);
471 if (tty
&& tty
->ops
&& tty
->ops
->show_fdinfo
)
472 tty
->ops
->show_fdinfo(tty
, m
);
475 static const struct file_operations tty_fops
= {
480 .unlocked_ioctl
= tty_ioctl
,
481 .compat_ioctl
= tty_compat_ioctl
,
483 .release
= tty_release
,
484 .fasync
= tty_fasync
,
485 .show_fdinfo
= tty_show_fdinfo
,
488 static const struct file_operations console_fops
= {
491 .write
= redirected_tty_write
,
493 .unlocked_ioctl
= tty_ioctl
,
494 .compat_ioctl
= tty_compat_ioctl
,
496 .release
= tty_release
,
497 .fasync
= tty_fasync
,
500 static const struct file_operations hung_up_tty_fops
= {
502 .read
= hung_up_tty_read
,
503 .write
= hung_up_tty_write
,
504 .poll
= hung_up_tty_poll
,
505 .unlocked_ioctl
= hung_up_tty_ioctl
,
506 .compat_ioctl
= hung_up_tty_compat_ioctl
,
507 .release
= tty_release
,
508 .fasync
= hung_up_tty_fasync
,
511 static DEFINE_SPINLOCK(redirect_lock
);
512 static struct file
*redirect
;
515 * tty_wakeup - request more data
518 * Internal and external helper for wakeups of tty. This function
519 * informs the line discipline if present that the driver is ready
520 * to receive more output data.
523 void tty_wakeup(struct tty_struct
*tty
)
525 struct tty_ldisc
*ld
;
527 if (test_bit(TTY_DO_WRITE_WAKEUP
, &tty
->flags
)) {
528 ld
= tty_ldisc_ref(tty
);
530 if (ld
->ops
->write_wakeup
)
531 ld
->ops
->write_wakeup(tty
);
535 wake_up_interruptible_poll(&tty
->write_wait
, POLLOUT
);
538 EXPORT_SYMBOL_GPL(tty_wakeup
);
541 * __tty_hangup - actual handler for hangup events
544 * This can be called by a "kworker" kernel thread. That is process
545 * synchronous but doesn't hold any locks, so we need to make sure we
546 * have the appropriate locks for what we're doing.
548 * The hangup event clears any pending redirections onto the hung up
549 * device. It ensures future writes will error and it does the needed
550 * line discipline hangup and signal delivery. The tty object itself
555 * redirect lock for undoing redirection
556 * file list lock for manipulating list of ttys
557 * tty_ldiscs_lock from called functions
558 * termios_rwsem resetting termios data
559 * tasklist_lock to walk task list for hangup event
560 * ->siglock to protect ->signal/->sighand
562 static void __tty_hangup(struct tty_struct
*tty
, int exit_session
)
564 struct file
*cons_filp
= NULL
;
565 struct file
*filp
, *f
= NULL
;
566 struct tty_file_private
*priv
;
567 int closecount
= 0, n
;
574 spin_lock(&redirect_lock
);
575 if (redirect
&& file_tty(redirect
) == tty
) {
579 spin_unlock(&redirect_lock
);
583 if (test_bit(TTY_HUPPED
, &tty
->flags
)) {
589 * Some console devices aren't actually hung up for technical and
590 * historical reasons, which can lead to indefinite interruptible
591 * sleep in n_tty_read(). The following explicitly tells
592 * n_tty_read() to abort readers.
594 set_bit(TTY_HUPPING
, &tty
->flags
);
596 /* inuse_filps is protected by the single tty lock,
597 this really needs to change if we want to flush the
598 workqueue with the lock held */
599 check_tty_count(tty
, "tty_hangup");
601 spin_lock(&tty
->files_lock
);
602 /* This breaks for file handles being sent over AF_UNIX sockets ? */
603 list_for_each_entry(priv
, &tty
->tty_files
, list
) {
605 if (filp
->f_op
->write
== redirected_tty_write
)
607 if (filp
->f_op
->write
!= tty_write
)
610 __tty_fasync(-1, filp
, 0); /* can't block */
611 filp
->f_op
= &hung_up_tty_fops
;
613 spin_unlock(&tty
->files_lock
);
615 refs
= tty_signal_session_leader(tty
, exit_session
);
616 /* Account for the p->signal references we killed */
620 tty_ldisc_hangup(tty
, cons_filp
!= NULL
);
622 spin_lock_irq(&tty
->ctrl_lock
);
623 clear_bit(TTY_THROTTLED
, &tty
->flags
);
624 clear_bit(TTY_DO_WRITE_WAKEUP
, &tty
->flags
);
625 put_pid(tty
->session
);
629 tty
->ctrl_status
= 0;
630 spin_unlock_irq(&tty
->ctrl_lock
);
633 * If one of the devices matches a console pointer, we
634 * cannot just call hangup() because that will cause
635 * tty->count and state->count to go out of sync.
636 * So we just call close() the right number of times.
640 for (n
= 0; n
< closecount
; n
++)
641 tty
->ops
->close(tty
, cons_filp
);
642 } else if (tty
->ops
->hangup
)
643 tty
->ops
->hangup(tty
);
645 * We don't want to have driver/ldisc interactions beyond the ones
646 * we did here. The driver layer expects no calls after ->hangup()
647 * from the ldisc side, which is now guaranteed.
649 set_bit(TTY_HUPPED
, &tty
->flags
);
650 clear_bit(TTY_HUPPING
, &tty
->flags
);
657 static void do_tty_hangup(struct work_struct
*work
)
659 struct tty_struct
*tty
=
660 container_of(work
, struct tty_struct
, hangup_work
);
662 __tty_hangup(tty
, 0);
666 * tty_hangup - trigger a hangup event
667 * @tty: tty to hangup
669 * A carrier loss (virtual or otherwise) has occurred on this like
670 * schedule a hangup sequence to run after this event.
673 void tty_hangup(struct tty_struct
*tty
)
675 tty_debug_hangup(tty
, "hangup\n");
676 schedule_work(&tty
->hangup_work
);
679 EXPORT_SYMBOL(tty_hangup
);
682 * tty_vhangup - process vhangup
683 * @tty: tty to hangup
685 * The user has asked via system call for the terminal to be hung up.
686 * We do this synchronously so that when the syscall returns the process
687 * is complete. That guarantee is necessary for security reasons.
690 void tty_vhangup(struct tty_struct
*tty
)
692 tty_debug_hangup(tty
, "vhangup\n");
693 __tty_hangup(tty
, 0);
696 EXPORT_SYMBOL(tty_vhangup
);
700 * tty_vhangup_self - process vhangup for own ctty
702 * Perform a vhangup on the current controlling tty
705 void tty_vhangup_self(void)
707 struct tty_struct
*tty
;
709 tty
= get_current_tty();
717 * tty_vhangup_session - hangup session leader exit
718 * @tty: tty to hangup
720 * The session leader is exiting and hanging up its controlling terminal.
721 * Every process in the foreground process group is signalled SIGHUP.
723 * We do this synchronously so that when the syscall returns the process
724 * is complete. That guarantee is necessary for security reasons.
727 void tty_vhangup_session(struct tty_struct
*tty
)
729 tty_debug_hangup(tty
, "session hangup\n");
730 __tty_hangup(tty
, 1);
734 * tty_hung_up_p - was tty hung up
735 * @filp: file pointer of tty
737 * Return true if the tty has been subject to a vhangup or a carrier
741 int tty_hung_up_p(struct file
*filp
)
743 return (filp
&& filp
->f_op
== &hung_up_tty_fops
);
746 EXPORT_SYMBOL(tty_hung_up_p
);
749 * stop_tty - propagate flow control
752 * Perform flow control to the driver. May be called
753 * on an already stopped device and will not re-call the driver
756 * This functionality is used by both the line disciplines for
757 * halting incoming flow and by the driver. It may therefore be
758 * called from any context, may be under the tty atomic_write_lock
765 void __stop_tty(struct tty_struct
*tty
)
774 void stop_tty(struct tty_struct
*tty
)
778 spin_lock_irqsave(&tty
->flow_lock
, flags
);
780 spin_unlock_irqrestore(&tty
->flow_lock
, flags
);
782 EXPORT_SYMBOL(stop_tty
);
785 * start_tty - propagate flow control
788 * Start a tty that has been stopped if at all possible. If this
789 * tty was previous stopped and is now being started, the driver
790 * start method is invoked and the line discipline woken.
796 void __start_tty(struct tty_struct
*tty
)
798 if (!tty
->stopped
|| tty
->flow_stopped
)
802 tty
->ops
->start(tty
);
806 void start_tty(struct tty_struct
*tty
)
810 spin_lock_irqsave(&tty
->flow_lock
, flags
);
812 spin_unlock_irqrestore(&tty
->flow_lock
, flags
);
814 EXPORT_SYMBOL(start_tty
);
816 static void tty_update_time(struct timespec
*time
)
818 unsigned long sec
= get_seconds();
821 * We only care if the two values differ in anything other than the
822 * lower three bits (i.e every 8 seconds). If so, then we can update
823 * the time of the tty device, otherwise it could be construded as a
824 * security leak to let userspace know the exact timing of the tty.
826 if ((sec
^ time
->tv_sec
) & ~7)
831 * tty_read - read method for tty device files
832 * @file: pointer to tty file
834 * @count: size of user buffer
837 * Perform the read system call function on this terminal device. Checks
838 * for hung up devices before calling the line discipline method.
841 * Locks the line discipline internally while needed. Multiple
842 * read calls may be outstanding in parallel.
845 static ssize_t
tty_read(struct file
*file
, char __user
*buf
, size_t count
,
849 struct inode
*inode
= file_inode(file
);
850 struct tty_struct
*tty
= file_tty(file
);
851 struct tty_ldisc
*ld
;
853 if (tty_paranoia_check(tty
, inode
, "tty_read"))
855 if (!tty
|| tty_io_error(tty
))
858 /* We want to wait for the line discipline to sort out in this
860 ld
= tty_ldisc_ref_wait(tty
);
862 return hung_up_tty_read(file
, buf
, count
, ppos
);
864 i
= ld
->ops
->read(tty
, file
, buf
, count
);
870 tty_update_time(&inode
->i_atime
);
875 static void tty_write_unlock(struct tty_struct
*tty
)
877 mutex_unlock(&tty
->atomic_write_lock
);
878 wake_up_interruptible_poll(&tty
->write_wait
, POLLOUT
);
881 static int tty_write_lock(struct tty_struct
*tty
, int ndelay
)
883 if (!mutex_trylock(&tty
->atomic_write_lock
)) {
886 if (mutex_lock_interruptible(&tty
->atomic_write_lock
))
893 * Split writes up in sane blocksizes to avoid
894 * denial-of-service type attacks
896 static inline ssize_t
do_tty_write(
897 ssize_t (*write
)(struct tty_struct
*, struct file
*, const unsigned char *, size_t),
898 struct tty_struct
*tty
,
900 const char __user
*buf
,
903 ssize_t ret
, written
= 0;
906 ret
= tty_write_lock(tty
, file
->f_flags
& O_NDELAY
);
911 * We chunk up writes into a temporary buffer. This
912 * simplifies low-level drivers immensely, since they
913 * don't have locking issues and user mode accesses.
915 * But if TTY_NO_WRITE_SPLIT is set, we should use a
918 * The default chunk-size is 2kB, because the NTTY
919 * layer has problems with bigger chunks. It will
920 * claim to be able to handle more characters than
923 * FIXME: This can probably go away now except that 64K chunks
924 * are too likely to fail unless switched to vmalloc...
927 if (test_bit(TTY_NO_WRITE_SPLIT
, &tty
->flags
))
932 /* write_buf/write_cnt is protected by the atomic_write_lock mutex */
933 if (tty
->write_cnt
< chunk
) {
934 unsigned char *buf_chunk
;
939 buf_chunk
= kmalloc(chunk
, GFP_KERNEL
);
944 kfree(tty
->write_buf
);
945 tty
->write_cnt
= chunk
;
946 tty
->write_buf
= buf_chunk
;
949 /* Do the write .. */
955 if (copy_from_user(tty
->write_buf
, buf
, size
))
957 ret
= write(tty
, file
, tty
->write_buf
, size
);
966 if (signal_pending(current
))
971 tty_update_time(&file_inode(file
)->i_mtime
);
975 tty_write_unlock(tty
);
980 * tty_write_message - write a message to a certain tty, not just the console.
981 * @tty: the destination tty_struct
982 * @msg: the message to write
984 * This is used for messages that need to be redirected to a specific tty.
985 * We don't put it into the syslog queue right now maybe in the future if
988 * We must still hold the BTM and test the CLOSING flag for the moment.
991 void tty_write_message(struct tty_struct
*tty
, char *msg
)
994 mutex_lock(&tty
->atomic_write_lock
);
996 if (tty
->ops
->write
&& tty
->count
> 0)
997 tty
->ops
->write(tty
, msg
, strlen(msg
));
999 tty_write_unlock(tty
);
1006 * tty_write - write method for tty device file
1007 * @file: tty file pointer
1008 * @buf: user data to write
1009 * @count: bytes to write
1012 * Write data to a tty device via the line discipline.
1015 * Locks the line discipline as required
1016 * Writes to the tty driver are serialized by the atomic_write_lock
1017 * and are then processed in chunks to the device. The line discipline
1018 * write method will not be invoked in parallel for each device.
1021 static ssize_t
tty_write(struct file
*file
, const char __user
*buf
,
1022 size_t count
, loff_t
*ppos
)
1024 struct tty_struct
*tty
= file_tty(file
);
1025 struct tty_ldisc
*ld
;
1028 if (tty_paranoia_check(tty
, file_inode(file
), "tty_write"))
1030 if (!tty
|| !tty
->ops
->write
|| tty_io_error(tty
))
1032 /* Short term debug to catch buggy drivers */
1033 if (tty
->ops
->write_room
== NULL
)
1034 tty_err(tty
, "missing write_room method\n");
1035 ld
= tty_ldisc_ref_wait(tty
);
1037 return hung_up_tty_write(file
, buf
, count
, ppos
);
1038 if (!ld
->ops
->write
)
1041 ret
= do_tty_write(ld
->ops
->write
, tty
, file
, buf
, count
);
1042 tty_ldisc_deref(ld
);
1046 ssize_t
redirected_tty_write(struct file
*file
, const char __user
*buf
,
1047 size_t count
, loff_t
*ppos
)
1049 struct file
*p
= NULL
;
1051 spin_lock(&redirect_lock
);
1053 p
= get_file(redirect
);
1054 spin_unlock(&redirect_lock
);
1058 res
= vfs_write(p
, buf
, count
, &p
->f_pos
);
1062 return tty_write(file
, buf
, count
, ppos
);
1066 * tty_send_xchar - send priority character
1068 * Send a high priority character to the tty even if stopped
1070 * Locking: none for xchar method, write ordering for write method.
1073 int tty_send_xchar(struct tty_struct
*tty
, char ch
)
1075 int was_stopped
= tty
->stopped
;
1077 if (tty
->ops
->send_xchar
) {
1078 down_read(&tty
->termios_rwsem
);
1079 tty
->ops
->send_xchar(tty
, ch
);
1080 up_read(&tty
->termios_rwsem
);
1084 if (tty_write_lock(tty
, 0) < 0)
1085 return -ERESTARTSYS
;
1087 down_read(&tty
->termios_rwsem
);
1090 tty
->ops
->write(tty
, &ch
, 1);
1093 up_read(&tty
->termios_rwsem
);
1094 tty_write_unlock(tty
);
1098 static char ptychar
[] = "pqrstuvwxyzabcde";
1101 * pty_line_name - generate name for a pty
1102 * @driver: the tty driver in use
1103 * @index: the minor number
1104 * @p: output buffer of at least 6 bytes
1106 * Generate a name from a driver reference and write it to the output
1111 static void pty_line_name(struct tty_driver
*driver
, int index
, char *p
)
1113 int i
= index
+ driver
->name_base
;
1114 /* ->name is initialized to "ttyp", but "tty" is expected */
1115 sprintf(p
, "%s%c%x",
1116 driver
->subtype
== PTY_TYPE_SLAVE
? "tty" : driver
->name
,
1117 ptychar
[i
>> 4 & 0xf], i
& 0xf);
1121 * tty_line_name - generate name for a tty
1122 * @driver: the tty driver in use
1123 * @index: the minor number
1124 * @p: output buffer of at least 7 bytes
1126 * Generate a name from a driver reference and write it to the output
1131 static ssize_t
tty_line_name(struct tty_driver
*driver
, int index
, char *p
)
1133 if (driver
->flags
& TTY_DRIVER_UNNUMBERED_NODE
)
1134 return sprintf(p
, "%s", driver
->name
);
1136 return sprintf(p
, "%s%d", driver
->name
,
1137 index
+ driver
->name_base
);
1141 * tty_driver_lookup_tty() - find an existing tty, if any
1142 * @driver: the driver for the tty
1143 * @idx: the minor number
1145 * Return the tty, if found. If not found, return NULL or ERR_PTR() if the
1146 * driver lookup() method returns an error.
1148 * Locking: tty_mutex must be held. If the tty is found, bump the tty kref.
1150 static struct tty_struct
*tty_driver_lookup_tty(struct tty_driver
*driver
,
1151 struct file
*file
, int idx
)
1153 struct tty_struct
*tty
;
1155 if (driver
->ops
->lookup
)
1157 tty
= ERR_PTR(-EIO
);
1159 tty
= driver
->ops
->lookup(driver
, file
, idx
);
1161 tty
= driver
->ttys
[idx
];
1169 * tty_init_termios - helper for termios setup
1170 * @tty: the tty to set up
1172 * Initialise the termios structures for this tty. Thus runs under
1173 * the tty_mutex currently so we can be relaxed about ordering.
1176 void tty_init_termios(struct tty_struct
*tty
)
1178 struct ktermios
*tp
;
1179 int idx
= tty
->index
;
1181 if (tty
->driver
->flags
& TTY_DRIVER_RESET_TERMIOS
)
1182 tty
->termios
= tty
->driver
->init_termios
;
1184 /* Check for lazy saved data */
1185 tp
= tty
->driver
->termios
[idx
];
1188 tty
->termios
.c_line
= tty
->driver
->init_termios
.c_line
;
1190 tty
->termios
= tty
->driver
->init_termios
;
1192 /* Compatibility until drivers always set this */
1193 tty
->termios
.c_ispeed
= tty_termios_input_baud_rate(&tty
->termios
);
1194 tty
->termios
.c_ospeed
= tty_termios_baud_rate(&tty
->termios
);
1196 EXPORT_SYMBOL_GPL(tty_init_termios
);
1198 int tty_standard_install(struct tty_driver
*driver
, struct tty_struct
*tty
)
1200 tty_init_termios(tty
);
1201 tty_driver_kref_get(driver
);
1203 driver
->ttys
[tty
->index
] = tty
;
1206 EXPORT_SYMBOL_GPL(tty_standard_install
);
1209 * tty_driver_install_tty() - install a tty entry in the driver
1210 * @driver: the driver for the tty
1213 * Install a tty object into the driver tables. The tty->index field
1214 * will be set by the time this is called. This method is responsible
1215 * for ensuring any need additional structures are allocated and
1218 * Locking: tty_mutex for now
1220 static int tty_driver_install_tty(struct tty_driver
*driver
,
1221 struct tty_struct
*tty
)
1223 return driver
->ops
->install
? driver
->ops
->install(driver
, tty
) :
1224 tty_standard_install(driver
, tty
);
1228 * tty_driver_remove_tty() - remove a tty from the driver tables
1229 * @driver: the driver for the tty
1230 * @idx: the minor number
1232 * Remvoe a tty object from the driver tables. The tty->index field
1233 * will be set by the time this is called.
1235 * Locking: tty_mutex for now
1237 static void tty_driver_remove_tty(struct tty_driver
*driver
, struct tty_struct
*tty
)
1239 if (driver
->ops
->remove
)
1240 driver
->ops
->remove(driver
, tty
);
1242 driver
->ttys
[tty
->index
] = NULL
;
1246 * tty_reopen() - fast re-open of an open tty
1247 * @tty - the tty to open
1249 * Return 0 on success, -errno on error.
1250 * Re-opens on master ptys are not allowed and return -EIO.
1252 * Locking: Caller must hold tty_lock
1254 static int tty_reopen(struct tty_struct
*tty
)
1256 struct tty_driver
*driver
= tty
->driver
;
1258 if (driver
->type
== TTY_DRIVER_TYPE_PTY
&&
1259 driver
->subtype
== PTY_TYPE_MASTER
)
1265 if (test_bit(TTY_EXCLUSIVE
, &tty
->flags
) && !capable(CAP_SYS_ADMIN
))
1271 return tty_ldisc_reinit(tty
, tty
->termios
.c_line
);
1277 * tty_init_dev - initialise a tty device
1278 * @driver: tty driver we are opening a device on
1279 * @idx: device index
1280 * @ret_tty: returned tty structure
1282 * Prepare a tty device. This may not be a "new" clean device but
1283 * could also be an active device. The pty drivers require special
1284 * handling because of this.
1287 * The function is called under the tty_mutex, which
1288 * protects us from the tty struct or driver itself going away.
1290 * On exit the tty device has the line discipline attached and
1291 * a reference count of 1. If a pair was created for pty/tty use
1292 * and the other was a pty master then it too has a reference count of 1.
1294 * WSH 06/09/97: Rewritten to remove races and properly clean up after a
1295 * failed open. The new code protects the open with a mutex, so it's
1296 * really quite straightforward. The mutex locking can probably be
1297 * relaxed for the (most common) case of reopening a tty.
1300 struct tty_struct
*tty_init_dev(struct tty_driver
*driver
, int idx
)
1302 struct tty_struct
*tty
;
1306 * First time open is complex, especially for PTY devices.
1307 * This code guarantees that either everything succeeds and the
1308 * TTY is ready for operation, or else the table slots are vacated
1309 * and the allocated memory released. (Except that the termios
1313 if (!try_module_get(driver
->owner
))
1314 return ERR_PTR(-ENODEV
);
1316 tty
= alloc_tty_struct(driver
, idx
);
1319 goto err_module_put
;
1323 retval
= tty_driver_install_tty(driver
, tty
);
1328 tty
->port
= driver
->ports
[idx
];
1330 WARN_RATELIMIT(!tty
->port
,
1331 "%s: %s driver does not set tty->port. This will crash the kernel later. Fix the driver!\n",
1332 __func__
, tty
->driver
->name
);
1334 retval
= tty_ldisc_lock(tty
, 5 * HZ
);
1336 goto err_release_lock
;
1337 tty
->port
->itty
= tty
;
1340 * Structures all installed ... call the ldisc open routines.
1341 * If we fail here just call release_tty to clean up. No need
1342 * to decrement the use counts, as release_tty doesn't care.
1344 retval
= tty_ldisc_setup(tty
, tty
->link
);
1346 goto err_release_tty
;
1347 tty_ldisc_unlock(tty
);
1348 /* Return the tty locked so that it cannot vanish under the caller */
1353 free_tty_struct(tty
);
1355 module_put(driver
->owner
);
1356 return ERR_PTR(retval
);
1358 /* call the tty release_tty routine to clean out this slot */
1360 tty_ldisc_unlock(tty
);
1361 tty_info_ratelimited(tty
, "ldisc open failed (%d), clearing slot %d\n",
1365 release_tty(tty
, idx
);
1366 return ERR_PTR(retval
);
1369 static void tty_free_termios(struct tty_struct
*tty
)
1371 struct ktermios
*tp
;
1372 int idx
= tty
->index
;
1374 /* If the port is going to reset then it has no termios to save */
1375 if (tty
->driver
->flags
& TTY_DRIVER_RESET_TERMIOS
)
1378 /* Stash the termios data */
1379 tp
= tty
->driver
->termios
[idx
];
1381 tp
= kmalloc(sizeof(struct ktermios
), GFP_KERNEL
);
1384 tty
->driver
->termios
[idx
] = tp
;
1390 * tty_flush_works - flush all works of a tty/pty pair
1391 * @tty: tty device to flush works for (or either end of a pty pair)
1393 * Sync flush all works belonging to @tty (and the 'other' tty).
1395 static void tty_flush_works(struct tty_struct
*tty
)
1397 flush_work(&tty
->SAK_work
);
1398 flush_work(&tty
->hangup_work
);
1400 flush_work(&tty
->link
->SAK_work
);
1401 flush_work(&tty
->link
->hangup_work
);
1406 * release_one_tty - release tty structure memory
1407 * @kref: kref of tty we are obliterating
1409 * Releases memory associated with a tty structure, and clears out the
1410 * driver table slots. This function is called when a device is no longer
1411 * in use. It also gets called when setup of a device fails.
1414 * takes the file list lock internally when working on the list
1415 * of ttys that the driver keeps.
1417 * This method gets called from a work queue so that the driver private
1418 * cleanup ops can sleep (needed for USB at least)
1420 static void release_one_tty(struct work_struct
*work
)
1422 struct tty_struct
*tty
=
1423 container_of(work
, struct tty_struct
, hangup_work
);
1424 struct tty_driver
*driver
= tty
->driver
;
1425 struct module
*owner
= driver
->owner
;
1427 if (tty
->ops
->cleanup
)
1428 tty
->ops
->cleanup(tty
);
1431 tty_driver_kref_put(driver
);
1434 spin_lock(&tty
->files_lock
);
1435 list_del_init(&tty
->tty_files
);
1436 spin_unlock(&tty
->files_lock
);
1439 put_pid(tty
->session
);
1440 free_tty_struct(tty
);
1443 static void queue_release_one_tty(struct kref
*kref
)
1445 struct tty_struct
*tty
= container_of(kref
, struct tty_struct
, kref
);
1447 /* The hangup queue is now free so we can reuse it rather than
1448 waste a chunk of memory for each port */
1449 INIT_WORK(&tty
->hangup_work
, release_one_tty
);
1450 schedule_work(&tty
->hangup_work
);
1454 * tty_kref_put - release a tty kref
1457 * Release a reference to a tty device and if need be let the kref
1458 * layer destruct the object for us
1461 void tty_kref_put(struct tty_struct
*tty
)
1464 kref_put(&tty
->kref
, queue_release_one_tty
);
1466 EXPORT_SYMBOL(tty_kref_put
);
1469 * release_tty - release tty structure memory
1471 * Release both @tty and a possible linked partner (think pty pair),
1472 * and decrement the refcount of the backing module.
1476 * takes the file list lock internally when working on the list
1477 * of ttys that the driver keeps.
1480 static void release_tty(struct tty_struct
*tty
, int idx
)
1482 /* This should always be true but check for the moment */
1483 WARN_ON(tty
->index
!= idx
);
1484 WARN_ON(!mutex_is_locked(&tty_mutex
));
1485 if (tty
->ops
->shutdown
)
1486 tty
->ops
->shutdown(tty
);
1487 tty_free_termios(tty
);
1488 tty_driver_remove_tty(tty
->driver
, tty
);
1489 tty
->port
->itty
= NULL
;
1491 tty
->link
->port
->itty
= NULL
;
1492 tty_buffer_cancel_work(tty
->port
);
1494 tty_buffer_cancel_work(tty
->link
->port
);
1496 tty_kref_put(tty
->link
);
1501 * tty_release_checks - check a tty before real release
1502 * @tty: tty to check
1503 * @o_tty: link of @tty (if any)
1504 * @idx: index of the tty
1506 * Performs some paranoid checking before true release of the @tty.
1507 * This is a no-op unless TTY_PARANOIA_CHECK is defined.
1509 static int tty_release_checks(struct tty_struct
*tty
, int idx
)
1511 #ifdef TTY_PARANOIA_CHECK
1512 if (idx
< 0 || idx
>= tty
->driver
->num
) {
1513 tty_debug(tty
, "bad idx %d\n", idx
);
1517 /* not much to check for devpts */
1518 if (tty
->driver
->flags
& TTY_DRIVER_DEVPTS_MEM
)
1521 if (tty
!= tty
->driver
->ttys
[idx
]) {
1522 tty_debug(tty
, "bad driver table[%d] = %p\n",
1523 idx
, tty
->driver
->ttys
[idx
]);
1526 if (tty
->driver
->other
) {
1527 struct tty_struct
*o_tty
= tty
->link
;
1529 if (o_tty
!= tty
->driver
->other
->ttys
[idx
]) {
1530 tty_debug(tty
, "bad other table[%d] = %p\n",
1531 idx
, tty
->driver
->other
->ttys
[idx
]);
1534 if (o_tty
->link
!= tty
) {
1535 tty_debug(tty
, "bad link = %p\n", o_tty
->link
);
1544 * tty_kclose - closes tty opened by tty_kopen
1547 * Performs the final steps to release and free a tty device. It is the
1548 * same as tty_release_struct except that it also resets TTY_PORT_KOPENED
1549 * flag on tty->port.
1551 void tty_kclose(struct tty_struct
*tty
)
1554 * Ask the line discipline code to release its structures
1556 tty_ldisc_release(tty
);
1558 /* Wait for pending work before tty destruction commmences */
1559 tty_flush_works(tty
);
1561 tty_debug_hangup(tty
, "freeing structure\n");
1563 * The release_tty function takes care of the details of clearing
1564 * the slots and preserving the termios structure. The tty_unlock_pair
1565 * should be safe as we keep a kref while the tty is locked (so the
1566 * unlock never unlocks a freed tty).
1568 mutex_lock(&tty_mutex
);
1569 tty_port_set_kopened(tty
->port
, 0);
1570 release_tty(tty
, tty
->index
);
1571 mutex_unlock(&tty_mutex
);
1573 EXPORT_SYMBOL_GPL(tty_kclose
);
1576 * tty_release_struct - release a tty struct
1578 * @idx: index of the tty
1580 * Performs the final steps to release and free a tty device. It is
1581 * roughly the reverse of tty_init_dev.
1583 void tty_release_struct(struct tty_struct
*tty
, int idx
)
1586 * Ask the line discipline code to release its structures
1588 tty_ldisc_release(tty
);
1590 /* Wait for pending work before tty destruction commmences */
1591 tty_flush_works(tty
);
1593 tty_debug_hangup(tty
, "freeing structure\n");
1595 * The release_tty function takes care of the details of clearing
1596 * the slots and preserving the termios structure. The tty_unlock_pair
1597 * should be safe as we keep a kref while the tty is locked (so the
1598 * unlock never unlocks a freed tty).
1600 mutex_lock(&tty_mutex
);
1601 release_tty(tty
, idx
);
1602 mutex_unlock(&tty_mutex
);
1604 EXPORT_SYMBOL_GPL(tty_release_struct
);
1607 * tty_release - vfs callback for close
1608 * @inode: inode of tty
1609 * @filp: file pointer for handle to tty
1611 * Called the last time each file handle is closed that references
1612 * this tty. There may however be several such references.
1615 * Takes bkl. See tty_release_dev
1617 * Even releasing the tty structures is a tricky business.. We have
1618 * to be very careful that the structures are all released at the
1619 * same time, as interrupts might otherwise get the wrong pointers.
1621 * WSH 09/09/97: rewritten to avoid some nasty race conditions that could
1622 * lead to double frees or releasing memory still in use.
1625 int tty_release(struct inode
*inode
, struct file
*filp
)
1627 struct tty_struct
*tty
= file_tty(filp
);
1628 struct tty_struct
*o_tty
= NULL
;
1629 int do_sleep
, final
;
1634 if (tty_paranoia_check(tty
, inode
, __func__
))
1638 check_tty_count(tty
, __func__
);
1640 __tty_fasync(-1, filp
, 0);
1643 if (tty
->driver
->type
== TTY_DRIVER_TYPE_PTY
&&
1644 tty
->driver
->subtype
== PTY_TYPE_MASTER
)
1647 if (tty_release_checks(tty
, idx
)) {
1652 tty_debug_hangup(tty
, "releasing (count=%d)\n", tty
->count
);
1654 if (tty
->ops
->close
)
1655 tty
->ops
->close(tty
, filp
);
1657 /* If tty is pty master, lock the slave pty (stable lock order) */
1658 tty_lock_slave(o_tty
);
1661 * Sanity check: if tty->count is going to zero, there shouldn't be
1662 * any waiters on tty->read_wait or tty->write_wait. We test the
1663 * wait queues and kick everyone out _before_ actually starting to
1664 * close. This ensures that we won't block while releasing the tty
1667 * The test for the o_tty closing is necessary, since the master and
1668 * slave sides may close in any order. If the slave side closes out
1669 * first, its count will be one, since the master side holds an open.
1670 * Thus this test wouldn't be triggered at the time the slave closed,
1676 if (tty
->count
<= 1) {
1677 if (waitqueue_active(&tty
->read_wait
)) {
1678 wake_up_poll(&tty
->read_wait
, POLLIN
);
1681 if (waitqueue_active(&tty
->write_wait
)) {
1682 wake_up_poll(&tty
->write_wait
, POLLOUT
);
1686 if (o_tty
&& o_tty
->count
<= 1) {
1687 if (waitqueue_active(&o_tty
->read_wait
)) {
1688 wake_up_poll(&o_tty
->read_wait
, POLLIN
);
1691 if (waitqueue_active(&o_tty
->write_wait
)) {
1692 wake_up_poll(&o_tty
->write_wait
, POLLOUT
);
1701 tty_warn(tty
, "read/write wait queue active!\n");
1703 schedule_timeout_killable(timeout
);
1704 if (timeout
< 120 * HZ
)
1705 timeout
= 2 * timeout
+ 1;
1707 timeout
= MAX_SCHEDULE_TIMEOUT
;
1711 if (--o_tty
->count
< 0) {
1712 tty_warn(tty
, "bad slave count (%d)\n", o_tty
->count
);
1716 if (--tty
->count
< 0) {
1717 tty_warn(tty
, "bad tty->count (%d)\n", tty
->count
);
1722 * We've decremented tty->count, so we need to remove this file
1723 * descriptor off the tty->tty_files list; this serves two
1725 * - check_tty_count sees the correct number of file descriptors
1726 * associated with this tty.
1727 * - do_tty_hangup no longer sees this file descriptor as
1728 * something that needs to be handled for hangups.
1733 * Perform some housekeeping before deciding whether to return.
1735 * If _either_ side is closing, make sure there aren't any
1736 * processes that still think tty or o_tty is their controlling
1740 read_lock(&tasklist_lock
);
1741 session_clear_tty(tty
->session
);
1743 session_clear_tty(o_tty
->session
);
1744 read_unlock(&tasklist_lock
);
1747 /* check whether both sides are closing ... */
1748 final
= !tty
->count
&& !(o_tty
&& o_tty
->count
);
1750 tty_unlock_slave(o_tty
);
1753 /* At this point, the tty->count == 0 should ensure a dead tty
1754 cannot be re-opened by a racing opener */
1759 tty_debug_hangup(tty
, "final close\n");
1761 tty_release_struct(tty
, idx
);
1766 * tty_open_current_tty - get locked tty of current task
1767 * @device: device number
1768 * @filp: file pointer to tty
1769 * @return: locked tty of the current task iff @device is /dev/tty
1771 * Performs a re-open of the current task's controlling tty.
1773 * We cannot return driver and index like for the other nodes because
1774 * devpts will not work then. It expects inodes to be from devpts FS.
1776 static struct tty_struct
*tty_open_current_tty(dev_t device
, struct file
*filp
)
1778 struct tty_struct
*tty
;
1781 if (device
!= MKDEV(TTYAUX_MAJOR
, 0))
1784 tty
= get_current_tty();
1786 return ERR_PTR(-ENXIO
);
1788 filp
->f_flags
|= O_NONBLOCK
; /* Don't let /dev/tty block */
1791 tty_kref_put(tty
); /* safe to drop the kref now */
1793 retval
= tty_reopen(tty
);
1796 tty
= ERR_PTR(retval
);
1802 * tty_lookup_driver - lookup a tty driver for a given device file
1803 * @device: device number
1804 * @filp: file pointer to tty
1805 * @index: index for the device in the @return driver
1806 * @return: driver for this inode (with increased refcount)
1808 * If @return is not erroneous, the caller is responsible to decrement the
1809 * refcount by tty_driver_kref_put.
1811 * Locking: tty_mutex protects get_tty_driver
1813 static struct tty_driver
*tty_lookup_driver(dev_t device
, struct file
*filp
,
1816 struct tty_driver
*driver
;
1820 case MKDEV(TTY_MAJOR
, 0): {
1821 extern struct tty_driver
*console_driver
;
1822 driver
= tty_driver_kref_get(console_driver
);
1823 *index
= fg_console
;
1827 case MKDEV(TTYAUX_MAJOR
, 1): {
1828 struct tty_driver
*console_driver
= console_device(index
);
1829 if (console_driver
) {
1830 driver
= tty_driver_kref_get(console_driver
);
1831 if (driver
&& filp
) {
1832 /* Don't let /dev/console block */
1833 filp
->f_flags
|= O_NONBLOCK
;
1837 return ERR_PTR(-ENODEV
);
1840 driver
= get_tty_driver(device
, index
);
1842 return ERR_PTR(-ENODEV
);
1849 * tty_kopen - open a tty device for kernel
1850 * @device: dev_t of device to open
1852 * Opens tty exclusively for kernel. Performs the driver lookup,
1853 * makes sure it's not already opened and performs the first-time
1854 * tty initialization.
1856 * Returns the locked initialized &tty_struct
1858 * Claims the global tty_mutex to serialize:
1859 * - concurrent first-time tty initialization
1860 * - concurrent tty driver removal w/ lookup
1861 * - concurrent tty removal from driver table
1863 struct tty_struct
*tty_kopen(dev_t device
)
1865 struct tty_struct
*tty
;
1866 struct tty_driver
*driver
= NULL
;
1869 mutex_lock(&tty_mutex
);
1870 driver
= tty_lookup_driver(device
, NULL
, &index
);
1871 if (IS_ERR(driver
)) {
1872 mutex_unlock(&tty_mutex
);
1873 return ERR_CAST(driver
);
1876 /* check whether we're reopening an existing tty */
1877 tty
= tty_driver_lookup_tty(driver
, NULL
, index
);
1882 /* drop kref from tty_driver_lookup_tty() */
1884 tty
= ERR_PTR(-EBUSY
);
1885 } else { /* tty_init_dev returns tty with the tty_lock held */
1886 tty
= tty_init_dev(driver
, index
);
1889 tty_port_set_kopened(tty
->port
, 1);
1892 mutex_unlock(&tty_mutex
);
1893 tty_driver_kref_put(driver
);
1896 EXPORT_SYMBOL_GPL(tty_kopen
);
1899 * tty_open_by_driver - open a tty device
1900 * @device: dev_t of device to open
1901 * @inode: inode of device file
1902 * @filp: file pointer to tty
1904 * Performs the driver lookup, checks for a reopen, or otherwise
1905 * performs the first-time tty initialization.
1907 * Returns the locked initialized or re-opened &tty_struct
1909 * Claims the global tty_mutex to serialize:
1910 * - concurrent first-time tty initialization
1911 * - concurrent tty driver removal w/ lookup
1912 * - concurrent tty removal from driver table
1914 static struct tty_struct
*tty_open_by_driver(dev_t device
, struct inode
*inode
,
1917 struct tty_struct
*tty
;
1918 struct tty_driver
*driver
= NULL
;
1922 mutex_lock(&tty_mutex
);
1923 driver
= tty_lookup_driver(device
, filp
, &index
);
1924 if (IS_ERR(driver
)) {
1925 mutex_unlock(&tty_mutex
);
1926 return ERR_CAST(driver
);
1929 /* check whether we're reopening an existing tty */
1930 tty
= tty_driver_lookup_tty(driver
, filp
, index
);
1932 mutex_unlock(&tty_mutex
);
1937 if (tty_port_kopened(tty
->port
)) {
1939 mutex_unlock(&tty_mutex
);
1940 tty
= ERR_PTR(-EBUSY
);
1943 mutex_unlock(&tty_mutex
);
1944 retval
= tty_lock_interruptible(tty
);
1945 tty_kref_put(tty
); /* drop kref from tty_driver_lookup_tty() */
1947 if (retval
== -EINTR
)
1948 retval
= -ERESTARTSYS
;
1949 tty
= ERR_PTR(retval
);
1952 retval
= tty_reopen(tty
);
1955 tty
= ERR_PTR(retval
);
1957 } else { /* Returns with the tty_lock held for now */
1958 tty
= tty_init_dev(driver
, index
);
1959 mutex_unlock(&tty_mutex
);
1962 tty_driver_kref_put(driver
);
1967 * tty_open - open a tty device
1968 * @inode: inode of device file
1969 * @filp: file pointer to tty
1971 * tty_open and tty_release keep up the tty count that contains the
1972 * number of opens done on a tty. We cannot use the inode-count, as
1973 * different inodes might point to the same tty.
1975 * Open-counting is needed for pty masters, as well as for keeping
1976 * track of serial lines: DTR is dropped when the last close happens.
1977 * (This is not done solely through tty->count, now. - Ted 1/27/92)
1979 * The termios state of a pty is reset on first open so that
1980 * settings don't persist across reuse.
1982 * Locking: tty_mutex protects tty, tty_lookup_driver and tty_init_dev.
1983 * tty->count should protect the rest.
1984 * ->siglock protects ->signal/->sighand
1986 * Note: the tty_unlock/lock cases without a ref are only safe due to
1990 static int tty_open(struct inode
*inode
, struct file
*filp
)
1992 struct tty_struct
*tty
;
1994 dev_t device
= inode
->i_rdev
;
1995 unsigned saved_flags
= filp
->f_flags
;
1997 nonseekable_open(inode
, filp
);
2000 retval
= tty_alloc_file(filp
);
2004 tty
= tty_open_current_tty(device
, filp
);
2006 tty
= tty_open_by_driver(device
, inode
, filp
);
2009 tty_free_file(filp
);
2010 retval
= PTR_ERR(tty
);
2011 if (retval
!= -EAGAIN
|| signal_pending(current
))
2017 tty_add_file(tty
, filp
);
2019 check_tty_count(tty
, __func__
);
2020 tty_debug_hangup(tty
, "opening (count=%d)\n", tty
->count
);
2023 retval
= tty
->ops
->open(tty
, filp
);
2026 filp
->f_flags
= saved_flags
;
2029 tty_debug_hangup(tty
, "open error %d, releasing\n", retval
);
2031 tty_unlock(tty
); /* need to call tty_release without BTM */
2032 tty_release(inode
, filp
);
2033 if (retval
!= -ERESTARTSYS
)
2036 if (signal_pending(current
))
2041 * Need to reset f_op in case a hangup happened.
2043 if (tty_hung_up_p(filp
))
2044 filp
->f_op
= &tty_fops
;
2047 clear_bit(TTY_HUPPED
, &tty
->flags
);
2049 noctty
= (filp
->f_flags
& O_NOCTTY
) ||
2050 (IS_ENABLED(CONFIG_VT
) && device
== MKDEV(TTY_MAJOR
, 0)) ||
2051 device
== MKDEV(TTYAUX_MAJOR
, 1) ||
2052 (tty
->driver
->type
== TTY_DRIVER_TYPE_PTY
&&
2053 tty
->driver
->subtype
== PTY_TYPE_MASTER
);
2055 tty_open_proc_set_tty(filp
, tty
);
2063 * tty_poll - check tty status
2064 * @filp: file being polled
2065 * @wait: poll wait structures to update
2067 * Call the line discipline polling method to obtain the poll
2068 * status of the device.
2070 * Locking: locks called line discipline but ldisc poll method
2071 * may be re-entered freely by other callers.
2074 static unsigned int tty_poll(struct file
*filp
, poll_table
*wait
)
2076 struct tty_struct
*tty
= file_tty(filp
);
2077 struct tty_ldisc
*ld
;
2080 if (tty_paranoia_check(tty
, file_inode(filp
), "tty_poll"))
2083 ld
= tty_ldisc_ref_wait(tty
);
2085 return hung_up_tty_poll(filp
, wait
);
2087 ret
= ld
->ops
->poll(tty
, filp
, wait
);
2088 tty_ldisc_deref(ld
);
2092 static int __tty_fasync(int fd
, struct file
*filp
, int on
)
2094 struct tty_struct
*tty
= file_tty(filp
);
2095 unsigned long flags
;
2098 if (tty_paranoia_check(tty
, file_inode(filp
), "tty_fasync"))
2101 retval
= fasync_helper(fd
, filp
, on
, &tty
->fasync
);
2109 spin_lock_irqsave(&tty
->ctrl_lock
, flags
);
2112 type
= PIDTYPE_PGID
;
2114 pid
= task_pid(current
);
2118 spin_unlock_irqrestore(&tty
->ctrl_lock
, flags
);
2119 __f_setown(filp
, pid
, type
, 0);
2127 static int tty_fasync(int fd
, struct file
*filp
, int on
)
2129 struct tty_struct
*tty
= file_tty(filp
);
2130 int retval
= -ENOTTY
;
2133 if (!tty_hung_up_p(filp
))
2134 retval
= __tty_fasync(fd
, filp
, on
);
2141 * tiocsti - fake input character
2142 * @tty: tty to fake input into
2143 * @p: pointer to character
2145 * Fake input to a tty device. Does the necessary locking and
2148 * FIXME: does not honour flow control ??
2151 * Called functions take tty_ldiscs_lock
2152 * current->signal->tty check is safe without locks
2154 * FIXME: may race normal receive processing
2157 static int tiocsti(struct tty_struct
*tty
, char __user
*p
)
2160 struct tty_ldisc
*ld
;
2162 if ((current
->signal
->tty
!= tty
) && !capable(CAP_SYS_ADMIN
))
2164 if (get_user(ch
, p
))
2166 tty_audit_tiocsti(tty
, ch
);
2167 ld
= tty_ldisc_ref_wait(tty
);
2170 ld
->ops
->receive_buf(tty
, &ch
, &mbz
, 1);
2171 tty_ldisc_deref(ld
);
2176 * tiocgwinsz - implement window query ioctl
2178 * @arg: user buffer for result
2180 * Copies the kernel idea of the window size into the user buffer.
2182 * Locking: tty->winsize_mutex is taken to ensure the winsize data
2186 static int tiocgwinsz(struct tty_struct
*tty
, struct winsize __user
*arg
)
2190 mutex_lock(&tty
->winsize_mutex
);
2191 err
= copy_to_user(arg
, &tty
->winsize
, sizeof(*arg
));
2192 mutex_unlock(&tty
->winsize_mutex
);
2194 return err
? -EFAULT
: 0;
2198 * tty_do_resize - resize event
2199 * @tty: tty being resized
2200 * @rows: rows (character)
2201 * @cols: cols (character)
2203 * Update the termios variables and send the necessary signals to
2204 * peform a terminal resize correctly
2207 int tty_do_resize(struct tty_struct
*tty
, struct winsize
*ws
)
2212 mutex_lock(&tty
->winsize_mutex
);
2213 if (!memcmp(ws
, &tty
->winsize
, sizeof(*ws
)))
2216 /* Signal the foreground process group */
2217 pgrp
= tty_get_pgrp(tty
);
2219 kill_pgrp(pgrp
, SIGWINCH
, 1);
2224 mutex_unlock(&tty
->winsize_mutex
);
2227 EXPORT_SYMBOL(tty_do_resize
);
2230 * tiocswinsz - implement window size set ioctl
2231 * @tty; tty side of tty
2232 * @arg: user buffer for result
2234 * Copies the user idea of the window size to the kernel. Traditionally
2235 * this is just advisory information but for the Linux console it
2236 * actually has driver level meaning and triggers a VC resize.
2239 * Driver dependent. The default do_resize method takes the
2240 * tty termios mutex and ctrl_lock. The console takes its own lock
2241 * then calls into the default method.
2244 static int tiocswinsz(struct tty_struct
*tty
, struct winsize __user
*arg
)
2246 struct winsize tmp_ws
;
2247 if (copy_from_user(&tmp_ws
, arg
, sizeof(*arg
)))
2250 if (tty
->ops
->resize
)
2251 return tty
->ops
->resize(tty
, &tmp_ws
);
2253 return tty_do_resize(tty
, &tmp_ws
);
2257 * tioccons - allow admin to move logical console
2258 * @file: the file to become console
2260 * Allow the administrator to move the redirected console device
2262 * Locking: uses redirect_lock to guard the redirect information
2265 static int tioccons(struct file
*file
)
2267 if (!capable(CAP_SYS_ADMIN
))
2269 if (file
->f_op
->write
== redirected_tty_write
) {
2271 spin_lock(&redirect_lock
);
2274 spin_unlock(&redirect_lock
);
2279 spin_lock(&redirect_lock
);
2281 spin_unlock(&redirect_lock
);
2284 redirect
= get_file(file
);
2285 spin_unlock(&redirect_lock
);
2290 * fionbio - non blocking ioctl
2291 * @file: file to set blocking value
2292 * @p: user parameter
2294 * Historical tty interfaces had a blocking control ioctl before
2295 * the generic functionality existed. This piece of history is preserved
2296 * in the expected tty API of posix OS's.
2298 * Locking: none, the open file handle ensures it won't go away.
2301 static int fionbio(struct file
*file
, int __user
*p
)
2305 if (get_user(nonblock
, p
))
2308 spin_lock(&file
->f_lock
);
2310 file
->f_flags
|= O_NONBLOCK
;
2312 file
->f_flags
&= ~O_NONBLOCK
;
2313 spin_unlock(&file
->f_lock
);
2318 * tiocsetd - set line discipline
2320 * @p: pointer to user data
2322 * Set the line discipline according to user request.
2324 * Locking: see tty_set_ldisc, this function is just a helper
2327 static int tiocsetd(struct tty_struct
*tty
, int __user
*p
)
2332 if (get_user(disc
, p
))
2335 ret
= tty_set_ldisc(tty
, disc
);
2341 * tiocgetd - get line discipline
2343 * @p: pointer to user data
2345 * Retrieves the line discipline id directly from the ldisc.
2347 * Locking: waits for ldisc reference (in case the line discipline
2348 * is changing or the tty is being hungup)
2351 static int tiocgetd(struct tty_struct
*tty
, int __user
*p
)
2353 struct tty_ldisc
*ld
;
2356 ld
= tty_ldisc_ref_wait(tty
);
2359 ret
= put_user(ld
->ops
->num
, p
);
2360 tty_ldisc_deref(ld
);
2365 * send_break - performed time break
2366 * @tty: device to break on
2367 * @duration: timeout in mS
2369 * Perform a timed break on hardware that lacks its own driver level
2370 * timed break functionality.
2373 * atomic_write_lock serializes
2377 static int send_break(struct tty_struct
*tty
, unsigned int duration
)
2381 if (tty
->ops
->break_ctl
== NULL
)
2384 if (tty
->driver
->flags
& TTY_DRIVER_HARDWARE_BREAK
)
2385 retval
= tty
->ops
->break_ctl(tty
, duration
);
2387 /* Do the work ourselves */
2388 if (tty_write_lock(tty
, 0) < 0)
2390 retval
= tty
->ops
->break_ctl(tty
, -1);
2393 if (!signal_pending(current
))
2394 msleep_interruptible(duration
);
2395 retval
= tty
->ops
->break_ctl(tty
, 0);
2397 tty_write_unlock(tty
);
2398 if (signal_pending(current
))
2405 * tty_tiocmget - get modem status
2407 * @file: user file pointer
2408 * @p: pointer to result
2410 * Obtain the modem status bits from the tty driver if the feature
2411 * is supported. Return -EINVAL if it is not available.
2413 * Locking: none (up to the driver)
2416 static int tty_tiocmget(struct tty_struct
*tty
, int __user
*p
)
2418 int retval
= -EINVAL
;
2420 if (tty
->ops
->tiocmget
) {
2421 retval
= tty
->ops
->tiocmget(tty
);
2424 retval
= put_user(retval
, p
);
2430 * tty_tiocmset - set modem status
2432 * @cmd: command - clear bits, set bits or set all
2433 * @p: pointer to desired bits
2435 * Set the modem status bits from the tty driver if the feature
2436 * is supported. Return -EINVAL if it is not available.
2438 * Locking: none (up to the driver)
2441 static int tty_tiocmset(struct tty_struct
*tty
, unsigned int cmd
,
2445 unsigned int set
, clear
, val
;
2447 if (tty
->ops
->tiocmset
== NULL
)
2450 retval
= get_user(val
, p
);
2466 set
&= TIOCM_DTR
|TIOCM_RTS
|TIOCM_OUT1
|TIOCM_OUT2
|TIOCM_LOOP
;
2467 clear
&= TIOCM_DTR
|TIOCM_RTS
|TIOCM_OUT1
|TIOCM_OUT2
|TIOCM_LOOP
;
2468 return tty
->ops
->tiocmset(tty
, set
, clear
);
2471 static int tty_tiocgicount(struct tty_struct
*tty
, void __user
*arg
)
2473 int retval
= -EINVAL
;
2474 struct serial_icounter_struct icount
;
2475 memset(&icount
, 0, sizeof(icount
));
2476 if (tty
->ops
->get_icount
)
2477 retval
= tty
->ops
->get_icount(tty
, &icount
);
2480 if (copy_to_user(arg
, &icount
, sizeof(icount
)))
2485 static void tty_warn_deprecated_flags(struct serial_struct __user
*ss
)
2487 static DEFINE_RATELIMIT_STATE(depr_flags
,
2488 DEFAULT_RATELIMIT_INTERVAL
,
2489 DEFAULT_RATELIMIT_BURST
);
2490 char comm
[TASK_COMM_LEN
];
2493 if (get_user(flags
, &ss
->flags
))
2496 flags
&= ASYNC_DEPRECATED
;
2498 if (flags
&& __ratelimit(&depr_flags
))
2499 pr_warn("%s: '%s' is using deprecated serial flags (with no effect): %.8x\n",
2500 __func__
, get_task_comm(comm
, current
), flags
);
2504 * if pty, return the slave side (real_tty)
2505 * otherwise, return self
2507 static struct tty_struct
*tty_pair_get_tty(struct tty_struct
*tty
)
2509 if (tty
->driver
->type
== TTY_DRIVER_TYPE_PTY
&&
2510 tty
->driver
->subtype
== PTY_TYPE_MASTER
)
2516 * Split this up, as gcc can choke on it otherwise..
2518 long tty_ioctl(struct file
*file
, unsigned int cmd
, unsigned long arg
)
2520 struct tty_struct
*tty
= file_tty(file
);
2521 struct tty_struct
*real_tty
;
2522 void __user
*p
= (void __user
*)arg
;
2524 struct tty_ldisc
*ld
;
2526 if (tty_paranoia_check(tty
, file_inode(file
), "tty_ioctl"))
2529 real_tty
= tty_pair_get_tty(tty
);
2532 * Factor out some common prep work
2540 retval
= tty_check_change(tty
);
2543 if (cmd
!= TIOCCBRK
) {
2544 tty_wait_until_sent(tty
, 0);
2545 if (signal_pending(current
))
2556 return tiocsti(tty
, p
);
2558 return tiocgwinsz(real_tty
, p
);
2560 return tiocswinsz(real_tty
, p
);
2562 return real_tty
!= tty
? -EINVAL
: tioccons(file
);
2564 return fionbio(file
, p
);
2566 set_bit(TTY_EXCLUSIVE
, &tty
->flags
);
2569 clear_bit(TTY_EXCLUSIVE
, &tty
->flags
);
2573 int excl
= test_bit(TTY_EXCLUSIVE
, &tty
->flags
);
2574 return put_user(excl
, (int __user
*)p
);
2577 return tiocgetd(tty
, p
);
2579 return tiocsetd(tty
, p
);
2581 if (!capable(CAP_SYS_ADMIN
))
2587 unsigned int ret
= new_encode_dev(tty_devnum(real_tty
));
2588 return put_user(ret
, (unsigned int __user
*)p
);
2593 case TIOCSBRK
: /* Turn break on, unconditionally */
2594 if (tty
->ops
->break_ctl
)
2595 return tty
->ops
->break_ctl(tty
, -1);
2597 case TIOCCBRK
: /* Turn break off, unconditionally */
2598 if (tty
->ops
->break_ctl
)
2599 return tty
->ops
->break_ctl(tty
, 0);
2601 case TCSBRK
: /* SVID version: non-zero arg --> no break */
2602 /* non-zero arg means wait for all output data
2603 * to be sent (performed above) but don't send break.
2604 * This is used by the tcdrain() termios function.
2607 return send_break(tty
, 250);
2609 case TCSBRKP
: /* support for POSIX tcsendbreak() */
2610 return send_break(tty
, arg
? arg
*100 : 250);
2613 return tty_tiocmget(tty
, p
);
2617 return tty_tiocmset(tty
, cmd
, p
);
2619 retval
= tty_tiocgicount(tty
, p
);
2620 /* For the moment allow fall through to the old method */
2621 if (retval
!= -EINVAL
)
2628 /* flush tty buffer and allow ldisc to process ioctl */
2629 tty_buffer_flush(tty
, NULL
);
2634 tty_warn_deprecated_flags(p
);
2637 /* Special because the struct file is needed */
2638 return ptm_open_peer(file
, tty
, (int)arg
);
2640 retval
= tty_jobctrl_ioctl(tty
, real_tty
, file
, cmd
, arg
);
2641 if (retval
!= -ENOIOCTLCMD
)
2644 if (tty
->ops
->ioctl
) {
2645 retval
= tty
->ops
->ioctl(tty
, cmd
, arg
);
2646 if (retval
!= -ENOIOCTLCMD
)
2649 ld
= tty_ldisc_ref_wait(tty
);
2651 return hung_up_tty_ioctl(file
, cmd
, arg
);
2653 if (ld
->ops
->ioctl
) {
2654 retval
= ld
->ops
->ioctl(tty
, file
, cmd
, arg
);
2655 if (retval
== -ENOIOCTLCMD
)
2658 tty_ldisc_deref(ld
);
2662 #ifdef CONFIG_COMPAT
2663 static long tty_compat_ioctl(struct file
*file
, unsigned int cmd
,
2666 struct tty_struct
*tty
= file_tty(file
);
2667 struct tty_ldisc
*ld
;
2668 int retval
= -ENOIOCTLCMD
;
2670 if (tty_paranoia_check(tty
, file_inode(file
), "tty_ioctl"))
2673 if (tty
->ops
->compat_ioctl
) {
2674 retval
= tty
->ops
->compat_ioctl(tty
, cmd
, arg
);
2675 if (retval
!= -ENOIOCTLCMD
)
2679 ld
= tty_ldisc_ref_wait(tty
);
2681 return hung_up_tty_compat_ioctl(file
, cmd
, arg
);
2682 if (ld
->ops
->compat_ioctl
)
2683 retval
= ld
->ops
->compat_ioctl(tty
, file
, cmd
, arg
);
2685 retval
= n_tty_compat_ioctl_helper(tty
, file
, cmd
, arg
);
2686 tty_ldisc_deref(ld
);
2692 static int this_tty(const void *t
, struct file
*file
, unsigned fd
)
2694 if (likely(file
->f_op
->read
!= tty_read
))
2696 return file_tty(file
) != t
? 0 : fd
+ 1;
2700 * This implements the "Secure Attention Key" --- the idea is to
2701 * prevent trojan horses by killing all processes associated with this
2702 * tty when the user hits the "Secure Attention Key". Required for
2703 * super-paranoid applications --- see the Orange Book for more details.
2705 * This code could be nicer; ideally it should send a HUP, wait a few
2706 * seconds, then send a INT, and then a KILL signal. But you then
2707 * have to coordinate with the init process, since all processes associated
2708 * with the current tty must be dead before the new getty is allowed
2711 * Now, if it would be correct ;-/ The current code has a nasty hole -
2712 * it doesn't catch files in flight. We may send the descriptor to ourselves
2713 * via AF_UNIX socket, close it and later fetch from socket. FIXME.
2715 * Nasty bug: do_SAK is being called in interrupt context. This can
2716 * deadlock. We punt it up to process context. AKPM - 16Mar2001
2718 void __do_SAK(struct tty_struct
*tty
)
2723 struct task_struct
*g
, *p
;
2724 struct pid
*session
;
2729 session
= tty
->session
;
2731 tty_ldisc_flush(tty
);
2733 tty_driver_flush_buffer(tty
);
2735 read_lock(&tasklist_lock
);
2736 /* Kill the entire session */
2737 do_each_pid_task(session
, PIDTYPE_SID
, p
) {
2738 tty_notice(tty
, "SAK: killed process %d (%s): by session\n",
2739 task_pid_nr(p
), p
->comm
);
2740 send_sig(SIGKILL
, p
, 1);
2741 } while_each_pid_task(session
, PIDTYPE_SID
, p
);
2743 /* Now kill any processes that happen to have the tty open */
2744 do_each_thread(g
, p
) {
2745 if (p
->signal
->tty
== tty
) {
2746 tty_notice(tty
, "SAK: killed process %d (%s): by controlling tty\n",
2747 task_pid_nr(p
), p
->comm
);
2748 send_sig(SIGKILL
, p
, 1);
2752 i
= iterate_fd(p
->files
, 0, this_tty
, tty
);
2754 tty_notice(tty
, "SAK: killed process %d (%s): by fd#%d\n",
2755 task_pid_nr(p
), p
->comm
, i
- 1);
2756 force_sig(SIGKILL
, p
);
2759 } while_each_thread(g
, p
);
2760 read_unlock(&tasklist_lock
);
2764 static void do_SAK_work(struct work_struct
*work
)
2766 struct tty_struct
*tty
=
2767 container_of(work
, struct tty_struct
, SAK_work
);
2772 * The tq handling here is a little racy - tty->SAK_work may already be queued.
2773 * Fortunately we don't need to worry, because if ->SAK_work is already queued,
2774 * the values which we write to it will be identical to the values which it
2775 * already has. --akpm
2777 void do_SAK(struct tty_struct
*tty
)
2781 schedule_work(&tty
->SAK_work
);
2784 EXPORT_SYMBOL(do_SAK
);
2786 static int dev_match_devt(struct device
*dev
, const void *data
)
2788 const dev_t
*devt
= data
;
2789 return dev
->devt
== *devt
;
2792 /* Must put_device() after it's unused! */
2793 static struct device
*tty_get_device(struct tty_struct
*tty
)
2795 dev_t devt
= tty_devnum(tty
);
2796 return class_find_device(tty_class
, NULL
, &devt
, dev_match_devt
);
2803 * This subroutine allocates and initializes a tty structure.
2805 * Locking: none - tty in question is not exposed at this point
2808 struct tty_struct
*alloc_tty_struct(struct tty_driver
*driver
, int idx
)
2810 struct tty_struct
*tty
;
2812 tty
= kzalloc(sizeof(*tty
), GFP_KERNEL
);
2816 kref_init(&tty
->kref
);
2817 tty
->magic
= TTY_MAGIC
;
2818 if (tty_ldisc_init(tty
)) {
2822 tty
->session
= NULL
;
2824 mutex_init(&tty
->legacy_mutex
);
2825 mutex_init(&tty
->throttle_mutex
);
2826 init_rwsem(&tty
->termios_rwsem
);
2827 mutex_init(&tty
->winsize_mutex
);
2828 init_ldsem(&tty
->ldisc_sem
);
2829 init_waitqueue_head(&tty
->write_wait
);
2830 init_waitqueue_head(&tty
->read_wait
);
2831 INIT_WORK(&tty
->hangup_work
, do_tty_hangup
);
2832 mutex_init(&tty
->atomic_write_lock
);
2833 spin_lock_init(&tty
->ctrl_lock
);
2834 spin_lock_init(&tty
->flow_lock
);
2835 spin_lock_init(&tty
->files_lock
);
2836 INIT_LIST_HEAD(&tty
->tty_files
);
2837 INIT_WORK(&tty
->SAK_work
, do_SAK_work
);
2839 tty
->driver
= driver
;
2840 tty
->ops
= driver
->ops
;
2842 tty_line_name(driver
, idx
, tty
->name
);
2843 tty
->dev
= tty_get_device(tty
);
2849 * tty_put_char - write one character to a tty
2853 * Write one byte to the tty using the provided put_char method
2854 * if present. Returns the number of characters successfully output.
2856 * Note: the specific put_char operation in the driver layer may go
2857 * away soon. Don't call it directly, use this method
2860 int tty_put_char(struct tty_struct
*tty
, unsigned char ch
)
2862 if (tty
->ops
->put_char
)
2863 return tty
->ops
->put_char(tty
, ch
);
2864 return tty
->ops
->write(tty
, &ch
, 1);
2866 EXPORT_SYMBOL_GPL(tty_put_char
);
2868 struct class *tty_class
;
2870 static int tty_cdev_add(struct tty_driver
*driver
, dev_t dev
,
2871 unsigned int index
, unsigned int count
)
2875 /* init here, since reused cdevs cause crashes */
2876 driver
->cdevs
[index
] = cdev_alloc();
2877 if (!driver
->cdevs
[index
])
2879 driver
->cdevs
[index
]->ops
= &tty_fops
;
2880 driver
->cdevs
[index
]->owner
= driver
->owner
;
2881 err
= cdev_add(driver
->cdevs
[index
], dev
, count
);
2883 kobject_put(&driver
->cdevs
[index
]->kobj
);
2888 * tty_register_device - register a tty device
2889 * @driver: the tty driver that describes the tty device
2890 * @index: the index in the tty driver for this tty device
2891 * @device: a struct device that is associated with this tty device.
2892 * This field is optional, if there is no known struct device
2893 * for this tty device it can be set to NULL safely.
2895 * Returns a pointer to the struct device for this tty device
2896 * (or ERR_PTR(-EFOO) on error).
2898 * This call is required to be made to register an individual tty device
2899 * if the tty driver's flags have the TTY_DRIVER_DYNAMIC_DEV bit set. If
2900 * that bit is not set, this function should not be called by a tty
2906 struct device
*tty_register_device(struct tty_driver
*driver
, unsigned index
,
2907 struct device
*device
)
2909 return tty_register_device_attr(driver
, index
, device
, NULL
, NULL
);
2911 EXPORT_SYMBOL(tty_register_device
);
2913 static void tty_device_create_release(struct device
*dev
)
2915 dev_dbg(dev
, "releasing...\n");
2920 * tty_register_device_attr - register a tty device
2921 * @driver: the tty driver that describes the tty device
2922 * @index: the index in the tty driver for this tty device
2923 * @device: a struct device that is associated with this tty device.
2924 * This field is optional, if there is no known struct device
2925 * for this tty device it can be set to NULL safely.
2926 * @drvdata: Driver data to be set to device.
2927 * @attr_grp: Attribute group to be set on device.
2929 * Returns a pointer to the struct device for this tty device
2930 * (or ERR_PTR(-EFOO) on error).
2932 * This call is required to be made to register an individual tty device
2933 * if the tty driver's flags have the TTY_DRIVER_DYNAMIC_DEV bit set. If
2934 * that bit is not set, this function should not be called by a tty
2939 struct device
*tty_register_device_attr(struct tty_driver
*driver
,
2940 unsigned index
, struct device
*device
,
2942 const struct attribute_group
**attr_grp
)
2945 dev_t devt
= MKDEV(driver
->major
, driver
->minor_start
) + index
;
2946 struct ktermios
*tp
;
2950 if (index
>= driver
->num
) {
2951 pr_err("%s: Attempt to register invalid tty line number (%d)\n",
2952 driver
->name
, index
);
2953 return ERR_PTR(-EINVAL
);
2956 if (driver
->type
== TTY_DRIVER_TYPE_PTY
)
2957 pty_line_name(driver
, index
, name
);
2959 tty_line_name(driver
, index
, name
);
2961 dev
= kzalloc(sizeof(*dev
), GFP_KERNEL
);
2963 return ERR_PTR(-ENOMEM
);
2966 dev
->class = tty_class
;
2967 dev
->parent
= device
;
2968 dev
->release
= tty_device_create_release
;
2969 dev_set_name(dev
, "%s", name
);
2970 dev
->groups
= attr_grp
;
2971 dev_set_drvdata(dev
, drvdata
);
2973 dev_set_uevent_suppress(dev
, 1);
2975 retval
= device_register(dev
);
2979 if (!(driver
->flags
& TTY_DRIVER_DYNAMIC_ALLOC
)) {
2981 * Free any saved termios data so that the termios state is
2982 * reset when reusing a minor number.
2984 tp
= driver
->termios
[index
];
2986 driver
->termios
[index
] = NULL
;
2990 retval
= tty_cdev_add(driver
, devt
, index
, 1);
2995 dev_set_uevent_suppress(dev
, 0);
2996 kobject_uevent(&dev
->kobj
, KOBJ_ADD
);
3005 return ERR_PTR(retval
);
3007 EXPORT_SYMBOL_GPL(tty_register_device_attr
);
3010 * tty_unregister_device - unregister a tty device
3011 * @driver: the tty driver that describes the tty device
3012 * @index: the index in the tty driver for this tty device
3014 * If a tty device is registered with a call to tty_register_device() then
3015 * this function must be called when the tty device is gone.
3020 void tty_unregister_device(struct tty_driver
*driver
, unsigned index
)
3022 device_destroy(tty_class
,
3023 MKDEV(driver
->major
, driver
->minor_start
) + index
);
3024 if (!(driver
->flags
& TTY_DRIVER_DYNAMIC_ALLOC
)) {
3025 cdev_del(driver
->cdevs
[index
]);
3026 driver
->cdevs
[index
] = NULL
;
3029 EXPORT_SYMBOL(tty_unregister_device
);
3032 * __tty_alloc_driver -- allocate tty driver
3033 * @lines: count of lines this driver can handle at most
3034 * @owner: module which is responsible for this driver
3035 * @flags: some of TTY_DRIVER_* flags, will be set in driver->flags
3037 * This should not be called directly, some of the provided macros should be
3038 * used instead. Use IS_ERR and friends on @retval.
3040 struct tty_driver
*__tty_alloc_driver(unsigned int lines
, struct module
*owner
,
3041 unsigned long flags
)
3043 struct tty_driver
*driver
;
3044 unsigned int cdevs
= 1;
3047 if (!lines
|| (flags
& TTY_DRIVER_UNNUMBERED_NODE
&& lines
> 1))
3048 return ERR_PTR(-EINVAL
);
3050 driver
= kzalloc(sizeof(struct tty_driver
), GFP_KERNEL
);
3052 return ERR_PTR(-ENOMEM
);
3054 kref_init(&driver
->kref
);
3055 driver
->magic
= TTY_DRIVER_MAGIC
;
3056 driver
->num
= lines
;
3057 driver
->owner
= owner
;
3058 driver
->flags
= flags
;
3060 if (!(flags
& TTY_DRIVER_DEVPTS_MEM
)) {
3061 driver
->ttys
= kcalloc(lines
, sizeof(*driver
->ttys
),
3063 driver
->termios
= kcalloc(lines
, sizeof(*driver
->termios
),
3065 if (!driver
->ttys
|| !driver
->termios
) {
3071 if (!(flags
& TTY_DRIVER_DYNAMIC_ALLOC
)) {
3072 driver
->ports
= kcalloc(lines
, sizeof(*driver
->ports
),
3074 if (!driver
->ports
) {
3081 driver
->cdevs
= kcalloc(cdevs
, sizeof(*driver
->cdevs
), GFP_KERNEL
);
3082 if (!driver
->cdevs
) {
3089 kfree(driver
->ports
);
3090 kfree(driver
->ttys
);
3091 kfree(driver
->termios
);
3092 kfree(driver
->cdevs
);
3094 return ERR_PTR(err
);
3096 EXPORT_SYMBOL(__tty_alloc_driver
);
3098 static void destruct_tty_driver(struct kref
*kref
)
3100 struct tty_driver
*driver
= container_of(kref
, struct tty_driver
, kref
);
3102 struct ktermios
*tp
;
3104 if (driver
->flags
& TTY_DRIVER_INSTALLED
) {
3105 for (i
= 0; i
< driver
->num
; i
++) {
3106 tp
= driver
->termios
[i
];
3108 driver
->termios
[i
] = NULL
;
3111 if (!(driver
->flags
& TTY_DRIVER_DYNAMIC_DEV
))
3112 tty_unregister_device(driver
, i
);
3114 proc_tty_unregister_driver(driver
);
3115 if (driver
->flags
& TTY_DRIVER_DYNAMIC_ALLOC
)
3116 cdev_del(driver
->cdevs
[0]);
3118 kfree(driver
->cdevs
);
3119 kfree(driver
->ports
);
3120 kfree(driver
->termios
);
3121 kfree(driver
->ttys
);
3125 void tty_driver_kref_put(struct tty_driver
*driver
)
3127 kref_put(&driver
->kref
, destruct_tty_driver
);
3129 EXPORT_SYMBOL(tty_driver_kref_put
);
3131 void tty_set_operations(struct tty_driver
*driver
,
3132 const struct tty_operations
*op
)
3136 EXPORT_SYMBOL(tty_set_operations
);
3138 void put_tty_driver(struct tty_driver
*d
)
3140 tty_driver_kref_put(d
);
3142 EXPORT_SYMBOL(put_tty_driver
);
3145 * Called by a tty driver to register itself.
3147 int tty_register_driver(struct tty_driver
*driver
)
3154 if (!driver
->major
) {
3155 error
= alloc_chrdev_region(&dev
, driver
->minor_start
,
3156 driver
->num
, driver
->name
);
3158 driver
->major
= MAJOR(dev
);
3159 driver
->minor_start
= MINOR(dev
);
3162 dev
= MKDEV(driver
->major
, driver
->minor_start
);
3163 error
= register_chrdev_region(dev
, driver
->num
, driver
->name
);
3168 if (driver
->flags
& TTY_DRIVER_DYNAMIC_ALLOC
) {
3169 error
= tty_cdev_add(driver
, dev
, 0, driver
->num
);
3171 goto err_unreg_char
;
3174 mutex_lock(&tty_mutex
);
3175 list_add(&driver
->tty_drivers
, &tty_drivers
);
3176 mutex_unlock(&tty_mutex
);
3178 if (!(driver
->flags
& TTY_DRIVER_DYNAMIC_DEV
)) {
3179 for (i
= 0; i
< driver
->num
; i
++) {
3180 d
= tty_register_device(driver
, i
, NULL
);
3183 goto err_unreg_devs
;
3187 proc_tty_register_driver(driver
);
3188 driver
->flags
|= TTY_DRIVER_INSTALLED
;
3192 for (i
--; i
>= 0; i
--)
3193 tty_unregister_device(driver
, i
);
3195 mutex_lock(&tty_mutex
);
3196 list_del(&driver
->tty_drivers
);
3197 mutex_unlock(&tty_mutex
);
3200 unregister_chrdev_region(dev
, driver
->num
);
3204 EXPORT_SYMBOL(tty_register_driver
);
3207 * Called by a tty driver to unregister itself.
3209 int tty_unregister_driver(struct tty_driver
*driver
)
3213 if (driver
->refcount
)
3216 unregister_chrdev_region(MKDEV(driver
->major
, driver
->minor_start
),
3218 mutex_lock(&tty_mutex
);
3219 list_del(&driver
->tty_drivers
);
3220 mutex_unlock(&tty_mutex
);
3224 EXPORT_SYMBOL(tty_unregister_driver
);
3226 dev_t
tty_devnum(struct tty_struct
*tty
)
3228 return MKDEV(tty
->driver
->major
, tty
->driver
->minor_start
) + tty
->index
;
3230 EXPORT_SYMBOL(tty_devnum
);
3232 void tty_default_fops(struct file_operations
*fops
)
3237 static char *tty_devnode(struct device
*dev
, umode_t
*mode
)
3241 if (dev
->devt
== MKDEV(TTYAUX_MAJOR
, 0) ||
3242 dev
->devt
== MKDEV(TTYAUX_MAJOR
, 2))
3247 static int __init
tty_class_init(void)
3249 tty_class
= class_create(THIS_MODULE
, "tty");
3250 if (IS_ERR(tty_class
))
3251 return PTR_ERR(tty_class
);
3252 tty_class
->devnode
= tty_devnode
;
3256 postcore_initcall(tty_class_init
);
3258 /* 3/2004 jmc: why do these devices exist? */
3259 static struct cdev tty_cdev
, console_cdev
;
3261 static ssize_t
show_cons_active(struct device
*dev
,
3262 struct device_attribute
*attr
, char *buf
)
3264 struct console
*cs
[16];
3270 for_each_console(c
) {
3275 if ((c
->flags
& CON_ENABLED
) == 0)
3278 if (i
>= ARRAY_SIZE(cs
))
3282 int index
= cs
[i
]->index
;
3283 struct tty_driver
*drv
= cs
[i
]->device(cs
[i
], &index
);
3285 /* don't resolve tty0 as some programs depend on it */
3286 if (drv
&& (cs
[i
]->index
> 0 || drv
->major
!= TTY_MAJOR
))
3287 count
+= tty_line_name(drv
, index
, buf
+ count
);
3289 count
+= sprintf(buf
+ count
, "%s%d",
3290 cs
[i
]->name
, cs
[i
]->index
);
3292 count
+= sprintf(buf
+ count
, "%c", i
? ' ':'\n');
3298 static DEVICE_ATTR(active
, S_IRUGO
, show_cons_active
, NULL
);
3300 static struct attribute
*cons_dev_attrs
[] = {
3301 &dev_attr_active
.attr
,
3305 ATTRIBUTE_GROUPS(cons_dev
);
3307 static struct device
*consdev
;
3309 void console_sysfs_notify(void)
3312 sysfs_notify(&consdev
->kobj
, NULL
, "active");
3316 * Ok, now we can initialize the rest of the tty devices and can count
3317 * on memory allocations, interrupts etc..
3319 int __init
tty_init(void)
3321 cdev_init(&tty_cdev
, &tty_fops
);
3322 if (cdev_add(&tty_cdev
, MKDEV(TTYAUX_MAJOR
, 0), 1) ||
3323 register_chrdev_region(MKDEV(TTYAUX_MAJOR
, 0), 1, "/dev/tty") < 0)
3324 panic("Couldn't register /dev/tty driver\n");
3325 device_create(tty_class
, NULL
, MKDEV(TTYAUX_MAJOR
, 0), NULL
, "tty");
3327 cdev_init(&console_cdev
, &console_fops
);
3328 if (cdev_add(&console_cdev
, MKDEV(TTYAUX_MAJOR
, 1), 1) ||
3329 register_chrdev_region(MKDEV(TTYAUX_MAJOR
, 1), 1, "/dev/console") < 0)
3330 panic("Couldn't register /dev/console driver\n");
3331 consdev
= device_create_with_groups(tty_class
, NULL
,
3332 MKDEV(TTYAUX_MAJOR
, 1), NULL
,
3333 cons_dev_groups
, "console");
3334 if (IS_ERR(consdev
))
3338 vty_init(&console_fops
);