vl: smp_parse: cleanups
[qemu/ar7.git] / tests / vhost-user-test.c
blobb2b1665ab84615fdabc37b14cd2a402f60bca0a4
1 /*
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.
9 */
11 #include "qemu/osdep.h"
13 #include "libqtest.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>
20 #include <sys/vfs.h>
21 #include <qemu/sockets.h>
23 /* GLIB version compatibility flags */
24 #if !GLIB_CHECK_VERSION(2, 26, 0)
25 #define G_TIME_SPAN_SECOND (G_GINT64_CONSTANT(1000000))
26 #endif
28 #if GLIB_CHECK_VERSION(2, 28, 0)
29 #define HAVE_MONOTONIC_TIME
30 #endif
32 #define QEMU_CMD_ACCEL " -machine accel=tcg"
33 #define QEMU_CMD_MEM " -m %d -object memory-backend-file,id=mem,size=%dM,"\
34 "mem-path=%s,share=on -numa node,memdev=mem"
35 #define QEMU_CMD_CHR " -chardev socket,id=%s,path=%s"
36 #define QEMU_CMD_NETDEV " -netdev vhost-user,id=net0,chardev=%s,vhostforce"
37 #define QEMU_CMD_NET " -device virtio-net-pci,netdev=net0,romfile=./pc-bios/pxe-virtio.rom"
39 #define QEMU_CMD QEMU_CMD_ACCEL QEMU_CMD_MEM QEMU_CMD_CHR \
40 QEMU_CMD_NETDEV QEMU_CMD_NET
42 #define HUGETLBFS_MAGIC 0x958458f6
44 /*********** FROM hw/virtio/vhost-user.c *************************************/
46 #define VHOST_MEMORY_MAX_NREGIONS 8
48 #define VHOST_USER_F_PROTOCOL_FEATURES 30
49 #define VHOST_USER_PROTOCOL_F_LOG_SHMFD 1
51 #define VHOST_LOG_PAGE 0x1000
53 typedef enum VhostUserRequest {
54 VHOST_USER_NONE = 0,
55 VHOST_USER_GET_FEATURES = 1,
56 VHOST_USER_SET_FEATURES = 2,
57 VHOST_USER_SET_OWNER = 3,
58 VHOST_USER_RESET_OWNER = 4,
59 VHOST_USER_SET_MEM_TABLE = 5,
60 VHOST_USER_SET_LOG_BASE = 6,
61 VHOST_USER_SET_LOG_FD = 7,
62 VHOST_USER_SET_VRING_NUM = 8,
63 VHOST_USER_SET_VRING_ADDR = 9,
64 VHOST_USER_SET_VRING_BASE = 10,
65 VHOST_USER_GET_VRING_BASE = 11,
66 VHOST_USER_SET_VRING_KICK = 12,
67 VHOST_USER_SET_VRING_CALL = 13,
68 VHOST_USER_SET_VRING_ERR = 14,
69 VHOST_USER_GET_PROTOCOL_FEATURES = 15,
70 VHOST_USER_SET_PROTOCOL_FEATURES = 16,
71 VHOST_USER_SET_VRING_ENABLE = 18,
72 VHOST_USER_MAX
73 } VhostUserRequest;
75 typedef struct VhostUserMemoryRegion {
76 uint64_t guest_phys_addr;
77 uint64_t memory_size;
78 uint64_t userspace_addr;
79 uint64_t mmap_offset;
80 } VhostUserMemoryRegion;
82 typedef struct VhostUserMemory {
83 uint32_t nregions;
84 uint32_t padding;
85 VhostUserMemoryRegion regions[VHOST_MEMORY_MAX_NREGIONS];
86 } VhostUserMemory;
88 typedef struct VhostUserLog {
89 uint64_t mmap_size;
90 uint64_t mmap_offset;
91 } VhostUserLog;
93 typedef struct VhostUserMsg {
94 VhostUserRequest request;
96 #define VHOST_USER_VERSION_MASK (0x3)
97 #define VHOST_USER_REPLY_MASK (0x1<<2)
98 uint32_t flags;
99 uint32_t size; /* the following payload size */
100 union {
101 #define VHOST_USER_VRING_IDX_MASK (0xff)
102 #define VHOST_USER_VRING_NOFD_MASK (0x1<<8)
103 uint64_t u64;
104 struct vhost_vring_state state;
105 struct vhost_vring_addr addr;
106 VhostUserMemory memory;
107 VhostUserLog log;
108 } payload;
109 } QEMU_PACKED VhostUserMsg;
111 static VhostUserMsg m __attribute__ ((unused));
112 #define VHOST_USER_HDR_SIZE (sizeof(m.request) \
113 + sizeof(m.flags) \
114 + sizeof(m.size))
116 #define VHOST_USER_PAYLOAD_SIZE (sizeof(m) - VHOST_USER_HDR_SIZE)
118 /* The version of the protocol we support */
119 #define VHOST_USER_VERSION (0x1)
120 /*****************************************************************************/
122 typedef struct TestServer {
123 gchar *socket_path;
124 gchar *mig_path;
125 gchar *chr_name;
126 CharDriverState *chr;
127 int fds_num;
128 int fds[VHOST_MEMORY_MAX_NREGIONS];
129 VhostUserMemory memory;
130 GMutex data_mutex;
131 GCond data_cond;
132 int log_fd;
133 uint64_t rings;
134 } TestServer;
136 #if !GLIB_CHECK_VERSION(2, 32, 0)
137 static gboolean g_cond_wait_until(CompatGCond cond, CompatGMutex mutex,
138 gint64 end_time)
140 gboolean ret = FALSE;
141 end_time -= g_get_monotonic_time();
142 GTimeVal time = { end_time / G_TIME_SPAN_SECOND,
143 end_time % G_TIME_SPAN_SECOND };
144 ret = g_cond_timed_wait(cond, mutex, &time);
145 return ret;
147 #endif
149 static const char *tmpfs;
150 static const char *root;
152 static void wait_for_fds(TestServer *s)
154 gint64 end_time;
156 g_mutex_lock(&s->data_mutex);
158 end_time = g_get_monotonic_time() + 5 * G_TIME_SPAN_SECOND;
159 while (!s->fds_num) {
160 if (!g_cond_wait_until(&s->data_cond, &s->data_mutex, end_time)) {
161 /* timeout has passed */
162 g_assert(s->fds_num);
163 break;
167 /* check for sanity */
168 g_assert_cmpint(s->fds_num, >, 0);
169 g_assert_cmpint(s->fds_num, ==, s->memory.nregions);
171 g_mutex_unlock(&s->data_mutex);
174 static void read_guest_mem(const void *data)
176 TestServer *s = (void *)data;
177 uint32_t *guest_mem;
178 int i, j;
179 size_t size;
181 wait_for_fds(s);
183 g_mutex_lock(&s->data_mutex);
185 /* iterate all regions */
186 for (i = 0; i < s->fds_num; i++) {
188 /* We'll check only the region statring at 0x0*/
189 if (s->memory.regions[i].guest_phys_addr != 0x0) {
190 continue;
193 g_assert_cmpint(s->memory.regions[i].memory_size, >, 1024);
195 size = s->memory.regions[i].memory_size +
196 s->memory.regions[i].mmap_offset;
198 guest_mem = mmap(0, size, PROT_READ | PROT_WRITE,
199 MAP_SHARED, s->fds[i], 0);
201 g_assert(guest_mem != MAP_FAILED);
202 guest_mem += (s->memory.regions[i].mmap_offset / sizeof(*guest_mem));
204 for (j = 0; j < 256; j++) {
205 uint32_t a = readl(s->memory.regions[i].guest_phys_addr + j*4);
206 uint32_t b = guest_mem[j];
208 g_assert_cmpint(a, ==, b);
211 munmap(guest_mem, s->memory.regions[i].memory_size);
214 g_mutex_unlock(&s->data_mutex);
217 static void *thread_function(void *data)
219 GMainLoop *loop = data;
220 g_main_loop_run(loop);
221 return NULL;
224 static int chr_can_read(void *opaque)
226 return VHOST_USER_HDR_SIZE;
229 static void chr_read(void *opaque, const uint8_t *buf, int size)
231 TestServer *s = opaque;
232 CharDriverState *chr = s->chr;
233 VhostUserMsg msg;
234 uint8_t *p = (uint8_t *) &msg;
235 int fd;
237 if (size != VHOST_USER_HDR_SIZE) {
238 g_test_message("Wrong message size received %d\n", size);
239 return;
242 g_mutex_lock(&s->data_mutex);
243 memcpy(p, buf, VHOST_USER_HDR_SIZE);
245 if (msg.size) {
246 p += VHOST_USER_HDR_SIZE;
247 g_assert_cmpint(qemu_chr_fe_read_all(chr, p, msg.size), ==, msg.size);
250 switch (msg.request) {
251 case VHOST_USER_GET_FEATURES:
252 /* send back features to qemu */
253 msg.flags |= VHOST_USER_REPLY_MASK;
254 msg.size = sizeof(m.payload.u64);
255 msg.payload.u64 = 0x1ULL << VHOST_F_LOG_ALL |
256 0x1ULL << VHOST_USER_F_PROTOCOL_FEATURES;
257 p = (uint8_t *) &msg;
258 qemu_chr_fe_write_all(chr, p, VHOST_USER_HDR_SIZE + msg.size);
259 break;
261 case VHOST_USER_SET_FEATURES:
262 g_assert_cmpint(msg.payload.u64 & (0x1ULL << VHOST_USER_F_PROTOCOL_FEATURES),
263 !=, 0ULL);
264 break;
266 case VHOST_USER_GET_PROTOCOL_FEATURES:
267 /* send back features to qemu */
268 msg.flags |= VHOST_USER_REPLY_MASK;
269 msg.size = sizeof(m.payload.u64);
270 msg.payload.u64 = 1 << VHOST_USER_PROTOCOL_F_LOG_SHMFD;
271 p = (uint8_t *) &msg;
272 qemu_chr_fe_write_all(chr, p, VHOST_USER_HDR_SIZE + msg.size);
273 break;
275 case VHOST_USER_GET_VRING_BASE:
276 /* send back vring base to qemu */
277 msg.flags |= VHOST_USER_REPLY_MASK;
278 msg.size = sizeof(m.payload.state);
279 msg.payload.state.num = 0;
280 p = (uint8_t *) &msg;
281 qemu_chr_fe_write_all(chr, p, VHOST_USER_HDR_SIZE + msg.size);
283 assert(msg.payload.state.index < 2);
284 s->rings &= ~(0x1ULL << msg.payload.state.index);
285 break;
287 case VHOST_USER_SET_MEM_TABLE:
288 /* received the mem table */
289 memcpy(&s->memory, &msg.payload.memory, sizeof(msg.payload.memory));
290 s->fds_num = qemu_chr_fe_get_msgfds(chr, s->fds, G_N_ELEMENTS(s->fds));
292 /* signal the test that it can continue */
293 g_cond_signal(&s->data_cond);
294 break;
296 case VHOST_USER_SET_VRING_KICK:
297 case VHOST_USER_SET_VRING_CALL:
298 /* consume the fd */
299 qemu_chr_fe_get_msgfds(chr, &fd, 1);
301 * This is a non-blocking eventfd.
302 * The receive function forces it to be blocking,
303 * so revert it back to non-blocking.
305 qemu_set_nonblock(fd);
306 break;
308 case VHOST_USER_SET_LOG_BASE:
309 if (s->log_fd != -1) {
310 close(s->log_fd);
311 s->log_fd = -1;
313 qemu_chr_fe_get_msgfds(chr, &s->log_fd, 1);
314 msg.flags |= VHOST_USER_REPLY_MASK;
315 msg.size = 0;
316 p = (uint8_t *) &msg;
317 qemu_chr_fe_write_all(chr, p, VHOST_USER_HDR_SIZE);
319 g_cond_signal(&s->data_cond);
320 break;
322 case VHOST_USER_SET_VRING_BASE:
323 assert(msg.payload.state.index < 2);
324 s->rings |= 0x1ULL << msg.payload.state.index;
325 break;
327 default:
328 break;
331 g_mutex_unlock(&s->data_mutex);
334 static const char *init_hugepagefs(const char *path)
336 struct statfs fs;
337 int ret;
339 if (access(path, R_OK | W_OK | X_OK)) {
340 g_test_message("access on path (%s): %s\n", path, strerror(errno));
341 return NULL;
344 do {
345 ret = statfs(path, &fs);
346 } while (ret != 0 && errno == EINTR);
348 if (ret != 0) {
349 g_test_message("statfs on path (%s): %s\n", path, strerror(errno));
350 return NULL;
353 if (fs.f_type != HUGETLBFS_MAGIC) {
354 g_test_message("Warning: path not on HugeTLBFS: %s\n", path);
355 return NULL;
358 return path;
361 static TestServer *test_server_new(const gchar *name)
363 TestServer *server = g_new0(TestServer, 1);
364 gchar *chr_path;
366 server->socket_path = g_strdup_printf("%s/%s.sock", tmpfs, name);
367 server->mig_path = g_strdup_printf("%s/%s.mig", tmpfs, name);
369 chr_path = g_strdup_printf("unix:%s,server,nowait", server->socket_path);
370 server->chr_name = g_strdup_printf("chr-%s", name);
371 server->chr = qemu_chr_new(server->chr_name, chr_path, NULL);
372 g_free(chr_path);
374 qemu_chr_add_handlers(server->chr, chr_can_read, chr_read, NULL, server);
376 g_mutex_init(&server->data_mutex);
377 g_cond_init(&server->data_cond);
379 server->log_fd = -1;
381 return server;
384 #define GET_QEMU_CMD(s) \
385 g_strdup_printf(QEMU_CMD, 512, 512, (root), (s)->chr_name, \
386 (s)->socket_path, (s)->chr_name)
388 #define GET_QEMU_CMDE(s, mem, extra, ...) \
389 g_strdup_printf(QEMU_CMD extra, (mem), (mem), (root), (s)->chr_name, \
390 (s)->socket_path, (s)->chr_name, ##__VA_ARGS__)
392 static gboolean _test_server_free(TestServer *server)
394 int i;
396 qemu_chr_delete(server->chr);
398 for (i = 0; i < server->fds_num; i++) {
399 close(server->fds[i]);
402 if (server->log_fd != -1) {
403 close(server->log_fd);
406 unlink(server->socket_path);
407 g_free(server->socket_path);
409 unlink(server->mig_path);
410 g_free(server->mig_path);
412 g_free(server->chr_name);
413 g_free(server);
415 return FALSE;
418 static void test_server_free(TestServer *server)
420 g_idle_add((GSourceFunc)_test_server_free, server);
423 static void wait_for_log_fd(TestServer *s)
425 gint64 end_time;
427 g_mutex_lock(&s->data_mutex);
428 end_time = g_get_monotonic_time() + 5 * G_TIME_SPAN_SECOND;
429 while (s->log_fd == -1) {
430 if (!g_cond_wait_until(&s->data_cond, &s->data_mutex, end_time)) {
431 /* timeout has passed */
432 g_assert(s->log_fd != -1);
433 break;
437 g_mutex_unlock(&s->data_mutex);
440 static void write_guest_mem(TestServer *s, uint32_t seed)
442 uint32_t *guest_mem;
443 int i, j;
444 size_t size;
446 wait_for_fds(s);
448 /* iterate all regions */
449 for (i = 0; i < s->fds_num; i++) {
451 /* We'll write only the region statring at 0x0 */
452 if (s->memory.regions[i].guest_phys_addr != 0x0) {
453 continue;
456 g_assert_cmpint(s->memory.regions[i].memory_size, >, 1024);
458 size = s->memory.regions[i].memory_size +
459 s->memory.regions[i].mmap_offset;
461 guest_mem = mmap(0, size, PROT_READ | PROT_WRITE,
462 MAP_SHARED, s->fds[i], 0);
464 g_assert(guest_mem != MAP_FAILED);
465 guest_mem += (s->memory.regions[i].mmap_offset / sizeof(*guest_mem));
467 for (j = 0; j < 256; j++) {
468 guest_mem[j] = seed + j;
471 munmap(guest_mem, s->memory.regions[i].memory_size);
472 break;
476 static guint64 get_log_size(TestServer *s)
478 guint64 log_size = 0;
479 int i;
481 for (i = 0; i < s->memory.nregions; ++i) {
482 VhostUserMemoryRegion *reg = &s->memory.regions[i];
483 guint64 last = range_get_last(reg->guest_phys_addr,
484 reg->memory_size);
485 log_size = MAX(log_size, last / (8 * VHOST_LOG_PAGE) + 1);
488 return log_size;
491 typedef struct TestMigrateSource {
492 GSource source;
493 TestServer *src;
494 TestServer *dest;
495 } TestMigrateSource;
497 static gboolean
498 test_migrate_source_check(GSource *source)
500 TestMigrateSource *t = (TestMigrateSource *)source;
501 gboolean overlap = t->src->rings && t->dest->rings;
503 g_assert(!overlap);
505 return FALSE;
508 #if !GLIB_CHECK_VERSION(2,36,0)
509 /* this callback is unnecessary with glib >2.36, the default
510 * prepare for the source does the same */
511 static gboolean
512 test_migrate_source_prepare(GSource *source, gint *timeout)
514 *timeout = -1;
515 return FALSE;
517 #endif
519 GSourceFuncs test_migrate_source_funcs = {
520 #if !GLIB_CHECK_VERSION(2,36,0)
521 .prepare = test_migrate_source_prepare,
522 #endif
523 .check = test_migrate_source_check,
526 static void test_migrate(void)
528 TestServer *s = test_server_new("src");
529 TestServer *dest = test_server_new("dest");
530 char *uri = g_strdup_printf("%s%s", "unix:", dest->mig_path);
531 QTestState *global = global_qtest, *from, *to;
532 GSource *source;
533 gchar *cmd;
534 QDict *rsp;
535 guint8 *log;
536 guint64 size;
538 cmd = GET_QEMU_CMDE(s, 2, "");
539 from = qtest_start(cmd);
540 g_free(cmd);
542 wait_for_fds(s);
543 size = get_log_size(s);
544 g_assert_cmpint(size, ==, (2 * 1024 * 1024) / (VHOST_LOG_PAGE * 8));
546 cmd = GET_QEMU_CMDE(dest, 2, " -incoming %s", uri);
547 to = qtest_init(cmd);
548 g_free(cmd);
550 source = g_source_new(&test_migrate_source_funcs,
551 sizeof(TestMigrateSource));
552 ((TestMigrateSource *)source)->src = s;
553 ((TestMigrateSource *)source)->dest = dest;
554 g_source_attach(source, NULL);
556 /* slow down migration to have time to fiddle with log */
557 /* TODO: qtest could learn to break on some places */
558 rsp = qmp("{ 'execute': 'migrate_set_speed',"
559 "'arguments': { 'value': 10 } }");
560 g_assert(qdict_haskey(rsp, "return"));
561 QDECREF(rsp);
563 cmd = g_strdup_printf("{ 'execute': 'migrate',"
564 "'arguments': { 'uri': '%s' } }",
565 uri);
566 rsp = qmp(cmd);
567 g_free(cmd);
568 g_assert(qdict_haskey(rsp, "return"));
569 QDECREF(rsp);
571 wait_for_log_fd(s);
573 log = mmap(0, size, PROT_READ | PROT_WRITE, MAP_SHARED, s->log_fd, 0);
574 g_assert(log != MAP_FAILED);
576 /* modify first page */
577 write_guest_mem(s, 0x42);
578 log[0] = 1;
579 munmap(log, size);
581 /* speed things up */
582 rsp = qmp("{ 'execute': 'migrate_set_speed',"
583 "'arguments': { 'value': 0 } }");
584 g_assert(qdict_haskey(rsp, "return"));
585 QDECREF(rsp);
587 qmp_eventwait("STOP");
589 global_qtest = to;
590 qmp_eventwait("RESUME");
592 read_guest_mem(dest);
594 g_source_destroy(source);
595 g_source_unref(source);
597 qtest_quit(to);
598 test_server_free(dest);
599 qtest_quit(from);
600 test_server_free(s);
601 g_free(uri);
603 global_qtest = global;
606 int main(int argc, char **argv)
608 QTestState *s = NULL;
609 TestServer *server = NULL;
610 const char *hugefs;
611 char *qemu_cmd = NULL;
612 int ret;
613 char template[] = "/tmp/vhost-test-XXXXXX";
614 GMainLoop *loop;
615 GThread *thread;
617 g_test_init(&argc, &argv, NULL);
619 module_call_init(MODULE_INIT_QOM);
620 qemu_add_opts(&qemu_chardev_opts);
622 tmpfs = mkdtemp(template);
623 if (!tmpfs) {
624 g_test_message("mkdtemp on path (%s): %s\n", template, strerror(errno));
626 g_assert(tmpfs);
628 hugefs = getenv("QTEST_HUGETLBFS_PATH");
629 if (hugefs) {
630 root = init_hugepagefs(hugefs);
631 g_assert(root);
632 } else {
633 root = tmpfs;
636 server = test_server_new("test");
638 loop = g_main_loop_new(NULL, FALSE);
639 /* run the main loop thread so the chardev may operate */
640 thread = g_thread_new(NULL, thread_function, loop);
642 qemu_cmd = GET_QEMU_CMD(server);
644 s = qtest_start(qemu_cmd);
645 g_free(qemu_cmd);
647 qtest_add_data_func("/vhost-user/read-guest-mem", server, read_guest_mem);
648 qtest_add_func("/vhost-user/migrate", test_migrate);
650 ret = g_test_run();
652 if (s) {
653 qtest_quit(s);
656 /* cleanup */
657 test_server_free(server);
659 /* finish the helper thread and dispatch pending sources */
660 g_main_loop_quit(loop);
661 g_thread_join(thread);
662 while (g_main_context_pending(NULL)) {
663 g_main_context_iteration (NULL, TRUE);
665 g_main_loop_unref(loop);
667 ret = rmdir(tmpfs);
668 if (ret != 0) {
669 g_test_message("unable to rmdir: path (%s): %s\n",
670 tmpfs, strerror(errno));
672 g_assert_cmpint(ret, ==, 0);
674 return ret;