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
#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 143 144 145 146 147

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

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

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

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

	ld->ops = ldops;
178
	ld->tty = tty;
179

A
Alan Cox 已提交
180
	return ld;
181 182
}

183 184 185 186 187 188 189 190 191 192
/**
 *	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;

193
	put_ldops(ld->ops);
194 195 196
	kfree(ld);
}

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

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

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

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

306 307

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

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

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

P
Peter Hurley 已提交
325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342
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);
}

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

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

	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)
{
388
	__tty_ldisc_unlock(tty);
389
	if (tty2)
390
		__tty_ldisc_unlock(tty2);
391 392
}

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

void tty_ldisc_flush(struct tty_struct *tty)
{
	struct tty_ldisc *ld = tty_ldisc_ref(tty);
404 405 406

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

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

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

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

static int tty_ldisc_open(struct tty_struct *tty, struct tty_ldisc *ld)
{
	WARN_ON(test_and_set_bit(TTY_LDISC_OPEN, &tty->flags));
444 445
	if (ld->ops->open) {
		int ret;
446
                /* BTM here locks versus a hangup event */
447
		ret = ld->ops->open(tty);
J
Jiri Slaby 已提交
448 449
		if (ret)
			clear_bit(TTY_LDISC_OPEN, &tty->flags);
450 451

		tty_ldisc_debug(tty, "%p: opened\n", tty->ldisc);
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
	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);
472
	tty_ldisc_debug(tty, "%p: closed\n", tty->ldisc);
A
Alan Cox 已提交
473
}
474 475 476 477 478 479 480 481 482 483 484 485

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

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

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

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

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

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

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

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

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

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

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

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

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

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

580 581 582 583 584 585
	/* 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 已提交
586
	tty_ldisc_put(old_ldisc);
587 588

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

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

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

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


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

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

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

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

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

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

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

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

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

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

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

		/* 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 已提交
698
		if (reset == 0) {
699

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

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

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

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

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

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

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);
}

762 763
/**
 *	tty_ldisc_release		-	release line discipline
764
 *	@tty: tty being shut down (or one end of pty pair)
765
 *
766 767 768
 *	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.
769 770
 */

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

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

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

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

789
	tty_ldisc_debug(tty, "released\n");
790 791 792 793 794 795 796 797 798 799 800 801
}

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

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

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