[mirror_qemu.git] / tests / libqtest.c

/*
 * QTest
 *
 * Copyright IBM, Corp. 2012
 * Copyright Red Hat, Inc. 2012
 * Copyright SUSE LINUX Products GmbH 2013
 *
 * Authors:
 *  Anthony Liguori   <aliguori@us.ibm.com>
 *  Paolo Bonzini     <pbonzini@redhat.com>
 *  Andreas Färber    <afaerber@suse.de>
 *
 * This work is licensed under the terms of the GNU GPL, version 2 or later.
 * See the COPYING file in the top-level directory.
 *
 */
#include "libqtest.h"

#include <glib.h>
#include <sys/types.h>
#include <sys/socket.h>
#include <sys/wait.h>
#include <sys/un.h>
#include <inttypes.h>
#include <errno.h>
#include <stdio.h>
#include <stdlib.h>
#include <unistd.h>
#include <string.h>

#include "qemu/compiler.h"
#include "qemu/osdep.h"
#include "qapi/qmp/json-parser.h"
#include "qapi/qmp/json-streamer.h"
#include "qapi/qmp/qjson.h"

#define MAX_IRQ 256
#define SOCKET_TIMEOUT 5

QTestState *global_qtest;

struct QTestState
{
    int fd;
    int qmp_fd;
    bool irq_level[MAX_IRQ];
    GString *rx;
    pid_t qemu_pid;  /* our child QEMU process */
    struct sigaction sigact_old; /* restored on exit */
};

static GList *qtest_instances;
static struct sigaction sigact_old;

#define g_assert_no_errno(ret) do { \
    g_assert_cmpint(ret, !=, -1); \
} while (0)

static int init_socket(const char *socket_path)
{
    struct sockaddr_un addr;
    int sock;
    int ret;

    sock = socket(PF_UNIX, SOCK_STREAM, 0);
    g_assert_no_errno(sock);

    addr.sun_family = AF_UNIX;
    snprintf(addr.sun_path, sizeof(addr.sun_path), "%s", socket_path);
    qemu_set_cloexec(sock);

    do {
        ret = bind(sock, (struct sockaddr *)&addr, sizeof(addr));
    } while (ret == -1 && errno == EINTR);
    g_assert_no_errno(ret);
    ret = listen(sock, 1);
    g_assert_no_errno(ret);

    return sock;
}

static int socket_accept(int sock)
{
    struct sockaddr_un addr;
    socklen_t addrlen;
    int ret;
    struct timeval timeout = { .tv_sec = SOCKET_TIMEOUT,
                               .tv_usec = 0 };

    setsockopt(sock, SOL_SOCKET, SO_RCVTIMEO, (void *)&timeout,
               sizeof(timeout));

    do {
        addrlen = sizeof(addr);
        ret = accept(sock, (struct sockaddr *)&addr, &addrlen);
    } while (ret == -1 && errno == EINTR);
    if (ret == -1) {
        fprintf(stderr, "%s failed: %s\n", __func__, strerror(errno));
    }
    close(sock);

    return ret;
}

static void kill_qemu(QTestState *s)
{
    if (s->qemu_pid != -1) {
        kill(s->qemu_pid, SIGTERM);
        waitpid(s->qemu_pid, NULL, 0);
    }
}

static void sigabrt_handler(int signo)
{
    GList *elem;
    for (elem = qtest_instances; elem; elem = elem->next) {
        kill_qemu(elem->data);
    }
}

static void setup_sigabrt_handler(void)
{
    struct sigaction sigact;

    /* Catch SIGABRT to clean up on g_assert() failure */
    sigact = (struct sigaction){
        .sa_handler = sigabrt_handler,
        .sa_flags = SA_RESETHAND,
    };
    sigemptyset(&sigact.sa_mask);
    sigaction(SIGABRT, &sigact, &sigact_old);
}

static void cleanup_sigabrt_handler(void)
{
    sigaction(SIGABRT, &sigact_old, NULL);
}

QTestState *qtest_init(const char *extra_args)
{
    QTestState *s;
    int sock, qmpsock, i;
    gchar *socket_path;
    gchar *qmp_socket_path;
    gchar *command;
    const char *qemu_binary;

    qemu_binary = getenv("QTEST_QEMU_BINARY");
    g_assert(qemu_binary != NULL);

    s = g_malloc(sizeof(*s));

    socket_path = g_strdup_printf("/tmp/qtest-%d.sock", getpid());
    qmp_socket_path = g_strdup_printf("/tmp/qtest-%d.qmp", getpid());

    sock = init_socket(socket_path);
    qmpsock = init_socket(qmp_socket_path);

    /* Only install SIGABRT handler once */
    if (!qtest_instances) {
        setup_sigabrt_handler();
    }

    qtest_instances = g_list_prepend(qtest_instances, s);

    s->qemu_pid = fork();
    if (s->qemu_pid == 0) {
        setenv("QEMU_AUDIO_DRV", "none", true);
        command = g_strdup_printf("exec %s "
                                  "-qtest unix:%s,nowait "
                                  "-qtest-log %s "
                                  "-qmp unix:%s,nowait "
                                  "-machine accel=qtest "
                                  "-display none "
                                  "%s", qemu_binary, socket_path,
                                  getenv("QTEST_LOG") ? "/dev/fd/2" : "/dev/null",
                                  qmp_socket_path,
                                  extra_args ?: "");
        execlp("/bin/sh", "sh", "-c", command, NULL);
        exit(1);
    }

    s->fd = socket_accept(sock);
    if (s->fd >= 0) {
        s->qmp_fd = socket_accept(qmpsock);
    }
    unlink(socket_path);
    unlink(qmp_socket_path);
    g_free(socket_path);
    g_free(qmp_socket_path);

    g_assert(s->fd >= 0 && s->qmp_fd >= 0);

    s->rx = g_string_new("");
    for (i = 0; i < MAX_IRQ; i++) {
        s->irq_level[i] = false;
    }

    /* Read the QMP greeting and then do the handshake */
    qtest_qmp_discard_response(s, "");
    qtest_qmp_discard_response(s, "{ 'execute': 'qmp_capabilities' }");

    if (getenv("QTEST_STOP")) {
        kill(s->qemu_pid, SIGSTOP);
    }

    return s;
}

