#include "ttyutils.h"
#include "all-io.h"
#include "monotonic.h"
+#include "timeutils.h"
+#include "strutils.h"
+#include "xalloc.h"
#include "debug.h"
-UL_DEBUG_DEFINE_MASK(script);
+static UL_DEBUG_DEFINE_MASK(script);
UL_DEBUG_DEFINE_MASKNAMES(script) = UL_DEBUG_EMPTY_MASKNAMES;
#define SCRIPT_DEBUG_INIT (1 << 1)
#define DEFAULT_TYPESCRIPT_FILENAME "typescript"
+enum {
+ SCRIPT_FMT_RAW = 1, /* raw slave/master data */
+ SCRIPT_FMT_TIMING_SIMPLE, /* timing info in classic "<time> <delta>" format */
+};
+
+struct script_log {
+ FILE *fp; /* file pointer (handler) */
+ int format; /* SCRIPT_FMT_* */
+ char *filename; /* on command line specified name */
+ struct timeval oldtime; /* previous entry log time */
+};
+
+struct script_stream {
+ struct timeval oldtime; /* last update */
+ struct script_log **logs; /* logs where to write data from stream */
+ size_t nlogs; /* number of logs */
+};
+
struct script_control {
char *shell; /* shell to be executed */
char *command; /* command to be executed */
- char *fname; /* output file path */
- FILE *typescriptfp; /* output file pointer */
- char *tname; /* timing file path */
- FILE *timingfp; /* timing file pointer */
- struct timeval oldtime; /* previous write or command start time */
+ uint64_t outsz; /* current output files size */
+ uint64_t maxsz; /* maximum output files size */
+
int master; /* pseudoterminal master file descriptor */
int slave; /* pseudoterminal slave file descriptor */
+
+ struct script_stream out; /* output */
+ struct script_stream in; /* input */
+
int poll_timeout; /* poll() timeout, used in end of execution */
pid_t child; /* child pid */
int childstatus; /* child process exit value */
struct termios attrs; /* slave terminal runtime attributes */
struct winsize win; /* terminal window size */
#if !HAVE_LIBUTIL || !HAVE_PTY_H
- char line *; /* terminal line */
+ char *line; /* terminal line */
#endif
unsigned int
append:1, /* append output */
rc_wanted:1, /* return child exit value */
flush:1, /* flush after each write */
quiet:1, /* suppress most output */
- timing:1, /* include timing file */
force:1, /* write output to links */
isterm:1, /* is child process running as terminal */
die:1; /* terminate program */
int sigfd; /* file descriptor for signalfd() */
};
+static void restore_tty(struct script_control *ctl, int mode);
+static void __attribute__((__noreturn__)) fail(struct script_control *ctl);
+
static void script_init_debug(void)
{
- __UL_INIT_DEBUG(script, SCRIPT_DEBUG_, 0, SCRIPT_DEBUG);
+ __UL_INIT_DEBUG_FROM_ENV(script, SCRIPT_DEBUG_, 0, SCRIPT_DEBUG);
}
/*
# define script_time(x) time(x)
#endif
-static void __attribute__((__noreturn__)) usage(FILE *out)
+static void __attribute__((__noreturn__)) usage(void)
{
+ FILE *out = stdout;
fputs(USAGE_HEADER, out);
fprintf(out, _(" %s [options] [file]\n"), program_invocation_short_name);
fputs(_("Make a typescript of a terminal session.\n"), out);
fputs(USAGE_OPTIONS, out);
- fputs(_(" -a, --append append the output\n"
- " -c, --command <command> run command rather than interactive shell\n"
- " -e, --return return exit code of the child process\n"
- " -f, --flush run flush after each write\n"
- " --force use output file even when it is a link\n"
- " -q, --quiet be quiet\n"
- " -t, --timing[=<file>] output timing data to stderr (or to FILE)\n"
- " -V, --version output version information and exit\n"
- " -h, --help display this help and exit\n\n"), out);
-
- fprintf(out, USAGE_MAN_TAIL("script(1)"));
- exit(out == stderr ? EXIT_FAILURE : EXIT_SUCCESS);
+ fputs(_(" -O, --log-out <file> log stdout to file (default)\n"), out);
+ fputs(_(" -a, --append append the output\n"), out);
+ fputs(_(" -c, --command <command> run command rather than interactive shell\n"), out);
+ fputs(_(" -e, --return return exit code of the child process\n"), out);
+ fputs(_(" -f, --flush run flush after each write\n"), out);
+ fputs(_(" --force use output file even when it is a link\n"), out);
+ fputs(_(" -o, --output-limit <size> terminate if output files exceed size\n"), out);
+ fputs(_(" -q, --quiet be quiet\n"), out);
+ fputs(_(" -t[<file>], --timing[=<file>] output timing data to stderr or to FILE\n"), out);
+
+ fputs(USAGE_SEPARATOR, out);
+ printf(USAGE_HELP_OPTIONS(31));
+ printf(USAGE_MAN_TAIL("script(1)"));
+
+ exit(EXIT_SUCCESS);
+}
+
+static struct script_log *get_log_by_name(struct script_stream *stream,
+ const char *name)
+{
+ size_t i;
+
+ for (i = 0; i < stream->nlogs; i++) {
+ struct script_log *log = stream->logs[i];
+ if (strcmp(log->filename, name) == 0)
+ return log;
+ }
+ return NULL;
+}
+
+static struct script_log *log_associate(struct script_control *ctl,
+ struct script_stream *stream,
+ const char *filename, int format)
+{
+ struct script_log *log;
+
+ assert(ctl);
+ assert(filename);
+ assert(stream);
+
+ log = get_log_by_name(stream, filename);
+ if (log)
+ return log; /* already defined */
+
+ log = get_log_by_name(stream == &ctl->out ? &ctl->in : &ctl->out, filename);
+ if (!log) {
+ /* create a new log */
+ log = xcalloc(1, sizeof(*log));
+ log->filename = xstrdup(filename);
+ log->format = format;
+ }
+
+ /* add log to the stream */
+ stream->logs = xrealloc(stream->logs,
+ (stream->nlogs + 1) * sizeof(log));
+ stream->logs[stream->nlogs] = log;
+ stream->nlogs++;
+
+ return log;
+}
+
+static void log_close(struct script_control *ctl __attribute__((unused)),
+ struct script_log *log,
+ const char *msg,
+ int status)
+{
+ DBG(MISC, ul_debug("closing %s", log->filename));
+
+ switch (log->format) {
+ case SCRIPT_FMT_RAW:
+ {
+ char buf[FORMAT_TIMESTAMP_MAX];
+ time_t tvec = script_time((time_t *)NULL);
+
+ strtime_iso(&tvec, ISO_TIMESTAMP, buf, sizeof(buf));
+ if (msg)
+ fprintf(log->fp, _("\nScript done on %s [<%s>]\n"), buf, msg);
+ else
+ fprintf(log->fp, _("\nScript done on %s [COMMAND_EXIT_CODE=\"%d\"]\n"), buf, status);
+ break;
+ }
+ case SCRIPT_FMT_TIMING_SIMPLE:
+ break;
+ }
+
+ if (close_stream(log->fp) != 0)
+ err(EXIT_FAILURE, "write failed: %s", log->filename);
+
+ log->fp = NULL;
+}
+
+static void log_start(struct script_control *ctl,
+ struct script_log *log)
+{
+
+ assert(log->fp == NULL);
+
+ DBG(MISC, ul_debug("opening %s", log->filename));
+
+ /* open the log */
+ log->fp = fopen(log->filename,
+ ctl->append && log->format == SCRIPT_FMT_RAW ?
+ "a" UL_CLOEXECSTR :
+ "w" UL_CLOEXECSTR);
+ if (!log->fp) {
+ restore_tty(ctl, TCSANOW);
+ warn(_("cannot open %s"), log->filename);
+ fail(ctl);
+ }
+
+ /* write header, etc. */
+ switch (log->format) {
+ case SCRIPT_FMT_RAW:
+ {
+ char buf[FORMAT_TIMESTAMP_MAX];
+ time_t tvec = script_time((time_t *)NULL);
+
+ strtime_iso(&tvec, ISO_TIMESTAMP, buf, sizeof(buf));
+ fprintf(log->fp, _("Script started on %s ["), buf);
+
+ if (ctl->isterm) {
+ int cols = 0, lines = 0;
+ const char *tty = NULL, *term = NULL;
+
+ get_terminal_dimension(&cols, &lines);
+ get_terminal_name(&tty, NULL, NULL);
+ get_terminal_type(&term);
+
+ if (term)
+ fprintf(log->fp, "TERM=\"%s\" ", term);
+ if (tty)
+ fprintf(log->fp, "TTY=\"%s\" ", tty);
+
+ fprintf(log->fp, "COLUMNS=\"%d\" LINES=\"%d\"", cols, lines);
+ } else
+ fprintf(log->fp, _("<not executed on terminal>"));
+
+ fputs("]\n", log->fp);
+ break;
+ }
+ case SCRIPT_FMT_TIMING_SIMPLE:
+ gettime_monotonic(&log->oldtime);
+ break;
+ }
+}
+
+static size_t log_write(struct script_control *ctl,
+ struct script_log *log,
+ char *obuf, size_t bytes)
+{
+ if (!log->fp)
+ return 0;
+
+ DBG(IO, ul_debug(" writining %s", log->filename));
+
+ switch (log->format) {
+ case SCRIPT_FMT_RAW:
+ if (fwrite_all(obuf, 1, bytes, log->fp)) {
+ warn(_("cannot write %s"), log->filename);
+ fail(ctl);
+ }
+ break;
+ case SCRIPT_FMT_TIMING_SIMPLE:
+ {
+ struct timeval now, delta;
+ int sz;
+
+ DBG(IO, ul_debug(" writing timing info"));
+
+ gettime_monotonic(&now);
+ timersub(&now, &log->oldtime, &delta);
+ sz = fprintf(log->fp, "%ld.%06ld %zd\n",
+ (long)delta.tv_sec, (long)delta.tv_usec, bytes);
+ log->oldtime = now;
+ bytes = sz > 0 ? sz : 0;
+ break;
+ }
+ default:
+ break;
+ }
+
+ if (ctl->flush)
+ fflush(log->fp);
+
+ return bytes;
+}
+
+static uint64_t log_stream_activity(
+ struct script_control *ctl,
+ struct script_stream *stream,
+ char *buf, size_t bytes)
+{
+ size_t i;
+ uint64_t outsz = 0;
+
+ for (i = 0; i < stream->nlogs; i++)
+ outsz += log_write(ctl, stream->logs[i], buf, bytes);
+
+ return outsz;
}
-static void die_if_link(const struct script_control *ctl)
+
+static void die_if_link(struct script_control *ctl, const char *filename)
{
struct stat s;
if (ctl->force)
return;
- if (lstat(ctl->fname, &s) == 0 && (S_ISLNK(s.st_mode) || s.st_nlink > 1))
+ if (lstat(filename, &s) == 0 && (S_ISLNK(s.st_mode) || s.st_nlink > 1))
errx(EXIT_FAILURE,
_("output file `%s' is a link\n"
"Use --force if you really want to use it.\n"
- "Program not started."), ctl->fname);
+ "Program not started."), filename);
}
-static void __attribute__((__noreturn__)) done(struct script_control *ctl)
+static void restore_tty(struct script_control *ctl, int mode)
+{
+ struct termios rtt;
+
+ if (!ctl->isterm)
+ return;
+
+ rtt = ctl->attrs;
+ tcsetattr(STDIN_FILENO, mode, &rtt);
+}
+
+static void enable_rawmode_tty(struct script_control *ctl)
+{
+ struct termios rtt;
+
+ if (!ctl->isterm)
+ return;
+
+ rtt = ctl->attrs;
+ cfmakeraw(&rtt);
+ rtt.c_lflag &= ~ECHO;
+ tcsetattr(STDIN_FILENO, TCSANOW, &rtt);
+}
+
+static void __attribute__((__noreturn__)) done_log(struct script_control *ctl, const char *msg)
{
+ int status;
+ size_t i;
+
DBG(MISC, ul_debug("done!"));
- if (ctl->isterm)
- tcsetattr(STDIN_FILENO, TCSADRAIN, &ctl->attrs);
- if (!ctl->quiet && ctl->typescriptfp)
- printf(_("Script done, file is %s\n"), ctl->fname);
+ restore_tty(ctl, TCSADRAIN);
+
+ if (WIFSIGNALED(ctl->childstatus))
+ status = WTERMSIG(ctl->childstatus) + 0x80;
+ else
+ status = WEXITSTATUS(ctl->childstatus);
+
+
+ DBG(MISC, ul_debug(" status=%d", status));
+
+ /* close all output logs */
+ for (i = 0; i < ctl->out.nlogs; i++)
+ log_close(ctl, ctl->out.logs[i], msg, status);
+
+ /* close all input logs */
+ for (i = 0; i < ctl->in.nlogs; i++)
+ log_close(ctl, ctl->in.logs[i], msg, status);
+
+ if (!ctl->quiet)
+ printf(_("Script done.\n"));
+
#ifdef HAVE_LIBUTEMPTER
if (ctl->master >= 0)
utempter_remove_record(ctl->master);
#endif
kill(ctl->child, SIGTERM); /* make sure we don't create orphans */
+ exit(ctl->rc_wanted ? status : EXIT_SUCCESS);
+}
- if (ctl->timingfp && close_stream(ctl->timingfp) != 0)
- err(EXIT_FAILURE, "write failed: %s", ctl->tname);
- if (ctl->typescriptfp && close_stream(ctl->typescriptfp) != 0)
- err(EXIT_FAILURE, "write failed: %s", ctl->fname);
-
- if (ctl->rc_wanted) {
- if (WIFSIGNALED(ctl->childstatus))
- exit(WTERMSIG(ctl->childstatus) + 0x80);
- else
- exit(WEXITSTATUS(ctl->childstatus));
- }
- exit(EXIT_SUCCESS);
+static void __attribute__((__noreturn__)) done(struct script_control *ctl)
+{
+ done_log(ctl, NULL);
}
static void __attribute__((__noreturn__)) fail(struct script_control *ctl)
ctl->childstatus = status;
}
+/* data from master to stdout */
static void write_output(struct script_control *ctl, char *obuf,
ssize_t bytes)
{
- DBG(IO, ul_debug(" writing output"));
-
- if (ctl->timing && ctl->timingfp) {
- struct timeval now, delta;
-
- DBG(IO, ul_debug(" writing timing info"));
-
- gettime_monotonic(&now);
- timersub(&now, &ctl->oldtime, &delta);
- fprintf(ctl->timingfp, "%ld.%06ld %zd\n",
- (long)delta.tv_sec, (long)delta.tv_usec, bytes);
- if (ctl->flush)
- fflush(ctl->timingfp);
- ctl->oldtime = now;
- }
-
- DBG(IO, ul_debug(" writing to script file"));
-
- if (fwrite_all(obuf, 1, bytes, ctl->typescriptfp)) {
- warn(_("cannot write script file"));
- fail(ctl);
- }
- if (ctl->flush)
- fflush(ctl->typescriptfp);
-
DBG(IO, ul_debug(" writing to output"));
if (write_all(STDOUT_FILENO, obuf, bytes)) {
warn(_("write failed"));
fail(ctl);
}
-
- DBG(IO, ul_debug(" writing output *done*"));
}
static int write_to_shell(struct script_control *ctl,
{
char buf[BUFSIZ];
ssize_t bytes;
-
DBG(IO, ul_debug("%d FD active", fd));
*eof = 0;
/* without sync write_output() will write both input &
* shell output that looks like double echoing */
fdatasync(ctl->master);
+ ctl->outsz += log_stream_activity(ctl, &ctl->in, buf, (size_t) bytes);
- /* from command (master) to stdout */
+ /* from command (master) to stdout and log */
} else if (fd == ctl->master) {
DBG(IO, ul_debug(" master --> stdout %zd bytes", bytes));
write_output(ctl, buf, bytes);
+ ctl->outsz += log_stream_activity(ctl, &ctl->out, buf, (size_t) bytes);
+ }
+
+ /* check output limit */
+ if (ctl->maxsz != 0 && ctl->outsz >= ctl->maxsz) {
+ if (!ctl->quiet)
+ printf(_("Script terminated, max output files size %"PRIu64" exceeded.\n"), ctl->maxsz);
+ DBG(IO, ul_debug("output size %"PRIu64", exceeded limit %"PRIu64, ctl->outsz, ctl->maxsz));
+ done_log(ctl, _("max output size exceeded"));
}
}
switch (info.ssi_signo) {
case SIGCHLD:
- DBG(SIGNAL, ul_debug(" get signal SIGCHLD"));
- wait_for_child(ctl, 0);
- ctl->poll_timeout = 10;
+ DBG(SIGNAL, ul_debug(" get signal SIGCHLD [ssi_code=%d, ssi_status=%d]",
+ info.ssi_code, info.ssi_status));
+ if (info.ssi_code == CLD_EXITED
+ || info.ssi_code == CLD_KILLED
+ || info.ssi_code == CLD_DUMPED) {
+ wait_for_child(ctl, 0);
+ ctl->poll_timeout = 10;
+
+ /* In case of ssi_code is CLD_TRAPPED, CLD_STOPPED, or CLD_CONTINUED */
+ } else if (info.ssi_status == SIGSTOP && ctl->child) {
+ DBG(SIGNAL, ul_debug(" child stop by SIGSTOP -- stop parent too"));
+ kill(getpid(), SIGSTOP);
+ DBG(SIGNAL, ul_debug(" resume"));
+ kill(ctl->child, SIGCONT);
+ }
return;
case SIGWINCH:
DBG(SIGNAL, ul_debug(" get signal SIGWINCH"));
default:
abort();
}
+ DBG(SIGNAL, ul_debug("signal handle on FD %d done", fd));
}
static void do_io(struct script_control *ctl)
{
- int ret, ignore_stdin = 0, eof = 0;
- time_t tvec = script_time((time_t *)NULL);
- char buf[128];
+ int ret, eof = 0;
+ size_t i;
enum {
POLLFD_SIGNAL = 0,
POLLFD_MASTER,
- POLLFD_STDIN /* optional; keep it last, see ignore_stdin */
+ POLLFD_STDIN
};
struct pollfd pfd[] = {
};
- if ((ctl->typescriptfp =
- fopen(ctl->fname, ctl->append ? "a" UL_CLOEXECSTR : "w" UL_CLOEXECSTR)) == NULL) {
- warn(_("cannot open %s"), ctl->fname);
- fail(ctl);
- }
- if (ctl->timing) {
- if (!ctl->tname) {
- if (!(ctl->timingfp = fopen("/dev/stderr", "w" UL_CLOEXECSTR)))
- err(EXIT_FAILURE, _("cannot open %s"), "/dev/stderr");
- } else if (!(ctl->timingfp = fopen(ctl->tname, "w" UL_CLOEXECSTR)))
- err(EXIT_FAILURE, _("cannot open %s"), ctl->tname);
- }
-
+ /* start all output logs */
+ for (i = 0; i < ctl->out.nlogs; i++)
+ log_start(ctl, ctl->out.logs[i]);
- strftime(buf, sizeof buf, "%c\n", localtime(&tvec));
- fprintf(ctl->typescriptfp, _("Script started on %s"), buf);
- gettime_monotonic(&ctl->oldtime);
+ /* start all input logs */
+ for (i = 0; i < ctl->in.nlogs; i++)
+ log_start(ctl, ctl->in.logs[i]);
while (!ctl->die) {
size_t i;
DBG(POLL, ul_debug("calling poll()"));
/* wait for input or signal */
- ret = poll(pfd, ARRAY_SIZE(pfd) - ignore_stdin, ctl->poll_timeout);
+ ret = poll(pfd, ARRAY_SIZE(pfd), ctl->poll_timeout);
errsv = errno;
DBG(POLL, ul_debug("poll() rc=%d", ret));
break;
}
- for (i = 0; i < ARRAY_SIZE(pfd) - ignore_stdin; i++) {
+ for (i = 0; i < ARRAY_SIZE(pfd); i++) {
if (pfd[i].revents == 0)
continue;
if ((pfd[i].revents & POLLHUP) || eof) {
DBG(POLL, ul_debug(" ignore FD"));
pfd[i].fd = -1;
- /* according to man poll() set FD to -1 can't be used to ignore
- * STDIN, so let's remove the FD from pool at all */
if (i == POLLFD_STDIN) {
- ignore_stdin = 1;
write_eof_to_shell(ctl);
DBG(POLL, ul_debug(" ignore STDIN"));
}
if (!ctl->die)
wait_for_child(ctl, 1);
- if (!ctl->quiet && ctl->typescriptfp) {
- tvec = script_time((time_t *)NULL);
- strftime(buf, sizeof buf, "%c\n", localtime(&tvec));
- fprintf(ctl->typescriptfp, _("\nScript done on %s"), buf);
- }
+
done(ctl);
}
fail(ctl);
}
-static void fixtty(struct script_control *ctl)
-{
- struct termios rtt;
-
- if (!ctl->isterm)
- return;
-
- rtt = ctl->attrs;
- cfmakeraw(&rtt);
- rtt.c_lflag &= ~ECHO;
- tcsetattr(STDIN_FILENO, TCSANOW, &rtt);
-}
static void getmaster(struct script_control *ctl)
{
.line = "/dev/ptyXX",
#endif
.master = -1,
- .poll_timeout = -1,
- 0
+ .slave = -1,
+
+ .poll_timeout = -1
};
int ch;
+ const char *typescript = DEFAULT_TYPESCRIPT_FILENAME;
+ const char *timingfile = NULL;
enum { FORCE_OPTION = CHAR_MAX + 1 };
{"return", no_argument, NULL, 'e'},
{"flush", no_argument, NULL, 'f'},
{"force", no_argument, NULL, FORCE_OPTION,},
+ {"log-out", required_argument, NULL, 'O'},
+ {"output-limit", required_argument, NULL, 'o'},
{"quiet", no_argument, NULL, 'q'},
{"timing", optional_argument, NULL, 't'},
{"version", no_argument, NULL, 'V'},
setlocale(LC_NUMERIC, "C");
bindtextdomain(PACKAGE, LOCALEDIR);
textdomain(PACKAGE);
- atexit(close_stdout);
+ close_stdout_atexit();
script_init_debug();
- while ((ch = getopt_long(argc, argv, "ac:efqt::Vh", longopts, NULL)) != -1)
+ while ((ch = getopt_long(argc, argv, "ac:efO:o:qt::Vh", longopts, NULL)) != -1)
switch (ch) {
case 'a':
ctl.append = 1;
case FORCE_OPTION:
ctl.force = 1;
break;
+ case 'O':
+ typescript = optarg;
+ break;
+ case 'o':
+ ctl.maxsz = strtosize_or_err(optarg, _("failed to parse output limit size"));
+ break;
case 'q':
ctl.quiet = 1;
break;
case 't':
- if (optarg)
- ctl.tname = optarg;
- ctl.timing = 1;
+ if (optarg && *optarg == '=')
+ optarg++;
+ log_associate(&ctl, &ctl.out,
+ optarg ? optarg : "/dev/stderr",
+ SCRIPT_FMT_TIMING_SIMPLE);
+ /* used for message only */
+ timingfile = optarg ? optarg : "stderr";
break;
+
case 'V':
- printf(UTIL_LINUX_VERSION);
- exit(EXIT_SUCCESS);
- break;
+ print_version(EXIT_SUCCESS);
case 'h':
- usage(stdout);
- break;
+ usage();
default:
- usage(stderr);
+ errtryhelp(EXIT_FAILURE);
}
argc -= optind;
argv += optind;
- if (argc > 0)
- ctl.fname = argv[0];
- else {
- ctl.fname = DEFAULT_TYPESCRIPT_FILENAME;
- die_if_link(&ctl);
+ if (!typescript) {
+ if (argc > 0)
+ typescript = argv[0];
+ else
+ die_if_link(&ctl, DEFAULT_TYPESCRIPT_FILENAME);
}
+ /* associate stdout with typescript file */
+ log_associate(&ctl, &ctl.out, typescript, SCRIPT_FMT_RAW);
+
ctl.shell = getenv("SHELL");
if (ctl.shell == NULL)
ctl.shell = _PATH_BSHELL;
getmaster(&ctl);
- if (!ctl.quiet)
- printf(_("Script started, file is %s\n"), ctl.fname);
- fixtty(&ctl);
+ if (!ctl.quiet) {
+ if (!timingfile)
+ printf(_("Script started, log file is '%s'.\n"), typescript);
+ else
+ printf(_("Script started, log file is '%s', timing file is '%s'.\n"),
+ typescript, timingfile);
+ }
+ enable_rawmode_tty(&ctl);
#ifdef HAVE_LIBUTEMPTER
utempter_add_record(ctl.master, NULL);
projects / thirdparty / util-linux.git / blobdiff