blob: 2fe216b276e29ee54d6dd804555f27668407875a [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
Peter Hurley36697522013-06-15 07:04:48 -0400158static struct tty_ldisc *tty_ldisc_get(struct tty_struct *tty, int disc)
Alan Cox01e1abb2008-07-22 11:16:55 +0100159{
Alan Coxc65c9bc2009-06-11 12:50:12 +0100160 struct tty_ldisc *ld;
Linus Torvalds182274f2009-08-03 16:01:28 -0700161 struct tty_ldisc_ops *ldops;
Alan Cox01e1abb2008-07-22 11:16:55 +0100162
163 if (disc < N_TTY || disc >= NR_LDISCS)
Alan Coxc65c9bc2009-06-11 12:50:12 +0100164 return ERR_PTR(-EINVAL);
Linus Torvalds182274f2009-08-03 16:01:28 -0700165
166 /*
167 * Get the ldisc ops - we may need to request them to be loaded
168 * dynamically and try again.
169 */
170 ldops = get_ldops(disc);
171 if (IS_ERR(ldops)) {
Alan Cox01e1abb2008-07-22 11:16:55 +0100172 request_module("tty-ldisc-%d", disc);
Linus Torvalds182274f2009-08-03 16:01:28 -0700173 ldops = get_ldops(disc);
174 if (IS_ERR(ldops))
175 return ERR_CAST(ldops);
Alan Cox01e1abb2008-07-22 11:16:55 +0100176 }
Linus Torvalds182274f2009-08-03 16:01:28 -0700177
178 ld = kmalloc(sizeof(struct tty_ldisc), GFP_KERNEL);
179 if (ld == NULL) {
180 put_ldops(ldops);
181 return ERR_PTR(-ENOMEM);
182 }
183
184 ld->ops = ldops;
Peter Hurley36697522013-06-15 07:04:48 -0400185 ld->tty = tty;
Ivo Sieben1541f842012-05-03 14:37:43 +0200186
Alan Coxc65c9bc2009-06-11 12:50:12 +0100187 return ld;
Alan Cox01e1abb2008-07-22 11:16:55 +0100188}
189
Peter Hurley734de242013-03-11 16:44:43 -0400190/**
191 * tty_ldisc_put - release the ldisc
192 *
193 * Complement of tty_ldisc_get().
194 */
Denys Vlasenkocb128f62015-10-27 17:40:02 +0100195static void tty_ldisc_put(struct tty_ldisc *ld)
Peter Hurley734de242013-03-11 16:44:43 -0400196{
Peter Hurley734de242013-03-11 16:44:43 -0400197 if (WARN_ON_ONCE(!ld))
198 return;
199
Peter Hurley36697522013-06-15 07:04:48 -0400200 put_ldops(ld->ops);
Peter Hurley734de242013-03-11 16:44:43 -0400201 kfree(ld);
Peter Hurley734de242013-03-11 16:44:43 -0400202}
203
Alan Cox852e99d2009-06-11 12:51:41 +0100204static void *tty_ldiscs_seq_start(struct seq_file *m, loff_t *pos)
Alan Cox01e1abb2008-07-22 11:16:55 +0100205{
206 return (*pos < NR_LDISCS) ? pos : NULL;
207}
208
Alan Cox852e99d2009-06-11 12:51:41 +0100209static void *tty_ldiscs_seq_next(struct seq_file *m, void *v, loff_t *pos)
Alan Cox01e1abb2008-07-22 11:16:55 +0100210{
211 (*pos)++;
212 return (*pos < NR_LDISCS) ? pos : NULL;
213}
214
215static void tty_ldiscs_seq_stop(struct seq_file *m, void *v)
216{
217}
218
219static int tty_ldiscs_seq_show(struct seq_file *m, void *v)
220{
221 int i = *(loff_t *)v;
Linus Torvaldsf0de0e82009-08-03 16:00:15 -0700222 struct tty_ldisc_ops *ldops;
Alan Cox852e99d2009-06-11 12:51:41 +0100223
Linus Torvaldsf0de0e82009-08-03 16:00:15 -0700224 ldops = get_ldops(i);
225 if (IS_ERR(ldops))
Alan Cox01e1abb2008-07-22 11:16:55 +0100226 return 0;
Linus Torvaldsf0de0e82009-08-03 16:00:15 -0700227 seq_printf(m, "%-10s %2d\n", ldops->name ? ldops->name : "???", i);
228 put_ldops(ldops);
Alan Cox01e1abb2008-07-22 11:16:55 +0100229 return 0;
230}
231
232static const struct seq_operations tty_ldiscs_seq_ops = {
233 .start = tty_ldiscs_seq_start,
234 .next = tty_ldiscs_seq_next,
235 .stop = tty_ldiscs_seq_stop,
236 .show = tty_ldiscs_seq_show,
237};
238
239static int proc_tty_ldiscs_open(struct inode *inode, struct file *file)
240{
241 return seq_open(file, &tty_ldiscs_seq_ops);
242}
243
244const struct file_operations tty_ldiscs_proc_fops = {
245 .owner = THIS_MODULE,
246 .open = proc_tty_ldiscs_open,
247 .read = seq_read,
248 .llseek = seq_lseek,
249 .release = seq_release,
250};
251
252/**
Alan Cox01e1abb2008-07-22 11:16:55 +0100253 * tty_ldisc_ref_wait - wait for the tty ldisc
254 * @tty: tty device
255 *
256 * Dereference the line discipline for the terminal and take a
257 * reference to it. If the line discipline is in flux then
258 * wait patiently until it changes.
259 *
Peter Hurley892d1fa2016-01-10 22:41:06 -0800260 * Returns: NULL if the tty has been hungup and not re-opened with
261 * a new file descriptor, otherwise valid ldisc reference
262 *
Alan Cox01e1abb2008-07-22 11:16:55 +0100263 * Note: Must not be called from an IRQ/timer context. The caller
264 * must also be careful not to hold other locks that will deadlock
265 * against a discipline change, such as an existing ldisc reference
266 * (which we check for)
267 *
Peter Hurleye55afd12016-01-10 22:41:01 -0800268 * Note: a file_operations routine (read/poll/write) should use this
269 * function to wait for any ldisc lifetime events to finish.
Alan Cox01e1abb2008-07-22 11:16:55 +0100270 */
271
272struct tty_ldisc *tty_ldisc_ref_wait(struct tty_struct *tty)
273{
Dmitry Vyukova4a3e062017-03-04 13:46:12 +0100274 struct tty_ldisc *ld;
275
Peter Hurley36697522013-06-15 07:04:48 -0400276 ldsem_down_read(&tty->ldisc_sem, MAX_SCHEDULE_TIMEOUT);
Dmitry Vyukova4a3e062017-03-04 13:46:12 +0100277 ld = tty->ldisc;
278 if (!ld)
Peter Hurleya570a492016-01-10 22:41:02 -0800279 ldsem_up_read(&tty->ldisc_sem);
Dmitry Vyukova4a3e062017-03-04 13:46:12 +0100280 return ld;
Alan Cox01e1abb2008-07-22 11:16:55 +0100281}
Alan Cox01e1abb2008-07-22 11:16:55 +0100282EXPORT_SYMBOL_GPL(tty_ldisc_ref_wait);
283
284/**
285 * tty_ldisc_ref - get the tty ldisc
286 * @tty: tty device
287 *
288 * Dereference the line discipline for the terminal and take a
289 * reference to it. If the line discipline is in flux then
290 * return NULL. Can be called from IRQ and timer functions.
Alan Cox01e1abb2008-07-22 11:16:55 +0100291 */
292
293struct tty_ldisc *tty_ldisc_ref(struct tty_struct *tty)
294{
Peter Hurley36697522013-06-15 07:04:48 -0400295 struct tty_ldisc *ld = NULL;
296
297 if (ldsem_down_read_trylock(&tty->ldisc_sem)) {
298 ld = tty->ldisc;
299 if (!ld)
300 ldsem_up_read(&tty->ldisc_sem);
301 }
302 return ld;
Alan Cox01e1abb2008-07-22 11:16:55 +0100303}
Alan Cox01e1abb2008-07-22 11:16:55 +0100304EXPORT_SYMBOL_GPL(tty_ldisc_ref);
305
306/**
307 * tty_ldisc_deref - free a tty ldisc reference
308 * @ld: reference to free up
309 *
310 * Undoes the effect of tty_ldisc_ref or tty_ldisc_ref_wait. May
311 * be called in IRQ context.
Alan Cox01e1abb2008-07-22 11:16:55 +0100312 */
313
314void tty_ldisc_deref(struct tty_ldisc *ld)
315{
Peter Hurley36697522013-06-15 07:04:48 -0400316 ldsem_up_read(&ld->tty->ldisc_sem);
Alan Cox01e1abb2008-07-22 11:16:55 +0100317}
Alan Cox01e1abb2008-07-22 11:16:55 +0100318EXPORT_SYMBOL_GPL(tty_ldisc_deref);
319
Peter Hurleyd2c43892013-06-15 07:04:47 -0400320
Peter Hurleyc2bb5242016-01-09 21:13:51 -0800321static inline int
Peter Hurleye80a10e2014-11-05 12:13:06 -0500322__tty_ldisc_lock(struct tty_struct *tty, unsigned long timeout)
Peter Hurleyd2c43892013-06-15 07:04:47 -0400323{
324 return ldsem_down_write(&tty->ldisc_sem, timeout);
325}
326
Peter Hurleyc2bb5242016-01-09 21:13:51 -0800327static inline int
Peter Hurleye80a10e2014-11-05 12:13:06 -0500328__tty_ldisc_lock_nested(struct tty_struct *tty, unsigned long timeout)
Peter Hurleyd2c43892013-06-15 07:04:47 -0400329{
330 return ldsem_down_write_nested(&tty->ldisc_sem,
331 LDISC_SEM_OTHER, timeout);
332}
333
Peter Hurleye80a10e2014-11-05 12:13:06 -0500334static inline void __tty_ldisc_unlock(struct tty_struct *tty)
Peter Hurleyd2c43892013-06-15 07:04:47 -0400335{
Guillaume Gomez52772ea2015-10-04 21:19:18 +0200336 ldsem_up_write(&tty->ldisc_sem);
Peter Hurleyd2c43892013-06-15 07:04:47 -0400337}
338
Peter Hurleyc2bb5242016-01-09 21:13:51 -0800339static int tty_ldisc_lock(struct tty_struct *tty, unsigned long timeout)
Peter Hurleyfae76e92014-11-05 12:13:07 -0500340{
341 int ret;
342
343 ret = __tty_ldisc_lock(tty, timeout);
344 if (!ret)
345 return -EBUSY;
346 set_bit(TTY_LDISC_HALTED, &tty->flags);
347 return 0;
348}
349
350static void tty_ldisc_unlock(struct tty_struct *tty)
351{
352 clear_bit(TTY_LDISC_HALTED, &tty->flags);
353 __tty_ldisc_unlock(tty);
354}
355
Peter Hurleyc2bb5242016-01-09 21:13:51 -0800356static int
Peter Hurleyd2c43892013-06-15 07:04:47 -0400357tty_ldisc_lock_pair_timeout(struct tty_struct *tty, struct tty_struct *tty2,
358 unsigned long timeout)
359{
360 int ret;
361
362 if (tty < tty2) {
Peter Hurleye80a10e2014-11-05 12:13:06 -0500363 ret = __tty_ldisc_lock(tty, timeout);
Peter Hurleyd2c43892013-06-15 07:04:47 -0400364 if (ret) {
Peter Hurleye80a10e2014-11-05 12:13:06 -0500365 ret = __tty_ldisc_lock_nested(tty2, timeout);
Peter Hurleyd2c43892013-06-15 07:04:47 -0400366 if (!ret)
Peter Hurleye80a10e2014-11-05 12:13:06 -0500367 __tty_ldisc_unlock(tty);
Peter Hurleyd2c43892013-06-15 07:04:47 -0400368 }
369 } else {
370 /* if this is possible, it has lots of implications */
371 WARN_ON_ONCE(tty == tty2);
372 if (tty2 && tty != tty2) {
Peter Hurleye80a10e2014-11-05 12:13:06 -0500373 ret = __tty_ldisc_lock(tty2, timeout);
Peter Hurleyd2c43892013-06-15 07:04:47 -0400374 if (ret) {
Peter Hurleye80a10e2014-11-05 12:13:06 -0500375 ret = __tty_ldisc_lock_nested(tty, timeout);
Peter Hurleyd2c43892013-06-15 07:04:47 -0400376 if (!ret)
Peter Hurleye80a10e2014-11-05 12:13:06 -0500377 __tty_ldisc_unlock(tty2);
Peter Hurleyd2c43892013-06-15 07:04:47 -0400378 }
379 } else
Peter Hurleye80a10e2014-11-05 12:13:06 -0500380 ret = __tty_ldisc_lock(tty, timeout);
Peter Hurleyd2c43892013-06-15 07:04:47 -0400381 }
382
383 if (!ret)
384 return -EBUSY;
385
386 set_bit(TTY_LDISC_HALTED, &tty->flags);
387 if (tty2)
388 set_bit(TTY_LDISC_HALTED, &tty2->flags);
389 return 0;
390}
391
Peter Hurleyc2bb5242016-01-09 21:13:51 -0800392static void tty_ldisc_lock_pair(struct tty_struct *tty, struct tty_struct *tty2)
Peter Hurleyd2c43892013-06-15 07:04:47 -0400393{
394 tty_ldisc_lock_pair_timeout(tty, tty2, MAX_SCHEDULE_TIMEOUT);
395}
396
Peter Hurleyc2bb5242016-01-09 21:13:51 -0800397static void tty_ldisc_unlock_pair(struct tty_struct *tty,
398 struct tty_struct *tty2)
Peter Hurleyd2c43892013-06-15 07:04:47 -0400399{
Peter Hurleye80a10e2014-11-05 12:13:06 -0500400 __tty_ldisc_unlock(tty);
Peter Hurleyd2c43892013-06-15 07:04:47 -0400401 if (tty2)
Peter Hurleye80a10e2014-11-05 12:13:06 -0500402 __tty_ldisc_unlock(tty2);
Peter Hurleyd2c43892013-06-15 07:04:47 -0400403}
404
Alan Cox01e1abb2008-07-22 11:16:55 +0100405/**
Alan Coxf2c4c652009-06-11 12:50:58 +0100406 * tty_ldisc_flush - flush line discipline queue
407 * @tty: tty
408 *
Peter Hurley86c80a82014-11-05 12:13:09 -0500409 * Flush the line discipline queue (if any) and the tty flip buffers
410 * for this tty.
Alan Coxf2c4c652009-06-11 12:50:58 +0100411 */
412
413void tty_ldisc_flush(struct tty_struct *tty)
414{
415 struct tty_ldisc *ld = tty_ldisc_ref(tty);
Peter Hurley86c80a82014-11-05 12:13:09 -0500416
417 tty_buffer_flush(tty, ld);
418 if (ld)
Alan Coxf2c4c652009-06-11 12:50:58 +0100419 tty_ldisc_deref(ld);
Alan Coxf2c4c652009-06-11 12:50:58 +0100420}
Alan Coxf2c4c652009-06-11 12:50:58 +0100421EXPORT_SYMBOL_GPL(tty_ldisc_flush);
422
423/**
Alan Cox01e1abb2008-07-22 11:16:55 +0100424 * tty_set_termios_ldisc - set ldisc field
425 * @tty: tty structure
Peter Hurleyc12da962016-01-10 22:41:04 -0800426 * @disc: line discipline number
Alan Cox01e1abb2008-07-22 11:16:55 +0100427 *
428 * This is probably overkill for real world processors but
429 * they are not on hot paths so a little discipline won't do
430 * any harm.
431 *
Peter Hurleydd42bf12015-11-27 14:30:21 -0500432 * The line discipline-related tty_struct fields are reset to
433 * prevent the ldisc driver from re-using stale information for
434 * the new ldisc instance.
435 *
Peter Hurley6a1c0682013-06-15 09:14:23 -0400436 * Locking: takes termios_rwsem
Alan Cox01e1abb2008-07-22 11:16:55 +0100437 */
438
Peter Hurleyc12da962016-01-10 22:41:04 -0800439static void tty_set_termios_ldisc(struct tty_struct *tty, int disc)
Alan Cox01e1abb2008-07-22 11:16:55 +0100440{
Peter Hurley6a1c0682013-06-15 09:14:23 -0400441 down_write(&tty->termios_rwsem);
Peter Hurleyc12da962016-01-10 22:41:04 -0800442 tty->termios.c_line = disc;
Peter Hurley6a1c0682013-06-15 09:14:23 -0400443 up_write(&tty->termios_rwsem);
Peter Hurleydd42bf12015-11-27 14:30:21 -0500444
445 tty->disc_data = NULL;
446 tty->receive_room = 0;
Alan Cox01e1abb2008-07-22 11:16:55 +0100447}
448
Alan Coxc65c9bc2009-06-11 12:50:12 +0100449/**
450 * tty_ldisc_open - open a line discipline
451 * @tty: tty we are opening the ldisc on
452 * @ld: discipline to open
453 *
454 * A helper opening method. Also a convenient debugging and check
455 * point.
Arnd Bergmannec79d602010-06-01 22:53:01 +0200456 *
457 * Locking: always called with BTM already held.
Alan Coxc65c9bc2009-06-11 12:50:12 +0100458 */
459
460static int tty_ldisc_open(struct tty_struct *tty, struct tty_ldisc *ld)
461{
462 WARN_ON(test_and_set_bit(TTY_LDISC_OPEN, &tty->flags));
Alan Coxf18f9492009-11-30 13:18:35 +0000463 if (ld->ops->open) {
464 int ret;
Arnd Bergmannec79d602010-06-01 22:53:01 +0200465 /* BTM here locks versus a hangup event */
Alan Coxf18f9492009-11-30 13:18:35 +0000466 ret = ld->ops->open(tty);
Jiri Slaby7f90cfc2010-11-25 00:27:54 +0100467 if (ret)
468 clear_bit(TTY_LDISC_OPEN, &tty->flags);
Peter Hurleyfb6edc92015-07-12 22:49:12 -0400469
Peter Hurleya570a492016-01-10 22:41:02 -0800470 tty_ldisc_debug(tty, "%p: opened\n", ld);
Alan Coxf18f9492009-11-30 13:18:35 +0000471 return ret;
472 }
Alan Coxc65c9bc2009-06-11 12:50:12 +0100473 return 0;
474}
475
476/**
477 * tty_ldisc_close - close a line discipline
478 * @tty: tty we are opening the ldisc on
479 * @ld: discipline to close
480 *
481 * A helper close method. Also a convenient debugging and check
482 * point.
483 */
484
485static void tty_ldisc_close(struct tty_struct *tty, struct tty_ldisc *ld)
486{
487 WARN_ON(!test_bit(TTY_LDISC_OPEN, &tty->flags));
488 clear_bit(TTY_LDISC_OPEN, &tty->flags);
489 if (ld->ops->close)
490 ld->ops->close(tty);
Peter Hurleya570a492016-01-10 22:41:02 -0800491 tty_ldisc_debug(tty, "%p: closed\n", ld);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100492}
Alan Cox01e1abb2008-07-22 11:16:55 +0100493
494/**
Alan Cox8a8dabf2017-06-02 13:49:30 +0100495 * tty_ldisc_failto - helper for ldisc failback
496 * @tty: tty to open the ldisc on
497 * @ld: ldisc we are trying to fail back to
498 *
499 * Helper to try and recover a tty when switching back to the old
500 * ldisc fails and we need something attached.
501 */
502
503static int tty_ldisc_failto(struct tty_struct *tty, int ld)
504{
505 struct tty_ldisc *disc = tty_ldisc_get(tty, ld);
506 int r;
507
508 if (IS_ERR(disc))
509 return PTR_ERR(disc);
510 tty->ldisc = disc;
511 tty_set_termios_ldisc(tty, ld);
512 if ((r = tty_ldisc_open(tty, disc)) < 0)
513 tty_ldisc_put(disc);
514 return r;
515}
516
517/**
Greg Kroah-Hartmana8983d02017-04-14 10:57:52 +0200518 * tty_ldisc_restore - helper for tty ldisc change
519 * @tty: tty to recover
520 * @old: previous ldisc
521 *
522 * Restore the previous line discipline or N_TTY when a line discipline
523 * change fails due to an open error
524 */
525
526static void tty_ldisc_restore(struct tty_struct *tty, struct tty_ldisc *old)
527{
Greg Kroah-Hartmana8983d02017-04-14 10:57:52 +0200528 /* There is an outstanding reference here so this is safe */
529 old = tty_ldisc_get(tty, old->ops->num);
530 WARN_ON(IS_ERR(old));
531 tty->ldisc = old;
532 tty_set_termios_ldisc(tty, old->ops->num);
533 if (tty_ldisc_open(tty, old) < 0) {
534 tty_ldisc_put(old);
Alan Cox8a8dabf2017-06-02 13:49:30 +0100535 /* The traditional behaviour is to fall back to N_TTY, we
536 want to avoid falling back to N_NULL unless we have no
537 choice to avoid the risk of breaking anything */
538 if (tty_ldisc_failto(tty, N_TTY) < 0 &&
539 tty_ldisc_failto(tty, N_NULL) < 0)
540 panic("Couldn't open N_NULL ldisc for %s.",
541 tty_name(tty));
Greg Kroah-Hartmana8983d02017-04-14 10:57:52 +0200542 }
543}
544
545/**
Alan Cox01e1abb2008-07-22 11:16:55 +0100546 * tty_set_ldisc - set line discipline
547 * @tty: the terminal to set
548 * @ldisc: the line discipline
549 *
550 * Set the discipline of a tty line. Must be called from a process
Alan Coxc65c9bc2009-06-11 12:50:12 +0100551 * context. The ldisc change logic has to protect itself against any
552 * overlapping ldisc change (including on the other end of pty pairs),
553 * the close of one side of a tty/pty pair, and eventually hangup.
Alan Cox01e1abb2008-07-22 11:16:55 +0100554 */
555
Peter Hurleyc12da962016-01-10 22:41:04 -0800556int tty_set_ldisc(struct tty_struct *tty, int disc)
Alan Cox01e1abb2008-07-22 11:16:55 +0100557{
Greg Kroah-Hartmana8983d02017-04-14 10:57:52 +0200558 int retval;
559 struct tty_ldisc *old_ldisc, *new_ldisc;
560
561 new_ldisc = tty_ldisc_get(tty, disc);
562 if (IS_ERR(new_ldisc))
563 return PTR_ERR(new_ldisc);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100564
Peter Hurleyc8483bc2014-11-05 12:12:45 -0500565 tty_lock(tty);
Peter Hurley276a6612014-11-05 12:13:08 -0500566 retval = tty_ldisc_lock(tty, 5 * HZ);
Peter Hurley63d8cb32015-11-08 09:29:38 -0500567 if (retval)
568 goto err;
Alan Coxc65c9bc2009-06-11 12:50:12 +0100569
Peter Hurleya570a492016-01-10 22:41:02 -0800570 if (!tty->ldisc) {
571 retval = -EIO;
572 goto out;
573 }
574
Peter Hurley63d8cb32015-11-08 09:29:38 -0500575 /* Check the no-op case */
Greg Kroah-Hartmana8983d02017-04-14 10:57:52 +0200576 if (tty->ldisc->ops->num == disc)
Peter Hurley63d8cb32015-11-08 09:29:38 -0500577 goto out;
Alan Coxc65c9bc2009-06-11 12:50:12 +0100578
Peter Hurley63d8cb32015-11-08 09:29:38 -0500579 if (test_bit(TTY_HUPPED, &tty->flags)) {
580 /* We were raced by hangup */
581 retval = -EIO;
582 goto out;
Alan Coxc65c9bc2009-06-11 12:50:12 +0100583 }
Alan Cox01e1abb2008-07-22 11:16:55 +0100584
Greg Kroah-Hartmana8983d02017-04-14 10:57:52 +0200585 old_ldisc = tty->ldisc;
586
587 /* Shutdown the old discipline. */
588 tty_ldisc_close(tty, old_ldisc);
589
590 /* Now set up the new line discipline. */
591 tty->ldisc = new_ldisc;
592 tty_set_termios_ldisc(tty, disc);
593
594 retval = tty_ldisc_open(tty, new_ldisc);
Alan Cox01e1abb2008-07-22 11:16:55 +0100595 if (retval < 0) {
Alan Coxc65c9bc2009-06-11 12:50:12 +0100596 /* Back to the old one or N_TTY if we can't */
Greg Kroah-Hartmana8983d02017-04-14 10:57:52 +0200597 tty_ldisc_put(new_ldisc);
598 tty_ldisc_restore(tty, old_ldisc);
Alan Cox01e1abb2008-07-22 11:16:55 +0100599 }
Alan Coxc65c9bc2009-06-11 12:50:12 +0100600
Greg Kroah-Hartmana8983d02017-04-14 10:57:52 +0200601 if (tty->ldisc->ops->num != old_ldisc->ops->num && tty->ops->set_ldisc) {
Peter Hurley9191aaa2014-11-05 13:11:41 -0500602 down_read(&tty->termios_rwsem);
Alan Cox01e1abb2008-07-22 11:16:55 +0100603 tty->ops->set_ldisc(tty);
Peter Hurley9191aaa2014-11-05 13:11:41 -0500604 up_read(&tty->termios_rwsem);
605 }
Alan Cox01e1abb2008-07-22 11:16:55 +0100606
Greg Kroah-Hartmana8983d02017-04-14 10:57:52 +0200607 /* At this point we hold a reference to the new ldisc and a
608 reference to the old ldisc, or we hold two references to
609 the old ldisc (if it was restored as part of error cleanup
610 above). In either case, releasing a single reference from
611 the old ldisc is correct. */
612 new_ldisc = old_ldisc;
Peter Hurley63d8cb32015-11-08 09:29:38 -0500613out:
Peter Hurley276a6612014-11-05 12:13:08 -0500614 tty_ldisc_unlock(tty);
Alan Cox01e1abb2008-07-22 11:16:55 +0100615
Alan Coxc65c9bc2009-06-11 12:50:12 +0100616 /* Restart the work queue in case no characters kick it off. Safe if
Alan Cox01e1abb2008-07-22 11:16:55 +0100617 already running */
Peter Hurley17a69212015-11-08 07:53:06 -0500618 tty_buffer_restart_work(tty->port);
Peter Hurley63d8cb32015-11-08 09:29:38 -0500619err:
Greg Kroah-Hartmana8983d02017-04-14 10:57:52 +0200620 tty_ldisc_put(new_ldisc); /* drop the extra reference */
Alan Cox89c8d912012-08-08 16:30:13 +0100621 tty_unlock(tty);
Alan Cox01e1abb2008-07-22 11:16:55 +0100622 return retval;
623}
Okash Khawaja1ab92da2017-05-15 18:45:33 +0100624EXPORT_SYMBOL_GPL(tty_set_ldisc);
Alan Cox01e1abb2008-07-22 11:16:55 +0100625
Alan Coxc65c9bc2009-06-11 12:50:12 +0100626/**
Peter Hurley6ffeb4b2016-01-10 22:41:03 -0800627 * tty_ldisc_kill - teardown ldisc
628 * @tty: tty being released
629 *
630 * Perform final close of the ldisc and reset tty->ldisc
631 */
632static void tty_ldisc_kill(struct tty_struct *tty)
633{
634 if (!tty->ldisc)
635 return;
636 /*
637 * Now kill off the ldisc
638 */
639 tty_ldisc_close(tty, tty->ldisc);
640 tty_ldisc_put(tty->ldisc);
641 /* Force an oops if we mess this up */
642 tty->ldisc = NULL;
643}
644
645/**
Alan Coxc65c9bc2009-06-11 12:50:12 +0100646 * tty_reset_termios - reset terminal state
647 * @tty: tty to reset
648 *
649 * Restore a terminal to the driver default state.
650 */
651
652static void tty_reset_termios(struct tty_struct *tty)
653{
Peter Hurley6a1c0682013-06-15 09:14:23 -0400654 down_write(&tty->termios_rwsem);
Alan Coxadc8d742012-07-14 15:31:47 +0100655 tty->termios = tty->driver->init_termios;
656 tty->termios.c_ispeed = tty_termios_input_baud_rate(&tty->termios);
657 tty->termios.c_ospeed = tty_termios_baud_rate(&tty->termios);
Peter Hurley6a1c0682013-06-15 09:14:23 -0400658 up_write(&tty->termios_rwsem);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100659}
660
661
662/**
663 * tty_ldisc_reinit - reinitialise the tty ldisc
664 * @tty: tty to reinit
Peter Hurleyc12da962016-01-10 22:41:04 -0800665 * @disc: line discipline to reinitialize
Alan Coxc65c9bc2009-06-11 12:50:12 +0100666 *
Peter Hurley7896f302016-01-10 22:41:05 -0800667 * Completely reinitialize the line discipline state, by closing the
Peter Hurley892d1fa2016-01-10 22:41:06 -0800668 * current instance, if there is one, and opening a new instance. If
669 * an error occurs opening the new non-N_TTY instance, the instance
670 * is dropped and tty->ldisc reset to NULL. The caller can then retry
671 * with N_TTY instead.
Peter Hurley7896f302016-01-10 22:41:05 -0800672 *
673 * Returns 0 if successful, otherwise error code < 0
Alan Coxc65c9bc2009-06-11 12:50:12 +0100674 */
675
Peter Hurley892d1fa2016-01-10 22:41:06 -0800676int tty_ldisc_reinit(struct tty_struct *tty, int disc)
Alan Coxc65c9bc2009-06-11 12:50:12 +0100677{
Peter Hurley7896f302016-01-10 22:41:05 -0800678 struct tty_ldisc *ld;
679 int retval;
Philippe Rétornaz1c95ba12010-10-27 17:13:21 +0200680
Peter Hurley7896f302016-01-10 22:41:05 -0800681 ld = tty_ldisc_get(tty, disc);
Greg Kroah-Hartmana8983d02017-04-14 10:57:52 +0200682 if (IS_ERR(ld)) {
683 BUG_ON(disc == N_TTY);
Peter Hurley7896f302016-01-10 22:41:05 -0800684 return PTR_ERR(ld);
Greg Kroah-Hartmana8983d02017-04-14 10:57:52 +0200685 }
Alan Coxc65c9bc2009-06-11 12:50:12 +0100686
Peter Hurley7896f302016-01-10 22:41:05 -0800687 if (tty->ldisc) {
688 tty_ldisc_close(tty, tty->ldisc);
689 tty_ldisc_put(tty->ldisc);
690 }
691
692 /* switch the line discipline */
Peter Hurleyf48070452013-03-11 16:44:42 -0400693 tty->ldisc = ld;
Peter Hurleyc12da962016-01-10 22:41:04 -0800694 tty_set_termios_ldisc(tty, disc);
Peter Hurley7896f302016-01-10 22:41:05 -0800695 retval = tty_ldisc_open(tty, tty->ldisc);
696 if (retval) {
Greg Kroah-Hartmana8983d02017-04-14 10:57:52 +0200697 if (!WARN_ON(disc == N_TTY)) {
698 tty_ldisc_put(tty->ldisc);
699 tty->ldisc = NULL;
700 }
Peter Hurley7896f302016-01-10 22:41:05 -0800701 }
702 return retval;
Alan Coxc65c9bc2009-06-11 12:50:12 +0100703}
704
705/**
706 * tty_ldisc_hangup - hangup ldisc reset
707 * @tty: tty being hung up
708 *
709 * Some tty devices reset their termios when they receive a hangup
710 * event. In that situation we must also switch back to N_TTY properly
711 * before we reset the termios data.
712 *
713 * Locking: We can take the ldisc mutex as the rest of the code is
714 * careful to allow for this.
715 *
716 * In the pty pair case this occurs in the close() path of the
717 * tty itself so we must be careful about locking rules.
718 */
719
Peter Hurley892d1fa2016-01-10 22:41:06 -0800720void tty_ldisc_hangup(struct tty_struct *tty, bool reinit)
Alan Coxc65c9bc2009-06-11 12:50:12 +0100721{
722 struct tty_ldisc *ld;
723
Peter Hurleya570a492016-01-10 22:41:02 -0800724 tty_ldisc_debug(tty, "%p: hangup\n", tty->ldisc);
Peter Hurleyfc575ee2013-03-11 16:44:38 -0400725
Alan Coxc65c9bc2009-06-11 12:50:12 +0100726 ld = tty_ldisc_ref(tty);
727 if (ld != NULL) {
Alan Coxc65c9bc2009-06-11 12:50:12 +0100728 if (ld->ops->flush_buffer)
729 ld->ops->flush_buffer(tty);
730 tty_driver_flush_buffer(tty);
731 if ((test_bit(TTY_DO_WRITE_WAKEUP, &tty->flags)) &&
732 ld->ops->write_wakeup)
733 ld->ops->write_wakeup(tty);
734 if (ld->ops->hangup)
735 ld->ops->hangup(tty);
736 tty_ldisc_deref(ld);
737 }
Peter Hurley36697522013-06-15 07:04:48 -0400738
Alan Coxc65c9bc2009-06-11 12:50:12 +0100739 wake_up_interruptible_poll(&tty->write_wait, POLLOUT);
740 wake_up_interruptible_poll(&tty->read_wait, POLLIN);
Peter Hurley36697522013-06-15 07:04:48 -0400741
Alan Coxc65c9bc2009-06-11 12:50:12 +0100742 /*
743 * Shutdown the current line discipline, and reset it to
Alan Cox638b9642010-02-08 10:09:26 +0000744 * N_TTY if need be.
745 *
746 * Avoid racing set_ldisc or tty_ldisc_release
Alan Coxc65c9bc2009-06-11 12:50:12 +0100747 */
Peter Hurleyfae76e92014-11-05 12:13:07 -0500748 tty_ldisc_lock(tty, MAX_SCHEDULE_TIMEOUT);
Arnd Bergmann60af22d2010-06-01 22:53:06 +0200749
Peter Hurley892d1fa2016-01-10 22:41:06 -0800750 if (tty->driver->flags & TTY_DRIVER_RESET_TERMIOS)
Alan Cox638b9642010-02-08 10:09:26 +0000751 tty_reset_termios(tty);
Peter Hurleyfc575ee2013-03-11 16:44:38 -0400752
Peter Hurley892d1fa2016-01-10 22:41:06 -0800753 if (tty->ldisc) {
754 if (reinit) {
755 if (tty_ldisc_reinit(tty, tty->termios.c_line) < 0)
756 tty_ldisc_reinit(tty, N_TTY);
757 } else
758 tty_ldisc_kill(tty);
759 }
760 tty_ldisc_unlock(tty);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100761}
Alan Cox01e1abb2008-07-22 11:16:55 +0100762
763/**
764 * tty_ldisc_setup - open line discipline
765 * @tty: tty being shut down
766 * @o_tty: pair tty for pty/tty pairs
767 *
768 * Called during the initial open of a tty/pty pair in order to set up the
Alan Coxc65c9bc2009-06-11 12:50:12 +0100769 * line disciplines and bind them to the tty. This has no locking issues
770 * as the device isn't yet active.
Alan Cox01e1abb2008-07-22 11:16:55 +0100771 */
772
773int tty_ldisc_setup(struct tty_struct *tty, struct tty_struct *o_tty)
774{
Peter Hurley9de2a7c2016-01-10 22:41:08 -0800775 int retval = tty_ldisc_open(tty, tty->ldisc);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100776 if (retval)
777 return retval;
778
779 if (o_tty) {
780 retval = tty_ldisc_open(o_tty, o_tty->ldisc);
Alan Cox01e1abb2008-07-22 11:16:55 +0100781 if (retval) {
Peter Hurley9de2a7c2016-01-10 22:41:08 -0800782 tty_ldisc_close(tty, tty->ldisc);
Alan Cox01e1abb2008-07-22 11:16:55 +0100783 return retval;
784 }
Alan Cox01e1abb2008-07-22 11:16:55 +0100785 }
Alan Cox01e1abb2008-07-22 11:16:55 +0100786 return 0;
787}
Alan Cox89c8d912012-08-08 16:30:13 +0100788
Alan Cox01e1abb2008-07-22 11:16:55 +0100789/**
790 * tty_ldisc_release - release line discipline
Peter Hurley62462ae2014-11-05 12:12:58 -0500791 * @tty: tty being shut down (or one end of pty pair)
Alan Cox01e1abb2008-07-22 11:16:55 +0100792 *
Peter Hurley62462ae2014-11-05 12:12:58 -0500793 * Called during the final close of a tty or a pty pair in order to shut
Peter Hurley5b6e6832016-01-10 22:41:00 -0800794 * down the line discpline layer. On exit, each tty's ldisc is NULL.
Alan Cox01e1abb2008-07-22 11:16:55 +0100795 */
796
Peter Hurley62462ae2014-11-05 12:12:58 -0500797void tty_ldisc_release(struct tty_struct *tty)
Alan Cox01e1abb2008-07-22 11:16:55 +0100798{
Peter Hurley62462ae2014-11-05 12:12:58 -0500799 struct tty_struct *o_tty = tty->link;
800
Alan Cox01e1abb2008-07-22 11:16:55 +0100801 /*
Peter Hurleya2965b72013-03-11 16:44:35 -0400802 * Shutdown this line discipline. As this is the final close,
803 * it does not race with the set_ldisc code path.
Alan Cox01e1abb2008-07-22 11:16:55 +0100804 */
Alan Cox01e1abb2008-07-22 11:16:55 +0100805
Peter Hurley36697522013-06-15 07:04:48 -0400806 tty_ldisc_lock_pair(tty, o_tty);
Alan Cox89c8d912012-08-08 16:30:13 +0100807 tty_ldisc_kill(tty);
Alan Cox89c8d912012-08-08 16:30:13 +0100808 if (o_tty)
809 tty_ldisc_kill(o_tty);
Peter Hurley36697522013-06-15 07:04:48 -0400810 tty_ldisc_unlock_pair(tty, o_tty);
811
Alan Coxaef29bc2009-06-29 15:21:47 +0100812 /* And the memory resources remaining (buffers, termios) will be
813 disposed of when the kref hits zero */
Peter Hurleyfc575ee2013-03-11 16:44:38 -0400814
Peter Hurleyfb6edc92015-07-12 22:49:12 -0400815 tty_ldisc_debug(tty, "released\n");
Alan Cox01e1abb2008-07-22 11:16:55 +0100816}
Okash Khawaja1ab92da2017-05-15 18:45:33 +0100817EXPORT_SYMBOL_GPL(tty_ldisc_release);
Alan Cox01e1abb2008-07-22 11:16:55 +0100818
819/**
820 * tty_ldisc_init - ldisc setup for new tty
821 * @tty: tty being allocated
822 *
823 * Set up the line discipline objects for a newly allocated tty. Note that
824 * the tty structure is not completely set up when this call is made.
825 */
826
827void tty_ldisc_init(struct tty_struct *tty)
828{
Peter Hurley36697522013-06-15 07:04:48 -0400829 struct tty_ldisc *ld = tty_ldisc_get(tty, N_TTY);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100830 if (IS_ERR(ld))
Alan Cox01e1abb2008-07-22 11:16:55 +0100831 panic("n_tty: init_tty");
Peter Hurleyf48070452013-03-11 16:44:42 -0400832 tty->ldisc = ld;
Alan Cox01e1abb2008-07-22 11:16:55 +0100833}
834
Jiri Slaby67166712011-03-23 10:48:35 +0100835/**
Peter Hurleyc8b710b2016-01-09 21:13:46 -0800836 * tty_ldisc_deinit - ldisc cleanup for new tty
Jiri Slaby67166712011-03-23 10:48:35 +0100837 * @tty: tty that was allocated recently
838 *
839 * The tty structure must not becompletely set up (tty_ldisc_setup) when
840 * this call is made.
841 */
842void tty_ldisc_deinit(struct tty_struct *tty)
843{
Peter Hurleyc8b710b2016-01-09 21:13:46 -0800844 if (tty->ldisc)
845 tty_ldisc_put(tty->ldisc);
Peter Hurleyf48070452013-03-11 16:44:42 -0400846 tty->ldisc = NULL;
Jiri Slaby67166712011-03-23 10:48:35 +0100847}