blob: df3c64272d21561485dbd0feb1a838f88e79f7f3 [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 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07007 */
8
Alan Coxfe9cd962008-10-13 10:43:38 +01009#include <linux/module.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070010
11#include <linux/errno.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070012#include <linux/interrupt.h>
13#include <linux/tty.h>
14#include <linux/tty_flip.h>
15#include <linux/fcntl.h>
Alexey Dobriyand43c36d2009-10-07 17:09:06 +040016#include <linux/sched.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070017#include <linux/string.h>
18#include <linux/major.h>
19#include <linux/mm.h>
20#include <linux/init.h>
Alan Coxd81ed102008-10-13 10:41:42 +010021#include <linux/device.h>
Alan Coxfe9cd962008-10-13 10:43:38 +010022#include <linux/uaccess.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070023#include <linux/bitops.h>
24#include <linux/devpts_fs.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090025#include <linux/slab.h>
Alan Coxd739e652012-05-03 22:22:09 +010026#include <linux/mutex.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070027
Alan Coxfe9cd962008-10-13 10:43:38 +010028
Linus Torvalds1da177e2005-04-16 15:20:36 -070029#ifdef CONFIG_UNIX98_PTYS
Roel Kluinda2bdf92009-01-07 18:09:15 -080030static struct tty_driver *ptm_driver;
Linus Torvalds1da177e2005-04-16 15:20:36 -070031static struct tty_driver *pts_driver;
Alan Coxd739e652012-05-03 22:22:09 +010032static DEFINE_MUTEX(devpts_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -070033#endif
34
Alan Coxfe9cd962008-10-13 10:43:38 +010035static void pty_close(struct tty_struct *tty, struct file *filp)
Linus Torvalds1da177e2005-04-16 15:20:36 -070036{
Alan Coxfe9cd962008-10-13 10:43:38 +010037 BUG_ON(!tty);
38 if (tty->driver->subtype == PTY_TYPE_MASTER)
39 WARN_ON(tty->count > 1);
40 else {
Linus Torvalds1da177e2005-04-16 15:20:36 -070041 if (tty->count > 2)
42 return;
43 }
44 wake_up_interruptible(&tty->read_wait);
45 wake_up_interruptible(&tty->write_wait);
46 tty->packet = 0;
Alan Cox89c8d912012-08-08 16:30:13 +010047 /* Review - krefs on tty_link ?? */
Linus Torvalds1da177e2005-04-16 15:20:36 -070048 if (!tty->link)
49 return;
50 tty->link->packet = 0;
51 set_bit(TTY_OTHER_CLOSED, &tty->link->flags);
52 wake_up_interruptible(&tty->link->read_wait);
53 wake_up_interruptible(&tty->link->write_wait);
54 if (tty->driver->subtype == PTY_TYPE_MASTER) {
55 set_bit(TTY_OTHER_CLOSED, &tty->flags);
Greg Kroah-Hartmance1000d2012-02-24 13:56:36 -080056#ifdef CONFIG_UNIX98_PTYS
Alan Coxd739e652012-05-03 22:22:09 +010057 if (tty->driver == ptm_driver) {
58 mutex_lock(&devpts_mutex);
Jiri Slabyf11afb62012-10-18 22:26:29 +020059 devpts_pty_kill(tty->link->driver_data);
Alan Coxd739e652012-05-03 22:22:09 +010060 mutex_unlock(&devpts_mutex);
61 }
Greg Kroah-Hartmance1000d2012-02-24 13:56:36 -080062#endif
Alan Cox89c8d912012-08-08 16:30:13 +010063 tty_unlock(tty);
Arnd Bergmann11dbf202010-06-18 14:58:07 +020064 tty_vhangup(tty->link);
Alan Cox89c8d912012-08-08 16:30:13 +010065 tty_lock(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -070066 }
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{
Jiri Slabyecbbfd42012-10-18 22:26:47 +020096 int n = 8192 - to->port->buf.memory_used;
Alan Coxd945cb92009-07-07 16:39:41 +010097 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
Cyrill Gorcunov06026d92012-10-24 23:43:20 +0400174/* Set the packet mode on a pty */
175static int pty_set_pktmode(struct tty_struct *tty, int __user *arg)
176{
177 unsigned long flags;
178 int pktmode;
179
180 if (get_user(pktmode, arg))
181 return -EFAULT;
182
183 spin_lock_irqsave(&tty->ctrl_lock, flags);
184 if (pktmode) {
185 if (!tty->packet) {
186 tty->packet = 1;
187 tty->link->ctrl_status = 0;
188 }
189 } else
190 tty->packet = 0;
191 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
192
193 return 0;
194}
195
hyc@symas.com26df6d12010-06-22 10:14:49 -0700196/* Send a signal to the slave */
197static int pty_signal(struct tty_struct *tty, int sig)
198{
199 unsigned long flags;
200 struct pid *pgrp;
201
202 if (tty->link) {
203 spin_lock_irqsave(&tty->link->ctrl_lock, flags);
204 pgrp = get_pid(tty->link->pgrp);
205 spin_unlock_irqrestore(&tty->link->ctrl_lock, flags);
206
207 kill_pgrp(pgrp, sig, 1);
208 put_pid(pgrp);
209 }
210 return 0;
211}
212
Linus Torvalds1da177e2005-04-16 15:20:36 -0700213static void pty_flush_buffer(struct tty_struct *tty)
214{
215 struct tty_struct *to = tty->link;
Alan Cox04f378b2008-04-30 00:53:29 -0700216 unsigned long flags;
Alan Coxfe9cd962008-10-13 10:43:38 +0100217
Linus Torvalds1da177e2005-04-16 15:20:36 -0700218 if (!to)
219 return;
Alan Coxd945cb92009-07-07 16:39:41 +0100220 /* tty_buffer_flush(to); FIXME */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700221 if (to->packet) {
Alan Cox04f378b2008-04-30 00:53:29 -0700222 spin_lock_irqsave(&tty->ctrl_lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700223 tty->ctrl_status |= TIOCPKT_FLUSHWRITE;
224 wake_up_interruptible(&to->read_wait);
Alan Cox04f378b2008-04-30 00:53:29 -0700225 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700226 }
227}
228
Alan Coxfe9cd962008-10-13 10:43:38 +0100229static int pty_open(struct tty_struct *tty, struct file *filp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700230{
231 int retval = -ENODEV;
232
233 if (!tty || !tty->link)
234 goto out;
235
236 retval = -EIO;
237 if (test_bit(TTY_OTHER_CLOSED, &tty->flags))
238 goto out;
239 if (test_bit(TTY_PTY_LOCK, &tty->link->flags))
240 goto out;
241 if (tty->link->count != 1)
242 goto out;
243
244 clear_bit(TTY_OTHER_CLOSED, &tty->link->flags);
245 set_bit(TTY_THROTTLED, &tty->flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700246 retval = 0;
247out:
248 return retval;
249}
250
Alan Coxfe9cd962008-10-13 10:43:38 +0100251static void pty_set_termios(struct tty_struct *tty,
252 struct ktermios *old_termios)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700253{
Alan Coxadc8d742012-07-14 15:31:47 +0100254 tty->termios.c_cflag &= ~(CSIZE | PARENB);
255 tty->termios.c_cflag |= (CS8 | CREAD);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700256}
257
Alan Coxfc6f6232009-01-02 13:43:17 +0000258/**
259 * pty_do_resize - resize event
260 * @tty: tty being resized
Alan Coxc774bda2009-01-11 19:46:49 +0000261 * @ws: window size being set.
Alan Coxfc6f6232009-01-02 13:43:17 +0000262 *
Daniel Mack3ad2f3f2010-02-03 08:01:28 +0800263 * Update the termios variables and send the necessary signals to
Alan Coxfc6f6232009-01-02 13:43:17 +0000264 * peform a terminal resize correctly
265 */
266
267int pty_resize(struct tty_struct *tty, struct winsize *ws)
268{
269 struct pid *pgrp, *rpgrp;
270 unsigned long flags;
271 struct tty_struct *pty = tty->link;
272
273 /* For a PTY we need to lock the tty side */
274 mutex_lock(&tty->termios_mutex);
275 if (!memcmp(ws, &tty->winsize, sizeof(*ws)))
276 goto done;
277
278 /* Get the PID values and reference them so we can
279 avoid holding the tty ctrl lock while sending signals.
280 We need to lock these individually however. */
281
282 spin_lock_irqsave(&tty->ctrl_lock, flags);
283 pgrp = get_pid(tty->pgrp);
284 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
285
286 spin_lock_irqsave(&pty->ctrl_lock, flags);
287 rpgrp = get_pid(pty->pgrp);
288 spin_unlock_irqrestore(&pty->ctrl_lock, flags);
289
290 if (pgrp)
291 kill_pgrp(pgrp, SIGWINCH, 1);
292 if (rpgrp != pgrp && rpgrp)
293 kill_pgrp(rpgrp, SIGWINCH, 1);
294
295 put_pid(pgrp);
296 put_pid(rpgrp);
297
298 tty->winsize = *ws;
299 pty->winsize = *ws; /* Never used so will go away soon */
300done:
301 mutex_unlock(&tty->termios_mutex);
302 return 0;
303}
304
Alan Coxd1552552012-07-27 18:02:54 +0100305/**
306 * pty_common_install - set up the pty pair
307 * @driver: the pty driver
308 * @tty: the tty being instantiated
309 * @bool: legacy, true if this is BSD style
310 *
311 * Perform the initial set up for the tty/pty pair. Called from the
312 * tty layer when the port is first opened.
313 *
314 * Locking: the caller must hold the tty_mutex
315 */
Jiri Slaby5d249bc2012-06-04 13:35:29 +0200316static int pty_common_install(struct tty_driver *driver, struct tty_struct *tty,
317 bool legacy)
Alan Coxbf970ee2008-10-13 10:42:39 +0100318{
319 struct tty_struct *o_tty;
Jiri Slabyd03702a2012-06-04 13:35:30 +0200320 struct tty_port *ports[2];
Alan Coxbf970ee2008-10-13 10:42:39 +0100321 int idx = tty->index;
Jiri Slaby5d249bc2012-06-04 13:35:29 +0200322 int retval = -ENOMEM;
Alan Coxbf970ee2008-10-13 10:42:39 +0100323
324 o_tty = alloc_tty_struct();
Jiri Slaby6f9ea7a2012-08-07 21:47:26 +0200325 if (!o_tty)
326 goto err;
Jiri Slabyd03702a2012-06-04 13:35:30 +0200327 ports[0] = kmalloc(sizeof **ports, GFP_KERNEL);
328 ports[1] = kmalloc(sizeof **ports, GFP_KERNEL);
Jiri Slaby6f9ea7a2012-08-07 21:47:26 +0200329 if (!ports[0] || !ports[1])
Jiri Slabyd03702a2012-06-04 13:35:30 +0200330 goto err_free_tty;
Alan Coxbf970ee2008-10-13 10:42:39 +0100331 if (!try_module_get(driver->other->owner)) {
332 /* This cannot in fact currently happen */
Jiri Slaby8a1b8d72011-03-23 10:48:33 +0100333 goto err_free_tty;
Alan Coxbf970ee2008-10-13 10:42:39 +0100334 }
335 initialize_tty_struct(o_tty, driver->other, idx);
336
Jiri Slaby5d249bc2012-06-04 13:35:29 +0200337 if (legacy) {
338 /* We always use new tty termios data so we can do this
339 the easy way .. */
340 retval = tty_init_termios(tty);
341 if (retval)
342 goto err_deinit_tty;
Alan Coxbf970ee2008-10-13 10:42:39 +0100343
Jiri Slaby5d249bc2012-06-04 13:35:29 +0200344 retval = tty_init_termios(o_tty);
345 if (retval)
346 goto err_free_termios;
347
348 driver->other->ttys[idx] = o_tty;
349 driver->ttys[idx] = tty;
350 } else {
Alan Coxadc8d742012-07-14 15:31:47 +0100351 memset(&tty->termios_locked, 0, sizeof(tty->termios_locked));
352 tty->termios = driver->init_termios;
353 memset(&o_tty->termios_locked, 0, sizeof(tty->termios_locked));
354 o_tty->termios = driver->other->init_termios;
Jiri Slaby5d249bc2012-06-04 13:35:29 +0200355 }
Alan Coxfe9cd962008-10-13 10:43:38 +0100356
Alan Coxbf970ee2008-10-13 10:42:39 +0100357 /*
358 * Everything allocated ... set up the o_tty structure.
359 */
Alan Coxbf970ee2008-10-13 10:42:39 +0100360 tty_driver_kref_get(driver->other);
361 if (driver->subtype == PTY_TYPE_MASTER)
362 o_tty->count++;
363 /* Establish the links in both directions */
364 tty->link = o_tty;
365 o_tty->link = tty;
Jiri Slabyd03702a2012-06-04 13:35:30 +0200366 tty_port_init(ports[0]);
367 tty_port_init(ports[1]);
368 o_tty->port = ports[0];
369 tty->port = ports[1];
Jiri Slaby967fab62012-10-18 22:26:46 +0200370 o_tty->port->itty = o_tty;
Alan Coxbf970ee2008-10-13 10:42:39 +0100371
372 tty_driver_kref_get(driver);
373 tty->count++;
Alan Coxbf970ee2008-10-13 10:42:39 +0100374 return 0;
Jiri Slaby8a1b8d72011-03-23 10:48:33 +0100375err_free_termios:
Jiri Slaby5d249bc2012-06-04 13:35:29 +0200376 if (legacy)
377 tty_free_termios(tty);
Jiri Slabya9dccdd2011-03-23 10:48:36 +0100378err_deinit_tty:
379 deinitialize_tty_struct(o_tty);
Alan Coxbf970ee2008-10-13 10:42:39 +0100380 module_put(o_tty->driver->owner);
Jiri Slaby8a1b8d72011-03-23 10:48:33 +0100381err_free_tty:
Jiri Slabyd03702a2012-06-04 13:35:30 +0200382 kfree(ports[0]);
383 kfree(ports[1]);
Alan Coxbf970ee2008-10-13 10:42:39 +0100384 free_tty_struct(o_tty);
Jiri Slaby6f9ea7a2012-08-07 21:47:26 +0200385err:
Jiri Slaby8a1b8d72011-03-23 10:48:33 +0100386 return retval;
Alan Coxbf970ee2008-10-13 10:42:39 +0100387}
388
Jiri Slabyfa2ecfc5a2012-10-18 22:26:31 +0200389/* this is called once with whichever end is closed last */
390static void pty_unix98_shutdown(struct tty_struct *tty)
391{
392 devpts_kill_index(tty->driver_data, tty->index);
393}
394
Jiri Slabyd03702a2012-06-04 13:35:30 +0200395static void pty_cleanup(struct tty_struct *tty)
396{
Jiri Slaby967fab62012-10-18 22:26:46 +0200397 tty->port->itty = NULL;
Jiri Slabyd03702a2012-06-04 13:35:30 +0200398 kfree(tty->port);
399}
400
Jiri Slaby5d249bc2012-06-04 13:35:29 +0200401/* Traditional BSD devices */
402#ifdef CONFIG_LEGACY_PTYS
403
404static int pty_install(struct tty_driver *driver, struct tty_struct *tty)
405{
406 return pty_common_install(driver, tty, true);
407}
408
Alan Coxd1552552012-07-27 18:02:54 +0100409static void pty_remove(struct tty_driver *driver, struct tty_struct *tty)
410{
411 struct tty_struct *pair = tty->link;
412 driver->ttys[tty->index] = NULL;
413 if (pair)
414 pair->driver->ttys[pair->index] = NULL;
415}
416
Alan Cox6caa76b2011-02-14 16:27:22 +0000417static int pty_bsd_ioctl(struct tty_struct *tty,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700418 unsigned int cmd, unsigned long arg)
419{
420 switch (cmd) {
421 case TIOCSPTLCK: /* Set PT Lock (disallow slave open) */
422 return pty_set_lock(tty, (int __user *) arg);
Cyrill Gorcunov06026d92012-10-24 23:43:20 +0400423 case TIOCPKT: /* Set PT packet mode */
424 return pty_set_pktmode(tty, (int __user *)arg);
hyc@symas.com26df6d12010-06-22 10:14:49 -0700425 case TIOCSIG: /* Send signal to other side of pty */
426 return pty_signal(tty, (int) arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700427 }
428 return -ENOIOCTLCMD;
429}
430
Kay Sieversdc8c8582007-08-15 12:25:38 +0200431static int legacy_count = CONFIG_LEGACY_PTY_COUNT;
432module_param(legacy_count, int, 0);
433
Linus Torvalds342a5972009-09-30 07:49:40 -0700434/*
435 * The master side of a pty can do TIOCSPTLCK and thus
436 * has pty_bsd_ioctl.
437 */
438static const struct tty_operations master_pty_ops_bsd = {
439 .install = pty_install,
Alan Cox3e8e88c2008-04-30 00:54:10 -0700440 .open = pty_open,
441 .close = pty_close,
442 .write = pty_write,
443 .write_room = pty_write_room,
444 .flush_buffer = pty_flush_buffer,
445 .chars_in_buffer = pty_chars_in_buffer,
446 .unthrottle = pty_unthrottle,
447 .set_termios = pty_set_termios,
448 .ioctl = pty_bsd_ioctl,
Jiri Slabyd03702a2012-06-04 13:35:30 +0200449 .cleanup = pty_cleanup,
Alan Coxd1552552012-07-27 18:02:54 +0100450 .resize = pty_resize,
451 .remove = pty_remove
Alan Cox3e8e88c2008-04-30 00:54:10 -0700452};
453
Linus Torvalds342a5972009-09-30 07:49:40 -0700454static const struct tty_operations slave_pty_ops_bsd = {
455 .install = pty_install,
456 .open = pty_open,
457 .close = pty_close,
458 .write = pty_write,
459 .write_room = pty_write_room,
460 .flush_buffer = pty_flush_buffer,
461 .chars_in_buffer = pty_chars_in_buffer,
462 .unthrottle = pty_unthrottle,
463 .set_termios = pty_set_termios,
Jiri Slabyd03702a2012-06-04 13:35:30 +0200464 .cleanup = pty_cleanup,
Alan Coxd1552552012-07-27 18:02:54 +0100465 .resize = pty_resize,
466 .remove = pty_remove
Linus Torvalds342a5972009-09-30 07:49:40 -0700467};
468
Linus Torvalds1da177e2005-04-16 15:20:36 -0700469static void __init legacy_pty_init(void)
470{
Linus Torvalds342a5972009-09-30 07:49:40 -0700471 struct tty_driver *pty_driver, *pty_slave_driver;
472
Kay Sieversdc8c8582007-08-15 12:25:38 +0200473 if (legacy_count <= 0)
474 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700475
Jiri Slaby21aca2f2012-08-08 22:26:41 +0200476 pty_driver = tty_alloc_driver(legacy_count,
477 TTY_DRIVER_RESET_TERMIOS |
478 TTY_DRIVER_REAL_RAW |
479 TTY_DRIVER_DYNAMIC_ALLOC);
Dan Carpenterc3a63442012-08-16 16:16:56 +0300480 if (IS_ERR(pty_driver))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700481 panic("Couldn't allocate pty driver");
482
Jiri Slaby21aca2f2012-08-08 22:26:41 +0200483 pty_slave_driver = tty_alloc_driver(legacy_count,
484 TTY_DRIVER_RESET_TERMIOS |
485 TTY_DRIVER_REAL_RAW |
486 TTY_DRIVER_DYNAMIC_ALLOC);
Dan Carpenterc3a63442012-08-16 16:16:56 +0300487 if (IS_ERR(pty_slave_driver))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700488 panic("Couldn't allocate pty slave driver");
489
Linus Torvalds1da177e2005-04-16 15:20:36 -0700490 pty_driver->driver_name = "pty_master";
491 pty_driver->name = "pty";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700492 pty_driver->major = PTY_MASTER_MAJOR;
493 pty_driver->minor_start = 0;
494 pty_driver->type = TTY_DRIVER_TYPE_PTY;
495 pty_driver->subtype = PTY_TYPE_MASTER;
496 pty_driver->init_termios = tty_std_termios;
497 pty_driver->init_termios.c_iflag = 0;
498 pty_driver->init_termios.c_oflag = 0;
499 pty_driver->init_termios.c_cflag = B38400 | CS8 | CREAD;
500 pty_driver->init_termios.c_lflag = 0;
Alan Cox606d0992006-12-08 02:38:45 -0800501 pty_driver->init_termios.c_ispeed = 38400;
502 pty_driver->init_termios.c_ospeed = 38400;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700503 pty_driver->other = pty_slave_driver;
Linus Torvalds342a5972009-09-30 07:49:40 -0700504 tty_set_operations(pty_driver, &master_pty_ops_bsd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700505
Linus Torvalds1da177e2005-04-16 15:20:36 -0700506 pty_slave_driver->driver_name = "pty_slave";
507 pty_slave_driver->name = "ttyp";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700508 pty_slave_driver->major = PTY_SLAVE_MAJOR;
509 pty_slave_driver->minor_start = 0;
510 pty_slave_driver->type = TTY_DRIVER_TYPE_PTY;
511 pty_slave_driver->subtype = PTY_TYPE_SLAVE;
512 pty_slave_driver->init_termios = tty_std_termios;
513 pty_slave_driver->init_termios.c_cflag = B38400 | CS8 | CREAD;
Alan Cox606d0992006-12-08 02:38:45 -0800514 pty_slave_driver->init_termios.c_ispeed = 38400;
515 pty_slave_driver->init_termios.c_ospeed = 38400;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700516 pty_slave_driver->other = pty_driver;
Linus Torvalds342a5972009-09-30 07:49:40 -0700517 tty_set_operations(pty_slave_driver, &slave_pty_ops_bsd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700518
519 if (tty_register_driver(pty_driver))
520 panic("Couldn't register pty driver");
521 if (tty_register_driver(pty_slave_driver))
522 panic("Couldn't register pty slave driver");
523}
524#else
525static inline void legacy_pty_init(void) { }
526#endif
527
528/* Unix98 devices */
529#ifdef CONFIG_UNIX98_PTYS
Linus Torvalds1da177e2005-04-16 15:20:36 -0700530
Alan Coxd81ed102008-10-13 10:41:42 +0100531static struct cdev ptmx_cdev;
532
Alan Cox6caa76b2011-02-14 16:27:22 +0000533static int pty_unix98_ioctl(struct tty_struct *tty,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700534 unsigned int cmd, unsigned long arg)
535{
536 switch (cmd) {
537 case TIOCSPTLCK: /* Set PT Lock (disallow slave open) */
538 return pty_set_lock(tty, (int __user *)arg);
Cyrill Gorcunov06026d92012-10-24 23:43:20 +0400539 case TIOCPKT: /* Set PT packet mode */
540 return pty_set_pktmode(tty, (int __user *)arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700541 case TIOCGPTN: /* Get PT Number */
542 return put_user(tty->index, (unsigned int __user *)arg);
hyc@symas.com26df6d12010-06-22 10:14:49 -0700543 case TIOCSIG: /* Send signal to other side of pty */
544 return pty_signal(tty, (int) arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700545 }
546
547 return -ENOIOCTLCMD;
548}
549
Alan Cox99f1fe12008-10-13 10:42:00 +0100550/**
551 * ptm_unix98_lookup - find a pty master
552 * @driver: ptm driver
553 * @idx: tty index
554 *
555 * Look up a pty master device. Called under the tty_mutex for now.
556 * This provides our locking.
557 */
558
Sukadev Bhattiprolu15f1a632008-10-13 10:42:59 +0100559static struct tty_struct *ptm_unix98_lookup(struct tty_driver *driver,
560 struct inode *ptm_inode, int idx)
Alan Cox99f1fe12008-10-13 10:42:00 +0100561{
Konstantin Khlebnikov593a27c2012-01-05 13:04:21 +0400562 /* Master must be open via /dev/ptmx */
563 return ERR_PTR(-EIO);
Alan Cox99f1fe12008-10-13 10:42:00 +0100564}
565
566/**
567 * pts_unix98_lookup - find a pty slave
568 * @driver: pts driver
569 * @idx: tty index
570 *
571 * Look up a pty master device. Called under the tty_mutex for now.
Alan Coxd739e652012-05-03 22:22:09 +0100572 * This provides our locking for the tty pointer.
Alan Cox99f1fe12008-10-13 10:42:00 +0100573 */
574
Sukadev Bhattiprolu15f1a632008-10-13 10:42:59 +0100575static struct tty_struct *pts_unix98_lookup(struct tty_driver *driver,
576 struct inode *pts_inode, int idx)
Alan Cox99f1fe12008-10-13 10:42:00 +0100577{
Alan Coxd739e652012-05-03 22:22:09 +0100578 struct tty_struct *tty;
579
580 mutex_lock(&devpts_mutex);
Jiri Slaby8fcbaa22012-10-18 22:26:27 +0200581 tty = devpts_get_priv(pts_inode);
Alan Coxd739e652012-05-03 22:22:09 +0100582 mutex_unlock(&devpts_mutex);
Alan Cox99f1fe12008-10-13 10:42:00 +0100583 /* Master must be open before slave */
584 if (!tty)
585 return ERR_PTR(-EIO);
586 return tty;
587}
588
Alan Cox8b0a88d2008-10-13 10:42:19 +0100589/* We have no need to install and remove our tty objects as devpts does all
590 the work for us */
591
Alan Coxbf970ee2008-10-13 10:42:39 +0100592static int pty_unix98_install(struct tty_driver *driver, struct tty_struct *tty)
Alan Cox8b0a88d2008-10-13 10:42:19 +0100593{
Jiri Slaby5d249bc2012-06-04 13:35:29 +0200594 return pty_common_install(driver, tty, false);
Alan Cox8b0a88d2008-10-13 10:42:19 +0100595}
596
Jiri Slaby71716042012-06-04 13:35:28 +0200597static void pty_unix98_remove(struct tty_driver *driver, struct tty_struct *tty)
Jiri Slaby484af542011-11-16 16:27:11 +0100598{
Alan Cox8b0a88d2008-10-13 10:42:19 +0100599}
600
Alan Coxfeebed62008-10-13 10:41:30 +0100601static const struct tty_operations ptm_unix98_ops = {
Alan Cox99f1fe12008-10-13 10:42:00 +0100602 .lookup = ptm_unix98_lookup,
Alan Coxbf970ee2008-10-13 10:42:39 +0100603 .install = pty_unix98_install,
Jiri Slaby71716042012-06-04 13:35:28 +0200604 .remove = pty_unix98_remove,
Alan Cox3e8e88c2008-04-30 00:54:10 -0700605 .open = pty_open,
606 .close = pty_close,
607 .write = pty_write,
608 .write_room = pty_write_room,
609 .flush_buffer = pty_flush_buffer,
610 .chars_in_buffer = pty_chars_in_buffer,
611 .unthrottle = pty_unthrottle,
612 .set_termios = pty_set_termios,
Alan Coxfeebed62008-10-13 10:41:30 +0100613 .ioctl = pty_unix98_ioctl,
Alan Cox36b3c072012-07-17 17:06:57 +0100614 .resize = pty_resize,
Jiri Slabyfa2ecfc5a2012-10-18 22:26:31 +0200615 .shutdown = pty_unix98_shutdown,
Alan Cox36b3c072012-07-17 17:06:57 +0100616 .cleanup = pty_cleanup
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,
Jiri Slaby71716042012-06-04 13:35:28 +0200622 .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,
Jiri Slabyfa2ecfc5a2012-10-18 22:26:31 +0200631 .shutdown = pty_unix98_shutdown,
Jiri Slabyd03702a2012-06-04 13:35:30 +0200632 .cleanup = pty_cleanup,
Alan Cox99f1fe12008-10-13 10:42:00 +0100633};
Alan Coxd81ed102008-10-13 10:41:42 +0100634
635/**
636 * ptmx_open - open a unix 98 pty master
637 * @inode: inode of device file
638 * @filp: file pointer to tty
639 *
640 * Allocate a unix98 pty master device from the ptmx driver.
641 *
642 * Locking: tty_mutex protects the init_dev work. tty->count should
643 * protect the rest.
644 * allocated_ptys_lock handles the list of free pty numbers
645 */
646
Arnd Bergmann64ba3dc2010-06-01 22:53:02 +0200647static int ptmx_open(struct inode *inode, struct file *filp)
Alan Coxd81ed102008-10-13 10:41:42 +0100648{
649 struct tty_struct *tty;
Jiri Slaby162b97c2012-10-18 22:26:28 +0200650 struct inode *slave_inode;
Alan Coxd81ed102008-10-13 10:41:42 +0100651 int retval;
652 int index;
653
654 nonseekable_open(inode, filp);
655
Jiri Slabyfa90e1c2011-10-12 11:32:43 +0200656 retval = tty_alloc_file(filp);
657 if (retval)
658 return retval;
659
Alan Coxd81ed102008-10-13 10:41:42 +0100660 /* find a device that is not in use. */
Alan Cox89c8d912012-08-08 16:30:13 +0100661 mutex_lock(&devpts_mutex);
Sukadev Bhattiprolu15f1a632008-10-13 10:42:59 +0100662 index = devpts_new_index(inode);
Jiri Slabyfa90e1c2011-10-12 11:32:43 +0200663 if (index < 0) {
664 retval = index;
Alan Cox05fb79e2012-09-19 15:34:47 +0100665 mutex_unlock(&devpts_mutex);
Jiri Slabyfa90e1c2011-10-12 11:32:43 +0200666 goto err_file;
667 }
Alan Coxd81ed102008-10-13 10:41:42 +0100668
Alan Cox6d31a882012-07-14 15:31:27 +0100669 mutex_unlock(&devpts_mutex);
Alan Cox89c8d912012-08-08 16:30:13 +0100670
671 mutex_lock(&tty_mutex);
672 tty = tty_init_dev(ptm_driver, index);
Alan Coxd81ed102008-10-13 10:41:42 +0100673
Alan Cox73ec06f2008-10-13 10:42:29 +0100674 if (IS_ERR(tty)) {
675 retval = PTR_ERR(tty);
Alan Coxd81ed102008-10-13 10:41:42 +0100676 goto out;
Alan Cox73ec06f2008-10-13 10:42:29 +0100677 }
Alan Coxd81ed102008-10-13 10:41:42 +0100678
Alan Cox89c8d912012-08-08 16:30:13 +0100679 /* The tty returned here is locked so we can safely
680 drop the mutex */
681 mutex_unlock(&tty_mutex);
682
Alan Coxd81ed102008-10-13 10:41:42 +0100683 set_bit(TTY_PTY_LOCK, &tty->flags); /* LOCK THE SLAVE */
Nick Pigginee2ffa02010-08-18 04:37:35 +1000684
Jiri Slabyfa90e1c2011-10-12 11:32:43 +0200685 tty_add_file(tty, filp);
Alan Coxd81ed102008-10-13 10:41:42 +0100686
Jiri Slabyf11afb62012-10-18 22:26:29 +0200687 slave_inode = devpts_pty_new(inode,
688 MKDEV(UNIX98_PTY_SLAVE_MAJOR, index), index,
689 tty->link);
Jiri Slaby162b97c2012-10-18 22:26:28 +0200690 if (IS_ERR(slave_inode)) {
691 retval = PTR_ERR(slave_inode);
Jiri Slaby1177c0e2011-10-12 11:32:44 +0200692 goto err_release;
Jiri Slaby162b97c2012-10-18 22:26:28 +0200693 }
Alan Coxd81ed102008-10-13 10:41:42 +0100694
695 retval = ptm_driver->ops->open(tty, filp);
Arnd Bergmann64ba3dc2010-06-01 22:53:02 +0200696 if (retval)
Jiri Slaby1177c0e2011-10-12 11:32:44 +0200697 goto err_release;
698
Alan Cox89c8d912012-08-08 16:30:13 +0100699 tty_unlock(tty);
Jiri Slabyfa2ecfc5a2012-10-18 22:26:31 +0200700 tty->driver_data = inode;
Jiri Slabyf11afb62012-10-18 22:26:29 +0200701 tty->link->driver_data = slave_inode;
Jiri Slaby1177c0e2011-10-12 11:32:44 +0200702 return 0;
703err_release:
Alan Cox89c8d912012-08-08 16:30:13 +0100704 tty_unlock(tty);
Alan Coxeeb89d92009-11-30 13:18:29 +0000705 tty_release(inode, filp);
Alan Coxd81ed102008-10-13 10:41:42 +0100706 return retval;
707out:
Alan Cox89c8d912012-08-08 16:30:13 +0100708 mutex_unlock(&tty_mutex);
Jiri Slabyd3bda522012-01-30 21:14:32 +0100709 devpts_kill_index(inode, index);
Jiri Slabyfa90e1c2011-10-12 11:32:43 +0200710err_file:
711 tty_free_file(filp);
Arnd Bergmann64ba3dc2010-06-01 22:53:02 +0200712 return retval;
Alan Coxd81ed102008-10-13 10:41:42 +0100713}
714
715static struct file_operations ptmx_fops;
716
Linus Torvalds1da177e2005-04-16 15:20:36 -0700717static void __init unix98_pty_init(void)
718{
Jiri Slaby21aca2f2012-08-08 22:26:41 +0200719 ptm_driver = tty_alloc_driver(NR_UNIX98_PTY_MAX,
720 TTY_DRIVER_RESET_TERMIOS |
721 TTY_DRIVER_REAL_RAW |
722 TTY_DRIVER_DYNAMIC_DEV |
723 TTY_DRIVER_DEVPTS_MEM |
724 TTY_DRIVER_DYNAMIC_ALLOC);
Dan Carpenterc3a63442012-08-16 16:16:56 +0300725 if (IS_ERR(ptm_driver))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700726 panic("Couldn't allocate Unix98 ptm driver");
Jiri Slaby21aca2f2012-08-08 22:26:41 +0200727 pts_driver = tty_alloc_driver(NR_UNIX98_PTY_MAX,
728 TTY_DRIVER_RESET_TERMIOS |
729 TTY_DRIVER_REAL_RAW |
730 TTY_DRIVER_DYNAMIC_DEV |
731 TTY_DRIVER_DEVPTS_MEM |
732 TTY_DRIVER_DYNAMIC_ALLOC);
Dan Carpenterc3a63442012-08-16 16:16:56 +0300733 if (IS_ERR(pts_driver))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700734 panic("Couldn't allocate Unix98 pts driver");
735
Linus Torvalds1da177e2005-04-16 15:20:36 -0700736 ptm_driver->driver_name = "pty_master";
737 ptm_driver->name = "ptm";
738 ptm_driver->major = UNIX98_PTY_MASTER_MAJOR;
739 ptm_driver->minor_start = 0;
740 ptm_driver->type = TTY_DRIVER_TYPE_PTY;
741 ptm_driver->subtype = PTY_TYPE_MASTER;
742 ptm_driver->init_termios = tty_std_termios;
743 ptm_driver->init_termios.c_iflag = 0;
744 ptm_driver->init_termios.c_oflag = 0;
745 ptm_driver->init_termios.c_cflag = B38400 | CS8 | CREAD;
746 ptm_driver->init_termios.c_lflag = 0;
Alan Cox606d0992006-12-08 02:38:45 -0800747 ptm_driver->init_termios.c_ispeed = 38400;
748 ptm_driver->init_termios.c_ospeed = 38400;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700749 ptm_driver->other = pts_driver;
Alan Coxfeebed62008-10-13 10:41:30 +0100750 tty_set_operations(ptm_driver, &ptm_unix98_ops);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700751
Linus Torvalds1da177e2005-04-16 15:20:36 -0700752 pts_driver->driver_name = "pty_slave";
753 pts_driver->name = "pts";
754 pts_driver->major = UNIX98_PTY_SLAVE_MAJOR;
755 pts_driver->minor_start = 0;
756 pts_driver->type = TTY_DRIVER_TYPE_PTY;
757 pts_driver->subtype = PTY_TYPE_SLAVE;
758 pts_driver->init_termios = tty_std_termios;
759 pts_driver->init_termios.c_cflag = B38400 | CS8 | CREAD;
Alan Cox606d0992006-12-08 02:38:45 -0800760 pts_driver->init_termios.c_ispeed = 38400;
761 pts_driver->init_termios.c_ospeed = 38400;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700762 pts_driver->other = ptm_driver;
Alan Cox99f1fe12008-10-13 10:42:00 +0100763 tty_set_operations(pts_driver, &pty_unix98_ops);
Alan Coxfe9cd962008-10-13 10:43:38 +0100764
Linus Torvalds1da177e2005-04-16 15:20:36 -0700765 if (tty_register_driver(ptm_driver))
766 panic("Couldn't register Unix98 ptm driver");
767 if (tty_register_driver(pts_driver))
768 panic("Couldn't register Unix98 pts driver");
769
Alan Coxd81ed102008-10-13 10:41:42 +0100770 /* Now create the /dev/ptmx special device */
771 tty_default_fops(&ptmx_fops);
772 ptmx_fops.open = ptmx_open;
773
774 cdev_init(&ptmx_cdev, &ptmx_fops);
775 if (cdev_add(&ptmx_cdev, MKDEV(TTYAUX_MAJOR, 2), 1) ||
776 register_chrdev_region(MKDEV(TTYAUX_MAJOR, 2), 1, "/dev/ptmx") < 0)
777 panic("Couldn't register /dev/ptmx driver\n");
778 device_create(tty_class, NULL, MKDEV(TTYAUX_MAJOR, 2), NULL, "ptmx");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700779}
Alan Coxd81ed102008-10-13 10:41:42 +0100780
Linus Torvalds1da177e2005-04-16 15:20:36 -0700781#else
782static inline void unix98_pty_init(void) { }
783#endif
784
785static int __init pty_init(void)
786{
787 legacy_pty_init();
788 unix98_pty_init();
789 return 0;
790}
791module_init(pty_init);