tty_ldisc.c 22.0 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36
#include <linux/types.h>
#include <linux/major.h>
#include <linux/errno.h>
#include <linux/signal.h>
#include <linux/fcntl.h>
#include <linux/sched.h>
#include <linux/interrupt.h>
#include <linux/tty.h>
#include <linux/tty_driver.h>
#include <linux/tty_flip.h>
#include <linux/devpts_fs.h>
#include <linux/file.h>
#include <linux/console.h>
#include <linux/timer.h>
#include <linux/ctype.h>
#include <linux/kd.h>
#include <linux/mm.h>
#include <linux/string.h>
#include <linux/slab.h>
#include <linux/poll.h>
#include <linux/proc_fs.h>
#include <linux/init.h>
#include <linux/module.h>
#include <linux/device.h>
#include <linux/wait.h>
#include <linux/bitops.h>
#include <linux/delay.h>
#include <linux/seq_file.h>

#include <linux/uaccess.h>
#include <asm/system.h>

#include <linux/kbd_kern.h>
#include <linux/vt_kern.h>
#include <linux/selection.h>

37 38
#include <linux/smp_lock.h>	/* For the moment */

39 40 41 42 43 44 45 46 47 48 49 50 51 52
#include <linux/kmod.h>
#include <linux/nsproxy.h>

/*
 *	This guards the refcounted line discipline lists. The lock
 *	must be taken with irqs off because there are hangup path
 *	callers who will do ldisc lookups and cannot sleep.
 */

static DEFINE_SPINLOCK(tty_ldisc_lock);
static DECLARE_WAIT_QUEUE_HEAD(tty_ldisc_wait);
/* Line disc dispatch table */
static struct tty_ldisc_ops *tty_ldiscs[NR_LDISCS];

53 54 55 56 57 58 59
static inline struct tty_ldisc *get_ldisc(struct tty_ldisc *ld)
{
	if (ld)
		atomic_inc(&ld->users);
	return ld;
}

60
static void put_ldisc(struct tty_ldisc *ld)
61
{
62 63
	unsigned long flags;

64 65 66 67 68 69
	if (WARN_ON_ONCE(!ld))
		return;

	/*
	 * If this is the last user, free the ldisc, and
	 * release the ldisc ops.
70 71 72
	 *
	 * We really want an "atomic_dec_and_lock_irqsave()",
	 * but we don't have it, so this does it by hand.
73
	 */
74 75
	local_irq_save(flags);
	if (atomic_dec_and_lock(&ld->users, &tty_ldisc_lock)) {
76 77 78 79 80
		struct tty_ldisc_ops *ldo = ld->ops;

		ldo->refcount--;
		module_put(ldo->owner);
		spin_unlock_irqrestore(&tty_ldisc_lock, flags);
81 82 83

		kfree(ld);
		return;
84
	}
85
	local_irq_restore(flags);
86 87
}

88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149
/**
 *	tty_register_ldisc	-	install a line discipline
 *	@disc: ldisc number
 *	@new_ldisc: pointer to the ldisc object
 *
 *	Installs a new line discipline into the kernel. The discipline
 *	is set up as unreferenced and then made available to the kernel
 *	from this point onwards.
 *
 *	Locking:
 *		takes tty_ldisc_lock to guard against ldisc races
 */

int tty_register_ldisc(int disc, struct tty_ldisc_ops *new_ldisc)
{
	unsigned long flags;
	int ret = 0;

	if (disc < N_TTY || disc >= NR_LDISCS)
		return -EINVAL;

	spin_lock_irqsave(&tty_ldisc_lock, flags);
	tty_ldiscs[disc] = new_ldisc;
	new_ldisc->num = disc;
	new_ldisc->refcount = 0;
	spin_unlock_irqrestore(&tty_ldisc_lock, flags);

	return ret;
}
EXPORT_SYMBOL(tty_register_ldisc);

/**
 *	tty_unregister_ldisc	-	unload a line discipline
 *	@disc: ldisc number
 *	@new_ldisc: pointer to the ldisc object
 *
 *	Remove a line discipline from the kernel providing it is not
 *	currently in use.
 *
 *	Locking:
 *		takes tty_ldisc_lock to guard against ldisc races
 */

