[PATCH] Char: tty, delete wake_up_interruptible after tty_wakeup
[powerpc.git] / drivers / char / tty_io.c
1 /*
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
68 #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>
96 #include <linux/delay.h>
97
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>
104
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
112 struct ktermios tty_std_termios = {     /* for the benefit of tty drivers  */
113         .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,
118         .c_cc = INIT_C_CC,
119         .c_ispeed = 38400,
120         .c_ospeed = 38400
121 };
122
123 EXPORT_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    
129 LIST_HEAD(tty_drivers);                 /* linked list of tty drivers */
130
131 /* Mutex to protect creating and releasing a tty. This is shared with
132    vt.c for deeply disgusting hack reasons */
133 DEFINE_MUTEX(tty_mutex);
134 EXPORT_SYMBOL(tty_mutex);
135
136 #ifdef CONFIG_UNIX98_PTYS
137 extern struct tty_driver *ptm_driver;   /* Unix98 pty masters; for /dev/ptmx */
138 extern int pty_limit;           /* Config limit on Unix98 ptys */
139 static DEFINE_IDR(allocated_ptys);
140 static DECLARE_MUTEX(allocated_ptys_lock);
141 static int ptmx_open(struct inode *, struct file *);
142 #endif
143
144 extern void disable_early_printk(void);
145
146 static void initialize_tty_struct(struct tty_struct *tty);
147
148 static ssize_t tty_read(struct file *, char __user *, size_t, loff_t *);
149 static ssize_t tty_write(struct file *, const char __user *, size_t, loff_t *);
150 ssize_t redirected_tty_write(struct file *, const char __user *, size_t, loff_t *);
151 static unsigned int tty_poll(struct file *, poll_table *);
152 static int tty_open(struct inode *, struct file *);
153 static int tty_release(struct inode *, struct file *);
154 int tty_ioctl(struct inode * inode, struct file * file,
155               unsigned int cmd, unsigned long arg);
156 static int tty_fasync(int fd, struct file * filp, int on);
157 static void release_mem(struct tty_struct *tty, int idx);
158
159 /**
160  *      alloc_tty_struct        -       allocate a tty object
161  *
162  *      Return a new empty tty structure. The data fields have not
163  *      been initialized in any way but has been zeroed
164  *
165  *      Locking: none
166  */
167
168 static struct tty_struct *alloc_tty_struct(void)
169 {
170         return kzalloc(sizeof(struct tty_struct), GFP_KERNEL);
171 }
172
173 static void tty_buffer_free_all(struct tty_struct *);
174
175 /**
176  *      free_tty_struct         -       free a disused tty
177  *      @tty: tty struct to free
178  *
179  *      Free the write buffers, tty queue and tty memory itself.
180  *
181  *      Locking: none. Must be called after tty is definitely unused
182  */
183
184 static inline void free_tty_struct(struct tty_struct *tty)
185 {
186         kfree(tty->write_buf);
187         tty_buffer_free_all(tty);
188         kfree(tty);
189 }
190
191 #define TTY_NUMBER(tty) ((tty)->index + (tty)->driver->name_base)
192
193 /**
194  *      tty_name        -       return tty naming
195  *      @tty: tty structure
196  *      @buf: buffer for output
197  *
198  *      Convert a tty structure into a name. The name reflects the kernel
199  *      naming policy and if udev is in use may not reflect user space
200  *
201  *      Locking: none
202  */
203
204 char *tty_name(struct tty_struct *tty, char *buf)
205 {
206         if (!tty) /* Hmm.  NULL pointer.  That's fun. */
207                 strcpy(buf, "NULL tty");
208         else
209                 strcpy(buf, tty->name);
210         return buf;
211 }
212
213 EXPORT_SYMBOL(tty_name);
214
215 int tty_paranoia_check(struct tty_struct *tty, struct inode *inode,
216                               const char *routine)
217 {
218 #ifdef TTY_PARANOIA_CHECK
219         if (!tty) {
220                 printk(KERN_WARNING
221                         "null TTY for (%d:%d) in %s\n",
222                         imajor(inode), iminor(inode), routine);
223                 return 1;
224         }
225         if (tty->magic != TTY_MAGIC) {
226                 printk(KERN_WARNING
227                         "bad magic number for tty struct (%d:%d) in %s\n",
228                         imajor(inode), iminor(inode), routine);
229                 return 1;
230         }
231 #endif
232         return 0;
233 }
234
235 static int check_tty_count(struct tty_struct *tty, const char *routine)
236 {
237 #ifdef CHECK_TTY_COUNT
238         struct list_head *p;
239         int count = 0;
240         
241         file_list_lock();
242         list_for_each(p, &tty->tty_files) {
243                 count++;
244         }
245         file_list_unlock();
246         if (tty->driver->type == TTY_DRIVER_TYPE_PTY &&
247             tty->driver->subtype == PTY_TYPE_SLAVE &&
248             tty->link && tty->link->count)
249                 count++;
250         if (tty->count != count) {
251                 printk(KERN_WARNING "Warning: dev (%s) tty->count(%d) "
252                                     "!= #fd's(%d) in %s\n",
253                        tty->name, tty->count, count, routine);
254                 return count;
255         }
256 #endif
257         return 0;
258 }
259
260 /*
261  * Tty buffer allocation management
262  */
263
264 /**
265  *      tty_buffer_free_all             -       free buffers used by a tty
266  *      @tty: tty to free from
267  *
268  *      Remove all the buffers pending on a tty whether queued with data
269  *      or in the free ring. Must be called when the tty is no longer in use
270  *
271  *      Locking: none
272  */
273
274 static void tty_buffer_free_all(struct tty_struct *tty)
275 {
276         struct tty_buffer *thead;
277         while((thead = tty->buf.head) != NULL) {
278                 tty->buf.head = thead->next;
279                 kfree(thead);
280         }
281         while((thead = tty->buf.free) != NULL) {
282                 tty->buf.free = thead->next;
283                 kfree(thead);
284         }
285         tty->buf.tail = NULL;
286         tty->buf.memory_used = 0;
287 }
288
289 /**
290  *      tty_buffer_init         -       prepare a tty buffer structure
291  *      @tty: tty to initialise
292  *
293  *      Set up the initial state of the buffer management for a tty device.
294  *      Must be called before the other tty buffer functions are used.
295  *
296  *      Locking: none
297  */
298
299 static void tty_buffer_init(struct tty_struct *tty)
300 {
301         spin_lock_init(&tty->buf.lock);
302         tty->buf.head = NULL;
303         tty->buf.tail = NULL;
304         tty->buf.free = NULL;
305         tty->buf.memory_used = 0;
306 }
307
308 /**
309  *      tty_buffer_alloc        -       allocate a tty buffer
310  *      @tty: tty device
311  *      @size: desired size (characters)
312  *
313  *      Allocate a new tty buffer to hold the desired number of characters.
314  *      Return NULL if out of memory or the allocation would exceed the
315  *      per device queue
316  *
317  *      Locking: Caller must hold tty->buf.lock
318  */
319
320 static struct tty_buffer *tty_buffer_alloc(struct tty_struct *tty, size_t size)
321 {
322         struct tty_buffer *p;
323
324         if (tty->buf.memory_used + size > 65536)
325                 return NULL;
326         p = kmalloc(sizeof(struct tty_buffer) + 2 * size, GFP_ATOMIC);
327         if(p == NULL)
328                 return NULL;
329         p->used = 0;
330         p->size = size;
331         p->next = NULL;
332         p->commit = 0;
333         p->read = 0;
334         p->char_buf_ptr = (char *)(p->data);
335         p->flag_buf_ptr = (unsigned char *)p->char_buf_ptr + size;
336         tty->buf.memory_used += size;
337         return p;
338 }
339
340 /**
341  *      tty_buffer_free         -       free a tty buffer
342  *      @tty: tty owning the buffer
343  *      @b: the buffer to free
344  *
345  *      Free a tty buffer, or add it to the free list according to our
346  *      internal strategy
347  *
348  *      Locking: Caller must hold tty->buf.lock
349  */
350
351 static void tty_buffer_free(struct tty_struct *tty, struct tty_buffer *b)
352 {
353         /* Dumb strategy for now - should keep some stats */
354         tty->buf.memory_used -= b->size;
355         WARN_ON(tty->buf.memory_used < 0);
356
357         if(b->size >= 512)
358                 kfree(b);
359         else {
360                 b->next = tty->buf.free;
361                 tty->buf.free = b;
362         }
363 }
364
365 /**
366  *      tty_buffer_find         -       find a free tty buffer
367  *      @tty: tty owning the buffer
368  *      @size: characters wanted
369  *
370  *      Locate an existing suitable tty buffer or if we are lacking one then
371  *      allocate a new one. We round our buffers off in 256 character chunks
372  *      to get better allocation behaviour.
373  *
374  *      Locking: Caller must hold tty->buf.lock
375  */
376
377 static struct tty_buffer *tty_buffer_find(struct tty_struct *tty, size_t size)
378 {
379         struct tty_buffer **tbh = &tty->buf.free;
380         while((*tbh) != NULL) {
381                 struct tty_buffer *t = *tbh;
382                 if(t->size >= size) {
383                         *tbh = t->next;
384                         t->next = NULL;
385                         t->used = 0;
386                         t->commit = 0;
387                         t->read = 0;
388                         tty->buf.memory_used += t->size;
389                         return t;
390                 }
391                 tbh = &((*tbh)->next);
392         }
393         /* Round the buffer size out */
394         size = (size + 0xFF) & ~ 0xFF;
395         return tty_buffer_alloc(tty, size);
396         /* Should possibly check if this fails for the largest buffer we
397            have queued and recycle that ? */
398 }
399
400 /**
401  *      tty_buffer_request_room         -       grow tty buffer if needed
402  *      @tty: tty structure
403  *      @size: size desired
404  *
405  *      Make at least size bytes of linear space available for the tty
406  *      buffer. If we fail return the size we managed to find.
407  *
408  *      Locking: Takes tty->buf.lock
409  */
410 int tty_buffer_request_room(struct tty_struct *tty, size_t size)
411 {
412         struct tty_buffer *b, *n;
413         int left;
414         unsigned long flags;
415
416         spin_lock_irqsave(&tty->buf.lock, flags);
417
418         /* OPTIMISATION: We could keep a per tty "zero" sized buffer to
419            remove this conditional if its worth it. This would be invisible
420            to the callers */
421         if ((b = tty->buf.tail) != NULL)
422                 left = b->size - b->used;
423         else
424                 left = 0;
425
426         if (left < size) {
427                 /* This is the slow path - looking for new buffers to use */
428                 if ((n = tty_buffer_find(tty, size)) != NULL) {
429                         if (b != NULL) {
430                                 b->next = n;
431                                 b->commit = b->used;
432                         } else
433                                 tty->buf.head = n;
434                         tty->buf.tail = n;
435                 } else
436                         size = left;
437         }
438
439         spin_unlock_irqrestore(&tty->buf.lock, flags);
440         return size;
441 }
442 EXPORT_SYMBOL_GPL(tty_buffer_request_room);
443
444 /**
445  *      tty_insert_flip_string  -       Add characters to the tty buffer
446  *      @tty: tty structure
447  *      @chars: characters
448  *      @size: size
449  *
450  *      Queue a series of bytes to the tty buffering. All the characters
451  *      passed are marked as without error. Returns the number added.
452  *
453  *      Locking: Called functions may take tty->buf.lock
454  */
455
456 int tty_insert_flip_string(struct tty_struct *tty, const unsigned char *chars,
457                                 size_t size)
458 {
459         int copied = 0;
460         do {
461                 int space = tty_buffer_request_room(tty, size - copied);
462                 struct tty_buffer *tb = tty->buf.tail;
463                 /* If there is no space then tb may be NULL */
464                 if(unlikely(space == 0))
465                         break;
466                 memcpy(tb->char_buf_ptr + tb->used, chars, space);
467                 memset(tb->flag_buf_ptr + tb->used, TTY_NORMAL, space);
468                 tb->used += space;
469                 copied += space;
470                 chars += space;
471                 /* There is a small chance that we need to split the data over
472                    several buffers. If this is the case we must loop */
473         } while (unlikely(size > copied));
474         return copied;
475 }
476 EXPORT_SYMBOL(tty_insert_flip_string);
477
478 /**
479  *      tty_insert_flip_string_flags    -       Add characters to the tty buffer
480  *      @tty: tty structure
481  *      @chars: characters
482  *      @flags: flag bytes
483  *      @size: size
484  *
485  *      Queue a series of bytes to the tty buffering. For each character
486  *      the flags array indicates the status of the character. Returns the
487  *      number added.
488  *
489  *      Locking: Called functions may take tty->buf.lock
490  */
491
492 int tty_insert_flip_string_flags(struct tty_struct *tty,
493                 const unsigned char *chars, const char *flags, size_t size)
494 {
495         int copied = 0;
496         do {
497                 int space = tty_buffer_request_room(tty, size - copied);
498                 struct tty_buffer *tb = tty->buf.tail;
499                 /* If there is no space then tb may be NULL */
500                 if(unlikely(space == 0))
501                         break;
502                 memcpy(tb->char_buf_ptr + tb->used, chars, space);
503                 memcpy(tb->flag_buf_ptr + tb->used, flags, space);
504                 tb->used += space;
505                 copied += space;
506                 chars += space;
507                 flags += space;
508                 /* There is a small chance that we need to split the data over
509                    several buffers. If this is the case we must loop */
510         } while (unlikely(size > copied));
511         return copied;
512 }
513 EXPORT_SYMBOL(tty_insert_flip_string_flags);
514
515 /**
516  *      tty_schedule_flip       -       push characters to ldisc
517  *      @tty: tty to push from
518  *
519  *      Takes any pending buffers and transfers their ownership to the
520  *      ldisc side of the queue. It then schedules those characters for
521  *      processing by the line discipline.
522  *
523  *      Locking: Takes tty->buf.lock
524  */
525
526 void tty_schedule_flip(struct tty_struct *tty)
527 {
528         unsigned long flags;
529         spin_lock_irqsave(&tty->buf.lock, flags);
530         if (tty->buf.tail != NULL)
531                 tty->buf.tail->commit = tty->buf.tail->used;
532         spin_unlock_irqrestore(&tty->buf.lock, flags);
533         schedule_delayed_work(&tty->buf.work, 1);
534 }
535 EXPORT_SYMBOL(tty_schedule_flip);
536
537 /**
538  *      tty_prepare_flip_string         -       make room for characters
539  *      @tty: tty
540  *      @chars: return pointer for character write area
541  *      @size: desired size
542  *
543  *      Prepare a block of space in the buffer for data. Returns the length
544  *      available and buffer pointer to the space which is now allocated and
545  *      accounted for as ready for normal characters. This is used for drivers
546  *      that need their own block copy routines into the buffer. There is no
547  *      guarantee the buffer is a DMA target!
548  *
549  *      Locking: May call functions taking tty->buf.lock
550  */
551
552 int tty_prepare_flip_string(struct tty_struct *tty, unsigned char **chars, size_t size)
553 {
554         int space = tty_buffer_request_room(tty, size);
555         if (likely(space)) {
556                 struct tty_buffer *tb = tty->buf.tail;
557                 *chars = tb->char_buf_ptr + tb->used;
558                 memset(tb->flag_buf_ptr + tb->used, TTY_NORMAL, space);
559                 tb->used += space;
560         }
561         return space;
562 }
563
564 EXPORT_SYMBOL_GPL(tty_prepare_flip_string);
565
566 /**
567  *      tty_prepare_flip_string_flags   -       make room for characters
568  *      @tty: tty
569  *      @chars: return pointer for character write area
570  *      @flags: return pointer for status flag write area
571  *      @size: desired size
572  *
573  *      Prepare a block of space in the buffer for data. Returns the length
574  *      available and buffer pointer to the space which is now allocated and
575  *      accounted for as ready for characters. This is used for drivers
576  *      that need their own block copy routines into the buffer. There is no
577  *      guarantee the buffer is a DMA target!
578  *
579  *      Locking: May call functions taking tty->buf.lock
580  */
581
582 int tty_prepare_flip_string_flags(struct tty_struct *tty, unsigned char **chars, char **flags, size_t size)
583 {
584         int space = tty_buffer_request_room(tty, size);
585         if (likely(space)) {
586                 struct tty_buffer *tb = tty->buf.tail;
587                 *chars = tb->char_buf_ptr + tb->used;
588                 *flags = tb->flag_buf_ptr + tb->used;
589                 tb->used += space;
590         }
591         return space;
592 }
593
594 EXPORT_SYMBOL_GPL(tty_prepare_flip_string_flags);
595
596
597
598 /**
599  *      tty_set_termios_ldisc           -       set ldisc field
600  *      @tty: tty structure
601  *      @num: line discipline number
602  *
603  *      This is probably overkill for real world processors but
604  *      they are not on hot paths so a little discipline won't do 
605  *      any harm.
606  *
607  *      Locking: takes termios_mutex
608  */
609  
610 static void tty_set_termios_ldisc(struct tty_struct *tty, int num)
611 {
612         mutex_lock(&tty->termios_mutex);
613         tty->termios->c_line = num;
614         mutex_unlock(&tty->termios_mutex);
615 }
616
617 /*
618  *      This guards the refcounted line discipline lists. The lock
619  *      must be taken with irqs off because there are hangup path
620  *      callers who will do ldisc lookups and cannot sleep.
621  */
622  
623 static DEFINE_SPINLOCK(tty_ldisc_lock);
624 static DECLARE_WAIT_QUEUE_HEAD(tty_ldisc_wait);
625 static struct tty_ldisc tty_ldiscs[NR_LDISCS];  /* line disc dispatch table */
626
627 /**
628  *      tty_register_ldisc      -       install a line discipline
629  *      @disc: ldisc number
630  *      @new_ldisc: pointer to the ldisc object
631  *
632  *      Installs a new line discipline into the kernel. The discipline
633  *      is set up as unreferenced and then made available to the kernel
634  *      from this point onwards.
635  *
636  *      Locking:
637  *              takes tty_ldisc_lock to guard against ldisc races
638  */
639
640 int tty_register_ldisc(int disc, struct tty_ldisc *new_ldisc)
641 {
642         unsigned long flags;
643         int ret = 0;
644         
645         if (disc < N_TTY || disc >= NR_LDISCS)
646                 return -EINVAL;
647         
648         spin_lock_irqsave(&tty_ldisc_lock, flags);
649         tty_ldiscs[disc] = *new_ldisc;
650         tty_ldiscs[disc].num = disc;
651         tty_ldiscs[disc].flags |= LDISC_FLAG_DEFINED;
652         tty_ldiscs[disc].refcount = 0;
653         spin_unlock_irqrestore(&tty_ldisc_lock, flags);
654         
655         return ret;
656 }
657 EXPORT_SYMBOL(tty_register_ldisc);
658
659 /**
660  *      tty_unregister_ldisc    -       unload a line discipline
661  *      @disc: ldisc number
662  *      @new_ldisc: pointer to the ldisc object
663  *
664  *      Remove a line discipline from the kernel providing it is not
665  *      currently in use.
666  *
667  *      Locking:
668  *              takes tty_ldisc_lock to guard against ldisc races
669  */
670
671 int tty_unregister_ldisc(int disc)
672 {
673         unsigned long flags;
674         int ret = 0;
675
676         if (disc < N_TTY || disc >= NR_LDISCS)
677                 return -EINVAL;
678
679         spin_lock_irqsave(&tty_ldisc_lock, flags);
680         if (tty_ldiscs[disc].refcount)
681                 ret = -EBUSY;
682         else
683                 tty_ldiscs[disc].flags &= ~LDISC_FLAG_DEFINED;
684         spin_unlock_irqrestore(&tty_ldisc_lock, flags);
685
686         return ret;
687 }
688 EXPORT_SYMBOL(tty_unregister_ldisc);
689
690 /**
691  *      tty_ldisc_get           -       take a reference to an ldisc
692  *      @disc: ldisc number
693  *
694  *      Takes a reference to a line discipline. Deals with refcounts and
695  *      module locking counts. Returns NULL if the discipline is not available.
696  *      Returns a pointer to the discipline and bumps the ref count if it is
697  *      available
698  *
699  *      Locking:
700  *              takes tty_ldisc_lock to guard against ldisc races
701  */
702
703 struct tty_ldisc *tty_ldisc_get(int disc)
704 {
705         unsigned long flags;
706         struct tty_ldisc *ld;
707
708         if (disc < N_TTY || disc >= NR_LDISCS)
709                 return NULL;
710         
711         spin_lock_irqsave(&tty_ldisc_lock, flags);
712
713         ld = &tty_ldiscs[disc];
714         /* Check the entry is defined */
715         if(ld->flags & LDISC_FLAG_DEFINED)
716         {
717                 /* If the module is being unloaded we can't use it */
718                 if (!try_module_get(ld->owner))
719                         ld = NULL;
720                 else /* lock it */
721                         ld->refcount++;
722         }
723         else
724                 ld = NULL;
725         spin_unlock_irqrestore(&tty_ldisc_lock, flags);
726         return ld;
727 }
728
729 EXPORT_SYMBOL_GPL(tty_ldisc_get);
730
731 /**
732  *      tty_ldisc_put           -       drop ldisc reference
733  *      @disc: ldisc number
734  *
735  *      Drop a reference to a line discipline. Manage refcounts and
736  *      module usage counts
737  *
738  *      Locking:
739  *              takes tty_ldisc_lock to guard against ldisc races
740  */
741
742 void tty_ldisc_put(int disc)
743 {
744         struct tty_ldisc *ld;
745         unsigned long flags;
746         
747         BUG_ON(disc < N_TTY || disc >= NR_LDISCS);
748                 
749         spin_lock_irqsave(&tty_ldisc_lock, flags);
750         ld = &tty_ldiscs[disc];
751         BUG_ON(ld->refcount == 0);
752         ld->refcount--;
753         module_put(ld->owner);
754         spin_unlock_irqrestore(&tty_ldisc_lock, flags);
755 }
756         
757 EXPORT_SYMBOL_GPL(tty_ldisc_put);
758
759 /**
760  *      tty_ldisc_assign        -       set ldisc on a tty
761  *      @tty: tty to assign
762  *      @ld: line discipline
763  *
764  *      Install an instance of a line discipline into a tty structure. The
765  *      ldisc must have a reference count above zero to ensure it remains/
766  *      The tty instance refcount starts at zero.
767  *
768  *      Locking:
769  *              Caller must hold references
770  */
771
772 static void tty_ldisc_assign(struct tty_struct *tty, struct tty_ldisc *ld)
773 {
774         tty->ldisc = *ld;
775         tty->ldisc.refcount = 0;
776 }
777
778 /**
779  *      tty_ldisc_try           -       internal helper
780  *      @tty: the tty
781  *
782  *      Make a single attempt to grab and bump the refcount on
783  *      the tty ldisc. Return 0 on failure or 1 on success. This is
784  *      used to implement both the waiting and non waiting versions
785  *      of tty_ldisc_ref
786  *
787  *      Locking: takes tty_ldisc_lock
788  */
789
790 static int tty_ldisc_try(struct tty_struct *tty)
791 {
792         unsigned long flags;
793         struct tty_ldisc *ld;
794         int ret = 0;
795         
796         spin_lock_irqsave(&tty_ldisc_lock, flags);
797         ld = &tty->ldisc;
798         if(test_bit(TTY_LDISC, &tty->flags))
799         {
800                 ld->refcount++;
801                 ret = 1;
802         }
803         spin_unlock_irqrestore(&tty_ldisc_lock, flags);
804         return ret;
805 }
806
807 /**
808  *      tty_ldisc_ref_wait      -       wait for the tty ldisc
809  *      @tty: tty device
810  *
811  *      Dereference the line discipline for the terminal and take a 
812  *      reference to it. If the line discipline is in flux then 
813  *      wait patiently until it changes.
814  *
815  *      Note: Must not be called from an IRQ/timer context. The caller
816  *      must also be careful not to hold other locks that will deadlock
817  *      against a discipline change, such as an existing ldisc reference
818  *      (which we check for)
819  *
820  *      Locking: call functions take tty_ldisc_lock
821  */
822  
823 struct tty_ldisc *tty_ldisc_ref_wait(struct tty_struct *tty)
824 {
825         /* wait_event is a macro */
826         wait_event(tty_ldisc_wait, tty_ldisc_try(tty));
827         if(tty->ldisc.refcount == 0)
828                 printk(KERN_ERR "tty_ldisc_ref_wait\n");
829         return &tty->ldisc;
830 }
831
832 EXPORT_SYMBOL_GPL(tty_ldisc_ref_wait);
833
834 /**
835  *      tty_ldisc_ref           -       get the tty ldisc
836  *      @tty: tty device
837  *
838  *      Dereference the line discipline for the terminal and take a 
839  *      reference to it. If the line discipline is in flux then 
840  *      return NULL. Can be called from IRQ and timer functions.
841  *
842  *      Locking: called functions take tty_ldisc_lock
843  */
844  
845 struct tty_ldisc *tty_ldisc_ref(struct tty_struct *tty)
846 {
847         if(tty_ldisc_try(tty))
848                 return &tty->ldisc;
849         return NULL;
850 }
851
852 EXPORT_SYMBOL_GPL(tty_ldisc_ref);
853
854 /**
855  *      tty_ldisc_deref         -       free a tty ldisc reference
856  *      @ld: reference to free up
857  *
858  *      Undoes the effect of tty_ldisc_ref or tty_ldisc_ref_wait. May
859  *      be called in IRQ context.
860  *
861  *      Locking: takes tty_ldisc_lock
862  */
863  
864 void tty_ldisc_deref(struct tty_ldisc *ld)
865 {
866         unsigned long flags;
867
868         BUG_ON(ld == NULL);
869                 
870         spin_lock_irqsave(&tty_ldisc_lock, flags);
871         if(ld->refcount == 0)
872                 printk(KERN_ERR "tty_ldisc_deref: no references.\n");
873         else
874                 ld->refcount--;
875         if(ld->refcount == 0)
876                 wake_up(&tty_ldisc_wait);
877         spin_unlock_irqrestore(&tty_ldisc_lock, flags);
878 }
879
880 EXPORT_SYMBOL_GPL(tty_ldisc_deref);
881
882 /**
883  *      tty_ldisc_enable        -       allow ldisc use
884  *      @tty: terminal to activate ldisc on
885  *
886  *      Set the TTY_LDISC flag when the line discipline can be called
887  *      again. Do neccessary wakeups for existing sleepers.
888  *
889  *      Note: nobody should set this bit except via this function. Clearing
890  *      directly is allowed.
891  */
892
893 static void tty_ldisc_enable(struct tty_struct *tty)
894 {
895         set_bit(TTY_LDISC, &tty->flags);
896         wake_up(&tty_ldisc_wait);
897 }
898         
899 /**
900  *      tty_set_ldisc           -       set line discipline
901  *      @tty: the terminal to set
902  *      @ldisc: the line discipline
903  *
904  *      Set the discipline of a tty line. Must be called from a process
905  *      context.
906  *
907  *      Locking: takes tty_ldisc_lock.
908  *               called functions take termios_mutex
909  */
910  
911 static int tty_set_ldisc(struct tty_struct *tty, int ldisc)
912 {
913         int retval = 0;
914         struct tty_ldisc o_ldisc;
915         char buf[64];
916         int work;
917         unsigned long flags;
918         struct tty_ldisc *ld;
919         struct tty_struct *o_tty;
920
921         if ((ldisc < N_TTY) || (ldisc >= NR_LDISCS))
922                 return -EINVAL;
923
924 restart:
925
926         ld = tty_ldisc_get(ldisc);
927         /* Eduardo Blanco <ejbs@cs.cs.com.uy> */
928         /* Cyrus Durgin <cider@speakeasy.org> */
929         if (ld == NULL) {
930                 request_module("tty-ldisc-%d", ldisc);
931                 ld = tty_ldisc_get(ldisc);
932         }
933         if (ld == NULL)
934                 return -EINVAL;
935
936         /*
937          *      No more input please, we are switching. The new ldisc
938          *      will update this value in the ldisc open function
939          */
940
941         tty->receive_room = 0;
942
943         /*
944          *      Problem: What do we do if this blocks ?
945          */
946
947         tty_wait_until_sent(tty, 0);
948
949         if (tty->ldisc.num == ldisc) {
950                 tty_ldisc_put(ldisc);
951                 return 0;
952         }
953
954         o_ldisc = tty->ldisc;
955         o_tty = tty->link;
956
957         /*
958          *      Make sure we don't change while someone holds a
959          *      reference to the line discipline. The TTY_LDISC bit
960          *      prevents anyone taking a reference once it is clear.
961          *      We need the lock to avoid racing reference takers.
962          */
963
964         spin_lock_irqsave(&tty_ldisc_lock, flags);
965         if (tty->ldisc.refcount || (o_tty && o_tty->ldisc.refcount)) {
966                 if(tty->ldisc.refcount) {
967                         /* Free the new ldisc we grabbed. Must drop the lock
968                            first. */
969                         spin_unlock_irqrestore(&tty_ldisc_lock, flags);
970                         tty_ldisc_put(ldisc);
971                         /*
972                          * There are several reasons we may be busy, including
973                          * random momentary I/O traffic. We must therefore
974                          * retry. We could distinguish between blocking ops
975                          * and retries if we made tty_ldisc_wait() smarter. That
976                          * is up for discussion.
977                          */
978                         if (wait_event_interruptible(tty_ldisc_wait, tty->ldisc.refcount == 0) < 0)
979                                 return -ERESTARTSYS;
980                         goto restart;
981                 }
982                 if(o_tty && o_tty->ldisc.refcount) {
983                         spin_unlock_irqrestore(&tty_ldisc_lock, flags);
984                         tty_ldisc_put(ldisc);
985                         if (wait_event_interruptible(tty_ldisc_wait, o_tty->ldisc.refcount == 0) < 0)
986                                 return -ERESTARTSYS;
987                         goto restart;
988                 }
989         }
990
991         /* if the TTY_LDISC bit is set, then we are racing against another ldisc change */
992
993         if (!test_bit(TTY_LDISC, &tty->flags)) {
994                 spin_unlock_irqrestore(&tty_ldisc_lock, flags);
995                 tty_ldisc_put(ldisc);
996                 ld = tty_ldisc_ref_wait(tty);
997                 tty_ldisc_deref(ld);
998                 goto restart;
999         }
1000
1001         clear_bit(TTY_LDISC, &tty->flags);
1002         if (o_tty)
1003                 clear_bit(TTY_LDISC, &o_tty->flags);
1004         spin_unlock_irqrestore(&tty_ldisc_lock, flags);
1005
1006         /*
1007          *      From this point on we know nobody has an ldisc
1008          *      usage reference, nor can they obtain one until
1009          *      we say so later on.
1010          */
1011
1012         work = cancel_delayed_work(&tty->buf.work);
1013         /*
1014          * Wait for ->hangup_work and ->buf.work handlers to terminate
1015          */
1016          
1017         flush_scheduled_work();
1018         /* Shutdown the current discipline. */
1019         if (tty->ldisc.close)
1020                 (tty->ldisc.close)(tty);
1021
1022         /* Now set up the new line discipline. */
1023         tty_ldisc_assign(tty, ld);
1024         tty_set_termios_ldisc(tty, ldisc);
1025         if (tty->ldisc.open)
1026                 retval = (tty->ldisc.open)(tty);
1027         if (retval < 0) {
1028                 tty_ldisc_put(ldisc);
1029                 /* There is an outstanding reference here so this is safe */
1030                 tty_ldisc_assign(tty, tty_ldisc_get(o_ldisc.num));
1031                 tty_set_termios_ldisc(tty, tty->ldisc.num);
1032                 if (tty->ldisc.open && (tty->ldisc.open(tty) < 0)) {
1033                         tty_ldisc_put(o_ldisc.num);
1034                         /* This driver is always present */
1035                         tty_ldisc_assign(tty, tty_ldisc_get(N_TTY));
1036                         tty_set_termios_ldisc(tty, N_TTY);
1037                         if (tty->ldisc.open) {
1038                                 int r = tty->ldisc.open(tty);
1039
1040                                 if (r < 0)
1041                                         panic("Couldn't open N_TTY ldisc for "
1042                                               "%s --- error %d.",
1043                                               tty_name(tty, buf), r);
1044                         }
1045                 }
1046         }
1047         /* At this point we hold a reference to the new ldisc and a
1048            a reference to the old ldisc. If we ended up flipping back
1049            to the existing ldisc we have two references to it */
1050         
1051         if (tty->ldisc.num != o_ldisc.num && tty->driver->set_ldisc)
1052                 tty->driver->set_ldisc(tty);
1053                 
1054         tty_ldisc_put(o_ldisc.num);
1055         
1056         /*
1057          *      Allow ldisc referencing to occur as soon as the driver
1058          *      ldisc callback completes.
1059          */
1060          
1061         tty_ldisc_enable(tty);
1062         if (o_tty)
1063                 tty_ldisc_enable(o_tty);
1064         
1065         /* Restart it in case no characters kick it off. Safe if
1066            already running */
1067         if (work)
1068                 schedule_delayed_work(&tty->buf.work, 1);
1069         return retval;
1070 }
1071
1072 /**
1073  *      get_tty_driver          -       find device of a tty
1074  *      @dev_t: device identifier
1075  *      @index: returns the index of the tty
1076  *
1077  *      This routine returns a tty driver structure, given a device number
1078  *      and also passes back the index number.
1079  *
1080  *      Locking: caller must hold tty_mutex
1081  */
1082
1083 static struct tty_driver *get_tty_driver(dev_t device, int *index)
1084 {
1085         struct tty_driver *p;
1086
1087         list_for_each_entry(p, &tty_drivers, tty_drivers) {
1088                 dev_t base = MKDEV(p->major, p->minor_start);
1089                 if (device < base || device >= base + p->num)
1090                         continue;
1091                 *index = device - base;
1092                 return p;
1093         }
1094         return NULL;
1095 }
1096
1097 /**
1098  *      tty_check_change        -       check for POSIX terminal changes
1099  *      @tty: tty to check
1100  *
1101  *      If we try to write to, or set the state of, a terminal and we're
1102  *      not in the foreground, send a SIGTTOU.  If the signal is blocked or
1103  *      ignored, go ahead and perform the operation.  (POSIX 7.2)
1104  *
1105  *      Locking: none
1106  */
1107
1108 int tty_check_change(struct tty_struct * tty)
1109 {
1110         if (current->signal->tty != tty)
1111                 return 0;
1112         if (tty->pgrp <= 0) {
1113                 printk(KERN_WARNING "tty_check_change: tty->pgrp <= 0!\n");
1114                 return 0;
1115         }
1116         if (process_group(current) == tty->pgrp)
1117                 return 0;
1118         if (is_ignored(SIGTTOU))
1119                 return 0;
1120         if (is_orphaned_pgrp(process_group(current)))
1121                 return -EIO;
1122         (void) kill_pg(process_group(current), SIGTTOU, 1);
1123         return -ERESTARTSYS;
1124 }
1125
1126 EXPORT_SYMBOL(tty_check_change);
1127
1128 static ssize_t hung_up_tty_read(struct file * file, char __user * buf,
1129                                 size_t count, loff_t *ppos)
1130 {
1131         return 0;
1132 }
1133
1134 static ssize_t hung_up_tty_write(struct file * file, const char __user * buf,
1135                                  size_t count, loff_t *ppos)
1136 {
1137         return -EIO;
1138 }
1139
1140 /* No kernel lock held - none needed ;) */
1141 static unsigned int hung_up_tty_poll(struct file * filp, poll_table * wait)
1142 {
1143         return POLLIN | POLLOUT | POLLERR | POLLHUP | POLLRDNORM | POLLWRNORM;
1144 }
1145
1146 static int hung_up_tty_ioctl(struct inode * inode, struct file * file,
1147                              unsigned int cmd, unsigned long arg)
1148 {
1149         return cmd == TIOCSPGRP ? -ENOTTY : -EIO;
1150 }
1151
1152 static const struct file_operations tty_fops = {
1153         .llseek         = no_llseek,
1154         .read           = tty_read,
1155         .write          = tty_write,
1156         .poll           = tty_poll,
1157         .ioctl          = tty_ioctl,
1158         .open           = tty_open,
1159         .release        = tty_release,
1160         .fasync         = tty_fasync,
1161 };
1162
1163 #ifdef CONFIG_UNIX98_PTYS
1164 static const struct file_operations ptmx_fops = {
1165         .llseek         = no_llseek,
1166         .read           = tty_read,
1167         .write          = tty_write,
1168         .poll           = tty_poll,
1169         .ioctl          = tty_ioctl,
1170         .open           = ptmx_open,
1171         .release        = tty_release,
1172         .fasync         = tty_fasync,
1173 };
1174 #endif
1175
1176 static const struct file_operations console_fops = {
1177         .llseek         = no_llseek,
1178         .read           = tty_read,
1179         .write          = redirected_tty_write,
1180         .poll           = tty_poll,
1181         .ioctl          = tty_ioctl,
1182         .open           = tty_open,
1183         .release        = tty_release,
1184         .fasync         = tty_fasync,
1185 };
1186
1187 static const struct file_operations hung_up_tty_fops = {
1188         .llseek         = no_llseek,
1189         .read           = hung_up_tty_read,
1190         .write          = hung_up_tty_write,
1191         .poll           = hung_up_tty_poll,
1192         .ioctl          = hung_up_tty_ioctl,
1193         .release        = tty_release,
1194 };
1195
1196 static DEFINE_SPINLOCK(redirect_lock);
1197 static struct file *redirect;
1198
1199 /**
1200  *      tty_wakeup      -       request more data
1201  *      @tty: terminal
1202  *
1203  *      Internal and external helper for wakeups of tty. This function
1204  *      informs the line discipline if present that the driver is ready
1205  *      to receive more output data.
1206  */
1207  
1208 void tty_wakeup(struct tty_struct *tty)
1209 {
1210         struct tty_ldisc *ld;
1211         
1212         if (test_bit(TTY_DO_WRITE_WAKEUP, &tty->flags)) {
1213                 ld = tty_ldisc_ref(tty);
1214                 if(ld) {
1215                         if(ld->write_wakeup)
1216                                 ld->write_wakeup(tty);
1217                         tty_ldisc_deref(ld);
1218                 }
1219         }
1220         wake_up_interruptible(&tty->write_wait);
1221 }
1222
1223 EXPORT_SYMBOL_GPL(tty_wakeup);
1224
1225 /**
1226  *      tty_ldisc_flush -       flush line discipline queue
1227  *      @tty: tty
1228  *
1229  *      Flush the line discipline queue (if any) for this tty. If there
1230  *      is no line discipline active this is a no-op.
1231  */
1232  
1233 void tty_ldisc_flush(struct tty_struct *tty)
1234 {
1235         struct tty_ldisc *ld = tty_ldisc_ref(tty);
1236         if(ld) {
1237                 if(ld->flush_buffer)
1238                         ld->flush_buffer(tty);
1239                 tty_ldisc_deref(ld);
1240         }
1241 }
1242
1243 EXPORT_SYMBOL_GPL(tty_ldisc_flush);
1244
1245 /**
1246  *      tty_reset_termios       -       reset terminal state
1247  *      @tty: tty to reset
1248  *
1249  *      Restore a terminal to the driver default state
1250  */
1251
1252 static void tty_reset_termios(struct tty_struct *tty)
1253 {
1254         mutex_lock(&tty->termios_mutex);
1255         *tty->termios = tty->driver->init_termios;
1256         tty->termios->c_ispeed = tty_termios_input_baud_rate(tty->termios);
1257         tty->termios->c_ospeed = tty_termios_baud_rate(tty->termios);
1258         mutex_unlock(&tty->termios_mutex);
1259 }
1260         
1261 /**
1262  *      do_tty_hangup           -       actual handler for hangup events
1263  *      @work: tty device
1264  *
1265  *      This can be called by the "eventd" kernel thread.  That is process
1266  *      synchronous but doesn't hold any locks, so we need to make sure we
1267  *      have the appropriate locks for what we're doing.
1268  *
1269  *      The hangup event clears any pending redirections onto the hung up
1270  *      device. It ensures future writes will error and it does the needed
1271  *      line discipline hangup and signal delivery. The tty object itself
1272  *      remains intact.
1273  *
1274  *      Locking:
1275  *              BKL
1276  *                redirect lock for undoing redirection
1277  *                file list lock for manipulating list of ttys
1278  *                tty_ldisc_lock from called functions
1279  *                termios_mutex resetting termios data
1280  *                tasklist_lock to walk task list for hangup event
1281  *                  ->siglock to protect ->signal/->sighand
1282  */
1283 static void do_tty_hangup(struct work_struct *work)
1284 {
1285         struct tty_struct *tty =
1286                 container_of(work, struct tty_struct, hangup_work);
1287         struct file * cons_filp = NULL;
1288         struct file *filp, *f = NULL;
1289         struct task_struct *p;
1290         struct tty_ldisc *ld;
1291         int    closecount = 0, n;
1292
1293         if (!tty)
1294                 return;
1295
1296         /* inuse_filps is protected by the single kernel lock */
1297         lock_kernel();
1298
1299         spin_lock(&redirect_lock);
1300         if (redirect && redirect->private_data == tty) {
1301                 f = redirect;
1302                 redirect = NULL;
1303         }
1304         spin_unlock(&redirect_lock);
1305         
1306         check_tty_count(tty, "do_tty_hangup");
1307         file_list_lock();
1308         /* This breaks for file handles being sent over AF_UNIX sockets ? */
1309         list_for_each_entry(filp, &tty->tty_files, f_u.fu_list) {
1310                 if (filp->f_op->write == redirected_tty_write)
1311                         cons_filp = filp;
1312                 if (filp->f_op->write != tty_write)
1313                         continue;
1314                 closecount++;
1315                 tty_fasync(-1, filp, 0);        /* can't block */
1316                 filp->f_op = &hung_up_tty_fops;
1317         }
1318         file_list_unlock();
1319         
1320         /* FIXME! What are the locking issues here? This may me overdoing things..
1321          * this question is especially important now that we've removed the irqlock. */
1322
1323         ld = tty_ldisc_ref(tty);
1324         if(ld != NULL)  /* We may have no line discipline at this point */
1325         {
1326                 if (ld->flush_buffer)
1327                         ld->flush_buffer(tty);
1328                 if (tty->driver->flush_buffer)
1329                         tty->driver->flush_buffer(tty);
1330                 if ((test_bit(TTY_DO_WRITE_WAKEUP, &tty->flags)) &&
1331                     ld->write_wakeup)
1332                         ld->write_wakeup(tty);
1333                 if (ld->hangup)
1334                         ld->hangup(tty);
1335         }
1336
1337         /* FIXME: Once we trust the LDISC code better we can wait here for
1338            ldisc completion and fix the driver call race */
1339            
1340         wake_up_interruptible(&tty->write_wait);
1341         wake_up_interruptible(&tty->read_wait);
1342
1343         /*
1344          * Shutdown the current line discipline, and reset it to
1345          * N_TTY.
1346          */
1347         if (tty->driver->flags & TTY_DRIVER_RESET_TERMIOS)
1348                 tty_reset_termios(tty);
1349         
1350         /* Defer ldisc switch */
1351         /* tty_deferred_ldisc_switch(N_TTY);
1352         
1353           This should get done automatically when the port closes and
1354           tty_release is called */
1355         
1356         read_lock(&tasklist_lock);
1357         if (tty->session > 0) {
1358                 do_each_task_pid(tty->session, PIDTYPE_SID, p) {
1359                         spin_lock_irq(&p->sighand->siglock);
1360                         if (p->signal->tty == tty)
1361                                 p->signal->tty = NULL;
1362                         if (!p->signal->leader) {
1363                                 spin_unlock_irq(&p->sighand->siglock);
1364                                 continue;
1365                         }
1366                         __group_send_sig_info(SIGHUP, SEND_SIG_PRIV, p);
1367                         __group_send_sig_info(SIGCONT, SEND_SIG_PRIV, p);
1368                         if (tty->pgrp > 0)
1369                                 p->signal->tty_old_pgrp = tty->pgrp;
1370                         spin_unlock_irq(&p->sighand->siglock);
1371                 } while_each_task_pid(tty->session, PIDTYPE_SID, p);
1372         }
1373         read_unlock(&tasklist_lock);
1374
1375         tty->flags = 0;
1376         tty->session = 0;
1377         tty->pgrp = -1;
1378         tty->ctrl_status = 0;
1379         /*
1380          *      If one of the devices matches a console pointer, we
1381          *      cannot just call hangup() because that will cause
1382          *      tty->count and state->count to go out of sync.
1383          *      So we just call close() the right number of times.
1384          */
1385         if (cons_filp) {
1386                 if (tty->driver->close)
1387                         for (n = 0; n < closecount; n++)
1388                                 tty->driver->close(tty, cons_filp);
1389         } else if (tty->driver->hangup)
1390                 (tty->driver->hangup)(tty);
1391                 
1392         /* We don't want to have driver/ldisc interactions beyond
1393            the ones we did here. The driver layer expects no
1394            calls after ->hangup() from the ldisc side. However we
1395            can't yet guarantee all that */
1396
1397         set_bit(TTY_HUPPED, &tty->flags);
1398         if (ld) {
1399                 tty_ldisc_enable(tty);
1400                 tty_ldisc_deref(ld);
1401         }
1402         unlock_kernel();
1403         if (f)
1404                 fput(f);
1405 }
1406
1407 /**
1408  *      tty_hangup              -       trigger a hangup event
1409  *      @tty: tty to hangup
1410  *
1411  *      A carrier loss (virtual or otherwise) has occurred on this like
1412  *      schedule a hangup sequence to run after this event.
1413  */
1414
1415 void tty_hangup(struct tty_struct * tty)
1416 {
1417 #ifdef TTY_DEBUG_HANGUP
1418         char    buf[64];
1419         
1420         printk(KERN_DEBUG "%s hangup...\n", tty_name(tty, buf));
1421 #endif
1422         schedule_work(&tty->hangup_work);
1423 }
1424
1425 EXPORT_SYMBOL(tty_hangup);
1426
1427 /**
1428  *      tty_vhangup             -       process vhangup
1429  *      @tty: tty to hangup
1430  *
1431  *      The user has asked via system call for the terminal to be hung up.
1432  *      We do this synchronously so that when the syscall returns the process
1433  *      is complete. That guarantee is neccessary for security reasons.
1434  */
1435
1436 void tty_vhangup(struct tty_struct * tty)
1437 {
1438 #ifdef TTY_DEBUG_HANGUP
1439         char    buf[64];
1440
1441         printk(KERN_DEBUG "%s vhangup...\n", tty_name(tty, buf));
1442 #endif
1443         do_tty_hangup(&tty->hangup_work);
1444 }
1445 EXPORT_SYMBOL(tty_vhangup);
1446
1447 /**
1448  *      tty_hung_up_p           -       was tty hung up
1449  *      @filp: file pointer of tty
1450  *
1451  *      Return true if the tty has been subject to a vhangup or a carrier
1452  *      loss
1453  */
1454
1455 int tty_hung_up_p(struct file * filp)
1456 {
1457         return (filp->f_op == &hung_up_tty_fops);
1458 }
1459
1460 EXPORT_SYMBOL(tty_hung_up_p);
1461
1462 static void session_clear_tty(pid_t session)
1463 {
1464         struct task_struct *p;
1465         do_each_task_pid(session, PIDTYPE_SID, p) {
1466                 proc_clear_tty(p);
1467         } while_each_task_pid(session, PIDTYPE_SID, p);
1468 }
1469
1470 /**
1471  *      disassociate_ctty       -       disconnect controlling tty
1472  *      @on_exit: true if exiting so need to "hang up" the session
1473  *
1474  *      This function is typically called only by the session leader, when
1475  *      it wants to disassociate itself from its controlling tty.
1476  *
1477  *      It performs the following functions:
1478  *      (1)  Sends a SIGHUP and SIGCONT to the foreground process group
1479  *      (2)  Clears the tty from being controlling the session
1480  *      (3)  Clears the controlling tty for all processes in the
1481  *              session group.
1482  *
1483  *      The argument on_exit is set to 1 if called when a process is
1484  *      exiting; it is 0 if called by the ioctl TIOCNOTTY.
1485  *
1486  *      Locking:
1487  *              BKL is taken for hysterical raisins
1488  *                tty_mutex is taken to protect tty
1489  *                ->siglock is taken to protect ->signal/->sighand
1490  *                tasklist_lock is taken to walk process list for sessions
1491  *                  ->siglock is taken to protect ->signal/->sighand
1492  */
1493
1494 void disassociate_ctty(int on_exit)
1495 {
1496         struct tty_struct *tty;
1497         int tty_pgrp = -1;
1498         int session;
1499
1500         lock_kernel();
1501
1502         mutex_lock(&tty_mutex);
1503         tty = get_current_tty();
1504         if (tty) {
1505                 tty_pgrp = tty->pgrp;
1506                 mutex_unlock(&tty_mutex);
1507                 /* XXX: here we race, there is nothing protecting tty */
1508                 if (on_exit && tty->driver->type != TTY_DRIVER_TYPE_PTY)
1509                         tty_vhangup(tty);
1510         } else {
1511                 pid_t old_pgrp = current->signal->tty_old_pgrp;
1512                 if (old_pgrp) {
1513                         kill_pg(old_pgrp, SIGHUP, on_exit);
1514                         kill_pg(old_pgrp, SIGCONT, on_exit);
1515                 }
1516                 mutex_unlock(&tty_mutex);
1517                 unlock_kernel();        
1518                 return;
1519         }
1520         if (tty_pgrp > 0) {
1521                 kill_pg(tty_pgrp, SIGHUP, on_exit);
1522                 if (!on_exit)
1523                         kill_pg(tty_pgrp, SIGCONT, on_exit);
1524         }
1525
1526         spin_lock_irq(&current->sighand->siglock);
1527         current->signal->tty_old_pgrp = 0;
1528         session = process_session(current);
1529         spin_unlock_irq(&current->sighand->siglock);
1530
1531         mutex_lock(&tty_mutex);
1532         /* It is possible that do_tty_hangup has free'd this tty */
1533         tty = get_current_tty();
1534         if (tty) {
1535                 tty->session = 0;
1536                 tty->pgrp = 0;
1537         } else {
1538 #ifdef TTY_DEBUG_HANGUP
1539                 printk(KERN_DEBUG "error attempted to write to tty [0x%p]"
1540                        " = NULL", tty);
1541 #endif
1542         }
1543         mutex_unlock(&tty_mutex);
1544
1545         /* Now clear signal->tty under the lock */
1546         read_lock(&tasklist_lock);
1547         session_clear_tty(session);
1548         read_unlock(&tasklist_lock);
1549         unlock_kernel();
1550 }
1551
1552
1553 /**
1554  *      stop_tty        -       propogate flow control
1555  *      @tty: tty to stop
1556  *
1557  *      Perform flow control to the driver. For PTY/TTY pairs we
1558  *      must also propogate the TIOCKPKT status. May be called
1559  *      on an already stopped device and will not re-call the driver
1560  *      method.
1561  *
1562  *      This functionality is used by both the line disciplines for
1563  *      halting incoming flow and by the driver. It may therefore be
1564  *      called from any context, may be under the tty atomic_write_lock
1565  *      but not always.
1566  *
1567  *      Locking:
1568  *              Broken. Relies on BKL which is unsafe here.
1569  */
1570
1571 void stop_tty(struct tty_struct *tty)
1572 {
1573         if (tty->stopped)
1574                 return;
1575         tty->stopped = 1;
1576         if (tty->link && tty->link->packet) {
1577                 tty->ctrl_status &= ~TIOCPKT_START;
1578                 tty->ctrl_status |= TIOCPKT_STOP;
1579                 wake_up_interruptible(&tty->link->read_wait);
1580         }
1581         if (tty->driver->stop)
1582                 (tty->driver->stop)(tty);
1583 }
1584
1585 EXPORT_SYMBOL(stop_tty);
1586
1587 /**
1588  *      start_tty       -       propogate flow control
1589  *      @tty: tty to start
1590  *
1591  *      Start a tty that has been stopped if at all possible. Perform
1592  *      any neccessary wakeups and propogate the TIOCPKT status. If this
1593  *      is the tty was previous stopped and is being started then the
1594  *      driver start method is invoked and the line discipline woken.
1595  *
1596  *      Locking:
1597  *              Broken. Relies on BKL which is unsafe here.
1598  */
1599
1600 void start_tty(struct tty_struct *tty)
1601 {
1602         if (!tty->stopped || tty->flow_stopped)
1603                 return;
1604         tty->stopped = 0;
1605         if (tty->link && tty->link->packet) {
1606                 tty->ctrl_status &= ~TIOCPKT_STOP;
1607                 tty->ctrl_status |= TIOCPKT_START;
1608                 wake_up_interruptible(&tty->link->read_wait);
1609         }
1610         if (tty->driver->start)
1611                 (tty->driver->start)(tty);
1612
1613         /* If we have a running line discipline it may need kicking */
1614         tty_wakeup(tty);
1615 }
1616
1617 EXPORT_SYMBOL(start_tty);
1618
1619 /**
1620  *      tty_read        -       read method for tty device files
1621  *      @file: pointer to tty file
1622  *      @buf: user buffer
1623  *      @count: size of user buffer
1624  *      @ppos: unused
1625  *
1626  *      Perform the read system call function on this terminal device. Checks
1627  *      for hung up devices before calling the line discipline method.
1628  *
1629  *      Locking:
1630  *              Locks the line discipline internally while needed
1631  *              For historical reasons the line discipline read method is
1632  *      invoked under the BKL. This will go away in time so do not rely on it
1633  *      in new code. Multiple read calls may be outstanding in parallel.
1634  */
1635
1636 static ssize_t tty_read(struct file * file, char __user * buf, size_t count, 
1637                         loff_t *ppos)
1638 {
1639         int i;
1640         struct tty_struct * tty;
1641         struct inode *inode;
1642         struct tty_ldisc *ld;
1643
1644         tty = (struct tty_struct *)file->private_data;
1645         inode = file->f_path.dentry->d_inode;
1646         if (tty_paranoia_check(tty, inode, "tty_read"))
1647                 return -EIO;
1648         if (!tty || (test_bit(TTY_IO_ERROR, &tty->flags)))
1649                 return -EIO;
1650
1651         /* We want to wait for the line discipline to sort out in this
1652            situation */
1653         ld = tty_ldisc_ref_wait(tty);
1654         lock_kernel();
1655         if (ld->read)
1656                 i = (ld->read)(tty,file,buf,count);
1657         else
1658                 i = -EIO;
1659         tty_ldisc_deref(ld);
1660         unlock_kernel();
1661         if (i > 0)
1662                 inode->i_atime = current_fs_time(inode->i_sb);
1663         return i;
1664 }
1665
1666 /*
1667  * Split writes up in sane blocksizes to avoid
1668  * denial-of-service type attacks
1669  */
1670 static inline ssize_t do_tty_write(
1671         ssize_t (*write)(struct tty_struct *, struct file *, const unsigned char *, size_t),
1672         struct tty_struct *tty,
1673         struct file *file,
1674         const char __user *buf,
1675         size_t count)
1676 {
1677         ssize_t ret = 0, written = 0;
1678         unsigned int chunk;
1679         
1680         /* FIXME: O_NDELAY ... */
1681         if (mutex_lock_interruptible(&tty->atomic_write_lock)) {
1682                 return -ERESTARTSYS;
1683         }
1684
1685         /*
1686          * We chunk up writes into a temporary buffer. This
1687          * simplifies low-level drivers immensely, since they
1688          * don't have locking issues and user mode accesses.
1689          *
1690          * But if TTY_NO_WRITE_SPLIT is set, we should use a
1691          * big chunk-size..
1692          *
1693          * The default chunk-size is 2kB, because the NTTY
1694          * layer has problems with bigger chunks. It will
1695          * claim to be able to handle more characters than
1696          * it actually does.
1697          *
1698          * FIXME: This can probably go away now except that 64K chunks
1699          * are too likely to fail unless switched to vmalloc...
1700          */
1701         chunk = 2048;
1702         if (test_bit(TTY_NO_WRITE_SPLIT, &tty->flags))
1703                 chunk = 65536;
1704         if (count < chunk)
1705                 chunk = count;
1706
1707         /* write_buf/write_cnt is protected by the atomic_write_lock mutex */
1708         if (tty->write_cnt < chunk) {
1709                 unsigned char *buf;
1710
1711                 if (chunk < 1024)
1712                         chunk = 1024;
1713
1714                 buf = kmalloc(chunk, GFP_KERNEL);
1715                 if (!buf) {
1716                         mutex_unlock(&tty->atomic_write_lock);
1717                         return -ENOMEM;
1718                 }
1719                 kfree(tty->write_buf);
1720                 tty->write_cnt = chunk;
1721                 tty->write_buf = buf;
1722         }
1723
1724         /* Do the write .. */
1725         for (;;) {
1726                 size_t size = count;
1727                 if (size > chunk)
1728                         size = chunk;
1729                 ret = -EFAULT;
1730                 if (copy_from_user(tty->write_buf, buf, size))
1731                         break;
1732                 lock_kernel();
1733                 ret = write(tty, file, tty->write_buf, size);
1734                 unlock_kernel();
1735                 if (ret <= 0)
1736                         break;
1737                 written += ret;
1738                 buf += ret;
1739                 count -= ret;
1740                 if (!count)
1741                         break;
1742                 ret = -ERESTARTSYS;
1743                 if (signal_pending(current))
1744                         break;
1745                 cond_resched();
1746         }
1747         if (written) {
1748                 struct inode *inode = file->f_path.dentry->d_inode;
1749                 inode->i_mtime = current_fs_time(inode->i_sb);
1750                 ret = written;
1751         }
1752         mutex_unlock(&tty->atomic_write_lock);
1753         return ret;
1754 }
1755
1756
1757 /**
1758  *      tty_write               -       write method for tty device file
1759  *      @file: tty file pointer
1760  *      @buf: user data to write
1761  *      @count: bytes to write
1762  *      @ppos: unused
1763  *
1764  *      Write data to a tty device via the line discipline.
1765  *
1766  *      Locking:
1767  *              Locks the line discipline as required
1768  *              Writes to the tty driver are serialized by the atomic_write_lock
1769  *      and are then processed in chunks to the device. The line discipline
1770  *      write method will not be involked in parallel for each device
1771  *              The line discipline write method is called under the big
1772  *      kernel lock for historical reasons. New code should not rely on this.
1773  */
1774
1775 static ssize_t tty_write(struct file * file, const char __user * buf, size_t count,
1776                          loff_t *ppos)
1777 {
1778         struct tty_struct * tty;
1779         struct inode *inode = file->f_path.dentry->d_inode;
1780         ssize_t ret;
1781         struct tty_ldisc *ld;
1782         
1783         tty = (struct tty_struct *)file->private_data;
1784         if (tty_paranoia_check(tty, inode, "tty_write"))
1785                 return -EIO;
1786         if (!tty || !tty->driver->write || (test_bit(TTY_IO_ERROR, &tty->flags)))
1787                 return -EIO;
1788
1789         ld = tty_ldisc_ref_wait(tty);           
1790         if (!ld->write)
1791                 ret = -EIO;
1792         else
1793                 ret = do_tty_write(ld->write, tty, file, buf, count);
1794         tty_ldisc_deref(ld);
1795         return ret;
1796 }
1797
1798 ssize_t redirected_tty_write(struct file * file, const char __user * buf, size_t count,
1799                          loff_t *ppos)
1800 {
1801         struct file *p = NULL;
1802
1803         spin_lock(&redirect_lock);
1804         if (redirect) {
1805                 get_file(redirect);
1806                 p = redirect;
1807         }
1808         spin_unlock(&redirect_lock);
1809
1810         if (p) {
1811                 ssize_t res;
1812                 res = vfs_write(p, buf, count, &p->f_pos);
1813                 fput(p);
1814                 return res;
1815         }
1816
1817         return tty_write(file, buf, count, ppos);
1818 }
1819
1820 static char ptychar[] = "pqrstuvwxyzabcde";
1821
1822 /**
1823  *      pty_line_name   -       generate name for a pty
1824  *      @driver: the tty driver in use
1825  *      @index: the minor number
1826  *      @p: output buffer of at least 6 bytes
1827  *
1828  *      Generate a name from a driver reference and write it to the output
1829  *      buffer.
1830  *
1831  *      Locking: None
1832  */
1833 static void pty_line_name(struct tty_driver *driver, int index, char *p)
1834 {
1835         int i = index + driver->name_base;
1836         /* ->name is initialized to "ttyp", but "tty" is expected */
1837         sprintf(p, "%s%c%x",
1838                         driver->subtype == PTY_TYPE_SLAVE ? "tty" : driver->name,
1839                         ptychar[i >> 4 & 0xf], i & 0xf);
1840 }
1841
1842 /**
1843  *      pty_line_name   -       generate name for a tty
1844  *      @driver: the tty driver in use
1845  *      @index: the minor number
1846  *      @p: output buffer of at least 7 bytes
1847  *
1848  *      Generate a name from a driver reference and write it to the output
1849  *      buffer.
1850  *
1851  *      Locking: None
1852  */
1853 static void tty_line_name(struct tty_driver *driver, int index, char *p)
1854 {
1855         sprintf(p, "%s%d", driver->name, index + driver->name_base);
1856 }
1857
1858 /**
1859  *      init_dev                -       initialise a tty device
1860  *      @driver: tty driver we are opening a device on
1861  *      @idx: device index
1862  *      @tty: returned tty structure
1863  *
1864  *      Prepare a tty device. This may not be a "new" clean device but
1865  *      could also be an active device. The pty drivers require special
1866  *      handling because of this.
1867  *
1868  *      Locking:
1869  *              The function is called under the tty_mutex, which
1870  *      protects us from the tty struct or driver itself going away.
1871  *
1872  *      On exit the tty device has the line discipline attached and
1873  *      a reference count of 1. If a pair was created for pty/tty use
1874  *      and the other was a pty master then it too has a reference count of 1.
1875  *
1876  * WSH 06/09/97: Rewritten to remove races and properly clean up after a
1877  * failed open.  The new code protects the open with a mutex, so it's
1878  * really quite straightforward.  The mutex locking can probably be
1879  * relaxed for the (most common) case of reopening a tty.
1880  */
1881
1882 static int init_dev(struct tty_driver *driver, int idx,
1883         struct tty_struct **ret_tty)
1884 {
1885         struct tty_struct *tty, *o_tty;
1886         struct ktermios *tp, **tp_loc, *o_tp, **o_tp_loc;
1887         struct ktermios *ltp, **ltp_loc, *o_ltp, **o_ltp_loc;
1888         int retval = 0;
1889
1890         /* check whether we're reopening an existing tty */
1891         if (driver->flags & TTY_DRIVER_DEVPTS_MEM) {
1892                 tty = devpts_get_tty(idx);
1893                 if (tty && driver->subtype == PTY_TYPE_MASTER)
1894                         tty = tty->link;
1895         } else {
1896                 tty = driver->ttys[idx];
1897         }
1898         if (tty) goto fast_track;
1899
1900         /*
1901          * First time open is complex, especially for PTY devices.
1902          * This code guarantees that either everything succeeds and the
1903          * TTY is ready for operation, or else the table slots are vacated
1904          * and the allocated memory released.  (Except that the termios 
1905          * and locked termios may be retained.)
1906          */
1907
1908         if (!try_module_get(driver->owner)) {
1909                 retval = -ENODEV;
1910                 goto end_init;
1911         }
1912
1913         o_tty = NULL;
1914         tp = o_tp = NULL;
1915         ltp = o_ltp = NULL;
1916
1917         tty = alloc_tty_struct();
1918         if(!tty)
1919                 goto fail_no_mem;
1920         initialize_tty_struct(tty);
1921         tty->driver = driver;
1922         tty->index = idx;
1923         tty_line_name(driver, idx, tty->name);
1924
1925         if (driver->flags & TTY_DRIVER_DEVPTS_MEM) {
1926                 tp_loc = &tty->termios;
1927                 ltp_loc = &tty->termios_locked;
1928         } else {
1929                 tp_loc = &driver->termios[idx];
1930                 ltp_loc = &driver->termios_locked[idx];
1931         }
1932
1933         if (!*tp_loc) {
1934                 tp = (struct ktermios *) kmalloc(sizeof(struct ktermios),
1935                                                 GFP_KERNEL);
1936                 if (!tp)
1937                         goto free_mem_out;
1938                 *tp = driver->init_termios;
1939         }
1940
1941         if (!*ltp_loc) {
1942                 ltp = (struct ktermios *) kmalloc(sizeof(struct ktermios),
1943                                                  GFP_KERNEL);
1944                 if (!ltp)
1945                         goto free_mem_out;
1946                 memset(ltp, 0, sizeof(struct ktermios));
1947         }
1948
1949         if (driver->type == TTY_DRIVER_TYPE_PTY) {
1950                 o_tty = alloc_tty_struct();
1951                 if (!o_tty)
1952                         goto free_mem_out;
1953                 initialize_tty_struct(o_tty);
1954                 o_tty->driver = driver->other;
1955                 o_tty->index = idx;
1956                 tty_line_name(driver->other, idx, o_tty->name);
1957
1958                 if (driver->flags & TTY_DRIVER_DEVPTS_MEM) {
1959                         o_tp_loc = &o_tty->termios;
1960                         o_ltp_loc = &o_tty->termios_locked;
1961                 } else {
1962                         o_tp_loc = &driver->other->termios[idx];
1963                         o_ltp_loc = &driver->other->termios_locked[idx];
1964                 }
1965
1966                 if (!*o_tp_loc) {
1967                         o_tp = (struct ktermios *)
1968                                 kmalloc(sizeof(struct ktermios), GFP_KERNEL);
1969                         if (!o_tp)
1970                                 goto free_mem_out;
1971                         *o_tp = driver->other->init_termios;
1972                 }
1973
1974                 if (!*o_ltp_loc) {
1975                         o_ltp = (struct ktermios *)
1976                                 kmalloc(sizeof(struct ktermios), GFP_KERNEL);
1977                         if (!o_ltp)
1978                                 goto free_mem_out;
1979                         memset(o_ltp, 0, sizeof(struct ktermios));
1980                 }
1981
1982                 /*
1983                  * Everything allocated ... set up the o_tty structure.
1984                  */
1985                 if (!(driver->other->flags & TTY_DRIVER_DEVPTS_MEM)) {
1986                         driver->other->ttys[idx] = o_tty;
1987                 }
1988                 if (!*o_tp_loc)
1989                         *o_tp_loc = o_tp;
1990                 if (!*o_ltp_loc)
1991                         *o_ltp_loc = o_ltp;
1992                 o_tty->termios = *o_tp_loc;
1993                 o_tty->termios_locked = *o_ltp_loc;
1994                 driver->other->refcount++;
1995                 if (driver->subtype == PTY_TYPE_MASTER)
1996                         o_tty->count++;
1997
1998                 /* Establish the links in both directions */
1999                 tty->link   = o_tty;
2000                 o_tty->link = tty;
2001         }
2002
2003         /* 
2004          * All structures have been allocated, so now we install them.
2005          * Failures after this point use release_mem to clean up, so 
2006          * there's no need to null out the local pointers.
2007          */
2008         if (!(driver->flags & TTY_DRIVER_DEVPTS_MEM)) {
2009                 driver->ttys[idx] = tty;
2010         }
2011         
2012         if (!*tp_loc)
2013                 *tp_loc = tp;
2014         if (!*ltp_loc)
2015                 *ltp_loc = ltp;
2016         tty->termios = *tp_loc;
2017         tty->termios_locked = *ltp_loc;
2018         /* Compatibility until drivers always set this */
2019         tty->termios->c_ispeed = tty_termios_input_baud_rate(tty->termios);
2020         tty->termios->c_ospeed = tty_termios_baud_rate(tty->termios);
2021         driver->refcount++;
2022         tty->count++;
2023
2024         /* 
2025          * Structures all installed ... call the ldisc open routines.
2026          * If we fail here just call release_mem to clean up.  No need
2027          * to decrement the use counts, as release_mem doesn't care.
2028          */
2029
2030         if (tty->ldisc.open) {
2031                 retval = (tty->ldisc.open)(tty);
2032                 if (retval)
2033                         goto release_mem_out;
2034         }
2035         if (o_tty && o_tty->ldisc.open) {
2036                 retval = (o_tty->ldisc.open)(o_tty);
2037                 if (retval) {
2038                         if (tty->ldisc.close)
2039                                 (tty->ldisc.close)(tty);
2040                         goto release_mem_out;
2041                 }
2042                 tty_ldisc_enable(o_tty);
2043         }
2044         tty_ldisc_enable(tty);
2045         goto success;
2046
2047         /*
2048          * This fast open can be used if the tty is already open.
2049          * No memory is allocated, and the only failures are from
2050          * attempting to open a closing tty or attempting multiple
2051          * opens on a pty master.
2052          */
2053 fast_track:
2054         if (test_bit(TTY_CLOSING, &tty->flags)) {
2055                 retval = -EIO;
2056                 goto end_init;
2057         }
2058         if (driver->type == TTY_DRIVER_TYPE_PTY &&
2059             driver->subtype == PTY_TYPE_MASTER) {
2060                 /*
2061                  * special case for PTY masters: only one open permitted, 
2062                  * and the slave side open count is incremented as well.
2063                  */
2064                 if (tty->count) {
2065                         retval = -EIO;
2066                         goto end_init;
2067                 }
2068                 tty->link->count++;
2069         }
2070         tty->count++;
2071         tty->driver = driver; /* N.B. why do this every time?? */
2072
2073         /* FIXME */
2074         if(!test_bit(TTY_LDISC, &tty->flags))
2075                 printk(KERN_ERR "init_dev but no ldisc\n");
2076 success:
2077         *ret_tty = tty;
2078         
2079         /* All paths come through here to release the mutex */
2080 end_init:
2081         return retval;
2082
2083         /* Release locally allocated memory ... nothing placed in slots */
2084 free_mem_out:
2085         kfree(o_tp);
2086         if (o_tty)
2087                 free_tty_struct(o_tty);
2088         kfree(ltp);
2089         kfree(tp);
2090         free_tty_struct(tty);
2091
2092 fail_no_mem:
2093         module_put(driver->owner);
2094         retval = -ENOMEM;
2095         goto end_init;
2096
2097         /* call the tty release_mem routine to clean out this slot */
2098 release_mem_out:
2099         if (printk_ratelimit())
2100                 printk(KERN_INFO "init_dev: ldisc open failed, "
2101                                  "clearing slot %d\n", idx);
2102         release_mem(tty, idx);
2103         goto end_init;
2104 }
2105
2106 /**
2107  *      release_mem             -       release tty structure memory
2108  *
2109  *      Releases memory associated with a tty structure, and clears out the
2110  *      driver table slots. This function is called when a device is no longer
2111  *      in use. It also gets called when setup of a device fails.
2112  *
2113  *      Locking:
2114  *              tty_mutex - sometimes only
2115  *              takes the file list lock internally when working on the list
2116  *      of ttys that the driver keeps.
2117  *              FIXME: should we require tty_mutex is held here ??
2118  */
2119
2120 static void release_mem(struct tty_struct *tty, int idx)
2121 {
2122         struct tty_struct *o_tty;
2123         struct ktermios *tp;
2124         int devpts = tty->driver->flags & TTY_DRIVER_DEVPTS_MEM;
2125
2126         if ((o_tty = tty->link) != NULL) {
2127                 if (!devpts)
2128                         o_tty->driver->ttys[idx] = NULL;
2129                 if (o_tty->driver->flags & TTY_DRIVER_RESET_TERMIOS) {
2130                         tp = o_tty->termios;
2131                         if (!devpts)
2132                                 o_tty->driver->termios[idx] = NULL;
2133                         kfree(tp);
2134
2135                         tp = o_tty->termios_locked;
2136                         if (!devpts)
2137                                 o_tty->driver->termios_locked[idx] = NULL;
2138                         kfree(tp);
2139                 }
2140                 o_tty->magic = 0;
2141                 o_tty->driver->refcount--;
2142                 file_list_lock();
2143                 list_del_init(&o_tty->tty_files);
2144                 file_list_unlock();
2145                 free_tty_struct(o_tty);
2146         }
2147
2148         if (!devpts)
2149                 tty->driver->ttys[idx] = NULL;
2150         if (tty->driver->flags & TTY_DRIVER_RESET_TERMIOS) {
2151                 tp = tty->termios;
2152                 if (!devpts)
2153                         tty->driver->termios[idx] = NULL;
2154                 kfree(tp);
2155
2156                 tp = tty->termios_locked;
2157                 if (!devpts)
2158                         tty->driver->termios_locked[idx] = NULL;
2159                 kfree(tp);
2160         }
2161
2162         tty->magic = 0;
2163         tty->driver->refcount--;
2164         file_list_lock();
2165         list_del_init(&tty->tty_files);
2166         file_list_unlock();
2167         module_put(tty->driver->owner);
2168         free_tty_struct(tty);
2169 }
2170
2171 /*
2172  * Even releasing the tty structures is a tricky business.. We have
2173  * to be very careful that the structures are all released at the
2174  * same time, as interrupts might otherwise get the wrong pointers.
2175  *
2176  * WSH 09/09/97: rewritten to avoid some nasty race conditions that could
2177  * lead to double frees or releasing memory still in use.
2178  */
2179 static void release_dev(struct file * filp)
2180 {
2181         struct tty_struct *tty, *o_tty;
2182         int     pty_master, tty_closing, o_tty_closing, do_sleep;
2183         int     devpts;
2184         int     idx;
2185         char    buf[64];
2186         unsigned long flags;
2187         
2188         tty = (struct tty_struct *)filp->private_data;
2189         if (tty_paranoia_check(tty, filp->f_path.dentry->d_inode, "release_dev"))
2190                 return;
2191
2192         check_tty_count(tty, "release_dev");
2193
2194         tty_fasync(-1, filp, 0);
2195
2196         idx = tty->index;
2197         pty_master = (tty->driver->type == TTY_DRIVER_TYPE_PTY &&
2198                       tty->driver->subtype == PTY_TYPE_MASTER);
2199         devpts = (tty->driver->flags & TTY_DRIVER_DEVPTS_MEM) != 0;
2200         o_tty = tty->link;
2201
2202 #ifdef TTY_PARANOIA_CHECK
2203         if (idx < 0 || idx >= tty->driver->num) {
2204                 printk(KERN_DEBUG "release_dev: bad idx when trying to "
2205                                   "free (%s)\n", tty->name);
2206                 return;
2207         }
2208         if (!(tty->driver->flags & TTY_DRIVER_DEVPTS_MEM)) {
2209                 if (tty != tty->driver->ttys[idx]) {
2210                         printk(KERN_DEBUG "release_dev: driver.table[%d] not tty "
2211                                "for (%s)\n", idx, tty->name);
2212                         return;
2213                 }
2214                 if (tty->termios != tty->driver->termios[idx]) {
2215                         printk(KERN_DEBUG "release_dev: driver.termios[%d] not termios "
2216                                "for (%s)\n",
2217                                idx, tty->name);
2218                         return;
2219                 }
2220                 if (tty->termios_locked != tty->driver->termios_locked[idx]) {
2221                         printk(KERN_DEBUG "release_dev: driver.termios_locked[%d] not "
2222                                "termios_locked for (%s)\n",
2223                                idx, tty->name);
2224                         return;
2225                 }
2226         }
2227 #endif
2228
2229 #ifdef TTY_DEBUG_HANGUP
2230         printk(KERN_DEBUG "release_dev of %s (tty count=%d)...",
2231                tty_name(tty, buf), tty->count);
2232 #endif
2233
2234 #ifdef TTY_PARANOIA_CHECK
2235         if (tty->driver->other &&
2236              !(tty->driver->flags & TTY_DRIVER_DEVPTS_MEM)) {
2237                 if (o_tty != tty->driver->other->ttys[idx]) {
2238                         printk(KERN_DEBUG "release_dev: other->table[%d] "
2239                                           "not o_tty for (%s)\n",
2240                                idx, tty->name);
2241                         return;
2242                 }
2243                 if (o_tty->termios != tty->driver->other->termios[idx]) {
2244                         printk(KERN_DEBUG "release_dev: other->termios[%d] "
2245                                           "not o_termios for (%s)\n",
2246                                idx, tty->name);
2247                         return;
2248                 }
2249                 if (o_tty->termios_locked != 
2250                       tty->driver->other->termios_locked[idx]) {
2251                         printk(KERN_DEBUG "release_dev: other->termios_locked["
2252                                           "%d] not o_termios_locked for (%s)\n",
2253                                idx, tty->name);
2254                         return;
2255                 }
2256                 if (o_tty->link != tty) {
2257                         printk(KERN_DEBUG "release_dev: bad pty pointers\n");
2258                         return;
2259                 }
2260         }
2261 #endif
2262         if (tty->driver->close)
2263                 tty->driver->close(tty, filp);
2264
2265         /*
2266          * Sanity check: if tty->count is going to zero, there shouldn't be
2267          * any waiters on tty->read_wait or tty->write_wait.  We test the
2268          * wait queues and kick everyone out _before_ actually starting to
2269          * close.  This ensures that we won't block while releasing the tty
2270          * structure.
2271          *
2272          * The test for the o_tty closing is necessary, since the master and
2273          * slave sides may close in any order.  If the slave side closes out
2274          * first, its count will be one, since the master side holds an open.
2275          * Thus this test wouldn't be triggered at the time the slave closes,
2276          * so we do it now.
2277          *
2278          * Note that it's possible for the tty to be opened again while we're
2279          * flushing out waiters.  By recalculating the closing flags before
2280          * each iteration we avoid any problems.
2281          */
2282         while (1) {
2283                 /* Guard against races with tty->count changes elsewhere and
2284                    opens on /dev/tty */
2285                    
2286                 mutex_lock(&tty_mutex);
2287                 tty_closing = tty->count <= 1;
2288                 o_tty_closing = o_tty &&
2289                         (o_tty->count <= (pty_master ? 1 : 0));
2290                 do_sleep = 0;
2291
2292                 if (tty_closing) {
2293                         if (waitqueue_active(&tty->read_wait)) {
2294                                 wake_up(&tty->read_wait);
2295                                 do_sleep++;
2296                         }
2297                         if (waitqueue_active(&tty->write_wait)) {
2298                                 wake_up(&tty->write_wait);
2299                                 do_sleep++;
2300                         }
2301                 }
2302                 if (o_tty_closing) {
2303                         if (waitqueue_active(&o_tty->read_wait)) {
2304                                 wake_up(&o_tty->read_wait);
2305                                 do_sleep++;
2306                         }
2307                         if (waitqueue_active(&o_tty->write_wait)) {
2308                                 wake_up(&o_tty->write_wait);
2309                                 do_sleep++;
2310                         }
2311                 }
2312                 if (!do_sleep)
2313                         break;
2314
2315                 printk(KERN_WARNING "release_dev: %s: read/write wait queue "
2316                                     "active!\n", tty_name(tty, buf));
2317                 mutex_unlock(&tty_mutex);
2318                 schedule();
2319         }       
2320
2321         /*
2322          * The closing flags are now consistent with the open counts on 
2323          * both sides, and we've completed the last operation that could 
2324          * block, so it's safe to proceed with closing.
2325          */
2326         if (pty_master) {
2327                 if (--o_tty->count < 0) {
2328                         printk(KERN_WARNING "release_dev: bad pty slave count "
2329                                             "(%d) for %s\n",
2330                                o_tty->count, tty_name(o_tty, buf));
2331                         o_tty->count = 0;
2332                 }
2333         }
2334         if (--tty->count < 0) {
2335                 printk(KERN_WARNING "release_dev: bad tty->count (%d) for %s\n",
2336                        tty->count, tty_name(tty, buf));
2337                 tty->count = 0;
2338         }
2339         
2340         /*
2341          * We've decremented tty->count, so we need to remove this file
2342          * descriptor off the tty->tty_files list; this serves two
2343          * purposes:
2344          *  - check_tty_count sees the correct number of file descriptors
2345          *    associated with this tty.
2346          *  - do_tty_hangup no longer sees this file descriptor as
2347          *    something that needs to be handled for hangups.
2348          */
2349         file_kill(filp);
2350         filp->private_data = NULL;
2351
2352         /*
2353          * Perform some housekeeping before deciding whether to return.
2354          *
2355          * Set the TTY_CLOSING flag if this was the last open.  In the
2356          * case of a pty we may have to wait around for the other side
2357          * to close, and TTY_CLOSING makes sure we can't be reopened.
2358          */
2359         if(tty_closing)
2360                 set_bit(TTY_CLOSING, &tty->flags);
2361         if(o_tty_closing)
2362                 set_bit(TTY_CLOSING, &o_tty->flags);
2363
2364         /*
2365          * If _either_ side is closing, make sure there aren't any
2366          * processes that still think tty or o_tty is their controlling
2367          * tty.
2368          */
2369         if (tty_closing || o_tty_closing) {
2370                 read_lock(&tasklist_lock);
2371                 session_clear_tty(tty->session);
2372                 if (o_tty)
2373                         session_clear_tty(o_tty->session);
2374                 read_unlock(&tasklist_lock);
2375         }
2376
2377         mutex_unlock(&tty_mutex);
2378
2379         /* check whether both sides are closing ... */
2380         if (!tty_closing || (o_tty && !o_tty_closing))
2381                 return;
2382         
2383 #ifdef TTY_DEBUG_HANGUP
2384         printk(KERN_DEBUG "freeing tty structure...");
2385 #endif
2386         /*
2387          * Prevent flush_to_ldisc() from rescheduling the work for later.  Then
2388          * kill any delayed work. As this is the final close it does not
2389          * race with the set_ldisc code path.
2390          */
2391         clear_bit(TTY_LDISC, &tty->flags);
2392         cancel_delayed_work(&tty->buf.work);
2393
2394         /*
2395          * Wait for ->hangup_work and ->buf.work handlers to terminate
2396          */
2397          
2398         flush_scheduled_work();
2399         
2400         /*
2401          * Wait for any short term users (we know they are just driver
2402          * side waiters as the file is closing so user count on the file
2403          * side is zero.
2404          */
2405         spin_lock_irqsave(&tty_ldisc_lock, flags);
2406         while(tty->ldisc.refcount)
2407         {
2408                 spin_unlock_irqrestore(&tty_ldisc_lock, flags);
2409                 wait_event(tty_ldisc_wait, tty->ldisc.refcount == 0);
2410                 spin_lock_irqsave(&tty_ldisc_lock, flags);
2411         }
2412         spin_unlock_irqrestore(&tty_ldisc_lock, flags);
2413         /*
2414          * Shutdown the current line discipline, and reset it to N_TTY.
2415          * N.B. why reset ldisc when we're releasing the memory??
2416          *
2417          * FIXME: this MUST get fixed for the new reflocking
2418          */
2419         if (tty->ldisc.close)
2420                 (tty->ldisc.close)(tty);
2421         tty_ldisc_put(tty->ldisc.num);
2422         
2423         /*
2424          *      Switch the line discipline back
2425          */
2426         tty_ldisc_assign(tty, tty_ldisc_get(N_TTY));
2427         tty_set_termios_ldisc(tty,N_TTY); 
2428         if (o_tty) {
2429                 /* FIXME: could o_tty be in setldisc here ? */
2430                 clear_bit(TTY_LDISC, &o_tty->flags);
2431                 if (o_tty->ldisc.close)
2432                         (o_tty->ldisc.close)(o_tty);
2433                 tty_ldisc_put(o_tty->ldisc.num);
2434                 tty_ldisc_assign(o_tty, tty_ldisc_get(N_TTY));
2435                 tty_set_termios_ldisc(o_tty,N_TTY); 
2436         }
2437         /*
2438          * The release_mem function takes care of the details of clearing
2439          * the slots and preserving the termios structure.
2440          */
2441         release_mem(tty, idx);
2442
2443 #ifdef CONFIG_UNIX98_PTYS
2444         /* Make this pty number available for reallocation */
2445         if (devpts) {
2446                 down(&allocated_ptys_lock);
2447                 idr_remove(&allocated_ptys, idx);
2448                 up(&allocated_ptys_lock);
2449         }
2450 #endif
2451
2452 }
2453
2454 /**
2455  *      tty_open                -       open a tty device
2456  *      @inode: inode of device file
2457  *      @filp: file pointer to tty
2458  *
2459  *      tty_open and tty_release keep up the tty count that contains the
2460  *      number of opens done on a tty. We cannot use the inode-count, as
2461  *      different inodes might point to the same tty.
2462  *
2463  *      Open-counting is needed for pty masters, as well as for keeping
2464  *      track of serial lines: DTR is dropped when the last close happens.
2465  *      (This is not done solely through tty->count, now.  - Ted 1/27/92)
2466  *
2467  *      The termios state of a pty is reset on first open so that
2468  *      settings don't persist across reuse.
2469  *
2470  *      Locking: tty_mutex protects tty, get_tty_driver and init_dev work.
2471  *               tty->count should protect the rest.
2472  *               ->siglock protects ->signal/->sighand
2473  */
2474
2475 static int tty_open(struct inode * inode, struct file * filp)
2476 {
2477         struct tty_struct *tty;
2478         int noctty, retval;
2479         struct tty_driver *driver;
2480         int index;
2481         dev_t device = inode->i_rdev;
2482         unsigned short saved_flags = filp->f_flags;
2483
2484         nonseekable_open(inode, filp);
2485         
2486 retry_open:
2487         noctty = filp->f_flags & O_NOCTTY;
2488         index  = -1;
2489         retval = 0;
2490         
2491         mutex_lock(&tty_mutex);
2492
2493         if (device == MKDEV(TTYAUX_MAJOR,0)) {
2494                 tty = get_current_tty();
2495                 if (!tty) {
2496                         mutex_unlock(&tty_mutex);
2497                         return -ENXIO;
2498                 }
2499                 driver = tty->driver;
2500                 index = tty->index;
2501                 filp->f_flags |= O_NONBLOCK; /* Don't let /dev/tty block */
2502                 /* noctty = 1; */
2503                 goto got_driver;
2504         }
2505 #ifdef CONFIG_VT
2506         if (device == MKDEV(TTY_MAJOR,0)) {
2507                 extern struct tty_driver *console_driver;
2508                 driver = console_driver;
2509                 index = fg_console;
2510                 noctty = 1;
2511                 goto got_driver;
2512         }
2513 #endif
2514         if (device == MKDEV(TTYAUX_MAJOR,1)) {
2515                 driver = console_device(&index);
2516                 if (driver) {
2517                         /* Don't let /dev/console block */
2518                         filp->f_flags |= O_NONBLOCK;
2519                         noctty = 1;
2520                         goto got_driver;
2521                 }
2522                 mutex_unlock(&tty_mutex);
2523                 return -ENODEV;
2524         }
2525
2526         driver = get_tty_driver(device, &index);
2527         if (!driver) {
2528                 mutex_unlock(&tty_mutex);
2529                 return -ENODEV;
2530         }
2531 got_driver:
2532         retval = init_dev(driver, index, &tty);
2533         mutex_unlock(&tty_mutex);
2534         if (retval)
2535                 return retval;
2536
2537         filp->private_data = tty;
2538         file_move(filp, &tty->tty_files);
2539         check_tty_count(tty, "tty_open");
2540         if (tty->driver->type == TTY_DRIVER_TYPE_PTY &&
2541             tty->driver->subtype == PTY_TYPE_MASTER)
2542                 noctty = 1;
2543 #ifdef TTY_DEBUG_HANGUP
2544         printk(KERN_DEBUG "opening %s...", tty->name);
2545 #endif
2546         if (!retval) {
2547                 if (tty->driver->open)
2548                         retval = tty->driver->open(tty, filp);
2549                 else
2550                         retval = -ENODEV;
2551         }
2552         filp->f_flags = saved_flags;
2553
2554         if (!retval && test_bit(TTY_EXCLUSIVE, &tty->flags) && !capable(CAP_SYS_ADMIN))
2555                 retval = -EBUSY;
2556
2557         if (retval) {
2558 #ifdef TTY_DEBUG_HANGUP
2559                 printk(KERN_DEBUG "error %d in opening %s...", retval,
2560                        tty->name);
2561 #endif
2562                 release_dev(filp);
2563                 if (retval != -ERESTARTSYS)
2564                         return retval;
2565                 if (signal_pending(current))
2566                         return retval;
2567                 schedule();
2568                 /*
2569                  * Need to reset f_op in case a hangup happened.
2570                  */
2571                 if (filp->f_op == &hung_up_tty_fops)
2572                         filp->f_op = &tty_fops;
2573                 goto retry_open;
2574         }
2575
2576         mutex_lock(&tty_mutex);
2577         spin_lock_irq(&current->sighand->siglock);
2578         if (!noctty &&
2579             current->signal->leader &&
2580             !current->signal->tty &&
2581             tty->session == 0)
2582                 __proc_set_tty(current, tty);
2583         spin_unlock_irq(&current->sighand->siglock);
2584         mutex_unlock(&tty_mutex);
2585         return 0;
2586 }
2587
2588 #ifdef CONFIG_UNIX98_PTYS
2589 /**
2590  *      ptmx_open               -       open a unix 98 pty master
2591  *      @inode: inode of device file
2592  *      @filp: file pointer to tty
2593  *
2594  *      Allocate a unix98 pty master device from the ptmx driver.
2595  *
2596  *      Locking: tty_mutex protects theinit_dev work. tty->count should
2597                 protect the rest.
2598  *              allocated_ptys_lock handles the list of free pty numbers
2599  */
2600
2601 static int ptmx_open(struct inode * inode, struct file * filp)
2602 {
2603         struct tty_struct *tty;
2604         int retval;
2605         int index;
2606         int idr_ret;
2607
2608         nonseekable_open(inode, filp);
2609
2610         /* find a device that is not in use. */
2611         down(&allocated_ptys_lock);
2612         if (!idr_pre_get(&allocated_ptys, GFP_KERNEL)) {
2613                 up(&allocated_ptys_lock);
2614                 return -ENOMEM;
2615         }
2616         idr_ret = idr_get_new(&allocated_ptys, NULL, &index);
2617         if (idr_ret < 0) {
2618                 up(&allocated_ptys_lock);
2619                 if (idr_ret == -EAGAIN)
2620                         return -ENOMEM;
2621                 return -EIO;
2622         }
2623         if (index >= pty_limit) {
2624                 idr_remove(&allocated_ptys, index);
2625                 up(&allocated_ptys_lock);
2626                 return -EIO;
2627         }
2628         up(&allocated_ptys_lock);
2629
2630         mutex_lock(&tty_mutex);
2631         retval = init_dev(ptm_driver, index, &tty);
2632         mutex_unlock(&tty_mutex);
2633         
2634         if (retval)
2635                 goto out;
2636
2637         set_bit(TTY_PTY_LOCK, &tty->flags); /* LOCK THE SLAVE */
2638         filp->private_data = tty;
2639         file_move(filp, &tty->tty_files);
2640
2641         retval = -ENOMEM;
2642         if (devpts_pty_new(tty->link))
2643                 goto out1;
2644
2645         check_tty_count(tty, "tty_open");
2646         retval = ptm_driver->open(tty, filp);
2647         if (!retval)
2648                 return 0;
2649 out1:
2650         release_dev(filp);
2651         return retval;
2652 out:
2653         down(&allocated_ptys_lock);
2654         idr_remove(&allocated_ptys, index);
2655         up(&allocated_ptys_lock);
2656         return retval;
2657 }
2658 #endif
2659
2660 /**
2661  *      tty_release             -       vfs callback for close
2662  *      @inode: inode of tty
2663  *      @filp: file pointer for handle to tty
2664  *
2665  *      Called the last time each file handle is closed that references
2666  *      this tty. There may however be several such references.
2667  *
2668  *      Locking:
2669  *              Takes bkl. See release_dev
2670  */
2671
2672 static int tty_release(struct inode * inode, struct file * filp)
2673 {
2674         lock_kernel();
2675         release_dev(filp);
2676         unlock_kernel();
2677         return 0;
2678 }
2679
2680 /**
2681  *      tty_poll        -       check tty status
2682  *      @filp: file being polled
2683  *      @wait: poll wait structures to update
2684  *
2685  *      Call the line discipline polling method to obtain the poll
2686  *      status of the device.
2687  *
2688  *      Locking: locks called line discipline but ldisc poll method
2689  *      may be re-entered freely by other callers.
2690  */
2691
2692 static unsigned int tty_poll(struct file * filp, poll_table * wait)
2693 {
2694         struct tty_struct * tty;
2695         struct tty_ldisc *ld;
2696         int ret = 0;
2697
2698         tty = (struct tty_struct *)filp->private_data;
2699         if (tty_paranoia_check(tty, filp->f_path.dentry->d_inode, "tty_poll"))
2700                 return 0;
2701                 
2702         ld = tty_ldisc_ref_wait(tty);
2703         if (ld->poll)
2704                 ret = (ld->poll)(tty, filp, wait);
2705         tty_ldisc_deref(ld);
2706         return ret;
2707 }
2708
2709 static int tty_fasync(int fd, struct file * filp, int on)
2710 {
2711         struct tty_struct * tty;
2712         int retval;
2713
2714         tty = (struct tty_struct *)filp->private_data;
2715         if (tty_paranoia_check(tty, filp->f_path.dentry->d_inode, "tty_fasync"))
2716                 return 0;
2717         
2718         retval = fasync_helper(fd, filp, on, &tty->fasync);
2719         if (retval <= 0)
2720                 return retval;
2721
2722         if (on) {
2723                 if (!waitqueue_active(&tty->read_wait))
2724                         tty->minimum_to_wake = 1;
2725                 retval = f_setown(filp, (-tty->pgrp) ? : current->pid, 0);
2726                 if (retval)
2727                         return retval;
2728         } else {
2729                 if (!tty->fasync && !waitqueue_active(&tty->read_wait))
2730                         tty->minimum_to_wake = N_TTY_BUF_SIZE;
2731         }
2732         return 0;
2733 }
2734
2735 /**
2736  *      tiocsti                 -       fake input character
2737  *      @tty: tty to fake input into
2738  *      @p: pointer to character
2739  *
2740  *      Fake input to a tty device. Does the neccessary locking and
2741  *      input management.
2742  *
2743  *      FIXME: does not honour flow control ??
2744  *
2745  *      Locking:
2746  *              Called functions take tty_ldisc_lock
2747  *              current->signal->tty check is safe without locks
2748  *
2749  *      FIXME: may race normal receive processing
2750  */
2751
2752 static int tiocsti(struct tty_struct *tty, char __user *p)
2753 {
2754         char ch, mbz = 0;
2755         struct tty_ldisc *ld;
2756         
2757         if ((current->signal->tty != tty) && !capable(CAP_SYS_ADMIN))
2758                 return -EPERM;
2759         if (get_user(ch, p))
2760                 return -EFAULT;
2761         ld = tty_ldisc_ref_wait(tty);
2762         ld->receive_buf(tty, &ch, &mbz, 1);
2763         tty_ldisc_deref(ld);
2764         return 0;
2765 }
2766
2767 /**
2768  *      tiocgwinsz              -       implement window query ioctl
2769  *      @tty; tty
2770  *      @arg: user buffer for result
2771  *
2772  *      Copies the kernel idea of the window size into the user buffer.
2773  *
2774  *      Locking: tty->termios_mutex is taken to ensure the winsize data
2775  *              is consistent.
2776  */
2777
2778 static int tiocgwinsz(struct tty_struct *tty, struct winsize __user * arg)
2779 {
2780         int err;
2781
2782         mutex_lock(&tty->termios_mutex);
2783         err = copy_to_user(arg, &tty->winsize, sizeof(*arg));
2784         mutex_unlock(&tty->termios_mutex);
2785
2786         return err ? -EFAULT: 0;
2787 }
2788
2789 /**
2790  *      tiocswinsz              -       implement window size set ioctl
2791  *      @tty; tty
2792  *      @arg: user buffer for result
2793  *
2794  *      Copies the user idea of the window size to the kernel. Traditionally
2795  *      this is just advisory information but for the Linux console it
2796  *      actually has driver level meaning and triggers a VC resize.
2797  *
2798  *      Locking:
2799  *              Called function use the console_sem is used to ensure we do
2800  *      not try and resize the console twice at once.
2801  *              The tty->termios_mutex is used to ensure we don't double
2802  *      resize and get confused. Lock order - tty->termios_mutex before
2803  *      console sem
2804  */
2805
2806 static int tiocswinsz(struct tty_struct *tty, struct tty_struct *real_tty,
2807         struct winsize __user * arg)
2808 {
2809         struct winsize tmp_ws;
2810
2811         if (copy_from_user(&tmp_ws, arg, sizeof(*arg)))
2812                 return -EFAULT;
2813
2814         mutex_lock(&tty->termios_mutex);
2815         if (!memcmp(&tmp_ws, &tty->winsize, sizeof(*arg)))
2816                 goto done;
2817
2818 #ifdef CONFIG_VT
2819         if (tty->driver->type == TTY_DRIVER_TYPE_CONSOLE) {
2820                 if (vc_lock_resize(tty->driver_data, tmp_ws.ws_col,
2821                                         tmp_ws.ws_row)) {
2822                         mutex_unlock(&tty->termios_mutex);
2823                         return -ENXIO;
2824                 }
2825         }
2826 #endif
2827         if (tty->pgrp > 0)
2828                 kill_pg(tty->pgrp, SIGWINCH, 1);
2829         if ((real_tty->pgrp != tty->pgrp) && (real_tty->pgrp > 0))
2830                 kill_pg(real_tty->pgrp, SIGWINCH, 1);
2831         tty->winsize = tmp_ws;
2832         real_tty->winsize = tmp_ws;
2833 done:
2834         mutex_unlock(&tty->termios_mutex);
2835         return 0;
2836 }
2837
2838 /**
2839  *      tioccons        -       allow admin to move logical console
2840  *      @file: the file to become console
2841  *
2842  *      Allow the adminstrator to move the redirected console device
2843  *
2844  *      Locking: uses redirect_lock to guard the redirect information
2845  */
2846
2847 static int tioccons(struct file *file)
2848 {
2849         if (!capable(CAP_SYS_ADMIN))
2850                 return -EPERM;
2851         if (file->f_op->write == redirected_tty_write) {
2852                 struct file *f;
2853                 spin_lock(&redirect_lock);
2854                 f = redirect;
2855                 redirect = NULL;
2856                 spin_unlock(&redirect_lock);
2857                 if (f)
2858                         fput(f);
2859                 return 0;
2860         }
2861         spin_lock(&redirect_lock);
2862         if (redirect) {
2863                 spin_unlock(&redirect_lock);
2864                 return -EBUSY;
2865         }
2866         get_file(file);
2867         redirect = file;
2868         spin_unlock(&redirect_lock);
2869         return 0;
2870 }
2871
2872 /**
2873  *      fionbio         -       non blocking ioctl
2874  *      @file: file to set blocking value
2875  *      @p: user parameter
2876  *
2877  *      Historical tty interfaces had a blocking control ioctl before
2878  *      the generic functionality existed. This piece of history is preserved
2879  *      in the expected tty API of posix OS's.
2880  *
2881  *      Locking: none, the open fle handle ensures it won't go away.
2882  */
2883
2884 static int fionbio(struct file *file, int __user *p)
2885 {
2886         int nonblock;
2887
2888         if (get_user(nonblock, p))
2889                 return -EFAULT;
2890
2891         if (nonblock)
2892                 file->f_flags |= O_NONBLOCK;
2893         else
2894                 file->f_flags &= ~O_NONBLOCK;
2895         return 0;
2896 }
2897
2898 /**
2899  *      tiocsctty       -       set controlling tty
2900  *      @tty: tty structure
2901  *      @arg: user argument
2902  *
2903  *      This ioctl is used to manage job control. It permits a session
2904  *      leader to set this tty as the controlling tty for the session.
2905  *
2906  *      Locking:
2907  *              Takes tty_mutex() to protect tty instance
2908  *              Takes tasklist_lock internally to walk sessions
2909  *              Takes ->siglock() when updating signal->tty
2910  */
2911
2912 static int tiocsctty(struct tty_struct *tty, int arg)
2913 {
2914         int ret = 0;
2915         if (current->signal->leader &&
2916                         (process_session(current) == tty->session))
2917                 return ret;
2918
2919         mutex_lock(&tty_mutex);
2920         /*
2921          * The process must be a session leader and
2922          * not have a controlling tty already.
2923          */
2924         if (!current->signal->leader || current->signal->tty) {
2925                 ret = -EPERM;
2926                 goto unlock;
2927         }
2928
2929         if (tty->session > 0) {
2930                 /*
2931                  * This tty is already the controlling
2932                  * tty for another session group!
2933                  */
2934                 if ((arg == 1) && capable(CAP_SYS_ADMIN)) {
2935                         /*
2936                          * Steal it away
2937                          */
2938                         read_lock(&tasklist_lock);
2939                         session_clear_tty(tty->session);
2940                         read_unlock(&tasklist_lock);
2941                 } else {
2942                         ret = -EPERM;
2943                         goto unlock;
2944                 }
2945         }
2946         proc_set_tty(current, tty);
2947 unlock:
2948         mutex_unlock(&tty_mutex);
2949         return ret;
2950 }
2951
2952 /**
2953  *      tiocgpgrp               -       get process group
2954  *      @tty: tty passed by user
2955  *      @real_tty: tty side of the tty pased by the user if a pty else the tty
2956  *      @p: returned pid
2957  *
2958  *      Obtain the process group of the tty. If there is no process group
2959  *      return an error.
2960  *
2961  *      Locking: none. Reference to current->signal->tty is safe.
2962  */
2963
2964 static int tiocgpgrp(struct tty_struct *tty, struct tty_struct *real_tty, pid_t __user *p)
2965 {
2966         /*
2967          * (tty == real_tty) is a cheap way of
2968          * testing if the tty is NOT a master pty.
2969          */
2970         if (tty == real_tty && current->signal->tty != real_tty)
2971                 return -ENOTTY;
2972         return put_user(real_tty->pgrp, p);
2973 }
2974
2975 /**
2976  *      tiocspgrp               -       attempt to set process group
2977  *      @tty: tty passed by user
2978  *      @real_tty: tty side device matching tty passed by user
2979  *      @p: pid pointer
2980  *
2981  *      Set the process group of the tty to the session passed. Only
2982  *      permitted where the tty session is our session.
2983  *
2984  *      Locking: None
2985  */
2986
2987 static int tiocspgrp(struct tty_struct *tty, struct tty_struct *real_tty, pid_t __user *p)
2988 {
2989         pid_t pgrp;
2990         int retval = tty_check_change(real_tty);
2991
2992         if (retval == -EIO)
2993                 return -ENOTTY;
2994         if (retval)
2995                 return retval;
2996         if (!current->signal->tty ||
2997             (current->signal->tty != real_tty) ||
2998             (real_tty->session != process_session(current)))
2999                 return -ENOTTY;
3000         if (get_user(pgrp, p))
3001                 return -EFAULT;
3002         if (pgrp < 0)
3003                 return -EINVAL;
3004         if (session_of_pgrp(pgrp) != process_session(current))
3005                 return -EPERM;
3006         real_tty->pgrp = pgrp;
3007         return 0;
3008 }
3009
3010 /**
3011  *      tiocgsid                -       get session id
3012  *      @tty: tty passed by user
3013  *      @real_tty: tty side of the tty pased by the user if a pty else the tty
3014  *      @p: pointer to returned session id
3015  *
3016  *      Obtain the session id of the tty. If there is no session
3017  *      return an error.
3018  *
3019  *      Locking: none. Reference to current->signal->tty is safe.
3020  */
3021
3022 static int tiocgsid(struct tty_struct *tty, struct tty_struct *real_tty, pid_t __user *p)
3023 {
3024         /*
3025          * (tty == real_tty) is a cheap way of
3026          * testing if the tty is NOT a master pty.
3027         */
3028         if (tty == real_tty && current->signal->tty != real_tty)
3029                 return -ENOTTY;
3030         if (real_tty->session <= 0)
3031                 return -ENOTTY;
3032         return put_user(real_tty->session, p);
3033 }
3034
3035 /**
3036  *      tiocsetd        -       set line discipline
3037  *      @tty: tty device
3038  *      @p: pointer to user data
3039  *
3040  *      Set the line discipline according to user request.
3041  *
3042  *      Locking: see tty_set_ldisc, this function is just a helper
3043  */
3044
3045 static int tiocsetd(struct tty_struct *tty, int __user *p)
3046 {
3047         int ldisc;
3048
3049         if (get_user(ldisc, p))
3050                 return -EFAULT;
3051         return tty_set_ldisc(tty, ldisc);
3052 }
3053
3054 /**
3055  *      send_break      -       performed time break
3056  *      @tty: device to break on
3057  *      @duration: timeout in mS
3058  *
3059  *      Perform a timed break on hardware that lacks its own driver level
3060  *      timed break functionality.
3061  *
3062  *      Locking:
3063  *              atomic_write_lock serializes
3064  *
3065  */
3066
3067 static int send_break(struct tty_struct *tty, unsigned int duration)
3068 {
3069         if (mutex_lock_interruptible(&tty->atomic_write_lock))
3070                 return -EINTR;
3071         tty->driver->break_ctl(tty, -1);
3072         if (!signal_pending(current)) {
3073                 msleep_interruptible(duration);
3074         }
3075         tty->driver->break_ctl(tty, 0);
3076         mutex_unlock(&tty->atomic_write_lock);
3077         if (signal_pending(current))
3078                 return -EINTR;
3079         return 0;
3080 }
3081
3082 /**
3083  *      tiocmget                -       get modem status
3084  *      @tty: tty device
3085  *      @file: user file pointer
3086  *      @p: pointer to result
3087  *
3088  *      Obtain the modem status bits from the tty driver if the feature
3089  *      is supported. Return -EINVAL if it is not available.
3090  *
3091  *      Locking: none (up to the driver)
3092  */
3093
3094 static int tty_tiocmget(struct tty_struct *tty, struct file *file, int __user *p)
3095 {
3096         int retval = -EINVAL;
3097
3098         if (tty->driver->tiocmget) {
3099                 retval = tty->driver->tiocmget(tty, file);
3100
3101                 if (retval >= 0)
3102                         retval = put_user(retval, p);
3103         }
3104         return retval;
3105 }
3106
3107 /**
3108  *      tiocmset                -       set modem status
3109  *      @tty: tty device
3110  *      @file: user file pointer
3111  *      @cmd: command - clear bits, set bits or set all
3112  *      @p: pointer to desired bits
3113  *
3114  *      Set the modem status bits from the tty driver if the feature
3115  *      is supported. Return -EINVAL if it is not available.
3116  *
3117  *      Locking: none (up to the driver)
3118  */
3119
3120 static int tty_tiocmset(struct tty_struct *tty, struct file *file, unsigned int cmd,
3121              unsigned __user *p)
3122 {
3123         int retval = -EINVAL;
3124
3125         if (tty->driver->tiocmset) {
3126                 unsigned int set, clear, val;
3127
3128                 retval = get_user(val, p);
3129                 if (retval)
3130                         return retval;
3131
3132                 set = clear = 0;
3133                 switch (cmd) {
3134                 case TIOCMBIS:
3135                         set = val;
3136                         break;
3137                 case TIOCMBIC:
3138                         clear = val;
3139                         break;
3140                 case TIOCMSET:
3141                         set = val;
3142                         clear = ~val;
3143                         break;
3144                 }
3145
3146                 set &= TIOCM_DTR|TIOCM_RTS|TIOCM_OUT1|TIOCM_OUT2|TIOCM_LOOP;
3147                 clear &= TIOCM_DTR|TIOCM_RTS|TIOCM_OUT1|TIOCM_OUT2|TIOCM_LOOP;
3148
3149                 retval = tty->driver->tiocmset(tty, file, set, clear);
3150         }
3151         return retval;
3152 }
3153
3154 /*
3155  * Split this up, as gcc can choke on it otherwise..
3156  */
3157 int tty_ioctl(struct inode * inode, struct file * file,
3158               unsigned int cmd, unsigned long arg)
3159 {
3160         struct tty_struct *tty, *real_tty;
3161         void __user *p = (void __user *)arg;
3162         int retval;
3163         struct tty_ldisc *ld;
3164         
3165         tty = (struct tty_struct *)file->private_data;
3166         if (tty_paranoia_check(tty, inode, "tty_ioctl"))
3167                 return -EINVAL;
3168
3169         /* CHECKME: is this safe as one end closes ? */
3170
3171         real_tty = tty;
3172         if (tty->driver->type == TTY_DRIVER_TYPE_PTY &&
3173             tty->driver->subtype == PTY_TYPE_MASTER)
3174                 real_tty = tty->link;
3175
3176         /*
3177          * Break handling by driver
3178          */
3179         if (!tty->driver->break_ctl) {
3180                 switch(cmd) {
3181                 case TIOCSBRK:
3182                 case TIOCCBRK:
3183                         if (tty->driver->ioctl)
3184                                 return tty->driver->ioctl(tty, file, cmd, arg);
3185                         return -EINVAL;
3186                         
3187                 /* These two ioctl's always return success; even if */
3188                 /* the driver doesn't support them. */
3189                 case TCSBRK:
3190                 case TCSBRKP:
3191                         if (!tty->driver->ioctl)
3192                                 return 0;
3193                         retval = tty->driver->ioctl(tty, file, cmd, arg);
3194                         if (retval == -ENOIOCTLCMD)
3195                                 retval = 0;
3196                         return retval;
3197                 }
3198         }
3199
3200         /*
3201          * Factor out some common prep work
3202          */
3203         switch (cmd) {
3204         case TIOCSETD:
3205         case TIOCSBRK:
3206         case TIOCCBRK:
3207         case TCSBRK:
3208         case TCSBRKP:                   
3209                 retval = tty_check_change(tty);
3210                 if (retval)
3211                         return retval;
3212                 if (cmd != TIOCCBRK) {
3213                         tty_wait_until_sent(tty, 0);
3214                         if (signal_pending(current))
3215                                 return -EINTR;
3216                 }
3217                 break;
3218         }
3219
3220         switch (cmd) {
3221                 case TIOCSTI:
3222                         return tiocsti(tty, p);
3223                 case TIOCGWINSZ:
3224                         return tiocgwinsz(tty, p);
3225                 case TIOCSWINSZ:
3226                         return tiocswinsz(tty, real_tty, p);
3227                 case TIOCCONS:
3228                         return real_tty!=tty ? -EINVAL : tioccons(file);
3229                 case FIONBIO:
3230                         return fionbio(file, p);
3231                 case TIOCEXCL:
3232                         set_bit(TTY_EXCLUSIVE, &tty->flags);
3233                         return 0;
3234                 case TIOCNXCL:
3235                         clear_bit(TTY_EXCLUSIVE, &tty->flags);
3236                         return 0;
3237                 case TIOCNOTTY:
3238                         if (current->signal->tty != tty)
3239                                 return -ENOTTY;
3240                         if (current->signal->leader)
3241                                 disassociate_ctty(0);
3242                         proc_clear_tty(current);
3243                         return 0;
3244                 case TIOCSCTTY:
3245                         return tiocsctty(tty, arg);
3246                 case TIOCGPGRP:
3247                         return tiocgpgrp(tty, real_tty, p);
3248                 case TIOCSPGRP:
3249                         return tiocspgrp(tty, real_tty, p);
3250                 case TIOCGSID:
3251                         return tiocgsid(tty, real_tty, p);
3252                 case TIOCGETD:
3253                         /* FIXME: check this is ok */
3254                         return put_user(tty->ldisc.num, (int __user *)p);
3255                 case TIOCSETD:
3256                         return tiocsetd(tty, p);
3257 #ifdef CONFIG_VT
3258                 case TIOCLINUX:
3259                         return tioclinux(tty, arg);
3260 #endif
3261                 /*
3262                  * Break handling
3263                  */
3264                 case TIOCSBRK:  /* Turn break on, unconditionally */
3265                         tty->driver->break_ctl(tty, -1);
3266                         return 0;
3267                         
3268                 case TIOCCBRK:  /* Turn break off, unconditionally */
3269                         tty->driver->break_ctl(tty, 0);
3270                         return 0;
3271                 case TCSBRK:   /* SVID version: non-zero arg --> no break */
3272                         /* non-zero arg means wait for all output data
3273                          * to be sent (performed above) but don't send break.
3274                          * This is used by the tcdrain() termios function.
3275                          */
3276                         if (!arg)
3277                                 return send_break(tty, 250);
3278                         return 0;
3279                 case TCSBRKP:   /* support for POSIX tcsendbreak() */   
3280                         return send_break(tty, arg ? arg*100 : 250);
3281
3282                 case TIOCMGET:
3283                         return tty_tiocmget(tty, file, p);
3284
3285                 case TIOCMSET:
3286                 case TIOCMBIC:
3287                 case TIOCMBIS:
3288                         return tty_tiocmset(tty, file, cmd, p);
3289         }
3290         if (tty->driver->ioctl) {
3291                 retval = (tty->driver->ioctl)(tty, file, cmd, arg);
3292                 if (retval != -ENOIOCTLCMD)
3293                         return retval;
3294         }
3295         ld = tty_ldisc_ref_wait(tty);
3296         retval = -EINVAL;
3297         if (ld->ioctl) {
3298                 retval = ld->ioctl(tty, file, cmd, arg);
3299                 if (retval == -ENOIOCTLCMD)
3300                         retval = -EINVAL;
3301         }
3302         tty_ldisc_deref(ld);
3303         return retval;
3304 }
3305
3306
3307 /*
3308  * This implements the "Secure Attention Key" ---  the idea is to
3309  * prevent trojan horses by killing all processes associated with this
3310  * tty when the user hits the "Secure Attention Key".  Required for
3311  * super-paranoid applications --- see the Orange Book for more details.
3312  * 
3313  * This code could be nicer; ideally it should send a HUP, wait a few
3314  * seconds, then send a INT, and then a KILL signal.  But you then
3315  * have to coordinate with the init process, since all processes associated
3316  * with the current tty must be dead before the new getty is allowed
3317  * to spawn.
3318  *
3319  * Now, if it would be correct ;-/ The current code has a nasty hole -
3320  * it doesn't catch files in flight. We may send the descriptor to ourselves
3321  * via AF_UNIX socket, close it and later fetch from socket. FIXME.
3322  *
3323  * Nasty bug: do_SAK is being called in interrupt context.  This can
3324  * deadlock.  We punt it up to process context.  AKPM - 16Mar2001
3325  */
3326 void __do_SAK(struct tty_struct *tty)
3327 {
3328 #ifdef TTY_SOFT_SAK
3329         tty_hangup(tty);
3330 #else
3331         struct task_struct *g, *p;
3332         int session;
3333         int             i;
3334         struct file     *filp;
3335         struct fdtable *fdt;
3336         
3337         if (!tty)
3338                 return;
3339         session = tty->session;
3340         
3341         tty_ldisc_flush(tty);
3342
3343         if (tty->driver->flush_buffer)
3344                 tty->driver->flush_buffer(tty);
3345         
3346         read_lock(&tasklist_lock);
3347         /* Kill the entire session */
3348         do_each_task_pid(session, PIDTYPE_SID, p) {
3349                 printk(KERN_NOTICE "SAK: killed process %d"
3350                         " (%s): process_session(p)==tty->session\n",
3351                         p->pid, p->comm);
3352                 send_sig(SIGKILL, p, 1);
3353         } while_each_task_pid(session, PIDTYPE_SID, p);
3354         /* Now kill any processes that happen to have the
3355          * tty open.
3356          */
3357         do_each_thread(g, p) {
3358                 if (p->signal->tty == tty) {
3359                         printk(KERN_NOTICE "SAK: killed process %d"
3360                             " (%s): process_session(p)==tty->session\n",
3361                             p->pid, p->comm);
3362                         send_sig(SIGKILL, p, 1);
3363                         continue;
3364                 }
3365                 task_lock(p);
3366                 if (p->files) {
3367                         /*
3368                          * We don't take a ref to the file, so we must
3369                          * hold ->file_lock instead.
3370                          */
3371                         spin_lock(&p->files->file_lock);
3372                         fdt = files_fdtable(p->files);
3373                         for (i=0; i < fdt->max_fds; i++) {
3374                                 filp = fcheck_files(p->files, i);
3375                                 if (!filp)
3376                                         continue;
3377                                 if (filp->f_op->read == tty_read &&
3378                                     filp->private_data == tty) {
3379                                         printk(KERN_NOTICE "SAK: killed process %d"
3380                                             " (%s): fd#%d opened to the tty\n",
3381                                             p->pid, p->comm, i);
3382                                         force_sig(SIGKILL, p);
3383                                         break;
3384                                 }
3385                         }
3386                         spin_unlock(&p->files->file_lock);
3387                 }
3388                 task_unlock(p);
3389         } while_each_thread(g, p);
3390         read_unlock(&tasklist_lock);
3391 #endif
3392 }
3393
3394 static void do_SAK_work(struct work_struct *work)
3395 {
3396         struct tty_struct *tty =
3397                 container_of(work, struct tty_struct, SAK_work);
3398         __do_SAK(tty);
3399 }
3400
3401 /*
3402  * The tq handling here is a little racy - tty->SAK_work may already be queued.
3403  * Fortunately we don't need to worry, because if ->SAK_work is already queued,
3404  * the values which we write to it will be identical to the values which it
3405  * already has. --akpm
3406  */
3407 void do_SAK(struct tty_struct *tty)
3408 {
3409         if (!tty)
3410                 return;
3411         PREPARE_WORK(&tty->SAK_work, do_SAK_work);
3412         schedule_work(&tty->SAK_work);
3413 }
3414
3415 EXPORT_SYMBOL(do_SAK);
3416
3417 /**
3418  *      flush_to_ldisc
3419  *      @work: tty structure passed from work queue.
3420  *
3421  *      This routine is called out of the software interrupt to flush data
3422  *      from the buffer chain to the line discipline.
3423  *
3424  *      Locking: holds tty->buf.lock to guard buffer list. Drops the lock
3425  *      while invoking the line discipline receive_buf method. The
3426  *      receive_buf method is single threaded for each tty instance.
3427  */
3428  
3429 static void flush_to_ldisc(struct work_struct *work)
3430 {
3431         struct tty_struct *tty =
3432                 container_of(work, struct tty_struct, buf.work.work);
3433         unsigned long   flags;
3434         struct tty_ldisc *disc;
3435         struct tty_buffer *tbuf, *head;
3436         char *char_buf;
3437         unsigned char *flag_buf;
3438
3439         disc = tty_ldisc_ref(tty);
3440         if (disc == NULL)       /*  !TTY_LDISC */
3441                 return;
3442
3443         spin_lock_irqsave(&tty->buf.lock, flags);
3444         head = tty->buf.head;
3445         if (head != NULL) {
3446                 tty->buf.head = NULL;
3447                 for (;;) {
3448                         int count = head->commit - head->read;
3449                         if (!count) {
3450                                 if (head->next == NULL)
3451                                         break;
3452                                 tbuf = head;
3453                                 head = head->next;
3454                                 tty_buffer_free(tty, tbuf);
3455                                 continue;
3456                         }
3457                         if (!tty->receive_room) {
3458                                 schedule_delayed_work(&tty->buf.work, 1);
3459                                 break;
3460                         }
3461                         if (count > tty->receive_room)
3462                                 count = tty->receive_room;
3463                         char_buf = head->char_buf_ptr + head->read;
3464                         flag_buf = head->flag_buf_ptr + head->read;
3465                         head->read += count;
3466                         spin_unlock_irqrestore(&tty->buf.lock, flags);
3467                         disc->receive_buf(tty, char_buf, flag_buf, count);
3468                         spin_lock_irqsave(&tty->buf.lock, flags);
3469                 }
3470                 tty->buf.head = head;
3471         }
3472         spin_unlock_irqrestore(&tty->buf.lock, flags);
3473
3474         tty_ldisc_deref(disc);
3475 }
3476
3477 /**
3478  *      tty_flip_buffer_push    -       terminal
3479  *      @tty: tty to push
3480  *
3481  *      Queue a push of the terminal flip buffers to the line discipline. This
3482  *      function must not be called from IRQ context if tty->low_latency is set.
3483  *
3484  *      In the event of the queue being busy for flipping the work will be
3485  *      held off and retried later.
3486  *
3487  *      Locking: tty buffer lock. Driver locks in low latency mode.
3488  */
3489
3490 void tty_flip_buffer_push(struct tty_struct *tty)
3491 {
3492         unsigned long flags;
3493         spin_lock_irqsave(&tty->buf.lock, flags);
3494         if (tty->buf.tail != NULL)
3495                 tty->buf.tail->commit = tty->buf.tail->used;
3496         spin_unlock_irqrestore(&tty->buf.lock, flags);
3497
3498         if (tty->low_latency)
3499                 flush_to_ldisc(&tty->buf.work.work);
3500         else
3501                 schedule_delayed_work(&tty->buf.work, 1);
3502 }
3503
3504 EXPORT_SYMBOL(tty_flip_buffer_push);
3505
3506
3507 /**
3508  *      initialize_tty_struct
3509  *      @tty: tty to initialize
3510  *
3511  *      This subroutine initializes a tty structure that has been newly
3512  *      allocated.
3513  *
3514  *      Locking: none - tty in question must not be exposed at this point
3515  */
3516
3517 static void initialize_tty_struct(struct tty_struct *tty)
3518 {
3519         memset(tty, 0, sizeof(struct tty_struct));
3520         tty->magic = TTY_MAGIC;
3521         tty_ldisc_assign(tty, tty_ldisc_get(N_TTY));
3522         tty->pgrp = -1;
3523         tty->overrun_time = jiffies;
3524         tty->buf.head = tty->buf.tail = NULL;
3525         tty_buffer_init(tty);
3526         INIT_DELAYED_WORK(&tty->buf.work, flush_to_ldisc);
3527         init_MUTEX(&tty->buf.pty_sem);
3528         mutex_init(&tty->termios_mutex);
3529         init_waitqueue_head(&tty->write_wait);
3530         init_waitqueue_head(&tty->read_wait);
3531         INIT_WORK(&tty->hangup_work, do_tty_hangup);
3532         mutex_init(&tty->atomic_read_lock);
3533         mutex_init(&tty->atomic_write_lock);
3534         spin_lock_init(&tty->read_lock);
3535         INIT_LIST_HEAD(&tty->tty_files);
3536         INIT_WORK(&tty->SAK_work, NULL);
3537 }
3538
3539 /*
3540  * The default put_char routine if the driver did not define one.
3541  */
3542
3543 static void tty_default_put_char(struct tty_struct *tty, unsigned char ch)
3544 {
3545         tty->driver->write(tty, &ch, 1);
3546 }
3547
3548 static struct class *tty_class;
3549
3550 /**
3551  *      tty_register_device - register a tty device
3552  *      @driver: the tty driver that describes the tty device
3553  *      @index: the index in the tty driver for this tty device
3554  *      @device: a struct device that is associated with this tty device.
3555  *              This field is optional, if there is no known struct device
3556  *              for this tty device it can be set to NULL safely.
3557  *
3558  *      Returns a pointer to the struct device for this tty device
3559  *      (or ERR_PTR(-EFOO) on error).
3560  *
3561  *      This call is required to be made to register an individual tty device
3562  *      if the tty driver's flags have the TTY_DRIVER_DYNAMIC_DEV bit set.  If
3563  *      that bit is not set, this function should not be called by a tty
3564  *      driver.
3565  *
3566  *      Locking: ??
3567  */
3568
3569 struct device *tty_register_device(struct tty_driver *driver, unsigned index,
3570                                    struct device *device)
3571 {
3572         char name[64];
3573         dev_t dev = MKDEV(driver->major, driver->minor_start) + index;
3574
3575         if (index >= driver->num) {
3576                 printk(KERN_ERR "Attempt to register invalid tty line number "
3577                        " (%d).\n", index);
3578                 return ERR_PTR(-EINVAL);
3579         }
3580
3581         if (driver->type == TTY_DRIVER_TYPE_PTY)
3582                 pty_line_name(driver, index, name);
3583         else
3584                 tty_line_name(driver, index, name);
3585
3586         return device_create(tty_class, device, dev, name);
3587 }
3588
3589 /**
3590  *      tty_unregister_device - unregister a tty device
3591  *      @driver: the tty driver that describes the tty device
3592  *      @index: the index in the tty driver for this tty device
3593  *
3594  *      If a tty device is registered with a call to tty_register_device() then
3595  *      this function must be called when the tty device is gone.
3596  *
3597  *      Locking: ??
3598  */
3599
3600 void tty_unregister_device(struct tty_driver *driver, unsigned index)
3601 {
3602         device_destroy(tty_class, MKDEV(driver->major, driver->minor_start) + index);
3603 }
3604
3605 EXPORT_SYMBOL(tty_register_device);
3606 EXPORT_SYMBOL(tty_unregister_device);
3607
3608 struct tty_driver *alloc_tty_driver(int lines)
3609 {
3610         struct tty_driver *driver;
3611
3612         driver = kmalloc(sizeof(struct tty_driver), GFP_KERNEL);
3613         if (driver) {
3614                 memset(driver, 0, sizeof(struct tty_driver));
3615                 driver->magic = TTY_DRIVER_MAGIC;
3616                 driver->num = lines;
3617                 /* later we'll move allocation of tables here */
3618         }
3619         return driver;
3620 }
3621
3622 void put_tty_driver(struct tty_driver *driver)
3623 {
3624         kfree(driver);
3625 }
3626
3627 void tty_set_operations(struct tty_driver *driver,
3628                         const struct tty_operations *op)
3629 {
3630         driver->open = op->open;
3631         driver->close = op->close;
3632         driver->write = op->write;
3633         driver->put_char = op->put_char;
3634         driver->flush_chars = op->flush_chars;
3635         driver->write_room = op->write_room;
3636         driver->chars_in_buffer = op->chars_in_buffer;
3637         driver->ioctl = op->ioctl;
3638         driver->set_termios = op->set_termios;
3639         driver->throttle = op->throttle;
3640         driver->unthrottle = op->unthrottle;
3641         driver->stop = op->stop;
3642         driver->start = op->start;
3643         driver->hangup = op->hangup;
3644         driver->break_ctl = op->break_ctl;
3645         driver->flush_buffer = op->flush_buffer;
3646         driver->set_ldisc = op->set_ldisc;
3647         driver->wait_until_sent = op->wait_until_sent;
3648         driver->send_xchar = op->send_xchar;
3649         driver->read_proc = op->read_proc;
3650         driver->write_proc = op->write_proc;
3651         driver->tiocmget = op->tiocmget;
3652         driver->tiocmset = op->tiocmset;
3653 }
3654
3655
3656 EXPORT_SYMBOL(alloc_tty_driver);
3657 EXPORT_SYMBOL(put_tty_driver);
3658 EXPORT_SYMBOL(tty_set_operations);
3659
3660 /*
3661  * Called by a tty driver to register itself.
3662  */
3663 int tty_register_driver(struct tty_driver *driver)
3664 {
3665         int error;
3666         int i;
3667         dev_t dev;
3668         void **p = NULL;
3669
3670         if (driver->flags & TTY_DRIVER_INSTALLED)
3671                 return 0;
3672
3673         if (!(driver->flags & TTY_DRIVER_DEVPTS_MEM)) {
3674                 p = kmalloc(driver->num * 3 * sizeof(void *), GFP_KERNEL);
3675                 if (!p)
3676                         return -ENOMEM;
3677                 memset(p, 0, driver->num * 3 * sizeof(void *));
3678         }
3679
3680         if (!driver->major) {
3681                 error = alloc_chrdev_region(&dev, driver->minor_start, driver->num,
3682                                                 (char*)driver->name);
3683                 if (!error) {
3684                         driver->major = MAJOR(dev);
3685                         driver->minor_start = MINOR(dev);
3686                 }
3687         } else {
3688                 dev = MKDEV(driver->major, driver->minor_start);
3689                 error = register_chrdev_region(dev, driver->num,
3690                                                 (char*)driver->name);
3691         }
3692         if (error < 0) {
3693                 kfree(p);
3694                 return error;
3695         }
3696
3697         if (p) {
3698                 driver->ttys = (struct tty_struct **)p;
3699                 driver->termios = (struct ktermios **)(p + driver->num);
3700                 driver->termios_locked = (struct ktermios **)(p + driver->num * 2);
3701         } else {
3702                 driver->ttys = NULL;
3703                 driver->termios = NULL;
3704                 driver->termios_locked = NULL;
3705         }
3706
3707         cdev_init(&driver->cdev, &tty_fops);
3708         driver->cdev.owner = driver->owner;
3709         error = cdev_add(&driver->cdev, dev, driver->num);
3710         if (error) {
3711                 unregister_chrdev_region(dev, driver->num);
3712                 driver->ttys = NULL;
3713                 driver->termios = driver->termios_locked = NULL;
3714                 kfree(p);
3715                 return error;
3716         }
3717
3718         if (!driver->put_char)
3719                 driver->put_char = tty_default_put_char;
3720         
3721         list_add(&driver->tty_drivers, &tty_drivers);
3722         
3723         if ( !(driver->flags & TTY_DRIVER_DYNAMIC_DEV) ) {
3724                 for(i = 0; i < driver->num; i++)
3725                     tty_register_device(driver, i, NULL);
3726         }
3727         proc_tty_register_driver(driver);
3728         return 0;
3729 }
3730
3731 EXPORT_SYMBOL(tty_register_driver);
3732
3733 /*
3734  * Called by a tty driver to unregister itself.
3735  */
3736 int tty_unregister_driver(struct tty_driver *driver)
3737 {
3738         int i;
3739         struct ktermios *tp;
3740         void *p;
3741
3742         if (driver->refcount)
3743                 return -EBUSY;
3744
3745         unregister_chrdev_region(MKDEV(driver->major, driver->minor_start),
3746                                 driver->num);
3747
3748         list_del(&driver->tty_drivers);
3749
3750         /*
3751          * Free the termios and termios_locked structures because
3752          * we don't want to get memory leaks when modular tty
3753          * drivers are removed from the kernel.
3754          */
3755         for (i = 0; i < driver->num; i++) {
3756                 tp = driver->termios[i];
3757                 if (tp) {
3758                         driver->termios[i] = NULL;
3759                         kfree(tp);
3760                 }
3761                 tp = driver->termios_locked[i];
3762                 if (tp) {
3763                         driver->termios_locked[i] = NULL;
3764                         kfree(tp);
3765                 }
3766                 if (!(driver->flags & TTY_DRIVER_DYNAMIC_DEV))
3767                         tty_unregister_device(driver, i);
3768         }
3769         p = driver->ttys;
3770         proc_tty_unregister_driver(driver);
3771         driver->ttys = NULL;
3772         driver->termios = driver->termios_locked = NULL;
3773         kfree(p);
3774         cdev_del(&driver->cdev);
3775         return 0;
3776 }
3777 EXPORT_SYMBOL(tty_unregister_driver);
3778
3779 dev_t tty_devnum(struct tty_struct *tty)
3780 {
3781         return MKDEV(tty->driver->major, tty->driver->minor_start) + tty->index;
3782 }
3783 EXPORT_SYMBOL(tty_devnum);
3784
3785 void proc_clear_tty(struct task_struct *p)
3786 {
3787         spin_lock_irq(&p->sighand->siglock);
3788         p->signal->tty = NULL;
3789         spin_unlock_irq(&p->sighand->siglock);
3790 }
3791 EXPORT_SYMBOL(proc_clear_tty);
3792
3793 void __proc_set_tty(struct task_struct *tsk, struct tty_struct *tty)
3794 {
3795         if (tty) {
3796                 tty->session = process_session(tsk);
3797                 tty->pgrp = process_group(tsk);
3798         }
3799         tsk->signal->tty = tty;
3800         tsk->signal->tty_old_pgrp = 0;
3801 }
3802
3803 void proc_set_tty(struct task_struct *tsk, struct tty_struct *tty)
3804 {
3805         spin_lock_irq(&tsk->sighand->siglock);
3806         __proc_set_tty(tsk, tty);
3807         spin_unlock_irq(&tsk->sighand->siglock);
3808 }
3809
3810 struct tty_struct *get_current_tty(void)
3811 {
3812         struct tty_struct *tty;
3813         WARN_ON_ONCE(!mutex_is_locked(&tty_mutex));
3814         tty = current->signal->tty;
3815         /*
3816          * session->tty can be changed/cleared from under us, make sure we
3817          * issue the load. The obtained pointer, when not NULL, is valid as
3818          * long as we hold tty_mutex.
3819          */
3820         barrier();
3821         return tty;
3822 }
3823 EXPORT_SYMBOL_GPL(get_current_tty);
3824
3825 /*
3826  * Initialize the console device. This is called *early*, so
3827  * we can't necessarily depend on lots of kernel help here.
3828  * Just do some early initializations, and do the complex setup
3829  * later.
3830  */
3831 void __init console_init(void)
3832 {
3833         initcall_t *call;
3834
3835         /* Setup the default TTY line discipline. */
3836         (void) tty_register_ldisc(N_TTY, &tty_ldisc_N_TTY);
3837
3838         /*
3839          * set up the console device so that later boot sequences can 
3840          * inform about problems etc..
3841          */
3842 #ifdef CONFIG_EARLY_PRINTK
3843         disable_early_printk();
3844 #endif
3845         call = __con_initcall_start;
3846         while (call < __con_initcall_end) {
3847                 (*call)();
3848                 call++;
3849         }
3850 }
3851
3852 #ifdef CONFIG_VT
3853 extern int vty_init(void);
3854 #endif
3855
3856 static int __init tty_class_init(void)
3857 {
3858         tty_class = class_create(THIS_MODULE, "tty");
3859         if (IS_ERR(tty_class))
3860                 return PTR_ERR(tty_class);
3861         return 0;
3862 }
3863
3864 postcore_initcall(tty_class_init);
3865
3866 /* 3/2004 jmc: why do these devices exist? */
3867
3868 static struct cdev tty_cdev, console_cdev;
3869 #ifdef CONFIG_UNIX98_PTYS
3870 static struct cdev ptmx_cdev;
3871 #endif
3872 #ifdef CONFIG_VT
3873 static struct cdev vc0_cdev;
3874 #endif
3875
3876 /*
3877  * Ok, now we can initialize the rest of the tty devices and can count
3878  * on memory allocations, interrupts etc..
3879  */
3880 static int __init tty_init(void)
3881 {
3882         cdev_init(&tty_cdev, &tty_fops);
3883         if (cdev_add(&tty_cdev, MKDEV(TTYAUX_MAJOR, 0), 1) ||
3884             register_chrdev_region(MKDEV(TTYAUX_MAJOR, 0), 1, "/dev/tty") < 0)
3885                 panic("Couldn't register /dev/tty driver\n");
3886         device_create(tty_class, NULL, MKDEV(TTYAUX_MAJOR, 0), "tty");
3887
3888         cdev_init(&console_cdev, &console_fops);
3889         if (cdev_add(&console_cdev, MKDEV(TTYAUX_MAJOR, 1), 1) ||
3890             register_chrdev_region(MKDEV(TTYAUX_MAJOR, 1), 1, "/dev/console") < 0)
3891                 panic("Couldn't register /dev/console driver\n");
3892         device_create(tty_class, NULL, MKDEV(TTYAUX_MAJOR, 1), "console");
3893
3894 #ifdef CONFIG_UNIX98_PTYS
3895         cdev_init(&ptmx_cdev, &ptmx_fops);
3896         if (cdev_add(&ptmx_cdev, MKDEV(TTYAUX_MAJOR, 2), 1) ||
3897             register_chrdev_region(MKDEV(TTYAUX_MAJOR, 2), 1, "/dev/ptmx") < 0)
3898                 panic("Couldn't register /dev/ptmx driver\n");
3899         device_create(tty_class, NULL, MKDEV(TTYAUX_MAJOR, 2), "ptmx");
3900 #endif
3901
3902 #ifdef CONFIG_VT
3903         cdev_init(&vc0_cdev, &console_fops);
3904         if (cdev_add(&vc0_cdev, MKDEV(TTY_MAJOR, 0), 1) ||
3905             register_chrdev_region(MKDEV(TTY_MAJOR, 0), 1, "/dev/vc/0") < 0)
3906                 panic("Couldn't register /dev/tty0 driver\n");
3907         device_create(tty_class, NULL, MKDEV(TTY_MAJOR, 0), "tty0");
3908
3909         vty_init();
3910 #endif
3911         return 0;
3912 }
3913 module_init(tty_init);