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