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