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"
19 #include <sys/socket.h>
23 #include <sys/prctl.h>
24 #endif /* __linux__ */
28 #include "qemu/ctype.h"
29 #include "qemu/cutils.h"
30 #include "qapi/qmp/qdict.h"
31 #include "qapi/qmp/qjson.h"
32 #include "qapi/qmp/qlist.h"
33 #include "qapi/qmp/qstring.h"
36 #define SOCKET_TIMEOUT 50
38 typedef void (*QTestSendFn
)(QTestState
*s
, const char *buf
);
39 typedef void (*ExternalSendFn
)(void *s
, const char *buf
);
40 typedef GString
* (*QTestRecvFn
)(QTestState
*);
42 typedef struct QTestClientTransportOps
{
43 QTestSendFn send
; /* for sending qtest commands */
46 * use external_send to send qtest command strings through functions which
47 * do not accept a QTestState as the first parameter.
49 ExternalSendFn external_send
;
51 QTestRecvFn recv_line
; /* for receiving qtest command responses */
58 pid_t qemu_pid
; /* our child QEMU process */
62 bool irq_level
[MAX_IRQ
];
64 QTestTransportOps ops
;
65 GList
*pending_events
;
68 static GHookList abrt_hooks
;
69 static struct sigaction sigact_old
;
71 static int qtest_query_target_endianness(QTestState
*s
);
73 static void qtest_client_socket_send(QTestState
*, const char *buf
);
74 static void socket_send(int fd
, const char *buf
, size_t size
);
76 static GString
*qtest_client_socket_recv_line(QTestState
*);
78 static void qtest_client_set_tx_handler(QTestState
*s
, QTestSendFn send
);
79 static void qtest_client_set_rx_handler(QTestState
*s
, QTestRecvFn recv
);
81 static int init_socket(const char *socket_path
)
83 int sock
= qtest_socket_server(socket_path
);
84 qemu_set_cloexec(sock
);
88 static int socket_accept(int sock
)
90 struct sockaddr_un addr
;
93 struct timeval timeout
= { .tv_sec
= SOCKET_TIMEOUT
,
96 if (setsockopt(sock
, SOL_SOCKET
, SO_RCVTIMEO
,
97 (void *)&timeout
, sizeof(timeout
))) {
98 fprintf(stderr
, "%s failed to set SO_RCVTIMEO: %s\n",
99 __func__
, strerror(errno
));
105 addrlen
= sizeof(addr
);
106 ret
= accept(sock
, (struct sockaddr
*)&addr
, &addrlen
);
107 } while (ret
== -1 && errno
== EINTR
);
109 fprintf(stderr
, "%s failed: %s\n", __func__
, strerror(errno
));
116 bool qtest_probe_child(QTestState
*s
)
118 pid_t pid
= s
->qemu_pid
;
121 pid
= waitpid(pid
, &s
->wstatus
, WNOHANG
);
130 void qtest_set_expected_status(QTestState
*s
, int status
)
132 s
->expected_status
= status
;
135 void qtest_kill_qemu(QTestState
*s
)
137 pid_t pid
= s
->qemu_pid
;
140 /* Skip wait if qtest_probe_child already reaped. */
143 TFR(pid
= waitpid(s
->qemu_pid
, &s
->wstatus
, 0));
144 assert(pid
== s
->qemu_pid
);
149 * Check whether qemu exited with expected exit status; anything else is
150 * fishy and should be logged with as much detail as possible.
152 wstatus
= s
->wstatus
;
153 if (WIFEXITED(wstatus
) && WEXITSTATUS(wstatus
) != s
->expected_status
) {
154 fprintf(stderr
, "%s:%d: kill_qemu() tried to terminate QEMU "
155 "process but encountered exit status %d (expected %d)\n",
156 __FILE__
, __LINE__
, WEXITSTATUS(wstatus
), s
->expected_status
);
158 } else if (WIFSIGNALED(wstatus
)) {
159 int sig
= WTERMSIG(wstatus
);
160 const char *signame
= strsignal(sig
) ?: "unknown ???";
161 const char *dump
= WCOREDUMP(wstatus
) ? " (core dumped)" : "";
163 fprintf(stderr
, "%s:%d: kill_qemu() detected QEMU death "
164 "from signal %d (%s)%s\n",
165 __FILE__
, __LINE__
, sig
, signame
, dump
);
170 static void kill_qemu_hook_func(void *s
)
175 static void sigabrt_handler(int signo
)
177 g_hook_list_invoke(&abrt_hooks
, FALSE
);
180 static void setup_sigabrt_handler(void)
182 struct sigaction sigact
;
184 /* Catch SIGABRT to clean up on g_assert() failure */
185 sigact
= (struct sigaction
){
186 .sa_handler
= sigabrt_handler
,
187 .sa_flags
= SA_RESETHAND
,
189 sigemptyset(&sigact
.sa_mask
);
190 sigaction(SIGABRT
, &sigact
, &sigact_old
);
193 static void cleanup_sigabrt_handler(void)
195 sigaction(SIGABRT
, &sigact_old
, NULL
);
198 static bool hook_list_is_empty(GHookList
*hook_list
)
200 GHook
*hook
= g_hook_first_valid(hook_list
, TRUE
);
206 g_hook_unref(hook_list
, hook
);
210 void qtest_add_abrt_handler(GHookFunc fn
, const void *data
)
214 if (!abrt_hooks
.is_setup
) {
215 g_hook_list_init(&abrt_hooks
, sizeof(GHook
));
218 /* Only install SIGABRT handler once */
219 if (hook_list_is_empty(&abrt_hooks
)) {
220 setup_sigabrt_handler();
223 hook
= g_hook_alloc(&abrt_hooks
);
225 hook
->data
= (void *)data
;
227 g_hook_prepend(&abrt_hooks
, hook
);
230 void qtest_remove_abrt_handler(void *data
)
232 GHook
*hook
= g_hook_find_data(&abrt_hooks
, TRUE
, data
);
233 g_hook_destroy_link(&abrt_hooks
, hook
);
235 /* Uninstall SIGABRT handler on last instance */
236 if (hook_list_is_empty(&abrt_hooks
)) {
237 cleanup_sigabrt_handler();
241 static const char *qtest_qemu_binary(void)
243 const char *qemu_bin
;
245 qemu_bin
= getenv("QTEST_QEMU_BINARY");
247 fprintf(stderr
, "Environment variable QTEST_QEMU_BINARY required\n");
254 QTestState
*qtest_init_without_qmp_handshake(const char *extra_args
)
257 int sock
, qmpsock
, i
;
259 gchar
*qmp_socket_path
;
261 const char *qemu_binary
= qtest_qemu_binary();
262 const char *trace
= g_getenv("QTEST_TRACE");
263 g_autofree
char *tracearg
= trace
?
264 g_strdup_printf("-trace %s ", trace
) : g_strdup("");
266 s
= g_new(QTestState
, 1);
268 socket_path
= g_strdup_printf("/tmp/qtest-%d.sock", getpid());
269 qmp_socket_path
= g_strdup_printf("/tmp/qtest-%d.qmp", getpid());
271 /* It's possible that if an earlier test run crashed it might
272 * have left a stale unix socket lying around. Delete any
273 * stale old socket to avoid spurious test failures with
274 * tests/libqtest.c:70:init_socket: assertion failed (ret != -1): (-1 != -1)
277 unlink(qmp_socket_path
);
279 sock
= init_socket(socket_path
);
280 qmpsock
= init_socket(qmp_socket_path
);
282 qtest_client_set_rx_handler(s
, qtest_client_socket_recv_line
);
283 qtest_client_set_tx_handler(s
, qtest_client_socket_send
);
285 qtest_add_abrt_handler(kill_qemu_hook_func
, s
);
287 command
= g_strdup_printf("exec %s %s"
290 "-chardev socket,path=%s,id=char0 "
291 "-mon chardev=char0,mode=control "
295 qemu_binary
, tracearg
, socket_path
,
296 getenv("QTEST_LOG") ? "/dev/fd/2" : "/dev/null",
300 g_test_message("starting QEMU: %s", command
);
302 s
->pending_events
= NULL
;
304 s
->expected_status
= 0;
305 s
->qemu_pid
= fork();
306 if (s
->qemu_pid
== 0) {
309 * Although we register a ABRT handler to kill off QEMU
310 * when g_assert() triggers, we want an extra safety
311 * net. The QEMU process might be non-functional and
312 * thus not have responded to SIGTERM. The test script
313 * might also have crashed with SEGV, in which case the
314 * cleanup handlers won't ever run.
316 * This PR_SET_PDEATHSIG setup will ensure any remaining
317 * QEMU will get terminated with SIGKILL in these cases.
319 prctl(PR_SET_PDEATHSIG
, SIGKILL
, 0, 0, 0);
320 #endif /* __linux__ */
321 if (!g_setenv("QEMU_AUDIO_DRV", "none", true)) {
324 execlp("/bin/sh", "sh", "-c", command
, NULL
);
329 s
->fd
= socket_accept(sock
);
331 s
->qmp_fd
= socket_accept(qmpsock
);
334 unlink(qmp_socket_path
);
336 g_free(qmp_socket_path
);
338 g_assert(s
->fd
>= 0 && s
->qmp_fd
>= 0);
340 s
->rx
= g_string_new("");
341 for (i
= 0; i
< MAX_IRQ
; i
++) {
342 s
->irq_level
[i
] = false;
345 if (getenv("QTEST_STOP")) {
346 kill(s
->qemu_pid
, SIGSTOP
);
349 /* ask endianness of the target */
351 s
->big_endian
= qtest_query_target_endianness(s
);
356 QTestState
*qtest_init(const char *extra_args
)
358 QTestState
*s
= qtest_init_without_qmp_handshake(extra_args
);
361 /* Read the QMP greeting and then do the handshake */
362 greeting
= qtest_qmp_receive(s
);
363 qobject_unref(greeting
);
364 qobject_unref(qtest_qmp(s
, "{ 'execute': 'qmp_capabilities' }"));
369 QTestState
*qtest_vinitf(const char *fmt
, va_list ap
)
371 char *args
= g_strdup_vprintf(fmt
, ap
);
374 s
= qtest_init(args
);
379 QTestState
*qtest_initf(const char *fmt
, ...)
385 s
= qtest_vinitf(fmt
, ap
);
390 QTestState
*qtest_init_with_serial(const char *extra_args
, int *sock_fd
)
393 char *sock_path
, sock_dir
[] = "/tmp/qtest-serial-XXXXXX";
396 g_assert_true(mkdtemp(sock_dir
) != NULL
);
397 sock_path
= g_strdup_printf("%s/sock", sock_dir
);
399 sock_fd_init
= init_socket(sock_path
);
401 qts
= qtest_initf("-chardev socket,id=s0,path=%s -serial chardev:s0 %s",
402 sock_path
, extra_args
);
404 *sock_fd
= socket_accept(sock_fd_init
);
410 g_assert_true(*sock_fd
>= 0);
415 void qtest_quit(QTestState
*s
)
417 qtest_remove_abrt_handler(s
);
422 g_string_free(s
->rx
, true);
424 for (GList
*it
= s
->pending_events
; it
!= NULL
; it
= it
->next
) {
425 qobject_unref((QDict
*)it
->data
);
428 g_list_free(s
->pending_events
);
433 static void socket_send(int fd
, const char *buf
, size_t size
)
435 size_t res
= qemu_write_full(fd
, buf
, size
);
440 static void qtest_client_socket_send(QTestState
*s
, const char *buf
)
442 socket_send(s
->fd
, buf
, strlen(buf
));
445 static void G_GNUC_PRINTF(2, 3) qtest_sendf(QTestState
*s
, const char *fmt
, ...)
450 gchar
*str
= g_strdup_vprintf(fmt
, ap
);
457 static GString
*qtest_client_socket_recv_line(QTestState
*s
)
463 while ((eol
= strchr(s
->rx
->str
, '\n')) == NULL
) {
467 len
= read(s
->fd
, buffer
, sizeof(buffer
));
468 if (len
== -1 && errno
== EINTR
) {
472 if (len
== -1 || len
== 0) {
473 fprintf(stderr
, "Broken pipe\n");
477 g_string_append_len(s
->rx
, buffer
, len
);
480 offset
= eol
- s
->rx
->str
;
481 line
= g_string_new_len(s
->rx
->str
, offset
);
482 g_string_erase(s
->rx
, 0, offset
+ 1);
487 static gchar
**qtest_rsp_args(QTestState
*s
, int expected_args
)
494 line
= s
->ops
.recv_line(s
);
495 words
= g_strsplit(line
->str
, " ", 0);
496 g_string_free(line
, TRUE
);
498 if (strcmp(words
[0], "IRQ") == 0) {
502 g_assert(words
[1] != NULL
);
503 g_assert(words
[2] != NULL
);
505 ret
= qemu_strtol(words
[2], NULL
, 0, &irq
);
507 g_assert_cmpint(irq
, >=, 0);
508 g_assert_cmpint(irq
, <, MAX_IRQ
);
510 if (strcmp(words
[1], "raise") == 0) {
511 s
->irq_level
[irq
] = true;
513 s
->irq_level
[irq
] = false;
520 g_assert(words
[0] != NULL
);
521 g_assert_cmpstr(words
[0], ==, "OK");
523 for (i
= 0; i
< expected_args
; i
++) {
524 g_assert(words
[i
] != NULL
);
530 static void qtest_rsp(QTestState
*s
)
532 gchar
**words
= qtest_rsp_args(s
, 0);
537 static int qtest_query_target_endianness(QTestState
*s
)
542 qtest_sendf(s
, "endianness\n");
543 args
= qtest_rsp_args(s
, 1);
544 g_assert(strcmp(args
[1], "big") == 0 || strcmp(args
[1], "little") == 0);
545 big_endian
= strcmp(args
[1], "big") == 0;
551 QDict
*qtest_qmp_receive(QTestState
*s
)
554 QDict
*response
= qtest_qmp_receive_dict(s
);
556 if (!qdict_get_try_str(response
, "event")) {
559 /* Stash the event for a later consumption */
560 s
->pending_events
= g_list_append(s
->pending_events
, response
);
564 QDict
*qtest_qmp_receive_dict(QTestState
*s
)
566 return qmp_fd_receive(s
->qmp_fd
);
569 int qtest_socket_server(const char *socket_path
)
571 struct sockaddr_un addr
;
575 sock
= socket(PF_UNIX
, SOCK_STREAM
, 0);
576 g_assert_cmpint(sock
, !=, -1);
578 addr
.sun_family
= AF_UNIX
;
579 snprintf(addr
.sun_path
, sizeof(addr
.sun_path
), "%s", socket_path
);
582 ret
= bind(sock
, (struct sockaddr
*)&addr
, sizeof(addr
));
583 } while (ret
== -1 && errno
== EINTR
);
584 g_assert_cmpint(ret
, !=, -1);
585 ret
= listen(sock
, 1);
586 g_assert_cmpint(ret
, !=, -1);
591 void qtest_qmp_vsend_fds(QTestState
*s
, int *fds
, size_t fds_num
,
592 const char *fmt
, va_list ap
)
594 qmp_fd_vsend_fds(s
->qmp_fd
, fds
, fds_num
, fmt
, ap
);
597 void qtest_qmp_vsend(QTestState
*s
, const char *fmt
, va_list ap
)
599 qmp_fd_vsend_fds(s
->qmp_fd
, NULL
, 0, fmt
, ap
);
602 QDict
*qtest_vqmp_fds(QTestState
*s
, int *fds
, size_t fds_num
,
603 const char *fmt
, va_list ap
)
605 qtest_qmp_vsend_fds(s
, fds
, fds_num
, fmt
, ap
);
608 return qtest_qmp_receive(s
);
611 QDict
*qtest_vqmp(QTestState
*s
, const char *fmt
, va_list ap
)
613 qtest_qmp_vsend(s
, fmt
, ap
);
616 return qtest_qmp_receive(s
);
619 QDict
*qtest_qmp_fds(QTestState
*s
, int *fds
, size_t fds_num
,
620 const char *fmt
, ...)
626 response
= qtest_vqmp_fds(s
, fds
, fds_num
, fmt
, ap
);
631 QDict
*qtest_qmp(QTestState
*s
, const char *fmt
, ...)
637 response
= qtest_vqmp(s
, fmt
, ap
);
642 void qtest_qmp_send(QTestState
*s
, const char *fmt
, ...)
647 qtest_qmp_vsend(s
, fmt
, ap
);
651 void qtest_qmp_send_raw(QTestState
*s
, const char *fmt
, ...)
656 qmp_fd_vsend_raw(s
->qmp_fd
, fmt
, ap
);
660 QDict
*qtest_qmp_event_ref(QTestState
*s
, const char *event
)
662 while (s
->pending_events
) {
664 GList
*first
= s
->pending_events
;
665 QDict
*response
= (QDict
*)first
->data
;
667 s
->pending_events
= g_list_delete_link(s
->pending_events
, first
);
669 if (!strcmp(qdict_get_str(response
, "event"), event
)) {
672 qobject_unref(response
);
677 QDict
*qtest_qmp_eventwait_ref(QTestState
*s
, const char *event
)
679 QDict
*response
= qtest_qmp_event_ref(s
, event
);
686 response
= qtest_qmp_receive_dict(s
);
687 if ((qdict_haskey(response
, "event")) &&
688 (strcmp(qdict_get_str(response
, "event"), event
) == 0)) {
691 qobject_unref(response
);
695 void qtest_qmp_eventwait(QTestState
*s
, const char *event
)
699 response
= qtest_qmp_eventwait_ref(s
, event
);
700 qobject_unref(response
);
703 char *qtest_vhmp(QTestState
*s
, const char *fmt
, va_list ap
)
709 cmd
= g_strdup_vprintf(fmt
, ap
);
710 resp
= qtest_qmp(s
, "{'execute': 'human-monitor-command',"
711 " 'arguments': {'command-line': %s}}",
713 ret
= g_strdup(qdict_get_try_str(resp
, "return"));
720 char *qtest_hmp(QTestState
*s
, const char *fmt
, ...)
726 ret
= qtest_vhmp(s
, fmt
, ap
);
731 const char *qtest_get_arch(void)
733 const char *qemu
= qtest_qemu_binary();
734 const char *end
= strrchr(qemu
, '-');
737 fprintf(stderr
, "Can't determine architecture from binary name.\n");
741 if (!strstr(qemu
, "-system-")) {
742 fprintf(stderr
, "QTEST_QEMU_BINARY must end with *-system-<arch> "
743 "where 'arch' is the target\narchitecture (x86_64, aarch64, "
751 bool qtest_has_accel(const char *accel_name
)
753 if (g_str_equal(accel_name
, "tcg")) {
754 #if defined(CONFIG_TCG)
759 } else if (g_str_equal(accel_name
, "kvm")) {
761 const char *arch
= qtest_get_arch();
762 const char *targets
[] = { CONFIG_KVM_TARGETS
};
764 for (i
= 0; i
< ARRAY_SIZE(targets
); i
++) {
765 if (!strncmp(targets
[i
], arch
, strlen(arch
))) {
766 if (!access("/dev/kvm", R_OK
| W_OK
)) {
772 /* not implemented */
773 g_assert_not_reached();
778 bool qtest_get_irq(QTestState
*s
, int num
)
780 /* dummy operation in order to make sure irq is up to date */
783 return s
->irq_level
[num
];
786 void qtest_module_load(QTestState
*s
, const char *prefix
, const char *libname
)
788 qtest_sendf(s
, "module_load %s %s\n", prefix
, libname
);
792 static int64_t qtest_clock_rsp(QTestState
*s
)
796 words
= qtest_rsp_args(s
, 2);
797 clock
= g_ascii_strtoll(words
[1], NULL
, 0);
802 int64_t qtest_clock_step_next(QTestState
*s
)
804 qtest_sendf(s
, "clock_step\n");
805 return qtest_clock_rsp(s
);
808 int64_t qtest_clock_step(QTestState
*s
, int64_t step
)
810 qtest_sendf(s
, "clock_step %"PRIi64
"\n", step
);
811 return qtest_clock_rsp(s
);
814 int64_t qtest_clock_set(QTestState
*s
, int64_t val
)
816 qtest_sendf(s
, "clock_set %"PRIi64
"\n", val
);
817 return qtest_clock_rsp(s
);
820 void qtest_irq_intercept_out(QTestState
*s
, const char *qom_path
)
822 qtest_sendf(s
, "irq_intercept_out %s\n", qom_path
);
826 void qtest_irq_intercept_in(QTestState
*s
, const char *qom_path
)
828 qtest_sendf(s
, "irq_intercept_in %s\n", qom_path
);
832 void qtest_set_irq_in(QTestState
*s
, const char *qom_path
, const char *name
,
836 name
= "unnamed-gpio-in";
838 qtest_sendf(s
, "set_irq_in %s %s %d %d\n", qom_path
, name
, num
, level
);
842 static void qtest_out(QTestState
*s
, const char *cmd
, uint16_t addr
, uint32_t value
)
844 qtest_sendf(s
, "%s 0x%x 0x%x\n", cmd
, addr
, value
);
848 void qtest_outb(QTestState
*s
, uint16_t addr
, uint8_t value
)
850 qtest_out(s
, "outb", addr
, value
);
853 void qtest_outw(QTestState
*s
, uint16_t addr
, uint16_t value
)
855 qtest_out(s
, "outw", addr
, value
);
858 void qtest_outl(QTestState
*s
, uint16_t addr
, uint32_t value
)
860 qtest_out(s
, "outl", addr
, value
);
863 static uint32_t qtest_in(QTestState
*s
, const char *cmd
, uint16_t addr
)
869 qtest_sendf(s
, "%s 0x%x\n", cmd
, addr
);
870 args
= qtest_rsp_args(s
, 2);
871 ret
= qemu_strtoul(args
[1], NULL
, 0, &value
);
872 g_assert(!ret
&& value
<= UINT32_MAX
);
878 uint8_t qtest_inb(QTestState
*s
, uint16_t addr
)
880 return qtest_in(s
, "inb", addr
);
883 uint16_t qtest_inw(QTestState
*s
, uint16_t addr
)
885 return qtest_in(s
, "inw", addr
);
888 uint32_t qtest_inl(QTestState
*s
, uint16_t addr
)
890 return qtest_in(s
, "inl", addr
);
893 static void qtest_write(QTestState
*s
, const char *cmd
, uint64_t addr
,
896 qtest_sendf(s
, "%s 0x%" PRIx64
" 0x%" PRIx64
"\n", cmd
, addr
, value
);
900 void qtest_writeb(QTestState
*s
, uint64_t addr
, uint8_t value
)
902 qtest_write(s
, "writeb", addr
, value
);
905 void qtest_writew(QTestState
*s
, uint64_t addr
, uint16_t value
)
907 qtest_write(s
, "writew", addr
, value
);
910 void qtest_writel(QTestState
*s
, uint64_t addr
, uint32_t value
)
912 qtest_write(s
, "writel", addr
, value
);
915 void qtest_writeq(QTestState
*s
, uint64_t addr
, uint64_t value
)
917 qtest_write(s
, "writeq", addr
, value
);
920 static uint64_t qtest_read(QTestState
*s
, const char *cmd
, uint64_t addr
)
926 qtest_sendf(s
, "%s 0x%" PRIx64
"\n", cmd
, addr
);
927 args
= qtest_rsp_args(s
, 2);
928 ret
= qemu_strtou64(args
[1], NULL
, 0, &value
);
935 uint8_t qtest_readb(QTestState
*s
, uint64_t addr
)
937 return qtest_read(s
, "readb", addr
);
940 uint16_t qtest_readw(QTestState
*s
, uint64_t addr
)
942 return qtest_read(s
, "readw", addr
);
945 uint32_t qtest_readl(QTestState
*s
, uint64_t addr
)
947 return qtest_read(s
, "readl", addr
);
950 uint64_t qtest_readq(QTestState
*s
, uint64_t addr
)
952 return qtest_read(s
, "readq", addr
);
955 static int hex2nib(char ch
)
957 if (ch
>= '0' && ch
<= '9') {
959 } else if (ch
>= 'a' && ch
<= 'f') {
960 return 10 + (ch
- 'a');
961 } else if (ch
>= 'A' && ch
<= 'F') {
962 return 10 + (ch
- 'a');
968 void qtest_memread(QTestState
*s
, uint64_t addr
, void *data
, size_t size
)
978 qtest_sendf(s
, "read 0x%" PRIx64
" 0x%zx\n", addr
, size
);
979 args
= qtest_rsp_args(s
, 2);
981 for (i
= 0; i
< size
; i
++) {
982 ptr
[i
] = hex2nib(args
[1][2 + (i
* 2)]) << 4;
983 ptr
[i
] |= hex2nib(args
[1][2 + (i
* 2) + 1]);
989 uint64_t qtest_rtas_call(QTestState
*s
, const char *name
,
990 uint32_t nargs
, uint64_t args
,
991 uint32_t nret
, uint64_t ret
)
993 qtest_sendf(s
, "rtas %s %u 0x%"PRIx64
" %u 0x%"PRIx64
"\n",
994 name
, nargs
, args
, nret
, ret
);
999 void qtest_add_func(const char *str
, void (*fn
)(void))
1001 gchar
*path
= g_strdup_printf("/%s/%s", qtest_get_arch(), str
);
1002 g_test_add_func(path
, fn
);
1006 void qtest_add_data_func_full(const char *str
, void *data
,
1007 void (*fn
)(const void *),
1008 GDestroyNotify data_free_func
)
1010 gchar
*path
= g_strdup_printf("/%s/%s", qtest_get_arch(), str
);
1011 g_test_add_data_func_full(path
, data
, fn
, data_free_func
);
1015 void qtest_add_data_func(const char *str
, const void *data
,
1016 void (*fn
)(const void *))
1018 gchar
*path
= g_strdup_printf("/%s/%s", qtest_get_arch(), str
);
1019 g_test_add_data_func(path
, data
, fn
);
1023 void qtest_bufwrite(QTestState
*s
, uint64_t addr
, const void *data
, size_t size
)
1027 bdata
= g_base64_encode(data
, size
);
1028 qtest_sendf(s
, "b64write 0x%" PRIx64
" 0x%zx ", addr
, size
);
1029 s
->ops
.send(s
, bdata
);
1030 s
->ops
.send(s
, "\n");
1035 void qtest_bufread(QTestState
*s
, uint64_t addr
, void *data
, size_t size
)
1040 qtest_sendf(s
, "b64read 0x%" PRIx64
" 0x%zx\n", addr
, size
);
1041 args
= qtest_rsp_args(s
, 2);
1043 g_base64_decode_inplace(args
[1], &len
);
1045 fprintf(stderr
, "bufread: asked for %zu bytes but decoded %zu\n",
1047 len
= MIN(len
, size
);
1050 memcpy(data
, args
[1], len
);
1054 void qtest_memwrite(QTestState
*s
, uint64_t addr
, const void *data
, size_t size
)
1056 const uint8_t *ptr
= data
;
1064 enc
= g_malloc(2 * size
+ 1);
1066 for (i
= 0; i
< size
; i
++) {
1067 sprintf(&enc
[i
* 2], "%02x", ptr
[i
]);
1070 qtest_sendf(s
, "write 0x%" PRIx64
" 0x%zx 0x%s\n", addr
, size
, enc
);
1075 void qtest_memset(QTestState
*s
, uint64_t addr
, uint8_t pattern
, size_t size
)
1077 qtest_sendf(s
, "memset 0x%" PRIx64
" 0x%zx 0x%02x\n", addr
, size
, pattern
);
1081 void qtest_qmp_assert_success(QTestState
*qts
, const char *fmt
, ...)
1087 response
= qtest_vqmp(qts
, fmt
, ap
);
1091 if (!qdict_haskey(response
, "return")) {
1092 GString
*s
= qobject_to_json_pretty(QOBJECT(response
), true);
1093 g_test_message("%s", s
->str
);
1094 g_string_free(s
, true);
1096 g_assert(qdict_haskey(response
, "return"));
1097 qobject_unref(response
);
1100 bool qtest_big_endian(QTestState
*s
)
1102 return s
->big_endian
;
1105 static bool qtest_check_machine_version(const char *mname
, const char *basename
,
1106 int major
, int minor
)
1111 newname
= g_strdup_printf("%s-%i.%i", basename
, major
, minor
);
1112 is_equal
= g_str_equal(mname
, newname
);
1118 static bool qtest_is_old_versioned_machine(const char *mname
)
1120 const char *dash
= strrchr(mname
, '-');
1121 const char *dot
= strrchr(mname
, '.');
1124 const int major
= QEMU_VERSION_MAJOR
;
1125 const int minor
= QEMU_VERSION_MINOR
;
1128 if (dash
&& dot
&& dot
> dash
) {
1129 for (chr
= dash
+ 1; *chr
; chr
++) {
1130 if (!qemu_isdigit(*chr
) && *chr
!= '.') {
1135 * Now check if it is one of the latest versions. Check major + 1
1136 * and minor + 1 versions as well, since they might already exist
1137 * in the development branch.
1139 bname
= g_strdup(mname
);
1140 bname
[dash
- mname
] = 0;
1141 res
= !qtest_check_machine_version(mname
, bname
, major
+ 1, 0) &&
1142 !qtest_check_machine_version(mname
, bname
, major
, minor
+ 1) &&
1143 !qtest_check_machine_version(mname
, bname
, major
, minor
);
1156 * Returns an array with pointers to the available machine names.
1157 * The terminating entry has the name set to NULL.
1159 static struct MachInfo
*qtest_get_machines(void)
1161 static struct MachInfo
*machines
;
1162 QDict
*response
, *minfo
;
1164 const QListEntry
*p
;
1174 qts
= qtest_init("-machine none");
1175 response
= qtest_qmp(qts
, "{ 'execute': 'query-machines' }");
1177 list
= qdict_get_qlist(response
, "return");
1180 machines
= g_new(struct MachInfo
, qlist_size(list
) + 1);
1182 for (p
= qlist_first(list
), idx
= 0; p
; p
= qlist_next(p
), idx
++) {
1183 minfo
= qobject_to(QDict
, qlist_entry_obj(p
));
1186 qobj
= qdict_get(minfo
, "name");
1188 qstr
= qobject_to(QString
, qobj
);
1190 machines
[idx
].name
= g_strdup(qstring_get_str(qstr
));
1192 qobj
= qdict_get(minfo
, "alias");
1193 if (qobj
) { /* The alias is optional */
1194 qstr
= qobject_to(QString
, qobj
);
1196 machines
[idx
].alias
= g_strdup(qstring_get_str(qstr
));
1198 machines
[idx
].alias
= NULL
;
1203 qobject_unref(response
);
1205 memset(&machines
[idx
], 0, sizeof(struct MachInfo
)); /* Terminating entry */
1209 void qtest_cb_for_every_machine(void (*cb
)(const char *machine
),
1210 bool skip_old_versioned
)
1212 struct MachInfo
*machines
;
1215 machines
= qtest_get_machines();
1217 for (i
= 0; machines
[i
].name
!= NULL
; i
++) {
1218 /* Ignore machines that cannot be used for qtests */
1219 if (!strncmp("xenfv", machines
[i
].name
, 5) ||
1220 g_str_equal("xenpv", machines
[i
].name
)) {
1223 if (!skip_old_versioned
||
1224 !qtest_is_old_versioned_machine(machines
[i
].name
)) {
1225 cb(machines
[i
].name
);
1230 bool qtest_has_machine(const char *machine
)
1232 struct MachInfo
*machines
;
1235 machines
= qtest_get_machines();
1237 for (i
= 0; machines
[i
].name
!= NULL
; i
++) {
1238 if (g_str_equal(machine
, machines
[i
].name
) ||
1239 (machines
[i
].alias
&& g_str_equal(machine
, machines
[i
].alias
))) {
1247 bool qtest_has_device(const char *device
)
1250 const QListEntry
*p
;
1259 QTestState
*qts
= qtest_init("-machine none");
1262 qdict_put_bool(args
, "abstract", false);
1263 qdict_put_str(args
, "implements", "device");
1265 resp
= qtest_qmp(qts
, "{'execute': 'qom-list-types', 'arguments': %p }",
1267 g_assert(qdict_haskey(resp
, "return"));
1268 list
= qdict_get_qlist(resp
, "return");
1270 qobject_unref(resp
);
1275 for (p
= qlist_first(list
), idx
= 0; p
; p
= qlist_next(p
), idx
++) {
1276 devinfo
= qobject_to(QDict
, qlist_entry_obj(p
));
1279 qobj
= qdict_get(devinfo
, "name");
1281 qstr
= qobject_to(QString
, qobj
);
1283 if (g_str_equal(qstring_get_str(qstr
), device
)) {
1292 * Generic hot-plugging test via the device_add QMP commands.
1294 void qtest_qmp_device_add_qdict(QTestState
*qts
, const char *drv
,
1295 const QDict
*arguments
)
1298 QDict
*args
= arguments
? qdict_clone_shallow(arguments
) : qdict_new();
1300 g_assert(!qdict_haskey(args
, "driver"));
1301 qdict_put_str(args
, "driver", drv
);
1302 resp
= qtest_qmp(qts
, "{'execute': 'device_add', 'arguments': %p}", args
);
1304 g_assert(!qdict_haskey(resp
, "event")); /* We don't expect any events */
1305 g_assert(!qdict_haskey(resp
, "error"));
1306 qobject_unref(resp
);
1309 void qtest_qmp_device_add(QTestState
*qts
, const char *driver
, const char *id
,
1310 const char *fmt
, ...)
1316 args
= qdict_from_vjsonf_nofail(fmt
, ap
);
1319 g_assert(!qdict_haskey(args
, "id"));
1320 qdict_put_str(args
, "id", id
);
1322 qtest_qmp_device_add_qdict(qts
, driver
, args
);
1323 qobject_unref(args
);
1326 void qtest_qmp_add_client(QTestState
*qts
, const char *protocol
, int fd
)
1330 resp
= qtest_qmp_fds(qts
, &fd
, 1, "{'execute': 'getfd',"
1331 "'arguments': {'fdname': 'fdname'}}");
1333 g_assert(!qdict_haskey(resp
, "event")); /* We don't expect any events */
1334 g_assert(!qdict_haskey(resp
, "error"));
1335 qobject_unref(resp
);
1338 qts
, "{'execute': 'add_client',"
1339 "'arguments': {'protocol': %s, 'fdname': 'fdname'}}", protocol
);
1341 g_assert(!qdict_haskey(resp
, "event")); /* We don't expect any events */
1342 g_assert(!qdict_haskey(resp
, "error"));
1343 qobject_unref(resp
);
1347 * Generic hot-unplugging test via the device_del QMP command.
1348 * Device deletion will get one response and one event. For example:
1350 * {'execute': 'device_del','arguments': { 'id': 'scsi-hd'}}
1352 * will get this one:
1354 * {"timestamp": {"seconds": 1505289667, "microseconds": 569862},
1355 * "event": "DEVICE_DELETED", "data": {"device": "scsi-hd",
1356 * "path": "/machine/peripheral/scsi-hd"}}
1362 void qtest_qmp_device_del(QTestState
*qts
, const char *id
)
1366 rsp
= qtest_qmp(qts
, "{'execute': 'device_del', 'arguments': {'id': %s}}",
1369 g_assert(qdict_haskey(rsp
, "return"));
1371 qtest_qmp_eventwait(qts
, "DEVICE_DELETED");
1374 static void qtest_client_set_tx_handler(QTestState
*s
,
1379 static void qtest_client_set_rx_handler(QTestState
*s
, QTestRecvFn recv
)
1381 s
->ops
.recv_line
= recv
;
1383 /* A type-safe wrapper for s->send() */
1384 static void send_wrapper(QTestState
*s
, const char *buf
)
1386 s
->ops
.external_send(s
, buf
);
1389 static GString
*qtest_client_inproc_recv_line(QTestState
*s
)
1395 eol
= strchr(s
->rx
->str
, '\n');
1396 offset
= eol
- s
->rx
->str
;
1397 line
= g_string_new_len(s
->rx
->str
, offset
);
1398 g_string_erase(s
->rx
, 0, offset
+ 1);
1402 QTestState
*qtest_inproc_init(QTestState
**s
, bool log
, const char* arch
,
1403 void (*send
)(void*, const char*))
1406 qts
= g_new0(QTestState
, 1);
1407 qts
->pending_events
= NULL
;
1408 *s
= qts
; /* Expose qts early on, since the query endianness relies on it */
1410 for (int i
= 0; i
< MAX_IRQ
; i
++) {
1411 qts
->irq_level
[i
] = false;
1414 qtest_client_set_rx_handler(qts
, qtest_client_inproc_recv_line
);
1416 /* send() may not have a matching protoype, so use a type-safe wrapper */
1417 qts
->ops
.external_send
= send
;
1418 qtest_client_set_tx_handler(qts
, send_wrapper
);
1420 qts
->big_endian
= qtest_query_target_endianness(qts
);
1423 * Set a dummy path for QTEST_QEMU_BINARY. Doesn't need to exist, but this
1424 * way, qtest_get_arch works for inproc qtest.
1426 gchar
*bin_path
= g_strconcat("/qemu-system-", arch
, NULL
);
1427 setenv("QTEST_QEMU_BINARY", bin_path
, 0);
1433 void qtest_client_inproc_recv(void *opaque
, const char *str
)
1435 QTestState
*qts
= *(QTestState
**)opaque
;
1438 qts
->rx
= g_string_new(NULL
);
1440 g_string_append(qts
->rx
, str
);
1444 void qtest_qom_set_bool(QTestState
*s
, const char *path
, const char *property
,
1449 r
= qtest_qmp(s
, "{ 'execute': 'qom-set', 'arguments': "
1450 "{ 'path': %s, 'property': %s, 'value': %i } }",
1451 path
, property
, value
);
1455 bool qtest_qom_get_bool(QTestState
*s
, const char *path
, const char *property
)
1460 r
= qtest_qmp(s
, "{ 'execute': 'qom-get', 'arguments': "
1461 "{ 'path': %s, 'property': %s } }", path
, property
);
1462 b
= qdict_get_bool(r
, "return");