Blame view

drivers/tty/tty_ldisc.c 23.3 KB
01e1abb2c   Alan Cox   tty: Split ldisc ...
1
2
3
4
5
6
7
8
9
10
11
12
  #include <linux/types.h>
  #include <linux/major.h>
  #include <linux/errno.h>
  #include <linux/signal.h>
  #include <linux/fcntl.h>
  #include <linux/sched.h>
  #include <linux/interrupt.h>
  #include <linux/tty.h>
  #include <linux/tty_driver.h>
  #include <linux/tty_flip.h>
  #include <linux/devpts_fs.h>
  #include <linux/file.h>
01e1abb2c   Alan Cox   tty: Split ldisc ...
13
14
15
16
17
18
19
20
21
22
23
  #include <linux/console.h>
  #include <linux/timer.h>
  #include <linux/ctype.h>
  #include <linux/kd.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>
01e1abb2c   Alan Cox   tty: Split ldisc ...
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
  #include <linux/device.h>
  #include <linux/wait.h>
  #include <linux/bitops.h>
  #include <linux/delay.h>
  #include <linux/seq_file.h>
  
  #include <linux/uaccess.h>
  #include <asm/system.h>
  
  #include <linux/kbd_kern.h>
  #include <linux/vt_kern.h>
  #include <linux/selection.h>
  
  #include <linux/kmod.h>
  #include <linux/nsproxy.h>
  
  /*
   *	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.
   */
  
  static DEFINE_SPINLOCK(tty_ldisc_lock);
  static DECLARE_WAIT_QUEUE_HEAD(tty_ldisc_wait);
100eeae2c   Jiri Slaby   TTY: restore tty_...
48
  static DECLARE_WAIT_QUEUE_HEAD(tty_ldisc_idle);
01e1abb2c   Alan Cox   tty: Split ldisc ...
49
50
  /* Line disc dispatch table */
  static struct tty_ldisc_ops *tty_ldiscs[NR_LDISCS];
65b770468   Linus Torvalds   tty-ldisc: turn l...
51
52
53
54
55
56
  static inline struct tty_ldisc *get_ldisc(struct tty_ldisc *ld)
  {
  	if (ld)
  		atomic_inc(&ld->users);
  	return ld;
  }
cbe9352fa   Linus Torvalds   tty-ldisc: be mor...
57
  static void put_ldisc(struct tty_ldisc *ld)
65b770468   Linus Torvalds   tty-ldisc: turn l...
58
  {
cbe9352fa   Linus Torvalds   tty-ldisc: be mor...
59
  	unsigned long flags;
65b770468   Linus Torvalds   tty-ldisc: turn l...
60
61
62
63
64
65
  	if (WARN_ON_ONCE(!ld))
  		return;
  
  	/*
  	 * If this is the last user, free the ldisc, and
  	 * release the ldisc ops.
cbe9352fa   Linus Torvalds   tty-ldisc: be mor...
66
67
68
  	 *
  	 * We really want an "atomic_dec_and_lock_irqsave()",
  	 * but we don't have it, so this does it by hand.
65b770468   Linus Torvalds   tty-ldisc: turn l...
69
  	 */
cbe9352fa   Linus Torvalds   tty-ldisc: be mor...
70
71
  	local_irq_save(flags);
  	if (atomic_dec_and_lock(&ld->users, &tty_ldisc_lock)) {
65b770468   Linus Torvalds   tty-ldisc: turn l...
72
  		struct tty_ldisc_ops *ldo = ld->ops;
65b770468   Linus Torvalds   tty-ldisc: turn l...
73
74
75
  		ldo->refcount--;
  		module_put(ldo->owner);
  		spin_unlock_irqrestore(&tty_ldisc_lock, flags);
cbe9352fa   Linus Torvalds   tty-ldisc: be mor...
76
77
78
  
  		kfree(ld);
  		return;
65b770468   Linus Torvalds   tty-ldisc: turn l...
79
  	}
cbe9352fa   Linus Torvalds   tty-ldisc: be mor...
80
  	local_irq_restore(flags);
100eeae2c   Jiri Slaby   TTY: restore tty_...
81
  	wake_up(&tty_ldisc_idle);
65b770468   Linus Torvalds   tty-ldisc: turn l...
82
  }
01e1abb2c   Alan Cox   tty: Split ldisc ...
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
  /**
   *	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:
   *		takes tty_ldisc_lock to guard against ldisc races
   */
  
  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;
  
  	spin_lock_irqsave(&tty_ldisc_lock, flags);
  	tty_ldiscs[disc] = new_ldisc;
  	new_ldisc->num = disc;
  	new_ldisc->refcount = 0;
  	spin_unlock_irqrestore(&tty_ldisc_lock, flags);
  
  	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:
   *		takes tty_ldisc_lock to guard against ldisc races
   */
  
  int tty_unregister_ldisc(int disc)
  {
  	unsigned long flags;
  	int ret = 0;
  
  	if (disc < N_TTY || disc >= NR_LDISCS)
  		return -EINVAL;
  
  	spin_lock_irqsave(&tty_ldisc_lock, flags);
  	if (tty_ldiscs[disc]->refcount)
  		ret = -EBUSY;
  	else
  		tty_ldiscs[disc] = NULL;
  	spin_unlock_irqrestore(&tty_ldisc_lock, flags);
  
  	return ret;
  }
  EXPORT_SYMBOL(tty_unregister_ldisc);
