2 * linux/drivers/char/tty_io.c
4 * Copyright (C) 1991, 1992 Linus Torvalds
8 * 'tty_io.c' gives an orthogonal feeling to tty's, be they consoles
9 * or rs-channels. It also implements echoing, cooked mode etc.
11 * Kill-line thanks to John T Kohl, who also corrected VMIN = VTIME = 0.
13 * Modified by Theodore Ts'o, 9/14/92, to dynamically allocate the
14 * tty_struct and tty_queue structures. Previously there was an array
15 * of 256 tty_struct's which was statically allocated, and the
16 * tty_queue structures were allocated at boot time. Both are now
17 * dynamically allocated only when the tty is open.
19 * Also restructured routines so that there is more of a separation
20 * between the high-level tty routines (tty_io.c and tty_ioctl.c) and
21 * the low-level tty routines (serial.c, pty.c, console.c). This
22 * makes for cleaner and more compact code. -TYT, 9/17/92
24 * Modified by Fred N. van Kempen, 01/29/93, to add line disciplines
25 * which can be dynamically activated and de-activated by the line
26 * discipline handling modules (like SLIP).
28 * NOTE: pay no attention to the line discipline code (yet); its
29 * interface is still subject to change in this version...
32 * Added functionality to the OPOST tty handling. No delays, but all
33 * other bits should be there.
34 * -- Nick Holloway <alfie@dcs.warwick.ac.uk>, 27th May 1993.
36 * Rewrote canonical mode and added more termios flags.
37 * -- julian@uhunix.uhcc.hawaii.edu (J. Cowley), 13Jan94
39 * Reorganized FASYNC support so mouse code can share it.
40 * -- ctm@ardi.com, 9Sep95
42 * New TIOCLINUX variants added.
43 * -- mj@k332.feld.cvut.cz, 19-Nov-95
45 * Restrict vt switching via ioctl()
46 * -- grif@cs.ucr.edu, 5-Dec-95
48 * Move console and virtual terminal code to more appropriate files,
49 * implement CONFIG_VT and generalize console device interface.
50 * -- Marko Kohtala <Marko.Kohtala@hut.fi>, March 97
52 * Rewrote init_dev and release_dev to eliminate races.
53 * -- Bill Hawes <whawes@star.net>, June 97
55 * Added devfs support.
56 * -- C. Scott Ananian <cananian@alumni.princeton.edu>, 13-Jan-1998
58 * Added support for a Unix98-style ptmx device.
59 * -- C. Scott Ananian <cananian@alumni.princeton.edu>, 14-Jan-1998
61 * Reduced memory usage for older ARM systems
62 * -- Russell King <rmk@arm.linux.org.uk>
64 * Move do_SAK() into process context. Less stack use in devfs functions.
65 * alloc_tty_struct() always uses kmalloc()
66 * -- Andrew Morton <andrewm@uow.edu.eu> 17Mar01
69 #include <linux/types.h>
70 #include <linux/major.h>
71 #include <linux/errno.h>
72 #include <linux/signal.h>
73 #include <linux/fcntl.h>
74 #include <linux/sched.h>
75 #include <linux/interrupt.h>
76 #include <linux/tty.h>
77 #include <linux/tty_driver.h>
78 #include <linux/tty_flip.h>
79 #include <linux/devpts_fs.h>
80 #include <linux/file.h>
81 #include <linux/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/smp_lock.h>
93 #include <linux/device.h>
94 #include <linux/idr.h>
95 #include <linux/wait.h>
96 #include <linux/bitops.h>
97 #include <linux/delay.h>
99 #include <asm/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 #ifdef CONFIG_UNIX98_PTYS
139 extern struct tty_driver *ptm_driver; /* Unix98 pty masters; for /dev/ptmx */
140 extern int pty_limit; /* Config limit on Unix98 ptys */
141 static DEFINE_IDR(allocated_ptys);
142 static DEFINE_MUTEX(allocated_ptys_lock);
143 static int ptmx_open(struct inode *, struct file *);
146 static void initialize_tty_struct(struct tty_struct *tty);
148 static ssize_t tty_read(struct file *, char __user *, size_t, loff_t *);
149 static ssize_t tty_write(struct file *, const char __user *, size_t, loff_t *);
150 ssize_t redirected_tty_write(struct file *, const char __user *,
152 static unsigned int tty_poll(struct file *, poll_table *);
153 static int tty_open(struct inode *, struct file *);
154 static int tty_release(struct inode *, struct file *);
155 long tty_ioctl(struct file *file, unsigned int cmd, unsigned long arg);
157 static long tty_compat_ioctl(struct file *file, unsigned int cmd,
160 #define tty_compat_ioctl NULL
162 static int tty_fasync(int fd, struct file *filp, int on);
163 static void release_tty(struct tty_struct *tty, int idx);
164 static void __proc_set_tty(struct task_struct *tsk, struct tty_struct *tty);
165 static void proc_set_tty(struct task_struct *tsk, struct tty_struct *tty);
168 * alloc_tty_struct - allocate a tty object
170 * Return a new empty tty structure. The data fields have not
171 * been initialized in any way but has been zeroed
176 static struct tty_struct *alloc_tty_struct(void)
178 return kzalloc(sizeof(struct tty_struct), GFP_KERNEL);
181 static void tty_buffer_free_all(struct tty_struct *);
184 * free_tty_struct - free a disused tty
185 * @tty: tty struct to free
187 * Free the write buffers, tty queue and tty memory itself.
189 * Locking: none. Must be called after tty is definitely unused
192 static inline void free_tty_struct(struct tty_struct *tty)
194 kfree(tty->write_buf);
195 tty_buffer_free_all(tty);
199 #define TTY_NUMBER(tty) ((tty)->index + (tty)->driver->name_base)
202 * tty_name - return tty naming
203 * @tty: tty structure
204 * @buf: buffer for output
206 * Convert a tty structure into a name. The name reflects the kernel
207 * naming policy and if udev is in use may not reflect user space
212 char *tty_name(struct tty_struct *tty, char *buf)
214 if (!tty) /* Hmm. NULL pointer. That's fun. */
215 strcpy(buf, "NULL tty");
217 strcpy(buf, tty->name);
221 EXPORT_SYMBOL(tty_name);
223 int tty_paranoia_check(struct tty_struct *tty, struct inode *inode,
226 #ifdef TTY_PARANOIA_CHECK
229 "null TTY for (%d:%d) in %s\n",
230 imajor(inode), iminor(inode), routine);
233 if (tty->magic != TTY_MAGIC) {
235 "bad magic number for tty struct (%d:%d) in %s\n",
236 imajor(inode), iminor(inode), routine);
243 static int check_tty_count(struct tty_struct *tty, const char *routine)
245 #ifdef CHECK_TTY_COUNT
250 list_for_each(p, &tty->tty_files) {
254 if (tty->driver->type == TTY_DRIVER_TYPE_PTY &&
255 tty->driver->subtype == PTY_TYPE_SLAVE &&
256 tty->link && tty->link->count)
258 if (tty->count != count) {
259 printk(KERN_WARNING "Warning: dev (%s) tty->count(%d) "
260 "!= #fd's(%d) in %s\n",
261 tty->name, tty->count, count, routine);
269 * Tty buffer allocation management
273 * tty_buffer_free_all - free buffers used by a tty
274 * @tty: tty to free from
276 * Remove all the buffers pending on a tty whether queued with data
277 * or in the free ring. Must be called when the tty is no longer in use
282 static void tty_buffer_free_all(struct tty_struct *tty)
284 struct tty_buffer *thead;
285 while ((thead = tty->buf.head) != NULL) {
286 tty->buf.head = thead->next;
289 while ((thead = tty->buf.free) != NULL) {
290 tty->buf.free = thead->next;
293 tty->buf.tail = NULL;
294 tty->buf.memory_used = 0;
298 * tty_buffer_init - prepare a tty buffer structure
299 * @tty: tty to initialise
301 * Set up the initial state of the buffer management for a tty device.
302 * Must be called before the other tty buffer functions are used.
307 static void tty_buffer_init(struct tty_struct *tty)
309 spin_lock_init(&tty->buf.lock);
310 tty->buf.head = NULL;
311 tty->buf.tail = NULL;
312 tty->buf.free = NULL;
313 tty->buf.memory_used = 0;
317 * tty_buffer_alloc - allocate a tty buffer
319 * @size: desired size (characters)
321 * Allocate a new tty buffer to hold the desired number of characters.
322 * Return NULL if out of memory or the allocation would exceed the
325 * Locking: Caller must hold tty->buf.lock
328 static struct tty_buffer *tty_buffer_alloc(struct tty_struct *tty, size_t size)
330 struct tty_buffer *p;
332 if (tty->buf.memory_used + size > 65536)
334 p = kmalloc(sizeof(struct tty_buffer) + 2 * size, GFP_ATOMIC);
342 p->char_buf_ptr = (char *)(p->data);
343 p->flag_buf_ptr = (unsigned char *)p->char_buf_ptr + size;
344 tty->buf.memory_used += size;
349 * tty_buffer_free - free a tty buffer
350 * @tty: tty owning the buffer
351 * @b: the buffer to free
353 * Free a tty buffer, or add it to the free list according to our
356 * Locking: Caller must hold tty->buf.lock
359 static void tty_buffer_free(struct tty_struct *tty, struct tty_buffer *b)
361 /* Dumb strategy for now - should keep some stats */
362 tty->buf.memory_used -= b->size;
363 WARN_ON(tty->buf.memory_used < 0);
368 b->next = tty->buf.free;
374 * __tty_buffer_flush - flush full tty buffers
377 * flush all the buffers containing receive data. Caller must
378 * hold the buffer lock and must have ensured no parallel flush to
381 * Locking: Caller must hold tty->buf.lock
384 static void __tty_buffer_flush(struct tty_struct *tty)
386 struct tty_buffer *thead;
388 while ((thead = tty->buf.head) != NULL) {
389 tty->buf.head = thead->next;
390 tty_buffer_free(tty, thead);
392 tty->buf.tail = NULL;
396 * tty_buffer_flush - flush full tty buffers
399 * flush all the buffers containing receive data. If the buffer is
400 * being processed by flush_to_ldisc then we defer the processing
406 static void tty_buffer_flush(struct tty_struct *tty)
409 spin_lock_irqsave(&tty->buf.lock, flags);
411 /* If the data is being pushed to the tty layer then we can't
412 process it here. Instead set a flag and the flush_to_ldisc
413 path will process the flush request before it exits */
414 if (test_bit(TTY_FLUSHING, &tty->flags)) {
415 set_bit(TTY_FLUSHPENDING, &tty->flags);
416 spin_unlock_irqrestore(&tty->buf.lock, flags);
417 wait_event(tty->read_wait,
418 test_bit(TTY_FLUSHPENDING, &tty->flags) == 0);
421 __tty_buffer_flush(tty);
422 spin_unlock_irqrestore(&tty->buf.lock, flags);
426 * tty_buffer_find - find a free tty buffer
427 * @tty: tty owning the buffer
428 * @size: characters wanted
430 * Locate an existing suitable tty buffer or if we are lacking one then
431 * allocate a new one. We round our buffers off in 256 character chunks
432 * to get better allocation behaviour.
434 * Locking: Caller must hold tty->buf.lock
437 static struct tty_buffer *tty_buffer_find(struct tty_struct *tty, size_t size)
439 struct tty_buffer **tbh = &tty->buf.free;
440 while ((*tbh) != NULL) {
441 struct tty_buffer *t = *tbh;
442 if (t->size >= size) {
448 tty->buf.memory_used += t->size;
451 tbh = &((*tbh)->next);
453 /* Round the buffer size out */
454 size = (size + 0xFF) & ~0xFF;
455 return tty_buffer_alloc(tty, size);
456 /* Should possibly check if this fails for the largest buffer we
457 have queued and recycle that ? */
461 * tty_buffer_request_room - grow tty buffer if needed
462 * @tty: tty structure
463 * @size: size desired
465 * Make at least size bytes of linear space available for the tty
466 * buffer. If we fail return the size we managed to find.
468 * Locking: Takes tty->buf.lock
470 int tty_buffer_request_room(struct tty_struct *tty, size_t size)
472 struct tty_buffer *b, *n;
476 spin_lock_irqsave(&tty->buf.lock, flags);
478 /* OPTIMISATION: We could keep a per tty "zero" sized buffer to
479 remove this conditional if its worth it. This would be invisible
481 if ((b = tty->buf.tail) != NULL)
482 left = b->size - b->used;
487 /* This is the slow path - looking for new buffers to use */
488 if ((n = tty_buffer_find(tty, size)) != NULL) {
499 spin_unlock_irqrestore(&tty->buf.lock, flags);
502 EXPORT_SYMBOL_GPL(tty_buffer_request_room);
505 * tty_insert_flip_string - Add characters to the tty buffer
506 * @tty: tty structure
510 * Queue a series of bytes to the tty buffering. All the characters
511 * passed are marked as without error. Returns the number added.
513 * Locking: Called functions may take tty->buf.lock
516 int tty_insert_flip_string(struct tty_struct *tty, const unsigned char *chars,
521 int space = tty_buffer_request_room(tty, size - copied);
522 struct tty_buffer *tb = tty->buf.tail;
523 /* If there is no space then tb may be NULL */
524 if (unlikely(space == 0))
526 memcpy(tb->char_buf_ptr + tb->used, chars, space);
527 memset(tb->flag_buf_ptr + tb->used, TTY_NORMAL, space);
531 /* There is a small chance that we need to split the data over
532 several buffers. If this is the case we must loop */
533 } while (unlikely(size > copied));
536 EXPORT_SYMBOL(tty_insert_flip_string);
539 * tty_insert_flip_string_flags - Add characters to the tty buffer
540 * @tty: tty structure
545 * Queue a series of bytes to the tty buffering. For each character
546 * the flags array indicates the status of the character. Returns the
549 * Locking: Called functions may take tty->buf.lock
552 int tty_insert_flip_string_flags(struct tty_struct *tty,
553 const unsigned char *chars, const char *flags, size_t size)
557 int space = tty_buffer_request_room(tty, size - copied);
558 struct tty_buffer *tb = tty->buf.tail;
559 /* If there is no space then tb may be NULL */
560 if (unlikely(space == 0))
562 memcpy(tb->char_buf_ptr + tb->used, chars, space);
563 memcpy(tb->flag_buf_ptr + tb->used, flags, space);
568 /* There is a small chance that we need to split the data over
569 several buffers. If this is the case we must loop */
570 } while (unlikely(size > copied));
573 EXPORT_SYMBOL(tty_insert_flip_string_flags);
576 * tty_schedule_flip - push characters to ldisc
577 * @tty: tty to push from
579 * Takes any pending buffers and transfers their ownership to the
580 * ldisc side of the queue. It then schedules those characters for
581 * processing by the line discipline.
583 * Locking: Takes tty->buf.lock
586 void tty_schedule_flip(struct tty_struct *tty)
589 spin_lock_irqsave(&tty->buf.lock, flags);
590 if (tty->buf.tail != NULL)
591 tty->buf.tail->commit = tty->buf.tail->used;
592 spin_unlock_irqrestore(&tty->buf.lock, flags);
593 schedule_delayed_work(&tty->buf.work, 1);
595 EXPORT_SYMBOL(tty_schedule_flip);
598 * tty_prepare_flip_string - make room for characters
600 * @chars: return pointer for character write area
601 * @size: desired size
603 * Prepare a block of space in the buffer for data. Returns the length
604 * available and buffer pointer to the space which is now allocated and
605 * accounted for as ready for normal characters. This is used for drivers
606 * that need their own block copy routines into the buffer. There is no
607 * guarantee the buffer is a DMA target!
609 * Locking: May call functions taking tty->buf.lock
612 int tty_prepare_flip_string(struct tty_struct *tty, unsigned char **chars,
615 int space = tty_buffer_request_room(tty, size);
617 struct tty_buffer *tb = tty->buf.tail;
618 *chars = tb->char_buf_ptr + tb->used;
619 memset(tb->flag_buf_ptr + tb->used, TTY_NORMAL, space);
625 EXPORT_SYMBOL_GPL(tty_prepare_flip_string);
628 * tty_prepare_flip_string_flags - make room for characters
630 * @chars: return pointer for character write area
631 * @flags: return pointer for status flag write area
632 * @size: desired size
634 * Prepare a block of space in the buffer for data. Returns the length
635 * available and buffer pointer to the space which is now allocated and
636 * accounted for as ready for characters. This is used for drivers
637 * that need their own block copy routines into the buffer. There is no
638 * guarantee the buffer is a DMA target!
640 * Locking: May call functions taking tty->buf.lock
643 int tty_prepare_flip_string_flags(struct tty_struct *tty,
644 unsigned char **chars, char **flags, size_t size)
646 int space = tty_buffer_request_room(tty, size);
648 struct tty_buffer *tb = tty->buf.tail;
649 *chars = tb->char_buf_ptr + tb->used;
650 *flags = tb->flag_buf_ptr + tb->used;
656 EXPORT_SYMBOL_GPL(tty_prepare_flip_string_flags);
661 * tty_set_termios_ldisc - set ldisc field
662 * @tty: tty structure
663 * @num: line discipline number
665 * This is probably overkill for real world processors but
666 * they are not on hot paths so a little discipline won't do
669 * Locking: takes termios_mutex
672 static void tty_set_termios_ldisc(struct tty_struct *tty, int num)
674 mutex_lock(&tty->termios_mutex);
675 tty->termios->c_line = num;
676 mutex_unlock(&tty->termios_mutex);
680 * This guards the refcounted line discipline lists. The lock
681 * must be taken with irqs off because there are hangup path
682 * callers who will do ldisc lookups and cannot sleep.
685 static DEFINE_SPINLOCK(tty_ldisc_lock);
686 static DECLARE_WAIT_QUEUE_HEAD(tty_ldisc_wait);
687 /* Line disc dispatch table */
688 static struct tty_ldisc tty_ldiscs[NR_LDISCS];
691 * tty_register_ldisc - install a line discipline
692 * @disc: ldisc number
693 * @new_ldisc: pointer to the ldisc object
695 * Installs a new line discipline into the kernel. The discipline
696 * is set up as unreferenced and then made available to the kernel
697 * from this point onwards.
700 * takes tty_ldisc_lock to guard against ldisc races
703 int tty_register_ldisc(int disc, struct tty_ldisc *new_ldisc)
708 if (disc < N_TTY || disc >= NR_LDISCS)
711 spin_lock_irqsave(&tty_ldisc_lock, flags);
712 tty_ldiscs[disc] = *new_ldisc;
713 tty_ldiscs[disc].num = disc;
714 tty_ldiscs[disc].flags |= LDISC_FLAG_DEFINED;
715 tty_ldiscs[disc].refcount = 0;
716 spin_unlock_irqrestore(&tty_ldisc_lock, flags);
720 EXPORT_SYMBOL(tty_register_ldisc);
723 * tty_unregister_ldisc - unload a line discipline
724 * @disc: ldisc number
725 * @new_ldisc: pointer to the ldisc object
727 * Remove a line discipline from the kernel providing it is not
731 * takes tty_ldisc_lock to guard against ldisc races
734 int tty_unregister_ldisc(int disc)
739 if (disc < N_TTY || disc >= NR_LDISCS)
742 spin_lock_irqsave(&tty_ldisc_lock, flags);
743 if (tty_ldiscs[disc].refcount)
746 tty_ldiscs[disc].flags &= ~LDISC_FLAG_DEFINED;
747 spin_unlock_irqrestore(&tty_ldisc_lock, flags);
751 EXPORT_SYMBOL(tty_unregister_ldisc);
754 * tty_ldisc_get - take a reference to an ldisc
755 * @disc: ldisc number
757 * Takes a reference to a line discipline. Deals with refcounts and
758 * module locking counts. Returns NULL if the discipline is not available.
759 * Returns a pointer to the discipline and bumps the ref count if it is
763 * takes tty_ldisc_lock to guard against ldisc races
766 struct tty_ldisc *tty_ldisc_get(int disc)
769 struct tty_ldisc *ld;
771 if (disc < N_TTY || disc >= NR_LDISCS)
774 spin_lock_irqsave(&tty_ldisc_lock, flags);
776 ld = &tty_ldiscs[disc];
777 /* Check the entry is defined */
778 if (ld->flags & LDISC_FLAG_DEFINED) {
779 /* If the module is being unloaded we can't use it */
780 if (!try_module_get(ld->owner))
786 spin_unlock_irqrestore(&tty_ldisc_lock, flags);
790 EXPORT_SYMBOL_GPL(tty_ldisc_get);
793 * tty_ldisc_put - drop ldisc reference
794 * @disc: ldisc number
796 * Drop a reference to a line discipline. Manage refcounts and
797 * module usage counts
800 * takes tty_ldisc_lock to guard against ldisc races
803 void tty_ldisc_put(int disc)
805 struct tty_ldisc *ld;
808 BUG_ON(disc < N_TTY || disc >= NR_LDISCS);
810 spin_lock_irqsave(&tty_ldisc_lock, flags);
811 ld = &tty_ldiscs[disc];
812 BUG_ON(ld->refcount == 0);
814 module_put(ld->owner);
815 spin_unlock_irqrestore(&tty_ldisc_lock, flags);
818 EXPORT_SYMBOL_GPL(tty_ldisc_put);
821 * tty_ldisc_assign - set ldisc on a tty
822 * @tty: tty to assign
823 * @ld: line discipline
825 * Install an instance of a line discipline into a tty structure. The
826 * ldisc must have a reference count above zero to ensure it remains/
827 * The tty instance refcount starts at zero.
830 * Caller must hold references
833 static void tty_ldisc_assign(struct tty_struct *tty, struct tty_ldisc *ld)
836 tty->ldisc.refcount = 0;
840 * tty_ldisc_try - internal helper
843 * Make a single attempt to grab and bump the refcount on
844 * the tty ldisc. Return 0 on failure or 1 on success. This is
845 * used to implement both the waiting and non waiting versions
848 * Locking: takes tty_ldisc_lock
851 static int tty_ldisc_try(struct tty_struct *tty)
854 struct tty_ldisc *ld;
857 spin_lock_irqsave(&tty_ldisc_lock, flags);
859 if (test_bit(TTY_LDISC, &tty->flags)) {
863 spin_unlock_irqrestore(&tty_ldisc_lock, flags);
868 * tty_ldisc_ref_wait - wait for the tty ldisc
871 * Dereference the line discipline for the terminal and take a
872 * reference to it. If the line discipline is in flux then
873 * wait patiently until it changes.
875 * Note: Must not be called from an IRQ/timer context. The caller
876 * must also be careful not to hold other locks that will deadlock
877 * against a discipline change, such as an existing ldisc reference
878 * (which we check for)
880 * Locking: call functions take tty_ldisc_lock
883 struct tty_ldisc *tty_ldisc_ref_wait(struct tty_struct *tty)
885 /* wait_event is a macro */
886 wait_event(tty_ldisc_wait, tty_ldisc_try(tty));
887 if (tty->ldisc.refcount == 0)
888 printk(KERN_ERR "tty_ldisc_ref_wait\n");
892 EXPORT_SYMBOL_GPL(tty_ldisc_ref_wait);
895 * tty_ldisc_ref - get the tty ldisc
898 * Dereference the line discipline for the terminal and take a
899 * reference to it. If the line discipline is in flux then
900 * return NULL. Can be called from IRQ and timer functions.
902 * Locking: called functions take tty_ldisc_lock
905 struct tty_ldisc *tty_ldisc_ref(struct tty_struct *tty)
907 if (tty_ldisc_try(tty))
912 EXPORT_SYMBOL_GPL(tty_ldisc_ref);
915 * tty_ldisc_deref - free a tty ldisc reference
916 * @ld: reference to free up
918 * Undoes the effect of tty_ldisc_ref or tty_ldisc_ref_wait. May
919 * be called in IRQ context.
921 * Locking: takes tty_ldisc_lock
924 void tty_ldisc_deref(struct tty_ldisc *ld)
930 spin_lock_irqsave(&tty_ldisc_lock, flags);
931 if (ld->refcount == 0)
932 printk(KERN_ERR "tty_ldisc_deref: no references.\n");
935 if (ld->refcount == 0)
936 wake_up(&tty_ldisc_wait);
937 spin_unlock_irqrestore(&tty_ldisc_lock, flags);
940 EXPORT_SYMBOL_GPL(tty_ldisc_deref);
943 * tty_ldisc_enable - allow ldisc use
944 * @tty: terminal to activate ldisc on
946 * Set the TTY_LDISC flag when the line discipline can be called
947 * again. Do necessary wakeups for existing sleepers.
949 * Note: nobody should set this bit except via this function. Clearing
950 * directly is allowed.
953 static void tty_ldisc_enable(struct tty_struct *tty)
955 set_bit(TTY_LDISC, &tty->flags);
956 wake_up(&tty_ldisc_wait);
960 * tty_set_ldisc - set line discipline
961 * @tty: the terminal to set
962 * @ldisc: the line discipline
964 * Set the discipline of a tty line. Must be called from a process
967 * Locking: takes tty_ldisc_lock.
968 * called functions take termios_mutex
971 static int tty_set_ldisc(struct tty_struct *tty, int ldisc)
974 struct tty_ldisc o_ldisc;
978 struct tty_ldisc *ld;
979 struct tty_struct *o_tty;
981 if ((ldisc < N_TTY) || (ldisc >= NR_LDISCS))
986 ld = tty_ldisc_get(ldisc);
987 /* Eduardo Blanco <ejbs@cs.cs.com.uy> */
988 /* Cyrus Durgin <cider@speakeasy.org> */
990 request_module("tty-ldisc-%d", ldisc);
991 ld = tty_ldisc_get(ldisc);
997 * Problem: What do we do if this blocks ?
1000 tty_wait_until_sent(tty, 0);
1002 if (tty->ldisc.num == ldisc) {
1003 tty_ldisc_put(ldisc);
1008 * No more input please, we are switching. The new ldisc
1009 * will update this value in the ldisc open function
1012 tty->receive_room = 0;
1014 o_ldisc = tty->ldisc;
1018 * Make sure we don't change while someone holds a
1019 * reference to the line discipline. The TTY_LDISC bit
1020 * prevents anyone taking a reference once it is clear.
1021 * We need the lock to avoid racing reference takers.
1024 spin_lock_irqsave(&tty_ldisc_lock, flags);
1025 if (tty->ldisc.refcount || (o_tty && o_tty->ldisc.refcount)) {
1026 if (tty->ldisc.refcount) {
1027 /* Free the new ldisc we grabbed. Must drop the lock
1029 spin_unlock_irqrestore(&tty_ldisc_lock, flags);
1030 tty_ldisc_put(ldisc);
1032 * There are several reasons we may be busy, including
1033 * random momentary I/O traffic. We must therefore
1034 * retry. We could distinguish between blocking ops
1035 * and retries if we made tty_ldisc_wait() smarter.
1036 * That is up for discussion.
1038 if (wait_event_interruptible(tty_ldisc_wait, tty->ldisc.refcount == 0) < 0)
1039 return -ERESTARTSYS;
1042 if (o_tty && o_tty->ldisc.refcount) {
1043 spin_unlock_irqrestore(&tty_ldisc_lock, flags);
1044 tty_ldisc_put(ldisc);
1045 if (wait_event_interruptible(tty_ldisc_wait, o_tty->ldisc.refcount == 0) < 0)
1046 return -ERESTARTSYS;
1051 * If the TTY_LDISC bit is set, then we are racing against
1052 * another ldisc change
1054 if (!test_bit(TTY_LDISC, &tty->flags)) {
1055 spin_unlock_irqrestore(&tty_ldisc_lock, flags);
1056 tty_ldisc_put(ldisc);
1057 ld = tty_ldisc_ref_wait(tty);
1058 tty_ldisc_deref(ld);
1062 clear_bit(TTY_LDISC, &tty->flags);
1064 clear_bit(TTY_LDISC, &o_tty->flags);
1065 spin_unlock_irqrestore(&tty_ldisc_lock, flags);
1068 * From this point on we know nobody has an ldisc
1069 * usage reference, nor can they obtain one until
1070 * we say so later on.
1073 work = cancel_delayed_work(&tty->buf.work);
1075 * Wait for ->hangup_work and ->buf.work handlers to terminate
1077 flush_scheduled_work();
1078 /* Shutdown the current discipline. */
1079 if (tty->ldisc.close)
1080 (tty->ldisc.close)(tty);
1082 /* Now set up the new line discipline. */
1083 tty_ldisc_assign(tty, ld);
1084 tty_set_termios_ldisc(tty, ldisc);
1085 if (tty->ldisc.open)
1086 retval = (tty->ldisc.open)(tty);
1088 tty_ldisc_put(ldisc);
1089 /* There is an outstanding reference here so this is safe */
1090 tty_ldisc_assign(tty, tty_ldisc_get(o_ldisc.num));
1091 tty_set_termios_ldisc(tty, tty->ldisc.num);
1092 if (tty->ldisc.open && (tty->ldisc.open(tty) < 0)) {
1093 tty_ldisc_put(o_ldisc.num);
1094 /* This driver is always present */
1095 tty_ldisc_assign(tty, tty_ldisc_get(N_TTY));
1096 tty_set_termios_ldisc(tty, N_TTY);
1097 if (tty->ldisc.open) {
1098 int r = tty->ldisc.open(tty);
1101 panic("Couldn't open N_TTY ldisc for "
1103 tty_name(tty, buf), r);
1107 /* At this point we hold a reference to the new ldisc and a
1108 a reference to the old ldisc. If we ended up flipping back
1109 to the existing ldisc we have two references to it */
1111 if (tty->ldisc.num != o_ldisc.num && tty->driver->set_ldisc)
1112 tty->driver->set_ldisc(tty);
1114 tty_ldisc_put(o_ldisc.num);
1117 * Allow ldisc referencing to occur as soon as the driver
1118 * ldisc callback completes.
1121 tty_ldisc_enable(tty);
1123 tty_ldisc_enable(o_tty);
1125 /* Restart it in case no characters kick it off. Safe if
1128 schedule_delayed_work(&tty->buf.work, 1);
1133 * get_tty_driver - find device of a tty
1134 * @dev_t: device identifier
1135 * @index: returns the index of the tty
1137 * This routine returns a tty driver structure, given a device number
1138 * and also passes back the index number.
1140 * Locking: caller must hold tty_mutex
1143 static struct tty_driver *get_tty_driver(dev_t device, int *index)
1145 struct tty_driver *p;
1147 list_for_each_entry(p, &tty_drivers, tty_drivers) {
1148 dev_t base = MKDEV(p->major, p->minor_start);
1149 if (device < base || device >= base + p->num)
1151 *index = device - base;
1157 #ifdef CONFIG_CONSOLE_POLL
1160 * tty_find_polling_driver - find device of a polled tty
1161 * @name: name string to match
1162 * @line: pointer to resulting tty line nr
1164 * This routine returns a tty driver structure, given a name
1165 * and the condition that the tty driver is capable of polled
1168 struct tty_driver *tty_find_polling_driver(char *name, int *line)
1170 struct tty_driver *p, *res = NULL;
1174 mutex_lock(&tty_mutex);
1175 /* Search through the tty devices to look for a match */
1176 list_for_each_entry(p, &tty_drivers, tty_drivers) {
1177 str = name + strlen(p->name);
1178 tty_line = simple_strtoul(str, &str, 10);
1184 if (tty_line >= 0 && tty_line <= p->num && p->poll_init &&
1185 !p->poll_init(p, tty_line, str)) {
1192 mutex_unlock(&tty_mutex);
1196 EXPORT_SYMBOL_GPL(tty_find_polling_driver);
1200 * tty_check_change - check for POSIX terminal changes
1201 * @tty: tty to check
1203 * If we try to write to, or set the state of, a terminal and we're
1204 * not in the foreground, send a SIGTTOU. If the signal is blocked or
1205 * ignored, go ahead and perform the operation. (POSIX 7.2)
1207 * Locking: none - FIXME: review this
1210 int tty_check_change(struct tty_struct *tty)
1212 if (current->signal->tty != tty)
1215 printk(KERN_WARNING "tty_check_change: tty->pgrp == NULL!\n");
1218 if (task_pgrp(current) == tty->pgrp)
1220 if (is_ignored(SIGTTOU))
1222 if (is_current_pgrp_orphaned())
1224 kill_pgrp(task_pgrp(current), SIGTTOU, 1);
1225 set_thread_flag(TIF_SIGPENDING);
1226 return -ERESTARTSYS;
1229 EXPORT_SYMBOL(tty_check_change);
1231 static ssize_t hung_up_tty_read(struct file *file, char __user *buf,
1232 size_t count, loff_t *ppos)
1237 static ssize_t hung_up_tty_write(struct file *file, const char __user *buf,
1238 size_t count, loff_t *ppos)
1243 /* No kernel lock held - none needed ;) */
1244 static unsigned int hung_up_tty_poll(struct file *filp, poll_table *wait)
1246 return POLLIN | POLLOUT | POLLERR | POLLHUP | POLLRDNORM | POLLWRNORM;
1249 static long hung_up_tty_ioctl(struct file *file, unsigned int cmd,
1252 return cmd == TIOCSPGRP ? -ENOTTY : -EIO;
1255 static long hung_up_tty_compat_ioctl(struct file *file,
1256 unsigned int cmd, unsigned long arg)
1258 return cmd == TIOCSPGRP ? -ENOTTY : -EIO;
1261 static const struct file_operations tty_fops = {
1262 .llseek = no_llseek,
1266 .unlocked_ioctl = tty_ioctl,
1267 .compat_ioctl = tty_compat_ioctl,
1269 .release = tty_release,
1270 .fasync = tty_fasync,
1273 #ifdef CONFIG_UNIX98_PTYS
1274 static const struct file_operations ptmx_fops = {
1275 .llseek = no_llseek,
1279 .unlocked_ioctl = tty_ioctl,
1280 .compat_ioctl = tty_compat_ioctl,
1282 .release = tty_release,
1283 .fasync = tty_fasync,
1287 static const struct file_operations console_fops = {
1288 .llseek = no_llseek,
1290 .write = redirected_tty_write,
1292 .unlocked_ioctl = tty_ioctl,
1293 .compat_ioctl = tty_compat_ioctl,
1295 .release = tty_release,
1296 .fasync = tty_fasync,
1299 static const struct file_operations hung_up_tty_fops = {
1300 .llseek = no_llseek,
1301 .read = hung_up_tty_read,
1302 .write = hung_up_tty_write,
1303 .poll = hung_up_tty_poll,
1304 .unlocked_ioctl = hung_up_tty_ioctl,
1305 .compat_ioctl = hung_up_tty_compat_ioctl,
1306 .release = tty_release,
1309 static DEFINE_SPINLOCK(redirect_lock);
1310 static struct file *redirect;
1313 * tty_wakeup - request more data
1316 * Internal and external helper for wakeups of tty. This function
1317 * informs the line discipline if present that the driver is ready
1318 * to receive more output data.
1321 void tty_wakeup(struct tty_struct *tty)
1323 struct tty_ldisc *ld;
1325 if (test_bit(TTY_DO_WRITE_WAKEUP, &tty->flags)) {
1326 ld = tty_ldisc_ref(tty);
1328 if (ld->write_wakeup)
1329 ld->write_wakeup(tty);
1330 tty_ldisc_deref(ld);
1333 wake_up_interruptible(&tty->write_wait);
1336 EXPORT_SYMBOL_GPL(tty_wakeup);
1339 * tty_ldisc_flush - flush line discipline queue
1342 * Flush the line discipline queue (if any) for this tty. If there
1343 * is no line discipline active this is a no-op.
1346 void tty_ldisc_flush(struct tty_struct *tty)
1348 struct tty_ldisc *ld = tty_ldisc_ref(tty);
1350 if (ld->flush_buffer)
1351 ld->flush_buffer(tty);
1352 tty_ldisc_deref(ld);
1354 tty_buffer_flush(tty);
1357 EXPORT_SYMBOL_GPL(tty_ldisc_flush);
1360 * tty_reset_termios - reset terminal state
1361 * @tty: tty to reset
1363 * Restore a terminal to the driver default state
1366 static void tty_reset_termios(struct tty_struct *tty)
1368 mutex_lock(&tty->termios_mutex);
1369 *tty->termios = tty->driver->init_termios;
1370 tty->termios->c_ispeed = tty_termios_input_baud_rate(tty->termios);
1371 tty->termios->c_ospeed = tty_termios_baud_rate(tty->termios);
1372 mutex_unlock(&tty->termios_mutex);
1376 * do_tty_hangup - actual handler for hangup events
1379 * This can be called by the "eventd" kernel thread. That is process
1380 * synchronous but doesn't hold any locks, so we need to make sure we
1381 * have the appropriate locks for what we're doing.
1383 * The hangup event clears any pending redirections onto the hung up
1384 * device. It ensures future writes will error and it does the needed
1385 * line discipline hangup and signal delivery. The tty object itself
1390 * redirect lock for undoing redirection
1391 * file list lock for manipulating list of ttys
1392 * tty_ldisc_lock from called functions
1393 * termios_mutex resetting termios data
1394 * tasklist_lock to walk task list for hangup event
1395 * ->siglock to protect ->signal/->sighand
1397 static void do_tty_hangup(struct work_struct *work)
1399 struct tty_struct *tty =
1400 container_of(work, struct tty_struct, hangup_work);
1401 struct file *cons_filp = NULL;
1402 struct file *filp, *f = NULL;
1403 struct task_struct *p;
1404 struct tty_ldisc *ld;
1405 int closecount = 0, n;
1410 /* inuse_filps is protected by the single kernel lock */
1413 spin_lock(&redirect_lock);
1414 if (redirect && redirect->private_data == tty) {
1418 spin_unlock(&redirect_lock);
1420 check_tty_count(tty, "do_tty_hangup");
1422 /* This breaks for file handles being sent over AF_UNIX sockets ? */
1423 list_for_each_entry(filp, &tty->tty_files, f_u.fu_list) {
1424 if (filp->f_op->write == redirected_tty_write)
1426 if (filp->f_op->write != tty_write)
1429 tty_fasync(-1, filp, 0); /* can't block */
1430 filp->f_op = &hung_up_tty_fops;
1434 * FIXME! What are the locking issues here? This may me overdoing
1435 * things... This question is especially important now that we've
1436 * removed the irqlock.
1438 ld = tty_ldisc_ref(tty);
1440 /* We may have no line discipline at this point */
1441 if (ld->flush_buffer)
1442 ld->flush_buffer(tty);
1443 if (tty->driver->flush_buffer)
1444 tty->driver->flush_buffer(tty);
1445 if ((test_bit(TTY_DO_WRITE_WAKEUP, &tty->flags)) &&
1447 ld->write_wakeup(tty);
1452 * FIXME: Once we trust the LDISC code better we can wait here for
1453 * ldisc completion and fix the driver call race
1455 wake_up_interruptible(&tty->write_wait);
1456 wake_up_interruptible(&tty->read_wait);
1458 * Shutdown the current line discipline, and reset it to
1461 if (tty->driver->flags & TTY_DRIVER_RESET_TERMIOS)
1462 tty_reset_termios(tty);
1463 /* Defer ldisc switch */
1464 /* tty_deferred_ldisc_switch(N_TTY);
1466 This should get done automatically when the port closes and
1467 tty_release is called */
1469 read_lock(&tasklist_lock);
1471 do_each_pid_task(tty->session, PIDTYPE_SID, p) {
1472 spin_lock_irq(&p->sighand->siglock);
1473 if (p->signal->tty == tty)
1474 p->signal->tty = NULL;
1475 if (!p->signal->leader) {
1476 spin_unlock_irq(&p->sighand->siglock);
1479 __group_send_sig_info(SIGHUP, SEND_SIG_PRIV, p);
1480 __group_send_sig_info(SIGCONT, SEND_SIG_PRIV, p);
1481 put_pid(p->signal->tty_old_pgrp); /* A noop */
1483 p->signal->tty_old_pgrp = get_pid(tty->pgrp);
1484 spin_unlock_irq(&p->sighand->siglock);
1485 } while_each_pid_task(tty->session, PIDTYPE_SID, p);
1487 read_unlock(&tasklist_lock);
1490 put_pid(tty->session);
1492 tty->session = NULL;
1494 tty->ctrl_status = 0;
1496 * If one of the devices matches a console pointer, we
1497 * cannot just call hangup() because that will cause
1498 * tty->count and state->count to go out of sync.
1499 * So we just call close() the right number of times.
1502 if (tty->driver->close)
1503 for (n = 0; n < closecount; n++)
1504 tty->driver->close(tty, cons_filp);
1505 } else if (tty->driver->hangup)
1506 (tty->driver->hangup)(tty);
1508 * We don't want to have driver/ldisc interactions beyond
1509 * the ones we did here. The driver layer expects no
1510 * calls after ->hangup() from the ldisc side. However we
1511 * can't yet guarantee all that.
1513 set_bit(TTY_HUPPED, &tty->flags);
1515 tty_ldisc_enable(tty);
1516 tty_ldisc_deref(ld);
1524 * tty_hangup - trigger a hangup event
1525 * @tty: tty to hangup
1527 * A carrier loss (virtual or otherwise) has occurred on this like
1528 * schedule a hangup sequence to run after this event.
1531 void tty_hangup(struct tty_struct *tty)
1533 #ifdef TTY_DEBUG_HANGUP
1535 printk(KERN_DEBUG "%s hangup...\n", tty_name(tty, buf));
1537 schedule_work(&tty->hangup_work);
1540 EXPORT_SYMBOL(tty_hangup);
1543 * tty_vhangup - process vhangup
1544 * @tty: tty to hangup
1546 * The user has asked via system call for the terminal to be hung up.
1547 * We do this synchronously so that when the syscall returns the process
1548 * is complete. That guarantee is necessary for security reasons.
1551 void tty_vhangup(struct tty_struct *tty)
1553 #ifdef TTY_DEBUG_HANGUP
1556 printk(KERN_DEBUG "%s vhangup...\n", tty_name(tty, buf));
1558 do_tty_hangup(&tty->hangup_work);
1561 EXPORT_SYMBOL(tty_vhangup);
1564 * tty_hung_up_p - was tty hung up
1565 * @filp: file pointer of tty
1567 * Return true if the tty has been subject to a vhangup or a carrier
1571 int tty_hung_up_p(struct file *filp)
1573 return (filp->f_op == &hung_up_tty_fops);
1576 EXPORT_SYMBOL(tty_hung_up_p);
1579 * is_tty - checker whether file is a TTY
1580 * @filp: file handle that may be a tty
1582 * Check if the file handle is a tty handle.
1585 int is_tty(struct file *filp)
1587 return filp->f_op->read == tty_read
1588 || filp->f_op->read == hung_up_tty_read;
1591 static void session_clear_tty(struct pid *session)
1593 struct task_struct *p;
1594 do_each_pid_task(session, PIDTYPE_SID, p) {
1596 } while_each_pid_task(session, PIDTYPE_SID, p);
1600 * disassociate_ctty - disconnect controlling tty
1601 * @on_exit: true if exiting so need to "hang up" the session
1603 * This function is typically called only by the session leader, when
1604 * it wants to disassociate itself from its controlling tty.
1606 * It performs the following functions:
1607 * (1) Sends a SIGHUP and SIGCONT to the foreground process group
1608 * (2) Clears the tty from being controlling the session
1609 * (3) Clears the controlling tty for all processes in the
1612 * The argument on_exit is set to 1 if called when a process is
1613 * exiting; it is 0 if called by the ioctl TIOCNOTTY.
1616 * BKL is taken for hysterical raisins
1617 * tty_mutex is taken to protect tty
1618 * ->siglock is taken to protect ->signal/->sighand
1619 * tasklist_lock is taken to walk process list for sessions
1620 * ->siglock is taken to protect ->signal/->sighand
1623 void disassociate_ctty(int on_exit)
1625 struct tty_struct *tty;
1626 struct pid *tty_pgrp = NULL;
1629 mutex_lock(&tty_mutex);
1630 tty = get_current_tty();
1632 tty_pgrp = get_pid(tty->pgrp);
1633 mutex_unlock(&tty_mutex);
1635 /* XXX: here we race, there is nothing protecting tty */
1636 if (on_exit && tty->driver->type != TTY_DRIVER_TYPE_PTY)
1639 } else if (on_exit) {
1640 struct pid *old_pgrp;
1641 spin_lock_irq(¤t->sighand->siglock);
1642 old_pgrp = current->signal->tty_old_pgrp;
1643 current->signal->tty_old_pgrp = NULL;
1644 spin_unlock_irq(¤t->sighand->siglock);
1646 kill_pgrp(old_pgrp, SIGHUP, on_exit);
1647 kill_pgrp(old_pgrp, SIGCONT, on_exit);
1650 mutex_unlock(&tty_mutex);
1654 kill_pgrp(tty_pgrp, SIGHUP, on_exit);
1656 kill_pgrp(tty_pgrp, SIGCONT, on_exit);
1660 spin_lock_irq(¤t->sighand->siglock);
1661 put_pid(current->signal->tty_old_pgrp);
1662 current->signal->tty_old_pgrp = NULL;
1663 spin_unlock_irq(¤t->sighand->siglock);
1665 mutex_lock(&tty_mutex);
1666 /* It is possible that do_tty_hangup has free'd this tty */
1667 tty = get_current_tty();
1669 put_pid(tty->session);
1671 tty->session = NULL;
1674 #ifdef TTY_DEBUG_HANGUP
1675 printk(KERN_DEBUG "error attempted to write to tty [0x%p]"
1679 mutex_unlock(&tty_mutex);
1681 /* Now clear signal->tty under the lock */
1682 read_lock(&tasklist_lock);
1683 session_clear_tty(task_session(current));
1684 read_unlock(&tasklist_lock);
1689 * no_tty - Ensure the current process does not have a controlling tty
1693 struct task_struct *tsk = current;
1695 if (tsk->signal->leader)
1696 disassociate_ctty(0);
1698 proc_clear_tty(tsk);
1703 * stop_tty - propagate flow control
1706 * Perform flow control to the driver. For PTY/TTY pairs we
1707 * must also propagate the TIOCKPKT status. May be called
1708 * on an already stopped device and will not re-call the driver
1711 * This functionality is used by both the line disciplines for
1712 * halting incoming flow and by the driver. It may therefore be
1713 * called from any context, may be under the tty atomic_write_lock
1717 * Uses the tty control lock internally
1720 void stop_tty(struct tty_struct *tty)
1722 unsigned long flags;
1723 spin_lock_irqsave(&tty->ctrl_lock, flags);
1725 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
1729 if (tty->link && tty->link->packet) {
1730 tty->ctrl_status &= ~TIOCPKT_START;
1731 tty->ctrl_status |= TIOCPKT_STOP;
1732 wake_up_interruptible(&tty->link->read_wait);
1734 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
1735 if (tty->driver->stop)
1736 (tty->driver->stop)(tty);
1739 EXPORT_SYMBOL(stop_tty);
1742 * start_tty - propagate flow control
1743 * @tty: tty to start
1745 * Start a tty that has been stopped if at all possible. Perform
1746 * any necessary wakeups and propagate the TIOCPKT status. If this
1747 * is the tty was previous stopped and is being started then the
1748 * driver start method is invoked and the line discipline woken.
1754 void start_tty(struct tty_struct *tty)
1756 unsigned long flags;
1757 spin_lock_irqsave(&tty->ctrl_lock, flags);
1758 if (!tty->stopped || tty->flow_stopped) {
1759 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
1763 if (tty->link && tty->link->packet) {
1764 tty->ctrl_status &= ~TIOCPKT_STOP;
1765 tty->ctrl_status |= TIOCPKT_START;
1766 wake_up_interruptible(&tty->link->read_wait);
1768 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
1769 if (tty->driver->start)
1770 (tty->driver->start)(tty);
1771 /* If we have a running line discipline it may need kicking */
1775 EXPORT_SYMBOL(start_tty);
1778 * tty_read - read method for tty device files
1779 * @file: pointer to tty file
1781 * @count: size of user buffer
1784 * Perform the read system call function on this terminal device. Checks
1785 * for hung up devices before calling the line discipline method.
1788 * Locks the line discipline internally while needed
1789 * For historical reasons the line discipline read method is
1790 * invoked under the BKL. This will go away in time so do not rely on it
1791 * in new code. Multiple read calls may be outstanding in parallel.
1794 static ssize_t tty_read(struct file *file, char __user *buf, size_t count,
1798 struct tty_struct *tty;
1799 struct inode *inode;
1800 struct tty_ldisc *ld;
1802 tty = (struct tty_struct *)file->private_data;
1803 inode = file->f_path.dentry->d_inode;
1804 if (tty_paranoia_check(tty, inode, "tty_read"))
1806 if (!tty || (test_bit(TTY_IO_ERROR, &tty->flags)))
1809 /* We want to wait for the line discipline to sort out in this
1811 ld = tty_ldisc_ref_wait(tty);
1813 i = (ld->read)(tty, file, buf, count);
1816 tty_ldisc_deref(ld);
1818 inode->i_atime = current_fs_time(inode->i_sb);
1822 void tty_write_unlock(struct tty_struct *tty)
1824 mutex_unlock(&tty->atomic_write_lock);
1825 wake_up_interruptible(&tty->write_wait);
1828 int tty_write_lock(struct tty_struct *tty, int ndelay)
1830 if (!mutex_trylock(&tty->atomic_write_lock)) {
1833 if (mutex_lock_interruptible(&tty->atomic_write_lock))
1834 return -ERESTARTSYS;
1840 * Split writes up in sane blocksizes to avoid
1841 * denial-of-service type attacks
1843 static inline ssize_t do_tty_write(
1844 ssize_t (*write)(struct tty_struct *, struct file *, const unsigned char *, size_t),
1845 struct tty_struct *tty,
1847 const char __user *buf,
1850 ssize_t ret, written = 0;
1853 ret = tty_write_lock(tty, file->f_flags & O_NDELAY);
1858 * We chunk up writes into a temporary buffer. This
1859 * simplifies low-level drivers immensely, since they
1860 * don't have locking issues and user mode accesses.
1862 * But if TTY_NO_WRITE_SPLIT is set, we should use a
1865 * The default chunk-size is 2kB, because the NTTY
1866 * layer has problems with bigger chunks. It will
1867 * claim to be able to handle more characters than
1870 * FIXME: This can probably go away now except that 64K chunks
1871 * are too likely to fail unless switched to vmalloc...
1874 if (test_bit(TTY_NO_WRITE_SPLIT, &tty->flags))
1879 /* write_buf/write_cnt is protected by the atomic_write_lock mutex */
1880 if (tty->write_cnt < chunk) {
1886 buf = kmalloc(chunk, GFP_KERNEL);
1891 kfree(tty->write_buf);
1892 tty->write_cnt = chunk;
1893 tty->write_buf = buf;
1896 /* Do the write .. */
1898 size_t size = count;
1902 if (copy_from_user(tty->write_buf, buf, size))
1904 ret = write(tty, file, tty->write_buf, size);
1913 if (signal_pending(current))
1918 struct inode *inode = file->f_path.dentry->d_inode;
1919 inode->i_mtime = current_fs_time(inode->i_sb);
1923 tty_write_unlock(tty);
1929 * tty_write - write method for tty device file
1930 * @file: tty file pointer
1931 * @buf: user data to write
1932 * @count: bytes to write
1935 * Write data to a tty device via the line discipline.
1938 * Locks the line discipline as required
1939 * Writes to the tty driver are serialized by the atomic_write_lock
1940 * and are then processed in chunks to the device. The line discipline
1941 * write method will not be involked in parallel for each device
1942 * The line discipline write method is called under the big
1943 * kernel lock for historical reasons. New code should not rely on this.
1946 static ssize_t tty_write(struct file *file, const char __user *buf,
1947 size_t count, loff_t *ppos)
1949 struct tty_struct *tty;
1950 struct inode *inode = file->f_path.dentry->d_inode;
1952 struct tty_ldisc *ld;
1954 tty = (struct tty_struct *)file->private_data;
1955 if (tty_paranoia_check(tty, inode, "tty_write"))
1957 if (!tty || !tty->driver->write ||
1958 (test_bit(TTY_IO_ERROR, &tty->flags)))
1961 ld = tty_ldisc_ref_wait(tty);
1965 ret = do_tty_write(ld->write, tty, file, buf, count);
1966 tty_ldisc_deref(ld);
1970 ssize_t redirected_tty_write(struct file *file, const char __user *buf,
1971 size_t count, loff_t *ppos)
1973 struct file *p = NULL;
1975 spin_lock(&redirect_lock);
1980 spin_unlock(&redirect_lock);
1984 res = vfs_write(p, buf, count, &p->f_pos);
1988 return tty_write(file, buf, count, ppos);
1991 static char ptychar[] = "pqrstuvwxyzabcde";
1994 * pty_line_name - generate name for a pty
1995 * @driver: the tty driver in use
1996 * @index: the minor number
1997 * @p: output buffer of at least 6 bytes
1999 * Generate a name from a driver reference and write it to the output
2004 static void pty_line_name(struct tty_driver *driver, int index, char *p)
2006 int i = index + driver->name_base;
2007 /* ->name is initialized to "ttyp", but "tty" is expected */
2008 sprintf(p, "%s%c%x",
2009 driver->subtype == PTY_TYPE_SLAVE ? "tty" : driver->name,
2010 ptychar[i >> 4 & 0xf], i & 0xf);
2014 * pty_line_name - generate name for a tty
2015 * @driver: the tty driver in use
2016 * @index: the minor number
2017 * @p: output buffer of at least 7 bytes
2019 * Generate a name from a driver reference and write it to the output
2024 static void tty_line_name(struct tty_driver *driver, int index, char *p)
2026 sprintf(p, "%s%d", driver->name, index + driver->name_base);
2030 * init_dev - initialise a tty device
2031 * @driver: tty driver we are opening a device on
2032 * @idx: device index
2033 * @tty: returned tty structure
2035 * Prepare a tty device. This may not be a "new" clean device but
2036 * could also be an active device. The pty drivers require special
2037 * handling because of this.
2040 * The function is called under the tty_mutex, which
2041 * protects us from the tty struct or driver itself going away.
2043 * On exit the tty device has the line discipline attached and
2044 * a reference count of 1. If a pair was created for pty/tty use
2045 * and the other was a pty master then it too has a reference count of 1.
2047 * WSH 06/09/97: Rewritten to remove races and properly clean up after a
2048 * failed open. The new code protects the open with a mutex, so it's
2049 * really quite straightforward. The mutex locking can probably be
2050 * relaxed for the (most common) case of reopening a tty.
2053 static int init_dev(struct tty_driver *driver, int idx,
2054 struct tty_struct **ret_tty)
2056 struct tty_struct *tty, *o_tty;
2057 struct ktermios *tp, **tp_loc, *o_tp, **o_tp_loc;
2058 struct ktermios *ltp, **ltp_loc, *o_ltp, **o_ltp_loc;
2061 /* check whether we're reopening an existing tty */
2062 if (driver->flags & TTY_DRIVER_DEVPTS_MEM) {
2063 tty = devpts_get_tty(idx);
2065 * If we don't have a tty here on a slave open, it's because
2066 * the master already started the close process and there's
2067 * no relation between devpts file and tty anymore.
2069 if (!tty && driver->subtype == PTY_TYPE_SLAVE) {
2074 * It's safe from now on because init_dev() is called with
2075 * tty_mutex held and release_dev() won't change tty->count
2076 * or tty->flags without having to grab tty_mutex
2078 if (tty && driver->subtype == PTY_TYPE_MASTER)
2081 tty = driver->ttys[idx];
2083 if (tty) goto fast_track;
2086 * First time open is complex, especially for PTY devices.
2087 * This code guarantees that either everything succeeds and the
2088 * TTY is ready for operation, or else the table slots are vacated
2089 * and the allocated memory released. (Except that the termios
2090 * and locked termios may be retained.)
2093 if (!try_module_get(driver->owner)) {
2102 tty = alloc_tty_struct();
2105 initialize_tty_struct(tty);
2106 tty->driver = driver;
2108 tty_line_name(driver, idx, tty->name);
2110 if (driver->flags & TTY_DRIVER_DEVPTS_MEM) {
2111 tp_loc = &tty->termios;
2112 ltp_loc = &tty->termios_locked;
2114 tp_loc = &driver->termios[idx];
2115 ltp_loc = &driver->termios_locked[idx];
2119 tp = kmalloc(sizeof(struct ktermios), GFP_KERNEL);
2122 *tp = driver->init_termios;
2126 ltp = kzalloc(sizeof(struct ktermios), GFP_KERNEL);
2131 if (driver->type == TTY_DRIVER_TYPE_PTY) {
2132 o_tty = alloc_tty_struct();
2135 initialize_tty_struct(o_tty);
2136 o_tty->driver = driver->other;
2138 tty_line_name(driver->other, idx, o_tty->name);
2140 if (driver->flags & TTY_DRIVER_DEVPTS_MEM) {
2141 o_tp_loc = &o_tty->termios;
2142 o_ltp_loc = &o_tty->termios_locked;
2144 o_tp_loc = &driver->other->termios[idx];
2145 o_ltp_loc = &driver->other->termios_locked[idx];
2149 o_tp = kmalloc(sizeof(struct ktermios), GFP_KERNEL);
2152 *o_tp = driver->other->init_termios;
2156 o_ltp = kzalloc(sizeof(struct ktermios), GFP_KERNEL);
2162 * Everything allocated ... set up the o_tty structure.
2164 if (!(driver->other->flags & TTY_DRIVER_DEVPTS_MEM))
2165 driver->other->ttys[idx] = o_tty;
2170 o_tty->termios = *o_tp_loc;
2171 o_tty->termios_locked = *o_ltp_loc;
2172 driver->other->refcount++;
2173 if (driver->subtype == PTY_TYPE_MASTER)
2176 /* Establish the links in both directions */
2182 * All structures have been allocated, so now we install them.
2183 * Failures after this point use release_tty to clean up, so
2184 * there's no need to null out the local pointers.
2186 if (!(driver->flags & TTY_DRIVER_DEVPTS_MEM))
2187 driver->ttys[idx] = tty;
2193 tty->termios = *tp_loc;
2194 tty->termios_locked = *ltp_loc;
2195 /* Compatibility until drivers always set this */
2196 tty->termios->c_ispeed = tty_termios_input_baud_rate(tty->termios);
2197 tty->termios->c_ospeed = tty_termios_baud_rate(tty->termios);
2202 * Structures all installed ... call the ldisc open routines.
2203 * If we fail here just call release_tty to clean up. No need
2204 * to decrement the use counts, as release_tty doesn't care.
2207 if (tty->ldisc.open) {
2208 retval = (tty->ldisc.open)(tty);
2210 goto release_mem_out;
2212 if (o_tty && o_tty->ldisc.open) {
2213 retval = (o_tty->ldisc.open)(o_tty);
2215 if (tty->ldisc.close)
2216 (tty->ldisc.close)(tty);
2217 goto release_mem_out;
2219 tty_ldisc_enable(o_tty);
2221 tty_ldisc_enable(tty);
2225 * This fast open can be used if the tty is already open.
2226 * No memory is allocated, and the only failures are from
2227 * attempting to open a closing tty or attempting multiple
2228 * opens on a pty master.
2231 if (test_bit(TTY_CLOSING, &tty->flags)) {
2235 if (driver->type == TTY_DRIVER_TYPE_PTY &&
2236 driver->subtype == PTY_TYPE_MASTER) {
2238 * special case for PTY masters: only one open permitted,
2239 * and the slave side open count is incremented as well.
2248 tty->driver = driver; /* N.B. why do this every time?? */
2251 if (!test_bit(TTY_LDISC, &tty->flags))
2252 printk(KERN_ERR "init_dev but no ldisc\n");
2256 /* All paths come through here to release the mutex */
2260 /* Release locally allocated memory ... nothing placed in slots */
2264 free_tty_struct(o_tty);
2267 free_tty_struct(tty);
2270 module_put(driver->owner);
2274 /* call the tty release_tty routine to clean out this slot */
2276 if (printk_ratelimit())
2277 printk(KERN_INFO "init_dev: ldisc open failed, "
2278 "clearing slot %d\n", idx);
2279 release_tty(tty, idx);
2284 * release_one_tty - release tty structure memory
2286 * Releases memory associated with a tty structure, and clears out the
2287 * driver table slots. This function is called when a device is no longer
2288 * in use. It also gets called when setup of a device fails.
2291 * tty_mutex - sometimes only
2292 * takes the file list lock internally when working on the list
2293 * of ttys that the driver keeps.
2294 * FIXME: should we require tty_mutex is held here ??
2296 static void release_one_tty(struct tty_struct *tty, int idx)
2298 int devpts = tty->driver->flags & TTY_DRIVER_DEVPTS_MEM;
2299 struct ktermios *tp;
2302 tty->driver->ttys[idx] = NULL;
2304 if (tty->driver->flags & TTY_DRIVER_RESET_TERMIOS) {
2307 tty->driver->termios[idx] = NULL;
2310 tp = tty->termios_locked;
2312 tty->driver->termios_locked[idx] = NULL;
2318 tty->driver->refcount--;
2321 list_del_init(&tty->tty_files);
2324 free_tty_struct(tty);
2328 * release_tty - release tty structure memory
2330 * Release both @tty and a possible linked partner (think pty pair),
2331 * and decrement the refcount of the backing module.
2334 * tty_mutex - sometimes only
2335 * takes the file list lock internally when working on the list
2336 * of ttys that the driver keeps.
2337 * FIXME: should we require tty_mutex is held here ??
2339 static void release_tty(struct tty_struct *tty, int idx)
2341 struct tty_driver *driver = tty->driver;
2344 release_one_tty(tty->link, idx);
2345 release_one_tty(tty, idx);
2346 module_put(driver->owner);
2350 * Even releasing the tty structures is a tricky business.. We have
2351 * to be very careful that the structures are all released at the
2352 * same time, as interrupts might otherwise get the wrong pointers.
2354 * WSH 09/09/97: rewritten to avoid some nasty race conditions that could
2355 * lead to double frees or releasing memory still in use.
2357 static void release_dev(struct file *filp)
2359 struct tty_struct *tty, *o_tty;
2360 int pty_master, tty_closing, o_tty_closing, do_sleep;
2364 unsigned long flags;
2366 tty = (struct tty_struct *)filp->private_data;
2367 if (tty_paranoia_check(tty, filp->f_path.dentry->d_inode,
2371 check_tty_count(tty, "release_dev");
2373 tty_fasync(-1, filp, 0);
2376 pty_master = (tty->driver->type == TTY_DRIVER_TYPE_PTY &&
2377 tty->driver->subtype == PTY_TYPE_MASTER);
2378 devpts = (tty->driver->flags & TTY_DRIVER_DEVPTS_MEM) != 0;
2381 #ifdef TTY_PARANOIA_CHECK
2382 if (idx < 0 || idx >= tty->driver->num) {
2383 printk(KERN_DEBUG "release_dev: bad idx when trying to "
2384 "free (%s)\n", tty->name);
2387 if (!(tty->driver->flags & TTY_DRIVER_DEVPTS_MEM)) {
2388 if (tty != tty->driver->ttys[idx]) {
2389 printk(KERN_DEBUG "release_dev: driver.table[%d] not tty "
2390 "for (%s)\n", idx, tty->name);
2393 if (tty->termios != tty->driver->termios[idx]) {
2394 printk(KERN_DEBUG "release_dev: driver.termios[%d] not termios "
2399 if (tty->termios_locked != tty->driver->termios_locked[idx]) {
2400 printk(KERN_DEBUG "release_dev: driver.termios_locked[%d] not "
2401 "termios_locked for (%s)\n",
2408 #ifdef TTY_DEBUG_HANGUP
2409 printk(KERN_DEBUG "release_dev of %s (tty count=%d)...",
2410 tty_name(tty, buf), tty->count);
2413 #ifdef TTY_PARANOIA_CHECK
2414 if (tty->driver->other &&
2415 !(tty->driver->flags & TTY_DRIVER_DEVPTS_MEM)) {
2416 if (o_tty != tty->driver->other->ttys[idx]) {
2417 printk(KERN_DEBUG "release_dev: other->table[%d] "
2418 "not o_tty for (%s)\n",
2422 if (o_tty->termios != tty->driver->other->termios[idx]) {
2423 printk(KERN_DEBUG "release_dev: other->termios[%d] "
2424 "not o_termios for (%s)\n",
2428 if (o_tty->termios_locked !=
2429 tty->driver->other->termios_locked[idx]) {
2430 printk(KERN_DEBUG "release_dev: other->termios_locked["
2431 "%d] not o_termios_locked for (%s)\n",
2435 if (o_tty->link != tty) {
2436 printk(KERN_DEBUG "release_dev: bad pty pointers\n");
2441 if (tty->driver->close)
2442 tty->driver->close(tty, filp);
2445 * Sanity check: if tty->count is going to zero, there shouldn't be
2446 * any waiters on tty->read_wait or tty->write_wait. We test the
2447 * wait queues and kick everyone out _before_ actually starting to
2448 * close. This ensures that we won't block while releasing the tty
2451 * The test for the o_tty closing is necessary, since the master and
2452 * slave sides may close in any order. If the slave side closes out
2453 * first, its count will be one, since the master side holds an open.
2454 * Thus this test wouldn't be triggered at the time the slave closes,
2457 * Note that it's possible for the tty to be opened again while we're
2458 * flushing out waiters. By recalculating the closing flags before
2459 * each iteration we avoid any problems.
2462 /* Guard against races with tty->count changes elsewhere and
2463 opens on /dev/tty */
2465 mutex_lock(&tty_mutex);
2466 tty_closing = tty->count <= 1;
2467 o_tty_closing = o_tty &&
2468 (o_tty->count <= (pty_master ? 1 : 0));
2472 if (waitqueue_active(&tty->read_wait)) {
2473 wake_up(&tty->read_wait);
2476 if (waitqueue_active(&tty->write_wait)) {
2477 wake_up(&tty->write_wait);
2481 if (o_tty_closing) {
2482 if (waitqueue_active(&o_tty->read_wait)) {
2483 wake_up(&o_tty->read_wait);
2486 if (waitqueue_active(&o_tty->write_wait)) {
2487 wake_up(&o_tty->write_wait);
2494 printk(KERN_WARNING "release_dev: %s: read/write wait queue "
2495 "active!\n", tty_name(tty, buf));
2496 mutex_unlock(&tty_mutex);
2501 * The closing flags are now consistent with the open counts on
2502 * both sides, and we've completed the last operation that could
2503 * block, so it's safe to proceed with closing.
2506 if (--o_tty->count < 0) {
2507 printk(KERN_WARNING "release_dev: bad pty slave count "
2509 o_tty->count, tty_name(o_tty, buf));
2513 if (--tty->count < 0) {
2514 printk(KERN_WARNING "release_dev: bad tty->count (%d) for %s\n",
2515 tty->count, tty_name(tty, buf));
2520 * We've decremented tty->count, so we need to remove this file
2521 * descriptor off the tty->tty_files list; this serves two
2523 * - check_tty_count sees the correct number of file descriptors
2524 * associated with this tty.
2525 * - do_tty_hangup no longer sees this file descriptor as
2526 * something that needs to be handled for hangups.
2529 filp->private_data = NULL;
2532 * Perform some housekeeping before deciding whether to return.
2534 * Set the TTY_CLOSING flag if this was the last open. In the
2535 * case of a pty we may have to wait around for the other side
2536 * to close, and TTY_CLOSING makes sure we can't be reopened.
2539 set_bit(TTY_CLOSING, &tty->flags);
2541 set_bit(TTY_CLOSING, &o_tty->flags);
2544 * If _either_ side is closing, make sure there aren't any
2545 * processes that still think tty or o_tty is their controlling
2548 if (tty_closing || o_tty_closing) {
2549 read_lock(&tasklist_lock);
2550 session_clear_tty(tty->session);
2552 session_clear_tty(o_tty->session);
2553 read_unlock(&tasklist_lock);
2556 mutex_unlock(&tty_mutex);
2558 /* check whether both sides are closing ... */
2559 if (!tty_closing || (o_tty && !o_tty_closing))
2562 #ifdef TTY_DEBUG_HANGUP
2563 printk(KERN_DEBUG "freeing tty structure...");
2566 * Prevent flush_to_ldisc() from rescheduling the work for later. Then
2567 * kill any delayed work. As this is the final close it does not
2568 * race with the set_ldisc code path.
2570 clear_bit(TTY_LDISC, &tty->flags);
2571 cancel_delayed_work(&tty->buf.work);
2574 * Wait for ->hangup_work and ->buf.work handlers to terminate
2577 flush_scheduled_work();
2580 * Wait for any short term users (we know they are just driver
2581 * side waiters as the file is closing so user count on the file
2584 spin_lock_irqsave(&tty_ldisc_lock, flags);
2585 while (tty->ldisc.refcount) {
2586 spin_unlock_irqrestore(&tty_ldisc_lock, flags);
2587 wait_event(tty_ldisc_wait, tty->ldisc.refcount == 0);
2588 spin_lock_irqsave(&tty_ldisc_lock, flags);
2590 spin_unlock_irqrestore(&tty_ldisc_lock, flags);
2592 * Shutdown the current line discipline, and reset it to N_TTY.
2593 * N.B. why reset ldisc when we're releasing the memory??
2595 * FIXME: this MUST get fixed for the new reflocking
2597 if (tty->ldisc.close)
2598 (tty->ldisc.close)(tty);
2599 tty_ldisc_put(tty->ldisc.num);
2602 * Switch the line discipline back
2604 tty_ldisc_assign(tty, tty_ldisc_get(N_TTY));
2605 tty_set_termios_ldisc(tty, N_TTY);
2607 /* FIXME: could o_tty be in setldisc here ? */
2608 clear_bit(TTY_LDISC, &o_tty->flags);
2609 if (o_tty->ldisc.close)
2610 (o_tty->ldisc.close)(o_tty);
2611 tty_ldisc_put(o_tty->ldisc.num);
2612 tty_ldisc_assign(o_tty, tty_ldisc_get(N_TTY));
2613 tty_set_termios_ldisc(o_tty, N_TTY);
2616 * The release_tty function takes care of the details of clearing
2617 * the slots and preserving the termios structure.
2619 release_tty(tty, idx);
2621 #ifdef CONFIG_UNIX98_PTYS
2622 /* Make this pty number available for reallocation */
2624 mutex_lock(&allocated_ptys_lock);
2625 idr_remove(&allocated_ptys, idx);
2626 mutex_unlock(&allocated_ptys_lock);
2633 * tty_open - open a tty device
2634 * @inode: inode of device file
2635 * @filp: file pointer to tty
2637 * tty_open and tty_release keep up the tty count that contains the
2638 * number of opens done on a tty. We cannot use the inode-count, as
2639 * different inodes might point to the same tty.
2641 * Open-counting is needed for pty masters, as well as for keeping
2642 * track of serial lines: DTR is dropped when the last close happens.
2643 * (This is not done solely through tty->count, now. - Ted 1/27/92)
2645 * The termios state of a pty is reset on first open so that
2646 * settings don't persist across reuse.
2648 * Locking: tty_mutex protects tty, get_tty_driver and init_dev work.
2649 * tty->count should protect the rest.
2650 * ->siglock protects ->signal/->sighand
2653 static int tty_open(struct inode *inode, struct file *filp)
2655 struct tty_struct *tty;
2657 struct tty_driver *driver;
2659 dev_t device = inode->i_rdev;
2660 unsigned short saved_flags = filp->f_flags;
2662 nonseekable_open(inode, filp);
2665 noctty = filp->f_flags & O_NOCTTY;
2669 mutex_lock(&tty_mutex);
2671 if (device == MKDEV(TTYAUX_MAJOR, 0)) {
2672 tty = get_current_tty();
2674 mutex_unlock(&tty_mutex);
2677 driver = tty->driver;
2679 filp->f_flags |= O_NONBLOCK; /* Don't let /dev/tty block */
2684 if (device == MKDEV(TTY_MAJOR, 0)) {
2685 extern struct tty_driver *console_driver;
2686 driver = console_driver;
2692 if (device == MKDEV(TTYAUX_MAJOR, 1)) {
2693 driver = console_device(&index);
2695 /* Don't let /dev/console block */
2696 filp->f_flags |= O_NONBLOCK;
2700 mutex_unlock(&tty_mutex);
2704 driver = get_tty_driver(device, &index);
2706 mutex_unlock(&tty_mutex);
2710 retval = init_dev(driver, index, &tty);
2711 mutex_unlock(&tty_mutex);
2715 filp->private_data = tty;
2716 file_move(filp, &tty->tty_files);
2717 check_tty_count(tty, "tty_open");
2718 if (tty->driver->type == TTY_DRIVER_TYPE_PTY &&
2719 tty->driver->subtype == PTY_TYPE_MASTER)
2721 #ifdef TTY_DEBUG_HANGUP
2722 printk(KERN_DEBUG "opening %s...", tty->name);
2725 if (tty->driver->open)
2726 retval = tty->driver->open(tty, filp);
2730 filp->f_flags = saved_flags;
2732 if (!retval && test_bit(TTY_EXCLUSIVE, &tty->flags) &&
2733 !capable(CAP_SYS_ADMIN))
2737 #ifdef TTY_DEBUG_HANGUP
2738 printk(KERN_DEBUG "error %d in opening %s...", retval,
2742 if (retval != -ERESTARTSYS)
2744 if (signal_pending(current))
2748 * Need to reset f_op in case a hangup happened.
2750 if (filp->f_op == &hung_up_tty_fops)
2751 filp->f_op = &tty_fops;
2755 mutex_lock(&tty_mutex);
2756 spin_lock_irq(¤t->sighand->siglock);
2758 current->signal->leader &&
2759 !current->signal->tty &&
2760 tty->session == NULL)
2761 __proc_set_tty(current, tty);
2762 spin_unlock_irq(¤t->sighand->siglock);
2763 mutex_unlock(&tty_mutex);
2767 #ifdef CONFIG_UNIX98_PTYS
2769 * ptmx_open - open a unix 98 pty master
2770 * @inode: inode of device file
2771 * @filp: file pointer to tty
2773 * Allocate a unix98 pty master device from the ptmx driver.
2775 * Locking: tty_mutex protects theinit_dev work. tty->count should
2777 * allocated_ptys_lock handles the list of free pty numbers
2780 static int ptmx_open(struct inode *inode, struct file *filp)
2782 struct tty_struct *tty;
2787 nonseekable_open(inode, filp);
2789 /* find a device that is not in use. */
2790 mutex_lock(&allocated_ptys_lock);
2791 if (!idr_pre_get(&allocated_ptys, GFP_KERNEL)) {
2792 mutex_unlock(&allocated_ptys_lock);
2795 idr_ret = idr_get_new(&allocated_ptys, NULL, &index);
2797 mutex_unlock(&allocated_ptys_lock);
2798 if (idr_ret == -EAGAIN)
2802 if (index >= pty_limit) {
2803 idr_remove(&allocated_ptys, index);
2804 mutex_unlock(&allocated_ptys_lock);
2807 mutex_unlock(&allocated_ptys_lock);
2809 mutex_lock(&tty_mutex);
2810 retval = init_dev(ptm_driver, index, &tty);
2811 mutex_unlock(&tty_mutex);
2816 set_bit(TTY_PTY_LOCK, &tty->flags); /* LOCK THE SLAVE */
2817 filp->private_data = tty;
2818 file_move(filp, &tty->tty_files);
2821 if (devpts_pty_new(tty->link))
2824 check_tty_count(tty, "tty_open");
2825 retval = ptm_driver->open(tty, filp);
2832 mutex_lock(&allocated_ptys_lock);
2833 idr_remove(&allocated_ptys, index);
2834 mutex_unlock(&allocated_ptys_lock);
2840 * tty_release - vfs callback for close
2841 * @inode: inode of tty
2842 * @filp: file pointer for handle to tty
2844 * Called the last time each file handle is closed that references
2845 * this tty. There may however be several such references.
2848 * Takes bkl. See release_dev
2851 static int tty_release(struct inode *inode, struct file *filp)
2860 * tty_poll - check tty status
2861 * @filp: file being polled
2862 * @wait: poll wait structures to update
2864 * Call the line discipline polling method to obtain the poll
2865 * status of the device.
2867 * Locking: locks called line discipline but ldisc poll method
2868 * may be re-entered freely by other callers.
2871 static unsigned int tty_poll(struct file *filp, poll_table *wait)
2873 struct tty_struct *tty;
2874 struct tty_ldisc *ld;
2877 tty = (struct tty_struct *)filp->private_data;
2878 if (tty_paranoia_check(tty, filp->f_path.dentry->d_inode, "tty_poll"))
2881 ld = tty_ldisc_ref_wait(tty);
2883 ret = (ld->poll)(tty, filp, wait);
2884 tty_ldisc_deref(ld);
2888 static int tty_fasync(int fd, struct file *filp, int on)
2890 struct tty_struct *tty;
2893 tty = (struct tty_struct *)filp->private_data;
2894 if (tty_paranoia_check(tty, filp->f_path.dentry->d_inode, "tty_fasync"))
2897 retval = fasync_helper(fd, filp, on, &tty->fasync);
2904 if (!waitqueue_active(&tty->read_wait))
2905 tty->minimum_to_wake = 1;
2908 type = PIDTYPE_PGID;
2910 pid = task_pid(current);
2913 retval = __f_setown(filp, pid, type, 0);
2917 if (!tty->fasync && !waitqueue_active(&tty->read_wait))
2918 tty->minimum_to_wake = N_TTY_BUF_SIZE;
2924 * tiocsti - fake input character
2925 * @tty: tty to fake input into
2926 * @p: pointer to character
2928 * Fake input to a tty device. Does the necessary locking and
2931 * FIXME: does not honour flow control ??
2934 * Called functions take tty_ldisc_lock
2935 * current->signal->tty check is safe without locks
2937 * FIXME: may race normal receive processing
2940 static int tiocsti(struct tty_struct *tty, char __user *p)
2943 struct tty_ldisc *ld;
2945 if ((current->signal->tty != tty) && !capable(CAP_SYS_ADMIN))
2947 if (get_user(ch, p))
2949 ld = tty_ldisc_ref_wait(tty);
2950 ld->receive_buf(tty, &ch, &mbz, 1);
2951 tty_ldisc_deref(ld);
2956 * tiocgwinsz - implement window query ioctl
2958 * @arg: user buffer for result
2960 * Copies the kernel idea of the window size into the user buffer.
2962 * Locking: tty->termios_mutex is taken to ensure the winsize data
2966 static int tiocgwinsz(struct tty_struct *tty, struct winsize __user *arg)
2970 mutex_lock(&tty->termios_mutex);
2971 err = copy_to_user(arg, &tty->winsize, sizeof(*arg));
2972 mutex_unlock(&tty->termios_mutex);
2974 return err ? -EFAULT: 0;
2978 * tiocswinsz - implement window size set ioctl
2980 * @arg: user buffer for result
2982 * Copies the user idea of the window size to the kernel. Traditionally
2983 * this is just advisory information but for the Linux console it
2984 * actually has driver level meaning and triggers a VC resize.
2987 * Called function use the console_sem is used to ensure we do
2988 * not try and resize the console twice at once.
2989 * The tty->termios_mutex is used to ensure we don't double
2990 * resize and get confused. Lock order - tty->termios_mutex before
2994 static int tiocswinsz(struct tty_struct *tty, struct tty_struct *real_tty,
2995 struct winsize __user *arg)
2997 struct winsize tmp_ws;
2999 if (copy_from_user(&tmp_ws, arg, sizeof(*arg)))
3002 mutex_lock(&tty->termios_mutex);
3003 if (!memcmp(&tmp_ws, &tty->winsize, sizeof(*arg)))
3007 if (tty->driver->type == TTY_DRIVER_TYPE_CONSOLE) {
3008 if (vc_lock_resize(tty->driver_data, tmp_ws.ws_col,
3010 mutex_unlock(&tty->termios_mutex);
3016 kill_pgrp(tty->pgrp, SIGWINCH, 1);
3017 if ((real_tty->pgrp != tty->pgrp) && real_tty->pgrp)
3018 kill_pgrp(real_tty->pgrp, SIGWINCH, 1);
3019 tty->winsize = tmp_ws;
3020 real_tty->winsize = tmp_ws;
3022 mutex_unlock(&tty->termios_mutex);
3027 * tioccons - allow admin to move logical console
3028 * @file: the file to become console
3030 * Allow the adminstrator to move the redirected console device
3032 * Locking: uses redirect_lock to guard the redirect information
3035 static int tioccons(struct file *file)
3037 if (!capable(CAP_SYS_ADMIN))
3039 if (file->f_op->write == redirected_tty_write) {
3041 spin_lock(&redirect_lock);
3044 spin_unlock(&redirect_lock);
3049 spin_lock(&redirect_lock);
3051 spin_unlock(&redirect_lock);
3056 spin_unlock(&redirect_lock);
3061 * fionbio - non blocking ioctl
3062 * @file: file to set blocking value
3063 * @p: user parameter
3065 * Historical tty interfaces had a blocking control ioctl before
3066 * the generic functionality existed. This piece of history is preserved
3067 * in the expected tty API of posix OS's.
3069 * Locking: none, the open fle handle ensures it won't go away.
3072 static int fionbio(struct file *file, int __user *p)
3076 if (get_user(nonblock, p))
3079 /* file->f_flags is still BKL protected in the fs layer - vomit */
3082 file->f_flags |= O_NONBLOCK;
3084 file->f_flags &= ~O_NONBLOCK;
3090 * tiocsctty - set controlling tty
3091 * @tty: tty structure
3092 * @arg: user argument
3094 * This ioctl is used to manage job control. It permits a session
3095 * leader to set this tty as the controlling tty for the session.
3098 * Takes tty_mutex() to protect tty instance
3099 * Takes tasklist_lock internally to walk sessions
3100 * Takes ->siglock() when updating signal->tty
3103 static int tiocsctty(struct tty_struct *tty, int arg)
3106 if (current->signal->leader && (task_session(current) == tty->session))
3109 mutex_lock(&tty_mutex);
3111 * The process must be a session leader and
3112 * not have a controlling tty already.
3114 if (!current->signal->leader || current->signal->tty) {
3121 * This tty is already the controlling
3122 * tty for another session group!
3124 if (arg == 1 && capable(CAP_SYS_ADMIN)) {
3128 read_lock(&tasklist_lock);
3129 session_clear_tty(tty->session);
3130 read_unlock(&tasklist_lock);
3136 proc_set_tty(current, tty);
3138 mutex_unlock(&tty_mutex);
3143 * tiocgpgrp - get process group
3144 * @tty: tty passed by user
3145 * @real_tty: tty side of the tty pased by the user if a pty else the tty
3148 * Obtain the process group of the tty. If there is no process group
3151 * Locking: none. Reference to current->signal->tty is safe.
3154 static int tiocgpgrp(struct tty_struct *tty, struct tty_struct *real_tty, pid_t __user *p)
3157 * (tty == real_tty) is a cheap way of
3158 * testing if the tty is NOT a master pty.
3160 if (tty == real_tty && current->signal->tty != real_tty)
3162 return put_user(pid_vnr(real_tty->pgrp), p);
3166 * tiocspgrp - attempt to set process group
3167 * @tty: tty passed by user
3168 * @real_tty: tty side device matching tty passed by user
3171 * Set the process group of the tty to the session passed. Only
3172 * permitted where the tty session is our session.
3177 static int tiocspgrp(struct tty_struct *tty, struct tty_struct *real_tty, pid_t __user *p)
3181 int retval = tty_check_change(real_tty);
3187 if (!current->signal->tty ||
3188 (current->signal->tty != real_tty) ||
3189 (real_tty->session != task_session(current)))
3191 if (get_user(pgrp_nr, p))
3196 pgrp = find_vpid(pgrp_nr);
3201 if (session_of_pgrp(pgrp) != task_session(current))
3204 put_pid(real_tty->pgrp);
3205 real_tty->pgrp = get_pid(pgrp);
3212 * tiocgsid - get session id
3213 * @tty: tty passed by user
3214 * @real_tty: tty side of the tty pased by the user if a pty else the tty
3215 * @p: pointer to returned session id
3217 * Obtain the session id of the tty. If there is no session
3220 * Locking: none. Reference to current->signal->tty is safe.
3223 static int tiocgsid(struct tty_struct *tty, struct tty_struct *real_tty, pid_t __user *p)
3226 * (tty == real_tty) is a cheap way of
3227 * testing if the tty is NOT a master pty.
3229 if (tty == real_tty && current->signal->tty != real_tty)
3231 if (!real_tty->session)
3233 return put_user(pid_vnr(real_tty->session), p);
3237 * tiocsetd - set line discipline
3239 * @p: pointer to user data
3241 * Set the line discipline according to user request.
3243 * Locking: see tty_set_ldisc, this function is just a helper
3246 static int tiocsetd(struct tty_struct *tty, int __user *p)
3251 if (get_user(ldisc, p))
3255 ret = tty_set_ldisc(tty, ldisc);
3262 * send_break - performed time break
3263 * @tty: device to break on
3264 * @duration: timeout in mS
3266 * Perform a timed break on hardware that lacks its own driver level
3267 * timed break functionality.
3270 * atomic_write_lock serializes
3274 static int send_break(struct tty_struct *tty, unsigned int duration)
3276 int retval = -EINTR;
3279 if (tty_write_lock(tty, 0) < 0)
3281 tty->driver->break_ctl(tty, -1);
3282 if (!signal_pending(current))
3283 msleep_interruptible(duration);
3284 tty->driver->break_ctl(tty, 0);
3285 tty_write_unlock(tty);
3286 if (!signal_pending(current))
3294 * tiocmget - get modem status
3296 * @file: user file pointer
3297 * @p: pointer to result
3299 * Obtain the modem status bits from the tty driver if the feature
3300 * is supported. Return -EINVAL if it is not available.
3302 * Locking: none (up to the driver)
3305 static int tty_tiocmget(struct tty_struct *tty, struct file *file, int __user *p)
3307 int retval = -EINVAL;
3309 if (tty->driver->tiocmget) {
3311 retval = tty->driver->tiocmget(tty, file);
3315 retval = put_user(retval, p);
3321 * tiocmset - set modem status
3323 * @file: user file pointer
3324 * @cmd: command - clear bits, set bits or set all
3325 * @p: pointer to desired bits
3327 * Set the modem status bits from the tty driver if the feature
3328 * is supported. Return -EINVAL if it is not available.
3330 * Locking: none (up to the driver)
3333 static int tty_tiocmset(struct tty_struct *tty, struct file *file, unsigned int cmd,
3336 int retval = -EINVAL;
3338 if (tty->driver->tiocmset) {
3339 unsigned int set, clear, val;
3341 retval = get_user(val, p);
3359 set &= TIOCM_DTR|TIOCM_RTS|TIOCM_OUT1|TIOCM_OUT2|TIOCM_LOOP;
3360 clear &= TIOCM_DTR|TIOCM_RTS|TIOCM_OUT1|TIOCM_OUT2|TIOCM_LOOP;
3363 retval = tty->driver->tiocmset(tty, file, set, clear);
3370 * Split this up, as gcc can choke on it otherwise..
3372 long tty_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
3374 struct tty_struct *tty, *real_tty;
3375 void __user *p = (void __user *)arg;
3377 struct tty_ldisc *ld;
3378 struct inode *inode = file->f_dentry->d_inode;
3380 tty = (struct tty_struct *)file->private_data;
3381 if (tty_paranoia_check(tty, inode, "tty_ioctl"))
3385 if (tty->driver->type == TTY_DRIVER_TYPE_PTY &&
3386 tty->driver->subtype == PTY_TYPE_MASTER)
3387 real_tty = tty->link;
3390 * Break handling by driver
3395 if (!tty->driver->break_ctl) {
3399 if (tty->driver->ioctl) {
3401 retval = tty->driver->ioctl(tty, file, cmd, arg);
3406 /* These two ioctl's always return success; even if */
3407 /* the driver doesn't support them. */
3410 if (!tty->driver->ioctl)
3413 retval = tty->driver->ioctl(tty, file, cmd, arg);
3415 if (retval == -ENOIOCTLCMD)
3422 * Factor out some common prep work
3430 retval = tty_check_change(tty);
3433 if (cmd != TIOCCBRK) {
3435 tty_wait_until_sent(tty, 0);
3437 if (signal_pending(current))
3445 return tiocsti(tty, p);
3447 return tiocgwinsz(tty, p);
3449 return tiocswinsz(tty, real_tty, p);
3451 return real_tty != tty ? -EINVAL : tioccons(file);
3453 return fionbio(file, p);
3455 set_bit(TTY_EXCLUSIVE, &tty->flags);
3458 clear_bit(TTY_EXCLUSIVE, &tty->flags);
3461 if (current->signal->tty != tty)
3466 return tiocsctty(tty, arg);
3468 return tiocgpgrp(tty, real_tty, p);
3470 return tiocspgrp(tty, real_tty, p);
3472 return tiocgsid(tty, real_tty, p);
3474 /* FIXME: check this is ok */
3475 return put_user(tty->ldisc.num, (int __user *)p);
3477 return tiocsetd(tty, p);
3480 return tioclinux(tty, arg);
3485 case TIOCSBRK: /* Turn break on, unconditionally */
3487 tty->driver->break_ctl(tty, -1);
3491 case TIOCCBRK: /* Turn break off, unconditionally */
3493 tty->driver->break_ctl(tty, 0);
3496 case TCSBRK: /* SVID version: non-zero arg --> no break */
3497 /* non-zero arg means wait for all output data
3498 * to be sent (performed above) but don't send break.
3499 * This is used by the tcdrain() termios function.
3502 return send_break(tty, 250);
3504 case TCSBRKP: /* support for POSIX tcsendbreak() */
3505 return send_break(tty, arg ? arg*100 : 250);
3508 return tty_tiocmget(tty, file, p);
3512 return tty_tiocmset(tty, file, cmd, p);
3517 /* flush tty buffer and allow ldisc to process ioctl */
3518 tty_buffer_flush(tty);
3523 if (tty->driver->ioctl) {
3525 retval = (tty->driver->ioctl)(tty, file, cmd, arg);
3527 if (retval != -ENOIOCTLCMD)
3530 ld = tty_ldisc_ref_wait(tty);
3534 retval = ld->ioctl(tty, file, cmd, arg);
3536 if (retval == -ENOIOCTLCMD)
3539 tty_ldisc_deref(ld);
3543 #ifdef CONFIG_COMPAT
3544 static long tty_compat_ioctl(struct file *file, unsigned int cmd,
3547 struct inode *inode = file->f_dentry->d_inode;
3548 struct tty_struct *tty = file->private_data;
3549 struct tty_ldisc *ld;
3550 int retval = -ENOIOCTLCMD;
3552 if (tty_paranoia_check(tty, inode, "tty_ioctl"))
3555 if (tty->driver->compat_ioctl) {
3556 retval = (tty->driver->compat_ioctl)(tty, file, cmd, arg);
3557 if (retval != -ENOIOCTLCMD)
3561 ld = tty_ldisc_ref_wait(tty);
3562 if (ld->compat_ioctl)
3563 retval = ld->compat_ioctl(tty, file, cmd, arg);
3564 tty_ldisc_deref(ld);
3571 * This implements the "Secure Attention Key" --- the idea is to
3572 * prevent trojan horses by killing all processes associated with this
3573 * tty when the user hits the "Secure Attention Key". Required for
3574 * super-paranoid applications --- see the Orange Book for more details.
3576 * This code could be nicer; ideally it should send a HUP, wait a few
3577 * seconds, then send a INT, and then a KILL signal. But you then
3578 * have to coordinate with the init process, since all processes associated
3579 * with the current tty must be dead before the new getty is allowed
3582 * Now, if it would be correct ;-/ The current code has a nasty hole -
3583 * it doesn't catch files in flight. We may send the descriptor to ourselves
3584 * via AF_UNIX socket, close it and later fetch from socket. FIXME.
3586 * Nasty bug: do_SAK is being called in interrupt context. This can
3587 * deadlock. We punt it up to process context. AKPM - 16Mar2001
3589 void __do_SAK(struct tty_struct *tty)
3594 struct task_struct *g, *p;
3595 struct pid *session;
3598 struct fdtable *fdt;
3602 session = tty->session;
3604 tty_ldisc_flush(tty);
3606 if (tty->driver->flush_buffer)
3607 tty->driver->flush_buffer(tty);
3609 read_lock(&tasklist_lock);
3610 /* Kill the entire session */
3611 do_each_pid_task(session, PIDTYPE_SID, p) {
3612 printk(KERN_NOTICE "SAK: killed process %d"
3613 " (%s): task_session_nr(p)==tty->session\n",
3614 task_pid_nr(p), p->comm);
3615 send_sig(SIGKILL, p, 1);
3616 } while_each_pid_task(session, PIDTYPE_SID, p);
3617 /* Now kill any processes that happen to have the
3620 do_each_thread(g, p) {
3621 if (p->signal->tty == tty) {
3622 printk(KERN_NOTICE "SAK: killed process %d"
3623 " (%s): task_session_nr(p)==tty->session\n",
3624 task_pid_nr(p), p->comm);
3625 send_sig(SIGKILL, p, 1);
3631 * We don't take a ref to the file, so we must
3632 * hold ->file_lock instead.
3634 spin_lock(&p->files->file_lock);
3635 fdt = files_fdtable(p->files);
3636 for (i = 0; i < fdt->max_fds; i++) {
3637 filp = fcheck_files(p->files, i);
3640 if (filp->f_op->read == tty_read &&
3641 filp->private_data == tty) {
3642 printk(KERN_NOTICE "SAK: killed process %d"
3643 " (%s): fd#%d opened to the tty\n",
3644 task_pid_nr(p), p->comm, i);
3645 force_sig(SIGKILL, p);
3649 spin_unlock(&p->files->file_lock);
3652 } while_each_thread(g, p);
3653 read_unlock(&tasklist_lock);
3657 static void do_SAK_work(struct work_struct *work)
3659 struct tty_struct *tty =
3660 container_of(work, struct tty_struct, SAK_work);
3665 * The tq handling here is a little racy - tty->SAK_work may already be queued.
3666 * Fortunately we don't need to worry, because if ->SAK_work is already queued,
3667 * the values which we write to it will be identical to the values which it
3668 * already has. --akpm
3670 void do_SAK(struct tty_struct *tty)
3674 schedule_work(&tty->SAK_work);
3677 EXPORT_SYMBOL(do_SAK);
3681 * @work: tty structure passed from work queue.
3683 * This routine is called out of the software interrupt to flush data
3684 * from the buffer chain to the line discipline.
3686 * Locking: holds tty->buf.lock to guard buffer list. Drops the lock
3687 * while invoking the line discipline receive_buf method. The
3688 * receive_buf method is single threaded for each tty instance.
3691 static void flush_to_ldisc(struct work_struct *work)
3693 struct tty_struct *tty =
3694 container_of(work, struct tty_struct, buf.work.work);
3695 unsigned long flags;
3696 struct tty_ldisc *disc;
3697 struct tty_buffer *tbuf, *head;
3699 unsigned char *flag_buf;
3701 disc = tty_ldisc_ref(tty);
3702 if (disc == NULL) /* !TTY_LDISC */
3705 spin_lock_irqsave(&tty->buf.lock, flags);
3706 /* So we know a flush is running */
3707 set_bit(TTY_FLUSHING, &tty->flags);
3708 head = tty->buf.head;
3710 tty->buf.head = NULL;
3712 int count = head->commit - head->read;
3714 if (head->next == NULL)
3718 tty_buffer_free(tty, tbuf);
3721 /* Ldisc or user is trying to flush the buffers
3722 we are feeding to the ldisc, stop feeding the
3723 line discipline as we want to empty the queue */
3724 if (test_bit(TTY_FLUSHPENDING, &tty->flags))
3726 if (!tty->receive_room) {
3727 schedule_delayed_work(&tty->buf.work, 1);
3730 if (count > tty->receive_room)
3731 count = tty->receive_room;
3732 char_buf = head->char_buf_ptr + head->read;
3733 flag_buf = head->flag_buf_ptr + head->read;
3734 head->read += count;
3735 spin_unlock_irqrestore(&tty->buf.lock, flags);
3736 disc->receive_buf(tty, char_buf, flag_buf, count);
3737 spin_lock_irqsave(&tty->buf.lock, flags);
3739 /* Restore the queue head */
3740 tty->buf.head = head;
3742 /* We may have a deferred request to flush the input buffer,
3743 if so pull the chain under the lock and empty the queue */
3744 if (test_bit(TTY_FLUSHPENDING, &tty->flags)) {
3745 __tty_buffer_flush(tty);
3746 clear_bit(TTY_FLUSHPENDING, &tty->flags);
3747 wake_up(&tty->read_wait);
3749 clear_bit(TTY_FLUSHING, &tty->flags);
3750 spin_unlock_irqrestore(&tty->buf.lock, flags);
3752 tty_ldisc_deref(disc);
3756 * tty_flip_buffer_push - terminal
3759 * Queue a push of the terminal flip buffers to the line discipline. This
3760 * function must not be called from IRQ context if tty->low_latency is set.
3762 * In the event of the queue being busy for flipping the work will be
3763 * held off and retried later.
3765 * Locking: tty buffer lock. Driver locks in low latency mode.
3768 void tty_flip_buffer_push(struct tty_struct *tty)
3770 unsigned long flags;
3771 spin_lock_irqsave(&tty->buf.lock, flags);
3772 if (tty->buf.tail != NULL)
3773 tty->buf.tail->commit = tty->buf.tail->used;
3774 spin_unlock_irqrestore(&tty->buf.lock, flags);
3776 if (tty->low_latency)
3777 flush_to_ldisc(&tty->buf.work.work);
3779 schedule_delayed_work(&tty->buf.work, 1);
3782 EXPORT_SYMBOL(tty_flip_buffer_push);
3786 * initialize_tty_struct
3787 * @tty: tty to initialize
3789 * This subroutine initializes a tty structure that has been newly
3792 * Locking: none - tty in question must not be exposed at this point
3795 static void initialize_tty_struct(struct tty_struct *tty)
3797 memset(tty, 0, sizeof(struct tty_struct));
3798 tty->magic = TTY_MAGIC;
3799 tty_ldisc_assign(tty, tty_ldisc_get(N_TTY));
3800 tty->session = NULL;
3802 tty->overrun_time = jiffies;
3803 tty->buf.head = tty->buf.tail = NULL;
3804 tty_buffer_init(tty);
3805 INIT_DELAYED_WORK(&tty->buf.work, flush_to_ldisc);
3806 mutex_init(&tty->termios_mutex);
3807 init_waitqueue_head(&tty->write_wait);
3808 init_waitqueue_head(&tty->read_wait);
3809 INIT_WORK(&tty->hangup_work, do_tty_hangup);
3810 mutex_init(&tty->atomic_read_lock);
3811 mutex_init(&tty->atomic_write_lock);
3812 spin_lock_init(&tty->read_lock);
3813 spin_lock_init(&tty->ctrl_lock);
3814 INIT_LIST_HEAD(&tty->tty_files);
3815 INIT_WORK(&tty->SAK_work, do_SAK_work);
3819 * The default put_char routine if the driver did not define one.
3822 static void tty_default_put_char(struct tty_struct *tty, unsigned char ch)
3824 tty->driver->write(tty, &ch, 1);
3827 static struct class *tty_class;
3830 * tty_register_device - register a tty device
3831 * @driver: the tty driver that describes the tty device
3832 * @index: the index in the tty driver for this tty device
3833 * @device: a struct device that is associated with this tty device.
3834 * This field is optional, if there is no known struct device
3835 * for this tty device it can be set to NULL safely.
3837 * Returns a pointer to the struct device for this tty device
3838 * (or ERR_PTR(-EFOO) on error).
3840 * This call is required to be made to register an individual tty device
3841 * if the tty driver's flags have the TTY_DRIVER_DYNAMIC_DEV bit set. If
3842 * that bit is not set, this function should not be called by a tty
3848 struct device *tty_register_device(struct tty_driver *driver, unsigned index,
3849 struct device *device)
3852 dev_t dev = MKDEV(driver->major, driver->minor_start) + index;
3854 if (index >= driver->num) {
3855 printk(KERN_ERR "Attempt to register invalid tty line number "
3857 return ERR_PTR(-EINVAL);
3860 if (driver->type == TTY_DRIVER_TYPE_PTY)
3861 pty_line_name(driver, index, name);
3863 tty_line_name(driver, index, name);
3865 return device_create(tty_class, device, dev, name);
3869 * tty_unregister_device - unregister a tty device
3870 * @driver: the tty driver that describes the tty device
3871 * @index: the index in the tty driver for this tty device
3873 * If a tty device is registered with a call to tty_register_device() then
3874 * this function must be called when the tty device is gone.
3879 void tty_unregister_device(struct tty_driver *driver, unsigned index)
3881 device_destroy(tty_class,
3882 MKDEV(driver->major, driver->minor_start) + index);
3885 EXPORT_SYMBOL(tty_register_device);
3886 EXPORT_SYMBOL(tty_unregister_device);
3888 struct tty_driver *alloc_tty_driver(int lines)
3890 struct tty_driver *driver;
3892 driver = kzalloc(sizeof(struct tty_driver), GFP_KERNEL);
3894 driver->magic = TTY_DRIVER_MAGIC;
3895 driver->num = lines;
3896 /* later we'll move allocation of tables here */
3901 void put_tty_driver(struct tty_driver *driver)
3906 void tty_set_operations(struct tty_driver *driver,
3907 const struct tty_operations *op)
3909 driver->open = op->open;
3910 driver->close = op->close;
3911 driver->write = op->write;
3912 driver->put_char = op->put_char;
3913 driver->flush_chars = op->flush_chars;
3914 driver->write_room = op->write_room;
3915 driver->chars_in_buffer = op->chars_in_buffer;
3916 driver->ioctl = op->ioctl;
3917 driver->compat_ioctl = op->compat_ioctl;
3918 driver->set_termios = op->set_termios;
3919 driver->throttle = op->throttle;
3920 driver->unthrottle = op->unthrottle;
3921 driver->stop = op->stop;
3922 driver->start = op->start;
3923 driver->hangup = op->hangup;
3924 driver->break_ctl = op->break_ctl;
3925 driver->flush_buffer = op->flush_buffer;
3926 driver->set_ldisc = op->set_ldisc;
3927 driver->wait_until_sent = op->wait_until_sent;
3928 driver->send_xchar = op->send_xchar;
3929 driver->read_proc = op->read_proc;
3930 driver->write_proc = op->write_proc;
3931 driver->tiocmget = op->tiocmget;
3932 driver->tiocmset = op->tiocmset;
3933 #ifdef CONFIG_CONSOLE_POLL
3934 driver->poll_init = op->poll_init;
3935 driver->poll_get_char = op->poll_get_char;
3936 driver->poll_put_char = op->poll_put_char;
3941 EXPORT_SYMBOL(alloc_tty_driver);
3942 EXPORT_SYMBOL(put_tty_driver);
3943 EXPORT_SYMBOL(tty_set_operations);
3946 * Called by a tty driver to register itself.
3948 int tty_register_driver(struct tty_driver *driver)
3955 if (driver->flags & TTY_DRIVER_INSTALLED)
3958 if (!(driver->flags & TTY_DRIVER_DEVPTS_MEM) && driver->num) {
3959 p = kzalloc(driver->num * 3 * sizeof(void *), GFP_KERNEL);
3964 if (!driver->major) {
3965 error = alloc_chrdev_region(&dev, driver->minor_start,
3966 driver->num, driver->name);
3968 driver->major = MAJOR(dev);
3969 driver->minor_start = MINOR(dev);
3972 dev = MKDEV(driver->major, driver->minor_start);
3973 error = register_chrdev_region(dev, driver->num, driver->name);
3981 driver->ttys = (struct tty_struct **)p;
3982 driver->termios = (struct ktermios **)(p + driver->num);
3983 driver->termios_locked = (struct ktermios **)
3984 (p + driver->num * 2);
3986 driver->ttys = NULL;
3987 driver->termios = NULL;
3988 driver->termios_locked = NULL;
3991 cdev_init(&driver->cdev, &tty_fops);
3992 driver->cdev.owner = driver->owner;
3993 error = cdev_add(&driver->cdev, dev, driver->num);
3995 unregister_chrdev_region(dev, driver->num);
3996 driver->ttys = NULL;
3997 driver->termios = driver->termios_locked = NULL;
4002 if (!driver->put_char)
4003 driver->put_char = tty_default_put_char;
4005 mutex_lock(&tty_mutex);
4006 list_add(&driver->tty_drivers, &tty_drivers);
4007 mutex_unlock(&tty_mutex);
4009 if (!(driver->flags & TTY_DRIVER_DYNAMIC_DEV)) {
4010 for (i = 0; i < driver->num; i++)
4011 tty_register_device(driver, i, NULL);
4013 proc_tty_register_driver(driver);
4017 EXPORT_SYMBOL(tty_register_driver);
4020 * Called by a tty driver to unregister itself.
4022 int tty_unregister_driver(struct tty_driver *driver)
4025 struct ktermios *tp;
4028 if (driver->refcount)
4031 unregister_chrdev_region(MKDEV(driver->major, driver->minor_start),
4033 mutex_lock(&tty_mutex);
4034 list_del(&driver->tty_drivers);
4035 mutex_unlock(&tty_mutex);
4038 * Free the termios and termios_locked structures because
4039 * we don't want to get memory leaks when modular tty
4040 * drivers are removed from the kernel.
4042 for (i = 0; i < driver->num; i++) {
4043 tp = driver->termios[i];
4045 driver->termios[i] = NULL;
4048 tp = driver->termios_locked[i];
4050 driver->termios_locked[i] = NULL;
4053 if (!(driver->flags & TTY_DRIVER_DYNAMIC_DEV))
4054 tty_unregister_device(driver, i);
4057 proc_tty_unregister_driver(driver);
4058 driver->ttys = NULL;
4059 driver->termios = driver->termios_locked = NULL;
4061 cdev_del(&driver->cdev);
4064 EXPORT_SYMBOL(tty_unregister_driver);
4066 dev_t tty_devnum(struct tty_struct *tty)
4068 return MKDEV(tty->driver->major, tty->driver->minor_start) + tty->index;
4070 EXPORT_SYMBOL(tty_devnum);
4072 void proc_clear_tty(struct task_struct *p)
4074 spin_lock_irq(&p->sighand->siglock);
4075 p->signal->tty = NULL;
4076 spin_unlock_irq(&p->sighand->siglock);
4078 EXPORT_SYMBOL(proc_clear_tty);
4080 static void __proc_set_tty(struct task_struct *tsk, struct tty_struct *tty)
4083 /* We should not have a session or pgrp to here but.... */
4084 put_pid(tty->session);
4086 tty->session = get_pid(task_session(tsk));
4087 tty->pgrp = get_pid(task_pgrp(tsk));
4089 put_pid(tsk->signal->tty_old_pgrp);
4090 tsk->signal->tty = tty;
4091 tsk->signal->tty_old_pgrp = NULL;
4094 static void proc_set_tty(struct task_struct *tsk, struct tty_struct *tty)
4096 spin_lock_irq(&tsk->sighand->siglock);
4097 __proc_set_tty(tsk, tty);
4098 spin_unlock_irq(&tsk->sighand->siglock);
4101 struct tty_struct *get_current_tty(void)
4103 struct tty_struct *tty;
4104 WARN_ON_ONCE(!mutex_is_locked(&tty_mutex));
4105 tty = current->signal->tty;
4107 * session->tty can be changed/cleared from under us, make sure we
4108 * issue the load. The obtained pointer, when not NULL, is valid as
4109 * long as we hold tty_mutex.
4114 EXPORT_SYMBOL_GPL(get_current_tty);
4117 * Initialize the console device. This is called *early*, so
4118 * we can't necessarily depend on lots of kernel help here.
4119 * Just do some early initializations, and do the complex setup
4122 void __init console_init(void)
4126 /* Setup the default TTY line discipline. */
4127 (void) tty_register_ldisc(N_TTY, &tty_ldisc_N_TTY);
4130 * set up the console device so that later boot sequences can
4131 * inform about problems etc..
4133 call = __con_initcall_start;
4134 while (call < __con_initcall_end) {
4140 static int __init tty_class_init(void)
4142 tty_class = class_create(THIS_MODULE, "tty");
4143 if (IS_ERR(tty_class))
4144 return PTR_ERR(tty_class);
4148 postcore_initcall(tty_class_init);
4150 /* 3/2004 jmc: why do these devices exist? */
4152 static struct cdev tty_cdev, console_cdev;
4153 #ifdef CONFIG_UNIX98_PTYS
4154 static struct cdev ptmx_cdev;
4157 static struct cdev vc0_cdev;
4161 * Ok, now we can initialize the rest of the tty devices and can count
4162 * on memory allocations, interrupts etc..
4164 static int __init tty_init(void)
4166 cdev_init(&tty_cdev, &tty_fops);
4167 if (cdev_add(&tty_cdev, MKDEV(TTYAUX_MAJOR, 0), 1) ||
4168 register_chrdev_region(MKDEV(TTYAUX_MAJOR, 0), 1, "/dev/tty") < 0)
4169 panic("Couldn't register /dev/tty driver\n");
4170 device_create(tty_class, NULL, MKDEV(TTYAUX_MAJOR, 0), "tty");
4172 cdev_init(&console_cdev, &console_fops);
4173 if (cdev_add(&console_cdev, MKDEV(TTYAUX_MAJOR, 1), 1) ||
4174 register_chrdev_region(MKDEV(TTYAUX_MAJOR, 1), 1, "/dev/console") < 0)
4175 panic("Couldn't register /dev/console driver\n");
4176 device_create(tty_class, NULL, MKDEV(TTYAUX_MAJOR, 1), "console");
4178 #ifdef CONFIG_UNIX98_PTYS
4179 cdev_init(&ptmx_cdev, &ptmx_fops);
4180 if (cdev_add(&ptmx_cdev, MKDEV(TTYAUX_MAJOR, 2), 1) ||
4181 register_chrdev_region(MKDEV(TTYAUX_MAJOR, 2), 1, "/dev/ptmx") < 0)
4182 panic("Couldn't register /dev/ptmx driver\n");
4183 device_create(tty_class, NULL, MKDEV(TTYAUX_MAJOR, 2), "ptmx");
4187 cdev_init(&vc0_cdev, &console_fops);
4188 if (cdev_add(&vc0_cdev, MKDEV(TTY_MAJOR, 0), 1) ||
4189 register_chrdev_region(MKDEV(TTY_MAJOR, 0), 1, "/dev/vc/0") < 0)
4190 panic("Couldn't register /dev/tty0 driver\n");
4191 device_create(tty_class, NULL, MKDEV(TTY_MAJOR, 0), "tty0");
4197 module_init(tty_init);