4 * Copyright (c) 1982, 1986, 1989, 1993
5 * The Regents of the University of California. All rights reserved.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 * 3. Neither the name of the University nor the names of its contributors
16 * may be used to endorse or promote products derived from this software
17 * without specific prior written permission.
19 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
23 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31 * @(#)tty_pty.c 8.4 (Berkeley) 2/20/95
32 * $FreeBSD: src/sys/kern/tty_pty.c,v 1.74.2.4 2002/02/20 19:58:13 dillon Exp $
36 * Most functions here could use a separate lock to deal with concurrent
37 * access to the 'pt's.
41 * Pseudo-teletype Driver
42 * (Actually two drivers, requiring two dev_ops structures)
45 #include <sys/param.h>
46 #include <sys/systm.h>
51 #include <sys/ttydefaults.h> /* for TTYDEF_* */
53 #include <sys/fcntl.h>
54 #include <sys/kernel.h>
55 #include <sys/vnode.h>
56 #include <sys/signalvar.h>
57 #include <sys/malloc.h>
58 #include <sys/device.h>
59 #include <sys/devfs.h>
61 #include <sys/sysctl.h>
63 MALLOC_DEFINE(M_PTY, "ptys", "pty data structures");
65 static void ptsstart (struct tty *tp);
66 static void ptsstop (struct tty *tp, int rw);
67 static void ptsunhold (struct tty *tp);
68 static void ptcwakeup (struct tty *tp, int flag);
69 static void ptyinit (int n);
70 static int filt_ptcread (struct knote *kn, long hint);
71 static void filt_ptcrdetach (struct knote *kn);
72 static int filt_ptcwrite (struct knote *kn, long hint);
73 static void filt_ptcwdetach (struct knote *kn);
75 static d_open_t ptsopen;
76 static d_close_t ptsclose;
77 static d_read_t ptsread;
78 static d_write_t ptswrite;
79 static d_ioctl_t ptyioctl;
80 static d_open_t ptcopen;
81 static d_close_t ptcclose;
82 static d_read_t ptcread;
83 static d_write_t ptcwrite;
84 static d_kqfilter_t ptckqfilter;
86 DEVFS_DEFINE_CLONE_BITMAP(pty);
87 static struct pt_ioctl **ptis; /* keep pti's intact */
89 static d_clone_t ptyclone;
91 static int pty_debug_level = 0;
93 static struct dev_ops pts98_ops = {
94 { "pts98", 0, D_TTY | D_MPSAFE },
100 .d_kqfilter = ttykqfilter,
101 .d_revoke = ttyrevoke
104 static struct dev_ops ptc98_ops = {
105 { "ptc98", 0, D_TTY | D_MASTER | D_MPSAFE },
111 .d_kqfilter = ptckqfilter,
112 .d_revoke = ttyrevoke
115 static struct dev_ops pts_ops = {
116 { "pts", 0, D_TTY | D_MPSAFE },
122 .d_kqfilter = ttykqfilter,
123 .d_revoke = ttyrevoke
126 #define CDEV_MAJOR_C 6
127 static struct dev_ops ptc_ops = {
128 { "ptc", 0, D_TTY | D_MASTER | D_MPSAFE },
134 .d_kqfilter = ptckqfilter,
135 .d_revoke = ttyrevoke
138 #define BUFSIZ 100 /* Chunk size iomoved to/from user */
140 #define MAXPTYS 1000 /* Maximum cloneable ptys */
144 int pt_refs; /* Structural references interlock S/MOPEN */
146 struct kqinfo pt_kqr, pt_kqw;
151 struct prison *pt_prison;
157 #define PF_PKT 0x0008 /* packet mode */
158 #define PF_STOPPED 0x0010 /* user told stopped */
159 #define PF_REMOTE 0x0020 /* remote and flow controlled input */
160 #define PF_NOSTOP 0x0040
161 #define PF_UCNTL 0x0080 /* user control mode */
163 #define PF_PTCSTATEMASK 0x00FF
166 * pt_flags open state. Note that PF_SCLOSED is used to activate
167 * read EOF on the ptc so it is only set after the slave has been
168 * opened and then closed, and cleared again if the slave is opened
171 #define PF_UNIX98 0x0100
172 #define PF_SOPEN 0x0200
173 #define PF_MOPEN 0x0400
174 #define PF_SCLOSED 0x0800
175 #define PF_TERMINATED 0x8000
178 * This function creates and initializes a pts/ptc pair
180 * pts == /dev/tty[pqrsPQRS][0123456789abcdefghijklmnopqrstuv]
181 * ptc == /dev/pty[pqrsPQRS][0123456789abcdefghijklmnopqrstuv]
183 * XXX: define and add mapping of upper minor bits to allow more
190 char *names = "pqrsPQRS";
191 struct pt_ioctl *pti;
193 /* For now we only map the lower 8 bits of the minor */
197 pti = kmalloc(sizeof(*pti), M_PTY, M_WAITOK | M_ZERO);
198 pti->devs = devs = make_dev(&pts_ops, n, 0, 0, 0666,
200 names[n / 32], hex2ascii(n % 32));
201 pti->devc = devc = make_dev(&ptc_ops, n, 0, 0, 0666,
203 names[n / 32], hex2ascii(n % 32));
205 pti->pt_tty.t_dev = devs;
207 devs->si_drv1 = devc->si_drv1 = pti;
208 devs->si_tty = devc->si_tty = &pti->pt_tty;
209 devs->si_flags |= SI_OVERRIDE; /* uid, gid, perms from dev */
210 devc->si_flags |= SI_OVERRIDE; /* uid, gid, perms from dev */
211 ttyinit(&pti->pt_tty);
212 ttyregister(&pti->pt_tty);
216 ptyclone(struct dev_clone_args *ap)
219 struct pt_ioctl *pti;
222 * Limit the number of unix98 pty (slave) devices to 1000 for now.
224 * If this limit is reached, we don't clone and return an error
227 unit = devfs_clone_bitmap_get(&DEVFS_CLONE_BITMAP(pty), MAXPTYS);
235 * pti structures must be persistent once allocated.
237 if ((pti = ptis[unit]) == NULL) {
238 lwkt_gettoken(&tty_token);
239 pti = kmalloc(sizeof(*pti), M_PTY, M_WAITOK | M_ZERO);
240 if (ptis[unit] == NULL) {
242 ttyinit(&pti->pt_tty);
246 lwkt_reltoken(&tty_token);
250 * The cloning bitmap should guarantee isolation during
253 pti->devc = make_only_dev(&ptc98_ops, unit,
255 0, 0600, "ptm/%d", unit);
256 pti->devs = make_dev(&pts98_ops, unit,
258 GID_TTY, 0620, "pts/%d", unit);
259 ap->a_dev = pti->devc;
261 pti->devs->si_flags |= SI_OVERRIDE; /* uid, gid, perms from dev */
262 pti->devc->si_flags |= SI_OVERRIDE; /* uid, gid, perms from dev */
264 pti->pt_tty.t_dev = pti->devs;
265 pti->pt_flags = PF_UNIX98;
266 pti->pt_uminor = unit;
267 pti->devs->si_drv1 = pti->devc->si_drv1 = pti;
268 pti->devs->si_tty = pti->devc->si_tty = &pti->pt_tty;
269 ttyregister(&pti->pt_tty);
275 * pti_hold() prevents the pti from being destroyed due to a termination
276 * while a pt*open() is blocked.
278 * This function returns non-zero if we cannot hold due to a termination
282 pti_hold(struct pt_ioctl *pti)
284 if (pti->pt_flags & PF_TERMINATED)
292 * pti_done() releases the reference and checks to see if both sides have
293 * been closed on a unix98 pty, allowing us to destroy the device and
296 * We do not release resources on non-unix98 ptys. Those are left
297 * statically allocated.
300 pti_done(struct pt_ioctl *pti)
302 lwkt_gettoken(&pti->pt_tty.t_token);
303 if (--pti->pt_refs == 0) {
308 * Only unix09 ptys are freed up (the pti structure itself
309 * is never freed, regardless).
311 if ((pti->pt_flags & PF_UNIX98) == 0) {
312 lwkt_reltoken(&pti->pt_tty.t_token);
317 * Interlock open attempts against termination by setting
318 * PF_TERMINATED. This allows us to block while cleaning
319 * out the device infrastructure.
321 * Do not terminate the tty if it still has a session
322 * association (t_refs).
324 if ((pti->pt_flags & (PF_SOPEN|PF_MOPEN)) == 0 &&
325 pti->pt_tty.t_refs == 0) {
326 pti->pt_flags |= PF_TERMINATED;
327 uminor_no = pti->pt_uminor;
329 if ((dev = pti->devs) != NULL) {
334 if ((dev = pti->devc) != NULL) {
339 ttyunregister(&pti->pt_tty);
340 pti->pt_tty.t_dev = NULL;
342 devfs_clone_bitmap_put(&DEVFS_CLONE_BITMAP(pty),
344 /* pti structure remains intact */
347 lwkt_reltoken(&pti->pt_tty.t_token);
352 ptsopen(struct dev_open_args *ap)
354 cdev_t dev = ap->a_head.a_dev;
357 struct pt_ioctl *pti;
360 * The pti will already be assigned by the clone code or
361 * pre-created if a non-unix 98 pty. If si_drv1 is NULL
362 * we are somehow racing a unix98 termination.
364 if (dev->si_drv1 == NULL)
368 lwkt_gettoken(&pti->pt_tty.t_token);
370 lwkt_reltoken(&pti->pt_tty.t_token);
377 * Reinit most of the tty state if it isn't open. Handle
380 if ((tp->t_state & TS_ISOPEN) == 0) {
381 ttychars(tp); /* Set up default chars */
382 tp->t_iflag = TTYDEF_IFLAG;
383 tp->t_oflag = TTYDEF_OFLAG;
384 tp->t_lflag = TTYDEF_LFLAG;
385 tp->t_cflag = TTYDEF_CFLAG;
386 tp->t_ispeed = tp->t_ospeed = TTYDEF_SPEED;
387 } else if ((tp->t_state & TS_XCLUDE) &&
388 priv_check_cred(ap->a_cred, PRIV_ROOT, 0)) {
390 lwkt_reltoken(&pti->pt_tty.t_token);
392 } else if (pti->pt_prison != ap->a_cred->cr_prison) {
394 lwkt_reltoken(&pti->pt_tty.t_token);
399 * If the ptc is already present this will connect us up. It
400 * is unclear if this is actually needed.
402 * If neither side is open be sure to clear any left over
403 * ZOMBIE state before continuing.
406 (void)(*linesw[tp->t_line].l_modem)(tp, 1);
407 else if ((pti->pt_flags & PF_SOPEN) == 0)
408 tp->t_state &= ~TS_ZOMBIE;
411 * Wait for the carrier (ptc side)
413 while ((tp->t_state & TS_CARR_ON) == 0) {
414 if (ap->a_oflags & FNONBLOCK)
416 error = ttysleep(tp, TSA_CARR_ON(tp), PCATCH, "ptsopn", 0);
419 lwkt_reltoken(&pti->pt_tty.t_token);
425 * Mark the tty open and mark the slave side as being open.
427 error = (*linesw[tp->t_line].l_open)(dev, tp);
430 pti->pt_flags |= PF_SOPEN;
431 pti->pt_flags &= ~PF_SCLOSED;
432 ptcwakeup(tp, FREAD|FWRITE);
435 lwkt_reltoken(&pti->pt_tty.t_token);
441 ptsclose(struct dev_close_args *ap)
443 cdev_t dev = ap->a_head.a_dev;
445 struct pt_ioctl *pti = dev->si_drv1;
448 lwkt_gettoken(&pti->pt_tty.t_token);
450 panic("ptsclose on terminated pti");
453 * Disconnect the slave side
456 err = (*linesw[tp->t_line].l_close)(tp, ap->a_fflag);
457 ptsstop(tp, FREAD|FWRITE);
458 ttyclose(tp); /* clears t_state */
461 * Mark the pts side closed and signal the ptc. Do not mark the
462 * tty a zombie... that is, allow the tty to be re-opened as long
463 * as the ptc is still open. The ptc will read() EOFs until the
464 * pts side is reopened or the ptc is closed.
466 * xterm() depends on this behavior as it will revoke() the pts
467 * and then reopen it after the (unnecessary old code) chmod.
469 pti->pt_flags &= ~PF_SOPEN;
470 pti->pt_flags |= PF_SCLOSED;
472 ptcwakeup(tp, FREAD);
474 lwkt_reltoken(&pti->pt_tty.t_token);
479 ptsread(struct dev_read_args *ap)
481 cdev_t dev = ap->a_head.a_dev;
482 struct proc *p = curproc;
483 struct tty *tp = dev->si_tty;
484 struct pt_ioctl *pti = dev->si_drv1;
489 lp = curthread->td_lwp;
491 lwkt_gettoken(&pti->pt_tty.t_token);
493 if (pti->pt_flags & PF_REMOTE) {
494 while (isbackground(p, tp)) {
495 if (SIGISMEMBER(p->p_sigignore, SIGTTIN) ||
496 SIGISMEMBER(lp->lwp_sigmask, SIGTTIN) ||
497 p->p_pgrp->pg_jobc == 0 ||
498 (p->p_flags & P_PPWAIT)) {
499 lwkt_reltoken(&pti->pt_tty.t_token);
502 pgsignal(p->p_pgrp, SIGTTIN, 1);
503 error = ttysleep(tp, &lbolt, PCATCH, "ptsbg", 0);
505 lwkt_reltoken(&pti->pt_tty.t_token);
509 if (tp->t_canq.c_cc == 0) {
510 if (ap->a_ioflag & IO_NDELAY) {
511 lwkt_reltoken(&pti->pt_tty.t_token);
512 return (EWOULDBLOCK);
514 error = ttysleep(tp, TSA_PTS_READ(tp), PCATCH,
517 lwkt_reltoken(&pti->pt_tty.t_token);
522 while (tp->t_canq.c_cc > 1 && ap->a_uio->uio_resid > 0)
523 if (ureadc(clist_getc(&tp->t_canq), ap->a_uio) < 0) {
527 if (tp->t_canq.c_cc == 1)
528 clist_getc(&tp->t_canq);
529 if (tp->t_canq.c_cc) {
530 lwkt_reltoken(&pti->pt_tty.t_token);
535 error = (*linesw[tp->t_line].l_read)(tp, ap->a_uio, ap->a_ioflag);
536 ptcwakeup(tp, FWRITE);
537 lwkt_reltoken(&pti->pt_tty.t_token);
543 * Write to pseudo-tty.
544 * Wakeups of controlling tty will happen
545 * indirectly, when tty driver calls ptsstart.
548 ptswrite(struct dev_write_args *ap)
550 cdev_t dev = ap->a_head.a_dev;
555 lwkt_gettoken(&tp->t_token);
556 if (tp->t_oproc == NULL) {
557 lwkt_reltoken(&tp->t_token);
560 ret = ((*linesw[tp->t_line].l_write)(tp, ap->a_uio, ap->a_ioflag));
561 lwkt_reltoken(&tp->t_token);
567 * Start output on pseudo-tty.
568 * Wake up process selecting or sleeping for input from controlling tty.
571 ptsstart(struct tty *tp)
573 struct pt_ioctl *pti = tp->t_dev->si_drv1;
575 lwkt_gettoken(&pti->pt_tty.t_token);
576 lwkt_gettoken(&tp->t_token);
577 if (tp->t_state & TS_TTSTOP) {
578 lwkt_reltoken(&tp->t_token);
579 lwkt_reltoken(&pti->pt_tty.t_token);
583 if (pti->pt_flags & PF_STOPPED) {
584 pti->pt_flags &= ~PF_STOPPED;
585 pti->pt_send = TIOCPKT_START;
588 ptcwakeup(tp, FREAD);
589 lwkt_reltoken(&tp->t_token);
590 lwkt_reltoken(&pti->pt_tty.t_token);
594 * NOTE: Must be called with tp->t_token held
597 ptcwakeup(struct tty *tp, int flag)
600 wakeup(TSA_PTC_READ(tp));
601 KNOTE(&tp->t_rkq.ki_note, 0);
604 wakeup(TSA_PTC_WRITE(tp));
605 KNOTE(&tp->t_wkq.ki_note, 0);
610 ptcopen(struct dev_open_args *ap)
612 cdev_t dev = ap->a_head.a_dev;
614 struct pt_ioctl *pti;
617 * The pti will already be assigned by the clone code or
618 * pre-created if a non-unix 98 pty. If si_drv1 is NULL
619 * we are somehow racing a unix98 termination.
625 lwkt_gettoken(&pti->pt_tty.t_token);
627 lwkt_reltoken(&pti->pt_tty.t_token);
630 if (pti->pt_prison && pti->pt_prison != ap->a_cred->cr_prison) {
632 lwkt_reltoken(&pti->pt_tty.t_token);
636 lwkt_gettoken(&tp->t_token);
639 lwkt_reltoken(&tp->t_token);
640 lwkt_reltoken(&pti->pt_tty.t_token);
645 * If the slave side is not yet open clear any left over zombie
646 * state before doing our modem control.
648 if ((pti->pt_flags & PF_SOPEN) == 0)
649 tp->t_state &= ~TS_ZOMBIE;
651 tp->t_oproc = ptsstart;
652 tp->t_stop = ptsstop;
653 tp->t_unhold = ptsunhold;
658 (void)(*linesw[tp->t_line].l_modem)(tp, 1);
660 tp->t_lflag &= ~EXTPROC;
661 pti->pt_prison = ap->a_cred->cr_prison;
662 pti->pt_flags &= ~PF_PTCSTATEMASK;
666 pti->devs->si_uid = ap->a_cred->cr_uid;
667 pti->devs->si_gid = ap->a_cred->cr_uid ? GID_TTY : 0;
668 pti->devs->si_perms = 0600;
669 pti->devc->si_uid = ap->a_cred->cr_uid;
670 pti->devc->si_gid = 0;
671 pti->devc->si_perms = 0600;
674 * Mark master side open. This does not cause any events
677 pti->pt_flags |= PF_MOPEN;
680 lwkt_reltoken(&tp->t_token);
681 lwkt_reltoken(&pti->pt_tty.t_token);
687 ptcclose(struct dev_close_args *ap)
689 cdev_t dev = ap->a_head.a_dev;
691 struct pt_ioctl *pti = dev->si_drv1;
693 lwkt_gettoken(&pti->pt_tty.t_token);
695 lwkt_reltoken(&pti->pt_tty.t_token);
696 panic("ptcclose on terminated pti");
699 lwkt_gettoken(&tp->t_token);
701 (void)(*linesw[tp->t_line].l_modem)(tp, 0);
704 * Mark the master side closed. If the slave is still open
705 * mark the tty ZOMBIE, preventing any new action until both
708 * NOTE: The ttyflush() will wake up the slave once we've
709 * set appropriate flags. The ZOMBIE flag will be
710 * cleared when the slave side is closed.
712 pti->pt_flags &= ~PF_MOPEN;
713 if (pti->pt_flags & PF_SOPEN)
714 tp->t_state |= TS_ZOMBIE;
717 * Turn off the carrier and disconnect. This will notify the slave
720 if (tp->t_state & TS_ISOPEN) {
721 tp->t_state &= ~(TS_CARR_ON | TS_CONNECTED);
722 ttyflush(tp, FREAD | FWRITE);
724 tp->t_oproc = NULL; /* mark closed */
726 pti->pt_prison = NULL;
727 pti->devs->si_uid = 0;
728 pti->devs->si_gid = 0;
729 pti->devs->si_perms = 0666;
730 pti->devc->si_uid = 0;
731 pti->devc->si_gid = 0;
732 pti->devc->si_perms = 0666;
735 lwkt_reltoken(&tp->t_token);
736 lwkt_reltoken(&pti->pt_tty.t_token);
742 ptcread(struct dev_read_args *ap)
744 cdev_t dev = ap->a_head.a_dev;
745 struct tty *tp = dev->si_tty;
746 struct pt_ioctl *pti = dev->si_drv1;
750 lwkt_gettoken(&pti->pt_tty.t_token);
751 lwkt_gettoken(&tp->t_token);
754 * We want to block until the slave
755 * is open, and there's something to read;
756 * but if we lost the slave or we're NBIO,
757 * then return the appropriate error instead.
760 if (tp->t_state&TS_ISOPEN) {
761 if ((pti->pt_flags & PF_PKT) && pti->pt_send) {
762 error = ureadc((int)pti->pt_send, ap->a_uio);
764 lwkt_reltoken(&tp->t_token);
765 lwkt_reltoken(&pti->pt_tty.t_token);
768 if (pti->pt_send & TIOCPKT_IOCTL) {
769 cc = (int)szmin(ap->a_uio->uio_resid,
770 sizeof(tp->t_termios));
771 uiomove((caddr_t)&tp->t_termios, cc,
775 lwkt_reltoken(&tp->t_token);
776 lwkt_reltoken(&pti->pt_tty.t_token);
780 if ((pti->pt_flags & PF_UCNTL) && pti->pt_ucntl) {
781 error = ureadc((int)pti->pt_ucntl, ap->a_uio);
783 lwkt_reltoken(&tp->t_token);
784 lwkt_reltoken(&pti->pt_tty.t_token);
788 lwkt_reltoken(&tp->t_token);
789 lwkt_reltoken(&pti->pt_tty.t_token);
793 if (tp->t_outq.c_cc && (tp->t_state&TS_TTSTOP) == 0)
796 if ((tp->t_state & TS_CONNECTED) == 0) {
797 lwkt_reltoken(&tp->t_token);
798 lwkt_reltoken(&pti->pt_tty.t_token);
799 return (0); /* EOF */
801 if (ap->a_ioflag & IO_NDELAY) {
802 lwkt_reltoken(&tp->t_token);
803 lwkt_reltoken(&pti->pt_tty.t_token);
804 return (EWOULDBLOCK);
806 error = tsleep(TSA_PTC_READ(tp), PCATCH, "ptcin", 0);
808 lwkt_reltoken(&tp->t_token);
809 lwkt_reltoken(&pti->pt_tty.t_token);
813 if (pti->pt_flags & (PF_PKT|PF_UCNTL))
814 error = ureadc(0, ap->a_uio);
815 while (ap->a_uio->uio_resid > 0 && error == 0) {
816 cc = clist_qtob(&tp->t_outq, buf,
817 (int)szmin(ap->a_uio->uio_resid, BUFSIZ));
820 error = uiomove(buf, (size_t)cc, ap->a_uio);
823 lwkt_reltoken(&tp->t_token);
824 lwkt_reltoken(&pti->pt_tty.t_token);
830 ptsstop(struct tty *tp, int flush)
832 struct pt_ioctl *pti = tp->t_dev->si_drv1;
835 lwkt_gettoken(&pti->pt_tty.t_token);
836 /* note: FLUSHREAD and FLUSHWRITE already ok */
839 flush = TIOCPKT_STOP;
840 pti->pt_flags |= PF_STOPPED;
842 pti->pt_flags &= ~PF_STOPPED;
844 pti->pt_send |= flush;
845 /* change of perspective */
854 lwkt_reltoken(&pti->pt_tty.t_token);
858 * ttyunhold() calls us instead of just decrementing tp->t_refs. This
859 * is needed because a session can hold onto a pts (half closed state)
860 * even if there are no live file descriptors. Without the callback
864 ptsunhold(struct tty *tp)
866 struct pt_ioctl *pti = tp->t_dev->si_drv1;
868 lwkt_gettoken(&pti->pt_tty.t_token);
869 lwkt_gettoken(&tp->t_token);
873 lwkt_reltoken(&tp->t_token);
874 lwkt_reltoken(&pti->pt_tty.t_token);
878 * kqueue ops for pseudo-terminals.
880 static struct filterops ptcread_filtops =
881 { FILTEROP_ISFD|FILTEROP_MPSAFE, NULL, filt_ptcrdetach, filt_ptcread };
882 static struct filterops ptcwrite_filtops =
883 { FILTEROP_ISFD|FILTEROP_MPSAFE, NULL, filt_ptcwdetach, filt_ptcwrite };
886 ptckqfilter(struct dev_kqfilter_args *ap)
888 cdev_t dev = ap->a_head.a_dev;
889 struct knote *kn = ap->a_kn;
890 struct tty *tp = dev->si_tty;
894 switch (kn->kn_filter) {
896 klist = &tp->t_rkq.ki_note;
897 kn->kn_fop = &ptcread_filtops;
900 klist = &tp->t_wkq.ki_note;
901 kn->kn_fop = &ptcwrite_filtops;
904 ap->a_result = EOPNOTSUPP;
908 kn->kn_hook = (caddr_t)dev;
909 knote_insert(klist, kn);
914 filt_ptcread (struct knote *kn, long hint)
916 struct tty *tp = ((cdev_t)kn->kn_hook)->si_tty;
917 struct pt_ioctl *pti = ((cdev_t)kn->kn_hook)->si_drv1;
919 lwkt_gettoken(&pti->pt_tty.t_token);
920 lwkt_gettoken(&tp->t_token);
922 if ((tp->t_state & TS_ZOMBIE) || (pti->pt_flags & PF_SCLOSED)) {
923 kn->kn_flags |= (EV_EOF | EV_NODATA);
924 lwkt_reltoken(&tp->t_token);
925 lwkt_reltoken(&pti->pt_tty.t_token);
929 if ((tp->t_state & TS_ISOPEN) &&
930 ((tp->t_outq.c_cc && (tp->t_state & TS_TTSTOP) == 0) ||
931 ((pti->pt_flags & PF_PKT) && pti->pt_send) ||
932 ((pti->pt_flags & PF_UCNTL) && pti->pt_ucntl))) {
933 kn->kn_data = tp->t_outq.c_cc;
934 lwkt_reltoken(&tp->t_token);
935 lwkt_reltoken(&pti->pt_tty.t_token);
938 lwkt_reltoken(&tp->t_token);
939 lwkt_reltoken(&pti->pt_tty.t_token);
945 filt_ptcwrite (struct knote *kn, long hint)
947 struct tty *tp = ((cdev_t)kn->kn_hook)->si_tty;
948 struct pt_ioctl *pti = ((cdev_t)kn->kn_hook)->si_drv1;
950 lwkt_gettoken(&pti->pt_tty.t_token);
951 lwkt_gettoken(&tp->t_token);
952 if (tp->t_state & TS_ZOMBIE) {
953 lwkt_reltoken(&tp->t_token);
954 lwkt_reltoken(&pti->pt_tty.t_token);
955 kn->kn_flags |= (EV_EOF | EV_NODATA);
959 if (tp->t_state & TS_ISOPEN &&
960 ((pti->pt_flags & PF_REMOTE) ?
961 (tp->t_canq.c_cc == 0) :
962 ((tp->t_rawq.c_cc + tp->t_canq.c_cc < TTYHOG - 2) ||
963 (tp->t_canq.c_cc == 0 && (tp->t_lflag & ICANON))))) {
964 kn->kn_data = tp->t_canq.c_cc + tp->t_rawq.c_cc;
965 lwkt_reltoken(&tp->t_token);
966 lwkt_reltoken(&pti->pt_tty.t_token);
969 lwkt_reltoken(&tp->t_token);
970 lwkt_reltoken(&pti->pt_tty.t_token);
977 filt_ptcrdetach (struct knote *kn)
979 struct tty *tp = ((cdev_t)kn->kn_hook)->si_tty;
981 knote_remove(&tp->t_rkq.ki_note, kn);
985 filt_ptcwdetach (struct knote *kn)
987 struct tty *tp = ((cdev_t)kn->kn_hook)->si_tty;
989 knote_remove(&tp->t_wkq.ki_note, kn);
996 ptcwrite(struct dev_write_args *ap)
998 cdev_t dev = ap->a_head.a_dev;
999 struct tty *tp = dev->si_tty;
1002 u_char locbuf[BUFSIZ];
1004 struct pt_ioctl *pti = dev->si_drv1;
1007 lwkt_gettoken(&pti->pt_tty.t_token);
1008 lwkt_gettoken(&tp->t_token);
1010 if ((tp->t_state&TS_ISOPEN) == 0)
1012 if (pti->pt_flags & PF_REMOTE) {
1013 if (tp->t_canq.c_cc)
1015 while ((ap->a_uio->uio_resid > 0 || cc > 0) &&
1016 tp->t_canq.c_cc < TTYHOG - 1) {
1018 cc = (int)szmin(ap->a_uio->uio_resid, BUFSIZ);
1019 cc = imin(cc, TTYHOG - 1 - tp->t_canq.c_cc);
1021 error = uiomove(cp, (size_t)cc, ap->a_uio);
1023 lwkt_reltoken(&tp->t_token);
1024 lwkt_reltoken(&pti->pt_tty.t_token);
1027 /* check again for safety */
1028 if ((tp->t_state & TS_ISOPEN) == 0) {
1029 /* adjust as usual */
1030 ap->a_uio->uio_resid += cc;
1031 lwkt_reltoken(&tp->t_token);
1032 lwkt_reltoken(&pti->pt_tty.t_token);
1037 cc = clist_btoq((char *)cp, cc, &tp->t_canq);
1039 * XXX we don't guarantee that the canq size
1040 * is >= TTYHOG, so the above btoq() may
1041 * leave some bytes uncopied. However, space
1042 * is guaranteed for the null terminator if
1043 * we don't fail here since (TTYHOG - 1) is
1044 * not a multiple of CBSIZE.
1050 /* adjust for data copied in but not written */
1051 ap->a_uio->uio_resid += cc;
1052 clist_putc(0, &tp->t_canq);
1054 wakeup(TSA_PTS_READ(tp));
1055 lwkt_reltoken(&tp->t_token);
1056 lwkt_reltoken(&pti->pt_tty.t_token);
1060 while (ap->a_uio->uio_resid > 0 || cc > 0) {
1062 cc = (int)szmin(ap->a_uio->uio_resid, BUFSIZ);
1064 error = uiomove(cp, (size_t)cc, ap->a_uio);
1066 lwkt_reltoken(&tp->t_token);
1067 lwkt_reltoken(&pti->pt_tty.t_token);
1070 /* check again for safety */
1071 if ((tp->t_state & TS_ISOPEN) == 0) {
1072 /* adjust for data copied in but not written */
1073 ap->a_uio->uio_resid += cc;
1074 lwkt_reltoken(&tp->t_token);
1075 lwkt_reltoken(&pti->pt_tty.t_token);
1080 if ((tp->t_rawq.c_cc + tp->t_canq.c_cc) >= TTYHOG - 2 &&
1081 (tp->t_canq.c_cc > 0 || !(tp->t_lflag&ICANON))) {
1082 wakeup(TSA_HUP_OR_INPUT(tp));
1085 (*linesw[tp->t_line].l_rint)(*cp++, tp);
1091 lwkt_reltoken(&tp->t_token);
1092 lwkt_reltoken(&pti->pt_tty.t_token);
1096 * Come here to wait for slave to open, for space
1097 * in outq, or space in rawq, or an empty canq.
1099 if ((tp->t_state & TS_CONNECTED) == 0) {
1100 /* adjust for data copied in but not written */
1101 ap->a_uio->uio_resid += cc;
1102 lwkt_reltoken(&tp->t_token);
1103 lwkt_reltoken(&pti->pt_tty.t_token);
1106 if (ap->a_ioflag & IO_NDELAY) {
1107 /* adjust for data copied in but not written */
1108 ap->a_uio->uio_resid += cc;
1110 lwkt_reltoken(&tp->t_token);
1111 lwkt_reltoken(&pti->pt_tty.t_token);
1112 return (EWOULDBLOCK);
1114 lwkt_reltoken(&tp->t_token);
1115 lwkt_reltoken(&pti->pt_tty.t_token);
1118 error = tsleep(TSA_PTC_WRITE(tp), PCATCH, "ptcout", 0);
1120 /* adjust for data copied in but not written */
1121 ap->a_uio->uio_resid += cc;
1122 lwkt_reltoken(&tp->t_token);
1123 lwkt_reltoken(&pti->pt_tty.t_token);
1131 ptyioctl(struct dev_ioctl_args *ap)
1133 cdev_t dev = ap->a_head.a_dev;
1134 struct tty *tp = dev->si_tty;
1135 struct pt_ioctl *pti = dev->si_drv1;
1136 u_char *cc = tp->t_cc;
1139 lwkt_gettoken(&pti->pt_tty.t_token);
1140 lwkt_gettoken(&tp->t_token);
1142 if (dev_dflags(dev) & D_MASTER) {
1143 switch (ap->a_cmd) {
1147 * We avoid calling ttioctl on the controller since,
1148 * in that case, tp must be the controlling terminal.
1150 *(int *)ap->a_data = tp->t_pgrp ? tp->t_pgrp->pg_id : 0;
1151 lwkt_reltoken(&tp->t_token);
1152 lwkt_reltoken(&pti->pt_tty.t_token);
1156 if (*(int *)ap->a_data) {
1157 if (pti->pt_flags & PF_UCNTL) {
1158 lwkt_reltoken(&tp->t_token);
1159 lwkt_reltoken(&pti->pt_tty.t_token);
1162 pti->pt_flags |= PF_PKT;
1164 pti->pt_flags &= ~PF_PKT;
1166 lwkt_reltoken(&tp->t_token);
1167 lwkt_reltoken(&pti->pt_tty.t_token);
1171 if (*(int *)ap->a_data) {
1172 if (pti->pt_flags & PF_PKT) {
1173 lwkt_reltoken(&tp->t_token);
1174 lwkt_reltoken(&pti->pt_tty.t_token);
1177 pti->pt_flags |= PF_UCNTL;
1179 pti->pt_flags &= ~PF_UCNTL;
1181 lwkt_reltoken(&tp->t_token);
1182 lwkt_reltoken(&pti->pt_tty.t_token);
1186 if (*(int *)ap->a_data)
1187 pti->pt_flags |= PF_REMOTE;
1189 pti->pt_flags &= ~PF_REMOTE;
1190 ttyflush(tp, FREAD|FWRITE);
1191 lwkt_reltoken(&tp->t_token);
1192 lwkt_reltoken(&pti->pt_tty.t_token);
1195 case TIOCISPTMASTER:
1196 if ((pti->pt_flags & PF_UNIX98) &&
1197 (pti->devc == dev)) {
1198 lwkt_reltoken(&tp->t_token);
1199 lwkt_reltoken(&pti->pt_tty.t_token);
1202 lwkt_reltoken(&tp->t_token);
1203 lwkt_reltoken(&pti->pt_tty.t_token);
1209 * The rest of the ioctls shouldn't be called until
1210 * the slave is open.
1212 if ((tp->t_state & TS_ISOPEN) == 0) {
1213 lwkt_reltoken(&tp->t_token);
1214 lwkt_reltoken(&pti->pt_tty.t_token);
1218 switch (ap->a_cmd) {
1224 * IF CONTROLLER STTY THEN MUST FLUSH TO PREVENT A HANG.
1225 * ttywflush(tp) will hang if there are characters in
1228 ndflush(&tp->t_outq, tp->t_outq.c_cc);
1232 if (*(unsigned int *)ap->a_data >= NSIG ||
1233 *(unsigned int *)ap->a_data == 0) {
1234 lwkt_reltoken(&tp->t_token);
1235 lwkt_reltoken(&pti->pt_tty.t_token);
1238 if ((tp->t_lflag&NOFLSH) == 0)
1239 ttyflush(tp, FREAD|FWRITE);
1240 pgsignal(tp->t_pgrp, *(unsigned int *)ap->a_data, 1);
1241 if ((*(unsigned int *)ap->a_data == SIGINFO) &&
1242 ((tp->t_lflag&NOKERNINFO) == 0))
1244 lwkt_reltoken(&tp->t_token);
1245 lwkt_reltoken(&pti->pt_tty.t_token);
1249 if (ap->a_cmd == TIOCEXT) {
1251 * When the EXTPROC bit is being toggled, we need
1252 * to send an TIOCPKT_IOCTL if the packet driver
1255 if (*(int *)ap->a_data) {
1256 if (pti->pt_flags & PF_PKT) {
1257 pti->pt_send |= TIOCPKT_IOCTL;
1258 ptcwakeup(tp, FREAD);
1260 tp->t_lflag |= EXTPROC;
1262 if ((tp->t_lflag & EXTPROC) &&
1263 (pti->pt_flags & PF_PKT)) {
1264 pti->pt_send |= TIOCPKT_IOCTL;
1265 ptcwakeup(tp, FREAD);
1267 tp->t_lflag &= ~EXTPROC;
1269 lwkt_reltoken(&tp->t_token);
1270 lwkt_reltoken(&pti->pt_tty.t_token);
1273 error = (*linesw[tp->t_line].l_ioctl)(tp, ap->a_cmd, ap->a_data,
1274 ap->a_fflag, ap->a_cred);
1275 if (error == ENOIOCTL)
1276 error = ttioctl(tp, ap->a_cmd, ap->a_data, ap->a_fflag);
1277 if (error == ENOIOCTL) {
1278 if (pti->pt_flags & PF_UCNTL &&
1279 (ap->a_cmd & ~0xff) == UIOCCMD(0)) {
1280 if (ap->a_cmd & 0xff) {
1281 pti->pt_ucntl = (u_char)ap->a_cmd;
1282 ptcwakeup(tp, FREAD);
1284 lwkt_reltoken(&tp->t_token);
1285 lwkt_reltoken(&pti->pt_tty.t_token);
1291 * If external processing and packet mode send ioctl packet.
1293 if ((tp->t_lflag&EXTPROC) && (pti->pt_flags & PF_PKT)) {
1298 pti->pt_send |= TIOCPKT_IOCTL;
1299 ptcwakeup(tp, FREAD);
1304 stop = (tp->t_iflag & IXON) && CCEQ(cc[VSTOP], CTRL('s'))
1305 && CCEQ(cc[VSTART], CTRL('q'));
1306 if (pti->pt_flags & PF_NOSTOP) {
1308 pti->pt_send &= ~TIOCPKT_NOSTOP;
1309 pti->pt_send |= TIOCPKT_DOSTOP;
1310 pti->pt_flags &= ~PF_NOSTOP;
1311 ptcwakeup(tp, FREAD);
1315 pti->pt_send &= ~TIOCPKT_DOSTOP;
1316 pti->pt_send |= TIOCPKT_NOSTOP;
1317 pti->pt_flags |= PF_NOSTOP;
1318 ptcwakeup(tp, FREAD);
1321 lwkt_reltoken(&tp->t_token);
1322 lwkt_reltoken(&pti->pt_tty.t_token);
1328 static void ptc_drvinit (void *unused);
1330 SYSCTL_INT(_kern, OID_AUTO, pty_debug, CTLFLAG_RW, &pty_debug_level,
1331 0, "Change pty debug level");
1334 ptc_drvinit(void *unused)
1340 * Create the clonable base device.
1342 make_autoclone_dev(&ptc_ops, &DEVFS_CLONE_BITMAP(pty), ptyclone,
1343 0, 0, 0666, "ptmx");
1344 ptis = kmalloc(sizeof(struct pt_ioctl *) * MAXPTYS, M_PTY,
1347 for (i = 0; i < 256; i++) {
1352 SYSINIT(ptcdev, SI_SUB_DRIVERS, SI_ORDER_MIDDLE + CDEV_MAJOR_C,