f0de0e8d3   Linus Torvalds   tty-ldisc: make /...
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
  static struct tty_ldisc_ops *get_ldops(int disc)
  {
  	unsigned long flags;
  	struct tty_ldisc_ops *ldops, *ret;
  
  	spin_lock_irqsave(&tty_ldisc_lock, flags);
  	ret = ERR_PTR(-EINVAL);
  	ldops = tty_ldiscs[disc];
  	if (ldops) {
  		ret = ERR_PTR(-EAGAIN);
  		if (try_module_get(ldops->owner)) {
  			ldops->refcount++;
  			ret = ldops;
  		}
  	}
  	spin_unlock_irqrestore(&tty_ldisc_lock, flags);
  	return ret;
  }
  
  static void put_ldops(struct tty_ldisc_ops *ldops)
  {
  	unsigned long flags;
  
  	spin_lock_irqsave(&tty_ldisc_lock, flags);
  	ldops->refcount--;
  	module_put(ldops->owner);
  	spin_unlock_irqrestore(&tty_ldisc_lock, flags);
  }
01e1abb2c   Alan Cox   tty: Split ldisc ...
172
173
  
  /**
01e1abb2c   Alan Cox   tty: Split ldisc ...
174
175
   *	tty_ldisc_get		-	take a reference to an ldisc
   *	@disc: ldisc number
01e1abb2c   Alan Cox   tty: Split ldisc ...
176
177
178
179
180
181
182
183
184
   *
   *	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:
   *		takes tty_ldisc_lock to guard against ldisc races
   */
c65c9bc3e   Alan Cox   tty: rewrite the ...
185
  static struct tty_ldisc *tty_ldisc_get(int disc)
