4 * Copyright IBM, Corp. 2012
5 * Copyright Red Hat, Inc. 2012
6 * Copyright SUSE LINUX Products GmbH 2013
9 * Anthony Liguori <aliguori@us.ibm.com>
10 * Paolo Bonzini <pbonzini@redhat.com>
11 * Andreas Färber <afaerber@suse.de>
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.
20 #include <sys/types.h>
21 #include <sys/socket.h>
31 #include "qemu/compiler.h"
32 #include "qemu/osdep.h"
33 #include "qapi/qmp/json-parser.h"
34 #include "qapi/qmp/json-streamer.h"
35 #include "qapi/qmp/qjson.h"
38 #define SOCKET_TIMEOUT 5
40 QTestState
*global_qtest
;
46 bool irq_level
[MAX_IRQ
];
48 pid_t qemu_pid
; /* our child QEMU process */
49 struct sigaction sigact_old
; /* restored on exit */
52 static GList
*qtest_instances
;
53 static struct sigaction sigact_old
;
55 #define g_assert_no_errno(ret) do { \
56 g_assert_cmpint(ret, !=, -1); \
59 static int init_socket(const char *socket_path
)
61 struct sockaddr_un addr
;
65 sock
= socket(PF_UNIX
, SOCK_STREAM
, 0);
66 g_assert_no_errno(sock
);
68 addr
.sun_family
= AF_UNIX
;
69 snprintf(addr
.sun_path
, sizeof(addr
.sun_path
), "%s", socket_path
);
70 qemu_set_cloexec(sock
);
73 ret
= bind(sock
, (struct sockaddr
*)&addr
, sizeof(addr
));
74 } while (ret
== -1 && errno
== EINTR
);
75 g_assert_no_errno(ret
);
76 ret
= listen(sock
, 1);
77 g_assert_no_errno(ret
);
82 static int socket_accept(int sock
)
84 struct sockaddr_un addr
;
87 struct timeval timeout
= { .tv_sec
= SOCKET_TIMEOUT
,
90 setsockopt(sock
, SOL_SOCKET
, SO_RCVTIMEO
, (void *)&timeout
,
94 addrlen
= sizeof(addr
);
95 ret
= accept(sock
, (struct sockaddr
*)&addr
, &addrlen
);
96 } while (ret
== -1 && errno
== EINTR
);
98 fprintf(stderr
, "%s failed: %s\n", __func__
, strerror(errno
));
105 static void kill_qemu(QTestState
*s
)
107 if (s
->qemu_pid
!= -1) {
108 kill(s
->qemu_pid
, SIGTERM
);
109 waitpid(s
->qemu_pid
, NULL
, 0);
113 static void sigabrt_handler(int signo
)
116 for (elem
= qtest_instances
; elem
; elem
= elem
->next
) {
117 kill_qemu(elem
->data
);
121 static void setup_sigabrt_handler(void)
123 struct sigaction sigact
;
125 /* Catch SIGABRT to clean up on g_assert() failure */
126 sigact
= (struct sigaction
){
127 .sa_handler
= sigabrt_handler
,
128 .sa_flags
= SA_RESETHAND
,
130 sigemptyset(&sigact
.sa_mask
);
131 sigaction(SIGABRT
, &sigact
, &sigact_old
);
134 static void cleanup_sigabrt_handler(void)
136 sigaction(SIGABRT
, &sigact_old
, NULL
);
139 QTestState
*qtest_init(const char *extra_args
)
142 int sock
, qmpsock
, i
;
144 gchar
*qmp_socket_path
;
146 const char *qemu_binary
;
148 qemu_binary
= getenv("QTEST_QEMU_BINARY");
149 g_assert(qemu_binary
!= NULL
);
151 s
= g_malloc(sizeof(*s
));
153 socket_path
= g_strdup_printf("/tmp/qtest-%d.sock", getpid());
154 qmp_socket_path
= g_strdup_printf("/tmp/qtest-%d.qmp", getpid());
156 sock
= init_socket(socket_path
);
157 qmpsock
= init_socket(qmp_socket_path
);
159 /* Only install SIGABRT handler once */
160 if (!qtest_instances
) {
161 setup_sigabrt_handler();
164 qtest_instances
= g_list_prepend(qtest_instances
, s
);
166 s
->qemu_pid
= fork();
167 if (s
->qemu_pid
== 0) {
168 setenv("QEMU_AUDIO_DRV", "none", true);
169 command
= g_strdup_printf("exec %s "
170 "-qtest unix:%s,nowait "
172 "-qmp unix:%s,nowait "
173 "-machine accel=qtest "
175 "%s", qemu_binary
, socket_path
,
176 getenv("QTEST_LOG") ? "/dev/fd/2" : "/dev/null",
179 execlp("/bin/sh", "sh", "-c", command
, NULL
);
183 s
->fd
= socket_accept(sock
);
185 s
->qmp_fd
= socket_accept(qmpsock
);
188 unlink(qmp_socket_path
);
190 g_free(qmp_socket_path
);
192 g_assert(s
->fd
>= 0 && s
->qmp_fd
>= 0);
194 s
->rx
= g_string_new("");
195 for (i
= 0; i
< MAX_IRQ
; i
++) {
196 s
->irq_level
[i
] = false;
199 /* Read the QMP greeting and then do the handshake */
200 qtest_qmp_discard_response(s
, "");
201 qtest_qmp_discard_response(s
, "{ 'execute': 'qmp_capabilities' }");
203 if (getenv("QTEST_STOP")) {
204 kill(s
->qemu_pid
, SIGSTOP
);
210 void qtest_quit(QTestState
*s
)
212 /* Uninstall SIGABRT handler on last instance */
213 if (qtest_instances
&& !qtest_instances
->next
) {
214 cleanup_sigabrt_handler();
217 qtest_instances
= g_list_remove(qtest_instances
, s
);
222 g_string_free(s
->rx
, true);
226 static void socket_send(int fd
, const char *buf
, size_t size
)
231 while (offset
< size
) {
234 len
= write(fd
, buf
+ offset
, size
- offset
);
235 if (len
== -1 && errno
== EINTR
) {
239 g_assert_no_errno(len
);
240 g_assert_cmpint(len
, >, 0);
246 static void socket_sendf(int fd
, const char *fmt
, va_list ap
)
248 gchar
*str
= g_strdup_vprintf(fmt
, ap
);
249 size_t size
= strlen(str
);
251 socket_send(fd
, str
, size
);
255 static void GCC_FMT_ATTR(2, 3) qtest_sendf(QTestState
*s
, const char *fmt
, ...)
260 socket_sendf(s
->fd
, fmt
, ap
);
264 static GString
*qtest_recv_line(QTestState
*s
)
270 while ((eol
= strchr(s
->rx
->str
, '\n')) == NULL
) {
274 len
= read(s
->fd
, buffer
, sizeof(buffer
));
275 if (len
== -1 && errno
== EINTR
) {
279 if (len
== -1 || len
== 0) {
280 fprintf(stderr
, "Broken pipe\n");
284 g_string_append_len(s
->rx
, buffer
, len
);
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);
294 static gchar
**qtest_rsp(QTestState
*s
, int expected_args
)
301 line
= qtest_recv_line(s
);
302 words
= g_strsplit(line
->str
, " ", 0);
303 g_string_free(line
, TRUE
);
305 if (strcmp(words
[0], "IRQ") == 0) {
308 g_assert(words
[1] != NULL
);
309 g_assert(words
[2] != NULL
);
311 irq
= strtoul(words
[2], NULL
, 0);
312 g_assert_cmpint(irq
, >=, 0);
313 g_assert_cmpint(irq
, <, MAX_IRQ
);
315 if (strcmp(words
[1], "raise") == 0) {
316 s
->irq_level
[irq
] = true;
318 s
->irq_level
[irq
] = false;
325 g_assert(words
[0] != NULL
);
326 g_assert_cmpstr(words
[0], ==, "OK");
329 for (i
= 0; i
< expected_args
; i
++) {
330 g_assert(words
[i
] != NULL
);
340 JSONMessageParser parser
;
344 static void qmp_response(JSONMessageParser
*parser
, QList
*tokens
)
346 QMPResponseParser
*qmp
= container_of(parser
, QMPResponseParser
, parser
);
349 obj
= json_parser_parse(tokens
, NULL
);
351 fprintf(stderr
, "QMP JSON response parsing failed\n");
355 g_assert(qobject_type(obj
) == QTYPE_QDICT
);
356 g_assert(!qmp
->response
);
357 qmp
->response
= (QDict
*)obj
;
360 QDict
*qtest_qmp_receive(QTestState
*s
)
362 QMPResponseParser qmp
;
363 bool log
= getenv("QTEST_LOG") != NULL
;
366 json_message_parser_init(&qmp
.parser
, qmp_response
);
367 while (!qmp
.response
) {
371 len
= read(s
->qmp_fd
, &c
, 1);
372 if (len
== -1 && errno
== EINTR
) {
376 if (len
== -1 || len
== 0) {
377 fprintf(stderr
, "Broken pipe\n");
382 len
= write(2, &c
, 1);
384 json_message_parser_feed(&qmp
.parser
, &c
, 1);
386 json_message_parser_destroy(&qmp
.parser
);
392 * Allow users to send a message without waiting for the reply,
393 * in the case that they choose to discard all replies up until
394 * a particular EVENT is received.
396 void qtest_async_qmpv(QTestState
*s
, const char *fmt
, va_list ap
)
401 /* Going through qobject ensures we escape strings properly.
402 * This seemingly unnecessary copy is required in case va_list
405 va_copy(ap_copy
, ap
);
406 qobj
= qobject_from_jsonv(fmt
, &ap_copy
);
409 /* No need to send anything for an empty QObject. */
411 int log
= getenv("QTEST_LOG") != NULL
;
412 QString
*qstr
= qobject_to_json(qobj
);
413 const char *str
= qstring_get_str(qstr
);
414 size_t size
= qstring_get_length(qstr
);
417 fprintf(stderr
, "%s", str
);
419 /* Send QMP request */
420 socket_send(s
->qmp_fd
, str
, size
);
423 qobject_decref(qobj
);
427 QDict
*qtest_qmpv(QTestState
*s
, const char *fmt
, va_list ap
)
429 qtest_async_qmpv(s
, fmt
, ap
);
432 return qtest_qmp_receive(s
);
435 QDict
*qtest_qmp(QTestState
*s
, const char *fmt
, ...)
441 response
= qtest_qmpv(s
, fmt
, ap
);
446 void qtest_async_qmp(QTestState
*s
, const char *fmt
, ...)
451 qtest_async_qmpv(s
, fmt
, ap
);
455 void qtest_qmpv_discard_response(QTestState
*s
, const char *fmt
, va_list ap
)
457 QDict
*response
= qtest_qmpv(s
, fmt
, ap
);
461 void qtest_qmp_discard_response(QTestState
*s
, const char *fmt
, ...)
467 response
= qtest_qmpv(s
, fmt
, ap
);
472 void qtest_qmp_eventwait(QTestState
*s
, const char *event
)
477 response
= qtest_qmp_receive(s
);
478 if ((qdict_haskey(response
, "event")) &&
479 (strcmp(qdict_get_str(response
, "event"), event
) == 0)) {
488 const char *qtest_get_arch(void)
490 const char *qemu
= getenv("QTEST_QEMU_BINARY");
491 g_assert(qemu
!= NULL
);
492 const char *end
= strrchr(qemu
, '/');
494 return end
+ strlen("/qemu-system-");
497 bool qtest_get_irq(QTestState
*s
, int num
)
499 /* dummy operation in order to make sure irq is up to date */
502 return s
->irq_level
[num
];
505 static int64_t qtest_clock_rsp(QTestState
*s
)
509 words
= qtest_rsp(s
, 2);
510 clock
= g_ascii_strtoll(words
[1], NULL
, 0);
515 int64_t qtest_clock_step_next(QTestState
*s
)
517 qtest_sendf(s
, "clock_step\n");
518 return qtest_clock_rsp(s
);
521 int64_t qtest_clock_step(QTestState
*s
, int64_t step
)
523 qtest_sendf(s
, "clock_step %"PRIi64
"\n", step
);
524 return qtest_clock_rsp(s
);
527 int64_t qtest_clock_set(QTestState
*s
, int64_t val
)
529 qtest_sendf(s
, "clock_set %"PRIi64
"\n", val
);
530 return qtest_clock_rsp(s
);
533 void qtest_irq_intercept_out(QTestState
*s
, const char *qom_path
)
535 qtest_sendf(s
, "irq_intercept_out %s\n", qom_path
);
539 void qtest_irq_intercept_in(QTestState
*s
, const char *qom_path
)
541 qtest_sendf(s
, "irq_intercept_in %s\n", qom_path
);
545 static void qtest_out(QTestState
*s
, const char *cmd
, uint16_t addr
, uint32_t value
)
547 qtest_sendf(s
, "%s 0x%x 0x%x\n", cmd
, addr
, value
);
551 void qtest_outb(QTestState
*s
, uint16_t addr
, uint8_t value
)
553 qtest_out(s
, "outb", addr
, value
);
556 void qtest_outw(QTestState
*s
, uint16_t addr
, uint16_t value
)
558 qtest_out(s
, "outw", addr
, value
);
561 void qtest_outl(QTestState
*s
, uint16_t addr
, uint32_t value
)
563 qtest_out(s
, "outl", addr
, value
);
566 static uint32_t qtest_in(QTestState
*s
, const char *cmd
, uint16_t addr
)
571 qtest_sendf(s
, "%s 0x%x\n", cmd
, addr
);
572 args
= qtest_rsp(s
, 2);
573 value
= strtoul(args
[1], NULL
, 0);
579 uint8_t qtest_inb(QTestState
*s
, uint16_t addr
)
581 return qtest_in(s
, "inb", addr
);
584 uint16_t qtest_inw(QTestState
*s
, uint16_t addr
)
586 return qtest_in(s
, "inw", addr
);
589 uint32_t qtest_inl(QTestState
*s
, uint16_t addr
)
591 return qtest_in(s
, "inl", addr
);
594 static void qtest_write(QTestState
*s
, const char *cmd
, uint64_t addr
,
597 qtest_sendf(s
, "%s 0x%" PRIx64
" 0x%" PRIx64
"\n", cmd
, addr
, value
);
601 void qtest_writeb(QTestState
*s
, uint64_t addr
, uint8_t value
)
603 qtest_write(s
, "writeb", addr
, value
);
606 void qtest_writew(QTestState
*s
, uint64_t addr
, uint16_t value
)
608 qtest_write(s
, "writew", addr
, value
);
611 void qtest_writel(QTestState
*s
, uint64_t addr
, uint32_t value
)
613 qtest_write(s
, "writel", addr
, value
);
616 void qtest_writeq(QTestState
*s
, uint64_t addr
, uint64_t value
)
618 qtest_write(s
, "writeq", addr
, value
);
621 static uint64_t qtest_read(QTestState
*s
, const char *cmd
, uint64_t addr
)
626 qtest_sendf(s
, "%s 0x%" PRIx64
"\n", cmd
, addr
);
627 args
= qtest_rsp(s
, 2);
628 value
= strtoull(args
[1], NULL
, 0);
634 uint8_t qtest_readb(QTestState
*s
, uint64_t addr
)
636 return qtest_read(s
, "readb", addr
);
639 uint16_t qtest_readw(QTestState
*s
, uint64_t addr
)
641 return qtest_read(s
, "readw", addr
);
644 uint32_t qtest_readl(QTestState
*s
, uint64_t addr
)
646 return qtest_read(s
, "readl", addr
);
649 uint64_t qtest_readq(QTestState
*s
, uint64_t addr
)
651 return qtest_read(s
, "readq", addr
);
654 static int hex2nib(char ch
)
656 if (ch
>= '0' && ch
<= '9') {
658 } else if (ch
>= 'a' && ch
<= 'f') {
659 return 10 + (ch
- 'a');
660 } else if (ch
>= 'A' && ch
<= 'F') {
661 return 10 + (ch
- 'a');
667 void qtest_memread(QTestState
*s
, uint64_t addr
, void *data
, size_t size
)
673 qtest_sendf(s
, "read 0x%" PRIx64
" 0x%zx\n", addr
, size
);
674 args
= qtest_rsp(s
, 2);
676 for (i
= 0; i
< size
; i
++) {
677 ptr
[i
] = hex2nib(args
[1][2 + (i
* 2)]) << 4;
678 ptr
[i
] |= hex2nib(args
[1][2 + (i
* 2) + 1]);
684 void qtest_add_func(const char *str
, void (*fn
))
686 gchar
*path
= g_strdup_printf("/%s/%s", qtest_get_arch(), str
);
687 g_test_add_func(path
, fn
);
691 void qtest_add_data_func(const char *str
, const void *data
, void (*fn
))
693 gchar
*path
= g_strdup_printf("/%s/%s", qtest_get_arch(), str
);
694 g_test_add_data_func(path
, data
, fn
);
698 void qtest_memwrite(QTestState
*s
, uint64_t addr
, const void *data
, size_t size
)
700 const uint8_t *ptr
= data
;
703 qtest_sendf(s
, "write 0x%" PRIx64
" 0x%zx 0x", addr
, size
);
704 for (i
= 0; i
< size
; i
++) {
705 qtest_sendf(s
, "%02x", ptr
[i
]);
707 qtest_sendf(s
, "\n");
711 void qtest_memset(QTestState
*s
, uint64_t addr
, uint8_t pattern
, size_t size
)
715 qtest_sendf(s
, "write 0x%" PRIx64
" 0x%zx 0x", addr
, size
);
716 for (i
= 0; i
< size
; i
++) {
717 qtest_sendf(s
, "%02x", pattern
);
719 qtest_sendf(s
, "\n");
723 QDict
*qmp(const char *fmt
, ...)
729 response
= qtest_qmpv(global_qtest
, fmt
, ap
);
734 void qmp_async(const char *fmt
, ...)
739 qtest_async_qmpv(global_qtest
, fmt
, ap
);
743 void qmp_discard_response(const char *fmt
, ...)
748 qtest_qmpv_discard_response(global_qtest
, fmt
, ap
);
752 bool qtest_big_endian(void)
754 const char *arch
= qtest_get_arch();
757 static const struct {
761 { "aarch64", false },
768 { "microblaze", true },
769 { "microblazeel", false },
772 { "mips64el", false },
784 { "unicore32", false },
787 { "xtensaeb", true },
791 for (i
= 0; endianness
[i
].arch
; i
++) {
792 if (strcmp(endianness
[i
].arch
, arch
) == 0) {
793 return endianness
[i
].big_endian
;