drivers/tty/tty_ldisc.c

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