Greg Kroah-Hartman | e3b3d0f | 2017-11-06 18:11:51 +0100 | [diff] [blame^] | 1 | // SPDX-License-Identifier: GPL-2.0 |
Alan Cox | 01e1abb | 2008-07-22 11:16:55 +0100 | [diff] [blame] | 2 | #include <linux/types.h> |
Alan Cox | 01e1abb | 2008-07-22 11:16:55 +0100 | [diff] [blame] | 3 | #include <linux/errno.h> |
Jiri Slaby | 8b3ffa1 | 2011-11-16 16:27:10 +0100 | [diff] [blame] | 4 | #include <linux/kmod.h> |
Alan Cox | 01e1abb | 2008-07-22 11:16:55 +0100 | [diff] [blame] | 5 | #include <linux/sched.h> |
| 6 | #include <linux/interrupt.h> |
| 7 | #include <linux/tty.h> |
| 8 | #include <linux/tty_driver.h> |
Alan Cox | 01e1abb | 2008-07-22 11:16:55 +0100 | [diff] [blame] | 9 | #include <linux/file.h> |
Alan Cox | 01e1abb | 2008-07-22 11:16:55 +0100 | [diff] [blame] | 10 | #include <linux/mm.h> |
| 11 | #include <linux/string.h> |
| 12 | #include <linux/slab.h> |
| 13 | #include <linux/poll.h> |
| 14 | #include <linux/proc_fs.h> |
Alan Cox | 01e1abb | 2008-07-22 11:16:55 +0100 | [diff] [blame] | 15 | #include <linux/module.h> |
Alan Cox | 01e1abb | 2008-07-22 11:16:55 +0100 | [diff] [blame] | 16 | #include <linux/device.h> |
| 17 | #include <linux/wait.h> |
| 18 | #include <linux/bitops.h> |
Alan Cox | 01e1abb | 2008-07-22 11:16:55 +0100 | [diff] [blame] | 19 | #include <linux/seq_file.h> |
Alan Cox | 01e1abb | 2008-07-22 11:16:55 +0100 | [diff] [blame] | 20 | #include <linux/uaccess.h> |
Jiri Slaby | 0c73c08 | 2011-11-16 16:27:09 +0100 | [diff] [blame] | 21 | #include <linux/ratelimit.h> |
Alan Cox | 01e1abb | 2008-07-22 11:16:55 +0100 | [diff] [blame] | 22 | |
Peter Hurley | fc575ee | 2013-03-11 16:44:38 -0400 | [diff] [blame] | 23 | #undef LDISC_DEBUG_HANGUP |
| 24 | |
| 25 | #ifdef LDISC_DEBUG_HANGUP |
Peter Hurley | 0a6adc1 | 2015-07-12 22:49:10 -0400 | [diff] [blame] | 26 | #define tty_ldisc_debug(tty, f, args...) tty_debug(tty, f, ##args) |
Peter Hurley | fc575ee | 2013-03-11 16:44:38 -0400 | [diff] [blame] | 27 | #else |
| 28 | #define tty_ldisc_debug(tty, f, args...) |
| 29 | #endif |
| 30 | |
Peter Hurley | d2c4389 | 2013-06-15 07:04:47 -0400 | [diff] [blame] | 31 | /* lockdep nested classes for tty->ldisc_sem */ |
| 32 | enum { |
| 33 | LDISC_SEM_NORMAL, |
| 34 | LDISC_SEM_OTHER, |
| 35 | }; |
| 36 | |
| 37 | |
Alan Cox | 01e1abb | 2008-07-22 11:16:55 +0100 | [diff] [blame] | 38 | /* |
| 39 | * This guards the refcounted line discipline lists. The lock |
| 40 | * must be taken with irqs off because there are hangup path |
| 41 | * callers who will do ldisc lookups and cannot sleep. |
| 42 | */ |
| 43 | |
Peter Hurley | 137084b | 2013-06-15 07:04:46 -0400 | [diff] [blame] | 44 | static DEFINE_RAW_SPINLOCK(tty_ldiscs_lock); |
Alan Cox | 01e1abb | 2008-07-22 11:16:55 +0100 | [diff] [blame] | 45 | /* Line disc dispatch table */ |
| 46 | static struct tty_ldisc_ops *tty_ldiscs[NR_LDISCS]; |
| 47 | |
| 48 | /** |
| 49 | * tty_register_ldisc - install a line discipline |
| 50 | * @disc: ldisc number |
| 51 | * @new_ldisc: pointer to the ldisc object |
| 52 | * |
| 53 | * Installs a new line discipline into the kernel. The discipline |
| 54 | * is set up as unreferenced and then made available to the kernel |
| 55 | * from this point onwards. |
| 56 | * |
| 57 | * Locking: |
Peter Hurley | 137084b | 2013-06-15 07:04:46 -0400 | [diff] [blame] | 58 | * takes tty_ldiscs_lock to guard against ldisc races |
Alan Cox | 01e1abb | 2008-07-22 11:16:55 +0100 | [diff] [blame] | 59 | */ |
| 60 | |
| 61 | int tty_register_ldisc(int disc, struct tty_ldisc_ops *new_ldisc) |
| 62 | { |
| 63 | unsigned long flags; |
| 64 | int ret = 0; |
| 65 | |
| 66 | if (disc < N_TTY || disc >= NR_LDISCS) |
| 67 | return -EINVAL; |
| 68 | |
Peter Hurley | 137084b | 2013-06-15 07:04:46 -0400 | [diff] [blame] | 69 | raw_spin_lock_irqsave(&tty_ldiscs_lock, flags); |
Alan Cox | 01e1abb | 2008-07-22 11:16:55 +0100 | [diff] [blame] | 70 | tty_ldiscs[disc] = new_ldisc; |
| 71 | new_ldisc->num = disc; |
| 72 | new_ldisc->refcount = 0; |
Peter Hurley | 137084b | 2013-06-15 07:04:46 -0400 | [diff] [blame] | 73 | raw_spin_unlock_irqrestore(&tty_ldiscs_lock, flags); |
Alan Cox | 01e1abb | 2008-07-22 11:16:55 +0100 | [diff] [blame] | 74 | |
| 75 | return ret; |
| 76 | } |
| 77 | EXPORT_SYMBOL(tty_register_ldisc); |
| 78 | |
| 79 | /** |
| 80 | * tty_unregister_ldisc - unload a line discipline |
| 81 | * @disc: ldisc number |
| 82 | * @new_ldisc: pointer to the ldisc object |
| 83 | * |
| 84 | * Remove a line discipline from the kernel providing it is not |
| 85 | * currently in use. |
| 86 | * |
| 87 | * Locking: |
Peter Hurley | 137084b | 2013-06-15 07:04:46 -0400 | [diff] [blame] | 88 | * takes tty_ldiscs_lock to guard against ldisc races |
Alan Cox | 01e1abb | 2008-07-22 11:16:55 +0100 | [diff] [blame] | 89 | */ |
| 90 | |
| 91 | int tty_unregister_ldisc(int disc) |
| 92 | { |
| 93 | unsigned long flags; |
| 94 | int ret = 0; |
| 95 | |
| 96 | if (disc < N_TTY || disc >= NR_LDISCS) |
| 97 | return -EINVAL; |
| 98 | |
Peter Hurley | 137084b | 2013-06-15 07:04:46 -0400 | [diff] [blame] | 99 | raw_spin_lock_irqsave(&tty_ldiscs_lock, flags); |
Alan Cox | 01e1abb | 2008-07-22 11:16:55 +0100 | [diff] [blame] | 100 | if (tty_ldiscs[disc]->refcount) |
| 101 | ret = -EBUSY; |
| 102 | else |
| 103 | tty_ldiscs[disc] = NULL; |
Peter Hurley | 137084b | 2013-06-15 07:04:46 -0400 | [diff] [blame] | 104 | raw_spin_unlock_irqrestore(&tty_ldiscs_lock, flags); |
Alan Cox | 01e1abb | 2008-07-22 11:16:55 +0100 | [diff] [blame] | 105 | |
| 106 | return ret; |
| 107 | } |
| 108 | EXPORT_SYMBOL(tty_unregister_ldisc); |
| 109 | |
Linus Torvalds | f0de0e8 | 2009-08-03 16:00:15 -0700 | [diff] [blame] | 110 | static struct tty_ldisc_ops *get_ldops(int disc) |
| 111 | { |
| 112 | unsigned long flags; |
| 113 | struct tty_ldisc_ops *ldops, *ret; |
| 114 | |
Peter Hurley | 137084b | 2013-06-15 07:04:46 -0400 | [diff] [blame] | 115 | raw_spin_lock_irqsave(&tty_ldiscs_lock, flags); |
Linus Torvalds | f0de0e8 | 2009-08-03 16:00:15 -0700 | [diff] [blame] | 116 | ret = ERR_PTR(-EINVAL); |
| 117 | ldops = tty_ldiscs[disc]; |
| 118 | if (ldops) { |
| 119 | ret = ERR_PTR(-EAGAIN); |
| 120 | if (try_module_get(ldops->owner)) { |
| 121 | ldops->refcount++; |
| 122 | ret = ldops; |
| 123 | } |
| 124 | } |
Peter Hurley | 137084b | 2013-06-15 07:04:46 -0400 | [diff] [blame] | 125 | raw_spin_unlock_irqrestore(&tty_ldiscs_lock, flags); |
Linus Torvalds | f0de0e8 | 2009-08-03 16:00:15 -0700 | [diff] [blame] | 126 | return ret; |
| 127 | } |
| 128 | |
| 129 | static void put_ldops(struct tty_ldisc_ops *ldops) |
| 130 | { |
| 131 | unsigned long flags; |
| 132 | |
Peter Hurley | 137084b | 2013-06-15 07:04:46 -0400 | [diff] [blame] | 133 | raw_spin_lock_irqsave(&tty_ldiscs_lock, flags); |
Linus Torvalds | f0de0e8 | 2009-08-03 16:00:15 -0700 | [diff] [blame] | 134 | ldops->refcount--; |
| 135 | module_put(ldops->owner); |
Peter Hurley | 137084b | 2013-06-15 07:04:46 -0400 | [diff] [blame] | 136 | raw_spin_unlock_irqrestore(&tty_ldiscs_lock, flags); |
Linus Torvalds | f0de0e8 | 2009-08-03 16:00:15 -0700 | [diff] [blame] | 137 | } |
Alan Cox | 01e1abb | 2008-07-22 11:16:55 +0100 | [diff] [blame] | 138 | |
| 139 | /** |
Alan Cox | 01e1abb | 2008-07-22 11:16:55 +0100 | [diff] [blame] | 140 | * tty_ldisc_get - take a reference to an ldisc |
| 141 | * @disc: ldisc number |
Alan Cox | 01e1abb | 2008-07-22 11:16:55 +0100 | [diff] [blame] | 142 | * |
| 143 | * Takes a reference to a line discipline. Deals with refcounts and |
Peter Hurley | c0cc1c5 | 2016-01-10 22:40:59 -0800 | [diff] [blame] | 144 | * module locking counts. |
| 145 | * |
| 146 | * Returns: -EINVAL if the discipline index is not [N_TTY..NR_LDISCS] or |
| 147 | * if the discipline is not registered |
| 148 | * -EAGAIN if request_module() failed to load or register the |
| 149 | * the discipline |
| 150 | * -ENOMEM if allocation failure |
| 151 | * |
| 152 | * Otherwise, returns a pointer to the discipline and bumps the |
| 153 | * ref count |
Alan Cox | 01e1abb | 2008-07-22 11:16:55 +0100 | [diff] [blame] | 154 | * |
| 155 | * Locking: |
Peter Hurley | 137084b | 2013-06-15 07:04:46 -0400 | [diff] [blame] | 156 | * takes tty_ldiscs_lock to guard against ldisc races |
Alan Cox | 01e1abb | 2008-07-22 11:16:55 +0100 | [diff] [blame] | 157 | */ |
| 158 | |
Peter Hurley | 3669752 | 2013-06-15 07:04:48 -0400 | [diff] [blame] | 159 | static struct tty_ldisc *tty_ldisc_get(struct tty_struct *tty, int disc) |
Alan Cox | 01e1abb | 2008-07-22 11:16:55 +0100 | [diff] [blame] | 160 | { |
Alan Cox | c65c9bc | 2009-06-11 12:50:12 +0100 | [diff] [blame] | 161 | struct tty_ldisc *ld; |
Linus Torvalds | 182274f | 2009-08-03 16:01:28 -0700 | [diff] [blame] | 162 | struct tty_ldisc_ops *ldops; |
Alan Cox | 01e1abb | 2008-07-22 11:16:55 +0100 | [diff] [blame] | 163 | |
| 164 | if (disc < N_TTY || disc >= NR_LDISCS) |
Alan Cox | c65c9bc | 2009-06-11 12:50:12 +0100 | [diff] [blame] | 165 | return ERR_PTR(-EINVAL); |
Linus Torvalds | 182274f | 2009-08-03 16:01:28 -0700 | [diff] [blame] | 166 | |
| 167 | /* |
| 168 | * Get the ldisc ops - we may need to request them to be loaded |
| 169 | * dynamically and try again. |
| 170 | */ |
| 171 | ldops = get_ldops(disc); |
| 172 | if (IS_ERR(ldops)) { |
Alan Cox | 01e1abb | 2008-07-22 11:16:55 +0100 | [diff] [blame] | 173 | request_module("tty-ldisc-%d", disc); |
Linus Torvalds | 182274f | 2009-08-03 16:01:28 -0700 | [diff] [blame] | 174 | ldops = get_ldops(disc); |
| 175 | if (IS_ERR(ldops)) |
| 176 | return ERR_CAST(ldops); |
Alan Cox | 01e1abb | 2008-07-22 11:16:55 +0100 | [diff] [blame] | 177 | } |
Linus Torvalds | 182274f | 2009-08-03 16:01:28 -0700 | [diff] [blame] | 178 | |
| 179 | ld = kmalloc(sizeof(struct tty_ldisc), GFP_KERNEL); |
| 180 | if (ld == NULL) { |
| 181 | put_ldops(ldops); |
| 182 | return ERR_PTR(-ENOMEM); |
| 183 | } |
| 184 | |
| 185 | ld->ops = ldops; |
Peter Hurley | 3669752 | 2013-06-15 07:04:48 -0400 | [diff] [blame] | 186 | ld->tty = tty; |
Ivo Sieben | 1541f84 | 2012-05-03 14:37:43 +0200 | [diff] [blame] | 187 | |
Alan Cox | c65c9bc | 2009-06-11 12:50:12 +0100 | [diff] [blame] | 188 | return ld; |
Alan Cox | 01e1abb | 2008-07-22 11:16:55 +0100 | [diff] [blame] | 189 | } |
| 190 | |
Peter Hurley | 734de24 | 2013-03-11 16:44:43 -0400 | [diff] [blame] | 191 | /** |
| 192 | * tty_ldisc_put - release the ldisc |
| 193 | * |
| 194 | * Complement of tty_ldisc_get(). |
| 195 | */ |
Denys Vlasenko | cb128f6 | 2015-10-27 17:40:02 +0100 | [diff] [blame] | 196 | static void tty_ldisc_put(struct tty_ldisc *ld) |
Peter Hurley | 734de24 | 2013-03-11 16:44:43 -0400 | [diff] [blame] | 197 | { |
Peter Hurley | 734de24 | 2013-03-11 16:44:43 -0400 | [diff] [blame] | 198 | if (WARN_ON_ONCE(!ld)) |
| 199 | return; |
| 200 | |
Peter Hurley | 3669752 | 2013-06-15 07:04:48 -0400 | [diff] [blame] | 201 | put_ldops(ld->ops); |
Peter Hurley | 734de24 | 2013-03-11 16:44:43 -0400 | [diff] [blame] | 202 | kfree(ld); |
Peter Hurley | 734de24 | 2013-03-11 16:44:43 -0400 | [diff] [blame] | 203 | } |
| 204 | |
Alan Cox | 852e99d | 2009-06-11 12:51:41 +0100 | [diff] [blame] | 205 | static void *tty_ldiscs_seq_start(struct seq_file *m, loff_t *pos) |
Alan Cox | 01e1abb | 2008-07-22 11:16:55 +0100 | [diff] [blame] | 206 | { |
| 207 | return (*pos < NR_LDISCS) ? pos : NULL; |
| 208 | } |
| 209 | |
Alan Cox | 852e99d | 2009-06-11 12:51:41 +0100 | [diff] [blame] | 210 | static void *tty_ldiscs_seq_next(struct seq_file *m, void *v, loff_t *pos) |
Alan Cox | 01e1abb | 2008-07-22 11:16:55 +0100 | [diff] [blame] | 211 | { |
| 212 | (*pos)++; |
| 213 | return (*pos < NR_LDISCS) ? pos : NULL; |
| 214 | } |
| 215 | |
| 216 | static void tty_ldiscs_seq_stop(struct seq_file *m, void *v) |
| 217 | { |
| 218 | } |
| 219 | |
| 220 | static int tty_ldiscs_seq_show(struct seq_file *m, void *v) |
| 221 | { |
| 222 | int i = *(loff_t *)v; |
Linus Torvalds | f0de0e8 | 2009-08-03 16:00:15 -0700 | [diff] [blame] | 223 | struct tty_ldisc_ops *ldops; |
Alan Cox | 852e99d | 2009-06-11 12:51:41 +0100 | [diff] [blame] | 224 | |
Linus Torvalds | f0de0e8 | 2009-08-03 16:00:15 -0700 | [diff] [blame] | 225 | ldops = get_ldops(i); |
| 226 | if (IS_ERR(ldops)) |
Alan Cox | 01e1abb | 2008-07-22 11:16:55 +0100 | [diff] [blame] | 227 | return 0; |
Linus Torvalds | f0de0e8 | 2009-08-03 16:00:15 -0700 | [diff] [blame] | 228 | seq_printf(m, "%-10s %2d\n", ldops->name ? ldops->name : "???", i); |
| 229 | put_ldops(ldops); |
Alan Cox | 01e1abb | 2008-07-22 11:16:55 +0100 | [diff] [blame] | 230 | return 0; |
| 231 | } |
| 232 | |
| 233 | static const struct seq_operations tty_ldiscs_seq_ops = { |
| 234 | .start = tty_ldiscs_seq_start, |
| 235 | .next = tty_ldiscs_seq_next, |
| 236 | .stop = tty_ldiscs_seq_stop, |
| 237 | .show = tty_ldiscs_seq_show, |
| 238 | }; |
| 239 | |
| 240 | static int proc_tty_ldiscs_open(struct inode *inode, struct file *file) |
| 241 | { |
| 242 | return seq_open(file, &tty_ldiscs_seq_ops); |
| 243 | } |
| 244 | |
| 245 | const struct file_operations tty_ldiscs_proc_fops = { |
| 246 | .owner = THIS_MODULE, |
| 247 | .open = proc_tty_ldiscs_open, |
| 248 | .read = seq_read, |
| 249 | .llseek = seq_lseek, |
| 250 | .release = seq_release, |
| 251 | }; |
| 252 | |
| 253 | /** |
Alan Cox | 01e1abb | 2008-07-22 11:16:55 +0100 | [diff] [blame] | 254 | * tty_ldisc_ref_wait - wait for the tty ldisc |
| 255 | * @tty: tty device |
| 256 | * |
| 257 | * Dereference the line discipline for the terminal and take a |
| 258 | * reference to it. If the line discipline is in flux then |
| 259 | * wait patiently until it changes. |
| 260 | * |
Peter Hurley | 892d1fa | 2016-01-10 22:41:06 -0800 | [diff] [blame] | 261 | * Returns: NULL if the tty has been hungup and not re-opened with |
| 262 | * a new file descriptor, otherwise valid ldisc reference |
| 263 | * |
Alan Cox | 01e1abb | 2008-07-22 11:16:55 +0100 | [diff] [blame] | 264 | * Note: Must not be called from an IRQ/timer context. The caller |
| 265 | * must also be careful not to hold other locks that will deadlock |
| 266 | * against a discipline change, such as an existing ldisc reference |
| 267 | * (which we check for) |
| 268 | * |
Peter Hurley | e55afd1 | 2016-01-10 22:41:01 -0800 | [diff] [blame] | 269 | * Note: a file_operations routine (read/poll/write) should use this |
| 270 | * function to wait for any ldisc lifetime events to finish. |
Alan Cox | 01e1abb | 2008-07-22 11:16:55 +0100 | [diff] [blame] | 271 | */ |
| 272 | |
| 273 | struct tty_ldisc *tty_ldisc_ref_wait(struct tty_struct *tty) |
| 274 | { |
Dmitry Vyukov | a4a3e06 | 2017-03-04 13:46:12 +0100 | [diff] [blame] | 275 | struct tty_ldisc *ld; |
| 276 | |
Peter Hurley | 3669752 | 2013-06-15 07:04:48 -0400 | [diff] [blame] | 277 | ldsem_down_read(&tty->ldisc_sem, MAX_SCHEDULE_TIMEOUT); |
Dmitry Vyukov | a4a3e06 | 2017-03-04 13:46:12 +0100 | [diff] [blame] | 278 | ld = tty->ldisc; |
| 279 | if (!ld) |
Peter Hurley | a570a49 | 2016-01-10 22:41:02 -0800 | [diff] [blame] | 280 | ldsem_up_read(&tty->ldisc_sem); |
Dmitry Vyukov | a4a3e06 | 2017-03-04 13:46:12 +0100 | [diff] [blame] | 281 | return ld; |
Alan Cox | 01e1abb | 2008-07-22 11:16:55 +0100 | [diff] [blame] | 282 | } |
Alan Cox | 01e1abb | 2008-07-22 11:16:55 +0100 | [diff] [blame] | 283 | EXPORT_SYMBOL_GPL(tty_ldisc_ref_wait); |
| 284 | |
| 285 | /** |
| 286 | * tty_ldisc_ref - get the tty ldisc |
| 287 | * @tty: tty device |
| 288 | * |
| 289 | * Dereference the line discipline for the terminal and take a |
| 290 | * reference to it. If the line discipline is in flux then |
| 291 | * return NULL. Can be called from IRQ and timer functions. |
Alan Cox | 01e1abb | 2008-07-22 11:16:55 +0100 | [diff] [blame] | 292 | */ |
| 293 | |
| 294 | struct tty_ldisc *tty_ldisc_ref(struct tty_struct *tty) |
| 295 | { |
Peter Hurley | 3669752 | 2013-06-15 07:04:48 -0400 | [diff] [blame] | 296 | struct tty_ldisc *ld = NULL; |
| 297 | |
| 298 | if (ldsem_down_read_trylock(&tty->ldisc_sem)) { |
| 299 | ld = tty->ldisc; |
| 300 | if (!ld) |
| 301 | ldsem_up_read(&tty->ldisc_sem); |
| 302 | } |
| 303 | return ld; |
Alan Cox | 01e1abb | 2008-07-22 11:16:55 +0100 | [diff] [blame] | 304 | } |
Alan Cox | 01e1abb | 2008-07-22 11:16:55 +0100 | [diff] [blame] | 305 | EXPORT_SYMBOL_GPL(tty_ldisc_ref); |
| 306 | |
| 307 | /** |
| 308 | * tty_ldisc_deref - free a tty ldisc reference |
| 309 | * @ld: reference to free up |
| 310 | * |
| 311 | * Undoes the effect of tty_ldisc_ref or tty_ldisc_ref_wait. May |
| 312 | * be called in IRQ context. |
Alan Cox | 01e1abb | 2008-07-22 11:16:55 +0100 | [diff] [blame] | 313 | */ |
| 314 | |
| 315 | void tty_ldisc_deref(struct tty_ldisc *ld) |
| 316 | { |
Peter Hurley | 3669752 | 2013-06-15 07:04:48 -0400 | [diff] [blame] | 317 | ldsem_up_read(&ld->tty->ldisc_sem); |
Alan Cox | 01e1abb | 2008-07-22 11:16:55 +0100 | [diff] [blame] | 318 | } |
Alan Cox | 01e1abb | 2008-07-22 11:16:55 +0100 | [diff] [blame] | 319 | EXPORT_SYMBOL_GPL(tty_ldisc_deref); |
| 320 | |
Peter Hurley | d2c4389 | 2013-06-15 07:04:47 -0400 | [diff] [blame] | 321 | |
Peter Hurley | c2bb524 | 2016-01-09 21:13:51 -0800 | [diff] [blame] | 322 | static inline int |
Peter Hurley | e80a10e | 2014-11-05 12:13:06 -0500 | [diff] [blame] | 323 | __tty_ldisc_lock(struct tty_struct *tty, unsigned long timeout) |
Peter Hurley | d2c4389 | 2013-06-15 07:04:47 -0400 | [diff] [blame] | 324 | { |
| 325 | return ldsem_down_write(&tty->ldisc_sem, timeout); |
| 326 | } |
| 327 | |
Peter Hurley | c2bb524 | 2016-01-09 21:13:51 -0800 | [diff] [blame] | 328 | static inline int |
Peter Hurley | e80a10e | 2014-11-05 12:13:06 -0500 | [diff] [blame] | 329 | __tty_ldisc_lock_nested(struct tty_struct *tty, unsigned long timeout) |
Peter Hurley | d2c4389 | 2013-06-15 07:04:47 -0400 | [diff] [blame] | 330 | { |
| 331 | return ldsem_down_write_nested(&tty->ldisc_sem, |
| 332 | LDISC_SEM_OTHER, timeout); |
| 333 | } |
| 334 | |
Peter Hurley | e80a10e | 2014-11-05 12:13:06 -0500 | [diff] [blame] | 335 | static inline void __tty_ldisc_unlock(struct tty_struct *tty) |
Peter Hurley | d2c4389 | 2013-06-15 07:04:47 -0400 | [diff] [blame] | 336 | { |
Guillaume Gomez | 52772ea | 2015-10-04 21:19:18 +0200 | [diff] [blame] | 337 | ldsem_up_write(&tty->ldisc_sem); |
Peter Hurley | d2c4389 | 2013-06-15 07:04:47 -0400 | [diff] [blame] | 338 | } |
| 339 | |
Peter Hurley | c2bb524 | 2016-01-09 21:13:51 -0800 | [diff] [blame] | 340 | static int tty_ldisc_lock(struct tty_struct *tty, unsigned long timeout) |
Peter Hurley | fae76e9 | 2014-11-05 12:13:07 -0500 | [diff] [blame] | 341 | { |
| 342 | int ret; |
| 343 | |
| 344 | ret = __tty_ldisc_lock(tty, timeout); |
| 345 | if (!ret) |
| 346 | return -EBUSY; |
| 347 | set_bit(TTY_LDISC_HALTED, &tty->flags); |
| 348 | return 0; |
| 349 | } |
| 350 | |
| 351 | static void tty_ldisc_unlock(struct tty_struct *tty) |
| 352 | { |
| 353 | clear_bit(TTY_LDISC_HALTED, &tty->flags); |
| 354 | __tty_ldisc_unlock(tty); |
| 355 | } |
| 356 | |
Peter Hurley | c2bb524 | 2016-01-09 21:13:51 -0800 | [diff] [blame] | 357 | static int |
Peter Hurley | d2c4389 | 2013-06-15 07:04:47 -0400 | [diff] [blame] | 358 | tty_ldisc_lock_pair_timeout(struct tty_struct *tty, struct tty_struct *tty2, |
| 359 | unsigned long timeout) |
| 360 | { |
| 361 | int ret; |
| 362 | |
| 363 | if (tty < tty2) { |
Peter Hurley | e80a10e | 2014-11-05 12:13:06 -0500 | [diff] [blame] | 364 | ret = __tty_ldisc_lock(tty, timeout); |
Peter Hurley | d2c4389 | 2013-06-15 07:04:47 -0400 | [diff] [blame] | 365 | if (ret) { |
Peter Hurley | e80a10e | 2014-11-05 12:13:06 -0500 | [diff] [blame] | 366 | ret = __tty_ldisc_lock_nested(tty2, timeout); |
Peter Hurley | d2c4389 | 2013-06-15 07:04:47 -0400 | [diff] [blame] | 367 | if (!ret) |
Peter Hurley | e80a10e | 2014-11-05 12:13:06 -0500 | [diff] [blame] | 368 | __tty_ldisc_unlock(tty); |
Peter Hurley | d2c4389 | 2013-06-15 07:04:47 -0400 | [diff] [blame] | 369 | } |
| 370 | } else { |
| 371 | /* if this is possible, it has lots of implications */ |
| 372 | WARN_ON_ONCE(tty == tty2); |
| 373 | if (tty2 && tty != tty2) { |
Peter Hurley | e80a10e | 2014-11-05 12:13:06 -0500 | [diff] [blame] | 374 | ret = __tty_ldisc_lock(tty2, timeout); |
Peter Hurley | d2c4389 | 2013-06-15 07:04:47 -0400 | [diff] [blame] | 375 | if (ret) { |
Peter Hurley | e80a10e | 2014-11-05 12:13:06 -0500 | [diff] [blame] | 376 | ret = __tty_ldisc_lock_nested(tty, timeout); |
Peter Hurley | d2c4389 | 2013-06-15 07:04:47 -0400 | [diff] [blame] | 377 | if (!ret) |
Peter Hurley | e80a10e | 2014-11-05 12:13:06 -0500 | [diff] [blame] | 378 | __tty_ldisc_unlock(tty2); |
Peter Hurley | d2c4389 | 2013-06-15 07:04:47 -0400 | [diff] [blame] | 379 | } |
| 380 | } else |
Peter Hurley | e80a10e | 2014-11-05 12:13:06 -0500 | [diff] [blame] | 381 | ret = __tty_ldisc_lock(tty, timeout); |
Peter Hurley | d2c4389 | 2013-06-15 07:04:47 -0400 | [diff] [blame] | 382 | } |
| 383 | |
| 384 | if (!ret) |
| 385 | return -EBUSY; |
| 386 | |
| 387 | set_bit(TTY_LDISC_HALTED, &tty->flags); |
| 388 | if (tty2) |
| 389 | set_bit(TTY_LDISC_HALTED, &tty2->flags); |
| 390 | return 0; |
| 391 | } |
| 392 | |
Peter Hurley | c2bb524 | 2016-01-09 21:13:51 -0800 | [diff] [blame] | 393 | static void tty_ldisc_lock_pair(struct tty_struct *tty, struct tty_struct *tty2) |
Peter Hurley | d2c4389 | 2013-06-15 07:04:47 -0400 | [diff] [blame] | 394 | { |
| 395 | tty_ldisc_lock_pair_timeout(tty, tty2, MAX_SCHEDULE_TIMEOUT); |
| 396 | } |
| 397 | |
Peter Hurley | c2bb524 | 2016-01-09 21:13:51 -0800 | [diff] [blame] | 398 | static void tty_ldisc_unlock_pair(struct tty_struct *tty, |
| 399 | struct tty_struct *tty2) |
Peter Hurley | d2c4389 | 2013-06-15 07:04:47 -0400 | [diff] [blame] | 400 | { |
Peter Hurley | e80a10e | 2014-11-05 12:13:06 -0500 | [diff] [blame] | 401 | __tty_ldisc_unlock(tty); |
Peter Hurley | d2c4389 | 2013-06-15 07:04:47 -0400 | [diff] [blame] | 402 | if (tty2) |
Peter Hurley | e80a10e | 2014-11-05 12:13:06 -0500 | [diff] [blame] | 403 | __tty_ldisc_unlock(tty2); |
Peter Hurley | d2c4389 | 2013-06-15 07:04:47 -0400 | [diff] [blame] | 404 | } |
| 405 | |
Alan Cox | 01e1abb | 2008-07-22 11:16:55 +0100 | [diff] [blame] | 406 | /** |
Alan Cox | f2c4c65 | 2009-06-11 12:50:58 +0100 | [diff] [blame] | 407 | * tty_ldisc_flush - flush line discipline queue |
| 408 | * @tty: tty |
| 409 | * |
Peter Hurley | 86c80a8 | 2014-11-05 12:13:09 -0500 | [diff] [blame] | 410 | * Flush the line discipline queue (if any) and the tty flip buffers |
| 411 | * for this tty. |
Alan Cox | f2c4c65 | 2009-06-11 12:50:58 +0100 | [diff] [blame] | 412 | */ |
| 413 | |
| 414 | void tty_ldisc_flush(struct tty_struct *tty) |
| 415 | { |
| 416 | struct tty_ldisc *ld = tty_ldisc_ref(tty); |
Peter Hurley | 86c80a8 | 2014-11-05 12:13:09 -0500 | [diff] [blame] | 417 | |
| 418 | tty_buffer_flush(tty, ld); |
| 419 | if (ld) |
Alan Cox | f2c4c65 | 2009-06-11 12:50:58 +0100 | [diff] [blame] | 420 | tty_ldisc_deref(ld); |
Alan Cox | f2c4c65 | 2009-06-11 12:50:58 +0100 | [diff] [blame] | 421 | } |
Alan Cox | f2c4c65 | 2009-06-11 12:50:58 +0100 | [diff] [blame] | 422 | EXPORT_SYMBOL_GPL(tty_ldisc_flush); |
| 423 | |
| 424 | /** |
Alan Cox | 01e1abb | 2008-07-22 11:16:55 +0100 | [diff] [blame] | 425 | * tty_set_termios_ldisc - set ldisc field |
| 426 | * @tty: tty structure |
Peter Hurley | c12da96 | 2016-01-10 22:41:04 -0800 | [diff] [blame] | 427 | * @disc: line discipline number |
Alan Cox | 01e1abb | 2008-07-22 11:16:55 +0100 | [diff] [blame] | 428 | * |
| 429 | * This is probably overkill for real world processors but |
| 430 | * they are not on hot paths so a little discipline won't do |
| 431 | * any harm. |
| 432 | * |
Peter Hurley | dd42bf1 | 2015-11-27 14:30:21 -0500 | [diff] [blame] | 433 | * The line discipline-related tty_struct fields are reset to |
| 434 | * prevent the ldisc driver from re-using stale information for |
| 435 | * the new ldisc instance. |
| 436 | * |
Peter Hurley | 6a1c068 | 2013-06-15 09:14:23 -0400 | [diff] [blame] | 437 | * Locking: takes termios_rwsem |
Alan Cox | 01e1abb | 2008-07-22 11:16:55 +0100 | [diff] [blame] | 438 | */ |
| 439 | |
Peter Hurley | c12da96 | 2016-01-10 22:41:04 -0800 | [diff] [blame] | 440 | static void tty_set_termios_ldisc(struct tty_struct *tty, int disc) |
Alan Cox | 01e1abb | 2008-07-22 11:16:55 +0100 | [diff] [blame] | 441 | { |
Peter Hurley | 6a1c068 | 2013-06-15 09:14:23 -0400 | [diff] [blame] | 442 | down_write(&tty->termios_rwsem); |
Peter Hurley | c12da96 | 2016-01-10 22:41:04 -0800 | [diff] [blame] | 443 | tty->termios.c_line = disc; |
Peter Hurley | 6a1c068 | 2013-06-15 09:14:23 -0400 | [diff] [blame] | 444 | up_write(&tty->termios_rwsem); |
Peter Hurley | dd42bf1 | 2015-11-27 14:30:21 -0500 | [diff] [blame] | 445 | |
| 446 | tty->disc_data = NULL; |
| 447 | tty->receive_room = 0; |
Alan Cox | 01e1abb | 2008-07-22 11:16:55 +0100 | [diff] [blame] | 448 | } |
| 449 | |
Alan Cox | c65c9bc | 2009-06-11 12:50:12 +0100 | [diff] [blame] | 450 | /** |
| 451 | * tty_ldisc_open - open a line discipline |
| 452 | * @tty: tty we are opening the ldisc on |
| 453 | * @ld: discipline to open |
| 454 | * |
| 455 | * A helper opening method. Also a convenient debugging and check |
| 456 | * point. |
Arnd Bergmann | ec79d60 | 2010-06-01 22:53:01 +0200 | [diff] [blame] | 457 | * |
| 458 | * Locking: always called with BTM already held. |
Alan Cox | c65c9bc | 2009-06-11 12:50:12 +0100 | [diff] [blame] | 459 | */ |
| 460 | |
| 461 | static int tty_ldisc_open(struct tty_struct *tty, struct tty_ldisc *ld) |
| 462 | { |
| 463 | WARN_ON(test_and_set_bit(TTY_LDISC_OPEN, &tty->flags)); |
Alan Cox | f18f949 | 2009-11-30 13:18:35 +0000 | [diff] [blame] | 464 | if (ld->ops->open) { |
| 465 | int ret; |
Arnd Bergmann | ec79d60 | 2010-06-01 22:53:01 +0200 | [diff] [blame] | 466 | /* BTM here locks versus a hangup event */ |
Alan Cox | f18f949 | 2009-11-30 13:18:35 +0000 | [diff] [blame] | 467 | ret = ld->ops->open(tty); |
Jiri Slaby | 7f90cfc | 2010-11-25 00:27:54 +0100 | [diff] [blame] | 468 | if (ret) |
| 469 | clear_bit(TTY_LDISC_OPEN, &tty->flags); |
Peter Hurley | fb6edc9 | 2015-07-12 22:49:12 -0400 | [diff] [blame] | 470 | |
Peter Hurley | a570a49 | 2016-01-10 22:41:02 -0800 | [diff] [blame] | 471 | tty_ldisc_debug(tty, "%p: opened\n", ld); |
Alan Cox | f18f949 | 2009-11-30 13:18:35 +0000 | [diff] [blame] | 472 | return ret; |
| 473 | } |
Alan Cox | c65c9bc | 2009-06-11 12:50:12 +0100 | [diff] [blame] | 474 | return 0; |
| 475 | } |
| 476 | |
| 477 | /** |
| 478 | * tty_ldisc_close - close a line discipline |
| 479 | * @tty: tty we are opening the ldisc on |
| 480 | * @ld: discipline to close |
| 481 | * |
| 482 | * A helper close method. Also a convenient debugging and check |
| 483 | * point. |
| 484 | */ |
| 485 | |
| 486 | static void tty_ldisc_close(struct tty_struct *tty, struct tty_ldisc *ld) |
| 487 | { |
| 488 | WARN_ON(!test_bit(TTY_LDISC_OPEN, &tty->flags)); |
| 489 | clear_bit(TTY_LDISC_OPEN, &tty->flags); |
| 490 | if (ld->ops->close) |
| 491 | ld->ops->close(tty); |
Peter Hurley | a570a49 | 2016-01-10 22:41:02 -0800 | [diff] [blame] | 492 | tty_ldisc_debug(tty, "%p: closed\n", ld); |
Alan Cox | c65c9bc | 2009-06-11 12:50:12 +0100 | [diff] [blame] | 493 | } |
Alan Cox | 01e1abb | 2008-07-22 11:16:55 +0100 | [diff] [blame] | 494 | |
| 495 | /** |
Alan Cox | 8a8dabf | 2017-06-02 13:49:30 +0100 | [diff] [blame] | 496 | * tty_ldisc_failto - helper for ldisc failback |
| 497 | * @tty: tty to open the ldisc on |
| 498 | * @ld: ldisc we are trying to fail back to |
| 499 | * |
| 500 | * Helper to try and recover a tty when switching back to the old |
| 501 | * ldisc fails and we need something attached. |
| 502 | */ |
| 503 | |
| 504 | static int tty_ldisc_failto(struct tty_struct *tty, int ld) |
| 505 | { |
| 506 | struct tty_ldisc *disc = tty_ldisc_get(tty, ld); |
| 507 | int r; |
| 508 | |
| 509 | if (IS_ERR(disc)) |
| 510 | return PTR_ERR(disc); |
| 511 | tty->ldisc = disc; |
| 512 | tty_set_termios_ldisc(tty, ld); |
| 513 | if ((r = tty_ldisc_open(tty, disc)) < 0) |
| 514 | tty_ldisc_put(disc); |
| 515 | return r; |
| 516 | } |
| 517 | |
| 518 | /** |
Greg Kroah-Hartman | a8983d0 | 2017-04-14 10:57:52 +0200 | [diff] [blame] | 519 | * tty_ldisc_restore - helper for tty ldisc change |
| 520 | * @tty: tty to recover |
| 521 | * @old: previous ldisc |
| 522 | * |
| 523 | * Restore the previous line discipline or N_TTY when a line discipline |
| 524 | * change fails due to an open error |
| 525 | */ |
| 526 | |
| 527 | static void tty_ldisc_restore(struct tty_struct *tty, struct tty_ldisc *old) |
| 528 | { |
Greg Kroah-Hartman | a8983d0 | 2017-04-14 10:57:52 +0200 | [diff] [blame] | 529 | /* There is an outstanding reference here so this is safe */ |
| 530 | old = tty_ldisc_get(tty, old->ops->num); |
| 531 | WARN_ON(IS_ERR(old)); |
| 532 | tty->ldisc = old; |
| 533 | tty_set_termios_ldisc(tty, old->ops->num); |
| 534 | if (tty_ldisc_open(tty, old) < 0) { |
| 535 | tty_ldisc_put(old); |
Alan Cox | 8a8dabf | 2017-06-02 13:49:30 +0100 | [diff] [blame] | 536 | /* The traditional behaviour is to fall back to N_TTY, we |
| 537 | want to avoid falling back to N_NULL unless we have no |
| 538 | choice to avoid the risk of breaking anything */ |
| 539 | if (tty_ldisc_failto(tty, N_TTY) < 0 && |
| 540 | tty_ldisc_failto(tty, N_NULL) < 0) |
| 541 | panic("Couldn't open N_NULL ldisc for %s.", |
| 542 | tty_name(tty)); |
Greg Kroah-Hartman | a8983d0 | 2017-04-14 10:57:52 +0200 | [diff] [blame] | 543 | } |
| 544 | } |
| 545 | |
| 546 | /** |
Alan Cox | 01e1abb | 2008-07-22 11:16:55 +0100 | [diff] [blame] | 547 | * tty_set_ldisc - set line discipline |
| 548 | * @tty: the terminal to set |
| 549 | * @ldisc: the line discipline |
| 550 | * |
| 551 | * Set the discipline of a tty line. Must be called from a process |
Alan Cox | c65c9bc | 2009-06-11 12:50:12 +0100 | [diff] [blame] | 552 | * context. The ldisc change logic has to protect itself against any |
| 553 | * overlapping ldisc change (including on the other end of pty pairs), |
| 554 | * the close of one side of a tty/pty pair, and eventually hangup. |
Alan Cox | 01e1abb | 2008-07-22 11:16:55 +0100 | [diff] [blame] | 555 | */ |
| 556 | |
Peter Hurley | c12da96 | 2016-01-10 22:41:04 -0800 | [diff] [blame] | 557 | int tty_set_ldisc(struct tty_struct *tty, int disc) |
Alan Cox | 01e1abb | 2008-07-22 11:16:55 +0100 | [diff] [blame] | 558 | { |
Greg Kroah-Hartman | a8983d0 | 2017-04-14 10:57:52 +0200 | [diff] [blame] | 559 | int retval; |
| 560 | struct tty_ldisc *old_ldisc, *new_ldisc; |
| 561 | |
| 562 | new_ldisc = tty_ldisc_get(tty, disc); |
| 563 | if (IS_ERR(new_ldisc)) |
| 564 | return PTR_ERR(new_ldisc); |
Alan Cox | c65c9bc | 2009-06-11 12:50:12 +0100 | [diff] [blame] | 565 | |
Peter Hurley | c8483bc | 2014-11-05 12:12:45 -0500 | [diff] [blame] | 566 | tty_lock(tty); |
Peter Hurley | 276a661 | 2014-11-05 12:13:08 -0500 | [diff] [blame] | 567 | retval = tty_ldisc_lock(tty, 5 * HZ); |
Peter Hurley | 63d8cb3 | 2015-11-08 09:29:38 -0500 | [diff] [blame] | 568 | if (retval) |
| 569 | goto err; |
Alan Cox | c65c9bc | 2009-06-11 12:50:12 +0100 | [diff] [blame] | 570 | |
Peter Hurley | a570a49 | 2016-01-10 22:41:02 -0800 | [diff] [blame] | 571 | if (!tty->ldisc) { |
| 572 | retval = -EIO; |
| 573 | goto out; |
| 574 | } |
| 575 | |
Peter Hurley | 63d8cb3 | 2015-11-08 09:29:38 -0500 | [diff] [blame] | 576 | /* Check the no-op case */ |
Greg Kroah-Hartman | a8983d0 | 2017-04-14 10:57:52 +0200 | [diff] [blame] | 577 | if (tty->ldisc->ops->num == disc) |
Peter Hurley | 63d8cb3 | 2015-11-08 09:29:38 -0500 | [diff] [blame] | 578 | goto out; |
Alan Cox | c65c9bc | 2009-06-11 12:50:12 +0100 | [diff] [blame] | 579 | |
Peter Hurley | 63d8cb3 | 2015-11-08 09:29:38 -0500 | [diff] [blame] | 580 | if (test_bit(TTY_HUPPED, &tty->flags)) { |
| 581 | /* We were raced by hangup */ |
| 582 | retval = -EIO; |
| 583 | goto out; |
Alan Cox | c65c9bc | 2009-06-11 12:50:12 +0100 | [diff] [blame] | 584 | } |
Alan Cox | 01e1abb | 2008-07-22 11:16:55 +0100 | [diff] [blame] | 585 | |
Greg Kroah-Hartman | a8983d0 | 2017-04-14 10:57:52 +0200 | [diff] [blame] | 586 | old_ldisc = tty->ldisc; |
| 587 | |
| 588 | /* Shutdown the old discipline. */ |
| 589 | tty_ldisc_close(tty, old_ldisc); |
| 590 | |
| 591 | /* Now set up the new line discipline. */ |
| 592 | tty->ldisc = new_ldisc; |
| 593 | tty_set_termios_ldisc(tty, disc); |
| 594 | |
| 595 | retval = tty_ldisc_open(tty, new_ldisc); |
Alan Cox | 01e1abb | 2008-07-22 11:16:55 +0100 | [diff] [blame] | 596 | if (retval < 0) { |
Alan Cox | c65c9bc | 2009-06-11 12:50:12 +0100 | [diff] [blame] | 597 | /* Back to the old one or N_TTY if we can't */ |
Greg Kroah-Hartman | a8983d0 | 2017-04-14 10:57:52 +0200 | [diff] [blame] | 598 | tty_ldisc_put(new_ldisc); |
| 599 | tty_ldisc_restore(tty, old_ldisc); |
Alan Cox | 01e1abb | 2008-07-22 11:16:55 +0100 | [diff] [blame] | 600 | } |
Alan Cox | c65c9bc | 2009-06-11 12:50:12 +0100 | [diff] [blame] | 601 | |
Greg Kroah-Hartman | a8983d0 | 2017-04-14 10:57:52 +0200 | [diff] [blame] | 602 | if (tty->ldisc->ops->num != old_ldisc->ops->num && tty->ops->set_ldisc) { |
Peter Hurley | 9191aaa | 2014-11-05 13:11:41 -0500 | [diff] [blame] | 603 | down_read(&tty->termios_rwsem); |
Alan Cox | 01e1abb | 2008-07-22 11:16:55 +0100 | [diff] [blame] | 604 | tty->ops->set_ldisc(tty); |
Peter Hurley | 9191aaa | 2014-11-05 13:11:41 -0500 | [diff] [blame] | 605 | up_read(&tty->termios_rwsem); |
| 606 | } |
Alan Cox | 01e1abb | 2008-07-22 11:16:55 +0100 | [diff] [blame] | 607 | |
Greg Kroah-Hartman | a8983d0 | 2017-04-14 10:57:52 +0200 | [diff] [blame] | 608 | /* At this point we hold a reference to the new ldisc and a |
| 609 | reference to the old ldisc, or we hold two references to |
| 610 | the old ldisc (if it was restored as part of error cleanup |
| 611 | above). In either case, releasing a single reference from |
| 612 | the old ldisc is correct. */ |
| 613 | new_ldisc = old_ldisc; |
Peter Hurley | 63d8cb3 | 2015-11-08 09:29:38 -0500 | [diff] [blame] | 614 | out: |
Peter Hurley | 276a661 | 2014-11-05 12:13:08 -0500 | [diff] [blame] | 615 | tty_ldisc_unlock(tty); |
Alan Cox | 01e1abb | 2008-07-22 11:16:55 +0100 | [diff] [blame] | 616 | |
Alan Cox | c65c9bc | 2009-06-11 12:50:12 +0100 | [diff] [blame] | 617 | /* Restart the work queue in case no characters kick it off. Safe if |
Alan Cox | 01e1abb | 2008-07-22 11:16:55 +0100 | [diff] [blame] | 618 | already running */ |
Peter Hurley | 17a6921 | 2015-11-08 07:53:06 -0500 | [diff] [blame] | 619 | tty_buffer_restart_work(tty->port); |
Peter Hurley | 63d8cb3 | 2015-11-08 09:29:38 -0500 | [diff] [blame] | 620 | err: |
Greg Kroah-Hartman | a8983d0 | 2017-04-14 10:57:52 +0200 | [diff] [blame] | 621 | tty_ldisc_put(new_ldisc); /* drop the extra reference */ |
Alan Cox | 89c8d91 | 2012-08-08 16:30:13 +0100 | [diff] [blame] | 622 | tty_unlock(tty); |
Alan Cox | 01e1abb | 2008-07-22 11:16:55 +0100 | [diff] [blame] | 623 | return retval; |
| 624 | } |
Okash Khawaja | 1ab92da | 2017-05-15 18:45:33 +0100 | [diff] [blame] | 625 | EXPORT_SYMBOL_GPL(tty_set_ldisc); |
Alan Cox | 01e1abb | 2008-07-22 11:16:55 +0100 | [diff] [blame] | 626 | |
Alan Cox | c65c9bc | 2009-06-11 12:50:12 +0100 | [diff] [blame] | 627 | /** |
Peter Hurley | 6ffeb4b | 2016-01-10 22:41:03 -0800 | [diff] [blame] | 628 | * tty_ldisc_kill - teardown ldisc |
| 629 | * @tty: tty being released |
| 630 | * |
| 631 | * Perform final close of the ldisc and reset tty->ldisc |
| 632 | */ |
| 633 | static void tty_ldisc_kill(struct tty_struct *tty) |
| 634 | { |
| 635 | if (!tty->ldisc) |
| 636 | return; |
| 637 | /* |
| 638 | * Now kill off the ldisc |
| 639 | */ |
| 640 | tty_ldisc_close(tty, tty->ldisc); |
| 641 | tty_ldisc_put(tty->ldisc); |
| 642 | /* Force an oops if we mess this up */ |
| 643 | tty->ldisc = NULL; |
| 644 | } |
| 645 | |
| 646 | /** |
Alan Cox | c65c9bc | 2009-06-11 12:50:12 +0100 | [diff] [blame] | 647 | * tty_reset_termios - reset terminal state |
| 648 | * @tty: tty to reset |
| 649 | * |
| 650 | * Restore a terminal to the driver default state. |
| 651 | */ |
| 652 | |
| 653 | static void tty_reset_termios(struct tty_struct *tty) |
| 654 | { |
Peter Hurley | 6a1c068 | 2013-06-15 09:14:23 -0400 | [diff] [blame] | 655 | down_write(&tty->termios_rwsem); |
Alan Cox | adc8d74 | 2012-07-14 15:31:47 +0100 | [diff] [blame] | 656 | tty->termios = tty->driver->init_termios; |
| 657 | tty->termios.c_ispeed = tty_termios_input_baud_rate(&tty->termios); |
| 658 | tty->termios.c_ospeed = tty_termios_baud_rate(&tty->termios); |
Peter Hurley | 6a1c068 | 2013-06-15 09:14:23 -0400 | [diff] [blame] | 659 | up_write(&tty->termios_rwsem); |
Alan Cox | c65c9bc | 2009-06-11 12:50:12 +0100 | [diff] [blame] | 660 | } |
| 661 | |
| 662 | |
| 663 | /** |
| 664 | * tty_ldisc_reinit - reinitialise the tty ldisc |
| 665 | * @tty: tty to reinit |
Peter Hurley | c12da96 | 2016-01-10 22:41:04 -0800 | [diff] [blame] | 666 | * @disc: line discipline to reinitialize |
Alan Cox | c65c9bc | 2009-06-11 12:50:12 +0100 | [diff] [blame] | 667 | * |
Peter Hurley | 7896f30 | 2016-01-10 22:41:05 -0800 | [diff] [blame] | 668 | * Completely reinitialize the line discipline state, by closing the |
Peter Hurley | 892d1fa | 2016-01-10 22:41:06 -0800 | [diff] [blame] | 669 | * current instance, if there is one, and opening a new instance. If |
| 670 | * an error occurs opening the new non-N_TTY instance, the instance |
| 671 | * is dropped and tty->ldisc reset to NULL. The caller can then retry |
| 672 | * with N_TTY instead. |
Peter Hurley | 7896f30 | 2016-01-10 22:41:05 -0800 | [diff] [blame] | 673 | * |
| 674 | * Returns 0 if successful, otherwise error code < 0 |
Alan Cox | c65c9bc | 2009-06-11 12:50:12 +0100 | [diff] [blame] | 675 | */ |
| 676 | |
Peter Hurley | 892d1fa | 2016-01-10 22:41:06 -0800 | [diff] [blame] | 677 | int tty_ldisc_reinit(struct tty_struct *tty, int disc) |
Alan Cox | c65c9bc | 2009-06-11 12:50:12 +0100 | [diff] [blame] | 678 | { |
Peter Hurley | 7896f30 | 2016-01-10 22:41:05 -0800 | [diff] [blame] | 679 | struct tty_ldisc *ld; |
| 680 | int retval; |
Philippe Rétornaz | 1c95ba1 | 2010-10-27 17:13:21 +0200 | [diff] [blame] | 681 | |
Peter Hurley | 7896f30 | 2016-01-10 22:41:05 -0800 | [diff] [blame] | 682 | ld = tty_ldisc_get(tty, disc); |
Greg Kroah-Hartman | a8983d0 | 2017-04-14 10:57:52 +0200 | [diff] [blame] | 683 | if (IS_ERR(ld)) { |
| 684 | BUG_ON(disc == N_TTY); |
Peter Hurley | 7896f30 | 2016-01-10 22:41:05 -0800 | [diff] [blame] | 685 | return PTR_ERR(ld); |
Greg Kroah-Hartman | a8983d0 | 2017-04-14 10:57:52 +0200 | [diff] [blame] | 686 | } |
Alan Cox | c65c9bc | 2009-06-11 12:50:12 +0100 | [diff] [blame] | 687 | |
Peter Hurley | 7896f30 | 2016-01-10 22:41:05 -0800 | [diff] [blame] | 688 | if (tty->ldisc) { |
| 689 | tty_ldisc_close(tty, tty->ldisc); |
| 690 | tty_ldisc_put(tty->ldisc); |
| 691 | } |
| 692 | |
| 693 | /* switch the line discipline */ |
Peter Hurley | f4807045 | 2013-03-11 16:44:42 -0400 | [diff] [blame] | 694 | tty->ldisc = ld; |
Peter Hurley | c12da96 | 2016-01-10 22:41:04 -0800 | [diff] [blame] | 695 | tty_set_termios_ldisc(tty, disc); |
Peter Hurley | 7896f30 | 2016-01-10 22:41:05 -0800 | [diff] [blame] | 696 | retval = tty_ldisc_open(tty, tty->ldisc); |
| 697 | if (retval) { |
Greg Kroah-Hartman | a8983d0 | 2017-04-14 10:57:52 +0200 | [diff] [blame] | 698 | if (!WARN_ON(disc == N_TTY)) { |
| 699 | tty_ldisc_put(tty->ldisc); |
| 700 | tty->ldisc = NULL; |
| 701 | } |
Peter Hurley | 7896f30 | 2016-01-10 22:41:05 -0800 | [diff] [blame] | 702 | } |
| 703 | return retval; |
Alan Cox | c65c9bc | 2009-06-11 12:50:12 +0100 | [diff] [blame] | 704 | } |
| 705 | |
| 706 | /** |
| 707 | * tty_ldisc_hangup - hangup ldisc reset |
| 708 | * @tty: tty being hung up |
| 709 | * |
| 710 | * Some tty devices reset their termios when they receive a hangup |
| 711 | * event. In that situation we must also switch back to N_TTY properly |
| 712 | * before we reset the termios data. |
| 713 | * |
| 714 | * Locking: We can take the ldisc mutex as the rest of the code is |
| 715 | * careful to allow for this. |
| 716 | * |
| 717 | * In the pty pair case this occurs in the close() path of the |
| 718 | * tty itself so we must be careful about locking rules. |
| 719 | */ |
| 720 | |
Peter Hurley | 892d1fa | 2016-01-10 22:41:06 -0800 | [diff] [blame] | 721 | void tty_ldisc_hangup(struct tty_struct *tty, bool reinit) |
Alan Cox | c65c9bc | 2009-06-11 12:50:12 +0100 | [diff] [blame] | 722 | { |
| 723 | struct tty_ldisc *ld; |
| 724 | |
Peter Hurley | a570a49 | 2016-01-10 22:41:02 -0800 | [diff] [blame] | 725 | tty_ldisc_debug(tty, "%p: hangup\n", tty->ldisc); |
Peter Hurley | fc575ee | 2013-03-11 16:44:38 -0400 | [diff] [blame] | 726 | |
Alan Cox | c65c9bc | 2009-06-11 12:50:12 +0100 | [diff] [blame] | 727 | ld = tty_ldisc_ref(tty); |
| 728 | if (ld != NULL) { |
Alan Cox | c65c9bc | 2009-06-11 12:50:12 +0100 | [diff] [blame] | 729 | if (ld->ops->flush_buffer) |
| 730 | ld->ops->flush_buffer(tty); |
| 731 | tty_driver_flush_buffer(tty); |
| 732 | if ((test_bit(TTY_DO_WRITE_WAKEUP, &tty->flags)) && |
| 733 | ld->ops->write_wakeup) |
| 734 | ld->ops->write_wakeup(tty); |
| 735 | if (ld->ops->hangup) |
| 736 | ld->ops->hangup(tty); |
| 737 | tty_ldisc_deref(ld); |
| 738 | } |
Peter Hurley | 3669752 | 2013-06-15 07:04:48 -0400 | [diff] [blame] | 739 | |
Alan Cox | c65c9bc | 2009-06-11 12:50:12 +0100 | [diff] [blame] | 740 | wake_up_interruptible_poll(&tty->write_wait, POLLOUT); |
| 741 | wake_up_interruptible_poll(&tty->read_wait, POLLIN); |
Peter Hurley | 3669752 | 2013-06-15 07:04:48 -0400 | [diff] [blame] | 742 | |
Alan Cox | c65c9bc | 2009-06-11 12:50:12 +0100 | [diff] [blame] | 743 | /* |
| 744 | * Shutdown the current line discipline, and reset it to |
Alan Cox | 638b964 | 2010-02-08 10:09:26 +0000 | [diff] [blame] | 745 | * N_TTY if need be. |
| 746 | * |
| 747 | * Avoid racing set_ldisc or tty_ldisc_release |
Alan Cox | c65c9bc | 2009-06-11 12:50:12 +0100 | [diff] [blame] | 748 | */ |
Peter Hurley | fae76e9 | 2014-11-05 12:13:07 -0500 | [diff] [blame] | 749 | tty_ldisc_lock(tty, MAX_SCHEDULE_TIMEOUT); |
Arnd Bergmann | 60af22d | 2010-06-01 22:53:06 +0200 | [diff] [blame] | 750 | |
Peter Hurley | 892d1fa | 2016-01-10 22:41:06 -0800 | [diff] [blame] | 751 | if (tty->driver->flags & TTY_DRIVER_RESET_TERMIOS) |
Alan Cox | 638b964 | 2010-02-08 10:09:26 +0000 | [diff] [blame] | 752 | tty_reset_termios(tty); |
Peter Hurley | fc575ee | 2013-03-11 16:44:38 -0400 | [diff] [blame] | 753 | |
Peter Hurley | 892d1fa | 2016-01-10 22:41:06 -0800 | [diff] [blame] | 754 | if (tty->ldisc) { |
| 755 | if (reinit) { |
| 756 | if (tty_ldisc_reinit(tty, tty->termios.c_line) < 0) |
| 757 | tty_ldisc_reinit(tty, N_TTY); |
| 758 | } else |
| 759 | tty_ldisc_kill(tty); |
| 760 | } |
| 761 | tty_ldisc_unlock(tty); |
Alan Cox | c65c9bc | 2009-06-11 12:50:12 +0100 | [diff] [blame] | 762 | } |
Alan Cox | 01e1abb | 2008-07-22 11:16:55 +0100 | [diff] [blame] | 763 | |
| 764 | /** |
| 765 | * tty_ldisc_setup - open line discipline |
| 766 | * @tty: tty being shut down |
| 767 | * @o_tty: pair tty for pty/tty pairs |
| 768 | * |
| 769 | * Called during the initial open of a tty/pty pair in order to set up the |
Alan Cox | c65c9bc | 2009-06-11 12:50:12 +0100 | [diff] [blame] | 770 | * line disciplines and bind them to the tty. This has no locking issues |
| 771 | * as the device isn't yet active. |
Alan Cox | 01e1abb | 2008-07-22 11:16:55 +0100 | [diff] [blame] | 772 | */ |
| 773 | |
| 774 | int tty_ldisc_setup(struct tty_struct *tty, struct tty_struct *o_tty) |
| 775 | { |
Peter Hurley | 9de2a7c | 2016-01-10 22:41:08 -0800 | [diff] [blame] | 776 | int retval = tty_ldisc_open(tty, tty->ldisc); |
Alan Cox | c65c9bc | 2009-06-11 12:50:12 +0100 | [diff] [blame] | 777 | if (retval) |
| 778 | return retval; |
| 779 | |
| 780 | if (o_tty) { |
| 781 | retval = tty_ldisc_open(o_tty, o_tty->ldisc); |
Alan Cox | 01e1abb | 2008-07-22 11:16:55 +0100 | [diff] [blame] | 782 | if (retval) { |
Peter Hurley | 9de2a7c | 2016-01-10 22:41:08 -0800 | [diff] [blame] | 783 | tty_ldisc_close(tty, tty->ldisc); |
Alan Cox | 01e1abb | 2008-07-22 11:16:55 +0100 | [diff] [blame] | 784 | return retval; |
| 785 | } |
Alan Cox | 01e1abb | 2008-07-22 11:16:55 +0100 | [diff] [blame] | 786 | } |
Alan Cox | 01e1abb | 2008-07-22 11:16:55 +0100 | [diff] [blame] | 787 | return 0; |
| 788 | } |
Alan Cox | 89c8d91 | 2012-08-08 16:30:13 +0100 | [diff] [blame] | 789 | |
Alan Cox | 01e1abb | 2008-07-22 11:16:55 +0100 | [diff] [blame] | 790 | /** |
| 791 | * tty_ldisc_release - release line discipline |
Peter Hurley | 62462ae | 2014-11-05 12:12:58 -0500 | [diff] [blame] | 792 | * @tty: tty being shut down (or one end of pty pair) |
Alan Cox | 01e1abb | 2008-07-22 11:16:55 +0100 | [diff] [blame] | 793 | * |
Peter Hurley | 62462ae | 2014-11-05 12:12:58 -0500 | [diff] [blame] | 794 | * Called during the final close of a tty or a pty pair in order to shut |
Peter Hurley | 5b6e683 | 2016-01-10 22:41:00 -0800 | [diff] [blame] | 795 | * down the line discpline layer. On exit, each tty's ldisc is NULL. |
Alan Cox | 01e1abb | 2008-07-22 11:16:55 +0100 | [diff] [blame] | 796 | */ |
| 797 | |
Peter Hurley | 62462ae | 2014-11-05 12:12:58 -0500 | [diff] [blame] | 798 | void tty_ldisc_release(struct tty_struct *tty) |
Alan Cox | 01e1abb | 2008-07-22 11:16:55 +0100 | [diff] [blame] | 799 | { |
Peter Hurley | 62462ae | 2014-11-05 12:12:58 -0500 | [diff] [blame] | 800 | struct tty_struct *o_tty = tty->link; |
| 801 | |
Alan Cox | 01e1abb | 2008-07-22 11:16:55 +0100 | [diff] [blame] | 802 | /* |
Peter Hurley | a2965b7 | 2013-03-11 16:44:35 -0400 | [diff] [blame] | 803 | * Shutdown this line discipline. As this is the final close, |
| 804 | * it does not race with the set_ldisc code path. |
Alan Cox | 01e1abb | 2008-07-22 11:16:55 +0100 | [diff] [blame] | 805 | */ |
Alan Cox | 01e1abb | 2008-07-22 11:16:55 +0100 | [diff] [blame] | 806 | |
Peter Hurley | 3669752 | 2013-06-15 07:04:48 -0400 | [diff] [blame] | 807 | tty_ldisc_lock_pair(tty, o_tty); |
Alan Cox | 89c8d91 | 2012-08-08 16:30:13 +0100 | [diff] [blame] | 808 | tty_ldisc_kill(tty); |
Alan Cox | 89c8d91 | 2012-08-08 16:30:13 +0100 | [diff] [blame] | 809 | if (o_tty) |
| 810 | tty_ldisc_kill(o_tty); |
Peter Hurley | 3669752 | 2013-06-15 07:04:48 -0400 | [diff] [blame] | 811 | tty_ldisc_unlock_pair(tty, o_tty); |
| 812 | |
Alan Cox | aef29bc | 2009-06-29 15:21:47 +0100 | [diff] [blame] | 813 | /* And the memory resources remaining (buffers, termios) will be |
| 814 | disposed of when the kref hits zero */ |
Peter Hurley | fc575ee | 2013-03-11 16:44:38 -0400 | [diff] [blame] | 815 | |
Peter Hurley | fb6edc9 | 2015-07-12 22:49:12 -0400 | [diff] [blame] | 816 | tty_ldisc_debug(tty, "released\n"); |
Alan Cox | 01e1abb | 2008-07-22 11:16:55 +0100 | [diff] [blame] | 817 | } |
Okash Khawaja | 1ab92da | 2017-05-15 18:45:33 +0100 | [diff] [blame] | 818 | EXPORT_SYMBOL_GPL(tty_ldisc_release); |
Alan Cox | 01e1abb | 2008-07-22 11:16:55 +0100 | [diff] [blame] | 819 | |
| 820 | /** |
| 821 | * tty_ldisc_init - ldisc setup for new tty |
| 822 | * @tty: tty being allocated |
| 823 | * |
| 824 | * Set up the line discipline objects for a newly allocated tty. Note that |
| 825 | * the tty structure is not completely set up when this call is made. |
| 826 | */ |
| 827 | |
| 828 | void tty_ldisc_init(struct tty_struct *tty) |
| 829 | { |
Peter Hurley | 3669752 | 2013-06-15 07:04:48 -0400 | [diff] [blame] | 830 | struct tty_ldisc *ld = tty_ldisc_get(tty, N_TTY); |
Alan Cox | c65c9bc | 2009-06-11 12:50:12 +0100 | [diff] [blame] | 831 | if (IS_ERR(ld)) |
Alan Cox | 01e1abb | 2008-07-22 11:16:55 +0100 | [diff] [blame] | 832 | panic("n_tty: init_tty"); |
Peter Hurley | f4807045 | 2013-03-11 16:44:42 -0400 | [diff] [blame] | 833 | tty->ldisc = ld; |
Alan Cox | 01e1abb | 2008-07-22 11:16:55 +0100 | [diff] [blame] | 834 | } |
| 835 | |
Jiri Slaby | 6716671 | 2011-03-23 10:48:35 +0100 | [diff] [blame] | 836 | /** |
Peter Hurley | c8b710b | 2016-01-09 21:13:46 -0800 | [diff] [blame] | 837 | * tty_ldisc_deinit - ldisc cleanup for new tty |
Jiri Slaby | 6716671 | 2011-03-23 10:48:35 +0100 | [diff] [blame] | 838 | * @tty: tty that was allocated recently |
| 839 | * |
| 840 | * The tty structure must not becompletely set up (tty_ldisc_setup) when |
| 841 | * this call is made. |
| 842 | */ |
| 843 | void tty_ldisc_deinit(struct tty_struct *tty) |
| 844 | { |
Peter Hurley | c8b710b | 2016-01-09 21:13:46 -0800 | [diff] [blame] | 845 | if (tty->ldisc) |
| 846 | tty_ldisc_put(tty->ldisc); |
Peter Hurley | f4807045 | 2013-03-11 16:44:42 -0400 | [diff] [blame] | 847 | tty->ldisc = NULL; |
Jiri Slaby | 6716671 | 2011-03-23 10:48:35 +0100 | [diff] [blame] | 848 | } |