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 25 26 27 28 29 30 31 32
#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

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


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

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

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;

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

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

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

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

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

	return ret;
}
EXPORT_SYMBOL(tty_unregister_ldisc);

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

309 310

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

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

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

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

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

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

	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)
{
391
	__tty_ldisc_unlock(tty);
392
	if (tty2)
393
		__tty_ldisc_unlock(tty2);
394 395
}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

P
Peter Hurley 已提交
552
	if (test_bit(TTY_HUPPED, &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 */
P
Peter Hurley 已提交
555
		tty_ldisc_unlock(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

P
Peter Hurley 已提交
575
	if (tty->ldisc->ops->num != old_ldisc->ops->num && tty->ops->set_ldisc)
576 577
		tty->ops->set_ldisc(tty);

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

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

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

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

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


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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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, "ldisc closed\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);
}