void qtest_quit(QTestState *s)
{
    /* Uninstall SIGABRT handler on last instance */
    if (qtest_instances && !qtest_instances->next) {
        cleanup_sigabrt_handler();
    }

    qtest_instances = g_list_remove(qtest_instances, s);

    kill_qemu(s);
    close(s->fd);
    close(s->qmp_fd);
    g_string_free(s->rx, true);
    g_free(s);
}

static void socket_send(int fd, const char *buf, size_t size)
{
    size_t offset;

    offset = 0;
    while (offset < size) {
        ssize_t len;

        len = write(fd, buf + offset, size - offset);
        if (len == -1 && errno == EINTR) {
            continue;
        }

        g_assert_no_errno(len);
        g_assert_cmpint(len, >, 0);

        offset += len;
    }
}

static void socket_sendf(int fd, const char *fmt, va_list ap)
{
    gchar *str = g_strdup_vprintf(fmt, ap);
    size_t size = strlen(str);

    socket_send(fd, str, size);
    g_free(str);
}

static void GCC_FMT_ATTR(2, 3) qtest_sendf(QTestState *s, const char *fmt, ...)
{
    va_list ap;

    va_start(ap, fmt);
    socket_sendf(s->fd, fmt, ap);
    va_end(ap);
}

static GString *qtest_recv_line(QTestState *s)
{
    GString *line;
    size_t offset;
    char *eol;

    while ((eol = strchr(s->rx->str, '\n')) == NULL) {
        ssize_t len;
        char buffer[1024];

        len = read(s->fd, buffer, sizeof(buffer));
        if (len == -1 && errno == EINTR) {
            continue;
        }

        if (len == -1 || len == 0) {
            fprintf(stderr, "Broken pipe\n");
            exit(1);
        }

        g_string_append_len(s->rx, buffer, len);
    }

    offset = eol - s->rx->str;
    line = g_string_new_len(s->rx->str, offset);
    g_string_erase(s->rx, 0, offset + 1);

    return line;
}

static gchar **qtest_rsp(QTestState *s, int expected_args)
{
    GString *line;
    gchar **words;
    int i;

redo:
    line = qtest_recv_line(s);
    words = g_strsplit(line->str, " ", 0);
    g_string_free(line, TRUE);

    if (strcmp(words[0], "IRQ") == 0) {
        int irq;

        g_assert(words[1] != NULL);
        g_assert(words[2] != NULL);

        irq = strtoul(words[2], NULL, 0);
        g_assert_cmpint(irq, >=, 0);
        g_assert_cmpint(irq, <, MAX_IRQ);

        if (strcmp(words[1], "raise") == 0) {
            s->irq_level[irq] = true;
        } else {
            s->irq_level[irq] = false;
        }

        g_strfreev(words);
        goto redo;
    }

    g_assert(words[0] != NULL);
    g_assert_cmpstr(words[0], ==, "OK");

    if (expected_args) {
        for (i = 0; i < expected_args; i++) {
            g_assert(words[i] != NULL);
        }
    } else {
        g_strfreev(words);
    }

    return words;
}

typedef struct {
    JSONMessageParser parser;
    QDict *response;
} QMPResponseParser;

static void qmp_response(JSONMessageParser *parser, QList *tokens)
{
    QMPResponseParser *qmp = container_of(parser, QMPResponseParser, parser);
    QObject *obj;

    obj = json_parser_parse(tokens, NULL);
    if (!obj) {
        fprintf(stderr, "QMP JSON response parsing failed\n");
        exit(1);
    }

    g_assert(qobject_type(obj) == QTYPE_QDICT);
    g_assert(!qmp->response);
    qmp->response = (QDict *)obj;
}

QDict *qtest_qmp_receive(QTestState *s)
{
    QMPResponseParser qmp;
    bool log = getenv("QTEST_LOG") != NULL;

    qmp.response = NULL;
    json_message_parser_init(&qmp.parser, qmp_response);
    while (!qmp.response) {
        ssize_t len;
        char c;

        len = read(s->qmp_fd, &c, 1);
        if (len == -1 && errno == EINTR) {
            continue;
        }

        if (len == -1 || len == 0) {
            fprintf(stderr, "Broken pipe\n");
            exit(1);
        }

        if (log) {
            len = write(2, &c, 1);
        }
        json_message_parser_feed(&qmp.parser, &c, 1);
    }
    json_message_parser_destroy(&qmp.parser);

    return qmp.response;
}

QDict *qtest_qmpv(QTestState *s, const char *fmt, va_list ap)
{
    va_list ap_copy;
    QObject *qobj;

    /* Going through qobject ensures we escape strings properly.
     * This seemingly unnecessary copy is required in case va_list
     * is an array type.
     */
    va_copy(ap_copy, ap);
    qobj = qobject_from_jsonv(fmt, &ap_copy);
    va_end(ap_copy);

    /* No need to send anything for an empty QObject.  */
    if (qobj) {
        int log = getenv("QTEST_LOG") != NULL;
        QString *qstr = qobject_to_json(qobj);
        const char *str = qstring_get_str(qstr);
        size_t size = qstring_get_length(qstr);

        if (log) {
            fprintf(stderr, "%s", str);
        }
        /* Send QMP request */
        socket_send(s->qmp_fd, str, size);

        QDECREF(qstr);
        qobject_decref(qobj);
    }

    /* Receive reply */
    return qtest_qmp_receive(s);
}

QDict *qtest_qmp(QTestState *s, const char *fmt, ...)
{
    va_list ap;
    QDict *response;

    va_start(ap, fmt);
    response = qtest_qmpv(s, fmt, ap);
    va_end(ap);
    return response;
}

void qtest_qmpv_discard_response(QTestState *s, const char *fmt, va_list ap)
{
    QDict *response = qtest_qmpv(s, fmt, ap);
    QDECREF(response);
}

