pty.c 20.6 KB
Newer Older
Linus Torvalds's avatar
Linus Torvalds committed
1 2 3 4 5 6 7 8
/*
 *  Copyright (C) 1991, 1992  Linus Torvalds
 *
 *  Added support for a Unix98-style ptmx device.
 *    -- C. Scott Ananian <cananian@alumni.princeton.edu>, 14-Jan-1998
 *
 */

Alan Cox's avatar
Alan Cox committed
9
#include <linux/module.h>
Linus Torvalds's avatar
Linus Torvalds committed
10 11 12 13 14 15

#include <linux/errno.h>
#include <linux/interrupt.h>
#include <linux/tty.h>
#include <linux/tty_flip.h>
#include <linux/fcntl.h>
16
#include <linux/sched.h>
Linus Torvalds's avatar
Linus Torvalds committed
17 18 19 20
#include <linux/string.h>
#include <linux/major.h>
#include <linux/mm.h>
#include <linux/init.h>
21
#include <linux/device.h>
Alan Cox's avatar
Alan Cox committed
22
#include <linux/uaccess.h>
Linus Torvalds's avatar
Linus Torvalds committed
23 24
#include <linux/bitops.h>
#include <linux/devpts_fs.h>
25
#include <linux/slab.h>
26
#include <linux/mutex.h>
Linus Torvalds's avatar
Linus Torvalds committed
27

Alan Cox's avatar
Alan Cox committed
28

Linus Torvalds's avatar
Linus Torvalds committed
29
#ifdef CONFIG_UNIX98_PTYS
Roel Kluin's avatar
Roel Kluin committed
30
static struct tty_driver *ptm_driver;
Linus Torvalds's avatar
Linus Torvalds committed
31
static struct tty_driver *pts_driver;
32
static DEFINE_MUTEX(devpts_mutex);
Linus Torvalds's avatar
Linus Torvalds committed
33 34
#endif

Alan Cox's avatar
Alan Cox committed
35
static void pty_close(struct tty_struct *tty, struct file *filp)
Linus Torvalds's avatar
Linus Torvalds committed
36
{
Alan Cox's avatar
Alan Cox committed
37 38 39 40
	BUG_ON(!tty);
	if (tty->driver->subtype == PTY_TYPE_MASTER)
		WARN_ON(tty->count > 1);
	else {
41 42
		if (test_bit(TTY_IO_ERROR, &tty->flags))
			return;
Linus Torvalds's avatar
Linus Torvalds committed
43 44 45
		if (tty->count > 2)
			return;
	}
46
	set_bit(TTY_IO_ERROR, &tty->flags);
Linus Torvalds's avatar
Linus Torvalds committed
47 48 49
	wake_up_interruptible(&tty->read_wait);
	wake_up_interruptible(&tty->write_wait);
	tty->packet = 0;
Alan Cox's avatar
Alan Cox committed
50
	/* Review - krefs on tty_link ?? */
Linus Torvalds's avatar
Linus Torvalds committed
51 52 53 54 55 56 57
	if (!tty->link)
		return;
	set_bit(TTY_OTHER_CLOSED, &tty->link->flags);
	wake_up_interruptible(&tty->link->read_wait);
	wake_up_interruptible(&tty->link->write_wait);
	if (tty->driver->subtype == PTY_TYPE_MASTER) {
		set_bit(TTY_OTHER_CLOSED, &tty->flags);
58
#ifdef CONFIG_UNIX98_PTYS
59
		if (tty->driver == ptm_driver) {
60
			mutex_lock(&devpts_mutex);
61 62
			if (tty->link->driver_data)
				devpts_pty_kill(tty->link->driver_data);
63
			mutex_unlock(&devpts_mutex);
64
		}
65
#endif
Alan Cox's avatar
Alan Cox committed
66
		tty_unlock(tty);
67
		tty_vhangup(tty->link);
Alan Cox's avatar
Alan Cox committed
68
		tty_lock(tty);
Linus Torvalds's avatar
Linus Torvalds committed
69 70 71 72 73 74 75
	}
}

/*
 * The unthrottle routine is called by the line discipline to signal
 * that it can receive more characters.  For PTY's, the TTY_THROTTLED
 * flag is always set, to force the line discipline to always call the
Alan Cox's avatar
Alan Cox committed
76
 * unthrottle routine when there are fewer than TTY_THRESHOLD_UNTHROTTLE
Linus Torvalds's avatar
Linus Torvalds committed
77 78 79 80 81
 * characters in the queue.  This is necessary since each time this
 * happens, we need to wake up any sleeping processes that could be
 * (1) trying to send data to the pty, or (2) waiting in wait_until_sent()
 * for the pty buffer to be drained.
 */
