1 // SPDX-License-Identifier: GPL-2.0 2 /* 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 21 * makes for cleaner and more compact code. -TYT, 9/17/92 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 43 * 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 * 51 * Rewrote tty_init_dev and tty_release_dev to eliminate races. 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. 64 * alloc_tty_struct() always uses kmalloc() 65 * -- Andrew Morton <andrewm@uow.edu.eu> 17Mar01 66 */ 67 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> 73 #include <linux/sched/signal.h> 74 #include <linux/sched/task.h> 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> 81 #include <linux/fdtable.h> 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> 90 #include <linux/ppp-ioctl.h> 91 #include <linux/proc_fs.h> 92 #include <linux/init.h> 93 #include <linux/module.h> 94 #include <linux/device.h> 95 #include <linux/wait.h> 96 #include <linux/bitops.h> 97 #include <linux/delay.h> 98 #include <linux/seq_file.h> 99 #include <linux/serial.h> 100 #include <linux/ratelimit.h> 101 #include <linux/compat.h> 102 103 #include <linux/uaccess.h> 104 105 #include <linux/kbd_kern.h> 106 #include <linux/vt_kern.h> 107 #include <linux/selection.h> 108 109 #include <linux/kmod.h> 110 #include <linux/nsproxy.h> 111 112 #undef TTY_DEBUG_HANGUP 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 118 119 #define TTY_PARANOIA_CHECK 1 120 #define CHECK_TTY_COUNT 1 121 122 struct ktermios tty_std_termios = { /* for the benefit of tty drivers */ 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, 128 .c_cc = INIT_C_CC, 129 .c_ispeed = 38400, 130 .c_ospeed = 38400, 131 /* .c_line = N_TTY, */ 132 }; 133 134 EXPORT_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 */ 139 140 LIST_HEAD(tty_drivers); /* linked list of tty drivers */ 141 142 /* Mutex to protect creating and releasing a tty */ 143 DEFINE_MUTEX(tty_mutex); 144 145 static ssize_t tty_read(struct file *, char __user *, size_t, loff_t *); 146 static ssize_t tty_write(struct file *, const char __user *, size_t, loff_t *); 147 ssize_t redirected_tty_write(struct file *, const char __user *, 148 size_t, loff_t *); 149 static __poll_t tty_poll(struct file *, poll_table *); 150 static int tty_open(struct inode *, struct file *); 151 long tty_ioctl(struct file *file, unsigned int cmd, unsigned long arg); 152 #ifdef CONFIG_COMPAT 153 static long tty_compat_ioctl(struct file *file, unsigned int cmd, 154 unsigned long arg); 155 #else 156 #define tty_compat_ioctl NULL 157 #endif 158 static int __tty_fasync(int fd, struct file *filp, int on); 159 static int tty_fasync(int fd, struct file *filp, int on); 160 static void release_tty(struct tty_struct *tty, int idx); 161 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 171 static void free_tty_struct(struct tty_struct *tty) 172 { 173 tty_ldisc_deinit(tty); 174 put_device(tty->dev); 175 kfree(tty->write_buf); 176 tty->magic = 0xDEADDEAD; 177 kfree(tty); 178 } 179 180 static inline struct tty_struct *file_tty(struct file *file) 181 { 182 return ((struct tty_file_private *)file->private_data)->tty; 183 } 184 185 int tty_alloc_file(struct file *file) 186 { 187 struct tty_file_private *priv; 188 189 priv = kmalloc(sizeof(*priv), GFP_KERNEL); 190 if (!priv) 191 return -ENOMEM; 192 193 file->private_data = priv; 194 195 return 0; 196 } 197 198 /* Associate a new file with the tty structure */ 199 void tty_add_file(struct tty_struct *tty, struct file *file) 200 { 201 struct tty_file_private *priv = file->private_data; 202 203 priv->tty = tty; 204 priv->file = file; 205 206 spin_lock(&tty->files_lock); 207 list_add(&priv->list, &tty->tty_files); 208 spin_unlock(&tty->files_lock); 209 } 210 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 */ 217 void 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); 223 } 224 225 /* Delete file from its tty */ 226 static void tty_del_file(struct file *file) 227 { 228 struct tty_file_private *priv = file->private_data; 229 struct tty_struct *tty = priv->tty; 230 231 spin_lock(&tty->files_lock); 232 list_del(&priv->list); 233 spin_unlock(&tty->files_lock); 234 tty_free_file(file); 235 } 236 237 /** 238 * tty_name - return tty naming 239 * @tty: tty structure 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 247 const char *tty_name(const struct tty_struct *tty) 248 { 249 if (!tty) /* Hmm. NULL pointer. That's fun. */ 250 return "NULL tty"; 251 return tty->name; 252 } 253 254 EXPORT_SYMBOL(tty_name); 255 256 const char *tty_driver_name(const struct tty_struct *tty) 257 { 258 if (!tty || !tty->driver) 259 return ""; 260 return tty->driver->name; 261 } 262 263 static int tty_paranoia_check(struct tty_struct *tty, struct inode *inode, 264 const char *routine) 265 { 266 #ifdef TTY_PARANOIA_CHECK 267 if (!tty) { 268 pr_warn("(%d:%d): %s: NULL tty\n", 269 imajor(inode), iminor(inode), routine); 270 return 1; 271 } 272 if (tty->magic != TTY_MAGIC) { 273 pr_warn("(%d:%d): %s: bad magic number\n", 274 imajor(inode), iminor(inode), routine); 275 return 1; 276 } 277 #endif 278 return 0; 279 } 280 281 /* Caller must hold tty_lock */ 282 static int check_tty_count(struct tty_struct *tty, const char *routine) 283 { 284 #ifdef CHECK_TTY_COUNT 285 struct list_head *p; 286 int count = 0, kopen_count = 0; 287 288 spin_lock(&tty->files_lock); 289 list_for_each(p, &tty->tty_files) { 290 count++; 291 } 292 spin_unlock(&tty->files_lock); 293 if (tty->driver->type == TTY_DRIVER_TYPE_PTY && 294 tty->driver->subtype == PTY_TYPE_SLAVE && 295 tty->link && tty->link->count) 296 count++; 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); 303 } 304 #endif 305 return 0; 306 } 307 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 317 */ 318 319 static 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; 328 return tty_driver_kref_get(p); 329 } 330 return NULL; 331 } 332 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 */ 346 int 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; 377 out: 378 mutex_unlock(&tty_mutex); 379 return ret; 380 } 381 EXPORT_SYMBOL_GPL(tty_dev_name_to_number); 382 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 */ 394 struct tty_driver *tty_find_polling_driver(char *name, int *line) 395 { 396 struct tty_driver *p, *res = NULL; 397 int tty_line = 0; 398 int len; 399 char *str, *stp; 400 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 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) { 413 if (!len || strncmp(name, p->name, len) != 0) 414 continue; 415 stp = str; 416 if (*stp == ',') 417 stp++; 418 if (*stp == '\0') 419 stp = NULL; 420 421 if (tty_line >= 0 && tty_line < p->num && p->ops && 422 p->ops->poll_init && !p->ops->poll_init(p, tty_line, stp)) { 423 res = tty_driver_kref_get(p); 424 *line = tty_line; 425 break; 426 } 427 } 428 mutex_unlock(&tty_mutex); 429 430 return res; 431 } 432 EXPORT_SYMBOL_GPL(tty_find_polling_driver); 433 #endif 434 435 static ssize_t hung_up_tty_read(struct file *file, char __user *buf, 436 size_t count, loff_t *ppos) 437 { 438 return 0; 439 } 440 441 static ssize_t hung_up_tty_write(struct file *file, const char __user *buf, 442 size_t count, loff_t *ppos) 443 { 444 return -EIO; 445 } 446 447 /* No kernel lock held - none needed ;) */ 448 static __poll_t hung_up_tty_poll(struct file *filp, poll_table *wait) 449 { 450 return EPOLLIN | EPOLLOUT | EPOLLERR | EPOLLHUP | EPOLLRDNORM | EPOLLWRNORM; 451 } 452 453 static long hung_up_tty_ioctl(struct file *file, unsigned int cmd, 454 unsigned long arg) 455 { 456 return cmd == TIOCSPGRP ? -ENOTTY : -EIO; 457 } 458 459 static long hung_up_tty_compat_ioctl(struct file *file, 460 unsigned int cmd, unsigned long arg) 461 { 462 return cmd == TIOCSPGRP ? -ENOTTY : -EIO; 463 } 464 465 static int hung_up_tty_fasync(int fd, struct file *file, int on) 466 { 467 return -ENOTTY; 468 } 469 470 static 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 478 static const struct file_operations tty_fops = { 479 .llseek = no_llseek, 480 .read = tty_read, 481 .write = tty_write, 482 .poll = tty_poll, 483 .unlocked_ioctl = tty_ioctl, 484 .compat_ioctl = tty_compat_ioctl, 485 .open = tty_open, 486 .release = tty_release, 487 .fasync = tty_fasync, 488 .show_fdinfo = tty_show_fdinfo, 489 }; 490 491 static const struct file_operations console_fops = { 492 .llseek = no_llseek, 493 .read = tty_read, 494 .write = redirected_tty_write, 495 .poll = tty_poll, 496 .unlocked_ioctl = tty_ioctl, 497 .compat_ioctl = tty_compat_ioctl, 498 .open = tty_open, 499 .release = tty_release, 500 .fasync = tty_fasync, 501 }; 502 503 static const struct file_operations hung_up_tty_fops = { 504 .llseek = no_llseek, 505 .read = hung_up_tty_read, 506 .write = hung_up_tty_write, 507 .poll = hung_up_tty_poll, 508 .unlocked_ioctl = hung_up_tty_ioctl, 509 .compat_ioctl = hung_up_tty_compat_ioctl, 510 .release = tty_release, 511 .fasync = hung_up_tty_fasync, 512 }; 513 514 static DEFINE_SPINLOCK(redirect_lock); 515 static struct file *redirect; 516 517 extern void tty_sysctl_init(void); 518 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 */ 527 528 void tty_wakeup(struct tty_struct *tty) 529 { 530 struct tty_ldisc *ld; 531 532 if (test_bit(TTY_DO_WRITE_WAKEUP, &tty->flags)) { 533 ld = tty_ldisc_ref(tty); 534 if (ld) { 535 if (ld->ops->write_wakeup) 536 ld->ops->write_wakeup(tty); 537 tty_ldisc_deref(ld); 538 } 539 } 540 wake_up_interruptible_poll(&tty->write_wait, EPOLLOUT); 541 } 542 543 EXPORT_SYMBOL_GPL(tty_wakeup); 544 545 /** 546 * __tty_hangup - actual handler for hangup events 547 * @work: tty device 548 * 549 * This can be called by a "kworker" kernel thread. That is process 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: 559 * BTM 560 * redirect lock for undoing redirection 561 * file list lock for manipulating list of ttys 562 * tty_ldiscs_lock from called functions 563 * termios_rwsem resetting termios data 564 * tasklist_lock to walk task list for hangup event 565 * ->siglock to protect ->signal/->sighand 566 */ 567 static void __tty_hangup(struct tty_struct *tty, int exit_session) 568 { 569 struct file *cons_filp = NULL; 570 struct file *filp, *f = NULL; 571 struct tty_file_private *priv; 572 int closecount = 0, n; 573 int refs; 574 575 if (!tty) 576 return; 577 578 579 spin_lock(&redirect_lock); 580 if (redirect && file_tty(redirect) == tty) { 581 f = redirect; 582 redirect = NULL; 583 } 584 spin_unlock(&redirect_lock); 585 586 tty_lock(tty); 587 588 if (test_bit(TTY_HUPPED, &tty->flags)) { 589 tty_unlock(tty); 590 return; 591 } 592 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 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 */ 604 check_tty_count(tty, "tty_hangup"); 605 606 spin_lock(&tty->files_lock); 607 /* This breaks for file handles being sent over AF_UNIX sockets ? */ 608 list_for_each_entry(priv, &tty->tty_files, list) { 609 filp = priv->file; 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++; 615 __tty_fasync(-1, filp, 0); /* can't block */ 616 filp->f_op = &hung_up_tty_fops; 617 } 618 spin_unlock(&tty->files_lock); 619 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 625 tty_ldisc_hangup(tty, cons_filp != NULL); 626 627 spin_lock_irq(&tty->ctrl_lock); 628 clear_bit(TTY_THROTTLED, &tty->flags); 629 clear_bit(TTY_DO_WRITE_WAKEUP, &tty->flags); 630 put_pid(tty->session); 631 put_pid(tty->pgrp); 632 tty->session = NULL; 633 tty->pgrp = NULL; 634 tty->ctrl_status = 0; 635 spin_unlock_irq(&tty->ctrl_lock); 636 637 /* 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. 642 */ 643 if (cons_filp) { 644 if (tty->ops->close) 645 for (n = 0; n < closecount; n++) 646 tty->ops->close(tty, cons_filp); 647 } else if (tty->ops->hangup) 648 tty->ops->hangup(tty); 649 /* 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. 653 */ 654 set_bit(TTY_HUPPED, &tty->flags); 655 clear_bit(TTY_HUPPING, &tty->flags); 656 tty_unlock(tty); 657 658 if (f) 659 fput(f); 660 } 661 662 static void do_tty_hangup(struct work_struct *work) 663 { 664 struct tty_struct *tty = 665 container_of(work, struct tty_struct, hangup_work); 666 667 __tty_hangup(tty, 0); 668 } 669 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 678 void tty_hangup(struct tty_struct *tty) 679 { 680 tty_debug_hangup(tty, "hangup\n"); 681 schedule_work(&tty->hangup_work); 682 } 683 684 EXPORT_SYMBOL(tty_hangup); 685 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 692 * is complete. That guarantee is necessary for security reasons. 693 */ 694 695 void tty_vhangup(struct tty_struct *tty) 696 { 697 tty_debug_hangup(tty, "vhangup\n"); 698 __tty_hangup(tty, 0); 699 } 700 701 EXPORT_SYMBOL(tty_vhangup); 702 703 704 /** 705 * tty_vhangup_self - process vhangup for own ctty 706 * 707 * Perform a vhangup on the current controlling tty 708 */ 709 710 void tty_vhangup_self(void) 711 { 712 struct tty_struct *tty; 713 714 tty = get_current_tty(); 715 if (tty) { 716 tty_vhangup(tty); 717 tty_kref_put(tty); 718 } 719 } 720 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 732 void tty_vhangup_session(struct tty_struct *tty) 733 { 734 tty_debug_hangup(tty, "session hangup\n"); 735 __tty_hangup(tty, 1); 736 } 737 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 746 int tty_hung_up_p(struct file *filp) 747 { 748 return (filp && filp->f_op == &hung_up_tty_fops); 749 } 750 751 EXPORT_SYMBOL(tty_hung_up_p); 752 753 /** 754 * stop_tty - propagate flow control 755 * @tty: tty to stop 756 * 757 * Perform flow control to the driver. May be called 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: 767 * flow_lock 768 */ 769 770 void __stop_tty(struct tty_struct *tty) 771 { 772 if (tty->stopped) 773 return; 774 tty->stopped = 1; 775 if (tty->ops->stop) 776 tty->ops->stop(tty); 777 } 778 779 void 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 } 787 EXPORT_SYMBOL(stop_tty); 788 789 /** 790 * start_tty - propagate flow control 791 * @tty: tty to start 792 * 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. 796 * 797 * Locking: 798 * flow_lock 799 */ 800 801 void __start_tty(struct tty_struct *tty) 802 { 803 if (!tty->stopped || tty->flow_stopped) 804 return; 805 tty->stopped = 0; 806 if (tty->ops->start) 807 tty->ops->start(tty); 808 tty_wakeup(tty); 809 } 810 811 void 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 } 819 EXPORT_SYMBOL(start_tty); 820 821 static void tty_update_time(struct timespec64 *time) 822 { 823 time64_t sec = ktime_get_real_seconds(); 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) 832 time->tv_sec = sec; 833 } 834 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: 846 * Locks the line discipline internally while needed. Multiple 847 * read calls may be outstanding in parallel. 848 */ 849 850 static ssize_t tty_read(struct file *file, char __user *buf, size_t count, 851 loff_t *ppos) 852 { 853 int i; 854 struct inode *inode = file_inode(file); 855 struct tty_struct *tty = file_tty(file); 856 struct tty_ldisc *ld; 857 858 if (tty_paranoia_check(tty, inode, "tty_read")) 859 return -EIO; 860 if (!tty || tty_io_error(tty)) 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); 866 if (!ld) 867 return hung_up_tty_read(file, buf, count, ppos); 868 if (ld->ops->read) 869 i = ld->ops->read(tty, file, buf, count); 870 else 871 i = -EIO; 872 tty_ldisc_deref(ld); 873 874 if (i > 0) 875 tty_update_time(&inode->i_atime); 876 877 return i; 878 } 879 880 static void tty_write_unlock(struct tty_struct *tty) 881 { 882 mutex_unlock(&tty->atomic_write_lock); 883 wake_up_interruptible_poll(&tty->write_wait, EPOLLOUT); 884 } 885 886 static int tty_write_lock(struct tty_struct *tty, int ndelay) 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 897 /* 898 * Split writes up in sane blocksizes to avoid 899 * denial-of-service type attacks 900 */ 901 static 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 { 908 ssize_t ret, written = 0; 909 unsigned int chunk; 910 911 ret = tty_write_lock(tty, file->f_flags & O_NDELAY); 912 if (ret < 0) 913 return ret; 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. 927 * 928 * FIXME: This can probably go away now except that 64K chunks 929 * are too likely to fail unless switched to vmalloc... 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 937 /* write_buf/write_cnt is protected by the atomic_write_lock mutex */ 938 if (tty->write_cnt < chunk) { 939 unsigned char *buf_chunk; 940 941 if (chunk < 1024) 942 chunk = 1024; 943 944 buf_chunk = kmalloc(chunk, GFP_KERNEL); 945 if (!buf_chunk) { 946 ret = -ENOMEM; 947 goto out; 948 } 949 kfree(tty->write_buf); 950 tty->write_cnt = chunk; 951 tty->write_buf = buf_chunk; 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; 962 ret = write(tty, file, tty->write_buf, size); 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 } 975 if (written) { 976 tty_update_time(&file_inode(file)->i_mtime); 977 ret = written; 978 } 979 out: 980 tty_write_unlock(tty); 981 return ret; 982 } 983 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 * 993 * We must still hold the BTM and test the CLOSING flag for the moment. 994 */ 995 996 void tty_write_message(struct tty_struct *tty, char *msg) 997 { 998 if (tty) { 999 mutex_lock(&tty->atomic_write_lock); 1000 tty_lock(tty); 1001 if (tty->ops->write && tty->count > 0) 1002 tty->ops->write(tty, msg, strlen(msg)); 1003 tty_unlock(tty); 1004 tty_write_unlock(tty); 1005 } 1006 return; 1007 } 1008 1009 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 1023 * write method will not be invoked in parallel for each device. 1024 */ 1025 1026 static ssize_t tty_write(struct file *file, const char __user *buf, 1027 size_t count, loff_t *ppos) 1028 { 1029 struct tty_struct *tty = file_tty(file); 1030 struct tty_ldisc *ld; 1031 ssize_t ret; 1032 1033 if (tty_paranoia_check(tty, file_inode(file), "tty_write")) 1034 return -EIO; 1035 if (!tty || !tty->ops->write || tty_io_error(tty)) 1036 return -EIO; 1037 /* Short term debug to catch buggy drivers */ 1038 if (tty->ops->write_room == NULL) 1039 tty_err(tty, "missing write_room method\n"); 1040 ld = tty_ldisc_ref_wait(tty); 1041 if (!ld) 1042 return hung_up_tty_write(file, buf, count, ppos); 1043 if (!ld->ops->write) 1044 ret = -EIO; 1045 else 1046 ret = do_tty_write(ld->ops->write, tty, file, buf, count); 1047 tty_ldisc_deref(ld); 1048 return ret; 1049 } 1050 1051 ssize_t redirected_tty_write(struct file *file, const char __user *buf, 1052 size_t count, loff_t *ppos) 1053 { 1054 struct file *p = NULL; 1055 1056 spin_lock(&redirect_lock); 1057 if (redirect) 1058 p = get_file(redirect); 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 } 1067 return tty_write(file, buf, count, ppos); 1068 } 1069 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 1078 int tty_send_xchar(struct tty_struct *tty, char ch) 1079 { 1080 int was_stopped = tty->stopped; 1081 1082 if (tty->ops->send_xchar) { 1083 down_read(&tty->termios_rwsem); 1084 tty->ops->send_xchar(tty, ch); 1085 up_read(&tty->termios_rwsem); 1086 return 0; 1087 } 1088 1089 if (tty_write_lock(tty, 0) < 0) 1090 return -ERESTARTSYS; 1091 1092 down_read(&tty->termios_rwsem); 1093 if (was_stopped) 1094 start_tty(tty); 1095 tty->ops->write(tty, &ch, 1); 1096 if (was_stopped) 1097 stop_tty(tty); 1098 up_read(&tty->termios_rwsem); 1099 tty_write_unlock(tty); 1100 return 0; 1101 } 1102 1103 static char ptychar[] = "pqrstuvwxyzabcde"; 1104 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 */ 1116 static void pty_line_name(struct tty_driver *driver, int index, char *p) 1117 { 1118 int i = index + driver->name_base; 1119 /* ->name is initialized to "ttyp", but "tty" is expected */ 1120 sprintf(p, "%s%c%x", 1121 driver->subtype == PTY_TYPE_SLAVE ? "tty" : driver->name, 1122 ptychar[i >> 4 & 0xf], i & 0xf); 1123 } 1124 1125 /** 1126 * tty_line_name - generate name for a tty 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 1132 * buffer. 1133 * 1134 * Locking: None 1135 */ 1136 static ssize_t tty_line_name(struct tty_driver *driver, int index, char *p) 1137 { 1138 if (driver->flags & TTY_DRIVER_UNNUMBERED_NODE) 1139 return sprintf(p, "%s", driver->name); 1140 else 1141 return sprintf(p, "%s%d", driver->name, 1142 index + driver->name_base); 1143 } 1144 1145 /** 1146 * tty_driver_lookup_tty() - find an existing tty, if any 1147 * @driver: the driver for the tty 1148 * @idx: the minor number 1149 * 1150 * Return the tty, if found. If not found, return NULL or ERR_PTR() if the 1151 * driver lookup() method returns an error. 1152 * 1153 * Locking: tty_mutex must be held. If the tty is found, bump the tty kref. 1154 */ 1155 static struct tty_struct *tty_driver_lookup_tty(struct tty_driver *driver, 1156 struct file *file, int idx) 1157 { 1158 struct tty_struct *tty; 1159 1160 if (driver->ops->lookup) 1161 if (!file) 1162 tty = ERR_PTR(-EIO); 1163 else 1164 tty = driver->ops->lookup(driver, file, idx); 1165 else 1166 tty = driver->ttys[idx]; 1167 1168 if (!IS_ERR(tty)) 1169 tty_kref_get(tty); 1170 return tty; 1171 } 1172 1173 /** 1174 * tty_init_termios - helper for termios setup 1175 * @tty: the tty to set up 1176 * 1177 * Initialise the termios structure for this tty. This runs under 1178 * the tty_mutex currently so we can be relaxed about ordering. 1179 */ 1180 1181 void tty_init_termios(struct tty_struct *tty) 1182 { 1183 struct ktermios *tp; 1184 int idx = tty->index; 1185 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]; 1191 if (tp != NULL) { 1192 tty->termios = *tp; 1193 tty->termios.c_line = tty->driver->init_termios.c_line; 1194 } else 1195 tty->termios = tty->driver->init_termios; 1196 } 1197 /* Compatibility until drivers always set this */ 1198 tty->termios.c_ispeed = tty_termios_input_baud_rate(&tty->termios); 1199 tty->termios.c_ospeed = tty_termios_baud_rate(&tty->termios); 1200 } 1201 EXPORT_SYMBOL_GPL(tty_init_termios); 1202 1203 int tty_standard_install(struct tty_driver *driver, struct tty_struct *tty) 1204 { 1205 tty_init_termios(tty); 1206 tty_driver_kref_get(driver); 1207 tty->count++; 1208 driver->ttys[tty->index] = tty; 1209 return 0; 1210 } 1211 EXPORT_SYMBOL_GPL(tty_standard_install); 1212 1213 /** 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 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. 1222 * 1223 * Locking: tty_mutex for now 1224 */ 1225 static int tty_driver_install_tty(struct tty_driver *driver, 1226 struct tty_struct *tty) 1227 { 1228 return driver->ops->install ? driver->ops->install(driver, tty) : 1229 tty_standard_install(driver, tty); 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 */ 1242 static void tty_driver_remove_tty(struct tty_driver *driver, struct tty_struct *tty) 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 1253 * 1254 * Return 0 on success, -errno on error. 1255 * Re-opens on master ptys are not allowed and return -EIO. 1256 * 1257 * Locking: Caller must hold tty_lock 1258 */ 1259 static int tty_reopen(struct tty_struct *tty) 1260 { 1261 struct tty_driver *driver = tty->driver; 1262 struct tty_ldisc *ld; 1263 int retval = 0; 1264 1265 if (driver->type == TTY_DRIVER_TYPE_PTY && 1266 driver->subtype == PTY_TYPE_MASTER) 1267 return -EIO; 1268 1269 if (!tty->count) 1270 return -EAGAIN; 1271 1272 if (test_bit(TTY_EXCLUSIVE, &tty->flags) && !capable(CAP_SYS_ADMIN)) 1273 return -EBUSY; 1274 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 } 1287 1288 if (retval == 0) 1289 tty->count++; 1290 1291 return retval; 1292 } 1293 1294 /** 1295 * tty_init_dev - initialise a tty device 1296 * @driver: tty driver we are opening a device on 1297 * @idx: device index 1298 * @ret_tty: returned tty structure 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 * 1312 * WSH 06/09/97: Rewritten to remove races and properly clean up after a 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 1315 * relaxed for the (most common) case of reopening a tty. 1316 */ 1317 1318 struct tty_struct *tty_init_dev(struct tty_driver *driver, int idx) 1319 { 1320 struct tty_struct *tty; 1321 int retval; 1322 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 1327 * and the allocated memory released. (Except that the termios 1328 * may be retained.) 1329 */ 1330 1331 if (!try_module_get(driver->owner)) 1332 return ERR_PTR(-ENODEV); 1333 1334 tty = alloc_tty_struct(driver, idx); 1335 if (!tty) { 1336 retval = -ENOMEM; 1337 goto err_module_put; 1338 } 1339 1340 tty_lock(tty); 1341 retval = tty_driver_install_tty(driver, tty); 1342 if (retval < 0) 1343 goto err_free_tty; 1344 1345 if (!tty->port) 1346 tty->port = driver->ports[idx]; 1347 1348 WARN_RATELIMIT(!tty->port, 1349 "%s: %s driver does not set tty->port. This will crash the kernel later. Fix the driver!\n", 1350 __func__, tty->driver->name); 1351 1352 retval = tty_ldisc_lock(tty, 5 * HZ); 1353 if (retval) 1354 goto err_release_lock; 1355 tty->port->itty = tty; 1356 1357 /* 1358 * Structures all installed ... call the ldisc open routines. 1359 * If we fail here just call release_tty to clean up. No need 1360 * to decrement the use counts, as release_tty doesn't care. 1361 */ 1362 retval = tty_ldisc_setup(tty, tty->link); 1363 if (retval) 1364 goto err_release_tty; 1365 tty_ldisc_unlock(tty); 1366 /* Return the tty locked so that it cannot vanish under the caller */ 1367 return tty; 1368 1369 err_free_tty: 1370 tty_unlock(tty); 1371 free_tty_struct(tty); 1372 err_module_put: 1373 module_put(driver->owner); 1374 return ERR_PTR(retval); 1375 1376 /* call the tty release_tty routine to clean out this slot */ 1377 err_release_tty: 1378 tty_ldisc_unlock(tty); 1379 tty_info_ratelimited(tty, "ldisc open failed (%d), clearing slot %d\n", 1380 retval, idx); 1381 err_release_lock: 1382 tty_unlock(tty); 1383 release_tty(tty, idx); 1384 return ERR_PTR(retval); 1385 } 1386 1387 /** 1388 * tty_save_termios() - save tty termios data in driver table 1389 * @tty: tty whose termios data to save 1390 * 1391 * Locking: Caller guarantees serialisation with tty_init_termios(). 1392 */ 1393 void tty_save_termios(struct tty_struct *tty) 1394 { 1395 struct ktermios *tp; 1396 int idx = tty->index; 1397 1398 /* If the port is going to reset then it has no termios to save */ 1399 if (tty->driver->flags & TTY_DRIVER_RESET_TERMIOS) 1400 return; 1401 1402 /* Stash the termios data */ 1403 tp = tty->driver->termios[idx]; 1404 if (tp == NULL) { 1405 tp = kmalloc(sizeof(struct ktermios), GFP_KERNEL); 1406 if (tp == NULL) 1407 return; 1408 tty->driver->termios[idx] = tp; 1409 } 1410 *tp = tty->termios; 1411 } 1412 EXPORT_SYMBOL_GPL(tty_save_termios); 1413 1414 /** 1415 * tty_flush_works - flush all works of a tty/pty pair 1416 * @tty: tty device to flush works for (or either end of a pty pair) 1417 * 1418 * Sync flush all works belonging to @tty (and the 'other' tty). 1419 */ 1420 static void tty_flush_works(struct tty_struct *tty) 1421 { 1422 flush_work(&tty->SAK_work); 1423 flush_work(&tty->hangup_work); 1424 if (tty->link) { 1425 flush_work(&tty->link->SAK_work); 1426 flush_work(&tty->link->hangup_work); 1427 } 1428 } 1429 1430 /** 1431 * release_one_tty - release tty structure memory 1432 * @kref: kref of tty we are obliterating 1433 * 1434 * Releases memory associated with a tty structure, and clears out the 1435 * driver table slots. This function is called when a device is no longer 1436 * in use. It also gets called when setup of a device fails. 1437 * 1438 * Locking: 1439 * takes the file list lock internally when working on the list 1440 * of ttys that the driver keeps. 1441 * 1442 * This method gets called from a work queue so that the driver private 1443 * cleanup ops can sleep (needed for USB at least) 1444 */ 1445 static void release_one_tty(struct work_struct *work) 1446 { 1447 struct tty_struct *tty = 1448 container_of(work, struct tty_struct, hangup_work); 1449 struct tty_driver *driver = tty->driver; 1450 struct module *owner = driver->owner; 1451 1452 if (tty->ops->cleanup) 1453 tty->ops->cleanup(tty); 1454 1455 tty->magic = 0; 1456 tty_driver_kref_put(driver); 1457 module_put(owner); 1458 1459 spin_lock(&tty->files_lock); 1460 list_del_init(&tty->tty_files); 1461 spin_unlock(&tty->files_lock); 1462 1463 put_pid(tty->pgrp); 1464 put_pid(tty->session); 1465 free_tty_struct(tty); 1466 } 1467 1468 static void queue_release_one_tty(struct kref *kref) 1469 { 1470 struct tty_struct *tty = container_of(kref, struct tty_struct, kref); 1471 1472 /* The hangup queue is now free so we can reuse it rather than 1473 waste a chunk of memory for each port */ 1474 INIT_WORK(&tty->hangup_work, release_one_tty); 1475 schedule_work(&tty->hangup_work); 1476 } 1477 1478 /** 1479 * tty_kref_put - release a tty kref 1480 * @tty: tty device 1481 * 1482 * Release a reference to a tty device and if need be let the kref 1483 * layer destruct the object for us 1484 */ 1485 1486 void tty_kref_put(struct tty_struct *tty) 1487 { 1488 if (tty) 1489 kref_put(&tty->kref, queue_release_one_tty); 1490 } 1491 EXPORT_SYMBOL(tty_kref_put); 1492 1493 /** 1494 * release_tty - release tty structure memory 1495 * 1496 * Release both @tty and a possible linked partner (think pty pair), 1497 * and decrement the refcount of the backing module. 1498 * 1499 * Locking: 1500 * tty_mutex 1501 * takes the file list lock internally when working on the list 1502 * of ttys that the driver keeps. 1503 * 1504 */ 1505 static void release_tty(struct tty_struct *tty, int idx) 1506 { 1507 /* This should always be true but check for the moment */ 1508 WARN_ON(tty->index != idx); 1509 WARN_ON(!mutex_is_locked(&tty_mutex)); 1510 if (tty->ops->shutdown) 1511 tty->ops->shutdown(tty); 1512 tty_save_termios(tty); 1513 tty_driver_remove_tty(tty->driver, tty); 1514 tty->port->itty = NULL; 1515 if (tty->link) 1516 tty->link->port->itty = NULL; 1517 tty_buffer_cancel_work(tty->port); 1518 if (tty->link) 1519 tty_buffer_cancel_work(tty->link->port); 1520 1521 tty_kref_put(tty->link); 1522 tty_kref_put(tty); 1523 } 1524 1525 /** 1526 * tty_release_checks - check a tty before real release 1527 * @tty: tty to check 1528 * @o_tty: link of @tty (if any) 1529 * @idx: index of the tty 1530 * 1531 * Performs some paranoid checking before true release of the @tty. 1532 * This is a no-op unless TTY_PARANOIA_CHECK is defined. 1533 */ 1534 static int tty_release_checks(struct tty_struct *tty, int idx) 1535 { 1536 #ifdef TTY_PARANOIA_CHECK 1537 if (idx < 0 || idx >= tty->driver->num) { 1538 tty_debug(tty, "bad idx %d\n", idx); 1539 return -1; 1540 } 1541 1542 /* not much to check for devpts */ 1543 if (tty->driver->flags & TTY_DRIVER_DEVPTS_MEM) 1544 return 0; 1545 1546 if (tty != tty->driver->ttys[idx]) { 1547 tty_debug(tty, "bad driver table[%d] = %p\n", 1548 idx, tty->driver->ttys[idx]); 1549 return -1; 1550 } 1551 if (tty->driver->other) { 1552 struct tty_struct *o_tty = tty->link; 1553 1554 if (o_tty != tty->driver->other->ttys[idx]) { 1555 tty_debug(tty, "bad other table[%d] = %p\n", 1556 idx, tty->driver->other->ttys[idx]); 1557 return -1; 1558 } 1559 if (o_tty->link != tty) { 1560 tty_debug(tty, "bad link = %p\n", o_tty->link); 1561 return -1; 1562 } 1563 } 1564 #endif 1565 return 0; 1566 } 1567 1568 /** 1569 * tty_kclose - closes tty opened by tty_kopen 1570 * @tty: tty device 1571 * 1572 * Performs the final steps to release and free a tty device. It is the 1573 * same as tty_release_struct except that it also resets TTY_PORT_KOPENED 1574 * flag on tty->port. 1575 */ 1576 void tty_kclose(struct tty_struct *tty) 1577 { 1578 /* 1579 * Ask the line discipline code to release its structures 1580 */ 1581 tty_ldisc_release(tty); 1582 1583 /* Wait for pending work before tty destruction commmences */ 1584 tty_flush_works(tty); 1585 1586 tty_debug_hangup(tty, "freeing structure\n"); 1587 /* 1588 * The release_tty function takes care of the details of clearing 1589 * the slots and preserving the termios structure. The tty_unlock_pair 1590 * should be safe as we keep a kref while the tty is locked (so the 1591 * unlock never unlocks a freed tty). 1592 */ 1593 mutex_lock(&tty_mutex); 1594 tty_port_set_kopened(tty->port, 0); 1595 release_tty(tty, tty->index); 1596 mutex_unlock(&tty_mutex); 1597 } 1598 EXPORT_SYMBOL_GPL(tty_kclose); 1599 1600 /** 1601 * tty_release_struct - release a tty struct 1602 * @tty: tty device 1603 * @idx: index of the tty 1604 * 1605 * Performs the final steps to release and free a tty device. It is 1606 * roughly the reverse of tty_init_dev. 1607 */ 1608 void tty_release_struct(struct tty_struct *tty, int idx) 1609 { 1610 /* 1611 * Ask the line discipline code to release its structures 1612 */ 1613 tty_ldisc_release(tty); 1614 1615 /* Wait for pending work before tty destruction commmences */ 1616 tty_flush_works(tty); 1617 1618 tty_debug_hangup(tty, "freeing structure\n"); 1619 /* 1620 * The release_tty function takes care of the details of clearing 1621 * the slots and preserving the termios structure. The tty_unlock_pair 1622 * should be safe as we keep a kref while the tty is locked (so the 1623 * unlock never unlocks a freed tty). 1624 */ 1625 mutex_lock(&tty_mutex); 1626 release_tty(tty, idx); 1627 mutex_unlock(&tty_mutex); 1628 } 1629 EXPORT_SYMBOL_GPL(tty_release_struct); 1630 1631 /** 1632 * tty_release - vfs callback for close 1633 * @inode: inode of tty 1634 * @filp: file pointer for handle to tty 1635 * 1636 * Called the last time each file handle is closed that references 1637 * this tty. There may however be several such references. 1638 * 1639 * Locking: 1640 * Takes bkl. See tty_release_dev 1641 * 1642 * Even releasing the tty structures is a tricky business.. We have 1643 * to be very careful that the structures are all released at the 1644 * same time, as interrupts might otherwise get the wrong pointers. 1645 * 1646 * WSH 09/09/97: rewritten to avoid some nasty race conditions that could 1647 * lead to double frees or releasing memory still in use. 1648 */ 1649 1650 int tty_release(struct inode *inode, struct file *filp) 1651 { 1652 struct tty_struct *tty = file_tty(filp); 1653 struct tty_struct *o_tty = NULL; 1654 int do_sleep, final; 1655 int idx; 1656 long timeout = 0; 1657 int once = 1; 1658 1659 if (tty_paranoia_check(tty, inode, __func__)) 1660 return 0; 1661 1662 tty_lock(tty); 1663 check_tty_count(tty, __func__); 1664 1665 __tty_fasync(-1, filp, 0); 1666 1667 idx = tty->index; 1668 if (tty->driver->type == TTY_DRIVER_TYPE_PTY && 1669 tty->driver->subtype == PTY_TYPE_MASTER) 1670 o_tty = tty->link; 1671 1672 if (tty_release_checks(tty, idx)) { 1673 tty_unlock(tty); 1674 return 0; 1675 } 1676 1677 tty_debug_hangup(tty, "releasing (count=%d)\n", tty->count); 1678 1679 if (tty->ops->close) 1680 tty->ops->close(tty, filp); 1681 1682 /* If tty is pty master, lock the slave pty (stable lock order) */ 1683 tty_lock_slave(o_tty); 1684 1685 /* 1686 * Sanity check: if tty->count is going to zero, there shouldn't be 1687 * any waiters on tty->read_wait or tty->write_wait. We test the 1688 * wait queues and kick everyone out _before_ actually starting to 1689 * close. This ensures that we won't block while releasing the tty 1690 * structure. 1691 * 1692 * The test for the o_tty closing is necessary, since the master and 1693 * slave sides may close in any order. If the slave side closes out 1694 * first, its count will be one, since the master side holds an open. 1695 * Thus this test wouldn't be triggered at the time the slave closed, 1696 * so we do it now. 1697 */ 1698 while (1) { 1699 do_sleep = 0; 1700 1701 if (tty->count <= 1) { 1702 if (waitqueue_active(&tty->read_wait)) { 1703 wake_up_poll(&tty->read_wait, EPOLLIN); 1704 do_sleep++; 1705 } 1706 if (waitqueue_active(&tty->write_wait)) { 1707 wake_up_poll(&tty->write_wait, EPOLLOUT); 1708 do_sleep++; 1709 } 1710 } 1711 if (o_tty && o_tty->count <= 1) { 1712 if (waitqueue_active(&o_tty->read_wait)) { 1713 wake_up_poll(&o_tty->read_wait, EPOLLIN); 1714 do_sleep++; 1715 } 1716 if (waitqueue_active(&o_tty->write_wait)) { 1717 wake_up_poll(&o_tty->write_wait, EPOLLOUT); 1718 do_sleep++; 1719 } 1720 } 1721 if (!do_sleep) 1722 break; 1723 1724 if (once) { 1725 once = 0; 1726 tty_warn(tty, "read/write wait queue active!\n"); 1727 } 1728 schedule_timeout_killable(timeout); 1729 if (timeout < 120 * HZ) 1730 timeout = 2 * timeout + 1; 1731 else 1732 timeout = MAX_SCHEDULE_TIMEOUT; 1733 } 1734 1735 if (o_tty) { 1736 if (--o_tty->count < 0) { 1737 tty_warn(tty, "bad slave count (%d)\n", o_tty->count); 1738 o_tty->count = 0; 1739 } 1740 } 1741 if (--tty->count < 0) { 1742 tty_warn(tty, "bad tty->count (%d)\n", tty->count); 1743 tty->count = 0; 1744 } 1745 1746 /* 1747 * We've decremented tty->count, so we need to remove this file 1748 * descriptor off the tty->tty_files list; this serves two 1749 * purposes: 1750 * - check_tty_count sees the correct number of file descriptors 1751 * associated with this tty. 1752 * - do_tty_hangup no longer sees this file descriptor as 1753 * something that needs to be handled for hangups. 1754 */ 1755 tty_del_file(filp); 1756 1757 /* 1758 * Perform some housekeeping before deciding whether to return. 1759 * 1760 * If _either_ side is closing, make sure there aren't any 1761 * processes that still think tty or o_tty is their controlling 1762 * tty. 1763 */ 1764 if (!tty->count) { 1765 read_lock(&tasklist_lock); 1766 session_clear_tty(tty->session); 1767 if (o_tty) 1768 session_clear_tty(o_tty->session); 1769 read_unlock(&tasklist_lock); 1770 } 1771 1772 /* check whether both sides are closing ... */ 1773 final = !tty->count && !(o_tty && o_tty->count); 1774 1775 tty_unlock_slave(o_tty); 1776 tty_unlock(tty); 1777 1778 /* At this point, the tty->count == 0 should ensure a dead tty 1779 cannot be re-opened by a racing opener */ 1780 1781 if (!final) 1782 return 0; 1783 1784 tty_debug_hangup(tty, "final close\n"); 1785 1786 tty_release_struct(tty, idx); 1787 return 0; 1788 } 1789 1790 /** 1791 * tty_open_current_tty - get locked tty of current task 1792 * @device: device number 1793 * @filp: file pointer to tty 1794 * @return: locked tty of the current task iff @device is /dev/tty 1795 * 1796 * Performs a re-open of the current task's controlling tty. 1797 * 1798 * We cannot return driver and index like for the other nodes because 1799 * devpts will not work then. It expects inodes to be from devpts FS. 1800 */ 1801 static struct tty_struct *tty_open_current_tty(dev_t device, struct file *filp) 1802 { 1803 struct tty_struct *tty; 1804 int retval; 1805 1806 if (device != MKDEV(TTYAUX_MAJOR, 0)) 1807 return NULL; 1808 1809 tty = get_current_tty(); 1810 if (!tty) 1811 return ERR_PTR(-ENXIO); 1812 1813 filp->f_flags |= O_NONBLOCK; /* Don't let /dev/tty block */ 1814 /* noctty = 1; */ 1815 tty_lock(tty); 1816 tty_kref_put(tty); /* safe to drop the kref now */ 1817 1818 retval = tty_reopen(tty); 1819 if (retval < 0) { 1820 tty_unlock(tty); 1821 tty = ERR_PTR(retval); 1822 } 1823 return tty; 1824 } 1825 1826 /** 1827 * tty_lookup_driver - lookup a tty driver for a given device file 1828 * @device: device number 1829 * @filp: file pointer to tty 1830 * @index: index for the device in the @return driver 1831 * @return: driver for this inode (with increased refcount) 1832 * 1833 * If @return is not erroneous, the caller is responsible to decrement the 1834 * refcount by tty_driver_kref_put. 1835 * 1836 * Locking: tty_mutex protects get_tty_driver 1837 */ 1838 static struct tty_driver *tty_lookup_driver(dev_t device, struct file *filp, 1839 int *index) 1840 { 1841 struct tty_driver *driver = NULL; 1842 1843 switch (device) { 1844 #ifdef CONFIG_VT 1845 case MKDEV(TTY_MAJOR, 0): { 1846 extern struct tty_driver *console_driver; 1847 driver = tty_driver_kref_get(console_driver); 1848 *index = fg_console; 1849 break; 1850 } 1851 #endif 1852 case MKDEV(TTYAUX_MAJOR, 1): { 1853 struct tty_driver *console_driver = console_device(index); 1854 if (console_driver) { 1855 driver = tty_driver_kref_get(console_driver); 1856 if (driver && filp) { 1857 /* Don't let /dev/console block */ 1858 filp->f_flags |= O_NONBLOCK; 1859 break; 1860 } 1861 } 1862 if (driver) 1863 tty_driver_kref_put(driver); 1864 return ERR_PTR(-ENODEV); 1865 } 1866 default: 1867 driver = get_tty_driver(device, index); 1868 if (!driver) 1869 return ERR_PTR(-ENODEV); 1870 break; 1871 } 1872 return driver; 1873 } 1874 1875 /** 1876 * tty_kopen - open a tty device for kernel 1877 * @device: dev_t of device to open 1878 * 1879 * Opens tty exclusively for kernel. Performs the driver lookup, 1880 * makes sure it's not already opened and performs the first-time 1881 * tty initialization. 1882 * 1883 * Returns the locked initialized &tty_struct 1884 * 1885 * Claims the global tty_mutex to serialize: 1886 * - concurrent first-time tty initialization 1887 * - concurrent tty driver removal w/ lookup 1888 * - concurrent tty removal from driver table 1889 */ 1890 struct tty_struct *tty_kopen(dev_t device) 1891 { 1892 struct tty_struct *tty; 1893 struct tty_driver *driver = NULL; 1894 int index = -1; 1895 1896 mutex_lock(&tty_mutex); 1897 driver = tty_lookup_driver(device, NULL, &index); 1898 if (IS_ERR(driver)) { 1899 mutex_unlock(&tty_mutex); 1900 return ERR_CAST(driver); 1901 } 1902 1903 /* check whether we're reopening an existing tty */ 1904 tty = tty_driver_lookup_tty(driver, NULL, index); 1905 if (IS_ERR(tty)) 1906 goto out; 1907 1908 if (tty) { 1909 /* drop kref from tty_driver_lookup_tty() */ 1910 tty_kref_put(tty); 1911 tty = ERR_PTR(-EBUSY); 1912 } else { /* tty_init_dev returns tty with the tty_lock held */ 1913 tty = tty_init_dev(driver, index); 1914 if (IS_ERR(tty)) 1915 goto out; 1916 tty_port_set_kopened(tty->port, 1); 1917 } 1918 out: 1919 mutex_unlock(&tty_mutex); 1920 tty_driver_kref_put(driver); 1921 return tty; 1922 } 1923 EXPORT_SYMBOL_GPL(tty_kopen); 1924 1925 /** 1926 * tty_open_by_driver - open a tty device 1927 * @device: dev_t of device to open 1928 * @inode: inode of device file 1929 * @filp: file pointer to tty 1930 * 1931 * Performs the driver lookup, checks for a reopen, or otherwise 1932 * performs the first-time tty initialization. 1933 * 1934 * Returns the locked initialized or re-opened &tty_struct 1935 * 1936 * Claims the global tty_mutex to serialize: 1937 * - concurrent first-time tty initialization 1938 * - concurrent tty driver removal w/ lookup 1939 * - concurrent tty removal from driver table 1940 */ 1941 static struct tty_struct *tty_open_by_driver(dev_t device, struct inode *inode, 1942 struct file *filp) 1943 { 1944 struct tty_struct *tty; 1945 struct tty_driver *driver = NULL; 1946 int index = -1; 1947 int retval; 1948 1949 mutex_lock(&tty_mutex); 1950 driver = tty_lookup_driver(device, filp, &index); 1951 if (IS_ERR(driver)) { 1952 mutex_unlock(&tty_mutex); 1953 return ERR_CAST(driver); 1954 } 1955 1956 /* check whether we're reopening an existing tty */ 1957 tty = tty_driver_lookup_tty(driver, filp, index); 1958 if (IS_ERR(tty)) { 1959 mutex_unlock(&tty_mutex); 1960 goto out; 1961 } 1962 1963 if (tty) { 1964 if (tty_port_kopened(tty->port)) { 1965 tty_kref_put(tty); 1966 mutex_unlock(&tty_mutex); 1967 tty = ERR_PTR(-EBUSY); 1968 goto out; 1969 } 1970 mutex_unlock(&tty_mutex); 1971 retval = tty_lock_interruptible(tty); 1972 tty_kref_put(tty); /* drop kref from tty_driver_lookup_tty() */ 1973 if (retval) { 1974 if (retval == -EINTR) 1975 retval = -ERESTARTSYS; 1976 tty = ERR_PTR(retval); 1977 goto out; 1978 } 1979 retval = tty_reopen(tty); 1980 if (retval < 0) { 1981 tty_unlock(tty); 1982 tty = ERR_PTR(retval); 1983 } 1984 } else { /* Returns with the tty_lock held for now */ 1985 tty = tty_init_dev(driver, index); 1986 mutex_unlock(&tty_mutex); 1987 } 1988 out: 1989 tty_driver_kref_put(driver); 1990 return tty; 1991 } 1992 1993 /** 1994 * tty_open - open a tty device 1995 * @inode: inode of device file 1996 * @filp: file pointer to tty 1997 * 1998 * tty_open and tty_release keep up the tty count that contains the 1999 * number of opens done on a tty. We cannot use the inode-count, as 2000 * different inodes might point to the same tty. 2001 * 2002 * Open-counting is needed for pty masters, as well as for keeping 2003 * track of serial lines: DTR is dropped when the last close happens. 2004 * (This is not done solely through tty->count, now. - Ted 1/27/92) 2005 * 2006 * The termios state of a pty is reset on first open so that 2007 * settings don't persist across reuse. 2008 * 2009 * Locking: tty_mutex protects tty, tty_lookup_driver and tty_init_dev. 2010 * tty->count should protect the rest. 2011 * ->siglock protects ->signal/->sighand 2012 * 2013 * Note: the tty_unlock/lock cases without a ref are only safe due to 2014 * tty_mutex 2015 */ 2016 2017 static int tty_open(struct inode *inode, struct file *filp) 2018 { 2019 struct tty_struct *tty; 2020 int noctty, retval; 2021 dev_t device = inode->i_rdev; 2022 unsigned saved_flags = filp->f_flags; 2023 2024 nonseekable_open(inode, filp); 2025 2026 retry_open: 2027 retval = tty_alloc_file(filp); 2028 if (retval) 2029 return -ENOMEM; 2030 2031 tty = tty_open_current_tty(device, filp); 2032 if (!tty) 2033 tty = tty_open_by_driver(device, inode, filp); 2034 2035 if (IS_ERR(tty)) { 2036 tty_free_file(filp); 2037 retval = PTR_ERR(tty); 2038 if (retval != -EAGAIN || signal_pending(current)) 2039 return retval; 2040 schedule(); 2041 goto retry_open; 2042 } 2043 2044 tty_add_file(tty, filp); 2045 2046 check_tty_count(tty, __func__); 2047 tty_debug_hangup(tty, "opening (count=%d)\n", tty->count); 2048 2049 if (tty->ops->open) 2050 retval = tty->ops->open(tty, filp); 2051 else 2052 retval = -ENODEV; 2053 filp->f_flags = saved_flags; 2054 2055 if (retval) { 2056 tty_debug_hangup(tty, "open error %d, releasing\n", retval); 2057 2058 tty_unlock(tty); /* need to call tty_release without BTM */ 2059 tty_release(inode, filp); 2060 if (retval != -ERESTARTSYS) 2061 return retval; 2062 2063 if (signal_pending(current)) 2064 return retval; 2065 2066 schedule(); 2067 /* 2068 * Need to reset f_op in case a hangup happened. 2069 */ 2070 if (tty_hung_up_p(filp)) 2071 filp->f_op = &tty_fops; 2072 goto retry_open; 2073 } 2074 clear_bit(TTY_HUPPED, &tty->flags); 2075 2076 noctty = (filp->f_flags & O_NOCTTY) || 2077 (IS_ENABLED(CONFIG_VT) && device == MKDEV(TTY_MAJOR, 0)) || 2078 device == MKDEV(TTYAUX_MAJOR, 1) || 2079 (tty->driver->type == TTY_DRIVER_TYPE_PTY && 2080 tty->driver->subtype == PTY_TYPE_MASTER); 2081 if (!noctty) 2082 tty_open_proc_set_tty(filp, tty); 2083 tty_unlock(tty); 2084 return 0; 2085 } 2086 2087 2088 2089 /** 2090 * tty_poll - check tty status 2091 * @filp: file being polled 2092 * @wait: poll wait structures to update 2093 * 2094 * Call the line discipline polling method to obtain the poll 2095 * status of the device. 2096 * 2097 * Locking: locks called line discipline but ldisc poll method 2098 * may be re-entered freely by other callers. 2099 */ 2100 2101 static __poll_t tty_poll(struct file *filp, poll_table *wait) 2102 { 2103 struct tty_struct *tty = file_tty(filp); 2104 struct tty_ldisc *ld; 2105 __poll_t ret = 0; 2106 2107 if (tty_paranoia_check(tty, file_inode(filp), "tty_poll")) 2108 return 0; 2109 2110 ld = tty_ldisc_ref_wait(tty); 2111 if (!ld) 2112 return hung_up_tty_poll(filp, wait); 2113 if (ld->ops->poll) 2114 ret = ld->ops->poll(tty, filp, wait); 2115 tty_ldisc_deref(ld); 2116 return ret; 2117 } 2118 2119 static int __tty_fasync(int fd, struct file *filp, int on) 2120 { 2121 struct tty_struct *tty = file_tty(filp); 2122 unsigned long flags; 2123 int retval = 0; 2124 2125 if (tty_paranoia_check(tty, file_inode(filp), "tty_fasync")) 2126 goto out; 2127 2128 retval = fasync_helper(fd, filp, on, &tty->fasync); 2129 if (retval <= 0) 2130 goto out; 2131 2132 if (on) { 2133 enum pid_type type; 2134 struct pid *pid; 2135 2136 spin_lock_irqsave(&tty->ctrl_lock, flags); 2137 if (tty->pgrp) { 2138 pid = tty->pgrp; 2139 type = PIDTYPE_PGID; 2140 } else { 2141 pid = task_pid(current); 2142 type = PIDTYPE_TGID; 2143 } 2144 get_pid(pid); 2145 spin_unlock_irqrestore(&tty->ctrl_lock, flags); 2146 __f_setown(filp, pid, type, 0); 2147 put_pid(pid); 2148 retval = 0; 2149 } 2150 out: 2151 return retval; 2152 } 2153 2154 static int tty_fasync(int fd, struct file *filp, int on) 2155 { 2156 struct tty_struct *tty = file_tty(filp); 2157 int retval = -ENOTTY; 2158 2159 tty_lock(tty); 2160 if (!tty_hung_up_p(filp)) 2161 retval = __tty_fasync(fd, filp, on); 2162 tty_unlock(tty); 2163 2164 return retval; 2165 } 2166 2167 /** 2168 * tiocsti - fake input character 2169 * @tty: tty to fake input into 2170 * @p: pointer to character 2171 * 2172 * Fake input to a tty device. Does the necessary locking and 2173 * input management. 2174 * 2175 * FIXME: does not honour flow control ?? 2176 * 2177 * Locking: 2178 * Called functions take tty_ldiscs_lock 2179 * current->signal->tty check is safe without locks 2180 * 2181 * FIXME: may race normal receive processing 2182 */ 2183 2184 static int tiocsti(struct tty_struct *tty, char __user *p) 2185 { 2186 char ch, mbz = 0; 2187 struct tty_ldisc *ld; 2188 2189 if ((current->signal->tty != tty) && !capable(CAP_SYS_ADMIN)) 2190 return -EPERM; 2191 if (get_user(ch, p)) 2192 return -EFAULT; 2193 tty_audit_tiocsti(tty, ch); 2194 ld = tty_ldisc_ref_wait(tty); 2195 if (!ld) 2196 return -EIO; 2197 if (ld->ops->receive_buf) 2198 ld->ops->receive_buf(tty, &ch, &mbz, 1); 2199 tty_ldisc_deref(ld); 2200 return 0; 2201 } 2202 2203 /** 2204 * tiocgwinsz - implement window query ioctl 2205 * @tty; tty 2206 * @arg: user buffer for result 2207 * 2208 * Copies the kernel idea of the window size into the user buffer. 2209 * 2210 * Locking: tty->winsize_mutex is taken to ensure the winsize data 2211 * is consistent. 2212 */ 2213 2214 static int tiocgwinsz(struct tty_struct *tty, struct winsize __user *arg) 2215 { 2216 int err; 2217 2218 mutex_lock(&tty->winsize_mutex); 2219 err = copy_to_user(arg, &tty->winsize, sizeof(*arg)); 2220 mutex_unlock(&tty->winsize_mutex); 2221 2222 return err ? -EFAULT: 0; 2223 } 2224 2225 /** 2226 * tty_do_resize - resize event 2227 * @tty: tty being resized 2228 * @rows: rows (character) 2229 * @cols: cols (character) 2230 * 2231 * Update the termios variables and send the necessary signals to 2232 * peform a terminal resize correctly 2233 */ 2234 2235 int tty_do_resize(struct tty_struct *tty, struct winsize *ws) 2236 { 2237 struct pid *pgrp; 2238 2239 /* Lock the tty */ 2240 mutex_lock(&tty->winsize_mutex); 2241 if (!memcmp(ws, &tty->winsize, sizeof(*ws))) 2242 goto done; 2243 2244 /* Signal the foreground process group */ 2245 pgrp = tty_get_pgrp(tty); 2246 if (pgrp) 2247 kill_pgrp(pgrp, SIGWINCH, 1); 2248 put_pid(pgrp); 2249 2250 tty->winsize = *ws; 2251 done: 2252 mutex_unlock(&tty->winsize_mutex); 2253 return 0; 2254 } 2255 EXPORT_SYMBOL(tty_do_resize); 2256 2257 /** 2258 * tiocswinsz - implement window size set ioctl 2259 * @tty; tty side of tty 2260 * @arg: user buffer for result 2261 * 2262 * Copies the user idea of the window size to the kernel. Traditionally 2263 * this is just advisory information but for the Linux console it 2264 * actually has driver level meaning and triggers a VC resize. 2265 * 2266 * Locking: 2267 * Driver dependent. The default do_resize method takes the 2268 * tty termios mutex and ctrl_lock. The console takes its own lock 2269 * then calls into the default method. 2270 */ 2271 2272 static int tiocswinsz(struct tty_struct *tty, struct winsize __user *arg) 2273 { 2274 struct winsize tmp_ws; 2275 if (copy_from_user(&tmp_ws, arg, sizeof(*arg))) 2276 return -EFAULT; 2277 2278 if (tty->ops->resize) 2279 return tty->ops->resize(tty, &tmp_ws); 2280 else 2281 return tty_do_resize(tty, &tmp_ws); 2282 } 2283 2284 /** 2285 * tioccons - allow admin to move logical console 2286 * @file: the file to become console 2287 * 2288 * Allow the administrator to move the redirected console device 2289 * 2290 * Locking: uses redirect_lock to guard the redirect information 2291 */ 2292 2293 static int tioccons(struct file *file) 2294 { 2295 if (!capable(CAP_SYS_ADMIN)) 2296 return -EPERM; 2297 if (file->f_op->write == redirected_tty_write) { 2298 struct file *f; 2299 spin_lock(&redirect_lock); 2300 f = redirect; 2301 redirect = NULL; 2302 spin_unlock(&redirect_lock); 2303 if (f) 2304 fput(f); 2305 return 0; 2306 } 2307 spin_lock(&redirect_lock); 2308 if (redirect) { 2309 spin_unlock(&redirect_lock); 2310 return -EBUSY; 2311 } 2312 redirect = get_file(file); 2313 spin_unlock(&redirect_lock); 2314 return 0; 2315 } 2316 2317 /** 2318 * tiocsetd - set line discipline 2319 * @tty: tty device 2320 * @p: pointer to user data 2321 * 2322 * Set the line discipline according to user request. 2323 * 2324 * Locking: see tty_set_ldisc, this function is just a helper 2325 */ 2326 2327 static int tiocsetd(struct tty_struct *tty, int __user *p) 2328 { 2329 int disc; 2330 int ret; 2331 2332 if (get_user(disc, p)) 2333 return -EFAULT; 2334 2335 ret = tty_set_ldisc(tty, disc); 2336 2337 return ret; 2338 } 2339 2340 /** 2341 * tiocgetd - get line discipline 2342 * @tty: tty device 2343 * @p: pointer to user data 2344 * 2345 * Retrieves the line discipline id directly from the ldisc. 2346 * 2347 * Locking: waits for ldisc reference (in case the line discipline 2348 * is changing or the tty is being hungup) 2349 */ 2350 2351 static int tiocgetd(struct tty_struct *tty, int __user *p) 2352 { 2353 struct tty_ldisc *ld; 2354 int ret; 2355 2356 ld = tty_ldisc_ref_wait(tty); 2357 if (!ld) 2358 return -EIO; 2359 ret = put_user(ld->ops->num, p); 2360 tty_ldisc_deref(ld); 2361 return ret; 2362 } 2363 2364 /** 2365 * send_break - performed time break 2366 * @tty: device to break on 2367 * @duration: timeout in mS 2368 * 2369 * Perform a timed break on hardware that lacks its own driver level 2370 * timed break functionality. 2371 * 2372 * Locking: 2373 * atomic_write_lock serializes 2374 * 2375 */ 2376 2377 static int send_break(struct tty_struct *tty, unsigned int duration) 2378 { 2379 int retval; 2380 2381 if (tty->ops->break_ctl == NULL) 2382 return 0; 2383 2384 if (tty->driver->flags & TTY_DRIVER_HARDWARE_BREAK) 2385 retval = tty->ops->break_ctl(tty, duration); 2386 else { 2387 /* Do the work ourselves */ 2388 if (tty_write_lock(tty, 0) < 0) 2389 return -EINTR; 2390 retval = tty->ops->break_ctl(tty, -1); 2391 if (retval) 2392 goto out; 2393 if (!signal_pending(current)) 2394 msleep_interruptible(duration); 2395 retval = tty->ops->break_ctl(tty, 0); 2396 out: 2397 tty_write_unlock(tty); 2398 if (signal_pending(current)) 2399 retval = -EINTR; 2400 } 2401 return retval; 2402 } 2403 2404 /** 2405 * tty_tiocmget - get modem status 2406 * @tty: tty device 2407 * @file: user file pointer 2408 * @p: pointer to result 2409 * 2410 * Obtain the modem status bits from the tty driver if the feature 2411 * is supported. Return -EINVAL if it is not available. 2412 * 2413 * Locking: none (up to the driver) 2414 */ 2415 2416 static int tty_tiocmget(struct tty_struct *tty, int __user *p) 2417 { 2418 int retval = -EINVAL; 2419 2420 if (tty->ops->tiocmget) { 2421 retval = tty->ops->tiocmget(tty); 2422 2423 if (retval >= 0) 2424 retval = put_user(retval, p); 2425 } 2426 return retval; 2427 } 2428 2429 /** 2430 * tty_tiocmset - set modem status 2431 * @tty: tty device 2432 * @cmd: command - clear bits, set bits or set all 2433 * @p: pointer to desired bits 2434 * 2435 * Set the modem status bits from the tty driver if the feature 2436 * is supported. Return -EINVAL if it is not available. 2437 * 2438 * Locking: none (up to the driver) 2439 */ 2440 2441 static int tty_tiocmset(struct tty_struct *tty, unsigned int cmd, 2442 unsigned __user *p) 2443 { 2444 int retval; 2445 unsigned int set, clear, val; 2446 2447 if (tty->ops->tiocmset == NULL) 2448 return -EINVAL; 2449 2450 retval = get_user(val, p); 2451 if (retval) 2452 return retval; 2453 set = clear = 0; 2454 switch (cmd) { 2455 case TIOCMBIS: 2456 set = val; 2457 break; 2458 case TIOCMBIC: 2459 clear = val; 2460 break; 2461 case TIOCMSET: 2462 set = val; 2463 clear = ~val; 2464 break; 2465 } 2466 set &= TIOCM_DTR|TIOCM_RTS|TIOCM_OUT1|TIOCM_OUT2|TIOCM_LOOP; 2467 clear &= TIOCM_DTR|TIOCM_RTS|TIOCM_OUT1|TIOCM_OUT2|TIOCM_LOOP; 2468 return tty->ops->tiocmset(tty, set, clear); 2469 } 2470 2471 static int tty_tiocgicount(struct tty_struct *tty, void __user *arg) 2472 { 2473 int retval = -EINVAL; 2474 struct serial_icounter_struct icount; 2475 memset(&icount, 0, sizeof(icount)); 2476 if (tty->ops->get_icount) 2477 retval = tty->ops->get_icount(tty, &icount); 2478 if (retval != 0) 2479 return retval; 2480 if (copy_to_user(arg, &icount, sizeof(icount))) 2481 return -EFAULT; 2482 return 0; 2483 } 2484 2485 static int tty_tiocsserial(struct tty_struct *tty, struct serial_struct __user *ss) 2486 { 2487 static DEFINE_RATELIMIT_STATE(depr_flags, 2488 DEFAULT_RATELIMIT_INTERVAL, 2489 DEFAULT_RATELIMIT_BURST); 2490 char comm[TASK_COMM_LEN]; 2491 struct serial_struct v; 2492 int flags; 2493 2494 if (copy_from_user(&v, ss, sizeof(struct serial_struct))) 2495 return -EFAULT; 2496 2497 flags = v.flags & ASYNC_DEPRECATED; 2498 2499 if (flags && __ratelimit(&depr_flags)) 2500 pr_warn("%s: '%s' is using deprecated serial flags (with no effect): %.8x\n", 2501 __func__, get_task_comm(comm, current), flags); 2502 if (!tty->ops->set_serial) 2503 return -ENOTTY; 2504 return tty->ops->set_serial(tty, &v); 2505 } 2506 2507 static int tty_tiocgserial(struct tty_struct *tty, struct serial_struct __user *ss) 2508 { 2509 struct serial_struct v; 2510 int err; 2511 2512 memset(&v, 0, sizeof(struct serial_struct)); 2513 if (!tty->ops->get_serial) 2514 return -ENOTTY; 2515 err = tty->ops->get_serial(tty, &v); 2516 if (!err && copy_to_user(ss, &v, sizeof(struct serial_struct))) 2517 err = -EFAULT; 2518 return err; 2519 } 2520 2521 /* 2522 * if pty, return the slave side (real_tty) 2523 * otherwise, return self 2524 */ 2525 static struct tty_struct *tty_pair_get_tty(struct tty_struct *tty) 2526 { 2527 if (tty->driver->type == TTY_DRIVER_TYPE_PTY && 2528 tty->driver->subtype == PTY_TYPE_MASTER) 2529 tty = tty->link; 2530 return tty; 2531 } 2532 2533 /* 2534 * Split this up, as gcc can choke on it otherwise.. 2535 */ 2536 long tty_ioctl(struct file *file, unsigned int cmd, unsigned long arg) 2537 { 2538 struct tty_struct *tty = file_tty(file); 2539 struct tty_struct *real_tty; 2540 void __user *p = (void __user *)arg; 2541 int retval; 2542 struct tty_ldisc *ld; 2543 2544 if (tty_paranoia_check(tty, file_inode(file), "tty_ioctl")) 2545 return -EINVAL; 2546 2547 real_tty = tty_pair_get_tty(tty); 2548 2549 /* 2550 * Factor out some common prep work 2551 */ 2552 switch (cmd) { 2553 case TIOCSETD: 2554 case TIOCSBRK: 2555 case TIOCCBRK: 2556 case TCSBRK: 2557 case TCSBRKP: 2558 retval = tty_check_change(tty); 2559 if (retval) 2560 return retval; 2561 if (cmd != TIOCCBRK) { 2562 tty_wait_until_sent(tty, 0); 2563 if (signal_pending(current)) 2564 return -EINTR; 2565 } 2566 break; 2567 } 2568 2569 /* 2570 * Now do the stuff. 2571 */ 2572 switch (cmd) { 2573 case TIOCSTI: 2574 return tiocsti(tty, p); 2575 case TIOCGWINSZ: 2576 return tiocgwinsz(real_tty, p); 2577 case TIOCSWINSZ: 2578 return tiocswinsz(real_tty, p); 2579 case TIOCCONS: 2580 return real_tty != tty ? -EINVAL : tioccons(file); 2581 case TIOCEXCL: 2582 set_bit(TTY_EXCLUSIVE, &tty->flags); 2583 return 0; 2584 case TIOCNXCL: 2585 clear_bit(TTY_EXCLUSIVE, &tty->flags); 2586 return 0; 2587 case TIOCGEXCL: 2588 { 2589 int excl = test_bit(TTY_EXCLUSIVE, &tty->flags); 2590 return put_user(excl, (int __user *)p); 2591 } 2592 case TIOCGETD: 2593 return tiocgetd(tty, p); 2594 case TIOCSETD: 2595 return tiocsetd(tty, p); 2596 case TIOCVHANGUP: 2597 if (!capable(CAP_SYS_ADMIN)) 2598 return -EPERM; 2599 tty_vhangup(tty); 2600 return 0; 2601 case TIOCGDEV: 2602 { 2603 unsigned int ret = new_encode_dev(tty_devnum(real_tty)); 2604 return put_user(ret, (unsigned int __user *)p); 2605 } 2606 /* 2607 * Break handling 2608 */ 2609 case TIOCSBRK: /* Turn break on, unconditionally */ 2610 if (tty->ops->break_ctl) 2611 return tty->ops->break_ctl(tty, -1); 2612 return 0; 2613 case TIOCCBRK: /* Turn break off, unconditionally */ 2614 if (tty->ops->break_ctl) 2615 return tty->ops->break_ctl(tty, 0); 2616 return 0; 2617 case TCSBRK: /* SVID version: non-zero arg --> no break */ 2618 /* non-zero arg means wait for all output data 2619 * to be sent (performed above) but don't send break. 2620 * This is used by the tcdrain() termios function. 2621 */ 2622 if (!arg) 2623 return send_break(tty, 250); 2624 return 0; 2625 case TCSBRKP: /* support for POSIX tcsendbreak() */ 2626 return send_break(tty, arg ? arg*100 : 250); 2627 2628 case TIOCMGET: 2629 return tty_tiocmget(tty, p); 2630 case TIOCMSET: 2631 case TIOCMBIC: 2632 case TIOCMBIS: 2633 return tty_tiocmset(tty, cmd, p); 2634 case TIOCGICOUNT: 2635 return tty_tiocgicount(tty, p); 2636 case TCFLSH: 2637 switch (arg) { 2638 case TCIFLUSH: 2639 case TCIOFLUSH: 2640 /* flush tty buffer and allow ldisc to process ioctl */ 2641 tty_buffer_flush(tty, NULL); 2642 break; 2643 } 2644 break; 2645 case TIOCSSERIAL: 2646 return tty_tiocsserial(tty, p); 2647 case TIOCGSERIAL: 2648 return tty_tiocgserial(tty, p); 2649 case TIOCGPTPEER: 2650 /* Special because the struct file is needed */ 2651 return ptm_open_peer(file, tty, (int)arg); 2652 default: 2653 retval = tty_jobctrl_ioctl(tty, real_tty, file, cmd, arg); 2654 if (retval != -ENOIOCTLCMD) 2655 return retval; 2656 } 2657 if (tty->ops->ioctl) { 2658 retval = tty->ops->ioctl(tty, cmd, arg); 2659 if (retval != -ENOIOCTLCMD) 2660 return retval; 2661 } 2662 ld = tty_ldisc_ref_wait(tty); 2663 if (!ld) 2664 return hung_up_tty_ioctl(file, cmd, arg); 2665 retval = -EINVAL; 2666 if (ld->ops->ioctl) { 2667 retval = ld->ops->ioctl(tty, file, cmd, arg); 2668 if (retval == -ENOIOCTLCMD) 2669 retval = -ENOTTY; 2670 } 2671 tty_ldisc_deref(ld); 2672 return retval; 2673 } 2674 2675 #ifdef CONFIG_COMPAT 2676 2677 struct serial_struct32 { 2678 compat_int_t type; 2679 compat_int_t line; 2680 compat_uint_t port; 2681 compat_int_t irq; 2682 compat_int_t flags; 2683 compat_int_t xmit_fifo_size; 2684 compat_int_t custom_divisor; 2685 compat_int_t baud_base; 2686 unsigned short close_delay; 2687 char io_type; 2688 char reserved_char[1]; 2689 compat_int_t hub6; 2690 unsigned short closing_wait; /* time to wait before closing */ 2691 unsigned short closing_wait2; /* no longer used... */ 2692 compat_uint_t iomem_base; 2693 unsigned short iomem_reg_shift; 2694 unsigned int port_high; 2695 /* compat_ulong_t iomap_base FIXME */ 2696 compat_int_t reserved[1]; 2697 }; 2698 2699 static int compat_tty_tiocsserial(struct tty_struct *tty, 2700 struct serial_struct32 __user *ss) 2701 { 2702 static DEFINE_RATELIMIT_STATE(depr_flags, 2703 DEFAULT_RATELIMIT_INTERVAL, 2704 DEFAULT_RATELIMIT_BURST); 2705 char comm[TASK_COMM_LEN]; 2706 struct serial_struct32 v32; 2707 struct serial_struct v; 2708 int flags; 2709 2710 if (copy_from_user(&v32, ss, sizeof(struct serial_struct32))) 2711 return -EFAULT; 2712 2713 memcpy(&v, &v32, offsetof(struct serial_struct32, iomem_base)); 2714 v.iomem_base = compat_ptr(v32.iomem_base); 2715 v.iomem_reg_shift = v32.iomem_reg_shift; 2716 v.port_high = v32.port_high; 2717 v.iomap_base = 0; 2718 2719 flags = v.flags & ASYNC_DEPRECATED; 2720 2721 if (flags && __ratelimit(&depr_flags)) 2722 pr_warn("%s: '%s' is using deprecated serial flags (with no effect): %.8x\n", 2723 __func__, get_task_comm(comm, current), flags); 2724 if (!tty->ops->set_serial) 2725 return -ENOTTY; 2726 return tty->ops->set_serial(tty, &v); 2727 } 2728 2729 static int compat_tty_tiocgserial(struct tty_struct *tty, 2730 struct serial_struct32 __user *ss) 2731 { 2732 struct serial_struct32 v32; 2733 struct serial_struct v; 2734 int err; 2735 memset(&v, 0, sizeof(struct serial_struct)); 2736 2737 if (!tty->ops->set_serial) 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; 2746 if (copy_to_user(ss, &v32, sizeof(struct serial_struct32))) 2747 err = -EFAULT; 2748 } 2749 return err; 2750 } 2751 static long tty_compat_ioctl(struct file *file, unsigned int cmd, 2752 unsigned long arg) 2753 { 2754 struct tty_struct *tty = file_tty(file); 2755 struct tty_ldisc *ld; 2756 int retval = -ENOIOCTLCMD; 2757 2758 switch (cmd) { 2759 case TIOCOUTQ: 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: 2815 2816 case PPPIOCGCHAN: 2817 case PPPIOCGUNIT: 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 2837 if (tty_paranoia_check(tty, file_inode(file), "tty_ioctl")) 2838 return -EINVAL; 2839 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 } 2846 if (tty->ops->compat_ioctl) { 2847 retval = tty->ops->compat_ioctl(tty, cmd, arg); 2848 if (retval != -ENOIOCTLCMD) 2849 return retval; 2850 } 2851 2852 ld = tty_ldisc_ref_wait(tty); 2853 if (!ld) 2854 return hung_up_tty_compat_ioctl(file, cmd, arg); 2855 if (ld->ops->compat_ioctl) 2856 retval = ld->ops->compat_ioctl(tty, file, cmd, arg); 2857 if (retval == -ENOIOCTLCMD && ld->ops->ioctl) 2858 retval = ld->ops->ioctl(tty, file, 2859 (unsigned long)compat_ptr(cmd), arg); 2860 tty_ldisc_deref(ld); 2861 2862 return retval; 2863 } 2864 #endif 2865 2866 static 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 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. 2878 * 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 */ 2892 void __do_SAK(struct tty_struct *tty) 2893 { 2894 #ifdef TTY_SOFT_SAK 2895 tty_hangup(tty); 2896 #else 2897 struct task_struct *g, *p; 2898 struct pid *session; 2899 int i; 2900 2901 if (!tty) 2902 return; 2903 session = tty->session; 2904 2905 tty_ldisc_flush(tty); 2906 2907 tty_driver_flush_buffer(tty); 2908 2909 read_lock(&tasklist_lock); 2910 /* Kill the entire session */ 2911 do_each_pid_task(session, PIDTYPE_SID, p) { 2912 tty_notice(tty, "SAK: killed process %d (%s): by session\n", 2913 task_pid_nr(p), p->comm); 2914 group_send_sig_info(SIGKILL, SEND_SIG_PRIV, p, PIDTYPE_SID); 2915 } while_each_pid_task(session, PIDTYPE_SID, p); 2916 2917 /* Now kill any processes that happen to have the tty open */ 2918 do_each_thread(g, p) { 2919 if (p->signal->tty == tty) { 2920 tty_notice(tty, "SAK: killed process %d (%s): by controlling tty\n", 2921 task_pid_nr(p), p->comm); 2922 group_send_sig_info(SIGKILL, SEND_SIG_PRIV, p, PIDTYPE_SID); 2923 continue; 2924 } 2925 task_lock(p); 2926 i = iterate_fd(p->files, 0, this_tty, tty); 2927 if (i != 0) { 2928 tty_notice(tty, "SAK: killed process %d (%s): by fd#%d\n", 2929 task_pid_nr(p), p->comm, i - 1); 2930 group_send_sig_info(SIGKILL, SEND_SIG_PRIV, p, PIDTYPE_SID); 2931 } 2932 task_unlock(p); 2933 } while_each_thread(g, p); 2934 read_unlock(&tasklist_lock); 2935 #endif 2936 } 2937 2938 static 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 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 */ 2951 void do_SAK(struct tty_struct *tty) 2952 { 2953 if (!tty) 2954 return; 2955 schedule_work(&tty->SAK_work); 2956 } 2957 2958 EXPORT_SYMBOL(do_SAK); 2959 2960 /* Must put_device() after it's unused! */ 2961 static struct device *tty_get_device(struct tty_struct *tty) 2962 { 2963 dev_t devt = tty_devnum(tty); 2964 return class_find_device_by_devt(tty_class, devt); 2965 } 2966 2967 2968 /** 2969 * alloc_tty_struct 2970 * 2971 * This subroutine allocates and initializes a tty structure. 2972 * 2973 * Locking: none - tty in question is not exposed at this point 2974 */ 2975 2976 struct tty_struct *alloc_tty_struct(struct tty_driver *driver, int idx) 2977 { 2978 struct tty_struct *tty; 2979 2980 tty = kzalloc(sizeof(*tty), GFP_KERNEL); 2981 if (!tty) 2982 return NULL; 2983 2984 kref_init(&tty->kref); 2985 tty->magic = TTY_MAGIC; 2986 if (tty_ldisc_init(tty)) { 2987 kfree(tty); 2988 return NULL; 2989 } 2990 tty->session = NULL; 2991 tty->pgrp = NULL; 2992 mutex_init(&tty->legacy_mutex); 2993 mutex_init(&tty->throttle_mutex); 2994 init_rwsem(&tty->termios_rwsem); 2995 mutex_init(&tty->winsize_mutex); 2996 init_ldsem(&tty->ldisc_sem); 2997 init_waitqueue_head(&tty->write_wait); 2998 init_waitqueue_head(&tty->read_wait); 2999 INIT_WORK(&tty->hangup_work, do_tty_hangup); 3000 mutex_init(&tty->atomic_write_lock); 3001 spin_lock_init(&tty->ctrl_lock); 3002 spin_lock_init(&tty->flow_lock); 3003 spin_lock_init(&tty->files_lock); 3004 INIT_LIST_HEAD(&tty->tty_files); 3005 INIT_WORK(&tty->SAK_work, do_SAK_work); 3006 3007 tty->driver = driver; 3008 tty->ops = driver->ops; 3009 tty->index = idx; 3010 tty_line_name(driver, idx, tty->name); 3011 tty->dev = tty_get_device(tty); 3012 3013 return tty; 3014 } 3015 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 3026 */ 3027 3028 int tty_put_char(struct tty_struct *tty, unsigned char ch) 3029 { 3030 if (tty->ops->put_char) 3031 return tty->ops->put_char(tty, ch); 3032 return tty->ops->write(tty, &ch, 1); 3033 } 3034 EXPORT_SYMBOL_GPL(tty_put_char); 3035 3036 struct class *tty_class; 3037 3038 static int tty_cdev_add(struct tty_driver *driver, dev_t dev, 3039 unsigned int index, unsigned int count) 3040 { 3041 int err; 3042 3043 /* init here, since reused cdevs cause crashes */ 3044 driver->cdevs[index] = cdev_alloc(); 3045 if (!driver->cdevs[index]) 3046 return -ENOMEM; 3047 driver->cdevs[index]->ops = &tty_fops; 3048 driver->cdevs[index]->owner = driver->owner; 3049 err = cdev_add(driver->cdevs[index], dev, count); 3050 if (err) 3051 kobject_put(&driver->cdevs[index]->kobj); 3052 return err; 3053 } 3054 3055 /** 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. 3062 * 3063 * Returns a pointer to the struct device for this tty device 3064 * (or ERR_PTR(-EFOO) on error). 3065 * 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: ?? 3072 */ 3073 3074 struct device *tty_register_device(struct tty_driver *driver, unsigned index, 3075 struct device *device) 3076 { 3077 return tty_register_device_attr(driver, index, device, NULL, NULL); 3078 } 3079 EXPORT_SYMBOL(tty_register_device); 3080 3081 static void tty_device_create_release(struct device *dev) 3082 { 3083 dev_dbg(dev, "releasing...\n"); 3084 kfree(dev); 3085 } 3086 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 */ 3107 struct 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 { 3112 char name[64]; 3113 dev_t devt = MKDEV(driver->major, driver->minor_start) + index; 3114 struct ktermios *tp; 3115 struct device *dev; 3116 int retval; 3117 3118 if (index >= driver->num) { 3119 pr_err("%s: Attempt to register invalid tty line number (%d)\n", 3120 driver->name, index); 3121 return ERR_PTR(-EINVAL); 3122 } 3123 3124 if (driver->type == TTY_DRIVER_TYPE_PTY) 3125 pty_line_name(driver, index, name); 3126 else 3127 tty_line_name(driver, index, name); 3128 3129 dev = kzalloc(sizeof(*dev), GFP_KERNEL); 3130 if (!dev) 3131 return ERR_PTR(-ENOMEM); 3132 3133 dev->devt = devt; 3134 dev->class = tty_class; 3135 dev->parent = device; 3136 dev->release = tty_device_create_release; 3137 dev_set_name(dev, "%s", name); 3138 dev->groups = attr_grp; 3139 dev_set_drvdata(dev, drvdata); 3140 3141 dev_set_uevent_suppress(dev, 1); 3142 3143 retval = device_register(dev); 3144 if (retval) 3145 goto err_put; 3146 3147 if (!(driver->flags & TTY_DRIVER_DYNAMIC_ALLOC)) { 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 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); 3165 3166 return dev; 3167 3168 err_del: 3169 device_del(dev); 3170 err_put: 3171 put_device(dev); 3172 3173 return ERR_PTR(retval); 3174 } 3175 EXPORT_SYMBOL_GPL(tty_register_device_attr); 3176 3177 /** 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 3181 * 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: ?? 3186 */ 3187 3188 void tty_unregister_device(struct tty_driver *driver, unsigned index) 3189 { 3190 device_destroy(tty_class, 3191 MKDEV(driver->major, driver->minor_start) + index); 3192 if (!(driver->flags & TTY_DRIVER_DYNAMIC_ALLOC)) { 3193 cdev_del(driver->cdevs[index]); 3194 driver->cdevs[index] = NULL; 3195 } 3196 } 3197 EXPORT_SYMBOL(tty_unregister_device); 3198 3199 /** 3200 * __tty_alloc_driver -- allocate tty driver 3201 * @lines: count of lines this driver can handle at most 3202 * @owner: module which is responsible for this driver 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 */ 3208 struct tty_driver *__tty_alloc_driver(unsigned int lines, struct module *owner, 3209 unsigned long flags) 3210 { 3211 struct tty_driver *driver; 3212 unsigned int cdevs = 1; 3213 int err; 3214 3215 if (!lines || (flags & TTY_DRIVER_UNNUMBERED_NODE && lines > 1)) 3216 return ERR_PTR(-EINVAL); 3217 3218 driver = kzalloc(sizeof(struct tty_driver), GFP_KERNEL); 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; 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 } 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; 3253 } 3254 3255 return driver; 3256 err_free_all: 3257 kfree(driver->ports); 3258 kfree(driver->ttys); 3259 kfree(driver->termios); 3260 kfree(driver->cdevs); 3261 kfree(driver); 3262 return ERR_PTR(err); 3263 } 3264 EXPORT_SYMBOL(__tty_alloc_driver); 3265 3266 static void destruct_tty_driver(struct kref *kref) 3267 { 3268 struct tty_driver *driver = container_of(kref, struct tty_driver, kref); 3269 int i; 3270 struct ktermios *tp; 3271 3272 if (driver->flags & TTY_DRIVER_INSTALLED) { 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 } 3279 if (!(driver->flags & TTY_DRIVER_DYNAMIC_DEV)) 3280 tty_unregister_device(driver, i); 3281 } 3282 proc_tty_unregister_driver(driver); 3283 if (driver->flags & TTY_DRIVER_DYNAMIC_ALLOC) 3284 cdev_del(driver->cdevs[0]); 3285 } 3286 kfree(driver->cdevs); 3287 kfree(driver->ports); 3288 kfree(driver->termios); 3289 kfree(driver->ttys); 3290 kfree(driver); 3291 } 3292 3293 void tty_driver_kref_put(struct tty_driver *driver) 3294 { 3295 kref_put(&driver->kref, destruct_tty_driver); 3296 } 3297 EXPORT_SYMBOL(tty_driver_kref_put); 3298 3299 void tty_set_operations(struct tty_driver *driver, 3300 const struct tty_operations *op) 3301 { 3302 driver->ops = op; 3303 }; 3304 EXPORT_SYMBOL(tty_set_operations); 3305 3306 void put_tty_driver(struct tty_driver *d) 3307 { 3308 tty_driver_kref_put(d); 3309 } 3310 EXPORT_SYMBOL(put_tty_driver); 3311 3312 /* 3313 * Called by a tty driver to register itself. 3314 */ 3315 int tty_register_driver(struct tty_driver *driver) 3316 { 3317 int error; 3318 int i; 3319 dev_t dev; 3320 struct device *d; 3321 3322 if (!driver->major) { 3323 error = alloc_chrdev_region(&dev, driver->minor_start, 3324 driver->num, driver->name); 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); 3331 error = register_chrdev_region(dev, driver->num, driver->name); 3332 } 3333 if (error < 0) 3334 goto err; 3335 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 } 3341 3342 mutex_lock(&tty_mutex); 3343 list_add(&driver->tty_drivers, &tty_drivers); 3344 mutex_unlock(&tty_mutex); 3345 3346 if (!(driver->flags & TTY_DRIVER_DYNAMIC_DEV)) { 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); 3351 goto err_unreg_devs; 3352 } 3353 } 3354 } 3355 proc_tty_register_driver(driver); 3356 driver->flags |= TTY_DRIVER_INSTALLED; 3357 return 0; 3358 3359 err_unreg_devs: 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 3367 err_unreg_char: 3368 unregister_chrdev_region(dev, driver->num); 3369 err: 3370 return error; 3371 } 3372 EXPORT_SYMBOL(tty_register_driver); 3373 3374 /* 3375 * Called by a tty driver to unregister itself. 3376 */ 3377 int tty_unregister_driver(struct tty_driver *driver) 3378 { 3379 #if 0 3380 /* FIXME */ 3381 if (driver->refcount) 3382 return -EBUSY; 3383 #endif 3384 unregister_chrdev_region(MKDEV(driver->major, driver->minor_start), 3385 driver->num); 3386 mutex_lock(&tty_mutex); 3387 list_del(&driver->tty_drivers); 3388 mutex_unlock(&tty_mutex); 3389 return 0; 3390 } 3391 3392 EXPORT_SYMBOL(tty_unregister_driver); 3393 3394 dev_t tty_devnum(struct tty_struct *tty) 3395 { 3396 return MKDEV(tty->driver->major, tty->driver->minor_start) + tty->index; 3397 } 3398 EXPORT_SYMBOL(tty_devnum); 3399 3400 void tty_default_fops(struct file_operations *fops) 3401 { 3402 *fops = tty_fops; 3403 } 3404 3405 static char *tty_devnode(struct device *dev, umode_t *mode) 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 3415 static int __init tty_class_init(void) 3416 { 3417 tty_class = class_create(THIS_MODULE, "tty"); 3418 if (IS_ERR(tty_class)) 3419 return PTR_ERR(tty_class); 3420 tty_class->devnode = tty_devnode; 3421 return 0; 3422 } 3423 3424 postcore_initcall(tty_class_init); 3425 3426 /* 3/2004 jmc: why do these devices exist? */ 3427 static struct cdev tty_cdev, console_cdev; 3428 3429 static 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 3437 console_lock(); 3438 for_each_console(c) { 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 } 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 } 3462 console_unlock(); 3463 3464 return count; 3465 } 3466 static DEVICE_ATTR(active, S_IRUGO, show_cons_active, NULL); 3467 3468 static struct attribute *cons_dev_attrs[] = { 3469 &dev_attr_active.attr, 3470 NULL 3471 }; 3472 3473 ATTRIBUTE_GROUPS(cons_dev); 3474 3475 static struct device *consdev; 3476 3477 void console_sysfs_notify(void) 3478 { 3479 if (consdev) 3480 sysfs_notify(&consdev->kobj, NULL, "active"); 3481 } 3482 3483 /* 3484 * Ok, now we can initialize the rest of the tty devices and can count 3485 * on memory allocations, interrupts etc.. 3486 */ 3487 int __init tty_init(void) 3488 { 3489 tty_sysctl_init(); 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"); 3494 device_create(tty_class, NULL, MKDEV(TTYAUX_MAJOR, 0), NULL, "tty"); 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"); 3500 consdev = device_create_with_groups(tty_class, NULL, 3501 MKDEV(TTYAUX_MAJOR, 1), NULL, 3502 cons_dev_groups, "console"); 3503 if (IS_ERR(consdev)) 3504 consdev = NULL; 3505 3506 #ifdef CONFIG_VT 3507 vty_init(&console_fops); 3508 #endif 3509 return 0; 3510 } 3511 3512