GCOV - Varnish Cache


/*-
 * Copyright (c) 2015 Varnish Software AS
 * All rights reserved.
 *
 * Author: Dridi Boukelmoune <dridi@varnish-software.com>
 *
 * SPDX-License-Identifier: BSD-2-Clause
 *
 * 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.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR 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 AUTHOR 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.
 *
 * XXX:
 *      -ignore-stderr (otherwise output to stderr is fail)
 */

#include "config.h"

#include <sys/ioctl.h>          // Linux: struct winsize

#include <ctype.h>
#include <fcntl.h>
#include <inttypes.h>
#include <poll.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#ifdef __sun
#  include <stropts.h>
#endif
#include <termios.h>
#include <unistd.h>

#include "vtc.h"

#include "vre.h"
#include "vev.h"
#include "vlu.h"
#include "vsb.h"
#include "vsub.h"

#include "teken.h"

struct process {
        unsigned                magic;
#define PROCESS_MAGIC           0x1617b43e
        char                    *name;
        struct vtclog           *vl;
        VTAILQ_ENTRY(process)   list;

        char                    *spec;
        char                    *dir;
        char                    *out;
        char                    *err;
        int                     fd_term;
        int                     fd_stderr;
        int                     f_stdout;
        int                     f_stderr;
        struct vlu              *vlu_stdout;
        struct vlu              *vlu_stderr;
        int                     log;
        pid_t                   pid;
        int                     expect_exit;
        int                     expect_signal;
        int                     allow_core;

        uintmax_t               stdout_bytes;
        uintmax_t               stderr_bytes;

        pthread_mutex_t         mtx;
        pthread_t               tp;
        unsigned                hasthread;

        int                     nlin;
        int                     ncol;
        int                     ansi_response;
        char                    **vram;
        teken_t                 tek[1];
};

static VTAILQ_HEAD(, process)   processes =
    VTAILQ_HEAD_INITIALIZER(processes);

static void term_resize(struct process *pp, int lin, int col);

/**********************************************************************
 * Terminal emulation
 */

static void
term_cursor(void *priv, const teken_pos_t *pos)
{
        (void)priv;
        (void)pos;
}

static void
term_putchar(void *priv, const teken_pos_t *pos, teken_char_t ch,
    const teken_attr_t *at)
{
        struct process *pp;

        CAST_OBJ_NOTNULL(pp, priv, PROCESS_MAGIC);
        (void)at;
        if (ch > 126 || ch < 32)
                ch = '?';
        assert(pos->tp_row < pp->nlin);
        assert(pos->tp_col < pp->ncol);
        pp->vram[pos->tp_row][pos->tp_col] = ch;
}

static void
term_fill(void *priv, const teken_rect_t *r, teken_char_t c,
    const teken_attr_t *a)
{
        teken_pos_t p;

        /* Braindead implementation of fill() - just call putchar(). */
        for (p.tp_row = r->tr_begin.tp_row;
            p.tp_row < r->tr_end.tp_row; p.tp_row++)
                for (p.tp_col = r->tr_begin.tp_col;
                    p.tp_col < r->tr_end.tp_col; p.tp_col++)
                        term_putchar(priv, &p, c, a);
}

static void
term_copy(void *priv, const teken_rect_t *r, const teken_pos_t *p)
{
        struct process *pp;
        int nrow, ncol, y; /* Has to be signed - >= 0 comparison */

        /*
         * Copying is a little tricky. We must make sure we do it in
         * correct order, to make sure we don't overwrite our own data.
         */
        CAST_OBJ_NOTNULL(pp, priv, PROCESS_MAGIC);

        nrow = r->tr_end.tp_row - r->tr_begin.tp_row;
        ncol = r->tr_end.tp_col - r->tr_begin.tp_col;

        if (p->tp_row < r->tr_begin.tp_row) {
                /* Copy from top to bottom. */
                for (y = 0; y < nrow; y++)
                        memmove(&pp->vram[p->tp_row + y][p->tp_col],
                            &pp->vram[r->tr_begin.tp_row + y][r->tr_begin.tp_col], ncol);
        } else {
                /* Copy from bottom to top. */
                for (y = nrow - 1; y >= 0; y--)
                        memmove(&pp->vram[p->tp_row + y][p->tp_col],
                            &pp->vram[r->tr_begin.tp_row + y][r->tr_begin.tp_col], ncol);
        }
}

static void
term_respond(void *priv, const void *p, size_t l)
{
        struct process *pp;
        int r;

        CAST_OBJ_NOTNULL(pp, priv, PROCESS_MAGIC);

        vtc_dump(pp->vl, 4, "term_response", p, l);
        if (pp->ansi_response) {
                r = write(pp->fd_term, p, l);
                if (r != l)
                        vtc_fatal(pp->vl, "Could not write to process: %s",
                            strerror(errno));
        }
}

static void
term_param(void *priv, int p, unsigned int v)
{
        struct process *pp;

        CAST_OBJ_NOTNULL(pp, priv, PROCESS_MAGIC);
        if (p == TP_132COLS && v)
                term_resize(pp, pp->nlin, 132);
        if (p == TP_132COLS && !v)
                term_resize(pp, pp->nlin, 80);
}

static const teken_funcs_t process_teken_func = {
        .tf_cursor      =       term_cursor,
        .tf_putchar     =       term_putchar,
        .tf_fill        =       term_fill,
        .tf_copy        =       term_copy,
        .tf_respond     =       term_respond,
        .tf_param       =       term_param,
};

static void
term_screen_dump(const struct process *pp)
{
        int i;
        const teken_pos_t *pos;

        for (i = 0; i < pp->nlin; i++)
                vtc_dump(pp->vl, 3, "screen", pp->vram[i], pp->ncol);
        pos = teken_get_cursor(pp->tek);
        vtc_log(pp->vl, 3, "Cursor at line %d column %d",
            pos->tp_row + 1, pos->tp_col + 1);
}

static void
term_resize(struct process *pp, int lin, int col)
{
        teken_pos_t pos;
        char **vram;
        int i, j;

        vram = calloc(lin, sizeof *pp->vram);
        AN(vram);
        for (i = 0; i < lin; i++) {
                vram[i] = calloc(col + 1L, 1);
                AN(vram[i]);
                memset(vram[i], ' ', col);
                vram[i][col] = '\0';
        }
        if (pp->vram != NULL) {
                for (i = 0; i < lin; i++) {
                        if (i >= pp->nlin)
                                break;
                        j = col;
                        if (j > pp->ncol)
                                j = pp->ncol;
                        memcpy(vram[i], pp->vram[i], j);
                }
                for (i = 0; i < pp->nlin; i++)
                        free(pp->vram[i]);
                free(pp->vram);
        }
        pp->vram = vram;
        pp->nlin = lin;
        pp->ncol = col;

        pos.tp_row = lin;
        pos.tp_col = col;
        teken_set_winsize(pp->tek, &pos);
}

static int
term_find_textline(const struct process *pp, int *x, int y, const char *pat)
{
        const char *t;
        int l;

        if (*x == 0) {
                t = strstr(pp->vram[y], pat);
                if (t != NULL) {
                        *x = 1 + (t - pp->vram[y]);
                        return (1);
                }
        } else if (*x <= pp->ncol) {
                t = pp->vram[y] + *x - 1;
                l = strlen(pat);
                assert((*x - 1) + (l - 1) < pp->ncol);
                if (!memcmp(t, pat, l))
                        return (1);
        }
        return (0);
}