void qtest_qmp_discard_response(QTestState *s, const char *fmt, ...)
{
    va_list ap;
    QDict *response;

    va_start(ap, fmt);
    response = qtest_qmpv(s, fmt, ap);
    va_end(ap);
    QDECREF(response);
}

const char *qtest_get_arch(void)
{
    const char *qemu = getenv("QTEST_QEMU_BINARY");
    const char *end = strrchr(qemu, '/');

    return end + strlen("/qemu-system-");
}

bool qtest_get_irq(QTestState *s, int num)
{
    /* dummy operation in order to make sure irq is up to date */
    qtest_inb(s, 0);

    return s->irq_level[num];
}

static int64_t qtest_clock_rsp(QTestState *s)
{
    gchar **words;
    int64_t clock;
    words = qtest_rsp(s, 2);
    clock = g_ascii_strtoll(words[1], NULL, 0);
    g_strfreev(words);
    return clock;
}

int64_t qtest_clock_step_next(QTestState *s)
{
    qtest_sendf(s, "clock_step\n");
    return qtest_clock_rsp(s);
}

int64_t qtest_clock_step(QTestState *s, int64_t step)
{
    qtest_sendf(s, "clock_step %"PRIi64"\n", step);
    return qtest_clock_rsp(s);
}

int64_t qtest_clock_set(QTestState *s, int64_t val)
{
    qtest_sendf(s, "clock_set %"PRIi64"\n", val);
    return qtest_clock_rsp(s);
}

void qtest_irq_intercept_out(QTestState *s, const char *qom_path)
{
    qtest_sendf(s, "irq_intercept_out %s\n", qom_path);
    qtest_rsp(s, 0);
}

void qtest_irq_intercept_in(QTestState *s, const char *qom_path)
{
    qtest_sendf(s, "irq_intercept_in %s\n", qom_path);
    qtest_rsp(s, 0);
}

static void qtest_out(QTestState *s, const char *cmd, uint16_t addr, uint32_t value)
{
    qtest_sendf(s, "%s 0x%x 0x%x\n", cmd, addr, value);
    qtest_rsp(s, 0);
}

void qtest_outb(QTestState *s, uint16_t addr, uint8_t value)
{
    qtest_out(s, "outb", addr, value);
}

void qtest_outw(QTestState *s, uint16_t addr, uint16_t value)
{
    qtest_out(s, "outw", addr, value);
}

void qtest_outl(QTestState *s, uint16_t addr, uint32_t value)
{
    qtest_out(s, "outl", addr, value);
}

static uint32_t qtest_in(QTestState *s, const char *cmd, uint16_t addr)
{
    gchar **args;
    uint32_t value;

    qtest_sendf(s, "%s 0x%x\n", cmd, addr);
    args = qtest_rsp(s, 2);
    value = strtoul(args[1], NULL, 0);
    g_strfreev(args);

    return value;
}

uint8_t qtest_inb(QTestState *s, uint16_t addr)
{
    return qtest_in(s, "inb", addr);
}

uint16_t qtest_inw(QTestState *s, uint16_t addr)
{
    return qtest_in(s, "inw", addr);
}

uint32_t qtest_inl(QTestState *s, uint16_t addr)
{
    return qtest_in(s, "inl", addr);
}

static void qtest_write(QTestState *s, const char *cmd, uint64_t addr,
                        uint64_t value)
{
    qtest_sendf(s, "%s 0x%" PRIx64 " 0x%" PRIx64 "\n", cmd, addr, value);
    qtest_rsp(s, 0);
}

void qtest_writeb(QTestState *s, uint64_t addr, uint8_t value)
{
    qtest_write(s, "writeb", addr, value);
}

void qtest_writew(QTestState *s, uint64_t addr, uint16_t value)
{
    qtest_write(s, "writew", addr, value);
}

void qtest_writel(QTestState *s, uint64_t addr, uint32_t value)
{
    qtest_write(s, "writel", addr, value);
}

void qtest_writeq(QTestState *s, uint64_t addr, uint64_t value)
{
    qtest_write(s, "writeq", addr, value);
}

static uint64_t qtest_read(QTestState *s, const char *cmd, uint64_t addr)
{
    gchar **args;
    uint64_t value;

    qtest_sendf(s, "%s 0x%" PRIx64 "\n", cmd, addr);
    args = qtest_rsp(s, 2);
    value = strtoull(args[1], NULL, 0);
    g_strfreev(args);

    return value;
}

uint8_t qtest_readb(QTestState *s, uint64_t addr)
{
    return qtest_read(s, "readb", addr);
}

uint16_t qtest_readw(QTestState *s, uint64_t addr)
{
    return qtest_read(s, "readw", addr);
}

uint32_t qtest_readl(QTestState *s, uint64_t addr)
{
    return qtest_read(s, "readl", addr);
}

uint64_t qtest_readq(QTestState *s, uint64_t addr)
{
    return qtest_read(s, "readq", addr);
}

static int hex2nib(char ch)
{
    if (ch >= '0' && ch <= '9') {
        return ch - '0';
    } else if (ch >= 'a' && ch <= 'f') {
        return 10 + (ch - 'a');
    } else if (ch >= 'A' && ch <= 'F') {
        return 10 + (ch - 'a');
    } else {
        return -1;
    }
}

void qtest_memread(QTestState *s, uint64_t addr, void *data, size_t size)
{
    uint8_t *ptr = data;
    gchar **args;
    size_t i;

    qtest_sendf(s, "read 0x%" PRIx64 " 0x%zx\n", addr, size);
    args = qtest_rsp(s, 2);

    for (i = 0; i < size; i++) {
        ptr[i] = hex2nib(args[1][2 + (i * 2)]) << 4;
        ptr[i] |= hex2nib(args[1][2 + (i * 2) + 1]);
    }

    g_strfreev(args);
}

void qtest_add_func(const char *str, void (*fn))
{
    gchar *path = g_strdup_printf("/%s/%s", qtest_get_arch(), str);
    g_test_add_func(path, fn);
    g_free(path);
}

