2 * Copyright (C) 1991, 1992 Linus Torvalds
4 * Added support for a Unix98-style ptmx device.
9 #include <linux/module.h>
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>
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>
29 #ifdef CONFIG_UNIX98_PTYS
30 static struct tty_driver *ptm_driver;
31 static struct tty_driver *pts_driver;
32 static DEFINE_MUTEX(devpts_mutex);
35 static void pty_close(struct tty_struct *tty, struct file *filp)
38 if (tty->driver->subtype == PTY_TYPE_MASTER)
39 WARN_ON(tty->count > 1);
41 if (test_bit(TTY_IO_ERROR, &tty->flags))
46 set_bit(TTY_IO_ERROR, &tty->flags);
47 wake_up_interruptible(&tty->read_wait);
48 wake_up_interruptible(&tty->write_wait);
50 /* Review - krefs on tty_link ?? */
53 set_bit(TTY_OTHER_CLOSED, &tty->link->flags);
54 wake_up_interruptible(&tty->link->read_wait);
55 wake_up_interruptible(&tty->link->write_wait);
56 if (tty->driver->subtype == PTY_TYPE_MASTER) {
57 set_bit(TTY_OTHER_CLOSED, &tty->flags);
58 #ifdef CONFIG_UNIX98_PTYS
59 if (tty->driver == ptm_driver) {
60 mutex_lock(&devpts_mutex);
61 if (tty->link->driver_data)
62 devpts_pty_kill(tty->link->driver_data);
63 mutex_unlock(&devpts_mutex);
67 tty_vhangup(tty->link);
73 * The unthrottle routine is called by the line discipline to signal
74 * that it can receive more characters. For PTY's, the TTY_THROTTLED
75 * flag is always set, to force the line discipline to always call the
76 * unthrottle routine when there are fewer than TTY_THRESHOLD_UNTHROTTLE
77 * characters in the queue. This is necessary since each time this
78 * happens, we need to wake up any sleeping processes that could be
79 * (1) trying to send data to the pty, or (2) waiting in wait_until_sent()
80 * for the pty buffer to be drained.
82 static void pty_unthrottle(struct tty_struct *tty)
84 tty_wakeup(tty->link);
85 set_bit(TTY_THROTTLED, &tty->flags);
89 * pty_space - report space left for writing
90 * @to: tty we are writing into
92 * The tty buffers allow 64K but we sneak a peak and clip at 8K this
93 * allows a lot of overspill room for echo and other fun messes to
97 static int pty_space(struct tty_struct *to)
99 int n = 8192 - to->port->buf.memory_used;
106 * pty_write - write to a pty
107 * @tty: the tty we write from
108 * @buf: kernel buffer of data
109 * @count: bytes to write
111 * Our "hardware" write method. Data is coming from the ldisc which
112 * may be in a non sleeping state. We simply throw this at the other
113 * end of the link as if we were an IRQ handler receiving stuff for
114 * the other side of the pty/tty pair.
117 static int pty_write(struct tty_struct *tty, const unsigned char *buf, int c)
119 struct tty_struct *to = tty->link;
125 /* Stuff the data into the input queue of the other end */
126 c = tty_insert_flip_string(to->port, buf, c);
129 tty_flip_buffer_push(to->port);
137 * pty_write_room - write space
138 * @tty: tty we are writing from
140 * Report how many bytes the ldisc can send into the queue for
144 static int pty_write_room(struct tty_struct *tty)
148 return pty_space(tty->link);
152 * pty_chars_in_buffer - characters currently in our tx queue
155 * Report how much we have in the transmit queue. As everything is
156 * instantly at the other end this is easy to implement.
159 static int pty_chars_in_buffer(struct tty_struct *tty)
164 /* Set the lock flag on a pty */
165 static int pty_set_lock(struct tty_struct *tty, int __user *arg)
168 if (get_user(val, arg))
171 set_bit(TTY_PTY_LOCK, &tty->flags);
173 clear_bit(TTY_PTY_LOCK, &tty->flags);
177 static int pty_get_lock(struct tty_struct *tty, int __user *arg)
179 int locked = test_bit(TTY_PTY_LOCK, &tty->flags);
180 return put_user(locked, arg);
183 /* Set the packet mode on a pty */
184 static int pty_set_pktmode(struct tty_struct *tty, int __user *arg)
189 if (get_user(pktmode, arg))
192 spin_lock_irqsave(&tty->ctrl_lock, flags);
196 tty->link->ctrl_status = 0;
200 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
205 /* Get the packet mode of a pty */
206 static int pty_get_pktmode(struct tty_struct *tty, int __user *arg)
208 int pktmode = tty->packet;
209 return put_user(pktmode, arg);
212 /* Send a signal to the slave */
213 static int pty_signal(struct tty_struct *tty, int sig)
219 spin_lock_irqsave(&tty->link->ctrl_lock, flags);
220 pgrp = get_pid(tty->link->pgrp);
221 spin_unlock_irqrestore(&tty->link->ctrl_lock, flags);
223 kill_pgrp(pgrp, sig, 1);
229 static void pty_flush_buffer(struct tty_struct *tty)
231 struct tty_struct *to = tty->link;
236 /* tty_buffer_flush(to); FIXME */
238 spin_lock_irqsave(&tty->ctrl_lock, flags);
239 tty->ctrl_status |= TIOCPKT_FLUSHWRITE;
240 wake_up_interruptible(&to->read_wait);
241 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
245 static int pty_open(struct tty_struct *tty, struct file *filp)
247 int retval = -ENODEV;
249 if (!tty || !tty->link)
252 set_bit(TTY_IO_ERROR, &tty->flags);
255 if (test_bit(TTY_OTHER_CLOSED, &tty->flags))
257 if (test_bit(TTY_PTY_LOCK, &tty->link->flags))
259 if (tty->driver->subtype == PTY_TYPE_SLAVE && tty->link->count != 1)
262 clear_bit(TTY_IO_ERROR, &tty->flags);
263 clear_bit(TTY_OTHER_CLOSED, &tty->link->flags);
264 set_bit(TTY_THROTTLED, &tty->flags);
270 static void pty_set_termios(struct tty_struct *tty,
271 struct ktermios *old_termios)
273 tty->termios.c_cflag &= ~(CSIZE | PARENB);
274 tty->termios.c_cflag |= (CS8 | CREAD);
278 * pty_do_resize - resize event
279 * @tty: tty being resized
280 * @ws: window size being set.
282 * Update the termios variables and send the necessary signals to
283 * peform a terminal resize correctly
286 static int pty_resize(struct tty_struct *tty, struct winsize *ws)
288 struct pid *pgrp, *rpgrp;
290 struct tty_struct *pty = tty->link;
292 /* For a PTY we need to lock the tty side */
293 mutex_lock(&tty->termios_mutex);
294 if (!memcmp(ws, &tty->winsize, sizeof(*ws)))
297 /* Get the PID values and reference them so we can
298 avoid holding the tty ctrl lock while sending signals.
299 We need to lock these individually however. */
301 spin_lock_irqsave(&tty->ctrl_lock, flags);
302 pgrp = get_pid(tty->pgrp);
303 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
305 spin_lock_irqsave(&pty->ctrl_lock, flags);
306 rpgrp = get_pid(pty->pgrp);
307 spin_unlock_irqrestore(&pty->ctrl_lock, flags);
310 kill_pgrp(pgrp, SIGWINCH, 1);
311 if (rpgrp != pgrp && rpgrp)
312 kill_pgrp(rpgrp, SIGWINCH, 1);
318 pty->winsize = *ws; /* Never used so will go away soon */
320 mutex_unlock(&tty->termios_mutex);
325 * pty_common_install - set up the pty pair
326 * @driver: the pty driver
327 * @tty: the tty being instantiated
328 * @bool: legacy, true if this is BSD style
330 * Perform the initial set up for the tty/pty pair. Called from the
331 * tty layer when the port is first opened.
333 * Locking: the caller must hold the tty_mutex
335 static int pty_common_install(struct tty_driver *driver, struct tty_struct *tty,
338 struct tty_struct *o_tty;
339 struct tty_port *ports[2];
340 int idx = tty->index;
341 int retval = -ENOMEM;
343 o_tty = alloc_tty_struct();
346 ports[0] = kmalloc(sizeof **ports, GFP_KERNEL);
347 ports[1] = kmalloc(sizeof **ports, GFP_KERNEL);
348 if (!ports[0] || !ports[1])
350 if (!try_module_get(driver->other->owner)) {
351 /* This cannot in fact currently happen */
354 initialize_tty_struct(o_tty, driver->other, idx);
357 /* We always use new tty termios data so we can do this
359 retval = tty_init_termios(tty);
363 retval = tty_init_termios(o_tty);
365 goto err_free_termios;
367 driver->other->ttys[idx] = o_tty;
368 driver->ttys[idx] = tty;
370 memset(&tty->termios_locked, 0, sizeof(tty->termios_locked));
371 tty->termios = driver->init_termios;
372 memset(&o_tty->termios_locked, 0, sizeof(tty->termios_locked));
373 o_tty->termios = driver->other->init_termios;
377 * Everything allocated ... set up the o_tty structure.
379 tty_driver_kref_get(driver->other);
380 if (driver->subtype == PTY_TYPE_MASTER)
382 /* Establish the links in both directions */
385 tty_port_init(ports[0]);
386 tty_port_init(ports[1]);
387 o_tty->port = ports[0];
388 tty->port = ports[1];
389 o_tty->port->itty = o_tty;
391 tty_driver_kref_get(driver);
396 tty_free_termios(tty);
398 deinitialize_tty_struct(o_tty);
399 module_put(o_tty->driver->owner);
403 free_tty_struct(o_tty);
408 static void pty_cleanup(struct tty_struct *tty)
410 tty_port_put(tty->port);
413 /* Traditional BSD devices */
414 #ifdef CONFIG_LEGACY_PTYS
416 static int pty_install(struct tty_driver *driver, struct tty_struct *tty)
418 return pty_common_install(driver, tty, true);
421 static void pty_remove(struct tty_driver *driver, struct tty_struct *tty)
423 struct tty_struct *pair = tty->link;
424 driver->ttys[tty->index] = NULL;
426 pair->driver->ttys[pair->index] = NULL;
429 static int pty_bsd_ioctl(struct tty_struct *tty,
430 unsigned int cmd, unsigned long arg)
433 case TIOCSPTLCK: /* Set PT Lock (disallow slave open) */
434 return pty_set_lock(tty, (int __user *) arg);
435 case TIOCGPTLCK: /* Get PT Lock status */
436 return pty_get_lock(tty, (int __user *)arg);
437 case TIOCPKT: /* Set PT packet mode */
438 return pty_set_pktmode(tty, (int __user *)arg);
439 case TIOCGPKT: /* Get PT packet mode */
440 return pty_get_pktmode(tty, (int __user *)arg);
441 case TIOCSIG: /* Send signal to other side of pty */
442 return pty_signal(tty, (int) arg);
443 case TIOCGPTN: /* TTY returns ENOTTY, but glibc expects EINVAL here */
449 static int legacy_count = CONFIG_LEGACY_PTY_COUNT;
450 module_param(legacy_count, int, 0);
453 * The master side of a pty can do TIOCSPTLCK and thus
456 static const struct tty_operations master_pty_ops_bsd = {
457 .install = pty_install,
461 .write_room = pty_write_room,
462 .flush_buffer = pty_flush_buffer,
463 .chars_in_buffer = pty_chars_in_buffer,
464 .unthrottle = pty_unthrottle,
465 .set_termios = pty_set_termios,
466 .ioctl = pty_bsd_ioctl,
467 .cleanup = pty_cleanup,
468 .resize = pty_resize,
472 static const struct tty_operations slave_pty_ops_bsd = {
473 .install = pty_install,
477 .write_room = pty_write_room,
478 .flush_buffer = pty_flush_buffer,
479 .chars_in_buffer = pty_chars_in_buffer,
480 .unthrottle = pty_unthrottle,
481 .set_termios = pty_set_termios,
482 .cleanup = pty_cleanup,
483 .resize = pty_resize,
487 static void __init legacy_pty_init(void)
489 struct tty_driver *pty_driver, *pty_slave_driver;
491 if (legacy_count <= 0)
494 pty_driver = tty_alloc_driver(legacy_count,
495 TTY_DRIVER_RESET_TERMIOS |
496 TTY_DRIVER_REAL_RAW |
497 TTY_DRIVER_DYNAMIC_ALLOC);
498 if (IS_ERR(pty_driver))
499 panic("Couldn't allocate pty driver");
501 pty_slave_driver = tty_alloc_driver(legacy_count,
502 TTY_DRIVER_RESET_TERMIOS |
503 TTY_DRIVER_REAL_RAW |
504 TTY_DRIVER_DYNAMIC_ALLOC);
505 if (IS_ERR(pty_slave_driver))
506 panic("Couldn't allocate pty slave driver");
508 pty_driver->driver_name = "pty_master";
509 pty_driver->name = "pty";
510 pty_driver->major = PTY_MASTER_MAJOR;
511 pty_driver->minor_start = 0;
512 pty_driver->type = TTY_DRIVER_TYPE_PTY;
513 pty_driver->subtype = PTY_TYPE_MASTER;
514 pty_driver->init_termios = tty_std_termios;
515 pty_driver->init_termios.c_iflag = 0;
516 pty_driver->init_termios.c_oflag = 0;
517 pty_driver->init_termios.c_cflag = B38400 | CS8 | CREAD;
518 pty_driver->init_termios.c_lflag = 0;
519 pty_driver->init_termios.c_ispeed = 38400;
520 pty_driver->init_termios.c_ospeed = 38400;
521 pty_driver->other = pty_slave_driver;
522 tty_set_operations(pty_driver, &master_pty_ops_bsd);
524 pty_slave_driver->driver_name = "pty_slave";
525 pty_slave_driver->name = "ttyp";
526 pty_slave_driver->major = PTY_SLAVE_MAJOR;
527 pty_slave_driver->minor_start = 0;
528 pty_slave_driver->type = TTY_DRIVER_TYPE_PTY;
529 pty_slave_driver->subtype = PTY_TYPE_SLAVE;
530 pty_slave_driver->init_termios = tty_std_termios;
531 pty_slave_driver->init_termios.c_cflag = B38400 | CS8 | CREAD;
532 pty_slave_driver->init_termios.c_ispeed = 38400;
533 pty_slave_driver->init_termios.c_ospeed = 38400;
534 pty_slave_driver->other = pty_driver;
535 tty_set_operations(pty_slave_driver, &slave_pty_ops_bsd);
537 if (tty_register_driver(pty_driver))
538 panic("Couldn't register pty driver");
539 if (tty_register_driver(pty_slave_driver))
540 panic("Couldn't register pty slave driver");
543 static inline void legacy_pty_init(void) { }
547 #ifdef CONFIG_UNIX98_PTYS
549 static struct cdev ptmx_cdev;
551 static int pty_unix98_ioctl(struct tty_struct *tty,
552 unsigned int cmd, unsigned long arg)
555 case TIOCSPTLCK: /* Set PT Lock (disallow slave open) */
556 return pty_set_lock(tty, (int __user *)arg);
557 case TIOCGPTLCK: /* Get PT Lock status */
558 return pty_get_lock(tty, (int __user *)arg);
559 case TIOCPKT: /* Set PT packet mode */
560 return pty_set_pktmode(tty, (int __user *)arg);
561 case TIOCGPKT: /* Get PT packet mode */
562 return pty_get_pktmode(tty, (int __user *)arg);
563 case TIOCGPTN: /* Get PT Number */
564 return put_user(tty->index, (unsigned int __user *)arg);
565 case TIOCSIG: /* Send signal to other side of pty */
566 return pty_signal(tty, (int) arg);
573 * ptm_unix98_lookup - find a pty master
574 * @driver: ptm driver
577 * Look up a pty master device. Called under the tty_mutex for now.
578 * This provides our locking.
581 static struct tty_struct *ptm_unix98_lookup(struct tty_driver *driver,
582 struct inode *ptm_inode, int idx)
584 /* Master must be open via /dev/ptmx */
585 return ERR_PTR(-EIO);
589 * pts_unix98_lookup - find a pty slave
590 * @driver: pts driver
593 * Look up a pty master device. Called under the tty_mutex for now.
594 * This provides our locking for the tty pointer.
597 static struct tty_struct *pts_unix98_lookup(struct tty_driver *driver,
598 struct inode *pts_inode, int idx)
600 struct tty_struct *tty;
602 mutex_lock(&devpts_mutex);
603 tty = devpts_get_priv(pts_inode);
604 mutex_unlock(&devpts_mutex);
605 /* Master must be open before slave */
607 return ERR_PTR(-EIO);
611 /* We have no need to install and remove our tty objects as devpts does all
614 static int pty_unix98_install(struct tty_driver *driver, struct tty_struct *tty)
616 return pty_common_install(driver, tty, false);
619 static void pty_unix98_remove(struct tty_driver *driver, struct tty_struct *tty)
623 /* this is called once with whichever end is closed last */
624 static void pty_unix98_shutdown(struct tty_struct *tty)
626 devpts_kill_index(tty->driver_data, tty->index);
629 static const struct tty_operations ptm_unix98_ops = {
630 .lookup = ptm_unix98_lookup,
631 .install = pty_unix98_install,
632 .remove = pty_unix98_remove,
636 .write_room = pty_write_room,
637 .flush_buffer = pty_flush_buffer,
638 .chars_in_buffer = pty_chars_in_buffer,
639 .unthrottle = pty_unthrottle,
640 .set_termios = pty_set_termios,
641 .ioctl = pty_unix98_ioctl,
642 .resize = pty_resize,
643 .shutdown = pty_unix98_shutdown,
644 .cleanup = pty_cleanup
647 static const struct tty_operations pty_unix98_ops = {
648 .lookup = pts_unix98_lookup,
649 .install = pty_unix98_install,
650 .remove = pty_unix98_remove,
654 .write_room = pty_write_room,
655 .flush_buffer = pty_flush_buffer,
656 .chars_in_buffer = pty_chars_in_buffer,
657 .unthrottle = pty_unthrottle,
658 .set_termios = pty_set_termios,
659 .shutdown = pty_unix98_shutdown,
660 .cleanup = pty_cleanup,
664 * ptmx_open - open a unix 98 pty master
665 * @inode: inode of device file
666 * @filp: file pointer to tty
668 * Allocate a unix98 pty master device from the ptmx driver.
670 * Locking: tty_mutex protects the init_dev work. tty->count should
672 * allocated_ptys_lock handles the list of free pty numbers
675 static int ptmx_open(struct inode *inode, struct file *filp)
677 struct tty_struct *tty;
678 struct inode *slave_inode;
682 nonseekable_open(inode, filp);
684 /* We refuse fsnotify events on ptmx, since it's a shared resource */
685 filp->f_mode |= FMODE_NONOTIFY;
687 retval = tty_alloc_file(filp);
691 /* find a device that is not in use. */
692 mutex_lock(&devpts_mutex);
693 index = devpts_new_index(inode);
696 mutex_unlock(&devpts_mutex);
700 mutex_unlock(&devpts_mutex);
702 mutex_lock(&tty_mutex);
703 tty = tty_init_dev(ptm_driver, index);
706 retval = PTR_ERR(tty);
710 /* The tty returned here is locked so we can safely
712 mutex_unlock(&tty_mutex);
714 set_bit(TTY_PTY_LOCK, &tty->flags); /* LOCK THE SLAVE */
715 tty->driver_data = inode;
717 tty_add_file(tty, filp);
719 slave_inode = devpts_pty_new(inode,
720 MKDEV(UNIX98_PTY_SLAVE_MAJOR, index), index,
722 if (IS_ERR(slave_inode)) {
723 retval = PTR_ERR(slave_inode);
726 tty->link->driver_data = slave_inode;
728 retval = ptm_driver->ops->open(tty, filp);
736 tty_release(inode, filp);
739 mutex_unlock(&tty_mutex);
740 devpts_kill_index(inode, index);
746 static struct file_operations ptmx_fops;
748 static void __init unix98_pty_init(void)
750 ptm_driver = tty_alloc_driver(NR_UNIX98_PTY_MAX,
751 TTY_DRIVER_RESET_TERMIOS |
752 TTY_DRIVER_REAL_RAW |
753 TTY_DRIVER_DYNAMIC_DEV |
754 TTY_DRIVER_DEVPTS_MEM |
755 TTY_DRIVER_DYNAMIC_ALLOC);
756 if (IS_ERR(ptm_driver))
757 panic("Couldn't allocate Unix98 ptm driver");
758 pts_driver = tty_alloc_driver(NR_UNIX98_PTY_MAX,
759 TTY_DRIVER_RESET_TERMIOS |
760 TTY_DRIVER_REAL_RAW |
761 TTY_DRIVER_DYNAMIC_DEV |
762 TTY_DRIVER_DEVPTS_MEM |
763 TTY_DRIVER_DYNAMIC_ALLOC);
764 if (IS_ERR(pts_driver))
765 panic("Couldn't allocate Unix98 pts driver");
767 ptm_driver->driver_name = "pty_master";
768 ptm_driver->name = "ptm";
769 ptm_driver->major = UNIX98_PTY_MASTER_MAJOR;
770 ptm_driver->minor_start = 0;
771 ptm_driver->type = TTY_DRIVER_TYPE_PTY;
772 ptm_driver->subtype = PTY_TYPE_MASTER;
773 ptm_driver->init_termios = tty_std_termios;
774 ptm_driver->init_termios.c_iflag = 0;
775 ptm_driver->init_termios.c_oflag = 0;
776 ptm_driver->init_termios.c_cflag = B38400 | CS8 | CREAD;
777 ptm_driver->init_termios.c_lflag = 0;
778 ptm_driver->init_termios.c_ispeed = 38400;
779 ptm_driver->init_termios.c_ospeed = 38400;
780 ptm_driver->other = pts_driver;
781 tty_set_operations(ptm_driver, &ptm_unix98_ops);
783 pts_driver->driver_name = "pty_slave";
784 pts_driver->name = "pts";
785 pts_driver->major = UNIX98_PTY_SLAVE_MAJOR;
786 pts_driver->minor_start = 0;
787 pts_driver->type = TTY_DRIVER_TYPE_PTY;
788 pts_driver->subtype = PTY_TYPE_SLAVE;
789 pts_driver->init_termios = tty_std_termios;
790 pts_driver->init_termios.c_cflag = B38400 | CS8 | CREAD;
791 pts_driver->init_termios.c_ispeed = 38400;
792 pts_driver->init_termios.c_ospeed = 38400;
793 pts_driver->other = ptm_driver;
794 tty_set_operations(pts_driver, &pty_unix98_ops);
796 if (tty_register_driver(ptm_driver))
797 panic("Couldn't register Unix98 ptm driver");
798 if (tty_register_driver(pts_driver))
799 panic("Couldn't register Unix98 pts driver");
801 /* Now create the /dev/ptmx special device */
802 tty_default_fops(&ptmx_fops);
803 ptmx_fops.open = ptmx_open;
805 cdev_init(&ptmx_cdev, &ptmx_fops);
806 if (cdev_add(&ptmx_cdev, MKDEV(TTYAUX_MAJOR, 2), 1) ||
807 register_chrdev_region(MKDEV(TTYAUX_MAJOR, 2), 1, "/dev/ptmx") < 0)
808 panic("Couldn't register /dev/ptmx driver");
809 device_create(tty_class, NULL, MKDEV(TTYAUX_MAJOR, 2), NULL, "ptmx");
813 static inline void unix98_pty_init(void) { }
816 static int __init pty_init(void)
822 module_init(pty_init);