[mirror_qemu.git] / tests / libqtest.c

/*
 * QTest
 *
 * Copyright IBM, Corp. 2012
 * Copyright Red Hat, Inc. 2012
 *
 * Authors:
 *  Anthony Liguori   <aliguori@us.ibm.com>
 *  Paolo Bonzini     <pbonzini@redhat.com>
 *
 * 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 "osdep.h"

#define MAX_IRQ 256

QTestState *global_qtest;

struct QTestState
{
    int fd;
    bool irq_level[MAX_IRQ];
    GString *rx;
    gchar *pid_file;
};

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

QTestState *qtest_init(const char *extra_args)
{
    QTestState *s;
    struct sockaddr_un addr;
    int sock, ret, i;
    gchar *socket_path;
    gchar *pid_file;
    gchar *command;
    const char *qemu_binary;
    pid_t pid;
    socklen_t addrlen;

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

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

    s = g_malloc(sizeof(*s));

    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);
    listen(sock, 1);

    pid = fork();
    if (pid == 0) {
        command = g_strdup_printf("%s "
                                  "-qtest unix:%s,nowait "
                                  "-qtest-log /dev/null "
                                  "-pidfile %s "
                                  "-machine accel=qtest "
                                  "%s", qemu_binary, socket_path,
                                  pid_file,
                                  extra_args ?: "");

        ret = system(command);
        exit(ret);
        g_free(command);
    }

    do {
        ret = accept(sock, (struct sockaddr *)&addr, &addrlen);
    } while (ret == -1 && errno == EINTR);
    g_assert_no_errno(ret);
    close(sock);

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

    g_free(socket_path);

    return s;
}

void qtest_quit(QTestState *s)
{
    FILE *f;
    char buffer[1024];

    f = fopen(s->pid_file, "r");
    if (f) {
        if (fgets(buffer, sizeof(buffer), f)) {
            pid_t pid = atoi(buffer);
            int status = 0;

            kill(pid, SIGTERM);
            waitpid(pid, &status, 0);
        }

        fclose(f);
    }
}

static void qtest_sendf(QTestState *s, const char *fmt, ...)
{
    va_list ap;
    gchar *str;
    size_t size, offset;

    va_start(ap, fmt);
    str = g_strdup_vprintf(fmt, ap);
    va_end(ap);
    size = strlen(str);

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

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

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

        offset += len;
    }
}

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;
}

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 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%x 0x%x\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);
}

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%x 0x%x 0x", addr, size);
    for (i = 0; i < size; i++) {
        qtest_sendf(s, "%02x", ptr[i]);
    }
    qtest_sendf(s, "\n");
    qtest_rsp(s, 0);
}
Commit	Line	Data
49ee3590 AL	1	/*
	2	* QTest
	3	*
	4	* Copyright IBM, Corp. 2012
	5	* Copyright Red Hat, Inc. 2012
	6	*
	7	* Authors:
	8	* Anthony Liguori <aliguori@us.ibm.com>
	9	* Paolo Bonzini <pbonzini@redhat.com>
	10	*
	11	* This work is licensed under the terms of the GNU GPL, version 2 or later.
	12	* See the COPYING file in the top-level directory.
	13	*
	14	*/
	15	#include "libqtest.h"
	16
	17	#include <glib.h>
	18	#include <sys/types.h>
	19	#include <sys/socket.h>
	20	#include <sys/wait.h>
	21	#include <sys/un.h>
	22	#include <inttypes.h>
	23	#include <errno.h>
	24	#include <stdio.h>
	25	#include <stdlib.h>
	26	#include <unistd.h>
	27	#include <string.h>
	28
	29	#include "osdep.h"
	30
	31	#define MAX_IRQ 256
	32
	33	QTestState *global_qtest;
	34
	35	struct QTestState
	36	{
	37	int fd;
	38	bool irq_level[MAX_IRQ];
	39	GString *rx;
	40	gchar *pid_file;
	41	};
	42
	43	#define g_assert_no_errno(ret) do { \
	44	g_assert_cmpint(ret, !=, -1); \
	45	} while (0)
	46
	47	QTestState qtest_init(const char extra_args)
	48	{
	49	QTestState *s;
	50	struct sockaddr_un addr;
	51	int sock, ret, i;
	52	gchar *socket_path;
	53	gchar *pid_file;
	54	gchar *command;
	55	const char *qemu_binary;
	56	pid_t pid;
	57	socklen_t addrlen;
	58
	59	qemu_binary = getenv("QTEST_QEMU_BINARY");
	60	g_assert(qemu_binary != NULL);
	61
	62	socket_path = g_strdup_printf("/tmp/qtest-%d.sock", getpid());
	63	pid_file = g_strdup_printf("/tmp/qtest-%d.pid", getpid());
	64
65	s = g_malloc(sizeof(*s));
66
67	sock = socket(PF_UNIX, SOCK_STREAM, 0);
68	g_assert_no_errno(sock);
69
70	addr.sun_family = AF_UNIX;
71	snprintf(addr.sun_path, sizeof(addr.sun_path), "%s", socket_path);
72	qemu_set_cloexec(sock);
73
74	do {
75	ret = bind(sock, (struct sockaddr *)&addr, sizeof(addr));
76	} while (ret == -1 && errno == EINTR);
77	g_assert_no_errno(ret);
78	listen(sock, 1);
79
80	pid = fork();
81	if (pid == 0) {
82	command = g_strdup_printf("%s "
83	"-qtest unix:%s,nowait "
84	"-qtest-log /dev/null "
85	"-pidfile %s "
86	"-machine accel=qtest "
87	"%s", qemu_binary, socket_path,
88	pid_file,
89	extra_args ?: "");
90
91	ret = system(command);
92	exit(ret);
93	g_free(command);
94	}
95
96	do {
97	ret = accept(sock, (struct sockaddr *)&addr, &addrlen);
98	} while (ret == -1 && errno == EINTR);
99	g_assert_no_errno(ret);
100	close(sock);
101
102	s->fd = ret;
103	s->rx = g_string_new("");
104	s->pid_file = pid_file;
105	for (i = 0; i < MAX_IRQ; i++) {
106	s->irq_level[i] = false;
107	}
108
109	g_free(socket_path);
110
111	return s;
112	}
113
114	void qtest_quit(QTestState *s)
115	{
116	FILE *f;
117	char buffer[1024];
118
119	f = fopen(s->pid_file, "r");
120	if (f) {
121	if (fgets(buffer, sizeof(buffer), f)) {
122	pid_t pid = atoi(buffer);
123	int status = 0;
124
125	kill(pid, SIGTERM);
126	waitpid(pid, &status, 0);
127	}
128
129	fclose(f);
130	}
131	}
132
133	static void qtest_sendf(QTestState s, const char fmt, ...)
134	{
135	va_list ap;
136	gchar *str;
137	size_t size, offset;
138
139	va_start(ap, fmt);
140	str = g_strdup_vprintf(fmt, ap);
141	va_end(ap);
142	size = strlen(str);
143
144	offset = 0;
145	while (offset < size) {
146	ssize_t len;
147
148	len = write(s->fd, str + offset, size - offset);
149	if (len == -1 && errno == EINTR) {
150	continue;
151	}
152
153	g_assert_no_errno(len);
154	g_assert_cmpint(len, >, 0);
155
156	offset += len;
157	}
158	}
159
160	static GString qtest_recv_line(QTestState s)
161	{
162	GString *line;
163	size_t offset;
164	char *eol;
165
166	while ((eol = strchr(s->rx->str, '\n')) == NULL) {
167	ssize_t len;
168	char buffer[1024];
169
170	len = read(s->fd, buffer, sizeof(buffer));
171	if (len == -1 && errno == EINTR) {
172	continue;
173	}
174
175	if (len == -1 \|\| len == 0) {
176	fprintf(stderr, "Broken pipe\n");
177	exit(1);
178	}
179
180	g_string_append_len(s->rx, buffer, len);
181	}
182
183	offset = eol - s->rx->str;
184	line = g_string_new_len(s->rx->str, offset);
185	g_string_erase(s->rx, 0, offset + 1);
186
187	return line;
188	}
189
190	static gchar *qtest_rsp(QTestState s, int expected_args)
191	{
192	GString *line;
193	gchar **words;
194	int i;
195
196	redo:
197	line = qtest_recv_line(s);
198	words = g_strsplit(line->str, " ", 0);
199	g_string_free(line, TRUE);
200
201	if (strcmp(words[0], "IRQ") == 0) {
202	int irq;
203
204	g_assert(words[1] != NULL);
205	g_assert(words[2] != NULL);
206
207	irq = strtoul(words[2], NULL, 0);
208	g_assert_cmpint(irq, >=, 0);
209	g_assert_cmpint(irq, <, MAX_IRQ);
210
211	if (strcmp(words[1], "raise") == 0) {
212	s->irq_level[irq] = true;
213	} else {
214	s->irq_level[irq] = false;
215	}
216
217	g_strfreev(words);
218	goto redo;
219	}
220
221	g_assert(words[0] != NULL);
222	g_assert_cmpstr(words[0], ==, "OK");
223
224	if (expected_args) {
225	for (i = 0; i < expected_args; i++) {
226	g_assert(words[i] != NULL);
227	}
228	} else {
229	g_strfreev(words);
230	}
231
232	return words;
233	}
234
235	const char *qtest_get_arch(void)
236	{
237	const char *qemu = getenv("QTEST_QEMU_BINARY");
238	const char *end = strrchr(qemu, '/');
239
240	return end + strlen("/qemu-system-");
241	}
242
243	bool qtest_get_irq(QTestState *s, int num)
244	{
245	/* dummy operation in order to make sure irq is up to date */
246	qtest_inb(s, 0);
247
248	return s->irq_level[num];
249	}
250
251	static int64_t qtest_clock_rsp(QTestState *s)
252	{
253	gchar **words;
254	int64_t clock;
255	words = qtest_rsp(s, 2);
256	clock = g_ascii_strtoll(words[1], NULL, 0);
257	g_strfreev(words);
258	return clock;
259	}
260
261	int64_t qtest_clock_step_next(QTestState *s)
262	{
263	qtest_sendf(s, "clock_step\n");
264	return qtest_clock_rsp(s);
265	}
266
267	int64_t qtest_clock_step(QTestState *s, int64_t step)
268	{
269	qtest_sendf(s, "clock_step %"PRIi64"\n", step);
270	return qtest_clock_rsp(s);
271	}
272
273	int64_t qtest_clock_set(QTestState *s, int64_t val)
274	{
275	qtest_sendf(s, "clock_set %"PRIi64"\n", val);
276	return qtest_clock_rsp(s);
277	}
278
279	void qtest_irq_intercept_out(QTestState s, const char qom_path)
280	{
281	qtest_sendf(s, "irq_intercept_out %s\n", qom_path);
282	qtest_rsp(s, 0);
283	}
284
285	void qtest_irq_intercept_in(QTestState s, const char qom_path)
286	{
287	qtest_sendf(s, "irq_intercept_in %s\n", qom_path);
288	qtest_rsp(s, 0);
289	}
290
291	static void qtest_out(QTestState s, const char cmd, uint16_t addr, uint32_t value)
292	{
293	qtest_sendf(s, "%s 0x%x 0x%x\n", cmd, addr, value);
294	qtest_rsp(s, 0);
295	}
296
297	void qtest_outb(QTestState *s, uint16_t addr, uint8_t value)
298	{
299	qtest_out(s, "outb", addr, value);
300	}
301
302	void qtest_outw(QTestState *s, uint16_t addr, uint16_t value)
303	{
304	qtest_out(s, "outw", addr, value);
305	}
306
307	void qtest_outl(QTestState *s, uint16_t addr, uint32_t value)
308	{
309	qtest_out(s, "outl", addr, value);
310	}
311
312	static uint32_t qtest_in(QTestState s, const char cmd, uint16_t addr)
313	{
314	gchar **args;
315	uint32_t value;
316
317	qtest_sendf(s, "%s 0x%x\n", cmd, addr);
318	args = qtest_rsp(s, 2);
319	value = strtoul(args[1], NULL, 0);
320	g_strfreev(args);
321
322	return value;
323	}
324
325	uint8_t qtest_inb(QTestState *s, uint16_t addr)
326	{
327	return qtest_in(s, "inb", addr);
328	}
329
330	uint16_t qtest_inw(QTestState *s, uint16_t addr)
331	{
332	return qtest_in(s, "inw", addr);
333	}
334
335	uint32_t qtest_inl(QTestState *s, uint16_t addr)
336	{
337	return qtest_in(s, "inl", addr);
338	}
339
340	static int hex2nib(char ch)
341	{
342	if (ch >= '0' && ch <= '9') {
343	return ch - '0';
344	} else if (ch >= 'a' && ch <= 'f') {
345	return 10 + (ch - 'a');
346	} else if (ch >= 'A' && ch <= 'F') {
347	return 10 + (ch - 'a');
348	} else {
349	return -1;
350	}
351	}
352
353	void qtest_memread(QTestState s, uint64_t addr, void data, size_t size)
354	{
355	uint8_t *ptr = data;
356	gchar **args;
357	size_t i;
358
359	qtest_sendf(s, "read 0x%x 0x%x\n", addr, size);
360	args = qtest_rsp(s, 2);
361
362	for (i = 0; i < size; i++) {
363	ptr[i] = hex2nib(args[1][2 + (i * 2)]) << 4;
364	ptr[i] \|= hex2nib(args[1][2 + (i * 2) + 1]);
365	}
366
367	g_strfreev(args);
368	}
369
370	void qtest_add_func(const char str, void (fn))
371	{
372	gchar *path = g_strdup_printf("/%s/%s", qtest_get_arch(), str);
373	g_test_add_func(path, fn);
374	}
375
376	void qtest_memwrite(QTestState s, uint64_t addr, const void data, size_t size)
377	{
378	const uint8_t *ptr = data;
379	size_t i;
380
381	qtest_sendf(s, "write 0x%x 0x%x 0x", addr, size);
382	for (i = 0; i < size; i++) {
383	qtest_sendf(s, "%02x", ptr[i]);
384	}
385	qtest_sendf(s, "\n");
386	qtest_rsp(s, 0);
387	}