static int
term_find_text(const struct process *pp, int *x, int *y, const char *pat)
{
        int yy;

        if (*y == 0) {
                for (yy = 0; yy < pp->nlin; yy++) {
                        if (term_find_textline(pp, x, yy, pat)) {
                                *y = yy + 1;
                                return (1);
                        }
                }
        } else if (*y <= pp->nlin) {
                if (term_find_textline(pp, x, *y - 1, pat))
                        return (1);
        }
        return (0);
}

static void
term_expect_text(struct process *pp,
    const char *lin, const char *col, const char *pat)
{
        int x, y, l, d = 10000;
        char *t;

        y = strtoul(lin, NULL, 0);
        if (y < 0 || y > pp->nlin)
                vtc_fatal(pp->vl, "YYY %d nlin %d", y, pp->nlin);
        x = strtoul(col, NULL, 0);
        for(l = 0; l <= 10 && x > pp->ncol; l++)        // wait for screen change
                usleep(100000);
        if (x < 0 || x > pp->ncol)
                vtc_fatal(pp->vl, "XXX %d ncol %d", x, pp->ncol);
        l = strlen(pat);
        if (x + l - 1 > pp->ncol)
                vtc_fatal(pp->vl, "XXX %d ncol %d", x + l - 1, pp->ncol);
        PTOK(pthread_mutex_lock(&pp->mtx));
        while (!term_find_text(pp, &x, &y, pat)) {
                if (x != 0 && y != 0) {
                        t = pp->vram[y - 1] + x - 1;
                        vtc_log(pp->vl, 4,
                            "text at %d,%d: '%.*s'", y, x, l, t);
                }
                PTOK(pthread_mutex_unlock(&pp->mtx));
                usleep(d);
                PTOK(pthread_mutex_lock(&pp->mtx));
                if (d < 3000000)
                        d += d;
        }
        PTOK(pthread_mutex_unlock(&pp->mtx));
        vtc_log(pp->vl, 4, "found expected text at %d,%d: '%s'", y, x, pat);
}

static void
term_expect_cursor(const struct process *pp, const char *lin, const char *col)
{
        int x, y, l;
        const teken_pos_t *pos;

        pos = teken_get_cursor(pp->tek);
        y = strtoul(lin, NULL, 0);
        if (y < 0 || y > pp->nlin)
                vtc_fatal(pp->vl, "YYY %d nlin %d", y, pp->nlin);
        x = strtoul(col, NULL, 0);
        for(l = 0; l < 10 && x > pp->ncol; l++) // wait for screen change
                usleep(100000);
        if (x < 0 || x > pp->ncol)
                vtc_fatal(pp->vl, "XXX %d ncol %d", x, pp->ncol);
        if (y != 0 && (y-1) != pos->tp_row)
                vtc_fatal(pp->vl, "Cursor on line %d (expected %d)",
                    pos->tp_row + 1, y);
        if (x != 0 && (x-1) != pos->tp_col)
                vtc_fatal(pp->vl, "Cursor in column %d (expected %d)",
                    pos->tp_col + 1, y);
}

static void
term_match_text(struct process *pp,
    const char *lin, const char *col, const char *re)
{
        int i, l, err, erroff;
        struct vsb *vsb, re_vsb[1];
        size_t len;
        ssize_t x, y;
        vre_t *vre;
        char errbuf[VRE_ERROR_LEN];

        vsb = VSB_new_auto();
        AN(vsb);

        y = strtoul(lin, NULL, 0);
        if (y < 0 || y > pp->nlin)
                vtc_fatal(pp->vl, "YYY %zd nlin %d", y, pp->nlin);
        x = strtoul(col, NULL, 0);
        for(l = 0; l < 10 && x > pp->ncol; l++) // wait for screen change
                usleep(100000);
        if (x < 0 || x > pp->ncol)
                vtc_fatal(pp->vl, "XXX %zd ncol %d", x, pp->ncol);

        if (x)
                x--;

        if (y)
                y--;

        vre = VRE_compile(re, 0, &err, &erroff, 1);
        if (vre == NULL) {
                AN(VSB_init(re_vsb, errbuf, sizeof errbuf));
                AZ(VRE_error(re_vsb, err));
                AZ(VSB_finish(re_vsb));
                VSB_fini(re_vsb);
                vtc_fatal(pp->vl, "invalid regexp \"%s\" at %d (%s)",
                    re, erroff, errbuf);
        }

        PTOK(pthread_mutex_lock(&pp->mtx));

        len = (pp->nlin - y) * (pp->ncol - x);
        for (i = y; i < pp->nlin; i++) {
                VSB_bcat(vsb, &pp->vram[i][x], pp->ncol - x);
                VSB_putc(vsb, '\n');
        }

        AZ(VSB_finish(vsb));

        if (VRE_match(vre, VSB_data(vsb), len, 0, NULL) < 1)
                vtc_fatal(pp->vl, "match failed: (\"%s\")", re);
        else
                vtc_log(pp->vl, 4, "match succeeded");

        PTOK(pthread_mutex_unlock(&pp->mtx));
        VSB_destroy(&vsb);
        VRE_free(&vre);
}

/**********************************************************************
 * Allocate and initialize a process
 */

#define PROCESS_EXPAND(field, format, ...)                              \
        do {                                                            \
                vsb = macro_expandf(p->vl, format, __VA_ARGS__);        \
                AN(vsb);                                                \
                p->field = strdup(VSB_data(vsb));                       \
                AN(p->field);                                           \
                VSB_destroy(&vsb);                                      \
        } while (0)

static void
process_coverage(struct process *p)
{
        const teken_attr_t *a;
        teken_pos_t pos;
        int fg, bg;

        // Code-Coverage of Teken

        (void)teken_get_sequence(p->tek, TKEY_UP);
        (void)teken_get_sequence(p->tek, TKEY_F1);
        (void)teken_256to8(0);
        (void)teken_256to16(0);
        a = teken_get_defattr(p->tek);
        teken_set_defattr(p->tek, a);
        a = teken_get_curattr(p->tek);
        teken_set_curattr(p->tek, a);
        (void)teken_get_winsize(p->tek);
        pos.tp_row = 0;
        pos.tp_col = 8;
        teken_set_cursor(p->tek, &pos);
        teken_get_defattr_cons25(p->tek, &fg, &bg);
}

static struct process *
process_new(const char *name)
{
        struct process *p;
        struct vsb *vsb;
        char buf[1024];

        ALLOC_OBJ(p, PROCESS_MAGIC);
        AN(p);
        REPLACE(p->name, name);
        PTOK(pthread_mutex_init(&p->mtx, NULL));

        p->vl = vtc_logopen("%s", name);
        AN(p->vl);

        PROCESS_EXPAND(dir, "${tmpdir}/%s", name);
        PROCESS_EXPAND(out, "${tmpdir}/%s/term", name);
        PROCESS_EXPAND(err, "${tmpdir}/%s/stderr", name);

        bprintf(buf, "rm -rf %s ; mkdir -p %s ; touch %s %s",
            p->dir, p->dir, p->out, p->err);
        AZ(system(buf));

        p->fd_term = -1;

        VTAILQ_INSERT_TAIL(&processes, p, list);
        teken_init(p->tek, &process_teken_func, p);
        term_resize(p, 24, 80);
        process_coverage(p);
        return (p);
}

