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