void qtest_memwrite(QTestState *s, uint64_t addr, const void *data, size_t size)
{
    const uint8_t *ptr = data;
    size_t i;

    qtest_sendf(s, "write 0x%" PRIx64 " 0x%zx 0x", addr, size);
    for (i = 0; i < size; i++) {
        qtest_sendf(s, "%02x", ptr[i]);
    }
    qtest_sendf(s, "\n");
    qtest_rsp(s, 0);
}

void qtest_memset(QTestState *s, uint64_t addr, uint8_t pattern, size_t size)
{
    size_t i;

    qtest_sendf(s, "write 0x%" PRIx64 " 0x%zx 0x", addr, size);
    for (i = 0; i < size; i++) {
        qtest_sendf(s, "%02x", pattern);
    }
    qtest_sendf(s, "\n");
    qtest_rsp(s, 0);
}

QDict *qmp(const char *fmt, ...)
{
    va_list ap;
    QDict *response;

    va_start(ap, fmt);
    response = qtest_qmpv(global_qtest, fmt, ap);
    va_end(ap);
    return response;
}

void qmp_discard_response(const char *fmt, ...)
{
    va_list ap;

    va_start(ap, fmt);
    qtest_qmpv_discard_response(global_qtest, fmt, ap);
    va_end(ap);
}

bool qtest_big_endian(void)
{
    const char *arch = qtest_get_arch();
    int i;

    static const struct {
        const char *arch;
        bool big_endian;
    } endianness[] = {
        { "aarch64", false },
        { "alpha", false },
        { "arm", false },
        { "cris", false },
        { "i386", false },
        { "lm32", true },
        { "m68k", true },
        { "microblaze", true },
        { "microblazeel", false },
        { "mips", true },
        { "mips64", true },
        { "mips64el", false },
        { "mipsel", false },
        { "moxie", true },
        { "or32", true },
        { "ppc", true },
        { "ppc64", true },
        { "ppcemb", true },
        { "s390x", true },
        { "sh4", false },
        { "sh4eb", true },
        { "sparc", true },
        { "sparc64", true },
        { "unicore32", false },
        { "x86_64", false },
        { "xtensa", false },
        { "xtensaeb", true },
        {},
    };

    for (i = 0; endianness[i].arch; i++) {
        if (strcmp(endianness[i].arch, arch) == 0) {
            return endianness[i].big_endian;
        }
    }

    return false;
}
Commit	Line	Data
49ee3590 AL	1	/*
	2	* QTest
	3	*
	4	* Copyright IBM, Corp. 2012
	5	* Copyright Red Hat, Inc. 2012
872536bf	6	* Copyright SUSE LINUX Products GmbH 2013
49ee3590 AL	7	*
	8	* Authors:
	9	* Anthony Liguori <aliguori@us.ibm.com>
	10	* Paolo Bonzini <pbonzini@redhat.com>
872536bf	11	* Andreas Färber <afaerber@suse.de>
49ee3590 AL	12	*
	13	* This work is licensed under the terms of the GNU GPL, version 2 or later.
	14	* See the COPYING file in the top-level directory.
	15	*
	16	*/
	17	#include "libqtest.h"
	18
	19	#include <glib.h>
	20	#include <sys/types.h>
	21	#include <sys/socket.h>
	22	#include <sys/wait.h>
	23	#include <sys/un.h>
	24	#include <inttypes.h>
	25	#include <errno.h>
	26	#include <stdio.h>
	27	#include <stdlib.h>
	28	#include <unistd.h>
	29	#include <string.h>
	30
1de7afc9 PB	31	#include "qemu/compiler.h"
1de7afc9 PB	32	#include "qemu/osdep.h"
0c460dac	33	#include "qapi/qmp/json-parser.h"
563890c7 PB	34	#include "qapi/qmp/json-streamer.h"
563890c7 PB	35	#include "qapi/qmp/qjson.h"
49ee3590 AL	36
49ee3590 AL	37	#define MAX_IRQ 256
f8762027	38	#define SOCKET_TIMEOUT 5
49ee3590 AL	39
	40	QTestState *global_qtest;
	41
	42	struct QTestState
	43	{
	44	int fd;
a3ca163c	45	int qmp_fd;
49ee3590 AL	46	bool irq_level[MAX_IRQ];
49ee3590 AL	47	GString *rx;
cef60c92	48	pid_t qemu_pid; /* our child QEMU process */
b15d422a	49	struct sigaction sigact_old; /* restored on exit */
49ee3590 AL	50	};
49ee3590 AL	51
d7668251 SH	52	static GList *qtest_instances;
	53	static struct sigaction sigact_old;
	54
49ee3590 AL	55	#define g_assert_no_errno(ret) do { \
	56	g_assert_cmpint(ret, !=, -1); \
	57	} while (0)
	58
a3ca163c KW	59	static int init_socket(const char *socket_path)
	60	{
	61	struct sockaddr_un addr;
	62	int sock;
	63	int ret;
	64
	65	sock = socket(PF_UNIX, SOCK_STREAM, 0);
	66	g_assert_no_errno(sock);
	67
	68	addr.sun_family = AF_UNIX;
	69	snprintf(addr.sun_path, sizeof(addr.sun_path), "%s", socket_path);
	70	qemu_set_cloexec(sock);
	71
	72	do {
	73	ret = bind(sock, (struct sockaddr *)&addr, sizeof(addr));
	74	} while (ret == -1 && errno == EINTR);
	75	g_assert_no_errno(ret);
a7ded163 AF	76	ret = listen(sock, 1);
a7ded163 AF	77	g_assert_no_errno(ret);
a3ca163c KW	78
	79	return sock;
	80	}
	81
	82	static int socket_accept(int sock)
	83	{
	84	struct sockaddr_un addr;
	85	socklen_t addrlen;
	86	int ret;
f8762027 MA	87	struct timeval timeout = { .tv_sec = SOCKET_TIMEOUT,
	88	.tv_usec = 0 };
	89
	90	setsockopt(sock, SOL_SOCKET, SO_RCVTIMEO, (void *)&timeout,
	91	sizeof(timeout));
a3ca163c KW	92
a3ca163c KW	93	do {
535b4563	94	addrlen = sizeof(addr);
a3ca163c KW	95	ret = accept(sock, (struct sockaddr *)&addr, &addrlen);
a3ca163c KW	96	} while (ret == -1 && errno == EINTR);
a7d915f3 AF	97	if (ret == -1) {
	98	fprintf(stderr, "%s failed: %s\n", __func__, strerror(errno));
	99	}
a3ca163c KW	100	close(sock);
	101
	102	return ret;
	103	}
	104
