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
7 * When reading this code see also fs/devpts. In particular note that the
8 * driver_data field is used by the devpts side as a binding to the devpts
12 #include <linux/module.h>
14 #include <linux/errno.h>
15 #include <linux/interrupt.h>
16 #include <linux/tty.h>
17 #include <linux/tty_flip.h>
18 #include <linux/fcntl.h>
19 #include <linux/sched.h>
20 #include <linux/string.h>
21 #include <linux/major.h>
23 #include <linux/init.h>
24 #include <linux/device.h>
25 #include <linux/uaccess.h>
26 #include <linux/bitops.h>
27 #include <linux/devpts_fs.h>
28 #include <linux/slab.h>
29 #include <linux/mutex.h>
32 #ifdef CONFIG_UNIX98_PTYS
33 static struct tty_driver *ptm_driver;
34 static struct tty_driver *pts_driver;
35 static DEFINE_MUTEX(devpts_mutex);
38 static void pty_close(struct tty_struct *tty, struct file *filp)
41 if (tty->driver->subtype == PTY_TYPE_MASTER)
42 WARN_ON(tty->count > 1);
47 wake_up_interruptible(&tty->read_wait);
48 wake_up_interruptible(&tty->write_wait);
52 tty->link->packet = 0;
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 devpts_pty_kill(tty->link);
62 mutex_unlock(&devpts_mutex);
66 tty_vhangup(tty->link);
72 * The unthrottle routine is called by the line discipline to signal
73 * that it can receive more characters. For PTY's, the TTY_THROTTLED
74 * flag is always set, to force the line discipline to always call the
75 * unthrottle routine when there are fewer than TTY_THRESHOLD_UNTHROTTLE
76 * characters in the queue. This is necessary since each time this
77 * happens, we need to wake up any sleeping processes that could be
78 * (1) trying to send data to the pty, or (2) waiting in wait_until_sent()
79 * for the pty buffer to be drained.
81 static void pty_unthrottle(struct tty_struct *tty)
83 tty_wakeup(tty->link);
84 set_bit(TTY_THROTTLED, &tty->flags);
88 * pty_space - report space left for writing
89 * @to: tty we are writing into
91 * The tty buffers allow 64K but we sneak a peak and clip at 8K this
92 * allows a lot of overspill room for echo and other fun messes to
96 static int pty_space(struct tty_struct *to)
98 int n = 8192 - to->buf.memory_used;
105 * pty_write - write to a pty
106 * @tty: the tty we write from
107 * @buf: kernel buffer of data
108 * @count: bytes to write
110 * Our "hardware" write method. Data is coming from the ldisc which
111 * may be in a non sleeping state. We simply throw this at the other
112 * end of the link as if we were an IRQ handler receiving stuff for
113 * the other side of the pty/tty pair.
116 static int pty_write(struct tty_struct *tty, const unsigned char *buf, int c)
118 struct tty_struct *to = tty->link;
124 /* Stuff the data into the input queue of the other end */
125 c = tty_insert_flip_string(to, buf, c);
128 tty_flip_buffer_push(to);
136 * pty_write_room - write space
137 * @tty: tty we are writing from
139 * Report how many bytes the ldisc can send into the queue for
143 static int pty_write_room(struct tty_struct *tty)
147 return pty_space(tty->link);
151 * pty_chars_in_buffer - characters currently in our tx queue
154 * Report how much we have in the transmit queue. As everything is
155 * instantly at the other end this is easy to implement.
158 static int pty_chars_in_buffer(struct tty_struct *tty)
163 /* Set the lock flag on a pty */
164 static int pty_set_lock(struct tty_struct *tty, int __user *arg)
167 if (get_user(val, arg))
170 set_bit(TTY_PTY_LOCK, &tty->flags);
172 clear_bit(TTY_PTY_LOCK, &tty->flags);
176 /* Send a signal to the slave */
177 static int pty_signal(struct tty_struct *tty, int sig)
183 spin_lock_irqsave(&tty->link->ctrl_lock, flags);
184 pgrp = get_pid(tty->link->pgrp);
185 spin_unlock_irqrestore(&tty->link->ctrl_lock, flags);
187 kill_pgrp(pgrp, sig, 1);
193 static void pty_flush_buffer(struct tty_struct *tty)
195 struct tty_struct *to = tty->link;
200 /* tty_buffer_flush(to); FIXME */
202 spin_lock_irqsave(&tty->ctrl_lock, flags);
203 tty->ctrl_status |= TIOCPKT_FLUSHWRITE;
204 wake_up_interruptible(&to->read_wait);
205 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
209 static int pty_open(struct tty_struct *tty, struct file *filp)
211 int retval = -ENODEV;
213 if (!tty || !tty->link)
217 if (test_bit(TTY_OTHER_CLOSED, &tty->flags))
219 if (test_bit(TTY_PTY_LOCK, &tty->link->flags))
221 if (tty->link->count != 1)
224 clear_bit(TTY_OTHER_CLOSED, &tty->link->flags);
225 set_bit(TTY_THROTTLED, &tty->flags);
231 static void pty_set_termios(struct tty_struct *tty,
232 struct ktermios *old_termios)
234 tty->termios.c_cflag &= ~(CSIZE | PARENB);
235 tty->termios.c_cflag |= (CS8 | CREAD);
239 * pty_do_resize - resize event
240 * @tty: tty being resized
241 * @ws: window size being set.
243 * Update the termios variables and send the necessary signals to
244 * peform a terminal resize correctly
247 int pty_resize(struct tty_struct *tty, struct winsize *ws)
249 struct pid *pgrp, *rpgrp;
251 struct tty_struct *pty = tty->link;
253 /* For a PTY we need to lock the tty side */
254 mutex_lock(&tty->termios_mutex);
255 if (!memcmp(ws, &tty->winsize, sizeof(*ws)))
258 /* Get the PID values and reference them so we can
259 avoid holding the tty ctrl lock while sending signals.
260 We need to lock these individually however. */
262 spin_lock_irqsave(&tty->ctrl_lock, flags);
263 pgrp = get_pid(tty->pgrp);
264 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
266 spin_lock_irqsave(&pty->ctrl_lock, flags);
267 rpgrp = get_pid(pty->pgrp);
268 spin_unlock_irqrestore(&pty->ctrl_lock, flags);
271 kill_pgrp(pgrp, SIGWINCH, 1);
272 if (rpgrp != pgrp && rpgrp)
273 kill_pgrp(rpgrp, SIGWINCH, 1);
279 pty->winsize = *ws; /* Never used so will go away soon */
281 mutex_unlock(&tty->termios_mutex);
286 * pty_common_install - set up the pty pair
287 * @driver: the pty driver
288 * @tty: the tty being instantiated
289 * @bool: legacy, true if this is BSD style
291 * Perform the initial set up for the tty/pty pair. Called from the
292 * tty layer when the port is first opened.
294 * Locking: the caller must hold the tty_mutex
296 static int pty_common_install(struct tty_driver *driver, struct tty_struct *tty,
299 struct tty_struct *o_tty;
300 struct tty_port *ports[2];
301 int idx = tty->index;
302 int retval = -ENOMEM;
304 o_tty = alloc_tty_struct();
305 ports[0] = kmalloc(sizeof **ports, GFP_KERNEL);
306 ports[1] = kmalloc(sizeof **ports, GFP_KERNEL);
307 if (!o_tty || !ports[0] || !ports[1])
309 if (!try_module_get(driver->other->owner)) {
310 /* This cannot in fact currently happen */
313 initialize_tty_struct(o_tty, driver->other, idx);
316 /* We always use new tty termios data so we can do this
318 retval = tty_init_termios(tty);
322 retval = tty_init_termios(o_tty);
324 goto err_free_termios;
326 driver->other->ttys[idx] = o_tty;
327 driver->ttys[idx] = tty;
329 memset(&tty->termios_locked, 0, sizeof(tty->termios_locked));
330 tty->termios = driver->init_termios;
331 memset(&o_tty->termios_locked, 0, sizeof(tty->termios_locked));
332 o_tty->termios = driver->other->init_termios;
336 * Everything allocated ... set up the o_tty structure.
338 tty_driver_kref_get(driver->other);
339 if (driver->subtype == PTY_TYPE_MASTER)
341 /* Establish the links in both directions */
344 tty_port_init(ports[0]);
345 tty_port_init(ports[1]);
346 o_tty->port = ports[0];
347 tty->port = ports[1];
349 tty_driver_kref_get(driver);
354 tty_free_termios(tty);
356 deinitialize_tty_struct(o_tty);
357 module_put(o_tty->driver->owner);
361 free_tty_struct(o_tty);
365 static void pty_cleanup(struct tty_struct *tty)
370 /* Traditional BSD devices */
371 #ifdef CONFIG_LEGACY_PTYS
373 static int pty_install(struct tty_driver *driver, struct tty_struct *tty)
375 return pty_common_install(driver, tty, true);
378 static void pty_remove(struct tty_driver *driver, struct tty_struct *tty)
380 struct tty_struct *pair = tty->link;
381 driver->ttys[tty->index] = NULL;
383 pair->driver->ttys[pair->index] = NULL;
386 static int pty_bsd_ioctl(struct tty_struct *tty,
387 unsigned int cmd, unsigned long arg)
390 case TIOCSPTLCK: /* Set PT Lock (disallow slave open) */
391 return pty_set_lock(tty, (int __user *) arg);
392 case TIOCSIG: /* Send signal to other side of pty */
393 return pty_signal(tty, (int) arg);
398 static int legacy_count = CONFIG_LEGACY_PTY_COUNT;
399 module_param(legacy_count, int, 0);
402 * The master side of a pty can do TIOCSPTLCK and thus
405 static const struct tty_operations master_pty_ops_bsd = {
406 .install = pty_install,
410 .write_room = pty_write_room,
411 .flush_buffer = pty_flush_buffer,
412 .chars_in_buffer = pty_chars_in_buffer,
413 .unthrottle = pty_unthrottle,
414 .set_termios = pty_set_termios,
415 .ioctl = pty_bsd_ioctl,
416 .cleanup = pty_cleanup,
417 .resize = pty_resize,
421 static const struct tty_operations slave_pty_ops_bsd = {
422 .install = pty_install,
426 .write_room = pty_write_room,
427 .flush_buffer = pty_flush_buffer,
428 .chars_in_buffer = pty_chars_in_buffer,
429 .unthrottle = pty_unthrottle,
430 .set_termios = pty_set_termios,
431 .cleanup = pty_cleanup,
432 .resize = pty_resize,
436 static void __init legacy_pty_init(void)
438 struct tty_driver *pty_driver, *pty_slave_driver;
440 if (legacy_count <= 0)
443 pty_driver = alloc_tty_driver(legacy_count);
445 panic("Couldn't allocate pty driver");
447 pty_slave_driver = alloc_tty_driver(legacy_count);
448 if (!pty_slave_driver)
449 panic("Couldn't allocate pty slave driver");
451 pty_driver->driver_name = "pty_master";
452 pty_driver->name = "pty";
453 pty_driver->major = PTY_MASTER_MAJOR;
454 pty_driver->minor_start = 0;
455 pty_driver->type = TTY_DRIVER_TYPE_PTY;
456 pty_driver->subtype = PTY_TYPE_MASTER;
457 pty_driver->init_termios = tty_std_termios;
458 pty_driver->init_termios.c_iflag = 0;
459 pty_driver->init_termios.c_oflag = 0;
460 pty_driver->init_termios.c_cflag = B38400 | CS8 | CREAD;
461 pty_driver->init_termios.c_lflag = 0;
462 pty_driver->init_termios.c_ispeed = 38400;
463 pty_driver->init_termios.c_ospeed = 38400;
464 pty_driver->flags = TTY_DRIVER_RESET_TERMIOS | TTY_DRIVER_REAL_RAW;
465 pty_driver->other = pty_slave_driver;
466 tty_set_operations(pty_driver, &master_pty_ops_bsd);
468 pty_slave_driver->driver_name = "pty_slave";
469 pty_slave_driver->name = "ttyp";
470 pty_slave_driver->major = PTY_SLAVE_MAJOR;
471 pty_slave_driver->minor_start = 0;
472 pty_slave_driver->type = TTY_DRIVER_TYPE_PTY;
473 pty_slave_driver->subtype = PTY_TYPE_SLAVE;
474 pty_slave_driver->init_termios = tty_std_termios;
475 pty_slave_driver->init_termios.c_cflag = B38400 | CS8 | CREAD;
476 pty_slave_driver->init_termios.c_ispeed = 38400;
477 pty_slave_driver->init_termios.c_ospeed = 38400;
478 pty_slave_driver->flags = TTY_DRIVER_RESET_TERMIOS |
480 pty_slave_driver->other = pty_driver;
481 tty_set_operations(pty_slave_driver, &slave_pty_ops_bsd);
483 if (tty_register_driver(pty_driver))
484 panic("Couldn't register pty driver");
485 if (tty_register_driver(pty_slave_driver))
486 panic("Couldn't register pty slave driver");
489 static inline void legacy_pty_init(void) { }
493 #ifdef CONFIG_UNIX98_PTYS
495 static struct cdev ptmx_cdev;
497 static int pty_unix98_ioctl(struct tty_struct *tty,
498 unsigned int cmd, unsigned long arg)
501 case TIOCSPTLCK: /* Set PT Lock (disallow slave open) */
502 return pty_set_lock(tty, (int __user *)arg);
503 case TIOCGPTN: /* Get PT Number */
504 return put_user(tty->index, (unsigned int __user *)arg);
505 case TIOCSIG: /* Send signal to other side of pty */
506 return pty_signal(tty, (int) arg);
513 * ptm_unix98_lookup - find a pty master
514 * @driver: ptm driver
517 * Look up a pty master device. Called under the tty_mutex for now.
518 * This provides our locking.
521 static struct tty_struct *ptm_unix98_lookup(struct tty_driver *driver,
522 struct inode *ptm_inode, int idx)
524 /* Master must be open via /dev/ptmx */
525 return ERR_PTR(-EIO);
529 * pts_unix98_lookup - find a pty slave
530 * @driver: pts driver
533 * Look up a pty master device. Called under the tty_mutex for now.
534 * This provides our locking for the tty pointer.
537 static struct tty_struct *pts_unix98_lookup(struct tty_driver *driver,
538 struct inode *pts_inode, int idx)
540 struct tty_struct *tty;
542 mutex_lock(&devpts_mutex);
543 tty = devpts_get_tty(pts_inode, idx);
544 mutex_unlock(&devpts_mutex);
545 /* Master must be open before slave */
547 return ERR_PTR(-EIO);
551 /* We have no need to install and remove our tty objects as devpts does all
554 static int pty_unix98_install(struct tty_driver *driver, struct tty_struct *tty)
556 return pty_common_install(driver, tty, false);
559 static void pty_unix98_remove(struct tty_driver *driver, struct tty_struct *tty)
563 static const struct tty_operations ptm_unix98_ops = {
564 .lookup = ptm_unix98_lookup,
565 .install = pty_unix98_install,
566 .remove = pty_unix98_remove,
570 .write_room = pty_write_room,
571 .flush_buffer = pty_flush_buffer,
572 .chars_in_buffer = pty_chars_in_buffer,
573 .unthrottle = pty_unthrottle,
574 .set_termios = pty_set_termios,
575 .ioctl = pty_unix98_ioctl,
576 .resize = pty_resize,
577 .cleanup = pty_cleanup
580 static const struct tty_operations pty_unix98_ops = {
581 .lookup = pts_unix98_lookup,
582 .install = pty_unix98_install,
583 .remove = pty_unix98_remove,
587 .write_room = pty_write_room,
588 .flush_buffer = pty_flush_buffer,
589 .chars_in_buffer = pty_chars_in_buffer,
590 .unthrottle = pty_unthrottle,
591 .set_termios = pty_set_termios,
592 .cleanup = pty_cleanup,
596 * ptmx_open - open a unix 98 pty master
597 * @inode: inode of device file
598 * @filp: file pointer to tty
600 * Allocate a unix98 pty master device from the ptmx driver.
602 * Locking: tty_mutex protects the init_dev work. tty->count should
604 * allocated_ptys_lock handles the list of free pty numbers
607 static int ptmx_open(struct inode *inode, struct file *filp)
609 struct tty_struct *tty;
613 nonseekable_open(inode, filp);
615 retval = tty_alloc_file(filp);
619 /* find a device that is not in use. */
621 index = devpts_new_index(inode);
628 mutex_lock(&tty_mutex);
629 mutex_lock(&devpts_mutex);
630 tty = tty_init_dev(ptm_driver, index);
631 mutex_unlock(&devpts_mutex);
633 mutex_unlock(&tty_mutex);
636 retval = PTR_ERR(tty);
640 set_bit(TTY_PTY_LOCK, &tty->flags); /* LOCK THE SLAVE */
642 tty_add_file(tty, filp);
644 retval = devpts_pty_new(inode, tty->link);
648 retval = ptm_driver->ops->open(tty, filp);
656 tty_release(inode, filp);
659 devpts_kill_index(inode, index);
666 static struct file_operations ptmx_fops;
668 static void __init unix98_pty_init(void)
670 ptm_driver = alloc_tty_driver(NR_UNIX98_PTY_MAX);
672 panic("Couldn't allocate Unix98 ptm driver");
673 pts_driver = alloc_tty_driver(NR_UNIX98_PTY_MAX);
675 panic("Couldn't allocate Unix98 pts driver");
677 ptm_driver->driver_name = "pty_master";
678 ptm_driver->name = "ptm";
679 ptm_driver->major = UNIX98_PTY_MASTER_MAJOR;
680 ptm_driver->minor_start = 0;
681 ptm_driver->type = TTY_DRIVER_TYPE_PTY;
682 ptm_driver->subtype = PTY_TYPE_MASTER;
683 ptm_driver->init_termios = tty_std_termios;
684 ptm_driver->init_termios.c_iflag = 0;
685 ptm_driver->init_termios.c_oflag = 0;
686 ptm_driver->init_termios.c_cflag = B38400 | CS8 | CREAD;
687 ptm_driver->init_termios.c_lflag = 0;
688 ptm_driver->init_termios.c_ispeed = 38400;
689 ptm_driver->init_termios.c_ospeed = 38400;
690 ptm_driver->flags = TTY_DRIVER_RESET_TERMIOS | TTY_DRIVER_REAL_RAW |
691 TTY_DRIVER_DYNAMIC_DEV | TTY_DRIVER_DEVPTS_MEM;
692 ptm_driver->other = pts_driver;
693 tty_set_operations(ptm_driver, &ptm_unix98_ops);
695 pts_driver->driver_name = "pty_slave";
696 pts_driver->name = "pts";
697 pts_driver->major = UNIX98_PTY_SLAVE_MAJOR;
698 pts_driver->minor_start = 0;
699 pts_driver->type = TTY_DRIVER_TYPE_PTY;
700 pts_driver->subtype = PTY_TYPE_SLAVE;
701 pts_driver->init_termios = tty_std_termios;
702 pts_driver->init_termios.c_cflag = B38400 | CS8 | CREAD;
703 pts_driver->init_termios.c_ispeed = 38400;
704 pts_driver->init_termios.c_ospeed = 38400;
705 pts_driver->flags = TTY_DRIVER_RESET_TERMIOS | TTY_DRIVER_REAL_RAW |
706 TTY_DRIVER_DYNAMIC_DEV | TTY_DRIVER_DEVPTS_MEM;
707 pts_driver->other = ptm_driver;
708 tty_set_operations(pts_driver, &pty_unix98_ops);
710 if (tty_register_driver(ptm_driver))
711 panic("Couldn't register Unix98 ptm driver");
712 if (tty_register_driver(pts_driver))
713 panic("Couldn't register Unix98 pts driver");
715 /* Now create the /dev/ptmx special device */
716 tty_default_fops(&ptmx_fops);
717 ptmx_fops.open = ptmx_open;
719 cdev_init(&ptmx_cdev, &ptmx_fops);
720 if (cdev_add(&ptmx_cdev, MKDEV(TTYAUX_MAJOR, 2), 1) ||
721 register_chrdev_region(MKDEV(TTYAUX_MAJOR, 2), 1, "/dev/ptmx") < 0)
722 panic("Couldn't register /dev/ptmx driver\n");
723 device_create(tty_class, NULL, MKDEV(TTYAUX_MAJOR, 2), NULL, "ptmx");
727 static inline void unix98_pty_init(void) { }
730 static int __init pty_init(void)
736 module_init(pty_init);