tty_ldisc.c 19.4 KB
Newer Older
1 2
#include <linux/types.h>
#include <linux/errno.h>
3
#include <linux/kmod.h>
4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19
#include <linux/sched.h>
#include <linux/interrupt.h>
#include <linux/tty.h>
#include <linux/tty_driver.h>
#include <linux/file.h>
#include <linux/mm.h>
#include <linux/string.h>
#include <linux/slab.h>
#include <linux/poll.h>
#include <linux/proc_fs.h>
#include <linux/module.h>
#include <linux/device.h>
#include <linux/wait.h>
#include <linux/bitops.h>
#include <linux/seq_file.h>
#include <linux/uaccess.h>
20
#include <linux/ratelimit.h>
21

22 23 24
#undef LDISC_DEBUG_HANGUP

#ifdef LDISC_DEBUG_HANGUP
25
#define tty_ldisc_debug(tty, f, args...)	tty_debug(tty, f, ##args)
26 27 28 29
#else
#define tty_ldisc_debug(tty, f, args...)
#endif

30 31 32 33 34 35 36
/* lockdep nested classes for tty->ldisc_sem */
enum {
	LDISC_SEM_NORMAL,
	LDISC_SEM_OTHER,
};


37 38 39 40 41 42
/*
 *	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.
 */

43
static DEFINE_RAW_SPINLOCK(tty_ldiscs_lock);
44 45 46 47 48 49 50 51 52 53 54 55 56
/* Line disc dispatch table */
static struct tty_ldisc_ops *tty_ldiscs[NR_LDISCS];

/**
 *	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:
57
 *		takes tty_ldiscs_lock to guard against ldisc races
58 59 60 61 62 63 64 65 66 67
 */

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;

68
	raw_spin_lock_irqsave(&tty_ldiscs_lock, flags);
69 70 71
	tty_ldiscs[disc] = new_ldisc;
	new_ldisc->num = disc;
	new_ldisc->refcount = 0;
72
	raw_spin_unlock_irqrestore(&tty_ldiscs_lock, flags);
73 74 75 76 77 78 79 80 81 82 83 84 85 86

	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:
87
 *		takes tty_ldiscs_lock to guard against ldisc races
88 89 90 91 92 93 94 95 96 97
 */

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

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

98
	raw_spin_lock_irqsave(&tty_ldiscs_lock, flags);
99 100 101 102
	if (tty_ldiscs[disc]->refcount)
		ret = -EBUSY;
	else
		tty_ldiscs[disc] = NULL;
103
	raw_spin_unlock_irqrestore(&tty_ldiscs_lock, flags);
104 105 106 107 108

	return ret;
}
EXPORT_SYMBOL(tty_unregister_ldisc);

109 110 111 112 113
static struct tty_ldisc_ops *get_ldops(int disc)
{
	unsigned long flags;
	struct tty_ldisc_ops *ldops, *ret;

114
	raw_spin_lock_irqsave(&tty_ldiscs_lock, flags);
115 116 117 118 119 120 121 122 123
	ret = ERR_PTR(-EINVAL);
	ldops = tty_ldiscs[disc];
	if (ldops) {
		ret = ERR_PTR(-EAGAIN);
		if (try_module_get(ldops->owner)) {
			ldops->refcount++;
			ret = ldops;
		}
	}
124
	raw_spin_unlock_irqrestore(&tty_ldiscs_lock, flags);
125 126 127 128 129 130 131
	return ret;
}

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

132
	raw_spin_lock_irqsave(&tty_ldiscs_lock, flags);
133 134
	ldops->refcount--;
	module_put(ldops->owner);
135
	raw_spin_unlock_irqrestore(&tty_ldiscs_lock, flags);
136
}
137 138 139 140 141 142

/**
 *	tty_ldisc_get		-	take a reference to an ldisc
 *	@disc: ldisc number
 *
 *	Takes a reference to a line discipline. Deals with refcounts and
143 144 145 146 147 148 149 150 151 152
 *	module locking counts.
 *
 *	Returns: -EINVAL if the discipline index is not [N_TTY..NR_LDISCS] or
 *			 if the discipline is not registered
 *		 -EAGAIN if request_module() failed to load or register the
 *			 the discipline
 *		 -ENOMEM if allocation failure
 *
 *		 Otherwise, returns a pointer to the discipline and bumps the
 *		 ref count
153 154
 *
 *	Locking:
155
 *		takes tty_ldiscs_lock to guard against ldisc races
156 157
 */