b15d422a SH	105	static void kill_qemu(QTestState *s)
	106	{
	107	if (s->qemu_pid != -1) {
	108	kill(s->qemu_pid, SIGTERM);
	109	waitpid(s->qemu_pid, NULL, 0);
	110	}
	111	}
	112
	113	static void sigabrt_handler(int signo)
	114	{
d7668251 SH	115	GList *elem;
	116	for (elem = qtest_instances; elem; elem = elem->next) {
	117	kill_qemu(elem->data);
	118	}
	119	}
	120
	121	static void setup_sigabrt_handler(void)
	122	{
	123	struct sigaction sigact;
	124
	125	/* Catch SIGABRT to clean up on g_assert() failure */
	126	sigact = (struct sigaction){
	127	.sa_handler = sigabrt_handler,
	128	.sa_flags = SA_RESETHAND,
	129	};
	130	sigemptyset(&sigact.sa_mask);
	131	sigaction(SIGABRT, &sigact, &sigact_old);
	132	}
	133
	134	static void cleanup_sigabrt_handler(void)
	135	{
	136	sigaction(SIGABRT, &sigact_old, NULL);
b15d422a SH	137	}
b15d422a SH	138
49ee3590 AL	139	QTestState qtest_init(const char extra_args)
	140	{
	141	QTestState *s;
8a8fd637	142	int sock, qmpsock, i;
56db2e58 SH	143	gchar *socket_path;
56db2e58 SH	144	gchar *qmp_socket_path;
49ee3590 AL	145	gchar *command;
49ee3590 AL	146	const char *qemu_binary;
49ee3590 AL	147
	148	qemu_binary = getenv("QTEST_QEMU_BINARY");
	149	g_assert(qemu_binary != NULL);
	150
96b8ca47	151	s = g_malloc(sizeof(*s));
49ee3590	152
56db2e58 SH	153	socket_path = g_strdup_printf("/tmp/qtest-%d.sock", getpid());
56db2e58 SH	154	qmp_socket_path = g_strdup_printf("/tmp/qtest-%d.qmp", getpid());
bb494a50	155
56db2e58 SH	156	sock = init_socket(socket_path);
56db2e58 SH	157	qmpsock = init_socket(qmp_socket_path);
49ee3590	158
d7668251 SH	159	/* Only install SIGABRT handler once */
	160	if (!qtest_instances) {
	161	setup_sigabrt_handler();
	162	}
	163
	164	qtest_instances = g_list_prepend(qtest_instances, s);
b15d422a	165
cef60c92 SH	166	s->qemu_pid = fork();
cef60c92 SH	167	if (s->qemu_pid == 0) {
6b029216	168	setenv("QEMU_AUDIO_DRV", "none", true);
cef60c92	169	command = g_strdup_printf("exec %s "
49ee3590	170	"-qtest unix:%s,nowait "
7c282cb4	171	"-qtest-log %s "
a3ca163c	172	"-qmp unix:%s,nowait "
49ee3590	173	"-machine accel=qtest "
2ad645d2	174	"-display none "
56db2e58	175	"%s", qemu_binary, socket_path,
7c282cb4	176	getenv("QTEST_LOG") ? "/dev/fd/2" : "/dev/null",
cef60c92	177	qmp_socket_path,
49ee3590	178	extra_args ?: "");
8a8fd637 AL	179	execlp("/bin/sh", "sh", "-c", command, NULL);
8a8fd637 AL	180	exit(1);
49ee3590 AL	181	}
49ee3590 AL	182
a3ca163c	183	s->fd = socket_accept(sock);
f8762027 MA	184	if (s->fd >= 0) {
	185	s->qmp_fd = socket_accept(qmpsock);
	186	}
56db2e58 SH	187	unlink(socket_path);
	188	unlink(qmp_socket_path);
	189	g_free(socket_path);
	190	g_free(qmp_socket_path);
49ee3590	191
f8762027 MA	192	g_assert(s->fd >= 0 && s->qmp_fd >= 0);
f8762027 MA	193
49ee3590	194	s->rx = g_string_new("");
49ee3590 AL	195	for (i = 0; i < MAX_IRQ; i++) {
	196	s->irq_level[i] = false;
	197	}
	198
a3ca163c	199	/* Read the QMP greeting and then do the handshake */
0d1aa05e SH	200	qtest_qmp_discard_response(s, "");
0d1aa05e SH	201	qtest_qmp_discard_response(s, "{ 'execute': 'qmp_capabilities' }");
49ee3590	202
e0fea6b1	203	if (getenv("QTEST_STOP")) {
1ad3c6ab	204	kill(s->qemu_pid, SIGSTOP);
e0fea6b1 PB	205	}
e0fea6b1 PB	206
49ee3590 AL	207	return s;
	208	}
	209
	210	void qtest_quit(QTestState *s)
	211	{
d7668251 SH	212	/* Uninstall SIGABRT handler on last instance */
	213	if (qtest_instances && !qtest_instances->next) {
	214	cleanup_sigabrt_handler();
	215	}
	216
	217	qtest_instances = g_list_remove(qtest_instances, s);
bb494a50	218
b15d422a	219	kill_qemu(s);
fdd26fca MA	220	close(s->fd);
	221	close(s->qmp_fd);
	222	g_string_free(s->rx, true);
fdd26fca	223	g_free(s);
49ee3590 AL	224	}
49ee3590 AL	225
563890c7	226	static void socket_send(int fd, const char *buf, size_t size)
49ee3590	227	{
563890c7	228	size_t offset;
49ee3590 AL	229
	230	offset = 0;
	231	while (offset < size) {
	232	ssize_t len;
	233
563890c7	234	len = write(fd, buf + offset, size - offset);
49ee3590 AL	235	if (len == -1 && errno == EINTR) {
	236	continue;
	237	}
	238
	239	g_assert_no_errno(len);
	240	g_assert_cmpint(len, >, 0);
	241
	242	offset += len;
	243	}
	244	}
	245