01e1abb2c   Alan Cox   tty: Split ldisc ...
186
  {
c65c9bc3e   Alan Cox   tty: rewrite the ...
187
  	struct tty_ldisc *ld;
182274f85   Linus Torvalds   tty-ldisc: get ri...
188
  	struct tty_ldisc_ops *ldops;
01e1abb2c   Alan Cox   tty: Split ldisc ...
189
190
  
  	if (disc < N_TTY || disc >= NR_LDISCS)
c65c9bc3e   Alan Cox   tty: rewrite the ...
191
  		return ERR_PTR(-EINVAL);
182274f85   Linus Torvalds   tty-ldisc: get ri...
192
193
194
195
196
197
198
  
  	/*
  	 * 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)) {
01e1abb2c   Alan Cox   tty: Split ldisc ...
199
  		request_module("tty-ldisc-%d", disc);
182274f85   Linus Torvalds   tty-ldisc: get ri...
200
201
202
203
204
205
206
207
208
  		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);
01e1abb2c   Alan Cox   tty: Split ldisc ...
209
  	}
182274f85   Linus Torvalds   tty-ldisc: get ri...
210
211
212
  
  	ld->ops = ldops;
  	atomic_set(&ld->users, 1);
c65c9bc3e   Alan Cox   tty: rewrite the ...
213
  	return ld;
01e1abb2c   Alan Cox   tty: Split ldisc ...
214
  }
852e99d22   Alan Cox   tty: bring ldisc ...
215
  static void *tty_ldiscs_seq_start(struct seq_file *m, loff_t *pos)
01e1abb2c   Alan Cox   tty: Split ldisc ...
216
217
218
  {
  	return (*pos < NR_LDISCS) ? pos : NULL;
  }
852e99d22   Alan Cox   tty: bring ldisc ...
219
  static void *tty_ldiscs_seq_next(struct seq_file *m, void *v, loff_t *pos)
01e1abb2c   Alan Cox   tty: Split ldisc ...
220
221
222
223
224
225
226
227
228
229
230
231
  {
  	(*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;
f0de0e8d3   Linus Torvalds   tty-ldisc: make /...
232
  	struct tty_ldisc_ops *ldops;
852e99d22   Alan Cox   tty: bring ldisc ...
233

f0de0e8d3   Linus Torvalds   tty-ldisc: make /...
234
235
  	ldops = get_ldops(i);
  	if (IS_ERR(ldops))
01e1abb2c   Alan Cox   tty: Split ldisc ...
236
  		return 0;
f0de0e8d3   Linus Torvalds   tty-ldisc: make /...
237
238
239
  	seq_printf(m, "%-10s %2d
  ", ldops->name ? ldops->name : "???", i);
  	put_ldops(ldops);
01e1abb2c   Alan Cox   tty: Split ldisc ...
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
  	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_assign	-	set ldisc on a tty
   *	@tty: tty to assign
   *	@ld: line discipline
   *
   *	Install an instance of a line discipline into a tty structure. The
8d2ead743   Alan Cox   tty: Fix leaks in...
269
   *	ldisc must have a reference count above zero to ensure it remains.
01e1abb2c   Alan Cox   tty: Split ldisc ...
270
271
272
273
274
275
276
277
   *	The tty instance refcount starts at zero.
   *
   *	Locking:
   *		Caller must hold references
   */
  
  static void tty_ldisc_assign(struct tty_struct *tty, struct tty_ldisc *ld)
  {
c65c9bc3e   Alan Cox   tty: rewrite the ...
278
  	tty->ldisc = ld;
01e1abb2c   Alan Cox   tty: Split ldisc ...
279
280
281
282
283
284
285
286
287
288
289
290
291
  }
  
  /**
   *	tty_ldisc_try		-	internal helper
   *	@tty: the tty
   *
   *	Make a single attempt to grab and bump the refcount on
   *	the tty ldisc. Return 0 on failure or 1 on success. This is
   *	used to implement both the waiting and non waiting versions
   *	of tty_ldisc_ref
   *
   *	Locking: takes tty_ldisc_lock
   */
65b770468   Linus Torvalds   tty-ldisc: turn l...
292
  static struct tty_ldisc *tty_ldisc_try(struct tty_struct *tty)
01e1abb2c   Alan Cox   tty: Split ldisc ...
293
294
295
  {
  	unsigned long flags;
  	struct tty_ldisc *ld;
01e1abb2c   Alan Cox   tty: Split ldisc ...
296
297
  
  	spin_lock_irqsave(&tty_ldisc_lock, flags);
65b770468   Linus Torvalds   tty-ldisc: turn l...
298
299
300
  	ld = NULL;
  	if (test_bit(TTY_LDISC, &tty->flags))
  		ld = get_ldisc(tty->ldisc);
01e1abb2c   Alan Cox   tty: Split ldisc ...
301
  	spin_unlock_irqrestore(&tty_ldisc_lock, flags);
65b770468   Linus Torvalds   tty-ldisc: turn l...
302
  	return ld;
01e1abb2c   Alan Cox   tty: Split ldisc ...
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
  }
  
  /**
   *	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)
   *
   *	Locking: call functions take tty_ldisc_lock
   */
  
  struct tty_ldisc *tty_ldisc_ref_wait(struct tty_struct *tty)
  {
65b770468   Linus Torvalds   tty-ldisc: turn l...
323
  	struct tty_ldisc *ld;
01e1abb2c   Alan Cox   tty: Split ldisc ...
324
  	/* wait_event is a macro */
65b770468   Linus Torvalds   tty-ldisc: turn l...
325
326
  	wait_event(tty_ldisc_wait, (ld = tty_ldisc_try(tty)) != NULL);
  	return ld;
01e1abb2c   Alan Cox   tty: Split ldisc ...
327
  }
01e1abb2c   Alan Cox   tty: Split ldisc ...
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
  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.
   *
   *	Locking: called functions take tty_ldisc_lock
   */
  
  struct tty_ldisc *tty_ldisc_ref(struct tty_struct *tty)
  {
65b770468   Linus Torvalds   tty-ldisc: turn l...
343
  	return tty_ldisc_try(tty);
01e1abb2c   Alan Cox   tty: Split ldisc ...
344
  }
01e1abb2c   Alan Cox   tty: Split ldisc ...
345
346
347
348
349
350
351
352
353
354
355
356
357
358
  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.
   *
   *	Locking: takes tty_ldisc_lock
   */
  
  void tty_ldisc_deref(struct tty_ldisc *ld)
  {
65b770468   Linus Torvalds   tty-ldisc: turn l...
359
  	put_ldisc(ld);
01e1abb2c   Alan Cox   tty: Split ldisc ...
360
  }
01e1abb2c   Alan Cox   tty: Split ldisc ...
361
  EXPORT_SYMBOL_GPL(tty_ldisc_deref);
65b770468   Linus Torvalds   tty-ldisc: turn l...
362
363
364
365
  static inline void tty_ldisc_put(struct tty_ldisc *ld)
  {
  	put_ldisc(ld);
  }
01e1abb2c   Alan Cox   tty: Split ldisc ...
366
367
368
369
370
  /**
   *	tty_ldisc_enable	-	allow ldisc use
   *	@tty: terminal to activate ldisc on
   *
   *	Set the TTY_LDISC flag when the line discipline can be called
c9b3976e3   Alan Cox   tty: Fix PPP hang...
371
372
   *	again. Do necessary wakeups for existing sleepers. Clear the LDISC
   *	changing flag to indicate any ldisc change is now over.
01e1abb2c   Alan Cox   tty: Split ldisc ...
373
   *
c9b3976e3   Alan Cox   tty: Fix PPP hang...
374
375
   *	Note: nobody should set the TTY_LDISC bit except via this function.
   *	Clearing directly is allowed.
01e1abb2c   Alan Cox   tty: Split ldisc ...
376
377
378
379
380
   */
  
  void tty_ldisc_enable(struct tty_struct *tty)
  {
  	set_bit(TTY_LDISC, &tty->flags);
c9b3976e3   Alan Cox   tty: Fix PPP hang...
381
  	clear_bit(TTY_LDISC_CHANGING, &tty->flags);
01e1abb2c   Alan Cox   tty: Split ldisc ...
382
383
384
385
  	wake_up(&tty_ldisc_wait);
  }
  
  /**
f2c4c65c8   Alan Cox   tty: Move ldisc_f...
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
   *	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);
  }
f2c4c65c8   Alan Cox   tty: Move ldisc_f...
403
404
405
  EXPORT_SYMBOL_GPL(tty_ldisc_flush);
  
  /**
01e1abb2c   Alan Cox   tty: Split ldisc ...
406
407
408
409
410
411
412
413
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.
   *
   *	Locking: takes termios_mutex
   */
  
  static void tty_set_termios_ldisc(struct tty_struct *tty, int num)
  {
  	mutex_lock(&tty->termios_mutex);
  	tty->termios->c_line = num;
  	mutex_unlock(&tty->termios_mutex);
  }
c65c9bc3e   Alan Cox   tty: rewrite the ...
423
424
425
426
427
428
429
  /**
   *	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.
ec79d6056   Arnd Bergmann   tty: replace BKL ...
430
431
   *
   *	Locking: always called with BTM already held.
c65c9bc3e   Alan Cox   tty: rewrite the ...
432
433
434
435
436
   */
  
  static int tty_ldisc_open(struct tty_struct *tty, struct tty_ldisc *ld)
  {
  	WARN_ON(test_and_set_bit(TTY_LDISC_OPEN, &tty->flags));
f18f9498e   Alan Cox   tty: Push the loc...
437
438
  	if (ld->ops->open) {
  		int ret;
ec79d6056   Arnd Bergmann   tty: replace BKL ...
439
                  /* BTM here locks versus a hangup event */
ddcd9fb66   Arnd Bergmann   tty: remove tty_l...
440
  		WARN_ON(!tty_locked());
f18f9498e   Alan Cox   tty: Push the loc...
441
  		ret = ld->ops->open(tty);
7f90cfc50   Jiri Slaby   TTY: ldisc, fix o...
442
443
  		if (ret)
  			clear_bit(TTY_LDISC_OPEN, &tty->flags);
f18f9498e   Alan Cox   tty: Push the loc...
444
445
  		return ret;
  	}
c65c9bc3e   Alan Cox   tty: rewrite the ...
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
  	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);
  }
