/*
* Copyright (c) 1982, 1986, 1989, 1993
* The Regents of the University of California. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* 3. Neither the name of the University nor the names of its contributors
* may be used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*
* @(#)tty_pty.c 8.4 (Berkeley) 2/20/95
*/
/*
* Pseudo-teletype Driver
* (Actually two drivers, requiring two entries in 'cdevsw')
*/
/*
* Check if a pty is free to use.
*/
int
pty_isfree(int minor, int lock)
{
struct pt_softc *pt = pt_softc[minor];
if (lock)
mutex_enter(&pt_softc_mutex);
minor = pt == NULL || pt->pt_tty == NULL ||
pt->pt_tty->t_oproc == NULL;
if (lock)
mutex_exit(&pt_softc_mutex);
return minor;
}
/*
* Check if the minor is correct and ensure necessary structures
* are properly allocated.
*/
int
pty_check(int ptn)
{
struct pt_softc *pti;
if (ptn >= npty) {
struct pt_softc **newpt, **oldpt;
int newnpty;
int oldnpty;
/* check if the requested pty can be granted */
if (ptn >= maxptys) {
limit_reached:
tablefull("pty", "increase kern.maxptys");
return ENXIO;
}
/* Allocate a larger pty array */
for (newnpty = npty; newnpty <= ptn;)
newnpty *= 2;
if (newnpty > maxptys)
newnpty = maxptys;
newpt = ptyarralloc(newnpty);
/*
* Now grab the pty array mutex - we need to ensure
* that the pty array is consistent while copying its
* content to newly allocated, larger space; we also
* need to be safe against pty_maxptys().
*/
mutex_enter(&pt_softc_mutex);
/*
* If the pty array was not enlarged while we were waiting
* for mutex, copy current contents of pt_softc[] to newly
* allocated array and start using the new bigger array.
*/
if (newnpty > npty) {
memcpy(newpt, pt_softc, npty*sizeof(struct pt_softc *));
oldpt = pt_softc;
oldnpty = npty;
pt_softc = newpt;
npty = newnpty;
} else {
/* was enlarged when waited for lock, free new space */
oldpt = newpt;
oldnpty = newnpty;
}
/*
* If the entry is not yet allocated, allocate one. The mutex is
* needed so that the state of pt_softc[] array is consistant
* in case it has been lengthened above.
*/
if (!pt_softc[ptn]) {
pti = kmem_zalloc(sizeof(*pti), KM_SLEEP);
/*
* Check the entry again - it might have been
* added while we were waiting for mutex.
*/
if (pt_softc[ptn]) {
mutex_exit(&pt_softc_mutex);
tty_free(pti->pt_tty);
seldestroy(&pti->pt_selr);
seldestroy(&pti->pt_selw);
kmem_free(pti, sizeof(*pti));
return 0;
}
tty_attach(pti->pt_tty);
pt_softc[ptn] = pti;
mutex_exit(&pt_softc_mutex);
}
return 0;
}
/*
* Set maxpty in thread-safe way. Returns 0 in case of error, otherwise
* new value of maxptys.
*/
int
pty_maxptys(int newmax, int set)
{
if (!set)
return maxptys;
/*
* We have to grab the pt_softc lock, so that we would pick correct
* value of npty (might be modified in pty_check()).
*/
mutex_enter(&pt_softc_mutex);
/*
* The value cannot be set to value lower than the highest pty
* number ever allocated.
*/
if (newmax >= npty)
maxptys = newmax;
else
newmax = 0;
mutex_exit(&pt_softc_mutex);
return newmax;
}
/*
* Establish n (or default if n is 1) ptys in the system.
*/
void
ptyattach(int n)
{
/*
* Start output on pseudo-tty.
* Wake up process polling or sleeping for input from controlling tty.
*/
void
ptsstart(struct tty *tp)
{
struct pt_softc *pti;
int
ptcread(dev_t dev, struct uio *uio, int flag)
{
struct pt_softc *pti = pt_softc[minor(dev)];
struct tty *tp = pti->pt_tty;
u_char bf[BUFSIZ];
int error = 0, cc;
int c;
if (uio->uio_resid <= 0)
return EINVAL;
/*
* We want to block until the slave
* is open, and there's something to read;
* but if we lost the slave or we're NBIO,
* then return the appropriate error instead.
*/
mutex_spin_enter(&tty_lock);
for (;;) {
if (ISSET(tp->t_state, TS_ISOPEN)) {
if (pti->pt_flags & PF_PKT && (c = pti->pt_send)) {
pti->pt_send = 0;
mutex_spin_exit(&tty_lock);
error = ureadc(c, uio);
if (error != 0)
return error;
/*
* Since we don't have the tty locked, there's
* a risk of messing up `t_termios'. This is
* relevant only if the tty got closed and then
* opened again while we were out uiomoving.
*/
if (c & TIOCPKT_IOCTL) {
cc = uimin(uio->uio_resid,
sizeof(tp->t_termios));
uiomove((void *) &tp->t_termios,
cc, uio);
}
return 0;
}
if (pti->pt_flags & PF_UCNTL && (c = pti->pt_ucntl)) {
pti->pt_ucntl = 0;
mutex_spin_exit(&tty_lock);
error = ureadc(c, uio);
if (error != 0)
return error;
return 0;
}
if (tp->t_outq.c_cc && !ISSET(tp->t_state, TS_TTSTOP))
break;
}
if (!ISSET(tp->t_state, TS_CARR_ON)) {
error = 0; /* EOF */
goto out;
}
if (flag & IO_NDELAY) {
error = EWOULDBLOCK;
goto out;
}
error = cv_wait_sig(&tp->t_outcvf, &tty_lock);
if (error != 0)
goto out;
}
int
ptcwrite(dev_t dev, struct uio *uio, int flag)
{
struct pt_softc *pti = pt_softc[minor(dev)];
struct tty *tp = pti->pt_tty;
u_char *cp = NULL;
int cc = 0;
u_char locbuf[BUFSIZ];
int cnt = 0;
int error = 0;
again:
mutex_spin_enter(&tty_lock);
if (!ISSET(tp->t_state, TS_ISOPEN))
goto block;
if (pti->pt_flags & PF_REMOTE) {
if (tp->t_canq.c_cc)
goto block;
while (uio->uio_resid > 0 && tp->t_canq.c_cc < TTYHOG) {
if (cc == 0) {
cc = uimin(uio->uio_resid, BUFSIZ);
cc = uimin(cc, TTYHOG - tp->t_canq.c_cc);
cp = locbuf;
mutex_spin_exit(&tty_lock);
error = uiomove(cp, cc, uio);
if (error != 0)
return error;
mutex_spin_enter(&tty_lock);
/* check again for safety */
if (!ISSET(tp->t_state, TS_ISOPEN)) {
/*
* adjust for data copied in but not
* written
*/
uio->uio_resid += cc;
error = EIO;
goto out;
}
}
if (cc) {
cc = b_to_q(cp, cc, &tp->t_outq);
if (cc > 0)
goto block;
}
}
(void) putc(0, &tp->t_canq);
ttwakeup(tp);
cv_broadcast(&tp->t_cancv);
error = 0;
goto out;
}
while (uio->uio_resid > 0) {
if (cc == 0) {
cc = uimin(uio->uio_resid, BUFSIZ);
cp = locbuf;
mutex_spin_exit(&tty_lock);
error = uiomove(cp, cc, uio);
if (error != 0)
return error;
mutex_spin_enter(&tty_lock);
/* check again for safety */
if (!ISSET(tp->t_state, TS_ISOPEN)) {
/* adjust for data copied in but not written */
uio->uio_resid += cc;
error = EIO;
goto out;
}
}
while (cc > 0) {
int used = tp->t_rawq.c_cc + tp->t_canq.c_cc;
int canon = ISSET(tp->t_lflag, ICANON) ? 1 : 0;
/*
* We need space for 2 characters if canonical
* because we might need to print ^C
*/
if (used >= (TTYHOG - canon) &&
(tp->t_canq.c_cc > 0 || !canon)) {
cv_broadcast(&tp->t_rawcv);
goto block;
}
/*
* XXX - should change l_rint to be called with lock
* see also tty.c:ttyinput_wlock()
*/
mutex_spin_exit(&tty_lock);
(*tp->t_linesw->l_rint)(*cp++, tp);
mutex_spin_enter(&tty_lock);
cnt++;
cc--;
}
}
error = 0;
goto out;
block:
/*
* Come here to wait for slave to open, for space
* in outq, or space in rawq.
*/
if (!ISSET(tp->t_state, TS_CARR_ON)) {
/* adjust for data copied in but not written */
uio->uio_resid += cc;
error = EIO;
goto out;
}
if (flag & IO_NDELAY) {
/* adjust for data copied in but not written */
uio->uio_resid += cc;
error = cnt == 0 ? EWOULDBLOCK : 0;
goto out;
}
error = cv_wait_sig(&tp->t_rawcvf, &tty_lock);
mutex_spin_exit(&tty_lock);
if (error != 0) {
/* adjust for data copied in but not written */
uio->uio_resid += cc;
return error;
}
goto again;
out:
mutex_spin_exit(&tty_lock);
return error;
}
int
ptcpoll(dev_t dev, int events, struct lwp *l)
{
struct pt_softc *pti = pt_softc[minor(dev)];
struct tty *tp = pti->pt_tty;
int revents = 0;
if (canread) {
/*
* c_cc is number of characters after output post-processing;
* the amount of data actually read(2) depends on
* setting of input flags for the terminal.
*/
kn->kn_data = tp->t_outq.c_cc;
if (((pti->pt_flags & PF_PKT) && pti->pt_send) ||
((pti->pt_flags & PF_UCNTL) && pti->pt_ucntl))
kn->kn_data++;
}
if (!ISSET(tp->t_state, TS_CARR_ON)) {
knote_set_eof(kn, 0);
canread = 1;
}
if ((hint & NOTE_SUBMIT) == 0) {
mutex_spin_exit(&tty_lock);
}
if (canwrite) {
if (pti->pt_flags & PF_REMOTE)
nwrite = tp->t_canq.c_cn;
else {
/* this is guaranteed to be > 0 due to above check */
nwrite = tp->t_canq.c_cn
- (tp->t_rawq.c_cc + tp->t_canq.c_cc);
}
kn->kn_data = nwrite;
}
if ((hint & NOTE_SUBMIT) == 0) {
mutex_spin_exit(&tty_lock);
}
/*
* IF CONTROLLER STTY THEN MUST FLUSH TO PREVENT A HANG.
* ttywflush(tp) will hang if there are characters in the outq.
*/
if (cmd == TIOCEXT) {
/*
* When the EXTPROC bit is being toggled, we need
* to send an TIOCPKT_IOCTL if the packet driver
* is turned on.
*/
if (*(int *)data) {
if (pti->pt_flags & PF_PKT) {
pti->pt_send |= TIOCPKT_IOCTL;
ptcwakeup(tp, FREAD);
}
SET(tp->t_lflag, EXTPROC);
} else {
if (ISSET(tp->t_lflag, EXTPROC) &&
(pti->pt_flags & PF_PKT)) {
pti->pt_send |= TIOCPKT_IOCTL;
ptcwakeup(tp, FREAD);
}
CLR(tp->t_lflag, EXTPROC);
}
return(0);
}
#ifndef NO_DEV_PTM
/* Allow getting the name from either the master or the slave */
if (cmd == TIOCPTSNAME) {
if ((error = pty_getmp(l, &mp)) != 0)
return error;
return pty_fill_ptmget(l, dev, -1, -1, data, mp);
}
#endif
case TIOCGPGRP:
/*
* We avoid calling ttioctl on the controller since,
* in that case, tp must be the controlling terminal.
*/
*(int *)data = tp->t_pgrp ? tp->t_pgrp->pg_id : 0;
return 0;
case TIOCPKT:
if (*(int *)data) {
if (pti->pt_flags & PF_UCNTL)
return EINVAL;
pti->pt_flags |= PF_PKT;
} else
pti->pt_flags &= ~PF_PKT;
return 0;
case TIOCUCNTL:
if (*(int *)data) {
if (pti->pt_flags & PF_PKT)
return EINVAL;
pti->pt_flags |= PF_UCNTL;
} else
pti->pt_flags &= ~PF_UCNTL;
return 0;
case TIOCREMOTE:
if (*(int *)data)
pti->pt_flags |= PF_REMOTE;
else
pti->pt_flags &= ~PF_REMOTE;
mutex_spin_enter(&tty_lock);
ttyflush(tp, FREAD|FWRITE);
mutex_spin_exit(&tty_lock);
return 0;
case TIOCSETP:
case TIOCSETN:
case TIOCSETD:
case TIOCSETA:
case TIOCSETAW:
case TIOCSETAF:
mutex_spin_enter(&tty_lock);
ndflush(&tp->t_outq, tp->t_outq.c_cc);
mutex_spin_exit(&tty_lock);
break;
case TIOCSIG:
sig = (int)(long)*(void **)data;
if (sig <= 0 || sig >= NSIG)
return EINVAL;
mutex_spin_enter(&tty_lock);
if (!ISSET(tp->t_lflag, NOFLSH))
ttyflush(tp, FREAD|FWRITE);
tp->t_state |= TS_SIGINFO;
ttysig(tp, TTYSIG_PG1, sig);
mutex_spin_exit(&tty_lock);
return 0;