563890c7 PB	246	static void socket_sendf(int fd, const char *fmt, va_list ap)
	247	{
	248	gchar *str = g_strdup_vprintf(fmt, ap);
	249	size_t size = strlen(str);
	250
	251	socket_send(fd, str, size);
	252	g_free(str);
	253	}
	254
a3ca163c KW	255	static void GCC_FMT_ATTR(2, 3) qtest_sendf(QTestState s, const char fmt, ...)
	256	{
	257	va_list ap;
	258
	259	va_start(ap, fmt);
	260	socket_sendf(s->fd, fmt, ap);
	261	va_end(ap);
	262	}
	263
49ee3590 AL	264	static GString qtest_recv_line(QTestState s)
	265	{
	266	GString *line;
	267	size_t offset;
	268	char *eol;
	269
	270	while ((eol = strchr(s->rx->str, '\n')) == NULL) {
	271	ssize_t len;
	272	char buffer[1024];
	273
	274	len = read(s->fd, buffer, sizeof(buffer));
	275	if (len == -1 && errno == EINTR) {
	276	continue;
	277	}
	278
	279	if (len == -1 \|\| len == 0) {
	280	fprintf(stderr, "Broken pipe\n");
	281	exit(1);
	282	}
	283
	284	g_string_append_len(s->rx, buffer, len);
	285	}
	286
	287	offset = eol - s->rx->str;
	288	line = g_string_new_len(s->rx->str, offset);
	289	g_string_erase(s->rx, 0, offset + 1);
	290
	291	return line;
	292	}
	293
	294	static gchar *qtest_rsp(QTestState s, int expected_args)
	295	{
	296	GString *line;
	297	gchar **words;
	298	int i;
	299
	300	redo:
	301	line = qtest_recv_line(s);
	302	words = g_strsplit(line->str, " ", 0);
	303	g_string_free(line, TRUE);
	304
	305	if (strcmp(words[0], "IRQ") == 0) {
	306	int irq;
	307
	308	g_assert(words[1] != NULL);
	309	g_assert(words[2] != NULL);
	310
	311	irq = strtoul(words[2], NULL, 0);
	312	g_assert_cmpint(irq, >=, 0);
	313	g_assert_cmpint(irq, <, MAX_IRQ);
	314
	315	if (strcmp(words[1], "raise") == 0) {
	316	s->irq_level[irq] = true;
	317	} else {
	318	s->irq_level[irq] = false;
	319	}
	320
	321	g_strfreev(words);
	322	goto redo;
	323	}
	324
	325	g_assert(words[0] != NULL);
	326	g_assert_cmpstr(words[0], ==, "OK");
	327
328	if (expected_args) {
329	for (i = 0; i < expected_args; i++) {
330	g_assert(words[i] != NULL);
331	}
332	} else {
333	g_strfreev(words);
334	}
335
336	return words;
337	}
338
0c460dac SH	339	typedef struct {
	340	JSONMessageParser parser;
	341	QDict *response;
	342	} QMPResponseParser;
	343
	344	static void qmp_response(JSONMessageParser parser, QList tokens)
a3ca163c	345	{
0c460dac SH	346	QMPResponseParser *qmp = container_of(parser, QMPResponseParser, parser);
	347	QObject *obj;
	348
	349	obj = json_parser_parse(tokens, NULL);
	350	if (!obj) {
	351	fprintf(stderr, "QMP JSON response parsing failed\n");
	352	exit(1);
	353	}
	354
	355	g_assert(qobject_type(obj) == QTYPE_QDICT);
	356	g_assert(!qmp->response);
	357	qmp->response = (QDict *)obj;
	358	}
	359
66e0c7b1	360	QDict qtest_qmp_receive(QTestState s)
0c460dac SH	361	{
0c460dac SH	362	QMPResponseParser qmp;
7c282cb4	363	bool log = getenv("QTEST_LOG") != NULL;
a3ca163c	364
0c460dac SH	365	qmp.response = NULL;
	366	json_message_parser_init(&qmp.parser, qmp_response);
	367	while (!qmp.response) {
a3ca163c KW	368	ssize_t len;
	369	char c;
	370
	371	len = read(s->qmp_fd, &c, 1);
	372	if (len == -1 && errno == EINTR) {
	373	continue;
	374	}
	375
039380a8 AL	376	if (len == -1 \|\| len == 0) {
	377	fprintf(stderr, "Broken pipe\n");
	378	exit(1);
	379	}
	380
7c282cb4 PB	381	if (log) {
	382	len = write(2, &c, 1);
	383	}
0c460dac	384	json_message_parser_feed(&qmp.parser, &c, 1);
a3ca163c	385	}
0c460dac SH	386	json_message_parser_destroy(&qmp.parser);
	387
	388	return qmp.response;
	389	}
	390