01e1abb2c   Alan Cox   tty: Split ldisc ...
465
466
467
468
469
470
471
472
473
474
475
476
477
  
  /**
   *	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];
c65c9bc3e   Alan Cox   tty: rewrite the ...
478
479
  	struct tty_ldisc *new_ldisc;
  	int r;
01e1abb2c   Alan Cox   tty: Split ldisc ...
480
481
  
  	/* There is an outstanding reference here so this is safe */
c65c9bc3e   Alan Cox   tty: rewrite the ...
482
483
  	old = tty_ldisc_get(old->ops->num);
  	WARN_ON(IS_ERR(old));
01e1abb2c   Alan Cox   tty: Split ldisc ...
484
485
  	tty_ldisc_assign(tty, old);
  	tty_set_termios_ldisc(tty, old->ops->num);
c65c9bc3e   Alan Cox   tty: rewrite the ...
486
487
  	if (tty_ldisc_open(tty, old) < 0) {
  		tty_ldisc_put(old);
01e1abb2c   Alan Cox   tty: Split ldisc ...
488
  		/* This driver is always present */
852e99d22   Alan Cox   tty: bring ldisc ...
489
  		new_ldisc = tty_ldisc_get(N_TTY);
c65c9bc3e   Alan Cox   tty: rewrite the ...
490
  		if (IS_ERR(new_ldisc))
01e1abb2c   Alan Cox   tty: Split ldisc ...
491
  			panic("n_tty: get");
c65c9bc3e   Alan Cox   tty: rewrite the ...
492
  		tty_ldisc_assign(tty, new_ldisc);
01e1abb2c   Alan Cox   tty: Split ldisc ...
493
  		tty_set_termios_ldisc(tty, N_TTY);
c65c9bc3e   Alan Cox   tty: rewrite the ...
494
495
496
497
498
  		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);
01e1abb2c   Alan Cox   tty: Split ldisc ...
499
500
501
502
  	}
  }
  
  /**
c65c9bc3e   Alan Cox   tty: rewrite the ...
503
   *	tty_ldisc_halt		-	shut down the line discipline
e8b70e7d3   Alan Cox   tty: Extract vari...
504
505
506
507
508
509
510
   *	@tty: tty device
   *
   *	Shut down the line discipline and work queue for this tty device.
   *	The TTY_LDISC flag being cleared ensures no further references can
   *	be obtained while the delayed work queue halt ensures that no more
   *	data is fed to the ldisc.
   *
5c58ceff1   Linus Torvalds   tty: make sure to...
511
512
513
   *	You need to do a 'flush_scheduled_work()' (outside the ldisc_mutex)
   *	in order to make sure any currently executing ldisc work is also
   *	flushed.
e8b70e7d3   Alan Cox   tty: Extract vari...
514
   */
c65c9bc3e   Alan Cox   tty: rewrite the ...
515
  static int tty_ldisc_halt(struct tty_struct *tty)
