blob: a054d03c22e7b7376824927ce577d46644b01f16 [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
143 * module locking counts. Returns NULL if the discipline is not available.
144 * Returns a pointer to the discipline and bumps the ref count if it is
145 * available
146 *
147 * Locking:
Peter Hurley137084b2013-06-15 07:04:46 -0400148 * takes tty_ldiscs_lock to guard against ldisc races
Alan Cox01e1abb2008-07-22 11:16:55 +0100149 */
150
Peter Hurley36697522013-06-15 07:04:48 -0400151static struct tty_ldisc *tty_ldisc_get(struct tty_struct *tty, int disc)
Alan Cox01e1abb2008-07-22 11:16:55 +0100152{
Alan Coxc65c9bc2009-06-11 12:50:12 +0100153 struct tty_ldisc *ld;
Linus Torvalds182274f2009-08-03 16:01:28 -0700154 struct tty_ldisc_ops *ldops;
Alan Cox01e1abb2008-07-22 11:16:55 +0100155
156 if (disc < N_TTY || disc >= NR_LDISCS)
Alan Coxc65c9bc2009-06-11 12:50:12 +0100157 return ERR_PTR(-EINVAL);
Linus Torvalds182274f2009-08-03 16:01:28 -0700158
159 /*
160 * Get the ldisc ops - we may need to request them to be loaded
161 * dynamically and try again.
162 */
163 ldops = get_ldops(disc);
164 if (IS_ERR(ldops)) {
Alan Cox01e1abb2008-07-22 11:16:55 +0100165 request_module("tty-ldisc-%d", disc);
Linus Torvalds182274f2009-08-03 16:01:28 -0700166 ldops = get_ldops(disc);
167 if (IS_ERR(ldops))
168 return ERR_CAST(ldops);
Alan Cox01e1abb2008-07-22 11:16:55 +0100169 }
Linus Torvalds182274f2009-08-03 16:01:28 -0700170
171 ld = kmalloc(sizeof(struct tty_ldisc), GFP_KERNEL);
172 if (ld == NULL) {
173 put_ldops(ldops);
174 return ERR_PTR(-ENOMEM);
175 }
176
177 ld->ops = ldops;
Peter Hurley36697522013-06-15 07:04:48 -0400178 ld->tty = tty;
Ivo Sieben1541f842012-05-03 14:37:43 +0200179
Alan Coxc65c9bc2009-06-11 12:50:12 +0100180 return ld;
Alan Cox01e1abb2008-07-22 11:16:55 +0100181}
182
Peter Hurley734de242013-03-11 16:44:43 -0400183/**
184 * tty_ldisc_put - release the ldisc
185 *
186 * Complement of tty_ldisc_get().
187 */
Denys Vlasenkocb128f62015-10-27 17:40:02 +0100188static void tty_ldisc_put(struct tty_ldisc *ld)
Peter Hurley734de242013-03-11 16:44:43 -0400189{
Peter Hurley734de242013-03-11 16:44:43 -0400190 if (WARN_ON_ONCE(!ld))
191 return;
192
Peter Hurley36697522013-06-15 07:04:48 -0400193 put_ldops(ld->ops);
Peter Hurley734de242013-03-11 16:44:43 -0400194 kfree(ld);
Peter Hurley734de242013-03-11 16:44:43 -0400195}
196
Alan Cox852e99d2009-06-11 12:51:41 +0100197static void *tty_ldiscs_seq_start(struct seq_file *m, loff_t *pos)
Alan Cox01e1abb2008-07-22 11:16:55 +0100198{
199 return (*pos < NR_LDISCS) ? pos : NULL;
200}
201
Alan Cox852e99d2009-06-11 12:51:41 +0100202static void *tty_ldiscs_seq_next(struct seq_file *m, void *v, loff_t *pos)
Alan Cox01e1abb2008-07-22 11:16:55 +0100203{
204 (*pos)++;
205 return (*pos < NR_LDISCS) ? pos : NULL;
206}
207
208static void tty_ldiscs_seq_stop(struct seq_file *m, void *v)
209{
210}
211
212static int tty_ldiscs_seq_show(struct seq_file *m, void *v)
213{
214 int i = *(loff_t *)v;
Linus Torvaldsf0de0e82009-08-03 16:00:15 -0700215 struct tty_ldisc_ops *ldops;
Alan Cox852e99d2009-06-11 12:51:41 +0100216
Linus Torvaldsf0de0e82009-08-03 16:00:15 -0700217 ldops = get_ldops(i);
218 if (IS_ERR(ldops))
Alan Cox01e1abb2008-07-22 11:16:55 +0100219 return 0;
Linus Torvaldsf0de0e82009-08-03 16:00:15 -0700220 seq_printf(m, "%-10s %2d\n", ldops->name ? ldops->name : "???", i);
221 put_ldops(ldops);
Alan Cox01e1abb2008-07-22 11:16:55 +0100222 return 0;
223}
224
225static const struct seq_operations tty_ldiscs_seq_ops = {
226 .start = tty_ldiscs_seq_start,
227 .next = tty_ldiscs_seq_next,
228 .stop = tty_ldiscs_seq_stop,
229 .show = tty_ldiscs_seq_show,
230};
231
232static int proc_tty_ldiscs_open(struct inode *inode, struct file *file)
233{
234 return seq_open(file, &tty_ldiscs_seq_ops);
235}
236
237const struct file_operations tty_ldiscs_proc_fops = {
238 .owner = THIS_MODULE,
239 .open = proc_tty_ldiscs_open,
240 .read = seq_read,
241 .llseek = seq_lseek,
242 .release = seq_release,
243};
244
245/**
Alan Cox01e1abb2008-07-22 11:16:55 +0100246 * tty_ldisc_ref_wait - wait for the tty ldisc
247 * @tty: tty device
248 *
249 * Dereference the line discipline for the terminal and take a
250 * reference to it. If the line discipline is in flux then
251 * wait patiently until it changes.
252 *
253 * Note: Must not be called from an IRQ/timer context. The caller
254 * must also be careful not to hold other locks that will deadlock
255 * against a discipline change, such as an existing ldisc reference
256 * (which we check for)
257 *
Peter Hurley36697522013-06-15 07:04:48 -0400258 * Note: only callable from a file_operations routine (which
259 * guarantees tty->ldisc != NULL when the lock is acquired).
Alan Cox01e1abb2008-07-22 11:16:55 +0100260 */
261
262struct tty_ldisc *tty_ldisc_ref_wait(struct tty_struct *tty)
263{
Peter Hurley36697522013-06-15 07:04:48 -0400264 ldsem_down_read(&tty->ldisc_sem, MAX_SCHEDULE_TIMEOUT);
265 WARN_ON(!tty->ldisc);
266 return tty->ldisc;
Alan Cox01e1abb2008-07-22 11:16:55 +0100267}
Alan Cox01e1abb2008-07-22 11:16:55 +0100268EXPORT_SYMBOL_GPL(tty_ldisc_ref_wait);
269
270/**
271 * tty_ldisc_ref - get the tty ldisc
272 * @tty: tty device
273 *
274 * Dereference the line discipline for the terminal and take a
275 * reference to it. If the line discipline is in flux then
276 * return NULL. Can be called from IRQ and timer functions.
Alan Cox01e1abb2008-07-22 11:16:55 +0100277 */
278
279struct tty_ldisc *tty_ldisc_ref(struct tty_struct *tty)
280{
Peter Hurley36697522013-06-15 07:04:48 -0400281 struct tty_ldisc *ld = NULL;
282
283 if (ldsem_down_read_trylock(&tty->ldisc_sem)) {
284 ld = tty->ldisc;
285 if (!ld)
286 ldsem_up_read(&tty->ldisc_sem);
287 }
288 return ld;
Alan Cox01e1abb2008-07-22 11:16:55 +0100289}
Alan Cox01e1abb2008-07-22 11:16:55 +0100290EXPORT_SYMBOL_GPL(tty_ldisc_ref);
291
292/**
293 * tty_ldisc_deref - free a tty ldisc reference
294 * @ld: reference to free up
295 *
296 * Undoes the effect of tty_ldisc_ref or tty_ldisc_ref_wait. May
297 * be called in IRQ context.
Alan Cox01e1abb2008-07-22 11:16:55 +0100298 */
299
300void tty_ldisc_deref(struct tty_ldisc *ld)
301{
Peter Hurley36697522013-06-15 07:04:48 -0400302 ldsem_up_read(&ld->tty->ldisc_sem);
Alan Cox01e1abb2008-07-22 11:16:55 +0100303}
Alan Cox01e1abb2008-07-22 11:16:55 +0100304EXPORT_SYMBOL_GPL(tty_ldisc_deref);
305
Peter Hurleyd2c43892013-06-15 07:04:47 -0400306
307static inline int __lockfunc
Peter Hurleye80a10e2014-11-05 12:13:06 -0500308__tty_ldisc_lock(struct tty_struct *tty, unsigned long timeout)
Peter Hurleyd2c43892013-06-15 07:04:47 -0400309{
310 return ldsem_down_write(&tty->ldisc_sem, timeout);
311}
312
313static inline int __lockfunc
Peter Hurleye80a10e2014-11-05 12:13:06 -0500314__tty_ldisc_lock_nested(struct tty_struct *tty, unsigned long timeout)
Peter Hurleyd2c43892013-06-15 07:04:47 -0400315{
316 return ldsem_down_write_nested(&tty->ldisc_sem,
317 LDISC_SEM_OTHER, timeout);
318}
319
Peter Hurleye80a10e2014-11-05 12:13:06 -0500320static inline void __tty_ldisc_unlock(struct tty_struct *tty)
Peter Hurleyd2c43892013-06-15 07:04:47 -0400321{
Guillaume Gomez52772ea2015-10-04 21:19:18 +0200322 ldsem_up_write(&tty->ldisc_sem);
Peter Hurleyd2c43892013-06-15 07:04:47 -0400323}
324
325static int __lockfunc
Peter Hurleyfae76e92014-11-05 12:13:07 -0500326tty_ldisc_lock(struct tty_struct *tty, unsigned long timeout)
327{
328 int ret;
329
330 ret = __tty_ldisc_lock(tty, timeout);
331 if (!ret)
332 return -EBUSY;
333 set_bit(TTY_LDISC_HALTED, &tty->flags);
334 return 0;
335}
336
337static void tty_ldisc_unlock(struct tty_struct *tty)
338{
339 clear_bit(TTY_LDISC_HALTED, &tty->flags);
340 __tty_ldisc_unlock(tty);
341}
342
343static int __lockfunc
Peter Hurleyd2c43892013-06-15 07:04:47 -0400344tty_ldisc_lock_pair_timeout(struct tty_struct *tty, struct tty_struct *tty2,
345 unsigned long timeout)
346{
347 int ret;
348
349 if (tty < tty2) {
Peter Hurleye80a10e2014-11-05 12:13:06 -0500350 ret = __tty_ldisc_lock(tty, timeout);
Peter Hurleyd2c43892013-06-15 07:04:47 -0400351 if (ret) {
Peter Hurleye80a10e2014-11-05 12:13:06 -0500352 ret = __tty_ldisc_lock_nested(tty2, timeout);
Peter Hurleyd2c43892013-06-15 07:04:47 -0400353 if (!ret)
Peter Hurleye80a10e2014-11-05 12:13:06 -0500354 __tty_ldisc_unlock(tty);
Peter Hurleyd2c43892013-06-15 07:04:47 -0400355 }
356 } else {
357 /* if this is possible, it has lots of implications */
358 WARN_ON_ONCE(tty == tty2);
359 if (tty2 && tty != tty2) {
Peter Hurleye80a10e2014-11-05 12:13:06 -0500360 ret = __tty_ldisc_lock(tty2, timeout);
Peter Hurleyd2c43892013-06-15 07:04:47 -0400361 if (ret) {
Peter Hurleye80a10e2014-11-05 12:13:06 -0500362 ret = __tty_ldisc_lock_nested(tty, timeout);
Peter Hurleyd2c43892013-06-15 07:04:47 -0400363 if (!ret)
Peter Hurleye80a10e2014-11-05 12:13:06 -0500364 __tty_ldisc_unlock(tty2);
Peter Hurleyd2c43892013-06-15 07:04:47 -0400365 }
366 } else
Peter Hurleye80a10e2014-11-05 12:13:06 -0500367 ret = __tty_ldisc_lock(tty, timeout);
Peter Hurleyd2c43892013-06-15 07:04:47 -0400368 }
369
370 if (!ret)
371 return -EBUSY;
372
373 set_bit(TTY_LDISC_HALTED, &tty->flags);
374 if (tty2)
375 set_bit(TTY_LDISC_HALTED, &tty2->flags);
376 return 0;
377}
378
379static void __lockfunc
380tty_ldisc_lock_pair(struct tty_struct *tty, struct tty_struct *tty2)
381{
382 tty_ldisc_lock_pair_timeout(tty, tty2, MAX_SCHEDULE_TIMEOUT);
383}
384
385static void __lockfunc tty_ldisc_unlock_pair(struct tty_struct *tty,
386 struct tty_struct *tty2)
387{
Peter Hurleye80a10e2014-11-05 12:13:06 -0500388 __tty_ldisc_unlock(tty);
Peter Hurleyd2c43892013-06-15 07:04:47 -0400389 if (tty2)
Peter Hurleye80a10e2014-11-05 12:13:06 -0500390 __tty_ldisc_unlock(tty2);
Peter Hurleyd2c43892013-06-15 07:04:47 -0400391}
392
Alan Cox01e1abb2008-07-22 11:16:55 +0100393/**
Alan Coxf2c4c652009-06-11 12:50:58 +0100394 * tty_ldisc_flush - flush line discipline queue
395 * @tty: tty
396 *
Peter Hurley86c80a82014-11-05 12:13:09 -0500397 * Flush the line discipline queue (if any) and the tty flip buffers
398 * for this tty.
Alan Coxf2c4c652009-06-11 12:50:58 +0100399 */
400
401void tty_ldisc_flush(struct tty_struct *tty)
402{
403 struct tty_ldisc *ld = tty_ldisc_ref(tty);
Peter Hurley86c80a82014-11-05 12:13:09 -0500404
405 tty_buffer_flush(tty, ld);
406 if (ld)
Alan Coxf2c4c652009-06-11 12:50:58 +0100407 tty_ldisc_deref(ld);
Alan Coxf2c4c652009-06-11 12:50:58 +0100408}
Alan Coxf2c4c652009-06-11 12:50:58 +0100409EXPORT_SYMBOL_GPL(tty_ldisc_flush);
410
411/**
Alan Cox01e1abb2008-07-22 11:16:55 +0100412 * tty_set_termios_ldisc - set ldisc field
413 * @tty: tty structure
414 * @num: line discipline number
415 *
416 * This is probably overkill for real world processors but
417 * they are not on hot paths so a little discipline won't do
418 * any harm.
419 *
Peter Hurleydd42bf12015-11-27 14:30:21 -0500420 * The line discipline-related tty_struct fields are reset to
421 * prevent the ldisc driver from re-using stale information for
422 * the new ldisc instance.
423 *
Peter Hurley6a1c0682013-06-15 09:14:23 -0400424 * Locking: takes termios_rwsem
Alan Cox01e1abb2008-07-22 11:16:55 +0100425 */
426
427static void tty_set_termios_ldisc(struct tty_struct *tty, int num)
428{
Peter Hurley6a1c0682013-06-15 09:14:23 -0400429 down_write(&tty->termios_rwsem);
Alan Coxadc8d742012-07-14 15:31:47 +0100430 tty->termios.c_line = num;
Peter Hurley6a1c0682013-06-15 09:14:23 -0400431 up_write(&tty->termios_rwsem);
Peter Hurleydd42bf12015-11-27 14:30:21 -0500432
433 tty->disc_data = NULL;
434 tty->receive_room = 0;
Alan Cox01e1abb2008-07-22 11:16:55 +0100435}
436
Alan Coxc65c9bc2009-06-11 12:50:12 +0100437/**
438 * tty_ldisc_open - open a line discipline
439 * @tty: tty we are opening the ldisc on
440 * @ld: discipline to open
441 *
442 * A helper opening method. Also a convenient debugging and check
443 * point.
Arnd Bergmannec79d602010-06-01 22:53:01 +0200444 *
445 * Locking: always called with BTM already held.
Alan Coxc65c9bc2009-06-11 12:50:12 +0100446 */
447
448static int tty_ldisc_open(struct tty_struct *tty, struct tty_ldisc *ld)
449{
450 WARN_ON(test_and_set_bit(TTY_LDISC_OPEN, &tty->flags));
Alan Coxf18f9492009-11-30 13:18:35 +0000451 if (ld->ops->open) {
452 int ret;
Arnd Bergmannec79d602010-06-01 22:53:01 +0200453 /* BTM here locks versus a hangup event */
Alan Coxf18f9492009-11-30 13:18:35 +0000454 ret = ld->ops->open(tty);
Jiri Slaby7f90cfc2010-11-25 00:27:54 +0100455 if (ret)
456 clear_bit(TTY_LDISC_OPEN, &tty->flags);
Peter Hurleyfb6edc92015-07-12 22:49:12 -0400457
458 tty_ldisc_debug(tty, "%p: opened\n", tty->ldisc);
Alan Coxf18f9492009-11-30 13:18:35 +0000459 return ret;
460 }
Alan Coxc65c9bc2009-06-11 12:50:12 +0100461 return 0;
462}
463
464/**
465 * tty_ldisc_close - close a line discipline
466 * @tty: tty we are opening the ldisc on
467 * @ld: discipline to close
468 *
469 * A helper close method. Also a convenient debugging and check
470 * point.
471 */
472
473static void tty_ldisc_close(struct tty_struct *tty, struct tty_ldisc *ld)
474{
475 WARN_ON(!test_bit(TTY_LDISC_OPEN, &tty->flags));
476 clear_bit(TTY_LDISC_OPEN, &tty->flags);
477 if (ld->ops->close)
478 ld->ops->close(tty);
Peter Hurleyfb6edc92015-07-12 22:49:12 -0400479 tty_ldisc_debug(tty, "%p: closed\n", tty->ldisc);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100480}
Alan Cox01e1abb2008-07-22 11:16:55 +0100481
482/**
483 * tty_ldisc_restore - helper for tty ldisc change
484 * @tty: tty to recover
485 * @old: previous ldisc
486 *
487 * Restore the previous line discipline or N_TTY when a line discipline
488 * change fails due to an open error
489 */
490
491static void tty_ldisc_restore(struct tty_struct *tty, struct tty_ldisc *old)
492{
Alan Coxc65c9bc2009-06-11 12:50:12 +0100493 struct tty_ldisc *new_ldisc;
494 int r;
Alan Cox01e1abb2008-07-22 11:16:55 +0100495
496 /* There is an outstanding reference here so this is safe */
Peter Hurley36697522013-06-15 07:04:48 -0400497 old = tty_ldisc_get(tty, old->ops->num);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100498 WARN_ON(IS_ERR(old));
Peter Hurleyf48070452013-03-11 16:44:42 -0400499 tty->ldisc = old;
Alan Cox01e1abb2008-07-22 11:16:55 +0100500 tty_set_termios_ldisc(tty, old->ops->num);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100501 if (tty_ldisc_open(tty, old) < 0) {
502 tty_ldisc_put(old);
Alan Cox01e1abb2008-07-22 11:16:55 +0100503 /* This driver is always present */
Peter Hurley36697522013-06-15 07:04:48 -0400504 new_ldisc = tty_ldisc_get(tty, N_TTY);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100505 if (IS_ERR(new_ldisc))
Alan Cox01e1abb2008-07-22 11:16:55 +0100506 panic("n_tty: get");
Peter Hurleyf48070452013-03-11 16:44:42 -0400507 tty->ldisc = new_ldisc;
Alan Cox01e1abb2008-07-22 11:16:55 +0100508 tty_set_termios_ldisc(tty, N_TTY);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100509 r = tty_ldisc_open(tty, new_ldisc);
510 if (r < 0)
511 panic("Couldn't open N_TTY ldisc for "
512 "%s --- error %d.",
Rasmus Villemoes429b4742015-03-31 15:55:59 +0200513 tty_name(tty), r);
Alan Cox01e1abb2008-07-22 11:16:55 +0100514 }
515}
516
517/**
518 * tty_set_ldisc - set line discipline
519 * @tty: the terminal to set
520 * @ldisc: the line discipline
521 *
522 * Set the discipline of a tty line. Must be called from a process
Alan Coxc65c9bc2009-06-11 12:50:12 +0100523 * context. The ldisc change logic has to protect itself against any
524 * overlapping ldisc change (including on the other end of pty pairs),
525 * the close of one side of a tty/pty pair, and eventually hangup.
Alan Cox01e1abb2008-07-22 11:16:55 +0100526 */
527
528int tty_set_ldisc(struct tty_struct *tty, int ldisc)
529{
530 int retval;
Peter Hurley9fbfa342013-06-15 07:04:49 -0400531 struct tty_ldisc *old_ldisc, *new_ldisc;
Alan Cox01e1abb2008-07-22 11:16:55 +0100532
Peter Hurley36697522013-06-15 07:04:48 -0400533 new_ldisc = tty_ldisc_get(tty, ldisc);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100534 if (IS_ERR(new_ldisc))
535 return PTR_ERR(new_ldisc);
536
Peter Hurleyc8483bc2014-11-05 12:12:45 -0500537 tty_lock(tty);
Peter Hurley276a6612014-11-05 12:13:08 -0500538 retval = tty_ldisc_lock(tty, 5 * HZ);
Peter Hurley63d8cb32015-11-08 09:29:38 -0500539 if (retval)
540 goto err;
Alan Coxc65c9bc2009-06-11 12:50:12 +0100541
Peter Hurley63d8cb32015-11-08 09:29:38 -0500542 /* Check the no-op case */
543 if (tty->ldisc->ops->num == ldisc)
544 goto out;
Alan Coxc65c9bc2009-06-11 12:50:12 +0100545
Peter Hurley63d8cb32015-11-08 09:29:38 -0500546 if (test_bit(TTY_HUPPED, &tty->flags)) {
547 /* We were raced by hangup */
548 retval = -EIO;
549 goto out;
Alan Coxc65c9bc2009-06-11 12:50:12 +0100550 }
Alan Cox01e1abb2008-07-22 11:16:55 +0100551
Peter Hurley9fbfa342013-06-15 07:04:49 -0400552 old_ldisc = tty->ldisc;
Jiri Slaby100eeae2010-10-31 23:17:51 +0100553
Peter Hurley9fbfa342013-06-15 07:04:49 -0400554 /* Shutdown the old discipline. */
555 tty_ldisc_close(tty, old_ldisc);
Alan Cox01e1abb2008-07-22 11:16:55 +0100556
557 /* Now set up the new line discipline. */
Peter Hurleyf48070452013-03-11 16:44:42 -0400558 tty->ldisc = new_ldisc;
Alan Cox01e1abb2008-07-22 11:16:55 +0100559 tty_set_termios_ldisc(tty, ldisc);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100560
561 retval = tty_ldisc_open(tty, new_ldisc);
Alan Cox01e1abb2008-07-22 11:16:55 +0100562 if (retval < 0) {
Alan Coxc65c9bc2009-06-11 12:50:12 +0100563 /* Back to the old one or N_TTY if we can't */
564 tty_ldisc_put(new_ldisc);
Peter Hurley9fbfa342013-06-15 07:04:49 -0400565 tty_ldisc_restore(tty, old_ldisc);
Alan Cox01e1abb2008-07-22 11:16:55 +0100566 }
Alan Coxc65c9bc2009-06-11 12:50:12 +0100567
Peter Hurley9191aaa2014-11-05 13:11:41 -0500568 if (tty->ldisc->ops->num != old_ldisc->ops->num && tty->ops->set_ldisc) {
569 down_read(&tty->termios_rwsem);
Alan Cox01e1abb2008-07-22 11:16:55 +0100570 tty->ops->set_ldisc(tty);
Peter Hurley9191aaa2014-11-05 13:11:41 -0500571 up_read(&tty->termios_rwsem);
572 }
Alan Cox01e1abb2008-07-22 11:16:55 +0100573
Peter Hurleyb0e95852013-06-15 07:04:51 -0400574 /* At this point we hold a reference to the new ldisc and a
575 reference to the old ldisc, or we hold two references to
576 the old ldisc (if it was restored as part of error cleanup
577 above). In either case, releasing a single reference from
578 the old ldisc is correct. */
Peter Hurley63d8cb32015-11-08 09:29:38 -0500579 new_ldisc = old_ldisc;
580out:
Peter Hurley276a6612014-11-05 12:13:08 -0500581 tty_ldisc_unlock(tty);
Alan Cox01e1abb2008-07-22 11:16:55 +0100582
Alan Coxc65c9bc2009-06-11 12:50:12 +0100583 /* Restart the work queue in case no characters kick it off. Safe if
Alan Cox01e1abb2008-07-22 11:16:55 +0100584 already running */
Peter Hurley17a69212015-11-08 07:53:06 -0500585 tty_buffer_restart_work(tty->port);
Peter Hurley63d8cb32015-11-08 09:29:38 -0500586err:
587 tty_ldisc_put(new_ldisc); /* drop the extra reference */
Alan Cox89c8d912012-08-08 16:30:13 +0100588 tty_unlock(tty);
Alan Cox01e1abb2008-07-22 11:16:55 +0100589 return retval;
590}
591
Alan Coxc65c9bc2009-06-11 12:50:12 +0100592/**
593 * tty_reset_termios - reset terminal state
594 * @tty: tty to reset
595 *
596 * Restore a terminal to the driver default state.
597 */
598
599static void tty_reset_termios(struct tty_struct *tty)
600{
Peter Hurley6a1c0682013-06-15 09:14:23 -0400601 down_write(&tty->termios_rwsem);
Alan Coxadc8d742012-07-14 15:31:47 +0100602 tty->termios = tty->driver->init_termios;
603 tty->termios.c_ispeed = tty_termios_input_baud_rate(&tty->termios);
604 tty->termios.c_ospeed = tty_termios_baud_rate(&tty->termios);
Peter Hurley6a1c0682013-06-15 09:14:23 -0400605 up_write(&tty->termios_rwsem);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100606}
607
608
609/**
610 * tty_ldisc_reinit - reinitialise the tty ldisc
611 * @tty: tty to reinit
Alan Cox638b9642010-02-08 10:09:26 +0000612 * @ldisc: line discipline to reinitialize
Alan Coxc65c9bc2009-06-11 12:50:12 +0100613 *
Alan Cox638b9642010-02-08 10:09:26 +0000614 * Switch the tty to a line discipline and leave the ldisc
615 * state closed
Alan Coxc65c9bc2009-06-11 12:50:12 +0100616 */
617
Philippe Rétornaz1c95ba12010-10-27 17:13:21 +0200618static int tty_ldisc_reinit(struct tty_struct *tty, int ldisc)
Alan Coxc65c9bc2009-06-11 12:50:12 +0100619{
Peter Hurley36697522013-06-15 07:04:48 -0400620 struct tty_ldisc *ld = tty_ldisc_get(tty, ldisc);
Philippe Rétornaz1c95ba12010-10-27 17:13:21 +0200621
622 if (IS_ERR(ld))
623 return -1;
Alan Coxc65c9bc2009-06-11 12:50:12 +0100624
625 tty_ldisc_close(tty, tty->ldisc);
626 tty_ldisc_put(tty->ldisc);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100627 /*
628 * Switch the line discipline back
629 */
Peter Hurleyf48070452013-03-11 16:44:42 -0400630 tty->ldisc = ld;
Alan Cox638b9642010-02-08 10:09:26 +0000631 tty_set_termios_ldisc(tty, ldisc);
Philippe Rétornaz1c95ba12010-10-27 17:13:21 +0200632
633 return 0;
Alan Coxc65c9bc2009-06-11 12:50:12 +0100634}
635
636/**
637 * tty_ldisc_hangup - hangup ldisc reset
638 * @tty: tty being hung up
639 *
640 * Some tty devices reset their termios when they receive a hangup
641 * event. In that situation we must also switch back to N_TTY properly
642 * before we reset the termios data.
643 *
644 * Locking: We can take the ldisc mutex as the rest of the code is
645 * careful to allow for this.
646 *
647 * In the pty pair case this occurs in the close() path of the
648 * tty itself so we must be careful about locking rules.
649 */
650
651void tty_ldisc_hangup(struct tty_struct *tty)
652{
653 struct tty_ldisc *ld;
Alan Cox638b9642010-02-08 10:09:26 +0000654 int reset = tty->driver->flags & TTY_DRIVER_RESET_TERMIOS;
655 int err = 0;
Alan Coxc65c9bc2009-06-11 12:50:12 +0100656
Peter Hurleyfb6edc92015-07-12 22:49:12 -0400657 tty_ldisc_debug(tty, "%p: closing\n", tty->ldisc);
Peter Hurleyfc575ee2013-03-11 16:44:38 -0400658
Alan Coxc65c9bc2009-06-11 12:50:12 +0100659 ld = tty_ldisc_ref(tty);
660 if (ld != NULL) {
Alan Coxc65c9bc2009-06-11 12:50:12 +0100661 if (ld->ops->flush_buffer)
662 ld->ops->flush_buffer(tty);
663 tty_driver_flush_buffer(tty);
664 if ((test_bit(TTY_DO_WRITE_WAKEUP, &tty->flags)) &&
665 ld->ops->write_wakeup)
666 ld->ops->write_wakeup(tty);
667 if (ld->ops->hangup)
668 ld->ops->hangup(tty);
669 tty_ldisc_deref(ld);
670 }
Peter Hurley36697522013-06-15 07:04:48 -0400671
Alan Coxc65c9bc2009-06-11 12:50:12 +0100672 wake_up_interruptible_poll(&tty->write_wait, POLLOUT);
673 wake_up_interruptible_poll(&tty->read_wait, POLLIN);
Peter Hurley36697522013-06-15 07:04:48 -0400674
Alan Coxc65c9bc2009-06-11 12:50:12 +0100675 /*
676 * Shutdown the current line discipline, and reset it to
Alan Cox638b9642010-02-08 10:09:26 +0000677 * N_TTY if need be.
678 *
679 * Avoid racing set_ldisc or tty_ldisc_release
Alan Coxc65c9bc2009-06-11 12:50:12 +0100680 */
Peter Hurleyfae76e92014-11-05 12:13:07 -0500681 tty_ldisc_lock(tty, MAX_SCHEDULE_TIMEOUT);
Arnd Bergmann60af22d2010-06-01 22:53:06 +0200682
Peter Hurley36697522013-06-15 07:04:48 -0400683 if (tty->ldisc) {
Peter Hurleyc8785242013-03-11 16:44:36 -0400684
685 /* At this point we have a halted ldisc; we want to close it and
686 reopen a new ldisc. We could defer the reopen to the next
687 open but it means auditing a lot of other paths so this is
688 a FIXME */
Alan Cox638b9642010-02-08 10:09:26 +0000689 if (reset == 0) {
Philippe Rétornaz1c95ba12010-10-27 17:13:21 +0200690
Alan Coxadc8d742012-07-14 15:31:47 +0100691 if (!tty_ldisc_reinit(tty, tty->termios.c_line))
Philippe Rétornaz1c95ba12010-10-27 17:13:21 +0200692 err = tty_ldisc_open(tty, tty->ldisc);
693 else
694 err = 1;
Alan Coxc8d50042009-07-16 16:05:08 +0100695 }
Alan Cox638b9642010-02-08 10:09:26 +0000696 /* If the re-open fails or we reset then go to N_TTY. The
697 N_TTY open cannot fail */
698 if (reset || err) {
Philippe Rétornaz1c95ba12010-10-27 17:13:21 +0200699 BUG_ON(tty_ldisc_reinit(tty, N_TTY));
Alan Cox638b9642010-02-08 10:09:26 +0000700 WARN_ON(tty_ldisc_open(tty, tty->ldisc));
701 }
Alan Coxc65c9bc2009-06-11 12:50:12 +0100702 }
Peter Hurleyfae76e92014-11-05 12:13:07 -0500703 tty_ldisc_unlock(tty);
Alan Cox638b9642010-02-08 10:09:26 +0000704 if (reset)
705 tty_reset_termios(tty);
Peter Hurleyfc575ee2013-03-11 16:44:38 -0400706
Peter Hurleyfb6edc92015-07-12 22:49:12 -0400707 tty_ldisc_debug(tty, "%p: re-opened\n", tty->ldisc);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100708}
Alan Cox01e1abb2008-07-22 11:16:55 +0100709
710/**
711 * tty_ldisc_setup - open line discipline
712 * @tty: tty being shut down
713 * @o_tty: pair tty for pty/tty pairs
714 *
715 * Called during the initial open of a tty/pty pair in order to set up the
Alan Coxc65c9bc2009-06-11 12:50:12 +0100716 * line disciplines and bind them to the tty. This has no locking issues
717 * as the device isn't yet active.
Alan Cox01e1abb2008-07-22 11:16:55 +0100718 */
719
720int tty_ldisc_setup(struct tty_struct *tty, struct tty_struct *o_tty)
721{
Alan Coxc65c9bc2009-06-11 12:50:12 +0100722 struct tty_ldisc *ld = tty->ldisc;
Alan Cox01e1abb2008-07-22 11:16:55 +0100723 int retval;
724
Alan Coxc65c9bc2009-06-11 12:50:12 +0100725 retval = tty_ldisc_open(tty, ld);
726 if (retval)
727 return retval;
728
729 if (o_tty) {
730 retval = tty_ldisc_open(o_tty, o_tty->ldisc);
Alan Cox01e1abb2008-07-22 11:16:55 +0100731 if (retval) {
Alan Coxc65c9bc2009-06-11 12:50:12 +0100732 tty_ldisc_close(tty, ld);
Alan Cox01e1abb2008-07-22 11:16:55 +0100733 return retval;
734 }
Alan Cox01e1abb2008-07-22 11:16:55 +0100735 }
Alan Cox01e1abb2008-07-22 11:16:55 +0100736 return 0;
737}
Alan Cox89c8d912012-08-08 16:30:13 +0100738
739static void tty_ldisc_kill(struct tty_struct *tty)
740{
Alan Cox89c8d912012-08-08 16:30:13 +0100741 /*
742 * Now kill off the ldisc
743 */
744 tty_ldisc_close(tty, tty->ldisc);
745 tty_ldisc_put(tty->ldisc);
746 /* Force an oops if we mess this up */
747 tty->ldisc = NULL;
748
749 /* Ensure the next open requests the N_TTY ldisc */
750 tty_set_termios_ldisc(tty, N_TTY);
Alan Cox89c8d912012-08-08 16:30:13 +0100751}
752
Alan Cox01e1abb2008-07-22 11:16:55 +0100753/**
754 * tty_ldisc_release - release line discipline
Peter Hurley62462ae2014-11-05 12:12:58 -0500755 * @tty: tty being shut down (or one end of pty pair)
Alan Cox01e1abb2008-07-22 11:16:55 +0100756 *
Peter Hurley62462ae2014-11-05 12:12:58 -0500757 * Called during the final close of a tty or a pty pair in order to shut
758 * down the line discpline layer. On exit, each ldisc assigned is N_TTY and
759 * each ldisc has not been opened.
Alan Cox01e1abb2008-07-22 11:16:55 +0100760 */
761
Peter Hurley62462ae2014-11-05 12:12:58 -0500762void tty_ldisc_release(struct tty_struct *tty)
Alan Cox01e1abb2008-07-22 11:16:55 +0100763{
Peter Hurley62462ae2014-11-05 12:12:58 -0500764 struct tty_struct *o_tty = tty->link;
765
Alan Cox01e1abb2008-07-22 11:16:55 +0100766 /*
Peter Hurleya2965b72013-03-11 16:44:35 -0400767 * Shutdown this line discipline. As this is the final close,
768 * it does not race with the set_ldisc code path.
Alan Cox01e1abb2008-07-22 11:16:55 +0100769 */
Alan Cox01e1abb2008-07-22 11:16:55 +0100770
Peter Hurley36697522013-06-15 07:04:48 -0400771 tty_ldisc_lock_pair(tty, o_tty);
Alan Cox89c8d912012-08-08 16:30:13 +0100772 tty_ldisc_kill(tty);
Alan Cox89c8d912012-08-08 16:30:13 +0100773 if (o_tty)
774 tty_ldisc_kill(o_tty);
Peter Hurley36697522013-06-15 07:04:48 -0400775 tty_ldisc_unlock_pair(tty, o_tty);
776
Alan Coxaef29bc2009-06-29 15:21:47 +0100777 /* And the memory resources remaining (buffers, termios) will be
778 disposed of when the kref hits zero */
Peter Hurleyfc575ee2013-03-11 16:44:38 -0400779
Peter Hurleyfb6edc92015-07-12 22:49:12 -0400780 tty_ldisc_debug(tty, "released\n");
Alan Cox01e1abb2008-07-22 11:16:55 +0100781}
782
783/**
784 * tty_ldisc_init - ldisc setup for new tty
785 * @tty: tty being allocated
786 *
787 * Set up the line discipline objects for a newly allocated tty. Note that
788 * the tty structure is not completely set up when this call is made.
789 */
790
791void tty_ldisc_init(struct tty_struct *tty)
792{
Peter Hurley36697522013-06-15 07:04:48 -0400793 struct tty_ldisc *ld = tty_ldisc_get(tty, N_TTY);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100794 if (IS_ERR(ld))
Alan Cox01e1abb2008-07-22 11:16:55 +0100795 panic("n_tty: init_tty");
Peter Hurleyf48070452013-03-11 16:44:42 -0400796 tty->ldisc = ld;
Alan Cox01e1abb2008-07-22 11:16:55 +0100797}
798
Jiri Slaby67166712011-03-23 10:48:35 +0100799/**
800 * tty_ldisc_init - ldisc cleanup for new tty
801 * @tty: tty that was allocated recently
802 *
803 * The tty structure must not becompletely set up (tty_ldisc_setup) when
804 * this call is made.
805 */
806void tty_ldisc_deinit(struct tty_struct *tty)
807{
Peter Hurleyebc9bae2013-03-11 16:44:40 -0400808 tty_ldisc_put(tty->ldisc);
Peter Hurleyf48070452013-03-11 16:44:42 -0400809 tty->ldisc = NULL;
Jiri Slaby67166712011-03-23 10:48:35 +0100810}
811
Alan Cox01e1abb2008-07-22 11:16:55 +0100812void tty_ldisc_begin(void)
813{
814 /* Setup the default TTY line discipline. */
815 (void) tty_register_ldisc(N_TTY, &tty_ldisc_N_TTY);
816}