blob: 3eb3f2a03bbb9e95cf68f6e75c473a5dd906a723 [file] [log] [blame]
Alan Cox01e1abb2008-07-22 11:16:55 +01001#include <linux/types.h>
Alan Cox01e1abb2008-07-22 11:16:55 +01002#include <linux/errno.h>
Jiri Slaby8b3ffa12011-11-16 16:27:10 +01003#include <linux/kmod.h>
Alan Cox01e1abb2008-07-22 11:16:55 +01004#include <linux/sched.h>
5#include <linux/interrupt.h>
6#include <linux/tty.h>
7#include <linux/tty_driver.h>
Alan Cox01e1abb2008-07-22 11:16:55 +01008#include <linux/file.h>
Alan Cox01e1abb2008-07-22 11:16:55 +01009#include <linux/mm.h>
10#include <linux/string.h>
11#include <linux/slab.h>
12#include <linux/poll.h>
13#include <linux/proc_fs.h>
Alan Cox01e1abb2008-07-22 11:16:55 +010014#include <linux/module.h>
Alan Cox01e1abb2008-07-22 11:16:55 +010015#include <linux/device.h>
16#include <linux/wait.h>
17#include <linux/bitops.h>
Alan Cox01e1abb2008-07-22 11:16:55 +010018#include <linux/seq_file.h>
Alan Cox01e1abb2008-07-22 11:16:55 +010019#include <linux/uaccess.h>
Jiri Slaby0c73c082011-11-16 16:27:09 +010020#include <linux/ratelimit.h>
Alan Cox01e1abb2008-07-22 11:16:55 +010021
Peter Hurleyfc575ee2013-03-11 16:44:38 -040022#undef LDISC_DEBUG_HANGUP
23
24#ifdef LDISC_DEBUG_HANGUP
Peter Hurley0a6adc12015-07-12 22:49:10 -040025#define tty_ldisc_debug(tty, f, args...) tty_debug(tty, f, ##args)
Peter Hurleyfc575ee2013-03-11 16:44:38 -040026#else
27#define tty_ldisc_debug(tty, f, args...)
28#endif
29
Peter Hurleyd2c43892013-06-15 07:04:47 -040030/* lockdep nested classes for tty->ldisc_sem */
31enum {
32 LDISC_SEM_NORMAL,
33 LDISC_SEM_OTHER,
34};
35
36
Alan Cox01e1abb2008-07-22 11:16:55 +010037/*
38 * This guards the refcounted line discipline lists. The lock
39 * must be taken with irqs off because there are hangup path
40 * callers who will do ldisc lookups and cannot sleep.
41 */
42
Peter Hurley137084b2013-06-15 07:04:46 -040043static DEFINE_RAW_SPINLOCK(tty_ldiscs_lock);
Alan Cox01e1abb2008-07-22 11:16:55 +010044/* Line disc dispatch table */
45static struct tty_ldisc_ops *tty_ldiscs[NR_LDISCS];
46
47/**
48 * tty_register_ldisc - install a line discipline
49 * @disc: ldisc number
50 * @new_ldisc: pointer to the ldisc object
51 *
52 * Installs a new line discipline into the kernel. The discipline
53 * is set up as unreferenced and then made available to the kernel
54 * from this point onwards.
55 *
56 * Locking:
Peter Hurley137084b2013-06-15 07:04:46 -040057 * takes tty_ldiscs_lock to guard against ldisc races
Alan Cox01e1abb2008-07-22 11:16:55 +010058 */
59
60int tty_register_ldisc(int disc, struct tty_ldisc_ops *new_ldisc)
61{
62 unsigned long flags;
63 int ret = 0;
64
65 if (disc < N_TTY || disc >= NR_LDISCS)
66 return -EINVAL;
67
Peter Hurley137084b2013-06-15 07:04:46 -040068 raw_spin_lock_irqsave(&tty_ldiscs_lock, flags);
Alan Cox01e1abb2008-07-22 11:16:55 +010069 tty_ldiscs[disc] = new_ldisc;
70 new_ldisc->num = disc;
71 new_ldisc->refcount = 0;
Peter Hurley137084b2013-06-15 07:04:46 -040072 raw_spin_unlock_irqrestore(&tty_ldiscs_lock, flags);
Alan Cox01e1abb2008-07-22 11:16:55 +010073
74 return ret;
75}
76EXPORT_SYMBOL(tty_register_ldisc);
77
78/**
79 * tty_unregister_ldisc - unload a line discipline
80 * @disc: ldisc number
81 * @new_ldisc: pointer to the ldisc object
82 *
83 * Remove a line discipline from the kernel providing it is not
84 * currently in use.
85 *
86 * Locking:
Peter Hurley137084b2013-06-15 07:04:46 -040087 * takes tty_ldiscs_lock to guard against ldisc races
Alan Cox01e1abb2008-07-22 11:16:55 +010088 */
89
90int tty_unregister_ldisc(int disc)
91{
92 unsigned long flags;
93 int ret = 0;
94
95 if (disc < N_TTY || disc >= NR_LDISCS)
96 return -EINVAL;
97
Peter Hurley137084b2013-06-15 07:04:46 -040098 raw_spin_lock_irqsave(&tty_ldiscs_lock, flags);
Alan Cox01e1abb2008-07-22 11:16:55 +010099 if (tty_ldiscs[disc]->refcount)
100 ret = -EBUSY;
101 else
102 tty_ldiscs[disc] = NULL;
Peter Hurley137084b2013-06-15 07:04:46 -0400103 raw_spin_unlock_irqrestore(&tty_ldiscs_lock, flags);
Alan Cox01e1abb2008-07-22 11:16:55 +0100104
105 return ret;
106}
107EXPORT_SYMBOL(tty_unregister_ldisc);
108
Linus Torvaldsf0de0e82009-08-03 16:00:15 -0700109static struct tty_ldisc_ops *get_ldops(int disc)
110{
111 unsigned long flags;
112 struct tty_ldisc_ops *ldops, *ret;
113
Peter Hurley137084b2013-06-15 07:04:46 -0400114 raw_spin_lock_irqsave(&tty_ldiscs_lock, flags);
Linus Torvaldsf0de0e82009-08-03 16:00:15 -0700115 ret = ERR_PTR(-EINVAL);
116 ldops = tty_ldiscs[disc];
117 if (ldops) {
118 ret = ERR_PTR(-EAGAIN);
119 if (try_module_get(ldops->owner)) {
120 ldops->refcount++;
121 ret = ldops;
122 }
123 }
Peter Hurley137084b2013-06-15 07:04:46 -0400124 raw_spin_unlock_irqrestore(&tty_ldiscs_lock, flags);
Linus Torvaldsf0de0e82009-08-03 16:00:15 -0700125 return ret;
126}
127
128static void put_ldops(struct tty_ldisc_ops *ldops)
129{
130 unsigned long flags;
131
Peter Hurley137084b2013-06-15 07:04:46 -0400132 raw_spin_lock_irqsave(&tty_ldiscs_lock, flags);
Linus Torvaldsf0de0e82009-08-03 16:00:15 -0700133 ldops->refcount--;
134 module_put(ldops->owner);
Peter Hurley137084b2013-06-15 07:04:46 -0400135 raw_spin_unlock_irqrestore(&tty_ldiscs_lock, flags);
Linus Torvaldsf0de0e82009-08-03 16:00:15 -0700136}
Alan Cox01e1abb2008-07-22 11:16:55 +0100137
138/**
Alan Cox01e1abb2008-07-22 11:16:55 +0100139 * tty_ldisc_get - take a reference to an ldisc
140 * @disc: ldisc number
Alan Cox01e1abb2008-07-22 11:16:55 +0100141 *
142 * Takes a reference to a line discipline. Deals with refcounts and
Peter Hurleyc0cc1c52016-01-10 22:40:59 -0800143 * module locking counts.
144 *
145 * Returns: -EINVAL if the discipline index is not [N_TTY..NR_LDISCS] or
146 * if the discipline is not registered
147 * -EAGAIN if request_module() failed to load or register the
148 * the discipline
149 * -ENOMEM if allocation failure
150 *
151 * Otherwise, returns a pointer to the discipline and bumps the
152 * ref count
Alan Cox01e1abb2008-07-22 11:16:55 +0100153 *
154 * Locking:
Peter Hurley137084b2013-06-15 07:04:46 -0400155 * takes tty_ldiscs_lock to guard against ldisc races
Alan Cox01e1abb2008-07-22 11:16:55 +0100156 */
157
Greg Kroah-Hartman9b7984e2019-01-21 17:26:42 +0100158#if defined(CONFIG_LDISC_AUTOLOAD)
159 #define INITIAL_AUTOLOAD_STATE 1
160#else
161 #define INITIAL_AUTOLOAD_STATE 0
162#endif
163static int tty_ldisc_autoload = INITIAL_AUTOLOAD_STATE;
164
Peter Hurley36697522013-06-15 07:04:48 -0400165static struct tty_ldisc *tty_ldisc_get(struct tty_struct *tty, int disc)
Alan Cox01e1abb2008-07-22 11:16:55 +0100166{
Alan Coxc65c9bc2009-06-11 12:50:12 +0100167 struct tty_ldisc *ld;
Linus Torvalds182274f2009-08-03 16:01:28 -0700168 struct tty_ldisc_ops *ldops;
Alan Cox01e1abb2008-07-22 11:16:55 +0100169
170 if (disc < N_TTY || disc >= NR_LDISCS)
Alan Coxc65c9bc2009-06-11 12:50:12 +0100171 return ERR_PTR(-EINVAL);
Linus Torvalds182274f2009-08-03 16:01:28 -0700172
173 /*
174 * Get the ldisc ops - we may need to request them to be loaded
175 * dynamically and try again.
176 */
177 ldops = get_ldops(disc);
178 if (IS_ERR(ldops)) {
Greg Kroah-Hartman9b7984e2019-01-21 17:26:42 +0100179 if (!capable(CAP_SYS_MODULE) && !tty_ldisc_autoload)
180 return ERR_PTR(-EPERM);
Alan Cox01e1abb2008-07-22 11:16:55 +0100181 request_module("tty-ldisc-%d", disc);
Linus Torvalds182274f2009-08-03 16:01:28 -0700182 ldops = get_ldops(disc);
183 if (IS_ERR(ldops))
184 return ERR_CAST(ldops);
Alan Cox01e1abb2008-07-22 11:16:55 +0100185 }
Linus Torvalds182274f2009-08-03 16:01:28 -0700186
Tetsuo Handaad30f052018-04-25 20:12:31 +0900187 /*
188 * There is no way to handle allocation failure of only 16 bytes.
189 * Let's simplify error handling and save more memory.
190 */
191 ld = kmalloc(sizeof(struct tty_ldisc), GFP_KERNEL | __GFP_NOFAIL);
Linus Torvalds182274f2009-08-03 16:01:28 -0700192 ld->ops = ldops;
Peter Hurley36697522013-06-15 07:04:48 -0400193 ld->tty = tty;
Ivo Sieben1541f842012-05-03 14:37:43 +0200194
Alan Coxc65c9bc2009-06-11 12:50:12 +0100195 return ld;
Alan Cox01e1abb2008-07-22 11:16:55 +0100196}
197
Peter Hurley734de242013-03-11 16:44:43 -0400198/**
199 * tty_ldisc_put - release the ldisc
200 *
201 * Complement of tty_ldisc_get().
202 */
Denys Vlasenkocb128f62015-10-27 17:40:02 +0100203static void tty_ldisc_put(struct tty_ldisc *ld)
Peter Hurley734de242013-03-11 16:44:43 -0400204{
Peter Hurley734de242013-03-11 16:44:43 -0400205 if (WARN_ON_ONCE(!ld))
206 return;
207
Peter Hurley36697522013-06-15 07:04:48 -0400208 put_ldops(ld->ops);
Peter Hurley734de242013-03-11 16:44:43 -0400209 kfree(ld);
Peter Hurley734de242013-03-11 16:44:43 -0400210}
211
Alan Cox852e99d2009-06-11 12:51:41 +0100212static void *tty_ldiscs_seq_start(struct seq_file *m, loff_t *pos)
Alan Cox01e1abb2008-07-22 11:16:55 +0100213{
214 return (*pos < NR_LDISCS) ? pos : NULL;
215}
216
Alan Cox852e99d2009-06-11 12:51:41 +0100217static void *tty_ldiscs_seq_next(struct seq_file *m, void *v, loff_t *pos)
Alan Cox01e1abb2008-07-22 11:16:55 +0100218{
219 (*pos)++;
220 return (*pos < NR_LDISCS) ? pos : NULL;
221}
222
223static void tty_ldiscs_seq_stop(struct seq_file *m, void *v)
224{
225}
226
227static int tty_ldiscs_seq_show(struct seq_file *m, void *v)
228{
229 int i = *(loff_t *)v;
Linus Torvaldsf0de0e82009-08-03 16:00:15 -0700230 struct tty_ldisc_ops *ldops;
Alan Cox852e99d2009-06-11 12:51:41 +0100231
Linus Torvaldsf0de0e82009-08-03 16:00:15 -0700232 ldops = get_ldops(i);
233 if (IS_ERR(ldops))
Alan Cox01e1abb2008-07-22 11:16:55 +0100234 return 0;
Linus Torvaldsf0de0e82009-08-03 16:00:15 -0700235 seq_printf(m, "%-10s %2d\n", ldops->name ? ldops->name : "???", i);
236 put_ldops(ldops);
Alan Cox01e1abb2008-07-22 11:16:55 +0100237 return 0;
238}
239
240static const struct seq_operations tty_ldiscs_seq_ops = {
241 .start = tty_ldiscs_seq_start,
242 .next = tty_ldiscs_seq_next,
243 .stop = tty_ldiscs_seq_stop,
244 .show = tty_ldiscs_seq_show,
245};
246
247static int proc_tty_ldiscs_open(struct inode *inode, struct file *file)
248{
249 return seq_open(file, &tty_ldiscs_seq_ops);
250}
251
252const struct file_operations tty_ldiscs_proc_fops = {
253 .owner = THIS_MODULE,
254 .open = proc_tty_ldiscs_open,
255 .read = seq_read,
256 .llseek = seq_lseek,
257 .release = seq_release,
258};
259
260/**
Alan Cox01e1abb2008-07-22 11:16:55 +0100261 * tty_ldisc_ref_wait - wait for the tty ldisc
262 * @tty: tty device
263 *
264 * Dereference the line discipline for the terminal and take a
265 * reference to it. If the line discipline is in flux then
266 * wait patiently until it changes.
267 *
Peter Hurley892d1fa2016-01-10 22:41:06 -0800268 * Returns: NULL if the tty has been hungup and not re-opened with
269 * a new file descriptor, otherwise valid ldisc reference
270 *
Alan Cox01e1abb2008-07-22 11:16:55 +0100271 * Note: Must not be called from an IRQ/timer context. The caller
272 * must also be careful not to hold other locks that will deadlock
273 * against a discipline change, such as an existing ldisc reference
274 * (which we check for)
275 *
Peter Hurleye55afd12016-01-10 22:41:01 -0800276 * Note: a file_operations routine (read/poll/write) should use this
277 * function to wait for any ldisc lifetime events to finish.
Alan Cox01e1abb2008-07-22 11:16:55 +0100278 */
279
280struct tty_ldisc *tty_ldisc_ref_wait(struct tty_struct *tty)
281{
Dmitry Vyukov2a47e7d2017-03-04 13:46:12 +0100282 struct tty_ldisc *ld;
283
Peter Hurley36697522013-06-15 07:04:48 -0400284 ldsem_down_read(&tty->ldisc_sem, MAX_SCHEDULE_TIMEOUT);
Dmitry Vyukov2a47e7d2017-03-04 13:46:12 +0100285 ld = tty->ldisc;
286 if (!ld)
Peter Hurleya570a492016-01-10 22:41:02 -0800287 ldsem_up_read(&tty->ldisc_sem);
Dmitry Vyukov2a47e7d2017-03-04 13:46:12 +0100288 return ld;
Alan Cox01e1abb2008-07-22 11:16:55 +0100289}
Alan Cox01e1abb2008-07-22 11:16:55 +0100290EXPORT_SYMBOL_GPL(tty_ldisc_ref_wait);
291
292/**
293 * tty_ldisc_ref - get the tty ldisc
294 * @tty: tty device
295 *
296 * Dereference the line discipline for the terminal and take a
297 * reference to it. If the line discipline is in flux then
298 * return NULL. Can be called from IRQ and timer functions.
Alan Cox01e1abb2008-07-22 11:16:55 +0100299 */
300
301struct tty_ldisc *tty_ldisc_ref(struct tty_struct *tty)
302{
Peter Hurley36697522013-06-15 07:04:48 -0400303 struct tty_ldisc *ld = NULL;
304
305 if (ldsem_down_read_trylock(&tty->ldisc_sem)) {
306 ld = tty->ldisc;
307 if (!ld)
308 ldsem_up_read(&tty->ldisc_sem);
309 }
310 return ld;
Alan Cox01e1abb2008-07-22 11:16:55 +0100311}
Alan Cox01e1abb2008-07-22 11:16:55 +0100312EXPORT_SYMBOL_GPL(tty_ldisc_ref);
313
314/**
315 * tty_ldisc_deref - free a tty ldisc reference
316 * @ld: reference to free up
317 *
318 * Undoes the effect of tty_ldisc_ref or tty_ldisc_ref_wait. May
319 * be called in IRQ context.
Alan Cox01e1abb2008-07-22 11:16:55 +0100320 */
321
322void tty_ldisc_deref(struct tty_ldisc *ld)
323{
Peter Hurley36697522013-06-15 07:04:48 -0400324 ldsem_up_read(&ld->tty->ldisc_sem);
Alan Cox01e1abb2008-07-22 11:16:55 +0100325}
Alan Cox01e1abb2008-07-22 11:16:55 +0100326EXPORT_SYMBOL_GPL(tty_ldisc_deref);
327
Peter Hurleyd2c43892013-06-15 07:04:47 -0400328
Peter Hurleyc2bb5242016-01-09 21:13:51 -0800329static inline int
Peter Hurleye80a10e2014-11-05 12:13:06 -0500330__tty_ldisc_lock(struct tty_struct *tty, unsigned long timeout)
Peter Hurleyd2c43892013-06-15 07:04:47 -0400331{
332 return ldsem_down_write(&tty->ldisc_sem, timeout);
333}
334
Peter Hurleyc2bb5242016-01-09 21:13:51 -0800335static inline int
Peter Hurleye80a10e2014-11-05 12:13:06 -0500336__tty_ldisc_lock_nested(struct tty_struct *tty, unsigned long timeout)
Peter Hurleyd2c43892013-06-15 07:04:47 -0400337{
338 return ldsem_down_write_nested(&tty->ldisc_sem,
339 LDISC_SEM_OTHER, timeout);
340}
341
Peter Hurleye80a10e2014-11-05 12:13:06 -0500342static inline void __tty_ldisc_unlock(struct tty_struct *tty)
Peter Hurleyd2c43892013-06-15 07:04:47 -0400343{
Guillaume Gomez52772ea2015-10-04 21:19:18 +0200344 ldsem_up_write(&tty->ldisc_sem);
Peter Hurleyd2c43892013-06-15 07:04:47 -0400345}
346
Gaurav Kohli55eaecf2018-01-23 13:16:34 +0530347int tty_ldisc_lock(struct tty_struct *tty, unsigned long timeout)
Peter Hurleyfae76e92014-11-05 12:13:07 -0500348{
349 int ret;
350
351 ret = __tty_ldisc_lock(tty, timeout);
352 if (!ret)
353 return -EBUSY;
354 set_bit(TTY_LDISC_HALTED, &tty->flags);
355 return 0;
356}
357
Gaurav Kohli55eaecf2018-01-23 13:16:34 +0530358void tty_ldisc_unlock(struct tty_struct *tty)
Peter Hurleyfae76e92014-11-05 12:13:07 -0500359{
360 clear_bit(TTY_LDISC_HALTED, &tty->flags);
361 __tty_ldisc_unlock(tty);
362}
363
Peter Hurleyc2bb5242016-01-09 21:13:51 -0800364static int
Peter Hurleyd2c43892013-06-15 07:04:47 -0400365tty_ldisc_lock_pair_timeout(struct tty_struct *tty, struct tty_struct *tty2,
366 unsigned long timeout)
367{
368 int ret;
369
370 if (tty < tty2) {
Peter Hurleye80a10e2014-11-05 12:13:06 -0500371 ret = __tty_ldisc_lock(tty, timeout);
Peter Hurleyd2c43892013-06-15 07:04:47 -0400372 if (ret) {
Peter Hurleye80a10e2014-11-05 12:13:06 -0500373 ret = __tty_ldisc_lock_nested(tty2, timeout);
Peter Hurleyd2c43892013-06-15 07:04:47 -0400374 if (!ret)
Peter Hurleye80a10e2014-11-05 12:13:06 -0500375 __tty_ldisc_unlock(tty);
Peter Hurleyd2c43892013-06-15 07:04:47 -0400376 }
377 } else {
378 /* if this is possible, it has lots of implications */
379 WARN_ON_ONCE(tty == tty2);
380 if (tty2 && tty != tty2) {
Peter Hurleye80a10e2014-11-05 12:13:06 -0500381 ret = __tty_ldisc_lock(tty2, timeout);
Peter Hurleyd2c43892013-06-15 07:04:47 -0400382 if (ret) {
Peter Hurleye80a10e2014-11-05 12:13:06 -0500383 ret = __tty_ldisc_lock_nested(tty, timeout);
Peter Hurleyd2c43892013-06-15 07:04:47 -0400384 if (!ret)
Peter Hurleye80a10e2014-11-05 12:13:06 -0500385 __tty_ldisc_unlock(tty2);
Peter Hurleyd2c43892013-06-15 07:04:47 -0400386 }
387 } else
Peter Hurleye80a10e2014-11-05 12:13:06 -0500388 ret = __tty_ldisc_lock(tty, timeout);
Peter Hurleyd2c43892013-06-15 07:04:47 -0400389 }
390
391 if (!ret)
392 return -EBUSY;
393
394 set_bit(TTY_LDISC_HALTED, &tty->flags);
395 if (tty2)
396 set_bit(TTY_LDISC_HALTED, &tty2->flags);
397 return 0;
398}
399
Peter Hurleyc2bb5242016-01-09 21:13:51 -0800400static void tty_ldisc_lock_pair(struct tty_struct *tty, struct tty_struct *tty2)
Peter Hurleyd2c43892013-06-15 07:04:47 -0400401{
402 tty_ldisc_lock_pair_timeout(tty, tty2, MAX_SCHEDULE_TIMEOUT);
403}
404
Peter Hurleyc2bb5242016-01-09 21:13:51 -0800405static void tty_ldisc_unlock_pair(struct tty_struct *tty,
406 struct tty_struct *tty2)
Peter Hurleyd2c43892013-06-15 07:04:47 -0400407{
Peter Hurleye80a10e2014-11-05 12:13:06 -0500408 __tty_ldisc_unlock(tty);
Peter Hurleyd2c43892013-06-15 07:04:47 -0400409 if (tty2)
Peter Hurleye80a10e2014-11-05 12:13:06 -0500410 __tty_ldisc_unlock(tty2);
Peter Hurleyd2c43892013-06-15 07:04:47 -0400411}
412
Alan Cox01e1abb2008-07-22 11:16:55 +0100413/**
Alan Coxf2c4c652009-06-11 12:50:58 +0100414 * tty_ldisc_flush - flush line discipline queue
415 * @tty: tty
416 *
Peter Hurley86c80a82014-11-05 12:13:09 -0500417 * Flush the line discipline queue (if any) and the tty flip buffers
418 * for this tty.
Alan Coxf2c4c652009-06-11 12:50:58 +0100419 */
420
421void tty_ldisc_flush(struct tty_struct *tty)
422{
423 struct tty_ldisc *ld = tty_ldisc_ref(tty);
Peter Hurley86c80a82014-11-05 12:13:09 -0500424
425 tty_buffer_flush(tty, ld);
426 if (ld)
Alan Coxf2c4c652009-06-11 12:50:58 +0100427 tty_ldisc_deref(ld);
Alan Coxf2c4c652009-06-11 12:50:58 +0100428}
Alan Coxf2c4c652009-06-11 12:50:58 +0100429EXPORT_SYMBOL_GPL(tty_ldisc_flush);
430
431/**
Alan Cox01e1abb2008-07-22 11:16:55 +0100432 * tty_set_termios_ldisc - set ldisc field
433 * @tty: tty structure
Peter Hurleyc12da962016-01-10 22:41:04 -0800434 * @disc: line discipline number
Alan Cox01e1abb2008-07-22 11:16:55 +0100435 *
436 * This is probably overkill for real world processors but
437 * they are not on hot paths so a little discipline won't do
438 * any harm.
439 *
Peter Hurleydd42bf12015-11-27 14:30:21 -0500440 * The line discipline-related tty_struct fields are reset to
441 * prevent the ldisc driver from re-using stale information for
442 * the new ldisc instance.
443 *
Peter Hurley6a1c0682013-06-15 09:14:23 -0400444 * Locking: takes termios_rwsem
Alan Cox01e1abb2008-07-22 11:16:55 +0100445 */
446
Peter Hurleyc12da962016-01-10 22:41:04 -0800447static void tty_set_termios_ldisc(struct tty_struct *tty, int disc)
Alan Cox01e1abb2008-07-22 11:16:55 +0100448{
Peter Hurley6a1c0682013-06-15 09:14:23 -0400449 down_write(&tty->termios_rwsem);
Peter Hurleyc12da962016-01-10 22:41:04 -0800450 tty->termios.c_line = disc;
Peter Hurley6a1c0682013-06-15 09:14:23 -0400451 up_write(&tty->termios_rwsem);
Peter Hurleydd42bf12015-11-27 14:30:21 -0500452
453 tty->disc_data = NULL;
454 tty->receive_room = 0;
Alan Cox01e1abb2008-07-22 11:16:55 +0100455}
456
Alan Coxc65c9bc2009-06-11 12:50:12 +0100457/**
458 * tty_ldisc_open - open a line discipline
459 * @tty: tty we are opening the ldisc on
460 * @ld: discipline to open
461 *
462 * A helper opening method. Also a convenient debugging and check
463 * point.
Arnd Bergmannec79d602010-06-01 22:53:01 +0200464 *
465 * Locking: always called with BTM already held.
Alan Coxc65c9bc2009-06-11 12:50:12 +0100466 */
467
468static int tty_ldisc_open(struct tty_struct *tty, struct tty_ldisc *ld)
469{
470 WARN_ON(test_and_set_bit(TTY_LDISC_OPEN, &tty->flags));
Alan Coxf18f9492009-11-30 13:18:35 +0000471 if (ld->ops->open) {
472 int ret;
Arnd Bergmannec79d602010-06-01 22:53:01 +0200473 /* BTM here locks versus a hangup event */
Alan Coxf18f9492009-11-30 13:18:35 +0000474 ret = ld->ops->open(tty);
Jiri Slaby7f90cfc2010-11-25 00:27:54 +0100475 if (ret)
476 clear_bit(TTY_LDISC_OPEN, &tty->flags);
Peter Hurleyfb6edc92015-07-12 22:49:12 -0400477
Peter Hurleya570a492016-01-10 22:41:02 -0800478 tty_ldisc_debug(tty, "%p: opened\n", ld);
Alan Coxf18f9492009-11-30 13:18:35 +0000479 return ret;
480 }
Alan Coxc65c9bc2009-06-11 12:50:12 +0100481 return 0;
482}
483
484/**
485 * tty_ldisc_close - close a line discipline
486 * @tty: tty we are opening the ldisc on
487 * @ld: discipline to close
488 *
489 * A helper close method. Also a convenient debugging and check
490 * point.
491 */
492
493static void tty_ldisc_close(struct tty_struct *tty, struct tty_ldisc *ld)
494{
495 WARN_ON(!test_bit(TTY_LDISC_OPEN, &tty->flags));
496 clear_bit(TTY_LDISC_OPEN, &tty->flags);
497 if (ld->ops->close)
498 ld->ops->close(tty);
Peter Hurleya570a492016-01-10 22:41:02 -0800499 tty_ldisc_debug(tty, "%p: closed\n", ld);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100500}
Alan Cox01e1abb2008-07-22 11:16:55 +0100501
502/**
Alan Cox01e1abb2008-07-22 11:16:55 +0100503 * tty_set_ldisc - set line discipline
504 * @tty: the terminal to set
505 * @ldisc: the line discipline
506 *
507 * Set the discipline of a tty line. Must be called from a process
Alan Coxc65c9bc2009-06-11 12:50:12 +0100508 * context. The ldisc change logic has to protect itself against any
509 * overlapping ldisc change (including on the other end of pty pairs),
510 * the close of one side of a tty/pty pair, and eventually hangup.
Alan Cox01e1abb2008-07-22 11:16:55 +0100511 */
512
Peter Hurleyc12da962016-01-10 22:41:04 -0800513int tty_set_ldisc(struct tty_struct *tty, int disc)
Alan Cox01e1abb2008-07-22 11:16:55 +0100514{
Dmitry Vyukov70f450f2017-03-04 14:55:19 +0100515 int retval, old_disc;
Alan Coxc65c9bc2009-06-11 12:50:12 +0100516
Peter Hurleyc8483bc2014-11-05 12:12:45 -0500517 tty_lock(tty);
Peter Hurley276a6612014-11-05 12:13:08 -0500518 retval = tty_ldisc_lock(tty, 5 * HZ);
Peter Hurley63d8cb32015-11-08 09:29:38 -0500519 if (retval)
520 goto err;
Alan Coxc65c9bc2009-06-11 12:50:12 +0100521
Peter Hurleya570a492016-01-10 22:41:02 -0800522 if (!tty->ldisc) {
523 retval = -EIO;
524 goto out;
525 }
526
Peter Hurley63d8cb32015-11-08 09:29:38 -0500527 /* Check the no-op case */
Dmitry Vyukov70f450f2017-03-04 14:55:19 +0100528 old_disc = tty->ldisc->ops->num;
529 if (old_disc == disc)
Peter Hurley63d8cb32015-11-08 09:29:38 -0500530 goto out;
Alan Coxc65c9bc2009-06-11 12:50:12 +0100531
Peter Hurley63d8cb32015-11-08 09:29:38 -0500532 if (test_bit(TTY_HUPPED, &tty->flags)) {
533 /* We were raced by hangup */
534 retval = -EIO;
535 goto out;
Alan Coxc65c9bc2009-06-11 12:50:12 +0100536 }
Alan Cox01e1abb2008-07-22 11:16:55 +0100537
Dmitry Vyukov70f450f2017-03-04 14:55:19 +0100538 retval = tty_ldisc_reinit(tty, disc);
Alan Cox01e1abb2008-07-22 11:16:55 +0100539 if (retval < 0) {
Alan Coxc65c9bc2009-06-11 12:50:12 +0100540 /* Back to the old one or N_TTY if we can't */
Dmitry Vyukov70f450f2017-03-04 14:55:19 +0100541 if (tty_ldisc_reinit(tty, old_disc) < 0) {
542 pr_err("tty: TIOCSETD failed, reinitializing N_TTY\n");
543 if (tty_ldisc_reinit(tty, N_TTY) < 0) {
544 /* At this point we have tty->ldisc == NULL. */
545 pr_err("tty: reinitializing N_TTY failed\n");
546 }
547 }
Alan Cox01e1abb2008-07-22 11:16:55 +0100548 }
Alan Coxc65c9bc2009-06-11 12:50:12 +0100549
Dmitry Vyukov70f450f2017-03-04 14:55:19 +0100550 if (tty->ldisc && tty->ldisc->ops->num != old_disc &&
551 tty->ops->set_ldisc) {
Peter Hurley9191aaa2014-11-05 13:11:41 -0500552 down_read(&tty->termios_rwsem);
Alan Cox01e1abb2008-07-22 11:16:55 +0100553 tty->ops->set_ldisc(tty);
Peter Hurley9191aaa2014-11-05 13:11:41 -0500554 up_read(&tty->termios_rwsem);
555 }
Alan Cox01e1abb2008-07-22 11:16:55 +0100556
Peter Hurley63d8cb32015-11-08 09:29:38 -0500557out:
Peter Hurley276a6612014-11-05 12:13:08 -0500558 tty_ldisc_unlock(tty);
Alan Cox01e1abb2008-07-22 11:16:55 +0100559
Alan Coxc65c9bc2009-06-11 12:50:12 +0100560 /* Restart the work queue in case no characters kick it off. Safe if
Alan Cox01e1abb2008-07-22 11:16:55 +0100561 already running */
Peter Hurley17a69212015-11-08 07:53:06 -0500562 tty_buffer_restart_work(tty->port);
Peter Hurley63d8cb32015-11-08 09:29:38 -0500563err:
Alan Cox89c8d912012-08-08 16:30:13 +0100564 tty_unlock(tty);
Alan Cox01e1abb2008-07-22 11:16:55 +0100565 return retval;
566}
567
Alan Coxc65c9bc2009-06-11 12:50:12 +0100568/**
Peter Hurley6ffeb4b2016-01-10 22:41:03 -0800569 * tty_ldisc_kill - teardown ldisc
570 * @tty: tty being released
571 *
572 * Perform final close of the ldisc and reset tty->ldisc
573 */
574static void tty_ldisc_kill(struct tty_struct *tty)
575{
576 if (!tty->ldisc)
577 return;
578 /*
579 * Now kill off the ldisc
580 */
581 tty_ldisc_close(tty, tty->ldisc);
582 tty_ldisc_put(tty->ldisc);
583 /* Force an oops if we mess this up */
584 tty->ldisc = NULL;
585}
586
587/**
Alan Coxc65c9bc2009-06-11 12:50:12 +0100588 * tty_reset_termios - reset terminal state
589 * @tty: tty to reset
590 *
591 * Restore a terminal to the driver default state.
592 */
593
594static void tty_reset_termios(struct tty_struct *tty)
595{
Peter Hurley6a1c0682013-06-15 09:14:23 -0400596 down_write(&tty->termios_rwsem);
Alan Coxadc8d742012-07-14 15:31:47 +0100597 tty->termios = tty->driver->init_termios;
598 tty->termios.c_ispeed = tty_termios_input_baud_rate(&tty->termios);
599 tty->termios.c_ospeed = tty_termios_baud_rate(&tty->termios);
Peter Hurley6a1c0682013-06-15 09:14:23 -0400600 up_write(&tty->termios_rwsem);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100601}
602
603
604/**
605 * tty_ldisc_reinit - reinitialise the tty ldisc
606 * @tty: tty to reinit
Peter Hurleyc12da962016-01-10 22:41:04 -0800607 * @disc: line discipline to reinitialize
Alan Coxc65c9bc2009-06-11 12:50:12 +0100608 *
Peter Hurley7896f302016-01-10 22:41:05 -0800609 * Completely reinitialize the line discipline state, by closing the
Peter Hurley892d1fa2016-01-10 22:41:06 -0800610 * current instance, if there is one, and opening a new instance. If
611 * an error occurs opening the new non-N_TTY instance, the instance
612 * is dropped and tty->ldisc reset to NULL. The caller can then retry
613 * with N_TTY instead.
Peter Hurley7896f302016-01-10 22:41:05 -0800614 *
615 * Returns 0 if successful, otherwise error code < 0
Alan Coxc65c9bc2009-06-11 12:50:12 +0100616 */
617
Peter Hurley892d1fa2016-01-10 22:41:06 -0800618int tty_ldisc_reinit(struct tty_struct *tty, int disc)
Alan Coxc65c9bc2009-06-11 12:50:12 +0100619{
Peter Hurley7896f302016-01-10 22:41:05 -0800620 struct tty_ldisc *ld;
621 int retval;
Philippe Rétornaz1c95ba12010-10-27 17:13:21 +0200622
Peter Hurley7896f302016-01-10 22:41:05 -0800623 ld = tty_ldisc_get(tty, disc);
Dmitry Vyukov70f450f2017-03-04 14:55:19 +0100624 if (IS_ERR(ld))
Peter Hurley7896f302016-01-10 22:41:05 -0800625 return PTR_ERR(ld);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100626
Peter Hurley7896f302016-01-10 22:41:05 -0800627 if (tty->ldisc) {
628 tty_ldisc_close(tty, tty->ldisc);
629 tty_ldisc_put(tty->ldisc);
630 }
631
632 /* switch the line discipline */
Peter Hurleyf48070452013-03-11 16:44:42 -0400633 tty->ldisc = ld;
Peter Hurleyc12da962016-01-10 22:41:04 -0800634 tty_set_termios_ldisc(tty, disc);
Peter Hurley7896f302016-01-10 22:41:05 -0800635 retval = tty_ldisc_open(tty, tty->ldisc);
636 if (retval) {
Dmitry Vyukov70f450f2017-03-04 14:55:19 +0100637 tty_ldisc_put(tty->ldisc);
638 tty->ldisc = NULL;
Peter Hurley7896f302016-01-10 22:41:05 -0800639 }
640 return retval;
Alan Coxc65c9bc2009-06-11 12:50:12 +0100641}
642
643/**
644 * tty_ldisc_hangup - hangup ldisc reset
645 * @tty: tty being hung up
646 *
647 * Some tty devices reset their termios when they receive a hangup
648 * event. In that situation we must also switch back to N_TTY properly
649 * before we reset the termios data.
650 *
651 * Locking: We can take the ldisc mutex as the rest of the code is
652 * careful to allow for this.
653 *
654 * In the pty pair case this occurs in the close() path of the
655 * tty itself so we must be careful about locking rules.
656 */
657
Peter Hurley892d1fa2016-01-10 22:41:06 -0800658void tty_ldisc_hangup(struct tty_struct *tty, bool reinit)
Alan Coxc65c9bc2009-06-11 12:50:12 +0100659{
660 struct tty_ldisc *ld;
661
Peter Hurleya570a492016-01-10 22:41:02 -0800662 tty_ldisc_debug(tty, "%p: hangup\n", tty->ldisc);
Peter Hurleyfc575ee2013-03-11 16:44:38 -0400663
Alan Coxc65c9bc2009-06-11 12:50:12 +0100664 ld = tty_ldisc_ref(tty);
665 if (ld != NULL) {
Alan Coxc65c9bc2009-06-11 12:50:12 +0100666 if (ld->ops->flush_buffer)
667 ld->ops->flush_buffer(tty);
668 tty_driver_flush_buffer(tty);
669 if ((test_bit(TTY_DO_WRITE_WAKEUP, &tty->flags)) &&
670 ld->ops->write_wakeup)
671 ld->ops->write_wakeup(tty);
672 if (ld->ops->hangup)
673 ld->ops->hangup(tty);
674 tty_ldisc_deref(ld);
675 }
Peter Hurley36697522013-06-15 07:04:48 -0400676
Alan Coxc65c9bc2009-06-11 12:50:12 +0100677 wake_up_interruptible_poll(&tty->write_wait, POLLOUT);
678 wake_up_interruptible_poll(&tty->read_wait, POLLIN);
Peter Hurley36697522013-06-15 07:04:48 -0400679
Alan Coxc65c9bc2009-06-11 12:50:12 +0100680 /*
681 * Shutdown the current line discipline, and reset it to
Alan Cox638b9642010-02-08 10:09:26 +0000682 * N_TTY if need be.
683 *
684 * Avoid racing set_ldisc or tty_ldisc_release
Alan Coxc65c9bc2009-06-11 12:50:12 +0100685 */
Peter Hurleyfae76e92014-11-05 12:13:07 -0500686 tty_ldisc_lock(tty, MAX_SCHEDULE_TIMEOUT);
Arnd Bergmann60af22d2010-06-01 22:53:06 +0200687
Peter Hurley892d1fa2016-01-10 22:41:06 -0800688 if (tty->driver->flags & TTY_DRIVER_RESET_TERMIOS)
Alan Cox638b9642010-02-08 10:09:26 +0000689 tty_reset_termios(tty);
Peter Hurleyfc575ee2013-03-11 16:44:38 -0400690
Peter Hurley892d1fa2016-01-10 22:41:06 -0800691 if (tty->ldisc) {
692 if (reinit) {
693 if (tty_ldisc_reinit(tty, tty->termios.c_line) < 0)
694 tty_ldisc_reinit(tty, N_TTY);
695 } else
696 tty_ldisc_kill(tty);
697 }
698 tty_ldisc_unlock(tty);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100699}
Alan Cox01e1abb2008-07-22 11:16:55 +0100700
701/**
702 * tty_ldisc_setup - open line discipline
703 * @tty: tty being shut down
704 * @o_tty: pair tty for pty/tty pairs
705 *
706 * Called during the initial open of a tty/pty pair in order to set up the
Alan Coxc65c9bc2009-06-11 12:50:12 +0100707 * line disciplines and bind them to the tty. This has no locking issues
708 * as the device isn't yet active.
Alan Cox01e1abb2008-07-22 11:16:55 +0100709 */
710
711int tty_ldisc_setup(struct tty_struct *tty, struct tty_struct *o_tty)
712{
Peter Hurley9de2a7c2016-01-10 22:41:08 -0800713 int retval = tty_ldisc_open(tty, tty->ldisc);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100714 if (retval)
715 return retval;
716
717 if (o_tty) {
718 retval = tty_ldisc_open(o_tty, o_tty->ldisc);
Alan Cox01e1abb2008-07-22 11:16:55 +0100719 if (retval) {
Peter Hurley9de2a7c2016-01-10 22:41:08 -0800720 tty_ldisc_close(tty, tty->ldisc);
Alan Cox01e1abb2008-07-22 11:16:55 +0100721 return retval;
722 }
Alan Cox01e1abb2008-07-22 11:16:55 +0100723 }
Alan Cox01e1abb2008-07-22 11:16:55 +0100724 return 0;
725}
Alan Cox89c8d912012-08-08 16:30:13 +0100726
Alan Cox01e1abb2008-07-22 11:16:55 +0100727/**
728 * tty_ldisc_release - release line discipline
Peter Hurley62462ae2014-11-05 12:12:58 -0500729 * @tty: tty being shut down (or one end of pty pair)
Alan Cox01e1abb2008-07-22 11:16:55 +0100730 *
Peter Hurley62462ae2014-11-05 12:12:58 -0500731 * Called during the final close of a tty or a pty pair in order to shut
Peter Hurley5b6e6832016-01-10 22:41:00 -0800732 * down the line discpline layer. On exit, each tty's ldisc is NULL.
Alan Cox01e1abb2008-07-22 11:16:55 +0100733 */
734
Peter Hurley62462ae2014-11-05 12:12:58 -0500735void tty_ldisc_release(struct tty_struct *tty)
Alan Cox01e1abb2008-07-22 11:16:55 +0100736{
Peter Hurley62462ae2014-11-05 12:12:58 -0500737 struct tty_struct *o_tty = tty->link;
738
Alan Cox01e1abb2008-07-22 11:16:55 +0100739 /*
Peter Hurleya2965b72013-03-11 16:44:35 -0400740 * Shutdown this line discipline. As this is the final close,
741 * it does not race with the set_ldisc code path.
Alan Cox01e1abb2008-07-22 11:16:55 +0100742 */
Alan Cox01e1abb2008-07-22 11:16:55 +0100743
Peter Hurley36697522013-06-15 07:04:48 -0400744 tty_ldisc_lock_pair(tty, o_tty);
Alan Cox89c8d912012-08-08 16:30:13 +0100745 tty_ldisc_kill(tty);
Alan Cox89c8d912012-08-08 16:30:13 +0100746 if (o_tty)
747 tty_ldisc_kill(o_tty);
Peter Hurley36697522013-06-15 07:04:48 -0400748 tty_ldisc_unlock_pair(tty, o_tty);
749
Alan Coxaef29bc2009-06-29 15:21:47 +0100750 /* And the memory resources remaining (buffers, termios) will be
751 disposed of when the kref hits zero */
Peter Hurleyfc575ee2013-03-11 16:44:38 -0400752
Peter Hurleyfb6edc92015-07-12 22:49:12 -0400753 tty_ldisc_debug(tty, "released\n");
Alan Cox01e1abb2008-07-22 11:16:55 +0100754}
755
756/**
757 * tty_ldisc_init - ldisc setup for new tty
758 * @tty: tty being allocated
759 *
760 * Set up the line discipline objects for a newly allocated tty. Note that
761 * the tty structure is not completely set up when this call is made.
762 */
763
Tetsuo Handa6a506d42018-04-05 19:40:16 +0900764int tty_ldisc_init(struct tty_struct *tty)
Alan Cox01e1abb2008-07-22 11:16:55 +0100765{
Peter Hurley36697522013-06-15 07:04:48 -0400766 struct tty_ldisc *ld = tty_ldisc_get(tty, N_TTY);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100767 if (IS_ERR(ld))
Tetsuo Handa6a506d42018-04-05 19:40:16 +0900768 return PTR_ERR(ld);
Peter Hurleyf48070452013-03-11 16:44:42 -0400769 tty->ldisc = ld;
Tetsuo Handa6a506d42018-04-05 19:40:16 +0900770 return 0;
Alan Cox01e1abb2008-07-22 11:16:55 +0100771}
772
Jiri Slaby67166712011-03-23 10:48:35 +0100773/**
Peter Hurleyc8b710b2016-01-09 21:13:46 -0800774 * tty_ldisc_deinit - ldisc cleanup for new tty
Jiri Slaby67166712011-03-23 10:48:35 +0100775 * @tty: tty that was allocated recently
776 *
777 * The tty structure must not becompletely set up (tty_ldisc_setup) when
778 * this call is made.
779 */
780void tty_ldisc_deinit(struct tty_struct *tty)
781{
Peter Hurleyc8b710b2016-01-09 21:13:46 -0800782 if (tty->ldisc)
783 tty_ldisc_put(tty->ldisc);
Peter Hurleyf48070452013-03-11 16:44:42 -0400784 tty->ldisc = NULL;
Jiri Slaby67166712011-03-23 10:48:35 +0100785}
Greg Kroah-Hartman9b7984e2019-01-21 17:26:42 +0100786
787static int zero;
788static int one = 1;
789static struct ctl_table tty_table[] = {
790 {
791 .procname = "ldisc_autoload",
792 .data = &tty_ldisc_autoload,
793 .maxlen = sizeof(tty_ldisc_autoload),
794 .mode = 0644,
795 .proc_handler = proc_dointvec,
796 .extra1 = &zero,
797 .extra2 = &one,
798 },
799 { }
800};
801
802static struct ctl_table tty_dir_table[] = {
803 {
804 .procname = "tty",
805 .mode = 0555,
806 .child = tty_table,
807 },
808 { }
809};
810
811static struct ctl_table tty_root_table[] = {
812 {
813 .procname = "dev",
814 .mode = 0555,
815 .child = tty_dir_table,
816 },
817 { }
818};
819
820void tty_sysctl_init(void)
821{
822 register_sysctl_table(tty_root_table);
823}