e8b70e7d3   Alan Cox   tty: Extract vari...
516
517
  {
  	clear_bit(TTY_LDISC, &tty->flags);
f23eb2b2b   Linus Torvalds   tty: stop using "...
518
  	return cancel_work_sync(&tty->buf.work);
e8b70e7d3   Alan Cox   tty: Extract vari...
519
520
521
  }
  
  /**
0a1f1a0b6   Tejun Heo   tty_ldisc: don't ...
522
523
524
525
526
527
528
529
530
   *	tty_ldisc_flush_works	-	flush all works of a tty
   *	@tty: tty device to flush works for
   *
   *	Sync flush all works belonging to @tty.
   */
  static void tty_ldisc_flush_works(struct tty_struct *tty)
  {
  	flush_work_sync(&tty->hangup_work);
  	flush_work_sync(&tty->SAK_work);
f23eb2b2b   Linus Torvalds   tty: stop using "...
531
  	flush_work_sync(&tty->buf.work);
0a1f1a0b6   Tejun Heo   tty_ldisc: don't ...
532
533
534
  }
  
  /**
100eeae2c   Jiri Slaby   TTY: restore tty_...
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
   *	tty_ldisc_wait_idle	-	wait for the ldisc to become idle
   *	@tty: tty to wait for
   *
   *	Wait for the line discipline to become idle. The discipline must
   *	have been halted for this to guarantee it remains idle.
   */
  static int tty_ldisc_wait_idle(struct tty_struct *tty)
  {
  	int ret;
  	ret = wait_event_interruptible_timeout(tty_ldisc_idle,
  			atomic_read(&tty->ldisc->users) == 1, 5 * HZ);
  	if (ret < 0)
  		return ret;
  	return ret > 0 ? 0 : -EBUSY;
  }
  
  /**
01e1abb2c   Alan Cox   tty: Split ldisc ...
552
553
554
555
556
   *	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
c65c9bc3e   Alan Cox   tty: rewrite the ...
557
558
559
   *	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.
01e1abb2c   Alan Cox   tty: Split ldisc ...
560
   *
c65c9bc3e   Alan Cox   tty: rewrite the ...
561
   *	Locking: takes tty_ldisc_lock, termios_mutex
01e1abb2c   Alan Cox   tty: Split ldisc ...
562
563
564
565
566
   */
  
  int tty_set_ldisc(struct tty_struct *tty, int ldisc)
  {
  	int retval;
c65c9bc3e   Alan Cox   tty: rewrite the ...
567
568
  	struct tty_ldisc *o_ldisc, *new_ldisc;
  	int work, o_work = 0;
01e1abb2c   Alan Cox   tty: Split ldisc ...
569
  	struct tty_struct *o_tty;
c65c9bc3e   Alan Cox   tty: rewrite the ...
570
571
572
  	new_ldisc = tty_ldisc_get(ldisc);
  	if (IS_ERR(new_ldisc))
  		return PTR_ERR(new_ldisc);
01e1abb2c   Alan Cox   tty: Split ldisc ...
573

ec79d6056   Arnd Bergmann   tty: replace BKL ...
574
  	tty_lock();
01e1abb2c   Alan Cox   tty: Split ldisc ...
575
  	/*
c65c9bc3e   Alan Cox   tty: rewrite the ...
576
577
  	 *	We need to look at the tty locking here for pty/tty pairs
  	 *	when both sides try to change in parallel.
01e1abb2c   Alan Cox   tty: Split ldisc ...
578
  	 */
c65c9bc3e   Alan Cox   tty: rewrite the ...
579
  	o_tty = tty->link;	/* o_tty is the pty side or NULL */
01e1abb2c   Alan Cox   tty: Split ldisc ...
580

c65c9bc3e   Alan Cox   tty: rewrite the ...
581
582
583
584
585
  	/*
  	 *	Check the no-op case
  	 */
  
  	if (tty->ldisc->ops->num == ldisc) {
ec79d6056   Arnd Bergmann   tty: replace BKL ...
586
  		tty_unlock();
c65c9bc3e   Alan Cox   tty: rewrite the ...
587
  		tty_ldisc_put(new_ldisc);
01e1abb2c   Alan Cox   tty: Split ldisc ...
588
589
  		return 0;
  	}
ec79d6056   Arnd Bergmann   tty: replace BKL ...
590
  	tty_unlock();
01e1abb2c   Alan Cox   tty: Split ldisc ...
591
  	/*
c65c9bc3e   Alan Cox   tty: rewrite the ...
592
593
594
595
596
  	 *	Problem: What do we do if this blocks ?
  	 *	We could deadlock here
  	 */
  
  	tty_wait_until_sent(tty, 0);
60af22d2e   Arnd Bergmann   tty: reorder ldis...
597
  	tty_lock();
c65c9bc3e   Alan Cox   tty: rewrite the ...
598
599
600
601
602
603
604
605
606
  	mutex_lock(&tty->ldisc_mutex);
  
  	/*
  	 *	We could be midstream of another ldisc change which has
  	 *	dropped the lock during processing. If so we need to wait.
  	 */
  
  	while (test_bit(TTY_LDISC_CHANGING, &tty->flags)) {
  		mutex_unlock(&tty->ldisc_mutex);
60af22d2e   Arnd Bergmann   tty: reorder ldis...
607
  		tty_unlock();
c65c9bc3e   Alan Cox   tty: rewrite the ...
608
609
  		wait_event(tty_ldisc_wait,
  			test_bit(TTY_LDISC_CHANGING, &tty->flags) == 0);
60af22d2e   Arnd Bergmann   tty: reorder ldis...
610
  		tty_lock();
c65c9bc3e   Alan Cox   tty: rewrite the ...
611
612
  		mutex_lock(&tty->ldisc_mutex);
  	}
eeb89d918   Alan Cox   tty: push the BKL...
613

c65c9bc3e   Alan Cox   tty: rewrite the ...
614
  	set_bit(TTY_LDISC_CHANGING, &tty->flags);
852e99d22   Alan Cox   tty: bring ldisc ...
615

c65c9bc3e   Alan Cox   tty: rewrite the ...
616
  	/*
01e1abb2c   Alan Cox   tty: Split ldisc ...
617
618
619
620
621
622
623
  	 *	No more input please, we are switching. The new ldisc
  	 *	will update this value in the ldisc open function
  	 */
  
  	tty->receive_room = 0;
  
  	o_ldisc = tty->ldisc;
eeb89d918   Alan Cox   tty: push the BKL...
624

ec79d6056   Arnd Bergmann   tty: replace BKL ...
625
  	tty_unlock();
01e1abb2c   Alan Cox   tty: Split ldisc ...
626
627
628
629
630
  	/*
  	 *	Make sure we don't change while someone holds a
  	 *	reference to the line discipline. The TTY_LDISC bit
  	 *	prevents anyone taking a reference once it is clear.
  	 *	We need the lock to avoid racing reference takers.
c9b3976e3   Alan Cox   tty: Fix PPP hang...
631
632
633
634
  	 *
  	 *	We must clear the TTY_LDISC bit here to avoid a livelock
  	 *	with a userspace app continually trying to use the tty in
  	 *	parallel to the change and re-referencing the tty.
01e1abb2c   Alan Cox   tty: Split ldisc ...
635
  	 */
c65c9bc3e   Alan Cox   tty: rewrite the ...
636
  	work = tty_ldisc_halt(tty);
01e1abb2c   Alan Cox   tty: Split ldisc ...
637
  	if (o_tty)
c65c9bc3e   Alan Cox   tty: rewrite the ...
638
  		o_work = tty_ldisc_halt(o_tty);
01e1abb2c   Alan Cox   tty: Split ldisc ...
639

01e1abb2c   Alan Cox   tty: Split ldisc ...
640
  	/*
c65c9bc3e   Alan Cox   tty: rewrite the ...
641
642
  	 * Wait for ->hangup_work and ->buf.work handlers to terminate.
  	 * We must drop the mutex here in case a hangup is also in process.
01e1abb2c   Alan Cox   tty: Split ldisc ...
643
  	 */
c65c9bc3e   Alan Cox   tty: rewrite the ...
644
645
  
  	mutex_unlock(&tty->ldisc_mutex);
0a1f1a0b6   Tejun Heo   tty_ldisc: don't ...
646
  	tty_ldisc_flush_works(tty);
c65c9bc3e   Alan Cox   tty: rewrite the ...
647

100eeae2c   Jiri Slaby   TTY: restore tty_...
648
  	retval = tty_ldisc_wait_idle(tty);
ec79d6056   Arnd Bergmann   tty: replace BKL ...
649
  	tty_lock();
60af22d2e   Arnd Bergmann   tty: reorder ldis...
650
  	mutex_lock(&tty->ldisc_mutex);
100eeae2c   Jiri Slaby   TTY: restore tty_...
651
652
653
654
655
656
  
  	/* handle wait idle failure locked */
  	if (retval) {
  		tty_ldisc_put(new_ldisc);
  		goto enable;
  	}
c65c9bc3e   Alan Cox   tty: rewrite the ...
657
658
659
660
661
662
  	if (test_bit(TTY_HUPPED, &tty->flags)) {
  		/* We were raced by the hangup method. It will have stomped
  		   the ldisc data and closed the ldisc down */
  		clear_bit(TTY_LDISC_CHANGING, &tty->flags);
  		mutex_unlock(&tty->ldisc_mutex);
  		tty_ldisc_put(new_ldisc);
ec79d6056   Arnd Bergmann   tty: replace BKL ...
663
  		tty_unlock();
c65c9bc3e   Alan Cox   tty: rewrite the ...
664
665
  		return -EIO;
  	}
01e1abb2c   Alan Cox   tty: Split ldisc ...
666
  	/* Shutdown the current discipline. */
c65c9bc3e   Alan Cox   tty: rewrite the ...
667
  	tty_ldisc_close(tty, o_ldisc);
01e1abb2c   Alan Cox   tty: Split ldisc ...
668
669
  
  	/* Now set up the new line discipline. */
c65c9bc3e   Alan Cox   tty: rewrite the ...
670
  	tty_ldisc_assign(tty, new_ldisc);
01e1abb2c   Alan Cox   tty: Split ldisc ...
671
  	tty_set_termios_ldisc(tty, ldisc);
c65c9bc3e   Alan Cox   tty: rewrite the ...
672
673
  
  	retval = tty_ldisc_open(tty, new_ldisc);
01e1abb2c   Alan Cox   tty: Split ldisc ...
674
  	if (retval < 0) {
c65c9bc3e   Alan Cox   tty: rewrite the ...
675
676
677
  		/* Back to the old one or N_TTY if we can't */
  		tty_ldisc_put(new_ldisc);
  		tty_ldisc_restore(tty, o_ldisc);
01e1abb2c   Alan Cox   tty: Split ldisc ...
678
  	}
c65c9bc3e   Alan Cox   tty: rewrite the ...
679

01e1abb2c   Alan Cox   tty: Split ldisc ...
680
681
682
  	/* 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 */
c65c9bc3e   Alan Cox   tty: rewrite the ...
683
  	if (tty->ldisc->ops->num != o_ldisc->ops->num && tty->ops->set_ldisc)
01e1abb2c   Alan Cox   tty: Split ldisc ...
684
  		tty->ops->set_ldisc(tty);
c65c9bc3e   Alan Cox   tty: rewrite the ...
685
  	tty_ldisc_put(o_ldisc);
01e1abb2c   Alan Cox   tty: Split ldisc ...
686

100eeae2c   Jiri Slaby   TTY: restore tty_...
687
  enable:
01e1abb2c   Alan Cox   tty: Split ldisc ...
688
  	/*
c65c9bc3e   Alan Cox   tty: rewrite the ...
689
  	 *	Allow ldisc referencing to occur again
01e1abb2c   Alan Cox   tty: Split ldisc ...
690
691
692
693
694
  	 */
  
  	tty_ldisc_enable(tty);
  	if (o_tty)
  		tty_ldisc_enable(o_tty);
c65c9bc3e   Alan Cox   tty: rewrite the ...
695
  	/* Restart the work queue in case no characters kick it off. Safe if
01e1abb2c   Alan Cox   tty: Split ldisc ...
696
697
  	   already running */
  	if (work)
f23eb2b2b   Linus Torvalds   tty: stop using "...
698
  		schedule_work(&tty->buf.work);
c65c9bc3e   Alan Cox   tty: rewrite the ...
699
  	if (o_work)
f23eb2b2b   Linus Torvalds   tty: stop using "...
700
  		schedule_work(&o_tty->buf.work);
c65c9bc3e   Alan Cox   tty: rewrite the ...
701
  	mutex_unlock(&tty->ldisc_mutex);
ec79d6056   Arnd Bergmann   tty: replace BKL ...
702
  	tty_unlock();
01e1abb2c   Alan Cox   tty: Split ldisc ...
703
704
  	return retval;
  }
