1 // SPDX-License-Identifier: GPL-2.0
2 #include <linux/types.h>
3 #include <linux/errno.h>
4 #include <linux/kmod.h>
5 #include <linux/sched.h>
6 #include <linux/interrupt.h>
8 #include <linux/tty_driver.h>
9 #include <linux/file.h>
11 #include <linux/string.h>
12 #include <linux/slab.h>
13 #include <linux/poll.h>
14 #include <linux/proc_fs.h>
15 #include <linux/module.h>
16 #include <linux/device.h>
17 #include <linux/wait.h>
18 #include <linux/bitops.h>
19 #include <linux/seq_file.h>
20 #include <linux/uaccess.h>
21 #include <linux/ratelimit.h>
23 #undef LDISC_DEBUG_HANGUP
25 #ifdef LDISC_DEBUG_HANGUP
26 #define tty_ldisc_debug(tty, f, args...) tty_debug(tty, f, ##args)
28 #define tty_ldisc_debug(tty, f, args...)
31 /* lockdep nested classes for tty->ldisc_sem */
39 * This guards the refcounted line discipline lists. The lock
40 * must be taken with irqs off because there are hangup path
41 * callers who will do ldisc lookups and cannot sleep.
44 static DEFINE_RAW_SPINLOCK(tty_ldiscs_lock
);
45 /* Line disc dispatch table */
46 static struct tty_ldisc_ops
*tty_ldiscs
[NR_LDISCS
];
49 * tty_register_ldisc - install a line discipline
51 * @new_ldisc: pointer to the ldisc object
53 * Installs a new line discipline into the kernel. The discipline
54 * is set up as unreferenced and then made available to the kernel
55 * from this point onwards.
58 * takes tty_ldiscs_lock to guard against ldisc races
61 int tty_register_ldisc(int disc
, struct tty_ldisc_ops
*new_ldisc
)
66 if (disc
< N_TTY
|| disc
>= NR_LDISCS
)
69 raw_spin_lock_irqsave(&tty_ldiscs_lock
, flags
);
70 tty_ldiscs
[disc
] = new_ldisc
;
71 new_ldisc
->num
= disc
;
72 new_ldisc
->refcount
= 0;
73 raw_spin_unlock_irqrestore(&tty_ldiscs_lock
, flags
);
77 EXPORT_SYMBOL(tty_register_ldisc
);
80 * tty_unregister_ldisc - unload a line discipline
82 * @new_ldisc: pointer to the ldisc object
84 * Remove a line discipline from the kernel providing it is not
88 * takes tty_ldiscs_lock to guard against ldisc races
91 int tty_unregister_ldisc(int disc
)
96 if (disc
< N_TTY
|| disc
>= NR_LDISCS
)
99 raw_spin_lock_irqsave(&tty_ldiscs_lock
, flags
);
100 if (tty_ldiscs
[disc
]->refcount
)
103 tty_ldiscs
[disc
] = NULL
;
104 raw_spin_unlock_irqrestore(&tty_ldiscs_lock
, flags
);
108 EXPORT_SYMBOL(tty_unregister_ldisc
);
110 static struct tty_ldisc_ops
*get_ldops(int disc
)
113 struct tty_ldisc_ops
*ldops
, *ret
;
115 raw_spin_lock_irqsave(&tty_ldiscs_lock
, flags
);
116 ret
= ERR_PTR(-EINVAL
);
117 ldops
= tty_ldiscs
[disc
];
119 ret
= ERR_PTR(-EAGAIN
);
120 if (try_module_get(ldops
->owner
)) {
125 raw_spin_unlock_irqrestore(&tty_ldiscs_lock
, flags
);
129 static void put_ldops(struct tty_ldisc_ops
*ldops
)
133 raw_spin_lock_irqsave(&tty_ldiscs_lock
, flags
);
135 module_put(ldops
->owner
);
136 raw_spin_unlock_irqrestore(&tty_ldiscs_lock
, flags
);
140 * tty_ldisc_get - take a reference to an ldisc
141 * @disc: ldisc number
143 * Takes a reference to a line discipline. Deals with refcounts and
144 * module locking counts.
146 * Returns: -EINVAL if the discipline index is not [N_TTY..NR_LDISCS] or
147 * if the discipline is not registered
148 * -EAGAIN if request_module() failed to load or register the
150 * -ENOMEM if allocation failure
152 * Otherwise, returns a pointer to the discipline and bumps the
156 * takes tty_ldiscs_lock to guard against ldisc races
159 #if defined(CONFIG_LDISC_AUTOLOAD)
160 #define INITIAL_AUTOLOAD_STATE 1
162 #define INITIAL_AUTOLOAD_STATE 0
164 static int tty_ldisc_autoload
= INITIAL_AUTOLOAD_STATE
;
166 static struct tty_ldisc
*tty_ldisc_get(struct tty_struct
*tty
, int disc
)
168 struct tty_ldisc
*ld
;
169 struct tty_ldisc_ops
*ldops
;
171 if (disc
< N_TTY
|| disc
>= NR_LDISCS
)
172 return ERR_PTR(-EINVAL
);
175 * Get the ldisc ops - we may need to request them to be loaded
176 * dynamically and try again.
178 ldops
= get_ldops(disc
);
180 if (!capable(CAP_SYS_MODULE
) && !tty_ldisc_autoload
)
181 return ERR_PTR(-EPERM
);
182 request_module("tty-ldisc-%d", disc
);
183 ldops
= get_ldops(disc
);
185 return ERR_CAST(ldops
);
189 * There is no way to handle allocation failure of only 16 bytes.
190 * Let's simplify error handling and save more memory.
192 ld
= kmalloc(sizeof(struct tty_ldisc
), GFP_KERNEL
| __GFP_NOFAIL
);
200 * tty_ldisc_put - release the ldisc
202 * Complement of tty_ldisc_get().
204 static void tty_ldisc_put(struct tty_ldisc
*ld
)
206 if (WARN_ON_ONCE(!ld
))
213 static void *tty_ldiscs_seq_start(struct seq_file
*m
, loff_t
*pos
)
215 return (*pos
< NR_LDISCS
) ? pos
: NULL
;
218 static void *tty_ldiscs_seq_next(struct seq_file
*m
, void *v
, loff_t
*pos
)
221 return (*pos
< NR_LDISCS
) ? pos
: NULL
;
224 static void tty_ldiscs_seq_stop(struct seq_file
*m
, void *v
)
228 static int tty_ldiscs_seq_show(struct seq_file
*m
, void *v
)
230 int i
= *(loff_t
*)v
;
231 struct tty_ldisc_ops
*ldops
;
233 ldops
= get_ldops(i
);
236 seq_printf(m
, "%-10s %2d\n", ldops
->name
? ldops
->name
: "???", i
);
241 const struct seq_operations tty_ldiscs_seq_ops
= {
242 .start
= tty_ldiscs_seq_start
,
243 .next
= tty_ldiscs_seq_next
,
244 .stop
= tty_ldiscs_seq_stop
,
245 .show
= tty_ldiscs_seq_show
,
249 * tty_ldisc_ref_wait - wait for the tty ldisc
252 * Dereference the line discipline for the terminal and take a
253 * reference to it. If the line discipline is in flux then
254 * wait patiently until it changes.
256 * Returns: NULL if the tty has been hungup and not re-opened with
257 * a new file descriptor, otherwise valid ldisc reference
259 * Note: Must not be called from an IRQ/timer context. The caller
260 * must also be careful not to hold other locks that will deadlock
261 * against a discipline change, such as an existing ldisc reference
262 * (which we check for)
264 * Note: a file_operations routine (read/poll/write) should use this
265 * function to wait for any ldisc lifetime events to finish.
268 struct tty_ldisc
*tty_ldisc_ref_wait(struct tty_struct
*tty
)
270 struct tty_ldisc
*ld
;
272 ldsem_down_read(&tty
->ldisc_sem
, MAX_SCHEDULE_TIMEOUT
);
275 ldsem_up_read(&tty
->ldisc_sem
);
278 EXPORT_SYMBOL_GPL(tty_ldisc_ref_wait
);
281 * tty_ldisc_ref - get the tty ldisc
284 * Dereference the line discipline for the terminal and take a
285 * reference to it. If the line discipline is in flux then
286 * return NULL. Can be called from IRQ and timer functions.
289 struct tty_ldisc
*tty_ldisc_ref(struct tty_struct
*tty
)
291 struct tty_ldisc
*ld
= NULL
;
293 if (ldsem_down_read_trylock(&tty
->ldisc_sem
)) {
296 ldsem_up_read(&tty
->ldisc_sem
);
300 EXPORT_SYMBOL_GPL(tty_ldisc_ref
);
303 * tty_ldisc_deref - free a tty ldisc reference
304 * @ld: reference to free up
306 * Undoes the effect of tty_ldisc_ref or tty_ldisc_ref_wait. May
307 * be called in IRQ context.
310 void tty_ldisc_deref(struct tty_ldisc
*ld
)
312 ldsem_up_read(&ld
->tty
->ldisc_sem
);
314 EXPORT_SYMBOL_GPL(tty_ldisc_deref
);
318 __tty_ldisc_lock(struct tty_struct
*tty
, unsigned long timeout
)
320 return ldsem_down_write(&tty
->ldisc_sem
, timeout
);
324 __tty_ldisc_lock_nested(struct tty_struct
*tty
, unsigned long timeout
)
326 return ldsem_down_write_nested(&tty
->ldisc_sem
,
327 LDISC_SEM_OTHER
, timeout
);
330 static inline void __tty_ldisc_unlock(struct tty_struct
*tty
)
332 ldsem_up_write(&tty
->ldisc_sem
);
335 int tty_ldisc_lock(struct tty_struct
*tty
, unsigned long timeout
)
339 /* Kindly asking blocked readers to release the read side */
340 set_bit(TTY_LDISC_CHANGING
, &tty
->flags
);
341 wake_up_interruptible_all(&tty
->read_wait
);
342 wake_up_interruptible_all(&tty
->write_wait
);
344 ret
= __tty_ldisc_lock(tty
, timeout
);
347 set_bit(TTY_LDISC_HALTED
, &tty
->flags
);
351 void tty_ldisc_unlock(struct tty_struct
*tty
)
353 clear_bit(TTY_LDISC_HALTED
, &tty
->flags
);
354 /* Can be cleared here - ldisc_unlock will wake up writers firstly */
355 clear_bit(TTY_LDISC_CHANGING
, &tty
->flags
);
356 __tty_ldisc_unlock(tty
);
360 tty_ldisc_lock_pair_timeout(struct tty_struct
*tty
, struct tty_struct
*tty2
,
361 unsigned long timeout
)
366 ret
= __tty_ldisc_lock(tty
, timeout
);
368 ret
= __tty_ldisc_lock_nested(tty2
, timeout
);
370 __tty_ldisc_unlock(tty
);
373 /* if this is possible, it has lots of implications */
374 WARN_ON_ONCE(tty
== tty2
);
375 if (tty2
&& tty
!= tty2
) {
376 ret
= __tty_ldisc_lock(tty2
, timeout
);
378 ret
= __tty_ldisc_lock_nested(tty
, timeout
);
380 __tty_ldisc_unlock(tty2
);
383 ret
= __tty_ldisc_lock(tty
, timeout
);
389 set_bit(TTY_LDISC_HALTED
, &tty
->flags
);
391 set_bit(TTY_LDISC_HALTED
, &tty2
->flags
);
395 static void tty_ldisc_lock_pair(struct tty_struct
*tty
, struct tty_struct
*tty2
)
397 tty_ldisc_lock_pair_timeout(tty
, tty2
, MAX_SCHEDULE_TIMEOUT
);
400 static void tty_ldisc_unlock_pair(struct tty_struct
*tty
,
401 struct tty_struct
*tty2
)
403 __tty_ldisc_unlock(tty
);
405 __tty_ldisc_unlock(tty2
);
409 * tty_ldisc_flush - flush line discipline queue
412 * Flush the line discipline queue (if any) and the tty flip buffers
416 void tty_ldisc_flush(struct tty_struct
*tty
)
418 struct tty_ldisc
*ld
= tty_ldisc_ref(tty
);
420 tty_buffer_flush(tty
, ld
);
424 EXPORT_SYMBOL_GPL(tty_ldisc_flush
);
427 * tty_set_termios_ldisc - set ldisc field
428 * @tty: tty structure
429 * @disc: line discipline number
431 * This is probably overkill for real world processors but
432 * they are not on hot paths so a little discipline won't do
435 * The line discipline-related tty_struct fields are reset to
436 * prevent the ldisc driver from re-using stale information for
437 * the new ldisc instance.
439 * Locking: takes termios_rwsem
442 static void tty_set_termios_ldisc(struct tty_struct
*tty
, int disc
)
444 down_write(&tty
->termios_rwsem
);
445 tty
->termios
.c_line
= disc
;
446 up_write(&tty
->termios_rwsem
);
448 tty
->disc_data
= NULL
;
449 tty
->receive_room
= 0;
453 * tty_ldisc_open - open a line discipline
454 * @tty: tty we are opening the ldisc on
455 * @ld: discipline to open
457 * A helper opening method. Also a convenient debugging and check
460 * Locking: always called with BTM already held.
463 static int tty_ldisc_open(struct tty_struct
*tty
, struct tty_ldisc
*ld
)
465 WARN_ON(test_and_set_bit(TTY_LDISC_OPEN
, &tty
->flags
));
468 /* BTM here locks versus a hangup event */
469 ret
= ld
->ops
->open(tty
);
471 clear_bit(TTY_LDISC_OPEN
, &tty
->flags
);
473 tty_ldisc_debug(tty
, "%p: opened\n", ld
);
480 * tty_ldisc_close - close a line discipline
481 * @tty: tty we are opening the ldisc on
482 * @ld: discipline to close
484 * A helper close method. Also a convenient debugging and check
488 static void tty_ldisc_close(struct tty_struct
*tty
, struct tty_ldisc
*ld
)
490 WARN_ON(!test_bit(TTY_LDISC_OPEN
, &tty
->flags
));
491 clear_bit(TTY_LDISC_OPEN
, &tty
->flags
);
494 tty_ldisc_debug(tty
, "%p: closed\n", ld
);
498 * tty_ldisc_failto - helper for ldisc failback
499 * @tty: tty to open the ldisc on
500 * @ld: ldisc we are trying to fail back to
502 * Helper to try and recover a tty when switching back to the old
503 * ldisc fails and we need something attached.
506 static int tty_ldisc_failto(struct tty_struct
*tty
, int ld
)
508 struct tty_ldisc
*disc
= tty_ldisc_get(tty
, ld
);
512 return PTR_ERR(disc
);
514 tty_set_termios_ldisc(tty
, ld
);
515 if ((r
= tty_ldisc_open(tty
, disc
)) < 0)
521 * tty_ldisc_restore - helper for tty ldisc change
522 * @tty: tty to recover
523 * @old: previous ldisc
525 * Restore the previous line discipline or N_TTY when a line discipline
526 * change fails due to an open error
529 static void tty_ldisc_restore(struct tty_struct
*tty
, struct tty_ldisc
*old
)
531 /* There is an outstanding reference here so this is safe */
532 if (tty_ldisc_failto(tty
, old
->ops
->num
) < 0) {
533 const char *name
= tty_name(tty
);
535 pr_warn("Falling back ldisc for %s.\n", name
);
536 /* The traditional behaviour is to fall back to N_TTY, we
537 want to avoid falling back to N_NULL unless we have no
538 choice to avoid the risk of breaking anything */
539 if (tty_ldisc_failto(tty
, N_TTY
) < 0 &&
540 tty_ldisc_failto(tty
, N_NULL
) < 0)
541 panic("Couldn't open N_NULL ldisc for %s.", name
);
546 * tty_set_ldisc - set line discipline
547 * @tty: the terminal to set
548 * @ldisc: the line discipline
550 * Set the discipline of a tty line. Must be called from a process
551 * context. The ldisc change logic has to protect itself against any
552 * overlapping ldisc change (including on the other end of pty pairs),
553 * the close of one side of a tty/pty pair, and eventually hangup.
556 int tty_set_ldisc(struct tty_struct
*tty
, int disc
)
559 struct tty_ldisc
*old_ldisc
, *new_ldisc
;
561 new_ldisc
= tty_ldisc_get(tty
, disc
);
562 if (IS_ERR(new_ldisc
))
563 return PTR_ERR(new_ldisc
);
566 retval
= tty_ldisc_lock(tty
, 5 * HZ
);
575 /* Check the no-op case */
576 if (tty
->ldisc
->ops
->num
== disc
)
579 if (test_bit(TTY_HUPPED
, &tty
->flags
)) {
580 /* We were raced by hangup */
585 old_ldisc
= tty
->ldisc
;
587 /* Shutdown the old discipline. */
588 tty_ldisc_close(tty
, old_ldisc
);
590 /* Now set up the new line discipline. */
591 tty
->ldisc
= new_ldisc
;
592 tty_set_termios_ldisc(tty
, disc
);
594 retval
= tty_ldisc_open(tty
, new_ldisc
);
596 /* Back to the old one or N_TTY if we can't */
597 tty_ldisc_put(new_ldisc
);
598 tty_ldisc_restore(tty
, old_ldisc
);
601 if (tty
->ldisc
->ops
->num
!= old_ldisc
->ops
->num
&& tty
->ops
->set_ldisc
) {
602 down_read(&tty
->termios_rwsem
);
603 tty
->ops
->set_ldisc(tty
);
604 up_read(&tty
->termios_rwsem
);
607 /* At this point we hold a reference to the new ldisc and a
608 reference to the old ldisc, or we hold two references to
609 the old ldisc (if it was restored as part of error cleanup
610 above). In either case, releasing a single reference from
611 the old ldisc is correct. */
612 new_ldisc
= old_ldisc
;
614 tty_ldisc_unlock(tty
);
616 /* Restart the work queue in case no characters kick it off. Safe if
618 tty_buffer_restart_work(tty
->port
);
620 tty_ldisc_put(new_ldisc
); /* drop the extra reference */
624 EXPORT_SYMBOL_GPL(tty_set_ldisc
);
627 * tty_ldisc_kill - teardown ldisc
628 * @tty: tty being released
630 * Perform final close of the ldisc and reset tty->ldisc
632 static void tty_ldisc_kill(struct tty_struct
*tty
)
637 * Now kill off the ldisc
639 tty_ldisc_close(tty
, tty
->ldisc
);
640 tty_ldisc_put(tty
->ldisc
);
641 /* Force an oops if we mess this up */
646 * tty_reset_termios - reset terminal state
649 * Restore a terminal to the driver default state.
652 static void tty_reset_termios(struct tty_struct
*tty
)
654 down_write(&tty
->termios_rwsem
);
655 tty
->termios
= tty
->driver
->init_termios
;
656 tty
->termios
.c_ispeed
= tty_termios_input_baud_rate(&tty
->termios
);
657 tty
->termios
.c_ospeed
= tty_termios_baud_rate(&tty
->termios
);
658 up_write(&tty
->termios_rwsem
);
663 * tty_ldisc_reinit - reinitialise the tty ldisc
664 * @tty: tty to reinit
665 * @disc: line discipline to reinitialize
667 * Completely reinitialize the line discipline state, by closing the
668 * current instance, if there is one, and opening a new instance. If
669 * an error occurs opening the new non-N_TTY instance, the instance
670 * is dropped and tty->ldisc reset to NULL. The caller can then retry
671 * with N_TTY instead.
673 * Returns 0 if successful, otherwise error code < 0
676 int tty_ldisc_reinit(struct tty_struct
*tty
, int disc
)
678 struct tty_ldisc
*ld
;
681 ld
= tty_ldisc_get(tty
, disc
);
683 BUG_ON(disc
== N_TTY
);
688 tty_ldisc_close(tty
, tty
->ldisc
);
689 tty_ldisc_put(tty
->ldisc
);
692 /* switch the line discipline */
694 tty_set_termios_ldisc(tty
, disc
);
695 retval
= tty_ldisc_open(tty
, tty
->ldisc
);
697 tty_ldisc_put(tty
->ldisc
);
704 * tty_ldisc_hangup - hangup ldisc reset
705 * @tty: tty being hung up
707 * Some tty devices reset their termios when they receive a hangup
708 * event. In that situation we must also switch back to N_TTY properly
709 * before we reset the termios data.
711 * Locking: We can take the ldisc mutex as the rest of the code is
712 * careful to allow for this.
714 * In the pty pair case this occurs in the close() path of the
715 * tty itself so we must be careful about locking rules.
718 void tty_ldisc_hangup(struct tty_struct
*tty
, bool reinit
)
720 struct tty_ldisc
*ld
;
722 tty_ldisc_debug(tty
, "%p: hangup\n", tty
->ldisc
);
724 ld
= tty_ldisc_ref(tty
);
726 if (ld
->ops
->flush_buffer
)
727 ld
->ops
->flush_buffer(tty
);
728 tty_driver_flush_buffer(tty
);
729 if ((test_bit(TTY_DO_WRITE_WAKEUP
, &tty
->flags
)) &&
730 ld
->ops
->write_wakeup
)
731 ld
->ops
->write_wakeup(tty
);
733 ld
->ops
->hangup(tty
);
737 wake_up_interruptible_poll(&tty
->write_wait
, EPOLLOUT
);
738 wake_up_interruptible_poll(&tty
->read_wait
, EPOLLIN
);
741 * Shutdown the current line discipline, and reset it to
744 * Avoid racing set_ldisc or tty_ldisc_release
746 tty_ldisc_lock(tty
, MAX_SCHEDULE_TIMEOUT
);
748 if (tty
->driver
->flags
& TTY_DRIVER_RESET_TERMIOS
)
749 tty_reset_termios(tty
);
753 if (tty_ldisc_reinit(tty
, tty
->termios
.c_line
) < 0 &&
754 tty_ldisc_reinit(tty
, N_TTY
) < 0)
755 WARN_ON(tty_ldisc_reinit(tty
, N_NULL
) < 0);
759 tty_ldisc_unlock(tty
);
763 * tty_ldisc_setup - open line discipline
764 * @tty: tty being shut down
765 * @o_tty: pair tty for pty/tty pairs
767 * Called during the initial open of a tty/pty pair in order to set up the
768 * line disciplines and bind them to the tty. This has no locking issues
769 * as the device isn't yet active.
772 int tty_ldisc_setup(struct tty_struct
*tty
, struct tty_struct
*o_tty
)
774 int retval
= tty_ldisc_open(tty
, tty
->ldisc
);
779 retval
= tty_ldisc_open(o_tty
, o_tty
->ldisc
);
781 tty_ldisc_close(tty
, tty
->ldisc
);
789 * tty_ldisc_release - release line discipline
790 * @tty: tty being shut down (or one end of pty pair)
792 * Called during the final close of a tty or a pty pair in order to shut
793 * down the line discpline layer. On exit, each tty's ldisc is NULL.
796 void tty_ldisc_release(struct tty_struct
*tty
)
798 struct tty_struct
*o_tty
= tty
->link
;
801 * Shutdown this line discipline. As this is the final close,
802 * it does not race with the set_ldisc code path.
805 tty_ldisc_lock_pair(tty
, o_tty
);
808 tty_ldisc_kill(o_tty
);
809 tty_ldisc_unlock_pair(tty
, o_tty
);
811 /* And the memory resources remaining (buffers, termios) will be
812 disposed of when the kref hits zero */
814 tty_ldisc_debug(tty
, "released\n");
816 EXPORT_SYMBOL_GPL(tty_ldisc_release
);
819 * tty_ldisc_init - ldisc setup for new tty
820 * @tty: tty being allocated
822 * Set up the line discipline objects for a newly allocated tty. Note that
823 * the tty structure is not completely set up when this call is made.
826 int tty_ldisc_init(struct tty_struct
*tty
)
828 struct tty_ldisc
*ld
= tty_ldisc_get(tty
, N_TTY
);
836 * tty_ldisc_deinit - ldisc cleanup for new tty
837 * @tty: tty that was allocated recently
839 * The tty structure must not becompletely set up (tty_ldisc_setup) when
842 void tty_ldisc_deinit(struct tty_struct
*tty
)
845 tty_ldisc_put(tty
->ldisc
);
851 static struct ctl_table tty_table
[] = {
853 .procname
= "ldisc_autoload",
854 .data
= &tty_ldisc_autoload
,
855 .maxlen
= sizeof(tty_ldisc_autoload
),
857 .proc_handler
= proc_dointvec
,
864 static struct ctl_table tty_dir_table
[] = {
873 static struct ctl_table tty_root_table
[] = {
877 .child
= tty_dir_table
,
882 void tty_sysctl_init(void)
884 register_sysctl_table(tty_root_table
);