Alan Cox's avatar
Alan Cox committed
82
static void pty_unthrottle(struct tty_struct *tty)
Linus Torvalds's avatar
Linus Torvalds committed
83
{
84
	tty_wakeup(tty->link);
Linus Torvalds's avatar
Linus Torvalds committed
85 86 87
	set_bit(TTY_THROTTLED, &tty->flags);
}

88 89 90
/**
 *	pty_space	-	report space left for writing
 *	@to: tty we are writing into
Linus Torvalds's avatar
Linus Torvalds committed
91
 *
92 93 94 95 96 97 98
 *	The tty buffers allow 64K but we sneak a peak and clip at 8K this
 *	allows a lot of overspill room for echo and other fun messes to
 *	be handled properly
 */

static int pty_space(struct tty_struct *to)
{
99
	int n = 8192 - to->port->buf.memory_used;
100 101 102 103 104 105 106 107 108 109
	if (n < 0)
		return 0;
	return n;
}

/**
 *	pty_write		-	write to a pty
 *	@tty: the tty we write from
 *	@buf: kernel buffer of data
 *	@count: bytes to write
110
 *
111 112 113 114
 *	Our "hardware" write method. Data is coming from the ldisc which
 *	may be in a non sleeping state. We simply throw this at the other
 *	end of the link as if we were an IRQ handler receiving stuff for
 *	the other side of the pty/tty pair.
Linus Torvalds's avatar
Linus Torvalds committed
115
 */
116

117
static int pty_write(struct tty_struct *tty, const unsigned char *buf, int c)
Linus Torvalds's avatar
Linus Torvalds committed
118 119 120
{
	struct tty_struct *to = tty->link;

121
	if (tty->stopped)
Linus Torvalds's avatar
Linus Torvalds committed
122
		return 0;
123 124 125

	if (c > 0) {
		/* Stuff the data into the input queue of the other end */
126
		c = tty_insert_flip_string(to->port, buf, c);
127
		/* And shovel */
128
		if (c) {
129
			tty_flip_buffer_push(to->port);
130 131
			tty_wakeup(tty);
		}
132
	}
Linus Torvalds's avatar
Linus Torvalds committed
133 134 135
	return c;
}

136 137 138 139 140 141 142 143
/**
 *	pty_write_room	-	write space
 *	@tty: tty we are writing from
 *
 *	Report how many bytes the ldisc can send into the queue for
 *	the other device.
 */

Linus Torvalds's avatar
Linus Torvalds committed
144 145
static int pty_write_room(struct tty_struct *tty)
{
146 147
	if (tty->stopped)
		return 0;
148
	return pty_space(tty->link);
Linus Torvalds's avatar
Linus Torvalds committed
149 150
}

151 152 153
/**
 *	pty_chars_in_buffer	-	characters currently in our tx queue
 *	@tty: our tty
Alan Cox's avatar
Alan Cox committed
154
 *
155 156
 *	Report how much we have in the transmit queue. As everything is
 *	instantly at the other end this is easy to implement.
Linus Torvalds's avatar
Linus Torvalds committed
157
 */
158

Linus Torvalds's avatar
Linus Torvalds committed
159 160
static int pty_chars_in_buffer(struct tty_struct *tty)
{
161
	return 0;
Linus Torvalds's avatar
Linus Torvalds committed
162 163 164
}

/* Set the lock flag on a pty */
Alan Cox's avatar
Alan Cox committed
165
static int pty_set_lock(struct tty_struct *tty, int __user *arg)
Linus Torvalds's avatar
Linus Torvalds committed
166 167
{
	int val;
Alan Cox's avatar
Alan Cox committed
168
	if (get_user(val, arg))
Linus Torvalds's avatar
Linus Torvalds committed
169 170 171 172 173 174 175 176
		return -EFAULT;
	if (val)
		set_bit(TTY_PTY_LOCK, &tty->flags);
	else
		clear_bit(TTY_PTY_LOCK, &tty->flags);
	return 0;
}

177 178 179 180 181 182
static int pty_get_lock(struct tty_struct *tty, int __user *arg)
{
	int locked = test_bit(TTY_PTY_LOCK, &tty->flags);
	return put_user(locked, arg);
}

183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204
/* Set the packet mode on a pty */
static int pty_set_pktmode(struct tty_struct *tty, int __user *arg)
{
	unsigned long flags;
	int pktmode;

	if (get_user(pktmode, arg))
		return -EFAULT;

	spin_lock_irqsave(&tty->ctrl_lock, flags);
	if (pktmode) {
		if (!tty->packet) {
			tty->packet = 1;
			tty->link->ctrl_status = 0;
		}
	} else
		tty->packet = 0;
	spin_unlock_irqrestore(&tty->ctrl_lock, flags);

	return 0;
}

205 206 207 208 209 210 211
/* Get the packet mode of a pty */
static int pty_get_pktmode(struct tty_struct *tty, int __user *arg)
{
	int pktmode = tty->packet;
	return put_user(pktmode, arg);
}