158
static struct tty_ldisc *tty_ldisc_get(struct tty_struct *tty, int disc)
159
{
A
Alan Cox 已提交
160
	struct tty_ldisc *ld;
161
	struct tty_ldisc_ops *ldops;
162 163

	if (disc < N_TTY || disc >= NR_LDISCS)
A
Alan Cox 已提交
164
		return ERR_PTR(-EINVAL);
165 166 167 168 169 170 171

	/*
	 * 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)) {
172
		request_module("tty-ldisc-%d", disc);
173 174 175 176 177 178 179 180 181
		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);
182
	}
183 184

	ld->ops = ldops;
185
	ld->tty = tty;
186

A
Alan Cox 已提交
187
	return ld;
188 189
}

190 191 192 193 194
/**
 *	tty_ldisc_put		-	release the ldisc
 *
 *	Complement of tty_ldisc_get().
 */
195
static void tty_ldisc_put(struct tty_ldisc *ld)
196 197 198 199
{
	if (WARN_ON_ONCE(!ld))
		return;

200
	put_ldops(ld->ops);
201 202 203
	kfree(ld);
}

A
Alan Cox 已提交
204
static void *tty_ldiscs_seq_start(struct seq_file *m, loff_t *pos)
205 206 207 208
{
	return (*pos < NR_LDISCS) ? pos : NULL;
}

A
Alan Cox 已提交
209
static void *tty_ldiscs_seq_next(struct seq_file *m, void *v, loff_t *pos)
210 211 212 213 214 215 216 217 218 219 220 221
{
	(*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;
222
	struct tty_ldisc_ops *ldops;
A
Alan Cox 已提交
223

224 225
	ldops = get_ldops(i);
	if (IS_ERR(ldops))
226
		return 0;
227 228
	seq_printf(m, "%-10s %2d\n", ldops->name ? ldops->name : "???", i);
	put_ldops(ldops);
229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259
	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_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.
 *
260 261 262
 *	Returns: NULL if the tty has been hungup and not re-opened with
 *		 a new file descriptor, otherwise valid ldisc reference
 *
263 264 265 266 267
 *	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)
 *
268 269
 *	Note: a file_operations routine (read/poll/write) should use this
 *	function to wait for any ldisc lifetime events to finish.
270 271 272 273
 */

struct tty_ldisc *tty_ldisc_ref_wait(struct tty_struct *tty)
{
274
	ldsem_down_read(&tty->ldisc_sem, MAX_SCHEDULE_TIMEOUT);
P
Peter Hurley 已提交
275 276
	if (!tty->ldisc)
		ldsem_up_read(&tty->ldisc_sem);
277
	return tty->ldisc;
278 279 280 281 282 283 284 285 286 287 288 289 290 291
}
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.
 */

struct tty_ldisc *tty_ldisc_ref(struct tty_struct *tty)
{
292 293 294 295 296 297 298 299
	struct tty_ldisc *ld = NULL;

	if (ldsem_down_read_trylock(&tty->ldisc_sem)) {
		ld = tty->ldisc;
		if (!ld)
			ldsem_up_read(&tty->ldisc_sem);
	}
	return ld;
300 301 302 303 304 305 306 307 308 309 310 311 312
}
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.
 */

void tty_ldisc_deref(struct tty_ldisc *ld)
{
313
	ldsem_up_read(&ld->tty->ldisc_sem);
314 315 316
}
EXPORT_SYMBOL_GPL(tty_ldisc_deref);

317

318
static inline int
319
__tty_ldisc_lock(struct tty_struct *tty, unsigned long timeout)
320 321 322 323
{
	return ldsem_down_write(&tty->ldisc_sem, timeout);
}

324
static inline int
325
__tty_ldisc_lock_nested(struct tty_struct *tty, unsigned long timeout)
326 327 328 329 330
{
	return ldsem_down_write_nested(&tty->ldisc_sem,
				       LDISC_SEM_OTHER, timeout);
}

331
static inline void __tty_ldisc_unlock(struct tty_struct *tty)
332
{
333
	ldsem_up_write(&tty->ldisc_sem);
334 335
}

336
static int tty_ldisc_lock(struct tty_struct *tty, unsigned long timeout)
P
Peter Hurley 已提交
337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352
{
	int ret;

	ret = __tty_ldisc_lock(tty, timeout);
	if (!ret)
		return -EBUSY;
	set_bit(TTY_LDISC_HALTED, &tty->flags);
	return 0;
}

static void tty_ldisc_unlock(struct tty_struct *tty)
{
	clear_bit(TTY_LDISC_HALTED, &tty->flags);
	__tty_ldisc_unlock(tty);
}

353
static int
354 355 356 357 358 359
tty_ldisc_lock_pair_timeout(struct tty_struct *tty, struct tty_struct *tty2,
			    unsigned long timeout)
{
	int ret;

	if (tty < tty2) {
360
		ret = __tty_ldisc_lock(tty, timeout);
361
		if (ret) {
362
			ret = __tty_ldisc_lock_nested(tty2, timeout);
363
			if (!ret)
364
				__tty_ldisc_unlock(tty);
365 366 367 368 369
		}
	} else {
		/* if this is possible, it has lots of implications */
		WARN_ON_ONCE(tty == tty2);
		if (tty2 && tty != tty2) {
370
			ret = __tty_ldisc_lock(tty2, timeout);
371
			if (ret) {
372
				ret = __tty_ldisc_lock_nested(tty, timeout);
373
				if (!ret)
374
					__tty_ldisc_unlock(tty2);
375 376
			}
		} else
377
			ret = __tty_ldisc_lock(tty, timeout);
378 379 380 381 382 383 384 385 386 387 388
	}

	if (!ret)
		return -EBUSY;

	set_bit(TTY_LDISC_HALTED, &tty->flags);
	if (tty2)
		set_bit(TTY_LDISC_HALTED, &tty2->flags);
	return 0;
}

389
static void tty_ldisc_lock_pair(struct tty_struct *tty, struct tty_struct *tty2)
390 391 392 393
{
	tty_ldisc_lock_pair_timeout(tty, tty2, MAX_SCHEDULE_TIMEOUT);
}

394 395
static void tty_ldisc_unlock_pair(struct tty_struct *tty,
				  struct tty_struct *tty2)
396
{
397
	__tty_ldisc_unlock(tty);
398
	if (tty2)
399
		__tty_ldisc_unlock(tty2);
400 401
}

A
Alan Cox 已提交
402 403 404 405
/**
 *	tty_ldisc_flush	-	flush line discipline queue
 *	@tty: tty
 *
406 407
 *	Flush the line discipline queue (if any) and the tty flip buffers
 *	for this tty.
A
Alan Cox 已提交
408 409 410 411 412
 */

void tty_ldisc_flush(struct tty_struct *tty)
{
	struct tty_ldisc *ld = tty_ldisc_ref(tty);
413 414 415

	tty_buffer_flush(tty, ld);
	if (ld)
A
Alan Cox 已提交
416 417 418 419
		tty_ldisc_deref(ld);
}
EXPORT_SYMBOL_GPL(tty_ldisc_flush);

420 421 422
/**
 *	tty_set_termios_ldisc		-	set ldisc field
 *	@tty: tty structure
423
 *	@disc: line discipline number
424 425 426 427 428
 *
 *	This is probably overkill for real world processors but
 *	they are not on hot paths so a little discipline won't do
 *	any harm.
 *
429 430 431 432
 *	The line discipline-related tty_struct fields are reset to
 *	prevent the ldisc driver from re-using stale information for
 *	the new ldisc instance.
 *
433
 *	Locking: takes termios_rwsem
434 435
 */

436
static void tty_set_termios_ldisc(struct tty_struct *tty, int disc)
437
{
438
	down_write(&tty->termios_rwsem);
439
	tty->termios.c_line = disc;
440
	up_write(&tty->termios_rwsem);
441 442 443

	tty->disc_data = NULL;
	tty->receive_room = 0;
444 445
}

A
Alan Cox 已提交
446 447 448 449 450 451 452
/**
 *	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.
453 454
 *
 *	Locking: always called with BTM already held.
A
Alan Cox 已提交
455 456 457 458 459
 */

static int tty_ldisc_open(struct tty_struct *tty, struct tty_ldisc *ld)
{
	WARN_ON(test_and_set_bit(TTY_LDISC_OPEN, &tty->flags));
460 461
	if (ld->ops->open) {
		int ret;
462
                /* BTM here locks versus a hangup event */
463
		ret = ld->ops->open(tty);
J
Jiri Slaby 已提交
464 465
		if (ret)
			clear_bit(TTY_LDISC_OPEN, &tty->flags);
466

P
Peter Hurley 已提交
467
		tty_ldisc_debug(tty, "%p: opened\n", ld);
468 469
		return ret;
	}
A
Alan Cox 已提交
470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487
	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);
P
Peter Hurley 已提交
488
	tty_ldisc_debug(tty, "%p: closed\n", ld);
A
Alan Cox 已提交
489
}
490 491 492 493 494 495 496 497 498 499 500 501

/**
 *	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)
{
A
Alan Cox 已提交
502 503
	struct tty_ldisc *new_ldisc;
	int r;
504 505

	/* There is an outstanding reference here so this is safe */
506
	old = tty_ldisc_get(tty, old->ops->num);
A
Alan Cox 已提交
507
	WARN_ON(IS_ERR(old));
508
	tty->ldisc = old;
509
	tty_set_termios_ldisc(tty, old->ops->num);
A
Alan Cox 已提交
510 511
	if (tty_ldisc_open(tty, old) < 0) {
		tty_ldisc_put(old);
512
		/* This driver is always present */
513
		new_ldisc = tty_ldisc_get(tty, N_TTY);
A
Alan Cox 已提交
514
		if (IS_ERR(new_ldisc))
515
			panic("n_tty: get");
516
		tty->ldisc = new_ldisc;
517
		tty_set_termios_ldisc(tty, N_TTY);
A
Alan Cox 已提交
518 519 520 521
		r = tty_ldisc_open(tty, new_ldisc);
		if (r < 0)
			panic("Couldn't open N_TTY ldisc for "
			      "%s --- error %d.",
522
			      tty_name(tty), r);
523 524 525 526 527 528 529 530 531
	}
}

