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() -- Andrew Morton <andrewm@uow.edu.eu> 17Mar01
68 #include <linux/types.h>
69 #include <linux/major.h>
70 #include <linux/errno.h>
71 #include <linux/signal.h>
72 #include <linux/fcntl.h>
73 #include <linux/sched.h>
74 #include <linux/interrupt.h>
75 #include <linux/tty.h>
76 #include <linux/tty_driver.h>
77 #include <linux/tty_flip.h>
78 #include <linux/devpts_fs.h>
79 #include <linux/file.h>
80 #include <linux/console.h>
81 #include <linux/timer.h>
82 #include <linux/ctype.h>
85 #include <linux/string.h>
86 #include <linux/slab.h>
87 #include <linux/poll.h>
88 #include <linux/proc_fs.h>
89 #include <linux/init.h>
90 #include <linux/module.h>
91 #include <linux/smp_lock.h>
92 #include <linux/device.h>
93 #include <linux/idr.h>
94 #include <linux/wait.h>
95 #include <linux/bitops.h>
96 #include <linux/delay.h>
98 #include <asm/uaccess.h>
99 #include <asm/system.h>
101 #include <linux/kbd_kern.h>
102 #include <linux/vt_kern.h>
103 #include <linux/selection.h>
105 #include <linux/kmod.h>
106 #include <linux/vs_pid.h>
108 #undef TTY_DEBUG_HANGUP
110 #define TTY_PARANOIA_CHECK 1
111 #define CHECK_TTY_COUNT 1
113 struct ktermios tty_std_termios = { /* for the benefit of tty drivers */
114 .c_iflag = ICRNL | IXON,
115 .c_oflag = OPOST | ONLCR,
116 .c_cflag = B38400 | CS8 | CREAD | HUPCL,
117 .c_lflag = ISIG | ICANON | ECHO | ECHOE | ECHOK |
118 ECHOCTL | ECHOKE | IEXTEN,
124 EXPORT_SYMBOL(tty_std_termios);
126 /* This list gets poked at by procfs and various bits of boot up code. This
127 could do with some rationalisation such as pulling the tty proc function
130 LIST_HEAD(tty_drivers); /* linked list of tty drivers */
132 /* Mutex to protect creating and releasing a tty. This is shared with
133 vt.c for deeply disgusting hack reasons */
134 DEFINE_MUTEX(tty_mutex);
135 EXPORT_SYMBOL(tty_mutex);
137 #ifdef CONFIG_UNIX98_PTYS
138 extern struct tty_driver *ptm_driver; /* Unix98 pty masters; for /dev/ptmx */
139 extern int pty_limit; /* Config limit on Unix98 ptys */
140 static DEFINE_IDR(allocated_ptys);
141 static DECLARE_MUTEX(allocated_ptys_lock);
142 static int ptmx_open(struct inode *, struct file *);
145 extern void disable_early_printk(void);
147 static void initialize_tty_struct(struct tty_struct *tty);
149 static ssize_t tty_read(struct file *, char __user *, size_t, loff_t *);
150 static ssize_t tty_write(struct file *, const char __user *, size_t, loff_t *);
151 ssize_t redirected_tty_write(struct file *, const char __user *, size_t, loff_t *);
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 int tty_ioctl(struct inode * inode, struct file * file,
156 unsigned int cmd, unsigned long arg);
157 static int tty_fasync(int fd, struct file * filp, int on);
158 static void release_mem(struct tty_struct *tty, int idx);
161 * alloc_tty_struct - allocate a tty object
163 * Return a new empty tty structure. The data fields have not
164 * been initialized in any way but has been zeroed
169 static struct tty_struct *alloc_tty_struct(void)
171 return kzalloc(sizeof(struct tty_struct), GFP_KERNEL);
174 static void tty_buffer_free_all(struct tty_struct *);
177 * free_tty_struct - free a disused tty
178 * @tty: tty struct to free
180 * Free the write buffers, tty queue and tty memory itself.
182 * Locking: none. Must be called after tty is definitely unused
185 static inline void free_tty_struct(struct tty_struct *tty)
187 kfree(tty->write_buf);
188 tty_buffer_free_all(tty);
189 memset(tty, 0xDEADDEAD, sizeof(struct tty_struct));
193 #define TTY_NUMBER(tty) ((tty)->index + (tty)->driver->name_base)
196 * tty_name - return tty naming
197 * @tty: tty structure
198 * @buf: buffer for output
200 * Convert a tty structure into a name. The name reflects the kernel
201 * naming policy and if udev is in use may not reflect user space
206 char *tty_name(struct tty_struct *tty, char *buf)
208 if (!tty) /* Hmm. NULL pointer. That's fun. */
209 strcpy(buf, "NULL tty");
211 strcpy(buf, tty->name);
215 EXPORT_SYMBOL(tty_name);
217 int tty_paranoia_check(struct tty_struct *tty, struct inode *inode,
220 #ifdef TTY_PARANOIA_CHECK
223 "null TTY for (%d:%d) in %s\n",
224 imajor(inode), iminor(inode), routine);
227 if (tty->magic != TTY_MAGIC) {
229 "bad magic number for tty struct (%d:%d) in %s\n",
230 imajor(inode), iminor(inode), routine);
237 static int check_tty_count(struct tty_struct *tty, const char *routine)
239 #ifdef CHECK_TTY_COUNT
244 list_for_each(p, &tty->tty_files) {
248 if (tty->driver->type == TTY_DRIVER_TYPE_PTY &&
249 tty->driver->subtype == PTY_TYPE_SLAVE &&
250 tty->link && tty->link->count)
252 if (tty->count != count) {
253 printk(KERN_WARNING "Warning: dev (%s) tty->count(%d) "
254 "!= #fd's(%d) in %s\n",
255 tty->name, tty->count, count, routine);
263 * Tty buffer allocation management
267 * tty_buffer_free_all - free buffers used by a tty
268 * @tty: tty to free from
270 * Remove all the buffers pending on a tty whether queued with data
271 * or in the free ring. Must be called when the tty is no longer in use
276 static void tty_buffer_free_all(struct tty_struct *tty)
278 struct tty_buffer *thead;
279 while((thead = tty->buf.head) != NULL) {
280 tty->buf.head = thead->next;
283 while((thead = tty->buf.free) != NULL) {
284 tty->buf.free = thead->next;
287 tty->buf.tail = NULL;
288 tty->buf.memory_used = 0;
292 * tty_buffer_init - prepare a tty buffer structure
293 * @tty: tty to initialise
295 * Set up the initial state of the buffer management for a tty device.
296 * Must be called before the other tty buffer functions are used.
301 static void tty_buffer_init(struct tty_struct *tty)
303 spin_lock_init(&tty->buf.lock);
304 tty->buf.head = NULL;
305 tty->buf.tail = NULL;
306 tty->buf.free = NULL;
307 tty->buf.memory_used = 0;
311 * tty_buffer_alloc - allocate a tty buffer
313 * @size: desired size (characters)
315 * Allocate a new tty buffer to hold the desired number of characters.
316 * Return NULL if out of memory or the allocation would exceed the
319 * Locking: Caller must hold tty->buf.lock
322 static struct tty_buffer *tty_buffer_alloc(struct tty_struct *tty, size_t size)
324 struct tty_buffer *p;
326 if (tty->buf.memory_used + size > 65536)
328 p = kmalloc(sizeof(struct tty_buffer) + 2 * size, GFP_ATOMIC);
336 p->char_buf_ptr = (char *)(p->data);
337 p->flag_buf_ptr = (unsigned char *)p->char_buf_ptr + size;
338 tty->buf.memory_used += size;
343 * tty_buffer_free - free a tty buffer
344 * @tty: tty owning the buffer
345 * @b: the buffer to free
347 * Free a tty buffer, or add it to the free list according to our
350 * Locking: Caller must hold tty->buf.lock
353 static void tty_buffer_free(struct tty_struct *tty, struct tty_buffer *b)
355 /* Dumb strategy for now - should keep some stats */
356 tty->buf.memory_used -= b->size;
357 WARN_ON(tty->buf.memory_used < 0);
362 b->next = tty->buf.free;
368 * tty_buffer_find - find a free tty buffer
369 * @tty: tty owning the buffer
370 * @size: characters wanted
372 * Locate an existing suitable tty buffer or if we are lacking one then
373 * allocate a new one. We round our buffers off in 256 character chunks
374 * to get better allocation behaviour.
376 * Locking: Caller must hold tty->buf.lock
379 static struct tty_buffer *tty_buffer_find(struct tty_struct *tty, size_t size)
381 struct tty_buffer **tbh = &tty->buf.free;
382 while((*tbh) != NULL) {
383 struct tty_buffer *t = *tbh;
384 if(t->size >= size) {
390 tty->buf.memory_used += t->size;
393 tbh = &((*tbh)->next);
395 /* Round the buffer size out */
396 size = (size + 0xFF) & ~ 0xFF;
397 return tty_buffer_alloc(tty, size);
398 /* Should possibly check if this fails for the largest buffer we
399 have queued and recycle that ? */
403 * tty_buffer_request_room - grow tty buffer if needed
404 * @tty: tty structure
405 * @size: size desired
407 * Make at least size bytes of linear space available for the tty
408 * buffer. If we fail return the size we managed to find.
410 * Locking: Takes tty->buf.lock
412 int tty_buffer_request_room(struct tty_struct *tty, size_t size)
414 struct tty_buffer *b, *n;
418 spin_lock_irqsave(&tty->buf.lock, flags);
420 /* OPTIMISATION: We could keep a per tty "zero" sized buffer to
421 remove this conditional if its worth it. This would be invisible
423 if ((b = tty->buf.tail) != NULL)
424 left = b->size - b->used;
429 /* This is the slow path - looking for new buffers to use */
430 if ((n = tty_buffer_find(tty, size)) != NULL) {
441 spin_unlock_irqrestore(&tty->buf.lock, flags);
444 EXPORT_SYMBOL_GPL(tty_buffer_request_room);
447 * tty_insert_flip_string - Add characters to the tty buffer
448 * @tty: tty structure
452 * Queue a series of bytes to the tty buffering. All the characters
453 * passed are marked as without error. Returns the number added.
455 * Locking: Called functions may take tty->buf.lock
458 int tty_insert_flip_string(struct tty_struct *tty, const unsigned char *chars,
463 int space = tty_buffer_request_room(tty, size - copied);
464 struct tty_buffer *tb = tty->buf.tail;
465 /* If there is no space then tb may be NULL */
466 if(unlikely(space == 0))
468 memcpy(tb->char_buf_ptr + tb->used, chars, space);
469 memset(tb->flag_buf_ptr + tb->used, TTY_NORMAL, space);
473 /* There is a small chance that we need to split the data over
474 several buffers. If this is the case we must loop */
475 } while (unlikely(size > copied));
478 EXPORT_SYMBOL(tty_insert_flip_string);
481 * tty_insert_flip_string_flags - Add characters to the tty buffer
482 * @tty: tty structure
487 * Queue a series of bytes to the tty buffering. For each character
488 * the flags array indicates the status of the character. Returns the
491 * Locking: Called functions may take tty->buf.lock
494 int tty_insert_flip_string_flags(struct tty_struct *tty,
495 const unsigned char *chars, const char *flags, size_t size)
499 int space = tty_buffer_request_room(tty, size - copied);
500 struct tty_buffer *tb = tty->buf.tail;
501 /* If there is no space then tb may be NULL */
502 if(unlikely(space == 0))
504 memcpy(tb->char_buf_ptr + tb->used, chars, space);
505 memcpy(tb->flag_buf_ptr + tb->used, flags, space);
510 /* There is a small chance that we need to split the data over
511 several buffers. If this is the case we must loop */
512 } while (unlikely(size > copied));
515 EXPORT_SYMBOL(tty_insert_flip_string_flags);
518 * tty_schedule_flip - push characters to ldisc
519 * @tty: tty to push from
521 * Takes any pending buffers and transfers their ownership to the
522 * ldisc side of the queue. It then schedules those characters for
523 * processing by the line discipline.
525 * Locking: Takes tty->buf.lock
528 void tty_schedule_flip(struct tty_struct *tty)
531 spin_lock_irqsave(&tty->buf.lock, flags);
532 if (tty->buf.tail != NULL)
533 tty->buf.tail->commit = tty->buf.tail->used;
534 spin_unlock_irqrestore(&tty->buf.lock, flags);
535 schedule_delayed_work(&tty->buf.work, 1);
537 EXPORT_SYMBOL(tty_schedule_flip);
540 * tty_prepare_flip_string - make room for characters
542 * @chars: return pointer for character write area
543 * @size: desired size
545 * Prepare a block of space in the buffer for data. Returns the length
546 * available and buffer pointer to the space which is now allocated and
547 * accounted for as ready for normal characters. This is used for drivers
548 * that need their own block copy routines into the buffer. There is no
549 * guarantee the buffer is a DMA target!
551 * Locking: May call functions taking tty->buf.lock
554 int tty_prepare_flip_string(struct tty_struct *tty, unsigned char **chars, size_t size)
556 int space = tty_buffer_request_room(tty, size);
558 struct tty_buffer *tb = tty->buf.tail;
559 *chars = tb->char_buf_ptr + tb->used;
560 memset(tb->flag_buf_ptr + tb->used, TTY_NORMAL, space);
566 EXPORT_SYMBOL_GPL(tty_prepare_flip_string);
569 * tty_prepare_flip_string_flags - make room for characters
571 * @chars: return pointer for character write area
572 * @flags: return pointer for status flag write area
573 * @size: desired size
575 * Prepare a block of space in the buffer for data. Returns the length
576 * available and buffer pointer to the space which is now allocated and
577 * accounted for as ready for characters. This is used for drivers
578 * that need their own block copy routines into the buffer. There is no
579 * guarantee the buffer is a DMA target!
581 * Locking: May call functions taking tty->buf.lock
584 int tty_prepare_flip_string_flags(struct tty_struct *tty, unsigned char **chars, char **flags, size_t size)
586 int space = tty_buffer_request_room(tty, size);
588 struct tty_buffer *tb = tty->buf.tail;
589 *chars = tb->char_buf_ptr + tb->used;
590 *flags = tb->flag_buf_ptr + tb->used;
596 EXPORT_SYMBOL_GPL(tty_prepare_flip_string_flags);
601 * tty_set_termios_ldisc - set ldisc field
602 * @tty: tty structure
603 * @num: line discipline number
605 * This is probably overkill for real world processors but
606 * they are not on hot paths so a little discipline won't do
609 * Locking: takes termios_mutex
612 static void tty_set_termios_ldisc(struct tty_struct *tty, int num)
614 mutex_lock(&tty->termios_mutex);
615 tty->termios->c_line = num;
616 mutex_unlock(&tty->termios_mutex);
620 * This guards the refcounted line discipline lists. The lock
621 * must be taken with irqs off because there are hangup path
622 * callers who will do ldisc lookups and cannot sleep.
625 static DEFINE_SPINLOCK(tty_ldisc_lock);
626 static DECLARE_WAIT_QUEUE_HEAD(tty_ldisc_wait);
627 static struct tty_ldisc tty_ldiscs[NR_LDISCS]; /* line disc dispatch table */
630 * tty_register_ldisc - install a line discipline
631 * @disc: ldisc number
632 * @new_ldisc: pointer to the ldisc object
634 * Installs a new line discipline into the kernel. The discipline
635 * is set up as unreferenced and then made available to the kernel
636 * from this point onwards.
639 * takes tty_ldisc_lock to guard against ldisc races
642 int tty_register_ldisc(int disc, struct tty_ldisc *new_ldisc)
647 if (disc < N_TTY || disc >= NR_LDISCS)
650 spin_lock_irqsave(&tty_ldisc_lock, flags);
651 tty_ldiscs[disc] = *new_ldisc;
652 tty_ldiscs[disc].num = disc;
653 tty_ldiscs[disc].flags |= LDISC_FLAG_DEFINED;
654 tty_ldiscs[disc].refcount = 0;
655 spin_unlock_irqrestore(&tty_ldisc_lock, flags);
659 EXPORT_SYMBOL(tty_register_ldisc);
662 * tty_unregister_ldisc - unload a line discipline
663 * @disc: ldisc number
664 * @new_ldisc: pointer to the ldisc object
666 * Remove a line discipline from the kernel providing it is not
670 * takes tty_ldisc_lock to guard against ldisc races
673 int tty_unregister_ldisc(int disc)
678 if (disc < N_TTY || disc >= NR_LDISCS)
681 spin_lock_irqsave(&tty_ldisc_lock, flags);
682 if (tty_ldiscs[disc].refcount)
685 tty_ldiscs[disc].flags &= ~LDISC_FLAG_DEFINED;
686 spin_unlock_irqrestore(&tty_ldisc_lock, flags);
690 EXPORT_SYMBOL(tty_unregister_ldisc);
693 * tty_ldisc_get - take a reference to an ldisc
694 * @disc: ldisc number
696 * Takes a reference to a line discipline. Deals with refcounts and
697 * module locking counts. Returns NULL if the discipline is not available.
698 * Returns a pointer to the discipline and bumps the ref count if it is
702 * takes tty_ldisc_lock to guard against ldisc races
705 struct tty_ldisc *tty_ldisc_get(int disc)
708 struct tty_ldisc *ld;
710 if (disc < N_TTY || disc >= NR_LDISCS)
713 spin_lock_irqsave(&tty_ldisc_lock, flags);
715 ld = &tty_ldiscs[disc];
716 /* Check the entry is defined */
717 if(ld->flags & LDISC_FLAG_DEFINED)
719 /* If the module is being unloaded we can't use it */
720 if (!try_module_get(ld->owner))
727 spin_unlock_irqrestore(&tty_ldisc_lock, flags);
731 EXPORT_SYMBOL_GPL(tty_ldisc_get);
734 * tty_ldisc_put - drop ldisc reference
735 * @disc: ldisc number
737 * Drop a reference to a line discipline. Manage refcounts and
738 * module usage counts
741 * takes tty_ldisc_lock to guard against ldisc races
744 void tty_ldisc_put(int disc)
746 struct tty_ldisc *ld;
749 BUG_ON(disc < N_TTY || disc >= NR_LDISCS);
751 spin_lock_irqsave(&tty_ldisc_lock, flags);
752 ld = &tty_ldiscs[disc];
753 BUG_ON(ld->refcount == 0);
755 module_put(ld->owner);
756 spin_unlock_irqrestore(&tty_ldisc_lock, flags);
759 EXPORT_SYMBOL_GPL(tty_ldisc_put);
762 * tty_ldisc_assign - set ldisc on a tty
763 * @tty: tty to assign
764 * @ld: line discipline
766 * Install an instance of a line discipline into a tty structure. The
767 * ldisc must have a reference count above zero to ensure it remains/
768 * The tty instance refcount starts at zero.
771 * Caller must hold references
774 static void tty_ldisc_assign(struct tty_struct *tty, struct tty_ldisc *ld)
777 tty->ldisc.refcount = 0;
781 * tty_ldisc_try - internal helper
784 * Make a single attempt to grab and bump the refcount on
785 * the tty ldisc. Return 0 on failure or 1 on success. This is
786 * used to implement both the waiting and non waiting versions
789 * Locking: takes tty_ldisc_lock
792 static int tty_ldisc_try(struct tty_struct *tty)
795 struct tty_ldisc *ld;
798 spin_lock_irqsave(&tty_ldisc_lock, flags);
800 if(test_bit(TTY_LDISC, &tty->flags))
805 spin_unlock_irqrestore(&tty_ldisc_lock, flags);
810 * tty_ldisc_ref_wait - wait for the tty ldisc
813 * Dereference the line discipline for the terminal and take a
814 * reference to it. If the line discipline is in flux then
815 * wait patiently until it changes.
817 * Note: Must not be called from an IRQ/timer context. The caller
818 * must also be careful not to hold other locks that will deadlock
819 * against a discipline change, such as an existing ldisc reference
820 * (which we check for)
822 * Locking: call functions take tty_ldisc_lock
825 struct tty_ldisc *tty_ldisc_ref_wait(struct tty_struct *tty)
827 /* wait_event is a macro */
828 wait_event(tty_ldisc_wait, tty_ldisc_try(tty));
829 if(tty->ldisc.refcount == 0)
830 printk(KERN_ERR "tty_ldisc_ref_wait\n");
834 EXPORT_SYMBOL_GPL(tty_ldisc_ref_wait);
837 * tty_ldisc_ref - get the tty ldisc
840 * Dereference the line discipline for the terminal and take a
841 * reference to it. If the line discipline is in flux then
842 * return NULL. Can be called from IRQ and timer functions.
844 * Locking: called functions take tty_ldisc_lock
847 struct tty_ldisc *tty_ldisc_ref(struct tty_struct *tty)
849 if(tty_ldisc_try(tty))
854 EXPORT_SYMBOL_GPL(tty_ldisc_ref);
857 * tty_ldisc_deref - free a tty ldisc reference
858 * @ld: reference to free up
860 * Undoes the effect of tty_ldisc_ref or tty_ldisc_ref_wait. May
861 * be called in IRQ context.
863 * Locking: takes tty_ldisc_lock
866 void tty_ldisc_deref(struct tty_ldisc *ld)
872 spin_lock_irqsave(&tty_ldisc_lock, flags);
873 if(ld->refcount == 0)
874 printk(KERN_ERR "tty_ldisc_deref: no references.\n");
877 if(ld->refcount == 0)
878 wake_up(&tty_ldisc_wait);
879 spin_unlock_irqrestore(&tty_ldisc_lock, flags);
882 EXPORT_SYMBOL_GPL(tty_ldisc_deref);
885 * tty_ldisc_enable - allow ldisc use
886 * @tty: terminal to activate ldisc on
888 * Set the TTY_LDISC flag when the line discipline can be called
889 * again. Do neccessary wakeups for existing sleepers.
891 * Note: nobody should set this bit except via this function. Clearing
892 * directly is allowed.
895 static void tty_ldisc_enable(struct tty_struct *tty)
897 set_bit(TTY_LDISC, &tty->flags);
898 wake_up(&tty_ldisc_wait);
902 * tty_set_ldisc - set line discipline
903 * @tty: the terminal to set
904 * @ldisc: the line discipline
906 * Set the discipline of a tty line. Must be called from a process
909 * Locking: takes tty_ldisc_lock.
910 * called functions take termios_mutex
913 static int tty_set_ldisc(struct tty_struct *tty, int ldisc)
916 struct tty_ldisc o_ldisc;
920 struct tty_ldisc *ld;
921 struct tty_struct *o_tty;
923 if ((ldisc < N_TTY) || (ldisc >= NR_LDISCS))
928 ld = tty_ldisc_get(ldisc);
929 /* Eduardo Blanco <ejbs@cs.cs.com.uy> */
930 /* Cyrus Durgin <cider@speakeasy.org> */
932 request_module("tty-ldisc-%d", ldisc);
933 ld = tty_ldisc_get(ldisc);
939 * No more input please, we are switching. The new ldisc
940 * will update this value in the ldisc open function
943 tty->receive_room = 0;
946 * Problem: What do we do if this blocks ?
949 tty_wait_until_sent(tty, 0);
951 if (tty->ldisc.num == ldisc) {
952 tty_ldisc_put(ldisc);
956 o_ldisc = tty->ldisc;
960 * Make sure we don't change while someone holds a
961 * reference to the line discipline. The TTY_LDISC bit
962 * prevents anyone taking a reference once it is clear.
963 * We need the lock to avoid racing reference takers.
966 spin_lock_irqsave(&tty_ldisc_lock, flags);
967 if (tty->ldisc.refcount || (o_tty && o_tty->ldisc.refcount)) {
968 if(tty->ldisc.refcount) {
969 /* Free the new ldisc we grabbed. Must drop the lock
971 spin_unlock_irqrestore(&tty_ldisc_lock, flags);
972 tty_ldisc_put(ldisc);
974 * There are several reasons we may be busy, including
975 * random momentary I/O traffic. We must therefore
976 * retry. We could distinguish between blocking ops
977 * and retries if we made tty_ldisc_wait() smarter. That
978 * is up for discussion.
980 if (wait_event_interruptible(tty_ldisc_wait, tty->ldisc.refcount == 0) < 0)
984 if(o_tty && o_tty->ldisc.refcount) {
985 spin_unlock_irqrestore(&tty_ldisc_lock, flags);
986 tty_ldisc_put(ldisc);
987 if (wait_event_interruptible(tty_ldisc_wait, o_tty->ldisc.refcount == 0) < 0)
993 /* if the TTY_LDISC bit is set, then we are racing against another ldisc change */
995 if (!test_bit(TTY_LDISC, &tty->flags)) {
996 spin_unlock_irqrestore(&tty_ldisc_lock, flags);
997 tty_ldisc_put(ldisc);
998 ld = tty_ldisc_ref_wait(tty);
1003 clear_bit(TTY_LDISC, &tty->flags);
1005 clear_bit(TTY_LDISC, &o_tty->flags);
1006 spin_unlock_irqrestore(&tty_ldisc_lock, flags);
1009 * From this point on we know nobody has an ldisc
1010 * usage reference, nor can they obtain one until
1011 * we say so later on.
1014 work = cancel_delayed_work(&tty->buf.work);
1016 * Wait for ->hangup_work and ->buf.work handlers to terminate
1019 flush_scheduled_work();
1020 /* Shutdown the current discipline. */
1021 if (tty->ldisc.close)
1022 (tty->ldisc.close)(tty);
1024 /* Now set up the new line discipline. */
1025 tty_ldisc_assign(tty, ld);
1026 tty_set_termios_ldisc(tty, ldisc);
1027 if (tty->ldisc.open)
1028 retval = (tty->ldisc.open)(tty);
1030 tty_ldisc_put(ldisc);
1031 /* There is an outstanding reference here so this is safe */
1032 tty_ldisc_assign(tty, tty_ldisc_get(o_ldisc.num));
1033 tty_set_termios_ldisc(tty, tty->ldisc.num);
1034 if (tty->ldisc.open && (tty->ldisc.open(tty) < 0)) {
1035 tty_ldisc_put(o_ldisc.num);
1036 /* This driver is always present */
1037 tty_ldisc_assign(tty, tty_ldisc_get(N_TTY));
1038 tty_set_termios_ldisc(tty, N_TTY);
1039 if (tty->ldisc.open) {
1040 int r = tty->ldisc.open(tty);
1043 panic("Couldn't open N_TTY ldisc for "
1045 tty_name(tty, buf), r);
1049 /* At this point we hold a reference to the new ldisc and a
1050 a reference to the old ldisc. If we ended up flipping back
1051 to the existing ldisc we have two references to it */
1053 if (tty->ldisc.num != o_ldisc.num && tty->driver->set_ldisc)
1054 tty->driver->set_ldisc(tty);
1056 tty_ldisc_put(o_ldisc.num);
1059 * Allow ldisc referencing to occur as soon as the driver
1060 * ldisc callback completes.
1063 tty_ldisc_enable(tty);
1065 tty_ldisc_enable(o_tty);
1067 /* Restart it in case no characters kick it off. Safe if
1070 schedule_delayed_work(&tty->buf.work, 1);
1075 * get_tty_driver - find device of a tty
1076 * @dev_t: device identifier
1077 * @index: returns the index of the tty
1079 * This routine returns a tty driver structure, given a device number
1080 * and also passes back the index number.
1082 * Locking: caller must hold tty_mutex
1085 static struct tty_driver *get_tty_driver(dev_t device, int *index)
1087 struct tty_driver *p;
1089 list_for_each_entry(p, &tty_drivers, tty_drivers) {
1090 dev_t base = MKDEV(p->major, p->minor_start);
1091 if (device < base || device >= base + p->num)
1093 *index = device - base;
1100 * tty_check_change - check for POSIX terminal changes
1101 * @tty: tty to check
1103 * If we try to write to, or set the state of, a terminal and we're
1104 * not in the foreground, send a SIGTTOU. If the signal is blocked or
1105 * ignored, go ahead and perform the operation. (POSIX 7.2)
1110 int tty_check_change(struct tty_struct * tty)
1112 if (current->signal->tty != tty)
1114 if (tty->pgrp <= 0) {
1115 printk(KERN_WARNING "tty_check_change: tty->pgrp <= 0!\n");
1118 if (process_group(current) == tty->pgrp)
1120 if (is_ignored(SIGTTOU))
1122 if (is_orphaned_pgrp(process_group(current)))
1124 (void) kill_pg(process_group(current), SIGTTOU, 1);
1125 return -ERESTARTSYS;
1128 EXPORT_SYMBOL(tty_check_change);
1130 static ssize_t hung_up_tty_read(struct file * file, char __user * buf,
1131 size_t count, loff_t *ppos)
1136 static ssize_t hung_up_tty_write(struct file * file, const char __user * buf,
1137 size_t count, loff_t *ppos)
1142 /* No kernel lock held - none needed ;) */
1143 static unsigned int hung_up_tty_poll(struct file * filp, poll_table * wait)
1145 return POLLIN | POLLOUT | POLLERR | POLLHUP | POLLRDNORM | POLLWRNORM;
1148 static int hung_up_tty_ioctl(struct inode * inode, struct file * file,
1149 unsigned int cmd, unsigned long arg)
1151 return cmd == TIOCSPGRP ? -ENOTTY : -EIO;
1154 static const struct file_operations tty_fops = {
1155 .llseek = no_llseek,
1161 .release = tty_release,
1162 .fasync = tty_fasync,
1165 #ifdef CONFIG_UNIX98_PTYS
1166 static const struct file_operations ptmx_fops = {
1167 .llseek = no_llseek,
1173 .release = tty_release,
1174 .fasync = tty_fasync,
1178 static const struct file_operations console_fops = {
1179 .llseek = no_llseek,
1181 .write = redirected_tty_write,
1185 .release = tty_release,
1186 .fasync = tty_fasync,
1189 static const struct file_operations hung_up_tty_fops = {
1190 .llseek = no_llseek,
1191 .read = hung_up_tty_read,
1192 .write = hung_up_tty_write,
1193 .poll = hung_up_tty_poll,
1194 .ioctl = hung_up_tty_ioctl,
1195 .release = tty_release,
1198 static DEFINE_SPINLOCK(redirect_lock);
1199 static struct file *redirect;
1202 * tty_wakeup - request more data
1205 * Internal and external helper for wakeups of tty. This function
1206 * informs the line discipline if present that the driver is ready
1207 * to receive more output data.
1210 void tty_wakeup(struct tty_struct *tty)
1212 struct tty_ldisc *ld;
1214 if (test_bit(TTY_DO_WRITE_WAKEUP, &tty->flags)) {
1215 ld = tty_ldisc_ref(tty);
1217 if(ld->write_wakeup)
1218 ld->write_wakeup(tty);
1219 tty_ldisc_deref(ld);
1222 wake_up_interruptible(&tty->write_wait);
1225 EXPORT_SYMBOL_GPL(tty_wakeup);
1228 * tty_ldisc_flush - flush line discipline queue
1231 * Flush the line discipline queue (if any) for this tty. If there
1232 * is no line discipline active this is a no-op.
1235 void tty_ldisc_flush(struct tty_struct *tty)
1237 struct tty_ldisc *ld = tty_ldisc_ref(tty);
1239 if(ld->flush_buffer)
1240 ld->flush_buffer(tty);
1241 tty_ldisc_deref(ld);
1245 EXPORT_SYMBOL_GPL(tty_ldisc_flush);
1248 * tty_reset_termios - reset terminal state
1249 * @tty: tty to reset
1251 * Restore a terminal to the driver default state
1254 static void tty_reset_termios(struct tty_struct *tty)
1256 mutex_lock(&tty->termios_mutex);
1257 *tty->termios = tty->driver->init_termios;
1258 tty->termios->c_ispeed = tty_termios_input_baud_rate(tty->termios);
1259 tty->termios->c_ospeed = tty_termios_baud_rate(tty->termios);
1260 mutex_unlock(&tty->termios_mutex);
1264 * do_tty_hangup - actual handler for hangup events
1267 * This can be called by the "eventd" kernel thread. That is process
1268 * synchronous but doesn't hold any locks, so we need to make sure we
1269 * have the appropriate locks for what we're doing.
1271 * The hangup event clears any pending redirections onto the hung up
1272 * device. It ensures future writes will error and it does the needed
1273 * line discipline hangup and signal delivery. The tty object itself
1278 * redirect lock for undoing redirection
1279 * file list lock for manipulating list of ttys
1280 * tty_ldisc_lock from called functions
1281 * termios_mutex resetting termios data
1282 * tasklist_lock to walk task list for hangup event
1283 * ->siglock to protect ->signal/->sighand
1285 static void do_tty_hangup(struct work_struct *work)
1287 struct tty_struct *tty =
1288 container_of(work, struct tty_struct, hangup_work);
1289 struct file * cons_filp = NULL;
1290 struct file *filp, *f = NULL;
1291 struct task_struct *p;
1292 struct tty_ldisc *ld;
1293 int closecount = 0, n;
1298 /* inuse_filps is protected by the single kernel lock */
1301 spin_lock(&redirect_lock);
1302 if (redirect && redirect->private_data == tty) {
1306 spin_unlock(&redirect_lock);
1308 check_tty_count(tty, "do_tty_hangup");
1310 /* This breaks for file handles being sent over AF_UNIX sockets ? */
1311 list_for_each_entry(filp, &tty->tty_files, f_u.fu_list) {
1312 if (filp->f_op->write == redirected_tty_write)
1314 if (filp->f_op->write != tty_write)
1317 tty_fasync(-1, filp, 0); /* can't block */
1318 filp->f_op = &hung_up_tty_fops;
1322 /* FIXME! What are the locking issues here? This may me overdoing things..
1323 * this question is especially important now that we've removed the irqlock. */
1325 ld = tty_ldisc_ref(tty);
1326 if(ld != NULL) /* We may have no line discipline at this point */
1328 if (ld->flush_buffer)
1329 ld->flush_buffer(tty);
1330 if (tty->driver->flush_buffer)
1331 tty->driver->flush_buffer(tty);
1332 if ((test_bit(TTY_DO_WRITE_WAKEUP, &tty->flags)) &&
1334 ld->write_wakeup(tty);
1339 /* FIXME: Once we trust the LDISC code better we can wait here for
1340 ldisc completion and fix the driver call race */
1342 wake_up_interruptible(&tty->write_wait);
1343 wake_up_interruptible(&tty->read_wait);
1346 * Shutdown the current line discipline, and reset it to
1349 if (tty->driver->flags & TTY_DRIVER_RESET_TERMIOS)
1350 tty_reset_termios(tty);
1352 /* Defer ldisc switch */
1353 /* tty_deferred_ldisc_switch(N_TTY);
1355 This should get done automatically when the port closes and
1356 tty_release is called */
1358 read_lock(&tasklist_lock);
1359 if (tty->session > 0) {
1360 do_each_task_pid(tty->session, PIDTYPE_SID, p) {
1361 spin_lock_irq(&p->sighand->siglock);
1362 if (p->signal->tty == tty)
1363 p->signal->tty = NULL;
1364 if (!p->signal->leader) {
1365 spin_unlock_irq(&p->sighand->siglock);
1368 __group_send_sig_info(SIGHUP, SEND_SIG_PRIV, p);
1369 __group_send_sig_info(SIGCONT, SEND_SIG_PRIV, p);
1371 p->signal->tty_old_pgrp = tty->pgrp;
1372 spin_unlock_irq(&p->sighand->siglock);
1373 } while_each_task_pid(tty->session, PIDTYPE_SID, p);
1375 read_unlock(&tasklist_lock);
1380 tty->ctrl_status = 0;
1382 * If one of the devices matches a console pointer, we
1383 * cannot just call hangup() because that will cause
1384 * tty->count and state->count to go out of sync.
1385 * So we just call close() the right number of times.
1388 if (tty->driver->close)
1389 for (n = 0; n < closecount; n++)
1390 tty->driver->close(tty, cons_filp);
1391 } else if (tty->driver->hangup)
1392 (tty->driver->hangup)(tty);
1394 /* We don't want to have driver/ldisc interactions beyond
1395 the ones we did here. The driver layer expects no
1396 calls after ->hangup() from the ldisc side. However we
1397 can't yet guarantee all that */
1399 set_bit(TTY_HUPPED, &tty->flags);
1401 tty_ldisc_enable(tty);
1402 tty_ldisc_deref(ld);
1410 * tty_hangup - trigger a hangup event
1411 * @tty: tty to hangup
1413 * A carrier loss (virtual or otherwise) has occurred on this like
1414 * schedule a hangup sequence to run after this event.
1417 void tty_hangup(struct tty_struct * tty)
1419 #ifdef TTY_DEBUG_HANGUP
1422 printk(KERN_DEBUG "%s hangup...\n", tty_name(tty, buf));
1424 schedule_work(&tty->hangup_work);
1427 EXPORT_SYMBOL(tty_hangup);
1430 * tty_vhangup - process vhangup
1431 * @tty: tty to hangup
1433 * The user has asked via system call for the terminal to be hung up.
1434 * We do this synchronously so that when the syscall returns the process
1435 * is complete. That guarantee is neccessary for security reasons.
1438 void tty_vhangup(struct tty_struct * tty)
1440 #ifdef TTY_DEBUG_HANGUP
1443 printk(KERN_DEBUG "%s vhangup...\n", tty_name(tty, buf));
1445 do_tty_hangup(&tty->hangup_work);
1447 EXPORT_SYMBOL(tty_vhangup);
1450 * tty_hung_up_p - was tty hung up
1451 * @filp: file pointer of tty
1453 * Return true if the tty has been subject to a vhangup or a carrier
1457 int tty_hung_up_p(struct file * filp)
1459 return (filp->f_op == &hung_up_tty_fops);
1462 EXPORT_SYMBOL(tty_hung_up_p);
1464 static void session_clear_tty(pid_t session)
1466 struct task_struct *p;
1467 do_each_task_pid(session, PIDTYPE_SID, p) {
1469 } while_each_task_pid(session, PIDTYPE_SID, p);
1473 * disassociate_ctty - disconnect controlling tty
1474 * @on_exit: true if exiting so need to "hang up" the session
1476 * This function is typically called only by the session leader, when
1477 * it wants to disassociate itself from its controlling tty.
1479 * It performs the following functions:
1480 * (1) Sends a SIGHUP and SIGCONT to the foreground process group
1481 * (2) Clears the tty from being controlling the session
1482 * (3) Clears the controlling tty for all processes in the
1485 * The argument on_exit is set to 1 if called when a process is
1486 * exiting; it is 0 if called by the ioctl TIOCNOTTY.
1489 * BKL is taken for hysterical raisins
1490 * tty_mutex is taken to protect tty
1491 * ->siglock is taken to protect ->signal/->sighand
1492 * tasklist_lock is taken to walk process list for sessions
1493 * ->siglock is taken to protect ->signal/->sighand
1496 void disassociate_ctty(int on_exit)
1498 struct tty_struct *tty;
1504 mutex_lock(&tty_mutex);
1505 tty = get_current_tty();
1507 tty_pgrp = tty->pgrp;
1508 mutex_unlock(&tty_mutex);
1509 /* XXX: here we race, there is nothing protecting tty */
1510 if (on_exit && tty->driver->type != TTY_DRIVER_TYPE_PTY)
1513 pid_t old_pgrp = current->signal->tty_old_pgrp;
1515 kill_pg(old_pgrp, SIGHUP, on_exit);
1516 kill_pg(old_pgrp, SIGCONT, on_exit);
1518 mutex_unlock(&tty_mutex);
1523 kill_pg(tty_pgrp, SIGHUP, on_exit);
1525 kill_pg(tty_pgrp, SIGCONT, on_exit);
1528 spin_lock_irq(¤t->sighand->siglock);
1529 current->signal->tty_old_pgrp = 0;
1530 session = process_session(current);
1531 spin_unlock_irq(¤t->sighand->siglock);
1533 mutex_lock(&tty_mutex);
1534 /* It is possible that do_tty_hangup has free'd this tty */
1535 tty = get_current_tty();
1540 #ifdef TTY_DEBUG_HANGUP
1541 printk(KERN_DEBUG "error attempted to write to tty [0x%p]"
1545 mutex_unlock(&tty_mutex);
1547 /* Now clear signal->tty under the lock */
1548 read_lock(&tasklist_lock);
1549 session_clear_tty(session);
1550 read_unlock(&tasklist_lock);
1556 * stop_tty - propogate flow control
1559 * Perform flow control to the driver. For PTY/TTY pairs we
1560 * must also propogate the TIOCKPKT status. May be called
1561 * on an already stopped device and will not re-call the driver
1564 * This functionality is used by both the line disciplines for
1565 * halting incoming flow and by the driver. It may therefore be
1566 * called from any context, may be under the tty atomic_write_lock
1570 * Broken. Relies on BKL which is unsafe here.
1573 void stop_tty(struct tty_struct *tty)
1578 if (tty->link && tty->link->packet) {
1579 tty->ctrl_status &= ~TIOCPKT_START;
1580 tty->ctrl_status |= TIOCPKT_STOP;
1581 wake_up_interruptible(&tty->link->read_wait);
1583 if (tty->driver->stop)
1584 (tty->driver->stop)(tty);
1587 EXPORT_SYMBOL(stop_tty);
1590 * start_tty - propogate flow control
1591 * @tty: tty to start
1593 * Start a tty that has been stopped if at all possible. Perform
1594 * any neccessary wakeups and propogate the TIOCPKT status. If this
1595 * is the tty was previous stopped and is being started then the
1596 * driver start method is invoked and the line discipline woken.
1599 * Broken. Relies on BKL which is unsafe here.
1602 void start_tty(struct tty_struct *tty)
1604 if (!tty->stopped || tty->flow_stopped)
1607 if (tty->link && tty->link->packet) {
1608 tty->ctrl_status &= ~TIOCPKT_STOP;
1609 tty->ctrl_status |= TIOCPKT_START;
1610 wake_up_interruptible(&tty->link->read_wait);
1612 if (tty->driver->start)
1613 (tty->driver->start)(tty);
1615 /* If we have a running line discipline it may need kicking */
1617 wake_up_interruptible(&tty->write_wait);
1620 EXPORT_SYMBOL(start_tty);
1623 * tty_read - read method for tty device files
1624 * @file: pointer to tty file
1626 * @count: size of user buffer
1629 * Perform the read system call function on this terminal device. Checks
1630 * for hung up devices before calling the line discipline method.
1633 * Locks the line discipline internally while needed
1634 * For historical reasons the line discipline read method is
1635 * invoked under the BKL. This will go away in time so do not rely on it
1636 * in new code. Multiple read calls may be outstanding in parallel.
1639 static ssize_t tty_read(struct file * file, char __user * buf, size_t count,
1643 struct tty_struct * tty;
1644 struct inode *inode;
1645 struct tty_ldisc *ld;
1647 tty = (struct tty_struct *)file->private_data;
1648 inode = file->f_path.dentry->d_inode;
1649 if (tty_paranoia_check(tty, inode, "tty_read"))
1651 if (!tty || (test_bit(TTY_IO_ERROR, &tty->flags)))
1654 /* We want to wait for the line discipline to sort out in this
1656 ld = tty_ldisc_ref_wait(tty);
1659 i = (ld->read)(tty,file,buf,count);
1662 tty_ldisc_deref(ld);
1665 inode->i_atime = current_fs_time(inode->i_sb);
1670 * Split writes up in sane blocksizes to avoid
1671 * denial-of-service type attacks
1673 static inline ssize_t do_tty_write(
1674 ssize_t (*write)(struct tty_struct *, struct file *, const unsigned char *, size_t),
1675 struct tty_struct *tty,
1677 const char __user *buf,
1680 ssize_t ret = 0, written = 0;
1683 /* FIXME: O_NDELAY ... */
1684 if (mutex_lock_interruptible(&tty->atomic_write_lock)) {
1685 return -ERESTARTSYS;
1689 * We chunk up writes into a temporary buffer. This
1690 * simplifies low-level drivers immensely, since they
1691 * don't have locking issues and user mode accesses.
1693 * But if TTY_NO_WRITE_SPLIT is set, we should use a
1696 * The default chunk-size is 2kB, because the NTTY
1697 * layer has problems with bigger chunks. It will
1698 * claim to be able to handle more characters than
1701 * FIXME: This can probably go away now except that 64K chunks
1702 * are too likely to fail unless switched to vmalloc...
1705 if (test_bit(TTY_NO_WRITE_SPLIT, &tty->flags))
1710 /* write_buf/write_cnt is protected by the atomic_write_lock mutex */
1711 if (tty->write_cnt < chunk) {
1717 buf = kmalloc(chunk, GFP_KERNEL);
1719 mutex_unlock(&tty->atomic_write_lock);
1722 kfree(tty->write_buf);
1723 tty->write_cnt = chunk;
1724 tty->write_buf = buf;
1727 /* Do the write .. */
1729 size_t size = count;
1733 if (copy_from_user(tty->write_buf, buf, size))
1736 ret = write(tty, file, tty->write_buf, size);
1746 if (signal_pending(current))
1751 struct inode *inode = file->f_path.dentry->d_inode;
1752 inode->i_mtime = current_fs_time(inode->i_sb);
1755 mutex_unlock(&tty->atomic_write_lock);
1761 * tty_write - write method for tty device file
1762 * @file: tty file pointer
1763 * @buf: user data to write
1764 * @count: bytes to write
1767 * Write data to a tty device via the line discipline.
1770 * Locks the line discipline as required
1771 * Writes to the tty driver are serialized by the atomic_write_lock
1772 * and are then processed in chunks to the device. The line discipline
1773 * write method will not be involked in parallel for each device
1774 * The line discipline write method is called under the big
1775 * kernel lock for historical reasons. New code should not rely on this.
1778 static ssize_t tty_write(struct file * file, const char __user * buf, size_t count,
1781 struct tty_struct * tty;
1782 struct inode *inode = file->f_path.dentry->d_inode;
1784 struct tty_ldisc *ld;
1786 tty = (struct tty_struct *)file->private_data;
1787 if (tty_paranoia_check(tty, inode, "tty_write"))
1789 if (!tty || !tty->driver->write || (test_bit(TTY_IO_ERROR, &tty->flags)))
1792 ld = tty_ldisc_ref_wait(tty);
1796 ret = do_tty_write(ld->write, tty, file, buf, count);
1797 tty_ldisc_deref(ld);
1801 ssize_t redirected_tty_write(struct file * file, const char __user * buf, size_t count,
1804 struct file *p = NULL;
1806 spin_lock(&redirect_lock);
1811 spin_unlock(&redirect_lock);
1815 res = vfs_write(p, buf, count, &p->f_pos);
1820 return tty_write(file, buf, count, ppos);
1823 static char ptychar[] = "pqrstuvwxyzabcde";
1826 * pty_line_name - generate name for a pty
1827 * @driver: the tty driver in use
1828 * @index: the minor number
1829 * @p: output buffer of at least 6 bytes
1831 * Generate a name from a driver reference and write it to the output
1836 static void pty_line_name(struct tty_driver *driver, int index, char *p)
1838 int i = index + driver->name_base;
1839 /* ->name is initialized to "ttyp", but "tty" is expected */
1840 sprintf(p, "%s%c%x",
1841 driver->subtype == PTY_TYPE_SLAVE ? "tty" : driver->name,
1842 ptychar[i >> 4 & 0xf], i & 0xf);
1846 * pty_line_name - generate name for a tty
1847 * @driver: the tty driver in use
1848 * @index: the minor number
1849 * @p: output buffer of at least 7 bytes
1851 * Generate a name from a driver reference and write it to the output
1856 static void tty_line_name(struct tty_driver *driver, int index, char *p)
1858 sprintf(p, "%s%d", driver->name, index + driver->name_base);
1862 * init_dev - initialise a tty device
1863 * @driver: tty driver we are opening a device on
1864 * @idx: device index
1865 * @tty: returned tty structure
1867 * Prepare a tty device. This may not be a "new" clean device but
1868 * could also be an active device. The pty drivers require special
1869 * handling because of this.
1872 * The function is called under the tty_mutex, which
1873 * protects us from the tty struct or driver itself going away.
1875 * On exit the tty device has the line discipline attached and
1876 * a reference count of 1. If a pair was created for pty/tty use
1877 * and the other was a pty master then it too has a reference count of 1.
1879 * WSH 06/09/97: Rewritten to remove races and properly clean up after a
1880 * failed open. The new code protects the open with a mutex, so it's
1881 * really quite straightforward. The mutex locking can probably be
1882 * relaxed for the (most common) case of reopening a tty.
1885 static int init_dev(struct tty_driver *driver, int idx,
1886 struct tty_struct **ret_tty)
1888 struct tty_struct *tty, *o_tty;
1889 struct ktermios *tp, **tp_loc, *o_tp, **o_tp_loc;
1890 struct ktermios *ltp, **ltp_loc, *o_ltp, **o_ltp_loc;
1893 /* check whether we're reopening an existing tty */
1894 if (driver->flags & TTY_DRIVER_DEVPTS_MEM) {
1895 tty = devpts_get_tty(idx);
1897 * If we don't have a tty here on a slave open, it's because
1898 * the master already started the close process and there's
1899 * no relation between devpts file and tty anymore.
1901 if (!tty && driver->subtype == PTY_TYPE_SLAVE) {
1906 * It's safe from now on because init_dev() is called with
1907 * tty_mutex held and release_dev() won't change tty->count
1908 * or tty->flags without having to grab tty_mutex
1910 if (tty && driver->subtype == PTY_TYPE_MASTER)
1913 tty = driver->ttys[idx];
1915 if (tty) goto fast_track;
1918 * First time open is complex, especially for PTY devices.
1919 * This code guarantees that either everything succeeds and the
1920 * TTY is ready for operation, or else the table slots are vacated
1921 * and the allocated memory released. (Except that the termios
1922 * and locked termios may be retained.)
1925 if (!try_module_get(driver->owner)) {
1934 tty = alloc_tty_struct();
1937 initialize_tty_struct(tty);
1938 tty->driver = driver;
1940 tty_line_name(driver, idx, tty->name);
1942 if (driver->flags & TTY_DRIVER_DEVPTS_MEM) {
1943 tp_loc = &tty->termios;
1944 ltp_loc = &tty->termios_locked;
1946 tp_loc = &driver->termios[idx];
1947 ltp_loc = &driver->termios_locked[idx];
1951 tp = (struct ktermios *) kmalloc(sizeof(struct ktermios),
1955 *tp = driver->init_termios;
1959 ltp = (struct ktermios *) kmalloc(sizeof(struct ktermios),
1963 memset(ltp, 0, sizeof(struct ktermios));
1966 if (driver->type == TTY_DRIVER_TYPE_PTY) {
1967 o_tty = alloc_tty_struct();
1970 initialize_tty_struct(o_tty);
1971 o_tty->driver = driver->other;
1973 tty_line_name(driver->other, idx, o_tty->name);
1975 if (driver->flags & TTY_DRIVER_DEVPTS_MEM) {
1976 o_tp_loc = &o_tty->termios;
1977 o_ltp_loc = &o_tty->termios_locked;
1979 o_tp_loc = &driver->other->termios[idx];
1980 o_ltp_loc = &driver->other->termios_locked[idx];
1984 o_tp = (struct ktermios *)
1985 kmalloc(sizeof(struct ktermios), GFP_KERNEL);
1988 *o_tp = driver->other->init_termios;
1992 o_ltp = (struct ktermios *)
1993 kmalloc(sizeof(struct ktermios), GFP_KERNEL);
1996 memset(o_ltp, 0, sizeof(struct ktermios));
2000 * Everything allocated ... set up the o_tty structure.
2002 if (!(driver->other->flags & TTY_DRIVER_DEVPTS_MEM)) {
2003 driver->other->ttys[idx] = o_tty;
2009 o_tty->termios = *o_tp_loc;
2010 o_tty->termios_locked = *o_ltp_loc;
2011 driver->other->refcount++;
2012 if (driver->subtype == PTY_TYPE_MASTER)
2015 /* Establish the links in both directions */
2021 * All structures have been allocated, so now we install them.
2022 * Failures after this point use release_mem to clean up, so
2023 * there's no need to null out the local pointers.
2025 if (!(driver->flags & TTY_DRIVER_DEVPTS_MEM)) {
2026 driver->ttys[idx] = tty;
2033 tty->termios = *tp_loc;
2034 tty->termios_locked = *ltp_loc;
2035 /* Compatibility until drivers always set this */
2036 tty->termios->c_ispeed = tty_termios_input_baud_rate(tty->termios);
2037 tty->termios->c_ospeed = tty_termios_baud_rate(tty->termios);
2042 * Structures all installed ... call the ldisc open routines.
2043 * If we fail here just call release_mem to clean up. No need
2044 * to decrement the use counts, as release_mem doesn't care.
2047 if (tty->ldisc.open) {
2048 retval = (tty->ldisc.open)(tty);
2050 goto release_mem_out;
2052 if (o_tty && o_tty->ldisc.open) {
2053 retval = (o_tty->ldisc.open)(o_tty);
2055 if (tty->ldisc.close)
2056 (tty->ldisc.close)(tty);
2057 goto release_mem_out;
2059 tty_ldisc_enable(o_tty);
2061 tty_ldisc_enable(tty);
2065 * This fast open can be used if the tty is already open.
2066 * No memory is allocated, and the only failures are from
2067 * attempting to open a closing tty or attempting multiple
2068 * opens on a pty master.
2071 if (test_bit(TTY_CLOSING, &tty->flags)) {
2075 if (driver->type == TTY_DRIVER_TYPE_PTY &&
2076 driver->subtype == PTY_TYPE_MASTER) {
2078 * special case for PTY masters: only one open permitted,
2079 * and the slave side open count is incremented as well.
2088 tty->driver = driver; /* N.B. why do this every time?? */
2091 if(!test_bit(TTY_LDISC, &tty->flags))
2092 printk(KERN_ERR "init_dev but no ldisc\n");
2096 /* All paths come through here to release the mutex */
2100 /* Release locally allocated memory ... nothing placed in slots */
2104 free_tty_struct(o_tty);
2107 free_tty_struct(tty);
2110 module_put(driver->owner);
2114 /* call the tty release_mem routine to clean out this slot */
2116 if (printk_ratelimit())
2117 printk(KERN_INFO "init_dev: ldisc open failed, "
2118 "clearing slot %d\n", idx);
2119 release_mem(tty, idx);
2124 * release_mem - release tty structure memory
2126 * Releases memory associated with a tty structure, and clears out the
2127 * driver table slots. This function is called when a device is no longer
2128 * in use. It also gets called when setup of a device fails.
2131 * tty_mutex - sometimes only
2132 * takes the file list lock internally when working on the list
2133 * of ttys that the driver keeps.
2134 * FIXME: should we require tty_mutex is held here ??
2137 static void release_mem(struct tty_struct *tty, int idx)
2139 struct tty_struct *o_tty;
2140 struct ktermios *tp;
2141 int devpts = tty->driver->flags & TTY_DRIVER_DEVPTS_MEM;
2143 if ((o_tty = tty->link) != NULL) {
2145 o_tty->driver->ttys[idx] = NULL;
2146 if (o_tty->driver->flags & TTY_DRIVER_RESET_TERMIOS) {
2147 tp = o_tty->termios;
2149 o_tty->driver->termios[idx] = NULL;
2152 tp = o_tty->termios_locked;
2154 o_tty->driver->termios_locked[idx] = NULL;
2158 o_tty->driver->refcount--;
2160 list_del_init(&o_tty->tty_files);
2162 free_tty_struct(o_tty);
2166 tty->driver->ttys[idx] = NULL;
2167 if (tty->driver->flags & TTY_DRIVER_RESET_TERMIOS) {
2170 tty->driver->termios[idx] = NULL;
2173 tp = tty->termios_locked;
2175 tty->driver->termios_locked[idx] = NULL;
2180 tty->driver->refcount--;
2182 list_del_init(&tty->tty_files);
2184 module_put(tty->driver->owner);
2185 free_tty_struct(tty);
2189 * Even releasing the tty structures is a tricky business.. We have
2190 * to be very careful that the structures are all released at the
2191 * same time, as interrupts might otherwise get the wrong pointers.
2193 * WSH 09/09/97: rewritten to avoid some nasty race conditions that could
2194 * lead to double frees or releasing memory still in use.
2196 static void release_dev(struct file * filp)
2198 struct tty_struct *tty, *o_tty;
2199 int pty_master, tty_closing, o_tty_closing, do_sleep;
2203 unsigned long flags;
2205 tty = (struct tty_struct *)filp->private_data;
2206 if (tty_paranoia_check(tty, filp->f_path.dentry->d_inode, "release_dev"))
2209 check_tty_count(tty, "release_dev");
2211 tty_fasync(-1, filp, 0);
2214 pty_master = (tty->driver->type == TTY_DRIVER_TYPE_PTY &&
2215 tty->driver->subtype == PTY_TYPE_MASTER);
2216 devpts = (tty->driver->flags & TTY_DRIVER_DEVPTS_MEM) != 0;
2219 #ifdef TTY_PARANOIA_CHECK
2220 if (idx < 0 || idx >= tty->driver->num) {
2221 printk(KERN_DEBUG "release_dev: bad idx when trying to "
2222 "free (%s)\n", tty->name);
2225 if (!(tty->driver->flags & TTY_DRIVER_DEVPTS_MEM)) {
2226 if (tty != tty->driver->ttys[idx]) {
2227 printk(KERN_DEBUG "release_dev: driver.table[%d] not tty "
2228 "for (%s)\n", idx, tty->name);
2231 if (tty->termios != tty->driver->termios[idx]) {
2232 printk(KERN_DEBUG "release_dev: driver.termios[%d] not termios "
2237 if (tty->termios_locked != tty->driver->termios_locked[idx]) {
2238 printk(KERN_DEBUG "release_dev: driver.termios_locked[%d] not "
2239 "termios_locked for (%s)\n",
2246 #ifdef TTY_DEBUG_HANGUP
2247 printk(KERN_DEBUG "release_dev of %s (tty count=%d)...",
2248 tty_name(tty, buf), tty->count);
2251 #ifdef TTY_PARANOIA_CHECK
2252 if (tty->driver->other &&
2253 !(tty->driver->flags & TTY_DRIVER_DEVPTS_MEM)) {
2254 if (o_tty != tty->driver->other->ttys[idx]) {
2255 printk(KERN_DEBUG "release_dev: other->table[%d] "
2256 "not o_tty for (%s)\n",
2260 if (o_tty->termios != tty->driver->other->termios[idx]) {
2261 printk(KERN_DEBUG "release_dev: other->termios[%d] "
2262 "not o_termios for (%s)\n",
2266 if (o_tty->termios_locked !=
2267 tty->driver->other->termios_locked[idx]) {
2268 printk(KERN_DEBUG "release_dev: other->termios_locked["
2269 "%d] not o_termios_locked for (%s)\n",
2273 if (o_tty->link != tty) {
2274 printk(KERN_DEBUG "release_dev: bad pty pointers\n");
2279 if (tty->driver->close)
2280 tty->driver->close(tty, filp);
2283 * Sanity check: if tty->count is going to zero, there shouldn't be
2284 * any waiters on tty->read_wait or tty->write_wait. We test the
2285 * wait queues and kick everyone out _before_ actually starting to
2286 * close. This ensures that we won't block while releasing the tty
2289 * The test for the o_tty closing is necessary, since the master and
2290 * slave sides may close in any order. If the slave side closes out
2291 * first, its count will be one, since the master side holds an open.
2292 * Thus this test wouldn't be triggered at the time the slave closes,
2295 * Note that it's possible for the tty to be opened again while we're
2296 * flushing out waiters. By recalculating the closing flags before
2297 * each iteration we avoid any problems.
2300 /* Guard against races with tty->count changes elsewhere and
2301 opens on /dev/tty */
2303 mutex_lock(&tty_mutex);
2304 tty_closing = tty->count <= 1;
2305 o_tty_closing = o_tty &&
2306 (o_tty->count <= (pty_master ? 1 : 0));
2310 if (waitqueue_active(&tty->read_wait)) {
2311 wake_up(&tty->read_wait);
2314 if (waitqueue_active(&tty->write_wait)) {
2315 wake_up(&tty->write_wait);
2319 if (o_tty_closing) {
2320 if (waitqueue_active(&o_tty->read_wait)) {
2321 wake_up(&o_tty->read_wait);
2324 if (waitqueue_active(&o_tty->write_wait)) {
2325 wake_up(&o_tty->write_wait);
2332 printk(KERN_WARNING "release_dev: %s: read/write wait queue "
2333 "active!\n", tty_name(tty, buf));
2334 mutex_unlock(&tty_mutex);
2339 * The closing flags are now consistent with the open counts on
2340 * both sides, and we've completed the last operation that could
2341 * block, so it's safe to proceed with closing.
2344 if (--o_tty->count < 0) {
2345 printk(KERN_WARNING "release_dev: bad pty slave count "
2347 o_tty->count, tty_name(o_tty, buf));
2351 if (--tty->count < 0) {
2352 printk(KERN_WARNING "release_dev: bad tty->count (%d) for %s\n",
2353 tty->count, tty_name(tty, buf));
2358 * We've decremented tty->count, so we need to remove this file
2359 * descriptor off the tty->tty_files list; this serves two
2361 * - check_tty_count sees the correct number of file descriptors
2362 * associated with this tty.
2363 * - do_tty_hangup no longer sees this file descriptor as
2364 * something that needs to be handled for hangups.
2367 filp->private_data = NULL;
2370 * Perform some housekeeping before deciding whether to return.
2372 * Set the TTY_CLOSING flag if this was the last open. In the
2373 * case of a pty we may have to wait around for the other side
2374 * to close, and TTY_CLOSING makes sure we can't be reopened.
2377 set_bit(TTY_CLOSING, &tty->flags);
2379 set_bit(TTY_CLOSING, &o_tty->flags);
2382 * If _either_ side is closing, make sure there aren't any
2383 * processes that still think tty or o_tty is their controlling
2386 if (tty_closing || o_tty_closing) {
2387 read_lock(&tasklist_lock);
2388 session_clear_tty(tty->session);
2390 session_clear_tty(o_tty->session);
2391 read_unlock(&tasklist_lock);
2394 mutex_unlock(&tty_mutex);
2396 /* check whether both sides are closing ... */
2397 if (!tty_closing || (o_tty && !o_tty_closing))
2400 #ifdef TTY_DEBUG_HANGUP
2401 printk(KERN_DEBUG "freeing tty structure...");
2404 * Prevent flush_to_ldisc() from rescheduling the work for later. Then
2405 * kill any delayed work. As this is the final close it does not
2406 * race with the set_ldisc code path.
2408 clear_bit(TTY_LDISC, &tty->flags);
2409 cancel_delayed_work(&tty->buf.work);
2412 * Wait for ->hangup_work and ->buf.work handlers to terminate
2415 flush_scheduled_work();
2418 * Wait for any short term users (we know they are just driver
2419 * side waiters as the file is closing so user count on the file
2422 spin_lock_irqsave(&tty_ldisc_lock, flags);
2423 while(tty->ldisc.refcount)
2425 spin_unlock_irqrestore(&tty_ldisc_lock, flags);
2426 wait_event(tty_ldisc_wait, tty->ldisc.refcount == 0);
2427 spin_lock_irqsave(&tty_ldisc_lock, flags);
2429 spin_unlock_irqrestore(&tty_ldisc_lock, flags);
2431 * Shutdown the current line discipline, and reset it to N_TTY.
2432 * N.B. why reset ldisc when we're releasing the memory??
2434 * FIXME: this MUST get fixed for the new reflocking
2436 if (tty->ldisc.close)
2437 (tty->ldisc.close)(tty);
2438 tty_ldisc_put(tty->ldisc.num);
2441 * Switch the line discipline back
2443 tty_ldisc_assign(tty, tty_ldisc_get(N_TTY));
2444 tty_set_termios_ldisc(tty,N_TTY);
2446 /* FIXME: could o_tty be in setldisc here ? */
2447 clear_bit(TTY_LDISC, &o_tty->flags);
2448 if (o_tty->ldisc.close)
2449 (o_tty->ldisc.close)(o_tty);
2450 tty_ldisc_put(o_tty->ldisc.num);
2451 tty_ldisc_assign(o_tty, tty_ldisc_get(N_TTY));
2452 tty_set_termios_ldisc(o_tty,N_TTY);
2455 * The release_mem function takes care of the details of clearing
2456 * the slots and preserving the termios structure.
2458 release_mem(tty, idx);
2460 #ifdef CONFIG_UNIX98_PTYS
2461 /* Make this pty number available for reallocation */
2463 down(&allocated_ptys_lock);
2464 idr_remove(&allocated_ptys, idx);
2465 up(&allocated_ptys_lock);
2472 * tty_open - open a tty device
2473 * @inode: inode of device file
2474 * @filp: file pointer to tty
2476 * tty_open and tty_release keep up the tty count that contains the
2477 * number of opens done on a tty. We cannot use the inode-count, as
2478 * different inodes might point to the same tty.
2480 * Open-counting is needed for pty masters, as well as for keeping
2481 * track of serial lines: DTR is dropped when the last close happens.
2482 * (This is not done solely through tty->count, now. - Ted 1/27/92)
2484 * The termios state of a pty is reset on first open so that
2485 * settings don't persist across reuse.
2487 * Locking: tty_mutex protects tty, get_tty_driver and init_dev work.
2488 * tty->count should protect the rest.
2489 * ->siglock protects ->signal/->sighand
2492 static int tty_open(struct inode * inode, struct file * filp)
2494 struct tty_struct *tty;
2496 struct tty_driver *driver;
2498 dev_t device = inode->i_rdev;
2499 unsigned short saved_flags = filp->f_flags;
2501 nonseekable_open(inode, filp);
2504 noctty = filp->f_flags & O_NOCTTY;
2508 mutex_lock(&tty_mutex);
2510 if (device == MKDEV(TTYAUX_MAJOR,0)) {
2511 tty = get_current_tty();
2513 mutex_unlock(&tty_mutex);
2516 driver = tty->driver;
2518 filp->f_flags |= O_NONBLOCK; /* Don't let /dev/tty block */
2523 if (device == MKDEV(TTY_MAJOR,0)) {
2524 extern struct tty_driver *console_driver;
2525 driver = console_driver;
2531 if (device == MKDEV(TTYAUX_MAJOR,1)) {
2532 driver = console_device(&index);
2534 /* Don't let /dev/console block */
2535 filp->f_flags |= O_NONBLOCK;
2539 mutex_unlock(&tty_mutex);
2543 driver = get_tty_driver(device, &index);
2545 mutex_unlock(&tty_mutex);
2549 retval = init_dev(driver, index, &tty);
2550 mutex_unlock(&tty_mutex);
2554 filp->private_data = tty;
2555 file_move(filp, &tty->tty_files);
2556 check_tty_count(tty, "tty_open");
2557 if (tty->driver->type == TTY_DRIVER_TYPE_PTY &&
2558 tty->driver->subtype == PTY_TYPE_MASTER)
2560 #ifdef TTY_DEBUG_HANGUP
2561 printk(KERN_DEBUG "opening %s...", tty->name);
2564 if (tty->driver->open)
2565 retval = tty->driver->open(tty, filp);
2569 filp->f_flags = saved_flags;
2571 if (!retval && test_bit(TTY_EXCLUSIVE, &tty->flags) && !capable(CAP_SYS_ADMIN))
2575 #ifdef TTY_DEBUG_HANGUP
2576 printk(KERN_DEBUG "error %d in opening %s...", retval,
2580 if (retval != -ERESTARTSYS)
2582 if (signal_pending(current))
2586 * Need to reset f_op in case a hangup happened.
2588 if (filp->f_op == &hung_up_tty_fops)
2589 filp->f_op = &tty_fops;
2593 mutex_lock(&tty_mutex);
2594 spin_lock_irq(¤t->sighand->siglock);
2596 current->signal->leader &&
2597 !current->signal->tty &&
2599 __proc_set_tty(current, tty);
2600 spin_unlock_irq(¤t->sighand->siglock);
2601 mutex_unlock(&tty_mutex);
2605 #ifdef CONFIG_UNIX98_PTYS
2607 * ptmx_open - open a unix 98 pty master
2608 * @inode: inode of device file
2609 * @filp: file pointer to tty
2611 * Allocate a unix98 pty master device from the ptmx driver.
2613 * Locking: tty_mutex protects theinit_dev work. tty->count should
2615 * allocated_ptys_lock handles the list of free pty numbers
2618 static int ptmx_open(struct inode * inode, struct file * filp)
2620 struct tty_struct *tty;
2625 nonseekable_open(inode, filp);
2627 /* find a device that is not in use. */
2628 down(&allocated_ptys_lock);
2629 if (!idr_pre_get(&allocated_ptys, GFP_KERNEL)) {
2630 up(&allocated_ptys_lock);
2633 idr_ret = idr_get_new(&allocated_ptys, NULL, &index);
2635 up(&allocated_ptys_lock);
2636 if (idr_ret == -EAGAIN)
2640 if (index >= pty_limit) {
2641 idr_remove(&allocated_ptys, index);
2642 up(&allocated_ptys_lock);
2645 up(&allocated_ptys_lock);
2647 mutex_lock(&tty_mutex);
2648 retval = init_dev(ptm_driver, index, &tty);
2649 mutex_unlock(&tty_mutex);
2654 set_bit(TTY_PTY_LOCK, &tty->flags); /* LOCK THE SLAVE */
2655 filp->private_data = tty;
2656 file_move(filp, &tty->tty_files);
2659 if (devpts_pty_new(tty->link))
2662 check_tty_count(tty, "tty_open");
2663 retval = ptm_driver->open(tty, filp);
2670 down(&allocated_ptys_lock);
2671 idr_remove(&allocated_ptys, index);
2672 up(&allocated_ptys_lock);
2678 * tty_release - vfs callback for close
2679 * @inode: inode of tty
2680 * @filp: file pointer for handle to tty
2682 * Called the last time each file handle is closed that references
2683 * this tty. There may however be several such references.
2686 * Takes bkl. See release_dev
2689 static int tty_release(struct inode * inode, struct file * filp)
2698 * tty_poll - check tty status
2699 * @filp: file being polled
2700 * @wait: poll wait structures to update
2702 * Call the line discipline polling method to obtain the poll
2703 * status of the device.
2705 * Locking: locks called line discipline but ldisc poll method
2706 * may be re-entered freely by other callers.
2709 static unsigned int tty_poll(struct file * filp, poll_table * wait)
2711 struct tty_struct * tty;
2712 struct tty_ldisc *ld;
2715 tty = (struct tty_struct *)filp->private_data;
2716 if (tty_paranoia_check(tty, filp->f_path.dentry->d_inode, "tty_poll"))
2719 ld = tty_ldisc_ref_wait(tty);
2721 ret = (ld->poll)(tty, filp, wait);
2722 tty_ldisc_deref(ld);
2726 static int tty_fasync(int fd, struct file * filp, int on)
2728 struct tty_struct * tty;
2731 tty = (struct tty_struct *)filp->private_data;
2732 if (tty_paranoia_check(tty, filp->f_path.dentry->d_inode, "tty_fasync"))
2735 retval = fasync_helper(fd, filp, on, &tty->fasync);
2740 if (!waitqueue_active(&tty->read_wait))
2741 tty->minimum_to_wake = 1;
2742 retval = f_setown(filp, (-tty->pgrp) ? : current->pid, 0);
2746 if (!tty->fasync && !waitqueue_active(&tty->read_wait))
2747 tty->minimum_to_wake = N_TTY_BUF_SIZE;
2753 * tiocsti - fake input character
2754 * @tty: tty to fake input into
2755 * @p: pointer to character
2757 * Fake input to a tty device. Does the neccessary locking and
2760 * FIXME: does not honour flow control ??
2763 * Called functions take tty_ldisc_lock
2764 * current->signal->tty check is safe without locks
2766 * FIXME: may race normal receive processing
2769 static int tiocsti(struct tty_struct *tty, char __user *p)
2772 struct tty_ldisc *ld;
2774 if ((current->signal->tty != tty) && !capable(CAP_SYS_ADMIN))
2776 if (get_user(ch, p))
2778 ld = tty_ldisc_ref_wait(tty);
2779 ld->receive_buf(tty, &ch, &mbz, 1);
2780 tty_ldisc_deref(ld);
2785 * tiocgwinsz - implement window query ioctl
2787 * @arg: user buffer for result
2789 * Copies the kernel idea of the window size into the user buffer.
2791 * Locking: tty->termios_mutex is taken to ensure the winsize data
2795 static int tiocgwinsz(struct tty_struct *tty, struct winsize __user * arg)
2799 mutex_lock(&tty->termios_mutex);
2800 err = copy_to_user(arg, &tty->winsize, sizeof(*arg));
2801 mutex_unlock(&tty->termios_mutex);
2803 return err ? -EFAULT: 0;
2807 * tiocswinsz - implement window size set ioctl
2809 * @arg: user buffer for result
2811 * Copies the user idea of the window size to the kernel. Traditionally
2812 * this is just advisory information but for the Linux console it
2813 * actually has driver level meaning and triggers a VC resize.
2816 * Called function use the console_sem is used to ensure we do
2817 * not try and resize the console twice at once.
2818 * The tty->termios_mutex is used to ensure we don't double
2819 * resize and get confused. Lock order - tty->termios_mutex before
2823 static int tiocswinsz(struct tty_struct *tty, struct tty_struct *real_tty,
2824 struct winsize __user * arg)
2826 struct winsize tmp_ws;
2828 if (copy_from_user(&tmp_ws, arg, sizeof(*arg)))
2831 mutex_lock(&tty->termios_mutex);
2832 if (!memcmp(&tmp_ws, &tty->winsize, sizeof(*arg)))
2836 if (tty->driver->type == TTY_DRIVER_TYPE_CONSOLE) {
2837 if (vc_lock_resize(tty->driver_data, tmp_ws.ws_col,
2839 mutex_unlock(&tty->termios_mutex);
2845 kill_pg(tty->pgrp, SIGWINCH, 1);
2846 if ((real_tty->pgrp != tty->pgrp) && (real_tty->pgrp > 0))
2847 kill_pg(real_tty->pgrp, SIGWINCH, 1);
2848 tty->winsize = tmp_ws;
2849 real_tty->winsize = tmp_ws;
2851 mutex_unlock(&tty->termios_mutex);
2856 * tioccons - allow admin to move logical console
2857 * @file: the file to become console
2859 * Allow the adminstrator to move the redirected console device
2861 * Locking: uses redirect_lock to guard the redirect information
2864 static int tioccons(struct file *file)
2866 if (!capable(CAP_SYS_ADMIN))
2868 if (file->f_op->write == redirected_tty_write) {
2870 spin_lock(&redirect_lock);
2873 spin_unlock(&redirect_lock);
2878 spin_lock(&redirect_lock);
2880 spin_unlock(&redirect_lock);
2885 spin_unlock(&redirect_lock);
2890 * fionbio - non blocking ioctl
2891 * @file: file to set blocking value
2892 * @p: user parameter
2894 * Historical tty interfaces had a blocking control ioctl before
2895 * the generic functionality existed. This piece of history is preserved
2896 * in the expected tty API of posix OS's.
2898 * Locking: none, the open fle handle ensures it won't go away.
2901 static int fionbio(struct file *file, int __user *p)
2905 if (get_user(nonblock, p))
2909 file->f_flags |= O_NONBLOCK;
2911 file->f_flags &= ~O_NONBLOCK;
2916 * tiocsctty - set controlling tty
2917 * @tty: tty structure
2918 * @arg: user argument
2920 * This ioctl is used to manage job control. It permits a session
2921 * leader to set this tty as the controlling tty for the session.
2924 * Takes tty_mutex() to protect tty instance
2925 * Takes tasklist_lock internally to walk sessions
2926 * Takes ->siglock() when updating signal->tty
2929 static int tiocsctty(struct tty_struct *tty, int arg)
2932 if (current->signal->leader &&
2933 (process_session(current) == tty->session))
2936 mutex_lock(&tty_mutex);
2938 * The process must be a session leader and
2939 * not have a controlling tty already.
2941 if (!current->signal->leader || current->signal->tty) {
2946 if (tty->session > 0) {
2948 * This tty is already the controlling
2949 * tty for another session group!
2951 if ((arg == 1) && capable(CAP_SYS_ADMIN)) {
2955 read_lock(&tasklist_lock);
2956 session_clear_tty(tty->session);
2957 read_unlock(&tasklist_lock);
2963 proc_set_tty(current, tty);
2965 mutex_unlock(&tty_mutex);
2970 * tiocgpgrp - get process group
2971 * @tty: tty passed by user
2972 * @real_tty: tty side of the tty pased by the user if a pty else the tty
2975 * Obtain the process group of the tty. If there is no process group
2978 * Locking: none. Reference to current->signal->tty is safe.
2981 static int tiocgpgrp(struct tty_struct *tty, struct tty_struct *real_tty, pid_t __user *p)
2985 * (tty == real_tty) is a cheap way of
2986 * testing if the tty is NOT a master pty.
2988 if (tty == real_tty && current->signal->tty != real_tty)
2991 pgrp = vx_map_pid(real_tty->pgrp);
2992 return put_user(pgrp, p);
2996 * tiocspgrp - attempt to set process group
2997 * @tty: tty passed by user
2998 * @real_tty: tty side device matching tty passed by user
3001 * Set the process group of the tty to the session passed. Only
3002 * permitted where the tty session is our session.
3007 static int tiocspgrp(struct tty_struct *tty, struct tty_struct *real_tty, pid_t __user *p)
3010 int retval = tty_check_change(real_tty);
3016 if (!current->signal->tty ||
3017 (current->signal->tty != real_tty) ||
3018 (real_tty->session != process_session(current)))
3020 if (get_user(pgrp, p))
3023 pgrp = vx_rmap_pid(pgrp);
3026 if (session_of_pgrp(pgrp) != process_session(current))
3028 real_tty->pgrp = pgrp;
3033 * tiocgsid - get session id
3034 * @tty: tty passed by user
3035 * @real_tty: tty side of the tty pased by the user if a pty else the tty
3036 * @p: pointer to returned session id
3038 * Obtain the session id of the tty. If there is no session
3041 * Locking: none. Reference to current->signal->tty is safe.
3044 static int tiocgsid(struct tty_struct *tty, struct tty_struct *real_tty, pid_t __user *p)
3047 * (tty == real_tty) is a cheap way of
3048 * testing if the tty is NOT a master pty.
3050 if (tty == real_tty && current->signal->tty != real_tty)
3052 if (real_tty->session <= 0)
3054 return put_user(real_tty->session, p);
3058 * tiocsetd - set line discipline
3060 * @p: pointer to user data
3062 * Set the line discipline according to user request.
3064 * Locking: see tty_set_ldisc, this function is just a helper
3067 static int tiocsetd(struct tty_struct *tty, int __user *p)
3071 if (get_user(ldisc, p))
3073 return tty_set_ldisc(tty, ldisc);
3077 * send_break - performed time break
3078 * @tty: device to break on
3079 * @duration: timeout in mS
3081 * Perform a timed break on hardware that lacks its own driver level
3082 * timed break functionality.
3085 * atomic_write_lock serializes
3089 static int send_break(struct tty_struct *tty, unsigned int duration)
3091 if (mutex_lock_interruptible(&tty->atomic_write_lock))
3093 tty->driver->break_ctl(tty, -1);
3094 if (!signal_pending(current)) {
3095 msleep_interruptible(duration);
3097 tty->driver->break_ctl(tty, 0);
3098 mutex_unlock(&tty->atomic_write_lock);
3099 if (signal_pending(current))
3105 * tiocmget - get modem status
3107 * @file: user file pointer
3108 * @p: pointer to result
3110 * Obtain the modem status bits from the tty driver if the feature
3111 * is supported. Return -EINVAL if it is not available.
3113 * Locking: none (up to the driver)
3116 static int tty_tiocmget(struct tty_struct *tty, struct file *file, int __user *p)
3118 int retval = -EINVAL;
3120 if (tty->driver->tiocmget) {
3121 retval = tty->driver->tiocmget(tty, file);
3124 retval = put_user(retval, p);
3130 * tiocmset - set modem status
3132 * @file: user file pointer
3133 * @cmd: command - clear bits, set bits or set all
3134 * @p: pointer to desired bits
3136 * Set the modem status bits from the tty driver if the feature
3137 * is supported. Return -EINVAL if it is not available.
3139 * Locking: none (up to the driver)
3142 static int tty_tiocmset(struct tty_struct *tty, struct file *file, unsigned int cmd,
3145 int retval = -EINVAL;
3147 if (tty->driver->tiocmset) {
3148 unsigned int set, clear, val;
3150 retval = get_user(val, p);
3168 set &= TIOCM_DTR|TIOCM_RTS|TIOCM_OUT1|TIOCM_OUT2|TIOCM_LOOP;
3169 clear &= TIOCM_DTR|TIOCM_RTS|TIOCM_OUT1|TIOCM_OUT2|TIOCM_LOOP;
3171 retval = tty->driver->tiocmset(tty, file, set, clear);
3177 * Split this up, as gcc can choke on it otherwise..
3179 int tty_ioctl(struct inode * inode, struct file * file,
3180 unsigned int cmd, unsigned long arg)
3182 struct tty_struct *tty, *real_tty;
3183 void __user *p = (void __user *)arg;
3185 struct tty_ldisc *ld;
3187 tty = (struct tty_struct *)file->private_data;
3188 if (tty_paranoia_check(tty, inode, "tty_ioctl"))
3191 /* CHECKME: is this safe as one end closes ? */
3194 if (tty->driver->type == TTY_DRIVER_TYPE_PTY &&
3195 tty->driver->subtype == PTY_TYPE_MASTER)
3196 real_tty = tty->link;
3199 * Break handling by driver
3201 if (!tty->driver->break_ctl) {
3205 if (tty->driver->ioctl)
3206 return tty->driver->ioctl(tty, file, cmd, arg);
3209 /* These two ioctl's always return success; even if */
3210 /* the driver doesn't support them. */
3213 if (!tty->driver->ioctl)
3215 retval = tty->driver->ioctl(tty, file, cmd, arg);
3216 if (retval == -ENOIOCTLCMD)
3223 * Factor out some common prep work
3231 retval = tty_check_change(tty);
3234 if (cmd != TIOCCBRK) {
3235 tty_wait_until_sent(tty, 0);
3236 if (signal_pending(current))
3244 return tiocsti(tty, p);
3246 return tiocgwinsz(tty, p);
3248 return tiocswinsz(tty, real_tty, p);
3250 return real_tty!=tty ? -EINVAL : tioccons(file);
3252 return fionbio(file, p);
3254 set_bit(TTY_EXCLUSIVE, &tty->flags);
3257 clear_bit(TTY_EXCLUSIVE, &tty->flags);
3260 if (current->signal->tty != tty)
3262 if (current->signal->leader)
3263 disassociate_ctty(0);
3264 proc_clear_tty(current);
3267 return tiocsctty(tty, arg);
3269 return tiocgpgrp(tty, real_tty, p);
3271 return tiocspgrp(tty, real_tty, p);
3273 return tiocgsid(tty, real_tty, p);
3275 /* FIXME: check this is ok */
3276 return put_user(tty->ldisc.num, (int __user *)p);
3278 return tiocsetd(tty, p);
3281 return tioclinux(tty, arg);
3286 case TIOCSBRK: /* Turn break on, unconditionally */
3287 tty->driver->break_ctl(tty, -1);
3290 case TIOCCBRK: /* Turn break off, unconditionally */
3291 tty->driver->break_ctl(tty, 0);
3293 case TCSBRK: /* SVID version: non-zero arg --> no break */
3294 /* non-zero arg means wait for all output data
3295 * to be sent (performed above) but don't send break.
3296 * This is used by the tcdrain() termios function.
3299 return send_break(tty, 250);
3301 case TCSBRKP: /* support for POSIX tcsendbreak() */
3302 return send_break(tty, arg ? arg*100 : 250);
3305 return tty_tiocmget(tty, file, p);
3310 return tty_tiocmset(tty, file, cmd, p);
3312 if (tty->driver->ioctl) {
3313 retval = (tty->driver->ioctl)(tty, file, cmd, arg);
3314 if (retval != -ENOIOCTLCMD)
3317 ld = tty_ldisc_ref_wait(tty);
3320 retval = ld->ioctl(tty, file, cmd, arg);
3321 if (retval == -ENOIOCTLCMD)
3324 tty_ldisc_deref(ld);
3330 * This implements the "Secure Attention Key" --- the idea is to
3331 * prevent trojan horses by killing all processes associated with this
3332 * tty when the user hits the "Secure Attention Key". Required for
3333 * super-paranoid applications --- see the Orange Book for more details.
3335 * This code could be nicer; ideally it should send a HUP, wait a few
3336 * seconds, then send a INT, and then a KILL signal. But you then
3337 * have to coordinate with the init process, since all processes associated
3338 * with the current tty must be dead before the new getty is allowed
3341 * Now, if it would be correct ;-/ The current code has a nasty hole -
3342 * it doesn't catch files in flight. We may send the descriptor to ourselves
3343 * via AF_UNIX socket, close it and later fetch from socket. FIXME.
3345 * Nasty bug: do_SAK is being called in interrupt context. This can
3346 * deadlock. We punt it up to process context. AKPM - 16Mar2001
3348 static void __do_SAK(struct work_struct *work)
3350 struct tty_struct *tty =
3351 container_of(work, struct tty_struct, SAK_work);
3355 struct task_struct *g, *p;
3359 struct fdtable *fdt;
3363 session = tty->session;
3365 tty_ldisc_flush(tty);
3367 if (tty->driver->flush_buffer)
3368 tty->driver->flush_buffer(tty);
3370 read_lock(&tasklist_lock);
3371 /* Kill the entire session */
3372 do_each_task_pid(session, PIDTYPE_SID, p) {
3373 printk(KERN_NOTICE "SAK: killed process %d"
3374 " (%s): process_session(p)==tty->session\n",
3376 send_sig(SIGKILL, p, 1);
3377 } while_each_task_pid(session, PIDTYPE_SID, p);
3378 /* Now kill any processes that happen to have the
3381 do_each_thread(g, p) {
3382 if (p->signal->tty == tty) {
3383 printk(KERN_NOTICE "SAK: killed process %d"
3384 " (%s): process_session(p)==tty->session\n",
3386 send_sig(SIGKILL, p, 1);
3392 * We don't take a ref to the file, so we must
3393 * hold ->file_lock instead.
3395 spin_lock(&p->files->file_lock);
3396 fdt = files_fdtable(p->files);
3397 for (i=0; i < fdt->max_fds; i++) {
3398 filp = fcheck_files(p->files, i);
3401 if (filp->f_op->read == tty_read &&
3402 filp->private_data == tty) {
3403 printk(KERN_NOTICE "SAK: killed process %d"
3404 " (%s): fd#%d opened to the tty\n",
3405 p->pid, p->comm, i);
3406 force_sig(SIGKILL, p);
3410 spin_unlock(&p->files->file_lock);
3413 } while_each_thread(g, p);
3414 read_unlock(&tasklist_lock);
3419 * The tq handling here is a little racy - tty->SAK_work may already be queued.
3420 * Fortunately we don't need to worry, because if ->SAK_work is already queued,
3421 * the values which we write to it will be identical to the values which it
3422 * already has. --akpm
3424 void do_SAK(struct tty_struct *tty)
3428 PREPARE_WORK(&tty->SAK_work, __do_SAK);
3429 schedule_work(&tty->SAK_work);
3432 EXPORT_SYMBOL(do_SAK);
3436 * @work: tty structure passed from work queue.
3438 * This routine is called out of the software interrupt to flush data
3439 * from the buffer chain to the line discipline.
3441 * Locking: holds tty->buf.lock to guard buffer list. Drops the lock
3442 * while invoking the line discipline receive_buf method. The
3443 * receive_buf method is single threaded for each tty instance.
3446 static void flush_to_ldisc(struct work_struct *work)
3448 struct tty_struct *tty =
3449 container_of(work, struct tty_struct, buf.work.work);
3450 unsigned long flags;
3451 struct tty_ldisc *disc;
3452 struct tty_buffer *tbuf, *head;
3454 unsigned char *flag_buf;
3456 disc = tty_ldisc_ref(tty);
3457 if (disc == NULL) /* !TTY_LDISC */
3460 spin_lock_irqsave(&tty->buf.lock, flags);
3461 head = tty->buf.head;
3463 tty->buf.head = NULL;
3465 int count = head->commit - head->read;
3467 if (head->next == NULL)
3471 tty_buffer_free(tty, tbuf);
3474 if (!tty->receive_room) {
3475 schedule_delayed_work(&tty->buf.work, 1);
3478 if (count > tty->receive_room)
3479 count = tty->receive_room;
3480 char_buf = head->char_buf_ptr + head->read;
3481 flag_buf = head->flag_buf_ptr + head->read;
3482 head->read += count;
3483 spin_unlock_irqrestore(&tty->buf.lock, flags);
3484 disc->receive_buf(tty, char_buf, flag_buf, count);
3485 spin_lock_irqsave(&tty->buf.lock, flags);
3487 tty->buf.head = head;
3489 spin_unlock_irqrestore(&tty->buf.lock, flags);
3491 tty_ldisc_deref(disc);
3495 * tty_flip_buffer_push - terminal
3498 * Queue a push of the terminal flip buffers to the line discipline. This
3499 * function must not be called from IRQ context if tty->low_latency is set.
3501 * In the event of the queue being busy for flipping the work will be
3502 * held off and retried later.
3504 * Locking: tty buffer lock. Driver locks in low latency mode.
3507 void tty_flip_buffer_push(struct tty_struct *tty)
3509 unsigned long flags;
3510 spin_lock_irqsave(&tty->buf.lock, flags);
3511 if (tty->buf.tail != NULL)
3512 tty->buf.tail->commit = tty->buf.tail->used;
3513 spin_unlock_irqrestore(&tty->buf.lock, flags);
3515 if (tty->low_latency)
3516 flush_to_ldisc(&tty->buf.work.work);
3518 schedule_delayed_work(&tty->buf.work, 1);
3521 EXPORT_SYMBOL(tty_flip_buffer_push);
3525 * initialize_tty_struct
3526 * @tty: tty to initialize
3528 * This subroutine initializes a tty structure that has been newly
3531 * Locking: none - tty in question must not be exposed at this point
3534 static void initialize_tty_struct(struct tty_struct *tty)
3536 memset(tty, 0, sizeof(struct tty_struct));
3537 tty->magic = TTY_MAGIC;
3538 tty_ldisc_assign(tty, tty_ldisc_get(N_TTY));
3540 tty->overrun_time = jiffies;
3541 tty->buf.head = tty->buf.tail = NULL;
3542 tty_buffer_init(tty);
3543 INIT_DELAYED_WORK(&tty->buf.work, flush_to_ldisc);
3544 init_MUTEX(&tty->buf.pty_sem);
3545 mutex_init(&tty->termios_mutex);
3546 init_waitqueue_head(&tty->write_wait);
3547 init_waitqueue_head(&tty->read_wait);
3548 INIT_WORK(&tty->hangup_work, do_tty_hangup);
3549 mutex_init(&tty->atomic_read_lock);
3550 mutex_init(&tty->atomic_write_lock);
3551 spin_lock_init(&tty->read_lock);
3552 INIT_LIST_HEAD(&tty->tty_files);
3553 INIT_WORK(&tty->SAK_work, NULL);
3557 * The default put_char routine if the driver did not define one.
3560 static void tty_default_put_char(struct tty_struct *tty, unsigned char ch)
3562 tty->driver->write(tty, &ch, 1);
3565 static struct class *tty_class;
3568 * tty_register_device - register a tty device
3569 * @driver: the tty driver that describes the tty device
3570 * @index: the index in the tty driver for this tty device
3571 * @device: a struct device that is associated with this tty device.
3572 * This field is optional, if there is no known struct device
3573 * for this tty device it can be set to NULL safely.
3575 * Returns a pointer to the struct device for this tty device
3576 * (or ERR_PTR(-EFOO) on error).
3578 * This call is required to be made to register an individual tty device
3579 * if the tty driver's flags have the TTY_DRIVER_DYNAMIC_DEV bit set. If
3580 * that bit is not set, this function should not be called by a tty
3586 struct device *tty_register_device(struct tty_driver *driver, unsigned index,
3587 struct device *device)
3590 dev_t dev = MKDEV(driver->major, driver->minor_start) + index;
3592 if (index >= driver->num) {
3593 printk(KERN_ERR "Attempt to register invalid tty line number "
3595 return ERR_PTR(-EINVAL);
3598 if (driver->type == TTY_DRIVER_TYPE_PTY)
3599 pty_line_name(driver, index, name);
3601 tty_line_name(driver, index, name);
3603 return device_create(tty_class, device, dev, name);
3607 * tty_unregister_device - unregister a tty device
3608 * @driver: the tty driver that describes the tty device
3609 * @index: the index in the tty driver for this tty device
3611 * If a tty device is registered with a call to tty_register_device() then
3612 * this function must be called when the tty device is gone.
3617 void tty_unregister_device(struct tty_driver *driver, unsigned index)
3619 device_destroy(tty_class, MKDEV(driver->major, driver->minor_start) + index);
3622 EXPORT_SYMBOL(tty_register_device);
3623 EXPORT_SYMBOL(tty_unregister_device);
3625 struct tty_driver *alloc_tty_driver(int lines)
3627 struct tty_driver *driver;
3629 driver = kmalloc(sizeof(struct tty_driver), GFP_KERNEL);
3631 memset(driver, 0, sizeof(struct tty_driver));
3632 driver->magic = TTY_DRIVER_MAGIC;
3633 driver->num = lines;
3634 /* later we'll move allocation of tables here */
3639 void put_tty_driver(struct tty_driver *driver)
3644 void tty_set_operations(struct tty_driver *driver,
3645 const struct tty_operations *op)
3647 driver->open = op->open;
3648 driver->close = op->close;
3649 driver->write = op->write;
3650 driver->put_char = op->put_char;
3651 driver->flush_chars = op->flush_chars;
3652 driver->write_room = op->write_room;
3653 driver->chars_in_buffer = op->chars_in_buffer;
3654 driver->ioctl = op->ioctl;
3655 driver->set_termios = op->set_termios;
3656 driver->throttle = op->throttle;
3657 driver->unthrottle = op->unthrottle;
3658 driver->stop = op->stop;
3659 driver->start = op->start;
3660 driver->hangup = op->hangup;
3661 driver->break_ctl = op->break_ctl;
3662 driver->flush_buffer = op->flush_buffer;
3663 driver->set_ldisc = op->set_ldisc;
3664 driver->wait_until_sent = op->wait_until_sent;
3665 driver->send_xchar = op->send_xchar;
3666 driver->read_proc = op->read_proc;
3667 driver->write_proc = op->write_proc;
3668 driver->tiocmget = op->tiocmget;
3669 driver->tiocmset = op->tiocmset;
3673 EXPORT_SYMBOL(alloc_tty_driver);
3674 EXPORT_SYMBOL(put_tty_driver);
3675 EXPORT_SYMBOL(tty_set_operations);
3678 * Called by a tty driver to register itself.
3680 int tty_register_driver(struct tty_driver *driver)
3687 if (driver->flags & TTY_DRIVER_INSTALLED)
3690 if (!(driver->flags & TTY_DRIVER_DEVPTS_MEM)) {
3691 p = kmalloc(driver->num * 3 * sizeof(void *), GFP_KERNEL);
3694 memset(p, 0, driver->num * 3 * sizeof(void *));
3697 if (!driver->major) {
3698 error = alloc_chrdev_region(&dev, driver->minor_start, driver->num,
3699 (char*)driver->name);
3701 driver->major = MAJOR(dev);
3702 driver->minor_start = MINOR(dev);
3705 dev = MKDEV(driver->major, driver->minor_start);
3706 error = register_chrdev_region(dev, driver->num,
3707 (char*)driver->name);
3715 driver->ttys = (struct tty_struct **)p;
3716 driver->termios = (struct ktermios **)(p + driver->num);
3717 driver->termios_locked = (struct ktermios **)(p + driver->num * 2);
3719 driver->ttys = NULL;
3720 driver->termios = NULL;
3721 driver->termios_locked = NULL;
3724 cdev_init(&driver->cdev, &tty_fops);
3725 driver->cdev.owner = driver->owner;
3726 error = cdev_add(&driver->cdev, dev, driver->num);
3728 unregister_chrdev_region(dev, driver->num);
3729 driver->ttys = NULL;
3730 driver->termios = driver->termios_locked = NULL;
3735 if (!driver->put_char)
3736 driver->put_char = tty_default_put_char;
3738 list_add(&driver->tty_drivers, &tty_drivers);
3740 if ( !(driver->flags & TTY_DRIVER_DYNAMIC_DEV) ) {
3741 for(i = 0; i < driver->num; i++)
3742 tty_register_device(driver, i, NULL);
3744 proc_tty_register_driver(driver);
3748 EXPORT_SYMBOL(tty_register_driver);
3751 * Called by a tty driver to unregister itself.
3753 int tty_unregister_driver(struct tty_driver *driver)
3756 struct ktermios *tp;
3759 if (driver->refcount)
3762 unregister_chrdev_region(MKDEV(driver->major, driver->minor_start),
3765 list_del(&driver->tty_drivers);
3768 * Free the termios and termios_locked structures because
3769 * we don't want to get memory leaks when modular tty
3770 * drivers are removed from the kernel.
3772 for (i = 0; i < driver->num; i++) {
3773 tp = driver->termios[i];
3775 driver->termios[i] = NULL;
3778 tp = driver->termios_locked[i];
3780 driver->termios_locked[i] = NULL;
3783 if (!(driver->flags & TTY_DRIVER_DYNAMIC_DEV))
3784 tty_unregister_device(driver, i);
3787 proc_tty_unregister_driver(driver);
3788 driver->ttys = NULL;
3789 driver->termios = driver->termios_locked = NULL;
3791 cdev_del(&driver->cdev);
3794 EXPORT_SYMBOL(tty_unregister_driver);
3796 dev_t tty_devnum(struct tty_struct *tty)
3799 WARN_ON(!tty->magic);
3800 WARN_ON(!tty->driver);
3801 return MKDEV(tty->driver->major, tty->driver->minor_start) + tty->index;
3803 EXPORT_SYMBOL(tty_devnum);
3805 void proc_clear_tty(struct task_struct *p)
3807 spin_lock_irq(&p->sighand->siglock);
3808 p->signal->tty = NULL;
3809 spin_unlock_irq(&p->sighand->siglock);
3811 EXPORT_SYMBOL(proc_clear_tty);
3813 void __proc_set_tty(struct task_struct *tsk, struct tty_struct *tty)
3816 tty->session = process_session(tsk);
3817 tty->pgrp = process_group(tsk);
3819 tsk->signal->tty = tty;
3820 tsk->signal->tty_old_pgrp = 0;
3823 void proc_set_tty(struct task_struct *tsk, struct tty_struct *tty)
3825 spin_lock_irq(&tsk->sighand->siglock);
3826 __proc_set_tty(tsk, tty);
3827 spin_unlock_irq(&tsk->sighand->siglock);
3830 struct tty_struct *get_current_tty(void)
3832 struct tty_struct *tty;
3833 WARN_ON_ONCE(!mutex_is_locked(&tty_mutex));
3834 tty = current->signal->tty;
3836 * session->tty can be changed/cleared from under us, make sure we
3837 * issue the load. The obtained pointer, when not NULL, is valid as
3838 * long as we hold tty_mutex.
3843 EXPORT_SYMBOL_GPL(get_current_tty);
3846 * Initialize the console device. This is called *early*, so
3847 * we can't necessarily depend on lots of kernel help here.
3848 * Just do some early initializations, and do the complex setup
3851 void __init console_init(void)
3855 /* Setup the default TTY line discipline. */
3856 (void) tty_register_ldisc(N_TTY, &tty_ldisc_N_TTY);
3859 * set up the console device so that later boot sequences can
3860 * inform about problems etc..
3862 #ifdef CONFIG_EARLY_PRINTK
3863 disable_early_printk();
3865 call = __con_initcall_start;
3866 while (call < __con_initcall_end) {
3873 extern int vty_init(void);
3876 static int __init tty_class_init(void)
3878 tty_class = class_create(THIS_MODULE, "tty");
3879 if (IS_ERR(tty_class))
3880 return PTR_ERR(tty_class);
3884 postcore_initcall(tty_class_init);
3886 /* 3/2004 jmc: why do these devices exist? */
3888 static struct cdev tty_cdev, console_cdev;
3889 #ifdef CONFIG_UNIX98_PTYS
3890 static struct cdev ptmx_cdev;
3893 static struct cdev vc0_cdev;
3897 * Ok, now we can initialize the rest of the tty devices and can count
3898 * on memory allocations, interrupts etc..
3900 static int __init tty_init(void)
3902 cdev_init(&tty_cdev, &tty_fops);
3903 if (cdev_add(&tty_cdev, MKDEV(TTYAUX_MAJOR, 0), 1) ||
3904 register_chrdev_region(MKDEV(TTYAUX_MAJOR, 0), 1, "/dev/tty") < 0)
3905 panic("Couldn't register /dev/tty driver\n");
3906 device_create(tty_class, NULL, MKDEV(TTYAUX_MAJOR, 0), "tty");
3908 cdev_init(&console_cdev, &console_fops);
3909 if (cdev_add(&console_cdev, MKDEV(TTYAUX_MAJOR, 1), 1) ||
3910 register_chrdev_region(MKDEV(TTYAUX_MAJOR, 1), 1, "/dev/console") < 0)
3911 panic("Couldn't register /dev/console driver\n");
3912 device_create(tty_class, NULL, MKDEV(TTYAUX_MAJOR, 1), "console");
3914 #ifdef CONFIG_UNIX98_PTYS
3915 cdev_init(&ptmx_cdev, &ptmx_fops);
3916 if (cdev_add(&ptmx_cdev, MKDEV(TTYAUX_MAJOR, 2), 1) ||
3917 register_chrdev_region(MKDEV(TTYAUX_MAJOR, 2), 1, "/dev/ptmx") < 0)
3918 panic("Couldn't register /dev/ptmx driver\n");
3919 device_create(tty_class, NULL, MKDEV(TTYAUX_MAJOR, 2), "ptmx");
3923 cdev_init(&vc0_cdev, &console_fops);
3924 if (cdev_add(&vc0_cdev, MKDEV(TTY_MAJOR, 0), 1) ||
3925 register_chrdev_region(MKDEV(TTY_MAJOR, 0), 1, "/dev/vc/0") < 0)
3926 panic("Couldn't register /dev/tty0 driver\n");
3927 device_create(tty_class, NULL, MKDEV(TTY_MAJOR, 0), "tty0");
3934 module_init(tty_init);