blob: 706faca834f2710996a79d74b7433e75a128f539 [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
Dmitry Safonov95595c82018-11-01 00:24:48 +0000351 /* Kindly asking blocked readers to release the read side */
352 set_bit(TTY_LDISC_CHANGING, &tty->flags);
353 wake_up_interruptible_all(&tty->read_wait);
354 wake_up_interruptible_all(&tty->write_wait);
355
Peter Hurleyfae76e92014-11-05 12:13:07 -0500356 ret = __tty_ldisc_lock(tty, timeout);
357 if (!ret)
358 return -EBUSY;
359 set_bit(TTY_LDISC_HALTED, &tty->flags);
360 return 0;
361}
362
Gaurav Kohli55eaecf2018-01-23 13:16:34 +0530363void tty_ldisc_unlock(struct tty_struct *tty)
Peter Hurleyfae76e92014-11-05 12:13:07 -0500364{
365 clear_bit(TTY_LDISC_HALTED, &tty->flags);
Dmitry Safonov95595c82018-11-01 00:24:48 +0000366 /* Can be cleared here - ldisc_unlock will wake up writers firstly */
367 clear_bit(TTY_LDISC_CHANGING, &tty->flags);
Peter Hurleyfae76e92014-11-05 12:13:07 -0500368 __tty_ldisc_unlock(tty);
369}
370
Peter Hurleyc2bb5242016-01-09 21:13:51 -0800371static int
Peter Hurleyd2c43892013-06-15 07:04:47 -0400372tty_ldisc_lock_pair_timeout(struct tty_struct *tty, struct tty_struct *tty2,
373 unsigned long timeout)
374{
375 int ret;
376
377 if (tty < tty2) {
Peter Hurleye80a10e2014-11-05 12:13:06 -0500378 ret = __tty_ldisc_lock(tty, timeout);
Peter Hurleyd2c43892013-06-15 07:04:47 -0400379 if (ret) {
Peter Hurleye80a10e2014-11-05 12:13:06 -0500380 ret = __tty_ldisc_lock_nested(tty2, timeout);
Peter Hurleyd2c43892013-06-15 07:04:47 -0400381 if (!ret)
Peter Hurleye80a10e2014-11-05 12:13:06 -0500382 __tty_ldisc_unlock(tty);
Peter Hurleyd2c43892013-06-15 07:04:47 -0400383 }
384 } else {
385 /* if this is possible, it has lots of implications */
386 WARN_ON_ONCE(tty == tty2);
387 if (tty2 && tty != tty2) {
Peter Hurleye80a10e2014-11-05 12:13:06 -0500388 ret = __tty_ldisc_lock(tty2, timeout);
Peter Hurleyd2c43892013-06-15 07:04:47 -0400389 if (ret) {
Peter Hurleye80a10e2014-11-05 12:13:06 -0500390 ret = __tty_ldisc_lock_nested(tty, timeout);
Peter Hurleyd2c43892013-06-15 07:04:47 -0400391 if (!ret)
Peter Hurleye80a10e2014-11-05 12:13:06 -0500392 __tty_ldisc_unlock(tty2);
Peter Hurleyd2c43892013-06-15 07:04:47 -0400393 }
394 } else
Peter Hurleye80a10e2014-11-05 12:13:06 -0500395 ret = __tty_ldisc_lock(tty, timeout);
Peter Hurleyd2c43892013-06-15 07:04:47 -0400396 }
397
398 if (!ret)
399 return -EBUSY;
400
401 set_bit(TTY_LDISC_HALTED, &tty->flags);
402 if (tty2)
403 set_bit(TTY_LDISC_HALTED, &tty2->flags);
404 return 0;
405}
406
Peter Hurleyc2bb5242016-01-09 21:13:51 -0800407static void tty_ldisc_lock_pair(struct tty_struct *tty, struct tty_struct *tty2)
Peter Hurleyd2c43892013-06-15 07:04:47 -0400408{
409 tty_ldisc_lock_pair_timeout(tty, tty2, MAX_SCHEDULE_TIMEOUT);
410}
411
Peter Hurleyc2bb5242016-01-09 21:13:51 -0800412static void tty_ldisc_unlock_pair(struct tty_struct *tty,
413 struct tty_struct *tty2)
Peter Hurleyd2c43892013-06-15 07:04:47 -0400414{
Peter Hurleye80a10e2014-11-05 12:13:06 -0500415 __tty_ldisc_unlock(tty);
Peter Hurleyd2c43892013-06-15 07:04:47 -0400416 if (tty2)
Peter Hurleye80a10e2014-11-05 12:13:06 -0500417 __tty_ldisc_unlock(tty2);
Peter Hurleyd2c43892013-06-15 07:04:47 -0400418}
419
Alan Cox01e1abb2008-07-22 11:16:55 +0100420/**
Alan Coxf2c4c652009-06-11 12:50:58 +0100421 * tty_ldisc_flush - flush line discipline queue
422 * @tty: tty
423 *
Peter Hurley86c80a82014-11-05 12:13:09 -0500424 * Flush the line discipline queue (if any) and the tty flip buffers
425 * for this tty.
Alan Coxf2c4c652009-06-11 12:50:58 +0100426 */
427
428void tty_ldisc_flush(struct tty_struct *tty)
429{
430 struct tty_ldisc *ld = tty_ldisc_ref(tty);
Peter Hurley86c80a82014-11-05 12:13:09 -0500431
432 tty_buffer_flush(tty, ld);
433 if (ld)
Alan Coxf2c4c652009-06-11 12:50:58 +0100434 tty_ldisc_deref(ld);
Alan Coxf2c4c652009-06-11 12:50:58 +0100435}
Alan Coxf2c4c652009-06-11 12:50:58 +0100436EXPORT_SYMBOL_GPL(tty_ldisc_flush);
437
438/**
Alan Cox01e1abb2008-07-22 11:16:55 +0100439 * tty_set_termios_ldisc - set ldisc field
440 * @tty: tty structure
Peter Hurleyc12da962016-01-10 22:41:04 -0800441 * @disc: line discipline number
Alan Cox01e1abb2008-07-22 11:16:55 +0100442 *
443 * This is probably overkill for real world processors but
444 * they are not on hot paths so a little discipline won't do
445 * any harm.
446 *
Peter Hurleydd42bf12015-11-27 14:30:21 -0500447 * The line discipline-related tty_struct fields are reset to
448 * prevent the ldisc driver from re-using stale information for
449 * the new ldisc instance.
450 *
Peter Hurley6a1c0682013-06-15 09:14:23 -0400451 * Locking: takes termios_rwsem
Alan Cox01e1abb2008-07-22 11:16:55 +0100452 */
453
Peter Hurleyc12da962016-01-10 22:41:04 -0800454static void tty_set_termios_ldisc(struct tty_struct *tty, int disc)
Alan Cox01e1abb2008-07-22 11:16:55 +0100455{
Peter Hurley6a1c0682013-06-15 09:14:23 -0400456 down_write(&tty->termios_rwsem);
Peter Hurleyc12da962016-01-10 22:41:04 -0800457 tty->termios.c_line = disc;
Peter Hurley6a1c0682013-06-15 09:14:23 -0400458 up_write(&tty->termios_rwsem);
Peter Hurleydd42bf12015-11-27 14:30:21 -0500459
460 tty->disc_data = NULL;
461 tty->receive_room = 0;
Alan Cox01e1abb2008-07-22 11:16:55 +0100462}
463
Alan Coxc65c9bc2009-06-11 12:50:12 +0100464/**
465 * tty_ldisc_open - open a line discipline
466 * @tty: tty we are opening the ldisc on
467 * @ld: discipline to open
468 *
469 * A helper opening method. Also a convenient debugging and check
470 * point.
Arnd Bergmannec79d602010-06-01 22:53:01 +0200471 *
472 * Locking: always called with BTM already held.
Alan Coxc65c9bc2009-06-11 12:50:12 +0100473 */
474
475static int tty_ldisc_open(struct tty_struct *tty, struct tty_ldisc *ld)
476{
477 WARN_ON(test_and_set_bit(TTY_LDISC_OPEN, &tty->flags));
Alan Coxf18f9492009-11-30 13:18:35 +0000478 if (ld->ops->open) {
479 int ret;
Arnd Bergmannec79d602010-06-01 22:53:01 +0200480 /* BTM here locks versus a hangup event */
Alan Coxf18f9492009-11-30 13:18:35 +0000481 ret = ld->ops->open(tty);
Jiri Slaby7f90cfc2010-11-25 00:27:54 +0100482 if (ret)
483 clear_bit(TTY_LDISC_OPEN, &tty->flags);
Peter Hurleyfb6edc92015-07-12 22:49:12 -0400484
Peter Hurleya570a492016-01-10 22:41:02 -0800485 tty_ldisc_debug(tty, "%p: opened\n", ld);
Alan Coxf18f9492009-11-30 13:18:35 +0000486 return ret;
487 }
Alan Coxc65c9bc2009-06-11 12:50:12 +0100488 return 0;
489}
490
491/**
492 * tty_ldisc_close - close a line discipline
493 * @tty: tty we are opening the ldisc on
494 * @ld: discipline to close
495 *
496 * A helper close method. Also a convenient debugging and check
497 * point.
498 */
499
500static void tty_ldisc_close(struct tty_struct *tty, struct tty_ldisc *ld)
501{
502 WARN_ON(!test_bit(TTY_LDISC_OPEN, &tty->flags));
503 clear_bit(TTY_LDISC_OPEN, &tty->flags);
504 if (ld->ops->close)
505 ld->ops->close(tty);
Peter Hurleya570a492016-01-10 22:41:02 -0800506 tty_ldisc_debug(tty, "%p: closed\n", ld);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100507}
Alan Cox01e1abb2008-07-22 11:16:55 +0100508
509/**
Alan Cox01e1abb2008-07-22 11:16:55 +0100510 * tty_set_ldisc - set line discipline
511 * @tty: the terminal to set
512 * @ldisc: the line discipline
513 *
514 * Set the discipline of a tty line. Must be called from a process
Alan Coxc65c9bc2009-06-11 12:50:12 +0100515 * context. The ldisc change logic has to protect itself against any
516 * overlapping ldisc change (including on the other end of pty pairs),
517 * the close of one side of a tty/pty pair, and eventually hangup.
Alan Cox01e1abb2008-07-22 11:16:55 +0100518 */
519
Peter Hurleyc12da962016-01-10 22:41:04 -0800520int tty_set_ldisc(struct tty_struct *tty, int disc)
Alan Cox01e1abb2008-07-22 11:16:55 +0100521{
Dmitry Vyukov70f450f2017-03-04 14:55:19 +0100522 int retval, old_disc;
Alan Coxc65c9bc2009-06-11 12:50:12 +0100523
Peter Hurleyc8483bc2014-11-05 12:12:45 -0500524 tty_lock(tty);
Peter Hurley276a6612014-11-05 12:13:08 -0500525 retval = tty_ldisc_lock(tty, 5 * HZ);
Peter Hurley63d8cb32015-11-08 09:29:38 -0500526 if (retval)
527 goto err;
Alan Coxc65c9bc2009-06-11 12:50:12 +0100528
Peter Hurleya570a492016-01-10 22:41:02 -0800529 if (!tty->ldisc) {
530 retval = -EIO;
531 goto out;
532 }
533
Peter Hurley63d8cb32015-11-08 09:29:38 -0500534 /* Check the no-op case */
Dmitry Vyukov70f450f2017-03-04 14:55:19 +0100535 old_disc = tty->ldisc->ops->num;
536 if (old_disc == disc)
Peter Hurley63d8cb32015-11-08 09:29:38 -0500537 goto out;
Alan Coxc65c9bc2009-06-11 12:50:12 +0100538
Peter Hurley63d8cb32015-11-08 09:29:38 -0500539 if (test_bit(TTY_HUPPED, &tty->flags)) {
540 /* We were raced by hangup */
541 retval = -EIO;
542 goto out;
Alan Coxc65c9bc2009-06-11 12:50:12 +0100543 }
Alan Cox01e1abb2008-07-22 11:16:55 +0100544
Dmitry Vyukov70f450f2017-03-04 14:55:19 +0100545 retval = tty_ldisc_reinit(tty, disc);
Alan Cox01e1abb2008-07-22 11:16:55 +0100546 if (retval < 0) {
Alan Coxc65c9bc2009-06-11 12:50:12 +0100547 /* Back to the old one or N_TTY if we can't */
Dmitry Vyukov70f450f2017-03-04 14:55:19 +0100548 if (tty_ldisc_reinit(tty, old_disc) < 0) {
549 pr_err("tty: TIOCSETD failed, reinitializing N_TTY\n");
550 if (tty_ldisc_reinit(tty, N_TTY) < 0) {
551 /* At this point we have tty->ldisc == NULL. */
552 pr_err("tty: reinitializing N_TTY failed\n");
553 }
554 }
Alan Cox01e1abb2008-07-22 11:16:55 +0100555 }
Alan Coxc65c9bc2009-06-11 12:50:12 +0100556
Dmitry Vyukov70f450f2017-03-04 14:55:19 +0100557 if (tty->ldisc && tty->ldisc->ops->num != old_disc &&
558 tty->ops->set_ldisc) {
Peter Hurley9191aaa2014-11-05 13:11:41 -0500559 down_read(&tty->termios_rwsem);
Alan Cox01e1abb2008-07-22 11:16:55 +0100560 tty->ops->set_ldisc(tty);
Peter Hurley9191aaa2014-11-05 13:11:41 -0500561 up_read(&tty->termios_rwsem);
562 }
Alan Cox01e1abb2008-07-22 11:16:55 +0100563
Peter Hurley63d8cb32015-11-08 09:29:38 -0500564out:
Peter Hurley276a6612014-11-05 12:13:08 -0500565 tty_ldisc_unlock(tty);
Alan Cox01e1abb2008-07-22 11:16:55 +0100566
Alan Coxc65c9bc2009-06-11 12:50:12 +0100567 /* Restart the work queue in case no characters kick it off. Safe if
Alan Cox01e1abb2008-07-22 11:16:55 +0100568 already running */
Peter Hurley17a69212015-11-08 07:53:06 -0500569 tty_buffer_restart_work(tty->port);
Peter Hurley63d8cb32015-11-08 09:29:38 -0500570err:
Alan Cox89c8d912012-08-08 16:30:13 +0100571 tty_unlock(tty);
Alan Cox01e1abb2008-07-22 11:16:55 +0100572 return retval;
573}
574
Alan Coxc65c9bc2009-06-11 12:50:12 +0100575/**
Peter Hurley6ffeb4b2016-01-10 22:41:03 -0800576 * tty_ldisc_kill - teardown ldisc
577 * @tty: tty being released
578 *
579 * Perform final close of the ldisc and reset tty->ldisc
580 */
581static void tty_ldisc_kill(struct tty_struct *tty)
582{
583 if (!tty->ldisc)
584 return;
585 /*
586 * Now kill off the ldisc
587 */
588 tty_ldisc_close(tty, tty->ldisc);
589 tty_ldisc_put(tty->ldisc);
590 /* Force an oops if we mess this up */
591 tty->ldisc = NULL;
592}
593
594/**
Alan Coxc65c9bc2009-06-11 12:50:12 +0100595 * tty_reset_termios - reset terminal state
596 * @tty: tty to reset
597 *
598 * Restore a terminal to the driver default state.
599 */
600
601static void tty_reset_termios(struct tty_struct *tty)
602{
Peter Hurley6a1c0682013-06-15 09:14:23 -0400603 down_write(&tty->termios_rwsem);
Alan Coxadc8d742012-07-14 15:31:47 +0100604 tty->termios = tty->driver->init_termios;
605 tty->termios.c_ispeed = tty_termios_input_baud_rate(&tty->termios);
606 tty->termios.c_ospeed = tty_termios_baud_rate(&tty->termios);
Peter Hurley6a1c0682013-06-15 09:14:23 -0400607 up_write(&tty->termios_rwsem);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100608}
609
610
611/**
612 * tty_ldisc_reinit - reinitialise the tty ldisc
613 * @tty: tty to reinit
Peter Hurleyc12da962016-01-10 22:41:04 -0800614 * @disc: line discipline to reinitialize
Alan Coxc65c9bc2009-06-11 12:50:12 +0100615 *
Peter Hurley7896f302016-01-10 22:41:05 -0800616 * Completely reinitialize the line discipline state, by closing the
Peter Hurley892d1fa2016-01-10 22:41:06 -0800617 * current instance, if there is one, and opening a new instance. If
618 * an error occurs opening the new non-N_TTY instance, the instance
619 * is dropped and tty->ldisc reset to NULL. The caller can then retry
620 * with N_TTY instead.
Peter Hurley7896f302016-01-10 22:41:05 -0800621 *
622 * Returns 0 if successful, otherwise error code < 0
Alan Coxc65c9bc2009-06-11 12:50:12 +0100623 */
624
Peter Hurley892d1fa2016-01-10 22:41:06 -0800625int tty_ldisc_reinit(struct tty_struct *tty, int disc)
Alan Coxc65c9bc2009-06-11 12:50:12 +0100626{
Peter Hurley7896f302016-01-10 22:41:05 -0800627 struct tty_ldisc *ld;
628 int retval;
Philippe Rétornaz1c95ba12010-10-27 17:13:21 +0200629
Peter Hurley7896f302016-01-10 22:41:05 -0800630 ld = tty_ldisc_get(tty, disc);
Dmitry Vyukov70f450f2017-03-04 14:55:19 +0100631 if (IS_ERR(ld))
Peter Hurley7896f302016-01-10 22:41:05 -0800632 return PTR_ERR(ld);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100633
Peter Hurley7896f302016-01-10 22:41:05 -0800634 if (tty->ldisc) {
635 tty_ldisc_close(tty, tty->ldisc);
636 tty_ldisc_put(tty->ldisc);
637 }
638
639 /* switch the line discipline */
Peter Hurleyf48070452013-03-11 16:44:42 -0400640 tty->ldisc = ld;
Peter Hurleyc12da962016-01-10 22:41:04 -0800641 tty_set_termios_ldisc(tty, disc);
Peter Hurley7896f302016-01-10 22:41:05 -0800642 retval = tty_ldisc_open(tty, tty->ldisc);
643 if (retval) {
Dmitry Vyukov70f450f2017-03-04 14:55:19 +0100644 tty_ldisc_put(tty->ldisc);
645 tty->ldisc = NULL;
Peter Hurley7896f302016-01-10 22:41:05 -0800646 }
647 return retval;
Alan Coxc65c9bc2009-06-11 12:50:12 +0100648}
649
650/**
651 * tty_ldisc_hangup - hangup ldisc reset
652 * @tty: tty being hung up
653 *
654 * Some tty devices reset their termios when they receive a hangup
655 * event. In that situation we must also switch back to N_TTY properly
656 * before we reset the termios data.
657 *
658 * Locking: We can take the ldisc mutex as the rest of the code is
659 * careful to allow for this.
660 *
661 * In the pty pair case this occurs in the close() path of the
662 * tty itself so we must be careful about locking rules.
663 */
664
Peter Hurley892d1fa2016-01-10 22:41:06 -0800665void tty_ldisc_hangup(struct tty_struct *tty, bool reinit)
Alan Coxc65c9bc2009-06-11 12:50:12 +0100666{
667 struct tty_ldisc *ld;
668
Peter Hurleya570a492016-01-10 22:41:02 -0800669 tty_ldisc_debug(tty, "%p: hangup\n", tty->ldisc);
Peter Hurleyfc575ee2013-03-11 16:44:38 -0400670
Alan Coxc65c9bc2009-06-11 12:50:12 +0100671 ld = tty_ldisc_ref(tty);
672 if (ld != NULL) {
Alan Coxc65c9bc2009-06-11 12:50:12 +0100673 if (ld->ops->flush_buffer)
674 ld->ops->flush_buffer(tty);
675 tty_driver_flush_buffer(tty);
676 if ((test_bit(TTY_DO_WRITE_WAKEUP, &tty->flags)) &&
677 ld->ops->write_wakeup)
678 ld->ops->write_wakeup(tty);
679 if (ld->ops->hangup)
680 ld->ops->hangup(tty);
681 tty_ldisc_deref(ld);
682 }
Peter Hurley36697522013-06-15 07:04:48 -0400683
Alan Coxc65c9bc2009-06-11 12:50:12 +0100684 wake_up_interruptible_poll(&tty->write_wait, POLLOUT);
685 wake_up_interruptible_poll(&tty->read_wait, POLLIN);
Peter Hurley36697522013-06-15 07:04:48 -0400686
Alan Coxc65c9bc2009-06-11 12:50:12 +0100687 /*
688 * Shutdown the current line discipline, and reset it to
Alan Cox638b9642010-02-08 10:09:26 +0000689 * N_TTY if need be.
690 *
691 * Avoid racing set_ldisc or tty_ldisc_release
Alan Coxc65c9bc2009-06-11 12:50:12 +0100692 */
Peter Hurleyfae76e92014-11-05 12:13:07 -0500693 tty_ldisc_lock(tty, MAX_SCHEDULE_TIMEOUT);
Arnd Bergmann60af22d2010-06-01 22:53:06 +0200694
Peter Hurley892d1fa2016-01-10 22:41:06 -0800695 if (tty->driver->flags & TTY_DRIVER_RESET_TERMIOS)
Alan Cox638b9642010-02-08 10:09:26 +0000696 tty_reset_termios(tty);
Peter Hurleyfc575ee2013-03-11 16:44:38 -0400697
Peter Hurley892d1fa2016-01-10 22:41:06 -0800698 if (tty->ldisc) {
699 if (reinit) {
700 if (tty_ldisc_reinit(tty, tty->termios.c_line) < 0)
701 tty_ldisc_reinit(tty, N_TTY);
702 } else
703 tty_ldisc_kill(tty);
704 }
705 tty_ldisc_unlock(tty);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100706}
Alan Cox01e1abb2008-07-22 11:16:55 +0100707
708/**
709 * tty_ldisc_setup - open line discipline
710 * @tty: tty being shut down
711 * @o_tty: pair tty for pty/tty pairs
712 *
713 * Called during the initial open of a tty/pty pair in order to set up the
Alan Coxc65c9bc2009-06-11 12:50:12 +0100714 * line disciplines and bind them to the tty. This has no locking issues
715 * as the device isn't yet active.
Alan Cox01e1abb2008-07-22 11:16:55 +0100716 */
717
718int tty_ldisc_setup(struct tty_struct *tty, struct tty_struct *o_tty)
719{
Peter Hurley9de2a7c2016-01-10 22:41:08 -0800720 int retval = tty_ldisc_open(tty, tty->ldisc);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100721 if (retval)
722 return retval;
723
724 if (o_tty) {
725 retval = tty_ldisc_open(o_tty, o_tty->ldisc);
Alan Cox01e1abb2008-07-22 11:16:55 +0100726 if (retval) {
Peter Hurley9de2a7c2016-01-10 22:41:08 -0800727 tty_ldisc_close(tty, tty->ldisc);
Alan Cox01e1abb2008-07-22 11:16:55 +0100728 return retval;
729 }
Alan Cox01e1abb2008-07-22 11:16:55 +0100730 }
Alan Cox01e1abb2008-07-22 11:16:55 +0100731 return 0;
732}
Alan Cox89c8d912012-08-08 16:30:13 +0100733
Alan Cox01e1abb2008-07-22 11:16:55 +0100734/**
735 * tty_ldisc_release - release line discipline
Peter Hurley62462ae2014-11-05 12:12:58 -0500736 * @tty: tty being shut down (or one end of pty pair)
Alan Cox01e1abb2008-07-22 11:16:55 +0100737 *
Peter Hurley62462ae2014-11-05 12:12:58 -0500738 * Called during the final close of a tty or a pty pair in order to shut
Peter Hurley5b6e6832016-01-10 22:41:00 -0800739 * down the line discpline layer. On exit, each tty's ldisc is NULL.
Alan Cox01e1abb2008-07-22 11:16:55 +0100740 */
741
Peter Hurley62462ae2014-11-05 12:12:58 -0500742void tty_ldisc_release(struct tty_struct *tty)
Alan Cox01e1abb2008-07-22 11:16:55 +0100743{
Peter Hurley62462ae2014-11-05 12:12:58 -0500744 struct tty_struct *o_tty = tty->link;
745
Alan Cox01e1abb2008-07-22 11:16:55 +0100746 /*
Peter Hurleya2965b72013-03-11 16:44:35 -0400747 * Shutdown this line discipline. As this is the final close,
748 * it does not race with the set_ldisc code path.
Alan Cox01e1abb2008-07-22 11:16:55 +0100749 */
Alan Cox01e1abb2008-07-22 11:16:55 +0100750
Peter Hurley36697522013-06-15 07:04:48 -0400751 tty_ldisc_lock_pair(tty, o_tty);
Alan Cox89c8d912012-08-08 16:30:13 +0100752 tty_ldisc_kill(tty);
Alan Cox89c8d912012-08-08 16:30:13 +0100753 if (o_tty)
754 tty_ldisc_kill(o_tty);
Peter Hurley36697522013-06-15 07:04:48 -0400755 tty_ldisc_unlock_pair(tty, o_tty);
756
Alan Coxaef29bc2009-06-29 15:21:47 +0100757 /* And the memory resources remaining (buffers, termios) will be
758 disposed of when the kref hits zero */
Peter Hurleyfc575ee2013-03-11 16:44:38 -0400759
Peter Hurleyfb6edc92015-07-12 22:49:12 -0400760 tty_ldisc_debug(tty, "released\n");
Alan Cox01e1abb2008-07-22 11:16:55 +0100761}
762
763/**
764 * tty_ldisc_init - ldisc setup for new tty
765 * @tty: tty being allocated
766 *
767 * Set up the line discipline objects for a newly allocated tty. Note that
768 * the tty structure is not completely set up when this call is made.
769 */
770
Tetsuo Handa6a506d42018-04-05 19:40:16 +0900771int tty_ldisc_init(struct tty_struct *tty)
Alan Cox01e1abb2008-07-22 11:16:55 +0100772{
Peter Hurley36697522013-06-15 07:04:48 -0400773 struct tty_ldisc *ld = tty_ldisc_get(tty, N_TTY);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100774 if (IS_ERR(ld))
Tetsuo Handa6a506d42018-04-05 19:40:16 +0900775 return PTR_ERR(ld);
Peter Hurleyf48070452013-03-11 16:44:42 -0400776 tty->ldisc = ld;
Tetsuo Handa6a506d42018-04-05 19:40:16 +0900777 return 0;
Alan Cox01e1abb2008-07-22 11:16:55 +0100778}
779
Jiri Slaby67166712011-03-23 10:48:35 +0100780/**
Peter Hurleyc8b710b2016-01-09 21:13:46 -0800781 * tty_ldisc_deinit - ldisc cleanup for new tty
Jiri Slaby67166712011-03-23 10:48:35 +0100782 * @tty: tty that was allocated recently
783 *
784 * The tty structure must not becompletely set up (tty_ldisc_setup) when
785 * this call is made.
786 */
787void tty_ldisc_deinit(struct tty_struct *tty)
788{
Peter Hurleyc8b710b2016-01-09 21:13:46 -0800789 if (tty->ldisc)
790 tty_ldisc_put(tty->ldisc);
Peter Hurleyf48070452013-03-11 16:44:42 -0400791 tty->ldisc = NULL;
Jiri Slaby67166712011-03-23 10:48:35 +0100792}
Greg Kroah-Hartman9b7984e2019-01-21 17:26:42 +0100793
794static int zero;
795static int one = 1;
796static struct ctl_table tty_table[] = {
797 {
798 .procname = "ldisc_autoload",
799 .data = &tty_ldisc_autoload,
800 .maxlen = sizeof(tty_ldisc_autoload),
801 .mode = 0644,
802 .proc_handler = proc_dointvec,
803 .extra1 = &zero,
804 .extra2 = &one,
805 },
806 { }
807};
808
809static struct ctl_table tty_dir_table[] = {
810 {
811 .procname = "tty",
812 .mode = 0555,
813 .child = tty_table,
814 },
815 { }
816};
817
818static struct ctl_table tty_root_table[] = {
819 {
820 .procname = "dev",
821 .mode = 0555,
822 .child = tty_dir_table,
823 },
824 { }
825};
826
827void tty_sysctl_init(void)
828{
829 register_sysctl_table(tty_root_table);
830}