blob: 4008f5f653453de90ff0f653ea14ee340ee651d2 [file] [log] [blame]
Alan Cox01e1abb2008-07-22 11:16:55 +01001#include <linux/types.h>
Alan Cox01e1abb2008-07-22 11:16:55 +01002#include <linux/errno.h>
Jiri Slaby8b3ffa12011-11-16 16:27:10 +01003#include <linux/kmod.h>
Alan Cox01e1abb2008-07-22 11:16:55 +01004#include <linux/sched.h>
5#include <linux/interrupt.h>
6#include <linux/tty.h>
7#include <linux/tty_driver.h>
Alan Cox01e1abb2008-07-22 11:16:55 +01008#include <linux/file.h>
Alan Cox01e1abb2008-07-22 11:16:55 +01009#include <linux/mm.h>
10#include <linux/string.h>
11#include <linux/slab.h>
12#include <linux/poll.h>
13#include <linux/proc_fs.h>
Alan Cox01e1abb2008-07-22 11:16:55 +010014#include <linux/module.h>
Alan Cox01e1abb2008-07-22 11:16:55 +010015#include <linux/device.h>
16#include <linux/wait.h>
17#include <linux/bitops.h>
Alan Cox01e1abb2008-07-22 11:16:55 +010018#include <linux/seq_file.h>
Alan Cox01e1abb2008-07-22 11:16:55 +010019#include <linux/uaccess.h>
Jiri Slaby0c73c082011-11-16 16:27:09 +010020#include <linux/ratelimit.h>
Alan Cox01e1abb2008-07-22 11:16:55 +010021
Peter Hurleyfc575ee2013-03-11 16:44:38 -040022#undef LDISC_DEBUG_HANGUP
23
24#ifdef LDISC_DEBUG_HANGUP
Peter Hurley0a6adc12015-07-12 22:49:10 -040025#define tty_ldisc_debug(tty, f, args...) tty_debug(tty, f, ##args)
Peter Hurleyfc575ee2013-03-11 16:44:38 -040026#else
27#define tty_ldisc_debug(tty, f, args...)
28#endif
29
Peter Hurleyd2c43892013-06-15 07:04:47 -040030/* lockdep nested classes for tty->ldisc_sem */
31enum {
32 LDISC_SEM_NORMAL,
33 LDISC_SEM_OTHER,
34};
35
36
Alan Cox01e1abb2008-07-22 11:16:55 +010037/*
38 * This guards the refcounted line discipline lists. The lock
39 * must be taken with irqs off because there are hangup path
40 * callers who will do ldisc lookups and cannot sleep.
41 */
42
Peter Hurley137084b2013-06-15 07:04:46 -040043static DEFINE_RAW_SPINLOCK(tty_ldiscs_lock);
Alan Cox01e1abb2008-07-22 11:16:55 +010044/* Line disc dispatch table */
45static struct tty_ldisc_ops *tty_ldiscs[NR_LDISCS];
46
47/**
48 * tty_register_ldisc - install a line discipline
49 * @disc: ldisc number
50 * @new_ldisc: pointer to the ldisc object
51 *
52 * Installs a new line discipline into the kernel. The discipline
53 * is set up as unreferenced and then made available to the kernel
54 * from this point onwards.
55 *
56 * Locking:
Peter Hurley137084b2013-06-15 07:04:46 -040057 * takes tty_ldiscs_lock to guard against ldisc races
Alan Cox01e1abb2008-07-22 11:16:55 +010058 */
59
60int tty_register_ldisc(int disc, struct tty_ldisc_ops *new_ldisc)
61{
62 unsigned long flags;
63 int ret = 0;
64
65 if (disc < N_TTY || disc >= NR_LDISCS)
66 return -EINVAL;
67
Peter Hurley137084b2013-06-15 07:04:46 -040068 raw_spin_lock_irqsave(&tty_ldiscs_lock, flags);
Alan Cox01e1abb2008-07-22 11:16:55 +010069 tty_ldiscs[disc] = new_ldisc;
70 new_ldisc->num = disc;
71 new_ldisc->refcount = 0;
Peter Hurley137084b2013-06-15 07:04:46 -040072 raw_spin_unlock_irqrestore(&tty_ldiscs_lock, flags);
Alan Cox01e1abb2008-07-22 11:16:55 +010073
74 return ret;
75}
76EXPORT_SYMBOL(tty_register_ldisc);
77
78/**
79 * tty_unregister_ldisc - unload a line discipline
80 * @disc: ldisc number
81 * @new_ldisc: pointer to the ldisc object
82 *
83 * Remove a line discipline from the kernel providing it is not
84 * currently in use.
85 *
86 * Locking:
Peter Hurley137084b2013-06-15 07:04:46 -040087 * takes tty_ldiscs_lock to guard against ldisc races
Alan Cox01e1abb2008-07-22 11:16:55 +010088 */
89
90int tty_unregister_ldisc(int disc)
91{
92 unsigned long flags;
93 int ret = 0;
94
95 if (disc < N_TTY || disc >= NR_LDISCS)
96 return -EINVAL;
97
Peter Hurley137084b2013-06-15 07:04:46 -040098 raw_spin_lock_irqsave(&tty_ldiscs_lock, flags);
Alan Cox01e1abb2008-07-22 11:16:55 +010099 if (tty_ldiscs[disc]->refcount)
100 ret = -EBUSY;
101 else
102 tty_ldiscs[disc] = NULL;
Peter Hurley137084b2013-06-15 07:04:46 -0400103 raw_spin_unlock_irqrestore(&tty_ldiscs_lock, flags);
Alan Cox01e1abb2008-07-22 11:16:55 +0100104
105 return ret;
106}
107EXPORT_SYMBOL(tty_unregister_ldisc);
108
Linus Torvaldsf0de0e82009-08-03 16:00:15 -0700109static struct tty_ldisc_ops *get_ldops(int disc)
110{
111 unsigned long flags;
112 struct tty_ldisc_ops *ldops, *ret;
113
Peter Hurley137084b2013-06-15 07:04:46 -0400114 raw_spin_lock_irqsave(&tty_ldiscs_lock, flags);
Linus Torvaldsf0de0e82009-08-03 16:00:15 -0700115 ret = ERR_PTR(-EINVAL);
116 ldops = tty_ldiscs[disc];
117 if (ldops) {
118 ret = ERR_PTR(-EAGAIN);
119 if (try_module_get(ldops->owner)) {
120 ldops->refcount++;
121 ret = ldops;
122 }
123 }
Peter Hurley137084b2013-06-15 07:04:46 -0400124 raw_spin_unlock_irqrestore(&tty_ldiscs_lock, flags);
Linus Torvaldsf0de0e82009-08-03 16:00:15 -0700125 return ret;
126}
127
128static void put_ldops(struct tty_ldisc_ops *ldops)
129{
130 unsigned long flags;
131
Peter Hurley137084b2013-06-15 07:04:46 -0400132 raw_spin_lock_irqsave(&tty_ldiscs_lock, flags);
Linus Torvaldsf0de0e82009-08-03 16:00:15 -0700133 ldops->refcount--;
134 module_put(ldops->owner);
Peter Hurley137084b2013-06-15 07:04:46 -0400135 raw_spin_unlock_irqrestore(&tty_ldiscs_lock, flags);
Linus Torvaldsf0de0e82009-08-03 16:00:15 -0700136}
Alan Cox01e1abb2008-07-22 11:16:55 +0100137
138/**
Alan Cox01e1abb2008-07-22 11:16:55 +0100139 * tty_ldisc_get - take a reference to an ldisc
140 * @disc: ldisc number
Alan Cox01e1abb2008-07-22 11:16:55 +0100141 *
142 * Takes a reference to a line discipline. Deals with refcounts and
Peter Hurleyc0cc1c52016-01-10 22:40:59 -0800143 * module locking counts.
144 *
145 * Returns: -EINVAL if the discipline index is not [N_TTY..NR_LDISCS] or
146 * if the discipline is not registered
147 * -EAGAIN if request_module() failed to load or register the
148 * the discipline
149 * -ENOMEM if allocation failure
150 *
151 * Otherwise, returns a pointer to the discipline and bumps the
152 * ref count
Alan Cox01e1abb2008-07-22 11:16:55 +0100153 *
154 * Locking:
Peter Hurley137084b2013-06-15 07:04:46 -0400155 * takes tty_ldiscs_lock to guard against ldisc races
Alan Cox01e1abb2008-07-22 11:16:55 +0100156 */
157
Peter Hurley36697522013-06-15 07:04:48 -0400158static struct tty_ldisc *tty_ldisc_get(struct tty_struct *tty, int disc)
Alan Cox01e1abb2008-07-22 11:16:55 +0100159{
Alan Coxc65c9bc2009-06-11 12:50:12 +0100160 struct tty_ldisc *ld;
Linus Torvalds182274f2009-08-03 16:01:28 -0700161 struct tty_ldisc_ops *ldops;
Alan Cox01e1abb2008-07-22 11:16:55 +0100162
163 if (disc < N_TTY || disc >= NR_LDISCS)
Alan Coxc65c9bc2009-06-11 12:50:12 +0100164 return ERR_PTR(-EINVAL);
Linus Torvalds182274f2009-08-03 16:01:28 -0700165
166 /*
167 * Get the ldisc ops - we may need to request them to be loaded
168 * dynamically and try again.
169 */
170 ldops = get_ldops(disc);
171 if (IS_ERR(ldops)) {
Alan Cox01e1abb2008-07-22 11:16:55 +0100172 request_module("tty-ldisc-%d", disc);
Linus Torvalds182274f2009-08-03 16:01:28 -0700173 ldops = get_ldops(disc);
174 if (IS_ERR(ldops))
175 return ERR_CAST(ldops);
Alan Cox01e1abb2008-07-22 11:16:55 +0100176 }
Linus Torvalds182274f2009-08-03 16:01:28 -0700177
178 ld = kmalloc(sizeof(struct tty_ldisc), GFP_KERNEL);
179 if (ld == NULL) {
180 put_ldops(ldops);
181 return ERR_PTR(-ENOMEM);
182 }
183
184 ld->ops = ldops;
Peter Hurley36697522013-06-15 07:04:48 -0400185 ld->tty = tty;
Ivo Sieben1541f842012-05-03 14:37:43 +0200186
Alan Coxc65c9bc2009-06-11 12:50:12 +0100187 return ld;
Alan Cox01e1abb2008-07-22 11:16:55 +0100188}
189
Peter Hurley734de242013-03-11 16:44:43 -0400190/**
191 * tty_ldisc_put - release the ldisc
192 *
193 * Complement of tty_ldisc_get().
194 */
Denys Vlasenkocb128f62015-10-27 17:40:02 +0100195static void tty_ldisc_put(struct tty_ldisc *ld)
Peter Hurley734de242013-03-11 16:44:43 -0400196{
Peter Hurley734de242013-03-11 16:44:43 -0400197 if (WARN_ON_ONCE(!ld))
198 return;
199
Peter Hurley36697522013-06-15 07:04:48 -0400200 put_ldops(ld->ops);
Peter Hurley734de242013-03-11 16:44:43 -0400201 kfree(ld);
Peter Hurley734de242013-03-11 16:44:43 -0400202}
203
Alan Cox852e99d2009-06-11 12:51:41 +0100204static void *tty_ldiscs_seq_start(struct seq_file *m, loff_t *pos)
Alan Cox01e1abb2008-07-22 11:16:55 +0100205{
206 return (*pos < NR_LDISCS) ? pos : NULL;
207}
208
Alan Cox852e99d2009-06-11 12:51:41 +0100209static void *tty_ldiscs_seq_next(struct seq_file *m, void *v, loff_t *pos)
Alan Cox01e1abb2008-07-22 11:16:55 +0100210{
211 (*pos)++;
212 return (*pos < NR_LDISCS) ? pos : NULL;
213}
214
215static void tty_ldiscs_seq_stop(struct seq_file *m, void *v)
216{
217}
218
219static int tty_ldiscs_seq_show(struct seq_file *m, void *v)
220{
221 int i = *(loff_t *)v;
Linus Torvaldsf0de0e82009-08-03 16:00:15 -0700222 struct tty_ldisc_ops *ldops;
Alan Cox852e99d2009-06-11 12:51:41 +0100223
Linus Torvaldsf0de0e82009-08-03 16:00:15 -0700224 ldops = get_ldops(i);
225 if (IS_ERR(ldops))
Alan Cox01e1abb2008-07-22 11:16:55 +0100226 return 0;
Linus Torvaldsf0de0e82009-08-03 16:00:15 -0700227 seq_printf(m, "%-10s %2d\n", ldops->name ? ldops->name : "???", i);
228 put_ldops(ldops);
Alan Cox01e1abb2008-07-22 11:16:55 +0100229 return 0;
230}
231
232static const struct seq_operations tty_ldiscs_seq_ops = {
233 .start = tty_ldiscs_seq_start,
234 .next = tty_ldiscs_seq_next,
235 .stop = tty_ldiscs_seq_stop,
236 .show = tty_ldiscs_seq_show,
237};
238
239static int proc_tty_ldiscs_open(struct inode *inode, struct file *file)
240{
241 return seq_open(file, &tty_ldiscs_seq_ops);
242}
243
244const struct file_operations tty_ldiscs_proc_fops = {
245 .owner = THIS_MODULE,
246 .open = proc_tty_ldiscs_open,
247 .read = seq_read,
248 .llseek = seq_lseek,
249 .release = seq_release,
250};
251
252/**
Alan Cox01e1abb2008-07-22 11:16:55 +0100253 * tty_ldisc_ref_wait - wait for the tty ldisc
254 * @tty: tty device
255 *
256 * Dereference the line discipline for the terminal and take a
257 * reference to it. If the line discipline is in flux then
258 * wait patiently until it changes.
259 *
260 * Note: Must not be called from an IRQ/timer context. The caller
261 * must also be careful not to hold other locks that will deadlock
262 * against a discipline change, such as an existing ldisc reference
263 * (which we check for)
264 *
Peter Hurley36697522013-06-15 07:04:48 -0400265 * Note: only callable from a file_operations routine (which
266 * guarantees tty->ldisc != NULL when the lock is acquired).
Alan Cox01e1abb2008-07-22 11:16:55 +0100267 */
268
269struct tty_ldisc *tty_ldisc_ref_wait(struct tty_struct *tty)
270{
Peter Hurley36697522013-06-15 07:04:48 -0400271 ldsem_down_read(&tty->ldisc_sem, MAX_SCHEDULE_TIMEOUT);
272 WARN_ON(!tty->ldisc);
273 return tty->ldisc;
Alan Cox01e1abb2008-07-22 11:16:55 +0100274}
Alan Cox01e1abb2008-07-22 11:16:55 +0100275EXPORT_SYMBOL_GPL(tty_ldisc_ref_wait);
276
277/**
278 * tty_ldisc_ref - get the tty ldisc
279 * @tty: tty device
280 *
281 * Dereference the line discipline for the terminal and take a
282 * reference to it. If the line discipline is in flux then
283 * return NULL. Can be called from IRQ and timer functions.
Alan Cox01e1abb2008-07-22 11:16:55 +0100284 */
285
286struct tty_ldisc *tty_ldisc_ref(struct tty_struct *tty)
287{
Peter Hurley36697522013-06-15 07:04:48 -0400288 struct tty_ldisc *ld = NULL;
289
290 if (ldsem_down_read_trylock(&tty->ldisc_sem)) {
291 ld = tty->ldisc;
292 if (!ld)
293 ldsem_up_read(&tty->ldisc_sem);
294 }
295 return ld;
Alan Cox01e1abb2008-07-22 11:16:55 +0100296}
Alan Cox01e1abb2008-07-22 11:16:55 +0100297EXPORT_SYMBOL_GPL(tty_ldisc_ref);
298
299/**
300 * tty_ldisc_deref - free a tty ldisc reference
301 * @ld: reference to free up
302 *
303 * Undoes the effect of tty_ldisc_ref or tty_ldisc_ref_wait. May
304 * be called in IRQ context.
Alan Cox01e1abb2008-07-22 11:16:55 +0100305 */
306
307void tty_ldisc_deref(struct tty_ldisc *ld)
308{
Peter Hurley36697522013-06-15 07:04:48 -0400309 ldsem_up_read(&ld->tty->ldisc_sem);
Alan Cox01e1abb2008-07-22 11:16:55 +0100310}
Alan Cox01e1abb2008-07-22 11:16:55 +0100311EXPORT_SYMBOL_GPL(tty_ldisc_deref);
312
Peter Hurleyd2c43892013-06-15 07:04:47 -0400313
Peter Hurleyc2bb5242016-01-09 21:13:51 -0800314static inline int
Peter Hurleye80a10e2014-11-05 12:13:06 -0500315__tty_ldisc_lock(struct tty_struct *tty, unsigned long timeout)
Peter Hurleyd2c43892013-06-15 07:04:47 -0400316{
317 return ldsem_down_write(&tty->ldisc_sem, timeout);
318}
319
Peter Hurleyc2bb5242016-01-09 21:13:51 -0800320static inline int
Peter Hurleye80a10e2014-11-05 12:13:06 -0500321__tty_ldisc_lock_nested(struct tty_struct *tty, unsigned long timeout)
Peter Hurleyd2c43892013-06-15 07:04:47 -0400322{
323 return ldsem_down_write_nested(&tty->ldisc_sem,
324 LDISC_SEM_OTHER, timeout);
325}
326
Peter Hurleye80a10e2014-11-05 12:13:06 -0500327static inline void __tty_ldisc_unlock(struct tty_struct *tty)
Peter Hurleyd2c43892013-06-15 07:04:47 -0400328{
Guillaume Gomez52772ea2015-10-04 21:19:18 +0200329 ldsem_up_write(&tty->ldisc_sem);
Peter Hurleyd2c43892013-06-15 07:04:47 -0400330}
331
Peter Hurleyc2bb5242016-01-09 21:13:51 -0800332static int tty_ldisc_lock(struct tty_struct *tty, unsigned long timeout)
Peter Hurleyfae76e92014-11-05 12:13:07 -0500333{
334 int ret;
335
336 ret = __tty_ldisc_lock(tty, timeout);
337 if (!ret)
338 return -EBUSY;
339 set_bit(TTY_LDISC_HALTED, &tty->flags);
340 return 0;
341}
342
343static void tty_ldisc_unlock(struct tty_struct *tty)
344{
345 clear_bit(TTY_LDISC_HALTED, &tty->flags);
346 __tty_ldisc_unlock(tty);
347}
348
Peter Hurleyc2bb5242016-01-09 21:13:51 -0800349static int
Peter Hurleyd2c43892013-06-15 07:04:47 -0400350tty_ldisc_lock_pair_timeout(struct tty_struct *tty, struct tty_struct *tty2,
351 unsigned long timeout)
352{
353 int ret;
354
355 if (tty < tty2) {
Peter Hurleye80a10e2014-11-05 12:13:06 -0500356 ret = __tty_ldisc_lock(tty, timeout);
Peter Hurleyd2c43892013-06-15 07:04:47 -0400357 if (ret) {
Peter Hurleye80a10e2014-11-05 12:13:06 -0500358 ret = __tty_ldisc_lock_nested(tty2, timeout);
Peter Hurleyd2c43892013-06-15 07:04:47 -0400359 if (!ret)
Peter Hurleye80a10e2014-11-05 12:13:06 -0500360 __tty_ldisc_unlock(tty);
Peter Hurleyd2c43892013-06-15 07:04:47 -0400361 }
362 } else {
363 /* if this is possible, it has lots of implications */
364 WARN_ON_ONCE(tty == tty2);
365 if (tty2 && tty != tty2) {
Peter Hurleye80a10e2014-11-05 12:13:06 -0500366 ret = __tty_ldisc_lock(tty2, timeout);
Peter Hurleyd2c43892013-06-15 07:04:47 -0400367 if (ret) {
Peter Hurleye80a10e2014-11-05 12:13:06 -0500368 ret = __tty_ldisc_lock_nested(tty, timeout);
Peter Hurleyd2c43892013-06-15 07:04:47 -0400369 if (!ret)
Peter Hurleye80a10e2014-11-05 12:13:06 -0500370 __tty_ldisc_unlock(tty2);
Peter Hurleyd2c43892013-06-15 07:04:47 -0400371 }
372 } else
Peter Hurleye80a10e2014-11-05 12:13:06 -0500373 ret = __tty_ldisc_lock(tty, timeout);
Peter Hurleyd2c43892013-06-15 07:04:47 -0400374 }
375
376 if (!ret)
377 return -EBUSY;
378
379 set_bit(TTY_LDISC_HALTED, &tty->flags);
380 if (tty2)
381 set_bit(TTY_LDISC_HALTED, &tty2->flags);
382 return 0;
383}
384
Peter Hurleyc2bb5242016-01-09 21:13:51 -0800385static void tty_ldisc_lock_pair(struct tty_struct *tty, struct tty_struct *tty2)
Peter Hurleyd2c43892013-06-15 07:04:47 -0400386{
387 tty_ldisc_lock_pair_timeout(tty, tty2, MAX_SCHEDULE_TIMEOUT);
388}
389
Peter Hurleyc2bb5242016-01-09 21:13:51 -0800390static void tty_ldisc_unlock_pair(struct tty_struct *tty,
391 struct tty_struct *tty2)
Peter Hurleyd2c43892013-06-15 07:04:47 -0400392{
Peter Hurleye80a10e2014-11-05 12:13:06 -0500393 __tty_ldisc_unlock(tty);
Peter Hurleyd2c43892013-06-15 07:04:47 -0400394 if (tty2)
Peter Hurleye80a10e2014-11-05 12:13:06 -0500395 __tty_ldisc_unlock(tty2);
Peter Hurleyd2c43892013-06-15 07:04:47 -0400396}
397
Alan Cox01e1abb2008-07-22 11:16:55 +0100398/**
Alan Coxf2c4c652009-06-11 12:50:58 +0100399 * tty_ldisc_flush - flush line discipline queue
400 * @tty: tty
401 *
Peter Hurley86c80a82014-11-05 12:13:09 -0500402 * Flush the line discipline queue (if any) and the tty flip buffers
403 * for this tty.
Alan Coxf2c4c652009-06-11 12:50:58 +0100404 */
405
406void tty_ldisc_flush(struct tty_struct *tty)
407{
408 struct tty_ldisc *ld = tty_ldisc_ref(tty);
Peter Hurley86c80a82014-11-05 12:13:09 -0500409
410 tty_buffer_flush(tty, ld);
411 if (ld)
Alan Coxf2c4c652009-06-11 12:50:58 +0100412 tty_ldisc_deref(ld);
Alan Coxf2c4c652009-06-11 12:50:58 +0100413}
Alan Coxf2c4c652009-06-11 12:50:58 +0100414EXPORT_SYMBOL_GPL(tty_ldisc_flush);
415
416/**
Alan Cox01e1abb2008-07-22 11:16:55 +0100417 * tty_set_termios_ldisc - set ldisc field
418 * @tty: tty structure
419 * @num: line discipline number
420 *
421 * This is probably overkill for real world processors but
422 * they are not on hot paths so a little discipline won't do
423 * any harm.
424 *
Peter Hurleydd42bf12015-11-27 14:30:21 -0500425 * The line discipline-related tty_struct fields are reset to
426 * prevent the ldisc driver from re-using stale information for
427 * the new ldisc instance.
428 *
Peter Hurley6a1c0682013-06-15 09:14:23 -0400429 * Locking: takes termios_rwsem
Alan Cox01e1abb2008-07-22 11:16:55 +0100430 */
431
432static void tty_set_termios_ldisc(struct tty_struct *tty, int num)
433{
Peter Hurley6a1c0682013-06-15 09:14:23 -0400434 down_write(&tty->termios_rwsem);
Alan Coxadc8d742012-07-14 15:31:47 +0100435 tty->termios.c_line = num;
Peter Hurley6a1c0682013-06-15 09:14:23 -0400436 up_write(&tty->termios_rwsem);
Peter Hurleydd42bf12015-11-27 14:30:21 -0500437
438 tty->disc_data = NULL;
439 tty->receive_room = 0;
Alan Cox01e1abb2008-07-22 11:16:55 +0100440}
441
Alan Coxc65c9bc2009-06-11 12:50:12 +0100442/**
443 * tty_ldisc_open - open a line discipline
444 * @tty: tty we are opening the ldisc on
445 * @ld: discipline to open
446 *
447 * A helper opening method. Also a convenient debugging and check
448 * point.
Arnd Bergmannec79d602010-06-01 22:53:01 +0200449 *
450 * Locking: always called with BTM already held.
Alan Coxc65c9bc2009-06-11 12:50:12 +0100451 */
452
453static int tty_ldisc_open(struct tty_struct *tty, struct tty_ldisc *ld)
454{
455 WARN_ON(test_and_set_bit(TTY_LDISC_OPEN, &tty->flags));
Alan Coxf18f9492009-11-30 13:18:35 +0000456 if (ld->ops->open) {
457 int ret;
Arnd Bergmannec79d602010-06-01 22:53:01 +0200458 /* BTM here locks versus a hangup event */
Alan Coxf18f9492009-11-30 13:18:35 +0000459 ret = ld->ops->open(tty);
Jiri Slaby7f90cfc2010-11-25 00:27:54 +0100460 if (ret)
461 clear_bit(TTY_LDISC_OPEN, &tty->flags);
Peter Hurleyfb6edc92015-07-12 22:49:12 -0400462
463 tty_ldisc_debug(tty, "%p: opened\n", tty->ldisc);
Alan Coxf18f9492009-11-30 13:18:35 +0000464 return ret;
465 }
Alan Coxc65c9bc2009-06-11 12:50:12 +0100466 return 0;
467}
468
469/**
470 * tty_ldisc_close - close a line discipline
471 * @tty: tty we are opening the ldisc on
472 * @ld: discipline to close
473 *
474 * A helper close method. Also a convenient debugging and check
475 * point.
476 */
477
478static void tty_ldisc_close(struct tty_struct *tty, struct tty_ldisc *ld)
479{
480 WARN_ON(!test_bit(TTY_LDISC_OPEN, &tty->flags));
481 clear_bit(TTY_LDISC_OPEN, &tty->flags);
482 if (ld->ops->close)
483 ld->ops->close(tty);
Peter Hurleyfb6edc92015-07-12 22:49:12 -0400484 tty_ldisc_debug(tty, "%p: closed\n", tty->ldisc);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100485}
Alan Cox01e1abb2008-07-22 11:16:55 +0100486
487/**
488 * tty_ldisc_restore - helper for tty ldisc change
489 * @tty: tty to recover
490 * @old: previous ldisc
491 *
492 * Restore the previous line discipline or N_TTY when a line discipline
493 * change fails due to an open error
494 */
495
496static void tty_ldisc_restore(struct tty_struct *tty, struct tty_ldisc *old)
497{
Alan Coxc65c9bc2009-06-11 12:50:12 +0100498 struct tty_ldisc *new_ldisc;
499 int r;
Alan Cox01e1abb2008-07-22 11:16:55 +0100500
501 /* There is an outstanding reference here so this is safe */
Peter Hurley36697522013-06-15 07:04:48 -0400502 old = tty_ldisc_get(tty, old->ops->num);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100503 WARN_ON(IS_ERR(old));
Peter Hurleyf48070452013-03-11 16:44:42 -0400504 tty->ldisc = old;
Alan Cox01e1abb2008-07-22 11:16:55 +0100505 tty_set_termios_ldisc(tty, old->ops->num);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100506 if (tty_ldisc_open(tty, old) < 0) {
507 tty_ldisc_put(old);
Alan Cox01e1abb2008-07-22 11:16:55 +0100508 /* This driver is always present */
Peter Hurley36697522013-06-15 07:04:48 -0400509 new_ldisc = tty_ldisc_get(tty, N_TTY);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100510 if (IS_ERR(new_ldisc))
Alan Cox01e1abb2008-07-22 11:16:55 +0100511 panic("n_tty: get");
Peter Hurleyf48070452013-03-11 16:44:42 -0400512 tty->ldisc = new_ldisc;
Alan Cox01e1abb2008-07-22 11:16:55 +0100513 tty_set_termios_ldisc(tty, N_TTY);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100514 r = tty_ldisc_open(tty, new_ldisc);
515 if (r < 0)
516 panic("Couldn't open N_TTY ldisc for "
517 "%s --- error %d.",
Rasmus Villemoes429b4742015-03-31 15:55:59 +0200518 tty_name(tty), r);
Alan Cox01e1abb2008-07-22 11:16:55 +0100519 }
520}
521
522/**
523 * tty_set_ldisc - set line discipline
524 * @tty: the terminal to set
525 * @ldisc: the line discipline
526 *
527 * Set the discipline of a tty line. Must be called from a process
Alan Coxc65c9bc2009-06-11 12:50:12 +0100528 * context. The ldisc change logic has to protect itself against any
529 * overlapping ldisc change (including on the other end of pty pairs),
530 * the close of one side of a tty/pty pair, and eventually hangup.
Alan Cox01e1abb2008-07-22 11:16:55 +0100531 */
532
533int tty_set_ldisc(struct tty_struct *tty, int ldisc)
534{
535 int retval;
Peter Hurley9fbfa342013-06-15 07:04:49 -0400536 struct tty_ldisc *old_ldisc, *new_ldisc;
Alan Cox01e1abb2008-07-22 11:16:55 +0100537
Peter Hurley36697522013-06-15 07:04:48 -0400538 new_ldisc = tty_ldisc_get(tty, ldisc);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100539 if (IS_ERR(new_ldisc))
540 return PTR_ERR(new_ldisc);
541
Peter Hurleyc8483bc2014-11-05 12:12:45 -0500542 tty_lock(tty);
Peter Hurley276a6612014-11-05 12:13:08 -0500543 retval = tty_ldisc_lock(tty, 5 * HZ);
Peter Hurley63d8cb32015-11-08 09:29:38 -0500544 if (retval)
545 goto err;
Alan Coxc65c9bc2009-06-11 12:50:12 +0100546
Peter Hurley63d8cb32015-11-08 09:29:38 -0500547 /* Check the no-op case */
548 if (tty->ldisc->ops->num == ldisc)
549 goto out;
Alan Coxc65c9bc2009-06-11 12:50:12 +0100550
Peter Hurley63d8cb32015-11-08 09:29:38 -0500551 if (test_bit(TTY_HUPPED, &tty->flags)) {
552 /* We were raced by hangup */
553 retval = -EIO;
554 goto out;
Alan Coxc65c9bc2009-06-11 12:50:12 +0100555 }
Alan Cox01e1abb2008-07-22 11:16:55 +0100556
Peter Hurley9fbfa342013-06-15 07:04:49 -0400557 old_ldisc = tty->ldisc;
Jiri Slaby100eeae2010-10-31 23:17:51 +0100558
Peter Hurley9fbfa342013-06-15 07:04:49 -0400559 /* Shutdown the old discipline. */
560 tty_ldisc_close(tty, old_ldisc);
Alan Cox01e1abb2008-07-22 11:16:55 +0100561
562 /* Now set up the new line discipline. */
Peter Hurleyf48070452013-03-11 16:44:42 -0400563 tty->ldisc = new_ldisc;
Alan Cox01e1abb2008-07-22 11:16:55 +0100564 tty_set_termios_ldisc(tty, ldisc);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100565
566 retval = tty_ldisc_open(tty, new_ldisc);
Alan Cox01e1abb2008-07-22 11:16:55 +0100567 if (retval < 0) {
Alan Coxc65c9bc2009-06-11 12:50:12 +0100568 /* Back to the old one or N_TTY if we can't */
569 tty_ldisc_put(new_ldisc);
Peter Hurley9fbfa342013-06-15 07:04:49 -0400570 tty_ldisc_restore(tty, old_ldisc);
Alan Cox01e1abb2008-07-22 11:16:55 +0100571 }
Alan Coxc65c9bc2009-06-11 12:50:12 +0100572
Peter Hurley9191aaa2014-11-05 13:11:41 -0500573 if (tty->ldisc->ops->num != old_ldisc->ops->num && tty->ops->set_ldisc) {
574 down_read(&tty->termios_rwsem);
Alan Cox01e1abb2008-07-22 11:16:55 +0100575 tty->ops->set_ldisc(tty);
Peter Hurley9191aaa2014-11-05 13:11:41 -0500576 up_read(&tty->termios_rwsem);
577 }
Alan Cox01e1abb2008-07-22 11:16:55 +0100578
Peter Hurleyb0e95852013-06-15 07:04:51 -0400579 /* At this point we hold a reference to the new ldisc and a
580 reference to the old ldisc, or we hold two references to
581 the old ldisc (if it was restored as part of error cleanup
582 above). In either case, releasing a single reference from
583 the old ldisc is correct. */
Peter Hurley63d8cb32015-11-08 09:29:38 -0500584 new_ldisc = old_ldisc;
585out:
Peter Hurley276a6612014-11-05 12:13:08 -0500586 tty_ldisc_unlock(tty);
Alan Cox01e1abb2008-07-22 11:16:55 +0100587
Alan Coxc65c9bc2009-06-11 12:50:12 +0100588 /* Restart the work queue in case no characters kick it off. Safe if
Alan Cox01e1abb2008-07-22 11:16:55 +0100589 already running */
Peter Hurley17a69212015-11-08 07:53:06 -0500590 tty_buffer_restart_work(tty->port);
Peter Hurley63d8cb32015-11-08 09:29:38 -0500591err:
592 tty_ldisc_put(new_ldisc); /* drop the extra reference */
Alan Cox89c8d912012-08-08 16:30:13 +0100593 tty_unlock(tty);
Alan Cox01e1abb2008-07-22 11:16:55 +0100594 return retval;
595}
596
Alan Coxc65c9bc2009-06-11 12:50:12 +0100597/**
598 * tty_reset_termios - reset terminal state
599 * @tty: tty to reset
600 *
601 * Restore a terminal to the driver default state.
602 */
603
604static void tty_reset_termios(struct tty_struct *tty)
605{
Peter Hurley6a1c0682013-06-15 09:14:23 -0400606 down_write(&tty->termios_rwsem);
Alan Coxadc8d742012-07-14 15:31:47 +0100607 tty->termios = tty->driver->init_termios;
608 tty->termios.c_ispeed = tty_termios_input_baud_rate(&tty->termios);
609 tty->termios.c_ospeed = tty_termios_baud_rate(&tty->termios);
Peter Hurley6a1c0682013-06-15 09:14:23 -0400610 up_write(&tty->termios_rwsem);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100611}
612
613
614/**
615 * tty_ldisc_reinit - reinitialise the tty ldisc
616 * @tty: tty to reinit
Alan Cox638b9642010-02-08 10:09:26 +0000617 * @ldisc: line discipline to reinitialize
Alan Coxc65c9bc2009-06-11 12:50:12 +0100618 *
Alan Cox638b9642010-02-08 10:09:26 +0000619 * Switch the tty to a line discipline and leave the ldisc
620 * state closed
Alan Coxc65c9bc2009-06-11 12:50:12 +0100621 */
622
Philippe Rétornaz1c95ba12010-10-27 17:13:21 +0200623static int tty_ldisc_reinit(struct tty_struct *tty, int ldisc)
Alan Coxc65c9bc2009-06-11 12:50:12 +0100624{
Peter Hurley36697522013-06-15 07:04:48 -0400625 struct tty_ldisc *ld = tty_ldisc_get(tty, ldisc);
Philippe Rétornaz1c95ba12010-10-27 17:13:21 +0200626
627 if (IS_ERR(ld))
628 return -1;
Alan Coxc65c9bc2009-06-11 12:50:12 +0100629
630 tty_ldisc_close(tty, tty->ldisc);
631 tty_ldisc_put(tty->ldisc);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100632 /*
633 * Switch the line discipline back
634 */
Peter Hurleyf48070452013-03-11 16:44:42 -0400635 tty->ldisc = ld;
Alan Cox638b9642010-02-08 10:09:26 +0000636 tty_set_termios_ldisc(tty, ldisc);
Philippe Rétornaz1c95ba12010-10-27 17:13:21 +0200637
638 return 0;
Alan Coxc65c9bc2009-06-11 12:50:12 +0100639}
640
641/**
642 * tty_ldisc_hangup - hangup ldisc reset
643 * @tty: tty being hung up
644 *
645 * Some tty devices reset their termios when they receive a hangup
646 * event. In that situation we must also switch back to N_TTY properly
647 * before we reset the termios data.
648 *
649 * Locking: We can take the ldisc mutex as the rest of the code is
650 * careful to allow for this.
651 *
652 * In the pty pair case this occurs in the close() path of the
653 * tty itself so we must be careful about locking rules.
654 */
655
656void tty_ldisc_hangup(struct tty_struct *tty)
657{
658 struct tty_ldisc *ld;
Alan Cox638b9642010-02-08 10:09:26 +0000659 int reset = tty->driver->flags & TTY_DRIVER_RESET_TERMIOS;
660 int err = 0;
Alan Coxc65c9bc2009-06-11 12:50:12 +0100661
Peter Hurleyfb6edc92015-07-12 22:49:12 -0400662 tty_ldisc_debug(tty, "%p: closing\n", tty->ldisc);
Peter Hurleyfc575ee2013-03-11 16:44:38 -0400663
Alan Coxc65c9bc2009-06-11 12:50:12 +0100664 ld = tty_ldisc_ref(tty);
665 if (ld != NULL) {
Alan Coxc65c9bc2009-06-11 12:50:12 +0100666 if (ld->ops->flush_buffer)
667 ld->ops->flush_buffer(tty);
668 tty_driver_flush_buffer(tty);
669 if ((test_bit(TTY_DO_WRITE_WAKEUP, &tty->flags)) &&
670 ld->ops->write_wakeup)
671 ld->ops->write_wakeup(tty);
672 if (ld->ops->hangup)
673 ld->ops->hangup(tty);
674 tty_ldisc_deref(ld);
675 }
Peter Hurley36697522013-06-15 07:04:48 -0400676
Alan Coxc65c9bc2009-06-11 12:50:12 +0100677 wake_up_interruptible_poll(&tty->write_wait, POLLOUT);
678 wake_up_interruptible_poll(&tty->read_wait, POLLIN);
Peter Hurley36697522013-06-15 07:04:48 -0400679
Alan Coxc65c9bc2009-06-11 12:50:12 +0100680 /*
681 * Shutdown the current line discipline, and reset it to
Alan Cox638b9642010-02-08 10:09:26 +0000682 * N_TTY if need be.
683 *
684 * Avoid racing set_ldisc or tty_ldisc_release
Alan Coxc65c9bc2009-06-11 12:50:12 +0100685 */
Peter Hurleyfae76e92014-11-05 12:13:07 -0500686 tty_ldisc_lock(tty, MAX_SCHEDULE_TIMEOUT);
Arnd Bergmann60af22d2010-06-01 22:53:06 +0200687
Peter Hurley36697522013-06-15 07:04:48 -0400688 if (tty->ldisc) {
Peter Hurleyc8785242013-03-11 16:44:36 -0400689
690 /* At this point we have a halted ldisc; we want to close it and
691 reopen a new ldisc. We could defer the reopen to the next
692 open but it means auditing a lot of other paths so this is
693 a FIXME */
Alan Cox638b9642010-02-08 10:09:26 +0000694 if (reset == 0) {
Philippe Rétornaz1c95ba12010-10-27 17:13:21 +0200695
Alan Coxadc8d742012-07-14 15:31:47 +0100696 if (!tty_ldisc_reinit(tty, tty->termios.c_line))
Philippe Rétornaz1c95ba12010-10-27 17:13:21 +0200697 err = tty_ldisc_open(tty, tty->ldisc);
698 else
699 err = 1;
Alan Coxc8d50042009-07-16 16:05:08 +0100700 }
Alan Cox638b9642010-02-08 10:09:26 +0000701 /* If the re-open fails or we reset then go to N_TTY. The
702 N_TTY open cannot fail */
703 if (reset || err) {
Philippe Rétornaz1c95ba12010-10-27 17:13:21 +0200704 BUG_ON(tty_ldisc_reinit(tty, N_TTY));
Alan Cox638b9642010-02-08 10:09:26 +0000705 WARN_ON(tty_ldisc_open(tty, tty->ldisc));
706 }
Alan Coxc65c9bc2009-06-11 12:50:12 +0100707 }
Peter Hurleyfae76e92014-11-05 12:13:07 -0500708 tty_ldisc_unlock(tty);
Alan Cox638b9642010-02-08 10:09:26 +0000709 if (reset)
710 tty_reset_termios(tty);
Peter Hurleyfc575ee2013-03-11 16:44:38 -0400711
Peter Hurleyfb6edc92015-07-12 22:49:12 -0400712 tty_ldisc_debug(tty, "%p: re-opened\n", tty->ldisc);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100713}
Alan Cox01e1abb2008-07-22 11:16:55 +0100714
715/**
716 * tty_ldisc_setup - open line discipline
717 * @tty: tty being shut down
718 * @o_tty: pair tty for pty/tty pairs
719 *
720 * Called during the initial open of a tty/pty pair in order to set up the
Alan Coxc65c9bc2009-06-11 12:50:12 +0100721 * line disciplines and bind them to the tty. This has no locking issues
722 * as the device isn't yet active.
Alan Cox01e1abb2008-07-22 11:16:55 +0100723 */
724
725int tty_ldisc_setup(struct tty_struct *tty, struct tty_struct *o_tty)
726{
Alan Coxc65c9bc2009-06-11 12:50:12 +0100727 struct tty_ldisc *ld = tty->ldisc;
Alan Cox01e1abb2008-07-22 11:16:55 +0100728 int retval;
729
Alan Coxc65c9bc2009-06-11 12:50:12 +0100730 retval = tty_ldisc_open(tty, ld);
731 if (retval)
732 return retval;
733
734 if (o_tty) {
735 retval = tty_ldisc_open(o_tty, o_tty->ldisc);
Alan Cox01e1abb2008-07-22 11:16:55 +0100736 if (retval) {
Alan Coxc65c9bc2009-06-11 12:50:12 +0100737 tty_ldisc_close(tty, ld);
Alan Cox01e1abb2008-07-22 11:16:55 +0100738 return retval;
739 }
Alan Cox01e1abb2008-07-22 11:16:55 +0100740 }
Alan Cox01e1abb2008-07-22 11:16:55 +0100741 return 0;
742}
Alan Cox89c8d912012-08-08 16:30:13 +0100743
744static void tty_ldisc_kill(struct tty_struct *tty)
745{
Alan Cox89c8d912012-08-08 16:30:13 +0100746 /*
747 * Now kill off the ldisc
748 */
749 tty_ldisc_close(tty, tty->ldisc);
750 tty_ldisc_put(tty->ldisc);
751 /* Force an oops if we mess this up */
752 tty->ldisc = NULL;
Alan Cox89c8d912012-08-08 16:30:13 +0100753}
754
Alan Cox01e1abb2008-07-22 11:16:55 +0100755/**
756 * tty_ldisc_release - release line discipline
Peter Hurley62462ae2014-11-05 12:12:58 -0500757 * @tty: tty being shut down (or one end of pty pair)
Alan Cox01e1abb2008-07-22 11:16:55 +0100758 *
Peter Hurley62462ae2014-11-05 12:12:58 -0500759 * Called during the final close of a tty or a pty pair in order to shut
760 * down the line discpline layer. On exit, each ldisc assigned is N_TTY and
761 * each ldisc has not been opened.
Alan Cox01e1abb2008-07-22 11:16:55 +0100762 */
763
Peter Hurley62462ae2014-11-05 12:12:58 -0500764void tty_ldisc_release(struct tty_struct *tty)
Alan Cox01e1abb2008-07-22 11:16:55 +0100765{
Peter Hurley62462ae2014-11-05 12:12:58 -0500766 struct tty_struct *o_tty = tty->link;
767
Alan Cox01e1abb2008-07-22 11:16:55 +0100768 /*
Peter Hurleya2965b72013-03-11 16:44:35 -0400769 * Shutdown this line discipline. As this is the final close,
770 * it does not race with the set_ldisc code path.
Alan Cox01e1abb2008-07-22 11:16:55 +0100771 */
Alan Cox01e1abb2008-07-22 11:16:55 +0100772
Peter Hurley36697522013-06-15 07:04:48 -0400773 tty_ldisc_lock_pair(tty, o_tty);
Alan Cox89c8d912012-08-08 16:30:13 +0100774 tty_ldisc_kill(tty);
Alan Cox89c8d912012-08-08 16:30:13 +0100775 if (o_tty)
776 tty_ldisc_kill(o_tty);
Peter Hurley36697522013-06-15 07:04:48 -0400777 tty_ldisc_unlock_pair(tty, o_tty);
778
Alan Coxaef29bc2009-06-29 15:21:47 +0100779 /* And the memory resources remaining (buffers, termios) will be
780 disposed of when the kref hits zero */
Peter Hurleyfc575ee2013-03-11 16:44:38 -0400781
Peter Hurleyfb6edc92015-07-12 22:49:12 -0400782 tty_ldisc_debug(tty, "released\n");
Alan Cox01e1abb2008-07-22 11:16:55 +0100783}
784
785/**
786 * tty_ldisc_init - ldisc setup for new tty
787 * @tty: tty being allocated
788 *
789 * Set up the line discipline objects for a newly allocated tty. Note that
790 * the tty structure is not completely set up when this call is made.
791 */
792
793void tty_ldisc_init(struct tty_struct *tty)
794{
Peter Hurley36697522013-06-15 07:04:48 -0400795 struct tty_ldisc *ld = tty_ldisc_get(tty, N_TTY);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100796 if (IS_ERR(ld))
Alan Cox01e1abb2008-07-22 11:16:55 +0100797 panic("n_tty: init_tty");
Peter Hurleyf48070452013-03-11 16:44:42 -0400798 tty->ldisc = ld;
Alan Cox01e1abb2008-07-22 11:16:55 +0100799}
800
Jiri Slaby67166712011-03-23 10:48:35 +0100801/**
Peter Hurleyc8b710b2016-01-09 21:13:46 -0800802 * tty_ldisc_deinit - ldisc cleanup for new tty
Jiri Slaby67166712011-03-23 10:48:35 +0100803 * @tty: tty that was allocated recently
804 *
805 * The tty structure must not becompletely set up (tty_ldisc_setup) when
806 * this call is made.
807 */
808void tty_ldisc_deinit(struct tty_struct *tty)
809{
Peter Hurleyc8b710b2016-01-09 21:13:46 -0800810 if (tty->ldisc)
811 tty_ldisc_put(tty->ldisc);
Peter Hurleyf48070452013-03-11 16:44:42 -0400812 tty->ldisc = NULL;
Jiri Slaby67166712011-03-23 10:48:35 +0100813}
814
Alan Cox01e1abb2008-07-22 11:16:55 +0100815void tty_ldisc_begin(void)
816{
817 /* Setup the default TTY line discipline. */
818 (void) tty_register_ldisc(N_TTY, &tty_ldisc_N_TTY);
819}