/**
 *	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 已提交
532 533 534
 *	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.
535 536
 */

537
int tty_set_ldisc(struct tty_struct *tty, int disc)
538 539
{
	int retval;
P
Peter Hurley 已提交
540
	struct tty_ldisc *old_ldisc, *new_ldisc;
541

542
	new_ldisc = tty_ldisc_get(tty, disc);
A
Alan Cox 已提交
543 544
	if (IS_ERR(new_ldisc))
		return PTR_ERR(new_ldisc);
545

546
	tty_lock(tty);
P
Peter Hurley 已提交
547
	retval = tty_ldisc_lock(tty, 5 * HZ);
548 549
	if (retval)
		goto err;
550

P
Peter Hurley 已提交
551 552 553 554 555
	if (!tty->ldisc) {
		retval = -EIO;
		goto out;
	}

556
	/* Check the no-op case */
557
	if (tty->ldisc->ops->num == disc)
558
		goto out;
A
Alan Cox 已提交
559

560 561 562 563
	if (test_bit(TTY_HUPPED, &tty->flags)) {
		/* We were raced by hangup */
		retval = -EIO;
		goto out;
564 565
	}

P
Peter Hurley 已提交
566
	old_ldisc = tty->ldisc;
J
Jiri Slaby 已提交
567

P
Peter Hurley 已提交
568 569
	/* Shutdown the old discipline. */
	tty_ldisc_close(tty, old_ldisc);
570 571

	/* Now set up the new line discipline. */
572
	tty->ldisc = new_ldisc;
573
	tty_set_termios_ldisc(tty, disc);
A
Alan Cox 已提交
574 575

	retval = tty_ldisc_open(tty, new_ldisc);
576
	if (retval < 0) {
A
Alan Cox 已提交
577 578
		/* Back to the old one or N_TTY if we can't */
		tty_ldisc_put(new_ldisc);
P
Peter Hurley 已提交
579
		tty_ldisc_restore(tty, old_ldisc);
580
	}
A
Alan Cox 已提交
581

582 583
	if (tty->ldisc->ops->num != old_ldisc->ops->num && tty->ops->set_ldisc) {
		down_read(&tty->termios_rwsem);
584
		tty->ops->set_ldisc(tty);
585 586
		up_read(&tty->termios_rwsem);
	}
587

588 589 590 591 592
	/* At this point we hold a reference to the new ldisc and a
	   reference to the old ldisc, or we hold two references to
	   the old ldisc (if it was restored as part of error cleanup
	   above). In either case, releasing a single reference from
	   the old ldisc is correct. */
593 594
	new_ldisc = old_ldisc;
out:
P
Peter Hurley 已提交
595
	tty_ldisc_unlock(tty);
596

A
Alan Cox 已提交
597
	/* Restart the work queue in case no characters kick it off. Safe if
598
	   already running */
599
	tty_buffer_restart_work(tty->port);
600 601
err:
	tty_ldisc_put(new_ldisc);	/* drop the extra reference */
A
Alan Cox 已提交
602
	tty_unlock(tty);
603 604 605
	return retval;
}