int tty_unregister_ldisc(int disc)
{
	unsigned long flags;
	int ret = 0;

	if (disc < N_TTY || disc >= NR_LDISCS)
		return -EINVAL;

	spin_lock_irqsave(&tty_ldisc_lock, flags);
	if (tty_ldiscs[disc]->refcount)
		ret = -EBUSY;
	else
		tty_ldiscs[disc] = NULL;
	spin_unlock_irqrestore(&tty_ldisc_lock, flags);

	return ret;
}
EXPORT_SYMBOL(tty_unregister_ldisc);

150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177
static struct tty_ldisc_ops *get_ldops(int disc)
{
	unsigned long flags;
	struct tty_ldisc_ops *ldops, *ret;

	spin_lock_irqsave(&tty_ldisc_lock, flags);
	ret = ERR_PTR(-EINVAL);
	ldops = tty_ldiscs[disc];
	if (ldops) {
		ret = ERR_PTR(-EAGAIN);
		if (try_module_get(ldops->owner)) {
			ldops->refcount++;
			ret = ldops;
		}
	}
	spin_unlock_irqrestore(&tty_ldisc_lock, flags);
	return ret;
}

static void put_ldops(struct tty_ldisc_ops *ldops)
{
	unsigned long flags;

	spin_lock_irqsave(&tty_ldisc_lock, flags);
	ldops->refcount--;
	module_put(ldops->owner);
	spin_unlock_irqrestore(&tty_ldisc_lock, flags);
}
178 179 180 181 182 183 184 185 186 187 188 189 190 191

/**
 *	tty_ldisc_get		-	take a reference to an ldisc
 *	@disc: ldisc number
 *
 *	Takes a reference to a line discipline. Deals with refcounts and
 *	module locking counts. Returns NULL if the discipline is not available.
 *	Returns a pointer to the discipline and bumps the ref count if it is
 *	available
 *
 *	Locking:
 *		takes tty_ldisc_lock to guard against ldisc races
 */

A
Alan Cox 已提交
192
static struct tty_ldisc *tty_ldisc_get(int disc)
193
{
A
Alan Cox 已提交
194
	struct tty_ldisc *ld;
195
	struct tty_ldisc_ops *ldops;
196 197

	if (disc < N_TTY || disc >= NR_LDISCS)
A
Alan Cox 已提交
198
		return ERR_PTR(-EINVAL);
199 200 201 202 203 204 205

	/*
	 * Get the ldisc ops - we may need to request them to be loaded
	 * dynamically and try again.
	 */
	ldops = get_ldops(disc);
	if (IS_ERR(ldops)) {
206
		request_module("tty-ldisc-%d", disc);
207 208 209 210 211 212 213 214 215
		ldops = get_ldops(disc);
		if (IS_ERR(ldops))
			return ERR_CAST(ldops);
	}

	ld = kmalloc(sizeof(struct tty_ldisc), GFP_KERNEL);
	if (ld == NULL) {
		put_ldops(ldops);
		return ERR_PTR(-ENOMEM);
216
	}
217 218 219

	ld->ops = ldops;
	atomic_set(&ld->users, 1);
A
Alan Cox 已提交
220
	return ld;
221 222
}

A
Alan Cox 已提交
223
static void *tty_ldiscs_seq_start(struct seq_file *m, loff_t *pos)
224 225 226 227
{
	return (*pos < NR_LDISCS) ? pos : NULL;
}

A
Alan Cox 已提交
228
static void *tty_ldiscs_seq_next(struct seq_file *m, void *v, loff_t *pos)
229 230 231 232 233 234 235 236 237 238 239 240
{
	(*pos)++;
	return (*pos < NR_LDISCS) ? pos : NULL;
}

static void tty_ldiscs_seq_stop(struct seq_file *m, void *v)
{
}

static int tty_ldiscs_seq_show(struct seq_file *m, void *v)
{
	int i = *(loff_t *)v;
241
	struct tty_ldisc_ops *ldops;
A
Alan Cox 已提交
242

243 244
	ldops = get_ldops(i);
	if (IS_ERR(ldops))
245
		return 0;
246 247
	seq_printf(m, "%-10s %2d\n", ldops->name ? ldops->name : "???", i);
	put_ldops(ldops);
248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276
	return 0;
}

static const struct seq_operations tty_ldiscs_seq_ops = {
	.start	= tty_ldiscs_seq_start,
	.next	= tty_ldiscs_seq_next,
	.stop	= tty_ldiscs_seq_stop,
	.show	= tty_ldiscs_seq_show,
};

static int proc_tty_ldiscs_open(struct inode *inode, struct file *file)
{
	return seq_open(file, &tty_ldiscs_seq_ops);
}

