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>
25 #include <sys/prctl.h>
26 #endif /* __linux__ */
28 #include <sys/procctl.h>
29 #endif /* __FreeBSD__ */
33 #include "qemu/ctype.h"
34 #include "qemu/cutils.h"
35 #include "qemu/sockets.h"
36 #include "qapi/qmp/qdict.h"
37 #include "qapi/qmp/qjson.h"
38 #include "qapi/qmp/qlist.h"
39 #include "qapi/qmp/qstring.h"
44 # define SOCKET_TIMEOUT 50
45 # define CMD_EXEC "exec "
46 # define DEV_STDERR "/dev/fd/2"
47 # define DEV_NULL "/dev/null"
49 # define SOCKET_TIMEOUT 50000
51 # define DEV_STDERR "2"
52 # define DEV_NULL "nul"
55 #define WAITPID_TIMEOUT 30
57 typedef void (*QTestSendFn
)(QTestState
*s
, const char *buf
);
58 typedef void (*ExternalSendFn
)(void *s
, const char *buf
);
59 typedef GString
* (*QTestRecvFn
)(QTestState
*);
61 typedef struct QTestClientTransportOps
{
62 QTestSendFn send
; /* for sending qtest commands */
65 * use external_send to send qtest command strings through functions which
66 * do not accept a QTestState as the first parameter.
68 ExternalSendFn external_send
;
70 QTestRecvFn recv_line
; /* for receiving qtest command responses */
77 pid_t qemu_pid
; /* our child QEMU process */
84 bool irq_level
[MAX_IRQ
];
86 QTestTransportOps ops
;
87 GList
*pending_events
;
88 QTestQMPEventCallback eventCB
;
92 static GHookList abrt_hooks
;
93 static void (*sighandler_old
)(int);
95 static int qtest_query_target_endianness(QTestState
*s
);
97 static void qtest_client_socket_send(QTestState
*, const char *buf
);
98 static void socket_send(int fd
, const char *buf
, size_t size
);
100 static GString
*qtest_client_socket_recv_line(QTestState
*);
102 static void qtest_client_set_tx_handler(QTestState
*s
, QTestSendFn send
);
103 static void qtest_client_set_rx_handler(QTestState
*s
, QTestRecvFn recv
);
105 static int init_socket(const char *socket_path
)
107 int sock
= qtest_socket_server(socket_path
);
108 qemu_set_cloexec(sock
);
112 static int socket_accept(int sock
)
114 struct sockaddr_un addr
;
118 * timeout unit of blocking receive calls is different among platforms.
119 * It's in seconds on non-Windows platforms but milliseconds on Windows.
122 struct timeval timeout
= { .tv_sec
= SOCKET_TIMEOUT
,
125 DWORD timeout
= SOCKET_TIMEOUT
;
128 if (setsockopt(sock
, SOL_SOCKET
, SO_RCVTIMEO
,
129 (void *)&timeout
, sizeof(timeout
))) {
130 fprintf(stderr
, "%s failed to set SO_RCVTIMEO: %s\n",
131 __func__
, strerror(errno
));
137 addrlen
= sizeof(addr
);
138 ret
= accept(sock
, (struct sockaddr
*)&addr
, &addrlen
);
139 } while (ret
== -1 && errno
== EINTR
);
141 fprintf(stderr
, "%s failed: %s\n", __func__
, strerror(errno
));
148 pid_t
qtest_pid(QTestState
*s
)
153 bool qtest_probe_child(QTestState
*s
)
155 pid_t pid
= s
->qemu_pid
;
159 pid
= waitpid(pid
, &s
->wstatus
, WNOHANG
);
164 GetExitCodeProcess((HANDLE
)pid
, &s
->exit_code
);
165 if (s
->exit_code
== STILL_ACTIVE
) {
168 CloseHandle((HANDLE
)pid
);
171 qtest_remove_abrt_handler(s
);
176 void qtest_set_expected_status(QTestState
*s
, int status
)
178 s
->expected_status
= status
;
181 static void qtest_check_status(QTestState
*s
)
183 assert(s
->qemu_pid
== -1);
186 * Check whether qemu exited with expected exit status; anything else is
187 * fishy and should be logged with as much detail as possible.
190 int wstatus
= s
->wstatus
;
191 if (WIFEXITED(wstatus
) && WEXITSTATUS(wstatus
) != s
->expected_status
) {
192 fprintf(stderr
, "%s:%d: kill_qemu() tried to terminate QEMU "
193 "process but encountered exit status %d (expected %d)\n",
194 __FILE__
, __LINE__
, WEXITSTATUS(wstatus
), s
->expected_status
);
196 } else if (WIFSIGNALED(wstatus
)) {
197 int sig
= WTERMSIG(wstatus
);
198 const char *signame
= strsignal(sig
) ?: "unknown ???";
199 const char *dump
= WCOREDUMP(wstatus
) ? " (core dumped)" : "";
201 fprintf(stderr
, "%s:%d: kill_qemu() detected QEMU death "
202 "from signal %d (%s)%s\n",
203 __FILE__
, __LINE__
, sig
, signame
, dump
);
207 if (s
->exit_code
!= s
->expected_status
) {
208 fprintf(stderr
, "%s:%d: kill_qemu() tried to terminate QEMU "
209 "process but encountered exit status %ld (expected %d)\n",
210 __FILE__
, __LINE__
, s
->exit_code
, s
->expected_status
);
216 void qtest_wait_qemu(QTestState
*s
)
218 if (s
->qemu_pid
!= -1) {
223 /* poll for a while until sending SIGKILL */
224 end
= g_get_monotonic_time() + WAITPID_TIMEOUT
* G_TIME_SPAN_SECOND
;
227 pid
= waitpid(s
->qemu_pid
, &s
->wstatus
, WNOHANG
);
231 g_usleep(100 * 1000);
232 } while (g_get_monotonic_time() < end
);
235 kill(s
->qemu_pid
, SIGKILL
);
236 pid
= RETRY_ON_EINTR(waitpid(s
->qemu_pid
, &s
->wstatus
, 0));
239 assert(pid
== s
->qemu_pid
);
243 ret
= WaitForSingleObject((HANDLE
)s
->qemu_pid
, INFINITE
);
244 assert(ret
== WAIT_OBJECT_0
);
245 GetExitCodeProcess((HANDLE
)s
->qemu_pid
, &s
->exit_code
);
246 CloseHandle((HANDLE
)s
->qemu_pid
);
250 qtest_remove_abrt_handler(s
);
252 qtest_check_status(s
);
255 void qtest_kill_qemu(QTestState
*s
)
257 /* Skip wait if qtest_probe_child() already reaped */
258 if (s
->qemu_pid
!= -1) {
260 kill(s
->qemu_pid
, SIGTERM
);
262 TerminateProcess((HANDLE
)s
->qemu_pid
, s
->expected_status
);
268 qtest_check_status(s
);
271 static void kill_qemu_hook_func(void *s
)
276 static void sigabrt_handler(int signo
)
278 g_hook_list_invoke(&abrt_hooks
, FALSE
);
281 static void setup_sigabrt_handler(void)
283 sighandler_old
= signal(SIGABRT
, sigabrt_handler
);
286 static void cleanup_sigabrt_handler(void)
288 signal(SIGABRT
, sighandler_old
);
291 static bool hook_list_is_empty(GHookList
*hook_list
)
293 GHook
*hook
= g_hook_first_valid(hook_list
, TRUE
);
299 g_hook_unref(hook_list
, hook
);
303 void qtest_add_abrt_handler(GHookFunc fn
, const void *data
)
307 if (!abrt_hooks
.is_setup
) {
308 g_hook_list_init(&abrt_hooks
, sizeof(GHook
));
311 /* Only install SIGABRT handler once */
312 if (hook_list_is_empty(&abrt_hooks
)) {
313 setup_sigabrt_handler();
316 hook
= g_hook_alloc(&abrt_hooks
);
318 hook
->data
= (void *)data
;
320 g_hook_prepend(&abrt_hooks
, hook
);
323 void qtest_remove_abrt_handler(void *data
)
325 GHook
*hook
= g_hook_find_data(&abrt_hooks
, TRUE
, data
);
331 g_hook_destroy_link(&abrt_hooks
, hook
);
333 /* Uninstall SIGABRT handler on last instance */
334 if (hook_list_is_empty(&abrt_hooks
)) {
335 cleanup_sigabrt_handler();
339 static const char *qtest_qemu_binary(void)
341 const char *qemu_bin
;
343 qemu_bin
= getenv("QTEST_QEMU_BINARY");
345 fprintf(stderr
, "Environment variable QTEST_QEMU_BINARY required\n");
353 static pid_t
qtest_create_process(char *cmd
)
356 PROCESS_INFORMATION pi
;
359 ZeroMemory(&si
, sizeof(si
));
361 ZeroMemory(&pi
, sizeof(pi
));
363 ret
= CreateProcess(NULL
, /* module name */
364 cmd
, /* command line */
365 NULL
, /* process handle not inheritable */
366 NULL
, /* thread handle not inheritable */
367 FALSE
, /* set handle inheritance to FALSE */
368 0, /* No creation flags */
369 NULL
, /* use parent's environment block */
370 NULL
, /* use parent's starting directory */
371 &si
, /* pointer to STARTUPINFO structure */
372 &pi
/* pointer to PROCESS_INFORMATION structure */
375 fprintf(stderr
, "%s:%d: unable to create a new process (%s)\n",
376 __FILE__
, __LINE__
, strerror(GetLastError()));
380 return (pid_t
)pi
.hProcess
;
384 static QTestState
*G_GNUC_PRINTF(1, 2) qtest_spawn_qemu(const char *fmt
, ...)
387 QTestState
*s
= g_new0(QTestState
, 1);
388 const char *trace
= g_getenv("QTEST_TRACE");
389 g_autofree
char *tracearg
= trace
?
390 g_strdup_printf("-trace %s ", trace
) : g_strdup("");
391 g_autoptr(GString
) command
= g_string_new("");
394 g_string_append_printf(command
, CMD_EXEC
"%s %s",
395 qtest_qemu_binary(), tracearg
);
396 g_string_append_vprintf(command
, fmt
, ap
);
399 qtest_add_abrt_handler(kill_qemu_hook_func
, s
);
401 g_test_message("starting QEMU: %s", command
->str
);
404 s
->qemu_pid
= fork();
405 if (s
->qemu_pid
== 0) {
408 * Although we register a ABRT handler to kill off QEMU
409 * when g_assert() triggers, we want an extra safety
410 * net. The QEMU process might be non-functional and
411 * thus not have responded to SIGTERM. The test script
412 * might also have crashed with SEGV, in which case the
413 * cleanup handlers won't ever run.
415 * This PR_SET_PDEATHSIG setup will ensure any remaining
416 * QEMU will get terminated with SIGKILL in these cases.
418 prctl(PR_SET_PDEATHSIG
, SIGKILL
, 0, 0, 0);
419 #endif /* __linux__ */
422 procctl(P_PID
, getpid(), PROC_PDEATHSIG_CTL
, &sig
);
423 #endif /* __FreeBSD__ */
424 if (!g_setenv("QEMU_AUDIO_DRV", "none", true)) {
427 execlp("/bin/sh", "sh", "-c", command
->str
, NULL
);
431 s
->qemu_pid
= qtest_create_process(command
->str
);
437 QTestState
*qtest_init_without_qmp_handshake(const char *extra_args
)
440 int sock
, qmpsock
, i
;
442 gchar
*qmp_socket_path
;
444 socket_path
= g_strdup_printf("%s/qtest-%d.sock",
445 g_get_tmp_dir(), getpid());
446 qmp_socket_path
= g_strdup_printf("%s/qtest-%d.qmp",
447 g_get_tmp_dir(), getpid());
450 * It's possible that if an earlier test run crashed it might
451 * have left a stale unix socket lying around. Delete any
452 * stale old socket to avoid spurious test failures with
453 * tests/libqtest.c:70:init_socket: assertion failed (ret != -1): (-1 != -1)
456 unlink(qmp_socket_path
);
459 sock
= init_socket(socket_path
);
460 qmpsock
= init_socket(qmp_socket_path
);
462 s
= qtest_spawn_qemu("-qtest unix:%s "
464 "-chardev socket,path=%s,id=char0 "
465 "-mon chardev=char0,mode=control "
470 getenv("QTEST_LOG") ? DEV_STDERR
: DEV_NULL
,
474 qtest_client_set_rx_handler(s
, qtest_client_socket_recv_line
);
475 qtest_client_set_tx_handler(s
, qtest_client_socket_send
);
477 s
->fd
= socket_accept(sock
);
479 s
->qmp_fd
= socket_accept(qmpsock
);
482 unlink(qmp_socket_path
);
484 g_free(qmp_socket_path
);
486 g_assert(s
->fd
>= 0 && s
->qmp_fd
>= 0);
488 s
->rx
= g_string_new("");
489 for (i
= 0; i
< MAX_IRQ
; i
++) {
490 s
->irq_level
[i
] = false;
494 * Stopping QEMU for debugging is not supported on Windows.
496 * Using DebugActiveProcess() API can suspend the QEMU process,
497 * but gdb cannot attach to the process. Using the undocumented
498 * NtSuspendProcess() can suspend the QEMU process and gdb can
499 * attach to the process, but gdb cannot resume it.
502 if (getenv("QTEST_STOP")) {
503 kill(s
->qemu_pid
, SIGSTOP
);
507 /* ask endianness of the target */
509 s
->big_endian
= qtest_query_target_endianness(s
);
514 QTestState
*qtest_init(const char *extra_args
)
516 QTestState
*s
= qtest_init_without_qmp_handshake(extra_args
);
519 /* Read the QMP greeting and then do the handshake */
520 greeting
= qtest_qmp_receive(s
);
521 qobject_unref(greeting
);
522 qobject_unref(qtest_qmp(s
, "{ 'execute': 'qmp_capabilities' }"));
527 QTestState
*qtest_vinitf(const char *fmt
, va_list ap
)
529 char *args
= g_strdup_vprintf(fmt
, ap
);
532 s
= qtest_init(args
);
537 QTestState
*qtest_initf(const char *fmt
, ...)
543 s
= qtest_vinitf(fmt
, ap
);
548 QTestState
*qtest_init_with_serial(const char *extra_args
, int *sock_fd
)
551 g_autofree
char *sock_dir
= NULL
;
555 sock_dir
= g_dir_make_tmp("qtest-serial-XXXXXX", NULL
);
556 g_assert_true(sock_dir
!= NULL
);
557 sock_path
= g_strdup_printf("%s/sock", sock_dir
);
560 sock_fd_init
= init_socket(sock_path
);
562 qts
= qtest_initf("-chardev socket,id=s0,path=%s -serial chardev:s0 %s",
563 sock_path
, extra_args
);
565 *sock_fd
= socket_accept(sock_fd_init
);
571 g_assert_true(*sock_fd
>= 0);
576 void qtest_quit(QTestState
*s
)
578 qtest_remove_abrt_handler(s
);
583 g_string_free(s
->rx
, true);
585 for (GList
*it
= s
->pending_events
; it
!= NULL
; it
= it
->next
) {
586 qobject_unref((QDict
*)it
->data
);
589 g_list_free(s
->pending_events
);
594 static void socket_send(int fd
, const char *buf
, size_t size
)
596 ssize_t res
= qemu_send_full(fd
, buf
, size
);
601 static void qtest_client_socket_send(QTestState
*s
, const char *buf
)
603 socket_send(s
->fd
, buf
, strlen(buf
));
606 static void G_GNUC_PRINTF(2, 3) qtest_sendf(QTestState
*s
, const char *fmt
, ...)
611 gchar
*str
= g_strdup_vprintf(fmt
, ap
);
618 static GString
*qtest_client_socket_recv_line(QTestState
*s
)
624 while ((eol
= strchr(s
->rx
->str
, '\n')) == NULL
) {
628 len
= recv(s
->fd
, buffer
, sizeof(buffer
), 0);
629 if (len
== -1 && errno
== EINTR
) {
633 if (len
== -1 || len
== 0) {
634 fprintf(stderr
, "Broken pipe\n");
638 g_string_append_len(s
->rx
, buffer
, len
);
641 offset
= eol
- s
->rx
->str
;
642 line
= g_string_new_len(s
->rx
->str
, offset
);
643 g_string_erase(s
->rx
, 0, offset
+ 1);
648 static gchar
**qtest_rsp_args(QTestState
*s
, int expected_args
)
655 line
= s
->ops
.recv_line(s
);
656 words
= g_strsplit(line
->str
, " ", 0);
657 g_string_free(line
, TRUE
);
659 if (strcmp(words
[0], "IRQ") == 0) {
663 g_assert(words
[1] != NULL
);
664 g_assert(words
[2] != NULL
);
666 ret
= qemu_strtol(words
[2], NULL
, 0, &irq
);
668 g_assert_cmpint(irq
, >=, 0);
669 g_assert_cmpint(irq
, <, MAX_IRQ
);
671 if (strcmp(words
[1], "raise") == 0) {
672 s
->irq_level
[irq
] = true;
674 s
->irq_level
[irq
] = false;
681 g_assert(words
[0] != NULL
);
682 g_assert_cmpstr(words
[0], ==, "OK");
684 for (i
= 0; i
< expected_args
; i
++) {
685 g_assert(words
[i
] != NULL
);
691 static void qtest_rsp(QTestState
*s
)
693 gchar
**words
= qtest_rsp_args(s
, 0);
698 static int qtest_query_target_endianness(QTestState
*s
)
703 qtest_sendf(s
, "endianness\n");
704 args
= qtest_rsp_args(s
, 1);
705 g_assert(strcmp(args
[1], "big") == 0 || strcmp(args
[1], "little") == 0);
706 big_endian
= strcmp(args
[1], "big") == 0;
712 QDict
*qtest_qmp_receive(QTestState
*s
)
715 QDict
*response
= qtest_qmp_receive_dict(s
);
717 if (!qdict_get_try_str(response
, "event")) {
722 !s
->eventCB(s
, qdict_get_str(response
, "event"),
723 response
, s
->eventData
)) {
724 /* Stash the event for a later consumption */
725 s
->pending_events
= g_list_append(s
->pending_events
, response
);
730 QDict
*qtest_qmp_receive_dict(QTestState
*s
)
732 return qmp_fd_receive(s
->qmp_fd
);
735 int qtest_socket_server(const char *socket_path
)
737 struct sockaddr_un addr
;
741 sock
= socket(PF_UNIX
, SOCK_STREAM
, 0);
742 g_assert_cmpint(sock
, !=, -1);
744 addr
.sun_family
= AF_UNIX
;
745 snprintf(addr
.sun_path
, sizeof(addr
.sun_path
), "%s", socket_path
);
747 ret
= RETRY_ON_EINTR(bind(sock
, (struct sockaddr
*)&addr
, sizeof(addr
)));
748 g_assert_cmpint(ret
, !=, -1);
749 ret
= listen(sock
, 1);
750 g_assert_cmpint(ret
, !=, -1);
756 void qtest_qmp_vsend_fds(QTestState
*s
, int *fds
, size_t fds_num
,
757 const char *fmt
, va_list ap
)
759 qmp_fd_vsend_fds(s
->qmp_fd
, fds
, fds_num
, fmt
, ap
);
763 void qtest_qmp_vsend(QTestState
*s
, const char *fmt
, va_list ap
)
765 qmp_fd_vsend(s
->qmp_fd
, fmt
, ap
);
769 QDict
*qtest_vqmp_fds(QTestState
*s
, int *fds
, size_t fds_num
,
770 const char *fmt
, va_list ap
)
772 qtest_qmp_vsend_fds(s
, fds
, fds_num
, fmt
, ap
);
775 return qtest_qmp_receive(s
);
779 QDict
*qtest_vqmp(QTestState
*s
, const char *fmt
, va_list ap
)
781 qtest_qmp_vsend(s
, fmt
, ap
);
784 return qtest_qmp_receive(s
);
788 QDict
*qtest_qmp_fds(QTestState
*s
, int *fds
, size_t fds_num
,
789 const char *fmt
, ...)
795 response
= qtest_vqmp_fds(s
, fds
, fds_num
, fmt
, ap
);
801 QDict
*qtest_qmp(QTestState
*s
, const char *fmt
, ...)
807 response
= qtest_vqmp(s
, fmt
, ap
);
812 void qtest_qmp_send(QTestState
*s
, const char *fmt
, ...)
817 qtest_qmp_vsend(s
, fmt
, ap
);
821 void qtest_qmp_send_raw(QTestState
*s
, const char *fmt
, ...)
826 qmp_fd_vsend_raw(s
->qmp_fd
, fmt
, ap
);
830 void qtest_qmp_set_event_callback(QTestState
*s
,
831 QTestQMPEventCallback cb
, void *opaque
)
834 s
->eventData
= opaque
;
837 QDict
*qtest_qmp_event_ref(QTestState
*s
, const char *event
)
839 while (s
->pending_events
) {
841 GList
*first
= s
->pending_events
;
842 QDict
*response
= (QDict
*)first
->data
;
844 s
->pending_events
= g_list_delete_link(s
->pending_events
, first
);
846 if (!strcmp(qdict_get_str(response
, "event"), event
)) {
849 qobject_unref(response
);
854 QDict
*qtest_qmp_eventwait_ref(QTestState
*s
, const char *event
)
856 QDict
*response
= qtest_qmp_event_ref(s
, event
);
863 response
= qtest_qmp_receive_dict(s
);
864 if ((qdict_haskey(response
, "event")) &&
865 (strcmp(qdict_get_str(response
, "event"), event
) == 0)) {
868 qobject_unref(response
);
872 void qtest_qmp_eventwait(QTestState
*s
, const char *event
)
876 response
= qtest_qmp_eventwait_ref(s
, event
);
877 qobject_unref(response
);
880 char *qtest_vhmp(QTestState
*s
, const char *fmt
, va_list ap
)
886 cmd
= g_strdup_vprintf(fmt
, ap
);
887 resp
= qtest_qmp(s
, "{'execute': 'human-monitor-command',"
888 " 'arguments': {'command-line': %s}}",
890 ret
= g_strdup(qdict_get_try_str(resp
, "return"));
897 char *qtest_hmp(QTestState
*s
, const char *fmt
, ...)
903 ret
= qtest_vhmp(s
, fmt
, ap
);
908 const char *qtest_get_arch(void)
910 const char *qemu
= qtest_qemu_binary();
911 const char *end
= strrchr(qemu
, '-');
914 fprintf(stderr
, "Can't determine architecture from binary name.\n");
918 if (!strstr(qemu
, "-system-")) {
919 fprintf(stderr
, "QTEST_QEMU_BINARY must end with *-system-<arch> "
920 "where 'arch' is the target\narchitecture (x86_64, aarch64, "
928 bool qtest_has_accel(const char *accel_name
)
930 if (g_str_equal(accel_name
, "tcg")) {
931 #if defined(CONFIG_TCG)
936 } else if (g_str_equal(accel_name
, "kvm")) {
938 const char *arch
= qtest_get_arch();
939 const char *targets
[] = { CONFIG_KVM_TARGETS
};
941 for (i
= 0; i
< ARRAY_SIZE(targets
); i
++) {
942 if (!strncmp(targets
[i
], arch
, strlen(arch
))) {
943 if (!access("/dev/kvm", R_OK
| W_OK
)) {
949 /* not implemented */
950 g_assert_not_reached();
955 bool qtest_get_irq(QTestState
*s
, int num
)
957 /* dummy operation in order to make sure irq is up to date */
960 return s
->irq_level
[num
];
963 void qtest_module_load(QTestState
*s
, const char *prefix
, const char *libname
)
965 qtest_sendf(s
, "module_load %s %s\n", prefix
, libname
);
969 static int64_t qtest_clock_rsp(QTestState
*s
)
973 words
= qtest_rsp_args(s
, 2);
974 clock
= g_ascii_strtoll(words
[1], NULL
, 0);
979 int64_t qtest_clock_step_next(QTestState
*s
)
981 qtest_sendf(s
, "clock_step\n");
982 return qtest_clock_rsp(s
);
985 int64_t qtest_clock_step(QTestState
*s
, int64_t step
)
987 qtest_sendf(s
, "clock_step %"PRIi64
"\n", step
);
988 return qtest_clock_rsp(s
);
991 int64_t qtest_clock_set(QTestState
*s
, int64_t val
)
993 qtest_sendf(s
, "clock_set %"PRIi64
"\n", val
);
994 return qtest_clock_rsp(s
);
997 void qtest_irq_intercept_out(QTestState
*s
, const char *qom_path
)
999 qtest_sendf(s
, "irq_intercept_out %s\n", qom_path
);
1003 void qtest_irq_intercept_out_named(QTestState
*s
, const char *qom_path
, const char *name
)
1005 qtest_sendf(s
, "irq_intercept_out %s %s\n", qom_path
, name
);
1009 void qtest_irq_intercept_in(QTestState
*s
, const char *qom_path
)
1011 qtest_sendf(s
, "irq_intercept_in %s\n", qom_path
);
1015 void qtest_set_irq_in(QTestState
*s
, const char *qom_path
, const char *name
,
1019 name
= "unnamed-gpio-in";
1021 qtest_sendf(s
, "set_irq_in %s %s %d %d\n", qom_path
, name
, num
, level
);
1025 static void qtest_out(QTestState
*s
, const char *cmd
, uint16_t addr
, uint32_t value
)
1027 qtest_sendf(s
, "%s 0x%x 0x%x\n", cmd
, addr
, value
);
1031 void qtest_outb(QTestState
*s
, uint16_t addr
, uint8_t value
)
1033 qtest_out(s
, "outb", addr
, value
);
1036 void qtest_outw(QTestState
*s
, uint16_t addr
, uint16_t value
)
1038 qtest_out(s
, "outw", addr
, value
);
1041 void qtest_outl(QTestState
*s
, uint16_t addr
, uint32_t value
)
1043 qtest_out(s
, "outl", addr
, value
);
1046 static uint32_t qtest_in(QTestState
*s
, const char *cmd
, uint16_t addr
)
1050 unsigned long value
;
1052 qtest_sendf(s
, "%s 0x%x\n", cmd
, addr
);
1053 args
= qtest_rsp_args(s
, 2);
1054 ret
= qemu_strtoul(args
[1], NULL
, 0, &value
);
1055 g_assert(!ret
&& value
<= UINT32_MAX
);
1061 uint8_t qtest_inb(QTestState
*s
, uint16_t addr
)
1063 return qtest_in(s
, "inb", addr
);
1066 uint16_t qtest_inw(QTestState
*s
, uint16_t addr
)
1068 return qtest_in(s
, "inw", addr
);
1071 uint32_t qtest_inl(QTestState
*s
, uint16_t addr
)
1073 return qtest_in(s
, "inl", addr
);
1076 static void qtest_write(QTestState
*s
, const char *cmd
, uint64_t addr
,
1079 qtest_sendf(s
, "%s 0x%" PRIx64
" 0x%" PRIx64
"\n", cmd
, addr
, value
);
1083 void qtest_writeb(QTestState
*s
, uint64_t addr
, uint8_t value
)
1085 qtest_write(s
, "writeb", addr
, value
);
1088 void qtest_writew(QTestState
*s
, uint64_t addr
, uint16_t value
)
1090 qtest_write(s
, "writew", addr
, value
);
1093 void qtest_writel(QTestState
*s
, uint64_t addr
, uint32_t value
)
1095 qtest_write(s
, "writel", addr
, value
);
1098 void qtest_writeq(QTestState
*s
, uint64_t addr
, uint64_t value
)
1100 qtest_write(s
, "writeq", addr
, value
);
1103 static uint64_t qtest_read(QTestState
*s
, const char *cmd
, uint64_t addr
)
1109 qtest_sendf(s
, "%s 0x%" PRIx64
"\n", cmd
, addr
);
1110 args
= qtest_rsp_args(s
, 2);
1111 ret
= qemu_strtou64(args
[1], NULL
, 0, &value
);
1118 uint8_t qtest_readb(QTestState
*s
, uint64_t addr
)
1120 return qtest_read(s
, "readb", addr
);
1123 uint16_t qtest_readw(QTestState
*s
, uint64_t addr
)
1125 return qtest_read(s
, "readw", addr
);
1128 uint32_t qtest_readl(QTestState
*s
, uint64_t addr
)
1130 return qtest_read(s
, "readl", addr
);
1133 uint64_t qtest_readq(QTestState
*s
, uint64_t addr
)
1135 return qtest_read(s
, "readq", addr
);
1138 static int hex2nib(char ch
)
1140 if (ch
>= '0' && ch
<= '9') {
1142 } else if (ch
>= 'a' && ch
<= 'f') {
1143 return 10 + (ch
- 'a');
1144 } else if (ch
>= 'A' && ch
<= 'F') {
1145 return 10 + (ch
- 'a');
1151 void qtest_memread(QTestState
*s
, uint64_t addr
, void *data
, size_t size
)
1153 uint8_t *ptr
= data
;
1161 qtest_sendf(s
, "read 0x%" PRIx64
" 0x%zx\n", addr
, size
);
1162 args
= qtest_rsp_args(s
, 2);
1164 for (i
= 0; i
< size
; i
++) {
1165 ptr
[i
] = hex2nib(args
[1][2 + (i
* 2)]) << 4;
1166 ptr
[i
] |= hex2nib(args
[1][2 + (i
* 2) + 1]);
1172 uint64_t qtest_rtas_call(QTestState
*s
, const char *name
,
1173 uint32_t nargs
, uint64_t args
,
1174 uint32_t nret
, uint64_t ret
)
1176 qtest_sendf(s
, "rtas %s %u 0x%"PRIx64
" %u 0x%"PRIx64
"\n",
1177 name
, nargs
, args
, nret
, ret
);
1182 void qtest_add_func(const char *str
, void (*fn
)(void))
1184 gchar
*path
= g_strdup_printf("/%s/%s", qtest_get_arch(), str
);
1185 g_test_add_func(path
, fn
);
1189 void qtest_add_data_func_full(const char *str
, void *data
,
1190 void (*fn
)(const void *),
1191 GDestroyNotify data_free_func
)
1193 gchar
*path
= g_strdup_printf("/%s/%s", qtest_get_arch(), str
);
1194 g_test_add_data_func_full(path
, data
, fn
, data_free_func
);
1198 void qtest_add_data_func(const char *str
, const void *data
,
1199 void (*fn
)(const void *))
1201 gchar
*path
= g_strdup_printf("/%s/%s", qtest_get_arch(), str
);
1202 g_test_add_data_func(path
, data
, fn
);
1206 void qtest_bufwrite(QTestState
*s
, uint64_t addr
, const void *data
, size_t size
)
1210 bdata
= g_base64_encode(data
, size
);
1211 qtest_sendf(s
, "b64write 0x%" PRIx64
" 0x%zx ", addr
, size
);
1212 s
->ops
.send(s
, bdata
);
1213 s
->ops
.send(s
, "\n");
1218 void qtest_bufread(QTestState
*s
, uint64_t addr
, void *data
, size_t size
)
1223 qtest_sendf(s
, "b64read 0x%" PRIx64
" 0x%zx\n", addr
, size
);
1224 args
= qtest_rsp_args(s
, 2);
1226 g_base64_decode_inplace(args
[1], &len
);
1228 fprintf(stderr
, "bufread: asked for %zu bytes but decoded %zu\n",
1230 len
= MIN(len
, size
);
1233 memcpy(data
, args
[1], len
);
1237 void qtest_memwrite(QTestState
*s
, uint64_t addr
, const void *data
, size_t size
)
1239 const uint8_t *ptr
= data
;
1247 enc
= g_malloc(2 * size
+ 1);
1249 for (i
= 0; i
< size
; i
++) {
1250 sprintf(&enc
[i
* 2], "%02x", ptr
[i
]);
1253 qtest_sendf(s
, "write 0x%" PRIx64
" 0x%zx 0x%s\n", addr
, size
, enc
);
1258 void qtest_memset(QTestState
*s
, uint64_t addr
, uint8_t pattern
, size_t size
)
1260 qtest_sendf(s
, "memset 0x%" PRIx64
" 0x%zx 0x%02x\n", addr
, size
, pattern
);
1264 QDict
*qtest_vqmp_assert_success_ref(QTestState
*qts
,
1265 const char *fmt
, va_list args
)
1270 response
= qtest_vqmp(qts
, fmt
, args
);
1273 if (!qdict_haskey(response
, "return")) {
1274 g_autoptr(GString
) s
= qobject_to_json_pretty(QOBJECT(response
), true);
1275 g_test_message("%s", s
->str
);
1277 g_assert(qdict_haskey(response
, "return"));
1278 ret
= qdict_get_qdict(response
, "return");
1280 qobject_unref(response
);
1285 void qtest_vqmp_assert_success(QTestState
*qts
,
1286 const char *fmt
, va_list args
)
1290 response
= qtest_vqmp_assert_success_ref(qts
, fmt
, args
);
1292 qobject_unref(response
);
1296 QDict
*qtest_vqmp_fds_assert_success_ref(QTestState
*qts
, int *fds
, size_t nfds
,
1297 const char *fmt
, va_list args
)
1302 response
= qtest_vqmp_fds(qts
, fds
, nfds
, fmt
, args
);
1305 if (!qdict_haskey(response
, "return")) {
1306 g_autoptr(GString
) s
= qobject_to_json_pretty(QOBJECT(response
), true);
1307 g_test_message("%s", s
->str
);
1309 g_assert(qdict_haskey(response
, "return"));
1310 ret
= qdict_get_qdict(response
, "return");
1312 qobject_unref(response
);
1317 void qtest_vqmp_fds_assert_success(QTestState
*qts
, int *fds
, size_t nfds
,
1318 const char *fmt
, va_list args
)
1321 response
= qtest_vqmp_fds_assert_success_ref(qts
, fds
, nfds
, fmt
, args
);
1322 qobject_unref(response
);
1324 #endif /* !_WIN32 */
1326 QDict
*qtest_qmp_assert_success_ref(QTestState
*qts
, const char *fmt
, ...)
1331 response
= qtest_vqmp_assert_success_ref(qts
, fmt
, ap
);
1336 void qtest_qmp_assert_success(QTestState
*qts
, const char *fmt
, ...)
1340 qtest_vqmp_assert_success(qts
, fmt
, ap
);
1345 QDict
*qtest_qmp_fds_assert_success_ref(QTestState
*qts
, int *fds
, size_t nfds
,
1346 const char *fmt
, ...)
1351 response
= qtest_vqmp_fds_assert_success_ref(qts
, fds
, nfds
, fmt
, ap
);
1356 void qtest_qmp_fds_assert_success(QTestState
*qts
, int *fds
, size_t nfds
,
1357 const char *fmt
, ...)
1361 qtest_vqmp_fds_assert_success(qts
, fds
, nfds
, fmt
, ap
);
1364 #endif /* !_WIN32 */
1366 bool qtest_big_endian(QTestState
*s
)
1368 return s
->big_endian
;
1371 static bool qtest_check_machine_version(const char *mname
, const char *basename
,
1372 int major
, int minor
)
1377 newname
= g_strdup_printf("%s-%i.%i", basename
, major
, minor
);
1378 is_equal
= g_str_equal(mname
, newname
);
1384 static bool qtest_is_old_versioned_machine(const char *mname
)
1386 const char *dash
= strrchr(mname
, '-');
1387 const char *dot
= strrchr(mname
, '.');
1390 const int major
= QEMU_VERSION_MAJOR
;
1391 const int minor
= QEMU_VERSION_MINOR
;
1394 if (dash
&& dot
&& dot
> dash
) {
1395 for (chr
= dash
+ 1; *chr
; chr
++) {
1396 if (!qemu_isdigit(*chr
) && *chr
!= '.') {
1401 * Now check if it is one of the latest versions. Check major + 1
1402 * and minor + 1 versions as well, since they might already exist
1403 * in the development branch.
1405 bname
= g_strdup(mname
);
1406 bname
[dash
- mname
] = 0;
1407 res
= !qtest_check_machine_version(mname
, bname
, major
+ 1, 0) &&
1408 !qtest_check_machine_version(mname
, bname
, major
, minor
+ 1) &&
1409 !qtest_check_machine_version(mname
, bname
, major
, minor
);
1422 * Returns an array with pointers to the available machine names.
1423 * The terminating entry has the name set to NULL.
1425 static struct MachInfo
*qtest_get_machines(void)
1427 static struct MachInfo
*machines
;
1428 QDict
*response
, *minfo
;
1430 const QListEntry
*p
;
1440 qts
= qtest_init("-machine none");
1441 response
= qtest_qmp(qts
, "{ 'execute': 'query-machines' }");
1443 list
= qdict_get_qlist(response
, "return");
1446 machines
= g_new(struct MachInfo
, qlist_size(list
) + 1);
1448 for (p
= qlist_first(list
), idx
= 0; p
; p
= qlist_next(p
), idx
++) {
1449 minfo
= qobject_to(QDict
, qlist_entry_obj(p
));
1452 qobj
= qdict_get(minfo
, "name");
1454 qstr
= qobject_to(QString
, qobj
);
1456 machines
[idx
].name
= g_strdup(qstring_get_str(qstr
));
1458 qobj
= qdict_get(minfo
, "alias");
1459 if (qobj
) { /* The alias is optional */
1460 qstr
= qobject_to(QString
, qobj
);
1462 machines
[idx
].alias
= g_strdup(qstring_get_str(qstr
));
1464 machines
[idx
].alias
= NULL
;
1469 qobject_unref(response
);
1471 memset(&machines
[idx
], 0, sizeof(struct MachInfo
)); /* Terminating entry */
1475 void qtest_cb_for_every_machine(void (*cb
)(const char *machine
),
1476 bool skip_old_versioned
)
1478 struct MachInfo
*machines
;
1481 machines
= qtest_get_machines();
1483 for (i
= 0; machines
[i
].name
!= NULL
; i
++) {
1484 /* Ignore machines that cannot be used for qtests */
1485 if (!strncmp("xenfv", machines
[i
].name
, 5) ||
1486 g_str_equal("xenpv", machines
[i
].name
) ||
1487 g_str_equal("xenpvh", machines
[i
].name
)) {
1490 if (!skip_old_versioned
||
1491 !qtest_is_old_versioned_machine(machines
[i
].name
)) {
1492 cb(machines
[i
].name
);
1497 bool qtest_has_machine(const char *machine
)
1499 struct MachInfo
*machines
;
1502 machines
= qtest_get_machines();
1504 for (i
= 0; machines
[i
].name
!= NULL
; i
++) {
1505 if (g_str_equal(machine
, machines
[i
].name
) ||
1506 (machines
[i
].alias
&& g_str_equal(machine
, machines
[i
].alias
))) {
1514 bool qtest_has_device(const char *device
)
1517 const QListEntry
*p
;
1526 QTestState
*qts
= qtest_init("-machine none");
1529 qdict_put_bool(args
, "abstract", false);
1530 qdict_put_str(args
, "implements", "device");
1532 resp
= qtest_qmp(qts
, "{'execute': 'qom-list-types', 'arguments': %p }",
1534 g_assert(qdict_haskey(resp
, "return"));
1535 list
= qdict_get_qlist(resp
, "return");
1537 qobject_unref(resp
);
1542 for (p
= qlist_first(list
), idx
= 0; p
; p
= qlist_next(p
), idx
++) {
1543 devinfo
= qobject_to(QDict
, qlist_entry_obj(p
));
1546 qobj
= qdict_get(devinfo
, "name");
1548 qstr
= qobject_to(QString
, qobj
);
1550 if (g_str_equal(qstring_get_str(qstr
), device
)) {
1559 * Generic hot-plugging test via the device_add QMP commands.
1561 void qtest_qmp_device_add_qdict(QTestState
*qts
, const char *drv
,
1562 const QDict
*arguments
)
1565 QDict
*args
= arguments
? qdict_clone_shallow(arguments
) : qdict_new();
1567 g_assert(!qdict_haskey(args
, "driver"));
1568 qdict_put_str(args
, "driver", drv
);
1569 resp
= qtest_qmp(qts
, "{'execute': 'device_add', 'arguments': %p}", args
);
1571 g_assert(!qdict_haskey(resp
, "event")); /* We don't expect any events */
1572 if (qdict_haskey(resp
, "error")) {
1573 fprintf(stderr
, "error: %s\n",
1574 qdict_get_str(qdict_get_qdict(resp
, "error"), "desc"));
1576 g_assert(!qdict_haskey(resp
, "error"));
1577 qobject_unref(resp
);
1580 void qtest_qmp_device_add(QTestState
*qts
, const char *driver
, const char *id
,
1581 const char *fmt
, ...)
1587 args
= qdict_from_vjsonf_nofail(fmt
, ap
);
1590 g_assert(!qdict_haskey(args
, "id"));
1591 qdict_put_str(args
, "id", id
);
1593 qtest_qmp_device_add_qdict(qts
, driver
, args
);
1594 qobject_unref(args
);
1597 void qtest_qmp_add_client(QTestState
*qts
, const char *protocol
, int fd
)
1602 WSAPROTOCOL_INFOW info
;
1603 g_autofree
char *info64
= NULL
;
1606 assert(fd_is_socket(fd
));
1607 s
= _get_osfhandle(fd
);
1608 if (WSADuplicateSocketW(s
, GetProcessId((HANDLE
)qts
->qemu_pid
), &info
) == SOCKET_ERROR
) {
1609 g_autofree
char *emsg
= g_win32_error_message(WSAGetLastError());
1610 g_error("WSADuplicateSocketW failed: %s", emsg
);
1612 info64
= g_base64_encode((guchar
*)&info
, sizeof(info
));
1613 resp
= qtest_qmp(qts
, "{'execute': 'get-win32-socket',"
1614 "'arguments': {'fdname': 'fdname', 'info': %s}}", info64
);
1616 resp
= qtest_qmp_fds(qts
, &fd
, 1, "{'execute': 'getfd',"
1617 "'arguments': {'fdname': 'fdname'}}");
1620 g_assert(!qdict_haskey(resp
, "event")); /* We don't expect any events */
1621 g_assert(!qdict_haskey(resp
, "error"));
1622 qobject_unref(resp
);
1625 qts
, "{'execute': 'add_client',"
1626 "'arguments': {'protocol': %s, 'fdname': 'fdname'}}", protocol
);
1628 g_assert(!qdict_haskey(resp
, "event")); /* We don't expect any events */
1629 g_assert(!qdict_haskey(resp
, "error"));
1630 qobject_unref(resp
);
1634 * Generic hot-unplugging test via the device_del QMP command.
1635 * Device deletion will get one response and one event. For example:
1637 * {'execute': 'device_del','arguments': { 'id': 'scsi-hd'}}
1639 * will get this one:
1641 * {"timestamp": {"seconds": 1505289667, "microseconds": 569862},
1642 * "event": "DEVICE_DELETED", "data": {"device": "scsi-hd",
1643 * "path": "/machine/peripheral/scsi-hd"}}
1649 void qtest_qmp_device_del_send(QTestState
*qts
, const char *id
)
1651 QDict
*rsp
= qtest_qmp(qts
, "{'execute': 'device_del', "
1652 "'arguments': {'id': %s}}", id
);
1654 g_assert(qdict_haskey(rsp
, "return"));
1655 g_assert(!qdict_haskey(rsp
, "error"));
1659 void qtest_qmp_device_del(QTestState
*qts
, const char *id
)
1661 qtest_qmp_device_del_send(qts
, id
);
1662 qtest_qmp_eventwait(qts
, "DEVICE_DELETED");
1665 static void qtest_client_set_tx_handler(QTestState
*s
,
1670 static void qtest_client_set_rx_handler(QTestState
*s
, QTestRecvFn recv
)
1672 s
->ops
.recv_line
= recv
;
1674 /* A type-safe wrapper for s->send() */
1675 static void send_wrapper(QTestState
*s
, const char *buf
)
1677 s
->ops
.external_send(s
, buf
);
1680 static GString
*qtest_client_inproc_recv_line(QTestState
*s
)
1686 eol
= strchr(s
->rx
->str
, '\n');
1687 offset
= eol
- s
->rx
->str
;
1688 line
= g_string_new_len(s
->rx
->str
, offset
);
1689 g_string_erase(s
->rx
, 0, offset
+ 1);
1693 QTestState
*qtest_inproc_init(QTestState
**s
, bool log
, const char* arch
,
1694 void (*send
)(void*, const char*))
1697 qts
= g_new0(QTestState
, 1);
1698 qts
->pending_events
= NULL
;
1699 *s
= qts
; /* Expose qts early on, since the query endianness relies on it */
1701 for (int i
= 0; i
< MAX_IRQ
; i
++) {
1702 qts
->irq_level
[i
] = false;
1705 qtest_client_set_rx_handler(qts
, qtest_client_inproc_recv_line
);
1707 /* send() may not have a matching prototype, so use a type-safe wrapper */
1708 qts
->ops
.external_send
= send
;
1709 qtest_client_set_tx_handler(qts
, send_wrapper
);
1711 qts
->big_endian
= qtest_query_target_endianness(qts
);
1714 * Set a dummy path for QTEST_QEMU_BINARY. Doesn't need to exist, but this
1715 * way, qtest_get_arch works for inproc qtest.
1717 gchar
*bin_path
= g_strconcat("/qemu-system-", arch
, NULL
);
1718 g_setenv("QTEST_QEMU_BINARY", bin_path
, 0);
1724 void qtest_client_inproc_recv(void *opaque
, const char *str
)
1726 QTestState
*qts
= *(QTestState
**)opaque
;
1729 qts
->rx
= g_string_new(NULL
);
1731 g_string_append(qts
->rx
, str
);
1735 void qtest_qom_set_bool(QTestState
*s
, const char *path
, const char *property
,
1740 r
= qtest_qmp(s
, "{ 'execute': 'qom-set', 'arguments': "
1741 "{ 'path': %s, 'property': %s, 'value': %i } }",
1742 path
, property
, value
);
1746 bool qtest_qom_get_bool(QTestState
*s
, const char *path
, const char *property
)
1751 r
= qtest_qmp(s
, "{ 'execute': 'qom-get', 'arguments': "
1752 "{ 'path': %s, 'property': %s } }", path
, property
);
1753 b
= qdict_get_bool(r
, "return");
1759 bool have_qemu_img(void)
1762 const char *path
= getenv("QTEST_QEMU_IMG");
1767 rpath
= realpath(path
, NULL
);
1776 bool mkimg(const char *file
, const char *fmt
, unsigned size_mb
)
1782 char *qemu_img_path
;
1784 char *qemu_img_abs_path
;
1786 qemu_img_path
= getenv("QTEST_QEMU_IMG");
1787 if (!qemu_img_path
) {
1790 qemu_img_abs_path
= realpath(qemu_img_path
, NULL
);
1791 if (!qemu_img_abs_path
) {
1795 cli
= g_strdup_printf("%s create -f %s %s %uM", qemu_img_abs_path
,
1796 fmt
, file
, size_mb
);
1797 ret
= g_spawn_command_line_sync(cli
, &out
, &out2
, &rc
, &err
);
1798 if (err
|| !g_spawn_check_exit_status(rc
, &err
)) {
1799 fprintf(stderr
, "%s\n", err
->message
);
1806 free(qemu_img_abs_path
);