blob: f90b6217b3ba0d23f1740d90dcccdc464406b276 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07002 * 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
Alan Cox37bdfb02008-02-08 04:18:47 -080020 * makes for cleaner and more compact code. -TYT, 9/17/92
Linus Torvalds1da177e2005-04-16 15:20:36 -070021 *
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
Alan Cox37bdfb02008-02-08 04:18:47 -080042 *
Linus Torvalds1da177e2005-04-16 15:20:36 -070043 * 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 *
Alan Coxd81ed102008-10-13 10:41:42 +010050 * Rewrote tty_init_dev and tty_release_dev to eliminate races.
Linus Torvalds1da177e2005-04-16 15:20:36 -070051 * -- 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.
Alan Cox37bdfb02008-02-08 04:18:47 -080063 * alloc_tty_struct() always uses kmalloc()
64 * -- Andrew Morton <andrewm@uow.edu.eu> 17Mar01
Linus Torvalds1da177e2005-04-16 15:20:36 -070065 */
66
Linus Torvalds1da177e2005-04-16 15:20:36 -070067#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>
Al Viro9f3acc32008-04-24 07:44:08 -040079#include <linux/fdtable.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070080#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>
Linus Torvalds1da177e2005-04-16 15:20:36 -070091#include <linux/device.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070092#include <linux/wait.h>
93#include <linux/bitops.h>
Domen Puncerb20f3ae2005-06-25 14:58:42 -070094#include <linux/delay.h>
Alan Coxa352def2008-07-16 21:53:12 +010095#include <linux/seq_file.h>
Alan Coxd281da72010-09-16 18:21:24 +010096#include <linux/serial.h>
Manuel Zerpies5a3c6b22011-06-16 14:07:22 +020097#include <linux/ratelimit.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070098
Alan Coxa352def2008-07-16 21:53:12 +010099#include <linux/uaccess.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700100
101#include <linux/kbd_kern.h>
102#include <linux/vt_kern.h>
103#include <linux/selection.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700104
105#include <linux/kmod.h>
Pavel Emelyanovb4888932007-10-18 23:40:14 -0700106#include <linux/nsproxy.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700107
108#undef TTY_DEBUG_HANGUP
109
110#define TTY_PARANOIA_CHECK 1
111#define CHECK_TTY_COUNT 1
112
Alan Coxedc6afc2006-12-08 02:38:44 -0800113struct ktermios tty_std_termios = { /* for the benefit of tty drivers */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700114 .c_iflag = ICRNL | IXON,
115 .c_oflag = OPOST | ONLCR,
116 .c_cflag = B38400 | CS8 | CREAD | HUPCL,
117 .c_lflag = ISIG | ICANON | ECHO | ECHOE | ECHOK |
118 ECHOCTL | ECHOKE | IEXTEN,
Alan Coxedc6afc2006-12-08 02:38:44 -0800119 .c_cc = INIT_C_CC,
120 .c_ispeed = 38400,
121 .c_ospeed = 38400
Linus Torvalds1da177e2005-04-16 15:20:36 -0700122};
123
124EXPORT_SYMBOL(tty_std_termios);
125
126/* This list gets poked at by procfs and various bits of boot up code. This
127 could do with some rationalisation such as pulling the tty proc function
128 into this file */
Alan Cox37bdfb02008-02-08 04:18:47 -0800129
Linus Torvalds1da177e2005-04-16 15:20:36 -0700130LIST_HEAD(tty_drivers); /* linked list of tty drivers */
131
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800132/* Mutex to protect creating and releasing a tty. This is shared with
Linus Torvalds1da177e2005-04-16 15:20:36 -0700133 vt.c for deeply disgusting hack reasons */
Ingo Molnar70522e12006-03-23 03:00:31 -0800134DEFINE_MUTEX(tty_mutex);
Alan Coxde2a84f2006-09-29 02:00:57 -0700135EXPORT_SYMBOL(tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700136
Nick Pigginee2ffa02010-08-18 04:37:35 +1000137/* Spinlock to protect the tty->tty_files list */
138DEFINE_SPINLOCK(tty_files_lock);
139
Linus Torvalds1da177e2005-04-16 15:20:36 -0700140static ssize_t tty_read(struct file *, char __user *, size_t, loff_t *);
141static ssize_t tty_write(struct file *, const char __user *, size_t, loff_t *);
Alan Cox37bdfb02008-02-08 04:18:47 -0800142ssize_t redirected_tty_write(struct file *, const char __user *,
143 size_t, loff_t *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700144static unsigned int tty_poll(struct file *, poll_table *);
145static int tty_open(struct inode *, struct file *);
Alan Cox04f378b2008-04-30 00:53:29 -0700146long tty_ioctl(struct file *file, unsigned int cmd, unsigned long arg);
Paul Fulghume10cc1d2007-05-10 22:22:50 -0700147#ifdef CONFIG_COMPAT
Alan Cox37bdfb02008-02-08 04:18:47 -0800148static long tty_compat_ioctl(struct file *file, unsigned int cmd,
Paul Fulghume10cc1d2007-05-10 22:22:50 -0700149 unsigned long arg);
150#else
151#define tty_compat_ioctl NULL
152#endif
Arnd Bergmannec79d602010-06-01 22:53:01 +0200153static int __tty_fasync(int fd, struct file *filp, int on);
Alan Cox37bdfb02008-02-08 04:18:47 -0800154static int tty_fasync(int fd, struct file *filp, int on);
Christoph Hellwigd5698c22007-02-10 01:46:46 -0800155static void release_tty(struct tty_struct *tty, int idx);
Eric W. Biederman2a65f1d2007-05-08 00:26:53 -0700156static void __proc_set_tty(struct task_struct *tsk, struct tty_struct *tty);
Eric W. Biederman98a27ba2007-05-08 00:26:56 -0700157static void proc_set_tty(struct task_struct *tsk, struct tty_struct *tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700158
Alan Coxaf9b8972006-08-27 01:24:01 -0700159/**
160 * alloc_tty_struct - allocate a tty object
161 *
162 * Return a new empty tty structure. The data fields have not
163 * been initialized in any way but has been zeroed
164 *
165 * Locking: none
Alan Coxaf9b8972006-08-27 01:24:01 -0700166 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700167
Alan Coxbf970ee2008-10-13 10:42:39 +0100168struct tty_struct *alloc_tty_struct(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700169{
Alan Cox1266b1e2006-09-29 02:00:40 -0700170 return kzalloc(sizeof(struct tty_struct), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700171}
172
Alan Coxaf9b8972006-08-27 01:24:01 -0700173/**
174 * free_tty_struct - free a disused tty
175 * @tty: tty struct to free
176 *
177 * Free the write buffers, tty queue and tty memory itself.
178 *
179 * Locking: none. Must be called after tty is definitely unused
180 */
181
Alan Coxbf970ee2008-10-13 10:42:39 +0100182void free_tty_struct(struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700183{
Dan Carpenterdc6802a2012-07-24 12:52:04 +0100184 if (!tty)
185 return;
Dmitry Eremin-Solenikov30004ac2010-08-09 18:22:49 +0400186 if (tty->dev)
187 put_device(tty->dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700188 kfree(tty->write_buf);
Alan Cox33f0f882006-01-09 20:54:13 -0800189 tty_buffer_free_all(tty);
Alan Cox89c8d912012-08-08 16:30:13 +0100190 tty->magic = 0xDEADDEAD;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700191 kfree(tty);
192}
193
Nick Piggind996b622010-08-18 04:37:36 +1000194static inline struct tty_struct *file_tty(struct file *file)
195{
196 return ((struct tty_file_private *)file->private_data)->tty;
197}
198
Jiri Slabyfa90e1c2011-10-12 11:32:43 +0200199int tty_alloc_file(struct file *file)
Nick Piggind996b622010-08-18 04:37:36 +1000200{
201 struct tty_file_private *priv;
202
Pekka Enbergf573bd12010-08-24 07:48:34 +0300203 priv = kmalloc(sizeof(*priv), GFP_KERNEL);
204 if (!priv)
205 return -ENOMEM;
Nick Piggind996b622010-08-18 04:37:36 +1000206
Jiri Slabyfa90e1c2011-10-12 11:32:43 +0200207 file->private_data = priv;
208
209 return 0;
210}
211
212/* Associate a new file with the tty structure */
213void tty_add_file(struct tty_struct *tty, struct file *file)
214{
215 struct tty_file_private *priv = file->private_data;
216
Nick Piggind996b622010-08-18 04:37:36 +1000217 priv->tty = tty;
218 priv->file = file;
Nick Piggind996b622010-08-18 04:37:36 +1000219
220 spin_lock(&tty_files_lock);
221 list_add(&priv->list, &tty->tty_files);
222 spin_unlock(&tty_files_lock);
Jiri Slabyfa90e1c2011-10-12 11:32:43 +0200223}
Pekka Enbergf573bd12010-08-24 07:48:34 +0300224
Jiri Slabyfa90e1c2011-10-12 11:32:43 +0200225/**
226 * tty_free_file - free file->private_data
227 *
228 * This shall be used only for fail path handling when tty_add_file was not
229 * called yet.
230 */
231void tty_free_file(struct file *file)
232{
233 struct tty_file_private *priv = file->private_data;
234
235 file->private_data = NULL;
236 kfree(priv);
Nick Piggind996b622010-08-18 04:37:36 +1000237}
238
239/* Delete file from its tty */
240void tty_del_file(struct file *file)
241{
242 struct tty_file_private *priv = file->private_data;
243
244 spin_lock(&tty_files_lock);
245 list_del(&priv->list);
246 spin_unlock(&tty_files_lock);
Jiri Slabyfa90e1c2011-10-12 11:32:43 +0200247 tty_free_file(file);
Nick Piggind996b622010-08-18 04:37:36 +1000248}
249
250
Linus Torvalds1da177e2005-04-16 15:20:36 -0700251#define TTY_NUMBER(tty) ((tty)->index + (tty)->driver->name_base)
252
Alan Coxaf9b8972006-08-27 01:24:01 -0700253/**
254 * tty_name - return tty naming
255 * @tty: tty structure
256 * @buf: buffer for output
257 *
258 * Convert a tty structure into a name. The name reflects the kernel
259 * naming policy and if udev is in use may not reflect user space
260 *
261 * Locking: none
262 */
263
Linus Torvalds1da177e2005-04-16 15:20:36 -0700264char *tty_name(struct tty_struct *tty, char *buf)
265{
266 if (!tty) /* Hmm. NULL pointer. That's fun. */
267 strcpy(buf, "NULL tty");
268 else
269 strcpy(buf, tty->name);
270 return buf;
271}
272
273EXPORT_SYMBOL(tty_name);
274
Andrew Mortond769a662005-05-05 16:15:50 -0700275int tty_paranoia_check(struct tty_struct *tty, struct inode *inode,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700276 const char *routine)
277{
278#ifdef TTY_PARANOIA_CHECK
279 if (!tty) {
280 printk(KERN_WARNING
281 "null TTY for (%d:%d) in %s\n",
282 imajor(inode), iminor(inode), routine);
283 return 1;
284 }
285 if (tty->magic != TTY_MAGIC) {
286 printk(KERN_WARNING
287 "bad magic number for tty struct (%d:%d) in %s\n",
288 imajor(inode), iminor(inode), routine);
289 return 1;
290 }
291#endif
292 return 0;
293}
294
295static int check_tty_count(struct tty_struct *tty, const char *routine)
296{
297#ifdef CHECK_TTY_COUNT
298 struct list_head *p;
299 int count = 0;
Alan Cox37bdfb02008-02-08 04:18:47 -0800300
Nick Pigginee2ffa02010-08-18 04:37:35 +1000301 spin_lock(&tty_files_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700302 list_for_each(p, &tty->tty_files) {
303 count++;
304 }
Nick Pigginee2ffa02010-08-18 04:37:35 +1000305 spin_unlock(&tty_files_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700306 if (tty->driver->type == TTY_DRIVER_TYPE_PTY &&
307 tty->driver->subtype == PTY_TYPE_SLAVE &&
308 tty->link && tty->link->count)
309 count++;
310 if (tty->count != count) {
311 printk(KERN_WARNING "Warning: dev (%s) tty->count(%d) "
312 "!= #fd's(%d) in %s\n",
313 tty->name, tty->count, count, routine);
314 return count;
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800315 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700316#endif
317 return 0;
318}
319
Alan Coxaf9b8972006-08-27 01:24:01 -0700320/**
Alan Coxaf9b8972006-08-27 01:24:01 -0700321 * get_tty_driver - find device of a tty
322 * @dev_t: device identifier
323 * @index: returns the index of the tty
324 *
325 * This routine returns a tty driver structure, given a device number
326 * and also passes back the index number.
327 *
328 * Locking: caller must hold tty_mutex
Linus Torvalds1da177e2005-04-16 15:20:36 -0700329 */
Alan Coxaf9b8972006-08-27 01:24:01 -0700330
Linus Torvalds1da177e2005-04-16 15:20:36 -0700331static struct tty_driver *get_tty_driver(dev_t device, int *index)
332{
333 struct tty_driver *p;
334
335 list_for_each_entry(p, &tty_drivers, tty_drivers) {
336 dev_t base = MKDEV(p->major, p->minor_start);
337 if (device < base || device >= base + p->num)
338 continue;
339 *index = device - base;
Alan Cox7d7b93c2008-10-13 10:42:09 +0100340 return tty_driver_kref_get(p);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700341 }
342 return NULL;
343}
344
Jason Wesself2d937f2008-04-17 20:05:37 +0200345#ifdef CONFIG_CONSOLE_POLL
346
347/**
348 * tty_find_polling_driver - find device of a polled tty
349 * @name: name string to match
350 * @line: pointer to resulting tty line nr
351 *
352 * This routine returns a tty driver structure, given a name
353 * and the condition that the tty driver is capable of polled
354 * operation.
355 */
356struct tty_driver *tty_find_polling_driver(char *name, int *line)
357{
358 struct tty_driver *p, *res = NULL;
359 int tty_line = 0;
Jason Wessel0dca0fd2008-09-26 10:36:42 -0500360 int len;
Alan Cox5f0878a2009-06-11 12:46:41 +0100361 char *str, *stp;
Jason Wesself2d937f2008-04-17 20:05:37 +0200362
Jason Wessel0dca0fd2008-09-26 10:36:42 -0500363 for (str = name; *str; str++)
364 if ((*str >= '0' && *str <= '9') || *str == ',')
365 break;
366 if (!*str)
367 return NULL;
368
369 len = str - name;
370 tty_line = simple_strtoul(str, &str, 10);
371
Jason Wesself2d937f2008-04-17 20:05:37 +0200372 mutex_lock(&tty_mutex);
373 /* Search through the tty devices to look for a match */
374 list_for_each_entry(p, &tty_drivers, tty_drivers) {
Jason Wessel0dca0fd2008-09-26 10:36:42 -0500375 if (strncmp(name, p->name, len) != 0)
376 continue;
Alan Cox5f0878a2009-06-11 12:46:41 +0100377 stp = str;
378 if (*stp == ',')
379 stp++;
380 if (*stp == '\0')
381 stp = NULL;
Jason Wesself2d937f2008-04-17 20:05:37 +0200382
Nathael Pajani6eb68d62010-09-02 16:06:16 +0200383 if (tty_line >= 0 && tty_line < p->num && p->ops &&
Alan Cox5f0878a2009-06-11 12:46:41 +0100384 p->ops->poll_init && !p->ops->poll_init(p, tty_line, stp)) {
Alan Cox7d7b93c2008-10-13 10:42:09 +0100385 res = tty_driver_kref_get(p);
Jason Wesself2d937f2008-04-17 20:05:37 +0200386 *line = tty_line;
387 break;
388 }
389 }
390 mutex_unlock(&tty_mutex);
391
392 return res;
393}
394EXPORT_SYMBOL_GPL(tty_find_polling_driver);
395#endif
396
Alan Coxaf9b8972006-08-27 01:24:01 -0700397/**
398 * tty_check_change - check for POSIX terminal changes
399 * @tty: tty to check
400 *
401 * If we try to write to, or set the state of, a terminal and we're
402 * not in the foreground, send a SIGTTOU. If the signal is blocked or
403 * ignored, go ahead and perform the operation. (POSIX 7.2)
404 *
Alan Cox978e5952008-04-30 00:53:59 -0700405 * Locking: ctrl_lock
Linus Torvalds1da177e2005-04-16 15:20:36 -0700406 */
Alan Coxaf9b8972006-08-27 01:24:01 -0700407
Alan Cox37bdfb02008-02-08 04:18:47 -0800408int tty_check_change(struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700409{
Alan Cox47f86832008-04-30 00:53:30 -0700410 unsigned long flags;
411 int ret = 0;
412
Linus Torvalds1da177e2005-04-16 15:20:36 -0700413 if (current->signal->tty != tty)
414 return 0;
Alan Cox47f86832008-04-30 00:53:30 -0700415
416 spin_lock_irqsave(&tty->ctrl_lock, flags);
417
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800418 if (!tty->pgrp) {
419 printk(KERN_WARNING "tty_check_change: tty->pgrp == NULL!\n");
Andrew Morton9ffee4c2008-05-14 16:05:58 -0700420 goto out_unlock;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700421 }
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800422 if (task_pgrp(current) == tty->pgrp)
Andrew Morton9ffee4c2008-05-14 16:05:58 -0700423 goto out_unlock;
424 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700425 if (is_ignored(SIGTTOU))
Alan Cox47f86832008-04-30 00:53:30 -0700426 goto out;
427 if (is_current_pgrp_orphaned()) {
428 ret = -EIO;
429 goto out;
430 }
Oleg Nesterov040b6362007-06-01 00:46:53 -0700431 kill_pgrp(task_pgrp(current), SIGTTOU, 1);
432 set_thread_flag(TIF_SIGPENDING);
Alan Cox47f86832008-04-30 00:53:30 -0700433 ret = -ERESTARTSYS;
434out:
Andrew Morton9ffee4c2008-05-14 16:05:58 -0700435 return ret;
436out_unlock:
Alan Cox47f86832008-04-30 00:53:30 -0700437 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
438 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700439}
440
441EXPORT_SYMBOL(tty_check_change);
442
Alan Cox37bdfb02008-02-08 04:18:47 -0800443static ssize_t hung_up_tty_read(struct file *file, char __user *buf,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700444 size_t count, loff_t *ppos)
445{
446 return 0;
447}
448
Alan Cox37bdfb02008-02-08 04:18:47 -0800449static ssize_t hung_up_tty_write(struct file *file, const char __user *buf,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700450 size_t count, loff_t *ppos)
451{
452 return -EIO;
453}
454
455/* No kernel lock held - none needed ;) */
Alan Cox37bdfb02008-02-08 04:18:47 -0800456static unsigned int hung_up_tty_poll(struct file *filp, poll_table *wait)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700457{
458 return POLLIN | POLLOUT | POLLERR | POLLHUP | POLLRDNORM | POLLWRNORM;
459}
460
Alan Cox04f378b2008-04-30 00:53:29 -0700461static long hung_up_tty_ioctl(struct file *file, unsigned int cmd,
462 unsigned long arg)
Paul Fulghum38ad2ed2007-06-16 10:15:55 -0700463{
464 return cmd == TIOCSPGRP ? -ENOTTY : -EIO;
465}
466
Alan Cox37bdfb02008-02-08 04:18:47 -0800467static long hung_up_tty_compat_ioctl(struct file *file,
Paul Fulghum38ad2ed2007-06-16 10:15:55 -0700468 unsigned int cmd, unsigned long arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700469{
470 return cmd == TIOCSPGRP ? -ENOTTY : -EIO;
471}
472
Arjan van de Ven62322d22006-07-03 00:24:21 -0700473static const struct file_operations tty_fops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700474 .llseek = no_llseek,
475 .read = tty_read,
476 .write = tty_write,
477 .poll = tty_poll,
Alan Cox04f378b2008-04-30 00:53:29 -0700478 .unlocked_ioctl = tty_ioctl,
Paul Fulghume10cc1d2007-05-10 22:22:50 -0700479 .compat_ioctl = tty_compat_ioctl,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700480 .open = tty_open,
481 .release = tty_release,
482 .fasync = tty_fasync,
483};
484
Arjan van de Ven62322d22006-07-03 00:24:21 -0700485static const struct file_operations console_fops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700486 .llseek = no_llseek,
487 .read = tty_read,
488 .write = redirected_tty_write,
489 .poll = tty_poll,
Alan Cox04f378b2008-04-30 00:53:29 -0700490 .unlocked_ioctl = tty_ioctl,
Paul Fulghume10cc1d2007-05-10 22:22:50 -0700491 .compat_ioctl = tty_compat_ioctl,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700492 .open = tty_open,
493 .release = tty_release,
494 .fasync = tty_fasync,
495};
496
Arjan van de Ven62322d22006-07-03 00:24:21 -0700497static const struct file_operations hung_up_tty_fops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700498 .llseek = no_llseek,
499 .read = hung_up_tty_read,
500 .write = hung_up_tty_write,
501 .poll = hung_up_tty_poll,
Alan Cox04f378b2008-04-30 00:53:29 -0700502 .unlocked_ioctl = hung_up_tty_ioctl,
Paul Fulghum38ad2ed2007-06-16 10:15:55 -0700503 .compat_ioctl = hung_up_tty_compat_ioctl,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700504 .release = tty_release,
505};
506
507static DEFINE_SPINLOCK(redirect_lock);
508static struct file *redirect;
509
510/**
511 * tty_wakeup - request more data
512 * @tty: terminal
513 *
514 * Internal and external helper for wakeups of tty. This function
515 * informs the line discipline if present that the driver is ready
516 * to receive more output data.
517 */
Alan Cox37bdfb02008-02-08 04:18:47 -0800518
Linus Torvalds1da177e2005-04-16 15:20:36 -0700519void tty_wakeup(struct tty_struct *tty)
520{
521 struct tty_ldisc *ld;
Alan Cox37bdfb02008-02-08 04:18:47 -0800522
Linus Torvalds1da177e2005-04-16 15:20:36 -0700523 if (test_bit(TTY_DO_WRITE_WAKEUP, &tty->flags)) {
524 ld = tty_ldisc_ref(tty);
Alan Cox37bdfb02008-02-08 04:18:47 -0800525 if (ld) {
Alan Coxa352def2008-07-16 21:53:12 +0100526 if (ld->ops->write_wakeup)
527 ld->ops->write_wakeup(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700528 tty_ldisc_deref(ld);
529 }
530 }
Davide Libenzi4b194492009-03-31 15:24:24 -0700531 wake_up_interruptible_poll(&tty->write_wait, POLLOUT);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700532}
533
534EXPORT_SYMBOL_GPL(tty_wakeup);
535
536/**
Arnd Bergmann11dbf202010-06-18 14:58:07 +0200537 * __tty_hangup - actual handler for hangup events
David Howells65f27f32006-11-22 14:55:48 +0000538 * @work: tty device
Alan Coxaf9b8972006-08-27 01:24:01 -0700539 *
Alan Cox1bad8792008-07-22 23:38:04 +0100540 * This can be called by the "eventd" kernel thread. That is process
Alan Coxaf9b8972006-08-27 01:24:01 -0700541 * synchronous but doesn't hold any locks, so we need to make sure we
542 * have the appropriate locks for what we're doing.
543 *
544 * The hangup event clears any pending redirections onto the hung up
545 * device. It ensures future writes will error and it does the needed
546 * line discipline hangup and signal delivery. The tty object itself
547 * remains intact.
548 *
549 * Locking:
Arnd Bergmannec79d602010-06-01 22:53:01 +0200550 * BTM
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800551 * redirect lock for undoing redirection
552 * file list lock for manipulating list of ttys
553 * tty_ldisc_lock from called functions
554 * termios_mutex resetting termios data
555 * tasklist_lock to walk task list for hangup event
556 * ->siglock to protect ->signal/->sighand
Linus Torvalds1da177e2005-04-16 15:20:36 -0700557 */
Arnd Bergmann11dbf202010-06-18 14:58:07 +0200558void __tty_hangup(struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700559{
Alan Cox37bdfb02008-02-08 04:18:47 -0800560 struct file *cons_filp = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700561 struct file *filp, *f = NULL;
562 struct task_struct *p;
Nick Piggind996b622010-08-18 04:37:36 +1000563 struct tty_file_private *priv;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700564 int closecount = 0, n;
Alan Cox47f86832008-04-30 00:53:30 -0700565 unsigned long flags;
Alan Cox9c9f4de2008-10-13 10:37:26 +0100566 int refs = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700567
568 if (!tty)
569 return;
570
Linus Torvalds1da177e2005-04-16 15:20:36 -0700571
572 spin_lock(&redirect_lock);
Nick Piggind996b622010-08-18 04:37:36 +1000573 if (redirect && file_tty(redirect) == tty) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700574 f = redirect;
575 redirect = NULL;
576 }
577 spin_unlock(&redirect_lock);
Alan Cox37bdfb02008-02-08 04:18:47 -0800578
Alan Cox89c8d912012-08-08 16:30:13 +0100579 tty_lock(tty);
Arnd Bergmann11dbf202010-06-18 14:58:07 +0200580
Jiri Slabyacfa7472010-11-29 10:16:54 +0100581 /* some functions below drop BTM, so we need this bit */
582 set_bit(TTY_HUPPING, &tty->flags);
583
Arnd Bergmannec79d602010-06-01 22:53:01 +0200584 /* inuse_filps is protected by the single tty lock,
585 this really needs to change if we want to flush the
586 workqueue with the lock held */
Arnd Bergmann11dbf202010-06-18 14:58:07 +0200587 check_tty_count(tty, "tty_hangup");
Alan Cox36ba7822009-11-30 13:18:51 +0000588
Nick Pigginee2ffa02010-08-18 04:37:35 +1000589 spin_lock(&tty_files_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700590 /* This breaks for file handles being sent over AF_UNIX sockets ? */
Nick Piggind996b622010-08-18 04:37:36 +1000591 list_for_each_entry(priv, &tty->tty_files, list) {
592 filp = priv->file;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700593 if (filp->f_op->write == redirected_tty_write)
594 cons_filp = filp;
595 if (filp->f_op->write != tty_write)
596 continue;
597 closecount++;
Arnd Bergmannec79d602010-06-01 22:53:01 +0200598 __tty_fasync(-1, filp, 0); /* can't block */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700599 filp->f_op = &hung_up_tty_fops;
600 }
Nick Pigginee2ffa02010-08-18 04:37:35 +1000601 spin_unlock(&tty_files_lock);
Alan Cox37bdfb02008-02-08 04:18:47 -0800602
Jiri Slabyacfa7472010-11-29 10:16:54 +0100603 /*
604 * it drops BTM and thus races with reopen
605 * we protect the race by TTY_HUPPING
606 */
Alan Coxc65c9bc2009-06-11 12:50:12 +0100607 tty_ldisc_hangup(tty);
Alan Cox37bdfb02008-02-08 04:18:47 -0800608
Linus Torvalds1da177e2005-04-16 15:20:36 -0700609 read_lock(&tasklist_lock);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800610 if (tty->session) {
611 do_each_pid_task(tty->session, PIDTYPE_SID, p) {
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800612 spin_lock_irq(&p->sighand->siglock);
Alan Cox9c9f4de2008-10-13 10:37:26 +0100613 if (p->signal->tty == tty) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700614 p->signal->tty = NULL;
Alan Cox9c9f4de2008-10-13 10:37:26 +0100615 /* We defer the dereferences outside fo
616 the tasklist lock */
617 refs++;
618 }
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800619 if (!p->signal->leader) {
620 spin_unlock_irq(&p->sighand->siglock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700621 continue;
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800622 }
623 __group_send_sig_info(SIGHUP, SEND_SIG_PRIV, p);
624 __group_send_sig_info(SIGCONT, SEND_SIG_PRIV, p);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800625 put_pid(p->signal->tty_old_pgrp); /* A noop */
Alan Cox47f86832008-04-30 00:53:30 -0700626 spin_lock_irqsave(&tty->ctrl_lock, flags);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800627 if (tty->pgrp)
628 p->signal->tty_old_pgrp = get_pid(tty->pgrp);
Alan Cox47f86832008-04-30 00:53:30 -0700629 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800630 spin_unlock_irq(&p->sighand->siglock);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800631 } while_each_pid_task(tty->session, PIDTYPE_SID, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700632 }
633 read_unlock(&tasklist_lock);
634
Alan Cox47f86832008-04-30 00:53:30 -0700635 spin_lock_irqsave(&tty->ctrl_lock, flags);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100636 clear_bit(TTY_THROTTLED, &tty->flags);
637 clear_bit(TTY_PUSH, &tty->flags);
638 clear_bit(TTY_DO_WRITE_WAKEUP, &tty->flags);
Eric W. Biedermand9c1e9a2007-03-18 12:45:44 -0600639 put_pid(tty->session);
640 put_pid(tty->pgrp);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800641 tty->session = NULL;
642 tty->pgrp = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700643 tty->ctrl_status = 0;
Alan Cox47f86832008-04-30 00:53:30 -0700644 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
645
Alan Cox9c9f4de2008-10-13 10:37:26 +0100646 /* Account for the p->signal references we killed */
647 while (refs--)
648 tty_kref_put(tty);
649
Linus Torvalds1da177e2005-04-16 15:20:36 -0700650 /*
Alan Cox37bdfb02008-02-08 04:18:47 -0800651 * If one of the devices matches a console pointer, we
652 * cannot just call hangup() because that will cause
653 * tty->count and state->count to go out of sync.
654 * So we just call close() the right number of times.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700655 */
656 if (cons_filp) {
Alan Coxf34d7a52008-04-30 00:54:13 -0700657 if (tty->ops->close)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700658 for (n = 0; n < closecount; n++)
Alan Coxf34d7a52008-04-30 00:54:13 -0700659 tty->ops->close(tty, cons_filp);
660 } else if (tty->ops->hangup)
661 (tty->ops->hangup)(tty);
Alan Cox37bdfb02008-02-08 04:18:47 -0800662 /*
663 * We don't want to have driver/ldisc interactions beyond
664 * the ones we did here. The driver layer expects no
665 * calls after ->hangup() from the ldisc side. However we
666 * can't yet guarantee all that.
667 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700668 set_bit(TTY_HUPPED, &tty->flags);
Jiri Slabyacfa7472010-11-29 10:16:54 +0100669 clear_bit(TTY_HUPPING, &tty->flags);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100670 tty_ldisc_enable(tty);
Arnd Bergmann11dbf202010-06-18 14:58:07 +0200671
Alan Cox89c8d912012-08-08 16:30:13 +0100672 tty_unlock(tty);
Arnd Bergmann11dbf202010-06-18 14:58:07 +0200673
Linus Torvalds1da177e2005-04-16 15:20:36 -0700674 if (f)
675 fput(f);
676}
677
Arnd Bergmannddcd9fb2010-06-01 22:53:08 +0200678static void do_tty_hangup(struct work_struct *work)
679{
680 struct tty_struct *tty =
681 container_of(work, struct tty_struct, hangup_work);
682
Arnd Bergmann11dbf202010-06-18 14:58:07 +0200683 __tty_hangup(tty);
Arnd Bergmannddcd9fb2010-06-01 22:53:08 +0200684}
685
Alan Coxaf9b8972006-08-27 01:24:01 -0700686/**
687 * tty_hangup - trigger a hangup event
688 * @tty: tty to hangup
689 *
690 * A carrier loss (virtual or otherwise) has occurred on this like
691 * schedule a hangup sequence to run after this event.
692 */
693
Alan Cox37bdfb02008-02-08 04:18:47 -0800694void tty_hangup(struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700695{
696#ifdef TTY_DEBUG_HANGUP
697 char buf[64];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700698 printk(KERN_DEBUG "%s hangup...\n", tty_name(tty, buf));
699#endif
700 schedule_work(&tty->hangup_work);
701}
702
703EXPORT_SYMBOL(tty_hangup);
704
Alan Coxaf9b8972006-08-27 01:24:01 -0700705/**
706 * tty_vhangup - process vhangup
707 * @tty: tty to hangup
708 *
709 * The user has asked via system call for the terminal to be hung up.
710 * We do this synchronously so that when the syscall returns the process
Robert P. J. Day3a4fa0a2007-10-19 23:10:43 +0200711 * is complete. That guarantee is necessary for security reasons.
Alan Coxaf9b8972006-08-27 01:24:01 -0700712 */
713
Alan Cox37bdfb02008-02-08 04:18:47 -0800714void tty_vhangup(struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700715{
716#ifdef TTY_DEBUG_HANGUP
717 char buf[64];
718
719 printk(KERN_DEBUG "%s vhangup...\n", tty_name(tty, buf));
720#endif
Arnd Bergmann11dbf202010-06-18 14:58:07 +0200721 __tty_hangup(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700722}
Alan Cox37bdfb02008-02-08 04:18:47 -0800723
Linus Torvalds1da177e2005-04-16 15:20:36 -0700724EXPORT_SYMBOL(tty_vhangup);
725
Arnd Bergmann11dbf202010-06-18 14:58:07 +0200726
Alan Coxaf9b8972006-08-27 01:24:01 -0700727/**
Alan Cox2cb59982008-10-13 10:40:30 +0100728 * tty_vhangup_self - process vhangup for own ctty
729 *
730 * Perform a vhangup on the current controlling tty
731 */
732
733void tty_vhangup_self(void)
734{
735 struct tty_struct *tty;
736
Alan Cox2cb59982008-10-13 10:40:30 +0100737 tty = get_current_tty();
738 if (tty) {
739 tty_vhangup(tty);
740 tty_kref_put(tty);
741 }
Alan Cox2cb59982008-10-13 10:40:30 +0100742}
743
744/**
Alan Coxaf9b8972006-08-27 01:24:01 -0700745 * tty_hung_up_p - was tty hung up
746 * @filp: file pointer of tty
747 *
748 * Return true if the tty has been subject to a vhangup or a carrier
749 * loss
750 */
751
Alan Cox37bdfb02008-02-08 04:18:47 -0800752int tty_hung_up_p(struct file *filp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700753{
754 return (filp->f_op == &hung_up_tty_fops);
755}
756
757EXPORT_SYMBOL(tty_hung_up_p);
758
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800759static void session_clear_tty(struct pid *session)
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800760{
761 struct task_struct *p;
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800762 do_each_pid_task(session, PIDTYPE_SID, p) {
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800763 proc_clear_tty(p);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800764 } while_each_pid_task(session, PIDTYPE_SID, p);
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800765}
766
Alan Coxaf9b8972006-08-27 01:24:01 -0700767/**
768 * disassociate_ctty - disconnect controlling tty
769 * @on_exit: true if exiting so need to "hang up" the session
Linus Torvalds1da177e2005-04-16 15:20:36 -0700770 *
Alan Coxaf9b8972006-08-27 01:24:01 -0700771 * This function is typically called only by the session leader, when
772 * it wants to disassociate itself from its controlling tty.
773 *
774 * It performs the following functions:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700775 * (1) Sends a SIGHUP and SIGCONT to the foreground process group
776 * (2) Clears the tty from being controlling the session
777 * (3) Clears the controlling tty for all processes in the
778 * session group.
779 *
Alan Coxaf9b8972006-08-27 01:24:01 -0700780 * The argument on_exit is set to 1 if called when a process is
781 * exiting; it is 0 if called by the ioctl TIOCNOTTY.
782 *
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800783 * Locking:
Arnd Bergmannec79d602010-06-01 22:53:01 +0200784 * BTM is taken for hysterical raisins, and held when
785 * called from no_tty().
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800786 * tty_mutex is taken to protect tty
787 * ->siglock is taken to protect ->signal/->sighand
788 * tasklist_lock is taken to walk process list for sessions
789 * ->siglock is taken to protect ->signal/->sighand
Linus Torvalds1da177e2005-04-16 15:20:36 -0700790 */
Alan Coxaf9b8972006-08-27 01:24:01 -0700791
Linus Torvalds1da177e2005-04-16 15:20:36 -0700792void disassociate_ctty(int on_exit)
793{
794 struct tty_struct *tty;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700795
Alan Cox5ec93d12009-11-30 13:18:45 +0000796 if (!current->signal->leader)
797 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700798
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800799 tty = get_current_tty();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700800 if (tty) {
Jiri Slaby1411dc42011-11-09 21:33:18 +0100801 struct pid *tty_pgrp = get_pid(tty->pgrp);
Arnd Bergmannddcd9fb2010-06-01 22:53:08 +0200802 if (on_exit) {
Arnd Bergmannddcd9fb2010-06-01 22:53:08 +0200803 if (tty->driver->type != TTY_DRIVER_TYPE_PTY)
Arnd Bergmann11dbf202010-06-18 14:58:07 +0200804 tty_vhangup(tty);
Arnd Bergmannddcd9fb2010-06-01 22:53:08 +0200805 }
Alan Cox452a00d2008-10-13 10:39:13 +0100806 tty_kref_put(tty);
Jiri Slaby1411dc42011-11-09 21:33:18 +0100807 if (tty_pgrp) {
808 kill_pgrp(tty_pgrp, SIGHUP, on_exit);
809 if (!on_exit)
810 kill_pgrp(tty_pgrp, SIGCONT, on_exit);
811 put_pid(tty_pgrp);
812 }
Eric W. Biederman680a9672007-02-12 00:52:52 -0800813 } else if (on_exit) {
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800814 struct pid *old_pgrp;
Eric W. Biederman680a9672007-02-12 00:52:52 -0800815 spin_lock_irq(&current->sighand->siglock);
816 old_pgrp = current->signal->tty_old_pgrp;
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800817 current->signal->tty_old_pgrp = NULL;
Eric W. Biederman680a9672007-02-12 00:52:52 -0800818 spin_unlock_irq(&current->sighand->siglock);
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800819 if (old_pgrp) {
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800820 kill_pgrp(old_pgrp, SIGHUP, on_exit);
821 kill_pgrp(old_pgrp, SIGCONT, on_exit);
822 put_pid(old_pgrp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700823 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700824 return;
825 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700826
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800827 spin_lock_irq(&current->sighand->siglock);
Eric W. Biederman2a65f1d2007-05-08 00:26:53 -0700828 put_pid(current->signal->tty_old_pgrp);
Randy Dunlap23cac8d2007-02-20 13:58:05 -0800829 current->signal->tty_old_pgrp = NULL;
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800830 spin_unlock_irq(&current->sighand->siglock);
831
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800832 tty = get_current_tty();
833 if (tty) {
Alan Cox47f86832008-04-30 00:53:30 -0700834 unsigned long flags;
835 spin_lock_irqsave(&tty->ctrl_lock, flags);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800836 put_pid(tty->session);
837 put_pid(tty->pgrp);
838 tty->session = NULL;
839 tty->pgrp = NULL;
Alan Cox47f86832008-04-30 00:53:30 -0700840 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
Alan Cox452a00d2008-10-13 10:39:13 +0100841 tty_kref_put(tty);
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800842 } else {
843#ifdef TTY_DEBUG_HANGUP
844 printk(KERN_DEBUG "error attempted to write to tty [0x%p]"
845 " = NULL", tty);
846#endif
847 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700848
849 /* Now clear signal->tty under the lock */
850 read_lock(&tasklist_lock);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800851 session_clear_tty(task_session(current));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700852 read_unlock(&tasklist_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700853}
854
Eric W. Biederman98a27ba2007-05-08 00:26:56 -0700855/**
856 *
857 * no_tty - Ensure the current process does not have a controlling tty
858 */
859void no_tty(void)
860{
Alan Cox3af502b2012-05-03 22:21:53 +0100861 /* FIXME: Review locking here. The tty_lock never covered any race
862 between a new association and proc_clear_tty but possible we need
863 to protect against this anyway */
Eric W. Biederman98a27ba2007-05-08 00:26:56 -0700864 struct task_struct *tsk = current;
Alan Cox5ec93d12009-11-30 13:18:45 +0000865 disassociate_ctty(0);
Eric W. Biederman98a27ba2007-05-08 00:26:56 -0700866 proc_clear_tty(tsk);
867}
868
Alan Coxaf9b8972006-08-27 01:24:01 -0700869
870/**
Robert P. J. Daybeb7dd82007-05-09 07:14:03 +0200871 * stop_tty - propagate flow control
Alan Coxaf9b8972006-08-27 01:24:01 -0700872 * @tty: tty to stop
873 *
874 * Perform flow control to the driver. For PTY/TTY pairs we
Robert P. J. Daybeb7dd82007-05-09 07:14:03 +0200875 * must also propagate the TIOCKPKT status. May be called
Alan Coxaf9b8972006-08-27 01:24:01 -0700876 * on an already stopped device and will not re-call the driver
877 * method.
878 *
879 * This functionality is used by both the line disciplines for
880 * halting incoming flow and by the driver. It may therefore be
881 * called from any context, may be under the tty atomic_write_lock
882 * but not always.
883 *
884 * Locking:
Alan Cox04f378b2008-04-30 00:53:29 -0700885 * Uses the tty control lock internally
Alan Coxaf9b8972006-08-27 01:24:01 -0700886 */
887
Linus Torvalds1da177e2005-04-16 15:20:36 -0700888void stop_tty(struct tty_struct *tty)
889{
Alan Cox04f378b2008-04-30 00:53:29 -0700890 unsigned long flags;
891 spin_lock_irqsave(&tty->ctrl_lock, flags);
892 if (tty->stopped) {
893 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700894 return;
Alan Cox04f378b2008-04-30 00:53:29 -0700895 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700896 tty->stopped = 1;
897 if (tty->link && tty->link->packet) {
898 tty->ctrl_status &= ~TIOCPKT_START;
899 tty->ctrl_status |= TIOCPKT_STOP;
Davide Libenzi4b194492009-03-31 15:24:24 -0700900 wake_up_interruptible_poll(&tty->link->read_wait, POLLIN);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700901 }
Alan Cox04f378b2008-04-30 00:53:29 -0700902 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
Alan Coxf34d7a52008-04-30 00:54:13 -0700903 if (tty->ops->stop)
904 (tty->ops->stop)(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700905}
906
907EXPORT_SYMBOL(stop_tty);
908
Alan Coxaf9b8972006-08-27 01:24:01 -0700909/**
Robert P. J. Daybeb7dd82007-05-09 07:14:03 +0200910 * start_tty - propagate flow control
Alan Coxaf9b8972006-08-27 01:24:01 -0700911 * @tty: tty to start
912 *
913 * Start a tty that has been stopped if at all possible. Perform
Robert P. J. Day3a4fa0a2007-10-19 23:10:43 +0200914 * any necessary wakeups and propagate the TIOCPKT status. If this
Alan Coxaf9b8972006-08-27 01:24:01 -0700915 * is the tty was previous stopped and is being started then the
916 * driver start method is invoked and the line discipline woken.
917 *
918 * Locking:
Alan Cox04f378b2008-04-30 00:53:29 -0700919 * ctrl_lock
Alan Coxaf9b8972006-08-27 01:24:01 -0700920 */
921
Linus Torvalds1da177e2005-04-16 15:20:36 -0700922void start_tty(struct tty_struct *tty)
923{
Alan Cox04f378b2008-04-30 00:53:29 -0700924 unsigned long flags;
925 spin_lock_irqsave(&tty->ctrl_lock, flags);
926 if (!tty->stopped || tty->flow_stopped) {
927 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700928 return;
Alan Cox04f378b2008-04-30 00:53:29 -0700929 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700930 tty->stopped = 0;
931 if (tty->link && tty->link->packet) {
932 tty->ctrl_status &= ~TIOCPKT_STOP;
933 tty->ctrl_status |= TIOCPKT_START;
Davide Libenzi4b194492009-03-31 15:24:24 -0700934 wake_up_interruptible_poll(&tty->link->read_wait, POLLIN);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700935 }
Alan Cox04f378b2008-04-30 00:53:29 -0700936 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
Alan Coxf34d7a52008-04-30 00:54:13 -0700937 if (tty->ops->start)
938 (tty->ops->start)(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700939 /* If we have a running line discipline it may need kicking */
940 tty_wakeup(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700941}
942
943EXPORT_SYMBOL(start_tty);
944
Alan Coxaf9b8972006-08-27 01:24:01 -0700945/**
946 * tty_read - read method for tty device files
947 * @file: pointer to tty file
948 * @buf: user buffer
949 * @count: size of user buffer
950 * @ppos: unused
951 *
952 * Perform the read system call function on this terminal device. Checks
953 * for hung up devices before calling the line discipline method.
954 *
955 * Locking:
Alan Cox47f86832008-04-30 00:53:30 -0700956 * Locks the line discipline internally while needed. Multiple
957 * read calls may be outstanding in parallel.
Alan Coxaf9b8972006-08-27 01:24:01 -0700958 */
959
Alan Cox37bdfb02008-02-08 04:18:47 -0800960static ssize_t tty_read(struct file *file, char __user *buf, size_t count,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700961 loff_t *ppos)
962{
963 int i;
Nick Piggind996b622010-08-18 04:37:36 +1000964 struct inode *inode = file->f_path.dentry->d_inode;
965 struct tty_struct *tty = file_tty(file);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700966 struct tty_ldisc *ld;
967
Linus Torvalds1da177e2005-04-16 15:20:36 -0700968 if (tty_paranoia_check(tty, inode, "tty_read"))
969 return -EIO;
970 if (!tty || (test_bit(TTY_IO_ERROR, &tty->flags)))
971 return -EIO;
972
973 /* We want to wait for the line discipline to sort out in this
974 situation */
975 ld = tty_ldisc_ref_wait(tty);
Alan Coxa352def2008-07-16 21:53:12 +0100976 if (ld->ops->read)
977 i = (ld->ops->read)(tty, file, buf, count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700978 else
979 i = -EIO;
980 tty_ldisc_deref(ld);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700981 if (i > 0)
982 inode->i_atime = current_fs_time(inode->i_sb);
983 return i;
984}
985
Alan Cox9c1729d2007-07-15 23:39:43 -0700986void tty_write_unlock(struct tty_struct *tty)
Jiri Slaby83c67572011-04-20 10:43:18 +0200987 __releases(&tty->atomic_write_lock)
Alan Cox9c1729d2007-07-15 23:39:43 -0700988{
989 mutex_unlock(&tty->atomic_write_lock);
Davide Libenzi4b194492009-03-31 15:24:24 -0700990 wake_up_interruptible_poll(&tty->write_wait, POLLOUT);
Alan Cox9c1729d2007-07-15 23:39:43 -0700991}
992
993int tty_write_lock(struct tty_struct *tty, int ndelay)
Jiri Slaby83c67572011-04-20 10:43:18 +0200994 __acquires(&tty->atomic_write_lock)
Alan Cox9c1729d2007-07-15 23:39:43 -0700995{
996 if (!mutex_trylock(&tty->atomic_write_lock)) {
997 if (ndelay)
998 return -EAGAIN;
999 if (mutex_lock_interruptible(&tty->atomic_write_lock))
1000 return -ERESTARTSYS;
1001 }
1002 return 0;
1003}
1004
Linus Torvalds1da177e2005-04-16 15:20:36 -07001005/*
1006 * Split writes up in sane blocksizes to avoid
1007 * denial-of-service type attacks
1008 */
1009static inline ssize_t do_tty_write(
1010 ssize_t (*write)(struct tty_struct *, struct file *, const unsigned char *, size_t),
1011 struct tty_struct *tty,
1012 struct file *file,
1013 const char __user *buf,
1014 size_t count)
1015{
Alan Cox9c1729d2007-07-15 23:39:43 -07001016 ssize_t ret, written = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001017 unsigned int chunk;
Alan Cox37bdfb02008-02-08 04:18:47 -08001018
Alan Cox9c1729d2007-07-15 23:39:43 -07001019 ret = tty_write_lock(tty, file->f_flags & O_NDELAY);
1020 if (ret < 0)
1021 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001022
1023 /*
1024 * We chunk up writes into a temporary buffer. This
1025 * simplifies low-level drivers immensely, since they
1026 * don't have locking issues and user mode accesses.
1027 *
1028 * But if TTY_NO_WRITE_SPLIT is set, we should use a
1029 * big chunk-size..
1030 *
1031 * The default chunk-size is 2kB, because the NTTY
1032 * layer has problems with bigger chunks. It will
1033 * claim to be able to handle more characters than
1034 * it actually does.
Alan Coxaf9b8972006-08-27 01:24:01 -07001035 *
1036 * FIXME: This can probably go away now except that 64K chunks
1037 * are too likely to fail unless switched to vmalloc...
Linus Torvalds1da177e2005-04-16 15:20:36 -07001038 */
1039 chunk = 2048;
1040 if (test_bit(TTY_NO_WRITE_SPLIT, &tty->flags))
1041 chunk = 65536;
1042 if (count < chunk)
1043 chunk = count;
1044
Ingo Molnar70522e12006-03-23 03:00:31 -08001045 /* write_buf/write_cnt is protected by the atomic_write_lock mutex */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001046 if (tty->write_cnt < chunk) {
Jason Wessel402fda92008-10-13 10:45:36 +01001047 unsigned char *buf_chunk;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001048
1049 if (chunk < 1024)
1050 chunk = 1024;
1051
Jason Wessel402fda92008-10-13 10:45:36 +01001052 buf_chunk = kmalloc(chunk, GFP_KERNEL);
1053 if (!buf_chunk) {
Alan Cox9c1729d2007-07-15 23:39:43 -07001054 ret = -ENOMEM;
1055 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001056 }
1057 kfree(tty->write_buf);
1058 tty->write_cnt = chunk;
Jason Wessel402fda92008-10-13 10:45:36 +01001059 tty->write_buf = buf_chunk;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001060 }
1061
1062 /* Do the write .. */
1063 for (;;) {
1064 size_t size = count;
1065 if (size > chunk)
1066 size = chunk;
1067 ret = -EFAULT;
1068 if (copy_from_user(tty->write_buf, buf, size))
1069 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001070 ret = write(tty, file, tty->write_buf, size);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001071 if (ret <= 0)
1072 break;
1073 written += ret;
1074 buf += ret;
1075 count -= ret;
1076 if (!count)
1077 break;
1078 ret = -ERESTARTSYS;
1079 if (signal_pending(current))
1080 break;
1081 cond_resched();
1082 }
1083 if (written) {
Josef Sipeka7113a92006-12-08 02:36:55 -08001084 struct inode *inode = file->f_path.dentry->d_inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001085 inode->i_mtime = current_fs_time(inode->i_sb);
1086 ret = written;
1087 }
Alan Cox9c1729d2007-07-15 23:39:43 -07001088out:
1089 tty_write_unlock(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001090 return ret;
1091}
1092
Alan Cox95f9bfc2008-10-13 10:39:23 +01001093/**
1094 * tty_write_message - write a message to a certain tty, not just the console.
1095 * @tty: the destination tty_struct
1096 * @msg: the message to write
1097 *
1098 * This is used for messages that need to be redirected to a specific tty.
1099 * We don't put it into the syslog queue right now maybe in the future if
1100 * really needed.
1101 *
Arnd Bergmannec79d602010-06-01 22:53:01 +02001102 * We must still hold the BTM and test the CLOSING flag for the moment.
Alan Cox95f9bfc2008-10-13 10:39:23 +01001103 */
1104
1105void tty_write_message(struct tty_struct *tty, char *msg)
1106{
Alan Cox95f9bfc2008-10-13 10:39:23 +01001107 if (tty) {
1108 mutex_lock(&tty->atomic_write_lock);
Alan Cox89c8d912012-08-08 16:30:13 +01001109 tty_lock(tty);
Alan Coxeeb89d92009-11-30 13:18:29 +00001110 if (tty->ops->write && !test_bit(TTY_CLOSING, &tty->flags)) {
Alan Cox89c8d912012-08-08 16:30:13 +01001111 tty_unlock(tty);
Alan Cox95f9bfc2008-10-13 10:39:23 +01001112 tty->ops->write(tty, msg, strlen(msg));
Alan Coxeeb89d92009-11-30 13:18:29 +00001113 } else
Alan Cox89c8d912012-08-08 16:30:13 +01001114 tty_unlock(tty);
Alan Cox95f9bfc2008-10-13 10:39:23 +01001115 tty_write_unlock(tty);
1116 }
Alan Cox95f9bfc2008-10-13 10:39:23 +01001117 return;
1118}
1119
Linus Torvalds1da177e2005-04-16 15:20:36 -07001120
Alan Coxaf9b8972006-08-27 01:24:01 -07001121/**
1122 * tty_write - write method for tty device file
1123 * @file: tty file pointer
1124 * @buf: user data to write
1125 * @count: bytes to write
1126 * @ppos: unused
1127 *
1128 * Write data to a tty device via the line discipline.
1129 *
1130 * Locking:
1131 * Locks the line discipline as required
1132 * Writes to the tty driver are serialized by the atomic_write_lock
1133 * and are then processed in chunks to the device. The line discipline
Joe Petersona88a69c2009-01-02 13:40:53 +00001134 * write method will not be invoked in parallel for each device.
Alan Coxaf9b8972006-08-27 01:24:01 -07001135 */
1136
Alan Cox37bdfb02008-02-08 04:18:47 -08001137static ssize_t tty_write(struct file *file, const char __user *buf,
1138 size_t count, loff_t *ppos)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001139{
Josef Sipeka7113a92006-12-08 02:36:55 -08001140 struct inode *inode = file->f_path.dentry->d_inode;
Nick Piggind996b622010-08-18 04:37:36 +10001141 struct tty_struct *tty = file_tty(file);
1142 struct tty_ldisc *ld;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001143 ssize_t ret;
Alan Cox37bdfb02008-02-08 04:18:47 -08001144
Linus Torvalds1da177e2005-04-16 15:20:36 -07001145 if (tty_paranoia_check(tty, inode, "tty_write"))
1146 return -EIO;
Alan Coxf34d7a52008-04-30 00:54:13 -07001147 if (!tty || !tty->ops->write ||
Alan Cox37bdfb02008-02-08 04:18:47 -08001148 (test_bit(TTY_IO_ERROR, &tty->flags)))
1149 return -EIO;
Alan Coxf34d7a52008-04-30 00:54:13 -07001150 /* Short term debug to catch buggy drivers */
1151 if (tty->ops->write_room == NULL)
1152 printk(KERN_ERR "tty driver %s lacks a write_room method.\n",
1153 tty->driver->name);
Alan Cox37bdfb02008-02-08 04:18:47 -08001154 ld = tty_ldisc_ref_wait(tty);
Alan Coxa352def2008-07-16 21:53:12 +01001155 if (!ld->ops->write)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001156 ret = -EIO;
1157 else
Alan Coxa352def2008-07-16 21:53:12 +01001158 ret = do_tty_write(ld->ops->write, tty, file, buf, count);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001159 tty_ldisc_deref(ld);
1160 return ret;
1161}
1162
Alan Cox37bdfb02008-02-08 04:18:47 -08001163ssize_t redirected_tty_write(struct file *file, const char __user *buf,
1164 size_t count, loff_t *ppos)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001165{
1166 struct file *p = NULL;
1167
1168 spin_lock(&redirect_lock);
Al Virocb0942b2012-08-27 14:48:26 -04001169 if (redirect)
1170 p = get_file(redirect);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001171 spin_unlock(&redirect_lock);
1172
1173 if (p) {
1174 ssize_t res;
1175 res = vfs_write(p, buf, count, &p->f_pos);
1176 fput(p);
1177 return res;
1178 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001179 return tty_write(file, buf, count, ppos);
1180}
1181
1182static char ptychar[] = "pqrstuvwxyzabcde";
1183
Alan Coxaf9b8972006-08-27 01:24:01 -07001184/**
1185 * pty_line_name - generate name for a pty
1186 * @driver: the tty driver in use
1187 * @index: the minor number
1188 * @p: output buffer of at least 6 bytes
1189 *
1190 * Generate a name from a driver reference and write it to the output
1191 * buffer.
1192 *
1193 * Locking: None
1194 */
1195static void pty_line_name(struct tty_driver *driver, int index, char *p)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001196{
1197 int i = index + driver->name_base;
1198 /* ->name is initialized to "ttyp", but "tty" is expected */
1199 sprintf(p, "%s%c%x",
Alan Cox37bdfb02008-02-08 04:18:47 -08001200 driver->subtype == PTY_TYPE_SLAVE ? "tty" : driver->name,
1201 ptychar[i >> 4 & 0xf], i & 0xf);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001202}
1203
Alan Coxaf9b8972006-08-27 01:24:01 -07001204/**
Alan Cox8b0a88d2008-10-13 10:42:19 +01001205 * tty_line_name - generate name for a tty
Alan Coxaf9b8972006-08-27 01:24:01 -07001206 * @driver: the tty driver in use
1207 * @index: the minor number
1208 * @p: output buffer of at least 7 bytes
1209 *
1210 * Generate a name from a driver reference and write it to the output
1211 * buffer.
1212 *
1213 * Locking: None
1214 */
1215static void tty_line_name(struct tty_driver *driver, int index, char *p)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001216{
Jiri Slaby0019b402012-08-08 22:26:43 +02001217 if (driver->flags & TTY_DRIVER_UNNUMBERED_NODE)
1218 strcpy(p, driver->name);
1219 else
1220 sprintf(p, "%s%d", driver->name, index + driver->name_base);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001221}
1222
Alan Cox99f1fe12008-10-13 10:42:00 +01001223/**
1224 * tty_driver_lookup_tty() - find an existing tty, if any
1225 * @driver: the driver for the tty
1226 * @idx: the minor number
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001227 *
Alan Cox99f1fe12008-10-13 10:42:00 +01001228 * Return the tty, if found or ERR_PTR() otherwise.
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001229 *
Alan Cox99f1fe12008-10-13 10:42:00 +01001230 * Locking: tty_mutex must be held. If tty is found, the mutex must
1231 * be held until the 'fast-open' is also done. Will change once we
1232 * have refcounting in the driver and per driver locking
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001233 */
Jason Wessela47d5452009-01-02 13:43:04 +00001234static struct tty_struct *tty_driver_lookup_tty(struct tty_driver *driver,
Sukadev Bhattiprolu15f1a632008-10-13 10:42:59 +01001235 struct inode *inode, int idx)
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001236{
Alan Cox99f1fe12008-10-13 10:42:00 +01001237 if (driver->ops->lookup)
Sukadev Bhattiprolu15f1a632008-10-13 10:42:59 +01001238 return driver->ops->lookup(driver, inode, idx);
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001239
Jiri Slabyd4834262012-03-05 14:51:53 +01001240 return driver->ttys[idx];
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001241}
1242
Alan Cox99f1fe12008-10-13 10:42:00 +01001243/**
Alan Coxbf970ee2008-10-13 10:42:39 +01001244 * tty_init_termios - helper for termios setup
1245 * @tty: the tty to set up
1246 *
1247 * Initialise the termios structures for this tty. Thus runs under
1248 * the tty_mutex currently so we can be relaxed about ordering.
1249 */
1250
1251int tty_init_termios(struct tty_struct *tty)
1252{
Alan Coxfe6e29f2008-10-13 10:44:08 +01001253 struct ktermios *tp;
Alan Coxbf970ee2008-10-13 10:42:39 +01001254 int idx = tty->index;
1255
Alan Cox36b3c072012-07-17 17:06:57 +01001256 if (tty->driver->flags & TTY_DRIVER_RESET_TERMIOS)
1257 tty->termios = tty->driver->init_termios;
1258 else {
1259 /* Check for lazy saved data */
1260 tp = tty->driver->termios[idx];
1261 if (tp != NULL)
1262 tty->termios = *tp;
1263 else
1264 tty->termios = tty->driver->init_termios;
Alan Coxbf970ee2008-10-13 10:42:39 +01001265 }
Alan Coxbf970ee2008-10-13 10:42:39 +01001266 /* Compatibility until drivers always set this */
Alan Coxadc8d742012-07-14 15:31:47 +01001267 tty->termios.c_ispeed = tty_termios_input_baud_rate(&tty->termios);
1268 tty->termios.c_ospeed = tty_termios_baud_rate(&tty->termios);
Alan Coxbf970ee2008-10-13 10:42:39 +01001269 return 0;
1270}
Alan Coxfe1ae7f2009-09-19 13:13:33 -07001271EXPORT_SYMBOL_GPL(tty_init_termios);
Alan Coxbf970ee2008-10-13 10:42:39 +01001272
Jiri Slaby66d450e2012-01-30 21:14:28 +01001273int tty_standard_install(struct tty_driver *driver, struct tty_struct *tty)
1274{
1275 int ret = tty_init_termios(tty);
1276 if (ret)
1277 return ret;
1278
1279 tty_driver_kref_get(driver);
1280 tty->count++;
1281 driver->ttys[tty->index] = tty;
1282 return 0;
1283}
1284EXPORT_SYMBOL_GPL(tty_standard_install);
1285
Alan Coxbf970ee2008-10-13 10:42:39 +01001286/**
Alan Cox8b0a88d2008-10-13 10:42:19 +01001287 * tty_driver_install_tty() - install a tty entry in the driver
1288 * @driver: the driver for the tty
1289 * @tty: the tty
1290 *
1291 * Install a tty object into the driver tables. The tty->index field
Alan Coxbf970ee2008-10-13 10:42:39 +01001292 * will be set by the time this is called. This method is responsible
1293 * for ensuring any need additional structures are allocated and
1294 * configured.
Alan Cox8b0a88d2008-10-13 10:42:19 +01001295 *
1296 * Locking: tty_mutex for now
1297 */
1298static int tty_driver_install_tty(struct tty_driver *driver,
1299 struct tty_struct *tty)
1300{
Jiri Slaby66d450e2012-01-30 21:14:28 +01001301 return driver->ops->install ? driver->ops->install(driver, tty) :
1302 tty_standard_install(driver, tty);
Alan Cox8b0a88d2008-10-13 10:42:19 +01001303}
1304
1305/**
1306 * tty_driver_remove_tty() - remove a tty from the driver tables
1307 * @driver: the driver for the tty
1308 * @idx: the minor number
1309 *
1310 * Remvoe a tty object from the driver tables. The tty->index field
1311 * will be set by the time this is called.
1312 *
1313 * Locking: tty_mutex for now
1314 */
Jiri Slaby24d406a2011-08-10 14:59:28 +02001315void tty_driver_remove_tty(struct tty_driver *driver, struct tty_struct *tty)
Alan Cox8b0a88d2008-10-13 10:42:19 +01001316{
1317 if (driver->ops->remove)
1318 driver->ops->remove(driver, tty);
1319 else
1320 driver->ttys[tty->index] = NULL;
1321}
1322
1323/*
1324 * tty_reopen() - fast re-open of an open tty
1325 * @tty - the tty to open
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001326 *
Alan Cox99f1fe12008-10-13 10:42:00 +01001327 * Return 0 on success, -errno on error.
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001328 *
Alan Cox99f1fe12008-10-13 10:42:00 +01001329 * Locking: tty_mutex must be held from the time the tty was found
1330 * till this open completes.
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001331 */
Alan Cox99f1fe12008-10-13 10:42:00 +01001332static int tty_reopen(struct tty_struct *tty)
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001333{
1334 struct tty_driver *driver = tty->driver;
1335
Jiri Slabye2efafb2010-11-29 10:16:53 +01001336 if (test_bit(TTY_CLOSING, &tty->flags) ||
Jiri Slabyacfa7472010-11-29 10:16:54 +01001337 test_bit(TTY_HUPPING, &tty->flags) ||
Jiri Slabye2efafb2010-11-29 10:16:53 +01001338 test_bit(TTY_LDISC_CHANGING, &tty->flags))
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001339 return -EIO;
1340
1341 if (driver->type == TTY_DRIVER_TYPE_PTY &&
1342 driver->subtype == PTY_TYPE_MASTER) {
1343 /*
1344 * special case for PTY masters: only one open permitted,
1345 * and the slave side open count is incremented as well.
1346 */
1347 if (tty->count)
1348 return -EIO;
1349
1350 tty->link->count++;
1351 }
1352 tty->count++;
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001353
Alan Cox1aa4bed2009-06-16 17:01:33 +01001354 mutex_lock(&tty->ldisc_mutex);
Alan Cox99f1fe12008-10-13 10:42:00 +01001355 WARN_ON(!test_bit(TTY_LDISC, &tty->flags));
Alan Cox1aa4bed2009-06-16 17:01:33 +01001356 mutex_unlock(&tty->ldisc_mutex);
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001357
1358 return 0;
1359}
1360
Alan Coxaf9b8972006-08-27 01:24:01 -07001361/**
Alan Coxd81ed102008-10-13 10:41:42 +01001362 * tty_init_dev - initialise a tty device
Alan Coxaf9b8972006-08-27 01:24:01 -07001363 * @driver: tty driver we are opening a device on
1364 * @idx: device index
Alan Cox15582d32008-10-13 10:41:03 +01001365 * @ret_tty: returned tty structure
Alan Coxaf9b8972006-08-27 01:24:01 -07001366 *
1367 * Prepare a tty device. This may not be a "new" clean device but
1368 * could also be an active device. The pty drivers require special
1369 * handling because of this.
1370 *
1371 * Locking:
1372 * The function is called under the tty_mutex, which
1373 * protects us from the tty struct or driver itself going away.
1374 *
1375 * On exit the tty device has the line discipline attached and
1376 * a reference count of 1. If a pair was created for pty/tty use
1377 * and the other was a pty master then it too has a reference count of 1.
1378 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07001379 * WSH 06/09/97: Rewritten to remove races and properly clean up after a
Ingo Molnar70522e12006-03-23 03:00:31 -08001380 * failed open. The new code protects the open with a mutex, so it's
1381 * really quite straightforward. The mutex locking can probably be
Linus Torvalds1da177e2005-04-16 15:20:36 -07001382 * relaxed for the (most common) case of reopening a tty.
1383 */
Alan Coxaf9b8972006-08-27 01:24:01 -07001384
Konstantin Khlebnikov593a27c2012-01-05 13:04:21 +04001385struct tty_struct *tty_init_dev(struct tty_driver *driver, int idx)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001386{
Alan Coxbf970ee2008-10-13 10:42:39 +01001387 struct tty_struct *tty;
Alan Cox73ec06f2008-10-13 10:42:29 +01001388 int retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001389
Linus Torvalds1da177e2005-04-16 15:20:36 -07001390 /*
1391 * First time open is complex, especially for PTY devices.
1392 * This code guarantees that either everything succeeds and the
1393 * TTY is ready for operation, or else the table slots are vacated
Alan Cox37bdfb02008-02-08 04:18:47 -08001394 * and the allocated memory released. (Except that the termios
Linus Torvalds1da177e2005-04-16 15:20:36 -07001395 * and locked termios may be retained.)
1396 */
1397
Alan Cox73ec06f2008-10-13 10:42:29 +01001398 if (!try_module_get(driver->owner))
1399 return ERR_PTR(-ENODEV);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001400
Linus Torvalds1da177e2005-04-16 15:20:36 -07001401 tty = alloc_tty_struct();
Jiri Slabyd5543502011-03-23 10:48:32 +01001402 if (!tty) {
1403 retval = -ENOMEM;
1404 goto err_module_put;
1405 }
Alan Coxbf970ee2008-10-13 10:42:39 +01001406 initialize_tty_struct(tty, driver, idx);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001407
Alan Cox89c8d912012-08-08 16:30:13 +01001408 tty_lock(tty);
Alan Cox73ec06f2008-10-13 10:42:29 +01001409 retval = tty_driver_install_tty(driver, tty);
Jiri Slabyd5543502011-03-23 10:48:32 +01001410 if (retval < 0)
Jiri Slabya9dccdd2011-03-23 10:48:36 +01001411 goto err_deinit_tty;
Alan Cox8b0a88d2008-10-13 10:42:19 +01001412
Jiri Slaby04831dc2012-06-04 13:35:36 +02001413 if (!tty->port)
1414 tty->port = driver->ports[idx];
1415
Jiri Slaby5d4121c2012-08-17 14:27:52 +02001416 WARN_RATELIMIT(!tty->port,
1417 "%s: %s driver does not set tty->port. This will crash the kernel later. Fix the driver!\n",
1418 __func__, tty->driver->name);
1419
Alan Cox37bdfb02008-02-08 04:18:47 -08001420 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001421 * Structures all installed ... call the ldisc open routines.
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001422 * If we fail here just call release_tty to clean up. No need
1423 * to decrement the use counts, as release_tty doesn't care.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001424 */
Alan Coxbf970ee2008-10-13 10:42:39 +01001425 retval = tty_ldisc_setup(tty, tty->link);
Alan Cox01e1abb2008-07-22 11:16:55 +01001426 if (retval)
Jiri Slabyd5543502011-03-23 10:48:32 +01001427 goto err_release_tty;
Alan Cox89c8d912012-08-08 16:30:13 +01001428 /* Return the tty locked so that it cannot vanish under the caller */
Alan Cox73ec06f2008-10-13 10:42:29 +01001429 return tty;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001430
Jiri Slabya9dccdd2011-03-23 10:48:36 +01001431err_deinit_tty:
Alan Cox89c8d912012-08-08 16:30:13 +01001432 tty_unlock(tty);
Jiri Slabya9dccdd2011-03-23 10:48:36 +01001433 deinitialize_tty_struct(tty);
Jiri Slabyd5543502011-03-23 10:48:32 +01001434 free_tty_struct(tty);
1435err_module_put:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001436 module_put(driver->owner);
Jiri Slabyd5543502011-03-23 10:48:32 +01001437 return ERR_PTR(retval);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001438
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001439 /* call the tty release_tty routine to clean out this slot */
Jiri Slabyd5543502011-03-23 10:48:32 +01001440err_release_tty:
Alan Cox89c8d912012-08-08 16:30:13 +01001441 tty_unlock(tty);
Manuel Zerpies5a3c6b22011-06-16 14:07:22 +02001442 printk_ratelimited(KERN_INFO "tty_init_dev: ldisc open failed, "
Akinobu Mita40509142006-09-29 02:01:27 -07001443 "clearing slot %d\n", idx);
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001444 release_tty(tty, idx);
Alan Cox73ec06f2008-10-13 10:42:29 +01001445 return ERR_PTR(retval);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001446}
1447
Alan Coxfeebed62008-10-13 10:41:30 +01001448void tty_free_termios(struct tty_struct *tty)
1449{
1450 struct ktermios *tp;
1451 int idx = tty->index;
Alan Cox36b3c072012-07-17 17:06:57 +01001452
1453 /* If the port is going to reset then it has no termios to save */
1454 if (tty->driver->flags & TTY_DRIVER_RESET_TERMIOS)
1455 return;
1456
1457 /* Stash the termios data */
1458 tp = tty->driver->termios[idx];
1459 if (tp == NULL) {
1460 tp = kmalloc(sizeof(struct ktermios), GFP_KERNEL);
1461 if (tp == NULL) {
1462 pr_warn("tty: no memory to save termios state.\n");
1463 return;
1464 }
Dan Carpenter4ac5d702012-07-24 12:51:52 +01001465 tty->driver->termios[idx] = tp;
Alan Coxfeebed62008-10-13 10:41:30 +01001466 }
Alan Cox36b3c072012-07-17 17:06:57 +01001467 *tp = tty->termios;
Alan Coxfeebed62008-10-13 10:41:30 +01001468}
1469EXPORT_SYMBOL(tty_free_termios);
1470
Alan Coxfeebed62008-10-13 10:41:30 +01001471
Alan Coxaf9b8972006-08-27 01:24:01 -07001472/**
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001473 * release_one_tty - release tty structure memory
Alan Cox9c9f4de2008-10-13 10:37:26 +01001474 * @kref: kref of tty we are obliterating
Alan Coxaf9b8972006-08-27 01:24:01 -07001475 *
1476 * Releases memory associated with a tty structure, and clears out the
1477 * driver table slots. This function is called when a device is no longer
1478 * in use. It also gets called when setup of a device fails.
1479 *
1480 * Locking:
Alan Coxaf9b8972006-08-27 01:24:01 -07001481 * takes the file list lock internally when working on the list
1482 * of ttys that the driver keeps.
Alan Coxb50989d2009-09-19 13:13:22 -07001483 *
1484 * This method gets called from a work queue so that the driver private
Dave Youngf278a2f2009-09-27 16:00:42 +00001485 * cleanup ops can sleep (needed for USB at least)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001486 */
Alan Coxb50989d2009-09-19 13:13:22 -07001487static void release_one_tty(struct work_struct *work)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001488{
Alan Coxb50989d2009-09-19 13:13:22 -07001489 struct tty_struct *tty =
1490 container_of(work, struct tty_struct, hangup_work);
Alan Cox6f967f72008-10-13 10:37:36 +01001491 struct tty_driver *driver = tty->driver;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001492
Dave Youngf278a2f2009-09-27 16:00:42 +00001493 if (tty->ops->cleanup)
1494 tty->ops->cleanup(tty);
1495
Linus Torvalds1da177e2005-04-16 15:20:36 -07001496 tty->magic = 0;
Alan Cox7d7b93c2008-10-13 10:42:09 +01001497 tty_driver_kref_put(driver);
Alan Cox6f967f72008-10-13 10:37:36 +01001498 module_put(driver->owner);
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001499
Nick Pigginee2ffa02010-08-18 04:37:35 +10001500 spin_lock(&tty_files_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001501 list_del_init(&tty->tty_files);
Nick Pigginee2ffa02010-08-18 04:37:35 +10001502 spin_unlock(&tty_files_lock);
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001503
Oleg Nesterov6da8d862010-04-02 18:05:12 +02001504 put_pid(tty->pgrp);
1505 put_pid(tty->session);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001506 free_tty_struct(tty);
1507}
1508
Alan Coxb50989d2009-09-19 13:13:22 -07001509static void queue_release_one_tty(struct kref *kref)
1510{
1511 struct tty_struct *tty = container_of(kref, struct tty_struct, kref);
Dave Youngf278a2f2009-09-27 16:00:42 +00001512
Alan Coxb50989d2009-09-19 13:13:22 -07001513 /* The hangup queue is now free so we can reuse it rather than
1514 waste a chunk of memory for each port */
1515 INIT_WORK(&tty->hangup_work, release_one_tty);
1516 schedule_work(&tty->hangup_work);
1517}
1518
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001519/**
Alan Cox9c9f4de2008-10-13 10:37:26 +01001520 * tty_kref_put - release a tty kref
1521 * @tty: tty device
1522 *
1523 * Release a reference to a tty device and if need be let the kref
1524 * layer destruct the object for us
1525 */
1526
1527void tty_kref_put(struct tty_struct *tty)
1528{
1529 if (tty)
Alan Coxb50989d2009-09-19 13:13:22 -07001530 kref_put(&tty->kref, queue_release_one_tty);
Alan Cox9c9f4de2008-10-13 10:37:26 +01001531}
1532EXPORT_SYMBOL(tty_kref_put);
1533
1534/**
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001535 * release_tty - release tty structure memory
1536 *
1537 * Release both @tty and a possible linked partner (think pty pair),
1538 * and decrement the refcount of the backing module.
1539 *
1540 * Locking:
Alan Coxd1552552012-07-27 18:02:54 +01001541 * tty_mutex
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001542 * takes the file list lock internally when working on the list
1543 * of ttys that the driver keeps.
Alan Cox9c9f4de2008-10-13 10:37:26 +01001544 *
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001545 */
1546static void release_tty(struct tty_struct *tty, int idx)
1547{
Alan Cox9c9f4de2008-10-13 10:37:26 +01001548 /* This should always be true but check for the moment */
1549 WARN_ON(tty->index != idx);
Alan Coxd1552552012-07-27 18:02:54 +01001550 WARN_ON(!mutex_is_locked(&tty_mutex));
Alan Cox36b3c072012-07-17 17:06:57 +01001551 if (tty->ops->shutdown)
1552 tty->ops->shutdown(tty);
1553 tty_free_termios(tty);
1554 tty_driver_remove_tty(tty->driver, tty);
1555
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001556 if (tty->link)
Alan Cox9c9f4de2008-10-13 10:37:26 +01001557 tty_kref_put(tty->link);
1558 tty_kref_put(tty);
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001559}
1560
Alan Coxeeb89d92009-11-30 13:18:29 +00001561/**
Jiri Slaby955787ca2011-11-11 10:47:23 +01001562 * tty_release_checks - check a tty before real release
1563 * @tty: tty to check
1564 * @o_tty: link of @tty (if any)
1565 * @idx: index of the tty
1566 *
1567 * Performs some paranoid checking before true release of the @tty.
1568 * This is a no-op unless TTY_PARANOIA_CHECK is defined.
1569 */
1570static int tty_release_checks(struct tty_struct *tty, struct tty_struct *o_tty,
1571 int idx)
1572{
1573#ifdef TTY_PARANOIA_CHECK
1574 if (idx < 0 || idx >= tty->driver->num) {
Jiri Slaby9de44bd2011-11-09 21:33:24 +01001575 printk(KERN_DEBUG "%s: bad idx when trying to free (%s)\n",
1576 __func__, tty->name);
Jiri Slaby955787ca2011-11-11 10:47:23 +01001577 return -1;
1578 }
1579
1580 /* not much to check for devpts */
1581 if (tty->driver->flags & TTY_DRIVER_DEVPTS_MEM)
1582 return 0;
1583
1584 if (tty != tty->driver->ttys[idx]) {
Jiri Slaby9de44bd2011-11-09 21:33:24 +01001585 printk(KERN_DEBUG "%s: driver.table[%d] not tty for (%s)\n",
1586 __func__, idx, tty->name);
Jiri Slaby955787ca2011-11-11 10:47:23 +01001587 return -1;
1588 }
Jiri Slaby955787ca2011-11-11 10:47:23 +01001589 if (tty->driver->other) {
1590 if (o_tty != tty->driver->other->ttys[idx]) {
Jiri Slaby9de44bd2011-11-09 21:33:24 +01001591 printk(KERN_DEBUG "%s: other->table[%d] not o_tty for (%s)\n",
1592 __func__, idx, tty->name);
Jiri Slaby955787ca2011-11-11 10:47:23 +01001593 return -1;
1594 }
Jiri Slaby955787ca2011-11-11 10:47:23 +01001595 if (o_tty->link != tty) {
Jiri Slaby9de44bd2011-11-09 21:33:24 +01001596 printk(KERN_DEBUG "%s: bad pty pointers\n", __func__);
Jiri Slaby955787ca2011-11-11 10:47:23 +01001597 return -1;
1598 }
1599 }
1600#endif
1601 return 0;
1602}
1603
1604/**
Alan Coxeeb89d92009-11-30 13:18:29 +00001605 * 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 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07001615 * 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 */
Alan Coxeeb89d92009-11-30 13:18:29 +00001622
1623int tty_release(struct inode *inode, struct file *filp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001624{
Nick Piggind996b622010-08-18 04:37:36 +10001625 struct tty_struct *tty = file_tty(filp);
1626 struct tty_struct *o_tty;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001627 int pty_master, tty_closing, o_tty_closing, do_sleep;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001628 int idx;
1629 char buf[64];
Alan Cox37bdfb02008-02-08 04:18:47 -08001630
Jiri Slaby9de44bd2011-11-09 21:33:24 +01001631 if (tty_paranoia_check(tty, inode, __func__))
Alan Coxeeb89d92009-11-30 13:18:29 +00001632 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001633
Alan Cox89c8d912012-08-08 16:30:13 +01001634 tty_lock(tty);
Jiri Slaby9de44bd2011-11-09 21:33:24 +01001635 check_tty_count(tty, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001636
Arnd Bergmannec79d602010-06-01 22:53:01 +02001637 __tty_fasync(-1, filp, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001638
1639 idx = tty->index;
1640 pty_master = (tty->driver->type == TTY_DRIVER_TYPE_PTY &&
1641 tty->driver->subtype == PTY_TYPE_MASTER);
Alan Cox89c8d912012-08-08 16:30:13 +01001642 /* Review: parallel close */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001643 o_tty = tty->link;
1644
Jiri Slaby955787ca2011-11-11 10:47:23 +01001645 if (tty_release_checks(tty, o_tty, idx)) {
Alan Cox89c8d912012-08-08 16:30:13 +01001646 tty_unlock(tty);
Alan Coxeeb89d92009-11-30 13:18:29 +00001647 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001648 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001649
1650#ifdef TTY_DEBUG_HANGUP
Jiri Slaby9de44bd2011-11-09 21:33:24 +01001651 printk(KERN_DEBUG "%s: %s (tty count=%d)...\n", __func__,
1652 tty_name(tty, buf), tty->count);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001653#endif
1654
Alan Coxf34d7a52008-04-30 00:54:13 -07001655 if (tty->ops->close)
1656 tty->ops->close(tty, filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001657
Alan Cox89c8d912012-08-08 16:30:13 +01001658 tty_unlock(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001659 /*
1660 * Sanity check: if tty->count is going to zero, there shouldn't be
1661 * any waiters on tty->read_wait or tty->write_wait. We test the
1662 * wait queues and kick everyone out _before_ actually starting to
1663 * close. This ensures that we won't block while releasing the tty
1664 * structure.
1665 *
1666 * The test for the o_tty closing is necessary, since the master and
1667 * slave sides may close in any order. If the slave side closes out
1668 * first, its count will be one, since the master side holds an open.
1669 * Thus this test wouldn't be triggered at the time the slave closes,
1670 * so we do it now.
1671 *
1672 * Note that it's possible for the tty to be opened again while we're
1673 * flushing out waiters. By recalculating the closing flags before
1674 * each iteration we avoid any problems.
1675 */
1676 while (1) {
1677 /* Guard against races with tty->count changes elsewhere and
1678 opens on /dev/tty */
Alan Cox37bdfb02008-02-08 04:18:47 -08001679
Ingo Molnar70522e12006-03-23 03:00:31 -08001680 mutex_lock(&tty_mutex);
Alan Cox89c8d912012-08-08 16:30:13 +01001681 tty_lock_pair(tty, o_tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001682 tty_closing = tty->count <= 1;
1683 o_tty_closing = o_tty &&
1684 (o_tty->count <= (pty_master ? 1 : 0));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001685 do_sleep = 0;
1686
1687 if (tty_closing) {
1688 if (waitqueue_active(&tty->read_wait)) {
Davide Libenzi4b194492009-03-31 15:24:24 -07001689 wake_up_poll(&tty->read_wait, POLLIN);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001690 do_sleep++;
1691 }
1692 if (waitqueue_active(&tty->write_wait)) {
Davide Libenzi4b194492009-03-31 15:24:24 -07001693 wake_up_poll(&tty->write_wait, POLLOUT);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001694 do_sleep++;
1695 }
1696 }
1697 if (o_tty_closing) {
1698 if (waitqueue_active(&o_tty->read_wait)) {
Davide Libenzi4b194492009-03-31 15:24:24 -07001699 wake_up_poll(&o_tty->read_wait, POLLIN);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001700 do_sleep++;
1701 }
1702 if (waitqueue_active(&o_tty->write_wait)) {
Davide Libenzi4b194492009-03-31 15:24:24 -07001703 wake_up_poll(&o_tty->write_wait, POLLOUT);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001704 do_sleep++;
1705 }
1706 }
1707 if (!do_sleep)
1708 break;
1709
Jiri Slaby9de44bd2011-11-09 21:33:24 +01001710 printk(KERN_WARNING "%s: %s: read/write wait queue active!\n",
1711 __func__, tty_name(tty, buf));
Alan Cox89c8d912012-08-08 16:30:13 +01001712 tty_unlock_pair(tty, o_tty);
Ingo Molnar70522e12006-03-23 03:00:31 -08001713 mutex_unlock(&tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001714 schedule();
Alan Cox37bdfb02008-02-08 04:18:47 -08001715 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001716
1717 /*
Alan Cox37bdfb02008-02-08 04:18:47 -08001718 * The closing flags are now consistent with the open counts on
1719 * both sides, and we've completed the last operation that could
Linus Torvalds1da177e2005-04-16 15:20:36 -07001720 * block, so it's safe to proceed with closing.
Alan Coxd1552552012-07-27 18:02:54 +01001721 *
1722 * We must *not* drop the tty_mutex until we ensure that a further
1723 * entry into tty_open can not pick up this tty.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001724 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001725 if (pty_master) {
1726 if (--o_tty->count < 0) {
Jiri Slaby9de44bd2011-11-09 21:33:24 +01001727 printk(KERN_WARNING "%s: bad pty slave count (%d) for %s\n",
1728 __func__, o_tty->count, tty_name(o_tty, buf));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001729 o_tty->count = 0;
1730 }
1731 }
1732 if (--tty->count < 0) {
Jiri Slaby9de44bd2011-11-09 21:33:24 +01001733 printk(KERN_WARNING "%s: bad tty->count (%d) for %s\n",
1734 __func__, tty->count, tty_name(tty, buf));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001735 tty->count = 0;
1736 }
Alan Cox37bdfb02008-02-08 04:18:47 -08001737
Linus Torvalds1da177e2005-04-16 15:20:36 -07001738 /*
1739 * We've decremented tty->count, so we need to remove this file
1740 * descriptor off the tty->tty_files list; this serves two
1741 * purposes:
1742 * - check_tty_count sees the correct number of file descriptors
1743 * associated with this tty.
1744 * - do_tty_hangup no longer sees this file descriptor as
1745 * something that needs to be handled for hangups.
1746 */
Nick Piggind996b622010-08-18 04:37:36 +10001747 tty_del_file(filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001748
1749 /*
1750 * Perform some housekeeping before deciding whether to return.
1751 *
1752 * Set the TTY_CLOSING flag if this was the last open. In the
1753 * case of a pty we may have to wait around for the other side
1754 * to close, and TTY_CLOSING makes sure we can't be reopened.
1755 */
Alan Cox37bdfb02008-02-08 04:18:47 -08001756 if (tty_closing)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001757 set_bit(TTY_CLOSING, &tty->flags);
Alan Cox37bdfb02008-02-08 04:18:47 -08001758 if (o_tty_closing)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001759 set_bit(TTY_CLOSING, &o_tty->flags);
1760
1761 /*
1762 * If _either_ side is closing, make sure there aren't any
1763 * processes that still think tty or o_tty is their controlling
1764 * tty.
1765 */
1766 if (tty_closing || o_tty_closing) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001767 read_lock(&tasklist_lock);
Peter Zijlstra24ec8392006-12-08 02:36:04 -08001768 session_clear_tty(tty->session);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001769 if (o_tty)
Peter Zijlstra24ec8392006-12-08 02:36:04 -08001770 session_clear_tty(o_tty->session);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001771 read_unlock(&tasklist_lock);
1772 }
1773
Ingo Molnar70522e12006-03-23 03:00:31 -08001774 mutex_unlock(&tty_mutex);
Alan Cox89c8d912012-08-08 16:30:13 +01001775 tty_unlock_pair(tty, o_tty);
Alan Coxd1552552012-07-27 18:02:54 +01001776 /* At this point the TTY_CLOSING flag should ensure a dead tty
1777 cannot be re-opened by a racing opener */
Paul Fulghumda965822006-02-14 13:53:00 -08001778
Linus Torvalds1da177e2005-04-16 15:20:36 -07001779 /* check whether both sides are closing ... */
Alan Coxd1552552012-07-27 18:02:54 +01001780 if (!tty_closing || (o_tty && !o_tty_closing))
Alan Coxeeb89d92009-11-30 13:18:29 +00001781 return 0;
Alan Cox37bdfb02008-02-08 04:18:47 -08001782
Linus Torvalds1da177e2005-04-16 15:20:36 -07001783#ifdef TTY_DEBUG_HANGUP
Jiri Slaby9de44bd2011-11-09 21:33:24 +01001784 printk(KERN_DEBUG "%s: freeing tty structure...\n", __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001785#endif
1786 /*
Alan Cox01e1abb2008-07-22 11:16:55 +01001787 * Ask the line discipline code to release its structures
Linus Torvalds1da177e2005-04-16 15:20:36 -07001788 */
Alan Cox01e1abb2008-07-22 11:16:55 +01001789 tty_ldisc_release(tty, o_tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001790 /*
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001791 * The release_tty function takes care of the details of clearing
Alan Cox89c8d912012-08-08 16:30:13 +01001792 * the slots and preserving the termios structure. The tty_unlock_pair
1793 * should be safe as we keep a kref while the tty is locked (so the
1794 * unlock never unlocks a freed tty).
Linus Torvalds1da177e2005-04-16 15:20:36 -07001795 */
Alan Coxd1552552012-07-27 18:02:54 +01001796 mutex_lock(&tty_mutex);
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001797 release_tty(tty, idx);
Alan Coxd1552552012-07-27 18:02:54 +01001798 mutex_unlock(&tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001799
Alan Coxeeb89d92009-11-30 13:18:29 +00001800 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001801}
1802
Alan Coxaf9b8972006-08-27 01:24:01 -07001803/**
Jiri Slabyb82154a2011-11-09 21:33:19 +01001804 * tty_open_current_tty - get tty of current task for open
1805 * @device: device number
1806 * @filp: file pointer to tty
1807 * @return: tty of the current task iff @device is /dev/tty
1808 *
1809 * We cannot return driver and index like for the other nodes because
1810 * devpts will not work then. It expects inodes to be from devpts FS.
Alan Cox3af502b2012-05-03 22:21:53 +01001811 *
1812 * We need to move to returning a refcounted object from all the lookup
1813 * paths including this one.
Jiri Slabyb82154a2011-11-09 21:33:19 +01001814 */
1815static struct tty_struct *tty_open_current_tty(dev_t device, struct file *filp)
1816{
1817 struct tty_struct *tty;
1818
1819 if (device != MKDEV(TTYAUX_MAJOR, 0))
1820 return NULL;
1821
1822 tty = get_current_tty();
1823 if (!tty)
1824 return ERR_PTR(-ENXIO);
1825
1826 filp->f_flags |= O_NONBLOCK; /* Don't let /dev/tty block */
1827 /* noctty = 1; */
1828 tty_kref_put(tty);
1829 /* FIXME: we put a reference and return a TTY! */
Alan Cox3af502b2012-05-03 22:21:53 +01001830 /* This is only safe because the caller holds tty_mutex */
Jiri Slabyb82154a2011-11-09 21:33:19 +01001831 return tty;
1832}
1833
1834/**
Jiri Slaby5b5e7042011-11-09 21:33:20 +01001835 * tty_lookup_driver - lookup a tty driver for a given device file
1836 * @device: device number
1837 * @filp: file pointer to tty
1838 * @noctty: set if the device should not become a controlling tty
1839 * @index: index for the device in the @return driver
1840 * @return: driver for this inode (with increased refcount)
1841 *
1842 * If @return is not erroneous, the caller is responsible to decrement the
1843 * refcount by tty_driver_kref_put.
1844 *
1845 * Locking: tty_mutex protects get_tty_driver
1846 */
1847static struct tty_driver *tty_lookup_driver(dev_t device, struct file *filp,
1848 int *noctty, int *index)
1849{
1850 struct tty_driver *driver;
1851
Jiri Slaby2cd00502011-11-09 21:33:22 +01001852 switch (device) {
Jiri Slaby5b5e7042011-11-09 21:33:20 +01001853#ifdef CONFIG_VT
Jiri Slaby2cd00502011-11-09 21:33:22 +01001854 case MKDEV(TTY_MAJOR, 0): {
Jiri Slaby5b5e7042011-11-09 21:33:20 +01001855 extern struct tty_driver *console_driver;
1856 driver = tty_driver_kref_get(console_driver);
1857 *index = fg_console;
1858 *noctty = 1;
Jiri Slaby2cd00502011-11-09 21:33:22 +01001859 break;
Jiri Slaby5b5e7042011-11-09 21:33:20 +01001860 }
1861#endif
Jiri Slaby2cd00502011-11-09 21:33:22 +01001862 case MKDEV(TTYAUX_MAJOR, 1): {
Jiri Slaby5b5e7042011-11-09 21:33:20 +01001863 struct tty_driver *console_driver = console_device(index);
1864 if (console_driver) {
1865 driver = tty_driver_kref_get(console_driver);
1866 if (driver) {
1867 /* Don't let /dev/console block */
1868 filp->f_flags |= O_NONBLOCK;
1869 *noctty = 1;
Jiri Slaby2cd00502011-11-09 21:33:22 +01001870 break;
Jiri Slaby5b5e7042011-11-09 21:33:20 +01001871 }
1872 }
1873 return ERR_PTR(-ENODEV);
1874 }
Jiri Slaby2cd00502011-11-09 21:33:22 +01001875 default:
1876 driver = get_tty_driver(device, index);
1877 if (!driver)
1878 return ERR_PTR(-ENODEV);
1879 break;
1880 }
Jiri Slaby5b5e7042011-11-09 21:33:20 +01001881 return driver;
1882}
1883
1884/**
Alan Coxeeb89d92009-11-30 13:18:29 +00001885 * tty_open - open a tty device
Alan Coxaf9b8972006-08-27 01:24:01 -07001886 * @inode: inode of device file
1887 * @filp: file pointer to tty
Linus Torvalds1da177e2005-04-16 15:20:36 -07001888 *
Alan Coxaf9b8972006-08-27 01:24:01 -07001889 * tty_open and tty_release keep up the tty count that contains the
1890 * number of opens done on a tty. We cannot use the inode-count, as
1891 * different inodes might point to the same tty.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001892 *
Alan Coxaf9b8972006-08-27 01:24:01 -07001893 * Open-counting is needed for pty masters, as well as for keeping
1894 * track of serial lines: DTR is dropped when the last close happens.
1895 * (This is not done solely through tty->count, now. - Ted 1/27/92)
1896 *
1897 * The termios state of a pty is reset on first open so that
1898 * settings don't persist across reuse.
1899 *
Jiri Slaby5b5e7042011-11-09 21:33:20 +01001900 * Locking: tty_mutex protects tty, tty_lookup_driver and tty_init_dev.
Peter Zijlstra24ec8392006-12-08 02:36:04 -08001901 * tty->count should protect the rest.
1902 * ->siglock protects ->signal/->sighand
Alan Cox89c8d912012-08-08 16:30:13 +01001903 *
1904 * Note: the tty_unlock/lock cases without a ref are only safe due to
1905 * tty_mutex
Linus Torvalds1da177e2005-04-16 15:20:36 -07001906 */
Alan Coxaf9b8972006-08-27 01:24:01 -07001907
Alan Coxeeb89d92009-11-30 13:18:29 +00001908static int tty_open(struct inode *inode, struct file *filp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001909{
Jiri Slabyb82154a2011-11-09 21:33:19 +01001910 struct tty_struct *tty;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001911 int noctty, retval;
Jiri Slabyb82154a2011-11-09 21:33:19 +01001912 struct tty_driver *driver = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001913 int index;
1914 dev_t device = inode->i_rdev;
Andrew Morton846c1512009-04-02 16:56:36 -07001915 unsigned saved_flags = filp->f_flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001916
1917 nonseekable_open(inode, filp);
Alan Cox37bdfb02008-02-08 04:18:47 -08001918
Linus Torvalds1da177e2005-04-16 15:20:36 -07001919retry_open:
Jiri Slabyfa90e1c2011-10-12 11:32:43 +02001920 retval = tty_alloc_file(filp);
1921 if (retval)
1922 return -ENOMEM;
1923
Linus Torvalds1da177e2005-04-16 15:20:36 -07001924 noctty = filp->f_flags & O_NOCTTY;
1925 index = -1;
1926 retval = 0;
Alan Cox37bdfb02008-02-08 04:18:47 -08001927
Ingo Molnar70522e12006-03-23 03:00:31 -08001928 mutex_lock(&tty_mutex);
Alan Cox89c8d912012-08-08 16:30:13 +01001929 /* This is protected by the tty_mutex */
Jiri Slabyb82154a2011-11-09 21:33:19 +01001930 tty = tty_open_current_tty(device, filp);
1931 if (IS_ERR(tty)) {
Jiri Slabyba5db442011-11-09 21:33:21 +01001932 retval = PTR_ERR(tty);
1933 goto err_unlock;
Jiri Slaby5b5e7042011-11-09 21:33:20 +01001934 } else if (!tty) {
1935 driver = tty_lookup_driver(device, filp, &noctty, &index);
1936 if (IS_ERR(driver)) {
Jiri Slabyba5db442011-11-09 21:33:21 +01001937 retval = PTR_ERR(driver);
1938 goto err_unlock;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001939 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001940
Sukadev Bhattiprolu4a2b5fd2008-10-13 10:42:49 +01001941 /* check whether we're reopening an existing tty */
Sukadev Bhattiprolu15f1a632008-10-13 10:42:59 +01001942 tty = tty_driver_lookup_tty(driver, inode, index);
Eric Paris808ffa32009-01-27 11:50:37 +00001943 if (IS_ERR(tty)) {
Jiri Slabyba5db442011-11-09 21:33:21 +01001944 retval = PTR_ERR(tty);
1945 goto err_unlock;
Eric Paris808ffa32009-01-27 11:50:37 +00001946 }
Sukadev Bhattiprolu4a2b5fd2008-10-13 10:42:49 +01001947 }
1948
1949 if (tty) {
Alan Cox89c8d912012-08-08 16:30:13 +01001950 tty_lock(tty);
Sukadev Bhattiprolu4a2b5fd2008-10-13 10:42:49 +01001951 retval = tty_reopen(tty);
Alan Cox89c8d912012-08-08 16:30:13 +01001952 if (retval < 0) {
1953 tty_unlock(tty);
Sukadev Bhattiprolu4a2b5fd2008-10-13 10:42:49 +01001954 tty = ERR_PTR(retval);
Alan Cox89c8d912012-08-08 16:30:13 +01001955 }
1956 } else /* Returns with the tty_lock held for now */
Konstantin Khlebnikov593a27c2012-01-05 13:04:21 +04001957 tty = tty_init_dev(driver, index);
Sukadev Bhattiprolu4a2b5fd2008-10-13 10:42:49 +01001958
Ingo Molnar70522e12006-03-23 03:00:31 -08001959 mutex_unlock(&tty_mutex);
Jiri Slabyb82154a2011-11-09 21:33:19 +01001960 if (driver)
1961 tty_driver_kref_put(driver);
Alan Coxeeb89d92009-11-30 13:18:29 +00001962 if (IS_ERR(tty)) {
Jiri Slabyba5db442011-11-09 21:33:21 +01001963 retval = PTR_ERR(tty);
1964 goto err_file;
Alan Coxeeb89d92009-11-30 13:18:29 +00001965 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001966
Jiri Slabyfa90e1c2011-10-12 11:32:43 +02001967 tty_add_file(tty, filp);
Nick Piggind996b622010-08-18 04:37:36 +10001968
Jiri Slaby9de44bd2011-11-09 21:33:24 +01001969 check_tty_count(tty, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001970 if (tty->driver->type == TTY_DRIVER_TYPE_PTY &&
1971 tty->driver->subtype == PTY_TYPE_MASTER)
1972 noctty = 1;
1973#ifdef TTY_DEBUG_HANGUP
Jiri Slaby9de44bd2011-11-09 21:33:24 +01001974 printk(KERN_DEBUG "%s: opening %s...\n", __func__, tty->name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001975#endif
Herton Ronaldo Krzesinski909bc772011-03-31 15:35:31 -03001976 if (tty->ops->open)
1977 retval = tty->ops->open(tty, filp);
1978 else
1979 retval = -ENODEV;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001980 filp->f_flags = saved_flags;
1981
Alan Cox37bdfb02008-02-08 04:18:47 -08001982 if (!retval && test_bit(TTY_EXCLUSIVE, &tty->flags) &&
1983 !capable(CAP_SYS_ADMIN))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001984 retval = -EBUSY;
1985
1986 if (retval) {
1987#ifdef TTY_DEBUG_HANGUP
Jiri Slaby9de44bd2011-11-09 21:33:24 +01001988 printk(KERN_DEBUG "%s: error %d in opening %s...\n", __func__,
1989 retval, tty->name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001990#endif
Alan Cox89c8d912012-08-08 16:30:13 +01001991 tty_unlock(tty); /* need to call tty_release without BTM */
Alan Coxeeb89d92009-11-30 13:18:29 +00001992 tty_release(inode, filp);
Arnd Bergmann64ba3dc32010-06-01 22:53:02 +02001993 if (retval != -ERESTARTSYS)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001994 return retval;
Arnd Bergmann64ba3dc32010-06-01 22:53:02 +02001995
1996 if (signal_pending(current))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001997 return retval;
Arnd Bergmann64ba3dc32010-06-01 22:53:02 +02001998
Linus Torvalds1da177e2005-04-16 15:20:36 -07001999 schedule();
2000 /*
2001 * Need to reset f_op in case a hangup happened.
2002 */
2003 if (filp->f_op == &hung_up_tty_fops)
2004 filp->f_op = &tty_fops;
2005 goto retry_open;
2006 }
Alan Cox89c8d912012-08-08 16:30:13 +01002007 tty_unlock(tty);
Alan Coxeeb89d92009-11-30 13:18:29 +00002008
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002009
2010 mutex_lock(&tty_mutex);
Alan Cox89c8d912012-08-08 16:30:13 +01002011 tty_lock(tty);
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002012 spin_lock_irq(&current->sighand->siglock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002013 if (!noctty &&
2014 current->signal->leader &&
2015 !current->signal->tty &&
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08002016 tty->session == NULL)
Eric W. Biederman2a65f1d2007-05-08 00:26:53 -07002017 __proc_set_tty(current, tty);
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002018 spin_unlock_irq(&current->sighand->siglock);
Alan Cox89c8d912012-08-08 16:30:13 +01002019 tty_unlock(tty);
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002020 mutex_unlock(&tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002021 return 0;
Jiri Slabyba5db442011-11-09 21:33:21 +01002022err_unlock:
Jiri Slabyba5db442011-11-09 21:33:21 +01002023 mutex_unlock(&tty_mutex);
2024 /* after locks to avoid deadlock */
2025 if (!IS_ERR_OR_NULL(driver))
2026 tty_driver_kref_put(driver);
2027err_file:
2028 tty_free_file(filp);
2029 return retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002030}
2031
Jonathan Corbet39d95b92008-05-16 09:10:50 -06002032
Linus Torvalds1da177e2005-04-16 15:20:36 -07002033
Alan Coxaf9b8972006-08-27 01:24:01 -07002034/**
2035 * tty_poll - check tty status
2036 * @filp: file being polled
2037 * @wait: poll wait structures to update
2038 *
2039 * Call the line discipline polling method to obtain the poll
2040 * status of the device.
2041 *
2042 * Locking: locks called line discipline but ldisc poll method
2043 * may be re-entered freely by other callers.
2044 */
2045
Alan Cox37bdfb02008-02-08 04:18:47 -08002046static unsigned int tty_poll(struct file *filp, poll_table *wait)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002047{
Nick Piggind996b622010-08-18 04:37:36 +10002048 struct tty_struct *tty = file_tty(filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002049 struct tty_ldisc *ld;
2050 int ret = 0;
2051
Josef Sipeka7113a92006-12-08 02:36:55 -08002052 if (tty_paranoia_check(tty, filp->f_path.dentry->d_inode, "tty_poll"))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002053 return 0;
Alan Cox37bdfb02008-02-08 04:18:47 -08002054
Linus Torvalds1da177e2005-04-16 15:20:36 -07002055 ld = tty_ldisc_ref_wait(tty);
Alan Coxa352def2008-07-16 21:53:12 +01002056 if (ld->ops->poll)
2057 ret = (ld->ops->poll)(tty, filp, wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002058 tty_ldisc_deref(ld);
2059 return ret;
2060}
2061
Arnd Bergmannec79d602010-06-01 22:53:01 +02002062static int __tty_fasync(int fd, struct file *filp, int on)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002063{
Nick Piggind996b622010-08-18 04:37:36 +10002064 struct tty_struct *tty = file_tty(filp);
Alan Cox47f86832008-04-30 00:53:30 -07002065 unsigned long flags;
Jonathan Corbet5d1e3232008-06-19 16:04:53 -06002066 int retval = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002067
Josef Sipeka7113a92006-12-08 02:36:55 -08002068 if (tty_paranoia_check(tty, filp->f_path.dentry->d_inode, "tty_fasync"))
Jonathan Corbet5d1e3232008-06-19 16:04:53 -06002069 goto out;
Alan Cox37bdfb02008-02-08 04:18:47 -08002070
Linus Torvalds1da177e2005-04-16 15:20:36 -07002071 retval = fasync_helper(fd, filp, on, &tty->fasync);
2072 if (retval <= 0)
Jonathan Corbet5d1e3232008-06-19 16:04:53 -06002073 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002074
2075 if (on) {
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08002076 enum pid_type type;
2077 struct pid *pid;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002078 if (!waitqueue_active(&tty->read_wait))
2079 tty->minimum_to_wake = 1;
Alan Cox47f86832008-04-30 00:53:30 -07002080 spin_lock_irqsave(&tty->ctrl_lock, flags);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08002081 if (tty->pgrp) {
2082 pid = tty->pgrp;
2083 type = PIDTYPE_PGID;
2084 } else {
2085 pid = task_pid(current);
2086 type = PIDTYPE_PID;
2087 }
Linus Torvalds80e1e822010-02-07 10:11:23 -08002088 get_pid(pid);
Greg Kroah-Hartman70362512009-12-17 07:07:19 -08002089 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
Linus Torvalds80e1e822010-02-07 10:11:23 -08002090 retval = __f_setown(filp, pid, type, 0);
2091 put_pid(pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002092 if (retval)
Jonathan Corbet5d1e3232008-06-19 16:04:53 -06002093 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002094 } else {
2095 if (!tty->fasync && !waitqueue_active(&tty->read_wait))
2096 tty->minimum_to_wake = N_TTY_BUF_SIZE;
2097 }
Jonathan Corbet5d1e3232008-06-19 16:04:53 -06002098 retval = 0;
2099out:
Arnd Bergmannec79d602010-06-01 22:53:01 +02002100 return retval;
2101}
2102
2103static int tty_fasync(int fd, struct file *filp, int on)
2104{
Alan Cox89c8d912012-08-08 16:30:13 +01002105 struct tty_struct *tty = file_tty(filp);
Arnd Bergmannec79d602010-06-01 22:53:01 +02002106 int retval;
Alan Cox89c8d912012-08-08 16:30:13 +01002107
2108 tty_lock(tty);
Arnd Bergmannec79d602010-06-01 22:53:01 +02002109 retval = __tty_fasync(fd, filp, on);
Alan Cox89c8d912012-08-08 16:30:13 +01002110 tty_unlock(tty);
2111
Jonathan Corbet5d1e3232008-06-19 16:04:53 -06002112 return retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002113}
2114
Alan Coxaf9b8972006-08-27 01:24:01 -07002115/**
2116 * tiocsti - fake input character
2117 * @tty: tty to fake input into
2118 * @p: pointer to character
2119 *
Robert P. J. Day3a4fa0a2007-10-19 23:10:43 +02002120 * Fake input to a tty device. Does the necessary locking and
Alan Coxaf9b8972006-08-27 01:24:01 -07002121 * input management.
2122 *
2123 * FIXME: does not honour flow control ??
2124 *
2125 * Locking:
2126 * Called functions take tty_ldisc_lock
2127 * current->signal->tty check is safe without locks
Alan Cox28298232006-09-29 02:00:58 -07002128 *
2129 * FIXME: may race normal receive processing
Alan Coxaf9b8972006-08-27 01:24:01 -07002130 */
2131
Linus Torvalds1da177e2005-04-16 15:20:36 -07002132static int tiocsti(struct tty_struct *tty, char __user *p)
2133{
2134 char ch, mbz = 0;
2135 struct tty_ldisc *ld;
Alan Cox37bdfb02008-02-08 04:18:47 -08002136
Linus Torvalds1da177e2005-04-16 15:20:36 -07002137 if ((current->signal->tty != tty) && !capable(CAP_SYS_ADMIN))
2138 return -EPERM;
2139 if (get_user(ch, p))
2140 return -EFAULT;
Al Viro1e641742008-12-09 09:23:33 +00002141 tty_audit_tiocsti(tty, ch);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002142 ld = tty_ldisc_ref_wait(tty);
Alan Coxa352def2008-07-16 21:53:12 +01002143 ld->ops->receive_buf(tty, &ch, &mbz, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002144 tty_ldisc_deref(ld);
2145 return 0;
2146}
2147
Alan Coxaf9b8972006-08-27 01:24:01 -07002148/**
2149 * tiocgwinsz - implement window query ioctl
2150 * @tty; tty
2151 * @arg: user buffer for result
2152 *
Alan Cox808a0d32006-09-29 02:00:40 -07002153 * Copies the kernel idea of the window size into the user buffer.
Alan Coxaf9b8972006-08-27 01:24:01 -07002154 *
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002155 * Locking: tty->termios_mutex is taken to ensure the winsize data
Alan Cox808a0d32006-09-29 02:00:40 -07002156 * is consistent.
Alan Coxaf9b8972006-08-27 01:24:01 -07002157 */
2158
Alan Cox37bdfb02008-02-08 04:18:47 -08002159static int tiocgwinsz(struct tty_struct *tty, struct winsize __user *arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002160{
Alan Cox808a0d32006-09-29 02:00:40 -07002161 int err;
2162
Arjan van de Ven5785c952006-09-29 02:00:43 -07002163 mutex_lock(&tty->termios_mutex);
Alan Cox808a0d32006-09-29 02:00:40 -07002164 err = copy_to_user(arg, &tty->winsize, sizeof(*arg));
Arjan van de Ven5785c952006-09-29 02:00:43 -07002165 mutex_unlock(&tty->termios_mutex);
Alan Cox808a0d32006-09-29 02:00:40 -07002166
2167 return err ? -EFAULT: 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002168}
2169
Alan Coxaf9b8972006-08-27 01:24:01 -07002170/**
Alan Cox8c9a9dd2008-08-15 10:39:38 +01002171 * tty_do_resize - resize event
2172 * @tty: tty being resized
Alan Cox8c9a9dd2008-08-15 10:39:38 +01002173 * @rows: rows (character)
2174 * @cols: cols (character)
Alan Coxaf9b8972006-08-27 01:24:01 -07002175 *
Daniel Mack3ad2f3f2010-02-03 08:01:28 +08002176 * Update the termios variables and send the necessary signals to
Alan Cox8c9a9dd2008-08-15 10:39:38 +01002177 * peform a terminal resize correctly
Alan Coxaf9b8972006-08-27 01:24:01 -07002178 */
2179
Alan Coxfc6f6232009-01-02 13:43:17 +00002180int tty_do_resize(struct tty_struct *tty, struct winsize *ws)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002181{
Alan Coxfc6f6232009-01-02 13:43:17 +00002182 struct pid *pgrp;
Alan Cox47f86832008-04-30 00:53:30 -07002183 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002184
Alan Coxfc6f6232009-01-02 13:43:17 +00002185 /* Lock the tty */
2186 mutex_lock(&tty->termios_mutex);
2187 if (!memcmp(ws, &tty->winsize, sizeof(*ws)))
Alan Coxca9bda02006-09-29 02:00:03 -07002188 goto done;
Alan Cox47f86832008-04-30 00:53:30 -07002189 /* Get the PID values and reference them so we can
2190 avoid holding the tty ctrl lock while sending signals */
2191 spin_lock_irqsave(&tty->ctrl_lock, flags);
2192 pgrp = get_pid(tty->pgrp);
Alan Cox47f86832008-04-30 00:53:30 -07002193 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
2194
2195 if (pgrp)
2196 kill_pgrp(pgrp, SIGWINCH, 1);
Alan Cox47f86832008-04-30 00:53:30 -07002197 put_pid(pgrp);
Alan Cox47f86832008-04-30 00:53:30 -07002198
Alan Cox8c9a9dd2008-08-15 10:39:38 +01002199 tty->winsize = *ws;
Alan Coxca9bda02006-09-29 02:00:03 -07002200done:
Alan Coxfc6f6232009-01-02 13:43:17 +00002201 mutex_unlock(&tty->termios_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002202 return 0;
2203}
2204
Alan Coxaf9b8972006-08-27 01:24:01 -07002205/**
Alan Cox8c9a9dd2008-08-15 10:39:38 +01002206 * tiocswinsz - implement window size set ioctl
Alan Coxfc6f6232009-01-02 13:43:17 +00002207 * @tty; tty side of tty
Alan Cox8c9a9dd2008-08-15 10:39:38 +01002208 * @arg: user buffer for result
2209 *
2210 * Copies the user idea of the window size to the kernel. Traditionally
2211 * this is just advisory information but for the Linux console it
2212 * actually has driver level meaning and triggers a VC resize.
2213 *
2214 * Locking:
Lucas De Marchi25985ed2011-03-30 22:57:33 -03002215 * Driver dependent. The default do_resize method takes the
Alan Cox8c9a9dd2008-08-15 10:39:38 +01002216 * tty termios mutex and ctrl_lock. The console takes its own lock
2217 * then calls into the default method.
2218 */
2219
Alan Coxfc6f6232009-01-02 13:43:17 +00002220static int tiocswinsz(struct tty_struct *tty, struct winsize __user *arg)
Alan Cox8c9a9dd2008-08-15 10:39:38 +01002221{
2222 struct winsize tmp_ws;
2223 if (copy_from_user(&tmp_ws, arg, sizeof(*arg)))
2224 return -EFAULT;
2225
2226 if (tty->ops->resize)
Alan Coxfc6f6232009-01-02 13:43:17 +00002227 return tty->ops->resize(tty, &tmp_ws);
Alan Cox8c9a9dd2008-08-15 10:39:38 +01002228 else
Alan Coxfc6f6232009-01-02 13:43:17 +00002229 return tty_do_resize(tty, &tmp_ws);
Alan Cox8c9a9dd2008-08-15 10:39:38 +01002230}
2231
2232/**
Alan Coxaf9b8972006-08-27 01:24:01 -07002233 * tioccons - allow admin to move logical console
2234 * @file: the file to become console
2235 *
Lucas De Marchi25985ed2011-03-30 22:57:33 -03002236 * Allow the administrator to move the redirected console device
Alan Coxaf9b8972006-08-27 01:24:01 -07002237 *
2238 * Locking: uses redirect_lock to guard the redirect information
2239 */
2240
Linus Torvalds1da177e2005-04-16 15:20:36 -07002241static int tioccons(struct file *file)
2242{
2243 if (!capable(CAP_SYS_ADMIN))
2244 return -EPERM;
2245 if (file->f_op->write == redirected_tty_write) {
2246 struct file *f;
2247 spin_lock(&redirect_lock);
2248 f = redirect;
2249 redirect = NULL;
2250 spin_unlock(&redirect_lock);
2251 if (f)
2252 fput(f);
2253 return 0;
2254 }
2255 spin_lock(&redirect_lock);
2256 if (redirect) {
2257 spin_unlock(&redirect_lock);
2258 return -EBUSY;
2259 }
Al Virocb0942b2012-08-27 14:48:26 -04002260 redirect = get_file(file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002261 spin_unlock(&redirect_lock);
2262 return 0;
2263}
2264
Alan Coxaf9b8972006-08-27 01:24:01 -07002265/**
2266 * fionbio - non blocking ioctl
2267 * @file: file to set blocking value
2268 * @p: user parameter
2269 *
2270 * Historical tty interfaces had a blocking control ioctl before
2271 * the generic functionality existed. This piece of history is preserved
2272 * in the expected tty API of posix OS's.
2273 *
Alan Cox6146b9a2009-09-19 13:13:19 -07002274 * Locking: none, the open file handle ensures it won't go away.
Alan Coxaf9b8972006-08-27 01:24:01 -07002275 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002276
2277static int fionbio(struct file *file, int __user *p)
2278{
2279 int nonblock;
2280
2281 if (get_user(nonblock, p))
2282 return -EFAULT;
2283
Jonathan Corbetdb1dd4d2009-02-06 15:25:24 -07002284 spin_lock(&file->f_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002285 if (nonblock)
2286 file->f_flags |= O_NONBLOCK;
2287 else
2288 file->f_flags &= ~O_NONBLOCK;
Jonathan Corbetdb1dd4d2009-02-06 15:25:24 -07002289 spin_unlock(&file->f_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002290 return 0;
2291}
2292
Alan Coxaf9b8972006-08-27 01:24:01 -07002293/**
2294 * tiocsctty - set controlling tty
2295 * @tty: tty structure
2296 * @arg: user argument
2297 *
2298 * This ioctl is used to manage job control. It permits a session
2299 * leader to set this tty as the controlling tty for the session.
2300 *
2301 * Locking:
Alan Cox28298232006-09-29 02:00:58 -07002302 * Takes tty_mutex() to protect tty instance
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002303 * Takes tasklist_lock internally to walk sessions
2304 * Takes ->siglock() when updating signal->tty
Alan Coxaf9b8972006-08-27 01:24:01 -07002305 */
2306
Linus Torvalds1da177e2005-04-16 15:20:36 -07002307static int tiocsctty(struct tty_struct *tty, int arg)
2308{
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002309 int ret = 0;
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08002310 if (current->signal->leader && (task_session(current) == tty->session))
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002311 return ret;
2312
2313 mutex_lock(&tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002314 /*
2315 * The process must be a session leader and
2316 * not have a controlling tty already.
2317 */
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002318 if (!current->signal->leader || current->signal->tty) {
2319 ret = -EPERM;
2320 goto unlock;
2321 }
2322
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08002323 if (tty->session) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002324 /*
2325 * This tty is already the controlling
2326 * tty for another session group!
2327 */
Alan Cox37bdfb02008-02-08 04:18:47 -08002328 if (arg == 1 && capable(CAP_SYS_ADMIN)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002329 /*
2330 * Steal it away
2331 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002332 read_lock(&tasklist_lock);
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002333 session_clear_tty(tty->session);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002334 read_unlock(&tasklist_lock);
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002335 } else {
2336 ret = -EPERM;
2337 goto unlock;
2338 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002339 }
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002340 proc_set_tty(current, tty);
2341unlock:
Alan Cox28298232006-09-29 02:00:58 -07002342 mutex_unlock(&tty_mutex);
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002343 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002344}
2345
Alan Coxaf9b8972006-08-27 01:24:01 -07002346/**
Alan Cox5d0fdf12008-04-30 00:53:31 -07002347 * tty_get_pgrp - return a ref counted pgrp pid
2348 * @tty: tty to read
2349 *
2350 * Returns a refcounted instance of the pid struct for the process
2351 * group controlling the tty.
2352 */
2353
2354struct pid *tty_get_pgrp(struct tty_struct *tty)
2355{
2356 unsigned long flags;
2357 struct pid *pgrp;
2358
2359 spin_lock_irqsave(&tty->ctrl_lock, flags);
2360 pgrp = get_pid(tty->pgrp);
2361 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
2362
2363 return pgrp;
2364}
2365EXPORT_SYMBOL_GPL(tty_get_pgrp);
2366
2367/**
Alan Coxaf9b8972006-08-27 01:24:01 -07002368 * tiocgpgrp - get process group
2369 * @tty: tty passed by user
Lucas De Marchi25985ed2011-03-30 22:57:33 -03002370 * @real_tty: tty side of the tty passed by the user if a pty else the tty
Alan Coxaf9b8972006-08-27 01:24:01 -07002371 * @p: returned pid
2372 *
2373 * Obtain the process group of the tty. If there is no process group
2374 * return an error.
2375 *
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002376 * Locking: none. Reference to current->signal->tty is safe.
Alan Coxaf9b8972006-08-27 01:24:01 -07002377 */
2378
Linus Torvalds1da177e2005-04-16 15:20:36 -07002379static int tiocgpgrp(struct tty_struct *tty, struct tty_struct *real_tty, pid_t __user *p)
2380{
Alan Cox5d0fdf12008-04-30 00:53:31 -07002381 struct pid *pid;
2382 int ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002383 /*
2384 * (tty == real_tty) is a cheap way of
2385 * testing if the tty is NOT a master pty.
2386 */
2387 if (tty == real_tty && current->signal->tty != real_tty)
2388 return -ENOTTY;
Alan Cox5d0fdf12008-04-30 00:53:31 -07002389 pid = tty_get_pgrp(real_tty);
2390 ret = put_user(pid_vnr(pid), p);
2391 put_pid(pid);
2392 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002393}
2394
Alan Coxaf9b8972006-08-27 01:24:01 -07002395/**
2396 * tiocspgrp - attempt to set process group
2397 * @tty: tty passed by user
2398 * @real_tty: tty side device matching tty passed by user
2399 * @p: pid pointer
2400 *
2401 * Set the process group of the tty to the session passed. Only
2402 * permitted where the tty session is our session.
2403 *
Alan Cox47f86832008-04-30 00:53:30 -07002404 * Locking: RCU, ctrl lock
Alan Coxaf9b8972006-08-27 01:24:01 -07002405 */
2406
Linus Torvalds1da177e2005-04-16 15:20:36 -07002407static int tiocspgrp(struct tty_struct *tty, struct tty_struct *real_tty, pid_t __user *p)
2408{
Eric W. Biederman04a2e6a2007-02-12 00:52:56 -08002409 struct pid *pgrp;
2410 pid_t pgrp_nr;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002411 int retval = tty_check_change(real_tty);
Alan Cox47f86832008-04-30 00:53:30 -07002412 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002413
2414 if (retval == -EIO)
2415 return -ENOTTY;
2416 if (retval)
2417 return retval;
2418 if (!current->signal->tty ||
2419 (current->signal->tty != real_tty) ||
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08002420 (real_tty->session != task_session(current)))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002421 return -ENOTTY;
Eric W. Biederman04a2e6a2007-02-12 00:52:56 -08002422 if (get_user(pgrp_nr, p))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002423 return -EFAULT;
Eric W. Biederman04a2e6a2007-02-12 00:52:56 -08002424 if (pgrp_nr < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002425 return -EINVAL;
Eric W. Biederman04a2e6a2007-02-12 00:52:56 -08002426 rcu_read_lock();
Pavel Emelyanovb4888932007-10-18 23:40:14 -07002427 pgrp = find_vpid(pgrp_nr);
Eric W. Biederman04a2e6a2007-02-12 00:52:56 -08002428 retval = -ESRCH;
2429 if (!pgrp)
2430 goto out_unlock;
2431 retval = -EPERM;
2432 if (session_of_pgrp(pgrp) != task_session(current))
2433 goto out_unlock;
2434 retval = 0;
Alan Cox47f86832008-04-30 00:53:30 -07002435 spin_lock_irqsave(&tty->ctrl_lock, flags);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08002436 put_pid(real_tty->pgrp);
2437 real_tty->pgrp = get_pid(pgrp);
Alan Cox47f86832008-04-30 00:53:30 -07002438 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
Eric W. Biederman04a2e6a2007-02-12 00:52:56 -08002439out_unlock:
2440 rcu_read_unlock();
2441 return retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002442}
2443
Alan Coxaf9b8972006-08-27 01:24:01 -07002444/**
2445 * tiocgsid - get session id
2446 * @tty: tty passed by user
Lucas De Marchi25985ed2011-03-30 22:57:33 -03002447 * @real_tty: tty side of the tty passed by the user if a pty else the tty
Alan Coxaf9b8972006-08-27 01:24:01 -07002448 * @p: pointer to returned session id
2449 *
2450 * Obtain the session id of the tty. If there is no session
2451 * return an error.
2452 *
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002453 * Locking: none. Reference to current->signal->tty is safe.
Alan Coxaf9b8972006-08-27 01:24:01 -07002454 */
2455
Linus Torvalds1da177e2005-04-16 15:20:36 -07002456static int tiocgsid(struct tty_struct *tty, struct tty_struct *real_tty, pid_t __user *p)
2457{
2458 /*
2459 * (tty == real_tty) is a cheap way of
2460 * testing if the tty is NOT a master pty.
2461 */
2462 if (tty == real_tty && current->signal->tty != real_tty)
2463 return -ENOTTY;
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08002464 if (!real_tty->session)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002465 return -ENOTTY;
Pavel Emelyanovb4888932007-10-18 23:40:14 -07002466 return put_user(pid_vnr(real_tty->session), p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002467}
2468
Alan Coxaf9b8972006-08-27 01:24:01 -07002469/**
2470 * tiocsetd - set line discipline
2471 * @tty: tty device
2472 * @p: pointer to user data
2473 *
2474 * Set the line discipline according to user request.
2475 *
2476 * Locking: see tty_set_ldisc, this function is just a helper
2477 */
2478
Linus Torvalds1da177e2005-04-16 15:20:36 -07002479static int tiocsetd(struct tty_struct *tty, int __user *p)
2480{
2481 int ldisc;
Alan Cox04f378b2008-04-30 00:53:29 -07002482 int ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002483
2484 if (get_user(ldisc, p))
2485 return -EFAULT;
Alan Cox04f378b2008-04-30 00:53:29 -07002486
Alan Cox04f378b2008-04-30 00:53:29 -07002487 ret = tty_set_ldisc(tty, ldisc);
Alan Cox04f378b2008-04-30 00:53:29 -07002488
2489 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002490}
2491
Alan Coxaf9b8972006-08-27 01:24:01 -07002492/**
2493 * send_break - performed time break
2494 * @tty: device to break on
2495 * @duration: timeout in mS
2496 *
2497 * Perform a timed break on hardware that lacks its own driver level
2498 * timed break functionality.
2499 *
2500 * Locking:
Alan Cox28298232006-09-29 02:00:58 -07002501 * atomic_write_lock serializes
Alan Coxaf9b8972006-08-27 01:24:01 -07002502 *
Alan Coxaf9b8972006-08-27 01:24:01 -07002503 */
2504
Domen Puncerb20f3ae2005-06-25 14:58:42 -07002505static int send_break(struct tty_struct *tty, unsigned int duration)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002506{
Alan Cox9e989662008-07-22 11:18:03 +01002507 int retval;
2508
2509 if (tty->ops->break_ctl == NULL)
2510 return 0;
2511
2512 if (tty->driver->flags & TTY_DRIVER_HARDWARE_BREAK)
2513 retval = tty->ops->break_ctl(tty, duration);
2514 else {
2515 /* Do the work ourselves */
2516 if (tty_write_lock(tty, 0) < 0)
2517 return -EINTR;
2518 retval = tty->ops->break_ctl(tty, -1);
2519 if (retval)
2520 goto out;
2521 if (!signal_pending(current))
2522 msleep_interruptible(duration);
2523 retval = tty->ops->break_ctl(tty, 0);
2524out:
2525 tty_write_unlock(tty);
2526 if (signal_pending(current))
2527 retval = -EINTR;
2528 }
2529 return retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002530}
2531
Alan Coxaf9b8972006-08-27 01:24:01 -07002532/**
Alan Coxf34d7a52008-04-30 00:54:13 -07002533 * tty_tiocmget - get modem status
Alan Coxaf9b8972006-08-27 01:24:01 -07002534 * @tty: tty device
2535 * @file: user file pointer
2536 * @p: pointer to result
2537 *
2538 * Obtain the modem status bits from the tty driver if the feature
2539 * is supported. Return -EINVAL if it is not available.
2540 *
2541 * Locking: none (up to the driver)
2542 */
2543
Alan Cox60b33c12011-02-14 16:26:14 +00002544static int tty_tiocmget(struct tty_struct *tty, int __user *p)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002545{
2546 int retval = -EINVAL;
2547
Alan Coxf34d7a52008-04-30 00:54:13 -07002548 if (tty->ops->tiocmget) {
Alan Cox60b33c12011-02-14 16:26:14 +00002549 retval = tty->ops->tiocmget(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002550
2551 if (retval >= 0)
2552 retval = put_user(retval, p);
2553 }
2554 return retval;
2555}
2556
Alan Coxaf9b8972006-08-27 01:24:01 -07002557/**
Alan Coxf34d7a52008-04-30 00:54:13 -07002558 * tty_tiocmset - set modem status
Alan Coxaf9b8972006-08-27 01:24:01 -07002559 * @tty: tty device
Alan Coxaf9b8972006-08-27 01:24:01 -07002560 * @cmd: command - clear bits, set bits or set all
2561 * @p: pointer to desired bits
2562 *
2563 * Set the modem status bits from the tty driver if the feature
2564 * is supported. Return -EINVAL if it is not available.
2565 *
2566 * Locking: none (up to the driver)
2567 */
2568
Alan Cox20b9d172011-02-14 16:26:50 +00002569static int tty_tiocmset(struct tty_struct *tty, unsigned int cmd,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002570 unsigned __user *p)
2571{
Alan Coxae677512008-07-16 21:56:54 +01002572 int retval;
2573 unsigned int set, clear, val;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002574
Alan Coxae677512008-07-16 21:56:54 +01002575 if (tty->ops->tiocmset == NULL)
2576 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002577
Alan Coxae677512008-07-16 21:56:54 +01002578 retval = get_user(val, p);
2579 if (retval)
2580 return retval;
2581 set = clear = 0;
2582 switch (cmd) {
2583 case TIOCMBIS:
2584 set = val;
2585 break;
2586 case TIOCMBIC:
2587 clear = val;
2588 break;
2589 case TIOCMSET:
2590 set = val;
2591 clear = ~val;
2592 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002593 }
Alan Coxae677512008-07-16 21:56:54 +01002594 set &= TIOCM_DTR|TIOCM_RTS|TIOCM_OUT1|TIOCM_OUT2|TIOCM_LOOP;
2595 clear &= TIOCM_DTR|TIOCM_RTS|TIOCM_OUT1|TIOCM_OUT2|TIOCM_LOOP;
Alan Cox20b9d172011-02-14 16:26:50 +00002596 return tty->ops->tiocmset(tty, set, clear);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002597}
2598
Alan Coxd281da72010-09-16 18:21:24 +01002599static int tty_tiocgicount(struct tty_struct *tty, void __user *arg)
2600{
2601 int retval = -EINVAL;
2602 struct serial_icounter_struct icount;
2603 memset(&icount, 0, sizeof(icount));
2604 if (tty->ops->get_icount)
2605 retval = tty->ops->get_icount(tty, &icount);
2606 if (retval != 0)
2607 return retval;
2608 if (copy_to_user(arg, &icount, sizeof(icount)))
2609 return -EFAULT;
2610 return 0;
2611}
2612
Alan Coxe8b70e72009-06-11 12:48:02 +01002613struct tty_struct *tty_pair_get_tty(struct tty_struct *tty)
2614{
2615 if (tty->driver->type == TTY_DRIVER_TYPE_PTY &&
2616 tty->driver->subtype == PTY_TYPE_MASTER)
2617 tty = tty->link;
2618 return tty;
2619}
2620EXPORT_SYMBOL(tty_pair_get_tty);
2621
2622struct tty_struct *tty_pair_get_pty(struct tty_struct *tty)
2623{
2624 if (tty->driver->type == TTY_DRIVER_TYPE_PTY &&
2625 tty->driver->subtype == PTY_TYPE_MASTER)
2626 return tty;
2627 return tty->link;
2628}
2629EXPORT_SYMBOL(tty_pair_get_pty);
2630
Linus Torvalds1da177e2005-04-16 15:20:36 -07002631/*
2632 * Split this up, as gcc can choke on it otherwise..
2633 */
Alan Cox04f378b2008-04-30 00:53:29 -07002634long tty_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002635{
Nick Piggind996b622010-08-18 04:37:36 +10002636 struct tty_struct *tty = file_tty(file);
2637 struct tty_struct *real_tty;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002638 void __user *p = (void __user *)arg;
2639 int retval;
2640 struct tty_ldisc *ld;
Alan Cox04f378b2008-04-30 00:53:29 -07002641 struct inode *inode = file->f_dentry->d_inode;
Alan Cox37bdfb02008-02-08 04:18:47 -08002642
Linus Torvalds1da177e2005-04-16 15:20:36 -07002643 if (tty_paranoia_check(tty, inode, "tty_ioctl"))
2644 return -EINVAL;
2645
Alan Coxe8b70e72009-06-11 12:48:02 +01002646 real_tty = tty_pair_get_tty(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002647
2648 /*
2649 * Factor out some common prep work
2650 */
2651 switch (cmd) {
2652 case TIOCSETD:
2653 case TIOCSBRK:
2654 case TIOCCBRK:
2655 case TCSBRK:
Alan Cox37bdfb02008-02-08 04:18:47 -08002656 case TCSBRKP:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002657 retval = tty_check_change(tty);
2658 if (retval)
2659 return retval;
2660 if (cmd != TIOCCBRK) {
2661 tty_wait_until_sent(tty, 0);
2662 if (signal_pending(current))
2663 return -EINTR;
2664 }
2665 break;
2666 }
2667
Alan Cox9e989662008-07-22 11:18:03 +01002668 /*
2669 * Now do the stuff.
2670 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002671 switch (cmd) {
Alan Cox37bdfb02008-02-08 04:18:47 -08002672 case TIOCSTI:
2673 return tiocsti(tty, p);
2674 case TIOCGWINSZ:
Alan Cox8f520022008-10-13 10:38:46 +01002675 return tiocgwinsz(real_tty, p);
Alan Cox37bdfb02008-02-08 04:18:47 -08002676 case TIOCSWINSZ:
Alan Coxfc6f6232009-01-02 13:43:17 +00002677 return tiocswinsz(real_tty, p);
Alan Cox37bdfb02008-02-08 04:18:47 -08002678 case TIOCCONS:
2679 return real_tty != tty ? -EINVAL : tioccons(file);
2680 case FIONBIO:
2681 return fionbio(file, p);
2682 case TIOCEXCL:
2683 set_bit(TTY_EXCLUSIVE, &tty->flags);
2684 return 0;
2685 case TIOCNXCL:
2686 clear_bit(TTY_EXCLUSIVE, &tty->flags);
2687 return 0;
2688 case TIOCNOTTY:
2689 if (current->signal->tty != tty)
2690 return -ENOTTY;
2691 no_tty();
2692 return 0;
2693 case TIOCSCTTY:
2694 return tiocsctty(tty, arg);
2695 case TIOCGPGRP:
2696 return tiocgpgrp(tty, real_tty, p);
2697 case TIOCSPGRP:
2698 return tiocspgrp(tty, real_tty, p);
2699 case TIOCGSID:
2700 return tiocgsid(tty, real_tty, p);
2701 case TIOCGETD:
Alan Coxc65c9bc2009-06-11 12:50:12 +01002702 return put_user(tty->ldisc->ops->num, (int __user *)p);
Alan Cox37bdfb02008-02-08 04:18:47 -08002703 case TIOCSETD:
2704 return tiocsetd(tty, p);
Kay Sievers3c95c982011-02-17 18:39:28 +01002705 case TIOCVHANGUP:
2706 if (!capable(CAP_SYS_ADMIN))
2707 return -EPERM;
2708 tty_vhangup(tty);
2709 return 0;
Werner Finkb7b8de02010-12-03 12:48:23 +01002710 case TIOCGDEV:
2711 {
2712 unsigned int ret = new_encode_dev(tty_devnum(real_tty));
2713 return put_user(ret, (unsigned int __user *)p);
2714 }
Alan Cox37bdfb02008-02-08 04:18:47 -08002715 /*
2716 * Break handling
2717 */
2718 case TIOCSBRK: /* Turn break on, unconditionally */
Alan Coxf34d7a52008-04-30 00:54:13 -07002719 if (tty->ops->break_ctl)
Alan Cox9e989662008-07-22 11:18:03 +01002720 return tty->ops->break_ctl(tty, -1);
Alan Cox37bdfb02008-02-08 04:18:47 -08002721 return 0;
Alan Cox37bdfb02008-02-08 04:18:47 -08002722 case TIOCCBRK: /* Turn break off, unconditionally */
Alan Coxf34d7a52008-04-30 00:54:13 -07002723 if (tty->ops->break_ctl)
Alan Cox9e989662008-07-22 11:18:03 +01002724 return tty->ops->break_ctl(tty, 0);
Alan Cox37bdfb02008-02-08 04:18:47 -08002725 return 0;
2726 case TCSBRK: /* SVID version: non-zero arg --> no break */
2727 /* non-zero arg means wait for all output data
2728 * to be sent (performed above) but don't send break.
2729 * This is used by the tcdrain() termios function.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002730 */
Alan Cox37bdfb02008-02-08 04:18:47 -08002731 if (!arg)
2732 return send_break(tty, 250);
2733 return 0;
2734 case TCSBRKP: /* support for POSIX tcsendbreak() */
2735 return send_break(tty, arg ? arg*100 : 250);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002736
Alan Cox37bdfb02008-02-08 04:18:47 -08002737 case TIOCMGET:
Alan Cox60b33c12011-02-14 16:26:14 +00002738 return tty_tiocmget(tty, p);
Alan Cox37bdfb02008-02-08 04:18:47 -08002739 case TIOCMSET:
2740 case TIOCMBIC:
2741 case TIOCMBIS:
Alan Cox20b9d172011-02-14 16:26:50 +00002742 return tty_tiocmset(tty, cmd, p);
Alan Coxd281da72010-09-16 18:21:24 +01002743 case TIOCGICOUNT:
2744 retval = tty_tiocgicount(tty, p);
2745 /* For the moment allow fall through to the old method */
2746 if (retval != -EINVAL)
2747 return retval;
2748 break;
Alan Cox37bdfb02008-02-08 04:18:47 -08002749 case TCFLSH:
2750 switch (arg) {
2751 case TCIFLUSH:
2752 case TCIOFLUSH:
2753 /* flush tty buffer and allow ldisc to process ioctl */
2754 tty_buffer_flush(tty);
Paul Fulghumc5c34d42007-05-12 10:36:55 -07002755 break;
Alan Cox37bdfb02008-02-08 04:18:47 -08002756 }
2757 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002758 }
Alan Coxf34d7a52008-04-30 00:54:13 -07002759 if (tty->ops->ioctl) {
Alan Cox6caa76b2011-02-14 16:27:22 +00002760 retval = (tty->ops->ioctl)(tty, cmd, arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002761 if (retval != -ENOIOCTLCMD)
2762 return retval;
2763 }
2764 ld = tty_ldisc_ref_wait(tty);
2765 retval = -EINVAL;
Alan Coxa352def2008-07-16 21:53:12 +01002766 if (ld->ops->ioctl) {
2767 retval = ld->ops->ioctl(tty, file, cmd, arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002768 if (retval == -ENOIOCTLCMD)
Wanlong Gaobbb63c52012-08-27 15:23:12 +08002769 retval = -ENOTTY;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002770 }
2771 tty_ldisc_deref(ld);
2772 return retval;
2773}
2774
Paul Fulghume10cc1d2007-05-10 22:22:50 -07002775#ifdef CONFIG_COMPAT
Alan Cox37bdfb02008-02-08 04:18:47 -08002776static long tty_compat_ioctl(struct file *file, unsigned int cmd,
Paul Fulghume10cc1d2007-05-10 22:22:50 -07002777 unsigned long arg)
2778{
2779 struct inode *inode = file->f_dentry->d_inode;
Nick Piggind996b622010-08-18 04:37:36 +10002780 struct tty_struct *tty = file_tty(file);
Paul Fulghume10cc1d2007-05-10 22:22:50 -07002781 struct tty_ldisc *ld;
2782 int retval = -ENOIOCTLCMD;
2783
2784 if (tty_paranoia_check(tty, inode, "tty_ioctl"))
2785 return -EINVAL;
2786
Alan Coxf34d7a52008-04-30 00:54:13 -07002787 if (tty->ops->compat_ioctl) {
Alan Cox6caa76b2011-02-14 16:27:22 +00002788 retval = (tty->ops->compat_ioctl)(tty, cmd, arg);
Paul Fulghume10cc1d2007-05-10 22:22:50 -07002789 if (retval != -ENOIOCTLCMD)
2790 return retval;
2791 }
2792
2793 ld = tty_ldisc_ref_wait(tty);
Alan Coxa352def2008-07-16 21:53:12 +01002794 if (ld->ops->compat_ioctl)
2795 retval = ld->ops->compat_ioctl(tty, file, cmd, arg);
Thomas Meyer8193c422011-10-05 23:13:13 +02002796 else
2797 retval = n_tty_compat_ioctl_helper(tty, file, cmd, arg);
Paul Fulghume10cc1d2007-05-10 22:22:50 -07002798 tty_ldisc_deref(ld);
2799
2800 return retval;
2801}
2802#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07002803
Al Viroc3c073f2012-08-21 22:32:06 -04002804static int this_tty(const void *t, struct file *file, unsigned fd)
2805{
2806 if (likely(file->f_op->read != tty_read))
2807 return 0;
2808 return file_tty(file) != t ? 0 : fd + 1;
2809}
2810
Linus Torvalds1da177e2005-04-16 15:20:36 -07002811/*
2812 * This implements the "Secure Attention Key" --- the idea is to
2813 * prevent trojan horses by killing all processes associated with this
2814 * tty when the user hits the "Secure Attention Key". Required for
2815 * super-paranoid applications --- see the Orange Book for more details.
Alan Cox37bdfb02008-02-08 04:18:47 -08002816 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07002817 * This code could be nicer; ideally it should send a HUP, wait a few
2818 * seconds, then send a INT, and then a KILL signal. But you then
2819 * have to coordinate with the init process, since all processes associated
2820 * with the current tty must be dead before the new getty is allowed
2821 * to spawn.
2822 *
2823 * Now, if it would be correct ;-/ The current code has a nasty hole -
2824 * it doesn't catch files in flight. We may send the descriptor to ourselves
2825 * via AF_UNIX socket, close it and later fetch from socket. FIXME.
2826 *
2827 * Nasty bug: do_SAK is being called in interrupt context. This can
2828 * deadlock. We punt it up to process context. AKPM - 16Mar2001
2829 */
Eric W. Biederman8b6312f2007-02-10 01:44:34 -08002830void __do_SAK(struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002831{
2832#ifdef TTY_SOFT_SAK
2833 tty_hangup(tty);
2834#else
Eric W. Biederman652486f2006-03-28 16:11:02 -08002835 struct task_struct *g, *p;
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08002836 struct pid *session;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002837 int i;
Alan Cox37bdfb02008-02-08 04:18:47 -08002838
Linus Torvalds1da177e2005-04-16 15:20:36 -07002839 if (!tty)
2840 return;
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002841 session = tty->session;
Alan Cox37bdfb02008-02-08 04:18:47 -08002842
Dan Carpenterb3f13de2006-12-13 00:35:09 -08002843 tty_ldisc_flush(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002844
Alan Coxf34d7a52008-04-30 00:54:13 -07002845 tty_driver_flush_buffer(tty);
Alan Cox37bdfb02008-02-08 04:18:47 -08002846
Linus Torvalds1da177e2005-04-16 15:20:36 -07002847 read_lock(&tasklist_lock);
Eric W. Biederman652486f2006-03-28 16:11:02 -08002848 /* Kill the entire session */
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08002849 do_each_pid_task(session, PIDTYPE_SID, p) {
Eric W. Biederman652486f2006-03-28 16:11:02 -08002850 printk(KERN_NOTICE "SAK: killed process %d"
Oleg Nesterov1b0f7ff2009-04-02 16:58:39 -07002851 " (%s): task_session(p)==tty->session\n",
Pavel Emelyanovba25f9d2007-10-18 23:40:40 -07002852 task_pid_nr(p), p->comm);
Eric W. Biederman652486f2006-03-28 16:11:02 -08002853 send_sig(SIGKILL, p, 1);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08002854 } while_each_pid_task(session, PIDTYPE_SID, p);
Eric W. Biederman652486f2006-03-28 16:11:02 -08002855 /* Now kill any processes that happen to have the
2856 * tty open.
2857 */
2858 do_each_thread(g, p) {
2859 if (p->signal->tty == tty) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002860 printk(KERN_NOTICE "SAK: killed process %d"
Oleg Nesterov1b0f7ff2009-04-02 16:58:39 -07002861 " (%s): task_session(p)==tty->session\n",
Pavel Emelyanovba25f9d2007-10-18 23:40:40 -07002862 task_pid_nr(p), p->comm);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002863 send_sig(SIGKILL, p, 1);
2864 continue;
2865 }
2866 task_lock(p);
Al Viroc3c073f2012-08-21 22:32:06 -04002867 i = iterate_fd(p->files, 0, this_tty, tty);
2868 if (i != 0) {
2869 printk(KERN_NOTICE "SAK: killed process %d"
2870 " (%s): fd#%d opened to the tty\n",
2871 task_pid_nr(p), p->comm, i - 1);
2872 force_sig(SIGKILL, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002873 }
2874 task_unlock(p);
Eric W. Biederman652486f2006-03-28 16:11:02 -08002875 } while_each_thread(g, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002876 read_unlock(&tasklist_lock);
2877#endif
2878}
2879
Eric W. Biederman8b6312f2007-02-10 01:44:34 -08002880static 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
Linus Torvalds1da177e2005-04-16 15:20:36 -07002887/*
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 */
2893void do_SAK(struct tty_struct *tty)
2894{
2895 if (!tty)
2896 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002897 schedule_work(&tty->SAK_work);
2898}
2899
2900EXPORT_SYMBOL(do_SAK);
2901
Dmitry Eremin-Solenikov30004ac2010-08-09 18:22:49 +04002902static 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! */
2909static 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
Alan Coxaf9b8972006-08-27 01:24:01 -07002916/**
Alan Coxaf9b8972006-08-27 01:24:01 -07002917 * 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
Linus Torvalds1da177e2005-04-16 15:20:36 -07002924 */
Alan Coxaf9b8972006-08-27 01:24:01 -07002925
Alan Coxbf970ee2008-10-13 10:42:39 +01002926void initialize_tty_struct(struct tty_struct *tty,
2927 struct tty_driver *driver, int idx)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002928{
2929 memset(tty, 0, sizeof(struct tty_struct));
Alan Cox9c9f4de2008-10-13 10:37:26 +01002930 kref_init(&tty->kref);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002931 tty->magic = TTY_MAGIC;
Alan Cox01e1abb2008-07-22 11:16:55 +01002932 tty_ldisc_init(tty);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08002933 tty->session = NULL;
2934 tty->pgrp = NULL;
Alan Cox33f0f882006-01-09 20:54:13 -08002935 tty_buffer_init(tty);
Alan Cox89c8d912012-08-08 16:30:13 +01002936 mutex_init(&tty->legacy_mutex);
Arjan van de Ven5785c952006-09-29 02:00:43 -07002937 mutex_init(&tty->termios_mutex);
Alan Coxc65c9bc2009-06-11 12:50:12 +01002938 mutex_init(&tty->ldisc_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002939 init_waitqueue_head(&tty->write_wait);
2940 init_waitqueue_head(&tty->read_wait);
David Howells65f27f32006-11-22 14:55:48 +00002941 INIT_WORK(&tty->hangup_work, do_tty_hangup);
Ingo Molnar70522e12006-03-23 03:00:31 -08002942 mutex_init(&tty->atomic_write_lock);
Alan Cox04f378b2008-04-30 00:53:29 -07002943 spin_lock_init(&tty->ctrl_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002944 INIT_LIST_HEAD(&tty->tty_files);
Eric W. Biederman7f1f86a2007-02-13 14:38:58 -07002945 INIT_WORK(&tty->SAK_work, do_SAK_work);
Alan Coxbf970ee2008-10-13 10:42:39 +01002946
2947 tty->driver = driver;
2948 tty->ops = driver->ops;
2949 tty->index = idx;
2950 tty_line_name(driver, idx, tty->name);
Dmitry Eremin-Solenikov30004ac2010-08-09 18:22:49 +04002951 tty->dev = tty_get_device(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002952}
2953
Alan Coxf34d7a52008-04-30 00:54:13 -07002954/**
Jiri Slaby67166712011-03-23 10:48:35 +01002955 * deinitialize_tty_struct
2956 * @tty: tty to deinitialize
2957 *
2958 * This subroutine deinitializes a tty structure that has been newly
2959 * allocated but tty_release cannot be called on that yet.
2960 *
2961 * Locking: none - tty in question must not be exposed at this point
2962 */
2963void deinitialize_tty_struct(struct tty_struct *tty)
2964{
2965 tty_ldisc_deinit(tty);
2966}
2967
2968/**
Alan Coxf34d7a52008-04-30 00:54:13 -07002969 * tty_put_char - write one character to a tty
2970 * @tty: tty
2971 * @ch: character
2972 *
2973 * Write one byte to the tty using the provided put_char method
2974 * if present. Returns the number of characters successfully output.
2975 *
2976 * Note: the specific put_char operation in the driver layer may go
2977 * away soon. Don't call it directly, use this method
Linus Torvalds1da177e2005-04-16 15:20:36 -07002978 */
Alan Coxaf9b8972006-08-27 01:24:01 -07002979
Alan Coxf34d7a52008-04-30 00:54:13 -07002980int tty_put_char(struct tty_struct *tty, unsigned char ch)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002981{
Alan Coxf34d7a52008-04-30 00:54:13 -07002982 if (tty->ops->put_char)
2983 return tty->ops->put_char(tty, ch);
2984 return tty->ops->write(tty, &ch, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002985}
Alan Coxf34d7a52008-04-30 00:54:13 -07002986EXPORT_SYMBOL_GPL(tty_put_char);
2987
Alan Coxd81ed102008-10-13 10:41:42 +01002988struct class *tty_class;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002989
Jiri Slaby7e73eca2012-08-08 22:26:44 +02002990static int tty_cdev_add(struct tty_driver *driver, dev_t dev,
2991 unsigned int index, unsigned int count)
2992{
2993 /* init here, since reused cdevs cause crashes */
2994 cdev_init(&driver->cdevs[index], &tty_fops);
2995 driver->cdevs[index].owner = driver->owner;
2996 return cdev_add(&driver->cdevs[index], dev, count);
2997}
2998
Linus Torvalds1da177e2005-04-16 15:20:36 -07002999/**
Alan Coxaf9b8972006-08-27 01:24:01 -07003000 * tty_register_device - register a tty device
3001 * @driver: the tty driver that describes the tty device
3002 * @index: the index in the tty driver for this tty device
3003 * @device: a struct device that is associated with this tty device.
3004 * This field is optional, if there is no known struct device
3005 * for this tty device it can be set to NULL safely.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003006 *
Greg Kroah-Hartman01107d32006-08-07 22:19:37 -07003007 * Returns a pointer to the struct device for this tty device
3008 * (or ERR_PTR(-EFOO) on error).
Hansjoerg Lipp1cdcb6b2006-04-22 18:36:53 +02003009 *
Alan Coxaf9b8972006-08-27 01:24:01 -07003010 * This call is required to be made to register an individual tty device
3011 * if the tty driver's flags have the TTY_DRIVER_DYNAMIC_DEV bit set. If
3012 * that bit is not set, this function should not be called by a tty
3013 * driver.
3014 *
3015 * Locking: ??
Linus Torvalds1da177e2005-04-16 15:20:36 -07003016 */
Alan Coxaf9b8972006-08-27 01:24:01 -07003017
Greg Kroah-Hartman01107d32006-08-07 22:19:37 -07003018struct device *tty_register_device(struct tty_driver *driver, unsigned index,
3019 struct device *device)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003020{
Tomas Hlavacek6915c0e2012-09-06 03:17:18 +02003021 return tty_register_device_attr(driver, index, device, NULL, NULL);
3022}
3023EXPORT_SYMBOL(tty_register_device);
3024
Tomas Hlavacekb1b79912012-09-06 23:17:47 +02003025static void tty_device_create_release(struct device *dev)
3026{
3027 pr_debug("device: '%s': %s\n", dev_name(dev), __func__);
3028 kfree(dev);
3029}
3030
Tomas Hlavacek6915c0e2012-09-06 03:17:18 +02003031/**
3032 * tty_register_device_attr - register a tty device
3033 * @driver: the tty driver that describes the tty device
3034 * @index: the index in the tty driver for this tty device
3035 * @device: a struct device that is associated with this tty device.
3036 * This field is optional, if there is no known struct device
3037 * for this tty device it can be set to NULL safely.
3038 * @drvdata: Driver data to be set to device.
3039 * @attr_grp: Attribute group to be set on device.
3040 *
3041 * Returns a pointer to the struct device for this tty device
3042 * (or ERR_PTR(-EFOO) on error).
3043 *
3044 * This call is required to be made to register an individual tty device
3045 * if the tty driver's flags have the TTY_DRIVER_DYNAMIC_DEV bit set. If
3046 * that bit is not set, this function should not be called by a tty
3047 * driver.
3048 *
3049 * Locking: ??
3050 */
3051struct device *tty_register_device_attr(struct tty_driver *driver,
3052 unsigned index, struct device *device,
3053 void *drvdata,
3054 const struct attribute_group **attr_grp)
3055{
Linus Torvalds1da177e2005-04-16 15:20:36 -07003056 char name[64];
Tomas Hlavacek6915c0e2012-09-06 03:17:18 +02003057 dev_t devt = MKDEV(driver->major, driver->minor_start) + index;
3058 struct device *dev = NULL;
3059 int retval = -ENODEV;
Jiri Slaby7e73eca2012-08-08 22:26:44 +02003060 bool cdev = false;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003061
3062 if (index >= driver->num) {
3063 printk(KERN_ERR "Attempt to register invalid tty line number "
3064 " (%d).\n", index);
Hansjoerg Lipp1cdcb6b2006-04-22 18:36:53 +02003065 return ERR_PTR(-EINVAL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003066 }
3067
Linus Torvalds1da177e2005-04-16 15:20:36 -07003068 if (driver->type == TTY_DRIVER_TYPE_PTY)
3069 pty_line_name(driver, index, name);
3070 else
3071 tty_line_name(driver, index, name);
Hansjoerg Lipp1cdcb6b2006-04-22 18:36:53 +02003072
Jiri Slaby7e73eca2012-08-08 22:26:44 +02003073 if (!(driver->flags & TTY_DRIVER_DYNAMIC_ALLOC)) {
Tomas Hlavacek6915c0e2012-09-06 03:17:18 +02003074 retval = tty_cdev_add(driver, devt, index, 1);
3075 if (retval)
3076 goto error;
Jiri Slaby7e73eca2012-08-08 22:26:44 +02003077 cdev = true;
3078 }
3079
Tomas Hlavacek6915c0e2012-09-06 03:17:18 +02003080 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
3081 if (!dev) {
3082 retval = -ENOMEM;
3083 goto error;
3084 }
Jiri Slaby7e73eca2012-08-08 22:26:44 +02003085
Tomas Hlavacek6915c0e2012-09-06 03:17:18 +02003086 dev->devt = devt;
3087 dev->class = tty_class;
3088 dev->parent = device;
Tomas Hlavacekb1b79912012-09-06 23:17:47 +02003089 dev->release = tty_device_create_release;
Tomas Hlavacek6915c0e2012-09-06 03:17:18 +02003090 dev_set_name(dev, "%s", name);
3091 dev->groups = attr_grp;
3092 dev_set_drvdata(dev, drvdata);
3093
3094 retval = device_register(dev);
3095 if (retval)
3096 goto error;
3097
3098 return dev;
3099
3100error:
3101 put_device(dev);
3102 if (cdev)
3103 cdev_del(&driver->cdevs[index]);
3104 return ERR_PTR(retval);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003105}
Tomas Hlavacek6915c0e2012-09-06 03:17:18 +02003106EXPORT_SYMBOL_GPL(tty_register_device_attr);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003107
3108/**
Alan Coxaf9b8972006-08-27 01:24:01 -07003109 * tty_unregister_device - unregister a tty device
3110 * @driver: the tty driver that describes the tty device
3111 * @index: the index in the tty driver for this tty device
Linus Torvalds1da177e2005-04-16 15:20:36 -07003112 *
Alan Coxaf9b8972006-08-27 01:24:01 -07003113 * If a tty device is registered with a call to tty_register_device() then
3114 * this function must be called when the tty device is gone.
3115 *
3116 * Locking: ??
Linus Torvalds1da177e2005-04-16 15:20:36 -07003117 */
Alan Coxaf9b8972006-08-27 01:24:01 -07003118
Linus Torvalds1da177e2005-04-16 15:20:36 -07003119void tty_unregister_device(struct tty_driver *driver, unsigned index)
3120{
Alan Cox37bdfb02008-02-08 04:18:47 -08003121 device_destroy(tty_class,
3122 MKDEV(driver->major, driver->minor_start) + index);
Jiri Slaby7e73eca2012-08-08 22:26:44 +02003123 if (!(driver->flags & TTY_DRIVER_DYNAMIC_ALLOC))
3124 cdev_del(&driver->cdevs[index]);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003125}
Linus Torvalds1da177e2005-04-16 15:20:36 -07003126EXPORT_SYMBOL(tty_unregister_device);
3127
Jiri Slaby7f0bc6a2012-08-07 21:47:42 +02003128/**
3129 * __tty_alloc_driver -- allocate tty driver
3130 * @lines: count of lines this driver can handle at most
3131 * @owner: module which is repsonsible for this driver
3132 * @flags: some of TTY_DRIVER_* flags, will be set in driver->flags
3133 *
3134 * This should not be called directly, some of the provided macros should be
3135 * used instead. Use IS_ERR and friends on @retval.
3136 */
3137struct tty_driver *__tty_alloc_driver(unsigned int lines, struct module *owner,
3138 unsigned long flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003139{
3140 struct tty_driver *driver;
Jiri Slaby7e73eca2012-08-08 22:26:44 +02003141 unsigned int cdevs = 1;
Jiri Slaby16a02082012-08-08 22:26:42 +02003142 int err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003143
Jiri Slaby0019b402012-08-08 22:26:43 +02003144 if (!lines || (flags & TTY_DRIVER_UNNUMBERED_NODE && lines > 1))
Jiri Slaby7f0bc6a2012-08-07 21:47:42 +02003145 return ERR_PTR(-EINVAL);
3146
Jean Delvare506eb992007-07-15 23:40:14 -07003147 driver = kzalloc(sizeof(struct tty_driver), GFP_KERNEL);
Jiri Slaby7f0bc6a2012-08-07 21:47:42 +02003148 if (!driver)
3149 return ERR_PTR(-ENOMEM);
3150
3151 kref_init(&driver->kref);
3152 driver->magic = TTY_DRIVER_MAGIC;
3153 driver->num = lines;
3154 driver->owner = owner;
3155 driver->flags = flags;
Jiri Slaby16a02082012-08-08 22:26:42 +02003156
3157 if (!(flags & TTY_DRIVER_DEVPTS_MEM)) {
3158 driver->ttys = kcalloc(lines, sizeof(*driver->ttys),
3159 GFP_KERNEL);
3160 driver->termios = kcalloc(lines, sizeof(*driver->termios),
3161 GFP_KERNEL);
3162 if (!driver->ttys || !driver->termios) {
3163 err = -ENOMEM;
3164 goto err_free_all;
3165 }
3166 }
3167
3168 if (!(flags & TTY_DRIVER_DYNAMIC_ALLOC)) {
3169 driver->ports = kcalloc(lines, sizeof(*driver->ports),
3170 GFP_KERNEL);
3171 if (!driver->ports) {
3172 err = -ENOMEM;
3173 goto err_free_all;
3174 }
Jiri Slaby7e73eca2012-08-08 22:26:44 +02003175 cdevs = lines;
3176 }
3177
3178 driver->cdevs = kcalloc(cdevs, sizeof(*driver->cdevs), GFP_KERNEL);
3179 if (!driver->cdevs) {
3180 err = -ENOMEM;
3181 goto err_free_all;
Jiri Slaby16a02082012-08-08 22:26:42 +02003182 }
Jiri Slaby7f0bc6a2012-08-07 21:47:42 +02003183
Linus Torvalds1da177e2005-04-16 15:20:36 -07003184 return driver;
Jiri Slaby16a02082012-08-08 22:26:42 +02003185err_free_all:
3186 kfree(driver->ports);
3187 kfree(driver->ttys);
3188 kfree(driver->termios);
3189 kfree(driver);
3190 return ERR_PTR(err);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003191}
Jiri Slaby7f0bc6a2012-08-07 21:47:42 +02003192EXPORT_SYMBOL(__tty_alloc_driver);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003193
Alan Cox7d7b93c2008-10-13 10:42:09 +01003194static void destruct_tty_driver(struct kref *kref)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003195{
Alan Cox7d7b93c2008-10-13 10:42:09 +01003196 struct tty_driver *driver = container_of(kref, struct tty_driver, kref);
3197 int i;
3198 struct ktermios *tp;
Alan Cox7d7b93c2008-10-13 10:42:09 +01003199
3200 if (driver->flags & TTY_DRIVER_INSTALLED) {
3201 /*
3202 * Free the termios and termios_locked structures because
3203 * we don't want to get memory leaks when modular tty
3204 * drivers are removed from the kernel.
3205 */
3206 for (i = 0; i < driver->num; i++) {
3207 tp = driver->termios[i];
3208 if (tp) {
3209 driver->termios[i] = NULL;
3210 kfree(tp);
3211 }
Alan Cox7d7b93c2008-10-13 10:42:09 +01003212 if (!(driver->flags & TTY_DRIVER_DYNAMIC_DEV))
3213 tty_unregister_device(driver, i);
3214 }
Alan Cox7d7b93c2008-10-13 10:42:09 +01003215 proc_tty_unregister_driver(driver);
Jiri Slaby7e73eca2012-08-08 22:26:44 +02003216 if (driver->flags & TTY_DRIVER_DYNAMIC_ALLOC)
3217 cdev_del(&driver->cdevs[0]);
Alan Cox7d7b93c2008-10-13 10:42:09 +01003218 }
Jiri Slaby7e73eca2012-08-08 22:26:44 +02003219 kfree(driver->cdevs);
Jiri Slaby04831dc2012-06-04 13:35:36 +02003220 kfree(driver->ports);
Jiri Slaby16a02082012-08-08 22:26:42 +02003221 kfree(driver->termios);
3222 kfree(driver->ttys);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003223 kfree(driver);
3224}
3225
Alan Cox7d7b93c2008-10-13 10:42:09 +01003226void tty_driver_kref_put(struct tty_driver *driver)
3227{
3228 kref_put(&driver->kref, destruct_tty_driver);
3229}
3230EXPORT_SYMBOL(tty_driver_kref_put);
3231
Jeff Dikeb68e31d2006-10-02 02:17:18 -07003232void tty_set_operations(struct tty_driver *driver,
3233 const struct tty_operations *op)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003234{
Alan Coxf34d7a52008-04-30 00:54:13 -07003235 driver->ops = op;
3236};
Linus Torvalds1da177e2005-04-16 15:20:36 -07003237EXPORT_SYMBOL(tty_set_operations);
3238
Alan Cox7d7b93c2008-10-13 10:42:09 +01003239void put_tty_driver(struct tty_driver *d)
3240{
3241 tty_driver_kref_put(d);
3242}
3243EXPORT_SYMBOL(put_tty_driver);
3244
Linus Torvalds1da177e2005-04-16 15:20:36 -07003245/*
3246 * Called by a tty driver to register itself.
3247 */
3248int tty_register_driver(struct tty_driver *driver)
3249{
3250 int error;
Alan Cox37bdfb02008-02-08 04:18:47 -08003251 int i;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003252 dev_t dev;
Vasiliy Kulikovb670bde2010-09-05 22:32:22 +04003253 struct device *d;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003254
Linus Torvalds1da177e2005-04-16 15:20:36 -07003255 if (!driver->major) {
Alan Cox37bdfb02008-02-08 04:18:47 -08003256 error = alloc_chrdev_region(&dev, driver->minor_start,
3257 driver->num, driver->name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003258 if (!error) {
3259 driver->major = MAJOR(dev);
3260 driver->minor_start = MINOR(dev);
3261 }
3262 } else {
3263 dev = MKDEV(driver->major, driver->minor_start);
Geert Uytterhoevene5717c42007-02-20 15:45:21 +01003264 error = register_chrdev_region(dev, driver->num, driver->name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003265 }
Jiri Slaby9bb8a3d2012-06-04 13:35:35 +02003266 if (error < 0)
Jiri Slaby16a02082012-08-08 22:26:42 +02003267 goto err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003268
Jiri Slaby7e73eca2012-08-08 22:26:44 +02003269 if (driver->flags & TTY_DRIVER_DYNAMIC_ALLOC) {
3270 error = tty_cdev_add(driver, dev, 0, driver->num);
3271 if (error)
3272 goto err_unreg_char;
3273 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003274
Alexey Dobriyanca509f62007-05-08 00:27:12 -07003275 mutex_lock(&tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003276 list_add(&driver->tty_drivers, &tty_drivers);
Alexey Dobriyanca509f62007-05-08 00:27:12 -07003277 mutex_unlock(&tty_mutex);
Alan Cox37bdfb02008-02-08 04:18:47 -08003278
3279 if (!(driver->flags & TTY_DRIVER_DYNAMIC_DEV)) {
Vasiliy Kulikovb670bde2010-09-05 22:32:22 +04003280 for (i = 0; i < driver->num; i++) {
3281 d = tty_register_device(driver, i, NULL);
3282 if (IS_ERR(d)) {
3283 error = PTR_ERR(d);
Jiri Slaby16a02082012-08-08 22:26:42 +02003284 goto err_unreg_devs;
Vasiliy Kulikovb670bde2010-09-05 22:32:22 +04003285 }
3286 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003287 }
3288 proc_tty_register_driver(driver);
Alan Cox7d7b93c2008-10-13 10:42:09 +01003289 driver->flags |= TTY_DRIVER_INSTALLED;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003290 return 0;
Vasiliy Kulikovb670bde2010-09-05 22:32:22 +04003291
Jiri Slaby16a02082012-08-08 22:26:42 +02003292err_unreg_devs:
Vasiliy Kulikovb670bde2010-09-05 22:32:22 +04003293 for (i--; i >= 0; i--)
3294 tty_unregister_device(driver, i);
3295
3296 mutex_lock(&tty_mutex);
3297 list_del(&driver->tty_drivers);
3298 mutex_unlock(&tty_mutex);
3299
Jiri Slaby9bb8a3d2012-06-04 13:35:35 +02003300err_unreg_char:
Vasiliy Kulikovb670bde2010-09-05 22:32:22 +04003301 unregister_chrdev_region(dev, driver->num);
Jiri Slaby16a02082012-08-08 22:26:42 +02003302err:
Vasiliy Kulikovb670bde2010-09-05 22:32:22 +04003303 return error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003304}
Linus Torvalds1da177e2005-04-16 15:20:36 -07003305EXPORT_SYMBOL(tty_register_driver);
3306
3307/*
3308 * Called by a tty driver to unregister itself.
3309 */
3310int tty_unregister_driver(struct tty_driver *driver)
3311{
Alan Cox7d7b93c2008-10-13 10:42:09 +01003312#if 0
3313 /* FIXME */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003314 if (driver->refcount)
3315 return -EBUSY;
Alan Cox7d7b93c2008-10-13 10:42:09 +01003316#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07003317 unregister_chrdev_region(MKDEV(driver->major, driver->minor_start),
3318 driver->num);
Alexey Dobriyanca509f62007-05-08 00:27:12 -07003319 mutex_lock(&tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003320 list_del(&driver->tty_drivers);
Alexey Dobriyanca509f62007-05-08 00:27:12 -07003321 mutex_unlock(&tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003322 return 0;
3323}
Alan Cox7d7b93c2008-10-13 10:42:09 +01003324
Linus Torvalds1da177e2005-04-16 15:20:36 -07003325EXPORT_SYMBOL(tty_unregister_driver);
3326
Peter Zijlstra24ec8392006-12-08 02:36:04 -08003327dev_t tty_devnum(struct tty_struct *tty)
3328{
3329 return MKDEV(tty->driver->major, tty->driver->minor_start) + tty->index;
3330}
3331EXPORT_SYMBOL(tty_devnum);
3332
3333void proc_clear_tty(struct task_struct *p)
3334{
Arjan van de Ven7c3b1dc2008-10-15 10:52:34 +01003335 unsigned long flags;
Alan Cox9c9f4de2008-10-13 10:37:26 +01003336 struct tty_struct *tty;
Arjan van de Ven7c3b1dc2008-10-15 10:52:34 +01003337 spin_lock_irqsave(&p->sighand->siglock, flags);
Alan Cox9c9f4de2008-10-13 10:37:26 +01003338 tty = p->signal->tty;
Peter Zijlstra24ec8392006-12-08 02:36:04 -08003339 p->signal->tty = NULL;
Arjan van de Ven7c3b1dc2008-10-15 10:52:34 +01003340 spin_unlock_irqrestore(&p->sighand->siglock, flags);
Alan Cox9c9f4de2008-10-13 10:37:26 +01003341 tty_kref_put(tty);
Peter Zijlstra24ec8392006-12-08 02:36:04 -08003342}
Peter Zijlstra24ec8392006-12-08 02:36:04 -08003343
Alan Cox47f86832008-04-30 00:53:30 -07003344/* Called under the sighand lock */
3345
Eric W. Biederman2a65f1d2007-05-08 00:26:53 -07003346static void __proc_set_tty(struct task_struct *tsk, struct tty_struct *tty)
Peter Zijlstra24ec8392006-12-08 02:36:04 -08003347{
3348 if (tty) {
Alan Cox47f86832008-04-30 00:53:30 -07003349 unsigned long flags;
3350 /* We should not have a session or pgrp to put here but.... */
3351 spin_lock_irqsave(&tty->ctrl_lock, flags);
Eric W. Biedermand9c1e9a2007-03-18 12:45:44 -06003352 put_pid(tty->session);
3353 put_pid(tty->pgrp);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08003354 tty->pgrp = get_pid(task_pgrp(tsk));
Alan Cox47f86832008-04-30 00:53:30 -07003355 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
3356 tty->session = get_pid(task_session(tsk));
Alan Cox9c9f4de2008-10-13 10:37:26 +01003357 if (tsk->signal->tty) {
3358 printk(KERN_DEBUG "tty not NULL!!\n");
3359 tty_kref_put(tsk->signal->tty);
3360 }
Peter Zijlstra24ec8392006-12-08 02:36:04 -08003361 }
Eric W. Biederman2a65f1d2007-05-08 00:26:53 -07003362 put_pid(tsk->signal->tty_old_pgrp);
Alan Cox9c9f4de2008-10-13 10:37:26 +01003363 tsk->signal->tty = tty_kref_get(tty);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08003364 tsk->signal->tty_old_pgrp = NULL;
Peter Zijlstra24ec8392006-12-08 02:36:04 -08003365}
3366
Eric W. Biederman98a27ba2007-05-08 00:26:56 -07003367static void proc_set_tty(struct task_struct *tsk, struct tty_struct *tty)
Peter Zijlstra24ec8392006-12-08 02:36:04 -08003368{
3369 spin_lock_irq(&tsk->sighand->siglock);
Eric W. Biederman2a65f1d2007-05-08 00:26:53 -07003370 __proc_set_tty(tsk, tty);
Peter Zijlstra24ec8392006-12-08 02:36:04 -08003371 spin_unlock_irq(&tsk->sighand->siglock);
3372}
3373
3374struct tty_struct *get_current_tty(void)
3375{
3376 struct tty_struct *tty;
Alan Cox934e6eb2008-10-13 10:40:43 +01003377 unsigned long flags;
3378
3379 spin_lock_irqsave(&current->sighand->siglock, flags);
Alan Cox452a00d2008-10-13 10:39:13 +01003380 tty = tty_kref_get(current->signal->tty);
Alan Cox934e6eb2008-10-13 10:40:43 +01003381 spin_unlock_irqrestore(&current->sighand->siglock, flags);
Peter Zijlstra24ec8392006-12-08 02:36:04 -08003382 return tty;
3383}
Heiko Carstensa311f742006-12-13 00:33:41 -08003384EXPORT_SYMBOL_GPL(get_current_tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003385
Alan Coxd81ed102008-10-13 10:41:42 +01003386void tty_default_fops(struct file_operations *fops)
3387{
3388 *fops = tty_fops;
3389}
3390
Linus Torvalds1da177e2005-04-16 15:20:36 -07003391/*
3392 * Initialize the console device. This is called *early*, so
3393 * we can't necessarily depend on lots of kernel help here.
3394 * Just do some early initializations, and do the complex setup
3395 * later.
3396 */
3397void __init console_init(void)
3398{
3399 initcall_t *call;
3400
3401 /* Setup the default TTY line discipline. */
Alan Cox01e1abb2008-07-22 11:16:55 +01003402 tty_ldisc_begin();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003403
3404 /*
Alan Cox37bdfb02008-02-08 04:18:47 -08003405 * set up the console device so that later boot sequences can
Linus Torvalds1da177e2005-04-16 15:20:36 -07003406 * inform about problems etc..
3407 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003408 call = __con_initcall_start;
3409 while (call < __con_initcall_end) {
3410 (*call)();
3411 call++;
3412 }
3413}
3414
Al Viro2c9ede52011-07-23 20:24:48 -04003415static char *tty_devnode(struct device *dev, umode_t *mode)
Kay Sieverse454cea2009-09-18 23:01:12 +02003416{
3417 if (!mode)
3418 return NULL;
3419 if (dev->devt == MKDEV(TTYAUX_MAJOR, 0) ||
3420 dev->devt == MKDEV(TTYAUX_MAJOR, 2))
3421 *mode = 0666;
3422 return NULL;
3423}
3424
Linus Torvalds1da177e2005-04-16 15:20:36 -07003425static int __init tty_class_init(void)
3426{
gregkh@suse.de7fe845d2005-03-15 14:23:15 -08003427 tty_class = class_create(THIS_MODULE, "tty");
Linus Torvalds1da177e2005-04-16 15:20:36 -07003428 if (IS_ERR(tty_class))
3429 return PTR_ERR(tty_class);
Kay Sieverse454cea2009-09-18 23:01:12 +02003430 tty_class->devnode = tty_devnode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003431 return 0;
3432}
3433
3434postcore_initcall(tty_class_init);
3435
3436/* 3/2004 jmc: why do these devices exist? */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003437static struct cdev tty_cdev, console_cdev;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003438
Kay Sieversfbc92a32010-12-01 18:51:05 +01003439static ssize_t show_cons_active(struct device *dev,
3440 struct device_attribute *attr, char *buf)
3441{
3442 struct console *cs[16];
3443 int i = 0;
3444 struct console *c;
3445 ssize_t count = 0;
3446
Torben Hohnac751ef2011-01-25 15:07:35 -08003447 console_lock();
Kay Sieversa2a6a822011-01-09 16:39:14 +01003448 for_each_console(c) {
Kay Sieversfbc92a32010-12-01 18:51:05 +01003449 if (!c->device)
3450 continue;
3451 if (!c->write)
3452 continue;
3453 if ((c->flags & CON_ENABLED) == 0)
3454 continue;
3455 cs[i++] = c;
3456 if (i >= ARRAY_SIZE(cs))
3457 break;
3458 }
3459 while (i--)
3460 count += sprintf(buf + count, "%s%d%c",
3461 cs[i]->name, cs[i]->index, i ? ' ':'\n');
Torben Hohnac751ef2011-01-25 15:07:35 -08003462 console_unlock();
Kay Sieversfbc92a32010-12-01 18:51:05 +01003463
3464 return count;
3465}
3466static DEVICE_ATTR(active, S_IRUGO, show_cons_active, NULL);
3467
3468static struct device *consdev;
3469
3470void console_sysfs_notify(void)
3471{
3472 if (consdev)
3473 sysfs_notify(&consdev->kobj, NULL, "active");
3474}
3475
Linus Torvalds1da177e2005-04-16 15:20:36 -07003476/*
3477 * Ok, now we can initialize the rest of the tty devices and can count
3478 * on memory allocations, interrupts etc..
3479 */
David Howells31d1d482010-08-06 16:34:43 +01003480int __init tty_init(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003481{
3482 cdev_init(&tty_cdev, &tty_fops);
3483 if (cdev_add(&tty_cdev, MKDEV(TTYAUX_MAJOR, 0), 1) ||
3484 register_chrdev_region(MKDEV(TTYAUX_MAJOR, 0), 1, "/dev/tty") < 0)
3485 panic("Couldn't register /dev/tty driver\n");
Kay Sieversfbc92a32010-12-01 18:51:05 +01003486 device_create(tty_class, NULL, MKDEV(TTYAUX_MAJOR, 0), NULL, "tty");
Linus Torvalds1da177e2005-04-16 15:20:36 -07003487
3488 cdev_init(&console_cdev, &console_fops);
3489 if (cdev_add(&console_cdev, MKDEV(TTYAUX_MAJOR, 1), 1) ||
3490 register_chrdev_region(MKDEV(TTYAUX_MAJOR, 1), 1, "/dev/console") < 0)
3491 panic("Couldn't register /dev/console driver\n");
Kay Sieversfbc92a32010-12-01 18:51:05 +01003492 consdev = device_create(tty_class, NULL, MKDEV(TTYAUX_MAJOR, 1), NULL,
Greg Kroah-Hartman47aa5792008-05-21 12:52:33 -07003493 "console");
Kay Sieversfbc92a32010-12-01 18:51:05 +01003494 if (IS_ERR(consdev))
3495 consdev = NULL;
3496 else
Kay Sieversa2a6a822011-01-09 16:39:14 +01003497 WARN_ON(device_create_file(consdev, &dev_attr_active) < 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003498
Linus Torvalds1da177e2005-04-16 15:20:36 -07003499#ifdef CONFIG_VT
Alan Coxd81ed102008-10-13 10:41:42 +01003500 vty_init(&console_fops);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003501#endif
3502 return 0;
3503}
David Howells31d1d482010-08-06 16:34:43 +01003504