drivers/tty/pty.c

   1 /*
   2  *  Copyright (C) 1991, 1992  Linus Torvalds
   3  *
   4  *  Added support for a Unix98-style ptmx device.
   5  *    -- C. Scott Ananian <cananian@alumni.princeton.edu>, 14-Jan-1998
   6  *
   7  */
   8
   9 #include <linux/module.h>
  10
  11 #include <linux/errno.h>
  12 #include <linux/interrupt.h>
  13 #include <linux/tty.h>
  14 #include <linux/tty_flip.h>
  15 #include <linux/fcntl.h>
  16 #include <linux/sched.h>
  17 #include <linux/string.h>
  18 #include <linux/major.h>
  19 #include <linux/mm.h>
  20 #include <linux/init.h>
  21 #include <linux/device.h>
  22 #include <linux/uaccess.h>
  23 #include <linux/bitops.h>
  24 #include <linux/devpts_fs.h>
  25 #include <linux/slab.h>
  26 #include <linux/mutex.h>
  27 #include <linux/poll.h>
  28
  29
  30 #ifdef CONFIG_UNIX98_PTYS
  31 static struct tty_driver *ptm_driver;
  32 static struct tty_driver *pts_driver;
  33 static DEFINE_MUTEX(devpts_mutex);
  34 #endif
  35
  36 static void pty_close(struct tty_struct *tty, struct file *filp)
  37 {
  38         BUG_ON(!tty);
  39         if (tty->driver->subtype == PTY_TYPE_MASTER)
  40                 WARN_ON(tty->count > 1);
  41         else {
  42                 if (test_bit(TTY_IO_ERROR, &tty->flags))
  43                         return;
  44                 if (tty->count > 2)
  45                         return;
  46         }
  47         set_bit(TTY_IO_ERROR, &tty->flags);
  48         wake_up_interruptible(&tty->read_wait);
  49         wake_up_interruptible(&tty->write_wait);
  50         spin_lock_irq(&tty->ctrl_lock);
  51         tty->packet = 0;
  52         spin_unlock_irq(&tty->ctrl_lock);
  53         /* Review - krefs on tty_link ?? */
  54         if (!tty->link)
  55                 return;
  56         tty_flush_to_ldisc(tty->link);
  57         set_bit(TTY_OTHER_CLOSED, &tty->link->flags);
  58         wake_up_interruptible(&tty->link->read_wait);
  59         wake_up_interruptible(&tty->link->write_wait);
  60         if (tty->driver->subtype == PTY_TYPE_MASTER) {
  61                 set_bit(TTY_OTHER_CLOSED, &tty->flags);
  62 #ifdef CONFIG_UNIX98_PTYS
  63                 if (tty->driver == ptm_driver) {
  64                         mutex_lock(&devpts_mutex);
  65                         if (tty->link->driver_data)
  66                                 devpts_pty_kill(tty->link->driver_data);
  67                         mutex_unlock(&devpts_mutex);
  68                 }
  69 #endif
  70                 tty_vhangup(tty->link);
  71         }
  72 }
  73
  74 /*
  75  * The unthrottle routine is called by the line discipline to signal
  76  * that it can receive more characters.  For PTY's, the TTY_THROTTLED
  77  * flag is always set, to force the line discipline to always call the
  78  * unthrottle routine when there are fewer than TTY_THRESHOLD_UNTHROTTLE
  79  * characters in the queue.  This is necessary since each time this
  80  * happens, we need to wake up any sleeping processes that could be
  81  * (1) trying to send data to the pty, or (2) waiting in wait_until_sent()
  82  * for the pty buffer to be drained.
  83  */
  84 static void pty_unthrottle(struct tty_struct *tty)
  85 {
  86         tty_wakeup(tty->link);
  87         set_bit(TTY_THROTTLED, &tty->flags);
  88 }
  89
  90 /**
  91  *      pty_write               -       write to a pty
  92  *      @tty: the tty we write from
  93  *      @buf: kernel buffer of data
  94  *      @count: bytes to write
  95  *
  96  *      Our "hardware" write method. Data is coming from the ldisc which
  97  *      may be in a non sleeping state. We simply throw this at the other
  98  *      end of the link as if we were an IRQ handler receiving stuff for
  99  *      the other side of the pty/tty pair.
 100  */
 101
 102 static int pty_write(struct tty_struct *tty, const unsigned char *buf, int c)
 103 {
 104         struct tty_struct *to = tty->link;
 105
 106         if (tty->stopped)
 107                 return 0;
 108
 109         if (c > 0) {
 110                 /* Stuff the data into the input queue of the other end */
 111                 c = tty_insert_flip_string(to->port, buf, c);
 112                 /* And shovel */
 113                 if (c)
 114                         tty_flip_buffer_push(to->port);
 115         }
 116         return c;
 117 }
 118
 119 /**
 120  *      pty_write_room  -       write space
 121  *      @tty: tty we are writing from
 122  *
 123  *      Report how many bytes the ldisc can send into the queue for
 124  *      the other device.
 125  */
 126
 127 static int pty_write_room(struct tty_struct *tty)
 128 {
 129         if (tty->stopped)
 130                 return 0;
 131         return tty_buffer_space_avail(tty->link->port);
 132 }
 133
 134 /**
 135  *      pty_chars_in_buffer     -       characters currently in our tx queue
 136  *      @tty: our tty
 137  *
 138  *      Report how much we have in the transmit queue. As everything is
 139  *      instantly at the other end this is easy to implement.
 140  */
 141
 142 static int pty_chars_in_buffer(struct tty_struct *tty)
 143 {
 144         return 0;
 145 }
 146
 147 /* Set the lock flag on a pty */
 148 static int pty_set_lock(struct tty_struct *tty, int __user *arg)
 149 {
 150         int val;
 151         if (get_user(val, arg))
 152                 return -EFAULT;
 153         if (val)
 154                 set_bit(TTY_PTY_LOCK, &tty->flags);
 155         else
 156                 clear_bit(TTY_PTY_LOCK, &tty->flags);
 157         return 0;
 158 }
 159
 160 static int pty_get_lock(struct tty_struct *tty, int __user *arg)
 161 {
 162         int locked = test_bit(TTY_PTY_LOCK, &tty->flags);
 163         return put_user(locked, arg);
 164 }
 165
 166 /* Set the packet mode on a pty */
 167 static int pty_set_pktmode(struct tty_struct *tty, int __user *arg)
 168 {
 169         int pktmode;
 170
 171         if (get_user(pktmode, arg))
 172                 return -EFAULT;
 173
 174         spin_lock_irq(&tty->ctrl_lock);
 175         if (pktmode) {
 176                 if (!tty->packet) {
 177                         tty->link->ctrl_status = 0;
 178                         smp_mb();
 179                         tty->packet = 1;
 180                 }
 181         } else
 182                 tty->packet = 0;
 183         spin_unlock_irq(&tty->ctrl_lock);
 184
 185         return 0;
 186 }
 187
 188 /* Get the packet mode of a pty */
 189 static int pty_get_pktmode(struct tty_struct *tty, int __user *arg)
 190 {
 191         int pktmode = tty->packet;
 192         return put_user(pktmode, arg);
 193 }
 194
 195 /* Send a signal to the slave */
 196 static int pty_signal(struct tty_struct *tty, int sig)
 197 {
 198         struct pid *pgrp;
 199
 200         if (sig != SIGINT && sig != SIGQUIT && sig != SIGTSTP)
 201                 return -EINVAL;
 202
 203         if (tty->link) {
 204                 pgrp = tty_get_pgrp(tty->link);
 205                 if (pgrp)
 206                         kill_pgrp(pgrp, sig, 1);
 207                 put_pid(pgrp);
 208         }
 209         return 0;
 210 }
 211
 212 static void pty_flush_buffer(struct tty_struct *tty)
 213 {
 214         struct tty_struct *to = tty->link;
 215         struct tty_ldisc *ld;
 216
 217         if (!to)
 218                 return;
 219
 220         ld = tty_ldisc_ref(to);
 221         tty_buffer_flush(to, ld);
 222         if (ld)
 223                 tty_ldisc_deref(ld);
 224
 225         if (to->packet) {
 226                 spin_lock_irq(&tty->ctrl_lock);
 227                 tty->ctrl_status |= TIOCPKT_FLUSHWRITE;
 228                 wake_up_interruptible(&to->read_wait);
 229                 spin_unlock_irq(&tty->ctrl_lock);
 230         }
 231 }
 232
 233 static int pty_open(struct tty_struct *tty, struct file *filp)
 234 {
 235         if (!tty || !tty->link)
 236                 return -ENODEV;
 237
 238         if (test_bit(TTY_OTHER_CLOSED, &tty->flags))
 239                 goto out;
 240         if (test_bit(TTY_PTY_LOCK, &tty->link->flags))
 241                 goto out;
 242         if (tty->driver->subtype == PTY_TYPE_SLAVE && tty->link->count != 1)
 243                 goto out;
 244
 245         clear_bit(TTY_IO_ERROR, &tty->flags);
 246         clear_bit(TTY_OTHER_CLOSED, &tty->link->flags);
 247         set_bit(TTY_THROTTLED, &tty->flags);
 248         return 0;
 249
 250 out:
 251         set_bit(TTY_IO_ERROR, &tty->flags);
 252         return -EIO;
 253 }
 254
 255 static void pty_set_termios(struct tty_struct *tty,
 256                                         struct ktermios *old_termios)
 257 {
 258         /* See if packet mode change of state. */
 259         if (tty->link && tty->link->packet) {
 260                 int extproc = (old_termios->c_lflag & EXTPROC) |
 261                                 (tty->termios.c_lflag & EXTPROC);
 262                 int old_flow = ((old_termios->c_iflag & IXON) &&
 263                                 (old_termios->c_cc[VSTOP] == '\023') &&
 264                                 (old_termios->c_cc[VSTART] == '\021'));
 265                 int new_flow = (I_IXON(tty) &&
 266                                 STOP_CHAR(tty) == '\023' &&
 267                                 START_CHAR(tty) == '\021');
 268                 if ((old_flow != new_flow) || extproc) {
 269                         spin_lock_irq(&tty->ctrl_lock);
 270                         if (old_flow != new_flow) {
 271                                 tty->ctrl_status &= ~(TIOCPKT_DOSTOP | TIOCPKT_NOSTOP);
 272                                 if (new_flow)
 273                                         tty->ctrl_status |= TIOCPKT_DOSTOP;
 274                                 else
 275                                         tty->ctrl_status |= TIOCPKT_NOSTOP;
 276                         }
 277                         if (extproc)
 278                                 tty->ctrl_status |= TIOCPKT_IOCTL;
 279                         spin_unlock_irq(&tty->ctrl_lock);
 280                         wake_up_interruptible(&tty->link->read_wait);
 281                 }
 282         }
 283
 284         tty->termios.c_cflag &= ~(CSIZE | PARENB);
 285         tty->termios.c_cflag |= (CS8 | CREAD);
 286 }
 287
 288 /**
 289  *      pty_do_resize           -       resize event
 290  *      @tty: tty being resized
 291  *      @ws: window size being set.
 292  *
 293  *      Update the termios variables and send the necessary signals to
 294  *      peform a terminal resize correctly
 295  */
 296
 297 static int pty_resize(struct tty_struct *tty,  struct winsize *ws)
 298 {
 299         struct pid *pgrp, *rpgrp;
 300         struct tty_struct *pty = tty->link;
 301
 302         /* For a PTY we need to lock the tty side */
 303         mutex_lock(&tty->winsize_mutex);
 304         if (!memcmp(ws, &tty->winsize, sizeof(*ws)))
 305                 goto done;
 306
 307         /* Signal the foreground process group of both ptys */
 308         pgrp = tty_get_pgrp(tty);
 309         rpgrp = tty_get_pgrp(pty);
 310
 311         if (pgrp)
 312                 kill_pgrp(pgrp, SIGWINCH, 1);
 313         if (rpgrp != pgrp && rpgrp)
 314                 kill_pgrp(rpgrp, SIGWINCH, 1);
 315
 316         put_pid(pgrp);
 317         put_pid(rpgrp);
 318
 319         tty->winsize = *ws;
 320         pty->winsize = *ws;     /* Never used so will go away soon */
 321 done:
 322         mutex_unlock(&tty->winsize_mutex);
 323         return 0;
 324 }
 325
 326 /**
 327  *      pty_start - start() handler
 328  *      pty_stop  - stop() handler
 329  *      @tty: tty being flow-controlled
 330  *
 331  *      Propagates the TIOCPKT status to the master pty.
 332  *
 333  *      NB: only the master pty can be in packet mode so only the slave
 334  *          needs start()/stop() handlers
 335  */
 336 static void pty_start(struct tty_struct *tty)
 337 {
 338         unsigned long flags;
 339
 340         if (tty->link && tty->link->packet) {
 341                 spin_lock_irqsave(&tty->ctrl_lock, flags);
 342                 tty->ctrl_status &= ~TIOCPKT_STOP;
 343                 tty->ctrl_status |= TIOCPKT_START;
 344                 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
 345                 wake_up_interruptible_poll(&tty->link->read_wait, POLLIN);
 346         }
 347 }
 348
 349 static void pty_stop(struct tty_struct *tty)
 350 {
 351         unsigned long flags;
 352
 353         if (tty->link && tty->link->packet) {
 354                 spin_lock_irqsave(&tty->ctrl_lock, flags);
 355                 tty->ctrl_status &= ~TIOCPKT_START;
 356                 tty->ctrl_status |= TIOCPKT_STOP;
 357                 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
 358                 wake_up_interruptible_poll(&tty->link->read_wait, POLLIN);
 359         }
 360 }
 361
 362 /**
 363  *      pty_common_install              -       set up the pty pair
 364  *      @driver: the pty driver
 365  *      @tty: the tty being instantiated
 366  *      @legacy: true if this is BSD style
 367  *
 368  *      Perform the initial set up for the tty/pty pair. Called from the
 369  *      tty layer when the port is first opened.
 370  *
 371  *      Locking: the caller must hold the tty_mutex
 372  */
 373 static int pty_common_install(struct tty_driver *driver, struct tty_struct *tty,
 374                 bool legacy)
 375 {
 376         struct tty_struct *o_tty;
 377         struct tty_port *ports[2];
 378         int idx = tty->index;
 379         int retval = -ENOMEM;
 380
 381         /* Opening the slave first has always returned -EIO */
 382         if (driver->subtype != PTY_TYPE_MASTER)
 383                 return -EIO;
 384
 385         ports[0] = kmalloc(sizeof **ports, GFP_KERNEL);
 386         ports[1] = kmalloc(sizeof **ports, GFP_KERNEL);
 387         if (!ports[0] || !ports[1])
 388                 goto err;
 389         if (!try_module_get(driver->other->owner)) {
 390                 /* This cannot in fact currently happen */
 391                 goto err;
 392         }
 393         o_tty = alloc_tty_struct(driver->other, idx);
 394         if (!o_tty)
 395                 goto err_put_module;
 396
 397         tty_set_lock_subclass(o_tty);
 398
 399         if (legacy) {
 400                 /* We always use new tty termios data so we can do this
 401                    the easy way .. */
 402                 retval = tty_init_termios(tty);
 403                 if (retval)
 404                         goto err_deinit_tty;
 405
 406                 retval = tty_init_termios(o_tty);
 407                 if (retval)
 408                         goto err_free_termios;
 409
 410                 driver->other->ttys[idx] = o_tty;
 411                 driver->ttys[idx] = tty;
 412         } else {
 413                 memset(&tty->termios_locked, 0, sizeof(tty->termios_locked));
 414                 tty->termios = driver->init_termios;
 415                 memset(&o_tty->termios_locked, 0, sizeof(tty->termios_locked));
 416                 o_tty->termios = driver->other->init_termios;
 417         }
 418
 419         /*
 420          * Everything allocated ... set up the o_tty structure.
 421          */
 422         tty_driver_kref_get(driver->other);
 423         /* Establish the links in both directions */
 424         tty->link   = o_tty;
 425         o_tty->link = tty;
 426         tty_port_init(ports[0]);
 427         tty_port_init(ports[1]);
 428         tty_buffer_set_limit(ports[0], 8192);
 429         tty_buffer_set_limit(ports[1], 8192);
 430         o_tty->port = ports[0];
 431         tty->port = ports[1];
 432         o_tty->port->itty = o_tty;
 433
 434         tty_buffer_set_lock_subclass(o_tty->port);
 435
 436         tty_driver_kref_get(driver);
 437         tty->count++;
 438         o_tty->count++;
 439         return 0;
 440 err_free_termios:
 441         if (legacy)
 442                 tty_free_termios(tty);
 443 err_deinit_tty:
 444         deinitialize_tty_struct(o_tty);
 445         free_tty_struct(o_tty);
 446 err_put_module:
 447         module_put(driver->other->owner);
 448 err:
 449         kfree(ports[0]);
 450         kfree(ports[1]);
 451         return retval;
 452 }
 453
 454 static void pty_cleanup(struct tty_struct *tty)
 455 {
 456         tty_port_put(tty->port);
 457 }
 458
 459 /* Traditional BSD devices */
 460 #ifdef CONFIG_LEGACY_PTYS
 461
 462 static int pty_install(struct tty_driver *driver, struct tty_struct *tty)
 463 {
 464         return pty_common_install(driver, tty, true);
 465 }
 466
 467 static void pty_remove(struct tty_driver *driver, struct tty_struct *tty)
 468 {
 469         struct tty_struct *pair = tty->link;
 470         driver->ttys[tty->index] = NULL;
 471         if (pair)
 472                 pair->driver->ttys[pair->index] = NULL;
 473 }
 474
 475 static int pty_bsd_ioctl(struct tty_struct *tty,
 476                          unsigned int cmd, unsigned long arg)
 477 {
 478         switch (cmd) {
 479         case TIOCSPTLCK: /* Set PT Lock (disallow slave open) */
 480                 return pty_set_lock(tty, (int __user *) arg);
 481         case TIOCGPTLCK: /* Get PT Lock status */
 482                 return pty_get_lock(tty, (int __user *)arg);
 483         case TIOCPKT: /* Set PT packet mode */
 484                 return pty_set_pktmode(tty, (int __user *)arg);
 485         case TIOCGPKT: /* Get PT packet mode */
 486                 return pty_get_pktmode(tty, (int __user *)arg);
 487         case TIOCSIG:    /* Send signal to other side of pty */
 488                 return pty_signal(tty, (int) arg);
 489         case TIOCGPTN: /* TTY returns ENOTTY, but glibc expects EINVAL here */
 490                 return -EINVAL;
 491         }
 492         return -ENOIOCTLCMD;
 493 }
 494
 495 static int legacy_count = CONFIG_LEGACY_PTY_COUNT;
 496 module_param(legacy_count, int, 0);
 497
 498 /*
 499  * The master side of a pty can do TIOCSPTLCK and thus
 500  * has pty_bsd_ioctl.
 501  */
 502 static const struct tty_operations master_pty_ops_bsd = {
 503         .install = pty_install,
 504         .open = pty_open,
 505         .close = pty_close,
 506         .write = pty_write,
 507         .write_room = pty_write_room,
 508         .flush_buffer = pty_flush_buffer,
 509         .chars_in_buffer = pty_chars_in_buffer,
 510         .unthrottle = pty_unthrottle,
 511         .ioctl = pty_bsd_ioctl,
 512         .cleanup = pty_cleanup,
 513         .resize = pty_resize,
 514         .remove = pty_remove
 515 };
 516
 517 static const struct tty_operations slave_pty_ops_bsd = {
 518         .install = pty_install,
 519         .open = pty_open,
 520         .close = pty_close,
 521         .write = pty_write,
 522         .write_room = pty_write_room,
 523         .flush_buffer = pty_flush_buffer,
 524         .chars_in_buffer = pty_chars_in_buffer,
 525         .unthrottle = pty_unthrottle,
 526         .set_termios = pty_set_termios,
 527         .cleanup = pty_cleanup,
 528         .resize = pty_resize,
 529         .start = pty_start,
 530         .stop = pty_stop,
 531         .remove = pty_remove
 532 };
 533
 534 static void __init legacy_pty_init(void)
 535 {
 536         struct tty_driver *pty_driver, *pty_slave_driver;
 537
 538         if (legacy_count <= 0)
 539                 return;
 540
 541         pty_driver = tty_alloc_driver(legacy_count,
 542                         TTY_DRIVER_RESET_TERMIOS |
 543                         TTY_DRIVER_REAL_RAW |
 544                         TTY_DRIVER_DYNAMIC_ALLOC);
 545         if (IS_ERR(pty_driver))
 546                 panic("Couldn't allocate pty driver");
 547
 548         pty_slave_driver = tty_alloc_driver(legacy_count,
 549                         TTY_DRIVER_RESET_TERMIOS |
 550                         TTY_DRIVER_REAL_RAW |
 551                         TTY_DRIVER_DYNAMIC_ALLOC);
 552         if (IS_ERR(pty_slave_driver))
 553                 panic("Couldn't allocate pty slave driver");
 554
 555         pty_driver->driver_name = "pty_master";
 556         pty_driver->name = "pty";
 557         pty_driver->major = PTY_MASTER_MAJOR;
 558         pty_driver->minor_start = 0;
 559         pty_driver->type = TTY_DRIVER_TYPE_PTY;
 560         pty_driver->subtype = PTY_TYPE_MASTER;
 561         pty_driver->init_termios = tty_std_termios;
 562         pty_driver->init_termios.c_iflag = 0;
 563         pty_driver->init_termios.c_oflag = 0;
 564         pty_driver->init_termios.c_cflag = B38400 | CS8 | CREAD;
 565         pty_driver->init_termios.c_lflag = 0;
 566         pty_driver->init_termios.c_ispeed = 38400;
 567         pty_driver->init_termios.c_ospeed = 38400;
 568         pty_driver->other = pty_slave_driver;
 569         tty_set_operations(pty_driver, &master_pty_ops_bsd);
 570
 571         pty_slave_driver->driver_name = "pty_slave";
 572         pty_slave_driver->name = "ttyp";
 573         pty_slave_driver->major = PTY_SLAVE_MAJOR;
 574         pty_slave_driver->minor_start = 0;
 575         pty_slave_driver->type = TTY_DRIVER_TYPE_PTY;
 576         pty_slave_driver->subtype = PTY_TYPE_SLAVE;
 577         pty_slave_driver->init_termios = tty_std_termios;
 578         pty_slave_driver->init_termios.c_cflag = B38400 | CS8 | CREAD;
 579         pty_slave_driver->init_termios.c_ispeed = 38400;
 580         pty_slave_driver->init_termios.c_ospeed = 38400;
 581         pty_slave_driver->other = pty_driver;
 582         tty_set_operations(pty_slave_driver, &slave_pty_ops_bsd);
 583
 584         if (tty_register_driver(pty_driver))
 585                 panic("Couldn't register pty driver");
 586         if (tty_register_driver(pty_slave_driver))
 587                 panic("Couldn't register pty slave driver");
 588 }
 589 #else
 590 static inline void legacy_pty_init(void) { }
 591 #endif
 592
 593 /* Unix98 devices */
 594 #ifdef CONFIG_UNIX98_PTYS
 595
 596 static struct cdev ptmx_cdev;
 597
 598 static int pty_unix98_ioctl(struct tty_struct *tty,
 599                             unsigned int cmd, unsigned long arg)
 600 {
 601         switch (cmd) {
 602         case TIOCSPTLCK: /* Set PT Lock (disallow slave open) */
 603                 return pty_set_lock(tty, (int __user *)arg);
 604         case TIOCGPTLCK: /* Get PT Lock status */
 605                 return pty_get_lock(tty, (int __user *)arg);
 606         case TIOCPKT: /* Set PT packet mode */
 607                 return pty_set_pktmode(tty, (int __user *)arg);
 608         case TIOCGPKT: /* Get PT packet mode */
 609                 return pty_get_pktmode(tty, (int __user *)arg);
 610         case TIOCGPTN: /* Get PT Number */
 611                 return put_user(tty->index, (unsigned int __user *)arg);
 612         case TIOCSIG:    /* Send signal to other side of pty */
 613                 return pty_signal(tty, (int) arg);
 614         }
 615
 616         return -ENOIOCTLCMD;
 617 }
 618
 619 /**
 620  *      ptm_unix98_lookup       -       find a pty master
 621  *      @driver: ptm driver
 622  *      @idx: tty index
 623  *
 624  *      Look up a pty master device. Called under the tty_mutex for now.
 625  *      This provides our locking.
 626  */
 627
 628 static struct tty_struct *ptm_unix98_lookup(struct tty_driver *driver,
 629                 struct inode *ptm_inode, int idx)
 630 {
 631         /* Master must be open via /dev/ptmx */
 632         return ERR_PTR(-EIO);
 633 }
 634
 635 /**
 636  *      pts_unix98_lookup       -       find a pty slave
 637  *      @driver: pts driver
 638  *      @idx: tty index
 639  *
 640  *      Look up a pty master device. Called under the tty_mutex for now.
 641  *      This provides our locking for the tty pointer.
 642  */
 643
 644 static struct tty_struct *pts_unix98_lookup(struct tty_driver *driver,
 645                 struct inode *pts_inode, int idx)
 646 {
 647         struct tty_struct *tty;
 648
 649         mutex_lock(&devpts_mutex);
 650         tty = devpts_get_priv(pts_inode);
 651         mutex_unlock(&devpts_mutex);
 652         /* Master must be open before slave */
 653         if (!tty)
 654                 return ERR_PTR(-EIO);
 655         return tty;
 656 }
 657
 658 /* We have no need to install and remove our tty objects as devpts does all
 659    the work for us */
 660
 661 static int pty_unix98_install(struct tty_driver *driver, struct tty_struct *tty)
 662 {
 663         return pty_common_install(driver, tty, false);
 664 }
 665
 666 static void pty_unix98_remove(struct tty_driver *driver, struct tty_struct *tty)
 667 {
 668 }
 669
 670 /* this is called once with whichever end is closed last */
 671 static void pty_unix98_shutdown(struct tty_struct *tty)
 672 {
 673         devpts_kill_index(tty->driver_data, tty->index);
 674 }
 675
 676 static const struct tty_operations ptm_unix98_ops = {
 677         .lookup = ptm_unix98_lookup,
 678         .install = pty_unix98_install,
 679         .remove = pty_unix98_remove,
 680         .open = pty_open,
 681         .close = pty_close,
 682         .write = pty_write,
 683         .write_room = pty_write_room,
 684         .flush_buffer = pty_flush_buffer,
 685         .chars_in_buffer = pty_chars_in_buffer,
 686         .unthrottle = pty_unthrottle,
 687         .ioctl = pty_unix98_ioctl,
 688         .resize = pty_resize,
 689         .shutdown = pty_unix98_shutdown,
 690         .cleanup = pty_cleanup
 691 };
 692
 693 static const struct tty_operations pty_unix98_ops = {
 694         .lookup = pts_unix98_lookup,
 695         .install = pty_unix98_install,
 696         .remove = pty_unix98_remove,
 697         .open = pty_open,
 698         .close = pty_close,
 699         .write = pty_write,
 700         .write_room = pty_write_room,
 701         .flush_buffer = pty_flush_buffer,
 702         .chars_in_buffer = pty_chars_in_buffer,
 703         .unthrottle = pty_unthrottle,
 704         .set_termios = pty_set_termios,
 705         .start = pty_start,
 706         .stop = pty_stop,
 707         .shutdown = pty_unix98_shutdown,
 708         .cleanup = pty_cleanup,
 709 };
 710
 711 /**
 712  *      ptmx_open               -       open a unix 98 pty master
 713  *      @inode: inode of device file
 714  *      @filp: file pointer to tty
 715  *
 716  *      Allocate a unix98 pty master device from the ptmx driver.
 717  *
 718  *      Locking: tty_mutex protects the init_dev work. tty->count should
 719  *              protect the rest.
 720  *              allocated_ptys_lock handles the list of free pty numbers
 721  */
 722
 723 static int ptmx_open(struct inode *inode, struct file *filp)
 724 {
 725         struct tty_struct *tty;
 726         struct inode *slave_inode;
 727         int retval;
 728         int index;
 729
 730         nonseekable_open(inode, filp);
 731
 732         /* We refuse fsnotify events on ptmx, since it's a shared resource */
 733         filp->f_mode |= FMODE_NONOTIFY;
 734
 735         retval = tty_alloc_file(filp);
 736         if (retval)
 737                 return retval;
 738
 739         /* find a device that is not in use. */
 740         mutex_lock(&devpts_mutex);
 741         index = devpts_new_index(inode);
 742         if (index < 0) {
 743                 retval = index;
 744                 mutex_unlock(&devpts_mutex);
 745                 goto err_file;
 746         }
 747
 748         mutex_unlock(&devpts_mutex);
 749
 750         mutex_lock(&tty_mutex);
 751         tty = tty_init_dev(ptm_driver, index);
 752
 753         if (IS_ERR(tty)) {
 754                 retval = PTR_ERR(tty);
 755                 goto out;
 756         }
 757
 758         /* The tty returned here is locked so we can safely
 759            drop the mutex */
 760         mutex_unlock(&tty_mutex);
 761
 762         set_bit(TTY_PTY_LOCK, &tty->flags); /* LOCK THE SLAVE */
 763         tty->driver_data = inode;
 764
 765         tty_add_file(tty, filp);
 766
 767         slave_inode = devpts_pty_new(inode,
 768                         MKDEV(UNIX98_PTY_SLAVE_MAJOR, index), index,
 769                         tty->link);
 770         if (IS_ERR(slave_inode)) {
 771                 retval = PTR_ERR(slave_inode);
 772                 goto err_release;
 773         }
 774         tty->link->driver_data = slave_inode;
 775
 776         retval = ptm_driver->ops->open(tty, filp);
 777         if (retval)
 778                 goto err_release;
 779
 780         tty_unlock(tty);
 781         return 0;
 782 err_release:
 783         tty_unlock(tty);
 784         tty_release(inode, filp);
 785         return retval;
 786 out:
 787         mutex_unlock(&tty_mutex);
 788         devpts_kill_index(inode, index);
 789 err_file:
 790         tty_free_file(filp);
 791         return retval;
 792 }
 793
 794 static struct file_operations ptmx_fops;
 795
 796 static void __init unix98_pty_init(void)
 797 {
 798         ptm_driver = tty_alloc_driver(NR_UNIX98_PTY_MAX,
 799                         TTY_DRIVER_RESET_TERMIOS |
 800                         TTY_DRIVER_REAL_RAW |
 801                         TTY_DRIVER_DYNAMIC_DEV |
 802                         TTY_DRIVER_DEVPTS_MEM |
 803                         TTY_DRIVER_DYNAMIC_ALLOC);
 804         if (IS_ERR(ptm_driver))
 805                 panic("Couldn't allocate Unix98 ptm driver");
 806         pts_driver = tty_alloc_driver(NR_UNIX98_PTY_MAX,
 807                         TTY_DRIVER_RESET_TERMIOS |
 808                         TTY_DRIVER_REAL_RAW |
 809                         TTY_DRIVER_DYNAMIC_DEV |
 810                         TTY_DRIVER_DEVPTS_MEM |
 811                         TTY_DRIVER_DYNAMIC_ALLOC);
 812         if (IS_ERR(pts_driver))
 813                 panic("Couldn't allocate Unix98 pts driver");
 814
 815         ptm_driver->driver_name = "pty_master";
 816         ptm_driver->name = "ptm";
 817         ptm_driver->major = UNIX98_PTY_MASTER_MAJOR;
 818         ptm_driver->minor_start = 0;
 819         ptm_driver->type = TTY_DRIVER_TYPE_PTY;
 820         ptm_driver->subtype = PTY_TYPE_MASTER;
 821         ptm_driver->init_termios = tty_std_termios;
 822         ptm_driver->init_termios.c_iflag = 0;
 823         ptm_driver->init_termios.c_oflag = 0;
 824         ptm_driver->init_termios.c_cflag = B38400 | CS8 | CREAD;
 825         ptm_driver->init_termios.c_lflag = 0;
 826         ptm_driver->init_termios.c_ispeed = 38400;
 827         ptm_driver->init_termios.c_ospeed = 38400;
 828         ptm_driver->other = pts_driver;
 829         tty_set_operations(ptm_driver, &ptm_unix98_ops);
 830
 831         pts_driver->driver_name = "pty_slave";
 832         pts_driver->name = "pts";
 833         pts_driver->major = UNIX98_PTY_SLAVE_MAJOR;
 834         pts_driver->minor_start = 0;
 835         pts_driver->type = TTY_DRIVER_TYPE_PTY;
 836         pts_driver->subtype = PTY_TYPE_SLAVE;
 837         pts_driver->init_termios = tty_std_termios;
 838         pts_driver->init_termios.c_cflag = B38400 | CS8 | CREAD;
 839         pts_driver->init_termios.c_ispeed = 38400;
 840         pts_driver->init_termios.c_ospeed = 38400;
 841         pts_driver->other = ptm_driver;
 842         tty_set_operations(pts_driver, &pty_unix98_ops);
 843
 844         if (tty_register_driver(ptm_driver))
 845                 panic("Couldn't register Unix98 ptm driver");
 846         if (tty_register_driver(pts_driver))
 847                 panic("Couldn't register Unix98 pts driver");
 848
 849         /* Now create the /dev/ptmx special device */
 850         tty_default_fops(&ptmx_fops);
 851         ptmx_fops.open = ptmx_open;
 852
 853         cdev_init(&ptmx_cdev, &ptmx_fops);
 854         if (cdev_add(&ptmx_cdev, MKDEV(TTYAUX_MAJOR, 2), 1) ||
 855             register_chrdev_region(MKDEV(TTYAUX_MAJOR, 2), 1, "/dev/ptmx") < 0)
 856                 panic("Couldn't register /dev/ptmx driver");
 857         device_create(tty_class, NULL, MKDEV(TTYAUX_MAJOR, 2), NULL, "ptmx");
 858 }
 859
 860 #else
 861 static inline void unix98_pty_init(void) { }
 862 #endif
 863
 864 static int __init pty_init(void)
 865 {
 866         legacy_pty_init();
 867         unix98_pty_init();
 868         return 0;
 869 }
 870 module_init(pty_init);