blob: 4219f040adb8ff55f35109accc5eea5e55ef2366 [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
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 Coxadc8d742012-07-14 15:31:47 +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
Alan Coxd1552552012-07-27 18:02:54 +0100283/**
284 * pty_common_install - set up the pty pair
285 * @driver: the pty driver
286 * @tty: the tty being instantiated
287 * @bool: legacy, true if this is BSD style
288 *
289 * Perform the initial set up for the tty/pty pair. Called from the
290 * tty layer when the port is first opened.
291 *
292 * Locking: the caller must hold the tty_mutex
293 */
Jiri Slaby5d249bc2012-06-04 13:35:29 +0200294static int pty_common_install(struct tty_driver *driver, struct tty_struct *tty,
295 bool legacy)
Alan Coxbf970ee2008-10-13 10:42:39 +0100296{
297 struct tty_struct *o_tty;
Jiri Slabyd03702a2012-06-04 13:35:30 +0200298 struct tty_port *ports[2];
Alan Coxbf970ee2008-10-13 10:42:39 +0100299 int idx = tty->index;
Jiri Slaby5d249bc2012-06-04 13:35:29 +0200300 int retval = -ENOMEM;
Alan Coxbf970ee2008-10-13 10:42:39 +0100301
302 o_tty = alloc_tty_struct();
Jiri Slaby6f9ea7a2012-08-07 21:47:26 +0200303 if (!o_tty)
304 goto err;
Jiri Slabyd03702a2012-06-04 13:35:30 +0200305 ports[0] = kmalloc(sizeof **ports, GFP_KERNEL);
306 ports[1] = kmalloc(sizeof **ports, GFP_KERNEL);
Jiri Slaby6f9ea7a2012-08-07 21:47:26 +0200307 if (!ports[0] || !ports[1])
Jiri Slabyd03702a2012-06-04 13:35:30 +0200308 goto err_free_tty;
Alan Coxbf970ee2008-10-13 10:42:39 +0100309 if (!try_module_get(driver->other->owner)) {
310 /* This cannot in fact currently happen */
Jiri Slaby8a1b8d72011-03-23 10:48:33 +0100311 goto err_free_tty;
Alan Coxbf970ee2008-10-13 10:42:39 +0100312 }
313 initialize_tty_struct(o_tty, driver->other, idx);
314
Jiri Slaby5d249bc2012-06-04 13:35:29 +0200315 if (legacy) {
316 /* We always use new tty termios data so we can do this
317 the easy way .. */
318 retval = tty_init_termios(tty);
319 if (retval)
320 goto err_deinit_tty;
Alan Coxbf970ee2008-10-13 10:42:39 +0100321
Jiri Slaby5d249bc2012-06-04 13:35:29 +0200322 retval = tty_init_termios(o_tty);
323 if (retval)
324 goto err_free_termios;
325
326 driver->other->ttys[idx] = o_tty;
327 driver->ttys[idx] = tty;
328 } else {
Alan Coxadc8d742012-07-14 15:31:47 +0100329 memset(&tty->termios_locked, 0, sizeof(tty->termios_locked));
330 tty->termios = driver->init_termios;
331 memset(&o_tty->termios_locked, 0, sizeof(tty->termios_locked));
332 o_tty->termios = driver->other->init_termios;
Jiri Slaby5d249bc2012-06-04 13:35:29 +0200333 }
Alan Coxfe9cd962008-10-13 10:43:38 +0100334
Alan Coxbf970ee2008-10-13 10:42:39 +0100335 /*
336 * Everything allocated ... set up the o_tty structure.
337 */
Alan Coxbf970ee2008-10-13 10:42:39 +0100338 tty_driver_kref_get(driver->other);
339 if (driver->subtype == PTY_TYPE_MASTER)
340 o_tty->count++;
341 /* Establish the links in both directions */
342 tty->link = o_tty;
343 o_tty->link = tty;
Jiri Slabyd03702a2012-06-04 13:35:30 +0200344 tty_port_init(ports[0]);
345 tty_port_init(ports[1]);
346 o_tty->port = ports[0];
347 tty->port = ports[1];
Jiri Slaby967fab62012-10-18 22:26:46 +0200348 o_tty->port->itty = o_tty;
Alan Coxbf970ee2008-10-13 10:42:39 +0100349
350 tty_driver_kref_get(driver);
351 tty->count++;
Alan Coxbf970ee2008-10-13 10:42:39 +0100352 return 0;
Jiri Slaby8a1b8d72011-03-23 10:48:33 +0100353err_free_termios:
Jiri Slaby5d249bc2012-06-04 13:35:29 +0200354 if (legacy)
355 tty_free_termios(tty);
Jiri Slabya9dccdd2011-03-23 10:48:36 +0100356err_deinit_tty:
357 deinitialize_tty_struct(o_tty);
Alan Coxbf970ee2008-10-13 10:42:39 +0100358 module_put(o_tty->driver->owner);
Jiri Slaby8a1b8d72011-03-23 10:48:33 +0100359err_free_tty:
Jiri Slabyd03702a2012-06-04 13:35:30 +0200360 kfree(ports[0]);
361 kfree(ports[1]);
Alan Coxbf970ee2008-10-13 10:42:39 +0100362 free_tty_struct(o_tty);
Jiri Slaby6f9ea7a2012-08-07 21:47:26 +0200363err:
Jiri Slaby8a1b8d72011-03-23 10:48:33 +0100364 return retval;
Alan Coxbf970ee2008-10-13 10:42:39 +0100365}
366
Jiri Slabyfa2ecfc5a2012-10-18 22:26:31 +0200367/* this is called once with whichever end is closed last */
368static void pty_unix98_shutdown(struct tty_struct *tty)
369{
370 devpts_kill_index(tty->driver_data, tty->index);
371}
372
Jiri Slabyd03702a2012-06-04 13:35:30 +0200373static void pty_cleanup(struct tty_struct *tty)
374{
Jiri Slaby967fab62012-10-18 22:26:46 +0200375 tty->port->itty = NULL;
Jiri Slabyd03702a2012-06-04 13:35:30 +0200376 kfree(tty->port);
377}
378
Jiri Slaby5d249bc2012-06-04 13:35:29 +0200379/* Traditional BSD devices */
380#ifdef CONFIG_LEGACY_PTYS
381
382static int pty_install(struct tty_driver *driver, struct tty_struct *tty)
383{
384 return pty_common_install(driver, tty, true);
385}
386
Alan Coxd1552552012-07-27 18:02:54 +0100387static void pty_remove(struct tty_driver *driver, struct tty_struct *tty)
388{
389 struct tty_struct *pair = tty->link;
390 driver->ttys[tty->index] = NULL;
391 if (pair)
392 pair->driver->ttys[pair->index] = NULL;
393}
394
Alan Cox6caa76b2011-02-14 16:27:22 +0000395static int pty_bsd_ioctl(struct tty_struct *tty,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700396 unsigned int cmd, unsigned long arg)
397{
398 switch (cmd) {
399 case TIOCSPTLCK: /* Set PT Lock (disallow slave open) */
400 return pty_set_lock(tty, (int __user *) arg);
hyc@symas.com26df6d12010-06-22 10:14:49 -0700401 case TIOCSIG: /* Send signal to other side of pty */
402 return pty_signal(tty, (int) arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700403 }
404 return -ENOIOCTLCMD;
405}
406
Kay Sieversdc8c8582007-08-15 12:25:38 +0200407static int legacy_count = CONFIG_LEGACY_PTY_COUNT;
408module_param(legacy_count, int, 0);
409
Linus Torvalds342a5972009-09-30 07:49:40 -0700410/*
411 * The master side of a pty can do TIOCSPTLCK and thus
412 * has pty_bsd_ioctl.
413 */
414static const struct tty_operations master_pty_ops_bsd = {
415 .install = pty_install,
Alan Cox3e8e88c2008-04-30 00:54:10 -0700416 .open = pty_open,
417 .close = pty_close,
418 .write = pty_write,
419 .write_room = pty_write_room,
420 .flush_buffer = pty_flush_buffer,
421 .chars_in_buffer = pty_chars_in_buffer,
422 .unthrottle = pty_unthrottle,
423 .set_termios = pty_set_termios,
424 .ioctl = pty_bsd_ioctl,
Jiri Slabyd03702a2012-06-04 13:35:30 +0200425 .cleanup = pty_cleanup,
Alan Coxd1552552012-07-27 18:02:54 +0100426 .resize = pty_resize,
427 .remove = pty_remove
Alan Cox3e8e88c2008-04-30 00:54:10 -0700428};
429
Linus Torvalds342a5972009-09-30 07:49:40 -0700430static const struct tty_operations slave_pty_ops_bsd = {
431 .install = pty_install,
432 .open = pty_open,
433 .close = pty_close,
434 .write = pty_write,
435 .write_room = pty_write_room,
436 .flush_buffer = pty_flush_buffer,
437 .chars_in_buffer = pty_chars_in_buffer,
438 .unthrottle = pty_unthrottle,
439 .set_termios = pty_set_termios,
Jiri Slabyd03702a2012-06-04 13:35:30 +0200440 .cleanup = pty_cleanup,
Alan Coxd1552552012-07-27 18:02:54 +0100441 .resize = pty_resize,
442 .remove = pty_remove
Linus Torvalds342a5972009-09-30 07:49:40 -0700443};
444
Linus Torvalds1da177e2005-04-16 15:20:36 -0700445static void __init legacy_pty_init(void)
446{
Linus Torvalds342a5972009-09-30 07:49:40 -0700447 struct tty_driver *pty_driver, *pty_slave_driver;
448
Kay Sieversdc8c8582007-08-15 12:25:38 +0200449 if (legacy_count <= 0)
450 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700451
Jiri Slaby21aca2f2012-08-08 22:26:41 +0200452 pty_driver = tty_alloc_driver(legacy_count,
453 TTY_DRIVER_RESET_TERMIOS |
454 TTY_DRIVER_REAL_RAW |
455 TTY_DRIVER_DYNAMIC_ALLOC);
Dan Carpenterc3a63442012-08-16 16:16:56 +0300456 if (IS_ERR(pty_driver))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700457 panic("Couldn't allocate pty driver");
458
Jiri Slaby21aca2f2012-08-08 22:26:41 +0200459 pty_slave_driver = tty_alloc_driver(legacy_count,
460 TTY_DRIVER_RESET_TERMIOS |
461 TTY_DRIVER_REAL_RAW |
462 TTY_DRIVER_DYNAMIC_ALLOC);
Dan Carpenterc3a63442012-08-16 16:16:56 +0300463 if (IS_ERR(pty_slave_driver))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700464 panic("Couldn't allocate pty slave driver");
465
Linus Torvalds1da177e2005-04-16 15:20:36 -0700466 pty_driver->driver_name = "pty_master";
467 pty_driver->name = "pty";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700468 pty_driver->major = PTY_MASTER_MAJOR;
469 pty_driver->minor_start = 0;
470 pty_driver->type = TTY_DRIVER_TYPE_PTY;
471 pty_driver->subtype = PTY_TYPE_MASTER;
472 pty_driver->init_termios = tty_std_termios;
473 pty_driver->init_termios.c_iflag = 0;
474 pty_driver->init_termios.c_oflag = 0;
475 pty_driver->init_termios.c_cflag = B38400 | CS8 | CREAD;
476 pty_driver->init_termios.c_lflag = 0;
Alan Cox606d0992006-12-08 02:38:45 -0800477 pty_driver->init_termios.c_ispeed = 38400;
478 pty_driver->init_termios.c_ospeed = 38400;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700479 pty_driver->other = pty_slave_driver;
Linus Torvalds342a5972009-09-30 07:49:40 -0700480 tty_set_operations(pty_driver, &master_pty_ops_bsd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700481
Linus Torvalds1da177e2005-04-16 15:20:36 -0700482 pty_slave_driver->driver_name = "pty_slave";
483 pty_slave_driver->name = "ttyp";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700484 pty_slave_driver->major = PTY_SLAVE_MAJOR;
485 pty_slave_driver->minor_start = 0;
486 pty_slave_driver->type = TTY_DRIVER_TYPE_PTY;
487 pty_slave_driver->subtype = PTY_TYPE_SLAVE;
488 pty_slave_driver->init_termios = tty_std_termios;
489 pty_slave_driver->init_termios.c_cflag = B38400 | CS8 | CREAD;
Alan Cox606d0992006-12-08 02:38:45 -0800490 pty_slave_driver->init_termios.c_ispeed = 38400;
491 pty_slave_driver->init_termios.c_ospeed = 38400;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700492 pty_slave_driver->other = pty_driver;
Linus Torvalds342a5972009-09-30 07:49:40 -0700493 tty_set_operations(pty_slave_driver, &slave_pty_ops_bsd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700494
495 if (tty_register_driver(pty_driver))
496 panic("Couldn't register pty driver");
497 if (tty_register_driver(pty_slave_driver))
498 panic("Couldn't register pty slave driver");
499}
500#else
501static inline void legacy_pty_init(void) { }
502#endif
503
504/* Unix98 devices */
505#ifdef CONFIG_UNIX98_PTYS
Linus Torvalds1da177e2005-04-16 15:20:36 -0700506
Alan Coxd81ed102008-10-13 10:41:42 +0100507static struct cdev ptmx_cdev;
508
Alan Cox6caa76b2011-02-14 16:27:22 +0000509static int pty_unix98_ioctl(struct tty_struct *tty,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700510 unsigned int cmd, unsigned long arg)
511{
512 switch (cmd) {
513 case TIOCSPTLCK: /* Set PT Lock (disallow slave open) */
514 return pty_set_lock(tty, (int __user *)arg);
515 case TIOCGPTN: /* Get PT Number */
516 return put_user(tty->index, (unsigned int __user *)arg);
hyc@symas.com26df6d12010-06-22 10:14:49 -0700517 case TIOCSIG: /* Send signal to other side of pty */
518 return pty_signal(tty, (int) arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700519 }
520
521 return -ENOIOCTLCMD;
522}
523
Alan Cox99f1fe12008-10-13 10:42:00 +0100524/**
525 * ptm_unix98_lookup - find a pty master
526 * @driver: ptm driver
527 * @idx: tty index
528 *
529 * Look up a pty master device. Called under the tty_mutex for now.
530 * This provides our locking.
531 */
532
Sukadev Bhattiprolu15f1a632008-10-13 10:42:59 +0100533static struct tty_struct *ptm_unix98_lookup(struct tty_driver *driver,
534 struct inode *ptm_inode, int idx)
Alan Cox99f1fe12008-10-13 10:42:00 +0100535{
Konstantin Khlebnikov593a27c2012-01-05 13:04:21 +0400536 /* Master must be open via /dev/ptmx */
537 return ERR_PTR(-EIO);
Alan Cox99f1fe12008-10-13 10:42:00 +0100538}
539
540/**
541 * pts_unix98_lookup - find a pty slave
542 * @driver: pts driver
543 * @idx: tty index
544 *
545 * Look up a pty master device. Called under the tty_mutex for now.
Alan Coxd739e652012-05-03 22:22:09 +0100546 * This provides our locking for the tty pointer.
Alan Cox99f1fe12008-10-13 10:42:00 +0100547 */
548
Sukadev Bhattiprolu15f1a632008-10-13 10:42:59 +0100549static struct tty_struct *pts_unix98_lookup(struct tty_driver *driver,
550 struct inode *pts_inode, int idx)
Alan Cox99f1fe12008-10-13 10:42:00 +0100551{
Alan Coxd739e652012-05-03 22:22:09 +0100552 struct tty_struct *tty;
553
554 mutex_lock(&devpts_mutex);
Jiri Slaby8fcbaa22012-10-18 22:26:27 +0200555 tty = devpts_get_priv(pts_inode);
Alan Coxd739e652012-05-03 22:22:09 +0100556 mutex_unlock(&devpts_mutex);
Alan Cox99f1fe12008-10-13 10:42:00 +0100557 /* Master must be open before slave */
558 if (!tty)
559 return ERR_PTR(-EIO);
560 return tty;
561}
562
Alan Cox8b0a88d2008-10-13 10:42:19 +0100563/* We have no need to install and remove our tty objects as devpts does all
564 the work for us */
565
Alan Coxbf970ee2008-10-13 10:42:39 +0100566static int pty_unix98_install(struct tty_driver *driver, struct tty_struct *tty)
Alan Cox8b0a88d2008-10-13 10:42:19 +0100567{
Jiri Slaby5d249bc2012-06-04 13:35:29 +0200568 return pty_common_install(driver, tty, false);
Alan Cox8b0a88d2008-10-13 10:42:19 +0100569}
570
Jiri Slaby71716042012-06-04 13:35:28 +0200571static void pty_unix98_remove(struct tty_driver *driver, struct tty_struct *tty)
Jiri Slaby484af542011-11-16 16:27:11 +0100572{
Alan Cox8b0a88d2008-10-13 10:42:19 +0100573}
574
Alan Coxfeebed62008-10-13 10:41:30 +0100575static const struct tty_operations ptm_unix98_ops = {
Alan Cox99f1fe12008-10-13 10:42:00 +0100576 .lookup = ptm_unix98_lookup,
Alan Coxbf970ee2008-10-13 10:42:39 +0100577 .install = pty_unix98_install,
Jiri Slaby71716042012-06-04 13:35:28 +0200578 .remove = pty_unix98_remove,
Alan Cox3e8e88c2008-04-30 00:54:10 -0700579 .open = pty_open,
580 .close = pty_close,
581 .write = pty_write,
582 .write_room = pty_write_room,
583 .flush_buffer = pty_flush_buffer,
584 .chars_in_buffer = pty_chars_in_buffer,
585 .unthrottle = pty_unthrottle,
586 .set_termios = pty_set_termios,
Alan Coxfeebed62008-10-13 10:41:30 +0100587 .ioctl = pty_unix98_ioctl,
Alan Cox36b3c072012-07-17 17:06:57 +0100588 .resize = pty_resize,
Jiri Slabyfa2ecfc5a2012-10-18 22:26:31 +0200589 .shutdown = pty_unix98_shutdown,
Alan Cox36b3c072012-07-17 17:06:57 +0100590 .cleanup = pty_cleanup
Alan Cox3e8e88c2008-04-30 00:54:10 -0700591};
592
Alan Cox99f1fe12008-10-13 10:42:00 +0100593static const struct tty_operations pty_unix98_ops = {
594 .lookup = pts_unix98_lookup,
Alan Coxbf970ee2008-10-13 10:42:39 +0100595 .install = pty_unix98_install,
Jiri Slaby71716042012-06-04 13:35:28 +0200596 .remove = pty_unix98_remove,
Alan Cox99f1fe12008-10-13 10:42:00 +0100597 .open = pty_open,
598 .close = pty_close,
599 .write = pty_write,
600 .write_room = pty_write_room,
601 .flush_buffer = pty_flush_buffer,
602 .chars_in_buffer = pty_chars_in_buffer,
603 .unthrottle = pty_unthrottle,
604 .set_termios = pty_set_termios,
Jiri Slabyfa2ecfc5a2012-10-18 22:26:31 +0200605 .shutdown = pty_unix98_shutdown,
Jiri Slabyd03702a2012-06-04 13:35:30 +0200606 .cleanup = pty_cleanup,
Alan Cox99f1fe12008-10-13 10:42:00 +0100607};
Alan Coxd81ed102008-10-13 10:41:42 +0100608
609/**
610 * ptmx_open - open a unix 98 pty master
611 * @inode: inode of device file
612 * @filp: file pointer to tty
613 *
614 * Allocate a unix98 pty master device from the ptmx driver.
615 *
616 * Locking: tty_mutex protects the init_dev work. tty->count should
617 * protect the rest.
618 * allocated_ptys_lock handles the list of free pty numbers
619 */
620
Arnd Bergmann64ba3dc32010-06-01 22:53:02 +0200621static int ptmx_open(struct inode *inode, struct file *filp)
Alan Coxd81ed102008-10-13 10:41:42 +0100622{
623 struct tty_struct *tty;
Jiri Slaby162b97c2012-10-18 22:26:28 +0200624 struct inode *slave_inode;
Alan Coxd81ed102008-10-13 10:41:42 +0100625 int retval;
626 int index;
627
628 nonseekable_open(inode, filp);
629
Jiri Slabyfa90e1c2011-10-12 11:32:43 +0200630 retval = tty_alloc_file(filp);
631 if (retval)
632 return retval;
633
Alan Coxd81ed102008-10-13 10:41:42 +0100634 /* find a device that is not in use. */
Alan Cox89c8d912012-08-08 16:30:13 +0100635 mutex_lock(&devpts_mutex);
Sukadev Bhattiprolu15f1a632008-10-13 10:42:59 +0100636 index = devpts_new_index(inode);
Jiri Slabyfa90e1c2011-10-12 11:32:43 +0200637 if (index < 0) {
638 retval = index;
Alan Cox05fb79e2012-09-19 15:34:47 +0100639 mutex_unlock(&devpts_mutex);
Jiri Slabyfa90e1c2011-10-12 11:32:43 +0200640 goto err_file;
641 }
Alan Coxd81ed102008-10-13 10:41:42 +0100642
Alan Cox6d31a882012-07-14 15:31:27 +0100643 mutex_unlock(&devpts_mutex);
Alan Cox89c8d912012-08-08 16:30:13 +0100644
645 mutex_lock(&tty_mutex);
646 tty = tty_init_dev(ptm_driver, index);
Alan Coxd81ed102008-10-13 10:41:42 +0100647
Alan Cox73ec06f2008-10-13 10:42:29 +0100648 if (IS_ERR(tty)) {
649 retval = PTR_ERR(tty);
Alan Coxd81ed102008-10-13 10:41:42 +0100650 goto out;
Alan Cox73ec06f2008-10-13 10:42:29 +0100651 }
Alan Coxd81ed102008-10-13 10:41:42 +0100652
Alan Cox89c8d912012-08-08 16:30:13 +0100653 /* The tty returned here is locked so we can safely
654 drop the mutex */
655 mutex_unlock(&tty_mutex);
656
Alan Coxd81ed102008-10-13 10:41:42 +0100657 set_bit(TTY_PTY_LOCK, &tty->flags); /* LOCK THE SLAVE */
Nick Pigginee2ffa02010-08-18 04:37:35 +1000658
Jiri Slabyfa90e1c2011-10-12 11:32:43 +0200659 tty_add_file(tty, filp);
Alan Coxd81ed102008-10-13 10:41:42 +0100660
Jiri Slabyf11afb62012-10-18 22:26:29 +0200661 slave_inode = devpts_pty_new(inode,
662 MKDEV(UNIX98_PTY_SLAVE_MAJOR, index), index,
663 tty->link);
Jiri Slaby162b97c2012-10-18 22:26:28 +0200664 if (IS_ERR(slave_inode)) {
665 retval = PTR_ERR(slave_inode);
Jiri Slaby1177c0e2011-10-12 11:32:44 +0200666 goto err_release;
Jiri Slaby162b97c2012-10-18 22:26:28 +0200667 }
Alan Coxd81ed102008-10-13 10:41:42 +0100668
669 retval = ptm_driver->ops->open(tty, filp);
Arnd Bergmann64ba3dc32010-06-01 22:53:02 +0200670 if (retval)
Jiri Slaby1177c0e2011-10-12 11:32:44 +0200671 goto err_release;
672
Alan Cox89c8d912012-08-08 16:30:13 +0100673 tty_unlock(tty);
Jiri Slabyfa2ecfc5a2012-10-18 22:26:31 +0200674 tty->driver_data = inode;
Jiri Slabyf11afb62012-10-18 22:26:29 +0200675 tty->link->driver_data = slave_inode;
Jiri Slaby1177c0e2011-10-12 11:32:44 +0200676 return 0;
677err_release:
Alan Cox89c8d912012-08-08 16:30:13 +0100678 tty_unlock(tty);
Alan Coxeeb89d92009-11-30 13:18:29 +0000679 tty_release(inode, filp);
Alan Coxd81ed102008-10-13 10:41:42 +0100680 return retval;
681out:
Alan Cox89c8d912012-08-08 16:30:13 +0100682 mutex_unlock(&tty_mutex);
Jiri Slabyd3bda522012-01-30 21:14:32 +0100683 devpts_kill_index(inode, index);
Jiri Slabyfa90e1c2011-10-12 11:32:43 +0200684err_file:
685 tty_free_file(filp);
Arnd Bergmann64ba3dc32010-06-01 22:53:02 +0200686 return retval;
Alan Coxd81ed102008-10-13 10:41:42 +0100687}
688
689static struct file_operations ptmx_fops;
690
Linus Torvalds1da177e2005-04-16 15:20:36 -0700691static void __init unix98_pty_init(void)
692{
Jiri Slaby21aca2f2012-08-08 22:26:41 +0200693 ptm_driver = tty_alloc_driver(NR_UNIX98_PTY_MAX,
694 TTY_DRIVER_RESET_TERMIOS |
695 TTY_DRIVER_REAL_RAW |
696 TTY_DRIVER_DYNAMIC_DEV |
697 TTY_DRIVER_DEVPTS_MEM |
698 TTY_DRIVER_DYNAMIC_ALLOC);
Dan Carpenterc3a63442012-08-16 16:16:56 +0300699 if (IS_ERR(ptm_driver))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700700 panic("Couldn't allocate Unix98 ptm driver");
Jiri Slaby21aca2f2012-08-08 22:26:41 +0200701 pts_driver = tty_alloc_driver(NR_UNIX98_PTY_MAX,
702 TTY_DRIVER_RESET_TERMIOS |
703 TTY_DRIVER_REAL_RAW |
704 TTY_DRIVER_DYNAMIC_DEV |
705 TTY_DRIVER_DEVPTS_MEM |
706 TTY_DRIVER_DYNAMIC_ALLOC);
Dan Carpenterc3a63442012-08-16 16:16:56 +0300707 if (IS_ERR(pts_driver))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700708 panic("Couldn't allocate Unix98 pts driver");
709
Linus Torvalds1da177e2005-04-16 15:20:36 -0700710 ptm_driver->driver_name = "pty_master";
711 ptm_driver->name = "ptm";
712 ptm_driver->major = UNIX98_PTY_MASTER_MAJOR;
713 ptm_driver->minor_start = 0;
714 ptm_driver->type = TTY_DRIVER_TYPE_PTY;
715 ptm_driver->subtype = PTY_TYPE_MASTER;
716 ptm_driver->init_termios = tty_std_termios;
717 ptm_driver->init_termios.c_iflag = 0;
718 ptm_driver->init_termios.c_oflag = 0;
719 ptm_driver->init_termios.c_cflag = B38400 | CS8 | CREAD;
720 ptm_driver->init_termios.c_lflag = 0;
Alan Cox606d0992006-12-08 02:38:45 -0800721 ptm_driver->init_termios.c_ispeed = 38400;
722 ptm_driver->init_termios.c_ospeed = 38400;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700723 ptm_driver->other = pts_driver;
Alan Coxfeebed62008-10-13 10:41:30 +0100724 tty_set_operations(ptm_driver, &ptm_unix98_ops);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700725
Linus Torvalds1da177e2005-04-16 15:20:36 -0700726 pts_driver->driver_name = "pty_slave";
727 pts_driver->name = "pts";
728 pts_driver->major = UNIX98_PTY_SLAVE_MAJOR;
729 pts_driver->minor_start = 0;
730 pts_driver->type = TTY_DRIVER_TYPE_PTY;
731 pts_driver->subtype = PTY_TYPE_SLAVE;
732 pts_driver->init_termios = tty_std_termios;
733 pts_driver->init_termios.c_cflag = B38400 | CS8 | CREAD;
Alan Cox606d0992006-12-08 02:38:45 -0800734 pts_driver->init_termios.c_ispeed = 38400;
735 pts_driver->init_termios.c_ospeed = 38400;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700736 pts_driver->other = ptm_driver;
Alan Cox99f1fe12008-10-13 10:42:00 +0100737 tty_set_operations(pts_driver, &pty_unix98_ops);
Alan Coxfe9cd962008-10-13 10:43:38 +0100738
Linus Torvalds1da177e2005-04-16 15:20:36 -0700739 if (tty_register_driver(ptm_driver))
740 panic("Couldn't register Unix98 ptm driver");
741 if (tty_register_driver(pts_driver))
742 panic("Couldn't register Unix98 pts driver");
743
Alan Coxd81ed102008-10-13 10:41:42 +0100744 /* Now create the /dev/ptmx special device */
745 tty_default_fops(&ptmx_fops);
746 ptmx_fops.open = ptmx_open;
747
748 cdev_init(&ptmx_cdev, &ptmx_fops);
749 if (cdev_add(&ptmx_cdev, MKDEV(TTYAUX_MAJOR, 2), 1) ||
750 register_chrdev_region(MKDEV(TTYAUX_MAJOR, 2), 1, "/dev/ptmx") < 0)
751 panic("Couldn't register /dev/ptmx driver\n");
752 device_create(tty_class, NULL, MKDEV(TTYAUX_MAJOR, 2), NULL, "ptmx");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700753}
Alan Coxd81ed102008-10-13 10:41:42 +0100754
Linus Torvalds1da177e2005-04-16 15:20:36 -0700755#else
756static inline void unix98_pty_init(void) { }
757#endif
758
759static int __init pty_init(void)
760{
761 legacy_pty_init();
762 unix98_pty_init();
763 return 0;
764}
765module_init(pty_init);