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