212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228
/* Send a signal to the slave */
static int pty_signal(struct tty_struct *tty, int sig)
{
	unsigned long flags;
	struct pid *pgrp;

	if (tty->link) {
		spin_lock_irqsave(&tty->link->ctrl_lock, flags);
		pgrp = get_pid(tty->link->pgrp);
		spin_unlock_irqrestore(&tty->link->ctrl_lock, flags);

		kill_pgrp(pgrp, sig, 1);
		put_pid(pgrp);
	}
	return 0;
}

Linus Torvalds's avatar
Linus Torvalds committed
229 230 231
static void pty_flush_buffer(struct tty_struct *tty)
{
	struct tty_struct *to = tty->link;
Alan Cox's avatar
Alan Cox committed
232
	unsigned long flags;
Alan Cox's avatar
Alan Cox committed
233

Linus Torvalds's avatar
Linus Torvalds committed
234 235
	if (!to)
		return;
236
	/* tty_buffer_flush(to); FIXME */
Linus Torvalds's avatar
Linus Torvalds committed
237
	if (to->packet) {
Alan Cox's avatar
Alan Cox committed
238
		spin_lock_irqsave(&tty->ctrl_lock, flags);
Linus Torvalds's avatar
Linus Torvalds committed
239 240
		tty->ctrl_status |= TIOCPKT_FLUSHWRITE;
		wake_up_interruptible(&to->read_wait);
Alan Cox's avatar
Alan Cox committed
241
		spin_unlock_irqrestore(&tty->ctrl_lock, flags);
Linus Torvalds's avatar
Linus Torvalds committed
242 243 244
	}
}

Alan Cox's avatar
Alan Cox committed
245
static int pty_open(struct tty_struct *tty, struct file *filp)
Linus Torvalds's avatar
Linus Torvalds committed
246 247 248 249 250 251
{
	int	retval = -ENODEV;

	if (!tty || !tty->link)
		goto out;

252 253
	set_bit(TTY_IO_ERROR, &tty->flags);

Linus Torvalds's avatar
Linus Torvalds committed
254 255 256 257 258
	retval = -EIO;
	if (test_bit(TTY_OTHER_CLOSED, &tty->flags))
		goto out;
	if (test_bit(TTY_PTY_LOCK, &tty->link->flags))
		goto out;
259
	if (tty->driver->subtype == PTY_TYPE_SLAVE && tty->link->count != 1)
Linus Torvalds's avatar
Linus Torvalds committed
260 261
		goto out;

262
	clear_bit(TTY_IO_ERROR, &tty->flags);
Linus Torvalds's avatar
Linus Torvalds committed
263 264 265 266 267 268 269
	clear_bit(TTY_OTHER_CLOSED, &tty->link->flags);
	set_bit(TTY_THROTTLED, &tty->flags);
	retval = 0;
out:
	return retval;
}

Alan Cox's avatar
Alan Cox committed
270 271
static void pty_set_termios(struct tty_struct *tty,
					struct ktermios *old_termios)
Linus Torvalds's avatar
Linus Torvalds committed
272
{
273 274
	tty->termios.c_cflag &= ~(CSIZE | PARENB);
	tty->termios.c_cflag |= (CS8 | CREAD);
Linus Torvalds's avatar
Linus Torvalds committed
275 276
}

Alan Cox's avatar
Alan Cox committed
277 278 279
/**
 *	pty_do_resize		-	resize event
 *	@tty: tty being resized
Alan Cox's avatar
Alan Cox committed
280
 *	@ws: window size being set.
Alan Cox's avatar
Alan Cox committed
281
 *
282
 *	Update the termios variables and send the necessary signals to
Alan Cox's avatar
Alan Cox committed
283 284 285
 *	peform a terminal resize correctly
 */

Josh Triplett's avatar
Josh Triplett committed
286
static int pty_resize(struct tty_struct *tty,  struct winsize *ws)
Alan Cox's avatar
Alan Cox committed
287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323
{
	struct pid *pgrp, *rpgrp;
	unsigned long flags;
	struct tty_struct *pty = tty->link;

	/* For a PTY we need to lock the tty side */
	mutex_lock(&tty->termios_mutex);
	if (!memcmp(ws, &tty->winsize, sizeof(*ws)))
		goto done;

	/* Get the PID values and reference them so we can
	   avoid holding the tty ctrl lock while sending signals.
	   We need to lock these individually however. */

	spin_lock_irqsave(&tty->ctrl_lock, flags);
	pgrp = get_pid(tty->pgrp);
	spin_unlock_irqrestore(&tty->ctrl_lock, flags);

	spin_lock_irqsave(&pty->ctrl_lock, flags);
	rpgrp = get_pid(pty->pgrp);
	spin_unlock_irqrestore(&pty->ctrl_lock, flags);

	if (pgrp)
		kill_pgrp(pgrp, SIGWINCH, 1);
	if (rpgrp != pgrp && rpgrp)
		kill_pgrp(rpgrp, SIGWINCH, 1);

	put_pid(pgrp);
	put_pid(rpgrp);

	tty->winsize = *ws;
	pty->winsize = *ws;	/* Never used so will go away soon */
done:
	mutex_unlock(&tty->termios_mutex);
	return 0;
}