#undef PROCESS_EXPAND

/**********************************************************************
 * Clean up process
 */

static void
process_delete(struct process *p)
{
        int i;

        CHECK_OBJ_NOTNULL(p, PROCESS_MAGIC);
        PTOK(pthread_mutex_destroy(&p->mtx));
        vtc_logclose(p->vl);
        free(p->name);
        free(p->dir);
        free(p->out);
        free(p->err);

        for (i = 0; i < p->nlin; i++)
                free(p->vram[i]);
        free(p->vram);

        /*
         * We do not delete the directory, it may contain useful stdout
         * and stderr files. They will be deleted on account of belonging
         * to the test's tmpdir.
         */

        /* XXX: MEMLEAK (?) */
        FREE_OBJ(p);
}

static void
process_undef(const struct process *p)
{
        CHECK_OBJ_NOTNULL(p, PROCESS_MAGIC);

        macro_undef(p->vl, p->name, "dir");
        macro_undef(p->vl, p->name, "out");
        macro_undef(p->vl, p->name, "err");
}

/**********************************************************************
 * Data stream handling
 */

static int
process_vlu_func(void *priv, const char *l)
{
        struct process *p;

        CAST_OBJ_NOTNULL(p, priv, PROCESS_MAGIC);
        vtc_dump(p->vl, 4, "output", l, -1);
        return (0);
}

static int v_matchproto_(vev_cb_f)
process_stdout(const struct vev *ev, int what)
{
        struct process *p;
        char buf[BUFSIZ];
        int i;

        CAST_OBJ_NOTNULL(p, ev->priv, PROCESS_MAGIC);
        (void)what;
        i = read(p->fd_term, buf, sizeof buf);
        if (i <= 0) {
                vtc_log(p->vl, 4, "stdout read %d", i);
                return (1);
        }
        PTOK(pthread_mutex_lock(&p->mtx));
        p->stdout_bytes += i;
        PTOK(pthread_mutex_unlock(&p->mtx));
        if (p->log == 1)
                (void)VLU_Feed(p->vlu_stdout, buf, i);
        else if (p->log == 2)
                vtc_dump(p->vl, 4, "stdout", buf, i);
        else if (p->log == 3)
                vtc_hexdump(p->vl, 4, "stdout", buf, i);
        assert(write(p->f_stdout, buf, i) == i);
        PTOK(pthread_mutex_lock(&p->mtx));
        teken_input(p->tek, buf, i);
        PTOK(pthread_mutex_unlock(&p->mtx));
        return (0);
}

static int v_matchproto_(vev_cb_f)
process_stderr(const struct vev *ev, int what)
{
        struct process *p;
        char buf[BUFSIZ];
        int i;

        CAST_OBJ_NOTNULL(p, ev->priv, PROCESS_MAGIC);
        (void)what;
        i = read(p->fd_stderr, buf, sizeof buf);
        if (i <= 0) {
                vtc_log(p->vl, 4, "stderr read %d", i);
                return (1);
        }
        PTOK(pthread_mutex_lock(&p->mtx));
        p->stderr_bytes += i;
        PTOK(pthread_mutex_unlock(&p->mtx));
        vtc_dump(p->vl, 4, "stderr", buf, i);
        assert(write(p->f_stderr, buf, i) == i);
        return (0);
}

static void
process_cleanup(void *priv)
{
        struct vev_root *evb = priv;
        VEV_Destroy(&evb);
}

static void *
process_thread(void *priv)
{
        struct process *p;
        struct vev_root *evb;
        struct vev *ev;
        int r;

        CAST_OBJ_NOTNULL(p, priv, PROCESS_MAGIC);

        p->f_stdout = open(p->out, O_WRONLY|O_APPEND);
        assert(p->f_stdout >= 0);
        p->f_stderr = open(p->err, O_WRONLY|O_APPEND);
        assert(p->f_stderr >= 0);

        evb = VEV_New();
        AN(evb);
        pthread_cleanup_push(process_cleanup, evb);

        ev = VEV_Alloc();
        AN(ev);
        ev->fd = p->fd_term;
        ev->fd_flags = VEV__RD | VEV__HUP | VEV__ERR;
        ev->callback = process_stdout;
        ev->priv = p;
        AZ(VEV_Start(evb, ev));

        ev = VEV_Alloc();
        AN(ev);
        ev->fd = p->fd_stderr;
        ev->fd_flags = VEV__RD | VEV__HUP | VEV__ERR;
        ev->callback = process_stderr;
        ev->priv = p;
        AZ(VEV_Start(evb, ev));

        if (p->log == 1) {
                p->vlu_stdout = VLU_New(process_vlu_func, p, 1024);
                AN(p->vlu_stdout);
                p->vlu_stderr = VLU_New(process_vlu_func, p, 1024);
                AN(p->vlu_stderr);
        }

        do {
                r = VEV_Once(evb);
        } while (r == 1);

        if (r < 0)
                vtc_fatal(p->vl, "VEV_Once() = %d, error %s", r,
                    strerror(errno));

        vtc_wait4(p->vl, p->pid,
            p->expect_exit, p->expect_signal, p->allow_core);
        closefd(&p->f_stdout);
        closefd(&p->f_stderr);

        PTOK(pthread_mutex_lock(&p->mtx));

        /* NB: We keep the other macros around */
        macro_undef(p->vl, p->name, "pid");
        p->pid = -1;

        PTOK(pthread_mutex_unlock(&p->mtx));

        pthread_cleanup_pop(0);
        VEV_Destroy(&evb);
        if (p->log == 1) {
                VLU_Destroy(&p->vlu_stdout);
                VLU_Destroy(&p->vlu_stderr);
        }
        return (NULL);
}

static void
process_winsz(struct process *p, int fd)
{
        struct winsize ws;
        int i;

        memset(&ws, 0, sizeof ws);
        ws.ws_row = (short)p->nlin;
        ws.ws_col = (short)p->ncol;
        i = ioctl(fd, TIOCSWINSZ, &ws);
        if (i)
                vtc_log(p->vl, 4, "TIOCWINSZ %d %s", i, strerror(errno));
}

static void
process_init_term(struct process *p, int fd)
{
        struct termios tt;
        int i;

        process_winsz(p, fd);

        memset(&tt, 0, sizeof tt);
        tt.c_cflag = CREAD | CS8 | HUPCL;
        tt.c_iflag = BRKINT | ICRNL | IMAXBEL | IXON | IXANY;
        tt.c_lflag = ICANON | ISIG | IEXTEN | ECHO | ECHOE | ECHOKE | ECHOCTL;
        tt.c_oflag = OPOST | ONLCR;
        i = cfsetispeed(&tt, B9600);
        if (i)
                vtc_log(p->vl, 4, "cfsetispeed %d %s", i, strerror(errno));
        i = cfsetospeed(&tt, B9600);
        if (i)
                vtc_log(p->vl, 4, "cfsetospeed %d %s", i, strerror(errno));
        tt.c_cc[VEOF] = '\x04';                 // CTRL-D
        tt.c_cc[VERASE] = '\x08';               // CTRL-H (Backspace)
        tt.c_cc[VKILL] = '\x15';                // CTRL-U
        tt.c_cc[VINTR] = '\x03';                // CTRL-C
        tt.c_cc[VQUIT] = '\x1c';                // CTRL-backslash

        i = tcsetattr(fd, TCSAFLUSH, &tt);
        if (i)
                vtc_log(p->vl, 4, "TCSAFLUSH %d %s", i, strerror(errno));
}

