tty_ldisc.c 19.3 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 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

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 已提交
388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407
/**
 *	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);

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

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

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

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

/**
 *	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 已提交
481 482
	struct tty_ldisc *new_ldisc;
	int r;
483 484

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

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

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

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

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

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

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

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

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

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

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

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

P
Peter Hurley 已提交
571
	if (tty->ldisc->ops->num != old_ldisc->ops->num && tty->ops->set_ldisc)
572 573
		tty->ops->set_ldisc(tty);

574 575 576 577 578 579
	/* 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 已提交
580
	tty_ldisc_put(old_ldisc);
581 582

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

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

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

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


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

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

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

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

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

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

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

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

A
Alan Cox 已提交
677 678
	wake_up_interruptible_poll(&tty->write_wait, POLLOUT);
	wake_up_interruptible_poll(&tty->read_wait, POLLIN);
679

A
Alan Cox 已提交
680 681
	/*
	 * Shutdown the current line discipline, and reset it to
A
Alan Cox 已提交
682 683 684
	 * N_TTY if need be.
	 *
	 * Avoid racing set_ldisc or tty_ldisc_release
A
Alan Cox 已提交
685
	 */
686
	tty_ldisc_lock_pair(tty, tty->link);
A
Arnd Bergmann 已提交
687

688
	if (tty->ldisc) {
689 690 691 692 693

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

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

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

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

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

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

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

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

758 759 760 761 762
/**
 *	tty_ldisc_release		-	release line discipline
 *	@tty: tty being shut down
 *	@o_tty: pair tty for pty/tty pairs
 *
A
Alan Cox 已提交
763 764
 *	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 已提交
765
 *	ldisc has not been opened.
766 767
 *
 *	Holding ldisc_sem write lock serializes tty->ldisc changes.
768 769 770 771 772
 */

void tty_ldisc_release(struct tty_struct *tty, struct tty_struct *o_tty)
{
	/*
773 774
	 * Shutdown this line discipline. As this is the final close,
	 * it does not race with the set_ldisc code path.
775 776
	 */

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

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

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

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

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

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

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