Alan Cox's avatar
Alan Cox committed
324 325 326 327 328 329 330 331 332 333 334
/**
 *	pty_common_install		-	set up the pty pair
 *	@driver: the pty driver
 *	@tty: the tty being instantiated
 *	@bool: legacy, true if this is BSD style
 *
 *	Perform the initial set up for the tty/pty pair. Called from the
 *	tty layer when the port is first opened.
 *
 *	Locking: the caller must hold the tty_mutex
 */
335 336
static int pty_common_install(struct tty_driver *driver, struct tty_struct *tty,
		bool legacy)
337 338
{
	struct tty_struct *o_tty;
Jiri Slaby's avatar
Jiri Slaby committed
339
	struct tty_port *ports[2];
340
	int idx = tty->index;
341
	int retval = -ENOMEM;
342 343

	o_tty = alloc_tty_struct();
344 345
	if (!o_tty)
		goto err;
Jiri Slaby's avatar
Jiri Slaby committed
346 347
	ports[0] = kmalloc(sizeof **ports, GFP_KERNEL);
	ports[1] = kmalloc(sizeof **ports, GFP_KERNEL);
348
	if (!ports[0] || !ports[1])
Jiri Slaby's avatar
Jiri Slaby committed
349
		goto err_free_tty;
350 351
	if (!try_module_get(driver->other->owner)) {
		/* This cannot in fact currently happen */
352
		goto err_free_tty;
353 354 355
	}
	initialize_tty_struct(o_tty, driver->other, idx);

356 357 358 359 360 361 362 363 364 365 366 367 368 369
	if (legacy) {
		/* We always use new tty termios data so we can do this
		   the easy way .. */
		retval = tty_init_termios(tty);
		if (retval)
			goto err_deinit_tty;

		retval = tty_init_termios(o_tty);
		if (retval)
			goto err_free_termios;

		driver->other->ttys[idx] = o_tty;
		driver->ttys[idx] = tty;
	} else {
370 371 372 373
		memset(&tty->termios_locked, 0, sizeof(tty->termios_locked));
		tty->termios = driver->init_termios;
		memset(&o_tty->termios_locked, 0, sizeof(tty->termios_locked));
		o_tty->termios = driver->other->init_termios;
374
	}
Alan Cox's avatar
Alan Cox committed
375

376 377 378 379 380 381 382 383 384
	/*
	 * Everything allocated ... set up the o_tty structure.
	 */
	tty_driver_kref_get(driver->other);
	if (driver->subtype == PTY_TYPE_MASTER)
		o_tty->count++;
	/* Establish the links in both directions */
	tty->link   = o_tty;
	o_tty->link = tty;
Jiri Slaby's avatar
Jiri Slaby committed
385 386 387 388
	tty_port_init(ports[0]);
	tty_port_init(ports[1]);
	o_tty->port = ports[0];
	tty->port = ports[1];
Jiri Slaby's avatar
Jiri Slaby committed
389
	o_tty->port->itty = o_tty;
390 391 392 393

	tty_driver_kref_get(driver);
	tty->count++;
	return 0;
394
err_free_termios:
395 396
	if (legacy)
		tty_free_termios(tty);
397 398
err_deinit_tty:
	deinitialize_tty_struct(o_tty);
399
	module_put(o_tty->driver->owner);
400
err_free_tty:
Jiri Slaby's avatar
Jiri Slaby committed
401 402
	kfree(ports[0]);
	kfree(ports[1]);
403
	free_tty_struct(o_tty);
404
err:
405
	return retval;
406 407
}

Jiri Slaby's avatar
Jiri Slaby committed
408 409
static void pty_cleanup(struct tty_struct *tty)
{
Jiri Slaby's avatar
Jiri Slaby committed
410
	tty_port_put(tty->port);
Jiri Slaby's avatar
Jiri Slaby committed
411 412
}

413 414 415 416 417 418 419 420
/* Traditional BSD devices */
#ifdef CONFIG_LEGACY_PTYS

static int pty_install(struct tty_driver *driver, struct tty_struct *tty)
{
	return pty_common_install(driver, tty, true);
}

Alan Cox's avatar
Alan Cox committed
421 422 423 424 425 426 427 428
static void pty_remove(struct tty_driver *driver, struct tty_struct *tty)
{
	struct tty_struct *pair = tty->link;
	driver->ttys[tty->index] = NULL;
	if (pair)
		pair->driver->ttys[pair->index] = NULL;
}

