blob: fc4c97cae01ef4812da9b1bf61d6efe5d9cf6784 [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
Christoph Hellwigfddda2b2018-04-13 19:44:18 +0200232const struct seq_operations tty_ldiscs_seq_ops = {
Alan Cox01e1abb2008-07-22 11:16:55 +0100233 .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
Alan Cox01e1abb2008-07-22 11:16:55 +0100239/**
Alan Cox01e1abb2008-07-22 11:16:55 +0100240 * tty_ldisc_ref_wait - wait for the tty ldisc
241 * @tty: tty device
242 *
243 * Dereference the line discipline for the terminal and take a
244 * reference to it. If the line discipline is in flux then
245 * wait patiently until it changes.
246 *
Peter Hurley892d1fa2016-01-10 22:41:06 -0800247 * Returns: NULL if the tty has been hungup and not re-opened with
248 * a new file descriptor, otherwise valid ldisc reference
249 *
Alan Cox01e1abb2008-07-22 11:16:55 +0100250 * Note: Must not be called from an IRQ/timer context. The caller
251 * must also be careful not to hold other locks that will deadlock
252 * against a discipline change, such as an existing ldisc reference
253 * (which we check for)
254 *
Peter Hurleye55afd12016-01-10 22:41:01 -0800255 * Note: a file_operations routine (read/poll/write) should use this
256 * function to wait for any ldisc lifetime events to finish.
Alan Cox01e1abb2008-07-22 11:16:55 +0100257 */
258
259struct tty_ldisc *tty_ldisc_ref_wait(struct tty_struct *tty)
260{
Dmitry Vyukova4a3e062017-03-04 13:46:12 +0100261 struct tty_ldisc *ld;
262
Peter Hurley36697522013-06-15 07:04:48 -0400263 ldsem_down_read(&tty->ldisc_sem, MAX_SCHEDULE_TIMEOUT);
Dmitry Vyukova4a3e062017-03-04 13:46:12 +0100264 ld = tty->ldisc;
265 if (!ld)
Peter Hurleya570a492016-01-10 22:41:02 -0800266 ldsem_up_read(&tty->ldisc_sem);
Dmitry Vyukova4a3e062017-03-04 13:46:12 +0100267 return ld;
Alan Cox01e1abb2008-07-22 11:16:55 +0100268}
Alan Cox01e1abb2008-07-22 11:16:55 +0100269EXPORT_SYMBOL_GPL(tty_ldisc_ref_wait);
270
271/**
272 * tty_ldisc_ref - get the tty ldisc
273 * @tty: tty device
274 *
275 * Dereference the line discipline for the terminal and take a
276 * reference to it. If the line discipline is in flux then
277 * return NULL. Can be called from IRQ and timer functions.
Alan Cox01e1abb2008-07-22 11:16:55 +0100278 */
279
280struct tty_ldisc *tty_ldisc_ref(struct tty_struct *tty)
281{
Peter Hurley36697522013-06-15 07:04:48 -0400282 struct tty_ldisc *ld = NULL;
283
284 if (ldsem_down_read_trylock(&tty->ldisc_sem)) {
285 ld = tty->ldisc;
286 if (!ld)
287 ldsem_up_read(&tty->ldisc_sem);
288 }
289 return ld;
Alan Cox01e1abb2008-07-22 11:16:55 +0100290}
Alan Cox01e1abb2008-07-22 11:16:55 +0100291EXPORT_SYMBOL_GPL(tty_ldisc_ref);
292
293/**
294 * tty_ldisc_deref - free a tty ldisc reference
295 * @ld: reference to free up
296 *
297 * Undoes the effect of tty_ldisc_ref or tty_ldisc_ref_wait. May
298 * be called in IRQ context.
Alan Cox01e1abb2008-07-22 11:16:55 +0100299 */
300
301void tty_ldisc_deref(struct tty_ldisc *ld)
302{
Peter Hurley36697522013-06-15 07:04:48 -0400303 ldsem_up_read(&ld->tty->ldisc_sem);
Alan Cox01e1abb2008-07-22 11:16:55 +0100304}
Alan Cox01e1abb2008-07-22 11:16:55 +0100305EXPORT_SYMBOL_GPL(tty_ldisc_deref);
306
Peter Hurleyd2c43892013-06-15 07:04:47 -0400307
Peter Hurleyc2bb5242016-01-09 21:13:51 -0800308static inline int
Peter Hurleye80a10e2014-11-05 12:13:06 -0500309__tty_ldisc_lock(struct tty_struct *tty, unsigned long timeout)
Peter Hurleyd2c43892013-06-15 07:04:47 -0400310{
311 return ldsem_down_write(&tty->ldisc_sem, timeout);
312}
313
Peter Hurleyc2bb5242016-01-09 21:13:51 -0800314static inline int
Peter Hurleye80a10e2014-11-05 12:13:06 -0500315__tty_ldisc_lock_nested(struct tty_struct *tty, unsigned long timeout)
Peter Hurleyd2c43892013-06-15 07:04:47 -0400316{
317 return ldsem_down_write_nested(&tty->ldisc_sem,
318 LDISC_SEM_OTHER, timeout);
319}
320
Peter Hurleye80a10e2014-11-05 12:13:06 -0500321static inline void __tty_ldisc_unlock(struct tty_struct *tty)
Peter Hurleyd2c43892013-06-15 07:04:47 -0400322{
Guillaume Gomez52772ea2015-10-04 21:19:18 +0200323 ldsem_up_write(&tty->ldisc_sem);
Peter Hurleyd2c43892013-06-15 07:04:47 -0400324}
325
Gaurav Kohlib027e222018-01-23 13:16:34 +0530326int tty_ldisc_lock(struct tty_struct *tty, unsigned long timeout)
Peter Hurleyfae76e92014-11-05 12:13:07 -0500327{
328 int ret;
329
330 ret = __tty_ldisc_lock(tty, timeout);
331 if (!ret)
332 return -EBUSY;
333 set_bit(TTY_LDISC_HALTED, &tty->flags);
334 return 0;
335}
336
Gaurav Kohlib027e222018-01-23 13:16:34 +0530337void tty_ldisc_unlock(struct tty_struct *tty)
Peter Hurleyfae76e92014-11-05 12:13:07 -0500338{
339 clear_bit(TTY_LDISC_HALTED, &tty->flags);
340 __tty_ldisc_unlock(tty);
341}
342
Peter Hurleyc2bb5242016-01-09 21:13:51 -0800343static int
Peter Hurleyd2c43892013-06-15 07:04:47 -0400344tty_ldisc_lock_pair_timeout(struct tty_struct *tty, struct tty_struct *tty2,
345 unsigned long timeout)
346{
347 int ret;
348
349 if (tty < tty2) {
Peter Hurleye80a10e2014-11-05 12:13:06 -0500350 ret = __tty_ldisc_lock(tty, timeout);
Peter Hurleyd2c43892013-06-15 07:04:47 -0400351 if (ret) {
Peter Hurleye80a10e2014-11-05 12:13:06 -0500352 ret = __tty_ldisc_lock_nested(tty2, timeout);
Peter Hurleyd2c43892013-06-15 07:04:47 -0400353 if (!ret)
Peter Hurleye80a10e2014-11-05 12:13:06 -0500354 __tty_ldisc_unlock(tty);
Peter Hurleyd2c43892013-06-15 07:04:47 -0400355 }
356 } else {
357 /* if this is possible, it has lots of implications */
358 WARN_ON_ONCE(tty == tty2);
359 if (tty2 && tty != tty2) {
Peter Hurleye80a10e2014-11-05 12:13:06 -0500360 ret = __tty_ldisc_lock(tty2, timeout);
Peter Hurleyd2c43892013-06-15 07:04:47 -0400361 if (ret) {
Peter Hurleye80a10e2014-11-05 12:13:06 -0500362 ret = __tty_ldisc_lock_nested(tty, timeout);
Peter Hurleyd2c43892013-06-15 07:04:47 -0400363 if (!ret)
Peter Hurleye80a10e2014-11-05 12:13:06 -0500364 __tty_ldisc_unlock(tty2);
Peter Hurleyd2c43892013-06-15 07:04:47 -0400365 }
366 } else
Peter Hurleye80a10e2014-11-05 12:13:06 -0500367 ret = __tty_ldisc_lock(tty, timeout);
Peter Hurleyd2c43892013-06-15 07:04:47 -0400368 }
369
370 if (!ret)
371 return -EBUSY;
372
373 set_bit(TTY_LDISC_HALTED, &tty->flags);
374 if (tty2)
375 set_bit(TTY_LDISC_HALTED, &tty2->flags);
376 return 0;
377}
378
Peter Hurleyc2bb5242016-01-09 21:13:51 -0800379static void tty_ldisc_lock_pair(struct tty_struct *tty, struct tty_struct *tty2)
Peter Hurleyd2c43892013-06-15 07:04:47 -0400380{
381 tty_ldisc_lock_pair_timeout(tty, tty2, MAX_SCHEDULE_TIMEOUT);
382}
383
Peter Hurleyc2bb5242016-01-09 21:13:51 -0800384static void tty_ldisc_unlock_pair(struct tty_struct *tty,
385 struct tty_struct *tty2)
Peter Hurleyd2c43892013-06-15 07:04:47 -0400386{
Peter Hurleye80a10e2014-11-05 12:13:06 -0500387 __tty_ldisc_unlock(tty);
Peter Hurleyd2c43892013-06-15 07:04:47 -0400388 if (tty2)
Peter Hurleye80a10e2014-11-05 12:13:06 -0500389 __tty_ldisc_unlock(tty2);
Peter Hurleyd2c43892013-06-15 07:04:47 -0400390}
391
Alan Cox01e1abb2008-07-22 11:16:55 +0100392/**
Alan Coxf2c4c652009-06-11 12:50:58 +0100393 * tty_ldisc_flush - flush line discipline queue
394 * @tty: tty
395 *
Peter Hurley86c80a82014-11-05 12:13:09 -0500396 * Flush the line discipline queue (if any) and the tty flip buffers
397 * for this tty.
Alan Coxf2c4c652009-06-11 12:50:58 +0100398 */
399
400void tty_ldisc_flush(struct tty_struct *tty)
401{
402 struct tty_ldisc *ld = tty_ldisc_ref(tty);
Peter Hurley86c80a82014-11-05 12:13:09 -0500403
404 tty_buffer_flush(tty, ld);
405 if (ld)
Alan Coxf2c4c652009-06-11 12:50:58 +0100406 tty_ldisc_deref(ld);
Alan Coxf2c4c652009-06-11 12:50:58 +0100407}
Alan Coxf2c4c652009-06-11 12:50:58 +0100408EXPORT_SYMBOL_GPL(tty_ldisc_flush);
409
410/**
Alan Cox01e1abb2008-07-22 11:16:55 +0100411 * tty_set_termios_ldisc - set ldisc field
412 * @tty: tty structure
Peter Hurleyc12da962016-01-10 22:41:04 -0800413 * @disc: line discipline number
Alan Cox01e1abb2008-07-22 11:16:55 +0100414 *
415 * This is probably overkill for real world processors but
416 * they are not on hot paths so a little discipline won't do
417 * any harm.
418 *
Peter Hurleydd42bf12015-11-27 14:30:21 -0500419 * 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.
422 *
Peter Hurley6a1c0682013-06-15 09:14:23 -0400423 * Locking: takes termios_rwsem
Alan Cox01e1abb2008-07-22 11:16:55 +0100424 */
425
Peter Hurleyc12da962016-01-10 22:41:04 -0800426static void tty_set_termios_ldisc(struct tty_struct *tty, int disc)
Alan Cox01e1abb2008-07-22 11:16:55 +0100427{
Peter Hurley6a1c0682013-06-15 09:14:23 -0400428 down_write(&tty->termios_rwsem);
Peter Hurleyc12da962016-01-10 22:41:04 -0800429 tty->termios.c_line = disc;
Peter Hurley6a1c0682013-06-15 09:14:23 -0400430 up_write(&tty->termios_rwsem);
Peter Hurleydd42bf12015-11-27 14:30:21 -0500431
432 tty->disc_data = NULL;
433 tty->receive_room = 0;
Alan Cox01e1abb2008-07-22 11:16:55 +0100434}
435
Alan Coxc65c9bc2009-06-11 12:50:12 +0100436/**
437 * tty_ldisc_open - open a line discipline
438 * @tty: tty we are opening the ldisc on
439 * @ld: discipline to open
440 *
441 * A helper opening method. Also a convenient debugging and check
442 * point.
Arnd Bergmannec79d602010-06-01 22:53:01 +0200443 *
444 * Locking: always called with BTM already held.
Alan Coxc65c9bc2009-06-11 12:50:12 +0100445 */
446
447static int tty_ldisc_open(struct tty_struct *tty, struct tty_ldisc *ld)
448{
449 WARN_ON(test_and_set_bit(TTY_LDISC_OPEN, &tty->flags));
Alan Coxf18f9492009-11-30 13:18:35 +0000450 if (ld->ops->open) {
451 int ret;
Arnd Bergmannec79d602010-06-01 22:53:01 +0200452 /* BTM here locks versus a hangup event */
Alan Coxf18f9492009-11-30 13:18:35 +0000453 ret = ld->ops->open(tty);
Jiri Slaby7f90cfc2010-11-25 00:27:54 +0100454 if (ret)
455 clear_bit(TTY_LDISC_OPEN, &tty->flags);
Peter Hurleyfb6edc92015-07-12 22:49:12 -0400456
Peter Hurleya570a492016-01-10 22:41:02 -0800457 tty_ldisc_debug(tty, "%p: opened\n", ld);
Alan Coxf18f9492009-11-30 13:18:35 +0000458 return ret;
459 }
Alan Coxc65c9bc2009-06-11 12:50:12 +0100460 return 0;
461}
462
463/**
464 * tty_ldisc_close - close a line discipline
465 * @tty: tty we are opening the ldisc on
466 * @ld: discipline to close
467 *
468 * A helper close method. Also a convenient debugging and check
469 * point.
470 */
471
472static void tty_ldisc_close(struct tty_struct *tty, struct tty_ldisc *ld)
473{
474 WARN_ON(!test_bit(TTY_LDISC_OPEN, &tty->flags));
475 clear_bit(TTY_LDISC_OPEN, &tty->flags);
476 if (ld->ops->close)
477 ld->ops->close(tty);
Peter Hurleya570a492016-01-10 22:41:02 -0800478 tty_ldisc_debug(tty, "%p: closed\n", ld);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100479}
Alan Cox01e1abb2008-07-22 11:16:55 +0100480
481/**
Alan Cox8a8dabf2017-06-02 13:49:30 +0100482 * tty_ldisc_failto - helper for ldisc failback
483 * @tty: tty to open the ldisc on
484 * @ld: ldisc we are trying to fail back to
485 *
486 * Helper to try and recover a tty when switching back to the old
487 * ldisc fails and we need something attached.
488 */
489
490static int tty_ldisc_failto(struct tty_struct *tty, int ld)
491{
492 struct tty_ldisc *disc = tty_ldisc_get(tty, ld);
493 int r;
494
495 if (IS_ERR(disc))
496 return PTR_ERR(disc);
497 tty->ldisc = disc;
498 tty_set_termios_ldisc(tty, ld);
499 if ((r = tty_ldisc_open(tty, disc)) < 0)
500 tty_ldisc_put(disc);
501 return r;
502}
503
504/**
Greg Kroah-Hartmana8983d02017-04-14 10:57:52 +0200505 * tty_ldisc_restore - helper for tty ldisc change
506 * @tty: tty to recover
507 * @old: previous ldisc
508 *
509 * Restore the previous line discipline or N_TTY when a line discipline
510 * change fails due to an open error
511 */
512
513static void tty_ldisc_restore(struct tty_struct *tty, struct tty_ldisc *old)
514{
Greg Kroah-Hartmana8983d02017-04-14 10:57:52 +0200515 /* There is an outstanding reference here so this is safe */
Tetsuo Handa598c2d42018-04-16 20:06:34 +0900516 if (tty_ldisc_failto(tty, old->ops->num) < 0) {
517 const char *name = tty_name(tty);
518
519 pr_warn("Falling back ldisc for %s.\n", name);
Alan Cox8a8dabf2017-06-02 13:49:30 +0100520 /* The traditional behaviour is to fall back to N_TTY, we
521 want to avoid falling back to N_NULL unless we have no
522 choice to avoid the risk of breaking anything */
523 if (tty_ldisc_failto(tty, N_TTY) < 0 &&
524 tty_ldisc_failto(tty, N_NULL) < 0)
Tetsuo Handa598c2d42018-04-16 20:06:34 +0900525 panic("Couldn't open N_NULL ldisc for %s.", name);
Greg Kroah-Hartmana8983d02017-04-14 10:57:52 +0200526 }
527}
528
529/**
Alan Cox01e1abb2008-07-22 11:16:55 +0100530 * tty_set_ldisc - set line discipline
531 * @tty: the terminal to set
532 * @ldisc: the line discipline
533 *
534 * Set the discipline of a tty line. Must be called from a process
Alan Coxc65c9bc2009-06-11 12:50:12 +0100535 * context. The ldisc change logic has to protect itself against any
536 * overlapping ldisc change (including on the other end of pty pairs),
537 * the close of one side of a tty/pty pair, and eventually hangup.
Alan Cox01e1abb2008-07-22 11:16:55 +0100538 */
539
Peter Hurleyc12da962016-01-10 22:41:04 -0800540int tty_set_ldisc(struct tty_struct *tty, int disc)
Alan Cox01e1abb2008-07-22 11:16:55 +0100541{
Greg Kroah-Hartmana8983d02017-04-14 10:57:52 +0200542 int retval;
543 struct tty_ldisc *old_ldisc, *new_ldisc;
544
545 new_ldisc = tty_ldisc_get(tty, disc);
546 if (IS_ERR(new_ldisc))
547 return PTR_ERR(new_ldisc);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100548
Peter Hurleyc8483bc2014-11-05 12:12:45 -0500549 tty_lock(tty);
Peter Hurley276a6612014-11-05 12:13:08 -0500550 retval = tty_ldisc_lock(tty, 5 * HZ);
Peter Hurley63d8cb32015-11-08 09:29:38 -0500551 if (retval)
552 goto err;
Alan Coxc65c9bc2009-06-11 12:50:12 +0100553
Peter Hurleya570a492016-01-10 22:41:02 -0800554 if (!tty->ldisc) {
555 retval = -EIO;
556 goto out;
557 }
558
Peter Hurley63d8cb32015-11-08 09:29:38 -0500559 /* Check the no-op case */
Greg Kroah-Hartmana8983d02017-04-14 10:57:52 +0200560 if (tty->ldisc->ops->num == disc)
Peter Hurley63d8cb32015-11-08 09:29:38 -0500561 goto out;
Alan Coxc65c9bc2009-06-11 12:50:12 +0100562
Peter Hurley63d8cb32015-11-08 09:29:38 -0500563 if (test_bit(TTY_HUPPED, &tty->flags)) {
564 /* We were raced by hangup */
565 retval = -EIO;
566 goto out;
Alan Coxc65c9bc2009-06-11 12:50:12 +0100567 }
Alan Cox01e1abb2008-07-22 11:16:55 +0100568
Greg Kroah-Hartmana8983d02017-04-14 10:57:52 +0200569 old_ldisc = tty->ldisc;
570
571 /* Shutdown the old discipline. */
572 tty_ldisc_close(tty, old_ldisc);
573
574 /* Now set up the new line discipline. */
575 tty->ldisc = new_ldisc;
576 tty_set_termios_ldisc(tty, disc);
577
578 retval = tty_ldisc_open(tty, new_ldisc);
Alan Cox01e1abb2008-07-22 11:16:55 +0100579 if (retval < 0) {
Alan Coxc65c9bc2009-06-11 12:50:12 +0100580 /* Back to the old one or N_TTY if we can't */
Greg Kroah-Hartmana8983d02017-04-14 10:57:52 +0200581 tty_ldisc_put(new_ldisc);
582 tty_ldisc_restore(tty, old_ldisc);
Alan Cox01e1abb2008-07-22 11:16:55 +0100583 }
Alan Coxc65c9bc2009-06-11 12:50:12 +0100584
Greg Kroah-Hartmana8983d02017-04-14 10:57:52 +0200585 if (tty->ldisc->ops->num != old_ldisc->ops->num && tty->ops->set_ldisc) {
Peter Hurley9191aaa2014-11-05 13:11:41 -0500586 down_read(&tty->termios_rwsem);
Alan Cox01e1abb2008-07-22 11:16:55 +0100587 tty->ops->set_ldisc(tty);
Peter Hurley9191aaa2014-11-05 13:11:41 -0500588 up_read(&tty->termios_rwsem);
589 }
Alan Cox01e1abb2008-07-22 11:16:55 +0100590
Greg Kroah-Hartmana8983d02017-04-14 10:57:52 +0200591 /* At this point we hold a reference to the new ldisc and a
592 reference to the old ldisc, or we hold two references to
593 the old ldisc (if it was restored as part of error cleanup
594 above). In either case, releasing a single reference from
595 the old ldisc is correct. */
596 new_ldisc = old_ldisc;
Peter Hurley63d8cb32015-11-08 09:29:38 -0500597out:
Peter Hurley276a6612014-11-05 12:13:08 -0500598 tty_ldisc_unlock(tty);
Alan Cox01e1abb2008-07-22 11:16:55 +0100599
Alan Coxc65c9bc2009-06-11 12:50:12 +0100600 /* Restart the work queue in case no characters kick it off. Safe if
Alan Cox01e1abb2008-07-22 11:16:55 +0100601 already running */
Peter Hurley17a69212015-11-08 07:53:06 -0500602 tty_buffer_restart_work(tty->port);
Peter Hurley63d8cb32015-11-08 09:29:38 -0500603err:
Greg Kroah-Hartmana8983d02017-04-14 10:57:52 +0200604 tty_ldisc_put(new_ldisc); /* drop the extra reference */
Alan Cox89c8d912012-08-08 16:30:13 +0100605 tty_unlock(tty);
Alan Cox01e1abb2008-07-22 11:16:55 +0100606 return retval;
607}
Okash Khawaja1ab92da2017-05-15 18:45:33 +0100608EXPORT_SYMBOL_GPL(tty_set_ldisc);
Alan Cox01e1abb2008-07-22 11:16:55 +0100609
Alan Coxc65c9bc2009-06-11 12:50:12 +0100610/**
Peter Hurley6ffeb4b2016-01-10 22:41:03 -0800611 * tty_ldisc_kill - teardown ldisc
612 * @tty: tty being released
613 *
614 * Perform final close of the ldisc and reset tty->ldisc
615 */
616static void tty_ldisc_kill(struct tty_struct *tty)
617{
618 if (!tty->ldisc)
619 return;
620 /*
621 * Now kill off the ldisc
622 */
623 tty_ldisc_close(tty, tty->ldisc);
624 tty_ldisc_put(tty->ldisc);
625 /* Force an oops if we mess this up */
626 tty->ldisc = NULL;
627}
628
629/**
Alan Coxc65c9bc2009-06-11 12:50:12 +0100630 * tty_reset_termios - reset terminal state
631 * @tty: tty to reset
632 *
633 * Restore a terminal to the driver default state.
634 */
635
636static void tty_reset_termios(struct tty_struct *tty)
637{
Peter Hurley6a1c0682013-06-15 09:14:23 -0400638 down_write(&tty->termios_rwsem);
Alan Coxadc8d742012-07-14 15:31:47 +0100639 tty->termios = tty->driver->init_termios;
640 tty->termios.c_ispeed = tty_termios_input_baud_rate(&tty->termios);
641 tty->termios.c_ospeed = tty_termios_baud_rate(&tty->termios);
Peter Hurley6a1c0682013-06-15 09:14:23 -0400642 up_write(&tty->termios_rwsem);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100643}
644
645
646/**
647 * tty_ldisc_reinit - reinitialise the tty ldisc
648 * @tty: tty to reinit
Peter Hurleyc12da962016-01-10 22:41:04 -0800649 * @disc: line discipline to reinitialize
Alan Coxc65c9bc2009-06-11 12:50:12 +0100650 *
Peter Hurley7896f302016-01-10 22:41:05 -0800651 * Completely reinitialize the line discipline state, by closing the
Peter Hurley892d1fa2016-01-10 22:41:06 -0800652 * current instance, if there is one, and opening a new instance. If
653 * an error occurs opening the new non-N_TTY instance, the instance
654 * is dropped and tty->ldisc reset to NULL. The caller can then retry
655 * with N_TTY instead.
Peter Hurley7896f302016-01-10 22:41:05 -0800656 *
657 * Returns 0 if successful, otherwise error code < 0
Alan Coxc65c9bc2009-06-11 12:50:12 +0100658 */
659
Peter Hurley892d1fa2016-01-10 22:41:06 -0800660int tty_ldisc_reinit(struct tty_struct *tty, int disc)
Alan Coxc65c9bc2009-06-11 12:50:12 +0100661{
Peter Hurley7896f302016-01-10 22:41:05 -0800662 struct tty_ldisc *ld;
663 int retval;
Philippe Rétornaz1c95ba12010-10-27 17:13:21 +0200664
Peter Hurley7896f302016-01-10 22:41:05 -0800665 ld = tty_ldisc_get(tty, disc);
Greg Kroah-Hartmana8983d02017-04-14 10:57:52 +0200666 if (IS_ERR(ld)) {
667 BUG_ON(disc == N_TTY);
Peter Hurley7896f302016-01-10 22:41:05 -0800668 return PTR_ERR(ld);
Greg Kroah-Hartmana8983d02017-04-14 10:57:52 +0200669 }
Alan Coxc65c9bc2009-06-11 12:50:12 +0100670
Peter Hurley7896f302016-01-10 22:41:05 -0800671 if (tty->ldisc) {
672 tty_ldisc_close(tty, tty->ldisc);
673 tty_ldisc_put(tty->ldisc);
674 }
675
676 /* switch the line discipline */
Peter Hurleyf48070452013-03-11 16:44:42 -0400677 tty->ldisc = ld;
Peter Hurleyc12da962016-01-10 22:41:04 -0800678 tty_set_termios_ldisc(tty, disc);
Peter Hurley7896f302016-01-10 22:41:05 -0800679 retval = tty_ldisc_open(tty, tty->ldisc);
680 if (retval) {
Johannes Weinere65c62b2017-10-13 15:58:08 -0700681 tty_ldisc_put(tty->ldisc);
682 tty->ldisc = NULL;
Peter Hurley7896f302016-01-10 22:41:05 -0800683 }
684 return retval;
Alan Coxc65c9bc2009-06-11 12:50:12 +0100685}
686
687/**
688 * tty_ldisc_hangup - hangup ldisc reset
689 * @tty: tty being hung up
690 *
691 * Some tty devices reset their termios when they receive a hangup
692 * event. In that situation we must also switch back to N_TTY properly
693 * before we reset the termios data.
694 *
695 * Locking: We can take the ldisc mutex as the rest of the code is
696 * careful to allow for this.
697 *
698 * In the pty pair case this occurs in the close() path of the
699 * tty itself so we must be careful about locking rules.
700 */
701
Peter Hurley892d1fa2016-01-10 22:41:06 -0800702void tty_ldisc_hangup(struct tty_struct *tty, bool reinit)
Alan Coxc65c9bc2009-06-11 12:50:12 +0100703{
704 struct tty_ldisc *ld;
705
Peter Hurleya570a492016-01-10 22:41:02 -0800706 tty_ldisc_debug(tty, "%p: hangup\n", tty->ldisc);
Peter Hurleyfc575ee2013-03-11 16:44:38 -0400707
Alan Coxc65c9bc2009-06-11 12:50:12 +0100708 ld = tty_ldisc_ref(tty);
709 if (ld != NULL) {
Alan Coxc65c9bc2009-06-11 12:50:12 +0100710 if (ld->ops->flush_buffer)
711 ld->ops->flush_buffer(tty);
712 tty_driver_flush_buffer(tty);
713 if ((test_bit(TTY_DO_WRITE_WAKEUP, &tty->flags)) &&
714 ld->ops->write_wakeup)
715 ld->ops->write_wakeup(tty);
716 if (ld->ops->hangup)
717 ld->ops->hangup(tty);
718 tty_ldisc_deref(ld);
719 }
Peter Hurley36697522013-06-15 07:04:48 -0400720
Linus Torvaldsa9a08842018-02-11 14:34:03 -0800721 wake_up_interruptible_poll(&tty->write_wait, EPOLLOUT);
722 wake_up_interruptible_poll(&tty->read_wait, EPOLLIN);
Peter Hurley36697522013-06-15 07:04:48 -0400723
Alan Coxc65c9bc2009-06-11 12:50:12 +0100724 /*
725 * Shutdown the current line discipline, and reset it to
Alan Cox638b9642010-02-08 10:09:26 +0000726 * N_TTY if need be.
727 *
728 * Avoid racing set_ldisc or tty_ldisc_release
Alan Coxc65c9bc2009-06-11 12:50:12 +0100729 */
Peter Hurleyfae76e92014-11-05 12:13:07 -0500730 tty_ldisc_lock(tty, MAX_SCHEDULE_TIMEOUT);
Arnd Bergmann60af22d2010-06-01 22:53:06 +0200731
Peter Hurley892d1fa2016-01-10 22:41:06 -0800732 if (tty->driver->flags & TTY_DRIVER_RESET_TERMIOS)
Alan Cox638b9642010-02-08 10:09:26 +0000733 tty_reset_termios(tty);
Peter Hurleyfc575ee2013-03-11 16:44:38 -0400734
Peter Hurley892d1fa2016-01-10 22:41:06 -0800735 if (tty->ldisc) {
736 if (reinit) {
Johannes Weinere65c62b2017-10-13 15:58:08 -0700737 if (tty_ldisc_reinit(tty, tty->termios.c_line) < 0 &&
738 tty_ldisc_reinit(tty, N_TTY) < 0)
739 WARN_ON(tty_ldisc_reinit(tty, N_NULL) < 0);
Peter Hurley892d1fa2016-01-10 22:41:06 -0800740 } else
741 tty_ldisc_kill(tty);
742 }
743 tty_ldisc_unlock(tty);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100744}
Alan Cox01e1abb2008-07-22 11:16:55 +0100745
746/**
747 * tty_ldisc_setup - open line discipline
748 * @tty: tty being shut down
749 * @o_tty: pair tty for pty/tty pairs
750 *
751 * Called during the initial open of a tty/pty pair in order to set up the
Alan Coxc65c9bc2009-06-11 12:50:12 +0100752 * line disciplines and bind them to the tty. This has no locking issues
753 * as the device isn't yet active.
Alan Cox01e1abb2008-07-22 11:16:55 +0100754 */
755
756int tty_ldisc_setup(struct tty_struct *tty, struct tty_struct *o_tty)
757{
Peter Hurley9de2a7c2016-01-10 22:41:08 -0800758 int retval = tty_ldisc_open(tty, tty->ldisc);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100759 if (retval)
760 return retval;
761
762 if (o_tty) {
763 retval = tty_ldisc_open(o_tty, o_tty->ldisc);
Alan Cox01e1abb2008-07-22 11:16:55 +0100764 if (retval) {
Peter Hurley9de2a7c2016-01-10 22:41:08 -0800765 tty_ldisc_close(tty, tty->ldisc);
Alan Cox01e1abb2008-07-22 11:16:55 +0100766 return retval;
767 }
Alan Cox01e1abb2008-07-22 11:16:55 +0100768 }
Alan Cox01e1abb2008-07-22 11:16:55 +0100769 return 0;
770}
Alan Cox89c8d912012-08-08 16:30:13 +0100771
Alan Cox01e1abb2008-07-22 11:16:55 +0100772/**
773 * tty_ldisc_release - release line discipline
Peter Hurley62462ae2014-11-05 12:12:58 -0500774 * @tty: tty being shut down (or one end of pty pair)
Alan Cox01e1abb2008-07-22 11:16:55 +0100775 *
Peter Hurley62462ae2014-11-05 12:12:58 -0500776 * Called during the final close of a tty or a pty pair in order to shut
Peter Hurley5b6e6832016-01-10 22:41:00 -0800777 * down the line discpline layer. On exit, each tty's ldisc is NULL.
Alan Cox01e1abb2008-07-22 11:16:55 +0100778 */
779
Peter Hurley62462ae2014-11-05 12:12:58 -0500780void tty_ldisc_release(struct tty_struct *tty)
Alan Cox01e1abb2008-07-22 11:16:55 +0100781{
Peter Hurley62462ae2014-11-05 12:12:58 -0500782 struct tty_struct *o_tty = tty->link;
783
Alan Cox01e1abb2008-07-22 11:16:55 +0100784 /*
Peter Hurleya2965b72013-03-11 16:44:35 -0400785 * Shutdown this line discipline. As this is the final close,
786 * it does not race with the set_ldisc code path.
Alan Cox01e1abb2008-07-22 11:16:55 +0100787 */
Alan Cox01e1abb2008-07-22 11:16:55 +0100788
Peter Hurley36697522013-06-15 07:04:48 -0400789 tty_ldisc_lock_pair(tty, o_tty);
Alan Cox89c8d912012-08-08 16:30:13 +0100790 tty_ldisc_kill(tty);
Alan Cox89c8d912012-08-08 16:30:13 +0100791 if (o_tty)
792 tty_ldisc_kill(o_tty);
Peter Hurley36697522013-06-15 07:04:48 -0400793 tty_ldisc_unlock_pair(tty, o_tty);
794
Alan Coxaef29bc2009-06-29 15:21:47 +0100795 /* And the memory resources remaining (buffers, termios) will be
796 disposed of when the kref hits zero */
Peter Hurleyfc575ee2013-03-11 16:44:38 -0400797
Peter Hurleyfb6edc92015-07-12 22:49:12 -0400798 tty_ldisc_debug(tty, "released\n");
Alan Cox01e1abb2008-07-22 11:16:55 +0100799}
Okash Khawaja1ab92da2017-05-15 18:45:33 +0100800EXPORT_SYMBOL_GPL(tty_ldisc_release);
Alan Cox01e1abb2008-07-22 11:16:55 +0100801
802/**
803 * tty_ldisc_init - ldisc setup for new tty
804 * @tty: tty being allocated
805 *
806 * Set up the line discipline objects for a newly allocated tty. Note that
807 * the tty structure is not completely set up when this call is made.
808 */
809
Tetsuo Handa903f9db2018-04-05 19:40:16 +0900810int tty_ldisc_init(struct tty_struct *tty)
Alan Cox01e1abb2008-07-22 11:16:55 +0100811{
Peter Hurley36697522013-06-15 07:04:48 -0400812 struct tty_ldisc *ld = tty_ldisc_get(tty, N_TTY);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100813 if (IS_ERR(ld))
Tetsuo Handa903f9db2018-04-05 19:40:16 +0900814 return PTR_ERR(ld);
Peter Hurleyf48070452013-03-11 16:44:42 -0400815 tty->ldisc = ld;
Tetsuo Handa903f9db2018-04-05 19:40:16 +0900816 return 0;
Alan Cox01e1abb2008-07-22 11:16:55 +0100817}
818
Jiri Slaby67166712011-03-23 10:48:35 +0100819/**
Peter Hurleyc8b710b2016-01-09 21:13:46 -0800820 * tty_ldisc_deinit - ldisc cleanup for new tty
Jiri Slaby67166712011-03-23 10:48:35 +0100821 * @tty: tty that was allocated recently
822 *
823 * The tty structure must not becompletely set up (tty_ldisc_setup) when
824 * this call is made.
825 */
826void tty_ldisc_deinit(struct tty_struct *tty)
827{
Peter Hurleyc8b710b2016-01-09 21:13:46 -0800828 if (tty->ldisc)
829 tty_ldisc_put(tty->ldisc);
Peter Hurleyf48070452013-03-11 16:44:42 -0400830 tty->ldisc = NULL;
Jiri Slaby67166712011-03-23 10:48:35 +0100831}