tty_ldisc.c 22 KB

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