tty_ldisc.c 19 KB

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