Kernel bump from 4.1.3-rt to 4.1.7-rt.
[kvmfornfv.git] / kernel / drivers / tty / n_tty.c
1 /*
2  * n_tty.c --- implements the N_TTY line discipline.
3  *
4  * This code used to be in tty_io.c, but things are getting hairy
5  * enough that it made sense to split things off.  (The N_TTY
6  * processing has changed so much that it's hardly recognizable,
7  * anyway...)
8  *
9  * Note that the open routine for N_TTY is guaranteed never to return
10  * an error.  This is because Linux will fall back to setting a line
11  * to N_TTY if it can not switch to any other line discipline.
12  *
13  * Written by Theodore Ts'o, Copyright 1994.
14  *
15  * This file also contains code originally written by Linus Torvalds,
16  * Copyright 1991, 1992, 1993, and by Julian Cowley, Copyright 1994.
17  *
18  * This file may be redistributed under the terms of the GNU General Public
19  * License.
20  *
21  * Reduced memory usage for older ARM systems  - Russell King.
22  *
23  * 2000/01/20   Fixed SMP locking on put_tty_queue using bits of
24  *              the patch by Andrew J. Kroll <ag784@freenet.buffalo.edu>
25  *              who actually finally proved there really was a race.
26  *
27  * 2002/03/18   Implemented n_tty_wakeup to send SIGIO POLL_OUTs to
28  *              waiting writing processes-Sapan Bhatia <sapan@corewars.org>.
29  *              Also fixed a bug in BLOCKING mode where n_tty_write returns
30  *              EAGAIN
31  */
32
33 #include <linux/types.h>
34 #include <linux/major.h>
35 #include <linux/errno.h>
36 #include <linux/signal.h>
37 #include <linux/fcntl.h>
38 #include <linux/sched.h>
39 #include <linux/interrupt.h>
40 #include <linux/tty.h>
41 #include <linux/timer.h>
42 #include <linux/ctype.h>
43 #include <linux/mm.h>
44 #include <linux/string.h>
45 #include <linux/slab.h>
46 #include <linux/poll.h>
47 #include <linux/bitops.h>
48 #include <linux/audit.h>
49 #include <linux/file.h>
50 #include <linux/uaccess.h>
51 #include <linux/module.h>
52 #include <linux/ratelimit.h>
53 #include <linux/vmalloc.h>
54
55
56 /* number of characters left in xmit buffer before select has we have room */
57 #define WAKEUP_CHARS 256
58
59 /*
60  * This defines the low- and high-watermarks for throttling and
61  * unthrottling the TTY driver.  These watermarks are used for
62  * controlling the space in the read buffer.
63  */
64 #define TTY_THRESHOLD_THROTTLE          128 /* now based on remaining room */
65 #define TTY_THRESHOLD_UNTHROTTLE        128
66
67 /*
68  * Special byte codes used in the echo buffer to represent operations
69  * or special handling of characters.  Bytes in the echo buffer that
70  * are not part of such special blocks are treated as normal character
71  * codes.
72  */
73 #define ECHO_OP_START 0xff
74 #define ECHO_OP_MOVE_BACK_COL 0x80
75 #define ECHO_OP_SET_CANON_COL 0x81
76 #define ECHO_OP_ERASE_TAB 0x82
77
78 #define ECHO_COMMIT_WATERMARK   256
79 #define ECHO_BLOCK              256
80 #define ECHO_DISCARD_WATERMARK  N_TTY_BUF_SIZE - (ECHO_BLOCK + 32)
81
82
83 #undef N_TTY_TRACE
84 #ifdef N_TTY_TRACE
85 # define n_tty_trace(f, args...)        trace_printk(f, ##args)
86 #else
87 # define n_tty_trace(f, args...)
88 #endif
89
90 struct n_tty_data {
91         /* producer-published */
92         size_t read_head;
93         size_t commit_head;
94         size_t canon_head;
95         size_t echo_head;
96         size_t echo_commit;
97         size_t echo_mark;
98         DECLARE_BITMAP(char_map, 256);
99
100         /* private to n_tty_receive_overrun (single-threaded) */
101         unsigned long overrun_time;
102         int num_overrun;
103
104         /* non-atomic */
105         bool no_room;
106
107         /* must hold exclusive termios_rwsem to reset these */
108         unsigned char lnext:1, erasing:1, raw:1, real_raw:1, icanon:1;
109         unsigned char push:1;
110
111         /* shared by producer and consumer */
112         char read_buf[N_TTY_BUF_SIZE];
113         DECLARE_BITMAP(read_flags, N_TTY_BUF_SIZE);
114         unsigned char echo_buf[N_TTY_BUF_SIZE];
115
116         int minimum_to_wake;
117
118         /* consumer-published */
119         size_t read_tail;
120         size_t line_start;
121
122         /* protected by output lock */
123         unsigned int column;
124         unsigned int canon_column;
125         size_t echo_tail;
126
127         struct mutex atomic_read_lock;
128         struct mutex output_lock;
129 };
130
131 static inline size_t read_cnt(struct n_tty_data *ldata)
132 {
133         return ldata->read_head - ldata->read_tail;
134 }
135
136 static inline unsigned char read_buf(struct n_tty_data *ldata, size_t i)
137 {
138         return ldata->read_buf[i & (N_TTY_BUF_SIZE - 1)];
139 }
140
141 static inline unsigned char *read_buf_addr(struct n_tty_data *ldata, size_t i)
142 {
143         return &ldata->read_buf[i & (N_TTY_BUF_SIZE - 1)];
144 }
145
146 static inline unsigned char echo_buf(struct n_tty_data *ldata, size_t i)
147 {
148         return ldata->echo_buf[i & (N_TTY_BUF_SIZE - 1)];
149 }
150
151 static inline unsigned char *echo_buf_addr(struct n_tty_data *ldata, size_t i)
152 {
153         return &ldata->echo_buf[i & (N_TTY_BUF_SIZE - 1)];
154 }
155
156 static inline int tty_put_user(struct tty_struct *tty, unsigned char x,
157                                unsigned char __user *ptr)
158 {
159         struct n_tty_data *ldata = tty->disc_data;
160
161         tty_audit_add_data(tty, &x, 1, ldata->icanon);
162         return put_user(x, ptr);
163 }
164
165 static inline int tty_copy_to_user(struct tty_struct *tty,
166                                         void __user *to,
167                                         const void *from,
168                                         unsigned long n)
169 {
170         struct n_tty_data *ldata = tty->disc_data;
171
172         tty_audit_add_data(tty, to, n, ldata->icanon);
173         return copy_to_user(to, from, n);
174 }
175
176 /**
177  *      n_tty_kick_worker - start input worker (if required)
178  *      @tty: terminal
179  *
180  *      Re-schedules the flip buffer work if it may have stopped
181  *
182  *      Caller holds exclusive termios_rwsem
183  *         or
184  *      n_tty_read()/consumer path:
185  *              holds non-exclusive termios_rwsem
186  */
187
188 static void n_tty_kick_worker(struct tty_struct *tty)
189 {
190         struct n_tty_data *ldata = tty->disc_data;
191
192         /* Did the input worker stop? Restart it */
193         if (unlikely(ldata->no_room)) {
194                 ldata->no_room = 0;
195
196                 WARN_RATELIMIT(tty->port->itty == NULL,
197                                 "scheduling with invalid itty\n");
198                 /* see if ldisc has been killed - if so, this means that
199                  * even though the ldisc has been halted and ->buf.work
200                  * cancelled, ->buf.work is about to be rescheduled
201                  */
202                 WARN_RATELIMIT(test_bit(TTY_LDISC_HALTED, &tty->flags),
203                                "scheduling buffer work for halted ldisc\n");
204                 queue_work(system_unbound_wq, &tty->port->buf.work);
205         }
206 }
207
208 static ssize_t chars_in_buffer(struct tty_struct *tty)
209 {
210         struct n_tty_data *ldata = tty->disc_data;
211         ssize_t n = 0;
212
213         if (!ldata->icanon)
214                 n = ldata->commit_head - ldata->read_tail;
215         else
216                 n = ldata->canon_head - ldata->read_tail;
217         return n;
218 }
219
220 /**
221  *      n_tty_write_wakeup      -       asynchronous I/O notifier
222  *      @tty: tty device
223  *
224  *      Required for the ptys, serial driver etc. since processes
225  *      that attach themselves to the master and rely on ASYNC
226  *      IO must be woken up
227  */
228
229 static void n_tty_write_wakeup(struct tty_struct *tty)
230 {
231         if (tty->fasync && test_and_clear_bit(TTY_DO_WRITE_WAKEUP, &tty->flags))
232                 kill_fasync(&tty->fasync, SIGIO, POLL_OUT);
233 }
234
235 static void n_tty_check_throttle(struct tty_struct *tty)
236 {
237         struct n_tty_data *ldata = tty->disc_data;
238
239         /*
240          * Check the remaining room for the input canonicalization
241          * mode.  We don't want to throttle the driver if we're in
242          * canonical mode and don't have a newline yet!
243          */
244         if (ldata->icanon && ldata->canon_head == ldata->read_tail)
245                 return;
246
247         while (1) {
248                 int throttled;
249                 tty_set_flow_change(tty, TTY_THROTTLE_SAFE);
250                 if (N_TTY_BUF_SIZE - read_cnt(ldata) >= TTY_THRESHOLD_THROTTLE)
251                         break;
252                 throttled = tty_throttle_safe(tty);
253                 if (!throttled)
254                         break;
255         }
256         __tty_set_flow_change(tty, 0);
257 }
258
259 static void n_tty_check_unthrottle(struct tty_struct *tty)
260 {
261         if (tty->driver->type == TTY_DRIVER_TYPE_PTY &&
262             tty->link->ldisc->ops->write_wakeup == n_tty_write_wakeup) {
263                 if (chars_in_buffer(tty) > TTY_THRESHOLD_UNTHROTTLE)
264                         return;
265                 if (!tty->count)
266                         return;
267                 n_tty_kick_worker(tty);
268                 n_tty_write_wakeup(tty->link);
269                 if (waitqueue_active(&tty->link->write_wait))
270                         wake_up_interruptible_poll(&tty->link->write_wait, POLLOUT);
271                 return;
272         }
273
274         /* If there is enough space in the read buffer now, let the
275          * low-level driver know. We use chars_in_buffer() to
276          * check the buffer, as it now knows about canonical mode.
277          * Otherwise, if the driver is throttled and the line is
278          * longer than TTY_THRESHOLD_UNTHROTTLE in canonical mode,
279          * we won't get any more characters.
280          */
281
282         while (1) {
283                 int unthrottled;
284                 tty_set_flow_change(tty, TTY_UNTHROTTLE_SAFE);
285                 if (chars_in_buffer(tty) > TTY_THRESHOLD_UNTHROTTLE)
286                         break;
287                 if (!tty->count)
288                         break;
289                 n_tty_kick_worker(tty);
290                 unthrottled = tty_unthrottle_safe(tty);
291                 if (!unthrottled)
292                         break;
293         }
294         __tty_set_flow_change(tty, 0);
295 }
296
297 /**
298  *      put_tty_queue           -       add character to tty
299  *      @c: character
300  *      @ldata: n_tty data
301  *
302  *      Add a character to the tty read_buf queue.
303  *
304  *      n_tty_receive_buf()/producer path:
305  *              caller holds non-exclusive termios_rwsem
306  */
307
308 static inline void put_tty_queue(unsigned char c, struct n_tty_data *ldata)
309 {
310         *read_buf_addr(ldata, ldata->read_head) = c;
311         ldata->read_head++;
312 }
313
314 /**
315  *      reset_buffer_flags      -       reset buffer state
316  *      @tty: terminal to reset
317  *
318  *      Reset the read buffer counters and clear the flags.
319  *      Called from n_tty_open() and n_tty_flush_buffer().
320  *
321  *      Locking: caller holds exclusive termios_rwsem
322  *               (or locking is not required)
323  */
324
325 static void reset_buffer_flags(struct n_tty_data *ldata)
326 {
327         ldata->read_head = ldata->canon_head = ldata->read_tail = 0;
328         ldata->echo_head = ldata->echo_tail = ldata->echo_commit = 0;
329         ldata->commit_head = 0;
330         ldata->echo_mark = 0;
331         ldata->line_start = 0;
332
333         ldata->erasing = 0;
334         bitmap_zero(ldata->read_flags, N_TTY_BUF_SIZE);
335         ldata->push = 0;
336 }
337
338 static void n_tty_packet_mode_flush(struct tty_struct *tty)
339 {
340         unsigned long flags;
341
342         if (tty->link->packet) {
343                 spin_lock_irqsave(&tty->ctrl_lock, flags);
344                 tty->ctrl_status |= TIOCPKT_FLUSHREAD;
345                 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
346                 if (waitqueue_active(&tty->link->read_wait))
347                         wake_up_interruptible(&tty->link->read_wait);
348         }
349 }
350
351 /**
352  *      n_tty_flush_buffer      -       clean input queue
353  *      @tty:   terminal device
354  *
355  *      Flush the input buffer. Called when the tty layer wants the
356  *      buffer flushed (eg at hangup) or when the N_TTY line discipline
357  *      internally has to clean the pending queue (for example some signals).
358  *
359  *      Holds termios_rwsem to exclude producer/consumer while
360  *      buffer indices are reset.
361  *
362  *      Locking: ctrl_lock, exclusive termios_rwsem
363  */
364
365 static void n_tty_flush_buffer(struct tty_struct *tty)
366 {
367         down_write(&tty->termios_rwsem);
368         reset_buffer_flags(tty->disc_data);
369         n_tty_kick_worker(tty);
370
371         if (tty->link)
372                 n_tty_packet_mode_flush(tty);
373         up_write(&tty->termios_rwsem);
374 }
375
376 /**
377  *      n_tty_chars_in_buffer   -       report available bytes
378  *      @tty: tty device
379  *
380  *      Report the number of characters buffered to be delivered to user
381  *      at this instant in time.
382  *
383  *      Locking: exclusive termios_rwsem
384  */
385
386 static ssize_t n_tty_chars_in_buffer(struct tty_struct *tty)
387 {
388         ssize_t n;
389
390         WARN_ONCE(1, "%s is deprecated and scheduled for removal.", __func__);
391
392         down_write(&tty->termios_rwsem);
393         n = chars_in_buffer(tty);
394         up_write(&tty->termios_rwsem);
395         return n;
396 }
397
398 /**
399  *      is_utf8_continuation    -       utf8 multibyte check
400  *      @c: byte to check
401  *
402  *      Returns true if the utf8 character 'c' is a multibyte continuation
403  *      character. We use this to correctly compute the on screen size
404  *      of the character when printing
405  */
406
407 static inline int is_utf8_continuation(unsigned char c)
408 {
409         return (c & 0xc0) == 0x80;
410 }
411
412 /**
413  *      is_continuation         -       multibyte check
414  *      @c: byte to check
415  *
416  *      Returns true if the utf8 character 'c' is a multibyte continuation
417  *      character and the terminal is in unicode mode.
418  */
419
420 static inline int is_continuation(unsigned char c, struct tty_struct *tty)
421 {
422         return I_IUTF8(tty) && is_utf8_continuation(c);
423 }
424
425 /**
426  *      do_output_char                  -       output one character
427  *      @c: character (or partial unicode symbol)
428  *      @tty: terminal device
429  *      @space: space available in tty driver write buffer
430  *
431  *      This is a helper function that handles one output character
432  *      (including special characters like TAB, CR, LF, etc.),
433  *      doing OPOST processing and putting the results in the
434  *      tty driver's write buffer.
435  *
436  *      Note that Linux currently ignores TABDLY, CRDLY, VTDLY, FFDLY
437  *      and NLDLY.  They simply aren't relevant in the world today.
438  *      If you ever need them, add them here.
439  *
440  *      Returns the number of bytes of buffer space used or -1 if
441  *      no space left.
442  *
443  *      Locking: should be called under the output_lock to protect
444  *               the column state and space left in the buffer
445  */
446
447 static int do_output_char(unsigned char c, struct tty_struct *tty, int space)
448 {
449         struct n_tty_data *ldata = tty->disc_data;
450         int     spaces;
451
452         if (!space)
453                 return -1;
454
455         switch (c) {
456         case '\n':
457                 if (O_ONLRET(tty))
458                         ldata->column = 0;
459                 if (O_ONLCR(tty)) {
460                         if (space < 2)
461                                 return -1;
462                         ldata->canon_column = ldata->column = 0;
463                         tty->ops->write(tty, "\r\n", 2);
464                         return 2;
465                 }
466                 ldata->canon_column = ldata->column;
467                 break;
468         case '\r':
469                 if (O_ONOCR(tty) && ldata->column == 0)
470                         return 0;
471                 if (O_OCRNL(tty)) {
472                         c = '\n';
473                         if (O_ONLRET(tty))
474                                 ldata->canon_column = ldata->column = 0;
475                         break;
476                 }
477                 ldata->canon_column = ldata->column = 0;
478                 break;
479         case '\t':
480                 spaces = 8 - (ldata->column & 7);
481                 if (O_TABDLY(tty) == XTABS) {
482                         if (space < spaces)
483                                 return -1;
484                         ldata->column += spaces;
485                         tty->ops->write(tty, "        ", spaces);
486                         return spaces;
487                 }
488                 ldata->column += spaces;
489                 break;
490         case '\b':
491                 if (ldata->column > 0)
492                         ldata->column--;
493                 break;
494         default:
495                 if (!iscntrl(c)) {
496                         if (O_OLCUC(tty))
497                                 c = toupper(c);
498                         if (!is_continuation(c, tty))
499                                 ldata->column++;
500                 }
501                 break;
502         }
503
504         tty_put_char(tty, c);
505         return 1;
506 }
507
508 /**
509  *      process_output                  -       output post processor
510  *      @c: character (or partial unicode symbol)
511  *      @tty: terminal device
512  *
513  *      Output one character with OPOST processing.
514  *      Returns -1 when the output device is full and the character
515  *      must be retried.
516  *
517  *      Locking: output_lock to protect column state and space left
518  *               (also, this is called from n_tty_write under the
519  *                tty layer write lock)
520  */
521
522 static int process_output(unsigned char c, struct tty_struct *tty)
523 {
524         struct n_tty_data *ldata = tty->disc_data;
525         int     space, retval;
526
527         mutex_lock(&ldata->output_lock);
528
529         space = tty_write_room(tty);
530         retval = do_output_char(c, tty, space);
531
532         mutex_unlock(&ldata->output_lock);
533         if (retval < 0)
534                 return -1;
535         else
536                 return 0;
537 }
538
539 /**
540  *      process_output_block            -       block post processor
541  *      @tty: terminal device
542  *      @buf: character buffer
543  *      @nr: number of bytes to output
544  *
545  *      Output a block of characters with OPOST processing.
546  *      Returns the number of characters output.
547  *
548  *      This path is used to speed up block console writes, among other
549  *      things when processing blocks of output data. It handles only
550  *      the simple cases normally found and helps to generate blocks of
551  *      symbols for the console driver and thus improve performance.
552  *
553  *      Locking: output_lock to protect column state and space left
554  *               (also, this is called from n_tty_write under the
555  *                tty layer write lock)
556  */
557
558 static ssize_t process_output_block(struct tty_struct *tty,
559                                     const unsigned char *buf, unsigned int nr)
560 {
561         struct n_tty_data *ldata = tty->disc_data;
562         int     space;
563         int     i;
564         const unsigned char *cp;
565
566         mutex_lock(&ldata->output_lock);
567
568         space = tty_write_room(tty);
569         if (!space) {
570                 mutex_unlock(&ldata->output_lock);
571                 return 0;
572         }
573         if (nr > space)
574                 nr = space;
575
576         for (i = 0, cp = buf; i < nr; i++, cp++) {
577                 unsigned char c = *cp;
578
579                 switch (c) {
580                 case '\n':
581                         if (O_ONLRET(tty))
582                                 ldata->column = 0;
583                         if (O_ONLCR(tty))
584                                 goto break_out;
585                         ldata->canon_column = ldata->column;
586                         break;
587                 case '\r':
588                         if (O_ONOCR(tty) && ldata->column == 0)
589                                 goto break_out;
590                         if (O_OCRNL(tty))
591                                 goto break_out;
592                         ldata->canon_column = ldata->column = 0;
593                         break;
594                 case '\t':
595                         goto break_out;
596                 case '\b':
597                         if (ldata->column > 0)
598                                 ldata->column--;
599                         break;
600                 default:
601                         if (!iscntrl(c)) {
602                                 if (O_OLCUC(tty))
603                                         goto break_out;
604                                 if (!is_continuation(c, tty))
605                                         ldata->column++;
606                         }
607                         break;
608                 }
609         }
610 break_out:
611         i = tty->ops->write(tty, buf, i);
612
613         mutex_unlock(&ldata->output_lock);
614         return i;
615 }
616
617 /**
618  *      process_echoes  -       write pending echo characters
619  *      @tty: terminal device
620  *
621  *      Write previously buffered echo (and other ldisc-generated)
622  *      characters to the tty.
623  *
624  *      Characters generated by the ldisc (including echoes) need to
625  *      be buffered because the driver's write buffer can fill during
626  *      heavy program output.  Echoing straight to the driver will
627  *      often fail under these conditions, causing lost characters and
628  *      resulting mismatches of ldisc state information.
629  *
630  *      Since the ldisc state must represent the characters actually sent
631  *      to the driver at the time of the write, operations like certain
632  *      changes in column state are also saved in the buffer and executed
633  *      here.
634  *
635  *      A circular fifo buffer is used so that the most recent characters
636  *      are prioritized.  Also, when control characters are echoed with a
637  *      prefixed "^", the pair is treated atomically and thus not separated.
638  *
639  *      Locking: callers must hold output_lock
640  */
641
642 static size_t __process_echoes(struct tty_struct *tty)
643 {
644         struct n_tty_data *ldata = tty->disc_data;
645         int     space, old_space;
646         size_t tail;
647         unsigned char c;
648
649         old_space = space = tty_write_room(tty);
650
651         tail = ldata->echo_tail;
652         while (ldata->echo_commit != tail) {
653                 c = echo_buf(ldata, tail);
654                 if (c == ECHO_OP_START) {
655                         unsigned char op;
656                         int no_space_left = 0;
657
658                         /*
659                          * If the buffer byte is the start of a multi-byte
660                          * operation, get the next byte, which is either the
661                          * op code or a control character value.
662                          */
663                         op = echo_buf(ldata, tail + 1);
664
665                         switch (op) {
666                                 unsigned int num_chars, num_bs;
667
668                         case ECHO_OP_ERASE_TAB:
669                                 num_chars = echo_buf(ldata, tail + 2);
670
671                                 /*
672                                  * Determine how many columns to go back
673                                  * in order to erase the tab.
674                                  * This depends on the number of columns
675                                  * used by other characters within the tab
676                                  * area.  If this (modulo 8) count is from
677                                  * the start of input rather than from a
678                                  * previous tab, we offset by canon column.
679                                  * Otherwise, tab spacing is normal.
680                                  */
681                                 if (!(num_chars & 0x80))
682                                         num_chars += ldata->canon_column;
683                                 num_bs = 8 - (num_chars & 7);
684
685                                 if (num_bs > space) {
686                                         no_space_left = 1;
687                                         break;
688                                 }
689                                 space -= num_bs;
690                                 while (num_bs--) {
691                                         tty_put_char(tty, '\b');
692                                         if (ldata->column > 0)
693                                                 ldata->column--;
694                                 }
695                                 tail += 3;
696                                 break;
697
698                         case ECHO_OP_SET_CANON_COL:
699                                 ldata->canon_column = ldata->column;
700                                 tail += 2;
701                                 break;
702
703                         case ECHO_OP_MOVE_BACK_COL:
704                                 if (ldata->column > 0)
705                                         ldata->column--;
706                                 tail += 2;
707                                 break;
708
709                         case ECHO_OP_START:
710                                 /* This is an escaped echo op start code */
711                                 if (!space) {
712                                         no_space_left = 1;
713                                         break;
714                                 }
715                                 tty_put_char(tty, ECHO_OP_START);
716                                 ldata->column++;
717                                 space--;
718                                 tail += 2;
719                                 break;
720
721                         default:
722                                 /*
723                                  * If the op is not a special byte code,
724                                  * it is a ctrl char tagged to be echoed
725                                  * as "^X" (where X is the letter
726                                  * representing the control char).
727                                  * Note that we must ensure there is
728                                  * enough space for the whole ctrl pair.
729                                  *
730                                  */
731                                 if (space < 2) {
732                                         no_space_left = 1;
733                                         break;
734                                 }
735                                 tty_put_char(tty, '^');
736                                 tty_put_char(tty, op ^ 0100);
737                                 ldata->column += 2;
738                                 space -= 2;
739                                 tail += 2;
740                         }
741
742                         if (no_space_left)
743                                 break;
744                 } else {
745                         if (O_OPOST(tty)) {
746                                 int retval = do_output_char(c, tty, space);
747                                 if (retval < 0)
748                                         break;
749                                 space -= retval;
750                         } else {
751                                 if (!space)
752                                         break;
753                                 tty_put_char(tty, c);
754                                 space -= 1;
755                         }
756                         tail += 1;
757                 }
758         }
759
760         /* If the echo buffer is nearly full (so that the possibility exists
761          * of echo overrun before the next commit), then discard enough
762          * data at the tail to prevent a subsequent overrun */
763         while (ldata->echo_commit - tail >= ECHO_DISCARD_WATERMARK) {
764                 if (echo_buf(ldata, tail) == ECHO_OP_START) {
765                         if (echo_buf(ldata, tail + 1) == ECHO_OP_ERASE_TAB)
766                                 tail += 3;
767                         else
768                                 tail += 2;
769                 } else
770                         tail++;
771         }
772
773         ldata->echo_tail = tail;
774         return old_space - space;
775 }
776
777 static void commit_echoes(struct tty_struct *tty)
778 {
779         struct n_tty_data *ldata = tty->disc_data;
780         size_t nr, old, echoed;
781         size_t head;
782
783         head = ldata->echo_head;
784         ldata->echo_mark = head;
785         old = ldata->echo_commit - ldata->echo_tail;
786
787         /* Process committed echoes if the accumulated # of bytes
788          * is over the threshold (and try again each time another
789          * block is accumulated) */
790         nr = head - ldata->echo_tail;
791         if (nr < ECHO_COMMIT_WATERMARK || (nr % ECHO_BLOCK > old % ECHO_BLOCK))
792                 return;
793
794         mutex_lock(&ldata->output_lock);
795         ldata->echo_commit = head;
796         echoed = __process_echoes(tty);
797         mutex_unlock(&ldata->output_lock);
798
799         if (echoed && tty->ops->flush_chars)
800                 tty->ops->flush_chars(tty);
801 }
802
803 static void process_echoes(struct tty_struct *tty)
804 {
805         struct n_tty_data *ldata = tty->disc_data;
806         size_t echoed;
807
808         if (ldata->echo_mark == ldata->echo_tail)
809                 return;
810
811         mutex_lock(&ldata->output_lock);
812         ldata->echo_commit = ldata->echo_mark;
813         echoed = __process_echoes(tty);
814         mutex_unlock(&ldata->output_lock);
815
816         if (echoed && tty->ops->flush_chars)
817                 tty->ops->flush_chars(tty);
818 }
819
820 /* NB: echo_mark and echo_head should be equivalent here */
821 static void flush_echoes(struct tty_struct *tty)
822 {
823         struct n_tty_data *ldata = tty->disc_data;
824
825         if ((!L_ECHO(tty) && !L_ECHONL(tty)) ||
826             ldata->echo_commit == ldata->echo_head)
827                 return;
828
829         mutex_lock(&ldata->output_lock);
830         ldata->echo_commit = ldata->echo_head;
831         __process_echoes(tty);
832         mutex_unlock(&ldata->output_lock);
833 }
834
835 /**
836  *      add_echo_byte   -       add a byte to the echo buffer
837  *      @c: unicode byte to echo
838  *      @ldata: n_tty data
839  *
840  *      Add a character or operation byte to the echo buffer.
841  */
842
843 static inline void add_echo_byte(unsigned char c, struct n_tty_data *ldata)
844 {
845         *echo_buf_addr(ldata, ldata->echo_head++) = c;
846 }
847
848 /**
849  *      echo_move_back_col      -       add operation to move back a column
850  *      @ldata: n_tty data
851  *
852  *      Add an operation to the echo buffer to move back one column.
853  */
854
855 static void echo_move_back_col(struct n_tty_data *ldata)
856 {
857         add_echo_byte(ECHO_OP_START, ldata);
858         add_echo_byte(ECHO_OP_MOVE_BACK_COL, ldata);
859 }
860
861 /**
862  *      echo_set_canon_col      -       add operation to set the canon column
863  *      @ldata: n_tty data
864  *
865  *      Add an operation to the echo buffer to set the canon column
866  *      to the current column.
867  */
868
869 static void echo_set_canon_col(struct n_tty_data *ldata)
870 {
871         add_echo_byte(ECHO_OP_START, ldata);
872         add_echo_byte(ECHO_OP_SET_CANON_COL, ldata);
873 }
874
875 /**
876  *      echo_erase_tab  -       add operation to erase a tab
877  *      @num_chars: number of character columns already used
878  *      @after_tab: true if num_chars starts after a previous tab
879  *      @ldata: n_tty data
880  *
881  *      Add an operation to the echo buffer to erase a tab.
882  *
883  *      Called by the eraser function, which knows how many character
884  *      columns have been used since either a previous tab or the start
885  *      of input.  This information will be used later, along with
886  *      canon column (if applicable), to go back the correct number
887  *      of columns.
888  */
889
890 static void echo_erase_tab(unsigned int num_chars, int after_tab,
891                            struct n_tty_data *ldata)
892 {
893         add_echo_byte(ECHO_OP_START, ldata);
894         add_echo_byte(ECHO_OP_ERASE_TAB, ldata);
895
896         /* We only need to know this modulo 8 (tab spacing) */
897         num_chars &= 7;
898
899         /* Set the high bit as a flag if num_chars is after a previous tab */
900         if (after_tab)
901                 num_chars |= 0x80;
902
903         add_echo_byte(num_chars, ldata);
904 }
905
906 /**
907  *      echo_char_raw   -       echo a character raw
908  *      @c: unicode byte to echo
909  *      @tty: terminal device
910  *
911  *      Echo user input back onto the screen. This must be called only when
912  *      L_ECHO(tty) is true. Called from the driver receive_buf path.
913  *
914  *      This variant does not treat control characters specially.
915  */
916
917 static void echo_char_raw(unsigned char c, struct n_tty_data *ldata)
918 {
919         if (c == ECHO_OP_START) {
920                 add_echo_byte(ECHO_OP_START, ldata);
921                 add_echo_byte(ECHO_OP_START, ldata);
922         } else {
923                 add_echo_byte(c, ldata);
924         }
925 }
926
927 /**
928  *      echo_char       -       echo a character
929  *      @c: unicode byte to echo
930  *      @tty: terminal device
931  *
932  *      Echo user input back onto the screen. This must be called only when
933  *      L_ECHO(tty) is true. Called from the driver receive_buf path.
934  *
935  *      This variant tags control characters to be echoed as "^X"
936  *      (where X is the letter representing the control char).
937  */
938
939 static void echo_char(unsigned char c, struct tty_struct *tty)
940 {
941         struct n_tty_data *ldata = tty->disc_data;
942
943         if (c == ECHO_OP_START) {
944                 add_echo_byte(ECHO_OP_START, ldata);
945                 add_echo_byte(ECHO_OP_START, ldata);
946         } else {
947                 if (L_ECHOCTL(tty) && iscntrl(c) && c != '\t')
948                         add_echo_byte(ECHO_OP_START, ldata);
949                 add_echo_byte(c, ldata);
950         }
951 }
952
953 /**
954  *      finish_erasing          -       complete erase
955  *      @ldata: n_tty data
956  */
957
958 static inline void finish_erasing(struct n_tty_data *ldata)
959 {
960         if (ldata->erasing) {
961                 echo_char_raw('/', ldata);
962                 ldata->erasing = 0;
963         }
964 }
965
966 /**
967  *      eraser          -       handle erase function
968  *      @c: character input
969  *      @tty: terminal device
970  *
971  *      Perform erase and necessary output when an erase character is
972  *      present in the stream from the driver layer. Handles the complexities
973  *      of UTF-8 multibyte symbols.
974  *
975  *      n_tty_receive_buf()/producer path:
976  *              caller holds non-exclusive termios_rwsem
977  */
978
979 static void eraser(unsigned char c, struct tty_struct *tty)
980 {
981         struct n_tty_data *ldata = tty->disc_data;
982         enum { ERASE, WERASE, KILL } kill_type;
983         size_t head;
984         size_t cnt;
985         int seen_alnums;
986
987         if (ldata->read_head == ldata->canon_head) {
988                 /* process_output('\a', tty); */ /* what do you think? */
989                 return;
990         }
991         if (c == ERASE_CHAR(tty))
992                 kill_type = ERASE;
993         else if (c == WERASE_CHAR(tty))
994                 kill_type = WERASE;
995         else {
996                 if (!L_ECHO(tty)) {
997                         ldata->read_head = ldata->canon_head;
998                         return;
999                 }
1000                 if (!L_ECHOK(tty) || !L_ECHOKE(tty) || !L_ECHOE(tty)) {
1001                         ldata->read_head = ldata->canon_head;
1002                         finish_erasing(ldata);
1003                         echo_char(KILL_CHAR(tty), tty);
1004                         /* Add a newline if ECHOK is on and ECHOKE is off. */
1005                         if (L_ECHOK(tty))
1006                                 echo_char_raw('\n', ldata);
1007                         return;
1008                 }
1009                 kill_type = KILL;
1010         }
1011
1012         seen_alnums = 0;
1013         while (ldata->read_head != ldata->canon_head) {
1014                 head = ldata->read_head;
1015
1016                 /* erase a single possibly multibyte character */
1017                 do {
1018                         head--;
1019                         c = read_buf(ldata, head);
1020                 } while (is_continuation(c, tty) && head != ldata->canon_head);
1021
1022                 /* do not partially erase */
1023                 if (is_continuation(c, tty))
1024                         break;
1025
1026                 if (kill_type == WERASE) {
1027                         /* Equivalent to BSD's ALTWERASE. */
1028                         if (isalnum(c) || c == '_')
1029                                 seen_alnums++;
1030                         else if (seen_alnums)
1031                                 break;
1032                 }
1033                 cnt = ldata->read_head - head;
1034                 ldata->read_head = head;
1035                 if (L_ECHO(tty)) {
1036                         if (L_ECHOPRT(tty)) {
1037                                 if (!ldata->erasing) {
1038                                         echo_char_raw('\\', ldata);
1039                                         ldata->erasing = 1;
1040                                 }
1041                                 /* if cnt > 1, output a multi-byte character */
1042                                 echo_char(c, tty);
1043                                 while (--cnt > 0) {
1044                                         head++;
1045                                         echo_char_raw(read_buf(ldata, head), ldata);
1046                                         echo_move_back_col(ldata);
1047                                 }
1048                         } else if (kill_type == ERASE && !L_ECHOE(tty)) {
1049                                 echo_char(ERASE_CHAR(tty), tty);
1050                         } else if (c == '\t') {
1051                                 unsigned int num_chars = 0;
1052                                 int after_tab = 0;
1053                                 size_t tail = ldata->read_head;
1054
1055                                 /*
1056                                  * Count the columns used for characters
1057                                  * since the start of input or after a
1058                                  * previous tab.
1059                                  * This info is used to go back the correct
1060                                  * number of columns.
1061                                  */
1062                                 while (tail != ldata->canon_head) {
1063                                         tail--;
1064                                         c = read_buf(ldata, tail);
1065                                         if (c == '\t') {
1066                                                 after_tab = 1;
1067                                                 break;
1068                                         } else if (iscntrl(c)) {
1069                                                 if (L_ECHOCTL(tty))
1070                                                         num_chars += 2;
1071                                         } else if (!is_continuation(c, tty)) {
1072                                                 num_chars++;
1073                                         }
1074                                 }
1075                                 echo_erase_tab(num_chars, after_tab, ldata);
1076                         } else {
1077                                 if (iscntrl(c) && L_ECHOCTL(tty)) {
1078                                         echo_char_raw('\b', ldata);
1079                                         echo_char_raw(' ', ldata);
1080                                         echo_char_raw('\b', ldata);
1081                                 }
1082                                 if (!iscntrl(c) || L_ECHOCTL(tty)) {
1083                                         echo_char_raw('\b', ldata);
1084                                         echo_char_raw(' ', ldata);
1085                                         echo_char_raw('\b', ldata);
1086                                 }
1087                         }
1088                 }
1089                 if (kill_type == ERASE)
1090                         break;
1091         }
1092         if (ldata->read_head == ldata->canon_head && L_ECHO(tty))
1093                 finish_erasing(ldata);
1094 }
1095
1096 /**
1097  *      isig            -       handle the ISIG optio
1098  *      @sig: signal
1099  *      @tty: terminal
1100  *
1101  *      Called when a signal is being sent due to terminal input.
1102  *      Called from the driver receive_buf path so serialized.
1103  *
1104  *      Performs input and output flush if !NOFLSH. In this context, the echo
1105  *      buffer is 'output'. The signal is processed first to alert any current
1106  *      readers or writers to discontinue and exit their i/o loops.
1107  *
1108  *      Locking: ctrl_lock
1109  */
1110
1111 static void __isig(int sig, struct tty_struct *tty)
1112 {
1113         struct pid *tty_pgrp = tty_get_pgrp(tty);
1114         if (tty_pgrp) {
1115                 kill_pgrp(tty_pgrp, sig, 1);
1116                 put_pid(tty_pgrp);
1117         }
1118 }
1119
1120 static void isig(int sig, struct tty_struct *tty)
1121 {
1122         struct n_tty_data *ldata = tty->disc_data;
1123
1124         if (L_NOFLSH(tty)) {
1125                 /* signal only */
1126                 __isig(sig, tty);
1127
1128         } else { /* signal and flush */
1129                 up_read(&tty->termios_rwsem);
1130                 down_write(&tty->termios_rwsem);
1131
1132                 __isig(sig, tty);
1133
1134                 /* clear echo buffer */
1135                 mutex_lock(&ldata->output_lock);
1136                 ldata->echo_head = ldata->echo_tail = 0;
1137                 ldata->echo_mark = ldata->echo_commit = 0;
1138                 mutex_unlock(&ldata->output_lock);
1139
1140                 /* clear output buffer */
1141                 tty_driver_flush_buffer(tty);
1142
1143                 /* clear input buffer */
1144                 reset_buffer_flags(tty->disc_data);
1145
1146                 /* notify pty master of flush */
1147                 if (tty->link)
1148                         n_tty_packet_mode_flush(tty);
1149
1150                 up_write(&tty->termios_rwsem);
1151                 down_read(&tty->termios_rwsem);
1152         }
1153 }
1154
1155 /**
1156  *      n_tty_receive_break     -       handle break
1157  *      @tty: terminal
1158  *
1159  *      An RS232 break event has been hit in the incoming bitstream. This
1160  *      can cause a variety of events depending upon the termios settings.
1161  *
1162  *      n_tty_receive_buf()/producer path:
1163  *              caller holds non-exclusive termios_rwsem
1164  *
1165  *      Note: may get exclusive termios_rwsem if flushing input buffer
1166  */
1167
1168 static void n_tty_receive_break(struct tty_struct *tty)
1169 {
1170         struct n_tty_data *ldata = tty->disc_data;
1171
1172         if (I_IGNBRK(tty))
1173                 return;
1174         if (I_BRKINT(tty)) {
1175                 isig(SIGINT, tty);
1176                 return;
1177         }
1178         if (I_PARMRK(tty)) {
1179                 put_tty_queue('\377', ldata);
1180                 put_tty_queue('\0', ldata);
1181         }
1182         put_tty_queue('\0', ldata);
1183         if (waitqueue_active(&tty->read_wait))
1184                 wake_up_interruptible_poll(&tty->read_wait, POLLIN);
1185 }
1186
1187 /**
1188  *      n_tty_receive_overrun   -       handle overrun reporting
1189  *      @tty: terminal
1190  *
1191  *      Data arrived faster than we could process it. While the tty
1192  *      driver has flagged this the bits that were missed are gone
1193  *      forever.
1194  *
1195  *      Called from the receive_buf path so single threaded. Does not
1196  *      need locking as num_overrun and overrun_time are function
1197  *      private.
1198  */
1199
1200 static void n_tty_receive_overrun(struct tty_struct *tty)
1201 {
1202         struct n_tty_data *ldata = tty->disc_data;
1203         char buf[64];
1204
1205         ldata->num_overrun++;
1206         if (time_after(jiffies, ldata->overrun_time + HZ) ||
1207                         time_after(ldata->overrun_time, jiffies)) {
1208                 printk(KERN_WARNING "%s: %d input overrun(s)\n",
1209                         tty_name(tty, buf),
1210                         ldata->num_overrun);
1211                 ldata->overrun_time = jiffies;
1212                 ldata->num_overrun = 0;
1213         }
1214 }
1215
1216 /**
1217  *      n_tty_receive_parity_error      -       error notifier
1218  *      @tty: terminal device
1219  *      @c: character
1220  *
1221  *      Process a parity error and queue the right data to indicate
1222  *      the error case if necessary.
1223  *
1224  *      n_tty_receive_buf()/producer path:
1225  *              caller holds non-exclusive termios_rwsem
1226  */
1227 static void n_tty_receive_parity_error(struct tty_struct *tty, unsigned char c)
1228 {
1229         struct n_tty_data *ldata = tty->disc_data;
1230
1231         if (I_INPCK(tty)) {
1232                 if (I_IGNPAR(tty))
1233                         return;
1234                 if (I_PARMRK(tty)) {
1235                         put_tty_queue('\377', ldata);
1236                         put_tty_queue('\0', ldata);
1237                         put_tty_queue(c, ldata);
1238                 } else
1239                         put_tty_queue('\0', ldata);
1240         } else
1241                 put_tty_queue(c, ldata);
1242         if (waitqueue_active(&tty->read_wait))
1243                 wake_up_interruptible_poll(&tty->read_wait, POLLIN);
1244 }
1245
1246 static void
1247 n_tty_receive_signal_char(struct tty_struct *tty, int signal, unsigned char c)
1248 {
1249         isig(signal, tty);
1250         if (I_IXON(tty))
1251                 start_tty(tty);
1252         if (L_ECHO(tty)) {
1253                 echo_char(c, tty);
1254                 commit_echoes(tty);
1255         } else
1256                 process_echoes(tty);
1257         return;
1258 }
1259
1260 /**
1261  *      n_tty_receive_char      -       perform processing
1262  *      @tty: terminal device
1263  *      @c: character
1264  *
1265  *      Process an individual character of input received from the driver.
1266  *      This is serialized with respect to itself by the rules for the
1267  *      driver above.
1268  *
1269  *      n_tty_receive_buf()/producer path:
1270  *              caller holds non-exclusive termios_rwsem
1271  *              publishes canon_head if canonical mode is active
1272  *
1273  *      Returns 1 if LNEXT was received, else returns 0
1274  */
1275
1276 static int
1277 n_tty_receive_char_special(struct tty_struct *tty, unsigned char c)
1278 {
1279         struct n_tty_data *ldata = tty->disc_data;
1280
1281         if (I_IXON(tty)) {
1282                 if (c == START_CHAR(tty)) {
1283                         start_tty(tty);
1284                         process_echoes(tty);
1285                         return 0;
1286                 }
1287                 if (c == STOP_CHAR(tty)) {
1288                         stop_tty(tty);
1289                         return 0;
1290                 }
1291         }
1292
1293         if (L_ISIG(tty)) {
1294                 if (c == INTR_CHAR(tty)) {
1295                         n_tty_receive_signal_char(tty, SIGINT, c);
1296                         return 0;
1297                 } else if (c == QUIT_CHAR(tty)) {
1298                         n_tty_receive_signal_char(tty, SIGQUIT, c);
1299                         return 0;
1300                 } else if (c == SUSP_CHAR(tty)) {
1301                         n_tty_receive_signal_char(tty, SIGTSTP, c);
1302                         return 0;
1303                 }
1304         }
1305
1306         if (tty->stopped && !tty->flow_stopped && I_IXON(tty) && I_IXANY(tty)) {
1307                 start_tty(tty);
1308                 process_echoes(tty);
1309         }
1310
1311         if (c == '\r') {
1312                 if (I_IGNCR(tty))
1313                         return 0;
1314                 if (I_ICRNL(tty))
1315                         c = '\n';
1316         } else if (c == '\n' && I_INLCR(tty))
1317                 c = '\r';
1318
1319         if (ldata->icanon) {
1320                 if (c == ERASE_CHAR(tty) || c == KILL_CHAR(tty) ||
1321                     (c == WERASE_CHAR(tty) && L_IEXTEN(tty))) {
1322                         eraser(c, tty);
1323                         commit_echoes(tty);
1324                         return 0;
1325                 }
1326                 if (c == LNEXT_CHAR(tty) && L_IEXTEN(tty)) {
1327                         ldata->lnext = 1;
1328                         if (L_ECHO(tty)) {
1329                                 finish_erasing(ldata);
1330                                 if (L_ECHOCTL(tty)) {
1331                                         echo_char_raw('^', ldata);
1332                                         echo_char_raw('\b', ldata);
1333                                         commit_echoes(tty);
1334                                 }
1335                         }
1336                         return 1;
1337                 }
1338                 if (c == REPRINT_CHAR(tty) && L_ECHO(tty) && L_IEXTEN(tty)) {
1339                         size_t tail = ldata->canon_head;
1340
1341                         finish_erasing(ldata);
1342                         echo_char(c, tty);
1343                         echo_char_raw('\n', ldata);
1344                         while (tail != ldata->read_head) {
1345                                 echo_char(read_buf(ldata, tail), tty);
1346                                 tail++;
1347                         }
1348                         commit_echoes(tty);
1349                         return 0;
1350                 }
1351                 if (c == '\n') {
1352                         if (L_ECHO(tty) || L_ECHONL(tty)) {
1353                                 echo_char_raw('\n', ldata);
1354                                 commit_echoes(tty);
1355                         }
1356                         goto handle_newline;
1357                 }
1358                 if (c == EOF_CHAR(tty)) {
1359                         c = __DISABLED_CHAR;
1360                         goto handle_newline;
1361                 }
1362                 if ((c == EOL_CHAR(tty)) ||
1363                     (c == EOL2_CHAR(tty) && L_IEXTEN(tty))) {
1364                         /*
1365                          * XXX are EOL_CHAR and EOL2_CHAR echoed?!?
1366                          */
1367                         if (L_ECHO(tty)) {
1368                                 /* Record the column of first canon char. */
1369                                 if (ldata->canon_head == ldata->read_head)
1370                                         echo_set_canon_col(ldata);
1371                                 echo_char(c, tty);
1372                                 commit_echoes(tty);
1373                         }
1374                         /*
1375                          * XXX does PARMRK doubling happen for
1376                          * EOL_CHAR and EOL2_CHAR?
1377                          */
1378                         if (c == (unsigned char) '\377' && I_PARMRK(tty))
1379                                 put_tty_queue(c, ldata);
1380
1381 handle_newline:
1382                         set_bit(ldata->read_head & (N_TTY_BUF_SIZE - 1), ldata->read_flags);
1383                         put_tty_queue(c, ldata);
1384                         smp_store_release(&ldata->canon_head, ldata->read_head);
1385                         kill_fasync(&tty->fasync, SIGIO, POLL_IN);
1386                         if (waitqueue_active(&tty->read_wait))
1387                                 wake_up_interruptible_poll(&tty->read_wait, POLLIN);
1388                         return 0;
1389                 }
1390         }
1391
1392         if (L_ECHO(tty)) {
1393                 finish_erasing(ldata);
1394                 if (c == '\n')
1395                         echo_char_raw('\n', ldata);
1396                 else {
1397                         /* Record the column of first canon char. */
1398                         if (ldata->canon_head == ldata->read_head)
1399                                 echo_set_canon_col(ldata);
1400                         echo_char(c, tty);
1401                 }
1402                 commit_echoes(tty);
1403         }
1404
1405         /* PARMRK doubling check */
1406         if (c == (unsigned char) '\377' && I_PARMRK(tty))
1407                 put_tty_queue(c, ldata);
1408
1409         put_tty_queue(c, ldata);
1410         return 0;
1411 }
1412
1413 static inline void
1414 n_tty_receive_char_inline(struct tty_struct *tty, unsigned char c)
1415 {
1416         struct n_tty_data *ldata = tty->disc_data;
1417
1418         if (tty->stopped && !tty->flow_stopped && I_IXON(tty) && I_IXANY(tty)) {
1419                 start_tty(tty);
1420                 process_echoes(tty);
1421         }
1422         if (L_ECHO(tty)) {
1423                 finish_erasing(ldata);
1424                 /* Record the column of first canon char. */
1425                 if (ldata->canon_head == ldata->read_head)
1426                         echo_set_canon_col(ldata);
1427                 echo_char(c, tty);
1428                 commit_echoes(tty);
1429         }
1430         /* PARMRK doubling check */
1431         if (c == (unsigned char) '\377' && I_PARMRK(tty))
1432                 put_tty_queue(c, ldata);
1433         put_tty_queue(c, ldata);
1434 }
1435
1436 static void n_tty_receive_char(struct tty_struct *tty, unsigned char c)
1437 {
1438         n_tty_receive_char_inline(tty, c);
1439 }
1440
1441 static inline void
1442 n_tty_receive_char_fast(struct tty_struct *tty, unsigned char c)
1443 {
1444         struct n_tty_data *ldata = tty->disc_data;
1445
1446         if (tty->stopped && !tty->flow_stopped && I_IXON(tty) && I_IXANY(tty)) {
1447                 start_tty(tty);
1448                 process_echoes(tty);
1449         }
1450         if (L_ECHO(tty)) {
1451                 finish_erasing(ldata);
1452                 /* Record the column of first canon char. */
1453                 if (ldata->canon_head == ldata->read_head)
1454                         echo_set_canon_col(ldata);
1455                 echo_char(c, tty);
1456                 commit_echoes(tty);
1457         }
1458         put_tty_queue(c, ldata);
1459 }
1460
1461 static void n_tty_receive_char_closing(struct tty_struct *tty, unsigned char c)
1462 {
1463         if (I_ISTRIP(tty))
1464                 c &= 0x7f;
1465         if (I_IUCLC(tty) && L_IEXTEN(tty))
1466                 c = tolower(c);
1467
1468         if (I_IXON(tty)) {
1469                 if (c == STOP_CHAR(tty))
1470                         stop_tty(tty);
1471                 else if (c == START_CHAR(tty) ||
1472                          (tty->stopped && !tty->flow_stopped && I_IXANY(tty) &&
1473                           c != INTR_CHAR(tty) && c != QUIT_CHAR(tty) &&
1474                           c != SUSP_CHAR(tty))) {
1475                         start_tty(tty);
1476                         process_echoes(tty);
1477                 }
1478         }
1479 }
1480
1481 static void
1482 n_tty_receive_char_flagged(struct tty_struct *tty, unsigned char c, char flag)
1483 {
1484         char buf[64];
1485
1486         switch (flag) {
1487         case TTY_BREAK:
1488                 n_tty_receive_break(tty);
1489                 break;
1490         case TTY_PARITY:
1491         case TTY_FRAME:
1492                 n_tty_receive_parity_error(tty, c);
1493                 break;
1494         case TTY_OVERRUN:
1495                 n_tty_receive_overrun(tty);
1496                 break;
1497         default:
1498                 printk(KERN_ERR "%s: unknown flag %d\n",
1499                        tty_name(tty, buf), flag);
1500                 break;
1501         }
1502 }
1503
1504 static void
1505 n_tty_receive_char_lnext(struct tty_struct *tty, unsigned char c, char flag)
1506 {
1507         struct n_tty_data *ldata = tty->disc_data;
1508
1509         ldata->lnext = 0;
1510         if (likely(flag == TTY_NORMAL)) {
1511                 if (I_ISTRIP(tty))
1512                         c &= 0x7f;
1513                 if (I_IUCLC(tty) && L_IEXTEN(tty))
1514                         c = tolower(c);
1515                 n_tty_receive_char(tty, c);
1516         } else
1517                 n_tty_receive_char_flagged(tty, c, flag);
1518 }
1519
1520 static void
1521 n_tty_receive_buf_real_raw(struct tty_struct *tty, const unsigned char *cp,
1522                            char *fp, int count)
1523 {
1524         struct n_tty_data *ldata = tty->disc_data;
1525         size_t n, head;
1526
1527         head = ldata->read_head & (N_TTY_BUF_SIZE - 1);
1528         n = min_t(size_t, count, N_TTY_BUF_SIZE - head);
1529         memcpy(read_buf_addr(ldata, head), cp, n);
1530         ldata->read_head += n;
1531         cp += n;
1532         count -= n;
1533
1534         head = ldata->read_head & (N_TTY_BUF_SIZE - 1);
1535         n = min_t(size_t, count, N_TTY_BUF_SIZE - head);
1536         memcpy(read_buf_addr(ldata, head), cp, n);
1537         ldata->read_head += n;
1538 }
1539
1540 static void
1541 n_tty_receive_buf_raw(struct tty_struct *tty, const unsigned char *cp,
1542                       char *fp, int count)
1543 {
1544         struct n_tty_data *ldata = tty->disc_data;
1545         char flag = TTY_NORMAL;
1546
1547         while (count--) {
1548                 if (fp)
1549                         flag = *fp++;
1550                 if (likely(flag == TTY_NORMAL))
1551                         put_tty_queue(*cp++, ldata);
1552                 else
1553                         n_tty_receive_char_flagged(tty, *cp++, flag);
1554         }
1555 }
1556
1557 static void
1558 n_tty_receive_buf_closing(struct tty_struct *tty, const unsigned char *cp,
1559                           char *fp, int count)
1560 {
1561         char flag = TTY_NORMAL;
1562
1563         while (count--) {
1564                 if (fp)
1565                         flag = *fp++;
1566                 if (likely(flag == TTY_NORMAL))
1567                         n_tty_receive_char_closing(tty, *cp++);
1568                 else
1569                         n_tty_receive_char_flagged(tty, *cp++, flag);
1570         }
1571 }
1572
1573 static void
1574 n_tty_receive_buf_standard(struct tty_struct *tty, const unsigned char *cp,
1575                           char *fp, int count)
1576 {
1577         struct n_tty_data *ldata = tty->disc_data;
1578         char flag = TTY_NORMAL;
1579
1580         while (count--) {
1581                 if (fp)
1582                         flag = *fp++;
1583                 if (likely(flag == TTY_NORMAL)) {
1584                         unsigned char c = *cp++;
1585
1586                         if (I_ISTRIP(tty))
1587                                 c &= 0x7f;
1588                         if (I_IUCLC(tty) && L_IEXTEN(tty))
1589                                 c = tolower(c);
1590                         if (L_EXTPROC(tty)) {
1591                                 put_tty_queue(c, ldata);
1592                                 continue;
1593                         }
1594                         if (!test_bit(c, ldata->char_map))
1595                                 n_tty_receive_char_inline(tty, c);
1596                         else if (n_tty_receive_char_special(tty, c) && count) {
1597                                 if (fp)
1598                                         flag = *fp++;
1599                                 n_tty_receive_char_lnext(tty, *cp++, flag);
1600                                 count--;
1601                         }
1602                 } else
1603                         n_tty_receive_char_flagged(tty, *cp++, flag);
1604         }
1605 }
1606
1607 static void
1608 n_tty_receive_buf_fast(struct tty_struct *tty, const unsigned char *cp,
1609                        char *fp, int count)
1610 {
1611         struct n_tty_data *ldata = tty->disc_data;
1612         char flag = TTY_NORMAL;
1613
1614         while (count--) {
1615                 if (fp)
1616                         flag = *fp++;
1617                 if (likely(flag == TTY_NORMAL)) {
1618                         unsigned char c = *cp++;
1619
1620                         if (!test_bit(c, ldata->char_map))
1621                                 n_tty_receive_char_fast(tty, c);
1622                         else if (n_tty_receive_char_special(tty, c) && count) {
1623                                 if (fp)
1624                                         flag = *fp++;
1625                                 n_tty_receive_char_lnext(tty, *cp++, flag);
1626                                 count--;
1627                         }
1628                 } else
1629                         n_tty_receive_char_flagged(tty, *cp++, flag);
1630         }
1631 }
1632
1633 static void __receive_buf(struct tty_struct *tty, const unsigned char *cp,
1634                           char *fp, int count)
1635 {
1636         struct n_tty_data *ldata = tty->disc_data;
1637         bool preops = I_ISTRIP(tty) || (I_IUCLC(tty) && L_IEXTEN(tty));
1638
1639         if (ldata->real_raw)
1640                 n_tty_receive_buf_real_raw(tty, cp, fp, count);
1641         else if (ldata->raw || (L_EXTPROC(tty) && !preops))
1642                 n_tty_receive_buf_raw(tty, cp, fp, count);
1643         else if (tty->closing && !L_EXTPROC(tty))
1644                 n_tty_receive_buf_closing(tty, cp, fp, count);
1645         else {
1646                 if (ldata->lnext) {
1647                         char flag = TTY_NORMAL;
1648
1649                         if (fp)
1650                                 flag = *fp++;
1651                         n_tty_receive_char_lnext(tty, *cp++, flag);
1652                         count--;
1653                 }
1654
1655                 if (!preops && !I_PARMRK(tty))
1656                         n_tty_receive_buf_fast(tty, cp, fp, count);
1657                 else
1658                         n_tty_receive_buf_standard(tty, cp, fp, count);
1659
1660                 flush_echoes(tty);
1661                 if (tty->ops->flush_chars)
1662                         tty->ops->flush_chars(tty);
1663         }
1664
1665         if (ldata->icanon && !L_EXTPROC(tty))
1666                 return;
1667
1668         /* publish read_head to consumer */
1669         smp_store_release(&ldata->commit_head, ldata->read_head);
1670
1671         if ((read_cnt(ldata) >= ldata->minimum_to_wake) || L_EXTPROC(tty)) {
1672                 kill_fasync(&tty->fasync, SIGIO, POLL_IN);
1673                 if (waitqueue_active(&tty->read_wait))
1674                         wake_up_interruptible_poll(&tty->read_wait, POLLIN);
1675         }
1676 }
1677
1678 /**
1679  *      n_tty_receive_buf_common        -       process input
1680  *      @tty: device to receive input
1681  *      @cp: input chars
1682  *      @fp: flags for each char (if NULL, all chars are TTY_NORMAL)
1683  *      @count: number of input chars in @cp
1684  *
1685  *      Called by the terminal driver when a block of characters has
1686  *      been received. This function must be called from soft contexts
1687  *      not from interrupt context. The driver is responsible for making
1688  *      calls one at a time and in order (or using flush_to_ldisc)
1689  *
1690  *      Returns the # of input chars from @cp which were processed.
1691  *
1692  *      In canonical mode, the maximum line length is 4096 chars (including
1693  *      the line termination char); lines longer than 4096 chars are
1694  *      truncated. After 4095 chars, input data is still processed but
1695  *      not stored. Overflow processing ensures the tty can always
1696  *      receive more input until at least one line can be read.
1697  *
1698  *      In non-canonical mode, the read buffer will only accept 4095 chars;
1699  *      this provides the necessary space for a newline char if the input
1700  *      mode is switched to canonical.
1701  *
1702  *      Note it is possible for the read buffer to _contain_ 4096 chars
1703  *      in non-canonical mode: the read buffer could already contain the
1704  *      maximum canon line of 4096 chars when the mode is switched to
1705  *      non-canonical.
1706  *
1707  *      n_tty_receive_buf()/producer path:
1708  *              claims non-exclusive termios_rwsem
1709  *              publishes commit_head or canon_head
1710  */
1711 static int
1712 n_tty_receive_buf_common(struct tty_struct *tty, const unsigned char *cp,
1713                          char *fp, int count, int flow)
1714 {
1715         struct n_tty_data *ldata = tty->disc_data;
1716         int room, n, rcvd = 0, overflow;
1717
1718         down_read(&tty->termios_rwsem);
1719
1720         while (1) {
1721                 /*
1722                  * When PARMRK is set, each input char may take up to 3 chars
1723                  * in the read buf; reduce the buffer space avail by 3x
1724                  *
1725                  * If we are doing input canonicalization, and there are no
1726                  * pending newlines, let characters through without limit, so
1727                  * that erase characters will be handled.  Other excess
1728                  * characters will be beeped.
1729                  *
1730                  * paired with store in *_copy_from_read_buf() -- guarantees
1731                  * the consumer has loaded the data in read_buf up to the new
1732                  * read_tail (so this producer will not overwrite unread data)
1733                  */
1734                 size_t tail = smp_load_acquire(&ldata->read_tail);
1735
1736                 room = N_TTY_BUF_SIZE - (ldata->read_head - tail);
1737                 if (I_PARMRK(tty))
1738                         room = (room + 2) / 3;
1739                 room--;
1740                 if (room <= 0) {
1741                         overflow = ldata->icanon && ldata->canon_head == tail;
1742                         if (overflow && room < 0)
1743                                 ldata->read_head--;
1744                         room = overflow;
1745                         ldata->no_room = flow && !room;
1746                 } else
1747                         overflow = 0;
1748
1749                 n = min(count, room);
1750                 if (!n)
1751                         break;
1752
1753                 /* ignore parity errors if handling overflow */
1754                 if (!overflow || !fp || *fp != TTY_PARITY)
1755                         __receive_buf(tty, cp, fp, n);
1756
1757                 cp += n;
1758                 if (fp)
1759                         fp += n;
1760                 count -= n;
1761                 rcvd += n;
1762         }
1763
1764         tty->receive_room = room;
1765
1766         /* Unthrottle if handling overflow on pty */
1767         if (tty->driver->type == TTY_DRIVER_TYPE_PTY) {
1768                 if (overflow) {
1769                         tty_set_flow_change(tty, TTY_UNTHROTTLE_SAFE);
1770                         tty_unthrottle_safe(tty);
1771                         __tty_set_flow_change(tty, 0);
1772                 }
1773         } else
1774                 n_tty_check_throttle(tty);
1775
1776         up_read(&tty->termios_rwsem);
1777
1778         return rcvd;
1779 }
1780
1781 static void n_tty_receive_buf(struct tty_struct *tty, const unsigned char *cp,
1782                               char *fp, int count)
1783 {
1784         n_tty_receive_buf_common(tty, cp, fp, count, 0);
1785 }
1786
1787 static int n_tty_receive_buf2(struct tty_struct *tty, const unsigned char *cp,
1788                               char *fp, int count)
1789 {
1790         return n_tty_receive_buf_common(tty, cp, fp, count, 1);
1791 }
1792
1793 int is_ignored(int sig)
1794 {
1795         return (sigismember(&current->blocked, sig) ||
1796                 current->sighand->action[sig-1].sa.sa_handler == SIG_IGN);
1797 }
1798
1799 /**
1800  *      n_tty_set_termios       -       termios data changed
1801  *      @tty: terminal
1802  *      @old: previous data
1803  *
1804  *      Called by the tty layer when the user changes termios flags so
1805  *      that the line discipline can plan ahead. This function cannot sleep
1806  *      and is protected from re-entry by the tty layer. The user is
1807  *      guaranteed that this function will not be re-entered or in progress
1808  *      when the ldisc is closed.
1809  *
1810  *      Locking: Caller holds tty->termios_rwsem
1811  */
1812
1813 static void n_tty_set_termios(struct tty_struct *tty, struct ktermios *old)
1814 {
1815         struct n_tty_data *ldata = tty->disc_data;
1816
1817         if (!old || (old->c_lflag ^ tty->termios.c_lflag) & ICANON) {
1818                 bitmap_zero(ldata->read_flags, N_TTY_BUF_SIZE);
1819                 ldata->line_start = ldata->read_tail;
1820                 if (!L_ICANON(tty) || !read_cnt(ldata)) {
1821                         ldata->canon_head = ldata->read_tail;
1822                         ldata->push = 0;
1823                 } else {
1824                         set_bit((ldata->read_head - 1) & (N_TTY_BUF_SIZE - 1),
1825                                 ldata->read_flags);
1826                         ldata->canon_head = ldata->read_head;
1827                         ldata->push = 1;
1828                 }
1829                 ldata->commit_head = ldata->read_head;
1830                 ldata->erasing = 0;
1831                 ldata->lnext = 0;
1832         }
1833
1834         ldata->icanon = (L_ICANON(tty) != 0);
1835
1836         if (I_ISTRIP(tty) || I_IUCLC(tty) || I_IGNCR(tty) ||
1837             I_ICRNL(tty) || I_INLCR(tty) || L_ICANON(tty) ||
1838             I_IXON(tty) || L_ISIG(tty) || L_ECHO(tty) ||
1839             I_PARMRK(tty)) {
1840                 bitmap_zero(ldata->char_map, 256);
1841
1842                 if (I_IGNCR(tty) || I_ICRNL(tty))
1843                         set_bit('\r', ldata->char_map);
1844                 if (I_INLCR(tty))
1845                         set_bit('\n', ldata->char_map);
1846
1847                 if (L_ICANON(tty)) {
1848                         set_bit(ERASE_CHAR(tty), ldata->char_map);
1849                         set_bit(KILL_CHAR(tty), ldata->char_map);
1850                         set_bit(EOF_CHAR(tty), ldata->char_map);
1851                         set_bit('\n', ldata->char_map);
1852                         set_bit(EOL_CHAR(tty), ldata->char_map);
1853                         if (L_IEXTEN(tty)) {
1854                                 set_bit(WERASE_CHAR(tty), ldata->char_map);
1855                                 set_bit(LNEXT_CHAR(tty), ldata->char_map);
1856                                 set_bit(EOL2_CHAR(tty), ldata->char_map);
1857                                 if (L_ECHO(tty))
1858                                         set_bit(REPRINT_CHAR(tty),
1859                                                 ldata->char_map);
1860                         }
1861                 }
1862                 if (I_IXON(tty)) {
1863                         set_bit(START_CHAR(tty), ldata->char_map);
1864                         set_bit(STOP_CHAR(tty), ldata->char_map);
1865                 }
1866                 if (L_ISIG(tty)) {
1867                         set_bit(INTR_CHAR(tty), ldata->char_map);
1868                         set_bit(QUIT_CHAR(tty), ldata->char_map);
1869                         set_bit(SUSP_CHAR(tty), ldata->char_map);
1870                 }
1871                 clear_bit(__DISABLED_CHAR, ldata->char_map);
1872                 ldata->raw = 0;
1873                 ldata->real_raw = 0;
1874         } else {
1875                 ldata->raw = 1;
1876                 if ((I_IGNBRK(tty) || (!I_BRKINT(tty) && !I_PARMRK(tty))) &&
1877                     (I_IGNPAR(tty) || !I_INPCK(tty)) &&
1878                     (tty->driver->flags & TTY_DRIVER_REAL_RAW))
1879                         ldata->real_raw = 1;
1880                 else
1881                         ldata->real_raw = 0;
1882         }
1883         /*
1884          * Fix tty hang when I_IXON(tty) is cleared, but the tty
1885          * been stopped by STOP_CHAR(tty) before it.
1886          */
1887         if (!I_IXON(tty) && old && (old->c_iflag & IXON) && !tty->flow_stopped) {
1888                 start_tty(tty);
1889                 process_echoes(tty);
1890         }
1891
1892         /* The termios change make the tty ready for I/O */
1893         if (waitqueue_active(&tty->write_wait))
1894                 wake_up_interruptible(&tty->write_wait);
1895         if (waitqueue_active(&tty->read_wait))
1896                 wake_up_interruptible(&tty->read_wait);
1897 }
1898
1899 /**
1900  *      n_tty_close             -       close the ldisc for this tty
1901  *      @tty: device
1902  *
1903  *      Called from the terminal layer when this line discipline is
1904  *      being shut down, either because of a close or becsuse of a
1905  *      discipline change. The function will not be called while other
1906  *      ldisc methods are in progress.
1907  */
1908
1909 static void n_tty_close(struct tty_struct *tty)
1910 {
1911         struct n_tty_data *ldata = tty->disc_data;
1912
1913         if (tty->link)
1914                 n_tty_packet_mode_flush(tty);
1915
1916         vfree(ldata);
1917         tty->disc_data = NULL;
1918 }
1919
1920 /**
1921  *      n_tty_open              -       open an ldisc
1922  *      @tty: terminal to open
1923  *
1924  *      Called when this line discipline is being attached to the
1925  *      terminal device. Can sleep. Called serialized so that no
1926  *      other events will occur in parallel. No further open will occur
1927  *      until a close.
1928  */
1929
1930 static int n_tty_open(struct tty_struct *tty)
1931 {
1932         struct n_tty_data *ldata;
1933
1934         /* Currently a malloc failure here can panic */
1935         ldata = vmalloc(sizeof(*ldata));
1936         if (!ldata)
1937                 goto err;
1938
1939         ldata->overrun_time = jiffies;
1940         mutex_init(&ldata->atomic_read_lock);
1941         mutex_init(&ldata->output_lock);
1942
1943         tty->disc_data = ldata;
1944         reset_buffer_flags(tty->disc_data);
1945         ldata->column = 0;
1946         ldata->canon_column = 0;
1947         ldata->minimum_to_wake = 1;
1948         ldata->num_overrun = 0;
1949         ldata->no_room = 0;
1950         ldata->lnext = 0;
1951         tty->closing = 0;
1952         /* indicate buffer work may resume */
1953         clear_bit(TTY_LDISC_HALTED, &tty->flags);
1954         n_tty_set_termios(tty, NULL);
1955         tty_unthrottle(tty);
1956
1957         return 0;
1958 err:
1959         return -ENOMEM;
1960 }
1961
1962 static inline int input_available_p(struct tty_struct *tty, int poll)
1963 {
1964         struct n_tty_data *ldata = tty->disc_data;
1965         int amt = poll && !TIME_CHAR(tty) && MIN_CHAR(tty) ? MIN_CHAR(tty) : 1;
1966
1967         if (ldata->icanon && !L_EXTPROC(tty))
1968                 return ldata->canon_head != ldata->read_tail;
1969         else
1970                 return ldata->commit_head - ldata->read_tail >= amt;
1971 }
1972
1973 static inline int check_other_done(struct tty_struct *tty)
1974 {
1975         int done = test_bit(TTY_OTHER_DONE, &tty->flags);
1976         if (done) {
1977                 /* paired with cmpxchg() in check_other_closed(); ensures
1978                  * read buffer head index is not stale
1979                  */
1980                 smp_mb__after_atomic();
1981         }
1982         return done;
1983 }
1984
1985 /**
1986  *      copy_from_read_buf      -       copy read data directly
1987  *      @tty: terminal device
1988  *      @b: user data
1989  *      @nr: size of data
1990  *
1991  *      Helper function to speed up n_tty_read.  It is only called when
1992  *      ICANON is off; it copies characters straight from the tty queue to
1993  *      user space directly.  It can be profitably called twice; once to
1994  *      drain the space from the tail pointer to the (physical) end of the
1995  *      buffer, and once to drain the space from the (physical) beginning of
1996  *      the buffer to head pointer.
1997  *
1998  *      Called under the ldata->atomic_read_lock sem
1999  *
2000  *      n_tty_read()/consumer path:
2001  *              caller holds non-exclusive termios_rwsem
2002  *              read_tail published
2003  */
2004
2005 static int copy_from_read_buf(struct tty_struct *tty,
2006                                       unsigned char __user **b,
2007                                       size_t *nr)
2008
2009 {
2010         struct n_tty_data *ldata = tty->disc_data;
2011         int retval;
2012         size_t n;
2013         bool is_eof;
2014         size_t head = smp_load_acquire(&ldata->commit_head);
2015         size_t tail = ldata->read_tail & (N_TTY_BUF_SIZE - 1);
2016
2017         retval = 0;
2018         n = min(head - ldata->read_tail, N_TTY_BUF_SIZE - tail);
2019         n = min(*nr, n);
2020         if (n) {
2021                 retval = copy_to_user(*b, read_buf_addr(ldata, tail), n);
2022                 n -= retval;
2023                 is_eof = n == 1 && read_buf(ldata, tail) == EOF_CHAR(tty);
2024                 tty_audit_add_data(tty, read_buf_addr(ldata, tail), n,
2025                                 ldata->icanon);
2026                 smp_store_release(&ldata->read_tail, ldata->read_tail + n);
2027                 /* Turn single EOF into zero-length read */
2028                 if (L_EXTPROC(tty) && ldata->icanon && is_eof &&
2029                     (head == ldata->read_tail))
2030                         n = 0;
2031                 *b += n;
2032                 *nr -= n;
2033         }
2034         return retval;
2035 }
2036
2037 /**
2038  *      canon_copy_from_read_buf        -       copy read data in canonical mode
2039  *      @tty: terminal device
2040  *      @b: user data
2041  *      @nr: size of data
2042  *
2043  *      Helper function for n_tty_read.  It is only called when ICANON is on;
2044  *      it copies one line of input up to and including the line-delimiting
2045  *      character into the user-space buffer.
2046  *
2047  *      NB: When termios is changed from non-canonical to canonical mode and
2048  *      the read buffer contains data, n_tty_set_termios() simulates an EOF
2049  *      push (as if C-d were input) _without_ the DISABLED_CHAR in the buffer.
2050  *      This causes data already processed as input to be immediately available
2051  *      as input although a newline has not been received.
2052  *
2053  *      Called under the atomic_read_lock mutex
2054  *
2055  *      n_tty_read()/consumer path:
2056  *              caller holds non-exclusive termios_rwsem
2057  *              read_tail published
2058  */
2059
2060 static int canon_copy_from_read_buf(struct tty_struct *tty,
2061                                     unsigned char __user **b,
2062                                     size_t *nr)
2063 {
2064         struct n_tty_data *ldata = tty->disc_data;
2065         size_t n, size, more, c;
2066         size_t eol;
2067         size_t tail;
2068         int ret, found = 0;
2069         bool eof_push = 0;
2070
2071         /* N.B. avoid overrun if nr == 0 */
2072         n = min(*nr, smp_load_acquire(&ldata->canon_head) - ldata->read_tail);
2073         if (!n)
2074                 return 0;
2075
2076         tail = ldata->read_tail & (N_TTY_BUF_SIZE - 1);
2077         size = min_t(size_t, tail + n, N_TTY_BUF_SIZE);
2078
2079         n_tty_trace("%s: nr:%zu tail:%zu n:%zu size:%zu\n",
2080                     __func__, *nr, tail, n, size);
2081
2082         eol = find_next_bit(ldata->read_flags, size, tail);
2083         more = n - (size - tail);
2084         if (eol == N_TTY_BUF_SIZE && more) {
2085                 /* scan wrapped without finding set bit */
2086                 eol = find_next_bit(ldata->read_flags, more, 0);
2087                 if (eol != more)
2088                         found = 1;
2089         } else if (eol != size)
2090                 found = 1;
2091
2092         size = N_TTY_BUF_SIZE - tail;
2093         n = eol - tail;
2094         if (n > N_TTY_BUF_SIZE)
2095                 n += N_TTY_BUF_SIZE;
2096         n += found;
2097         c = n;
2098
2099         if (found && !ldata->push && read_buf(ldata, eol) == __DISABLED_CHAR) {
2100                 n--;
2101                 eof_push = !n && ldata->read_tail != ldata->line_start;
2102         }
2103
2104         n_tty_trace("%s: eol:%zu found:%d n:%zu c:%zu size:%zu more:%zu\n",
2105                     __func__, eol, found, n, c, size, more);
2106
2107         if (n > size) {
2108                 ret = tty_copy_to_user(tty, *b, read_buf_addr(ldata, tail), size);
2109                 if (ret)
2110                         return -EFAULT;
2111                 ret = tty_copy_to_user(tty, *b + size, ldata->read_buf, n - size);
2112         } else
2113                 ret = tty_copy_to_user(tty, *b, read_buf_addr(ldata, tail), n);
2114
2115         if (ret)
2116                 return -EFAULT;
2117         *b += n;
2118         *nr -= n;
2119
2120         if (found)
2121                 clear_bit(eol, ldata->read_flags);
2122         smp_store_release(&ldata->read_tail, ldata->read_tail + c);
2123
2124         if (found) {
2125                 if (!ldata->push)
2126                         ldata->line_start = ldata->read_tail;
2127                 else
2128                         ldata->push = 0;
2129                 tty_audit_push(tty);
2130         }
2131         return eof_push ? -EAGAIN : 0;
2132 }
2133
2134 extern ssize_t redirected_tty_write(struct file *, const char __user *,
2135                                                         size_t, loff_t *);
2136
2137 /**
2138  *      job_control             -       check job control
2139  *      @tty: tty
2140  *      @file: file handle
2141  *
2142  *      Perform job control management checks on this file/tty descriptor
2143  *      and if appropriate send any needed signals and return a negative
2144  *      error code if action should be taken.
2145  *
2146  *      Locking: redirected write test is safe
2147  *               current->signal->tty check is safe
2148  *               ctrl_lock to safely reference tty->pgrp
2149  */
2150
2151 static int job_control(struct tty_struct *tty, struct file *file)
2152 {
2153         /* Job control check -- must be done at start and after
2154            every sleep (POSIX.1 7.1.1.4). */
2155         /* NOTE: not yet done after every sleep pending a thorough
2156            check of the logic of this change. -- jlc */
2157         /* don't stop on /dev/console */
2158         if (file->f_op->write == redirected_tty_write ||
2159             current->signal->tty != tty)
2160                 return 0;
2161
2162         spin_lock_irq(&tty->ctrl_lock);
2163         if (!tty->pgrp)
2164                 printk(KERN_ERR "n_tty_read: no tty->pgrp!\n");
2165         else if (task_pgrp(current) != tty->pgrp) {
2166                 spin_unlock_irq(&tty->ctrl_lock);
2167                 if (is_ignored(SIGTTIN) || is_current_pgrp_orphaned())
2168                         return -EIO;
2169                 kill_pgrp(task_pgrp(current), SIGTTIN, 1);
2170                 set_thread_flag(TIF_SIGPENDING);
2171                 return -ERESTARTSYS;
2172         }
2173         spin_unlock_irq(&tty->ctrl_lock);
2174         return 0;
2175 }
2176
2177
2178 /**
2179  *      n_tty_read              -       read function for tty
2180  *      @tty: tty device
2181  *      @file: file object
2182  *      @buf: userspace buffer pointer
2183  *      @nr: size of I/O
2184  *
2185  *      Perform reads for the line discipline. We are guaranteed that the
2186  *      line discipline will not be closed under us but we may get multiple
2187  *      parallel readers and must handle this ourselves. We may also get
2188  *      a hangup. Always called in user context, may sleep.
2189  *
2190  *      This code must be sure never to sleep through a hangup.
2191  *
2192  *      n_tty_read()/consumer path:
2193  *              claims non-exclusive termios_rwsem
2194  *              publishes read_tail
2195  */
2196
2197 static ssize_t n_tty_read(struct tty_struct *tty, struct file *file,
2198                          unsigned char __user *buf, size_t nr)
2199 {
2200         struct n_tty_data *ldata = tty->disc_data;
2201         unsigned char __user *b = buf;
2202         DEFINE_WAIT_FUNC(wait, woken_wake_function);
2203         int c, done;
2204         int minimum, time;
2205         ssize_t retval = 0;
2206         long timeout;
2207         int packet;
2208         size_t tail;
2209
2210         c = job_control(tty, file);
2211         if (c < 0)
2212                 return c;
2213
2214         /*
2215          *      Internal serialization of reads.
2216          */
2217         if (file->f_flags & O_NONBLOCK) {
2218                 if (!mutex_trylock(&ldata->atomic_read_lock))
2219                         return -EAGAIN;
2220         } else {
2221                 if (mutex_lock_interruptible(&ldata->atomic_read_lock))
2222                         return -ERESTARTSYS;
2223         }
2224
2225         down_read(&tty->termios_rwsem);
2226
2227         minimum = time = 0;
2228         timeout = MAX_SCHEDULE_TIMEOUT;
2229         if (!ldata->icanon) {
2230                 minimum = MIN_CHAR(tty);
2231                 if (minimum) {
2232                         time = (HZ / 10) * TIME_CHAR(tty);
2233                         if (time)
2234                                 ldata->minimum_to_wake = 1;
2235                         else if (!waitqueue_active(&tty->read_wait) ||
2236                                  (ldata->minimum_to_wake > minimum))
2237                                 ldata->minimum_to_wake = minimum;
2238                 } else {
2239                         timeout = (HZ / 10) * TIME_CHAR(tty);
2240                         ldata->minimum_to_wake = minimum = 1;
2241                 }
2242         }
2243
2244         packet = tty->packet;
2245         tail = ldata->read_tail;
2246
2247         add_wait_queue(&tty->read_wait, &wait);
2248         while (nr) {
2249                 /* First test for status change. */
2250                 if (packet && tty->link->ctrl_status) {
2251                         unsigned char cs;
2252                         if (b != buf)
2253                                 break;
2254                         spin_lock_irq(&tty->link->ctrl_lock);
2255                         cs = tty->link->ctrl_status;
2256                         tty->link->ctrl_status = 0;
2257                         spin_unlock_irq(&tty->link->ctrl_lock);
2258                         if (tty_put_user(tty, cs, b++)) {
2259                                 retval = -EFAULT;
2260                                 b--;
2261                                 break;
2262                         }
2263                         nr--;
2264                         break;
2265                 }
2266
2267                 if (((minimum - (b - buf)) < ldata->minimum_to_wake) &&
2268                     ((minimum - (b - buf)) >= 1))
2269                         ldata->minimum_to_wake = (minimum - (b - buf));
2270
2271                 done = check_other_done(tty);
2272
2273                 if (!input_available_p(tty, 0)) {
2274                         if (done) {
2275                                 retval = -EIO;
2276                                 break;
2277                         }
2278                         if (tty_hung_up_p(file))
2279                                 break;
2280                         if (!timeout)
2281                                 break;
2282                         if (file->f_flags & O_NONBLOCK) {
2283                                 retval = -EAGAIN;
2284                                 break;
2285                         }
2286                         if (signal_pending(current)) {
2287                                 retval = -ERESTARTSYS;
2288                                 break;
2289                         }
2290                         up_read(&tty->termios_rwsem);
2291
2292                         timeout = wait_woken(&wait, TASK_INTERRUPTIBLE,
2293                                              timeout);
2294
2295                         down_read(&tty->termios_rwsem);
2296                         continue;
2297                 }
2298
2299                 if (ldata->icanon && !L_EXTPROC(tty)) {
2300                         retval = canon_copy_from_read_buf(tty, &b, &nr);
2301                         if (retval == -EAGAIN) {
2302                                 retval = 0;
2303                                 continue;
2304                         } else if (retval)
2305                                 break;
2306                 } else {
2307                         int uncopied;
2308
2309                         /* Deal with packet mode. */
2310                         if (packet && b == buf) {
2311                                 if (tty_put_user(tty, TIOCPKT_DATA, b++)) {
2312                                         retval = -EFAULT;
2313                                         b--;
2314                                         break;
2315                                 }
2316                                 nr--;
2317                         }
2318
2319                         uncopied = copy_from_read_buf(tty, &b, &nr);
2320                         uncopied += copy_from_read_buf(tty, &b, &nr);
2321                         if (uncopied) {
2322                                 retval = -EFAULT;
2323                                 break;
2324                         }
2325                 }
2326
2327                 n_tty_check_unthrottle(tty);
2328
2329                 if (b - buf >= minimum)
2330                         break;
2331                 if (time)
2332                         timeout = time;
2333         }
2334         if (tail != ldata->read_tail)
2335                 n_tty_kick_worker(tty);
2336         up_read(&tty->termios_rwsem);
2337
2338         remove_wait_queue(&tty->read_wait, &wait);
2339         if (!waitqueue_active(&tty->read_wait))
2340                 ldata->minimum_to_wake = minimum;
2341
2342         mutex_unlock(&ldata->atomic_read_lock);
2343
2344         if (b - buf)
2345                 retval = b - buf;
2346
2347         return retval;
2348 }
2349
2350 /**
2351  *      n_tty_write             -       write function for tty
2352  *      @tty: tty device
2353  *      @file: file object
2354  *      @buf: userspace buffer pointer
2355  *      @nr: size of I/O
2356  *
2357  *      Write function of the terminal device.  This is serialized with
2358  *      respect to other write callers but not to termios changes, reads
2359  *      and other such events.  Since the receive code will echo characters,
2360  *      thus calling driver write methods, the output_lock is used in
2361  *      the output processing functions called here as well as in the
2362  *      echo processing function to protect the column state and space
2363  *      left in the buffer.
2364  *
2365  *      This code must be sure never to sleep through a hangup.
2366  *
2367  *      Locking: output_lock to protect column state and space left
2368  *               (note that the process_output*() functions take this
2369  *                lock themselves)
2370  */
2371
2372 static ssize_t n_tty_write(struct tty_struct *tty, struct file *file,
2373                            const unsigned char *buf, size_t nr)
2374 {
2375         const unsigned char *b = buf;
2376         DEFINE_WAIT_FUNC(wait, woken_wake_function);
2377         int c;
2378         ssize_t retval = 0;
2379
2380         /* Job control check -- must be done at start (POSIX.1 7.1.1.4). */
2381         if (L_TOSTOP(tty) && file->f_op->write != redirected_tty_write) {
2382                 retval = tty_check_change(tty);
2383                 if (retval)
2384                         return retval;
2385         }
2386
2387         down_read(&tty->termios_rwsem);
2388
2389         /* Write out any echoed characters that are still pending */
2390         process_echoes(tty);
2391
2392         add_wait_queue(&tty->write_wait, &wait);
2393         while (1) {
2394                 if (signal_pending(current)) {
2395                         retval = -ERESTARTSYS;
2396                         break;
2397                 }
2398                 if (tty_hung_up_p(file) || (tty->link && !tty->link->count)) {
2399                         retval = -EIO;
2400                         break;
2401                 }
2402                 if (O_OPOST(tty)) {
2403                         while (nr > 0) {
2404                                 ssize_t num = process_output_block(tty, b, nr);
2405                                 if (num < 0) {
2406                                         if (num == -EAGAIN)
2407                                                 break;
2408                                         retval = num;
2409                                         goto break_out;
2410                                 }
2411                                 b += num;
2412                                 nr -= num;
2413                                 if (nr == 0)
2414                                         break;
2415                                 c = *b;
2416                                 if (process_output(c, tty) < 0)
2417                                         break;
2418                                 b++; nr--;
2419                         }
2420                         if (tty->ops->flush_chars)
2421                                 tty->ops->flush_chars(tty);
2422                 } else {
2423                         struct n_tty_data *ldata = tty->disc_data;
2424
2425                         while (nr > 0) {
2426                                 mutex_lock(&ldata->output_lock);
2427                                 c = tty->ops->write(tty, b, nr);
2428                                 mutex_unlock(&ldata->output_lock);
2429                                 if (c < 0) {
2430                                         retval = c;
2431                                         goto break_out;
2432                                 }
2433                                 if (!c)
2434                                         break;
2435                                 b += c;
2436                                 nr -= c;
2437                         }
2438                 }
2439                 if (!nr)
2440                         break;
2441                 if (file->f_flags & O_NONBLOCK) {
2442                         retval = -EAGAIN;
2443                         break;
2444                 }
2445                 up_read(&tty->termios_rwsem);
2446
2447                 wait_woken(&wait, TASK_INTERRUPTIBLE, MAX_SCHEDULE_TIMEOUT);
2448
2449                 down_read(&tty->termios_rwsem);
2450         }
2451 break_out:
2452         remove_wait_queue(&tty->write_wait, &wait);
2453         if (b - buf != nr && tty->fasync)
2454                 set_bit(TTY_DO_WRITE_WAKEUP, &tty->flags);
2455         up_read(&tty->termios_rwsem);
2456         return (b - buf) ? b - buf : retval;
2457 }
2458
2459 /**
2460  *      n_tty_poll              -       poll method for N_TTY
2461  *      @tty: terminal device
2462  *      @file: file accessing it
2463  *      @wait: poll table
2464  *
2465  *      Called when the line discipline is asked to poll() for data or
2466  *      for special events. This code is not serialized with respect to
2467  *      other events save open/close.
2468  *
2469  *      This code must be sure never to sleep through a hangup.
2470  *      Called without the kernel lock held - fine
2471  */
2472
2473 static unsigned int n_tty_poll(struct tty_struct *tty, struct file *file,
2474                                                         poll_table *wait)
2475 {
2476         struct n_tty_data *ldata = tty->disc_data;
2477         unsigned int mask = 0;
2478
2479         poll_wait(file, &tty->read_wait, wait);
2480         poll_wait(file, &tty->write_wait, wait);
2481         if (check_other_done(tty))
2482                 mask |= POLLHUP;
2483         if (input_available_p(tty, 1))
2484                 mask |= POLLIN | POLLRDNORM;
2485         if (tty->packet && tty->link->ctrl_status)
2486                 mask |= POLLPRI | POLLIN | POLLRDNORM;
2487         if (tty_hung_up_p(file))
2488                 mask |= POLLHUP;
2489         if (!(mask & (POLLHUP | POLLIN | POLLRDNORM))) {
2490                 if (MIN_CHAR(tty) && !TIME_CHAR(tty))
2491                         ldata->minimum_to_wake = MIN_CHAR(tty);
2492                 else
2493                         ldata->minimum_to_wake = 1;
2494         }
2495         if (tty->ops->write && !tty_is_writelocked(tty) &&
2496                         tty_chars_in_buffer(tty) < WAKEUP_CHARS &&
2497                         tty_write_room(tty) > 0)
2498                 mask |= POLLOUT | POLLWRNORM;
2499         return mask;
2500 }
2501
2502 static unsigned long inq_canon(struct n_tty_data *ldata)
2503 {
2504         size_t nr, head, tail;
2505
2506         if (ldata->canon_head == ldata->read_tail)
2507                 return 0;
2508         head = ldata->canon_head;
2509         tail = ldata->read_tail;
2510         nr = head - tail;
2511         /* Skip EOF-chars.. */
2512         while (head != tail) {
2513                 if (test_bit(tail & (N_TTY_BUF_SIZE - 1), ldata->read_flags) &&
2514                     read_buf(ldata, tail) == __DISABLED_CHAR)
2515                         nr--;
2516                 tail++;
2517         }
2518         return nr;
2519 }
2520
2521 static int n_tty_ioctl(struct tty_struct *tty, struct file *file,
2522                        unsigned int cmd, unsigned long arg)
2523 {
2524         struct n_tty_data *ldata = tty->disc_data;
2525         int retval;
2526
2527         switch (cmd) {
2528         case TIOCOUTQ:
2529                 return put_user(tty_chars_in_buffer(tty), (int __user *) arg);
2530         case TIOCINQ:
2531                 down_write(&tty->termios_rwsem);
2532                 if (L_ICANON(tty))
2533                         retval = inq_canon(ldata);
2534                 else
2535                         retval = read_cnt(ldata);
2536                 up_write(&tty->termios_rwsem);
2537                 return put_user(retval, (unsigned int __user *) arg);
2538         default:
2539                 return n_tty_ioctl_helper(tty, file, cmd, arg);
2540         }
2541 }
2542
2543 static void n_tty_fasync(struct tty_struct *tty, int on)
2544 {
2545         struct n_tty_data *ldata = tty->disc_data;
2546
2547         if (!waitqueue_active(&tty->read_wait)) {
2548                 if (on)
2549                         ldata->minimum_to_wake = 1;
2550                 else if (!tty->fasync)
2551                         ldata->minimum_to_wake = N_TTY_BUF_SIZE;
2552         }
2553 }
2554
2555 struct tty_ldisc_ops tty_ldisc_N_TTY = {
2556         .magic           = TTY_LDISC_MAGIC,
2557         .name            = "n_tty",
2558         .open            = n_tty_open,
2559         .close           = n_tty_close,
2560         .flush_buffer    = n_tty_flush_buffer,
2561         .chars_in_buffer = n_tty_chars_in_buffer,
2562         .read            = n_tty_read,
2563         .write           = n_tty_write,
2564         .ioctl           = n_tty_ioctl,
2565         .set_termios     = n_tty_set_termios,
2566         .poll            = n_tty_poll,
2567         .receive_buf     = n_tty_receive_buf,
2568         .write_wakeup    = n_tty_write_wakeup,
2569         .fasync          = n_tty_fasync,
2570         .receive_buf2    = n_tty_receive_buf2,
2571 };
2572
2573 /**
2574  *      n_tty_inherit_ops       -       inherit N_TTY methods
2575  *      @ops: struct tty_ldisc_ops where to save N_TTY methods
2576  *
2577  *      Enables a 'subclass' line discipline to 'inherit' N_TTY
2578  *      methods.
2579  */
2580
2581 void n_tty_inherit_ops(struct tty_ldisc_ops *ops)
2582 {
2583         *ops = tty_ldisc_N_TTY;
2584         ops->owner = NULL;
2585         ops->refcount = ops->flags = 0;
2586 }
2587 EXPORT_SYMBOL_GPL(n_tty_inherit_ops);