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