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 static struct tty_ldisc
*tty_ldisc_get(struct tty_struct
*tty
, int disc
)
161 struct tty_ldisc
*ld
;
162 struct tty_ldisc_ops
*ldops
;
164 if (disc
< N_TTY
|| disc
>= NR_LDISCS
)
165 return ERR_PTR(-EINVAL
);
168 * Get the ldisc ops - we may need to request them to be loaded
169 * dynamically and try again.
171 ldops
= get_ldops(disc
);
173 request_module("tty-ldisc-%d", disc
);
174 ldops
= get_ldops(disc
);
176 return ERR_CAST(ldops
);
180 * There is no way to handle allocation failure of only 16 bytes.
181 * Let's simplify error handling and save more memory.
183 ld
= kmalloc(sizeof(struct tty_ldisc
), GFP_KERNEL
| __GFP_NOFAIL
);
191 * tty_ldisc_put - release the ldisc
193 * Complement of tty_ldisc_get().
195 static void tty_ldisc_put(struct tty_ldisc
*ld
)
197 if (WARN_ON_ONCE(!ld
))
204 static void *tty_ldiscs_seq_start(struct seq_file
*m
, loff_t
*pos
)
206 return (*pos
< NR_LDISCS
) ? pos
: NULL
;
209 static void *tty_ldiscs_seq_next(struct seq_file
*m
, void *v
, loff_t
*pos
)
212 return (*pos
< NR_LDISCS
) ? pos
: NULL
;
215 static void tty_ldiscs_seq_stop(struct seq_file
*m
, void *v
)
219 static int tty_ldiscs_seq_show(struct seq_file
*m
, void *v
)
221 int i
= *(loff_t
*)v
;
222 struct tty_ldisc_ops
*ldops
;
224 ldops
= get_ldops(i
);
227 seq_printf(m
, "%-10s %2d\n", ldops
->name
? ldops
->name
: "???", i
);
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_ref_wait - wait for the tty ldisc
256 * Dereference the line discipline for the terminal and take a
257 * reference to it. If the line discipline is in flux then
258 * wait patiently until it changes.
260 * Returns: NULL if the tty has been hungup and not re-opened with
261 * a new file descriptor, otherwise valid ldisc reference
263 * Note: Must not be called from an IRQ/timer context. The caller
264 * must also be careful not to hold other locks that will deadlock
265 * against a discipline change, such as an existing ldisc reference
266 * (which we check for)
268 * Note: a file_operations routine (read/poll/write) should use this
269 * function to wait for any ldisc lifetime events to finish.
272 struct tty_ldisc
*tty_ldisc_ref_wait(struct tty_struct
*tty
)
274 struct tty_ldisc
*ld
;
276 ldsem_down_read(&tty
->ldisc_sem
, MAX_SCHEDULE_TIMEOUT
);
279 ldsem_up_read(&tty
->ldisc_sem
);
282 EXPORT_SYMBOL_GPL(tty_ldisc_ref_wait
);
285 * tty_ldisc_ref - get the tty ldisc
288 * Dereference the line discipline for the terminal and take a
289 * reference to it. If the line discipline is in flux then
290 * return NULL. Can be called from IRQ and timer functions.
293 struct tty_ldisc
*tty_ldisc_ref(struct tty_struct
*tty
)
295 struct tty_ldisc
*ld
= NULL
;
297 if (ldsem_down_read_trylock(&tty
->ldisc_sem
)) {
300 ldsem_up_read(&tty
->ldisc_sem
);
304 EXPORT_SYMBOL_GPL(tty_ldisc_ref
);
307 * tty_ldisc_deref - free a tty ldisc reference
308 * @ld: reference to free up
310 * Undoes the effect of tty_ldisc_ref or tty_ldisc_ref_wait. May
311 * be called in IRQ context.
314 void tty_ldisc_deref(struct tty_ldisc
*ld
)
316 ldsem_up_read(&ld
->tty
->ldisc_sem
);
318 EXPORT_SYMBOL_GPL(tty_ldisc_deref
);
322 __tty_ldisc_lock(struct tty_struct
*tty
, unsigned long timeout
)
324 return ldsem_down_write(&tty
->ldisc_sem
, timeout
);
328 __tty_ldisc_lock_nested(struct tty_struct
*tty
, unsigned long timeout
)
330 return ldsem_down_write_nested(&tty
->ldisc_sem
,
331 LDISC_SEM_OTHER
, timeout
);
334 static inline void __tty_ldisc_unlock(struct tty_struct
*tty
)
336 ldsem_up_write(&tty
->ldisc_sem
);
339 int tty_ldisc_lock(struct tty_struct
*tty
, unsigned long timeout
)
343 ret
= __tty_ldisc_lock(tty
, timeout
);
346 set_bit(TTY_LDISC_HALTED
, &tty
->flags
);
350 void tty_ldisc_unlock(struct tty_struct
*tty
)
352 clear_bit(TTY_LDISC_HALTED
, &tty
->flags
);
353 __tty_ldisc_unlock(tty
);
357 tty_ldisc_lock_pair_timeout(struct tty_struct
*tty
, struct tty_struct
*tty2
,
358 unsigned long timeout
)
363 ret
= __tty_ldisc_lock(tty
, timeout
);
365 ret
= __tty_ldisc_lock_nested(tty2
, timeout
);
367 __tty_ldisc_unlock(tty
);
370 /* if this is possible, it has lots of implications */
371 WARN_ON_ONCE(tty
== tty2
);
372 if (tty2
&& tty
!= tty2
) {
373 ret
= __tty_ldisc_lock(tty2
, timeout
);
375 ret
= __tty_ldisc_lock_nested(tty
, timeout
);
377 __tty_ldisc_unlock(tty2
);
380 ret
= __tty_ldisc_lock(tty
, timeout
);
386 set_bit(TTY_LDISC_HALTED
, &tty
->flags
);
388 set_bit(TTY_LDISC_HALTED
, &tty2
->flags
);
392 static void tty_ldisc_lock_pair(struct tty_struct
*tty
, struct tty_struct
*tty2
)
394 tty_ldisc_lock_pair_timeout(tty
, tty2
, MAX_SCHEDULE_TIMEOUT
);
397 static void tty_ldisc_unlock_pair(struct tty_struct
*tty
,
398 struct tty_struct
*tty2
)
400 __tty_ldisc_unlock(tty
);
402 __tty_ldisc_unlock(tty2
);
406 * tty_ldisc_flush - flush line discipline queue
409 * Flush the line discipline queue (if any) and the tty flip buffers
413 void tty_ldisc_flush(struct tty_struct
*tty
)
415 struct tty_ldisc
*ld
= tty_ldisc_ref(tty
);
417 tty_buffer_flush(tty
, ld
);
421 EXPORT_SYMBOL_GPL(tty_ldisc_flush
);
424 * tty_set_termios_ldisc - set ldisc field
425 * @tty: tty structure
426 * @disc: line discipline number
428 * This is probably overkill for real world processors but
429 * they are not on hot paths so a little discipline won't do
432 * The line discipline-related tty_struct fields are reset to
433 * prevent the ldisc driver from re-using stale information for
434 * the new ldisc instance.
436 * Locking: takes termios_rwsem
439 static void tty_set_termios_ldisc(struct tty_struct
*tty
, int disc
)
441 down_write(&tty
->termios_rwsem
);
442 tty
->termios
.c_line
= disc
;
443 up_write(&tty
->termios_rwsem
);
445 tty
->disc_data
= NULL
;
446 tty
->receive_room
= 0;
450 * tty_ldisc_open - open a line discipline
451 * @tty: tty we are opening the ldisc on
452 * @ld: discipline to open
454 * A helper opening method. Also a convenient debugging and check
457 * Locking: always called with BTM already held.
460 static int tty_ldisc_open(struct tty_struct
*tty
, struct tty_ldisc
*ld
)
462 WARN_ON(test_and_set_bit(TTY_LDISC_OPEN
, &tty
->flags
));
465 /* BTM here locks versus a hangup event */
466 ret
= ld
->ops
->open(tty
);
468 clear_bit(TTY_LDISC_OPEN
, &tty
->flags
);
470 tty_ldisc_debug(tty
, "%p: opened\n", ld
);
477 * tty_ldisc_close - close a line discipline
478 * @tty: tty we are opening the ldisc on
479 * @ld: discipline to close
481 * A helper close method. Also a convenient debugging and check
485 static void tty_ldisc_close(struct tty_struct
*tty
, struct tty_ldisc
*ld
)
487 WARN_ON(!test_bit(TTY_LDISC_OPEN
, &tty
->flags
));
488 clear_bit(TTY_LDISC_OPEN
, &tty
->flags
);
491 tty_ldisc_debug(tty
, "%p: closed\n", ld
);
495 * tty_ldisc_failto - helper for ldisc failback
496 * @tty: tty to open the ldisc on
497 * @ld: ldisc we are trying to fail back to
499 * Helper to try and recover a tty when switching back to the old
500 * ldisc fails and we need something attached.
503 static int tty_ldisc_failto(struct tty_struct
*tty
, int ld
)
505 struct tty_ldisc
*disc
= tty_ldisc_get(tty
, ld
);
509 return PTR_ERR(disc
);
511 tty_set_termios_ldisc(tty
, ld
);
512 if ((r
= tty_ldisc_open(tty
, disc
)) < 0)
518 * tty_ldisc_restore - helper for tty ldisc change
519 * @tty: tty to recover
520 * @old: previous ldisc
522 * Restore the previous line discipline or N_TTY when a line discipline
523 * change fails due to an open error
526 static void tty_ldisc_restore(struct tty_struct
*tty
, struct tty_ldisc
*old
)
528 /* There is an outstanding reference here so this is safe */
529 if (tty_ldisc_failto(tty
, old
->ops
->num
) < 0) {
530 const char *name
= tty_name(tty
);
532 pr_warn("Falling back ldisc for %s.\n", name
);
533 /* The traditional behaviour is to fall back to N_TTY, we
534 want to avoid falling back to N_NULL unless we have no
535 choice to avoid the risk of breaking anything */
536 if (tty_ldisc_failto(tty
, N_TTY
) < 0 &&
537 tty_ldisc_failto(tty
, N_NULL
) < 0)
538 panic("Couldn't open N_NULL ldisc for %s.", name
);
543 * tty_set_ldisc - set line discipline
544 * @tty: the terminal to set
545 * @ldisc: the line discipline
547 * Set the discipline of a tty line. Must be called from a process
548 * context. The ldisc change logic has to protect itself against any
549 * overlapping ldisc change (including on the other end of pty pairs),
550 * the close of one side of a tty/pty pair, and eventually hangup.
553 int tty_set_ldisc(struct tty_struct
*tty
, int disc
)
556 struct tty_ldisc
*old_ldisc
, *new_ldisc
;
558 new_ldisc
= tty_ldisc_get(tty
, disc
);
559 if (IS_ERR(new_ldisc
))
560 return PTR_ERR(new_ldisc
);
563 retval
= tty_ldisc_lock(tty
, 5 * HZ
);
572 /* Check the no-op case */
573 if (tty
->ldisc
->ops
->num
== disc
)
576 if (test_bit(TTY_HUPPED
, &tty
->flags
)) {
577 /* We were raced by hangup */
582 old_ldisc
= tty
->ldisc
;
584 /* Shutdown the old discipline. */
585 tty_ldisc_close(tty
, old_ldisc
);
587 /* Now set up the new line discipline. */
588 tty
->ldisc
= new_ldisc
;
589 tty_set_termios_ldisc(tty
, disc
);
591 retval
= tty_ldisc_open(tty
, new_ldisc
);
593 /* Back to the old one or N_TTY if we can't */
594 tty_ldisc_put(new_ldisc
);
595 tty_ldisc_restore(tty
, old_ldisc
);
598 if (tty
->ldisc
->ops
->num
!= old_ldisc
->ops
->num
&& tty
->ops
->set_ldisc
) {
599 down_read(&tty
->termios_rwsem
);
600 tty
->ops
->set_ldisc(tty
);
601 up_read(&tty
->termios_rwsem
);
604 /* At this point we hold a reference to the new ldisc and a
605 reference to the old ldisc, or we hold two references to
606 the old ldisc (if it was restored as part of error cleanup
607 above). In either case, releasing a single reference from
608 the old ldisc is correct. */
609 new_ldisc
= old_ldisc
;
611 tty_ldisc_unlock(tty
);
613 /* Restart the work queue in case no characters kick it off. Safe if
615 tty_buffer_restart_work(tty
->port
);
617 tty_ldisc_put(new_ldisc
); /* drop the extra reference */
621 EXPORT_SYMBOL_GPL(tty_set_ldisc
);
624 * tty_ldisc_kill - teardown ldisc
625 * @tty: tty being released
627 * Perform final close of the ldisc and reset tty->ldisc
629 static void tty_ldisc_kill(struct tty_struct
*tty
)
634 * Now kill off the ldisc
636 tty_ldisc_close(tty
, tty
->ldisc
);
637 tty_ldisc_put(tty
->ldisc
);
638 /* Force an oops if we mess this up */
643 * tty_reset_termios - reset terminal state
646 * Restore a terminal to the driver default state.
649 static void tty_reset_termios(struct tty_struct
*tty
)
651 down_write(&tty
->termios_rwsem
);
652 tty
->termios
= tty
->driver
->init_termios
;
653 tty
->termios
.c_ispeed
= tty_termios_input_baud_rate(&tty
->termios
);
654 tty
->termios
.c_ospeed
= tty_termios_baud_rate(&tty
->termios
);
655 up_write(&tty
->termios_rwsem
);
660 * tty_ldisc_reinit - reinitialise the tty ldisc
661 * @tty: tty to reinit
662 * @disc: line discipline to reinitialize
664 * Completely reinitialize the line discipline state, by closing the
665 * current instance, if there is one, and opening a new instance. If
666 * an error occurs opening the new non-N_TTY instance, the instance
667 * is dropped and tty->ldisc reset to NULL. The caller can then retry
668 * with N_TTY instead.
670 * Returns 0 if successful, otherwise error code < 0
673 int tty_ldisc_reinit(struct tty_struct
*tty
, int disc
)
675 struct tty_ldisc
*ld
;
678 ld
= tty_ldisc_get(tty
, disc
);
680 BUG_ON(disc
== N_TTY
);
685 tty_ldisc_close(tty
, tty
->ldisc
);
686 tty_ldisc_put(tty
->ldisc
);
689 /* switch the line discipline */
691 tty_set_termios_ldisc(tty
, disc
);
692 retval
= tty_ldisc_open(tty
, tty
->ldisc
);
694 tty_ldisc_put(tty
->ldisc
);
701 * tty_ldisc_hangup - hangup ldisc reset
702 * @tty: tty being hung up
704 * Some tty devices reset their termios when they receive a hangup
705 * event. In that situation we must also switch back to N_TTY properly
706 * before we reset the termios data.
708 * Locking: We can take the ldisc mutex as the rest of the code is
709 * careful to allow for this.
711 * In the pty pair case this occurs in the close() path of the
712 * tty itself so we must be careful about locking rules.
715 void tty_ldisc_hangup(struct tty_struct
*tty
, bool reinit
)
717 struct tty_ldisc
*ld
;
719 tty_ldisc_debug(tty
, "%p: hangup\n", tty
->ldisc
);
721 ld
= tty_ldisc_ref(tty
);
723 if (ld
->ops
->flush_buffer
)
724 ld
->ops
->flush_buffer(tty
);
725 tty_driver_flush_buffer(tty
);
726 if ((test_bit(TTY_DO_WRITE_WAKEUP
, &tty
->flags
)) &&
727 ld
->ops
->write_wakeup
)
728 ld
->ops
->write_wakeup(tty
);
730 ld
->ops
->hangup(tty
);
734 wake_up_interruptible_poll(&tty
->write_wait
, EPOLLOUT
);
735 wake_up_interruptible_poll(&tty
->read_wait
, EPOLLIN
);
738 * Shutdown the current line discipline, and reset it to
741 * Avoid racing set_ldisc or tty_ldisc_release
743 tty_ldisc_lock(tty
, MAX_SCHEDULE_TIMEOUT
);
745 if (tty
->driver
->flags
& TTY_DRIVER_RESET_TERMIOS
)
746 tty_reset_termios(tty
);
750 if (tty_ldisc_reinit(tty
, tty
->termios
.c_line
) < 0 &&
751 tty_ldisc_reinit(tty
, N_TTY
) < 0)
752 WARN_ON(tty_ldisc_reinit(tty
, N_NULL
) < 0);
756 tty_ldisc_unlock(tty
);
760 * tty_ldisc_setup - open line discipline
761 * @tty: tty being shut down
762 * @o_tty: pair tty for pty/tty pairs
764 * Called during the initial open of a tty/pty pair in order to set up the
765 * line disciplines and bind them to the tty. This has no locking issues
766 * as the device isn't yet active.
769 int tty_ldisc_setup(struct tty_struct
*tty
, struct tty_struct
*o_tty
)
771 int retval
= tty_ldisc_open(tty
, tty
->ldisc
);
776 retval
= tty_ldisc_open(o_tty
, o_tty
->ldisc
);
778 tty_ldisc_close(tty
, tty
->ldisc
);
786 * tty_ldisc_release - release line discipline
787 * @tty: tty being shut down (or one end of pty pair)
789 * Called during the final close of a tty or a pty pair in order to shut
790 * down the line discpline layer. On exit, each tty's ldisc is NULL.
793 void tty_ldisc_release(struct tty_struct
*tty
)
795 struct tty_struct
*o_tty
= tty
->link
;
798 * Shutdown this line discipline. As this is the final close,
799 * it does not race with the set_ldisc code path.
802 tty_ldisc_lock_pair(tty
, o_tty
);
805 tty_ldisc_kill(o_tty
);
806 tty_ldisc_unlock_pair(tty
, o_tty
);
808 /* And the memory resources remaining (buffers, termios) will be
809 disposed of when the kref hits zero */
811 tty_ldisc_debug(tty
, "released\n");
813 EXPORT_SYMBOL_GPL(tty_ldisc_release
);
816 * tty_ldisc_init - ldisc setup for new tty
817 * @tty: tty being allocated
819 * Set up the line discipline objects for a newly allocated tty. Note that
820 * the tty structure is not completely set up when this call is made.
823 int tty_ldisc_init(struct tty_struct
*tty
)
825 struct tty_ldisc
*ld
= tty_ldisc_get(tty
, N_TTY
);
833 * tty_ldisc_deinit - ldisc cleanup for new tty
834 * @tty: tty that was allocated recently
836 * The tty structure must not becompletely set up (tty_ldisc_setup) when
839 void tty_ldisc_deinit(struct tty_struct
*tty
)
842 tty_ldisc_put(tty
->ldisc
);