P
Peter Hurley 已提交
606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624
/**
 *	tty_ldisc_kill	-	teardown ldisc
 *	@tty: tty being released
 *
 *	Perform final close of the ldisc and reset tty->ldisc
 */
static void tty_ldisc_kill(struct tty_struct *tty)
{
	if (!tty->ldisc)
		return;
	/*
	 * Now kill off the ldisc
	 */
	tty_ldisc_close(tty, tty->ldisc);
	tty_ldisc_put(tty->ldisc);
	/* Force an oops if we mess this up */
	tty->ldisc = NULL;
}

A
Alan Cox 已提交
625 626 627 628 629 630 631 632 633
/**
 *	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)
{
634
	down_write(&tty->termios_rwsem);
635 636 637
	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);
638
	up_write(&tty->termios_rwsem);
A
Alan Cox 已提交
639 640 641 642 643 644
}


/**
 *	tty_ldisc_reinit	-	reinitialise the tty ldisc
 *	@tty: tty to reinit
645
 *	@disc: line discipline to reinitialize
A
Alan Cox 已提交
646
 *
647
 *	Completely reinitialize the line discipline state, by closing the
648 649 650 651
 *	current instance, if there is one, and opening a new instance. If
 *	an error occurs opening the new non-N_TTY instance, the instance
 *	is dropped and tty->ldisc reset to NULL. The caller can then retry
 *	with N_TTY instead.
652 653
 *
 *	Returns 0 if successful, otherwise error code < 0
A
Alan Cox 已提交
654 655
 */

