2 * QTest testcase for the vhost-user
4 * Copyright (c) 2014 Virtual Open Systems Sarl.
6 * This work is licensed under the terms of the GNU GPL, version 2 or later.
7 * See the COPYING file in the top-level directory.
11 #include "qemu/osdep.h"
14 #include "qemu/option.h"
15 #include "qemu/range.h"
16 #include "sysemu/char.h"
17 #include "sysemu/sysemu.h"
19 #include <linux/vhost.h>
22 #include <qemu/sockets.h>
24 /* GLIB version compatibility flags */
25 #if !GLIB_CHECK_VERSION(2, 26, 0)
26 #define G_TIME_SPAN_SECOND (G_GINT64_CONSTANT(1000000))
29 #if GLIB_CHECK_VERSION(2, 28, 0)
30 #define HAVE_MONOTONIC_TIME
33 #define QEMU_CMD_ACCEL " -machine accel=tcg"
34 #define QEMU_CMD_MEM " -m %d -object memory-backend-file,id=mem,size=%dM,"\
35 "mem-path=%s,share=on -numa node,memdev=mem"
36 #define QEMU_CMD_CHR " -chardev socket,id=%s,path=%s%s"
37 #define QEMU_CMD_NETDEV " -netdev vhost-user,id=net0,chardev=%s,vhostforce"
38 #define QEMU_CMD_NET " -device virtio-net-pci,netdev=net0,romfile=./pc-bios/pxe-virtio.rom"
40 #define QEMU_CMD QEMU_CMD_ACCEL QEMU_CMD_MEM QEMU_CMD_CHR \
41 QEMU_CMD_NETDEV QEMU_CMD_NET
43 #define HUGETLBFS_MAGIC 0x958458f6
45 /*********** FROM hw/virtio/vhost-user.c *************************************/
47 #define VHOST_MEMORY_MAX_NREGIONS 8
49 #define VHOST_USER_F_PROTOCOL_FEATURES 30
50 #define VHOST_USER_PROTOCOL_F_LOG_SHMFD 1
52 #define VHOST_LOG_PAGE 0x1000
54 typedef enum VhostUserRequest
{
56 VHOST_USER_GET_FEATURES
= 1,
57 VHOST_USER_SET_FEATURES
= 2,
58 VHOST_USER_SET_OWNER
= 3,
59 VHOST_USER_RESET_OWNER
= 4,
60 VHOST_USER_SET_MEM_TABLE
= 5,
61 VHOST_USER_SET_LOG_BASE
= 6,
62 VHOST_USER_SET_LOG_FD
= 7,
63 VHOST_USER_SET_VRING_NUM
= 8,
64 VHOST_USER_SET_VRING_ADDR
= 9,
65 VHOST_USER_SET_VRING_BASE
= 10,
66 VHOST_USER_GET_VRING_BASE
= 11,
67 VHOST_USER_SET_VRING_KICK
= 12,
68 VHOST_USER_SET_VRING_CALL
= 13,
69 VHOST_USER_SET_VRING_ERR
= 14,
70 VHOST_USER_GET_PROTOCOL_FEATURES
= 15,
71 VHOST_USER_SET_PROTOCOL_FEATURES
= 16,
72 VHOST_USER_SET_VRING_ENABLE
= 18,
76 typedef struct VhostUserMemoryRegion
{
77 uint64_t guest_phys_addr
;
79 uint64_t userspace_addr
;
81 } VhostUserMemoryRegion
;
83 typedef struct VhostUserMemory
{
86 VhostUserMemoryRegion regions
[VHOST_MEMORY_MAX_NREGIONS
];
89 typedef struct VhostUserLog
{
94 typedef struct VhostUserMsg
{
95 VhostUserRequest request
;
97 #define VHOST_USER_VERSION_MASK (0x3)
98 #define VHOST_USER_REPLY_MASK (0x1<<2)
100 uint32_t size
; /* the following payload size */
102 #define VHOST_USER_VRING_IDX_MASK (0xff)
103 #define VHOST_USER_VRING_NOFD_MASK (0x1<<8)
105 struct vhost_vring_state state
;
106 struct vhost_vring_addr addr
;
107 VhostUserMemory memory
;
110 } QEMU_PACKED VhostUserMsg
;
112 static VhostUserMsg m
__attribute__ ((unused
));
113 #define VHOST_USER_HDR_SIZE (sizeof(m.request) \
117 #define VHOST_USER_PAYLOAD_SIZE (sizeof(m) - VHOST_USER_HDR_SIZE)
119 /* The version of the protocol we support */
120 #define VHOST_USER_VERSION (0x1)
121 /*****************************************************************************/
123 typedef struct TestServer
{
127 CharDriverState
*chr
;
129 int fds
[VHOST_MEMORY_MAX_NREGIONS
];
130 VhostUserMemory memory
;
137 #if !GLIB_CHECK_VERSION(2, 32, 0)
138 static gboolean
g_cond_wait_until(CompatGCond cond
, CompatGMutex mutex
,
141 gboolean ret
= FALSE
;
142 end_time
-= g_get_monotonic_time();
143 GTimeVal time
= { end_time
/ G_TIME_SPAN_SECOND
,
144 end_time
% G_TIME_SPAN_SECOND
};
145 ret
= g_cond_timed_wait(cond
, mutex
, &time
);
150 static const char *tmpfs
;
151 static const char *root
;
153 static void wait_for_fds(TestServer
*s
)
157 g_mutex_lock(&s
->data_mutex
);
159 end_time
= g_get_monotonic_time() + 5 * G_TIME_SPAN_SECOND
;
160 while (!s
->fds_num
) {
161 if (!g_cond_wait_until(&s
->data_cond
, &s
->data_mutex
, end_time
)) {
162 /* timeout has passed */
163 g_assert(s
->fds_num
);
168 /* check for sanity */
169 g_assert_cmpint(s
->fds_num
, >, 0);
170 g_assert_cmpint(s
->fds_num
, ==, s
->memory
.nregions
);
172 g_mutex_unlock(&s
->data_mutex
);
175 static void read_guest_mem(const void *data
)
177 TestServer
*s
= (void *)data
;
184 g_mutex_lock(&s
->data_mutex
);
186 /* iterate all regions */
187 for (i
= 0; i
< s
->fds_num
; i
++) {
189 /* We'll check only the region statring at 0x0*/
190 if (s
->memory
.regions
[i
].guest_phys_addr
!= 0x0) {
194 g_assert_cmpint(s
->memory
.regions
[i
].memory_size
, >, 1024);
196 size
= s
->memory
.regions
[i
].memory_size
+
197 s
->memory
.regions
[i
].mmap_offset
;
199 guest_mem
= mmap(0, size
, PROT_READ
| PROT_WRITE
,
200 MAP_SHARED
, s
->fds
[i
], 0);
202 g_assert(guest_mem
!= MAP_FAILED
);
203 guest_mem
+= (s
->memory
.regions
[i
].mmap_offset
/ sizeof(*guest_mem
));
205 for (j
= 0; j
< 256; j
++) {
206 uint32_t a
= readl(s
->memory
.regions
[i
].guest_phys_addr
+ j
*4);
207 uint32_t b
= guest_mem
[j
];
209 g_assert_cmpint(a
, ==, b
);
212 munmap(guest_mem
, s
->memory
.regions
[i
].memory_size
);
215 g_mutex_unlock(&s
->data_mutex
);
218 static void *thread_function(void *data
)
220 GMainLoop
*loop
= data
;
221 g_main_loop_run(loop
);
225 static int chr_can_read(void *opaque
)
227 return VHOST_USER_HDR_SIZE
;
230 static void chr_read(void *opaque
, const uint8_t *buf
, int size
)
232 TestServer
*s
= opaque
;
233 CharDriverState
*chr
= s
->chr
;
235 uint8_t *p
= (uint8_t *) &msg
;
238 if (size
!= VHOST_USER_HDR_SIZE
) {
239 g_test_message("Wrong message size received %d\n", size
);
243 g_mutex_lock(&s
->data_mutex
);
244 memcpy(p
, buf
, VHOST_USER_HDR_SIZE
);
247 p
+= VHOST_USER_HDR_SIZE
;
248 size
= qemu_chr_fe_read_all(chr
, p
, msg
.size
);
249 if (size
!= msg
.size
) {
250 g_test_message("Wrong message size received %d != %d\n",
256 switch (msg
.request
) {
257 case VHOST_USER_GET_FEATURES
:
258 /* send back features to qemu */
259 msg
.flags
|= VHOST_USER_REPLY_MASK
;
260 msg
.size
= sizeof(m
.payload
.u64
);
261 msg
.payload
.u64
= 0x1ULL
<< VHOST_F_LOG_ALL
|
262 0x1ULL
<< VHOST_USER_F_PROTOCOL_FEATURES
;
263 p
= (uint8_t *) &msg
;
264 qemu_chr_fe_write_all(chr
, p
, VHOST_USER_HDR_SIZE
+ msg
.size
);
267 case VHOST_USER_SET_FEATURES
:
268 g_assert_cmpint(msg
.payload
.u64
& (0x1ULL
<< VHOST_USER_F_PROTOCOL_FEATURES
),
272 case VHOST_USER_GET_PROTOCOL_FEATURES
:
273 /* send back features to qemu */
274 msg
.flags
|= VHOST_USER_REPLY_MASK
;
275 msg
.size
= sizeof(m
.payload
.u64
);
276 msg
.payload
.u64
= 1 << VHOST_USER_PROTOCOL_F_LOG_SHMFD
;
277 p
= (uint8_t *) &msg
;
278 qemu_chr_fe_write_all(chr
, p
, VHOST_USER_HDR_SIZE
+ msg
.size
);
281 case VHOST_USER_GET_VRING_BASE
:
282 /* send back vring base to qemu */
283 msg
.flags
|= VHOST_USER_REPLY_MASK
;
284 msg
.size
= sizeof(m
.payload
.state
);
285 msg
.payload
.state
.num
= 0;
286 p
= (uint8_t *) &msg
;
287 qemu_chr_fe_write_all(chr
, p
, VHOST_USER_HDR_SIZE
+ msg
.size
);
289 assert(msg
.payload
.state
.index
< 2);
290 s
->rings
&= ~(0x1ULL
<< msg
.payload
.state
.index
);
293 case VHOST_USER_SET_MEM_TABLE
:
294 /* received the mem table */
295 memcpy(&s
->memory
, &msg
.payload
.memory
, sizeof(msg
.payload
.memory
));
296 s
->fds_num
= qemu_chr_fe_get_msgfds(chr
, s
->fds
, G_N_ELEMENTS(s
->fds
));
298 /* signal the test that it can continue */
299 g_cond_signal(&s
->data_cond
);
302 case VHOST_USER_SET_VRING_KICK
:
303 case VHOST_USER_SET_VRING_CALL
:
305 qemu_chr_fe_get_msgfds(chr
, &fd
, 1);
307 * This is a non-blocking eventfd.
308 * The receive function forces it to be blocking,
309 * so revert it back to non-blocking.
311 qemu_set_nonblock(fd
);
314 case VHOST_USER_SET_LOG_BASE
:
315 if (s
->log_fd
!= -1) {
319 qemu_chr_fe_get_msgfds(chr
, &s
->log_fd
, 1);
320 msg
.flags
|= VHOST_USER_REPLY_MASK
;
322 p
= (uint8_t *) &msg
;
323 qemu_chr_fe_write_all(chr
, p
, VHOST_USER_HDR_SIZE
);
325 g_cond_signal(&s
->data_cond
);
328 case VHOST_USER_SET_VRING_BASE
:
329 assert(msg
.payload
.state
.index
< 2);
330 s
->rings
|= 0x1ULL
<< msg
.payload
.state
.index
;
337 g_mutex_unlock(&s
->data_mutex
);
340 static const char *init_hugepagefs(const char *path
)
345 if (access(path
, R_OK
| W_OK
| X_OK
)) {
346 g_test_message("access on path (%s): %s\n", path
, strerror(errno
));
351 ret
= statfs(path
, &fs
);
352 } while (ret
!= 0 && errno
== EINTR
);
355 g_test_message("statfs on path (%s): %s\n", path
, strerror(errno
));
359 if (fs
.f_type
!= HUGETLBFS_MAGIC
) {
360 g_test_message("Warning: path not on HugeTLBFS: %s\n", path
);
367 static TestServer
*test_server_new(const gchar
*name
)
369 TestServer
*server
= g_new0(TestServer
, 1);
371 server
->socket_path
= g_strdup_printf("%s/%s.sock", tmpfs
, name
);
372 server
->mig_path
= g_strdup_printf("%s/%s.mig", tmpfs
, name
);
373 server
->chr_name
= g_strdup_printf("chr-%s", name
);
375 g_mutex_init(&server
->data_mutex
);
376 g_cond_init(&server
->data_cond
);
383 static void test_server_create_chr(TestServer
*server
, const gchar
*opt
)
387 chr_path
= g_strdup_printf("unix:%s%s", server
->socket_path
, opt
);
388 server
->chr
= qemu_chr_new(server
->chr_name
, chr_path
, NULL
);
391 qemu_chr_add_handlers(server
->chr
, chr_can_read
, chr_read
, NULL
, server
);
394 static void test_server_listen(TestServer
*server
)
396 test_server_create_chr(server
, ",server,nowait");
399 static inline void test_server_connect(TestServer
*server
)
401 test_server_create_chr(server
, ",reconnect=1");
404 #define GET_QEMU_CMD(s) \
405 g_strdup_printf(QEMU_CMD, 512, 512, (root), (s)->chr_name, \
406 (s)->socket_path, "", (s)->chr_name)
408 #define GET_QEMU_CMDE(s, mem, chr_opts, extra, ...) \
409 g_strdup_printf(QEMU_CMD extra, (mem), (mem), (root), (s)->chr_name, \
410 (s)->socket_path, (chr_opts), (s)->chr_name, ##__VA_ARGS__)
412 static gboolean
_test_server_free(TestServer
*server
)
416 qemu_chr_delete(server
->chr
);
418 for (i
= 0; i
< server
->fds_num
; i
++) {
419 close(server
->fds
[i
]);
422 if (server
->log_fd
!= -1) {
423 close(server
->log_fd
);
426 unlink(server
->socket_path
);
427 g_free(server
->socket_path
);
429 unlink(server
->mig_path
);
430 g_free(server
->mig_path
);
432 g_free(server
->chr_name
);
438 static void test_server_free(TestServer
*server
)
440 g_idle_add((GSourceFunc
)_test_server_free
, server
);
443 static void wait_for_log_fd(TestServer
*s
)
447 g_mutex_lock(&s
->data_mutex
);
448 end_time
= g_get_monotonic_time() + 5 * G_TIME_SPAN_SECOND
;
449 while (s
->log_fd
== -1) {
450 if (!g_cond_wait_until(&s
->data_cond
, &s
->data_mutex
, end_time
)) {
451 /* timeout has passed */
452 g_assert(s
->log_fd
!= -1);
457 g_mutex_unlock(&s
->data_mutex
);
460 static void write_guest_mem(TestServer
*s
, uint32_t seed
)
468 /* iterate all regions */
469 for (i
= 0; i
< s
->fds_num
; i
++) {
471 /* We'll write only the region statring at 0x0 */
472 if (s
->memory
.regions
[i
].guest_phys_addr
!= 0x0) {
476 g_assert_cmpint(s
->memory
.regions
[i
].memory_size
, >, 1024);
478 size
= s
->memory
.regions
[i
].memory_size
+
479 s
->memory
.regions
[i
].mmap_offset
;
481 guest_mem
= mmap(0, size
, PROT_READ
| PROT_WRITE
,
482 MAP_SHARED
, s
->fds
[i
], 0);
484 g_assert(guest_mem
!= MAP_FAILED
);
485 guest_mem
+= (s
->memory
.regions
[i
].mmap_offset
/ sizeof(*guest_mem
));
487 for (j
= 0; j
< 256; j
++) {
488 guest_mem
[j
] = seed
+ j
;
491 munmap(guest_mem
, s
->memory
.regions
[i
].memory_size
);
496 static guint64
get_log_size(TestServer
*s
)
498 guint64 log_size
= 0;
501 for (i
= 0; i
< s
->memory
.nregions
; ++i
) {
502 VhostUserMemoryRegion
*reg
= &s
->memory
.regions
[i
];
503 guint64 last
= range_get_last(reg
->guest_phys_addr
,
505 log_size
= MAX(log_size
, last
/ (8 * VHOST_LOG_PAGE
) + 1);
511 typedef struct TestMigrateSource
{
518 test_migrate_source_check(GSource
*source
)
520 TestMigrateSource
*t
= (TestMigrateSource
*)source
;
521 gboolean overlap
= t
->src
->rings
&& t
->dest
->rings
;
528 #if !GLIB_CHECK_VERSION(2,36,0)
529 /* this callback is unnecessary with glib >2.36, the default
530 * prepare for the source does the same */
532 test_migrate_source_prepare(GSource
*source
, gint
*timeout
)
539 GSourceFuncs test_migrate_source_funcs
= {
540 #if !GLIB_CHECK_VERSION(2,36,0)
541 .prepare
= test_migrate_source_prepare
,
543 .check
= test_migrate_source_check
,
546 static void test_migrate(void)
548 TestServer
*s
= test_server_new("src");
549 TestServer
*dest
= test_server_new("dest");
550 char *uri
= g_strdup_printf("%s%s", "unix:", dest
->mig_path
);
551 QTestState
*global
= global_qtest
, *from
, *to
;
558 test_server_listen(s
);
559 test_server_listen(dest
);
561 cmd
= GET_QEMU_CMDE(s
, 2, "", "");
562 from
= qtest_start(cmd
);
566 size
= get_log_size(s
);
567 g_assert_cmpint(size
, ==, (2 * 1024 * 1024) / (VHOST_LOG_PAGE
* 8));
569 cmd
= GET_QEMU_CMDE(dest
, 2, "", " -incoming %s", uri
);
570 to
= qtest_init(cmd
);
573 source
= g_source_new(&test_migrate_source_funcs
,
574 sizeof(TestMigrateSource
));
575 ((TestMigrateSource
*)source
)->src
= s
;
576 ((TestMigrateSource
*)source
)->dest
= dest
;
577 g_source_attach(source
, NULL
);
579 /* slow down migration to have time to fiddle with log */
580 /* TODO: qtest could learn to break on some places */
581 rsp
= qmp("{ 'execute': 'migrate_set_speed',"
582 "'arguments': { 'value': 10 } }");
583 g_assert(qdict_haskey(rsp
, "return"));
586 cmd
= g_strdup_printf("{ 'execute': 'migrate',"
587 "'arguments': { 'uri': '%s' } }",
591 g_assert(qdict_haskey(rsp
, "return"));
596 log
= mmap(0, size
, PROT_READ
| PROT_WRITE
, MAP_SHARED
, s
->log_fd
, 0);
597 g_assert(log
!= MAP_FAILED
);
599 /* modify first page */
600 write_guest_mem(s
, 0x42);
604 /* speed things up */
605 rsp
= qmp("{ 'execute': 'migrate_set_speed',"
606 "'arguments': { 'value': 0 } }");
607 g_assert(qdict_haskey(rsp
, "return"));
610 qmp_eventwait("STOP");
613 qmp_eventwait("RESUME");
615 read_guest_mem(dest
);
617 g_source_destroy(source
);
618 g_source_unref(source
);
621 test_server_free(dest
);
626 global_qtest
= global
;
629 #ifdef CONFIG_HAS_GLIB_SUBPROCESS_TESTS
630 static void wait_for_rings_started(TestServer
*s
, size_t count
)
634 g_mutex_lock(&s
->data_mutex
);
635 end_time
= g_get_monotonic_time() + 5 * G_TIME_SPAN_SECOND
;
636 while (ctpop64(s
->rings
) != count
) {
637 if (!g_cond_wait_until(&s
->data_cond
, &s
->data_mutex
, end_time
)) {
638 /* timeout has passed */
639 g_assert_cmpint(ctpop64(s
->rings
), ==, count
);
644 g_mutex_unlock(&s
->data_mutex
);
648 reconnect_cb(gpointer user_data
)
650 TestServer
*s
= user_data
;
652 qemu_chr_disconnect(s
->chr
);
658 connect_thread(gpointer data
)
660 TestServer
*s
= data
;
662 /* wait for qemu to start before first try, to avoid extra warnings */
663 g_usleep(G_USEC_PER_SEC
);
664 test_server_connect(s
);
669 static void test_reconnect_subprocess(void)
671 TestServer
*s
= test_server_new("reconnect");
674 g_thread_new("connect", connect_thread
, s
);
675 cmd
= GET_QEMU_CMDE(s
, 2, ",server", "");
680 wait_for_rings_started(s
, 2);
685 g_idle_add(reconnect_cb
, s
);
687 wait_for_rings_started(s
, 2);
694 static void test_reconnect(void)
696 gchar
*path
= g_strdup_printf("/%s/vhost-user/reconnect/subprocess",
698 g_test_trap_subprocess(path
, 0, 0);
699 g_test_trap_assert_passed();
703 int main(int argc
, char **argv
)
705 QTestState
*s
= NULL
;
706 TestServer
*server
= NULL
;
708 char *qemu_cmd
= NULL
;
710 char template[] = "/tmp/vhost-test-XXXXXX";
714 g_test_init(&argc
, &argv
, NULL
);
716 module_call_init(MODULE_INIT_QOM
);
717 qemu_add_opts(&qemu_chardev_opts
);
719 tmpfs
= mkdtemp(template);
721 g_test_message("mkdtemp on path (%s): %s\n", template, strerror(errno
));
725 hugefs
= getenv("QTEST_HUGETLBFS_PATH");
727 root
= init_hugepagefs(hugefs
);
733 server
= test_server_new("test");
734 test_server_listen(server
);
736 loop
= g_main_loop_new(NULL
, FALSE
);
737 /* run the main loop thread so the chardev may operate */
738 thread
= g_thread_new(NULL
, thread_function
, loop
);
740 qemu_cmd
= GET_QEMU_CMD(server
);
742 s
= qtest_start(qemu_cmd
);
745 qtest_add_data_func("/vhost-user/read-guest-mem", server
, read_guest_mem
);
746 qtest_add_func("/vhost-user/migrate", test_migrate
);
747 #ifdef CONFIG_HAS_GLIB_SUBPROCESS_TESTS
748 qtest_add_func("/vhost-user/reconnect/subprocess",
749 test_reconnect_subprocess
);
750 qtest_add_func("/vhost-user/reconnect", test_reconnect
);
760 test_server_free(server
);
762 /* finish the helper thread and dispatch pending sources */
763 g_main_loop_quit(loop
);
764 g_thread_join(thread
);
765 while (g_main_context_pending(NULL
)) {
766 g_main_context_iteration (NULL
, TRUE
);
768 g_main_loop_unref(loop
);
772 g_test_message("unable to rmdir: path (%s): %s\n",
773 tmpfs
, strerror(errno
));
775 g_assert_cmpint(ret
, ==, 0);