blob: 1dbe27824220266e1dd23b71bab7f6edadae32d1 [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
396static void __lockfunc tty_ldisc_enable_pair(struct tty_struct *tty,
397 struct tty_struct *tty2)
398{
399 clear_bit(TTY_LDISC_HALTED, &tty->flags);
400 if (tty2)
401 clear_bit(TTY_LDISC_HALTED, &tty2->flags);
402
403 tty_ldisc_unlock_pair(tty, tty2);
404}
405
Alan Cox01e1abb2008-07-22 11:16:55 +0100406/**
Alan Coxf2c4c652009-06-11 12:50:58 +0100407 * tty_ldisc_flush - flush line discipline queue
408 * @tty: tty
409 *
410 * Flush the line discipline queue (if any) for this tty. If there
411 * is no line discipline active this is a no-op.
412 */
413
414void tty_ldisc_flush(struct tty_struct *tty)
415{
416 struct tty_ldisc *ld = tty_ldisc_ref(tty);
417 if (ld) {
418 if (ld->ops->flush_buffer)
419 ld->ops->flush_buffer(tty);
420 tty_ldisc_deref(ld);
421 }
422 tty_buffer_flush(tty);
423}
Alan Coxf2c4c652009-06-11 12:50:58 +0100424EXPORT_SYMBOL_GPL(tty_ldisc_flush);
425
426/**
Alan Cox01e1abb2008-07-22 11:16:55 +0100427 * tty_set_termios_ldisc - set ldisc field
428 * @tty: tty structure
429 * @num: line discipline number
430 *
431 * This is probably overkill for real world processors but
432 * they are not on hot paths so a little discipline won't do
433 * any harm.
434 *
Peter Hurley6a1c0682013-06-15 09:14:23 -0400435 * Locking: takes termios_rwsem
Alan Cox01e1abb2008-07-22 11:16:55 +0100436 */
437
438static void tty_set_termios_ldisc(struct tty_struct *tty, int num)
439{
Peter Hurley6a1c0682013-06-15 09:14:23 -0400440 down_write(&tty->termios_rwsem);
Alan Coxadc8d742012-07-14 15:31:47 +0100441 tty->termios.c_line = num;
Peter Hurley6a1c0682013-06-15 09:14:23 -0400442 up_write(&tty->termios_rwsem);
Alan Cox01e1abb2008-07-22 11:16:55 +0100443}
444
Alan Coxc65c9bc2009-06-11 12:50:12 +0100445/**
446 * tty_ldisc_open - open a line discipline
447 * @tty: tty we are opening the ldisc on
448 * @ld: discipline to open
449 *
450 * A helper opening method. Also a convenient debugging and check
451 * point.
Arnd Bergmannec79d602010-06-01 22:53:01 +0200452 *
453 * Locking: always called with BTM already held.
Alan Coxc65c9bc2009-06-11 12:50:12 +0100454 */
455
456static int tty_ldisc_open(struct tty_struct *tty, struct tty_ldisc *ld)
457{
458 WARN_ON(test_and_set_bit(TTY_LDISC_OPEN, &tty->flags));
Alan Coxf18f9492009-11-30 13:18:35 +0000459 if (ld->ops->open) {
460 int ret;
Arnd Bergmannec79d602010-06-01 22:53:01 +0200461 /* BTM here locks versus a hangup event */
Alan Coxf18f9492009-11-30 13:18:35 +0000462 ret = ld->ops->open(tty);
Jiri Slaby7f90cfc2010-11-25 00:27:54 +0100463 if (ret)
464 clear_bit(TTY_LDISC_OPEN, &tty->flags);
Alan Coxf18f9492009-11-30 13:18:35 +0000465 return ret;
466 }
Alan Coxc65c9bc2009-06-11 12:50:12 +0100467 return 0;
468}
469
470/**
471 * tty_ldisc_close - close a line discipline
472 * @tty: tty we are opening the ldisc on
473 * @ld: discipline to close
474 *
475 * A helper close method. Also a convenient debugging and check
476 * point.
477 */
478
479static void tty_ldisc_close(struct tty_struct *tty, struct tty_ldisc *ld)
480{
481 WARN_ON(!test_bit(TTY_LDISC_OPEN, &tty->flags));
482 clear_bit(TTY_LDISC_OPEN, &tty->flags);
483 if (ld->ops->close)
484 ld->ops->close(tty);
485}
Alan Cox01e1abb2008-07-22 11:16:55 +0100486
487/**
488 * tty_ldisc_restore - helper for tty ldisc change
489 * @tty: tty to recover
490 * @old: previous ldisc
491 *
492 * Restore the previous line discipline or N_TTY when a line discipline
493 * change fails due to an open error
494 */
495
496static void tty_ldisc_restore(struct tty_struct *tty, struct tty_ldisc *old)
497{
498 char buf[64];
Alan Coxc65c9bc2009-06-11 12:50:12 +0100499 struct tty_ldisc *new_ldisc;
500 int r;
Alan Cox01e1abb2008-07-22 11:16:55 +0100501
502 /* There is an outstanding reference here so this is safe */
Peter Hurley36697522013-06-15 07:04:48 -0400503 old = tty_ldisc_get(tty, old->ops->num);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100504 WARN_ON(IS_ERR(old));
Peter Hurleyf48070452013-03-11 16:44:42 -0400505 tty->ldisc = old;
Alan Cox01e1abb2008-07-22 11:16:55 +0100506 tty_set_termios_ldisc(tty, old->ops->num);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100507 if (tty_ldisc_open(tty, old) < 0) {
508 tty_ldisc_put(old);
Alan Cox01e1abb2008-07-22 11:16:55 +0100509 /* This driver is always present */
Peter Hurley36697522013-06-15 07:04:48 -0400510 new_ldisc = tty_ldisc_get(tty, N_TTY);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100511 if (IS_ERR(new_ldisc))
Alan Cox01e1abb2008-07-22 11:16:55 +0100512 panic("n_tty: get");
Peter Hurleyf48070452013-03-11 16:44:42 -0400513 tty->ldisc = new_ldisc;
Alan Cox01e1abb2008-07-22 11:16:55 +0100514 tty_set_termios_ldisc(tty, N_TTY);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100515 r = tty_ldisc_open(tty, new_ldisc);
516 if (r < 0)
517 panic("Couldn't open N_TTY ldisc for "
518 "%s --- error %d.",
519 tty_name(tty, buf), r);
Alan Cox01e1abb2008-07-22 11:16:55 +0100520 }
521}
522
523/**
524 * tty_set_ldisc - set line discipline
525 * @tty: the terminal to set
526 * @ldisc: the line discipline
527 *
528 * Set the discipline of a tty line. Must be called from a process
Alan Coxc65c9bc2009-06-11 12:50:12 +0100529 * context. The ldisc change logic has to protect itself against any
530 * overlapping ldisc change (including on the other end of pty pairs),
531 * the close of one side of a tty/pty pair, and eventually hangup.
Alan Cox01e1abb2008-07-22 11:16:55 +0100532 */
533
534int tty_set_ldisc(struct tty_struct *tty, int ldisc)
535{
536 int retval;
Peter Hurley9fbfa342013-06-15 07:04:49 -0400537 struct tty_ldisc *old_ldisc, *new_ldisc;
Peter Hurley36697522013-06-15 07:04:48 -0400538 struct tty_struct *o_tty = tty->link;
Alan Cox01e1abb2008-07-22 11:16:55 +0100539
Peter Hurley36697522013-06-15 07:04:48 -0400540 new_ldisc = tty_ldisc_get(tty, ldisc);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100541 if (IS_ERR(new_ldisc))
542 return PTR_ERR(new_ldisc);
543
Peter Hurleyc8483bc2014-11-05 12:12:45 -0500544 tty_lock(tty);
Peter Hurley36697522013-06-15 07:04:48 -0400545 retval = tty_ldisc_lock_pair_timeout(tty, o_tty, 5 * HZ);
546 if (retval) {
547 tty_ldisc_put(new_ldisc);
Peter Hurleyc8483bc2014-11-05 12:12:45 -0500548 tty_unlock(tty);
Peter Hurley36697522013-06-15 07:04:48 -0400549 return retval;
550 }
Alan Coxc65c9bc2009-06-11 12:50:12 +0100551
552 /*
553 * Check the no-op case
554 */
555
556 if (tty->ldisc->ops->num == ldisc) {
Peter Hurley36697522013-06-15 07:04:48 -0400557 tty_ldisc_enable_pair(tty, o_tty);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100558 tty_ldisc_put(new_ldisc);
Peter Hurleyc8483bc2014-11-05 12:12:45 -0500559 tty_unlock(tty);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100560 return 0;
561 }
Alan Cox01e1abb2008-07-22 11:16:55 +0100562
Peter Hurley9fbfa342013-06-15 07:04:49 -0400563 old_ldisc = tty->ldisc;
Jiri Slaby100eeae2010-10-31 23:17:51 +0100564
Peter Hurley3ff51a12014-11-05 12:12:46 -0500565 if (test_bit(TTY_HUPPED, &tty->flags)) {
Alan Coxc65c9bc2009-06-11 12:50:12 +0100566 /* We were raced by the hangup method. It will have stomped
567 the ldisc data and closed the ldisc down */
Peter Hurley36697522013-06-15 07:04:48 -0400568 tty_ldisc_enable_pair(tty, o_tty);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100569 tty_ldisc_put(new_ldisc);
Alan Cox89c8d912012-08-08 16:30:13 +0100570 tty_unlock(tty);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100571 return -EIO;
572 }
573
Peter Hurley9fbfa342013-06-15 07:04:49 -0400574 /* Shutdown the old discipline. */
575 tty_ldisc_close(tty, old_ldisc);
Alan Cox01e1abb2008-07-22 11:16:55 +0100576
577 /* Now set up the new line discipline. */
Peter Hurleyf48070452013-03-11 16:44:42 -0400578 tty->ldisc = new_ldisc;
Alan Cox01e1abb2008-07-22 11:16:55 +0100579 tty_set_termios_ldisc(tty, ldisc);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100580
581 retval = tty_ldisc_open(tty, new_ldisc);
Alan Cox01e1abb2008-07-22 11:16:55 +0100582 if (retval < 0) {
Alan Coxc65c9bc2009-06-11 12:50:12 +0100583 /* Back to the old one or N_TTY if we can't */
584 tty_ldisc_put(new_ldisc);
Peter Hurley9fbfa342013-06-15 07:04:49 -0400585 tty_ldisc_restore(tty, old_ldisc);
Alan Cox01e1abb2008-07-22 11:16:55 +0100586 }
Alan Coxc65c9bc2009-06-11 12:50:12 +0100587
Peter Hurley9fbfa342013-06-15 07:04:49 -0400588 if (tty->ldisc->ops->num != old_ldisc->ops->num && tty->ops->set_ldisc)
Alan Cox01e1abb2008-07-22 11:16:55 +0100589 tty->ops->set_ldisc(tty);
590
Peter Hurleyb0e95852013-06-15 07:04:51 -0400591 /* At this point we hold a reference to the new ldisc and a
592 reference to the old ldisc, or we hold two references to
593 the old ldisc (if it was restored as part of error cleanup
594 above). In either case, releasing a single reference from
595 the old ldisc is correct. */
596
Peter Hurley9fbfa342013-06-15 07:04:49 -0400597 tty_ldisc_put(old_ldisc);
Alan Cox01e1abb2008-07-22 11:16:55 +0100598
599 /*
Alan Coxc65c9bc2009-06-11 12:50:12 +0100600 * Allow ldisc referencing to occur again
Alan Cox01e1abb2008-07-22 11:16:55 +0100601 */
Peter Hurley36697522013-06-15 07:04:48 -0400602 tty_ldisc_enable_pair(tty, o_tty);
Alan Cox01e1abb2008-07-22 11:16:55 +0100603
Alan Coxc65c9bc2009-06-11 12:50:12 +0100604 /* Restart the work queue in case no characters kick it off. Safe if
Alan Cox01e1abb2008-07-22 11:16:55 +0100605 already running */
Peter Hurley4f98d462013-03-11 16:44:34 -0400606 schedule_work(&tty->port->buf.work);
607 if (o_tty)
Jiri Slabyecbbfd42012-10-18 22:26:47 +0200608 schedule_work(&o_tty->port->buf.work);
Peter Hurley4f98d462013-03-11 16:44:34 -0400609
Alan Cox89c8d912012-08-08 16:30:13 +0100610 tty_unlock(tty);
Alan Cox01e1abb2008-07-22 11:16:55 +0100611 return retval;
612}
613
Alan Coxc65c9bc2009-06-11 12:50:12 +0100614/**
615 * tty_reset_termios - reset terminal state
616 * @tty: tty to reset
617 *
618 * Restore a terminal to the driver default state.
619 */
620
621static void tty_reset_termios(struct tty_struct *tty)
622{
Peter Hurley6a1c0682013-06-15 09:14:23 -0400623 down_write(&tty->termios_rwsem);
Alan Coxadc8d742012-07-14 15:31:47 +0100624 tty->termios = tty->driver->init_termios;
625 tty->termios.c_ispeed = tty_termios_input_baud_rate(&tty->termios);
626 tty->termios.c_ospeed = tty_termios_baud_rate(&tty->termios);
Peter Hurley6a1c0682013-06-15 09:14:23 -0400627 up_write(&tty->termios_rwsem);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100628}
629
630
631/**
632 * tty_ldisc_reinit - reinitialise the tty ldisc
633 * @tty: tty to reinit
Alan Cox638b9642010-02-08 10:09:26 +0000634 * @ldisc: line discipline to reinitialize
Alan Coxc65c9bc2009-06-11 12:50:12 +0100635 *
Alan Cox638b9642010-02-08 10:09:26 +0000636 * Switch the tty to a line discipline and leave the ldisc
637 * state closed
Alan Coxc65c9bc2009-06-11 12:50:12 +0100638 */
639
Philippe Rétornaz1c95ba12010-10-27 17:13:21 +0200640static int tty_ldisc_reinit(struct tty_struct *tty, int ldisc)
Alan Coxc65c9bc2009-06-11 12:50:12 +0100641{
Peter Hurley36697522013-06-15 07:04:48 -0400642 struct tty_ldisc *ld = tty_ldisc_get(tty, ldisc);
Philippe Rétornaz1c95ba12010-10-27 17:13:21 +0200643
644 if (IS_ERR(ld))
645 return -1;
Alan Coxc65c9bc2009-06-11 12:50:12 +0100646
647 tty_ldisc_close(tty, tty->ldisc);
648 tty_ldisc_put(tty->ldisc);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100649 /*
650 * Switch the line discipline back
651 */
Peter Hurleyf48070452013-03-11 16:44:42 -0400652 tty->ldisc = ld;
Alan Cox638b9642010-02-08 10:09:26 +0000653 tty_set_termios_ldisc(tty, ldisc);
Philippe Rétornaz1c95ba12010-10-27 17:13:21 +0200654
655 return 0;
Alan Coxc65c9bc2009-06-11 12:50:12 +0100656}
657
658/**
659 * tty_ldisc_hangup - hangup ldisc reset
660 * @tty: tty being hung up
661 *
662 * Some tty devices reset their termios when they receive a hangup
663 * event. In that situation we must also switch back to N_TTY properly
664 * before we reset the termios data.
665 *
666 * Locking: We can take the ldisc mutex as the rest of the code is
667 * careful to allow for this.
668 *
669 * In the pty pair case this occurs in the close() path of the
670 * tty itself so we must be careful about locking rules.
671 */
672
673void tty_ldisc_hangup(struct tty_struct *tty)
674{
675 struct tty_ldisc *ld;
Alan Cox638b9642010-02-08 10:09:26 +0000676 int reset = tty->driver->flags & TTY_DRIVER_RESET_TERMIOS;
677 int err = 0;
Alan Coxc65c9bc2009-06-11 12:50:12 +0100678
Peter Hurleyfc575ee2013-03-11 16:44:38 -0400679 tty_ldisc_debug(tty, "closing ldisc: %p\n", tty->ldisc);
680
Alan Coxc65c9bc2009-06-11 12:50:12 +0100681 ld = tty_ldisc_ref(tty);
682 if (ld != NULL) {
Alan Coxc65c9bc2009-06-11 12:50:12 +0100683 if (ld->ops->flush_buffer)
684 ld->ops->flush_buffer(tty);
685 tty_driver_flush_buffer(tty);
686 if ((test_bit(TTY_DO_WRITE_WAKEUP, &tty->flags)) &&
687 ld->ops->write_wakeup)
688 ld->ops->write_wakeup(tty);
689 if (ld->ops->hangup)
690 ld->ops->hangup(tty);
691 tty_ldisc_deref(ld);
692 }
Peter Hurley36697522013-06-15 07:04:48 -0400693
Alan Coxc65c9bc2009-06-11 12:50:12 +0100694 wake_up_interruptible_poll(&tty->write_wait, POLLOUT);
695 wake_up_interruptible_poll(&tty->read_wait, POLLIN);
Peter Hurley36697522013-06-15 07:04:48 -0400696
Alan Coxc65c9bc2009-06-11 12:50:12 +0100697 /*
698 * Shutdown the current line discipline, and reset it to
Alan Cox638b9642010-02-08 10:09:26 +0000699 * N_TTY if need be.
700 *
701 * Avoid racing set_ldisc or tty_ldisc_release
Alan Coxc65c9bc2009-06-11 12:50:12 +0100702 */
Peter Hurleyfae76e92014-11-05 12:13:07 -0500703 tty_ldisc_lock(tty, MAX_SCHEDULE_TIMEOUT);
Arnd Bergmann60af22d2010-06-01 22:53:06 +0200704
Peter Hurley36697522013-06-15 07:04:48 -0400705 if (tty->ldisc) {
Peter Hurleyc8785242013-03-11 16:44:36 -0400706
707 /* At this point we have a halted ldisc; we want to close it and
708 reopen a new ldisc. We could defer the reopen to the next
709 open but it means auditing a lot of other paths so this is
710 a FIXME */
Alan Cox638b9642010-02-08 10:09:26 +0000711 if (reset == 0) {
Philippe Rétornaz1c95ba12010-10-27 17:13:21 +0200712
Alan Coxadc8d742012-07-14 15:31:47 +0100713 if (!tty_ldisc_reinit(tty, tty->termios.c_line))
Philippe Rétornaz1c95ba12010-10-27 17:13:21 +0200714 err = tty_ldisc_open(tty, tty->ldisc);
715 else
716 err = 1;
Alan Coxc8d50042009-07-16 16:05:08 +0100717 }
Alan Cox638b9642010-02-08 10:09:26 +0000718 /* If the re-open fails or we reset then go to N_TTY. The
719 N_TTY open cannot fail */
720 if (reset || err) {
Philippe Rétornaz1c95ba12010-10-27 17:13:21 +0200721 BUG_ON(tty_ldisc_reinit(tty, N_TTY));
Alan Cox638b9642010-02-08 10:09:26 +0000722 WARN_ON(tty_ldisc_open(tty, tty->ldisc));
723 }
Alan Coxc65c9bc2009-06-11 12:50:12 +0100724 }
Peter Hurleyfae76e92014-11-05 12:13:07 -0500725 tty_ldisc_unlock(tty);
Alan Cox638b9642010-02-08 10:09:26 +0000726 if (reset)
727 tty_reset_termios(tty);
Peter Hurleyfc575ee2013-03-11 16:44:38 -0400728
729 tty_ldisc_debug(tty, "re-opened ldisc: %p\n", tty->ldisc);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100730}
Alan Cox01e1abb2008-07-22 11:16:55 +0100731
732/**
733 * tty_ldisc_setup - open line discipline
734 * @tty: tty being shut down
735 * @o_tty: pair tty for pty/tty pairs
736 *
737 * Called during the initial open of a tty/pty pair in order to set up the
Alan Coxc65c9bc2009-06-11 12:50:12 +0100738 * line disciplines and bind them to the tty. This has no locking issues
739 * as the device isn't yet active.
Alan Cox01e1abb2008-07-22 11:16:55 +0100740 */
741
742int tty_ldisc_setup(struct tty_struct *tty, struct tty_struct *o_tty)
743{
Alan Coxc65c9bc2009-06-11 12:50:12 +0100744 struct tty_ldisc *ld = tty->ldisc;
Alan Cox01e1abb2008-07-22 11:16:55 +0100745 int retval;
746
Alan Coxc65c9bc2009-06-11 12:50:12 +0100747 retval = tty_ldisc_open(tty, ld);
748 if (retval)
749 return retval;
750
751 if (o_tty) {
752 retval = tty_ldisc_open(o_tty, o_tty->ldisc);
Alan Cox01e1abb2008-07-22 11:16:55 +0100753 if (retval) {
Alan Coxc65c9bc2009-06-11 12:50:12 +0100754 tty_ldisc_close(tty, ld);
Alan Cox01e1abb2008-07-22 11:16:55 +0100755 return retval;
756 }
Alan Cox01e1abb2008-07-22 11:16:55 +0100757 }
Alan Cox01e1abb2008-07-22 11:16:55 +0100758 return 0;
759}
Alan Cox89c8d912012-08-08 16:30:13 +0100760
761static void tty_ldisc_kill(struct tty_struct *tty)
762{
Alan Cox89c8d912012-08-08 16:30:13 +0100763 /*
764 * Now kill off the ldisc
765 */
766 tty_ldisc_close(tty, tty->ldisc);
767 tty_ldisc_put(tty->ldisc);
768 /* Force an oops if we mess this up */
769 tty->ldisc = NULL;
770
771 /* Ensure the next open requests the N_TTY ldisc */
772 tty_set_termios_ldisc(tty, N_TTY);
Alan Cox89c8d912012-08-08 16:30:13 +0100773}
774
Alan Cox01e1abb2008-07-22 11:16:55 +0100775/**
776 * tty_ldisc_release - release line discipline
Peter Hurley62462ae2014-11-05 12:12:58 -0500777 * @tty: tty being shut down (or one end of pty pair)
Alan Cox01e1abb2008-07-22 11:16:55 +0100778 *
Peter Hurley62462ae2014-11-05 12:12:58 -0500779 * Called during the final close of a tty or a pty pair in order to shut
780 * down the line discpline layer. On exit, each ldisc assigned is N_TTY and
781 * each ldisc has not been opened.
Alan Cox01e1abb2008-07-22 11:16:55 +0100782 */
783
Peter Hurley62462ae2014-11-05 12:12:58 -0500784void tty_ldisc_release(struct tty_struct *tty)
Alan Cox01e1abb2008-07-22 11:16:55 +0100785{
Peter Hurley62462ae2014-11-05 12:12:58 -0500786 struct tty_struct *o_tty = tty->link;
787
Alan Cox01e1abb2008-07-22 11:16:55 +0100788 /*
Peter Hurleya2965b72013-03-11 16:44:35 -0400789 * Shutdown this line discipline. As this is the final close,
790 * it does not race with the set_ldisc code path.
Alan Cox01e1abb2008-07-22 11:16:55 +0100791 */
Alan Cox01e1abb2008-07-22 11:16:55 +0100792
Peter Hurleyfc575ee2013-03-11 16:44:38 -0400793 tty_ldisc_debug(tty, "closing ldisc: %p\n", tty->ldisc);
794
Peter Hurley36697522013-06-15 07:04:48 -0400795 tty_ldisc_lock_pair(tty, o_tty);
Alan Cox89c8d912012-08-08 16:30:13 +0100796 tty_ldisc_kill(tty);
Alan Cox89c8d912012-08-08 16:30:13 +0100797 if (o_tty)
798 tty_ldisc_kill(o_tty);
Peter Hurley36697522013-06-15 07:04:48 -0400799 tty_ldisc_unlock_pair(tty, o_tty);
800
Alan Coxaef29bc2009-06-29 15:21:47 +0100801 /* And the memory resources remaining (buffers, termios) will be
802 disposed of when the kref hits zero */
Peter Hurleyfc575ee2013-03-11 16:44:38 -0400803
804 tty_ldisc_debug(tty, "ldisc closed\n");
Alan Cox01e1abb2008-07-22 11:16:55 +0100805}
806
807/**
808 * tty_ldisc_init - ldisc setup for new tty
809 * @tty: tty being allocated
810 *
811 * Set up the line discipline objects for a newly allocated tty. Note that
812 * the tty structure is not completely set up when this call is made.
813 */
814
815void tty_ldisc_init(struct tty_struct *tty)
816{
Peter Hurley36697522013-06-15 07:04:48 -0400817 struct tty_ldisc *ld = tty_ldisc_get(tty, N_TTY);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100818 if (IS_ERR(ld))
Alan Cox01e1abb2008-07-22 11:16:55 +0100819 panic("n_tty: init_tty");
Peter Hurleyf48070452013-03-11 16:44:42 -0400820 tty->ldisc = ld;
Alan Cox01e1abb2008-07-22 11:16:55 +0100821}
822
Jiri Slaby67166712011-03-23 10:48:35 +0100823/**
824 * tty_ldisc_init - ldisc cleanup for new tty
825 * @tty: tty that was allocated recently
826 *
827 * The tty structure must not becompletely set up (tty_ldisc_setup) when
828 * this call is made.
829 */
830void tty_ldisc_deinit(struct tty_struct *tty)
831{
Peter Hurleyebc9bae2013-03-11 16:44:40 -0400832 tty_ldisc_put(tty->ldisc);
Peter Hurleyf48070452013-03-11 16:44:42 -0400833 tty->ldisc = NULL;
Jiri Slaby67166712011-03-23 10:48:35 +0100834}
835
Alan Cox01e1abb2008-07-22 11:16:55 +0100836void tty_ldisc_begin(void)
837{
838 /* Setup the default TTY line discipline. */
839 (void) tty_register_ldisc(N_TTY, &tty_ldisc_N_TTY);
840}