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. Returns NULL if the discipline is not available.
144 * Returns a pointer to the discipline and bumps the ref count if it is
148 * takes tty_ldiscs_lock to guard against ldisc races
151 static struct tty_ldisc
*tty_ldisc_get(struct tty_struct
*tty
, int disc
)
153 struct tty_ldisc
*ld
;
154 struct tty_ldisc_ops
*ldops
;
156 if (disc
< N_TTY
|| disc
>= NR_LDISCS
)
157 return ERR_PTR(-EINVAL
);
160 * Get the ldisc ops - we may need to request them to be loaded
161 * dynamically and try again.
163 ldops
= get_ldops(disc
);
165 request_module("tty-ldisc-%d", disc
);
166 ldops
= get_ldops(disc
);
168 return ERR_CAST(ldops
);
172 * There is no way to handle allocation failure of only 16 bytes.
173 * Let's simplify error handling and save more memory.
175 ld
= kmalloc(sizeof(struct tty_ldisc
), GFP_KERNEL
| __GFP_NOFAIL
);
183 * tty_ldisc_put - release the ldisc
185 * Complement of tty_ldisc_get().
187 static inline void tty_ldisc_put(struct tty_ldisc
*ld
)
189 if (WARN_ON_ONCE(!ld
))
196 static void *tty_ldiscs_seq_start(struct seq_file
*m
, loff_t
*pos
)
198 return (*pos
< NR_LDISCS
) ? pos
: NULL
;
201 static void *tty_ldiscs_seq_next(struct seq_file
*m
, void *v
, loff_t
*pos
)
204 return (*pos
< NR_LDISCS
) ? pos
: NULL
;
207 static void tty_ldiscs_seq_stop(struct seq_file
*m
, void *v
)
211 static int tty_ldiscs_seq_show(struct seq_file
*m
, void *v
)
213 int i
= *(loff_t
*)v
;
214 struct tty_ldisc_ops
*ldops
;
216 ldops
= get_ldops(i
);
219 seq_printf(m
, "%-10s %2d\n", ldops
->name
? ldops
->name
: "???", i
);
224 static const struct seq_operations tty_ldiscs_seq_ops
= {
225 .start
= tty_ldiscs_seq_start
,
226 .next
= tty_ldiscs_seq_next
,
227 .stop
= tty_ldiscs_seq_stop
,
228 .show
= tty_ldiscs_seq_show
,
231 static int proc_tty_ldiscs_open(struct inode
*inode
, struct file
*file
)
233 return seq_open(file
, &tty_ldiscs_seq_ops
);
236 const struct file_operations tty_ldiscs_proc_fops
= {
237 .owner
= THIS_MODULE
,
238 .open
= proc_tty_ldiscs_open
,
241 .release
= seq_release
,
245 * tty_ldisc_ref_wait - wait for the tty ldisc
248 * Dereference the line discipline for the terminal and take a
249 * reference to it. If the line discipline is in flux then
250 * wait patiently until it changes.
252 * Note: Must not be called from an IRQ/timer context. The caller
253 * must also be careful not to hold other locks that will deadlock
254 * against a discipline change, such as an existing ldisc reference
255 * (which we check for)
257 * Note: only callable from a file_operations routine (which
258 * guarantees tty->ldisc != NULL when the lock is acquired).
261 struct tty_ldisc
*tty_ldisc_ref_wait(struct tty_struct
*tty
)
263 ldsem_down_read(&tty
->ldisc_sem
, MAX_SCHEDULE_TIMEOUT
);
264 WARN_ON(!tty
->ldisc
);
267 EXPORT_SYMBOL_GPL(tty_ldisc_ref_wait
);
270 * tty_ldisc_ref - get the tty ldisc
273 * Dereference the line discipline for the terminal and take a
274 * reference to it. If the line discipline is in flux then
275 * return NULL. Can be called from IRQ and timer functions.
278 struct tty_ldisc
*tty_ldisc_ref(struct tty_struct
*tty
)
280 struct tty_ldisc
*ld
= NULL
;
282 if (ldsem_down_read_trylock(&tty
->ldisc_sem
)) {
285 ldsem_up_read(&tty
->ldisc_sem
);
289 EXPORT_SYMBOL_GPL(tty_ldisc_ref
);
292 * tty_ldisc_deref - free a tty ldisc reference
293 * @ld: reference to free up
295 * Undoes the effect of tty_ldisc_ref or tty_ldisc_ref_wait. May
296 * be called in IRQ context.
299 void tty_ldisc_deref(struct tty_ldisc
*ld
)
301 ldsem_up_read(&ld
->tty
->ldisc_sem
);
303 EXPORT_SYMBOL_GPL(tty_ldisc_deref
);
306 static inline int __lockfunc
307 __tty_ldisc_lock(struct tty_struct
*tty
, unsigned long timeout
)
309 return ldsem_down_write(&tty
->ldisc_sem
, timeout
);
312 static inline int __lockfunc
313 __tty_ldisc_lock_nested(struct tty_struct
*tty
, unsigned long timeout
)
315 return ldsem_down_write_nested(&tty
->ldisc_sem
,
316 LDISC_SEM_OTHER
, timeout
);
319 static inline void __tty_ldisc_unlock(struct tty_struct
*tty
)
321 ldsem_up_write(&tty
->ldisc_sem
);
324 static int __lockfunc
325 tty_ldisc_lock(struct tty_struct
*tty
, unsigned long timeout
)
329 ret
= __tty_ldisc_lock(tty
, timeout
);
332 set_bit(TTY_LDISC_HALTED
, &tty
->flags
);
336 static void tty_ldisc_unlock(struct tty_struct
*tty
)
338 clear_bit(TTY_LDISC_HALTED
, &tty
->flags
);
339 __tty_ldisc_unlock(tty
);
342 static int __lockfunc
343 tty_ldisc_lock_pair_timeout(struct tty_struct
*tty
, struct tty_struct
*tty2
,
344 unsigned long timeout
)
349 ret
= __tty_ldisc_lock(tty
, timeout
);
351 ret
= __tty_ldisc_lock_nested(tty2
, timeout
);
353 __tty_ldisc_unlock(tty
);
356 /* if this is possible, it has lots of implications */
357 WARN_ON_ONCE(tty
== tty2
);
358 if (tty2
&& tty
!= tty2
) {
359 ret
= __tty_ldisc_lock(tty2
, timeout
);
361 ret
= __tty_ldisc_lock_nested(tty
, timeout
);
363 __tty_ldisc_unlock(tty2
);
366 ret
= __tty_ldisc_lock(tty
, timeout
);
372 set_bit(TTY_LDISC_HALTED
, &tty
->flags
);
374 set_bit(TTY_LDISC_HALTED
, &tty2
->flags
);
378 static void __lockfunc
379 tty_ldisc_lock_pair(struct tty_struct
*tty
, struct tty_struct
*tty2
)
381 tty_ldisc_lock_pair_timeout(tty
, tty2
, MAX_SCHEDULE_TIMEOUT
);
384 static void __lockfunc
tty_ldisc_unlock_pair(struct tty_struct
*tty
,
385 struct tty_struct
*tty2
)
387 __tty_ldisc_unlock(tty
);
389 __tty_ldisc_unlock(tty2
);
393 * tty_ldisc_flush - flush line discipline queue
396 * Flush the line discipline queue (if any) and the tty flip buffers
400 void tty_ldisc_flush(struct tty_struct
*tty
)
402 struct tty_ldisc
*ld
= tty_ldisc_ref(tty
);
404 tty_buffer_flush(tty
, ld
);
408 EXPORT_SYMBOL_GPL(tty_ldisc_flush
);
411 * tty_set_termios_ldisc - set ldisc field
412 * @tty: tty structure
413 * @num: line discipline number
415 * This is probably overkill for real world processors but
416 * they are not on hot paths so a little discipline won't do
419 * The line discipline-related tty_struct fields are reset to
420 * prevent the ldisc driver from re-using stale information for
421 * the new ldisc instance.
423 * Locking: takes termios_rwsem
426 static void tty_set_termios_ldisc(struct tty_struct
*tty
, int num
)
428 down_write(&tty
->termios_rwsem
);
429 tty
->termios
.c_line
= num
;
430 up_write(&tty
->termios_rwsem
);
432 tty
->disc_data
= NULL
;
433 tty
->receive_room
= 0;
437 * tty_ldisc_open - open a line discipline
438 * @tty: tty we are opening the ldisc on
439 * @ld: discipline to open
441 * A helper opening method. Also a convenient debugging and check
444 * Locking: always called with BTM already held.
447 static int tty_ldisc_open(struct tty_struct
*tty
, struct tty_ldisc
*ld
)
449 WARN_ON(test_and_set_bit(TTY_LDISC_OPEN
, &tty
->flags
));
452 /* BTM here locks versus a hangup event */
453 ret
= ld
->ops
->open(tty
);
455 clear_bit(TTY_LDISC_OPEN
, &tty
->flags
);
457 tty_ldisc_debug(tty
, "%p: opened\n", tty
->ldisc
);
464 * tty_ldisc_close - close a line discipline
465 * @tty: tty we are opening the ldisc on
466 * @ld: discipline to close
468 * A helper close method. Also a convenient debugging and check
472 static void tty_ldisc_close(struct tty_struct
*tty
, struct tty_ldisc
*ld
)
474 WARN_ON(!test_bit(TTY_LDISC_OPEN
, &tty
->flags
));
475 clear_bit(TTY_LDISC_OPEN
, &tty
->flags
);
478 tty_ldisc_debug(tty
, "%p: closed\n", tty
->ldisc
);
482 * tty_ldisc_restore - helper for tty ldisc change
483 * @tty: tty to recover
484 * @old: previous ldisc
486 * Restore the previous line discipline or N_TTY when a line discipline
487 * change fails due to an open error
490 static void tty_ldisc_restore(struct tty_struct
*tty
, struct tty_ldisc
*old
)
492 struct tty_ldisc
*new_ldisc
;
495 /* There is an outstanding reference here so this is safe */
496 old
= tty_ldisc_get(tty
, old
->ops
->num
);
497 WARN_ON(IS_ERR(old
));
499 tty_set_termios_ldisc(tty
, old
->ops
->num
);
500 if (tty_ldisc_open(tty
, old
) < 0) {
502 /* This driver is always present */
503 new_ldisc
= tty_ldisc_get(tty
, N_TTY
);
504 if (IS_ERR(new_ldisc
))
506 tty
->ldisc
= new_ldisc
;
507 tty_set_termios_ldisc(tty
, N_TTY
);
508 r
= tty_ldisc_open(tty
, new_ldisc
);
510 panic("Couldn't open N_TTY ldisc for "
517 * tty_set_ldisc - set line discipline
518 * @tty: the terminal to set
519 * @ldisc: the line discipline
521 * Set the discipline of a tty line. Must be called from a process
522 * context. The ldisc change logic has to protect itself against any
523 * overlapping ldisc change (including on the other end of pty pairs),
524 * the close of one side of a tty/pty pair, and eventually hangup.
527 int tty_set_ldisc(struct tty_struct
*tty
, int ldisc
)
530 struct tty_ldisc
*old_ldisc
, *new_ldisc
;
532 new_ldisc
= tty_ldisc_get(tty
, ldisc
);
533 if (IS_ERR(new_ldisc
))
534 return PTR_ERR(new_ldisc
);
537 retval
= tty_ldisc_lock(tty
, 5 * HZ
);
539 tty_ldisc_put(new_ldisc
);
545 * Check the no-op case
548 if (tty
->ldisc
->ops
->num
== ldisc
) {
549 tty_ldisc_unlock(tty
);
550 tty_ldisc_put(new_ldisc
);
555 old_ldisc
= tty
->ldisc
;
557 if (test_bit(TTY_HUPPED
, &tty
->flags
)) {
558 /* We were raced by the hangup method. It will have stomped
559 the ldisc data and closed the ldisc down */
560 tty_ldisc_unlock(tty
);
561 tty_ldisc_put(new_ldisc
);
566 /* Shutdown the old discipline. */
567 tty_ldisc_close(tty
, old_ldisc
);
569 /* Now set up the new line discipline. */
570 tty
->ldisc
= new_ldisc
;
571 tty_set_termios_ldisc(tty
, ldisc
);
573 retval
= tty_ldisc_open(tty
, new_ldisc
);
575 /* Back to the old one or N_TTY if we can't */
576 tty_ldisc_put(new_ldisc
);
577 tty_ldisc_restore(tty
, old_ldisc
);
580 if (tty
->ldisc
->ops
->num
!= old_ldisc
->ops
->num
&& tty
->ops
->set_ldisc
) {
581 down_read(&tty
->termios_rwsem
);
582 tty
->ops
->set_ldisc(tty
);
583 up_read(&tty
->termios_rwsem
);
586 /* At this point we hold a reference to the new ldisc and a
587 reference to the old ldisc, or we hold two references to
588 the old ldisc (if it was restored as part of error cleanup
589 above). In either case, releasing a single reference from
590 the old ldisc is correct. */
592 tty_ldisc_put(old_ldisc
);
595 * Allow ldisc referencing to occur again
597 tty_ldisc_unlock(tty
);
599 /* Restart the work queue in case no characters kick it off. Safe if
601 tty_buffer_restart_work(tty
->port
);
608 * tty_reset_termios - reset terminal state
611 * Restore a terminal to the driver default state.
614 static void tty_reset_termios(struct tty_struct
*tty
)
616 down_write(&tty
->termios_rwsem
);
617 tty
->termios
= tty
->driver
->init_termios
;
618 tty
->termios
.c_ispeed
= tty_termios_input_baud_rate(&tty
->termios
);
619 tty
->termios
.c_ospeed
= tty_termios_baud_rate(&tty
->termios
);
620 up_write(&tty
->termios_rwsem
);
625 * tty_ldisc_reinit - reinitialise the tty ldisc
626 * @tty: tty to reinit
627 * @ldisc: line discipline to reinitialize
629 * Switch the tty to a line discipline and leave the ldisc
633 static int tty_ldisc_reinit(struct tty_struct
*tty
, int ldisc
)
635 struct tty_ldisc
*ld
= tty_ldisc_get(tty
, ldisc
);
640 tty_ldisc_close(tty
, tty
->ldisc
);
641 tty_ldisc_put(tty
->ldisc
);
643 * Switch the line discipline back
646 tty_set_termios_ldisc(tty
, ldisc
);
652 * tty_ldisc_hangup - hangup ldisc reset
653 * @tty: tty being hung up
655 * Some tty devices reset their termios when they receive a hangup
656 * event. In that situation we must also switch back to N_TTY properly
657 * before we reset the termios data.
659 * Locking: We can take the ldisc mutex as the rest of the code is
660 * careful to allow for this.
662 * In the pty pair case this occurs in the close() path of the
663 * tty itself so we must be careful about locking rules.
666 void tty_ldisc_hangup(struct tty_struct
*tty
)
668 struct tty_ldisc
*ld
;
669 int reset
= tty
->driver
->flags
& TTY_DRIVER_RESET_TERMIOS
;
672 tty_ldisc_debug(tty
, "%p: closing\n", tty
->ldisc
);
674 ld
= tty_ldisc_ref(tty
);
676 if (ld
->ops
->flush_buffer
)
677 ld
->ops
->flush_buffer(tty
);
678 tty_driver_flush_buffer(tty
);
679 if ((test_bit(TTY_DO_WRITE_WAKEUP
, &tty
->flags
)) &&
680 ld
->ops
->write_wakeup
)
681 ld
->ops
->write_wakeup(tty
);
683 ld
->ops
->hangup(tty
);
687 wake_up_interruptible_poll(&tty
->write_wait
, POLLOUT
);
688 wake_up_interruptible_poll(&tty
->read_wait
, POLLIN
);
691 * Shutdown the current line discipline, and reset it to
694 * Avoid racing set_ldisc or tty_ldisc_release
696 tty_ldisc_lock(tty
, MAX_SCHEDULE_TIMEOUT
);
700 /* At this point we have a halted ldisc; we want to close it and
701 reopen a new ldisc. We could defer the reopen to the next
702 open but it means auditing a lot of other paths so this is
706 if (!tty_ldisc_reinit(tty
, tty
->termios
.c_line
))
707 err
= tty_ldisc_open(tty
, tty
->ldisc
);
711 /* If the re-open fails or we reset then go to N_TTY. The
712 N_TTY open cannot fail */
714 BUG_ON(tty_ldisc_reinit(tty
, N_TTY
));
715 WARN_ON(tty_ldisc_open(tty
, tty
->ldisc
));
718 tty_ldisc_unlock(tty
);
720 tty_reset_termios(tty
);
722 tty_ldisc_debug(tty
, "%p: re-opened\n", tty
->ldisc
);
726 * tty_ldisc_setup - open line discipline
727 * @tty: tty being shut down
728 * @o_tty: pair tty for pty/tty pairs
730 * Called during the initial open of a tty/pty pair in order to set up the
731 * line disciplines and bind them to the tty. This has no locking issues
732 * as the device isn't yet active.
735 int tty_ldisc_setup(struct tty_struct
*tty
, struct tty_struct
*o_tty
)
737 struct tty_ldisc
*ld
= tty
->ldisc
;
740 retval
= tty_ldisc_open(tty
, ld
);
745 retval
= tty_ldisc_open(o_tty
, o_tty
->ldisc
);
747 tty_ldisc_close(tty
, ld
);
754 static void tty_ldisc_kill(struct tty_struct
*tty
)
757 * Now kill off the ldisc
759 tty_ldisc_close(tty
, tty
->ldisc
);
760 tty_ldisc_put(tty
->ldisc
);
761 /* Force an oops if we mess this up */
764 /* Ensure the next open requests the N_TTY ldisc */
765 tty_set_termios_ldisc(tty
, N_TTY
);
769 * tty_ldisc_release - release line discipline
770 * @tty: tty being shut down (or one end of pty pair)
772 * Called during the final close of a tty or a pty pair in order to shut
773 * down the line discpline layer. On exit, each ldisc assigned is N_TTY and
774 * each ldisc has not been opened.
777 void tty_ldisc_release(struct tty_struct
*tty
)
779 struct tty_struct
*o_tty
= tty
->link
;
782 * Shutdown this line discipline. As this is the final close,
783 * it does not race with the set_ldisc code path.
786 tty_ldisc_lock_pair(tty
, o_tty
);
789 tty_ldisc_kill(o_tty
);
790 tty_ldisc_unlock_pair(tty
, o_tty
);
792 /* And the memory resources remaining (buffers, termios) will be
793 disposed of when the kref hits zero */
795 tty_ldisc_debug(tty
, "released\n");
799 * tty_ldisc_init - ldisc setup for new tty
800 * @tty: tty being allocated
802 * Set up the line discipline objects for a newly allocated tty. Note that
803 * the tty structure is not completely set up when this call is made.
806 int tty_ldisc_init(struct tty_struct
*tty
)
808 struct tty_ldisc
*ld
= tty_ldisc_get(tty
, N_TTY
);
816 * tty_ldisc_init - ldisc cleanup for new tty
817 * @tty: tty that was allocated recently
819 * The tty structure must not becompletely set up (tty_ldisc_setup) when
822 void tty_ldisc_deinit(struct tty_struct
*tty
)
824 tty_ldisc_put(tty
->ldisc
);
828 void tty_ldisc_begin(void)
830 /* Setup the default TTY line discipline. */
831 (void) tty_register_ldisc(N_TTY
, &tty_ldisc_N_TTY
);