TTY: pty, cleanup the pty counting
[GitHub/mt8127/android_kernel_alcatel_ttab.git] / drivers / tty / tty_ldisc.c
CommitLineData
01e1abb2
AC
1#include <linux/types.h>
2#include <linux/major.h>
3#include <linux/errno.h>
4#include <linux/signal.h>
5#include <linux/fcntl.h>
6#include <linux/sched.h>
7#include <linux/interrupt.h>
8#include <linux/tty.h>
9#include <linux/tty_driver.h>
10#include <linux/tty_flip.h>
11#include <linux/devpts_fs.h>
12#include <linux/file.h>
01e1abb2
AC
13#include <linux/console.h>
14#include <linux/timer.h>
15#include <linux/ctype.h>
16#include <linux/kd.h>
17#include <linux/mm.h>
18#include <linux/string.h>
19#include <linux/slab.h>
20#include <linux/poll.h>
21#include <linux/proc_fs.h>
22#include <linux/init.h>
23#include <linux/module.h>
01e1abb2
AC
24#include <linux/device.h>
25#include <linux/wait.h>
26#include <linux/bitops.h>
27#include <linux/delay.h>
28#include <linux/seq_file.h>
29
30#include <linux/uaccess.h>
31#include <asm/system.h>
32
33#include <linux/kbd_kern.h>
34#include <linux/vt_kern.h>
35#include <linux/selection.h>
36
37#include <linux/kmod.h>
38#include <linux/nsproxy.h>
39
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
46static DEFINE_SPINLOCK(tty_ldisc_lock);
47static DECLARE_WAIT_QUEUE_HEAD(tty_ldisc_wait);
100eeae2 48static DECLARE_WAIT_QUEUE_HEAD(tty_ldisc_idle);
01e1abb2
AC
49/* Line disc dispatch table */
50static struct tty_ldisc_ops *tty_ldiscs[NR_LDISCS];
51
65b77046
LT
52static inline struct tty_ldisc *get_ldisc(struct tty_ldisc *ld)
53{
54 if (ld)
55 atomic_inc(&ld->users);
56 return ld;
57}
58
cbe9352f 59static void put_ldisc(struct tty_ldisc *ld)
65b77046 60{
cbe9352f
LT
61 unsigned long flags;
62
65b77046
LT
63 if (WARN_ON_ONCE(!ld))
64 return;
65
66 /*
67 * If this is the last user, free the ldisc, and
68 * release the ldisc ops.
cbe9352f
LT
69 *
70 * We really want an "atomic_dec_and_lock_irqsave()",
71 * but we don't have it, so this does it by hand.
65b77046 72 */
cbe9352f
LT
73 local_irq_save(flags);
74 if (atomic_dec_and_lock(&ld->users, &tty_ldisc_lock)) {
65b77046
LT
75 struct tty_ldisc_ops *ldo = ld->ops;
76
65b77046
LT
77 ldo->refcount--;
78 module_put(ldo->owner);
79 spin_unlock_irqrestore(&tty_ldisc_lock, flags);
cbe9352f
LT
80
81 kfree(ld);
82 return;
65b77046 83 }
cbe9352f 84 local_irq_restore(flags);
100eeae2 85 wake_up(&tty_ldisc_idle);
65b77046
LT
86}
87
01e1abb2
AC
88/**
89 * tty_register_ldisc - install a line discipline
90 * @disc: ldisc number
91 * @new_ldisc: pointer to the ldisc object
92 *
93 * Installs a new line discipline into the kernel. The discipline
94 * is set up as unreferenced and then made available to the kernel
95 * from this point onwards.
96 *
97 * Locking:
98 * takes tty_ldisc_lock to guard against ldisc races
99 */
100
101int tty_register_ldisc(int disc, struct tty_ldisc_ops *new_ldisc)
102{
103 unsigned long flags;
104 int ret = 0;
105
106 if (disc < N_TTY || disc >= NR_LDISCS)
107 return -EINVAL;
108
109 spin_lock_irqsave(&tty_ldisc_lock, flags);
110 tty_ldiscs[disc] = new_ldisc;
111 new_ldisc->num = disc;
112 new_ldisc->refcount = 0;
113 spin_unlock_irqrestore(&tty_ldisc_lock, flags);
114
115 return ret;
116}
117EXPORT_SYMBOL(tty_register_ldisc);
118
119/**
120 * tty_unregister_ldisc - unload a line discipline
121 * @disc: ldisc number
122 * @new_ldisc: pointer to the ldisc object
123 *
124 * Remove a line discipline from the kernel providing it is not
125 * currently in use.
126 *
127 * Locking:
128 * takes tty_ldisc_lock to guard against ldisc races
129 */
130
131int tty_unregister_ldisc(int disc)
132{
133 unsigned long flags;
134 int ret = 0;
135
136 if (disc < N_TTY || disc >= NR_LDISCS)
137 return -EINVAL;
138
139 spin_lock_irqsave(&tty_ldisc_lock, flags);
140 if (tty_ldiscs[disc]->refcount)
141 ret = -EBUSY;
142 else
143 tty_ldiscs[disc] = NULL;
144 spin_unlock_irqrestore(&tty_ldisc_lock, flags);
145
146 return ret;
147}
148EXPORT_SYMBOL(tty_unregister_ldisc);
149
f0de0e8d
LT
150static struct tty_ldisc_ops *get_ldops(int disc)
151{
152 unsigned long flags;
153 struct tty_ldisc_ops *ldops, *ret;
154
155 spin_lock_irqsave(&tty_ldisc_lock, flags);
156 ret = ERR_PTR(-EINVAL);
157 ldops = tty_ldiscs[disc];
158 if (ldops) {
159 ret = ERR_PTR(-EAGAIN);
160 if (try_module_get(ldops->owner)) {
161 ldops->refcount++;
162 ret = ldops;
163 }
164 }
165 spin_unlock_irqrestore(&tty_ldisc_lock, flags);
166 return ret;
167}
168
169static void put_ldops(struct tty_ldisc_ops *ldops)
170{
171 unsigned long flags;
172
173 spin_lock_irqsave(&tty_ldisc_lock, flags);
174 ldops->refcount--;
175 module_put(ldops->owner);
176 spin_unlock_irqrestore(&tty_ldisc_lock, flags);
177}
01e1abb2 178
01e1abb2
AC
179/**
180 * tty_ldisc_get - take a reference to an ldisc
181 * @disc: ldisc number
01e1abb2
AC
182 *
183 * Takes a reference to a line discipline. Deals with refcounts and
184 * module locking counts. Returns NULL if the discipline is not available.
185 * Returns a pointer to the discipline and bumps the ref count if it is
186 * available
187 *
188 * Locking:
189 * takes tty_ldisc_lock to guard against ldisc races
190 */
191
c65c9bc3 192static struct tty_ldisc *tty_ldisc_get(int disc)
01e1abb2 193{
c65c9bc3 194 struct tty_ldisc *ld;
182274f8 195 struct tty_ldisc_ops *ldops;
01e1abb2
AC
196
197 if (disc < N_TTY || disc >= NR_LDISCS)
c65c9bc3 198 return ERR_PTR(-EINVAL);
182274f8
LT
199
200 /*
201 * Get the ldisc ops - we may need to request them to be loaded
202 * dynamically and try again.
203 */
204 ldops = get_ldops(disc);
205 if (IS_ERR(ldops)) {
01e1abb2 206 request_module("tty-ldisc-%d", disc);
182274f8
LT
207 ldops = get_ldops(disc);
208 if (IS_ERR(ldops))
209 return ERR_CAST(ldops);
210 }
211
212 ld = kmalloc(sizeof(struct tty_ldisc), GFP_KERNEL);
213 if (ld == NULL) {
214 put_ldops(ldops);
215 return ERR_PTR(-ENOMEM);
01e1abb2 216 }
182274f8
LT
217
218 ld->ops = ldops;
219 atomic_set(&ld->users, 1);
c65c9bc3 220 return ld;
01e1abb2
AC
221}
222
852e99d2 223static void *tty_ldiscs_seq_start(struct seq_file *m, loff_t *pos)
01e1abb2
AC
224{
225 return (*pos < NR_LDISCS) ? pos : NULL;
226}
227
852e99d2 228static void *tty_ldiscs_seq_next(struct seq_file *m, void *v, loff_t *pos)
01e1abb2
AC
229{
230 (*pos)++;
231 return (*pos < NR_LDISCS) ? pos : NULL;
232}
233
234static void tty_ldiscs_seq_stop(struct seq_file *m, void *v)
235{
236}
237
238static int tty_ldiscs_seq_show(struct seq_file *m, void *v)
239{
240 int i = *(loff_t *)v;
f0de0e8d 241 struct tty_ldisc_ops *ldops;
852e99d2 242
f0de0e8d
LT
243 ldops = get_ldops(i);
244 if (IS_ERR(ldops))
01e1abb2 245 return 0;
f0de0e8d
LT
246 seq_printf(m, "%-10s %2d\n", ldops->name ? ldops->name : "???", i);
247 put_ldops(ldops);
01e1abb2
AC
248 return 0;
249}
250
251static const struct seq_operations tty_ldiscs_seq_ops = {
252 .start = tty_ldiscs_seq_start,
253 .next = tty_ldiscs_seq_next,
254 .stop = tty_ldiscs_seq_stop,
255 .show = tty_ldiscs_seq_show,
256};
257
258static int proc_tty_ldiscs_open(struct inode *inode, struct file *file)
259{
260 return seq_open(file, &tty_ldiscs_seq_ops);
261}
262
263const struct file_operations tty_ldiscs_proc_fops = {
264 .owner = THIS_MODULE,
265 .open = proc_tty_ldiscs_open,
266 .read = seq_read,
267 .llseek = seq_lseek,
268 .release = seq_release,
269};
270
271/**
272 * tty_ldisc_assign - set ldisc on a tty
273 * @tty: tty to assign
274 * @ld: line discipline
275 *
276 * Install an instance of a line discipline into a tty structure. The
8d2ead74 277 * ldisc must have a reference count above zero to ensure it remains.
01e1abb2
AC
278 * The tty instance refcount starts at zero.
279 *
280 * Locking:
281 * Caller must hold references
282 */
283
284static void tty_ldisc_assign(struct tty_struct *tty, struct tty_ldisc *ld)
285{
c65c9bc3 286 tty->ldisc = ld;
01e1abb2
AC
287}
288
289/**
290 * tty_ldisc_try - internal helper
291 * @tty: the tty
292 *
293 * Make a single attempt to grab and bump the refcount on
294 * the tty ldisc. Return 0 on failure or 1 on success. This is
295 * used to implement both the waiting and non waiting versions
296 * of tty_ldisc_ref
297 *
298 * Locking: takes tty_ldisc_lock
299 */
300
65b77046 301static struct tty_ldisc *tty_ldisc_try(struct tty_struct *tty)
01e1abb2
AC
302{
303 unsigned long flags;
304 struct tty_ldisc *ld;
01e1abb2
AC
305
306 spin_lock_irqsave(&tty_ldisc_lock, flags);
65b77046
LT
307 ld = NULL;
308 if (test_bit(TTY_LDISC, &tty->flags))
309 ld = get_ldisc(tty->ldisc);
01e1abb2 310 spin_unlock_irqrestore(&tty_ldisc_lock, flags);
65b77046 311 return ld;
01e1abb2
AC
312}
313
314/**
315 * tty_ldisc_ref_wait - wait for the tty ldisc
316 * @tty: tty device
317 *
318 * Dereference the line discipline for the terminal and take a
319 * reference to it. If the line discipline is in flux then
320 * wait patiently until it changes.
321 *
322 * Note: Must not be called from an IRQ/timer context. The caller
323 * must also be careful not to hold other locks that will deadlock
324 * against a discipline change, such as an existing ldisc reference
325 * (which we check for)
326 *
327 * Locking: call functions take tty_ldisc_lock
328 */
329
330struct tty_ldisc *tty_ldisc_ref_wait(struct tty_struct *tty)
331{
65b77046
LT
332 struct tty_ldisc *ld;
333
01e1abb2 334 /* wait_event is a macro */
65b77046
LT
335 wait_event(tty_ldisc_wait, (ld = tty_ldisc_try(tty)) != NULL);
336 return ld;
01e1abb2 337}
01e1abb2
AC
338EXPORT_SYMBOL_GPL(tty_ldisc_ref_wait);
339
340/**
341 * tty_ldisc_ref - get the tty ldisc
342 * @tty: tty device
343 *
344 * Dereference the line discipline for the terminal and take a
345 * reference to it. If the line discipline is in flux then
346 * return NULL. Can be called from IRQ and timer functions.
347 *
348 * Locking: called functions take tty_ldisc_lock
349 */
350
351struct tty_ldisc *tty_ldisc_ref(struct tty_struct *tty)
352{
65b77046 353 return tty_ldisc_try(tty);
01e1abb2 354}
01e1abb2
AC
355EXPORT_SYMBOL_GPL(tty_ldisc_ref);
356
357/**
358 * tty_ldisc_deref - free a tty ldisc reference
359 * @ld: reference to free up
360 *
361 * Undoes the effect of tty_ldisc_ref or tty_ldisc_ref_wait. May
362 * be called in IRQ context.
363 *
364 * Locking: takes tty_ldisc_lock
365 */
366
367void tty_ldisc_deref(struct tty_ldisc *ld)
368{
65b77046 369 put_ldisc(ld);
01e1abb2 370}
01e1abb2
AC
371EXPORT_SYMBOL_GPL(tty_ldisc_deref);
372
65b77046
LT
373static inline void tty_ldisc_put(struct tty_ldisc *ld)
374{
375 put_ldisc(ld);
376}
377
01e1abb2
AC
378/**
379 * tty_ldisc_enable - allow ldisc use
380 * @tty: terminal to activate ldisc on
381 *
382 * Set the TTY_LDISC flag when the line discipline can be called
c9b3976e
AC
383 * again. Do necessary wakeups for existing sleepers. Clear the LDISC
384 * changing flag to indicate any ldisc change is now over.
01e1abb2 385 *
c9b3976e
AC
386 * Note: nobody should set the TTY_LDISC bit except via this function.
387 * Clearing directly is allowed.
01e1abb2
AC
388 */
389
390void tty_ldisc_enable(struct tty_struct *tty)
391{
392 set_bit(TTY_LDISC, &tty->flags);
c9b3976e 393 clear_bit(TTY_LDISC_CHANGING, &tty->flags);
01e1abb2
AC
394 wake_up(&tty_ldisc_wait);
395}
396
f2c4c65c
AC
397/**
398 * tty_ldisc_flush - flush line discipline queue
399 * @tty: tty
400 *
401 * Flush the line discipline queue (if any) for this tty. If there
402 * is no line discipline active this is a no-op.
403 */
404
405void tty_ldisc_flush(struct tty_struct *tty)
406{
407 struct tty_ldisc *ld = tty_ldisc_ref(tty);
408 if (ld) {
409 if (ld->ops->flush_buffer)
410 ld->ops->flush_buffer(tty);
411 tty_ldisc_deref(ld);
412 }
413 tty_buffer_flush(tty);
414}
f2c4c65c
AC
415EXPORT_SYMBOL_GPL(tty_ldisc_flush);
416
01e1abb2
AC
417/**
418 * tty_set_termios_ldisc - set ldisc field
419 * @tty: tty structure
420 * @num: line discipline number
421 *
422 * This is probably overkill for real world processors but
423 * they are not on hot paths so a little discipline won't do
424 * any harm.
425 *
426 * Locking: takes termios_mutex
427 */
428
429static void tty_set_termios_ldisc(struct tty_struct *tty, int num)
430{
431 mutex_lock(&tty->termios_mutex);
432 tty->termios->c_line = num;
433 mutex_unlock(&tty->termios_mutex);
434}
435
c65c9bc3
AC
436/**
437 * tty_ldisc_open - open a line discipline
438 * @tty: tty we are opening the ldisc on
439 * @ld: discipline to open
440 *
441 * A helper opening method. Also a convenient debugging and check
442 * point.
ec79d605
AB
443 *
444 * Locking: always called with BTM already held.
c65c9bc3
AC
445 */
446
447static int tty_ldisc_open(struct tty_struct *tty, struct tty_ldisc *ld)
448{
449 WARN_ON(test_and_set_bit(TTY_LDISC_OPEN, &tty->flags));
f18f9498
AC
450 if (ld->ops->open) {
451 int ret;
ec79d605 452 /* BTM here locks versus a hangup event */
f18f9498 453 ret = ld->ops->open(tty);
7f90cfc5
JS
454 if (ret)
455 clear_bit(TTY_LDISC_OPEN, &tty->flags);
f18f9498
AC
456 return ret;
457 }
c65c9bc3
AC
458 return 0;
459}
460
461/**
462 * tty_ldisc_close - close a line discipline
463 * @tty: tty we are opening the ldisc on
464 * @ld: discipline to close
465 *
466 * A helper close method. Also a convenient debugging and check
467 * point.
468 */
469
470static void tty_ldisc_close(struct tty_struct *tty, struct tty_ldisc *ld)
471{
472 WARN_ON(!test_bit(TTY_LDISC_OPEN, &tty->flags));
473 clear_bit(TTY_LDISC_OPEN, &tty->flags);
474 if (ld->ops->close)
475 ld->ops->close(tty);
476}
01e1abb2
AC
477
478/**
479 * tty_ldisc_restore - helper for tty ldisc change
480 * @tty: tty to recover
481 * @old: previous ldisc
482 *
483 * Restore the previous line discipline or N_TTY when a line discipline
484 * change fails due to an open error
485 */
486
487static void tty_ldisc_restore(struct tty_struct *tty, struct tty_ldisc *old)
488{
489 char buf[64];
c65c9bc3
AC
490 struct tty_ldisc *new_ldisc;
491 int r;
01e1abb2
AC
492
493 /* There is an outstanding reference here so this is safe */
c65c9bc3
AC
494 old = tty_ldisc_get(old->ops->num);
495 WARN_ON(IS_ERR(old));
01e1abb2
AC
496 tty_ldisc_assign(tty, old);
497 tty_set_termios_ldisc(tty, old->ops->num);
c65c9bc3
AC
498 if (tty_ldisc_open(tty, old) < 0) {
499 tty_ldisc_put(old);
01e1abb2 500 /* This driver is always present */
852e99d2 501 new_ldisc = tty_ldisc_get(N_TTY);
c65c9bc3 502 if (IS_ERR(new_ldisc))
01e1abb2 503 panic("n_tty: get");
c65c9bc3 504 tty_ldisc_assign(tty, new_ldisc);
01e1abb2 505 tty_set_termios_ldisc(tty, N_TTY);
c65c9bc3
AC
506 r = tty_ldisc_open(tty, new_ldisc);
507 if (r < 0)
508 panic("Couldn't open N_TTY ldisc for "
509 "%s --- error %d.",
510 tty_name(tty, buf), r);
01e1abb2
AC
511 }
512}
513
e8b70e7d 514/**
c65c9bc3 515 * tty_ldisc_halt - shut down the line discipline
e8b70e7d
AC
516 * @tty: tty device
517 *
518 * Shut down the line discipline and work queue for this tty device.
519 * The TTY_LDISC flag being cleared ensures no further references can
520 * be obtained while the delayed work queue halt ensures that no more
521 * data is fed to the ldisc.
522 *
5c58ceff
LT
523 * You need to do a 'flush_scheduled_work()' (outside the ldisc_mutex)
524 * in order to make sure any currently executing ldisc work is also
525 * flushed.
e8b70e7d
AC
526 */
527
c65c9bc3 528static int tty_ldisc_halt(struct tty_struct *tty)
e8b70e7d
AC
529{
530 clear_bit(TTY_LDISC, &tty->flags);
f23eb2b2 531 return cancel_work_sync(&tty->buf.work);
e8b70e7d
AC
532}
533
0a1f1a0b
TH
534/**
535 * tty_ldisc_flush_works - flush all works of a tty
536 * @tty: tty device to flush works for
537 *
538 * Sync flush all works belonging to @tty.
539 */
540static void tty_ldisc_flush_works(struct tty_struct *tty)
541{
542 flush_work_sync(&tty->hangup_work);
543 flush_work_sync(&tty->SAK_work);
f23eb2b2 544 flush_work_sync(&tty->buf.work);
0a1f1a0b
TH
545}
546
100eeae2
JS
547/**
548 * tty_ldisc_wait_idle - wait for the ldisc to become idle
549 * @tty: tty to wait for
550 *
551 * Wait for the line discipline to become idle. The discipline must
552 * have been halted for this to guarantee it remains idle.
553 */
554static int tty_ldisc_wait_idle(struct tty_struct *tty)
555{
556 int ret;
92f6fa09 557 ret = wait_event_timeout(tty_ldisc_idle,
100eeae2 558 atomic_read(&tty->ldisc->users) == 1, 5 * HZ);
100eeae2
JS
559 return ret > 0 ? 0 : -EBUSY;
560}
561
01e1abb2
AC
562/**
563 * tty_set_ldisc - set line discipline
564 * @tty: the terminal to set
565 * @ldisc: the line discipline
566 *
567 * Set the discipline of a tty line. Must be called from a process
c65c9bc3
AC
568 * context. The ldisc change logic has to protect itself against any
569 * overlapping ldisc change (including on the other end of pty pairs),
570 * the close of one side of a tty/pty pair, and eventually hangup.
01e1abb2 571 *
c65c9bc3 572 * Locking: takes tty_ldisc_lock, termios_mutex
01e1abb2
AC
573 */
574
575int tty_set_ldisc(struct tty_struct *tty, int ldisc)
576{
577 int retval;
c65c9bc3
AC
578 struct tty_ldisc *o_ldisc, *new_ldisc;
579 int work, o_work = 0;
01e1abb2
AC
580 struct tty_struct *o_tty;
581
c65c9bc3
AC
582 new_ldisc = tty_ldisc_get(ldisc);
583 if (IS_ERR(new_ldisc))
584 return PTR_ERR(new_ldisc);
01e1abb2 585
ec79d605 586 tty_lock();
01e1abb2 587 /*
c65c9bc3
AC
588 * We need to look at the tty locking here for pty/tty pairs
589 * when both sides try to change in parallel.
01e1abb2
AC
590 */
591
c65c9bc3
AC
592 o_tty = tty->link; /* o_tty is the pty side or NULL */
593
01e1abb2 594
c65c9bc3
AC
595 /*
596 * Check the no-op case
597 */
598
599 if (tty->ldisc->ops->num == ldisc) {
ec79d605 600 tty_unlock();
c65c9bc3 601 tty_ldisc_put(new_ldisc);
01e1abb2
AC
602 return 0;
603 }
604
ec79d605 605 tty_unlock();
c65c9bc3
AC
606 /*
607 * Problem: What do we do if this blocks ?
608 * We could deadlock here
609 */
610
611 tty_wait_until_sent(tty, 0);
612
60af22d2 613 tty_lock();
c65c9bc3
AC
614 mutex_lock(&tty->ldisc_mutex);
615
616 /*
617 * We could be midstream of another ldisc change which has
618 * dropped the lock during processing. If so we need to wait.
619 */
620
621 while (test_bit(TTY_LDISC_CHANGING, &tty->flags)) {
622 mutex_unlock(&tty->ldisc_mutex);
60af22d2 623 tty_unlock();
c65c9bc3
AC
624 wait_event(tty_ldisc_wait,
625 test_bit(TTY_LDISC_CHANGING, &tty->flags) == 0);
60af22d2 626 tty_lock();
c65c9bc3
AC
627 mutex_lock(&tty->ldisc_mutex);
628 }
eeb89d91 629
c65c9bc3 630 set_bit(TTY_LDISC_CHANGING, &tty->flags);
852e99d2 631
01e1abb2
AC
632 /*
633 * No more input please, we are switching. The new ldisc
634 * will update this value in the ldisc open function
635 */
636
637 tty->receive_room = 0;
638
639 o_ldisc = tty->ldisc;
eeb89d91 640
ec79d605 641 tty_unlock();
01e1abb2
AC
642 /*
643 * Make sure we don't change while someone holds a
644 * reference to the line discipline. The TTY_LDISC bit
645 * prevents anyone taking a reference once it is clear.
646 * We need the lock to avoid racing reference takers.
c9b3976e
AC
647 *
648 * We must clear the TTY_LDISC bit here to avoid a livelock
649 * with a userspace app continually trying to use the tty in
650 * parallel to the change and re-referencing the tty.
01e1abb2
AC
651 */
652
c65c9bc3 653 work = tty_ldisc_halt(tty);
01e1abb2 654 if (o_tty)
c65c9bc3 655 o_work = tty_ldisc_halt(o_tty);
01e1abb2 656
01e1abb2 657 /*
c65c9bc3
AC
658 * Wait for ->hangup_work and ->buf.work handlers to terminate.
659 * We must drop the mutex here in case a hangup is also in process.
01e1abb2 660 */
c65c9bc3
AC
661
662 mutex_unlock(&tty->ldisc_mutex);
663
0a1f1a0b 664 tty_ldisc_flush_works(tty);
c65c9bc3 665
100eeae2
JS
666 retval = tty_ldisc_wait_idle(tty);
667
ec79d605 668 tty_lock();
60af22d2 669 mutex_lock(&tty->ldisc_mutex);
100eeae2
JS
670
671 /* handle wait idle failure locked */
672 if (retval) {
673 tty_ldisc_put(new_ldisc);
674 goto enable;
675 }
676
c65c9bc3
AC
677 if (test_bit(TTY_HUPPED, &tty->flags)) {
678 /* We were raced by the hangup method. It will have stomped
679 the ldisc data and closed the ldisc down */
680 clear_bit(TTY_LDISC_CHANGING, &tty->flags);
681 mutex_unlock(&tty->ldisc_mutex);
682 tty_ldisc_put(new_ldisc);
ec79d605 683 tty_unlock();
c65c9bc3
AC
684 return -EIO;
685 }
686
01e1abb2 687 /* Shutdown the current discipline. */
c65c9bc3 688 tty_ldisc_close(tty, o_ldisc);
01e1abb2
AC
689
690 /* Now set up the new line discipline. */
c65c9bc3 691 tty_ldisc_assign(tty, new_ldisc);
01e1abb2 692 tty_set_termios_ldisc(tty, ldisc);
c65c9bc3
AC
693
694 retval = tty_ldisc_open(tty, new_ldisc);
01e1abb2 695 if (retval < 0) {
c65c9bc3
AC
696 /* Back to the old one or N_TTY if we can't */
697 tty_ldisc_put(new_ldisc);
698 tty_ldisc_restore(tty, o_ldisc);
01e1abb2 699 }
c65c9bc3 700
01e1abb2
AC
701 /* At this point we hold a reference to the new ldisc and a
702 a reference to the old ldisc. If we ended up flipping back
703 to the existing ldisc we have two references to it */
704
c65c9bc3 705 if (tty->ldisc->ops->num != o_ldisc->ops->num && tty->ops->set_ldisc)
01e1abb2
AC
706 tty->ops->set_ldisc(tty);
707
c65c9bc3 708 tty_ldisc_put(o_ldisc);
01e1abb2 709
100eeae2 710enable:
01e1abb2 711 /*
c65c9bc3 712 * Allow ldisc referencing to occur again
01e1abb2
AC
713 */
714
715 tty_ldisc_enable(tty);
716 if (o_tty)
717 tty_ldisc_enable(o_tty);
718
c65c9bc3 719 /* Restart the work queue in case no characters kick it off. Safe if
01e1abb2
AC
720 already running */
721 if (work)
f23eb2b2 722 schedule_work(&tty->buf.work);
c65c9bc3 723 if (o_work)
f23eb2b2 724 schedule_work(&o_tty->buf.work);
c65c9bc3 725 mutex_unlock(&tty->ldisc_mutex);
ec79d605 726 tty_unlock();
01e1abb2
AC
727 return retval;
728}
729
c65c9bc3
AC
730/**
731 * tty_reset_termios - reset terminal state
732 * @tty: tty to reset
733 *
734 * Restore a terminal to the driver default state.
735 */
736
737static void tty_reset_termios(struct tty_struct *tty)
738{
739 mutex_lock(&tty->termios_mutex);
740 *tty->termios = tty->driver->init_termios;
741 tty->termios->c_ispeed = tty_termios_input_baud_rate(tty->termios);
742 tty->termios->c_ospeed = tty_termios_baud_rate(tty->termios);
743 mutex_unlock(&tty->termios_mutex);
744}
745
746
747/**
748 * tty_ldisc_reinit - reinitialise the tty ldisc
749 * @tty: tty to reinit
638b9648 750 * @ldisc: line discipline to reinitialize
c65c9bc3 751 *
638b9648
AC
752 * Switch the tty to a line discipline and leave the ldisc
753 * state closed
c65c9bc3
AC
754 */
755
1c95ba1e 756static int tty_ldisc_reinit(struct tty_struct *tty, int ldisc)
c65c9bc3 757{
1c95ba1e
PR
758 struct tty_ldisc *ld = tty_ldisc_get(ldisc);
759
760 if (IS_ERR(ld))
761 return -1;
c65c9bc3 762
92f6fa09
JS
763 WARN_ON_ONCE(tty_ldisc_wait_idle(tty));
764
c65c9bc3
AC
765 tty_ldisc_close(tty, tty->ldisc);
766 tty_ldisc_put(tty->ldisc);
767 tty->ldisc = NULL;
768 /*
769 * Switch the line discipline back
770 */
c65c9bc3 771 tty_ldisc_assign(tty, ld);
638b9648 772 tty_set_termios_ldisc(tty, ldisc);
1c95ba1e
PR
773
774 return 0;
c65c9bc3
AC
775}
776
777/**
778 * tty_ldisc_hangup - hangup ldisc reset
779 * @tty: tty being hung up
780 *
781 * Some tty devices reset their termios when they receive a hangup
782 * event. In that situation we must also switch back to N_TTY properly
783 * before we reset the termios data.
784 *
785 * Locking: We can take the ldisc mutex as the rest of the code is
786 * careful to allow for this.
787 *
788 * In the pty pair case this occurs in the close() path of the
789 * tty itself so we must be careful about locking rules.
790 */
791
792void tty_ldisc_hangup(struct tty_struct *tty)
793{
794 struct tty_ldisc *ld;
638b9648
AC
795 int reset = tty->driver->flags & TTY_DRIVER_RESET_TERMIOS;
796 int err = 0;
c65c9bc3
AC
797
798 /*
799 * FIXME! What are the locking issues here? This may me overdoing
800 * things... This question is especially important now that we've
801 * removed the irqlock.
802 */
803 ld = tty_ldisc_ref(tty);
804 if (ld != NULL) {
805 /* We may have no line discipline at this point */
806 if (ld->ops->flush_buffer)
807 ld->ops->flush_buffer(tty);
808 tty_driver_flush_buffer(tty);
809 if ((test_bit(TTY_DO_WRITE_WAKEUP, &tty->flags)) &&
810 ld->ops->write_wakeup)
811 ld->ops->write_wakeup(tty);
812 if (ld->ops->hangup)
813 ld->ops->hangup(tty);
814 tty_ldisc_deref(ld);
815 }
816 /*
817 * FIXME: Once we trust the LDISC code better we can wait here for
818 * ldisc completion and fix the driver call race
819 */
820 wake_up_interruptible_poll(&tty->write_wait, POLLOUT);
821 wake_up_interruptible_poll(&tty->read_wait, POLLIN);
822 /*
823 * Shutdown the current line discipline, and reset it to
638b9648
AC
824 * N_TTY if need be.
825 *
826 * Avoid racing set_ldisc or tty_ldisc_release
c65c9bc3 827 */
638b9648 828 mutex_lock(&tty->ldisc_mutex);
60af22d2
AB
829
830 /*
831 * this is like tty_ldisc_halt, but we need to give up
f23eb2b2
LT
832 * the BTM before calling cancel_work_sync, which may
833 * need to wait for another function taking the BTM
60af22d2
AB
834 */
835 clear_bit(TTY_LDISC, &tty->flags);
836 tty_unlock();
f23eb2b2 837 cancel_work_sync(&tty->buf.work);
60af22d2
AB
838 mutex_unlock(&tty->ldisc_mutex);
839
840 tty_lock();
841 mutex_lock(&tty->ldisc_mutex);
842
638b9648
AC
843 /* At this point we have a closed ldisc and we want to
844 reopen it. We could defer this to the next open but
845 it means auditing a lot of other paths so this is
846 a FIXME */
847 if (tty->ldisc) { /* Not yet closed */
848 if (reset == 0) {
1c95ba1e
PR
849
850 if (!tty_ldisc_reinit(tty, tty->termios->c_line))
851 err = tty_ldisc_open(tty, tty->ldisc);
852 else
853 err = 1;
638b9648
AC
854 }
855 /* If the re-open fails or we reset then go to N_TTY. The
856 N_TTY open cannot fail */
857 if (reset || err) {
1c95ba1e 858 BUG_ON(tty_ldisc_reinit(tty, N_TTY));
c8d50041 859 WARN_ON(tty_ldisc_open(tty, tty->ldisc));
c8d50041 860 }
638b9648 861 tty_ldisc_enable(tty);
c65c9bc3 862 }
638b9648
AC
863 mutex_unlock(&tty->ldisc_mutex);
864 if (reset)
865 tty_reset_termios(tty);
c65c9bc3 866}
01e1abb2
AC
867
868/**
869 * tty_ldisc_setup - open line discipline
870 * @tty: tty being shut down
871 * @o_tty: pair tty for pty/tty pairs
872 *
873 * Called during the initial open of a tty/pty pair in order to set up the
c65c9bc3
AC
874 * line disciplines and bind them to the tty. This has no locking issues
875 * as the device isn't yet active.
01e1abb2
AC
876 */
877
878int tty_ldisc_setup(struct tty_struct *tty, struct tty_struct *o_tty)
879{
c65c9bc3 880 struct tty_ldisc *ld = tty->ldisc;
01e1abb2
AC
881 int retval;
882
c65c9bc3
AC
883 retval = tty_ldisc_open(tty, ld);
884 if (retval)
885 return retval;
886
887 if (o_tty) {
888 retval = tty_ldisc_open(o_tty, o_tty->ldisc);
01e1abb2 889 if (retval) {
c65c9bc3 890 tty_ldisc_close(tty, ld);
01e1abb2
AC
891 return retval;
892 }
893 tty_ldisc_enable(o_tty);
894 }
895 tty_ldisc_enable(tty);
896 return 0;
897}
01e1abb2
AC
898/**
899 * tty_ldisc_release - release line discipline
900 * @tty: tty being shut down
901 * @o_tty: pair tty for pty/tty pairs
902 *
852e99d2
AC
903 * Called during the final close of a tty/pty pair in order to shut down
904 * the line discpline layer. On exit the ldisc assigned is N_TTY and the
c65c9bc3 905 * ldisc has not been opened.
01e1abb2
AC
906 */
907
908void tty_ldisc_release(struct tty_struct *tty, struct tty_struct *o_tty)
909{
01e1abb2
AC
910 /*
911 * Prevent flush_to_ldisc() from rescheduling the work for later. Then
912 * kill any delayed work. As this is the final close it does not
913 * race with the set_ldisc code path.
914 */
01e1abb2 915
60af22d2 916 tty_unlock();
e8b70e7d 917 tty_ldisc_halt(tty);
0a1f1a0b 918 tty_ldisc_flush_works(tty);
60af22d2 919 tty_lock();
01e1abb2 920
c8d50041 921 mutex_lock(&tty->ldisc_mutex);
01e1abb2 922 /*
aef29bc2 923 * Now kill off the ldisc
01e1abb2 924 */
aef29bc2
AC
925 tty_ldisc_close(tty, tty->ldisc);
926 tty_ldisc_put(tty->ldisc);
927 /* Force an oops if we mess this up */
928 tty->ldisc = NULL;
929
930 /* Ensure the next open requests the N_TTY ldisc */
931 tty_set_termios_ldisc(tty, N_TTY);
c8d50041 932 mutex_unlock(&tty->ldisc_mutex);
01e1abb2 933
c65c9bc3
AC
934 /* This will need doing differently if we need to lock */
935 if (o_tty)
936 tty_ldisc_release(o_tty, NULL);
aef29bc2
AC
937
938 /* And the memory resources remaining (buffers, termios) will be
939 disposed of when the kref hits zero */
01e1abb2
AC
940}
941
942/**
943 * tty_ldisc_init - ldisc setup for new tty
944 * @tty: tty being allocated
945 *
946 * Set up the line discipline objects for a newly allocated tty. Note that
947 * the tty structure is not completely set up when this call is made.
948 */
949
950void tty_ldisc_init(struct tty_struct *tty)
951{
c65c9bc3
AC
952 struct tty_ldisc *ld = tty_ldisc_get(N_TTY);
953 if (IS_ERR(ld))
01e1abb2 954 panic("n_tty: init_tty");
c65c9bc3 955 tty_ldisc_assign(tty, ld);
01e1abb2
AC
956}
957
6716671d
JS
958/**
959 * tty_ldisc_init - ldisc cleanup for new tty
960 * @tty: tty that was allocated recently
961 *
962 * The tty structure must not becompletely set up (tty_ldisc_setup) when
963 * this call is made.
964 */
965void tty_ldisc_deinit(struct tty_struct *tty)
966{
967 put_ldisc(tty->ldisc);
968 tty_ldisc_assign(tty, NULL);
969}
970
01e1abb2
AC
971void tty_ldisc_begin(void)
972{
973 /* Setup the default TTY line discipline. */
974 (void) tty_register_ldisc(N_TTY, &tty_ldisc_N_TTY);
975}