c65c9bc3e   Alan Cox   tty: rewrite the ...
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
  /**
   *	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);
  	*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);
  	mutex_unlock(&tty->termios_mutex);
  }
  
  
  /**
   *	tty_ldisc_reinit	-	reinitialise the tty ldisc
   *	@tty: tty to reinit
638b9648a   Alan Cox   tty: Fix the ldis...
725
   *	@ldisc: line discipline to reinitialize
c65c9bc3e   Alan Cox   tty: rewrite the ...
726
   *
638b9648a   Alan Cox   tty: Fix the ldis...
727
728
   *	Switch the tty to a line discipline and leave the ldisc
   *	state closed
c65c9bc3e   Alan Cox   tty: rewrite the ...
729
   */
1c95ba1e1   Philippe Rétornaz   tty_ldisc: Fix BU...
730
  static int tty_ldisc_reinit(struct tty_struct *tty, int ldisc)
c65c9bc3e   Alan Cox   tty: rewrite the ...
731
  {
1c95ba1e1   Philippe Rétornaz   tty_ldisc: Fix BU...
732
733
734
735
  	struct tty_ldisc *ld = tty_ldisc_get(ldisc);
  
  	if (IS_ERR(ld))
  		return -1;
c65c9bc3e   Alan Cox   tty: rewrite the ...
736
737
738
739
740
741
742
  
  	tty_ldisc_close(tty, tty->ldisc);
  	tty_ldisc_put(tty->ldisc);
  	tty->ldisc = NULL;
  	/*
  	 *	Switch the line discipline back
  	 */
c65c9bc3e   Alan Cox   tty: rewrite the ...
743
  	tty_ldisc_assign(tty, ld);
638b9648a   Alan Cox   tty: Fix the ldis...
744
  	tty_set_termios_ldisc(tty, ldisc);
1c95ba1e1   Philippe Rétornaz   tty_ldisc: Fix BU...
745
746
  
  	return 0;
c65c9bc3e   Alan Cox   tty: rewrite the ...
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
  }
  
  /**
   *	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;
638b9648a   Alan Cox   tty: Fix the ldis...
767
768
  	int reset = tty->driver->flags & TTY_DRIVER_RESET_TERMIOS;
  	int err = 0;
c65c9bc3e   Alan Cox   tty: rewrite the ...
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
  
  	/*
  	 * FIXME! What are the locking issues here? This may me overdoing
  	 * things... This question is especially important now that we've
  	 * removed the irqlock.
  	 */
  	ld = tty_ldisc_ref(tty);
  	if (ld != NULL) {
  		/* We may have no line discipline at this point */
  		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);
  	}
  	/*
  	 * FIXME: Once we trust the LDISC code better we can wait here for
  	 * ldisc completion and fix the driver call race
  	 */
  	wake_up_interruptible_poll(&tty->write_wait, POLLOUT);
  	wake_up_interruptible_poll(&tty->read_wait, POLLIN);
  	/*
  	 * Shutdown the current line discipline, and reset it to
638b9648a   Alan Cox   tty: Fix the ldis...
796
797
798
  	 * N_TTY if need be.
  	 *
  	 * Avoid racing set_ldisc or tty_ldisc_release
c65c9bc3e   Alan Cox   tty: rewrite the ...
799
  	 */