const struct file_operations tty_ldiscs_proc_fops = {
	.owner		= THIS_MODULE,
	.open		= proc_tty_ldiscs_open,
	.read		= seq_read,
	.llseek		= seq_lseek,
	.release	= seq_release,
};

/**
 *	tty_ldisc_assign	-	set ldisc on a tty
 *	@tty: tty to assign
 *	@ld: line discipline
 *
 *	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 279 280 281 282 283 284 285
 *	The tty instance refcount starts at zero.
 *
 *	Locking:
 *		Caller must hold references
 */

static void tty_ldisc_assign(struct tty_struct *tty, struct tty_ldisc *ld)
{
A
Alan Cox 已提交
286
	tty->ldisc = ld;
287 288 289 290 291 292 293 294 295 296 297 298 299 300
}

/**
 *	tty_ldisc_try		-	internal helper
 *	@tty: the tty
 *
 *	Make a single attempt to grab and bump the refcount on
 *	the tty ldisc. Return 0 on failure or 1 on success. This is
 *	used to implement both the waiting and non waiting versions
 *	of tty_ldisc_ref
 *
 *	Locking: takes tty_ldisc_lock
 */

301
static struct tty_ldisc *tty_ldisc_try(struct tty_struct *tty)
302 303 304 305 306
{
	unsigned long flags;
	struct tty_ldisc *ld;

	spin_lock_irqsave(&tty_ldisc_lock, flags);
307 308 309
	ld = NULL;
	if (test_bit(TTY_LDISC, &tty->flags))
		ld = get_ldisc(tty->ldisc);
310
	spin_unlock_irqrestore(&tty_ldisc_lock, flags);
311
	return ld;
312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331
}

/**
 *	tty_ldisc_ref_wait	-	wait for the tty ldisc
 *	@tty: tty device
 *
 *	Dereference the line discipline for the terminal and take a
 *	reference to it. If the line discipline is in flux then
 *	wait patiently until it changes.
 *
 *	Note: Must not be called from an IRQ/timer context. The caller
 *	must also be careful not to hold other locks that will deadlock
 *	against a discipline change, such as an existing ldisc reference
 *	(which we check for)
 *
 *	Locking: call functions take tty_ldisc_lock
 */

struct tty_ldisc *tty_ldisc_ref_wait(struct tty_struct *tty)
{
332 333
	struct tty_ldisc *ld;

334
	/* wait_event is a macro */
335 336
	wait_event(tty_ldisc_wait, (ld = tty_ldisc_try(tty)) != NULL);
	return ld;
337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352
}
EXPORT_SYMBOL_GPL(tty_ldisc_ref_wait);

/**
 *	tty_ldisc_ref		-	get the tty ldisc
 *	@tty: tty device
 *
 *	Dereference the line discipline for the terminal and take a
 *	reference to it. If the line discipline is in flux then
 *	return NULL. Can be called from IRQ and timer functions.
 *
 *	Locking: called functions take tty_ldisc_lock
 */

struct tty_ldisc *tty_ldisc_ref(struct tty_struct *tty)
{
353
	return tty_ldisc_try(tty);
354 355 356 357 358 359 360 361 362 363 364 365 366 367 368
}
EXPORT_SYMBOL_GPL(tty_ldisc_ref);

/**
 *	tty_ldisc_deref		-	free a tty ldisc reference
 *	@ld: reference to free up
 *
 *	Undoes the effect of tty_ldisc_ref or tty_ldisc_ref_wait. May
 *	be called in IRQ context.
 *
 *	Locking: takes tty_ldisc_lock
 */

void tty_ldisc_deref(struct tty_ldisc *ld)
{
369
	put_ldisc(ld);
370 371 372
}
EXPORT_SYMBOL_GPL(tty_ldisc_deref);

373 374 375 376 377
static inline void tty_ldisc_put(struct tty_ldisc *ld)
{
	put_ldisc(ld);
}

378 379 380 381 382
/**
 *	tty_ldisc_enable	-	allow ldisc use
 *	@tty: terminal to activate ldisc on
 *
 *	Set the TTY_LDISC flag when the line discipline can be called
A
Alan Cox 已提交
383 384
 *	again. Do necessary wakeups for existing sleepers. Clear the LDISC
 *	changing flag to indicate any ldisc change is now over.
385
 *
A
Alan Cox 已提交
386 387
 *	Note: nobody should set the TTY_LDISC bit except via this function.
 *	Clearing directly is allowed.
388 389 390 391 392
 */

