2 * Copyright (C) 1991, 1992 Linus Torvalds
4 * Added support for a Unix98-style ptmx device.
5 * -- C. Scott Ananian <cananian@alumni.princeton.edu>, 14-Jan-1998
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 if (!tty || !tty->link)
250 if (test_bit(TTY_OTHER_CLOSED, &tty->flags))
252 if (test_bit(TTY_PTY_LOCK, &tty->link->flags))
254 if (tty->driver->subtype == PTY_TYPE_SLAVE && tty->link->count != 1)
257 clear_bit(TTY_IO_ERROR, &tty->flags);
258 clear_bit(TTY_OTHER_CLOSED, &tty->link->flags);
259 set_bit(TTY_THROTTLED, &tty->flags);
263 set_bit(TTY_IO_ERROR, &tty->flags);
267 static void pty_set_termios(struct tty_struct *tty,
268 struct ktermios *old_termios)
270 tty->termios.c_cflag &= ~(CSIZE | PARENB);
271 tty->termios.c_cflag |= (CS8 | CREAD);
275 * pty_do_resize - resize event
276 * @tty: tty being resized
277 * @ws: window size being set.
279 * Update the termios variables and send the necessary signals to
280 * peform a terminal resize correctly
283 static int pty_resize(struct tty_struct *tty, struct winsize *ws)
285 struct pid *pgrp, *rpgrp;
287 struct tty_struct *pty = tty->link;
289 /* For a PTY we need to lock the tty side */
290 mutex_lock(&tty->termios_mutex);
291 if (!memcmp(ws, &tty->winsize, sizeof(*ws)))
294 /* Get the PID values and reference them so we can
295 avoid holding the tty ctrl lock while sending signals.
296 We need to lock these individually however. */
298 spin_lock_irqsave(&tty->ctrl_lock, flags);
299 pgrp = get_pid(tty->pgrp);
300 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
302 spin_lock_irqsave(&pty->ctrl_lock, flags);
303 rpgrp = get_pid(pty->pgrp);
304 spin_unlock_irqrestore(&pty->ctrl_lock, flags);
307 kill_pgrp(pgrp, SIGWINCH, 1);
308 if (rpgrp != pgrp && rpgrp)
309 kill_pgrp(rpgrp, SIGWINCH, 1);
315 pty->winsize = *ws; /* Never used so will go away soon */
317 mutex_unlock(&tty->termios_mutex);
322 * pty_common_install - set up the pty pair
323 * @driver: the pty driver
324 * @tty: the tty being instantiated
325 * @bool: legacy, true if this is BSD style
327 * Perform the initial set up for the tty/pty pair. Called from the
328 * tty layer when the port is first opened.
330 * Locking: the caller must hold the tty_mutex
332 static int pty_common_install(struct tty_driver *driver, struct tty_struct *tty,
335 struct tty_struct *o_tty;
336 struct tty_port *ports[2];
337 int idx = tty->index;
338 int retval = -ENOMEM;
340 o_tty = alloc_tty_struct();
343 ports[0] = kmalloc(sizeof **ports, GFP_KERNEL);
344 ports[1] = kmalloc(sizeof **ports, GFP_KERNEL);
345 if (!ports[0] || !ports[1])
347 if (!try_module_get(driver->other->owner)) {
348 /* This cannot in fact currently happen */
351 initialize_tty_struct(o_tty, driver->other, idx);
354 /* We always use new tty termios data so we can do this
356 retval = tty_init_termios(tty);
360 retval = tty_init_termios(o_tty);
362 goto err_free_termios;
364 driver->other->ttys[idx] = o_tty;
365 driver->ttys[idx] = tty;
367 memset(&tty->termios_locked, 0, sizeof(tty->termios_locked));
368 tty->termios = driver->init_termios;
369 memset(&o_tty->termios_locked, 0, sizeof(tty->termios_locked));
370 o_tty->termios = driver->other->init_termios;
374 * Everything allocated ... set up the o_tty structure.
376 tty_driver_kref_get(driver->other);
377 if (driver->subtype == PTY_TYPE_MASTER)
379 /* Establish the links in both directions */
382 tty_port_init(ports[0]);
383 tty_port_init(ports[1]);
384 o_tty->port = ports[0];
385 tty->port = ports[1];
386 o_tty->port->itty = o_tty;
388 tty_driver_kref_get(driver);
393 tty_free_termios(tty);
395 deinitialize_tty_struct(o_tty);
396 module_put(o_tty->driver->owner);
400 free_tty_struct(o_tty);
405 static void pty_cleanup(struct tty_struct *tty)
407 tty_port_put(tty->port);
410 /* Traditional BSD devices */
411 #ifdef CONFIG_LEGACY_PTYS
413 static int pty_install(struct tty_driver *driver, struct tty_struct *tty)
415 return pty_common_install(driver, tty, true);
418 static void pty_remove(struct tty_driver *driver, struct tty_struct *tty)
420 struct tty_struct *pair = tty->link;
421 driver->ttys[tty->index] = NULL;
423 pair->driver->ttys[pair->index] = NULL;
426 static int pty_bsd_ioctl(struct tty_struct *tty,
427 unsigned int cmd, unsigned long arg)
430 case TIOCSPTLCK: /* Set PT Lock (disallow slave open) */
431 return pty_set_lock(tty, (int __user *) arg);
432 case TIOCGPTLCK: /* Get PT Lock status */
433 return pty_get_lock(tty, (int __user *)arg);
434 case TIOCPKT: /* Set PT packet mode */
435 return pty_set_pktmode(tty, (int __user *)arg);
436 case TIOCGPKT: /* Get PT packet mode */
437 return pty_get_pktmode(tty, (int __user *)arg);
438 case TIOCSIG: /* Send signal to other side of pty */
439 return pty_signal(tty, (int) arg);
440 case TIOCGPTN: /* TTY returns ENOTTY, but glibc expects EINVAL here */
446 static int legacy_count = CONFIG_LEGACY_PTY_COUNT;
447 module_param(legacy_count, int, 0);
450 * The master side of a pty can do TIOCSPTLCK and thus
453 static const struct tty_operations master_pty_ops_bsd = {
454 .install = pty_install,
458 .write_room = pty_write_room,
459 .flush_buffer = pty_flush_buffer,
460 .chars_in_buffer = pty_chars_in_buffer,
461 .unthrottle = pty_unthrottle,
462 .set_termios = pty_set_termios,
463 .ioctl = pty_bsd_ioctl,
464 .cleanup = pty_cleanup,
465 .resize = pty_resize,
469 static const struct tty_operations slave_pty_ops_bsd = {
470 .install = pty_install,
474 .write_room = pty_write_room,
475 .flush_buffer = pty_flush_buffer,
476 .chars_in_buffer = pty_chars_in_buffer,
477 .unthrottle = pty_unthrottle,
478 .set_termios = pty_set_termios,
479 .cleanup = pty_cleanup,
480 .resize = pty_resize,
484 static void __init legacy_pty_init(void)
486 struct tty_driver *pty_driver, *pty_slave_driver;
488 if (legacy_count <= 0)
491 pty_driver = tty_alloc_driver(legacy_count,
492 TTY_DRIVER_RESET_TERMIOS |
493 TTY_DRIVER_REAL_RAW |
494 TTY_DRIVER_DYNAMIC_ALLOC);
495 if (IS_ERR(pty_driver))
496 panic("Couldn't allocate pty driver");
498 pty_slave_driver = tty_alloc_driver(legacy_count,
499 TTY_DRIVER_RESET_TERMIOS |
500 TTY_DRIVER_REAL_RAW |
501 TTY_DRIVER_DYNAMIC_ALLOC);
502 if (IS_ERR(pty_slave_driver))
503 panic("Couldn't allocate pty slave driver");
505 pty_driver->driver_name = "pty_master";
506 pty_driver->name = "pty";
507 pty_driver->major = PTY_MASTER_MAJOR;
508 pty_driver->minor_start = 0;
509 pty_driver->type = TTY_DRIVER_TYPE_PTY;
510 pty_driver->subtype = PTY_TYPE_MASTER;
511 pty_driver->init_termios = tty_std_termios;
512 pty_driver->init_termios.c_iflag = 0;
513 pty_driver->init_termios.c_oflag = 0;
514 pty_driver->init_termios.c_cflag = B38400 | CS8 | CREAD;
515 pty_driver->init_termios.c_lflag = 0;
516 pty_driver->init_termios.c_ispeed = 38400;
517 pty_driver->init_termios.c_ospeed = 38400;
518 pty_driver->other = pty_slave_driver;
519 tty_set_operations(pty_driver, &master_pty_ops_bsd);
521 pty_slave_driver->driver_name = "pty_slave";
522 pty_slave_driver->name = "ttyp";
523 pty_slave_driver->major = PTY_SLAVE_MAJOR;
524 pty_slave_driver->minor_start = 0;
525 pty_slave_driver->type = TTY_DRIVER_TYPE_PTY;
526 pty_slave_driver->subtype = PTY_TYPE_SLAVE;
527 pty_slave_driver->init_termios = tty_std_termios;
528 pty_slave_driver->init_termios.c_cflag = B38400 | CS8 | CREAD;
529 pty_slave_driver->init_termios.c_ispeed = 38400;
530 pty_slave_driver->init_termios.c_ospeed = 38400;
531 pty_slave_driver->other = pty_driver;
532 tty_set_operations(pty_slave_driver, &slave_pty_ops_bsd);
534 if (tty_register_driver(pty_driver))
535 panic("Couldn't register pty driver");
536 if (tty_register_driver(pty_slave_driver))
537 panic("Couldn't register pty slave driver");
540 static inline void legacy_pty_init(void) { }
544 #ifdef CONFIG_UNIX98_PTYS
546 static struct cdev ptmx_cdev;
548 static int pty_unix98_ioctl(struct tty_struct *tty,
549 unsigned int cmd, unsigned long arg)
552 case TIOCSPTLCK: /* Set PT Lock (disallow slave open) */
553 return pty_set_lock(tty, (int __user *)arg);
554 case TIOCGPTLCK: /* Get PT Lock status */
555 return pty_get_lock(tty, (int __user *)arg);
556 case TIOCPKT: /* Set PT packet mode */
557 return pty_set_pktmode(tty, (int __user *)arg);
558 case TIOCGPKT: /* Get PT packet mode */
559 return pty_get_pktmode(tty, (int __user *)arg);
560 case TIOCGPTN: /* Get PT Number */
561 return put_user(tty->index, (unsigned int __user *)arg);
562 case TIOCSIG: /* Send signal to other side of pty */
563 return pty_signal(tty, (int) arg);
570 * ptm_unix98_lookup - find a pty master
571 * @driver: ptm driver
574 * Look up a pty master device. Called under the tty_mutex for now.
575 * This provides our locking.
578 static struct tty_struct *ptm_unix98_lookup(struct tty_driver *driver,
579 struct inode *ptm_inode, int idx)
581 /* Master must be open via /dev/ptmx */
582 return ERR_PTR(-EIO);
586 * pts_unix98_lookup - find a pty slave
587 * @driver: pts driver
590 * Look up a pty master device. Called under the tty_mutex for now.
591 * This provides our locking for the tty pointer.
594 static struct tty_struct *pts_unix98_lookup(struct tty_driver *driver,
595 struct inode *pts_inode, int idx)
597 struct tty_struct *tty;
599 mutex_lock(&devpts_mutex);
600 tty = devpts_get_priv(pts_inode);
601 mutex_unlock(&devpts_mutex);
602 /* Master must be open before slave */
604 return ERR_PTR(-EIO);
608 /* We have no need to install and remove our tty objects as devpts does all
611 static int pty_unix98_install(struct tty_driver *driver, struct tty_struct *tty)
613 return pty_common_install(driver, tty, false);
616 static void pty_unix98_remove(struct tty_driver *driver, struct tty_struct *tty)
620 /* this is called once with whichever end is closed last */
621 static void pty_unix98_shutdown(struct tty_struct *tty)
623 devpts_kill_index(tty->driver_data, tty->index);
626 static const struct tty_operations ptm_unix98_ops = {
627 .lookup = ptm_unix98_lookup,
628 .install = pty_unix98_install,
629 .remove = pty_unix98_remove,
633 .write_room = pty_write_room,
634 .flush_buffer = pty_flush_buffer,
635 .chars_in_buffer = pty_chars_in_buffer,
636 .unthrottle = pty_unthrottle,
637 .set_termios = pty_set_termios,
638 .ioctl = pty_unix98_ioctl,
639 .resize = pty_resize,
640 .shutdown = pty_unix98_shutdown,
641 .cleanup = pty_cleanup
644 static const struct tty_operations pty_unix98_ops = {
645 .lookup = pts_unix98_lookup,
646 .install = pty_unix98_install,
647 .remove = pty_unix98_remove,
651 .write_room = pty_write_room,
652 .flush_buffer = pty_flush_buffer,
653 .chars_in_buffer = pty_chars_in_buffer,
654 .unthrottle = pty_unthrottle,
655 .set_termios = pty_set_termios,
656 .shutdown = pty_unix98_shutdown,
657 .cleanup = pty_cleanup,
661 * ptmx_open - open a unix 98 pty master
662 * @inode: inode of device file
663 * @filp: file pointer to tty
665 * Allocate a unix98 pty master device from the ptmx driver.
667 * Locking: tty_mutex protects the init_dev work. tty->count should
669 * allocated_ptys_lock handles the list of free pty numbers
672 static int ptmx_open(struct inode *inode, struct file *filp)
674 struct tty_struct *tty;
675 struct inode *slave_inode;
679 nonseekable_open(inode, filp);
681 /* We refuse fsnotify events on ptmx, since it's a shared resource */
682 filp->f_mode |= FMODE_NONOTIFY;
684 retval = tty_alloc_file(filp);
688 /* find a device that is not in use. */
689 mutex_lock(&devpts_mutex);
690 index = devpts_new_index(inode);
693 mutex_unlock(&devpts_mutex);
697 mutex_unlock(&devpts_mutex);
699 mutex_lock(&tty_mutex);
700 tty = tty_init_dev(ptm_driver, index);
703 retval = PTR_ERR(tty);
707 /* The tty returned here is locked so we can safely
709 mutex_unlock(&tty_mutex);
711 set_bit(TTY_PTY_LOCK, &tty->flags); /* LOCK THE SLAVE */
712 tty->driver_data = inode;
714 tty_add_file(tty, filp);
716 slave_inode = devpts_pty_new(inode,
717 MKDEV(UNIX98_PTY_SLAVE_MAJOR, index), index,
719 if (IS_ERR(slave_inode)) {
720 retval = PTR_ERR(slave_inode);
723 tty->link->driver_data = slave_inode;
725 retval = ptm_driver->ops->open(tty, filp);
733 tty_release(inode, filp);
736 mutex_unlock(&tty_mutex);
737 devpts_kill_index(inode, index);
743 static struct file_operations ptmx_fops;
745 static void __init unix98_pty_init(void)
747 ptm_driver = tty_alloc_driver(NR_UNIX98_PTY_MAX,
748 TTY_DRIVER_RESET_TERMIOS |
749 TTY_DRIVER_REAL_RAW |
750 TTY_DRIVER_DYNAMIC_DEV |
751 TTY_DRIVER_DEVPTS_MEM |
752 TTY_DRIVER_DYNAMIC_ALLOC);
753 if (IS_ERR(ptm_driver))
754 panic("Couldn't allocate Unix98 ptm driver");
755 pts_driver = tty_alloc_driver(NR_UNIX98_PTY_MAX,
756 TTY_DRIVER_RESET_TERMIOS |
757 TTY_DRIVER_REAL_RAW |
758 TTY_DRIVER_DYNAMIC_DEV |
759 TTY_DRIVER_DEVPTS_MEM |
760 TTY_DRIVER_DYNAMIC_ALLOC);
761 if (IS_ERR(pts_driver))
762 panic("Couldn't allocate Unix98 pts driver");
764 ptm_driver->driver_name = "pty_master";
765 ptm_driver->name = "ptm";
766 ptm_driver->major = UNIX98_PTY_MASTER_MAJOR;
767 ptm_driver->minor_start = 0;
768 ptm_driver->type = TTY_DRIVER_TYPE_PTY;
769 ptm_driver->subtype = PTY_TYPE_MASTER;
770 ptm_driver->init_termios = tty_std_termios;
771 ptm_driver->init_termios.c_iflag = 0;
772 ptm_driver->init_termios.c_oflag = 0;
773 ptm_driver->init_termios.c_cflag = B38400 | CS8 | CREAD;
774 ptm_driver->init_termios.c_lflag = 0;
775 ptm_driver->init_termios.c_ispeed = 38400;
776 ptm_driver->init_termios.c_ospeed = 38400;
777 ptm_driver->other = pts_driver;
778 tty_set_operations(ptm_driver, &ptm_unix98_ops);
780 pts_driver->driver_name = "pty_slave";
781 pts_driver->name = "pts";
782 pts_driver->major = UNIX98_PTY_SLAVE_MAJOR;
783 pts_driver->minor_start = 0;
784 pts_driver->type = TTY_DRIVER_TYPE_PTY;
785 pts_driver->subtype = PTY_TYPE_SLAVE;
786 pts_driver->init_termios = tty_std_termios;
787 pts_driver->init_termios.c_cflag = B38400 | CS8 | CREAD;
788 pts_driver->init_termios.c_ispeed = 38400;
789 pts_driver->init_termios.c_ospeed = 38400;
790 pts_driver->other = ptm_driver;
791 tty_set_operations(pts_driver, &pty_unix98_ops);
793 if (tty_register_driver(ptm_driver))
794 panic("Couldn't register Unix98 ptm driver");
795 if (tty_register_driver(pts_driver))
796 panic("Couldn't register Unix98 pts driver");
798 /* Now create the /dev/ptmx special device */
799 tty_default_fops(&ptmx_fops);
800 ptmx_fops.open = ptmx_open;
802 cdev_init(&ptmx_cdev, &ptmx_fops);
803 if (cdev_add(&ptmx_cdev, MKDEV(TTYAUX_MAJOR, 2), 1) ||
804 register_chrdev_region(MKDEV(TTYAUX_MAJOR, 2), 1, "/dev/ptmx") < 0)
805 panic("Couldn't register /dev/ptmx driver");
806 device_create(tty_class, NULL, MKDEV(TTYAUX_MAJOR, 2), NULL, "ptmx");
810 static inline void unix98_pty_init(void) { }
813 static int __init pty_init(void)
819 module_init(pty_init);