blob: 776d8a62f77cc8374ebea10901c7b988a8d71d02 [file] [log] [blame]
Greg Kroah-Hartmane3b3d0f2017-11-06 18:11:51 +01001// SPDX-License-Identifier: GPL-2.0
Alan Cox01e1abb2008-07-22 11:16:55 +01002#include <linux/types.h>
Alan Cox01e1abb2008-07-22 11:16:55 +01003#include <linux/errno.h>
Jiri Slaby8b3ffa12011-11-16 16:27:10 +01004#include <linux/kmod.h>
Alan Cox01e1abb2008-07-22 11:16:55 +01005#include <linux/sched.h>
6#include <linux/interrupt.h>
7#include <linux/tty.h>
8#include <linux/tty_driver.h>
Alan Cox01e1abb2008-07-22 11:16:55 +01009#include <linux/file.h>
Alan Cox01e1abb2008-07-22 11:16:55 +010010#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 Cox01e1abb2008-07-22 11:16:55 +010015#include <linux/module.h>
Alan Cox01e1abb2008-07-22 11:16:55 +010016#include <linux/device.h>
17#include <linux/wait.h>
18#include <linux/bitops.h>
Alan Cox01e1abb2008-07-22 11:16:55 +010019#include <linux/seq_file.h>
Alan Cox01e1abb2008-07-22 11:16:55 +010020#include <linux/uaccess.h>
Jiri Slaby0c73c082011-11-16 16:27:09 +010021#include <linux/ratelimit.h>
Greg Kroah-Hartman98602c02021-04-08 14:51:22 +020022#include "tty.h"
Alan Cox01e1abb2008-07-22 11:16:55 +010023
Peter Hurleyfc575ee2013-03-11 16:44:38 -040024#undef LDISC_DEBUG_HANGUP
25
26#ifdef LDISC_DEBUG_HANGUP
Peter Hurley0a6adc12015-07-12 22:49:10 -040027#define tty_ldisc_debug(tty, f, args...) tty_debug(tty, f, ##args)
Peter Hurleyfc575ee2013-03-11 16:44:38 -040028#else
29#define tty_ldisc_debug(tty, f, args...)
30#endif
31
Peter Hurleyd2c43892013-06-15 07:04:47 -040032/* lockdep nested classes for tty->ldisc_sem */
33enum {
34 LDISC_SEM_NORMAL,
35 LDISC_SEM_OTHER,
36};
37
38
Alan Cox01e1abb2008-07-22 11:16:55 +010039/*
40 * This guards the refcounted line discipline lists. The lock
41 * must be taken with irqs off because there are hangup path
42 * callers who will do ldisc lookups and cannot sleep.
43 */
44
Peter Hurley137084b2013-06-15 07:04:46 -040045static DEFINE_RAW_SPINLOCK(tty_ldiscs_lock);
Alan Cox01e1abb2008-07-22 11:16:55 +010046/* Line disc dispatch table */
47static struct tty_ldisc_ops *tty_ldiscs[NR_LDISCS];
48
49/**
Jiri Slabycbb68f92021-11-26 09:16:01 +010050 * tty_register_ldisc - install a line discipline
51 * @new_ldisc: pointer to the ldisc object
Alan Cox01e1abb2008-07-22 11:16:55 +010052 *
Jiri Slabycbb68f92021-11-26 09:16:01 +010053 * Installs a new line discipline into the kernel. The discipline is set up as
54 * unreferenced and then made available to the kernel from this point onwards.
Alan Cox01e1abb2008-07-22 11:16:55 +010055 *
Jiri Slabycbb68f92021-11-26 09:16:01 +010056 * Locking: takes %tty_ldiscs_lock to guard against ldisc races
Alan Cox01e1abb2008-07-22 11:16:55 +010057 */
Jiri Slabyfbadf70a2021-05-05 11:19:07 +020058int tty_register_ldisc(struct tty_ldisc_ops *new_ldisc)
Alan Cox01e1abb2008-07-22 11:16:55 +010059{
60 unsigned long flags;
61 int ret = 0;
62
Jiri Slabyfbadf70a2021-05-05 11:19:07 +020063 if (new_ldisc->num < N_TTY || new_ldisc->num >= NR_LDISCS)
Alan Cox01e1abb2008-07-22 11:16:55 +010064 return -EINVAL;
65
Peter Hurley137084b2013-06-15 07:04:46 -040066 raw_spin_lock_irqsave(&tty_ldiscs_lock, flags);
Jiri Slabyfbadf70a2021-05-05 11:19:07 +020067 tty_ldiscs[new_ldisc->num] = new_ldisc;
Peter Hurley137084b2013-06-15 07:04:46 -040068 raw_spin_unlock_irqrestore(&tty_ldiscs_lock, flags);
Alan Cox01e1abb2008-07-22 11:16:55 +010069
70 return ret;
71}
72EXPORT_SYMBOL(tty_register_ldisc);
73
74/**
Jiri Slabycbb68f92021-11-26 09:16:01 +010075 * tty_unregister_ldisc - unload a line discipline
76 * @ldisc: ldisc number
Alan Cox01e1abb2008-07-22 11:16:55 +010077 *
Jiri Slabycbb68f92021-11-26 09:16:01 +010078 * Remove a line discipline from the kernel providing it is not currently in
79 * use.
Alan Cox01e1abb2008-07-22 11:16:55 +010080 *
Jiri Slabycbb68f92021-11-26 09:16:01 +010081 * Locking: takes %tty_ldiscs_lock to guard against ldisc races
Alan Cox01e1abb2008-07-22 11:16:55 +010082 */
83
Jiri Slabyf6f19592021-05-05 11:19:12 +020084void tty_unregister_ldisc(struct tty_ldisc_ops *ldisc)
Alan Cox01e1abb2008-07-22 11:16:55 +010085{
86 unsigned long flags;
Alan Cox01e1abb2008-07-22 11:16:55 +010087
Peter Hurley137084b2013-06-15 07:04:46 -040088 raw_spin_lock_irqsave(&tty_ldiscs_lock, flags);
Jiri Slaby19475202021-05-05 11:19:10 +020089 tty_ldiscs[ldisc->num] = NULL;
Peter Hurley137084b2013-06-15 07:04:46 -040090 raw_spin_unlock_irqrestore(&tty_ldiscs_lock, flags);
Alan Cox01e1abb2008-07-22 11:16:55 +010091}
92EXPORT_SYMBOL(tty_unregister_ldisc);
93
Linus Torvaldsf0de0e82009-08-03 16:00:15 -070094static struct tty_ldisc_ops *get_ldops(int disc)
95{
96 unsigned long flags;
97 struct tty_ldisc_ops *ldops, *ret;
98
Peter Hurley137084b2013-06-15 07:04:46 -040099 raw_spin_lock_irqsave(&tty_ldiscs_lock, flags);
Linus Torvaldsf0de0e82009-08-03 16:00:15 -0700100 ret = ERR_PTR(-EINVAL);
101 ldops = tty_ldiscs[disc];
102 if (ldops) {
103 ret = ERR_PTR(-EAGAIN);
Jiri Slaby19475202021-05-05 11:19:10 +0200104 if (try_module_get(ldops->owner))
Linus Torvaldsf0de0e82009-08-03 16:00:15 -0700105 ret = ldops;
Linus Torvaldsf0de0e82009-08-03 16:00:15 -0700106 }
Peter Hurley137084b2013-06-15 07:04:46 -0400107 raw_spin_unlock_irqrestore(&tty_ldiscs_lock, flags);
Linus Torvaldsf0de0e82009-08-03 16:00:15 -0700108 return ret;
109}
110
111static void put_ldops(struct tty_ldisc_ops *ldops)
112{
113 unsigned long flags;
114
Peter Hurley137084b2013-06-15 07:04:46 -0400115 raw_spin_lock_irqsave(&tty_ldiscs_lock, flags);
Linus Torvaldsf0de0e82009-08-03 16:00:15 -0700116 module_put(ldops->owner);
Peter Hurley137084b2013-06-15 07:04:46 -0400117 raw_spin_unlock_irqrestore(&tty_ldiscs_lock, flags);
Linus Torvaldsf0de0e82009-08-03 16:00:15 -0700118}
Alan Cox01e1abb2008-07-22 11:16:55 +0100119
Lee Jones8eddcca2020-11-12 10:58:54 +0000120static int tty_ldisc_autoload = IS_BUILTIN(CONFIG_LDISC_AUTOLOAD);
Alan Cox01e1abb2008-07-22 11:16:55 +0100121
Jiri Slabycbb68f92021-11-26 09:16:01 +0100122/**
123 * tty_ldisc_get - take a reference to an ldisc
124 * @tty: tty device
125 * @disc: ldisc number
126 *
127 * Takes a reference to a line discipline. Deals with refcounts and module
128 * locking counts. If the discipline is not available, its module loaded, if
129 * possible.
130 *
131 * Returns:
132 * * -%EINVAL if the discipline index is not [%N_TTY .. %NR_LDISCS] or if the
133 * discipline is not registered
134 * * -%EAGAIN if request_module() failed to load or register the discipline
135 * * -%ENOMEM if allocation failure
136 * * Otherwise, returns a pointer to the discipline and bumps the ref count
137 *
138 * Locking: takes %tty_ldiscs_lock to guard against ldisc races
139 */
Peter Hurley36697522013-06-15 07:04:48 -0400140static struct tty_ldisc *tty_ldisc_get(struct tty_struct *tty, int disc)
Alan Cox01e1abb2008-07-22 11:16:55 +0100141{
Alan Coxc65c9bc2009-06-11 12:50:12 +0100142 struct tty_ldisc *ld;
Linus Torvalds182274f2009-08-03 16:01:28 -0700143 struct tty_ldisc_ops *ldops;
Alan Cox01e1abb2008-07-22 11:16:55 +0100144
145 if (disc < N_TTY || disc >= NR_LDISCS)
Alan Coxc65c9bc2009-06-11 12:50:12 +0100146 return ERR_PTR(-EINVAL);
Linus Torvalds182274f2009-08-03 16:01:28 -0700147
148 /*
149 * Get the ldisc ops - we may need to request them to be loaded
150 * dynamically and try again.
151 */
152 ldops = get_ldops(disc);
153 if (IS_ERR(ldops)) {
Greg Kroah-Hartman7c0cca72019-01-21 17:26:42 +0100154 if (!capable(CAP_SYS_MODULE) && !tty_ldisc_autoload)
155 return ERR_PTR(-EPERM);
Alan Cox01e1abb2008-07-22 11:16:55 +0100156 request_module("tty-ldisc-%d", disc);
Linus Torvalds182274f2009-08-03 16:01:28 -0700157 ldops = get_ldops(disc);
158 if (IS_ERR(ldops))
159 return ERR_CAST(ldops);
Alan Cox01e1abb2008-07-22 11:16:55 +0100160 }
Linus Torvalds182274f2009-08-03 16:01:28 -0700161
Tetsuo Handabcdd0ca2018-04-25 20:12:31 +0900162 /*
163 * There is no way to handle allocation failure of only 16 bytes.
164 * Let's simplify error handling and save more memory.
165 */
166 ld = kmalloc(sizeof(struct tty_ldisc), GFP_KERNEL | __GFP_NOFAIL);
Linus Torvalds182274f2009-08-03 16:01:28 -0700167 ld->ops = ldops;
Peter Hurley36697522013-06-15 07:04:48 -0400168 ld->tty = tty;
Ivo Sieben1541f842012-05-03 14:37:43 +0200169
Alan Coxc65c9bc2009-06-11 12:50:12 +0100170 return ld;
Alan Cox01e1abb2008-07-22 11:16:55 +0100171}
172
Jiri Slabycbb68f92021-11-26 09:16:01 +0100173/**
174 * tty_ldisc_put - release the ldisc
175 * @ld: lisdsc to release
Peter Hurley734de242013-03-11 16:44:43 -0400176 *
Jiri Slabycbb68f92021-11-26 09:16:01 +0100177 * Complement of tty_ldisc_get().
Peter Hurley734de242013-03-11 16:44:43 -0400178 */
Denys Vlasenkocb128f62015-10-27 17:40:02 +0100179static void tty_ldisc_put(struct tty_ldisc *ld)
Peter Hurley734de242013-03-11 16:44:43 -0400180{
Peter Hurley734de242013-03-11 16:44:43 -0400181 if (WARN_ON_ONCE(!ld))
182 return;
183
Peter Hurley36697522013-06-15 07:04:48 -0400184 put_ldops(ld->ops);
Peter Hurley734de242013-03-11 16:44:43 -0400185 kfree(ld);
Peter Hurley734de242013-03-11 16:44:43 -0400186}
187
Alan Cox852e99d2009-06-11 12:51:41 +0100188static void *tty_ldiscs_seq_start(struct seq_file *m, loff_t *pos)
Alan Cox01e1abb2008-07-22 11:16:55 +0100189{
190 return (*pos < NR_LDISCS) ? pos : NULL;
191}
192
Alan Cox852e99d2009-06-11 12:51:41 +0100193static void *tty_ldiscs_seq_next(struct seq_file *m, void *v, loff_t *pos)
Alan Cox01e1abb2008-07-22 11:16:55 +0100194{
195 (*pos)++;
196 return (*pos < NR_LDISCS) ? pos : NULL;
197}
198
199static void tty_ldiscs_seq_stop(struct seq_file *m, void *v)
200{
201}
202
203static int tty_ldiscs_seq_show(struct seq_file *m, void *v)
204{
205 int i = *(loff_t *)v;
Linus Torvaldsf0de0e82009-08-03 16:00:15 -0700206 struct tty_ldisc_ops *ldops;
Alan Cox852e99d2009-06-11 12:51:41 +0100207
Linus Torvaldsf0de0e82009-08-03 16:00:15 -0700208 ldops = get_ldops(i);
209 if (IS_ERR(ldops))
Alan Cox01e1abb2008-07-22 11:16:55 +0100210 return 0;
Linus Torvaldsf0de0e82009-08-03 16:00:15 -0700211 seq_printf(m, "%-10s %2d\n", ldops->name ? ldops->name : "???", i);
212 put_ldops(ldops);
Alan Cox01e1abb2008-07-22 11:16:55 +0100213 return 0;
214}
215
Christoph Hellwigfddda2b2018-04-13 19:44:18 +0200216const struct seq_operations tty_ldiscs_seq_ops = {
Alan Cox01e1abb2008-07-22 11:16:55 +0100217 .start = tty_ldiscs_seq_start,
218 .next = tty_ldiscs_seq_next,
219 .stop = tty_ldiscs_seq_stop,
220 .show = tty_ldiscs_seq_show,
221};
222
Alan Cox01e1abb2008-07-22 11:16:55 +0100223/**
Jiri Slabycbb68f92021-11-26 09:16:01 +0100224 * tty_ldisc_ref_wait - wait for the tty ldisc
225 * @tty: tty device
Alan Cox01e1abb2008-07-22 11:16:55 +0100226 *
Jiri Slabycbb68f92021-11-26 09:16:01 +0100227 * Dereference the line discipline for the terminal and take a reference to it.
228 * If the line discipline is in flux then wait patiently until it changes.
Alan Cox01e1abb2008-07-22 11:16:55 +0100229 *
Jiri Slabycbb68f92021-11-26 09:16:01 +0100230 * Returns: %NULL if the tty has been hungup and not re-opened with a new file
231 * descriptor, otherwise valid ldisc reference
Peter Hurley892d1fa2016-01-10 22:41:06 -0800232 *
Jiri Slabycbb68f92021-11-26 09:16:01 +0100233 * Note 1: Must not be called from an IRQ/timer context. The caller must also
234 * be careful not to hold other locks that will deadlock against a discipline
235 * change, such as an existing ldisc reference (which we check for).
Alan Cox01e1abb2008-07-22 11:16:55 +0100236 *
Jiri Slabycbb68f92021-11-26 09:16:01 +0100237 * Note 2: a file_operations routine (read/poll/write) should use this function
238 * to wait for any ldisc lifetime events to finish.
Alan Cox01e1abb2008-07-22 11:16:55 +0100239 */
Alan Cox01e1abb2008-07-22 11:16:55 +0100240struct tty_ldisc *tty_ldisc_ref_wait(struct tty_struct *tty)
241{
Dmitry Vyukova4a3e062017-03-04 13:46:12 +0100242 struct tty_ldisc *ld;
243
Peter Hurley36697522013-06-15 07:04:48 -0400244 ldsem_down_read(&tty->ldisc_sem, MAX_SCHEDULE_TIMEOUT);
Dmitry Vyukova4a3e062017-03-04 13:46:12 +0100245 ld = tty->ldisc;
246 if (!ld)
Peter Hurleya570a492016-01-10 22:41:02 -0800247 ldsem_up_read(&tty->ldisc_sem);
Dmitry Vyukova4a3e062017-03-04 13:46:12 +0100248 return ld;
Alan Cox01e1abb2008-07-22 11:16:55 +0100249}
Alan Cox01e1abb2008-07-22 11:16:55 +0100250EXPORT_SYMBOL_GPL(tty_ldisc_ref_wait);
251
252/**
Jiri Slabycbb68f92021-11-26 09:16:01 +0100253 * tty_ldisc_ref - get the tty ldisc
254 * @tty: tty device
Alan Cox01e1abb2008-07-22 11:16:55 +0100255 *
Jiri Slabycbb68f92021-11-26 09:16:01 +0100256 * Dereference the line discipline for the terminal and take a reference to it.
257 * If the line discipline is in flux then return %NULL. Can be called from IRQ
258 * and timer functions.
Alan Cox01e1abb2008-07-22 11:16:55 +0100259 */
Alan Cox01e1abb2008-07-22 11:16:55 +0100260struct tty_ldisc *tty_ldisc_ref(struct tty_struct *tty)
261{
Peter Hurley36697522013-06-15 07:04:48 -0400262 struct tty_ldisc *ld = NULL;
263
264 if (ldsem_down_read_trylock(&tty->ldisc_sem)) {
265 ld = tty->ldisc;
266 if (!ld)
267 ldsem_up_read(&tty->ldisc_sem);
268 }
269 return ld;
Alan Cox01e1abb2008-07-22 11:16:55 +0100270}
Alan Cox01e1abb2008-07-22 11:16:55 +0100271EXPORT_SYMBOL_GPL(tty_ldisc_ref);
272
273/**
Jiri Slabycbb68f92021-11-26 09:16:01 +0100274 * tty_ldisc_deref - free a tty ldisc reference
275 * @ld: reference to free up
Alan Cox01e1abb2008-07-22 11:16:55 +0100276 *
Jiri Slabycbb68f92021-11-26 09:16:01 +0100277 * Undoes the effect of tty_ldisc_ref() or tty_ldisc_ref_wait(). May be called
278 * in IRQ context.
Alan Cox01e1abb2008-07-22 11:16:55 +0100279 */
Alan Cox01e1abb2008-07-22 11:16:55 +0100280void tty_ldisc_deref(struct tty_ldisc *ld)
281{
Peter Hurley36697522013-06-15 07:04:48 -0400282 ldsem_up_read(&ld->tty->ldisc_sem);
Alan Cox01e1abb2008-07-22 11:16:55 +0100283}
Alan Cox01e1abb2008-07-22 11:16:55 +0100284EXPORT_SYMBOL_GPL(tty_ldisc_deref);
285
Peter Hurleyd2c43892013-06-15 07:04:47 -0400286
Peter Hurleyc2bb5242016-01-09 21:13:51 -0800287static inline int
Peter Hurleye80a10e2014-11-05 12:13:06 -0500288__tty_ldisc_lock(struct tty_struct *tty, unsigned long timeout)
Peter Hurleyd2c43892013-06-15 07:04:47 -0400289{
290 return ldsem_down_write(&tty->ldisc_sem, timeout);
291}
292
Peter Hurleyc2bb5242016-01-09 21:13:51 -0800293static inline int
Peter Hurleye80a10e2014-11-05 12:13:06 -0500294__tty_ldisc_lock_nested(struct tty_struct *tty, unsigned long timeout)
Peter Hurleyd2c43892013-06-15 07:04:47 -0400295{
296 return ldsem_down_write_nested(&tty->ldisc_sem,
297 LDISC_SEM_OTHER, timeout);
298}
299
Peter Hurleye80a10e2014-11-05 12:13:06 -0500300static inline void __tty_ldisc_unlock(struct tty_struct *tty)
Peter Hurleyd2c43892013-06-15 07:04:47 -0400301{
Guillaume Gomez52772ea2015-10-04 21:19:18 +0200302 ldsem_up_write(&tty->ldisc_sem);
Peter Hurleyd2c43892013-06-15 07:04:47 -0400303}
304
Gaurav Kohlib027e222018-01-23 13:16:34 +0530305int tty_ldisc_lock(struct tty_struct *tty, unsigned long timeout)
Peter Hurleyfae76e92014-11-05 12:13:07 -0500306{
307 int ret;
308
Dmitry Safonovc96cf922018-11-01 00:24:48 +0000309 /* Kindly asking blocked readers to release the read side */
310 set_bit(TTY_LDISC_CHANGING, &tty->flags);
311 wake_up_interruptible_all(&tty->read_wait);
312 wake_up_interruptible_all(&tty->write_wait);
313
Peter Hurleyfae76e92014-11-05 12:13:07 -0500314 ret = __tty_ldisc_lock(tty, timeout);
315 if (!ret)
316 return -EBUSY;
317 set_bit(TTY_LDISC_HALTED, &tty->flags);
318 return 0;
319}
320
Gaurav Kohlib027e222018-01-23 13:16:34 +0530321void tty_ldisc_unlock(struct tty_struct *tty)
Peter Hurleyfae76e92014-11-05 12:13:07 -0500322{
323 clear_bit(TTY_LDISC_HALTED, &tty->flags);
Dmitry Safonovc96cf922018-11-01 00:24:48 +0000324 /* Can be cleared here - ldisc_unlock will wake up writers firstly */
325 clear_bit(TTY_LDISC_CHANGING, &tty->flags);
Peter Hurleyfae76e92014-11-05 12:13:07 -0500326 __tty_ldisc_unlock(tty);
327}
328
Peter Hurleyc2bb5242016-01-09 21:13:51 -0800329static int
Peter Hurleyd2c43892013-06-15 07:04:47 -0400330tty_ldisc_lock_pair_timeout(struct tty_struct *tty, struct tty_struct *tty2,
331 unsigned long timeout)
332{
333 int ret;
334
335 if (tty < tty2) {
Peter Hurleye80a10e2014-11-05 12:13:06 -0500336 ret = __tty_ldisc_lock(tty, timeout);
Peter Hurleyd2c43892013-06-15 07:04:47 -0400337 if (ret) {
Peter Hurleye80a10e2014-11-05 12:13:06 -0500338 ret = __tty_ldisc_lock_nested(tty2, timeout);
Peter Hurleyd2c43892013-06-15 07:04:47 -0400339 if (!ret)
Peter Hurleye80a10e2014-11-05 12:13:06 -0500340 __tty_ldisc_unlock(tty);
Peter Hurleyd2c43892013-06-15 07:04:47 -0400341 }
342 } else {
343 /* if this is possible, it has lots of implications */
344 WARN_ON_ONCE(tty == tty2);
345 if (tty2 && tty != tty2) {
Peter Hurleye80a10e2014-11-05 12:13:06 -0500346 ret = __tty_ldisc_lock(tty2, timeout);
Peter Hurleyd2c43892013-06-15 07:04:47 -0400347 if (ret) {
Peter Hurleye80a10e2014-11-05 12:13:06 -0500348 ret = __tty_ldisc_lock_nested(tty, timeout);
Peter Hurleyd2c43892013-06-15 07:04:47 -0400349 if (!ret)
Peter Hurleye80a10e2014-11-05 12:13:06 -0500350 __tty_ldisc_unlock(tty2);
Peter Hurleyd2c43892013-06-15 07:04:47 -0400351 }
352 } else
Peter Hurleye80a10e2014-11-05 12:13:06 -0500353 ret = __tty_ldisc_lock(tty, timeout);
Peter Hurleyd2c43892013-06-15 07:04:47 -0400354 }
355
356 if (!ret)
357 return -EBUSY;
358
359 set_bit(TTY_LDISC_HALTED, &tty->flags);
360 if (tty2)
361 set_bit(TTY_LDISC_HALTED, &tty2->flags);
362 return 0;
363}
364
Peter Hurleyc2bb5242016-01-09 21:13:51 -0800365static void tty_ldisc_lock_pair(struct tty_struct *tty, struct tty_struct *tty2)
Peter Hurleyd2c43892013-06-15 07:04:47 -0400366{
367 tty_ldisc_lock_pair_timeout(tty, tty2, MAX_SCHEDULE_TIMEOUT);
368}
369
Peter Hurleyc2bb5242016-01-09 21:13:51 -0800370static void tty_ldisc_unlock_pair(struct tty_struct *tty,
371 struct tty_struct *tty2)
Peter Hurleyd2c43892013-06-15 07:04:47 -0400372{
Peter Hurleye80a10e2014-11-05 12:13:06 -0500373 __tty_ldisc_unlock(tty);
Peter Hurleyd2c43892013-06-15 07:04:47 -0400374 if (tty2)
Peter Hurleye80a10e2014-11-05 12:13:06 -0500375 __tty_ldisc_unlock(tty2);
Peter Hurleyd2c43892013-06-15 07:04:47 -0400376}
377
Alan Cox01e1abb2008-07-22 11:16:55 +0100378/**
Jiri Slabycbb68f92021-11-26 09:16:01 +0100379 * tty_ldisc_flush - flush line discipline queue
380 * @tty: tty to flush ldisc for
Alan Coxf2c4c652009-06-11 12:50:58 +0100381 *
Jiri Slabycbb68f92021-11-26 09:16:01 +0100382 * Flush the line discipline queue (if any) and the tty flip buffers for this
383 * @tty.
Alan Coxf2c4c652009-06-11 12:50:58 +0100384 */
Alan Coxf2c4c652009-06-11 12:50:58 +0100385void tty_ldisc_flush(struct tty_struct *tty)
386{
387 struct tty_ldisc *ld = tty_ldisc_ref(tty);
Peter Hurley86c80a82014-11-05 12:13:09 -0500388
389 tty_buffer_flush(tty, ld);
390 if (ld)
Alan Coxf2c4c652009-06-11 12:50:58 +0100391 tty_ldisc_deref(ld);
Alan Coxf2c4c652009-06-11 12:50:58 +0100392}
Alan Coxf2c4c652009-06-11 12:50:58 +0100393EXPORT_SYMBOL_GPL(tty_ldisc_flush);
394
395/**
Jiri Slabycbb68f92021-11-26 09:16:01 +0100396 * tty_set_termios_ldisc - set ldisc field
397 * @tty: tty structure
398 * @disc: line discipline number
Alan Cox01e1abb2008-07-22 11:16:55 +0100399 *
Jiri Slabycbb68f92021-11-26 09:16:01 +0100400 * This is probably overkill for real world processors but they are not on hot
401 * paths so a little discipline won't do any harm.
Alan Cox01e1abb2008-07-22 11:16:55 +0100402 *
Jiri Slabycbb68f92021-11-26 09:16:01 +0100403 * The line discipline-related tty_struct fields are reset to prevent the ldisc
404 * driver from re-using stale information for the new ldisc instance.
Peter Hurleydd42bf12015-11-27 14:30:21 -0500405 *
Jiri Slabycbb68f92021-11-26 09:16:01 +0100406 * Locking: takes termios_rwsem
Alan Cox01e1abb2008-07-22 11:16:55 +0100407 */
Peter Hurleyc12da962016-01-10 22:41:04 -0800408static void tty_set_termios_ldisc(struct tty_struct *tty, int disc)
Alan Cox01e1abb2008-07-22 11:16:55 +0100409{
Peter Hurley6a1c0682013-06-15 09:14:23 -0400410 down_write(&tty->termios_rwsem);
Peter Hurleyc12da962016-01-10 22:41:04 -0800411 tty->termios.c_line = disc;
Peter Hurley6a1c0682013-06-15 09:14:23 -0400412 up_write(&tty->termios_rwsem);
Peter Hurleydd42bf12015-11-27 14:30:21 -0500413
414 tty->disc_data = NULL;
415 tty->receive_room = 0;
Alan Cox01e1abb2008-07-22 11:16:55 +0100416}
417
Alan Coxc65c9bc2009-06-11 12:50:12 +0100418/**
Jiri Slabycbb68f92021-11-26 09:16:01 +0100419 * tty_ldisc_open - open a line discipline
420 * @tty: tty we are opening the ldisc on
421 * @ld: discipline to open
Alan Coxc65c9bc2009-06-11 12:50:12 +0100422 *
Jiri Slabycbb68f92021-11-26 09:16:01 +0100423 * A helper opening method. Also a convenient debugging and check point.
Arnd Bergmannec79d602010-06-01 22:53:01 +0200424 *
Jiri Slabycbb68f92021-11-26 09:16:01 +0100425 * Locking: always called with BTM already held.
Alan Coxc65c9bc2009-06-11 12:50:12 +0100426 */
Alan Coxc65c9bc2009-06-11 12:50:12 +0100427static int tty_ldisc_open(struct tty_struct *tty, struct tty_ldisc *ld)
428{
429 WARN_ON(test_and_set_bit(TTY_LDISC_OPEN, &tty->flags));
Alan Coxf18f9492009-11-30 13:18:35 +0000430 if (ld->ops->open) {
431 int ret;
Xiaofei Tan5d3945e2021-04-07 15:06:46 +0800432 /* BTM here locks versus a hangup event */
Alan Coxf18f9492009-11-30 13:18:35 +0000433 ret = ld->ops->open(tty);
Jiri Slaby7f90cfc2010-11-25 00:27:54 +0100434 if (ret)
435 clear_bit(TTY_LDISC_OPEN, &tty->flags);
Peter Hurleyfb6edc92015-07-12 22:49:12 -0400436
Peter Hurleya570a492016-01-10 22:41:02 -0800437 tty_ldisc_debug(tty, "%p: opened\n", ld);
Alan Coxf18f9492009-11-30 13:18:35 +0000438 return ret;
439 }
Alan Coxc65c9bc2009-06-11 12:50:12 +0100440 return 0;
441}
442
443/**
Jiri Slabycbb68f92021-11-26 09:16:01 +0100444 * tty_ldisc_close - close a line discipline
445 * @tty: tty we are opening the ldisc on
446 * @ld: discipline to close
Alan Coxc65c9bc2009-06-11 12:50:12 +0100447 *
Jiri Slabycbb68f92021-11-26 09:16:01 +0100448 * A helper close method. Also a convenient debugging and check point.
Alan Coxc65c9bc2009-06-11 12:50:12 +0100449 */
Alan Coxc65c9bc2009-06-11 12:50:12 +0100450static void tty_ldisc_close(struct tty_struct *tty, struct tty_ldisc *ld)
451{
Nikolay Borisov9ffbe8a2019-05-31 13:06:51 +0300452 lockdep_assert_held_write(&tty->ldisc_sem);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100453 WARN_ON(!test_bit(TTY_LDISC_OPEN, &tty->flags));
454 clear_bit(TTY_LDISC_OPEN, &tty->flags);
455 if (ld->ops->close)
456 ld->ops->close(tty);
Peter Hurleya570a492016-01-10 22:41:02 -0800457 tty_ldisc_debug(tty, "%p: closed\n", ld);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100458}
Alan Cox01e1abb2008-07-22 11:16:55 +0100459
460/**
Jiri Slabycbb68f92021-11-26 09:16:01 +0100461 * tty_ldisc_failto - helper for ldisc failback
462 * @tty: tty to open the ldisc on
463 * @ld: ldisc we are trying to fail back to
Alan Cox8a8dabf2017-06-02 13:49:30 +0100464 *
Jiri Slabycbb68f92021-11-26 09:16:01 +0100465 * Helper to try and recover a tty when switching back to the old ldisc fails
466 * and we need something attached.
Alan Cox8a8dabf2017-06-02 13:49:30 +0100467 */
Alan Cox8a8dabf2017-06-02 13:49:30 +0100468static int tty_ldisc_failto(struct tty_struct *tty, int ld)
469{
470 struct tty_ldisc *disc = tty_ldisc_get(tty, ld);
471 int r;
472
Nikolay Borisov9ffbe8a2019-05-31 13:06:51 +0300473 lockdep_assert_held_write(&tty->ldisc_sem);
Alan Cox8a8dabf2017-06-02 13:49:30 +0100474 if (IS_ERR(disc))
475 return PTR_ERR(disc);
476 tty->ldisc = disc;
477 tty_set_termios_ldisc(tty, ld);
Xiaofei Tan408795b2021-04-07 15:06:49 +0800478 r = tty_ldisc_open(tty, disc);
479 if (r < 0)
Alan Cox8a8dabf2017-06-02 13:49:30 +0100480 tty_ldisc_put(disc);
481 return r;
482}
483
484/**
Jiri Slabycbb68f92021-11-26 09:16:01 +0100485 * tty_ldisc_restore - helper for tty ldisc change
486 * @tty: tty to recover
487 * @old: previous ldisc
Greg Kroah-Hartmana8983d02017-04-14 10:57:52 +0200488 *
Jiri Slabycbb68f92021-11-26 09:16:01 +0100489 * Restore the previous line discipline or %N_TTY when a line discipline change
490 * fails due to an open error
Greg Kroah-Hartmana8983d02017-04-14 10:57:52 +0200491 */
Greg Kroah-Hartmana8983d02017-04-14 10:57:52 +0200492static void tty_ldisc_restore(struct tty_struct *tty, struct tty_ldisc *old)
493{
Greg Kroah-Hartmana8983d02017-04-14 10:57:52 +0200494 /* There is an outstanding reference here so this is safe */
Tetsuo Handa598c2d42018-04-16 20:06:34 +0900495 if (tty_ldisc_failto(tty, old->ops->num) < 0) {
496 const char *name = tty_name(tty);
497
498 pr_warn("Falling back ldisc for %s.\n", name);
Xiaofei Tan72a8dcd2021-04-07 15:06:48 +0800499 /*
500 * The traditional behaviour is to fall back to N_TTY, we
501 * want to avoid falling back to N_NULL unless we have no
502 * choice to avoid the risk of breaking anything
503 */
Alan Cox8a8dabf2017-06-02 13:49:30 +0100504 if (tty_ldisc_failto(tty, N_TTY) < 0 &&
505 tty_ldisc_failto(tty, N_NULL) < 0)
Tetsuo Handa598c2d42018-04-16 20:06:34 +0900506 panic("Couldn't open N_NULL ldisc for %s.", name);
Greg Kroah-Hartmana8983d02017-04-14 10:57:52 +0200507 }
508}
509
510/**
Jiri Slabycbb68f92021-11-26 09:16:01 +0100511 * tty_set_ldisc - set line discipline
512 * @tty: the terminal to set
513 * @disc: the line discipline number
Alan Cox01e1abb2008-07-22 11:16:55 +0100514 *
Jiri Slabycbb68f92021-11-26 09:16:01 +0100515 * Set the discipline of a tty line. Must be called from a process context. The
516 * ldisc change logic has to protect itself against any overlapping ldisc
517 * change (including on the other end of pty pairs), the close of one side of a
518 * tty/pty pair, and eventually hangup.
Alan Cox01e1abb2008-07-22 11:16:55 +0100519 */
Peter Hurleyc12da962016-01-10 22:41:04 -0800520int tty_set_ldisc(struct tty_struct *tty, int disc)
Alan Cox01e1abb2008-07-22 11:16:55 +0100521{
Greg Kroah-Hartmana8983d02017-04-14 10:57:52 +0200522 int retval;
523 struct tty_ldisc *old_ldisc, *new_ldisc;
524
525 new_ldisc = tty_ldisc_get(tty, disc);
526 if (IS_ERR(new_ldisc))
527 return PTR_ERR(new_ldisc);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100528
Peter Hurleyc8483bc2014-11-05 12:12:45 -0500529 tty_lock(tty);
Peter Hurley276a6612014-11-05 12:13:08 -0500530 retval = tty_ldisc_lock(tty, 5 * HZ);
Peter Hurley63d8cb32015-11-08 09:29:38 -0500531 if (retval)
532 goto err;
Alan Coxc65c9bc2009-06-11 12:50:12 +0100533
Peter Hurleya570a492016-01-10 22:41:02 -0800534 if (!tty->ldisc) {
535 retval = -EIO;
536 goto out;
537 }
538
Peter Hurley63d8cb32015-11-08 09:29:38 -0500539 /* Check the no-op case */
Greg Kroah-Hartmana8983d02017-04-14 10:57:52 +0200540 if (tty->ldisc->ops->num == disc)
Peter Hurley63d8cb32015-11-08 09:29:38 -0500541 goto out;
Alan Coxc65c9bc2009-06-11 12:50:12 +0100542
Peter Hurley63d8cb32015-11-08 09:29:38 -0500543 if (test_bit(TTY_HUPPED, &tty->flags)) {
544 /* We were raced by hangup */
545 retval = -EIO;
546 goto out;
Alan Coxc65c9bc2009-06-11 12:50:12 +0100547 }
Alan Cox01e1abb2008-07-22 11:16:55 +0100548
Greg Kroah-Hartmana8983d02017-04-14 10:57:52 +0200549 old_ldisc = tty->ldisc;
550
551 /* Shutdown the old discipline. */
552 tty_ldisc_close(tty, old_ldisc);
553
554 /* Now set up the new line discipline. */
555 tty->ldisc = new_ldisc;
556 tty_set_termios_ldisc(tty, disc);
557
558 retval = tty_ldisc_open(tty, new_ldisc);
Alan Cox01e1abb2008-07-22 11:16:55 +0100559 if (retval < 0) {
Alan Coxc65c9bc2009-06-11 12:50:12 +0100560 /* Back to the old one or N_TTY if we can't */
Greg Kroah-Hartmana8983d02017-04-14 10:57:52 +0200561 tty_ldisc_put(new_ldisc);
562 tty_ldisc_restore(tty, old_ldisc);
Alan Cox01e1abb2008-07-22 11:16:55 +0100563 }
Alan Coxc65c9bc2009-06-11 12:50:12 +0100564
Greg Kroah-Hartmana8983d02017-04-14 10:57:52 +0200565 if (tty->ldisc->ops->num != old_ldisc->ops->num && tty->ops->set_ldisc) {
Peter Hurley9191aaa2014-11-05 13:11:41 -0500566 down_read(&tty->termios_rwsem);
Alan Cox01e1abb2008-07-22 11:16:55 +0100567 tty->ops->set_ldisc(tty);
Peter Hurley9191aaa2014-11-05 13:11:41 -0500568 up_read(&tty->termios_rwsem);
569 }
Alan Cox01e1abb2008-07-22 11:16:55 +0100570
Xiaofei Tan72a8dcd2021-04-07 15:06:48 +0800571 /*
572 * At this point we hold a reference to the new ldisc and a
573 * reference to the old ldisc, or we hold two references to
574 * the old ldisc (if it was restored as part of error cleanup
575 * above). In either case, releasing a single reference from
576 * the old ldisc is correct.
577 */
Greg Kroah-Hartmana8983d02017-04-14 10:57:52 +0200578 new_ldisc = old_ldisc;
Peter Hurley63d8cb32015-11-08 09:29:38 -0500579out:
Peter Hurley276a6612014-11-05 12:13:08 -0500580 tty_ldisc_unlock(tty);
Alan Cox01e1abb2008-07-22 11:16:55 +0100581
Xiaofei Tan72a8dcd2021-04-07 15:06:48 +0800582 /*
583 * Restart the work queue in case no characters kick it off. Safe if
584 * already running
585 */
Peter Hurley17a69212015-11-08 07:53:06 -0500586 tty_buffer_restart_work(tty->port);
Peter Hurley63d8cb32015-11-08 09:29:38 -0500587err:
Greg Kroah-Hartmana8983d02017-04-14 10:57:52 +0200588 tty_ldisc_put(new_ldisc); /* drop the extra reference */
Alan Cox89c8d912012-08-08 16:30:13 +0100589 tty_unlock(tty);
Alan Cox01e1abb2008-07-22 11:16:55 +0100590 return retval;
591}
Okash Khawaja1ab92da2017-05-15 18:45:33 +0100592EXPORT_SYMBOL_GPL(tty_set_ldisc);
Alan Cox01e1abb2008-07-22 11:16:55 +0100593
Alan Coxc65c9bc2009-06-11 12:50:12 +0100594/**
Jiri Slabycbb68f92021-11-26 09:16:01 +0100595 * tty_ldisc_kill - teardown ldisc
596 * @tty: tty being released
Peter Hurley6ffeb4b2016-01-10 22:41:03 -0800597 *
Jiri Slabycbb68f92021-11-26 09:16:01 +0100598 * Perform final close of the ldisc and reset @tty->ldisc
Peter Hurley6ffeb4b2016-01-10 22:41:03 -0800599 */
600static void tty_ldisc_kill(struct tty_struct *tty)
601{
Nikolay Borisov9ffbe8a2019-05-31 13:06:51 +0300602 lockdep_assert_held_write(&tty->ldisc_sem);
Peter Hurley6ffeb4b2016-01-10 22:41:03 -0800603 if (!tty->ldisc)
604 return;
605 /*
606 * Now kill off the ldisc
607 */
608 tty_ldisc_close(tty, tty->ldisc);
609 tty_ldisc_put(tty->ldisc);
610 /* Force an oops if we mess this up */
611 tty->ldisc = NULL;
612}
613
614/**
Jiri Slabycbb68f92021-11-26 09:16:01 +0100615 * tty_reset_termios - reset terminal state
616 * @tty: tty to reset
Alan Coxc65c9bc2009-06-11 12:50:12 +0100617 *
Jiri Slabycbb68f92021-11-26 09:16:01 +0100618 * Restore a terminal to the driver default state.
Alan Coxc65c9bc2009-06-11 12:50:12 +0100619 */
Alan Coxc65c9bc2009-06-11 12:50:12 +0100620static void tty_reset_termios(struct tty_struct *tty)
621{
Peter Hurley6a1c0682013-06-15 09:14:23 -0400622 down_write(&tty->termios_rwsem);
Alan Coxadc8d742012-07-14 15:31:47 +0100623 tty->termios = tty->driver->init_termios;
624 tty->termios.c_ispeed = tty_termios_input_baud_rate(&tty->termios);
625 tty->termios.c_ospeed = tty_termios_baud_rate(&tty->termios);
Peter Hurley6a1c0682013-06-15 09:14:23 -0400626 up_write(&tty->termios_rwsem);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100627}
628
629
630/**
Jiri Slabycbb68f92021-11-26 09:16:01 +0100631 * tty_ldisc_reinit - reinitialise the tty ldisc
632 * @tty: tty to reinit
633 * @disc: line discipline to reinitialize
Alan Coxc65c9bc2009-06-11 12:50:12 +0100634 *
Jiri Slabycbb68f92021-11-26 09:16:01 +0100635 * Completely reinitialize the line discipline state, by closing the current
636 * instance, if there is one, and opening a new instance. If an error occurs
637 * opening the new non-%N_TTY instance, the instance is dropped and @tty->ldisc
638 * reset to %NULL. The caller can then retry with %N_TTY instead.
Peter Hurley7896f302016-01-10 22:41:05 -0800639 *
Jiri Slabycbb68f92021-11-26 09:16:01 +0100640 * Returns: 0 if successful, otherwise error code < 0
Alan Coxc65c9bc2009-06-11 12:50:12 +0100641 */
Peter Hurley892d1fa2016-01-10 22:41:06 -0800642int tty_ldisc_reinit(struct tty_struct *tty, int disc)
Alan Coxc65c9bc2009-06-11 12:50:12 +0100643{
Peter Hurley7896f302016-01-10 22:41:05 -0800644 struct tty_ldisc *ld;
645 int retval;
Philippe Rétornaz1c95ba12010-10-27 17:13:21 +0200646
Nikolay Borisov9ffbe8a2019-05-31 13:06:51 +0300647 lockdep_assert_held_write(&tty->ldisc_sem);
Peter Hurley7896f302016-01-10 22:41:05 -0800648 ld = tty_ldisc_get(tty, disc);
Greg Kroah-Hartmana8983d02017-04-14 10:57:52 +0200649 if (IS_ERR(ld)) {
650 BUG_ON(disc == N_TTY);
Peter Hurley7896f302016-01-10 22:41:05 -0800651 return PTR_ERR(ld);
Greg Kroah-Hartmana8983d02017-04-14 10:57:52 +0200652 }
Alan Coxc65c9bc2009-06-11 12:50:12 +0100653
Peter Hurley7896f302016-01-10 22:41:05 -0800654 if (tty->ldisc) {
655 tty_ldisc_close(tty, tty->ldisc);
656 tty_ldisc_put(tty->ldisc);
657 }
658
659 /* switch the line discipline */
Peter Hurleyf48070452013-03-11 16:44:42 -0400660 tty->ldisc = ld;
Peter Hurleyc12da962016-01-10 22:41:04 -0800661 tty_set_termios_ldisc(tty, disc);
Peter Hurley7896f302016-01-10 22:41:05 -0800662 retval = tty_ldisc_open(tty, tty->ldisc);
663 if (retval) {
Johannes Weinere65c62b2017-10-13 15:58:08 -0700664 tty_ldisc_put(tty->ldisc);
665 tty->ldisc = NULL;
Peter Hurley7896f302016-01-10 22:41:05 -0800666 }
667 return retval;
Alan Coxc65c9bc2009-06-11 12:50:12 +0100668}
669
670/**
Jiri Slabycbb68f92021-11-26 09:16:01 +0100671 * tty_ldisc_hangup - hangup ldisc reset
672 * @tty: tty being hung up
673 * @reinit: whether to re-initialise the tty
Alan Coxc65c9bc2009-06-11 12:50:12 +0100674 *
Jiri Slabycbb68f92021-11-26 09:16:01 +0100675 * Some tty devices reset their termios when they receive a hangup event. In
676 * that situation we must also switch back to %N_TTY properly before we reset
677 * the termios data.
Alan Coxc65c9bc2009-06-11 12:50:12 +0100678 *
Jiri Slabycbb68f92021-11-26 09:16:01 +0100679 * Locking: We can take the ldisc mutex as the rest of the code is careful to
680 * allow for this.
Alan Coxc65c9bc2009-06-11 12:50:12 +0100681 *
Jiri Slabycbb68f92021-11-26 09:16:01 +0100682 * In the pty pair case this occurs in the close() path of the tty itself so we
683 * must be careful about locking rules.
Alan Coxc65c9bc2009-06-11 12:50:12 +0100684 */
Peter Hurley892d1fa2016-01-10 22:41:06 -0800685void tty_ldisc_hangup(struct tty_struct *tty, bool reinit)
Alan Coxc65c9bc2009-06-11 12:50:12 +0100686{
687 struct tty_ldisc *ld;
688
Peter Hurleya570a492016-01-10 22:41:02 -0800689 tty_ldisc_debug(tty, "%p: hangup\n", tty->ldisc);
Peter Hurleyfc575ee2013-03-11 16:44:38 -0400690
Alan Coxc65c9bc2009-06-11 12:50:12 +0100691 ld = tty_ldisc_ref(tty);
692 if (ld != NULL) {
Alan Coxc65c9bc2009-06-11 12:50:12 +0100693 if (ld->ops->flush_buffer)
694 ld->ops->flush_buffer(tty);
695 tty_driver_flush_buffer(tty);
696 if ((test_bit(TTY_DO_WRITE_WAKEUP, &tty->flags)) &&
697 ld->ops->write_wakeup)
698 ld->ops->write_wakeup(tty);
699 if (ld->ops->hangup)
700 ld->ops->hangup(tty);
701 tty_ldisc_deref(ld);
702 }
Peter Hurley36697522013-06-15 07:04:48 -0400703
Linus Torvaldsa9a08842018-02-11 14:34:03 -0800704 wake_up_interruptible_poll(&tty->write_wait, EPOLLOUT);
705 wake_up_interruptible_poll(&tty->read_wait, EPOLLIN);
Peter Hurley36697522013-06-15 07:04:48 -0400706
Alan Coxc65c9bc2009-06-11 12:50:12 +0100707 /*
708 * Shutdown the current line discipline, and reset it to
Alan Cox638b9642010-02-08 10:09:26 +0000709 * N_TTY if need be.
710 *
711 * Avoid racing set_ldisc or tty_ldisc_release
Alan Coxc65c9bc2009-06-11 12:50:12 +0100712 */
Peter Hurleyfae76e92014-11-05 12:13:07 -0500713 tty_ldisc_lock(tty, MAX_SCHEDULE_TIMEOUT);
Arnd Bergmann60af22d2010-06-01 22:53:06 +0200714
Peter Hurley892d1fa2016-01-10 22:41:06 -0800715 if (tty->driver->flags & TTY_DRIVER_RESET_TERMIOS)
Alan Cox638b9642010-02-08 10:09:26 +0000716 tty_reset_termios(tty);
Peter Hurleyfc575ee2013-03-11 16:44:38 -0400717
Peter Hurley892d1fa2016-01-10 22:41:06 -0800718 if (tty->ldisc) {
719 if (reinit) {
Johannes Weinere65c62b2017-10-13 15:58:08 -0700720 if (tty_ldisc_reinit(tty, tty->termios.c_line) < 0 &&
721 tty_ldisc_reinit(tty, N_TTY) < 0)
722 WARN_ON(tty_ldisc_reinit(tty, N_NULL) < 0);
Peter Hurley892d1fa2016-01-10 22:41:06 -0800723 } else
724 tty_ldisc_kill(tty);
725 }
726 tty_ldisc_unlock(tty);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100727}
Alan Cox01e1abb2008-07-22 11:16:55 +0100728
729/**
Jiri Slabycbb68f92021-11-26 09:16:01 +0100730 * tty_ldisc_setup - open line discipline
731 * @tty: tty being shut down
732 * @o_tty: pair tty for pty/tty pairs
Alan Cox01e1abb2008-07-22 11:16:55 +0100733 *
Jiri Slabycbb68f92021-11-26 09:16:01 +0100734 * Called during the initial open of a tty/pty pair in order to set up the line
735 * disciplines and bind them to the @tty. This has no locking issues as the
736 * device isn't yet active.
Alan Cox01e1abb2008-07-22 11:16:55 +0100737 */
Alan Cox01e1abb2008-07-22 11:16:55 +0100738int tty_ldisc_setup(struct tty_struct *tty, struct tty_struct *o_tty)
739{
Peter Hurley9de2a7c2016-01-10 22:41:08 -0800740 int retval = tty_ldisc_open(tty, tty->ldisc);
Xiaofei Tand7238352021-04-07 15:06:47 +0800741
Alan Coxc65c9bc2009-06-11 12:50:12 +0100742 if (retval)
743 return retval;
744
745 if (o_tty) {
Dmitry Safonov110b8922018-11-01 00:24:51 +0000746 /*
747 * Called without o_tty->ldisc_sem held, as o_tty has been
748 * just allocated and no one has a reference to it.
749 */
Alan Coxc65c9bc2009-06-11 12:50:12 +0100750 retval = tty_ldisc_open(o_tty, o_tty->ldisc);
Alan Cox01e1abb2008-07-22 11:16:55 +0100751 if (retval) {
Peter Hurley9de2a7c2016-01-10 22:41:08 -0800752 tty_ldisc_close(tty, tty->ldisc);
Alan Cox01e1abb2008-07-22 11:16:55 +0100753 return retval;
754 }
Alan Cox01e1abb2008-07-22 11:16:55 +0100755 }
Alan Cox01e1abb2008-07-22 11:16:55 +0100756 return 0;
757}
Alan Cox89c8d912012-08-08 16:30:13 +0100758
Alan Cox01e1abb2008-07-22 11:16:55 +0100759/**
Jiri Slabycbb68f92021-11-26 09:16:01 +0100760 * tty_ldisc_release - release line discipline
761 * @tty: tty being shut down (or one end of pty pair)
Alan Cox01e1abb2008-07-22 11:16:55 +0100762 *
Jiri Slabycbb68f92021-11-26 09:16:01 +0100763 * Called during the final close of a tty or a pty pair in order to shut down
764 * the line discpline layer. On exit, each tty's ldisc is %NULL.
Alan Cox01e1abb2008-07-22 11:16:55 +0100765 */
Peter Hurley62462ae2014-11-05 12:12:58 -0500766void tty_ldisc_release(struct tty_struct *tty)
Alan Cox01e1abb2008-07-22 11:16:55 +0100767{
Peter Hurley62462ae2014-11-05 12:12:58 -0500768 struct tty_struct *o_tty = tty->link;
769
Alan Cox01e1abb2008-07-22 11:16:55 +0100770 /*
Peter Hurleya2965b72013-03-11 16:44:35 -0400771 * Shutdown this line discipline. As this is the final close,
772 * it does not race with the set_ldisc code path.
Alan Cox01e1abb2008-07-22 11:16:55 +0100773 */
Alan Cox01e1abb2008-07-22 11:16:55 +0100774
Peter Hurley36697522013-06-15 07:04:48 -0400775 tty_ldisc_lock_pair(tty, o_tty);
Alan Cox89c8d912012-08-08 16:30:13 +0100776 tty_ldisc_kill(tty);
Alan Cox89c8d912012-08-08 16:30:13 +0100777 if (o_tty)
778 tty_ldisc_kill(o_tty);
Peter Hurley36697522013-06-15 07:04:48 -0400779 tty_ldisc_unlock_pair(tty, o_tty);
780
Xiaofei Tan72a8dcd2021-04-07 15:06:48 +0800781 /*
782 * And the memory resources remaining (buffers, termios) will be
783 * disposed of when the kref hits zero
784 */
Peter Hurleyfc575ee2013-03-11 16:44:38 -0400785
Peter Hurleyfb6edc92015-07-12 22:49:12 -0400786 tty_ldisc_debug(tty, "released\n");
Alan Cox01e1abb2008-07-22 11:16:55 +0100787}
788
789/**
Jiri Slabycbb68f92021-11-26 09:16:01 +0100790 * tty_ldisc_init - ldisc setup for new tty
791 * @tty: tty being allocated
Alan Cox01e1abb2008-07-22 11:16:55 +0100792 *
Jiri Slabycbb68f92021-11-26 09:16:01 +0100793 * Set up the line discipline objects for a newly allocated tty. Note that the
794 * tty structure is not completely set up when this call is made.
Alan Cox01e1abb2008-07-22 11:16:55 +0100795 */
Tetsuo Handa903f9db2018-04-05 19:40:16 +0900796int tty_ldisc_init(struct tty_struct *tty)
Alan Cox01e1abb2008-07-22 11:16:55 +0100797{
Peter Hurley36697522013-06-15 07:04:48 -0400798 struct tty_ldisc *ld = tty_ldisc_get(tty, N_TTY);
Xiaofei Tand7238352021-04-07 15:06:47 +0800799
Alan Coxc65c9bc2009-06-11 12:50:12 +0100800 if (IS_ERR(ld))
Tetsuo Handa903f9db2018-04-05 19:40:16 +0900801 return PTR_ERR(ld);
Peter Hurleyf48070452013-03-11 16:44:42 -0400802 tty->ldisc = ld;
Tetsuo Handa903f9db2018-04-05 19:40:16 +0900803 return 0;
Alan Cox01e1abb2008-07-22 11:16:55 +0100804}
805
Jiri Slaby67166712011-03-23 10:48:35 +0100806/**
Jiri Slabycbb68f92021-11-26 09:16:01 +0100807 * tty_ldisc_deinit - ldisc cleanup for new tty
808 * @tty: tty that was allocated recently
Jiri Slaby67166712011-03-23 10:48:35 +0100809 *
Jiri Slabycbb68f92021-11-26 09:16:01 +0100810 * The tty structure must not be completely set up (tty_ldisc_setup()) when
811 * this call is made.
Jiri Slaby67166712011-03-23 10:48:35 +0100812 */
813void tty_ldisc_deinit(struct tty_struct *tty)
814{
Dmitry Safonov110b8922018-11-01 00:24:51 +0000815 /* no ldisc_sem, tty is being destroyed */
Peter Hurleyc8b710b2016-01-09 21:13:46 -0800816 if (tty->ldisc)
817 tty_ldisc_put(tty->ldisc);
Peter Hurleyf48070452013-03-11 16:44:42 -0400818 tty->ldisc = NULL;
Jiri Slaby67166712011-03-23 10:48:35 +0100819}
Greg Kroah-Hartman7c0cca72019-01-21 17:26:42 +0100820
Greg Kroah-Hartman7c0cca72019-01-21 17:26:42 +0100821static struct ctl_table tty_table[] = {
822 {
823 .procname = "ldisc_autoload",
824 .data = &tty_ldisc_autoload,
825 .maxlen = sizeof(tty_ldisc_autoload),
826 .mode = 0644,
827 .proc_handler = proc_dointvec,
Matteo Croceeec48442019-07-18 15:58:50 -0700828 .extra1 = SYSCTL_ZERO,
829 .extra2 = SYSCTL_ONE,
Greg Kroah-Hartman7c0cca72019-01-21 17:26:42 +0100830 },
831 { }
832};
833
834static struct ctl_table tty_dir_table[] = {
835 {
836 .procname = "tty",
837 .mode = 0555,
838 .child = tty_table,
839 },
840 { }
841};
842
843static struct ctl_table tty_root_table[] = {
844 {
845 .procname = "dev",
846 .mode = 0555,
847 .child = tty_dir_table,
848 },
849 { }
850};
851
852void tty_sysctl_init(void)
853{
854 register_sysctl_table(tty_root_table);
855}