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/qmp/json-parser.h"
25 #include "qapi/qmp/json-streamer.h"
26 #include "qapi/qmp/qjson.h"
29 #define SOCKET_TIMEOUT 50
31 QTestState
*global_qtest
;
37 bool irq_level
[MAX_IRQ
];
39 pid_t qemu_pid
; /* our child QEMU process */
43 static GHookList abrt_hooks
;
44 static GList
*qtest_instances
;
45 static struct sigaction sigact_old
;
47 #define g_assert_no_errno(ret) do { \
48 g_assert_cmpint(ret, !=, -1); \
51 static int qtest_query_target_endianness(QTestState
*s
);
53 static int init_socket(const char *socket_path
)
55 struct sockaddr_un addr
;
59 sock
= socket(PF_UNIX
, SOCK_STREAM
, 0);
60 g_assert_no_errno(sock
);
62 addr
.sun_family
= AF_UNIX
;
63 snprintf(addr
.sun_path
, sizeof(addr
.sun_path
), "%s", socket_path
);
64 qemu_set_cloexec(sock
);
67 ret
= bind(sock
, (struct sockaddr
*)&addr
, sizeof(addr
));
68 } while (ret
== -1 && errno
== EINTR
);
69 g_assert_no_errno(ret
);
70 ret
= listen(sock
, 1);
71 g_assert_no_errno(ret
);
76 static int socket_accept(int sock
)
78 struct sockaddr_un addr
;
81 struct timeval timeout
= { .tv_sec
= SOCKET_TIMEOUT
,
84 setsockopt(sock
, SOL_SOCKET
, SO_RCVTIMEO
, (void *)&timeout
,
88 addrlen
= sizeof(addr
);
89 ret
= accept(sock
, (struct sockaddr
*)&addr
, &addrlen
);
90 } while (ret
== -1 && errno
== EINTR
);
92 fprintf(stderr
, "%s failed: %s\n", __func__
, strerror(errno
));
99 static void kill_qemu(QTestState
*s
)
101 if (s
->qemu_pid
!= -1) {
102 kill(s
->qemu_pid
, SIGTERM
);
103 waitpid(s
->qemu_pid
, NULL
, 0);
107 static void kill_qemu_hook_func(void *s
)
112 static void sigabrt_handler(int signo
)
114 g_hook_list_invoke(&abrt_hooks
, FALSE
);
117 static void setup_sigabrt_handler(void)
119 struct sigaction sigact
;
121 /* Catch SIGABRT to clean up on g_assert() failure */
122 sigact
= (struct sigaction
){
123 .sa_handler
= sigabrt_handler
,
124 .sa_flags
= SA_RESETHAND
,
126 sigemptyset(&sigact
.sa_mask
);
127 sigaction(SIGABRT
, &sigact
, &sigact_old
);
130 static void cleanup_sigabrt_handler(void)
132 sigaction(SIGABRT
, &sigact_old
, NULL
);
135 void qtest_add_abrt_handler(GHookFunc fn
, const void *data
)
139 /* Only install SIGABRT handler once */
140 if (!abrt_hooks
.is_setup
) {
141 g_hook_list_init(&abrt_hooks
, sizeof(GHook
));
142 setup_sigabrt_handler();
145 hook
= g_hook_alloc(&abrt_hooks
);
147 hook
->data
= (void *)data
;
149 g_hook_prepend(&abrt_hooks
, hook
);
152 QTestState
*qtest_init_without_qmp_handshake(const char *extra_args
)
155 int sock
, qmpsock
, i
;
157 gchar
*qmp_socket_path
;
159 const char *qemu_binary
;
161 qemu_binary
= getenv("QTEST_QEMU_BINARY");
162 g_assert(qemu_binary
!= NULL
);
164 s
= g_malloc(sizeof(*s
));
166 socket_path
= g_strdup_printf("/tmp/qtest-%d.sock", getpid());
167 qmp_socket_path
= g_strdup_printf("/tmp/qtest-%d.qmp", getpid());
169 sock
= init_socket(socket_path
);
170 qmpsock
= init_socket(qmp_socket_path
);
172 qtest_add_abrt_handler(kill_qemu_hook_func
, s
);
174 s
->qemu_pid
= fork();
175 if (s
->qemu_pid
== 0) {
176 setenv("QEMU_AUDIO_DRV", "none", true);
177 command
= g_strdup_printf("exec %s "
178 "-qtest unix:%s,nowait "
180 "-qmp unix:%s,nowait "
181 "-machine accel=qtest "
183 "%s", qemu_binary
, socket_path
,
184 getenv("QTEST_LOG") ? "/dev/fd/2" : "/dev/null",
187 execlp("/bin/sh", "sh", "-c", command
, NULL
);
191 s
->fd
= socket_accept(sock
);
193 s
->qmp_fd
= socket_accept(qmpsock
);
196 unlink(qmp_socket_path
);
198 g_free(qmp_socket_path
);
200 g_assert(s
->fd
>= 0 && s
->qmp_fd
>= 0);
202 s
->rx
= g_string_new("");
203 for (i
= 0; i
< MAX_IRQ
; i
++) {
204 s
->irq_level
[i
] = false;
207 if (getenv("QTEST_STOP")) {
208 kill(s
->qemu_pid
, SIGSTOP
);
211 /* ask endianness of the target */
213 s
->big_endian
= qtest_query_target_endianness(s
);
218 QTestState
*qtest_init(const char *extra_args
)
220 QTestState
*s
= qtest_init_without_qmp_handshake(extra_args
);
222 /* Read the QMP greeting and then do the handshake */
223 qtest_qmp_discard_response(s
, "");
224 qtest_qmp_discard_response(s
, "{ 'execute': 'qmp_capabilities' }");
229 void qtest_quit(QTestState
*s
)
231 qtest_instances
= g_list_remove(qtest_instances
, s
);
232 g_hook_destroy_link(&abrt_hooks
, g_hook_find_data(&abrt_hooks
, TRUE
, s
));
234 /* Uninstall SIGABRT handler on last instance */
235 if (!qtest_instances
) {
236 cleanup_sigabrt_handler();
242 g_string_free(s
->rx
, true);
246 static void socket_send(int fd
, const char *buf
, size_t size
)
251 while (offset
< size
) {
254 len
= write(fd
, buf
+ offset
, size
- offset
);
255 if (len
== -1 && errno
== EINTR
) {
259 g_assert_no_errno(len
);
260 g_assert_cmpint(len
, >, 0);
266 static void socket_sendf(int fd
, const char *fmt
, va_list ap
)
268 gchar
*str
= g_strdup_vprintf(fmt
, ap
);
269 size_t size
= strlen(str
);
271 socket_send(fd
, str
, size
);
275 static void GCC_FMT_ATTR(2, 3) qtest_sendf(QTestState
*s
, const char *fmt
, ...)
280 socket_sendf(s
->fd
, fmt
, ap
);
284 static GString
*qtest_recv_line(QTestState
*s
)
290 while ((eol
= strchr(s
->rx
->str
, '\n')) == NULL
) {
294 len
= read(s
->fd
, buffer
, sizeof(buffer
));
295 if (len
== -1 && errno
== EINTR
) {
299 if (len
== -1 || len
== 0) {
300 fprintf(stderr
, "Broken pipe\n");
304 g_string_append_len(s
->rx
, buffer
, len
);
307 offset
= eol
- s
->rx
->str
;
308 line
= g_string_new_len(s
->rx
->str
, offset
);
309 g_string_erase(s
->rx
, 0, offset
+ 1);
314 static gchar
**qtest_rsp(QTestState
*s
, int expected_args
)
321 line
= qtest_recv_line(s
);
322 words
= g_strsplit(line
->str
, " ", 0);
323 g_string_free(line
, TRUE
);
325 if (strcmp(words
[0], "IRQ") == 0) {
328 g_assert(words
[1] != NULL
);
329 g_assert(words
[2] != NULL
);
331 irq
= strtoul(words
[2], NULL
, 0);
332 g_assert_cmpint(irq
, >=, 0);
333 g_assert_cmpint(irq
, <, MAX_IRQ
);
335 if (strcmp(words
[1], "raise") == 0) {
336 s
->irq_level
[irq
] = true;
338 s
->irq_level
[irq
] = false;
345 g_assert(words
[0] != NULL
);
346 g_assert_cmpstr(words
[0], ==, "OK");
349 for (i
= 0; i
< expected_args
; i
++) {
350 g_assert(words
[i
] != NULL
);
359 static int qtest_query_target_endianness(QTestState
*s
)
364 qtest_sendf(s
, "endianness\n");
365 args
= qtest_rsp(s
, 1);
366 g_assert(strcmp(args
[1], "big") == 0 || strcmp(args
[1], "little") == 0);
367 big_endian
= strcmp(args
[1], "big") == 0;
374 JSONMessageParser parser
;
378 static void qmp_response(JSONMessageParser
*parser
, GQueue
*tokens
)
380 QMPResponseParser
*qmp
= container_of(parser
, QMPResponseParser
, parser
);
383 obj
= json_parser_parse(tokens
, NULL
);
385 fprintf(stderr
, "QMP JSON response parsing failed\n");
389 g_assert(!qmp
->response
);
390 qmp
->response
= qobject_to_qdict(obj
);
391 g_assert(qmp
->response
);
394 QDict
*qmp_fd_receive(int fd
)
396 QMPResponseParser qmp
;
397 bool log
= getenv("QTEST_LOG") != NULL
;
400 json_message_parser_init(&qmp
.parser
, qmp_response
);
401 while (!qmp
.response
) {
405 len
= read(fd
, &c
, 1);
406 if (len
== -1 && errno
== EINTR
) {
410 if (len
== -1 || len
== 0) {
411 fprintf(stderr
, "Broken pipe\n");
416 len
= write(2, &c
, 1);
418 json_message_parser_feed(&qmp
.parser
, &c
, 1);
420 json_message_parser_destroy(&qmp
.parser
);
425 QDict
*qtest_qmp_receive(QTestState
*s
)
427 return qmp_fd_receive(s
->qmp_fd
);
431 * Allow users to send a message without waiting for the reply,
432 * in the case that they choose to discard all replies up until
433 * a particular EVENT is received.
435 void qmp_fd_sendv(int fd
, const char *fmt
, va_list ap
)
440 /* Going through qobject ensures we escape strings properly.
441 * This seemingly unnecessary copy is required in case va_list
444 va_copy(ap_copy
, ap
);
445 qobj
= qobject_from_jsonv(fmt
, &ap_copy
);
448 /* No need to send anything for an empty QObject. */
450 int log
= getenv("QTEST_LOG") != NULL
;
451 QString
*qstr
= qobject_to_json(qobj
);
455 * BUG: QMP doesn't react to input until it sees a newline, an
456 * object, or an array. Work-around: give it a newline.
458 qstring_append_chr(qstr
, '\n');
459 str
= qstring_get_str(qstr
);
462 fprintf(stderr
, "%s", str
);
464 /* Send QMP request */
465 socket_send(fd
, str
, qstring_get_length(qstr
));
468 qobject_decref(qobj
);
472 void qtest_async_qmpv(QTestState
*s
, const char *fmt
, va_list ap
)
474 qmp_fd_sendv(s
->qmp_fd
, fmt
, ap
);
477 QDict
*qmp_fdv(int fd
, const char *fmt
, va_list ap
)
479 qmp_fd_sendv(fd
, fmt
, ap
);
481 return qmp_fd_receive(fd
);
484 QDict
*qtest_qmpv(QTestState
*s
, const char *fmt
, va_list ap
)
486 qtest_async_qmpv(s
, fmt
, ap
);
489 return qtest_qmp_receive(s
);
492 QDict
*qmp_fd(int fd
, const char *fmt
, ...)
498 response
= qmp_fdv(fd
, fmt
, ap
);
503 void qmp_fd_send(int fd
, const char *fmt
, ...)
508 qmp_fd_sendv(fd
, fmt
, ap
);
512 QDict
*qtest_qmp(QTestState
*s
, const char *fmt
, ...)
518 response
= qtest_qmpv(s
, fmt
, ap
);
523 void qtest_async_qmp(QTestState
*s
, const char *fmt
, ...)
528 qtest_async_qmpv(s
, fmt
, ap
);
532 void qtest_qmpv_discard_response(QTestState
*s
, const char *fmt
, va_list ap
)
534 QDict
*response
= qtest_qmpv(s
, fmt
, ap
);
538 void qtest_qmp_discard_response(QTestState
*s
, const char *fmt
, ...)
544 response
= qtest_qmpv(s
, fmt
, ap
);
549 QDict
*qtest_qmp_eventwait_ref(QTestState
*s
, const char *event
)
554 response
= qtest_qmp_receive(s
);
555 if ((qdict_haskey(response
, "event")) &&
556 (strcmp(qdict_get_str(response
, "event"), event
) == 0)) {
563 void qtest_qmp_eventwait(QTestState
*s
, const char *event
)
567 response
= qtest_qmp_eventwait_ref(s
, event
);
571 char *qtest_hmpv(QTestState
*s
, const char *fmt
, va_list ap
)
577 cmd
= g_strdup_vprintf(fmt
, ap
);
578 resp
= qtest_qmp(s
, "{'execute': 'human-monitor-command',"
579 " 'arguments': {'command-line': %s}}",
581 ret
= g_strdup(qdict_get_try_str(resp
, "return"));
588 char *qtest_hmp(QTestState
*s
, const char *fmt
, ...)
594 ret
= qtest_hmpv(s
, fmt
, ap
);
599 const char *qtest_get_arch(void)
601 const char *qemu
= getenv("QTEST_QEMU_BINARY");
602 g_assert(qemu
!= NULL
);
603 const char *end
= strrchr(qemu
, '/');
605 return end
+ strlen("/qemu-system-");
608 bool qtest_get_irq(QTestState
*s
, int num
)
610 /* dummy operation in order to make sure irq is up to date */
613 return s
->irq_level
[num
];
616 static int64_t qtest_clock_rsp(QTestState
*s
)
620 words
= qtest_rsp(s
, 2);
621 clock
= g_ascii_strtoll(words
[1], NULL
, 0);
626 int64_t qtest_clock_step_next(QTestState
*s
)
628 qtest_sendf(s
, "clock_step\n");
629 return qtest_clock_rsp(s
);
632 int64_t qtest_clock_step(QTestState
*s
, int64_t step
)
634 qtest_sendf(s
, "clock_step %"PRIi64
"\n", step
);
635 return qtest_clock_rsp(s
);
638 int64_t qtest_clock_set(QTestState
*s
, int64_t val
)
640 qtest_sendf(s
, "clock_set %"PRIi64
"\n", val
);
641 return qtest_clock_rsp(s
);
644 void qtest_irq_intercept_out(QTestState
*s
, const char *qom_path
)
646 qtest_sendf(s
, "irq_intercept_out %s\n", qom_path
);
650 void qtest_irq_intercept_in(QTestState
*s
, const char *qom_path
)
652 qtest_sendf(s
, "irq_intercept_in %s\n", qom_path
);
656 static void qtest_out(QTestState
*s
, const char *cmd
, uint16_t addr
, uint32_t value
)
658 qtest_sendf(s
, "%s 0x%x 0x%x\n", cmd
, addr
, value
);
662 void qtest_outb(QTestState
*s
, uint16_t addr
, uint8_t value
)
664 qtest_out(s
, "outb", addr
, value
);
667 void qtest_outw(QTestState
*s
, uint16_t addr
, uint16_t value
)
669 qtest_out(s
, "outw", addr
, value
);
672 void qtest_outl(QTestState
*s
, uint16_t addr
, uint32_t value
)
674 qtest_out(s
, "outl", addr
, value
);
677 static uint32_t qtest_in(QTestState
*s
, const char *cmd
, uint16_t addr
)
682 qtest_sendf(s
, "%s 0x%x\n", cmd
, addr
);
683 args
= qtest_rsp(s
, 2);
684 value
= strtoul(args
[1], NULL
, 0);
690 uint8_t qtest_inb(QTestState
*s
, uint16_t addr
)
692 return qtest_in(s
, "inb", addr
);
695 uint16_t qtest_inw(QTestState
*s
, uint16_t addr
)
697 return qtest_in(s
, "inw", addr
);
700 uint32_t qtest_inl(QTestState
*s
, uint16_t addr
)
702 return qtest_in(s
, "inl", addr
);
705 static void qtest_write(QTestState
*s
, const char *cmd
, uint64_t addr
,
708 qtest_sendf(s
, "%s 0x%" PRIx64
" 0x%" PRIx64
"\n", cmd
, addr
, value
);
712 void qtest_writeb(QTestState
*s
, uint64_t addr
, uint8_t value
)
714 qtest_write(s
, "writeb", addr
, value
);
717 void qtest_writew(QTestState
*s
, uint64_t addr
, uint16_t value
)
719 qtest_write(s
, "writew", addr
, value
);
722 void qtest_writel(QTestState
*s
, uint64_t addr
, uint32_t value
)
724 qtest_write(s
, "writel", addr
, value
);
727 void qtest_writeq(QTestState
*s
, uint64_t addr
, uint64_t value
)
729 qtest_write(s
, "writeq", addr
, value
);
732 static uint64_t qtest_read(QTestState
*s
, const char *cmd
, uint64_t addr
)
737 qtest_sendf(s
, "%s 0x%" PRIx64
"\n", cmd
, addr
);
738 args
= qtest_rsp(s
, 2);
739 value
= strtoull(args
[1], NULL
, 0);
745 uint8_t qtest_readb(QTestState
*s
, uint64_t addr
)
747 return qtest_read(s
, "readb", addr
);
750 uint16_t qtest_readw(QTestState
*s
, uint64_t addr
)
752 return qtest_read(s
, "readw", addr
);
755 uint32_t qtest_readl(QTestState
*s
, uint64_t addr
)
757 return qtest_read(s
, "readl", addr
);
760 uint64_t qtest_readq(QTestState
*s
, uint64_t addr
)
762 return qtest_read(s
, "readq", addr
);
765 static int hex2nib(char ch
)
767 if (ch
>= '0' && ch
<= '9') {
769 } else if (ch
>= 'a' && ch
<= 'f') {
770 return 10 + (ch
- 'a');
771 } else if (ch
>= 'A' && ch
<= 'F') {
772 return 10 + (ch
- 'a');
778 void qtest_memread(QTestState
*s
, uint64_t addr
, void *data
, size_t size
)
788 qtest_sendf(s
, "read 0x%" PRIx64
" 0x%zx\n", addr
, size
);
789 args
= qtest_rsp(s
, 2);
791 for (i
= 0; i
< size
; i
++) {
792 ptr
[i
] = hex2nib(args
[1][2 + (i
* 2)]) << 4;
793 ptr
[i
] |= hex2nib(args
[1][2 + (i
* 2) + 1]);
799 uint64_t qtest_rtas_call(QTestState
*s
, const char *name
,
800 uint32_t nargs
, uint64_t args
,
801 uint32_t nret
, uint64_t ret
)
803 qtest_sendf(s
, "rtas %s %u 0x%"PRIx64
" %u 0x%"PRIx64
"\n",
804 name
, nargs
, args
, nret
, ret
);
809 void qtest_add_func(const char *str
, void (*fn
)(void))
811 gchar
*path
= g_strdup_printf("/%s/%s", qtest_get_arch(), str
);
812 g_test_add_func(path
, fn
);
816 void qtest_add_data_func_full(const char *str
, void *data
,
817 void (*fn
)(const void *),
818 GDestroyNotify data_free_func
)
820 gchar
*path
= g_strdup_printf("/%s/%s", qtest_get_arch(), str
);
821 g_test_add_data_func_full(path
, data
, fn
, data_free_func
);
825 void qtest_add_data_func(const char *str
, const void *data
,
826 void (*fn
)(const void *))
828 gchar
*path
= g_strdup_printf("/%s/%s", qtest_get_arch(), str
);
829 g_test_add_data_func(path
, data
, fn
);
833 void qtest_bufwrite(QTestState
*s
, uint64_t addr
, const void *data
, size_t size
)
837 bdata
= g_base64_encode(data
, size
);
838 qtest_sendf(s
, "b64write 0x%" PRIx64
" 0x%zx ", addr
, size
);
839 socket_send(s
->fd
, bdata
, strlen(bdata
));
840 socket_send(s
->fd
, "\n", 1);
845 void qtest_bufread(QTestState
*s
, uint64_t addr
, void *data
, size_t size
)
850 qtest_sendf(s
, "b64read 0x%" PRIx64
" 0x%zx\n", addr
, size
);
851 args
= qtest_rsp(s
, 2);
853 g_base64_decode_inplace(args
[1], &len
);
855 fprintf(stderr
, "bufread: asked for %zu bytes but decoded %zu\n",
857 len
= MIN(len
, size
);
860 memcpy(data
, args
[1], len
);
864 void qtest_memwrite(QTestState
*s
, uint64_t addr
, const void *data
, size_t size
)
866 const uint8_t *ptr
= data
;
874 enc
= g_malloc(2 * size
+ 1);
876 for (i
= 0; i
< size
; i
++) {
877 sprintf(&enc
[i
* 2], "%02x", ptr
[i
]);
880 qtest_sendf(s
, "write 0x%" PRIx64
" 0x%zx 0x%s\n", addr
, size
, enc
);
885 void qtest_memset(QTestState
*s
, uint64_t addr
, uint8_t pattern
, size_t size
)
887 qtest_sendf(s
, "memset 0x%" PRIx64
" 0x%zx 0x%02x\n", addr
, size
, pattern
);
891 QDict
*qmp(const char *fmt
, ...)
897 response
= qtest_qmpv(global_qtest
, fmt
, ap
);
902 void qmp_async(const char *fmt
, ...)
907 qtest_async_qmpv(global_qtest
, fmt
, ap
);
911 void qmp_discard_response(const char *fmt
, ...)
916 qtest_qmpv_discard_response(global_qtest
, fmt
, ap
);
919 char *hmp(const char *fmt
, ...)
925 ret
= qtest_hmpv(global_qtest
, fmt
, ap
);
930 bool qtest_big_endian(QTestState
*s
)
932 return s
->big_endian
;