tty_ldisc.c 19.1 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 26
#define tty_ldisc_debug(tty, f, args...) ({				  \
	printk(KERN_DEBUG "%s: %s: " f, __func__, tty_name(tty), ##args); \
27 28 29 30 31
})
#else
#define tty_ldisc_debug(tty, f, args...)
#endif

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


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

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

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;

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

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

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

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

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

	return ret;
}
EXPORT_SYMBOL(tty_unregister_ldisc);

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

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

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

134
	raw_spin_lock_irqsave(&tty_ldiscs_lock, flags);
135 136
	ldops->refcount--;
	module_put(ldops->owner);
137
	raw_spin_unlock_irqrestore(&tty_ldiscs_lock, flags);
138
}
139 140 141 142 143 144 145 146 147 148 149

/**
 *	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:
150
 *		takes tty_ldiscs_lock to guard against ldisc races
151 152
 */

153
static struct tty_ldisc *tty_ldisc_get(struct tty_struct *tty, int disc)
154
{
A
Alan Cox 已提交
155
	struct tty_ldisc *ld;
156
	struct tty_ldisc_ops *ldops;
157 158

	if (disc < N_TTY || disc >= NR_LDISCS)
A
Alan Cox 已提交
159
		return ERR_PTR(-EINVAL);
160 161 162 163 164 165 166

	/*
	 * 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)) {
167
		request_module("tty-ldisc-%d", disc);
168 169 170 171 172 173 174 175 176
		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);
177
	}
178 179

	ld->ops = ldops;
180
	ld->tty = tty;
181

A
Alan Cox 已提交
182
	return ld;
183 184
}

185 186 187 188 189 190 191 192 193 194
/**
 *	tty_ldisc_put		-	release the ldisc
 *
 *	Complement of tty_ldisc_get().
 */
static inline void tty_ldisc_put(struct tty_ldisc *ld)
{
	if (WARN_ON_ONCE(!ld))
		return;

195
	put_ldops(ld->ops);
196 197 198
	kfree(ld);
}

A
Alan Cox 已提交
199
static void *tty_ldiscs_seq_start(struct seq_file *m, loff_t *pos)
200 201 202 203
{
	return (*pos < NR_LDISCS) ? pos : NULL;
}

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

219 220
	ldops = get_ldops(i);
	if (IS_ERR(ldops))
221
		return 0;
222 223
	seq_printf(m, "%-10s %2d\n", ldops->name ? ldops->name : "???", i);
	put_ldops(ldops);
224 225 226 227 228 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.
 *
 *	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)
 *
260 261
 *	Note: only callable from a file_operations routine (which
 *	guarantees tty->ldisc != NULL when the lock is acquired).
262 263 264 265
 */

struct tty_ldisc *tty_ldisc_ref_wait(struct tty_struct *tty)
{
266 267 268
	ldsem_down_read(&tty->ldisc_sem, MAX_SCHEDULE_TIMEOUT);
	WARN_ON(!tty->ldisc);
	return tty->ldisc;
269 270 271 272 273 274 275 276 277 278 279 280 281 282
}
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)
{
283 284 285 286 287 288 289 290
	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;
291 292 293 294 295 296 297 298 299 300 301 302 303
}
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)
{
304
	ldsem_up_read(&ld->tty->ldisc_sem);
305 306 307
}
EXPORT_SYMBOL_GPL(tty_ldisc_deref);

308 309

static inline int __lockfunc
310
__tty_ldisc_lock(struct tty_struct *tty, unsigned long timeout)
311 312 313 314 315
{
	return ldsem_down_write(&tty->ldisc_sem, timeout);
}

static inline int __lockfunc
316
__tty_ldisc_lock_nested(struct tty_struct *tty, unsigned long timeout)
317 318 319 320 321
{
	return ldsem_down_write_nested(&tty->ldisc_sem,
				       LDISC_SEM_OTHER, timeout);
}

322
static inline void __tty_ldisc_unlock(struct tty_struct *tty)
323 324 325 326
{
	return ldsem_up_write(&tty->ldisc_sem);
}

P
Peter Hurley 已提交
327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344
static int __lockfunc
tty_ldisc_lock(struct tty_struct *tty, unsigned long timeout)
{
	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);
}

