term-utils/scriptreplay.c

   1 /*
   2  * Copyright (C) 2008-2019, Karel Zak <kzak@redhat.com>
   3  * Copyright (C) 2008, James Youngman <jay@gnu.org>
   4  *
   5  * This file is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This file is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  *
  16  * Based on scriptreplay.pl by Joey Hess <joey@kitenet.net>
  17  */
  18
  19 #include <stdio.h>
  20 #include <stdarg.h>
  21 #include <stdlib.h>
  22 #include <string.h>
  23 #include <errno.h>
  24 #include <time.h>
  25 #include <limits.h>
  26 #include <math.h>
  27 #include <sys/select.h>
  28 #include <unistd.h>
  29 #include <getopt.h>
  30 #include <sys/time.h>
  31 #include <termios.h>
  32
  33 #include "c.h"
  34 #include "xalloc.h"
  35 #include "closestream.h"
  36 #include "nls.h"
  37 #include "strutils.h"
  38 #include "optutils.h"
  39 #include "script-playutils.h"
  40
  41 static void __attribute__((__noreturn__))
  42 usage(void)
  43 {
  44         FILE *out = stdout;
  45         fputs(USAGE_HEADER, out);
  46         fprintf(out,
  47               _(" %s [options]\n"),
  48               program_invocation_short_name);
  49         fprintf(out,
  50               _(" %s [-t] timingfile [typescript] [divisor]\n"),
  51               program_invocation_short_name);
  52
  53         fputs(USAGE_SEPARATOR, out);
  54         fputs(_("Play back terminal typescripts, using timing information.\n"), out);
  55
  56         fputs(USAGE_OPTIONS, out);
  57         fputs(_(" -t, --timing <file>     script timing log file\n"), out);
  58         fputs(_(" -T, --log-timing <file> alias to -t\n"), out);
  59         fputs(_(" -I, --log-in <file>     script stdin log file\n"), out);
  60         fputs(_(" -O, --log-out <file>    script stdout log file (default)\n"), out);
  61         fputs(_(" -B, --log-io <file>     script stdin and stdout log file\n"), out);
  62         fputs(USAGE_SEPARATOR, out);
  63         fputs(_(" -s, --typescript <file> deprecated alias to -O\n"), out);
  64
  65         fputs(USAGE_SEPARATOR, out);
  66         fputs(_("     --summary           display overview about recorded session and exit\n"), out);
  67         fputs(_(" -d, --divisor <num>     speed up or slow down execution with time divisor\n"), out);
  68         fputs(_(" -m, --maxdelay <num>    wait at most this many seconds between updates\n"), out);
  69         fputs(_(" -x, --stream <name>     stream type (out, in, signal or info)\n"), out);
  70         fputs(_(" -c, --cr-mode <type>    CR char mode (auto, never, always)\n"), out);
  71         fprintf(out, USAGE_HELP_OPTIONS(25));
  72
  73         fprintf(out, USAGE_MAN_TAIL("scriptreplay(1)"));
  74         exit(EXIT_SUCCESS);
  75 }
  76
  77 static double
  78 getnum(const char *s)
  79 {
  80         const double d = strtod_or_err(s, _("failed to parse number"));
  81
  82         if (isnan(d)) {
  83                 errno = EINVAL;
  84                 err(EXIT_FAILURE, "%s: %s", _("failed to parse number"), s);
  85         }
  86         return d;
  87 }
  88
  89 static void
  90 delay_for(struct timeval *delay)
  91 {
  92 #ifdef HAVE_NANOSLEEP
  93         struct timespec ts, remainder;
  94         ts.tv_sec = (time_t) delay->tv_sec;
  95         ts.tv_nsec = delay->tv_usec * 1000;
  96
  97         DBG(TIMING, ul_debug("going to sleep for %"PRId64".%06"PRId64,
  98                         (int64_t) delay->tv_sec, (int64_t) delay->tv_usec));
  99
 100         while (-1 == nanosleep(&ts, &remainder)) {
 101                 if (EINTR == errno)
 102                         ts = remainder;
 103                 else
 104                         break;
 105         }
 106 #else
 107         select(0, NULL, NULL, NULL, delay);
 108 #endif
 109 }
 110
 111 static void
 112 appendchr(char *buf, size_t bufsz, int c)
 113 {
 114         size_t sz;
 115
 116         if (strchr(buf, c))
 117                 return;         /* already in */
 118
 119         sz = strlen(buf);
 120         if (sz + 1 < bufsz)
 121                 buf[sz] = c;
 122 }
 123
 124 static int
 125 setterm(struct termios *backup)
 126 {
 127         struct termios tattr;
 128
 129         if (tcgetattr(STDOUT_FILENO, backup) != 0) {
 130                 if (errno != ENOTTY) /* For debugger. */
 131                         err(EXIT_FAILURE, _("unexpected tcgetattr failure"));
 132                 return 0;
 133         }
 134         tattr = *backup;
 135         cfmakeraw(&tattr);
 136         tattr.c_lflag |= ISIG;
 137         tattr.c_iflag |= IXON;
 138         tcsetattr(STDOUT_FILENO, TCSANOW, &tattr);
 139         return 1;
 140 }
 141
 142 int
 143 main(int argc, char *argv[])
 144 {
 145         static const struct timeval mindelay = { .tv_sec = 0, .tv_usec = 100 };
 146         struct timeval maxdelay;
 147
 148         int isterm;
 149         struct termios saved;
 150
 151         struct replay_setup *setup = NULL;
 152         struct replay_step *step = NULL;
 153         char streams[6] = {0};          /* IOSI - in, out, signal,info */
 154         const char *log_out = NULL,
 155                    *log_in = NULL,
 156                    *log_io = NULL,
 157                    *log_tm = NULL;
 158         double divi = 1;
 159         int diviopt = FALSE, idx;
 160         int ch, rc, crmode = REPLAY_CRMODE_AUTO, summary = 0;
 161         enum {
 162                 OPT_SUMMARY = CHAR_MAX + 1
 163         };
 164
 165         static const struct option longopts[] = {
 166                 { "cr-mode",    required_argument,      0, 'c' },
 167                 { "timing",     required_argument,      0, 't' },
 168                 { "log-timing", required_argument,      0, 'T' },
 169                 { "log-in",     required_argument,      0, 'I' },
 170                 { "log-out",    required_argument,      0, 'O' },
 171                 { "log-io",     required_argument,      0, 'B' },
 172                 { "typescript", required_argument,      0, 's' },
 173                 { "divisor",    required_argument,      0, 'd' },
 174                 { "maxdelay",   required_argument,      0, 'm' },
 175                 { "stream",     required_argument,      0, 'x' },
 176                 { "summary",    no_argument,            0, OPT_SUMMARY },
 177                 { "version",    no_argument,            0, 'V' },
 178                 { "help",       no_argument,            0, 'h' },
 179                 { NULL,         0, 0, 0 }
 180         };
 181         static const ul_excl_t excl[] = {       /* rows and cols in ASCII order */
 182                 { 'O', 's' },
 183                 { 0 }
 184         };
 185         int excl_st[ARRAY_SIZE(excl)] = UL_EXCL_STATUS_INIT;
 186         /* Because we use space as a separator, we can't afford to use any
 187          * locale which tolerates a space in a number.  In any case, script.c
 188          * sets the LC_NUMERIC locale to C, anyway.
 189          */
 190         setlocale(LC_ALL, "");
 191         setlocale(LC_NUMERIC, "C");
 192
 193         bindtextdomain(PACKAGE, LOCALEDIR);
 194         textdomain(PACKAGE);
 195         close_stdout_atexit();
 196
 197         replay_init_debug();
 198         timerclear(&maxdelay);
 199
 200         while ((ch = getopt_long(argc, argv, "B:c:I:O:T:t:s:d:m:x:Vh", longopts, NULL)) != -1) {
 201
 202                 err_exclusive_options(ch, longopts, excl, excl_st);
 203
 204                 switch(ch) {
 205                 case 'c':
 206                         if (strcmp("auto", optarg) == 0)
 207                                 crmode = REPLAY_CRMODE_AUTO;
 208                         else if (strcmp("never", optarg) == 0)
 209                                 crmode = REPLAY_CRMODE_NEVER;
 210                         else if (strcmp("always", optarg) == 0)
 211                                 crmode = REPLAY_CRMODE_ALWAYS;
 212                         else
 213                                 errx(EXIT_FAILURE, _("unsupported mode name: '%s'"), optarg);
 214                         break;
 215                 case 't':
 216                 case 'T':
 217                         log_tm = optarg;
 218                         break;
 219                 case 'O':
 220                 case 's':
 221                         log_out = optarg;
 222                         break;
 223                 case 'I':
 224                         log_in = optarg;
 225                         break;
 226                 case 'B':
 227                         log_io = optarg;
 228                         break;
 229                 case 'd':
 230                         diviopt = TRUE;
 231                         divi = getnum(optarg);
 232                         break;
 233                 case 'm':
 234                         strtotimeval_or_err(optarg, &maxdelay, _("failed to parse maximal delay argument"));
 235                         break;
 236                 case 'x':
 237                         if (strcmp("in", optarg) == 0)
 238                                 appendchr(streams, sizeof(streams), 'I');
 239                         else if (strcmp("out", optarg) == 0)
 240                                 appendchr(streams, sizeof(streams), 'O');
 241                         else if (strcmp("signal", optarg) == 0)
 242                                 appendchr(streams, sizeof(streams), 'S');
 243                         else if (strcmp("info", optarg) == 0)
 244                                 appendchr(streams, sizeof(streams), 'H');
 245                         else
 246                                 errx(EXIT_FAILURE, _("unsupported stream name: '%s'"), optarg);
 247                         break;
 248                 case OPT_SUMMARY:
 249                         summary = 1;
 250                         break;
 251                 case 'V':
 252                         print_version(EXIT_SUCCESS);
 253                 case 'h':
 254                         usage();
 255                 default:
 256                         errtryhelp(EXIT_FAILURE);
 257                 }
 258         }
 259         argc -= optind;
 260         argv += optind;
 261         idx = 0;
 262
 263         if (summary)
 264                 streams[0] = 'H', streams[1] = '\0';
 265
 266         if (!log_tm && idx < argc)
 267                 log_tm = argv[idx++];
 268         if (!log_out && !summary && !log_in && !log_io)
 269                 log_out = idx < argc ? argv[idx++] : "typescript";
 270
 271         if (!diviopt)
 272                 divi = idx < argc ? getnum(argv[idx]) : 1;
 273
 274         if (!log_tm)
 275                 errx(EXIT_FAILURE, _("timing file not specified"));
 276         if (!(log_out || log_in || log_io) && !summary)
 277                 errx(EXIT_FAILURE, _("data log file not specified"));
 278
 279         setup = replay_new_setup();
 280
 281         if (replay_set_timing_file(setup, log_tm) != 0)
 282                 err(EXIT_FAILURE, _("cannot open %s"), log_tm);
 283
 284         if (log_out && replay_associate_log(setup, "O", log_out) != 0)
 285                 err(EXIT_FAILURE, _("cannot open %s"), log_out);
 286
 287         if (log_in && replay_associate_log(setup, "I", log_in) != 0)
 288                 err(EXIT_FAILURE, _("cannot open %s"), log_in);
 289
 290         if (log_io && replay_associate_log(setup, "IO", log_io) != 0)
 291                 err(EXIT_FAILURE, _("cannot open %s"), log_io);
 292
 293         if (!*streams) {
 294                 /* output is preferred default */
 295                 if (log_out || log_io)
 296                         appendchr(streams, sizeof(streams), 'O');
 297                 else if (log_in)
 298                         appendchr(streams, sizeof(streams), 'I');
 299         }
 300
 301         replay_set_default_type(setup,
 302                         *streams && streams[1] == '\0' ? *streams : 'O');
 303         replay_set_crmode(setup, crmode);
 304
 305         if (divi != 1)
 306                 replay_set_delay_div(setup, divi);
 307         if (timerisset(&maxdelay))
 308                 replay_set_delay_max(setup, &maxdelay);
 309         replay_set_delay_min(setup, &mindelay);
 310
 311         isterm = setterm(&saved);
 312
 313         do {
 314                 rc = replay_get_next_step(setup, streams, &step);
 315                 if (rc)
 316                         break;
 317
 318                 if (!summary) {
 319                         struct timeval *delay = replay_step_get_delay(step);
 320
 321                         if (delay && timerisset(delay))
 322                                 delay_for(delay);
 323                 }
 324                 rc = replay_emit_step_data(setup, step, STDOUT_FILENO);
 325         } while (rc == 0);
 326
 327         if (isterm)
 328                 tcsetattr(STDOUT_FILENO, TCSADRAIN, &saved);
 329
 330         if (step && rc < 0)
 331                 err(EXIT_FAILURE, _("%s: log file error"), replay_step_get_filename(step));
 332         else if (rc < 0)
 333                 err(EXIT_FAILURE, _("%s: line %d: timing file error"),
 334                                 replay_get_timing_file(setup),
 335                                 replay_get_timing_line(setup));
 336         printf("\n");
 337         replay_free_setup(setup);
 338
 339         exit(EXIT_SUCCESS);
 340 }