blob: 3737f55272d2c1184463edc3714f89fb2724730e [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
25#define tty_ldisc_debug(tty, f, args...) ({ \
26 char __b[64]; \
27 printk(KERN_DEBUG "%s: %s: " f, __func__, tty_name(tty, __b), ##args); \
28})
29#else
30#define tty_ldisc_debug(tty, f, args...)
31#endif
32
Peter Hurleyd2c43892013-06-15 07:04:47 -040033/* lockdep nested classes for tty->ldisc_sem */
34enum {
35 LDISC_SEM_NORMAL,
36 LDISC_SEM_OTHER,
37};
38
39
Alan Cox01e1abb2008-07-22 11:16:55 +010040/*
41 * This guards the refcounted line discipline lists. The lock
42 * must be taken with irqs off because there are hangup path
43 * callers who will do ldisc lookups and cannot sleep.
44 */
45
Peter Hurley137084b2013-06-15 07:04:46 -040046static DEFINE_RAW_SPINLOCK(tty_ldiscs_lock);
Alan Cox01e1abb2008-07-22 11:16:55 +010047/* Line disc dispatch table */
48static struct tty_ldisc_ops *tty_ldiscs[NR_LDISCS];
49
50/**
51 * tty_register_ldisc - install a line discipline
52 * @disc: ldisc number
53 * @new_ldisc: pointer to the ldisc object
54 *
55 * Installs a new line discipline into the kernel. The discipline
56 * is set up as unreferenced and then made available to the kernel
57 * from this point onwards.
58 *
59 * Locking:
Peter Hurley137084b2013-06-15 07:04:46 -040060 * takes tty_ldiscs_lock to guard against ldisc races
Alan Cox01e1abb2008-07-22 11:16:55 +010061 */
62
63int tty_register_ldisc(int disc, struct tty_ldisc_ops *new_ldisc)
64{
65 unsigned long flags;
66 int ret = 0;
67
68 if (disc < N_TTY || disc >= NR_LDISCS)
69 return -EINVAL;
70
Peter Hurley137084b2013-06-15 07:04:46 -040071 raw_spin_lock_irqsave(&tty_ldiscs_lock, flags);
Alan Cox01e1abb2008-07-22 11:16:55 +010072 tty_ldiscs[disc] = new_ldisc;
73 new_ldisc->num = disc;
74 new_ldisc->refcount = 0;
Peter Hurley137084b2013-06-15 07:04:46 -040075 raw_spin_unlock_irqrestore(&tty_ldiscs_lock, flags);
Alan Cox01e1abb2008-07-22 11:16:55 +010076
77 return ret;
78}
79EXPORT_SYMBOL(tty_register_ldisc);
80
81/**
82 * tty_unregister_ldisc - unload a line discipline
83 * @disc: ldisc number
84 * @new_ldisc: pointer to the ldisc object
85 *
86 * Remove a line discipline from the kernel providing it is not
87 * currently in use.
88 *
89 * Locking:
Peter Hurley137084b2013-06-15 07:04:46 -040090 * takes tty_ldiscs_lock to guard against ldisc races
Alan Cox01e1abb2008-07-22 11:16:55 +010091 */
92
93int tty_unregister_ldisc(int disc)
94{
95 unsigned long flags;
96 int ret = 0;
97
98 if (disc < N_TTY || disc >= NR_LDISCS)
99 return -EINVAL;
100
Peter Hurley137084b2013-06-15 07:04:46 -0400101 raw_spin_lock_irqsave(&tty_ldiscs_lock, flags);
Alan Cox01e1abb2008-07-22 11:16:55 +0100102 if (tty_ldiscs[disc]->refcount)
103 ret = -EBUSY;
104 else
105 tty_ldiscs[disc] = NULL;
Peter Hurley137084b2013-06-15 07:04:46 -0400106 raw_spin_unlock_irqrestore(&tty_ldiscs_lock, flags);
Alan Cox01e1abb2008-07-22 11:16:55 +0100107
108 return ret;
109}
110EXPORT_SYMBOL(tty_unregister_ldisc);
111
Linus Torvaldsf0de0e82009-08-03 16:00:15 -0700112static struct tty_ldisc_ops *get_ldops(int disc)
113{
114 unsigned long flags;
115 struct tty_ldisc_ops *ldops, *ret;
116
Peter Hurley137084b2013-06-15 07:04:46 -0400117 raw_spin_lock_irqsave(&tty_ldiscs_lock, flags);
Linus Torvaldsf0de0e82009-08-03 16:00:15 -0700118 ret = ERR_PTR(-EINVAL);
119 ldops = tty_ldiscs[disc];
120 if (ldops) {
121 ret = ERR_PTR(-EAGAIN);
122 if (try_module_get(ldops->owner)) {
123 ldops->refcount++;
124 ret = ldops;
125 }
126 }
Peter Hurley137084b2013-06-15 07:04:46 -0400127 raw_spin_unlock_irqrestore(&tty_ldiscs_lock, flags);
Linus Torvaldsf0de0e82009-08-03 16:00:15 -0700128 return ret;
129}
130
131static void put_ldops(struct tty_ldisc_ops *ldops)
132{
133 unsigned long flags;
134
Peter Hurley137084b2013-06-15 07:04:46 -0400135 raw_spin_lock_irqsave(&tty_ldiscs_lock, flags);
Linus Torvaldsf0de0e82009-08-03 16:00:15 -0700136 ldops->refcount--;
137 module_put(ldops->owner);
Peter Hurley137084b2013-06-15 07:04:46 -0400138 raw_spin_unlock_irqrestore(&tty_ldiscs_lock, flags);
Linus Torvaldsf0de0e82009-08-03 16:00:15 -0700139}
Alan Cox01e1abb2008-07-22 11:16:55 +0100140
141/**
Alan Cox01e1abb2008-07-22 11:16:55 +0100142 * tty_ldisc_get - take a reference to an ldisc
143 * @disc: ldisc number
Alan Cox01e1abb2008-07-22 11:16:55 +0100144 *
145 * Takes a reference to a line discipline. Deals with refcounts and
146 * module locking counts. Returns NULL if the discipline is not available.
147 * Returns a pointer to the discipline and bumps the ref count if it is
148 * available
149 *
150 * Locking:
Peter Hurley137084b2013-06-15 07:04:46 -0400151 * takes tty_ldiscs_lock to guard against ldisc races
Alan Cox01e1abb2008-07-22 11:16:55 +0100152 */
153
Peter Hurley36697522013-06-15 07:04:48 -0400154static struct tty_ldisc *tty_ldisc_get(struct tty_struct *tty, int disc)
Alan Cox01e1abb2008-07-22 11:16:55 +0100155{
Alan Coxc65c9bc2009-06-11 12:50:12 +0100156 struct tty_ldisc *ld;
Linus Torvalds182274f2009-08-03 16:01:28 -0700157 struct tty_ldisc_ops *ldops;
Alan Cox01e1abb2008-07-22 11:16:55 +0100158
159 if (disc < N_TTY || disc >= NR_LDISCS)
Alan Coxc65c9bc2009-06-11 12:50:12 +0100160 return ERR_PTR(-EINVAL);
Linus Torvalds182274f2009-08-03 16:01:28 -0700161
162 /*
163 * Get the ldisc ops - we may need to request them to be loaded
164 * dynamically and try again.
165 */
166 ldops = get_ldops(disc);
167 if (IS_ERR(ldops)) {
Alan Cox01e1abb2008-07-22 11:16:55 +0100168 request_module("tty-ldisc-%d", disc);
Linus Torvalds182274f2009-08-03 16:01:28 -0700169 ldops = get_ldops(disc);
170 if (IS_ERR(ldops))
171 return ERR_CAST(ldops);
Alan Cox01e1abb2008-07-22 11:16:55 +0100172 }
Linus Torvalds182274f2009-08-03 16:01:28 -0700173
174 ld = kmalloc(sizeof(struct tty_ldisc), GFP_KERNEL);
175 if (ld == NULL) {
176 put_ldops(ldops);
177 return ERR_PTR(-ENOMEM);
178 }
179
180 ld->ops = ldops;
Peter Hurley36697522013-06-15 07:04:48 -0400181 ld->tty = tty;
Ivo Sieben1541f842012-05-03 14:37:43 +0200182
Alan Coxc65c9bc2009-06-11 12:50:12 +0100183 return ld;
Alan Cox01e1abb2008-07-22 11:16:55 +0100184}
185
Peter Hurley734de242013-03-11 16:44:43 -0400186/**
187 * tty_ldisc_put - release the ldisc
188 *
189 * Complement of tty_ldisc_get().
190 */
191static inline void tty_ldisc_put(struct tty_ldisc *ld)
192{
Peter Hurley734de242013-03-11 16:44:43 -0400193 if (WARN_ON_ONCE(!ld))
194 return;
195
Peter Hurley36697522013-06-15 07:04:48 -0400196 put_ldops(ld->ops);
Peter Hurley734de242013-03-11 16:44:43 -0400197 kfree(ld);
Peter Hurley734de242013-03-11 16:44:43 -0400198}
199
Alan Cox852e99d2009-06-11 12:51:41 +0100200static void *tty_ldiscs_seq_start(struct seq_file *m, loff_t *pos)
Alan Cox01e1abb2008-07-22 11:16:55 +0100201{
202 return (*pos < NR_LDISCS) ? pos : NULL;
203}
204
Alan Cox852e99d2009-06-11 12:51:41 +0100205static void *tty_ldiscs_seq_next(struct seq_file *m, void *v, loff_t *pos)
Alan Cox01e1abb2008-07-22 11:16:55 +0100206{
207 (*pos)++;
208 return (*pos < NR_LDISCS) ? pos : NULL;
209}
210
211static void tty_ldiscs_seq_stop(struct seq_file *m, void *v)
212{
213}
214
215static int tty_ldiscs_seq_show(struct seq_file *m, void *v)
216{
217 int i = *(loff_t *)v;
Linus Torvaldsf0de0e82009-08-03 16:00:15 -0700218 struct tty_ldisc_ops *ldops;
Alan Cox852e99d2009-06-11 12:51:41 +0100219
Linus Torvaldsf0de0e82009-08-03 16:00:15 -0700220 ldops = get_ldops(i);
221 if (IS_ERR(ldops))
Alan Cox01e1abb2008-07-22 11:16:55 +0100222 return 0;
Linus Torvaldsf0de0e82009-08-03 16:00:15 -0700223 seq_printf(m, "%-10s %2d\n", ldops->name ? ldops->name : "???", i);
224 put_ldops(ldops);
Alan Cox01e1abb2008-07-22 11:16:55 +0100225 return 0;
226}
227
228static const struct seq_operations tty_ldiscs_seq_ops = {
229 .start = tty_ldiscs_seq_start,
230 .next = tty_ldiscs_seq_next,
231 .stop = tty_ldiscs_seq_stop,
232 .show = tty_ldiscs_seq_show,
233};
234
235static int proc_tty_ldiscs_open(struct inode *inode, struct file *file)
236{
237 return seq_open(file, &tty_ldiscs_seq_ops);
238}
239
240const struct file_operations tty_ldiscs_proc_fops = {
241 .owner = THIS_MODULE,
242 .open = proc_tty_ldiscs_open,
243 .read = seq_read,
244 .llseek = seq_lseek,
245 .release = seq_release,
246};
247
248/**
Alan Cox01e1abb2008-07-22 11:16:55 +0100249 * tty_ldisc_ref_wait - wait for the tty ldisc
250 * @tty: tty device
251 *
252 * Dereference the line discipline for the terminal and take a
253 * reference to it. If the line discipline is in flux then
254 * wait patiently until it changes.
255 *
256 * Note: Must not be called from an IRQ/timer context. The caller
257 * must also be careful not to hold other locks that will deadlock
258 * against a discipline change, such as an existing ldisc reference
259 * (which we check for)
260 *
Peter Hurley36697522013-06-15 07:04:48 -0400261 * Note: only callable from a file_operations routine (which
262 * guarantees tty->ldisc != NULL when the lock is acquired).
Alan Cox01e1abb2008-07-22 11:16:55 +0100263 */
264
265struct tty_ldisc *tty_ldisc_ref_wait(struct tty_struct *tty)
266{
Peter Hurley36697522013-06-15 07:04:48 -0400267 ldsem_down_read(&tty->ldisc_sem, MAX_SCHEDULE_TIMEOUT);
268 WARN_ON(!tty->ldisc);
269 return tty->ldisc;
Alan Cox01e1abb2008-07-22 11:16:55 +0100270}
Alan Cox01e1abb2008-07-22 11:16:55 +0100271EXPORT_SYMBOL_GPL(tty_ldisc_ref_wait);
272
273/**
274 * tty_ldisc_ref - get the tty ldisc
275 * @tty: tty device
276 *
277 * Dereference the line discipline for the terminal and take a
278 * reference to it. If the line discipline is in flux then
279 * return NULL. Can be called from IRQ and timer functions.
Alan Cox01e1abb2008-07-22 11:16:55 +0100280 */
281
282struct tty_ldisc *tty_ldisc_ref(struct tty_struct *tty)
283{
Peter Hurley36697522013-06-15 07:04:48 -0400284 struct tty_ldisc *ld = NULL;
285
286 if (ldsem_down_read_trylock(&tty->ldisc_sem)) {
287 ld = tty->ldisc;
288 if (!ld)
289 ldsem_up_read(&tty->ldisc_sem);
290 }
291 return ld;
Alan Cox01e1abb2008-07-22 11:16:55 +0100292}
Alan Cox01e1abb2008-07-22 11:16:55 +0100293EXPORT_SYMBOL_GPL(tty_ldisc_ref);
294
295/**
296 * tty_ldisc_deref - free a tty ldisc reference
297 * @ld: reference to free up
298 *
299 * Undoes the effect of tty_ldisc_ref or tty_ldisc_ref_wait. May
300 * be called in IRQ context.
Alan Cox01e1abb2008-07-22 11:16:55 +0100301 */
302
303void tty_ldisc_deref(struct tty_ldisc *ld)
304{
Peter Hurley36697522013-06-15 07:04:48 -0400305 ldsem_up_read(&ld->tty->ldisc_sem);
Alan Cox01e1abb2008-07-22 11:16:55 +0100306}
Alan Cox01e1abb2008-07-22 11:16:55 +0100307EXPORT_SYMBOL_GPL(tty_ldisc_deref);
308
Peter Hurleyd2c43892013-06-15 07:04:47 -0400309
310static inline int __lockfunc
Peter Hurleye80a10e2014-11-05 12:13:06 -0500311__tty_ldisc_lock(struct tty_struct *tty, unsigned long timeout)
Peter Hurleyd2c43892013-06-15 07:04:47 -0400312{
313 return ldsem_down_write(&tty->ldisc_sem, timeout);
314}
315
316static inline int __lockfunc
Peter Hurleye80a10e2014-11-05 12:13:06 -0500317__tty_ldisc_lock_nested(struct tty_struct *tty, unsigned long timeout)
Peter Hurleyd2c43892013-06-15 07:04:47 -0400318{
319 return ldsem_down_write_nested(&tty->ldisc_sem,
320 LDISC_SEM_OTHER, timeout);
321}
322
Peter Hurleye80a10e2014-11-05 12:13:06 -0500323static inline void __tty_ldisc_unlock(struct tty_struct *tty)
Peter Hurleyd2c43892013-06-15 07:04:47 -0400324{
325 return ldsem_up_write(&tty->ldisc_sem);
326}
327
328static int __lockfunc
Peter Hurleyfae76e92014-11-05 12:13:07 -0500329tty_ldisc_lock(struct tty_struct *tty, unsigned long timeout)
330{
331 int ret;
332
333 ret = __tty_ldisc_lock(tty, timeout);
334 if (!ret)
335 return -EBUSY;
336 set_bit(TTY_LDISC_HALTED, &tty->flags);
337 return 0;
338}
339
340static void tty_ldisc_unlock(struct tty_struct *tty)
341{
342 clear_bit(TTY_LDISC_HALTED, &tty->flags);
343 __tty_ldisc_unlock(tty);
344}
345
346static int __lockfunc
Peter Hurleyd2c43892013-06-15 07:04:47 -0400347tty_ldisc_lock_pair_timeout(struct tty_struct *tty, struct tty_struct *tty2,
348 unsigned long timeout)
349{
350 int ret;
351
352 if (tty < tty2) {
Peter Hurleye80a10e2014-11-05 12:13:06 -0500353 ret = __tty_ldisc_lock(tty, timeout);
Peter Hurleyd2c43892013-06-15 07:04:47 -0400354 if (ret) {
Peter Hurleye80a10e2014-11-05 12:13:06 -0500355 ret = __tty_ldisc_lock_nested(tty2, timeout);
Peter Hurleyd2c43892013-06-15 07:04:47 -0400356 if (!ret)
Peter Hurleye80a10e2014-11-05 12:13:06 -0500357 __tty_ldisc_unlock(tty);
Peter Hurleyd2c43892013-06-15 07:04:47 -0400358 }
359 } else {
360 /* if this is possible, it has lots of implications */
361 WARN_ON_ONCE(tty == tty2);
362 if (tty2 && tty != tty2) {
Peter Hurleye80a10e2014-11-05 12:13:06 -0500363 ret = __tty_ldisc_lock(tty2, timeout);
Peter Hurleyd2c43892013-06-15 07:04:47 -0400364 if (ret) {
Peter Hurleye80a10e2014-11-05 12:13:06 -0500365 ret = __tty_ldisc_lock_nested(tty, timeout);
Peter Hurleyd2c43892013-06-15 07:04:47 -0400366 if (!ret)
Peter Hurleye80a10e2014-11-05 12:13:06 -0500367 __tty_ldisc_unlock(tty2);
Peter Hurleyd2c43892013-06-15 07:04:47 -0400368 }
369 } else
Peter Hurleye80a10e2014-11-05 12:13:06 -0500370 ret = __tty_ldisc_lock(tty, timeout);
Peter Hurleyd2c43892013-06-15 07:04:47 -0400371 }
372
373 if (!ret)
374 return -EBUSY;
375
376 set_bit(TTY_LDISC_HALTED, &tty->flags);
377 if (tty2)
378 set_bit(TTY_LDISC_HALTED, &tty2->flags);
379 return 0;
380}
381
382static void __lockfunc
383tty_ldisc_lock_pair(struct tty_struct *tty, struct tty_struct *tty2)
384{
385 tty_ldisc_lock_pair_timeout(tty, tty2, MAX_SCHEDULE_TIMEOUT);
386}
387
388static void __lockfunc tty_ldisc_unlock_pair(struct tty_struct *tty,
389 struct tty_struct *tty2)
390{
Peter Hurleye80a10e2014-11-05 12:13:06 -0500391 __tty_ldisc_unlock(tty);
Peter Hurleyd2c43892013-06-15 07:04:47 -0400392 if (tty2)
Peter Hurleye80a10e2014-11-05 12:13:06 -0500393 __tty_ldisc_unlock(tty2);
Peter Hurleyd2c43892013-06-15 07:04:47 -0400394}
395
Alan Cox01e1abb2008-07-22 11:16:55 +0100396/**
Alan Coxf2c4c652009-06-11 12:50:58 +0100397 * tty_ldisc_flush - flush line discipline queue
398 * @tty: tty
399 *
Peter Hurley86c80a82014-11-05 12:13:09 -0500400 * Flush the line discipline queue (if any) and the tty flip buffers
401 * for this tty.
Alan Coxf2c4c652009-06-11 12:50:58 +0100402 */
403
404void tty_ldisc_flush(struct tty_struct *tty)
405{
406 struct tty_ldisc *ld = tty_ldisc_ref(tty);
Peter Hurley86c80a82014-11-05 12:13:09 -0500407
408 tty_buffer_flush(tty, ld);
409 if (ld)
Alan Coxf2c4c652009-06-11 12:50:58 +0100410 tty_ldisc_deref(ld);
Alan Coxf2c4c652009-06-11 12:50:58 +0100411}
Alan Coxf2c4c652009-06-11 12:50:58 +0100412EXPORT_SYMBOL_GPL(tty_ldisc_flush);
413
414/**
Alan Cox01e1abb2008-07-22 11:16:55 +0100415 * tty_set_termios_ldisc - set ldisc field
416 * @tty: tty structure
417 * @num: line discipline number
418 *
419 * This is probably overkill for real world processors but
420 * they are not on hot paths so a little discipline won't do
421 * any harm.
422 *
Peter Hurley6a1c0682013-06-15 09:14:23 -0400423 * Locking: takes termios_rwsem
Alan Cox01e1abb2008-07-22 11:16:55 +0100424 */
425
426static void tty_set_termios_ldisc(struct tty_struct *tty, int num)
427{
Peter Hurley6a1c0682013-06-15 09:14:23 -0400428 down_write(&tty->termios_rwsem);
Alan Coxadc8d742012-07-14 15:31:47 +0100429 tty->termios.c_line = num;
Peter Hurley6a1c0682013-06-15 09:14:23 -0400430 up_write(&tty->termios_rwsem);
Alan Cox01e1abb2008-07-22 11:16:55 +0100431}
432
Alan Coxc65c9bc2009-06-11 12:50:12 +0100433/**
434 * tty_ldisc_open - open a line discipline
435 * @tty: tty we are opening the ldisc on
436 * @ld: discipline to open
437 *
438 * A helper opening method. Also a convenient debugging and check
439 * point.
Arnd Bergmannec79d602010-06-01 22:53:01 +0200440 *
441 * Locking: always called with BTM already held.
Alan Coxc65c9bc2009-06-11 12:50:12 +0100442 */
443
444static int tty_ldisc_open(struct tty_struct *tty, struct tty_ldisc *ld)
445{
446 WARN_ON(test_and_set_bit(TTY_LDISC_OPEN, &tty->flags));
Alan Coxf18f9492009-11-30 13:18:35 +0000447 if (ld->ops->open) {
448 int ret;
Arnd Bergmannec79d602010-06-01 22:53:01 +0200449 /* BTM here locks versus a hangup event */
Alan Coxf18f9492009-11-30 13:18:35 +0000450 ret = ld->ops->open(tty);
Jiri Slaby7f90cfc2010-11-25 00:27:54 +0100451 if (ret)
452 clear_bit(TTY_LDISC_OPEN, &tty->flags);
Alan Coxf18f9492009-11-30 13:18:35 +0000453 return ret;
454 }
Alan Coxc65c9bc2009-06-11 12:50:12 +0100455 return 0;
456}
457
458/**
459 * tty_ldisc_close - close a line discipline
460 * @tty: tty we are opening the ldisc on
461 * @ld: discipline to close
462 *
463 * A helper close method. Also a convenient debugging and check
464 * point.
465 */
466
467static void tty_ldisc_close(struct tty_struct *tty, struct tty_ldisc *ld)
468{
469 WARN_ON(!test_bit(TTY_LDISC_OPEN, &tty->flags));
470 clear_bit(TTY_LDISC_OPEN, &tty->flags);
471 if (ld->ops->close)
472 ld->ops->close(tty);
473}
Alan Cox01e1abb2008-07-22 11:16:55 +0100474
475/**
476 * tty_ldisc_restore - helper for tty ldisc change
477 * @tty: tty to recover
478 * @old: previous ldisc
479 *
480 * Restore the previous line discipline or N_TTY when a line discipline
481 * change fails due to an open error
482 */
483
484static void tty_ldisc_restore(struct tty_struct *tty, struct tty_ldisc *old)
485{
486 char buf[64];
Alan Coxc65c9bc2009-06-11 12:50:12 +0100487 struct tty_ldisc *new_ldisc;
488 int r;
Alan Cox01e1abb2008-07-22 11:16:55 +0100489
490 /* There is an outstanding reference here so this is safe */
Peter Hurley36697522013-06-15 07:04:48 -0400491 old = tty_ldisc_get(tty, old->ops->num);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100492 WARN_ON(IS_ERR(old));
Peter Hurleyf48070452013-03-11 16:44:42 -0400493 tty->ldisc = old;
Alan Cox01e1abb2008-07-22 11:16:55 +0100494 tty_set_termios_ldisc(tty, old->ops->num);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100495 if (tty_ldisc_open(tty, old) < 0) {
496 tty_ldisc_put(old);
Alan Cox01e1abb2008-07-22 11:16:55 +0100497 /* This driver is always present */
Peter Hurley36697522013-06-15 07:04:48 -0400498 new_ldisc = tty_ldisc_get(tty, N_TTY);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100499 if (IS_ERR(new_ldisc))
Alan Cox01e1abb2008-07-22 11:16:55 +0100500 panic("n_tty: get");
Peter Hurleyf48070452013-03-11 16:44:42 -0400501 tty->ldisc = new_ldisc;
Alan Cox01e1abb2008-07-22 11:16:55 +0100502 tty_set_termios_ldisc(tty, N_TTY);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100503 r = tty_ldisc_open(tty, new_ldisc);
504 if (r < 0)
505 panic("Couldn't open N_TTY ldisc for "
506 "%s --- error %d.",
507 tty_name(tty, buf), r);
Alan Cox01e1abb2008-07-22 11:16:55 +0100508 }
509}
510
511/**
512 * tty_set_ldisc - set line discipline
513 * @tty: the terminal to set
514 * @ldisc: the line discipline
515 *
516 * Set the discipline of a tty line. Must be called from a process
Alan Coxc65c9bc2009-06-11 12:50:12 +0100517 * context. The ldisc change logic has to protect itself against any
518 * overlapping ldisc change (including on the other end of pty pairs),
519 * the close of one side of a tty/pty pair, and eventually hangup.
Alan Cox01e1abb2008-07-22 11:16:55 +0100520 */
521
522int tty_set_ldisc(struct tty_struct *tty, int ldisc)
523{
524 int retval;
Peter Hurley9fbfa342013-06-15 07:04:49 -0400525 struct tty_ldisc *old_ldisc, *new_ldisc;
Alan Cox01e1abb2008-07-22 11:16:55 +0100526
Peter Hurley36697522013-06-15 07:04:48 -0400527 new_ldisc = tty_ldisc_get(tty, ldisc);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100528 if (IS_ERR(new_ldisc))
529 return PTR_ERR(new_ldisc);
530
Peter Hurleyc8483bc2014-11-05 12:12:45 -0500531 tty_lock(tty);
Peter Hurley276a6612014-11-05 12:13:08 -0500532 retval = tty_ldisc_lock(tty, 5 * HZ);
Peter Hurley36697522013-06-15 07:04:48 -0400533 if (retval) {
534 tty_ldisc_put(new_ldisc);
Peter Hurleyc8483bc2014-11-05 12:12:45 -0500535 tty_unlock(tty);
Peter Hurley36697522013-06-15 07:04:48 -0400536 return retval;
537 }
Alan Coxc65c9bc2009-06-11 12:50:12 +0100538
539 /*
540 * Check the no-op case
541 */
542
543 if (tty->ldisc->ops->num == ldisc) {
Peter Hurley276a6612014-11-05 12:13:08 -0500544 tty_ldisc_unlock(tty);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100545 tty_ldisc_put(new_ldisc);
Peter Hurleyc8483bc2014-11-05 12:12:45 -0500546 tty_unlock(tty);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100547 return 0;
548 }
Alan Cox01e1abb2008-07-22 11:16:55 +0100549
Peter Hurley9fbfa342013-06-15 07:04:49 -0400550 old_ldisc = tty->ldisc;
Jiri Slaby100eeae2010-10-31 23:17:51 +0100551
Peter Hurley3ff51a12014-11-05 12:12:46 -0500552 if (test_bit(TTY_HUPPED, &tty->flags)) {
Alan Coxc65c9bc2009-06-11 12:50:12 +0100553 /* We were raced by the hangup method. It will have stomped
554 the ldisc data and closed the ldisc down */
Peter Hurley276a6612014-11-05 12:13:08 -0500555 tty_ldisc_unlock(tty);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100556 tty_ldisc_put(new_ldisc);
Alan Cox89c8d912012-08-08 16:30:13 +0100557 tty_unlock(tty);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100558 return -EIO;
559 }
560
Peter Hurley9fbfa342013-06-15 07:04:49 -0400561 /* Shutdown the old discipline. */
562 tty_ldisc_close(tty, old_ldisc);
Alan Cox01e1abb2008-07-22 11:16:55 +0100563
564 /* Now set up the new line discipline. */
Peter Hurleyf48070452013-03-11 16:44:42 -0400565 tty->ldisc = new_ldisc;
Alan Cox01e1abb2008-07-22 11:16:55 +0100566 tty_set_termios_ldisc(tty, ldisc);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100567
568 retval = tty_ldisc_open(tty, new_ldisc);
Alan Cox01e1abb2008-07-22 11:16:55 +0100569 if (retval < 0) {
Alan Coxc65c9bc2009-06-11 12:50:12 +0100570 /* Back to the old one or N_TTY if we can't */
571 tty_ldisc_put(new_ldisc);
Peter Hurley9fbfa342013-06-15 07:04:49 -0400572 tty_ldisc_restore(tty, old_ldisc);
Alan Cox01e1abb2008-07-22 11:16:55 +0100573 }
Alan Coxc65c9bc2009-06-11 12:50:12 +0100574
Peter Hurley9191aaa2014-11-05 13:11:41 -0500575 if (tty->ldisc->ops->num != old_ldisc->ops->num && tty->ops->set_ldisc) {
576 down_read(&tty->termios_rwsem);
Alan Cox01e1abb2008-07-22 11:16:55 +0100577 tty->ops->set_ldisc(tty);
Peter Hurley9191aaa2014-11-05 13:11:41 -0500578 up_read(&tty->termios_rwsem);
579 }
Alan Cox01e1abb2008-07-22 11:16:55 +0100580
Peter Hurleyb0e95852013-06-15 07:04:51 -0400581 /* At this point we hold a reference to the new ldisc and a
582 reference to the old ldisc, or we hold two references to
583 the old ldisc (if it was restored as part of error cleanup
584 above). In either case, releasing a single reference from
585 the old ldisc is correct. */
586
Peter Hurley9fbfa342013-06-15 07:04:49 -0400587 tty_ldisc_put(old_ldisc);
Alan Cox01e1abb2008-07-22 11:16:55 +0100588
589 /*
Alan Coxc65c9bc2009-06-11 12:50:12 +0100590 * Allow ldisc referencing to occur again
Alan Cox01e1abb2008-07-22 11:16:55 +0100591 */
Peter Hurley276a6612014-11-05 12:13:08 -0500592 tty_ldisc_unlock(tty);
Alan Cox01e1abb2008-07-22 11:16:55 +0100593
Alan Coxc65c9bc2009-06-11 12:50:12 +0100594 /* Restart the work queue in case no characters kick it off. Safe if
Alan Cox01e1abb2008-07-22 11:16:55 +0100595 already running */
Peter Hurley4f98d462013-03-11 16:44:34 -0400596 schedule_work(&tty->port->buf.work);
Peter Hurley4f98d462013-03-11 16:44:34 -0400597
Alan Cox89c8d912012-08-08 16:30:13 +0100598 tty_unlock(tty);
Alan Cox01e1abb2008-07-22 11:16:55 +0100599 return retval;
600}
601
Alan Coxc65c9bc2009-06-11 12:50:12 +0100602/**
603 * tty_reset_termios - reset terminal state
604 * @tty: tty to reset
605 *
606 * Restore a terminal to the driver default state.
607 */
608
609static void tty_reset_termios(struct tty_struct *tty)
610{
Peter Hurley6a1c0682013-06-15 09:14:23 -0400611 down_write(&tty->termios_rwsem);
Alan Coxadc8d742012-07-14 15:31:47 +0100612 tty->termios = tty->driver->init_termios;
613 tty->termios.c_ispeed = tty_termios_input_baud_rate(&tty->termios);
614 tty->termios.c_ospeed = tty_termios_baud_rate(&tty->termios);
Peter Hurley6a1c0682013-06-15 09:14:23 -0400615 up_write(&tty->termios_rwsem);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100616}
617
618
619/**
620 * tty_ldisc_reinit - reinitialise the tty ldisc
621 * @tty: tty to reinit
Alan Cox638b9642010-02-08 10:09:26 +0000622 * @ldisc: line discipline to reinitialize
Alan Coxc65c9bc2009-06-11 12:50:12 +0100623 *
Alan Cox638b9642010-02-08 10:09:26 +0000624 * Switch the tty to a line discipline and leave the ldisc
625 * state closed
Alan Coxc65c9bc2009-06-11 12:50:12 +0100626 */
627
Philippe Rétornaz1c95ba12010-10-27 17:13:21 +0200628static int tty_ldisc_reinit(struct tty_struct *tty, int ldisc)
Alan Coxc65c9bc2009-06-11 12:50:12 +0100629{
Peter Hurley36697522013-06-15 07:04:48 -0400630 struct tty_ldisc *ld = tty_ldisc_get(tty, ldisc);
Philippe Rétornaz1c95ba12010-10-27 17:13:21 +0200631
632 if (IS_ERR(ld))
633 return -1;
Alan Coxc65c9bc2009-06-11 12:50:12 +0100634
635 tty_ldisc_close(tty, tty->ldisc);
636 tty_ldisc_put(tty->ldisc);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100637 /*
638 * Switch the line discipline back
639 */
Peter Hurleyf48070452013-03-11 16:44:42 -0400640 tty->ldisc = ld;
Alan Cox638b9642010-02-08 10:09:26 +0000641 tty_set_termios_ldisc(tty, ldisc);
Philippe Rétornaz1c95ba12010-10-27 17:13:21 +0200642
643 return 0;
Alan Coxc65c9bc2009-06-11 12:50:12 +0100644}
645
646/**
647 * tty_ldisc_hangup - hangup ldisc reset
648 * @tty: tty being hung up
649 *
650 * Some tty devices reset their termios when they receive a hangup
651 * event. In that situation we must also switch back to N_TTY properly
652 * before we reset the termios data.
653 *
654 * Locking: We can take the ldisc mutex as the rest of the code is
655 * careful to allow for this.
656 *
657 * In the pty pair case this occurs in the close() path of the
658 * tty itself so we must be careful about locking rules.
659 */
660
661void tty_ldisc_hangup(struct tty_struct *tty)
662{
663 struct tty_ldisc *ld;
Alan Cox638b9642010-02-08 10:09:26 +0000664 int reset = tty->driver->flags & TTY_DRIVER_RESET_TERMIOS;
665 int err = 0;
Alan Coxc65c9bc2009-06-11 12:50:12 +0100666
Peter Hurleyfc575ee2013-03-11 16:44:38 -0400667 tty_ldisc_debug(tty, "closing ldisc: %p\n", tty->ldisc);
668
Alan Coxc65c9bc2009-06-11 12:50:12 +0100669 ld = tty_ldisc_ref(tty);
670 if (ld != NULL) {
Alan Coxc65c9bc2009-06-11 12:50:12 +0100671 if (ld->ops->flush_buffer)
672 ld->ops->flush_buffer(tty);
673 tty_driver_flush_buffer(tty);
674 if ((test_bit(TTY_DO_WRITE_WAKEUP, &tty->flags)) &&
675 ld->ops->write_wakeup)
676 ld->ops->write_wakeup(tty);
677 if (ld->ops->hangup)
678 ld->ops->hangup(tty);
679 tty_ldisc_deref(ld);
680 }
Peter Hurley36697522013-06-15 07:04:48 -0400681
Alan Coxc65c9bc2009-06-11 12:50:12 +0100682 wake_up_interruptible_poll(&tty->write_wait, POLLOUT);
683 wake_up_interruptible_poll(&tty->read_wait, POLLIN);
Peter Hurley36697522013-06-15 07:04:48 -0400684
Alan Coxc65c9bc2009-06-11 12:50:12 +0100685 /*
686 * Shutdown the current line discipline, and reset it to
Alan Cox638b9642010-02-08 10:09:26 +0000687 * N_TTY if need be.
688 *
689 * Avoid racing set_ldisc or tty_ldisc_release
Alan Coxc65c9bc2009-06-11 12:50:12 +0100690 */
Peter Hurleyfae76e92014-11-05 12:13:07 -0500691 tty_ldisc_lock(tty, MAX_SCHEDULE_TIMEOUT);
Arnd Bergmann60af22d2010-06-01 22:53:06 +0200692
Peter Hurley36697522013-06-15 07:04:48 -0400693 if (tty->ldisc) {
Peter Hurleyc8785242013-03-11 16:44:36 -0400694
695 /* At this point we have a halted ldisc; we want to close it and
696 reopen a new ldisc. We could defer the reopen to the next
697 open but it means auditing a lot of other paths so this is
698 a FIXME */
Alan Cox638b9642010-02-08 10:09:26 +0000699 if (reset == 0) {
Philippe Rétornaz1c95ba12010-10-27 17:13:21 +0200700
Alan Coxadc8d742012-07-14 15:31:47 +0100701 if (!tty_ldisc_reinit(tty, tty->termios.c_line))
Philippe Rétornaz1c95ba12010-10-27 17:13:21 +0200702 err = tty_ldisc_open(tty, tty->ldisc);
703 else
704 err = 1;
Alan Coxc8d50042009-07-16 16:05:08 +0100705 }
Alan Cox638b9642010-02-08 10:09:26 +0000706 /* If the re-open fails or we reset then go to N_TTY. The
707 N_TTY open cannot fail */
708 if (reset || err) {
Philippe Rétornaz1c95ba12010-10-27 17:13:21 +0200709 BUG_ON(tty_ldisc_reinit(tty, N_TTY));
Alan Cox638b9642010-02-08 10:09:26 +0000710 WARN_ON(tty_ldisc_open(tty, tty->ldisc));
711 }
Alan Coxc65c9bc2009-06-11 12:50:12 +0100712 }
Peter Hurleyfae76e92014-11-05 12:13:07 -0500713 tty_ldisc_unlock(tty);
Alan Cox638b9642010-02-08 10:09:26 +0000714 if (reset)
715 tty_reset_termios(tty);
Peter Hurleyfc575ee2013-03-11 16:44:38 -0400716
717 tty_ldisc_debug(tty, "re-opened ldisc: %p\n", tty->ldisc);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100718}
Alan Cox01e1abb2008-07-22 11:16:55 +0100719
720/**
721 * tty_ldisc_setup - open line discipline
722 * @tty: tty being shut down
723 * @o_tty: pair tty for pty/tty pairs
724 *
725 * Called during the initial open of a tty/pty pair in order to set up the
Alan Coxc65c9bc2009-06-11 12:50:12 +0100726 * line disciplines and bind them to the tty. This has no locking issues
727 * as the device isn't yet active.
Alan Cox01e1abb2008-07-22 11:16:55 +0100728 */
729
730int tty_ldisc_setup(struct tty_struct *tty, struct tty_struct *o_tty)
731{
Alan Coxc65c9bc2009-06-11 12:50:12 +0100732 struct tty_ldisc *ld = tty->ldisc;
Alan Cox01e1abb2008-07-22 11:16:55 +0100733 int retval;
734
Alan Coxc65c9bc2009-06-11 12:50:12 +0100735 retval = tty_ldisc_open(tty, ld);
736 if (retval)
737 return retval;
738
739 if (o_tty) {
740 retval = tty_ldisc_open(o_tty, o_tty->ldisc);
Alan Cox01e1abb2008-07-22 11:16:55 +0100741 if (retval) {
Alan Coxc65c9bc2009-06-11 12:50:12 +0100742 tty_ldisc_close(tty, ld);
Alan Cox01e1abb2008-07-22 11:16:55 +0100743 return retval;
744 }
Alan Cox01e1abb2008-07-22 11:16:55 +0100745 }
Alan Cox01e1abb2008-07-22 11:16:55 +0100746 return 0;
747}
Alan Cox89c8d912012-08-08 16:30:13 +0100748
749static void tty_ldisc_kill(struct tty_struct *tty)
750{
Alan Cox89c8d912012-08-08 16:30:13 +0100751 /*
752 * Now kill off the ldisc
753 */
754 tty_ldisc_close(tty, tty->ldisc);
755 tty_ldisc_put(tty->ldisc);
756 /* Force an oops if we mess this up */
757 tty->ldisc = NULL;
758
759 /* Ensure the next open requests the N_TTY ldisc */
760 tty_set_termios_ldisc(tty, N_TTY);
Alan Cox89c8d912012-08-08 16:30:13 +0100761}
762
Alan Cox01e1abb2008-07-22 11:16:55 +0100763/**
764 * tty_ldisc_release - release line discipline
Peter Hurley62462ae2014-11-05 12:12:58 -0500765 * @tty: tty being shut down (or one end of pty pair)
Alan Cox01e1abb2008-07-22 11:16:55 +0100766 *
Peter Hurley62462ae2014-11-05 12:12:58 -0500767 * Called during the final close of a tty or a pty pair in order to shut
768 * down the line discpline layer. On exit, each ldisc assigned is N_TTY and
769 * each ldisc has not been opened.
Alan Cox01e1abb2008-07-22 11:16:55 +0100770 */
771
Peter Hurley62462ae2014-11-05 12:12:58 -0500772void tty_ldisc_release(struct tty_struct *tty)
Alan Cox01e1abb2008-07-22 11:16:55 +0100773{
Peter Hurley62462ae2014-11-05 12:12:58 -0500774 struct tty_struct *o_tty = tty->link;
775
Alan Cox01e1abb2008-07-22 11:16:55 +0100776 /*
Peter Hurleya2965b72013-03-11 16:44:35 -0400777 * Shutdown this line discipline. As this is the final close,
778 * it does not race with the set_ldisc code path.
Alan Cox01e1abb2008-07-22 11:16:55 +0100779 */
Alan Cox01e1abb2008-07-22 11:16:55 +0100780
Peter Hurleyfc575ee2013-03-11 16:44:38 -0400781 tty_ldisc_debug(tty, "closing ldisc: %p\n", tty->ldisc);
782
Peter Hurley36697522013-06-15 07:04:48 -0400783 tty_ldisc_lock_pair(tty, o_tty);
Alan Cox89c8d912012-08-08 16:30:13 +0100784 tty_ldisc_kill(tty);
Alan Cox89c8d912012-08-08 16:30:13 +0100785 if (o_tty)
786 tty_ldisc_kill(o_tty);
Peter Hurley36697522013-06-15 07:04:48 -0400787 tty_ldisc_unlock_pair(tty, o_tty);
788
Alan Coxaef29bc2009-06-29 15:21:47 +0100789 /* And the memory resources remaining (buffers, termios) will be
790 disposed of when the kref hits zero */
Peter Hurleyfc575ee2013-03-11 16:44:38 -0400791
792 tty_ldisc_debug(tty, "ldisc closed\n");
Alan Cox01e1abb2008-07-22 11:16:55 +0100793}
794
795/**
796 * tty_ldisc_init - ldisc setup for new tty
797 * @tty: tty being allocated
798 *
799 * Set up the line discipline objects for a newly allocated tty. Note that
800 * the tty structure is not completely set up when this call is made.
801 */
802
803void tty_ldisc_init(struct tty_struct *tty)
804{
Peter Hurley36697522013-06-15 07:04:48 -0400805 struct tty_ldisc *ld = tty_ldisc_get(tty, N_TTY);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100806 if (IS_ERR(ld))
Alan Cox01e1abb2008-07-22 11:16:55 +0100807 panic("n_tty: init_tty");
Peter Hurleyf48070452013-03-11 16:44:42 -0400808 tty->ldisc = ld;
Alan Cox01e1abb2008-07-22 11:16:55 +0100809}
810
Jiri Slaby67166712011-03-23 10:48:35 +0100811/**
812 * tty_ldisc_init - ldisc cleanup for new tty
813 * @tty: tty that was allocated recently
814 *
815 * The tty structure must not becompletely set up (tty_ldisc_setup) when
816 * this call is made.
817 */
818void tty_ldisc_deinit(struct tty_struct *tty)
819{
Peter Hurleyebc9bae2013-03-11 16:44:40 -0400820 tty_ldisc_put(tty->ldisc);
Peter Hurleyf48070452013-03-11 16:44:42 -0400821 tty->ldisc = NULL;
Jiri Slaby67166712011-03-23 10:48:35 +0100822}
823
Alan Cox01e1abb2008-07-22 11:16:55 +0100824void tty_ldisc_begin(void)
825{
826 /* Setup the default TTY line discipline. */
827 (void) tty_register_ldisc(N_TTY, &tty_ldisc_N_TTY);
828}