blob: b5daaaa9007ed25ef5aee50041fc4895c0e90c54 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * linux/drivers/char/pty.c
3 *
4 * Copyright (C) 1991, 1992 Linus Torvalds
5 *
6 * Added support for a Unix98-style ptmx device.
7 * -- C. Scott Ananian <cananian@alumni.princeton.edu>, 14-Jan-1998
8 * Added TTY_DO_WRITE_WAKEUP to enable n_tty to send POLL_OUT to
9 * waiting writers -- Sapan Bhatia <sapan@corewars.org>
10 *
Alan Coxfe9cd962008-10-13 10:43:38 +010011 * When reading this code see also fs/devpts. In particular note that the
12 * driver_data field is used by the devpts side as a binding to the devpts
13 * inode.
Linus Torvalds1da177e2005-04-16 15:20:36 -070014 */
15
Alan Coxfe9cd962008-10-13 10:43:38 +010016#include <linux/module.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070017
18#include <linux/errno.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070019#include <linux/interrupt.h>
20#include <linux/tty.h>
21#include <linux/tty_flip.h>
22#include <linux/fcntl.h>
23#include <linux/string.h>
24#include <linux/major.h>
25#include <linux/mm.h>
26#include <linux/init.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070027#include <linux/sysctl.h>
Alan Coxd81ed102008-10-13 10:41:42 +010028#include <linux/device.h>
Alan Coxfe9cd962008-10-13 10:43:38 +010029#include <linux/uaccess.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070030#include <linux/bitops.h>
31#include <linux/devpts_fs.h>
32
Alan Coxfe9cd962008-10-13 10:43:38 +010033#include <asm/system.h>
34
Linus Torvalds1da177e2005-04-16 15:20:36 -070035/* These are global because they are accessed in tty_io.c */
36#ifdef CONFIG_UNIX98_PTYS
37struct tty_driver *ptm_driver;
38static struct tty_driver *pts_driver;
39#endif
40
Alan Coxfe9cd962008-10-13 10:43:38 +010041static void pty_close(struct tty_struct *tty, struct file *filp)
Linus Torvalds1da177e2005-04-16 15:20:36 -070042{
Alan Coxfe9cd962008-10-13 10:43:38 +010043 BUG_ON(!tty);
44 if (tty->driver->subtype == PTY_TYPE_MASTER)
45 WARN_ON(tty->count > 1);
46 else {
Linus Torvalds1da177e2005-04-16 15:20:36 -070047 if (tty->count > 2)
48 return;
49 }
50 wake_up_interruptible(&tty->read_wait);
51 wake_up_interruptible(&tty->write_wait);
52 tty->packet = 0;
53 if (!tty->link)
54 return;
55 tty->link->packet = 0;
56 set_bit(TTY_OTHER_CLOSED, &tty->link->flags);
57 wake_up_interruptible(&tty->link->read_wait);
58 wake_up_interruptible(&tty->link->write_wait);
59 if (tty->driver->subtype == PTY_TYPE_MASTER) {
60 set_bit(TTY_OTHER_CLOSED, &tty->flags);
61#ifdef CONFIG_UNIX98_PTYS
62 if (tty->driver == ptm_driver)
Sukadev Bhattiprolu15f1a632008-10-13 10:42:59 +010063 devpts_pty_kill(tty->link);
Linus Torvalds1da177e2005-04-16 15:20:36 -070064#endif
65 tty_vhangup(tty->link);
66 }
67}
68
69/*
70 * The unthrottle routine is called by the line discipline to signal
71 * that it can receive more characters. For PTY's, the TTY_THROTTLED
72 * flag is always set, to force the line discipline to always call the
Alan Coxfe9cd962008-10-13 10:43:38 +010073 * unthrottle routine when there are fewer than TTY_THRESHOLD_UNTHROTTLE
Linus Torvalds1da177e2005-04-16 15:20:36 -070074 * characters in the queue. This is necessary since each time this
75 * happens, we need to wake up any sleeping processes that could be
76 * (1) trying to send data to the pty, or (2) waiting in wait_until_sent()
77 * for the pty buffer to be drained.
78 */
Alan Coxfe9cd962008-10-13 10:43:38 +010079static void pty_unthrottle(struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -070080{
81 struct tty_struct *o_tty = tty->link;
82
83 if (!o_tty)
84 return;
85
86 tty_wakeup(o_tty);
87 set_bit(TTY_THROTTLED, &tty->flags);
88}
89
90/*
Alan Coxfe9cd962008-10-13 10:43:38 +010091 * WSH 05/24/97: modified to
Linus Torvalds1da177e2005-04-16 15:20:36 -070092 * (1) use space in tty->flip instead of a shared temp buffer
93 * The flip buffers aren't being used for a pty, so there's lots
94 * of space available. The buffer is protected by a per-pty
95 * semaphore that should almost never come under contention.
96 * (2) avoid redundant copying for cases where count >> receive_room
97 * N.B. Calls from user space may now return an error code instead of
98 * a count.
99 *
100 * FIXME: Our pty_write method is called with our ldisc lock held but
101 * not our partners. We can't just take the other one blindly without
Paul Fulghum817d6d32006-06-28 04:26:47 -0700102 * risking deadlocks.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700103 */
Alan Coxfe9cd962008-10-13 10:43:38 +0100104static int pty_write(struct tty_struct *tty, const unsigned char *buf,
105 int count)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700106{
107 struct tty_struct *to = tty->link;
108 int c;
109
110 if (!to || tty->stopped)
111 return 0;
112
Alan Cox33f0f882006-01-09 20:54:13 -0800113 c = to->receive_room;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700114 if (c > count)
115 c = count;
Alan Coxa352def2008-07-16 21:53:12 +0100116 to->ldisc.ops->receive_buf(to, buf, NULL, c);
Alan Coxfe9cd962008-10-13 10:43:38 +0100117
Linus Torvalds1da177e2005-04-16 15:20:36 -0700118 return c;
119}
120
121static int pty_write_room(struct tty_struct *tty)
122{
123 struct tty_struct *to = tty->link;
124
125 if (!to || tty->stopped)
126 return 0;
127
Alan Cox33f0f882006-01-09 20:54:13 -0800128 return to->receive_room;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700129}
130
131/*
132 * WSH 05/24/97: Modified for asymmetric MASTER/SLAVE behavior
Alan Coxfe9cd962008-10-13 10:43:38 +0100133 * The chars_in_buffer() value is used by the ldisc select() function
Linus Torvalds1da177e2005-04-16 15:20:36 -0700134 * to hold off writing when chars_in_buffer > WAKEUP_CHARS (== 256).
135 * The pty driver chars_in_buffer() Master/Slave must behave differently:
136 *
137 * The Master side needs to allow typed-ahead commands to accumulate
138 * while being canonicalized, so we report "our buffer" as empty until
139 * some threshold is reached, and then report the count. (Any count >
Alan Coxfe9cd962008-10-13 10:43:38 +0100140 * WAKEUP_CHARS is regarded by select() as "full".) To avoid deadlock
141 * the count returned must be 0 if no canonical data is available to be
Linus Torvalds1da177e2005-04-16 15:20:36 -0700142 * read. (The N_TTY ldisc.chars_in_buffer now knows this.)
Alan Coxfe9cd962008-10-13 10:43:38 +0100143 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700144 * The Slave side passes all characters in raw mode to the Master side's
145 * buffer where they can be read immediately, so in this case we can
146 * return the true count in the buffer.
147 */
148static int pty_chars_in_buffer(struct tty_struct *tty)
149{
150 struct tty_struct *to = tty->link;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700151 int count;
152
153 /* We should get the line discipline lock for "tty->link" */
Alan Coxa352def2008-07-16 21:53:12 +0100154 if (!to || !to->ldisc.ops->chars_in_buffer)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700155 return 0;
156
157 /* The ldisc must report 0 if no characters available to be read */
Alan Coxa352def2008-07-16 21:53:12 +0100158 count = to->ldisc.ops->chars_in_buffer(to);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700159
Alan Coxfe9cd962008-10-13 10:43:38 +0100160 if (tty->driver->subtype == PTY_TYPE_SLAVE)
161 return count;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700162
Alan Coxfe9cd962008-10-13 10:43:38 +0100163 /* Master side driver ... if the other side's read buffer is less than
Linus Torvalds1da177e2005-04-16 15:20:36 -0700164 * half full, return 0 to allow writers to proceed; otherwise return
Alan Coxfe9cd962008-10-13 10:43:38 +0100165 * the count. This leaves a comfortable margin to avoid overflow,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700166 * and still allows half a buffer's worth of typed-ahead commands.
167 */
Alan Coxfe9cd962008-10-13 10:43:38 +0100168 return (count < N_TTY_BUF_SIZE/2) ? 0 : count;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700169}
170
171/* Set the lock flag on a pty */
Alan Coxfe9cd962008-10-13 10:43:38 +0100172static int pty_set_lock(struct tty_struct *tty, int __user *arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700173{
174 int val;
Alan Coxfe9cd962008-10-13 10:43:38 +0100175 if (get_user(val, arg))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700176 return -EFAULT;
177 if (val)
178 set_bit(TTY_PTY_LOCK, &tty->flags);
179 else
180 clear_bit(TTY_PTY_LOCK, &tty->flags);
181 return 0;
182}
183
184static void pty_flush_buffer(struct tty_struct *tty)
185{
186 struct tty_struct *to = tty->link;
Alan Cox04f378b2008-04-30 00:53:29 -0700187 unsigned long flags;
Alan Coxfe9cd962008-10-13 10:43:38 +0100188
Linus Torvalds1da177e2005-04-16 15:20:36 -0700189 if (!to)
190 return;
Alan Coxfe9cd962008-10-13 10:43:38 +0100191
Alan Coxa352def2008-07-16 21:53:12 +0100192 if (to->ldisc.ops->flush_buffer)
193 to->ldisc.ops->flush_buffer(to);
Alan Coxfe9cd962008-10-13 10:43:38 +0100194
Linus Torvalds1da177e2005-04-16 15:20:36 -0700195 if (to->packet) {
Alan Cox04f378b2008-04-30 00:53:29 -0700196 spin_lock_irqsave(&tty->ctrl_lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700197 tty->ctrl_status |= TIOCPKT_FLUSHWRITE;
198 wake_up_interruptible(&to->read_wait);
Alan Cox04f378b2008-04-30 00:53:29 -0700199 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700200 }
201}
202
Alan Coxfe9cd962008-10-13 10:43:38 +0100203static int pty_open(struct tty_struct *tty, struct file *filp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700204{
205 int retval = -ENODEV;
206
207 if (!tty || !tty->link)
208 goto out;
209
210 retval = -EIO;
211 if (test_bit(TTY_OTHER_CLOSED, &tty->flags))
212 goto out;
213 if (test_bit(TTY_PTY_LOCK, &tty->link->flags))
214 goto out;
215 if (tty->link->count != 1)
216 goto out;
217
218 clear_bit(TTY_OTHER_CLOSED, &tty->link->flags);
219 set_bit(TTY_THROTTLED, &tty->flags);
220 set_bit(TTY_DO_WRITE_WAKEUP, &tty->flags);
221 retval = 0;
222out:
223 return retval;
224}
225
Alan Coxfe9cd962008-10-13 10:43:38 +0100226static void pty_set_termios(struct tty_struct *tty,
227 struct ktermios *old_termios)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700228{
Alan Coxfe9cd962008-10-13 10:43:38 +0100229 tty->termios->c_cflag &= ~(CSIZE | PARENB);
230 tty->termios->c_cflag |= (CS8 | CREAD);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700231}
232
Alan Coxfc6f6232009-01-02 13:43:17 +0000233/**
234 * pty_do_resize - resize event
235 * @tty: tty being resized
236 * @real_tty: real tty (not the same as tty if using a pty/tty pair)
237 * @rows: rows (character)
238 * @cols: cols (character)
239 *
240 * Update the termios variables and send the neccessary signals to
241 * peform a terminal resize correctly
242 */
243
244int pty_resize(struct tty_struct *tty, struct winsize *ws)
245{
246 struct pid *pgrp, *rpgrp;
247 unsigned long flags;
248 struct tty_struct *pty = tty->link;
249
250 /* For a PTY we need to lock the tty side */
251 mutex_lock(&tty->termios_mutex);
252 if (!memcmp(ws, &tty->winsize, sizeof(*ws)))
253 goto done;
254
255 /* Get the PID values and reference them so we can
256 avoid holding the tty ctrl lock while sending signals.
257 We need to lock these individually however. */
258
259 spin_lock_irqsave(&tty->ctrl_lock, flags);
260 pgrp = get_pid(tty->pgrp);
261 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
262
263 spin_lock_irqsave(&pty->ctrl_lock, flags);
264 rpgrp = get_pid(pty->pgrp);
265 spin_unlock_irqrestore(&pty->ctrl_lock, flags);
266
267 if (pgrp)
268 kill_pgrp(pgrp, SIGWINCH, 1);
269 if (rpgrp != pgrp && rpgrp)
270 kill_pgrp(rpgrp, SIGWINCH, 1);
271
272 put_pid(pgrp);
273 put_pid(rpgrp);
274
275 tty->winsize = *ws;
276 pty->winsize = *ws; /* Never used so will go away soon */
277done:
278 mutex_unlock(&tty->termios_mutex);
279 return 0;
280}
281
Alan Coxbf970ee2008-10-13 10:42:39 +0100282static int pty_install(struct tty_driver *driver, struct tty_struct *tty)
283{
284 struct tty_struct *o_tty;
285 int idx = tty->index;
286 int retval;
287
288 o_tty = alloc_tty_struct();
289 if (!o_tty)
290 return -ENOMEM;
291 if (!try_module_get(driver->other->owner)) {
292 /* This cannot in fact currently happen */
293 free_tty_struct(o_tty);
294 return -ENOMEM;
295 }
296 initialize_tty_struct(o_tty, driver->other, idx);
297
298 /* We always use new tty termios data so we can do this
299 the easy way .. */
300 retval = tty_init_termios(tty);
301 if (retval)
302 goto free_mem_out;
303
304 retval = tty_init_termios(o_tty);
305 if (retval) {
306 tty_free_termios(tty);
307 goto free_mem_out;
308 }
Alan Coxfe9cd962008-10-13 10:43:38 +0100309
Alan Coxbf970ee2008-10-13 10:42:39 +0100310 /*
311 * Everything allocated ... set up the o_tty structure.
312 */
313 driver->other->ttys[idx] = o_tty;
314 tty_driver_kref_get(driver->other);
315 if (driver->subtype == PTY_TYPE_MASTER)
316 o_tty->count++;
317 /* Establish the links in both directions */
318 tty->link = o_tty;
319 o_tty->link = tty;
320
321 tty_driver_kref_get(driver);
322 tty->count++;
323 driver->ttys[idx] = tty;
324 return 0;
325free_mem_out:
326 module_put(o_tty->driver->owner);
327 free_tty_struct(o_tty);
328 return -ENOMEM;
329}
330
331
Jeff Dikeb68e31d2006-10-02 02:17:18 -0700332static const struct tty_operations pty_ops = {
Alan Coxbf970ee2008-10-13 10:42:39 +0100333 .install = pty_install,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700334 .open = pty_open,
335 .close = pty_close,
336 .write = pty_write,
337 .write_room = pty_write_room,
338 .flush_buffer = pty_flush_buffer,
339 .chars_in_buffer = pty_chars_in_buffer,
340 .unthrottle = pty_unthrottle,
341 .set_termios = pty_set_termios,
Alan Coxfc6f6232009-01-02 13:43:17 +0000342 .resize = pty_resize
Linus Torvalds1da177e2005-04-16 15:20:36 -0700343};
344
345/* Traditional BSD devices */
346#ifdef CONFIG_LEGACY_PTYS
347static struct tty_driver *pty_driver, *pty_slave_driver;
348
349static int pty_bsd_ioctl(struct tty_struct *tty, struct file *file,
350 unsigned int cmd, unsigned long arg)
351{
352 switch (cmd) {
353 case TIOCSPTLCK: /* Set PT Lock (disallow slave open) */
354 return pty_set_lock(tty, (int __user *) arg);
355 }
356 return -ENOIOCTLCMD;
357}
358
Kay Sieversdc8c8582007-08-15 12:25:38 +0200359static int legacy_count = CONFIG_LEGACY_PTY_COUNT;
360module_param(legacy_count, int, 0);
361
Alan Cox3e8e88c2008-04-30 00:54:10 -0700362static const struct tty_operations pty_ops_bsd = {
363 .open = pty_open,
364 .close = pty_close,
365 .write = pty_write,
366 .write_room = pty_write_room,
367 .flush_buffer = pty_flush_buffer,
368 .chars_in_buffer = pty_chars_in_buffer,
369 .unthrottle = pty_unthrottle,
370 .set_termios = pty_set_termios,
371 .ioctl = pty_bsd_ioctl,
Alan Coxfc6f6232009-01-02 13:43:17 +0000372 .resize = pty_resize
Alan Cox3e8e88c2008-04-30 00:54:10 -0700373};
374
Linus Torvalds1da177e2005-04-16 15:20:36 -0700375static void __init legacy_pty_init(void)
376{
Kay Sieversdc8c8582007-08-15 12:25:38 +0200377 if (legacy_count <= 0)
378 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700379
Kay Sieversdc8c8582007-08-15 12:25:38 +0200380 pty_driver = alloc_tty_driver(legacy_count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700381 if (!pty_driver)
382 panic("Couldn't allocate pty driver");
383
Kay Sieversdc8c8582007-08-15 12:25:38 +0200384 pty_slave_driver = alloc_tty_driver(legacy_count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700385 if (!pty_slave_driver)
386 panic("Couldn't allocate pty slave driver");
387
388 pty_driver->owner = THIS_MODULE;
389 pty_driver->driver_name = "pty_master";
390 pty_driver->name = "pty";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700391 pty_driver->major = PTY_MASTER_MAJOR;
392 pty_driver->minor_start = 0;
393 pty_driver->type = TTY_DRIVER_TYPE_PTY;
394 pty_driver->subtype = PTY_TYPE_MASTER;
395 pty_driver->init_termios = tty_std_termios;
396 pty_driver->init_termios.c_iflag = 0;
397 pty_driver->init_termios.c_oflag = 0;
398 pty_driver->init_termios.c_cflag = B38400 | CS8 | CREAD;
399 pty_driver->init_termios.c_lflag = 0;
Alan Cox606d0992006-12-08 02:38:45 -0800400 pty_driver->init_termios.c_ispeed = 38400;
401 pty_driver->init_termios.c_ospeed = 38400;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700402 pty_driver->flags = TTY_DRIVER_RESET_TERMIOS | TTY_DRIVER_REAL_RAW;
403 pty_driver->other = pty_slave_driver;
404 tty_set_operations(pty_driver, &pty_ops);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700405
406 pty_slave_driver->owner = THIS_MODULE;
407 pty_slave_driver->driver_name = "pty_slave";
408 pty_slave_driver->name = "ttyp";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700409 pty_slave_driver->major = PTY_SLAVE_MAJOR;
410 pty_slave_driver->minor_start = 0;
411 pty_slave_driver->type = TTY_DRIVER_TYPE_PTY;
412 pty_slave_driver->subtype = PTY_TYPE_SLAVE;
413 pty_slave_driver->init_termios = tty_std_termios;
414 pty_slave_driver->init_termios.c_cflag = B38400 | CS8 | CREAD;
Alan Cox606d0992006-12-08 02:38:45 -0800415 pty_slave_driver->init_termios.c_ispeed = 38400;
416 pty_slave_driver->init_termios.c_ospeed = 38400;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700417 pty_slave_driver->flags = TTY_DRIVER_RESET_TERMIOS |
418 TTY_DRIVER_REAL_RAW;
419 pty_slave_driver->other = pty_driver;
420 tty_set_operations(pty_slave_driver, &pty_ops);
421
422 if (tty_register_driver(pty_driver))
423 panic("Couldn't register pty driver");
424 if (tty_register_driver(pty_slave_driver))
425 panic("Couldn't register pty slave driver");
426}
427#else
428static inline void legacy_pty_init(void) { }
429#endif
430
431/* Unix98 devices */
432#ifdef CONFIG_UNIX98_PTYS
433/*
434 * sysctl support for setting limits on the number of Unix98 ptys allocated.
435 * Otherwise one can eat up all kernel memory by opening /dev/ptmx repeatedly.
436 */
437int pty_limit = NR_UNIX98_PTY_DEFAULT;
Alan Coxfe9cd962008-10-13 10:43:38 +0100438static int pty_limit_min;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700439static int pty_limit_max = NR_UNIX98_PTY_MAX;
Alan Coxfe9cd962008-10-13 10:43:38 +0100440static int pty_count;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700441
Alan Coxd81ed102008-10-13 10:41:42 +0100442static struct cdev ptmx_cdev;
443
Eric W. Biederman35834ca2007-10-18 03:05:31 -0700444static struct ctl_table pty_table[] = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700445 {
446 .ctl_name = PTY_MAX,
447 .procname = "max",
448 .maxlen = sizeof(int),
449 .mode = 0644,
450 .data = &pty_limit,
451 .proc_handler = &proc_dointvec_minmax,
452 .strategy = &sysctl_intvec,
453 .extra1 = &pty_limit_min,
454 .extra2 = &pty_limit_max,
455 }, {
456 .ctl_name = PTY_NR,
457 .procname = "nr",
458 .maxlen = sizeof(int),
459 .mode = 0444,
Alan Coxbf970ee2008-10-13 10:42:39 +0100460 .data = &pty_count,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700461 .proc_handler = &proc_dointvec,
462 }, {
463 .ctl_name = 0
464 }
465};
466
Eric W. Biederman35834ca2007-10-18 03:05:31 -0700467static struct ctl_table pty_kern_table[] = {
468 {
469 .ctl_name = KERN_PTY,
470 .procname = "pty",
471 .mode = 0555,
472 .child = pty_table,
473 },
474 {}
475};
476
477static struct ctl_table pty_root_table[] = {
478 {
479 .ctl_name = CTL_KERN,
480 .procname = "kernel",
481 .mode = 0555,
482 .child = pty_kern_table,
483 },
484 {}
485};
486
487
Linus Torvalds1da177e2005-04-16 15:20:36 -0700488static int pty_unix98_ioctl(struct tty_struct *tty, struct file *file,
489 unsigned int cmd, unsigned long arg)
490{
491 switch (cmd) {
492 case TIOCSPTLCK: /* Set PT Lock (disallow slave open) */
493 return pty_set_lock(tty, (int __user *)arg);
494 case TIOCGPTN: /* Get PT Number */
495 return put_user(tty->index, (unsigned int __user *)arg);
496 }
497
498 return -ENOIOCTLCMD;
499}
500
Alan Cox99f1fe12008-10-13 10:42:00 +0100501/**
502 * ptm_unix98_lookup - find a pty master
503 * @driver: ptm driver
504 * @idx: tty index
505 *
506 * Look up a pty master device. Called under the tty_mutex for now.
507 * This provides our locking.
508 */
509
Sukadev Bhattiprolu15f1a632008-10-13 10:42:59 +0100510static struct tty_struct *ptm_unix98_lookup(struct tty_driver *driver,
511 struct inode *ptm_inode, int idx)
Alan Cox99f1fe12008-10-13 10:42:00 +0100512{
Sukadev Bhattiprolu15f1a632008-10-13 10:42:59 +0100513 struct tty_struct *tty = devpts_get_tty(ptm_inode, idx);
Alan Cox99f1fe12008-10-13 10:42:00 +0100514 if (tty)
515 tty = tty->link;
516 return tty;
517}
518
519/**
520 * pts_unix98_lookup - find a pty slave
521 * @driver: pts driver
522 * @idx: tty index
523 *
524 * Look up a pty master device. Called under the tty_mutex for now.
525 * This provides our locking.
526 */
527
Sukadev Bhattiprolu15f1a632008-10-13 10:42:59 +0100528static struct tty_struct *pts_unix98_lookup(struct tty_driver *driver,
529 struct inode *pts_inode, int idx)
Alan Cox99f1fe12008-10-13 10:42:00 +0100530{
Sukadev Bhattiprolu15f1a632008-10-13 10:42:59 +0100531 struct tty_struct *tty = devpts_get_tty(pts_inode, idx);
Alan Cox99f1fe12008-10-13 10:42:00 +0100532 /* Master must be open before slave */
533 if (!tty)
534 return ERR_PTR(-EIO);
535 return tty;
536}
537
Alan Coxbf970ee2008-10-13 10:42:39 +0100538static void pty_unix98_shutdown(struct tty_struct *tty)
Alan Coxfeebed62008-10-13 10:41:30 +0100539{
540 /* We have our own method as we don't use the tty index */
541 kfree(tty->termios);
Alan Coxfeebed62008-10-13 10:41:30 +0100542}
543
Alan Cox8b0a88d2008-10-13 10:42:19 +0100544/* We have no need to install and remove our tty objects as devpts does all
545 the work for us */
546
Alan Coxbf970ee2008-10-13 10:42:39 +0100547static int pty_unix98_install(struct tty_driver *driver, struct tty_struct *tty)
Alan Cox8b0a88d2008-10-13 10:42:19 +0100548{
Alan Coxbf970ee2008-10-13 10:42:39 +0100549 struct tty_struct *o_tty;
550 int idx = tty->index;
551
552 o_tty = alloc_tty_struct();
553 if (!o_tty)
554 return -ENOMEM;
555 if (!try_module_get(driver->other->owner)) {
556 /* This cannot in fact currently happen */
557 free_tty_struct(o_tty);
558 return -ENOMEM;
559 }
560 initialize_tty_struct(o_tty, driver->other, idx);
561
Alan Cox8dff04e2008-10-13 10:43:58 +0100562 tty->termios = kzalloc(sizeof(struct ktermios[2]), GFP_KERNEL);
Alan Coxbf970ee2008-10-13 10:42:39 +0100563 if (tty->termios == NULL)
564 goto free_mem_out;
565 *tty->termios = driver->init_termios;
Alan Cox8dff04e2008-10-13 10:43:58 +0100566 tty->termios_locked = tty->termios + 1;
567
568 o_tty->termios = kzalloc(sizeof(struct ktermios[2]), GFP_KERNEL);
Alan Coxbf970ee2008-10-13 10:42:39 +0100569 if (o_tty->termios == NULL)
570 goto free_mem_out;
571 *o_tty->termios = driver->other->init_termios;
Alan Cox8dff04e2008-10-13 10:43:58 +0100572 o_tty->termios_locked = o_tty->termios + 1;
Alan Coxbf970ee2008-10-13 10:42:39 +0100573
574 tty_driver_kref_get(driver->other);
575 if (driver->subtype == PTY_TYPE_MASTER)
576 o_tty->count++;
577 /* Establish the links in both directions */
578 tty->link = o_tty;
579 o_tty->link = tty;
580 /*
581 * All structures have been allocated, so now we install them.
582 * Failures after this point use release_tty to clean up, so
583 * there's no need to null out the local pointers.
584 */
585 tty_driver_kref_get(driver);
586 tty->count++;
587 pty_count++;
Alan Cox8b0a88d2008-10-13 10:42:19 +0100588 return 0;
Alan Coxbf970ee2008-10-13 10:42:39 +0100589free_mem_out:
Alan Cox8dff04e2008-10-13 10:43:58 +0100590 kfree(o_tty->termios);
Alan Coxbf970ee2008-10-13 10:42:39 +0100591 module_put(o_tty->driver->owner);
592 free_tty_struct(o_tty);
Alan Cox8dff04e2008-10-13 10:43:58 +0100593 kfree(tty->termios);
Alan Coxbf970ee2008-10-13 10:42:39 +0100594 return -ENOMEM;
Alan Cox8b0a88d2008-10-13 10:42:19 +0100595}
596
Alan Coxbf970ee2008-10-13 10:42:39 +0100597static void pty_unix98_remove(struct tty_driver *driver, struct tty_struct *tty)
Alan Cox8b0a88d2008-10-13 10:42:19 +0100598{
Alan Coxbf970ee2008-10-13 10:42:39 +0100599 pty_count--;
Alan Cox8b0a88d2008-10-13 10:42:19 +0100600}
601
Alan Coxfeebed62008-10-13 10:41:30 +0100602static const struct tty_operations ptm_unix98_ops = {
Alan Cox99f1fe12008-10-13 10:42:00 +0100603 .lookup = ptm_unix98_lookup,
Alan Coxbf970ee2008-10-13 10:42:39 +0100604 .install = pty_unix98_install,
605 .remove = pty_unix98_remove,
Alan Cox3e8e88c2008-04-30 00:54:10 -0700606 .open = pty_open,
607 .close = pty_close,
608 .write = pty_write,
609 .write_room = pty_write_room,
610 .flush_buffer = pty_flush_buffer,
611 .chars_in_buffer = pty_chars_in_buffer,
612 .unthrottle = pty_unthrottle,
613 .set_termios = pty_set_termios,
Alan Coxfeebed62008-10-13 10:41:30 +0100614 .ioctl = pty_unix98_ioctl,
Alan Coxfc6f6232009-01-02 13:43:17 +0000615 .shutdown = pty_unix98_shutdown,
616 .resize = pty_resize
Alan Cox3e8e88c2008-04-30 00:54:10 -0700617};
618
Alan Cox99f1fe12008-10-13 10:42:00 +0100619static const struct tty_operations pty_unix98_ops = {
620 .lookup = pts_unix98_lookup,
Alan Coxbf970ee2008-10-13 10:42:39 +0100621 .install = pty_unix98_install,
622 .remove = pty_unix98_remove,
Alan Cox99f1fe12008-10-13 10:42:00 +0100623 .open = pty_open,
624 .close = pty_close,
625 .write = pty_write,
626 .write_room = pty_write_room,
627 .flush_buffer = pty_flush_buffer,
628 .chars_in_buffer = pty_chars_in_buffer,
629 .unthrottle = pty_unthrottle,
630 .set_termios = pty_set_termios,
Alan Coxbf970ee2008-10-13 10:42:39 +0100631 .shutdown = pty_unix98_shutdown
Alan Cox99f1fe12008-10-13 10:42:00 +0100632};
Alan Coxd81ed102008-10-13 10:41:42 +0100633
634/**
635 * ptmx_open - open a unix 98 pty master
636 * @inode: inode of device file
637 * @filp: file pointer to tty
638 *
639 * Allocate a unix98 pty master device from the ptmx driver.
640 *
641 * Locking: tty_mutex protects the init_dev work. tty->count should
642 * protect the rest.
643 * allocated_ptys_lock handles the list of free pty numbers
644 */
645
646static int __ptmx_open(struct inode *inode, struct file *filp)
647{
648 struct tty_struct *tty;
649 int retval;
650 int index;
651
652 nonseekable_open(inode, filp);
653
654 /* find a device that is not in use. */
Sukadev Bhattiprolu15f1a632008-10-13 10:42:59 +0100655 index = devpts_new_index(inode);
Alan Coxd81ed102008-10-13 10:41:42 +0100656 if (index < 0)
657 return index;
658
659 mutex_lock(&tty_mutex);
Alan Cox73ec06f2008-10-13 10:42:29 +0100660 tty = tty_init_dev(ptm_driver, index, 1);
Alan Coxd81ed102008-10-13 10:41:42 +0100661 mutex_unlock(&tty_mutex);
662
Alan Cox73ec06f2008-10-13 10:42:29 +0100663 if (IS_ERR(tty)) {
664 retval = PTR_ERR(tty);
Alan Coxd81ed102008-10-13 10:41:42 +0100665 goto out;
Alan Cox73ec06f2008-10-13 10:42:29 +0100666 }
Alan Coxd81ed102008-10-13 10:41:42 +0100667
668 set_bit(TTY_PTY_LOCK, &tty->flags); /* LOCK THE SLAVE */
669 filp->private_data = tty;
670 file_move(filp, &tty->tty_files);
671
Sukadev Bhattiprolu15f1a632008-10-13 10:42:59 +0100672 retval = devpts_pty_new(inode, tty->link);
Alan Coxd81ed102008-10-13 10:41:42 +0100673 if (retval)
674 goto out1;
675
676 retval = ptm_driver->ops->open(tty, filp);
677 if (!retval)
678 return 0;
679out1:
680 tty_release_dev(filp);
681 return retval;
682out:
Sukadev Bhattiprolu15f1a632008-10-13 10:42:59 +0100683 devpts_kill_index(inode, index);
Alan Coxd81ed102008-10-13 10:41:42 +0100684 return retval;
685}
686
687static int ptmx_open(struct inode *inode, struct file *filp)
688{
689 int ret;
690
691 lock_kernel();
692 ret = __ptmx_open(inode, filp);
693 unlock_kernel();
694 return ret;
695}
696
697static struct file_operations ptmx_fops;
698
Linus Torvalds1da177e2005-04-16 15:20:36 -0700699static void __init unix98_pty_init(void)
700{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700701 ptm_driver = alloc_tty_driver(NR_UNIX98_PTY_MAX);
702 if (!ptm_driver)
703 panic("Couldn't allocate Unix98 ptm driver");
704 pts_driver = alloc_tty_driver(NR_UNIX98_PTY_MAX);
705 if (!pts_driver)
706 panic("Couldn't allocate Unix98 pts driver");
707
708 ptm_driver->owner = THIS_MODULE;
709 ptm_driver->driver_name = "pty_master";
710 ptm_driver->name = "ptm";
711 ptm_driver->major = UNIX98_PTY_MASTER_MAJOR;
712 ptm_driver->minor_start = 0;
713 ptm_driver->type = TTY_DRIVER_TYPE_PTY;
714 ptm_driver->subtype = PTY_TYPE_MASTER;
715 ptm_driver->init_termios = tty_std_termios;
716 ptm_driver->init_termios.c_iflag = 0;
717 ptm_driver->init_termios.c_oflag = 0;
718 ptm_driver->init_termios.c_cflag = B38400 | CS8 | CREAD;
719 ptm_driver->init_termios.c_lflag = 0;
Alan Cox606d0992006-12-08 02:38:45 -0800720 ptm_driver->init_termios.c_ispeed = 38400;
721 ptm_driver->init_termios.c_ospeed = 38400;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700722 ptm_driver->flags = TTY_DRIVER_RESET_TERMIOS | TTY_DRIVER_REAL_RAW |
Greg Kroah-Hartman331b8312005-06-20 21:15:16 -0700723 TTY_DRIVER_DYNAMIC_DEV | TTY_DRIVER_DEVPTS_MEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700724 ptm_driver->other = pts_driver;
Alan Coxfeebed62008-10-13 10:41:30 +0100725 tty_set_operations(ptm_driver, &ptm_unix98_ops);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700726
727 pts_driver->owner = THIS_MODULE;
728 pts_driver->driver_name = "pty_slave";
729 pts_driver->name = "pts";
730 pts_driver->major = UNIX98_PTY_SLAVE_MAJOR;
731 pts_driver->minor_start = 0;
732 pts_driver->type = TTY_DRIVER_TYPE_PTY;
733 pts_driver->subtype = PTY_TYPE_SLAVE;
734 pts_driver->init_termios = tty_std_termios;
735 pts_driver->init_termios.c_cflag = B38400 | CS8 | CREAD;
Alan Cox606d0992006-12-08 02:38:45 -0800736 pts_driver->init_termios.c_ispeed = 38400;
737 pts_driver->init_termios.c_ospeed = 38400;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700738 pts_driver->flags = TTY_DRIVER_RESET_TERMIOS | TTY_DRIVER_REAL_RAW |
Greg Kroah-Hartman331b8312005-06-20 21:15:16 -0700739 TTY_DRIVER_DYNAMIC_DEV | TTY_DRIVER_DEVPTS_MEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700740 pts_driver->other = ptm_driver;
Alan Cox99f1fe12008-10-13 10:42:00 +0100741 tty_set_operations(pts_driver, &pty_unix98_ops);
Alan Coxfe9cd962008-10-13 10:43:38 +0100742
Linus Torvalds1da177e2005-04-16 15:20:36 -0700743 if (tty_register_driver(ptm_driver))
744 panic("Couldn't register Unix98 ptm driver");
745 if (tty_register_driver(pts_driver))
746 panic("Couldn't register Unix98 pts driver");
747
Alan Coxfe9cd962008-10-13 10:43:38 +0100748 register_sysctl_table(pty_root_table);
Alan Coxd81ed102008-10-13 10:41:42 +0100749
750 /* Now create the /dev/ptmx special device */
751 tty_default_fops(&ptmx_fops);
752 ptmx_fops.open = ptmx_open;
753
754 cdev_init(&ptmx_cdev, &ptmx_fops);
755 if (cdev_add(&ptmx_cdev, MKDEV(TTYAUX_MAJOR, 2), 1) ||
756 register_chrdev_region(MKDEV(TTYAUX_MAJOR, 2), 1, "/dev/ptmx") < 0)
757 panic("Couldn't register /dev/ptmx driver\n");
758 device_create(tty_class, NULL, MKDEV(TTYAUX_MAJOR, 2), NULL, "ptmx");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700759}
Alan Coxd81ed102008-10-13 10:41:42 +0100760
Linus Torvalds1da177e2005-04-16 15:20:36 -0700761#else
762static inline void unix98_pty_init(void) { }
763#endif
764
765static int __init pty_init(void)
766{
767 legacy_pty_init();
768 unix98_pty_init();
769 return 0;
770}
771module_init(pty_init);