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.
17 #include "qemu/osdep.h"
20 #include <sys/socket.h>
24 #include "qapi/error.h"
25 #include "qapi/qmp/json-parser.h"
26 #include "qapi/qmp/json-streamer.h"
27 #include "qapi/qmp/qjson.h"
30 #define SOCKET_TIMEOUT 50
32 QTestState
*global_qtest
;
38 bool irq_level
[MAX_IRQ
];
40 pid_t qemu_pid
; /* our child QEMU process */
44 static GHookList abrt_hooks
;
45 static GList
*qtest_instances
;
46 static struct sigaction sigact_old
;
48 #define g_assert_no_errno(ret) do { \
49 g_assert_cmpint(ret, !=, -1); \
52 static int qtest_query_target_endianness(QTestState
*s
);
54 static int init_socket(const char *socket_path
)
56 struct sockaddr_un addr
;
60 sock
= socket(PF_UNIX
, SOCK_STREAM
, 0);
61 g_assert_no_errno(sock
);
63 addr
.sun_family
= AF_UNIX
;
64 snprintf(addr
.sun_path
, sizeof(addr
.sun_path
), "%s", socket_path
);
65 qemu_set_cloexec(sock
);
68 ret
= bind(sock
, (struct sockaddr
*)&addr
, sizeof(addr
));
69 } while (ret
== -1 && errno
== EINTR
);
70 g_assert_no_errno(ret
);
71 ret
= listen(sock
, 1);
72 g_assert_no_errno(ret
);
77 static int socket_accept(int sock
)
79 struct sockaddr_un addr
;
82 struct timeval timeout
= { .tv_sec
= SOCKET_TIMEOUT
,
85 setsockopt(sock
, SOL_SOCKET
, SO_RCVTIMEO
, (void *)&timeout
,
89 addrlen
= sizeof(addr
);
90 ret
= accept(sock
, (struct sockaddr
*)&addr
, &addrlen
);
91 } while (ret
== -1 && errno
== EINTR
);
93 fprintf(stderr
, "%s failed: %s\n", __func__
, strerror(errno
));
100 static void kill_qemu(QTestState
*s
)
102 if (s
->qemu_pid
!= -1) {
103 kill(s
->qemu_pid
, SIGTERM
);
104 waitpid(s
->qemu_pid
, NULL
, 0);
108 static void kill_qemu_hook_func(void *s
)
113 static void sigabrt_handler(int signo
)
115 g_hook_list_invoke(&abrt_hooks
, FALSE
);
118 static void setup_sigabrt_handler(void)
120 struct sigaction sigact
;
122 /* Catch SIGABRT to clean up on g_assert() failure */
123 sigact
= (struct sigaction
){
124 .sa_handler
= sigabrt_handler
,
125 .sa_flags
= SA_RESETHAND
,
127 sigemptyset(&sigact
.sa_mask
);
128 sigaction(SIGABRT
, &sigact
, &sigact_old
);
131 static void cleanup_sigabrt_handler(void)
133 sigaction(SIGABRT
, &sigact_old
, NULL
);
136 void qtest_add_abrt_handler(GHookFunc fn
, const void *data
)
140 /* Only install SIGABRT handler once */
141 if (!abrt_hooks
.is_setup
) {
142 g_hook_list_init(&abrt_hooks
, sizeof(GHook
));
143 setup_sigabrt_handler();
146 hook
= g_hook_alloc(&abrt_hooks
);
148 hook
->data
= (void *)data
;
150 g_hook_prepend(&abrt_hooks
, hook
);
153 QTestState
*qtest_init_without_qmp_handshake(const char *extra_args
)
156 int sock
, qmpsock
, i
;
158 gchar
*qmp_socket_path
;
160 const char *qemu_binary
;
162 qemu_binary
= getenv("QTEST_QEMU_BINARY");
163 g_assert(qemu_binary
!= NULL
);
165 s
= g_malloc(sizeof(*s
));
167 socket_path
= g_strdup_printf("/tmp/qtest-%d.sock", getpid());
168 qmp_socket_path
= g_strdup_printf("/tmp/qtest-%d.qmp", getpid());
170 sock
= init_socket(socket_path
);
171 qmpsock
= init_socket(qmp_socket_path
);
173 qtest_add_abrt_handler(kill_qemu_hook_func
, s
);
175 s
->qemu_pid
= fork();
176 if (s
->qemu_pid
== 0) {
177 setenv("QEMU_AUDIO_DRV", "none", true);
178 command
= g_strdup_printf("exec %s "
179 "-qtest unix:%s,nowait "
181 "-qmp unix:%s,nowait "
182 "-machine accel=qtest "
184 "%s", qemu_binary
, socket_path
,
185 getenv("QTEST_LOG") ? "/dev/fd/2" : "/dev/null",
188 execlp("/bin/sh", "sh", "-c", command
, NULL
);
192 s
->fd
= socket_accept(sock
);
194 s
->qmp_fd
= socket_accept(qmpsock
);
197 unlink(qmp_socket_path
);
199 g_free(qmp_socket_path
);
201 g_assert(s
->fd
>= 0 && s
->qmp_fd
>= 0);
203 s
->rx
= g_string_new("");
204 for (i
= 0; i
< MAX_IRQ
; i
++) {
205 s
->irq_level
[i
] = false;
208 if (getenv("QTEST_STOP")) {
209 kill(s
->qemu_pid
, SIGSTOP
);
212 /* ask endianness of the target */
214 s
->big_endian
= qtest_query_target_endianness(s
);
219 QTestState
*qtest_init(const char *extra_args
)
221 QTestState
*s
= qtest_init_without_qmp_handshake(extra_args
);
223 /* Read the QMP greeting and then do the handshake */
224 qtest_qmp_discard_response(s
, "");
225 qtest_qmp_discard_response(s
, "{ 'execute': 'qmp_capabilities' }");
230 void qtest_quit(QTestState
*s
)
232 qtest_instances
= g_list_remove(qtest_instances
, s
);
233 g_hook_destroy_link(&abrt_hooks
, g_hook_find_data(&abrt_hooks
, TRUE
, s
));
235 /* Uninstall SIGABRT handler on last instance */
236 if (!qtest_instances
) {
237 cleanup_sigabrt_handler();
243 g_string_free(s
->rx
, true);
247 static void socket_send(int fd
, const char *buf
, size_t size
)
252 while (offset
< size
) {
255 len
= write(fd
, buf
+ offset
, size
- offset
);
256 if (len
== -1 && errno
== EINTR
) {
260 g_assert_no_errno(len
);
261 g_assert_cmpint(len
, >, 0);
267 static void socket_sendf(int fd
, const char *fmt
, va_list ap
)
269 gchar
*str
= g_strdup_vprintf(fmt
, ap
);
270 size_t size
= strlen(str
);
272 socket_send(fd
, str
, size
);
276 static void GCC_FMT_ATTR(2, 3) qtest_sendf(QTestState
*s
, const char *fmt
, ...)
281 socket_sendf(s
->fd
, fmt
, ap
);
285 static GString
*qtest_recv_line(QTestState
*s
)
291 while ((eol
= strchr(s
->rx
->str
, '\n')) == NULL
) {
295 len
= read(s
->fd
, buffer
, sizeof(buffer
));
296 if (len
== -1 && errno
== EINTR
) {
300 if (len
== -1 || len
== 0) {
301 fprintf(stderr
, "Broken pipe\n");
305 g_string_append_len(s
->rx
, buffer
, len
);
308 offset
= eol
- s
->rx
->str
;
309 line
= g_string_new_len(s
->rx
->str
, offset
);
310 g_string_erase(s
->rx
, 0, offset
+ 1);
315 static gchar
**qtest_rsp(QTestState
*s
, int expected_args
)
322 line
= qtest_recv_line(s
);
323 words
= g_strsplit(line
->str
, " ", 0);
324 g_string_free(line
, TRUE
);
326 if (strcmp(words
[0], "IRQ") == 0) {
329 g_assert(words
[1] != NULL
);
330 g_assert(words
[2] != NULL
);
332 irq
= strtoul(words
[2], NULL
, 0);
333 g_assert_cmpint(irq
, >=, 0);
334 g_assert_cmpint(irq
, <, MAX_IRQ
);
336 if (strcmp(words
[1], "raise") == 0) {
337 s
->irq_level
[irq
] = true;
339 s
->irq_level
[irq
] = false;
346 g_assert(words
[0] != NULL
);
347 g_assert_cmpstr(words
[0], ==, "OK");
350 for (i
= 0; i
< expected_args
; i
++) {
351 g_assert(words
[i
] != NULL
);
360 static int qtest_query_target_endianness(QTestState
*s
)
365 qtest_sendf(s
, "endianness\n");
366 args
= qtest_rsp(s
, 1);
367 g_assert(strcmp(args
[1], "big") == 0 || strcmp(args
[1], "little") == 0);
368 big_endian
= strcmp(args
[1], "big") == 0;
375 JSONMessageParser parser
;
379 static void qmp_response(JSONMessageParser
*parser
, GQueue
*tokens
)
381 QMPResponseParser
*qmp
= container_of(parser
, QMPResponseParser
, parser
);
384 obj
= json_parser_parse(tokens
, NULL
);
386 fprintf(stderr
, "QMP JSON response parsing failed\n");
390 g_assert(!qmp
->response
);
391 qmp
->response
= qobject_to_qdict(obj
);
392 g_assert(qmp
->response
);
395 QDict
*qmp_fd_receive(int fd
)
397 QMPResponseParser qmp
;
398 bool log
= getenv("QTEST_LOG") != NULL
;
401 json_message_parser_init(&qmp
.parser
, qmp_response
);
402 while (!qmp
.response
) {
406 len
= read(fd
, &c
, 1);
407 if (len
== -1 && errno
== EINTR
) {
411 if (len
== -1 || len
== 0) {
412 fprintf(stderr
, "Broken pipe\n");
417 len
= write(2, &c
, 1);
419 json_message_parser_feed(&qmp
.parser
, &c
, 1);
421 json_message_parser_destroy(&qmp
.parser
);
426 QDict
*qtest_qmp_receive(QTestState
*s
)
428 return qmp_fd_receive(s
->qmp_fd
);
432 * Allow users to send a message without waiting for the reply,
433 * in the case that they choose to discard all replies up until
434 * a particular EVENT is received.
436 void qmp_fd_sendv(int fd
, const char *fmt
, va_list ap
)
441 /* Going through qobject ensures we escape strings properly.
442 * This seemingly unnecessary copy is required in case va_list
445 va_copy(ap_copy
, ap
);
446 qobj
= qobject_from_jsonv(fmt
, &ap_copy
, &error_abort
);
449 /* No need to send anything for an empty QObject. */
451 int log
= getenv("QTEST_LOG") != NULL
;
452 QString
*qstr
= qobject_to_json(qobj
);
456 * BUG: QMP doesn't react to input until it sees a newline, an
457 * object, or an array. Work-around: give it a newline.
459 qstring_append_chr(qstr
, '\n');
460 str
= qstring_get_str(qstr
);
463 fprintf(stderr
, "%s", str
);
465 /* Send QMP request */
466 socket_send(fd
, str
, qstring_get_length(qstr
));
469 qobject_decref(qobj
);
473 void qtest_async_qmpv(QTestState
*s
, const char *fmt
, va_list ap
)
475 qmp_fd_sendv(s
->qmp_fd
, fmt
, ap
);
478 QDict
*qmp_fdv(int fd
, const char *fmt
, va_list ap
)
480 qmp_fd_sendv(fd
, fmt
, ap
);
482 return qmp_fd_receive(fd
);
485 QDict
*qtest_qmpv(QTestState
*s
, const char *fmt
, va_list ap
)
487 qtest_async_qmpv(s
, fmt
, ap
);
490 return qtest_qmp_receive(s
);
493 QDict
*qmp_fd(int fd
, const char *fmt
, ...)
499 response
= qmp_fdv(fd
, fmt
, ap
);
504 void qmp_fd_send(int fd
, const char *fmt
, ...)
509 qmp_fd_sendv(fd
, fmt
, ap
);
513 QDict
*qtest_qmp(QTestState
*s
, const char *fmt
, ...)
519 response
= qtest_qmpv(s
, fmt
, ap
);
524 void qtest_async_qmp(QTestState
*s
, const char *fmt
, ...)
529 qtest_async_qmpv(s
, fmt
, ap
);
533 void qtest_qmpv_discard_response(QTestState
*s
, const char *fmt
, va_list ap
)
535 QDict
*response
= qtest_qmpv(s
, fmt
, ap
);
539 void qtest_qmp_discard_response(QTestState
*s
, const char *fmt
, ...)
545 response
= qtest_qmpv(s
, fmt
, ap
);
550 QDict
*qtest_qmp_eventwait_ref(QTestState
*s
, const char *event
)
555 response
= qtest_qmp_receive(s
);
556 if ((qdict_haskey(response
, "event")) &&
557 (strcmp(qdict_get_str(response
, "event"), event
) == 0)) {
564 void qtest_qmp_eventwait(QTestState
*s
, const char *event
)
568 response
= qtest_qmp_eventwait_ref(s
, event
);
572 char *qtest_hmpv(QTestState
*s
, const char *fmt
, va_list ap
)
578 cmd
= g_strdup_vprintf(fmt
, ap
);
579 resp
= qtest_qmp(s
, "{'execute': 'human-monitor-command',"
580 " 'arguments': {'command-line': %s}}",
582 ret
= g_strdup(qdict_get_try_str(resp
, "return"));
589 char *qtest_hmp(QTestState
*s
, const char *fmt
, ...)
595 ret
= qtest_hmpv(s
, fmt
, ap
);
600 const char *qtest_get_arch(void)
602 const char *qemu
= getenv("QTEST_QEMU_BINARY");
603 g_assert(qemu
!= NULL
);
604 const char *end
= strrchr(qemu
, '/');
606 return end
+ strlen("/qemu-system-");
609 bool qtest_get_irq(QTestState
*s
, int num
)
611 /* dummy operation in order to make sure irq is up to date */
614 return s
->irq_level
[num
];
617 static int64_t qtest_clock_rsp(QTestState
*s
)
621 words
= qtest_rsp(s
, 2);
622 clock
= g_ascii_strtoll(words
[1], NULL
, 0);
627 int64_t qtest_clock_step_next(QTestState
*s
)
629 qtest_sendf(s
, "clock_step\n");
630 return qtest_clock_rsp(s
);
633 int64_t qtest_clock_step(QTestState
*s
, int64_t step
)
635 qtest_sendf(s
, "clock_step %"PRIi64
"\n", step
);
636 return qtest_clock_rsp(s
);
639 int64_t qtest_clock_set(QTestState
*s
, int64_t val
)
641 qtest_sendf(s
, "clock_set %"PRIi64
"\n", val
);
642 return qtest_clock_rsp(s
);
645 void qtest_irq_intercept_out(QTestState
*s
, const char *qom_path
)
647 qtest_sendf(s
, "irq_intercept_out %s\n", qom_path
);
651 void qtest_irq_intercept_in(QTestState
*s
, const char *qom_path
)
653 qtest_sendf(s
, "irq_intercept_in %s\n", qom_path
);
657 static void qtest_out(QTestState
*s
, const char *cmd
, uint16_t addr
, uint32_t value
)
659 qtest_sendf(s
, "%s 0x%x 0x%x\n", cmd
, addr
, value
);
663 void qtest_outb(QTestState
*s
, uint16_t addr
, uint8_t value
)
665 qtest_out(s
, "outb", addr
, value
);
668 void qtest_outw(QTestState
*s
, uint16_t addr
, uint16_t value
)
670 qtest_out(s
, "outw", addr
, value
);
673 void qtest_outl(QTestState
*s
, uint16_t addr
, uint32_t value
)
675 qtest_out(s
, "outl", addr
, value
);
678 static uint32_t qtest_in(QTestState
*s
, const char *cmd
, uint16_t addr
)
683 qtest_sendf(s
, "%s 0x%x\n", cmd
, addr
);
684 args
= qtest_rsp(s
, 2);
685 value
= strtoul(args
[1], NULL
, 0);
691 uint8_t qtest_inb(QTestState
*s
, uint16_t addr
)
693 return qtest_in(s
, "inb", addr
);
696 uint16_t qtest_inw(QTestState
*s
, uint16_t addr
)
698 return qtest_in(s
, "inw", addr
);
701 uint32_t qtest_inl(QTestState
*s
, uint16_t addr
)
703 return qtest_in(s
, "inl", addr
);
706 static void qtest_write(QTestState
*s
, const char *cmd
, uint64_t addr
,
709 qtest_sendf(s
, "%s 0x%" PRIx64
" 0x%" PRIx64
"\n", cmd
, addr
, value
);
713 void qtest_writeb(QTestState
*s
, uint64_t addr
, uint8_t value
)
715 qtest_write(s
, "writeb", addr
, value
);
718 void qtest_writew(QTestState
*s
, uint64_t addr
, uint16_t value
)
720 qtest_write(s
, "writew", addr
, value
);
723 void qtest_writel(QTestState
*s
, uint64_t addr
, uint32_t value
)
725 qtest_write(s
, "writel", addr
, value
);
728 void qtest_writeq(QTestState
*s
, uint64_t addr
, uint64_t value
)
730 qtest_write(s
, "writeq", addr
, value
);
733 static uint64_t qtest_read(QTestState
*s
, const char *cmd
, uint64_t addr
)
738 qtest_sendf(s
, "%s 0x%" PRIx64
"\n", cmd
, addr
);
739 args
= qtest_rsp(s
, 2);
740 value
= strtoull(args
[1], NULL
, 0);
746 uint8_t qtest_readb(QTestState
*s
, uint64_t addr
)
748 return qtest_read(s
, "readb", addr
);
751 uint16_t qtest_readw(QTestState
*s
, uint64_t addr
)
753 return qtest_read(s
, "readw", addr
);
756 uint32_t qtest_readl(QTestState
*s
, uint64_t addr
)
758 return qtest_read(s
, "readl", addr
);
761 uint64_t qtest_readq(QTestState
*s
, uint64_t addr
)
763 return qtest_read(s
, "readq", addr
);
766 static int hex2nib(char ch
)
768 if (ch
>= '0' && ch
<= '9') {
770 } else if (ch
>= 'a' && ch
<= 'f') {
771 return 10 + (ch
- 'a');
772 } else if (ch
>= 'A' && ch
<= 'F') {
773 return 10 + (ch
- 'a');
779 void qtest_memread(QTestState
*s
, uint64_t addr
, void *data
, size_t size
)
789 qtest_sendf(s
, "read 0x%" PRIx64
" 0x%zx\n", addr
, size
);
790 args
= qtest_rsp(s
, 2);
792 for (i
= 0; i
< size
; i
++) {
793 ptr
[i
] = hex2nib(args
[1][2 + (i
* 2)]) << 4;
794 ptr
[i
] |= hex2nib(args
[1][2 + (i
* 2) + 1]);
800 uint64_t qtest_rtas_call(QTestState
*s
, const char *name
,
801 uint32_t nargs
, uint64_t args
,
802 uint32_t nret
, uint64_t ret
)
804 qtest_sendf(s
, "rtas %s %u 0x%"PRIx64
" %u 0x%"PRIx64
"\n",
805 name
, nargs
, args
, nret
, ret
);
810 void qtest_add_func(const char *str
, void (*fn
)(void))
812 gchar
*path
= g_strdup_printf("/%s/%s", qtest_get_arch(), str
);
813 g_test_add_func(path
, fn
);
817 void qtest_add_data_func_full(const char *str
, void *data
,
818 void (*fn
)(const void *),
819 GDestroyNotify data_free_func
)
821 gchar
*path
= g_strdup_printf("/%s/%s", qtest_get_arch(), str
);
822 g_test_add_data_func_full(path
, data
, fn
, data_free_func
);
826 void qtest_add_data_func(const char *str
, const void *data
,
827 void (*fn
)(const void *))
829 gchar
*path
= g_strdup_printf("/%s/%s", qtest_get_arch(), str
);
830 g_test_add_data_func(path
, data
, fn
);
834 void qtest_bufwrite(QTestState
*s
, uint64_t addr
, const void *data
, size_t size
)
838 bdata
= g_base64_encode(data
, size
);
839 qtest_sendf(s
, "b64write 0x%" PRIx64
" 0x%zx ", addr
, size
);
840 socket_send(s
->fd
, bdata
, strlen(bdata
));
841 socket_send(s
->fd
, "\n", 1);
846 void qtest_bufread(QTestState
*s
, uint64_t addr
, void *data
, size_t size
)
851 qtest_sendf(s
, "b64read 0x%" PRIx64
" 0x%zx\n", addr
, size
);
852 args
= qtest_rsp(s
, 2);
854 g_base64_decode_inplace(args
[1], &len
);
856 fprintf(stderr
, "bufread: asked for %zu bytes but decoded %zu\n",
858 len
= MIN(len
, size
);
861 memcpy(data
, args
[1], len
);
865 void qtest_memwrite(QTestState
*s
, uint64_t addr
, const void *data
, size_t size
)
867 const uint8_t *ptr
= data
;
875 enc
= g_malloc(2 * size
+ 1);
877 for (i
= 0; i
< size
; i
++) {
878 sprintf(&enc
[i
* 2], "%02x", ptr
[i
]);
881 qtest_sendf(s
, "write 0x%" PRIx64
" 0x%zx 0x%s\n", addr
, size
, enc
);
886 void qtest_memset(QTestState
*s
, uint64_t addr
, uint8_t pattern
, size_t size
)
888 qtest_sendf(s
, "memset 0x%" PRIx64
" 0x%zx 0x%02x\n", addr
, size
, pattern
);
892 QDict
*qmp(const char *fmt
, ...)
898 response
= qtest_qmpv(global_qtest
, fmt
, ap
);
903 void qmp_async(const char *fmt
, ...)
908 qtest_async_qmpv(global_qtest
, fmt
, ap
);
912 void qmp_discard_response(const char *fmt
, ...)
917 qtest_qmpv_discard_response(global_qtest
, fmt
, ap
);
920 char *hmp(const char *fmt
, ...)
926 ret
= qtest_hmpv(global_qtest
, fmt
, ap
);
931 bool qtest_big_endian(QTestState
*s
)
933 return s
->big_endian
;