429
static int pty_bsd_ioctl(struct tty_struct *tty,
Linus Torvalds's avatar
Linus Torvalds committed
430 431 432 433 434
			 unsigned int cmd, unsigned long arg)
{
	switch (cmd) {
	case TIOCSPTLCK: /* Set PT Lock (disallow slave open) */
		return pty_set_lock(tty, (int __user *) arg);
435 436
	case TIOCGPTLCK: /* Get PT Lock status */
		return pty_get_lock(tty, (int __user *)arg);
437 438
	case TIOCPKT: /* Set PT packet mode */
		return pty_set_pktmode(tty, (int __user *)arg);
439 440
	case TIOCGPKT: /* Get PT packet mode */
		return pty_get_pktmode(tty, (int __user *)arg);
441 442
	case TIOCSIG:    /* Send signal to other side of pty */
		return pty_signal(tty, (int) arg);
443 444
	case TIOCGPTN: /* TTY returns ENOTTY, but glibc expects EINVAL here */
		return -EINVAL;
Linus Torvalds's avatar
Linus Torvalds committed
445 446 447 448
	}
	return -ENOIOCTLCMD;
}

449 450 451
static int legacy_count = CONFIG_LEGACY_PTY_COUNT;
module_param(legacy_count, int, 0);

452 453 454 455 456 457
/*
 * The master side of a pty can do TIOCSPTLCK and thus
 * has pty_bsd_ioctl.
 */
static const struct tty_operations master_pty_ops_bsd = {
	.install = pty_install,
Alan Cox's avatar
Alan Cox committed
458 459 460 461 462 463 464 465 466
	.open = pty_open,
	.close = pty_close,
	.write = pty_write,
	.write_room = pty_write_room,
	.flush_buffer = pty_flush_buffer,
	.chars_in_buffer = pty_chars_in_buffer,
	.unthrottle = pty_unthrottle,
	.set_termios = pty_set_termios,
	.ioctl = pty_bsd_ioctl,
Jiri Slaby's avatar
Jiri Slaby committed
467
	.cleanup = pty_cleanup,
Alan Cox's avatar
Alan Cox committed
468 469
	.resize = pty_resize,
	.remove = pty_remove
Alan Cox's avatar
Alan Cox committed
470 471
};

472 473 474 475 476 477 478 479 480 481
static const struct tty_operations slave_pty_ops_bsd = {
	.install = pty_install,
	.open = pty_open,
	.close = pty_close,
	.write = pty_write,
	.write_room = pty_write_room,
	.flush_buffer = pty_flush_buffer,
	.chars_in_buffer = pty_chars_in_buffer,
	.unthrottle = pty_unthrottle,
	.set_termios = pty_set_termios,
Jiri Slaby's avatar
Jiri Slaby committed
482
	.cleanup = pty_cleanup,
Alan Cox's avatar
Alan Cox committed
483 484
	.resize = pty_resize,
	.remove = pty_remove
485 486
};

Linus Torvalds's avatar
Linus Torvalds committed
487 488
static void __init legacy_pty_init(void)
{
489 490
	struct tty_driver *pty_driver, *pty_slave_driver;

491 492
	if (legacy_count <= 0)
		return;
Linus Torvalds's avatar
Linus Torvalds committed
493

494 495 496 497
	pty_driver = tty_alloc_driver(legacy_count,
			TTY_DRIVER_RESET_TERMIOS |
			TTY_DRIVER_REAL_RAW |
			TTY_DRIVER_DYNAMIC_ALLOC);
498
	if (IS_ERR(pty_driver))
Linus Torvalds's avatar
Linus Torvalds committed
499 500
		panic("Couldn't allocate pty driver");

501 502 503 504
	pty_slave_driver = tty_alloc_driver(legacy_count,
			TTY_DRIVER_RESET_TERMIOS |
			TTY_DRIVER_REAL_RAW |
			TTY_DRIVER_DYNAMIC_ALLOC);
505
	if (IS_ERR(pty_slave_driver))
Linus Torvalds's avatar
Linus Torvalds committed
506 507 508 509 510 511 512 513 514 515 516 517 518
		panic("Couldn't allocate pty slave driver");

	pty_driver->driver_name = "pty_master";
	pty_driver->name = "pty";
	pty_driver->major = PTY_MASTER_MAJOR;
	pty_driver->minor_start = 0;
	pty_driver->type = TTY_DRIVER_TYPE_PTY;
	pty_driver->subtype = PTY_TYPE_MASTER;
	pty_driver->init_termios = tty_std_termios;
	pty_driver->init_termios.c_iflag = 0;
	pty_driver->init_termios.c_oflag = 0;
	pty_driver->init_termios.c_cflag = B38400 | CS8 | CREAD;
	pty_driver->init_termios.c_lflag = 0;
Alan Cox's avatar
Alan Cox committed
519 520
	pty_driver->init_termios.c_ispeed = 38400;
	pty_driver->init_termios.c_ospeed = 38400;
Linus Torvalds's avatar
Linus Torvalds committed
521
	pty_driver->other = pty_slave_driver;
522
	tty_set_operations(pty_driver, &master_pty_ops_bsd);
Linus Torvalds's avatar
Linus Torvalds committed
523 524 525 526 527 528 529 530 531

	pty_slave_driver->driver_name = "pty_slave";
	pty_slave_driver->name = "ttyp";
	pty_slave_driver->major = PTY_SLAVE_MAJOR;
	pty_slave_driver->minor_start = 0;
	pty_slave_driver->type = TTY_DRIVER_TYPE_PTY;
	pty_slave_driver->subtype = PTY_TYPE_SLAVE;
	pty_slave_driver->init_termios = tty_std_termios;
	pty_slave_driver->init_termios.c_cflag = B38400 | CS8 | CREAD;
Alan Cox's avatar
Alan Cox committed
532 533
	pty_slave_driver->init_termios.c_ispeed = 38400;
	pty_slave_driver->init_termios.c_ospeed = 38400;
Linus Torvalds's avatar
Linus Torvalds committed
534
	pty_slave_driver->other = pty_driver;
535
	tty_set_operations(pty_slave_driver, &slave_pty_ops_bsd);
Linus Torvalds's avatar
Linus Torvalds committed
536 537 538 539 540 541 542 543 544 545 546 547 548

	if (tty_register_driver(pty_driver))
		panic("Couldn't register pty driver");
	if (tty_register_driver(pty_slave_driver))
		panic("Couldn't register pty slave driver");
}
#else
static inline void legacy_pty_init(void) { }
#endif

