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