blob: fb7329ab2b37a85f0682805d2fe996f6279df64b [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
Tetsuo Handabcdd0ca2018-04-25 20:12:31 +0900179 /*
180 * There is no way to handle allocation failure of only 16 bytes.
181 * Let's simplify error handling and save more memory.
182 */
183 ld = kmalloc(sizeof(struct tty_ldisc), GFP_KERNEL | __GFP_NOFAIL);
Linus Torvalds182274f2009-08-03 16:01:28 -0700184 ld->ops = ldops;
Peter Hurley36697522013-06-15 07:04:48 -0400185 ld->tty = tty;
Ivo Sieben1541f842012-05-03 14:37:43 +0200186
Alan Coxc65c9bc2009-06-11 12:50:12 +0100187 return ld;
Alan Cox01e1abb2008-07-22 11:16:55 +0100188}
189
Peter Hurley734de242013-03-11 16:44:43 -0400190/**
191 * tty_ldisc_put - release the ldisc
192 *
193 * Complement of tty_ldisc_get().
194 */
Denys Vlasenkocb128f62015-10-27 17:40:02 +0100195static void tty_ldisc_put(struct tty_ldisc *ld)
Peter Hurley734de242013-03-11 16:44:43 -0400196{
Peter Hurley734de242013-03-11 16:44:43 -0400197 if (WARN_ON_ONCE(!ld))
198 return;
199
Peter Hurley36697522013-06-15 07:04:48 -0400200 put_ldops(ld->ops);
Peter Hurley734de242013-03-11 16:44:43 -0400201 kfree(ld);
Peter Hurley734de242013-03-11 16:44:43 -0400202}
203
Alan Cox852e99d2009-06-11 12:51:41 +0100204static void *tty_ldiscs_seq_start(struct seq_file *m, loff_t *pos)
Alan Cox01e1abb2008-07-22 11:16:55 +0100205{
206 return (*pos < NR_LDISCS) ? pos : NULL;
207}
208
Alan Cox852e99d2009-06-11 12:51:41 +0100209static void *tty_ldiscs_seq_next(struct seq_file *m, void *v, loff_t *pos)
Alan Cox01e1abb2008-07-22 11:16:55 +0100210{
211 (*pos)++;
212 return (*pos < NR_LDISCS) ? pos : NULL;
213}
214
215static void tty_ldiscs_seq_stop(struct seq_file *m, void *v)
216{
217}
218
219static int tty_ldiscs_seq_show(struct seq_file *m, void *v)
220{
221 int i = *(loff_t *)v;
Linus Torvaldsf0de0e82009-08-03 16:00:15 -0700222 struct tty_ldisc_ops *ldops;
Alan Cox852e99d2009-06-11 12:51:41 +0100223
Linus Torvaldsf0de0e82009-08-03 16:00:15 -0700224 ldops = get_ldops(i);
225 if (IS_ERR(ldops))
Alan Cox01e1abb2008-07-22 11:16:55 +0100226 return 0;
Linus Torvaldsf0de0e82009-08-03 16:00:15 -0700227 seq_printf(m, "%-10s %2d\n", ldops->name ? ldops->name : "???", i);
228 put_ldops(ldops);
Alan Cox01e1abb2008-07-22 11:16:55 +0100229 return 0;
230}
231
232static 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,
237};
238
239static int proc_tty_ldiscs_open(struct inode *inode, struct file *file)
240{
241 return seq_open(file, &tty_ldiscs_seq_ops);
242}
243
244const struct file_operations tty_ldiscs_proc_fops = {
245 .owner = THIS_MODULE,
246 .open = proc_tty_ldiscs_open,
247 .read = seq_read,
248 .llseek = seq_lseek,
249 .release = seq_release,
250};
251
252/**
Alan Cox01e1abb2008-07-22 11:16:55 +0100253 * tty_ldisc_ref_wait - wait for the tty ldisc
254 * @tty: tty device
255 *
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.
259 *
Peter Hurley892d1fa2016-01-10 22:41:06 -0800260 * Returns: NULL if the tty has been hungup and not re-opened with
261 * a new file descriptor, otherwise valid ldisc reference
262 *
Alan Cox01e1abb2008-07-22 11:16:55 +0100263 * 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)
267 *
Peter Hurleye55afd12016-01-10 22:41:01 -0800268 * Note: a file_operations routine (read/poll/write) should use this
269 * function to wait for any ldisc lifetime events to finish.
Alan Cox01e1abb2008-07-22 11:16:55 +0100270 */
271
272struct tty_ldisc *tty_ldisc_ref_wait(struct tty_struct *tty)
273{
Dmitry Vyukova4a3e062017-03-04 13:46:12 +0100274 struct tty_ldisc *ld;
275
Peter Hurley36697522013-06-15 07:04:48 -0400276 ldsem_down_read(&tty->ldisc_sem, MAX_SCHEDULE_TIMEOUT);
Dmitry Vyukova4a3e062017-03-04 13:46:12 +0100277 ld = tty->ldisc;
278 if (!ld)
Peter Hurleya570a492016-01-10 22:41:02 -0800279 ldsem_up_read(&tty->ldisc_sem);
Dmitry Vyukova4a3e062017-03-04 13:46:12 +0100280 return ld;
Alan Cox01e1abb2008-07-22 11:16:55 +0100281}
Alan Cox01e1abb2008-07-22 11:16:55 +0100282EXPORT_SYMBOL_GPL(tty_ldisc_ref_wait);
283
284/**
285 * tty_ldisc_ref - get the tty ldisc
286 * @tty: tty device
287 *
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.
Alan Cox01e1abb2008-07-22 11:16:55 +0100291 */
292
293struct tty_ldisc *tty_ldisc_ref(struct tty_struct *tty)
294{
Peter Hurley36697522013-06-15 07:04:48 -0400295 struct tty_ldisc *ld = NULL;
296
297 if (ldsem_down_read_trylock(&tty->ldisc_sem)) {
298 ld = tty->ldisc;
299 if (!ld)
300 ldsem_up_read(&tty->ldisc_sem);
301 }
302 return ld;
Alan Cox01e1abb2008-07-22 11:16:55 +0100303}
Alan Cox01e1abb2008-07-22 11:16:55 +0100304EXPORT_SYMBOL_GPL(tty_ldisc_ref);
305
306/**
307 * tty_ldisc_deref - free a tty ldisc reference
308 * @ld: reference to free up
309 *
310 * Undoes the effect of tty_ldisc_ref or tty_ldisc_ref_wait. May
311 * be called in IRQ context.
Alan Cox01e1abb2008-07-22 11:16:55 +0100312 */
313
314void tty_ldisc_deref(struct tty_ldisc *ld)
315{
Peter Hurley36697522013-06-15 07:04:48 -0400316 ldsem_up_read(&ld->tty->ldisc_sem);
Alan Cox01e1abb2008-07-22 11:16:55 +0100317}
Alan Cox01e1abb2008-07-22 11:16:55 +0100318EXPORT_SYMBOL_GPL(tty_ldisc_deref);
319
Peter Hurleyd2c43892013-06-15 07:04:47 -0400320
Peter Hurleyc2bb5242016-01-09 21:13:51 -0800321static inline int
Peter Hurleye80a10e2014-11-05 12:13:06 -0500322__tty_ldisc_lock(struct tty_struct *tty, unsigned long timeout)
Peter Hurleyd2c43892013-06-15 07:04:47 -0400323{
324 return ldsem_down_write(&tty->ldisc_sem, timeout);
325}
326
Peter Hurleyc2bb5242016-01-09 21:13:51 -0800327static inline int
Peter Hurleye80a10e2014-11-05 12:13:06 -0500328__tty_ldisc_lock_nested(struct tty_struct *tty, unsigned long timeout)
Peter Hurleyd2c43892013-06-15 07:04:47 -0400329{
330 return ldsem_down_write_nested(&tty->ldisc_sem,
331 LDISC_SEM_OTHER, timeout);
332}
333
Peter Hurleye80a10e2014-11-05 12:13:06 -0500334static inline void __tty_ldisc_unlock(struct tty_struct *tty)
Peter Hurleyd2c43892013-06-15 07:04:47 -0400335{
Guillaume Gomez52772ea2015-10-04 21:19:18 +0200336 ldsem_up_write(&tty->ldisc_sem);
Peter Hurleyd2c43892013-06-15 07:04:47 -0400337}
338
Gaurav Kohlib027e222018-01-23 13:16:34 +0530339int tty_ldisc_lock(struct tty_struct *tty, unsigned long timeout)
Peter Hurleyfae76e92014-11-05 12:13:07 -0500340{
341 int ret;
342
343 ret = __tty_ldisc_lock(tty, timeout);
344 if (!ret)
345 return -EBUSY;
346 set_bit(TTY_LDISC_HALTED, &tty->flags);
347 return 0;
348}
349
Gaurav Kohlib027e222018-01-23 13:16:34 +0530350void tty_ldisc_unlock(struct tty_struct *tty)
Peter Hurleyfae76e92014-11-05 12:13:07 -0500351{
352 clear_bit(TTY_LDISC_HALTED, &tty->flags);
353 __tty_ldisc_unlock(tty);
354}
355
Peter Hurleyc2bb5242016-01-09 21:13:51 -0800356static int
Peter Hurleyd2c43892013-06-15 07:04:47 -0400357tty_ldisc_lock_pair_timeout(struct tty_struct *tty, struct tty_struct *tty2,
358 unsigned long timeout)
359{
360 int ret;
361
362 if (tty < tty2) {
Peter Hurleye80a10e2014-11-05 12:13:06 -0500363 ret = __tty_ldisc_lock(tty, timeout);
Peter Hurleyd2c43892013-06-15 07:04:47 -0400364 if (ret) {
Peter Hurleye80a10e2014-11-05 12:13:06 -0500365 ret = __tty_ldisc_lock_nested(tty2, timeout);
Peter Hurleyd2c43892013-06-15 07:04:47 -0400366 if (!ret)
Peter Hurleye80a10e2014-11-05 12:13:06 -0500367 __tty_ldisc_unlock(tty);
Peter Hurleyd2c43892013-06-15 07:04:47 -0400368 }
369 } else {
370 /* if this is possible, it has lots of implications */
371 WARN_ON_ONCE(tty == tty2);
372 if (tty2 && tty != tty2) {
Peter Hurleye80a10e2014-11-05 12:13:06 -0500373 ret = __tty_ldisc_lock(tty2, timeout);
Peter Hurleyd2c43892013-06-15 07:04:47 -0400374 if (ret) {
Peter Hurleye80a10e2014-11-05 12:13:06 -0500375 ret = __tty_ldisc_lock_nested(tty, timeout);
Peter Hurleyd2c43892013-06-15 07:04:47 -0400376 if (!ret)
Peter Hurleye80a10e2014-11-05 12:13:06 -0500377 __tty_ldisc_unlock(tty2);
Peter Hurleyd2c43892013-06-15 07:04:47 -0400378 }
379 } else
Peter Hurleye80a10e2014-11-05 12:13:06 -0500380 ret = __tty_ldisc_lock(tty, timeout);
Peter Hurleyd2c43892013-06-15 07:04:47 -0400381 }
382
383 if (!ret)
384 return -EBUSY;
385
386 set_bit(TTY_LDISC_HALTED, &tty->flags);
387 if (tty2)
388 set_bit(TTY_LDISC_HALTED, &tty2->flags);
389 return 0;
390}
391
Peter Hurleyc2bb5242016-01-09 21:13:51 -0800392static void tty_ldisc_lock_pair(struct tty_struct *tty, struct tty_struct *tty2)
Peter Hurleyd2c43892013-06-15 07:04:47 -0400393{
394 tty_ldisc_lock_pair_timeout(tty, tty2, MAX_SCHEDULE_TIMEOUT);
395}
396
Peter Hurleyc2bb5242016-01-09 21:13:51 -0800397static void tty_ldisc_unlock_pair(struct tty_struct *tty,
398 struct tty_struct *tty2)
Peter Hurleyd2c43892013-06-15 07:04:47 -0400399{
Peter Hurleye80a10e2014-11-05 12:13:06 -0500400 __tty_ldisc_unlock(tty);
Peter Hurleyd2c43892013-06-15 07:04:47 -0400401 if (tty2)
Peter Hurleye80a10e2014-11-05 12:13:06 -0500402 __tty_ldisc_unlock(tty2);
Peter Hurleyd2c43892013-06-15 07:04:47 -0400403}
404
Alan Cox01e1abb2008-07-22 11:16:55 +0100405/**
Alan Coxf2c4c652009-06-11 12:50:58 +0100406 * tty_ldisc_flush - flush line discipline queue
407 * @tty: tty
408 *
Peter Hurley86c80a82014-11-05 12:13:09 -0500409 * Flush the line discipline queue (if any) and the tty flip buffers
410 * for this tty.
Alan Coxf2c4c652009-06-11 12:50:58 +0100411 */
412
413void tty_ldisc_flush(struct tty_struct *tty)
414{
415 struct tty_ldisc *ld = tty_ldisc_ref(tty);
Peter Hurley86c80a82014-11-05 12:13:09 -0500416
417 tty_buffer_flush(tty, ld);
418 if (ld)
Alan Coxf2c4c652009-06-11 12:50:58 +0100419 tty_ldisc_deref(ld);
Alan Coxf2c4c652009-06-11 12:50:58 +0100420}
Alan Coxf2c4c652009-06-11 12:50:58 +0100421EXPORT_SYMBOL_GPL(tty_ldisc_flush);
422
423/**
Alan Cox01e1abb2008-07-22 11:16:55 +0100424 * tty_set_termios_ldisc - set ldisc field
425 * @tty: tty structure
Peter Hurleyc12da962016-01-10 22:41:04 -0800426 * @disc: line discipline number
Alan Cox01e1abb2008-07-22 11:16:55 +0100427 *
428 * This is probably overkill for real world processors but
429 * they are not on hot paths so a little discipline won't do
430 * any harm.
431 *
Peter Hurleydd42bf12015-11-27 14:30:21 -0500432 * 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.
435 *
Peter Hurley6a1c0682013-06-15 09:14:23 -0400436 * Locking: takes termios_rwsem
Alan Cox01e1abb2008-07-22 11:16:55 +0100437 */
438
Peter Hurleyc12da962016-01-10 22:41:04 -0800439static void tty_set_termios_ldisc(struct tty_struct *tty, int disc)
Alan Cox01e1abb2008-07-22 11:16:55 +0100440{
Peter Hurley6a1c0682013-06-15 09:14:23 -0400441 down_write(&tty->termios_rwsem);
Peter Hurleyc12da962016-01-10 22:41:04 -0800442 tty->termios.c_line = disc;
Peter Hurley6a1c0682013-06-15 09:14:23 -0400443 up_write(&tty->termios_rwsem);
Peter Hurleydd42bf12015-11-27 14:30:21 -0500444
445 tty->disc_data = NULL;
446 tty->receive_room = 0;
Alan Cox01e1abb2008-07-22 11:16:55 +0100447}
448
Alan Coxc65c9bc2009-06-11 12:50:12 +0100449/**
450 * tty_ldisc_open - open a line discipline
451 * @tty: tty we are opening the ldisc on
452 * @ld: discipline to open
453 *
454 * A helper opening method. Also a convenient debugging and check
455 * point.
Arnd Bergmannec79d602010-06-01 22:53:01 +0200456 *
457 * Locking: always called with BTM already held.
Alan Coxc65c9bc2009-06-11 12:50:12 +0100458 */
459
460static int tty_ldisc_open(struct tty_struct *tty, struct tty_ldisc *ld)
461{
462 WARN_ON(test_and_set_bit(TTY_LDISC_OPEN, &tty->flags));
Alan Coxf18f9492009-11-30 13:18:35 +0000463 if (ld->ops->open) {
464 int ret;
Arnd Bergmannec79d602010-06-01 22:53:01 +0200465 /* BTM here locks versus a hangup event */
Alan Coxf18f9492009-11-30 13:18:35 +0000466 ret = ld->ops->open(tty);
Jiri Slaby7f90cfc2010-11-25 00:27:54 +0100467 if (ret)
468 clear_bit(TTY_LDISC_OPEN, &tty->flags);
Peter Hurleyfb6edc92015-07-12 22:49:12 -0400469
Peter Hurleya570a492016-01-10 22:41:02 -0800470 tty_ldisc_debug(tty, "%p: opened\n", ld);
Alan Coxf18f9492009-11-30 13:18:35 +0000471 return ret;
472 }
Alan Coxc65c9bc2009-06-11 12:50:12 +0100473 return 0;
474}
475
476/**
477 * tty_ldisc_close - close a line discipline
478 * @tty: tty we are opening the ldisc on
479 * @ld: discipline to close
480 *
481 * A helper close method. Also a convenient debugging and check
482 * point.
483 */
484
485static void tty_ldisc_close(struct tty_struct *tty, struct tty_ldisc *ld)
486{
487 WARN_ON(!test_bit(TTY_LDISC_OPEN, &tty->flags));
488 clear_bit(TTY_LDISC_OPEN, &tty->flags);
489 if (ld->ops->close)
490 ld->ops->close(tty);
Peter Hurleya570a492016-01-10 22:41:02 -0800491 tty_ldisc_debug(tty, "%p: closed\n", ld);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100492}
Alan Cox01e1abb2008-07-22 11:16:55 +0100493
494/**
Alan Cox8a8dabf2017-06-02 13:49:30 +0100495 * 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
498 *
499 * Helper to try and recover a tty when switching back to the old
500 * ldisc fails and we need something attached.
501 */
502
503static int tty_ldisc_failto(struct tty_struct *tty, int ld)
504{
505 struct tty_ldisc *disc = tty_ldisc_get(tty, ld);
506 int r;
507
508 if (IS_ERR(disc))
509 return PTR_ERR(disc);
510 tty->ldisc = disc;
511 tty_set_termios_ldisc(tty, ld);
512 if ((r = tty_ldisc_open(tty, disc)) < 0)
513 tty_ldisc_put(disc);
514 return r;
515}
516
517/**
Greg Kroah-Hartmana8983d02017-04-14 10:57:52 +0200518 * tty_ldisc_restore - helper for tty ldisc change
519 * @tty: tty to recover
520 * @old: previous ldisc
521 *
522 * Restore the previous line discipline or N_TTY when a line discipline
523 * change fails due to an open error
524 */
525
526static void tty_ldisc_restore(struct tty_struct *tty, struct tty_ldisc *old)
527{
Greg Kroah-Hartmana8983d02017-04-14 10:57:52 +0200528 /* There is an outstanding reference here so this is safe */
Tetsuo Handa598c2d42018-04-16 20:06:34 +0900529 if (tty_ldisc_failto(tty, old->ops->num) < 0) {
530 const char *name = tty_name(tty);
531
532 pr_warn("Falling back ldisc for %s.\n", name);
Alan Cox8a8dabf2017-06-02 13:49:30 +0100533 /* 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)
Tetsuo Handa598c2d42018-04-16 20:06:34 +0900538 panic("Couldn't open N_NULL ldisc for %s.", name);
Greg Kroah-Hartmana8983d02017-04-14 10:57:52 +0200539 }
540}
541
542/**
Alan Cox01e1abb2008-07-22 11:16:55 +0100543 * tty_set_ldisc - set line discipline
544 * @tty: the terminal to set
545 * @ldisc: the line discipline
546 *
547 * Set the discipline of a tty line. Must be called from a process
Alan Coxc65c9bc2009-06-11 12:50:12 +0100548 * 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.
Alan Cox01e1abb2008-07-22 11:16:55 +0100551 */
552
Peter Hurleyc12da962016-01-10 22:41:04 -0800553int tty_set_ldisc(struct tty_struct *tty, int disc)
Alan Cox01e1abb2008-07-22 11:16:55 +0100554{
Greg Kroah-Hartmana8983d02017-04-14 10:57:52 +0200555 int retval;
556 struct tty_ldisc *old_ldisc, *new_ldisc;
557
558 new_ldisc = tty_ldisc_get(tty, disc);
559 if (IS_ERR(new_ldisc))
560 return PTR_ERR(new_ldisc);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100561
Peter Hurleyc8483bc2014-11-05 12:12:45 -0500562 tty_lock(tty);
Peter Hurley276a6612014-11-05 12:13:08 -0500563 retval = tty_ldisc_lock(tty, 5 * HZ);
Peter Hurley63d8cb32015-11-08 09:29:38 -0500564 if (retval)
565 goto err;
Alan Coxc65c9bc2009-06-11 12:50:12 +0100566
Peter Hurleya570a492016-01-10 22:41:02 -0800567 if (!tty->ldisc) {
568 retval = -EIO;
569 goto out;
570 }
571
Peter Hurley63d8cb32015-11-08 09:29:38 -0500572 /* Check the no-op case */
Greg Kroah-Hartmana8983d02017-04-14 10:57:52 +0200573 if (tty->ldisc->ops->num == disc)
Peter Hurley63d8cb32015-11-08 09:29:38 -0500574 goto out;
Alan Coxc65c9bc2009-06-11 12:50:12 +0100575
Peter Hurley63d8cb32015-11-08 09:29:38 -0500576 if (test_bit(TTY_HUPPED, &tty->flags)) {
577 /* We were raced by hangup */
578 retval = -EIO;
579 goto out;
Alan Coxc65c9bc2009-06-11 12:50:12 +0100580 }
Alan Cox01e1abb2008-07-22 11:16:55 +0100581
Greg Kroah-Hartmana8983d02017-04-14 10:57:52 +0200582 old_ldisc = tty->ldisc;
583
584 /* Shutdown the old discipline. */
585 tty_ldisc_close(tty, old_ldisc);
586
587 /* Now set up the new line discipline. */
588 tty->ldisc = new_ldisc;
589 tty_set_termios_ldisc(tty, disc);
590
591 retval = tty_ldisc_open(tty, new_ldisc);
Alan Cox01e1abb2008-07-22 11:16:55 +0100592 if (retval < 0) {
Alan Coxc65c9bc2009-06-11 12:50:12 +0100593 /* Back to the old one or N_TTY if we can't */
Greg Kroah-Hartmana8983d02017-04-14 10:57:52 +0200594 tty_ldisc_put(new_ldisc);
595 tty_ldisc_restore(tty, old_ldisc);
Alan Cox01e1abb2008-07-22 11:16:55 +0100596 }
Alan Coxc65c9bc2009-06-11 12:50:12 +0100597
Greg Kroah-Hartmana8983d02017-04-14 10:57:52 +0200598 if (tty->ldisc->ops->num != old_ldisc->ops->num && tty->ops->set_ldisc) {
Peter Hurley9191aaa2014-11-05 13:11:41 -0500599 down_read(&tty->termios_rwsem);
Alan Cox01e1abb2008-07-22 11:16:55 +0100600 tty->ops->set_ldisc(tty);
Peter Hurley9191aaa2014-11-05 13:11:41 -0500601 up_read(&tty->termios_rwsem);
602 }
Alan Cox01e1abb2008-07-22 11:16:55 +0100603
Greg Kroah-Hartmana8983d02017-04-14 10:57:52 +0200604 /* 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;
Peter Hurley63d8cb32015-11-08 09:29:38 -0500610out:
Peter Hurley276a6612014-11-05 12:13:08 -0500611 tty_ldisc_unlock(tty);
Alan Cox01e1abb2008-07-22 11:16:55 +0100612
Alan Coxc65c9bc2009-06-11 12:50:12 +0100613 /* Restart the work queue in case no characters kick it off. Safe if
Alan Cox01e1abb2008-07-22 11:16:55 +0100614 already running */
Peter Hurley17a69212015-11-08 07:53:06 -0500615 tty_buffer_restart_work(tty->port);
Peter Hurley63d8cb32015-11-08 09:29:38 -0500616err:
Greg Kroah-Hartmana8983d02017-04-14 10:57:52 +0200617 tty_ldisc_put(new_ldisc); /* drop the extra reference */
Alan Cox89c8d912012-08-08 16:30:13 +0100618 tty_unlock(tty);
Alan Cox01e1abb2008-07-22 11:16:55 +0100619 return retval;
620}
Okash Khawaja1ab92da2017-05-15 18:45:33 +0100621EXPORT_SYMBOL_GPL(tty_set_ldisc);
Alan Cox01e1abb2008-07-22 11:16:55 +0100622
Alan Coxc65c9bc2009-06-11 12:50:12 +0100623/**
Peter Hurley6ffeb4b2016-01-10 22:41:03 -0800624 * tty_ldisc_kill - teardown ldisc
625 * @tty: tty being released
626 *
627 * Perform final close of the ldisc and reset tty->ldisc
628 */
629static void tty_ldisc_kill(struct tty_struct *tty)
630{
631 if (!tty->ldisc)
632 return;
633 /*
634 * Now kill off the ldisc
635 */
636 tty_ldisc_close(tty, tty->ldisc);
637 tty_ldisc_put(tty->ldisc);
638 /* Force an oops if we mess this up */
639 tty->ldisc = NULL;
640}
641
642/**
Alan Coxc65c9bc2009-06-11 12:50:12 +0100643 * tty_reset_termios - reset terminal state
644 * @tty: tty to reset
645 *
646 * Restore a terminal to the driver default state.
647 */
648
649static void tty_reset_termios(struct tty_struct *tty)
650{
Peter Hurley6a1c0682013-06-15 09:14:23 -0400651 down_write(&tty->termios_rwsem);
Alan Coxadc8d742012-07-14 15:31:47 +0100652 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);
Peter Hurley6a1c0682013-06-15 09:14:23 -0400655 up_write(&tty->termios_rwsem);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100656}
657
658
659/**
660 * tty_ldisc_reinit - reinitialise the tty ldisc
661 * @tty: tty to reinit
Peter Hurleyc12da962016-01-10 22:41:04 -0800662 * @disc: line discipline to reinitialize
Alan Coxc65c9bc2009-06-11 12:50:12 +0100663 *
Peter Hurley7896f302016-01-10 22:41:05 -0800664 * Completely reinitialize the line discipline state, by closing the
Peter Hurley892d1fa2016-01-10 22:41:06 -0800665 * 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.
Peter Hurley7896f302016-01-10 22:41:05 -0800669 *
670 * Returns 0 if successful, otherwise error code < 0
Alan Coxc65c9bc2009-06-11 12:50:12 +0100671 */
672
Peter Hurley892d1fa2016-01-10 22:41:06 -0800673int tty_ldisc_reinit(struct tty_struct *tty, int disc)
Alan Coxc65c9bc2009-06-11 12:50:12 +0100674{
Peter Hurley7896f302016-01-10 22:41:05 -0800675 struct tty_ldisc *ld;
676 int retval;
Philippe Rétornaz1c95ba12010-10-27 17:13:21 +0200677
Peter Hurley7896f302016-01-10 22:41:05 -0800678 ld = tty_ldisc_get(tty, disc);
Greg Kroah-Hartmana8983d02017-04-14 10:57:52 +0200679 if (IS_ERR(ld)) {
680 BUG_ON(disc == N_TTY);
Peter Hurley7896f302016-01-10 22:41:05 -0800681 return PTR_ERR(ld);
Greg Kroah-Hartmana8983d02017-04-14 10:57:52 +0200682 }
Alan Coxc65c9bc2009-06-11 12:50:12 +0100683
Peter Hurley7896f302016-01-10 22:41:05 -0800684 if (tty->ldisc) {
685 tty_ldisc_close(tty, tty->ldisc);
686 tty_ldisc_put(tty->ldisc);
687 }
688
689 /* switch the line discipline */
Peter Hurleyf48070452013-03-11 16:44:42 -0400690 tty->ldisc = ld;
Peter Hurleyc12da962016-01-10 22:41:04 -0800691 tty_set_termios_ldisc(tty, disc);
Peter Hurley7896f302016-01-10 22:41:05 -0800692 retval = tty_ldisc_open(tty, tty->ldisc);
693 if (retval) {
Johannes Weinere65c62b2017-10-13 15:58:08 -0700694 tty_ldisc_put(tty->ldisc);
695 tty->ldisc = NULL;
Peter Hurley7896f302016-01-10 22:41:05 -0800696 }
697 return retval;
Alan Coxc65c9bc2009-06-11 12:50:12 +0100698}
699
700/**
701 * tty_ldisc_hangup - hangup ldisc reset
702 * @tty: tty being hung up
703 *
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.
707 *
708 * Locking: We can take the ldisc mutex as the rest of the code is
709 * careful to allow for this.
710 *
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.
713 */
714
Peter Hurley892d1fa2016-01-10 22:41:06 -0800715void tty_ldisc_hangup(struct tty_struct *tty, bool reinit)
Alan Coxc65c9bc2009-06-11 12:50:12 +0100716{
717 struct tty_ldisc *ld;
718
Peter Hurleya570a492016-01-10 22:41:02 -0800719 tty_ldisc_debug(tty, "%p: hangup\n", tty->ldisc);
Peter Hurleyfc575ee2013-03-11 16:44:38 -0400720
Alan Coxc65c9bc2009-06-11 12:50:12 +0100721 ld = tty_ldisc_ref(tty);
722 if (ld != NULL) {
Alan Coxc65c9bc2009-06-11 12:50:12 +0100723 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);
729 if (ld->ops->hangup)
730 ld->ops->hangup(tty);
731 tty_ldisc_deref(ld);
732 }
Peter Hurley36697522013-06-15 07:04:48 -0400733
Linus Torvaldsa9a08842018-02-11 14:34:03 -0800734 wake_up_interruptible_poll(&tty->write_wait, EPOLLOUT);
735 wake_up_interruptible_poll(&tty->read_wait, EPOLLIN);
Peter Hurley36697522013-06-15 07:04:48 -0400736
Alan Coxc65c9bc2009-06-11 12:50:12 +0100737 /*
738 * Shutdown the current line discipline, and reset it to
Alan Cox638b9642010-02-08 10:09:26 +0000739 * N_TTY if need be.
740 *
741 * Avoid racing set_ldisc or tty_ldisc_release
Alan Coxc65c9bc2009-06-11 12:50:12 +0100742 */
Peter Hurleyfae76e92014-11-05 12:13:07 -0500743 tty_ldisc_lock(tty, MAX_SCHEDULE_TIMEOUT);
Arnd Bergmann60af22d2010-06-01 22:53:06 +0200744
Peter Hurley892d1fa2016-01-10 22:41:06 -0800745 if (tty->driver->flags & TTY_DRIVER_RESET_TERMIOS)
Alan Cox638b9642010-02-08 10:09:26 +0000746 tty_reset_termios(tty);
Peter Hurleyfc575ee2013-03-11 16:44:38 -0400747
Peter Hurley892d1fa2016-01-10 22:41:06 -0800748 if (tty->ldisc) {
749 if (reinit) {
Johannes Weinere65c62b2017-10-13 15:58:08 -0700750 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);
Peter Hurley892d1fa2016-01-10 22:41:06 -0800753 } else
754 tty_ldisc_kill(tty);
755 }
756 tty_ldisc_unlock(tty);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100757}
Alan Cox01e1abb2008-07-22 11:16:55 +0100758
759/**
760 * tty_ldisc_setup - open line discipline
761 * @tty: tty being shut down
762 * @o_tty: pair tty for pty/tty pairs
763 *
764 * Called during the initial open of a tty/pty pair in order to set up the
Alan Coxc65c9bc2009-06-11 12:50:12 +0100765 * line disciplines and bind them to the tty. This has no locking issues
766 * as the device isn't yet active.
Alan Cox01e1abb2008-07-22 11:16:55 +0100767 */
768
769int tty_ldisc_setup(struct tty_struct *tty, struct tty_struct *o_tty)
770{
Peter Hurley9de2a7c2016-01-10 22:41:08 -0800771 int retval = tty_ldisc_open(tty, tty->ldisc);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100772 if (retval)
773 return retval;
774
775 if (o_tty) {
776 retval = tty_ldisc_open(o_tty, o_tty->ldisc);
Alan Cox01e1abb2008-07-22 11:16:55 +0100777 if (retval) {
Peter Hurley9de2a7c2016-01-10 22:41:08 -0800778 tty_ldisc_close(tty, tty->ldisc);
Alan Cox01e1abb2008-07-22 11:16:55 +0100779 return retval;
780 }
Alan Cox01e1abb2008-07-22 11:16:55 +0100781 }
Alan Cox01e1abb2008-07-22 11:16:55 +0100782 return 0;
783}
Alan Cox89c8d912012-08-08 16:30:13 +0100784
Alan Cox01e1abb2008-07-22 11:16:55 +0100785/**
786 * tty_ldisc_release - release line discipline
Peter Hurley62462ae2014-11-05 12:12:58 -0500787 * @tty: tty being shut down (or one end of pty pair)
Alan Cox01e1abb2008-07-22 11:16:55 +0100788 *
Peter Hurley62462ae2014-11-05 12:12:58 -0500789 * Called during the final close of a tty or a pty pair in order to shut
Peter Hurley5b6e6832016-01-10 22:41:00 -0800790 * down the line discpline layer. On exit, each tty's ldisc is NULL.
Alan Cox01e1abb2008-07-22 11:16:55 +0100791 */
792
Peter Hurley62462ae2014-11-05 12:12:58 -0500793void tty_ldisc_release(struct tty_struct *tty)
Alan Cox01e1abb2008-07-22 11:16:55 +0100794{
Peter Hurley62462ae2014-11-05 12:12:58 -0500795 struct tty_struct *o_tty = tty->link;
796
Alan Cox01e1abb2008-07-22 11:16:55 +0100797 /*
Peter Hurleya2965b72013-03-11 16:44:35 -0400798 * Shutdown this line discipline. As this is the final close,
799 * it does not race with the set_ldisc code path.
Alan Cox01e1abb2008-07-22 11:16:55 +0100800 */
Alan Cox01e1abb2008-07-22 11:16:55 +0100801
Peter Hurley36697522013-06-15 07:04:48 -0400802 tty_ldisc_lock_pair(tty, o_tty);
Alan Cox89c8d912012-08-08 16:30:13 +0100803 tty_ldisc_kill(tty);
Alan Cox89c8d912012-08-08 16:30:13 +0100804 if (o_tty)
805 tty_ldisc_kill(o_tty);
Peter Hurley36697522013-06-15 07:04:48 -0400806 tty_ldisc_unlock_pair(tty, o_tty);
807
Alan Coxaef29bc2009-06-29 15:21:47 +0100808 /* And the memory resources remaining (buffers, termios) will be
809 disposed of when the kref hits zero */
Peter Hurleyfc575ee2013-03-11 16:44:38 -0400810
Peter Hurleyfb6edc92015-07-12 22:49:12 -0400811 tty_ldisc_debug(tty, "released\n");
Alan Cox01e1abb2008-07-22 11:16:55 +0100812}
Okash Khawaja1ab92da2017-05-15 18:45:33 +0100813EXPORT_SYMBOL_GPL(tty_ldisc_release);
Alan Cox01e1abb2008-07-22 11:16:55 +0100814
815/**
816 * tty_ldisc_init - ldisc setup for new tty
817 * @tty: tty being allocated
818 *
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.
821 */
822
Tetsuo Handa903f9db2018-04-05 19:40:16 +0900823int tty_ldisc_init(struct tty_struct *tty)
Alan Cox01e1abb2008-07-22 11:16:55 +0100824{
Peter Hurley36697522013-06-15 07:04:48 -0400825 struct tty_ldisc *ld = tty_ldisc_get(tty, N_TTY);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100826 if (IS_ERR(ld))
Tetsuo Handa903f9db2018-04-05 19:40:16 +0900827 return PTR_ERR(ld);
Peter Hurleyf48070452013-03-11 16:44:42 -0400828 tty->ldisc = ld;
Tetsuo Handa903f9db2018-04-05 19:40:16 +0900829 return 0;
Alan Cox01e1abb2008-07-22 11:16:55 +0100830}
831
Jiri Slaby67166712011-03-23 10:48:35 +0100832/**
Peter Hurleyc8b710b2016-01-09 21:13:46 -0800833 * tty_ldisc_deinit - ldisc cleanup for new tty
Jiri Slaby67166712011-03-23 10:48:35 +0100834 * @tty: tty that was allocated recently
835 *
836 * The tty structure must not becompletely set up (tty_ldisc_setup) when
837 * this call is made.
838 */
839void tty_ldisc_deinit(struct tty_struct *tty)
840{
Peter Hurleyc8b710b2016-01-09 21:13:46 -0800841 if (tty->ldisc)
842 tty_ldisc_put(tty->ldisc);
Peter Hurleyf48070452013-03-11 16:44:42 -0400843 tty->ldisc = NULL;
Jiri Slaby67166712011-03-23 10:48:35 +0100844}