void tty_ldisc_enable(struct tty_struct *tty)
{
	set_bit(TTY_LDISC, &tty->flags);
A
Alan Cox 已提交
393
	clear_bit(TTY_LDISC_CHANGING, &tty->flags);
394 395 396
	wake_up(&tty_ldisc_wait);
}

A
Alan Cox 已提交
397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416
/**
 *	tty_ldisc_flush	-	flush line discipline queue
 *	@tty: tty
 *
 *	Flush the line discipline queue (if any) for this tty. If there
 *	is no line discipline active this is a no-op.
 */

void tty_ldisc_flush(struct tty_struct *tty)
{
	struct tty_ldisc *ld = tty_ldisc_ref(tty);
	if (ld) {
		if (ld->ops->flush_buffer)
			ld->ops->flush_buffer(tty);
		tty_ldisc_deref(ld);
	}
	tty_buffer_flush(tty);
}
EXPORT_SYMBOL_GPL(tty_ldisc_flush);

417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435
/**
 *	tty_set_termios_ldisc		-	set ldisc field
 *	@tty: tty structure
 *	@num: line discipline number
 *
 *	This is probably overkill for real world processors but
 *	they are not on hot paths so a little discipline won't do
 *	any harm.
 *
 *	Locking: takes termios_mutex
 */

static void tty_set_termios_ldisc(struct tty_struct *tty, int num)
{
	mutex_lock(&tty->termios_mutex);
	tty->termios->c_line = num;
	mutex_unlock(&tty->termios_mutex);
}

A
Alan Cox 已提交
436 437 438 439 440 441 442
/**
 *	tty_ldisc_open		-	open a line discipline
 *	@tty: tty we are opening the ldisc on
 *	@ld: discipline to open
 *
 *	A helper opening method. Also a convenient debugging and check
 *	point.
443 444
 *
 *	Locking: always called with BTM already held.
A
Alan Cox 已提交
445 446 447 448 449
 */

static int tty_ldisc_open(struct tty_struct *tty, struct tty_ldisc *ld)
{
	WARN_ON(test_and_set_bit(TTY_LDISC_OPEN, &tty->flags));
450 451
	if (ld->ops->open) {
		int ret;
452
                /* BTM here locks versus a hangup event */
A
Arnd Bergmann 已提交
453
		WARN_ON(!tty_locked());
454 455 456
		ret = ld->ops->open(tty);
		return ret;
	}
A
Alan Cox 已提交
457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475
	return 0;
}

/**
 *	tty_ldisc_close		-	close a line discipline
 *	@tty: tty we are opening the ldisc on
 *	@ld: discipline to close
 *
 *	A helper close method. Also a convenient debugging and check
 *	point.
 */

static void tty_ldisc_close(struct tty_struct *tty, struct tty_ldisc *ld)
{
	WARN_ON(!test_bit(TTY_LDISC_OPEN, &tty->flags));
	clear_bit(TTY_LDISC_OPEN, &tty->flags);
	if (ld->ops->close)
		ld->ops->close(tty);
}
476 477 478 479 480 481 482 483 484 485 486 487 488

/**
 *	tty_ldisc_restore	-	helper for tty ldisc change
 *	@tty: tty to recover
 *	@old: previous ldisc
 *
 *	Restore the previous line discipline or N_TTY when a line discipline
 *	change fails due to an open error
 */

static void tty_ldisc_restore(struct tty_struct *tty, struct tty_ldisc *old)
{
	char buf[64];
A
Alan Cox 已提交
489 490
	struct tty_ldisc *new_ldisc;
	int r;
491 492

	/* There is an outstanding reference here so this is safe */
A
Alan Cox 已提交
493 494
	old = tty_ldisc_get(old->ops->num);
	WARN_ON(IS_ERR(old));
495 496
	tty_ldisc_assign(tty, old);
	tty_set_termios_ldisc(tty, old->ops->num);
A
Alan Cox 已提交
497 498
	if (tty_ldisc_open(tty, old) < 0) {
		tty_ldisc_put(old);
499
		/* This driver is always present */
A
Alan Cox 已提交
500
		new_ldisc = tty_ldisc_get(N_TTY);
A
Alan Cox 已提交
501
		if (IS_ERR(new_ldisc))
502
			panic("n_tty: get");
A
Alan Cox 已提交
503
		tty_ldisc_assign(tty, new_ldisc);
504
		tty_set_termios_ldisc(tty, N_TTY);
A
Alan Cox 已提交
505 506 507 508 509
		r = tty_ldisc_open(tty, new_ldisc);
		if (r < 0)
			panic("Couldn't open N_TTY ldisc for "
			      "%s --- error %d.",
			      tty_name(tty, buf), r);
510 511 512
	}
}