66e0c7b1 AF	391	QDict qtest_qmpv(QTestState s, const char *fmt, va_list ap)
66e0c7b1 AF	392	{
563890c7 PB	393	va_list ap_copy;
	394	QObject *qobj;
	395
	396	/* Going through qobject ensures we escape strings properly.
	397	* This seemingly unnecessary copy is required in case va_list
	398	* is an array type.
	399	*/
	400	va_copy(ap_copy, ap);
	401	qobj = qobject_from_jsonv(fmt, &ap_copy);
	402	va_end(ap_copy);
	403
	404	/* No need to send anything for an empty QObject. */
	405	if (qobj) {
ae74f187	406	int log = getenv("QTEST_LOG") != NULL;
563890c7 PB	407	QString *qstr = qobject_to_json(qobj);
	408	const char *str = qstring_get_str(qstr);
	409	size_t size = qstring_get_length(qstr);
	410
ae74f187 MM	411	if (log) {
	412	fprintf(stderr, "%s", str);
	413	}
563890c7 PB	414	/* Send QMP request */
	415	socket_send(s->qmp_fd, str, size);
	416
	417	QDECREF(qstr);
	418	qobject_decref(qobj);
	419	}
66e0c7b1 AF	420
	421	/* Receive reply */
	422	return qtest_qmp_receive(s);
	423	}
	424
0c460dac SH	425	QDict qtest_qmp(QTestState s, const char *fmt, ...)
	426	{
	427	va_list ap;
	428	QDict *response;
	429
	430	va_start(ap, fmt);
	431	response = qtest_qmpv(s, fmt, ap);
	432	va_end(ap);
	433	return response;
	434	}
	435
	436	void qtest_qmpv_discard_response(QTestState s, const char fmt, va_list ap)
	437	{
	438	QDict *response = qtest_qmpv(s, fmt, ap);
	439	QDECREF(response);
a3ca163c KW	440	}
a3ca163c KW	441
0d1aa05e	442	void qtest_qmp_discard_response(QTestState s, const char fmt, ...)
b73cf9e9 AF	443	{
b73cf9e9 AF	444	va_list ap;
0c460dac	445	QDict *response;
b73cf9e9 AF	446
b73cf9e9 AF	447	va_start(ap, fmt);
0c460dac	448	response = qtest_qmpv(s, fmt, ap);
b73cf9e9	449	va_end(ap);
0c460dac	450	QDECREF(response);
b73cf9e9 AF	451	}
b73cf9e9 AF	452
49ee3590 AL	453	const char *qtest_get_arch(void)
	454	{
	455	const char *qemu = getenv("QTEST_QEMU_BINARY");
	456	const char *end = strrchr(qemu, '/');
	457
	458	return end + strlen("/qemu-system-");
	459	}
	460
	461	bool qtest_get_irq(QTestState *s, int num)
	462	{
	463	/* dummy operation in order to make sure irq is up to date */
	464	qtest_inb(s, 0);
	465
	466	return s->irq_level[num];
	467	}
	468
	469	static int64_t qtest_clock_rsp(QTestState *s)
	470	{
	471	gchar **words;
	472	int64_t clock;
	473	words = qtest_rsp(s, 2);
	474	clock = g_ascii_strtoll(words[1], NULL, 0);
	475	g_strfreev(words);
	476	return clock;
	477	}
	478
	479	int64_t qtest_clock_step_next(QTestState *s)
	480	{
	481	qtest_sendf(s, "clock_step\n");
	482	return qtest_clock_rsp(s);
	483	}
	484
	485	int64_t qtest_clock_step(QTestState *s, int64_t step)
	486	{
	487	qtest_sendf(s, "clock_step %"PRIi64"\n", step);
	488	return qtest_clock_rsp(s);
	489	}
	490
	491	int64_t qtest_clock_set(QTestState *s, int64_t val)
	492	{
	493	qtest_sendf(s, "clock_set %"PRIi64"\n", val);
	494	return qtest_clock_rsp(s);
	495	}
	496
	497	void qtest_irq_intercept_out(QTestState s, const char qom_path)
	498	{
	499	qtest_sendf(s, "irq_intercept_out %s\n", qom_path);
	500	qtest_rsp(s, 0);
	501	}
	502
	503	void qtest_irq_intercept_in(QTestState s, const char qom_path)
	504	{
	505	qtest_sendf(s, "irq_intercept_in %s\n", qom_path);
	506	qtest_rsp(s, 0);
	507	}
	508
	509	static void qtest_out(QTestState s, const char cmd, uint16_t addr, uint32_t value)
	510	{
	511	qtest_sendf(s, "%s 0x%x 0x%x\n", cmd, addr, value);
	512	qtest_rsp(s, 0);
	513	}
	514
	515	void qtest_outb(QTestState *s, uint16_t addr, uint8_t value)
	516	{
517	qtest_out(s, "outb", addr, value);
518	}
519
520	void qtest_outw(QTestState *s, uint16_t addr, uint16_t value)
521	{
522	qtest_out(s, "outw", addr, value);
523	}
524
525	void qtest_outl(QTestState *s, uint16_t addr, uint32_t value)
526	{
527	qtest_out(s, "outl", addr, value);
528	}
529
530	static uint32_t qtest_in(QTestState s, const char cmd, uint16_t addr)
531	{
532	gchar **args;
533	uint32_t value;
534
535	qtest_sendf(s, "%s 0x%x\n", cmd, addr);
536	args = qtest_rsp(s, 2);
537	value = strtoul(args[1], NULL, 0);
538	g_strfreev(args);
539
540	return value;
541	}
542
543	uint8_t qtest_inb(QTestState *s, uint16_t addr)
544	{
545	return qtest_in(s, "inb", addr);
546	}
547
548	uint16_t qtest_inw(QTestState *s, uint16_t addr)
549	{
550	return qtest_in(s, "inw", addr);
551	}
552
553	uint32_t qtest_inl(QTestState *s, uint16_t addr)
554	{
555	return qtest_in(s, "inl", addr);
556	}
557
872536bf AF	558	static void qtest_write(QTestState s, const char cmd, uint64_t addr,
	559	uint64_t value)
	560	{
	561	qtest_sendf(s, "%s 0x%" PRIx64 " 0x%" PRIx64 "\n", cmd, addr, value);
	562	qtest_rsp(s, 0);
	563	}
	564
	565	void qtest_writeb(QTestState *s, uint64_t addr, uint8_t value)
	566	{
	567	qtest_write(s, "writeb", addr, value);
	568	}
	569
	570	void qtest_writew(QTestState *s, uint64_t addr, uint16_t value)
	571	{
	572	qtest_write(s, "writew", addr, value);
	573	}
	574
	575	void qtest_writel(QTestState *s, uint64_t addr, uint32_t value)
	576	{
	577	qtest_write(s, "writel", addr, value);
	578	}
	579
	580	void qtest_writeq(QTestState *s, uint64_t addr, uint64_t value)
	581	{
	582	qtest_write(s, "writeq", addr, value);
	583	}
	584
	585	static uint64_t qtest_read(QTestState s, const char cmd, uint64_t addr)
	586	{
	587	gchar **args;
	588	uint64_t value;
	589
	590	qtest_sendf(s, "%s 0x%" PRIx64 "\n", cmd, addr);
	591	args = qtest_rsp(s, 2);
	592	value = strtoull(args[1], NULL, 0);
	593	g_strfreev(args);
	594
	595	return value;
	596	}
	597
	598	uint8_t qtest_readb(QTestState *s, uint64_t addr)
	599	{
	600	return qtest_read(s, "readb", addr);
	601	}
	602
	603	uint16_t qtest_readw(QTestState *s, uint64_t addr)
	604	{
	605	return qtest_read(s, "readw", addr);
	606	}
	607
	608	uint32_t qtest_readl(QTestState *s, uint64_t addr)
	609	{
	610	return qtest_read(s, "readl", addr);
	611	}
	612
	613	uint64_t qtest_readq(QTestState *s, uint64_t addr)
	614	{
	615	return qtest_read(s, "readq", addr);
	616	}
	617
