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