Merge branch 'for-linus' of git://git.kernel.org/pub/scm/linux/kernel/git/s390/linux
[linux-2.6-block.git] / drivers / tty / pty.c
CommitLineData
1da177e4 1/*
1da177e4
LT
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
1da177e4 6 *
1da177e4
LT
7 */
8
fe9cd962 9#include <linux/module.h>
1da177e4
LT
10
11#include <linux/errno.h>
1da177e4
LT
12#include <linux/interrupt.h>
13#include <linux/tty.h>
14#include <linux/tty_flip.h>
15#include <linux/fcntl.h>
d43c36dc 16#include <linux/sched.h>
1da177e4
LT
17#include <linux/string.h>
18#include <linux/major.h>
19#include <linux/mm.h>
20#include <linux/init.h>
d81ed103 21#include <linux/device.h>
fe9cd962 22#include <linux/uaccess.h>
1da177e4
LT
23#include <linux/bitops.h>
24#include <linux/devpts_fs.h>
5a0e3ad6 25#include <linux/slab.h>
d739e65b 26#include <linux/mutex.h>
1da177e4 27
fe9cd962 28
1da177e4 29#ifdef CONFIG_UNIX98_PTYS
da2bdf9a 30static struct tty_driver *ptm_driver;
1da177e4 31static struct tty_driver *pts_driver;
d739e65b 32static DEFINE_MUTEX(devpts_mutex);
1da177e4
LT
33#endif
34
fe9cd962 35static void pty_close(struct tty_struct *tty, struct file *filp)
1da177e4 36{
fe9cd962
AC
37 BUG_ON(!tty);
38 if (tty->driver->subtype == PTY_TYPE_MASTER)
39 WARN_ON(tty->count > 1);
40 else {
69939035
PH
41 if (test_bit(TTY_IO_ERROR, &tty->flags))
42 return;
1da177e4
LT
43 if (tty->count > 2)
44 return;
45 }
69939035 46 set_bit(TTY_IO_ERROR, &tty->flags);
1da177e4
LT
47 wake_up_interruptible(&tty->read_wait);
48 wake_up_interruptible(&tty->write_wait);
49 tty->packet = 0;
89c8d91e 50 /* Review - krefs on tty_link ?? */
1da177e4
LT
51 if (!tty->link)
52 return;
1da177e4
LT
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);
ce1000dd 58#ifdef CONFIG_UNIX98_PTYS
d739e65b 59 if (tty->driver == ptm_driver) {
b9f8033f 60 mutex_lock(&devpts_mutex);
7acf6cd8
PH
61 if (tty->link->driver_data)
62 devpts_pty_kill(tty->link->driver_data);
b9f8033f 63 mutex_unlock(&devpts_mutex);
d739e65b 64 }
ce1000dd 65#endif
89c8d91e 66 tty_unlock(tty);
11dbf203 67 tty_vhangup(tty->link);
89c8d91e 68 tty_lock(tty);
1da177e4
LT
69 }
70}
71
72/*
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
fe9cd962 76 * unthrottle routine when there are fewer than TTY_THRESHOLD_UNTHROTTLE
1da177e4
LT
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.
81 */
fe9cd962 82static void pty_unthrottle(struct tty_struct *tty)
1da177e4 83{
d945cb9c 84 tty_wakeup(tty->link);
1da177e4
LT
85 set_bit(TTY_THROTTLED, &tty->flags);
86}
87
d945cb9c
AC
88/**
89 * pty_space - report space left for writing
90 * @to: tty we are writing into
1da177e4 91 *
d945cb9c
AC
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
94 * be handled properly
95 */
96
97static int pty_space(struct tty_struct *to)
98{
ecbbfd44 99 int n = 8192 - to->port->buf.memory_used;
d945cb9c
AC
100 if (n < 0)
101 return 0;
102 return n;
103}
104
105/**
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
762faaed 110 *
d945cb9c
AC
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.
1da177e4 115 */
d945cb9c 116
ac89a917 117static int pty_write(struct tty_struct *tty, const unsigned char *buf, int c)
1da177e4
LT
118{
119 struct tty_struct *to = tty->link;
1da177e4 120
d945cb9c 121 if (tty->stopped)
1da177e4 122 return 0;
d945cb9c 123
d945cb9c
AC
124 if (c > 0) {
125 /* Stuff the data into the input queue of the other end */
05c7cd39 126 c = tty_insert_flip_string(to->port, buf, c);
d945cb9c 127 /* And shovel */
202c4675 128 if (c) {
2e124b4a 129 tty_flip_buffer_push(to->port);
202c4675
LT
130 tty_wakeup(tty);
131 }
762faaed 132 }
1da177e4
LT
133 return c;
134}
135
d945cb9c
AC
136/**
137 * pty_write_room - write space
138 * @tty: tty we are writing from
139 *
140 * Report how many bytes the ldisc can send into the queue for
141 * the other device.
142 */
143
1da177e4
LT
144static int pty_write_room(struct tty_struct *tty)
145{
85dfd81d
LT
146 if (tty->stopped)
147 return 0;
d945cb9c 148 return pty_space(tty->link);
1da177e4
LT
149}
150
d945cb9c
AC
151/**
152 * pty_chars_in_buffer - characters currently in our tx queue
153 * @tty: our tty
fe9cd962 154 *
d945cb9c
AC
155 * Report how much we have in the transmit queue. As everything is
156 * instantly at the other end this is easy to implement.
1da177e4 157 */
d945cb9c 158
1da177e4
LT
159static int pty_chars_in_buffer(struct tty_struct *tty)
160{
d945cb9c 161 return 0;
1da177e4
LT
162}
163
164/* Set the lock flag on a pty */
fe9cd962 165static int pty_set_lock(struct tty_struct *tty, int __user *arg)
1da177e4
LT
166{
167 int val;
fe9cd962 168 if (get_user(val, arg))
1da177e4
LT
169 return -EFAULT;
170 if (val)
171 set_bit(TTY_PTY_LOCK, &tty->flags);
172 else
173 clear_bit(TTY_PTY_LOCK, &tty->flags);
174 return 0;
175}
176
84fd7bdf
CG
177static int pty_get_lock(struct tty_struct *tty, int __user *arg)
178{
179 int locked = test_bit(TTY_PTY_LOCK, &tty->flags);
180 return put_user(locked, arg);
181}
182
06026d91
CG
183/* Set the packet mode on a pty */
184static int pty_set_pktmode(struct tty_struct *tty, int __user *arg)
185{
186 unsigned long flags;
187 int pktmode;
188
189 if (get_user(pktmode, arg))
190 return -EFAULT;
191
192 spin_lock_irqsave(&tty->ctrl_lock, flags);
193 if (pktmode) {
194 if (!tty->packet) {
195 tty->packet = 1;
196 tty->link->ctrl_status = 0;
197 }
198 } else
199 tty->packet = 0;
200 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
201
202 return 0;
203}
204
84fd7bdf
CG
205/* Get the packet mode of a pty */
206static int pty_get_pktmode(struct tty_struct *tty, int __user *arg)
207{
208 int pktmode = tty->packet;
209 return put_user(pktmode, arg);
210}
211
26df6d13 212/* Send a signal to the slave */
213static int pty_signal(struct tty_struct *tty, int sig)
214{
215 unsigned long flags;
216 struct pid *pgrp;
217
218 if (tty->link) {
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);
222
223 kill_pgrp(pgrp, sig, 1);
224 put_pid(pgrp);
225 }
226 return 0;
227}
228
1da177e4
LT
229static void pty_flush_buffer(struct tty_struct *tty)
230{
231 struct tty_struct *to = tty->link;
04f378b1 232 unsigned long flags;
fe9cd962 233
1da177e4
LT
234 if (!to)
235 return;
d945cb9c 236 /* tty_buffer_flush(to); FIXME */
1da177e4 237 if (to->packet) {
04f378b1 238 spin_lock_irqsave(&tty->ctrl_lock, flags);
1da177e4
LT
239 tty->ctrl_status |= TIOCPKT_FLUSHWRITE;
240 wake_up_interruptible(&to->read_wait);
04f378b1 241 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
1da177e4
LT
242 }
243}
244
fe9cd962 245static int pty_open(struct tty_struct *tty, struct file *filp)
1da177e4 246{
1da177e4 247 if (!tty || !tty->link)
7c61c3d8 248 return -ENODEV;
69939035 249
1da177e4
LT
250 if (test_bit(TTY_OTHER_CLOSED, &tty->flags))
251 goto out;
252 if (test_bit(TTY_PTY_LOCK, &tty->link->flags))
253 goto out;
80cace72 254 if (tty->driver->subtype == PTY_TYPE_SLAVE && tty->link->count != 1)
1da177e4
LT
255 goto out;
256
69939035 257 clear_bit(TTY_IO_ERROR, &tty->flags);
1da177e4
LT
258 clear_bit(TTY_OTHER_CLOSED, &tty->link->flags);
259 set_bit(TTY_THROTTLED, &tty->flags);
7c61c3d8
PH
260 return 0;
261
1da177e4 262out:
7c61c3d8
PH
263 set_bit(TTY_IO_ERROR, &tty->flags);
264 return -EIO;
1da177e4
LT
265}
266
fe9cd962
AC
267static void pty_set_termios(struct tty_struct *tty,
268 struct ktermios *old_termios)
1da177e4 269{
adc8d746
AC
270 tty->termios.c_cflag &= ~(CSIZE | PARENB);
271 tty->termios.c_cflag |= (CS8 | CREAD);
1da177e4
LT
272}
273
fc6f6238
AC
274/**
275 * pty_do_resize - resize event
276 * @tty: tty being resized
c774bda2 277 * @ws: window size being set.
fc6f6238 278 *
3ad2f3fb 279 * Update the termios variables and send the necessary signals to
fc6f6238
AC
280 * peform a terminal resize correctly
281 */
282
159a8e92 283static int pty_resize(struct tty_struct *tty, struct winsize *ws)
fc6f6238
AC
284{
285 struct pid *pgrp, *rpgrp;
286 unsigned long flags;
287 struct tty_struct *pty = tty->link;
288
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)))
292 goto done;
293
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. */
297
298 spin_lock_irqsave(&tty->ctrl_lock, flags);
299 pgrp = get_pid(tty->pgrp);
300 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
301
302 spin_lock_irqsave(&pty->ctrl_lock, flags);
303 rpgrp = get_pid(pty->pgrp);
304 spin_unlock_irqrestore(&pty->ctrl_lock, flags);
305
306 if (pgrp)
307 kill_pgrp(pgrp, SIGWINCH, 1);
308 if (rpgrp != pgrp && rpgrp)
309 kill_pgrp(rpgrp, SIGWINCH, 1);
310
311 put_pid(pgrp);
312 put_pid(rpgrp);
313
314 tty->winsize = *ws;
315 pty->winsize = *ws; /* Never used so will go away soon */
316done:
317 mutex_unlock(&tty->termios_mutex);
318 return 0;
319}
320
d155255a
AC
321/**
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
326 *
327 * Perform the initial set up for the tty/pty pair. Called from the
328 * tty layer when the port is first opened.
329 *
330 * Locking: the caller must hold the tty_mutex
331 */
5d249bc6
JS
332static int pty_common_install(struct tty_driver *driver, struct tty_struct *tty,
333 bool legacy)
bf970ee4
AC
334{
335 struct tty_struct *o_tty;
d03702a2 336 struct tty_port *ports[2];
bf970ee4 337 int idx = tty->index;
5d249bc6 338 int retval = -ENOMEM;
bf970ee4
AC
339
340 o_tty = alloc_tty_struct();
6f9ea7ad
JS
341 if (!o_tty)
342 goto err;
d03702a2
JS
343 ports[0] = kmalloc(sizeof **ports, GFP_KERNEL);
344 ports[1] = kmalloc(sizeof **ports, GFP_KERNEL);
6f9ea7ad 345 if (!ports[0] || !ports[1])
d03702a2 346 goto err_free_tty;
bf970ee4
AC
347 if (!try_module_get(driver->other->owner)) {
348 /* This cannot in fact currently happen */
8a1b8d70 349 goto err_free_tty;
bf970ee4
AC
350 }
351 initialize_tty_struct(o_tty, driver->other, idx);
352
5d249bc6
JS
353 if (legacy) {
354 /* We always use new tty termios data so we can do this
355 the easy way .. */
356 retval = tty_init_termios(tty);
357 if (retval)
358 goto err_deinit_tty;
359
360 retval = tty_init_termios(o_tty);
361 if (retval)
362 goto err_free_termios;
363
364 driver->other->ttys[idx] = o_tty;
365 driver->ttys[idx] = tty;
366 } else {
adc8d746
AC
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;
5d249bc6 371 }
fe9cd962 372
bf970ee4
AC
373 /*
374 * Everything allocated ... set up the o_tty structure.
375 */
bf970ee4
AC
376 tty_driver_kref_get(driver->other);
377 if (driver->subtype == PTY_TYPE_MASTER)
378 o_tty->count++;
379 /* Establish the links in both directions */
380 tty->link = o_tty;
381 o_tty->link = tty;
d03702a2
JS
382 tty_port_init(ports[0]);
383 tty_port_init(ports[1]);
384 o_tty->port = ports[0];
385 tty->port = ports[1];
967fab69 386 o_tty->port->itty = o_tty;
bf970ee4
AC
387
388 tty_driver_kref_get(driver);
389 tty->count++;
bf970ee4 390 return 0;
8a1b8d70 391err_free_termios:
5d249bc6
JS
392 if (legacy)
393 tty_free_termios(tty);
a9dccddb
JS
394err_deinit_tty:
395 deinitialize_tty_struct(o_tty);
bf970ee4 396 module_put(o_tty->driver->owner);
8a1b8d70 397err_free_tty:
d03702a2
JS
398 kfree(ports[0]);
399 kfree(ports[1]);
bf970ee4 400 free_tty_struct(o_tty);
6f9ea7ad 401err:
8a1b8d70 402 return retval;
bf970ee4
AC
403}
404
d03702a2
JS
405static void pty_cleanup(struct tty_struct *tty)
406{
81c79838 407 tty_port_put(tty->port);
d03702a2
JS
408}
409
5d249bc6
JS
410/* Traditional BSD devices */
411#ifdef CONFIG_LEGACY_PTYS
412
413static int pty_install(struct tty_driver *driver, struct tty_struct *tty)
414{
415 return pty_common_install(driver, tty, true);
416}
417
d155255a
AC
418static void pty_remove(struct tty_driver *driver, struct tty_struct *tty)
419{
420 struct tty_struct *pair = tty->link;
421 driver->ttys[tty->index] = NULL;
422 if (pair)
423 pair->driver->ttys[pair->index] = NULL;
424}
425
6caa76b7 426static int pty_bsd_ioctl(struct tty_struct *tty,
1da177e4
LT
427 unsigned int cmd, unsigned long arg)
428{
429 switch (cmd) {
430 case TIOCSPTLCK: /* Set PT Lock (disallow slave open) */
431 return pty_set_lock(tty, (int __user *) arg);
84fd7bdf
CG
432 case TIOCGPTLCK: /* Get PT Lock status */
433 return pty_get_lock(tty, (int __user *)arg);
06026d91
CG
434 case TIOCPKT: /* Set PT packet mode */
435 return pty_set_pktmode(tty, (int __user *)arg);
84fd7bdf
CG
436 case TIOCGPKT: /* Get PT packet mode */
437 return pty_get_pktmode(tty, (int __user *)arg);
26df6d13 438 case TIOCSIG: /* Send signal to other side of pty */
439 return pty_signal(tty, (int) arg);
ded2f295
JS
440 case TIOCGPTN: /* TTY returns ENOTTY, but glibc expects EINVAL here */
441 return -EINVAL;
1da177e4
LT
442 }
443 return -ENOIOCTLCMD;
444}
445
dc8c8587
KS
446static int legacy_count = CONFIG_LEGACY_PTY_COUNT;
447module_param(legacy_count, int, 0);
448
342a5971
LT
449/*
450 * The master side of a pty can do TIOCSPTLCK and thus
451 * has pty_bsd_ioctl.
452 */
453static const struct tty_operations master_pty_ops_bsd = {
454 .install = pty_install,
3e8e88ca
AC
455 .open = pty_open,
456 .close = pty_close,
457 .write = pty_write,
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,
d03702a2 464 .cleanup = pty_cleanup,
d155255a
AC
465 .resize = pty_resize,
466 .remove = pty_remove
3e8e88ca
AC
467};
468
342a5971
LT
469static const struct tty_operations slave_pty_ops_bsd = {
470 .install = pty_install,
471 .open = pty_open,
472 .close = pty_close,
473 .write = pty_write,
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,
d03702a2 479 .cleanup = pty_cleanup,
d155255a
AC
480 .resize = pty_resize,
481 .remove = pty_remove
342a5971
LT
482};
483
1da177e4
LT
484static void __init legacy_pty_init(void)
485{
342a5971
LT
486 struct tty_driver *pty_driver, *pty_slave_driver;
487
dc8c8587
KS
488 if (legacy_count <= 0)
489 return;
1da177e4 490
21aca2fa
JS
491 pty_driver = tty_alloc_driver(legacy_count,
492 TTY_DRIVER_RESET_TERMIOS |
493 TTY_DRIVER_REAL_RAW |
494 TTY_DRIVER_DYNAMIC_ALLOC);
c3a6344a 495 if (IS_ERR(pty_driver))
1da177e4
LT
496 panic("Couldn't allocate pty driver");
497
21aca2fa
JS
498 pty_slave_driver = tty_alloc_driver(legacy_count,
499 TTY_DRIVER_RESET_TERMIOS |
500 TTY_DRIVER_REAL_RAW |
501 TTY_DRIVER_DYNAMIC_ALLOC);
c3a6344a 502 if (IS_ERR(pty_slave_driver))
1da177e4
LT
503 panic("Couldn't allocate pty slave driver");
504
1da177e4
LT
505 pty_driver->driver_name = "pty_master";
506 pty_driver->name = "pty";
1da177e4
LT
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;
606d099c
AC
516 pty_driver->init_termios.c_ispeed = 38400;
517 pty_driver->init_termios.c_ospeed = 38400;
1da177e4 518 pty_driver->other = pty_slave_driver;
342a5971 519 tty_set_operations(pty_driver, &master_pty_ops_bsd);
1da177e4 520
1da177e4
LT
521 pty_slave_driver->driver_name = "pty_slave";
522 pty_slave_driver->name = "ttyp";
1da177e4
LT
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;
606d099c
AC
529 pty_slave_driver->init_termios.c_ispeed = 38400;
530 pty_slave_driver->init_termios.c_ospeed = 38400;
1da177e4 531 pty_slave_driver->other = pty_driver;
342a5971 532 tty_set_operations(pty_slave_driver, &slave_pty_ops_bsd);
1da177e4
LT
533
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");
538}
539#else
540static inline void legacy_pty_init(void) { }
541#endif
542
543/* Unix98 devices */
544#ifdef CONFIG_UNIX98_PTYS
1da177e4 545
d81ed103
AC
546static struct cdev ptmx_cdev;
547
6caa76b7 548static int pty_unix98_ioctl(struct tty_struct *tty,
1da177e4
LT
549 unsigned int cmd, unsigned long arg)
550{
551 switch (cmd) {
552 case TIOCSPTLCK: /* Set PT Lock (disallow slave open) */
553 return pty_set_lock(tty, (int __user *)arg);
84fd7bdf
CG
554 case TIOCGPTLCK: /* Get PT Lock status */
555 return pty_get_lock(tty, (int __user *)arg);
06026d91
CG
556 case TIOCPKT: /* Set PT packet mode */
557 return pty_set_pktmode(tty, (int __user *)arg);
84fd7bdf
CG
558 case TIOCGPKT: /* Get PT packet mode */
559 return pty_get_pktmode(tty, (int __user *)arg);
1da177e4
LT
560 case TIOCGPTN: /* Get PT Number */
561 return put_user(tty->index, (unsigned int __user *)arg);
26df6d13 562 case TIOCSIG: /* Send signal to other side of pty */
563 return pty_signal(tty, (int) arg);
1da177e4
LT
564 }
565
566 return -ENOIOCTLCMD;
567}
568
99f1fe18
AC
569/**
570 * ptm_unix98_lookup - find a pty master
571 * @driver: ptm driver
572 * @idx: tty index
573 *
574 * Look up a pty master device. Called under the tty_mutex for now.
575 * This provides our locking.
576 */
577
15f1a633
SB
578static struct tty_struct *ptm_unix98_lookup(struct tty_driver *driver,
579 struct inode *ptm_inode, int idx)
99f1fe18 580{
593a27c4
KK
581 /* Master must be open via /dev/ptmx */
582 return ERR_PTR(-EIO);
99f1fe18
AC
583}
584
585/**
586 * pts_unix98_lookup - find a pty slave
587 * @driver: pts driver
588 * @idx: tty index
589 *
590 * Look up a pty master device. Called under the tty_mutex for now.
d739e65b 591 * This provides our locking for the tty pointer.
99f1fe18
AC
592 */
593
15f1a633
SB
594static struct tty_struct *pts_unix98_lookup(struct tty_driver *driver,
595 struct inode *pts_inode, int idx)
99f1fe18 596{
d739e65b
AC
597 struct tty_struct *tty;
598
599 mutex_lock(&devpts_mutex);
8fcbaa2b 600 tty = devpts_get_priv(pts_inode);
d739e65b 601 mutex_unlock(&devpts_mutex);
99f1fe18
AC
602 /* Master must be open before slave */
603 if (!tty)
604 return ERR_PTR(-EIO);
605 return tty;
606}
607
8b0a88d5
AC
608/* We have no need to install and remove our tty objects as devpts does all
609 the work for us */
610
bf970ee4 611static int pty_unix98_install(struct tty_driver *driver, struct tty_struct *tty)
8b0a88d5 612{
5d249bc6 613 return pty_common_install(driver, tty, false);
8b0a88d5
AC
614}
615
7171604a 616static void pty_unix98_remove(struct tty_driver *driver, struct tty_struct *tty)
8b0a88d5
AC
617{
618}
619
f4b208eb
JS
620/* this is called once with whichever end is closed last */
621static void pty_unix98_shutdown(struct tty_struct *tty)
622{
623 devpts_kill_index(tty->driver_data, tty->index);
624}
625
feebed65 626static const struct tty_operations ptm_unix98_ops = {
99f1fe18 627 .lookup = ptm_unix98_lookup,
bf970ee4 628 .install = pty_unix98_install,
7171604a 629 .remove = pty_unix98_remove,
3e8e88ca
AC
630 .open = pty_open,
631 .close = pty_close,
632 .write = pty_write,
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,
feebed65 638 .ioctl = pty_unix98_ioctl,
36b3c070 639 .resize = pty_resize,
fa2ecfc5 640 .shutdown = pty_unix98_shutdown,
36b3c070 641 .cleanup = pty_cleanup
3e8e88ca
AC
642};
643
99f1fe18
AC
644static const struct tty_operations pty_unix98_ops = {
645 .lookup = pts_unix98_lookup,
bf970ee4 646 .install = pty_unix98_install,
7171604a 647 .remove = pty_unix98_remove,
99f1fe18
AC
648 .open = pty_open,
649 .close = pty_close,
650 .write = pty_write,
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,
fa2ecfc5 656 .shutdown = pty_unix98_shutdown,
d03702a2 657 .cleanup = pty_cleanup,
99f1fe18 658};
d81ed103
AC
659
660/**
661 * ptmx_open - open a unix 98 pty master
662 * @inode: inode of device file
663 * @filp: file pointer to tty
664 *
665 * Allocate a unix98 pty master device from the ptmx driver.
666 *
667 * Locking: tty_mutex protects the init_dev work. tty->count should
b9f8033f 668 * protect the rest.
d81ed103
AC
669 * allocated_ptys_lock handles the list of free pty numbers
670 */
671
64ba3dc3 672static int ptmx_open(struct inode *inode, struct file *filp)
d81ed103
AC
673{
674 struct tty_struct *tty;
162b97cf 675 struct inode *slave_inode;
d81ed103
AC
676 int retval;
677 int index;
678
679 nonseekable_open(inode, filp);
680
b0b88565
LT
681 /* We refuse fsnotify events on ptmx, since it's a shared resource */
682 filp->f_mode |= FMODE_NONOTIFY;
683
fa90e1c9
JS
684 retval = tty_alloc_file(filp);
685 if (retval)
686 return retval;
687
d81ed103 688 /* find a device that is not in use. */
89c8d91e 689 mutex_lock(&devpts_mutex);
15f1a633 690 index = devpts_new_index(inode);
fa90e1c9
JS
691 if (index < 0) {
692 retval = index;
05fb79e4 693 mutex_unlock(&devpts_mutex);
fa90e1c9
JS
694 goto err_file;
695 }
d81ed103 696
89c8d91e
AC
697 mutex_unlock(&devpts_mutex);
698
d81ed103 699 mutex_lock(&tty_mutex);
593a27c4 700 tty = tty_init_dev(ptm_driver, index);
d81ed103 701
73ec06fc
AC
702 if (IS_ERR(tty)) {
703 retval = PTR_ERR(tty);
d81ed103 704 goto out;
73ec06fc 705 }
d81ed103 706
89c8d91e
AC
707 /* The tty returned here is locked so we can safely
708 drop the mutex */
709 mutex_unlock(&tty_mutex);
710
d81ed103 711 set_bit(TTY_PTY_LOCK, &tty->flags); /* LOCK THE SLAVE */
7acf6cd8 712 tty->driver_data = inode;
ee2ffa0d 713
fa90e1c9 714 tty_add_file(tty, filp);
d81ed103 715
f11afb61
JS
716 slave_inode = devpts_pty_new(inode,
717 MKDEV(UNIX98_PTY_SLAVE_MAJOR, index), index,
718 tty->link);
162b97cf
JS
719 if (IS_ERR(slave_inode)) {
720 retval = PTR_ERR(slave_inode);
1177c0ef 721 goto err_release;
162b97cf 722 }
7acf6cd8 723 tty->link->driver_data = slave_inode;
d81ed103
AC
724
725 retval = ptm_driver->ops->open(tty, filp);
64ba3dc3 726 if (retval)
1177c0ef
JS
727 goto err_release;
728
89c8d91e 729 tty_unlock(tty);
1177c0ef
JS
730 return 0;
731err_release:
89c8d91e 732 tty_unlock(tty);
eeb89d91 733 tty_release(inode, filp);
d81ed103
AC
734 return retval;
735out:
89c8d91e 736 mutex_unlock(&tty_mutex);
d3bda529 737 devpts_kill_index(inode, index);
fa90e1c9
JS
738err_file:
739 tty_free_file(filp);
64ba3dc3 740 return retval;
d81ed103
AC
741}
742
743static struct file_operations ptmx_fops;
744
1da177e4
LT
745static void __init unix98_pty_init(void)
746{
21aca2fa
JS
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);
c3a6344a 753 if (IS_ERR(ptm_driver))
1da177e4 754 panic("Couldn't allocate Unix98 ptm driver");
21aca2fa
JS
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);
c3a6344a 761 if (IS_ERR(pts_driver))
1da177e4
LT
762 panic("Couldn't allocate Unix98 pts driver");
763
1da177e4
LT
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;
606d099c
AC
775 ptm_driver->init_termios.c_ispeed = 38400;
776 ptm_driver->init_termios.c_ospeed = 38400;
1da177e4 777 ptm_driver->other = pts_driver;
feebed65 778 tty_set_operations(ptm_driver, &ptm_unix98_ops);
1da177e4 779
1da177e4
LT
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;
606d099c
AC
788 pts_driver->init_termios.c_ispeed = 38400;
789 pts_driver->init_termios.c_ospeed = 38400;
1da177e4 790 pts_driver->other = ptm_driver;
99f1fe18 791 tty_set_operations(pts_driver, &pty_unix98_ops);
fe9cd962 792
1da177e4
LT
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");
797
d81ed103
AC
798 /* Now create the /dev/ptmx special device */
799 tty_default_fops(&ptmx_fops);
800 ptmx_fops.open = ptmx_open;
801
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)
82f8c35f 805 panic("Couldn't register /dev/ptmx driver");
d81ed103 806 device_create(tty_class, NULL, MKDEV(TTYAUX_MAJOR, 2), NULL, "ptmx");
1da177e4 807}
d81ed103 808
1da177e4
LT
809#else
810static inline void unix98_pty_init(void) { }
811#endif
812
813static int __init pty_init(void)
814{
815 legacy_pty_init();
816 unix98_pty_init();
817 return 0;
818}
819module_init(pty_init);