blob: acd76b767d4c10aac5b540e31a1cd2dddf3c8436 [file] [log] [blame]
Alan Cox01e1abb2008-07-22 11:16:55 +01001#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>
Alan Cox01e1abb2008-07-22 11:16:55 +010013#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>
Alan Cox01e1abb2008-07-22 11:16:55 +010024#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);
48/* Line disc dispatch table */
49static struct tty_ldisc_ops *tty_ldiscs[NR_LDISCS];
50
51/**
52 * tty_register_ldisc - install a line discipline
53 * @disc: ldisc number
54 * @new_ldisc: pointer to the ldisc object
55 *
56 * Installs a new line discipline into the kernel. The discipline
57 * is set up as unreferenced and then made available to the kernel
58 * from this point onwards.
59 *
60 * Locking:
61 * takes tty_ldisc_lock to guard against ldisc races
62 */
63
64int tty_register_ldisc(int disc, struct tty_ldisc_ops *new_ldisc)
65{
66 unsigned long flags;
67 int ret = 0;
68
69 if (disc < N_TTY || disc >= NR_LDISCS)
70 return -EINVAL;
71
72 spin_lock_irqsave(&tty_ldisc_lock, flags);
73 tty_ldiscs[disc] = new_ldisc;
74 new_ldisc->num = disc;
75 new_ldisc->refcount = 0;
76 spin_unlock_irqrestore(&tty_ldisc_lock, flags);
77
78 return ret;
79}
80EXPORT_SYMBOL(tty_register_ldisc);
81
82/**
83 * tty_unregister_ldisc - unload a line discipline
84 * @disc: ldisc number
85 * @new_ldisc: pointer to the ldisc object
86 *
87 * Remove a line discipline from the kernel providing it is not
88 * currently in use.
89 *
90 * Locking:
91 * takes tty_ldisc_lock to guard against ldisc races
92 */
93
94int tty_unregister_ldisc(int disc)
95{
96 unsigned long flags;
97 int ret = 0;
98
99 if (disc < N_TTY || disc >= NR_LDISCS)
100 return -EINVAL;
101
102 spin_lock_irqsave(&tty_ldisc_lock, flags);
103 if (tty_ldiscs[disc]->refcount)
104 ret = -EBUSY;
105 else
106 tty_ldiscs[disc] = NULL;
107 spin_unlock_irqrestore(&tty_ldisc_lock, flags);
108
109 return ret;
110}
111EXPORT_SYMBOL(tty_unregister_ldisc);
112
113
114/**
115 * tty_ldisc_try_get - try and reference an ldisc
116 * @disc: ldisc number
Alan Cox01e1abb2008-07-22 11:16:55 +0100117 *
118 * Attempt to open and lock a line discipline into place. Return
Alan Coxc65c9bc2009-06-11 12:50:12 +0100119 * the line discipline refcounted or an error.
Alan Cox01e1abb2008-07-22 11:16:55 +0100120 */
121
Alan Coxc65c9bc2009-06-11 12:50:12 +0100122static struct tty_ldisc *tty_ldisc_try_get(int disc)
Alan Cox01e1abb2008-07-22 11:16:55 +0100123{
124 unsigned long flags;
Alan Coxc65c9bc2009-06-11 12:50:12 +0100125 struct tty_ldisc *ld;
Alan Cox01e1abb2008-07-22 11:16:55 +0100126 struct tty_ldisc_ops *ldops;
127 int err = -EINVAL;
Alan Cox852e99d2009-06-11 12:51:41 +0100128
Alan Coxc65c9bc2009-06-11 12:50:12 +0100129 ld = kmalloc(sizeof(struct tty_ldisc), GFP_KERNEL);
130 if (ld == NULL)
131 return ERR_PTR(-ENOMEM);
132
Alan Cox01e1abb2008-07-22 11:16:55 +0100133 spin_lock_irqsave(&tty_ldisc_lock, flags);
134 ld->ops = NULL;
135 ldops = tty_ldiscs[disc];
136 /* Check the entry is defined */
137 if (ldops) {
138 /* If the module is being unloaded we can't use it */
139 if (!try_module_get(ldops->owner))
140 err = -EAGAIN;
141 else {
142 /* lock it */
143 ldops->refcount++;
144 ld->ops = ldops;
Alan Coxc65c9bc2009-06-11 12:50:12 +0100145 ld->refcount = 0;
Alan Cox01e1abb2008-07-22 11:16:55 +0100146 err = 0;
147 }
148 }
149 spin_unlock_irqrestore(&tty_ldisc_lock, flags);
Alan Cox8d2ead72009-06-16 17:00:26 +0100150 if (err) {
151 kfree(ld);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100152 return ERR_PTR(err);
Alan Cox8d2ead72009-06-16 17:00:26 +0100153 }
Alan Coxc65c9bc2009-06-11 12:50:12 +0100154 return ld;
Alan Cox01e1abb2008-07-22 11:16:55 +0100155}
156
157/**
158 * tty_ldisc_get - take a reference to an ldisc
159 * @disc: ldisc number
Alan Cox01e1abb2008-07-22 11:16:55 +0100160 *
161 * Takes a reference to a line discipline. Deals with refcounts and
162 * module locking counts. Returns NULL if the discipline is not available.
163 * Returns a pointer to the discipline and bumps the ref count if it is
164 * available
165 *
166 * Locking:
167 * takes tty_ldisc_lock to guard against ldisc races
168 */
169
Alan Coxc65c9bc2009-06-11 12:50:12 +0100170static struct tty_ldisc *tty_ldisc_get(int disc)
Alan Cox01e1abb2008-07-22 11:16:55 +0100171{
Alan Coxc65c9bc2009-06-11 12:50:12 +0100172 struct tty_ldisc *ld;
Alan Cox01e1abb2008-07-22 11:16:55 +0100173
174 if (disc < N_TTY || disc >= NR_LDISCS)
Alan Coxc65c9bc2009-06-11 12:50:12 +0100175 return ERR_PTR(-EINVAL);
176 ld = tty_ldisc_try_get(disc);
177 if (IS_ERR(ld)) {
Alan Cox01e1abb2008-07-22 11:16:55 +0100178 request_module("tty-ldisc-%d", disc);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100179 ld = tty_ldisc_try_get(disc);
Alan Cox01e1abb2008-07-22 11:16:55 +0100180 }
Alan Coxc65c9bc2009-06-11 12:50:12 +0100181 return ld;
Alan Cox01e1abb2008-07-22 11:16:55 +0100182}
183
184/**
185 * tty_ldisc_put - drop ldisc reference
Alan Coxc65c9bc2009-06-11 12:50:12 +0100186 * @ld: ldisc
Alan Cox01e1abb2008-07-22 11:16:55 +0100187 *
188 * Drop a reference to a line discipline. Manage refcounts and
Alan Coxc65c9bc2009-06-11 12:50:12 +0100189 * module usage counts. Free the ldisc once the recount hits zero.
Alan Cox01e1abb2008-07-22 11:16:55 +0100190 *
191 * Locking:
192 * takes tty_ldisc_lock to guard against ldisc races
193 */
194
Alan Coxc65c9bc2009-06-11 12:50:12 +0100195static void tty_ldisc_put(struct tty_ldisc *ld)
Alan Cox01e1abb2008-07-22 11:16:55 +0100196{
197 unsigned long flags;
Alan Coxc65c9bc2009-06-11 12:50:12 +0100198 int disc = ld->ops->num;
199 struct tty_ldisc_ops *ldo;
Alan Cox01e1abb2008-07-22 11:16:55 +0100200
201 BUG_ON(disc < N_TTY || disc >= NR_LDISCS);
202
203 spin_lock_irqsave(&tty_ldisc_lock, flags);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100204 ldo = tty_ldiscs[disc];
205 BUG_ON(ldo->refcount == 0);
206 ldo->refcount--;
207 module_put(ldo->owner);
Alan Cox01e1abb2008-07-22 11:16:55 +0100208 spin_unlock_irqrestore(&tty_ldisc_lock, flags);
Alan Cox677ca302009-06-16 17:00:53 +0100209 WARN_ON(ld->refcount);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100210 kfree(ld);
Alan Cox01e1abb2008-07-22 11:16:55 +0100211}
212
Alan Cox852e99d2009-06-11 12:51:41 +0100213static void *tty_ldiscs_seq_start(struct seq_file *m, loff_t *pos)
Alan Cox01e1abb2008-07-22 11:16:55 +0100214{
215 return (*pos < NR_LDISCS) ? pos : NULL;
216}
217
Alan Cox852e99d2009-06-11 12:51:41 +0100218static void *tty_ldiscs_seq_next(struct seq_file *m, void *v, loff_t *pos)
Alan Cox01e1abb2008-07-22 11:16:55 +0100219{
220 (*pos)++;
221 return (*pos < NR_LDISCS) ? pos : NULL;
222}
223
224static void tty_ldiscs_seq_stop(struct seq_file *m, void *v)
225{
226}
227
228static int tty_ldiscs_seq_show(struct seq_file *m, void *v)
229{
230 int i = *(loff_t *)v;
Alan Coxc65c9bc2009-06-11 12:50:12 +0100231 struct tty_ldisc *ld;
Alan Cox852e99d2009-06-11 12:51:41 +0100232
Alan Coxc65c9bc2009-06-11 12:50:12 +0100233 ld = tty_ldisc_try_get(i);
234 if (IS_ERR(ld))
Alan Cox01e1abb2008-07-22 11:16:55 +0100235 return 0;
Alan Coxc65c9bc2009-06-11 12:50:12 +0100236 seq_printf(m, "%-10s %2d\n", ld->ops->name ? ld->ops->name : "???", i);
237 tty_ldisc_put(ld);
Alan Cox01e1abb2008-07-22 11:16:55 +0100238 return 0;
239}
240
241static const struct seq_operations tty_ldiscs_seq_ops = {
242 .start = tty_ldiscs_seq_start,
243 .next = tty_ldiscs_seq_next,
244 .stop = tty_ldiscs_seq_stop,
245 .show = tty_ldiscs_seq_show,
246};
247
248static int proc_tty_ldiscs_open(struct inode *inode, struct file *file)
249{
250 return seq_open(file, &tty_ldiscs_seq_ops);
251}
252
253const struct file_operations tty_ldiscs_proc_fops = {
254 .owner = THIS_MODULE,
255 .open = proc_tty_ldiscs_open,
256 .read = seq_read,
257 .llseek = seq_lseek,
258 .release = seq_release,
259};
260
261/**
262 * tty_ldisc_assign - set ldisc on a tty
263 * @tty: tty to assign
264 * @ld: line discipline
265 *
266 * Install an instance of a line discipline into a tty structure. The
Alan Cox8d2ead72009-06-16 17:00:26 +0100267 * ldisc must have a reference count above zero to ensure it remains.
Alan Cox01e1abb2008-07-22 11:16:55 +0100268 * The tty instance refcount starts at zero.
269 *
270 * Locking:
271 * Caller must hold references
272 */
273
274static void tty_ldisc_assign(struct tty_struct *tty, struct tty_ldisc *ld)
275{
Alan Coxc65c9bc2009-06-11 12:50:12 +0100276 tty->ldisc = ld;
Alan Cox01e1abb2008-07-22 11:16:55 +0100277}
278
279/**
280 * tty_ldisc_try - internal helper
281 * @tty: the tty
282 *
283 * Make a single attempt to grab and bump the refcount on
284 * the tty ldisc. Return 0 on failure or 1 on success. This is
285 * used to implement both the waiting and non waiting versions
286 * of tty_ldisc_ref
287 *
288 * Locking: takes tty_ldisc_lock
289 */
290
291static int tty_ldisc_try(struct tty_struct *tty)
292{
293 unsigned long flags;
294 struct tty_ldisc *ld;
295 int ret = 0;
296
297 spin_lock_irqsave(&tty_ldisc_lock, flags);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100298 ld = tty->ldisc;
Alan Cox01e1abb2008-07-22 11:16:55 +0100299 if (test_bit(TTY_LDISC, &tty->flags)) {
300 ld->refcount++;
301 ret = 1;
302 }
303 spin_unlock_irqrestore(&tty_ldisc_lock, flags);
304 return ret;
305}
306
307/**
308 * tty_ldisc_ref_wait - wait for the tty ldisc
309 * @tty: tty device
310 *
311 * Dereference the line discipline for the terminal and take a
312 * reference to it. If the line discipline is in flux then
313 * wait patiently until it changes.
314 *
315 * Note: Must not be called from an IRQ/timer context. The caller
316 * must also be careful not to hold other locks that will deadlock
317 * against a discipline change, such as an existing ldisc reference
318 * (which we check for)
319 *
320 * Locking: call functions take tty_ldisc_lock
321 */
322
323struct tty_ldisc *tty_ldisc_ref_wait(struct tty_struct *tty)
324{
325 /* wait_event is a macro */
326 wait_event(tty_ldisc_wait, tty_ldisc_try(tty));
Alan Coxc65c9bc2009-06-11 12:50:12 +0100327 WARN_ON(tty->ldisc->refcount == 0);
328 return tty->ldisc;
Alan Cox01e1abb2008-07-22 11:16:55 +0100329}
Alan Cox01e1abb2008-07-22 11:16:55 +0100330EXPORT_SYMBOL_GPL(tty_ldisc_ref_wait);
331
332/**
333 * tty_ldisc_ref - get the tty ldisc
334 * @tty: tty device
335 *
336 * Dereference the line discipline for the terminal and take a
337 * reference to it. If the line discipline is in flux then
338 * return NULL. Can be called from IRQ and timer functions.
339 *
340 * Locking: called functions take tty_ldisc_lock
341 */
342
343struct tty_ldisc *tty_ldisc_ref(struct tty_struct *tty)
344{
345 if (tty_ldisc_try(tty))
Alan Coxc65c9bc2009-06-11 12:50:12 +0100346 return tty->ldisc;
Alan Cox01e1abb2008-07-22 11:16:55 +0100347 return NULL;
348}
Alan Cox01e1abb2008-07-22 11:16:55 +0100349EXPORT_SYMBOL_GPL(tty_ldisc_ref);
350
351/**
352 * tty_ldisc_deref - free a tty ldisc reference
353 * @ld: reference to free up
354 *
355 * Undoes the effect of tty_ldisc_ref or tty_ldisc_ref_wait. May
356 * be called in IRQ context.
357 *
358 * Locking: takes tty_ldisc_lock
359 */
360
361void tty_ldisc_deref(struct tty_ldisc *ld)
362{
363 unsigned long flags;
364
365 BUG_ON(ld == NULL);
366
367 spin_lock_irqsave(&tty_ldisc_lock, flags);
368 if (ld->refcount == 0)
369 printk(KERN_ERR "tty_ldisc_deref: no references.\n");
370 else
371 ld->refcount--;
372 if (ld->refcount == 0)
373 wake_up(&tty_ldisc_wait);
374 spin_unlock_irqrestore(&tty_ldisc_lock, flags);
375}
Alan Cox01e1abb2008-07-22 11:16:55 +0100376EXPORT_SYMBOL_GPL(tty_ldisc_deref);
377
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
Alan Coxc9b39762009-01-02 13:44:56 +0000383 * again. Do necessary wakeups for existing sleepers. Clear the LDISC
384 * changing flag to indicate any ldisc change is now over.
Alan Cox01e1abb2008-07-22 11:16:55 +0100385 *
Alan Coxc9b39762009-01-02 13:44:56 +0000386 * Note: nobody should set the TTY_LDISC bit except via this function.
387 * Clearing directly is allowed.
Alan Cox01e1abb2008-07-22 11:16:55 +0100388 */
389
390void tty_ldisc_enable(struct tty_struct *tty)
391{
392 set_bit(TTY_LDISC, &tty->flags);
Alan Coxc9b39762009-01-02 13:44:56 +0000393 clear_bit(TTY_LDISC_CHANGING, &tty->flags);
Alan Cox01e1abb2008-07-22 11:16:55 +0100394 wake_up(&tty_ldisc_wait);
395}
396
397/**
Alan Coxf2c4c652009-06-11 12:50:58 +0100398 * 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}
Alan Coxf2c4c652009-06-11 12:50:58 +0100415EXPORT_SYMBOL_GPL(tty_ldisc_flush);
416
417/**
Alan Cox01e1abb2008-07-22 11:16:55 +0100418 * 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
Alan Coxc65c9bc2009-06-11 12:50:12 +0100436/**
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.
443 */
444
445static int tty_ldisc_open(struct tty_struct *tty, struct tty_ldisc *ld)
446{
447 WARN_ON(test_and_set_bit(TTY_LDISC_OPEN, &tty->flags));
448 if (ld->ops->open)
449 return ld->ops->open(tty);
450 return 0;
451}
452
453/**
454 * tty_ldisc_close - close a line discipline
455 * @tty: tty we are opening the ldisc on
456 * @ld: discipline to close
457 *
458 * A helper close method. Also a convenient debugging and check
459 * point.
460 */
461
462static void tty_ldisc_close(struct tty_struct *tty, struct tty_ldisc *ld)
463{
464 WARN_ON(!test_bit(TTY_LDISC_OPEN, &tty->flags));
465 clear_bit(TTY_LDISC_OPEN, &tty->flags);
466 if (ld->ops->close)
467 ld->ops->close(tty);
468}
Alan Cox01e1abb2008-07-22 11:16:55 +0100469
470/**
471 * tty_ldisc_restore - helper for tty ldisc change
472 * @tty: tty to recover
473 * @old: previous ldisc
474 *
475 * Restore the previous line discipline or N_TTY when a line discipline
476 * change fails due to an open error
477 */
478
479static void tty_ldisc_restore(struct tty_struct *tty, struct tty_ldisc *old)
480{
481 char buf[64];
Alan Coxc65c9bc2009-06-11 12:50:12 +0100482 struct tty_ldisc *new_ldisc;
483 int r;
Alan Cox01e1abb2008-07-22 11:16:55 +0100484
485 /* There is an outstanding reference here so this is safe */
Alan Coxc65c9bc2009-06-11 12:50:12 +0100486 old = tty_ldisc_get(old->ops->num);
487 WARN_ON(IS_ERR(old));
Alan Cox01e1abb2008-07-22 11:16:55 +0100488 tty_ldisc_assign(tty, old);
489 tty_set_termios_ldisc(tty, old->ops->num);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100490 if (tty_ldisc_open(tty, old) < 0) {
491 tty_ldisc_put(old);
Alan Cox01e1abb2008-07-22 11:16:55 +0100492 /* This driver is always present */
Alan Cox852e99d2009-06-11 12:51:41 +0100493 new_ldisc = tty_ldisc_get(N_TTY);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100494 if (IS_ERR(new_ldisc))
Alan Cox01e1abb2008-07-22 11:16:55 +0100495 panic("n_tty: get");
Alan Coxc65c9bc2009-06-11 12:50:12 +0100496 tty_ldisc_assign(tty, new_ldisc);
Alan Cox01e1abb2008-07-22 11:16:55 +0100497 tty_set_termios_ldisc(tty, N_TTY);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100498 r = tty_ldisc_open(tty, new_ldisc);
499 if (r < 0)
500 panic("Couldn't open N_TTY ldisc for "
501 "%s --- error %d.",
502 tty_name(tty, buf), r);
Alan Cox01e1abb2008-07-22 11:16:55 +0100503 }
504}
505
506/**
Alan Coxc65c9bc2009-06-11 12:50:12 +0100507 * tty_ldisc_halt - shut down the line discipline
Alan Coxe8b70e72009-06-11 12:48:02 +0100508 * @tty: tty device
509 *
510 * Shut down the line discipline and work queue for this tty device.
511 * The TTY_LDISC flag being cleared ensures no further references can
512 * be obtained while the delayed work queue halt ensures that no more
513 * data is fed to the ldisc.
514 *
Alan Cox852e99d2009-06-11 12:51:41 +0100515 * In order to wait for any existing references to complete see
Alan Coxe8b70e72009-06-11 12:48:02 +0100516 * tty_ldisc_wait_idle.
517 */
518
Alan Coxc65c9bc2009-06-11 12:50:12 +0100519static int tty_ldisc_halt(struct tty_struct *tty)
Alan Coxe8b70e72009-06-11 12:48:02 +0100520{
521 clear_bit(TTY_LDISC, &tty->flags);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100522 return cancel_delayed_work(&tty->buf.work);
Alan Coxe8b70e72009-06-11 12:48:02 +0100523}
524
525/**
526 * tty_ldisc_wait_idle - wait for the ldisc to become idle
527 * @tty: tty to wait for
528 *
529 * Wait for the line discipline to become idle. The discipline must
530 * have been halted for this to guarantee it remains idle.
531 *
Alan Coxc65c9bc2009-06-11 12:50:12 +0100532 * tty_ldisc_lock protects the ref counts currently.
Alan Coxe8b70e72009-06-11 12:48:02 +0100533 */
534
Alan Coxc65c9bc2009-06-11 12:50:12 +0100535static int tty_ldisc_wait_idle(struct tty_struct *tty)
Alan Coxe8b70e72009-06-11 12:48:02 +0100536{
537 unsigned long flags;
538 spin_lock_irqsave(&tty_ldisc_lock, flags);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100539 while (tty->ldisc->refcount) {
Alan Coxe8b70e72009-06-11 12:48:02 +0100540 spin_unlock_irqrestore(&tty_ldisc_lock, flags);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100541 if (wait_event_timeout(tty_ldisc_wait,
542 tty->ldisc->refcount == 0, 5 * HZ) == 0)
543 return -EBUSY;
Alan Coxe8b70e72009-06-11 12:48:02 +0100544 spin_lock_irqsave(&tty_ldisc_lock, flags);
545 }
546 spin_unlock_irqrestore(&tty_ldisc_lock, flags);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100547 return 0;
Alan Coxe8b70e72009-06-11 12:48:02 +0100548}
549
550/**
Alan Cox01e1abb2008-07-22 11:16:55 +0100551 * tty_set_ldisc - set line discipline
552 * @tty: the terminal to set
553 * @ldisc: the line discipline
554 *
555 * Set the discipline of a tty line. Must be called from a process
Alan Coxc65c9bc2009-06-11 12:50:12 +0100556 * context. The ldisc change logic has to protect itself against any
557 * overlapping ldisc change (including on the other end of pty pairs),
558 * the close of one side of a tty/pty pair, and eventually hangup.
Alan Cox01e1abb2008-07-22 11:16:55 +0100559 *
Alan Coxc65c9bc2009-06-11 12:50:12 +0100560 * Locking: takes tty_ldisc_lock, termios_mutex
Alan Cox01e1abb2008-07-22 11:16:55 +0100561 */
562
563int tty_set_ldisc(struct tty_struct *tty, int ldisc)
564{
565 int retval;
Alan Coxc65c9bc2009-06-11 12:50:12 +0100566 struct tty_ldisc *o_ldisc, *new_ldisc;
567 int work, o_work = 0;
Alan Cox01e1abb2008-07-22 11:16:55 +0100568 struct tty_struct *o_tty;
569
Alan Coxc65c9bc2009-06-11 12:50:12 +0100570 new_ldisc = tty_ldisc_get(ldisc);
571 if (IS_ERR(new_ldisc))
572 return PTR_ERR(new_ldisc);
573
574 /*
575 * We need to look at the tty locking here for pty/tty pairs
576 * when both sides try to change in parallel.
577 */
578
579 o_tty = tty->link; /* o_tty is the pty side or NULL */
580
581
582 /*
583 * Check the no-op case
584 */
585
586 if (tty->ldisc->ops->num == ldisc) {
587 tty_ldisc_put(new_ldisc);
588 return 0;
589 }
Alan Cox01e1abb2008-07-22 11:16:55 +0100590
591 /*
592 * Problem: What do we do if this blocks ?
Alan Coxc65c9bc2009-06-11 12:50:12 +0100593 * We could deadlock here
Alan Cox01e1abb2008-07-22 11:16:55 +0100594 */
595
596 tty_wait_until_sent(tty, 0);
597
Alan Coxc65c9bc2009-06-11 12:50:12 +0100598 mutex_lock(&tty->ldisc_mutex);
Alan Cox01e1abb2008-07-22 11:16:55 +0100599
600 /*
Alan Coxc65c9bc2009-06-11 12:50:12 +0100601 * We could be midstream of another ldisc change which has
602 * dropped the lock during processing. If so we need to wait.
603 */
604
605 while (test_bit(TTY_LDISC_CHANGING, &tty->flags)) {
606 mutex_unlock(&tty->ldisc_mutex);
607 wait_event(tty_ldisc_wait,
608 test_bit(TTY_LDISC_CHANGING, &tty->flags) == 0);
609 mutex_lock(&tty->ldisc_mutex);
610 }
611 set_bit(TTY_LDISC_CHANGING, &tty->flags);
Alan Cox852e99d2009-06-11 12:51:41 +0100612
Alan Coxc65c9bc2009-06-11 12:50:12 +0100613 /*
Alan Cox01e1abb2008-07-22 11:16:55 +0100614 * No more input please, we are switching. The new ldisc
615 * will update this value in the ldisc open function
616 */
617
618 tty->receive_room = 0;
619
620 o_ldisc = tty->ldisc;
Alan Cox01e1abb2008-07-22 11:16:55 +0100621 /*
622 * Make sure we don't change while someone holds a
623 * reference to the line discipline. The TTY_LDISC bit
624 * prevents anyone taking a reference once it is clear.
625 * We need the lock to avoid racing reference takers.
Alan Coxc9b39762009-01-02 13:44:56 +0000626 *
627 * We must clear the TTY_LDISC bit here to avoid a livelock
628 * with a userspace app continually trying to use the tty in
629 * parallel to the change and re-referencing the tty.
Alan Cox01e1abb2008-07-22 11:16:55 +0100630 */
631
Alan Coxc65c9bc2009-06-11 12:50:12 +0100632 work = tty_ldisc_halt(tty);
Alan Cox01e1abb2008-07-22 11:16:55 +0100633 if (o_tty)
Alan Coxc65c9bc2009-06-11 12:50:12 +0100634 o_work = tty_ldisc_halt(o_tty);
635
Alan Cox01e1abb2008-07-22 11:16:55 +0100636 /*
Alan Coxc65c9bc2009-06-11 12:50:12 +0100637 * Wait for ->hangup_work and ->buf.work handlers to terminate.
638 * We must drop the mutex here in case a hangup is also in process.
Alan Cox01e1abb2008-07-22 11:16:55 +0100639 */
640
Alan Coxc65c9bc2009-06-11 12:50:12 +0100641 mutex_unlock(&tty->ldisc_mutex);
642
Alan Cox01e1abb2008-07-22 11:16:55 +0100643 flush_scheduled_work();
Alan Coxc65c9bc2009-06-11 12:50:12 +0100644
645 /* Let any existing reference holders finish */
646 retval = tty_ldisc_wait_idle(tty);
647 if (retval < 0) {
648 clear_bit(TTY_LDISC_CHANGING, &tty->flags);
649 tty_ldisc_put(new_ldisc);
650 return retval;
651 }
652
653 mutex_lock(&tty->ldisc_mutex);
654 if (test_bit(TTY_HUPPED, &tty->flags)) {
655 /* We were raced by the hangup method. It will have stomped
656 the ldisc data and closed the ldisc down */
657 clear_bit(TTY_LDISC_CHANGING, &tty->flags);
658 mutex_unlock(&tty->ldisc_mutex);
659 tty_ldisc_put(new_ldisc);
660 return -EIO;
661 }
662
Alan Cox01e1abb2008-07-22 11:16:55 +0100663 /* Shutdown the current discipline. */
Alan Coxc65c9bc2009-06-11 12:50:12 +0100664 tty_ldisc_close(tty, o_ldisc);
Alan Cox01e1abb2008-07-22 11:16:55 +0100665
666 /* Now set up the new line discipline. */
Alan Coxc65c9bc2009-06-11 12:50:12 +0100667 tty_ldisc_assign(tty, new_ldisc);
Alan Cox01e1abb2008-07-22 11:16:55 +0100668 tty_set_termios_ldisc(tty, ldisc);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100669
670 retval = tty_ldisc_open(tty, new_ldisc);
Alan Cox01e1abb2008-07-22 11:16:55 +0100671 if (retval < 0) {
Alan Coxc65c9bc2009-06-11 12:50:12 +0100672 /* Back to the old one or N_TTY if we can't */
673 tty_ldisc_put(new_ldisc);
674 tty_ldisc_restore(tty, o_ldisc);
Alan Cox01e1abb2008-07-22 11:16:55 +0100675 }
Alan Coxc65c9bc2009-06-11 12:50:12 +0100676
Alan Cox01e1abb2008-07-22 11:16:55 +0100677 /* At this point we hold a reference to the new ldisc and a
678 a reference to the old ldisc. If we ended up flipping back
679 to the existing ldisc we have two references to it */
680
Alan Coxc65c9bc2009-06-11 12:50:12 +0100681 if (tty->ldisc->ops->num != o_ldisc->ops->num && tty->ops->set_ldisc)
Alan Cox01e1abb2008-07-22 11:16:55 +0100682 tty->ops->set_ldisc(tty);
683
Alan Coxc65c9bc2009-06-11 12:50:12 +0100684 tty_ldisc_put(o_ldisc);
Alan Cox01e1abb2008-07-22 11:16:55 +0100685
686 /*
Alan Coxc65c9bc2009-06-11 12:50:12 +0100687 * Allow ldisc referencing to occur again
Alan Cox01e1abb2008-07-22 11:16:55 +0100688 */
689
690 tty_ldisc_enable(tty);
691 if (o_tty)
692 tty_ldisc_enable(o_tty);
693
Alan Coxc65c9bc2009-06-11 12:50:12 +0100694 /* Restart the work queue in case no characters kick it off. Safe if
Alan Cox01e1abb2008-07-22 11:16:55 +0100695 already running */
696 if (work)
697 schedule_delayed_work(&tty->buf.work, 1);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100698 if (o_work)
699 schedule_delayed_work(&o_tty->buf.work, 1);
700 mutex_unlock(&tty->ldisc_mutex);
Alan Cox01e1abb2008-07-22 11:16:55 +0100701 return retval;
702}
703
Alan Coxc65c9bc2009-06-11 12:50:12 +0100704/**
705 * tty_reset_termios - reset terminal state
706 * @tty: tty to reset
707 *
708 * Restore a terminal to the driver default state.
709 */
710
711static void tty_reset_termios(struct tty_struct *tty)
712{
713 mutex_lock(&tty->termios_mutex);
714 *tty->termios = tty->driver->init_termios;
715 tty->termios->c_ispeed = tty_termios_input_baud_rate(tty->termios);
716 tty->termios->c_ospeed = tty_termios_baud_rate(tty->termios);
717 mutex_unlock(&tty->termios_mutex);
718}
719
720
721/**
722 * tty_ldisc_reinit - reinitialise the tty ldisc
723 * @tty: tty to reinit
724 *
725 * Switch the tty back to N_TTY line discipline and leave the
726 * ldisc state closed
727 */
728
729static void tty_ldisc_reinit(struct tty_struct *tty)
730{
731 struct tty_ldisc *ld;
732
733 tty_ldisc_close(tty, tty->ldisc);
734 tty_ldisc_put(tty->ldisc);
735 tty->ldisc = NULL;
736 /*
737 * Switch the line discipline back
738 */
739 ld = tty_ldisc_get(N_TTY);
740 BUG_ON(IS_ERR(ld));
741 tty_ldisc_assign(tty, ld);
742 tty_set_termios_ldisc(tty, N_TTY);
743}
744
745/**
746 * tty_ldisc_hangup - hangup ldisc reset
747 * @tty: tty being hung up
748 *
749 * Some tty devices reset their termios when they receive a hangup
750 * event. In that situation we must also switch back to N_TTY properly
751 * before we reset the termios data.
752 *
753 * Locking: We can take the ldisc mutex as the rest of the code is
754 * careful to allow for this.
755 *
756 * In the pty pair case this occurs in the close() path of the
757 * tty itself so we must be careful about locking rules.
758 */
759
760void tty_ldisc_hangup(struct tty_struct *tty)
761{
762 struct tty_ldisc *ld;
763
764 /*
765 * FIXME! What are the locking issues here? This may me overdoing
766 * things... This question is especially important now that we've
767 * removed the irqlock.
768 */
769 ld = tty_ldisc_ref(tty);
770 if (ld != NULL) {
771 /* We may have no line discipline at this point */
772 if (ld->ops->flush_buffer)
773 ld->ops->flush_buffer(tty);
774 tty_driver_flush_buffer(tty);
775 if ((test_bit(TTY_DO_WRITE_WAKEUP, &tty->flags)) &&
776 ld->ops->write_wakeup)
777 ld->ops->write_wakeup(tty);
778 if (ld->ops->hangup)
779 ld->ops->hangup(tty);
780 tty_ldisc_deref(ld);
781 }
782 /*
783 * FIXME: Once we trust the LDISC code better we can wait here for
784 * ldisc completion and fix the driver call race
785 */
786 wake_up_interruptible_poll(&tty->write_wait, POLLOUT);
787 wake_up_interruptible_poll(&tty->read_wait, POLLIN);
788 /*
789 * Shutdown the current line discipline, and reset it to
790 * N_TTY.
791 */
792 if (tty->driver->flags & TTY_DRIVER_RESET_TERMIOS) {
Alan Coxc8d50042009-07-16 16:05:08 +0100793 /* Avoid racing set_ldisc or tty_ldisc_release */
Alan Coxc65c9bc2009-06-11 12:50:12 +0100794 mutex_lock(&tty->ldisc_mutex);
Alan Coxc8d50042009-07-16 16:05:08 +0100795 if (tty->ldisc) { /* Not yet closed */
796 /* Switch back to N_TTY */
797 tty_ldisc_halt(tty);
798 tty_ldisc_wait_idle(tty);
799 tty_ldisc_reinit(tty);
800 /* At this point we have a closed ldisc and we want to
801 reopen it. We could defer this to the next open but
802 it means auditing a lot of other paths so this is
803 a FIXME */
804 WARN_ON(tty_ldisc_open(tty, tty->ldisc));
805 tty_ldisc_enable(tty);
806 }
Alan Coxc65c9bc2009-06-11 12:50:12 +0100807 mutex_unlock(&tty->ldisc_mutex);
808 tty_reset_termios(tty);
809 }
810}
Alan Cox01e1abb2008-07-22 11:16:55 +0100811
812/**
813 * tty_ldisc_setup - open line discipline
814 * @tty: tty being shut down
815 * @o_tty: pair tty for pty/tty pairs
816 *
817 * Called during the initial open of a tty/pty pair in order to set up the
Alan Coxc65c9bc2009-06-11 12:50:12 +0100818 * line disciplines and bind them to the tty. This has no locking issues
819 * as the device isn't yet active.
Alan Cox01e1abb2008-07-22 11:16:55 +0100820 */
821
822int tty_ldisc_setup(struct tty_struct *tty, struct tty_struct *o_tty)
823{
Alan Coxc65c9bc2009-06-11 12:50:12 +0100824 struct tty_ldisc *ld = tty->ldisc;
Alan Cox01e1abb2008-07-22 11:16:55 +0100825 int retval;
826
Alan Coxc65c9bc2009-06-11 12:50:12 +0100827 retval = tty_ldisc_open(tty, ld);
828 if (retval)
829 return retval;
830
831 if (o_tty) {
832 retval = tty_ldisc_open(o_tty, o_tty->ldisc);
Alan Cox01e1abb2008-07-22 11:16:55 +0100833 if (retval) {
Alan Coxc65c9bc2009-06-11 12:50:12 +0100834 tty_ldisc_close(tty, ld);
Alan Cox01e1abb2008-07-22 11:16:55 +0100835 return retval;
836 }
837 tty_ldisc_enable(o_tty);
838 }
839 tty_ldisc_enable(tty);
840 return 0;
841}
Alan Cox01e1abb2008-07-22 11:16:55 +0100842/**
843 * tty_ldisc_release - release line discipline
844 * @tty: tty being shut down
845 * @o_tty: pair tty for pty/tty pairs
846 *
Alan Cox852e99d2009-06-11 12:51:41 +0100847 * Called during the final close of a tty/pty pair in order to shut down
848 * the line discpline layer. On exit the ldisc assigned is N_TTY and the
Alan Coxc65c9bc2009-06-11 12:50:12 +0100849 * ldisc has not been opened.
Alan Cox01e1abb2008-07-22 11:16:55 +0100850 */
851
852void tty_ldisc_release(struct tty_struct *tty, struct tty_struct *o_tty)
853{
Alan Cox01e1abb2008-07-22 11:16:55 +0100854 /*
855 * Prevent flush_to_ldisc() from rescheduling the work for later. Then
856 * kill any delayed work. As this is the final close it does not
857 * race with the set_ldisc code path.
858 */
Alan Cox01e1abb2008-07-22 11:16:55 +0100859
Alan Coxe8b70e72009-06-11 12:48:02 +0100860 tty_ldisc_halt(tty);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100861 flush_scheduled_work();
Alan Cox01e1abb2008-07-22 11:16:55 +0100862
863 /*
864 * Wait for any short term users (we know they are just driver
865 * side waiters as the file is closing so user count on the file
866 * side is zero.
867 */
Alan Coxe8b70e72009-06-11 12:48:02 +0100868
869 tty_ldisc_wait_idle(tty);
870
Alan Coxc8d50042009-07-16 16:05:08 +0100871 mutex_lock(&tty->ldisc_mutex);
Alan Cox01e1abb2008-07-22 11:16:55 +0100872 /*
Alan Coxaef29bc2009-06-29 15:21:47 +0100873 * Now kill off the ldisc
Alan Cox01e1abb2008-07-22 11:16:55 +0100874 */
Alan Coxaef29bc2009-06-29 15:21:47 +0100875 tty_ldisc_close(tty, tty->ldisc);
876 tty_ldisc_put(tty->ldisc);
877 /* Force an oops if we mess this up */
878 tty->ldisc = NULL;
Alan Cox01e1abb2008-07-22 11:16:55 +0100879
Alan Coxaef29bc2009-06-29 15:21:47 +0100880 /* Ensure the next open requests the N_TTY ldisc */
881 tty_set_termios_ldisc(tty, N_TTY);
Alan Coxc8d50042009-07-16 16:05:08 +0100882 mutex_unlock(&tty->ldisc_mutex);
Alan Coxaef29bc2009-06-29 15:21:47 +0100883
Alan Coxc65c9bc2009-06-11 12:50:12 +0100884 /* This will need doing differently if we need to lock */
885 if (o_tty)
886 tty_ldisc_release(o_tty, NULL);
Alan Coxaef29bc2009-06-29 15:21:47 +0100887
888 /* And the memory resources remaining (buffers, termios) will be
889 disposed of when the kref hits zero */
Alan Cox01e1abb2008-07-22 11:16:55 +0100890}
891
892/**
893 * tty_ldisc_init - ldisc setup for new tty
894 * @tty: tty being allocated
895 *
896 * Set up the line discipline objects for a newly allocated tty. Note that
897 * the tty structure is not completely set up when this call is made.
898 */
899
900void tty_ldisc_init(struct tty_struct *tty)
901{
Alan Coxc65c9bc2009-06-11 12:50:12 +0100902 struct tty_ldisc *ld = tty_ldisc_get(N_TTY);
903 if (IS_ERR(ld))
Alan Cox01e1abb2008-07-22 11:16:55 +0100904 panic("n_tty: init_tty");
Alan Coxc65c9bc2009-06-11 12:50:12 +0100905 tty_ldisc_assign(tty, ld);
Alan Cox01e1abb2008-07-22 11:16:55 +0100906}
907
908void tty_ldisc_begin(void)
909{
910 /* Setup the default TTY line discipline. */
911 (void) tty_register_ldisc(N_TTY, &tty_ldisc_N_TTY);
912}