656
int tty_ldisc_reinit(struct tty_struct *tty, int disc)
A
Alan Cox 已提交
657
{
658 659
	struct tty_ldisc *ld;
	int retval;
660

661 662 663 664 665
	ld = tty_ldisc_get(tty, disc);
	if (IS_ERR(ld)) {
		BUG_ON(disc == N_TTY);
		return PTR_ERR(ld);
	}
A
Alan Cox 已提交
666

667 668 669 670 671 672
	if (tty->ldisc) {
		tty_ldisc_close(tty, tty->ldisc);
		tty_ldisc_put(tty->ldisc);
	}

	/* switch the line discipline */
673
	tty->ldisc = ld;
674
	tty_set_termios_ldisc(tty, disc);
675 676 677 678 679 680 681 682
	retval = tty_ldisc_open(tty, tty->ldisc);
	if (retval) {
		if (!WARN_ON(disc == N_TTY)) {
			tty_ldisc_put(tty->ldisc);
			tty->ldisc = NULL;
		}
	}
	return retval;
A
Alan Cox 已提交
683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699
}

/**
 *	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.
 */

700
void tty_ldisc_hangup(struct tty_struct *tty, bool reinit)
A
Alan Cox 已提交
701 702 703
{
	struct tty_ldisc *ld;

P
Peter Hurley 已提交
704
	tty_ldisc_debug(tty, "%p: hangup\n", tty->ldisc);
705

A
Alan Cox 已提交
706 707 708 709 710 711 712 713 714 715 716 717
	ld = tty_ldisc_ref(tty);
	if (ld != NULL) {
		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);
	}
