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