/**********************************************************************
 * Start the process thread
 */

static void
process_start(struct process *p)
{
        struct vsb *cl;
        int fd2[2];
        int master, slave;
        const char *slavename;
        char c;

        CHECK_OBJ_NOTNULL(p, PROCESS_MAGIC);
        if (p->hasthread)
                vtc_fatal(p->vl, "Already running, -wait first");

        vtc_log(p->vl, 4, "CMD: %s", p->spec);

        cl = macro_expand(p->vl, p->spec);
        AN(cl);

        master = posix_openpt(O_RDWR|O_NOCTTY);
        assert(master >= 0);
        AZ(grantpt(master));
        AZ(unlockpt(master));
        slavename = ptsname(master);
        AN(slavename);

        AZ(pipe(fd2));

        p->pid = fork();
        assert(p->pid >= 0);
        if (p->pid == 0) {
                assert(setsid() == getpid());
                assert(dup2(fd2[1], STDERR_FILENO) == STDERR_FILENO);
                AZ(close(STDIN_FILENO));
                slave = open(slavename, O_RDWR);
                assert(slave == STDIN_FILENO);
#ifdef __sun
                if (ioctl(slave, I_PUSH, "ptem"))
                        vtc_log(p->vl, 4, "PUSH ptem: %s", strerror(errno));
                if (ioctl(slave, I_PUSH, "ldterm"))
                        vtc_log(p->vl, 4, "PUSH ldterm: %s", strerror(errno));
                (void)ioctl(STDIN_FILENO, TIOCSCTTY, NULL);
#else
                AZ(ioctl(STDIN_FILENO, TIOCSCTTY, NULL));
#endif
                AZ(close(STDOUT_FILENO));
                assert(dup2(slave, STDOUT_FILENO) == STDOUT_FILENO);
                VSUB_closefrom(STDERR_FILENO + 1);
                process_init_term(p, slave);

                AZ(setenv("TERM", "xterm", 1));
                AZ(unsetenv("TERMCAP"));
                // Not using NULL because GCC is now even more demented...
                assert(write(STDERR_FILENO, "+", 1) == 1);
                AZ(execl("/bin/sh", "/bin/sh", "-c", VSB_data(cl), (char*)0));
                exit(1);
        }
        vtc_log(p->vl, 3, "PID: %ld", (long)p->pid);
        VSB_destroy(&cl);

        assert(read(fd2[0], &c, 1) == 1);
        p->fd_term = master;
        closefd(&fd2[1]);
        p->fd_stderr = fd2[0];
        macro_def(p->vl, p->name, "pid", "%ld", (long)p->pid);
        macro_def(p->vl, p->name, "dir", "%s", p->dir);
        macro_def(p->vl, p->name, "out", "%s", p->out);
        macro_def(p->vl, p->name, "err", "%s", p->err);
        p->hasthread = 1;
        PTOK(pthread_create(&p->tp, NULL, process_thread, p));
}

/**********************************************************************
 * Wait for process thread to stop
 */

static void
process_wait(struct process *p)
{
        void *v;

        if (p->hasthread) {
                PTOK(pthread_join(p->tp, &v));
                p->hasthread = 0;
        }
        vtc_log(p->vl, 4, "stdout %ju bytes, stderr %ju bytes",
            p->stdout_bytes, p->stderr_bytes);
}

/**********************************************************************
 * Send a signal to a process
 */

static void
process_kill(struct process *p, const char *sig)
{
        int j = 0;
        pid_t pid;

        CHECK_OBJ_NOTNULL(p, PROCESS_MAGIC);
        AN(sig);

        PTOK(pthread_mutex_lock(&p->mtx));
        pid = p->pid;
        PTOK(pthread_mutex_unlock(&p->mtx));

        if (pid <= 0)
                vtc_fatal(p->vl, "Cannot signal a non-running process");

        if (!strcmp(sig, "TERM"))
                j = SIGTERM;
        else if (!strcmp(sig, "INT"))
                j = SIGINT;
        else if (!strcmp(sig, "KILL"))
                j = SIGKILL;
        else if (!strcmp(sig, "HUP"))
                j = SIGHUP;
        else if (*sig == '-')
                j = strtoul(sig + 1, NULL, 10);
        else
                vtc_fatal(p->vl, "Could not grok signal (%s)", sig);

        if (p->expect_signal == 0)
                p->expect_signal = -j;
        if (kill(-pid, j) < 0)
                vtc_fatal(p->vl, "Failed to send signal %d (%s)",
                    j, strerror(errno));
        else
                vtc_log(p->vl, 4, "Sent signal %d", j);
}

/**********************************************************************
 * Write to a process' stdin
 */

static void
process_write(const struct process *p, const char *text)
{
        int r, len;

        if (!p->hasthread)
                vtc_fatal(p->vl, "Cannot write to a non-running process");

        len = strlen(text);
        vtc_log(p->vl, 4, "Writing %d bytes", len);
        r = write(p->fd_term, text, len);
        if (r != len)
                vtc_fatal(p->vl, "Failed to write: len=%d %s (%d)",
                    len, strerror(errno), errno);
}

static void
process_write_hex(const struct process *p, const char *text)
{
        struct vsb *vsb;

        if (!p->hasthread)
                vtc_fatal(p->vl, "Cannot write to a non-running process");

        vsb = vtc_hex_to_bin(p->vl, text);
        assert(VSB_len(vsb) >= 0);
        vtc_hexdump(p->vl, 4, "sendhex", VSB_data(vsb), VSB_len(vsb));
        AZ(VSB_tofile(vsb, p->fd_term));
        VSB_destroy(&vsb);
}

static void
process_close(struct process *p)
{

        if (!p->hasthread)
                vtc_fatal(p->vl, "Cannot close a non-running process");

        process_kill(p, "HUP");
}