718

A
Alan Cox 已提交
719 720
	wake_up_interruptible_poll(&tty->write_wait, POLLOUT);
	wake_up_interruptible_poll(&tty->read_wait, POLLIN);
721

A
Alan Cox 已提交
722 723
	/*
	 * Shutdown the current line discipline, and reset it to
A
Alan Cox 已提交
724 725 726
	 * N_TTY if need be.
	 *
	 * Avoid racing set_ldisc or tty_ldisc_release
A
Alan Cox 已提交
727
	 */
P
Peter Hurley 已提交
728
	tty_ldisc_lock(tty, MAX_SCHEDULE_TIMEOUT);
A
Arnd Bergmann 已提交
729

730 731
	if (tty->driver->flags & TTY_DRIVER_RESET_TERMIOS)
		tty_reset_termios(tty);
732

733 734 735 736 737 738
	if (tty->ldisc) {
		if (reinit) {
			if (tty_ldisc_reinit(tty, tty->termios.c_line) < 0)
				tty_ldisc_reinit(tty, N_TTY);
		} else
			tty_ldisc_kill(tty);
A
Alan Cox 已提交
739
	}
P
Peter Hurley 已提交
740
	tty_ldisc_unlock(tty);
A
Alan Cox 已提交
741
}
742 743 744 745 746 747 748

/**
 *	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 已提交
749 750
 *	line disciplines and bind them to the tty. This has no locking issues
 *	as the device isn't yet active.
751 752 753 754
 */

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

A
Alan Cox 已提交
758 759 760 761 762 763
	retval = tty_ldisc_open(tty, ld);
	if (retval)
		return retval;

	if (o_tty) {
		retval = tty_ldisc_open(o_tty, o_tty->ldisc);
764
		if (retval) {
A
Alan Cox 已提交
765
			tty_ldisc_close(tty, ld);
766 767 768 769 770
			return retval;
		}
	}
	return 0;
}
A
Alan Cox 已提交
771

772 773
/**
 *	tty_ldisc_release		-	release line discipline
774
 *	@tty: tty being shut down (or one end of pty pair)
775
 *
776
 *	Called during the final close of a tty or a pty pair in order to shut
777
 *	down the line discpline layer. On exit, each tty's ldisc is NULL.
778 779
 */

780
void tty_ldisc_release(struct tty_struct *tty)
781
{
782 783
	struct tty_struct *o_tty = tty->link;

784
	/*
785 786
	 * Shutdown this line discipline. As this is the final close,
	 * it does not race with the set_ldisc code path.
787 788
	 */

789
	tty_ldisc_lock_pair(tty, o_tty);
A
Alan Cox 已提交
790
	tty_ldisc_kill(tty);
A
Alan Cox 已提交
791
	if (o_tty)
A
Alan Cox 已提交
792
		tty_ldisc_kill(o_tty);
793 794
	tty_ldisc_unlock_pair(tty, o_tty);

795 796
	/* And the memory resources remaining (buffers, termios) will be
	   disposed of when the kref hits zero */
797

798
	tty_ldisc_debug(tty, "released\n");
799 800 801 802 803 804 805 806 807 808 809 810
}

/**
 *	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)
{
811
	struct tty_ldisc *ld = tty_ldisc_get(tty, N_TTY);
A
Alan Cox 已提交
812
	if (IS_ERR(ld))
813
		panic("n_tty: init_tty");
814
	tty->ldisc = ld;
815 816
}

817
/**
818
 *	tty_ldisc_deinit	-	ldisc cleanup for new tty
819 820 821 822 823 824 825
 *	@tty: tty that was allocated recently
 *
 *	The tty structure must not becompletely set up (tty_ldisc_setup) when
 *      this call is made.
 */
void tty_ldisc_deinit(struct tty_struct *tty)
{
826 827
	if (tty->ldisc)
		tty_ldisc_put(tty->ldisc);
828
	tty->ldisc = NULL;
829 830
}

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