513
/**
A
Alan Cox 已提交
514
 *	tty_ldisc_halt		-	shut down the line discipline
515 516 517 518 519 520 521
 *	@tty: tty device
 *
 *	Shut down the line discipline and work queue for this tty device.
 *	The TTY_LDISC flag being cleared ensures no further references can
 *	be obtained while the delayed work queue halt ensures that no more
 *	data is fed to the ldisc.
 *
522 523 524
 *	You need to do a 'flush_scheduled_work()' (outside the ldisc_mutex)
 *	in order to make sure any currently executing ldisc work is also
 *	flushed.
525 526
 */

A
Alan Cox 已提交
527
static int tty_ldisc_halt(struct tty_struct *tty)
528 529
{
	clear_bit(TTY_LDISC, &tty->flags);
530
	return cancel_delayed_work_sync(&tty->buf.work);
531 532
}

533 534 535 536 537 538
/**
 *	tty_set_ldisc		-	set line discipline
 *	@tty: the terminal to set
 *	@ldisc: the line discipline
 *
 *	Set the discipline of a tty line. Must be called from a process
A
Alan Cox 已提交
539 540 541
 *	context. The ldisc change logic has to protect itself against any
 *	overlapping ldisc change (including on the other end of pty pairs),
 *	the close of one side of a tty/pty pair, and eventually hangup.
542
 *
A
Alan Cox 已提交
543
 *	Locking: takes tty_ldisc_lock, termios_mutex
544 545 546 547 548
 */

