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 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/init.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 26 27 28 29 30 31 32 33
#undef LDISC_DEBUG_HANGUP

#ifdef LDISC_DEBUG_HANGUP
#define tty_ldisc_debug(tty, f, args...) ({				       \
	char __b[64];							       \
	printk(KERN_DEBUG "%s: %s: " f, __func__, tty_name(tty, __b), ##args); \
})
#else
#define tty_ldisc_debug(tty, f, args...)
#endif

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


41 42 43 44 45 46
/*
 *	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.
 */

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

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;

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

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

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

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

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

	return ret;
}
EXPORT_SYMBOL(tty_unregister_ldisc);

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

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

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

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

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

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

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

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

	ld->ops = ldops;
182
	ld->tty = tty;
183

A
Alan Cox 已提交
184
	return ld;
185 186
}

187 188 189 190 191 192 193 194 195 196
/**
 *	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;

197
	put_ldops(ld->ops);
198 199 200
	kfree(ld);
}

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

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

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

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

310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388

static inline int __lockfunc
tty_ldisc_lock(struct tty_struct *tty, unsigned long timeout)
{
	return ldsem_down_write(&tty->ldisc_sem, timeout);
}

static inline int __lockfunc
tty_ldisc_lock_nested(struct tty_struct *tty, unsigned long timeout)
{
	return ldsem_down_write_nested(&tty->ldisc_sem,
				       LDISC_SEM_OTHER, timeout);
}

static inline void tty_ldisc_unlock(struct tty_struct *tty)
{
	return ldsem_up_write(&tty->ldisc_sem);
}

static int __lockfunc
tty_ldisc_lock_pair_timeout(struct tty_struct *tty, struct tty_struct *tty2,
			    unsigned long timeout)
{
	int ret;

	if (tty < tty2) {
		ret = tty_ldisc_lock(tty, timeout);
		if (ret) {
			ret = tty_ldisc_lock_nested(tty2, timeout);
			if (!ret)
				tty_ldisc_unlock(tty);
		}
	} else {
		/* if this is possible, it has lots of implications */
		WARN_ON_ONCE(tty == tty2);
		if (tty2 && tty != tty2) {
			ret = tty_ldisc_lock(tty2, timeout);
			if (ret) {
				ret = tty_ldisc_lock_nested(tty, timeout);
				if (!ret)
					tty_ldisc_unlock(tty2);
			}
		} else
			ret = tty_ldisc_lock(tty, timeout);
	}

	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)
{
	tty_ldisc_unlock(tty);
	if (tty2)
		tty_ldisc_unlock(tty2);
}

static void __lockfunc tty_ldisc_enable_pair(struct tty_struct *tty,
					     struct tty_struct *tty2)
{
	clear_bit(TTY_LDISC_HALTED, &tty->flags);
	if (tty2)
		clear_bit(TTY_LDISC_HALTED, &tty2->flags);

	tty_ldisc_unlock_pair(tty, tty2);
}

A
Alan Cox 已提交
389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408
/**
 *	tty_ldisc_flush	-	flush line discipline queue
 *	@tty: tty
 *
 *	Flush the line discipline queue (if any) for this tty. If there
 *	is no line discipline active this is a no-op.
 */

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

409 410 411 412 413 414 415 416 417 418 419 420 421 422 423
/**
 *	tty_set_termios_ldisc		-	set ldisc field
 *	@tty: tty structure
 *	@num: line discipline number
 *
 *	This is probably overkill for real world processors but
 *	they are not on hot paths so a little discipline won't do
 *	any harm.
 *
 *	Locking: takes termios_mutex
 */

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

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

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

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

