1 #include <linux/types.h>
2 #include <linux/errno.h>
3 #include <linux/kmod.h>
4 #include <linux/sched.h>
5 #include <linux/interrupt.h>
7 #include <linux/tty_driver.h>
8 #include <linux/file.h>
10 #include <linux/string.h>
11 #include <linux/slab.h>
12 #include <linux/poll.h>
13 #include <linux/proc_fs.h>
14 #include <linux/module.h>
15 #include <linux/device.h>
16 #include <linux/wait.h>
17 #include <linux/bitops.h>
18 #include <linux/seq_file.h>
19 #include <linux/uaccess.h>
20 #include <linux/ratelimit.h>
22 #undef LDISC_DEBUG_HANGUP
24 #ifdef LDISC_DEBUG_HANGUP
25 #define tty_ldisc_debug(tty, f, args...) tty_debug(tty, f, ##args)
27 #define tty_ldisc_debug(tty, f, args...)
30 /* lockdep nested classes for tty->ldisc_sem */
38 * This guards the refcounted line discipline lists. The lock
39 * must be taken with irqs off because there are hangup path
40 * callers who will do ldisc lookups and cannot sleep.
43 static DEFINE_RAW_SPINLOCK(tty_ldiscs_lock);
44 /* Line disc dispatch table */
45 static struct tty_ldisc_ops *tty_ldiscs[NR_LDISCS];
48 * tty_register_ldisc - install a line discipline
50 * @new_ldisc: pointer to the ldisc object
52 * Installs a new line discipline into the kernel. The discipline
53 * is set up as unreferenced and then made available to the kernel
54 * from this point onwards.
57 * takes tty_ldiscs_lock to guard against ldisc races
60 int tty_register_ldisc(int disc, struct tty_ldisc_ops *new_ldisc)
65 if (disc < N_TTY || disc >= NR_LDISCS)
68 raw_spin_lock_irqsave(&tty_ldiscs_lock, flags);
69 tty_ldiscs[disc] = new_ldisc;
70 new_ldisc->num = disc;
71 new_ldisc->refcount = 0;
72 raw_spin_unlock_irqrestore(&tty_ldiscs_lock, flags);
76 EXPORT_SYMBOL(tty_register_ldisc);
79 * tty_unregister_ldisc - unload a line discipline
81 * @new_ldisc: pointer to the ldisc object
83 * Remove a line discipline from the kernel providing it is not
87 * takes tty_ldiscs_lock to guard against ldisc races
90 int tty_unregister_ldisc(int disc)
95 if (disc < N_TTY || disc >= NR_LDISCS)
98 raw_spin_lock_irqsave(&tty_ldiscs_lock, flags);
99 if (tty_ldiscs[disc]->refcount)
102 tty_ldiscs[disc] = NULL;
103 raw_spin_unlock_irqrestore(&tty_ldiscs_lock, flags);
107 EXPORT_SYMBOL(tty_unregister_ldisc);
109 static struct tty_ldisc_ops *get_ldops(int disc)
112 struct tty_ldisc_ops *ldops, *ret;
114 raw_spin_lock_irqsave(&tty_ldiscs_lock, flags);
115 ret = ERR_PTR(-EINVAL);
116 ldops = tty_ldiscs[disc];
118 ret = ERR_PTR(-EAGAIN);
119 if (try_module_get(ldops->owner)) {
124 raw_spin_unlock_irqrestore(&tty_ldiscs_lock, flags);
128 static void put_ldops(struct tty_ldisc_ops *ldops)
132 raw_spin_lock_irqsave(&tty_ldiscs_lock, flags);
134 module_put(ldops->owner);
135 raw_spin_unlock_irqrestore(&tty_ldiscs_lock, flags);
139 * tty_ldisc_get - take a reference to an ldisc
140 * @disc: ldisc number
142 * Takes a reference to a line discipline. Deals with refcounts and
143 * module locking counts.
145 * Returns: -EINVAL if the discipline index is not [N_TTY..NR_LDISCS] or
146 * if the discipline is not registered
147 * -EAGAIN if request_module() failed to load or register the
149 * -ENOMEM if allocation failure
151 * Otherwise, returns a pointer to the discipline and bumps the
155 * takes tty_ldiscs_lock to guard against ldisc races
158 #if defined(CONFIG_LDISC_AUTOLOAD)
159 #define INITIAL_AUTOLOAD_STATE 1
161 #define INITIAL_AUTOLOAD_STATE 0
163 static int tty_ldisc_autoload = INITIAL_AUTOLOAD_STATE;
165 static struct tty_ldisc *tty_ldisc_get(struct tty_struct *tty, int disc)
167 struct tty_ldisc *ld;
168 struct tty_ldisc_ops *ldops;
170 if (disc < N_TTY || disc >= NR_LDISCS)
171 return ERR_PTR(-EINVAL);
174 * Get the ldisc ops - we may need to request them to be loaded
175 * dynamically and try again.
177 ldops = get_ldops(disc);
179 if (!capable(CAP_SYS_MODULE) && !tty_ldisc_autoload)
180 return ERR_PTR(-EPERM);
181 request_module("tty-ldisc-%d", disc);
182 ldops = get_ldops(disc);
184 return ERR_CAST(ldops);
188 * There is no way to handle allocation failure of only 16 bytes.
189 * Let's simplify error handling and save more memory.
191 ld = kmalloc(sizeof(struct tty_ldisc), GFP_KERNEL | __GFP_NOFAIL);
199 * tty_ldisc_put - release the ldisc
201 * Complement of tty_ldisc_get().
203 static void tty_ldisc_put(struct tty_ldisc *ld)
205 if (WARN_ON_ONCE(!ld))
212 static void *tty_ldiscs_seq_start(struct seq_file *m, loff_t *pos)
214 return (*pos < NR_LDISCS) ? pos : NULL;
217 static void *tty_ldiscs_seq_next(struct seq_file *m, void *v, loff_t *pos)
220 return (*pos < NR_LDISCS) ? pos : NULL;
223 static void tty_ldiscs_seq_stop(struct seq_file *m, void *v)
227 static int tty_ldiscs_seq_show(struct seq_file *m, void *v)
229 int i = *(loff_t *)v;
230 struct tty_ldisc_ops *ldops;
232 ldops = get_ldops(i);
235 seq_printf(m, "%-10s %2d\n", ldops->name ? ldops->name : "???", i);
240 static const struct seq_operations tty_ldiscs_seq_ops = {
241 .start = tty_ldiscs_seq_start,
242 .next = tty_ldiscs_seq_next,
243 .stop = tty_ldiscs_seq_stop,
244 .show = tty_ldiscs_seq_show,
247 static int proc_tty_ldiscs_open(struct inode *inode, struct file *file)
249 return seq_open(file, &tty_ldiscs_seq_ops);
252 const struct file_operations tty_ldiscs_proc_fops = {
253 .owner = THIS_MODULE,
254 .open = proc_tty_ldiscs_open,
257 .release = seq_release,
261 * tty_ldisc_ref_wait - wait for the tty ldisc
264 * Dereference the line discipline for the terminal and take a
265 * reference to it. If the line discipline is in flux then
266 * wait patiently until it changes.
268 * Returns: NULL if the tty has been hungup and not re-opened with
269 * a new file descriptor, otherwise valid ldisc reference
271 * Note: Must not be called from an IRQ/timer context. The caller
272 * must also be careful not to hold other locks that will deadlock
273 * against a discipline change, such as an existing ldisc reference
274 * (which we check for)
276 * Note: a file_operations routine (read/poll/write) should use this
277 * function to wait for any ldisc lifetime events to finish.
280 struct tty_ldisc *tty_ldisc_ref_wait(struct tty_struct *tty)
282 struct tty_ldisc *ld;
284 ldsem_down_read(&tty->ldisc_sem, MAX_SCHEDULE_TIMEOUT);
287 ldsem_up_read(&tty->ldisc_sem);
290 EXPORT_SYMBOL_GPL(tty_ldisc_ref_wait);
293 * tty_ldisc_ref - get the tty ldisc
296 * Dereference the line discipline for the terminal and take a
297 * reference to it. If the line discipline is in flux then
298 * return NULL. Can be called from IRQ and timer functions.
301 struct tty_ldisc *tty_ldisc_ref(struct tty_struct *tty)
303 struct tty_ldisc *ld = NULL;
305 if (ldsem_down_read_trylock(&tty->ldisc_sem)) {
308 ldsem_up_read(&tty->ldisc_sem);
312 EXPORT_SYMBOL_GPL(tty_ldisc_ref);
315 * tty_ldisc_deref - free a tty ldisc reference
316 * @ld: reference to free up
318 * Undoes the effect of tty_ldisc_ref or tty_ldisc_ref_wait. May
319 * be called in IRQ context.
322 void tty_ldisc_deref(struct tty_ldisc *ld)
324 ldsem_up_read(&ld->tty->ldisc_sem);
326 EXPORT_SYMBOL_GPL(tty_ldisc_deref);
330 __tty_ldisc_lock(struct tty_struct *tty, unsigned long timeout)
332 return ldsem_down_write(&tty->ldisc_sem, timeout);
336 __tty_ldisc_lock_nested(struct tty_struct *tty, unsigned long timeout)
338 return ldsem_down_write_nested(&tty->ldisc_sem,
339 LDISC_SEM_OTHER, timeout);
342 static inline void __tty_ldisc_unlock(struct tty_struct *tty)
344 ldsem_up_write(&tty->ldisc_sem);
347 int tty_ldisc_lock(struct tty_struct *tty, unsigned long timeout)
351 /* Kindly asking blocked readers to release the read side */
352 set_bit(TTY_LDISC_CHANGING, &tty->flags);
353 wake_up_interruptible_all(&tty->read_wait);
354 wake_up_interruptible_all(&tty->write_wait);
356 ret = __tty_ldisc_lock(tty, timeout);
359 set_bit(TTY_LDISC_HALTED, &tty->flags);
363 void tty_ldisc_unlock(struct tty_struct *tty)
365 clear_bit(TTY_LDISC_HALTED, &tty->flags);
366 /* Can be cleared here - ldisc_unlock will wake up writers firstly */
367 clear_bit(TTY_LDISC_CHANGING, &tty->flags);
368 __tty_ldisc_unlock(tty);
372 tty_ldisc_lock_pair_timeout(struct tty_struct *tty, struct tty_struct *tty2,
373 unsigned long timeout)
378 ret = __tty_ldisc_lock(tty, timeout);
380 ret = __tty_ldisc_lock_nested(tty2, timeout);
382 __tty_ldisc_unlock(tty);
385 /* if this is possible, it has lots of implications */
386 WARN_ON_ONCE(tty == tty2);
387 if (tty2 && tty != tty2) {
388 ret = __tty_ldisc_lock(tty2, timeout);
390 ret = __tty_ldisc_lock_nested(tty, timeout);
392 __tty_ldisc_unlock(tty2);
395 ret = __tty_ldisc_lock(tty, timeout);
401 set_bit(TTY_LDISC_HALTED, &tty->flags);
403 set_bit(TTY_LDISC_HALTED, &tty2->flags);
407 static void tty_ldisc_lock_pair(struct tty_struct *tty, struct tty_struct *tty2)
409 tty_ldisc_lock_pair_timeout(tty, tty2, MAX_SCHEDULE_TIMEOUT);
412 static void tty_ldisc_unlock_pair(struct tty_struct *tty,
413 struct tty_struct *tty2)
415 __tty_ldisc_unlock(tty);
417 __tty_ldisc_unlock(tty2);
421 * tty_ldisc_flush - flush line discipline queue
424 * Flush the line discipline queue (if any) and the tty flip buffers
428 void tty_ldisc_flush(struct tty_struct *tty)
430 struct tty_ldisc *ld = tty_ldisc_ref(tty);
432 tty_buffer_flush(tty, ld);
436 EXPORT_SYMBOL_GPL(tty_ldisc_flush);
439 * tty_set_termios_ldisc - set ldisc field
440 * @tty: tty structure
441 * @disc: line discipline number
443 * This is probably overkill for real world processors but
444 * they are not on hot paths so a little discipline won't do
447 * The line discipline-related tty_struct fields are reset to
448 * prevent the ldisc driver from re-using stale information for
449 * the new ldisc instance.
451 * Locking: takes termios_rwsem
454 static void tty_set_termios_ldisc(struct tty_struct *tty, int disc)
456 down_write(&tty->termios_rwsem);
457 tty->termios.c_line = disc;
458 up_write(&tty->termios_rwsem);
460 tty->disc_data = NULL;
461 tty->receive_room = 0;
465 * tty_ldisc_open - open a line discipline
466 * @tty: tty we are opening the ldisc on
467 * @ld: discipline to open
469 * A helper opening method. Also a convenient debugging and check
472 * Locking: always called with BTM already held.
475 static int tty_ldisc_open(struct tty_struct *tty, struct tty_ldisc *ld)
477 WARN_ON(test_and_set_bit(TTY_LDISC_OPEN, &tty->flags));
480 /* BTM here locks versus a hangup event */
481 ret = ld->ops->open(tty);
483 clear_bit(TTY_LDISC_OPEN, &tty->flags);
485 tty_ldisc_debug(tty, "%p: opened\n", ld);
492 * tty_ldisc_close - close a line discipline
493 * @tty: tty we are opening the ldisc on
494 * @ld: discipline to close
496 * A helper close method. Also a convenient debugging and check
500 static void tty_ldisc_close(struct tty_struct *tty, struct tty_ldisc *ld)
502 WARN_ON(!test_bit(TTY_LDISC_OPEN, &tty->flags));
503 clear_bit(TTY_LDISC_OPEN, &tty->flags);
506 tty_ldisc_debug(tty, "%p: closed\n", ld);
510 * tty_set_ldisc - set line discipline
511 * @tty: the terminal to set
512 * @ldisc: the line discipline
514 * Set the discipline of a tty line. Must be called from a process
515 * context. The ldisc change logic has to protect itself against any
516 * overlapping ldisc change (including on the other end of pty pairs),
517 * the close of one side of a tty/pty pair, and eventually hangup.
520 int tty_set_ldisc(struct tty_struct *tty, int disc)
522 int retval, old_disc;
525 retval = tty_ldisc_lock(tty, 5 * HZ);
534 /* Check the no-op case */
535 old_disc = tty->ldisc->ops->num;
536 if (old_disc == disc)
539 if (test_bit(TTY_HUPPED, &tty->flags)) {
540 /* We were raced by hangup */
545 retval = tty_ldisc_reinit(tty, disc);
547 /* Back to the old one or N_TTY if we can't */
548 if (tty_ldisc_reinit(tty, old_disc) < 0) {
549 pr_err("tty: TIOCSETD failed, reinitializing N_TTY\n");
550 if (tty_ldisc_reinit(tty, N_TTY) < 0) {
551 /* At this point we have tty->ldisc == NULL. */
552 pr_err("tty: reinitializing N_TTY failed\n");
557 if (tty->ldisc && tty->ldisc->ops->num != old_disc &&
558 tty->ops->set_ldisc) {
559 down_read(&tty->termios_rwsem);
560 tty->ops->set_ldisc(tty);
561 up_read(&tty->termios_rwsem);
565 tty_ldisc_unlock(tty);
567 /* Restart the work queue in case no characters kick it off. Safe if
569 tty_buffer_restart_work(tty->port);
576 * tty_ldisc_kill - teardown ldisc
577 * @tty: tty being released
579 * Perform final close of the ldisc and reset tty->ldisc
581 static void tty_ldisc_kill(struct tty_struct *tty)
586 * Now kill off the ldisc
588 tty_ldisc_close(tty, tty->ldisc);
589 tty_ldisc_put(tty->ldisc);
590 /* Force an oops if we mess this up */
595 * tty_reset_termios - reset terminal state
598 * Restore a terminal to the driver default state.
601 static void tty_reset_termios(struct tty_struct *tty)
603 down_write(&tty->termios_rwsem);
604 tty->termios = tty->driver->init_termios;
605 tty->termios.c_ispeed = tty_termios_input_baud_rate(&tty->termios);
606 tty->termios.c_ospeed = tty_termios_baud_rate(&tty->termios);
607 up_write(&tty->termios_rwsem);
612 * tty_ldisc_reinit - reinitialise the tty ldisc
613 * @tty: tty to reinit
614 * @disc: line discipline to reinitialize
616 * Completely reinitialize the line discipline state, by closing the
617 * current instance, if there is one, and opening a new instance. If
618 * an error occurs opening the new non-N_TTY instance, the instance
619 * is dropped and tty->ldisc reset to NULL. The caller can then retry
620 * with N_TTY instead.
622 * Returns 0 if successful, otherwise error code < 0
625 int tty_ldisc_reinit(struct tty_struct *tty, int disc)
627 struct tty_ldisc *ld;
630 ld = tty_ldisc_get(tty, disc);
635 tty_ldisc_close(tty, tty->ldisc);
636 tty_ldisc_put(tty->ldisc);
639 /* switch the line discipline */
641 tty_set_termios_ldisc(tty, disc);
642 retval = tty_ldisc_open(tty, tty->ldisc);
644 tty_ldisc_put(tty->ldisc);
651 * tty_ldisc_hangup - hangup ldisc reset
652 * @tty: tty being hung up
654 * Some tty devices reset their termios when they receive a hangup
655 * event. In that situation we must also switch back to N_TTY properly
656 * before we reset the termios data.
658 * Locking: We can take the ldisc mutex as the rest of the code is
659 * careful to allow for this.
661 * In the pty pair case this occurs in the close() path of the
662 * tty itself so we must be careful about locking rules.
665 void tty_ldisc_hangup(struct tty_struct *tty, bool reinit)
667 struct tty_ldisc *ld;
669 tty_ldisc_debug(tty, "%p: hangup\n", tty->ldisc);
671 ld = tty_ldisc_ref(tty);
673 if (ld->ops->flush_buffer)
674 ld->ops->flush_buffer(tty);
675 tty_driver_flush_buffer(tty);
676 if ((test_bit(TTY_DO_WRITE_WAKEUP, &tty->flags)) &&
677 ld->ops->write_wakeup)
678 ld->ops->write_wakeup(tty);
680 ld->ops->hangup(tty);
684 wake_up_interruptible_poll(&tty->write_wait, POLLOUT);
685 wake_up_interruptible_poll(&tty->read_wait, POLLIN);
688 * Shutdown the current line discipline, and reset it to
691 * Avoid racing set_ldisc or tty_ldisc_release
693 tty_ldisc_lock(tty, MAX_SCHEDULE_TIMEOUT);
695 if (tty->driver->flags & TTY_DRIVER_RESET_TERMIOS)
696 tty_reset_termios(tty);
700 if (tty_ldisc_reinit(tty, tty->termios.c_line) < 0)
701 tty_ldisc_reinit(tty, N_TTY);
705 tty_ldisc_unlock(tty);
709 * tty_ldisc_setup - open line discipline
710 * @tty: tty being shut down
711 * @o_tty: pair tty for pty/tty pairs
713 * Called during the initial open of a tty/pty pair in order to set up the
714 * line disciplines and bind them to the tty. This has no locking issues
715 * as the device isn't yet active.
718 int tty_ldisc_setup(struct tty_struct *tty, struct tty_struct *o_tty)
720 int retval = tty_ldisc_open(tty, tty->ldisc);
725 retval = tty_ldisc_open(o_tty, o_tty->ldisc);
727 tty_ldisc_close(tty, tty->ldisc);
735 * tty_ldisc_release - release line discipline
736 * @tty: tty being shut down (or one end of pty pair)
738 * Called during the final close of a tty or a pty pair in order to shut
739 * down the line discpline layer. On exit, each tty's ldisc is NULL.
742 void tty_ldisc_release(struct tty_struct *tty)
744 struct tty_struct *o_tty = tty->link;
747 * Shutdown this line discipline. As this is the final close,
748 * it does not race with the set_ldisc code path.
751 tty_ldisc_lock_pair(tty, o_tty);
754 tty_ldisc_kill(o_tty);
755 tty_ldisc_unlock_pair(tty, o_tty);
757 /* And the memory resources remaining (buffers, termios) will be
758 disposed of when the kref hits zero */
760 tty_ldisc_debug(tty, "released\n");
764 * tty_ldisc_init - ldisc setup for new tty
765 * @tty: tty being allocated
767 * Set up the line discipline objects for a newly allocated tty. Note that
768 * the tty structure is not completely set up when this call is made.
771 int tty_ldisc_init(struct tty_struct *tty)
773 struct tty_ldisc *ld = tty_ldisc_get(tty, N_TTY);
781 * tty_ldisc_deinit - ldisc cleanup for new tty
782 * @tty: tty that was allocated recently
784 * The tty structure must not becompletely set up (tty_ldisc_setup) when
787 void tty_ldisc_deinit(struct tty_struct *tty)
790 tty_ldisc_put(tty->ldisc);
796 static struct ctl_table tty_table[] = {
798 .procname = "ldisc_autoload",
799 .data = &tty_ldisc_autoload,
800 .maxlen = sizeof(tty_ldisc_autoload),
802 .proc_handler = proc_dointvec,
809 static struct ctl_table tty_dir_table[] = {
818 static struct ctl_table tty_root_table[] = {
822 .child = tty_dir_table,
827 void tty_sysctl_init(void)
829 register_sysctl_table(tty_root_table);