blob: 3752edc30c366c7940812fb25c2569c7f88d3b79 [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
22 * makes for cleaner and more compact code. -TYT, 9/17/92
23 *
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
44 *
45 * 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.
65 * alloc_tty_struct() always uses kmalloc() -- Andrew Morton <andrewm@uow.edu.eu> 17Mar01
66 */
67
Linus Torvalds1da177e2005-04-16 15:20:36 -070068#include <linux/types.h>
69#include <linux/major.h>
70#include <linux/errno.h>
71#include <linux/signal.h>
72#include <linux/fcntl.h>
73#include <linux/sched.h>
74#include <linux/interrupt.h>
75#include <linux/tty.h>
76#include <linux/tty_driver.h>
77#include <linux/tty_flip.h>
78#include <linux/devpts_fs.h>
79#include <linux/file.h>
80#include <linux/console.h>
81#include <linux/timer.h>
82#include <linux/ctype.h>
83#include <linux/kd.h>
84#include <linux/mm.h>
85#include <linux/string.h>
86#include <linux/slab.h>
87#include <linux/poll.h>
88#include <linux/proc_fs.h>
89#include <linux/init.h>
90#include <linux/module.h>
91#include <linux/smp_lock.h>
92#include <linux/device.h>
93#include <linux/idr.h>
94#include <linux/wait.h>
95#include <linux/bitops.h>
Domen Puncerb20f3ae2005-06-25 14:58:42 -070096#include <linux/delay.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070097
98#include <asm/uaccess.h>
99#include <asm/system.h>
100
101#include <linux/kbd_kern.h>
102#include <linux/vt_kern.h>
103#include <linux/selection.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700104
105#include <linux/kmod.h>
106
107#undef TTY_DEBUG_HANGUP
108
109#define TTY_PARANOIA_CHECK 1
110#define CHECK_TTY_COUNT 1
111
Alan Coxedc6afc2006-12-08 02:38:44 -0800112struct ktermios tty_std_termios = { /* for the benefit of tty drivers */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700113 .c_iflag = ICRNL | IXON,
114 .c_oflag = OPOST | ONLCR,
115 .c_cflag = B38400 | CS8 | CREAD | HUPCL,
116 .c_lflag = ISIG | ICANON | ECHO | ECHOE | ECHOK |
117 ECHOCTL | ECHOKE | IEXTEN,
Alan Coxedc6afc2006-12-08 02:38:44 -0800118 .c_cc = INIT_C_CC,
119 .c_ispeed = 38400,
120 .c_ospeed = 38400
Linus Torvalds1da177e2005-04-16 15:20:36 -0700121};
122
123EXPORT_SYMBOL(tty_std_termios);
124
125/* This list gets poked at by procfs and various bits of boot up code. This
126 could do with some rationalisation such as pulling the tty proc function
127 into this file */
128
129LIST_HEAD(tty_drivers); /* linked list of tty drivers */
130
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800131/* Mutex to protect creating and releasing a tty. This is shared with
Linus Torvalds1da177e2005-04-16 15:20:36 -0700132 vt.c for deeply disgusting hack reasons */
Ingo Molnar70522e12006-03-23 03:00:31 -0800133DEFINE_MUTEX(tty_mutex);
Alan Coxde2a84f2006-09-29 02:00:57 -0700134EXPORT_SYMBOL(tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700135
136#ifdef CONFIG_UNIX98_PTYS
137extern struct tty_driver *ptm_driver; /* Unix98 pty masters; for /dev/ptmx */
138extern int pty_limit; /* Config limit on Unix98 ptys */
139static DEFINE_IDR(allocated_ptys);
140static DECLARE_MUTEX(allocated_ptys_lock);
141static int ptmx_open(struct inode *, struct file *);
142#endif
143
Linus Torvalds1da177e2005-04-16 15:20:36 -0700144static void initialize_tty_struct(struct tty_struct *tty);
145
146static ssize_t tty_read(struct file *, char __user *, size_t, loff_t *);
147static ssize_t tty_write(struct file *, const char __user *, size_t, loff_t *);
148ssize_t redirected_tty_write(struct file *, const char __user *, size_t, loff_t *);
149static unsigned int tty_poll(struct file *, poll_table *);
150static int tty_open(struct inode *, struct file *);
151static int tty_release(struct inode *, struct file *);
152int tty_ioctl(struct inode * inode, struct file * file,
153 unsigned int cmd, unsigned long arg);
Paul Fulghume10cc1d2007-05-10 22:22:50 -0700154#ifdef CONFIG_COMPAT
155static long tty_compat_ioctl(struct file * file, unsigned int cmd,
156 unsigned long arg);
157#else
158#define tty_compat_ioctl NULL
159#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700160static int tty_fasync(int fd, struct file * filp, int on);
Christoph Hellwigd5698c22007-02-10 01:46:46 -0800161static void release_tty(struct tty_struct *tty, int idx);
Eric W. Biederman2a65f1d2007-05-08 00:26:53 -0700162static void __proc_set_tty(struct task_struct *tsk, struct tty_struct *tty);
Eric W. Biederman98a27ba2007-05-08 00:26:56 -0700163static void proc_set_tty(struct task_struct *tsk, struct tty_struct *tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700164
Alan Coxaf9b8972006-08-27 01:24:01 -0700165/**
166 * alloc_tty_struct - allocate a tty object
167 *
168 * Return a new empty tty structure. The data fields have not
169 * been initialized in any way but has been zeroed
170 *
171 * Locking: none
Alan Coxaf9b8972006-08-27 01:24:01 -0700172 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700173
174static struct tty_struct *alloc_tty_struct(void)
175{
Alan Cox1266b1e2006-09-29 02:00:40 -0700176 return kzalloc(sizeof(struct tty_struct), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700177}
178
Alan Cox33f0f882006-01-09 20:54:13 -0800179static void tty_buffer_free_all(struct tty_struct *);
180
Alan Coxaf9b8972006-08-27 01:24:01 -0700181/**
182 * free_tty_struct - free a disused tty
183 * @tty: tty struct to free
184 *
185 * Free the write buffers, tty queue and tty memory itself.
186 *
187 * Locking: none. Must be called after tty is definitely unused
188 */
189
Linus Torvalds1da177e2005-04-16 15:20:36 -0700190static inline void free_tty_struct(struct tty_struct *tty)
191{
192 kfree(tty->write_buf);
Alan Cox33f0f882006-01-09 20:54:13 -0800193 tty_buffer_free_all(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700194 kfree(tty);
195}
196
197#define TTY_NUMBER(tty) ((tty)->index + (tty)->driver->name_base)
198
Alan Coxaf9b8972006-08-27 01:24:01 -0700199/**
200 * tty_name - return tty naming
201 * @tty: tty structure
202 * @buf: buffer for output
203 *
204 * Convert a tty structure into a name. The name reflects the kernel
205 * naming policy and if udev is in use may not reflect user space
206 *
207 * Locking: none
208 */
209
Linus Torvalds1da177e2005-04-16 15:20:36 -0700210char *tty_name(struct tty_struct *tty, char *buf)
211{
212 if (!tty) /* Hmm. NULL pointer. That's fun. */
213 strcpy(buf, "NULL tty");
214 else
215 strcpy(buf, tty->name);
216 return buf;
217}
218
219EXPORT_SYMBOL(tty_name);
220
Andrew Mortond769a662005-05-05 16:15:50 -0700221int tty_paranoia_check(struct tty_struct *tty, struct inode *inode,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700222 const char *routine)
223{
224#ifdef TTY_PARANOIA_CHECK
225 if (!tty) {
226 printk(KERN_WARNING
227 "null TTY for (%d:%d) in %s\n",
228 imajor(inode), iminor(inode), routine);
229 return 1;
230 }
231 if (tty->magic != TTY_MAGIC) {
232 printk(KERN_WARNING
233 "bad magic number for tty struct (%d:%d) in %s\n",
234 imajor(inode), iminor(inode), routine);
235 return 1;
236 }
237#endif
238 return 0;
239}
240
241static int check_tty_count(struct tty_struct *tty, const char *routine)
242{
243#ifdef CHECK_TTY_COUNT
244 struct list_head *p;
245 int count = 0;
246
247 file_list_lock();
248 list_for_each(p, &tty->tty_files) {
249 count++;
250 }
251 file_list_unlock();
252 if (tty->driver->type == TTY_DRIVER_TYPE_PTY &&
253 tty->driver->subtype == PTY_TYPE_SLAVE &&
254 tty->link && tty->link->count)
255 count++;
256 if (tty->count != count) {
257 printk(KERN_WARNING "Warning: dev (%s) tty->count(%d) "
258 "!= #fd's(%d) in %s\n",
259 tty->name, tty->count, count, routine);
260 return count;
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800261 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700262#endif
263 return 0;
264}
265
266/*
Alan Cox33f0f882006-01-09 20:54:13 -0800267 * Tty buffer allocation management
268 */
269
Alan Cox01da5fd2006-08-27 01:24:02 -0700270/**
271 * tty_buffer_free_all - free buffers used by a tty
272 * @tty: tty to free from
273 *
274 * Remove all the buffers pending on a tty whether queued with data
275 * or in the free ring. Must be called when the tty is no longer in use
276 *
277 * Locking: none
278 */
279
Alan Cox33f0f882006-01-09 20:54:13 -0800280static void tty_buffer_free_all(struct tty_struct *tty)
281{
282 struct tty_buffer *thead;
283 while((thead = tty->buf.head) != NULL) {
284 tty->buf.head = thead->next;
285 kfree(thead);
286 }
287 while((thead = tty->buf.free) != NULL) {
288 tty->buf.free = thead->next;
289 kfree(thead);
290 }
291 tty->buf.tail = NULL;
Alan Cox01da5fd2006-08-27 01:24:02 -0700292 tty->buf.memory_used = 0;
Alan Cox33f0f882006-01-09 20:54:13 -0800293}
294
Alan Cox01da5fd2006-08-27 01:24:02 -0700295/**
296 * tty_buffer_init - prepare a tty buffer structure
297 * @tty: tty to initialise
298 *
299 * Set up the initial state of the buffer management for a tty device.
300 * Must be called before the other tty buffer functions are used.
301 *
302 * Locking: none
303 */
304
Alan Cox33f0f882006-01-09 20:54:13 -0800305static void tty_buffer_init(struct tty_struct *tty)
306{
Paul Fulghum808249c2006-02-03 03:04:41 -0800307 spin_lock_init(&tty->buf.lock);
Alan Cox33f0f882006-01-09 20:54:13 -0800308 tty->buf.head = NULL;
309 tty->buf.tail = NULL;
310 tty->buf.free = NULL;
Alan Cox01da5fd2006-08-27 01:24:02 -0700311 tty->buf.memory_used = 0;
Alan Cox33f0f882006-01-09 20:54:13 -0800312}
313
Alan Cox01da5fd2006-08-27 01:24:02 -0700314/**
315 * tty_buffer_alloc - allocate a tty buffer
316 * @tty: tty device
317 * @size: desired size (characters)
318 *
319 * Allocate a new tty buffer to hold the desired number of characters.
320 * Return NULL if out of memory or the allocation would exceed the
321 * per device queue
322 *
323 * Locking: Caller must hold tty->buf.lock
324 */
325
326static struct tty_buffer *tty_buffer_alloc(struct tty_struct *tty, size_t size)
Alan Cox33f0f882006-01-09 20:54:13 -0800327{
Alan Cox01da5fd2006-08-27 01:24:02 -0700328 struct tty_buffer *p;
329
330 if (tty->buf.memory_used + size > 65536)
331 return NULL;
332 p = kmalloc(sizeof(struct tty_buffer) + 2 * size, GFP_ATOMIC);
Alan Cox33f0f882006-01-09 20:54:13 -0800333 if(p == NULL)
334 return NULL;
335 p->used = 0;
336 p->size = size;
337 p->next = NULL;
Paul Fulghum8977d922006-02-10 01:51:14 -0800338 p->commit = 0;
339 p->read = 0;
Alan Cox33f0f882006-01-09 20:54:13 -0800340 p->char_buf_ptr = (char *)(p->data);
341 p->flag_buf_ptr = (unsigned char *)p->char_buf_ptr + size;
Alan Cox01da5fd2006-08-27 01:24:02 -0700342 tty->buf.memory_used += size;
Alan Cox33f0f882006-01-09 20:54:13 -0800343 return p;
344}
345
Alan Cox01da5fd2006-08-27 01:24:02 -0700346/**
347 * tty_buffer_free - free a tty buffer
348 * @tty: tty owning the buffer
349 * @b: the buffer to free
350 *
351 * Free a tty buffer, or add it to the free list according to our
352 * internal strategy
353 *
354 * Locking: Caller must hold tty->buf.lock
355 */
Alan Cox33f0f882006-01-09 20:54:13 -0800356
357static void tty_buffer_free(struct tty_struct *tty, struct tty_buffer *b)
358{
359 /* Dumb strategy for now - should keep some stats */
Alan Cox01da5fd2006-08-27 01:24:02 -0700360 tty->buf.memory_used -= b->size;
361 WARN_ON(tty->buf.memory_used < 0);
362
Alan Cox33f0f882006-01-09 20:54:13 -0800363 if(b->size >= 512)
364 kfree(b);
365 else {
366 b->next = tty->buf.free;
367 tty->buf.free = b;
368 }
369}
370
Alan Cox01da5fd2006-08-27 01:24:02 -0700371/**
Paul Fulghumc5c34d42007-05-12 10:36:55 -0700372 * tty_buffer_flush - flush full tty buffers
373 * @tty: tty to flush
374 *
375 * flush all the buffers containing receive data
376 *
377 * Locking: none
378 */
379
380static void tty_buffer_flush(struct tty_struct *tty)
381{
382 struct tty_buffer *thead;
383 unsigned long flags;
384
385 spin_lock_irqsave(&tty->buf.lock, flags);
386 while((thead = tty->buf.head) != NULL) {
387 tty->buf.head = thead->next;
388 tty_buffer_free(tty, thead);
389 }
390 tty->buf.tail = NULL;
391 spin_unlock_irqrestore(&tty->buf.lock, flags);
392}
393
394/**
Alan Cox01da5fd2006-08-27 01:24:02 -0700395 * tty_buffer_find - find a free tty buffer
396 * @tty: tty owning the buffer
397 * @size: characters wanted
398 *
399 * Locate an existing suitable tty buffer or if we are lacking one then
400 * allocate a new one. We round our buffers off in 256 character chunks
401 * to get better allocation behaviour.
402 *
403 * Locking: Caller must hold tty->buf.lock
404 */
405
Alan Cox33f0f882006-01-09 20:54:13 -0800406static struct tty_buffer *tty_buffer_find(struct tty_struct *tty, size_t size)
407{
408 struct tty_buffer **tbh = &tty->buf.free;
409 while((*tbh) != NULL) {
410 struct tty_buffer *t = *tbh;
411 if(t->size >= size) {
412 *tbh = t->next;
413 t->next = NULL;
414 t->used = 0;
Paul Fulghum8977d922006-02-10 01:51:14 -0800415 t->commit = 0;
416 t->read = 0;
Alan Cox01da5fd2006-08-27 01:24:02 -0700417 tty->buf.memory_used += t->size;
Alan Cox33f0f882006-01-09 20:54:13 -0800418 return t;
419 }
420 tbh = &((*tbh)->next);
421 }
422 /* Round the buffer size out */
423 size = (size + 0xFF) & ~ 0xFF;
Alan Cox01da5fd2006-08-27 01:24:02 -0700424 return tty_buffer_alloc(tty, size);
Alan Cox33f0f882006-01-09 20:54:13 -0800425 /* Should possibly check if this fails for the largest buffer we
426 have queued and recycle that ? */
427}
428
Alan Cox01da5fd2006-08-27 01:24:02 -0700429/**
430 * tty_buffer_request_room - grow tty buffer if needed
431 * @tty: tty structure
432 * @size: size desired
433 *
434 * Make at least size bytes of linear space available for the tty
435 * buffer. If we fail return the size we managed to find.
436 *
437 * Locking: Takes tty->buf.lock
438 */
Alan Cox33f0f882006-01-09 20:54:13 -0800439int tty_buffer_request_room(struct tty_struct *tty, size_t size)
440{
Paul Fulghum808249c2006-02-03 03:04:41 -0800441 struct tty_buffer *b, *n;
442 int left;
443 unsigned long flags;
444
445 spin_lock_irqsave(&tty->buf.lock, flags);
Alan Cox33f0f882006-01-09 20:54:13 -0800446
447 /* OPTIMISATION: We could keep a per tty "zero" sized buffer to
448 remove this conditional if its worth it. This would be invisible
449 to the callers */
Paul Fulghum33b37a32006-06-28 04:26:49 -0700450 if ((b = tty->buf.tail) != NULL)
Alan Cox33f0f882006-01-09 20:54:13 -0800451 left = b->size - b->used;
Paul Fulghum33b37a32006-06-28 04:26:49 -0700452 else
Paul Fulghum808249c2006-02-03 03:04:41 -0800453 left = 0;
454
455 if (left < size) {
456 /* This is the slow path - looking for new buffers to use */
457 if ((n = tty_buffer_find(tty, size)) != NULL) {
458 if (b != NULL) {
459 b->next = n;
Paul Fulghum8977d922006-02-10 01:51:14 -0800460 b->commit = b->used;
Paul Fulghum808249c2006-02-03 03:04:41 -0800461 } else
462 tty->buf.head = n;
463 tty->buf.tail = n;
Paul Fulghum808249c2006-02-03 03:04:41 -0800464 } else
465 size = left;
466 }
467
468 spin_unlock_irqrestore(&tty->buf.lock, flags);
Alan Cox33f0f882006-01-09 20:54:13 -0800469 return size;
470}
Alan Cox33f0f882006-01-09 20:54:13 -0800471EXPORT_SYMBOL_GPL(tty_buffer_request_room);
472
Alan Coxaf9b8972006-08-27 01:24:01 -0700473/**
474 * tty_insert_flip_string - Add characters to the tty buffer
475 * @tty: tty structure
476 * @chars: characters
477 * @size: size
478 *
479 * Queue a series of bytes to the tty buffering. All the characters
480 * passed are marked as without error. Returns the number added.
481 *
482 * Locking: Called functions may take tty->buf.lock
483 */
484
Andrew Mortone1a25092006-04-10 22:54:05 -0700485int tty_insert_flip_string(struct tty_struct *tty, const unsigned char *chars,
486 size_t size)
Alan Cox33f0f882006-01-09 20:54:13 -0800487{
488 int copied = 0;
489 do {
490 int space = tty_buffer_request_room(tty, size - copied);
491 struct tty_buffer *tb = tty->buf.tail;
492 /* If there is no space then tb may be NULL */
493 if(unlikely(space == 0))
494 break;
495 memcpy(tb->char_buf_ptr + tb->used, chars, space);
496 memset(tb->flag_buf_ptr + tb->used, TTY_NORMAL, space);
497 tb->used += space;
498 copied += space;
499 chars += space;
Alexey Dobriyan527063b2006-09-29 01:59:50 -0700500 /* There is a small chance that we need to split the data over
501 several buffers. If this is the case we must loop */
502 } while (unlikely(size > copied));
Alan Cox33f0f882006-01-09 20:54:13 -0800503 return copied;
504}
Andrew Mortonee37df72006-03-31 02:30:35 -0800505EXPORT_SYMBOL(tty_insert_flip_string);
Alan Cox33f0f882006-01-09 20:54:13 -0800506
Alan Coxaf9b8972006-08-27 01:24:01 -0700507/**
508 * tty_insert_flip_string_flags - Add characters to the tty buffer
509 * @tty: tty structure
510 * @chars: characters
511 * @flags: flag bytes
512 * @size: size
513 *
514 * Queue a series of bytes to the tty buffering. For each character
515 * the flags array indicates the status of the character. Returns the
516 * number added.
517 *
518 * Locking: Called functions may take tty->buf.lock
519 */
520
Andrew Mortone1a25092006-04-10 22:54:05 -0700521int tty_insert_flip_string_flags(struct tty_struct *tty,
522 const unsigned char *chars, const char *flags, size_t size)
Alan Cox33f0f882006-01-09 20:54:13 -0800523{
524 int copied = 0;
525 do {
526 int space = tty_buffer_request_room(tty, size - copied);
527 struct tty_buffer *tb = tty->buf.tail;
528 /* If there is no space then tb may be NULL */
529 if(unlikely(space == 0))
530 break;
531 memcpy(tb->char_buf_ptr + tb->used, chars, space);
532 memcpy(tb->flag_buf_ptr + tb->used, flags, space);
533 tb->used += space;
534 copied += space;
535 chars += space;
536 flags += space;
Alexey Dobriyan527063b2006-09-29 01:59:50 -0700537 /* There is a small chance that we need to split the data over
538 several buffers. If this is the case we must loop */
539 } while (unlikely(size > copied));
Alan Cox33f0f882006-01-09 20:54:13 -0800540 return copied;
541}
Tobias Powalowskiff4547f2006-05-22 22:35:28 -0700542EXPORT_SYMBOL(tty_insert_flip_string_flags);
Alan Cox33f0f882006-01-09 20:54:13 -0800543
Alan Coxaf9b8972006-08-27 01:24:01 -0700544/**
545 * tty_schedule_flip - push characters to ldisc
546 * @tty: tty to push from
547 *
548 * Takes any pending buffers and transfers their ownership to the
549 * ldisc side of the queue. It then schedules those characters for
550 * processing by the line discipline.
551 *
552 * Locking: Takes tty->buf.lock
553 */
554
Andrew Mortone1a25092006-04-10 22:54:05 -0700555void tty_schedule_flip(struct tty_struct *tty)
556{
557 unsigned long flags;
558 spin_lock_irqsave(&tty->buf.lock, flags);
Paul Fulghum33b37a32006-06-28 04:26:49 -0700559 if (tty->buf.tail != NULL)
Andrew Mortone1a25092006-04-10 22:54:05 -0700560 tty->buf.tail->commit = tty->buf.tail->used;
Andrew Mortone1a25092006-04-10 22:54:05 -0700561 spin_unlock_irqrestore(&tty->buf.lock, flags);
562 schedule_delayed_work(&tty->buf.work, 1);
563}
564EXPORT_SYMBOL(tty_schedule_flip);
Alan Cox33f0f882006-01-09 20:54:13 -0800565
Alan Coxaf9b8972006-08-27 01:24:01 -0700566/**
567 * tty_prepare_flip_string - make room for characters
568 * @tty: tty
569 * @chars: return pointer for character write area
570 * @size: desired size
571 *
Alan Cox33f0f882006-01-09 20:54:13 -0800572 * Prepare a block of space in the buffer for data. Returns the length
573 * available and buffer pointer to the space which is now allocated and
574 * accounted for as ready for normal characters. This is used for drivers
575 * that need their own block copy routines into the buffer. There is no
576 * guarantee the buffer is a DMA target!
Alan Coxaf9b8972006-08-27 01:24:01 -0700577 *
578 * Locking: May call functions taking tty->buf.lock
Alan Cox33f0f882006-01-09 20:54:13 -0800579 */
580
581int tty_prepare_flip_string(struct tty_struct *tty, unsigned char **chars, size_t size)
582{
583 int space = tty_buffer_request_room(tty, size);
Paul Fulghum808249c2006-02-03 03:04:41 -0800584 if (likely(space)) {
585 struct tty_buffer *tb = tty->buf.tail;
586 *chars = tb->char_buf_ptr + tb->used;
587 memset(tb->flag_buf_ptr + tb->used, TTY_NORMAL, space);
588 tb->used += space;
589 }
Alan Cox33f0f882006-01-09 20:54:13 -0800590 return space;
591}
592
593EXPORT_SYMBOL_GPL(tty_prepare_flip_string);
594
Alan Coxaf9b8972006-08-27 01:24:01 -0700595/**
596 * tty_prepare_flip_string_flags - make room for characters
597 * @tty: tty
598 * @chars: return pointer for character write area
599 * @flags: return pointer for status flag write area
600 * @size: desired size
601 *
Alan Cox33f0f882006-01-09 20:54:13 -0800602 * Prepare a block of space in the buffer for data. Returns the length
603 * available and buffer pointer to the space which is now allocated and
604 * accounted for as ready for characters. This is used for drivers
605 * that need their own block copy routines into the buffer. There is no
606 * guarantee the buffer is a DMA target!
Alan Coxaf9b8972006-08-27 01:24:01 -0700607 *
608 * Locking: May call functions taking tty->buf.lock
Alan Cox33f0f882006-01-09 20:54:13 -0800609 */
610
611int tty_prepare_flip_string_flags(struct tty_struct *tty, unsigned char **chars, char **flags, size_t size)
612{
613 int space = tty_buffer_request_room(tty, size);
Paul Fulghum808249c2006-02-03 03:04:41 -0800614 if (likely(space)) {
615 struct tty_buffer *tb = tty->buf.tail;
616 *chars = tb->char_buf_ptr + tb->used;
617 *flags = tb->flag_buf_ptr + tb->used;
618 tb->used += space;
619 }
Alan Cox33f0f882006-01-09 20:54:13 -0800620 return space;
621}
622
623EXPORT_SYMBOL_GPL(tty_prepare_flip_string_flags);
624
625
626
Alan Coxaf9b8972006-08-27 01:24:01 -0700627/**
628 * tty_set_termios_ldisc - set ldisc field
629 * @tty: tty structure
630 * @num: line discipline number
631 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700632 * This is probably overkill for real world processors but
633 * they are not on hot paths so a little discipline won't do
634 * any harm.
Alan Coxaf9b8972006-08-27 01:24:01 -0700635 *
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800636 * Locking: takes termios_mutex
Linus Torvalds1da177e2005-04-16 15:20:36 -0700637 */
638
639static void tty_set_termios_ldisc(struct tty_struct *tty, int num)
640{
Arjan van de Ven5785c952006-09-29 02:00:43 -0700641 mutex_lock(&tty->termios_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700642 tty->termios->c_line = num;
Arjan van de Ven5785c952006-09-29 02:00:43 -0700643 mutex_unlock(&tty->termios_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700644}
645
646/*
647 * This guards the refcounted line discipline lists. The lock
648 * must be taken with irqs off because there are hangup path
649 * callers who will do ldisc lookups and cannot sleep.
650 */
651
652static DEFINE_SPINLOCK(tty_ldisc_lock);
653static DECLARE_WAIT_QUEUE_HEAD(tty_ldisc_wait);
Alexey Dobriyanbfb07592005-06-23 00:10:32 -0700654static struct tty_ldisc tty_ldiscs[NR_LDISCS]; /* line disc dispatch table */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700655
Alan Coxaf9b8972006-08-27 01:24:01 -0700656/**
657 * tty_register_ldisc - install a line discipline
658 * @disc: ldisc number
659 * @new_ldisc: pointer to the ldisc object
660 *
661 * Installs a new line discipline into the kernel. The discipline
662 * is set up as unreferenced and then made available to the kernel
663 * from this point onwards.
664 *
665 * Locking:
666 * takes tty_ldisc_lock to guard against ldisc races
667 */
668
Linus Torvalds1da177e2005-04-16 15:20:36 -0700669int tty_register_ldisc(int disc, struct tty_ldisc *new_ldisc)
670{
671 unsigned long flags;
672 int ret = 0;
673
674 if (disc < N_TTY || disc >= NR_LDISCS)
675 return -EINVAL;
676
677 spin_lock_irqsave(&tty_ldisc_lock, flags);
Alexey Dobriyanbfb07592005-06-23 00:10:32 -0700678 tty_ldiscs[disc] = *new_ldisc;
679 tty_ldiscs[disc].num = disc;
680 tty_ldiscs[disc].flags |= LDISC_FLAG_DEFINED;
681 tty_ldiscs[disc].refcount = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700682 spin_unlock_irqrestore(&tty_ldisc_lock, flags);
683
684 return ret;
685}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700686EXPORT_SYMBOL(tty_register_ldisc);
687
Alan Coxaf9b8972006-08-27 01:24:01 -0700688/**
689 * tty_unregister_ldisc - unload a line discipline
690 * @disc: ldisc number
691 * @new_ldisc: pointer to the ldisc object
692 *
693 * Remove a line discipline from the kernel providing it is not
694 * currently in use.
695 *
696 * Locking:
697 * takes tty_ldisc_lock to guard against ldisc races
698 */
699
Alexey Dobriyanbfb07592005-06-23 00:10:32 -0700700int tty_unregister_ldisc(int disc)
701{
702 unsigned long flags;
703 int ret = 0;
704
705 if (disc < N_TTY || disc >= NR_LDISCS)
706 return -EINVAL;
707
708 spin_lock_irqsave(&tty_ldisc_lock, flags);
709 if (tty_ldiscs[disc].refcount)
710 ret = -EBUSY;
711 else
712 tty_ldiscs[disc].flags &= ~LDISC_FLAG_DEFINED;
713 spin_unlock_irqrestore(&tty_ldisc_lock, flags);
714
715 return ret;
716}
717EXPORT_SYMBOL(tty_unregister_ldisc);
718
Alan Coxaf9b8972006-08-27 01:24:01 -0700719/**
720 * tty_ldisc_get - take a reference to an ldisc
721 * @disc: ldisc number
722 *
723 * Takes a reference to a line discipline. Deals with refcounts and
724 * module locking counts. Returns NULL if the discipline is not available.
725 * Returns a pointer to the discipline and bumps the ref count if it is
726 * available
727 *
728 * Locking:
729 * takes tty_ldisc_lock to guard against ldisc races
730 */
731
Linus Torvalds1da177e2005-04-16 15:20:36 -0700732struct tty_ldisc *tty_ldisc_get(int disc)
733{
734 unsigned long flags;
735 struct tty_ldisc *ld;
736
737 if (disc < N_TTY || disc >= NR_LDISCS)
738 return NULL;
739
740 spin_lock_irqsave(&tty_ldisc_lock, flags);
741
742 ld = &tty_ldiscs[disc];
743 /* Check the entry is defined */
744 if(ld->flags & LDISC_FLAG_DEFINED)
745 {
746 /* If the module is being unloaded we can't use it */
747 if (!try_module_get(ld->owner))
748 ld = NULL;
749 else /* lock it */
750 ld->refcount++;
751 }
752 else
753 ld = NULL;
754 spin_unlock_irqrestore(&tty_ldisc_lock, flags);
755 return ld;
756}
757
758EXPORT_SYMBOL_GPL(tty_ldisc_get);
759
Alan Coxaf9b8972006-08-27 01:24:01 -0700760/**
761 * tty_ldisc_put - drop ldisc reference
762 * @disc: ldisc number
763 *
764 * Drop a reference to a line discipline. Manage refcounts and
765 * module usage counts
766 *
767 * Locking:
768 * takes tty_ldisc_lock to guard against ldisc races
769 */
770
Linus Torvalds1da177e2005-04-16 15:20:36 -0700771void tty_ldisc_put(int disc)
772{
773 struct tty_ldisc *ld;
774 unsigned long flags;
775
Eric Sesterhenn56ee4822006-03-26 18:17:21 +0200776 BUG_ON(disc < N_TTY || disc >= NR_LDISCS);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700777
778 spin_lock_irqsave(&tty_ldisc_lock, flags);
779 ld = &tty_ldiscs[disc];
Eric Sesterhenn56ee4822006-03-26 18:17:21 +0200780 BUG_ON(ld->refcount == 0);
781 ld->refcount--;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700782 module_put(ld->owner);
783 spin_unlock_irqrestore(&tty_ldisc_lock, flags);
784}
785
786EXPORT_SYMBOL_GPL(tty_ldisc_put);
787
Alan Coxaf9b8972006-08-27 01:24:01 -0700788/**
789 * tty_ldisc_assign - set ldisc on a tty
790 * @tty: tty to assign
791 * @ld: line discipline
792 *
793 * Install an instance of a line discipline into a tty structure. The
794 * ldisc must have a reference count above zero to ensure it remains/
795 * The tty instance refcount starts at zero.
796 *
797 * Locking:
798 * Caller must hold references
799 */
800
Linus Torvalds1da177e2005-04-16 15:20:36 -0700801static void tty_ldisc_assign(struct tty_struct *tty, struct tty_ldisc *ld)
802{
803 tty->ldisc = *ld;
804 tty->ldisc.refcount = 0;
805}
806
807/**
808 * tty_ldisc_try - internal helper
809 * @tty: the tty
810 *
811 * Make a single attempt to grab and bump the refcount on
812 * the tty ldisc. Return 0 on failure or 1 on success. This is
813 * used to implement both the waiting and non waiting versions
814 * of tty_ldisc_ref
Alan Coxaf9b8972006-08-27 01:24:01 -0700815 *
816 * Locking: takes tty_ldisc_lock
Linus Torvalds1da177e2005-04-16 15:20:36 -0700817 */
818
819static int tty_ldisc_try(struct tty_struct *tty)
820{
821 unsigned long flags;
822 struct tty_ldisc *ld;
823 int ret = 0;
824
825 spin_lock_irqsave(&tty_ldisc_lock, flags);
826 ld = &tty->ldisc;
827 if(test_bit(TTY_LDISC, &tty->flags))
828 {
829 ld->refcount++;
830 ret = 1;
831 }
832 spin_unlock_irqrestore(&tty_ldisc_lock, flags);
833 return ret;
834}
835
836/**
837 * tty_ldisc_ref_wait - wait for the tty ldisc
838 * @tty: tty device
839 *
840 * Dereference the line discipline for the terminal and take a
841 * reference to it. If the line discipline is in flux then
842 * wait patiently until it changes.
843 *
844 * Note: Must not be called from an IRQ/timer context. The caller
845 * must also be careful not to hold other locks that will deadlock
846 * against a discipline change, such as an existing ldisc reference
847 * (which we check for)
Alan Coxaf9b8972006-08-27 01:24:01 -0700848 *
849 * Locking: call functions take tty_ldisc_lock
Linus Torvalds1da177e2005-04-16 15:20:36 -0700850 */
851
852struct tty_ldisc *tty_ldisc_ref_wait(struct tty_struct *tty)
853{
854 /* wait_event is a macro */
855 wait_event(tty_ldisc_wait, tty_ldisc_try(tty));
856 if(tty->ldisc.refcount == 0)
857 printk(KERN_ERR "tty_ldisc_ref_wait\n");
858 return &tty->ldisc;
859}
860
861EXPORT_SYMBOL_GPL(tty_ldisc_ref_wait);
862
863/**
864 * tty_ldisc_ref - get the tty ldisc
865 * @tty: tty device
866 *
867 * Dereference the line discipline for the terminal and take a
868 * reference to it. If the line discipline is in flux then
869 * return NULL. Can be called from IRQ and timer functions.
Alan Coxaf9b8972006-08-27 01:24:01 -0700870 *
871 * Locking: called functions take tty_ldisc_lock
Linus Torvalds1da177e2005-04-16 15:20:36 -0700872 */
873
874struct tty_ldisc *tty_ldisc_ref(struct tty_struct *tty)
875{
876 if(tty_ldisc_try(tty))
877 return &tty->ldisc;
878 return NULL;
879}
880
881EXPORT_SYMBOL_GPL(tty_ldisc_ref);
882
883/**
884 * tty_ldisc_deref - free a tty ldisc reference
885 * @ld: reference to free up
886 *
887 * Undoes the effect of tty_ldisc_ref or tty_ldisc_ref_wait. May
888 * be called in IRQ context.
Alan Coxaf9b8972006-08-27 01:24:01 -0700889 *
890 * Locking: takes tty_ldisc_lock
Linus Torvalds1da177e2005-04-16 15:20:36 -0700891 */
892
893void tty_ldisc_deref(struct tty_ldisc *ld)
894{
895 unsigned long flags;
896
Eric Sesterhenn56ee4822006-03-26 18:17:21 +0200897 BUG_ON(ld == NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700898
899 spin_lock_irqsave(&tty_ldisc_lock, flags);
900 if(ld->refcount == 0)
901 printk(KERN_ERR "tty_ldisc_deref: no references.\n");
902 else
903 ld->refcount--;
904 if(ld->refcount == 0)
905 wake_up(&tty_ldisc_wait);
906 spin_unlock_irqrestore(&tty_ldisc_lock, flags);
907}
908
909EXPORT_SYMBOL_GPL(tty_ldisc_deref);
910
911/**
912 * tty_ldisc_enable - allow ldisc use
913 * @tty: terminal to activate ldisc on
914 *
915 * Set the TTY_LDISC flag when the line discipline can be called
916 * again. Do neccessary wakeups for existing sleepers.
917 *
918 * Note: nobody should set this bit except via this function. Clearing
919 * directly is allowed.
920 */
921
922static void tty_ldisc_enable(struct tty_struct *tty)
923{
924 set_bit(TTY_LDISC, &tty->flags);
925 wake_up(&tty_ldisc_wait);
926}
927
928/**
929 * tty_set_ldisc - set line discipline
930 * @tty: the terminal to set
931 * @ldisc: the line discipline
932 *
933 * Set the discipline of a tty line. Must be called from a process
934 * context.
Alan Coxaf9b8972006-08-27 01:24:01 -0700935 *
936 * Locking: takes tty_ldisc_lock.
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800937 * called functions take termios_mutex
Linus Torvalds1da177e2005-04-16 15:20:36 -0700938 */
939
940static int tty_set_ldisc(struct tty_struct *tty, int ldisc)
941{
Jason Baronff55fe22005-09-09 13:01:57 -0700942 int retval = 0;
943 struct tty_ldisc o_ldisc;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700944 char buf[64];
945 int work;
946 unsigned long flags;
947 struct tty_ldisc *ld;
Jason Baronff55fe22005-09-09 13:01:57 -0700948 struct tty_struct *o_tty;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700949
950 if ((ldisc < N_TTY) || (ldisc >= NR_LDISCS))
951 return -EINVAL;
952
953restart:
954
Linus Torvalds1da177e2005-04-16 15:20:36 -0700955 ld = tty_ldisc_get(ldisc);
956 /* Eduardo Blanco <ejbs@cs.cs.com.uy> */
957 /* Cyrus Durgin <cider@speakeasy.org> */
958 if (ld == NULL) {
959 request_module("tty-ldisc-%d", ldisc);
960 ld = tty_ldisc_get(ldisc);
961 }
962 if (ld == NULL)
963 return -EINVAL;
964
Alan Cox33f0f882006-01-09 20:54:13 -0800965 /*
Alan Cox33f0f882006-01-09 20:54:13 -0800966 * Problem: What do we do if this blocks ?
967 */
968
Linus Torvalds1da177e2005-04-16 15:20:36 -0700969 tty_wait_until_sent(tty, 0);
970
Jason Baronff55fe22005-09-09 13:01:57 -0700971 if (tty->ldisc.num == ldisc) {
972 tty_ldisc_put(ldisc);
973 return 0;
974 }
975
Paul Fulghumae030e42007-05-09 02:33:38 -0700976 /*
977 * No more input please, we are switching. The new ldisc
978 * will update this value in the ldisc open function
979 */
980
981 tty->receive_room = 0;
982
Jason Baronff55fe22005-09-09 13:01:57 -0700983 o_ldisc = tty->ldisc;
984 o_tty = tty->link;
985
Linus Torvalds1da177e2005-04-16 15:20:36 -0700986 /*
987 * Make sure we don't change while someone holds a
988 * reference to the line discipline. The TTY_LDISC bit
989 * prevents anyone taking a reference once it is clear.
990 * We need the lock to avoid racing reference takers.
991 */
Jason Baronff55fe22005-09-09 13:01:57 -0700992
Linus Torvalds1da177e2005-04-16 15:20:36 -0700993 spin_lock_irqsave(&tty_ldisc_lock, flags);
Jason Baronff55fe22005-09-09 13:01:57 -0700994 if (tty->ldisc.refcount || (o_tty && o_tty->ldisc.refcount)) {
995 if(tty->ldisc.refcount) {
996 /* Free the new ldisc we grabbed. Must drop the lock
997 first. */
998 spin_unlock_irqrestore(&tty_ldisc_lock, flags);
999 tty_ldisc_put(ldisc);
1000 /*
1001 * There are several reasons we may be busy, including
1002 * random momentary I/O traffic. We must therefore
1003 * retry. We could distinguish between blocking ops
1004 * and retries if we made tty_ldisc_wait() smarter. That
1005 * is up for discussion.
1006 */
1007 if (wait_event_interruptible(tty_ldisc_wait, tty->ldisc.refcount == 0) < 0)
1008 return -ERESTARTSYS;
1009 goto restart;
1010 }
1011 if(o_tty && o_tty->ldisc.refcount) {
1012 spin_unlock_irqrestore(&tty_ldisc_lock, flags);
1013 tty_ldisc_put(ldisc);
1014 if (wait_event_interruptible(tty_ldisc_wait, o_tty->ldisc.refcount == 0) < 0)
1015 return -ERESTARTSYS;
1016 goto restart;
1017 }
1018 }
1019
1020 /* if the TTY_LDISC bit is set, then we are racing against another ldisc change */
1021
1022 if (!test_bit(TTY_LDISC, &tty->flags)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001023 spin_unlock_irqrestore(&tty_ldisc_lock, flags);
1024 tty_ldisc_put(ldisc);
Jason Baronff55fe22005-09-09 13:01:57 -07001025 ld = tty_ldisc_ref_wait(tty);
1026 tty_ldisc_deref(ld);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001027 goto restart;
1028 }
Jason Baronff55fe22005-09-09 13:01:57 -07001029
1030 clear_bit(TTY_LDISC, &tty->flags);
Paul Fulghum817d6d32006-06-28 04:26:47 -07001031 if (o_tty)
Jason Baronff55fe22005-09-09 13:01:57 -07001032 clear_bit(TTY_LDISC, &o_tty->flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001033 spin_unlock_irqrestore(&tty_ldisc_lock, flags);
Jason Baronff55fe22005-09-09 13:01:57 -07001034
Linus Torvalds1da177e2005-04-16 15:20:36 -07001035 /*
1036 * From this point on we know nobody has an ldisc
1037 * usage reference, nor can they obtain one until
1038 * we say so later on.
1039 */
Jason Baronff55fe22005-09-09 13:01:57 -07001040
Alan Cox33f0f882006-01-09 20:54:13 -08001041 work = cancel_delayed_work(&tty->buf.work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001042 /*
Alan Cox33f0f882006-01-09 20:54:13 -08001043 * Wait for ->hangup_work and ->buf.work handlers to terminate
Linus Torvalds1da177e2005-04-16 15:20:36 -07001044 */
1045
1046 flush_scheduled_work();
1047 /* Shutdown the current discipline. */
1048 if (tty->ldisc.close)
1049 (tty->ldisc.close)(tty);
1050
1051 /* Now set up the new line discipline. */
1052 tty_ldisc_assign(tty, ld);
1053 tty_set_termios_ldisc(tty, ldisc);
1054 if (tty->ldisc.open)
1055 retval = (tty->ldisc.open)(tty);
1056 if (retval < 0) {
1057 tty_ldisc_put(ldisc);
1058 /* There is an outstanding reference here so this is safe */
1059 tty_ldisc_assign(tty, tty_ldisc_get(o_ldisc.num));
1060 tty_set_termios_ldisc(tty, tty->ldisc.num);
1061 if (tty->ldisc.open && (tty->ldisc.open(tty) < 0)) {
1062 tty_ldisc_put(o_ldisc.num);
1063 /* This driver is always present */
1064 tty_ldisc_assign(tty, tty_ldisc_get(N_TTY));
1065 tty_set_termios_ldisc(tty, N_TTY);
1066 if (tty->ldisc.open) {
1067 int r = tty->ldisc.open(tty);
1068
1069 if (r < 0)
1070 panic("Couldn't open N_TTY ldisc for "
1071 "%s --- error %d.",
1072 tty_name(tty, buf), r);
1073 }
1074 }
1075 }
1076 /* At this point we hold a reference to the new ldisc and a
1077 a reference to the old ldisc. If we ended up flipping back
1078 to the existing ldisc we have two references to it */
1079
1080 if (tty->ldisc.num != o_ldisc.num && tty->driver->set_ldisc)
1081 tty->driver->set_ldisc(tty);
1082
1083 tty_ldisc_put(o_ldisc.num);
1084
1085 /*
1086 * Allow ldisc referencing to occur as soon as the driver
1087 * ldisc callback completes.
1088 */
1089
1090 tty_ldisc_enable(tty);
Jason Baronff55fe22005-09-09 13:01:57 -07001091 if (o_tty)
1092 tty_ldisc_enable(o_tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001093
1094 /* Restart it in case no characters kick it off. Safe if
1095 already running */
Jason Baronff55fe22005-09-09 13:01:57 -07001096 if (work)
Alan Cox33f0f882006-01-09 20:54:13 -08001097 schedule_delayed_work(&tty->buf.work, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001098 return retval;
1099}
1100
Alan Coxaf9b8972006-08-27 01:24:01 -07001101/**
1102 * get_tty_driver - find device of a tty
1103 * @dev_t: device identifier
1104 * @index: returns the index of the tty
1105 *
1106 * This routine returns a tty driver structure, given a device number
1107 * and also passes back the index number.
1108 *
1109 * Locking: caller must hold tty_mutex
Linus Torvalds1da177e2005-04-16 15:20:36 -07001110 */
Alan Coxaf9b8972006-08-27 01:24:01 -07001111
Linus Torvalds1da177e2005-04-16 15:20:36 -07001112static struct tty_driver *get_tty_driver(dev_t device, int *index)
1113{
1114 struct tty_driver *p;
1115
1116 list_for_each_entry(p, &tty_drivers, tty_drivers) {
1117 dev_t base = MKDEV(p->major, p->minor_start);
1118 if (device < base || device >= base + p->num)
1119 continue;
1120 *index = device - base;
1121 return p;
1122 }
1123 return NULL;
1124}
1125
Alan Coxaf9b8972006-08-27 01:24:01 -07001126/**
1127 * tty_check_change - check for POSIX terminal changes
1128 * @tty: tty to check
1129 *
1130 * If we try to write to, or set the state of, a terminal and we're
1131 * not in the foreground, send a SIGTTOU. If the signal is blocked or
1132 * ignored, go ahead and perform the operation. (POSIX 7.2)
1133 *
1134 * Locking: none
Linus Torvalds1da177e2005-04-16 15:20:36 -07001135 */
Alan Coxaf9b8972006-08-27 01:24:01 -07001136
Linus Torvalds1da177e2005-04-16 15:20:36 -07001137int tty_check_change(struct tty_struct * tty)
1138{
1139 if (current->signal->tty != tty)
1140 return 0;
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08001141 if (!tty->pgrp) {
1142 printk(KERN_WARNING "tty_check_change: tty->pgrp == NULL!\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001143 return 0;
1144 }
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08001145 if (task_pgrp(current) == tty->pgrp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001146 return 0;
1147 if (is_ignored(SIGTTOU))
1148 return 0;
Eric W. Biederman3e7cd6c2007-02-12 00:52:58 -08001149 if (is_current_pgrp_orphaned())
Linus Torvalds1da177e2005-04-16 15:20:36 -07001150 return -EIO;
Oleg Nesterov040b6362007-06-01 00:46:53 -07001151 kill_pgrp(task_pgrp(current), SIGTTOU, 1);
1152 set_thread_flag(TIF_SIGPENDING);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001153 return -ERESTARTSYS;
1154}
1155
1156EXPORT_SYMBOL(tty_check_change);
1157
1158static ssize_t hung_up_tty_read(struct file * file, char __user * buf,
1159 size_t count, loff_t *ppos)
1160{
1161 return 0;
1162}
1163
1164static ssize_t hung_up_tty_write(struct file * file, const char __user * buf,
1165 size_t count, loff_t *ppos)
1166{
1167 return -EIO;
1168}
1169
1170/* No kernel lock held - none needed ;) */
1171static unsigned int hung_up_tty_poll(struct file * filp, poll_table * wait)
1172{
1173 return POLLIN | POLLOUT | POLLERR | POLLHUP | POLLRDNORM | POLLWRNORM;
1174}
1175
Paul Fulghume10cc1d2007-05-10 22:22:50 -07001176static long hung_up_tty_ioctl(struct file * file,
1177 unsigned int cmd, unsigned long arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001178{
1179 return cmd == TIOCSPGRP ? -ENOTTY : -EIO;
1180}
1181
Arjan van de Ven62322d22006-07-03 00:24:21 -07001182static const struct file_operations tty_fops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001183 .llseek = no_llseek,
1184 .read = tty_read,
1185 .write = tty_write,
1186 .poll = tty_poll,
1187 .ioctl = tty_ioctl,
Paul Fulghume10cc1d2007-05-10 22:22:50 -07001188 .compat_ioctl = tty_compat_ioctl,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001189 .open = tty_open,
1190 .release = tty_release,
1191 .fasync = tty_fasync,
1192};
1193
1194#ifdef CONFIG_UNIX98_PTYS
Arjan van de Ven62322d22006-07-03 00:24:21 -07001195static const struct file_operations ptmx_fops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001196 .llseek = no_llseek,
1197 .read = tty_read,
1198 .write = tty_write,
1199 .poll = tty_poll,
1200 .ioctl = tty_ioctl,
Paul Fulghume10cc1d2007-05-10 22:22:50 -07001201 .compat_ioctl = tty_compat_ioctl,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001202 .open = ptmx_open,
1203 .release = tty_release,
1204 .fasync = tty_fasync,
1205};
1206#endif
1207
Arjan van de Ven62322d22006-07-03 00:24:21 -07001208static const struct file_operations console_fops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001209 .llseek = no_llseek,
1210 .read = tty_read,
1211 .write = redirected_tty_write,
1212 .poll = tty_poll,
1213 .ioctl = tty_ioctl,
Paul Fulghume10cc1d2007-05-10 22:22:50 -07001214 .compat_ioctl = tty_compat_ioctl,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001215 .open = tty_open,
1216 .release = tty_release,
1217 .fasync = tty_fasync,
1218};
1219
Arjan van de Ven62322d22006-07-03 00:24:21 -07001220static const struct file_operations hung_up_tty_fops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001221 .llseek = no_llseek,
1222 .read = hung_up_tty_read,
1223 .write = hung_up_tty_write,
1224 .poll = hung_up_tty_poll,
Paul Fulghume10cc1d2007-05-10 22:22:50 -07001225 .unlocked_ioctl = hung_up_tty_ioctl,
1226 .compat_ioctl = hung_up_tty_ioctl,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001227 .release = tty_release,
1228};
1229
1230static DEFINE_SPINLOCK(redirect_lock);
1231static struct file *redirect;
1232
1233/**
1234 * tty_wakeup - request more data
1235 * @tty: terminal
1236 *
1237 * Internal and external helper for wakeups of tty. This function
1238 * informs the line discipline if present that the driver is ready
1239 * to receive more output data.
1240 */
1241
1242void tty_wakeup(struct tty_struct *tty)
1243{
1244 struct tty_ldisc *ld;
1245
1246 if (test_bit(TTY_DO_WRITE_WAKEUP, &tty->flags)) {
1247 ld = tty_ldisc_ref(tty);
1248 if(ld) {
1249 if(ld->write_wakeup)
1250 ld->write_wakeup(tty);
1251 tty_ldisc_deref(ld);
1252 }
1253 }
1254 wake_up_interruptible(&tty->write_wait);
1255}
1256
1257EXPORT_SYMBOL_GPL(tty_wakeup);
1258
1259/**
1260 * tty_ldisc_flush - flush line discipline queue
1261 * @tty: tty
1262 *
1263 * Flush the line discipline queue (if any) for this tty. If there
1264 * is no line discipline active this is a no-op.
1265 */
1266
1267void tty_ldisc_flush(struct tty_struct *tty)
1268{
1269 struct tty_ldisc *ld = tty_ldisc_ref(tty);
1270 if(ld) {
1271 if(ld->flush_buffer)
1272 ld->flush_buffer(tty);
1273 tty_ldisc_deref(ld);
1274 }
Paul Fulghumc5c34d42007-05-12 10:36:55 -07001275 tty_buffer_flush(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001276}
1277
1278EXPORT_SYMBOL_GPL(tty_ldisc_flush);
Alan Coxedc6afc2006-12-08 02:38:44 -08001279
1280/**
1281 * tty_reset_termios - reset terminal state
1282 * @tty: tty to reset
1283 *
1284 * Restore a terminal to the driver default state
1285 */
1286
1287static void tty_reset_termios(struct tty_struct *tty)
1288{
1289 mutex_lock(&tty->termios_mutex);
1290 *tty->termios = tty->driver->init_termios;
1291 tty->termios->c_ispeed = tty_termios_input_baud_rate(tty->termios);
1292 tty->termios->c_ospeed = tty_termios_baud_rate(tty->termios);
1293 mutex_unlock(&tty->termios_mutex);
1294}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001295
Alan Coxaf9b8972006-08-27 01:24:01 -07001296/**
1297 * do_tty_hangup - actual handler for hangup events
David Howells65f27f32006-11-22 14:55:48 +00001298 * @work: tty device
Alan Coxaf9b8972006-08-27 01:24:01 -07001299 *
1300 * This can be called by the "eventd" kernel thread. That is process
1301 * synchronous but doesn't hold any locks, so we need to make sure we
1302 * have the appropriate locks for what we're doing.
1303 *
1304 * The hangup event clears any pending redirections onto the hung up
1305 * device. It ensures future writes will error and it does the needed
1306 * line discipline hangup and signal delivery. The tty object itself
1307 * remains intact.
1308 *
1309 * Locking:
1310 * BKL
Peter Zijlstra24ec8392006-12-08 02:36:04 -08001311 * redirect lock for undoing redirection
1312 * file list lock for manipulating list of ttys
1313 * tty_ldisc_lock from called functions
1314 * termios_mutex resetting termios data
1315 * tasklist_lock to walk task list for hangup event
1316 * ->siglock to protect ->signal/->sighand
Linus Torvalds1da177e2005-04-16 15:20:36 -07001317 */
David Howells65f27f32006-11-22 14:55:48 +00001318static void do_tty_hangup(struct work_struct *work)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001319{
David Howells65f27f32006-11-22 14:55:48 +00001320 struct tty_struct *tty =
1321 container_of(work, struct tty_struct, hangup_work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001322 struct file * cons_filp = NULL;
1323 struct file *filp, *f = NULL;
1324 struct task_struct *p;
1325 struct tty_ldisc *ld;
1326 int closecount = 0, n;
1327
1328 if (!tty)
1329 return;
1330
1331 /* inuse_filps is protected by the single kernel lock */
1332 lock_kernel();
1333
1334 spin_lock(&redirect_lock);
1335 if (redirect && redirect->private_data == tty) {
1336 f = redirect;
1337 redirect = NULL;
1338 }
1339 spin_unlock(&redirect_lock);
1340
1341 check_tty_count(tty, "do_tty_hangup");
1342 file_list_lock();
1343 /* This breaks for file handles being sent over AF_UNIX sockets ? */
Eric Dumazet2f512012005-10-30 15:02:16 -08001344 list_for_each_entry(filp, &tty->tty_files, f_u.fu_list) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001345 if (filp->f_op->write == redirected_tty_write)
1346 cons_filp = filp;
1347 if (filp->f_op->write != tty_write)
1348 continue;
1349 closecount++;
1350 tty_fasync(-1, filp, 0); /* can't block */
1351 filp->f_op = &hung_up_tty_fops;
1352 }
1353 file_list_unlock();
1354
1355 /* FIXME! What are the locking issues here? This may me overdoing things..
1356 * this question is especially important now that we've removed the irqlock. */
1357
1358 ld = tty_ldisc_ref(tty);
1359 if(ld != NULL) /* We may have no line discipline at this point */
1360 {
1361 if (ld->flush_buffer)
1362 ld->flush_buffer(tty);
1363 if (tty->driver->flush_buffer)
1364 tty->driver->flush_buffer(tty);
1365 if ((test_bit(TTY_DO_WRITE_WAKEUP, &tty->flags)) &&
1366 ld->write_wakeup)
1367 ld->write_wakeup(tty);
1368 if (ld->hangup)
1369 ld->hangup(tty);
1370 }
1371
1372 /* FIXME: Once we trust the LDISC code better we can wait here for
1373 ldisc completion and fix the driver call race */
1374
1375 wake_up_interruptible(&tty->write_wait);
1376 wake_up_interruptible(&tty->read_wait);
1377
1378 /*
1379 * Shutdown the current line discipline, and reset it to
1380 * N_TTY.
1381 */
1382 if (tty->driver->flags & TTY_DRIVER_RESET_TERMIOS)
Alan Coxedc6afc2006-12-08 02:38:44 -08001383 tty_reset_termios(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001384
1385 /* Defer ldisc switch */
1386 /* tty_deferred_ldisc_switch(N_TTY);
1387
1388 This should get done automatically when the port closes and
1389 tty_release is called */
1390
1391 read_lock(&tasklist_lock);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08001392 if (tty->session) {
1393 do_each_pid_task(tty->session, PIDTYPE_SID, p) {
Peter Zijlstra24ec8392006-12-08 02:36:04 -08001394 spin_lock_irq(&p->sighand->siglock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001395 if (p->signal->tty == tty)
1396 p->signal->tty = NULL;
Peter Zijlstra24ec8392006-12-08 02:36:04 -08001397 if (!p->signal->leader) {
1398 spin_unlock_irq(&p->sighand->siglock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001399 continue;
Peter Zijlstra24ec8392006-12-08 02:36:04 -08001400 }
1401 __group_send_sig_info(SIGHUP, SEND_SIG_PRIV, p);
1402 __group_send_sig_info(SIGCONT, SEND_SIG_PRIV, p);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08001403 put_pid(p->signal->tty_old_pgrp); /* A noop */
1404 if (tty->pgrp)
1405 p->signal->tty_old_pgrp = get_pid(tty->pgrp);
Peter Zijlstra24ec8392006-12-08 02:36:04 -08001406 spin_unlock_irq(&p->sighand->siglock);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08001407 } while_each_pid_task(tty->session, PIDTYPE_SID, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001408 }
1409 read_unlock(&tasklist_lock);
1410
1411 tty->flags = 0;
Eric W. Biedermand9c1e9a2007-03-18 12:45:44 -06001412 put_pid(tty->session);
1413 put_pid(tty->pgrp);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08001414 tty->session = NULL;
1415 tty->pgrp = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001416 tty->ctrl_status = 0;
1417 /*
1418 * If one of the devices matches a console pointer, we
1419 * cannot just call hangup() because that will cause
1420 * tty->count and state->count to go out of sync.
1421 * So we just call close() the right number of times.
1422 */
1423 if (cons_filp) {
1424 if (tty->driver->close)
1425 for (n = 0; n < closecount; n++)
1426 tty->driver->close(tty, cons_filp);
1427 } else if (tty->driver->hangup)
1428 (tty->driver->hangup)(tty);
1429
1430 /* We don't want to have driver/ldisc interactions beyond
1431 the ones we did here. The driver layer expects no
1432 calls after ->hangup() from the ldisc side. However we
1433 can't yet guarantee all that */
1434
1435 set_bit(TTY_HUPPED, &tty->flags);
1436 if (ld) {
1437 tty_ldisc_enable(tty);
1438 tty_ldisc_deref(ld);
1439 }
1440 unlock_kernel();
1441 if (f)
1442 fput(f);
1443}
1444
Alan Coxaf9b8972006-08-27 01:24:01 -07001445/**
1446 * tty_hangup - trigger a hangup event
1447 * @tty: tty to hangup
1448 *
1449 * A carrier loss (virtual or otherwise) has occurred on this like
1450 * schedule a hangup sequence to run after this event.
1451 */
1452
Linus Torvalds1da177e2005-04-16 15:20:36 -07001453void tty_hangup(struct tty_struct * tty)
1454{
1455#ifdef TTY_DEBUG_HANGUP
1456 char buf[64];
1457
1458 printk(KERN_DEBUG "%s hangup...\n", tty_name(tty, buf));
1459#endif
1460 schedule_work(&tty->hangup_work);
1461}
1462
1463EXPORT_SYMBOL(tty_hangup);
1464
Alan Coxaf9b8972006-08-27 01:24:01 -07001465/**
1466 * tty_vhangup - process vhangup
1467 * @tty: tty to hangup
1468 *
1469 * The user has asked via system call for the terminal to be hung up.
1470 * We do this synchronously so that when the syscall returns the process
1471 * is complete. That guarantee is neccessary for security reasons.
1472 */
1473
Linus Torvalds1da177e2005-04-16 15:20:36 -07001474void tty_vhangup(struct tty_struct * tty)
1475{
1476#ifdef TTY_DEBUG_HANGUP
1477 char buf[64];
1478
1479 printk(KERN_DEBUG "%s vhangup...\n", tty_name(tty, buf));
1480#endif
David Howells65f27f32006-11-22 14:55:48 +00001481 do_tty_hangup(&tty->hangup_work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001482}
1483EXPORT_SYMBOL(tty_vhangup);
1484
Alan Coxaf9b8972006-08-27 01:24:01 -07001485/**
1486 * tty_hung_up_p - was tty hung up
1487 * @filp: file pointer of tty
1488 *
1489 * Return true if the tty has been subject to a vhangup or a carrier
1490 * loss
1491 */
1492
Linus Torvalds1da177e2005-04-16 15:20:36 -07001493int tty_hung_up_p(struct file * filp)
1494{
1495 return (filp->f_op == &hung_up_tty_fops);
1496}
1497
1498EXPORT_SYMBOL(tty_hung_up_p);
1499
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08001500static void session_clear_tty(struct pid *session)
Peter Zijlstra24ec8392006-12-08 02:36:04 -08001501{
1502 struct task_struct *p;
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08001503 do_each_pid_task(session, PIDTYPE_SID, p) {
Peter Zijlstra24ec8392006-12-08 02:36:04 -08001504 proc_clear_tty(p);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08001505 } while_each_pid_task(session, PIDTYPE_SID, p);
Peter Zijlstra24ec8392006-12-08 02:36:04 -08001506}
1507
Alan Coxaf9b8972006-08-27 01:24:01 -07001508/**
1509 * disassociate_ctty - disconnect controlling tty
1510 * @on_exit: true if exiting so need to "hang up" the session
Linus Torvalds1da177e2005-04-16 15:20:36 -07001511 *
Alan Coxaf9b8972006-08-27 01:24:01 -07001512 * This function is typically called only by the session leader, when
1513 * it wants to disassociate itself from its controlling tty.
1514 *
1515 * It performs the following functions:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001516 * (1) Sends a SIGHUP and SIGCONT to the foreground process group
1517 * (2) Clears the tty from being controlling the session
1518 * (3) Clears the controlling tty for all processes in the
1519 * session group.
1520 *
Alan Coxaf9b8972006-08-27 01:24:01 -07001521 * The argument on_exit is set to 1 if called when a process is
1522 * exiting; it is 0 if called by the ioctl TIOCNOTTY.
1523 *
Peter Zijlstra24ec8392006-12-08 02:36:04 -08001524 * Locking:
Alan Coxaf9b8972006-08-27 01:24:01 -07001525 * BKL is taken for hysterical raisins
Peter Zijlstra24ec8392006-12-08 02:36:04 -08001526 * tty_mutex is taken to protect tty
1527 * ->siglock is taken to protect ->signal/->sighand
1528 * tasklist_lock is taken to walk process list for sessions
1529 * ->siglock is taken to protect ->signal/->sighand
Linus Torvalds1da177e2005-04-16 15:20:36 -07001530 */
Alan Coxaf9b8972006-08-27 01:24:01 -07001531
Linus Torvalds1da177e2005-04-16 15:20:36 -07001532void disassociate_ctty(int on_exit)
1533{
1534 struct tty_struct *tty;
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08001535 struct pid *tty_pgrp = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001536
1537 lock_kernel();
1538
Ingo Molnar70522e12006-03-23 03:00:31 -08001539 mutex_lock(&tty_mutex);
Peter Zijlstra24ec8392006-12-08 02:36:04 -08001540 tty = get_current_tty();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001541 if (tty) {
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08001542 tty_pgrp = get_pid(tty->pgrp);
Ingo Molnar70522e12006-03-23 03:00:31 -08001543 mutex_unlock(&tty_mutex);
Peter Zijlstra24ec8392006-12-08 02:36:04 -08001544 /* XXX: here we race, there is nothing protecting tty */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001545 if (on_exit && tty->driver->type != TTY_DRIVER_TYPE_PTY)
1546 tty_vhangup(tty);
Eric W. Biederman680a9672007-02-12 00:52:52 -08001547 } else if (on_exit) {
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08001548 struct pid *old_pgrp;
Eric W. Biederman680a9672007-02-12 00:52:52 -08001549 spin_lock_irq(&current->sighand->siglock);
1550 old_pgrp = current->signal->tty_old_pgrp;
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08001551 current->signal->tty_old_pgrp = NULL;
Eric W. Biederman680a9672007-02-12 00:52:52 -08001552 spin_unlock_irq(&current->sighand->siglock);
Peter Zijlstra24ec8392006-12-08 02:36:04 -08001553 if (old_pgrp) {
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08001554 kill_pgrp(old_pgrp, SIGHUP, on_exit);
1555 kill_pgrp(old_pgrp, SIGCONT, on_exit);
1556 put_pid(old_pgrp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001557 }
Ingo Molnar70522e12006-03-23 03:00:31 -08001558 mutex_unlock(&tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001559 unlock_kernel();
1560 return;
1561 }
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08001562 if (tty_pgrp) {
1563 kill_pgrp(tty_pgrp, SIGHUP, on_exit);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001564 if (!on_exit)
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08001565 kill_pgrp(tty_pgrp, SIGCONT, on_exit);
1566 put_pid(tty_pgrp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001567 }
1568
Peter Zijlstra24ec8392006-12-08 02:36:04 -08001569 spin_lock_irq(&current->sighand->siglock);
Eric W. Biederman2a65f1d2007-05-08 00:26:53 -07001570 put_pid(current->signal->tty_old_pgrp);
Randy Dunlap23cac8d2007-02-20 13:58:05 -08001571 current->signal->tty_old_pgrp = NULL;
Peter Zijlstra24ec8392006-12-08 02:36:04 -08001572 spin_unlock_irq(&current->sighand->siglock);
1573
1574 mutex_lock(&tty_mutex);
1575 /* It is possible that do_tty_hangup has free'd this tty */
1576 tty = get_current_tty();
1577 if (tty) {
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08001578 put_pid(tty->session);
1579 put_pid(tty->pgrp);
1580 tty->session = NULL;
1581 tty->pgrp = NULL;
Peter Zijlstra24ec8392006-12-08 02:36:04 -08001582 } else {
1583#ifdef TTY_DEBUG_HANGUP
1584 printk(KERN_DEBUG "error attempted to write to tty [0x%p]"
1585 " = NULL", tty);
1586#endif
1587 }
1588 mutex_unlock(&tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001589
1590 /* Now clear signal->tty under the lock */
1591 read_lock(&tasklist_lock);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08001592 session_clear_tty(task_session(current));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001593 read_unlock(&tasklist_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001594 unlock_kernel();
1595}
1596
Eric W. Biederman98a27ba2007-05-08 00:26:56 -07001597/**
1598 *
1599 * no_tty - Ensure the current process does not have a controlling tty
1600 */
1601void no_tty(void)
1602{
1603 struct task_struct *tsk = current;
1604 if (tsk->signal->leader)
1605 disassociate_ctty(0);
1606 proc_clear_tty(tsk);
1607}
1608
Alan Coxaf9b8972006-08-27 01:24:01 -07001609
1610/**
Robert P. J. Daybeb7dd82007-05-09 07:14:03 +02001611 * stop_tty - propagate flow control
Alan Coxaf9b8972006-08-27 01:24:01 -07001612 * @tty: tty to stop
1613 *
1614 * Perform flow control to the driver. For PTY/TTY pairs we
Robert P. J. Daybeb7dd82007-05-09 07:14:03 +02001615 * must also propagate the TIOCKPKT status. May be called
Alan Coxaf9b8972006-08-27 01:24:01 -07001616 * on an already stopped device and will not re-call the driver
1617 * method.
1618 *
1619 * This functionality is used by both the line disciplines for
1620 * halting incoming flow and by the driver. It may therefore be
1621 * called from any context, may be under the tty atomic_write_lock
1622 * but not always.
1623 *
1624 * Locking:
1625 * Broken. Relies on BKL which is unsafe here.
1626 */
1627
Linus Torvalds1da177e2005-04-16 15:20:36 -07001628void stop_tty(struct tty_struct *tty)
1629{
1630 if (tty->stopped)
1631 return;
1632 tty->stopped = 1;
1633 if (tty->link && tty->link->packet) {
1634 tty->ctrl_status &= ~TIOCPKT_START;
1635 tty->ctrl_status |= TIOCPKT_STOP;
1636 wake_up_interruptible(&tty->link->read_wait);
1637 }
1638 if (tty->driver->stop)
1639 (tty->driver->stop)(tty);
1640}
1641
1642EXPORT_SYMBOL(stop_tty);
1643
Alan Coxaf9b8972006-08-27 01:24:01 -07001644/**
Robert P. J. Daybeb7dd82007-05-09 07:14:03 +02001645 * start_tty - propagate flow control
Alan Coxaf9b8972006-08-27 01:24:01 -07001646 * @tty: tty to start
1647 *
1648 * Start a tty that has been stopped if at all possible. Perform
Robert P. J. Daybeb7dd82007-05-09 07:14:03 +02001649 * any neccessary wakeups and propagate the TIOCPKT status. If this
Alan Coxaf9b8972006-08-27 01:24:01 -07001650 * is the tty was previous stopped and is being started then the
1651 * driver start method is invoked and the line discipline woken.
1652 *
1653 * Locking:
1654 * Broken. Relies on BKL which is unsafe here.
1655 */
1656
Linus Torvalds1da177e2005-04-16 15:20:36 -07001657void start_tty(struct tty_struct *tty)
1658{
1659 if (!tty->stopped || tty->flow_stopped)
1660 return;
1661 tty->stopped = 0;
1662 if (tty->link && tty->link->packet) {
1663 tty->ctrl_status &= ~TIOCPKT_STOP;
1664 tty->ctrl_status |= TIOCPKT_START;
1665 wake_up_interruptible(&tty->link->read_wait);
1666 }
1667 if (tty->driver->start)
1668 (tty->driver->start)(tty);
1669
1670 /* If we have a running line discipline it may need kicking */
1671 tty_wakeup(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001672}
1673
1674EXPORT_SYMBOL(start_tty);
1675
Alan Coxaf9b8972006-08-27 01:24:01 -07001676/**
1677 * tty_read - read method for tty device files
1678 * @file: pointer to tty file
1679 * @buf: user buffer
1680 * @count: size of user buffer
1681 * @ppos: unused
1682 *
1683 * Perform the read system call function on this terminal device. Checks
1684 * for hung up devices before calling the line discipline method.
1685 *
1686 * Locking:
1687 * Locks the line discipline internally while needed
1688 * For historical reasons the line discipline read method is
1689 * invoked under the BKL. This will go away in time so do not rely on it
1690 * in new code. Multiple read calls may be outstanding in parallel.
1691 */
1692
Linus Torvalds1da177e2005-04-16 15:20:36 -07001693static ssize_t tty_read(struct file * file, char __user * buf, size_t count,
1694 loff_t *ppos)
1695{
1696 int i;
1697 struct tty_struct * tty;
1698 struct inode *inode;
1699 struct tty_ldisc *ld;
1700
1701 tty = (struct tty_struct *)file->private_data;
Josef Sipeka7113a92006-12-08 02:36:55 -08001702 inode = file->f_path.dentry->d_inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001703 if (tty_paranoia_check(tty, inode, "tty_read"))
1704 return -EIO;
1705 if (!tty || (test_bit(TTY_IO_ERROR, &tty->flags)))
1706 return -EIO;
1707
1708 /* We want to wait for the line discipline to sort out in this
1709 situation */
1710 ld = tty_ldisc_ref_wait(tty);
1711 lock_kernel();
1712 if (ld->read)
1713 i = (ld->read)(tty,file,buf,count);
1714 else
1715 i = -EIO;
1716 tty_ldisc_deref(ld);
1717 unlock_kernel();
1718 if (i > 0)
1719 inode->i_atime = current_fs_time(inode->i_sb);
1720 return i;
1721}
1722
1723/*
1724 * Split writes up in sane blocksizes to avoid
1725 * denial-of-service type attacks
1726 */
1727static inline ssize_t do_tty_write(
1728 ssize_t (*write)(struct tty_struct *, struct file *, const unsigned char *, size_t),
1729 struct tty_struct *tty,
1730 struct file *file,
1731 const char __user *buf,
1732 size_t count)
1733{
1734 ssize_t ret = 0, written = 0;
1735 unsigned int chunk;
1736
Alan Coxaf9b8972006-08-27 01:24:01 -07001737 /* FIXME: O_NDELAY ... */
Ingo Molnar70522e12006-03-23 03:00:31 -08001738 if (mutex_lock_interruptible(&tty->atomic_write_lock)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001739 return -ERESTARTSYS;
1740 }
1741
1742 /*
1743 * We chunk up writes into a temporary buffer. This
1744 * simplifies low-level drivers immensely, since they
1745 * don't have locking issues and user mode accesses.
1746 *
1747 * But if TTY_NO_WRITE_SPLIT is set, we should use a
1748 * big chunk-size..
1749 *
1750 * The default chunk-size is 2kB, because the NTTY
1751 * layer has problems with bigger chunks. It will
1752 * claim to be able to handle more characters than
1753 * it actually does.
Alan Coxaf9b8972006-08-27 01:24:01 -07001754 *
1755 * FIXME: This can probably go away now except that 64K chunks
1756 * are too likely to fail unless switched to vmalloc...
Linus Torvalds1da177e2005-04-16 15:20:36 -07001757 */
1758 chunk = 2048;
1759 if (test_bit(TTY_NO_WRITE_SPLIT, &tty->flags))
1760 chunk = 65536;
1761 if (count < chunk)
1762 chunk = count;
1763
Ingo Molnar70522e12006-03-23 03:00:31 -08001764 /* write_buf/write_cnt is protected by the atomic_write_lock mutex */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001765 if (tty->write_cnt < chunk) {
1766 unsigned char *buf;
1767
1768 if (chunk < 1024)
1769 chunk = 1024;
1770
1771 buf = kmalloc(chunk, GFP_KERNEL);
1772 if (!buf) {
Ingo Molnar70522e12006-03-23 03:00:31 -08001773 mutex_unlock(&tty->atomic_write_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001774 return -ENOMEM;
1775 }
1776 kfree(tty->write_buf);
1777 tty->write_cnt = chunk;
1778 tty->write_buf = buf;
1779 }
1780
1781 /* Do the write .. */
1782 for (;;) {
1783 size_t size = count;
1784 if (size > chunk)
1785 size = chunk;
1786 ret = -EFAULT;
1787 if (copy_from_user(tty->write_buf, buf, size))
1788 break;
1789 lock_kernel();
1790 ret = write(tty, file, tty->write_buf, size);
1791 unlock_kernel();
1792 if (ret <= 0)
1793 break;
1794 written += ret;
1795 buf += ret;
1796 count -= ret;
1797 if (!count)
1798 break;
1799 ret = -ERESTARTSYS;
1800 if (signal_pending(current))
1801 break;
1802 cond_resched();
1803 }
1804 if (written) {
Josef Sipeka7113a92006-12-08 02:36:55 -08001805 struct inode *inode = file->f_path.dentry->d_inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001806 inode->i_mtime = current_fs_time(inode->i_sb);
1807 ret = written;
1808 }
Ingo Molnar70522e12006-03-23 03:00:31 -08001809 mutex_unlock(&tty->atomic_write_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001810 return ret;
1811}
1812
1813
Alan Coxaf9b8972006-08-27 01:24:01 -07001814/**
1815 * tty_write - write method for tty device file
1816 * @file: tty file pointer
1817 * @buf: user data to write
1818 * @count: bytes to write
1819 * @ppos: unused
1820 *
1821 * Write data to a tty device via the line discipline.
1822 *
1823 * Locking:
1824 * Locks the line discipline as required
1825 * Writes to the tty driver are serialized by the atomic_write_lock
1826 * and are then processed in chunks to the device. The line discipline
1827 * write method will not be involked in parallel for each device
1828 * The line discipline write method is called under the big
1829 * kernel lock for historical reasons. New code should not rely on this.
1830 */
1831
Linus Torvalds1da177e2005-04-16 15:20:36 -07001832static ssize_t tty_write(struct file * file, const char __user * buf, size_t count,
1833 loff_t *ppos)
1834{
1835 struct tty_struct * tty;
Josef Sipeka7113a92006-12-08 02:36:55 -08001836 struct inode *inode = file->f_path.dentry->d_inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001837 ssize_t ret;
1838 struct tty_ldisc *ld;
1839
1840 tty = (struct tty_struct *)file->private_data;
1841 if (tty_paranoia_check(tty, inode, "tty_write"))
1842 return -EIO;
1843 if (!tty || !tty->driver->write || (test_bit(TTY_IO_ERROR, &tty->flags)))
1844 return -EIO;
1845
1846 ld = tty_ldisc_ref_wait(tty);
1847 if (!ld->write)
1848 ret = -EIO;
1849 else
1850 ret = do_tty_write(ld->write, tty, file, buf, count);
1851 tty_ldisc_deref(ld);
1852 return ret;
1853}
1854
1855ssize_t redirected_tty_write(struct file * file, const char __user * buf, size_t count,
1856 loff_t *ppos)
1857{
1858 struct file *p = NULL;
1859
1860 spin_lock(&redirect_lock);
1861 if (redirect) {
1862 get_file(redirect);
1863 p = redirect;
1864 }
1865 spin_unlock(&redirect_lock);
1866
1867 if (p) {
1868 ssize_t res;
1869 res = vfs_write(p, buf, count, &p->f_pos);
1870 fput(p);
1871 return res;
1872 }
1873
1874 return tty_write(file, buf, count, ppos);
1875}
1876
1877static char ptychar[] = "pqrstuvwxyzabcde";
1878
Alan Coxaf9b8972006-08-27 01:24:01 -07001879/**
1880 * pty_line_name - generate name for a pty
1881 * @driver: the tty driver in use
1882 * @index: the minor number
1883 * @p: output buffer of at least 6 bytes
1884 *
1885 * Generate a name from a driver reference and write it to the output
1886 * buffer.
1887 *
1888 * Locking: None
1889 */
1890static void pty_line_name(struct tty_driver *driver, int index, char *p)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001891{
1892 int i = index + driver->name_base;
1893 /* ->name is initialized to "ttyp", but "tty" is expected */
1894 sprintf(p, "%s%c%x",
1895 driver->subtype == PTY_TYPE_SLAVE ? "tty" : driver->name,
1896 ptychar[i >> 4 & 0xf], i & 0xf);
1897}
1898
Alan Coxaf9b8972006-08-27 01:24:01 -07001899/**
1900 * pty_line_name - generate name for a tty
1901 * @driver: the tty driver in use
1902 * @index: the minor number
1903 * @p: output buffer of at least 7 bytes
1904 *
1905 * Generate a name from a driver reference and write it to the output
1906 * buffer.
1907 *
1908 * Locking: None
1909 */
1910static void tty_line_name(struct tty_driver *driver, int index, char *p)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001911{
1912 sprintf(p, "%s%d", driver->name, index + driver->name_base);
1913}
1914
Alan Coxaf9b8972006-08-27 01:24:01 -07001915/**
1916 * init_dev - initialise a tty device
1917 * @driver: tty driver we are opening a device on
1918 * @idx: device index
1919 * @tty: returned tty structure
1920 *
1921 * Prepare a tty device. This may not be a "new" clean device but
1922 * could also be an active device. The pty drivers require special
1923 * handling because of this.
1924 *
1925 * Locking:
1926 * The function is called under the tty_mutex, which
1927 * protects us from the tty struct or driver itself going away.
1928 *
1929 * On exit the tty device has the line discipline attached and
1930 * a reference count of 1. If a pair was created for pty/tty use
1931 * and the other was a pty master then it too has a reference count of 1.
1932 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07001933 * WSH 06/09/97: Rewritten to remove races and properly clean up after a
Ingo Molnar70522e12006-03-23 03:00:31 -08001934 * failed open. The new code protects the open with a mutex, so it's
1935 * really quite straightforward. The mutex locking can probably be
Linus Torvalds1da177e2005-04-16 15:20:36 -07001936 * relaxed for the (most common) case of reopening a tty.
1937 */
Alan Coxaf9b8972006-08-27 01:24:01 -07001938
Linus Torvalds1da177e2005-04-16 15:20:36 -07001939static int init_dev(struct tty_driver *driver, int idx,
1940 struct tty_struct **ret_tty)
1941{
1942 struct tty_struct *tty, *o_tty;
Alan Coxedc6afc2006-12-08 02:38:44 -08001943 struct ktermios *tp, **tp_loc, *o_tp, **o_tp_loc;
1944 struct ktermios *ltp, **ltp_loc, *o_ltp, **o_ltp_loc;
Alan Coxaf9b8972006-08-27 01:24:01 -07001945 int retval = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001946
1947 /* check whether we're reopening an existing tty */
1948 if (driver->flags & TTY_DRIVER_DEVPTS_MEM) {
1949 tty = devpts_get_tty(idx);
Aristeu Sergio Rozanski Filho5a39e8c2007-02-28 20:13:53 -08001950 /*
1951 * If we don't have a tty here on a slave open, it's because
1952 * the master already started the close process and there's
1953 * no relation between devpts file and tty anymore.
1954 */
1955 if (!tty && driver->subtype == PTY_TYPE_SLAVE) {
1956 retval = -EIO;
1957 goto end_init;
1958 }
1959 /*
1960 * It's safe from now on because init_dev() is called with
1961 * tty_mutex held and release_dev() won't change tty->count
1962 * or tty->flags without having to grab tty_mutex
1963 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001964 if (tty && driver->subtype == PTY_TYPE_MASTER)
1965 tty = tty->link;
1966 } else {
1967 tty = driver->ttys[idx];
1968 }
1969 if (tty) goto fast_track;
1970
1971 /*
1972 * First time open is complex, especially for PTY devices.
1973 * This code guarantees that either everything succeeds and the
1974 * TTY is ready for operation, or else the table slots are vacated
1975 * and the allocated memory released. (Except that the termios
1976 * and locked termios may be retained.)
1977 */
1978
1979 if (!try_module_get(driver->owner)) {
1980 retval = -ENODEV;
1981 goto end_init;
1982 }
1983
1984 o_tty = NULL;
1985 tp = o_tp = NULL;
1986 ltp = o_ltp = NULL;
1987
1988 tty = alloc_tty_struct();
1989 if(!tty)
1990 goto fail_no_mem;
1991 initialize_tty_struct(tty);
1992 tty->driver = driver;
1993 tty->index = idx;
1994 tty_line_name(driver, idx, tty->name);
1995
1996 if (driver->flags & TTY_DRIVER_DEVPTS_MEM) {
1997 tp_loc = &tty->termios;
1998 ltp_loc = &tty->termios_locked;
1999 } else {
2000 tp_loc = &driver->termios[idx];
2001 ltp_loc = &driver->termios_locked[idx];
2002 }
2003
2004 if (!*tp_loc) {
Alan Coxedc6afc2006-12-08 02:38:44 -08002005 tp = (struct ktermios *) kmalloc(sizeof(struct ktermios),
Linus Torvalds1da177e2005-04-16 15:20:36 -07002006 GFP_KERNEL);
2007 if (!tp)
2008 goto free_mem_out;
2009 *tp = driver->init_termios;
2010 }
2011
2012 if (!*ltp_loc) {
Alan Coxedc6afc2006-12-08 02:38:44 -08002013 ltp = (struct ktermios *) kmalloc(sizeof(struct ktermios),
Linus Torvalds1da177e2005-04-16 15:20:36 -07002014 GFP_KERNEL);
2015 if (!ltp)
2016 goto free_mem_out;
Alan Coxedc6afc2006-12-08 02:38:44 -08002017 memset(ltp, 0, sizeof(struct ktermios));
Linus Torvalds1da177e2005-04-16 15:20:36 -07002018 }
2019
2020 if (driver->type == TTY_DRIVER_TYPE_PTY) {
2021 o_tty = alloc_tty_struct();
2022 if (!o_tty)
2023 goto free_mem_out;
2024 initialize_tty_struct(o_tty);
2025 o_tty->driver = driver->other;
2026 o_tty->index = idx;
2027 tty_line_name(driver->other, idx, o_tty->name);
2028
2029 if (driver->flags & TTY_DRIVER_DEVPTS_MEM) {
2030 o_tp_loc = &o_tty->termios;
2031 o_ltp_loc = &o_tty->termios_locked;
2032 } else {
2033 o_tp_loc = &driver->other->termios[idx];
2034 o_ltp_loc = &driver->other->termios_locked[idx];
2035 }
2036
2037 if (!*o_tp_loc) {
Alan Coxedc6afc2006-12-08 02:38:44 -08002038 o_tp = (struct ktermios *)
2039 kmalloc(sizeof(struct ktermios), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002040 if (!o_tp)
2041 goto free_mem_out;
2042 *o_tp = driver->other->init_termios;
2043 }
2044
2045 if (!*o_ltp_loc) {
Alan Coxedc6afc2006-12-08 02:38:44 -08002046 o_ltp = (struct ktermios *)
2047 kmalloc(sizeof(struct ktermios), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002048 if (!o_ltp)
2049 goto free_mem_out;
Alan Coxedc6afc2006-12-08 02:38:44 -08002050 memset(o_ltp, 0, sizeof(struct ktermios));
Linus Torvalds1da177e2005-04-16 15:20:36 -07002051 }
2052
2053 /*
2054 * Everything allocated ... set up the o_tty structure.
2055 */
2056 if (!(driver->other->flags & TTY_DRIVER_DEVPTS_MEM)) {
2057 driver->other->ttys[idx] = o_tty;
2058 }
2059 if (!*o_tp_loc)
2060 *o_tp_loc = o_tp;
2061 if (!*o_ltp_loc)
2062 *o_ltp_loc = o_ltp;
2063 o_tty->termios = *o_tp_loc;
2064 o_tty->termios_locked = *o_ltp_loc;
2065 driver->other->refcount++;
2066 if (driver->subtype == PTY_TYPE_MASTER)
2067 o_tty->count++;
2068
2069 /* Establish the links in both directions */
2070 tty->link = o_tty;
2071 o_tty->link = tty;
2072 }
2073
2074 /*
2075 * All structures have been allocated, so now we install them.
Christoph Hellwigd5698c22007-02-10 01:46:46 -08002076 * Failures after this point use release_tty to clean up, so
Linus Torvalds1da177e2005-04-16 15:20:36 -07002077 * there's no need to null out the local pointers.
2078 */
2079 if (!(driver->flags & TTY_DRIVER_DEVPTS_MEM)) {
2080 driver->ttys[idx] = tty;
2081 }
2082
2083 if (!*tp_loc)
2084 *tp_loc = tp;
2085 if (!*ltp_loc)
2086 *ltp_loc = ltp;
2087 tty->termios = *tp_loc;
2088 tty->termios_locked = *ltp_loc;
Alan Coxedc6afc2006-12-08 02:38:44 -08002089 /* Compatibility until drivers always set this */
2090 tty->termios->c_ispeed = tty_termios_input_baud_rate(tty->termios);
2091 tty->termios->c_ospeed = tty_termios_baud_rate(tty->termios);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002092 driver->refcount++;
2093 tty->count++;
2094
2095 /*
2096 * Structures all installed ... call the ldisc open routines.
Christoph Hellwigd5698c22007-02-10 01:46:46 -08002097 * If we fail here just call release_tty to clean up. No need
2098 * to decrement the use counts, as release_tty doesn't care.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002099 */
2100
2101 if (tty->ldisc.open) {
2102 retval = (tty->ldisc.open)(tty);
2103 if (retval)
2104 goto release_mem_out;
2105 }
2106 if (o_tty && o_tty->ldisc.open) {
2107 retval = (o_tty->ldisc.open)(o_tty);
2108 if (retval) {
2109 if (tty->ldisc.close)
2110 (tty->ldisc.close)(tty);
2111 goto release_mem_out;
2112 }
2113 tty_ldisc_enable(o_tty);
2114 }
2115 tty_ldisc_enable(tty);
2116 goto success;
2117
2118 /*
2119 * This fast open can be used if the tty is already open.
2120 * No memory is allocated, and the only failures are from
2121 * attempting to open a closing tty or attempting multiple
2122 * opens on a pty master.
2123 */
2124fast_track:
2125 if (test_bit(TTY_CLOSING, &tty->flags)) {
2126 retval = -EIO;
2127 goto end_init;
2128 }
2129 if (driver->type == TTY_DRIVER_TYPE_PTY &&
2130 driver->subtype == PTY_TYPE_MASTER) {
2131 /*
2132 * special case for PTY masters: only one open permitted,
2133 * and the slave side open count is incremented as well.
2134 */
2135 if (tty->count) {
2136 retval = -EIO;
2137 goto end_init;
2138 }
2139 tty->link->count++;
2140 }
2141 tty->count++;
2142 tty->driver = driver; /* N.B. why do this every time?? */
2143
2144 /* FIXME */
2145 if(!test_bit(TTY_LDISC, &tty->flags))
2146 printk(KERN_ERR "init_dev but no ldisc\n");
2147success:
2148 *ret_tty = tty;
2149
Ingo Molnar70522e12006-03-23 03:00:31 -08002150 /* All paths come through here to release the mutex */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002151end_init:
2152 return retval;
2153
2154 /* Release locally allocated memory ... nothing placed in slots */
2155free_mem_out:
Jesper Juhl735d5662005-11-07 01:01:29 -08002156 kfree(o_tp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002157 if (o_tty)
2158 free_tty_struct(o_tty);
Jesper Juhl735d5662005-11-07 01:01:29 -08002159 kfree(ltp);
2160 kfree(tp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002161 free_tty_struct(tty);
2162
2163fail_no_mem:
2164 module_put(driver->owner);
2165 retval = -ENOMEM;
2166 goto end_init;
2167
Christoph Hellwigd5698c22007-02-10 01:46:46 -08002168 /* call the tty release_tty routine to clean out this slot */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002169release_mem_out:
Akinobu Mita40509142006-09-29 02:01:27 -07002170 if (printk_ratelimit())
2171 printk(KERN_INFO "init_dev: ldisc open failed, "
2172 "clearing slot %d\n", idx);
Christoph Hellwigd5698c22007-02-10 01:46:46 -08002173 release_tty(tty, idx);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002174 goto end_init;
2175}
2176
Alan Coxaf9b8972006-08-27 01:24:01 -07002177/**
Christoph Hellwigd5698c22007-02-10 01:46:46 -08002178 * release_one_tty - release tty structure memory
Alan Coxaf9b8972006-08-27 01:24:01 -07002179 *
2180 * Releases memory associated with a tty structure, and clears out the
2181 * driver table slots. This function is called when a device is no longer
2182 * in use. It also gets called when setup of a device fails.
2183 *
2184 * Locking:
2185 * tty_mutex - sometimes only
2186 * takes the file list lock internally when working on the list
2187 * of ttys that the driver keeps.
2188 * FIXME: should we require tty_mutex is held here ??
Linus Torvalds1da177e2005-04-16 15:20:36 -07002189 */
Christoph Hellwigd5698c22007-02-10 01:46:46 -08002190static void release_one_tty(struct tty_struct *tty, int idx)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002191{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002192 int devpts = tty->driver->flags & TTY_DRIVER_DEVPTS_MEM;
Christoph Hellwigd5698c22007-02-10 01:46:46 -08002193 struct ktermios *tp;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002194
2195 if (!devpts)
2196 tty->driver->ttys[idx] = NULL;
Christoph Hellwigd5698c22007-02-10 01:46:46 -08002197
Linus Torvalds1da177e2005-04-16 15:20:36 -07002198 if (tty->driver->flags & TTY_DRIVER_RESET_TERMIOS) {
2199 tp = tty->termios;
2200 if (!devpts)
2201 tty->driver->termios[idx] = NULL;
2202 kfree(tp);
2203
2204 tp = tty->termios_locked;
2205 if (!devpts)
2206 tty->driver->termios_locked[idx] = NULL;
2207 kfree(tp);
2208 }
2209
Christoph Hellwigd5698c22007-02-10 01:46:46 -08002210
Linus Torvalds1da177e2005-04-16 15:20:36 -07002211 tty->magic = 0;
2212 tty->driver->refcount--;
Christoph Hellwigd5698c22007-02-10 01:46:46 -08002213
Linus Torvalds1da177e2005-04-16 15:20:36 -07002214 file_list_lock();
2215 list_del_init(&tty->tty_files);
2216 file_list_unlock();
Christoph Hellwigd5698c22007-02-10 01:46:46 -08002217
Linus Torvalds1da177e2005-04-16 15:20:36 -07002218 free_tty_struct(tty);
2219}
2220
Christoph Hellwigd5698c22007-02-10 01:46:46 -08002221/**
2222 * release_tty - release tty structure memory
2223 *
2224 * Release both @tty and a possible linked partner (think pty pair),
2225 * and decrement the refcount of the backing module.
2226 *
2227 * Locking:
2228 * tty_mutex - sometimes only
2229 * takes the file list lock internally when working on the list
2230 * of ttys that the driver keeps.
2231 * FIXME: should we require tty_mutex is held here ??
2232 */
2233static void release_tty(struct tty_struct *tty, int idx)
2234{
2235 struct tty_driver *driver = tty->driver;
2236
2237 if (tty->link)
2238 release_one_tty(tty->link, idx);
2239 release_one_tty(tty, idx);
2240 module_put(driver->owner);
2241}
2242
Linus Torvalds1da177e2005-04-16 15:20:36 -07002243/*
2244 * Even releasing the tty structures is a tricky business.. We have
2245 * to be very careful that the structures are all released at the
2246 * same time, as interrupts might otherwise get the wrong pointers.
2247 *
2248 * WSH 09/09/97: rewritten to avoid some nasty race conditions that could
2249 * lead to double frees or releasing memory still in use.
2250 */
2251static void release_dev(struct file * filp)
2252{
2253 struct tty_struct *tty, *o_tty;
2254 int pty_master, tty_closing, o_tty_closing, do_sleep;
Paul Fulghum14a62832006-04-10 22:54:19 -07002255 int devpts;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002256 int idx;
2257 char buf[64];
2258 unsigned long flags;
2259
2260 tty = (struct tty_struct *)filp->private_data;
Josef Sipeka7113a92006-12-08 02:36:55 -08002261 if (tty_paranoia_check(tty, filp->f_path.dentry->d_inode, "release_dev"))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002262 return;
2263
2264 check_tty_count(tty, "release_dev");
2265
2266 tty_fasync(-1, filp, 0);
2267
2268 idx = tty->index;
2269 pty_master = (tty->driver->type == TTY_DRIVER_TYPE_PTY &&
2270 tty->driver->subtype == PTY_TYPE_MASTER);
2271 devpts = (tty->driver->flags & TTY_DRIVER_DEVPTS_MEM) != 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002272 o_tty = tty->link;
2273
2274#ifdef TTY_PARANOIA_CHECK
2275 if (idx < 0 || idx >= tty->driver->num) {
2276 printk(KERN_DEBUG "release_dev: bad idx when trying to "
2277 "free (%s)\n", tty->name);
2278 return;
2279 }
2280 if (!(tty->driver->flags & TTY_DRIVER_DEVPTS_MEM)) {
2281 if (tty != tty->driver->ttys[idx]) {
2282 printk(KERN_DEBUG "release_dev: driver.table[%d] not tty "
2283 "for (%s)\n", idx, tty->name);
2284 return;
2285 }
2286 if (tty->termios != tty->driver->termios[idx]) {
2287 printk(KERN_DEBUG "release_dev: driver.termios[%d] not termios "
2288 "for (%s)\n",
2289 idx, tty->name);
2290 return;
2291 }
2292 if (tty->termios_locked != tty->driver->termios_locked[idx]) {
2293 printk(KERN_DEBUG "release_dev: driver.termios_locked[%d] not "
2294 "termios_locked for (%s)\n",
2295 idx, tty->name);
2296 return;
2297 }
2298 }
2299#endif
2300
2301#ifdef TTY_DEBUG_HANGUP
2302 printk(KERN_DEBUG "release_dev of %s (tty count=%d)...",
2303 tty_name(tty, buf), tty->count);
2304#endif
2305
2306#ifdef TTY_PARANOIA_CHECK
2307 if (tty->driver->other &&
2308 !(tty->driver->flags & TTY_DRIVER_DEVPTS_MEM)) {
2309 if (o_tty != tty->driver->other->ttys[idx]) {
2310 printk(KERN_DEBUG "release_dev: other->table[%d] "
2311 "not o_tty for (%s)\n",
2312 idx, tty->name);
2313 return;
2314 }
2315 if (o_tty->termios != tty->driver->other->termios[idx]) {
2316 printk(KERN_DEBUG "release_dev: other->termios[%d] "
2317 "not o_termios for (%s)\n",
2318 idx, tty->name);
2319 return;
2320 }
2321 if (o_tty->termios_locked !=
2322 tty->driver->other->termios_locked[idx]) {
2323 printk(KERN_DEBUG "release_dev: other->termios_locked["
2324 "%d] not o_termios_locked for (%s)\n",
2325 idx, tty->name);
2326 return;
2327 }
2328 if (o_tty->link != tty) {
2329 printk(KERN_DEBUG "release_dev: bad pty pointers\n");
2330 return;
2331 }
2332 }
2333#endif
2334 if (tty->driver->close)
2335 tty->driver->close(tty, filp);
2336
2337 /*
2338 * Sanity check: if tty->count is going to zero, there shouldn't be
2339 * any waiters on tty->read_wait or tty->write_wait. We test the
2340 * wait queues and kick everyone out _before_ actually starting to
2341 * close. This ensures that we won't block while releasing the tty
2342 * structure.
2343 *
2344 * The test for the o_tty closing is necessary, since the master and
2345 * slave sides may close in any order. If the slave side closes out
2346 * first, its count will be one, since the master side holds an open.
2347 * Thus this test wouldn't be triggered at the time the slave closes,
2348 * so we do it now.
2349 *
2350 * Note that it's possible for the tty to be opened again while we're
2351 * flushing out waiters. By recalculating the closing flags before
2352 * each iteration we avoid any problems.
2353 */
2354 while (1) {
2355 /* Guard against races with tty->count changes elsewhere and
2356 opens on /dev/tty */
2357
Ingo Molnar70522e12006-03-23 03:00:31 -08002358 mutex_lock(&tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002359 tty_closing = tty->count <= 1;
2360 o_tty_closing = o_tty &&
2361 (o_tty->count <= (pty_master ? 1 : 0));
Linus Torvalds1da177e2005-04-16 15:20:36 -07002362 do_sleep = 0;
2363
2364 if (tty_closing) {
2365 if (waitqueue_active(&tty->read_wait)) {
2366 wake_up(&tty->read_wait);
2367 do_sleep++;
2368 }
2369 if (waitqueue_active(&tty->write_wait)) {
2370 wake_up(&tty->write_wait);
2371 do_sleep++;
2372 }
2373 }
2374 if (o_tty_closing) {
2375 if (waitqueue_active(&o_tty->read_wait)) {
2376 wake_up(&o_tty->read_wait);
2377 do_sleep++;
2378 }
2379 if (waitqueue_active(&o_tty->write_wait)) {
2380 wake_up(&o_tty->write_wait);
2381 do_sleep++;
2382 }
2383 }
2384 if (!do_sleep)
2385 break;
2386
2387 printk(KERN_WARNING "release_dev: %s: read/write wait queue "
2388 "active!\n", tty_name(tty, buf));
Ingo Molnar70522e12006-03-23 03:00:31 -08002389 mutex_unlock(&tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002390 schedule();
2391 }
2392
2393 /*
2394 * The closing flags are now consistent with the open counts on
2395 * both sides, and we've completed the last operation that could
2396 * block, so it's safe to proceed with closing.
2397 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002398 if (pty_master) {
2399 if (--o_tty->count < 0) {
2400 printk(KERN_WARNING "release_dev: bad pty slave count "
2401 "(%d) for %s\n",
2402 o_tty->count, tty_name(o_tty, buf));
2403 o_tty->count = 0;
2404 }
2405 }
2406 if (--tty->count < 0) {
2407 printk(KERN_WARNING "release_dev: bad tty->count (%d) for %s\n",
2408 tty->count, tty_name(tty, buf));
2409 tty->count = 0;
2410 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002411
2412 /*
2413 * We've decremented tty->count, so we need to remove this file
2414 * descriptor off the tty->tty_files list; this serves two
2415 * purposes:
2416 * - check_tty_count sees the correct number of file descriptors
2417 * associated with this tty.
2418 * - do_tty_hangup no longer sees this file descriptor as
2419 * something that needs to be handled for hangups.
2420 */
2421 file_kill(filp);
2422 filp->private_data = NULL;
2423
2424 /*
2425 * Perform some housekeeping before deciding whether to return.
2426 *
2427 * Set the TTY_CLOSING flag if this was the last open. In the
2428 * case of a pty we may have to wait around for the other side
2429 * to close, and TTY_CLOSING makes sure we can't be reopened.
2430 */
2431 if(tty_closing)
2432 set_bit(TTY_CLOSING, &tty->flags);
2433 if(o_tty_closing)
2434 set_bit(TTY_CLOSING, &o_tty->flags);
2435
2436 /*
2437 * If _either_ side is closing, make sure there aren't any
2438 * processes that still think tty or o_tty is their controlling
2439 * tty.
2440 */
2441 if (tty_closing || o_tty_closing) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002442 read_lock(&tasklist_lock);
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002443 session_clear_tty(tty->session);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002444 if (o_tty)
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002445 session_clear_tty(o_tty->session);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002446 read_unlock(&tasklist_lock);
2447 }
2448
Ingo Molnar70522e12006-03-23 03:00:31 -08002449 mutex_unlock(&tty_mutex);
Paul Fulghumda965822006-02-14 13:53:00 -08002450
Linus Torvalds1da177e2005-04-16 15:20:36 -07002451 /* check whether both sides are closing ... */
2452 if (!tty_closing || (o_tty && !o_tty_closing))
2453 return;
2454
2455#ifdef TTY_DEBUG_HANGUP
2456 printk(KERN_DEBUG "freeing tty structure...");
2457#endif
2458 /*
2459 * Prevent flush_to_ldisc() from rescheduling the work for later. Then
2460 * kill any delayed work. As this is the final close it does not
2461 * race with the set_ldisc code path.
2462 */
2463 clear_bit(TTY_LDISC, &tty->flags);
Alan Cox33f0f882006-01-09 20:54:13 -08002464 cancel_delayed_work(&tty->buf.work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002465
2466 /*
Alan Cox33f0f882006-01-09 20:54:13 -08002467 * Wait for ->hangup_work and ->buf.work handlers to terminate
Linus Torvalds1da177e2005-04-16 15:20:36 -07002468 */
2469
2470 flush_scheduled_work();
2471
2472 /*
2473 * Wait for any short term users (we know they are just driver
2474 * side waiters as the file is closing so user count on the file
2475 * side is zero.
2476 */
2477 spin_lock_irqsave(&tty_ldisc_lock, flags);
2478 while(tty->ldisc.refcount)
2479 {
2480 spin_unlock_irqrestore(&tty_ldisc_lock, flags);
2481 wait_event(tty_ldisc_wait, tty->ldisc.refcount == 0);
2482 spin_lock_irqsave(&tty_ldisc_lock, flags);
2483 }
2484 spin_unlock_irqrestore(&tty_ldisc_lock, flags);
2485 /*
2486 * Shutdown the current line discipline, and reset it to N_TTY.
2487 * N.B. why reset ldisc when we're releasing the memory??
2488 *
2489 * FIXME: this MUST get fixed for the new reflocking
2490 */
2491 if (tty->ldisc.close)
2492 (tty->ldisc.close)(tty);
2493 tty_ldisc_put(tty->ldisc.num);
2494
2495 /*
2496 * Switch the line discipline back
2497 */
2498 tty_ldisc_assign(tty, tty_ldisc_get(N_TTY));
2499 tty_set_termios_ldisc(tty,N_TTY);
2500 if (o_tty) {
2501 /* FIXME: could o_tty be in setldisc here ? */
2502 clear_bit(TTY_LDISC, &o_tty->flags);
2503 if (o_tty->ldisc.close)
2504 (o_tty->ldisc.close)(o_tty);
2505 tty_ldisc_put(o_tty->ldisc.num);
2506 tty_ldisc_assign(o_tty, tty_ldisc_get(N_TTY));
2507 tty_set_termios_ldisc(o_tty,N_TTY);
2508 }
2509 /*
Christoph Hellwigd5698c22007-02-10 01:46:46 -08002510 * The release_tty function takes care of the details of clearing
Linus Torvalds1da177e2005-04-16 15:20:36 -07002511 * the slots and preserving the termios structure.
2512 */
Christoph Hellwigd5698c22007-02-10 01:46:46 -08002513 release_tty(tty, idx);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002514
2515#ifdef CONFIG_UNIX98_PTYS
2516 /* Make this pty number available for reallocation */
2517 if (devpts) {
2518 down(&allocated_ptys_lock);
2519 idr_remove(&allocated_ptys, idx);
2520 up(&allocated_ptys_lock);
2521 }
2522#endif
2523
2524}
2525
Alan Coxaf9b8972006-08-27 01:24:01 -07002526/**
2527 * tty_open - open a tty device
2528 * @inode: inode of device file
2529 * @filp: file pointer to tty
Linus Torvalds1da177e2005-04-16 15:20:36 -07002530 *
Alan Coxaf9b8972006-08-27 01:24:01 -07002531 * tty_open and tty_release keep up the tty count that contains the
2532 * number of opens done on a tty. We cannot use the inode-count, as
2533 * different inodes might point to the same tty.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002534 *
Alan Coxaf9b8972006-08-27 01:24:01 -07002535 * Open-counting is needed for pty masters, as well as for keeping
2536 * track of serial lines: DTR is dropped when the last close happens.
2537 * (This is not done solely through tty->count, now. - Ted 1/27/92)
2538 *
2539 * The termios state of a pty is reset on first open so that
2540 * settings don't persist across reuse.
2541 *
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002542 * Locking: tty_mutex protects tty, get_tty_driver and init_dev work.
2543 * tty->count should protect the rest.
2544 * ->siglock protects ->signal/->sighand
Linus Torvalds1da177e2005-04-16 15:20:36 -07002545 */
Alan Coxaf9b8972006-08-27 01:24:01 -07002546
Linus Torvalds1da177e2005-04-16 15:20:36 -07002547static int tty_open(struct inode * inode, struct file * filp)
2548{
2549 struct tty_struct *tty;
2550 int noctty, retval;
2551 struct tty_driver *driver;
2552 int index;
2553 dev_t device = inode->i_rdev;
2554 unsigned short saved_flags = filp->f_flags;
2555
2556 nonseekable_open(inode, filp);
2557
2558retry_open:
2559 noctty = filp->f_flags & O_NOCTTY;
2560 index = -1;
2561 retval = 0;
2562
Ingo Molnar70522e12006-03-23 03:00:31 -08002563 mutex_lock(&tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002564
2565 if (device == MKDEV(TTYAUX_MAJOR,0)) {
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002566 tty = get_current_tty();
2567 if (!tty) {
Ingo Molnar70522e12006-03-23 03:00:31 -08002568 mutex_unlock(&tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002569 return -ENXIO;
2570 }
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002571 driver = tty->driver;
2572 index = tty->index;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002573 filp->f_flags |= O_NONBLOCK; /* Don't let /dev/tty block */
2574 /* noctty = 1; */
2575 goto got_driver;
2576 }
2577#ifdef CONFIG_VT
2578 if (device == MKDEV(TTY_MAJOR,0)) {
2579 extern struct tty_driver *console_driver;
2580 driver = console_driver;
2581 index = fg_console;
2582 noctty = 1;
2583 goto got_driver;
2584 }
2585#endif
2586 if (device == MKDEV(TTYAUX_MAJOR,1)) {
2587 driver = console_device(&index);
2588 if (driver) {
2589 /* Don't let /dev/console block */
2590 filp->f_flags |= O_NONBLOCK;
2591 noctty = 1;
2592 goto got_driver;
2593 }
Ingo Molnar70522e12006-03-23 03:00:31 -08002594 mutex_unlock(&tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002595 return -ENODEV;
2596 }
2597
2598 driver = get_tty_driver(device, &index);
2599 if (!driver) {
Ingo Molnar70522e12006-03-23 03:00:31 -08002600 mutex_unlock(&tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002601 return -ENODEV;
2602 }
2603got_driver:
2604 retval = init_dev(driver, index, &tty);
Ingo Molnar70522e12006-03-23 03:00:31 -08002605 mutex_unlock(&tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002606 if (retval)
2607 return retval;
2608
2609 filp->private_data = tty;
2610 file_move(filp, &tty->tty_files);
2611 check_tty_count(tty, "tty_open");
2612 if (tty->driver->type == TTY_DRIVER_TYPE_PTY &&
2613 tty->driver->subtype == PTY_TYPE_MASTER)
2614 noctty = 1;
2615#ifdef TTY_DEBUG_HANGUP
2616 printk(KERN_DEBUG "opening %s...", tty->name);
2617#endif
2618 if (!retval) {
2619 if (tty->driver->open)
2620 retval = tty->driver->open(tty, filp);
2621 else
2622 retval = -ENODEV;
2623 }
2624 filp->f_flags = saved_flags;
2625
2626 if (!retval && test_bit(TTY_EXCLUSIVE, &tty->flags) && !capable(CAP_SYS_ADMIN))
2627 retval = -EBUSY;
2628
2629 if (retval) {
2630#ifdef TTY_DEBUG_HANGUP
2631 printk(KERN_DEBUG "error %d in opening %s...", retval,
2632 tty->name);
2633#endif
2634 release_dev(filp);
2635 if (retval != -ERESTARTSYS)
2636 return retval;
2637 if (signal_pending(current))
2638 return retval;
2639 schedule();
2640 /*
2641 * Need to reset f_op in case a hangup happened.
2642 */
2643 if (filp->f_op == &hung_up_tty_fops)
2644 filp->f_op = &tty_fops;
2645 goto retry_open;
2646 }
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002647
2648 mutex_lock(&tty_mutex);
2649 spin_lock_irq(&current->sighand->siglock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002650 if (!noctty &&
2651 current->signal->leader &&
2652 !current->signal->tty &&
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08002653 tty->session == NULL)
Eric W. Biederman2a65f1d2007-05-08 00:26:53 -07002654 __proc_set_tty(current, tty);
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002655 spin_unlock_irq(&current->sighand->siglock);
2656 mutex_unlock(&tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002657 return 0;
2658}
2659
2660#ifdef CONFIG_UNIX98_PTYS
Alan Coxaf9b8972006-08-27 01:24:01 -07002661/**
2662 * ptmx_open - open a unix 98 pty master
2663 * @inode: inode of device file
2664 * @filp: file pointer to tty
2665 *
2666 * Allocate a unix98 pty master device from the ptmx driver.
2667 *
2668 * Locking: tty_mutex protects theinit_dev work. tty->count should
2669 protect the rest.
2670 * allocated_ptys_lock handles the list of free pty numbers
2671 */
2672
Linus Torvalds1da177e2005-04-16 15:20:36 -07002673static int ptmx_open(struct inode * inode, struct file * filp)
2674{
2675 struct tty_struct *tty;
2676 int retval;
2677 int index;
2678 int idr_ret;
2679
2680 nonseekable_open(inode, filp);
2681
2682 /* find a device that is not in use. */
2683 down(&allocated_ptys_lock);
2684 if (!idr_pre_get(&allocated_ptys, GFP_KERNEL)) {
2685 up(&allocated_ptys_lock);
2686 return -ENOMEM;
2687 }
2688 idr_ret = idr_get_new(&allocated_ptys, NULL, &index);
2689 if (idr_ret < 0) {
2690 up(&allocated_ptys_lock);
2691 if (idr_ret == -EAGAIN)
2692 return -ENOMEM;
2693 return -EIO;
2694 }
2695 if (index >= pty_limit) {
2696 idr_remove(&allocated_ptys, index);
2697 up(&allocated_ptys_lock);
2698 return -EIO;
2699 }
2700 up(&allocated_ptys_lock);
2701
Ingo Molnar70522e12006-03-23 03:00:31 -08002702 mutex_lock(&tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002703 retval = init_dev(ptm_driver, index, &tty);
Ingo Molnar70522e12006-03-23 03:00:31 -08002704 mutex_unlock(&tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002705
2706 if (retval)
2707 goto out;
2708
2709 set_bit(TTY_PTY_LOCK, &tty->flags); /* LOCK THE SLAVE */
2710 filp->private_data = tty;
2711 file_move(filp, &tty->tty_files);
2712
2713 retval = -ENOMEM;
2714 if (devpts_pty_new(tty->link))
2715 goto out1;
2716
2717 check_tty_count(tty, "tty_open");
2718 retval = ptm_driver->open(tty, filp);
2719 if (!retval)
2720 return 0;
2721out1:
2722 release_dev(filp);
Paul Fulghum9453a5a2006-04-10 22:54:18 -07002723 return retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002724out:
2725 down(&allocated_ptys_lock);
2726 idr_remove(&allocated_ptys, index);
2727 up(&allocated_ptys_lock);
2728 return retval;
2729}
2730#endif
2731
Alan Coxaf9b8972006-08-27 01:24:01 -07002732/**
2733 * tty_release - vfs callback for close
2734 * @inode: inode of tty
2735 * @filp: file pointer for handle to tty
2736 *
2737 * Called the last time each file handle is closed that references
2738 * this tty. There may however be several such references.
2739 *
2740 * Locking:
2741 * Takes bkl. See release_dev
2742 */
2743
Linus Torvalds1da177e2005-04-16 15:20:36 -07002744static int tty_release(struct inode * inode, struct file * filp)
2745{
2746 lock_kernel();
2747 release_dev(filp);
2748 unlock_kernel();
2749 return 0;
2750}
2751
Alan Coxaf9b8972006-08-27 01:24:01 -07002752/**
2753 * tty_poll - check tty status
2754 * @filp: file being polled
2755 * @wait: poll wait structures to update
2756 *
2757 * Call the line discipline polling method to obtain the poll
2758 * status of the device.
2759 *
2760 * Locking: locks called line discipline but ldisc poll method
2761 * may be re-entered freely by other callers.
2762 */
2763
Linus Torvalds1da177e2005-04-16 15:20:36 -07002764static unsigned int tty_poll(struct file * filp, poll_table * wait)
2765{
2766 struct tty_struct * tty;
2767 struct tty_ldisc *ld;
2768 int ret = 0;
2769
2770 tty = (struct tty_struct *)filp->private_data;
Josef Sipeka7113a92006-12-08 02:36:55 -08002771 if (tty_paranoia_check(tty, filp->f_path.dentry->d_inode, "tty_poll"))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002772 return 0;
2773
2774 ld = tty_ldisc_ref_wait(tty);
2775 if (ld->poll)
2776 ret = (ld->poll)(tty, filp, wait);
2777 tty_ldisc_deref(ld);
2778 return ret;
2779}
2780
2781static int tty_fasync(int fd, struct file * filp, int on)
2782{
2783 struct tty_struct * tty;
2784 int retval;
2785
2786 tty = (struct tty_struct *)filp->private_data;
Josef Sipeka7113a92006-12-08 02:36:55 -08002787 if (tty_paranoia_check(tty, filp->f_path.dentry->d_inode, "tty_fasync"))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002788 return 0;
2789
2790 retval = fasync_helper(fd, filp, on, &tty->fasync);
2791 if (retval <= 0)
2792 return retval;
2793
2794 if (on) {
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08002795 enum pid_type type;
2796 struct pid *pid;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002797 if (!waitqueue_active(&tty->read_wait))
2798 tty->minimum_to_wake = 1;
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08002799 if (tty->pgrp) {
2800 pid = tty->pgrp;
2801 type = PIDTYPE_PGID;
2802 } else {
2803 pid = task_pid(current);
2804 type = PIDTYPE_PID;
2805 }
2806 retval = __f_setown(filp, pid, type, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002807 if (retval)
2808 return retval;
2809 } else {
2810 if (!tty->fasync && !waitqueue_active(&tty->read_wait))
2811 tty->minimum_to_wake = N_TTY_BUF_SIZE;
2812 }
2813 return 0;
2814}
2815
Alan Coxaf9b8972006-08-27 01:24:01 -07002816/**
2817 * tiocsti - fake input character
2818 * @tty: tty to fake input into
2819 * @p: pointer to character
2820 *
2821 * Fake input to a tty device. Does the neccessary locking and
2822 * input management.
2823 *
2824 * FIXME: does not honour flow control ??
2825 *
2826 * Locking:
2827 * Called functions take tty_ldisc_lock
2828 * current->signal->tty check is safe without locks
Alan Cox28298232006-09-29 02:00:58 -07002829 *
2830 * FIXME: may race normal receive processing
Alan Coxaf9b8972006-08-27 01:24:01 -07002831 */
2832
Linus Torvalds1da177e2005-04-16 15:20:36 -07002833static int tiocsti(struct tty_struct *tty, char __user *p)
2834{
2835 char ch, mbz = 0;
2836 struct tty_ldisc *ld;
2837
2838 if ((current->signal->tty != tty) && !capable(CAP_SYS_ADMIN))
2839 return -EPERM;
2840 if (get_user(ch, p))
2841 return -EFAULT;
2842 ld = tty_ldisc_ref_wait(tty);
2843 ld->receive_buf(tty, &ch, &mbz, 1);
2844 tty_ldisc_deref(ld);
2845 return 0;
2846}
2847
Alan Coxaf9b8972006-08-27 01:24:01 -07002848/**
2849 * tiocgwinsz - implement window query ioctl
2850 * @tty; tty
2851 * @arg: user buffer for result
2852 *
Alan Cox808a0d32006-09-29 02:00:40 -07002853 * Copies the kernel idea of the window size into the user buffer.
Alan Coxaf9b8972006-08-27 01:24:01 -07002854 *
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002855 * Locking: tty->termios_mutex is taken to ensure the winsize data
Alan Cox808a0d32006-09-29 02:00:40 -07002856 * is consistent.
Alan Coxaf9b8972006-08-27 01:24:01 -07002857 */
2858
Linus Torvalds1da177e2005-04-16 15:20:36 -07002859static int tiocgwinsz(struct tty_struct *tty, struct winsize __user * arg)
2860{
Alan Cox808a0d32006-09-29 02:00:40 -07002861 int err;
2862
Arjan van de Ven5785c952006-09-29 02:00:43 -07002863 mutex_lock(&tty->termios_mutex);
Alan Cox808a0d32006-09-29 02:00:40 -07002864 err = copy_to_user(arg, &tty->winsize, sizeof(*arg));
Arjan van de Ven5785c952006-09-29 02:00:43 -07002865 mutex_unlock(&tty->termios_mutex);
Alan Cox808a0d32006-09-29 02:00:40 -07002866
2867 return err ? -EFAULT: 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002868}
2869
Alan Coxaf9b8972006-08-27 01:24:01 -07002870/**
2871 * tiocswinsz - implement window size set ioctl
2872 * @tty; tty
2873 * @arg: user buffer for result
2874 *
2875 * Copies the user idea of the window size to the kernel. Traditionally
2876 * this is just advisory information but for the Linux console it
2877 * actually has driver level meaning and triggers a VC resize.
2878 *
2879 * Locking:
Alan Coxca9bda02006-09-29 02:00:03 -07002880 * Called function use the console_sem is used to ensure we do
2881 * not try and resize the console twice at once.
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002882 * The tty->termios_mutex is used to ensure we don't double
2883 * resize and get confused. Lock order - tty->termios_mutex before
Alan Coxca9bda02006-09-29 02:00:03 -07002884 * console sem
Alan Coxaf9b8972006-08-27 01:24:01 -07002885 */
2886
Linus Torvalds1da177e2005-04-16 15:20:36 -07002887static int tiocswinsz(struct tty_struct *tty, struct tty_struct *real_tty,
2888 struct winsize __user * arg)
2889{
2890 struct winsize tmp_ws;
2891
2892 if (copy_from_user(&tmp_ws, arg, sizeof(*arg)))
2893 return -EFAULT;
Alan Coxca9bda02006-09-29 02:00:03 -07002894
Arjan van de Ven5785c952006-09-29 02:00:43 -07002895 mutex_lock(&tty->termios_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002896 if (!memcmp(&tmp_ws, &tty->winsize, sizeof(*arg)))
Alan Coxca9bda02006-09-29 02:00:03 -07002897 goto done;
2898
Linus Torvalds1da177e2005-04-16 15:20:36 -07002899#ifdef CONFIG_VT
2900 if (tty->driver->type == TTY_DRIVER_TYPE_CONSOLE) {
Arjan van de Ven5785c952006-09-29 02:00:43 -07002901 if (vc_lock_resize(tty->driver_data, tmp_ws.ws_col,
2902 tmp_ws.ws_row)) {
2903 mutex_unlock(&tty->termios_mutex);
Alan Coxca9bda02006-09-29 02:00:03 -07002904 return -ENXIO;
2905 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002906 }
2907#endif
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08002908 if (tty->pgrp)
2909 kill_pgrp(tty->pgrp, SIGWINCH, 1);
2910 if ((real_tty->pgrp != tty->pgrp) && real_tty->pgrp)
2911 kill_pgrp(real_tty->pgrp, SIGWINCH, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002912 tty->winsize = tmp_ws;
2913 real_tty->winsize = tmp_ws;
Alan Coxca9bda02006-09-29 02:00:03 -07002914done:
Arjan van de Ven5785c952006-09-29 02:00:43 -07002915 mutex_unlock(&tty->termios_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002916 return 0;
2917}
2918
Alan Coxaf9b8972006-08-27 01:24:01 -07002919/**
2920 * tioccons - allow admin to move logical console
2921 * @file: the file to become console
2922 *
2923 * Allow the adminstrator to move the redirected console device
2924 *
2925 * Locking: uses redirect_lock to guard the redirect information
2926 */
2927
Linus Torvalds1da177e2005-04-16 15:20:36 -07002928static int tioccons(struct file *file)
2929{
2930 if (!capable(CAP_SYS_ADMIN))
2931 return -EPERM;
2932 if (file->f_op->write == redirected_tty_write) {
2933 struct file *f;
2934 spin_lock(&redirect_lock);
2935 f = redirect;
2936 redirect = NULL;
2937 spin_unlock(&redirect_lock);
2938 if (f)
2939 fput(f);
2940 return 0;
2941 }
2942 spin_lock(&redirect_lock);
2943 if (redirect) {
2944 spin_unlock(&redirect_lock);
2945 return -EBUSY;
2946 }
2947 get_file(file);
2948 redirect = file;
2949 spin_unlock(&redirect_lock);
2950 return 0;
2951}
2952
Alan Coxaf9b8972006-08-27 01:24:01 -07002953/**
2954 * fionbio - non blocking ioctl
2955 * @file: file to set blocking value
2956 * @p: user parameter
2957 *
2958 * Historical tty interfaces had a blocking control ioctl before
2959 * the generic functionality existed. This piece of history is preserved
2960 * in the expected tty API of posix OS's.
2961 *
2962 * Locking: none, the open fle handle ensures it won't go away.
2963 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002964
2965static int fionbio(struct file *file, int __user *p)
2966{
2967 int nonblock;
2968
2969 if (get_user(nonblock, p))
2970 return -EFAULT;
2971
2972 if (nonblock)
2973 file->f_flags |= O_NONBLOCK;
2974 else
2975 file->f_flags &= ~O_NONBLOCK;
2976 return 0;
2977}
2978
Alan Coxaf9b8972006-08-27 01:24:01 -07002979/**
2980 * tiocsctty - set controlling tty
2981 * @tty: tty structure
2982 * @arg: user argument
2983 *
2984 * This ioctl is used to manage job control. It permits a session
2985 * leader to set this tty as the controlling tty for the session.
2986 *
2987 * Locking:
Alan Cox28298232006-09-29 02:00:58 -07002988 * Takes tty_mutex() to protect tty instance
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002989 * Takes tasklist_lock internally to walk sessions
2990 * Takes ->siglock() when updating signal->tty
Alan Coxaf9b8972006-08-27 01:24:01 -07002991 */
2992
Linus Torvalds1da177e2005-04-16 15:20:36 -07002993static int tiocsctty(struct tty_struct *tty, int arg)
2994{
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002995 int ret = 0;
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08002996 if (current->signal->leader && (task_session(current) == tty->session))
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002997 return ret;
2998
2999 mutex_lock(&tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003000 /*
3001 * The process must be a session leader and
3002 * not have a controlling tty already.
3003 */
Peter Zijlstra24ec8392006-12-08 02:36:04 -08003004 if (!current->signal->leader || current->signal->tty) {
3005 ret = -EPERM;
3006 goto unlock;
3007 }
3008
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08003009 if (tty->session) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07003010 /*
3011 * This tty is already the controlling
3012 * tty for another session group!
3013 */
3014 if ((arg == 1) && capable(CAP_SYS_ADMIN)) {
3015 /*
3016 * Steal it away
3017 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003018 read_lock(&tasklist_lock);
Peter Zijlstra24ec8392006-12-08 02:36:04 -08003019 session_clear_tty(tty->session);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003020 read_unlock(&tasklist_lock);
Peter Zijlstra24ec8392006-12-08 02:36:04 -08003021 } else {
3022 ret = -EPERM;
3023 goto unlock;
3024 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003025 }
Peter Zijlstra24ec8392006-12-08 02:36:04 -08003026 proc_set_tty(current, tty);
3027unlock:
Alan Cox28298232006-09-29 02:00:58 -07003028 mutex_unlock(&tty_mutex);
Peter Zijlstra24ec8392006-12-08 02:36:04 -08003029 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003030}
3031
Alan Coxaf9b8972006-08-27 01:24:01 -07003032/**
3033 * tiocgpgrp - get process group
3034 * @tty: tty passed by user
3035 * @real_tty: tty side of the tty pased by the user if a pty else the tty
3036 * @p: returned pid
3037 *
3038 * Obtain the process group of the tty. If there is no process group
3039 * return an error.
3040 *
Peter Zijlstra24ec8392006-12-08 02:36:04 -08003041 * Locking: none. Reference to current->signal->tty is safe.
Alan Coxaf9b8972006-08-27 01:24:01 -07003042 */
3043
Linus Torvalds1da177e2005-04-16 15:20:36 -07003044static int tiocgpgrp(struct tty_struct *tty, struct tty_struct *real_tty, pid_t __user *p)
3045{
3046 /*
3047 * (tty == real_tty) is a cheap way of
3048 * testing if the tty is NOT a master pty.
3049 */
3050 if (tty == real_tty && current->signal->tty != real_tty)
3051 return -ENOTTY;
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08003052 return put_user(pid_nr(real_tty->pgrp), p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003053}
3054
Alan Coxaf9b8972006-08-27 01:24:01 -07003055/**
3056 * tiocspgrp - attempt to set process group
3057 * @tty: tty passed by user
3058 * @real_tty: tty side device matching tty passed by user
3059 * @p: pid pointer
3060 *
3061 * Set the process group of the tty to the session passed. Only
3062 * permitted where the tty session is our session.
3063 *
3064 * Locking: None
Alan Coxaf9b8972006-08-27 01:24:01 -07003065 */
3066
Linus Torvalds1da177e2005-04-16 15:20:36 -07003067static int tiocspgrp(struct tty_struct *tty, struct tty_struct *real_tty, pid_t __user *p)
3068{
Eric W. Biederman04a2e6a2007-02-12 00:52:56 -08003069 struct pid *pgrp;
3070 pid_t pgrp_nr;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003071 int retval = tty_check_change(real_tty);
3072
3073 if (retval == -EIO)
3074 return -ENOTTY;
3075 if (retval)
3076 return retval;
3077 if (!current->signal->tty ||
3078 (current->signal->tty != real_tty) ||
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08003079 (real_tty->session != task_session(current)))
Linus Torvalds1da177e2005-04-16 15:20:36 -07003080 return -ENOTTY;
Eric W. Biederman04a2e6a2007-02-12 00:52:56 -08003081 if (get_user(pgrp_nr, p))
Linus Torvalds1da177e2005-04-16 15:20:36 -07003082 return -EFAULT;
Eric W. Biederman04a2e6a2007-02-12 00:52:56 -08003083 if (pgrp_nr < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003084 return -EINVAL;
Eric W. Biederman04a2e6a2007-02-12 00:52:56 -08003085 rcu_read_lock();
3086 pgrp = find_pid(pgrp_nr);
3087 retval = -ESRCH;
3088 if (!pgrp)
3089 goto out_unlock;
3090 retval = -EPERM;
3091 if (session_of_pgrp(pgrp) != task_session(current))
3092 goto out_unlock;
3093 retval = 0;
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08003094 put_pid(real_tty->pgrp);
3095 real_tty->pgrp = get_pid(pgrp);
Eric W. Biederman04a2e6a2007-02-12 00:52:56 -08003096out_unlock:
3097 rcu_read_unlock();
3098 return retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003099}
3100
Alan Coxaf9b8972006-08-27 01:24:01 -07003101/**
3102 * tiocgsid - get session id
3103 * @tty: tty passed by user
3104 * @real_tty: tty side of the tty pased by the user if a pty else the tty
3105 * @p: pointer to returned session id
3106 *
3107 * Obtain the session id of the tty. If there is no session
3108 * return an error.
3109 *
Peter Zijlstra24ec8392006-12-08 02:36:04 -08003110 * Locking: none. Reference to current->signal->tty is safe.
Alan Coxaf9b8972006-08-27 01:24:01 -07003111 */
3112
Linus Torvalds1da177e2005-04-16 15:20:36 -07003113static int tiocgsid(struct tty_struct *tty, struct tty_struct *real_tty, pid_t __user *p)
3114{
3115 /*
3116 * (tty == real_tty) is a cheap way of
3117 * testing if the tty is NOT a master pty.
3118 */
3119 if (tty == real_tty && current->signal->tty != real_tty)
3120 return -ENOTTY;
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08003121 if (!real_tty->session)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003122 return -ENOTTY;
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08003123 return put_user(pid_nr(real_tty->session), p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003124}
3125
Alan Coxaf9b8972006-08-27 01:24:01 -07003126/**
3127 * tiocsetd - set line discipline
3128 * @tty: tty device
3129 * @p: pointer to user data
3130 *
3131 * Set the line discipline according to user request.
3132 *
3133 * Locking: see tty_set_ldisc, this function is just a helper
3134 */
3135
Linus Torvalds1da177e2005-04-16 15:20:36 -07003136static int tiocsetd(struct tty_struct *tty, int __user *p)
3137{
3138 int ldisc;
3139
3140 if (get_user(ldisc, p))
3141 return -EFAULT;
3142 return tty_set_ldisc(tty, ldisc);
3143}
3144
Alan Coxaf9b8972006-08-27 01:24:01 -07003145/**
3146 * send_break - performed time break
3147 * @tty: device to break on
3148 * @duration: timeout in mS
3149 *
3150 * Perform a timed break on hardware that lacks its own driver level
3151 * timed break functionality.
3152 *
3153 * Locking:
Alan Cox28298232006-09-29 02:00:58 -07003154 * atomic_write_lock serializes
Alan Coxaf9b8972006-08-27 01:24:01 -07003155 *
Alan Coxaf9b8972006-08-27 01:24:01 -07003156 */
3157
Domen Puncerb20f3ae2005-06-25 14:58:42 -07003158static int send_break(struct tty_struct *tty, unsigned int duration)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003159{
Alan Cox28298232006-09-29 02:00:58 -07003160 if (mutex_lock_interruptible(&tty->atomic_write_lock))
3161 return -EINTR;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003162 tty->driver->break_ctl(tty, -1);
3163 if (!signal_pending(current)) {
Domen Puncerb20f3ae2005-06-25 14:58:42 -07003164 msleep_interruptible(duration);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003165 }
3166 tty->driver->break_ctl(tty, 0);
Alan Cox28298232006-09-29 02:00:58 -07003167 mutex_unlock(&tty->atomic_write_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003168 if (signal_pending(current))
3169 return -EINTR;
3170 return 0;
3171}
3172
Alan Coxaf9b8972006-08-27 01:24:01 -07003173/**
3174 * tiocmget - get modem status
3175 * @tty: tty device
3176 * @file: user file pointer
3177 * @p: pointer to result
3178 *
3179 * Obtain the modem status bits from the tty driver if the feature
3180 * is supported. Return -EINVAL if it is not available.
3181 *
3182 * Locking: none (up to the driver)
3183 */
3184
3185static int tty_tiocmget(struct tty_struct *tty, struct file *file, int __user *p)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003186{
3187 int retval = -EINVAL;
3188
3189 if (tty->driver->tiocmget) {
3190 retval = tty->driver->tiocmget(tty, file);
3191
3192 if (retval >= 0)
3193 retval = put_user(retval, p);
3194 }
3195 return retval;
3196}
3197
Alan Coxaf9b8972006-08-27 01:24:01 -07003198/**
3199 * tiocmset - set modem status
3200 * @tty: tty device
3201 * @file: user file pointer
3202 * @cmd: command - clear bits, set bits or set all
3203 * @p: pointer to desired bits
3204 *
3205 * Set the modem status bits from the tty driver if the feature
3206 * is supported. Return -EINVAL if it is not available.
3207 *
3208 * Locking: none (up to the driver)
3209 */
3210
3211static int tty_tiocmset(struct tty_struct *tty, struct file *file, unsigned int cmd,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003212 unsigned __user *p)
3213{
3214 int retval = -EINVAL;
3215
3216 if (tty->driver->tiocmset) {
3217 unsigned int set, clear, val;
3218
3219 retval = get_user(val, p);
3220 if (retval)
3221 return retval;
3222
3223 set = clear = 0;
3224 switch (cmd) {
3225 case TIOCMBIS:
3226 set = val;
3227 break;
3228 case TIOCMBIC:
3229 clear = val;
3230 break;
3231 case TIOCMSET:
3232 set = val;
3233 clear = ~val;
3234 break;
3235 }
3236
3237 set &= TIOCM_DTR|TIOCM_RTS|TIOCM_OUT1|TIOCM_OUT2|TIOCM_LOOP;
3238 clear &= TIOCM_DTR|TIOCM_RTS|TIOCM_OUT1|TIOCM_OUT2|TIOCM_LOOP;
3239
3240 retval = tty->driver->tiocmset(tty, file, set, clear);
3241 }
3242 return retval;
3243}
3244
3245/*
3246 * Split this up, as gcc can choke on it otherwise..
3247 */
3248int tty_ioctl(struct inode * inode, struct file * file,
3249 unsigned int cmd, unsigned long arg)
3250{
3251 struct tty_struct *tty, *real_tty;
3252 void __user *p = (void __user *)arg;
3253 int retval;
3254 struct tty_ldisc *ld;
3255
3256 tty = (struct tty_struct *)file->private_data;
3257 if (tty_paranoia_check(tty, inode, "tty_ioctl"))
3258 return -EINVAL;
3259
Alan Cox28298232006-09-29 02:00:58 -07003260 /* CHECKME: is this safe as one end closes ? */
3261
Linus Torvalds1da177e2005-04-16 15:20:36 -07003262 real_tty = tty;
3263 if (tty->driver->type == TTY_DRIVER_TYPE_PTY &&
3264 tty->driver->subtype == PTY_TYPE_MASTER)
3265 real_tty = tty->link;
3266
3267 /*
3268 * Break handling by driver
3269 */
3270 if (!tty->driver->break_ctl) {
3271 switch(cmd) {
3272 case TIOCSBRK:
3273 case TIOCCBRK:
3274 if (tty->driver->ioctl)
3275 return tty->driver->ioctl(tty, file, cmd, arg);
3276 return -EINVAL;
3277
3278 /* These two ioctl's always return success; even if */
3279 /* the driver doesn't support them. */
3280 case TCSBRK:
3281 case TCSBRKP:
3282 if (!tty->driver->ioctl)
3283 return 0;
3284 retval = tty->driver->ioctl(tty, file, cmd, arg);
3285 if (retval == -ENOIOCTLCMD)
3286 retval = 0;
3287 return retval;
3288 }
3289 }
3290
3291 /*
3292 * Factor out some common prep work
3293 */
3294 switch (cmd) {
3295 case TIOCSETD:
3296 case TIOCSBRK:
3297 case TIOCCBRK:
3298 case TCSBRK:
3299 case TCSBRKP:
3300 retval = tty_check_change(tty);
3301 if (retval)
3302 return retval;
3303 if (cmd != TIOCCBRK) {
3304 tty_wait_until_sent(tty, 0);
3305 if (signal_pending(current))
3306 return -EINTR;
3307 }
3308 break;
3309 }
3310
3311 switch (cmd) {
3312 case TIOCSTI:
3313 return tiocsti(tty, p);
3314 case TIOCGWINSZ:
3315 return tiocgwinsz(tty, p);
3316 case TIOCSWINSZ:
3317 return tiocswinsz(tty, real_tty, p);
3318 case TIOCCONS:
3319 return real_tty!=tty ? -EINVAL : tioccons(file);
3320 case FIONBIO:
3321 return fionbio(file, p);
3322 case TIOCEXCL:
3323 set_bit(TTY_EXCLUSIVE, &tty->flags);
3324 return 0;
3325 case TIOCNXCL:
3326 clear_bit(TTY_EXCLUSIVE, &tty->flags);
3327 return 0;
3328 case TIOCNOTTY:
3329 if (current->signal->tty != tty)
3330 return -ENOTTY;
Eric W. Biederman98a27ba2007-05-08 00:26:56 -07003331 no_tty();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003332 return 0;
3333 case TIOCSCTTY:
3334 return tiocsctty(tty, arg);
3335 case TIOCGPGRP:
3336 return tiocgpgrp(tty, real_tty, p);
3337 case TIOCSPGRP:
3338 return tiocspgrp(tty, real_tty, p);
3339 case TIOCGSID:
3340 return tiocgsid(tty, real_tty, p);
3341 case TIOCGETD:
3342 /* FIXME: check this is ok */
3343 return put_user(tty->ldisc.num, (int __user *)p);
3344 case TIOCSETD:
3345 return tiocsetd(tty, p);
3346#ifdef CONFIG_VT
3347 case TIOCLINUX:
3348 return tioclinux(tty, arg);
3349#endif
3350 /*
3351 * Break handling
3352 */
3353 case TIOCSBRK: /* Turn break on, unconditionally */
3354 tty->driver->break_ctl(tty, -1);
3355 return 0;
3356
3357 case TIOCCBRK: /* Turn break off, unconditionally */
3358 tty->driver->break_ctl(tty, 0);
3359 return 0;
3360 case TCSBRK: /* SVID version: non-zero arg --> no break */
Paul Fulghum283fef52006-06-27 02:54:00 -07003361 /* non-zero arg means wait for all output data
3362 * to be sent (performed above) but don't send break.
3363 * This is used by the tcdrain() termios function.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003364 */
3365 if (!arg)
Domen Puncerb20f3ae2005-06-25 14:58:42 -07003366 return send_break(tty, 250);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003367 return 0;
3368 case TCSBRKP: /* support for POSIX tcsendbreak() */
Domen Puncerb20f3ae2005-06-25 14:58:42 -07003369 return send_break(tty, arg ? arg*100 : 250);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003370
3371 case TIOCMGET:
3372 return tty_tiocmget(tty, file, p);
3373
3374 case TIOCMSET:
3375 case TIOCMBIC:
3376 case TIOCMBIS:
3377 return tty_tiocmset(tty, file, cmd, p);
Paul Fulghumc5c34d42007-05-12 10:36:55 -07003378 case TCFLSH:
3379 switch (arg) {
3380 case TCIFLUSH:
3381 case TCIOFLUSH:
3382 /* flush tty buffer and allow ldisc to process ioctl */
3383 tty_buffer_flush(tty);
3384 break;
3385 }
3386 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003387 }
3388 if (tty->driver->ioctl) {
3389 retval = (tty->driver->ioctl)(tty, file, cmd, arg);
3390 if (retval != -ENOIOCTLCMD)
3391 return retval;
3392 }
3393 ld = tty_ldisc_ref_wait(tty);
3394 retval = -EINVAL;
3395 if (ld->ioctl) {
3396 retval = ld->ioctl(tty, file, cmd, arg);
3397 if (retval == -ENOIOCTLCMD)
3398 retval = -EINVAL;
3399 }
3400 tty_ldisc_deref(ld);
3401 return retval;
3402}
3403
Paul Fulghume10cc1d2007-05-10 22:22:50 -07003404#ifdef CONFIG_COMPAT
3405static long tty_compat_ioctl(struct file * file, unsigned int cmd,
3406 unsigned long arg)
3407{
3408 struct inode *inode = file->f_dentry->d_inode;
3409 struct tty_struct *tty = file->private_data;
3410 struct tty_ldisc *ld;
3411 int retval = -ENOIOCTLCMD;
3412
3413 if (tty_paranoia_check(tty, inode, "tty_ioctl"))
3414 return -EINVAL;
3415
3416 if (tty->driver->compat_ioctl) {
3417 retval = (tty->driver->compat_ioctl)(tty, file, cmd, arg);
3418 if (retval != -ENOIOCTLCMD)
3419 return retval;
3420 }
3421
3422 ld = tty_ldisc_ref_wait(tty);
3423 if (ld->compat_ioctl)
3424 retval = ld->compat_ioctl(tty, file, cmd, arg);
3425 tty_ldisc_deref(ld);
3426
3427 return retval;
3428}
3429#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07003430
3431/*
3432 * This implements the "Secure Attention Key" --- the idea is to
3433 * prevent trojan horses by killing all processes associated with this
3434 * tty when the user hits the "Secure Attention Key". Required for
3435 * super-paranoid applications --- see the Orange Book for more details.
3436 *
3437 * This code could be nicer; ideally it should send a HUP, wait a few
3438 * seconds, then send a INT, and then a KILL signal. But you then
3439 * have to coordinate with the init process, since all processes associated
3440 * with the current tty must be dead before the new getty is allowed
3441 * to spawn.
3442 *
3443 * Now, if it would be correct ;-/ The current code has a nasty hole -
3444 * it doesn't catch files in flight. We may send the descriptor to ourselves
3445 * via AF_UNIX socket, close it and later fetch from socket. FIXME.
3446 *
3447 * Nasty bug: do_SAK is being called in interrupt context. This can
3448 * deadlock. We punt it up to process context. AKPM - 16Mar2001
3449 */
Eric W. Biederman8b6312f2007-02-10 01:44:34 -08003450void __do_SAK(struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003451{
3452#ifdef TTY_SOFT_SAK
3453 tty_hangup(tty);
3454#else
Eric W. Biederman652486f2006-03-28 16:11:02 -08003455 struct task_struct *g, *p;
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08003456 struct pid *session;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003457 int i;
3458 struct file *filp;
Dipankar Sarmabadf1662005-09-09 13:04:10 -07003459 struct fdtable *fdt;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003460
3461 if (!tty)
3462 return;
Peter Zijlstra24ec8392006-12-08 02:36:04 -08003463 session = tty->session;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003464
Dan Carpenterb3f13de2006-12-13 00:35:09 -08003465 tty_ldisc_flush(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003466
3467 if (tty->driver->flush_buffer)
3468 tty->driver->flush_buffer(tty);
3469
3470 read_lock(&tasklist_lock);
Eric W. Biederman652486f2006-03-28 16:11:02 -08003471 /* Kill the entire session */
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08003472 do_each_pid_task(session, PIDTYPE_SID, p) {
Eric W. Biederman652486f2006-03-28 16:11:02 -08003473 printk(KERN_NOTICE "SAK: killed process %d"
Cedric Le Goater937949d2006-12-08 02:37:54 -08003474 " (%s): process_session(p)==tty->session\n",
Eric W. Biederman652486f2006-03-28 16:11:02 -08003475 p->pid, p->comm);
3476 send_sig(SIGKILL, p, 1);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08003477 } while_each_pid_task(session, PIDTYPE_SID, p);
Eric W. Biederman652486f2006-03-28 16:11:02 -08003478 /* Now kill any processes that happen to have the
3479 * tty open.
3480 */
3481 do_each_thread(g, p) {
3482 if (p->signal->tty == tty) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07003483 printk(KERN_NOTICE "SAK: killed process %d"
Cedric Le Goater937949d2006-12-08 02:37:54 -08003484 " (%s): process_session(p)==tty->session\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07003485 p->pid, p->comm);
3486 send_sig(SIGKILL, p, 1);
3487 continue;
3488 }
3489 task_lock(p);
3490 if (p->files) {
Dipankar Sarmaca99c1d2006-04-18 22:21:46 -07003491 /*
3492 * We don't take a ref to the file, so we must
3493 * hold ->file_lock instead.
3494 */
3495 spin_lock(&p->files->file_lock);
Dipankar Sarmabadf1662005-09-09 13:04:10 -07003496 fdt = files_fdtable(p->files);
3497 for (i=0; i < fdt->max_fds; i++) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07003498 filp = fcheck_files(p->files, i);
3499 if (!filp)
3500 continue;
3501 if (filp->f_op->read == tty_read &&
3502 filp->private_data == tty) {
3503 printk(KERN_NOTICE "SAK: killed process %d"
3504 " (%s): fd#%d opened to the tty\n",
3505 p->pid, p->comm, i);
Eric W. Biederman20ac9432006-04-13 04:49:07 -06003506 force_sig(SIGKILL, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003507 break;
3508 }
3509 }
Dipankar Sarmaca99c1d2006-04-18 22:21:46 -07003510 spin_unlock(&p->files->file_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003511 }
3512 task_unlock(p);
Eric W. Biederman652486f2006-03-28 16:11:02 -08003513 } while_each_thread(g, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003514 read_unlock(&tasklist_lock);
3515#endif
3516}
3517
Eric W. Biederman8b6312f2007-02-10 01:44:34 -08003518static void do_SAK_work(struct work_struct *work)
3519{
3520 struct tty_struct *tty =
3521 container_of(work, struct tty_struct, SAK_work);
3522 __do_SAK(tty);
3523}
3524
Linus Torvalds1da177e2005-04-16 15:20:36 -07003525/*
3526 * The tq handling here is a little racy - tty->SAK_work may already be queued.
3527 * Fortunately we don't need to worry, because if ->SAK_work is already queued,
3528 * the values which we write to it will be identical to the values which it
3529 * already has. --akpm
3530 */
3531void do_SAK(struct tty_struct *tty)
3532{
3533 if (!tty)
3534 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003535 schedule_work(&tty->SAK_work);
3536}
3537
3538EXPORT_SYMBOL(do_SAK);
3539
Alan Coxaf9b8972006-08-27 01:24:01 -07003540/**
3541 * flush_to_ldisc
David Howells65f27f32006-11-22 14:55:48 +00003542 * @work: tty structure passed from work queue.
Alan Coxaf9b8972006-08-27 01:24:01 -07003543 *
3544 * This routine is called out of the software interrupt to flush data
3545 * from the buffer chain to the line discipline.
3546 *
3547 * Locking: holds tty->buf.lock to guard buffer list. Drops the lock
3548 * while invoking the line discipline receive_buf method. The
3549 * receive_buf method is single threaded for each tty instance.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003550 */
3551
David Howells65f27f32006-11-22 14:55:48 +00003552static void flush_to_ldisc(struct work_struct *work)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003553{
David Howells65f27f32006-11-22 14:55:48 +00003554 struct tty_struct *tty =
3555 container_of(work, struct tty_struct, buf.work.work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003556 unsigned long flags;
3557 struct tty_ldisc *disc;
Paul Fulghum2c3bb202006-06-28 04:26:48 -07003558 struct tty_buffer *tbuf, *head;
Paul Fulghum8977d922006-02-10 01:51:14 -08003559 char *char_buf;
3560 unsigned char *flag_buf;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003561
3562 disc = tty_ldisc_ref(tty);
3563 if (disc == NULL) /* !TTY_LDISC */
3564 return;
3565
Paul Fulghum808249c2006-02-03 03:04:41 -08003566 spin_lock_irqsave(&tty->buf.lock, flags);
Paul Fulghum2c3bb202006-06-28 04:26:48 -07003567 head = tty->buf.head;
3568 if (head != NULL) {
3569 tty->buf.head = NULL;
3570 for (;;) {
3571 int count = head->commit - head->read;
3572 if (!count) {
3573 if (head->next == NULL)
3574 break;
3575 tbuf = head;
3576 head = head->next;
3577 tty_buffer_free(tty, tbuf);
3578 continue;
3579 }
3580 if (!tty->receive_room) {
3581 schedule_delayed_work(&tty->buf.work, 1);
3582 break;
3583 }
3584 if (count > tty->receive_room)
3585 count = tty->receive_room;
3586 char_buf = head->char_buf_ptr + head->read;
3587 flag_buf = head->flag_buf_ptr + head->read;
3588 head->read += count;
Paul Fulghum8977d922006-02-10 01:51:14 -08003589 spin_unlock_irqrestore(&tty->buf.lock, flags);
3590 disc->receive_buf(tty, char_buf, flag_buf, count);
3591 spin_lock_irqsave(&tty->buf.lock, flags);
3592 }
Paul Fulghum2c3bb202006-06-28 04:26:48 -07003593 tty->buf.head = head;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003594 }
Paul Fulghum808249c2006-02-03 03:04:41 -08003595 spin_unlock_irqrestore(&tty->buf.lock, flags);
Paul Fulghum817d6d32006-06-28 04:26:47 -07003596
Linus Torvalds1da177e2005-04-16 15:20:36 -07003597 tty_ldisc_deref(disc);
3598}
3599
Linus Torvalds1da177e2005-04-16 15:20:36 -07003600/**
3601 * tty_flip_buffer_push - terminal
3602 * @tty: tty to push
3603 *
3604 * Queue a push of the terminal flip buffers to the line discipline. This
3605 * function must not be called from IRQ context if tty->low_latency is set.
3606 *
3607 * In the event of the queue being busy for flipping the work will be
3608 * held off and retried later.
Alan Coxaf9b8972006-08-27 01:24:01 -07003609 *
3610 * Locking: tty buffer lock. Driver locks in low latency mode.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003611 */
3612
3613void tty_flip_buffer_push(struct tty_struct *tty)
3614{
Paul Fulghum808249c2006-02-03 03:04:41 -08003615 unsigned long flags;
3616 spin_lock_irqsave(&tty->buf.lock, flags);
Paul Fulghum33b37a32006-06-28 04:26:49 -07003617 if (tty->buf.tail != NULL)
Paul Fulghum8977d922006-02-10 01:51:14 -08003618 tty->buf.tail->commit = tty->buf.tail->used;
Paul Fulghum808249c2006-02-03 03:04:41 -08003619 spin_unlock_irqrestore(&tty->buf.lock, flags);
3620
Linus Torvalds1da177e2005-04-16 15:20:36 -07003621 if (tty->low_latency)
David Howells65f27f32006-11-22 14:55:48 +00003622 flush_to_ldisc(&tty->buf.work.work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003623 else
Alan Cox33f0f882006-01-09 20:54:13 -08003624 schedule_delayed_work(&tty->buf.work, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003625}
3626
3627EXPORT_SYMBOL(tty_flip_buffer_push);
3628
Alan Cox33f0f882006-01-09 20:54:13 -08003629
Alan Coxaf9b8972006-08-27 01:24:01 -07003630/**
3631 * initialize_tty_struct
3632 * @tty: tty to initialize
3633 *
3634 * This subroutine initializes a tty structure that has been newly
3635 * allocated.
3636 *
3637 * Locking: none - tty in question must not be exposed at this point
Linus Torvalds1da177e2005-04-16 15:20:36 -07003638 */
Alan Coxaf9b8972006-08-27 01:24:01 -07003639
Linus Torvalds1da177e2005-04-16 15:20:36 -07003640static void initialize_tty_struct(struct tty_struct *tty)
3641{
3642 memset(tty, 0, sizeof(struct tty_struct));
3643 tty->magic = TTY_MAGIC;
3644 tty_ldisc_assign(tty, tty_ldisc_get(N_TTY));
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08003645 tty->session = NULL;
3646 tty->pgrp = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003647 tty->overrun_time = jiffies;
Alan Cox33f0f882006-01-09 20:54:13 -08003648 tty->buf.head = tty->buf.tail = NULL;
3649 tty_buffer_init(tty);
David Howells65f27f32006-11-22 14:55:48 +00003650 INIT_DELAYED_WORK(&tty->buf.work, flush_to_ldisc);
Alan Cox33f0f882006-01-09 20:54:13 -08003651 init_MUTEX(&tty->buf.pty_sem);
Arjan van de Ven5785c952006-09-29 02:00:43 -07003652 mutex_init(&tty->termios_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003653 init_waitqueue_head(&tty->write_wait);
3654 init_waitqueue_head(&tty->read_wait);
David Howells65f27f32006-11-22 14:55:48 +00003655 INIT_WORK(&tty->hangup_work, do_tty_hangup);
Ingo Molnar70522e12006-03-23 03:00:31 -08003656 mutex_init(&tty->atomic_read_lock);
3657 mutex_init(&tty->atomic_write_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003658 spin_lock_init(&tty->read_lock);
3659 INIT_LIST_HEAD(&tty->tty_files);
Eric W. Biederman7f1f86a2007-02-13 14:38:58 -07003660 INIT_WORK(&tty->SAK_work, do_SAK_work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003661}
3662
3663/*
3664 * The default put_char routine if the driver did not define one.
3665 */
Alan Coxaf9b8972006-08-27 01:24:01 -07003666
Linus Torvalds1da177e2005-04-16 15:20:36 -07003667static void tty_default_put_char(struct tty_struct *tty, unsigned char ch)
3668{
3669 tty->driver->write(tty, &ch, 1);
3670}
3671
gregkh@suse.de7fe845d2005-03-15 14:23:15 -08003672static struct class *tty_class;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003673
3674/**
Alan Coxaf9b8972006-08-27 01:24:01 -07003675 * tty_register_device - register a tty device
3676 * @driver: the tty driver that describes the tty device
3677 * @index: the index in the tty driver for this tty device
3678 * @device: a struct device that is associated with this tty device.
3679 * This field is optional, if there is no known struct device
3680 * for this tty device it can be set to NULL safely.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003681 *
Greg Kroah-Hartman01107d32006-08-07 22:19:37 -07003682 * Returns a pointer to the struct device for this tty device
3683 * (or ERR_PTR(-EFOO) on error).
Hansjoerg Lipp1cdcb6b2006-04-22 18:36:53 +02003684 *
Alan Coxaf9b8972006-08-27 01:24:01 -07003685 * This call is required to be made to register an individual tty device
3686 * if the tty driver's flags have the TTY_DRIVER_DYNAMIC_DEV bit set. If
3687 * that bit is not set, this function should not be called by a tty
3688 * driver.
3689 *
3690 * Locking: ??
Linus Torvalds1da177e2005-04-16 15:20:36 -07003691 */
Alan Coxaf9b8972006-08-27 01:24:01 -07003692
Greg Kroah-Hartman01107d32006-08-07 22:19:37 -07003693struct device *tty_register_device(struct tty_driver *driver, unsigned index,
3694 struct device *device)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003695{
3696 char name[64];
3697 dev_t dev = MKDEV(driver->major, driver->minor_start) + index;
3698
3699 if (index >= driver->num) {
3700 printk(KERN_ERR "Attempt to register invalid tty line number "
3701 " (%d).\n", index);
Hansjoerg Lipp1cdcb6b2006-04-22 18:36:53 +02003702 return ERR_PTR(-EINVAL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003703 }
3704
Linus Torvalds1da177e2005-04-16 15:20:36 -07003705 if (driver->type == TTY_DRIVER_TYPE_PTY)
3706 pty_line_name(driver, index, name);
3707 else
3708 tty_line_name(driver, index, name);
Hansjoerg Lipp1cdcb6b2006-04-22 18:36:53 +02003709
Greg Kroah-Hartman01107d32006-08-07 22:19:37 -07003710 return device_create(tty_class, device, dev, name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003711}
3712
3713/**
Alan Coxaf9b8972006-08-27 01:24:01 -07003714 * tty_unregister_device - unregister a tty device
3715 * @driver: the tty driver that describes the tty device
3716 * @index: the index in the tty driver for this tty device
Linus Torvalds1da177e2005-04-16 15:20:36 -07003717 *
Alan Coxaf9b8972006-08-27 01:24:01 -07003718 * If a tty device is registered with a call to tty_register_device() then
3719 * this function must be called when the tty device is gone.
3720 *
3721 * Locking: ??
Linus Torvalds1da177e2005-04-16 15:20:36 -07003722 */
Alan Coxaf9b8972006-08-27 01:24:01 -07003723
Linus Torvalds1da177e2005-04-16 15:20:36 -07003724void tty_unregister_device(struct tty_driver *driver, unsigned index)
3725{
Greg Kroah-Hartman01107d32006-08-07 22:19:37 -07003726 device_destroy(tty_class, MKDEV(driver->major, driver->minor_start) + index);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003727}
3728
3729EXPORT_SYMBOL(tty_register_device);
3730EXPORT_SYMBOL(tty_unregister_device);
3731
3732struct tty_driver *alloc_tty_driver(int lines)
3733{
3734 struct tty_driver *driver;
3735
3736 driver = kmalloc(sizeof(struct tty_driver), GFP_KERNEL);
3737 if (driver) {
3738 memset(driver, 0, sizeof(struct tty_driver));
3739 driver->magic = TTY_DRIVER_MAGIC;
3740 driver->num = lines;
3741 /* later we'll move allocation of tables here */
3742 }
3743 return driver;
3744}
3745
3746void put_tty_driver(struct tty_driver *driver)
3747{
3748 kfree(driver);
3749}
3750
Jeff Dikeb68e31d2006-10-02 02:17:18 -07003751void tty_set_operations(struct tty_driver *driver,
3752 const struct tty_operations *op)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003753{
3754 driver->open = op->open;
3755 driver->close = op->close;
3756 driver->write = op->write;
3757 driver->put_char = op->put_char;
3758 driver->flush_chars = op->flush_chars;
3759 driver->write_room = op->write_room;
3760 driver->chars_in_buffer = op->chars_in_buffer;
3761 driver->ioctl = op->ioctl;
Paul Fulghume10cc1d2007-05-10 22:22:50 -07003762 driver->compat_ioctl = op->compat_ioctl;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003763 driver->set_termios = op->set_termios;
3764 driver->throttle = op->throttle;
3765 driver->unthrottle = op->unthrottle;
3766 driver->stop = op->stop;
3767 driver->start = op->start;
3768 driver->hangup = op->hangup;
3769 driver->break_ctl = op->break_ctl;
3770 driver->flush_buffer = op->flush_buffer;
3771 driver->set_ldisc = op->set_ldisc;
3772 driver->wait_until_sent = op->wait_until_sent;
3773 driver->send_xchar = op->send_xchar;
3774 driver->read_proc = op->read_proc;
3775 driver->write_proc = op->write_proc;
3776 driver->tiocmget = op->tiocmget;
3777 driver->tiocmset = op->tiocmset;
3778}
3779
3780
3781EXPORT_SYMBOL(alloc_tty_driver);
3782EXPORT_SYMBOL(put_tty_driver);
3783EXPORT_SYMBOL(tty_set_operations);
3784
3785/*
3786 * Called by a tty driver to register itself.
3787 */
3788int tty_register_driver(struct tty_driver *driver)
3789{
3790 int error;
3791 int i;
3792 dev_t dev;
3793 void **p = NULL;
3794
3795 if (driver->flags & TTY_DRIVER_INSTALLED)
3796 return 0;
3797
Andy Whitcroft543691a62007-05-06 14:49:33 -07003798 if (!(driver->flags & TTY_DRIVER_DEVPTS_MEM) && driver->num) {
3799 p = kzalloc(driver->num * 3 * sizeof(void *), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003800 if (!p)
3801 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003802 }
3803
3804 if (!driver->major) {
3805 error = alloc_chrdev_region(&dev, driver->minor_start, driver->num,
Geert Uytterhoevene5717c42007-02-20 15:45:21 +01003806 driver->name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003807 if (!error) {
3808 driver->major = MAJOR(dev);
3809 driver->minor_start = MINOR(dev);
3810 }
3811 } else {
3812 dev = MKDEV(driver->major, driver->minor_start);
Geert Uytterhoevene5717c42007-02-20 15:45:21 +01003813 error = register_chrdev_region(dev, driver->num, driver->name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003814 }
3815 if (error < 0) {
3816 kfree(p);
3817 return error;
3818 }
3819
3820 if (p) {
3821 driver->ttys = (struct tty_struct **)p;
Alan Coxedc6afc2006-12-08 02:38:44 -08003822 driver->termios = (struct ktermios **)(p + driver->num);
3823 driver->termios_locked = (struct ktermios **)(p + driver->num * 2);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003824 } else {
3825 driver->ttys = NULL;
3826 driver->termios = NULL;
3827 driver->termios_locked = NULL;
3828 }
3829
3830 cdev_init(&driver->cdev, &tty_fops);
3831 driver->cdev.owner = driver->owner;
3832 error = cdev_add(&driver->cdev, dev, driver->num);
3833 if (error) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07003834 unregister_chrdev_region(dev, driver->num);
3835 driver->ttys = NULL;
3836 driver->termios = driver->termios_locked = NULL;
3837 kfree(p);
3838 return error;
3839 }
3840
3841 if (!driver->put_char)
3842 driver->put_char = tty_default_put_char;
3843
Alexey Dobriyanca509f62007-05-08 00:27:12 -07003844 mutex_lock(&tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003845 list_add(&driver->tty_drivers, &tty_drivers);
Alexey Dobriyanca509f62007-05-08 00:27:12 -07003846 mutex_unlock(&tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003847
Greg Kroah-Hartman331b8312005-06-20 21:15:16 -07003848 if ( !(driver->flags & TTY_DRIVER_DYNAMIC_DEV) ) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07003849 for(i = 0; i < driver->num; i++)
3850 tty_register_device(driver, i, NULL);
3851 }
3852 proc_tty_register_driver(driver);
3853 return 0;
3854}
3855
3856EXPORT_SYMBOL(tty_register_driver);
3857
3858/*
3859 * Called by a tty driver to unregister itself.
3860 */
3861int tty_unregister_driver(struct tty_driver *driver)
3862{
3863 int i;
Alan Coxedc6afc2006-12-08 02:38:44 -08003864 struct ktermios *tp;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003865 void *p;
3866
3867 if (driver->refcount)
3868 return -EBUSY;
3869
3870 unregister_chrdev_region(MKDEV(driver->major, driver->minor_start),
3871 driver->num);
Alexey Dobriyanca509f62007-05-08 00:27:12 -07003872 mutex_lock(&tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003873 list_del(&driver->tty_drivers);
Alexey Dobriyanca509f62007-05-08 00:27:12 -07003874 mutex_unlock(&tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003875
3876 /*
3877 * Free the termios and termios_locked structures because
3878 * we don't want to get memory leaks when modular tty
3879 * drivers are removed from the kernel.
3880 */
3881 for (i = 0; i < driver->num; i++) {
3882 tp = driver->termios[i];
3883 if (tp) {
3884 driver->termios[i] = NULL;
3885 kfree(tp);
3886 }
3887 tp = driver->termios_locked[i];
3888 if (tp) {
3889 driver->termios_locked[i] = NULL;
3890 kfree(tp);
3891 }
Greg Kroah-Hartman331b8312005-06-20 21:15:16 -07003892 if (!(driver->flags & TTY_DRIVER_DYNAMIC_DEV))
Linus Torvalds1da177e2005-04-16 15:20:36 -07003893 tty_unregister_device(driver, i);
3894 }
3895 p = driver->ttys;
3896 proc_tty_unregister_driver(driver);
3897 driver->ttys = NULL;
3898 driver->termios = driver->termios_locked = NULL;
3899 kfree(p);
3900 cdev_del(&driver->cdev);
3901 return 0;
3902}
Linus Torvalds1da177e2005-04-16 15:20:36 -07003903EXPORT_SYMBOL(tty_unregister_driver);
3904
Peter Zijlstra24ec8392006-12-08 02:36:04 -08003905dev_t tty_devnum(struct tty_struct *tty)
3906{
3907 return MKDEV(tty->driver->major, tty->driver->minor_start) + tty->index;
3908}
3909EXPORT_SYMBOL(tty_devnum);
3910
3911void proc_clear_tty(struct task_struct *p)
3912{
3913 spin_lock_irq(&p->sighand->siglock);
3914 p->signal->tty = NULL;
3915 spin_unlock_irq(&p->sighand->siglock);
3916}
David S. Miller7cac4ce2007-05-11 14:30:57 -07003917EXPORT_SYMBOL(proc_clear_tty);
Peter Zijlstra24ec8392006-12-08 02:36:04 -08003918
Eric W. Biederman2a65f1d2007-05-08 00:26:53 -07003919static void __proc_set_tty(struct task_struct *tsk, struct tty_struct *tty)
Peter Zijlstra24ec8392006-12-08 02:36:04 -08003920{
3921 if (tty) {
Eric W. Biedermand9c1e9a2007-03-18 12:45:44 -06003922 /* We should not have a session or pgrp to here but.... */
3923 put_pid(tty->session);
3924 put_pid(tty->pgrp);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08003925 tty->session = get_pid(task_session(tsk));
3926 tty->pgrp = get_pid(task_pgrp(tsk));
Peter Zijlstra24ec8392006-12-08 02:36:04 -08003927 }
Eric W. Biederman2a65f1d2007-05-08 00:26:53 -07003928 put_pid(tsk->signal->tty_old_pgrp);
Peter Zijlstra24ec8392006-12-08 02:36:04 -08003929 tsk->signal->tty = tty;
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08003930 tsk->signal->tty_old_pgrp = NULL;
Peter Zijlstra24ec8392006-12-08 02:36:04 -08003931}
3932
Eric W. Biederman98a27ba2007-05-08 00:26:56 -07003933static void proc_set_tty(struct task_struct *tsk, struct tty_struct *tty)
Peter Zijlstra24ec8392006-12-08 02:36:04 -08003934{
3935 spin_lock_irq(&tsk->sighand->siglock);
Eric W. Biederman2a65f1d2007-05-08 00:26:53 -07003936 __proc_set_tty(tsk, tty);
Peter Zijlstra24ec8392006-12-08 02:36:04 -08003937 spin_unlock_irq(&tsk->sighand->siglock);
3938}
3939
3940struct tty_struct *get_current_tty(void)
3941{
3942 struct tty_struct *tty;
3943 WARN_ON_ONCE(!mutex_is_locked(&tty_mutex));
3944 tty = current->signal->tty;
3945 /*
3946 * session->tty can be changed/cleared from under us, make sure we
3947 * issue the load. The obtained pointer, when not NULL, is valid as
3948 * long as we hold tty_mutex.
3949 */
3950 barrier();
3951 return tty;
3952}
Heiko Carstensa311f742006-12-13 00:33:41 -08003953EXPORT_SYMBOL_GPL(get_current_tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003954
3955/*
3956 * Initialize the console device. This is called *early*, so
3957 * we can't necessarily depend on lots of kernel help here.
3958 * Just do some early initializations, and do the complex setup
3959 * later.
3960 */
3961void __init console_init(void)
3962{
3963 initcall_t *call;
3964
3965 /* Setup the default TTY line discipline. */
3966 (void) tty_register_ldisc(N_TTY, &tty_ldisc_N_TTY);
3967
3968 /*
3969 * set up the console device so that later boot sequences can
3970 * inform about problems etc..
3971 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003972 call = __con_initcall_start;
3973 while (call < __con_initcall_end) {
3974 (*call)();
3975 call++;
3976 }
3977}
3978
3979#ifdef CONFIG_VT
3980extern int vty_init(void);
3981#endif
3982
3983static int __init tty_class_init(void)
3984{
gregkh@suse.de7fe845d2005-03-15 14:23:15 -08003985 tty_class = class_create(THIS_MODULE, "tty");
Linus Torvalds1da177e2005-04-16 15:20:36 -07003986 if (IS_ERR(tty_class))
3987 return PTR_ERR(tty_class);
3988 return 0;
3989}
3990
3991postcore_initcall(tty_class_init);
3992
3993/* 3/2004 jmc: why do these devices exist? */
3994
3995static struct cdev tty_cdev, console_cdev;
3996#ifdef CONFIG_UNIX98_PTYS
3997static struct cdev ptmx_cdev;
3998#endif
3999#ifdef CONFIG_VT
4000static struct cdev vc0_cdev;
4001#endif
4002
4003/*
4004 * Ok, now we can initialize the rest of the tty devices and can count
4005 * on memory allocations, interrupts etc..
4006 */
4007static int __init tty_init(void)
4008{
4009 cdev_init(&tty_cdev, &tty_fops);
4010 if (cdev_add(&tty_cdev, MKDEV(TTYAUX_MAJOR, 0), 1) ||
4011 register_chrdev_region(MKDEV(TTYAUX_MAJOR, 0), 1, "/dev/tty") < 0)
4012 panic("Couldn't register /dev/tty driver\n");
Greg Kroah-Hartman01107d32006-08-07 22:19:37 -07004013 device_create(tty_class, NULL, MKDEV(TTYAUX_MAJOR, 0), "tty");
Linus Torvalds1da177e2005-04-16 15:20:36 -07004014
4015 cdev_init(&console_cdev, &console_fops);
4016 if (cdev_add(&console_cdev, MKDEV(TTYAUX_MAJOR, 1), 1) ||
4017 register_chrdev_region(MKDEV(TTYAUX_MAJOR, 1), 1, "/dev/console") < 0)
4018 panic("Couldn't register /dev/console driver\n");
Greg Kroah-Hartman01107d32006-08-07 22:19:37 -07004019 device_create(tty_class, NULL, MKDEV(TTYAUX_MAJOR, 1), "console");
Linus Torvalds1da177e2005-04-16 15:20:36 -07004020
4021#ifdef CONFIG_UNIX98_PTYS
4022 cdev_init(&ptmx_cdev, &ptmx_fops);
4023 if (cdev_add(&ptmx_cdev, MKDEV(TTYAUX_MAJOR, 2), 1) ||
4024 register_chrdev_region(MKDEV(TTYAUX_MAJOR, 2), 1, "/dev/ptmx") < 0)
4025 panic("Couldn't register /dev/ptmx driver\n");
Greg Kroah-Hartman01107d32006-08-07 22:19:37 -07004026 device_create(tty_class, NULL, MKDEV(TTYAUX_MAJOR, 2), "ptmx");
Linus Torvalds1da177e2005-04-16 15:20:36 -07004027#endif
4028
4029#ifdef CONFIG_VT
4030 cdev_init(&vc0_cdev, &console_fops);
4031 if (cdev_add(&vc0_cdev, MKDEV(TTY_MAJOR, 0), 1) ||
4032 register_chrdev_region(MKDEV(TTY_MAJOR, 0), 1, "/dev/vc/0") < 0)
4033 panic("Couldn't register /dev/tty0 driver\n");
Greg Kroah-Hartman01107d32006-08-07 22:19:37 -07004034 device_create(tty_class, NULL, MKDEV(TTY_MAJOR, 0), "tty0");
Linus Torvalds1da177e2005-04-16 15:20:36 -07004035
4036 vty_init();
4037#endif
4038 return 0;
4039}
4040module_init(tty_init);