int tty_set_ldisc(struct tty_struct *tty, int ldisc)
{
	int retval;
A
Alan Cox 已提交
549 550
	struct tty_ldisc *o_ldisc, *new_ldisc;
	int work, o_work = 0;
551 552
	struct tty_struct *o_tty;

A
Alan Cox 已提交
553 554 555
	new_ldisc = tty_ldisc_get(ldisc);
	if (IS_ERR(new_ldisc))
		return PTR_ERR(new_ldisc);
556

557
	tty_lock();
558
	/*
A
Alan Cox 已提交
559 560
	 *	We need to look at the tty locking here for pty/tty pairs
	 *	when both sides try to change in parallel.
561 562
	 */

A
Alan Cox 已提交
563 564
	o_tty = tty->link;	/* o_tty is the pty side or NULL */

565

A
Alan Cox 已提交
566 567 568 569 570
	/*
	 *	Check the no-op case
	 */

	if (tty->ldisc->ops->num == ldisc) {
571
		tty_unlock();
A
Alan Cox 已提交
572
		tty_ldisc_put(new_ldisc);
573 574 575
		return 0;
	}

576
	tty_unlock();
A
Alan Cox 已提交
577 578 579 580 581 582 583
	/*
	 *	Problem: What do we do if this blocks ?
	 *	We could deadlock here
	 */

	tty_wait_until_sent(tty, 0);

A
Arnd Bergmann 已提交
584
	tty_lock();
A
Alan Cox 已提交
585 586 587 588 589 590 591 592 593
	mutex_lock(&tty->ldisc_mutex);

	/*
	 *	We could be midstream of another ldisc change which has
	 *	dropped the lock during processing. If so we need to wait.
	 */

	while (test_bit(TTY_LDISC_CHANGING, &tty->flags)) {
		mutex_unlock(&tty->ldisc_mutex);
A
Arnd Bergmann 已提交
594
		tty_unlock();
A
Alan Cox 已提交
595 596
		wait_event(tty_ldisc_wait,
			test_bit(TTY_LDISC_CHANGING, &tty->flags) == 0);
A
Arnd Bergmann 已提交
597
		tty_lock();
A
Alan Cox 已提交
598 599
		mutex_lock(&tty->ldisc_mutex);
	}
600

A
Alan Cox 已提交
601
	set_bit(TTY_LDISC_CHANGING, &tty->flags);
A
Alan Cox 已提交
602

603 604 605 606 607 608 609 610
	/*
	 *	No more input please, we are switching. The new ldisc
	 *	will update this value in the ldisc open function
	 */

	tty->receive_room = 0;

	o_ldisc = tty->ldisc;
611

612
	tty_unlock();
613 614 615 616 617
	/*
	 *	Make sure we don't change while someone holds a
	 *	reference to the line discipline. The TTY_LDISC bit
	 *	prevents anyone taking a reference once it is clear.
	 *	We need the lock to avoid racing reference takers.
A
Alan Cox 已提交
618 619 620 621
	 *
	 *	We must clear the TTY_LDISC bit here to avoid a livelock
	 *	with a userspace app continually trying to use the tty in
	 *	parallel to the change and re-referencing the tty.
622 623
	 */

A
Alan Cox 已提交
624
	work = tty_ldisc_halt(tty);
625
	if (o_tty)
A
Alan Cox 已提交
626
		o_work = tty_ldisc_halt(o_tty);
627 628

	/*
A
Alan Cox 已提交
629 630
	 * Wait for ->hangup_work and ->buf.work handlers to terminate.
	 * We must drop the mutex here in case a hangup is also in process.
631
	 */
A
Alan Cox 已提交
632 633 634

	mutex_unlock(&tty->ldisc_mutex);

635
	flush_scheduled_work();
A
Alan Cox 已提交
636

637
	tty_lock();
A
Arnd Bergmann 已提交
638
	mutex_lock(&tty->ldisc_mutex);
A
Alan Cox 已提交
639 640 641 642 643 644
	if (test_bit(TTY_HUPPED, &tty->flags)) {
		/* We were raced by the hangup method. It will have stomped
		   the ldisc data and closed the ldisc down */
		clear_bit(TTY_LDISC_CHANGING, &tty->flags);
		mutex_unlock(&tty->ldisc_mutex);
		tty_ldisc_put(new_ldisc);
645
		tty_unlock();
A
Alan Cox 已提交
646 647 648
		return -EIO;
	}

649
	/* Shutdown the current discipline. */
A
Alan Cox 已提交
650
	tty_ldisc_close(tty, o_ldisc);
651 652

	/* Now set up the new line discipline. */
A
Alan Cox 已提交
653
	tty_ldisc_assign(tty, new_ldisc);
654
	tty_set_termios_ldisc(tty, ldisc);
A
Alan Cox 已提交
655 656

	retval = tty_ldisc_open(tty, new_ldisc);
657
	if (retval < 0) {
A
Alan Cox 已提交
658 659 660
		/* Back to the old one or N_TTY if we can't */
		tty_ldisc_put(new_ldisc);
		tty_ldisc_restore(tty, o_ldisc);
661
	}
A
Alan Cox 已提交
662

663 664 665 666
	/* At this point we hold a reference to the new ldisc and a
	   a reference to the old ldisc. If we ended up flipping back
	   to the existing ldisc we have two references to it */

A
Alan Cox 已提交
667
	if (tty->ldisc->ops->num != o_ldisc->ops->num && tty->ops->set_ldisc)
668 669
		tty->ops->set_ldisc(tty);

A
Alan Cox 已提交
670
	tty_ldisc_put(o_ldisc);
671 672

	/*
A
Alan Cox 已提交
673
	 *	Allow ldisc referencing to occur again
674 675 676 677 678 679
	 */

	tty_ldisc_enable(tty);
	if (o_tty)
		tty_ldisc_enable(o_tty);

A
Alan Cox 已提交
680
	/* Restart the work queue in case no characters kick it off. Safe if
681 682 683
	   already running */
	if (work)
		schedule_delayed_work(&tty->buf.work, 1);
A
Alan Cox 已提交
684 685 686
	if (o_work)
		schedule_delayed_work(&o_tty->buf.work, 1);
	mutex_unlock(&tty->ldisc_mutex);
687
	tty_unlock();
688 689 690
	return retval;
}

A
Alan Cox 已提交
691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710
/**
 *	tty_reset_termios	-	reset terminal state
 *	@tty: tty to reset
 *
 *	Restore a terminal to the driver default state.
 */

static void tty_reset_termios(struct tty_struct *tty)
{
	mutex_lock(&tty->termios_mutex);
	*tty->termios = tty->driver->init_termios;
	tty->termios->c_ispeed = tty_termios_input_baud_rate(tty->termios);
	tty->termios->c_ospeed = tty_termios_baud_rate(tty->termios);
	mutex_unlock(&tty->termios_mutex);
}


