blob: e18c8e86411040e5fe452abe9790b03aba5d3b18 [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 Hurleye55afd12016-01-10 22:41:01 -0800265 * Note: a file_operations routine (read/poll/write) should use this
266 * function to wait for any ldisc lifetime events to finish.
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);
Peter Hurleya570a492016-01-10 22:41:02 -0800272 if (!tty->ldisc)
273 ldsem_up_read(&tty->ldisc_sem);
Peter Hurley36697522013-06-15 07:04:48 -0400274 return tty->ldisc;
Alan Cox01e1abb2008-07-22 11:16:55 +0100275}
Alan Cox01e1abb2008-07-22 11:16:55 +0100276EXPORT_SYMBOL_GPL(tty_ldisc_ref_wait);
277
278/**
279 * tty_ldisc_ref - get the tty ldisc
280 * @tty: tty device
281 *
282 * Dereference the line discipline for the terminal and take a
283 * reference to it. If the line discipline is in flux then
284 * return NULL. Can be called from IRQ and timer functions.
Alan Cox01e1abb2008-07-22 11:16:55 +0100285 */
286
287struct tty_ldisc *tty_ldisc_ref(struct tty_struct *tty)
288{
Peter Hurley36697522013-06-15 07:04:48 -0400289 struct tty_ldisc *ld = NULL;
290
291 if (ldsem_down_read_trylock(&tty->ldisc_sem)) {
292 ld = tty->ldisc;
293 if (!ld)
294 ldsem_up_read(&tty->ldisc_sem);
295 }
296 return ld;
Alan Cox01e1abb2008-07-22 11:16:55 +0100297}
Alan Cox01e1abb2008-07-22 11:16:55 +0100298EXPORT_SYMBOL_GPL(tty_ldisc_ref);
299
300/**
301 * tty_ldisc_deref - free a tty ldisc reference
302 * @ld: reference to free up
303 *
304 * Undoes the effect of tty_ldisc_ref or tty_ldisc_ref_wait. May
305 * be called in IRQ context.
Alan Cox01e1abb2008-07-22 11:16:55 +0100306 */
307
308void tty_ldisc_deref(struct tty_ldisc *ld)
309{
Peter Hurley36697522013-06-15 07:04:48 -0400310 ldsem_up_read(&ld->tty->ldisc_sem);
Alan Cox01e1abb2008-07-22 11:16:55 +0100311}
Alan Cox01e1abb2008-07-22 11:16:55 +0100312EXPORT_SYMBOL_GPL(tty_ldisc_deref);
313
Peter Hurleyd2c43892013-06-15 07:04:47 -0400314
Peter Hurleyc2bb5242016-01-09 21:13:51 -0800315static inline int
Peter Hurleye80a10e2014-11-05 12:13:06 -0500316__tty_ldisc_lock(struct tty_struct *tty, unsigned long timeout)
Peter Hurleyd2c43892013-06-15 07:04:47 -0400317{
318 return ldsem_down_write(&tty->ldisc_sem, timeout);
319}
320
Peter Hurleyc2bb5242016-01-09 21:13:51 -0800321static inline int
Peter Hurleye80a10e2014-11-05 12:13:06 -0500322__tty_ldisc_lock_nested(struct tty_struct *tty, unsigned long timeout)
Peter Hurleyd2c43892013-06-15 07:04:47 -0400323{
324 return ldsem_down_write_nested(&tty->ldisc_sem,
325 LDISC_SEM_OTHER, timeout);
326}
327
Peter Hurleye80a10e2014-11-05 12:13:06 -0500328static inline void __tty_ldisc_unlock(struct tty_struct *tty)
Peter Hurleyd2c43892013-06-15 07:04:47 -0400329{
Guillaume Gomez52772ea2015-10-04 21:19:18 +0200330 ldsem_up_write(&tty->ldisc_sem);
Peter Hurleyd2c43892013-06-15 07:04:47 -0400331}
332
Peter Hurleyc2bb5242016-01-09 21:13:51 -0800333static int tty_ldisc_lock(struct tty_struct *tty, unsigned long timeout)
Peter Hurleyfae76e92014-11-05 12:13:07 -0500334{
335 int ret;
336
337 ret = __tty_ldisc_lock(tty, timeout);
338 if (!ret)
339 return -EBUSY;
340 set_bit(TTY_LDISC_HALTED, &tty->flags);
341 return 0;
342}
343
344static void tty_ldisc_unlock(struct tty_struct *tty)
345{
346 clear_bit(TTY_LDISC_HALTED, &tty->flags);
347 __tty_ldisc_unlock(tty);
348}
349
Peter Hurleyc2bb5242016-01-09 21:13:51 -0800350static int
Peter Hurleyd2c43892013-06-15 07:04:47 -0400351tty_ldisc_lock_pair_timeout(struct tty_struct *tty, struct tty_struct *tty2,
352 unsigned long timeout)
353{
354 int ret;
355
356 if (tty < tty2) {
Peter Hurleye80a10e2014-11-05 12:13:06 -0500357 ret = __tty_ldisc_lock(tty, timeout);
Peter Hurleyd2c43892013-06-15 07:04:47 -0400358 if (ret) {
Peter Hurleye80a10e2014-11-05 12:13:06 -0500359 ret = __tty_ldisc_lock_nested(tty2, timeout);
Peter Hurleyd2c43892013-06-15 07:04:47 -0400360 if (!ret)
Peter Hurleye80a10e2014-11-05 12:13:06 -0500361 __tty_ldisc_unlock(tty);
Peter Hurleyd2c43892013-06-15 07:04:47 -0400362 }
363 } else {
364 /* if this is possible, it has lots of implications */
365 WARN_ON_ONCE(tty == tty2);
366 if (tty2 && tty != tty2) {
Peter Hurleye80a10e2014-11-05 12:13:06 -0500367 ret = __tty_ldisc_lock(tty2, timeout);
Peter Hurleyd2c43892013-06-15 07:04:47 -0400368 if (ret) {
Peter Hurleye80a10e2014-11-05 12:13:06 -0500369 ret = __tty_ldisc_lock_nested(tty, timeout);
Peter Hurleyd2c43892013-06-15 07:04:47 -0400370 if (!ret)
Peter Hurleye80a10e2014-11-05 12:13:06 -0500371 __tty_ldisc_unlock(tty2);
Peter Hurleyd2c43892013-06-15 07:04:47 -0400372 }
373 } else
Peter Hurleye80a10e2014-11-05 12:13:06 -0500374 ret = __tty_ldisc_lock(tty, timeout);
Peter Hurleyd2c43892013-06-15 07:04:47 -0400375 }
376
377 if (!ret)
378 return -EBUSY;
379
380 set_bit(TTY_LDISC_HALTED, &tty->flags);
381 if (tty2)
382 set_bit(TTY_LDISC_HALTED, &tty2->flags);
383 return 0;
384}
385
Peter Hurleyc2bb5242016-01-09 21:13:51 -0800386static void tty_ldisc_lock_pair(struct tty_struct *tty, struct tty_struct *tty2)
Peter Hurleyd2c43892013-06-15 07:04:47 -0400387{
388 tty_ldisc_lock_pair_timeout(tty, tty2, MAX_SCHEDULE_TIMEOUT);
389}
390
Peter Hurleyc2bb5242016-01-09 21:13:51 -0800391static void tty_ldisc_unlock_pair(struct tty_struct *tty,
392 struct tty_struct *tty2)
Peter Hurleyd2c43892013-06-15 07:04:47 -0400393{
Peter Hurleye80a10e2014-11-05 12:13:06 -0500394 __tty_ldisc_unlock(tty);
Peter Hurleyd2c43892013-06-15 07:04:47 -0400395 if (tty2)
Peter Hurleye80a10e2014-11-05 12:13:06 -0500396 __tty_ldisc_unlock(tty2);
Peter Hurleyd2c43892013-06-15 07:04:47 -0400397}
398
Alan Cox01e1abb2008-07-22 11:16:55 +0100399/**
Alan Coxf2c4c652009-06-11 12:50:58 +0100400 * tty_ldisc_flush - flush line discipline queue
401 * @tty: tty
402 *
Peter Hurley86c80a82014-11-05 12:13:09 -0500403 * Flush the line discipline queue (if any) and the tty flip buffers
404 * for this tty.
Alan Coxf2c4c652009-06-11 12:50:58 +0100405 */
406
407void tty_ldisc_flush(struct tty_struct *tty)
408{
409 struct tty_ldisc *ld = tty_ldisc_ref(tty);
Peter Hurley86c80a82014-11-05 12:13:09 -0500410
411 tty_buffer_flush(tty, ld);
412 if (ld)
Alan Coxf2c4c652009-06-11 12:50:58 +0100413 tty_ldisc_deref(ld);
Alan Coxf2c4c652009-06-11 12:50:58 +0100414}
Alan Coxf2c4c652009-06-11 12:50:58 +0100415EXPORT_SYMBOL_GPL(tty_ldisc_flush);
416
417/**
Alan Cox01e1abb2008-07-22 11:16:55 +0100418 * tty_set_termios_ldisc - set ldisc field
419 * @tty: tty structure
Peter Hurleyc12da962016-01-10 22:41:04 -0800420 * @disc: line discipline number
Alan Cox01e1abb2008-07-22 11:16:55 +0100421 *
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 *
Peter Hurleydd42bf12015-11-27 14:30:21 -0500426 * The line discipline-related tty_struct fields are reset to
427 * prevent the ldisc driver from re-using stale information for
428 * the new ldisc instance.
429 *
Peter Hurley6a1c0682013-06-15 09:14:23 -0400430 * Locking: takes termios_rwsem
Alan Cox01e1abb2008-07-22 11:16:55 +0100431 */
432
Peter Hurleyc12da962016-01-10 22:41:04 -0800433static void tty_set_termios_ldisc(struct tty_struct *tty, int disc)
Alan Cox01e1abb2008-07-22 11:16:55 +0100434{
Peter Hurley6a1c0682013-06-15 09:14:23 -0400435 down_write(&tty->termios_rwsem);
Peter Hurleyc12da962016-01-10 22:41:04 -0800436 tty->termios.c_line = disc;
Peter Hurley6a1c0682013-06-15 09:14:23 -0400437 up_write(&tty->termios_rwsem);
Peter Hurleydd42bf12015-11-27 14:30:21 -0500438
439 tty->disc_data = NULL;
440 tty->receive_room = 0;
Alan Cox01e1abb2008-07-22 11:16:55 +0100441}
442
Alan Coxc65c9bc2009-06-11 12:50:12 +0100443/**
444 * tty_ldisc_open - open a line discipline
445 * @tty: tty we are opening the ldisc on
446 * @ld: discipline to open
447 *
448 * A helper opening method. Also a convenient debugging and check
449 * point.
Arnd Bergmannec79d602010-06-01 22:53:01 +0200450 *
451 * Locking: always called with BTM already held.
Alan Coxc65c9bc2009-06-11 12:50:12 +0100452 */
453
454static int tty_ldisc_open(struct tty_struct *tty, struct tty_ldisc *ld)
455{
456 WARN_ON(test_and_set_bit(TTY_LDISC_OPEN, &tty->flags));
Alan Coxf18f9492009-11-30 13:18:35 +0000457 if (ld->ops->open) {
458 int ret;
Arnd Bergmannec79d602010-06-01 22:53:01 +0200459 /* BTM here locks versus a hangup event */
Alan Coxf18f9492009-11-30 13:18:35 +0000460 ret = ld->ops->open(tty);
Jiri Slaby7f90cfc2010-11-25 00:27:54 +0100461 if (ret)
462 clear_bit(TTY_LDISC_OPEN, &tty->flags);
Peter Hurleyfb6edc92015-07-12 22:49:12 -0400463
Peter Hurleya570a492016-01-10 22:41:02 -0800464 tty_ldisc_debug(tty, "%p: opened\n", ld);
Alan Coxf18f9492009-11-30 13:18:35 +0000465 return ret;
466 }
Alan Coxc65c9bc2009-06-11 12:50:12 +0100467 return 0;
468}
469
470/**
471 * tty_ldisc_close - close a line discipline
472 * @tty: tty we are opening the ldisc on
473 * @ld: discipline to close
474 *
475 * A helper close method. Also a convenient debugging and check
476 * point.
477 */
478
479static void tty_ldisc_close(struct tty_struct *tty, struct tty_ldisc *ld)
480{
481 WARN_ON(!test_bit(TTY_LDISC_OPEN, &tty->flags));
482 clear_bit(TTY_LDISC_OPEN, &tty->flags);
483 if (ld->ops->close)
484 ld->ops->close(tty);
Peter Hurleya570a492016-01-10 22:41:02 -0800485 tty_ldisc_debug(tty, "%p: closed\n", ld);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100486}
Alan Cox01e1abb2008-07-22 11:16:55 +0100487
488/**
489 * tty_ldisc_restore - helper for tty ldisc change
490 * @tty: tty to recover
491 * @old: previous ldisc
492 *
493 * Restore the previous line discipline or N_TTY when a line discipline
494 * change fails due to an open error
495 */
496
497static void tty_ldisc_restore(struct tty_struct *tty, struct tty_ldisc *old)
498{
Alan Coxc65c9bc2009-06-11 12:50:12 +0100499 struct tty_ldisc *new_ldisc;
500 int r;
Alan Cox01e1abb2008-07-22 11:16:55 +0100501
502 /* There is an outstanding reference here so this is safe */
Peter Hurley36697522013-06-15 07:04:48 -0400503 old = tty_ldisc_get(tty, old->ops->num);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100504 WARN_ON(IS_ERR(old));
Peter Hurleyf48070452013-03-11 16:44:42 -0400505 tty->ldisc = old;
Alan Cox01e1abb2008-07-22 11:16:55 +0100506 tty_set_termios_ldisc(tty, old->ops->num);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100507 if (tty_ldisc_open(tty, old) < 0) {
508 tty_ldisc_put(old);
Alan Cox01e1abb2008-07-22 11:16:55 +0100509 /* This driver is always present */
Peter Hurley36697522013-06-15 07:04:48 -0400510 new_ldisc = tty_ldisc_get(tty, N_TTY);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100511 if (IS_ERR(new_ldisc))
Alan Cox01e1abb2008-07-22 11:16:55 +0100512 panic("n_tty: get");
Peter Hurleyf48070452013-03-11 16:44:42 -0400513 tty->ldisc = new_ldisc;
Alan Cox01e1abb2008-07-22 11:16:55 +0100514 tty_set_termios_ldisc(tty, N_TTY);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100515 r = tty_ldisc_open(tty, new_ldisc);
516 if (r < 0)
517 panic("Couldn't open N_TTY ldisc for "
518 "%s --- error %d.",
Rasmus Villemoes429b4742015-03-31 15:55:59 +0200519 tty_name(tty), r);
Alan Cox01e1abb2008-07-22 11:16:55 +0100520 }
521}
522
523/**
524 * tty_set_ldisc - set line discipline
525 * @tty: the terminal to set
526 * @ldisc: the line discipline
527 *
528 * Set the discipline of a tty line. Must be called from a process
Alan Coxc65c9bc2009-06-11 12:50:12 +0100529 * context. The ldisc change logic has to protect itself against any
530 * overlapping ldisc change (including on the other end of pty pairs),
531 * the close of one side of a tty/pty pair, and eventually hangup.
Alan Cox01e1abb2008-07-22 11:16:55 +0100532 */
533
Peter Hurleyc12da962016-01-10 22:41:04 -0800534int tty_set_ldisc(struct tty_struct *tty, int disc)
Alan Cox01e1abb2008-07-22 11:16:55 +0100535{
536 int retval;
Peter Hurley9fbfa342013-06-15 07:04:49 -0400537 struct tty_ldisc *old_ldisc, *new_ldisc;
Alan Cox01e1abb2008-07-22 11:16:55 +0100538
Peter Hurleyc12da962016-01-10 22:41:04 -0800539 new_ldisc = tty_ldisc_get(tty, disc);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100540 if (IS_ERR(new_ldisc))
541 return PTR_ERR(new_ldisc);
542
Peter Hurleyc8483bc2014-11-05 12:12:45 -0500543 tty_lock(tty);
Peter Hurley276a6612014-11-05 12:13:08 -0500544 retval = tty_ldisc_lock(tty, 5 * HZ);
Peter Hurley63d8cb32015-11-08 09:29:38 -0500545 if (retval)
546 goto err;
Alan Coxc65c9bc2009-06-11 12:50:12 +0100547
Peter Hurleya570a492016-01-10 22:41:02 -0800548 if (!tty->ldisc) {
549 retval = -EIO;
550 goto out;
551 }
552
Peter Hurley63d8cb32015-11-08 09:29:38 -0500553 /* Check the no-op case */
Peter Hurleyc12da962016-01-10 22:41:04 -0800554 if (tty->ldisc->ops->num == disc)
Peter Hurley63d8cb32015-11-08 09:29:38 -0500555 goto out;
Alan Coxc65c9bc2009-06-11 12:50:12 +0100556
Peter Hurley63d8cb32015-11-08 09:29:38 -0500557 if (test_bit(TTY_HUPPED, &tty->flags)) {
558 /* We were raced by hangup */
559 retval = -EIO;
560 goto out;
Alan Coxc65c9bc2009-06-11 12:50:12 +0100561 }
Alan Cox01e1abb2008-07-22 11:16:55 +0100562
Peter Hurley9fbfa342013-06-15 07:04:49 -0400563 old_ldisc = tty->ldisc;
Jiri Slaby100eeae2010-10-31 23:17:51 +0100564
Peter Hurley9fbfa342013-06-15 07:04:49 -0400565 /* Shutdown the old discipline. */
566 tty_ldisc_close(tty, old_ldisc);
Alan Cox01e1abb2008-07-22 11:16:55 +0100567
568 /* Now set up the new line discipline. */
Peter Hurleyf48070452013-03-11 16:44:42 -0400569 tty->ldisc = new_ldisc;
Peter Hurleyc12da962016-01-10 22:41:04 -0800570 tty_set_termios_ldisc(tty, disc);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100571
572 retval = tty_ldisc_open(tty, new_ldisc);
Alan Cox01e1abb2008-07-22 11:16:55 +0100573 if (retval < 0) {
Alan Coxc65c9bc2009-06-11 12:50:12 +0100574 /* Back to the old one or N_TTY if we can't */
575 tty_ldisc_put(new_ldisc);
Peter Hurley9fbfa342013-06-15 07:04:49 -0400576 tty_ldisc_restore(tty, old_ldisc);
Alan Cox01e1abb2008-07-22 11:16:55 +0100577 }
Alan Coxc65c9bc2009-06-11 12:50:12 +0100578
Peter Hurley9191aaa2014-11-05 13:11:41 -0500579 if (tty->ldisc->ops->num != old_ldisc->ops->num && tty->ops->set_ldisc) {
580 down_read(&tty->termios_rwsem);
Alan Cox01e1abb2008-07-22 11:16:55 +0100581 tty->ops->set_ldisc(tty);
Peter Hurley9191aaa2014-11-05 13:11:41 -0500582 up_read(&tty->termios_rwsem);
583 }
Alan Cox01e1abb2008-07-22 11:16:55 +0100584
Peter Hurleyb0e95852013-06-15 07:04:51 -0400585 /* At this point we hold a reference to the new ldisc and a
586 reference to the old ldisc, or we hold two references to
587 the old ldisc (if it was restored as part of error cleanup
588 above). In either case, releasing a single reference from
589 the old ldisc is correct. */
Peter Hurley63d8cb32015-11-08 09:29:38 -0500590 new_ldisc = old_ldisc;
591out:
Peter Hurley276a6612014-11-05 12:13:08 -0500592 tty_ldisc_unlock(tty);
Alan Cox01e1abb2008-07-22 11:16:55 +0100593
Alan Coxc65c9bc2009-06-11 12:50:12 +0100594 /* Restart the work queue in case no characters kick it off. Safe if
Alan Cox01e1abb2008-07-22 11:16:55 +0100595 already running */
Peter Hurley17a69212015-11-08 07:53:06 -0500596 tty_buffer_restart_work(tty->port);
Peter Hurley63d8cb32015-11-08 09:29:38 -0500597err:
598 tty_ldisc_put(new_ldisc); /* drop the extra reference */
Alan Cox89c8d912012-08-08 16:30:13 +0100599 tty_unlock(tty);
Alan Cox01e1abb2008-07-22 11:16:55 +0100600 return retval;
601}
602
Alan Coxc65c9bc2009-06-11 12:50:12 +0100603/**
Peter Hurley6ffeb4b2016-01-10 22:41:03 -0800604 * tty_ldisc_kill - teardown ldisc
605 * @tty: tty being released
606 *
607 * Perform final close of the ldisc and reset tty->ldisc
608 */
609static void tty_ldisc_kill(struct tty_struct *tty)
610{
611 if (!tty->ldisc)
612 return;
613 /*
614 * Now kill off the ldisc
615 */
616 tty_ldisc_close(tty, tty->ldisc);
617 tty_ldisc_put(tty->ldisc);
618 /* Force an oops if we mess this up */
619 tty->ldisc = NULL;
620}
621
622/**
Alan Coxc65c9bc2009-06-11 12:50:12 +0100623 * tty_reset_termios - reset terminal state
624 * @tty: tty to reset
625 *
626 * Restore a terminal to the driver default state.
627 */
628
629static void tty_reset_termios(struct tty_struct *tty)
630{
Peter Hurley6a1c0682013-06-15 09:14:23 -0400631 down_write(&tty->termios_rwsem);
Alan Coxadc8d742012-07-14 15:31:47 +0100632 tty->termios = tty->driver->init_termios;
633 tty->termios.c_ispeed = tty_termios_input_baud_rate(&tty->termios);
634 tty->termios.c_ospeed = tty_termios_baud_rate(&tty->termios);
Peter Hurley6a1c0682013-06-15 09:14:23 -0400635 up_write(&tty->termios_rwsem);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100636}
637
638
639/**
640 * tty_ldisc_reinit - reinitialise the tty ldisc
641 * @tty: tty to reinit
Peter Hurleyc12da962016-01-10 22:41:04 -0800642 * @disc: line discipline to reinitialize
Alan Coxc65c9bc2009-06-11 12:50:12 +0100643 *
Peter Hurley7896f302016-01-10 22:41:05 -0800644 * Completely reinitialize the line discipline state, by closing the
645 * current instance and opening a new instance. If an error occurs opening
646 * the new non-N_TTY instance, the instance is dropped and tty->ldisc reset
647 * to NULL. The caller can then retry with N_TTY instead.
648 *
649 * Returns 0 if successful, otherwise error code < 0
Alan Coxc65c9bc2009-06-11 12:50:12 +0100650 */
651
Peter Hurleyc12da962016-01-10 22:41:04 -0800652static int tty_ldisc_reinit(struct tty_struct *tty, int disc)
Alan Coxc65c9bc2009-06-11 12:50:12 +0100653{
Peter Hurley7896f302016-01-10 22:41:05 -0800654 struct tty_ldisc *ld;
655 int retval;
Philippe Rétornaz1c95ba12010-10-27 17:13:21 +0200656
Peter Hurley7896f302016-01-10 22:41:05 -0800657 ld = tty_ldisc_get(tty, disc);
658 if (IS_ERR(ld)) {
659 BUG_ON(disc == N_TTY);
660 return PTR_ERR(ld);
661 }
Alan Coxc65c9bc2009-06-11 12:50:12 +0100662
Peter Hurley7896f302016-01-10 22:41:05 -0800663 if (tty->ldisc) {
664 tty_ldisc_close(tty, tty->ldisc);
665 tty_ldisc_put(tty->ldisc);
666 }
667
668 /* switch the line discipline */
Peter Hurleyf48070452013-03-11 16:44:42 -0400669 tty->ldisc = ld;
Peter Hurleyc12da962016-01-10 22:41:04 -0800670 tty_set_termios_ldisc(tty, disc);
Peter Hurley7896f302016-01-10 22:41:05 -0800671 retval = tty_ldisc_open(tty, tty->ldisc);
672 if (retval) {
673 if (!WARN_ON(disc == N_TTY)) {
674 tty_ldisc_put(tty->ldisc);
675 tty->ldisc = NULL;
676 }
677 }
678 return retval;
Alan Coxc65c9bc2009-06-11 12:50:12 +0100679}
680
681/**
682 * tty_ldisc_hangup - hangup ldisc reset
683 * @tty: tty being hung up
684 *
685 * Some tty devices reset their termios when they receive a hangup
686 * event. In that situation we must also switch back to N_TTY properly
687 * before we reset the termios data.
688 *
689 * Locking: We can take the ldisc mutex as the rest of the code is
690 * careful to allow for this.
691 *
692 * In the pty pair case this occurs in the close() path of the
693 * tty itself so we must be careful about locking rules.
694 */
695
696void tty_ldisc_hangup(struct tty_struct *tty)
697{
698 struct tty_ldisc *ld;
Alan Cox638b9642010-02-08 10:09:26 +0000699 int reset = tty->driver->flags & TTY_DRIVER_RESET_TERMIOS;
700 int err = 0;
Alan Coxc65c9bc2009-06-11 12:50:12 +0100701
Peter Hurleya570a492016-01-10 22:41:02 -0800702 tty_ldisc_debug(tty, "%p: hangup\n", tty->ldisc);
Peter Hurleyfc575ee2013-03-11 16:44:38 -0400703
Alan Coxc65c9bc2009-06-11 12:50:12 +0100704 ld = tty_ldisc_ref(tty);
705 if (ld != NULL) {
Alan Coxc65c9bc2009-06-11 12:50:12 +0100706 if (ld->ops->flush_buffer)
707 ld->ops->flush_buffer(tty);
708 tty_driver_flush_buffer(tty);
709 if ((test_bit(TTY_DO_WRITE_WAKEUP, &tty->flags)) &&
710 ld->ops->write_wakeup)
711 ld->ops->write_wakeup(tty);
712 if (ld->ops->hangup)
713 ld->ops->hangup(tty);
714 tty_ldisc_deref(ld);
715 }
Peter Hurley36697522013-06-15 07:04:48 -0400716
Alan Coxc65c9bc2009-06-11 12:50:12 +0100717 wake_up_interruptible_poll(&tty->write_wait, POLLOUT);
718 wake_up_interruptible_poll(&tty->read_wait, POLLIN);
Peter Hurley36697522013-06-15 07:04:48 -0400719
Alan Coxc65c9bc2009-06-11 12:50:12 +0100720 /*
721 * Shutdown the current line discipline, and reset it to
Alan Cox638b9642010-02-08 10:09:26 +0000722 * N_TTY if need be.
723 *
724 * Avoid racing set_ldisc or tty_ldisc_release
Alan Coxc65c9bc2009-06-11 12:50:12 +0100725 */
Peter Hurleyfae76e92014-11-05 12:13:07 -0500726 tty_ldisc_lock(tty, MAX_SCHEDULE_TIMEOUT);
Arnd Bergmann60af22d2010-06-01 22:53:06 +0200727
Peter Hurley36697522013-06-15 07:04:48 -0400728 if (tty->ldisc) {
Peter Hurleyc8785242013-03-11 16:44:36 -0400729
730 /* At this point we have a halted ldisc; we want to close it and
731 reopen a new ldisc. We could defer the reopen to the next
732 open but it means auditing a lot of other paths so this is
733 a FIXME */
Peter Hurley7896f302016-01-10 22:41:05 -0800734 if (reset == 0)
735 err = tty_ldisc_reinit(tty, tty->termios.c_line);
Philippe Rétornaz1c95ba12010-10-27 17:13:21 +0200736
Alan Cox638b9642010-02-08 10:09:26 +0000737 /* If the re-open fails or we reset then go to N_TTY. The
738 N_TTY open cannot fail */
Peter Hurley7896f302016-01-10 22:41:05 -0800739 if (reset || err < 0)
740 tty_ldisc_reinit(tty, N_TTY);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100741 }
Peter Hurleyfae76e92014-11-05 12:13:07 -0500742 tty_ldisc_unlock(tty);
Alan Cox638b9642010-02-08 10:09:26 +0000743 if (reset)
744 tty_reset_termios(tty);
Peter Hurleyfc575ee2013-03-11 16:44:38 -0400745
Peter Hurleyfb6edc92015-07-12 22:49:12 -0400746 tty_ldisc_debug(tty, "%p: re-opened\n", tty->ldisc);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100747}
Alan Cox01e1abb2008-07-22 11:16:55 +0100748
749/**
750 * tty_ldisc_setup - open line discipline
751 * @tty: tty being shut down
752 * @o_tty: pair tty for pty/tty pairs
753 *
754 * Called during the initial open of a tty/pty pair in order to set up the
Alan Coxc65c9bc2009-06-11 12:50:12 +0100755 * line disciplines and bind them to the tty. This has no locking issues
756 * as the device isn't yet active.
Alan Cox01e1abb2008-07-22 11:16:55 +0100757 */
758
759int tty_ldisc_setup(struct tty_struct *tty, struct tty_struct *o_tty)
760{
Alan Coxc65c9bc2009-06-11 12:50:12 +0100761 struct tty_ldisc *ld = tty->ldisc;
Alan Cox01e1abb2008-07-22 11:16:55 +0100762 int retval;
763
Alan Coxc65c9bc2009-06-11 12:50:12 +0100764 retval = tty_ldisc_open(tty, ld);
765 if (retval)
766 return retval;
767
768 if (o_tty) {
769 retval = tty_ldisc_open(o_tty, o_tty->ldisc);
Alan Cox01e1abb2008-07-22 11:16:55 +0100770 if (retval) {
Alan Coxc65c9bc2009-06-11 12:50:12 +0100771 tty_ldisc_close(tty, ld);
Alan Cox01e1abb2008-07-22 11:16:55 +0100772 return retval;
773 }
Alan Cox01e1abb2008-07-22 11:16:55 +0100774 }
Alan Cox01e1abb2008-07-22 11:16:55 +0100775 return 0;
776}
Alan Cox89c8d912012-08-08 16:30:13 +0100777
Alan Cox01e1abb2008-07-22 11:16:55 +0100778/**
779 * tty_ldisc_release - release line discipline
Peter Hurley62462ae2014-11-05 12:12:58 -0500780 * @tty: tty being shut down (or one end of pty pair)
Alan Cox01e1abb2008-07-22 11:16:55 +0100781 *
Peter Hurley62462ae2014-11-05 12:12:58 -0500782 * Called during the final close of a tty or a pty pair in order to shut
Peter Hurley5b6e6832016-01-10 22:41:00 -0800783 * down the line discpline layer. On exit, each tty's ldisc is NULL.
Alan Cox01e1abb2008-07-22 11:16:55 +0100784 */
785
Peter Hurley62462ae2014-11-05 12:12:58 -0500786void tty_ldisc_release(struct tty_struct *tty)
Alan Cox01e1abb2008-07-22 11:16:55 +0100787{
Peter Hurley62462ae2014-11-05 12:12:58 -0500788 struct tty_struct *o_tty = tty->link;
789
Alan Cox01e1abb2008-07-22 11:16:55 +0100790 /*
Peter Hurleya2965b72013-03-11 16:44:35 -0400791 * Shutdown this line discipline. As this is the final close,
792 * it does not race with the set_ldisc code path.
Alan Cox01e1abb2008-07-22 11:16:55 +0100793 */
Alan Cox01e1abb2008-07-22 11:16:55 +0100794
Peter Hurley36697522013-06-15 07:04:48 -0400795 tty_ldisc_lock_pair(tty, o_tty);
Alan Cox89c8d912012-08-08 16:30:13 +0100796 tty_ldisc_kill(tty);
Alan Cox89c8d912012-08-08 16:30:13 +0100797 if (o_tty)
798 tty_ldisc_kill(o_tty);
Peter Hurley36697522013-06-15 07:04:48 -0400799 tty_ldisc_unlock_pair(tty, o_tty);
800
Alan Coxaef29bc2009-06-29 15:21:47 +0100801 /* And the memory resources remaining (buffers, termios) will be
802 disposed of when the kref hits zero */
Peter Hurleyfc575ee2013-03-11 16:44:38 -0400803
Peter Hurleyfb6edc92015-07-12 22:49:12 -0400804 tty_ldisc_debug(tty, "released\n");
Alan Cox01e1abb2008-07-22 11:16:55 +0100805}
806
807/**
808 * tty_ldisc_init - ldisc setup for new tty
809 * @tty: tty being allocated
810 *
811 * Set up the line discipline objects for a newly allocated tty. Note that
812 * the tty structure is not completely set up when this call is made.
813 */
814
815void tty_ldisc_init(struct tty_struct *tty)
816{
Peter Hurley36697522013-06-15 07:04:48 -0400817 struct tty_ldisc *ld = tty_ldisc_get(tty, N_TTY);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100818 if (IS_ERR(ld))
Alan Cox01e1abb2008-07-22 11:16:55 +0100819 panic("n_tty: init_tty");
Peter Hurleyf48070452013-03-11 16:44:42 -0400820 tty->ldisc = ld;
Alan Cox01e1abb2008-07-22 11:16:55 +0100821}
822
Jiri Slaby67166712011-03-23 10:48:35 +0100823/**
Peter Hurleyc8b710b2016-01-09 21:13:46 -0800824 * tty_ldisc_deinit - ldisc cleanup for new tty
Jiri Slaby67166712011-03-23 10:48:35 +0100825 * @tty: tty that was allocated recently
826 *
827 * The tty structure must not becompletely set up (tty_ldisc_setup) when
828 * this call is made.
829 */
830void tty_ldisc_deinit(struct tty_struct *tty)
831{
Peter Hurleyc8b710b2016-01-09 21:13:46 -0800832 if (tty->ldisc)
833 tty_ldisc_put(tty->ldisc);
Peter Hurleyf48070452013-03-11 16:44:42 -0400834 tty->ldisc = NULL;
Jiri Slaby67166712011-03-23 10:48:35 +0100835}
836
Alan Cox01e1abb2008-07-22 11:16:55 +0100837void tty_ldisc_begin(void)
838{
839 /* Setup the default TTY line discipline. */
840 (void) tty_register_ldisc(N_TTY, &tty_ldisc_N_TTY);
841}