]> git.proxmox.com Git - mirror_ubuntu-artful-kernel.git/blame - drivers/tty/pty.c
tty: Remove extra wakeup from pty write() path
[mirror_ubuntu-artful-kernel.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 *
7bfe0b71 92 * Limit the buffer space used by ptys to 8k.
d945cb9c
AC
93 */
94
95static int pty_space(struct tty_struct *to)
96{
7bfe0b71
PH
97 int n = tty_buffer_space_avail(to->port);
98 return min(n, 8192);
d945cb9c
AC
99}
100
101/**
102 * pty_write - write to a pty
103 * @tty: the tty we write from
104 * @buf: kernel buffer of data
105 * @count: bytes to write
762faaed 106 *
d945cb9c
AC
107 * Our "hardware" write method. Data is coming from the ldisc which
108 * may be in a non sleeping state. We simply throw this at the other
109 * end of the link as if we were an IRQ handler receiving stuff for
110 * the other side of the pty/tty pair.
1da177e4 111 */
d945cb9c 112
ac89a917 113static int pty_write(struct tty_struct *tty, const unsigned char *buf, int c)
1da177e4
LT
114{
115 struct tty_struct *to = tty->link;
1da177e4 116
d945cb9c 117 if (tty->stopped)
1da177e4 118 return 0;
d945cb9c 119
d945cb9c
AC
120 if (c > 0) {
121 /* Stuff the data into the input queue of the other end */
05c7cd39 122 c = tty_insert_flip_string(to->port, buf, c);
d945cb9c 123 /* And shovel */
5ede5253 124 if (c)
2e124b4a 125 tty_flip_buffer_push(to->port);
762faaed 126 }
1da177e4
LT
127 return c;
128}
129
d945cb9c
AC
130/**
131 * pty_write_room - write space
132 * @tty: tty we are writing from
133 *
134 * Report how many bytes the ldisc can send into the queue for
135 * the other device.
136 */
137
1da177e4
LT
138static int pty_write_room(struct tty_struct *tty)
139{
85dfd81d
LT
140 if (tty->stopped)
141 return 0;
d945cb9c 142 return pty_space(tty->link);
1da177e4
LT
143}
144
d945cb9c
AC
145/**
146 * pty_chars_in_buffer - characters currently in our tx queue
147 * @tty: our tty
fe9cd962 148 *
d945cb9c
AC
149 * Report how much we have in the transmit queue. As everything is
150 * instantly at the other end this is easy to implement.
1da177e4 151 */
d945cb9c 152
1da177e4
LT
153static int pty_chars_in_buffer(struct tty_struct *tty)
154{
d945cb9c 155 return 0;
1da177e4
LT
156}
157
158/* Set the lock flag on a pty */
fe9cd962 159static int pty_set_lock(struct tty_struct *tty, int __user *arg)
1da177e4
LT
160{
161 int val;
fe9cd962 162 if (get_user(val, arg))
1da177e4
LT
163 return -EFAULT;
164 if (val)
165 set_bit(TTY_PTY_LOCK, &tty->flags);
166 else
167 clear_bit(TTY_PTY_LOCK, &tty->flags);
168 return 0;
169}
170
84fd7bdf
CG
171static int pty_get_lock(struct tty_struct *tty, int __user *arg)
172{
173 int locked = test_bit(TTY_PTY_LOCK, &tty->flags);
174 return put_user(locked, arg);
175}
176
06026d91
CG
177/* Set the packet mode on a pty */
178static int pty_set_pktmode(struct tty_struct *tty, int __user *arg)
179{
180 unsigned long flags;
181 int pktmode;
182
183 if (get_user(pktmode, arg))
184 return -EFAULT;
185
186 spin_lock_irqsave(&tty->ctrl_lock, flags);
187 if (pktmode) {
188 if (!tty->packet) {
189 tty->packet = 1;
190 tty->link->ctrl_status = 0;
191 }
192 } else
193 tty->packet = 0;
194 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
195
196 return 0;
197}
198
84fd7bdf
CG
199/* Get the packet mode of a pty */
200static int pty_get_pktmode(struct tty_struct *tty, int __user *arg)
201{
202 int pktmode = tty->packet;
203 return put_user(pktmode, arg);
204}
205
26df6d13 206/* Send a signal to the slave */
207static int pty_signal(struct tty_struct *tty, int sig)
208{
209 unsigned long flags;
210 struct pid *pgrp;
211
212 if (tty->link) {
213 spin_lock_irqsave(&tty->link->ctrl_lock, flags);
214 pgrp = get_pid(tty->link->pgrp);
215 spin_unlock_irqrestore(&tty->link->ctrl_lock, flags);
216
217 kill_pgrp(pgrp, sig, 1);
218 put_pid(pgrp);
219 }
220 return 0;
221}
222
1da177e4
LT
223static void pty_flush_buffer(struct tty_struct *tty)
224{
225 struct tty_struct *to = tty->link;
04f378b1 226 unsigned long flags;
fe9cd962 227
1da177e4
LT
228 if (!to)
229 return;
d945cb9c 230 /* tty_buffer_flush(to); FIXME */
1da177e4 231 if (to->packet) {
04f378b1 232 spin_lock_irqsave(&tty->ctrl_lock, flags);
1da177e4
LT
233 tty->ctrl_status |= TIOCPKT_FLUSHWRITE;
234 wake_up_interruptible(&to->read_wait);
04f378b1 235 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
1da177e4
LT
236 }
237}
238
fe9cd962 239static int pty_open(struct tty_struct *tty, struct file *filp)
1da177e4 240{
1da177e4 241 if (!tty || !tty->link)
7c61c3d8 242 return -ENODEV;
69939035 243
1da177e4
LT
244 if (test_bit(TTY_OTHER_CLOSED, &tty->flags))
245 goto out;
246 if (test_bit(TTY_PTY_LOCK, &tty->link->flags))
247 goto out;
80cace72 248 if (tty->driver->subtype == PTY_TYPE_SLAVE && tty->link->count != 1)
1da177e4
LT
249 goto out;
250
69939035 251 clear_bit(TTY_IO_ERROR, &tty->flags);
1da177e4
LT
252 clear_bit(TTY_OTHER_CLOSED, &tty->link->flags);
253 set_bit(TTY_THROTTLED, &tty->flags);
7c61c3d8
PH
254 return 0;
255
1da177e4 256out:
7c61c3d8
PH
257 set_bit(TTY_IO_ERROR, &tty->flags);
258 return -EIO;
1da177e4
LT
259}
260
fe9cd962
AC
261static void pty_set_termios(struct tty_struct *tty,
262 struct ktermios *old_termios)
1da177e4 263{
adc8d746
AC
264 tty->termios.c_cflag &= ~(CSIZE | PARENB);
265 tty->termios.c_cflag |= (CS8 | CREAD);
1da177e4
LT
266}
267
fc6f6238
AC
268/**
269 * pty_do_resize - resize event
270 * @tty: tty being resized
c774bda2 271 * @ws: window size being set.
fc6f6238 272 *
3ad2f3fb 273 * Update the termios variables and send the necessary signals to
fc6f6238
AC
274 * peform a terminal resize correctly
275 */
276
159a8e92 277static int pty_resize(struct tty_struct *tty, struct winsize *ws)
fc6f6238
AC
278{
279 struct pid *pgrp, *rpgrp;
280 unsigned long flags;
281 struct tty_struct *pty = tty->link;
282
283 /* For a PTY we need to lock the tty side */
6a1c0680 284 down_write(&tty->termios_rwsem);
fc6f6238
AC
285 if (!memcmp(ws, &tty->winsize, sizeof(*ws)))
286 goto done;
287
288 /* Get the PID values and reference them so we can
289 avoid holding the tty ctrl lock while sending signals.
290 We need to lock these individually however. */
291
292 spin_lock_irqsave(&tty->ctrl_lock, flags);
293 pgrp = get_pid(tty->pgrp);
294 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
295
296 spin_lock_irqsave(&pty->ctrl_lock, flags);
297 rpgrp = get_pid(pty->pgrp);
298 spin_unlock_irqrestore(&pty->ctrl_lock, flags);
299
300 if (pgrp)
301 kill_pgrp(pgrp, SIGWINCH, 1);
302 if (rpgrp != pgrp && rpgrp)
303 kill_pgrp(rpgrp, SIGWINCH, 1);
304
305 put_pid(pgrp);
306 put_pid(rpgrp);
307
308 tty->winsize = *ws;
309 pty->winsize = *ws; /* Never used so will go away soon */
310done:
6a1c0680 311 up_write(&tty->termios_rwsem);
fc6f6238
AC
312 return 0;
313}
314
d155255a
AC
315/**
316 * pty_common_install - set up the pty pair
317 * @driver: the pty driver
318 * @tty: the tty being instantiated
319 * @bool: legacy, true if this is BSD style
320 *
321 * Perform the initial set up for the tty/pty pair. Called from the
322 * tty layer when the port is first opened.
323 *
324 * Locking: the caller must hold the tty_mutex
325 */
5d249bc6
JS
326static int pty_common_install(struct tty_driver *driver, struct tty_struct *tty,
327 bool legacy)
bf970ee4
AC
328{
329 struct tty_struct *o_tty;
d03702a2 330 struct tty_port *ports[2];
bf970ee4 331 int idx = tty->index;
5d249bc6 332 int retval = -ENOMEM;
bf970ee4
AC
333
334 o_tty = alloc_tty_struct();
6f9ea7ad
JS
335 if (!o_tty)
336 goto err;
d03702a2
JS
337 ports[0] = kmalloc(sizeof **ports, GFP_KERNEL);
338 ports[1] = kmalloc(sizeof **ports, GFP_KERNEL);
6f9ea7ad 339 if (!ports[0] || !ports[1])
d03702a2 340 goto err_free_tty;
bf970ee4
AC
341 if (!try_module_get(driver->other->owner)) {
342 /* This cannot in fact currently happen */
8a1b8d70 343 goto err_free_tty;
bf970ee4
AC
344 }
345 initialize_tty_struct(o_tty, driver->other, idx);
346
5d249bc6
JS
347 if (legacy) {
348 /* We always use new tty termios data so we can do this
349 the easy way .. */
350 retval = tty_init_termios(tty);
351 if (retval)
352 goto err_deinit_tty;
353
354 retval = tty_init_termios(o_tty);
355 if (retval)
356 goto err_free_termios;
357
358 driver->other->ttys[idx] = o_tty;
359 driver->ttys[idx] = tty;
360 } else {
adc8d746
AC
361 memset(&tty->termios_locked, 0, sizeof(tty->termios_locked));
362 tty->termios = driver->init_termios;
363 memset(&o_tty->termios_locked, 0, sizeof(tty->termios_locked));
364 o_tty->termios = driver->other->init_termios;
5d249bc6 365 }
fe9cd962 366
bf970ee4
AC
367 /*
368 * Everything allocated ... set up the o_tty structure.
369 */
bf970ee4
AC
370 tty_driver_kref_get(driver->other);
371 if (driver->subtype == PTY_TYPE_MASTER)
372 o_tty->count++;
373 /* Establish the links in both directions */
374 tty->link = o_tty;
375 o_tty->link = tty;
d03702a2
JS
376 tty_port_init(ports[0]);
377 tty_port_init(ports[1]);
378 o_tty->port = ports[0];
379 tty->port = ports[1];
967fab69 380 o_tty->port->itty = o_tty;
bf970ee4
AC
381
382 tty_driver_kref_get(driver);
383 tty->count++;
bf970ee4 384 return 0;
8a1b8d70 385err_free_termios:
5d249bc6
JS
386 if (legacy)
387 tty_free_termios(tty);
a9dccddb
JS
388err_deinit_tty:
389 deinitialize_tty_struct(o_tty);
bf970ee4 390 module_put(o_tty->driver->owner);
8a1b8d70 391err_free_tty:
d03702a2
JS
392 kfree(ports[0]);
393 kfree(ports[1]);
bf970ee4 394 free_tty_struct(o_tty);
6f9ea7ad 395err:
8a1b8d70 396 return retval;
bf970ee4
AC
397}
398
d03702a2
JS
399static void pty_cleanup(struct tty_struct *tty)
400{
81c79838 401 tty_port_put(tty->port);
d03702a2
JS
402}
403
5d249bc6
JS
404/* Traditional BSD devices */
405#ifdef CONFIG_LEGACY_PTYS
406
407static int pty_install(struct tty_driver *driver, struct tty_struct *tty)
408{
409 return pty_common_install(driver, tty, true);
410}
411
d155255a
AC
412static void pty_remove(struct tty_driver *driver, struct tty_struct *tty)
413{
414 struct tty_struct *pair = tty->link;
415 driver->ttys[tty->index] = NULL;
416 if (pair)
417 pair->driver->ttys[pair->index] = NULL;
418}
419
6caa76b7 420static int pty_bsd_ioctl(struct tty_struct *tty,
1da177e4
LT
421 unsigned int cmd, unsigned long arg)
422{
423 switch (cmd) {
424 case TIOCSPTLCK: /* Set PT Lock (disallow slave open) */
425 return pty_set_lock(tty, (int __user *) arg);
84fd7bdf
CG
426 case TIOCGPTLCK: /* Get PT Lock status */
427 return pty_get_lock(tty, (int __user *)arg);
06026d91
CG
428 case TIOCPKT: /* Set PT packet mode */
429 return pty_set_pktmode(tty, (int __user *)arg);
84fd7bdf
CG
430 case TIOCGPKT: /* Get PT packet mode */
431 return pty_get_pktmode(tty, (int __user *)arg);
26df6d13 432 case TIOCSIG: /* Send signal to other side of pty */
433 return pty_signal(tty, (int) arg);
ded2f295
JS
434 case TIOCGPTN: /* TTY returns ENOTTY, but glibc expects EINVAL here */
435 return -EINVAL;
1da177e4
LT
436 }
437 return -ENOIOCTLCMD;
438}
439
dc8c8587
KS
440static int legacy_count = CONFIG_LEGACY_PTY_COUNT;
441module_param(legacy_count, int, 0);
442
342a5971
LT
443/*
444 * The master side of a pty can do TIOCSPTLCK and thus
445 * has pty_bsd_ioctl.
446 */
447static const struct tty_operations master_pty_ops_bsd = {
448 .install = pty_install,
3e8e88ca
AC
449 .open = pty_open,
450 .close = pty_close,
451 .write = pty_write,
452 .write_room = pty_write_room,
453 .flush_buffer = pty_flush_buffer,
454 .chars_in_buffer = pty_chars_in_buffer,
455 .unthrottle = pty_unthrottle,
456 .set_termios = pty_set_termios,
457 .ioctl = pty_bsd_ioctl,
d03702a2 458 .cleanup = pty_cleanup,
d155255a
AC
459 .resize = pty_resize,
460 .remove = pty_remove
3e8e88ca
AC
461};
462
342a5971
LT
463static const struct tty_operations slave_pty_ops_bsd = {
464 .install = pty_install,
465 .open = pty_open,
466 .close = pty_close,
467 .write = pty_write,
468 .write_room = pty_write_room,
469 .flush_buffer = pty_flush_buffer,
470 .chars_in_buffer = pty_chars_in_buffer,
471 .unthrottle = pty_unthrottle,
472 .set_termios = pty_set_termios,
d03702a2 473 .cleanup = pty_cleanup,
d155255a
AC
474 .resize = pty_resize,
475 .remove = pty_remove
342a5971
LT
476};
477
1da177e4
LT
478static void __init legacy_pty_init(void)
479{
342a5971
LT
480 struct tty_driver *pty_driver, *pty_slave_driver;
481
dc8c8587
KS
482 if (legacy_count <= 0)
483 return;
1da177e4 484
21aca2fa
JS
485 pty_driver = tty_alloc_driver(legacy_count,
486 TTY_DRIVER_RESET_TERMIOS |
487 TTY_DRIVER_REAL_RAW |
488 TTY_DRIVER_DYNAMIC_ALLOC);
c3a6344a 489 if (IS_ERR(pty_driver))
1da177e4
LT
490 panic("Couldn't allocate pty driver");
491
21aca2fa
JS
492 pty_slave_driver = tty_alloc_driver(legacy_count,
493 TTY_DRIVER_RESET_TERMIOS |
494 TTY_DRIVER_REAL_RAW |
495 TTY_DRIVER_DYNAMIC_ALLOC);
c3a6344a 496 if (IS_ERR(pty_slave_driver))
1da177e4
LT
497 panic("Couldn't allocate pty slave driver");
498
1da177e4
LT
499 pty_driver->driver_name = "pty_master";
500 pty_driver->name = "pty";
1da177e4
LT
501 pty_driver->major = PTY_MASTER_MAJOR;
502 pty_driver->minor_start = 0;
503 pty_driver->type = TTY_DRIVER_TYPE_PTY;
504 pty_driver->subtype = PTY_TYPE_MASTER;
505 pty_driver->init_termios = tty_std_termios;
506 pty_driver->init_termios.c_iflag = 0;
507 pty_driver->init_termios.c_oflag = 0;
508 pty_driver->init_termios.c_cflag = B38400 | CS8 | CREAD;
509 pty_driver->init_termios.c_lflag = 0;
606d099c
AC
510 pty_driver->init_termios.c_ispeed = 38400;
511 pty_driver->init_termios.c_ospeed = 38400;
1da177e4 512 pty_driver->other = pty_slave_driver;
342a5971 513 tty_set_operations(pty_driver, &master_pty_ops_bsd);
1da177e4 514
1da177e4
LT
515 pty_slave_driver->driver_name = "pty_slave";
516 pty_slave_driver->name = "ttyp";
1da177e4
LT
517 pty_slave_driver->major = PTY_SLAVE_MAJOR;
518 pty_slave_driver->minor_start = 0;
519 pty_slave_driver->type = TTY_DRIVER_TYPE_PTY;
520 pty_slave_driver->subtype = PTY_TYPE_SLAVE;
521 pty_slave_driver->init_termios = tty_std_termios;
522 pty_slave_driver->init_termios.c_cflag = B38400 | CS8 | CREAD;
606d099c
AC
523 pty_slave_driver->init_termios.c_ispeed = 38400;
524 pty_slave_driver->init_termios.c_ospeed = 38400;
1da177e4 525 pty_slave_driver->other = pty_driver;
342a5971 526 tty_set_operations(pty_slave_driver, &slave_pty_ops_bsd);
1da177e4
LT
527
528 if (tty_register_driver(pty_driver))
529 panic("Couldn't register pty driver");
530 if (tty_register_driver(pty_slave_driver))
531 panic("Couldn't register pty slave driver");
532}
533#else
534static inline void legacy_pty_init(void) { }
535#endif
536
537/* Unix98 devices */
538#ifdef CONFIG_UNIX98_PTYS
1da177e4 539
d81ed103
AC
540static struct cdev ptmx_cdev;
541
6caa76b7 542static int pty_unix98_ioctl(struct tty_struct *tty,
1da177e4
LT
543 unsigned int cmd, unsigned long arg)
544{
545 switch (cmd) {
546 case TIOCSPTLCK: /* Set PT Lock (disallow slave open) */
547 return pty_set_lock(tty, (int __user *)arg);
84fd7bdf
CG
548 case TIOCGPTLCK: /* Get PT Lock status */
549 return pty_get_lock(tty, (int __user *)arg);
06026d91
CG
550 case TIOCPKT: /* Set PT packet mode */
551 return pty_set_pktmode(tty, (int __user *)arg);
84fd7bdf
CG
552 case TIOCGPKT: /* Get PT packet mode */
553 return pty_get_pktmode(tty, (int __user *)arg);
1da177e4
LT
554 case TIOCGPTN: /* Get PT Number */
555 return put_user(tty->index, (unsigned int __user *)arg);
26df6d13 556 case TIOCSIG: /* Send signal to other side of pty */
557 return pty_signal(tty, (int) arg);
1da177e4
LT
558 }
559
560 return -ENOIOCTLCMD;
561}
562
99f1fe18
AC
563/**
564 * ptm_unix98_lookup - find a pty master
565 * @driver: ptm driver
566 * @idx: tty index
567 *
568 * Look up a pty master device. Called under the tty_mutex for now.
569 * This provides our locking.
570 */
571
15f1a633
SB
572static struct tty_struct *ptm_unix98_lookup(struct tty_driver *driver,
573 struct inode *ptm_inode, int idx)
99f1fe18 574{
593a27c4
KK
575 /* Master must be open via /dev/ptmx */
576 return ERR_PTR(-EIO);
99f1fe18
AC
577}
578
579/**
580 * pts_unix98_lookup - find a pty slave
581 * @driver: pts driver
582 * @idx: tty index
583 *
584 * Look up a pty master device. Called under the tty_mutex for now.
d739e65b 585 * This provides our locking for the tty pointer.
99f1fe18
AC
586 */
587
15f1a633
SB
588static struct tty_struct *pts_unix98_lookup(struct tty_driver *driver,
589 struct inode *pts_inode, int idx)
99f1fe18 590{
d739e65b
AC
591 struct tty_struct *tty;
592
593 mutex_lock(&devpts_mutex);
8fcbaa2b 594 tty = devpts_get_priv(pts_inode);
d739e65b 595 mutex_unlock(&devpts_mutex);
99f1fe18
AC
596 /* Master must be open before slave */
597 if (!tty)
598 return ERR_PTR(-EIO);
599 return tty;
600}
601
8b0a88d5
AC
602/* We have no need to install and remove our tty objects as devpts does all
603 the work for us */
604
bf970ee4 605static int pty_unix98_install(struct tty_driver *driver, struct tty_struct *tty)
8b0a88d5 606{
5d249bc6 607 return pty_common_install(driver, tty, false);
8b0a88d5
AC
608}
609
7171604a 610static void pty_unix98_remove(struct tty_driver *driver, struct tty_struct *tty)
8b0a88d5
AC
611{
612}
613
f4b208eb
JS
614/* this is called once with whichever end is closed last */
615static void pty_unix98_shutdown(struct tty_struct *tty)
616{
617 devpts_kill_index(tty->driver_data, tty->index);
618}
619
feebed65 620static const struct tty_operations ptm_unix98_ops = {
99f1fe18 621 .lookup = ptm_unix98_lookup,
bf970ee4 622 .install = pty_unix98_install,
7171604a 623 .remove = pty_unix98_remove,
3e8e88ca
AC
624 .open = pty_open,
625 .close = pty_close,
626 .write = pty_write,
627 .write_room = pty_write_room,
628 .flush_buffer = pty_flush_buffer,
629 .chars_in_buffer = pty_chars_in_buffer,
630 .unthrottle = pty_unthrottle,
631 .set_termios = pty_set_termios,
feebed65 632 .ioctl = pty_unix98_ioctl,
36b3c070 633 .resize = pty_resize,
fa2ecfc5 634 .shutdown = pty_unix98_shutdown,
36b3c070 635 .cleanup = pty_cleanup
3e8e88ca
AC
636};
637
99f1fe18
AC
638static const struct tty_operations pty_unix98_ops = {
639 .lookup = pts_unix98_lookup,
bf970ee4 640 .install = pty_unix98_install,
7171604a 641 .remove = pty_unix98_remove,
99f1fe18
AC
642 .open = pty_open,
643 .close = pty_close,
644 .write = pty_write,
645 .write_room = pty_write_room,
646 .flush_buffer = pty_flush_buffer,
647 .chars_in_buffer = pty_chars_in_buffer,
648 .unthrottle = pty_unthrottle,
649 .set_termios = pty_set_termios,
fa2ecfc5 650 .shutdown = pty_unix98_shutdown,
d03702a2 651 .cleanup = pty_cleanup,
99f1fe18 652};
d81ed103
AC
653
654/**
655 * ptmx_open - open a unix 98 pty master
656 * @inode: inode of device file
657 * @filp: file pointer to tty
658 *
659 * Allocate a unix98 pty master device from the ptmx driver.
660 *
661 * Locking: tty_mutex protects the init_dev work. tty->count should
b9f8033f 662 * protect the rest.
d81ed103
AC
663 * allocated_ptys_lock handles the list of free pty numbers
664 */
665
64ba3dc3 666static int ptmx_open(struct inode *inode, struct file *filp)
d81ed103
AC
667{
668 struct tty_struct *tty;
162b97cf 669 struct inode *slave_inode;
d81ed103
AC
670 int retval;
671 int index;
672
673 nonseekable_open(inode, filp);
674
b0b88565
LT
675 /* We refuse fsnotify events on ptmx, since it's a shared resource */
676 filp->f_mode |= FMODE_NONOTIFY;
677
fa90e1c9
JS
678 retval = tty_alloc_file(filp);
679 if (retval)
680 return retval;
681
d81ed103 682 /* find a device that is not in use. */
89c8d91e 683 mutex_lock(&devpts_mutex);
15f1a633 684 index = devpts_new_index(inode);
fa90e1c9
JS
685 if (index < 0) {
686 retval = index;
05fb79e4 687 mutex_unlock(&devpts_mutex);
fa90e1c9
JS
688 goto err_file;
689 }
d81ed103 690
89c8d91e
AC
691 mutex_unlock(&devpts_mutex);
692
d81ed103 693 mutex_lock(&tty_mutex);
593a27c4 694 tty = tty_init_dev(ptm_driver, index);
d81ed103 695
73ec06fc
AC
696 if (IS_ERR(tty)) {
697 retval = PTR_ERR(tty);
d81ed103 698 goto out;
73ec06fc 699 }
d81ed103 700
89c8d91e
AC
701 /* The tty returned here is locked so we can safely
702 drop the mutex */
703 mutex_unlock(&tty_mutex);
704
d81ed103 705 set_bit(TTY_PTY_LOCK, &tty->flags); /* LOCK THE SLAVE */
7acf6cd8 706 tty->driver_data = inode;
ee2ffa0d 707
fa90e1c9 708 tty_add_file(tty, filp);
d81ed103 709
f11afb61
JS
710 slave_inode = devpts_pty_new(inode,
711 MKDEV(UNIX98_PTY_SLAVE_MAJOR, index), index,
712 tty->link);
162b97cf
JS
713 if (IS_ERR(slave_inode)) {
714 retval = PTR_ERR(slave_inode);
1177c0ef 715 goto err_release;
162b97cf 716 }
7acf6cd8 717 tty->link->driver_data = slave_inode;
d81ed103
AC
718
719 retval = ptm_driver->ops->open(tty, filp);
64ba3dc3 720 if (retval)
1177c0ef
JS
721 goto err_release;
722
89c8d91e 723 tty_unlock(tty);
1177c0ef
JS
724 return 0;
725err_release:
89c8d91e 726 tty_unlock(tty);
eeb89d91 727 tty_release(inode, filp);
d81ed103
AC
728 return retval;
729out:
89c8d91e 730 mutex_unlock(&tty_mutex);
d3bda529 731 devpts_kill_index(inode, index);
fa90e1c9
JS
732err_file:
733 tty_free_file(filp);
64ba3dc3 734 return retval;
d81ed103
AC
735}
736
737static struct file_operations ptmx_fops;
738
1da177e4
LT
739static void __init unix98_pty_init(void)
740{
21aca2fa
JS
741 ptm_driver = tty_alloc_driver(NR_UNIX98_PTY_MAX,
742 TTY_DRIVER_RESET_TERMIOS |
743 TTY_DRIVER_REAL_RAW |
744 TTY_DRIVER_DYNAMIC_DEV |
745 TTY_DRIVER_DEVPTS_MEM |
746 TTY_DRIVER_DYNAMIC_ALLOC);
c3a6344a 747 if (IS_ERR(ptm_driver))
1da177e4 748 panic("Couldn't allocate Unix98 ptm driver");
21aca2fa
JS
749 pts_driver = tty_alloc_driver(NR_UNIX98_PTY_MAX,
750 TTY_DRIVER_RESET_TERMIOS |
751 TTY_DRIVER_REAL_RAW |
752 TTY_DRIVER_DYNAMIC_DEV |
753 TTY_DRIVER_DEVPTS_MEM |
754 TTY_DRIVER_DYNAMIC_ALLOC);
c3a6344a 755 if (IS_ERR(pts_driver))
1da177e4
LT
756 panic("Couldn't allocate Unix98 pts driver");
757
1da177e4
LT
758 ptm_driver->driver_name = "pty_master";
759 ptm_driver->name = "ptm";
760 ptm_driver->major = UNIX98_PTY_MASTER_MAJOR;
761 ptm_driver->minor_start = 0;
762 ptm_driver->type = TTY_DRIVER_TYPE_PTY;
763 ptm_driver->subtype = PTY_TYPE_MASTER;
764 ptm_driver->init_termios = tty_std_termios;
765 ptm_driver->init_termios.c_iflag = 0;
766 ptm_driver->init_termios.c_oflag = 0;
767 ptm_driver->init_termios.c_cflag = B38400 | CS8 | CREAD;
768 ptm_driver->init_termios.c_lflag = 0;
606d099c
AC
769 ptm_driver->init_termios.c_ispeed = 38400;
770 ptm_driver->init_termios.c_ospeed = 38400;
1da177e4 771 ptm_driver->other = pts_driver;
feebed65 772 tty_set_operations(ptm_driver, &ptm_unix98_ops);
1da177e4 773
1da177e4
LT
774 pts_driver->driver_name = "pty_slave";
775 pts_driver->name = "pts";
776 pts_driver->major = UNIX98_PTY_SLAVE_MAJOR;
777 pts_driver->minor_start = 0;
778 pts_driver->type = TTY_DRIVER_TYPE_PTY;
779 pts_driver->subtype = PTY_TYPE_SLAVE;
780 pts_driver->init_termios = tty_std_termios;
781 pts_driver->init_termios.c_cflag = B38400 | CS8 | CREAD;
606d099c
AC
782 pts_driver->init_termios.c_ispeed = 38400;
783 pts_driver->init_termios.c_ospeed = 38400;
1da177e4 784 pts_driver->other = ptm_driver;
99f1fe18 785 tty_set_operations(pts_driver, &pty_unix98_ops);
fe9cd962 786
1da177e4
LT
787 if (tty_register_driver(ptm_driver))
788 panic("Couldn't register Unix98 ptm driver");
789 if (tty_register_driver(pts_driver))
790 panic("Couldn't register Unix98 pts driver");
791
d81ed103
AC
792 /* Now create the /dev/ptmx special device */
793 tty_default_fops(&ptmx_fops);
794 ptmx_fops.open = ptmx_open;
795
796 cdev_init(&ptmx_cdev, &ptmx_fops);
797 if (cdev_add(&ptmx_cdev, MKDEV(TTYAUX_MAJOR, 2), 1) ||
798 register_chrdev_region(MKDEV(TTYAUX_MAJOR, 2), 1, "/dev/ptmx") < 0)
82f8c35f 799 panic("Couldn't register /dev/ptmx driver");
d81ed103 800 device_create(tty_class, NULL, MKDEV(TTYAUX_MAJOR, 2), NULL, "ptmx");
1da177e4 801}
d81ed103 802
1da177e4
LT
803#else
804static inline void unix98_pty_init(void) { }
805#endif
806
807static int __init pty_init(void)
808{
809 legacy_pty_init();
810 unix98_pty_init();
811 return 0;
812}
813module_init(pty_init);