blob: de22ea952832c7602813a15b3a0630bfc860c3d0 [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
Linus Torvalds1da177e2005-04-16 15:20:36 -07008 *
Alan Coxfe9cd962008-10-13 10:43:38 +01009 * When reading this code see also fs/devpts. In particular note that the
10 * driver_data field is used by the devpts side as a binding to the devpts
11 * inode.
Linus Torvalds1da177e2005-04-16 15:20:36 -070012 */
13
Alan Coxfe9cd962008-10-13 10:43:38 +010014#include <linux/module.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070015
16#include <linux/errno.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070017#include <linux/interrupt.h>
18#include <linux/tty.h>
19#include <linux/tty_flip.h>
20#include <linux/fcntl.h>
Alexey Dobriyand43c36d2009-10-07 17:09:06 +040021#include <linux/sched.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070022#include <linux/string.h>
23#include <linux/major.h>
24#include <linux/mm.h>
25#include <linux/init.h>
Alexey Dobriyan405f5572009-07-11 22:08:37 +040026#include <linux/smp_lock.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>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090032#include <linux/slab.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070033
Alan Coxfe9cd962008-10-13 10:43:38 +010034#include <asm/system.h>
35
Linus Torvalds1da177e2005-04-16 15:20:36 -070036#ifdef CONFIG_UNIX98_PTYS
Roel Kluinda2bdf92009-01-07 18:09:15 -080037static struct tty_driver *ptm_driver;
Linus Torvalds1da177e2005-04-16 15:20:36 -070038static 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{
Alan Coxd945cb92009-07-07 16:39:41 +010081 tty_wakeup(tty->link);
Linus Torvalds1da177e2005-04-16 15:20:36 -070082 set_bit(TTY_THROTTLED, &tty->flags);
83}
84
Alan Coxd945cb92009-07-07 16:39:41 +010085/**
86 * pty_space - report space left for writing
87 * @to: tty we are writing into
Linus Torvalds1da177e2005-04-16 15:20:36 -070088 *
Alan Coxd945cb92009-07-07 16:39:41 +010089 * The tty buffers allow 64K but we sneak a peak and clip at 8K this
90 * allows a lot of overspill room for echo and other fun messes to
91 * be handled properly
Linus Torvalds1da177e2005-04-16 15:20:36 -070092 */
Alan Coxd945cb92009-07-07 16:39:41 +010093
94static int pty_space(struct tty_struct *to)
95{
96 int n = 8192 - to->buf.memory_used;
97 if (n < 0)
98 return 0;
99 return n;
100}
101
102/**
103 * pty_write - write to a pty
104 * @tty: the tty we write from
105 * @buf: kernel buffer of data
106 * @count: bytes to write
107 *
108 * Our "hardware" write method. Data is coming from the ldisc which
109 * may be in a non sleeping state. We simply throw this at the other
110 * end of the link as if we were an IRQ handler receiving stuff for
111 * the other side of the pty/tty pair.
112 */
113
Linus Torvaldsac89a912009-09-05 13:27:10 -0700114static int pty_write(struct tty_struct *tty, const unsigned char *buf, int c)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700115{
116 struct tty_struct *to = tty->link;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700117
Alan Coxd945cb92009-07-07 16:39:41 +0100118 if (tty->stopped)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700119 return 0;
120
Alan Coxd945cb92009-07-07 16:39:41 +0100121 if (c > 0) {
122 /* Stuff the data into the input queue of the other end */
123 c = tty_insert_flip_string(to, buf, c);
124 /* And shovel */
Linus Torvalds202c4672009-09-18 07:05:58 -0700125 if (c) {
126 tty_flip_buffer_push(to);
127 tty_wakeup(tty);
128 }
Alan Cox762faae2009-06-16 17:01:13 +0100129 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700130 return c;
131}
132
Alan Coxd945cb92009-07-07 16:39:41 +0100133/**
134 * pty_write_room - write space
135 * @tty: tty we are writing from
136 *
137 * Report how many bytes the ldisc can send into the queue for
138 * the other device.
139 */
140
Linus Torvalds1da177e2005-04-16 15:20:36 -0700141static int pty_write_room(struct tty_struct *tty)
142{
Linus Torvalds85dfd812009-08-10 13:21:19 -0700143 if (tty->stopped)
144 return 0;
Alan Coxd945cb92009-07-07 16:39:41 +0100145 return pty_space(tty->link);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700146}
147
Alan Coxd945cb92009-07-07 16:39:41 +0100148/**
149 * pty_chars_in_buffer - characters currently in our tx queue
150 * @tty: our tty
Linus Torvalds1da177e2005-04-16 15:20:36 -0700151 *
Alan Coxd945cb92009-07-07 16:39:41 +0100152 * Report how much we have in the transmit queue. As everything is
153 * instantly at the other end this is easy to implement.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700154 */
Alan Coxd945cb92009-07-07 16:39:41 +0100155
Linus Torvalds1da177e2005-04-16 15:20:36 -0700156static int pty_chars_in_buffer(struct tty_struct *tty)
157{
Alan Coxd945cb92009-07-07 16:39:41 +0100158 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700159}
160
161/* Set the lock flag on a pty */
Alan Coxfe9cd962008-10-13 10:43:38 +0100162static int pty_set_lock(struct tty_struct *tty, int __user *arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700163{
164 int val;
Alan Coxfe9cd962008-10-13 10:43:38 +0100165 if (get_user(val, arg))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700166 return -EFAULT;
167 if (val)
168 set_bit(TTY_PTY_LOCK, &tty->flags);
169 else
170 clear_bit(TTY_PTY_LOCK, &tty->flags);
171 return 0;
172}
173
hyc@symas.com26df6d12010-06-22 10:14:49 -0700174/* Send a signal to the slave */
175static int pty_signal(struct tty_struct *tty, int sig)
176{
177 unsigned long flags;
178 struct pid *pgrp;
179
180 if (tty->link) {
181 spin_lock_irqsave(&tty->link->ctrl_lock, flags);
182 pgrp = get_pid(tty->link->pgrp);
183 spin_unlock_irqrestore(&tty->link->ctrl_lock, flags);
184
185 kill_pgrp(pgrp, sig, 1);
186 put_pid(pgrp);
187 }
188 return 0;
189}
190
Linus Torvalds1da177e2005-04-16 15:20:36 -0700191static void pty_flush_buffer(struct tty_struct *tty)
192{
193 struct tty_struct *to = tty->link;
Alan Cox04f378b2008-04-30 00:53:29 -0700194 unsigned long flags;
Alan Coxfe9cd962008-10-13 10:43:38 +0100195
Linus Torvalds1da177e2005-04-16 15:20:36 -0700196 if (!to)
197 return;
Alan Coxd945cb92009-07-07 16:39:41 +0100198 /* tty_buffer_flush(to); FIXME */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700199 if (to->packet) {
Alan Cox04f378b2008-04-30 00:53:29 -0700200 spin_lock_irqsave(&tty->ctrl_lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700201 tty->ctrl_status |= TIOCPKT_FLUSHWRITE;
202 wake_up_interruptible(&to->read_wait);
Alan Cox04f378b2008-04-30 00:53:29 -0700203 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700204 }
205}
206
Alan Coxfe9cd962008-10-13 10:43:38 +0100207static int pty_open(struct tty_struct *tty, struct file *filp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700208{
209 int retval = -ENODEV;
210
211 if (!tty || !tty->link)
212 goto out;
213
214 retval = -EIO;
215 if (test_bit(TTY_OTHER_CLOSED, &tty->flags))
216 goto out;
217 if (test_bit(TTY_PTY_LOCK, &tty->link->flags))
218 goto out;
219 if (tty->link->count != 1)
220 goto out;
221
222 clear_bit(TTY_OTHER_CLOSED, &tty->link->flags);
223 set_bit(TTY_THROTTLED, &tty->flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700224 retval = 0;
225out:
226 return retval;
227}
228
Alan Coxfe9cd962008-10-13 10:43:38 +0100229static void pty_set_termios(struct tty_struct *tty,
230 struct ktermios *old_termios)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700231{
Alan Coxfe9cd962008-10-13 10:43:38 +0100232 tty->termios->c_cflag &= ~(CSIZE | PARENB);
233 tty->termios->c_cflag |= (CS8 | CREAD);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700234}
235
Alan Coxfc6f6232009-01-02 13:43:17 +0000236/**
237 * pty_do_resize - resize event
238 * @tty: tty being resized
Alan Coxc774bda2009-01-11 19:46:49 +0000239 * @ws: window size being set.
Alan Coxfc6f6232009-01-02 13:43:17 +0000240 *
Daniel Mack3ad2f3f2010-02-03 08:01:28 +0800241 * Update the termios variables and send the necessary signals to
Alan Coxfc6f6232009-01-02 13:43:17 +0000242 * peform a terminal resize correctly
243 */
244
245int pty_resize(struct tty_struct *tty, struct winsize *ws)
246{
247 struct pid *pgrp, *rpgrp;
248 unsigned long flags;
249 struct tty_struct *pty = tty->link;
250
251 /* For a PTY we need to lock the tty side */
252 mutex_lock(&tty->termios_mutex);
253 if (!memcmp(ws, &tty->winsize, sizeof(*ws)))
254 goto done;
255
256 /* Get the PID values and reference them so we can
257 avoid holding the tty ctrl lock while sending signals.
258 We need to lock these individually however. */
259
260 spin_lock_irqsave(&tty->ctrl_lock, flags);
261 pgrp = get_pid(tty->pgrp);
262 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
263
264 spin_lock_irqsave(&pty->ctrl_lock, flags);
265 rpgrp = get_pid(pty->pgrp);
266 spin_unlock_irqrestore(&pty->ctrl_lock, flags);
267
268 if (pgrp)
269 kill_pgrp(pgrp, SIGWINCH, 1);
270 if (rpgrp != pgrp && rpgrp)
271 kill_pgrp(rpgrp, SIGWINCH, 1);
272
273 put_pid(pgrp);
274 put_pid(rpgrp);
275
276 tty->winsize = *ws;
277 pty->winsize = *ws; /* Never used so will go away soon */
278done:
279 mutex_unlock(&tty->termios_mutex);
280 return 0;
281}
282
Linus Torvalds342a5972009-09-30 07:49:40 -0700283/* Traditional BSD devices */
284#ifdef CONFIG_LEGACY_PTYS
285
Alan Coxbf970ee2008-10-13 10:42:39 +0100286static int pty_install(struct tty_driver *driver, struct tty_struct *tty)
287{
288 struct tty_struct *o_tty;
289 int idx = tty->index;
290 int retval;
291
292 o_tty = alloc_tty_struct();
293 if (!o_tty)
294 return -ENOMEM;
295 if (!try_module_get(driver->other->owner)) {
296 /* This cannot in fact currently happen */
297 free_tty_struct(o_tty);
298 return -ENOMEM;
299 }
300 initialize_tty_struct(o_tty, driver->other, idx);
301
302 /* We always use new tty termios data so we can do this
303 the easy way .. */
304 retval = tty_init_termios(tty);
305 if (retval)
306 goto free_mem_out;
307
308 retval = tty_init_termios(o_tty);
309 if (retval) {
310 tty_free_termios(tty);
311 goto free_mem_out;
312 }
Alan Coxfe9cd962008-10-13 10:43:38 +0100313
Alan Coxbf970ee2008-10-13 10:42:39 +0100314 /*
315 * Everything allocated ... set up the o_tty structure.
316 */
317 driver->other->ttys[idx] = o_tty;
318 tty_driver_kref_get(driver->other);
319 if (driver->subtype == PTY_TYPE_MASTER)
320 o_tty->count++;
321 /* Establish the links in both directions */
322 tty->link = o_tty;
323 o_tty->link = tty;
324
325 tty_driver_kref_get(driver);
326 tty->count++;
327 driver->ttys[idx] = tty;
328 return 0;
329free_mem_out:
330 module_put(o_tty->driver->owner);
331 free_tty_struct(o_tty);
332 return -ENOMEM;
333}
334
Linus Torvalds1da177e2005-04-16 15:20:36 -0700335static int pty_bsd_ioctl(struct tty_struct *tty, struct file *file,
336 unsigned int cmd, unsigned long arg)
337{
338 switch (cmd) {
339 case TIOCSPTLCK: /* Set PT Lock (disallow slave open) */
340 return pty_set_lock(tty, (int __user *) arg);
hyc@symas.com26df6d12010-06-22 10:14:49 -0700341 case TIOCSIG: /* Send signal to other side of pty */
342 return pty_signal(tty, (int) arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700343 }
344 return -ENOIOCTLCMD;
345}
346
Kay Sieversdc8c8582007-08-15 12:25:38 +0200347static int legacy_count = CONFIG_LEGACY_PTY_COUNT;
348module_param(legacy_count, int, 0);
349
Linus Torvalds342a5972009-09-30 07:49:40 -0700350/*
351 * The master side of a pty can do TIOCSPTLCK and thus
352 * has pty_bsd_ioctl.
353 */
354static const struct tty_operations master_pty_ops_bsd = {
355 .install = pty_install,
Alan Cox3e8e88c2008-04-30 00:54:10 -0700356 .open = pty_open,
357 .close = pty_close,
358 .write = pty_write,
359 .write_room = pty_write_room,
360 .flush_buffer = pty_flush_buffer,
361 .chars_in_buffer = pty_chars_in_buffer,
362 .unthrottle = pty_unthrottle,
363 .set_termios = pty_set_termios,
364 .ioctl = pty_bsd_ioctl,
Alan Coxfc6f6232009-01-02 13:43:17 +0000365 .resize = pty_resize
Alan Cox3e8e88c2008-04-30 00:54:10 -0700366};
367
Linus Torvalds342a5972009-09-30 07:49:40 -0700368static const struct tty_operations slave_pty_ops_bsd = {
369 .install = pty_install,
370 .open = pty_open,
371 .close = pty_close,
372 .write = pty_write,
373 .write_room = pty_write_room,
374 .flush_buffer = pty_flush_buffer,
375 .chars_in_buffer = pty_chars_in_buffer,
376 .unthrottle = pty_unthrottle,
377 .set_termios = pty_set_termios,
378 .resize = pty_resize
379};
380
Linus Torvalds1da177e2005-04-16 15:20:36 -0700381static void __init legacy_pty_init(void)
382{
Linus Torvalds342a5972009-09-30 07:49:40 -0700383 struct tty_driver *pty_driver, *pty_slave_driver;
384
Kay Sieversdc8c8582007-08-15 12:25:38 +0200385 if (legacy_count <= 0)
386 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700387
Kay Sieversdc8c8582007-08-15 12:25:38 +0200388 pty_driver = alloc_tty_driver(legacy_count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700389 if (!pty_driver)
390 panic("Couldn't allocate pty driver");
391
Kay Sieversdc8c8582007-08-15 12:25:38 +0200392 pty_slave_driver = alloc_tty_driver(legacy_count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700393 if (!pty_slave_driver)
394 panic("Couldn't allocate pty slave driver");
395
396 pty_driver->owner = THIS_MODULE;
397 pty_driver->driver_name = "pty_master";
398 pty_driver->name = "pty";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700399 pty_driver->major = PTY_MASTER_MAJOR;
400 pty_driver->minor_start = 0;
401 pty_driver->type = TTY_DRIVER_TYPE_PTY;
402 pty_driver->subtype = PTY_TYPE_MASTER;
403 pty_driver->init_termios = tty_std_termios;
404 pty_driver->init_termios.c_iflag = 0;
405 pty_driver->init_termios.c_oflag = 0;
406 pty_driver->init_termios.c_cflag = B38400 | CS8 | CREAD;
407 pty_driver->init_termios.c_lflag = 0;
Alan Cox606d0992006-12-08 02:38:45 -0800408 pty_driver->init_termios.c_ispeed = 38400;
409 pty_driver->init_termios.c_ospeed = 38400;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700410 pty_driver->flags = TTY_DRIVER_RESET_TERMIOS | TTY_DRIVER_REAL_RAW;
411 pty_driver->other = pty_slave_driver;
Linus Torvalds342a5972009-09-30 07:49:40 -0700412 tty_set_operations(pty_driver, &master_pty_ops_bsd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700413
414 pty_slave_driver->owner = THIS_MODULE;
415 pty_slave_driver->driver_name = "pty_slave";
416 pty_slave_driver->name = "ttyp";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700417 pty_slave_driver->major = PTY_SLAVE_MAJOR;
418 pty_slave_driver->minor_start = 0;
419 pty_slave_driver->type = TTY_DRIVER_TYPE_PTY;
420 pty_slave_driver->subtype = PTY_TYPE_SLAVE;
421 pty_slave_driver->init_termios = tty_std_termios;
422 pty_slave_driver->init_termios.c_cflag = B38400 | CS8 | CREAD;
Alan Cox606d0992006-12-08 02:38:45 -0800423 pty_slave_driver->init_termios.c_ispeed = 38400;
424 pty_slave_driver->init_termios.c_ospeed = 38400;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700425 pty_slave_driver->flags = TTY_DRIVER_RESET_TERMIOS |
426 TTY_DRIVER_REAL_RAW;
427 pty_slave_driver->other = pty_driver;
Linus Torvalds342a5972009-09-30 07:49:40 -0700428 tty_set_operations(pty_slave_driver, &slave_pty_ops_bsd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700429
430 if (tty_register_driver(pty_driver))
431 panic("Couldn't register pty driver");
432 if (tty_register_driver(pty_slave_driver))
433 panic("Couldn't register pty slave driver");
434}
435#else
436static inline void legacy_pty_init(void) { }
437#endif
438
439/* Unix98 devices */
440#ifdef CONFIG_UNIX98_PTYS
441/*
442 * sysctl support for setting limits on the number of Unix98 ptys allocated.
443 * Otherwise one can eat up all kernel memory by opening /dev/ptmx repeatedly.
444 */
445int pty_limit = NR_UNIX98_PTY_DEFAULT;
Alan Coxfe9cd962008-10-13 10:43:38 +0100446static int pty_limit_min;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700447static int pty_limit_max = NR_UNIX98_PTY_MAX;
Alan Coxfe9cd962008-10-13 10:43:38 +0100448static int pty_count;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700449
Alan Coxd81ed102008-10-13 10:41:42 +0100450static struct cdev ptmx_cdev;
451
Eric W. Biederman35834ca2007-10-18 03:05:31 -0700452static struct ctl_table pty_table[] = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700453 {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700454 .procname = "max",
455 .maxlen = sizeof(int),
456 .mode = 0644,
457 .data = &pty_limit,
Eric W. Biederman6d456112009-11-16 03:11:48 -0800458 .proc_handler = proc_dointvec_minmax,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700459 .extra1 = &pty_limit_min,
460 .extra2 = &pty_limit_max,
461 }, {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700462 .procname = "nr",
463 .maxlen = sizeof(int),
464 .mode = 0444,
Alan Coxbf970ee2008-10-13 10:42:39 +0100465 .data = &pty_count,
Eric W. Biederman6d456112009-11-16 03:11:48 -0800466 .proc_handler = proc_dointvec,
Eric W. Biederman894d2492009-11-05 14:34:02 -0800467 },
468 {}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700469};
470
Eric W. Biederman35834ca2007-10-18 03:05:31 -0700471static struct ctl_table pty_kern_table[] = {
472 {
Eric W. Biederman35834ca2007-10-18 03:05:31 -0700473 .procname = "pty",
474 .mode = 0555,
475 .child = pty_table,
476 },
477 {}
478};
479
480static struct ctl_table pty_root_table[] = {
481 {
Eric W. Biederman35834ca2007-10-18 03:05:31 -0700482 .procname = "kernel",
483 .mode = 0555,
484 .child = pty_kern_table,
485 },
486 {}
487};
488
489
Linus Torvalds1da177e2005-04-16 15:20:36 -0700490static int pty_unix98_ioctl(struct tty_struct *tty, struct file *file,
491 unsigned int cmd, unsigned long arg)
492{
493 switch (cmd) {
494 case TIOCSPTLCK: /* Set PT Lock (disallow slave open) */
495 return pty_set_lock(tty, (int __user *)arg);
496 case TIOCGPTN: /* Get PT Number */
497 return put_user(tty->index, (unsigned int __user *)arg);
hyc@symas.com26df6d12010-06-22 10:14:49 -0700498 case TIOCSIG: /* Send signal to other side of pty */
499 return pty_signal(tty, (int) arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700500 }
501
502 return -ENOIOCTLCMD;
503}
504
Alan Cox99f1fe12008-10-13 10:42:00 +0100505/**
506 * ptm_unix98_lookup - find a pty master
507 * @driver: ptm driver
508 * @idx: tty index
509 *
510 * Look up a pty master device. Called under the tty_mutex for now.
511 * This provides our locking.
512 */
513
Sukadev Bhattiprolu15f1a632008-10-13 10:42:59 +0100514static struct tty_struct *ptm_unix98_lookup(struct tty_driver *driver,
515 struct inode *ptm_inode, int idx)
Alan Cox99f1fe12008-10-13 10:42:00 +0100516{
Sukadev Bhattiprolu15f1a632008-10-13 10:42:59 +0100517 struct tty_struct *tty = devpts_get_tty(ptm_inode, idx);
Alan Cox99f1fe12008-10-13 10:42:00 +0100518 if (tty)
519 tty = tty->link;
520 return tty;
521}
522
523/**
524 * pts_unix98_lookup - find a pty slave
525 * @driver: pts driver
526 * @idx: tty index
527 *
528 * Look up a pty master device. Called under the tty_mutex for now.
529 * This provides our locking.
530 */
531
Sukadev Bhattiprolu15f1a632008-10-13 10:42:59 +0100532static struct tty_struct *pts_unix98_lookup(struct tty_driver *driver,
533 struct inode *pts_inode, int idx)
Alan Cox99f1fe12008-10-13 10:42:00 +0100534{
Sukadev Bhattiprolu15f1a632008-10-13 10:42:59 +0100535 struct tty_struct *tty = devpts_get_tty(pts_inode, idx);
Alan Cox99f1fe12008-10-13 10:42:00 +0100536 /* Master must be open before slave */
537 if (!tty)
538 return ERR_PTR(-EIO);
539 return tty;
540}
541
Alan Coxbf970ee2008-10-13 10:42:39 +0100542static void pty_unix98_shutdown(struct tty_struct *tty)
Alan Coxfeebed62008-10-13 10:41:30 +0100543{
544 /* We have our own method as we don't use the tty index */
545 kfree(tty->termios);
Alan Coxfeebed62008-10-13 10:41:30 +0100546}
547
Alan Cox8b0a88d2008-10-13 10:42:19 +0100548/* We have no need to install and remove our tty objects as devpts does all
549 the work for us */
550
Alan Coxbf970ee2008-10-13 10:42:39 +0100551static int pty_unix98_install(struct tty_driver *driver, struct tty_struct *tty)
Alan Cox8b0a88d2008-10-13 10:42:19 +0100552{
Alan Coxbf970ee2008-10-13 10:42:39 +0100553 struct tty_struct *o_tty;
554 int idx = tty->index;
555
556 o_tty = alloc_tty_struct();
557 if (!o_tty)
558 return -ENOMEM;
559 if (!try_module_get(driver->other->owner)) {
560 /* This cannot in fact currently happen */
561 free_tty_struct(o_tty);
562 return -ENOMEM;
563 }
564 initialize_tty_struct(o_tty, driver->other, idx);
565
Alan Cox8dff04e2008-10-13 10:43:58 +0100566 tty->termios = kzalloc(sizeof(struct ktermios[2]), GFP_KERNEL);
Alan Coxbf970ee2008-10-13 10:42:39 +0100567 if (tty->termios == NULL)
568 goto free_mem_out;
569 *tty->termios = driver->init_termios;
Alan Cox8dff04e2008-10-13 10:43:58 +0100570 tty->termios_locked = tty->termios + 1;
571
572 o_tty->termios = kzalloc(sizeof(struct ktermios[2]), GFP_KERNEL);
Alan Coxbf970ee2008-10-13 10:42:39 +0100573 if (o_tty->termios == NULL)
574 goto free_mem_out;
575 *o_tty->termios = driver->other->init_termios;
Alan Cox8dff04e2008-10-13 10:43:58 +0100576 o_tty->termios_locked = o_tty->termios + 1;
Alan Coxbf970ee2008-10-13 10:42:39 +0100577
578 tty_driver_kref_get(driver->other);
579 if (driver->subtype == PTY_TYPE_MASTER)
580 o_tty->count++;
581 /* Establish the links in both directions */
582 tty->link = o_tty;
583 o_tty->link = tty;
584 /*
585 * All structures have been allocated, so now we install them.
586 * Failures after this point use release_tty to clean up, so
587 * there's no need to null out the local pointers.
588 */
589 tty_driver_kref_get(driver);
590 tty->count++;
591 pty_count++;
Alan Cox8b0a88d2008-10-13 10:42:19 +0100592 return 0;
Alan Coxbf970ee2008-10-13 10:42:39 +0100593free_mem_out:
Alan Cox8dff04e2008-10-13 10:43:58 +0100594 kfree(o_tty->termios);
Alan Coxbf970ee2008-10-13 10:42:39 +0100595 module_put(o_tty->driver->owner);
596 free_tty_struct(o_tty);
Alan Cox8dff04e2008-10-13 10:43:58 +0100597 kfree(tty->termios);
Alan Coxbf970ee2008-10-13 10:42:39 +0100598 return -ENOMEM;
Alan Cox8b0a88d2008-10-13 10:42:19 +0100599}
600
Alan Coxbf970ee2008-10-13 10:42:39 +0100601static void pty_unix98_remove(struct tty_driver *driver, struct tty_struct *tty)
Alan Cox8b0a88d2008-10-13 10:42:19 +0100602{
Alan Coxbf970ee2008-10-13 10:42:39 +0100603 pty_count--;
Alan Cox8b0a88d2008-10-13 10:42:19 +0100604}
605
Alan Coxfeebed62008-10-13 10:41:30 +0100606static const struct tty_operations ptm_unix98_ops = {
Alan Cox99f1fe12008-10-13 10:42:00 +0100607 .lookup = ptm_unix98_lookup,
Alan Coxbf970ee2008-10-13 10:42:39 +0100608 .install = pty_unix98_install,
609 .remove = pty_unix98_remove,
Alan Cox3e8e88c2008-04-30 00:54:10 -0700610 .open = pty_open,
611 .close = pty_close,
612 .write = pty_write,
613 .write_room = pty_write_room,
614 .flush_buffer = pty_flush_buffer,
615 .chars_in_buffer = pty_chars_in_buffer,
616 .unthrottle = pty_unthrottle,
617 .set_termios = pty_set_termios,
Alan Coxfeebed62008-10-13 10:41:30 +0100618 .ioctl = pty_unix98_ioctl,
Alan Coxfc6f6232009-01-02 13:43:17 +0000619 .shutdown = pty_unix98_shutdown,
620 .resize = pty_resize
Alan Cox3e8e88c2008-04-30 00:54:10 -0700621};
622
Alan Cox99f1fe12008-10-13 10:42:00 +0100623static const struct tty_operations pty_unix98_ops = {
624 .lookup = pts_unix98_lookup,
Alan Coxbf970ee2008-10-13 10:42:39 +0100625 .install = pty_unix98_install,
626 .remove = pty_unix98_remove,
Alan Cox99f1fe12008-10-13 10:42:00 +0100627 .open = pty_open,
628 .close = pty_close,
629 .write = pty_write,
630 .write_room = pty_write_room,
631 .flush_buffer = pty_flush_buffer,
632 .chars_in_buffer = pty_chars_in_buffer,
633 .unthrottle = pty_unthrottle,
634 .set_termios = pty_set_termios,
Alan Coxbf970ee2008-10-13 10:42:39 +0100635 .shutdown = pty_unix98_shutdown
Alan Cox99f1fe12008-10-13 10:42:00 +0100636};
Alan Coxd81ed102008-10-13 10:41:42 +0100637
638/**
639 * ptmx_open - open a unix 98 pty master
640 * @inode: inode of device file
641 * @filp: file pointer to tty
642 *
643 * Allocate a unix98 pty master device from the ptmx driver.
644 *
645 * Locking: tty_mutex protects the init_dev work. tty->count should
646 * protect the rest.
647 * allocated_ptys_lock handles the list of free pty numbers
648 */
649
Arnd Bergmann64ba3dc2010-06-01 22:53:02 +0200650static int ptmx_open(struct inode *inode, struct file *filp)
Alan Coxd81ed102008-10-13 10:41:42 +0100651{
652 struct tty_struct *tty;
653 int retval;
654 int index;
655
656 nonseekable_open(inode, filp);
657
658 /* find a device that is not in use. */
Arnd Bergmann64ba3dc2010-06-01 22:53:02 +0200659 tty_lock();
Sukadev Bhattiprolu15f1a632008-10-13 10:42:59 +0100660 index = devpts_new_index(inode);
Arnd Bergmann64ba3dc2010-06-01 22:53:02 +0200661 tty_unlock();
Alan Coxd81ed102008-10-13 10:41:42 +0100662 if (index < 0)
663 return index;
664
665 mutex_lock(&tty_mutex);
Arnd Bergmann64ba3dc2010-06-01 22:53:02 +0200666 tty_lock();
Alan Cox73ec06f2008-10-13 10:42:29 +0100667 tty = tty_init_dev(ptm_driver, index, 1);
Alan Coxd81ed102008-10-13 10:41:42 +0100668 mutex_unlock(&tty_mutex);
669
Alan Cox73ec06f2008-10-13 10:42:29 +0100670 if (IS_ERR(tty)) {
671 retval = PTR_ERR(tty);
Alan Coxd81ed102008-10-13 10:41:42 +0100672 goto out;
Alan Cox73ec06f2008-10-13 10:42:29 +0100673 }
Alan Coxd81ed102008-10-13 10:41:42 +0100674
675 set_bit(TTY_PTY_LOCK, &tty->flags); /* LOCK THE SLAVE */
676 filp->private_data = tty;
677 file_move(filp, &tty->tty_files);
678
Sukadev Bhattiprolu15f1a632008-10-13 10:42:59 +0100679 retval = devpts_pty_new(inode, tty->link);
Alan Coxd81ed102008-10-13 10:41:42 +0100680 if (retval)
681 goto out1;
682
683 retval = ptm_driver->ops->open(tty, filp);
Arnd Bergmann64ba3dc2010-06-01 22:53:02 +0200684 if (retval)
685 goto out2;
Alan Coxd81ed102008-10-13 10:41:42 +0100686out1:
Arnd Bergmann64ba3dc2010-06-01 22:53:02 +0200687 tty_unlock();
688 return retval;
689out2:
690 tty_unlock();
Alan Coxeeb89d92009-11-30 13:18:29 +0000691 tty_release(inode, filp);
Alan Coxd81ed102008-10-13 10:41:42 +0100692 return retval;
693out:
Sukadev Bhattiprolu15f1a632008-10-13 10:42:59 +0100694 devpts_kill_index(inode, index);
Arnd Bergmannec79d602010-06-01 22:53:01 +0200695 tty_unlock();
Arnd Bergmann64ba3dc2010-06-01 22:53:02 +0200696 return retval;
Alan Coxd81ed102008-10-13 10:41:42 +0100697}
698
699static struct file_operations ptmx_fops;
700
Linus Torvalds1da177e2005-04-16 15:20:36 -0700701static void __init unix98_pty_init(void)
702{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700703 ptm_driver = alloc_tty_driver(NR_UNIX98_PTY_MAX);
704 if (!ptm_driver)
705 panic("Couldn't allocate Unix98 ptm driver");
706 pts_driver = alloc_tty_driver(NR_UNIX98_PTY_MAX);
707 if (!pts_driver)
708 panic("Couldn't allocate Unix98 pts driver");
709
710 ptm_driver->owner = THIS_MODULE;
711 ptm_driver->driver_name = "pty_master";
712 ptm_driver->name = "ptm";
713 ptm_driver->major = UNIX98_PTY_MASTER_MAJOR;
714 ptm_driver->minor_start = 0;
715 ptm_driver->type = TTY_DRIVER_TYPE_PTY;
716 ptm_driver->subtype = PTY_TYPE_MASTER;
717 ptm_driver->init_termios = tty_std_termios;
718 ptm_driver->init_termios.c_iflag = 0;
719 ptm_driver->init_termios.c_oflag = 0;
720 ptm_driver->init_termios.c_cflag = B38400 | CS8 | CREAD;
721 ptm_driver->init_termios.c_lflag = 0;
Alan Cox606d0992006-12-08 02:38:45 -0800722 ptm_driver->init_termios.c_ispeed = 38400;
723 ptm_driver->init_termios.c_ospeed = 38400;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700724 ptm_driver->flags = TTY_DRIVER_RESET_TERMIOS | TTY_DRIVER_REAL_RAW |
Greg Kroah-Hartman331b8312005-06-20 21:15:16 -0700725 TTY_DRIVER_DYNAMIC_DEV | TTY_DRIVER_DEVPTS_MEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700726 ptm_driver->other = pts_driver;
Alan Coxfeebed62008-10-13 10:41:30 +0100727 tty_set_operations(ptm_driver, &ptm_unix98_ops);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700728
729 pts_driver->owner = THIS_MODULE;
730 pts_driver->driver_name = "pty_slave";
731 pts_driver->name = "pts";
732 pts_driver->major = UNIX98_PTY_SLAVE_MAJOR;
733 pts_driver->minor_start = 0;
734 pts_driver->type = TTY_DRIVER_TYPE_PTY;
735 pts_driver->subtype = PTY_TYPE_SLAVE;
736 pts_driver->init_termios = tty_std_termios;
737 pts_driver->init_termios.c_cflag = B38400 | CS8 | CREAD;
Alan Cox606d0992006-12-08 02:38:45 -0800738 pts_driver->init_termios.c_ispeed = 38400;
739 pts_driver->init_termios.c_ospeed = 38400;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700740 pts_driver->flags = TTY_DRIVER_RESET_TERMIOS | TTY_DRIVER_REAL_RAW |
Greg Kroah-Hartman331b8312005-06-20 21:15:16 -0700741 TTY_DRIVER_DYNAMIC_DEV | TTY_DRIVER_DEVPTS_MEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700742 pts_driver->other = ptm_driver;
Alan Cox99f1fe12008-10-13 10:42:00 +0100743 tty_set_operations(pts_driver, &pty_unix98_ops);
Alan Coxfe9cd962008-10-13 10:43:38 +0100744
Linus Torvalds1da177e2005-04-16 15:20:36 -0700745 if (tty_register_driver(ptm_driver))
746 panic("Couldn't register Unix98 ptm driver");
747 if (tty_register_driver(pts_driver))
748 panic("Couldn't register Unix98 pts driver");
749
Alan Coxfe9cd962008-10-13 10:43:38 +0100750 register_sysctl_table(pty_root_table);
Alan Coxd81ed102008-10-13 10:41:42 +0100751
752 /* Now create the /dev/ptmx special device */
753 tty_default_fops(&ptmx_fops);
754 ptmx_fops.open = ptmx_open;
755
756 cdev_init(&ptmx_cdev, &ptmx_fops);
757 if (cdev_add(&ptmx_cdev, MKDEV(TTYAUX_MAJOR, 2), 1) ||
758 register_chrdev_region(MKDEV(TTYAUX_MAJOR, 2), 1, "/dev/ptmx") < 0)
759 panic("Couldn't register /dev/ptmx driver\n");
760 device_create(tty_class, NULL, MKDEV(TTYAUX_MAJOR, 2), NULL, "ptmx");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700761}
Alan Coxd81ed102008-10-13 10:41:42 +0100762
Linus Torvalds1da177e2005-04-16 15:20:36 -0700763#else
764static inline void unix98_pty_init(void) { }
765#endif
766
767static int __init pty_init(void)
768{
769 legacy_pty_init();
770 unix98_pty_init();
771 return 0;
772}
773module_init(pty_init);