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