/* Unix98 devices */
#ifdef CONFIG_UNIX98_PTYS

549 550
static struct cdev ptmx_cdev;

551
static int pty_unix98_ioctl(struct tty_struct *tty,
Linus Torvalds's avatar
Linus Torvalds committed
552 553 554 555 556
			    unsigned int cmd, unsigned long arg)
{
	switch (cmd) {
	case TIOCSPTLCK: /* Set PT Lock (disallow slave open) */
		return pty_set_lock(tty, (int __user *)arg);
557 558
	case TIOCGPTLCK: /* Get PT Lock status */
		return pty_get_lock(tty, (int __user *)arg);
559 560
	case TIOCPKT: /* Set PT packet mode */
		return pty_set_pktmode(tty, (int __user *)arg);
561 562
	case TIOCGPKT: /* Get PT packet mode */
		return pty_get_pktmode(tty, (int __user *)arg);
Linus Torvalds's avatar
Linus Torvalds committed
563 564
	case TIOCGPTN: /* Get PT Number */
		return put_user(tty->index, (unsigned int __user *)arg);
565 566
	case TIOCSIG:    /* Send signal to other side of pty */
		return pty_signal(tty, (int) arg);
Linus Torvalds's avatar
Linus Torvalds committed
567 568 569 570 571
	}

	return -ENOIOCTLCMD;
}

572 573 574 575 576 577 578 579 580
/**
 *	ptm_unix98_lookup	-	find a pty master
 *	@driver: ptm driver
 *	@idx: tty index
 *
 *	Look up a pty master device. Called under the tty_mutex for now.
 *	This provides our locking.
 */

581 582
static struct tty_struct *ptm_unix98_lookup(struct tty_driver *driver,
		struct inode *ptm_inode, int idx)
583
{
584 585
	/* Master must be open via /dev/ptmx */
	return ERR_PTR(-EIO);
586 587 588 589 590 591 592 593
}

/**
 *	pts_unix98_lookup	-	find a pty slave
 *	@driver: pts driver
 *	@idx: tty index
 *
 *	Look up a pty master device. Called under the tty_mutex for now.
594
 *	This provides our locking for the tty pointer.
595 596
 */

597 598
static struct tty_struct *pts_unix98_lookup(struct tty_driver *driver,
		struct inode *pts_inode, int idx)
599
{
600 601 602
	struct tty_struct *tty;

	mutex_lock(&devpts_mutex);
603
	tty = devpts_get_priv(pts_inode);
604
	mutex_unlock(&devpts_mutex);
605 606 607 608 609 610
	/* Master must be open before slave */
	if (!tty)
		return ERR_PTR(-EIO);
	return tty;
}

Alan Cox's avatar
Alan Cox committed
611 612 613
/* We have no need to install and remove our tty objects as devpts does all
   the work for us */

614
static int pty_unix98_install(struct tty_driver *driver, struct tty_struct *tty)
Alan Cox's avatar
Alan Cox committed
615
{
616
	return pty_common_install(driver, tty, false);
Alan Cox's avatar
Alan Cox committed
617 618
}

619
static void pty_unix98_remove(struct tty_driver *driver, struct tty_struct *tty)
Alan Cox's avatar
Alan Cox committed
620 621 622
{
}

