Commit | Line | Data |
---|---|---|
01e1abb2 AC |
1 | #include <linux/types.h> |
2 | #include <linux/major.h> | |
3 | #include <linux/errno.h> | |
4 | #include <linux/signal.h> | |
5 | #include <linux/fcntl.h> | |
6 | #include <linux/sched.h> | |
7 | #include <linux/interrupt.h> | |
8 | #include <linux/tty.h> | |
9 | #include <linux/tty_driver.h> | |
10 | #include <linux/tty_flip.h> | |
11 | #include <linux/devpts_fs.h> | |
12 | #include <linux/file.h> | |
01e1abb2 AC |
13 | #include <linux/console.h> |
14 | #include <linux/timer.h> | |
15 | #include <linux/ctype.h> | |
16 | #include <linux/kd.h> | |
17 | #include <linux/mm.h> | |
18 | #include <linux/string.h> | |
19 | #include <linux/slab.h> | |
20 | #include <linux/poll.h> | |
21 | #include <linux/proc_fs.h> | |
22 | #include <linux/init.h> | |
23 | #include <linux/module.h> | |
01e1abb2 AC |
24 | #include <linux/device.h> |
25 | #include <linux/wait.h> | |
26 | #include <linux/bitops.h> | |
27 | #include <linux/delay.h> | |
28 | #include <linux/seq_file.h> | |
29 | ||
30 | #include <linux/uaccess.h> | |
31 | #include <asm/system.h> | |
32 | ||
33 | #include <linux/kbd_kern.h> | |
34 | #include <linux/vt_kern.h> | |
35 | #include <linux/selection.h> | |
36 | ||
37 | #include <linux/kmod.h> | |
38 | #include <linux/nsproxy.h> | |
39 | ||
40 | /* | |
41 | * This guards the refcounted line discipline lists. The lock | |
42 | * must be taken with irqs off because there are hangup path | |
43 | * callers who will do ldisc lookups and cannot sleep. | |
44 | */ | |
45 | ||
46 | static DEFINE_SPINLOCK(tty_ldisc_lock); | |
47 | static DECLARE_WAIT_QUEUE_HEAD(tty_ldisc_wait); | |
100eeae2 | 48 | static DECLARE_WAIT_QUEUE_HEAD(tty_ldisc_idle); |
01e1abb2 AC |
49 | /* Line disc dispatch table */ |
50 | static struct tty_ldisc_ops *tty_ldiscs[NR_LDISCS]; | |
51 | ||
65b77046 LT |
52 | static inline struct tty_ldisc *get_ldisc(struct tty_ldisc *ld) |
53 | { | |
54 | if (ld) | |
55 | atomic_inc(&ld->users); | |
56 | return ld; | |
57 | } | |
58 | ||
cbe9352f | 59 | static void put_ldisc(struct tty_ldisc *ld) |
65b77046 | 60 | { |
cbe9352f LT |
61 | unsigned long flags; |
62 | ||
65b77046 LT |
63 | if (WARN_ON_ONCE(!ld)) |
64 | return; | |
65 | ||
66 | /* | |
67 | * If this is the last user, free the ldisc, and | |
68 | * release the ldisc ops. | |
cbe9352f LT |
69 | * |
70 | * We really want an "atomic_dec_and_lock_irqsave()", | |
71 | * but we don't have it, so this does it by hand. | |
65b77046 | 72 | */ |
cbe9352f LT |
73 | local_irq_save(flags); |
74 | if (atomic_dec_and_lock(&ld->users, &tty_ldisc_lock)) { | |
65b77046 LT |
75 | struct tty_ldisc_ops *ldo = ld->ops; |
76 | ||
65b77046 LT |
77 | ldo->refcount--; |
78 | module_put(ldo->owner); | |
79 | spin_unlock_irqrestore(&tty_ldisc_lock, flags); | |
cbe9352f LT |
80 | |
81 | kfree(ld); | |
82 | return; | |
65b77046 | 83 | } |
cbe9352f | 84 | local_irq_restore(flags); |
100eeae2 | 85 | wake_up(&tty_ldisc_idle); |
65b77046 LT |
86 | } |
87 | ||
01e1abb2 AC |
88 | /** |
89 | * tty_register_ldisc - install a line discipline | |
90 | * @disc: ldisc number | |
91 | * @new_ldisc: pointer to the ldisc object | |
92 | * | |
93 | * Installs a new line discipline into the kernel. The discipline | |
94 | * is set up as unreferenced and then made available to the kernel | |
95 | * from this point onwards. | |
96 | * | |
97 | * Locking: | |
98 | * takes tty_ldisc_lock to guard against ldisc races | |
99 | */ | |
100 | ||
101 | int tty_register_ldisc(int disc, struct tty_ldisc_ops *new_ldisc) | |
102 | { | |
103 | unsigned long flags; | |
104 | int ret = 0; | |
105 | ||
106 | if (disc < N_TTY || disc >= NR_LDISCS) | |
107 | return -EINVAL; | |
108 | ||
109 | spin_lock_irqsave(&tty_ldisc_lock, flags); | |
110 | tty_ldiscs[disc] = new_ldisc; | |
111 | new_ldisc->num = disc; | |
112 | new_ldisc->refcount = 0; | |
113 | spin_unlock_irqrestore(&tty_ldisc_lock, flags); | |
114 | ||
115 | return ret; | |
116 | } | |
117 | EXPORT_SYMBOL(tty_register_ldisc); | |
118 | ||
119 | /** | |
120 | * tty_unregister_ldisc - unload a line discipline | |
121 | * @disc: ldisc number | |
122 | * @new_ldisc: pointer to the ldisc object | |
123 | * | |
124 | * Remove a line discipline from the kernel providing it is not | |
125 | * currently in use. | |
126 | * | |
127 | * Locking: | |
128 | * takes tty_ldisc_lock to guard against ldisc races | |
129 | */ | |
130 | ||
131 | int tty_unregister_ldisc(int disc) | |
132 | { | |
133 | unsigned long flags; | |
134 | int ret = 0; | |
135 | ||
136 | if (disc < N_TTY || disc >= NR_LDISCS) | |
137 | return -EINVAL; | |
138 | ||
139 | spin_lock_irqsave(&tty_ldisc_lock, flags); | |
140 | if (tty_ldiscs[disc]->refcount) | |
141 | ret = -EBUSY; | |
142 | else | |
143 | tty_ldiscs[disc] = NULL; | |
144 | spin_unlock_irqrestore(&tty_ldisc_lock, flags); | |
145 | ||
146 | return ret; | |
147 | } | |
148 | EXPORT_SYMBOL(tty_unregister_ldisc); | |
149 | ||
f0de0e8d LT |
150 | static struct tty_ldisc_ops *get_ldops(int disc) |
151 | { | |
152 | unsigned long flags; | |
153 | struct tty_ldisc_ops *ldops, *ret; | |
154 | ||
155 | spin_lock_irqsave(&tty_ldisc_lock, flags); | |
156 | ret = ERR_PTR(-EINVAL); | |
157 | ldops = tty_ldiscs[disc]; | |
158 | if (ldops) { | |
159 | ret = ERR_PTR(-EAGAIN); | |
160 | if (try_module_get(ldops->owner)) { | |
161 | ldops->refcount++; | |
162 | ret = ldops; | |
163 | } | |
164 | } | |
165 | spin_unlock_irqrestore(&tty_ldisc_lock, flags); | |
166 | return ret; | |
167 | } | |
168 | ||
169 | static void put_ldops(struct tty_ldisc_ops *ldops) | |
170 | { | |
171 | unsigned long flags; | |
172 | ||
173 | spin_lock_irqsave(&tty_ldisc_lock, flags); | |
174 | ldops->refcount--; | |
175 | module_put(ldops->owner); | |
176 | spin_unlock_irqrestore(&tty_ldisc_lock, flags); | |
177 | } | |
01e1abb2 | 178 | |
01e1abb2 AC |
179 | /** |
180 | * tty_ldisc_get - take a reference to an ldisc | |
181 | * @disc: ldisc number | |
01e1abb2 AC |
182 | * |
183 | * Takes a reference to a line discipline. Deals with refcounts and | |
184 | * module locking counts. Returns NULL if the discipline is not available. | |
185 | * Returns a pointer to the discipline and bumps the ref count if it is | |
186 | * available | |
187 | * | |
188 | * Locking: | |
189 | * takes tty_ldisc_lock to guard against ldisc races | |
190 | */ | |
191 | ||
c65c9bc3 | 192 | static struct tty_ldisc *tty_ldisc_get(int disc) |
01e1abb2 | 193 | { |
c65c9bc3 | 194 | struct tty_ldisc *ld; |
182274f8 | 195 | struct tty_ldisc_ops *ldops; |
01e1abb2 AC |
196 | |
197 | if (disc < N_TTY || disc >= NR_LDISCS) | |
c65c9bc3 | 198 | return ERR_PTR(-EINVAL); |
182274f8 LT |
199 | |
200 | /* | |
201 | * Get the ldisc ops - we may need to request them to be loaded | |
202 | * dynamically and try again. | |
203 | */ | |
204 | ldops = get_ldops(disc); | |
205 | if (IS_ERR(ldops)) { | |
01e1abb2 | 206 | request_module("tty-ldisc-%d", disc); |
182274f8 LT |
207 | ldops = get_ldops(disc); |
208 | if (IS_ERR(ldops)) | |
209 | return ERR_CAST(ldops); | |
210 | } | |
211 | ||
212 | ld = kmalloc(sizeof(struct tty_ldisc), GFP_KERNEL); | |
213 | if (ld == NULL) { | |
214 | put_ldops(ldops); | |
215 | return ERR_PTR(-ENOMEM); | |
01e1abb2 | 216 | } |
182274f8 LT |
217 | |
218 | ld->ops = ldops; | |
219 | atomic_set(&ld->users, 1); | |
c65c9bc3 | 220 | return ld; |
01e1abb2 AC |
221 | } |
222 | ||
852e99d2 | 223 | static void *tty_ldiscs_seq_start(struct seq_file *m, loff_t *pos) |
01e1abb2 AC |
224 | { |
225 | return (*pos < NR_LDISCS) ? pos : NULL; | |
226 | } | |
227 | ||
852e99d2 | 228 | static void *tty_ldiscs_seq_next(struct seq_file *m, void *v, loff_t *pos) |
01e1abb2 AC |
229 | { |
230 | (*pos)++; | |
231 | return (*pos < NR_LDISCS) ? pos : NULL; | |
232 | } | |
233 | ||
234 | static void tty_ldiscs_seq_stop(struct seq_file *m, void *v) | |
235 | { | |
236 | } | |
237 | ||
238 | static int tty_ldiscs_seq_show(struct seq_file *m, void *v) | |
239 | { | |
240 | int i = *(loff_t *)v; | |
f0de0e8d | 241 | struct tty_ldisc_ops *ldops; |
852e99d2 | 242 | |
f0de0e8d LT |
243 | ldops = get_ldops(i); |
244 | if (IS_ERR(ldops)) | |
01e1abb2 | 245 | return 0; |
f0de0e8d LT |
246 | seq_printf(m, "%-10s %2d\n", ldops->name ? ldops->name : "???", i); |
247 | put_ldops(ldops); | |
01e1abb2 AC |
248 | return 0; |
249 | } | |
250 | ||
251 | static const struct seq_operations tty_ldiscs_seq_ops = { | |
252 | .start = tty_ldiscs_seq_start, | |
253 | .next = tty_ldiscs_seq_next, | |
254 | .stop = tty_ldiscs_seq_stop, | |
255 | .show = tty_ldiscs_seq_show, | |
256 | }; | |
257 | ||
258 | static int proc_tty_ldiscs_open(struct inode *inode, struct file *file) | |
259 | { | |
260 | return seq_open(file, &tty_ldiscs_seq_ops); | |
261 | } | |
262 | ||
263 | const struct file_operations tty_ldiscs_proc_fops = { | |
264 | .owner = THIS_MODULE, | |
265 | .open = proc_tty_ldiscs_open, | |
266 | .read = seq_read, | |
267 | .llseek = seq_lseek, | |
268 | .release = seq_release, | |
269 | }; | |
270 | ||
271 | /** | |
272 | * tty_ldisc_assign - set ldisc on a tty | |
273 | * @tty: tty to assign | |
274 | * @ld: line discipline | |
275 | * | |
276 | * Install an instance of a line discipline into a tty structure. The | |
8d2ead74 | 277 | * ldisc must have a reference count above zero to ensure it remains. |
01e1abb2 AC |
278 | * The tty instance refcount starts at zero. |
279 | * | |
280 | * Locking: | |
281 | * Caller must hold references | |
282 | */ | |
283 | ||
284 | static void tty_ldisc_assign(struct tty_struct *tty, struct tty_ldisc *ld) | |
285 | { | |
c65c9bc3 | 286 | tty->ldisc = ld; |
01e1abb2 AC |
287 | } |
288 | ||
289 | /** | |
290 | * tty_ldisc_try - internal helper | |
291 | * @tty: the tty | |
292 | * | |
293 | * Make a single attempt to grab and bump the refcount on | |
294 | * the tty ldisc. Return 0 on failure or 1 on success. This is | |
295 | * used to implement both the waiting and non waiting versions | |
296 | * of tty_ldisc_ref | |
297 | * | |
298 | * Locking: takes tty_ldisc_lock | |
299 | */ | |
300 | ||
65b77046 | 301 | static struct tty_ldisc *tty_ldisc_try(struct tty_struct *tty) |
01e1abb2 AC |
302 | { |
303 | unsigned long flags; | |
304 | struct tty_ldisc *ld; | |
01e1abb2 AC |
305 | |
306 | spin_lock_irqsave(&tty_ldisc_lock, flags); | |
65b77046 LT |
307 | ld = NULL; |
308 | if (test_bit(TTY_LDISC, &tty->flags)) | |
309 | ld = get_ldisc(tty->ldisc); | |
01e1abb2 | 310 | spin_unlock_irqrestore(&tty_ldisc_lock, flags); |
65b77046 | 311 | return ld; |
01e1abb2 AC |
312 | } |
313 | ||
314 | /** | |
315 | * tty_ldisc_ref_wait - wait for the tty ldisc | |
316 | * @tty: tty device | |
317 | * | |
318 | * Dereference the line discipline for the terminal and take a | |
319 | * reference to it. If the line discipline is in flux then | |
320 | * wait patiently until it changes. | |
321 | * | |
322 | * Note: Must not be called from an IRQ/timer context. The caller | |
323 | * must also be careful not to hold other locks that will deadlock | |
324 | * against a discipline change, such as an existing ldisc reference | |
325 | * (which we check for) | |
326 | * | |
327 | * Locking: call functions take tty_ldisc_lock | |
328 | */ | |
329 | ||
330 | struct tty_ldisc *tty_ldisc_ref_wait(struct tty_struct *tty) | |
331 | { | |
65b77046 LT |
332 | struct tty_ldisc *ld; |
333 | ||
01e1abb2 | 334 | /* wait_event is a macro */ |
65b77046 LT |
335 | wait_event(tty_ldisc_wait, (ld = tty_ldisc_try(tty)) != NULL); |
336 | return ld; | |
01e1abb2 | 337 | } |
01e1abb2 AC |
338 | EXPORT_SYMBOL_GPL(tty_ldisc_ref_wait); |
339 | ||
340 | /** | |
341 | * tty_ldisc_ref - get the tty ldisc | |
342 | * @tty: tty device | |
343 | * | |
344 | * Dereference the line discipline for the terminal and take a | |
345 | * reference to it. If the line discipline is in flux then | |
346 | * return NULL. Can be called from IRQ and timer functions. | |
347 | * | |
348 | * Locking: called functions take tty_ldisc_lock | |
349 | */ | |
350 | ||
351 | struct tty_ldisc *tty_ldisc_ref(struct tty_struct *tty) | |
352 | { | |
65b77046 | 353 | return tty_ldisc_try(tty); |
01e1abb2 | 354 | } |
01e1abb2 AC |
355 | EXPORT_SYMBOL_GPL(tty_ldisc_ref); |
356 | ||
357 | /** | |
358 | * tty_ldisc_deref - free a tty ldisc reference | |
359 | * @ld: reference to free up | |
360 | * | |
361 | * Undoes the effect of tty_ldisc_ref or tty_ldisc_ref_wait. May | |
362 | * be called in IRQ context. | |
363 | * | |
364 | * Locking: takes tty_ldisc_lock | |
365 | */ | |
366 | ||
367 | void tty_ldisc_deref(struct tty_ldisc *ld) | |
368 | { | |
65b77046 | 369 | put_ldisc(ld); |
01e1abb2 | 370 | } |
01e1abb2 AC |
371 | EXPORT_SYMBOL_GPL(tty_ldisc_deref); |
372 | ||
65b77046 LT |
373 | static inline void tty_ldisc_put(struct tty_ldisc *ld) |
374 | { | |
375 | put_ldisc(ld); | |
376 | } | |
377 | ||
01e1abb2 AC |
378 | /** |
379 | * tty_ldisc_enable - allow ldisc use | |
380 | * @tty: terminal to activate ldisc on | |
381 | * | |
382 | * Set the TTY_LDISC flag when the line discipline can be called | |
c9b3976e AC |
383 | * again. Do necessary wakeups for existing sleepers. Clear the LDISC |
384 | * changing flag to indicate any ldisc change is now over. | |
01e1abb2 | 385 | * |
c9b3976e AC |
386 | * Note: nobody should set the TTY_LDISC bit except via this function. |
387 | * Clearing directly is allowed. | |
01e1abb2 AC |
388 | */ |
389 | ||
390 | void tty_ldisc_enable(struct tty_struct *tty) | |
391 | { | |
392 | set_bit(TTY_LDISC, &tty->flags); | |
c9b3976e | 393 | clear_bit(TTY_LDISC_CHANGING, &tty->flags); |
01e1abb2 AC |
394 | wake_up(&tty_ldisc_wait); |
395 | } | |
396 | ||
f2c4c65c AC |
397 | /** |
398 | * tty_ldisc_flush - flush line discipline queue | |
399 | * @tty: tty | |
400 | * | |
401 | * Flush the line discipline queue (if any) for this tty. If there | |
402 | * is no line discipline active this is a no-op. | |
403 | */ | |
404 | ||
405 | void tty_ldisc_flush(struct tty_struct *tty) | |
406 | { | |
407 | struct tty_ldisc *ld = tty_ldisc_ref(tty); | |
408 | if (ld) { | |
409 | if (ld->ops->flush_buffer) | |
410 | ld->ops->flush_buffer(tty); | |
411 | tty_ldisc_deref(ld); | |
412 | } | |
413 | tty_buffer_flush(tty); | |
414 | } | |
f2c4c65c AC |
415 | EXPORT_SYMBOL_GPL(tty_ldisc_flush); |
416 | ||
01e1abb2 AC |
417 | /** |
418 | * tty_set_termios_ldisc - set ldisc field | |
419 | * @tty: tty structure | |
420 | * @num: line discipline number | |
421 | * | |
422 | * This is probably overkill for real world processors but | |
423 | * they are not on hot paths so a little discipline won't do | |
424 | * any harm. | |
425 | * | |
426 | * Locking: takes termios_mutex | |
427 | */ | |
428 | ||
429 | static void tty_set_termios_ldisc(struct tty_struct *tty, int num) | |
430 | { | |
431 | mutex_lock(&tty->termios_mutex); | |
432 | tty->termios->c_line = num; | |
433 | mutex_unlock(&tty->termios_mutex); | |
434 | } | |
435 | ||
c65c9bc3 AC |
436 | /** |
437 | * tty_ldisc_open - open a line discipline | |
438 | * @tty: tty we are opening the ldisc on | |
439 | * @ld: discipline to open | |
440 | * | |
441 | * A helper opening method. Also a convenient debugging and check | |
442 | * point. | |
ec79d605 AB |
443 | * |
444 | * Locking: always called with BTM already held. | |
c65c9bc3 AC |
445 | */ |
446 | ||
447 | static int tty_ldisc_open(struct tty_struct *tty, struct tty_ldisc *ld) | |
448 | { | |
449 | WARN_ON(test_and_set_bit(TTY_LDISC_OPEN, &tty->flags)); | |
f18f9498 AC |
450 | if (ld->ops->open) { |
451 | int ret; | |
ec79d605 | 452 | /* BTM here locks versus a hangup event */ |
f18f9498 | 453 | ret = ld->ops->open(tty); |
7f90cfc5 JS |
454 | if (ret) |
455 | clear_bit(TTY_LDISC_OPEN, &tty->flags); | |
f18f9498 AC |
456 | return ret; |
457 | } | |
c65c9bc3 AC |
458 | return 0; |
459 | } | |
460 | ||
461 | /** | |
462 | * tty_ldisc_close - close a line discipline | |
463 | * @tty: tty we are opening the ldisc on | |
464 | * @ld: discipline to close | |
465 | * | |
466 | * A helper close method. Also a convenient debugging and check | |
467 | * point. | |
468 | */ | |
469 | ||
470 | static void tty_ldisc_close(struct tty_struct *tty, struct tty_ldisc *ld) | |
471 | { | |
472 | WARN_ON(!test_bit(TTY_LDISC_OPEN, &tty->flags)); | |
473 | clear_bit(TTY_LDISC_OPEN, &tty->flags); | |
474 | if (ld->ops->close) | |
475 | ld->ops->close(tty); | |
476 | } | |
01e1abb2 AC |
477 | |
478 | /** | |
479 | * tty_ldisc_restore - helper for tty ldisc change | |
480 | * @tty: tty to recover | |
481 | * @old: previous ldisc | |
482 | * | |
483 | * Restore the previous line discipline or N_TTY when a line discipline | |
484 | * change fails due to an open error | |
485 | */ | |
486 | ||
487 | static void tty_ldisc_restore(struct tty_struct *tty, struct tty_ldisc *old) | |
488 | { | |
489 | char buf[64]; | |
c65c9bc3 AC |
490 | struct tty_ldisc *new_ldisc; |
491 | int r; | |
01e1abb2 AC |
492 | |
493 | /* There is an outstanding reference here so this is safe */ | |
c65c9bc3 AC |
494 | old = tty_ldisc_get(old->ops->num); |
495 | WARN_ON(IS_ERR(old)); | |
01e1abb2 AC |
496 | tty_ldisc_assign(tty, old); |
497 | tty_set_termios_ldisc(tty, old->ops->num); | |
c65c9bc3 AC |
498 | if (tty_ldisc_open(tty, old) < 0) { |
499 | tty_ldisc_put(old); | |
01e1abb2 | 500 | /* This driver is always present */ |
852e99d2 | 501 | new_ldisc = tty_ldisc_get(N_TTY); |
c65c9bc3 | 502 | if (IS_ERR(new_ldisc)) |
01e1abb2 | 503 | panic("n_tty: get"); |
c65c9bc3 | 504 | tty_ldisc_assign(tty, new_ldisc); |
01e1abb2 | 505 | tty_set_termios_ldisc(tty, N_TTY); |
c65c9bc3 AC |
506 | r = tty_ldisc_open(tty, new_ldisc); |
507 | if (r < 0) | |
508 | panic("Couldn't open N_TTY ldisc for " | |
509 | "%s --- error %d.", | |
510 | tty_name(tty, buf), r); | |
01e1abb2 AC |
511 | } |
512 | } | |
513 | ||
e8b70e7d | 514 | /** |
c65c9bc3 | 515 | * tty_ldisc_halt - shut down the line discipline |
e8b70e7d AC |
516 | * @tty: tty device |
517 | * | |
518 | * Shut down the line discipline and work queue for this tty device. | |
519 | * The TTY_LDISC flag being cleared ensures no further references can | |
520 | * be obtained while the delayed work queue halt ensures that no more | |
521 | * data is fed to the ldisc. | |
522 | * | |
5c58ceff LT |
523 | * You need to do a 'flush_scheduled_work()' (outside the ldisc_mutex) |
524 | * in order to make sure any currently executing ldisc work is also | |
525 | * flushed. | |
e8b70e7d AC |
526 | */ |
527 | ||
c65c9bc3 | 528 | static int tty_ldisc_halt(struct tty_struct *tty) |
e8b70e7d AC |
529 | { |
530 | clear_bit(TTY_LDISC, &tty->flags); | |
f23eb2b2 | 531 | return cancel_work_sync(&tty->buf.work); |
e8b70e7d AC |
532 | } |
533 | ||
0a1f1a0b TH |
534 | /** |
535 | * tty_ldisc_flush_works - flush all works of a tty | |
536 | * @tty: tty device to flush works for | |
537 | * | |
538 | * Sync flush all works belonging to @tty. | |
539 | */ | |
540 | static void tty_ldisc_flush_works(struct tty_struct *tty) | |
541 | { | |
542 | flush_work_sync(&tty->hangup_work); | |
543 | flush_work_sync(&tty->SAK_work); | |
f23eb2b2 | 544 | flush_work_sync(&tty->buf.work); |
0a1f1a0b TH |
545 | } |
546 | ||
100eeae2 JS |
547 | /** |
548 | * tty_ldisc_wait_idle - wait for the ldisc to become idle | |
549 | * @tty: tty to wait for | |
df92d056 | 550 | * @timeout: for how long to wait at most |
100eeae2 JS |
551 | * |
552 | * Wait for the line discipline to become idle. The discipline must | |
553 | * have been halted for this to guarantee it remains idle. | |
554 | */ | |
df92d056 | 555 | static int tty_ldisc_wait_idle(struct tty_struct *tty, long timeout) |
100eeae2 | 556 | { |
df92d056 | 557 | long ret; |
92f6fa09 | 558 | ret = wait_event_timeout(tty_ldisc_idle, |
df92d056 | 559 | atomic_read(&tty->ldisc->users) == 1, timeout); |
100eeae2 JS |
560 | if (ret < 0) |
561 | return ret; | |
562 | return ret > 0 ? 0 : -EBUSY; | |
563 | } | |
564 | ||
01e1abb2 AC |
565 | /** |
566 | * tty_set_ldisc - set line discipline | |
567 | * @tty: the terminal to set | |
568 | * @ldisc: the line discipline | |
569 | * | |
570 | * Set the discipline of a tty line. Must be called from a process | |
c65c9bc3 AC |
571 | * context. The ldisc change logic has to protect itself against any |
572 | * overlapping ldisc change (including on the other end of pty pairs), | |
573 | * the close of one side of a tty/pty pair, and eventually hangup. | |
01e1abb2 | 574 | * |
c65c9bc3 | 575 | * Locking: takes tty_ldisc_lock, termios_mutex |
01e1abb2 AC |
576 | */ |
577 | ||
578 | int tty_set_ldisc(struct tty_struct *tty, int ldisc) | |
579 | { | |
580 | int retval; | |
c65c9bc3 AC |
581 | struct tty_ldisc *o_ldisc, *new_ldisc; |
582 | int work, o_work = 0; | |
01e1abb2 AC |
583 | struct tty_struct *o_tty; |
584 | ||
c65c9bc3 AC |
585 | new_ldisc = tty_ldisc_get(ldisc); |
586 | if (IS_ERR(new_ldisc)) | |
587 | return PTR_ERR(new_ldisc); | |
01e1abb2 | 588 | |
ec79d605 | 589 | tty_lock(); |
01e1abb2 | 590 | /* |
c65c9bc3 AC |
591 | * We need to look at the tty locking here for pty/tty pairs |
592 | * when both sides try to change in parallel. | |
01e1abb2 AC |
593 | */ |
594 | ||
c65c9bc3 AC |
595 | o_tty = tty->link; /* o_tty is the pty side or NULL */ |
596 | ||
01e1abb2 | 597 | |
c65c9bc3 AC |
598 | /* |
599 | * Check the no-op case | |
600 | */ | |
601 | ||
602 | if (tty->ldisc->ops->num == ldisc) { | |
ec79d605 | 603 | tty_unlock(); |
c65c9bc3 | 604 | tty_ldisc_put(new_ldisc); |
01e1abb2 AC |
605 | return 0; |
606 | } | |
607 | ||
ec79d605 | 608 | tty_unlock(); |
c65c9bc3 AC |
609 | /* |
610 | * Problem: What do we do if this blocks ? | |
611 | * We could deadlock here | |
612 | */ | |
613 | ||
614 | tty_wait_until_sent(tty, 0); | |
615 | ||
60af22d2 | 616 | tty_lock(); |
c65c9bc3 AC |
617 | mutex_lock(&tty->ldisc_mutex); |
618 | ||
619 | /* | |
620 | * We could be midstream of another ldisc change which has | |
621 | * dropped the lock during processing. If so we need to wait. | |
622 | */ | |
623 | ||
624 | while (test_bit(TTY_LDISC_CHANGING, &tty->flags)) { | |
625 | mutex_unlock(&tty->ldisc_mutex); | |
60af22d2 | 626 | tty_unlock(); |
c65c9bc3 AC |
627 | wait_event(tty_ldisc_wait, |
628 | test_bit(TTY_LDISC_CHANGING, &tty->flags) == 0); | |
60af22d2 | 629 | tty_lock(); |
c65c9bc3 AC |
630 | mutex_lock(&tty->ldisc_mutex); |
631 | } | |
eeb89d91 | 632 | |
c65c9bc3 | 633 | set_bit(TTY_LDISC_CHANGING, &tty->flags); |
852e99d2 | 634 | |
01e1abb2 AC |
635 | /* |
636 | * No more input please, we are switching. The new ldisc | |
637 | * will update this value in the ldisc open function | |
638 | */ | |
639 | ||
640 | tty->receive_room = 0; | |
641 | ||
642 | o_ldisc = tty->ldisc; | |
eeb89d91 | 643 | |
ec79d605 | 644 | tty_unlock(); |
01e1abb2 AC |
645 | /* |
646 | * Make sure we don't change while someone holds a | |
647 | * reference to the line discipline. The TTY_LDISC bit | |
648 | * prevents anyone taking a reference once it is clear. | |
649 | * We need the lock to avoid racing reference takers. | |
c9b3976e AC |
650 | * |
651 | * We must clear the TTY_LDISC bit here to avoid a livelock | |
652 | * with a userspace app continually trying to use the tty in | |
653 | * parallel to the change and re-referencing the tty. | |
01e1abb2 AC |
654 | */ |
655 | ||
c65c9bc3 | 656 | work = tty_ldisc_halt(tty); |
01e1abb2 | 657 | if (o_tty) |
c65c9bc3 | 658 | o_work = tty_ldisc_halt(o_tty); |
01e1abb2 | 659 | |
01e1abb2 | 660 | /* |
c65c9bc3 AC |
661 | * Wait for ->hangup_work and ->buf.work handlers to terminate. |
662 | * We must drop the mutex here in case a hangup is also in process. | |
01e1abb2 | 663 | */ |
c65c9bc3 AC |
664 | |
665 | mutex_unlock(&tty->ldisc_mutex); | |
666 | ||
0a1f1a0b | 667 | tty_ldisc_flush_works(tty); |
c65c9bc3 | 668 | |
df92d056 | 669 | retval = tty_ldisc_wait_idle(tty, 5 * HZ); |
100eeae2 | 670 | |
ec79d605 | 671 | tty_lock(); |
60af22d2 | 672 | mutex_lock(&tty->ldisc_mutex); |
100eeae2 JS |
673 | |
674 | /* handle wait idle failure locked */ | |
675 | if (retval) { | |
676 | tty_ldisc_put(new_ldisc); | |
677 | goto enable; | |
678 | } | |
679 | ||
c65c9bc3 AC |
680 | if (test_bit(TTY_HUPPED, &tty->flags)) { |
681 | /* We were raced by the hangup method. It will have stomped | |
682 | the ldisc data and closed the ldisc down */ | |
683 | clear_bit(TTY_LDISC_CHANGING, &tty->flags); | |
684 | mutex_unlock(&tty->ldisc_mutex); | |
685 | tty_ldisc_put(new_ldisc); | |
ec79d605 | 686 | tty_unlock(); |
c65c9bc3 AC |
687 | return -EIO; |
688 | } | |
689 | ||
01e1abb2 | 690 | /* Shutdown the current discipline. */ |
c65c9bc3 | 691 | tty_ldisc_close(tty, o_ldisc); |
01e1abb2 AC |
692 | |
693 | /* Now set up the new line discipline. */ | |
c65c9bc3 | 694 | tty_ldisc_assign(tty, new_ldisc); |
01e1abb2 | 695 | tty_set_termios_ldisc(tty, ldisc); |
c65c9bc3 AC |
696 | |
697 | retval = tty_ldisc_open(tty, new_ldisc); | |
01e1abb2 | 698 | if (retval < 0) { |
c65c9bc3 AC |
699 | /* Back to the old one or N_TTY if we can't */ |
700 | tty_ldisc_put(new_ldisc); | |
701 | tty_ldisc_restore(tty, o_ldisc); | |
01e1abb2 | 702 | } |
c65c9bc3 | 703 | |
01e1abb2 AC |
704 | /* At this point we hold a reference to the new ldisc and a |
705 | a reference to the old ldisc. If we ended up flipping back | |
706 | to the existing ldisc we have two references to it */ | |
707 | ||
c65c9bc3 | 708 | if (tty->ldisc->ops->num != o_ldisc->ops->num && tty->ops->set_ldisc) |
01e1abb2 AC |
709 | tty->ops->set_ldisc(tty); |
710 | ||
c65c9bc3 | 711 | tty_ldisc_put(o_ldisc); |
01e1abb2 | 712 | |
100eeae2 | 713 | enable: |
01e1abb2 | 714 | /* |
c65c9bc3 | 715 | * Allow ldisc referencing to occur again |
01e1abb2 AC |
716 | */ |
717 | ||
718 | tty_ldisc_enable(tty); | |
719 | if (o_tty) | |
720 | tty_ldisc_enable(o_tty); | |
721 | ||
c65c9bc3 | 722 | /* Restart the work queue in case no characters kick it off. Safe if |
01e1abb2 AC |
723 | already running */ |
724 | if (work) | |
f23eb2b2 | 725 | schedule_work(&tty->buf.work); |
c65c9bc3 | 726 | if (o_work) |
f23eb2b2 | 727 | schedule_work(&o_tty->buf.work); |
c65c9bc3 | 728 | mutex_unlock(&tty->ldisc_mutex); |
ec79d605 | 729 | tty_unlock(); |
01e1abb2 AC |
730 | return retval; |
731 | } | |
732 | ||
c65c9bc3 AC |
733 | /** |
734 | * tty_reset_termios - reset terminal state | |
735 | * @tty: tty to reset | |
736 | * | |
737 | * Restore a terminal to the driver default state. | |
738 | */ | |
739 | ||
740 | static void tty_reset_termios(struct tty_struct *tty) | |
741 | { | |
742 | mutex_lock(&tty->termios_mutex); | |
743 | *tty->termios = tty->driver->init_termios; | |
744 | tty->termios->c_ispeed = tty_termios_input_baud_rate(tty->termios); | |
745 | tty->termios->c_ospeed = tty_termios_baud_rate(tty->termios); | |
746 | mutex_unlock(&tty->termios_mutex); | |
747 | } | |
748 | ||
749 | ||
750 | /** | |
751 | * tty_ldisc_reinit - reinitialise the tty ldisc | |
752 | * @tty: tty to reinit | |
638b9648 | 753 | * @ldisc: line discipline to reinitialize |
c65c9bc3 | 754 | * |
638b9648 AC |
755 | * Switch the tty to a line discipline and leave the ldisc |
756 | * state closed | |
c65c9bc3 AC |
757 | */ |
758 | ||
1c95ba1e | 759 | static int tty_ldisc_reinit(struct tty_struct *tty, int ldisc) |
c65c9bc3 | 760 | { |
1c95ba1e PR |
761 | struct tty_ldisc *ld = tty_ldisc_get(ldisc); |
762 | ||
763 | if (IS_ERR(ld)) | |
764 | return -1; | |
c65c9bc3 AC |
765 | |
766 | tty_ldisc_close(tty, tty->ldisc); | |
767 | tty_ldisc_put(tty->ldisc); | |
768 | tty->ldisc = NULL; | |
769 | /* | |
770 | * Switch the line discipline back | |
771 | */ | |
c65c9bc3 | 772 | tty_ldisc_assign(tty, ld); |
638b9648 | 773 | tty_set_termios_ldisc(tty, ldisc); |
1c95ba1e PR |
774 | |
775 | return 0; | |
c65c9bc3 AC |
776 | } |
777 | ||
778 | /** | |
779 | * tty_ldisc_hangup - hangup ldisc reset | |
780 | * @tty: tty being hung up | |
781 | * | |
782 | * Some tty devices reset their termios when they receive a hangup | |
783 | * event. In that situation we must also switch back to N_TTY properly | |
784 | * before we reset the termios data. | |
785 | * | |
786 | * Locking: We can take the ldisc mutex as the rest of the code is | |
787 | * careful to allow for this. | |
788 | * | |
789 | * In the pty pair case this occurs in the close() path of the | |
790 | * tty itself so we must be careful about locking rules. | |
791 | */ | |
792 | ||
793 | void tty_ldisc_hangup(struct tty_struct *tty) | |
794 | { | |
795 | struct tty_ldisc *ld; | |
638b9648 AC |
796 | int reset = tty->driver->flags & TTY_DRIVER_RESET_TERMIOS; |
797 | int err = 0; | |
c65c9bc3 AC |
798 | |
799 | /* | |
800 | * FIXME! What are the locking issues here? This may me overdoing | |
801 | * things... This question is especially important now that we've | |
802 | * removed the irqlock. | |
803 | */ | |
804 | ld = tty_ldisc_ref(tty); | |
805 | if (ld != NULL) { | |
806 | /* We may have no line discipline at this point */ | |
807 | if (ld->ops->flush_buffer) | |
808 | ld->ops->flush_buffer(tty); | |
809 | tty_driver_flush_buffer(tty); | |
810 | if ((test_bit(TTY_DO_WRITE_WAKEUP, &tty->flags)) && | |
811 | ld->ops->write_wakeup) | |
812 | ld->ops->write_wakeup(tty); | |
813 | if (ld->ops->hangup) | |
814 | ld->ops->hangup(tty); | |
815 | tty_ldisc_deref(ld); | |
816 | } | |
817 | /* | |
818 | * FIXME: Once we trust the LDISC code better we can wait here for | |
819 | * ldisc completion and fix the driver call race | |
820 | */ | |
821 | wake_up_interruptible_poll(&tty->write_wait, POLLOUT); | |
822 | wake_up_interruptible_poll(&tty->read_wait, POLLIN); | |
823 | /* | |
824 | * Shutdown the current line discipline, and reset it to | |
638b9648 AC |
825 | * N_TTY if need be. |
826 | * | |
827 | * Avoid racing set_ldisc or tty_ldisc_release | |
c65c9bc3 | 828 | */ |
638b9648 | 829 | mutex_lock(&tty->ldisc_mutex); |
60af22d2 AB |
830 | |
831 | /* | |
832 | * this is like tty_ldisc_halt, but we need to give up | |
f23eb2b2 LT |
833 | * the BTM before calling cancel_work_sync, which may |
834 | * need to wait for another function taking the BTM | |
60af22d2 AB |
835 | */ |
836 | clear_bit(TTY_LDISC, &tty->flags); | |
837 | tty_unlock(); | |
f23eb2b2 | 838 | cancel_work_sync(&tty->buf.work); |
60af22d2 AB |
839 | mutex_unlock(&tty->ldisc_mutex); |
840 | ||
841 | tty_lock(); | |
842 | mutex_lock(&tty->ldisc_mutex); | |
843 | ||
638b9648 AC |
844 | /* At this point we have a closed ldisc and we want to |
845 | reopen it. We could defer this to the next open but | |
846 | it means auditing a lot of other paths so this is | |
847 | a FIXME */ | |
848 | if (tty->ldisc) { /* Not yet closed */ | |
30042072 JS |
849 | WARN_ON_ONCE(tty_ldisc_wait_idle(tty, 5 * HZ)); |
850 | ||
638b9648 | 851 | if (reset == 0) { |
1c95ba1e PR |
852 | |
853 | if (!tty_ldisc_reinit(tty, tty->termios->c_line)) | |
854 | err = tty_ldisc_open(tty, tty->ldisc); | |
855 | else | |
856 | err = 1; | |
638b9648 AC |
857 | } |
858 | /* If the re-open fails or we reset then go to N_TTY. The | |
859 | N_TTY open cannot fail */ | |
860 | if (reset || err) { | |
1c95ba1e | 861 | BUG_ON(tty_ldisc_reinit(tty, N_TTY)); |
c8d50041 | 862 | WARN_ON(tty_ldisc_open(tty, tty->ldisc)); |
c8d50041 | 863 | } |
638b9648 | 864 | tty_ldisc_enable(tty); |
c65c9bc3 | 865 | } |
638b9648 AC |
866 | mutex_unlock(&tty->ldisc_mutex); |
867 | if (reset) | |
868 | tty_reset_termios(tty); | |
c65c9bc3 | 869 | } |
01e1abb2 AC |
870 | |
871 | /** | |
872 | * tty_ldisc_setup - open line discipline | |
873 | * @tty: tty being shut down | |
874 | * @o_tty: pair tty for pty/tty pairs | |
875 | * | |
876 | * Called during the initial open of a tty/pty pair in order to set up the | |
c65c9bc3 AC |
877 | * line disciplines and bind them to the tty. This has no locking issues |
878 | * as the device isn't yet active. | |
01e1abb2 AC |
879 | */ |
880 | ||
881 | int tty_ldisc_setup(struct tty_struct *tty, struct tty_struct *o_tty) | |
882 | { | |
c65c9bc3 | 883 | struct tty_ldisc *ld = tty->ldisc; |
01e1abb2 AC |
884 | int retval; |
885 | ||
c65c9bc3 AC |
886 | retval = tty_ldisc_open(tty, ld); |
887 | if (retval) | |
888 | return retval; | |
889 | ||
890 | if (o_tty) { | |
891 | retval = tty_ldisc_open(o_tty, o_tty->ldisc); | |
01e1abb2 | 892 | if (retval) { |
c65c9bc3 | 893 | tty_ldisc_close(tty, ld); |
01e1abb2 AC |
894 | return retval; |
895 | } | |
896 | tty_ldisc_enable(o_tty); | |
897 | } | |
898 | tty_ldisc_enable(tty); | |
899 | return 0; | |
900 | } | |
01e1abb2 AC |
901 | /** |
902 | * tty_ldisc_release - release line discipline | |
903 | * @tty: tty being shut down | |
904 | * @o_tty: pair tty for pty/tty pairs | |
905 | * | |
852e99d2 AC |
906 | * Called during the final close of a tty/pty pair in order to shut down |
907 | * the line discpline layer. On exit the ldisc assigned is N_TTY and the | |
c65c9bc3 | 908 | * ldisc has not been opened. |
01e1abb2 AC |
909 | */ |
910 | ||
911 | void tty_ldisc_release(struct tty_struct *tty, struct tty_struct *o_tty) | |
912 | { | |
01e1abb2 AC |
913 | /* |
914 | * Prevent flush_to_ldisc() from rescheduling the work for later. Then | |
915 | * kill any delayed work. As this is the final close it does not | |
916 | * race with the set_ldisc code path. | |
917 | */ | |
01e1abb2 | 918 | |
60af22d2 | 919 | tty_unlock(); |
e8b70e7d | 920 | tty_ldisc_halt(tty); |
0a1f1a0b | 921 | tty_ldisc_flush_works(tty); |
60af22d2 | 922 | tty_lock(); |
01e1abb2 | 923 | |
c8d50041 | 924 | mutex_lock(&tty->ldisc_mutex); |
01e1abb2 | 925 | /* |
aef29bc2 | 926 | * Now kill off the ldisc |
01e1abb2 | 927 | */ |
aef29bc2 AC |
928 | tty_ldisc_close(tty, tty->ldisc); |
929 | tty_ldisc_put(tty->ldisc); | |
930 | /* Force an oops if we mess this up */ | |
931 | tty->ldisc = NULL; | |
932 | ||
933 | /* Ensure the next open requests the N_TTY ldisc */ | |
934 | tty_set_termios_ldisc(tty, N_TTY); | |
c8d50041 | 935 | mutex_unlock(&tty->ldisc_mutex); |
01e1abb2 | 936 | |
c65c9bc3 AC |
937 | /* This will need doing differently if we need to lock */ |
938 | if (o_tty) | |
939 | tty_ldisc_release(o_tty, NULL); | |
aef29bc2 AC |
940 | |
941 | /* And the memory resources remaining (buffers, termios) will be | |
942 | disposed of when the kref hits zero */ | |
01e1abb2 AC |
943 | } |
944 | ||
945 | /** | |
946 | * tty_ldisc_init - ldisc setup for new tty | |
947 | * @tty: tty being allocated | |
948 | * | |
949 | * Set up the line discipline objects for a newly allocated tty. Note that | |
950 | * the tty structure is not completely set up when this call is made. | |
951 | */ | |
952 | ||
953 | void tty_ldisc_init(struct tty_struct *tty) | |
954 | { | |
c65c9bc3 AC |
955 | struct tty_ldisc *ld = tty_ldisc_get(N_TTY); |
956 | if (IS_ERR(ld)) | |
01e1abb2 | 957 | panic("n_tty: init_tty"); |
c65c9bc3 | 958 | tty_ldisc_assign(tty, ld); |
01e1abb2 AC |
959 | } |
960 | ||
6716671d JS |
961 | /** |
962 | * tty_ldisc_init - ldisc cleanup for new tty | |
963 | * @tty: tty that was allocated recently | |
964 | * | |
965 | * The tty structure must not becompletely set up (tty_ldisc_setup) when | |
966 | * this call is made. | |
967 | */ | |
968 | void tty_ldisc_deinit(struct tty_struct *tty) | |
969 | { | |
970 | put_ldisc(tty->ldisc); | |
971 | tty_ldisc_assign(tty, NULL); | |
972 | } | |
973 | ||
01e1abb2 AC |
974 | void tty_ldisc_begin(void) |
975 | { | |
976 | /* Setup the default TTY line discipline. */ | |
977 | (void) tty_register_ldisc(N_TTY, &tty_ldisc_N_TTY); | |
978 | } |