345 346 347 348 349 350 351
static int __lockfunc
tty_ldisc_lock_pair_timeout(struct tty_struct *tty, struct tty_struct *tty2,
			    unsigned long timeout)
{
	int ret;

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

	if (!ret)
		return -EBUSY;

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

static void __lockfunc
tty_ldisc_lock_pair(struct tty_struct *tty, struct tty_struct *tty2)
{
	tty_ldisc_lock_pair_timeout(tty, tty2, MAX_SCHEDULE_TIMEOUT);
}

static void __lockfunc tty_ldisc_unlock_pair(struct tty_struct *tty,
					     struct tty_struct *tty2)
{
390
	__tty_ldisc_unlock(tty);
391
	if (tty2)
392
		__tty_ldisc_unlock(tty2);
393 394
}

A
Alan Cox 已提交
395 396 397 398
/**
 *	tty_ldisc_flush	-	flush line discipline queue
 *	@tty: tty
 *
399 400
 *	Flush the line discipline queue (if any) and the tty flip buffers
 *	for this tty.
A
Alan Cox 已提交
401 402 403 404 405
 */

void tty_ldisc_flush(struct tty_struct *tty)
{
	struct tty_ldisc *ld = tty_ldisc_ref(tty);
406 407 408

	tty_buffer_flush(tty, ld);
	if (ld)
A
Alan Cox 已提交
409 410 411 412
		tty_ldisc_deref(ld);
}
EXPORT_SYMBOL_GPL(tty_ldisc_flush);

413 414 415 416 417 418 419 420 421
/**
 *	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.
 *
422
 *	Locking: takes termios_rwsem
423 424 425 426
 */

static void tty_set_termios_ldisc(struct tty_struct *tty, int num)
{
427
	down_write(&tty->termios_rwsem);
428
	tty->termios.c_line = num;
429
	up_write(&tty->termios_rwsem);
430 431
}

A
Alan Cox 已提交
432 433 434 435 436 437 438
/**
 *	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.
439 440
 *
 *	Locking: always called with BTM already held.
A
Alan Cox 已提交
441 442 443 444 445
 */

static int tty_ldisc_open(struct tty_struct *tty, struct tty_ldisc *ld)
{
	WARN_ON(test_and_set_bit(TTY_LDISC_OPEN, &tty->flags));
446 447
	if (ld->ops->open) {
		int ret;
448
                /* BTM here locks versus a hangup event */
449
		ret = ld->ops->open(tty);
J
Jiri Slaby 已提交
450 451
		if (ret)
			clear_bit(TTY_LDISC_OPEN, &tty->flags);
452 453
		return ret;
	}
A
Alan Cox 已提交
454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472
	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);
}
473 474 475 476 477 478 479 480 481 482 483 484

/**
 *	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 已提交
485 486
	struct tty_ldisc *new_ldisc;
	int r;
487 488

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

/**
 *	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 已提交
515 516 517
 *	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.
518 519 520 521 522
 */

