Revert "Merge remote branch 'linux-2.6.32.y/master' into develop"
[firefly-linux-kernel-4.4.55.git] / drivers / char / tty_io.c
1 /*
2  *  linux/drivers/char/tty_io.c
3  *
4  *  Copyright (C) 1991, 1992  Linus Torvalds
5  */
6
7 /*
8  * 'tty_io.c' gives an orthogonal feeling to tty's, be they consoles
9  * or rs-channels. It also implements echoing, cooked mode etc.
10  *
11  * Kill-line thanks to John T Kohl, who also corrected VMIN = VTIME = 0.
12  *
13  * Modified by Theodore Ts'o, 9/14/92, to dynamically allocate the
14  * tty_struct and tty_queue structures.  Previously there was an array
15  * of 256 tty_struct's which was statically allocated, and the
16  * tty_queue structures were allocated at boot time.  Both are now
17  * dynamically allocated only when the tty is open.
18  *
19  * Also restructured routines so that there is more of a separation
20  * between the high-level tty routines (tty_io.c and tty_ioctl.c) and
21  * the low-level tty routines (serial.c, pty.c, console.c).  This
22  * makes for cleaner and more compact code.  -TYT, 9/17/92
23  *
24  * Modified by Fred N. van Kempen, 01/29/93, to add line disciplines
25  * which can be dynamically activated and de-activated by the line
26  * discipline handling modules (like SLIP).
27  *
28  * NOTE: pay no attention to the line discipline code (yet); its
29  * interface is still subject to change in this version...
30  * -- TYT, 1/31/92
31  *
32  * Added functionality to the OPOST tty handling.  No delays, but all
33  * other bits should be there.
34  *      -- Nick Holloway <alfie@dcs.warwick.ac.uk>, 27th May 1993.
35  *
36  * Rewrote canonical mode and added more termios flags.
37  *      -- julian@uhunix.uhcc.hawaii.edu (J. Cowley), 13Jan94
38  *
39  * Reorganized FASYNC support so mouse code can share it.
40  *      -- ctm@ardi.com, 9Sep95
41  *
42  * New TIOCLINUX variants added.
43  *      -- mj@k332.feld.cvut.cz, 19-Nov-95
44  *
45  * Restrict vt switching via ioctl()
46  *      -- grif@cs.ucr.edu, 5-Dec-95
47  *
48  * Move console and virtual terminal code to more appropriate files,
49  * implement CONFIG_VT and generalize console device interface.
50  *      -- Marko Kohtala <Marko.Kohtala@hut.fi>, March 97
51  *
52  * Rewrote tty_init_dev and tty_release_dev to eliminate races.
53  *      -- Bill Hawes <whawes@star.net>, June 97
54  *
55  * Added devfs support.
56  *      -- C. Scott Ananian <cananian@alumni.princeton.edu>, 13-Jan-1998
57  *
58  * Added support for a Unix98-style ptmx device.
59  *      -- C. Scott Ananian <cananian@alumni.princeton.edu>, 14-Jan-1998
60  *
61  * Reduced memory usage for older ARM systems
62  *      -- Russell King <rmk@arm.linux.org.uk>
63  *
64  * Move do_SAK() into process context.  Less stack use in devfs functions.
65  * alloc_tty_struct() always uses kmalloc()
66  *                       -- Andrew Morton <andrewm@uow.edu.eu> 17Mar01
67  */
68
69 #include <linux/types.h>
70 #include <linux/major.h>
71 #include <linux/errno.h>
72 #include <linux/signal.h>
73 #include <linux/fcntl.h>
74 #include <linux/sched.h>
75 #include <linux/interrupt.h>
76 #include <linux/tty.h>
77 #include <linux/tty_driver.h>
78 #include <linux/tty_flip.h>
79 #include <linux/devpts_fs.h>
80 #include <linux/file.h>
81 #include <linux/fdtable.h>
82 #include <linux/console.h>
83 #include <linux/timer.h>
84 #include <linux/ctype.h>
85 #include <linux/kd.h>
86 #include <linux/mm.h>
87 #include <linux/string.h>
88 #include <linux/slab.h>
89 #include <linux/poll.h>
90 #include <linux/proc_fs.h>
91 #include <linux/init.h>
92 #include <linux/module.h>
93 #include <linux/smp_lock.h>
94 #include <linux/device.h>
95 #include <linux/wait.h>
96 #include <linux/bitops.h>
97 #include <linux/delay.h>
98 #include <linux/seq_file.h>
99
100 #include <linux/uaccess.h>
101 #include <asm/system.h>
102
103 #include <linux/kbd_kern.h>
104 #include <linux/vt_kern.h>
105 #include <linux/selection.h>
106
107 #include <linux/kmod.h>
108 #include <linux/nsproxy.h>
109
110 #undef TTY_DEBUG_HANGUP
111
112 #define TTY_PARANOIA_CHECK 1
113 #define CHECK_TTY_COUNT 1
114
115 struct ktermios tty_std_termios = {     /* for the benefit of tty drivers  */
116         .c_iflag = ICRNL | IXON,
117         .c_oflag = OPOST | ONLCR,
118         .c_cflag = B38400 | CS8 | CREAD | HUPCL,
119         .c_lflag = ISIG | ICANON | ECHO | ECHOE | ECHOK |
120                    ECHOCTL | ECHOKE | IEXTEN,
121         .c_cc = INIT_C_CC,
122         .c_ispeed = 38400,
123         .c_ospeed = 38400
124 };
125
126 EXPORT_SYMBOL(tty_std_termios);
127
128 /* This list gets poked at by procfs and various bits of boot up code. This
129    could do with some rationalisation such as pulling the tty proc function
130    into this file */
131
132 LIST_HEAD(tty_drivers);                 /* linked list of tty drivers */
133
134 /* Mutex to protect creating and releasing a tty. This is shared with
135    vt.c for deeply disgusting hack reasons */
136 DEFINE_MUTEX(tty_mutex);
137 EXPORT_SYMBOL(tty_mutex);
138
139 static ssize_t tty_read(struct file *, char __user *, size_t, loff_t *);
140 static ssize_t tty_write(struct file *, const char __user *, size_t, loff_t *);
141 ssize_t redirected_tty_write(struct file *, const char __user *,
142                                                         size_t, loff_t *);
143 static unsigned int tty_poll(struct file *, poll_table *);
144 static int tty_open(struct inode *, struct file *);
145 static int tty_release(struct inode *, struct file *);
146 long tty_ioctl(struct file *file, unsigned int cmd, unsigned long arg);
147 #ifdef CONFIG_COMPAT
148 static long tty_compat_ioctl(struct file *file, unsigned int cmd,
149                                 unsigned long arg);
150 #else
151 #define tty_compat_ioctl NULL
152 #endif
153 static int tty_fasync(int fd, struct file *filp, int on);
154 static void release_tty(struct tty_struct *tty, int idx);
155 static void __proc_set_tty(struct task_struct *tsk, struct tty_struct *tty);
156 static void proc_set_tty(struct task_struct *tsk, struct tty_struct *tty);
157
158 /**
159  *      alloc_tty_struct        -       allocate a tty object
160  *
161  *      Return a new empty tty structure. The data fields have not
162  *      been initialized in any way but has been zeroed
163  *
164  *      Locking: none
165  */
166
167 struct tty_struct *alloc_tty_struct(void)
168 {
169         return kzalloc(sizeof(struct tty_struct), GFP_KERNEL);
170 }
171
172 /**
173  *      free_tty_struct         -       free a disused tty
174  *      @tty: tty struct to free
175  *
176  *      Free the write buffers, tty queue and tty memory itself.
177  *
178  *      Locking: none. Must be called after tty is definitely unused
179  */
180
181 void free_tty_struct(struct tty_struct *tty)
182 {
183         kfree(tty->write_buf);
184         tty_buffer_free_all(tty);
185         kfree(tty);
186 }
187
188 #define TTY_NUMBER(tty) ((tty)->index + (tty)->driver->name_base)
189
190 /**
191  *      tty_name        -       return tty naming
192  *      @tty: tty structure
193  *      @buf: buffer for output
194  *
195  *      Convert a tty structure into a name. The name reflects the kernel
196  *      naming policy and if udev is in use may not reflect user space
197  *
198  *      Locking: none
199  */
200
201 char *tty_name(struct tty_struct *tty, char *buf)
202 {
203         if (!tty) /* Hmm.  NULL pointer.  That's fun. */
204                 strcpy(buf, "NULL tty");
205         else
206                 strcpy(buf, tty->name);
207         return buf;
208 }
209
210 EXPORT_SYMBOL(tty_name);
211
212 int tty_paranoia_check(struct tty_struct *tty, struct inode *inode,
213                               const char *routine)
214 {
215 #ifdef TTY_PARANOIA_CHECK
216         if (!tty) {
217                 printk(KERN_WARNING
218                         "null TTY for (%d:%d) in %s\n",
219                         imajor(inode), iminor(inode), routine);
220                 return 1;
221         }
222         if (tty->magic != TTY_MAGIC) {
223                 printk(KERN_WARNING
224                         "bad magic number for tty struct (%d:%d) in %s\n",
225                         imajor(inode), iminor(inode), routine);
226                 return 1;
227         }
228 #endif
229         return 0;
230 }
231
232 static int check_tty_count(struct tty_struct *tty, const char *routine)
233 {
234 #ifdef CHECK_TTY_COUNT
235         struct list_head *p;
236         int count = 0;
237
238         file_list_lock();
239         list_for_each(p, &tty->tty_files) {
240                 count++;
241         }
242         file_list_unlock();
243         if (tty->driver->type == TTY_DRIVER_TYPE_PTY &&
244             tty->driver->subtype == PTY_TYPE_SLAVE &&
245             tty->link && tty->link->count)
246                 count++;
247         if (tty->count != count) {
248                 printk(KERN_WARNING "Warning: dev (%s) tty->count(%d) "
249                                     "!= #fd's(%d) in %s\n",
250                        tty->name, tty->count, count, routine);
251                 return count;
252         }
253 #endif
254         return 0;
255 }
256
257 /**
258  *      get_tty_driver          -       find device of a tty
259  *      @dev_t: device identifier
260  *      @index: returns the index of the tty
261  *
262  *      This routine returns a tty driver structure, given a device number
263  *      and also passes back the index number.
264  *
265  *      Locking: caller must hold tty_mutex
266  */
267
268 static struct tty_driver *get_tty_driver(dev_t device, int *index)
269 {
270         struct tty_driver *p;
271
272         list_for_each_entry(p, &tty_drivers, tty_drivers) {
273                 dev_t base = MKDEV(p->major, p->minor_start);
274                 if (device < base || device >= base + p->num)
275                         continue;
276                 *index = device - base;
277                 return tty_driver_kref_get(p);
278         }
279         return NULL;
280 }
281
282 #ifdef CONFIG_CONSOLE_POLL
283
284 /**
285  *      tty_find_polling_driver -       find device of a polled tty
286  *      @name: name string to match
287  *      @line: pointer to resulting tty line nr
288  *
289  *      This routine returns a tty driver structure, given a name
290  *      and the condition that the tty driver is capable of polled
291  *      operation.
292  */
293 struct tty_driver *tty_find_polling_driver(char *name, int *line)
294 {
295         struct tty_driver *p, *res = NULL;
296         int tty_line = 0;
297         int len;
298         char *str, *stp;
299
300         for (str = name; *str; str++)
301                 if ((*str >= '0' && *str <= '9') || *str == ',')
302                         break;
303         if (!*str)
304                 return NULL;
305
306         len = str - name;
307         tty_line = simple_strtoul(str, &str, 10);
308
309         mutex_lock(&tty_mutex);
310         /* Search through the tty devices to look for a match */
311         list_for_each_entry(p, &tty_drivers, tty_drivers) {
312                 if (strncmp(name, p->name, len) != 0)
313                         continue;
314                 stp = str;
315                 if (*stp == ',')
316                         stp++;
317                 if (*stp == '\0')
318                         stp = NULL;
319
320                 if (tty_line >= 0 && tty_line <= p->num && p->ops &&
321                     p->ops->poll_init && !p->ops->poll_init(p, tty_line, stp)) {
322                         res = tty_driver_kref_get(p);
323                         *line = tty_line;
324                         break;
325                 }
326         }
327         mutex_unlock(&tty_mutex);
328
329         return res;
330 }
331 EXPORT_SYMBOL_GPL(tty_find_polling_driver);
332 #endif
333
334 /**
335  *      tty_check_change        -       check for POSIX terminal changes
336  *      @tty: tty to check
337  *
338  *      If we try to write to, or set the state of, a terminal and we're
339  *      not in the foreground, send a SIGTTOU.  If the signal is blocked or
340  *      ignored, go ahead and perform the operation.  (POSIX 7.2)
341  *
342  *      Locking: ctrl_lock
343  */
344
345 int tty_check_change(struct tty_struct *tty)
346 {
347         unsigned long flags;
348         int ret = 0;
349
350         if (current->signal->tty != tty)
351                 return 0;
352
353         spin_lock_irqsave(&tty->ctrl_lock, flags);
354
355         if (!tty->pgrp) {
356                 printk(KERN_WARNING "tty_check_change: tty->pgrp == NULL!\n");
357                 goto out_unlock;
358         }
359         if (task_pgrp(current) == tty->pgrp)
360                 goto out_unlock;
361         spin_unlock_irqrestore(&tty->ctrl_lock, flags);
362         if (is_ignored(SIGTTOU))
363                 goto out;
364         if (is_current_pgrp_orphaned()) {
365                 ret = -EIO;
366                 goto out;
367         }
368         kill_pgrp(task_pgrp(current), SIGTTOU, 1);
369         set_thread_flag(TIF_SIGPENDING);
370         ret = -ERESTARTSYS;
371 out:
372         return ret;
373 out_unlock:
374         spin_unlock_irqrestore(&tty->ctrl_lock, flags);
375         return ret;
376 }
377
378 EXPORT_SYMBOL(tty_check_change);
379
380 static ssize_t hung_up_tty_read(struct file *file, char __user *buf,
381                                 size_t count, loff_t *ppos)
382 {
383         return 0;
384 }
385
386 static ssize_t hung_up_tty_write(struct file *file, const char __user *buf,
387                                  size_t count, loff_t *ppos)
388 {
389         return -EIO;
390 }
391
392 /* No kernel lock held - none needed ;) */
393 static unsigned int hung_up_tty_poll(struct file *filp, poll_table *wait)
394 {
395         return POLLIN | POLLOUT | POLLERR | POLLHUP | POLLRDNORM | POLLWRNORM;
396 }
397
398 static long hung_up_tty_ioctl(struct file *file, unsigned int cmd,
399                 unsigned long arg)
400 {
401         return cmd == TIOCSPGRP ? -ENOTTY : -EIO;
402 }
403
404 static long hung_up_tty_compat_ioctl(struct file *file,
405                                      unsigned int cmd, unsigned long arg)
406 {
407         return cmd == TIOCSPGRP ? -ENOTTY : -EIO;
408 }
409
410 static const struct file_operations tty_fops = {
411         .llseek         = no_llseek,
412         .read           = tty_read,
413         .write          = tty_write,
414         .poll           = tty_poll,
415         .unlocked_ioctl = tty_ioctl,
416         .compat_ioctl   = tty_compat_ioctl,
417         .open           = tty_open,
418         .release        = tty_release,
419         .fasync         = tty_fasync,
420 };
421
422 static const struct file_operations console_fops = {
423         .llseek         = no_llseek,
424         .read           = tty_read,
425         .write          = redirected_tty_write,
426         .poll           = tty_poll,
427         .unlocked_ioctl = tty_ioctl,
428         .compat_ioctl   = tty_compat_ioctl,
429         .open           = tty_open,
430         .release        = tty_release,
431         .fasync         = tty_fasync,
432 };
433
434 static const struct file_operations hung_up_tty_fops = {
435         .llseek         = no_llseek,
436         .read           = hung_up_tty_read,
437         .write          = hung_up_tty_write,
438         .poll           = hung_up_tty_poll,
439         .unlocked_ioctl = hung_up_tty_ioctl,
440         .compat_ioctl   = hung_up_tty_compat_ioctl,
441         .release        = tty_release,
442 };
443
444 static DEFINE_SPINLOCK(redirect_lock);
445 static struct file *redirect;
446
447 /**
448  *      tty_wakeup      -       request more data
449  *      @tty: terminal
450  *
451  *      Internal and external helper for wakeups of tty. This function
452  *      informs the line discipline if present that the driver is ready
453  *      to receive more output data.
454  */
455
456 void tty_wakeup(struct tty_struct *tty)
457 {
458         struct tty_ldisc *ld;
459
460         if (test_bit(TTY_DO_WRITE_WAKEUP, &tty->flags)) {
461                 ld = tty_ldisc_ref(tty);
462                 if (ld) {
463                         if (ld->ops->write_wakeup)
464                                 ld->ops->write_wakeup(tty);
465                         tty_ldisc_deref(ld);
466                 }
467         }
468         wake_up_interruptible_poll(&tty->write_wait, POLLOUT);
469 }
470
471 EXPORT_SYMBOL_GPL(tty_wakeup);
472
473 /**
474  *      do_tty_hangup           -       actual handler for hangup events
475  *      @work: tty device
476  *
477  *      This can be called by the "eventd" kernel thread.  That is process
478  *      synchronous but doesn't hold any locks, so we need to make sure we
479  *      have the appropriate locks for what we're doing.
480  *
481  *      The hangup event clears any pending redirections onto the hung up
482  *      device. It ensures future writes will error and it does the needed
483  *      line discipline hangup and signal delivery. The tty object itself
484  *      remains intact.
485  *
486  *      Locking:
487  *              BKL
488  *                redirect lock for undoing redirection
489  *                file list lock for manipulating list of ttys
490  *                tty_ldisc_lock from called functions
491  *                termios_mutex resetting termios data
492  *                tasklist_lock to walk task list for hangup event
493  *                  ->siglock to protect ->signal/->sighand
494  */
495 static void do_tty_hangup(struct work_struct *work)
496 {
497         struct tty_struct *tty =
498                 container_of(work, struct tty_struct, hangup_work);
499         struct file *cons_filp = NULL;
500         struct file *filp, *f = NULL;
501         struct task_struct *p;
502         int    closecount = 0, n;
503         unsigned long flags;
504         int refs = 0;
505
506         if (!tty)
507                 return;
508
509         /* inuse_filps is protected by the single kernel lock */
510         lock_kernel();
511
512         spin_lock(&redirect_lock);
513         if (redirect && redirect->private_data == tty) {
514                 f = redirect;
515                 redirect = NULL;
516         }
517         spin_unlock(&redirect_lock);
518
519         check_tty_count(tty, "do_tty_hangup");
520         file_list_lock();
521         /* This breaks for file handles being sent over AF_UNIX sockets ? */
522         list_for_each_entry(filp, &tty->tty_files, f_u.fu_list) {
523                 if (filp->f_op->write == redirected_tty_write)
524                         cons_filp = filp;
525                 if (filp->f_op->write != tty_write)
526                         continue;
527                 closecount++;
528                 tty_fasync(-1, filp, 0);        /* can't block */
529                 filp->f_op = &hung_up_tty_fops;
530         }
531         file_list_unlock();
532
533         tty_ldisc_hangup(tty);
534
535         read_lock(&tasklist_lock);
536         if (tty->session) {
537                 do_each_pid_task(tty->session, PIDTYPE_SID, p) {
538                         spin_lock_irq(&p->sighand->siglock);
539                         if (p->signal->tty == tty) {
540                                 p->signal->tty = NULL;
541                                 /* We defer the dereferences outside fo
542                                    the tasklist lock */
543                                 refs++;
544                         }
545                         if (!p->signal->leader) {
546                                 spin_unlock_irq(&p->sighand->siglock);
547                                 continue;
548                         }
549                         __group_send_sig_info(SIGHUP, SEND_SIG_PRIV, p);
550                         __group_send_sig_info(SIGCONT, SEND_SIG_PRIV, p);
551                         put_pid(p->signal->tty_old_pgrp);  /* A noop */
552                         spin_lock_irqsave(&tty->ctrl_lock, flags);
553                         if (tty->pgrp)
554                                 p->signal->tty_old_pgrp = get_pid(tty->pgrp);
555                         spin_unlock_irqrestore(&tty->ctrl_lock, flags);
556                         spin_unlock_irq(&p->sighand->siglock);
557                 } while_each_pid_task(tty->session, PIDTYPE_SID, p);
558         }
559         read_unlock(&tasklist_lock);
560
561         spin_lock_irqsave(&tty->ctrl_lock, flags);
562         clear_bit(TTY_THROTTLED, &tty->flags);
563         clear_bit(TTY_PUSH, &tty->flags);
564         clear_bit(TTY_DO_WRITE_WAKEUP, &tty->flags);
565         put_pid(tty->session);
566         put_pid(tty->pgrp);
567         tty->session = NULL;
568         tty->pgrp = NULL;
569         tty->ctrl_status = 0;
570         set_bit(TTY_HUPPED, &tty->flags);
571         spin_unlock_irqrestore(&tty->ctrl_lock, flags);
572
573         /* Account for the p->signal references we killed */
574         while (refs--)
575                 tty_kref_put(tty);
576
577         /*
578          * If one of the devices matches a console pointer, we
579          * cannot just call hangup() because that will cause
580          * tty->count and state->count to go out of sync.
581          * So we just call close() the right number of times.
582          */
583         if (cons_filp) {
584                 if (tty->ops->close)
585                         for (n = 0; n < closecount; n++)
586                                 tty->ops->close(tty, cons_filp);
587         } else if (tty->ops->hangup)
588                 (tty->ops->hangup)(tty);
589         /*
590          * We don't want to have driver/ldisc interactions beyond
591          * the ones we did here. The driver layer expects no
592          * calls after ->hangup() from the ldisc side. However we
593          * can't yet guarantee all that.
594          */
595         set_bit(TTY_HUPPED, &tty->flags);
596         tty_ldisc_enable(tty);
597         unlock_kernel();
598         if (f)
599                 fput(f);
600 }
601
602 /**
603  *      tty_hangup              -       trigger a hangup event
604  *      @tty: tty to hangup
605  *
606  *      A carrier loss (virtual or otherwise) has occurred on this like
607  *      schedule a hangup sequence to run after this event.
608  */
609
610 void tty_hangup(struct tty_struct *tty)
611 {
612 #ifdef TTY_DEBUG_HANGUP
613         char    buf[64];
614         printk(KERN_DEBUG "%s hangup...\n", tty_name(tty, buf));
615 #endif
616         schedule_work(&tty->hangup_work);
617 }
618
619 EXPORT_SYMBOL(tty_hangup);
620
621 /**
622  *      tty_vhangup             -       process vhangup
623  *      @tty: tty to hangup
624  *
625  *      The user has asked via system call for the terminal to be hung up.
626  *      We do this synchronously so that when the syscall returns the process
627  *      is complete. That guarantee is necessary for security reasons.
628  */
629
630 void tty_vhangup(struct tty_struct *tty)
631 {
632 #ifdef TTY_DEBUG_HANGUP
633         char    buf[64];
634
635         printk(KERN_DEBUG "%s vhangup...\n", tty_name(tty, buf));
636 #endif
637         do_tty_hangup(&tty->hangup_work);
638 }
639
640 EXPORT_SYMBOL(tty_vhangup);
641
642 /**
643  *      tty_vhangup_self        -       process vhangup for own ctty
644  *
645  *      Perform a vhangup on the current controlling tty
646  */
647
648 void tty_vhangup_self(void)
649 {
650         struct tty_struct *tty;
651
652         tty = get_current_tty();
653         if (tty) {
654                 tty_vhangup(tty);
655                 tty_kref_put(tty);
656         }
657 }
658
659 /**
660  *      tty_hung_up_p           -       was tty hung up
661  *      @filp: file pointer of tty
662  *
663  *      Return true if the tty has been subject to a vhangup or a carrier
664  *      loss
665  */
666
667 int tty_hung_up_p(struct file *filp)
668 {
669         return (filp->f_op == &hung_up_tty_fops);
670 }
671
672 EXPORT_SYMBOL(tty_hung_up_p);
673
674 static void session_clear_tty(struct pid *session)
675 {
676         struct task_struct *p;
677         do_each_pid_task(session, PIDTYPE_SID, p) {
678                 proc_clear_tty(p);
679         } while_each_pid_task(session, PIDTYPE_SID, p);
680 }
681
682 /**
683  *      disassociate_ctty       -       disconnect controlling tty
684  *      @on_exit: true if exiting so need to "hang up" the session
685  *
686  *      This function is typically called only by the session leader, when
687  *      it wants to disassociate itself from its controlling tty.
688  *
689  *      It performs the following functions:
690  *      (1)  Sends a SIGHUP and SIGCONT to the foreground process group
691  *      (2)  Clears the tty from being controlling the session
692  *      (3)  Clears the controlling tty for all processes in the
693  *              session group.
694  *
695  *      The argument on_exit is set to 1 if called when a process is
696  *      exiting; it is 0 if called by the ioctl TIOCNOTTY.
697  *
698  *      Locking:
699  *              BKL is taken for hysterical raisins
700  *                tty_mutex is taken to protect tty
701  *                ->siglock is taken to protect ->signal/->sighand
702  *                tasklist_lock is taken to walk process list for sessions
703  *                  ->siglock is taken to protect ->signal/->sighand
704  */
705
706 void disassociate_ctty(int on_exit)
707 {
708         struct tty_struct *tty;
709         struct pid *tty_pgrp = NULL;
710
711
712         tty = get_current_tty();
713         if (tty) {
714                 tty_pgrp = get_pid(tty->pgrp);
715                 lock_kernel();
716                 if (on_exit && tty->driver->type != TTY_DRIVER_TYPE_PTY)
717                         tty_vhangup(tty);
718                 unlock_kernel();
719                 tty_kref_put(tty);
720         } else if (on_exit) {
721                 struct pid *old_pgrp;
722                 spin_lock_irq(&current->sighand->siglock);
723                 old_pgrp = current->signal->tty_old_pgrp;
724                 current->signal->tty_old_pgrp = NULL;
725                 spin_unlock_irq(&current->sighand->siglock);
726                 if (old_pgrp) {
727                         kill_pgrp(old_pgrp, SIGHUP, on_exit);
728                         kill_pgrp(old_pgrp, SIGCONT, on_exit);
729                         put_pid(old_pgrp);
730                 }
731                 return;
732         }
733         if (tty_pgrp) {
734                 kill_pgrp(tty_pgrp, SIGHUP, on_exit);
735                 if (!on_exit)
736                         kill_pgrp(tty_pgrp, SIGCONT, on_exit);
737                 put_pid(tty_pgrp);
738         }
739
740         spin_lock_irq(&current->sighand->siglock);
741         put_pid(current->signal->tty_old_pgrp);
742         current->signal->tty_old_pgrp = NULL;
743         spin_unlock_irq(&current->sighand->siglock);
744
745         tty = get_current_tty();
746         if (tty) {
747                 unsigned long flags;
748                 spin_lock_irqsave(&tty->ctrl_lock, flags);
749                 put_pid(tty->session);
750                 put_pid(tty->pgrp);
751                 tty->session = NULL;
752                 tty->pgrp = NULL;
753                 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
754                 tty_kref_put(tty);
755         } else {
756 #ifdef TTY_DEBUG_HANGUP
757                 printk(KERN_DEBUG "error attempted to write to tty [0x%p]"
758                        " = NULL", tty);
759 #endif
760         }
761
762         /* Now clear signal->tty under the lock */
763         read_lock(&tasklist_lock);
764         session_clear_tty(task_session(current));
765         read_unlock(&tasklist_lock);
766 }
767
768 /**
769  *
770  *      no_tty  - Ensure the current process does not have a controlling tty
771  */
772 void no_tty(void)
773 {
774         struct task_struct *tsk = current;
775         lock_kernel();
776         if (tsk->signal->leader)
777                 disassociate_ctty(0);
778         unlock_kernel();
779         proc_clear_tty(tsk);
780 }
781
782
783 /**
784  *      stop_tty        -       propagate flow control
785  *      @tty: tty to stop
786  *
787  *      Perform flow control to the driver. For PTY/TTY pairs we
788  *      must also propagate the TIOCKPKT status. May be called
789  *      on an already stopped device and will not re-call the driver
790  *      method.
791  *
792  *      This functionality is used by both the line disciplines for
793  *      halting incoming flow and by the driver. It may therefore be
794  *      called from any context, may be under the tty atomic_write_lock
795  *      but not always.
796  *
797  *      Locking:
798  *              Uses the tty control lock internally
799  */
800
801 void stop_tty(struct tty_struct *tty)
802 {
803         unsigned long flags;
804         spin_lock_irqsave(&tty->ctrl_lock, flags);
805         if (tty->stopped) {
806                 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
807                 return;
808         }
809         tty->stopped = 1;
810         if (tty->link && tty->link->packet) {
811                 tty->ctrl_status &= ~TIOCPKT_START;
812                 tty->ctrl_status |= TIOCPKT_STOP;
813                 wake_up_interruptible_poll(&tty->link->read_wait, POLLIN);
814         }
815         spin_unlock_irqrestore(&tty->ctrl_lock, flags);
816         if (tty->ops->stop)
817                 (tty->ops->stop)(tty);
818 }
819
820 EXPORT_SYMBOL(stop_tty);
821
822 /**
823  *      start_tty       -       propagate flow control
824  *      @tty: tty to start
825  *
826  *      Start a tty that has been stopped if at all possible. Perform
827  *      any necessary wakeups and propagate the TIOCPKT status. If this
828  *      is the tty was previous stopped and is being started then the
829  *      driver start method is invoked and the line discipline woken.
830  *
831  *      Locking:
832  *              ctrl_lock
833  */
834
835 void start_tty(struct tty_struct *tty)
836 {
837         unsigned long flags;
838         spin_lock_irqsave(&tty->ctrl_lock, flags);
839         if (!tty->stopped || tty->flow_stopped) {
840                 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
841                 return;
842         }
843         tty->stopped = 0;
844         if (tty->link && tty->link->packet) {
845                 tty->ctrl_status &= ~TIOCPKT_STOP;
846                 tty->ctrl_status |= TIOCPKT_START;
847                 wake_up_interruptible_poll(&tty->link->read_wait, POLLIN);
848         }
849         spin_unlock_irqrestore(&tty->ctrl_lock, flags);
850         if (tty->ops->start)
851                 (tty->ops->start)(tty);
852         /* If we have a running line discipline it may need kicking */
853         tty_wakeup(tty);
854 }
855
856 EXPORT_SYMBOL(start_tty);
857
858 /**
859  *      tty_read        -       read method for tty device files
860  *      @file: pointer to tty file
861  *      @buf: user buffer
862  *      @count: size of user buffer
863  *      @ppos: unused
864  *
865  *      Perform the read system call function on this terminal device. Checks
866  *      for hung up devices before calling the line discipline method.
867  *
868  *      Locking:
869  *              Locks the line discipline internally while needed. Multiple
870  *      read calls may be outstanding in parallel.
871  */
872
873 static ssize_t tty_read(struct file *file, char __user *buf, size_t count,
874                         loff_t *ppos)
875 {
876         int i;
877         struct tty_struct *tty;
878         struct inode *inode;
879         struct tty_ldisc *ld;
880
881         tty = (struct tty_struct *)file->private_data;
882         inode = file->f_path.dentry->d_inode;
883         if (tty_paranoia_check(tty, inode, "tty_read"))
884                 return -EIO;
885         if (!tty || (test_bit(TTY_IO_ERROR, &tty->flags)))
886                 return -EIO;
887
888         /* We want to wait for the line discipline to sort out in this
889            situation */
890         ld = tty_ldisc_ref_wait(tty);
891         if (ld->ops->read)
892                 i = (ld->ops->read)(tty, file, buf, count);
893         else
894                 i = -EIO;
895         tty_ldisc_deref(ld);
896         if (i > 0)
897                 inode->i_atime = current_fs_time(inode->i_sb);
898         return i;
899 }
900
901 void tty_write_unlock(struct tty_struct *tty)
902 {
903         mutex_unlock(&tty->atomic_write_lock);
904         wake_up_interruptible_poll(&tty->write_wait, POLLOUT);
905 }
906
907 int tty_write_lock(struct tty_struct *tty, int ndelay)
908 {
909         if (!mutex_trylock(&tty->atomic_write_lock)) {
910                 if (ndelay)
911                         return -EAGAIN;
912                 if (mutex_lock_interruptible(&tty->atomic_write_lock))
913                         return -ERESTARTSYS;
914         }
915         return 0;
916 }
917
918 /*
919  * Split writes up in sane blocksizes to avoid
920  * denial-of-service type attacks
921  */
922 static inline ssize_t do_tty_write(
923         ssize_t (*write)(struct tty_struct *, struct file *, const unsigned char *, size_t),
924         struct tty_struct *tty,
925         struct file *file,
926         const char __user *buf,
927         size_t count)
928 {
929         ssize_t ret, written = 0;
930         unsigned int chunk;
931
932         ret = tty_write_lock(tty, file->f_flags & O_NDELAY);
933         if (ret < 0)
934                 return ret;
935
936         /*
937          * We chunk up writes into a temporary buffer. This
938          * simplifies low-level drivers immensely, since they
939          * don't have locking issues and user mode accesses.
940          *
941          * But if TTY_NO_WRITE_SPLIT is set, we should use a
942          * big chunk-size..
943          *
944          * The default chunk-size is 2kB, because the NTTY
945          * layer has problems with bigger chunks. It will
946          * claim to be able to handle more characters than
947          * it actually does.
948          *
949          * FIXME: This can probably go away now except that 64K chunks
950          * are too likely to fail unless switched to vmalloc...
951          */
952         chunk = 2048;
953         if (test_bit(TTY_NO_WRITE_SPLIT, &tty->flags))
954                 chunk = 65536;
955         if (count < chunk)
956                 chunk = count;
957
958         /* write_buf/write_cnt is protected by the atomic_write_lock mutex */
959         if (tty->write_cnt < chunk) {
960                 unsigned char *buf_chunk;
961
962                 if (chunk < 1024)
963                         chunk = 1024;
964
965                 buf_chunk = kmalloc(chunk, GFP_KERNEL);
966                 if (!buf_chunk) {
967                         ret = -ENOMEM;
968                         goto out;
969                 }
970                 kfree(tty->write_buf);
971                 tty->write_cnt = chunk;
972                 tty->write_buf = buf_chunk;
973         }
974
975         /* Do the write .. */
976         for (;;) {
977                 size_t size = count;
978                 if (size > chunk)
979                         size = chunk;
980                 ret = -EFAULT;
981                 if (copy_from_user(tty->write_buf, buf, size))
982                         break;
983                 ret = write(tty, file, tty->write_buf, size);
984                 if (ret <= 0)
985                         break;
986                 written += ret;
987                 buf += ret;
988                 count -= ret;
989                 if (!count)
990                         break;
991                 ret = -ERESTARTSYS;
992                 if (signal_pending(current))
993                         break;
994                 cond_resched();
995         }
996         if (written) {
997                 struct inode *inode = file->f_path.dentry->d_inode;
998                 inode->i_mtime = current_fs_time(inode->i_sb);
999                 ret = written;
1000         }
1001 out:
1002         tty_write_unlock(tty);
1003         return ret;
1004 }
1005
1006 /**
1007  * tty_write_message - write a message to a certain tty, not just the console.
1008  * @tty: the destination tty_struct
1009  * @msg: the message to write
1010  *
1011  * This is used for messages that need to be redirected to a specific tty.
1012  * We don't put it into the syslog queue right now maybe in the future if
1013  * really needed.
1014  *
1015  * We must still hold the BKL and test the CLOSING flag for the moment.
1016  */
1017
1018 void tty_write_message(struct tty_struct *tty, char *msg)
1019 {
1020         lock_kernel();
1021         if (tty) {
1022                 mutex_lock(&tty->atomic_write_lock);
1023                 if (tty->ops->write && !test_bit(TTY_CLOSING, &tty->flags))
1024                         tty->ops->write(tty, msg, strlen(msg));
1025                 tty_write_unlock(tty);
1026         }
1027         unlock_kernel();
1028         return;
1029 }
1030
1031
1032 /**
1033  *      tty_write               -       write method for tty device file
1034  *      @file: tty file pointer
1035  *      @buf: user data to write
1036  *      @count: bytes to write
1037  *      @ppos: unused
1038  *
1039  *      Write data to a tty device via the line discipline.
1040  *
1041  *      Locking:
1042  *              Locks the line discipline as required
1043  *              Writes to the tty driver are serialized by the atomic_write_lock
1044  *      and are then processed in chunks to the device. The line discipline
1045  *      write method will not be invoked in parallel for each device.
1046  */
1047
1048 static ssize_t tty_write(struct file *file, const char __user *buf,
1049                                                 size_t count, loff_t *ppos)
1050 {
1051         struct tty_struct *tty;
1052         struct inode *inode = file->f_path.dentry->d_inode;
1053         ssize_t ret;
1054         struct tty_ldisc *ld;
1055
1056         tty = (struct tty_struct *)file->private_data;
1057         if (tty_paranoia_check(tty, inode, "tty_write"))
1058                 return -EIO;
1059         if (!tty || !tty->ops->write ||
1060                 (test_bit(TTY_IO_ERROR, &tty->flags)))
1061                         return -EIO;
1062         /* Short term debug to catch buggy drivers */
1063         if (tty->ops->write_room == NULL)
1064                 printk(KERN_ERR "tty driver %s lacks a write_room method.\n",
1065                         tty->driver->name);
1066         ld = tty_ldisc_ref_wait(tty);
1067         if (!ld->ops->write)
1068                 ret = -EIO;
1069         else
1070                 ret = do_tty_write(ld->ops->write, tty, file, buf, count);
1071         tty_ldisc_deref(ld);
1072         return ret;
1073 }
1074
1075 ssize_t redirected_tty_write(struct file *file, const char __user *buf,
1076                                                 size_t count, loff_t *ppos)
1077 {
1078         struct file *p = NULL;
1079
1080         spin_lock(&redirect_lock);
1081         if (redirect) {
1082                 get_file(redirect);
1083                 p = redirect;
1084         }
1085         spin_unlock(&redirect_lock);
1086
1087         if (p) {
1088                 ssize_t res;
1089                 res = vfs_write(p, buf, count, &p->f_pos);
1090                 fput(p);
1091                 return res;
1092         }
1093         return tty_write(file, buf, count, ppos);
1094 }
1095
1096 static char ptychar[] = "pqrstuvwxyzabcde";
1097
1098 /**
1099  *      pty_line_name   -       generate name for a pty
1100  *      @driver: the tty driver in use
1101  *      @index: the minor number
1102  *      @p: output buffer of at least 6 bytes
1103  *
1104  *      Generate a name from a driver reference and write it to the output
1105  *      buffer.
1106  *
1107  *      Locking: None
1108  */
1109 static void pty_line_name(struct tty_driver *driver, int index, char *p)
1110 {
1111         int i = index + driver->name_base;
1112         /* ->name is initialized to "ttyp", but "tty" is expected */
1113         sprintf(p, "%s%c%x",
1114                 driver->subtype == PTY_TYPE_SLAVE ? "tty" : driver->name,
1115                 ptychar[i >> 4 & 0xf], i & 0xf);
1116 }
1117
1118 /**
1119  *      tty_line_name   -       generate name for a tty
1120  *      @driver: the tty driver in use
1121  *      @index: the minor number
1122  *      @p: output buffer of at least 7 bytes
1123  *
1124  *      Generate a name from a driver reference and write it to the output
1125  *      buffer.
1126  *
1127  *      Locking: None
1128  */
1129 static void tty_line_name(struct tty_driver *driver, int index, char *p)
1130 {
1131         sprintf(p, "%s%d", driver->name, index + driver->name_base);
1132 }
1133
1134 /**
1135  *      tty_driver_lookup_tty() - find an existing tty, if any
1136  *      @driver: the driver for the tty
1137  *      @idx:    the minor number
1138  *
1139  *      Return the tty, if found or ERR_PTR() otherwise.
1140  *
1141  *      Locking: tty_mutex must be held. If tty is found, the mutex must
1142  *      be held until the 'fast-open' is also done. Will change once we
1143  *      have refcounting in the driver and per driver locking
1144  */
1145 static struct tty_struct *tty_driver_lookup_tty(struct tty_driver *driver,
1146                 struct inode *inode, int idx)
1147 {
1148         struct tty_struct *tty;
1149
1150         if (driver->ops->lookup)
1151                 return driver->ops->lookup(driver, inode, idx);
1152
1153         tty = driver->ttys[idx];
1154         return tty;
1155 }
1156
1157 /**
1158  *      tty_init_termios        -  helper for termios setup
1159  *      @tty: the tty to set up
1160  *
1161  *      Initialise the termios structures for this tty. Thus runs under
1162  *      the tty_mutex currently so we can be relaxed about ordering.
1163  */
1164
1165 int tty_init_termios(struct tty_struct *tty)
1166 {
1167         struct ktermios *tp;
1168         int idx = tty->index;
1169
1170         tp = tty->driver->termios[idx];
1171         if (tp == NULL) {
1172                 tp = kzalloc(sizeof(struct ktermios[2]), GFP_KERNEL);
1173                 if (tp == NULL)
1174                         return -ENOMEM;
1175                 memcpy(tp, &tty->driver->init_termios,
1176                                                 sizeof(struct ktermios));
1177                 tty->driver->termios[idx] = tp;
1178         }
1179         tty->termios = tp;
1180         tty->termios_locked = tp + 1;
1181
1182         /* Compatibility until drivers always set this */
1183         tty->termios->c_ispeed = tty_termios_input_baud_rate(tty->termios);
1184         tty->termios->c_ospeed = tty_termios_baud_rate(tty->termios);
1185         return 0;
1186 }
1187 EXPORT_SYMBOL_GPL(tty_init_termios);
1188
1189 /**
1190  *      tty_driver_install_tty() - install a tty entry in the driver
1191  *      @driver: the driver for the tty
1192  *      @tty: the tty
1193  *
1194  *      Install a tty object into the driver tables. The tty->index field
1195  *      will be set by the time this is called. This method is responsible
1196  *      for ensuring any need additional structures are allocated and
1197  *      configured.
1198  *
1199  *      Locking: tty_mutex for now
1200  */
1201 static int tty_driver_install_tty(struct tty_driver *driver,
1202                                                 struct tty_struct *tty)
1203 {
1204         int idx = tty->index;
1205
1206         if (driver->ops->install)
1207                 return driver->ops->install(driver, tty);
1208
1209         if (tty_init_termios(tty) == 0) {
1210                 tty_driver_kref_get(driver);
1211                 tty->count++;
1212                 driver->ttys[idx] = tty;
1213                 return 0;
1214         }
1215         return -ENOMEM;
1216 }
1217
1218 /**
1219  *      tty_driver_remove_tty() - remove a tty from the driver tables
1220  *      @driver: the driver for the tty
1221  *      @idx:    the minor number
1222  *
1223  *      Remvoe a tty object from the driver tables. The tty->index field
1224  *      will be set by the time this is called.
1225  *
1226  *      Locking: tty_mutex for now
1227  */
1228 static void tty_driver_remove_tty(struct tty_driver *driver,
1229                                                 struct tty_struct *tty)
1230 {
1231         if (driver->ops->remove)
1232                 driver->ops->remove(driver, tty);
1233         else
1234                 driver->ttys[tty->index] = NULL;
1235 }
1236
1237 /*
1238  *      tty_reopen()    - fast re-open of an open tty
1239  *      @tty    - the tty to open
1240  *
1241  *      Return 0 on success, -errno on error.
1242  *
1243  *      Locking: tty_mutex must be held from the time the tty was found
1244  *               till this open completes.
1245  */
1246 static int tty_reopen(struct tty_struct *tty)
1247 {
1248         struct tty_driver *driver = tty->driver;
1249
1250         if (test_bit(TTY_CLOSING, &tty->flags))
1251                 return -EIO;
1252
1253         if (driver->type == TTY_DRIVER_TYPE_PTY &&
1254             driver->subtype == PTY_TYPE_MASTER) {
1255                 /*
1256                  * special case for PTY masters: only one open permitted,
1257                  * and the slave side open count is incremented as well.
1258                  */
1259                 if (tty->count)
1260                         return -EIO;
1261
1262                 tty->link->count++;
1263         }
1264         tty->count++;
1265         tty->driver = driver; /* N.B. why do this every time?? */
1266
1267         mutex_lock(&tty->ldisc_mutex);
1268         WARN_ON(!test_bit(TTY_LDISC, &tty->flags));
1269         mutex_unlock(&tty->ldisc_mutex);
1270
1271         return 0;
1272 }
1273
1274 /**
1275  *      tty_init_dev            -       initialise a tty device
1276  *      @driver: tty driver we are opening a device on
1277  *      @idx: device index
1278  *      @ret_tty: returned tty structure
1279  *      @first_ok: ok to open a new device (used by ptmx)
1280  *
1281  *      Prepare a tty device. This may not be a "new" clean device but
1282  *      could also be an active device. The pty drivers require special
1283  *      handling because of this.
1284  *
1285  *      Locking:
1286  *              The function is called under the tty_mutex, which
1287  *      protects us from the tty struct or driver itself going away.
1288  *
1289  *      On exit the tty device has the line discipline attached and
1290  *      a reference count of 1. If a pair was created for pty/tty use
1291  *      and the other was a pty master then it too has a reference count of 1.
1292  *
1293  * WSH 06/09/97: Rewritten to remove races and properly clean up after a
1294  * failed open.  The new code protects the open with a mutex, so it's
1295  * really quite straightforward.  The mutex locking can probably be
1296  * relaxed for the (most common) case of reopening a tty.
1297  */
1298
1299 struct tty_struct *tty_init_dev(struct tty_driver *driver, int idx,
1300                                                                 int first_ok)
1301 {
1302         struct tty_struct *tty;
1303         int retval;
1304
1305         /* Check if pty master is being opened multiple times */
1306         if (driver->subtype == PTY_TYPE_MASTER &&
1307                 (driver->flags & TTY_DRIVER_DEVPTS_MEM) && !first_ok)
1308                 return ERR_PTR(-EIO);
1309
1310         /*
1311          * First time open is complex, especially for PTY devices.
1312          * This code guarantees that either everything succeeds and the
1313          * TTY is ready for operation, or else the table slots are vacated
1314          * and the allocated memory released.  (Except that the termios
1315          * and locked termios may be retained.)
1316          */
1317
1318         if (!try_module_get(driver->owner))
1319                 return ERR_PTR(-ENODEV);
1320
1321         tty = alloc_tty_struct();
1322         if (!tty)
1323                 goto fail_no_mem;
1324         initialize_tty_struct(tty, driver, idx);
1325
1326         retval = tty_driver_install_tty(driver, tty);
1327         if (retval < 0) {
1328                 free_tty_struct(tty);
1329                 module_put(driver->owner);
1330                 return ERR_PTR(retval);
1331         }
1332
1333         /*
1334          * Structures all installed ... call the ldisc open routines.
1335          * If we fail here just call release_tty to clean up.  No need
1336          * to decrement the use counts, as release_tty doesn't care.
1337          */
1338
1339         retval = tty_ldisc_setup(tty, tty->link);
1340         if (retval)
1341                 goto release_mem_out;
1342         return tty;
1343
1344 fail_no_mem:
1345         module_put(driver->owner);
1346         return ERR_PTR(-ENOMEM);
1347
1348         /* call the tty release_tty routine to clean out this slot */
1349 release_mem_out:
1350         if (printk_ratelimit())
1351                 printk(KERN_INFO "tty_init_dev: ldisc open failed, "
1352                                  "clearing slot %d\n", idx);
1353         release_tty(tty, idx);
1354         return ERR_PTR(retval);
1355 }
1356
1357 void tty_free_termios(struct tty_struct *tty)
1358 {
1359         struct ktermios *tp;
1360         int idx = tty->index;
1361         /* Kill this flag and push into drivers for locking etc */
1362         if (tty->driver->flags & TTY_DRIVER_RESET_TERMIOS) {
1363                 /* FIXME: Locking on ->termios array */
1364                 tp = tty->termios;
1365                 tty->driver->termios[idx] = NULL;
1366                 kfree(tp);
1367         }
1368 }
1369 EXPORT_SYMBOL(tty_free_termios);
1370
1371 void tty_shutdown(struct tty_struct *tty)
1372 {
1373         tty_driver_remove_tty(tty->driver, tty);
1374         tty_free_termios(tty);
1375 }
1376 EXPORT_SYMBOL(tty_shutdown);
1377
1378 /**
1379  *      release_one_tty         -       release tty structure memory
1380  *      @kref: kref of tty we are obliterating
1381  *
1382  *      Releases memory associated with a tty structure, and clears out the
1383  *      driver table slots. This function is called when a device is no longer
1384  *      in use. It also gets called when setup of a device fails.
1385  *
1386  *      Locking:
1387  *              tty_mutex - sometimes only
1388  *              takes the file list lock internally when working on the list
1389  *      of ttys that the driver keeps.
1390  *
1391  *      This method gets called from a work queue so that the driver private
1392  *      cleanup ops can sleep (needed for USB at least)
1393  */
1394 static void release_one_tty(struct work_struct *work)
1395 {
1396         struct tty_struct *tty =
1397                 container_of(work, struct tty_struct, hangup_work);
1398         struct tty_driver *driver = tty->driver;
1399
1400         if (tty->ops->cleanup)
1401                 tty->ops->cleanup(tty);
1402
1403         tty->magic = 0;
1404         tty_driver_kref_put(driver);
1405         module_put(driver->owner);
1406
1407         file_list_lock();
1408         list_del_init(&tty->tty_files);
1409         file_list_unlock();
1410
1411         free_tty_struct(tty);
1412 }
1413
1414 static void queue_release_one_tty(struct kref *kref)
1415 {
1416         struct tty_struct *tty = container_of(kref, struct tty_struct, kref);
1417
1418         if (tty->ops->shutdown)
1419                 tty->ops->shutdown(tty);
1420         else
1421                 tty_shutdown(tty);
1422
1423         /* The hangup queue is now free so we can reuse it rather than
1424            waste a chunk of memory for each port */
1425         INIT_WORK(&tty->hangup_work, release_one_tty);
1426         schedule_work(&tty->hangup_work);
1427 }
1428
1429 /**
1430  *      tty_kref_put            -       release a tty kref
1431  *      @tty: tty device
1432  *
1433  *      Release a reference to a tty device and if need be let the kref
1434  *      layer destruct the object for us
1435  */
1436
1437 void tty_kref_put(struct tty_struct *tty)
1438 {
1439         if (tty)
1440                 kref_put(&tty->kref, queue_release_one_tty);
1441 }
1442 EXPORT_SYMBOL(tty_kref_put);
1443
1444 /**
1445  *      release_tty             -       release tty structure memory
1446  *
1447  *      Release both @tty and a possible linked partner (think pty pair),
1448  *      and decrement the refcount of the backing module.
1449  *
1450  *      Locking:
1451  *              tty_mutex - sometimes only
1452  *              takes the file list lock internally when working on the list
1453  *      of ttys that the driver keeps.
1454  *              FIXME: should we require tty_mutex is held here ??
1455  *
1456  */
1457 static void release_tty(struct tty_struct *tty, int idx)
1458 {
1459         /* This should always be true but check for the moment */
1460         WARN_ON(tty->index != idx);
1461
1462         if (tty->link)
1463                 tty_kref_put(tty->link);
1464         tty_kref_put(tty);
1465 }
1466
1467 /*
1468  * Even releasing the tty structures is a tricky business.. We have
1469  * to be very careful that the structures are all released at the
1470  * same time, as interrupts might otherwise get the wrong pointers.
1471  *
1472  * WSH 09/09/97: rewritten to avoid some nasty race conditions that could
1473  * lead to double frees or releasing memory still in use.
1474  */
1475 void tty_release_dev(struct file *filp)
1476 {
1477         struct tty_struct *tty, *o_tty;
1478         int     pty_master, tty_closing, o_tty_closing, do_sleep;
1479         int     devpts;
1480         int     idx;
1481         char    buf[64];
1482         struct  inode *inode;
1483
1484         inode = filp->f_path.dentry->d_inode;
1485         tty = (struct tty_struct *)filp->private_data;
1486         if (tty_paranoia_check(tty, inode, "tty_release_dev"))
1487                 return;
1488
1489         check_tty_count(tty, "tty_release_dev");
1490
1491         tty_fasync(-1, filp, 0);
1492
1493         idx = tty->index;
1494         pty_master = (tty->driver->type == TTY_DRIVER_TYPE_PTY &&
1495                       tty->driver->subtype == PTY_TYPE_MASTER);
1496         devpts = (tty->driver->flags & TTY_DRIVER_DEVPTS_MEM) != 0;
1497         o_tty = tty->link;
1498
1499 #ifdef TTY_PARANOIA_CHECK
1500         if (idx < 0 || idx >= tty->driver->num) {
1501                 printk(KERN_DEBUG "tty_release_dev: bad idx when trying to "
1502                                   "free (%s)\n", tty->name);
1503                 return;
1504         }
1505         if (!devpts) {
1506                 if (tty != tty->driver->ttys[idx]) {
1507                         printk(KERN_DEBUG "tty_release_dev: driver.table[%d] not tty "
1508                                "for (%s)\n", idx, tty->name);
1509                         return;
1510                 }
1511                 if (tty->termios != tty->driver->termios[idx]) {
1512                         printk(KERN_DEBUG "tty_release_dev: driver.termios[%d] not termios "
1513                                "for (%s)\n",
1514                                idx, tty->name);
1515                         return;
1516                 }
1517         }
1518 #endif
1519
1520 #ifdef TTY_DEBUG_HANGUP
1521         printk(KERN_DEBUG "tty_release_dev of %s (tty count=%d)...",
1522                tty_name(tty, buf), tty->count);
1523 #endif
1524
1525 #ifdef TTY_PARANOIA_CHECK
1526         if (tty->driver->other &&
1527              !(tty->driver->flags & TTY_DRIVER_DEVPTS_MEM)) {
1528                 if (o_tty != tty->driver->other->ttys[idx]) {
1529                         printk(KERN_DEBUG "tty_release_dev: other->table[%d] "
1530                                           "not o_tty for (%s)\n",
1531                                idx, tty->name);
1532                         return;
1533                 }
1534                 if (o_tty->termios != tty->driver->other->termios[idx]) {
1535                         printk(KERN_DEBUG "tty_release_dev: other->termios[%d] "
1536                                           "not o_termios for (%s)\n",
1537                                idx, tty->name);
1538                         return;
1539                 }
1540                 if (o_tty->link != tty) {
1541                         printk(KERN_DEBUG "tty_release_dev: bad pty pointers\n");
1542                         return;
1543                 }
1544         }
1545 #endif
1546         if (tty->ops->close)
1547                 tty->ops->close(tty, filp);
1548
1549         /*
1550          * Sanity check: if tty->count is going to zero, there shouldn't be
1551          * any waiters on tty->read_wait or tty->write_wait.  We test the
1552          * wait queues and kick everyone out _before_ actually starting to
1553          * close.  This ensures that we won't block while releasing the tty
1554          * structure.
1555          *
1556          * The test for the o_tty closing is necessary, since the master and
1557          * slave sides may close in any order.  If the slave side closes out
1558          * first, its count will be one, since the master side holds an open.
1559          * Thus this test wouldn't be triggered at the time the slave closes,
1560          * so we do it now.
1561          *
1562          * Note that it's possible for the tty to be opened again while we're
1563          * flushing out waiters.  By recalculating the closing flags before
1564          * each iteration we avoid any problems.
1565          */
1566         while (1) {
1567                 /* Guard against races with tty->count changes elsewhere and
1568                    opens on /dev/tty */
1569
1570                 mutex_lock(&tty_mutex);
1571                 tty_closing = tty->count <= 1;
1572                 o_tty_closing = o_tty &&
1573                         (o_tty->count <= (pty_master ? 1 : 0));
1574                 do_sleep = 0;
1575
1576                 if (tty_closing) {
1577                         if (waitqueue_active(&tty->read_wait)) {
1578                                 wake_up_poll(&tty->read_wait, POLLIN);
1579                                 do_sleep++;
1580                         }
1581                         if (waitqueue_active(&tty->write_wait)) {
1582                                 wake_up_poll(&tty->write_wait, POLLOUT);
1583                                 do_sleep++;
1584                         }
1585                 }
1586                 if (o_tty_closing) {
1587                         if (waitqueue_active(&o_tty->read_wait)) {
1588                                 wake_up_poll(&o_tty->read_wait, POLLIN);
1589                                 do_sleep++;
1590                         }
1591                         if (waitqueue_active(&o_tty->write_wait)) {
1592                                 wake_up_poll(&o_tty->write_wait, POLLOUT);
1593                                 do_sleep++;
1594                         }
1595                 }
1596                 if (!do_sleep)
1597                         break;
1598
1599                 printk(KERN_WARNING "tty_release_dev: %s: read/write wait queue "
1600                                     "active!\n", tty_name(tty, buf));
1601                 mutex_unlock(&tty_mutex);
1602                 schedule();
1603         }
1604
1605         /*
1606          * The closing flags are now consistent with the open counts on
1607          * both sides, and we've completed the last operation that could
1608          * block, so it's safe to proceed with closing.
1609          */
1610         if (pty_master) {
1611                 if (--o_tty->count < 0) {
1612                         printk(KERN_WARNING "tty_release_dev: bad pty slave count "
1613                                             "(%d) for %s\n",
1614                                o_tty->count, tty_name(o_tty, buf));
1615                         o_tty->count = 0;
1616                 }
1617         }
1618         if (--tty->count < 0) {
1619                 printk(KERN_WARNING "tty_release_dev: bad tty->count (%d) for %s\n",
1620                        tty->count, tty_name(tty, buf));
1621                 tty->count = 0;
1622         }
1623
1624         /*
1625          * We've decremented tty->count, so we need to remove this file
1626          * descriptor off the tty->tty_files list; this serves two
1627          * purposes:
1628          *  - check_tty_count sees the correct number of file descriptors
1629          *    associated with this tty.
1630          *  - do_tty_hangup no longer sees this file descriptor as
1631          *    something that needs to be handled for hangups.
1632          */
1633         file_kill(filp);
1634         filp->private_data = NULL;
1635
1636         /*
1637          * Perform some housekeeping before deciding whether to return.
1638          *
1639          * Set the TTY_CLOSING flag if this was the last open.  In the
1640          * case of a pty we may have to wait around for the other side
1641          * to close, and TTY_CLOSING makes sure we can't be reopened.
1642          */
1643         if (tty_closing)
1644                 set_bit(TTY_CLOSING, &tty->flags);
1645         if (o_tty_closing)
1646                 set_bit(TTY_CLOSING, &o_tty->flags);
1647
1648         /*
1649          * If _either_ side is closing, make sure there aren't any
1650          * processes that still think tty or o_tty is their controlling
1651          * tty.
1652          */
1653         if (tty_closing || o_tty_closing) {
1654                 read_lock(&tasklist_lock);
1655                 session_clear_tty(tty->session);
1656                 if (o_tty)
1657                         session_clear_tty(o_tty->session);
1658                 read_unlock(&tasklist_lock);
1659         }
1660
1661         mutex_unlock(&tty_mutex);
1662
1663         /* check whether both sides are closing ... */
1664         if (!tty_closing || (o_tty && !o_tty_closing))
1665                 return;
1666
1667 #ifdef TTY_DEBUG_HANGUP
1668         printk(KERN_DEBUG "freeing tty structure...");
1669 #endif
1670         /*
1671          * Ask the line discipline code to release its structures
1672          */
1673         tty_ldisc_release(tty, o_tty);
1674         /*
1675          * The release_tty function takes care of the details of clearing
1676          * the slots and preserving the termios structure.
1677          */
1678         release_tty(tty, idx);
1679
1680         /* Make this pty number available for reallocation */
1681         if (devpts)
1682                 devpts_kill_index(inode, idx);
1683 }
1684
1685 /**
1686  *      __tty_open              -       open a tty device
1687  *      @inode: inode of device file
1688  *      @filp: file pointer to tty
1689  *
1690  *      tty_open and tty_release keep up the tty count that contains the
1691  *      number of opens done on a tty. We cannot use the inode-count, as
1692  *      different inodes might point to the same tty.
1693  *
1694  *      Open-counting is needed for pty masters, as well as for keeping
1695  *      track of serial lines: DTR is dropped when the last close happens.
1696  *      (This is not done solely through tty->count, now.  - Ted 1/27/92)
1697  *
1698  *      The termios state of a pty is reset on first open so that
1699  *      settings don't persist across reuse.
1700  *
1701  *      Locking: tty_mutex protects tty, get_tty_driver and tty_init_dev work.
1702  *               tty->count should protect the rest.
1703  *               ->siglock protects ->signal/->sighand
1704  */
1705
1706 static int __tty_open(struct inode *inode, struct file *filp)
1707 {
1708         struct tty_struct *tty = NULL;
1709         int noctty, retval;
1710         struct tty_driver *driver;
1711         int index;
1712         dev_t device = inode->i_rdev;
1713         unsigned saved_flags = filp->f_flags;
1714
1715         nonseekable_open(inode, filp);
1716
1717 retry_open:
1718         noctty = filp->f_flags & O_NOCTTY;
1719         index  = -1;
1720         retval = 0;
1721
1722         mutex_lock(&tty_mutex);
1723
1724         if (device == MKDEV(TTYAUX_MAJOR, 0)) {
1725                 tty = get_current_tty();
1726                 if (!tty) {
1727                         mutex_unlock(&tty_mutex);
1728                         return -ENXIO;
1729                 }
1730                 driver = tty_driver_kref_get(tty->driver);
1731                 index = tty->index;
1732                 filp->f_flags |= O_NONBLOCK; /* Don't let /dev/tty block */
1733                 /* noctty = 1; */
1734                 /* FIXME: Should we take a driver reference ? */
1735                 tty_kref_put(tty);
1736                 goto got_driver;
1737         }
1738 #ifdef CONFIG_VT
1739         if (device == MKDEV(TTY_MAJOR, 0)) {
1740                 extern struct tty_driver *console_driver;
1741                 driver = tty_driver_kref_get(console_driver);
1742                 index = fg_console;
1743                 noctty = 1;
1744                 goto got_driver;
1745         }
1746 #endif
1747         if (device == MKDEV(TTYAUX_MAJOR, 1)) {
1748                 struct tty_driver *console_driver = console_device(&index);
1749                 if (console_driver) {
1750                         driver = tty_driver_kref_get(console_driver);
1751                         if (driver) {
1752                                 /* Don't let /dev/console block */
1753                                 filp->f_flags |= O_NONBLOCK;
1754                                 noctty = 1;
1755                                 goto got_driver;
1756                         }
1757                 }
1758                 mutex_unlock(&tty_mutex);
1759                 return -ENODEV;
1760         }
1761
1762         driver = get_tty_driver(device, &index);
1763         if (!driver) {
1764                 mutex_unlock(&tty_mutex);
1765                 return -ENODEV;
1766         }
1767 got_driver:
1768         if (!tty) {
1769                 /* check whether we're reopening an existing tty */
1770                 tty = tty_driver_lookup_tty(driver, inode, index);
1771
1772                 if (IS_ERR(tty)) {
1773                         mutex_unlock(&tty_mutex);
1774                         return PTR_ERR(tty);
1775                 }
1776         }
1777
1778         if (tty) {
1779                 retval = tty_reopen(tty);
1780                 if (retval)
1781                         tty = ERR_PTR(retval);
1782         } else
1783                 tty = tty_init_dev(driver, index, 0);
1784
1785         mutex_unlock(&tty_mutex);
1786         tty_driver_kref_put(driver);
1787         if (IS_ERR(tty))
1788                 return PTR_ERR(tty);
1789
1790         filp->private_data = tty;
1791         file_move(filp, &tty->tty_files);
1792         check_tty_count(tty, "tty_open");
1793         if (tty->driver->type == TTY_DRIVER_TYPE_PTY &&
1794             tty->driver->subtype == PTY_TYPE_MASTER)
1795                 noctty = 1;
1796 #ifdef TTY_DEBUG_HANGUP
1797         printk(KERN_DEBUG "opening %s...", tty->name);
1798 #endif
1799         if (!retval) {
1800                 if (tty->ops->open)
1801                         retval = tty->ops->open(tty, filp);
1802                 else
1803                         retval = -ENODEV;
1804         }
1805         filp->f_flags = saved_flags;
1806
1807         if (!retval && test_bit(TTY_EXCLUSIVE, &tty->flags) &&
1808                                                 !capable(CAP_SYS_ADMIN))
1809                 retval = -EBUSY;
1810
1811         if (retval) {
1812 #ifdef TTY_DEBUG_HANGUP
1813                 printk(KERN_DEBUG "error %d in opening %s...", retval,
1814                        tty->name);
1815 #endif
1816                 tty_release_dev(filp);
1817                 if (retval != -ERESTARTSYS)
1818                         return retval;
1819                 if (signal_pending(current))
1820                         return retval;
1821                 schedule();
1822                 /*
1823                  * Need to reset f_op in case a hangup happened.
1824                  */
1825                 if (filp->f_op == &hung_up_tty_fops)
1826                         filp->f_op = &tty_fops;
1827                 goto retry_open;
1828         }
1829
1830         mutex_lock(&tty_mutex);
1831         spin_lock_irq(&current->sighand->siglock);
1832         if (!noctty &&
1833             current->signal->leader &&
1834             !current->signal->tty &&
1835             tty->session == NULL)
1836                 __proc_set_tty(current, tty);
1837         spin_unlock_irq(&current->sighand->siglock);
1838         mutex_unlock(&tty_mutex);
1839         return 0;
1840 }
1841
1842 /* BKL pushdown: scary code avoidance wrapper */
1843 static int tty_open(struct inode *inode, struct file *filp)
1844 {
1845         int ret;
1846
1847         lock_kernel();
1848         ret = __tty_open(inode, filp);
1849         unlock_kernel();
1850         return ret;
1851 }
1852
1853
1854
1855
1856 /**
1857  *      tty_release             -       vfs callback for close
1858  *      @inode: inode of tty
1859  *      @filp: file pointer for handle to tty
1860  *
1861  *      Called the last time each file handle is closed that references
1862  *      this tty. There may however be several such references.
1863  *
1864  *      Locking:
1865  *              Takes bkl. See tty_release_dev
1866  */
1867
1868 static int tty_release(struct inode *inode, struct file *filp)
1869 {
1870         lock_kernel();
1871         tty_release_dev(filp);
1872         unlock_kernel();
1873         return 0;
1874 }
1875
1876 /**
1877  *      tty_poll        -       check tty status
1878  *      @filp: file being polled
1879  *      @wait: poll wait structures to update
1880  *
1881  *      Call the line discipline polling method to obtain the poll
1882  *      status of the device.
1883  *
1884  *      Locking: locks called line discipline but ldisc poll method
1885  *      may be re-entered freely by other callers.
1886  */
1887
1888 static unsigned int tty_poll(struct file *filp, poll_table *wait)
1889 {
1890         struct tty_struct *tty;
1891         struct tty_ldisc *ld;
1892         int ret = 0;
1893
1894         tty = (struct tty_struct *)filp->private_data;
1895         if (tty_paranoia_check(tty, filp->f_path.dentry->d_inode, "tty_poll"))
1896                 return 0;
1897
1898         ld = tty_ldisc_ref_wait(tty);
1899         if (ld->ops->poll)
1900                 ret = (ld->ops->poll)(tty, filp, wait);
1901         tty_ldisc_deref(ld);
1902         return ret;
1903 }
1904
1905 static int tty_fasync(int fd, struct file *filp, int on)
1906 {
1907         struct tty_struct *tty;
1908         unsigned long flags;
1909         int retval = 0;
1910
1911         lock_kernel();
1912         tty = (struct tty_struct *)filp->private_data;
1913         if (tty_paranoia_check(tty, filp->f_path.dentry->d_inode, "tty_fasync"))
1914                 goto out;
1915
1916         retval = fasync_helper(fd, filp, on, &tty->fasync);
1917         if (retval <= 0)
1918                 goto out;
1919
1920         if (on) {
1921                 enum pid_type type;
1922                 struct pid *pid;
1923                 if (!waitqueue_active(&tty->read_wait))
1924                         tty->minimum_to_wake = 1;
1925                 spin_lock_irqsave(&tty->ctrl_lock, flags);
1926                 if (tty->pgrp) {
1927                         pid = tty->pgrp;
1928                         type = PIDTYPE_PGID;
1929                 } else {
1930                         pid = task_pid(current);
1931                         type = PIDTYPE_PID;
1932                 }
1933                 get_pid(pid);
1934                 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
1935                 retval = __f_setown(filp, pid, type, 0);
1936                 put_pid(pid);
1937                 if (retval)
1938                         goto out;
1939         } else {
1940                 if (!tty->fasync && !waitqueue_active(&tty->read_wait))
1941                         tty->minimum_to_wake = N_TTY_BUF_SIZE;
1942         }
1943         retval = 0;
1944 out:
1945         unlock_kernel();
1946         return retval;
1947 }
1948
1949 /**
1950  *      tiocsti                 -       fake input character
1951  *      @tty: tty to fake input into
1952  *      @p: pointer to character
1953  *
1954  *      Fake input to a tty device. Does the necessary locking and
1955  *      input management.
1956  *
1957  *      FIXME: does not honour flow control ??
1958  *
1959  *      Locking:
1960  *              Called functions take tty_ldisc_lock
1961  *              current->signal->tty check is safe without locks
1962  *
1963  *      FIXME: may race normal receive processing
1964  */
1965
1966 static int tiocsti(struct tty_struct *tty, char __user *p)
1967 {
1968         char ch, mbz = 0;
1969         struct tty_ldisc *ld;
1970
1971         if ((current->signal->tty != tty) && !capable(CAP_SYS_ADMIN))
1972                 return -EPERM;
1973         if (get_user(ch, p))
1974                 return -EFAULT;
1975         tty_audit_tiocsti(tty, ch);
1976         ld = tty_ldisc_ref_wait(tty);
1977         ld->ops->receive_buf(tty, &ch, &mbz, 1);
1978         tty_ldisc_deref(ld);
1979         return 0;
1980 }
1981
1982 /**
1983  *      tiocgwinsz              -       implement window query ioctl
1984  *      @tty; tty
1985  *      @arg: user buffer for result
1986  *
1987  *      Copies the kernel idea of the window size into the user buffer.
1988  *
1989  *      Locking: tty->termios_mutex is taken to ensure the winsize data
1990  *              is consistent.
1991  */
1992
1993 static int tiocgwinsz(struct tty_struct *tty, struct winsize __user *arg)
1994 {
1995         int err;
1996
1997         mutex_lock(&tty->termios_mutex);
1998         err = copy_to_user(arg, &tty->winsize, sizeof(*arg));
1999         mutex_unlock(&tty->termios_mutex);
2000
2001         return err ? -EFAULT: 0;
2002 }
2003
2004 /**
2005  *      tty_do_resize           -       resize event
2006  *      @tty: tty being resized
2007  *      @rows: rows (character)
2008  *      @cols: cols (character)
2009  *
2010  *      Update the termios variables and send the neccessary signals to
2011  *      peform a terminal resize correctly
2012  */
2013
2014 int tty_do_resize(struct tty_struct *tty, struct winsize *ws)
2015 {
2016         struct pid *pgrp;
2017         unsigned long flags;
2018
2019         /* Lock the tty */
2020         mutex_lock(&tty->termios_mutex);
2021         if (!memcmp(ws, &tty->winsize, sizeof(*ws)))
2022                 goto done;
2023         /* Get the PID values and reference them so we can
2024            avoid holding the tty ctrl lock while sending signals */
2025         spin_lock_irqsave(&tty->ctrl_lock, flags);
2026         pgrp = get_pid(tty->pgrp);
2027         spin_unlock_irqrestore(&tty->ctrl_lock, flags);
2028
2029         if (pgrp)
2030                 kill_pgrp(pgrp, SIGWINCH, 1);
2031         put_pid(pgrp);
2032
2033         tty->winsize = *ws;
2034 done:
2035         mutex_unlock(&tty->termios_mutex);
2036         return 0;
2037 }
2038
2039 /**
2040  *      tiocswinsz              -       implement window size set ioctl
2041  *      @tty; tty side of tty
2042  *      @arg: user buffer for result
2043  *
2044  *      Copies the user idea of the window size to the kernel. Traditionally
2045  *      this is just advisory information but for the Linux console it
2046  *      actually has driver level meaning and triggers a VC resize.
2047  *
2048  *      Locking:
2049  *              Driver dependant. The default do_resize method takes the
2050  *      tty termios mutex and ctrl_lock. The console takes its own lock
2051  *      then calls into the default method.
2052  */
2053
2054 static int tiocswinsz(struct tty_struct *tty, struct winsize __user *arg)
2055 {
2056         struct winsize tmp_ws;
2057         if (copy_from_user(&tmp_ws, arg, sizeof(*arg)))
2058                 return -EFAULT;
2059
2060         if (tty->ops->resize)
2061                 return tty->ops->resize(tty, &tmp_ws);
2062         else
2063                 return tty_do_resize(tty, &tmp_ws);
2064 }
2065
2066 /**
2067  *      tioccons        -       allow admin to move logical console
2068  *      @file: the file to become console
2069  *
2070  *      Allow the adminstrator to move the redirected console device
2071  *
2072  *      Locking: uses redirect_lock to guard the redirect information
2073  */
2074
2075 static int tioccons(struct file *file)
2076 {
2077         if (!capable(CAP_SYS_ADMIN))
2078                 return -EPERM;
2079         if (file->f_op->write == redirected_tty_write) {
2080                 struct file *f;
2081                 spin_lock(&redirect_lock);
2082                 f = redirect;
2083                 redirect = NULL;
2084                 spin_unlock(&redirect_lock);
2085                 if (f)
2086                         fput(f);
2087                 return 0;
2088         }
2089         spin_lock(&redirect_lock);
2090         if (redirect) {
2091                 spin_unlock(&redirect_lock);
2092                 return -EBUSY;
2093         }
2094         get_file(file);
2095         redirect = file;
2096         spin_unlock(&redirect_lock);
2097         return 0;
2098 }
2099
2100 /**
2101  *      fionbio         -       non blocking ioctl
2102  *      @file: file to set blocking value
2103  *      @p: user parameter
2104  *
2105  *      Historical tty interfaces had a blocking control ioctl before
2106  *      the generic functionality existed. This piece of history is preserved
2107  *      in the expected tty API of posix OS's.
2108  *
2109  *      Locking: none, the open file handle ensures it won't go away.
2110  */
2111
2112 static int fionbio(struct file *file, int __user *p)
2113 {
2114         int nonblock;
2115
2116         if (get_user(nonblock, p))
2117                 return -EFAULT;
2118
2119         spin_lock(&file->f_lock);
2120         if (nonblock)
2121                 file->f_flags |= O_NONBLOCK;
2122         else
2123                 file->f_flags &= ~O_NONBLOCK;
2124         spin_unlock(&file->f_lock);
2125         return 0;
2126 }
2127
2128 /**
2129  *      tiocsctty       -       set controlling tty
2130  *      @tty: tty structure
2131  *      @arg: user argument
2132  *
2133  *      This ioctl is used to manage job control. It permits a session
2134  *      leader to set this tty as the controlling tty for the session.
2135  *
2136  *      Locking:
2137  *              Takes tty_mutex() to protect tty instance
2138  *              Takes tasklist_lock internally to walk sessions
2139  *              Takes ->siglock() when updating signal->tty
2140  */
2141
2142 static int tiocsctty(struct tty_struct *tty, int arg)
2143 {
2144         int ret = 0;
2145         if (current->signal->leader && (task_session(current) == tty->session))
2146                 return ret;
2147
2148         mutex_lock(&tty_mutex);
2149         /*
2150          * The process must be a session leader and
2151          * not have a controlling tty already.
2152          */
2153         if (!current->signal->leader || current->signal->tty) {
2154                 ret = -EPERM;
2155                 goto unlock;
2156         }
2157
2158         if (tty->session) {
2159                 /*
2160                  * This tty is already the controlling
2161                  * tty for another session group!
2162                  */
2163                 if (arg == 1 && capable(CAP_SYS_ADMIN)) {
2164                         /*
2165                          * Steal it away
2166                          */
2167                         read_lock(&tasklist_lock);
2168                         session_clear_tty(tty->session);
2169                         read_unlock(&tasklist_lock);
2170                 } else {
2171                         ret = -EPERM;
2172                         goto unlock;
2173                 }
2174         }
2175         proc_set_tty(current, tty);
2176 unlock:
2177         mutex_unlock(&tty_mutex);
2178         return ret;
2179 }
2180
2181 /**
2182  *      tty_get_pgrp    -       return a ref counted pgrp pid
2183  *      @tty: tty to read
2184  *
2185  *      Returns a refcounted instance of the pid struct for the process
2186  *      group controlling the tty.
2187  */
2188
2189 struct pid *tty_get_pgrp(struct tty_struct *tty)
2190 {
2191         unsigned long flags;
2192         struct pid *pgrp;
2193
2194         spin_lock_irqsave(&tty->ctrl_lock, flags);
2195         pgrp = get_pid(tty->pgrp);
2196         spin_unlock_irqrestore(&tty->ctrl_lock, flags);
2197
2198         return pgrp;
2199 }
2200 EXPORT_SYMBOL_GPL(tty_get_pgrp);
2201
2202 /**
2203  *      tiocgpgrp               -       get process group
2204  *      @tty: tty passed by user
2205  *      @real_tty: tty side of the tty pased by the user if a pty else the tty
2206  *      @p: returned pid
2207  *
2208  *      Obtain the process group of the tty. If there is no process group
2209  *      return an error.
2210  *
2211  *      Locking: none. Reference to current->signal->tty is safe.
2212  */
2213
2214 static int tiocgpgrp(struct tty_struct *tty, struct tty_struct *real_tty, pid_t __user *p)
2215 {
2216         struct pid *pid;
2217         int ret;
2218         /*
2219          * (tty == real_tty) is a cheap way of
2220          * testing if the tty is NOT a master pty.
2221          */
2222         if (tty == real_tty && current->signal->tty != real_tty)
2223                 return -ENOTTY;
2224         pid = tty_get_pgrp(real_tty);
2225         ret =  put_user(pid_vnr(pid), p);
2226         put_pid(pid);
2227         return ret;
2228 }
2229
2230 /**
2231  *      tiocspgrp               -       attempt to set process group
2232  *      @tty: tty passed by user
2233  *      @real_tty: tty side device matching tty passed by user
2234  *      @p: pid pointer
2235  *
2236  *      Set the process group of the tty to the session passed. Only
2237  *      permitted where the tty session is our session.
2238  *
2239  *      Locking: RCU, ctrl lock
2240  */
2241
2242 static int tiocspgrp(struct tty_struct *tty, struct tty_struct *real_tty, pid_t __user *p)
2243 {
2244         struct pid *pgrp;
2245         pid_t pgrp_nr;
2246         int retval = tty_check_change(real_tty);
2247         unsigned long flags;
2248
2249         if (retval == -EIO)
2250                 return -ENOTTY;
2251         if (retval)
2252                 return retval;
2253         if (!current->signal->tty ||
2254             (current->signal->tty != real_tty) ||
2255             (real_tty->session != task_session(current)))
2256                 return -ENOTTY;
2257         if (get_user(pgrp_nr, p))
2258                 return -EFAULT;
2259         if (pgrp_nr < 0)
2260                 return -EINVAL;
2261         rcu_read_lock();
2262         pgrp = find_vpid(pgrp_nr);
2263         retval = -ESRCH;
2264         if (!pgrp)
2265                 goto out_unlock;
2266         retval = -EPERM;
2267         if (session_of_pgrp(pgrp) != task_session(current))
2268                 goto out_unlock;
2269         retval = 0;
2270         spin_lock_irqsave(&tty->ctrl_lock, flags);
2271         put_pid(real_tty->pgrp);
2272         real_tty->pgrp = get_pid(pgrp);
2273         spin_unlock_irqrestore(&tty->ctrl_lock, flags);
2274 out_unlock:
2275         rcu_read_unlock();
2276         return retval;
2277 }
2278
2279 /**
2280  *      tiocgsid                -       get session id
2281  *      @tty: tty passed by user
2282  *      @real_tty: tty side of the tty pased by the user if a pty else the tty
2283  *      @p: pointer to returned session id
2284  *
2285  *      Obtain the session id of the tty. If there is no session
2286  *      return an error.
2287  *
2288  *      Locking: none. Reference to current->signal->tty is safe.
2289  */
2290
2291 static int tiocgsid(struct tty_struct *tty, struct tty_struct *real_tty, pid_t __user *p)
2292 {
2293         /*
2294          * (tty == real_tty) is a cheap way of
2295          * testing if the tty is NOT a master pty.
2296         */
2297         if (tty == real_tty && current->signal->tty != real_tty)
2298                 return -ENOTTY;
2299         if (!real_tty->session)
2300                 return -ENOTTY;
2301         return put_user(pid_vnr(real_tty->session), p);
2302 }
2303
2304 /**
2305  *      tiocsetd        -       set line discipline
2306  *      @tty: tty device
2307  *      @p: pointer to user data
2308  *
2309  *      Set the line discipline according to user request.
2310  *
2311  *      Locking: see tty_set_ldisc, this function is just a helper
2312  */
2313
2314 static int tiocsetd(struct tty_struct *tty, int __user *p)
2315 {
2316         int ldisc;
2317         int ret;
2318
2319         if (get_user(ldisc, p))
2320                 return -EFAULT;
2321
2322         lock_kernel();
2323         ret = tty_set_ldisc(tty, ldisc);
2324         unlock_kernel();
2325
2326         return ret;
2327 }
2328
2329 /**
2330  *      send_break      -       performed time break
2331  *      @tty: device to break on
2332  *      @duration: timeout in mS
2333  *
2334  *      Perform a timed break on hardware that lacks its own driver level
2335  *      timed break functionality.
2336  *
2337  *      Locking:
2338  *              atomic_write_lock serializes
2339  *
2340  */
2341
2342 static int send_break(struct tty_struct *tty, unsigned int duration)
2343 {
2344         int retval;
2345
2346         if (tty->ops->break_ctl == NULL)
2347                 return 0;
2348
2349         if (tty->driver->flags & TTY_DRIVER_HARDWARE_BREAK)
2350                 retval = tty->ops->break_ctl(tty, duration);
2351         else {
2352                 /* Do the work ourselves */
2353                 if (tty_write_lock(tty, 0) < 0)
2354                         return -EINTR;
2355                 retval = tty->ops->break_ctl(tty, -1);
2356                 if (retval)
2357                         goto out;
2358                 if (!signal_pending(current))
2359                         msleep_interruptible(duration);
2360                 retval = tty->ops->break_ctl(tty, 0);
2361 out:
2362                 tty_write_unlock(tty);
2363                 if (signal_pending(current))
2364                         retval = -EINTR;
2365         }
2366         return retval;
2367 }
2368
2369 /**
2370  *      tty_tiocmget            -       get modem status
2371  *      @tty: tty device
2372  *      @file: user file pointer
2373  *      @p: pointer to result
2374  *
2375  *      Obtain the modem status bits from the tty driver if the feature
2376  *      is supported. Return -EINVAL if it is not available.
2377  *
2378  *      Locking: none (up to the driver)
2379  */
2380
2381 static int tty_tiocmget(struct tty_struct *tty, struct file *file, int __user *p)
2382 {
2383         int retval = -EINVAL;
2384
2385         if (tty->ops->tiocmget) {
2386                 retval = tty->ops->tiocmget(tty, file);
2387
2388                 if (retval >= 0)
2389                         retval = put_user(retval, p);
2390         }
2391         return retval;
2392 }
2393
2394 /**
2395  *      tty_tiocmset            -       set modem status
2396  *      @tty: tty device
2397  *      @file: user file pointer
2398  *      @cmd: command - clear bits, set bits or set all
2399  *      @p: pointer to desired bits
2400  *
2401  *      Set the modem status bits from the tty driver if the feature
2402  *      is supported. Return -EINVAL if it is not available.
2403  *
2404  *      Locking: none (up to the driver)
2405  */
2406
2407 static int tty_tiocmset(struct tty_struct *tty, struct file *file, unsigned int cmd,
2408              unsigned __user *p)
2409 {
2410         int retval;
2411         unsigned int set, clear, val;
2412
2413         if (tty->ops->tiocmset == NULL)
2414                 return -EINVAL;
2415
2416         retval = get_user(val, p);
2417         if (retval)
2418                 return retval;
2419         set = clear = 0;
2420         switch (cmd) {
2421         case TIOCMBIS:
2422                 set = val;
2423                 break;
2424         case TIOCMBIC:
2425                 clear = val;
2426                 break;
2427         case TIOCMSET:
2428                 set = val;
2429                 clear = ~val;
2430                 break;
2431         }
2432         set &= TIOCM_DTR|TIOCM_RTS|TIOCM_OUT1|TIOCM_OUT2|TIOCM_LOOP;
2433         clear &= TIOCM_DTR|TIOCM_RTS|TIOCM_OUT1|TIOCM_OUT2|TIOCM_LOOP;
2434         return tty->ops->tiocmset(tty, file, set, clear);
2435 }
2436
2437 struct tty_struct *tty_pair_get_tty(struct tty_struct *tty)
2438 {
2439         if (tty->driver->type == TTY_DRIVER_TYPE_PTY &&
2440             tty->driver->subtype == PTY_TYPE_MASTER)
2441                 tty = tty->link;
2442         return tty;
2443 }
2444 EXPORT_SYMBOL(tty_pair_get_tty);
2445
2446 struct tty_struct *tty_pair_get_pty(struct tty_struct *tty)
2447 {
2448         if (tty->driver->type == TTY_DRIVER_TYPE_PTY &&
2449             tty->driver->subtype == PTY_TYPE_MASTER)
2450             return tty;
2451         return tty->link;
2452 }
2453 EXPORT_SYMBOL(tty_pair_get_pty);
2454
2455 /*
2456  * Split this up, as gcc can choke on it otherwise..
2457  */
2458 long tty_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
2459 {
2460         struct tty_struct *tty, *real_tty;
2461         void __user *p = (void __user *)arg;
2462         int retval;
2463         struct tty_ldisc *ld;
2464         struct inode *inode = file->f_dentry->d_inode;
2465
2466         tty = (struct tty_struct *)file->private_data;
2467         if (tty_paranoia_check(tty, inode, "tty_ioctl"))
2468                 return -EINVAL;
2469
2470         real_tty = tty_pair_get_tty(tty);
2471
2472         /*
2473          * Factor out some common prep work
2474          */
2475         switch (cmd) {
2476         case TIOCSETD:
2477         case TIOCSBRK:
2478         case TIOCCBRK:
2479         case TCSBRK:
2480         case TCSBRKP:
2481                 retval = tty_check_change(tty);
2482                 if (retval)
2483                         return retval;
2484                 if (cmd != TIOCCBRK) {
2485                         tty_wait_until_sent(tty, 0);
2486                         if (signal_pending(current))
2487                                 return -EINTR;
2488                 }
2489                 break;
2490         }
2491
2492         /*
2493          *      Now do the stuff.
2494          */
2495         switch (cmd) {
2496         case TIOCSTI:
2497                 return tiocsti(tty, p);
2498         case TIOCGWINSZ:
2499                 return tiocgwinsz(real_tty, p);
2500         case TIOCSWINSZ:
2501                 return tiocswinsz(real_tty, p);
2502         case TIOCCONS:
2503                 return real_tty != tty ? -EINVAL : tioccons(file);
2504         case FIONBIO:
2505                 return fionbio(file, p);
2506         case TIOCEXCL:
2507                 set_bit(TTY_EXCLUSIVE, &tty->flags);
2508                 return 0;
2509         case TIOCNXCL:
2510                 clear_bit(TTY_EXCLUSIVE, &tty->flags);
2511                 return 0;
2512         case TIOCNOTTY:
2513                 if (current->signal->tty != tty)
2514                         return -ENOTTY;
2515                 no_tty();
2516                 return 0;
2517         case TIOCSCTTY:
2518                 return tiocsctty(tty, arg);
2519         case TIOCGPGRP:
2520                 return tiocgpgrp(tty, real_tty, p);
2521         case TIOCSPGRP:
2522                 return tiocspgrp(tty, real_tty, p);
2523         case TIOCGSID:
2524                 return tiocgsid(tty, real_tty, p);
2525         case TIOCGETD:
2526                 return put_user(tty->ldisc->ops->num, (int __user *)p);
2527         case TIOCSETD:
2528                 return tiocsetd(tty, p);
2529         /*
2530          * Break handling
2531          */
2532         case TIOCSBRK:  /* Turn break on, unconditionally */
2533                 if (tty->ops->break_ctl)
2534                         return tty->ops->break_ctl(tty, -1);
2535                 return 0;
2536         case TIOCCBRK:  /* Turn break off, unconditionally */
2537                 if (tty->ops->break_ctl)
2538                         return tty->ops->break_ctl(tty, 0);
2539                 return 0;
2540         case TCSBRK:   /* SVID version: non-zero arg --> no break */
2541                 /* non-zero arg means wait for all output data
2542                  * to be sent (performed above) but don't send break.
2543                  * This is used by the tcdrain() termios function.
2544                  */
2545                 if (!arg)
2546                         return send_break(tty, 250);
2547                 return 0;
2548         case TCSBRKP:   /* support for POSIX tcsendbreak() */
2549                 return send_break(tty, arg ? arg*100 : 250);
2550
2551         case TIOCMGET:
2552                 return tty_tiocmget(tty, file, p);
2553         case TIOCMSET:
2554         case TIOCMBIC:
2555         case TIOCMBIS:
2556                 return tty_tiocmset(tty, file, cmd, p);
2557         case TCFLSH:
2558                 switch (arg) {
2559                 case TCIFLUSH:
2560                 case TCIOFLUSH:
2561                 /* flush tty buffer and allow ldisc to process ioctl */
2562                         tty_buffer_flush(tty);
2563                         break;
2564                 }
2565                 break;
2566         }
2567         if (tty->ops->ioctl) {
2568                 retval = (tty->ops->ioctl)(tty, file, cmd, arg);
2569                 if (retval != -ENOIOCTLCMD)
2570                         return retval;
2571         }
2572         ld = tty_ldisc_ref_wait(tty);
2573         retval = -EINVAL;
2574         if (ld->ops->ioctl) {
2575                 retval = ld->ops->ioctl(tty, file, cmd, arg);
2576                 if (retval == -ENOIOCTLCMD)
2577                         retval = -EINVAL;
2578         }
2579         tty_ldisc_deref(ld);
2580         return retval;
2581 }
2582
2583 #ifdef CONFIG_COMPAT
2584 static long tty_compat_ioctl(struct file *file, unsigned int cmd,
2585                                 unsigned long arg)
2586 {
2587         struct inode *inode = file->f_dentry->d_inode;
2588         struct tty_struct *tty = file->private_data;
2589         struct tty_ldisc *ld;
2590         int retval = -ENOIOCTLCMD;
2591
2592         if (tty_paranoia_check(tty, inode, "tty_ioctl"))
2593                 return -EINVAL;
2594
2595         if (tty->ops->compat_ioctl) {
2596                 retval = (tty->ops->compat_ioctl)(tty, file, cmd, arg);
2597                 if (retval != -ENOIOCTLCMD)
2598                         return retval;
2599         }
2600
2601         ld = tty_ldisc_ref_wait(tty);
2602         if (ld->ops->compat_ioctl)
2603                 retval = ld->ops->compat_ioctl(tty, file, cmd, arg);
2604         tty_ldisc_deref(ld);
2605
2606         return retval;
2607 }
2608 #endif
2609
2610 /*
2611  * This implements the "Secure Attention Key" ---  the idea is to
2612  * prevent trojan horses by killing all processes associated with this
2613  * tty when the user hits the "Secure Attention Key".  Required for
2614  * super-paranoid applications --- see the Orange Book for more details.
2615  *
2616  * This code could be nicer; ideally it should send a HUP, wait a few
2617  * seconds, then send a INT, and then a KILL signal.  But you then
2618  * have to coordinate with the init process, since all processes associated
2619  * with the current tty must be dead before the new getty is allowed
2620  * to spawn.
2621  *
2622  * Now, if it would be correct ;-/ The current code has a nasty hole -
2623  * it doesn't catch files in flight. We may send the descriptor to ourselves
2624  * via AF_UNIX socket, close it and later fetch from socket. FIXME.
2625  *
2626  * Nasty bug: do_SAK is being called in interrupt context.  This can
2627  * deadlock.  We punt it up to process context.  AKPM - 16Mar2001
2628  */
2629 void __do_SAK(struct tty_struct *tty)
2630 {
2631 #ifdef TTY_SOFT_SAK
2632         tty_hangup(tty);
2633 #else
2634         struct task_struct *g, *p;
2635         struct pid *session;
2636         int             i;
2637         struct file     *filp;
2638         struct fdtable *fdt;
2639
2640         if (!tty)
2641                 return;
2642         session = tty->session;
2643
2644         tty_ldisc_flush(tty);
2645
2646         tty_driver_flush_buffer(tty);
2647
2648         read_lock(&tasklist_lock);
2649         /* Kill the entire session */
2650         do_each_pid_task(session, PIDTYPE_SID, p) {
2651                 printk(KERN_NOTICE "SAK: killed process %d"
2652                         " (%s): task_session(p)==tty->session\n",
2653                         task_pid_nr(p), p->comm);
2654                 send_sig(SIGKILL, p, 1);
2655         } while_each_pid_task(session, PIDTYPE_SID, p);
2656         /* Now kill any processes that happen to have the
2657          * tty open.
2658          */
2659         do_each_thread(g, p) {
2660                 if (p->signal->tty == tty) {
2661                         printk(KERN_NOTICE "SAK: killed process %d"
2662                             " (%s): task_session(p)==tty->session\n",
2663                             task_pid_nr(p), p->comm);
2664                         send_sig(SIGKILL, p, 1);
2665                         continue;
2666                 }
2667                 task_lock(p);
2668                 if (p->files) {
2669                         /*
2670                          * We don't take a ref to the file, so we must
2671                          * hold ->file_lock instead.
2672                          */
2673                         spin_lock(&p->files->file_lock);
2674                         fdt = files_fdtable(p->files);
2675                         for (i = 0; i < fdt->max_fds; i++) {
2676                                 filp = fcheck_files(p->files, i);
2677                                 if (!filp)
2678                                         continue;
2679                                 if (filp->f_op->read == tty_read &&
2680                                     filp->private_data == tty) {
2681                                         printk(KERN_NOTICE "SAK: killed process %d"
2682                                             " (%s): fd#%d opened to the tty\n",
2683                                             task_pid_nr(p), p->comm, i);
2684                                         force_sig(SIGKILL, p);
2685                                         break;
2686                                 }
2687                         }
2688                         spin_unlock(&p->files->file_lock);
2689                 }
2690                 task_unlock(p);
2691         } while_each_thread(g, p);
2692         read_unlock(&tasklist_lock);
2693 #endif
2694 }
2695
2696 static void do_SAK_work(struct work_struct *work)
2697 {
2698         struct tty_struct *tty =
2699                 container_of(work, struct tty_struct, SAK_work);
2700         __do_SAK(tty);
2701 }
2702
2703 /*
2704  * The tq handling here is a little racy - tty->SAK_work may already be queued.
2705  * Fortunately we don't need to worry, because if ->SAK_work is already queued,
2706  * the values which we write to it will be identical to the values which it
2707  * already has. --akpm
2708  */
2709 void do_SAK(struct tty_struct *tty)
2710 {
2711         if (!tty)
2712                 return;
2713         schedule_work(&tty->SAK_work);
2714 }
2715
2716 EXPORT_SYMBOL(do_SAK);
2717
2718 /**
2719  *      initialize_tty_struct
2720  *      @tty: tty to initialize
2721  *
2722  *      This subroutine initializes a tty structure that has been newly
2723  *      allocated.
2724  *
2725  *      Locking: none - tty in question must not be exposed at this point
2726  */
2727
2728 void initialize_tty_struct(struct tty_struct *tty,
2729                 struct tty_driver *driver, int idx)
2730 {
2731         memset(tty, 0, sizeof(struct tty_struct));
2732         kref_init(&tty->kref);
2733         tty->magic = TTY_MAGIC;
2734         tty_ldisc_init(tty);
2735         tty->session = NULL;
2736         tty->pgrp = NULL;
2737         tty->overrun_time = jiffies;
2738         tty->buf.head = tty->buf.tail = NULL;
2739         tty_buffer_init(tty);
2740         mutex_init(&tty->termios_mutex);
2741         mutex_init(&tty->ldisc_mutex);
2742         init_waitqueue_head(&tty->write_wait);
2743         init_waitqueue_head(&tty->read_wait);
2744         INIT_WORK(&tty->hangup_work, do_tty_hangup);
2745         mutex_init(&tty->atomic_read_lock);
2746         mutex_init(&tty->atomic_write_lock);
2747         mutex_init(&tty->output_lock);
2748         mutex_init(&tty->echo_lock);
2749         spin_lock_init(&tty->read_lock);
2750         spin_lock_init(&tty->ctrl_lock);
2751         INIT_LIST_HEAD(&tty->tty_files);
2752         INIT_WORK(&tty->SAK_work, do_SAK_work);
2753
2754         tty->driver = driver;
2755         tty->ops = driver->ops;
2756         tty->index = idx;
2757         tty_line_name(driver, idx, tty->name);
2758 }
2759
2760 /**
2761  *      tty_put_char    -       write one character to a tty
2762  *      @tty: tty
2763  *      @ch: character
2764  *
2765  *      Write one byte to the tty using the provided put_char method
2766  *      if present. Returns the number of characters successfully output.
2767  *
2768  *      Note: the specific put_char operation in the driver layer may go
2769  *      away soon. Don't call it directly, use this method
2770  */
2771
2772 int tty_put_char(struct tty_struct *tty, unsigned char ch)
2773 {
2774         if (tty->ops->put_char)
2775                 return tty->ops->put_char(tty, ch);
2776         return tty->ops->write(tty, &ch, 1);
2777 }
2778 EXPORT_SYMBOL_GPL(tty_put_char);
2779
2780 struct class *tty_class;
2781
2782 /**
2783  *      tty_register_device - register a tty device
2784  *      @driver: the tty driver that describes the tty device
2785  *      @index: the index in the tty driver for this tty device
2786  *      @device: a struct device that is associated with this tty device.
2787  *              This field is optional, if there is no known struct device
2788  *              for this tty device it can be set to NULL safely.
2789  *
2790  *      Returns a pointer to the struct device for this tty device
2791  *      (or ERR_PTR(-EFOO) on error).
2792  *
2793  *      This call is required to be made to register an individual tty device
2794  *      if the tty driver's flags have the TTY_DRIVER_DYNAMIC_DEV bit set.  If
2795  *      that bit is not set, this function should not be called by a tty
2796  *      driver.
2797  *
2798  *      Locking: ??
2799  */
2800
2801 struct device *tty_register_device(struct tty_driver *driver, unsigned index,
2802                                    struct device *device)
2803 {
2804         char name[64];
2805         dev_t dev = MKDEV(driver->major, driver->minor_start) + index;
2806
2807         if (index >= driver->num) {
2808                 printk(KERN_ERR "Attempt to register invalid tty line number "
2809                        " (%d).\n", index);
2810                 return ERR_PTR(-EINVAL);
2811         }
2812
2813         if (driver->type == TTY_DRIVER_TYPE_PTY)
2814                 pty_line_name(driver, index, name);
2815         else
2816                 tty_line_name(driver, index, name);
2817
2818         return device_create(tty_class, device, dev, NULL, name);
2819 }
2820 EXPORT_SYMBOL(tty_register_device);
2821
2822 /**
2823  *      tty_unregister_device - unregister a tty device
2824  *      @driver: the tty driver that describes the tty device
2825  *      @index: the index in the tty driver for this tty device
2826  *
2827  *      If a tty device is registered with a call to tty_register_device() then
2828  *      this function must be called when the tty device is gone.
2829  *
2830  *      Locking: ??
2831  */
2832
2833 void tty_unregister_device(struct tty_driver *driver, unsigned index)
2834 {
2835         device_destroy(tty_class,
2836                 MKDEV(driver->major, driver->minor_start) + index);
2837 }
2838 EXPORT_SYMBOL(tty_unregister_device);
2839
2840 struct tty_driver *alloc_tty_driver(int lines)
2841 {
2842         struct tty_driver *driver;
2843
2844         driver = kzalloc(sizeof(struct tty_driver), GFP_KERNEL);
2845         if (driver) {
2846                 kref_init(&driver->kref);
2847                 driver->magic = TTY_DRIVER_MAGIC;
2848                 driver->num = lines;
2849                 /* later we'll move allocation of tables here */
2850         }
2851         return driver;
2852 }
2853 EXPORT_SYMBOL(alloc_tty_driver);
2854
2855 static void destruct_tty_driver(struct kref *kref)
2856 {
2857         struct tty_driver *driver = container_of(kref, struct tty_driver, kref);
2858         int i;
2859         struct ktermios *tp;
2860         void *p;
2861
2862         if (driver->flags & TTY_DRIVER_INSTALLED) {
2863                 /*
2864                  * Free the termios and termios_locked structures because
2865                  * we don't want to get memory leaks when modular tty
2866                  * drivers are removed from the kernel.
2867                  */
2868                 for (i = 0; i < driver->num; i++) {
2869                         tp = driver->termios[i];
2870                         if (tp) {
2871                                 driver->termios[i] = NULL;
2872                                 kfree(tp);
2873                         }
2874                         if (!(driver->flags & TTY_DRIVER_DYNAMIC_DEV))
2875                                 tty_unregister_device(driver, i);
2876                 }
2877                 p = driver->ttys;
2878                 proc_tty_unregister_driver(driver);
2879                 driver->ttys = NULL;
2880                 driver->termios = NULL;
2881                 kfree(p);
2882                 cdev_del(&driver->cdev);
2883         }
2884         kfree(driver);
2885 }
2886
2887 void tty_driver_kref_put(struct tty_driver *driver)
2888 {
2889         kref_put(&driver->kref, destruct_tty_driver);
2890 }
2891 EXPORT_SYMBOL(tty_driver_kref_put);
2892
2893 void tty_set_operations(struct tty_driver *driver,
2894                         const struct tty_operations *op)
2895 {
2896         driver->ops = op;
2897 };
2898 EXPORT_SYMBOL(tty_set_operations);
2899
2900 void put_tty_driver(struct tty_driver *d)
2901 {
2902         tty_driver_kref_put(d);
2903 }
2904 EXPORT_SYMBOL(put_tty_driver);
2905
2906 /*
2907  * Called by a tty driver to register itself.
2908  */
2909 int tty_register_driver(struct tty_driver *driver)
2910 {
2911         int error;
2912         int i;
2913         dev_t dev;
2914         void **p = NULL;
2915
2916         if (!(driver->flags & TTY_DRIVER_DEVPTS_MEM) && driver->num) {
2917                 p = kzalloc(driver->num * 2 * sizeof(void *), GFP_KERNEL);
2918                 if (!p)
2919                         return -ENOMEM;
2920         }
2921
2922         if (!driver->major) {
2923                 error = alloc_chrdev_region(&dev, driver->minor_start,
2924                                                 driver->num, driver->name);
2925                 if (!error) {
2926                         driver->major = MAJOR(dev);
2927                         driver->minor_start = MINOR(dev);
2928                 }
2929         } else {
2930                 dev = MKDEV(driver->major, driver->minor_start);
2931                 error = register_chrdev_region(dev, driver->num, driver->name);
2932         }
2933         if (error < 0) {
2934                 kfree(p);
2935                 return error;
2936         }
2937
2938         if (p) {
2939                 driver->ttys = (struct tty_struct **)p;
2940                 driver->termios = (struct ktermios **)(p + driver->num);
2941         } else {
2942                 driver->ttys = NULL;
2943                 driver->termios = NULL;
2944         }
2945
2946         cdev_init(&driver->cdev, &tty_fops);
2947         driver->cdev.owner = driver->owner;
2948         error = cdev_add(&driver->cdev, dev, driver->num);
2949         if (error) {
2950                 unregister_chrdev_region(dev, driver->num);
2951                 driver->ttys = NULL;
2952                 driver->termios = NULL;
2953                 kfree(p);
2954                 return error;
2955         }
2956
2957         mutex_lock(&tty_mutex);
2958         list_add(&driver->tty_drivers, &tty_drivers);
2959         mutex_unlock(&tty_mutex);
2960
2961         if (!(driver->flags & TTY_DRIVER_DYNAMIC_DEV)) {
2962                 for (i = 0; i < driver->num; i++)
2963                     tty_register_device(driver, i, NULL);
2964         }
2965         proc_tty_register_driver(driver);
2966         driver->flags |= TTY_DRIVER_INSTALLED;
2967         return 0;
2968 }
2969
2970 EXPORT_SYMBOL(tty_register_driver);
2971
2972 /*
2973  * Called by a tty driver to unregister itself.
2974  */
2975 int tty_unregister_driver(struct tty_driver *driver)
2976 {
2977 #if 0
2978         /* FIXME */
2979         if (driver->refcount)
2980                 return -EBUSY;
2981 #endif
2982         unregister_chrdev_region(MKDEV(driver->major, driver->minor_start),
2983                                 driver->num);
2984         mutex_lock(&tty_mutex);
2985         list_del(&driver->tty_drivers);
2986         mutex_unlock(&tty_mutex);
2987         return 0;
2988 }
2989
2990 EXPORT_SYMBOL(tty_unregister_driver);
2991
2992 dev_t tty_devnum(struct tty_struct *tty)
2993 {
2994         return MKDEV(tty->driver->major, tty->driver->minor_start) + tty->index;
2995 }
2996 EXPORT_SYMBOL(tty_devnum);
2997
2998 void proc_clear_tty(struct task_struct *p)
2999 {
3000         unsigned long flags;
3001         struct tty_struct *tty;
3002         spin_lock_irqsave(&p->sighand->siglock, flags);
3003         tty = p->signal->tty;
3004         p->signal->tty = NULL;
3005         spin_unlock_irqrestore(&p->sighand->siglock, flags);
3006         tty_kref_put(tty);
3007 }
3008
3009 /* Called under the sighand lock */
3010
3011 static void __proc_set_tty(struct task_struct *tsk, struct tty_struct *tty)
3012 {
3013         if (tty) {
3014                 unsigned long flags;
3015                 /* We should not have a session or pgrp to put here but.... */
3016                 spin_lock_irqsave(&tty->ctrl_lock, flags);
3017                 put_pid(tty->session);
3018                 put_pid(tty->pgrp);
3019                 tty->pgrp = get_pid(task_pgrp(tsk));
3020                 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
3021                 tty->session = get_pid(task_session(tsk));
3022                 if (tsk->signal->tty) {
3023                         printk(KERN_DEBUG "tty not NULL!!\n");
3024                         tty_kref_put(tsk->signal->tty);
3025                 }
3026         }
3027         put_pid(tsk->signal->tty_old_pgrp);
3028         tsk->signal->tty = tty_kref_get(tty);
3029         tsk->signal->tty_old_pgrp = NULL;
3030 }
3031
3032 static void proc_set_tty(struct task_struct *tsk, struct tty_struct *tty)
3033 {
3034         spin_lock_irq(&tsk->sighand->siglock);
3035         __proc_set_tty(tsk, tty);
3036         spin_unlock_irq(&tsk->sighand->siglock);
3037 }
3038
3039 struct tty_struct *get_current_tty(void)
3040 {
3041         struct tty_struct *tty;
3042         unsigned long flags;
3043
3044         spin_lock_irqsave(&current->sighand->siglock, flags);
3045         tty = tty_kref_get(current->signal->tty);
3046         spin_unlock_irqrestore(&current->sighand->siglock, flags);
3047         return tty;
3048 }
3049 EXPORT_SYMBOL_GPL(get_current_tty);
3050
3051 void tty_default_fops(struct file_operations *fops)
3052 {
3053         *fops = tty_fops;
3054 }
3055
3056 /*
3057  * Initialize the console device. This is called *early*, so
3058  * we can't necessarily depend on lots of kernel help here.
3059  * Just do some early initializations, and do the complex setup
3060  * later.
3061  */
3062 void __init console_init(void)
3063 {
3064         initcall_t *call;
3065
3066         /* Setup the default TTY line discipline. */
3067         tty_ldisc_begin();
3068
3069         /*
3070          * set up the console device so that later boot sequences can
3071          * inform about problems etc..
3072          */
3073         call = __con_initcall_start;
3074         while (call < __con_initcall_end) {
3075                 (*call)();
3076                 call++;
3077         }
3078 }
3079
3080 static char *tty_devnode(struct device *dev, mode_t *mode)
3081 {
3082         if (!mode)
3083                 return NULL;
3084         if (dev->devt == MKDEV(TTYAUX_MAJOR, 0) ||
3085             dev->devt == MKDEV(TTYAUX_MAJOR, 2))
3086                 *mode = 0666;
3087         return NULL;
3088 }
3089
3090 static int __init tty_class_init(void)
3091 {
3092         tty_class = class_create(THIS_MODULE, "tty");
3093         if (IS_ERR(tty_class))
3094                 return PTR_ERR(tty_class);
3095         tty_class->devnode = tty_devnode;
3096         return 0;
3097 }
3098
3099 postcore_initcall(tty_class_init);
3100
3101 /* 3/2004 jmc: why do these devices exist? */
3102
3103 static struct cdev tty_cdev, console_cdev;
3104
3105 /*
3106  * Ok, now we can initialize the rest of the tty devices and can count
3107  * on memory allocations, interrupts etc..
3108  */
3109 static int __init tty_init(void)
3110 {
3111         cdev_init(&tty_cdev, &tty_fops);
3112         if (cdev_add(&tty_cdev, MKDEV(TTYAUX_MAJOR, 0), 1) ||
3113             register_chrdev_region(MKDEV(TTYAUX_MAJOR, 0), 1, "/dev/tty") < 0)
3114                 panic("Couldn't register /dev/tty driver\n");
3115         device_create(tty_class, NULL, MKDEV(TTYAUX_MAJOR, 0), NULL,
3116                               "tty");
3117
3118         cdev_init(&console_cdev, &console_fops);
3119         if (cdev_add(&console_cdev, MKDEV(TTYAUX_MAJOR, 1), 1) ||
3120             register_chrdev_region(MKDEV(TTYAUX_MAJOR, 1), 1, "/dev/console") < 0)
3121                 panic("Couldn't register /dev/console driver\n");
3122         device_create(tty_class, NULL, MKDEV(TTYAUX_MAJOR, 1), NULL,
3123                               "console");
3124
3125 #ifdef CONFIG_VT
3126         vty_init(&console_fops);
3127 #endif
3128         return 0;
3129 }
3130 module_init(tty_init);