static void tty_ldisc_restore(struct tty_struct *tty, struct tty_ldisc *old)
{
	char buf[64];
A
Alan Cox 已提交
482 483
	struct tty_ldisc *new_ldisc;
	int r;
484 485

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

/**
 *	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 已提交
512 513 514
 *	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.
515 516 517 518 519
 */

int tty_set_ldisc(struct tty_struct *tty, int ldisc)
{
	int retval;
P
Peter Hurley 已提交
520
	struct tty_ldisc *old_ldisc, *new_ldisc;
521
	struct tty_struct *o_tty = tty->link;
522

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

527 528 529 530 531
	retval = tty_ldisc_lock_pair_timeout(tty, o_tty, 5 * HZ);
	if (retval) {
		tty_ldisc_put(new_ldisc);
		return retval;
	}
532

A
Alan Cox 已提交
533 534 535 536 537
	/*
	 *	Check the no-op case
	 */

	if (tty->ldisc->ops->num == ldisc) {
538
		tty_ldisc_enable_pair(tty, o_tty);
A
Alan Cox 已提交
539
		tty_ldisc_put(new_ldisc);
540 541 542
		return 0;
	}

543
	/* FIXME: why 'shutoff' input if the ldisc is locked? */
544 545
	tty->receive_room = 0;

P
Peter Hurley 已提交
546
	old_ldisc = tty->ldisc;
A
Alan Cox 已提交
547
	tty_lock(tty);
J
Jiri Slaby 已提交
548

549 550
	/* FIXME: for testing only */
	WARN_ON(test_bit(TTY_HUPPED, &tty->flags));
J
Jiri Slaby 已提交
551

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

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

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

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

575 576 577 578
	/* At this point we hold a reference to the new ldisc and a
	   a reference to the old ldisc. If we ended up flipping back
	   to the existing ldisc we have two references to it */

P
Peter Hurley 已提交
579
	if (tty->ldisc->ops->num != old_ldisc->ops->num && tty->ops->set_ldisc)
580 581
		tty->ops->set_ldisc(tty);

P
Peter Hurley 已提交
582
	tty_ldisc_put(old_ldisc);
583 584

	/*
A
Alan Cox 已提交
585
	 *	Allow ldisc referencing to occur again
586
	 */
587
	tty_ldisc_enable_pair(tty, o_tty);
588

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

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

A
Alan Cox 已提交
599 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)
{
	mutex_lock(&tty->termios_mutex);
609 610 611
	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);
A
Alan Cox 已提交
612 613 614 615 616 617 618
	mutex_unlock(&tty->termios_mutex);
}


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

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

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

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

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

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

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

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

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

	tty_unlock(tty);

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
	 */
690 691
	tty_ldisc_lock_pair(tty, tty->link);
	tty_lock(tty);
A
Arnd Bergmann 已提交
692

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

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

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

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

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

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

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

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

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

763 764 765 766 767
/**
 *	tty_ldisc_release		-	release line discipline
 *	@tty: tty being shut down
 *	@o_tty: pair tty for pty/tty pairs
 *
A
Alan Cox 已提交
768 769
 *	Called during the final close of a tty/pty pair in order to shut down
 *	the line discpline layer. On exit the ldisc assigned is N_TTY and the
A
Alan Cox 已提交
770
 *	ldisc has not been opened.
771 772 773 774 775
 */

void tty_ldisc_release(struct tty_struct *tty, struct tty_struct *o_tty)
{
	/*
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 781
	tty_ldisc_debug(tty, "closing ldisc: %p\n", tty->ldisc);

782
	tty_ldisc_lock_pair(tty, o_tty);
783
	tty_lock_pair(tty, o_tty);
784

A
Alan Cox 已提交
785
	tty_ldisc_kill(tty);
A
Alan Cox 已提交
786
	if (o_tty)
A
Alan Cox 已提交
787
		tty_ldisc_kill(o_tty);
788

A
Alan Cox 已提交
789
	tty_unlock_pair(tty, o_tty);
790 791
	tty_ldisc_unlock_pair(tty, o_tty);

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

	tty_ldisc_debug(tty, "ldisc closed\n");
796 797 798 799 800 801 802 803 804 805 806 807
}

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

814 815 816 817 818 819 820 821 822
/**
 *	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)
{
823
	tty_ldisc_put(tty->ldisc);
824
	tty->ldisc = NULL;
825 826
}

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