638b9648a   Alan Cox   tty: Fix the ldis...
800
  	mutex_lock(&tty->ldisc_mutex);
60af22d2e   Arnd Bergmann   tty: reorder ldis...
801
802
803
  
  	/*
  	 * this is like tty_ldisc_halt, but we need to give up
f23eb2b2b   Linus Torvalds   tty: stop using "...
804
805
  	 * the BTM before calling cancel_work_sync, which may
  	 * need to wait for another function taking the BTM
60af22d2e   Arnd Bergmann   tty: reorder ldis...
806
807
808
  	 */
  	clear_bit(TTY_LDISC, &tty->flags);
  	tty_unlock();
f23eb2b2b   Linus Torvalds   tty: stop using "...
809
  	cancel_work_sync(&tty->buf.work);
60af22d2e   Arnd Bergmann   tty: reorder ldis...
810
811
812
813
  	mutex_unlock(&tty->ldisc_mutex);
  
  	tty_lock();
  	mutex_lock(&tty->ldisc_mutex);
638b9648a   Alan Cox   tty: Fix the ldis...
814
815
816
817
818
819
  	/* At this point we have a closed ldisc and we want to
  	   reopen it. We could defer this to the next open but
  	   it means auditing a lot of other paths so this is
  	   a FIXME */
  	if (tty->ldisc) {	/* Not yet closed */
  		if (reset == 0) {
1c95ba1e1   Philippe Rétornaz   tty_ldisc: Fix BU...
820
821
822
823
824
  
  			if (!tty_ldisc_reinit(tty, tty->termios->c_line))
  				err = tty_ldisc_open(tty, tty->ldisc);
  			else
  				err = 1;
638b9648a   Alan Cox   tty: Fix the ldis...
825
826
827
828
  		}
  		/* If the re-open fails or we reset then go to N_TTY. The
  		   N_TTY open cannot fail */
  		if (reset || err) {
1c95ba1e1   Philippe Rétornaz   tty_ldisc: Fix BU...
829
  			BUG_ON(tty_ldisc_reinit(tty, N_TTY));
c8d500417   Alan Cox   tty: fix close/ha...
830
  			WARN_ON(tty_ldisc_open(tty, tty->ldisc));
c8d500417   Alan Cox   tty: fix close/ha...
831
  		}
638b9648a   Alan Cox   tty: Fix the ldis...
832
  		tty_ldisc_enable(tty);
c65c9bc3e   Alan Cox   tty: rewrite the ...
833
  	}
