blob: b0452688308c6605bfc64168c790a442bef1407d [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 Cox89c8d912012-08-08 16:30:13 +0100189 tty->magic = 0xDEADDEAD;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700190 kfree(tty);
191}
192
Nick Piggind996b622010-08-18 04:37:36 +1000193static inline struct tty_struct *file_tty(struct file *file)
194{
195 return ((struct tty_file_private *)file->private_data)->tty;
196}
197
Jiri Slabyfa90e1c2011-10-12 11:32:43 +0200198int tty_alloc_file(struct file *file)
Nick Piggind996b622010-08-18 04:37:36 +1000199{
200 struct tty_file_private *priv;
201
Pekka Enbergf573bd12010-08-24 07:48:34 +0300202 priv = kmalloc(sizeof(*priv), GFP_KERNEL);
203 if (!priv)
204 return -ENOMEM;
Nick Piggind996b622010-08-18 04:37:36 +1000205
Jiri Slabyfa90e1c2011-10-12 11:32:43 +0200206 file->private_data = priv;
207
208 return 0;
209}
210
211/* Associate a new file with the tty structure */
212void tty_add_file(struct tty_struct *tty, struct file *file)
213{
214 struct tty_file_private *priv = file->private_data;
215
Nick Piggind996b622010-08-18 04:37:36 +1000216 priv->tty = tty;
217 priv->file = file;
Nick Piggind996b622010-08-18 04:37:36 +1000218
219 spin_lock(&tty_files_lock);
220 list_add(&priv->list, &tty->tty_files);
221 spin_unlock(&tty_files_lock);
Jiri Slabyfa90e1c2011-10-12 11:32:43 +0200222}
Pekka Enbergf573bd12010-08-24 07:48:34 +0300223
Jiri Slabyfa90e1c2011-10-12 11:32:43 +0200224/**
225 * tty_free_file - free file->private_data
226 *
227 * This shall be used only for fail path handling when tty_add_file was not
228 * called yet.
229 */
230void tty_free_file(struct file *file)
231{
232 struct tty_file_private *priv = file->private_data;
233
234 file->private_data = NULL;
235 kfree(priv);
Nick Piggind996b622010-08-18 04:37:36 +1000236}
237
238/* Delete file from its tty */
Josh Triplett2520e272012-11-18 21:27:47 -0800239static void tty_del_file(struct file *file)
Nick Piggind996b622010-08-18 04:37:36 +1000240{
241 struct tty_file_private *priv = file->private_data;
242
243 spin_lock(&tty_files_lock);
244 list_del(&priv->list);
245 spin_unlock(&tty_files_lock);
Jiri Slabyfa90e1c2011-10-12 11:32:43 +0200246 tty_free_file(file);
Nick Piggind996b622010-08-18 04:37:36 +1000247}
248
249
Linus Torvalds1da177e2005-04-16 15:20:36 -0700250#define TTY_NUMBER(tty) ((tty)->index + (tty)->driver->name_base)
251
Alan Coxaf9b8972006-08-27 01:24:01 -0700252/**
253 * tty_name - return tty naming
254 * @tty: tty structure
255 * @buf: buffer for output
256 *
257 * Convert a tty structure into a name. The name reflects the kernel
258 * naming policy and if udev is in use may not reflect user space
259 *
260 * Locking: none
261 */
262
Linus Torvalds1da177e2005-04-16 15:20:36 -0700263char *tty_name(struct tty_struct *tty, char *buf)
264{
265 if (!tty) /* Hmm. NULL pointer. That's fun. */
266 strcpy(buf, "NULL tty");
267 else
268 strcpy(buf, tty->name);
269 return buf;
270}
271
272EXPORT_SYMBOL(tty_name);
273
Andrew Mortond769a662005-05-05 16:15:50 -0700274int tty_paranoia_check(struct tty_struct *tty, struct inode *inode,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700275 const char *routine)
276{
277#ifdef TTY_PARANOIA_CHECK
278 if (!tty) {
279 printk(KERN_WARNING
280 "null TTY for (%d:%d) in %s\n",
281 imajor(inode), iminor(inode), routine);
282 return 1;
283 }
284 if (tty->magic != TTY_MAGIC) {
285 printk(KERN_WARNING
286 "bad magic number for tty struct (%d:%d) in %s\n",
287 imajor(inode), iminor(inode), routine);
288 return 1;
289 }
290#endif
291 return 0;
292}
293
294static int check_tty_count(struct tty_struct *tty, const char *routine)
295{
296#ifdef CHECK_TTY_COUNT
297 struct list_head *p;
298 int count = 0;
Alan Cox37bdfb02008-02-08 04:18:47 -0800299
Nick Pigginee2ffa02010-08-18 04:37:35 +1000300 spin_lock(&tty_files_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700301 list_for_each(p, &tty->tty_files) {
302 count++;
303 }
Nick Pigginee2ffa02010-08-18 04:37:35 +1000304 spin_unlock(&tty_files_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700305 if (tty->driver->type == TTY_DRIVER_TYPE_PTY &&
306 tty->driver->subtype == PTY_TYPE_SLAVE &&
307 tty->link && tty->link->count)
308 count++;
309 if (tty->count != count) {
310 printk(KERN_WARNING "Warning: dev (%s) tty->count(%d) "
311 "!= #fd's(%d) in %s\n",
312 tty->name, tty->count, count, routine);
313 return count;
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800314 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700315#endif
316 return 0;
317}
318
Alan Coxaf9b8972006-08-27 01:24:01 -0700319/**
Alan Coxaf9b8972006-08-27 01:24:01 -0700320 * get_tty_driver - find device of a tty
321 * @dev_t: device identifier
322 * @index: returns the index of the tty
323 *
324 * This routine returns a tty driver structure, given a device number
325 * and also passes back the index number.
326 *
327 * Locking: caller must hold tty_mutex
Linus Torvalds1da177e2005-04-16 15:20:36 -0700328 */
Alan Coxaf9b8972006-08-27 01:24:01 -0700329
Linus Torvalds1da177e2005-04-16 15:20:36 -0700330static struct tty_driver *get_tty_driver(dev_t device, int *index)
331{
332 struct tty_driver *p;
333
334 list_for_each_entry(p, &tty_drivers, tty_drivers) {
335 dev_t base = MKDEV(p->major, p->minor_start);
336 if (device < base || device >= base + p->num)
337 continue;
338 *index = device - base;
Alan Cox7d7b93c2008-10-13 10:42:09 +0100339 return tty_driver_kref_get(p);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700340 }
341 return NULL;
342}
343
Jason Wesself2d937f2008-04-17 20:05:37 +0200344#ifdef CONFIG_CONSOLE_POLL
345
346/**
347 * tty_find_polling_driver - find device of a polled tty
348 * @name: name string to match
349 * @line: pointer to resulting tty line nr
350 *
351 * This routine returns a tty driver structure, given a name
352 * and the condition that the tty driver is capable of polled
353 * operation.
354 */
355struct tty_driver *tty_find_polling_driver(char *name, int *line)
356{
357 struct tty_driver *p, *res = NULL;
358 int tty_line = 0;
Jason Wessel0dca0fd2008-09-26 10:36:42 -0500359 int len;
Alan Cox5f0878a2009-06-11 12:46:41 +0100360 char *str, *stp;
Jason Wesself2d937f2008-04-17 20:05:37 +0200361
Jason Wessel0dca0fd2008-09-26 10:36:42 -0500362 for (str = name; *str; str++)
363 if ((*str >= '0' && *str <= '9') || *str == ',')
364 break;
365 if (!*str)
366 return NULL;
367
368 len = str - name;
369 tty_line = simple_strtoul(str, &str, 10);
370
Jason Wesself2d937f2008-04-17 20:05:37 +0200371 mutex_lock(&tty_mutex);
372 /* Search through the tty devices to look for a match */
373 list_for_each_entry(p, &tty_drivers, tty_drivers) {
Jason Wessel0dca0fd2008-09-26 10:36:42 -0500374 if (strncmp(name, p->name, len) != 0)
375 continue;
Alan Cox5f0878a2009-06-11 12:46:41 +0100376 stp = str;
377 if (*stp == ',')
378 stp++;
379 if (*stp == '\0')
380 stp = NULL;
Jason Wesself2d937f2008-04-17 20:05:37 +0200381
Nathael Pajani6eb68d62010-09-02 16:06:16 +0200382 if (tty_line >= 0 && tty_line < p->num && p->ops &&
Alan Cox5f0878a2009-06-11 12:46:41 +0100383 p->ops->poll_init && !p->ops->poll_init(p, tty_line, stp)) {
Alan Cox7d7b93c2008-10-13 10:42:09 +0100384 res = tty_driver_kref_get(p);
Jason Wesself2d937f2008-04-17 20:05:37 +0200385 *line = tty_line;
386 break;
387 }
388 }
389 mutex_unlock(&tty_mutex);
390
391 return res;
392}
393EXPORT_SYMBOL_GPL(tty_find_polling_driver);
394#endif
395
Alan Coxaf9b8972006-08-27 01:24:01 -0700396/**
397 * tty_check_change - check for POSIX terminal changes
398 * @tty: tty to check
399 *
400 * If we try to write to, or set the state of, a terminal and we're
401 * not in the foreground, send a SIGTTOU. If the signal is blocked or
402 * ignored, go ahead and perform the operation. (POSIX 7.2)
403 *
Alan Cox978e5952008-04-30 00:53:59 -0700404 * Locking: ctrl_lock
Linus Torvalds1da177e2005-04-16 15:20:36 -0700405 */
Alan Coxaf9b8972006-08-27 01:24:01 -0700406
Alan Cox37bdfb02008-02-08 04:18:47 -0800407int tty_check_change(struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700408{
Alan Cox47f86832008-04-30 00:53:30 -0700409 unsigned long flags;
410 int ret = 0;
411
Linus Torvalds1da177e2005-04-16 15:20:36 -0700412 if (current->signal->tty != tty)
413 return 0;
Alan Cox47f86832008-04-30 00:53:30 -0700414
415 spin_lock_irqsave(&tty->ctrl_lock, flags);
416
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800417 if (!tty->pgrp) {
418 printk(KERN_WARNING "tty_check_change: tty->pgrp == NULL!\n");
Andrew Morton9ffee4c2008-05-14 16:05:58 -0700419 goto out_unlock;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700420 }
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800421 if (task_pgrp(current) == tty->pgrp)
Andrew Morton9ffee4c2008-05-14 16:05:58 -0700422 goto out_unlock;
423 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700424 if (is_ignored(SIGTTOU))
Alan Cox47f86832008-04-30 00:53:30 -0700425 goto out;
426 if (is_current_pgrp_orphaned()) {
427 ret = -EIO;
428 goto out;
429 }
Oleg Nesterov040b6362007-06-01 00:46:53 -0700430 kill_pgrp(task_pgrp(current), SIGTTOU, 1);
431 set_thread_flag(TIF_SIGPENDING);
Alan Cox47f86832008-04-30 00:53:30 -0700432 ret = -ERESTARTSYS;
433out:
Andrew Morton9ffee4c2008-05-14 16:05:58 -0700434 return ret;
435out_unlock:
Alan Cox47f86832008-04-30 00:53:30 -0700436 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
437 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700438}
439
440EXPORT_SYMBOL(tty_check_change);
441
Alan Cox37bdfb02008-02-08 04:18:47 -0800442static ssize_t hung_up_tty_read(struct file *file, char __user *buf,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700443 size_t count, loff_t *ppos)
444{
445 return 0;
446}
447
Alan Cox37bdfb02008-02-08 04:18:47 -0800448static ssize_t hung_up_tty_write(struct file *file, const char __user *buf,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700449 size_t count, loff_t *ppos)
450{
451 return -EIO;
452}
453
454/* No kernel lock held - none needed ;) */
Alan Cox37bdfb02008-02-08 04:18:47 -0800455static unsigned int hung_up_tty_poll(struct file *filp, poll_table *wait)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700456{
457 return POLLIN | POLLOUT | POLLERR | POLLHUP | POLLRDNORM | POLLWRNORM;
458}
459
Alan Cox04f378b2008-04-30 00:53:29 -0700460static long hung_up_tty_ioctl(struct file *file, unsigned int cmd,
461 unsigned long arg)
Paul Fulghum38ad2ed2007-06-16 10:15:55 -0700462{
463 return cmd == TIOCSPGRP ? -ENOTTY : -EIO;
464}
465
Alan Cox37bdfb02008-02-08 04:18:47 -0800466static long hung_up_tty_compat_ioctl(struct file *file,
Paul Fulghum38ad2ed2007-06-16 10:15:55 -0700467 unsigned int cmd, unsigned long arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700468{
469 return cmd == TIOCSPGRP ? -ENOTTY : -EIO;
470}
471
Arjan van de Ven62322d22006-07-03 00:24:21 -0700472static const struct file_operations tty_fops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700473 .llseek = no_llseek,
474 .read = tty_read,
475 .write = tty_write,
476 .poll = tty_poll,
Alan Cox04f378b2008-04-30 00:53:29 -0700477 .unlocked_ioctl = tty_ioctl,
Paul Fulghume10cc1d2007-05-10 22:22:50 -0700478 .compat_ioctl = tty_compat_ioctl,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700479 .open = tty_open,
480 .release = tty_release,
481 .fasync = tty_fasync,
482};
483
Arjan van de Ven62322d22006-07-03 00:24:21 -0700484static const struct file_operations console_fops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700485 .llseek = no_llseek,
486 .read = tty_read,
487 .write = redirected_tty_write,
488 .poll = tty_poll,
Alan Cox04f378b2008-04-30 00:53:29 -0700489 .unlocked_ioctl = tty_ioctl,
Paul Fulghume10cc1d2007-05-10 22:22:50 -0700490 .compat_ioctl = tty_compat_ioctl,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700491 .open = tty_open,
492 .release = tty_release,
493 .fasync = tty_fasync,
494};
495
Arjan van de Ven62322d22006-07-03 00:24:21 -0700496static const struct file_operations hung_up_tty_fops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700497 .llseek = no_llseek,
498 .read = hung_up_tty_read,
499 .write = hung_up_tty_write,
500 .poll = hung_up_tty_poll,
Alan Cox04f378b2008-04-30 00:53:29 -0700501 .unlocked_ioctl = hung_up_tty_ioctl,
Paul Fulghum38ad2ed2007-06-16 10:15:55 -0700502 .compat_ioctl = hung_up_tty_compat_ioctl,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700503 .release = tty_release,
504};
505
506static DEFINE_SPINLOCK(redirect_lock);
507static struct file *redirect;
508
509/**
510 * tty_wakeup - request more data
511 * @tty: terminal
512 *
513 * Internal and external helper for wakeups of tty. This function
514 * informs the line discipline if present that the driver is ready
515 * to receive more output data.
516 */
Alan Cox37bdfb02008-02-08 04:18:47 -0800517
Linus Torvalds1da177e2005-04-16 15:20:36 -0700518void tty_wakeup(struct tty_struct *tty)
519{
520 struct tty_ldisc *ld;
Alan Cox37bdfb02008-02-08 04:18:47 -0800521
Linus Torvalds1da177e2005-04-16 15:20:36 -0700522 if (test_bit(TTY_DO_WRITE_WAKEUP, &tty->flags)) {
523 ld = tty_ldisc_ref(tty);
Alan Cox37bdfb02008-02-08 04:18:47 -0800524 if (ld) {
Alan Coxa352def2008-07-16 21:53:12 +0100525 if (ld->ops->write_wakeup)
526 ld->ops->write_wakeup(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700527 tty_ldisc_deref(ld);
528 }
529 }
Davide Libenzi4b194492009-03-31 15:24:24 -0700530 wake_up_interruptible_poll(&tty->write_wait, POLLOUT);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700531}
532
533EXPORT_SYMBOL_GPL(tty_wakeup);
534
535/**
Arnd Bergmann11dbf202010-06-18 14:58:07 +0200536 * __tty_hangup - actual handler for hangup events
David Howells65f27f32006-11-22 14:55:48 +0000537 * @work: tty device
Alan Coxaf9b8972006-08-27 01:24:01 -0700538 *
Kevin Cernekeeef4f5272012-12-26 20:43:41 -0800539 * This can be called by a "kworker" kernel thread. That is process
Alan Coxaf9b8972006-08-27 01:24:01 -0700540 * synchronous but doesn't hold any locks, so we need to make sure we
541 * have the appropriate locks for what we're doing.
542 *
543 * The hangup event clears any pending redirections onto the hung up
544 * device. It ensures future writes will error and it does the needed
545 * line discipline hangup and signal delivery. The tty object itself
546 * remains intact.
547 *
548 * Locking:
Arnd Bergmannec79d602010-06-01 22:53:01 +0200549 * BTM
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800550 * redirect lock for undoing redirection
551 * file list lock for manipulating list of ttys
552 * tty_ldisc_lock from called functions
553 * termios_mutex resetting termios data
554 * tasklist_lock to walk task list for hangup event
555 * ->siglock to protect ->signal/->sighand
Linus Torvalds1da177e2005-04-16 15:20:36 -0700556 */
Josh Triplett2520e272012-11-18 21:27:47 -0800557static void __tty_hangup(struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700558{
Alan Cox37bdfb02008-02-08 04:18:47 -0800559 struct file *cons_filp = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700560 struct file *filp, *f = NULL;
561 struct task_struct *p;
Nick Piggind996b622010-08-18 04:37:36 +1000562 struct tty_file_private *priv;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700563 int closecount = 0, n;
Alan Cox47f86832008-04-30 00:53:30 -0700564 unsigned long flags;
Alan Cox9c9f4de2008-10-13 10:37:26 +0100565 int refs = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700566
567 if (!tty)
568 return;
569
Linus Torvalds1da177e2005-04-16 15:20:36 -0700570
571 spin_lock(&redirect_lock);
Nick Piggind996b622010-08-18 04:37:36 +1000572 if (redirect && file_tty(redirect) == tty) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700573 f = redirect;
574 redirect = NULL;
575 }
576 spin_unlock(&redirect_lock);
Alan Cox37bdfb02008-02-08 04:18:47 -0800577
Alan Cox89c8d912012-08-08 16:30:13 +0100578 tty_lock(tty);
Arnd Bergmann11dbf202010-06-18 14:58:07 +0200579
Jiri Slabyacfa7472010-11-29 10:16:54 +0100580 /* some functions below drop BTM, so we need this bit */
581 set_bit(TTY_HUPPING, &tty->flags);
582
Arnd Bergmannec79d602010-06-01 22:53:01 +0200583 /* inuse_filps is protected by the single tty lock,
584 this really needs to change if we want to flush the
585 workqueue with the lock held */
Arnd Bergmann11dbf202010-06-18 14:58:07 +0200586 check_tty_count(tty, "tty_hangup");
Alan Cox36ba7822009-11-30 13:18:51 +0000587
Nick Pigginee2ffa02010-08-18 04:37:35 +1000588 spin_lock(&tty_files_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700589 /* This breaks for file handles being sent over AF_UNIX sockets ? */
Nick Piggind996b622010-08-18 04:37:36 +1000590 list_for_each_entry(priv, &tty->tty_files, list) {
591 filp = priv->file;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700592 if (filp->f_op->write == redirected_tty_write)
593 cons_filp = filp;
594 if (filp->f_op->write != tty_write)
595 continue;
596 closecount++;
Arnd Bergmannec79d602010-06-01 22:53:01 +0200597 __tty_fasync(-1, filp, 0); /* can't block */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700598 filp->f_op = &hung_up_tty_fops;
599 }
Nick Pigginee2ffa02010-08-18 04:37:35 +1000600 spin_unlock(&tty_files_lock);
Alan Cox37bdfb02008-02-08 04:18:47 -0800601
Jiri Slabyacfa7472010-11-29 10:16:54 +0100602 /*
603 * it drops BTM and thus races with reopen
604 * we protect the race by TTY_HUPPING
605 */
Alan Coxc65c9bc2009-06-11 12:50:12 +0100606 tty_ldisc_hangup(tty);
Alan Cox37bdfb02008-02-08 04:18:47 -0800607
Linus Torvalds1da177e2005-04-16 15:20:36 -0700608 read_lock(&tasklist_lock);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800609 if (tty->session) {
610 do_each_pid_task(tty->session, PIDTYPE_SID, p) {
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800611 spin_lock_irq(&p->sighand->siglock);
Alan Cox9c9f4de2008-10-13 10:37:26 +0100612 if (p->signal->tty == tty) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700613 p->signal->tty = NULL;
Alan Cox9c9f4de2008-10-13 10:37:26 +0100614 /* We defer the dereferences outside fo
615 the tasklist lock */
616 refs++;
617 }
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800618 if (!p->signal->leader) {
619 spin_unlock_irq(&p->sighand->siglock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700620 continue;
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800621 }
622 __group_send_sig_info(SIGHUP, SEND_SIG_PRIV, p);
623 __group_send_sig_info(SIGCONT, SEND_SIG_PRIV, p);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800624 put_pid(p->signal->tty_old_pgrp); /* A noop */
Alan Cox47f86832008-04-30 00:53:30 -0700625 spin_lock_irqsave(&tty->ctrl_lock, flags);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800626 if (tty->pgrp)
627 p->signal->tty_old_pgrp = get_pid(tty->pgrp);
Alan Cox47f86832008-04-30 00:53:30 -0700628 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800629 spin_unlock_irq(&p->sighand->siglock);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800630 } while_each_pid_task(tty->session, PIDTYPE_SID, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700631 }
632 read_unlock(&tasklist_lock);
633
Alan Cox47f86832008-04-30 00:53:30 -0700634 spin_lock_irqsave(&tty->ctrl_lock, flags);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100635 clear_bit(TTY_THROTTLED, &tty->flags);
636 clear_bit(TTY_PUSH, &tty->flags);
637 clear_bit(TTY_DO_WRITE_WAKEUP, &tty->flags);
Eric W. Biedermand9c1e9a2007-03-18 12:45:44 -0600638 put_pid(tty->session);
639 put_pid(tty->pgrp);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800640 tty->session = NULL;
641 tty->pgrp = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700642 tty->ctrl_status = 0;
Alan Cox47f86832008-04-30 00:53:30 -0700643 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
644
Alan Cox9c9f4de2008-10-13 10:37:26 +0100645 /* Account for the p->signal references we killed */
646 while (refs--)
647 tty_kref_put(tty);
648
Linus Torvalds1da177e2005-04-16 15:20:36 -0700649 /*
Alan Cox37bdfb02008-02-08 04:18:47 -0800650 * If one of the devices matches a console pointer, we
651 * cannot just call hangup() because that will cause
652 * tty->count and state->count to go out of sync.
653 * So we just call close() the right number of times.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700654 */
655 if (cons_filp) {
Alan Coxf34d7a52008-04-30 00:54:13 -0700656 if (tty->ops->close)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700657 for (n = 0; n < closecount; n++)
Alan Coxf34d7a52008-04-30 00:54:13 -0700658 tty->ops->close(tty, cons_filp);
659 } else if (tty->ops->hangup)
660 (tty->ops->hangup)(tty);
Alan Cox37bdfb02008-02-08 04:18:47 -0800661 /*
662 * We don't want to have driver/ldisc interactions beyond
663 * the ones we did here. The driver layer expects no
664 * calls after ->hangup() from the ldisc side. However we
665 * can't yet guarantee all that.
666 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700667 set_bit(TTY_HUPPED, &tty->flags);
Jiri Slabyacfa7472010-11-29 10:16:54 +0100668 clear_bit(TTY_HUPPING, &tty->flags);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100669 tty_ldisc_enable(tty);
Arnd Bergmann11dbf202010-06-18 14:58:07 +0200670
Alan Cox89c8d912012-08-08 16:30:13 +0100671 tty_unlock(tty);
Arnd Bergmann11dbf202010-06-18 14:58:07 +0200672
Linus Torvalds1da177e2005-04-16 15:20:36 -0700673 if (f)
674 fput(f);
675}
676
Arnd Bergmannddcd9fb2010-06-01 22:53:08 +0200677static void do_tty_hangup(struct work_struct *work)
678{
679 struct tty_struct *tty =
680 container_of(work, struct tty_struct, hangup_work);
681
Arnd Bergmann11dbf202010-06-18 14:58:07 +0200682 __tty_hangup(tty);
Arnd Bergmannddcd9fb2010-06-01 22:53:08 +0200683}
684
Alan Coxaf9b8972006-08-27 01:24:01 -0700685/**
686 * tty_hangup - trigger a hangup event
687 * @tty: tty to hangup
688 *
689 * A carrier loss (virtual or otherwise) has occurred on this like
690 * schedule a hangup sequence to run after this event.
691 */
692
Alan Cox37bdfb02008-02-08 04:18:47 -0800693void tty_hangup(struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700694{
695#ifdef TTY_DEBUG_HANGUP
696 char buf[64];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700697 printk(KERN_DEBUG "%s hangup...\n", tty_name(tty, buf));
698#endif
699 schedule_work(&tty->hangup_work);
700}
701
702EXPORT_SYMBOL(tty_hangup);
703
Alan Coxaf9b8972006-08-27 01:24:01 -0700704/**
705 * tty_vhangup - process vhangup
706 * @tty: tty to hangup
707 *
708 * The user has asked via system call for the terminal to be hung up.
709 * We do this synchronously so that when the syscall returns the process
Robert P. J. Day3a4fa0a2007-10-19 23:10:43 +0200710 * is complete. That guarantee is necessary for security reasons.
Alan Coxaf9b8972006-08-27 01:24:01 -0700711 */
712
Alan Cox37bdfb02008-02-08 04:18:47 -0800713void tty_vhangup(struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700714{
715#ifdef TTY_DEBUG_HANGUP
716 char buf[64];
717
718 printk(KERN_DEBUG "%s vhangup...\n", tty_name(tty, buf));
719#endif
Arnd Bergmann11dbf202010-06-18 14:58:07 +0200720 __tty_hangup(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700721}
Alan Cox37bdfb02008-02-08 04:18:47 -0800722
Linus Torvalds1da177e2005-04-16 15:20:36 -0700723EXPORT_SYMBOL(tty_vhangup);
724
Arnd Bergmann11dbf202010-06-18 14:58:07 +0200725
Alan Coxaf9b8972006-08-27 01:24:01 -0700726/**
Alan Cox2cb59982008-10-13 10:40:30 +0100727 * tty_vhangup_self - process vhangup for own ctty
728 *
729 * Perform a vhangup on the current controlling tty
730 */
731
732void tty_vhangup_self(void)
733{
734 struct tty_struct *tty;
735
Alan Cox2cb59982008-10-13 10:40:30 +0100736 tty = get_current_tty();
737 if (tty) {
738 tty_vhangup(tty);
739 tty_kref_put(tty);
740 }
Alan Cox2cb59982008-10-13 10:40:30 +0100741}
742
743/**
Alan Coxaf9b8972006-08-27 01:24:01 -0700744 * tty_hung_up_p - was tty hung up
745 * @filp: file pointer of tty
746 *
747 * Return true if the tty has been subject to a vhangup or a carrier
748 * loss
749 */
750
Alan Cox37bdfb02008-02-08 04:18:47 -0800751int tty_hung_up_p(struct file *filp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700752{
753 return (filp->f_op == &hung_up_tty_fops);
754}
755
756EXPORT_SYMBOL(tty_hung_up_p);
757
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800758static void session_clear_tty(struct pid *session)
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800759{
760 struct task_struct *p;
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800761 do_each_pid_task(session, PIDTYPE_SID, p) {
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800762 proc_clear_tty(p);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800763 } while_each_pid_task(session, PIDTYPE_SID, p);
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800764}
765
Alan Coxaf9b8972006-08-27 01:24:01 -0700766/**
767 * disassociate_ctty - disconnect controlling tty
768 * @on_exit: true if exiting so need to "hang up" the session
Linus Torvalds1da177e2005-04-16 15:20:36 -0700769 *
Alan Coxaf9b8972006-08-27 01:24:01 -0700770 * This function is typically called only by the session leader, when
771 * it wants to disassociate itself from its controlling tty.
772 *
773 * It performs the following functions:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700774 * (1) Sends a SIGHUP and SIGCONT to the foreground process group
775 * (2) Clears the tty from being controlling the session
776 * (3) Clears the controlling tty for all processes in the
777 * session group.
778 *
Alan Coxaf9b8972006-08-27 01:24:01 -0700779 * The argument on_exit is set to 1 if called when a process is
780 * exiting; it is 0 if called by the ioctl TIOCNOTTY.
781 *
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800782 * Locking:
Arnd Bergmannec79d602010-06-01 22:53:01 +0200783 * BTM is taken for hysterical raisins, and held when
784 * called from no_tty().
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800785 * tty_mutex is taken to protect tty
786 * ->siglock is taken to protect ->signal/->sighand
787 * tasklist_lock is taken to walk process list for sessions
788 * ->siglock is taken to protect ->signal/->sighand
Linus Torvalds1da177e2005-04-16 15:20:36 -0700789 */
Alan Coxaf9b8972006-08-27 01:24:01 -0700790
Linus Torvalds1da177e2005-04-16 15:20:36 -0700791void disassociate_ctty(int on_exit)
792{
793 struct tty_struct *tty;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700794
Alan Cox5ec93d12009-11-30 13:18:45 +0000795 if (!current->signal->leader)
796 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700797
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800798 tty = get_current_tty();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700799 if (tty) {
Jiri Slaby1411dc42011-11-09 21:33:18 +0100800 struct pid *tty_pgrp = get_pid(tty->pgrp);
Arnd Bergmannddcd9fb2010-06-01 22:53:08 +0200801 if (on_exit) {
Arnd Bergmannddcd9fb2010-06-01 22:53:08 +0200802 if (tty->driver->type != TTY_DRIVER_TYPE_PTY)
Arnd Bergmann11dbf202010-06-18 14:58:07 +0200803 tty_vhangup(tty);
Arnd Bergmannddcd9fb2010-06-01 22:53:08 +0200804 }
Alan Cox452a00d2008-10-13 10:39:13 +0100805 tty_kref_put(tty);
Jiri Slaby1411dc42011-11-09 21:33:18 +0100806 if (tty_pgrp) {
807 kill_pgrp(tty_pgrp, SIGHUP, on_exit);
808 if (!on_exit)
809 kill_pgrp(tty_pgrp, SIGCONT, on_exit);
810 put_pid(tty_pgrp);
811 }
Eric W. Biederman680a9672007-02-12 00:52:52 -0800812 } else if (on_exit) {
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800813 struct pid *old_pgrp;
Eric W. Biederman680a9672007-02-12 00:52:52 -0800814 spin_lock_irq(&current->sighand->siglock);
815 old_pgrp = current->signal->tty_old_pgrp;
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800816 current->signal->tty_old_pgrp = NULL;
Eric W. Biederman680a9672007-02-12 00:52:52 -0800817 spin_unlock_irq(&current->sighand->siglock);
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800818 if (old_pgrp) {
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800819 kill_pgrp(old_pgrp, SIGHUP, on_exit);
820 kill_pgrp(old_pgrp, SIGCONT, on_exit);
821 put_pid(old_pgrp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700822 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700823 return;
824 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700825
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800826 spin_lock_irq(&current->sighand->siglock);
Eric W. Biederman2a65f1d2007-05-08 00:26:53 -0700827 put_pid(current->signal->tty_old_pgrp);
Randy Dunlap23cac8d2007-02-20 13:58:05 -0800828 current->signal->tty_old_pgrp = NULL;
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800829 spin_unlock_irq(&current->sighand->siglock);
830
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800831 tty = get_current_tty();
832 if (tty) {
Alan Cox47f86832008-04-30 00:53:30 -0700833 unsigned long flags;
834 spin_lock_irqsave(&tty->ctrl_lock, flags);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800835 put_pid(tty->session);
836 put_pid(tty->pgrp);
837 tty->session = NULL;
838 tty->pgrp = NULL;
Alan Cox47f86832008-04-30 00:53:30 -0700839 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
Alan Cox452a00d2008-10-13 10:39:13 +0100840 tty_kref_put(tty);
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800841 } else {
842#ifdef TTY_DEBUG_HANGUP
843 printk(KERN_DEBUG "error attempted to write to tty [0x%p]"
844 " = NULL", tty);
845#endif
846 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700847
848 /* Now clear signal->tty under the lock */
849 read_lock(&tasklist_lock);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800850 session_clear_tty(task_session(current));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700851 read_unlock(&tasklist_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700852}
853
Eric W. Biederman98a27ba2007-05-08 00:26:56 -0700854/**
855 *
856 * no_tty - Ensure the current process does not have a controlling tty
857 */
858void no_tty(void)
859{
Alan Cox3af502b2012-05-03 22:21:53 +0100860 /* FIXME: Review locking here. The tty_lock never covered any race
861 between a new association and proc_clear_tty but possible we need
862 to protect against this anyway */
Eric W. Biederman98a27ba2007-05-08 00:26:56 -0700863 struct task_struct *tsk = current;
Alan Cox5ec93d12009-11-30 13:18:45 +0000864 disassociate_ctty(0);
Eric W. Biederman98a27ba2007-05-08 00:26:56 -0700865 proc_clear_tty(tsk);
866}
867
Alan Coxaf9b8972006-08-27 01:24:01 -0700868
869/**
Robert P. J. Daybeb7dd82007-05-09 07:14:03 +0200870 * stop_tty - propagate flow control
Alan Coxaf9b8972006-08-27 01:24:01 -0700871 * @tty: tty to stop
872 *
873 * Perform flow control to the driver. For PTY/TTY pairs we
Robert P. J. Daybeb7dd82007-05-09 07:14:03 +0200874 * must also propagate the TIOCKPKT status. May be called
Alan Coxaf9b8972006-08-27 01:24:01 -0700875 * on an already stopped device and will not re-call the driver
876 * method.
877 *
878 * This functionality is used by both the line disciplines for
879 * halting incoming flow and by the driver. It may therefore be
880 * called from any context, may be under the tty atomic_write_lock
881 * but not always.
882 *
883 * Locking:
Alan Cox04f378b2008-04-30 00:53:29 -0700884 * Uses the tty control lock internally
Alan Coxaf9b8972006-08-27 01:24:01 -0700885 */
886
Linus Torvalds1da177e2005-04-16 15:20:36 -0700887void stop_tty(struct tty_struct *tty)
888{
Alan Cox04f378b2008-04-30 00:53:29 -0700889 unsigned long flags;
890 spin_lock_irqsave(&tty->ctrl_lock, flags);
891 if (tty->stopped) {
892 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700893 return;
Alan Cox04f378b2008-04-30 00:53:29 -0700894 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700895 tty->stopped = 1;
896 if (tty->link && tty->link->packet) {
897 tty->ctrl_status &= ~TIOCPKT_START;
898 tty->ctrl_status |= TIOCPKT_STOP;
Davide Libenzi4b194492009-03-31 15:24:24 -0700899 wake_up_interruptible_poll(&tty->link->read_wait, POLLIN);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700900 }
Alan Cox04f378b2008-04-30 00:53:29 -0700901 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
Alan Coxf34d7a52008-04-30 00:54:13 -0700902 if (tty->ops->stop)
903 (tty->ops->stop)(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700904}
905
906EXPORT_SYMBOL(stop_tty);
907
Alan Coxaf9b8972006-08-27 01:24:01 -0700908/**
Robert P. J. Daybeb7dd82007-05-09 07:14:03 +0200909 * start_tty - propagate flow control
Alan Coxaf9b8972006-08-27 01:24:01 -0700910 * @tty: tty to start
911 *
912 * Start a tty that has been stopped if at all possible. Perform
Robert P. J. Day3a4fa0a2007-10-19 23:10:43 +0200913 * any necessary wakeups and propagate the TIOCPKT status. If this
Alan Coxaf9b8972006-08-27 01:24:01 -0700914 * is the tty was previous stopped and is being started then the
915 * driver start method is invoked and the line discipline woken.
916 *
917 * Locking:
Alan Cox04f378b2008-04-30 00:53:29 -0700918 * ctrl_lock
Alan Coxaf9b8972006-08-27 01:24:01 -0700919 */
920
Linus Torvalds1da177e2005-04-16 15:20:36 -0700921void start_tty(struct tty_struct *tty)
922{
Alan Cox04f378b2008-04-30 00:53:29 -0700923 unsigned long flags;
924 spin_lock_irqsave(&tty->ctrl_lock, flags);
925 if (!tty->stopped || tty->flow_stopped) {
926 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700927 return;
Alan Cox04f378b2008-04-30 00:53:29 -0700928 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700929 tty->stopped = 0;
930 if (tty->link && tty->link->packet) {
931 tty->ctrl_status &= ~TIOCPKT_STOP;
932 tty->ctrl_status |= TIOCPKT_START;
Davide Libenzi4b194492009-03-31 15:24:24 -0700933 wake_up_interruptible_poll(&tty->link->read_wait, POLLIN);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700934 }
Alan Cox04f378b2008-04-30 00:53:29 -0700935 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
Alan Coxf34d7a52008-04-30 00:54:13 -0700936 if (tty->ops->start)
937 (tty->ops->start)(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700938 /* If we have a running line discipline it may need kicking */
939 tty_wakeup(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700940}
941
942EXPORT_SYMBOL(start_tty);
943
Jiri Slaby37b7f3c2013-04-26 13:48:53 +0200944static void tty_update_time(struct timespec *time)
945{
946 unsigned long sec = get_seconds();
947 sec -= sec % 60;
948 if ((long)(sec - time->tv_sec) > 0)
949 time->tv_sec = sec;
950}
951
Alan Coxaf9b8972006-08-27 01:24:01 -0700952/**
953 * tty_read - read method for tty device files
954 * @file: pointer to tty file
955 * @buf: user buffer
956 * @count: size of user buffer
957 * @ppos: unused
958 *
959 * Perform the read system call function on this terminal device. Checks
960 * for hung up devices before calling the line discipline method.
961 *
962 * Locking:
Alan Cox47f86832008-04-30 00:53:30 -0700963 * Locks the line discipline internally while needed. Multiple
964 * read calls may be outstanding in parallel.
Alan Coxaf9b8972006-08-27 01:24:01 -0700965 */
966
Alan Cox37bdfb02008-02-08 04:18:47 -0800967static ssize_t tty_read(struct file *file, char __user *buf, size_t count,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700968 loff_t *ppos)
969{
970 int i;
Jiri Slaby37b7f3c2013-04-26 13:48:53 +0200971 struct inode *inode = file_inode(file);
Nick Piggind996b622010-08-18 04:37:36 +1000972 struct tty_struct *tty = file_tty(file);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700973 struct tty_ldisc *ld;
974
Jiri Slaby37b7f3c2013-04-26 13:48:53 +0200975 if (tty_paranoia_check(tty, inode, "tty_read"))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700976 return -EIO;
977 if (!tty || (test_bit(TTY_IO_ERROR, &tty->flags)))
978 return -EIO;
979
980 /* We want to wait for the line discipline to sort out in this
981 situation */
982 ld = tty_ldisc_ref_wait(tty);
Alan Coxa352def2008-07-16 21:53:12 +0100983 if (ld->ops->read)
984 i = (ld->ops->read)(tty, file, buf, count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700985 else
986 i = -EIO;
987 tty_ldisc_deref(ld);
Jiri Slabyb0de59b2013-02-15 15:25:05 +0100988
Jiri Slaby37b7f3c2013-04-26 13:48:53 +0200989 if (i > 0)
990 tty_update_time(&inode->i_atime);
991
Linus Torvalds1da177e2005-04-16 15:20:36 -0700992 return i;
993}
994
Alan Cox9c1729d2007-07-15 23:39:43 -0700995void tty_write_unlock(struct tty_struct *tty)
Jiri Slaby83c67572011-04-20 10:43:18 +0200996 __releases(&tty->atomic_write_lock)
Alan Cox9c1729d2007-07-15 23:39:43 -0700997{
998 mutex_unlock(&tty->atomic_write_lock);
Davide Libenzi4b194492009-03-31 15:24:24 -0700999 wake_up_interruptible_poll(&tty->write_wait, POLLOUT);
Alan Cox9c1729d2007-07-15 23:39:43 -07001000}
1001
1002int tty_write_lock(struct tty_struct *tty, int ndelay)
Jiri Slaby83c67572011-04-20 10:43:18 +02001003 __acquires(&tty->atomic_write_lock)
Alan Cox9c1729d2007-07-15 23:39:43 -07001004{
1005 if (!mutex_trylock(&tty->atomic_write_lock)) {
1006 if (ndelay)
1007 return -EAGAIN;
1008 if (mutex_lock_interruptible(&tty->atomic_write_lock))
1009 return -ERESTARTSYS;
1010 }
1011 return 0;
1012}
1013
Linus Torvalds1da177e2005-04-16 15:20:36 -07001014/*
1015 * Split writes up in sane blocksizes to avoid
1016 * denial-of-service type attacks
1017 */
1018static inline ssize_t do_tty_write(
1019 ssize_t (*write)(struct tty_struct *, struct file *, const unsigned char *, size_t),
1020 struct tty_struct *tty,
1021 struct file *file,
1022 const char __user *buf,
1023 size_t count)
1024{
Alan Cox9c1729d2007-07-15 23:39:43 -07001025 ssize_t ret, written = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001026 unsigned int chunk;
Alan Cox37bdfb02008-02-08 04:18:47 -08001027
Alan Cox9c1729d2007-07-15 23:39:43 -07001028 ret = tty_write_lock(tty, file->f_flags & O_NDELAY);
1029 if (ret < 0)
1030 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001031
1032 /*
1033 * We chunk up writes into a temporary buffer. This
1034 * simplifies low-level drivers immensely, since they
1035 * don't have locking issues and user mode accesses.
1036 *
1037 * But if TTY_NO_WRITE_SPLIT is set, we should use a
1038 * big chunk-size..
1039 *
1040 * The default chunk-size is 2kB, because the NTTY
1041 * layer has problems with bigger chunks. It will
1042 * claim to be able to handle more characters than
1043 * it actually does.
Alan Coxaf9b8972006-08-27 01:24:01 -07001044 *
1045 * FIXME: This can probably go away now except that 64K chunks
1046 * are too likely to fail unless switched to vmalloc...
Linus Torvalds1da177e2005-04-16 15:20:36 -07001047 */
1048 chunk = 2048;
1049 if (test_bit(TTY_NO_WRITE_SPLIT, &tty->flags))
1050 chunk = 65536;
1051 if (count < chunk)
1052 chunk = count;
1053
Ingo Molnar70522e12006-03-23 03:00:31 -08001054 /* write_buf/write_cnt is protected by the atomic_write_lock mutex */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001055 if (tty->write_cnt < chunk) {
Jason Wessel402fda92008-10-13 10:45:36 +01001056 unsigned char *buf_chunk;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001057
1058 if (chunk < 1024)
1059 chunk = 1024;
1060
Jason Wessel402fda92008-10-13 10:45:36 +01001061 buf_chunk = kmalloc(chunk, GFP_KERNEL);
1062 if (!buf_chunk) {
Alan Cox9c1729d2007-07-15 23:39:43 -07001063 ret = -ENOMEM;
1064 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001065 }
1066 kfree(tty->write_buf);
1067 tty->write_cnt = chunk;
Jason Wessel402fda92008-10-13 10:45:36 +01001068 tty->write_buf = buf_chunk;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001069 }
1070
1071 /* Do the write .. */
1072 for (;;) {
1073 size_t size = count;
1074 if (size > chunk)
1075 size = chunk;
1076 ret = -EFAULT;
1077 if (copy_from_user(tty->write_buf, buf, size))
1078 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001079 ret = write(tty, file, tty->write_buf, size);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001080 if (ret <= 0)
1081 break;
1082 written += ret;
1083 buf += ret;
1084 count -= ret;
1085 if (!count)
1086 break;
1087 ret = -ERESTARTSYS;
1088 if (signal_pending(current))
1089 break;
1090 cond_resched();
1091 }
Jiri Slaby37b7f3c2013-04-26 13:48:53 +02001092 if (written) {
1093 tty_update_time(&file_inode(file)->i_mtime);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001094 ret = written;
Jiri Slaby37b7f3c2013-04-26 13:48:53 +02001095 }
Alan Cox9c1729d2007-07-15 23:39:43 -07001096out:
1097 tty_write_unlock(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001098 return ret;
1099}
1100
Alan Cox95f9bfc2008-10-13 10:39:23 +01001101/**
1102 * tty_write_message - write a message to a certain tty, not just the console.
1103 * @tty: the destination tty_struct
1104 * @msg: the message to write
1105 *
1106 * This is used for messages that need to be redirected to a specific tty.
1107 * We don't put it into the syslog queue right now maybe in the future if
1108 * really needed.
1109 *
Arnd Bergmannec79d602010-06-01 22:53:01 +02001110 * We must still hold the BTM and test the CLOSING flag for the moment.
Alan Cox95f9bfc2008-10-13 10:39:23 +01001111 */
1112
1113void tty_write_message(struct tty_struct *tty, char *msg)
1114{
Alan Cox95f9bfc2008-10-13 10:39:23 +01001115 if (tty) {
1116 mutex_lock(&tty->atomic_write_lock);
Alan Cox89c8d912012-08-08 16:30:13 +01001117 tty_lock(tty);
Alan Coxeeb89d92009-11-30 13:18:29 +00001118 if (tty->ops->write && !test_bit(TTY_CLOSING, &tty->flags)) {
Alan Cox89c8d912012-08-08 16:30:13 +01001119 tty_unlock(tty);
Alan Cox95f9bfc2008-10-13 10:39:23 +01001120 tty->ops->write(tty, msg, strlen(msg));
Alan Coxeeb89d92009-11-30 13:18:29 +00001121 } else
Alan Cox89c8d912012-08-08 16:30:13 +01001122 tty_unlock(tty);
Alan Cox95f9bfc2008-10-13 10:39:23 +01001123 tty_write_unlock(tty);
1124 }
Alan Cox95f9bfc2008-10-13 10:39:23 +01001125 return;
1126}
1127
Linus Torvalds1da177e2005-04-16 15:20:36 -07001128
Alan Coxaf9b8972006-08-27 01:24:01 -07001129/**
1130 * tty_write - write method for tty device file
1131 * @file: tty file pointer
1132 * @buf: user data to write
1133 * @count: bytes to write
1134 * @ppos: unused
1135 *
1136 * Write data to a tty device via the line discipline.
1137 *
1138 * Locking:
1139 * Locks the line discipline as required
1140 * Writes to the tty driver are serialized by the atomic_write_lock
1141 * and are then processed in chunks to the device. The line discipline
Joe Petersona88a69c2009-01-02 13:40:53 +00001142 * write method will not be invoked in parallel for each device.
Alan Coxaf9b8972006-08-27 01:24:01 -07001143 */
1144
Alan Cox37bdfb02008-02-08 04:18:47 -08001145static ssize_t tty_write(struct file *file, const char __user *buf,
1146 size_t count, loff_t *ppos)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001147{
Nick Piggind996b622010-08-18 04:37:36 +10001148 struct tty_struct *tty = file_tty(file);
1149 struct tty_ldisc *ld;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001150 ssize_t ret;
Alan Cox37bdfb02008-02-08 04:18:47 -08001151
Al Viro6131ffa2013-02-27 16:59:05 -05001152 if (tty_paranoia_check(tty, file_inode(file), "tty_write"))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001153 return -EIO;
Alan Coxf34d7a52008-04-30 00:54:13 -07001154 if (!tty || !tty->ops->write ||
Alan Cox37bdfb02008-02-08 04:18:47 -08001155 (test_bit(TTY_IO_ERROR, &tty->flags)))
1156 return -EIO;
Alan Coxf34d7a52008-04-30 00:54:13 -07001157 /* Short term debug to catch buggy drivers */
1158 if (tty->ops->write_room == NULL)
1159 printk(KERN_ERR "tty driver %s lacks a write_room method.\n",
1160 tty->driver->name);
Alan Cox37bdfb02008-02-08 04:18:47 -08001161 ld = tty_ldisc_ref_wait(tty);
Alan Coxa352def2008-07-16 21:53:12 +01001162 if (!ld->ops->write)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001163 ret = -EIO;
1164 else
Alan Coxa352def2008-07-16 21:53:12 +01001165 ret = do_tty_write(ld->ops->write, tty, file, buf, count);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001166 tty_ldisc_deref(ld);
1167 return ret;
1168}
1169
Alan Cox37bdfb02008-02-08 04:18:47 -08001170ssize_t redirected_tty_write(struct file *file, const char __user *buf,
1171 size_t count, loff_t *ppos)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001172{
1173 struct file *p = NULL;
1174
1175 spin_lock(&redirect_lock);
Al Virocb0942b2012-08-27 14:48:26 -04001176 if (redirect)
1177 p = get_file(redirect);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001178 spin_unlock(&redirect_lock);
1179
1180 if (p) {
1181 ssize_t res;
1182 res = vfs_write(p, buf, count, &p->f_pos);
1183 fput(p);
1184 return res;
1185 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001186 return tty_write(file, buf, count, ppos);
1187}
1188
1189static char ptychar[] = "pqrstuvwxyzabcde";
1190
Alan Coxaf9b8972006-08-27 01:24:01 -07001191/**
1192 * pty_line_name - generate name for a pty
1193 * @driver: the tty driver in use
1194 * @index: the minor number
1195 * @p: output buffer of at least 6 bytes
1196 *
1197 * Generate a name from a driver reference and write it to the output
1198 * buffer.
1199 *
1200 * Locking: None
1201 */
1202static void pty_line_name(struct tty_driver *driver, int index, char *p)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001203{
1204 int i = index + driver->name_base;
1205 /* ->name is initialized to "ttyp", but "tty" is expected */
1206 sprintf(p, "%s%c%x",
Alan Cox37bdfb02008-02-08 04:18:47 -08001207 driver->subtype == PTY_TYPE_SLAVE ? "tty" : driver->name,
1208 ptychar[i >> 4 & 0xf], i & 0xf);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001209}
1210
Alan Coxaf9b8972006-08-27 01:24:01 -07001211/**
Alan Cox8b0a88d2008-10-13 10:42:19 +01001212 * tty_line_name - generate name for a tty
Alan Coxaf9b8972006-08-27 01:24:01 -07001213 * @driver: the tty driver in use
1214 * @index: the minor number
1215 * @p: output buffer of at least 7 bytes
1216 *
1217 * Generate a name from a driver reference and write it to the output
1218 * buffer.
1219 *
1220 * Locking: None
1221 */
1222static void tty_line_name(struct tty_driver *driver, int index, char *p)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001223{
Jiri Slaby0019b402012-08-08 22:26:43 +02001224 if (driver->flags & TTY_DRIVER_UNNUMBERED_NODE)
1225 strcpy(p, driver->name);
1226 else
1227 sprintf(p, "%s%d", driver->name, index + driver->name_base);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001228}
1229
Alan Cox99f1fe12008-10-13 10:42:00 +01001230/**
1231 * tty_driver_lookup_tty() - find an existing tty, if any
1232 * @driver: the driver for the tty
1233 * @idx: the minor number
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001234 *
Alan Cox99f1fe12008-10-13 10:42:00 +01001235 * Return the tty, if found or ERR_PTR() otherwise.
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001236 *
Alan Cox99f1fe12008-10-13 10:42:00 +01001237 * Locking: tty_mutex must be held. If tty is found, the mutex must
1238 * be held until the 'fast-open' is also done. Will change once we
1239 * have refcounting in the driver and per driver locking
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001240 */
Jason Wessela47d5452009-01-02 13:43:04 +00001241static struct tty_struct *tty_driver_lookup_tty(struct tty_driver *driver,
Sukadev Bhattiprolu15f1a632008-10-13 10:42:59 +01001242 struct inode *inode, int idx)
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001243{
Alan Cox99f1fe12008-10-13 10:42:00 +01001244 if (driver->ops->lookup)
Sukadev Bhattiprolu15f1a632008-10-13 10:42:59 +01001245 return driver->ops->lookup(driver, inode, idx);
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001246
Jiri Slabyd4834262012-03-05 14:51:53 +01001247 return driver->ttys[idx];
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001248}
1249
Alan Cox99f1fe12008-10-13 10:42:00 +01001250/**
Alan Coxbf970ee2008-10-13 10:42:39 +01001251 * tty_init_termios - helper for termios setup
1252 * @tty: the tty to set up
1253 *
1254 * Initialise the termios structures for this tty. Thus runs under
1255 * the tty_mutex currently so we can be relaxed about ordering.
1256 */
1257
1258int tty_init_termios(struct tty_struct *tty)
1259{
Alan Coxfe6e29f2008-10-13 10:44:08 +01001260 struct ktermios *tp;
Alan Coxbf970ee2008-10-13 10:42:39 +01001261 int idx = tty->index;
1262
Alan Cox36b3c072012-07-17 17:06:57 +01001263 if (tty->driver->flags & TTY_DRIVER_RESET_TERMIOS)
1264 tty->termios = tty->driver->init_termios;
1265 else {
1266 /* Check for lazy saved data */
1267 tp = tty->driver->termios[idx];
1268 if (tp != NULL)
1269 tty->termios = *tp;
1270 else
1271 tty->termios = tty->driver->init_termios;
Alan Coxbf970ee2008-10-13 10:42:39 +01001272 }
Alan Coxbf970ee2008-10-13 10:42:39 +01001273 /* Compatibility until drivers always set this */
Alan Coxadc8d742012-07-14 15:31:47 +01001274 tty->termios.c_ispeed = tty_termios_input_baud_rate(&tty->termios);
1275 tty->termios.c_ospeed = tty_termios_baud_rate(&tty->termios);
Alan Coxbf970ee2008-10-13 10:42:39 +01001276 return 0;
1277}
Alan Coxfe1ae7f2009-09-19 13:13:33 -07001278EXPORT_SYMBOL_GPL(tty_init_termios);
Alan Coxbf970ee2008-10-13 10:42:39 +01001279
Jiri Slaby66d450e2012-01-30 21:14:28 +01001280int tty_standard_install(struct tty_driver *driver, struct tty_struct *tty)
1281{
1282 int ret = tty_init_termios(tty);
1283 if (ret)
1284 return ret;
1285
1286 tty_driver_kref_get(driver);
1287 tty->count++;
1288 driver->ttys[tty->index] = tty;
1289 return 0;
1290}
1291EXPORT_SYMBOL_GPL(tty_standard_install);
1292
Alan Coxbf970ee2008-10-13 10:42:39 +01001293/**
Alan Cox8b0a88d2008-10-13 10:42:19 +01001294 * tty_driver_install_tty() - install a tty entry in the driver
1295 * @driver: the driver for the tty
1296 * @tty: the tty
1297 *
1298 * Install a tty object into the driver tables. The tty->index field
Alan Coxbf970ee2008-10-13 10:42:39 +01001299 * will be set by the time this is called. This method is responsible
1300 * for ensuring any need additional structures are allocated and
1301 * configured.
Alan Cox8b0a88d2008-10-13 10:42:19 +01001302 *
1303 * Locking: tty_mutex for now
1304 */
1305static int tty_driver_install_tty(struct tty_driver *driver,
1306 struct tty_struct *tty)
1307{
Jiri Slaby66d450e2012-01-30 21:14:28 +01001308 return driver->ops->install ? driver->ops->install(driver, tty) :
1309 tty_standard_install(driver, tty);
Alan Cox8b0a88d2008-10-13 10:42:19 +01001310}
1311
1312/**
1313 * tty_driver_remove_tty() - remove a tty from the driver tables
1314 * @driver: the driver for the tty
1315 * @idx: the minor number
1316 *
1317 * Remvoe a tty object from the driver tables. The tty->index field
1318 * will be set by the time this is called.
1319 *
1320 * Locking: tty_mutex for now
1321 */
Jiri Slaby24d406a2011-08-10 14:59:28 +02001322void tty_driver_remove_tty(struct tty_driver *driver, struct tty_struct *tty)
Alan Cox8b0a88d2008-10-13 10:42:19 +01001323{
1324 if (driver->ops->remove)
1325 driver->ops->remove(driver, tty);
1326 else
1327 driver->ttys[tty->index] = NULL;
1328}
1329
1330/*
1331 * tty_reopen() - fast re-open of an open tty
1332 * @tty - the tty to open
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001333 *
Alan Cox99f1fe12008-10-13 10:42:00 +01001334 * Return 0 on success, -errno on error.
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001335 *
Alan Cox99f1fe12008-10-13 10:42:00 +01001336 * Locking: tty_mutex must be held from the time the tty was found
1337 * till this open completes.
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001338 */
Alan Cox99f1fe12008-10-13 10:42:00 +01001339static int tty_reopen(struct tty_struct *tty)
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001340{
1341 struct tty_driver *driver = tty->driver;
1342
Jiri Slabye2efafb2010-11-29 10:16:53 +01001343 if (test_bit(TTY_CLOSING, &tty->flags) ||
Jiri Slabyacfa7472010-11-29 10:16:54 +01001344 test_bit(TTY_HUPPING, &tty->flags) ||
Jiri Slabye2efafb2010-11-29 10:16:53 +01001345 test_bit(TTY_LDISC_CHANGING, &tty->flags))
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001346 return -EIO;
1347
1348 if (driver->type == TTY_DRIVER_TYPE_PTY &&
1349 driver->subtype == PTY_TYPE_MASTER) {
1350 /*
1351 * special case for PTY masters: only one open permitted,
1352 * and the slave side open count is incremented as well.
1353 */
1354 if (tty->count)
1355 return -EIO;
1356
1357 tty->link->count++;
1358 }
1359 tty->count++;
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001360
Alan Cox1aa4bed2009-06-16 17:01:33 +01001361 mutex_lock(&tty->ldisc_mutex);
Alan Cox99f1fe12008-10-13 10:42:00 +01001362 WARN_ON(!test_bit(TTY_LDISC, &tty->flags));
Alan Cox1aa4bed2009-06-16 17:01:33 +01001363 mutex_unlock(&tty->ldisc_mutex);
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001364
1365 return 0;
1366}
1367
Alan Coxaf9b8972006-08-27 01:24:01 -07001368/**
Alan Coxd81ed102008-10-13 10:41:42 +01001369 * tty_init_dev - initialise a tty device
Alan Coxaf9b8972006-08-27 01:24:01 -07001370 * @driver: tty driver we are opening a device on
1371 * @idx: device index
Alan Cox15582d32008-10-13 10:41:03 +01001372 * @ret_tty: returned tty structure
Alan Coxaf9b8972006-08-27 01:24:01 -07001373 *
1374 * Prepare a tty device. This may not be a "new" clean device but
1375 * could also be an active device. The pty drivers require special
1376 * handling because of this.
1377 *
1378 * Locking:
1379 * The function is called under the tty_mutex, which
1380 * protects us from the tty struct or driver itself going away.
1381 *
1382 * On exit the tty device has the line discipline attached and
1383 * a reference count of 1. If a pair was created for pty/tty use
1384 * and the other was a pty master then it too has a reference count of 1.
1385 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07001386 * WSH 06/09/97: Rewritten to remove races and properly clean up after a
Ingo Molnar70522e12006-03-23 03:00:31 -08001387 * failed open. The new code protects the open with a mutex, so it's
1388 * really quite straightforward. The mutex locking can probably be
Linus Torvalds1da177e2005-04-16 15:20:36 -07001389 * relaxed for the (most common) case of reopening a tty.
1390 */
Alan Coxaf9b8972006-08-27 01:24:01 -07001391
Konstantin Khlebnikov593a27c2012-01-05 13:04:21 +04001392struct tty_struct *tty_init_dev(struct tty_driver *driver, int idx)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001393{
Alan Coxbf970ee2008-10-13 10:42:39 +01001394 struct tty_struct *tty;
Alan Cox73ec06f2008-10-13 10:42:29 +01001395 int retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001396
Linus Torvalds1da177e2005-04-16 15:20:36 -07001397 /*
1398 * First time open is complex, especially for PTY devices.
1399 * This code guarantees that either everything succeeds and the
1400 * TTY is ready for operation, or else the table slots are vacated
Alan Cox37bdfb02008-02-08 04:18:47 -08001401 * and the allocated memory released. (Except that the termios
Linus Torvalds1da177e2005-04-16 15:20:36 -07001402 * and locked termios may be retained.)
1403 */
1404
Alan Cox73ec06f2008-10-13 10:42:29 +01001405 if (!try_module_get(driver->owner))
1406 return ERR_PTR(-ENODEV);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001407
Linus Torvalds1da177e2005-04-16 15:20:36 -07001408 tty = alloc_tty_struct();
Jiri Slabyd5543502011-03-23 10:48:32 +01001409 if (!tty) {
1410 retval = -ENOMEM;
1411 goto err_module_put;
1412 }
Alan Coxbf970ee2008-10-13 10:42:39 +01001413 initialize_tty_struct(tty, driver, idx);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001414
Alan Cox89c8d912012-08-08 16:30:13 +01001415 tty_lock(tty);
Alan Cox73ec06f2008-10-13 10:42:29 +01001416 retval = tty_driver_install_tty(driver, tty);
Jiri Slabyd5543502011-03-23 10:48:32 +01001417 if (retval < 0)
Jiri Slabya9dccdd2011-03-23 10:48:36 +01001418 goto err_deinit_tty;
Alan Cox8b0a88d2008-10-13 10:42:19 +01001419
Jiri Slaby04831dc2012-06-04 13:35:36 +02001420 if (!tty->port)
1421 tty->port = driver->ports[idx];
1422
Jiri Slaby5d4121c2012-08-17 14:27:52 +02001423 WARN_RATELIMIT(!tty->port,
1424 "%s: %s driver does not set tty->port. This will crash the kernel later. Fix the driver!\n",
1425 __func__, tty->driver->name);
1426
Jiri Slaby967fab62012-10-18 22:26:46 +02001427 tty->port->itty = tty;
1428
Alan Cox37bdfb02008-02-08 04:18:47 -08001429 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001430 * Structures all installed ... call the ldisc open routines.
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001431 * If we fail here just call release_tty to clean up. No need
1432 * to decrement the use counts, as release_tty doesn't care.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001433 */
Alan Coxbf970ee2008-10-13 10:42:39 +01001434 retval = tty_ldisc_setup(tty, tty->link);
Alan Cox01e1abb2008-07-22 11:16:55 +01001435 if (retval)
Jiri Slabyd5543502011-03-23 10:48:32 +01001436 goto err_release_tty;
Alan Cox89c8d912012-08-08 16:30:13 +01001437 /* Return the tty locked so that it cannot vanish under the caller */
Alan Cox73ec06f2008-10-13 10:42:29 +01001438 return tty;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001439
Jiri Slabya9dccdd2011-03-23 10:48:36 +01001440err_deinit_tty:
Alan Cox89c8d912012-08-08 16:30:13 +01001441 tty_unlock(tty);
Jiri Slabya9dccdd2011-03-23 10:48:36 +01001442 deinitialize_tty_struct(tty);
Jiri Slabyd5543502011-03-23 10:48:32 +01001443 free_tty_struct(tty);
1444err_module_put:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001445 module_put(driver->owner);
Jiri Slabyd5543502011-03-23 10:48:32 +01001446 return ERR_PTR(retval);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001447
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001448 /* call the tty release_tty routine to clean out this slot */
Jiri Slabyd5543502011-03-23 10:48:32 +01001449err_release_tty:
Alan Cox89c8d912012-08-08 16:30:13 +01001450 tty_unlock(tty);
Manuel Zerpies5a3c6b22011-06-16 14:07:22 +02001451 printk_ratelimited(KERN_INFO "tty_init_dev: ldisc open failed, "
Akinobu Mita40509142006-09-29 02:01:27 -07001452 "clearing slot %d\n", idx);
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001453 release_tty(tty, idx);
Alan Cox73ec06f2008-10-13 10:42:29 +01001454 return ERR_PTR(retval);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001455}
1456
Alan Coxfeebed62008-10-13 10:41:30 +01001457void tty_free_termios(struct tty_struct *tty)
1458{
1459 struct ktermios *tp;
1460 int idx = tty->index;
Alan Cox36b3c072012-07-17 17:06:57 +01001461
1462 /* If the port is going to reset then it has no termios to save */
1463 if (tty->driver->flags & TTY_DRIVER_RESET_TERMIOS)
1464 return;
1465
1466 /* Stash the termios data */
1467 tp = tty->driver->termios[idx];
1468 if (tp == NULL) {
1469 tp = kmalloc(sizeof(struct ktermios), GFP_KERNEL);
1470 if (tp == NULL) {
1471 pr_warn("tty: no memory to save termios state.\n");
1472 return;
1473 }
Dan Carpenter4ac5d702012-07-24 12:51:52 +01001474 tty->driver->termios[idx] = tp;
Alan Coxfeebed62008-10-13 10:41:30 +01001475 }
Alan Cox36b3c072012-07-17 17:06:57 +01001476 *tp = tty->termios;
Alan Coxfeebed62008-10-13 10:41:30 +01001477}
1478EXPORT_SYMBOL(tty_free_termios);
1479
Alan Coxfeebed62008-10-13 10:41:30 +01001480
Alan Coxaf9b8972006-08-27 01:24:01 -07001481/**
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001482 * release_one_tty - release tty structure memory
Alan Cox9c9f4de2008-10-13 10:37:26 +01001483 * @kref: kref of tty we are obliterating
Alan Coxaf9b8972006-08-27 01:24:01 -07001484 *
1485 * Releases memory associated with a tty structure, and clears out the
1486 * driver table slots. This function is called when a device is no longer
1487 * in use. It also gets called when setup of a device fails.
1488 *
1489 * Locking:
Alan Coxaf9b8972006-08-27 01:24:01 -07001490 * takes the file list lock internally when working on the list
1491 * of ttys that the driver keeps.
Alan Coxb50989d2009-09-19 13:13:22 -07001492 *
1493 * This method gets called from a work queue so that the driver private
Dave Youngf278a2f2009-09-27 16:00:42 +00001494 * cleanup ops can sleep (needed for USB at least)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001495 */
Alan Coxb50989d2009-09-19 13:13:22 -07001496static void release_one_tty(struct work_struct *work)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001497{
Alan Coxb50989d2009-09-19 13:13:22 -07001498 struct tty_struct *tty =
1499 container_of(work, struct tty_struct, hangup_work);
Alan Cox6f967f72008-10-13 10:37:36 +01001500 struct tty_driver *driver = tty->driver;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001501
Dave Youngf278a2f2009-09-27 16:00:42 +00001502 if (tty->ops->cleanup)
1503 tty->ops->cleanup(tty);
1504
Linus Torvalds1da177e2005-04-16 15:20:36 -07001505 tty->magic = 0;
Alan Cox7d7b93c2008-10-13 10:42:09 +01001506 tty_driver_kref_put(driver);
Alan Cox6f967f72008-10-13 10:37:36 +01001507 module_put(driver->owner);
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001508
Nick Pigginee2ffa02010-08-18 04:37:35 +10001509 spin_lock(&tty_files_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001510 list_del_init(&tty->tty_files);
Nick Pigginee2ffa02010-08-18 04:37:35 +10001511 spin_unlock(&tty_files_lock);
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001512
Oleg Nesterov6da8d862010-04-02 18:05:12 +02001513 put_pid(tty->pgrp);
1514 put_pid(tty->session);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001515 free_tty_struct(tty);
1516}
1517
Alan Coxb50989d2009-09-19 13:13:22 -07001518static void queue_release_one_tty(struct kref *kref)
1519{
1520 struct tty_struct *tty = container_of(kref, struct tty_struct, kref);
Dave Youngf278a2f2009-09-27 16:00:42 +00001521
Alan Coxb50989d2009-09-19 13:13:22 -07001522 /* The hangup queue is now free so we can reuse it rather than
1523 waste a chunk of memory for each port */
1524 INIT_WORK(&tty->hangup_work, release_one_tty);
1525 schedule_work(&tty->hangup_work);
1526}
1527
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001528/**
Alan Cox9c9f4de2008-10-13 10:37:26 +01001529 * tty_kref_put - release a tty kref
1530 * @tty: tty device
1531 *
1532 * Release a reference to a tty device and if need be let the kref
1533 * layer destruct the object for us
1534 */
1535
1536void tty_kref_put(struct tty_struct *tty)
1537{
1538 if (tty)
Alan Coxb50989d2009-09-19 13:13:22 -07001539 kref_put(&tty->kref, queue_release_one_tty);
Alan Cox9c9f4de2008-10-13 10:37:26 +01001540}
1541EXPORT_SYMBOL(tty_kref_put);
1542
1543/**
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001544 * release_tty - release tty structure memory
1545 *
1546 * Release both @tty and a possible linked partner (think pty pair),
1547 * and decrement the refcount of the backing module.
1548 *
1549 * Locking:
Alan Coxd1552552012-07-27 18:02:54 +01001550 * tty_mutex
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001551 * takes the file list lock internally when working on the list
1552 * of ttys that the driver keeps.
Alan Cox9c9f4de2008-10-13 10:37:26 +01001553 *
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001554 */
1555static void release_tty(struct tty_struct *tty, int idx)
1556{
Alan Cox9c9f4de2008-10-13 10:37:26 +01001557 /* This should always be true but check for the moment */
1558 WARN_ON(tty->index != idx);
Alan Coxd1552552012-07-27 18:02:54 +01001559 WARN_ON(!mutex_is_locked(&tty_mutex));
Alan Cox36b3c072012-07-17 17:06:57 +01001560 if (tty->ops->shutdown)
1561 tty->ops->shutdown(tty);
1562 tty_free_termios(tty);
1563 tty_driver_remove_tty(tty->driver, tty);
Jiri Slaby967fab62012-10-18 22:26:46 +02001564 tty->port->itty = NULL;
Alan Cox36b3c072012-07-17 17:06:57 +01001565
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001566 if (tty->link)
Alan Cox9c9f4de2008-10-13 10:37:26 +01001567 tty_kref_put(tty->link);
1568 tty_kref_put(tty);
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001569}
1570
Alan Coxeeb89d92009-11-30 13:18:29 +00001571/**
Jiri Slaby955787ca2011-11-11 10:47:23 +01001572 * tty_release_checks - check a tty before real release
1573 * @tty: tty to check
1574 * @o_tty: link of @tty (if any)
1575 * @idx: index of the tty
1576 *
1577 * Performs some paranoid checking before true release of the @tty.
1578 * This is a no-op unless TTY_PARANOIA_CHECK is defined.
1579 */
1580static int tty_release_checks(struct tty_struct *tty, struct tty_struct *o_tty,
1581 int idx)
1582{
1583#ifdef TTY_PARANOIA_CHECK
1584 if (idx < 0 || idx >= tty->driver->num) {
Jiri Slaby9de44bd2011-11-09 21:33:24 +01001585 printk(KERN_DEBUG "%s: bad idx when trying to free (%s)\n",
1586 __func__, tty->name);
Jiri Slaby955787ca2011-11-11 10:47:23 +01001587 return -1;
1588 }
1589
1590 /* not much to check for devpts */
1591 if (tty->driver->flags & TTY_DRIVER_DEVPTS_MEM)
1592 return 0;
1593
1594 if (tty != tty->driver->ttys[idx]) {
Jiri Slaby9de44bd2011-11-09 21:33:24 +01001595 printk(KERN_DEBUG "%s: driver.table[%d] not tty for (%s)\n",
1596 __func__, idx, tty->name);
Jiri Slaby955787ca2011-11-11 10:47:23 +01001597 return -1;
1598 }
Jiri Slaby955787ca2011-11-11 10:47:23 +01001599 if (tty->driver->other) {
1600 if (o_tty != tty->driver->other->ttys[idx]) {
Jiri Slaby9de44bd2011-11-09 21:33:24 +01001601 printk(KERN_DEBUG "%s: other->table[%d] not o_tty for (%s)\n",
1602 __func__, idx, tty->name);
Jiri Slaby955787ca2011-11-11 10:47:23 +01001603 return -1;
1604 }
Jiri Slaby955787ca2011-11-11 10:47:23 +01001605 if (o_tty->link != tty) {
Jiri Slaby9de44bd2011-11-09 21:33:24 +01001606 printk(KERN_DEBUG "%s: bad pty pointers\n", __func__);
Jiri Slaby955787ca2011-11-11 10:47:23 +01001607 return -1;
1608 }
1609 }
1610#endif
1611 return 0;
1612}
1613
1614/**
Alan Coxeeb89d92009-11-30 13:18:29 +00001615 * tty_release - vfs callback for close
1616 * @inode: inode of tty
1617 * @filp: file pointer for handle to tty
1618 *
1619 * Called the last time each file handle is closed that references
1620 * this tty. There may however be several such references.
1621 *
1622 * Locking:
1623 * Takes bkl. See tty_release_dev
1624 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07001625 * Even releasing the tty structures is a tricky business.. We have
1626 * to be very careful that the structures are all released at the
1627 * same time, as interrupts might otherwise get the wrong pointers.
1628 *
1629 * WSH 09/09/97: rewritten to avoid some nasty race conditions that could
1630 * lead to double frees or releasing memory still in use.
1631 */
Alan Coxeeb89d92009-11-30 13:18:29 +00001632
1633int tty_release(struct inode *inode, struct file *filp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001634{
Nick Piggind996b622010-08-18 04:37:36 +10001635 struct tty_struct *tty = file_tty(filp);
1636 struct tty_struct *o_tty;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001637 int pty_master, tty_closing, o_tty_closing, do_sleep;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001638 int idx;
1639 char buf[64];
Alan Cox37bdfb02008-02-08 04:18:47 -08001640
Jiri Slaby9de44bd2011-11-09 21:33:24 +01001641 if (tty_paranoia_check(tty, inode, __func__))
Alan Coxeeb89d92009-11-30 13:18:29 +00001642 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001643
Alan Cox89c8d912012-08-08 16:30:13 +01001644 tty_lock(tty);
Jiri Slaby9de44bd2011-11-09 21:33:24 +01001645 check_tty_count(tty, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001646
Arnd Bergmannec79d602010-06-01 22:53:01 +02001647 __tty_fasync(-1, filp, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001648
1649 idx = tty->index;
1650 pty_master = (tty->driver->type == TTY_DRIVER_TYPE_PTY &&
1651 tty->driver->subtype == PTY_TYPE_MASTER);
Alan Cox89c8d912012-08-08 16:30:13 +01001652 /* Review: parallel close */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001653 o_tty = tty->link;
1654
Jiri Slaby955787ca2011-11-11 10:47:23 +01001655 if (tty_release_checks(tty, o_tty, idx)) {
Alan Cox89c8d912012-08-08 16:30:13 +01001656 tty_unlock(tty);
Alan Coxeeb89d92009-11-30 13:18:29 +00001657 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001658 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001659
1660#ifdef TTY_DEBUG_HANGUP
Jiri Slaby9de44bd2011-11-09 21:33:24 +01001661 printk(KERN_DEBUG "%s: %s (tty count=%d)...\n", __func__,
1662 tty_name(tty, buf), tty->count);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001663#endif
1664
Alan Coxf34d7a52008-04-30 00:54:13 -07001665 if (tty->ops->close)
1666 tty->ops->close(tty, filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001667
Alan Cox89c8d912012-08-08 16:30:13 +01001668 tty_unlock(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001669 /*
1670 * Sanity check: if tty->count is going to zero, there shouldn't be
1671 * any waiters on tty->read_wait or tty->write_wait. We test the
1672 * wait queues and kick everyone out _before_ actually starting to
1673 * close. This ensures that we won't block while releasing the tty
1674 * structure.
1675 *
1676 * The test for the o_tty closing is necessary, since the master and
1677 * slave sides may close in any order. If the slave side closes out
1678 * first, its count will be one, since the master side holds an open.
1679 * Thus this test wouldn't be triggered at the time the slave closes,
1680 * so we do it now.
1681 *
1682 * Note that it's possible for the tty to be opened again while we're
1683 * flushing out waiters. By recalculating the closing flags before
1684 * each iteration we avoid any problems.
1685 */
1686 while (1) {
1687 /* Guard against races with tty->count changes elsewhere and
1688 opens on /dev/tty */
Alan Cox37bdfb02008-02-08 04:18:47 -08001689
Ingo Molnar70522e12006-03-23 03:00:31 -08001690 mutex_lock(&tty_mutex);
Alan Cox89c8d912012-08-08 16:30:13 +01001691 tty_lock_pair(tty, o_tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001692 tty_closing = tty->count <= 1;
1693 o_tty_closing = o_tty &&
1694 (o_tty->count <= (pty_master ? 1 : 0));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001695 do_sleep = 0;
1696
1697 if (tty_closing) {
1698 if (waitqueue_active(&tty->read_wait)) {
Davide Libenzi4b194492009-03-31 15:24:24 -07001699 wake_up_poll(&tty->read_wait, POLLIN);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001700 do_sleep++;
1701 }
1702 if (waitqueue_active(&tty->write_wait)) {
Davide Libenzi4b194492009-03-31 15:24:24 -07001703 wake_up_poll(&tty->write_wait, POLLOUT);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001704 do_sleep++;
1705 }
1706 }
1707 if (o_tty_closing) {
1708 if (waitqueue_active(&o_tty->read_wait)) {
Davide Libenzi4b194492009-03-31 15:24:24 -07001709 wake_up_poll(&o_tty->read_wait, POLLIN);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001710 do_sleep++;
1711 }
1712 if (waitqueue_active(&o_tty->write_wait)) {
Davide Libenzi4b194492009-03-31 15:24:24 -07001713 wake_up_poll(&o_tty->write_wait, POLLOUT);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001714 do_sleep++;
1715 }
1716 }
1717 if (!do_sleep)
1718 break;
1719
Jiri Slaby9de44bd2011-11-09 21:33:24 +01001720 printk(KERN_WARNING "%s: %s: read/write wait queue active!\n",
1721 __func__, tty_name(tty, buf));
Alan Cox89c8d912012-08-08 16:30:13 +01001722 tty_unlock_pair(tty, o_tty);
Ingo Molnar70522e12006-03-23 03:00:31 -08001723 mutex_unlock(&tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001724 schedule();
Alan Cox37bdfb02008-02-08 04:18:47 -08001725 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001726
1727 /*
Alan Cox37bdfb02008-02-08 04:18:47 -08001728 * The closing flags are now consistent with the open counts on
1729 * both sides, and we've completed the last operation that could
Linus Torvalds1da177e2005-04-16 15:20:36 -07001730 * block, so it's safe to proceed with closing.
Alan Coxd1552552012-07-27 18:02:54 +01001731 *
1732 * We must *not* drop the tty_mutex until we ensure that a further
1733 * entry into tty_open can not pick up this tty.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001734 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001735 if (pty_master) {
1736 if (--o_tty->count < 0) {
Jiri Slaby9de44bd2011-11-09 21:33:24 +01001737 printk(KERN_WARNING "%s: bad pty slave count (%d) for %s\n",
1738 __func__, o_tty->count, tty_name(o_tty, buf));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001739 o_tty->count = 0;
1740 }
1741 }
1742 if (--tty->count < 0) {
Jiri Slaby9de44bd2011-11-09 21:33:24 +01001743 printk(KERN_WARNING "%s: bad tty->count (%d) for %s\n",
1744 __func__, tty->count, tty_name(tty, buf));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001745 tty->count = 0;
1746 }
Alan Cox37bdfb02008-02-08 04:18:47 -08001747
Linus Torvalds1da177e2005-04-16 15:20:36 -07001748 /*
1749 * We've decremented tty->count, so we need to remove this file
1750 * descriptor off the tty->tty_files list; this serves two
1751 * purposes:
1752 * - check_tty_count sees the correct number of file descriptors
1753 * associated with this tty.
1754 * - do_tty_hangup no longer sees this file descriptor as
1755 * something that needs to be handled for hangups.
1756 */
Nick Piggind996b622010-08-18 04:37:36 +10001757 tty_del_file(filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001758
1759 /*
1760 * Perform some housekeeping before deciding whether to return.
1761 *
1762 * Set the TTY_CLOSING flag if this was the last open. In the
1763 * case of a pty we may have to wait around for the other side
1764 * to close, and TTY_CLOSING makes sure we can't be reopened.
1765 */
Alan Cox37bdfb02008-02-08 04:18:47 -08001766 if (tty_closing)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001767 set_bit(TTY_CLOSING, &tty->flags);
Alan Cox37bdfb02008-02-08 04:18:47 -08001768 if (o_tty_closing)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001769 set_bit(TTY_CLOSING, &o_tty->flags);
1770
1771 /*
1772 * If _either_ side is closing, make sure there aren't any
1773 * processes that still think tty or o_tty is their controlling
1774 * tty.
1775 */
1776 if (tty_closing || o_tty_closing) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001777 read_lock(&tasklist_lock);
Peter Zijlstra24ec8392006-12-08 02:36:04 -08001778 session_clear_tty(tty->session);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001779 if (o_tty)
Peter Zijlstra24ec8392006-12-08 02:36:04 -08001780 session_clear_tty(o_tty->session);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001781 read_unlock(&tasklist_lock);
1782 }
1783
Ingo Molnar70522e12006-03-23 03:00:31 -08001784 mutex_unlock(&tty_mutex);
Alan Cox89c8d912012-08-08 16:30:13 +01001785 tty_unlock_pair(tty, o_tty);
Alan Coxd1552552012-07-27 18:02:54 +01001786 /* At this point the TTY_CLOSING flag should ensure a dead tty
1787 cannot be re-opened by a racing opener */
Paul Fulghumda965822006-02-14 13:53:00 -08001788
Linus Torvalds1da177e2005-04-16 15:20:36 -07001789 /* check whether both sides are closing ... */
Alan Coxd1552552012-07-27 18:02:54 +01001790 if (!tty_closing || (o_tty && !o_tty_closing))
Alan Coxeeb89d92009-11-30 13:18:29 +00001791 return 0;
Alan Cox37bdfb02008-02-08 04:18:47 -08001792
Linus Torvalds1da177e2005-04-16 15:20:36 -07001793#ifdef TTY_DEBUG_HANGUP
Jiri Slaby9de44bd2011-11-09 21:33:24 +01001794 printk(KERN_DEBUG "%s: freeing tty structure...\n", __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001795#endif
1796 /*
Alan Cox01e1abb2008-07-22 11:16:55 +01001797 * Ask the line discipline code to release its structures
Linus Torvalds1da177e2005-04-16 15:20:36 -07001798 */
Alan Cox01e1abb2008-07-22 11:16:55 +01001799 tty_ldisc_release(tty, o_tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001800 /*
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001801 * The release_tty function takes care of the details of clearing
Alan Cox89c8d912012-08-08 16:30:13 +01001802 * the slots and preserving the termios structure. The tty_unlock_pair
1803 * should be safe as we keep a kref while the tty is locked (so the
1804 * unlock never unlocks a freed tty).
Linus Torvalds1da177e2005-04-16 15:20:36 -07001805 */
Alan Coxd1552552012-07-27 18:02:54 +01001806 mutex_lock(&tty_mutex);
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001807 release_tty(tty, idx);
Alan Coxd1552552012-07-27 18:02:54 +01001808 mutex_unlock(&tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001809
Alan Coxeeb89d92009-11-30 13:18:29 +00001810 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001811}
1812
Alan Coxaf9b8972006-08-27 01:24:01 -07001813/**
Jiri Slabyb82154a2011-11-09 21:33:19 +01001814 * tty_open_current_tty - get tty of current task for open
1815 * @device: device number
1816 * @filp: file pointer to tty
1817 * @return: tty of the current task iff @device is /dev/tty
1818 *
1819 * We cannot return driver and index like for the other nodes because
1820 * devpts will not work then. It expects inodes to be from devpts FS.
Alan Cox3af502b2012-05-03 22:21:53 +01001821 *
1822 * We need to move to returning a refcounted object from all the lookup
1823 * paths including this one.
Jiri Slabyb82154a2011-11-09 21:33:19 +01001824 */
1825static struct tty_struct *tty_open_current_tty(dev_t device, struct file *filp)
1826{
1827 struct tty_struct *tty;
1828
1829 if (device != MKDEV(TTYAUX_MAJOR, 0))
1830 return NULL;
1831
1832 tty = get_current_tty();
1833 if (!tty)
1834 return ERR_PTR(-ENXIO);
1835
1836 filp->f_flags |= O_NONBLOCK; /* Don't let /dev/tty block */
1837 /* noctty = 1; */
1838 tty_kref_put(tty);
1839 /* FIXME: we put a reference and return a TTY! */
Alan Cox3af502b2012-05-03 22:21:53 +01001840 /* This is only safe because the caller holds tty_mutex */
Jiri Slabyb82154a2011-11-09 21:33:19 +01001841 return tty;
1842}
1843
1844/**
Jiri Slaby5b5e7042011-11-09 21:33:20 +01001845 * tty_lookup_driver - lookup a tty driver for a given device file
1846 * @device: device number
1847 * @filp: file pointer to tty
1848 * @noctty: set if the device should not become a controlling tty
1849 * @index: index for the device in the @return driver
1850 * @return: driver for this inode (with increased refcount)
1851 *
1852 * If @return is not erroneous, the caller is responsible to decrement the
1853 * refcount by tty_driver_kref_put.
1854 *
1855 * Locking: tty_mutex protects get_tty_driver
1856 */
1857static struct tty_driver *tty_lookup_driver(dev_t device, struct file *filp,
1858 int *noctty, int *index)
1859{
1860 struct tty_driver *driver;
1861
Jiri Slaby2cd00502011-11-09 21:33:22 +01001862 switch (device) {
Jiri Slaby5b5e7042011-11-09 21:33:20 +01001863#ifdef CONFIG_VT
Jiri Slaby2cd00502011-11-09 21:33:22 +01001864 case MKDEV(TTY_MAJOR, 0): {
Jiri Slaby5b5e7042011-11-09 21:33:20 +01001865 extern struct tty_driver *console_driver;
1866 driver = tty_driver_kref_get(console_driver);
1867 *index = fg_console;
1868 *noctty = 1;
Jiri Slaby2cd00502011-11-09 21:33:22 +01001869 break;
Jiri Slaby5b5e7042011-11-09 21:33:20 +01001870 }
1871#endif
Jiri Slaby2cd00502011-11-09 21:33:22 +01001872 case MKDEV(TTYAUX_MAJOR, 1): {
Jiri Slaby5b5e7042011-11-09 21:33:20 +01001873 struct tty_driver *console_driver = console_device(index);
1874 if (console_driver) {
1875 driver = tty_driver_kref_get(console_driver);
1876 if (driver) {
1877 /* Don't let /dev/console block */
1878 filp->f_flags |= O_NONBLOCK;
1879 *noctty = 1;
Jiri Slaby2cd00502011-11-09 21:33:22 +01001880 break;
Jiri Slaby5b5e7042011-11-09 21:33:20 +01001881 }
1882 }
1883 return ERR_PTR(-ENODEV);
1884 }
Jiri Slaby2cd00502011-11-09 21:33:22 +01001885 default:
1886 driver = get_tty_driver(device, index);
1887 if (!driver)
1888 return ERR_PTR(-ENODEV);
1889 break;
1890 }
Jiri Slaby5b5e7042011-11-09 21:33:20 +01001891 return driver;
1892}
1893
1894/**
Alan Coxeeb89d92009-11-30 13:18:29 +00001895 * tty_open - open a tty device
Alan Coxaf9b8972006-08-27 01:24:01 -07001896 * @inode: inode of device file
1897 * @filp: file pointer to tty
Linus Torvalds1da177e2005-04-16 15:20:36 -07001898 *
Alan Coxaf9b8972006-08-27 01:24:01 -07001899 * tty_open and tty_release keep up the tty count that contains the
1900 * number of opens done on a tty. We cannot use the inode-count, as
1901 * different inodes might point to the same tty.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001902 *
Alan Coxaf9b8972006-08-27 01:24:01 -07001903 * Open-counting is needed for pty masters, as well as for keeping
1904 * track of serial lines: DTR is dropped when the last close happens.
1905 * (This is not done solely through tty->count, now. - Ted 1/27/92)
1906 *
1907 * The termios state of a pty is reset on first open so that
1908 * settings don't persist across reuse.
1909 *
Jiri Slaby5b5e7042011-11-09 21:33:20 +01001910 * Locking: tty_mutex protects tty, tty_lookup_driver and tty_init_dev.
Peter Zijlstra24ec8392006-12-08 02:36:04 -08001911 * tty->count should protect the rest.
1912 * ->siglock protects ->signal/->sighand
Alan Cox89c8d912012-08-08 16:30:13 +01001913 *
1914 * Note: the tty_unlock/lock cases without a ref are only safe due to
1915 * tty_mutex
Linus Torvalds1da177e2005-04-16 15:20:36 -07001916 */
Alan Coxaf9b8972006-08-27 01:24:01 -07001917
Alan Coxeeb89d92009-11-30 13:18:29 +00001918static int tty_open(struct inode *inode, struct file *filp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001919{
Jiri Slabyb82154a2011-11-09 21:33:19 +01001920 struct tty_struct *tty;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001921 int noctty, retval;
Jiri Slabyb82154a2011-11-09 21:33:19 +01001922 struct tty_driver *driver = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001923 int index;
1924 dev_t device = inode->i_rdev;
Andrew Morton846c1512009-04-02 16:56:36 -07001925 unsigned saved_flags = filp->f_flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001926
1927 nonseekable_open(inode, filp);
Alan Cox37bdfb02008-02-08 04:18:47 -08001928
Linus Torvalds1da177e2005-04-16 15:20:36 -07001929retry_open:
Jiri Slabyfa90e1c2011-10-12 11:32:43 +02001930 retval = tty_alloc_file(filp);
1931 if (retval)
1932 return -ENOMEM;
1933
Linus Torvalds1da177e2005-04-16 15:20:36 -07001934 noctty = filp->f_flags & O_NOCTTY;
1935 index = -1;
1936 retval = 0;
Alan Cox37bdfb02008-02-08 04:18:47 -08001937
Ingo Molnar70522e12006-03-23 03:00:31 -08001938 mutex_lock(&tty_mutex);
Alan Cox89c8d912012-08-08 16:30:13 +01001939 /* This is protected by the tty_mutex */
Jiri Slabyb82154a2011-11-09 21:33:19 +01001940 tty = tty_open_current_tty(device, filp);
1941 if (IS_ERR(tty)) {
Jiri Slabyba5db442011-11-09 21:33:21 +01001942 retval = PTR_ERR(tty);
1943 goto err_unlock;
Jiri Slaby5b5e7042011-11-09 21:33:20 +01001944 } else if (!tty) {
1945 driver = tty_lookup_driver(device, filp, &noctty, &index);
1946 if (IS_ERR(driver)) {
Jiri Slabyba5db442011-11-09 21:33:21 +01001947 retval = PTR_ERR(driver);
1948 goto err_unlock;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001949 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001950
Sukadev Bhattiprolu4a2b5fd2008-10-13 10:42:49 +01001951 /* check whether we're reopening an existing tty */
Sukadev Bhattiprolu15f1a632008-10-13 10:42:59 +01001952 tty = tty_driver_lookup_tty(driver, inode, index);
Eric Paris808ffa32009-01-27 11:50:37 +00001953 if (IS_ERR(tty)) {
Jiri Slabyba5db442011-11-09 21:33:21 +01001954 retval = PTR_ERR(tty);
1955 goto err_unlock;
Eric Paris808ffa32009-01-27 11:50:37 +00001956 }
Sukadev Bhattiprolu4a2b5fd2008-10-13 10:42:49 +01001957 }
1958
1959 if (tty) {
Alan Cox89c8d912012-08-08 16:30:13 +01001960 tty_lock(tty);
Sukadev Bhattiprolu4a2b5fd2008-10-13 10:42:49 +01001961 retval = tty_reopen(tty);
Alan Cox89c8d912012-08-08 16:30:13 +01001962 if (retval < 0) {
1963 tty_unlock(tty);
Sukadev Bhattiprolu4a2b5fd2008-10-13 10:42:49 +01001964 tty = ERR_PTR(retval);
Alan Cox89c8d912012-08-08 16:30:13 +01001965 }
1966 } else /* Returns with the tty_lock held for now */
Konstantin Khlebnikov593a27c2012-01-05 13:04:21 +04001967 tty = tty_init_dev(driver, index);
Sukadev Bhattiprolu4a2b5fd2008-10-13 10:42:49 +01001968
Ingo Molnar70522e12006-03-23 03:00:31 -08001969 mutex_unlock(&tty_mutex);
Jiri Slabyb82154a2011-11-09 21:33:19 +01001970 if (driver)
1971 tty_driver_kref_put(driver);
Alan Coxeeb89d92009-11-30 13:18:29 +00001972 if (IS_ERR(tty)) {
Jiri Slabyba5db442011-11-09 21:33:21 +01001973 retval = PTR_ERR(tty);
1974 goto err_file;
Alan Coxeeb89d92009-11-30 13:18:29 +00001975 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001976
Jiri Slabyfa90e1c2011-10-12 11:32:43 +02001977 tty_add_file(tty, filp);
Nick Piggind996b622010-08-18 04:37:36 +10001978
Jiri Slaby9de44bd2011-11-09 21:33:24 +01001979 check_tty_count(tty, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001980 if (tty->driver->type == TTY_DRIVER_TYPE_PTY &&
1981 tty->driver->subtype == PTY_TYPE_MASTER)
1982 noctty = 1;
1983#ifdef TTY_DEBUG_HANGUP
Jiri Slaby9de44bd2011-11-09 21:33:24 +01001984 printk(KERN_DEBUG "%s: opening %s...\n", __func__, tty->name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001985#endif
Herton Ronaldo Krzesinski909bc772011-03-31 15:35:31 -03001986 if (tty->ops->open)
1987 retval = tty->ops->open(tty, filp);
1988 else
1989 retval = -ENODEV;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001990 filp->f_flags = saved_flags;
1991
Alan Cox37bdfb02008-02-08 04:18:47 -08001992 if (!retval && test_bit(TTY_EXCLUSIVE, &tty->flags) &&
1993 !capable(CAP_SYS_ADMIN))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001994 retval = -EBUSY;
1995
1996 if (retval) {
1997#ifdef TTY_DEBUG_HANGUP
Jiri Slaby9de44bd2011-11-09 21:33:24 +01001998 printk(KERN_DEBUG "%s: error %d in opening %s...\n", __func__,
1999 retval, tty->name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002000#endif
Alan Cox89c8d912012-08-08 16:30:13 +01002001 tty_unlock(tty); /* need to call tty_release without BTM */
Alan Coxeeb89d92009-11-30 13:18:29 +00002002 tty_release(inode, filp);
Arnd Bergmann64ba3dc2010-06-01 22:53:02 +02002003 if (retval != -ERESTARTSYS)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002004 return retval;
Arnd Bergmann64ba3dc2010-06-01 22:53:02 +02002005
2006 if (signal_pending(current))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002007 return retval;
Arnd Bergmann64ba3dc2010-06-01 22:53:02 +02002008
Linus Torvalds1da177e2005-04-16 15:20:36 -07002009 schedule();
2010 /*
2011 * Need to reset f_op in case a hangup happened.
2012 */
2013 if (filp->f_op == &hung_up_tty_fops)
2014 filp->f_op = &tty_fops;
2015 goto retry_open;
2016 }
Alan Cox89c8d912012-08-08 16:30:13 +01002017 tty_unlock(tty);
Alan Coxeeb89d92009-11-30 13:18:29 +00002018
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002019
2020 mutex_lock(&tty_mutex);
Alan Cox89c8d912012-08-08 16:30:13 +01002021 tty_lock(tty);
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002022 spin_lock_irq(&current->sighand->siglock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002023 if (!noctty &&
2024 current->signal->leader &&
2025 !current->signal->tty &&
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08002026 tty->session == NULL)
Eric W. Biederman2a65f1d2007-05-08 00:26:53 -07002027 __proc_set_tty(current, tty);
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002028 spin_unlock_irq(&current->sighand->siglock);
Alan Cox89c8d912012-08-08 16:30:13 +01002029 tty_unlock(tty);
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002030 mutex_unlock(&tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002031 return 0;
Jiri Slabyba5db442011-11-09 21:33:21 +01002032err_unlock:
Jiri Slabyba5db442011-11-09 21:33:21 +01002033 mutex_unlock(&tty_mutex);
2034 /* after locks to avoid deadlock */
2035 if (!IS_ERR_OR_NULL(driver))
2036 tty_driver_kref_put(driver);
2037err_file:
2038 tty_free_file(filp);
2039 return retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002040}
2041
Jonathan Corbet39d95b92008-05-16 09:10:50 -06002042
Linus Torvalds1da177e2005-04-16 15:20:36 -07002043
Alan Coxaf9b8972006-08-27 01:24:01 -07002044/**
2045 * tty_poll - check tty status
2046 * @filp: file being polled
2047 * @wait: poll wait structures to update
2048 *
2049 * Call the line discipline polling method to obtain the poll
2050 * status of the device.
2051 *
2052 * Locking: locks called line discipline but ldisc poll method
2053 * may be re-entered freely by other callers.
2054 */
2055
Alan Cox37bdfb02008-02-08 04:18:47 -08002056static unsigned int tty_poll(struct file *filp, poll_table *wait)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002057{
Nick Piggind996b622010-08-18 04:37:36 +10002058 struct tty_struct *tty = file_tty(filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002059 struct tty_ldisc *ld;
2060 int ret = 0;
2061
Al Viro6131ffa2013-02-27 16:59:05 -05002062 if (tty_paranoia_check(tty, file_inode(filp), "tty_poll"))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002063 return 0;
Alan Cox37bdfb02008-02-08 04:18:47 -08002064
Linus Torvalds1da177e2005-04-16 15:20:36 -07002065 ld = tty_ldisc_ref_wait(tty);
Alan Coxa352def2008-07-16 21:53:12 +01002066 if (ld->ops->poll)
2067 ret = (ld->ops->poll)(tty, filp, wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002068 tty_ldisc_deref(ld);
2069 return ret;
2070}
2071
Arnd Bergmannec79d602010-06-01 22:53:01 +02002072static int __tty_fasync(int fd, struct file *filp, int on)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002073{
Nick Piggind996b622010-08-18 04:37:36 +10002074 struct tty_struct *tty = file_tty(filp);
Alan Cox47f86832008-04-30 00:53:30 -07002075 unsigned long flags;
Jonathan Corbet5d1e3232008-06-19 16:04:53 -06002076 int retval = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002077
Al Viro6131ffa2013-02-27 16:59:05 -05002078 if (tty_paranoia_check(tty, file_inode(filp), "tty_fasync"))
Jonathan Corbet5d1e3232008-06-19 16:04:53 -06002079 goto out;
Alan Cox37bdfb02008-02-08 04:18:47 -08002080
Linus Torvalds1da177e2005-04-16 15:20:36 -07002081 retval = fasync_helper(fd, filp, on, &tty->fasync);
2082 if (retval <= 0)
Jonathan Corbet5d1e3232008-06-19 16:04:53 -06002083 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002084
2085 if (on) {
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08002086 enum pid_type type;
2087 struct pid *pid;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002088 if (!waitqueue_active(&tty->read_wait))
2089 tty->minimum_to_wake = 1;
Alan Cox47f86832008-04-30 00:53:30 -07002090 spin_lock_irqsave(&tty->ctrl_lock, flags);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08002091 if (tty->pgrp) {
2092 pid = tty->pgrp;
2093 type = PIDTYPE_PGID;
2094 } else {
2095 pid = task_pid(current);
2096 type = PIDTYPE_PID;
2097 }
Linus Torvalds80e1e822010-02-07 10:11:23 -08002098 get_pid(pid);
Greg Kroah-Hartman70362512009-12-17 07:07:19 -08002099 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
Linus Torvalds80e1e822010-02-07 10:11:23 -08002100 retval = __f_setown(filp, pid, type, 0);
2101 put_pid(pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002102 if (retval)
Jonathan Corbet5d1e3232008-06-19 16:04:53 -06002103 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002104 } else {
2105 if (!tty->fasync && !waitqueue_active(&tty->read_wait))
2106 tty->minimum_to_wake = N_TTY_BUF_SIZE;
2107 }
Jonathan Corbet5d1e3232008-06-19 16:04:53 -06002108 retval = 0;
2109out:
Arnd Bergmannec79d602010-06-01 22:53:01 +02002110 return retval;
2111}
2112
2113static int tty_fasync(int fd, struct file *filp, int on)
2114{
Alan Cox89c8d912012-08-08 16:30:13 +01002115 struct tty_struct *tty = file_tty(filp);
Arnd Bergmannec79d602010-06-01 22:53:01 +02002116 int retval;
Alan Cox89c8d912012-08-08 16:30:13 +01002117
2118 tty_lock(tty);
Arnd Bergmannec79d602010-06-01 22:53:01 +02002119 retval = __tty_fasync(fd, filp, on);
Alan Cox89c8d912012-08-08 16:30:13 +01002120 tty_unlock(tty);
2121
Jonathan Corbet5d1e3232008-06-19 16:04:53 -06002122 return retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002123}
2124
Alan Coxaf9b8972006-08-27 01:24:01 -07002125/**
2126 * tiocsti - fake input character
2127 * @tty: tty to fake input into
2128 * @p: pointer to character
2129 *
Robert P. J. Day3a4fa0a2007-10-19 23:10:43 +02002130 * Fake input to a tty device. Does the necessary locking and
Alan Coxaf9b8972006-08-27 01:24:01 -07002131 * input management.
2132 *
2133 * FIXME: does not honour flow control ??
2134 *
2135 * Locking:
2136 * Called functions take tty_ldisc_lock
2137 * current->signal->tty check is safe without locks
Alan Cox28298232006-09-29 02:00:58 -07002138 *
2139 * FIXME: may race normal receive processing
Alan Coxaf9b8972006-08-27 01:24:01 -07002140 */
2141
Linus Torvalds1da177e2005-04-16 15:20:36 -07002142static int tiocsti(struct tty_struct *tty, char __user *p)
2143{
2144 char ch, mbz = 0;
2145 struct tty_ldisc *ld;
Alan Cox37bdfb02008-02-08 04:18:47 -08002146
Linus Torvalds1da177e2005-04-16 15:20:36 -07002147 if ((current->signal->tty != tty) && !capable(CAP_SYS_ADMIN))
2148 return -EPERM;
2149 if (get_user(ch, p))
2150 return -EFAULT;
Al Viro1e641742008-12-09 09:23:33 +00002151 tty_audit_tiocsti(tty, ch);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002152 ld = tty_ldisc_ref_wait(tty);
Alan Coxa352def2008-07-16 21:53:12 +01002153 ld->ops->receive_buf(tty, &ch, &mbz, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002154 tty_ldisc_deref(ld);
2155 return 0;
2156}
2157
Alan Coxaf9b8972006-08-27 01:24:01 -07002158/**
2159 * tiocgwinsz - implement window query ioctl
2160 * @tty; tty
2161 * @arg: user buffer for result
2162 *
Alan Cox808a0d32006-09-29 02:00:40 -07002163 * Copies the kernel idea of the window size into the user buffer.
Alan Coxaf9b8972006-08-27 01:24:01 -07002164 *
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002165 * Locking: tty->termios_mutex is taken to ensure the winsize data
Alan Cox808a0d32006-09-29 02:00:40 -07002166 * is consistent.
Alan Coxaf9b8972006-08-27 01:24:01 -07002167 */
2168
Alan Cox37bdfb02008-02-08 04:18:47 -08002169static int tiocgwinsz(struct tty_struct *tty, struct winsize __user *arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002170{
Alan Cox808a0d32006-09-29 02:00:40 -07002171 int err;
2172
Arjan van de Ven5785c952006-09-29 02:00:43 -07002173 mutex_lock(&tty->termios_mutex);
Alan Cox808a0d32006-09-29 02:00:40 -07002174 err = copy_to_user(arg, &tty->winsize, sizeof(*arg));
Arjan van de Ven5785c952006-09-29 02:00:43 -07002175 mutex_unlock(&tty->termios_mutex);
Alan Cox808a0d32006-09-29 02:00:40 -07002176
2177 return err ? -EFAULT: 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002178}
2179
Alan Coxaf9b8972006-08-27 01:24:01 -07002180/**
Alan Cox8c9a9dd2008-08-15 10:39:38 +01002181 * tty_do_resize - resize event
2182 * @tty: tty being resized
Alan Cox8c9a9dd2008-08-15 10:39:38 +01002183 * @rows: rows (character)
2184 * @cols: cols (character)
Alan Coxaf9b8972006-08-27 01:24:01 -07002185 *
Daniel Mack3ad2f3f2010-02-03 08:01:28 +08002186 * Update the termios variables and send the necessary signals to
Alan Cox8c9a9dd2008-08-15 10:39:38 +01002187 * peform a terminal resize correctly
Alan Coxaf9b8972006-08-27 01:24:01 -07002188 */
2189
Alan Coxfc6f6232009-01-02 13:43:17 +00002190int tty_do_resize(struct tty_struct *tty, struct winsize *ws)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002191{
Alan Coxfc6f6232009-01-02 13:43:17 +00002192 struct pid *pgrp;
Alan Cox47f86832008-04-30 00:53:30 -07002193 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002194
Alan Coxfc6f6232009-01-02 13:43:17 +00002195 /* Lock the tty */
2196 mutex_lock(&tty->termios_mutex);
2197 if (!memcmp(ws, &tty->winsize, sizeof(*ws)))
Alan Coxca9bda02006-09-29 02:00:03 -07002198 goto done;
Alan Cox47f86832008-04-30 00:53:30 -07002199 /* Get the PID values and reference them so we can
2200 avoid holding the tty ctrl lock while sending signals */
2201 spin_lock_irqsave(&tty->ctrl_lock, flags);
2202 pgrp = get_pid(tty->pgrp);
Alan Cox47f86832008-04-30 00:53:30 -07002203 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
2204
2205 if (pgrp)
2206 kill_pgrp(pgrp, SIGWINCH, 1);
Alan Cox47f86832008-04-30 00:53:30 -07002207 put_pid(pgrp);
Alan Cox47f86832008-04-30 00:53:30 -07002208
Alan Cox8c9a9dd2008-08-15 10:39:38 +01002209 tty->winsize = *ws;
Alan Coxca9bda02006-09-29 02:00:03 -07002210done:
Alan Coxfc6f6232009-01-02 13:43:17 +00002211 mutex_unlock(&tty->termios_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002212 return 0;
2213}
Martin Schwidefsky4d334fd2013-01-04 14:55:13 +01002214EXPORT_SYMBOL(tty_do_resize);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002215
Alan Coxaf9b8972006-08-27 01:24:01 -07002216/**
Alan Cox8c9a9dd2008-08-15 10:39:38 +01002217 * tiocswinsz - implement window size set ioctl
Alan Coxfc6f6232009-01-02 13:43:17 +00002218 * @tty; tty side of tty
Alan Cox8c9a9dd2008-08-15 10:39:38 +01002219 * @arg: user buffer for result
2220 *
2221 * Copies the user idea of the window size to the kernel. Traditionally
2222 * this is just advisory information but for the Linux console it
2223 * actually has driver level meaning and triggers a VC resize.
2224 *
2225 * Locking:
Lucas De Marchi25985ed2011-03-30 22:57:33 -03002226 * Driver dependent. The default do_resize method takes the
Alan Cox8c9a9dd2008-08-15 10:39:38 +01002227 * tty termios mutex and ctrl_lock. The console takes its own lock
2228 * then calls into the default method.
2229 */
2230
Alan Coxfc6f6232009-01-02 13:43:17 +00002231static int tiocswinsz(struct tty_struct *tty, struct winsize __user *arg)
Alan Cox8c9a9dd2008-08-15 10:39:38 +01002232{
2233 struct winsize tmp_ws;
2234 if (copy_from_user(&tmp_ws, arg, sizeof(*arg)))
2235 return -EFAULT;
2236
2237 if (tty->ops->resize)
Alan Coxfc6f6232009-01-02 13:43:17 +00002238 return tty->ops->resize(tty, &tmp_ws);
Alan Cox8c9a9dd2008-08-15 10:39:38 +01002239 else
Alan Coxfc6f6232009-01-02 13:43:17 +00002240 return tty_do_resize(tty, &tmp_ws);
Alan Cox8c9a9dd2008-08-15 10:39:38 +01002241}
2242
2243/**
Alan Coxaf9b8972006-08-27 01:24:01 -07002244 * tioccons - allow admin to move logical console
2245 * @file: the file to become console
2246 *
Lucas De Marchi25985ed2011-03-30 22:57:33 -03002247 * Allow the administrator to move the redirected console device
Alan Coxaf9b8972006-08-27 01:24:01 -07002248 *
2249 * Locking: uses redirect_lock to guard the redirect information
2250 */
2251
Linus Torvalds1da177e2005-04-16 15:20:36 -07002252static int tioccons(struct file *file)
2253{
2254 if (!capable(CAP_SYS_ADMIN))
2255 return -EPERM;
2256 if (file->f_op->write == redirected_tty_write) {
2257 struct file *f;
2258 spin_lock(&redirect_lock);
2259 f = redirect;
2260 redirect = NULL;
2261 spin_unlock(&redirect_lock);
2262 if (f)
2263 fput(f);
2264 return 0;
2265 }
2266 spin_lock(&redirect_lock);
2267 if (redirect) {
2268 spin_unlock(&redirect_lock);
2269 return -EBUSY;
2270 }
Al Virocb0942b2012-08-27 14:48:26 -04002271 redirect = get_file(file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002272 spin_unlock(&redirect_lock);
2273 return 0;
2274}
2275
Alan Coxaf9b8972006-08-27 01:24:01 -07002276/**
2277 * fionbio - non blocking ioctl
2278 * @file: file to set blocking value
2279 * @p: user parameter
2280 *
2281 * Historical tty interfaces had a blocking control ioctl before
2282 * the generic functionality existed. This piece of history is preserved
2283 * in the expected tty API of posix OS's.
2284 *
Alan Cox6146b9a2009-09-19 13:13:19 -07002285 * Locking: none, the open file handle ensures it won't go away.
Alan Coxaf9b8972006-08-27 01:24:01 -07002286 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002287
2288static int fionbio(struct file *file, int __user *p)
2289{
2290 int nonblock;
2291
2292 if (get_user(nonblock, p))
2293 return -EFAULT;
2294
Jonathan Corbetdb1dd4d2009-02-06 15:25:24 -07002295 spin_lock(&file->f_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002296 if (nonblock)
2297 file->f_flags |= O_NONBLOCK;
2298 else
2299 file->f_flags &= ~O_NONBLOCK;
Jonathan Corbetdb1dd4d2009-02-06 15:25:24 -07002300 spin_unlock(&file->f_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002301 return 0;
2302}
2303
Alan Coxaf9b8972006-08-27 01:24:01 -07002304/**
2305 * tiocsctty - set controlling tty
2306 * @tty: tty structure
2307 * @arg: user argument
2308 *
2309 * This ioctl is used to manage job control. It permits a session
2310 * leader to set this tty as the controlling tty for the session.
2311 *
2312 * Locking:
Alan Cox28298232006-09-29 02:00:58 -07002313 * Takes tty_mutex() to protect tty instance
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002314 * Takes tasklist_lock internally to walk sessions
2315 * Takes ->siglock() when updating signal->tty
Alan Coxaf9b8972006-08-27 01:24:01 -07002316 */
2317
Linus Torvalds1da177e2005-04-16 15:20:36 -07002318static int tiocsctty(struct tty_struct *tty, int arg)
2319{
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002320 int ret = 0;
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08002321 if (current->signal->leader && (task_session(current) == tty->session))
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002322 return ret;
2323
2324 mutex_lock(&tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002325 /*
2326 * The process must be a session leader and
2327 * not have a controlling tty already.
2328 */
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002329 if (!current->signal->leader || current->signal->tty) {
2330 ret = -EPERM;
2331 goto unlock;
2332 }
2333
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08002334 if (tty->session) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002335 /*
2336 * This tty is already the controlling
2337 * tty for another session group!
2338 */
Alan Cox37bdfb02008-02-08 04:18:47 -08002339 if (arg == 1 && capable(CAP_SYS_ADMIN)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002340 /*
2341 * Steal it away
2342 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002343 read_lock(&tasklist_lock);
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002344 session_clear_tty(tty->session);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002345 read_unlock(&tasklist_lock);
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002346 } else {
2347 ret = -EPERM;
2348 goto unlock;
2349 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002350 }
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002351 proc_set_tty(current, tty);
2352unlock:
Alan Cox28298232006-09-29 02:00:58 -07002353 mutex_unlock(&tty_mutex);
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002354 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002355}
2356
Alan Coxaf9b8972006-08-27 01:24:01 -07002357/**
Alan Cox5d0fdf12008-04-30 00:53:31 -07002358 * tty_get_pgrp - return a ref counted pgrp pid
2359 * @tty: tty to read
2360 *
2361 * Returns a refcounted instance of the pid struct for the process
2362 * group controlling the tty.
2363 */
2364
2365struct pid *tty_get_pgrp(struct tty_struct *tty)
2366{
2367 unsigned long flags;
2368 struct pid *pgrp;
2369
2370 spin_lock_irqsave(&tty->ctrl_lock, flags);
2371 pgrp = get_pid(tty->pgrp);
2372 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
2373
2374 return pgrp;
2375}
2376EXPORT_SYMBOL_GPL(tty_get_pgrp);
2377
2378/**
Alan Coxaf9b8972006-08-27 01:24:01 -07002379 * tiocgpgrp - get process group
2380 * @tty: tty passed by user
Lucas De Marchi25985ed2011-03-30 22:57:33 -03002381 * @real_tty: tty side of the tty passed by the user if a pty else the tty
Alan Coxaf9b8972006-08-27 01:24:01 -07002382 * @p: returned pid
2383 *
2384 * Obtain the process group of the tty. If there is no process group
2385 * return an error.
2386 *
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002387 * Locking: none. Reference to current->signal->tty is safe.
Alan Coxaf9b8972006-08-27 01:24:01 -07002388 */
2389
Linus Torvalds1da177e2005-04-16 15:20:36 -07002390static int tiocgpgrp(struct tty_struct *tty, struct tty_struct *real_tty, pid_t __user *p)
2391{
Alan Cox5d0fdf12008-04-30 00:53:31 -07002392 struct pid *pid;
2393 int ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002394 /*
2395 * (tty == real_tty) is a cheap way of
2396 * testing if the tty is NOT a master pty.
2397 */
2398 if (tty == real_tty && current->signal->tty != real_tty)
2399 return -ENOTTY;
Alan Cox5d0fdf12008-04-30 00:53:31 -07002400 pid = tty_get_pgrp(real_tty);
2401 ret = put_user(pid_vnr(pid), p);
2402 put_pid(pid);
2403 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002404}
2405
Alan Coxaf9b8972006-08-27 01:24:01 -07002406/**
2407 * tiocspgrp - attempt to set process group
2408 * @tty: tty passed by user
2409 * @real_tty: tty side device matching tty passed by user
2410 * @p: pid pointer
2411 *
2412 * Set the process group of the tty to the session passed. Only
2413 * permitted where the tty session is our session.
2414 *
Alan Cox47f86832008-04-30 00:53:30 -07002415 * Locking: RCU, ctrl lock
Alan Coxaf9b8972006-08-27 01:24:01 -07002416 */
2417
Linus Torvalds1da177e2005-04-16 15:20:36 -07002418static int tiocspgrp(struct tty_struct *tty, struct tty_struct *real_tty, pid_t __user *p)
2419{
Eric W. Biederman04a2e6a2007-02-12 00:52:56 -08002420 struct pid *pgrp;
2421 pid_t pgrp_nr;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002422 int retval = tty_check_change(real_tty);
Alan Cox47f86832008-04-30 00:53:30 -07002423 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002424
2425 if (retval == -EIO)
2426 return -ENOTTY;
2427 if (retval)
2428 return retval;
2429 if (!current->signal->tty ||
2430 (current->signal->tty != real_tty) ||
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08002431 (real_tty->session != task_session(current)))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002432 return -ENOTTY;
Eric W. Biederman04a2e6a2007-02-12 00:52:56 -08002433 if (get_user(pgrp_nr, p))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002434 return -EFAULT;
Eric W. Biederman04a2e6a2007-02-12 00:52:56 -08002435 if (pgrp_nr < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002436 return -EINVAL;
Eric W. Biederman04a2e6a2007-02-12 00:52:56 -08002437 rcu_read_lock();
Pavel Emelyanovb4888932007-10-18 23:40:14 -07002438 pgrp = find_vpid(pgrp_nr);
Eric W. Biederman04a2e6a2007-02-12 00:52:56 -08002439 retval = -ESRCH;
2440 if (!pgrp)
2441 goto out_unlock;
2442 retval = -EPERM;
2443 if (session_of_pgrp(pgrp) != task_session(current))
2444 goto out_unlock;
2445 retval = 0;
Alan Cox47f86832008-04-30 00:53:30 -07002446 spin_lock_irqsave(&tty->ctrl_lock, flags);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08002447 put_pid(real_tty->pgrp);
2448 real_tty->pgrp = get_pid(pgrp);
Alan Cox47f86832008-04-30 00:53:30 -07002449 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
Eric W. Biederman04a2e6a2007-02-12 00:52:56 -08002450out_unlock:
2451 rcu_read_unlock();
2452 return retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002453}
2454
Alan Coxaf9b8972006-08-27 01:24:01 -07002455/**
2456 * tiocgsid - get session id
2457 * @tty: tty passed by user
Lucas De Marchi25985ed2011-03-30 22:57:33 -03002458 * @real_tty: tty side of the tty passed by the user if a pty else the tty
Alan Coxaf9b8972006-08-27 01:24:01 -07002459 * @p: pointer to returned session id
2460 *
2461 * Obtain the session id of the tty. If there is no session
2462 * return an error.
2463 *
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002464 * Locking: none. Reference to current->signal->tty is safe.
Alan Coxaf9b8972006-08-27 01:24:01 -07002465 */
2466
Linus Torvalds1da177e2005-04-16 15:20:36 -07002467static int tiocgsid(struct tty_struct *tty, struct tty_struct *real_tty, pid_t __user *p)
2468{
2469 /*
2470 * (tty == real_tty) is a cheap way of
2471 * testing if the tty is NOT a master pty.
2472 */
2473 if (tty == real_tty && current->signal->tty != real_tty)
2474 return -ENOTTY;
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08002475 if (!real_tty->session)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002476 return -ENOTTY;
Pavel Emelyanovb4888932007-10-18 23:40:14 -07002477 return put_user(pid_vnr(real_tty->session), p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002478}
2479
Alan Coxaf9b8972006-08-27 01:24:01 -07002480/**
2481 * tiocsetd - set line discipline
2482 * @tty: tty device
2483 * @p: pointer to user data
2484 *
2485 * Set the line discipline according to user request.
2486 *
2487 * Locking: see tty_set_ldisc, this function is just a helper
2488 */
2489
Linus Torvalds1da177e2005-04-16 15:20:36 -07002490static int tiocsetd(struct tty_struct *tty, int __user *p)
2491{
2492 int ldisc;
Alan Cox04f378b2008-04-30 00:53:29 -07002493 int ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002494
2495 if (get_user(ldisc, p))
2496 return -EFAULT;
Alan Cox04f378b2008-04-30 00:53:29 -07002497
Alan Cox04f378b2008-04-30 00:53:29 -07002498 ret = tty_set_ldisc(tty, ldisc);
Alan Cox04f378b2008-04-30 00:53:29 -07002499
2500 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002501}
2502
Alan Coxaf9b8972006-08-27 01:24:01 -07002503/**
2504 * send_break - performed time break
2505 * @tty: device to break on
2506 * @duration: timeout in mS
2507 *
2508 * Perform a timed break on hardware that lacks its own driver level
2509 * timed break functionality.
2510 *
2511 * Locking:
Alan Cox28298232006-09-29 02:00:58 -07002512 * atomic_write_lock serializes
Alan Coxaf9b8972006-08-27 01:24:01 -07002513 *
Alan Coxaf9b8972006-08-27 01:24:01 -07002514 */
2515
Domen Puncerb20f3ae2005-06-25 14:58:42 -07002516static int send_break(struct tty_struct *tty, unsigned int duration)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002517{
Alan Cox9e989662008-07-22 11:18:03 +01002518 int retval;
2519
2520 if (tty->ops->break_ctl == NULL)
2521 return 0;
2522
2523 if (tty->driver->flags & TTY_DRIVER_HARDWARE_BREAK)
2524 retval = tty->ops->break_ctl(tty, duration);
2525 else {
2526 /* Do the work ourselves */
2527 if (tty_write_lock(tty, 0) < 0)
2528 return -EINTR;
2529 retval = tty->ops->break_ctl(tty, -1);
2530 if (retval)
2531 goto out;
2532 if (!signal_pending(current))
2533 msleep_interruptible(duration);
2534 retval = tty->ops->break_ctl(tty, 0);
2535out:
2536 tty_write_unlock(tty);
2537 if (signal_pending(current))
2538 retval = -EINTR;
2539 }
2540 return retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002541}
2542
Alan Coxaf9b8972006-08-27 01:24:01 -07002543/**
Alan Coxf34d7a52008-04-30 00:54:13 -07002544 * tty_tiocmget - get modem status
Alan Coxaf9b8972006-08-27 01:24:01 -07002545 * @tty: tty device
2546 * @file: user file pointer
2547 * @p: pointer to result
2548 *
2549 * Obtain the modem status bits from the tty driver if the feature
2550 * is supported. Return -EINVAL if it is not available.
2551 *
2552 * Locking: none (up to the driver)
2553 */
2554
Alan Cox60b33c12011-02-14 16:26:14 +00002555static int tty_tiocmget(struct tty_struct *tty, int __user *p)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002556{
2557 int retval = -EINVAL;
2558
Alan Coxf34d7a52008-04-30 00:54:13 -07002559 if (tty->ops->tiocmget) {
Alan Cox60b33c12011-02-14 16:26:14 +00002560 retval = tty->ops->tiocmget(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002561
2562 if (retval >= 0)
2563 retval = put_user(retval, p);
2564 }
2565 return retval;
2566}
2567
Alan Coxaf9b8972006-08-27 01:24:01 -07002568/**
Alan Coxf34d7a52008-04-30 00:54:13 -07002569 * tty_tiocmset - set modem status
Alan Coxaf9b8972006-08-27 01:24:01 -07002570 * @tty: tty device
Alan Coxaf9b8972006-08-27 01:24:01 -07002571 * @cmd: command - clear bits, set bits or set all
2572 * @p: pointer to desired bits
2573 *
2574 * Set the modem status bits from the tty driver if the feature
2575 * is supported. Return -EINVAL if it is not available.
2576 *
2577 * Locking: none (up to the driver)
2578 */
2579
Alan Cox20b9d172011-02-14 16:26:50 +00002580static int tty_tiocmset(struct tty_struct *tty, unsigned int cmd,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002581 unsigned __user *p)
2582{
Alan Coxae677512008-07-16 21:56:54 +01002583 int retval;
2584 unsigned int set, clear, val;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002585
Alan Coxae677512008-07-16 21:56:54 +01002586 if (tty->ops->tiocmset == NULL)
2587 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002588
Alan Coxae677512008-07-16 21:56:54 +01002589 retval = get_user(val, p);
2590 if (retval)
2591 return retval;
2592 set = clear = 0;
2593 switch (cmd) {
2594 case TIOCMBIS:
2595 set = val;
2596 break;
2597 case TIOCMBIC:
2598 clear = val;
2599 break;
2600 case TIOCMSET:
2601 set = val;
2602 clear = ~val;
2603 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002604 }
Alan Coxae677512008-07-16 21:56:54 +01002605 set &= TIOCM_DTR|TIOCM_RTS|TIOCM_OUT1|TIOCM_OUT2|TIOCM_LOOP;
2606 clear &= TIOCM_DTR|TIOCM_RTS|TIOCM_OUT1|TIOCM_OUT2|TIOCM_LOOP;
Alan Cox20b9d172011-02-14 16:26:50 +00002607 return tty->ops->tiocmset(tty, set, clear);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002608}
2609
Alan Coxd281da72010-09-16 18:21:24 +01002610static int tty_tiocgicount(struct tty_struct *tty, void __user *arg)
2611{
2612 int retval = -EINVAL;
2613 struct serial_icounter_struct icount;
2614 memset(&icount, 0, sizeof(icount));
2615 if (tty->ops->get_icount)
2616 retval = tty->ops->get_icount(tty, &icount);
2617 if (retval != 0)
2618 return retval;
2619 if (copy_to_user(arg, &icount, sizeof(icount)))
2620 return -EFAULT;
2621 return 0;
2622}
2623
Alan Coxe8b70e72009-06-11 12:48:02 +01002624struct tty_struct *tty_pair_get_tty(struct tty_struct *tty)
2625{
2626 if (tty->driver->type == TTY_DRIVER_TYPE_PTY &&
2627 tty->driver->subtype == PTY_TYPE_MASTER)
2628 tty = tty->link;
2629 return tty;
2630}
2631EXPORT_SYMBOL(tty_pair_get_tty);
2632
2633struct tty_struct *tty_pair_get_pty(struct tty_struct *tty)
2634{
2635 if (tty->driver->type == TTY_DRIVER_TYPE_PTY &&
2636 tty->driver->subtype == PTY_TYPE_MASTER)
2637 return tty;
2638 return tty->link;
2639}
2640EXPORT_SYMBOL(tty_pair_get_pty);
2641
Linus Torvalds1da177e2005-04-16 15:20:36 -07002642/*
2643 * Split this up, as gcc can choke on it otherwise..
2644 */
Alan Cox04f378b2008-04-30 00:53:29 -07002645long tty_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002646{
Nick Piggind996b622010-08-18 04:37:36 +10002647 struct tty_struct *tty = file_tty(file);
2648 struct tty_struct *real_tty;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002649 void __user *p = (void __user *)arg;
2650 int retval;
2651 struct tty_ldisc *ld;
Alan Cox37bdfb02008-02-08 04:18:47 -08002652
Al Viro6131ffa2013-02-27 16:59:05 -05002653 if (tty_paranoia_check(tty, file_inode(file), "tty_ioctl"))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002654 return -EINVAL;
2655
Alan Coxe8b70e72009-06-11 12:48:02 +01002656 real_tty = tty_pair_get_tty(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002657
2658 /*
2659 * Factor out some common prep work
2660 */
2661 switch (cmd) {
2662 case TIOCSETD:
2663 case TIOCSBRK:
2664 case TIOCCBRK:
2665 case TCSBRK:
Alan Cox37bdfb02008-02-08 04:18:47 -08002666 case TCSBRKP:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002667 retval = tty_check_change(tty);
2668 if (retval)
2669 return retval;
2670 if (cmd != TIOCCBRK) {
2671 tty_wait_until_sent(tty, 0);
2672 if (signal_pending(current))
2673 return -EINTR;
2674 }
2675 break;
2676 }
2677
Alan Cox9e989662008-07-22 11:18:03 +01002678 /*
2679 * Now do the stuff.
2680 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002681 switch (cmd) {
Alan Cox37bdfb02008-02-08 04:18:47 -08002682 case TIOCSTI:
2683 return tiocsti(tty, p);
2684 case TIOCGWINSZ:
Alan Cox8f520022008-10-13 10:38:46 +01002685 return tiocgwinsz(real_tty, p);
Alan Cox37bdfb02008-02-08 04:18:47 -08002686 case TIOCSWINSZ:
Alan Coxfc6f6232009-01-02 13:43:17 +00002687 return tiocswinsz(real_tty, p);
Alan Cox37bdfb02008-02-08 04:18:47 -08002688 case TIOCCONS:
2689 return real_tty != tty ? -EINVAL : tioccons(file);
2690 case FIONBIO:
2691 return fionbio(file, p);
2692 case TIOCEXCL:
2693 set_bit(TTY_EXCLUSIVE, &tty->flags);
2694 return 0;
2695 case TIOCNXCL:
2696 clear_bit(TTY_EXCLUSIVE, &tty->flags);
2697 return 0;
Cyrill Gorcunov84fd7bd2012-10-24 23:43:22 +04002698 case TIOCGEXCL:
2699 {
2700 int excl = test_bit(TTY_EXCLUSIVE, &tty->flags);
2701 return put_user(excl, (int __user *)p);
2702 }
Alan Cox37bdfb02008-02-08 04:18:47 -08002703 case TIOCNOTTY:
2704 if (current->signal->tty != tty)
2705 return -ENOTTY;
2706 no_tty();
2707 return 0;
2708 case TIOCSCTTY:
2709 return tiocsctty(tty, arg);
2710 case TIOCGPGRP:
2711 return tiocgpgrp(tty, real_tty, p);
2712 case TIOCSPGRP:
2713 return tiocspgrp(tty, real_tty, p);
2714 case TIOCGSID:
2715 return tiocgsid(tty, real_tty, p);
2716 case TIOCGETD:
Alan Coxc65c9bc2009-06-11 12:50:12 +01002717 return put_user(tty->ldisc->ops->num, (int __user *)p);
Alan Cox37bdfb02008-02-08 04:18:47 -08002718 case TIOCSETD:
2719 return tiocsetd(tty, p);
Kay Sievers3c95c982011-02-17 18:39:28 +01002720 case TIOCVHANGUP:
2721 if (!capable(CAP_SYS_ADMIN))
2722 return -EPERM;
2723 tty_vhangup(tty);
2724 return 0;
Werner Finkb7b8de02010-12-03 12:48:23 +01002725 case TIOCGDEV:
2726 {
2727 unsigned int ret = new_encode_dev(tty_devnum(real_tty));
2728 return put_user(ret, (unsigned int __user *)p);
2729 }
Alan Cox37bdfb02008-02-08 04:18:47 -08002730 /*
2731 * Break handling
2732 */
2733 case TIOCSBRK: /* Turn break on, unconditionally */
Alan Coxf34d7a52008-04-30 00:54:13 -07002734 if (tty->ops->break_ctl)
Alan Cox9e989662008-07-22 11:18:03 +01002735 return tty->ops->break_ctl(tty, -1);
Alan Cox37bdfb02008-02-08 04:18:47 -08002736 return 0;
Alan Cox37bdfb02008-02-08 04:18:47 -08002737 case TIOCCBRK: /* Turn break off, unconditionally */
Alan Coxf34d7a52008-04-30 00:54:13 -07002738 if (tty->ops->break_ctl)
Alan Cox9e989662008-07-22 11:18:03 +01002739 return tty->ops->break_ctl(tty, 0);
Alan Cox37bdfb02008-02-08 04:18:47 -08002740 return 0;
2741 case TCSBRK: /* SVID version: non-zero arg --> no break */
2742 /* non-zero arg means wait for all output data
2743 * to be sent (performed above) but don't send break.
2744 * This is used by the tcdrain() termios function.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002745 */
Alan Cox37bdfb02008-02-08 04:18:47 -08002746 if (!arg)
2747 return send_break(tty, 250);
2748 return 0;
2749 case TCSBRKP: /* support for POSIX tcsendbreak() */
2750 return send_break(tty, arg ? arg*100 : 250);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002751
Alan Cox37bdfb02008-02-08 04:18:47 -08002752 case TIOCMGET:
Alan Cox60b33c12011-02-14 16:26:14 +00002753 return tty_tiocmget(tty, p);
Alan Cox37bdfb02008-02-08 04:18:47 -08002754 case TIOCMSET:
2755 case TIOCMBIC:
2756 case TIOCMBIS:
Alan Cox20b9d172011-02-14 16:26:50 +00002757 return tty_tiocmset(tty, cmd, p);
Alan Coxd281da72010-09-16 18:21:24 +01002758 case TIOCGICOUNT:
2759 retval = tty_tiocgicount(tty, p);
2760 /* For the moment allow fall through to the old method */
2761 if (retval != -EINVAL)
2762 return retval;
2763 break;
Alan Cox37bdfb02008-02-08 04:18:47 -08002764 case TCFLSH:
2765 switch (arg) {
2766 case TCIFLUSH:
2767 case TCIOFLUSH:
2768 /* flush tty buffer and allow ldisc to process ioctl */
2769 tty_buffer_flush(tty);
Paul Fulghumc5c34d42007-05-12 10:36:55 -07002770 break;
Alan Cox37bdfb02008-02-08 04:18:47 -08002771 }
2772 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002773 }
Alan Coxf34d7a52008-04-30 00:54:13 -07002774 if (tty->ops->ioctl) {
Alan Cox6caa76b2011-02-14 16:27:22 +00002775 retval = (tty->ops->ioctl)(tty, cmd, arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002776 if (retval != -ENOIOCTLCMD)
2777 return retval;
2778 }
2779 ld = tty_ldisc_ref_wait(tty);
2780 retval = -EINVAL;
Alan Coxa352def2008-07-16 21:53:12 +01002781 if (ld->ops->ioctl) {
2782 retval = ld->ops->ioctl(tty, file, cmd, arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002783 if (retval == -ENOIOCTLCMD)
Wanlong Gaobbb63c52012-08-27 15:23:12 +08002784 retval = -ENOTTY;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002785 }
2786 tty_ldisc_deref(ld);
2787 return retval;
2788}
2789
Paul Fulghume10cc1d2007-05-10 22:22:50 -07002790#ifdef CONFIG_COMPAT
Alan Cox37bdfb02008-02-08 04:18:47 -08002791static long tty_compat_ioctl(struct file *file, unsigned int cmd,
Paul Fulghume10cc1d2007-05-10 22:22:50 -07002792 unsigned long arg)
2793{
Nick Piggind996b622010-08-18 04:37:36 +10002794 struct tty_struct *tty = file_tty(file);
Paul Fulghume10cc1d2007-05-10 22:22:50 -07002795 struct tty_ldisc *ld;
2796 int retval = -ENOIOCTLCMD;
2797
Al Viro6131ffa2013-02-27 16:59:05 -05002798 if (tty_paranoia_check(tty, file_inode(file), "tty_ioctl"))
Paul Fulghume10cc1d2007-05-10 22:22:50 -07002799 return -EINVAL;
2800
Alan Coxf34d7a52008-04-30 00:54:13 -07002801 if (tty->ops->compat_ioctl) {
Alan Cox6caa76b2011-02-14 16:27:22 +00002802 retval = (tty->ops->compat_ioctl)(tty, cmd, arg);
Paul Fulghume10cc1d2007-05-10 22:22:50 -07002803 if (retval != -ENOIOCTLCMD)
2804 return retval;
2805 }
2806
2807 ld = tty_ldisc_ref_wait(tty);
Alan Coxa352def2008-07-16 21:53:12 +01002808 if (ld->ops->compat_ioctl)
2809 retval = ld->ops->compat_ioctl(tty, file, cmd, arg);
Thomas Meyer8193c422011-10-05 23:13:13 +02002810 else
2811 retval = n_tty_compat_ioctl_helper(tty, file, cmd, arg);
Paul Fulghume10cc1d2007-05-10 22:22:50 -07002812 tty_ldisc_deref(ld);
2813
2814 return retval;
2815}
2816#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07002817
Al Viroc3c073f2012-08-21 22:32:06 -04002818static int this_tty(const void *t, struct file *file, unsigned fd)
2819{
2820 if (likely(file->f_op->read != tty_read))
2821 return 0;
2822 return file_tty(file) != t ? 0 : fd + 1;
2823}
2824
Linus Torvalds1da177e2005-04-16 15:20:36 -07002825/*
2826 * This implements the "Secure Attention Key" --- the idea is to
2827 * prevent trojan horses by killing all processes associated with this
2828 * tty when the user hits the "Secure Attention Key". Required for
2829 * super-paranoid applications --- see the Orange Book for more details.
Alan Cox37bdfb02008-02-08 04:18:47 -08002830 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07002831 * This code could be nicer; ideally it should send a HUP, wait a few
2832 * seconds, then send a INT, and then a KILL signal. But you then
2833 * have to coordinate with the init process, since all processes associated
2834 * with the current tty must be dead before the new getty is allowed
2835 * to spawn.
2836 *
2837 * Now, if it would be correct ;-/ The current code has a nasty hole -
2838 * it doesn't catch files in flight. We may send the descriptor to ourselves
2839 * via AF_UNIX socket, close it and later fetch from socket. FIXME.
2840 *
2841 * Nasty bug: do_SAK is being called in interrupt context. This can
2842 * deadlock. We punt it up to process context. AKPM - 16Mar2001
2843 */
Eric W. Biederman8b6312f2007-02-10 01:44:34 -08002844void __do_SAK(struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002845{
2846#ifdef TTY_SOFT_SAK
2847 tty_hangup(tty);
2848#else
Eric W. Biederman652486f2006-03-28 16:11:02 -08002849 struct task_struct *g, *p;
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08002850 struct pid *session;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002851 int i;
Alan Cox37bdfb02008-02-08 04:18:47 -08002852
Linus Torvalds1da177e2005-04-16 15:20:36 -07002853 if (!tty)
2854 return;
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002855 session = tty->session;
Alan Cox37bdfb02008-02-08 04:18:47 -08002856
Dan Carpenterb3f13de2006-12-13 00:35:09 -08002857 tty_ldisc_flush(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002858
Alan Coxf34d7a52008-04-30 00:54:13 -07002859 tty_driver_flush_buffer(tty);
Alan Cox37bdfb02008-02-08 04:18:47 -08002860
Linus Torvalds1da177e2005-04-16 15:20:36 -07002861 read_lock(&tasklist_lock);
Eric W. Biederman652486f2006-03-28 16:11:02 -08002862 /* Kill the entire session */
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08002863 do_each_pid_task(session, PIDTYPE_SID, p) {
Eric W. Biederman652486f2006-03-28 16:11:02 -08002864 printk(KERN_NOTICE "SAK: killed process %d"
Oleg Nesterov1b0f7ff2009-04-02 16:58:39 -07002865 " (%s): task_session(p)==tty->session\n",
Pavel Emelyanovba25f9d2007-10-18 23:40:40 -07002866 task_pid_nr(p), p->comm);
Eric W. Biederman652486f2006-03-28 16:11:02 -08002867 send_sig(SIGKILL, p, 1);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08002868 } while_each_pid_task(session, PIDTYPE_SID, p);
Eric W. Biederman652486f2006-03-28 16:11:02 -08002869 /* Now kill any processes that happen to have the
2870 * tty open.
2871 */
2872 do_each_thread(g, p) {
2873 if (p->signal->tty == tty) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002874 printk(KERN_NOTICE "SAK: killed process %d"
Oleg Nesterov1b0f7ff2009-04-02 16:58:39 -07002875 " (%s): task_session(p)==tty->session\n",
Pavel Emelyanovba25f9d2007-10-18 23:40:40 -07002876 task_pid_nr(p), p->comm);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002877 send_sig(SIGKILL, p, 1);
2878 continue;
2879 }
2880 task_lock(p);
Al Viroc3c073f2012-08-21 22:32:06 -04002881 i = iterate_fd(p->files, 0, this_tty, tty);
2882 if (i != 0) {
2883 printk(KERN_NOTICE "SAK: killed process %d"
2884 " (%s): fd#%d opened to the tty\n",
2885 task_pid_nr(p), p->comm, i - 1);
2886 force_sig(SIGKILL, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002887 }
2888 task_unlock(p);
Eric W. Biederman652486f2006-03-28 16:11:02 -08002889 } while_each_thread(g, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002890 read_unlock(&tasklist_lock);
2891#endif
2892}
2893
Eric W. Biederman8b6312f2007-02-10 01:44:34 -08002894static void do_SAK_work(struct work_struct *work)
2895{
2896 struct tty_struct *tty =
2897 container_of(work, struct tty_struct, SAK_work);
2898 __do_SAK(tty);
2899}
2900
Linus Torvalds1da177e2005-04-16 15:20:36 -07002901/*
2902 * The tq handling here is a little racy - tty->SAK_work may already be queued.
2903 * Fortunately we don't need to worry, because if ->SAK_work is already queued,
2904 * the values which we write to it will be identical to the values which it
2905 * already has. --akpm
2906 */
2907void do_SAK(struct tty_struct *tty)
2908{
2909 if (!tty)
2910 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002911 schedule_work(&tty->SAK_work);
2912}
2913
2914EXPORT_SYMBOL(do_SAK);
2915
Greg Kroah-Hartman6e9430a2013-02-06 15:59:18 -08002916static int dev_match_devt(struct device *dev, const void *data)
Dmitry Eremin-Solenikov30004ac2010-08-09 18:22:49 +04002917{
Greg Kroah-Hartman6e9430a2013-02-06 15:59:18 -08002918 const dev_t *devt = data;
Dmitry Eremin-Solenikov30004ac2010-08-09 18:22:49 +04002919 return dev->devt == *devt;
2920}
2921
2922/* Must put_device() after it's unused! */
2923static struct device *tty_get_device(struct tty_struct *tty)
2924{
2925 dev_t devt = tty_devnum(tty);
2926 return class_find_device(tty_class, NULL, &devt, dev_match_devt);
2927}
2928
2929
Alan Coxaf9b8972006-08-27 01:24:01 -07002930/**
Alan Coxaf9b8972006-08-27 01:24:01 -07002931 * initialize_tty_struct
2932 * @tty: tty to initialize
2933 *
2934 * This subroutine initializes a tty structure that has been newly
2935 * allocated.
2936 *
2937 * Locking: none - tty in question must not be exposed at this point
Linus Torvalds1da177e2005-04-16 15:20:36 -07002938 */
Alan Coxaf9b8972006-08-27 01:24:01 -07002939
Alan Coxbf970ee2008-10-13 10:42:39 +01002940void initialize_tty_struct(struct tty_struct *tty,
2941 struct tty_driver *driver, int idx)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002942{
2943 memset(tty, 0, sizeof(struct tty_struct));
Alan Cox9c9f4de2008-10-13 10:37:26 +01002944 kref_init(&tty->kref);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002945 tty->magic = TTY_MAGIC;
Alan Cox01e1abb2008-07-22 11:16:55 +01002946 tty_ldisc_init(tty);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08002947 tty->session = NULL;
2948 tty->pgrp = NULL;
Alan Cox89c8d912012-08-08 16:30:13 +01002949 mutex_init(&tty->legacy_mutex);
Arjan van de Ven5785c952006-09-29 02:00:43 -07002950 mutex_init(&tty->termios_mutex);
Alan Coxc65c9bc2009-06-11 12:50:12 +01002951 mutex_init(&tty->ldisc_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002952 init_waitqueue_head(&tty->write_wait);
2953 init_waitqueue_head(&tty->read_wait);
David Howells65f27f32006-11-22 14:55:48 +00002954 INIT_WORK(&tty->hangup_work, do_tty_hangup);
Ingo Molnar70522e12006-03-23 03:00:31 -08002955 mutex_init(&tty->atomic_write_lock);
Alan Cox04f378b2008-04-30 00:53:29 -07002956 spin_lock_init(&tty->ctrl_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002957 INIT_LIST_HEAD(&tty->tty_files);
Eric W. Biederman7f1f86a2007-02-13 14:38:58 -07002958 INIT_WORK(&tty->SAK_work, do_SAK_work);
Alan Coxbf970ee2008-10-13 10:42:39 +01002959
2960 tty->driver = driver;
2961 tty->ops = driver->ops;
2962 tty->index = idx;
2963 tty_line_name(driver, idx, tty->name);
Dmitry Eremin-Solenikov30004ac2010-08-09 18:22:49 +04002964 tty->dev = tty_get_device(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002965}
2966
Alan Coxf34d7a52008-04-30 00:54:13 -07002967/**
Jiri Slaby67166712011-03-23 10:48:35 +01002968 * deinitialize_tty_struct
2969 * @tty: tty to deinitialize
2970 *
2971 * This subroutine deinitializes a tty structure that has been newly
2972 * allocated but tty_release cannot be called on that yet.
2973 *
2974 * Locking: none - tty in question must not be exposed at this point
2975 */
2976void deinitialize_tty_struct(struct tty_struct *tty)
2977{
2978 tty_ldisc_deinit(tty);
2979}
2980
2981/**
Alan Coxf34d7a52008-04-30 00:54:13 -07002982 * tty_put_char - write one character to a tty
2983 * @tty: tty
2984 * @ch: character
2985 *
2986 * Write one byte to the tty using the provided put_char method
2987 * if present. Returns the number of characters successfully output.
2988 *
2989 * Note: the specific put_char operation in the driver layer may go
2990 * away soon. Don't call it directly, use this method
Linus Torvalds1da177e2005-04-16 15:20:36 -07002991 */
Alan Coxaf9b8972006-08-27 01:24:01 -07002992
Alan Coxf34d7a52008-04-30 00:54:13 -07002993int tty_put_char(struct tty_struct *tty, unsigned char ch)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002994{
Alan Coxf34d7a52008-04-30 00:54:13 -07002995 if (tty->ops->put_char)
2996 return tty->ops->put_char(tty, ch);
2997 return tty->ops->write(tty, &ch, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002998}
Alan Coxf34d7a52008-04-30 00:54:13 -07002999EXPORT_SYMBOL_GPL(tty_put_char);
3000
Alan Coxd81ed102008-10-13 10:41:42 +01003001struct class *tty_class;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003002
Jiri Slaby7e73eca2012-08-08 22:26:44 +02003003static int tty_cdev_add(struct tty_driver *driver, dev_t dev,
3004 unsigned int index, unsigned int count)
3005{
3006 /* init here, since reused cdevs cause crashes */
3007 cdev_init(&driver->cdevs[index], &tty_fops);
3008 driver->cdevs[index].owner = driver->owner;
3009 return cdev_add(&driver->cdevs[index], dev, count);
3010}
3011
Linus Torvalds1da177e2005-04-16 15:20:36 -07003012/**
Alan Coxaf9b8972006-08-27 01:24:01 -07003013 * tty_register_device - register a tty device
3014 * @driver: the tty driver that describes the tty device
3015 * @index: the index in the tty driver for this tty device
3016 * @device: a struct device that is associated with this tty device.
3017 * This field is optional, if there is no known struct device
3018 * for this tty device it can be set to NULL safely.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003019 *
Greg Kroah-Hartman01107d32006-08-07 22:19:37 -07003020 * Returns a pointer to the struct device for this tty device
3021 * (or ERR_PTR(-EFOO) on error).
Hansjoerg Lipp1cdcb6b2006-04-22 18:36:53 +02003022 *
Alan Coxaf9b8972006-08-27 01:24:01 -07003023 * This call is required to be made to register an individual tty device
3024 * if the tty driver's flags have the TTY_DRIVER_DYNAMIC_DEV bit set. If
3025 * that bit is not set, this function should not be called by a tty
3026 * driver.
3027 *
3028 * Locking: ??
Linus Torvalds1da177e2005-04-16 15:20:36 -07003029 */
Alan Coxaf9b8972006-08-27 01:24:01 -07003030
Greg Kroah-Hartman01107d32006-08-07 22:19:37 -07003031struct device *tty_register_device(struct tty_driver *driver, unsigned index,
3032 struct device *device)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003033{
Tomas Hlavacek6915c0e2012-09-06 03:17:18 +02003034 return tty_register_device_attr(driver, index, device, NULL, NULL);
3035}
3036EXPORT_SYMBOL(tty_register_device);
3037
Tomas Hlavacekb1b79912012-09-06 23:17:47 +02003038static void tty_device_create_release(struct device *dev)
3039{
3040 pr_debug("device: '%s': %s\n", dev_name(dev), __func__);
3041 kfree(dev);
3042}
3043
Tomas Hlavacek6915c0e2012-09-06 03:17:18 +02003044/**
3045 * tty_register_device_attr - register a tty device
3046 * @driver: the tty driver that describes the tty device
3047 * @index: the index in the tty driver for this tty device
3048 * @device: a struct device that is associated with this tty device.
3049 * This field is optional, if there is no known struct device
3050 * for this tty device it can be set to NULL safely.
3051 * @drvdata: Driver data to be set to device.
3052 * @attr_grp: Attribute group to be set on device.
3053 *
3054 * Returns a pointer to the struct device for this tty device
3055 * (or ERR_PTR(-EFOO) on error).
3056 *
3057 * This call is required to be made to register an individual tty device
3058 * if the tty driver's flags have the TTY_DRIVER_DYNAMIC_DEV bit set. If
3059 * that bit is not set, this function should not be called by a tty
3060 * driver.
3061 *
3062 * Locking: ??
3063 */
3064struct device *tty_register_device_attr(struct tty_driver *driver,
3065 unsigned index, struct device *device,
3066 void *drvdata,
3067 const struct attribute_group **attr_grp)
3068{
Linus Torvalds1da177e2005-04-16 15:20:36 -07003069 char name[64];
Tomas Hlavacek6915c0e2012-09-06 03:17:18 +02003070 dev_t devt = MKDEV(driver->major, driver->minor_start) + index;
3071 struct device *dev = NULL;
3072 int retval = -ENODEV;
Jiri Slaby7e73eca2012-08-08 22:26:44 +02003073 bool cdev = false;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003074
3075 if (index >= driver->num) {
3076 printk(KERN_ERR "Attempt to register invalid tty line number "
3077 " (%d).\n", index);
Hansjoerg Lipp1cdcb6b2006-04-22 18:36:53 +02003078 return ERR_PTR(-EINVAL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003079 }
3080
Linus Torvalds1da177e2005-04-16 15:20:36 -07003081 if (driver->type == TTY_DRIVER_TYPE_PTY)
3082 pty_line_name(driver, index, name);
3083 else
3084 tty_line_name(driver, index, name);
Hansjoerg Lipp1cdcb6b2006-04-22 18:36:53 +02003085
Jiri Slaby7e73eca2012-08-08 22:26:44 +02003086 if (!(driver->flags & TTY_DRIVER_DYNAMIC_ALLOC)) {
Tomas Hlavacek6915c0e2012-09-06 03:17:18 +02003087 retval = tty_cdev_add(driver, devt, index, 1);
3088 if (retval)
3089 goto error;
Jiri Slaby7e73eca2012-08-08 22:26:44 +02003090 cdev = true;
3091 }
3092
Tomas Hlavacek6915c0e2012-09-06 03:17:18 +02003093 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
3094 if (!dev) {
3095 retval = -ENOMEM;
3096 goto error;
3097 }
Jiri Slaby7e73eca2012-08-08 22:26:44 +02003098
Tomas Hlavacek6915c0e2012-09-06 03:17:18 +02003099 dev->devt = devt;
3100 dev->class = tty_class;
3101 dev->parent = device;
Tomas Hlavacekb1b79912012-09-06 23:17:47 +02003102 dev->release = tty_device_create_release;
Tomas Hlavacek6915c0e2012-09-06 03:17:18 +02003103 dev_set_name(dev, "%s", name);
3104 dev->groups = attr_grp;
3105 dev_set_drvdata(dev, drvdata);
3106
3107 retval = device_register(dev);
3108 if (retval)
3109 goto error;
3110
3111 return dev;
3112
3113error:
3114 put_device(dev);
3115 if (cdev)
3116 cdev_del(&driver->cdevs[index]);
3117 return ERR_PTR(retval);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003118}
Tomas Hlavacek6915c0e2012-09-06 03:17:18 +02003119EXPORT_SYMBOL_GPL(tty_register_device_attr);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003120
3121/**
Alan Coxaf9b8972006-08-27 01:24:01 -07003122 * tty_unregister_device - unregister a tty device
3123 * @driver: the tty driver that describes the tty device
3124 * @index: the index in the tty driver for this tty device
Linus Torvalds1da177e2005-04-16 15:20:36 -07003125 *
Alan Coxaf9b8972006-08-27 01:24:01 -07003126 * If a tty device is registered with a call to tty_register_device() then
3127 * this function must be called when the tty device is gone.
3128 *
3129 * Locking: ??
Linus Torvalds1da177e2005-04-16 15:20:36 -07003130 */
Alan Coxaf9b8972006-08-27 01:24:01 -07003131
Linus Torvalds1da177e2005-04-16 15:20:36 -07003132void tty_unregister_device(struct tty_driver *driver, unsigned index)
3133{
Alan Cox37bdfb02008-02-08 04:18:47 -08003134 device_destroy(tty_class,
3135 MKDEV(driver->major, driver->minor_start) + index);
Jiri Slaby7e73eca2012-08-08 22:26:44 +02003136 if (!(driver->flags & TTY_DRIVER_DYNAMIC_ALLOC))
3137 cdev_del(&driver->cdevs[index]);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003138}
Linus Torvalds1da177e2005-04-16 15:20:36 -07003139EXPORT_SYMBOL(tty_unregister_device);
3140
Jiri Slaby7f0bc6a2012-08-07 21:47:42 +02003141/**
3142 * __tty_alloc_driver -- allocate tty driver
3143 * @lines: count of lines this driver can handle at most
3144 * @owner: module which is repsonsible for this driver
3145 * @flags: some of TTY_DRIVER_* flags, will be set in driver->flags
3146 *
3147 * This should not be called directly, some of the provided macros should be
3148 * used instead. Use IS_ERR and friends on @retval.
3149 */
3150struct tty_driver *__tty_alloc_driver(unsigned int lines, struct module *owner,
3151 unsigned long flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003152{
3153 struct tty_driver *driver;
Jiri Slaby7e73eca2012-08-08 22:26:44 +02003154 unsigned int cdevs = 1;
Jiri Slaby16a02082012-08-08 22:26:42 +02003155 int err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003156
Jiri Slaby0019b402012-08-08 22:26:43 +02003157 if (!lines || (flags & TTY_DRIVER_UNNUMBERED_NODE && lines > 1))
Jiri Slaby7f0bc6a2012-08-07 21:47:42 +02003158 return ERR_PTR(-EINVAL);
3159
Jean Delvare506eb992007-07-15 23:40:14 -07003160 driver = kzalloc(sizeof(struct tty_driver), GFP_KERNEL);
Jiri Slaby7f0bc6a2012-08-07 21:47:42 +02003161 if (!driver)
3162 return ERR_PTR(-ENOMEM);
3163
3164 kref_init(&driver->kref);
3165 driver->magic = TTY_DRIVER_MAGIC;
3166 driver->num = lines;
3167 driver->owner = owner;
3168 driver->flags = flags;
Jiri Slaby16a02082012-08-08 22:26:42 +02003169
3170 if (!(flags & TTY_DRIVER_DEVPTS_MEM)) {
3171 driver->ttys = kcalloc(lines, sizeof(*driver->ttys),
3172 GFP_KERNEL);
3173 driver->termios = kcalloc(lines, sizeof(*driver->termios),
3174 GFP_KERNEL);
3175 if (!driver->ttys || !driver->termios) {
3176 err = -ENOMEM;
3177 goto err_free_all;
3178 }
3179 }
3180
3181 if (!(flags & TTY_DRIVER_DYNAMIC_ALLOC)) {
3182 driver->ports = kcalloc(lines, sizeof(*driver->ports),
3183 GFP_KERNEL);
3184 if (!driver->ports) {
3185 err = -ENOMEM;
3186 goto err_free_all;
3187 }
Jiri Slaby7e73eca2012-08-08 22:26:44 +02003188 cdevs = lines;
3189 }
3190
3191 driver->cdevs = kcalloc(cdevs, sizeof(*driver->cdevs), GFP_KERNEL);
3192 if (!driver->cdevs) {
3193 err = -ENOMEM;
3194 goto err_free_all;
Jiri Slaby16a02082012-08-08 22:26:42 +02003195 }
Jiri Slaby7f0bc6a2012-08-07 21:47:42 +02003196
Linus Torvalds1da177e2005-04-16 15:20:36 -07003197 return driver;
Jiri Slaby16a02082012-08-08 22:26:42 +02003198err_free_all:
3199 kfree(driver->ports);
3200 kfree(driver->ttys);
3201 kfree(driver->termios);
3202 kfree(driver);
3203 return ERR_PTR(err);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003204}
Jiri Slaby7f0bc6a2012-08-07 21:47:42 +02003205EXPORT_SYMBOL(__tty_alloc_driver);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003206
Alan Cox7d7b93c2008-10-13 10:42:09 +01003207static void destruct_tty_driver(struct kref *kref)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003208{
Alan Cox7d7b93c2008-10-13 10:42:09 +01003209 struct tty_driver *driver = container_of(kref, struct tty_driver, kref);
3210 int i;
3211 struct ktermios *tp;
Alan Cox7d7b93c2008-10-13 10:42:09 +01003212
3213 if (driver->flags & TTY_DRIVER_INSTALLED) {
3214 /*
3215 * Free the termios and termios_locked structures because
3216 * we don't want to get memory leaks when modular tty
3217 * drivers are removed from the kernel.
3218 */
3219 for (i = 0; i < driver->num; i++) {
3220 tp = driver->termios[i];
3221 if (tp) {
3222 driver->termios[i] = NULL;
3223 kfree(tp);
3224 }
Alan Cox7d7b93c2008-10-13 10:42:09 +01003225 if (!(driver->flags & TTY_DRIVER_DYNAMIC_DEV))
3226 tty_unregister_device(driver, i);
3227 }
Alan Cox7d7b93c2008-10-13 10:42:09 +01003228 proc_tty_unregister_driver(driver);
Jiri Slaby7e73eca2012-08-08 22:26:44 +02003229 if (driver->flags & TTY_DRIVER_DYNAMIC_ALLOC)
3230 cdev_del(&driver->cdevs[0]);
Alan Cox7d7b93c2008-10-13 10:42:09 +01003231 }
Jiri Slaby7e73eca2012-08-08 22:26:44 +02003232 kfree(driver->cdevs);
Jiri Slaby04831dc2012-06-04 13:35:36 +02003233 kfree(driver->ports);
Jiri Slaby16a02082012-08-08 22:26:42 +02003234 kfree(driver->termios);
3235 kfree(driver->ttys);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003236 kfree(driver);
3237}
3238
Alan Cox7d7b93c2008-10-13 10:42:09 +01003239void tty_driver_kref_put(struct tty_driver *driver)
3240{
3241 kref_put(&driver->kref, destruct_tty_driver);
3242}
3243EXPORT_SYMBOL(tty_driver_kref_put);
3244
Jeff Dikeb68e31d2006-10-02 02:17:18 -07003245void tty_set_operations(struct tty_driver *driver,
3246 const struct tty_operations *op)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003247{
Alan Coxf34d7a52008-04-30 00:54:13 -07003248 driver->ops = op;
3249};
Linus Torvalds1da177e2005-04-16 15:20:36 -07003250EXPORT_SYMBOL(tty_set_operations);
3251
Alan Cox7d7b93c2008-10-13 10:42:09 +01003252void put_tty_driver(struct tty_driver *d)
3253{
3254 tty_driver_kref_put(d);
3255}
3256EXPORT_SYMBOL(put_tty_driver);
3257
Linus Torvalds1da177e2005-04-16 15:20:36 -07003258/*
3259 * Called by a tty driver to register itself.
3260 */
3261int tty_register_driver(struct tty_driver *driver)
3262{
3263 int error;
Alan Cox37bdfb02008-02-08 04:18:47 -08003264 int i;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003265 dev_t dev;
Vasiliy Kulikovb670bde2010-09-05 22:32:22 +04003266 struct device *d;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003267
Linus Torvalds1da177e2005-04-16 15:20:36 -07003268 if (!driver->major) {
Alan Cox37bdfb02008-02-08 04:18:47 -08003269 error = alloc_chrdev_region(&dev, driver->minor_start,
3270 driver->num, driver->name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003271 if (!error) {
3272 driver->major = MAJOR(dev);
3273 driver->minor_start = MINOR(dev);
3274 }
3275 } else {
3276 dev = MKDEV(driver->major, driver->minor_start);
Geert Uytterhoevene5717c42007-02-20 15:45:21 +01003277 error = register_chrdev_region(dev, driver->num, driver->name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003278 }
Jiri Slaby9bb8a3d2012-06-04 13:35:35 +02003279 if (error < 0)
Jiri Slaby16a02082012-08-08 22:26:42 +02003280 goto err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003281
Jiri Slaby7e73eca2012-08-08 22:26:44 +02003282 if (driver->flags & TTY_DRIVER_DYNAMIC_ALLOC) {
3283 error = tty_cdev_add(driver, dev, 0, driver->num);
3284 if (error)
3285 goto err_unreg_char;
3286 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003287
Alexey Dobriyanca509f62007-05-08 00:27:12 -07003288 mutex_lock(&tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003289 list_add(&driver->tty_drivers, &tty_drivers);
Alexey Dobriyanca509f62007-05-08 00:27:12 -07003290 mutex_unlock(&tty_mutex);
Alan Cox37bdfb02008-02-08 04:18:47 -08003291
3292 if (!(driver->flags & TTY_DRIVER_DYNAMIC_DEV)) {
Vasiliy Kulikovb670bde2010-09-05 22:32:22 +04003293 for (i = 0; i < driver->num; i++) {
3294 d = tty_register_device(driver, i, NULL);
3295 if (IS_ERR(d)) {
3296 error = PTR_ERR(d);
Jiri Slaby16a02082012-08-08 22:26:42 +02003297 goto err_unreg_devs;
Vasiliy Kulikovb670bde2010-09-05 22:32:22 +04003298 }
3299 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003300 }
3301 proc_tty_register_driver(driver);
Alan Cox7d7b93c2008-10-13 10:42:09 +01003302 driver->flags |= TTY_DRIVER_INSTALLED;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003303 return 0;
Vasiliy Kulikovb670bde2010-09-05 22:32:22 +04003304
Jiri Slaby16a02082012-08-08 22:26:42 +02003305err_unreg_devs:
Vasiliy Kulikovb670bde2010-09-05 22:32:22 +04003306 for (i--; i >= 0; i--)
3307 tty_unregister_device(driver, i);
3308
3309 mutex_lock(&tty_mutex);
3310 list_del(&driver->tty_drivers);
3311 mutex_unlock(&tty_mutex);
3312
Jiri Slaby9bb8a3d2012-06-04 13:35:35 +02003313err_unreg_char:
Vasiliy Kulikovb670bde2010-09-05 22:32:22 +04003314 unregister_chrdev_region(dev, driver->num);
Jiri Slaby16a02082012-08-08 22:26:42 +02003315err:
Vasiliy Kulikovb670bde2010-09-05 22:32:22 +04003316 return error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003317}
Linus Torvalds1da177e2005-04-16 15:20:36 -07003318EXPORT_SYMBOL(tty_register_driver);
3319
3320/*
3321 * Called by a tty driver to unregister itself.
3322 */
3323int tty_unregister_driver(struct tty_driver *driver)
3324{
Alan Cox7d7b93c2008-10-13 10:42:09 +01003325#if 0
3326 /* FIXME */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003327 if (driver->refcount)
3328 return -EBUSY;
Alan Cox7d7b93c2008-10-13 10:42:09 +01003329#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07003330 unregister_chrdev_region(MKDEV(driver->major, driver->minor_start),
3331 driver->num);
Alexey Dobriyanca509f62007-05-08 00:27:12 -07003332 mutex_lock(&tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003333 list_del(&driver->tty_drivers);
Alexey Dobriyanca509f62007-05-08 00:27:12 -07003334 mutex_unlock(&tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003335 return 0;
3336}
Alan Cox7d7b93c2008-10-13 10:42:09 +01003337
Linus Torvalds1da177e2005-04-16 15:20:36 -07003338EXPORT_SYMBOL(tty_unregister_driver);
3339
Peter Zijlstra24ec8392006-12-08 02:36:04 -08003340dev_t tty_devnum(struct tty_struct *tty)
3341{
3342 return MKDEV(tty->driver->major, tty->driver->minor_start) + tty->index;
3343}
3344EXPORT_SYMBOL(tty_devnum);
3345
3346void proc_clear_tty(struct task_struct *p)
3347{
Arjan van de Ven7c3b1dc2008-10-15 10:52:34 +01003348 unsigned long flags;
Alan Cox9c9f4de2008-10-13 10:37:26 +01003349 struct tty_struct *tty;
Arjan van de Ven7c3b1dc2008-10-15 10:52:34 +01003350 spin_lock_irqsave(&p->sighand->siglock, flags);
Alan Cox9c9f4de2008-10-13 10:37:26 +01003351 tty = p->signal->tty;
Peter Zijlstra24ec8392006-12-08 02:36:04 -08003352 p->signal->tty = NULL;
Arjan van de Ven7c3b1dc2008-10-15 10:52:34 +01003353 spin_unlock_irqrestore(&p->sighand->siglock, flags);
Alan Cox9c9f4de2008-10-13 10:37:26 +01003354 tty_kref_put(tty);
Peter Zijlstra24ec8392006-12-08 02:36:04 -08003355}
Peter Zijlstra24ec8392006-12-08 02:36:04 -08003356
Alan Cox47f86832008-04-30 00:53:30 -07003357/* Called under the sighand lock */
3358
Eric W. Biederman2a65f1d2007-05-08 00:26:53 -07003359static void __proc_set_tty(struct task_struct *tsk, struct tty_struct *tty)
Peter Zijlstra24ec8392006-12-08 02:36:04 -08003360{
3361 if (tty) {
Alan Cox47f86832008-04-30 00:53:30 -07003362 unsigned long flags;
3363 /* We should not have a session or pgrp to put here but.... */
3364 spin_lock_irqsave(&tty->ctrl_lock, flags);
Eric W. Biedermand9c1e9a2007-03-18 12:45:44 -06003365 put_pid(tty->session);
3366 put_pid(tty->pgrp);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08003367 tty->pgrp = get_pid(task_pgrp(tsk));
Alan Cox47f86832008-04-30 00:53:30 -07003368 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
3369 tty->session = get_pid(task_session(tsk));
Alan Cox9c9f4de2008-10-13 10:37:26 +01003370 if (tsk->signal->tty) {
3371 printk(KERN_DEBUG "tty not NULL!!\n");
3372 tty_kref_put(tsk->signal->tty);
3373 }
Peter Zijlstra24ec8392006-12-08 02:36:04 -08003374 }
Eric W. Biederman2a65f1d2007-05-08 00:26:53 -07003375 put_pid(tsk->signal->tty_old_pgrp);
Alan Cox9c9f4de2008-10-13 10:37:26 +01003376 tsk->signal->tty = tty_kref_get(tty);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08003377 tsk->signal->tty_old_pgrp = NULL;
Peter Zijlstra24ec8392006-12-08 02:36:04 -08003378}
3379
Eric W. Biederman98a27ba2007-05-08 00:26:56 -07003380static void proc_set_tty(struct task_struct *tsk, struct tty_struct *tty)
Peter Zijlstra24ec8392006-12-08 02:36:04 -08003381{
3382 spin_lock_irq(&tsk->sighand->siglock);
Eric W. Biederman2a65f1d2007-05-08 00:26:53 -07003383 __proc_set_tty(tsk, tty);
Peter Zijlstra24ec8392006-12-08 02:36:04 -08003384 spin_unlock_irq(&tsk->sighand->siglock);
3385}
3386
3387struct tty_struct *get_current_tty(void)
3388{
3389 struct tty_struct *tty;
Alan Cox934e6eb2008-10-13 10:40:43 +01003390 unsigned long flags;
3391
3392 spin_lock_irqsave(&current->sighand->siglock, flags);
Alan Cox452a00d2008-10-13 10:39:13 +01003393 tty = tty_kref_get(current->signal->tty);
Alan Cox934e6eb2008-10-13 10:40:43 +01003394 spin_unlock_irqrestore(&current->sighand->siglock, flags);
Peter Zijlstra24ec8392006-12-08 02:36:04 -08003395 return tty;
3396}
Heiko Carstensa311f742006-12-13 00:33:41 -08003397EXPORT_SYMBOL_GPL(get_current_tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003398
Alan Coxd81ed102008-10-13 10:41:42 +01003399void tty_default_fops(struct file_operations *fops)
3400{
3401 *fops = tty_fops;
3402}
3403
Linus Torvalds1da177e2005-04-16 15:20:36 -07003404/*
3405 * Initialize the console device. This is called *early*, so
3406 * we can't necessarily depend on lots of kernel help here.
3407 * Just do some early initializations, and do the complex setup
3408 * later.
3409 */
3410void __init console_init(void)
3411{
3412 initcall_t *call;
3413
3414 /* Setup the default TTY line discipline. */
Alan Cox01e1abb2008-07-22 11:16:55 +01003415 tty_ldisc_begin();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003416
3417 /*
Alan Cox37bdfb02008-02-08 04:18:47 -08003418 * set up the console device so that later boot sequences can
Linus Torvalds1da177e2005-04-16 15:20:36 -07003419 * inform about problems etc..
3420 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003421 call = __con_initcall_start;
3422 while (call < __con_initcall_end) {
3423 (*call)();
3424 call++;
3425 }
3426}
3427
Al Viro2c9ede52011-07-23 20:24:48 -04003428static char *tty_devnode(struct device *dev, umode_t *mode)
Kay Sieverse454cea2009-09-18 23:01:12 +02003429{
3430 if (!mode)
3431 return NULL;
3432 if (dev->devt == MKDEV(TTYAUX_MAJOR, 0) ||
3433 dev->devt == MKDEV(TTYAUX_MAJOR, 2))
3434 *mode = 0666;
3435 return NULL;
3436}
3437
Linus Torvalds1da177e2005-04-16 15:20:36 -07003438static int __init tty_class_init(void)
3439{
gregkh@suse.de7fe845d2005-03-15 14:23:15 -08003440 tty_class = class_create(THIS_MODULE, "tty");
Linus Torvalds1da177e2005-04-16 15:20:36 -07003441 if (IS_ERR(tty_class))
3442 return PTR_ERR(tty_class);
Kay Sieverse454cea2009-09-18 23:01:12 +02003443 tty_class->devnode = tty_devnode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003444 return 0;
3445}
3446
3447postcore_initcall(tty_class_init);
3448
3449/* 3/2004 jmc: why do these devices exist? */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003450static struct cdev tty_cdev, console_cdev;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003451
Kay Sieversfbc92a32010-12-01 18:51:05 +01003452static ssize_t show_cons_active(struct device *dev,
3453 struct device_attribute *attr, char *buf)
3454{
3455 struct console *cs[16];
3456 int i = 0;
3457 struct console *c;
3458 ssize_t count = 0;
3459
Torben Hohnac751ef2011-01-25 15:07:35 -08003460 console_lock();
Kay Sieversa2a6a822011-01-09 16:39:14 +01003461 for_each_console(c) {
Kay Sieversfbc92a32010-12-01 18:51:05 +01003462 if (!c->device)
3463 continue;
3464 if (!c->write)
3465 continue;
3466 if ((c->flags & CON_ENABLED) == 0)
3467 continue;
3468 cs[i++] = c;
3469 if (i >= ARRAY_SIZE(cs))
3470 break;
3471 }
3472 while (i--)
3473 count += sprintf(buf + count, "%s%d%c",
3474 cs[i]->name, cs[i]->index, i ? ' ':'\n');
Torben Hohnac751ef2011-01-25 15:07:35 -08003475 console_unlock();
Kay Sieversfbc92a32010-12-01 18:51:05 +01003476
3477 return count;
3478}
3479static DEVICE_ATTR(active, S_IRUGO, show_cons_active, NULL);
3480
3481static struct device *consdev;
3482
3483void console_sysfs_notify(void)
3484{
3485 if (consdev)
3486 sysfs_notify(&consdev->kobj, NULL, "active");
3487}
3488
Linus Torvalds1da177e2005-04-16 15:20:36 -07003489/*
3490 * Ok, now we can initialize the rest of the tty devices and can count
3491 * on memory allocations, interrupts etc..
3492 */
David Howells31d1d482010-08-06 16:34:43 +01003493int __init tty_init(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003494{
3495 cdev_init(&tty_cdev, &tty_fops);
3496 if (cdev_add(&tty_cdev, MKDEV(TTYAUX_MAJOR, 0), 1) ||
3497 register_chrdev_region(MKDEV(TTYAUX_MAJOR, 0), 1, "/dev/tty") < 0)
3498 panic("Couldn't register /dev/tty driver\n");
Kay Sieversfbc92a32010-12-01 18:51:05 +01003499 device_create(tty_class, NULL, MKDEV(TTYAUX_MAJOR, 0), NULL, "tty");
Linus Torvalds1da177e2005-04-16 15:20:36 -07003500
3501 cdev_init(&console_cdev, &console_fops);
3502 if (cdev_add(&console_cdev, MKDEV(TTYAUX_MAJOR, 1), 1) ||
3503 register_chrdev_region(MKDEV(TTYAUX_MAJOR, 1), 1, "/dev/console") < 0)
3504 panic("Couldn't register /dev/console driver\n");
Kay Sieversfbc92a32010-12-01 18:51:05 +01003505 consdev = device_create(tty_class, NULL, MKDEV(TTYAUX_MAJOR, 1), NULL,
Greg Kroah-Hartman47aa5792008-05-21 12:52:33 -07003506 "console");
Kay Sieversfbc92a32010-12-01 18:51:05 +01003507 if (IS_ERR(consdev))
3508 consdev = NULL;
3509 else
Kay Sieversa2a6a822011-01-09 16:39:14 +01003510 WARN_ON(device_create_file(consdev, &dev_attr_active) < 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003511
Linus Torvalds1da177e2005-04-16 15:20:36 -07003512#ifdef CONFIG_VT
Alan Coxd81ed102008-10-13 10:41:42 +01003513 vty_init(&console_fops);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003514#endif
3515 return 0;
3516}
David Howells31d1d482010-08-06 16:34:43 +01003517