blob: be6a373601b783677b876a512854edcfb28f3732 [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 Gorcunov84fd7bd2012-10-24 23:43:22 +0400174static int pty_get_lock(struct tty_struct *tty, int __user *arg)
175{
176 int locked = test_bit(TTY_PTY_LOCK, &tty->flags);
177 return put_user(locked, arg);
178}
179
Cyrill Gorcunov06026d92012-10-24 23:43:20 +0400180/* Set the packet mode on a pty */
181static int pty_set_pktmode(struct tty_struct *tty, int __user *arg)
182{
183 unsigned long flags;
184 int pktmode;
185
186 if (get_user(pktmode, arg))
187 return -EFAULT;
188
189 spin_lock_irqsave(&tty->ctrl_lock, flags);
190 if (pktmode) {
191 if (!tty->packet) {
192 tty->packet = 1;
193 tty->link->ctrl_status = 0;
194 }
195 } else
196 tty->packet = 0;
197 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
198
199 return 0;
200}
201
Cyrill Gorcunov84fd7bd2012-10-24 23:43:22 +0400202/* Get the packet mode of a pty */
203static int pty_get_pktmode(struct tty_struct *tty, int __user *arg)
204{
205 int pktmode = tty->packet;
206 return put_user(pktmode, arg);
207}
208
hyc@symas.com26df6d12010-06-22 10:14:49 -0700209/* Send a signal to the slave */
210static int pty_signal(struct tty_struct *tty, int sig)
211{
212 unsigned long flags;
213 struct pid *pgrp;
214
215 if (tty->link) {
216 spin_lock_irqsave(&tty->link->ctrl_lock, flags);
217 pgrp = get_pid(tty->link->pgrp);
218 spin_unlock_irqrestore(&tty->link->ctrl_lock, flags);
219
220 kill_pgrp(pgrp, sig, 1);
221 put_pid(pgrp);
222 }
223 return 0;
224}
225
Linus Torvalds1da177e2005-04-16 15:20:36 -0700226static void pty_flush_buffer(struct tty_struct *tty)
227{
228 struct tty_struct *to = tty->link;
Alan Cox04f378b2008-04-30 00:53:29 -0700229 unsigned long flags;
Alan Coxfe9cd962008-10-13 10:43:38 +0100230
Linus Torvalds1da177e2005-04-16 15:20:36 -0700231 if (!to)
232 return;
Alan Coxd945cb92009-07-07 16:39:41 +0100233 /* tty_buffer_flush(to); FIXME */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700234 if (to->packet) {
Alan Cox04f378b2008-04-30 00:53:29 -0700235 spin_lock_irqsave(&tty->ctrl_lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700236 tty->ctrl_status |= TIOCPKT_FLUSHWRITE;
237 wake_up_interruptible(&to->read_wait);
Alan Cox04f378b2008-04-30 00:53:29 -0700238 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700239 }
240}
241
Alan Coxfe9cd962008-10-13 10:43:38 +0100242static int pty_open(struct tty_struct *tty, struct file *filp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700243{
244 int retval = -ENODEV;
245
246 if (!tty || !tty->link)
247 goto out;
248
249 retval = -EIO;
250 if (test_bit(TTY_OTHER_CLOSED, &tty->flags))
251 goto out;
252 if (test_bit(TTY_PTY_LOCK, &tty->link->flags))
253 goto out;
254 if (tty->link->count != 1)
255 goto out;
256
257 clear_bit(TTY_OTHER_CLOSED, &tty->link->flags);
258 set_bit(TTY_THROTTLED, &tty->flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700259 retval = 0;
260out:
261 return retval;
262}
263
Alan Coxfe9cd962008-10-13 10:43:38 +0100264static void pty_set_termios(struct tty_struct *tty,
265 struct ktermios *old_termios)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700266{
Alan Coxadc8d742012-07-14 15:31:47 +0100267 tty->termios.c_cflag &= ~(CSIZE | PARENB);
268 tty->termios.c_cflag |= (CS8 | CREAD);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700269}
270
Alan Coxfc6f6232009-01-02 13:43:17 +0000271/**
272 * pty_do_resize - resize event
273 * @tty: tty being resized
Alan Coxc774bda2009-01-11 19:46:49 +0000274 * @ws: window size being set.
Alan Coxfc6f6232009-01-02 13:43:17 +0000275 *
Daniel Mack3ad2f3f2010-02-03 08:01:28 +0800276 * Update the termios variables and send the necessary signals to
Alan Coxfc6f6232009-01-02 13:43:17 +0000277 * peform a terminal resize correctly
278 */
279
Josh Triplett159a8e92012-11-18 21:27:40 -0800280static int pty_resize(struct tty_struct *tty, struct winsize *ws)
Alan Coxfc6f6232009-01-02 13:43:17 +0000281{
282 struct pid *pgrp, *rpgrp;
283 unsigned long flags;
284 struct tty_struct *pty = tty->link;
285
286 /* For a PTY we need to lock the tty side */
287 mutex_lock(&tty->termios_mutex);
288 if (!memcmp(ws, &tty->winsize, sizeof(*ws)))
289 goto done;
290
291 /* Get the PID values and reference them so we can
292 avoid holding the tty ctrl lock while sending signals.
293 We need to lock these individually however. */
294
295 spin_lock_irqsave(&tty->ctrl_lock, flags);
296 pgrp = get_pid(tty->pgrp);
297 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
298
299 spin_lock_irqsave(&pty->ctrl_lock, flags);
300 rpgrp = get_pid(pty->pgrp);
301 spin_unlock_irqrestore(&pty->ctrl_lock, flags);
302
303 if (pgrp)
304 kill_pgrp(pgrp, SIGWINCH, 1);
305 if (rpgrp != pgrp && rpgrp)
306 kill_pgrp(rpgrp, SIGWINCH, 1);
307
308 put_pid(pgrp);
309 put_pid(rpgrp);
310
311 tty->winsize = *ws;
312 pty->winsize = *ws; /* Never used so will go away soon */
313done:
314 mutex_unlock(&tty->termios_mutex);
315 return 0;
316}
317
Alan Coxd1552552012-07-27 18:02:54 +0100318/**
319 * pty_common_install - set up the pty pair
320 * @driver: the pty driver
321 * @tty: the tty being instantiated
322 * @bool: legacy, true if this is BSD style
323 *
324 * Perform the initial set up for the tty/pty pair. Called from the
325 * tty layer when the port is first opened.
326 *
327 * Locking: the caller must hold the tty_mutex
328 */
Jiri Slaby5d249bc2012-06-04 13:35:29 +0200329static int pty_common_install(struct tty_driver *driver, struct tty_struct *tty,
330 bool legacy)
Alan Coxbf970ee2008-10-13 10:42:39 +0100331{
332 struct tty_struct *o_tty;
Jiri Slabyd03702a2012-06-04 13:35:30 +0200333 struct tty_port *ports[2];
Alan Coxbf970ee2008-10-13 10:42:39 +0100334 int idx = tty->index;
Jiri Slaby5d249bc2012-06-04 13:35:29 +0200335 int retval = -ENOMEM;
Alan Coxbf970ee2008-10-13 10:42:39 +0100336
337 o_tty = alloc_tty_struct();
Jiri Slaby6f9ea7a2012-08-07 21:47:26 +0200338 if (!o_tty)
339 goto err;
Jiri Slabyd03702a2012-06-04 13:35:30 +0200340 ports[0] = kmalloc(sizeof **ports, GFP_KERNEL);
341 ports[1] = kmalloc(sizeof **ports, GFP_KERNEL);
Jiri Slaby6f9ea7a2012-08-07 21:47:26 +0200342 if (!ports[0] || !ports[1])
Jiri Slabyd03702a2012-06-04 13:35:30 +0200343 goto err_free_tty;
Alan Coxbf970ee2008-10-13 10:42:39 +0100344 if (!try_module_get(driver->other->owner)) {
345 /* This cannot in fact currently happen */
Jiri Slaby8a1b8d72011-03-23 10:48:33 +0100346 goto err_free_tty;
Alan Coxbf970ee2008-10-13 10:42:39 +0100347 }
348 initialize_tty_struct(o_tty, driver->other, idx);
349
Jiri Slaby5d249bc2012-06-04 13:35:29 +0200350 if (legacy) {
351 /* We always use new tty termios data so we can do this
352 the easy way .. */
353 retval = tty_init_termios(tty);
354 if (retval)
355 goto err_deinit_tty;
Alan Coxbf970ee2008-10-13 10:42:39 +0100356
Jiri Slaby5d249bc2012-06-04 13:35:29 +0200357 retval = tty_init_termios(o_tty);
358 if (retval)
359 goto err_free_termios;
360
361 driver->other->ttys[idx] = o_tty;
362 driver->ttys[idx] = tty;
363 } else {
Alan Coxadc8d742012-07-14 15:31:47 +0100364 memset(&tty->termios_locked, 0, sizeof(tty->termios_locked));
365 tty->termios = driver->init_termios;
366 memset(&o_tty->termios_locked, 0, sizeof(tty->termios_locked));
367 o_tty->termios = driver->other->init_termios;
Jiri Slaby5d249bc2012-06-04 13:35:29 +0200368 }
Alan Coxfe9cd962008-10-13 10:43:38 +0100369
Alan Coxbf970ee2008-10-13 10:42:39 +0100370 /*
371 * Everything allocated ... set up the o_tty structure.
372 */
Alan Coxbf970ee2008-10-13 10:42:39 +0100373 tty_driver_kref_get(driver->other);
374 if (driver->subtype == PTY_TYPE_MASTER)
375 o_tty->count++;
376 /* Establish the links in both directions */
377 tty->link = o_tty;
378 o_tty->link = tty;
Jiri Slabyd03702a2012-06-04 13:35:30 +0200379 tty_port_init(ports[0]);
380 tty_port_init(ports[1]);
381 o_tty->port = ports[0];
382 tty->port = ports[1];
Jiri Slaby967fab62012-10-18 22:26:46 +0200383 o_tty->port->itty = o_tty;
Alan Coxbf970ee2008-10-13 10:42:39 +0100384
385 tty_driver_kref_get(driver);
386 tty->count++;
Alan Coxbf970ee2008-10-13 10:42:39 +0100387 return 0;
Jiri Slaby8a1b8d72011-03-23 10:48:33 +0100388err_free_termios:
Jiri Slaby5d249bc2012-06-04 13:35:29 +0200389 if (legacy)
390 tty_free_termios(tty);
Jiri Slabya9dccdd2011-03-23 10:48:36 +0100391err_deinit_tty:
392 deinitialize_tty_struct(o_tty);
Alan Coxbf970ee2008-10-13 10:42:39 +0100393 module_put(o_tty->driver->owner);
Jiri Slaby8a1b8d72011-03-23 10:48:33 +0100394err_free_tty:
Jiri Slabyd03702a2012-06-04 13:35:30 +0200395 kfree(ports[0]);
396 kfree(ports[1]);
Alan Coxbf970ee2008-10-13 10:42:39 +0100397 free_tty_struct(o_tty);
Jiri Slaby6f9ea7a2012-08-07 21:47:26 +0200398err:
Jiri Slaby8a1b8d72011-03-23 10:48:33 +0100399 return retval;
Alan Coxbf970ee2008-10-13 10:42:39 +0100400}
401
Jiri Slabyfa2ecfc5a2012-10-18 22:26:31 +0200402/* this is called once with whichever end is closed last */
403static void pty_unix98_shutdown(struct tty_struct *tty)
404{
405 devpts_kill_index(tty->driver_data, tty->index);
406}
407
Jiri Slabyd03702a2012-06-04 13:35:30 +0200408static void pty_cleanup(struct tty_struct *tty)
409{
Jiri Slaby967fab62012-10-18 22:26:46 +0200410 tty->port->itty = NULL;
Jiri Slaby81c79832012-11-15 09:49:49 +0100411 tty_port_put(tty->port);
Jiri Slabyd03702a2012-06-04 13:35:30 +0200412}
413
Jiri Slaby5d249bc2012-06-04 13:35:29 +0200414/* Traditional BSD devices */
415#ifdef CONFIG_LEGACY_PTYS
416
417static int pty_install(struct tty_driver *driver, struct tty_struct *tty)
418{
419 return pty_common_install(driver, tty, true);
420}
421
Alan Coxd1552552012-07-27 18:02:54 +0100422static void pty_remove(struct tty_driver *driver, struct tty_struct *tty)
423{
424 struct tty_struct *pair = tty->link;
425 driver->ttys[tty->index] = NULL;
426 if (pair)
427 pair->driver->ttys[pair->index] = NULL;
428}
429
Alan Cox6caa76b2011-02-14 16:27:22 +0000430static int pty_bsd_ioctl(struct tty_struct *tty,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700431 unsigned int cmd, unsigned long arg)
432{
433 switch (cmd) {
434 case TIOCSPTLCK: /* Set PT Lock (disallow slave open) */
435 return pty_set_lock(tty, (int __user *) arg);
Cyrill Gorcunov84fd7bd2012-10-24 23:43:22 +0400436 case TIOCGPTLCK: /* Get PT Lock status */
437 return pty_get_lock(tty, (int __user *)arg);
Cyrill Gorcunov06026d92012-10-24 23:43:20 +0400438 case TIOCPKT: /* Set PT packet mode */
439 return pty_set_pktmode(tty, (int __user *)arg);
Cyrill Gorcunov84fd7bd2012-10-24 23:43:22 +0400440 case TIOCGPKT: /* Get PT packet mode */
441 return pty_get_pktmode(tty, (int __user *)arg);
hyc@symas.com26df6d12010-06-22 10:14:49 -0700442 case TIOCSIG: /* Send signal to other side of pty */
443 return pty_signal(tty, (int) arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700444 }
445 return -ENOIOCTLCMD;
446}
447
Kay Sieversdc8c8582007-08-15 12:25:38 +0200448static int legacy_count = CONFIG_LEGACY_PTY_COUNT;
449module_param(legacy_count, int, 0);
450
Linus Torvalds342a5972009-09-30 07:49:40 -0700451/*
452 * The master side of a pty can do TIOCSPTLCK and thus
453 * has pty_bsd_ioctl.
454 */
455static const struct tty_operations master_pty_ops_bsd = {
456 .install = pty_install,
Alan Cox3e8e88c2008-04-30 00:54:10 -0700457 .open = pty_open,
458 .close = pty_close,
459 .write = pty_write,
460 .write_room = pty_write_room,
461 .flush_buffer = pty_flush_buffer,
462 .chars_in_buffer = pty_chars_in_buffer,
463 .unthrottle = pty_unthrottle,
464 .set_termios = pty_set_termios,
465 .ioctl = pty_bsd_ioctl,
Jiri Slabyd03702a2012-06-04 13:35:30 +0200466 .cleanup = pty_cleanup,
Alan Coxd1552552012-07-27 18:02:54 +0100467 .resize = pty_resize,
468 .remove = pty_remove
Alan Cox3e8e88c2008-04-30 00:54:10 -0700469};
470
Linus Torvalds342a5972009-09-30 07:49:40 -0700471static const struct tty_operations slave_pty_ops_bsd = {
472 .install = pty_install,
473 .open = pty_open,
474 .close = pty_close,
475 .write = pty_write,
476 .write_room = pty_write_room,
477 .flush_buffer = pty_flush_buffer,
478 .chars_in_buffer = pty_chars_in_buffer,
479 .unthrottle = pty_unthrottle,
480 .set_termios = pty_set_termios,
Jiri Slabyd03702a2012-06-04 13:35:30 +0200481 .cleanup = pty_cleanup,
Alan Coxd1552552012-07-27 18:02:54 +0100482 .resize = pty_resize,
483 .remove = pty_remove
Linus Torvalds342a5972009-09-30 07:49:40 -0700484};
485
Linus Torvalds1da177e2005-04-16 15:20:36 -0700486static void __init legacy_pty_init(void)
487{
Linus Torvalds342a5972009-09-30 07:49:40 -0700488 struct tty_driver *pty_driver, *pty_slave_driver;
489
Kay Sieversdc8c8582007-08-15 12:25:38 +0200490 if (legacy_count <= 0)
491 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700492
Jiri Slaby21aca2f2012-08-08 22:26:41 +0200493 pty_driver = tty_alloc_driver(legacy_count,
494 TTY_DRIVER_RESET_TERMIOS |
495 TTY_DRIVER_REAL_RAW |
496 TTY_DRIVER_DYNAMIC_ALLOC);
Dan Carpenterc3a63442012-08-16 16:16:56 +0300497 if (IS_ERR(pty_driver))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700498 panic("Couldn't allocate pty driver");
499
Jiri Slaby21aca2f2012-08-08 22:26:41 +0200500 pty_slave_driver = tty_alloc_driver(legacy_count,
501 TTY_DRIVER_RESET_TERMIOS |
502 TTY_DRIVER_REAL_RAW |
503 TTY_DRIVER_DYNAMIC_ALLOC);
Dan Carpenterc3a63442012-08-16 16:16:56 +0300504 if (IS_ERR(pty_slave_driver))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700505 panic("Couldn't allocate pty slave driver");
506
Linus Torvalds1da177e2005-04-16 15:20:36 -0700507 pty_driver->driver_name = "pty_master";
508 pty_driver->name = "pty";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700509 pty_driver->major = PTY_MASTER_MAJOR;
510 pty_driver->minor_start = 0;
511 pty_driver->type = TTY_DRIVER_TYPE_PTY;
512 pty_driver->subtype = PTY_TYPE_MASTER;
513 pty_driver->init_termios = tty_std_termios;
514 pty_driver->init_termios.c_iflag = 0;
515 pty_driver->init_termios.c_oflag = 0;
516 pty_driver->init_termios.c_cflag = B38400 | CS8 | CREAD;
517 pty_driver->init_termios.c_lflag = 0;
Alan Cox606d0992006-12-08 02:38:45 -0800518 pty_driver->init_termios.c_ispeed = 38400;
519 pty_driver->init_termios.c_ospeed = 38400;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700520 pty_driver->other = pty_slave_driver;
Linus Torvalds342a5972009-09-30 07:49:40 -0700521 tty_set_operations(pty_driver, &master_pty_ops_bsd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700522
Linus Torvalds1da177e2005-04-16 15:20:36 -0700523 pty_slave_driver->driver_name = "pty_slave";
524 pty_slave_driver->name = "ttyp";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700525 pty_slave_driver->major = PTY_SLAVE_MAJOR;
526 pty_slave_driver->minor_start = 0;
527 pty_slave_driver->type = TTY_DRIVER_TYPE_PTY;
528 pty_slave_driver->subtype = PTY_TYPE_SLAVE;
529 pty_slave_driver->init_termios = tty_std_termios;
530 pty_slave_driver->init_termios.c_cflag = B38400 | CS8 | CREAD;
Alan Cox606d0992006-12-08 02:38:45 -0800531 pty_slave_driver->init_termios.c_ispeed = 38400;
532 pty_slave_driver->init_termios.c_ospeed = 38400;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700533 pty_slave_driver->other = pty_driver;
Linus Torvalds342a5972009-09-30 07:49:40 -0700534 tty_set_operations(pty_slave_driver, &slave_pty_ops_bsd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700535
536 if (tty_register_driver(pty_driver))
537 panic("Couldn't register pty driver");
538 if (tty_register_driver(pty_slave_driver))
539 panic("Couldn't register pty slave driver");
540}
541#else
542static inline void legacy_pty_init(void) { }
543#endif
544
545/* Unix98 devices */
546#ifdef CONFIG_UNIX98_PTYS
Linus Torvalds1da177e2005-04-16 15:20:36 -0700547
Alan Coxd81ed102008-10-13 10:41:42 +0100548static struct cdev ptmx_cdev;
549
Alan Cox6caa76b2011-02-14 16:27:22 +0000550static int pty_unix98_ioctl(struct tty_struct *tty,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700551 unsigned int cmd, unsigned long arg)
552{
553 switch (cmd) {
554 case TIOCSPTLCK: /* Set PT Lock (disallow slave open) */
555 return pty_set_lock(tty, (int __user *)arg);
Cyrill Gorcunov84fd7bd2012-10-24 23:43:22 +0400556 case TIOCGPTLCK: /* Get PT Lock status */
557 return pty_get_lock(tty, (int __user *)arg);
Cyrill Gorcunov06026d92012-10-24 23:43:20 +0400558 case TIOCPKT: /* Set PT packet mode */
559 return pty_set_pktmode(tty, (int __user *)arg);
Cyrill Gorcunov84fd7bd2012-10-24 23:43:22 +0400560 case TIOCGPKT: /* Get PT packet mode */
561 return pty_get_pktmode(tty, (int __user *)arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700562 case TIOCGPTN: /* Get PT Number */
563 return put_user(tty->index, (unsigned int __user *)arg);
hyc@symas.com26df6d12010-06-22 10:14:49 -0700564 case TIOCSIG: /* Send signal to other side of pty */
565 return pty_signal(tty, (int) arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700566 }
567
568 return -ENOIOCTLCMD;
569}
570
Alan Cox99f1fe12008-10-13 10:42:00 +0100571/**
572 * ptm_unix98_lookup - find a pty master
573 * @driver: ptm driver
574 * @idx: tty index
575 *
576 * Look up a pty master device. Called under the tty_mutex for now.
577 * This provides our locking.
578 */
579
Sukadev Bhattiprolu15f1a632008-10-13 10:42:59 +0100580static struct tty_struct *ptm_unix98_lookup(struct tty_driver *driver,
581 struct inode *ptm_inode, int idx)
Alan Cox99f1fe12008-10-13 10:42:00 +0100582{
Konstantin Khlebnikov593a27c2012-01-05 13:04:21 +0400583 /* Master must be open via /dev/ptmx */
584 return ERR_PTR(-EIO);
Alan Cox99f1fe12008-10-13 10:42:00 +0100585}
586
587/**
588 * pts_unix98_lookup - find a pty slave
589 * @driver: pts driver
590 * @idx: tty index
591 *
592 * Look up a pty master device. Called under the tty_mutex for now.
Alan Coxd739e652012-05-03 22:22:09 +0100593 * This provides our locking for the tty pointer.
Alan Cox99f1fe12008-10-13 10:42:00 +0100594 */
595
Sukadev Bhattiprolu15f1a632008-10-13 10:42:59 +0100596static struct tty_struct *pts_unix98_lookup(struct tty_driver *driver,
597 struct inode *pts_inode, int idx)
Alan Cox99f1fe12008-10-13 10:42:00 +0100598{
Alan Coxd739e652012-05-03 22:22:09 +0100599 struct tty_struct *tty;
600
601 mutex_lock(&devpts_mutex);
Jiri Slaby8fcbaa22012-10-18 22:26:27 +0200602 tty = devpts_get_priv(pts_inode);
Alan Coxd739e652012-05-03 22:22:09 +0100603 mutex_unlock(&devpts_mutex);
Alan Cox99f1fe12008-10-13 10:42:00 +0100604 /* Master must be open before slave */
605 if (!tty)
606 return ERR_PTR(-EIO);
607 return tty;
608}
609
Alan Cox8b0a88d2008-10-13 10:42:19 +0100610/* We have no need to install and remove our tty objects as devpts does all
611 the work for us */
612
Alan Coxbf970ee2008-10-13 10:42:39 +0100613static int pty_unix98_install(struct tty_driver *driver, struct tty_struct *tty)
Alan Cox8b0a88d2008-10-13 10:42:19 +0100614{
Jiri Slaby5d249bc2012-06-04 13:35:29 +0200615 return pty_common_install(driver, tty, false);
Alan Cox8b0a88d2008-10-13 10:42:19 +0100616}
617
Jiri Slaby71716042012-06-04 13:35:28 +0200618static void pty_unix98_remove(struct tty_driver *driver, struct tty_struct *tty)
Jiri Slaby484af542011-11-16 16:27:11 +0100619{
Alan Cox8b0a88d2008-10-13 10:42:19 +0100620}
621
Alan Coxfeebed62008-10-13 10:41:30 +0100622static const struct tty_operations ptm_unix98_ops = {
Alan Cox99f1fe12008-10-13 10:42:00 +0100623 .lookup = ptm_unix98_lookup,
Alan Coxbf970ee2008-10-13 10:42:39 +0100624 .install = pty_unix98_install,
Jiri Slaby71716042012-06-04 13:35:28 +0200625 .remove = pty_unix98_remove,
Alan Cox3e8e88c2008-04-30 00:54:10 -0700626 .open = pty_open,
627 .close = pty_close,
628 .write = pty_write,
629 .write_room = pty_write_room,
630 .flush_buffer = pty_flush_buffer,
631 .chars_in_buffer = pty_chars_in_buffer,
632 .unthrottle = pty_unthrottle,
633 .set_termios = pty_set_termios,
Alan Coxfeebed62008-10-13 10:41:30 +0100634 .ioctl = pty_unix98_ioctl,
Alan Cox36b3c072012-07-17 17:06:57 +0100635 .resize = pty_resize,
Jiri Slabyfa2ecfc5a2012-10-18 22:26:31 +0200636 .shutdown = pty_unix98_shutdown,
Alan Cox36b3c072012-07-17 17:06:57 +0100637 .cleanup = pty_cleanup
Alan Cox3e8e88c2008-04-30 00:54:10 -0700638};
639
Alan Cox99f1fe12008-10-13 10:42:00 +0100640static const struct tty_operations pty_unix98_ops = {
641 .lookup = pts_unix98_lookup,
Alan Coxbf970ee2008-10-13 10:42:39 +0100642 .install = pty_unix98_install,
Jiri Slaby71716042012-06-04 13:35:28 +0200643 .remove = pty_unix98_remove,
Alan Cox99f1fe12008-10-13 10:42:00 +0100644 .open = pty_open,
645 .close = pty_close,
646 .write = pty_write,
647 .write_room = pty_write_room,
648 .flush_buffer = pty_flush_buffer,
649 .chars_in_buffer = pty_chars_in_buffer,
650 .unthrottle = pty_unthrottle,
651 .set_termios = pty_set_termios,
Jiri Slabyfa2ecfc5a2012-10-18 22:26:31 +0200652 .shutdown = pty_unix98_shutdown,
Jiri Slabyd03702a2012-06-04 13:35:30 +0200653 .cleanup = pty_cleanup,
Alan Cox99f1fe12008-10-13 10:42:00 +0100654};
Alan Coxd81ed102008-10-13 10:41:42 +0100655
656/**
657 * ptmx_open - open a unix 98 pty master
658 * @inode: inode of device file
659 * @filp: file pointer to tty
660 *
661 * Allocate a unix98 pty master device from the ptmx driver.
662 *
663 * Locking: tty_mutex protects the init_dev work. tty->count should
664 * protect the rest.
665 * allocated_ptys_lock handles the list of free pty numbers
666 */
667
Arnd Bergmann64ba3dc32010-06-01 22:53:02 +0200668static int ptmx_open(struct inode *inode, struct file *filp)
Alan Coxd81ed102008-10-13 10:41:42 +0100669{
670 struct tty_struct *tty;
Jiri Slaby162b97c2012-10-18 22:26:28 +0200671 struct inode *slave_inode;
Alan Coxd81ed102008-10-13 10:41:42 +0100672 int retval;
673 int index;
674
675 nonseekable_open(inode, filp);
676
Jiri Slabyfa90e1c2011-10-12 11:32:43 +0200677 retval = tty_alloc_file(filp);
678 if (retval)
679 return retval;
680
Alan Coxd81ed102008-10-13 10:41:42 +0100681 /* find a device that is not in use. */
Alan Cox89c8d912012-08-08 16:30:13 +0100682 mutex_lock(&devpts_mutex);
Sukadev Bhattiprolu15f1a632008-10-13 10:42:59 +0100683 index = devpts_new_index(inode);
Jiri Slabyfa90e1c2011-10-12 11:32:43 +0200684 if (index < 0) {
685 retval = index;
Alan Cox05fb79e2012-09-19 15:34:47 +0100686 mutex_unlock(&devpts_mutex);
Jiri Slabyfa90e1c2011-10-12 11:32:43 +0200687 goto err_file;
688 }
Alan Coxd81ed102008-10-13 10:41:42 +0100689
Alan Cox6d31a882012-07-14 15:31:27 +0100690 mutex_unlock(&devpts_mutex);
Alan Cox89c8d912012-08-08 16:30:13 +0100691
692 mutex_lock(&tty_mutex);
693 tty = tty_init_dev(ptm_driver, index);
Alan Coxd81ed102008-10-13 10:41:42 +0100694
Alan Cox73ec06f2008-10-13 10:42:29 +0100695 if (IS_ERR(tty)) {
696 retval = PTR_ERR(tty);
Alan Coxd81ed102008-10-13 10:41:42 +0100697 goto out;
Alan Cox73ec06f2008-10-13 10:42:29 +0100698 }
Alan Coxd81ed102008-10-13 10:41:42 +0100699
Alan Cox89c8d912012-08-08 16:30:13 +0100700 /* The tty returned here is locked so we can safely
701 drop the mutex */
702 mutex_unlock(&tty_mutex);
703
Alan Coxd81ed102008-10-13 10:41:42 +0100704 set_bit(TTY_PTY_LOCK, &tty->flags); /* LOCK THE SLAVE */
Nick Pigginee2ffa02010-08-18 04:37:35 +1000705
Jiri Slabyfa90e1c2011-10-12 11:32:43 +0200706 tty_add_file(tty, filp);
Alan Coxd81ed102008-10-13 10:41:42 +0100707
Jiri Slabyf11afb62012-10-18 22:26:29 +0200708 slave_inode = devpts_pty_new(inode,
709 MKDEV(UNIX98_PTY_SLAVE_MAJOR, index), index,
710 tty->link);
Jiri Slaby162b97c2012-10-18 22:26:28 +0200711 if (IS_ERR(slave_inode)) {
712 retval = PTR_ERR(slave_inode);
Jiri Slaby1177c0e2011-10-12 11:32:44 +0200713 goto err_release;
Jiri Slaby162b97c2012-10-18 22:26:28 +0200714 }
Alan Coxd81ed102008-10-13 10:41:42 +0100715
716 retval = ptm_driver->ops->open(tty, filp);
Arnd Bergmann64ba3dc32010-06-01 22:53:02 +0200717 if (retval)
Jiri Slaby1177c0e2011-10-12 11:32:44 +0200718 goto err_release;
719
Alan Cox89c8d912012-08-08 16:30:13 +0100720 tty_unlock(tty);
Jiri Slabyfa2ecfc5a2012-10-18 22:26:31 +0200721 tty->driver_data = inode;
Jiri Slabyf11afb62012-10-18 22:26:29 +0200722 tty->link->driver_data = slave_inode;
Jiri Slaby1177c0e2011-10-12 11:32:44 +0200723 return 0;
724err_release:
Alan Cox89c8d912012-08-08 16:30:13 +0100725 tty_unlock(tty);
Alan Coxeeb89d92009-11-30 13:18:29 +0000726 tty_release(inode, filp);
Alan Coxd81ed102008-10-13 10:41:42 +0100727 return retval;
728out:
Alan Cox89c8d912012-08-08 16:30:13 +0100729 mutex_unlock(&tty_mutex);
Jiri Slabyd3bda522012-01-30 21:14:32 +0100730 devpts_kill_index(inode, index);
Jiri Slabyfa90e1c2011-10-12 11:32:43 +0200731err_file:
732 tty_free_file(filp);
Arnd Bergmann64ba3dc32010-06-01 22:53:02 +0200733 return retval;
Alan Coxd81ed102008-10-13 10:41:42 +0100734}
735
736static struct file_operations ptmx_fops;
737
Linus Torvalds1da177e2005-04-16 15:20:36 -0700738static void __init unix98_pty_init(void)
739{
Jiri Slaby21aca2f2012-08-08 22:26:41 +0200740 ptm_driver = tty_alloc_driver(NR_UNIX98_PTY_MAX,
741 TTY_DRIVER_RESET_TERMIOS |
742 TTY_DRIVER_REAL_RAW |
743 TTY_DRIVER_DYNAMIC_DEV |
744 TTY_DRIVER_DEVPTS_MEM |
745 TTY_DRIVER_DYNAMIC_ALLOC);
Dan Carpenterc3a63442012-08-16 16:16:56 +0300746 if (IS_ERR(ptm_driver))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700747 panic("Couldn't allocate Unix98 ptm driver");
Jiri Slaby21aca2f2012-08-08 22:26:41 +0200748 pts_driver = tty_alloc_driver(NR_UNIX98_PTY_MAX,
749 TTY_DRIVER_RESET_TERMIOS |
750 TTY_DRIVER_REAL_RAW |
751 TTY_DRIVER_DYNAMIC_DEV |
752 TTY_DRIVER_DEVPTS_MEM |
753 TTY_DRIVER_DYNAMIC_ALLOC);
Dan Carpenterc3a63442012-08-16 16:16:56 +0300754 if (IS_ERR(pts_driver))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700755 panic("Couldn't allocate Unix98 pts driver");
756
Linus Torvalds1da177e2005-04-16 15:20:36 -0700757 ptm_driver->driver_name = "pty_master";
758 ptm_driver->name = "ptm";
759 ptm_driver->major = UNIX98_PTY_MASTER_MAJOR;
760 ptm_driver->minor_start = 0;
761 ptm_driver->type = TTY_DRIVER_TYPE_PTY;
762 ptm_driver->subtype = PTY_TYPE_MASTER;
763 ptm_driver->init_termios = tty_std_termios;
764 ptm_driver->init_termios.c_iflag = 0;
765 ptm_driver->init_termios.c_oflag = 0;
766 ptm_driver->init_termios.c_cflag = B38400 | CS8 | CREAD;
767 ptm_driver->init_termios.c_lflag = 0;
Alan Cox606d0992006-12-08 02:38:45 -0800768 ptm_driver->init_termios.c_ispeed = 38400;
769 ptm_driver->init_termios.c_ospeed = 38400;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700770 ptm_driver->other = pts_driver;
Alan Coxfeebed62008-10-13 10:41:30 +0100771 tty_set_operations(ptm_driver, &ptm_unix98_ops);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700772
Linus Torvalds1da177e2005-04-16 15:20:36 -0700773 pts_driver->driver_name = "pty_slave";
774 pts_driver->name = "pts";
775 pts_driver->major = UNIX98_PTY_SLAVE_MAJOR;
776 pts_driver->minor_start = 0;
777 pts_driver->type = TTY_DRIVER_TYPE_PTY;
778 pts_driver->subtype = PTY_TYPE_SLAVE;
779 pts_driver->init_termios = tty_std_termios;
780 pts_driver->init_termios.c_cflag = B38400 | CS8 | CREAD;
Alan Cox606d0992006-12-08 02:38:45 -0800781 pts_driver->init_termios.c_ispeed = 38400;
782 pts_driver->init_termios.c_ospeed = 38400;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700783 pts_driver->other = ptm_driver;
Alan Cox99f1fe12008-10-13 10:42:00 +0100784 tty_set_operations(pts_driver, &pty_unix98_ops);
Alan Coxfe9cd962008-10-13 10:43:38 +0100785
Linus Torvalds1da177e2005-04-16 15:20:36 -0700786 if (tty_register_driver(ptm_driver))
787 panic("Couldn't register Unix98 ptm driver");
788 if (tty_register_driver(pts_driver))
789 panic("Couldn't register Unix98 pts driver");
790
Alan Coxd81ed102008-10-13 10:41:42 +0100791 /* Now create the /dev/ptmx special device */
792 tty_default_fops(&ptmx_fops);
793 ptmx_fops.open = ptmx_open;
794
795 cdev_init(&ptmx_cdev, &ptmx_fops);
796 if (cdev_add(&ptmx_cdev, MKDEV(TTYAUX_MAJOR, 2), 1) ||
797 register_chrdev_region(MKDEV(TTYAUX_MAJOR, 2), 1, "/dev/ptmx") < 0)
798 panic("Couldn't register /dev/ptmx driver\n");
799 device_create(tty_class, NULL, MKDEV(TTYAUX_MAJOR, 2), NULL, "ptmx");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700800}
Alan Coxd81ed102008-10-13 10:41:42 +0100801
Linus Torvalds1da177e2005-04-16 15:20:36 -0700802#else
803static inline void unix98_pty_init(void) { }
804#endif
805
806static int __init pty_init(void)
807{
808 legacy_pty_init();
809 unix98_pty_init();
810 return 0;
811}
812module_init(pty_init);