638b9648a   Alan Cox   tty: Fix the ldis...
834
835
836
  	mutex_unlock(&tty->ldisc_mutex);
  	if (reset)
  		tty_reset_termios(tty);
c65c9bc3e   Alan Cox   tty: rewrite the ...
837
  }
01e1abb2c   Alan Cox   tty: Split ldisc ...
838
839
840
841
842
843
844
  
  /**
   *	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
c65c9bc3e   Alan Cox   tty: rewrite the ...
845
846
   *	line disciplines and bind them to the tty. This has no locking issues
   *	as the device isn't yet active.
01e1abb2c   Alan Cox   tty: Split ldisc ...
847
848
849
850
   */
  
  int tty_ldisc_setup(struct tty_struct *tty, struct tty_struct *o_tty)
  {
c65c9bc3e   Alan Cox   tty: rewrite the ...
851
  	struct tty_ldisc *ld = tty->ldisc;
01e1abb2c   Alan Cox   tty: Split ldisc ...
852
  	int retval;
c65c9bc3e   Alan Cox   tty: rewrite the ...
853
854
855
856
857
858
  	retval = tty_ldisc_open(tty, ld);
  	if (retval)
  		return retval;
  
  	if (o_tty) {
  		retval = tty_ldisc_open(o_tty, o_tty->ldisc);
01e1abb2c   Alan Cox   tty: Split ldisc ...
859
  		if (retval) {
c65c9bc3e   Alan Cox   tty: rewrite the ...
860
  			tty_ldisc_close(tty, ld);
01e1abb2c   Alan Cox   tty: Split ldisc ...
861
862
863
864
865
866
867
  			return retval;
  		}
  		tty_ldisc_enable(o_tty);
  	}
  	tty_ldisc_enable(tty);
  	return 0;
  }
01e1abb2c   Alan Cox   tty: Split ldisc ...
868
869
870
871
872
  /**
   *	tty_ldisc_release		-	release line discipline
   *	@tty: tty being shut down
   *	@o_tty: pair tty for pty/tty pairs
   *
852e99d22   Alan Cox   tty: bring ldisc ...
873
874
   *	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
c65c9bc3e   Alan Cox   tty: rewrite the ...
875
   *	ldisc has not been opened.
01e1abb2c   Alan Cox   tty: Split ldisc ...
876
877
878
879
   */
  
  void tty_ldisc_release(struct tty_struct *tty, struct tty_struct *o_tty)
  {
01e1abb2c   Alan Cox   tty: Split ldisc ...
880
881
882
883
884
  	/*
  	 * Prevent flush_to_ldisc() from rescheduling the work for later.  Then
  	 * kill any delayed work. As this is the final close it does not
  	 * race with the set_ldisc code path.
  	 */
01e1abb2c   Alan Cox   tty: Split ldisc ...
885

60af22d2e   Arnd Bergmann   tty: reorder ldis...
886
  	tty_unlock();
e8b70e7d3   Alan Cox   tty: Extract vari...
887
  	tty_ldisc_halt(tty);
0a1f1a0b6   Tejun Heo   tty_ldisc: don't ...
888
  	tty_ldisc_flush_works(tty);
60af22d2e   Arnd Bergmann   tty: reorder ldis...
889
  	tty_lock();
01e1abb2c   Alan Cox   tty: Split ldisc ...
890

c8d500417   Alan Cox   tty: fix close/ha...
891
  	mutex_lock(&tty->ldisc_mutex);
01e1abb2c   Alan Cox   tty: Split ldisc ...
892
  	/*
aef29bc26   Alan Cox   tty: Fix the leak...
893
  	 * Now kill off the ldisc
01e1abb2c   Alan Cox   tty: Split ldisc ...
894
  	 */
aef29bc26   Alan Cox   tty: Fix the leak...
895
896
897
898
899
900
901
  	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);
c8d500417   Alan Cox   tty: fix close/ha...
902
  	mutex_unlock(&tty->ldisc_mutex);
01e1abb2c   Alan Cox   tty: Split ldisc ...
903

c65c9bc3e   Alan Cox   tty: rewrite the ...
904
905
906
  	/* This will need doing differently if we need to lock */
  	if (o_tty)
  		tty_ldisc_release(o_tty, NULL);
aef29bc26   Alan Cox   tty: Fix the leak...
907
908
909
  
  	/* And the memory resources remaining (buffers, termios) will be
  	   disposed of when the kref hits zero */
01e1abb2c   Alan Cox   tty: Split ldisc ...
910
911
912
913
914
915
916
917
918
919
920
921
  }
  
  /**
   *	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)
  {
c65c9bc3e   Alan Cox   tty: rewrite the ...
922
923
  	struct tty_ldisc *ld = tty_ldisc_get(N_TTY);
  	if (IS_ERR(ld))
01e1abb2c   Alan Cox   tty: Split ldisc ...
924
  		panic("n_tty: init_tty");
c65c9bc3e   Alan Cox   tty: rewrite the ...
925
  	tty_ldisc_assign(tty, ld);
01e1abb2c   Alan Cox   tty: Split ldisc ...
926
  }
6716671d8   Jiri Slaby   TTY: introduce de...
927
928
929
930
931
932
933
934
935
936
937
938
  /**
   *	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)
  {
  	put_ldisc(tty->ldisc);
  	tty_ldisc_assign(tty, NULL);
  }
01e1abb2c   Alan Cox   tty: Split ldisc ...
939
940
941
942
943
  void tty_ldisc_begin(void)
  {
  	/* Setup the default TTY line discipline. */
  	(void) tty_register_ldisc(N_TTY, &tty_ldisc_N_TTY);
  }