blob: 73598f2a3ada395bf4b5aeb5f6c84f71e1dd1f0c [file] [log] [blame]
Greg Kroah-Hartmane3b3d0f2017-11-06 18:11:51 +01001// SPDX-License-Identifier: GPL-2.0
Alan Cox01e1abb2008-07-22 11:16:55 +01002#include <linux/types.h>
Alan Cox01e1abb2008-07-22 11:16:55 +01003#include <linux/errno.h>
Jiri Slaby8b3ffa12011-11-16 16:27:10 +01004#include <linux/kmod.h>
Alan Cox01e1abb2008-07-22 11:16:55 +01005#include <linux/sched.h>
6#include <linux/interrupt.h>
7#include <linux/tty.h>
8#include <linux/tty_driver.h>
Alan Cox01e1abb2008-07-22 11:16:55 +01009#include <linux/file.h>
Alan Cox01e1abb2008-07-22 11:16:55 +010010#include <linux/mm.h>
11#include <linux/string.h>
12#include <linux/slab.h>
13#include <linux/poll.h>
14#include <linux/proc_fs.h>
Alan Cox01e1abb2008-07-22 11:16:55 +010015#include <linux/module.h>
Alan Cox01e1abb2008-07-22 11:16:55 +010016#include <linux/device.h>
17#include <linux/wait.h>
18#include <linux/bitops.h>
Alan Cox01e1abb2008-07-22 11:16:55 +010019#include <linux/seq_file.h>
Alan Cox01e1abb2008-07-22 11:16:55 +010020#include <linux/uaccess.h>
Jiri Slaby0c73c082011-11-16 16:27:09 +010021#include <linux/ratelimit.h>
Alan Cox01e1abb2008-07-22 11:16:55 +010022
Peter Hurleyfc575ee2013-03-11 16:44:38 -040023#undef LDISC_DEBUG_HANGUP
24
25#ifdef LDISC_DEBUG_HANGUP
Peter Hurley0a6adc12015-07-12 22:49:10 -040026#define tty_ldisc_debug(tty, f, args...) tty_debug(tty, f, ##args)
Peter Hurleyfc575ee2013-03-11 16:44:38 -040027#else
28#define tty_ldisc_debug(tty, f, args...)
29#endif
30
Peter Hurleyd2c43892013-06-15 07:04:47 -040031/* lockdep nested classes for tty->ldisc_sem */
32enum {
33 LDISC_SEM_NORMAL,
34 LDISC_SEM_OTHER,
35};
36
37
Alan Cox01e1abb2008-07-22 11:16:55 +010038/*
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.
42 */
43
Peter Hurley137084b2013-06-15 07:04:46 -040044static DEFINE_RAW_SPINLOCK(tty_ldiscs_lock);
Alan Cox01e1abb2008-07-22 11:16:55 +010045/* Line disc dispatch table */
46static struct tty_ldisc_ops *tty_ldiscs[NR_LDISCS];
47
48/**
49 * tty_register_ldisc - install a line discipline
50 * @disc: ldisc number
51 * @new_ldisc: pointer to the ldisc object
52 *
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.
56 *
57 * Locking:
Peter Hurley137084b2013-06-15 07:04:46 -040058 * takes tty_ldiscs_lock to guard against ldisc races
Alan Cox01e1abb2008-07-22 11:16:55 +010059 */
60
61int tty_register_ldisc(int disc, struct tty_ldisc_ops *new_ldisc)
62{
63 unsigned long flags;
64 int ret = 0;
65
66 if (disc < N_TTY || disc >= NR_LDISCS)
67 return -EINVAL;
68
Peter Hurley137084b2013-06-15 07:04:46 -040069 raw_spin_lock_irqsave(&tty_ldiscs_lock, flags);
Alan Cox01e1abb2008-07-22 11:16:55 +010070 tty_ldiscs[disc] = new_ldisc;
71 new_ldisc->num = disc;
72 new_ldisc->refcount = 0;
Peter Hurley137084b2013-06-15 07:04:46 -040073 raw_spin_unlock_irqrestore(&tty_ldiscs_lock, flags);
Alan Cox01e1abb2008-07-22 11:16:55 +010074
75 return ret;
76}
77EXPORT_SYMBOL(tty_register_ldisc);
78
79/**
80 * tty_unregister_ldisc - unload a line discipline
81 * @disc: ldisc number
82 * @new_ldisc: pointer to the ldisc object
83 *
84 * Remove a line discipline from the kernel providing it is not
85 * currently in use.
86 *
87 * Locking:
Peter Hurley137084b2013-06-15 07:04:46 -040088 * takes tty_ldiscs_lock to guard against ldisc races
Alan Cox01e1abb2008-07-22 11:16:55 +010089 */
90
91int tty_unregister_ldisc(int disc)
92{
93 unsigned long flags;
94 int ret = 0;
95
96 if (disc < N_TTY || disc >= NR_LDISCS)
97 return -EINVAL;
98
Peter Hurley137084b2013-06-15 07:04:46 -040099 raw_spin_lock_irqsave(&tty_ldiscs_lock, flags);
Alan Cox01e1abb2008-07-22 11:16:55 +0100100 if (tty_ldiscs[disc]->refcount)
101 ret = -EBUSY;
102 else
103 tty_ldiscs[disc] = NULL;
Peter Hurley137084b2013-06-15 07:04:46 -0400104 raw_spin_unlock_irqrestore(&tty_ldiscs_lock, flags);
Alan Cox01e1abb2008-07-22 11:16:55 +0100105
106 return ret;
107}
108EXPORT_SYMBOL(tty_unregister_ldisc);
109
Linus Torvaldsf0de0e82009-08-03 16:00:15 -0700110static struct tty_ldisc_ops *get_ldops(int disc)
111{
112 unsigned long flags;
113 struct tty_ldisc_ops *ldops, *ret;
114
Peter Hurley137084b2013-06-15 07:04:46 -0400115 raw_spin_lock_irqsave(&tty_ldiscs_lock, flags);
Linus Torvaldsf0de0e82009-08-03 16:00:15 -0700116 ret = ERR_PTR(-EINVAL);
117 ldops = tty_ldiscs[disc];
118 if (ldops) {
119 ret = ERR_PTR(-EAGAIN);
120 if (try_module_get(ldops->owner)) {
121 ldops->refcount++;
122 ret = ldops;
123 }
124 }
Peter Hurley137084b2013-06-15 07:04:46 -0400125 raw_spin_unlock_irqrestore(&tty_ldiscs_lock, flags);
Linus Torvaldsf0de0e82009-08-03 16:00:15 -0700126 return ret;
127}
128
129static void put_ldops(struct tty_ldisc_ops *ldops)
130{
131 unsigned long flags;
132
Peter Hurley137084b2013-06-15 07:04:46 -0400133 raw_spin_lock_irqsave(&tty_ldiscs_lock, flags);
Linus Torvaldsf0de0e82009-08-03 16:00:15 -0700134 ldops->refcount--;
135 module_put(ldops->owner);
Peter Hurley137084b2013-06-15 07:04:46 -0400136 raw_spin_unlock_irqrestore(&tty_ldiscs_lock, flags);
Linus Torvaldsf0de0e82009-08-03 16:00:15 -0700137}
Alan Cox01e1abb2008-07-22 11:16:55 +0100138
139/**
Alan Cox01e1abb2008-07-22 11:16:55 +0100140 * tty_ldisc_get - take a reference to an ldisc
141 * @disc: ldisc number
Alan Cox01e1abb2008-07-22 11:16:55 +0100142 *
143 * Takes a reference to a line discipline. Deals with refcounts and
Peter Hurleyc0cc1c52016-01-10 22:40:59 -0800144 * module locking counts.
145 *
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
149 * the discipline
150 * -ENOMEM if allocation failure
151 *
152 * Otherwise, returns a pointer to the discipline and bumps the
153 * ref count
Alan Cox01e1abb2008-07-22 11:16:55 +0100154 *
155 * Locking:
Peter Hurley137084b2013-06-15 07:04:46 -0400156 * takes tty_ldiscs_lock to guard against ldisc races
Alan Cox01e1abb2008-07-22 11:16:55 +0100157 */
158
Peter Hurley36697522013-06-15 07:04:48 -0400159static struct tty_ldisc *tty_ldisc_get(struct tty_struct *tty, int disc)
Alan Cox01e1abb2008-07-22 11:16:55 +0100160{
Alan Coxc65c9bc2009-06-11 12:50:12 +0100161 struct tty_ldisc *ld;
Linus Torvalds182274f2009-08-03 16:01:28 -0700162 struct tty_ldisc_ops *ldops;
Alan Cox01e1abb2008-07-22 11:16:55 +0100163
164 if (disc < N_TTY || disc >= NR_LDISCS)
Alan Coxc65c9bc2009-06-11 12:50:12 +0100165 return ERR_PTR(-EINVAL);
Linus Torvalds182274f2009-08-03 16:01:28 -0700166
167 /*
168 * Get the ldisc ops - we may need to request them to be loaded
169 * dynamically and try again.
170 */
171 ldops = get_ldops(disc);
172 if (IS_ERR(ldops)) {
Alan Cox01e1abb2008-07-22 11:16:55 +0100173 request_module("tty-ldisc-%d", disc);
Linus Torvalds182274f2009-08-03 16:01:28 -0700174 ldops = get_ldops(disc);
175 if (IS_ERR(ldops))
176 return ERR_CAST(ldops);
Alan Cox01e1abb2008-07-22 11:16:55 +0100177 }
Linus Torvalds182274f2009-08-03 16:01:28 -0700178
179 ld = kmalloc(sizeof(struct tty_ldisc), GFP_KERNEL);
180 if (ld == NULL) {
181 put_ldops(ldops);
182 return ERR_PTR(-ENOMEM);
183 }
184
185 ld->ops = ldops;
Peter Hurley36697522013-06-15 07:04:48 -0400186 ld->tty = tty;
Ivo Sieben1541f842012-05-03 14:37:43 +0200187
Alan Coxc65c9bc2009-06-11 12:50:12 +0100188 return ld;
Alan Cox01e1abb2008-07-22 11:16:55 +0100189}
190
Peter Hurley734de242013-03-11 16:44:43 -0400191/**
192 * tty_ldisc_put - release the ldisc
193 *
194 * Complement of tty_ldisc_get().
195 */
Denys Vlasenkocb128f62015-10-27 17:40:02 +0100196static void tty_ldisc_put(struct tty_ldisc *ld)
Peter Hurley734de242013-03-11 16:44:43 -0400197{
Peter Hurley734de242013-03-11 16:44:43 -0400198 if (WARN_ON_ONCE(!ld))
199 return;
200
Peter Hurley36697522013-06-15 07:04:48 -0400201 put_ldops(ld->ops);
Peter Hurley734de242013-03-11 16:44:43 -0400202 kfree(ld);
Peter Hurley734de242013-03-11 16:44:43 -0400203}
204
Alan Cox852e99d2009-06-11 12:51:41 +0100205static void *tty_ldiscs_seq_start(struct seq_file *m, loff_t *pos)
Alan Cox01e1abb2008-07-22 11:16:55 +0100206{
207 return (*pos < NR_LDISCS) ? pos : NULL;
208}
209
Alan Cox852e99d2009-06-11 12:51:41 +0100210static void *tty_ldiscs_seq_next(struct seq_file *m, void *v, loff_t *pos)
Alan Cox01e1abb2008-07-22 11:16:55 +0100211{
212 (*pos)++;
213 return (*pos < NR_LDISCS) ? pos : NULL;
214}
215
216static void tty_ldiscs_seq_stop(struct seq_file *m, void *v)
217{
218}
219
220static int tty_ldiscs_seq_show(struct seq_file *m, void *v)
221{
222 int i = *(loff_t *)v;
Linus Torvaldsf0de0e82009-08-03 16:00:15 -0700223 struct tty_ldisc_ops *ldops;
Alan Cox852e99d2009-06-11 12:51:41 +0100224
Linus Torvaldsf0de0e82009-08-03 16:00:15 -0700225 ldops = get_ldops(i);
226 if (IS_ERR(ldops))
Alan Cox01e1abb2008-07-22 11:16:55 +0100227 return 0;
Linus Torvaldsf0de0e82009-08-03 16:00:15 -0700228 seq_printf(m, "%-10s %2d\n", ldops->name ? ldops->name : "???", i);
229 put_ldops(ldops);
Alan Cox01e1abb2008-07-22 11:16:55 +0100230 return 0;
231}
232
233static const struct seq_operations tty_ldiscs_seq_ops = {
234 .start = tty_ldiscs_seq_start,
235 .next = tty_ldiscs_seq_next,
236 .stop = tty_ldiscs_seq_stop,
237 .show = tty_ldiscs_seq_show,
238};
239
240static int proc_tty_ldiscs_open(struct inode *inode, struct file *file)
241{
242 return seq_open(file, &tty_ldiscs_seq_ops);
243}
244
245const struct file_operations tty_ldiscs_proc_fops = {
246 .owner = THIS_MODULE,
247 .open = proc_tty_ldiscs_open,
248 .read = seq_read,
249 .llseek = seq_lseek,
250 .release = seq_release,
251};
252
253/**
Alan Cox01e1abb2008-07-22 11:16:55 +0100254 * tty_ldisc_ref_wait - wait for the tty ldisc
255 * @tty: tty device
256 *
257 * Dereference the line discipline for the terminal and take a
258 * reference to it. If the line discipline is in flux then
259 * wait patiently until it changes.
260 *
Peter Hurley892d1fa2016-01-10 22:41:06 -0800261 * Returns: NULL if the tty has been hungup and not re-opened with
262 * a new file descriptor, otherwise valid ldisc reference
263 *
Alan Cox01e1abb2008-07-22 11:16:55 +0100264 * Note: Must not be called from an IRQ/timer context. The caller
265 * must also be careful not to hold other locks that will deadlock
266 * against a discipline change, such as an existing ldisc reference
267 * (which we check for)
268 *
Peter Hurleye55afd12016-01-10 22:41:01 -0800269 * Note: a file_operations routine (read/poll/write) should use this
270 * function to wait for any ldisc lifetime events to finish.
Alan Cox01e1abb2008-07-22 11:16:55 +0100271 */
272
273struct tty_ldisc *tty_ldisc_ref_wait(struct tty_struct *tty)
274{
Dmitry Vyukova4a3e062017-03-04 13:46:12 +0100275 struct tty_ldisc *ld;
276
Peter Hurley36697522013-06-15 07:04:48 -0400277 ldsem_down_read(&tty->ldisc_sem, MAX_SCHEDULE_TIMEOUT);
Dmitry Vyukova4a3e062017-03-04 13:46:12 +0100278 ld = tty->ldisc;
279 if (!ld)
Peter Hurleya570a492016-01-10 22:41:02 -0800280 ldsem_up_read(&tty->ldisc_sem);
Dmitry Vyukova4a3e062017-03-04 13:46:12 +0100281 return ld;
Alan Cox01e1abb2008-07-22 11:16:55 +0100282}
Alan Cox01e1abb2008-07-22 11:16:55 +0100283EXPORT_SYMBOL_GPL(tty_ldisc_ref_wait);
284
285/**
286 * tty_ldisc_ref - get the tty ldisc
287 * @tty: tty device
288 *
289 * Dereference the line discipline for the terminal and take a
290 * reference to it. If the line discipline is in flux then
291 * return NULL. Can be called from IRQ and timer functions.
Alan Cox01e1abb2008-07-22 11:16:55 +0100292 */
293
294struct tty_ldisc *tty_ldisc_ref(struct tty_struct *tty)
295{
Peter Hurley36697522013-06-15 07:04:48 -0400296 struct tty_ldisc *ld = NULL;
297
298 if (ldsem_down_read_trylock(&tty->ldisc_sem)) {
299 ld = tty->ldisc;
300 if (!ld)
301 ldsem_up_read(&tty->ldisc_sem);
302 }
303 return ld;
Alan Cox01e1abb2008-07-22 11:16:55 +0100304}
Alan Cox01e1abb2008-07-22 11:16:55 +0100305EXPORT_SYMBOL_GPL(tty_ldisc_ref);
306
307/**
308 * tty_ldisc_deref - free a tty ldisc reference
309 * @ld: reference to free up
310 *
311 * Undoes the effect of tty_ldisc_ref or tty_ldisc_ref_wait. May
312 * be called in IRQ context.
Alan Cox01e1abb2008-07-22 11:16:55 +0100313 */
314
315void tty_ldisc_deref(struct tty_ldisc *ld)
316{
Peter Hurley36697522013-06-15 07:04:48 -0400317 ldsem_up_read(&ld->tty->ldisc_sem);
Alan Cox01e1abb2008-07-22 11:16:55 +0100318}
Alan Cox01e1abb2008-07-22 11:16:55 +0100319EXPORT_SYMBOL_GPL(tty_ldisc_deref);
320
Peter Hurleyd2c43892013-06-15 07:04:47 -0400321
Peter Hurleyc2bb5242016-01-09 21:13:51 -0800322static inline int
Peter Hurleye80a10e2014-11-05 12:13:06 -0500323__tty_ldisc_lock(struct tty_struct *tty, unsigned long timeout)
Peter Hurleyd2c43892013-06-15 07:04:47 -0400324{
325 return ldsem_down_write(&tty->ldisc_sem, timeout);
326}
327
Peter Hurleyc2bb5242016-01-09 21:13:51 -0800328static inline int
Peter Hurleye80a10e2014-11-05 12:13:06 -0500329__tty_ldisc_lock_nested(struct tty_struct *tty, unsigned long timeout)
Peter Hurleyd2c43892013-06-15 07:04:47 -0400330{
331 return ldsem_down_write_nested(&tty->ldisc_sem,
332 LDISC_SEM_OTHER, timeout);
333}
334
Peter Hurleye80a10e2014-11-05 12:13:06 -0500335static inline void __tty_ldisc_unlock(struct tty_struct *tty)
Peter Hurleyd2c43892013-06-15 07:04:47 -0400336{
Guillaume Gomez52772ea2015-10-04 21:19:18 +0200337 ldsem_up_write(&tty->ldisc_sem);
Peter Hurleyd2c43892013-06-15 07:04:47 -0400338}
339
Peter Hurleyc2bb5242016-01-09 21:13:51 -0800340static int tty_ldisc_lock(struct tty_struct *tty, unsigned long timeout)
Peter Hurleyfae76e92014-11-05 12:13:07 -0500341{
342 int ret;
343
344 ret = __tty_ldisc_lock(tty, timeout);
345 if (!ret)
346 return -EBUSY;
347 set_bit(TTY_LDISC_HALTED, &tty->flags);
348 return 0;
349}
350
351static void tty_ldisc_unlock(struct tty_struct *tty)
352{
353 clear_bit(TTY_LDISC_HALTED, &tty->flags);
354 __tty_ldisc_unlock(tty);
355}
356
Peter Hurleyc2bb5242016-01-09 21:13:51 -0800357static int
Peter Hurleyd2c43892013-06-15 07:04:47 -0400358tty_ldisc_lock_pair_timeout(struct tty_struct *tty, struct tty_struct *tty2,
359 unsigned long timeout)
360{
361 int ret;
362
363 if (tty < tty2) {
Peter Hurleye80a10e2014-11-05 12:13:06 -0500364 ret = __tty_ldisc_lock(tty, timeout);
Peter Hurleyd2c43892013-06-15 07:04:47 -0400365 if (ret) {
Peter Hurleye80a10e2014-11-05 12:13:06 -0500366 ret = __tty_ldisc_lock_nested(tty2, timeout);
Peter Hurleyd2c43892013-06-15 07:04:47 -0400367 if (!ret)
Peter Hurleye80a10e2014-11-05 12:13:06 -0500368 __tty_ldisc_unlock(tty);
Peter Hurleyd2c43892013-06-15 07:04:47 -0400369 }
370 } else {
371 /* if this is possible, it has lots of implications */
372 WARN_ON_ONCE(tty == tty2);
373 if (tty2 && tty != tty2) {
Peter Hurleye80a10e2014-11-05 12:13:06 -0500374 ret = __tty_ldisc_lock(tty2, timeout);
Peter Hurleyd2c43892013-06-15 07:04:47 -0400375 if (ret) {
Peter Hurleye80a10e2014-11-05 12:13:06 -0500376 ret = __tty_ldisc_lock_nested(tty, timeout);
Peter Hurleyd2c43892013-06-15 07:04:47 -0400377 if (!ret)
Peter Hurleye80a10e2014-11-05 12:13:06 -0500378 __tty_ldisc_unlock(tty2);
Peter Hurleyd2c43892013-06-15 07:04:47 -0400379 }
380 } else
Peter Hurleye80a10e2014-11-05 12:13:06 -0500381 ret = __tty_ldisc_lock(tty, timeout);
Peter Hurleyd2c43892013-06-15 07:04:47 -0400382 }
383
384 if (!ret)
385 return -EBUSY;
386
387 set_bit(TTY_LDISC_HALTED, &tty->flags);
388 if (tty2)
389 set_bit(TTY_LDISC_HALTED, &tty2->flags);
390 return 0;
391}
392
Peter Hurleyc2bb5242016-01-09 21:13:51 -0800393static void tty_ldisc_lock_pair(struct tty_struct *tty, struct tty_struct *tty2)
Peter Hurleyd2c43892013-06-15 07:04:47 -0400394{
395 tty_ldisc_lock_pair_timeout(tty, tty2, MAX_SCHEDULE_TIMEOUT);
396}
397
Peter Hurleyc2bb5242016-01-09 21:13:51 -0800398static void tty_ldisc_unlock_pair(struct tty_struct *tty,
399 struct tty_struct *tty2)
Peter Hurleyd2c43892013-06-15 07:04:47 -0400400{
Peter Hurleye80a10e2014-11-05 12:13:06 -0500401 __tty_ldisc_unlock(tty);
Peter Hurleyd2c43892013-06-15 07:04:47 -0400402 if (tty2)
Peter Hurleye80a10e2014-11-05 12:13:06 -0500403 __tty_ldisc_unlock(tty2);
Peter Hurleyd2c43892013-06-15 07:04:47 -0400404}
405
Alan Cox01e1abb2008-07-22 11:16:55 +0100406/**
Alan Coxf2c4c652009-06-11 12:50:58 +0100407 * tty_ldisc_flush - flush line discipline queue
408 * @tty: tty
409 *
Peter Hurley86c80a82014-11-05 12:13:09 -0500410 * Flush the line discipline queue (if any) and the tty flip buffers
411 * for this tty.
Alan Coxf2c4c652009-06-11 12:50:58 +0100412 */
413
414void tty_ldisc_flush(struct tty_struct *tty)
415{
416 struct tty_ldisc *ld = tty_ldisc_ref(tty);
Peter Hurley86c80a82014-11-05 12:13:09 -0500417
418 tty_buffer_flush(tty, ld);
419 if (ld)
Alan Coxf2c4c652009-06-11 12:50:58 +0100420 tty_ldisc_deref(ld);
Alan Coxf2c4c652009-06-11 12:50:58 +0100421}
Alan Coxf2c4c652009-06-11 12:50:58 +0100422EXPORT_SYMBOL_GPL(tty_ldisc_flush);
423
424/**
Alan Cox01e1abb2008-07-22 11:16:55 +0100425 * tty_set_termios_ldisc - set ldisc field
426 * @tty: tty structure
Peter Hurleyc12da962016-01-10 22:41:04 -0800427 * @disc: line discipline number
Alan Cox01e1abb2008-07-22 11:16:55 +0100428 *
429 * This is probably overkill for real world processors but
430 * they are not on hot paths so a little discipline won't do
431 * any harm.
432 *
Peter Hurleydd42bf12015-11-27 14:30:21 -0500433 * The line discipline-related tty_struct fields are reset to
434 * prevent the ldisc driver from re-using stale information for
435 * the new ldisc instance.
436 *
Peter Hurley6a1c0682013-06-15 09:14:23 -0400437 * Locking: takes termios_rwsem
Alan Cox01e1abb2008-07-22 11:16:55 +0100438 */
439
Peter Hurleyc12da962016-01-10 22:41:04 -0800440static void tty_set_termios_ldisc(struct tty_struct *tty, int disc)
Alan Cox01e1abb2008-07-22 11:16:55 +0100441{
Peter Hurley6a1c0682013-06-15 09:14:23 -0400442 down_write(&tty->termios_rwsem);
Peter Hurleyc12da962016-01-10 22:41:04 -0800443 tty->termios.c_line = disc;
Peter Hurley6a1c0682013-06-15 09:14:23 -0400444 up_write(&tty->termios_rwsem);
Peter Hurleydd42bf12015-11-27 14:30:21 -0500445
446 tty->disc_data = NULL;
447 tty->receive_room = 0;
Alan Cox01e1abb2008-07-22 11:16:55 +0100448}
449
Alan Coxc65c9bc2009-06-11 12:50:12 +0100450/**
451 * tty_ldisc_open - open a line discipline
452 * @tty: tty we are opening the ldisc on
453 * @ld: discipline to open
454 *
455 * A helper opening method. Also a convenient debugging and check
456 * point.
Arnd Bergmannec79d602010-06-01 22:53:01 +0200457 *
458 * Locking: always called with BTM already held.
Alan Coxc65c9bc2009-06-11 12:50:12 +0100459 */
460
461static int tty_ldisc_open(struct tty_struct *tty, struct tty_ldisc *ld)
462{
463 WARN_ON(test_and_set_bit(TTY_LDISC_OPEN, &tty->flags));
Alan Coxf18f9492009-11-30 13:18:35 +0000464 if (ld->ops->open) {
465 int ret;
Arnd Bergmannec79d602010-06-01 22:53:01 +0200466 /* BTM here locks versus a hangup event */
Alan Coxf18f9492009-11-30 13:18:35 +0000467 ret = ld->ops->open(tty);
Jiri Slaby7f90cfc2010-11-25 00:27:54 +0100468 if (ret)
469 clear_bit(TTY_LDISC_OPEN, &tty->flags);
Peter Hurleyfb6edc92015-07-12 22:49:12 -0400470
Peter Hurleya570a492016-01-10 22:41:02 -0800471 tty_ldisc_debug(tty, "%p: opened\n", ld);
Alan Coxf18f9492009-11-30 13:18:35 +0000472 return ret;
473 }
Alan Coxc65c9bc2009-06-11 12:50:12 +0100474 return 0;
475}
476
477/**
478 * tty_ldisc_close - close a line discipline
479 * @tty: tty we are opening the ldisc on
480 * @ld: discipline to close
481 *
482 * A helper close method. Also a convenient debugging and check
483 * point.
484 */
485
486static void tty_ldisc_close(struct tty_struct *tty, struct tty_ldisc *ld)
487{
488 WARN_ON(!test_bit(TTY_LDISC_OPEN, &tty->flags));
489 clear_bit(TTY_LDISC_OPEN, &tty->flags);
490 if (ld->ops->close)
491 ld->ops->close(tty);
Peter Hurleya570a492016-01-10 22:41:02 -0800492 tty_ldisc_debug(tty, "%p: closed\n", ld);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100493}
Alan Cox01e1abb2008-07-22 11:16:55 +0100494
495/**
Alan Cox8a8dabf2017-06-02 13:49:30 +0100496 * tty_ldisc_failto - helper for ldisc failback
497 * @tty: tty to open the ldisc on
498 * @ld: ldisc we are trying to fail back to
499 *
500 * Helper to try and recover a tty when switching back to the old
501 * ldisc fails and we need something attached.
502 */
503
504static int tty_ldisc_failto(struct tty_struct *tty, int ld)
505{
506 struct tty_ldisc *disc = tty_ldisc_get(tty, ld);
507 int r;
508
509 if (IS_ERR(disc))
510 return PTR_ERR(disc);
511 tty->ldisc = disc;
512 tty_set_termios_ldisc(tty, ld);
513 if ((r = tty_ldisc_open(tty, disc)) < 0)
514 tty_ldisc_put(disc);
515 return r;
516}
517
518/**
Greg Kroah-Hartmana8983d02017-04-14 10:57:52 +0200519 * tty_ldisc_restore - helper for tty ldisc change
520 * @tty: tty to recover
521 * @old: previous ldisc
522 *
523 * Restore the previous line discipline or N_TTY when a line discipline
524 * change fails due to an open error
525 */
526
527static void tty_ldisc_restore(struct tty_struct *tty, struct tty_ldisc *old)
528{
Greg Kroah-Hartmana8983d02017-04-14 10:57:52 +0200529 /* There is an outstanding reference here so this is safe */
530 old = tty_ldisc_get(tty, old->ops->num);
531 WARN_ON(IS_ERR(old));
532 tty->ldisc = old;
533 tty_set_termios_ldisc(tty, old->ops->num);
534 if (tty_ldisc_open(tty, old) < 0) {
535 tty_ldisc_put(old);
Alan Cox8a8dabf2017-06-02 13:49:30 +0100536 /* 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.",
542 tty_name(tty));
Greg Kroah-Hartmana8983d02017-04-14 10:57:52 +0200543 }
544}
545
546/**
Alan Cox01e1abb2008-07-22 11:16:55 +0100547 * tty_set_ldisc - set line discipline
548 * @tty: the terminal to set
549 * @ldisc: the line discipline
550 *
551 * Set the discipline of a tty line. Must be called from a process
Alan Coxc65c9bc2009-06-11 12:50:12 +0100552 * context. The ldisc change logic has to protect itself against any
553 * overlapping ldisc change (including on the other end of pty pairs),
554 * the close of one side of a tty/pty pair, and eventually hangup.
Alan Cox01e1abb2008-07-22 11:16:55 +0100555 */
556
Peter Hurleyc12da962016-01-10 22:41:04 -0800557int tty_set_ldisc(struct tty_struct *tty, int disc)
Alan Cox01e1abb2008-07-22 11:16:55 +0100558{
Greg Kroah-Hartmana8983d02017-04-14 10:57:52 +0200559 int retval;
560 struct tty_ldisc *old_ldisc, *new_ldisc;
561
562 new_ldisc = tty_ldisc_get(tty, disc);
563 if (IS_ERR(new_ldisc))
564 return PTR_ERR(new_ldisc);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100565
Peter Hurleyc8483bc2014-11-05 12:12:45 -0500566 tty_lock(tty);
Peter Hurley276a6612014-11-05 12:13:08 -0500567 retval = tty_ldisc_lock(tty, 5 * HZ);
Peter Hurley63d8cb32015-11-08 09:29:38 -0500568 if (retval)
569 goto err;
Alan Coxc65c9bc2009-06-11 12:50:12 +0100570
Peter Hurleya570a492016-01-10 22:41:02 -0800571 if (!tty->ldisc) {
572 retval = -EIO;
573 goto out;
574 }
575
Peter Hurley63d8cb32015-11-08 09:29:38 -0500576 /* Check the no-op case */
Greg Kroah-Hartmana8983d02017-04-14 10:57:52 +0200577 if (tty->ldisc->ops->num == disc)
Peter Hurley63d8cb32015-11-08 09:29:38 -0500578 goto out;
Alan Coxc65c9bc2009-06-11 12:50:12 +0100579
Peter Hurley63d8cb32015-11-08 09:29:38 -0500580 if (test_bit(TTY_HUPPED, &tty->flags)) {
581 /* We were raced by hangup */
582 retval = -EIO;
583 goto out;
Alan Coxc65c9bc2009-06-11 12:50:12 +0100584 }
Alan Cox01e1abb2008-07-22 11:16:55 +0100585
Greg Kroah-Hartmana8983d02017-04-14 10:57:52 +0200586 old_ldisc = tty->ldisc;
587
588 /* Shutdown the old discipline. */
589 tty_ldisc_close(tty, old_ldisc);
590
591 /* Now set up the new line discipline. */
592 tty->ldisc = new_ldisc;
593 tty_set_termios_ldisc(tty, disc);
594
595 retval = tty_ldisc_open(tty, new_ldisc);
Alan Cox01e1abb2008-07-22 11:16:55 +0100596 if (retval < 0) {
Alan Coxc65c9bc2009-06-11 12:50:12 +0100597 /* Back to the old one or N_TTY if we can't */
Greg Kroah-Hartmana8983d02017-04-14 10:57:52 +0200598 tty_ldisc_put(new_ldisc);
599 tty_ldisc_restore(tty, old_ldisc);
Alan Cox01e1abb2008-07-22 11:16:55 +0100600 }
Alan Coxc65c9bc2009-06-11 12:50:12 +0100601
Greg Kroah-Hartmana8983d02017-04-14 10:57:52 +0200602 if (tty->ldisc->ops->num != old_ldisc->ops->num && tty->ops->set_ldisc) {
Peter Hurley9191aaa2014-11-05 13:11:41 -0500603 down_read(&tty->termios_rwsem);
Alan Cox01e1abb2008-07-22 11:16:55 +0100604 tty->ops->set_ldisc(tty);
Peter Hurley9191aaa2014-11-05 13:11:41 -0500605 up_read(&tty->termios_rwsem);
606 }
Alan Cox01e1abb2008-07-22 11:16:55 +0100607
Greg Kroah-Hartmana8983d02017-04-14 10:57:52 +0200608 /* At this point we hold a reference to the new ldisc and a
609 reference to the old ldisc, or we hold two references to
610 the old ldisc (if it was restored as part of error cleanup
611 above). In either case, releasing a single reference from
612 the old ldisc is correct. */
613 new_ldisc = old_ldisc;
Peter Hurley63d8cb32015-11-08 09:29:38 -0500614out:
Peter Hurley276a6612014-11-05 12:13:08 -0500615 tty_ldisc_unlock(tty);
Alan Cox01e1abb2008-07-22 11:16:55 +0100616
Alan Coxc65c9bc2009-06-11 12:50:12 +0100617 /* Restart the work queue in case no characters kick it off. Safe if
Alan Cox01e1abb2008-07-22 11:16:55 +0100618 already running */
Peter Hurley17a69212015-11-08 07:53:06 -0500619 tty_buffer_restart_work(tty->port);
Peter Hurley63d8cb32015-11-08 09:29:38 -0500620err:
Greg Kroah-Hartmana8983d02017-04-14 10:57:52 +0200621 tty_ldisc_put(new_ldisc); /* drop the extra reference */
Alan Cox89c8d912012-08-08 16:30:13 +0100622 tty_unlock(tty);
Alan Cox01e1abb2008-07-22 11:16:55 +0100623 return retval;
624}
Okash Khawaja1ab92da2017-05-15 18:45:33 +0100625EXPORT_SYMBOL_GPL(tty_set_ldisc);
Alan Cox01e1abb2008-07-22 11:16:55 +0100626
Alan Coxc65c9bc2009-06-11 12:50:12 +0100627/**
Peter Hurley6ffeb4b2016-01-10 22:41:03 -0800628 * tty_ldisc_kill - teardown ldisc
629 * @tty: tty being released
630 *
631 * Perform final close of the ldisc and reset tty->ldisc
632 */
633static void tty_ldisc_kill(struct tty_struct *tty)
634{
635 if (!tty->ldisc)
636 return;
637 /*
638 * Now kill off the ldisc
639 */
640 tty_ldisc_close(tty, tty->ldisc);
641 tty_ldisc_put(tty->ldisc);
642 /* Force an oops if we mess this up */
643 tty->ldisc = NULL;
644}
645
646/**
Alan Coxc65c9bc2009-06-11 12:50:12 +0100647 * tty_reset_termios - reset terminal state
648 * @tty: tty to reset
649 *
650 * Restore a terminal to the driver default state.
651 */
652
653static void tty_reset_termios(struct tty_struct *tty)
654{
Peter Hurley6a1c0682013-06-15 09:14:23 -0400655 down_write(&tty->termios_rwsem);
Alan Coxadc8d742012-07-14 15:31:47 +0100656 tty->termios = tty->driver->init_termios;
657 tty->termios.c_ispeed = tty_termios_input_baud_rate(&tty->termios);
658 tty->termios.c_ospeed = tty_termios_baud_rate(&tty->termios);
Peter Hurley6a1c0682013-06-15 09:14:23 -0400659 up_write(&tty->termios_rwsem);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100660}
661
662
663/**
664 * tty_ldisc_reinit - reinitialise the tty ldisc
665 * @tty: tty to reinit
Peter Hurleyc12da962016-01-10 22:41:04 -0800666 * @disc: line discipline to reinitialize
Alan Coxc65c9bc2009-06-11 12:50:12 +0100667 *
Peter Hurley7896f302016-01-10 22:41:05 -0800668 * Completely reinitialize the line discipline state, by closing the
Peter Hurley892d1fa2016-01-10 22:41:06 -0800669 * current instance, if there is one, and opening a new instance. If
670 * an error occurs opening the new non-N_TTY instance, the instance
671 * is dropped and tty->ldisc reset to NULL. The caller can then retry
672 * with N_TTY instead.
Peter Hurley7896f302016-01-10 22:41:05 -0800673 *
674 * Returns 0 if successful, otherwise error code < 0
Alan Coxc65c9bc2009-06-11 12:50:12 +0100675 */
676
Peter Hurley892d1fa2016-01-10 22:41:06 -0800677int tty_ldisc_reinit(struct tty_struct *tty, int disc)
Alan Coxc65c9bc2009-06-11 12:50:12 +0100678{
Peter Hurley7896f302016-01-10 22:41:05 -0800679 struct tty_ldisc *ld;
680 int retval;
Philippe Rétornaz1c95ba12010-10-27 17:13:21 +0200681
Peter Hurley7896f302016-01-10 22:41:05 -0800682 ld = tty_ldisc_get(tty, disc);
Greg Kroah-Hartmana8983d02017-04-14 10:57:52 +0200683 if (IS_ERR(ld)) {
684 BUG_ON(disc == N_TTY);
Peter Hurley7896f302016-01-10 22:41:05 -0800685 return PTR_ERR(ld);
Greg Kroah-Hartmana8983d02017-04-14 10:57:52 +0200686 }
Alan Coxc65c9bc2009-06-11 12:50:12 +0100687
Peter Hurley7896f302016-01-10 22:41:05 -0800688 if (tty->ldisc) {
689 tty_ldisc_close(tty, tty->ldisc);
690 tty_ldisc_put(tty->ldisc);
691 }
692
693 /* switch the line discipline */
Peter Hurleyf48070452013-03-11 16:44:42 -0400694 tty->ldisc = ld;
Peter Hurleyc12da962016-01-10 22:41:04 -0800695 tty_set_termios_ldisc(tty, disc);
Peter Hurley7896f302016-01-10 22:41:05 -0800696 retval = tty_ldisc_open(tty, tty->ldisc);
697 if (retval) {
Greg Kroah-Hartmana8983d02017-04-14 10:57:52 +0200698 if (!WARN_ON(disc == N_TTY)) {
699 tty_ldisc_put(tty->ldisc);
700 tty->ldisc = NULL;
701 }
Peter Hurley7896f302016-01-10 22:41:05 -0800702 }
703 return retval;
Alan Coxc65c9bc2009-06-11 12:50:12 +0100704}
705
706/**
707 * tty_ldisc_hangup - hangup ldisc reset
708 * @tty: tty being hung up
709 *
710 * Some tty devices reset their termios when they receive a hangup
711 * event. In that situation we must also switch back to N_TTY properly
712 * before we reset the termios data.
713 *
714 * Locking: We can take the ldisc mutex as the rest of the code is
715 * careful to allow for this.
716 *
717 * In the pty pair case this occurs in the close() path of the
718 * tty itself so we must be careful about locking rules.
719 */
720
Peter Hurley892d1fa2016-01-10 22:41:06 -0800721void tty_ldisc_hangup(struct tty_struct *tty, bool reinit)
Alan Coxc65c9bc2009-06-11 12:50:12 +0100722{
723 struct tty_ldisc *ld;
724
Peter Hurleya570a492016-01-10 22:41:02 -0800725 tty_ldisc_debug(tty, "%p: hangup\n", tty->ldisc);
Peter Hurleyfc575ee2013-03-11 16:44:38 -0400726
Alan Coxc65c9bc2009-06-11 12:50:12 +0100727 ld = tty_ldisc_ref(tty);
728 if (ld != NULL) {
Alan Coxc65c9bc2009-06-11 12:50:12 +0100729 if (ld->ops->flush_buffer)
730 ld->ops->flush_buffer(tty);
731 tty_driver_flush_buffer(tty);
732 if ((test_bit(TTY_DO_WRITE_WAKEUP, &tty->flags)) &&
733 ld->ops->write_wakeup)
734 ld->ops->write_wakeup(tty);
735 if (ld->ops->hangup)
736 ld->ops->hangup(tty);
737 tty_ldisc_deref(ld);
738 }
Peter Hurley36697522013-06-15 07:04:48 -0400739
Alan Coxc65c9bc2009-06-11 12:50:12 +0100740 wake_up_interruptible_poll(&tty->write_wait, POLLOUT);
741 wake_up_interruptible_poll(&tty->read_wait, POLLIN);
Peter Hurley36697522013-06-15 07:04:48 -0400742
Alan Coxc65c9bc2009-06-11 12:50:12 +0100743 /*
744 * Shutdown the current line discipline, and reset it to
Alan Cox638b9642010-02-08 10:09:26 +0000745 * N_TTY if need be.
746 *
747 * Avoid racing set_ldisc or tty_ldisc_release
Alan Coxc65c9bc2009-06-11 12:50:12 +0100748 */
Peter Hurleyfae76e92014-11-05 12:13:07 -0500749 tty_ldisc_lock(tty, MAX_SCHEDULE_TIMEOUT);
Arnd Bergmann60af22d2010-06-01 22:53:06 +0200750
Peter Hurley892d1fa2016-01-10 22:41:06 -0800751 if (tty->driver->flags & TTY_DRIVER_RESET_TERMIOS)
Alan Cox638b9642010-02-08 10:09:26 +0000752 tty_reset_termios(tty);
Peter Hurleyfc575ee2013-03-11 16:44:38 -0400753
Peter Hurley892d1fa2016-01-10 22:41:06 -0800754 if (tty->ldisc) {
755 if (reinit) {
756 if (tty_ldisc_reinit(tty, tty->termios.c_line) < 0)
757 tty_ldisc_reinit(tty, N_TTY);
758 } else
759 tty_ldisc_kill(tty);
760 }
761 tty_ldisc_unlock(tty);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100762}
Alan Cox01e1abb2008-07-22 11:16:55 +0100763
764/**
765 * tty_ldisc_setup - open line discipline
766 * @tty: tty being shut down
767 * @o_tty: pair tty for pty/tty pairs
768 *
769 * Called during the initial open of a tty/pty pair in order to set up the
Alan Coxc65c9bc2009-06-11 12:50:12 +0100770 * line disciplines and bind them to the tty. This has no locking issues
771 * as the device isn't yet active.
Alan Cox01e1abb2008-07-22 11:16:55 +0100772 */
773
774int tty_ldisc_setup(struct tty_struct *tty, struct tty_struct *o_tty)
775{
Peter Hurley9de2a7c2016-01-10 22:41:08 -0800776 int retval = tty_ldisc_open(tty, tty->ldisc);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100777 if (retval)
778 return retval;
779
780 if (o_tty) {
781 retval = tty_ldisc_open(o_tty, o_tty->ldisc);
Alan Cox01e1abb2008-07-22 11:16:55 +0100782 if (retval) {
Peter Hurley9de2a7c2016-01-10 22:41:08 -0800783 tty_ldisc_close(tty, tty->ldisc);
Alan Cox01e1abb2008-07-22 11:16:55 +0100784 return retval;
785 }
Alan Cox01e1abb2008-07-22 11:16:55 +0100786 }
Alan Cox01e1abb2008-07-22 11:16:55 +0100787 return 0;
788}
Alan Cox89c8d912012-08-08 16:30:13 +0100789
Alan Cox01e1abb2008-07-22 11:16:55 +0100790/**
791 * tty_ldisc_release - release line discipline
Peter Hurley62462ae2014-11-05 12:12:58 -0500792 * @tty: tty being shut down (or one end of pty pair)
Alan Cox01e1abb2008-07-22 11:16:55 +0100793 *
Peter Hurley62462ae2014-11-05 12:12:58 -0500794 * Called during the final close of a tty or a pty pair in order to shut
Peter Hurley5b6e6832016-01-10 22:41:00 -0800795 * down the line discpline layer. On exit, each tty's ldisc is NULL.
Alan Cox01e1abb2008-07-22 11:16:55 +0100796 */
797
Peter Hurley62462ae2014-11-05 12:12:58 -0500798void tty_ldisc_release(struct tty_struct *tty)
Alan Cox01e1abb2008-07-22 11:16:55 +0100799{
Peter Hurley62462ae2014-11-05 12:12:58 -0500800 struct tty_struct *o_tty = tty->link;
801
Alan Cox01e1abb2008-07-22 11:16:55 +0100802 /*
Peter Hurleya2965b72013-03-11 16:44:35 -0400803 * Shutdown this line discipline. As this is the final close,
804 * it does not race with the set_ldisc code path.
Alan Cox01e1abb2008-07-22 11:16:55 +0100805 */
Alan Cox01e1abb2008-07-22 11:16:55 +0100806
Peter Hurley36697522013-06-15 07:04:48 -0400807 tty_ldisc_lock_pair(tty, o_tty);
Alan Cox89c8d912012-08-08 16:30:13 +0100808 tty_ldisc_kill(tty);
Alan Cox89c8d912012-08-08 16:30:13 +0100809 if (o_tty)
810 tty_ldisc_kill(o_tty);
Peter Hurley36697522013-06-15 07:04:48 -0400811 tty_ldisc_unlock_pair(tty, o_tty);
812
Alan Coxaef29bc2009-06-29 15:21:47 +0100813 /* And the memory resources remaining (buffers, termios) will be
814 disposed of when the kref hits zero */
Peter Hurleyfc575ee2013-03-11 16:44:38 -0400815
Peter Hurleyfb6edc92015-07-12 22:49:12 -0400816 tty_ldisc_debug(tty, "released\n");
Alan Cox01e1abb2008-07-22 11:16:55 +0100817}
Okash Khawaja1ab92da2017-05-15 18:45:33 +0100818EXPORT_SYMBOL_GPL(tty_ldisc_release);
Alan Cox01e1abb2008-07-22 11:16:55 +0100819
820/**
821 * tty_ldisc_init - ldisc setup for new tty
822 * @tty: tty being allocated
823 *
824 * Set up the line discipline objects for a newly allocated tty. Note that
825 * the tty structure is not completely set up when this call is made.
826 */
827
828void tty_ldisc_init(struct tty_struct *tty)
829{
Peter Hurley36697522013-06-15 07:04:48 -0400830 struct tty_ldisc *ld = tty_ldisc_get(tty, N_TTY);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100831 if (IS_ERR(ld))
Alan Cox01e1abb2008-07-22 11:16:55 +0100832 panic("n_tty: init_tty");
Peter Hurleyf48070452013-03-11 16:44:42 -0400833 tty->ldisc = ld;
Alan Cox01e1abb2008-07-22 11:16:55 +0100834}
835
Jiri Slaby67166712011-03-23 10:48:35 +0100836/**
Peter Hurleyc8b710b2016-01-09 21:13:46 -0800837 * tty_ldisc_deinit - ldisc cleanup for new tty
Jiri Slaby67166712011-03-23 10:48:35 +0100838 * @tty: tty that was allocated recently
839 *
840 * The tty structure must not becompletely set up (tty_ldisc_setup) when
841 * this call is made.
842 */
843void tty_ldisc_deinit(struct tty_struct *tty)
844{
Peter Hurleyc8b710b2016-01-09 21:13:46 -0800845 if (tty->ldisc)
846 tty_ldisc_put(tty->ldisc);
Peter Hurleyf48070452013-03-11 16:44:42 -0400847 tty->ldisc = NULL;
Jiri Slaby67166712011-03-23 10:48:35 +0100848}