/* SECTION: process process
 *
 * Run a process with stdin+stdout on a pseudo-terminal and stderr on a pipe.
 *
 * Output from the pseudo-terminal is copied verbatim to ${pNAME_out},
 * and the -log/-dump/-hexdump flags will also put it in the vtc-log.
 *
 * The pseudo-terminal is not in ECHO mode, but if the programs run set
 * it to ECHO mode ("stty sane") any input sent to the process will also
 * appear in this stream because of the ECHO.
 *
 * Output from the stderr-pipe is copied verbatim to ${pNAME_err}, and
 * is always included in the vtc_log.
 *
 *      process pNAME SPEC [-allow-core] [-expect-exit N] [-expect-signal N]
 *              [-dump] [-hexdump] [-log]
 *              [-run] [-close] [-kill SIGNAL] [-start] [-stop] [-wait]
 *              [-write STRING] [-writeln STRING] [-writehex HEXSTRING]
 *              [-need-bytes [+]NUMBER]
 *              [-screen-dump] [-winsz LINES COLUMNS] [-ansi-response]
 *              [-expect-cursor LINE COLUMN] [-expect-text LINE COLUMN TEXT]
 *              [-match-text LINE COLUMN REGEXP]
 *
 * pNAME
 *      Name of the process. It must start with 'p'.
 *
 * SPEC
 *      The command(s) to run in this process.
 *
 * \-hexdump
 *      Log output with vtc_hexdump(). Must be before -start/-run.
 *
 * \-dump
 *      Log output with vtc_dump(). Must be before -start/-run.
 *
 * \-log
 *      Log output with VLU/vtc_log(). Must be before -start/-run.
 *
 * \-start
 *      Start the process.
 *
 * \-expect-exit N
 *      Expect exit status N
 *
 * \-expect-signal N
 *      Expect signal in exit status N
 *
 * \-allow-core
 *      Core dump in exit status is OK
 *
 * \-wait
 *      Wait for the process to finish.
 *
 * \-run
 *      Shorthand for -start -wait.
 *
 *      In most cases, if you just want to start a process and wait for it
 *      to finish, you can use the ``shell`` command instead.
 *      The following commands are equivalent::
 *
 *          shell "do --something"
 *
 *          process p1 "do --something" -run
 *
 *      However, you may use the ``process`` variant to conveniently
 *      collect the standard input and output without dealing with shell
 *      redirections yourself. The ``shell`` command can also expect an
 *      expression from either output, consider using it if you only need
 *      to match one.
 *
 * \-key KEYSYM
 *      Send emulated key-press.
 *      KEYSYM can be one of (NPAGE, PPAGE, HOME, END)
 *
 *
 * \-kill SIGNAL
 *      Send a signal to the process. The argument can be either
 *      the string "TERM", "INT", or "KILL" for SIGTERM, SIGINT or SIGKILL
 *      signals, respectively, or a hyphen (-) followed by the signal
 *      number.
 *
 *      If you need to use other signal names, you can use the ``kill``\(1)
 *      command directly::
 *
 *          shell "kill -USR1 ${pNAME_pid}"
 *
 *      Note that SIGHUP usage is discouraged in test cases.
 *
 * \-stop
 *      Shorthand for -kill TERM.
 *
 * \-close
 *      Alias for "-kill HUP"
 *
 * \-winsz LINES COLUMNS
 *      Change the terminal window size to LIN lines and COL columns.
 *
 * \-write STRING
 *      Write a string to the process' stdin.
 *
 * \-writeln STRING
 *      Same as -write followed by a newline (\\n).
 *
 * \-writehex HEXSTRING
 *      Same as -write but interpreted as hexadecimal bytes.
 *
 * \-need-bytes [+]NUMBER
 *      Wait until at least NUMBER bytes have been received in total.
 *      If '+' is prefixed, NUMBER new bytes must be received.
 *
 * \-ansi-response
 *      Respond to terminal respond-back sequences
 *
 * \-expect-cursor LINE COLUMN
 *      Expect cursors location
 *
 * \-expect-text LINE COLUMNS TEXT
 *      Wait for TEXT to appear at LIN,COL on the virtual screen.
 *      Lines and columns are numbered 1...N
 *      LIN==0 means "on any line"
 *      COL==0 means "anywhere on the line"
 *
 * \-match-text LINE COLUMN REGEXP
 *      Wait for the PAT regular expression to match the text at LIN,COL on the virtual screen.
 *      Lines and columns are numbered 1...N
 *      LIN==0 means "on any line"
 *      COL==0 means "anywhere on the line"
 *
 *
 * \-screen-dump
 *      Dump the virtual screen into vtc_log
 *
 */

void
cmd_process(CMD_ARGS)
{
        struct process *p, *p2;
        uintmax_t u, v, bsnap;
        unsigned lin,col;
        int spec_set = 0;

        (void)priv;

        if (av == NULL) {
                /* Reset and free */
                VTAILQ_FOREACH_SAFE(p, &processes, list, p2) {
                        if (p->pid > 0) {
                                process_kill(p, "TERM");
                                sleep(1);
                                if (p->pid > 0)
                                        process_kill(p, "KILL");
                        }
                        if (p->hasthread)
                                process_wait(p);
                        VTAILQ_REMOVE(&processes, p, list);
                        process_undef(p);
                        process_delete(p);
                }
                return;
        }

        AZ(strcmp(av[0], "process"));
        av++;

        VTC_CHECK_NAME(vl, av[0], "Process", 'p');
        VTAILQ_FOREACH(p, &processes, list)
                if (!strcmp(p->name, av[0]))
                        break;
        if (p == NULL)
                p = process_new(av[0]);
        av++;

        PTOK(pthread_mutex_lock(&p->mtx));
        bsnap = p->stdout_bytes;
        PTOK(pthread_mutex_unlock(&p->mtx));

        for (; *av != NULL; av++) {
                if (vtc_error)
                        break;

                if (!strcmp(*av, "-allow-core")) {
                        p->allow_core = 1;
                        continue;
                }
                if (!strcmp(*av, "-close")) {
                        process_close(p);
                        continue;
                }
                if (!strcmp(*av, "-dump")) {
                        if (p->hasthread)
                                vtc_fatal(p->vl,
                                    "Cannot dump a running process");
                        p->log = 2;
                        continue;
                }
                if (!strcmp(*av, "-expect-exit")) {
                        p->expect_exit = strtoul(av[1], NULL, 0);
                        av++;
                        continue;
                }
                if (!strcmp(*av, "-expect-signal")) {
                        p->expect_signal = strtoul(av[1], NULL, 0);
                        av++;
                        continue;
                }
                if (!strcmp(*av, "-hexdump")) {
                        if (p->hasthread)
                                vtc_fatal(p->vl,
                                    "Cannot dump a running process");
                        p->log = 3;
                        continue;
                }
                if (!strcmp(*av, "-key")) {
                        if (!strcmp(av[1], "NPAGE"))
                                process_write(p, "\x1b\x5b\x36\x7e");
                        else if (!strcmp(av[1], "PPAGE"))
                                process_write(p, "\x1b\x5b\x35\x7e");
                        else if (!strcmp(av[1], "HOME"))
                                process_write(p, "\x1b\x4f\x48");
                        else if (!strcmp(av[1], "END"))
                                process_write(p, "\x1b\x4f\x46");
                        else
                                vtc_fatal(p->vl, "Unknown key %s", av[1]);
                        continue;
                }
                if (!strcmp(*av, "-kill")) {
                        process_kill(p, av[1]);
                        av++;
                        continue;
                }
                if (!strcmp(*av, "-log")) {
                        if (p->hasthread)
                                vtc_fatal(p->vl,
                                    "Cannot log a running process");
                        p->log = 1;
                        continue;
                }
                if (!strcmp(*av, "-need-bytes")) {
                        u = strtoumax(av[1], NULL, 0);
                        if (av[1][0] == '+')
                                u += bsnap;
                        av++;
                        do {
                                PTOK(pthread_mutex_lock(&p->mtx));
                                v = p->stdout_bytes;
                                PTOK(pthread_mutex_unlock(&p->mtx));
                                vtc_log(p->vl, 4, "Have %ju bytes", v);
                                usleep(500000);
                        } while(v < u);
                        continue;
                }
                if (!strcmp(*av, "-run")) {
                        process_start(p);
                        process_wait(p);
                        continue;
                }
                if (!strcmp(*av, "-ansi-response")) {
                        p->ansi_response = 1;
                        continue;
                }
                if (!strcmp(*av, "-expect-text")) {
                        AN(av[1]);
                        AN(av[2]);
                        AN(av[3]);
                        term_expect_text(p, av[1], av[2], av[3]);
                        av += 3;
                        continue;
                }
                if (!strcmp(*av, "-expect-cursor")) {
                        AN(av[1]);
                        AN(av[2]);
                        term_expect_cursor(p, av[1], av[2]);
                        av += 2;
                        continue;
                }
                if (!strcmp(*av, "-match-text")) {
                        AN(av[1]);
                        AN(av[2]);
                        AN(av[3]);
                        term_match_text(p, av[1], av[2], av[3]);
                        av += 3;
                        continue;
                }
                if (!strcmp(*av, "-screen_dump") ||
                    !strcmp(*av, "-screen-dump")) {
                        term_screen_dump(p);
                        continue;
                }
                if (!strcmp(*av, "-start")) {
                        process_start(p);
                        continue;
                }
                if (!strcmp(*av, "-stop")) {
                        process_kill(p, "TERM");
                        sleep(1);
                        continue;
                }
                if (!strcmp(*av, "-wait")) {
                        process_wait(p);
                        continue;
                }
                if (!strcmp(*av, "-winsz")) {
                        lin = atoi(av[1]);
                        assert(lin > 1);
                        col = atoi(av[2]);
                        assert(col > 1);
                        av += 2;
                        PTOK(pthread_mutex_lock(&p->mtx));
                        term_resize(p, lin, col);
                        PTOK(pthread_mutex_unlock(&p->mtx));
                        process_winsz(p, p->fd_term);
                        continue;
                }
                if (!strcmp(*av, "-write")) {
                        process_write(p, av[1]);
                        av++;
                        continue;
                }
                if (!strcmp(*av, "-writehex")) {
                        process_write_hex(p, av[1]);
                        av++;
                        continue;
                }
                if (!strcmp(*av, "-writeln")) {
                        process_write(p, av[1]);
                        process_write(p, "\n");
                        av++;
                        continue;
                }
                if (**av == '-' || spec_set)
                        vtc_fatal(p->vl, "Unknown process argument: %s", *av);
                REPLACE(p->spec, *av);
                spec_set = 1;
        }
}

		varnish-cache/bin/varnishtest/vtc_process.c