int tty_set_ldisc(struct tty_struct *tty, int ldisc)
{
	int retval;
P
Peter Hurley 已提交
523
	struct tty_ldisc *old_ldisc, *new_ldisc;
524

525
	new_ldisc = tty_ldisc_get(tty, ldisc);
A
Alan Cox 已提交
526 527
	if (IS_ERR(new_ldisc))
		return PTR_ERR(new_ldisc);
528

529
	tty_lock(tty);
P
Peter Hurley 已提交
530
	retval = tty_ldisc_lock(tty, 5 * HZ);
531 532
	if (retval) {
		tty_ldisc_put(new_ldisc);
533
		tty_unlock(tty);
534 535
		return retval;
	}
536

A
Alan Cox 已提交
537 538 539 540 541
	/*
	 *	Check the no-op case
	 */

	if (tty->ldisc->ops->num == ldisc) {
P
Peter Hurley 已提交
542
		tty_ldisc_unlock(tty);
A
Alan Cox 已提交
543
		tty_ldisc_put(new_ldisc);
544
		tty_unlock(tty);
545 546 547
		return 0;
	}

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

P
Peter Hurley 已提交
550
	if (test_bit(TTY_HUPPED, &tty->flags)) {
A
Alan Cox 已提交
551 552
		/* We were raced by the hangup method. It will have stomped
		   the ldisc data and closed the ldisc down */
P
Peter Hurley 已提交
553
		tty_ldisc_unlock(tty);
A
Alan Cox 已提交
554
		tty_ldisc_put(new_ldisc);
A
Alan Cox 已提交
555
		tty_unlock(tty);
A
Alan Cox 已提交
556 557 558
		return -EIO;
	}

P
Peter Hurley 已提交
559 560
	/* Shutdown the old discipline. */
	tty_ldisc_close(tty, old_ldisc);
561 562

	/* Now set up the new line discipline. */
563
	tty->ldisc = new_ldisc;
564
	tty_set_termios_ldisc(tty, ldisc);
A
Alan Cox 已提交
565 566

	retval = tty_ldisc_open(tty, new_ldisc);
567
	if (retval < 0) {
A
Alan Cox 已提交
568 569
		/* Back to the old one or N_TTY if we can't */
		tty_ldisc_put(new_ldisc);
P
Peter Hurley 已提交
570
		tty_ldisc_restore(tty, old_ldisc);
571
	}
A
Alan Cox 已提交
572

573 574
	if (tty->ldisc->ops->num != old_ldisc->ops->num && tty->ops->set_ldisc) {
		down_read(&tty->termios_rwsem);
575
		tty->ops->set_ldisc(tty);
576 577
		up_read(&tty->termios_rwsem);
	}
578

579 580 581 582 583 584
	/* 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. */

P
Peter Hurley 已提交
585
	tty_ldisc_put(old_ldisc);
586 587

	/*
A
Alan Cox 已提交
588
	 *	Allow ldisc referencing to occur again
589
	 */
P
Peter Hurley 已提交
590
	tty_ldisc_unlock(tty);
591

A
Alan Cox 已提交
592
	/* Restart the work queue in case no characters kick it off. Safe if
593
	   already running */
594 595
	schedule_work(&tty->port->buf.work);

A
Alan Cox 已提交
596
	tty_unlock(tty);
597 598 599
	return retval;
}

A
Alan Cox 已提交
600 601 602 603 604 605 606 607 608
/**
 *	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)
{
609
	down_write(&tty->termios_rwsem);
610 611 612
	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);
613
	up_write(&tty->termios_rwsem);
A
Alan Cox 已提交
614 615 616 617 618 619
}


/**
 *	tty_ldisc_reinit	-	reinitialise the tty ldisc
 *	@tty: tty to reinit
A
Alan Cox 已提交
620
 *	@ldisc: line discipline to reinitialize
A
Alan Cox 已提交
621
 *
A
Alan Cox 已提交
622 623
 *	Switch the tty to a line discipline and leave the ldisc
 *	state closed
A
Alan Cox 已提交
624 625
 */

626
static int tty_ldisc_reinit(struct tty_struct *tty, int ldisc)
A
Alan Cox 已提交
627
{
628
	struct tty_ldisc *ld = tty_ldisc_get(tty, ldisc);
629 630 631

	if (IS_ERR(ld))
		return -1;
A
Alan Cox 已提交
632 633 634 635 636 637

	tty_ldisc_close(tty, tty->ldisc);
	tty_ldisc_put(tty->ldisc);
	/*
	 *	Switch the line discipline back
	 */
638
	tty->ldisc = ld;
A
Alan Cox 已提交
639
	tty_set_termios_ldisc(tty, ldisc);
640 641

	return 0;
A
Alan Cox 已提交
642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661
}

/**
 *	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 已提交
662 663
	int reset = tty->driver->flags & TTY_DRIVER_RESET_TERMIOS;
	int err = 0;
A
Alan Cox 已提交
664

665 666
	tty_ldisc_debug(tty, "closing ldisc: %p\n", tty->ldisc);

A
Alan Cox 已提交
667 668 669 670 671 672 673 674 675 676 677 678
	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);
	}
679

A
Alan Cox 已提交
680 681
	wake_up_interruptible_poll(&tty->write_wait, POLLOUT);
	wake_up_interruptible_poll(&tty->read_wait, POLLIN);
682

A
Alan Cox 已提交
683 684
	/*
	 * Shutdown the current line discipline, and reset it to
A
Alan Cox 已提交
685 686 687
	 * N_TTY if need be.
	 *
	 * Avoid racing set_ldisc or tty_ldisc_release
A
Alan Cox 已提交
688
	 */