/**
 *	tty_ldisc_reinit	-	reinitialise the tty ldisc
 *	@tty: tty to reinit
A
Alan Cox 已提交
711
 *	@ldisc: line discipline to reinitialize
A
Alan Cox 已提交
712
 *
A
Alan Cox 已提交
713 714
 *	Switch the tty to a line discipline and leave the ldisc
 *	state closed
A
Alan Cox 已提交
715 716
 */

A
Alan Cox 已提交
717
static void tty_ldisc_reinit(struct tty_struct *tty, int ldisc)
A
Alan Cox 已提交
718 719 720 721 722 723 724 725 726
{
	struct tty_ldisc *ld;

	tty_ldisc_close(tty, tty->ldisc);
	tty_ldisc_put(tty->ldisc);
	tty->ldisc = NULL;
	/*
	 *	Switch the line discipline back
	 */
A
Alan Cox 已提交
727
	ld = tty_ldisc_get(ldisc);
A
Alan Cox 已提交
728 729
	BUG_ON(IS_ERR(ld));
	tty_ldisc_assign(tty, ld);
A
Alan Cox 已提交
730
	tty_set_termios_ldisc(tty, ldisc);
A
Alan Cox 已提交
731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750
}

/**
 *	tty_ldisc_hangup		-	hangup ldisc reset
 *	@tty: tty being hung up
 *
 *	Some tty devices reset their termios when they receive a hangup
 *	event. In that situation we must also switch back to N_TTY properly
 *	before we reset the termios data.
 *
 *	Locking: We can take the ldisc mutex as the rest of the code is
 *	careful to allow for this.
 *
 *	In the pty pair case this occurs in the close() path of the
 *	tty itself so we must be careful about locking rules.
 */

void tty_ldisc_hangup(struct tty_struct *tty)
{
	struct tty_ldisc *ld;
A
Alan Cox 已提交
751 752
	int reset = tty->driver->flags & TTY_DRIVER_RESET_TERMIOS;
	int err = 0;
A
Alan Cox 已提交
753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779

	/*
	 * FIXME! What are the locking issues here? This may me overdoing
	 * things... This question is especially important now that we've
	 * removed the irqlock.
	 */
	ld = tty_ldisc_ref(tty);
	if (ld != NULL) {
		/* We may have no line discipline at this point */
		if (ld->ops->flush_buffer)
			ld->ops->flush_buffer(tty);
		tty_driver_flush_buffer(tty);
		if ((test_bit(TTY_DO_WRITE_WAKEUP, &tty->flags)) &&
		    ld->ops->write_wakeup)
			ld->ops->write_wakeup(tty);
		if (ld->ops->hangup)
			ld->ops->hangup(tty);
		tty_ldisc_deref(ld);
	}
	/*
	 * FIXME: Once we trust the LDISC code better we can wait here for
	 * ldisc completion and fix the driver call race
	 */
	wake_up_interruptible_poll(&tty->write_wait, POLLOUT);
	wake_up_interruptible_poll(&tty->read_wait, POLLIN);
	/*
	 * Shutdown the current line discipline, and reset it to
A
Alan Cox 已提交
780 781 782
	 * N_TTY if need be.
	 *
	 * Avoid racing set_ldisc or tty_ldisc_release
A
Alan Cox 已提交
783
	 */
A
Alan Cox 已提交
784
	mutex_lock(&tty->ldisc_mutex);
A
Arnd Bergmann 已提交
785 786 787 788 789 790 791 792 793 794 795 796 797 798

	/*
	 * this is like tty_ldisc_halt, but we need to give up
	 * the BTM before calling cancel_delayed_work_sync,
	 * which may need to wait for another function taking the BTM
	 */
	clear_bit(TTY_LDISC, &tty->flags);
	tty_unlock();
	cancel_delayed_work_sync(&tty->buf.work);
	mutex_unlock(&tty->ldisc_mutex);

	tty_lock();
	mutex_lock(&tty->ldisc_mutex);

A
Alan Cox 已提交
799 800 801 802 803 804 805 806 807 808 809 810 811
	/* At this point we have a closed ldisc and we want to
	   reopen it. We could defer this to the next open but
	   it means auditing a lot of other paths so this is
	   a FIXME */
	if (tty->ldisc) {	/* Not yet closed */
		if (reset == 0) {
			tty_ldisc_reinit(tty, tty->termios->c_line);
			err = tty_ldisc_open(tty, tty->ldisc);
		}
		/* If the re-open fails or we reset then go to N_TTY. The
		   N_TTY open cannot fail */
		if (reset || err) {
			tty_ldisc_reinit(tty, N_TTY);
A
Alan Cox 已提交
812 813
			WARN_ON(tty_ldisc_open(tty, tty->ldisc));
		}
A
Alan Cox 已提交
814
		tty_ldisc_enable(tty);
A
Alan Cox 已提交
815
	}
A
Alan Cox 已提交
816 817 818
	mutex_unlock(&tty->ldisc_mutex);
	if (reset)
		tty_reset_termios(tty);
A
Alan Cox 已提交
819
}
820 821 822 823 824 825 826