623 624 625 626 627 628
/* this is called once with whichever end is closed last */
static void pty_unix98_shutdown(struct tty_struct *tty)
{
	devpts_kill_index(tty->driver_data, tty->index);
}

Alan Cox's avatar
Alan Cox committed
629
static const struct tty_operations ptm_unix98_ops = {
630
	.lookup = ptm_unix98_lookup,
631
	.install = pty_unix98_install,
632
	.remove = pty_unix98_remove,
Alan Cox's avatar
Alan Cox committed
633 634 635 636 637 638 639 640
	.open = pty_open,
	.close = pty_close,
	.write = pty_write,
	.write_room = pty_write_room,
	.flush_buffer = pty_flush_buffer,
	.chars_in_buffer = pty_chars_in_buffer,
	.unthrottle = pty_unthrottle,
	.set_termios = pty_set_termios,
Alan Cox's avatar
Alan Cox committed
641
	.ioctl = pty_unix98_ioctl,
642
	.resize = pty_resize,
Jiri Slaby's avatar
Jiri Slaby committed
643
	.shutdown = pty_unix98_shutdown,
644
	.cleanup = pty_cleanup
Alan Cox's avatar
Alan Cox committed
645 646
};

647 648
static const struct tty_operations pty_unix98_ops = {
	.lookup = pts_unix98_lookup,
649
	.install = pty_unix98_install,
650
	.remove = pty_unix98_remove,
651 652 653 654 655 656 657 658
	.open = pty_open,
	.close = pty_close,
	.write = pty_write,
	.write_room = pty_write_room,
	.flush_buffer = pty_flush_buffer,
	.chars_in_buffer = pty_chars_in_buffer,
	.unthrottle = pty_unthrottle,
	.set_termios = pty_set_termios,
Jiri Slaby's avatar
Jiri Slaby committed
659
	.shutdown = pty_unix98_shutdown,
Jiri Slaby's avatar
Jiri Slaby committed
660
	.cleanup = pty_cleanup,
661
};
662 663 664 665 666 667 668 669 670

/**
 *	ptmx_open		-	open a unix 98 pty master
 *	@inode: inode of device file
 *	@filp: file pointer to tty
 *
 *	Allocate a unix98 pty master device from the ptmx driver.
 *
 *	Locking: tty_mutex protects the init_dev work. tty->count should
671
 *		protect the rest.
672 673 674
 *		allocated_ptys_lock handles the list of free pty numbers
 */

675
static int ptmx_open(struct inode *inode, struct file *filp)
676 677
{
	struct tty_struct *tty;
678
	struct inode *slave_inode;
679 680 681 682 683
	int retval;
	int index;

	nonseekable_open(inode, filp);

684 685 686 687
	retval = tty_alloc_file(filp);
	if (retval)
		return retval;

688
	/* find a device that is not in use. */
Alan Cox's avatar
Alan Cox committed
689
	mutex_lock(&devpts_mutex);
690
	index = devpts_new_index(inode);
691 692
	if (index < 0) {
		retval = index;
693
		mutex_unlock(&devpts_mutex);
694 695
		goto err_file;
	}
696

Alan Cox's avatar
Alan Cox committed
697 698
	mutex_unlock(&devpts_mutex);

699
	mutex_lock(&tty_mutex);
700
	tty = tty_init_dev(ptm_driver, index);
701

702 703
	if (IS_ERR(tty)) {
		retval = PTR_ERR(tty);
704
		goto out;
705
	}
706

Alan Cox's avatar
Alan Cox committed
707 708 709 710
	/* The tty returned here is locked so we can safely
	   drop the mutex */
	mutex_unlock(&tty_mutex);

711
	set_bit(TTY_PTY_LOCK, &tty->flags); /* LOCK THE SLAVE */
712
	tty->driver_data = inode;
Nick Piggin's avatar
Nick Piggin committed
713

714
	tty_add_file(tty, filp);
715

716 717 718
	slave_inode = devpts_pty_new(inode,
			MKDEV(UNIX98_PTY_SLAVE_MAJOR, index), index,
			tty->link);
719 720
	if (IS_ERR(slave_inode)) {
		retval = PTR_ERR(slave_inode);
721
		goto err_release;
722
	}
723
	tty->link->driver_data = slave_inode;
724 725

	retval = ptm_driver->ops->open(tty, filp);
726
	if (retval)
727 728
		goto err_release;

Alan Cox's avatar
Alan Cox committed
729
	tty_unlock(tty);
730 731
	return 0;
err_release:
Alan Cox's avatar
Alan Cox committed
732
	tty_unlock(tty);
733
	tty_release(inode, filp);
734 735
	return retval;
out:
Alan Cox's avatar
Alan Cox committed
736
	mutex_unlock(&tty_mutex);
737
	devpts_kill_index(inode, index);
738 739
err_file:
	tty_free_file(filp);
740
	return retval;
741 742 743 744
}