49ee3590 AL	618	static int hex2nib(char ch)
	619	{
	620	if (ch >= '0' && ch <= '9') {
	621	return ch - '0';
	622	} else if (ch >= 'a' && ch <= 'f') {
	623	return 10 + (ch - 'a');
	624	} else if (ch >= 'A' && ch <= 'F') {
	625	return 10 + (ch - 'a');
	626	} else {
	627	return -1;
	628	}
	629	}
	630
	631	void qtest_memread(QTestState s, uint64_t addr, void data, size_t size)
	632	{
	633	uint8_t *ptr = data;
	634	gchar **args;
	635	size_t i;
	636
ea7697fc	637	qtest_sendf(s, "read 0x%" PRIx64 " 0x%zx\n", addr, size);
49ee3590 AL	638	args = qtest_rsp(s, 2);
	639
	640	for (i = 0; i < size; i++) {
	641	ptr[i] = hex2nib(args[1][2 + (i * 2)]) << 4;
	642	ptr[i] \|= hex2nib(args[1][2 + (i * 2) + 1]);
	643	}
	644
	645	g_strfreev(args);
	646	}
	647
	648	void qtest_add_func(const char str, void (fn))
	649	{
	650	gchar *path = g_strdup_printf("/%s/%s", qtest_get_arch(), str);
	651	g_test_add_func(path, fn);
a7afc6b8	652	g_free(path);
49ee3590 AL	653	}
	654
	655	void qtest_memwrite(QTestState s, uint64_t addr, const void data, size_t size)
	656	{
	657	const uint8_t *ptr = data;
	658	size_t i;
	659
ea7697fc	660	qtest_sendf(s, "write 0x%" PRIx64 " 0x%zx 0x", addr, size);
49ee3590 AL	661	for (i = 0; i < size; i++) {
	662	qtest_sendf(s, "%02x", ptr[i]);
	663	}
	664	qtest_sendf(s, "\n");
	665	qtest_rsp(s, 0);
	666	}
0100f425	667
86298845 JS	668	void qtest_memset(QTestState *s, uint64_t addr, uint8_t pattern, size_t size)
	669	{
	670	size_t i;
	671
	672	qtest_sendf(s, "write 0x%" PRIx64 " 0x%zx 0x", addr, size);
	673	for (i = 0; i < size; i++) {
	674	qtest_sendf(s, "%02x", pattern);
	675	}
	676	qtest_sendf(s, "\n");
	677	qtest_rsp(s, 0);
	678	}
	679
0100f425 PM	680	QDict qmp(const char fmt, ...)
	681	{
	682	va_list ap;
	683	QDict *response;
	684
	685	va_start(ap, fmt);
	686	response = qtest_qmpv(global_qtest, fmt, ap);
	687	va_end(ap);
	688	return response;
	689	}
	690
	691	void qmp_discard_response(const char *fmt, ...)
	692	{
	693	va_list ap;
	694
	695	va_start(ap, fmt);
	696	qtest_qmpv_discard_response(global_qtest, fmt, ap);
	697	va_end(ap);
	698	}
46e0cf76 MM	699
	700	bool qtest_big_endian(void)
	701	{
	702	const char *arch = qtest_get_arch();
	703	int i;
	704
	705	static const struct {
	706	const char *arch;
	707	bool big_endian;
	708	} endianness[] = {
	709	{ "aarch64", false },
	710	{ "alpha", false },
	711	{ "arm", false },
	712	{ "cris", false },
	713	{ "i386", false },
	714	{ "lm32", true },
	715	{ "m68k", true },
	716	{ "microblaze", true },
	717	{ "microblazeel", false },
	718	{ "mips", true },
	719	{ "mips64", true },
	720	{ "mips64el", false },
	721	{ "mipsel", false },
	722	{ "moxie", true },
	723	{ "or32", true },
	724	{ "ppc", true },
	725	{ "ppc64", true },
	726	{ "ppcemb", true },
	727	{ "s390x", true },
	728	{ "sh4", false },
	729	{ "sh4eb", true },
	730	{ "sparc", true },
	731	{ "sparc64", true },
	732	{ "unicore32", false },
	733	{ "x86_64", false },
	734	{ "xtensa", false },
	735	{ "xtensaeb", true },
	736	{},
	737	};
	738
	739	for (i = 0; endianness[i].arch; i++) {
	740	if (strcmp(endianness[i].arch, arch) == 0) {
	741	return endianness[i].big_endian;
	742	}
	743	}
	744
	745	return false;
	746	}