]> git.proxmox.com Git - mirror_ubuntu-artful-kernel.git/blame - drivers/tty/tty_ldisc.c
Merge branches 'for-4.4/upstream-fixes', 'for-4.5/async-suspend', 'for-4.5/container...
[mirror_ubuntu-artful-kernel.git] / drivers / tty / tty_ldisc.c
CommitLineData
01e1abb2 1#include <linux/types.h>
01e1abb2 2#include <linux/errno.h>
8b3ffa17 3#include <linux/kmod.h>
01e1abb2
AC
4#include <linux/sched.h>
5#include <linux/interrupt.h>
6#include <linux/tty.h>
7#include <linux/tty_driver.h>
01e1abb2 8#include <linux/file.h>
01e1abb2
AC
9#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>
01e1abb2 14#include <linux/module.h>
01e1abb2
AC
15#include <linux/device.h>
16#include <linux/wait.h>
17#include <linux/bitops.h>
01e1abb2 18#include <linux/seq_file.h>
01e1abb2 19#include <linux/uaccess.h>
0c73c08e 20#include <linux/ratelimit.h>
01e1abb2 21
fc575ee6
PH
22#undef LDISC_DEBUG_HANGUP
23
24#ifdef LDISC_DEBUG_HANGUP
0a6adc13 25#define tty_ldisc_debug(tty, f, args...) tty_debug(tty, f, ##args)
fc575ee6
PH
26#else
27#define tty_ldisc_debug(tty, f, args...)
28#endif
29
d2c43890
PH
30/* lockdep nested classes for tty->ldisc_sem */
31enum {
32 LDISC_SEM_NORMAL,
33 LDISC_SEM_OTHER,
34};
35
36
01e1abb2
AC
37/*
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
137084bb 43static DEFINE_RAW_SPINLOCK(tty_ldiscs_lock);
01e1abb2
AC
44/* 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:
137084bb 57 * takes tty_ldiscs_lock to guard against ldisc races
01e1abb2
AC
58 */
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
137084bb 68 raw_spin_lock_irqsave(&tty_ldiscs_lock, flags);
01e1abb2
AC
69 tty_ldiscs[disc] = new_ldisc;
70 new_ldisc->num = disc;
71 new_ldisc->refcount = 0;
137084bb 72 raw_spin_unlock_irqrestore(&tty_ldiscs_lock, flags);
01e1abb2
AC
73
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:
137084bb 87 * takes tty_ldiscs_lock to guard against ldisc races
01e1abb2
AC
88 */
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
137084bb 98 raw_spin_lock_irqsave(&tty_ldiscs_lock, flags);
01e1abb2
AC
99 if (tty_ldiscs[disc]->refcount)
100 ret = -EBUSY;
101 else
102 tty_ldiscs[disc] = NULL;
137084bb 103 raw_spin_unlock_irqrestore(&tty_ldiscs_lock, flags);
01e1abb2
AC
104
105 return ret;
106}
107EXPORT_SYMBOL(tty_unregister_ldisc);
108
f0de0e8d
LT
109static struct tty_ldisc_ops *get_ldops(int disc)
110{
111 unsigned long flags;
112 struct tty_ldisc_ops *ldops, *ret;
113
137084bb 114 raw_spin_lock_irqsave(&tty_ldiscs_lock, flags);
f0de0e8d
LT
115 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 }
137084bb 124 raw_spin_unlock_irqrestore(&tty_ldiscs_lock, flags);
f0de0e8d
LT
125 return ret;
126}
127
128static void put_ldops(struct tty_ldisc_ops *ldops)
129{
130 unsigned long flags;
131
137084bb 132 raw_spin_lock_irqsave(&tty_ldiscs_lock, flags);
f0de0e8d
LT
133 ldops->refcount--;
134 module_put(ldops->owner);
137084bb 135 raw_spin_unlock_irqrestore(&tty_ldiscs_lock, flags);
f0de0e8d 136}
01e1abb2 137
01e1abb2
AC
138/**
139 * tty_ldisc_get - take a reference to an ldisc
140 * @disc: ldisc number
01e1abb2
AC
141 *
142 * Takes a reference to a line discipline. Deals with refcounts and
143 * module locking counts. Returns NULL if the discipline is not available.
144 * Returns a pointer to the discipline and bumps the ref count if it is
145 * available
146 *
147 * Locking:
137084bb 148 * takes tty_ldiscs_lock to guard against ldisc races
01e1abb2
AC
149 */
150
36697529 151static struct tty_ldisc *tty_ldisc_get(struct tty_struct *tty, int disc)
01e1abb2 152{
c65c9bc3 153 struct tty_ldisc *ld;
182274f8 154 struct tty_ldisc_ops *ldops;
01e1abb2
AC
155
156 if (disc < N_TTY || disc >= NR_LDISCS)
c65c9bc3 157 return ERR_PTR(-EINVAL);
182274f8
LT
158
159 /*
160 * Get the ldisc ops - we may need to request them to be loaded
161 * dynamically and try again.
162 */
163 ldops = get_ldops(disc);
164 if (IS_ERR(ldops)) {
01e1abb2 165 request_module("tty-ldisc-%d", disc);
182274f8
LT
166 ldops = get_ldops(disc);
167 if (IS_ERR(ldops))
168 return ERR_CAST(ldops);
169 }
170
171 ld = kmalloc(sizeof(struct tty_ldisc), GFP_KERNEL);
172 if (ld == NULL) {
173 put_ldops(ldops);
174 return ERR_PTR(-ENOMEM);
01e1abb2 175 }
182274f8
LT
176
177 ld->ops = ldops;
36697529 178 ld->tty = tty;
1541f845 179
c65c9bc3 180 return ld;
01e1abb2
AC
181}
182
734de249
PH
183/**
184 * tty_ldisc_put - release the ldisc
185 *
186 * Complement of tty_ldisc_get().
187 */
188static inline void tty_ldisc_put(struct tty_ldisc *ld)
189{
734de249
PH
190 if (WARN_ON_ONCE(!ld))
191 return;
192
36697529 193 put_ldops(ld->ops);
734de249 194 kfree(ld);
734de249
PH
195}
196
852e99d2 197static void *tty_ldiscs_seq_start(struct seq_file *m, loff_t *pos)
01e1abb2
AC
198{
199 return (*pos < NR_LDISCS) ? pos : NULL;
200}
201
852e99d2 202static void *tty_ldiscs_seq_next(struct seq_file *m, void *v, loff_t *pos)
01e1abb2
AC
203{
204 (*pos)++;
205 return (*pos < NR_LDISCS) ? pos : NULL;
206}
207
208static void tty_ldiscs_seq_stop(struct seq_file *m, void *v)
209{
210}
211
212static int tty_ldiscs_seq_show(struct seq_file *m, void *v)
213{
214 int i = *(loff_t *)v;
f0de0e8d 215 struct tty_ldisc_ops *ldops;
852e99d2 216
f0de0e8d
LT
217 ldops = get_ldops(i);
218 if (IS_ERR(ldops))
01e1abb2 219 return 0;
f0de0e8d
LT
220 seq_printf(m, "%-10s %2d\n", ldops->name ? ldops->name : "???", i);
221 put_ldops(ldops);
01e1abb2
AC
222 return 0;
223}
224
225static const struct seq_operations tty_ldiscs_seq_ops = {
226 .start = tty_ldiscs_seq_start,
227 .next = tty_ldiscs_seq_next,
228 .stop = tty_ldiscs_seq_stop,
229 .show = tty_ldiscs_seq_show,
230};
231
232static int proc_tty_ldiscs_open(struct inode *inode, struct file *file)
233{
234 return seq_open(file, &tty_ldiscs_seq_ops);
235}
236
237const struct file_operations tty_ldiscs_proc_fops = {
238 .owner = THIS_MODULE,
239 .open = proc_tty_ldiscs_open,
240 .read = seq_read,
241 .llseek = seq_lseek,
242 .release = seq_release,
243};
244
01e1abb2
AC
245/**
246 * tty_ldisc_ref_wait - wait for the tty ldisc
247 * @tty: tty device
248 *
249 * Dereference the line discipline for the terminal and take a
250 * reference to it. If the line discipline is in flux then
251 * wait patiently until it changes.
252 *
253 * Note: Must not be called from an IRQ/timer context. The caller
254 * must also be careful not to hold other locks that will deadlock
255 * against a discipline change, such as an existing ldisc reference
256 * (which we check for)
257 *
36697529
PH
258 * Note: only callable from a file_operations routine (which
259 * guarantees tty->ldisc != NULL when the lock is acquired).
01e1abb2
AC
260 */
261
262struct tty_ldisc *tty_ldisc_ref_wait(struct tty_struct *tty)
263{
36697529
PH
264 ldsem_down_read(&tty->ldisc_sem, MAX_SCHEDULE_TIMEOUT);
265 WARN_ON(!tty->ldisc);
266 return tty->ldisc;
01e1abb2 267}
01e1abb2
AC
268EXPORT_SYMBOL_GPL(tty_ldisc_ref_wait);
269
270/**
271 * tty_ldisc_ref - get the tty ldisc
272 * @tty: tty device
273 *
274 * Dereference the line discipline for the terminal and take a
275 * reference to it. If the line discipline is in flux then
276 * return NULL. Can be called from IRQ and timer functions.
01e1abb2
AC
277 */
278
279struct tty_ldisc *tty_ldisc_ref(struct tty_struct *tty)
280{
36697529
PH
281 struct tty_ldisc *ld = NULL;
282
283 if (ldsem_down_read_trylock(&tty->ldisc_sem)) {
284 ld = tty->ldisc;
285 if (!ld)
286 ldsem_up_read(&tty->ldisc_sem);
287 }
288 return ld;
01e1abb2 289}
01e1abb2
AC
290EXPORT_SYMBOL_GPL(tty_ldisc_ref);
291
292/**
293 * tty_ldisc_deref - free a tty ldisc reference
294 * @ld: reference to free up
295 *
296 * Undoes the effect of tty_ldisc_ref or tty_ldisc_ref_wait. May
297 * be called in IRQ context.
01e1abb2
AC
298 */
299
300void tty_ldisc_deref(struct tty_ldisc *ld)
301{
36697529 302 ldsem_up_read(&ld->tty->ldisc_sem);
01e1abb2 303}
01e1abb2
AC
304EXPORT_SYMBOL_GPL(tty_ldisc_deref);
305
d2c43890
PH
306
307static inline int __lockfunc
e80a10ee 308__tty_ldisc_lock(struct tty_struct *tty, unsigned long timeout)
d2c43890
PH
309{
310 return ldsem_down_write(&tty->ldisc_sem, timeout);
311}
312
313static inline int __lockfunc
e80a10ee 314__tty_ldisc_lock_nested(struct tty_struct *tty, unsigned long timeout)
d2c43890
PH
315{
316 return ldsem_down_write_nested(&tty->ldisc_sem,
317 LDISC_SEM_OTHER, timeout);
318}
319
e80a10ee 320static inline void __tty_ldisc_unlock(struct tty_struct *tty)
d2c43890 321{
52772ea6 322 ldsem_up_write(&tty->ldisc_sem);
d2c43890
PH
323}
324
fae76e9a
PH
325static int __lockfunc
326tty_ldisc_lock(struct tty_struct *tty, unsigned long timeout)
327{
328 int ret;
329
330 ret = __tty_ldisc_lock(tty, timeout);
331 if (!ret)
332 return -EBUSY;
333 set_bit(TTY_LDISC_HALTED, &tty->flags);
334 return 0;
335}
336
337static void tty_ldisc_unlock(struct tty_struct *tty)
338{
339 clear_bit(TTY_LDISC_HALTED, &tty->flags);
340 __tty_ldisc_unlock(tty);
341}
342
d2c43890
PH
343static int __lockfunc
344tty_ldisc_lock_pair_timeout(struct tty_struct *tty, struct tty_struct *tty2,
345 unsigned long timeout)
346{
347 int ret;
348
349 if (tty < tty2) {
e80a10ee 350 ret = __tty_ldisc_lock(tty, timeout);
d2c43890 351 if (ret) {
e80a10ee 352 ret = __tty_ldisc_lock_nested(tty2, timeout);
d2c43890 353 if (!ret)
e80a10ee 354 __tty_ldisc_unlock(tty);
d2c43890
PH
355 }
356 } else {
357 /* if this is possible, it has lots of implications */
358 WARN_ON_ONCE(tty == tty2);
359 if (tty2 && tty != tty2) {
e80a10ee 360 ret = __tty_ldisc_lock(tty2, timeout);
d2c43890 361 if (ret) {
e80a10ee 362 ret = __tty_ldisc_lock_nested(tty, timeout);
d2c43890 363 if (!ret)
e80a10ee 364 __tty_ldisc_unlock(tty2);
d2c43890
PH
365 }
366 } else
e80a10ee 367 ret = __tty_ldisc_lock(tty, timeout);
d2c43890
PH
368 }
369
370 if (!ret)
371 return -EBUSY;
372
373 set_bit(TTY_LDISC_HALTED, &tty->flags);
374 if (tty2)
375 set_bit(TTY_LDISC_HALTED, &tty2->flags);
376 return 0;
377}
378
379static void __lockfunc
380tty_ldisc_lock_pair(struct tty_struct *tty, struct tty_struct *tty2)
381{
382 tty_ldisc_lock_pair_timeout(tty, tty2, MAX_SCHEDULE_TIMEOUT);
383}
384
385static void __lockfunc tty_ldisc_unlock_pair(struct tty_struct *tty,
386 struct tty_struct *tty2)
387{
e80a10ee 388 __tty_ldisc_unlock(tty);
d2c43890 389 if (tty2)
e80a10ee 390 __tty_ldisc_unlock(tty2);
d2c43890
PH
391}
392
f2c4c65c
AC
393/**
394 * tty_ldisc_flush - flush line discipline queue
395 * @tty: tty
396 *
86c80a8e
PH
397 * Flush the line discipline queue (if any) and the tty flip buffers
398 * for this tty.
f2c4c65c
AC
399 */
400
401void tty_ldisc_flush(struct tty_struct *tty)
402{
403 struct tty_ldisc *ld = tty_ldisc_ref(tty);
86c80a8e
PH
404
405 tty_buffer_flush(tty, ld);
406 if (ld)
f2c4c65c 407 tty_ldisc_deref(ld);
f2c4c65c 408}
f2c4c65c
AC
409EXPORT_SYMBOL_GPL(tty_ldisc_flush);
410
01e1abb2
AC
411/**
412 * tty_set_termios_ldisc - set ldisc field
413 * @tty: tty structure
414 * @num: line discipline number
415 *
416 * This is probably overkill for real world processors but
417 * they are not on hot paths so a little discipline won't do
418 * any harm.
419 *
6a1c0680 420 * Locking: takes termios_rwsem
01e1abb2
AC
421 */
422
423static void tty_set_termios_ldisc(struct tty_struct *tty, int num)
424{
6a1c0680 425 down_write(&tty->termios_rwsem);
adc8d746 426 tty->termios.c_line = num;
6a1c0680 427 up_write(&tty->termios_rwsem);
01e1abb2
AC
428}
429
c65c9bc3
AC
430/**
431 * tty_ldisc_open - open a line discipline
432 * @tty: tty we are opening the ldisc on
433 * @ld: discipline to open
434 *
435 * A helper opening method. Also a convenient debugging and check
436 * point.
ec79d605
AB
437 *
438 * Locking: always called with BTM already held.
c65c9bc3
AC
439 */
440
441static int tty_ldisc_open(struct tty_struct *tty, struct tty_ldisc *ld)
442{
443 WARN_ON(test_and_set_bit(TTY_LDISC_OPEN, &tty->flags));
f18f9498
AC
444 if (ld->ops->open) {
445 int ret;
ec79d605 446 /* BTM here locks versus a hangup event */
f18f9498 447 ret = ld->ops->open(tty);
7f90cfc5
JS
448 if (ret)
449 clear_bit(TTY_LDISC_OPEN, &tty->flags);
fb6edc91
PH
450
451 tty_ldisc_debug(tty, "%p: opened\n", tty->ldisc);
f18f9498
AC
452 return ret;
453 }
c65c9bc3
AC
454 return 0;
455}
456
457/**
458 * tty_ldisc_close - close a line discipline
459 * @tty: tty we are opening the ldisc on
460 * @ld: discipline to close
461 *
462 * A helper close method. Also a convenient debugging and check
463 * point.
464 */
465
466static void tty_ldisc_close(struct tty_struct *tty, struct tty_ldisc *ld)
467{
468 WARN_ON(!test_bit(TTY_LDISC_OPEN, &tty->flags));
469 clear_bit(TTY_LDISC_OPEN, &tty->flags);
470 if (ld->ops->close)
471 ld->ops->close(tty);
fb6edc91 472 tty_ldisc_debug(tty, "%p: closed\n", tty->ldisc);
c65c9bc3 473}
01e1abb2
AC
474
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{
c65c9bc3
AC
486 struct tty_ldisc *new_ldisc;
487 int r;
01e1abb2
AC
488
489 /* There is an outstanding reference here so this is safe */
36697529 490 old = tty_ldisc_get(tty, old->ops->num);
c65c9bc3 491 WARN_ON(IS_ERR(old));
f4807045 492 tty->ldisc = old;
01e1abb2 493 tty_set_termios_ldisc(tty, old->ops->num);
c65c9bc3
AC
494 if (tty_ldisc_open(tty, old) < 0) {
495 tty_ldisc_put(old);
01e1abb2 496 /* This driver is always present */
36697529 497 new_ldisc = tty_ldisc_get(tty, N_TTY);
c65c9bc3 498 if (IS_ERR(new_ldisc))
01e1abb2 499 panic("n_tty: get");
f4807045 500 tty->ldisc = new_ldisc;
01e1abb2 501 tty_set_termios_ldisc(tty, N_TTY);
c65c9bc3
AC
502 r = tty_ldisc_open(tty, new_ldisc);
503 if (r < 0)
504 panic("Couldn't open N_TTY ldisc for "
505 "%s --- error %d.",
429b4749 506 tty_name(tty), r);
01e1abb2
AC
507 }
508}
509
510/**
511 * tty_set_ldisc - set line discipline
512 * @tty: the terminal to set
513 * @ldisc: the line discipline
514 *
515 * Set the discipline of a tty line. Must be called from a process
c65c9bc3
AC
516 * context. The ldisc change logic has to protect itself against any
517 * overlapping ldisc change (including on the other end of pty pairs),
518 * the close of one side of a tty/pty pair, and eventually hangup.
01e1abb2
AC
519 */
520
521int tty_set_ldisc(struct tty_struct *tty, int ldisc)
522{
523 int retval;
9fbfa34c 524 struct tty_ldisc *old_ldisc, *new_ldisc;
01e1abb2 525
36697529 526 new_ldisc = tty_ldisc_get(tty, ldisc);
c65c9bc3
AC
527 if (IS_ERR(new_ldisc))
528 return PTR_ERR(new_ldisc);
01e1abb2 529
c8483bc9 530 tty_lock(tty);
276a661a 531 retval = tty_ldisc_lock(tty, 5 * HZ);
36697529
PH
532 if (retval) {
533 tty_ldisc_put(new_ldisc);
c8483bc9 534 tty_unlock(tty);
36697529
PH
535 return retval;
536 }
01e1abb2 537
c65c9bc3
AC
538 /*
539 * Check the no-op case
540 */
541
542 if (tty->ldisc->ops->num == ldisc) {
276a661a 543 tty_ldisc_unlock(tty);
c65c9bc3 544 tty_ldisc_put(new_ldisc);
c8483bc9 545 tty_unlock(tty);
01e1abb2
AC
546 return 0;
547 }
548
9fbfa34c 549 old_ldisc = tty->ldisc;
100eeae2 550
3ff51a19 551 if (test_bit(TTY_HUPPED, &tty->flags)) {
c65c9bc3
AC
552 /* We were raced by the hangup method. It will have stomped
553 the ldisc data and closed the ldisc down */
276a661a 554 tty_ldisc_unlock(tty);
c65c9bc3 555 tty_ldisc_put(new_ldisc);
89c8d91e 556 tty_unlock(tty);
c65c9bc3
AC
557 return -EIO;
558 }
559
9fbfa34c
PH
560 /* Shutdown the old discipline. */
561 tty_ldisc_close(tty, old_ldisc);
01e1abb2
AC
562
563 /* Now set up the new line discipline. */
f4807045 564 tty->ldisc = new_ldisc;
01e1abb2 565 tty_set_termios_ldisc(tty, ldisc);
c65c9bc3
AC
566
567 retval = tty_ldisc_open(tty, new_ldisc);
01e1abb2 568 if (retval < 0) {
c65c9bc3
AC
569 /* Back to the old one or N_TTY if we can't */
570 tty_ldisc_put(new_ldisc);
9fbfa34c 571 tty_ldisc_restore(tty, old_ldisc);
01e1abb2 572 }
c65c9bc3 573
9191aaaa
PH
574 if (tty->ldisc->ops->num != old_ldisc->ops->num && tty->ops->set_ldisc) {
575 down_read(&tty->termios_rwsem);
01e1abb2 576 tty->ops->set_ldisc(tty);
9191aaaa
PH
577 up_read(&tty->termios_rwsem);
578 }
01e1abb2 579
b0e95858
PH
580 /* At this point we hold a reference to the new ldisc and a
581 reference to the old ldisc, or we hold two references to
582 the old ldisc (if it was restored as part of error cleanup
583 above). In either case, releasing a single reference from
584 the old ldisc is correct. */
585
9fbfa34c 586 tty_ldisc_put(old_ldisc);
01e1abb2
AC
587
588 /*
c65c9bc3 589 * Allow ldisc referencing to occur again
01e1abb2 590 */
276a661a 591 tty_ldisc_unlock(tty);
01e1abb2 592
c65c9bc3 593 /* Restart the work queue in case no characters kick it off. Safe if
01e1abb2 594 already running */
17a69219 595 tty_buffer_restart_work(tty->port);
4f98d467 596
89c8d91e 597 tty_unlock(tty);
01e1abb2
AC
598 return retval;
599}
600
c65c9bc3
AC
601/**
602 * tty_reset_termios - reset terminal state
603 * @tty: tty to reset
604 *
605 * Restore a terminal to the driver default state.
606 */
607
608static void tty_reset_termios(struct tty_struct *tty)
609{
6a1c0680 610 down_write(&tty->termios_rwsem);
adc8d746
AC
611 tty->termios = tty->driver->init_termios;
612 tty->termios.c_ispeed = tty_termios_input_baud_rate(&tty->termios);
613 tty->termios.c_ospeed = tty_termios_baud_rate(&tty->termios);
6a1c0680 614 up_write(&tty->termios_rwsem);
c65c9bc3
AC
615}
616
617
618/**
619 * tty_ldisc_reinit - reinitialise the tty ldisc
620 * @tty: tty to reinit
638b9648 621 * @ldisc: line discipline to reinitialize
c65c9bc3 622 *
638b9648
AC
623 * Switch the tty to a line discipline and leave the ldisc
624 * state closed
c65c9bc3
AC
625 */
626
1c95ba1e 627static int tty_ldisc_reinit(struct tty_struct *tty, int ldisc)
c65c9bc3 628{
36697529 629 struct tty_ldisc *ld = tty_ldisc_get(tty, ldisc);
1c95ba1e
PR
630
631 if (IS_ERR(ld))
632 return -1;
c65c9bc3
AC
633
634 tty_ldisc_close(tty, tty->ldisc);
635 tty_ldisc_put(tty->ldisc);
c65c9bc3
AC
636 /*
637 * Switch the line discipline back
638 */
f4807045 639 tty->ldisc = ld;
638b9648 640 tty_set_termios_ldisc(tty, ldisc);
1c95ba1e
PR
641
642 return 0;
c65c9bc3
AC
643}
644
645/**
646 * tty_ldisc_hangup - hangup ldisc reset
647 * @tty: tty being hung up
648 *
649 * Some tty devices reset their termios when they receive a hangup
650 * event. In that situation we must also switch back to N_TTY properly
651 * before we reset the termios data.
652 *
653 * Locking: We can take the ldisc mutex as the rest of the code is
654 * careful to allow for this.
655 *
656 * In the pty pair case this occurs in the close() path of the
657 * tty itself so we must be careful about locking rules.
658 */
659
660void tty_ldisc_hangup(struct tty_struct *tty)
661{
662 struct tty_ldisc *ld;
638b9648
AC
663 int reset = tty->driver->flags & TTY_DRIVER_RESET_TERMIOS;
664 int err = 0;
c65c9bc3 665
fb6edc91 666 tty_ldisc_debug(tty, "%p: closing\n", tty->ldisc);
fc575ee6 667
c65c9bc3
AC
668 ld = tty_ldisc_ref(tty);
669 if (ld != NULL) {
c65c9bc3
AC
670 if (ld->ops->flush_buffer)
671 ld->ops->flush_buffer(tty);
672 tty_driver_flush_buffer(tty);
673 if ((test_bit(TTY_DO_WRITE_WAKEUP, &tty->flags)) &&
674 ld->ops->write_wakeup)
675 ld->ops->write_wakeup(tty);
676 if (ld->ops->hangup)
677 ld->ops->hangup(tty);
678 tty_ldisc_deref(ld);
679 }
36697529 680
c65c9bc3
AC
681 wake_up_interruptible_poll(&tty->write_wait, POLLOUT);
682 wake_up_interruptible_poll(&tty->read_wait, POLLIN);
36697529 683
c65c9bc3
AC
684 /*
685 * Shutdown the current line discipline, and reset it to
638b9648
AC
686 * N_TTY if need be.
687 *
688 * Avoid racing set_ldisc or tty_ldisc_release
c65c9bc3 689 */
fae76e9a 690 tty_ldisc_lock(tty, MAX_SCHEDULE_TIMEOUT);
60af22d2 691
36697529 692 if (tty->ldisc) {
c8785241
PH
693
694 /* At this point we have a halted ldisc; we want to close it and
695 reopen a new ldisc. We could defer the reopen to the next
696 open but it means auditing a lot of other paths so this is
697 a FIXME */
638b9648 698 if (reset == 0) {
1c95ba1e 699
adc8d746 700 if (!tty_ldisc_reinit(tty, tty->termios.c_line))
1c95ba1e
PR
701 err = tty_ldisc_open(tty, tty->ldisc);
702 else
703 err = 1;
638b9648
AC
704 }
705 /* If the re-open fails or we reset then go to N_TTY. The
706 N_TTY open cannot fail */
707 if (reset || err) {
1c95ba1e 708 BUG_ON(tty_ldisc_reinit(tty, N_TTY));
c8d50041 709 WARN_ON(tty_ldisc_open(tty, tty->ldisc));
c8d50041 710 }
c65c9bc3 711 }
fae76e9a 712 tty_ldisc_unlock(tty);
638b9648
AC
713 if (reset)
714 tty_reset_termios(tty);
fc575ee6 715
fb6edc91 716 tty_ldisc_debug(tty, "%p: re-opened\n", tty->ldisc);
c65c9bc3 717}
01e1abb2
AC
718
719/**
720 * tty_ldisc_setup - open line discipline
721 * @tty: tty being shut down
722 * @o_tty: pair tty for pty/tty pairs
723 *
724 * Called during the initial open of a tty/pty pair in order to set up the
c65c9bc3
AC
725 * line disciplines and bind them to the tty. This has no locking issues
726 * as the device isn't yet active.
01e1abb2
AC
727 */
728
729int tty_ldisc_setup(struct tty_struct *tty, struct tty_struct *o_tty)
730{
c65c9bc3 731 struct tty_ldisc *ld = tty->ldisc;
01e1abb2
AC
732 int retval;
733
c65c9bc3
AC
734 retval = tty_ldisc_open(tty, ld);
735 if (retval)
736 return retval;
737
738 if (o_tty) {
739 retval = tty_ldisc_open(o_tty, o_tty->ldisc);
01e1abb2 740 if (retval) {
c65c9bc3 741 tty_ldisc_close(tty, ld);
01e1abb2
AC
742 return retval;
743 }
01e1abb2 744 }
01e1abb2
AC
745 return 0;
746}
89c8d91e
AC
747
748static void tty_ldisc_kill(struct tty_struct *tty)
749{
89c8d91e
AC
750 /*
751 * Now kill off the ldisc
752 */
753 tty_ldisc_close(tty, tty->ldisc);
754 tty_ldisc_put(tty->ldisc);
755 /* Force an oops if we mess this up */
756 tty->ldisc = NULL;
757
758 /* Ensure the next open requests the N_TTY ldisc */
759 tty_set_termios_ldisc(tty, N_TTY);
89c8d91e
AC
760}
761
01e1abb2
AC
762/**
763 * tty_ldisc_release - release line discipline
62462aef 764 * @tty: tty being shut down (or one end of pty pair)
3ee175d9 765 *
62462aef
PH
766 * Called during the final close of a tty or a pty pair in order to shut
767 * down the line discpline layer. On exit, each ldisc assigned is N_TTY and
768 * each ldisc has not been opened.
01e1abb2
AC
769 */
770
62462aef 771void tty_ldisc_release(struct tty_struct *tty)
01e1abb2 772{
62462aef
PH
773 struct tty_struct *o_tty = tty->link;
774
01e1abb2 775 /*
a2965b7b
PH
776 * Shutdown this line discipline. As this is the final close,
777 * it does not race with the set_ldisc code path.
01e1abb2 778 */
01e1abb2 779
36697529 780 tty_ldisc_lock_pair(tty, o_tty);
89c8d91e 781 tty_ldisc_kill(tty);
c65c9bc3 782 if (o_tty)
89c8d91e 783 tty_ldisc_kill(o_tty);
36697529
PH
784 tty_ldisc_unlock_pair(tty, o_tty);
785
aef29bc2
AC
786 /* And the memory resources remaining (buffers, termios) will be
787 disposed of when the kref hits zero */
fc575ee6 788
fb6edc91 789 tty_ldisc_debug(tty, "released\n");
01e1abb2
AC
790}
791
792/**
793 * tty_ldisc_init - ldisc setup for new tty
794 * @tty: tty being allocated
795 *
796 * Set up the line discipline objects for a newly allocated tty. Note that
797 * the tty structure is not completely set up when this call is made.
798 */
799
800void tty_ldisc_init(struct tty_struct *tty)
801{
36697529 802 struct tty_ldisc *ld = tty_ldisc_get(tty, N_TTY);
c65c9bc3 803 if (IS_ERR(ld))
01e1abb2 804 panic("n_tty: init_tty");
f4807045 805 tty->ldisc = ld;
01e1abb2
AC
806}
807
6716671d
JS
808/**
809 * tty_ldisc_init - ldisc cleanup for new tty
810 * @tty: tty that was allocated recently
811 *
812 * The tty structure must not becompletely set up (tty_ldisc_setup) when
813 * this call is made.
814 */
815void tty_ldisc_deinit(struct tty_struct *tty)
816{
ebc9baed 817 tty_ldisc_put(tty->ldisc);
f4807045 818 tty->ldisc = NULL;
6716671d
JS
819}
820
01e1abb2
AC
821void tty_ldisc_begin(void)
822{
823 /* Setup the default TTY line discipline. */
824 (void) tty_register_ldisc(N_TTY, &tty_ldisc_N_TTY);
825}