mirror of
https://github.com/moparisthebest/socat
synced 2024-11-16 05:55:11 -05:00
230 lines
7.7 KiB
C
230 lines
7.7 KiB
C
/* source: xio-pty.c */
|
|
/* Copyright Gerhard Rieger 2002-2008 */
|
|
/* Published under the GNU General Public License V.2, see file COPYING */
|
|
|
|
/* this file contains the source for creating pty addresses */
|
|
|
|
#include "xiosysincludes.h"
|
|
#include "xioopen.h"
|
|
|
|
#include "xio-named.h"
|
|
#include "xio-termios.h"
|
|
|
|
|
|
#if WITH_PTY
|
|
|
|
/* here define the preferred polling intervall, in seconds */
|
|
#define PTY_INTERVALL 1,0 /* for struct timespec */
|
|
|
|
#define MAXPTYNAMELEN 64
|
|
|
|
static int xioopen_pty(const char *linkname, struct opt *opts, int xioflags, xiofile_t *xfd, unsigned groups);
|
|
static int xioopen_pty0(int argc, const char *argv[], struct opt *opts, int xioflags, xiofile_t *fd, unsigned groups, int dummy1, int dummy2, int dummy3);
|
|
static int xioopen_pty1(int argc, const char *argv[], struct opt *opts, int xioflags, xiofile_t *fd, unsigned groups, int dummy1, int dummy2, int dummy3);
|
|
|
|
static const struct xioaddr_endpoint_desc xioendpoint_pty0 = { XIOADDR_SYS, "pty", 0, XIOBIT_ALL, GROUP_NAMED|GROUP_FD|GROUP_TERMIOS|GROUP_PTY, XIOSHUT_NONE, XIOCLOSE_CLOSE, xioopen_pty0, 0, 0, 0 HELP("") };
|
|
static const struct xioaddr_endpoint_desc xioendpoint_pty1 = { XIOADDR_SYS, "pty", 1, XIOBIT_ALL, GROUP_NAMED|GROUP_FD|GROUP_TERMIOS|GROUP_PTY, XIOSHUT_NONE, XIOCLOSE_CLOSE, xioopen_pty1, 0, 0, 0 HELP(":<symlink>") };
|
|
|
|
const union xioaddr_desc* xioaddrs_pty[] = {
|
|
(union xioaddr_desc *)&xioendpoint_pty0,
|
|
(union xioaddr_desc *)&xioendpoint_pty1,
|
|
NULL
|
|
};
|
|
|
|
const struct optdesc opt_symbolic_link = { "symbolic-link", "link", OPT_SYMBOLIC_LINK, GROUP_PTY, PH_LATE, TYPE_FILENAME, OFUNC_SPEC, 0, 0 };
|
|
#if HAVE_POLL
|
|
const struct optdesc opt_pty_wait_slave = { "pty-wait-slave", "wait-slave", OPT_PTY_WAIT_SLAVE, GROUP_PTY, PH_EARLY, TYPE_BOOL, OFUNC_SPEC, 0, 0 };
|
|
const struct optdesc opt_pty_intervall = { "pty-interval", NULL, OPT_PTY_INTERVALL, GROUP_PTY, PH_EARLY, TYPE_TIMESPEC, OFUNC_SPEC, 0, 0 };
|
|
#endif /* HAVE_POLL */
|
|
|
|
static int xioopen_pty0(int argc, const char *argv[], struct opt *opts, int xioflags, xiofile_t *xfd, unsigned groups, int dummy1, int dummy2, int dummy3) {
|
|
char *linkname = NULL;
|
|
retropt_string(opts, OPT_SYMBOLIC_LINK, &linkname);
|
|
return xioopen_pty(linkname, opts, xioflags, xfd, groups);
|
|
}
|
|
|
|
static int xioopen_pty1(int argc, const char *argv[], struct opt *opts, int xioflags, xiofile_t *xfd, unsigned groups, int dummy1, int dummy2, int dummy3) {
|
|
return xioopen_pty(argv[1], opts, xioflags, xfd, groups);
|
|
}
|
|
|
|
static int xioopen_pty(const char *linkname, struct opt *opts, int xioflags, xiofile_t *xfd, unsigned groups) {
|
|
/* we expect the form: filename */
|
|
int ptyfd = -1, ttyfd = -1;
|
|
#if defined(HAVE_DEV_PTMX) || defined(HAVE_DEV_PTC)
|
|
bool useptmx = false; /* use /dev/ptmx or equivalent */
|
|
#endif
|
|
#if HAVE_OPENPTY
|
|
bool useopenpty = false; /* try only openpty */
|
|
#endif /* HAVE_OPENPTY */
|
|
char ptyname[MAXPTYNAMELEN];
|
|
char *tn = NULL;
|
|
bool opt_unlink_close = true; /* remove symlink afterwards */
|
|
bool wait_slave = false; /* true would be better for many platforms, but
|
|
some OSes cannot handle this, and for common
|
|
default behaviour as well as backward
|
|
compatibility we choose "no" as default */
|
|
struct timespec pollintv = { PTY_INTERVALL };
|
|
|
|
applyopts(-1, opts, PH_INIT);
|
|
if (applyopts_single(&xfd->stream, opts, PH_INIT) < 0) return -1;
|
|
|
|
retropt_bool(opts, OPT_UNLINK_CLOSE, &opt_unlink_close);
|
|
|
|
/* trying to set user-early, perm-early etc. here might be useless because
|
|
file system entry is eventually available only past pty creation */
|
|
/* name not yet known; umask should not be handled with this function! */
|
|
/* umask does not affect resulting mode, on Linux 2.4 */
|
|
applyopts_named("", opts, PH_EARLY); /* umask! */
|
|
|
|
#if defined(HAVE_DEV_PTMX) || defined(HAVE_DEV_PTC)
|
|
retropt_bool(opts, OPT_PTMX, &useptmx);
|
|
#endif
|
|
#if HAVE_OPENPTY
|
|
retropt_bool(opts, OPT_OPENPTY, &useopenpty);
|
|
#endif
|
|
|
|
#if (defined(HAVE_DEV_PTMX) || defined(HAVE_DEV_PTC))
|
|
# if HAVE_OPENPTY
|
|
useopenpty = !useptmx;
|
|
# else /* !HAVE_OPENPTY */
|
|
useptmx = true;
|
|
# endif /* !HAVE_OPENPTY */
|
|
#else
|
|
useopenpty = true;
|
|
#endif /* ! (defined(HAVE_DEV_PTMX) || defined(HAVE_DEV_PTC)) */
|
|
|
|
#if HAVE_POLL
|
|
retropt_bool(opts, OPT_PTY_WAIT_SLAVE, &wait_slave);
|
|
retropt_timespec(opts, OPT_PTY_INTERVALL, &pollintv);
|
|
#endif /* HAVE_POLL */
|
|
|
|
applyopts2(-1, opts, PH_INIT, PH_EARLY);
|
|
if (applyopts_single(&xfd->stream, opts, PH_INIT) < 0) return -1;
|
|
|
|
applyopts(-1, opts, PH_PREBIGEN);
|
|
|
|
#if defined(HAVE_DEV_PTMX)
|
|
# define PTMX "/dev/ptmx" /* Linux */
|
|
#elif HAVE_DEV_PTC
|
|
# define PTMX "/dev/ptc" /* AIX 4.3.3 */
|
|
#endif
|
|
#if HAVE_DEV_PTMX || HAVE_DEV_PTC
|
|
if (useptmx) {
|
|
if ((ptyfd = Open(PTMX, O_RDWR|O_NOCTTY, 0620)) < 0) {
|
|
Warn1("open(\""PTMX"\", O_RDWR|O_NOCTTY, 0620): %s",
|
|
strerror(errno));
|
|
/*!*/
|
|
} else {
|
|
;/*0 Info1("open(\""PTMX"\", O_RDWR|O_NOCTTY, 0620) -> %d", ptyfd);*/
|
|
}
|
|
if (ptyfd >= 0 && ttyfd < 0) {
|
|
/* we used PTMX before forking */
|
|
/*0 extern char *ptsname(int);*/
|
|
#if HAVE_GRANTPT /* AIX, not Linux */
|
|
if (Grantpt(ptyfd)/*!*/ < 0) {
|
|
Warn2("grantpt(%d): %s", ptyfd, strerror(errno));
|
|
}
|
|
#endif /* HAVE_GRANTPT */
|
|
#if HAVE_UNLOCKPT
|
|
if (Unlockpt(ptyfd)/*!*/ < 0) {
|
|
Warn2("unlockpt(%d): %s", ptyfd, strerror(errno));
|
|
}
|
|
#endif /* HAVE_UNLOCKPT */
|
|
#if HAVE_PTSNAME /* AIX, not Linux */
|
|
if ((tn = Ptsname(ptyfd)) == NULL) {
|
|
Warn2("ptsname(%d): %s", ptyfd, strerror(errno));
|
|
} else {
|
|
Notice1("PTY is %s", tn);
|
|
}
|
|
#endif /* HAVE_PTSNAME */
|
|
if (tn == NULL) {
|
|
if ((tn = Ttyname(ptyfd)) == NULL) {
|
|
Warn2("ttyname(%d): %s", ptyfd, strerror(errno));
|
|
}
|
|
}
|
|
strncpy(ptyname, tn, MAXPTYNAMELEN);
|
|
}
|
|
}
|
|
#endif /* HAVE_DEV_PTMX || HAVE_DEV_PTC */
|
|
#if HAVE_OPENPTY
|
|
if (ptyfd < 0) {
|
|
int result;
|
|
if ((result = Openpty(&ptyfd, &ttyfd, ptyname, NULL, NULL)) < 0) {
|
|
Error4("openpty(%p, %p, %p, NULL, NULL): %s",
|
|
&ptyfd, &ttyfd, ptyname, strerror(errno));
|
|
return -1;
|
|
}
|
|
Notice1("PTY is %s", ptyname);
|
|
}
|
|
#endif /* HAVE_OPENPTY */
|
|
|
|
if (linkname) {
|
|
if (Unlink(linkname) < 0 && errno != ENOENT) {
|
|
Error2("unlink(\"%s\"): %s", linkname, strerror(errno));
|
|
}
|
|
if (Symlink(ptyname, linkname) < 0) {
|
|
Error3("symlink(\"%s\", \"%s\"): %s",
|
|
ptyname, linkname, strerror(errno));
|
|
}
|
|
if (opt_unlink_close) {
|
|
if ((xfd->stream.unlink_close = strdup(linkname)) == NULL) {
|
|
Error1("strdup(\"%s\"): out of memory", linkname);
|
|
}
|
|
xfd->stream.opt_unlink_close = true;
|
|
}
|
|
}
|
|
|
|
applyopts_named(ptyname, opts, PH_PASTOPEN);
|
|
applyopts_named(ptyname, opts, PH_FD);
|
|
|
|
applyopts_cloexec(ptyfd, opts);/*!*/
|
|
xfd->stream.dtype = XIODATA_PTY;
|
|
xfd->stream.fdtype = FDTYPE_SINGLE;
|
|
|
|
applyopts(ptyfd, opts, PH_FD);
|
|
|
|
xfd->stream.fd1 = ptyfd;
|
|
applyopts(ptyfd, opts, PH_LATE);
|
|
if (applyopts_single(&xfd->stream, opts, PH_LATE) < 0) return -1;
|
|
|
|
#if HAVE_POLL
|
|
/* if you can and wish: */
|
|
if (wait_slave) {
|
|
/* try to wait until someone opens the slave side of the pty */
|
|
/* we want to get a HUP (hangup) condition on the pty */
|
|
#if HAVE_DEV_PTMX || HAVE_DEV_PTC
|
|
if (useptmx) {
|
|
ttyfd = Open(tn, O_RDWR|O_NOCTTY, 0620);
|
|
Close(ttyfd);
|
|
}
|
|
#endif
|
|
#if HAVE_OPENPTY
|
|
if (useopenpty) {
|
|
Close(ttyfd);
|
|
}
|
|
#endif /* HAVE_OPENPTY */
|
|
|
|
/* now we poll until the HUP vanishes - this indicates a slave conn. */
|
|
while (true) {
|
|
struct pollfd ufd;
|
|
ufd.fd = ptyfd;
|
|
ufd.events = (POLLHUP);
|
|
if (Poll(&ufd, 1, 0) < 0) {
|
|
Error3("poll({%d, 0x%04hu,}, 1, 0): %s",
|
|
ufd.fd, ufd.events, strerror(errno));
|
|
/*! close something */
|
|
return -1;
|
|
}
|
|
if (!(ufd.revents & POLLHUP)) {
|
|
break;
|
|
}
|
|
Nanosleep(&pollintv, NULL);
|
|
continue;
|
|
}
|
|
}
|
|
#endif /* HAVE_POLL */
|
|
|
|
return STAT_OK;
|
|
}
|
|
#endif /* WITH_PTY */
|