blob: 01c70c01f64a6413a9d3b8761542290a37d0c2b7 [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>
24#include <linux/smp_lock.h>
25#include <linux/device.h>
26#include <linux/wait.h>
27#include <linux/bitops.h>
28#include <linux/delay.h>
29#include <linux/seq_file.h>
30
31#include <linux/uaccess.h>
32#include <asm/system.h>
33
34#include <linux/kbd_kern.h>
35#include <linux/vt_kern.h>
36#include <linux/selection.h>
37
38#include <linux/kmod.h>
39#include <linux/nsproxy.h>
40
41/*
42 * This guards the refcounted line discipline lists. The lock
43 * must be taken with irqs off because there are hangup path
44 * callers who will do ldisc lookups and cannot sleep.
45 */
46
47static DEFINE_SPINLOCK(tty_ldisc_lock);
48static DECLARE_WAIT_QUEUE_HEAD(tty_ldisc_wait);
49/* Line disc dispatch table */
50static struct tty_ldisc_ops *tty_ldiscs[NR_LDISCS];
51
52/**
53 * tty_register_ldisc - install a line discipline
54 * @disc: ldisc number
55 * @new_ldisc: pointer to the ldisc object
56 *
57 * Installs a new line discipline into the kernel. The discipline
58 * is set up as unreferenced and then made available to the kernel
59 * from this point onwards.
60 *
61 * Locking:
62 * takes tty_ldisc_lock to guard against ldisc races
63 */
64
65int tty_register_ldisc(int disc, struct tty_ldisc_ops *new_ldisc)
66{
67 unsigned long flags;
68 int ret = 0;
69
70 if (disc < N_TTY || disc >= NR_LDISCS)
71 return -EINVAL;
72
73 spin_lock_irqsave(&tty_ldisc_lock, flags);
74 tty_ldiscs[disc] = new_ldisc;
75 new_ldisc->num = disc;
76 new_ldisc->refcount = 0;
77 spin_unlock_irqrestore(&tty_ldisc_lock, flags);
78
79 return ret;
80}
81EXPORT_SYMBOL(tty_register_ldisc);
82
83/**
84 * tty_unregister_ldisc - unload a line discipline
85 * @disc: ldisc number
86 * @new_ldisc: pointer to the ldisc object
87 *
88 * Remove a line discipline from the kernel providing it is not
89 * currently in use.
90 *
91 * Locking:
92 * takes tty_ldisc_lock to guard against ldisc races
93 */
94
95int tty_unregister_ldisc(int disc)
96{
97 unsigned long flags;
98 int ret = 0;
99
100 if (disc < N_TTY || disc >= NR_LDISCS)
101 return -EINVAL;
102
103 spin_lock_irqsave(&tty_ldisc_lock, flags);
104 if (tty_ldiscs[disc]->refcount)
105 ret = -EBUSY;
106 else
107 tty_ldiscs[disc] = NULL;
108 spin_unlock_irqrestore(&tty_ldisc_lock, flags);
109
110 return ret;
111}
112EXPORT_SYMBOL(tty_unregister_ldisc);
113
114
115/**
116 * tty_ldisc_try_get - try and reference an ldisc
117 * @disc: ldisc number
Alan Cox01e1abb2008-07-22 11:16:55 +0100118 *
119 * Attempt to open and lock a line discipline into place. Return
Alan Coxc65c9bc2009-06-11 12:50:12 +0100120 * the line discipline refcounted or an error.
Alan Cox01e1abb2008-07-22 11:16:55 +0100121 */
122
Alan Coxc65c9bc2009-06-11 12:50:12 +0100123static struct tty_ldisc *tty_ldisc_try_get(int disc)
Alan Cox01e1abb2008-07-22 11:16:55 +0100124{
125 unsigned long flags;
Alan Coxc65c9bc2009-06-11 12:50:12 +0100126 struct tty_ldisc *ld;
Alan Cox01e1abb2008-07-22 11:16:55 +0100127 struct tty_ldisc_ops *ldops;
128 int err = -EINVAL;
129
Alan Coxc65c9bc2009-06-11 12:50:12 +0100130 ld = kmalloc(sizeof(struct tty_ldisc), GFP_KERNEL);
131 if (ld == NULL)
132 return ERR_PTR(-ENOMEM);
133
Alan Cox01e1abb2008-07-22 11:16:55 +0100134 spin_lock_irqsave(&tty_ldisc_lock, flags);
135 ld->ops = NULL;
136 ldops = tty_ldiscs[disc];
137 /* Check the entry is defined */
138 if (ldops) {
139 /* If the module is being unloaded we can't use it */
140 if (!try_module_get(ldops->owner))
141 err = -EAGAIN;
142 else {
143 /* lock it */
144 ldops->refcount++;
145 ld->ops = ldops;
Alan Coxc65c9bc2009-06-11 12:50:12 +0100146 ld->refcount = 0;
Alan Cox01e1abb2008-07-22 11:16:55 +0100147 err = 0;
148 }
149 }
150 spin_unlock_irqrestore(&tty_ldisc_lock, flags);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100151 if (err)
152 return ERR_PTR(err);
153 return ld;
Alan Cox01e1abb2008-07-22 11:16:55 +0100154}
155
156/**
157 * tty_ldisc_get - take a reference to an ldisc
158 * @disc: ldisc number
Alan Cox01e1abb2008-07-22 11:16:55 +0100159 *
160 * Takes a reference to a line discipline. Deals with refcounts and
161 * module locking counts. Returns NULL if the discipline is not available.
162 * Returns a pointer to the discipline and bumps the ref count if it is
163 * available
164 *
165 * Locking:
166 * takes tty_ldisc_lock to guard against ldisc races
167 */
168
Alan Coxc65c9bc2009-06-11 12:50:12 +0100169static struct tty_ldisc *tty_ldisc_get(int disc)
Alan Cox01e1abb2008-07-22 11:16:55 +0100170{
Alan Coxc65c9bc2009-06-11 12:50:12 +0100171 struct tty_ldisc *ld;
Alan Cox01e1abb2008-07-22 11:16:55 +0100172
173 if (disc < N_TTY || disc >= NR_LDISCS)
Alan Coxc65c9bc2009-06-11 12:50:12 +0100174 return ERR_PTR(-EINVAL);
175 ld = tty_ldisc_try_get(disc);
176 if (IS_ERR(ld)) {
Alan Cox01e1abb2008-07-22 11:16:55 +0100177 request_module("tty-ldisc-%d", disc);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100178 ld = tty_ldisc_try_get(disc);
Alan Cox01e1abb2008-07-22 11:16:55 +0100179 }
Alan Coxc65c9bc2009-06-11 12:50:12 +0100180 return ld;
Alan Cox01e1abb2008-07-22 11:16:55 +0100181}
182
183/**
184 * tty_ldisc_put - drop ldisc reference
Alan Coxc65c9bc2009-06-11 12:50:12 +0100185 * @ld: ldisc
Alan Cox01e1abb2008-07-22 11:16:55 +0100186 *
187 * Drop a reference to a line discipline. Manage refcounts and
Alan Coxc65c9bc2009-06-11 12:50:12 +0100188 * module usage counts. Free the ldisc once the recount hits zero.
Alan Cox01e1abb2008-07-22 11:16:55 +0100189 *
190 * Locking:
191 * takes tty_ldisc_lock to guard against ldisc races
192 */
193
Alan Coxc65c9bc2009-06-11 12:50:12 +0100194static void tty_ldisc_put(struct tty_ldisc *ld)
Alan Cox01e1abb2008-07-22 11:16:55 +0100195{
196 unsigned long flags;
Alan Coxc65c9bc2009-06-11 12:50:12 +0100197 int disc = ld->ops->num;
198 struct tty_ldisc_ops *ldo;
Alan Cox01e1abb2008-07-22 11:16:55 +0100199
200 BUG_ON(disc < N_TTY || disc >= NR_LDISCS);
201
202 spin_lock_irqsave(&tty_ldisc_lock, flags);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100203 ldo = tty_ldiscs[disc];
204 BUG_ON(ldo->refcount == 0);
205 ldo->refcount--;
206 module_put(ldo->owner);
Alan Cox01e1abb2008-07-22 11:16:55 +0100207 spin_unlock_irqrestore(&tty_ldisc_lock, flags);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100208 kfree(ld);
Alan Cox01e1abb2008-07-22 11:16:55 +0100209}
210
211static void * tty_ldiscs_seq_start(struct seq_file *m, loff_t *pos)
212{
213 return (*pos < NR_LDISCS) ? pos : NULL;
214}
215
216static void * tty_ldiscs_seq_next(struct seq_file *m, void *v, loff_t *pos)
217{
218 (*pos)++;
219 return (*pos < NR_LDISCS) ? pos : NULL;
220}
221
222static void tty_ldiscs_seq_stop(struct seq_file *m, void *v)
223{
224}
225
226static int tty_ldiscs_seq_show(struct seq_file *m, void *v)
227{
228 int i = *(loff_t *)v;
Alan Coxc65c9bc2009-06-11 12:50:12 +0100229 struct tty_ldisc *ld;
Alan Cox01e1abb2008-07-22 11:16:55 +0100230
Alan Coxc65c9bc2009-06-11 12:50:12 +0100231 ld = tty_ldisc_try_get(i);
232 if (IS_ERR(ld))
Alan Cox01e1abb2008-07-22 11:16:55 +0100233 return 0;
Alan Coxc65c9bc2009-06-11 12:50:12 +0100234 seq_printf(m, "%-10s %2d\n", ld->ops->name ? ld->ops->name : "???", i);
235 tty_ldisc_put(ld);
Alan Cox01e1abb2008-07-22 11:16:55 +0100236 return 0;
237}
238
239static const struct seq_operations tty_ldiscs_seq_ops = {
240 .start = tty_ldiscs_seq_start,
241 .next = tty_ldiscs_seq_next,
242 .stop = tty_ldiscs_seq_stop,
243 .show = tty_ldiscs_seq_show,
244};
245
246static int proc_tty_ldiscs_open(struct inode *inode, struct file *file)
247{
248 return seq_open(file, &tty_ldiscs_seq_ops);
249}
250
251const struct file_operations tty_ldiscs_proc_fops = {
252 .owner = THIS_MODULE,
253 .open = proc_tty_ldiscs_open,
254 .read = seq_read,
255 .llseek = seq_lseek,
256 .release = seq_release,
257};
258
259/**
260 * tty_ldisc_assign - set ldisc on a tty
261 * @tty: tty to assign
262 * @ld: line discipline
263 *
264 * Install an instance of a line discipline into a tty structure. The
265 * ldisc must have a reference count above zero to ensure it remains/
266 * The tty instance refcount starts at zero.
267 *
268 * Locking:
269 * Caller must hold references
270 */
271
272static void tty_ldisc_assign(struct tty_struct *tty, struct tty_ldisc *ld)
273{
Alan Coxc65c9bc2009-06-11 12:50:12 +0100274 tty->ldisc = ld;
Alan Cox01e1abb2008-07-22 11:16:55 +0100275}
276
277/**
278 * tty_ldisc_try - internal helper
279 * @tty: the tty
280 *
281 * Make a single attempt to grab and bump the refcount on
282 * the tty ldisc. Return 0 on failure or 1 on success. This is
283 * used to implement both the waiting and non waiting versions
284 * of tty_ldisc_ref
285 *
286 * Locking: takes tty_ldisc_lock
287 */
288
289static int tty_ldisc_try(struct tty_struct *tty)
290{
291 unsigned long flags;
292 struct tty_ldisc *ld;
293 int ret = 0;
294
295 spin_lock_irqsave(&tty_ldisc_lock, flags);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100296 ld = tty->ldisc;
Alan Cox01e1abb2008-07-22 11:16:55 +0100297 if (test_bit(TTY_LDISC, &tty->flags)) {
298 ld->refcount++;
299 ret = 1;
300 }
301 spin_unlock_irqrestore(&tty_ldisc_lock, flags);
302 return ret;
303}
304
305/**
306 * tty_ldisc_ref_wait - wait for the tty ldisc
307 * @tty: tty device
308 *
309 * Dereference the line discipline for the terminal and take a
310 * reference to it. If the line discipline is in flux then
311 * wait patiently until it changes.
312 *
313 * Note: Must not be called from an IRQ/timer context. The caller
314 * must also be careful not to hold other locks that will deadlock
315 * against a discipline change, such as an existing ldisc reference
316 * (which we check for)
317 *
318 * Locking: call functions take tty_ldisc_lock
319 */
320
321struct tty_ldisc *tty_ldisc_ref_wait(struct tty_struct *tty)
322{
323 /* wait_event is a macro */
324 wait_event(tty_ldisc_wait, tty_ldisc_try(tty));
Alan Coxc65c9bc2009-06-11 12:50:12 +0100325 WARN_ON(tty->ldisc->refcount == 0);
326 return tty->ldisc;
Alan Cox01e1abb2008-07-22 11:16:55 +0100327}
328
329EXPORT_SYMBOL_GPL(tty_ldisc_ref_wait);
330
331/**
332 * tty_ldisc_ref - get the tty ldisc
333 * @tty: tty device
334 *
335 * Dereference the line discipline for the terminal and take a
336 * reference to it. If the line discipline is in flux then
337 * return NULL. Can be called from IRQ and timer functions.
338 *
339 * Locking: called functions take tty_ldisc_lock
340 */
341
342struct tty_ldisc *tty_ldisc_ref(struct tty_struct *tty)
343{
344 if (tty_ldisc_try(tty))
Alan Coxc65c9bc2009-06-11 12:50:12 +0100345 return tty->ldisc;
Alan Cox01e1abb2008-07-22 11:16:55 +0100346 return NULL;
347}
348
349EXPORT_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}
376
377EXPORT_SYMBOL_GPL(tty_ldisc_deref);
378
379/**
380 * tty_ldisc_enable - allow ldisc use
381 * @tty: terminal to activate ldisc on
382 *
383 * Set the TTY_LDISC flag when the line discipline can be called
Alan Coxc9b39762009-01-02 13:44:56 +0000384 * again. Do necessary wakeups for existing sleepers. Clear the LDISC
385 * changing flag to indicate any ldisc change is now over.
Alan Cox01e1abb2008-07-22 11:16:55 +0100386 *
Alan Coxc9b39762009-01-02 13:44:56 +0000387 * Note: nobody should set the TTY_LDISC bit except via this function.
388 * Clearing directly is allowed.
Alan Cox01e1abb2008-07-22 11:16:55 +0100389 */
390
391void tty_ldisc_enable(struct tty_struct *tty)
392{
393 set_bit(TTY_LDISC, &tty->flags);
Alan Coxc9b39762009-01-02 13:44:56 +0000394 clear_bit(TTY_LDISC_CHANGING, &tty->flags);
Alan Cox01e1abb2008-07-22 11:16:55 +0100395 wake_up(&tty_ldisc_wait);
396}
397
398/**
Alan Coxf2c4c652009-06-11 12:50:58 +0100399 * tty_ldisc_flush - flush line discipline queue
400 * @tty: tty
401 *
402 * Flush the line discipline queue (if any) for this tty. If there
403 * is no line discipline active this is a no-op.
404 */
405
406void tty_ldisc_flush(struct tty_struct *tty)
407{
408 struct tty_ldisc *ld = tty_ldisc_ref(tty);
409 if (ld) {
410 if (ld->ops->flush_buffer)
411 ld->ops->flush_buffer(tty);
412 tty_ldisc_deref(ld);
413 }
414 tty_buffer_flush(tty);
415}
416
417EXPORT_SYMBOL_GPL(tty_ldisc_flush);
418
419/**
Alan Cox01e1abb2008-07-22 11:16:55 +0100420 * tty_set_termios_ldisc - set ldisc field
421 * @tty: tty structure
422 * @num: line discipline number
423 *
424 * This is probably overkill for real world processors but
425 * they are not on hot paths so a little discipline won't do
426 * any harm.
427 *
428 * Locking: takes termios_mutex
429 */
430
431static void tty_set_termios_ldisc(struct tty_struct *tty, int num)
432{
433 mutex_lock(&tty->termios_mutex);
434 tty->termios->c_line = num;
435 mutex_unlock(&tty->termios_mutex);
436}
437
Alan Coxc65c9bc2009-06-11 12:50:12 +0100438/**
439 * tty_ldisc_open - open a line discipline
440 * @tty: tty we are opening the ldisc on
441 * @ld: discipline to open
442 *
443 * A helper opening method. Also a convenient debugging and check
444 * point.
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));
450 if (ld->ops->open)
451 return ld->ops->open(tty);
452 return 0;
453}
454
455/**
456 * tty_ldisc_close - close a line discipline
457 * @tty: tty we are opening the ldisc on
458 * @ld: discipline to close
459 *
460 * A helper close method. Also a convenient debugging and check
461 * point.
462 */
463
464static void tty_ldisc_close(struct tty_struct *tty, struct tty_ldisc *ld)
465{
466 WARN_ON(!test_bit(TTY_LDISC_OPEN, &tty->flags));
467 clear_bit(TTY_LDISC_OPEN, &tty->flags);
468 if (ld->ops->close)
469 ld->ops->close(tty);
470}
Alan Cox01e1abb2008-07-22 11:16:55 +0100471
472/**
473 * tty_ldisc_restore - helper for tty ldisc change
474 * @tty: tty to recover
475 * @old: previous ldisc
476 *
477 * Restore the previous line discipline or N_TTY when a line discipline
478 * change fails due to an open error
479 */
480
481static void tty_ldisc_restore(struct tty_struct *tty, struct tty_ldisc *old)
482{
483 char buf[64];
Alan Coxc65c9bc2009-06-11 12:50:12 +0100484 struct tty_ldisc *new_ldisc;
485 int r;
Alan Cox01e1abb2008-07-22 11:16:55 +0100486
487 /* There is an outstanding reference here so this is safe */
Alan Coxc65c9bc2009-06-11 12:50:12 +0100488 old = tty_ldisc_get(old->ops->num);
489 WARN_ON(IS_ERR(old));
Alan Cox01e1abb2008-07-22 11:16:55 +0100490 tty_ldisc_assign(tty, old);
491 tty_set_termios_ldisc(tty, old->ops->num);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100492 if (tty_ldisc_open(tty, old) < 0) {
493 tty_ldisc_put(old);
Alan Cox01e1abb2008-07-22 11:16:55 +0100494 /* This driver is always present */
Alan Coxc65c9bc2009-06-11 12:50:12 +0100495 new_ldisc =tty_ldisc_get(N_TTY);
496 if (IS_ERR(new_ldisc))
Alan Cox01e1abb2008-07-22 11:16:55 +0100497 panic("n_tty: get");
Alan Coxc65c9bc2009-06-11 12:50:12 +0100498 tty_ldisc_assign(tty, new_ldisc);
Alan Cox01e1abb2008-07-22 11:16:55 +0100499 tty_set_termios_ldisc(tty, N_TTY);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100500 r = tty_ldisc_open(tty, new_ldisc);
501 if (r < 0)
502 panic("Couldn't open N_TTY ldisc for "
503 "%s --- error %d.",
504 tty_name(tty, buf), r);
Alan Cox01e1abb2008-07-22 11:16:55 +0100505 }
506}
507
508/**
Alan Coxc65c9bc2009-06-11 12:50:12 +0100509 * tty_ldisc_halt - shut down the line discipline
Alan Coxe8b70e72009-06-11 12:48:02 +0100510 * @tty: tty device
511 *
512 * Shut down the line discipline and work queue for this tty device.
513 * The TTY_LDISC flag being cleared ensures no further references can
514 * be obtained while the delayed work queue halt ensures that no more
515 * data is fed to the ldisc.
516 *
517 * In order to wait for any existing references to complete see
518 * tty_ldisc_wait_idle.
519 */
520
Alan Coxc65c9bc2009-06-11 12:50:12 +0100521static int tty_ldisc_halt(struct tty_struct *tty)
Alan Coxe8b70e72009-06-11 12:48:02 +0100522{
523 clear_bit(TTY_LDISC, &tty->flags);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100524 return cancel_delayed_work(&tty->buf.work);
Alan Coxe8b70e72009-06-11 12:48:02 +0100525}
526
527/**
528 * tty_ldisc_wait_idle - wait for the ldisc to become idle
529 * @tty: tty to wait for
530 *
531 * Wait for the line discipline to become idle. The discipline must
532 * have been halted for this to guarantee it remains idle.
533 *
Alan Coxc65c9bc2009-06-11 12:50:12 +0100534 * tty_ldisc_lock protects the ref counts currently.
Alan Coxe8b70e72009-06-11 12:48:02 +0100535 */
536
Alan Coxc65c9bc2009-06-11 12:50:12 +0100537static int tty_ldisc_wait_idle(struct tty_struct *tty)
Alan Coxe8b70e72009-06-11 12:48:02 +0100538{
539 unsigned long flags;
540 spin_lock_irqsave(&tty_ldisc_lock, flags);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100541 while (tty->ldisc->refcount) {
Alan Coxe8b70e72009-06-11 12:48:02 +0100542 spin_unlock_irqrestore(&tty_ldisc_lock, flags);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100543 if (wait_event_timeout(tty_ldisc_wait,
544 tty->ldisc->refcount == 0, 5 * HZ) == 0)
545 return -EBUSY;
Alan Coxe8b70e72009-06-11 12:48:02 +0100546 spin_lock_irqsave(&tty_ldisc_lock, flags);
547 }
548 spin_unlock_irqrestore(&tty_ldisc_lock, flags);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100549 return 0;
Alan Coxe8b70e72009-06-11 12:48:02 +0100550}
551
552/**
Alan Cox01e1abb2008-07-22 11:16:55 +0100553 * tty_set_ldisc - set line discipline
554 * @tty: the terminal to set
555 * @ldisc: the line discipline
556 *
557 * Set the discipline of a tty line. Must be called from a process
Alan Coxc65c9bc2009-06-11 12:50:12 +0100558 * context. The ldisc change logic has to protect itself against any
559 * overlapping ldisc change (including on the other end of pty pairs),
560 * the close of one side of a tty/pty pair, and eventually hangup.
Alan Cox01e1abb2008-07-22 11:16:55 +0100561 *
Alan Coxc65c9bc2009-06-11 12:50:12 +0100562 * Locking: takes tty_ldisc_lock, termios_mutex
Alan Cox01e1abb2008-07-22 11:16:55 +0100563 */
564
565int tty_set_ldisc(struct tty_struct *tty, int ldisc)
566{
567 int retval;
Alan Coxc65c9bc2009-06-11 12:50:12 +0100568 struct tty_ldisc *o_ldisc, *new_ldisc;
569 int work, o_work = 0;
Alan Cox01e1abb2008-07-22 11:16:55 +0100570 struct tty_struct *o_tty;
571
Alan Coxc65c9bc2009-06-11 12:50:12 +0100572 new_ldisc = tty_ldisc_get(ldisc);
573 if (IS_ERR(new_ldisc))
574 return PTR_ERR(new_ldisc);
575
576 /*
577 * We need to look at the tty locking here for pty/tty pairs
578 * when both sides try to change in parallel.
579 */
580
581 o_tty = tty->link; /* o_tty is the pty side or NULL */
582
583
584 /*
585 * Check the no-op case
586 */
587
588 if (tty->ldisc->ops->num == ldisc) {
589 tty_ldisc_put(new_ldisc);
590 return 0;
591 }
Alan Cox01e1abb2008-07-22 11:16:55 +0100592
593 /*
594 * Problem: What do we do if this blocks ?
Alan Coxc65c9bc2009-06-11 12:50:12 +0100595 * We could deadlock here
Alan Cox01e1abb2008-07-22 11:16:55 +0100596 */
597
598 tty_wait_until_sent(tty, 0);
599
Alan Coxc65c9bc2009-06-11 12:50:12 +0100600 mutex_lock(&tty->ldisc_mutex);
Alan Cox01e1abb2008-07-22 11:16:55 +0100601
602 /*
Alan Coxc65c9bc2009-06-11 12:50:12 +0100603 * We could be midstream of another ldisc change which has
604 * dropped the lock during processing. If so we need to wait.
605 */
606
607 while (test_bit(TTY_LDISC_CHANGING, &tty->flags)) {
608 mutex_unlock(&tty->ldisc_mutex);
609 wait_event(tty_ldisc_wait,
610 test_bit(TTY_LDISC_CHANGING, &tty->flags) == 0);
611 mutex_lock(&tty->ldisc_mutex);
612 }
613 set_bit(TTY_LDISC_CHANGING, &tty->flags);
614
615 /*
Alan Cox01e1abb2008-07-22 11:16:55 +0100616 * No more input please, we are switching. The new ldisc
617 * will update this value in the ldisc open function
618 */
619
620 tty->receive_room = 0;
621
622 o_ldisc = tty->ldisc;
Alan Cox01e1abb2008-07-22 11:16:55 +0100623 /*
624 * Make sure we don't change while someone holds a
625 * reference to the line discipline. The TTY_LDISC bit
626 * prevents anyone taking a reference once it is clear.
627 * We need the lock to avoid racing reference takers.
Alan Coxc9b39762009-01-02 13:44:56 +0000628 *
629 * We must clear the TTY_LDISC bit here to avoid a livelock
630 * with a userspace app continually trying to use the tty in
631 * parallel to the change and re-referencing the tty.
Alan Cox01e1abb2008-07-22 11:16:55 +0100632 */
633
Alan Coxc65c9bc2009-06-11 12:50:12 +0100634 work = tty_ldisc_halt(tty);
Alan Cox01e1abb2008-07-22 11:16:55 +0100635 if (o_tty)
Alan Coxc65c9bc2009-06-11 12:50:12 +0100636 o_work = tty_ldisc_halt(o_tty);
637
Alan Cox01e1abb2008-07-22 11:16:55 +0100638 /*
Alan Coxc65c9bc2009-06-11 12:50:12 +0100639 * Wait for ->hangup_work and ->buf.work handlers to terminate.
640 * We must drop the mutex here in case a hangup is also in process.
Alan Cox01e1abb2008-07-22 11:16:55 +0100641 */
642
Alan Coxc65c9bc2009-06-11 12:50:12 +0100643 mutex_unlock(&tty->ldisc_mutex);
644
Alan Cox01e1abb2008-07-22 11:16:55 +0100645 flush_scheduled_work();
Alan Coxc65c9bc2009-06-11 12:50:12 +0100646
647 /* Let any existing reference holders finish */
648 retval = tty_ldisc_wait_idle(tty);
649 if (retval < 0) {
650 clear_bit(TTY_LDISC_CHANGING, &tty->flags);
651 tty_ldisc_put(new_ldisc);
652 return retval;
653 }
654
655 mutex_lock(&tty->ldisc_mutex);
656 if (test_bit(TTY_HUPPED, &tty->flags)) {
657 /* We were raced by the hangup method. It will have stomped
658 the ldisc data and closed the ldisc down */
659 clear_bit(TTY_LDISC_CHANGING, &tty->flags);
660 mutex_unlock(&tty->ldisc_mutex);
661 tty_ldisc_put(new_ldisc);
662 return -EIO;
663 }
664
Alan Cox01e1abb2008-07-22 11:16:55 +0100665 /* Shutdown the current discipline. */
Alan Coxc65c9bc2009-06-11 12:50:12 +0100666 tty_ldisc_close(tty, o_ldisc);
Alan Cox01e1abb2008-07-22 11:16:55 +0100667
668 /* Now set up the new line discipline. */
Alan Coxc65c9bc2009-06-11 12:50:12 +0100669 tty_ldisc_assign(tty, new_ldisc);
Alan Cox01e1abb2008-07-22 11:16:55 +0100670 tty_set_termios_ldisc(tty, ldisc);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100671
672 retval = tty_ldisc_open(tty, new_ldisc);
Alan Cox01e1abb2008-07-22 11:16:55 +0100673 if (retval < 0) {
Alan Coxc65c9bc2009-06-11 12:50:12 +0100674 /* Back to the old one or N_TTY if we can't */
675 tty_ldisc_put(new_ldisc);
676 tty_ldisc_restore(tty, o_ldisc);
Alan Cox01e1abb2008-07-22 11:16:55 +0100677 }
Alan Coxc65c9bc2009-06-11 12:50:12 +0100678
Alan Cox01e1abb2008-07-22 11:16:55 +0100679 /* At this point we hold a reference to the new ldisc and a
680 a reference to the old ldisc. If we ended up flipping back
681 to the existing ldisc we have two references to it */
682
Alan Coxc65c9bc2009-06-11 12:50:12 +0100683 if (tty->ldisc->ops->num != o_ldisc->ops->num && tty->ops->set_ldisc)
Alan Cox01e1abb2008-07-22 11:16:55 +0100684 tty->ops->set_ldisc(tty);
685
Alan Coxc65c9bc2009-06-11 12:50:12 +0100686 tty_ldisc_put(o_ldisc);
Alan Cox01e1abb2008-07-22 11:16:55 +0100687
688 /*
Alan Coxc65c9bc2009-06-11 12:50:12 +0100689 * Allow ldisc referencing to occur again
Alan Cox01e1abb2008-07-22 11:16:55 +0100690 */
691
692 tty_ldisc_enable(tty);
693 if (o_tty)
694 tty_ldisc_enable(o_tty);
695
Alan Coxc65c9bc2009-06-11 12:50:12 +0100696 /* Restart the work queue in case no characters kick it off. Safe if
Alan Cox01e1abb2008-07-22 11:16:55 +0100697 already running */
698 if (work)
699 schedule_delayed_work(&tty->buf.work, 1);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100700 if (o_work)
701 schedule_delayed_work(&o_tty->buf.work, 1);
702 mutex_unlock(&tty->ldisc_mutex);
Alan Cox01e1abb2008-07-22 11:16:55 +0100703 return retval;
704}
705
Alan Coxc65c9bc2009-06-11 12:50:12 +0100706/**
707 * tty_reset_termios - reset terminal state
708 * @tty: tty to reset
709 *
710 * Restore a terminal to the driver default state.
711 */
712
713static void tty_reset_termios(struct tty_struct *tty)
714{
715 mutex_lock(&tty->termios_mutex);
716 *tty->termios = tty->driver->init_termios;
717 tty->termios->c_ispeed = tty_termios_input_baud_rate(tty->termios);
718 tty->termios->c_ospeed = tty_termios_baud_rate(tty->termios);
719 mutex_unlock(&tty->termios_mutex);
720}
721
722
723/**
724 * tty_ldisc_reinit - reinitialise the tty ldisc
725 * @tty: tty to reinit
726 *
727 * Switch the tty back to N_TTY line discipline and leave the
728 * ldisc state closed
729 */
730
731static void tty_ldisc_reinit(struct tty_struct *tty)
732{
733 struct tty_ldisc *ld;
734
735 tty_ldisc_close(tty, tty->ldisc);
736 tty_ldisc_put(tty->ldisc);
737 tty->ldisc = NULL;
738 /*
739 * Switch the line discipline back
740 */
741 ld = tty_ldisc_get(N_TTY);
742 BUG_ON(IS_ERR(ld));
743 tty_ldisc_assign(tty, ld);
744 tty_set_termios_ldisc(tty, N_TTY);
745}
746
747/**
748 * tty_ldisc_hangup - hangup ldisc reset
749 * @tty: tty being hung up
750 *
751 * Some tty devices reset their termios when they receive a hangup
752 * event. In that situation we must also switch back to N_TTY properly
753 * before we reset the termios data.
754 *
755 * Locking: We can take the ldisc mutex as the rest of the code is
756 * careful to allow for this.
757 *
758 * In the pty pair case this occurs in the close() path of the
759 * tty itself so we must be careful about locking rules.
760 */
761
762void tty_ldisc_hangup(struct tty_struct *tty)
763{
764 struct tty_ldisc *ld;
765
766 /*
767 * FIXME! What are the locking issues here? This may me overdoing
768 * things... This question is especially important now that we've
769 * removed the irqlock.
770 */
771 ld = tty_ldisc_ref(tty);
772 if (ld != NULL) {
773 /* We may have no line discipline at this point */
774 if (ld->ops->flush_buffer)
775 ld->ops->flush_buffer(tty);
776 tty_driver_flush_buffer(tty);
777 if ((test_bit(TTY_DO_WRITE_WAKEUP, &tty->flags)) &&
778 ld->ops->write_wakeup)
779 ld->ops->write_wakeup(tty);
780 if (ld->ops->hangup)
781 ld->ops->hangup(tty);
782 tty_ldisc_deref(ld);
783 }
784 /*
785 * FIXME: Once we trust the LDISC code better we can wait here for
786 * ldisc completion and fix the driver call race
787 */
788 wake_up_interruptible_poll(&tty->write_wait, POLLOUT);
789 wake_up_interruptible_poll(&tty->read_wait, POLLIN);
790 /*
791 * Shutdown the current line discipline, and reset it to
792 * N_TTY.
793 */
794 if (tty->driver->flags & TTY_DRIVER_RESET_TERMIOS) {
795 /* Avoid racing set_ldisc */
796 mutex_lock(&tty->ldisc_mutex);
797 /* Switch back to N_TTY */
798 tty_ldisc_reinit(tty);
799 /* At this point we have a closed ldisc and we want to
800 reopen it. We could defer this to the next open but
801 it means auditing a lot of other paths so this is a FIXME */
802 WARN_ON(tty_ldisc_open(tty, tty->ldisc));
803 tty_ldisc_enable(tty);
804 mutex_unlock(&tty->ldisc_mutex);
805 tty_reset_termios(tty);
806 }
807}
Alan Cox01e1abb2008-07-22 11:16:55 +0100808
809/**
810 * tty_ldisc_setup - open line discipline
811 * @tty: tty being shut down
812 * @o_tty: pair tty for pty/tty pairs
813 *
814 * Called during the initial open of a tty/pty pair in order to set up the
Alan Coxc65c9bc2009-06-11 12:50:12 +0100815 * line disciplines and bind them to the tty. This has no locking issues
816 * as the device isn't yet active.
Alan Cox01e1abb2008-07-22 11:16:55 +0100817 */
818
819int tty_ldisc_setup(struct tty_struct *tty, struct tty_struct *o_tty)
820{
Alan Coxc65c9bc2009-06-11 12:50:12 +0100821 struct tty_ldisc *ld = tty->ldisc;
Alan Cox01e1abb2008-07-22 11:16:55 +0100822 int retval;
823
Alan Coxc65c9bc2009-06-11 12:50:12 +0100824 retval = tty_ldisc_open(tty, ld);
825 if (retval)
826 return retval;
827
828 if (o_tty) {
829 retval = tty_ldisc_open(o_tty, o_tty->ldisc);
Alan Cox01e1abb2008-07-22 11:16:55 +0100830 if (retval) {
Alan Coxc65c9bc2009-06-11 12:50:12 +0100831 tty_ldisc_close(tty, ld);
Alan Cox01e1abb2008-07-22 11:16:55 +0100832 return retval;
833 }
834 tty_ldisc_enable(o_tty);
835 }
836 tty_ldisc_enable(tty);
837 return 0;
838}
Alan Cox01e1abb2008-07-22 11:16:55 +0100839/**
840 * tty_ldisc_release - release line discipline
841 * @tty: tty being shut down
842 * @o_tty: pair tty for pty/tty pairs
843 *
844 * Called during the final close of a tty/pty pair in order to shut down the
Alan Coxc65c9bc2009-06-11 12:50:12 +0100845 * line discpline layer. On exit the ldisc assigned is N_TTY and the
846 * ldisc has not been opened.
Alan Cox01e1abb2008-07-22 11:16:55 +0100847 */
848
849void tty_ldisc_release(struct tty_struct *tty, struct tty_struct *o_tty)
850{
Alan Cox01e1abb2008-07-22 11:16:55 +0100851 /*
852 * Prevent flush_to_ldisc() from rescheduling the work for later. Then
853 * kill any delayed work. As this is the final close it does not
854 * race with the set_ldisc code path.
855 */
Alan Cox01e1abb2008-07-22 11:16:55 +0100856
Alan Coxe8b70e72009-06-11 12:48:02 +0100857 tty_ldisc_halt(tty);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100858 flush_scheduled_work();
Alan Cox01e1abb2008-07-22 11:16:55 +0100859
860 /*
861 * Wait for any short term users (we know they are just driver
862 * side waiters as the file is closing so user count on the file
863 * side is zero.
864 */
Alan Coxe8b70e72009-06-11 12:48:02 +0100865
866 tty_ldisc_wait_idle(tty);
867
Alan Cox01e1abb2008-07-22 11:16:55 +0100868 /*
869 * Shutdown the current line discipline, and reset it to N_TTY.
870 *
871 * FIXME: this MUST get fixed for the new reflocking
872 */
Alan Cox01e1abb2008-07-22 11:16:55 +0100873
Alan Coxe8b70e72009-06-11 12:48:02 +0100874 tty_ldisc_reinit(tty);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100875 /* This will need doing differently if we need to lock */
876 if (o_tty)
877 tty_ldisc_release(o_tty, NULL);
Alan Cox01e1abb2008-07-22 11:16:55 +0100878}
879
880/**
881 * tty_ldisc_init - ldisc setup for new tty
882 * @tty: tty being allocated
883 *
884 * Set up the line discipline objects for a newly allocated tty. Note that
885 * the tty structure is not completely set up when this call is made.
886 */
887
888void tty_ldisc_init(struct tty_struct *tty)
889{
Alan Coxc65c9bc2009-06-11 12:50:12 +0100890 struct tty_ldisc *ld = tty_ldisc_get(N_TTY);
891 if (IS_ERR(ld))
Alan Cox01e1abb2008-07-22 11:16:55 +0100892 panic("n_tty: init_tty");
Alan Coxc65c9bc2009-06-11 12:50:12 +0100893 tty_ldisc_assign(tty, ld);
Alan Cox01e1abb2008-07-22 11:16:55 +0100894}
895
896void tty_ldisc_begin(void)
897{
898 /* Setup the default TTY line discipline. */
899 (void) tty_register_ldisc(N_TTY, &tty_ldisc_N_TTY);
900}