0		/*-
1		* Copyright (c) 2015 Varnish Software AS
2		* All rights reserved.
3		*
4		* Author: Dridi Boukelmoune <dridi@varnish-software.com>
5		*
6		* SPDX-License-Identifier: BSD-2-Clause
7		*
8		* Redistribution and use in source and binary forms, with or without
9		* modification, are permitted provided that the following conditions
10		* are met:
11		* 1. Redistributions of source code must retain the above copyright
12		* notice, this list of conditions and the following disclaimer.
13		* 2. Redistributions in binary form must reproduce the above copyright
14		* notice, this list of conditions and the following disclaimer in the
15		* documentation and/or other materials provided with the distribution.
16		*
17		* THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18		* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19		* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20		* ARE DISCLAIMED. IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE
21		* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22		* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23		* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24		* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25		* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26		* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27		* SUCH DAMAGE.
28		*
29		* XXX:
30		* -ignore-stderr (otherwise output to stderr is fail)
31		*/
32
33		#include "config.h"
34
35		#include <sys/ioctl.h> // Linux: struct winsize
36
37		#include <ctype.h>
38		#include <fcntl.h>
39		#include <inttypes.h>
40		#include <poll.h>
41		#include <stdio.h>
42		#include <stdlib.h>
43		#include <string.h>
44		#ifdef __sun
45		# include <stropts.h>
46		#endif
47		#include <termios.h>
48		#include <unistd.h>
49
50		#include "vtc.h"
51
52		#include "vre.h"
53		#include "vev.h"
54		#include "vlu.h"
55		#include "vsb.h"
56		#include "vsub.h"
57
58		#include "teken.h"
59
60		struct process {
61		unsigned magic;
62		#define PROCESS_MAGIC 0x1617b43e
63		char *name;
64		struct vtclog *vl;
65		VTAILQ_ENTRY(process) list;
66
67		char *spec;
68		char *dir;
69		char *out;
70		char *err;
71		int fd_term;
72		int fd_stderr;
73		int f_stdout;
74		int f_stderr;
75		struct vlu *vlu_stdout;
76		struct vlu *vlu_stderr;
77		int log;
78		pid_t pid;
79		int expect_exit;
80		int expect_signal;
81		int allow_core;
82
83		uintmax_t stdout_bytes;
84		uintmax_t stderr_bytes;
85
86		pthread_mutex_t mtx;
87		pthread_t tp;
88		unsigned hasthread;
89
90		int nlin;
91		int ncol;
92		int ansi_response;
93		char **vram;
94		teken_t tek[1];
95		};
96
97		static VTAILQ_HEAD(, process) processes =
98		VTAILQ_HEAD_INITIALIZER(processes);
99
100		static void term_resize(struct process *pp, int lin, int col);
101
102		/**********************************************************************
103		* Terminal emulation
104		*/
105
106		static void
107	5541885	term_cursor(void priv, const teken_pos_t pos)
108		{
109	5541885	(void)priv;
110	5541885	(void)pos;
111	5541885	}
112
113		static void
114	35017924	term_putchar(void priv, const teken_pos_t pos, teken_char_t ch,
115		const teken_attr_t *at)
116		{
117		struct process *pp;
118
119	35017924	CAST_OBJ_NOTNULL(pp, priv, PROCESS_MAGIC);
120	35017905	(void)at;
121	35017905	if (ch > 126 \|\| ch < 32)
122	22480	ch = '?';
123	35017914	assert(pos->tp_row < pp->nlin);
124	35017914	assert(pos->tp_col < pp->ncol);
125	35017912	pp->vram[pos->tp_row][pos->tp_col] = ch;
126	35017912	}
127
128		static void
129	72020	term_fill(void priv, const teken_rect_t r, teken_char_t c,
130		const teken_attr_t *a)
131		{
132		teken_pos_t p;
133
134		/* Braindead implementation of fill() - just call putchar(). */
135	399520	for (p.tp_row = r->tr_begin.tp_row;
136	399520	p.tp_row < r->tr_end.tp_row; p.tp_row++)
137	30329994	for (p.tp_col = r->tr_begin.tp_col;
138	30329994	p.tp_col < r->tr_end.tp_col; p.tp_col++)
139	30329994	term_putchar(priv, &p, c, a);
140	72020	}
141
142		static void
143	69976	term_copy(void priv, const teken_rect_t r, const teken_pos_t *p)
144		{
145		struct process *pp;
146		int nrow, ncol, y; /* Has to be signed - >= 0 comparison */
147
148		/*
149		* Copying is a little tricky. We must make sure we do it in
150		* correct order, to make sure we don't overwrite our own data.
151		*/
152	69976	CAST_OBJ_NOTNULL(pp, priv, PROCESS_MAGIC);
153
154	69976	nrow = r->tr_end.tp_row - r->tr_begin.tp_row;
155	69976	ncol = r->tr_end.tp_col - r->tr_begin.tp_col;
156
157	69976	if (p->tp_row < r->tr_begin.tp_row) {
158		/* Copy from top to bottom. */
159	984056	for (y = 0; y < nrow; y++)
160	1912880	memmove(&pp->vram[p->tp_row + y][p->tp_col],
161	956440	&pp->vram[r->tr_begin.tp_row + y][r->tr_begin.tp_col], ncol);
162	27616	} else {
163		/* Copy from bottom to top. */
164	236600	for (y = nrow - 1; y >= 0; y--)
165	388480	memmove(&pp->vram[p->tp_row + y][p->tp_col],
166	194240	&pp->vram[r->tr_begin.tp_row + y][r->tr_begin.tp_col], ncol);
167		}
168	69976	}
169
170		static void
171	640	term_respond(void priv, const void p, size_t l)
172		{
173		struct process *pp;
174		int r;
175
176	640	CAST_OBJ_NOTNULL(pp, priv, PROCESS_MAGIC);
177
178	640	vtc_dump(pp->vl, 4, "term_response", p, l);
179	640	if (pp->ansi_response) {
180	80	r = write(pp->fd_term, p, l);
181	80	if (r != l)
182	0	vtc_fatal(pp->vl, "Could not write to process: %s",
183	0	strerror(errno));
184	80	}
185	640	}
186
187		static void
188	5400	term_param(void *priv, int p, unsigned int v)
189		{
190		struct process *pp;
191
192	5400	CAST_OBJ_NOTNULL(pp, priv, PROCESS_MAGIC);
193	5400	if (p == TP_132COLS && v)
194	480	term_resize(pp, pp->nlin, 132);
195	1440	if (p == TP_132COLS && !v)
196	960	term_resize(pp, pp->nlin, 80);
197	5400	}
198
199		static const teken_funcs_t process_teken_func = {
200		.tf_cursor = term_cursor,
201		.tf_putchar = term_putchar,
202		.tf_fill = term_fill,
203		.tf_copy = term_copy,
204		.tf_respond = term_respond,
205		.tf_param = term_param,
206		};
207
208		static void
209	6240	term_screen_dump(const struct process *pp)
210		{
211		int i;
212		const teken_pos_t *pos;
213
214	163040	for (i = 0; i < pp->nlin; i++)
215	156800	vtc_dump(pp->vl, 3, "screen", pp->vram[i], pp->ncol);
216	6240	pos = teken_get_cursor(pp->tek);
217	12480	vtc_log(pp->vl, 3, "Cursor at line %d column %d",
218	6240	pos->tp_row + 1, pos->tp_col + 1);
219	6240	}
220
221		static void
222	4000	term_resize(struct process *pp, int lin, int col)
223		{
224		teken_pos_t pos;
225		char **vram;
226		int i, j;
227
228	4000	vram = calloc(lin, sizeof *pp->vram);
229	4000	AN(vram);
230	103840	for (i = 0; i < lin; i++) {
231	99840	vram[i] = calloc(col + 1L, 1);
232	99840	AN(vram[i]);
233	99840	memset(vram[i], ' ', col);
234	99840	vram[i][col] = '\0';
235	99840	}
236	4000	if (pp->vram != NULL) {
237	43960	for (i = 0; i < lin; i++) {
238	42480	if (i >= pp->nlin)
239	280	break;
240	42200	j = col;
241	42200	if (j > pp->ncol)
242	15360	j = pp->ncol;
243	42200	memcpy(vram[i], pp->vram[i], j);
244	42200	}
245	44000	for (i = 0; i < pp->nlin; i++)
246	42240	free(pp->vram[i]);
247	1760	free(pp->vram);
248	1760	}
249	4000	pp->vram = vram;
250	4000	pp->nlin = lin;
251	4000	pp->ncol = col;
252
253	4000	pos.tp_row = lin;
254	4000	pos.tp_col = col;
255	4000	teken_set_winsize(pp->tek, &pos);
256	4000	}
257
258		static int
259	200111	term_find_textline(const struct process pp, int x, int y, const char *pat)
260		{
261		const char *t;
262		int l;
263
264	200111	if (*x == 0) {
265	158561	t = strstr(pp->vram[y], pat);
266	158561	if (t != NULL) {
267	2760	*x = 1 + (t - pp->vram[y]);
268	2760	return (1);
269		}
270	197351	} else if (*x <= pp->ncol) {
271	41550	t = pp->vram[y] + *x - 1;
272	41550	l = strlen(pat);
273	41550	assert((*x - 1) + (l - 1) < pp->ncol);
274	41550	if (!memcmp(t, pat, l))
275	7280	return (1);
276	34270	}
277	190071	return (0);
278	200111	}
279
280		static int
281	20507	term_find_text(const struct process pp, int x, int y, const char pat)
282		{
283		int yy;
284
285	20507	if (*y == 0) {
286	192196	for (yy = 0; yy < pp->nlin; yy++) {
287	187420	if (term_find_textline(pp, x, yy, pat)) {
288	3040	*y = yy + 1;
289	3040	return (1);
290		}
291	184380	}
292	17467	} else if (*y <= pp->nlin) {
293	12691	if (term_find_textline(pp, x, *y - 1, pat))
294	7000	return (1);
295	5691	}
296	10467	return (0);
297	20507	}
298
299		static void
300	10040	term_expect_text(struct process *pp,
301		const char lin, const char col, const char *pat)
302		{
303	10040	int x, y, l, d = 10000;
304		char *t;
305
306	10040	y = strtoul(lin, NULL, 0);
307	10040	if (y < 0 \|\| y > pp->nlin)
308	0	vtc_fatal(pp->vl, "YYY %d nlin %d", y, pp->nlin);
309	10040	x = strtoul(col, NULL, 0);
310	10200	for(l = 0; l <= 10 && x > pp->ncol; l++) // wait for screen change
311	160	usleep(100000);
312	10040	if (x < 0 \|\| x > pp->ncol)
313	0	vtc_fatal(pp->vl, "XXX %d ncol %d", x, pp->ncol);
314	10040	l = strlen(pat);
315	10040	if (x + l - 1 > pp->ncol)
316	0	vtc_fatal(pp->vl, "XXX %d ncol %d", x + l - 1, pp->ncol);
317	10040	PTOK(pthread_mutex_lock(&pp->mtx));
318	20507	while (!term_find_text(pp, &x, &y, pat)) {
319	10467	if (x != 0 && y != 0) {
320	4950	t = pp->vram[y - 1] + x - 1;
321	9900	vtc_log(pp->vl, 4,
322	4950	"text at %d,%d: '%.*s'", y, x, l, t);
323	4950	}
324	10467	PTOK(pthread_mutex_unlock(&pp->mtx));
325	10467	usleep(d);
326	10467	PTOK(pthread_mutex_lock(&pp->mtx));
327	10467	if (d < 3000000)
328	10467	d += d;
329		}
330	10040	PTOK(pthread_mutex_unlock(&pp->mtx));
331	10040	vtc_log(pp->vl, 4, "found expected text at %d,%d: '%s'", y, x, pat);
332	10040	}
333
334		static void
335	320	term_expect_cursor(const struct process pp, const char lin, const char *col)
336		{
337		int x, y, l;
338		const teken_pos_t *pos;
339
340	320	pos = teken_get_cursor(pp->tek);
341	320	y = strtoul(lin, NULL, 0);
342	320	if (y < 0 \|\| y > pp->nlin)
343	0	vtc_fatal(pp->vl, "YYY %d nlin %d", y, pp->nlin);
344	320	x = strtoul(col, NULL, 0);
345	320	for(l = 0; l < 10 && x > pp->ncol; l++) // wait for screen change
346	0	usleep(100000);
347	320	if (x < 0 \|\| x > pp->ncol)
348	0	vtc_fatal(pp->vl, "XXX %d ncol %d", x, pp->ncol);
349	320	if (y != 0 && (y-1) != pos->tp_row)
350	0	vtc_fatal(pp->vl, "Cursor on line %d (expected %d)",
351	0	pos->tp_row + 1, y);
352	240	if (x != 0 && (x-1) != pos->tp_col)
353	0	vtc_fatal(pp->vl, "Cursor in column %d (expected %d)",
354	0	pos->tp_col + 1, y);
355	320	}
356
357		static void
358	1360	term_match_text(struct process *pp,
359		const char lin, const char col, const char *re)
360		{
361		int i, l, err, erroff;
362		struct vsb *vsb, re_vsb[1];
363		size_t len;
364		ssize_t x, y;
365		vre_t *vre;
366		char errbuf[VRE_ERROR_LEN];
367
368	1360	vsb = VSB_new_auto();
369	1360	AN(vsb);
370
371	1360	y = strtoul(lin, NULL, 0);
372	1360	if (y < 0 \|\| y > pp->nlin)
373	0	vtc_fatal(pp->vl, "YYY %zd nlin %d", y, pp->nlin);
374	1360	x = strtoul(col, NULL, 0);
375	1360	for(l = 0; l < 10 && x > pp->ncol; l++) // wait for screen change
376	0	usleep(100000);
377	1360	if (x < 0 \|\| x > pp->ncol)
378	0	vtc_fatal(pp->vl, "XXX %zd ncol %d", x, pp->ncol);
379
380	1360	if (x)
381	640	x--;
382
383	720	if (y)
384	720	y--;
385
386	1360	vre = VRE_compile(re, 0, &err, &erroff, 1);
387	1360	if (vre == NULL) {
388	0	AN(VSB_init(re_vsb, errbuf, sizeof errbuf));
389	0	AZ(VRE_error(re_vsb, err));
390	0	AZ(VSB_finish(re_vsb));
391	0	VSB_fini(re_vsb);
392	0	vtc_fatal(pp->vl, "invalid regexp \"%s\" at %d (%s)",
393	0	re, erroff, errbuf);
394		}
395
396	1360	PTOK(pthread_mutex_lock(&pp->mtx));
397
398	1360	len = (pp->nlin - y) * (pp->ncol - x);
399	32960	for (i = y; i < pp->nlin; i++) {
400	31600	VSB_bcat(vsb, &pp->vram[i][x], pp->ncol - x);
401	31600	VSB_putc(vsb, '\n');
402	31600	}
403
404	1360	AZ(VSB_finish(vsb));
405
406	1360	if (VRE_match(vre, VSB_data(vsb), len, 0, NULL) < 1)
407	0	vtc_fatal(pp->vl, "match failed: (\"%s\")", re);
408		else
409	1360	vtc_log(pp->vl, 4, "match succeeded");
410
411	1360	PTOK(pthread_mutex_unlock(&pp->mtx));
412	1360	VSB_destroy(&vsb);
413	1360	VRE_free(&vre);
414	1360	}
415
416		/**********************************************************************
417		* Allocate and initialize a process
418		*/
419
420		#define PROCESS_EXPAND(field, format, ...) \
421		do { \
422		vsb = macro_expandf(p->vl, format, __VA_ARGS__); \
423		AN(vsb); \
424		p->field = strdup(VSB_data(vsb)); \
425		AN(p->field); \
426		VSB_destroy(&vsb); \
427		} while (0)
428
429		static void
430	2240	process_coverage(struct process *p)
431		{
432		const teken_attr_t *a;
433		teken_pos_t pos;
434		int fg, bg;
435
436		// Code-Coverage of Teken
437
438	2240	(void)teken_get_sequence(p->tek, TKEY_UP);
439	2240	(void)teken_get_sequence(p->tek, TKEY_F1);
440	2240	(void)teken_256to8(0);
441	2240	(void)teken_256to16(0);
442	2240	a = teken_get_defattr(p->tek);
443	2240	teken_set_defattr(p->tek, a);
444	2240	a = teken_get_curattr(p->tek);
445	2240	teken_set_curattr(p->tek, a);
446	2240	(void)teken_get_winsize(p->tek);
447	2240	pos.tp_row = 0;
448	2240	pos.tp_col = 8;
449	2240	teken_set_cursor(p->tek, &pos);
450	2240	teken_get_defattr_cons25(p->tek, &fg, &bg);
451	2240	}
452
453		static struct process *
454	2240	process_new(const char *name)
455		{
456		struct process *p;
457		struct vsb *vsb;
458		char buf[1024];
459
460	2240	ALLOC_OBJ(p, PROCESS_MAGIC);
461	2240	AN(p);
462	2240	REPLACE(p->name, name);
463	2240	PTOK(pthread_mutex_init(&p->mtx, NULL));
464
465	2240	p->vl = vtc_logopen("%s", name);
466	2240	AN(p->vl);
467
468	2240	PROCESS_EXPAND(dir, "${tmpdir}/%s", name);
469	2240	PROCESS_EXPAND(out, "${tmpdir}/%s/term", name);
470	2240	PROCESS_EXPAND(err, "${tmpdir}/%s/stderr", name);
471
472	2240	bprintf(buf, "rm -rf %s ; mkdir -p %s ; touch %s %s",
473		p->dir, p->dir, p->out, p->err);
474	2240	AZ(system(buf));
475
476	2240	p->fd_term = -1;
477
478	2240	VTAILQ_INSERT_TAIL(&processes, p, list);
479	2240	teken_init(p->tek, &process_teken_func, p);
480	2240	term_resize(p, 24, 80);
481	2240	process_coverage(p);
482	2240	return (p);
483		}
484
485		#undef PROCESS_EXPAND
486
487		/**********************************************************************
488		* Clean up process
489		*/
490
491		static void
492	2240	process_delete(struct process *p)
493		{
494		int i;
495
496	2240	CHECK_OBJ_NOTNULL(p, PROCESS_MAGIC);
497	2240	PTOK(pthread_mutex_destroy(&p->mtx));
498	2240	vtc_logclose(p->vl);
499	2240	free(p->name);