P
Peter Hurley 已提交
689
	tty_ldisc_lock(tty, MAX_SCHEDULE_TIMEOUT);
A
Arnd Bergmann 已提交
690

691
	if (tty->ldisc) {
692 693 694 695 696

		/* At this point we have a halted ldisc; we want to close it and
		   reopen a new ldisc. We could defer the reopen to the next
		   open but it means auditing a lot of other paths so this is
		   a FIXME */
A
Alan Cox 已提交
697
		if (reset == 0) {
698

699
			if (!tty_ldisc_reinit(tty, tty->termios.c_line))
700 701 702
				err = tty_ldisc_open(tty, tty->ldisc);
			else
				err = 1;
A
Alan Cox 已提交
703 704 705 706
		}
		/* If the re-open fails or we reset then go to N_TTY. The
		   N_TTY open cannot fail */
		if (reset || err) {
707
			BUG_ON(tty_ldisc_reinit(tty, N_TTY));
A
Alan Cox 已提交
708 709
			WARN_ON(tty_ldisc_open(tty, tty->ldisc));
		}
A
Alan Cox 已提交
710
	}
P
Peter Hurley 已提交
711
	tty_ldisc_unlock(tty);
A
Alan Cox 已提交
712 713
	if (reset)
		tty_reset_termios(tty);
714 715

	tty_ldisc_debug(tty, "re-opened ldisc: %p\n", tty->ldisc);
A
Alan Cox 已提交
716
}
717 718 719 720 721 722 723

/**
 *	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 已提交
724 725
 *	line disciplines and bind them to the tty. This has no locking issues
 *	as the device isn't yet active.
726 727 728 729
 */

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

A
Alan Cox 已提交
733 734 735 736 737 738
	retval = tty_ldisc_open(tty, ld);
	if (retval)
		return retval;

	if (o_tty) {
		retval = tty_ldisc_open(o_tty, o_tty->ldisc);
739
		if (retval) {
A
Alan Cox 已提交
740
			tty_ldisc_close(tty, ld);
741 742 743 744 745
			return retval;
		}
	}
	return 0;
}
A
Alan Cox 已提交
746 747 748 749 750 751 752 753 754 755 756 757 758 759 760

static void tty_ldisc_kill(struct tty_struct *tty)
{
	/*
	 * 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;

	/* Ensure the next open requests the N_TTY ldisc */
	tty_set_termios_ldisc(tty, N_TTY);
}

761 762
/**
 *	tty_ldisc_release		-	release line discipline
763
 *	@tty: tty being shut down (or one end of pty pair)
764
 *
765 766 767
 *	Called during the final close of a tty or a pty pair in order to shut
 *	down the line discpline layer. On exit, each ldisc assigned is N_TTY and
 *	each ldisc has not been opened.
768 769
 */

770
void tty_ldisc_release(struct tty_struct *tty)
771
{
772 773
	struct tty_struct *o_tty = tty->link;

774
	/*
775 776
	 * Shutdown this line discipline. As this is the final close,
	 * it does not race with the set_ldisc code path.
777 778
	 */

779 780
	tty_ldisc_debug(tty, "closing ldisc: %p\n", tty->ldisc);

781
	tty_ldisc_lock_pair(tty, o_tty);
A
Alan Cox 已提交
782
	tty_ldisc_kill(tty);
A
Alan Cox 已提交
783
	if (o_tty)
A
Alan Cox 已提交
784
		tty_ldisc_kill(o_tty);
785 786
	tty_ldisc_unlock_pair(tty, o_tty);

787 788
	/* And the memory resources remaining (buffers, termios) will be
	   disposed of when the kref hits zero */
789 790

	tty_ldisc_debug(tty, "ldisc closed\n");
791 792 793 794 795 796 797 798 799 800 801 802
}

/**
 *	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)
{
803
	struct tty_ldisc *ld = tty_ldisc_get(tty, N_TTY);
A
Alan Cox 已提交
804
	if (IS_ERR(ld))
805
		panic("n_tty: init_tty");
806
	tty->ldisc = ld;
807 808
}

809 810 811 812 813 814 815 816 817
/**
 *	tty_ldisc_init		-	ldisc cleanup for new tty
 *	@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)
{
818
	tty_ldisc_put(tty->ldisc);
819
	tty->ldisc = NULL;
820 821
}

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