tty: Document required behavior of tty driver close()
[deliverable/linux.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
LT
246{
247 int retval = -ENODEV;
248
249 if (!tty || !tty->link)
250 goto out;
251
69939035
PH
252 set_bit(TTY_IO_ERROR, &tty->flags);
253
1da177e4
LT
254 retval = -EIO;
255 if (test_bit(TTY_OTHER_CLOSED, &tty->flags))
256 goto out;
257 if (test_bit(TTY_PTY_LOCK, &tty->link->flags))
258 goto out;
259 if (tty->link->count != 1)
260 goto out;
261
69939035 262 clear_bit(TTY_IO_ERROR, &tty->flags);
1da177e4
LT
263 clear_bit(TTY_OTHER_CLOSED, &tty->link->flags);
264 set_bit(TTY_THROTTLED, &tty->flags);
1da177e4
LT
265 retval = 0;
266out:
267 return retval;
268}
269
fe9cd962
AC
270static void pty_set_termios(struct tty_struct *tty,
271 struct ktermios *old_termios)
1da177e4 272{
adc8d746
AC
273 tty->termios.c_cflag &= ~(CSIZE | PARENB);
274 tty->termios.c_cflag |= (CS8 | CREAD);
1da177e4
LT
275}
276
fc6f6238
AC
277/**
278 * pty_do_resize - resize event
279 * @tty: tty being resized
c774bda2 280 * @ws: window size being set.
fc6f6238 281 *
3ad2f3fb 282 * Update the termios variables and send the necessary signals to
fc6f6238
AC
283 * peform a terminal resize correctly
284 */
285
159a8e92 286static int pty_resize(struct tty_struct *tty, struct winsize *ws)
fc6f6238
AC
287{
288 struct pid *pgrp, *rpgrp;
289 unsigned long flags;
290 struct tty_struct *pty = tty->link;
291
292 /* For a PTY we need to lock the tty side */
293 mutex_lock(&tty->termios_mutex);
294 if (!memcmp(ws, &tty->winsize, sizeof(*ws)))
295 goto done;
296
297 /* Get the PID values and reference them so we can
298 avoid holding the tty ctrl lock while sending signals.
299 We need to lock these individually however. */
300
301 spin_lock_irqsave(&tty->ctrl_lock, flags);
302 pgrp = get_pid(tty->pgrp);
303 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
304
305 spin_lock_irqsave(&pty->ctrl_lock, flags);
306 rpgrp = get_pid(pty->pgrp);
307 spin_unlock_irqrestore(&pty->ctrl_lock, flags);
308
309 if (pgrp)
310 kill_pgrp(pgrp, SIGWINCH, 1);
311 if (rpgrp != pgrp && rpgrp)
312 kill_pgrp(rpgrp, SIGWINCH, 1);
313
314 put_pid(pgrp);
315 put_pid(rpgrp);
316
317 tty->winsize = *ws;
318 pty->winsize = *ws; /* Never used so will go away soon */
319done:
320 mutex_unlock(&tty->termios_mutex);
321 return 0;
322}
323
d155255a
AC
324/**
325 * pty_common_install - set up the pty pair
326 * @driver: the pty driver
327 * @tty: the tty being instantiated
328 * @bool: legacy, true if this is BSD style
329 *
330 * Perform the initial set up for the tty/pty pair. Called from the
331 * tty layer when the port is first opened.
332 *
333 * Locking: the caller must hold the tty_mutex
334 */
5d249bc6
JS
335static int pty_common_install(struct tty_driver *driver, struct tty_struct *tty,
336 bool legacy)
bf970ee4
AC
337{
338 struct tty_struct *o_tty;
d03702a2 339 struct tty_port *ports[2];
bf970ee4 340 int idx = tty->index;
5d249bc6 341 int retval = -ENOMEM;
bf970ee4
AC
342
343 o_tty = alloc_tty_struct();
6f9ea7ad
JS
344 if (!o_tty)
345 goto err;
d03702a2
JS
346 ports[0] = kmalloc(sizeof **ports, GFP_KERNEL);
347 ports[1] = kmalloc(sizeof **ports, GFP_KERNEL);
6f9ea7ad 348 if (!ports[0] || !ports[1])
d03702a2 349 goto err_free_tty;
bf970ee4
AC
350 if (!try_module_get(driver->other->owner)) {
351 /* This cannot in fact currently happen */
8a1b8d70 352 goto err_free_tty;
bf970ee4
AC
353 }
354 initialize_tty_struct(o_tty, driver->other, idx);
355
5d249bc6
JS
356 if (legacy) {
357 /* We always use new tty termios data so we can do this
358 the easy way .. */
359 retval = tty_init_termios(tty);
360 if (retval)
361 goto err_deinit_tty;
362
363 retval = tty_init_termios(o_tty);
364 if (retval)
365 goto err_free_termios;
366
367 driver->other->ttys[idx] = o_tty;
368 driver->ttys[idx] = tty;
369 } else {
adc8d746
AC
370 memset(&tty->termios_locked, 0, sizeof(tty->termios_locked));
371 tty->termios = driver->init_termios;
372 memset(&o_tty->termios_locked, 0, sizeof(tty->termios_locked));
373 o_tty->termios = driver->other->init_termios;
5d249bc6 374 }
fe9cd962 375
bf970ee4
AC
376 /*
377 * Everything allocated ... set up the o_tty structure.
378 */
bf970ee4
AC
379 tty_driver_kref_get(driver->other);
380 if (driver->subtype == PTY_TYPE_MASTER)
381 o_tty->count++;
382 /* Establish the links in both directions */
383 tty->link = o_tty;
384 o_tty->link = tty;
d03702a2
JS
385 tty_port_init(ports[0]);
386 tty_port_init(ports[1]);
387 o_tty->port = ports[0];
388 tty->port = ports[1];
967fab69 389 o_tty->port->itty = o_tty;
bf970ee4
AC
390
391 tty_driver_kref_get(driver);
392 tty->count++;
bf970ee4 393 return 0;
8a1b8d70 394err_free_termios:
5d249bc6
JS
395 if (legacy)
396 tty_free_termios(tty);
a9dccddb
JS
397err_deinit_tty:
398 deinitialize_tty_struct(o_tty);
bf970ee4 399 module_put(o_tty->driver->owner);
8a1b8d70 400err_free_tty:
d03702a2
JS
401 kfree(ports[0]);
402 kfree(ports[1]);
bf970ee4 403 free_tty_struct(o_tty);
6f9ea7ad 404err:
8a1b8d70 405 return retval;
bf970ee4
AC
406}
407
fa2ecfc5
JS
408/* this is called once with whichever end is closed last */
409static void pty_unix98_shutdown(struct tty_struct *tty)
410{
411 devpts_kill_index(tty->driver_data, tty->index);
412}
413
d03702a2
JS
414static void pty_cleanup(struct tty_struct *tty)
415{
967fab69 416 tty->port->itty = NULL;
81c79838 417 tty_port_put(tty->port);
d03702a2
JS
418}
419
5d249bc6
JS
420/* Traditional BSD devices */
421#ifdef CONFIG_LEGACY_PTYS
422
423static int pty_install(struct tty_driver *driver, struct tty_struct *tty)
424{
425 return pty_common_install(driver, tty, true);
426}
427
d155255a
AC
428static void pty_remove(struct tty_driver *driver, struct tty_struct *tty)
429{
430 struct tty_struct *pair = tty->link;
431 driver->ttys[tty->index] = NULL;
432 if (pair)
433 pair->driver->ttys[pair->index] = NULL;
434}
435
6caa76b7 436static int pty_bsd_ioctl(struct tty_struct *tty,
1da177e4
LT
437 unsigned int cmd, unsigned long arg)
438{
439 switch (cmd) {
440 case TIOCSPTLCK: /* Set PT Lock (disallow slave open) */
441 return pty_set_lock(tty, (int __user *) arg);
84fd7bdf
CG
442 case TIOCGPTLCK: /* Get PT Lock status */
443 return pty_get_lock(tty, (int __user *)arg);
06026d91
CG
444 case TIOCPKT: /* Set PT packet mode */
445 return pty_set_pktmode(tty, (int __user *)arg);
84fd7bdf
CG
446 case TIOCGPKT: /* Get PT packet mode */
447 return pty_get_pktmode(tty, (int __user *)arg);
26df6d13 448 case TIOCSIG: /* Send signal to other side of pty */
449 return pty_signal(tty, (int) arg);
ded2f295
JS
450 case TIOCGPTN: /* TTY returns ENOTTY, but glibc expects EINVAL here */
451 return -EINVAL;
1da177e4
LT
452 }
453 return -ENOIOCTLCMD;
454}
455
dc8c8587
KS
456static int legacy_count = CONFIG_LEGACY_PTY_COUNT;
457module_param(legacy_count, int, 0);
458
342a5971
LT
459/*
460 * The master side of a pty can do TIOCSPTLCK and thus
461 * has pty_bsd_ioctl.
462 */
463static const struct tty_operations master_pty_ops_bsd = {
464 .install = pty_install,
3e8e88ca
AC
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,
473 .ioctl = pty_bsd_ioctl,
d03702a2 474 .cleanup = pty_cleanup,
d155255a
AC
475 .resize = pty_resize,
476 .remove = pty_remove
3e8e88ca
AC
477};
478
342a5971
LT
479static const struct tty_operations slave_pty_ops_bsd = {
480 .install = pty_install,
481 .open = pty_open,
482 .close = pty_close,
483 .write = pty_write,
484 .write_room = pty_write_room,
485 .flush_buffer = pty_flush_buffer,
486 .chars_in_buffer = pty_chars_in_buffer,
487 .unthrottle = pty_unthrottle,
488 .set_termios = pty_set_termios,
d03702a2 489 .cleanup = pty_cleanup,
d155255a
AC
490 .resize = pty_resize,
491 .remove = pty_remove
342a5971
LT
492};
493
1da177e4
LT
494static void __init legacy_pty_init(void)
495{
342a5971
LT
496 struct tty_driver *pty_driver, *pty_slave_driver;
497
dc8c8587
KS
498 if (legacy_count <= 0)
499 return;
1da177e4 500
21aca2fa
JS
501 pty_driver = tty_alloc_driver(legacy_count,
502 TTY_DRIVER_RESET_TERMIOS |
503 TTY_DRIVER_REAL_RAW |
504 TTY_DRIVER_DYNAMIC_ALLOC);
c3a6344a 505 if (IS_ERR(pty_driver))
1da177e4
LT
506 panic("Couldn't allocate pty driver");
507
21aca2fa
JS
508 pty_slave_driver = tty_alloc_driver(legacy_count,
509 TTY_DRIVER_RESET_TERMIOS |
510 TTY_DRIVER_REAL_RAW |
511 TTY_DRIVER_DYNAMIC_ALLOC);
c3a6344a 512 if (IS_ERR(pty_slave_driver))
1da177e4
LT
513 panic("Couldn't allocate pty slave driver");
514
1da177e4
LT
515 pty_driver->driver_name = "pty_master";
516 pty_driver->name = "pty";
1da177e4
LT
517 pty_driver->major = PTY_MASTER_MAJOR;
518 pty_driver->minor_start = 0;
519 pty_driver->type = TTY_DRIVER_TYPE_PTY;
520 pty_driver->subtype = PTY_TYPE_MASTER;
521 pty_driver->init_termios = tty_std_termios;
522 pty_driver->init_termios.c_iflag = 0;
523 pty_driver->init_termios.c_oflag = 0;
524 pty_driver->init_termios.c_cflag = B38400 | CS8 | CREAD;
525 pty_driver->init_termios.c_lflag = 0;
606d099c
AC
526 pty_driver->init_termios.c_ispeed = 38400;
527 pty_driver->init_termios.c_ospeed = 38400;
1da177e4 528 pty_driver->other = pty_slave_driver;
342a5971 529 tty_set_operations(pty_driver, &master_pty_ops_bsd);
1da177e4 530
1da177e4
LT
531 pty_slave_driver->driver_name = "pty_slave";
532 pty_slave_driver->name = "ttyp";
1da177e4
LT
533 pty_slave_driver->major = PTY_SLAVE_MAJOR;
534 pty_slave_driver->minor_start = 0;
535 pty_slave_driver->type = TTY_DRIVER_TYPE_PTY;
536 pty_slave_driver->subtype = PTY_TYPE_SLAVE;
537 pty_slave_driver->init_termios = tty_std_termios;
538 pty_slave_driver->init_termios.c_cflag = B38400 | CS8 | CREAD;
606d099c
AC
539 pty_slave_driver->init_termios.c_ispeed = 38400;
540 pty_slave_driver->init_termios.c_ospeed = 38400;
1da177e4 541 pty_slave_driver->other = pty_driver;
342a5971 542 tty_set_operations(pty_slave_driver, &slave_pty_ops_bsd);
1da177e4
LT
543
544 if (tty_register_driver(pty_driver))
545 panic("Couldn't register pty driver");
546 if (tty_register_driver(pty_slave_driver))
547 panic("Couldn't register pty slave driver");
548}
549#else
550static inline void legacy_pty_init(void) { }
551#endif
552
553/* Unix98 devices */
554#ifdef CONFIG_UNIX98_PTYS
1da177e4 555
d81ed103
AC
556static struct cdev ptmx_cdev;
557
6caa76b7 558static int pty_unix98_ioctl(struct tty_struct *tty,
1da177e4
LT
559 unsigned int cmd, unsigned long arg)
560{
561 switch (cmd) {
562 case TIOCSPTLCK: /* Set PT Lock (disallow slave open) */
563 return pty_set_lock(tty, (int __user *)arg);
84fd7bdf
CG
564 case TIOCGPTLCK: /* Get PT Lock status */
565 return pty_get_lock(tty, (int __user *)arg);
06026d91
CG
566 case TIOCPKT: /* Set PT packet mode */
567 return pty_set_pktmode(tty, (int __user *)arg);
84fd7bdf
CG
568 case TIOCGPKT: /* Get PT packet mode */
569 return pty_get_pktmode(tty, (int __user *)arg);
1da177e4
LT
570 case TIOCGPTN: /* Get PT Number */
571 return put_user(tty->index, (unsigned int __user *)arg);
26df6d13 572 case TIOCSIG: /* Send signal to other side of pty */
573 return pty_signal(tty, (int) arg);
1da177e4
LT
574 }
575
576 return -ENOIOCTLCMD;
577}
578
99f1fe18
AC
579/**
580 * ptm_unix98_lookup - find a pty master
581 * @driver: ptm driver
582 * @idx: tty index
583 *
584 * Look up a pty master device. Called under the tty_mutex for now.
585 * This provides our locking.
586 */
587
15f1a633
SB
588static struct tty_struct *ptm_unix98_lookup(struct tty_driver *driver,
589 struct inode *ptm_inode, int idx)
99f1fe18 590{
593a27c4
KK
591 /* Master must be open via /dev/ptmx */
592 return ERR_PTR(-EIO);
99f1fe18
AC
593}
594
595/**
596 * pts_unix98_lookup - find a pty slave
597 * @driver: pts driver
598 * @idx: tty index
599 *
600 * Look up a pty master device. Called under the tty_mutex for now.
d739e65b 601 * This provides our locking for the tty pointer.
99f1fe18
AC
602 */
603
15f1a633
SB
604static struct tty_struct *pts_unix98_lookup(struct tty_driver *driver,
605 struct inode *pts_inode, int idx)
99f1fe18 606{
d739e65b
AC
607 struct tty_struct *tty;
608
609 mutex_lock(&devpts_mutex);
8fcbaa2b 610 tty = devpts_get_priv(pts_inode);
d739e65b 611 mutex_unlock(&devpts_mutex);
99f1fe18
AC
612 /* Master must be open before slave */
613 if (!tty)
614 return ERR_PTR(-EIO);
615 return tty;
616}
617
8b0a88d5
AC
618/* We have no need to install and remove our tty objects as devpts does all
619 the work for us */
620
bf970ee4 621static int pty_unix98_install(struct tty_driver *driver, struct tty_struct *tty)
8b0a88d5 622{
5d249bc6 623 return pty_common_install(driver, tty, false);
8b0a88d5
AC
624}
625
7171604a 626static void pty_unix98_remove(struct tty_driver *driver, struct tty_struct *tty)
8b0a88d5
AC
627{
628}
629
feebed65 630static const struct tty_operations ptm_unix98_ops = {
99f1fe18 631 .lookup = ptm_unix98_lookup,
bf970ee4 632 .install = pty_unix98_install,
7171604a 633 .remove = pty_unix98_remove,
3e8e88ca
AC
634 .open = pty_open,
635 .close = pty_close,
636 .write = pty_write,
637 .write_room = pty_write_room,
638 .flush_buffer = pty_flush_buffer,
639 .chars_in_buffer = pty_chars_in_buffer,
640 .unthrottle = pty_unthrottle,
641 .set_termios = pty_set_termios,
feebed65 642 .ioctl = pty_unix98_ioctl,
36b3c070 643 .resize = pty_resize,
fa2ecfc5 644 .shutdown = pty_unix98_shutdown,
36b3c070 645 .cleanup = pty_cleanup
3e8e88ca
AC
646};
647
99f1fe18
AC
648static const struct tty_operations pty_unix98_ops = {
649 .lookup = pts_unix98_lookup,
bf970ee4 650 .install = pty_unix98_install,
7171604a 651 .remove = pty_unix98_remove,
99f1fe18
AC
652 .open = pty_open,
653 .close = pty_close,
654 .write = pty_write,
655 .write_room = pty_write_room,
656 .flush_buffer = pty_flush_buffer,
657 .chars_in_buffer = pty_chars_in_buffer,
658 .unthrottle = pty_unthrottle,
659 .set_termios = pty_set_termios,
fa2ecfc5 660 .shutdown = pty_unix98_shutdown,
d03702a2 661 .cleanup = pty_cleanup,
99f1fe18 662};
d81ed103
AC
663
664/**
665 * ptmx_open - open a unix 98 pty master
666 * @inode: inode of device file
667 * @filp: file pointer to tty
668 *
669 * Allocate a unix98 pty master device from the ptmx driver.
670 *
671 * Locking: tty_mutex protects the init_dev work. tty->count should
b9f8033f 672 * protect the rest.
d81ed103
AC
673 * allocated_ptys_lock handles the list of free pty numbers
674 */
675
64ba3dc3 676static int ptmx_open(struct inode *inode, struct file *filp)
d81ed103
AC
677{
678 struct tty_struct *tty;
162b97cf 679 struct inode *slave_inode;
d81ed103
AC
680 int retval;
681 int index;
682
683 nonseekable_open(inode, filp);
684
fa90e1c9
JS
685 retval = tty_alloc_file(filp);
686 if (retval)
687 return retval;
688
d81ed103 689 /* find a device that is not in use. */
89c8d91e 690 mutex_lock(&devpts_mutex);
15f1a633 691 index = devpts_new_index(inode);
fa90e1c9
JS
692 if (index < 0) {
693 retval = index;
05fb79e4 694 mutex_unlock(&devpts_mutex);
fa90e1c9
JS
695 goto err_file;
696 }
d81ed103 697
89c8d91e
AC
698 mutex_unlock(&devpts_mutex);
699
d81ed103 700 mutex_lock(&tty_mutex);
593a27c4 701 tty = tty_init_dev(ptm_driver, index);
d81ed103 702
73ec06fc
AC
703 if (IS_ERR(tty)) {
704 retval = PTR_ERR(tty);
d81ed103 705 goto out;
73ec06fc 706 }
d81ed103 707
89c8d91e
AC
708 /* The tty returned here is locked so we can safely
709 drop the mutex */
710 mutex_unlock(&tty_mutex);
711
d81ed103 712 set_bit(TTY_PTY_LOCK, &tty->flags); /* LOCK THE SLAVE */
7acf6cd8 713 tty->driver_data = inode;
ee2ffa0d 714
fa90e1c9 715 tty_add_file(tty, filp);
d81ed103 716
f11afb61
JS
717 slave_inode = devpts_pty_new(inode,
718 MKDEV(UNIX98_PTY_SLAVE_MAJOR, index), index,
719 tty->link);
162b97cf
JS
720 if (IS_ERR(slave_inode)) {
721 retval = PTR_ERR(slave_inode);
1177c0ef 722 goto err_release;
162b97cf 723 }
7acf6cd8 724 tty->link->driver_data = slave_inode;
d81ed103
AC
725
726 retval = ptm_driver->ops->open(tty, filp);
64ba3dc3 727 if (retval)
1177c0ef
JS
728 goto err_release;
729
89c8d91e 730 tty_unlock(tty);
1177c0ef
JS
731 return 0;
732err_release:
89c8d91e 733 tty_unlock(tty);
eeb89d91 734 tty_release(inode, filp);
d81ed103
AC
735 return retval;
736out:
89c8d91e 737 mutex_unlock(&tty_mutex);
d3bda529 738 devpts_kill_index(inode, index);
fa90e1c9
JS
739err_file:
740 tty_free_file(filp);
64ba3dc3 741 return retval;
d81ed103
AC
742}
743
744static struct file_operations ptmx_fops;
745
1da177e4
LT
746static void __init unix98_pty_init(void)
747{
21aca2fa
JS
748 ptm_driver = tty_alloc_driver(NR_UNIX98_PTY_MAX,
749 TTY_DRIVER_RESET_TERMIOS |
750 TTY_DRIVER_REAL_RAW |
751 TTY_DRIVER_DYNAMIC_DEV |
752 TTY_DRIVER_DEVPTS_MEM |
753 TTY_DRIVER_DYNAMIC_ALLOC);
c3a6344a 754 if (IS_ERR(ptm_driver))
1da177e4 755 panic("Couldn't allocate Unix98 ptm driver");
21aca2fa
JS
756 pts_driver = tty_alloc_driver(NR_UNIX98_PTY_MAX,
757 TTY_DRIVER_RESET_TERMIOS |
758 TTY_DRIVER_REAL_RAW |
759 TTY_DRIVER_DYNAMIC_DEV |
760 TTY_DRIVER_DEVPTS_MEM |
761 TTY_DRIVER_DYNAMIC_ALLOC);
c3a6344a 762 if (IS_ERR(pts_driver))
1da177e4
LT
763 panic("Couldn't allocate Unix98 pts driver");
764
1da177e4
LT
765 ptm_driver->driver_name = "pty_master";
766 ptm_driver->name = "ptm";
767 ptm_driver->major = UNIX98_PTY_MASTER_MAJOR;
768 ptm_driver->minor_start = 0;
769 ptm_driver->type = TTY_DRIVER_TYPE_PTY;
770 ptm_driver->subtype = PTY_TYPE_MASTER;
771 ptm_driver->init_termios = tty_std_termios;
772 ptm_driver->init_termios.c_iflag = 0;
773 ptm_driver->init_termios.c_oflag = 0;
774 ptm_driver->init_termios.c_cflag = B38400 | CS8 | CREAD;
775 ptm_driver->init_termios.c_lflag = 0;
606d099c
AC
776 ptm_driver->init_termios.c_ispeed = 38400;
777 ptm_driver->init_termios.c_ospeed = 38400;
1da177e4 778 ptm_driver->other = pts_driver;
feebed65 779 tty_set_operations(ptm_driver, &ptm_unix98_ops);
1da177e4 780
1da177e4
LT
781 pts_driver->driver_name = "pty_slave";
782 pts_driver->name = "pts";
783 pts_driver->major = UNIX98_PTY_SLAVE_MAJOR;
784 pts_driver->minor_start = 0;
785 pts_driver->type = TTY_DRIVER_TYPE_PTY;
786 pts_driver->subtype = PTY_TYPE_SLAVE;
787 pts_driver->init_termios = tty_std_termios;
788 pts_driver->init_termios.c_cflag = B38400 | CS8 | CREAD;
606d099c
AC
789 pts_driver->init_termios.c_ispeed = 38400;
790 pts_driver->init_termios.c_ospeed = 38400;
1da177e4 791 pts_driver->other = ptm_driver;
99f1fe18 792 tty_set_operations(pts_driver, &pty_unix98_ops);
fe9cd962 793
1da177e4
LT
794 if (tty_register_driver(ptm_driver))
795 panic("Couldn't register Unix98 ptm driver");
796 if (tty_register_driver(pts_driver))
797 panic("Couldn't register Unix98 pts driver");
798
d81ed103
AC
799 /* Now create the /dev/ptmx special device */
800 tty_default_fops(&ptmx_fops);
801 ptmx_fops.open = ptmx_open;
802
803 cdev_init(&ptmx_cdev, &ptmx_fops);
804 if (cdev_add(&ptmx_cdev, MKDEV(TTYAUX_MAJOR, 2), 1) ||
805 register_chrdev_region(MKDEV(TTYAUX_MAJOR, 2), 1, "/dev/ptmx") < 0)
82f8c35f 806 panic("Couldn't register /dev/ptmx driver");
d81ed103 807 device_create(tty_class, NULL, MKDEV(TTYAUX_MAJOR, 2), NULL, "ptmx");
1da177e4 808}
d81ed103 809
1da177e4
LT
810#else
811static inline void unix98_pty_init(void) { }
812#endif
813
814static int __init pty_init(void)
815{
816 legacy_pty_init();
817 unix98_pty_init();
818 return 0;
819}
820module_init(pty_init);
This page took 0.681979 seconds and 5 git commands to generate.