1 #include <linux/types.h>
2 #include <linux/major.h>
3 #include <linux/errno.h>
4 #include <linux/signal.h>
5 #include <linux/fcntl.h>
6 #include <linux/sched.h>
7 #include <linux/interrupt.h>
9 #include <linux/tty_driver.h>
10 #include <linux/tty_flip.h>
11 #include <linux/devpts_fs.h>
12 #include <linux/file.h>
13 #include <linux/fdtable.h>
14 #include <linux/console.h>
15 #include <linux/timer.h>
16 #include <linux/ctype.h>
19 #include <linux/string.h>
20 #include <linux/slab.h>
21 #include <linux/poll.h>
22 #include <linux/proc_fs.h>
23 #include <linux/init.h>
24 #include <linux/module.h>
25 #include <linux/smp_lock.h>
26 #include <linux/device.h>
27 #include <linux/wait.h>
28 #include <linux/bitops.h>
29 #include <linux/delay.h>
30 #include <linux/seq_file.h>
32 #include <linux/uaccess.h>
33 #include <asm/system.h>
35 #include <linux/kbd_kern.h>
36 #include <linux/vt_kern.h>
37 #include <linux/selection.h>
39 #include <linux/kmod.h>
40 #include <linux/nsproxy.h>
43 * This guards the refcounted line discipline lists. The lock
44 * must be taken with irqs off because there are hangup path
45 * callers who will do ldisc lookups and cannot sleep.
48 static DEFINE_SPINLOCK(tty_ldisc_lock);
49 static DECLARE_WAIT_QUEUE_HEAD(tty_ldisc_wait);
50 /* Line disc dispatch table */
51 static struct tty_ldisc_ops *tty_ldiscs[NR_LDISCS];
54 * tty_register_ldisc - install a line discipline
56 * @new_ldisc: pointer to the ldisc object
58 * Installs a new line discipline into the kernel. The discipline
59 * is set up as unreferenced and then made available to the kernel
60 * from this point onwards.
63 * takes tty_ldisc_lock to guard against ldisc races
66 int tty_register_ldisc(int disc, struct tty_ldisc_ops *new_ldisc)
71 if (disc < N_TTY || disc >= NR_LDISCS)
74 spin_lock_irqsave(&tty_ldisc_lock, flags);
75 tty_ldiscs[disc] = new_ldisc;
76 new_ldisc->num = disc;
77 new_ldisc->refcount = 0;
78 spin_unlock_irqrestore(&tty_ldisc_lock, flags);
82 EXPORT_SYMBOL(tty_register_ldisc);
85 * tty_unregister_ldisc - unload a line discipline
87 * @new_ldisc: pointer to the ldisc object
89 * Remove a line discipline from the kernel providing it is not
93 * takes tty_ldisc_lock to guard against ldisc races
96 int tty_unregister_ldisc(int disc)
101 if (disc < N_TTY || disc >= NR_LDISCS)
104 spin_lock_irqsave(&tty_ldisc_lock, flags);
105 if (tty_ldiscs[disc]->refcount)
108 tty_ldiscs[disc] = NULL;
109 spin_unlock_irqrestore(&tty_ldisc_lock, flags);
113 EXPORT_SYMBOL(tty_unregister_ldisc);
117 * tty_ldisc_try_get - try and reference an ldisc
118 * @disc: ldisc number
119 * @ld: tty ldisc structure to complete
121 * Attempt to open and lock a line discipline into place. Return
122 * the line discipline refcounted and assigned in ld. On an error
123 * report the error code back
126 static int tty_ldisc_try_get(int disc, struct tty_ldisc *ld)
129 struct tty_ldisc_ops *ldops;
132 spin_lock_irqsave(&tty_ldisc_lock, flags);
134 ldops = tty_ldiscs[disc];
135 /* Check the entry is defined */
137 /* If the module is being unloaded we can't use it */
138 if (!try_module_get(ldops->owner))
147 spin_unlock_irqrestore(&tty_ldisc_lock, flags);
152 * tty_ldisc_get - take a reference to an ldisc
153 * @disc: ldisc number
154 * @ld: tty line discipline structure to use
156 * Takes a reference to a line discipline. Deals with refcounts and
157 * module locking counts. Returns NULL if the discipline is not available.
158 * Returns a pointer to the discipline and bumps the ref count if it is
162 * takes tty_ldisc_lock to guard against ldisc races
165 static int tty_ldisc_get(int disc, struct tty_ldisc *ld)
169 if (disc < N_TTY || disc >= NR_LDISCS)
171 err = tty_ldisc_try_get(disc, ld);
173 request_module("tty-ldisc-%d", disc);
174 err = tty_ldisc_try_get(disc, ld);
180 * tty_ldisc_put - drop ldisc reference
181 * @disc: ldisc number
183 * Drop a reference to a line discipline. Manage refcounts and
184 * module usage counts
187 * takes tty_ldisc_lock to guard against ldisc races
190 static void tty_ldisc_put(struct tty_ldisc_ops *ld)
195 BUG_ON(disc < N_TTY || disc >= NR_LDISCS);
197 spin_lock_irqsave(&tty_ldisc_lock, flags);
198 ld = tty_ldiscs[disc];
199 BUG_ON(ld->refcount == 0);
201 module_put(ld->owner);
202 spin_unlock_irqrestore(&tty_ldisc_lock, flags);
205 static void * tty_ldiscs_seq_start(struct seq_file *m, loff_t *pos)
207 return (*pos < NR_LDISCS) ? pos : NULL;
210 static void * tty_ldiscs_seq_next(struct seq_file *m, void *v, loff_t *pos)
213 return (*pos < NR_LDISCS) ? pos : NULL;
216 static void tty_ldiscs_seq_stop(struct seq_file *m, void *v)
220 static int tty_ldiscs_seq_show(struct seq_file *m, void *v)
222 int i = *(loff_t *)v;
225 if (tty_ldisc_get(i, &ld) < 0)
227 seq_printf(m, "%-10s %2d\n", ld.ops->name ? ld.ops->name : "???", i);
228 tty_ldisc_put(ld.ops);
232 static const struct seq_operations tty_ldiscs_seq_ops = {
233 .start = tty_ldiscs_seq_start,
234 .next = tty_ldiscs_seq_next,
235 .stop = tty_ldiscs_seq_stop,
236 .show = tty_ldiscs_seq_show,
239 static int proc_tty_ldiscs_open(struct inode *inode, struct file *file)
241 return seq_open(file, &tty_ldiscs_seq_ops);
244 const struct file_operations tty_ldiscs_proc_fops = {
245 .owner = THIS_MODULE,
246 .open = proc_tty_ldiscs_open,
249 .release = seq_release,
253 * tty_ldisc_assign - set ldisc on a tty
254 * @tty: tty to assign
255 * @ld: line discipline
257 * Install an instance of a line discipline into a tty structure. The
258 * ldisc must have a reference count above zero to ensure it remains/
259 * The tty instance refcount starts at zero.
262 * Caller must hold references
265 static void tty_ldisc_assign(struct tty_struct *tty, struct tty_ldisc *ld)
272 * tty_ldisc_try - internal helper
275 * Make a single attempt to grab and bump the refcount on
276 * the tty ldisc. Return 0 on failure or 1 on success. This is
277 * used to implement both the waiting and non waiting versions
280 * Locking: takes tty_ldisc_lock
283 static int tty_ldisc_try(struct tty_struct *tty)
286 struct tty_ldisc *ld;
289 spin_lock_irqsave(&tty_ldisc_lock, flags);
291 if (test_bit(TTY_LDISC, &tty->flags)) {
295 spin_unlock_irqrestore(&tty_ldisc_lock, flags);
300 * tty_ldisc_ref_wait - wait for the tty ldisc
303 * Dereference the line discipline for the terminal and take a
304 * reference to it. If the line discipline is in flux then
305 * wait patiently until it changes.
307 * Note: Must not be called from an IRQ/timer context. The caller
308 * must also be careful not to hold other locks that will deadlock
309 * against a discipline change, such as an existing ldisc reference
310 * (which we check for)
312 * Locking: call functions take tty_ldisc_lock
315 struct tty_ldisc *tty_ldisc_ref_wait(struct tty_struct *tty)
317 /* wait_event is a macro */
318 wait_event(tty_ldisc_wait, tty_ldisc_try(tty));
319 WARN_ON(tty->ldisc.refcount == 0);
323 EXPORT_SYMBOL_GPL(tty_ldisc_ref_wait);
326 * tty_ldisc_ref - get the tty ldisc
329 * Dereference the line discipline for the terminal and take a
330 * reference to it. If the line discipline is in flux then
331 * return NULL. Can be called from IRQ and timer functions.
333 * Locking: called functions take tty_ldisc_lock
336 struct tty_ldisc *tty_ldisc_ref(struct tty_struct *tty)
338 if (tty_ldisc_try(tty))
343 EXPORT_SYMBOL_GPL(tty_ldisc_ref);
346 * tty_ldisc_deref - free a tty ldisc reference
347 * @ld: reference to free up
349 * Undoes the effect of tty_ldisc_ref or tty_ldisc_ref_wait. May
350 * be called in IRQ context.
352 * Locking: takes tty_ldisc_lock
355 void tty_ldisc_deref(struct tty_ldisc *ld)
361 spin_lock_irqsave(&tty_ldisc_lock, flags);
362 if (ld->refcount == 0)
363 printk(KERN_ERR "tty_ldisc_deref: no references.\n");
366 if (ld->refcount == 0)
367 wake_up(&tty_ldisc_wait);
368 spin_unlock_irqrestore(&tty_ldisc_lock, flags);
371 EXPORT_SYMBOL_GPL(tty_ldisc_deref);
374 * tty_ldisc_enable - allow ldisc use
375 * @tty: terminal to activate ldisc on
377 * Set the TTY_LDISC flag when the line discipline can be called
378 * again. Do necessary wakeups for existing sleepers. Clear the LDISC
379 * changing flag to indicate any ldisc change is now over.
381 * Note: nobody should set the TTY_LDISC bit except via this function.
382 * Clearing directly is allowed.
385 void tty_ldisc_enable(struct tty_struct *tty)
387 set_bit(TTY_LDISC, &tty->flags);
388 clear_bit(TTY_LDISC_CHANGING, &tty->flags);
389 wake_up(&tty_ldisc_wait);
393 * tty_set_termios_ldisc - set ldisc field
394 * @tty: tty structure
395 * @num: line discipline number
397 * This is probably overkill for real world processors but
398 * they are not on hot paths so a little discipline won't do
401 * Locking: takes termios_mutex
404 static void tty_set_termios_ldisc(struct tty_struct *tty, int num)
406 mutex_lock(&tty->termios_mutex);
407 tty->termios->c_line = num;
408 mutex_unlock(&tty->termios_mutex);
413 * tty_ldisc_restore - helper for tty ldisc change
414 * @tty: tty to recover
415 * @old: previous ldisc
417 * Restore the previous line discipline or N_TTY when a line discipline
418 * change fails due to an open error
421 static void tty_ldisc_restore(struct tty_struct *tty, struct tty_ldisc *old)
424 struct tty_ldisc new_ldisc;
426 /* There is an outstanding reference here so this is safe */
427 tty_ldisc_get(old->ops->num, old);
428 tty_ldisc_assign(tty, old);
429 tty_set_termios_ldisc(tty, old->ops->num);
430 if (old->ops->open && (old->ops->open(tty) < 0)) {
431 tty_ldisc_put(old->ops);
432 /* This driver is always present */
433 if (tty_ldisc_get(N_TTY, &new_ldisc) < 0)
435 tty_ldisc_assign(tty, &new_ldisc);
436 tty_set_termios_ldisc(tty, N_TTY);
437 if (new_ldisc.ops->open) {
438 int r = new_ldisc.ops->open(tty);
440 panic("Couldn't open N_TTY ldisc for "
442 tty_name(tty, buf), r);
448 * tty_set_ldisc - set line discipline
449 * @tty: the terminal to set
450 * @ldisc: the line discipline
452 * Set the discipline of a tty line. Must be called from a process
455 * Locking: takes tty_ldisc_lock.
456 * called functions take termios_mutex
459 int tty_set_ldisc(struct tty_struct *tty, int ldisc)
462 struct tty_ldisc o_ldisc, new_ldisc;
465 struct tty_struct *o_tty;
468 /* This is a bit ugly for now but means we can break the 'ldisc
469 is part of the tty struct' assumption later */
470 retval = tty_ldisc_get(ldisc, &new_ldisc);
475 * Problem: What do we do if this blocks ?
478 tty_wait_until_sent(tty, 0);
480 if (tty->ldisc.ops->num == ldisc) {
481 tty_ldisc_put(new_ldisc.ops);
486 * No more input please, we are switching. The new ldisc
487 * will update this value in the ldisc open function
490 tty->receive_room = 0;
492 o_ldisc = tty->ldisc;
496 * Make sure we don't change while someone holds a
497 * reference to the line discipline. The TTY_LDISC bit
498 * prevents anyone taking a reference once it is clear.
499 * We need the lock to avoid racing reference takers.
501 * We must clear the TTY_LDISC bit here to avoid a livelock
502 * with a userspace app continually trying to use the tty in
503 * parallel to the change and re-referencing the tty.
505 clear_bit(TTY_LDISC, &tty->flags);
507 clear_bit(TTY_LDISC, &o_tty->flags);
509 spin_lock_irqsave(&tty_ldisc_lock, flags);
510 if (tty->ldisc.refcount || (o_tty && o_tty->ldisc.refcount)) {
511 if (tty->ldisc.refcount) {
512 /* Free the new ldisc we grabbed. Must drop the lock
514 spin_unlock_irqrestore(&tty_ldisc_lock, flags);
515 tty_ldisc_put(o_ldisc.ops);
517 * There are several reasons we may be busy, including
518 * random momentary I/O traffic. We must therefore
519 * retry. We could distinguish between blocking ops
520 * and retries if we made tty_ldisc_wait() smarter.
521 * That is up for discussion.
523 if (wait_event_interruptible(tty_ldisc_wait, tty->ldisc.refcount == 0) < 0)
527 if (o_tty && o_tty->ldisc.refcount) {
528 spin_unlock_irqrestore(&tty_ldisc_lock, flags);
529 tty_ldisc_put(o_tty->ldisc.ops);
530 if (wait_event_interruptible(tty_ldisc_wait, o_tty->ldisc.refcount == 0) < 0)
536 * If the TTY_LDISC bit is set, then we are racing against
537 * another ldisc change
539 if (test_bit(TTY_LDISC_CHANGING, &tty->flags)) {
540 struct tty_ldisc *ld;
541 spin_unlock_irqrestore(&tty_ldisc_lock, flags);
542 tty_ldisc_put(new_ldisc.ops);
543 ld = tty_ldisc_ref_wait(tty);
548 * This flag is used to avoid two parallel ldisc changes. Once
549 * open and close are fine grained locked this may work better
550 * as a mutex shared with the open/close/hup paths
552 set_bit(TTY_LDISC_CHANGING, &tty->flags);
554 set_bit(TTY_LDISC_CHANGING, &o_tty->flags);
555 spin_unlock_irqrestore(&tty_ldisc_lock, flags);
558 * From this point on we know nobody has an ldisc
559 * usage reference, nor can they obtain one until
560 * we say so later on.
563 work = cancel_delayed_work(&tty->buf.work);
565 * Wait for ->hangup_work and ->buf.work handlers to terminate
566 * MUST NOT hold locks here.
568 flush_scheduled_work();
569 /* Shutdown the current discipline. */
570 if (o_ldisc.ops->close)
571 (o_ldisc.ops->close)(tty);
573 /* Now set up the new line discipline. */
574 tty_ldisc_assign(tty, &new_ldisc);
575 tty_set_termios_ldisc(tty, ldisc);
576 if (new_ldisc.ops->open)
577 retval = (new_ldisc.ops->open)(tty);
579 tty_ldisc_put(new_ldisc.ops);
580 tty_ldisc_restore(tty, &o_ldisc);
582 /* At this point we hold a reference to the new ldisc and a
583 a reference to the old ldisc. If we ended up flipping back
584 to the existing ldisc we have two references to it */
586 if (tty->ldisc.ops->num != o_ldisc.ops->num && tty->ops->set_ldisc)
587 tty->ops->set_ldisc(tty);
589 tty_ldisc_put(o_ldisc.ops);
592 * Allow ldisc referencing to occur as soon as the driver
593 * ldisc callback completes.
596 tty_ldisc_enable(tty);
598 tty_ldisc_enable(o_tty);
600 /* Restart it in case no characters kick it off. Safe if
603 schedule_delayed_work(&tty->buf.work, 1);
609 * tty_ldisc_setup - open line discipline
610 * @tty: tty being shut down
611 * @o_tty: pair tty for pty/tty pairs
613 * Called during the initial open of a tty/pty pair in order to set up the
614 * line discplines and bind them to the tty.
617 int tty_ldisc_setup(struct tty_struct *tty, struct tty_struct *o_tty)
619 struct tty_ldisc *ld = &tty->ldisc;
623 retval = (ld->ops->open)(tty);
627 if (o_tty && o_tty->ldisc.ops->open) {
628 retval = (o_tty->ldisc.ops->open)(o_tty);
631 (ld->ops->close)(tty);
634 tty_ldisc_enable(o_tty);
636 tty_ldisc_enable(tty);
641 * tty_ldisc_release - release line discipline
642 * @tty: tty being shut down
643 * @o_tty: pair tty for pty/tty pairs
645 * Called during the final close of a tty/pty pair in order to shut down the
646 * line discpline layer.
649 void tty_ldisc_release(struct tty_struct *tty, struct tty_struct *o_tty)
654 * Prevent flush_to_ldisc() from rescheduling the work for later. Then
655 * kill any delayed work. As this is the final close it does not
656 * race with the set_ldisc code path.
658 clear_bit(TTY_LDISC, &tty->flags);
659 cancel_delayed_work(&tty->buf.work);
662 * Wait for ->hangup_work and ->buf.work handlers to terminate
665 flush_scheduled_work();
668 * Wait for any short term users (we know they are just driver
669 * side waiters as the file is closing so user count on the file
672 spin_lock_irqsave(&tty_ldisc_lock, flags);
673 while (tty->ldisc.refcount) {
674 spin_unlock_irqrestore(&tty_ldisc_lock, flags);
675 wait_event(tty_ldisc_wait, tty->ldisc.refcount == 0);
676 spin_lock_irqsave(&tty_ldisc_lock, flags);
678 spin_unlock_irqrestore(&tty_ldisc_lock, flags);
680 * Shutdown the current line discipline, and reset it to N_TTY.
682 * FIXME: this MUST get fixed for the new reflocking
684 if (tty->ldisc.ops->close)
685 (tty->ldisc.ops->close)(tty);
686 tty_ldisc_put(tty->ldisc.ops);
689 * Switch the line discipline back
691 WARN_ON(tty_ldisc_get(N_TTY, &ld));
692 tty_ldisc_assign(tty, &ld);
693 tty_set_termios_ldisc(tty, N_TTY);
695 /* FIXME: could o_tty be in setldisc here ? */
696 clear_bit(TTY_LDISC, &o_tty->flags);
697 if (o_tty->ldisc.ops->close)
698 (o_tty->ldisc.ops->close)(o_tty);
699 tty_ldisc_put(o_tty->ldisc.ops);
700 WARN_ON(tty_ldisc_get(N_TTY, &ld));
701 tty_ldisc_assign(o_tty, &ld);
702 tty_set_termios_ldisc(o_tty, N_TTY);
707 * tty_ldisc_init - ldisc setup for new tty
708 * @tty: tty being allocated
710 * Set up the line discipline objects for a newly allocated tty. Note that
711 * the tty structure is not completely set up when this call is made.
714 void tty_ldisc_init(struct tty_struct *tty)
717 if (tty_ldisc_get(N_TTY, &ld) < 0)
718 panic("n_tty: init_tty");
719 tty_ldisc_assign(tty, &ld);
722 void tty_ldisc_begin(void)
724 /* Setup the default TTY line discipline. */
725 (void) tty_register_ldisc(N_TTY, &tty_ldisc_N_TTY);