blob: e809e9d4683c6d82197cbd569c12b1375df8be99 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07002 * 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
Linus Torvalds1da177e2005-04-16 15:20:36 -07006 *
Alan Coxfe9cd962008-10-13 10:43:38 +01007 * When reading this code see also fs/devpts. In particular note that the
8 * driver_data field is used by the devpts side as a binding to the devpts
9 * inode.
Linus Torvalds1da177e2005-04-16 15:20:36 -070010 */
11
Alan Coxfe9cd962008-10-13 10:43:38 +010012#include <linux/module.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070013
14#include <linux/errno.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070015#include <linux/interrupt.h>
16#include <linux/tty.h>
17#include <linux/tty_flip.h>
18#include <linux/fcntl.h>
Alexey Dobriyand43c36d2009-10-07 17:09:06 +040019#include <linux/sched.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070020#include <linux/string.h>
21#include <linux/major.h>
22#include <linux/mm.h>
23#include <linux/init.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070024#include <linux/sysctl.h>
Alan Coxd81ed102008-10-13 10:41:42 +010025#include <linux/device.h>
Alan Coxfe9cd962008-10-13 10:43:38 +010026#include <linux/uaccess.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070027#include <linux/bitops.h>
28#include <linux/devpts_fs.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090029#include <linux/slab.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070030
Alan Coxfe9cd962008-10-13 10:43:38 +010031#include <asm/system.h>
32
Linus Torvalds1da177e2005-04-16 15:20:36 -070033#ifdef CONFIG_UNIX98_PTYS
Roel Kluinda2bdf92009-01-07 18:09:15 -080034static struct tty_driver *ptm_driver;
Linus Torvalds1da177e2005-04-16 15:20:36 -070035static struct tty_driver *pts_driver;
36#endif
37
Alan Coxfe9cd962008-10-13 10:43:38 +010038static void pty_close(struct tty_struct *tty, struct file *filp)
Linus Torvalds1da177e2005-04-16 15:20:36 -070039{
Alan Coxfe9cd962008-10-13 10:43:38 +010040 BUG_ON(!tty);
41 if (tty->driver->subtype == PTY_TYPE_MASTER)
42 WARN_ON(tty->count > 1);
43 else {
Linus Torvalds1da177e2005-04-16 15:20:36 -070044 if (tty->count > 2)
45 return;
46 }
47 wake_up_interruptible(&tty->read_wait);
48 wake_up_interruptible(&tty->write_wait);
49 tty->packet = 0;
50 if (!tty->link)
51 return;
52 tty->link->packet = 0;
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);
58#ifdef CONFIG_UNIX98_PTYS
59 if (tty->driver == ptm_driver)
Sukadev Bhattiprolu15f1a632008-10-13 10:42:59 +010060 devpts_pty_kill(tty->link);
Linus Torvalds1da177e2005-04-16 15:20:36 -070061#endif
Arnd Bergmann11dbf202010-06-18 14:58:07 +020062 tty_unlock();
63 tty_vhangup(tty->link);
64 tty_lock();
Linus Torvalds1da177e2005-04-16 15:20:36 -070065 }
66}
67
68/*
69 * The unthrottle routine is called by the line discipline to signal
70 * that it can receive more characters. For PTY's, the TTY_THROTTLED
71 * flag is always set, to force the line discipline to always call the
Alan Coxfe9cd962008-10-13 10:43:38 +010072 * unthrottle routine when there are fewer than TTY_THRESHOLD_UNTHROTTLE
Linus Torvalds1da177e2005-04-16 15:20:36 -070073 * characters in the queue. This is necessary since each time this
74 * happens, we need to wake up any sleeping processes that could be
75 * (1) trying to send data to the pty, or (2) waiting in wait_until_sent()
76 * for the pty buffer to be drained.
77 */
Alan Coxfe9cd962008-10-13 10:43:38 +010078static void pty_unthrottle(struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -070079{
Alan Coxd945cb92009-07-07 16:39:41 +010080 tty_wakeup(tty->link);
Linus Torvalds1da177e2005-04-16 15:20:36 -070081 set_bit(TTY_THROTTLED, &tty->flags);
82}
83
Alan Coxd945cb92009-07-07 16:39:41 +010084/**
85 * pty_space - report space left for writing
86 * @to: tty we are writing into
Linus Torvalds1da177e2005-04-16 15:20:36 -070087 *
Alan Coxd945cb92009-07-07 16:39:41 +010088 * The tty buffers allow 64K but we sneak a peak and clip at 8K this
89 * allows a lot of overspill room for echo and other fun messes to
90 * be handled properly
Linus Torvalds1da177e2005-04-16 15:20:36 -070091 */
Alan Coxd945cb92009-07-07 16:39:41 +010092
93static int pty_space(struct tty_struct *to)
94{
95 int n = 8192 - to->buf.memory_used;
96 if (n < 0)
97 return 0;
98 return n;
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
106 *
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.
111 */
112
Linus Torvaldsac89a912009-09-05 13:27:10 -0700113static int pty_write(struct tty_struct *tty, const unsigned char *buf, int c)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700114{
115 struct tty_struct *to = tty->link;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700116
Alan Coxd945cb92009-07-07 16:39:41 +0100117 if (tty->stopped)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700118 return 0;
119
Alan Coxd945cb92009-07-07 16:39:41 +0100120 if (c > 0) {
121 /* Stuff the data into the input queue of the other end */
122 c = tty_insert_flip_string(to, buf, c);
123 /* And shovel */
Linus Torvalds202c4672009-09-18 07:05:58 -0700124 if (c) {
125 tty_flip_buffer_push(to);
126 tty_wakeup(tty);
127 }
Alan Cox762faae2009-06-16 17:01:13 +0100128 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700129 return c;
130}
131
Alan Coxd945cb92009-07-07 16:39:41 +0100132/**
133 * pty_write_room - write space
134 * @tty: tty we are writing from
135 *
136 * Report how many bytes the ldisc can send into the queue for
137 * the other device.
138 */
139
Linus Torvalds1da177e2005-04-16 15:20:36 -0700140static int pty_write_room(struct tty_struct *tty)
141{
Linus Torvalds85dfd812009-08-10 13:21:19 -0700142 if (tty->stopped)
143 return 0;
Alan Coxd945cb92009-07-07 16:39:41 +0100144 return pty_space(tty->link);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700145}
146
Alan Coxd945cb92009-07-07 16:39:41 +0100147/**
148 * pty_chars_in_buffer - characters currently in our tx queue
149 * @tty: our tty
Linus Torvalds1da177e2005-04-16 15:20:36 -0700150 *
Alan Coxd945cb92009-07-07 16:39:41 +0100151 * Report how much we have in the transmit queue. As everything is
152 * instantly at the other end this is easy to implement.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700153 */
Alan Coxd945cb92009-07-07 16:39:41 +0100154
Linus Torvalds1da177e2005-04-16 15:20:36 -0700155static int pty_chars_in_buffer(struct tty_struct *tty)
156{
Alan Coxd945cb92009-07-07 16:39:41 +0100157 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700158}
159
160/* Set the lock flag on a pty */
Alan Coxfe9cd962008-10-13 10:43:38 +0100161static int pty_set_lock(struct tty_struct *tty, int __user *arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700162{
163 int val;
Alan Coxfe9cd962008-10-13 10:43:38 +0100164 if (get_user(val, arg))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700165 return -EFAULT;
166 if (val)
167 set_bit(TTY_PTY_LOCK, &tty->flags);
168 else
169 clear_bit(TTY_PTY_LOCK, &tty->flags);
170 return 0;
171}
172
hyc@symas.com26df6d12010-06-22 10:14:49 -0700173/* Send a signal to the slave */
174static int pty_signal(struct tty_struct *tty, int sig)
175{
176 unsigned long flags;
177 struct pid *pgrp;
178
179 if (tty->link) {
180 spin_lock_irqsave(&tty->link->ctrl_lock, flags);
181 pgrp = get_pid(tty->link->pgrp);
182 spin_unlock_irqrestore(&tty->link->ctrl_lock, flags);
183
184 kill_pgrp(pgrp, sig, 1);
185 put_pid(pgrp);
186 }
187 return 0;
188}
189
Linus Torvalds1da177e2005-04-16 15:20:36 -0700190static void pty_flush_buffer(struct tty_struct *tty)
191{
192 struct tty_struct *to = tty->link;
Alan Cox04f378b2008-04-30 00:53:29 -0700193 unsigned long flags;
Alan Coxfe9cd962008-10-13 10:43:38 +0100194
Linus Torvalds1da177e2005-04-16 15:20:36 -0700195 if (!to)
196 return;
Alan Coxd945cb92009-07-07 16:39:41 +0100197 /* tty_buffer_flush(to); FIXME */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700198 if (to->packet) {
Alan Cox04f378b2008-04-30 00:53:29 -0700199 spin_lock_irqsave(&tty->ctrl_lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700200 tty->ctrl_status |= TIOCPKT_FLUSHWRITE;
201 wake_up_interruptible(&to->read_wait);
Alan Cox04f378b2008-04-30 00:53:29 -0700202 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700203 }
204}
205
Alan Coxfe9cd962008-10-13 10:43:38 +0100206static int pty_open(struct tty_struct *tty, struct file *filp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700207{
208 int retval = -ENODEV;
209
210 if (!tty || !tty->link)
211 goto out;
212
213 retval = -EIO;
214 if (test_bit(TTY_OTHER_CLOSED, &tty->flags))
215 goto out;
216 if (test_bit(TTY_PTY_LOCK, &tty->link->flags))
217 goto out;
218 if (tty->link->count != 1)
219 goto out;
220
221 clear_bit(TTY_OTHER_CLOSED, &tty->link->flags);
222 set_bit(TTY_THROTTLED, &tty->flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700223 retval = 0;
224out:
225 return retval;
226}
227
Alan Coxfe9cd962008-10-13 10:43:38 +0100228static void pty_set_termios(struct tty_struct *tty,
229 struct ktermios *old_termios)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700230{
Alan Coxfe9cd962008-10-13 10:43:38 +0100231 tty->termios->c_cflag &= ~(CSIZE | PARENB);
232 tty->termios->c_cflag |= (CS8 | CREAD);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700233}
234
Alan Coxfc6f6232009-01-02 13:43:17 +0000235/**
236 * pty_do_resize - resize event
237 * @tty: tty being resized
Alan Coxc774bda2009-01-11 19:46:49 +0000238 * @ws: window size being set.
Alan Coxfc6f6232009-01-02 13:43:17 +0000239 *
Daniel Mack3ad2f3f2010-02-03 08:01:28 +0800240 * Update the termios variables and send the necessary signals to
Alan Coxfc6f6232009-01-02 13:43:17 +0000241 * 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
Linus Torvalds342a5972009-09-30 07:49:40 -0700282/* Traditional BSD devices */
283#ifdef CONFIG_LEGACY_PTYS
284
Alan Coxbf970ee2008-10-13 10:42:39 +0100285static int pty_install(struct tty_driver *driver, struct tty_struct *tty)
286{
287 struct tty_struct *o_tty;
288 int idx = tty->index;
289 int retval;
290
291 o_tty = alloc_tty_struct();
292 if (!o_tty)
293 return -ENOMEM;
294 if (!try_module_get(driver->other->owner)) {
295 /* This cannot in fact currently happen */
Jiri Slaby8a1b8d72011-03-23 10:48:33 +0100296 retval = -ENOMEM;
297 goto err_free_tty;
Alan Coxbf970ee2008-10-13 10:42:39 +0100298 }
299 initialize_tty_struct(o_tty, driver->other, idx);
300
301 /* We always use new tty termios data so we can do this
302 the easy way .. */
303 retval = tty_init_termios(tty);
304 if (retval)
Jiri Slabya9dccdd2011-03-23 10:48:36 +0100305 goto err_deinit_tty;
Alan Coxbf970ee2008-10-13 10:42:39 +0100306
307 retval = tty_init_termios(o_tty);
Jiri Slaby8a1b8d72011-03-23 10:48:33 +0100308 if (retval)
309 goto err_free_termios;
Alan Coxfe9cd962008-10-13 10:43:38 +0100310
Alan Coxbf970ee2008-10-13 10:42:39 +0100311 /*
312 * Everything allocated ... set up the o_tty structure.
313 */
314 driver->other->ttys[idx] = o_tty;
315 tty_driver_kref_get(driver->other);
316 if (driver->subtype == PTY_TYPE_MASTER)
317 o_tty->count++;
318 /* Establish the links in both directions */
319 tty->link = o_tty;
320 o_tty->link = tty;
321
322 tty_driver_kref_get(driver);
323 tty->count++;
324 driver->ttys[idx] = tty;
325 return 0;
Jiri Slaby8a1b8d72011-03-23 10:48:33 +0100326err_free_termios:
327 tty_free_termios(tty);
Jiri Slabya9dccdd2011-03-23 10:48:36 +0100328err_deinit_tty:
329 deinitialize_tty_struct(o_tty);
Alan Coxbf970ee2008-10-13 10:42:39 +0100330 module_put(o_tty->driver->owner);
Jiri Slaby8a1b8d72011-03-23 10:48:33 +0100331err_free_tty:
Alan Coxbf970ee2008-10-13 10:42:39 +0100332 free_tty_struct(o_tty);
Jiri Slaby8a1b8d72011-03-23 10:48:33 +0100333 return retval;
Alan Coxbf970ee2008-10-13 10:42:39 +0100334}
335
Alan Cox6caa76b2011-02-14 16:27:22 +0000336static int pty_bsd_ioctl(struct tty_struct *tty,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700337 unsigned int cmd, unsigned long arg)
338{
339 switch (cmd) {
340 case TIOCSPTLCK: /* Set PT Lock (disallow slave open) */
341 return pty_set_lock(tty, (int __user *) arg);
hyc@symas.com26df6d12010-06-22 10:14:49 -0700342 case TIOCSIG: /* Send signal to other side of pty */
343 return pty_signal(tty, (int) arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700344 }
345 return -ENOIOCTLCMD;
346}
347
Kay Sieversdc8c8582007-08-15 12:25:38 +0200348static int legacy_count = CONFIG_LEGACY_PTY_COUNT;
349module_param(legacy_count, int, 0);
350
Linus Torvalds342a5972009-09-30 07:49:40 -0700351/*
352 * The master side of a pty can do TIOCSPTLCK and thus
353 * has pty_bsd_ioctl.
354 */
355static const struct tty_operations master_pty_ops_bsd = {
356 .install = pty_install,
Alan Cox3e8e88c2008-04-30 00:54:10 -0700357 .open = pty_open,
358 .close = pty_close,
359 .write = pty_write,
360 .write_room = pty_write_room,
361 .flush_buffer = pty_flush_buffer,
362 .chars_in_buffer = pty_chars_in_buffer,
363 .unthrottle = pty_unthrottle,
364 .set_termios = pty_set_termios,
365 .ioctl = pty_bsd_ioctl,
Alan Coxfc6f6232009-01-02 13:43:17 +0000366 .resize = pty_resize
Alan Cox3e8e88c2008-04-30 00:54:10 -0700367};
368
Linus Torvalds342a5972009-09-30 07:49:40 -0700369static const struct tty_operations slave_pty_ops_bsd = {
370 .install = pty_install,
371 .open = pty_open,
372 .close = pty_close,
373 .write = pty_write,
374 .write_room = pty_write_room,
375 .flush_buffer = pty_flush_buffer,
376 .chars_in_buffer = pty_chars_in_buffer,
377 .unthrottle = pty_unthrottle,
378 .set_termios = pty_set_termios,
379 .resize = pty_resize
380};
381
Linus Torvalds1da177e2005-04-16 15:20:36 -0700382static void __init legacy_pty_init(void)
383{
Linus Torvalds342a5972009-09-30 07:49:40 -0700384 struct tty_driver *pty_driver, *pty_slave_driver;
385
Kay Sieversdc8c8582007-08-15 12:25:38 +0200386 if (legacy_count <= 0)
387 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700388
Kay Sieversdc8c8582007-08-15 12:25:38 +0200389 pty_driver = alloc_tty_driver(legacy_count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700390 if (!pty_driver)
391 panic("Couldn't allocate pty driver");
392
Kay Sieversdc8c8582007-08-15 12:25:38 +0200393 pty_slave_driver = alloc_tty_driver(legacy_count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700394 if (!pty_slave_driver)
395 panic("Couldn't allocate pty slave driver");
396
397 pty_driver->owner = THIS_MODULE;
398 pty_driver->driver_name = "pty_master";
399 pty_driver->name = "pty";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700400 pty_driver->major = PTY_MASTER_MAJOR;
401 pty_driver->minor_start = 0;
402 pty_driver->type = TTY_DRIVER_TYPE_PTY;
403 pty_driver->subtype = PTY_TYPE_MASTER;
404 pty_driver->init_termios = tty_std_termios;
405 pty_driver->init_termios.c_iflag = 0;
406 pty_driver->init_termios.c_oflag = 0;
407 pty_driver->init_termios.c_cflag = B38400 | CS8 | CREAD;
408 pty_driver->init_termios.c_lflag = 0;
Alan Cox606d0992006-12-08 02:38:45 -0800409 pty_driver->init_termios.c_ispeed = 38400;
410 pty_driver->init_termios.c_ospeed = 38400;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700411 pty_driver->flags = TTY_DRIVER_RESET_TERMIOS | TTY_DRIVER_REAL_RAW;
412 pty_driver->other = pty_slave_driver;
Linus Torvalds342a5972009-09-30 07:49:40 -0700413 tty_set_operations(pty_driver, &master_pty_ops_bsd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700414
415 pty_slave_driver->owner = THIS_MODULE;
416 pty_slave_driver->driver_name = "pty_slave";
417 pty_slave_driver->name = "ttyp";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700418 pty_slave_driver->major = PTY_SLAVE_MAJOR;
419 pty_slave_driver->minor_start = 0;
420 pty_slave_driver->type = TTY_DRIVER_TYPE_PTY;
421 pty_slave_driver->subtype = PTY_TYPE_SLAVE;
422 pty_slave_driver->init_termios = tty_std_termios;
423 pty_slave_driver->init_termios.c_cflag = B38400 | CS8 | CREAD;
Alan Cox606d0992006-12-08 02:38:45 -0800424 pty_slave_driver->init_termios.c_ispeed = 38400;
425 pty_slave_driver->init_termios.c_ospeed = 38400;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700426 pty_slave_driver->flags = TTY_DRIVER_RESET_TERMIOS |
427 TTY_DRIVER_REAL_RAW;
428 pty_slave_driver->other = pty_driver;
Linus Torvalds342a5972009-09-30 07:49:40 -0700429 tty_set_operations(pty_slave_driver, &slave_pty_ops_bsd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700430
431 if (tty_register_driver(pty_driver))
432 panic("Couldn't register pty driver");
433 if (tty_register_driver(pty_slave_driver))
434 panic("Couldn't register pty slave driver");
435}
436#else
437static inline void legacy_pty_init(void) { }
438#endif
439
440/* Unix98 devices */
441#ifdef CONFIG_UNIX98_PTYS
442/*
443 * sysctl support for setting limits on the number of Unix98 ptys allocated.
444 * Otherwise one can eat up all kernel memory by opening /dev/ptmx repeatedly.
445 */
446int pty_limit = NR_UNIX98_PTY_DEFAULT;
Alan Coxfe9cd962008-10-13 10:43:38 +0100447static int pty_limit_min;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700448static int pty_limit_max = NR_UNIX98_PTY_MAX;
Jiri Slaby24d406a2011-08-10 14:59:28 +0200449static int tty_count;
Alan Coxfe9cd962008-10-13 10:43:38 +0100450static int pty_count;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700451
Jiri Slaby24d406a2011-08-10 14:59:28 +0200452static inline void pty_inc_count(void)
453{
454 pty_count = (++tty_count) / 2;
455}
456
457static inline void pty_dec_count(void)
458{
459 pty_count = (--tty_count) / 2;
460}
461
Alan Coxd81ed102008-10-13 10:41:42 +0100462static struct cdev ptmx_cdev;
463
Eric W. Biederman35834ca2007-10-18 03:05:31 -0700464static struct ctl_table pty_table[] = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700465 {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700466 .procname = "max",
467 .maxlen = sizeof(int),
468 .mode = 0644,
469 .data = &pty_limit,
Eric W. Biederman6d456112009-11-16 03:11:48 -0800470 .proc_handler = proc_dointvec_minmax,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700471 .extra1 = &pty_limit_min,
472 .extra2 = &pty_limit_max,
473 }, {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700474 .procname = "nr",
475 .maxlen = sizeof(int),
476 .mode = 0444,
Alan Coxbf970ee2008-10-13 10:42:39 +0100477 .data = &pty_count,
Eric W. Biederman6d456112009-11-16 03:11:48 -0800478 .proc_handler = proc_dointvec,
Eric W. Biederman894d2492009-11-05 14:34:02 -0800479 },
480 {}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700481};
482
Eric W. Biederman35834ca2007-10-18 03:05:31 -0700483static struct ctl_table pty_kern_table[] = {
484 {
Eric W. Biederman35834ca2007-10-18 03:05:31 -0700485 .procname = "pty",
486 .mode = 0555,
487 .child = pty_table,
488 },
489 {}
490};
491
492static struct ctl_table pty_root_table[] = {
493 {
Eric W. Biederman35834ca2007-10-18 03:05:31 -0700494 .procname = "kernel",
495 .mode = 0555,
496 .child = pty_kern_table,
497 },
498 {}
499};
500
501
Alan Cox6caa76b2011-02-14 16:27:22 +0000502static int pty_unix98_ioctl(struct tty_struct *tty,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700503 unsigned int cmd, unsigned long arg)
504{
505 switch (cmd) {
506 case TIOCSPTLCK: /* Set PT Lock (disallow slave open) */
507 return pty_set_lock(tty, (int __user *)arg);
508 case TIOCGPTN: /* Get PT Number */
509 return put_user(tty->index, (unsigned int __user *)arg);
hyc@symas.com26df6d12010-06-22 10:14:49 -0700510 case TIOCSIG: /* Send signal to other side of pty */
511 return pty_signal(tty, (int) arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700512 }
513
514 return -ENOIOCTLCMD;
515}
516
Alan Cox99f1fe12008-10-13 10:42:00 +0100517/**
518 * ptm_unix98_lookup - find a pty master
519 * @driver: ptm driver
520 * @idx: tty index
521 *
522 * Look up a pty master device. Called under the tty_mutex for now.
523 * This provides our locking.
524 */
525
Sukadev Bhattiprolu15f1a632008-10-13 10:42:59 +0100526static struct tty_struct *ptm_unix98_lookup(struct tty_driver *driver,
527 struct inode *ptm_inode, int idx)
Alan Cox99f1fe12008-10-13 10:42:00 +0100528{
Sukadev Bhattiprolu15f1a632008-10-13 10:42:59 +0100529 struct tty_struct *tty = devpts_get_tty(ptm_inode, idx);
Alan Cox99f1fe12008-10-13 10:42:00 +0100530 if (tty)
531 tty = tty->link;
532 return tty;
533}
534
535/**
536 * pts_unix98_lookup - find a pty slave
537 * @driver: pts driver
538 * @idx: tty index
539 *
540 * Look up a pty master device. Called under the tty_mutex for now.
541 * This provides our locking.
542 */
543
Sukadev Bhattiprolu15f1a632008-10-13 10:42:59 +0100544static struct tty_struct *pts_unix98_lookup(struct tty_driver *driver,
545 struct inode *pts_inode, int idx)
Alan Cox99f1fe12008-10-13 10:42:00 +0100546{
Sukadev Bhattiprolu15f1a632008-10-13 10:42:59 +0100547 struct tty_struct *tty = devpts_get_tty(pts_inode, idx);
Alan Cox99f1fe12008-10-13 10:42:00 +0100548 /* Master must be open before slave */
549 if (!tty)
550 return ERR_PTR(-EIO);
551 return tty;
552}
553
Alan Coxbf970ee2008-10-13 10:42:39 +0100554static void pty_unix98_shutdown(struct tty_struct *tty)
Alan Coxfeebed62008-10-13 10:41:30 +0100555{
Jiri Slaby24d406a2011-08-10 14:59:28 +0200556 tty_driver_remove_tty(tty->driver, tty);
Alan Coxfeebed62008-10-13 10:41:30 +0100557 /* We have our own method as we don't use the tty index */
558 kfree(tty->termios);
Alan Coxfeebed62008-10-13 10:41:30 +0100559}
560
Alan Cox8b0a88d2008-10-13 10:42:19 +0100561/* We have no need to install and remove our tty objects as devpts does all
562 the work for us */
563
Alan Coxbf970ee2008-10-13 10:42:39 +0100564static int pty_unix98_install(struct tty_driver *driver, struct tty_struct *tty)
Alan Cox8b0a88d2008-10-13 10:42:19 +0100565{
Alan Coxbf970ee2008-10-13 10:42:39 +0100566 struct tty_struct *o_tty;
567 int idx = tty->index;
568
569 o_tty = alloc_tty_struct();
570 if (!o_tty)
571 return -ENOMEM;
572 if (!try_module_get(driver->other->owner)) {
573 /* This cannot in fact currently happen */
Jiri Slabyc18d77a2011-03-23 10:48:34 +0100574 goto err_free_tty;
Alan Coxbf970ee2008-10-13 10:42:39 +0100575 }
576 initialize_tty_struct(o_tty, driver->other, idx);
577
Alan Cox8dff04e2008-10-13 10:43:58 +0100578 tty->termios = kzalloc(sizeof(struct ktermios[2]), GFP_KERNEL);
Alan Coxbf970ee2008-10-13 10:42:39 +0100579 if (tty->termios == NULL)
Jiri Slabyc18d77a2011-03-23 10:48:34 +0100580 goto err_free_mem;
Alan Coxbf970ee2008-10-13 10:42:39 +0100581 *tty->termios = driver->init_termios;
Alan Cox8dff04e2008-10-13 10:43:58 +0100582 tty->termios_locked = tty->termios + 1;
583
584 o_tty->termios = kzalloc(sizeof(struct ktermios[2]), GFP_KERNEL);
Alan Coxbf970ee2008-10-13 10:42:39 +0100585 if (o_tty->termios == NULL)
Jiri Slabyc18d77a2011-03-23 10:48:34 +0100586 goto err_free_mem;
Alan Coxbf970ee2008-10-13 10:42:39 +0100587 *o_tty->termios = driver->other->init_termios;
Alan Cox8dff04e2008-10-13 10:43:58 +0100588 o_tty->termios_locked = o_tty->termios + 1;
Alan Coxbf970ee2008-10-13 10:42:39 +0100589
590 tty_driver_kref_get(driver->other);
591 if (driver->subtype == PTY_TYPE_MASTER)
592 o_tty->count++;
593 /* Establish the links in both directions */
594 tty->link = o_tty;
595 o_tty->link = tty;
596 /*
597 * All structures have been allocated, so now we install them.
598 * Failures after this point use release_tty to clean up, so
599 * there's no need to null out the local pointers.
600 */
601 tty_driver_kref_get(driver);
602 tty->count++;
Jiri Slaby24d406a2011-08-10 14:59:28 +0200603 pty_inc_count(); /* tty */
604 pty_inc_count(); /* tty->link */
Alan Cox8b0a88d2008-10-13 10:42:19 +0100605 return 0;
Jiri Slabyc18d77a2011-03-23 10:48:34 +0100606err_free_mem:
Jiri Slabya9dccdd2011-03-23 10:48:36 +0100607 deinitialize_tty_struct(o_tty);
Alan Cox8dff04e2008-10-13 10:43:58 +0100608 kfree(o_tty->termios);
Alan Cox8dff04e2008-10-13 10:43:58 +0100609 kfree(tty->termios);
Jiri Slabyc18d77a2011-03-23 10:48:34 +0100610 module_put(o_tty->driver->owner);
611err_free_tty:
612 free_tty_struct(o_tty);
Alan Coxbf970ee2008-10-13 10:42:39 +0100613 return -ENOMEM;
Alan Cox8b0a88d2008-10-13 10:42:19 +0100614}
615
Alan Coxbf970ee2008-10-13 10:42:39 +0100616static void pty_unix98_remove(struct tty_driver *driver, struct tty_struct *tty)
Alan Cox8b0a88d2008-10-13 10:42:19 +0100617{
Jiri Slaby24d406a2011-08-10 14:59:28 +0200618 pty_dec_count();
Alan Cox8b0a88d2008-10-13 10:42:19 +0100619}
620
Alan Coxfeebed62008-10-13 10:41:30 +0100621static const struct tty_operations ptm_unix98_ops = {
Alan Cox99f1fe12008-10-13 10:42:00 +0100622 .lookup = ptm_unix98_lookup,
Alan Coxbf970ee2008-10-13 10:42:39 +0100623 .install = pty_unix98_install,
624 .remove = pty_unix98_remove,
Alan Cox3e8e88c2008-04-30 00:54:10 -0700625 .open = pty_open,
626 .close = pty_close,
627 .write = pty_write,
628 .write_room = pty_write_room,
629 .flush_buffer = pty_flush_buffer,
630 .chars_in_buffer = pty_chars_in_buffer,
631 .unthrottle = pty_unthrottle,
632 .set_termios = pty_set_termios,
Alan Coxfeebed62008-10-13 10:41:30 +0100633 .ioctl = pty_unix98_ioctl,
Alan Coxfc6f6232009-01-02 13:43:17 +0000634 .shutdown = pty_unix98_shutdown,
635 .resize = pty_resize
Alan Cox3e8e88c2008-04-30 00:54:10 -0700636};
637
Alan Cox99f1fe12008-10-13 10:42:00 +0100638static const struct tty_operations pty_unix98_ops = {
639 .lookup = pts_unix98_lookup,
Alan Coxbf970ee2008-10-13 10:42:39 +0100640 .install = pty_unix98_install,
641 .remove = pty_unix98_remove,
Alan Cox99f1fe12008-10-13 10:42:00 +0100642 .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,
Alan Coxbf970ee2008-10-13 10:42:39 +0100650 .shutdown = pty_unix98_shutdown
Alan Cox99f1fe12008-10-13 10:42:00 +0100651};
Alan Coxd81ed102008-10-13 10:41:42 +0100652
653/**
654 * ptmx_open - open a unix 98 pty master
655 * @inode: inode of device file
656 * @filp: file pointer to tty
657 *
658 * Allocate a unix98 pty master device from the ptmx driver.
659 *
660 * Locking: tty_mutex protects the init_dev work. tty->count should
661 * protect the rest.
662 * allocated_ptys_lock handles the list of free pty numbers
663 */
664
Arnd Bergmann64ba3dc2010-06-01 22:53:02 +0200665static int ptmx_open(struct inode *inode, struct file *filp)
Alan Coxd81ed102008-10-13 10:41:42 +0100666{
667 struct tty_struct *tty;
668 int retval;
669 int index;
670
671 nonseekable_open(inode, filp);
672
673 /* find a device that is not in use. */
Arnd Bergmann64ba3dc2010-06-01 22:53:02 +0200674 tty_lock();
Sukadev Bhattiprolu15f1a632008-10-13 10:42:59 +0100675 index = devpts_new_index(inode);
Arnd Bergmann64ba3dc2010-06-01 22:53:02 +0200676 tty_unlock();
Alan Coxd81ed102008-10-13 10:41:42 +0100677 if (index < 0)
678 return index;
679
680 mutex_lock(&tty_mutex);
Arnd Bergmann64ba3dc2010-06-01 22:53:02 +0200681 tty_lock();
Alan Cox73ec06f2008-10-13 10:42:29 +0100682 tty = tty_init_dev(ptm_driver, index, 1);
Alan Coxd81ed102008-10-13 10:41:42 +0100683 mutex_unlock(&tty_mutex);
684
Alan Cox73ec06f2008-10-13 10:42:29 +0100685 if (IS_ERR(tty)) {
686 retval = PTR_ERR(tty);
Alan Coxd81ed102008-10-13 10:41:42 +0100687 goto out;
Alan Cox73ec06f2008-10-13 10:42:29 +0100688 }
Alan Coxd81ed102008-10-13 10:41:42 +0100689
690 set_bit(TTY_PTY_LOCK, &tty->flags); /* LOCK THE SLAVE */
Nick Pigginee2ffa02010-08-18 04:37:35 +1000691
Pekka Enbergf573bd12010-08-24 07:48:34 +0300692 retval = tty_add_file(tty, filp);
693 if (retval)
694 goto out;
Alan Coxd81ed102008-10-13 10:41:42 +0100695
Sukadev Bhattiprolu15f1a632008-10-13 10:42:59 +0100696 retval = devpts_pty_new(inode, tty->link);
Alan Coxd81ed102008-10-13 10:41:42 +0100697 if (retval)
698 goto out1;
699
700 retval = ptm_driver->ops->open(tty, filp);
Arnd Bergmann64ba3dc2010-06-01 22:53:02 +0200701 if (retval)
702 goto out2;
Alan Coxd81ed102008-10-13 10:41:42 +0100703out1:
Arnd Bergmann64ba3dc2010-06-01 22:53:02 +0200704 tty_unlock();
705 return retval;
706out2:
707 tty_unlock();
Alan Coxeeb89d92009-11-30 13:18:29 +0000708 tty_release(inode, filp);
Alan Coxd81ed102008-10-13 10:41:42 +0100709 return retval;
710out:
Sukadev Bhattiprolu15f1a632008-10-13 10:42:59 +0100711 devpts_kill_index(inode, index);
Arnd Bergmannec79d602010-06-01 22:53:01 +0200712 tty_unlock();
Arnd Bergmann64ba3dc2010-06-01 22:53:02 +0200713 return retval;
Alan Coxd81ed102008-10-13 10:41:42 +0100714}
715
716static struct file_operations ptmx_fops;
717
Linus Torvalds1da177e2005-04-16 15:20:36 -0700718static void __init unix98_pty_init(void)
719{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700720 ptm_driver = alloc_tty_driver(NR_UNIX98_PTY_MAX);
721 if (!ptm_driver)
722 panic("Couldn't allocate Unix98 ptm driver");
723 pts_driver = alloc_tty_driver(NR_UNIX98_PTY_MAX);
724 if (!pts_driver)
725 panic("Couldn't allocate Unix98 pts driver");
726
727 ptm_driver->owner = THIS_MODULE;
728 ptm_driver->driver_name = "pty_master";
729 ptm_driver->name = "ptm";
730 ptm_driver->major = UNIX98_PTY_MASTER_MAJOR;
731 ptm_driver->minor_start = 0;
732 ptm_driver->type = TTY_DRIVER_TYPE_PTY;
733 ptm_driver->subtype = PTY_TYPE_MASTER;
734 ptm_driver->init_termios = tty_std_termios;
735 ptm_driver->init_termios.c_iflag = 0;
736 ptm_driver->init_termios.c_oflag = 0;
737 ptm_driver->init_termios.c_cflag = B38400 | CS8 | CREAD;
738 ptm_driver->init_termios.c_lflag = 0;
Alan Cox606d0992006-12-08 02:38:45 -0800739 ptm_driver->init_termios.c_ispeed = 38400;
740 ptm_driver->init_termios.c_ospeed = 38400;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700741 ptm_driver->flags = TTY_DRIVER_RESET_TERMIOS | TTY_DRIVER_REAL_RAW |
Greg Kroah-Hartman331b8312005-06-20 21:15:16 -0700742 TTY_DRIVER_DYNAMIC_DEV | TTY_DRIVER_DEVPTS_MEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700743 ptm_driver->other = pts_driver;
Alan Coxfeebed62008-10-13 10:41:30 +0100744 tty_set_operations(ptm_driver, &ptm_unix98_ops);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700745
746 pts_driver->owner = THIS_MODULE;
747 pts_driver->driver_name = "pty_slave";
748 pts_driver->name = "pts";
749 pts_driver->major = UNIX98_PTY_SLAVE_MAJOR;
750 pts_driver->minor_start = 0;
751 pts_driver->type = TTY_DRIVER_TYPE_PTY;
752 pts_driver->subtype = PTY_TYPE_SLAVE;
753 pts_driver->init_termios = tty_std_termios;
754 pts_driver->init_termios.c_cflag = B38400 | CS8 | CREAD;
Alan Cox606d0992006-12-08 02:38:45 -0800755 pts_driver->init_termios.c_ispeed = 38400;
756 pts_driver->init_termios.c_ospeed = 38400;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700757 pts_driver->flags = TTY_DRIVER_RESET_TERMIOS | TTY_DRIVER_REAL_RAW |
Greg Kroah-Hartman331b8312005-06-20 21:15:16 -0700758 TTY_DRIVER_DYNAMIC_DEV | TTY_DRIVER_DEVPTS_MEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700759 pts_driver->other = ptm_driver;
Alan Cox99f1fe12008-10-13 10:42:00 +0100760 tty_set_operations(pts_driver, &pty_unix98_ops);
Alan Coxfe9cd962008-10-13 10:43:38 +0100761
Linus Torvalds1da177e2005-04-16 15:20:36 -0700762 if (tty_register_driver(ptm_driver))
763 panic("Couldn't register Unix98 ptm driver");
764 if (tty_register_driver(pts_driver))
765 panic("Couldn't register Unix98 pts driver");
766
Alan Coxfe9cd962008-10-13 10:43:38 +0100767 register_sysctl_table(pty_root_table);
Alan Coxd81ed102008-10-13 10:41:42 +0100768
769 /* Now create the /dev/ptmx special device */
770 tty_default_fops(&ptmx_fops);
771 ptmx_fops.open = ptmx_open;
772
773 cdev_init(&ptmx_cdev, &ptmx_fops);
774 if (cdev_add(&ptmx_cdev, MKDEV(TTYAUX_MAJOR, 2), 1) ||
775 register_chrdev_region(MKDEV(TTYAUX_MAJOR, 2), 1, "/dev/ptmx") < 0)
776 panic("Couldn't register /dev/ptmx driver\n");
777 device_create(tty_class, NULL, MKDEV(TTYAUX_MAJOR, 2), NULL, "ptmx");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700778}
Alan Coxd81ed102008-10-13 10:41:42 +0100779
Linus Torvalds1da177e2005-04-16 15:20:36 -0700780#else
781static inline void unix98_pty_init(void) { }
782#endif
783
784static int __init pty_init(void)
785{
786 legacy_pty_init();
787 unix98_pty_init();
788 return 0;
789}
790module_init(pty_init);