tty_ldisc.c 19.9 KB
Newer Older
1
// SPDX-License-Identifier: GPL-2.0
2 3
#include <linux/types.h>
#include <linux/errno.h>
4
#include <linux/kmod.h>
5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20
#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>
21
#include <linux/ratelimit.h>
22

23 24 25
#undef LDISC_DEBUG_HANGUP

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

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


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

44
static DEFINE_RAW_SPINLOCK(tty_ldiscs_lock);
45 46 47 48 49 50 51 52 53 54 55 56 57
/* 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:
58
 *		takes tty_ldiscs_lock to guard against ldisc races
59 60 61 62 63 64 65 66 67 68
 */

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;

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

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

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

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

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

	return ret;
}
EXPORT_SYMBOL(tty_unregister_ldisc);

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

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

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

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

/**
 *	tty_ldisc_get		-	take a reference to an ldisc
 *	@disc: ldisc number
 *
 *	Takes a reference to a line discipline. Deals with refcounts and
144 145 146 147 148 149 150 151 152 153
 *	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
154 155
 *
 *	Locking:
156
 *		takes tty_ldiscs_lock to guard against ldisc races
157 158
 */

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

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

	/*
	 * 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)) {
173
		request_module("tty-ldisc-%d", disc);
174 175 176 177 178
		ldops = get_ldops(disc);
		if (IS_ERR(ldops))
			return ERR_CAST(ldops);
	}

179 180 181 182 183
	/*
	 * There is no way to handle allocation failure of only 16 bytes.
	 * Let's simplify error handling and save more memory.
	 */
	ld = kmalloc(sizeof(struct tty_ldisc), GFP_KERNEL | __GFP_NOFAIL);
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 275
	struct tty_ldisc *ld;

276
	ldsem_down_read(&tty->ldisc_sem, MAX_SCHEDULE_TIMEOUT);
277 278
	ld = tty->ldisc;
	if (!ld)
P
Peter Hurley 已提交
279
		ldsem_up_read(&tty->ldisc_sem);
280
	return ld;
281 282 283 284 285 286 287 288 289 290 291 292 293 294
}
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)
{
295 296 297 298 299 300 301 302
	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;
303 304 305 306 307 308 309 310 311 312 313 314 315
}
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)
{
316
	ldsem_up_read(&ld->tty->ldisc_sem);
317 318 319
}
EXPORT_SYMBOL_GPL(tty_ldisc_deref);

320

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

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

334
static inline void __tty_ldisc_unlock(struct tty_struct *tty)
335
{
336
	ldsem_up_write(&tty->ldisc_sem);
337 338
}

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

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

350
void tty_ldisc_unlock(struct tty_struct *tty)
P
Peter Hurley 已提交
351 352 353 354 355
{
	clear_bit(TTY_LDISC_HALTED, &tty->flags);
	__tty_ldisc_unlock(tty);
}

356
static int
357 358 359 360 361 362
tty_ldisc_lock_pair_timeout(struct tty_struct *tty, struct tty_struct *tty2,
			    unsigned long timeout)
{
	int ret;

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

	if (!ret)
		return -EBUSY;

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

392
static void tty_ldisc_lock_pair(struct tty_struct *tty, struct tty_struct *tty2)
393 394 395 396
{
	tty_ldisc_lock_pair_timeout(tty, tty2, MAX_SCHEDULE_TIMEOUT);
}

397 398
static void tty_ldisc_unlock_pair(struct tty_struct *tty,
				  struct tty_struct *tty2)
399
{
400
	__tty_ldisc_unlock(tty);
401
	if (tty2)
402
		__tty_ldisc_unlock(tty2);
403 404
}

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

void tty_ldisc_flush(struct tty_struct *tty)
{
	struct tty_ldisc *ld = tty_ldisc_ref(tty);
416 417 418

	tty_buffer_flush(tty, ld);
	if (ld)
A
Alan Cox 已提交
419 420 421 422
		tty_ldisc_deref(ld);
}
EXPORT_SYMBOL_GPL(tty_ldisc_flush);

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

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

	tty->disc_data = NULL;
	tty->receive_room = 0;
447 448
}

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

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

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

494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516
/**
 *	tty_ldisc_failto	-	helper for ldisc failback
 *	@tty: tty to open the ldisc on
 *	@ld: ldisc we are trying to fail back to
 *
 *	Helper to try and recover a tty when switching back to the old
 *	ldisc fails and we need something attached.
 */

static int tty_ldisc_failto(struct tty_struct *tty, int ld)
{
	struct tty_ldisc *disc = tty_ldisc_get(tty, ld);
	int r;

	if (IS_ERR(disc))
		return PTR_ERR(disc);
	tty->ldisc = disc;
	tty_set_termios_ldisc(tty, ld);
	if ((r = tty_ldisc_open(tty, disc)) < 0)
		tty_ldisc_put(disc);
	return r;
}