static struct file_operations ptmx_fops;

Linus Torvalds's avatar
Linus Torvalds committed
745 746
static void __init unix98_pty_init(void)
{
747 748 749 750 751 752
	ptm_driver = tty_alloc_driver(NR_UNIX98_PTY_MAX,
			TTY_DRIVER_RESET_TERMIOS |
			TTY_DRIVER_REAL_RAW |
			TTY_DRIVER_DYNAMIC_DEV |
			TTY_DRIVER_DEVPTS_MEM |
			TTY_DRIVER_DYNAMIC_ALLOC);
753
	if (IS_ERR(ptm_driver))
Linus Torvalds's avatar
Linus Torvalds committed
754
		panic("Couldn't allocate Unix98 ptm driver");
755 756 757 758 759 760
	pts_driver = tty_alloc_driver(NR_UNIX98_PTY_MAX,
			TTY_DRIVER_RESET_TERMIOS |
			TTY_DRIVER_REAL_RAW |
			TTY_DRIVER_DYNAMIC_DEV |
			TTY_DRIVER_DEVPTS_MEM |
			TTY_DRIVER_DYNAMIC_ALLOC);
761
	if (IS_ERR(pts_driver))
Linus Torvalds's avatar
Linus Torvalds committed
762 763 764 765 766 767 768 769 770 771 772 773 774
		panic("Couldn't allocate Unix98 pts driver");

	ptm_driver->driver_name = "pty_master";
	ptm_driver->name = "ptm";
	ptm_driver->major = UNIX98_PTY_MASTER_MAJOR;
	ptm_driver->minor_start = 0;
	ptm_driver->type = TTY_DRIVER_TYPE_PTY;
	ptm_driver->subtype = PTY_TYPE_MASTER;
	ptm_driver->init_termios = tty_std_termios;
	ptm_driver->init_termios.c_iflag = 0;
	ptm_driver->init_termios.c_oflag = 0;
	ptm_driver->init_termios.c_cflag = B38400 | CS8 | CREAD;
	ptm_driver->init_termios.c_lflag = 0;
Alan Cox's avatar
Alan Cox committed
775 776
	ptm_driver->init_termios.c_ispeed = 38400;
	ptm_driver->init_termios.c_ospeed = 38400;
Linus Torvalds's avatar
Linus Torvalds committed
777
	ptm_driver->other = pts_driver;
Alan Cox's avatar
Alan Cox committed
778
	tty_set_operations(ptm_driver, &ptm_unix98_ops);
Linus Torvalds's avatar
Linus Torvalds committed
779 780 781 782 783 784 785 786 787

	pts_driver->driver_name = "pty_slave";
	pts_driver->name = "pts";
	pts_driver->major = UNIX98_PTY_SLAVE_MAJOR;
	pts_driver->minor_start = 0;
	pts_driver->type = TTY_DRIVER_TYPE_PTY;
	pts_driver->subtype = PTY_TYPE_SLAVE;
	pts_driver->init_termios = tty_std_termios;
	pts_driver->init_termios.c_cflag = B38400 | CS8 | CREAD;
Alan Cox's avatar
Alan Cox committed
788 789
	pts_driver->init_termios.c_ispeed = 38400;
	pts_driver->init_termios.c_ospeed = 38400;
Linus Torvalds's avatar
Linus Torvalds committed
790
	pts_driver->other = ptm_driver;
791
	tty_set_operations(pts_driver, &pty_unix98_ops);
Alan Cox's avatar
Alan Cox committed
792

Linus Torvalds's avatar
Linus Torvalds committed
793 794 795 796 797
	if (tty_register_driver(ptm_driver))
		panic("Couldn't register Unix98 ptm driver");
	if (tty_register_driver(pts_driver))
		panic("Couldn't register Unix98 pts driver");

798 799 800 801 802 803 804
	/* Now create the /dev/ptmx special device */
	tty_default_fops(&ptmx_fops);
	ptmx_fops.open = ptmx_open;

	cdev_init(&ptmx_cdev, &ptmx_fops);
	if (cdev_add(&ptmx_cdev, MKDEV(TTYAUX_MAJOR, 2), 1) ||
	    register_chrdev_region(MKDEV(TTYAUX_MAJOR, 2), 1, "/dev/ptmx") < 0)
Cong Ding's avatar
Cong Ding committed
805
		panic("Couldn't register /dev/ptmx driver");
806
	device_create(tty_class, NULL, MKDEV(TTYAUX_MAJOR, 2), NULL, "ptmx");
Linus Torvalds's avatar
Linus Torvalds committed
807
}
808

Linus Torvalds's avatar
Linus Torvalds committed
809 810 811 812 813 814 815 816 817 818 819
#else
static inline void unix98_pty_init(void) { }
#endif

static int __init pty_init(void)
{
	legacy_pty_init();
	unix98_pty_init();
	return 0;
}
module_init(pty_init);