blob: fd182f2e4a6cf0c030ae85b3cd4e3bccba6ff441 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * linux/drivers/char/tty_io.c
3 *
4 * Copyright (C) 1991, 1992 Linus Torvalds
5 */
6
7/*
8 * 'tty_io.c' gives an orthogonal feeling to tty's, be they consoles
9 * or rs-channels. It also implements echoing, cooked mode etc.
10 *
11 * Kill-line thanks to John T Kohl, who also corrected VMIN = VTIME = 0.
12 *
13 * Modified by Theodore Ts'o, 9/14/92, to dynamically allocate the
14 * tty_struct and tty_queue structures. Previously there was an array
15 * of 256 tty_struct's which was statically allocated, and the
16 * tty_queue structures were allocated at boot time. Both are now
17 * dynamically allocated only when the tty is open.
18 *
19 * Also restructured routines so that there is more of a separation
20 * between the high-level tty routines (tty_io.c and tty_ioctl.c) and
21 * the low-level tty routines (serial.c, pty.c, console.c). This
Alan Cox37bdfb02008-02-08 04:18:47 -080022 * makes for cleaner and more compact code. -TYT, 9/17/92
Linus Torvalds1da177e2005-04-16 15:20:36 -070023 *
24 * Modified by Fred N. van Kempen, 01/29/93, to add line disciplines
25 * which can be dynamically activated and de-activated by the line
26 * discipline handling modules (like SLIP).
27 *
28 * NOTE: pay no attention to the line discipline code (yet); its
29 * interface is still subject to change in this version...
30 * -- TYT, 1/31/92
31 *
32 * Added functionality to the OPOST tty handling. No delays, but all
33 * other bits should be there.
34 * -- Nick Holloway <alfie@dcs.warwick.ac.uk>, 27th May 1993.
35 *
36 * Rewrote canonical mode and added more termios flags.
37 * -- julian@uhunix.uhcc.hawaii.edu (J. Cowley), 13Jan94
38 *
39 * Reorganized FASYNC support so mouse code can share it.
40 * -- ctm@ardi.com, 9Sep95
41 *
42 * New TIOCLINUX variants added.
43 * -- mj@k332.feld.cvut.cz, 19-Nov-95
Alan Cox37bdfb02008-02-08 04:18:47 -080044 *
Linus Torvalds1da177e2005-04-16 15:20:36 -070045 * Restrict vt switching via ioctl()
46 * -- grif@cs.ucr.edu, 5-Dec-95
47 *
48 * Move console and virtual terminal code to more appropriate files,
49 * implement CONFIG_VT and generalize console device interface.
50 * -- Marko Kohtala <Marko.Kohtala@hut.fi>, March 97
51 *
52 * Rewrote init_dev and release_dev to eliminate races.
53 * -- Bill Hawes <whawes@star.net>, June 97
54 *
55 * Added devfs support.
56 * -- C. Scott Ananian <cananian@alumni.princeton.edu>, 13-Jan-1998
57 *
58 * Added support for a Unix98-style ptmx device.
59 * -- C. Scott Ananian <cananian@alumni.princeton.edu>, 14-Jan-1998
60 *
61 * Reduced memory usage for older ARM systems
62 * -- Russell King <rmk@arm.linux.org.uk>
63 *
64 * Move do_SAK() into process context. Less stack use in devfs functions.
Alan Cox37bdfb02008-02-08 04:18:47 -080065 * alloc_tty_struct() always uses kmalloc()
66 * -- Andrew Morton <andrewm@uow.edu.eu> 17Mar01
Linus Torvalds1da177e2005-04-16 15:20:36 -070067 */
68
Linus Torvalds1da177e2005-04-16 15:20:36 -070069#include <linux/types.h>
70#include <linux/major.h>
71#include <linux/errno.h>
72#include <linux/signal.h>
73#include <linux/fcntl.h>
74#include <linux/sched.h>
75#include <linux/interrupt.h>
76#include <linux/tty.h>
77#include <linux/tty_driver.h>
78#include <linux/tty_flip.h>
79#include <linux/devpts_fs.h>
80#include <linux/file.h>
Al Viro9f3acc32008-04-24 07:44:08 -040081#include <linux/fdtable.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070082#include <linux/console.h>
83#include <linux/timer.h>
84#include <linux/ctype.h>
85#include <linux/kd.h>
86#include <linux/mm.h>
87#include <linux/string.h>
88#include <linux/slab.h>
89#include <linux/poll.h>
90#include <linux/proc_fs.h>
91#include <linux/init.h>
92#include <linux/module.h>
93#include <linux/smp_lock.h>
94#include <linux/device.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070095#include <linux/wait.h>
96#include <linux/bitops.h>
Domen Puncerb20f3ae2005-06-25 14:58:42 -070097#include <linux/delay.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070098
99#include <asm/uaccess.h>
100#include <asm/system.h>
101
102#include <linux/kbd_kern.h>
103#include <linux/vt_kern.h>
104#include <linux/selection.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700105
106#include <linux/kmod.h>
Pavel Emelyanovb4888932007-10-18 23:40:14 -0700107#include <linux/nsproxy.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700108
109#undef TTY_DEBUG_HANGUP
110
111#define TTY_PARANOIA_CHECK 1
112#define CHECK_TTY_COUNT 1
113
Alan Coxedc6afc2006-12-08 02:38:44 -0800114struct ktermios tty_std_termios = { /* for the benefit of tty drivers */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700115 .c_iflag = ICRNL | IXON,
116 .c_oflag = OPOST | ONLCR,
117 .c_cflag = B38400 | CS8 | CREAD | HUPCL,
118 .c_lflag = ISIG | ICANON | ECHO | ECHOE | ECHOK |
119 ECHOCTL | ECHOKE | IEXTEN,
Alan Coxedc6afc2006-12-08 02:38:44 -0800120 .c_cc = INIT_C_CC,
121 .c_ispeed = 38400,
122 .c_ospeed = 38400
Linus Torvalds1da177e2005-04-16 15:20:36 -0700123};
124
125EXPORT_SYMBOL(tty_std_termios);
126
127/* This list gets poked at by procfs and various bits of boot up code. This
128 could do with some rationalisation such as pulling the tty proc function
129 into this file */
Alan Cox37bdfb02008-02-08 04:18:47 -0800130
Linus Torvalds1da177e2005-04-16 15:20:36 -0700131LIST_HEAD(tty_drivers); /* linked list of tty drivers */
132
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800133/* Mutex to protect creating and releasing a tty. This is shared with
Linus Torvalds1da177e2005-04-16 15:20:36 -0700134 vt.c for deeply disgusting hack reasons */
Ingo Molnar70522e12006-03-23 03:00:31 -0800135DEFINE_MUTEX(tty_mutex);
Alan Coxde2a84f2006-09-29 02:00:57 -0700136EXPORT_SYMBOL(tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700137
138#ifdef CONFIG_UNIX98_PTYS
139extern struct tty_driver *ptm_driver; /* Unix98 pty masters; for /dev/ptmx */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700140static int ptmx_open(struct inode *, struct file *);
141#endif
142
Linus Torvalds1da177e2005-04-16 15:20:36 -0700143static void initialize_tty_struct(struct tty_struct *tty);
144
145static ssize_t tty_read(struct file *, char __user *, size_t, loff_t *);
146static ssize_t tty_write(struct file *, const char __user *, size_t, loff_t *);
Alan Cox37bdfb02008-02-08 04:18:47 -0800147ssize_t redirected_tty_write(struct file *, const char __user *,
148 size_t, loff_t *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700149static unsigned int tty_poll(struct file *, poll_table *);
150static int tty_open(struct inode *, struct file *);
151static int tty_release(struct inode *, struct file *);
Alan Cox04f378b2008-04-30 00:53:29 -0700152long tty_ioctl(struct file *file, unsigned int cmd, unsigned long arg);
Paul Fulghume10cc1d2007-05-10 22:22:50 -0700153#ifdef CONFIG_COMPAT
Alan Cox37bdfb02008-02-08 04:18:47 -0800154static long tty_compat_ioctl(struct file *file, unsigned int cmd,
Paul Fulghume10cc1d2007-05-10 22:22:50 -0700155 unsigned long arg);
156#else
157#define tty_compat_ioctl NULL
158#endif
Alan Cox37bdfb02008-02-08 04:18:47 -0800159static int tty_fasync(int fd, struct file *filp, int on);
Christoph Hellwigd5698c22007-02-10 01:46:46 -0800160static void release_tty(struct tty_struct *tty, int idx);
Eric W. Biederman2a65f1d2007-05-08 00:26:53 -0700161static void __proc_set_tty(struct task_struct *tsk, struct tty_struct *tty);
Eric W. Biederman98a27ba2007-05-08 00:26:56 -0700162static void proc_set_tty(struct task_struct *tsk, struct tty_struct *tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700163
Alan Coxaf9b8972006-08-27 01:24:01 -0700164/**
165 * alloc_tty_struct - allocate a tty object
166 *
167 * Return a new empty tty structure. The data fields have not
168 * been initialized in any way but has been zeroed
169 *
170 * Locking: none
Alan Coxaf9b8972006-08-27 01:24:01 -0700171 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700172
173static struct tty_struct *alloc_tty_struct(void)
174{
Alan Cox1266b1e2006-09-29 02:00:40 -0700175 return kzalloc(sizeof(struct tty_struct), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700176}
177
Alan Cox33f0f882006-01-09 20:54:13 -0800178static void tty_buffer_free_all(struct tty_struct *);
179
Alan Coxaf9b8972006-08-27 01:24:01 -0700180/**
181 * free_tty_struct - free a disused tty
182 * @tty: tty struct to free
183 *
184 * Free the write buffers, tty queue and tty memory itself.
185 *
186 * Locking: none. Must be called after tty is definitely unused
187 */
188
Linus Torvalds1da177e2005-04-16 15:20:36 -0700189static inline void free_tty_struct(struct tty_struct *tty)
190{
191 kfree(tty->write_buf);
Alan Cox33f0f882006-01-09 20:54:13 -0800192 tty_buffer_free_all(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700193 kfree(tty);
194}
195
196#define TTY_NUMBER(tty) ((tty)->index + (tty)->driver->name_base)
197
Alan Coxaf9b8972006-08-27 01:24:01 -0700198/**
199 * tty_name - return tty naming
200 * @tty: tty structure
201 * @buf: buffer for output
202 *
203 * Convert a tty structure into a name. The name reflects the kernel
204 * naming policy and if udev is in use may not reflect user space
205 *
206 * Locking: none
207 */
208
Linus Torvalds1da177e2005-04-16 15:20:36 -0700209char *tty_name(struct tty_struct *tty, char *buf)
210{
211 if (!tty) /* Hmm. NULL pointer. That's fun. */
212 strcpy(buf, "NULL tty");
213 else
214 strcpy(buf, tty->name);
215 return buf;
216}
217
218EXPORT_SYMBOL(tty_name);
219
Andrew Mortond769a662005-05-05 16:15:50 -0700220int tty_paranoia_check(struct tty_struct *tty, struct inode *inode,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700221 const char *routine)
222{
223#ifdef TTY_PARANOIA_CHECK
224 if (!tty) {
225 printk(KERN_WARNING
226 "null TTY for (%d:%d) in %s\n",
227 imajor(inode), iminor(inode), routine);
228 return 1;
229 }
230 if (tty->magic != TTY_MAGIC) {
231 printk(KERN_WARNING
232 "bad magic number for tty struct (%d:%d) in %s\n",
233 imajor(inode), iminor(inode), routine);
234 return 1;
235 }
236#endif
237 return 0;
238}
239
240static int check_tty_count(struct tty_struct *tty, const char *routine)
241{
242#ifdef CHECK_TTY_COUNT
243 struct list_head *p;
244 int count = 0;
Alan Cox37bdfb02008-02-08 04:18:47 -0800245
Linus Torvalds1da177e2005-04-16 15:20:36 -0700246 file_list_lock();
247 list_for_each(p, &tty->tty_files) {
248 count++;
249 }
250 file_list_unlock();
251 if (tty->driver->type == TTY_DRIVER_TYPE_PTY &&
252 tty->driver->subtype == PTY_TYPE_SLAVE &&
253 tty->link && tty->link->count)
254 count++;
255 if (tty->count != count) {
256 printk(KERN_WARNING "Warning: dev (%s) tty->count(%d) "
257 "!= #fd's(%d) in %s\n",
258 tty->name, tty->count, count, routine);
259 return count;
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800260 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700261#endif
262 return 0;
263}
264
265/*
Alan Cox33f0f882006-01-09 20:54:13 -0800266 * Tty buffer allocation management
267 */
268
Alan Cox01da5fd2006-08-27 01:24:02 -0700269/**
270 * tty_buffer_free_all - free buffers used by a tty
271 * @tty: tty to free from
272 *
273 * Remove all the buffers pending on a tty whether queued with data
274 * or in the free ring. Must be called when the tty is no longer in use
275 *
276 * Locking: none
277 */
278
Alan Cox33f0f882006-01-09 20:54:13 -0800279static void tty_buffer_free_all(struct tty_struct *tty)
280{
281 struct tty_buffer *thead;
Alan Cox37bdfb02008-02-08 04:18:47 -0800282 while ((thead = tty->buf.head) != NULL) {
Alan Cox33f0f882006-01-09 20:54:13 -0800283 tty->buf.head = thead->next;
284 kfree(thead);
285 }
Alan Cox37bdfb02008-02-08 04:18:47 -0800286 while ((thead = tty->buf.free) != NULL) {
Alan Cox33f0f882006-01-09 20:54:13 -0800287 tty->buf.free = thead->next;
288 kfree(thead);
289 }
290 tty->buf.tail = NULL;
Alan Cox01da5fd2006-08-27 01:24:02 -0700291 tty->buf.memory_used = 0;
Alan Cox33f0f882006-01-09 20:54:13 -0800292}
293
Alan Cox01da5fd2006-08-27 01:24:02 -0700294/**
295 * tty_buffer_init - prepare a tty buffer structure
296 * @tty: tty to initialise
297 *
298 * Set up the initial state of the buffer management for a tty device.
299 * Must be called before the other tty buffer functions are used.
300 *
301 * Locking: none
302 */
303
Alan Cox33f0f882006-01-09 20:54:13 -0800304static void tty_buffer_init(struct tty_struct *tty)
305{
Paul Fulghum808249c2006-02-03 03:04:41 -0800306 spin_lock_init(&tty->buf.lock);
Alan Cox33f0f882006-01-09 20:54:13 -0800307 tty->buf.head = NULL;
308 tty->buf.tail = NULL;
309 tty->buf.free = NULL;
Alan Cox01da5fd2006-08-27 01:24:02 -0700310 tty->buf.memory_used = 0;
Alan Cox33f0f882006-01-09 20:54:13 -0800311}
312
Alan Cox01da5fd2006-08-27 01:24:02 -0700313/**
314 * tty_buffer_alloc - allocate a tty buffer
315 * @tty: tty device
316 * @size: desired size (characters)
317 *
318 * Allocate a new tty buffer to hold the desired number of characters.
319 * Return NULL if out of memory or the allocation would exceed the
320 * per device queue
321 *
322 * Locking: Caller must hold tty->buf.lock
323 */
324
325static struct tty_buffer *tty_buffer_alloc(struct tty_struct *tty, size_t size)
Alan Cox33f0f882006-01-09 20:54:13 -0800326{
Alan Cox01da5fd2006-08-27 01:24:02 -0700327 struct tty_buffer *p;
328
329 if (tty->buf.memory_used + size > 65536)
330 return NULL;
331 p = kmalloc(sizeof(struct tty_buffer) + 2 * size, GFP_ATOMIC);
Alan Cox37bdfb02008-02-08 04:18:47 -0800332 if (p == NULL)
Alan Cox33f0f882006-01-09 20:54:13 -0800333 return NULL;
334 p->used = 0;
335 p->size = size;
336 p->next = NULL;
Paul Fulghum8977d922006-02-10 01:51:14 -0800337 p->commit = 0;
338 p->read = 0;
Alan Cox33f0f882006-01-09 20:54:13 -0800339 p->char_buf_ptr = (char *)(p->data);
340 p->flag_buf_ptr = (unsigned char *)p->char_buf_ptr + size;
Alan Cox01da5fd2006-08-27 01:24:02 -0700341 tty->buf.memory_used += size;
Alan Cox33f0f882006-01-09 20:54:13 -0800342 return p;
343}
344
Alan Cox01da5fd2006-08-27 01:24:02 -0700345/**
346 * tty_buffer_free - free a tty buffer
347 * @tty: tty owning the buffer
348 * @b: the buffer to free
349 *
350 * Free a tty buffer, or add it to the free list according to our
351 * internal strategy
352 *
353 * Locking: Caller must hold tty->buf.lock
354 */
Alan Cox33f0f882006-01-09 20:54:13 -0800355
356static void tty_buffer_free(struct tty_struct *tty, struct tty_buffer *b)
357{
358 /* Dumb strategy for now - should keep some stats */
Alan Cox01da5fd2006-08-27 01:24:02 -0700359 tty->buf.memory_used -= b->size;
360 WARN_ON(tty->buf.memory_used < 0);
361
Alan Cox37bdfb02008-02-08 04:18:47 -0800362 if (b->size >= 512)
Alan Cox33f0f882006-01-09 20:54:13 -0800363 kfree(b);
364 else {
365 b->next = tty->buf.free;
366 tty->buf.free = b;
367 }
368}
369
Alan Cox01da5fd2006-08-27 01:24:02 -0700370/**
Alan Cox42fd5522007-08-10 13:01:05 -0700371 * __tty_buffer_flush - flush full tty buffers
372 * @tty: tty to flush
373 *
374 * flush all the buffers containing receive data. Caller must
375 * hold the buffer lock and must have ensured no parallel flush to
376 * ldisc is running.
377 *
378 * Locking: Caller must hold tty->buf.lock
379 */
380
381static void __tty_buffer_flush(struct tty_struct *tty)
382{
383 struct tty_buffer *thead;
384
Alan Cox37bdfb02008-02-08 04:18:47 -0800385 while ((thead = tty->buf.head) != NULL) {
Alan Cox42fd5522007-08-10 13:01:05 -0700386 tty->buf.head = thead->next;
387 tty_buffer_free(tty, thead);
388 }
389 tty->buf.tail = NULL;
390}
391
392/**
Paul Fulghumc5c34d42007-05-12 10:36:55 -0700393 * tty_buffer_flush - flush full tty buffers
394 * @tty: tty to flush
395 *
Alan Cox42fd5522007-08-10 13:01:05 -0700396 * flush all the buffers containing receive data. If the buffer is
397 * being processed by flush_to_ldisc then we defer the processing
398 * to that function
Paul Fulghumc5c34d42007-05-12 10:36:55 -0700399 *
400 * Locking: none
401 */
402
403static void tty_buffer_flush(struct tty_struct *tty)
404{
Paul Fulghumc5c34d42007-05-12 10:36:55 -0700405 unsigned long flags;
Paul Fulghumc5c34d42007-05-12 10:36:55 -0700406 spin_lock_irqsave(&tty->buf.lock, flags);
Alan Cox42fd5522007-08-10 13:01:05 -0700407
408 /* If the data is being pushed to the tty layer then we can't
409 process it here. Instead set a flag and the flush_to_ldisc
410 path will process the flush request before it exits */
411 if (test_bit(TTY_FLUSHING, &tty->flags)) {
412 set_bit(TTY_FLUSHPENDING, &tty->flags);
413 spin_unlock_irqrestore(&tty->buf.lock, flags);
414 wait_event(tty->read_wait,
415 test_bit(TTY_FLUSHPENDING, &tty->flags) == 0);
416 return;
417 } else
418 __tty_buffer_flush(tty);
Paul Fulghumc5c34d42007-05-12 10:36:55 -0700419 spin_unlock_irqrestore(&tty->buf.lock, flags);
420}
421
422/**
Alan Cox01da5fd2006-08-27 01:24:02 -0700423 * tty_buffer_find - find a free tty buffer
424 * @tty: tty owning the buffer
425 * @size: characters wanted
426 *
427 * Locate an existing suitable tty buffer or if we are lacking one then
428 * allocate a new one. We round our buffers off in 256 character chunks
429 * to get better allocation behaviour.
430 *
431 * Locking: Caller must hold tty->buf.lock
432 */
433
Alan Cox33f0f882006-01-09 20:54:13 -0800434static struct tty_buffer *tty_buffer_find(struct tty_struct *tty, size_t size)
435{
436 struct tty_buffer **tbh = &tty->buf.free;
Alan Cox37bdfb02008-02-08 04:18:47 -0800437 while ((*tbh) != NULL) {
Alan Cox33f0f882006-01-09 20:54:13 -0800438 struct tty_buffer *t = *tbh;
Alan Cox37bdfb02008-02-08 04:18:47 -0800439 if (t->size >= size) {
Alan Cox33f0f882006-01-09 20:54:13 -0800440 *tbh = t->next;
441 t->next = NULL;
442 t->used = 0;
Paul Fulghum8977d922006-02-10 01:51:14 -0800443 t->commit = 0;
444 t->read = 0;
Alan Cox01da5fd2006-08-27 01:24:02 -0700445 tty->buf.memory_used += t->size;
Alan Cox33f0f882006-01-09 20:54:13 -0800446 return t;
447 }
448 tbh = &((*tbh)->next);
449 }
450 /* Round the buffer size out */
Alan Cox37bdfb02008-02-08 04:18:47 -0800451 size = (size + 0xFF) & ~0xFF;
Alan Cox01da5fd2006-08-27 01:24:02 -0700452 return tty_buffer_alloc(tty, size);
Alan Cox33f0f882006-01-09 20:54:13 -0800453 /* Should possibly check if this fails for the largest buffer we
454 have queued and recycle that ? */
455}
456
Alan Cox01da5fd2006-08-27 01:24:02 -0700457/**
458 * tty_buffer_request_room - grow tty buffer if needed
459 * @tty: tty structure
460 * @size: size desired
461 *
462 * Make at least size bytes of linear space available for the tty
463 * buffer. If we fail return the size we managed to find.
464 *
465 * Locking: Takes tty->buf.lock
466 */
Alan Cox33f0f882006-01-09 20:54:13 -0800467int tty_buffer_request_room(struct tty_struct *tty, size_t size)
468{
Paul Fulghum808249c2006-02-03 03:04:41 -0800469 struct tty_buffer *b, *n;
470 int left;
471 unsigned long flags;
472
473 spin_lock_irqsave(&tty->buf.lock, flags);
Alan Cox33f0f882006-01-09 20:54:13 -0800474
475 /* OPTIMISATION: We could keep a per tty "zero" sized buffer to
476 remove this conditional if its worth it. This would be invisible
477 to the callers */
Paul Fulghum33b37a32006-06-28 04:26:49 -0700478 if ((b = tty->buf.tail) != NULL)
Alan Cox33f0f882006-01-09 20:54:13 -0800479 left = b->size - b->used;
Paul Fulghum33b37a32006-06-28 04:26:49 -0700480 else
Paul Fulghum808249c2006-02-03 03:04:41 -0800481 left = 0;
482
483 if (left < size) {
484 /* This is the slow path - looking for new buffers to use */
485 if ((n = tty_buffer_find(tty, size)) != NULL) {
486 if (b != NULL) {
487 b->next = n;
Paul Fulghum8977d922006-02-10 01:51:14 -0800488 b->commit = b->used;
Paul Fulghum808249c2006-02-03 03:04:41 -0800489 } else
490 tty->buf.head = n;
491 tty->buf.tail = n;
Paul Fulghum808249c2006-02-03 03:04:41 -0800492 } else
493 size = left;
494 }
495
496 spin_unlock_irqrestore(&tty->buf.lock, flags);
Alan Cox33f0f882006-01-09 20:54:13 -0800497 return size;
498}
Alan Cox33f0f882006-01-09 20:54:13 -0800499EXPORT_SYMBOL_GPL(tty_buffer_request_room);
500
Alan Coxaf9b8972006-08-27 01:24:01 -0700501/**
502 * tty_insert_flip_string - Add characters to the tty buffer
503 * @tty: tty structure
504 * @chars: characters
505 * @size: size
506 *
507 * Queue a series of bytes to the tty buffering. All the characters
508 * passed are marked as without error. Returns the number added.
509 *
510 * Locking: Called functions may take tty->buf.lock
511 */
512
Andrew Mortone1a25092006-04-10 22:54:05 -0700513int tty_insert_flip_string(struct tty_struct *tty, const unsigned char *chars,
514 size_t size)
Alan Cox33f0f882006-01-09 20:54:13 -0800515{
516 int copied = 0;
517 do {
518 int space = tty_buffer_request_room(tty, size - copied);
519 struct tty_buffer *tb = tty->buf.tail;
520 /* If there is no space then tb may be NULL */
Alan Cox37bdfb02008-02-08 04:18:47 -0800521 if (unlikely(space == 0))
Alan Cox33f0f882006-01-09 20:54:13 -0800522 break;
523 memcpy(tb->char_buf_ptr + tb->used, chars, space);
524 memset(tb->flag_buf_ptr + tb->used, TTY_NORMAL, space);
525 tb->used += space;
526 copied += space;
527 chars += space;
Alexey Dobriyan527063b2006-09-29 01:59:50 -0700528 /* There is a small chance that we need to split the data over
529 several buffers. If this is the case we must loop */
530 } while (unlikely(size > copied));
Alan Cox33f0f882006-01-09 20:54:13 -0800531 return copied;
532}
Andrew Mortonee37df72006-03-31 02:30:35 -0800533EXPORT_SYMBOL(tty_insert_flip_string);
Alan Cox33f0f882006-01-09 20:54:13 -0800534
Alan Coxaf9b8972006-08-27 01:24:01 -0700535/**
536 * tty_insert_flip_string_flags - Add characters to the tty buffer
537 * @tty: tty structure
538 * @chars: characters
539 * @flags: flag bytes
540 * @size: size
541 *
542 * Queue a series of bytes to the tty buffering. For each character
543 * the flags array indicates the status of the character. Returns the
544 * number added.
545 *
546 * Locking: Called functions may take tty->buf.lock
547 */
548
Andrew Mortone1a25092006-04-10 22:54:05 -0700549int tty_insert_flip_string_flags(struct tty_struct *tty,
550 const unsigned char *chars, const char *flags, size_t size)
Alan Cox33f0f882006-01-09 20:54:13 -0800551{
552 int copied = 0;
553 do {
554 int space = tty_buffer_request_room(tty, size - copied);
555 struct tty_buffer *tb = tty->buf.tail;
556 /* If there is no space then tb may be NULL */
Alan Cox37bdfb02008-02-08 04:18:47 -0800557 if (unlikely(space == 0))
Alan Cox33f0f882006-01-09 20:54:13 -0800558 break;
559 memcpy(tb->char_buf_ptr + tb->used, chars, space);
560 memcpy(tb->flag_buf_ptr + tb->used, flags, space);
561 tb->used += space;
562 copied += space;
563 chars += space;
564 flags += space;
Alexey Dobriyan527063b2006-09-29 01:59:50 -0700565 /* There is a small chance that we need to split the data over
566 several buffers. If this is the case we must loop */
567 } while (unlikely(size > copied));
Alan Cox33f0f882006-01-09 20:54:13 -0800568 return copied;
569}
Tobias Powalowskiff4547f2006-05-22 22:35:28 -0700570EXPORT_SYMBOL(tty_insert_flip_string_flags);
Alan Cox33f0f882006-01-09 20:54:13 -0800571
Alan Coxaf9b8972006-08-27 01:24:01 -0700572/**
573 * tty_schedule_flip - push characters to ldisc
574 * @tty: tty to push from
575 *
576 * Takes any pending buffers and transfers their ownership to the
577 * ldisc side of the queue. It then schedules those characters for
578 * processing by the line discipline.
579 *
580 * Locking: Takes tty->buf.lock
581 */
582
Andrew Mortone1a25092006-04-10 22:54:05 -0700583void tty_schedule_flip(struct tty_struct *tty)
584{
585 unsigned long flags;
586 spin_lock_irqsave(&tty->buf.lock, flags);
Paul Fulghum33b37a32006-06-28 04:26:49 -0700587 if (tty->buf.tail != NULL)
Andrew Mortone1a25092006-04-10 22:54:05 -0700588 tty->buf.tail->commit = tty->buf.tail->used;
Andrew Mortone1a25092006-04-10 22:54:05 -0700589 spin_unlock_irqrestore(&tty->buf.lock, flags);
590 schedule_delayed_work(&tty->buf.work, 1);
591}
592EXPORT_SYMBOL(tty_schedule_flip);
Alan Cox33f0f882006-01-09 20:54:13 -0800593
Alan Coxaf9b8972006-08-27 01:24:01 -0700594/**
595 * tty_prepare_flip_string - make room for characters
596 * @tty: tty
597 * @chars: return pointer for character write area
598 * @size: desired size
599 *
Alan Cox33f0f882006-01-09 20:54:13 -0800600 * Prepare a block of space in the buffer for data. Returns the length
601 * available and buffer pointer to the space which is now allocated and
602 * accounted for as ready for normal characters. This is used for drivers
603 * that need their own block copy routines into the buffer. There is no
604 * guarantee the buffer is a DMA target!
Alan Coxaf9b8972006-08-27 01:24:01 -0700605 *
606 * Locking: May call functions taking tty->buf.lock
Alan Cox33f0f882006-01-09 20:54:13 -0800607 */
608
Alan Cox37bdfb02008-02-08 04:18:47 -0800609int tty_prepare_flip_string(struct tty_struct *tty, unsigned char **chars,
610 size_t size)
Alan Cox33f0f882006-01-09 20:54:13 -0800611{
612 int space = tty_buffer_request_room(tty, size);
Paul Fulghum808249c2006-02-03 03:04:41 -0800613 if (likely(space)) {
614 struct tty_buffer *tb = tty->buf.tail;
615 *chars = tb->char_buf_ptr + tb->used;
616 memset(tb->flag_buf_ptr + tb->used, TTY_NORMAL, space);
617 tb->used += space;
618 }
Alan Cox33f0f882006-01-09 20:54:13 -0800619 return space;
620}
621
622EXPORT_SYMBOL_GPL(tty_prepare_flip_string);
623
Alan Coxaf9b8972006-08-27 01:24:01 -0700624/**
625 * tty_prepare_flip_string_flags - make room for characters
626 * @tty: tty
627 * @chars: return pointer for character write area
628 * @flags: return pointer for status flag write area
629 * @size: desired size
630 *
Alan Cox33f0f882006-01-09 20:54:13 -0800631 * Prepare a block of space in the buffer for data. Returns the length
632 * available and buffer pointer to the space which is now allocated and
633 * accounted for as ready for characters. This is used for drivers
634 * that need their own block copy routines into the buffer. There is no
635 * guarantee the buffer is a DMA target!
Alan Coxaf9b8972006-08-27 01:24:01 -0700636 *
637 * Locking: May call functions taking tty->buf.lock
Alan Cox33f0f882006-01-09 20:54:13 -0800638 */
639
Alan Cox37bdfb02008-02-08 04:18:47 -0800640int tty_prepare_flip_string_flags(struct tty_struct *tty,
641 unsigned char **chars, char **flags, size_t size)
Alan Cox33f0f882006-01-09 20:54:13 -0800642{
643 int space = tty_buffer_request_room(tty, size);
Paul Fulghum808249c2006-02-03 03:04:41 -0800644 if (likely(space)) {
645 struct tty_buffer *tb = tty->buf.tail;
646 *chars = tb->char_buf_ptr + tb->used;
647 *flags = tb->flag_buf_ptr + tb->used;
648 tb->used += space;
649 }
Alan Cox33f0f882006-01-09 20:54:13 -0800650 return space;
651}
652
653EXPORT_SYMBOL_GPL(tty_prepare_flip_string_flags);
654
655
656
Alan Coxaf9b8972006-08-27 01:24:01 -0700657/**
658 * tty_set_termios_ldisc - set ldisc field
659 * @tty: tty structure
660 * @num: line discipline number
661 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700662 * This is probably overkill for real world processors but
Alan Cox37bdfb02008-02-08 04:18:47 -0800663 * they are not on hot paths so a little discipline won't do
Linus Torvalds1da177e2005-04-16 15:20:36 -0700664 * any harm.
Alan Coxaf9b8972006-08-27 01:24:01 -0700665 *
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800666 * Locking: takes termios_mutex
Linus Torvalds1da177e2005-04-16 15:20:36 -0700667 */
Alan Cox37bdfb02008-02-08 04:18:47 -0800668
Linus Torvalds1da177e2005-04-16 15:20:36 -0700669static void tty_set_termios_ldisc(struct tty_struct *tty, int num)
670{
Arjan van de Ven5785c952006-09-29 02:00:43 -0700671 mutex_lock(&tty->termios_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700672 tty->termios->c_line = num;
Arjan van de Ven5785c952006-09-29 02:00:43 -0700673 mutex_unlock(&tty->termios_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700674}
675
676/*
677 * This guards the refcounted line discipline lists. The lock
678 * must be taken with irqs off because there are hangup path
679 * callers who will do ldisc lookups and cannot sleep.
680 */
Alan Cox37bdfb02008-02-08 04:18:47 -0800681
Linus Torvalds1da177e2005-04-16 15:20:36 -0700682static DEFINE_SPINLOCK(tty_ldisc_lock);
683static DECLARE_WAIT_QUEUE_HEAD(tty_ldisc_wait);
Alan Cox37bdfb02008-02-08 04:18:47 -0800684/* Line disc dispatch table */
685static struct tty_ldisc tty_ldiscs[NR_LDISCS];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700686
Alan Coxaf9b8972006-08-27 01:24:01 -0700687/**
688 * tty_register_ldisc - install a line discipline
689 * @disc: ldisc number
690 * @new_ldisc: pointer to the ldisc object
691 *
692 * Installs a new line discipline into the kernel. The discipline
693 * is set up as unreferenced and then made available to the kernel
694 * from this point onwards.
695 *
696 * Locking:
697 * takes tty_ldisc_lock to guard against ldisc races
698 */
699
Linus Torvalds1da177e2005-04-16 15:20:36 -0700700int tty_register_ldisc(int disc, struct tty_ldisc *new_ldisc)
701{
702 unsigned long flags;
703 int ret = 0;
Alan Cox37bdfb02008-02-08 04:18:47 -0800704
Linus Torvalds1da177e2005-04-16 15:20:36 -0700705 if (disc < N_TTY || disc >= NR_LDISCS)
706 return -EINVAL;
Alan Cox37bdfb02008-02-08 04:18:47 -0800707
Linus Torvalds1da177e2005-04-16 15:20:36 -0700708 spin_lock_irqsave(&tty_ldisc_lock, flags);
Alexey Dobriyanbfb07592005-06-23 00:10:32 -0700709 tty_ldiscs[disc] = *new_ldisc;
710 tty_ldiscs[disc].num = disc;
711 tty_ldiscs[disc].flags |= LDISC_FLAG_DEFINED;
712 tty_ldiscs[disc].refcount = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700713 spin_unlock_irqrestore(&tty_ldisc_lock, flags);
Alan Cox37bdfb02008-02-08 04:18:47 -0800714
Linus Torvalds1da177e2005-04-16 15:20:36 -0700715 return ret;
716}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700717EXPORT_SYMBOL(tty_register_ldisc);
718
Alan Coxaf9b8972006-08-27 01:24:01 -0700719/**
720 * tty_unregister_ldisc - unload a line discipline
721 * @disc: ldisc number
722 * @new_ldisc: pointer to the ldisc object
723 *
724 * Remove a line discipline from the kernel providing it is not
725 * currently in use.
726 *
727 * Locking:
728 * takes tty_ldisc_lock to guard against ldisc races
729 */
730
Alexey Dobriyanbfb07592005-06-23 00:10:32 -0700731int tty_unregister_ldisc(int disc)
732{
733 unsigned long flags;
734 int ret = 0;
735
736 if (disc < N_TTY || disc >= NR_LDISCS)
737 return -EINVAL;
738
739 spin_lock_irqsave(&tty_ldisc_lock, flags);
740 if (tty_ldiscs[disc].refcount)
741 ret = -EBUSY;
742 else
743 tty_ldiscs[disc].flags &= ~LDISC_FLAG_DEFINED;
744 spin_unlock_irqrestore(&tty_ldisc_lock, flags);
745
746 return ret;
747}
748EXPORT_SYMBOL(tty_unregister_ldisc);
749
Alan Coxaf9b8972006-08-27 01:24:01 -0700750/**
751 * tty_ldisc_get - take a reference to an ldisc
752 * @disc: ldisc number
753 *
754 * Takes a reference to a line discipline. Deals with refcounts and
755 * module locking counts. Returns NULL if the discipline is not available.
756 * Returns a pointer to the discipline and bumps the ref count if it is
757 * available
758 *
759 * Locking:
760 * takes tty_ldisc_lock to guard against ldisc races
761 */
762
Linus Torvalds1da177e2005-04-16 15:20:36 -0700763struct tty_ldisc *tty_ldisc_get(int disc)
764{
765 unsigned long flags;
766 struct tty_ldisc *ld;
767
768 if (disc < N_TTY || disc >= NR_LDISCS)
769 return NULL;
Alan Cox37bdfb02008-02-08 04:18:47 -0800770
Linus Torvalds1da177e2005-04-16 15:20:36 -0700771 spin_lock_irqsave(&tty_ldisc_lock, flags);
772
773 ld = &tty_ldiscs[disc];
774 /* Check the entry is defined */
Alan Cox37bdfb02008-02-08 04:18:47 -0800775 if (ld->flags & LDISC_FLAG_DEFINED) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700776 /* If the module is being unloaded we can't use it */
777 if (!try_module_get(ld->owner))
Alan Cox37bdfb02008-02-08 04:18:47 -0800778 ld = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700779 else /* lock it */
780 ld->refcount++;
Alan Cox37bdfb02008-02-08 04:18:47 -0800781 } else
Linus Torvalds1da177e2005-04-16 15:20:36 -0700782 ld = NULL;
783 spin_unlock_irqrestore(&tty_ldisc_lock, flags);
784 return ld;
785}
786
787EXPORT_SYMBOL_GPL(tty_ldisc_get);
788
Alan Coxaf9b8972006-08-27 01:24:01 -0700789/**
790 * tty_ldisc_put - drop ldisc reference
791 * @disc: ldisc number
792 *
793 * Drop a reference to a line discipline. Manage refcounts and
794 * module usage counts
795 *
796 * Locking:
797 * takes tty_ldisc_lock to guard against ldisc races
798 */
799
Linus Torvalds1da177e2005-04-16 15:20:36 -0700800void tty_ldisc_put(int disc)
801{
802 struct tty_ldisc *ld;
803 unsigned long flags;
Alan Cox37bdfb02008-02-08 04:18:47 -0800804
Eric Sesterhenn56ee4822006-03-26 18:17:21 +0200805 BUG_ON(disc < N_TTY || disc >= NR_LDISCS);
Alan Cox37bdfb02008-02-08 04:18:47 -0800806
Linus Torvalds1da177e2005-04-16 15:20:36 -0700807 spin_lock_irqsave(&tty_ldisc_lock, flags);
808 ld = &tty_ldiscs[disc];
Eric Sesterhenn56ee4822006-03-26 18:17:21 +0200809 BUG_ON(ld->refcount == 0);
810 ld->refcount--;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700811 module_put(ld->owner);
812 spin_unlock_irqrestore(&tty_ldisc_lock, flags);
813}
Alan Cox37bdfb02008-02-08 04:18:47 -0800814
Linus Torvalds1da177e2005-04-16 15:20:36 -0700815EXPORT_SYMBOL_GPL(tty_ldisc_put);
816
Alan Coxaf9b8972006-08-27 01:24:01 -0700817/**
818 * tty_ldisc_assign - set ldisc on a tty
819 * @tty: tty to assign
820 * @ld: line discipline
821 *
822 * Install an instance of a line discipline into a tty structure. The
823 * ldisc must have a reference count above zero to ensure it remains/
824 * The tty instance refcount starts at zero.
825 *
826 * Locking:
827 * Caller must hold references
828 */
829
Linus Torvalds1da177e2005-04-16 15:20:36 -0700830static void tty_ldisc_assign(struct tty_struct *tty, struct tty_ldisc *ld)
831{
832 tty->ldisc = *ld;
833 tty->ldisc.refcount = 0;
834}
835
836/**
837 * tty_ldisc_try - internal helper
838 * @tty: the tty
839 *
840 * Make a single attempt to grab and bump the refcount on
841 * the tty ldisc. Return 0 on failure or 1 on success. This is
842 * used to implement both the waiting and non waiting versions
843 * of tty_ldisc_ref
Alan Coxaf9b8972006-08-27 01:24:01 -0700844 *
845 * Locking: takes tty_ldisc_lock
Linus Torvalds1da177e2005-04-16 15:20:36 -0700846 */
847
848static int tty_ldisc_try(struct tty_struct *tty)
849{
850 unsigned long flags;
851 struct tty_ldisc *ld;
852 int ret = 0;
Alan Cox37bdfb02008-02-08 04:18:47 -0800853
Linus Torvalds1da177e2005-04-16 15:20:36 -0700854 spin_lock_irqsave(&tty_ldisc_lock, flags);
855 ld = &tty->ldisc;
Alan Cox37bdfb02008-02-08 04:18:47 -0800856 if (test_bit(TTY_LDISC, &tty->flags)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700857 ld->refcount++;
858 ret = 1;
859 }
860 spin_unlock_irqrestore(&tty_ldisc_lock, flags);
861 return ret;
862}
863
864/**
865 * tty_ldisc_ref_wait - wait for the tty ldisc
866 * @tty: tty device
867 *
Alan Cox37bdfb02008-02-08 04:18:47 -0800868 * Dereference the line discipline for the terminal and take a
869 * reference to it. If the line discipline is in flux then
Linus Torvalds1da177e2005-04-16 15:20:36 -0700870 * wait patiently until it changes.
871 *
872 * Note: Must not be called from an IRQ/timer context. The caller
873 * must also be careful not to hold other locks that will deadlock
874 * against a discipline change, such as an existing ldisc reference
875 * (which we check for)
Alan Coxaf9b8972006-08-27 01:24:01 -0700876 *
877 * Locking: call functions take tty_ldisc_lock
Linus Torvalds1da177e2005-04-16 15:20:36 -0700878 */
Alan Cox37bdfb02008-02-08 04:18:47 -0800879
Linus Torvalds1da177e2005-04-16 15:20:36 -0700880struct tty_ldisc *tty_ldisc_ref_wait(struct tty_struct *tty)
881{
882 /* wait_event is a macro */
883 wait_event(tty_ldisc_wait, tty_ldisc_try(tty));
Alan Cox37bdfb02008-02-08 04:18:47 -0800884 if (tty->ldisc.refcount == 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700885 printk(KERN_ERR "tty_ldisc_ref_wait\n");
886 return &tty->ldisc;
887}
888
889EXPORT_SYMBOL_GPL(tty_ldisc_ref_wait);
890
891/**
892 * tty_ldisc_ref - get the tty ldisc
893 * @tty: tty device
894 *
Alan Cox37bdfb02008-02-08 04:18:47 -0800895 * Dereference the line discipline for the terminal and take a
896 * reference to it. If the line discipline is in flux then
Linus Torvalds1da177e2005-04-16 15:20:36 -0700897 * return NULL. Can be called from IRQ and timer functions.
Alan Coxaf9b8972006-08-27 01:24:01 -0700898 *
899 * Locking: called functions take tty_ldisc_lock
Linus Torvalds1da177e2005-04-16 15:20:36 -0700900 */
Alan Cox37bdfb02008-02-08 04:18:47 -0800901
Linus Torvalds1da177e2005-04-16 15:20:36 -0700902struct tty_ldisc *tty_ldisc_ref(struct tty_struct *tty)
903{
Alan Cox37bdfb02008-02-08 04:18:47 -0800904 if (tty_ldisc_try(tty))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700905 return &tty->ldisc;
906 return NULL;
907}
908
909EXPORT_SYMBOL_GPL(tty_ldisc_ref);
910
911/**
912 * tty_ldisc_deref - free a tty ldisc reference
913 * @ld: reference to free up
914 *
915 * Undoes the effect of tty_ldisc_ref or tty_ldisc_ref_wait. May
916 * be called in IRQ context.
Alan Coxaf9b8972006-08-27 01:24:01 -0700917 *
918 * Locking: takes tty_ldisc_lock
Linus Torvalds1da177e2005-04-16 15:20:36 -0700919 */
Alan Cox37bdfb02008-02-08 04:18:47 -0800920
Linus Torvalds1da177e2005-04-16 15:20:36 -0700921void tty_ldisc_deref(struct tty_ldisc *ld)
922{
923 unsigned long flags;
924
Eric Sesterhenn56ee4822006-03-26 18:17:21 +0200925 BUG_ON(ld == NULL);
Alan Cox37bdfb02008-02-08 04:18:47 -0800926
Linus Torvalds1da177e2005-04-16 15:20:36 -0700927 spin_lock_irqsave(&tty_ldisc_lock, flags);
Alan Cox37bdfb02008-02-08 04:18:47 -0800928 if (ld->refcount == 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700929 printk(KERN_ERR "tty_ldisc_deref: no references.\n");
930 else
931 ld->refcount--;
Alan Cox37bdfb02008-02-08 04:18:47 -0800932 if (ld->refcount == 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700933 wake_up(&tty_ldisc_wait);
934 spin_unlock_irqrestore(&tty_ldisc_lock, flags);
935}
936
937EXPORT_SYMBOL_GPL(tty_ldisc_deref);
938
939/**
940 * tty_ldisc_enable - allow ldisc use
941 * @tty: terminal to activate ldisc on
942 *
943 * Set the TTY_LDISC flag when the line discipline can be called
Robert P. J. Day3a4fa0a2007-10-19 23:10:43 +0200944 * again. Do necessary wakeups for existing sleepers.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700945 *
946 * Note: nobody should set this bit except via this function. Clearing
947 * directly is allowed.
948 */
949
950static void tty_ldisc_enable(struct tty_struct *tty)
951{
952 set_bit(TTY_LDISC, &tty->flags);
953 wake_up(&tty_ldisc_wait);
954}
Alan Cox37bdfb02008-02-08 04:18:47 -0800955
Linus Torvalds1da177e2005-04-16 15:20:36 -0700956/**
957 * tty_set_ldisc - set line discipline
958 * @tty: the terminal to set
959 * @ldisc: the line discipline
960 *
961 * Set the discipline of a tty line. Must be called from a process
962 * context.
Alan Coxaf9b8972006-08-27 01:24:01 -0700963 *
964 * Locking: takes tty_ldisc_lock.
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800965 * called functions take termios_mutex
Linus Torvalds1da177e2005-04-16 15:20:36 -0700966 */
Alan Cox37bdfb02008-02-08 04:18:47 -0800967
Linus Torvalds1da177e2005-04-16 15:20:36 -0700968static int tty_set_ldisc(struct tty_struct *tty, int ldisc)
969{
Jason Baronff55fe22005-09-09 13:01:57 -0700970 int retval = 0;
971 struct tty_ldisc o_ldisc;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700972 char buf[64];
973 int work;
974 unsigned long flags;
975 struct tty_ldisc *ld;
Jason Baronff55fe22005-09-09 13:01:57 -0700976 struct tty_struct *o_tty;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700977
978 if ((ldisc < N_TTY) || (ldisc >= NR_LDISCS))
979 return -EINVAL;
980
981restart:
982
Linus Torvalds1da177e2005-04-16 15:20:36 -0700983 ld = tty_ldisc_get(ldisc);
984 /* Eduardo Blanco <ejbs@cs.cs.com.uy> */
985 /* Cyrus Durgin <cider@speakeasy.org> */
986 if (ld == NULL) {
987 request_module("tty-ldisc-%d", ldisc);
988 ld = tty_ldisc_get(ldisc);
989 }
990 if (ld == NULL)
991 return -EINVAL;
992
Alan Cox33f0f882006-01-09 20:54:13 -0800993 /*
Alan Cox33f0f882006-01-09 20:54:13 -0800994 * Problem: What do we do if this blocks ?
995 */
996
Linus Torvalds1da177e2005-04-16 15:20:36 -0700997 tty_wait_until_sent(tty, 0);
998
Jason Baronff55fe22005-09-09 13:01:57 -0700999 if (tty->ldisc.num == ldisc) {
1000 tty_ldisc_put(ldisc);
1001 return 0;
1002 }
1003
Paul Fulghumae030e42007-05-09 02:33:38 -07001004 /*
1005 * No more input please, we are switching. The new ldisc
1006 * will update this value in the ldisc open function
1007 */
1008
1009 tty->receive_room = 0;
1010
Jason Baronff55fe22005-09-09 13:01:57 -07001011 o_ldisc = tty->ldisc;
1012 o_tty = tty->link;
1013
Linus Torvalds1da177e2005-04-16 15:20:36 -07001014 /*
1015 * Make sure we don't change while someone holds a
1016 * reference to the line discipline. The TTY_LDISC bit
1017 * prevents anyone taking a reference once it is clear.
1018 * We need the lock to avoid racing reference takers.
1019 */
Jason Baronff55fe22005-09-09 13:01:57 -07001020
Linus Torvalds1da177e2005-04-16 15:20:36 -07001021 spin_lock_irqsave(&tty_ldisc_lock, flags);
Jason Baronff55fe22005-09-09 13:01:57 -07001022 if (tty->ldisc.refcount || (o_tty && o_tty->ldisc.refcount)) {
Alan Cox37bdfb02008-02-08 04:18:47 -08001023 if (tty->ldisc.refcount) {
Jason Baronff55fe22005-09-09 13:01:57 -07001024 /* Free the new ldisc we grabbed. Must drop the lock
1025 first. */
1026 spin_unlock_irqrestore(&tty_ldisc_lock, flags);
1027 tty_ldisc_put(ldisc);
1028 /*
1029 * There are several reasons we may be busy, including
1030 * random momentary I/O traffic. We must therefore
1031 * retry. We could distinguish between blocking ops
Alan Cox37bdfb02008-02-08 04:18:47 -08001032 * and retries if we made tty_ldisc_wait() smarter.
1033 * That is up for discussion.
Jason Baronff55fe22005-09-09 13:01:57 -07001034 */
1035 if (wait_event_interruptible(tty_ldisc_wait, tty->ldisc.refcount == 0) < 0)
1036 return -ERESTARTSYS;
1037 goto restart;
1038 }
Alan Cox37bdfb02008-02-08 04:18:47 -08001039 if (o_tty && o_tty->ldisc.refcount) {
Jason Baronff55fe22005-09-09 13:01:57 -07001040 spin_unlock_irqrestore(&tty_ldisc_lock, flags);
1041 tty_ldisc_put(ldisc);
1042 if (wait_event_interruptible(tty_ldisc_wait, o_tty->ldisc.refcount == 0) < 0)
1043 return -ERESTARTSYS;
1044 goto restart;
1045 }
1046 }
Alan Cox37bdfb02008-02-08 04:18:47 -08001047 /*
1048 * If the TTY_LDISC bit is set, then we are racing against
1049 * another ldisc change
1050 */
Jason Baronff55fe22005-09-09 13:01:57 -07001051 if (!test_bit(TTY_LDISC, &tty->flags)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001052 spin_unlock_irqrestore(&tty_ldisc_lock, flags);
1053 tty_ldisc_put(ldisc);
Jason Baronff55fe22005-09-09 13:01:57 -07001054 ld = tty_ldisc_ref_wait(tty);
1055 tty_ldisc_deref(ld);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001056 goto restart;
1057 }
Jason Baronff55fe22005-09-09 13:01:57 -07001058
1059 clear_bit(TTY_LDISC, &tty->flags);
Paul Fulghum817d6d32006-06-28 04:26:47 -07001060 if (o_tty)
Jason Baronff55fe22005-09-09 13:01:57 -07001061 clear_bit(TTY_LDISC, &o_tty->flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001062 spin_unlock_irqrestore(&tty_ldisc_lock, flags);
Jason Baronff55fe22005-09-09 13:01:57 -07001063
Linus Torvalds1da177e2005-04-16 15:20:36 -07001064 /*
1065 * From this point on we know nobody has an ldisc
1066 * usage reference, nor can they obtain one until
1067 * we say so later on.
1068 */
Jason Baronff55fe22005-09-09 13:01:57 -07001069
Alan Cox33f0f882006-01-09 20:54:13 -08001070 work = cancel_delayed_work(&tty->buf.work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001071 /*
Alan Cox33f0f882006-01-09 20:54:13 -08001072 * Wait for ->hangup_work and ->buf.work handlers to terminate
Linus Torvalds1da177e2005-04-16 15:20:36 -07001073 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001074 flush_scheduled_work();
1075 /* Shutdown the current discipline. */
1076 if (tty->ldisc.close)
1077 (tty->ldisc.close)(tty);
1078
1079 /* Now set up the new line discipline. */
1080 tty_ldisc_assign(tty, ld);
1081 tty_set_termios_ldisc(tty, ldisc);
1082 if (tty->ldisc.open)
1083 retval = (tty->ldisc.open)(tty);
1084 if (retval < 0) {
1085 tty_ldisc_put(ldisc);
1086 /* There is an outstanding reference here so this is safe */
1087 tty_ldisc_assign(tty, tty_ldisc_get(o_ldisc.num));
1088 tty_set_termios_ldisc(tty, tty->ldisc.num);
1089 if (tty->ldisc.open && (tty->ldisc.open(tty) < 0)) {
1090 tty_ldisc_put(o_ldisc.num);
1091 /* This driver is always present */
1092 tty_ldisc_assign(tty, tty_ldisc_get(N_TTY));
1093 tty_set_termios_ldisc(tty, N_TTY);
1094 if (tty->ldisc.open) {
1095 int r = tty->ldisc.open(tty);
1096
1097 if (r < 0)
1098 panic("Couldn't open N_TTY ldisc for "
1099 "%s --- error %d.",
1100 tty_name(tty, buf), r);
1101 }
1102 }
1103 }
1104 /* At this point we hold a reference to the new ldisc and a
1105 a reference to the old ldisc. If we ended up flipping back
1106 to the existing ldisc we have two references to it */
Alan Cox37bdfb02008-02-08 04:18:47 -08001107
Alan Coxf34d7a52008-04-30 00:54:13 -07001108 if (tty->ldisc.num != o_ldisc.num && tty->ops->set_ldisc)
1109 tty->ops->set_ldisc(tty);
Alan Cox37bdfb02008-02-08 04:18:47 -08001110
Linus Torvalds1da177e2005-04-16 15:20:36 -07001111 tty_ldisc_put(o_ldisc.num);
Alan Cox37bdfb02008-02-08 04:18:47 -08001112
Linus Torvalds1da177e2005-04-16 15:20:36 -07001113 /*
1114 * Allow ldisc referencing to occur as soon as the driver
1115 * ldisc callback completes.
1116 */
Alan Cox37bdfb02008-02-08 04:18:47 -08001117
Linus Torvalds1da177e2005-04-16 15:20:36 -07001118 tty_ldisc_enable(tty);
Jason Baronff55fe22005-09-09 13:01:57 -07001119 if (o_tty)
1120 tty_ldisc_enable(o_tty);
Alan Cox37bdfb02008-02-08 04:18:47 -08001121
Linus Torvalds1da177e2005-04-16 15:20:36 -07001122 /* Restart it in case no characters kick it off. Safe if
1123 already running */
Jason Baronff55fe22005-09-09 13:01:57 -07001124 if (work)
Alan Cox33f0f882006-01-09 20:54:13 -08001125 schedule_delayed_work(&tty->buf.work, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001126 return retval;
1127}
1128
Alan Coxaf9b8972006-08-27 01:24:01 -07001129/**
1130 * get_tty_driver - find device of a tty
1131 * @dev_t: device identifier
1132 * @index: returns the index of the tty
1133 *
1134 * This routine returns a tty driver structure, given a device number
1135 * and also passes back the index number.
1136 *
1137 * Locking: caller must hold tty_mutex
Linus Torvalds1da177e2005-04-16 15:20:36 -07001138 */
Alan Coxaf9b8972006-08-27 01:24:01 -07001139
Linus Torvalds1da177e2005-04-16 15:20:36 -07001140static struct tty_driver *get_tty_driver(dev_t device, int *index)
1141{
1142 struct tty_driver *p;
1143
1144 list_for_each_entry(p, &tty_drivers, tty_drivers) {
1145 dev_t base = MKDEV(p->major, p->minor_start);
1146 if (device < base || device >= base + p->num)
1147 continue;
1148 *index = device - base;
1149 return p;
1150 }
1151 return NULL;
1152}
1153
Jason Wesself2d937f2008-04-17 20:05:37 +02001154#ifdef CONFIG_CONSOLE_POLL
1155
1156/**
1157 * tty_find_polling_driver - find device of a polled tty
1158 * @name: name string to match
1159 * @line: pointer to resulting tty line nr
1160 *
1161 * This routine returns a tty driver structure, given a name
1162 * and the condition that the tty driver is capable of polled
1163 * operation.
1164 */
1165struct tty_driver *tty_find_polling_driver(char *name, int *line)
1166{
1167 struct tty_driver *p, *res = NULL;
1168 int tty_line = 0;
1169 char *str;
1170
1171 mutex_lock(&tty_mutex);
1172 /* Search through the tty devices to look for a match */
1173 list_for_each_entry(p, &tty_drivers, tty_drivers) {
1174 str = name + strlen(p->name);
1175 tty_line = simple_strtoul(str, &str, 10);
1176 if (*str == ',')
1177 str++;
1178 if (*str == '\0')
Harvey Harrison8da56302008-04-28 14:13:20 -07001179 str = NULL;
Jason Wesself2d937f2008-04-17 20:05:37 +02001180
Alan Coxf34d7a52008-04-30 00:54:13 -07001181 if (tty_line >= 0 && tty_line <= p->num && p->ops &&
1182 p->ops->poll_init && !p->ops->poll_init(p, tty_line, str)) {
Jason Wesself2d937f2008-04-17 20:05:37 +02001183 res = p;
1184 *line = tty_line;
1185 break;
1186 }
1187 }
1188 mutex_unlock(&tty_mutex);
1189
1190 return res;
1191}
1192EXPORT_SYMBOL_GPL(tty_find_polling_driver);
1193#endif
1194
Alan Coxaf9b8972006-08-27 01:24:01 -07001195/**
1196 * tty_check_change - check for POSIX terminal changes
1197 * @tty: tty to check
1198 *
1199 * If we try to write to, or set the state of, a terminal and we're
1200 * not in the foreground, send a SIGTTOU. If the signal is blocked or
1201 * ignored, go ahead and perform the operation. (POSIX 7.2)
1202 *
Alan Cox978e5952008-04-30 00:53:59 -07001203 * Locking: ctrl_lock
Linus Torvalds1da177e2005-04-16 15:20:36 -07001204 */
Alan Coxaf9b8972006-08-27 01:24:01 -07001205
Alan Cox37bdfb02008-02-08 04:18:47 -08001206int tty_check_change(struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001207{
Alan Cox47f86832008-04-30 00:53:30 -07001208 unsigned long flags;
1209 int ret = 0;
1210
Linus Torvalds1da177e2005-04-16 15:20:36 -07001211 if (current->signal->tty != tty)
1212 return 0;
Alan Cox47f86832008-04-30 00:53:30 -07001213
1214 spin_lock_irqsave(&tty->ctrl_lock, flags);
1215
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08001216 if (!tty->pgrp) {
1217 printk(KERN_WARNING "tty_check_change: tty->pgrp == NULL!\n");
Andrew Morton9ffee4c2008-05-14 16:05:58 -07001218 goto out_unlock;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001219 }
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08001220 if (task_pgrp(current) == tty->pgrp)
Andrew Morton9ffee4c2008-05-14 16:05:58 -07001221 goto out_unlock;
1222 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001223 if (is_ignored(SIGTTOU))
Alan Cox47f86832008-04-30 00:53:30 -07001224 goto out;
1225 if (is_current_pgrp_orphaned()) {
1226 ret = -EIO;
1227 goto out;
1228 }
Oleg Nesterov040b6362007-06-01 00:46:53 -07001229 kill_pgrp(task_pgrp(current), SIGTTOU, 1);
1230 set_thread_flag(TIF_SIGPENDING);
Alan Cox47f86832008-04-30 00:53:30 -07001231 ret = -ERESTARTSYS;
1232out:
Andrew Morton9ffee4c2008-05-14 16:05:58 -07001233 return ret;
1234out_unlock:
Alan Cox47f86832008-04-30 00:53:30 -07001235 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
1236 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001237}
1238
1239EXPORT_SYMBOL(tty_check_change);
1240
Alan Cox37bdfb02008-02-08 04:18:47 -08001241static ssize_t hung_up_tty_read(struct file *file, char __user *buf,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001242 size_t count, loff_t *ppos)
1243{
1244 return 0;
1245}
1246
Alan Cox37bdfb02008-02-08 04:18:47 -08001247static ssize_t hung_up_tty_write(struct file *file, const char __user *buf,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001248 size_t count, loff_t *ppos)
1249{
1250 return -EIO;
1251}
1252
1253/* No kernel lock held - none needed ;) */
Alan Cox37bdfb02008-02-08 04:18:47 -08001254static unsigned int hung_up_tty_poll(struct file *filp, poll_table *wait)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001255{
1256 return POLLIN | POLLOUT | POLLERR | POLLHUP | POLLRDNORM | POLLWRNORM;
1257}
1258
Alan Cox04f378b2008-04-30 00:53:29 -07001259static long hung_up_tty_ioctl(struct file *file, unsigned int cmd,
1260 unsigned long arg)
Paul Fulghum38ad2ed2007-06-16 10:15:55 -07001261{
1262 return cmd == TIOCSPGRP ? -ENOTTY : -EIO;
1263}
1264
Alan Cox37bdfb02008-02-08 04:18:47 -08001265static long hung_up_tty_compat_ioctl(struct file *file,
Paul Fulghum38ad2ed2007-06-16 10:15:55 -07001266 unsigned int cmd, unsigned long arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001267{
1268 return cmd == TIOCSPGRP ? -ENOTTY : -EIO;
1269}
1270
Arjan van de Ven62322d22006-07-03 00:24:21 -07001271static const struct file_operations tty_fops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001272 .llseek = no_llseek,
1273 .read = tty_read,
1274 .write = tty_write,
1275 .poll = tty_poll,
Alan Cox04f378b2008-04-30 00:53:29 -07001276 .unlocked_ioctl = tty_ioctl,
Paul Fulghume10cc1d2007-05-10 22:22:50 -07001277 .compat_ioctl = tty_compat_ioctl,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001278 .open = tty_open,
1279 .release = tty_release,
1280 .fasync = tty_fasync,
1281};
1282
1283#ifdef CONFIG_UNIX98_PTYS
Arjan van de Ven62322d22006-07-03 00:24:21 -07001284static const struct file_operations ptmx_fops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001285 .llseek = no_llseek,
1286 .read = tty_read,
1287 .write = tty_write,
1288 .poll = tty_poll,
Alan Cox04f378b2008-04-30 00:53:29 -07001289 .unlocked_ioctl = tty_ioctl,
Paul Fulghume10cc1d2007-05-10 22:22:50 -07001290 .compat_ioctl = tty_compat_ioctl,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001291 .open = ptmx_open,
1292 .release = tty_release,
1293 .fasync = tty_fasync,
1294};
1295#endif
1296
Arjan van de Ven62322d22006-07-03 00:24:21 -07001297static const struct file_operations console_fops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001298 .llseek = no_llseek,
1299 .read = tty_read,
1300 .write = redirected_tty_write,
1301 .poll = tty_poll,
Alan Cox04f378b2008-04-30 00:53:29 -07001302 .unlocked_ioctl = tty_ioctl,
Paul Fulghume10cc1d2007-05-10 22:22:50 -07001303 .compat_ioctl = tty_compat_ioctl,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001304 .open = tty_open,
1305 .release = tty_release,
1306 .fasync = tty_fasync,
1307};
1308
Arjan van de Ven62322d22006-07-03 00:24:21 -07001309static const struct file_operations hung_up_tty_fops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001310 .llseek = no_llseek,
1311 .read = hung_up_tty_read,
1312 .write = hung_up_tty_write,
1313 .poll = hung_up_tty_poll,
Alan Cox04f378b2008-04-30 00:53:29 -07001314 .unlocked_ioctl = hung_up_tty_ioctl,
Paul Fulghum38ad2ed2007-06-16 10:15:55 -07001315 .compat_ioctl = hung_up_tty_compat_ioctl,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001316 .release = tty_release,
1317};
1318
1319static DEFINE_SPINLOCK(redirect_lock);
1320static struct file *redirect;
1321
1322/**
1323 * tty_wakeup - request more data
1324 * @tty: terminal
1325 *
1326 * Internal and external helper for wakeups of tty. This function
1327 * informs the line discipline if present that the driver is ready
1328 * to receive more output data.
1329 */
Alan Cox37bdfb02008-02-08 04:18:47 -08001330
Linus Torvalds1da177e2005-04-16 15:20:36 -07001331void tty_wakeup(struct tty_struct *tty)
1332{
1333 struct tty_ldisc *ld;
Alan Cox37bdfb02008-02-08 04:18:47 -08001334
Linus Torvalds1da177e2005-04-16 15:20:36 -07001335 if (test_bit(TTY_DO_WRITE_WAKEUP, &tty->flags)) {
1336 ld = tty_ldisc_ref(tty);
Alan Cox37bdfb02008-02-08 04:18:47 -08001337 if (ld) {
1338 if (ld->write_wakeup)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001339 ld->write_wakeup(tty);
1340 tty_ldisc_deref(ld);
1341 }
1342 }
1343 wake_up_interruptible(&tty->write_wait);
1344}
1345
1346EXPORT_SYMBOL_GPL(tty_wakeup);
1347
1348/**
1349 * tty_ldisc_flush - flush line discipline queue
1350 * @tty: tty
1351 *
1352 * Flush the line discipline queue (if any) for this tty. If there
1353 * is no line discipline active this is a no-op.
1354 */
Alan Cox37bdfb02008-02-08 04:18:47 -08001355
Linus Torvalds1da177e2005-04-16 15:20:36 -07001356void tty_ldisc_flush(struct tty_struct *tty)
1357{
1358 struct tty_ldisc *ld = tty_ldisc_ref(tty);
Alan Cox37bdfb02008-02-08 04:18:47 -08001359 if (ld) {
1360 if (ld->flush_buffer)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001361 ld->flush_buffer(tty);
1362 tty_ldisc_deref(ld);
1363 }
Paul Fulghumc5c34d42007-05-12 10:36:55 -07001364 tty_buffer_flush(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001365}
1366
1367EXPORT_SYMBOL_GPL(tty_ldisc_flush);
Alan Coxedc6afc2006-12-08 02:38:44 -08001368
1369/**
1370 * tty_reset_termios - reset terminal state
1371 * @tty: tty to reset
1372 *
1373 * Restore a terminal to the driver default state
1374 */
1375
1376static void tty_reset_termios(struct tty_struct *tty)
1377{
1378 mutex_lock(&tty->termios_mutex);
1379 *tty->termios = tty->driver->init_termios;
1380 tty->termios->c_ispeed = tty_termios_input_baud_rate(tty->termios);
1381 tty->termios->c_ospeed = tty_termios_baud_rate(tty->termios);
1382 mutex_unlock(&tty->termios_mutex);
1383}
Alan Cox37bdfb02008-02-08 04:18:47 -08001384
Alan Coxaf9b8972006-08-27 01:24:01 -07001385/**
1386 * do_tty_hangup - actual handler for hangup events
David Howells65f27f32006-11-22 14:55:48 +00001387 * @work: tty device
Alan Coxaf9b8972006-08-27 01:24:01 -07001388 *
1389 * This can be called by the "eventd" kernel thread. That is process
1390 * synchronous but doesn't hold any locks, so we need to make sure we
1391 * have the appropriate locks for what we're doing.
1392 *
1393 * The hangup event clears any pending redirections onto the hung up
1394 * device. It ensures future writes will error and it does the needed
1395 * line discipline hangup and signal delivery. The tty object itself
1396 * remains intact.
1397 *
1398 * Locking:
1399 * BKL
Peter Zijlstra24ec8392006-12-08 02:36:04 -08001400 * redirect lock for undoing redirection
1401 * file list lock for manipulating list of ttys
1402 * tty_ldisc_lock from called functions
1403 * termios_mutex resetting termios data
1404 * tasklist_lock to walk task list for hangup event
1405 * ->siglock to protect ->signal/->sighand
Linus Torvalds1da177e2005-04-16 15:20:36 -07001406 */
David Howells65f27f32006-11-22 14:55:48 +00001407static void do_tty_hangup(struct work_struct *work)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001408{
David Howells65f27f32006-11-22 14:55:48 +00001409 struct tty_struct *tty =
1410 container_of(work, struct tty_struct, hangup_work);
Alan Cox37bdfb02008-02-08 04:18:47 -08001411 struct file *cons_filp = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001412 struct file *filp, *f = NULL;
1413 struct task_struct *p;
1414 struct tty_ldisc *ld;
1415 int closecount = 0, n;
Alan Cox47f86832008-04-30 00:53:30 -07001416 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001417
1418 if (!tty)
1419 return;
1420
1421 /* inuse_filps is protected by the single kernel lock */
1422 lock_kernel();
1423
1424 spin_lock(&redirect_lock);
1425 if (redirect && redirect->private_data == tty) {
1426 f = redirect;
1427 redirect = NULL;
1428 }
1429 spin_unlock(&redirect_lock);
Alan Cox37bdfb02008-02-08 04:18:47 -08001430
Linus Torvalds1da177e2005-04-16 15:20:36 -07001431 check_tty_count(tty, "do_tty_hangup");
1432 file_list_lock();
1433 /* This breaks for file handles being sent over AF_UNIX sockets ? */
Eric Dumazet2f512012005-10-30 15:02:16 -08001434 list_for_each_entry(filp, &tty->tty_files, f_u.fu_list) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001435 if (filp->f_op->write == redirected_tty_write)
1436 cons_filp = filp;
1437 if (filp->f_op->write != tty_write)
1438 continue;
1439 closecount++;
1440 tty_fasync(-1, filp, 0); /* can't block */
1441 filp->f_op = &hung_up_tty_fops;
1442 }
1443 file_list_unlock();
Alan Cox37bdfb02008-02-08 04:18:47 -08001444 /*
1445 * FIXME! What are the locking issues here? This may me overdoing
1446 * things... This question is especially important now that we've
1447 * removed the irqlock.
1448 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001449 ld = tty_ldisc_ref(tty);
Alan Cox37bdfb02008-02-08 04:18:47 -08001450 if (ld != NULL) {
1451 /* We may have no line discipline at this point */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001452 if (ld->flush_buffer)
1453 ld->flush_buffer(tty);
Alan Coxf34d7a52008-04-30 00:54:13 -07001454 tty_driver_flush_buffer(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001455 if ((test_bit(TTY_DO_WRITE_WAKEUP, &tty->flags)) &&
1456 ld->write_wakeup)
1457 ld->write_wakeup(tty);
1458 if (ld->hangup)
1459 ld->hangup(tty);
1460 }
Alan Cox37bdfb02008-02-08 04:18:47 -08001461 /*
1462 * FIXME: Once we trust the LDISC code better we can wait here for
1463 * ldisc completion and fix the driver call race
1464 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001465 wake_up_interruptible(&tty->write_wait);
1466 wake_up_interruptible(&tty->read_wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001467 /*
1468 * Shutdown the current line discipline, and reset it to
1469 * N_TTY.
1470 */
1471 if (tty->driver->flags & TTY_DRIVER_RESET_TERMIOS)
Alan Coxedc6afc2006-12-08 02:38:44 -08001472 tty_reset_termios(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001473 /* Defer ldisc switch */
1474 /* tty_deferred_ldisc_switch(N_TTY);
Alan Cox37bdfb02008-02-08 04:18:47 -08001475
Linus Torvalds1da177e2005-04-16 15:20:36 -07001476 This should get done automatically when the port closes and
1477 tty_release is called */
Alan Cox37bdfb02008-02-08 04:18:47 -08001478
Linus Torvalds1da177e2005-04-16 15:20:36 -07001479 read_lock(&tasklist_lock);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08001480 if (tty->session) {
1481 do_each_pid_task(tty->session, PIDTYPE_SID, p) {
Peter Zijlstra24ec8392006-12-08 02:36:04 -08001482 spin_lock_irq(&p->sighand->siglock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001483 if (p->signal->tty == tty)
1484 p->signal->tty = NULL;
Peter Zijlstra24ec8392006-12-08 02:36:04 -08001485 if (!p->signal->leader) {
1486 spin_unlock_irq(&p->sighand->siglock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001487 continue;
Peter Zijlstra24ec8392006-12-08 02:36:04 -08001488 }
1489 __group_send_sig_info(SIGHUP, SEND_SIG_PRIV, p);
1490 __group_send_sig_info(SIGCONT, SEND_SIG_PRIV, p);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08001491 put_pid(p->signal->tty_old_pgrp); /* A noop */
Alan Cox47f86832008-04-30 00:53:30 -07001492 spin_lock_irqsave(&tty->ctrl_lock, flags);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08001493 if (tty->pgrp)
1494 p->signal->tty_old_pgrp = get_pid(tty->pgrp);
Alan Cox47f86832008-04-30 00:53:30 -07001495 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
Peter Zijlstra24ec8392006-12-08 02:36:04 -08001496 spin_unlock_irq(&p->sighand->siglock);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08001497 } while_each_pid_task(tty->session, PIDTYPE_SID, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001498 }
1499 read_unlock(&tasklist_lock);
1500
Alan Cox47f86832008-04-30 00:53:30 -07001501 spin_lock_irqsave(&tty->ctrl_lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001502 tty->flags = 0;
Eric W. Biedermand9c1e9a2007-03-18 12:45:44 -06001503 put_pid(tty->session);
1504 put_pid(tty->pgrp);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08001505 tty->session = NULL;
1506 tty->pgrp = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001507 tty->ctrl_status = 0;
Alan Cox47f86832008-04-30 00:53:30 -07001508 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
1509
Linus Torvalds1da177e2005-04-16 15:20:36 -07001510 /*
Alan Cox37bdfb02008-02-08 04:18:47 -08001511 * If one of the devices matches a console pointer, we
1512 * cannot just call hangup() because that will cause
1513 * tty->count and state->count to go out of sync.
1514 * So we just call close() the right number of times.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001515 */
1516 if (cons_filp) {
Alan Coxf34d7a52008-04-30 00:54:13 -07001517 if (tty->ops->close)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001518 for (n = 0; n < closecount; n++)
Alan Coxf34d7a52008-04-30 00:54:13 -07001519 tty->ops->close(tty, cons_filp);
1520 } else if (tty->ops->hangup)
1521 (tty->ops->hangup)(tty);
Alan Cox37bdfb02008-02-08 04:18:47 -08001522 /*
1523 * We don't want to have driver/ldisc interactions beyond
1524 * the ones we did here. The driver layer expects no
1525 * calls after ->hangup() from the ldisc side. However we
1526 * can't yet guarantee all that.
1527 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001528 set_bit(TTY_HUPPED, &tty->flags);
1529 if (ld) {
1530 tty_ldisc_enable(tty);
1531 tty_ldisc_deref(ld);
1532 }
1533 unlock_kernel();
1534 if (f)
1535 fput(f);
1536}
1537
Alan Coxaf9b8972006-08-27 01:24:01 -07001538/**
1539 * tty_hangup - trigger a hangup event
1540 * @tty: tty to hangup
1541 *
1542 * A carrier loss (virtual or otherwise) has occurred on this like
1543 * schedule a hangup sequence to run after this event.
1544 */
1545
Alan Cox37bdfb02008-02-08 04:18:47 -08001546void tty_hangup(struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001547{
1548#ifdef TTY_DEBUG_HANGUP
1549 char buf[64];
Linus Torvalds1da177e2005-04-16 15:20:36 -07001550 printk(KERN_DEBUG "%s hangup...\n", tty_name(tty, buf));
1551#endif
1552 schedule_work(&tty->hangup_work);
1553}
1554
1555EXPORT_SYMBOL(tty_hangup);
1556
Alan Coxaf9b8972006-08-27 01:24:01 -07001557/**
1558 * tty_vhangup - process vhangup
1559 * @tty: tty to hangup
1560 *
1561 * The user has asked via system call for the terminal to be hung up.
1562 * We do this synchronously so that when the syscall returns the process
Robert P. J. Day3a4fa0a2007-10-19 23:10:43 +02001563 * is complete. That guarantee is necessary for security reasons.
Alan Coxaf9b8972006-08-27 01:24:01 -07001564 */
1565
Alan Cox37bdfb02008-02-08 04:18:47 -08001566void tty_vhangup(struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001567{
1568#ifdef TTY_DEBUG_HANGUP
1569 char buf[64];
1570
1571 printk(KERN_DEBUG "%s vhangup...\n", tty_name(tty, buf));
1572#endif
David Howells65f27f32006-11-22 14:55:48 +00001573 do_tty_hangup(&tty->hangup_work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001574}
Alan Cox37bdfb02008-02-08 04:18:47 -08001575
Linus Torvalds1da177e2005-04-16 15:20:36 -07001576EXPORT_SYMBOL(tty_vhangup);
1577
Alan Coxaf9b8972006-08-27 01:24:01 -07001578/**
1579 * tty_hung_up_p - was tty hung up
1580 * @filp: file pointer of tty
1581 *
1582 * Return true if the tty has been subject to a vhangup or a carrier
1583 * loss
1584 */
1585
Alan Cox37bdfb02008-02-08 04:18:47 -08001586int tty_hung_up_p(struct file *filp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001587{
1588 return (filp->f_op == &hung_up_tty_fops);
1589}
1590
1591EXPORT_SYMBOL(tty_hung_up_p);
1592
Miloslav Trmac522ed772007-07-15 23:40:56 -07001593/**
Alan Cox37bdfb02008-02-08 04:18:47 -08001594 * is_tty - checker whether file is a TTY
1595 * @filp: file handle that may be a tty
1596 *
1597 * Check if the file handle is a tty handle.
Miloslav Trmac522ed772007-07-15 23:40:56 -07001598 */
Alan Cox37bdfb02008-02-08 04:18:47 -08001599
Miloslav Trmac522ed772007-07-15 23:40:56 -07001600int is_tty(struct file *filp)
1601{
1602 return filp->f_op->read == tty_read
1603 || filp->f_op->read == hung_up_tty_read;
1604}
1605
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08001606static void session_clear_tty(struct pid *session)
Peter Zijlstra24ec8392006-12-08 02:36:04 -08001607{
1608 struct task_struct *p;
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08001609 do_each_pid_task(session, PIDTYPE_SID, p) {
Peter Zijlstra24ec8392006-12-08 02:36:04 -08001610 proc_clear_tty(p);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08001611 } while_each_pid_task(session, PIDTYPE_SID, p);
Peter Zijlstra24ec8392006-12-08 02:36:04 -08001612}
1613
Alan Coxaf9b8972006-08-27 01:24:01 -07001614/**
1615 * disassociate_ctty - disconnect controlling tty
1616 * @on_exit: true if exiting so need to "hang up" the session
Linus Torvalds1da177e2005-04-16 15:20:36 -07001617 *
Alan Coxaf9b8972006-08-27 01:24:01 -07001618 * This function is typically called only by the session leader, when
1619 * it wants to disassociate itself from its controlling tty.
1620 *
1621 * It performs the following functions:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001622 * (1) Sends a SIGHUP and SIGCONT to the foreground process group
1623 * (2) Clears the tty from being controlling the session
1624 * (3) Clears the controlling tty for all processes in the
1625 * session group.
1626 *
Alan Coxaf9b8972006-08-27 01:24:01 -07001627 * The argument on_exit is set to 1 if called when a process is
1628 * exiting; it is 0 if called by the ioctl TIOCNOTTY.
1629 *
Peter Zijlstra24ec8392006-12-08 02:36:04 -08001630 * Locking:
Alan Coxaf9b8972006-08-27 01:24:01 -07001631 * BKL is taken for hysterical raisins
Peter Zijlstra24ec8392006-12-08 02:36:04 -08001632 * tty_mutex is taken to protect tty
1633 * ->siglock is taken to protect ->signal/->sighand
1634 * tasklist_lock is taken to walk process list for sessions
1635 * ->siglock is taken to protect ->signal/->sighand
Linus Torvalds1da177e2005-04-16 15:20:36 -07001636 */
Alan Coxaf9b8972006-08-27 01:24:01 -07001637
Linus Torvalds1da177e2005-04-16 15:20:36 -07001638void disassociate_ctty(int on_exit)
1639{
1640 struct tty_struct *tty;
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08001641 struct pid *tty_pgrp = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001642
Linus Torvalds1da177e2005-04-16 15:20:36 -07001643
Ingo Molnar70522e12006-03-23 03:00:31 -08001644 mutex_lock(&tty_mutex);
Peter Zijlstra24ec8392006-12-08 02:36:04 -08001645 tty = get_current_tty();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001646 if (tty) {
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08001647 tty_pgrp = get_pid(tty->pgrp);
Ingo Molnar70522e12006-03-23 03:00:31 -08001648 mutex_unlock(&tty_mutex);
Alan Cox04f378b2008-04-30 00:53:29 -07001649 lock_kernel();
Peter Zijlstra24ec8392006-12-08 02:36:04 -08001650 /* XXX: here we race, there is nothing protecting tty */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001651 if (on_exit && tty->driver->type != TTY_DRIVER_TYPE_PTY)
1652 tty_vhangup(tty);
Alan Cox04f378b2008-04-30 00:53:29 -07001653 unlock_kernel();
Eric W. Biederman680a9672007-02-12 00:52:52 -08001654 } else if (on_exit) {
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08001655 struct pid *old_pgrp;
Eric W. Biederman680a9672007-02-12 00:52:52 -08001656 spin_lock_irq(&current->sighand->siglock);
1657 old_pgrp = current->signal->tty_old_pgrp;
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08001658 current->signal->tty_old_pgrp = NULL;
Eric W. Biederman680a9672007-02-12 00:52:52 -08001659 spin_unlock_irq(&current->sighand->siglock);
Peter Zijlstra24ec8392006-12-08 02:36:04 -08001660 if (old_pgrp) {
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08001661 kill_pgrp(old_pgrp, SIGHUP, on_exit);
1662 kill_pgrp(old_pgrp, SIGCONT, on_exit);
1663 put_pid(old_pgrp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001664 }
Ingo Molnar70522e12006-03-23 03:00:31 -08001665 mutex_unlock(&tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001666 return;
1667 }
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08001668 if (tty_pgrp) {
1669 kill_pgrp(tty_pgrp, SIGHUP, on_exit);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001670 if (!on_exit)
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08001671 kill_pgrp(tty_pgrp, SIGCONT, on_exit);
1672 put_pid(tty_pgrp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001673 }
1674
Peter Zijlstra24ec8392006-12-08 02:36:04 -08001675 spin_lock_irq(&current->sighand->siglock);
Eric W. Biederman2a65f1d2007-05-08 00:26:53 -07001676 put_pid(current->signal->tty_old_pgrp);
Randy Dunlap23cac8d2007-02-20 13:58:05 -08001677 current->signal->tty_old_pgrp = NULL;
Peter Zijlstra24ec8392006-12-08 02:36:04 -08001678 spin_unlock_irq(&current->sighand->siglock);
1679
1680 mutex_lock(&tty_mutex);
1681 /* It is possible that do_tty_hangup has free'd this tty */
1682 tty = get_current_tty();
1683 if (tty) {
Alan Cox47f86832008-04-30 00:53:30 -07001684 unsigned long flags;
1685 spin_lock_irqsave(&tty->ctrl_lock, flags);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08001686 put_pid(tty->session);
1687 put_pid(tty->pgrp);
1688 tty->session = NULL;
1689 tty->pgrp = NULL;
Alan Cox47f86832008-04-30 00:53:30 -07001690 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
Peter Zijlstra24ec8392006-12-08 02:36:04 -08001691 } else {
1692#ifdef TTY_DEBUG_HANGUP
1693 printk(KERN_DEBUG "error attempted to write to tty [0x%p]"
1694 " = NULL", tty);
1695#endif
1696 }
1697 mutex_unlock(&tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001698
1699 /* Now clear signal->tty under the lock */
1700 read_lock(&tasklist_lock);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08001701 session_clear_tty(task_session(current));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001702 read_unlock(&tasklist_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001703}
1704
Eric W. Biederman98a27ba2007-05-08 00:26:56 -07001705/**
1706 *
1707 * no_tty - Ensure the current process does not have a controlling tty
1708 */
1709void no_tty(void)
1710{
1711 struct task_struct *tsk = current;
Alan Cox04f378b2008-04-30 00:53:29 -07001712 lock_kernel();
Eric W. Biederman98a27ba2007-05-08 00:26:56 -07001713 if (tsk->signal->leader)
1714 disassociate_ctty(0);
Alan Cox04f378b2008-04-30 00:53:29 -07001715 unlock_kernel();
Eric W. Biederman98a27ba2007-05-08 00:26:56 -07001716 proc_clear_tty(tsk);
1717}
1718
Alan Coxaf9b8972006-08-27 01:24:01 -07001719
1720/**
Robert P. J. Daybeb7dd82007-05-09 07:14:03 +02001721 * stop_tty - propagate flow control
Alan Coxaf9b8972006-08-27 01:24:01 -07001722 * @tty: tty to stop
1723 *
1724 * Perform flow control to the driver. For PTY/TTY pairs we
Robert P. J. Daybeb7dd82007-05-09 07:14:03 +02001725 * must also propagate the TIOCKPKT status. May be called
Alan Coxaf9b8972006-08-27 01:24:01 -07001726 * on an already stopped device and will not re-call the driver
1727 * method.
1728 *
1729 * This functionality is used by both the line disciplines for
1730 * halting incoming flow and by the driver. It may therefore be
1731 * called from any context, may be under the tty atomic_write_lock
1732 * but not always.
1733 *
1734 * Locking:
Alan Cox04f378b2008-04-30 00:53:29 -07001735 * Uses the tty control lock internally
Alan Coxaf9b8972006-08-27 01:24:01 -07001736 */
1737
Linus Torvalds1da177e2005-04-16 15:20:36 -07001738void stop_tty(struct tty_struct *tty)
1739{
Alan Cox04f378b2008-04-30 00:53:29 -07001740 unsigned long flags;
1741 spin_lock_irqsave(&tty->ctrl_lock, flags);
1742 if (tty->stopped) {
1743 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001744 return;
Alan Cox04f378b2008-04-30 00:53:29 -07001745 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001746 tty->stopped = 1;
1747 if (tty->link && tty->link->packet) {
1748 tty->ctrl_status &= ~TIOCPKT_START;
1749 tty->ctrl_status |= TIOCPKT_STOP;
1750 wake_up_interruptible(&tty->link->read_wait);
1751 }
Alan Cox04f378b2008-04-30 00:53:29 -07001752 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
Alan Coxf34d7a52008-04-30 00:54:13 -07001753 if (tty->ops->stop)
1754 (tty->ops->stop)(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001755}
1756
1757EXPORT_SYMBOL(stop_tty);
1758
Alan Coxaf9b8972006-08-27 01:24:01 -07001759/**
Robert P. J. Daybeb7dd82007-05-09 07:14:03 +02001760 * start_tty - propagate flow control
Alan Coxaf9b8972006-08-27 01:24:01 -07001761 * @tty: tty to start
1762 *
1763 * Start a tty that has been stopped if at all possible. Perform
Robert P. J. Day3a4fa0a2007-10-19 23:10:43 +02001764 * any necessary wakeups and propagate the TIOCPKT status. If this
Alan Coxaf9b8972006-08-27 01:24:01 -07001765 * is the tty was previous stopped and is being started then the
1766 * driver start method is invoked and the line discipline woken.
1767 *
1768 * Locking:
Alan Cox04f378b2008-04-30 00:53:29 -07001769 * ctrl_lock
Alan Coxaf9b8972006-08-27 01:24:01 -07001770 */
1771
Linus Torvalds1da177e2005-04-16 15:20:36 -07001772void start_tty(struct tty_struct *tty)
1773{
Alan Cox04f378b2008-04-30 00:53:29 -07001774 unsigned long flags;
1775 spin_lock_irqsave(&tty->ctrl_lock, flags);
1776 if (!tty->stopped || tty->flow_stopped) {
1777 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001778 return;
Alan Cox04f378b2008-04-30 00:53:29 -07001779 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001780 tty->stopped = 0;
1781 if (tty->link && tty->link->packet) {
1782 tty->ctrl_status &= ~TIOCPKT_STOP;
1783 tty->ctrl_status |= TIOCPKT_START;
1784 wake_up_interruptible(&tty->link->read_wait);
1785 }
Alan Cox04f378b2008-04-30 00:53:29 -07001786 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
Alan Coxf34d7a52008-04-30 00:54:13 -07001787 if (tty->ops->start)
1788 (tty->ops->start)(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001789 /* If we have a running line discipline it may need kicking */
1790 tty_wakeup(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001791}
1792
1793EXPORT_SYMBOL(start_tty);
1794
Alan Coxaf9b8972006-08-27 01:24:01 -07001795/**
1796 * tty_read - read method for tty device files
1797 * @file: pointer to tty file
1798 * @buf: user buffer
1799 * @count: size of user buffer
1800 * @ppos: unused
1801 *
1802 * Perform the read system call function on this terminal device. Checks
1803 * for hung up devices before calling the line discipline method.
1804 *
1805 * Locking:
Alan Cox47f86832008-04-30 00:53:30 -07001806 * Locks the line discipline internally while needed. Multiple
1807 * read calls may be outstanding in parallel.
Alan Coxaf9b8972006-08-27 01:24:01 -07001808 */
1809
Alan Cox37bdfb02008-02-08 04:18:47 -08001810static ssize_t tty_read(struct file *file, char __user *buf, size_t count,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001811 loff_t *ppos)
1812{
1813 int i;
Alan Cox37bdfb02008-02-08 04:18:47 -08001814 struct tty_struct *tty;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001815 struct inode *inode;
1816 struct tty_ldisc *ld;
1817
1818 tty = (struct tty_struct *)file->private_data;
Josef Sipeka7113a92006-12-08 02:36:55 -08001819 inode = file->f_path.dentry->d_inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001820 if (tty_paranoia_check(tty, inode, "tty_read"))
1821 return -EIO;
1822 if (!tty || (test_bit(TTY_IO_ERROR, &tty->flags)))
1823 return -EIO;
1824
1825 /* We want to wait for the line discipline to sort out in this
1826 situation */
1827 ld = tty_ldisc_ref_wait(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001828 if (ld->read)
Alan Cox37bdfb02008-02-08 04:18:47 -08001829 i = (ld->read)(tty, file, buf, count);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001830 else
1831 i = -EIO;
1832 tty_ldisc_deref(ld);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001833 if (i > 0)
1834 inode->i_atime = current_fs_time(inode->i_sb);
1835 return i;
1836}
1837
Alan Cox9c1729d2007-07-15 23:39:43 -07001838void tty_write_unlock(struct tty_struct *tty)
1839{
1840 mutex_unlock(&tty->atomic_write_lock);
1841 wake_up_interruptible(&tty->write_wait);
1842}
1843
1844int tty_write_lock(struct tty_struct *tty, int ndelay)
1845{
1846 if (!mutex_trylock(&tty->atomic_write_lock)) {
1847 if (ndelay)
1848 return -EAGAIN;
1849 if (mutex_lock_interruptible(&tty->atomic_write_lock))
1850 return -ERESTARTSYS;
1851 }
1852 return 0;
1853}
1854
Linus Torvalds1da177e2005-04-16 15:20:36 -07001855/*
1856 * Split writes up in sane blocksizes to avoid
1857 * denial-of-service type attacks
1858 */
1859static inline ssize_t do_tty_write(
1860 ssize_t (*write)(struct tty_struct *, struct file *, const unsigned char *, size_t),
1861 struct tty_struct *tty,
1862 struct file *file,
1863 const char __user *buf,
1864 size_t count)
1865{
Alan Cox9c1729d2007-07-15 23:39:43 -07001866 ssize_t ret, written = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001867 unsigned int chunk;
Alan Cox37bdfb02008-02-08 04:18:47 -08001868
Alan Cox9c1729d2007-07-15 23:39:43 -07001869 ret = tty_write_lock(tty, file->f_flags & O_NDELAY);
1870 if (ret < 0)
1871 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001872
1873 /*
1874 * We chunk up writes into a temporary buffer. This
1875 * simplifies low-level drivers immensely, since they
1876 * don't have locking issues and user mode accesses.
1877 *
1878 * But if TTY_NO_WRITE_SPLIT is set, we should use a
1879 * big chunk-size..
1880 *
1881 * The default chunk-size is 2kB, because the NTTY
1882 * layer has problems with bigger chunks. It will
1883 * claim to be able to handle more characters than
1884 * it actually does.
Alan Coxaf9b8972006-08-27 01:24:01 -07001885 *
1886 * FIXME: This can probably go away now except that 64K chunks
1887 * are too likely to fail unless switched to vmalloc...
Linus Torvalds1da177e2005-04-16 15:20:36 -07001888 */
1889 chunk = 2048;
1890 if (test_bit(TTY_NO_WRITE_SPLIT, &tty->flags))
1891 chunk = 65536;
1892 if (count < chunk)
1893 chunk = count;
1894
Ingo Molnar70522e12006-03-23 03:00:31 -08001895 /* write_buf/write_cnt is protected by the atomic_write_lock mutex */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001896 if (tty->write_cnt < chunk) {
1897 unsigned char *buf;
1898
1899 if (chunk < 1024)
1900 chunk = 1024;
1901
1902 buf = kmalloc(chunk, GFP_KERNEL);
1903 if (!buf) {
Alan Cox9c1729d2007-07-15 23:39:43 -07001904 ret = -ENOMEM;
1905 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001906 }
1907 kfree(tty->write_buf);
1908 tty->write_cnt = chunk;
1909 tty->write_buf = buf;
1910 }
1911
1912 /* Do the write .. */
1913 for (;;) {
1914 size_t size = count;
1915 if (size > chunk)
1916 size = chunk;
1917 ret = -EFAULT;
1918 if (copy_from_user(tty->write_buf, buf, size))
1919 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001920 ret = write(tty, file, tty->write_buf, size);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001921 if (ret <= 0)
1922 break;
1923 written += ret;
1924 buf += ret;
1925 count -= ret;
1926 if (!count)
1927 break;
1928 ret = -ERESTARTSYS;
1929 if (signal_pending(current))
1930 break;
1931 cond_resched();
1932 }
1933 if (written) {
Josef Sipeka7113a92006-12-08 02:36:55 -08001934 struct inode *inode = file->f_path.dentry->d_inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001935 inode->i_mtime = current_fs_time(inode->i_sb);
1936 ret = written;
1937 }
Alan Cox9c1729d2007-07-15 23:39:43 -07001938out:
1939 tty_write_unlock(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001940 return ret;
1941}
1942
1943
Alan Coxaf9b8972006-08-27 01:24:01 -07001944/**
1945 * tty_write - write method for tty device file
1946 * @file: tty file pointer
1947 * @buf: user data to write
1948 * @count: bytes to write
1949 * @ppos: unused
1950 *
1951 * Write data to a tty device via the line discipline.
1952 *
1953 * Locking:
1954 * Locks the line discipline as required
1955 * Writes to the tty driver are serialized by the atomic_write_lock
1956 * and are then processed in chunks to the device. The line discipline
1957 * write method will not be involked in parallel for each device
1958 * The line discipline write method is called under the big
1959 * kernel lock for historical reasons. New code should not rely on this.
1960 */
1961
Alan Cox37bdfb02008-02-08 04:18:47 -08001962static ssize_t tty_write(struct file *file, const char __user *buf,
1963 size_t count, loff_t *ppos)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001964{
Alan Cox37bdfb02008-02-08 04:18:47 -08001965 struct tty_struct *tty;
Josef Sipeka7113a92006-12-08 02:36:55 -08001966 struct inode *inode = file->f_path.dentry->d_inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001967 ssize_t ret;
1968 struct tty_ldisc *ld;
Alan Cox37bdfb02008-02-08 04:18:47 -08001969
Linus Torvalds1da177e2005-04-16 15:20:36 -07001970 tty = (struct tty_struct *)file->private_data;
1971 if (tty_paranoia_check(tty, inode, "tty_write"))
1972 return -EIO;
Alan Coxf34d7a52008-04-30 00:54:13 -07001973 if (!tty || !tty->ops->write ||
Alan Cox37bdfb02008-02-08 04:18:47 -08001974 (test_bit(TTY_IO_ERROR, &tty->flags)))
1975 return -EIO;
Alan Coxf34d7a52008-04-30 00:54:13 -07001976 /* Short term debug to catch buggy drivers */
1977 if (tty->ops->write_room == NULL)
1978 printk(KERN_ERR "tty driver %s lacks a write_room method.\n",
1979 tty->driver->name);
Alan Cox37bdfb02008-02-08 04:18:47 -08001980 ld = tty_ldisc_ref_wait(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001981 if (!ld->write)
1982 ret = -EIO;
1983 else
1984 ret = do_tty_write(ld->write, tty, file, buf, count);
1985 tty_ldisc_deref(ld);
1986 return ret;
1987}
1988
Alan Cox37bdfb02008-02-08 04:18:47 -08001989ssize_t redirected_tty_write(struct file *file, const char __user *buf,
1990 size_t count, loff_t *ppos)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001991{
1992 struct file *p = NULL;
1993
1994 spin_lock(&redirect_lock);
1995 if (redirect) {
1996 get_file(redirect);
1997 p = redirect;
1998 }
1999 spin_unlock(&redirect_lock);
2000
2001 if (p) {
2002 ssize_t res;
2003 res = vfs_write(p, buf, count, &p->f_pos);
2004 fput(p);
2005 return res;
2006 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002007 return tty_write(file, buf, count, ppos);
2008}
2009
2010static char ptychar[] = "pqrstuvwxyzabcde";
2011
Alan Coxaf9b8972006-08-27 01:24:01 -07002012/**
2013 * pty_line_name - generate name for a pty
2014 * @driver: the tty driver in use
2015 * @index: the minor number
2016 * @p: output buffer of at least 6 bytes
2017 *
2018 * Generate a name from a driver reference and write it to the output
2019 * buffer.
2020 *
2021 * Locking: None
2022 */
2023static void pty_line_name(struct tty_driver *driver, int index, char *p)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002024{
2025 int i = index + driver->name_base;
2026 /* ->name is initialized to "ttyp", but "tty" is expected */
2027 sprintf(p, "%s%c%x",
Alan Cox37bdfb02008-02-08 04:18:47 -08002028 driver->subtype == PTY_TYPE_SLAVE ? "tty" : driver->name,
2029 ptychar[i >> 4 & 0xf], i & 0xf);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002030}
2031
Alan Coxaf9b8972006-08-27 01:24:01 -07002032/**
2033 * pty_line_name - generate name for a tty
2034 * @driver: the tty driver in use
2035 * @index: the minor number
2036 * @p: output buffer of at least 7 bytes
2037 *
2038 * Generate a name from a driver reference and write it to the output
2039 * buffer.
2040 *
2041 * Locking: None
2042 */
2043static void tty_line_name(struct tty_driver *driver, int index, char *p)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002044{
2045 sprintf(p, "%s%d", driver->name, index + driver->name_base);
2046}
2047
Alan Coxaf9b8972006-08-27 01:24:01 -07002048/**
2049 * init_dev - initialise a tty device
2050 * @driver: tty driver we are opening a device on
2051 * @idx: device index
2052 * @tty: returned tty structure
2053 *
2054 * Prepare a tty device. This may not be a "new" clean device but
2055 * could also be an active device. The pty drivers require special
2056 * handling because of this.
2057 *
2058 * Locking:
2059 * The function is called under the tty_mutex, which
2060 * protects us from the tty struct or driver itself going away.
2061 *
2062 * On exit the tty device has the line discipline attached and
2063 * a reference count of 1. If a pair was created for pty/tty use
2064 * and the other was a pty master then it too has a reference count of 1.
2065 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07002066 * WSH 06/09/97: Rewritten to remove races and properly clean up after a
Ingo Molnar70522e12006-03-23 03:00:31 -08002067 * failed open. The new code protects the open with a mutex, so it's
2068 * really quite straightforward. The mutex locking can probably be
Linus Torvalds1da177e2005-04-16 15:20:36 -07002069 * relaxed for the (most common) case of reopening a tty.
2070 */
Alan Coxaf9b8972006-08-27 01:24:01 -07002071
Linus Torvalds1da177e2005-04-16 15:20:36 -07002072static int init_dev(struct tty_driver *driver, int idx,
2073 struct tty_struct **ret_tty)
2074{
2075 struct tty_struct *tty, *o_tty;
Alan Coxedc6afc2006-12-08 02:38:44 -08002076 struct ktermios *tp, **tp_loc, *o_tp, **o_tp_loc;
2077 struct ktermios *ltp, **ltp_loc, *o_ltp, **o_ltp_loc;
Alan Coxaf9b8972006-08-27 01:24:01 -07002078 int retval = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002079
2080 /* check whether we're reopening an existing tty */
2081 if (driver->flags & TTY_DRIVER_DEVPTS_MEM) {
2082 tty = devpts_get_tty(idx);
Aristeu Sergio Rozanski Filho5a39e8c2007-02-28 20:13:53 -08002083 /*
2084 * If we don't have a tty here on a slave open, it's because
2085 * the master already started the close process and there's
2086 * no relation between devpts file and tty anymore.
2087 */
2088 if (!tty && driver->subtype == PTY_TYPE_SLAVE) {
2089 retval = -EIO;
2090 goto end_init;
2091 }
2092 /*
2093 * It's safe from now on because init_dev() is called with
2094 * tty_mutex held and release_dev() won't change tty->count
2095 * or tty->flags without having to grab tty_mutex
2096 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002097 if (tty && driver->subtype == PTY_TYPE_MASTER)
2098 tty = tty->link;
2099 } else {
2100 tty = driver->ttys[idx];
2101 }
2102 if (tty) goto fast_track;
2103
2104 /*
2105 * First time open is complex, especially for PTY devices.
2106 * This code guarantees that either everything succeeds and the
2107 * TTY is ready for operation, or else the table slots are vacated
Alan Cox37bdfb02008-02-08 04:18:47 -08002108 * and the allocated memory released. (Except that the termios
Linus Torvalds1da177e2005-04-16 15:20:36 -07002109 * and locked termios may be retained.)
2110 */
2111
2112 if (!try_module_get(driver->owner)) {
2113 retval = -ENODEV;
2114 goto end_init;
2115 }
2116
2117 o_tty = NULL;
2118 tp = o_tp = NULL;
2119 ltp = o_ltp = NULL;
2120
2121 tty = alloc_tty_struct();
Alan Cox37bdfb02008-02-08 04:18:47 -08002122 if (!tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002123 goto fail_no_mem;
2124 initialize_tty_struct(tty);
2125 tty->driver = driver;
Alan Coxf34d7a52008-04-30 00:54:13 -07002126 tty->ops = driver->ops;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002127 tty->index = idx;
2128 tty_line_name(driver, idx, tty->name);
2129
2130 if (driver->flags & TTY_DRIVER_DEVPTS_MEM) {
2131 tp_loc = &tty->termios;
2132 ltp_loc = &tty->termios_locked;
2133 } else {
2134 tp_loc = &driver->termios[idx];
2135 ltp_loc = &driver->termios_locked[idx];
2136 }
2137
2138 if (!*tp_loc) {
Jesper Juhlabcb1ff32007-08-24 02:28:42 +02002139 tp = kmalloc(sizeof(struct ktermios), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002140 if (!tp)
2141 goto free_mem_out;
2142 *tp = driver->init_termios;
2143 }
2144
2145 if (!*ltp_loc) {
Jean Delvare506eb992007-07-15 23:40:14 -07002146 ltp = kzalloc(sizeof(struct ktermios), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002147 if (!ltp)
2148 goto free_mem_out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002149 }
2150
2151 if (driver->type == TTY_DRIVER_TYPE_PTY) {
2152 o_tty = alloc_tty_struct();
2153 if (!o_tty)
2154 goto free_mem_out;
2155 initialize_tty_struct(o_tty);
2156 o_tty->driver = driver->other;
Alan Coxf34d7a52008-04-30 00:54:13 -07002157 o_tty->ops = driver->ops;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002158 o_tty->index = idx;
2159 tty_line_name(driver->other, idx, o_tty->name);
2160
2161 if (driver->flags & TTY_DRIVER_DEVPTS_MEM) {
2162 o_tp_loc = &o_tty->termios;
2163 o_ltp_loc = &o_tty->termios_locked;
2164 } else {
2165 o_tp_loc = &driver->other->termios[idx];
2166 o_ltp_loc = &driver->other->termios_locked[idx];
2167 }
2168
2169 if (!*o_tp_loc) {
Jesper Juhlabcb1ff32007-08-24 02:28:42 +02002170 o_tp = kmalloc(sizeof(struct ktermios), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002171 if (!o_tp)
2172 goto free_mem_out;
2173 *o_tp = driver->other->init_termios;
2174 }
2175
2176 if (!*o_ltp_loc) {
Jean Delvare506eb992007-07-15 23:40:14 -07002177 o_ltp = kzalloc(sizeof(struct ktermios), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002178 if (!o_ltp)
2179 goto free_mem_out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002180 }
2181
2182 /*
2183 * Everything allocated ... set up the o_tty structure.
2184 */
Alan Cox37bdfb02008-02-08 04:18:47 -08002185 if (!(driver->other->flags & TTY_DRIVER_DEVPTS_MEM))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002186 driver->other->ttys[idx] = o_tty;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002187 if (!*o_tp_loc)
2188 *o_tp_loc = o_tp;
2189 if (!*o_ltp_loc)
2190 *o_ltp_loc = o_ltp;
2191 o_tty->termios = *o_tp_loc;
2192 o_tty->termios_locked = *o_ltp_loc;
2193 driver->other->refcount++;
2194 if (driver->subtype == PTY_TYPE_MASTER)
2195 o_tty->count++;
2196
2197 /* Establish the links in both directions */
2198 tty->link = o_tty;
2199 o_tty->link = tty;
2200 }
2201
Alan Cox37bdfb02008-02-08 04:18:47 -08002202 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -07002203 * All structures have been allocated, so now we install them.
Christoph Hellwigd5698c22007-02-10 01:46:46 -08002204 * Failures after this point use release_tty to clean up, so
Linus Torvalds1da177e2005-04-16 15:20:36 -07002205 * there's no need to null out the local pointers.
2206 */
Alan Cox37bdfb02008-02-08 04:18:47 -08002207 if (!(driver->flags & TTY_DRIVER_DEVPTS_MEM))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002208 driver->ttys[idx] = tty;
Alan Cox37bdfb02008-02-08 04:18:47 -08002209
Linus Torvalds1da177e2005-04-16 15:20:36 -07002210 if (!*tp_loc)
2211 *tp_loc = tp;
2212 if (!*ltp_loc)
2213 *ltp_loc = ltp;
2214 tty->termios = *tp_loc;
2215 tty->termios_locked = *ltp_loc;
Alan Coxedc6afc2006-12-08 02:38:44 -08002216 /* Compatibility until drivers always set this */
2217 tty->termios->c_ispeed = tty_termios_input_baud_rate(tty->termios);
2218 tty->termios->c_ospeed = tty_termios_baud_rate(tty->termios);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002219 driver->refcount++;
2220 tty->count++;
2221
Alan Cox37bdfb02008-02-08 04:18:47 -08002222 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -07002223 * Structures all installed ... call the ldisc open routines.
Christoph Hellwigd5698c22007-02-10 01:46:46 -08002224 * If we fail here just call release_tty to clean up. No need
2225 * to decrement the use counts, as release_tty doesn't care.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002226 */
2227
2228 if (tty->ldisc.open) {
2229 retval = (tty->ldisc.open)(tty);
2230 if (retval)
2231 goto release_mem_out;
2232 }
2233 if (o_tty && o_tty->ldisc.open) {
2234 retval = (o_tty->ldisc.open)(o_tty);
2235 if (retval) {
2236 if (tty->ldisc.close)
2237 (tty->ldisc.close)(tty);
2238 goto release_mem_out;
2239 }
2240 tty_ldisc_enable(o_tty);
2241 }
2242 tty_ldisc_enable(tty);
2243 goto success;
2244
2245 /*
2246 * This fast open can be used if the tty is already open.
2247 * No memory is allocated, and the only failures are from
2248 * attempting to open a closing tty or attempting multiple
2249 * opens on a pty master.
2250 */
2251fast_track:
2252 if (test_bit(TTY_CLOSING, &tty->flags)) {
2253 retval = -EIO;
2254 goto end_init;
2255 }
2256 if (driver->type == TTY_DRIVER_TYPE_PTY &&
2257 driver->subtype == PTY_TYPE_MASTER) {
2258 /*
Alan Cox37bdfb02008-02-08 04:18:47 -08002259 * special case for PTY masters: only one open permitted,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002260 * and the slave side open count is incremented as well.
2261 */
2262 if (tty->count) {
2263 retval = -EIO;
2264 goto end_init;
2265 }
2266 tty->link->count++;
2267 }
2268 tty->count++;
2269 tty->driver = driver; /* N.B. why do this every time?? */
2270
2271 /* FIXME */
Alan Cox37bdfb02008-02-08 04:18:47 -08002272 if (!test_bit(TTY_LDISC, &tty->flags))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002273 printk(KERN_ERR "init_dev but no ldisc\n");
2274success:
2275 *ret_tty = tty;
Alan Cox37bdfb02008-02-08 04:18:47 -08002276
Ingo Molnar70522e12006-03-23 03:00:31 -08002277 /* All paths come through here to release the mutex */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002278end_init:
2279 return retval;
2280
2281 /* Release locally allocated memory ... nothing placed in slots */
2282free_mem_out:
Jesper Juhl735d5662005-11-07 01:01:29 -08002283 kfree(o_tp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002284 if (o_tty)
2285 free_tty_struct(o_tty);
Jesper Juhl735d5662005-11-07 01:01:29 -08002286 kfree(ltp);
2287 kfree(tp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002288 free_tty_struct(tty);
2289
2290fail_no_mem:
2291 module_put(driver->owner);
2292 retval = -ENOMEM;
2293 goto end_init;
2294
Christoph Hellwigd5698c22007-02-10 01:46:46 -08002295 /* call the tty release_tty routine to clean out this slot */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002296release_mem_out:
Akinobu Mita40509142006-09-29 02:01:27 -07002297 if (printk_ratelimit())
2298 printk(KERN_INFO "init_dev: ldisc open failed, "
2299 "clearing slot %d\n", idx);
Christoph Hellwigd5698c22007-02-10 01:46:46 -08002300 release_tty(tty, idx);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002301 goto end_init;
2302}
2303
Alan Coxaf9b8972006-08-27 01:24:01 -07002304/**
Christoph Hellwigd5698c22007-02-10 01:46:46 -08002305 * release_one_tty - release tty structure memory
Alan Coxaf9b8972006-08-27 01:24:01 -07002306 *
2307 * Releases memory associated with a tty structure, and clears out the
2308 * driver table slots. This function is called when a device is no longer
2309 * in use. It also gets called when setup of a device fails.
2310 *
2311 * Locking:
2312 * tty_mutex - sometimes only
2313 * takes the file list lock internally when working on the list
2314 * of ttys that the driver keeps.
2315 * FIXME: should we require tty_mutex is held here ??
Linus Torvalds1da177e2005-04-16 15:20:36 -07002316 */
Christoph Hellwigd5698c22007-02-10 01:46:46 -08002317static void release_one_tty(struct tty_struct *tty, int idx)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002318{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002319 int devpts = tty->driver->flags & TTY_DRIVER_DEVPTS_MEM;
Christoph Hellwigd5698c22007-02-10 01:46:46 -08002320 struct ktermios *tp;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002321
2322 if (!devpts)
2323 tty->driver->ttys[idx] = NULL;
Christoph Hellwigd5698c22007-02-10 01:46:46 -08002324
Linus Torvalds1da177e2005-04-16 15:20:36 -07002325 if (tty->driver->flags & TTY_DRIVER_RESET_TERMIOS) {
2326 tp = tty->termios;
2327 if (!devpts)
2328 tty->driver->termios[idx] = NULL;
2329 kfree(tp);
2330
2331 tp = tty->termios_locked;
2332 if (!devpts)
2333 tty->driver->termios_locked[idx] = NULL;
2334 kfree(tp);
2335 }
2336
Christoph Hellwigd5698c22007-02-10 01:46:46 -08002337
Linus Torvalds1da177e2005-04-16 15:20:36 -07002338 tty->magic = 0;
2339 tty->driver->refcount--;
Christoph Hellwigd5698c22007-02-10 01:46:46 -08002340
Linus Torvalds1da177e2005-04-16 15:20:36 -07002341 file_list_lock();
2342 list_del_init(&tty->tty_files);
2343 file_list_unlock();
Christoph Hellwigd5698c22007-02-10 01:46:46 -08002344
Linus Torvalds1da177e2005-04-16 15:20:36 -07002345 free_tty_struct(tty);
2346}
2347
Christoph Hellwigd5698c22007-02-10 01:46:46 -08002348/**
2349 * release_tty - release tty structure memory
2350 *
2351 * Release both @tty and a possible linked partner (think pty pair),
2352 * and decrement the refcount of the backing module.
2353 *
2354 * Locking:
2355 * tty_mutex - sometimes only
2356 * takes the file list lock internally when working on the list
2357 * of ttys that the driver keeps.
2358 * FIXME: should we require tty_mutex is held here ??
2359 */
2360static void release_tty(struct tty_struct *tty, int idx)
2361{
2362 struct tty_driver *driver = tty->driver;
2363
2364 if (tty->link)
2365 release_one_tty(tty->link, idx);
2366 release_one_tty(tty, idx);
2367 module_put(driver->owner);
2368}
2369
Linus Torvalds1da177e2005-04-16 15:20:36 -07002370/*
2371 * Even releasing the tty structures is a tricky business.. We have
2372 * to be very careful that the structures are all released at the
2373 * same time, as interrupts might otherwise get the wrong pointers.
2374 *
2375 * WSH 09/09/97: rewritten to avoid some nasty race conditions that could
2376 * lead to double frees or releasing memory still in use.
2377 */
Alan Cox37bdfb02008-02-08 04:18:47 -08002378static void release_dev(struct file *filp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002379{
2380 struct tty_struct *tty, *o_tty;
2381 int pty_master, tty_closing, o_tty_closing, do_sleep;
Paul Fulghum14a62832006-04-10 22:54:19 -07002382 int devpts;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002383 int idx;
2384 char buf[64];
2385 unsigned long flags;
Alan Cox37bdfb02008-02-08 04:18:47 -08002386
Linus Torvalds1da177e2005-04-16 15:20:36 -07002387 tty = (struct tty_struct *)filp->private_data;
Alan Cox37bdfb02008-02-08 04:18:47 -08002388 if (tty_paranoia_check(tty, filp->f_path.dentry->d_inode,
2389 "release_dev"))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002390 return;
2391
2392 check_tty_count(tty, "release_dev");
2393
2394 tty_fasync(-1, filp, 0);
2395
2396 idx = tty->index;
2397 pty_master = (tty->driver->type == TTY_DRIVER_TYPE_PTY &&
2398 tty->driver->subtype == PTY_TYPE_MASTER);
2399 devpts = (tty->driver->flags & TTY_DRIVER_DEVPTS_MEM) != 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002400 o_tty = tty->link;
2401
2402#ifdef TTY_PARANOIA_CHECK
2403 if (idx < 0 || idx >= tty->driver->num) {
2404 printk(KERN_DEBUG "release_dev: bad idx when trying to "
2405 "free (%s)\n", tty->name);
2406 return;
2407 }
2408 if (!(tty->driver->flags & TTY_DRIVER_DEVPTS_MEM)) {
2409 if (tty != tty->driver->ttys[idx]) {
2410 printk(KERN_DEBUG "release_dev: driver.table[%d] not tty "
2411 "for (%s)\n", idx, tty->name);
2412 return;
2413 }
2414 if (tty->termios != tty->driver->termios[idx]) {
2415 printk(KERN_DEBUG "release_dev: driver.termios[%d] not termios "
2416 "for (%s)\n",
2417 idx, tty->name);
2418 return;
2419 }
2420 if (tty->termios_locked != tty->driver->termios_locked[idx]) {
2421 printk(KERN_DEBUG "release_dev: driver.termios_locked[%d] not "
2422 "termios_locked for (%s)\n",
2423 idx, tty->name);
2424 return;
2425 }
2426 }
2427#endif
2428
2429#ifdef TTY_DEBUG_HANGUP
2430 printk(KERN_DEBUG "release_dev of %s (tty count=%d)...",
2431 tty_name(tty, buf), tty->count);
2432#endif
2433
2434#ifdef TTY_PARANOIA_CHECK
2435 if (tty->driver->other &&
2436 !(tty->driver->flags & TTY_DRIVER_DEVPTS_MEM)) {
2437 if (o_tty != tty->driver->other->ttys[idx]) {
2438 printk(KERN_DEBUG "release_dev: other->table[%d] "
2439 "not o_tty for (%s)\n",
2440 idx, tty->name);
2441 return;
2442 }
2443 if (o_tty->termios != tty->driver->other->termios[idx]) {
2444 printk(KERN_DEBUG "release_dev: other->termios[%d] "
2445 "not o_termios for (%s)\n",
2446 idx, tty->name);
2447 return;
2448 }
Alan Cox37bdfb02008-02-08 04:18:47 -08002449 if (o_tty->termios_locked !=
Linus Torvalds1da177e2005-04-16 15:20:36 -07002450 tty->driver->other->termios_locked[idx]) {
2451 printk(KERN_DEBUG "release_dev: other->termios_locked["
2452 "%d] not o_termios_locked for (%s)\n",
2453 idx, tty->name);
2454 return;
2455 }
2456 if (o_tty->link != tty) {
2457 printk(KERN_DEBUG "release_dev: bad pty pointers\n");
2458 return;
2459 }
2460 }
2461#endif
Alan Coxf34d7a52008-04-30 00:54:13 -07002462 if (tty->ops->close)
2463 tty->ops->close(tty, filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002464
2465 /*
2466 * Sanity check: if tty->count is going to zero, there shouldn't be
2467 * any waiters on tty->read_wait or tty->write_wait. We test the
2468 * wait queues and kick everyone out _before_ actually starting to
2469 * close. This ensures that we won't block while releasing the tty
2470 * structure.
2471 *
2472 * The test for the o_tty closing is necessary, since the master and
2473 * slave sides may close in any order. If the slave side closes out
2474 * first, its count will be one, since the master side holds an open.
2475 * Thus this test wouldn't be triggered at the time the slave closes,
2476 * so we do it now.
2477 *
2478 * Note that it's possible for the tty to be opened again while we're
2479 * flushing out waiters. By recalculating the closing flags before
2480 * each iteration we avoid any problems.
2481 */
2482 while (1) {
2483 /* Guard against races with tty->count changes elsewhere and
2484 opens on /dev/tty */
Alan Cox37bdfb02008-02-08 04:18:47 -08002485
Ingo Molnar70522e12006-03-23 03:00:31 -08002486 mutex_lock(&tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002487 tty_closing = tty->count <= 1;
2488 o_tty_closing = o_tty &&
2489 (o_tty->count <= (pty_master ? 1 : 0));
Linus Torvalds1da177e2005-04-16 15:20:36 -07002490 do_sleep = 0;
2491
2492 if (tty_closing) {
2493 if (waitqueue_active(&tty->read_wait)) {
2494 wake_up(&tty->read_wait);
2495 do_sleep++;
2496 }
2497 if (waitqueue_active(&tty->write_wait)) {
2498 wake_up(&tty->write_wait);
2499 do_sleep++;
2500 }
2501 }
2502 if (o_tty_closing) {
2503 if (waitqueue_active(&o_tty->read_wait)) {
2504 wake_up(&o_tty->read_wait);
2505 do_sleep++;
2506 }
2507 if (waitqueue_active(&o_tty->write_wait)) {
2508 wake_up(&o_tty->write_wait);
2509 do_sleep++;
2510 }
2511 }
2512 if (!do_sleep)
2513 break;
2514
2515 printk(KERN_WARNING "release_dev: %s: read/write wait queue "
2516 "active!\n", tty_name(tty, buf));
Ingo Molnar70522e12006-03-23 03:00:31 -08002517 mutex_unlock(&tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002518 schedule();
Alan Cox37bdfb02008-02-08 04:18:47 -08002519 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002520
2521 /*
Alan Cox37bdfb02008-02-08 04:18:47 -08002522 * The closing flags are now consistent with the open counts on
2523 * both sides, and we've completed the last operation that could
Linus Torvalds1da177e2005-04-16 15:20:36 -07002524 * block, so it's safe to proceed with closing.
2525 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002526 if (pty_master) {
2527 if (--o_tty->count < 0) {
2528 printk(KERN_WARNING "release_dev: bad pty slave count "
2529 "(%d) for %s\n",
2530 o_tty->count, tty_name(o_tty, buf));
2531 o_tty->count = 0;
2532 }
2533 }
2534 if (--tty->count < 0) {
2535 printk(KERN_WARNING "release_dev: bad tty->count (%d) for %s\n",
2536 tty->count, tty_name(tty, buf));
2537 tty->count = 0;
2538 }
Alan Cox37bdfb02008-02-08 04:18:47 -08002539
Linus Torvalds1da177e2005-04-16 15:20:36 -07002540 /*
2541 * We've decremented tty->count, so we need to remove this file
2542 * descriptor off the tty->tty_files list; this serves two
2543 * purposes:
2544 * - check_tty_count sees the correct number of file descriptors
2545 * associated with this tty.
2546 * - do_tty_hangup no longer sees this file descriptor as
2547 * something that needs to be handled for hangups.
2548 */
2549 file_kill(filp);
2550 filp->private_data = NULL;
2551
2552 /*
2553 * Perform some housekeeping before deciding whether to return.
2554 *
2555 * Set the TTY_CLOSING flag if this was the last open. In the
2556 * case of a pty we may have to wait around for the other side
2557 * to close, and TTY_CLOSING makes sure we can't be reopened.
2558 */
Alan Cox37bdfb02008-02-08 04:18:47 -08002559 if (tty_closing)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002560 set_bit(TTY_CLOSING, &tty->flags);
Alan Cox37bdfb02008-02-08 04:18:47 -08002561 if (o_tty_closing)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002562 set_bit(TTY_CLOSING, &o_tty->flags);
2563
2564 /*
2565 * If _either_ side is closing, make sure there aren't any
2566 * processes that still think tty or o_tty is their controlling
2567 * tty.
2568 */
2569 if (tty_closing || o_tty_closing) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002570 read_lock(&tasklist_lock);
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002571 session_clear_tty(tty->session);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002572 if (o_tty)
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002573 session_clear_tty(o_tty->session);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002574 read_unlock(&tasklist_lock);
2575 }
2576
Ingo Molnar70522e12006-03-23 03:00:31 -08002577 mutex_unlock(&tty_mutex);
Paul Fulghumda965822006-02-14 13:53:00 -08002578
Linus Torvalds1da177e2005-04-16 15:20:36 -07002579 /* check whether both sides are closing ... */
2580 if (!tty_closing || (o_tty && !o_tty_closing))
2581 return;
Alan Cox37bdfb02008-02-08 04:18:47 -08002582
Linus Torvalds1da177e2005-04-16 15:20:36 -07002583#ifdef TTY_DEBUG_HANGUP
2584 printk(KERN_DEBUG "freeing tty structure...");
2585#endif
2586 /*
2587 * Prevent flush_to_ldisc() from rescheduling the work for later. Then
2588 * kill any delayed work. As this is the final close it does not
2589 * race with the set_ldisc code path.
2590 */
2591 clear_bit(TTY_LDISC, &tty->flags);
Alan Cox33f0f882006-01-09 20:54:13 -08002592 cancel_delayed_work(&tty->buf.work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002593
2594 /*
Alan Cox33f0f882006-01-09 20:54:13 -08002595 * Wait for ->hangup_work and ->buf.work handlers to terminate
Linus Torvalds1da177e2005-04-16 15:20:36 -07002596 */
Alan Cox37bdfb02008-02-08 04:18:47 -08002597
Linus Torvalds1da177e2005-04-16 15:20:36 -07002598 flush_scheduled_work();
Alan Cox37bdfb02008-02-08 04:18:47 -08002599
Linus Torvalds1da177e2005-04-16 15:20:36 -07002600 /*
2601 * Wait for any short term users (we know they are just driver
2602 * side waiters as the file is closing so user count on the file
2603 * side is zero.
2604 */
2605 spin_lock_irqsave(&tty_ldisc_lock, flags);
Alan Cox37bdfb02008-02-08 04:18:47 -08002606 while (tty->ldisc.refcount) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002607 spin_unlock_irqrestore(&tty_ldisc_lock, flags);
2608 wait_event(tty_ldisc_wait, tty->ldisc.refcount == 0);
2609 spin_lock_irqsave(&tty_ldisc_lock, flags);
2610 }
2611 spin_unlock_irqrestore(&tty_ldisc_lock, flags);
2612 /*
2613 * Shutdown the current line discipline, and reset it to N_TTY.
2614 * N.B. why reset ldisc when we're releasing the memory??
2615 *
2616 * FIXME: this MUST get fixed for the new reflocking
2617 */
2618 if (tty->ldisc.close)
2619 (tty->ldisc.close)(tty);
2620 tty_ldisc_put(tty->ldisc.num);
Alan Cox37bdfb02008-02-08 04:18:47 -08002621
Linus Torvalds1da177e2005-04-16 15:20:36 -07002622 /*
2623 * Switch the line discipline back
2624 */
2625 tty_ldisc_assign(tty, tty_ldisc_get(N_TTY));
Alan Cox37bdfb02008-02-08 04:18:47 -08002626 tty_set_termios_ldisc(tty, N_TTY);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002627 if (o_tty) {
2628 /* FIXME: could o_tty be in setldisc here ? */
2629 clear_bit(TTY_LDISC, &o_tty->flags);
2630 if (o_tty->ldisc.close)
2631 (o_tty->ldisc.close)(o_tty);
2632 tty_ldisc_put(o_tty->ldisc.num);
2633 tty_ldisc_assign(o_tty, tty_ldisc_get(N_TTY));
Alan Cox37bdfb02008-02-08 04:18:47 -08002634 tty_set_termios_ldisc(o_tty, N_TTY);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002635 }
2636 /*
Christoph Hellwigd5698c22007-02-10 01:46:46 -08002637 * The release_tty function takes care of the details of clearing
Linus Torvalds1da177e2005-04-16 15:20:36 -07002638 * the slots and preserving the termios structure.
2639 */
Christoph Hellwigd5698c22007-02-10 01:46:46 -08002640 release_tty(tty, idx);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002641
Linus Torvalds1da177e2005-04-16 15:20:36 -07002642 /* Make this pty number available for reallocation */
Sukadev Bhattiprolu718a9162008-04-30 00:54:21 -07002643 if (devpts)
2644 devpts_kill_index(idx);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002645}
2646
Alan Coxaf9b8972006-08-27 01:24:01 -07002647/**
2648 * tty_open - open a tty device
2649 * @inode: inode of device file
2650 * @filp: file pointer to tty
Linus Torvalds1da177e2005-04-16 15:20:36 -07002651 *
Alan Coxaf9b8972006-08-27 01:24:01 -07002652 * tty_open and tty_release keep up the tty count that contains the
2653 * number of opens done on a tty. We cannot use the inode-count, as
2654 * different inodes might point to the same tty.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002655 *
Alan Coxaf9b8972006-08-27 01:24:01 -07002656 * Open-counting is needed for pty masters, as well as for keeping
2657 * track of serial lines: DTR is dropped when the last close happens.
2658 * (This is not done solely through tty->count, now. - Ted 1/27/92)
2659 *
2660 * The termios state of a pty is reset on first open so that
2661 * settings don't persist across reuse.
2662 *
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002663 * Locking: tty_mutex protects tty, get_tty_driver and init_dev work.
2664 * tty->count should protect the rest.
2665 * ->siglock protects ->signal/->sighand
Linus Torvalds1da177e2005-04-16 15:20:36 -07002666 */
Alan Coxaf9b8972006-08-27 01:24:01 -07002667
Jonathan Corbet39d95b92008-05-16 09:10:50 -06002668static int __tty_open(struct inode *inode, struct file *filp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002669{
2670 struct tty_struct *tty;
2671 int noctty, retval;
2672 struct tty_driver *driver;
2673 int index;
2674 dev_t device = inode->i_rdev;
2675 unsigned short saved_flags = filp->f_flags;
2676
2677 nonseekable_open(inode, filp);
Alan Cox37bdfb02008-02-08 04:18:47 -08002678
Linus Torvalds1da177e2005-04-16 15:20:36 -07002679retry_open:
2680 noctty = filp->f_flags & O_NOCTTY;
2681 index = -1;
2682 retval = 0;
Alan Cox37bdfb02008-02-08 04:18:47 -08002683
Ingo Molnar70522e12006-03-23 03:00:31 -08002684 mutex_lock(&tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002685
Alan Cox37bdfb02008-02-08 04:18:47 -08002686 if (device == MKDEV(TTYAUX_MAJOR, 0)) {
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002687 tty = get_current_tty();
2688 if (!tty) {
Ingo Molnar70522e12006-03-23 03:00:31 -08002689 mutex_unlock(&tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002690 return -ENXIO;
2691 }
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002692 driver = tty->driver;
2693 index = tty->index;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002694 filp->f_flags |= O_NONBLOCK; /* Don't let /dev/tty block */
2695 /* noctty = 1; */
2696 goto got_driver;
2697 }
2698#ifdef CONFIG_VT
Alan Cox37bdfb02008-02-08 04:18:47 -08002699 if (device == MKDEV(TTY_MAJOR, 0)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002700 extern struct tty_driver *console_driver;
2701 driver = console_driver;
2702 index = fg_console;
2703 noctty = 1;
2704 goto got_driver;
2705 }
2706#endif
Alan Cox37bdfb02008-02-08 04:18:47 -08002707 if (device == MKDEV(TTYAUX_MAJOR, 1)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002708 driver = console_device(&index);
2709 if (driver) {
2710 /* Don't let /dev/console block */
2711 filp->f_flags |= O_NONBLOCK;
2712 noctty = 1;
2713 goto got_driver;
2714 }
Ingo Molnar70522e12006-03-23 03:00:31 -08002715 mutex_unlock(&tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002716 return -ENODEV;
2717 }
2718
2719 driver = get_tty_driver(device, &index);
2720 if (!driver) {
Ingo Molnar70522e12006-03-23 03:00:31 -08002721 mutex_unlock(&tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002722 return -ENODEV;
2723 }
2724got_driver:
2725 retval = init_dev(driver, index, &tty);
Ingo Molnar70522e12006-03-23 03:00:31 -08002726 mutex_unlock(&tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002727 if (retval)
2728 return retval;
2729
2730 filp->private_data = tty;
2731 file_move(filp, &tty->tty_files);
2732 check_tty_count(tty, "tty_open");
2733 if (tty->driver->type == TTY_DRIVER_TYPE_PTY &&
2734 tty->driver->subtype == PTY_TYPE_MASTER)
2735 noctty = 1;
2736#ifdef TTY_DEBUG_HANGUP
2737 printk(KERN_DEBUG "opening %s...", tty->name);
2738#endif
2739 if (!retval) {
Alan Coxf34d7a52008-04-30 00:54:13 -07002740 if (tty->ops->open)
2741 retval = tty->ops->open(tty, filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002742 else
2743 retval = -ENODEV;
2744 }
2745 filp->f_flags = saved_flags;
2746
Alan Cox37bdfb02008-02-08 04:18:47 -08002747 if (!retval && test_bit(TTY_EXCLUSIVE, &tty->flags) &&
2748 !capable(CAP_SYS_ADMIN))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002749 retval = -EBUSY;
2750
2751 if (retval) {
2752#ifdef TTY_DEBUG_HANGUP
2753 printk(KERN_DEBUG "error %d in opening %s...", retval,
2754 tty->name);
2755#endif
2756 release_dev(filp);
2757 if (retval != -ERESTARTSYS)
2758 return retval;
2759 if (signal_pending(current))
2760 return retval;
2761 schedule();
2762 /*
2763 * Need to reset f_op in case a hangup happened.
2764 */
2765 if (filp->f_op == &hung_up_tty_fops)
2766 filp->f_op = &tty_fops;
2767 goto retry_open;
2768 }
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002769
2770 mutex_lock(&tty_mutex);
2771 spin_lock_irq(&current->sighand->siglock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002772 if (!noctty &&
2773 current->signal->leader &&
2774 !current->signal->tty &&
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08002775 tty->session == NULL)
Eric W. Biederman2a65f1d2007-05-08 00:26:53 -07002776 __proc_set_tty(current, tty);
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002777 spin_unlock_irq(&current->sighand->siglock);
2778 mutex_unlock(&tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002779 return 0;
2780}
2781
Jonathan Corbet39d95b92008-05-16 09:10:50 -06002782/* BKL pushdown: scary code avoidance wrapper */
2783static int tty_open(struct inode *inode, struct file *filp)
2784{
2785 int ret;
2786
2787 lock_kernel();
2788 ret = __tty_open(inode, filp);
2789 unlock_kernel();
2790 return ret;
2791}
2792
2793
2794
Linus Torvalds1da177e2005-04-16 15:20:36 -07002795#ifdef CONFIG_UNIX98_PTYS
Alan Coxaf9b8972006-08-27 01:24:01 -07002796/**
2797 * ptmx_open - open a unix 98 pty master
2798 * @inode: inode of device file
2799 * @filp: file pointer to tty
2800 *
2801 * Allocate a unix98 pty master device from the ptmx driver.
2802 *
2803 * Locking: tty_mutex protects theinit_dev work. tty->count should
Alan Cox37bdfb02008-02-08 04:18:47 -08002804 * protect the rest.
Alan Coxaf9b8972006-08-27 01:24:01 -07002805 * allocated_ptys_lock handles the list of free pty numbers
2806 */
2807
Jonathan Corbet39d95b92008-05-16 09:10:50 -06002808static int __ptmx_open(struct inode *inode, struct file *filp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002809{
2810 struct tty_struct *tty;
2811 int retval;
2812 int index;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002813
2814 nonseekable_open(inode, filp);
2815
2816 /* find a device that is not in use. */
Sukadev Bhattiprolu718a9162008-04-30 00:54:21 -07002817 index = devpts_new_index();
2818 if (index < 0)
2819 return index;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002820
Ingo Molnar70522e12006-03-23 03:00:31 -08002821 mutex_lock(&tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002822 retval = init_dev(ptm_driver, index, &tty);
Ingo Molnar70522e12006-03-23 03:00:31 -08002823 mutex_unlock(&tty_mutex);
Alan Cox37bdfb02008-02-08 04:18:47 -08002824
Linus Torvalds1da177e2005-04-16 15:20:36 -07002825 if (retval)
2826 goto out;
2827
2828 set_bit(TTY_PTY_LOCK, &tty->flags); /* LOCK THE SLAVE */
2829 filp->private_data = tty;
2830 file_move(filp, &tty->tty_files);
2831
Sukadev Bhattiprolu4f8f9d62008-04-30 00:54:20 -07002832 retval = devpts_pty_new(tty->link);
2833 if (retval)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002834 goto out1;
2835
Hiroshi Shimamoto86a96532008-04-30 00:54:20 -07002836 check_tty_count(tty, "ptmx_open");
Alan Coxf34d7a52008-04-30 00:54:13 -07002837 retval = ptm_driver->ops->open(tty, filp);
Miloslav Trmac41126222008-04-18 13:30:14 -07002838 if (!retval)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002839 return 0;
2840out1:
2841 release_dev(filp);
Paul Fulghum9453a5a2006-04-10 22:54:18 -07002842 return retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002843out:
Sukadev Bhattiprolu718a9162008-04-30 00:54:21 -07002844 devpts_kill_index(index);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002845 return retval;
2846}
Jonathan Corbet39d95b92008-05-16 09:10:50 -06002847
2848static int ptmx_open(struct inode *inode, struct file *filp)
2849{
2850 int ret;
2851
2852 lock_kernel();
2853 ret = __ptmx_open(inode, filp);
2854 unlock_kernel();
2855 return ret;
2856}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002857#endif
2858
Alan Coxaf9b8972006-08-27 01:24:01 -07002859/**
2860 * tty_release - vfs callback for close
2861 * @inode: inode of tty
2862 * @filp: file pointer for handle to tty
2863 *
2864 * Called the last time each file handle is closed that references
2865 * this tty. There may however be several such references.
2866 *
2867 * Locking:
2868 * Takes bkl. See release_dev
2869 */
2870
Alan Cox37bdfb02008-02-08 04:18:47 -08002871static int tty_release(struct inode *inode, struct file *filp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002872{
2873 lock_kernel();
2874 release_dev(filp);
2875 unlock_kernel();
2876 return 0;
2877}
2878
Alan Coxaf9b8972006-08-27 01:24:01 -07002879/**
2880 * tty_poll - check tty status
2881 * @filp: file being polled
2882 * @wait: poll wait structures to update
2883 *
2884 * Call the line discipline polling method to obtain the poll
2885 * status of the device.
2886 *
2887 * Locking: locks called line discipline but ldisc poll method
2888 * may be re-entered freely by other callers.
2889 */
2890
Alan Cox37bdfb02008-02-08 04:18:47 -08002891static unsigned int tty_poll(struct file *filp, poll_table *wait)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002892{
Alan Cox37bdfb02008-02-08 04:18:47 -08002893 struct tty_struct *tty;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002894 struct tty_ldisc *ld;
2895 int ret = 0;
2896
2897 tty = (struct tty_struct *)filp->private_data;
Josef Sipeka7113a92006-12-08 02:36:55 -08002898 if (tty_paranoia_check(tty, filp->f_path.dentry->d_inode, "tty_poll"))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002899 return 0;
Alan Cox37bdfb02008-02-08 04:18:47 -08002900
Linus Torvalds1da177e2005-04-16 15:20:36 -07002901 ld = tty_ldisc_ref_wait(tty);
2902 if (ld->poll)
2903 ret = (ld->poll)(tty, filp, wait);
2904 tty_ldisc_deref(ld);
2905 return ret;
2906}
2907
Alan Cox37bdfb02008-02-08 04:18:47 -08002908static int tty_fasync(int fd, struct file *filp, int on)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002909{
Alan Cox37bdfb02008-02-08 04:18:47 -08002910 struct tty_struct *tty;
Alan Cox47f86832008-04-30 00:53:30 -07002911 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002912 int retval;
2913
2914 tty = (struct tty_struct *)filp->private_data;
Josef Sipeka7113a92006-12-08 02:36:55 -08002915 if (tty_paranoia_check(tty, filp->f_path.dentry->d_inode, "tty_fasync"))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002916 return 0;
Alan Cox37bdfb02008-02-08 04:18:47 -08002917
Linus Torvalds1da177e2005-04-16 15:20:36 -07002918 retval = fasync_helper(fd, filp, on, &tty->fasync);
2919 if (retval <= 0)
2920 return retval;
2921
2922 if (on) {
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08002923 enum pid_type type;
2924 struct pid *pid;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002925 if (!waitqueue_active(&tty->read_wait))
2926 tty->minimum_to_wake = 1;
Alan Cox47f86832008-04-30 00:53:30 -07002927 spin_lock_irqsave(&tty->ctrl_lock, flags);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08002928 if (tty->pgrp) {
2929 pid = tty->pgrp;
2930 type = PIDTYPE_PGID;
2931 } else {
2932 pid = task_pid(current);
2933 type = PIDTYPE_PID;
2934 }
Alan Cox47f86832008-04-30 00:53:30 -07002935 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08002936 retval = __f_setown(filp, pid, type, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002937 if (retval)
2938 return retval;
2939 } else {
2940 if (!tty->fasync && !waitqueue_active(&tty->read_wait))
2941 tty->minimum_to_wake = N_TTY_BUF_SIZE;
2942 }
2943 return 0;
2944}
2945
Alan Coxaf9b8972006-08-27 01:24:01 -07002946/**
2947 * tiocsti - fake input character
2948 * @tty: tty to fake input into
2949 * @p: pointer to character
2950 *
Robert P. J. Day3a4fa0a2007-10-19 23:10:43 +02002951 * Fake input to a tty device. Does the necessary locking and
Alan Coxaf9b8972006-08-27 01:24:01 -07002952 * input management.
2953 *
2954 * FIXME: does not honour flow control ??
2955 *
2956 * Locking:
2957 * Called functions take tty_ldisc_lock
2958 * current->signal->tty check is safe without locks
Alan Cox28298232006-09-29 02:00:58 -07002959 *
2960 * FIXME: may race normal receive processing
Alan Coxaf9b8972006-08-27 01:24:01 -07002961 */
2962
Linus Torvalds1da177e2005-04-16 15:20:36 -07002963static int tiocsti(struct tty_struct *tty, char __user *p)
2964{
2965 char ch, mbz = 0;
2966 struct tty_ldisc *ld;
Alan Cox37bdfb02008-02-08 04:18:47 -08002967
Linus Torvalds1da177e2005-04-16 15:20:36 -07002968 if ((current->signal->tty != tty) && !capable(CAP_SYS_ADMIN))
2969 return -EPERM;
2970 if (get_user(ch, p))
2971 return -EFAULT;
2972 ld = tty_ldisc_ref_wait(tty);
2973 ld->receive_buf(tty, &ch, &mbz, 1);
2974 tty_ldisc_deref(ld);
2975 return 0;
2976}
2977
Alan Coxaf9b8972006-08-27 01:24:01 -07002978/**
2979 * tiocgwinsz - implement window query ioctl
2980 * @tty; tty
2981 * @arg: user buffer for result
2982 *
Alan Cox808a0d32006-09-29 02:00:40 -07002983 * Copies the kernel idea of the window size into the user buffer.
Alan Coxaf9b8972006-08-27 01:24:01 -07002984 *
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002985 * Locking: tty->termios_mutex is taken to ensure the winsize data
Alan Cox808a0d32006-09-29 02:00:40 -07002986 * is consistent.
Alan Coxaf9b8972006-08-27 01:24:01 -07002987 */
2988
Alan Cox37bdfb02008-02-08 04:18:47 -08002989static int tiocgwinsz(struct tty_struct *tty, struct winsize __user *arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002990{
Alan Cox808a0d32006-09-29 02:00:40 -07002991 int err;
2992
Arjan van de Ven5785c952006-09-29 02:00:43 -07002993 mutex_lock(&tty->termios_mutex);
Alan Cox808a0d32006-09-29 02:00:40 -07002994 err = copy_to_user(arg, &tty->winsize, sizeof(*arg));
Arjan van de Ven5785c952006-09-29 02:00:43 -07002995 mutex_unlock(&tty->termios_mutex);
Alan Cox808a0d32006-09-29 02:00:40 -07002996
2997 return err ? -EFAULT: 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002998}
2999
Alan Coxaf9b8972006-08-27 01:24:01 -07003000/**
3001 * tiocswinsz - implement window size set ioctl
3002 * @tty; tty
3003 * @arg: user buffer for result
3004 *
3005 * Copies the user idea of the window size to the kernel. Traditionally
3006 * this is just advisory information but for the Linux console it
3007 * actually has driver level meaning and triggers a VC resize.
3008 *
3009 * Locking:
Alan Coxca9bda02006-09-29 02:00:03 -07003010 * Called function use the console_sem is used to ensure we do
3011 * not try and resize the console twice at once.
Peter Zijlstra24ec8392006-12-08 02:36:04 -08003012 * The tty->termios_mutex is used to ensure we don't double
3013 * resize and get confused. Lock order - tty->termios_mutex before
Alan Coxca9bda02006-09-29 02:00:03 -07003014 * console sem
Alan Coxaf9b8972006-08-27 01:24:01 -07003015 */
3016
Linus Torvalds1da177e2005-04-16 15:20:36 -07003017static int tiocswinsz(struct tty_struct *tty, struct tty_struct *real_tty,
Alan Cox37bdfb02008-02-08 04:18:47 -08003018 struct winsize __user *arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003019{
3020 struct winsize tmp_ws;
Alan Cox47f86832008-04-30 00:53:30 -07003021 struct pid *pgrp, *rpgrp;
3022 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003023
3024 if (copy_from_user(&tmp_ws, arg, sizeof(*arg)))
3025 return -EFAULT;
Alan Coxca9bda02006-09-29 02:00:03 -07003026
Arjan van de Ven5785c952006-09-29 02:00:43 -07003027 mutex_lock(&tty->termios_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003028 if (!memcmp(&tmp_ws, &tty->winsize, sizeof(*arg)))
Alan Coxca9bda02006-09-29 02:00:03 -07003029 goto done;
3030
Linus Torvalds1da177e2005-04-16 15:20:36 -07003031#ifdef CONFIG_VT
3032 if (tty->driver->type == TTY_DRIVER_TYPE_CONSOLE) {
Arjan van de Ven5785c952006-09-29 02:00:43 -07003033 if (vc_lock_resize(tty->driver_data, tmp_ws.ws_col,
3034 tmp_ws.ws_row)) {
3035 mutex_unlock(&tty->termios_mutex);
Alan Cox37bdfb02008-02-08 04:18:47 -08003036 return -ENXIO;
Alan Coxca9bda02006-09-29 02:00:03 -07003037 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003038 }
3039#endif
Alan Cox47f86832008-04-30 00:53:30 -07003040 /* Get the PID values and reference them so we can
3041 avoid holding the tty ctrl lock while sending signals */
3042 spin_lock_irqsave(&tty->ctrl_lock, flags);
3043 pgrp = get_pid(tty->pgrp);
3044 rpgrp = get_pid(real_tty->pgrp);
3045 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
3046
3047 if (pgrp)
3048 kill_pgrp(pgrp, SIGWINCH, 1);
3049 if (rpgrp != pgrp && rpgrp)
3050 kill_pgrp(rpgrp, SIGWINCH, 1);
3051
3052 put_pid(pgrp);
3053 put_pid(rpgrp);
3054
Linus Torvalds1da177e2005-04-16 15:20:36 -07003055 tty->winsize = tmp_ws;
3056 real_tty->winsize = tmp_ws;
Alan Coxca9bda02006-09-29 02:00:03 -07003057done:
Arjan van de Ven5785c952006-09-29 02:00:43 -07003058 mutex_unlock(&tty->termios_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003059 return 0;
3060}
3061
Alan Coxaf9b8972006-08-27 01:24:01 -07003062/**
3063 * tioccons - allow admin to move logical console
3064 * @file: the file to become console
3065 *
3066 * Allow the adminstrator to move the redirected console device
3067 *
3068 * Locking: uses redirect_lock to guard the redirect information
3069 */
3070
Linus Torvalds1da177e2005-04-16 15:20:36 -07003071static int tioccons(struct file *file)
3072{
3073 if (!capable(CAP_SYS_ADMIN))
3074 return -EPERM;
3075 if (file->f_op->write == redirected_tty_write) {
3076 struct file *f;
3077 spin_lock(&redirect_lock);
3078 f = redirect;
3079 redirect = NULL;
3080 spin_unlock(&redirect_lock);
3081 if (f)
3082 fput(f);
3083 return 0;
3084 }
3085 spin_lock(&redirect_lock);
3086 if (redirect) {
3087 spin_unlock(&redirect_lock);
3088 return -EBUSY;
3089 }
3090 get_file(file);
3091 redirect = file;
3092 spin_unlock(&redirect_lock);
3093 return 0;
3094}
3095
Alan Coxaf9b8972006-08-27 01:24:01 -07003096/**
3097 * fionbio - non blocking ioctl
3098 * @file: file to set blocking value
3099 * @p: user parameter
3100 *
3101 * Historical tty interfaces had a blocking control ioctl before
3102 * the generic functionality existed. This piece of history is preserved
3103 * in the expected tty API of posix OS's.
3104 *
3105 * Locking: none, the open fle handle ensures it won't go away.
3106 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003107
3108static int fionbio(struct file *file, int __user *p)
3109{
3110 int nonblock;
3111
3112 if (get_user(nonblock, p))
3113 return -EFAULT;
3114
Alan Cox04f378b2008-04-30 00:53:29 -07003115 /* file->f_flags is still BKL protected in the fs layer - vomit */
3116 lock_kernel();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003117 if (nonblock)
3118 file->f_flags |= O_NONBLOCK;
3119 else
3120 file->f_flags &= ~O_NONBLOCK;
Alan Cox04f378b2008-04-30 00:53:29 -07003121 unlock_kernel();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003122 return 0;
3123}
3124
Alan Coxaf9b8972006-08-27 01:24:01 -07003125/**
3126 * tiocsctty - set controlling tty
3127 * @tty: tty structure
3128 * @arg: user argument
3129 *
3130 * This ioctl is used to manage job control. It permits a session
3131 * leader to set this tty as the controlling tty for the session.
3132 *
3133 * Locking:
Alan Cox28298232006-09-29 02:00:58 -07003134 * Takes tty_mutex() to protect tty instance
Peter Zijlstra24ec8392006-12-08 02:36:04 -08003135 * Takes tasklist_lock internally to walk sessions
3136 * Takes ->siglock() when updating signal->tty
Alan Coxaf9b8972006-08-27 01:24:01 -07003137 */
3138
Linus Torvalds1da177e2005-04-16 15:20:36 -07003139static int tiocsctty(struct tty_struct *tty, int arg)
3140{
Peter Zijlstra24ec8392006-12-08 02:36:04 -08003141 int ret = 0;
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08003142 if (current->signal->leader && (task_session(current) == tty->session))
Peter Zijlstra24ec8392006-12-08 02:36:04 -08003143 return ret;
3144
3145 mutex_lock(&tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003146 /*
3147 * The process must be a session leader and
3148 * not have a controlling tty already.
3149 */
Peter Zijlstra24ec8392006-12-08 02:36:04 -08003150 if (!current->signal->leader || current->signal->tty) {
3151 ret = -EPERM;
3152 goto unlock;
3153 }
3154
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08003155 if (tty->session) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07003156 /*
3157 * This tty is already the controlling
3158 * tty for another session group!
3159 */
Alan Cox37bdfb02008-02-08 04:18:47 -08003160 if (arg == 1 && capable(CAP_SYS_ADMIN)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07003161 /*
3162 * Steal it away
3163 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003164 read_lock(&tasklist_lock);
Peter Zijlstra24ec8392006-12-08 02:36:04 -08003165 session_clear_tty(tty->session);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003166 read_unlock(&tasklist_lock);
Peter Zijlstra24ec8392006-12-08 02:36:04 -08003167 } else {
3168 ret = -EPERM;
3169 goto unlock;
3170 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003171 }
Peter Zijlstra24ec8392006-12-08 02:36:04 -08003172 proc_set_tty(current, tty);
3173unlock:
Alan Cox28298232006-09-29 02:00:58 -07003174 mutex_unlock(&tty_mutex);
Peter Zijlstra24ec8392006-12-08 02:36:04 -08003175 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003176}
3177
Alan Coxaf9b8972006-08-27 01:24:01 -07003178/**
Alan Cox5d0fdf12008-04-30 00:53:31 -07003179 * tty_get_pgrp - return a ref counted pgrp pid
3180 * @tty: tty to read
3181 *
3182 * Returns a refcounted instance of the pid struct for the process
3183 * group controlling the tty.
3184 */
3185
3186struct pid *tty_get_pgrp(struct tty_struct *tty)
3187{
3188 unsigned long flags;
3189 struct pid *pgrp;
3190
3191 spin_lock_irqsave(&tty->ctrl_lock, flags);
3192 pgrp = get_pid(tty->pgrp);
3193 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
3194
3195 return pgrp;
3196}
3197EXPORT_SYMBOL_GPL(tty_get_pgrp);
3198
3199/**
Alan Coxaf9b8972006-08-27 01:24:01 -07003200 * tiocgpgrp - get process group
3201 * @tty: tty passed by user
3202 * @real_tty: tty side of the tty pased by the user if a pty else the tty
3203 * @p: returned pid
3204 *
3205 * Obtain the process group of the tty. If there is no process group
3206 * return an error.
3207 *
Peter Zijlstra24ec8392006-12-08 02:36:04 -08003208 * Locking: none. Reference to current->signal->tty is safe.
Alan Coxaf9b8972006-08-27 01:24:01 -07003209 */
3210
Linus Torvalds1da177e2005-04-16 15:20:36 -07003211static int tiocgpgrp(struct tty_struct *tty, struct tty_struct *real_tty, pid_t __user *p)
3212{
Alan Cox5d0fdf12008-04-30 00:53:31 -07003213 struct pid *pid;
3214 int ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003215 /*
3216 * (tty == real_tty) is a cheap way of
3217 * testing if the tty is NOT a master pty.
3218 */
3219 if (tty == real_tty && current->signal->tty != real_tty)
3220 return -ENOTTY;
Alan Cox5d0fdf12008-04-30 00:53:31 -07003221 pid = tty_get_pgrp(real_tty);
3222 ret = put_user(pid_vnr(pid), p);
3223 put_pid(pid);
3224 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003225}
3226
Alan Coxaf9b8972006-08-27 01:24:01 -07003227/**
3228 * tiocspgrp - attempt to set process group
3229 * @tty: tty passed by user
3230 * @real_tty: tty side device matching tty passed by user
3231 * @p: pid pointer
3232 *
3233 * Set the process group of the tty to the session passed. Only
3234 * permitted where the tty session is our session.
3235 *
Alan Cox47f86832008-04-30 00:53:30 -07003236 * Locking: RCU, ctrl lock
Alan Coxaf9b8972006-08-27 01:24:01 -07003237 */
3238
Linus Torvalds1da177e2005-04-16 15:20:36 -07003239static int tiocspgrp(struct tty_struct *tty, struct tty_struct *real_tty, pid_t __user *p)
3240{
Eric W. Biederman04a2e6a2007-02-12 00:52:56 -08003241 struct pid *pgrp;
3242 pid_t pgrp_nr;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003243 int retval = tty_check_change(real_tty);
Alan Cox47f86832008-04-30 00:53:30 -07003244 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003245
3246 if (retval == -EIO)
3247 return -ENOTTY;
3248 if (retval)
3249 return retval;
3250 if (!current->signal->tty ||
3251 (current->signal->tty != real_tty) ||
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08003252 (real_tty->session != task_session(current)))
Linus Torvalds1da177e2005-04-16 15:20:36 -07003253 return -ENOTTY;
Eric W. Biederman04a2e6a2007-02-12 00:52:56 -08003254 if (get_user(pgrp_nr, p))
Linus Torvalds1da177e2005-04-16 15:20:36 -07003255 return -EFAULT;
Eric W. Biederman04a2e6a2007-02-12 00:52:56 -08003256 if (pgrp_nr < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003257 return -EINVAL;
Eric W. Biederman04a2e6a2007-02-12 00:52:56 -08003258 rcu_read_lock();
Pavel Emelyanovb4888932007-10-18 23:40:14 -07003259 pgrp = find_vpid(pgrp_nr);
Eric W. Biederman04a2e6a2007-02-12 00:52:56 -08003260 retval = -ESRCH;
3261 if (!pgrp)
3262 goto out_unlock;
3263 retval = -EPERM;
3264 if (session_of_pgrp(pgrp) != task_session(current))
3265 goto out_unlock;
3266 retval = 0;
Alan Cox47f86832008-04-30 00:53:30 -07003267 spin_lock_irqsave(&tty->ctrl_lock, flags);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08003268 put_pid(real_tty->pgrp);
3269 real_tty->pgrp = get_pid(pgrp);
Alan Cox47f86832008-04-30 00:53:30 -07003270 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
Eric W. Biederman04a2e6a2007-02-12 00:52:56 -08003271out_unlock:
3272 rcu_read_unlock();
3273 return retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003274}
3275
Alan Coxaf9b8972006-08-27 01:24:01 -07003276/**
3277 * tiocgsid - get session id
3278 * @tty: tty passed by user
3279 * @real_tty: tty side of the tty pased by the user if a pty else the tty
3280 * @p: pointer to returned session id
3281 *
3282 * Obtain the session id of the tty. If there is no session
3283 * return an error.
3284 *
Peter Zijlstra24ec8392006-12-08 02:36:04 -08003285 * Locking: none. Reference to current->signal->tty is safe.
Alan Coxaf9b8972006-08-27 01:24:01 -07003286 */
3287
Linus Torvalds1da177e2005-04-16 15:20:36 -07003288static int tiocgsid(struct tty_struct *tty, struct tty_struct *real_tty, pid_t __user *p)
3289{
3290 /*
3291 * (tty == real_tty) is a cheap way of
3292 * testing if the tty is NOT a master pty.
3293 */
3294 if (tty == real_tty && current->signal->tty != real_tty)
3295 return -ENOTTY;
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08003296 if (!real_tty->session)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003297 return -ENOTTY;
Pavel Emelyanovb4888932007-10-18 23:40:14 -07003298 return put_user(pid_vnr(real_tty->session), p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003299}
3300
Alan Coxaf9b8972006-08-27 01:24:01 -07003301/**
3302 * tiocsetd - set line discipline
3303 * @tty: tty device
3304 * @p: pointer to user data
3305 *
3306 * Set the line discipline according to user request.
3307 *
3308 * Locking: see tty_set_ldisc, this function is just a helper
3309 */
3310
Linus Torvalds1da177e2005-04-16 15:20:36 -07003311static int tiocsetd(struct tty_struct *tty, int __user *p)
3312{
3313 int ldisc;
Alan Cox04f378b2008-04-30 00:53:29 -07003314 int ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003315
3316 if (get_user(ldisc, p))
3317 return -EFAULT;
Alan Cox04f378b2008-04-30 00:53:29 -07003318
3319 lock_kernel();
3320 ret = tty_set_ldisc(tty, ldisc);
3321 unlock_kernel();
3322
3323 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003324}
3325
Alan Coxaf9b8972006-08-27 01:24:01 -07003326/**
3327 * send_break - performed time break
3328 * @tty: device to break on
3329 * @duration: timeout in mS
3330 *
3331 * Perform a timed break on hardware that lacks its own driver level
3332 * timed break functionality.
3333 *
3334 * Locking:
Alan Cox28298232006-09-29 02:00:58 -07003335 * atomic_write_lock serializes
Alan Coxaf9b8972006-08-27 01:24:01 -07003336 *
Alan Coxaf9b8972006-08-27 01:24:01 -07003337 */
3338
Domen Puncerb20f3ae2005-06-25 14:58:42 -07003339static int send_break(struct tty_struct *tty, unsigned int duration)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003340{
Alan Cox9c1729d2007-07-15 23:39:43 -07003341 if (tty_write_lock(tty, 0) < 0)
Alan Coxf34d7a52008-04-30 00:54:13 -07003342 return -EINTR;
3343 tty->ops->break_ctl(tty, -1);
Alan Cox9c1729d2007-07-15 23:39:43 -07003344 if (!signal_pending(current))
Domen Puncerb20f3ae2005-06-25 14:58:42 -07003345 msleep_interruptible(duration);
Alan Coxf34d7a52008-04-30 00:54:13 -07003346 tty->ops->break_ctl(tty, 0);
Alan Cox9c1729d2007-07-15 23:39:43 -07003347 tty_write_unlock(tty);
Alan Cox04f378b2008-04-30 00:53:29 -07003348 if (!signal_pending(current))
Alan Coxf34d7a52008-04-30 00:54:13 -07003349 return -EINTR;
3350 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003351}
3352
Alan Coxaf9b8972006-08-27 01:24:01 -07003353/**
Alan Coxf34d7a52008-04-30 00:54:13 -07003354 * tty_tiocmget - get modem status
Alan Coxaf9b8972006-08-27 01:24:01 -07003355 * @tty: tty device
3356 * @file: user file pointer
3357 * @p: pointer to result
3358 *
3359 * Obtain the modem status bits from the tty driver if the feature
3360 * is supported. Return -EINVAL if it is not available.
3361 *
3362 * Locking: none (up to the driver)
3363 */
3364
3365static int tty_tiocmget(struct tty_struct *tty, struct file *file, int __user *p)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003366{
3367 int retval = -EINVAL;
3368
Alan Coxf34d7a52008-04-30 00:54:13 -07003369 if (tty->ops->tiocmget) {
3370 retval = tty->ops->tiocmget(tty, file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003371
3372 if (retval >= 0)
3373 retval = put_user(retval, p);
3374 }
3375 return retval;
3376}
3377
Alan Coxaf9b8972006-08-27 01:24:01 -07003378/**
Alan Coxf34d7a52008-04-30 00:54:13 -07003379 * tty_tiocmset - set modem status
Alan Coxaf9b8972006-08-27 01:24:01 -07003380 * @tty: tty device
3381 * @file: user file pointer
3382 * @cmd: command - clear bits, set bits or set all
3383 * @p: pointer to desired bits
3384 *
3385 * Set the modem status bits from the tty driver if the feature
3386 * is supported. Return -EINVAL if it is not available.
3387 *
3388 * Locking: none (up to the driver)
3389 */
3390
3391static int tty_tiocmset(struct tty_struct *tty, struct file *file, unsigned int cmd,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003392 unsigned __user *p)
3393{
3394 int retval = -EINVAL;
3395
Alan Coxf34d7a52008-04-30 00:54:13 -07003396 if (tty->ops->tiocmset) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07003397 unsigned int set, clear, val;
3398
3399 retval = get_user(val, p);
3400 if (retval)
3401 return retval;
3402
3403 set = clear = 0;
3404 switch (cmd) {
3405 case TIOCMBIS:
3406 set = val;
3407 break;
3408 case TIOCMBIC:
3409 clear = val;
3410 break;
3411 case TIOCMSET:
3412 set = val;
3413 clear = ~val;
3414 break;
3415 }
3416
3417 set &= TIOCM_DTR|TIOCM_RTS|TIOCM_OUT1|TIOCM_OUT2|TIOCM_LOOP;
3418 clear &= TIOCM_DTR|TIOCM_RTS|TIOCM_OUT1|TIOCM_OUT2|TIOCM_LOOP;
3419
Alan Coxf34d7a52008-04-30 00:54:13 -07003420 retval = tty->ops->tiocmset(tty, file, set, clear);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003421 }
3422 return retval;
3423}
3424
3425/*
3426 * Split this up, as gcc can choke on it otherwise..
3427 */
Alan Cox04f378b2008-04-30 00:53:29 -07003428long tty_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003429{
3430 struct tty_struct *tty, *real_tty;
3431 void __user *p = (void __user *)arg;
3432 int retval;
3433 struct tty_ldisc *ld;
Alan Cox04f378b2008-04-30 00:53:29 -07003434 struct inode *inode = file->f_dentry->d_inode;
Alan Cox37bdfb02008-02-08 04:18:47 -08003435
Linus Torvalds1da177e2005-04-16 15:20:36 -07003436 tty = (struct tty_struct *)file->private_data;
3437 if (tty_paranoia_check(tty, inode, "tty_ioctl"))
3438 return -EINVAL;
3439
3440 real_tty = tty;
3441 if (tty->driver->type == TTY_DRIVER_TYPE_PTY &&
3442 tty->driver->subtype == PTY_TYPE_MASTER)
3443 real_tty = tty->link;
3444
3445 /*
3446 * Break handling by driver
3447 */
Alan Cox04f378b2008-04-30 00:53:29 -07003448
3449 retval = -EINVAL;
3450
Alan Coxf34d7a52008-04-30 00:54:13 -07003451 if (!tty->ops->break_ctl) {
Alan Cox37bdfb02008-02-08 04:18:47 -08003452 switch (cmd) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07003453 case TIOCSBRK:
3454 case TIOCCBRK:
Alan Coxf34d7a52008-04-30 00:54:13 -07003455 if (tty->ops->ioctl)
3456 retval = tty->ops->ioctl(tty, file, cmd, arg);
3457 if (retval != -EINVAL && retval != -ENOIOCTLCMD)
3458 printk(KERN_WARNING "tty: driver %s needs updating to use break_ctl\n", tty->driver->name);
Alan Cox04f378b2008-04-30 00:53:29 -07003459 return retval;
Alan Cox37bdfb02008-02-08 04:18:47 -08003460
Linus Torvalds1da177e2005-04-16 15:20:36 -07003461 /* These two ioctl's always return success; even if */
3462 /* the driver doesn't support them. */
3463 case TCSBRK:
3464 case TCSBRKP:
Alan Coxf34d7a52008-04-30 00:54:13 -07003465 if (!tty->ops->ioctl)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003466 return 0;
Alan Coxf34d7a52008-04-30 00:54:13 -07003467 retval = tty->ops->ioctl(tty, file, cmd, arg);
3468 if (retval != -EINVAL && retval != -ENOIOCTLCMD)
3469 printk(KERN_WARNING "tty: driver %s needs updating to use break_ctl\n", tty->driver->name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003470 if (retval == -ENOIOCTLCMD)
3471 retval = 0;
3472 return retval;
3473 }
3474 }
3475
3476 /*
3477 * Factor out some common prep work
3478 */
3479 switch (cmd) {
3480 case TIOCSETD:
3481 case TIOCSBRK:
3482 case TIOCCBRK:
3483 case TCSBRK:
Alan Cox37bdfb02008-02-08 04:18:47 -08003484 case TCSBRKP:
Linus Torvalds1da177e2005-04-16 15:20:36 -07003485 retval = tty_check_change(tty);
3486 if (retval)
3487 return retval;
3488 if (cmd != TIOCCBRK) {
3489 tty_wait_until_sent(tty, 0);
3490 if (signal_pending(current))
3491 return -EINTR;
3492 }
3493 break;
3494 }
3495
3496 switch (cmd) {
Alan Cox37bdfb02008-02-08 04:18:47 -08003497 case TIOCSTI:
3498 return tiocsti(tty, p);
3499 case TIOCGWINSZ:
3500 return tiocgwinsz(tty, p);
3501 case TIOCSWINSZ:
3502 return tiocswinsz(tty, real_tty, p);
3503 case TIOCCONS:
3504 return real_tty != tty ? -EINVAL : tioccons(file);
3505 case FIONBIO:
3506 return fionbio(file, p);
3507 case TIOCEXCL:
3508 set_bit(TTY_EXCLUSIVE, &tty->flags);
3509 return 0;
3510 case TIOCNXCL:
3511 clear_bit(TTY_EXCLUSIVE, &tty->flags);
3512 return 0;
3513 case TIOCNOTTY:
3514 if (current->signal->tty != tty)
3515 return -ENOTTY;
3516 no_tty();
3517 return 0;
3518 case TIOCSCTTY:
3519 return tiocsctty(tty, arg);
3520 case TIOCGPGRP:
3521 return tiocgpgrp(tty, real_tty, p);
3522 case TIOCSPGRP:
3523 return tiocspgrp(tty, real_tty, p);
3524 case TIOCGSID:
3525 return tiocgsid(tty, real_tty, p);
3526 case TIOCGETD:
Alan Cox37bdfb02008-02-08 04:18:47 -08003527 return put_user(tty->ldisc.num, (int __user *)p);
3528 case TIOCSETD:
3529 return tiocsetd(tty, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003530#ifdef CONFIG_VT
Alan Cox37bdfb02008-02-08 04:18:47 -08003531 case TIOCLINUX:
3532 return tioclinux(tty, arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003533#endif
Alan Cox37bdfb02008-02-08 04:18:47 -08003534 /*
3535 * Break handling
3536 */
3537 case TIOCSBRK: /* Turn break on, unconditionally */
Alan Coxf34d7a52008-04-30 00:54:13 -07003538 if (tty->ops->break_ctl)
3539 tty->ops->break_ctl(tty, -1);
Alan Cox37bdfb02008-02-08 04:18:47 -08003540 return 0;
3541
3542 case TIOCCBRK: /* Turn break off, unconditionally */
Alan Coxf34d7a52008-04-30 00:54:13 -07003543 if (tty->ops->break_ctl)
3544 tty->ops->break_ctl(tty, 0);
Alan Cox37bdfb02008-02-08 04:18:47 -08003545 return 0;
3546 case TCSBRK: /* SVID version: non-zero arg --> no break */
3547 /* non-zero arg means wait for all output data
3548 * to be sent (performed above) but don't send break.
3549 * This is used by the tcdrain() termios function.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003550 */
Alan Cox37bdfb02008-02-08 04:18:47 -08003551 if (!arg)
3552 return send_break(tty, 250);
3553 return 0;
3554 case TCSBRKP: /* support for POSIX tcsendbreak() */
3555 return send_break(tty, arg ? arg*100 : 250);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003556
Alan Cox37bdfb02008-02-08 04:18:47 -08003557 case TIOCMGET:
3558 return tty_tiocmget(tty, file, p);
3559 case TIOCMSET:
3560 case TIOCMBIC:
3561 case TIOCMBIS:
3562 return tty_tiocmset(tty, file, cmd, p);
3563 case TCFLSH:
3564 switch (arg) {
3565 case TCIFLUSH:
3566 case TCIOFLUSH:
3567 /* flush tty buffer and allow ldisc to process ioctl */
3568 tty_buffer_flush(tty);
Paul Fulghumc5c34d42007-05-12 10:36:55 -07003569 break;
Alan Cox37bdfb02008-02-08 04:18:47 -08003570 }
3571 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003572 }
Alan Coxf34d7a52008-04-30 00:54:13 -07003573 if (tty->ops->ioctl) {
3574 retval = (tty->ops->ioctl)(tty, file, cmd, arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003575 if (retval != -ENOIOCTLCMD)
3576 return retval;
3577 }
3578 ld = tty_ldisc_ref_wait(tty);
3579 retval = -EINVAL;
3580 if (ld->ioctl) {
3581 retval = ld->ioctl(tty, file, cmd, arg);
3582 if (retval == -ENOIOCTLCMD)
3583 retval = -EINVAL;
3584 }
3585 tty_ldisc_deref(ld);
3586 return retval;
3587}
3588
Paul Fulghume10cc1d2007-05-10 22:22:50 -07003589#ifdef CONFIG_COMPAT
Alan Cox37bdfb02008-02-08 04:18:47 -08003590static long tty_compat_ioctl(struct file *file, unsigned int cmd,
Paul Fulghume10cc1d2007-05-10 22:22:50 -07003591 unsigned long arg)
3592{
3593 struct inode *inode = file->f_dentry->d_inode;
3594 struct tty_struct *tty = file->private_data;
3595 struct tty_ldisc *ld;
3596 int retval = -ENOIOCTLCMD;
3597
3598 if (tty_paranoia_check(tty, inode, "tty_ioctl"))
3599 return -EINVAL;
3600
Alan Coxf34d7a52008-04-30 00:54:13 -07003601 if (tty->ops->compat_ioctl) {
3602 retval = (tty->ops->compat_ioctl)(tty, file, cmd, arg);
Paul Fulghume10cc1d2007-05-10 22:22:50 -07003603 if (retval != -ENOIOCTLCMD)
3604 return retval;
3605 }
3606
3607 ld = tty_ldisc_ref_wait(tty);
3608 if (ld->compat_ioctl)
3609 retval = ld->compat_ioctl(tty, file, cmd, arg);
3610 tty_ldisc_deref(ld);
3611
3612 return retval;
3613}
3614#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07003615
3616/*
3617 * This implements the "Secure Attention Key" --- the idea is to
3618 * prevent trojan horses by killing all processes associated with this
3619 * tty when the user hits the "Secure Attention Key". Required for
3620 * super-paranoid applications --- see the Orange Book for more details.
Alan Cox37bdfb02008-02-08 04:18:47 -08003621 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07003622 * This code could be nicer; ideally it should send a HUP, wait a few
3623 * seconds, then send a INT, and then a KILL signal. But you then
3624 * have to coordinate with the init process, since all processes associated
3625 * with the current tty must be dead before the new getty is allowed
3626 * to spawn.
3627 *
3628 * Now, if it would be correct ;-/ The current code has a nasty hole -
3629 * it doesn't catch files in flight. We may send the descriptor to ourselves
3630 * via AF_UNIX socket, close it and later fetch from socket. FIXME.
3631 *
3632 * Nasty bug: do_SAK is being called in interrupt context. This can
3633 * deadlock. We punt it up to process context. AKPM - 16Mar2001
3634 */
Eric W. Biederman8b6312f2007-02-10 01:44:34 -08003635void __do_SAK(struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003636{
3637#ifdef TTY_SOFT_SAK
3638 tty_hangup(tty);
3639#else
Eric W. Biederman652486f2006-03-28 16:11:02 -08003640 struct task_struct *g, *p;
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08003641 struct pid *session;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003642 int i;
3643 struct file *filp;
Dipankar Sarmabadf1662005-09-09 13:04:10 -07003644 struct fdtable *fdt;
Alan Cox37bdfb02008-02-08 04:18:47 -08003645
Linus Torvalds1da177e2005-04-16 15:20:36 -07003646 if (!tty)
3647 return;
Peter Zijlstra24ec8392006-12-08 02:36:04 -08003648 session = tty->session;
Alan Cox37bdfb02008-02-08 04:18:47 -08003649
Dan Carpenterb3f13de2006-12-13 00:35:09 -08003650 tty_ldisc_flush(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003651
Alan Coxf34d7a52008-04-30 00:54:13 -07003652 tty_driver_flush_buffer(tty);
Alan Cox37bdfb02008-02-08 04:18:47 -08003653
Linus Torvalds1da177e2005-04-16 15:20:36 -07003654 read_lock(&tasklist_lock);
Eric W. Biederman652486f2006-03-28 16:11:02 -08003655 /* Kill the entire session */
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08003656 do_each_pid_task(session, PIDTYPE_SID, p) {
Eric W. Biederman652486f2006-03-28 16:11:02 -08003657 printk(KERN_NOTICE "SAK: killed process %d"
Pavel Emelianova47afb02007-10-18 23:39:46 -07003658 " (%s): task_session_nr(p)==tty->session\n",
Pavel Emelyanovba25f9d2007-10-18 23:40:40 -07003659 task_pid_nr(p), p->comm);
Eric W. Biederman652486f2006-03-28 16:11:02 -08003660 send_sig(SIGKILL, p, 1);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08003661 } while_each_pid_task(session, PIDTYPE_SID, p);
Eric W. Biederman652486f2006-03-28 16:11:02 -08003662 /* Now kill any processes that happen to have the
3663 * tty open.
3664 */
3665 do_each_thread(g, p) {
3666 if (p->signal->tty == tty) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07003667 printk(KERN_NOTICE "SAK: killed process %d"
Pavel Emelianova47afb02007-10-18 23:39:46 -07003668 " (%s): task_session_nr(p)==tty->session\n",
Pavel Emelyanovba25f9d2007-10-18 23:40:40 -07003669 task_pid_nr(p), p->comm);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003670 send_sig(SIGKILL, p, 1);
3671 continue;
3672 }
3673 task_lock(p);
3674 if (p->files) {
Dipankar Sarmaca99c1d2006-04-18 22:21:46 -07003675 /*
3676 * We don't take a ref to the file, so we must
3677 * hold ->file_lock instead.
3678 */
3679 spin_lock(&p->files->file_lock);
Dipankar Sarmabadf1662005-09-09 13:04:10 -07003680 fdt = files_fdtable(p->files);
Alan Cox37bdfb02008-02-08 04:18:47 -08003681 for (i = 0; i < fdt->max_fds; i++) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07003682 filp = fcheck_files(p->files, i);
3683 if (!filp)
3684 continue;
3685 if (filp->f_op->read == tty_read &&
3686 filp->private_data == tty) {
3687 printk(KERN_NOTICE "SAK: killed process %d"
3688 " (%s): fd#%d opened to the tty\n",
Pavel Emelyanovba25f9d2007-10-18 23:40:40 -07003689 task_pid_nr(p), p->comm, i);
Eric W. Biederman20ac9432006-04-13 04:49:07 -06003690 force_sig(SIGKILL, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003691 break;
3692 }
3693 }
Dipankar Sarmaca99c1d2006-04-18 22:21:46 -07003694 spin_unlock(&p->files->file_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003695 }
3696 task_unlock(p);
Eric W. Biederman652486f2006-03-28 16:11:02 -08003697 } while_each_thread(g, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003698 read_unlock(&tasklist_lock);
3699#endif
3700}
3701
Eric W. Biederman8b6312f2007-02-10 01:44:34 -08003702static void do_SAK_work(struct work_struct *work)
3703{
3704 struct tty_struct *tty =
3705 container_of(work, struct tty_struct, SAK_work);
3706 __do_SAK(tty);
3707}
3708
Linus Torvalds1da177e2005-04-16 15:20:36 -07003709/*
3710 * The tq handling here is a little racy - tty->SAK_work may already be queued.
3711 * Fortunately we don't need to worry, because if ->SAK_work is already queued,
3712 * the values which we write to it will be identical to the values which it
3713 * already has. --akpm
3714 */
3715void do_SAK(struct tty_struct *tty)
3716{
3717 if (!tty)
3718 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003719 schedule_work(&tty->SAK_work);
3720}
3721
3722EXPORT_SYMBOL(do_SAK);
3723
Alan Coxaf9b8972006-08-27 01:24:01 -07003724/**
3725 * flush_to_ldisc
David Howells65f27f32006-11-22 14:55:48 +00003726 * @work: tty structure passed from work queue.
Alan Coxaf9b8972006-08-27 01:24:01 -07003727 *
3728 * This routine is called out of the software interrupt to flush data
3729 * from the buffer chain to the line discipline.
3730 *
3731 * Locking: holds tty->buf.lock to guard buffer list. Drops the lock
3732 * while invoking the line discipline receive_buf method. The
3733 * receive_buf method is single threaded for each tty instance.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003734 */
Alan Cox37bdfb02008-02-08 04:18:47 -08003735
David Howells65f27f32006-11-22 14:55:48 +00003736static void flush_to_ldisc(struct work_struct *work)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003737{
David Howells65f27f32006-11-22 14:55:48 +00003738 struct tty_struct *tty =
3739 container_of(work, struct tty_struct, buf.work.work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003740 unsigned long flags;
3741 struct tty_ldisc *disc;
Paul Fulghum2c3bb202006-06-28 04:26:48 -07003742 struct tty_buffer *tbuf, *head;
Paul Fulghum8977d922006-02-10 01:51:14 -08003743 char *char_buf;
3744 unsigned char *flag_buf;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003745
3746 disc = tty_ldisc_ref(tty);
3747 if (disc == NULL) /* !TTY_LDISC */
3748 return;
3749
Paul Fulghum808249c2006-02-03 03:04:41 -08003750 spin_lock_irqsave(&tty->buf.lock, flags);
Alan Cox37bdfb02008-02-08 04:18:47 -08003751 /* So we know a flush is running */
3752 set_bit(TTY_FLUSHING, &tty->flags);
Paul Fulghum2c3bb202006-06-28 04:26:48 -07003753 head = tty->buf.head;
3754 if (head != NULL) {
3755 tty->buf.head = NULL;
3756 for (;;) {
3757 int count = head->commit - head->read;
3758 if (!count) {
3759 if (head->next == NULL)
3760 break;
3761 tbuf = head;
3762 head = head->next;
3763 tty_buffer_free(tty, tbuf);
3764 continue;
3765 }
Alan Cox42fd5522007-08-10 13:01:05 -07003766 /* Ldisc or user is trying to flush the buffers
3767 we are feeding to the ldisc, stop feeding the
3768 line discipline as we want to empty the queue */
3769 if (test_bit(TTY_FLUSHPENDING, &tty->flags))
3770 break;
Paul Fulghum2c3bb202006-06-28 04:26:48 -07003771 if (!tty->receive_room) {
3772 schedule_delayed_work(&tty->buf.work, 1);
3773 break;
3774 }
3775 if (count > tty->receive_room)
3776 count = tty->receive_room;
3777 char_buf = head->char_buf_ptr + head->read;
3778 flag_buf = head->flag_buf_ptr + head->read;
3779 head->read += count;
Paul Fulghum8977d922006-02-10 01:51:14 -08003780 spin_unlock_irqrestore(&tty->buf.lock, flags);
3781 disc->receive_buf(tty, char_buf, flag_buf, count);
3782 spin_lock_irqsave(&tty->buf.lock, flags);
3783 }
Alan Cox42fd5522007-08-10 13:01:05 -07003784 /* Restore the queue head */
Paul Fulghum2c3bb202006-06-28 04:26:48 -07003785 tty->buf.head = head;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003786 }
Alan Cox42fd5522007-08-10 13:01:05 -07003787 /* We may have a deferred request to flush the input buffer,
3788 if so pull the chain under the lock and empty the queue */
3789 if (test_bit(TTY_FLUSHPENDING, &tty->flags)) {
3790 __tty_buffer_flush(tty);
3791 clear_bit(TTY_FLUSHPENDING, &tty->flags);
3792 wake_up(&tty->read_wait);
3793 }
3794 clear_bit(TTY_FLUSHING, &tty->flags);
Paul Fulghum808249c2006-02-03 03:04:41 -08003795 spin_unlock_irqrestore(&tty->buf.lock, flags);
Paul Fulghum817d6d32006-06-28 04:26:47 -07003796
Linus Torvalds1da177e2005-04-16 15:20:36 -07003797 tty_ldisc_deref(disc);
3798}
3799
Linus Torvalds1da177e2005-04-16 15:20:36 -07003800/**
3801 * tty_flip_buffer_push - terminal
3802 * @tty: tty to push
3803 *
3804 * Queue a push of the terminal flip buffers to the line discipline. This
3805 * function must not be called from IRQ context if tty->low_latency is set.
3806 *
3807 * In the event of the queue being busy for flipping the work will be
3808 * held off and retried later.
Alan Coxaf9b8972006-08-27 01:24:01 -07003809 *
3810 * Locking: tty buffer lock. Driver locks in low latency mode.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003811 */
3812
3813void tty_flip_buffer_push(struct tty_struct *tty)
3814{
Paul Fulghum808249c2006-02-03 03:04:41 -08003815 unsigned long flags;
3816 spin_lock_irqsave(&tty->buf.lock, flags);
Paul Fulghum33b37a32006-06-28 04:26:49 -07003817 if (tty->buf.tail != NULL)
Paul Fulghum8977d922006-02-10 01:51:14 -08003818 tty->buf.tail->commit = tty->buf.tail->used;
Paul Fulghum808249c2006-02-03 03:04:41 -08003819 spin_unlock_irqrestore(&tty->buf.lock, flags);
3820
Linus Torvalds1da177e2005-04-16 15:20:36 -07003821 if (tty->low_latency)
David Howells65f27f32006-11-22 14:55:48 +00003822 flush_to_ldisc(&tty->buf.work.work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003823 else
Alan Cox33f0f882006-01-09 20:54:13 -08003824 schedule_delayed_work(&tty->buf.work, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003825}
3826
3827EXPORT_SYMBOL(tty_flip_buffer_push);
3828
Alan Cox33f0f882006-01-09 20:54:13 -08003829
Alan Coxaf9b8972006-08-27 01:24:01 -07003830/**
3831 * initialize_tty_struct
3832 * @tty: tty to initialize
3833 *
3834 * This subroutine initializes a tty structure that has been newly
3835 * allocated.
3836 *
3837 * Locking: none - tty in question must not be exposed at this point
Linus Torvalds1da177e2005-04-16 15:20:36 -07003838 */
Alan Coxaf9b8972006-08-27 01:24:01 -07003839
Linus Torvalds1da177e2005-04-16 15:20:36 -07003840static void initialize_tty_struct(struct tty_struct *tty)
3841{
3842 memset(tty, 0, sizeof(struct tty_struct));
3843 tty->magic = TTY_MAGIC;
3844 tty_ldisc_assign(tty, tty_ldisc_get(N_TTY));
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08003845 tty->session = NULL;
3846 tty->pgrp = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003847 tty->overrun_time = jiffies;
Alan Cox33f0f882006-01-09 20:54:13 -08003848 tty->buf.head = tty->buf.tail = NULL;
3849 tty_buffer_init(tty);
David Howells65f27f32006-11-22 14:55:48 +00003850 INIT_DELAYED_WORK(&tty->buf.work, flush_to_ldisc);
Arjan van de Ven5785c952006-09-29 02:00:43 -07003851 mutex_init(&tty->termios_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003852 init_waitqueue_head(&tty->write_wait);
3853 init_waitqueue_head(&tty->read_wait);
David Howells65f27f32006-11-22 14:55:48 +00003854 INIT_WORK(&tty->hangup_work, do_tty_hangup);
Ingo Molnar70522e12006-03-23 03:00:31 -08003855 mutex_init(&tty->atomic_read_lock);
3856 mutex_init(&tty->atomic_write_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003857 spin_lock_init(&tty->read_lock);
Alan Cox04f378b2008-04-30 00:53:29 -07003858 spin_lock_init(&tty->ctrl_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003859 INIT_LIST_HEAD(&tty->tty_files);
Eric W. Biederman7f1f86a2007-02-13 14:38:58 -07003860 INIT_WORK(&tty->SAK_work, do_SAK_work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003861}
3862
Alan Coxf34d7a52008-04-30 00:54:13 -07003863/**
3864 * tty_put_char - write one character to a tty
3865 * @tty: tty
3866 * @ch: character
3867 *
3868 * Write one byte to the tty using the provided put_char method
3869 * if present. Returns the number of characters successfully output.
3870 *
3871 * Note: the specific put_char operation in the driver layer may go
3872 * away soon. Don't call it directly, use this method
Linus Torvalds1da177e2005-04-16 15:20:36 -07003873 */
Alan Coxaf9b8972006-08-27 01:24:01 -07003874
Alan Coxf34d7a52008-04-30 00:54:13 -07003875int tty_put_char(struct tty_struct *tty, unsigned char ch)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003876{
Alan Coxf34d7a52008-04-30 00:54:13 -07003877 if (tty->ops->put_char)
3878 return tty->ops->put_char(tty, ch);
3879 return tty->ops->write(tty, &ch, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003880}
3881
Alan Coxf34d7a52008-04-30 00:54:13 -07003882EXPORT_SYMBOL_GPL(tty_put_char);
3883
gregkh@suse.de7fe845d2005-03-15 14:23:15 -08003884static struct class *tty_class;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003885
3886/**
Alan Coxaf9b8972006-08-27 01:24:01 -07003887 * tty_register_device - register a tty device
3888 * @driver: the tty driver that describes the tty device
3889 * @index: the index in the tty driver for this tty device
3890 * @device: a struct device that is associated with this tty device.
3891 * This field is optional, if there is no known struct device
3892 * for this tty device it can be set to NULL safely.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003893 *
Greg Kroah-Hartman01107d32006-08-07 22:19:37 -07003894 * Returns a pointer to the struct device for this tty device
3895 * (or ERR_PTR(-EFOO) on error).
Hansjoerg Lipp1cdcb6b2006-04-22 18:36:53 +02003896 *
Alan Coxaf9b8972006-08-27 01:24:01 -07003897 * This call is required to be made to register an individual tty device
3898 * if the tty driver's flags have the TTY_DRIVER_DYNAMIC_DEV bit set. If
3899 * that bit is not set, this function should not be called by a tty
3900 * driver.
3901 *
3902 * Locking: ??
Linus Torvalds1da177e2005-04-16 15:20:36 -07003903 */
Alan Coxaf9b8972006-08-27 01:24:01 -07003904
Greg Kroah-Hartman01107d32006-08-07 22:19:37 -07003905struct device *tty_register_device(struct tty_driver *driver, unsigned index,
3906 struct device *device)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003907{
3908 char name[64];
3909 dev_t dev = MKDEV(driver->major, driver->minor_start) + index;
3910
3911 if (index >= driver->num) {
3912 printk(KERN_ERR "Attempt to register invalid tty line number "
3913 " (%d).\n", index);
Hansjoerg Lipp1cdcb6b2006-04-22 18:36:53 +02003914 return ERR_PTR(-EINVAL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003915 }
3916
Linus Torvalds1da177e2005-04-16 15:20:36 -07003917 if (driver->type == TTY_DRIVER_TYPE_PTY)
3918 pty_line_name(driver, index, name);
3919 else
3920 tty_line_name(driver, index, name);
Hansjoerg Lipp1cdcb6b2006-04-22 18:36:53 +02003921
Greg Kroah-Hartman01107d32006-08-07 22:19:37 -07003922 return device_create(tty_class, device, dev, name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003923}
3924
3925/**
Alan Coxaf9b8972006-08-27 01:24:01 -07003926 * tty_unregister_device - unregister a tty device
3927 * @driver: the tty driver that describes the tty device
3928 * @index: the index in the tty driver for this tty device
Linus Torvalds1da177e2005-04-16 15:20:36 -07003929 *
Alan Coxaf9b8972006-08-27 01:24:01 -07003930 * If a tty device is registered with a call to tty_register_device() then
3931 * this function must be called when the tty device is gone.
3932 *
3933 * Locking: ??
Linus Torvalds1da177e2005-04-16 15:20:36 -07003934 */
Alan Coxaf9b8972006-08-27 01:24:01 -07003935
Linus Torvalds1da177e2005-04-16 15:20:36 -07003936void tty_unregister_device(struct tty_driver *driver, unsigned index)
3937{
Alan Cox37bdfb02008-02-08 04:18:47 -08003938 device_destroy(tty_class,
3939 MKDEV(driver->major, driver->minor_start) + index);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003940}
3941
3942EXPORT_SYMBOL(tty_register_device);
3943EXPORT_SYMBOL(tty_unregister_device);
3944
3945struct tty_driver *alloc_tty_driver(int lines)
3946{
3947 struct tty_driver *driver;
3948
Jean Delvare506eb992007-07-15 23:40:14 -07003949 driver = kzalloc(sizeof(struct tty_driver), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003950 if (driver) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07003951 driver->magic = TTY_DRIVER_MAGIC;
3952 driver->num = lines;
3953 /* later we'll move allocation of tables here */
3954 }
3955 return driver;
3956}
3957
3958void put_tty_driver(struct tty_driver *driver)
3959{
3960 kfree(driver);
3961}
3962
Jeff Dikeb68e31d2006-10-02 02:17:18 -07003963void tty_set_operations(struct tty_driver *driver,
3964 const struct tty_operations *op)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003965{
Alan Coxf34d7a52008-04-30 00:54:13 -07003966 driver->ops = op;
3967};
Linus Torvalds1da177e2005-04-16 15:20:36 -07003968
3969EXPORT_SYMBOL(alloc_tty_driver);
3970EXPORT_SYMBOL(put_tty_driver);
3971EXPORT_SYMBOL(tty_set_operations);
3972
3973/*
3974 * Called by a tty driver to register itself.
3975 */
3976int tty_register_driver(struct tty_driver *driver)
3977{
3978 int error;
Alan Cox37bdfb02008-02-08 04:18:47 -08003979 int i;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003980 dev_t dev;
3981 void **p = NULL;
3982
3983 if (driver->flags & TTY_DRIVER_INSTALLED)
3984 return 0;
3985
Andy Whitcroft543691a62007-05-06 14:49:33 -07003986 if (!(driver->flags & TTY_DRIVER_DEVPTS_MEM) && driver->num) {
3987 p = kzalloc(driver->num * 3 * sizeof(void *), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003988 if (!p)
3989 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003990 }
3991
3992 if (!driver->major) {
Alan Cox37bdfb02008-02-08 04:18:47 -08003993 error = alloc_chrdev_region(&dev, driver->minor_start,
3994 driver->num, driver->name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003995 if (!error) {
3996 driver->major = MAJOR(dev);
3997 driver->minor_start = MINOR(dev);
3998 }
3999 } else {
4000 dev = MKDEV(driver->major, driver->minor_start);
Geert Uytterhoevene5717c42007-02-20 15:45:21 +01004001 error = register_chrdev_region(dev, driver->num, driver->name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004002 }
4003 if (error < 0) {
4004 kfree(p);
4005 return error;
4006 }
4007
4008 if (p) {
4009 driver->ttys = (struct tty_struct **)p;
Alan Coxedc6afc2006-12-08 02:38:44 -08004010 driver->termios = (struct ktermios **)(p + driver->num);
Alan Cox37bdfb02008-02-08 04:18:47 -08004011 driver->termios_locked = (struct ktermios **)
4012 (p + driver->num * 2);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004013 } else {
4014 driver->ttys = NULL;
4015 driver->termios = NULL;
4016 driver->termios_locked = NULL;
4017 }
4018
4019 cdev_init(&driver->cdev, &tty_fops);
4020 driver->cdev.owner = driver->owner;
4021 error = cdev_add(&driver->cdev, dev, driver->num);
4022 if (error) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07004023 unregister_chrdev_region(dev, driver->num);
4024 driver->ttys = NULL;
4025 driver->termios = driver->termios_locked = NULL;
4026 kfree(p);
4027 return error;
4028 }
4029
Alexey Dobriyanca509f62007-05-08 00:27:12 -07004030 mutex_lock(&tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004031 list_add(&driver->tty_drivers, &tty_drivers);
Alexey Dobriyanca509f62007-05-08 00:27:12 -07004032 mutex_unlock(&tty_mutex);
Alan Cox37bdfb02008-02-08 04:18:47 -08004033
4034 if (!(driver->flags & TTY_DRIVER_DYNAMIC_DEV)) {
4035 for (i = 0; i < driver->num; i++)
Linus Torvalds1da177e2005-04-16 15:20:36 -07004036 tty_register_device(driver, i, NULL);
4037 }
4038 proc_tty_register_driver(driver);
4039 return 0;
4040}
4041
4042EXPORT_SYMBOL(tty_register_driver);
4043
4044/*
4045 * Called by a tty driver to unregister itself.
4046 */
4047int tty_unregister_driver(struct tty_driver *driver)
4048{
4049 int i;
Alan Coxedc6afc2006-12-08 02:38:44 -08004050 struct ktermios *tp;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004051 void *p;
4052
4053 if (driver->refcount)
4054 return -EBUSY;
4055
4056 unregister_chrdev_region(MKDEV(driver->major, driver->minor_start),
4057 driver->num);
Alexey Dobriyanca509f62007-05-08 00:27:12 -07004058 mutex_lock(&tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004059 list_del(&driver->tty_drivers);
Alexey Dobriyanca509f62007-05-08 00:27:12 -07004060 mutex_unlock(&tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004061
4062 /*
4063 * Free the termios and termios_locked structures because
4064 * we don't want to get memory leaks when modular tty
4065 * drivers are removed from the kernel.
4066 */
4067 for (i = 0; i < driver->num; i++) {
4068 tp = driver->termios[i];
4069 if (tp) {
4070 driver->termios[i] = NULL;
4071 kfree(tp);
4072 }
4073 tp = driver->termios_locked[i];
4074 if (tp) {
4075 driver->termios_locked[i] = NULL;
4076 kfree(tp);
4077 }
Greg Kroah-Hartman331b8312005-06-20 21:15:16 -07004078 if (!(driver->flags & TTY_DRIVER_DYNAMIC_DEV))
Linus Torvalds1da177e2005-04-16 15:20:36 -07004079 tty_unregister_device(driver, i);
4080 }
4081 p = driver->ttys;
4082 proc_tty_unregister_driver(driver);
4083 driver->ttys = NULL;
4084 driver->termios = driver->termios_locked = NULL;
4085 kfree(p);
4086 cdev_del(&driver->cdev);
4087 return 0;
4088}
Linus Torvalds1da177e2005-04-16 15:20:36 -07004089EXPORT_SYMBOL(tty_unregister_driver);
4090
Peter Zijlstra24ec8392006-12-08 02:36:04 -08004091dev_t tty_devnum(struct tty_struct *tty)
4092{
4093 return MKDEV(tty->driver->major, tty->driver->minor_start) + tty->index;
4094}
4095EXPORT_SYMBOL(tty_devnum);
4096
4097void proc_clear_tty(struct task_struct *p)
4098{
4099 spin_lock_irq(&p->sighand->siglock);
4100 p->signal->tty = NULL;
4101 spin_unlock_irq(&p->sighand->siglock);
4102}
David S. Miller7cac4ce2007-05-11 14:30:57 -07004103EXPORT_SYMBOL(proc_clear_tty);
Peter Zijlstra24ec8392006-12-08 02:36:04 -08004104
Alan Cox47f86832008-04-30 00:53:30 -07004105/* Called under the sighand lock */
4106
Eric W. Biederman2a65f1d2007-05-08 00:26:53 -07004107static void __proc_set_tty(struct task_struct *tsk, struct tty_struct *tty)
Peter Zijlstra24ec8392006-12-08 02:36:04 -08004108{
4109 if (tty) {
Alan Cox47f86832008-04-30 00:53:30 -07004110 unsigned long flags;
4111 /* We should not have a session or pgrp to put here but.... */
4112 spin_lock_irqsave(&tty->ctrl_lock, flags);
Eric W. Biedermand9c1e9a2007-03-18 12:45:44 -06004113 put_pid(tty->session);
4114 put_pid(tty->pgrp);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08004115 tty->pgrp = get_pid(task_pgrp(tsk));
Alan Cox47f86832008-04-30 00:53:30 -07004116 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
4117 tty->session = get_pid(task_session(tsk));
Peter Zijlstra24ec8392006-12-08 02:36:04 -08004118 }
Eric W. Biederman2a65f1d2007-05-08 00:26:53 -07004119 put_pid(tsk->signal->tty_old_pgrp);
Peter Zijlstra24ec8392006-12-08 02:36:04 -08004120 tsk->signal->tty = tty;
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08004121 tsk->signal->tty_old_pgrp = NULL;
Peter Zijlstra24ec8392006-12-08 02:36:04 -08004122}
4123
Eric W. Biederman98a27ba2007-05-08 00:26:56 -07004124static void proc_set_tty(struct task_struct *tsk, struct tty_struct *tty)
Peter Zijlstra24ec8392006-12-08 02:36:04 -08004125{
4126 spin_lock_irq(&tsk->sighand->siglock);
Eric W. Biederman2a65f1d2007-05-08 00:26:53 -07004127 __proc_set_tty(tsk, tty);
Peter Zijlstra24ec8392006-12-08 02:36:04 -08004128 spin_unlock_irq(&tsk->sighand->siglock);
4129}
4130
4131struct tty_struct *get_current_tty(void)
4132{
4133 struct tty_struct *tty;
4134 WARN_ON_ONCE(!mutex_is_locked(&tty_mutex));
4135 tty = current->signal->tty;
4136 /*
4137 * session->tty can be changed/cleared from under us, make sure we
4138 * issue the load. The obtained pointer, when not NULL, is valid as
4139 * long as we hold tty_mutex.
4140 */
4141 barrier();
4142 return tty;
4143}
Heiko Carstensa311f742006-12-13 00:33:41 -08004144EXPORT_SYMBOL_GPL(get_current_tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004145
4146/*
4147 * Initialize the console device. This is called *early*, so
4148 * we can't necessarily depend on lots of kernel help here.
4149 * Just do some early initializations, and do the complex setup
4150 * later.
4151 */
4152void __init console_init(void)
4153{
4154 initcall_t *call;
4155
4156 /* Setup the default TTY line discipline. */
4157 (void) tty_register_ldisc(N_TTY, &tty_ldisc_N_TTY);
4158
4159 /*
Alan Cox37bdfb02008-02-08 04:18:47 -08004160 * set up the console device so that later boot sequences can
Linus Torvalds1da177e2005-04-16 15:20:36 -07004161 * inform about problems etc..
4162 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07004163 call = __con_initcall_start;
4164 while (call < __con_initcall_end) {
4165 (*call)();
4166 call++;
4167 }
4168}
4169
Linus Torvalds1da177e2005-04-16 15:20:36 -07004170static int __init tty_class_init(void)
4171{
gregkh@suse.de7fe845d2005-03-15 14:23:15 -08004172 tty_class = class_create(THIS_MODULE, "tty");
Linus Torvalds1da177e2005-04-16 15:20:36 -07004173 if (IS_ERR(tty_class))
4174 return PTR_ERR(tty_class);
4175 return 0;
4176}
4177
4178postcore_initcall(tty_class_init);
4179
4180/* 3/2004 jmc: why do these devices exist? */
4181
4182static struct cdev tty_cdev, console_cdev;
4183#ifdef CONFIG_UNIX98_PTYS
4184static struct cdev ptmx_cdev;
4185#endif
4186#ifdef CONFIG_VT
4187static struct cdev vc0_cdev;
4188#endif
4189
4190/*
4191 * Ok, now we can initialize the rest of the tty devices and can count
4192 * on memory allocations, interrupts etc..
4193 */
4194static int __init tty_init(void)
4195{
4196 cdev_init(&tty_cdev, &tty_fops);
4197 if (cdev_add(&tty_cdev, MKDEV(TTYAUX_MAJOR, 0), 1) ||
4198 register_chrdev_region(MKDEV(TTYAUX_MAJOR, 0), 1, "/dev/tty") < 0)
4199 panic("Couldn't register /dev/tty driver\n");
Greg Kroah-Hartman01107d32006-08-07 22:19:37 -07004200 device_create(tty_class, NULL, MKDEV(TTYAUX_MAJOR, 0), "tty");
Linus Torvalds1da177e2005-04-16 15:20:36 -07004201
4202 cdev_init(&console_cdev, &console_fops);
4203 if (cdev_add(&console_cdev, MKDEV(TTYAUX_MAJOR, 1), 1) ||
4204 register_chrdev_region(MKDEV(TTYAUX_MAJOR, 1), 1, "/dev/console") < 0)
4205 panic("Couldn't register /dev/console driver\n");
Greg Kroah-Hartman01107d32006-08-07 22:19:37 -07004206 device_create(tty_class, NULL, MKDEV(TTYAUX_MAJOR, 1), "console");
Linus Torvalds1da177e2005-04-16 15:20:36 -07004207
4208#ifdef CONFIG_UNIX98_PTYS
4209 cdev_init(&ptmx_cdev, &ptmx_fops);
4210 if (cdev_add(&ptmx_cdev, MKDEV(TTYAUX_MAJOR, 2), 1) ||
4211 register_chrdev_region(MKDEV(TTYAUX_MAJOR, 2), 1, "/dev/ptmx") < 0)
4212 panic("Couldn't register /dev/ptmx driver\n");
Greg Kroah-Hartman01107d32006-08-07 22:19:37 -07004213 device_create(tty_class, NULL, MKDEV(TTYAUX_MAJOR, 2), "ptmx");
Linus Torvalds1da177e2005-04-16 15:20:36 -07004214#endif
4215
4216#ifdef CONFIG_VT
4217 cdev_init(&vc0_cdev, &console_fops);
4218 if (cdev_add(&vc0_cdev, MKDEV(TTY_MAJOR, 0), 1) ||
4219 register_chrdev_region(MKDEV(TTY_MAJOR, 0), 1, "/dev/vc/0") < 0)
4220 panic("Couldn't register /dev/tty0 driver\n");
Greg Kroah-Hartman01107d32006-08-07 22:19:37 -07004221 device_create(tty_class, NULL, MKDEV(TTY_MAJOR, 0), "tty0");
Linus Torvalds1da177e2005-04-16 15:20:36 -07004222
4223 vty_init();
4224#endif
4225 return 0;
4226}
4227module_init(tty_init);