517 518 519 520 521 522 523 524 525 526 527 528
/**
 *	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)
{
	/* There is an outstanding reference here so this is safe */
529 530 531 532
	if (tty_ldisc_failto(tty, old->ops->num) < 0) {
		const char *name = tty_name(tty);

		pr_warn("Falling back ldisc for %s.\n", name);
533 534 535 536 537
		/* The traditional behaviour is to fall back to N_TTY, we
		   want to avoid falling back to N_NULL unless we have no
		   choice to avoid the risk of breaking anything */
		if (tty_ldisc_failto(tty, N_TTY) < 0 &&
		    tty_ldisc_failto(tty, N_NULL) < 0)
538
			panic("Couldn't open N_NULL ldisc for %s.", name);
539 540 541
	}
}

542 543 544 545 546 547
/**
 *	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 已提交
548 549 550
 *	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.
551 552
 */

553
int tty_set_ldisc(struct tty_struct *tty, int disc)
554
{
555 556 557 558 559 560
	int retval;
	struct tty_ldisc *old_ldisc, *new_ldisc;

	new_ldisc = tty_ldisc_get(tty, disc);
	if (IS_ERR(new_ldisc))
		return PTR_ERR(new_ldisc);
561

562
	tty_lock(tty);
P
Peter Hurley 已提交
563
	retval = tty_ldisc_lock(tty, 5 * HZ);
564 565
	if (retval)
		goto err;
566

P
Peter Hurley 已提交
567 568 569 570 571
	if (!tty->ldisc) {
		retval = -EIO;
		goto out;
	}

572
	/* Check the no-op case */
573
	if (tty->ldisc->ops->num == disc)
574
		goto out;
A
Alan Cox 已提交
575

576 577 578 579
	if (test_bit(TTY_HUPPED, &tty->flags)) {
		/* We were raced by hangup */
		retval = -EIO;
		goto out;
580 581
	}

582 583 584 585 586 587 588 589 590 591
	old_ldisc = tty->ldisc;

	/* Shutdown the old discipline. */
	tty_ldisc_close(tty, old_ldisc);

	/* Now set up the new line discipline. */
	tty->ldisc = new_ldisc;
	tty_set_termios_ldisc(tty, disc);

	retval = tty_ldisc_open(tty, new_ldisc);
592
	if (retval < 0) {
A
Alan Cox 已提交
593
		/* Back to the old one or N_TTY if we can't */
594 595
		tty_ldisc_put(new_ldisc);
		tty_ldisc_restore(tty, old_ldisc);
596
	}
A
Alan Cox 已提交
597

598
	if (tty->ldisc->ops->num != old_ldisc->ops->num && tty->ops->set_ldisc) {
599
		down_read(&tty->termios_rwsem);
600
		tty->ops->set_ldisc(tty);
601 602
		up_read(&tty->termios_rwsem);
	}
603

604 605 606 607 608 609
	/* 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. */
	new_ldisc = old_ldisc;
610
out:
P
Peter Hurley 已提交
611
	tty_ldisc_unlock(tty);
612

A
Alan Cox 已提交
613
	/* Restart the work queue in case no characters kick it off. Safe if
614
	   already running */
615
	tty_buffer_restart_work(tty->port);
616
err:
617
	tty_ldisc_put(new_ldisc);	/* drop the extra reference */
A
Alan Cox 已提交
618
	tty_unlock(tty);
619 620
	return retval;
}
621
EXPORT_SYMBOL_GPL(tty_set_ldisc);
622

P
Peter Hurley 已提交
623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641
/**
 *	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 已提交
642 643 644 645 646 647 648 649 650
/**
 *	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)
{
651
	down_write(&tty->termios_rwsem);
652 653 654
	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);
655
	up_write(&tty->termios_rwsem);
A
Alan Cox 已提交
656 657 658 659 660 661
}


/**
 *	tty_ldisc_reinit	-	reinitialise the tty ldisc
 *	@tty: tty to reinit
662
 *	@disc: line discipline to reinitialize
A
Alan Cox 已提交
663
 *
664
 *	Completely reinitialize the line discipline state, by closing the
665 666 667 668
 *	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.
669 670
 *
 *	Returns 0 if successful, otherwise error code < 0
A
Alan Cox 已提交
671 672
 */

