drivers/tty/tty_ldisc.c

   1 #include <linux/types.h>
   2 #include <linux/errno.h>
   3 #include <linux/kmod.h>
   4 #include <linux/sched.h>
   5 #include <linux/interrupt.h>
   6 #include <linux/tty.h>
   7 #include <linux/tty_driver.h>
   8 #include <linux/file.h>
   9 #include <linux/mm.h>
  10 #include <linux/string.h>
  11 #include <linux/slab.h>
  12 #include <linux/poll.h>
  13 #include <linux/proc_fs.h>
  14 #include <linux/init.h>
  15 #include <linux/module.h>
  16 #include <linux/device.h>
  17 #include <linux/wait.h>
  18 #include <linux/bitops.h>
  19 #include <linux/seq_file.h>
  20 #include <linux/uaccess.h>
  21 #include <linux/ratelimit.h>
  22
  23 /*
  24  *      This guards the refcounted line discipline lists. The lock
  25  *      must be taken with irqs off because there are hangup path
  26  *      callers who will do ldisc lookups and cannot sleep.
  27  */
  28
  29 static DEFINE_RAW_SPINLOCK(tty_ldisc_lock);
  30 static DECLARE_WAIT_QUEUE_HEAD(tty_ldisc_wait);
  31 /* Line disc dispatch table */
  32 static struct tty_ldisc_ops *tty_ldiscs[NR_LDISCS];
  33
  34 static inline struct tty_ldisc *get_ldisc(struct tty_ldisc *ld)
  35 {
  36         if (ld)
  37                 atomic_inc(&ld->users);
  38         return ld;
  39 }
  40
  41 static void put_ldisc(struct tty_ldisc *ld)
  42 {
  43         unsigned long flags;
  44
  45         if (WARN_ON_ONCE(!ld))
  46                 return;
  47
  48         /*
  49          * If this is the last user, free the ldisc, and
  50          * release the ldisc ops.
  51          *
  52          * We really want an "atomic_dec_and_raw_lock_irqsave()",
  53          * but we don't have it, so this does it by hand.
  54          */
  55         raw_spin_lock_irqsave(&tty_ldisc_lock, flags);
  56         if (atomic_dec_and_test(&ld->users)) {
  57                 struct tty_ldisc_ops *ldo = ld->ops;
  58
  59                 ldo->refcount--;
  60                 module_put(ldo->owner);
  61                 raw_spin_unlock_irqrestore(&tty_ldisc_lock, flags);
  62
  63                 kfree(ld);
  64                 return;
  65         }
  66         raw_spin_unlock_irqrestore(&tty_ldisc_lock, flags);
  67
  68         if (waitqueue_active(&ld->wq_idle))
  69                 wake_up(&ld->wq_idle);
  70 }
  71
  72 /**
  73  *      tty_register_ldisc      -       install a line discipline
  74  *      @disc: ldisc number
  75  *      @new_ldisc: pointer to the ldisc object
  76  *
  77  *      Installs a new line discipline into the kernel. The discipline
  78  *      is set up as unreferenced and then made available to the kernel
  79  *      from this point onwards.
  80  *
  81  *      Locking:
  82  *              takes tty_ldisc_lock to guard against ldisc races
  83  */
  84
  85 int tty_register_ldisc(int disc, struct tty_ldisc_ops *new_ldisc)
  86 {
  87         unsigned long flags;
  88         int ret = 0;
  89
  90         if (disc < N_TTY || disc >= NR_LDISCS)
  91                 return -EINVAL;
  92
  93         raw_spin_lock_irqsave(&tty_ldisc_lock, flags);
  94         tty_ldiscs[disc] = new_ldisc;
  95         new_ldisc->num = disc;
  96         new_ldisc->refcount = 0;
  97         raw_spin_unlock_irqrestore(&tty_ldisc_lock, flags);
  98
  99         return ret;
 100 }
 101 EXPORT_SYMBOL(tty_register_ldisc);
 102
 103 /**
 104  *      tty_unregister_ldisc    -       unload a line discipline
 105  *      @disc: ldisc number
 106  *      @new_ldisc: pointer to the ldisc object
 107  *
 108  *      Remove a line discipline from the kernel providing it is not
 109  *      currently in use.
 110  *
 111  *      Locking:
 112  *              takes tty_ldisc_lock to guard against ldisc races
 113  */
 114
 115 int tty_unregister_ldisc(int disc)
 116 {
 117         unsigned long flags;
 118         int ret = 0;
 119
 120         if (disc < N_TTY || disc >= NR_LDISCS)
 121                 return -EINVAL;
 122
 123         raw_spin_lock_irqsave(&tty_ldisc_lock, flags);
 124         if (tty_ldiscs[disc]->refcount)
 125                 ret = -EBUSY;
 126         else
 127                 tty_ldiscs[disc] = NULL;
 128         raw_spin_unlock_irqrestore(&tty_ldisc_lock, flags);
 129
 130         return ret;
 131 }
 132 EXPORT_SYMBOL(tty_unregister_ldisc);
 133
 134 static struct tty_ldisc_ops *get_ldops(int disc)
 135 {
 136         unsigned long flags;
 137         struct tty_ldisc_ops *ldops, *ret;
 138
 139         raw_spin_lock_irqsave(&tty_ldisc_lock, flags);
 140         ret = ERR_PTR(-EINVAL);
 141         ldops = tty_ldiscs[disc];
 142         if (ldops) {
 143                 ret = ERR_PTR(-EAGAIN);
 144                 if (try_module_get(ldops->owner)) {
 145                         ldops->refcount++;
 146                         ret = ldops;
 147                 }
 148         }
 149         raw_spin_unlock_irqrestore(&tty_ldisc_lock, flags);
 150         return ret;
 151 }
 152
 153 static void put_ldops(struct tty_ldisc_ops *ldops)
 154 {
 155         unsigned long flags;
 156
 157         raw_spin_lock_irqsave(&tty_ldisc_lock, flags);
 158         ldops->refcount--;
 159         module_put(ldops->owner);
 160         raw_spin_unlock_irqrestore(&tty_ldisc_lock, flags);
 161 }
 162
 163 /**
 164  *      tty_ldisc_get           -       take a reference to an ldisc
 165  *      @disc: ldisc number
 166  *
 167  *      Takes a reference to a line discipline. Deals with refcounts and
 168  *      module locking counts. Returns NULL if the discipline is not available.
 169  *      Returns a pointer to the discipline and bumps the ref count if it is
 170  *      available
 171  *
 172  *      Locking:
 173  *              takes tty_ldisc_lock to guard against ldisc races
 174  */
 175
 176 static struct tty_ldisc *tty_ldisc_get(int disc)
 177 {
 178         struct tty_ldisc *ld;
 179         struct tty_ldisc_ops *ldops;
 180
 181         if (disc < N_TTY || disc >= NR_LDISCS)
 182                 return ERR_PTR(-EINVAL);
 183
 184         /*
 185          * Get the ldisc ops - we may need to request them to be loaded
 186          * dynamically and try again.
 187          */
 188         ldops = get_ldops(disc);
 189         if (IS_ERR(ldops)) {
 190                 request_module("tty-ldisc-%d", disc);
 191                 ldops = get_ldops(disc);
 192                 if (IS_ERR(ldops))
 193                         return ERR_CAST(ldops);
 194         }
 195
 196         ld = kmalloc(sizeof(struct tty_ldisc), GFP_KERNEL);
 197         if (ld == NULL) {
 198                 put_ldops(ldops);
 199                 return ERR_PTR(-ENOMEM);
 200         }
 201
 202         ld->ops = ldops;
 203         atomic_set(&ld->users, 1);
 204         init_waitqueue_head(&ld->wq_idle);
 205
 206         return ld;
 207 }
 208
 209 static void *tty_ldiscs_seq_start(struct seq_file *m, loff_t *pos)
 210 {
 211         return (*pos < NR_LDISCS) ? pos : NULL;
 212 }
 213
 214 static void *tty_ldiscs_seq_next(struct seq_file *m, void *v, loff_t *pos)
 215 {
 216         (*pos)++;
 217         return (*pos < NR_LDISCS) ? pos : NULL;
 218 }
 219
 220 static void tty_ldiscs_seq_stop(struct seq_file *m, void *v)
 221 {
 222 }
 223
 224 static int tty_ldiscs_seq_show(struct seq_file *m, void *v)
 225 {
 226         int i = *(loff_t *)v;
 227         struct tty_ldisc_ops *ldops;
 228
 229         ldops = get_ldops(i);
 230         if (IS_ERR(ldops))
 231                 return 0;
 232         seq_printf(m, "%-10s %2d\n", ldops->name ? ldops->name : "???", i);
 233         put_ldops(ldops);
 234         return 0;
 235 }
 236
 237 static const struct seq_operations tty_ldiscs_seq_ops = {
 238         .start  = tty_ldiscs_seq_start,
 239         .next   = tty_ldiscs_seq_next,
 240         .stop   = tty_ldiscs_seq_stop,
 241         .show   = tty_ldiscs_seq_show,
 242 };
 243
 244 static int proc_tty_ldiscs_open(struct inode *inode, struct file *file)
 245 {
 246         return seq_open(file, &tty_ldiscs_seq_ops);
 247 }
 248
 249 const struct file_operations tty_ldiscs_proc_fops = {
 250         .owner          = THIS_MODULE,
 251         .open           = proc_tty_ldiscs_open,
 252         .read           = seq_read,
 253         .llseek         = seq_lseek,
 254         .release        = seq_release,
 255 };
 256
 257 /**
 258  *      tty_ldisc_assign        -       set ldisc on a tty
 259  *      @tty: tty to assign
 260  *      @ld: line discipline
 261  *
 262  *      Install an instance of a line discipline into a tty structure. The
 263  *      ldisc must have a reference count above zero to ensure it remains.
 264  *      The tty instance refcount starts at zero.
 265  *
 266  *      Locking:
 267  *              Caller must hold references
 268  */
 269
 270 static void tty_ldisc_assign(struct tty_struct *tty, struct tty_ldisc *ld)
 271 {
 272         tty->ldisc = ld;
 273 }
 274
 275 /**
 276  *      tty_ldisc_try           -       internal helper
 277  *      @tty: the tty
 278  *
 279  *      Make a single attempt to grab and bump the refcount on
 280  *      the tty ldisc. Return 0 on failure or 1 on success. This is
 281  *      used to implement both the waiting and non waiting versions
 282  *      of tty_ldisc_ref
 283  *
 284  *      Locking: takes tty_ldisc_lock
 285  */
 286
 287 static struct tty_ldisc *tty_ldisc_try(struct tty_struct *tty)
 288 {
 289         unsigned long flags;
 290         struct tty_ldisc *ld;
 291
 292         raw_spin_lock_irqsave(&tty_ldisc_lock, flags);
 293         ld = NULL;
 294         if (test_bit(TTY_LDISC, &tty->flags))
 295                 ld = get_ldisc(tty->ldisc);
 296         raw_spin_unlock_irqrestore(&tty_ldisc_lock, flags);
 297         return ld;
 298 }
 299
 300 /**
 301  *      tty_ldisc_ref_wait      -       wait for the tty ldisc
 302  *      @tty: tty device
 303  *
 304  *      Dereference the line discipline for the terminal and take a
 305  *      reference to it. If the line discipline is in flux then
 306  *      wait patiently until it changes.
 307  *
 308  *      Note: Must not be called from an IRQ/timer context. The caller
 309  *      must also be careful not to hold other locks that will deadlock
 310  *      against a discipline change, such as an existing ldisc reference
 311  *      (which we check for)
 312  *
 313  *      Locking: call functions take tty_ldisc_lock
 314  */
 315
 316 struct tty_ldisc *tty_ldisc_ref_wait(struct tty_struct *tty)
 317 {
 318         struct tty_ldisc *ld;
 319
 320         /* wait_event is a macro */
 321         wait_event(tty_ldisc_wait, (ld = tty_ldisc_try(tty)) != NULL);
 322         return ld;
 323 }
 324 EXPORT_SYMBOL_GPL(tty_ldisc_ref_wait);
 325
 326 /**
 327  *      tty_ldisc_ref           -       get the tty ldisc
 328  *      @tty: tty device
 329  *
 330  *      Dereference the line discipline for the terminal and take a
 331  *      reference to it. If the line discipline is in flux then
 332  *      return NULL. Can be called from IRQ and timer functions.
 333  *
 334  *      Locking: called functions take tty_ldisc_lock
 335  */
 336
 337 struct tty_ldisc *tty_ldisc_ref(struct tty_struct *tty)
 338 {
 339         return tty_ldisc_try(tty);
 340 }
 341 EXPORT_SYMBOL_GPL(tty_ldisc_ref);
 342
 343 /**
 344  *      tty_ldisc_deref         -       free a tty ldisc reference
 345  *      @ld: reference to free up
 346  *
 347  *      Undoes the effect of tty_ldisc_ref or tty_ldisc_ref_wait. May
 348  *      be called in IRQ context.
 349  *
 350  *      Locking: takes tty_ldisc_lock
 351  */
 352
 353 void tty_ldisc_deref(struct tty_ldisc *ld)
 354 {
 355         put_ldisc(ld);
 356 }
 357 EXPORT_SYMBOL_GPL(tty_ldisc_deref);
 358
 359 static inline void tty_ldisc_put(struct tty_ldisc *ld)
 360 {
 361         put_ldisc(ld);
 362 }
 363
 364 /**
 365  *      tty_ldisc_enable        -       allow ldisc use
 366  *      @tty: terminal to activate ldisc on
 367  *
 368  *      Set the TTY_LDISC flag when the line discipline can be called
 369  *      again. Do necessary wakeups for existing sleepers. Clear the LDISC
 370  *      changing flag to indicate any ldisc change is now over.
 371  *
 372  *      Note: nobody should set the TTY_LDISC bit except via this function.
 373  *      Clearing directly is allowed.
 374  */
 375
 376 void tty_ldisc_enable(struct tty_struct *tty)
 377 {
 378         clear_bit(TTY_LDISC_HALTED, &tty->flags);
 379         set_bit(TTY_LDISC, &tty->flags);
 380         clear_bit(TTY_LDISC_CHANGING, &tty->flags);
 381         wake_up(&tty_ldisc_wait);
 382 }
 383
 384 /**
 385  *      tty_ldisc_flush -       flush line discipline queue
 386  *      @tty: tty
 387  *
 388  *      Flush the line discipline queue (if any) for this tty. If there
 389  *      is no line discipline active this is a no-op.
 390  */
 391
 392 void tty_ldisc_flush(struct tty_struct *tty)
 393 {
 394         struct tty_ldisc *ld = tty_ldisc_ref(tty);
 395         if (ld) {
 396                 if (ld->ops->flush_buffer)
 397                         ld->ops->flush_buffer(tty);
 398                 tty_ldisc_deref(ld);
 399         }
 400         tty_buffer_flush(tty);
 401 }
 402 EXPORT_SYMBOL_GPL(tty_ldisc_flush);
 403
 404 /**
 405  *      tty_set_termios_ldisc           -       set ldisc field
 406  *      @tty: tty structure
 407  *      @num: line discipline number
 408  *
 409  *      This is probably overkill for real world processors but
 410  *      they are not on hot paths so a little discipline won't do
 411  *      any harm.
 412  *
 413  *      Locking: takes termios_mutex
 414  */
 415
 416 static void tty_set_termios_ldisc(struct tty_struct *tty, int num)
 417 {
 418         mutex_lock(&tty->termios_mutex);
 419         tty->termios.c_line = num;
 420         mutex_unlock(&tty->termios_mutex);
 421 }
 422
 423 /**
 424  *      tty_ldisc_open          -       open a line discipline
 425  *      @tty: tty we are opening the ldisc on
 426  *      @ld: discipline to open
 427  *
 428  *      A helper opening method. Also a convenient debugging and check
 429  *      point.
 430  *
 431  *      Locking: always called with BTM already held.
 432  */
 433
 434 static int tty_ldisc_open(struct tty_struct *tty, struct tty_ldisc *ld)
 435 {
 436         WARN_ON(test_and_set_bit(TTY_LDISC_OPEN, &tty->flags));
 437         if (ld->ops->open) {
 438                 int ret;
 439                 /* BTM here locks versus a hangup event */
 440                 ret = ld->ops->open(tty);
 441                 if (ret)
 442                         clear_bit(TTY_LDISC_OPEN, &tty->flags);
 443                 return ret;
 444         }
 445         return 0;
 446 }
 447
 448 /**
 449  *      tty_ldisc_close         -       close a line discipline
 450  *      @tty: tty we are opening the ldisc on
 451  *      @ld: discipline to close
 452  *
 453  *      A helper close method. Also a convenient debugging and check
 454  *      point.
 455  */
 456
 457 static void tty_ldisc_close(struct tty_struct *tty, struct tty_ldisc *ld)
 458 {
 459         WARN_ON(!test_bit(TTY_LDISC_OPEN, &tty->flags));
 460         clear_bit(TTY_LDISC_OPEN, &tty->flags);
 461         if (ld->ops->close)
 462                 ld->ops->close(tty);
 463 }
 464
 465 /**
 466  *      tty_ldisc_restore       -       helper for tty ldisc change
 467  *      @tty: tty to recover
 468  *      @old: previous ldisc
 469  *
 470  *      Restore the previous line discipline or N_TTY when a line discipline
 471  *      change fails due to an open error
 472  */
 473
 474 static void tty_ldisc_restore(struct tty_struct *tty, struct tty_ldisc *old)
 475 {
 476         char buf[64];
 477         struct tty_ldisc *new_ldisc;
 478         int r;
 479
 480         /* There is an outstanding reference here so this is safe */
 481         old = tty_ldisc_get(old->ops->num);
 482         WARN_ON(IS_ERR(old));
 483         tty_ldisc_assign(tty, old);
 484         tty_set_termios_ldisc(tty, old->ops->num);
 485         if (tty_ldisc_open(tty, old) < 0) {
 486                 tty_ldisc_put(old);
 487                 /* This driver is always present */
 488                 new_ldisc = tty_ldisc_get(N_TTY);
 489                 if (IS_ERR(new_ldisc))
 490                         panic("n_tty: get");
 491                 tty_ldisc_assign(tty, new_ldisc);
 492                 tty_set_termios_ldisc(tty, N_TTY);
 493                 r = tty_ldisc_open(tty, new_ldisc);
 494                 if (r < 0)
 495                         panic("Couldn't open N_TTY ldisc for "
 496                               "%s --- error %d.",
 497                               tty_name(tty, buf), r);
 498         }
 499 }
 500
 501 /**
 502  *      tty_ldisc_halt          -       shut down the line discipline
 503  *      @tty: tty device
 504  *
 505  *      Shut down the line discipline and work queue for this tty device.
 506  *      The TTY_LDISC flag being cleared ensures no further references can
 507  *      be obtained while the delayed work queue halt ensures that no more
 508  *      data is fed to the ldisc.
 509  *
 510  *      You need to do a 'flush_scheduled_work()' (outside the ldisc_mutex)
 511  *      in order to make sure any currently executing ldisc work is also
 512  *      flushed.
 513  */
 514
 515 static int tty_ldisc_halt(struct tty_struct *tty)
 516 {
 517         int scheduled;
 518         clear_bit(TTY_LDISC, &tty->flags);
 519         scheduled = cancel_work_sync(&tty->port->buf.work);
 520         set_bit(TTY_LDISC_HALTED, &tty->flags);
 521         return scheduled;
 522 }
 523
 524 /**
 525  *      tty_ldisc_flush_works   -       flush all works of a tty
 526  *      @tty: tty device to flush works for
 527  *
 528  *      Sync flush all works belonging to @tty.
 529  */
 530 static void tty_ldisc_flush_works(struct tty_struct *tty)
 531 {
 532         flush_work(&tty->hangup_work);
 533         flush_work(&tty->SAK_work);
 534         flush_work(&tty->port->buf.work);
 535 }
 536
 537 /**
 538  *      tty_ldisc_wait_idle     -       wait for the ldisc to become idle
 539  *      @tty: tty to wait for
 540  *      @timeout: for how long to wait at most
 541  *
 542  *      Wait for the line discipline to become idle. The discipline must
 543  *      have been halted for this to guarantee it remains idle.
 544  */
 545 static int tty_ldisc_wait_idle(struct tty_struct *tty, long timeout)
 546 {
 547         long ret;
 548         ret = wait_event_timeout(tty->ldisc->wq_idle,
 549                         atomic_read(&tty->ldisc->users) == 1, timeout);
 550         return ret > 0 ? 0 : -EBUSY;
 551 }
 552
 553 /**
 554  *      tty_ldisc_hangup_wait_idle - wait for the ldisc to become idle
 555  *      @tty: tty to wait for
 556  *
 557  *      Wait for the line discipline to become idle. The discipline must
 558  *      have been halted for this to guarantee it remains idle.
 559  *
 560  *      Caller must hold legacy and ->ldisc_mutex.
 561  */
 562 static bool tty_ldisc_hangup_wait_idle(struct tty_struct *tty)
 563 {
 564         while (tty->ldisc) {    /* Not yet closed */
 565                 if (atomic_read(&tty->ldisc->users) != 1) {
 566                         char cur_n[TASK_COMM_LEN], tty_n[64];
 567                         long timeout = 3 * HZ;
 568                         tty_unlock(tty);
 569
 570                         while (tty_ldisc_wait_idle(tty, timeout) == -EBUSY) {
 571                                 timeout = MAX_SCHEDULE_TIMEOUT;
 572                                 printk_ratelimited(KERN_WARNING
 573                                         "%s: waiting (%s) for %s took too long, but we keep waiting...\n",
 574                                         __func__, get_task_comm(cur_n, current),
 575                                         tty_name(tty, tty_n));
 576                         }
 577                         /* must reacquire both locks and preserve lock order */
 578                         mutex_unlock(&tty->ldisc_mutex);
 579                         tty_lock(tty);
 580                         mutex_lock(&tty->ldisc_mutex);
 581                         continue;
 582                 }
 583                 break;
 584         }
 585         return !!tty->ldisc;
 586 }
 587
 588 /**
 589  *      tty_set_ldisc           -       set line discipline
 590  *      @tty: the terminal to set
 591  *      @ldisc: the line discipline
 592  *
 593  *      Set the discipline of a tty line. Must be called from a process
 594  *      context. The ldisc change logic has to protect itself against any
 595  *      overlapping ldisc change (including on the other end of pty pairs),
 596  *      the close of one side of a tty/pty pair, and eventually hangup.
 597  *
 598  *      Locking: takes tty_ldisc_lock, termios_mutex
 599  */
 600
 601 int tty_set_ldisc(struct tty_struct *tty, int ldisc)
 602 {
 603         int retval;
 604         struct tty_ldisc *o_ldisc, *new_ldisc;
 605         int work, o_work = 0;
 606         struct tty_struct *o_tty;
 607
 608         new_ldisc = tty_ldisc_get(ldisc);
 609         if (IS_ERR(new_ldisc))
 610                 return PTR_ERR(new_ldisc);
 611
 612         tty_lock(tty);
 613         /*
 614          *      We need to look at the tty locking here for pty/tty pairs
 615          *      when both sides try to change in parallel.
 616          */
 617
 618         o_tty = tty->link;      /* o_tty is the pty side or NULL */
 619
 620
 621         /*
 622          *      Check the no-op case
 623          */
 624
 625         if (tty->ldisc->ops->num == ldisc) {
 626                 tty_unlock(tty);
 627                 tty_ldisc_put(new_ldisc);
 628                 return 0;
 629         }
 630
 631         tty_unlock(tty);
 632         /*
 633          *      Problem: What do we do if this blocks ?
 634          *      We could deadlock here
 635          */
 636
 637         tty_wait_until_sent(tty, 0);
 638
 639         tty_lock(tty);
 640         mutex_lock(&tty->ldisc_mutex);
 641
 642         /*
 643          *      We could be midstream of another ldisc change which has
 644          *      dropped the lock during processing. If so we need to wait.
 645          */
 646
 647         while (test_bit(TTY_LDISC_CHANGING, &tty->flags)) {
 648                 mutex_unlock(&tty->ldisc_mutex);
 649                 tty_unlock(tty);
 650                 wait_event(tty_ldisc_wait,
 651                         test_bit(TTY_LDISC_CHANGING, &tty->flags) == 0);
 652                 tty_lock(tty);
 653                 mutex_lock(&tty->ldisc_mutex);
 654         }
 655
 656         set_bit(TTY_LDISC_CHANGING, &tty->flags);
 657
 658         /*
 659          *      No more input please, we are switching. The new ldisc
 660          *      will update this value in the ldisc open function
 661          */
 662
 663         tty->receive_room = 0;
 664
 665         o_ldisc = tty->ldisc;
 666
 667         tty_unlock(tty);
 668         /*
 669          *      Make sure we don't change while someone holds a
 670          *      reference to the line discipline. The TTY_LDISC bit
 671          *      prevents anyone taking a reference once it is clear.
 672          *      We need the lock to avoid racing reference takers.
 673          *
 674          *      We must clear the TTY_LDISC bit here to avoid a livelock
 675          *      with a userspace app continually trying to use the tty in
 676          *      parallel to the change and re-referencing the tty.
 677          */
 678
 679         work = tty_ldisc_halt(tty);
 680         if (o_tty)
 681                 o_work = tty_ldisc_halt(o_tty);
 682
 683         /*
 684          * Wait for ->hangup_work and ->buf.work handlers to terminate.
 685          * We must drop the mutex here in case a hangup is also in process.
 686          */
 687
 688         mutex_unlock(&tty->ldisc_mutex);
 689
 690         tty_ldisc_flush_works(tty);
 691
 692         retval = tty_ldisc_wait_idle(tty, 5 * HZ);
 693
 694         tty_lock(tty);
 695         mutex_lock(&tty->ldisc_mutex);
 696
 697         /* handle wait idle failure locked */
 698         if (retval) {
 699                 tty_ldisc_put(new_ldisc);
 700                 goto enable;
 701         }
 702
 703         if (test_bit(TTY_HUPPING, &tty->flags)) {
 704                 /* We were raced by the hangup method. It will have stomped
 705                    the ldisc data and closed the ldisc down */
 706                 clear_bit(TTY_LDISC_CHANGING, &tty->flags);
 707                 mutex_unlock(&tty->ldisc_mutex);
 708                 tty_ldisc_put(new_ldisc);
 709                 tty_unlock(tty);
 710                 return -EIO;
 711         }
 712
 713         /* Shutdown the current discipline. */
 714         tty_ldisc_close(tty, o_ldisc);
 715
 716         /* Now set up the new line discipline. */
 717         tty_ldisc_assign(tty, new_ldisc);
 718         tty_set_termios_ldisc(tty, ldisc);
 719
 720         retval = tty_ldisc_open(tty, new_ldisc);
 721         if (retval < 0) {
 722                 /* Back to the old one or N_TTY if we can't */
 723                 tty_ldisc_put(new_ldisc);
 724                 tty_ldisc_restore(tty, o_ldisc);
 725         }
 726
 727         /* At this point we hold a reference to the new ldisc and a
 728            a reference to the old ldisc. If we ended up flipping back
 729            to the existing ldisc we have two references to it */
 730
 731         if (tty->ldisc->ops->num != o_ldisc->ops->num && tty->ops->set_ldisc)
 732                 tty->ops->set_ldisc(tty);
 733
 734         tty_ldisc_put(o_ldisc);
 735
 736 enable:
 737         /*
 738          *      Allow ldisc referencing to occur again
 739          */
 740
 741         tty_ldisc_enable(tty);
 742         if (o_tty)
 743                 tty_ldisc_enable(o_tty);
 744
 745         /* Restart the work queue in case no characters kick it off. Safe if
 746            already running */
 747         if (work)
 748                 schedule_work(&tty->port->buf.work);
 749         if (o_work)
 750                 schedule_work(&o_tty->port->buf.work);
 751         mutex_unlock(&tty->ldisc_mutex);
 752         tty_unlock(tty);
 753         return retval;
 754 }
 755
 756 /**
 757  *      tty_reset_termios       -       reset terminal state
 758  *      @tty: tty to reset
 759  *
 760  *      Restore a terminal to the driver default state.
 761  */
 762
 763 static void tty_reset_termios(struct tty_struct *tty)
 764 {
 765         mutex_lock(&tty->termios_mutex);
 766         tty->termios = tty->driver->init_termios;
 767         tty->termios.c_ispeed = tty_termios_input_baud_rate(&tty->termios);
 768         tty->termios.c_ospeed = tty_termios_baud_rate(&tty->termios);
 769         mutex_unlock(&tty->termios_mutex);
 770 }
 771
 772
 773 /**
 774  *      tty_ldisc_reinit        -       reinitialise the tty ldisc
 775  *      @tty: tty to reinit
 776  *      @ldisc: line discipline to reinitialize
 777  *
 778  *      Switch the tty to a line discipline and leave the ldisc
 779  *      state closed
 780  */
 781
 782 static int tty_ldisc_reinit(struct tty_struct *tty, int ldisc)
 783 {
 784         struct tty_ldisc *ld = tty_ldisc_get(ldisc);
 785
 786         if (IS_ERR(ld))
 787                 return -1;
 788
 789         tty_ldisc_close(tty, tty->ldisc);
 790         tty_ldisc_put(tty->ldisc);
 791         tty->ldisc = NULL;
 792         /*
 793          *      Switch the line discipline back
 794          */
 795         tty_ldisc_assign(tty, ld);
 796         tty_set_termios_ldisc(tty, ldisc);
 797
 798         return 0;
 799 }
 800
 801 /**
 802  *      tty_ldisc_hangup                -       hangup ldisc reset
 803  *      @tty: tty being hung up
 804  *
 805  *      Some tty devices reset their termios when they receive a hangup
 806  *      event. In that situation we must also switch back to N_TTY properly
 807  *      before we reset the termios data.
 808  *
 809  *      Locking: We can take the ldisc mutex as the rest of the code is
 810  *      careful to allow for this.
 811  *
 812  *      In the pty pair case this occurs in the close() path of the
 813  *      tty itself so we must be careful about locking rules.
 814  */
 815
 816 void tty_ldisc_hangup(struct tty_struct *tty)
 817 {
 818         struct tty_ldisc *ld;
 819         int reset = tty->driver->flags & TTY_DRIVER_RESET_TERMIOS;
 820         int err = 0;
 821
 822         /*
 823          * FIXME! What are the locking issues here? This may me overdoing
 824          * things... This question is especially important now that we've
 825          * removed the irqlock.
 826          */
 827         ld = tty_ldisc_ref(tty);
 828         if (ld != NULL) {
 829                 /* We may have no line discipline at this point */
 830                 if (ld->ops->flush_buffer)
 831                         ld->ops->flush_buffer(tty);
 832                 tty_driver_flush_buffer(tty);
 833                 if ((test_bit(TTY_DO_WRITE_WAKEUP, &tty->flags)) &&
 834                     ld->ops->write_wakeup)
 835                         ld->ops->write_wakeup(tty);
 836                 if (ld->ops->hangup)
 837                         ld->ops->hangup(tty);
 838                 tty_ldisc_deref(ld);
 839         }
 840         /*
 841          * FIXME: Once we trust the LDISC code better we can wait here for
 842          * ldisc completion and fix the driver call race
 843          */
 844         wake_up_interruptible_poll(&tty->write_wait, POLLOUT);
 845         wake_up_interruptible_poll(&tty->read_wait, POLLIN);
 846         /*
 847          * Shutdown the current line discipline, and reset it to
 848          * N_TTY if need be.
 849          *
 850          * Avoid racing set_ldisc or tty_ldisc_release
 851          */
 852         mutex_lock(&tty->ldisc_mutex);
 853
 854         /*
 855          * this is like tty_ldisc_halt, but we need to give up
 856          * the BTM before calling cancel_work_sync, which may
 857          * need to wait for another function taking the BTM
 858          */
 859         clear_bit(TTY_LDISC, &tty->flags);
 860         tty_unlock(tty);
 861         cancel_work_sync(&tty->port->buf.work);
 862         set_bit(TTY_LDISC_HALTED, &tty->flags);
 863         mutex_unlock(&tty->ldisc_mutex);
 864         tty_lock(tty);
 865         mutex_lock(&tty->ldisc_mutex);
 866
 867         /* At this point we have a closed ldisc and we want to
 868            reopen it. We could defer this to the next open but
 869            it means auditing a lot of other paths so this is
 870            a FIXME */
 871         if (tty_ldisc_hangup_wait_idle(tty)) {
 872                 if (reset == 0) {
 873
 874                         if (!tty_ldisc_reinit(tty, tty->termios.c_line))
 875                                 err = tty_ldisc_open(tty, tty->ldisc);
 876                         else
 877                                 err = 1;
 878                 }
 879                 /* If the re-open fails or we reset then go to N_TTY. The
 880                    N_TTY open cannot fail */
 881                 if (reset || err) {
 882                         BUG_ON(tty_ldisc_reinit(tty, N_TTY));
 883                         WARN_ON(tty_ldisc_open(tty, tty->ldisc));
 884                 }
 885                 tty_ldisc_enable(tty);
 886         }
 887         mutex_unlock(&tty->ldisc_mutex);
 888         if (reset)
 889                 tty_reset_termios(tty);
 890 }
 891
 892 /**
 893  *      tty_ldisc_setup                 -       open line discipline
 894  *      @tty: tty being shut down
 895  *      @o_tty: pair tty for pty/tty pairs
 896  *
 897  *      Called during the initial open of a tty/pty pair in order to set up the
 898  *      line disciplines and bind them to the tty. This has no locking issues
 899  *      as the device isn't yet active.
 900  */
 901
 902 int tty_ldisc_setup(struct tty_struct *tty, struct tty_struct *o_tty)
 903 {
 904         struct tty_ldisc *ld = tty->ldisc;
 905         int retval;
 906
 907         retval = tty_ldisc_open(tty, ld);
 908         if (retval)
 909                 return retval;
 910
 911         if (o_tty) {
 912                 retval = tty_ldisc_open(o_tty, o_tty->ldisc);
 913                 if (retval) {
 914                         tty_ldisc_close(tty, ld);
 915                         return retval;
 916                 }
 917                 tty_ldisc_enable(o_tty);
 918         }
 919         tty_ldisc_enable(tty);
 920         return 0;
 921 }
 922
 923 static void tty_ldisc_kill(struct tty_struct *tty)
 924 {
 925         /* There cannot be users from userspace now. But there still might be
 926          * drivers holding a reference via tty_ldisc_ref. Do not steal them the
 927          * ldisc until they are done. */
 928         tty_ldisc_wait_idle(tty, MAX_SCHEDULE_TIMEOUT);
 929
 930         mutex_lock(&tty->ldisc_mutex);
 931         /*
 932          * Now kill off the ldisc
 933          */
 934         tty_ldisc_close(tty, tty->ldisc);
 935         tty_ldisc_put(tty->ldisc);
 936         /* Force an oops if we mess this up */
 937         tty->ldisc = NULL;
 938
 939         /* Ensure the next open requests the N_TTY ldisc */
 940         tty_set_termios_ldisc(tty, N_TTY);
 941         mutex_unlock(&tty->ldisc_mutex);
 942 }
 943
 944 /**
 945  *      tty_ldisc_release               -       release line discipline
 946  *      @tty: tty being shut down
 947  *      @o_tty: pair tty for pty/tty pairs
 948  *
 949  *      Called during the final close of a tty/pty pair in order to shut down
 950  *      the line discpline layer. On exit the ldisc assigned is N_TTY and the
 951  *      ldisc has not been opened.
 952  */
 953
 954 void tty_ldisc_release(struct tty_struct *tty, struct tty_struct *o_tty)
 955 {
 956         /*
 957          * Prevent flush_to_ldisc() from rescheduling the work for later.  Then
 958          * kill any delayed work. As this is the final close it does not
 959          * race with the set_ldisc code path.
 960          */
 961
 962         tty_ldisc_halt(tty);
 963         if (o_tty)
 964                 tty_ldisc_halt(o_tty);
 965
 966         tty_ldisc_flush_works(tty);
 967         if (o_tty)
 968                 tty_ldisc_flush_works(o_tty);
 969
 970         tty_lock_pair(tty, o_tty);
 971         /* This will need doing differently if we need to lock */
 972         tty_ldisc_kill(tty);
 973         if (o_tty)
 974                 tty_ldisc_kill(o_tty);
 975
 976         tty_unlock_pair(tty, o_tty);
 977         /* And the memory resources remaining (buffers, termios) will be
 978            disposed of when the kref hits zero */
 979 }
 980
 981 /**
 982  *      tty_ldisc_init          -       ldisc setup for new tty
 983  *      @tty: tty being allocated
 984  *
 985  *      Set up the line discipline objects for a newly allocated tty. Note that
 986  *      the tty structure is not completely set up when this call is made.
 987  */
 988
 989 void tty_ldisc_init(struct tty_struct *tty)
 990 {
 991         struct tty_ldisc *ld = tty_ldisc_get(N_TTY);
 992         if (IS_ERR(ld))
 993                 panic("n_tty: init_tty");
 994         tty_ldisc_assign(tty, ld);
 995 }
 996
 997 /**
 998  *      tty_ldisc_init          -       ldisc cleanup for new tty
 999  *      @tty: tty that was allocated recently
1000  *
1001  *      The tty structure must not becompletely set up (tty_ldisc_setup) when
1002  *      this call is made.
1003  */
1004 void tty_ldisc_deinit(struct tty_struct *tty)
1005 {
1006         put_ldisc(tty->ldisc);
1007         tty_ldisc_assign(tty, NULL);
1008 }
1009
1010 void tty_ldisc_begin(void)
1011 {
1012         /* Setup the default TTY line discipline. */
1013         (void) tty_register_ldisc(N_TTY, &tty_ldisc_N_TTY);
1014 }