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