673
int tty_ldisc_reinit(struct tty_struct *tty, int disc)
A
Alan Cox 已提交
674
{
675 676
	struct tty_ldisc *ld;
	int retval;
677

678
	ld = tty_ldisc_get(tty, disc);
679 680
	if (IS_ERR(ld)) {
		BUG_ON(disc == N_TTY);
681
		return PTR_ERR(ld);
682
	}
A
Alan Cox 已提交
683

684 685 686 687 688 689
	if (tty->ldisc) {
		tty_ldisc_close(tty, tty->ldisc);
		tty_ldisc_put(tty->ldisc);
	}

	/* switch the line discipline */
690
	tty->ldisc = ld;
691
	tty_set_termios_ldisc(tty, disc);
692 693
	retval = tty_ldisc_open(tty, tty->ldisc);
	if (retval) {
694 695
		tty_ldisc_put(tty->ldisc);
		tty->ldisc = NULL;
696 697
	}
	return retval;
A
Alan Cox 已提交
698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714
}

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

715
void tty_ldisc_hangup(struct tty_struct *tty, bool reinit)
A
Alan Cox 已提交
716 717 718
{
	struct tty_ldisc *ld;

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

A
Alan Cox 已提交
721 722 723 724 725 726 727 728 729 730 731 732
	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);
	}
733

734 735
	wake_up_interruptible_poll(&tty->write_wait, EPOLLOUT);
	wake_up_interruptible_poll(&tty->read_wait, EPOLLIN);
736

A
Alan Cox 已提交
737 738
	/*
	 * Shutdown the current line discipline, and reset it to
A
Alan Cox 已提交
739 740 741
	 * N_TTY if need be.
	 *
	 * Avoid racing set_ldisc or tty_ldisc_release
A
Alan Cox 已提交
742
	 */
P
Peter Hurley 已提交
743
	tty_ldisc_lock(tty, MAX_SCHEDULE_TIMEOUT);
A
Arnd Bergmann 已提交
744

745 746
	if (tty->driver->flags & TTY_DRIVER_RESET_TERMIOS)
		tty_reset_termios(tty);
747

748 749
	if (tty->ldisc) {
		if (reinit) {
750 751 752
			if (tty_ldisc_reinit(tty, tty->termios.c_line) < 0 &&
			    tty_ldisc_reinit(tty, N_TTY) < 0)
				WARN_ON(tty_ldisc_reinit(tty, N_NULL) < 0);
753 754
		} else
			tty_ldisc_kill(tty);
A
Alan Cox 已提交
755
	}
P
Peter Hurley 已提交
756
	tty_ldisc_unlock(tty);
A
Alan Cox 已提交
757
}
758 759 760 761 762 763 764

/**
 *	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 已提交
765 766
 *	line disciplines and bind them to the tty. This has no locking issues
 *	as the device isn't yet active.
767 768 769 770
 */

int tty_ldisc_setup(struct tty_struct *tty, struct tty_struct *o_tty)
{
771
	int retval = tty_ldisc_open(tty, tty->ldisc);
A
Alan Cox 已提交
772 773 774 775 776
	if (retval)
		return retval;

	if (o_tty) {
		retval = tty_ldisc_open(o_tty, o_tty->ldisc);
777
		if (retval) {
778
			tty_ldisc_close(tty, tty->ldisc);
779 780 781 782 783
			return retval;
		}
	}
	return 0;
}
A
Alan Cox 已提交
784

785 786
/**
 *	tty_ldisc_release		-	release line discipline
787
 *	@tty: tty being shut down (or one end of pty pair)
788
 *
789
 *	Called during the final close of a tty or a pty pair in order to shut
790
 *	down the line discpline layer. On exit, each tty's ldisc is NULL.
791 792
 */

793
void tty_ldisc_release(struct tty_struct *tty)
794
{
795 796
	struct tty_struct *o_tty = tty->link;

797
	/*
798 799
	 * Shutdown this line discipline. As this is the final close,
	 * it does not race with the set_ldisc code path.
800 801
	 */

802
	tty_ldisc_lock_pair(tty, o_tty);
A
Alan Cox 已提交
803
	tty_ldisc_kill(tty);
A
Alan Cox 已提交
804
	if (o_tty)
A
Alan Cox 已提交
805
		tty_ldisc_kill(o_tty);
806 807
	tty_ldisc_unlock_pair(tty, o_tty);

808 809
	/* And the memory resources remaining (buffers, termios) will be
	   disposed of when the kref hits zero */
810

811
	tty_ldisc_debug(tty, "released\n");
812
}
813
EXPORT_SYMBOL_GPL(tty_ldisc_release);
814 815 816 817 818 819 820 821 822

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

823
int tty_ldisc_init(struct tty_struct *tty)
824
{
825
	struct tty_ldisc *ld = tty_ldisc_get(tty, N_TTY);
A
Alan Cox 已提交
826
	if (IS_ERR(ld))
827
		return PTR_ERR(ld);
828
	tty->ldisc = ld;
829
	return 0;
830 831
}

832
/**
833
 *	tty_ldisc_deinit	-	ldisc cleanup for new tty
834 835 836 837 838 839 840
 *	@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)
{
841 842
	if (tty->ldisc)
		tty_ldisc_put(tty->ldisc);
843
	tty->ldisc = NULL;
844
}