/**
 *	tty_ldisc_setup			-	open line discipline
 *	@tty: tty being shut down
 *	@o_tty: pair tty for pty/tty pairs
 *
 *	Called during the initial open of a tty/pty pair in order to set up the
A
Alan Cox 已提交
827 828
 *	line disciplines and bind them to the tty. This has no locking issues
 *	as the device isn't yet active.
829 830 831 832
 */

int tty_ldisc_setup(struct tty_struct *tty, struct tty_struct *o_tty)
{
A
Alan Cox 已提交
833
	struct tty_ldisc *ld = tty->ldisc;
834 835
	int retval;

A
Alan Cox 已提交
836 837 838 839 840 841
	retval = tty_ldisc_open(tty, ld);
	if (retval)
		return retval;

	if (o_tty) {
		retval = tty_ldisc_open(o_tty, o_tty->ldisc);
842
		if (retval) {
A
Alan Cox 已提交
843
			tty_ldisc_close(tty, ld);
844 845 846 847 848 849 850 851 852 853 854 855
			return retval;
		}
		tty_ldisc_enable(o_tty);
	}
	tty_ldisc_enable(tty);
	return 0;
}
/**
 *	tty_ldisc_release		-	release line discipline
 *	@tty: tty being shut down
 *	@o_tty: pair tty for pty/tty pairs
 *
A
Alan Cox 已提交
856 857
 *	Called during the final close of a tty/pty pair in order to shut down
 *	the line discpline layer. On exit the ldisc assigned is N_TTY and the
A
Alan Cox 已提交
858
 *	ldisc has not been opened.
859 860 861 862 863 864 865 866 867 868
 */

void tty_ldisc_release(struct tty_struct *tty, struct tty_struct *o_tty)
{
	/*
	 * Prevent flush_to_ldisc() from rescheduling the work for later.  Then
	 * kill any delayed work. As this is the final close it does not
	 * race with the set_ldisc code path.
	 */

A
Arnd Bergmann 已提交
869
	tty_unlock();
870
	tty_ldisc_halt(tty);
A
Alan Cox 已提交
871
	flush_scheduled_work();
A
Arnd Bergmann 已提交
872
	tty_lock();
873

A
Alan Cox 已提交
874
	mutex_lock(&tty->ldisc_mutex);
875
	/*
876
	 * Now kill off the ldisc
877
	 */
878 879 880 881 882 883 884
	tty_ldisc_close(tty, tty->ldisc);
	tty_ldisc_put(tty->ldisc);
	/* Force an oops if we mess this up */
	tty->ldisc = NULL;

	/* Ensure the next open requests the N_TTY ldisc */
	tty_set_termios_ldisc(tty, N_TTY);
A
Alan Cox 已提交
885
	mutex_unlock(&tty->ldisc_mutex);
886

A
Alan Cox 已提交
887 888 889
	/* This will need doing differently if we need to lock */
	if (o_tty)
		tty_ldisc_release(o_tty, NULL);
890 891 892

	/* And the memory resources remaining (buffers, termios) will be
	   disposed of when the kref hits zero */
893 894 895 896 897 898 899 900 901 902 903 904
}

/**
 *	tty_ldisc_init		-	ldisc setup for new tty
 *	@tty: tty being allocated
 *
 *	Set up the line discipline objects for a newly allocated tty. Note that
 *	the tty structure is not completely set up when this call is made.
 */

void tty_ldisc_init(struct tty_struct *tty)
{
A
Alan Cox 已提交
905 906
	struct tty_ldisc *ld = tty_ldisc_get(N_TTY);
	if (IS_ERR(ld))
907
		panic("n_tty: init_tty");
A
Alan Cox 已提交
908
	tty_ldisc_assign(tty, ld);
909 910 911 912 913 914 915
}

void tty_ldisc_begin(void)
{
	/* Setup the default TTY line discipline. */
	(void) tty_register_ldisc(N_TTY, &tty_ldisc_N_TTY);
}