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