2 * QTest testcase for migration
4 * Copyright (c) 2016-2018 Red Hat, Inc. and/or its affiliates
5 * based on the vhost-user-test.c that is:
6 * Copyright (c) 2014 Virtual Open Systems Sarl.
8 * This work is licensed under the terms of the GNU GPL, version 2 or later.
9 * See the COPYING file in the top-level directory.
13 #include "qemu/osdep.h"
16 #include "qapi/qmp/qdict.h"
17 #include "qapi/qmp/qjson.h"
18 #include "qemu/option.h"
19 #include "qemu/range.h"
20 #include "qemu/sockets.h"
21 #include "chardev/char.h"
22 #include "sysemu/sysemu.h"
24 #include "migration/migration-test.h"
26 /* TODO actually test the results and get rid of this */
27 #define qtest_qmp_discard_response(...) qobject_unref(qtest_qmp(__VA_ARGS__))
29 unsigned start_address
;
32 static bool uffd_feature_thread_id
;
34 #if defined(__linux__)
35 #include <sys/syscall.h>
39 #if defined(__linux__) && defined(__NR_userfaultfd) && defined(CONFIG_EVENTFD)
40 #include <sys/eventfd.h>
41 #include <sys/ioctl.h>
42 #include <linux/userfaultfd.h>
44 static bool ufd_version_check(void)
46 struct uffdio_api api_struct
;
49 int ufd
= syscall(__NR_userfaultfd
, O_CLOEXEC
);
52 g_test_message("Skipping test: userfaultfd not available");
56 api_struct
.api
= UFFD_API
;
57 api_struct
.features
= 0;
58 if (ioctl(ufd
, UFFDIO_API
, &api_struct
)) {
59 g_test_message("Skipping test: UFFDIO_API failed");
62 uffd_feature_thread_id
= api_struct
.features
& UFFD_FEATURE_THREAD_ID
;
64 ioctl_mask
= (__u64
)1 << _UFFDIO_REGISTER
|
65 (__u64
)1 << _UFFDIO_UNREGISTER
;
66 if ((api_struct
.ioctls
& ioctl_mask
) != ioctl_mask
) {
67 g_test_message("Skipping test: Missing userfault feature");
75 static bool ufd_version_check(void)
77 g_test_message("Skipping test: Userfault not available (builtdtime)");
83 static const char *tmpfs
;
85 /* The boot file modifies memory area in [start_address, end_address)
86 * repeatedly. It outputs a 'B' at a fixed rate while it's still running.
88 #include "tests/migration/i386/a-b-bootblock.h"
89 #include "tests/migration/aarch64/a-b-kernel.h"
91 static void init_bootfile(const char *bootpath
, void *content
)
93 FILE *bootfile
= fopen(bootpath
, "wb");
95 g_assert_cmpint(fwrite(content
, 512, 1, bootfile
), ==, 1);
99 #include "tests/migration/s390x/a-b-bios.h"
101 static void init_bootfile_s390x(const char *bootpath
)
103 FILE *bootfile
= fopen(bootpath
, "wb");
104 size_t len
= sizeof(s390x_elf
);
106 g_assert_cmpint(fwrite(s390x_elf
, len
, 1, bootfile
), ==, 1);
111 * Wait for some output in the serial output file,
112 * we get an 'A' followed by an endless string of 'B's
113 * but on the destination we won't have the A.
115 static void wait_for_serial(const char *side
)
117 char *serialpath
= g_strdup_printf("%s/%s", tmpfs
, side
);
118 FILE *serialfile
= fopen(serialpath
, "r");
119 const char *arch
= qtest_get_arch();
120 int started
= (strcmp(side
, "src_serial") == 0 &&
121 strcmp(arch
, "ppc64") == 0) ? 0 : 1;
125 int readvalue
= fgetc(serialfile
);
128 /* SLOF prints its banner before starting test,
129 * to ignore it, mark the start of the test with '_',
130 * ignore all characters until this marker
137 fseek(serialfile
, 0, SEEK_SET
);
154 started
= (strcmp(side
, "src_serial") == 0 &&
155 strcmp(arch
, "ppc64") == 0) ? 0 : 1;
156 fseek(serialfile
, 0, SEEK_SET
);
161 fprintf(stderr
, "Unexpected %d on %s serial\n", readvalue
, side
);
162 g_assert_not_reached();
167 static void stop_cb(void *opaque
, const char *name
, QDict
*data
)
169 if (!strcmp(name
, "STOP")) {
175 * Events can get in the way of responses we are actually waiting for.
178 static QDict
*wait_command(QTestState
*who
, const char *command
, ...)
182 va_start(ap
, command
);
183 qtest_qmp_vsend(who
, command
, ap
);
186 return qtest_qmp_receive_success(who
, stop_cb
, NULL
);
190 * Note: caller is responsible to free the returned object via
191 * qobject_unref() after use
193 static QDict
*migrate_query(QTestState
*who
)
195 return wait_command(who
, "{ 'execute': 'query-migrate' }");
199 * Note: caller is responsible to free the returned object via
202 static gchar
*migrate_query_status(QTestState
*who
)
204 QDict
*rsp_return
= migrate_query(who
);
205 gchar
*status
= g_strdup(qdict_get_str(rsp_return
, "status"));
208 qobject_unref(rsp_return
);
214 * It's tricky to use qemu's migration event capability with qtest,
215 * events suddenly appearing confuse the qmp()/hmp() responses.
218 static uint64_t get_migration_pass(QTestState
*who
)
220 QDict
*rsp_return
, *rsp_ram
;
223 rsp_return
= migrate_query(who
);
224 if (!qdict_haskey(rsp_return
, "ram")) {
228 rsp_ram
= qdict_get_qdict(rsp_return
, "ram");
229 result
= qdict_get_try_int(rsp_ram
, "dirty-sync-count", 0);
231 qobject_unref(rsp_return
);
235 static void read_blocktime(QTestState
*who
)
239 rsp_return
= migrate_query(who
);
240 g_assert(qdict_haskey(rsp_return
, "postcopy-blocktime"));
241 qobject_unref(rsp_return
);
244 static void wait_for_migration_status(QTestState
*who
,
251 status
= migrate_query_status(who
);
252 completed
= strcmp(status
, goal
) == 0;
253 g_assert_cmpstr(status
, !=, "failed");
262 static void wait_for_migration_complete(QTestState
*who
)
264 wait_for_migration_status(who
, "completed");
267 static void wait_for_migration_pass(QTestState
*who
)
269 uint64_t initial_pass
= get_migration_pass(who
);
272 /* Wait for the 1st sync */
273 while (!got_stop
&& !initial_pass
) {
275 initial_pass
= get_migration_pass(who
);
280 pass
= get_migration_pass(who
);
281 } while (pass
== initial_pass
&& !got_stop
);
284 static void check_guests_ram(QTestState
*who
)
286 /* Our ASM test will have been incrementing one byte from each page from
287 * start_address to < end_address in order. This gives us a constraint
288 * that any page's byte should be equal or less than the previous pages
289 * byte (mod 256); and they should all be equal except for one transition
290 * at the point where we meet the incrementer. (We're running this with
291 * the guest stopped).
296 bool hit_edge
= false;
299 qtest_memread(who
, start_address
, &first_byte
, 1);
300 last_byte
= first_byte
;
302 for (address
= start_address
+ TEST_MEM_PAGE_SIZE
; address
< end_address
;
303 address
+= TEST_MEM_PAGE_SIZE
)
306 qtest_memread(who
, address
, &b
, 1);
307 if (b
!= last_byte
) {
308 if (((b
+ 1) % 256) == last_byte
&& !hit_edge
) {
309 /* This is OK, the guest stopped at the point of
310 * incrementing the previous page but didn't get
316 fprintf(stderr
, "Memory content inconsistency at %x"
317 " first_byte = %x last_byte = %x current = %x"
319 address
, first_byte
, last_byte
, b
, hit_edge
);
327 static void cleanup(const char *filename
)
329 char *path
= g_strdup_printf("%s/%s", tmpfs
, filename
);
335 static void migrate_check_parameter(QTestState
*who
, const char *parameter
,
340 rsp_return
= wait_command(who
,
341 "{ 'execute': 'query-migrate-parameters' }");
342 g_assert_cmpint(qdict_get_int(rsp_return
, parameter
), ==, value
);
343 qobject_unref(rsp_return
);
346 static void migrate_set_parameter(QTestState
*who
, const char *parameter
,
352 "{ 'execute': 'migrate-set-parameters',"
353 "'arguments': { %s: %lld } }",
355 g_assert(qdict_haskey(rsp
, "return"));
357 migrate_check_parameter(who
, parameter
, value
);
360 static void migrate_pause(QTestState
*who
)
364 rsp
= wait_command(who
, "{ 'execute': 'migrate-pause' }");
368 static void migrate_recover(QTestState
*who
, const char *uri
)
372 rsp
= wait_command(who
,
373 "{ 'execute': 'migrate-recover', "
374 " 'id': 'recover-cmd', "
375 " 'arguments': { 'uri': %s } }",
380 static void migrate_set_capability(QTestState
*who
, const char *capability
,
386 "{ 'execute': 'migrate-set-capabilities',"
388 "'capabilities': [ { "
389 "'capability': %s, 'state': %i } ] } }",
391 g_assert(qdict_haskey(rsp
, "return"));
396 * Send QMP command "migrate".
397 * Arguments are built from @fmt... (formatted like
398 * qobject_from_jsonf_nofail()) with "uri": @uri spliced in.
401 static void migrate(QTestState
*who
, const char *uri
, const char *fmt
, ...)
407 args
= qdict_from_vjsonf_nofail(fmt
, ap
);
410 g_assert(!qdict_haskey(args
, "uri"));
411 qdict_put_str(args
, "uri", uri
);
413 rsp
= qmp("{ 'execute': 'migrate', 'arguments': %p}", args
);
414 g_assert(qdict_haskey(rsp
, "return"));
418 static void migrate_postcopy_start(QTestState
*from
, QTestState
*to
)
422 rsp
= wait_command(from
, "{ 'execute': 'migrate-start-postcopy' }");
426 qtest_qmp_eventwait(from
, "STOP");
429 qtest_qmp_eventwait(to
, "RESUME");
432 static int test_migrate_start(QTestState
**from
, QTestState
**to
,
433 const char *uri
, bool hide_stderr
)
435 gchar
*cmd_src
, *cmd_dst
;
436 char *bootpath
= g_strdup_printf("%s/bootsect", tmpfs
);
437 const char *arch
= qtest_get_arch();
438 const char *accel
= "kvm:tcg";
442 if (strcmp(arch
, "i386") == 0 || strcmp(arch
, "x86_64") == 0) {
443 init_bootfile(bootpath
, x86_bootsect
);
444 cmd_src
= g_strdup_printf("-machine accel=%s -m 150M"
445 " -name source,debug-threads=on"
446 " -serial file:%s/src_serial"
447 " -drive file=%s,format=raw",
448 accel
, tmpfs
, bootpath
);
449 cmd_dst
= g_strdup_printf("-machine accel=%s -m 150M"
450 " -name target,debug-threads=on"
451 " -serial file:%s/dest_serial"
452 " -drive file=%s,format=raw"
454 accel
, tmpfs
, bootpath
, uri
);
455 start_address
= X86_TEST_MEM_START
;
456 end_address
= X86_TEST_MEM_END
;
457 } else if (g_str_equal(arch
, "s390x")) {
458 init_bootfile_s390x(bootpath
);
459 cmd_src
= g_strdup_printf("-machine accel=%s -m 128M"
460 " -name source,debug-threads=on"
461 " -serial file:%s/src_serial -bios %s",
462 accel
, tmpfs
, bootpath
);
463 cmd_dst
= g_strdup_printf("-machine accel=%s -m 128M"
464 " -name target,debug-threads=on"
465 " -serial file:%s/dest_serial -bios %s"
467 accel
, tmpfs
, bootpath
, uri
);
468 start_address
= S390_TEST_MEM_START
;
469 end_address
= S390_TEST_MEM_END
;
470 } else if (strcmp(arch
, "ppc64") == 0) {
471 cmd_src
= g_strdup_printf("-machine accel=%s -m 256M -nodefaults"
472 " -name source,debug-threads=on"
473 " -serial file:%s/src_serial"
474 " -prom-env 'use-nvramrc?=true' -prom-env "
475 "'nvramrc=hex .\" _\" begin %x %x "
476 "do i c@ 1 + i c! 1000 +loop .\" B\" 0 "
477 "until'", accel
, tmpfs
, end_address
,
479 cmd_dst
= g_strdup_printf("-machine accel=%s -m 256M"
480 " -name target,debug-threads=on"
481 " -serial file:%s/dest_serial"
485 start_address
= PPC_TEST_MEM_START
;
486 end_address
= PPC_TEST_MEM_END
;
487 } else if (strcmp(arch
, "aarch64") == 0) {
488 init_bootfile(bootpath
, aarch64_kernel
);
489 cmd_src
= g_strdup_printf("-machine virt,accel=%s,gic-version=max "
490 "-name vmsource,debug-threads=on -cpu max "
491 "-m 150M -serial file:%s/src_serial "
493 accel
, tmpfs
, bootpath
);
494 cmd_dst
= g_strdup_printf("-machine virt,accel=%s,gic-version=max "
495 "-name vmdest,debug-threads=on -cpu max "
496 "-m 150M -serial file:%s/dest_serial "
499 accel
, tmpfs
, bootpath
, uri
);
501 start_address
= ARM_TEST_MEM_START
;
502 end_address
= ARM_TEST_MEM_END
;
504 g_assert(sizeof(aarch64_kernel
) <= ARM_TEST_MAX_KERNEL_SIZE
);
506 g_assert_not_reached();
513 tmp
= g_strdup_printf("%s 2>/dev/null", cmd_src
);
517 tmp
= g_strdup_printf("%s 2>/dev/null", cmd_dst
);
522 *from
= qtest_start(cmd_src
);
525 *to
= qtest_init(cmd_dst
);
530 static void test_migrate_end(QTestState
*from
, QTestState
*to
, bool test_dest
)
532 unsigned char dest_byte_a
, dest_byte_b
, dest_byte_c
, dest_byte_d
;
537 qtest_memread(to
, start_address
, &dest_byte_a
, 1);
539 /* Destination still running, wait for a byte to change */
541 qtest_memread(to
, start_address
, &dest_byte_b
, 1);
543 } while (dest_byte_a
== dest_byte_b
);
545 qtest_qmp_discard_response(to
, "{ 'execute' : 'stop'}");
547 /* With it stopped, check nothing changes */
548 qtest_memread(to
, start_address
, &dest_byte_c
, 1);
550 qtest_memread(to
, start_address
, &dest_byte_d
, 1);
551 g_assert_cmpint(dest_byte_c
, ==, dest_byte_d
);
553 check_guests_ram(to
);
559 cleanup("migsocket");
560 cleanup("src_serial");
561 cleanup("dest_serial");
564 static void deprecated_set_downtime(QTestState
*who
, const double value
)
569 "{ 'execute': 'migrate_set_downtime',"
570 " 'arguments': { 'value': %f } }", value
);
571 g_assert(qdict_haskey(rsp
, "return"));
573 migrate_check_parameter(who
, "downtime-limit", value
* 1000);
576 static void deprecated_set_speed(QTestState
*who
, long long value
)
580 rsp
= qtest_qmp(who
, "{ 'execute': 'migrate_set_speed',"
581 "'arguments': { 'value': %lld } }", value
);
582 g_assert(qdict_haskey(rsp
, "return"));
584 migrate_check_parameter(who
, "max-bandwidth", value
);
587 static void test_deprecated(void)
591 from
= qtest_start("-machine none");
593 deprecated_set_downtime(from
, 0.12345);
594 deprecated_set_speed(from
, 12345);
599 static int migrate_postcopy_prepare(QTestState
**from_ptr
,
603 char *uri
= g_strdup_printf("unix:%s/migsocket", tmpfs
);
604 QTestState
*from
, *to
;
606 if (test_migrate_start(&from
, &to
, uri
, hide_error
)) {
610 migrate_set_capability(from
, "postcopy-ram", true);
611 migrate_set_capability(to
, "postcopy-ram", true);
612 migrate_set_capability(to
, "postcopy-blocktime", true);
614 /* We want to pick a speed slow enough that the test completes
615 * quickly, but that it doesn't complete precopy even on a slow
616 * machine, so also set the downtime.
618 migrate_set_parameter(from
, "max-bandwidth", 100000000);
619 migrate_set_parameter(from
, "downtime-limit", 1);
621 /* Wait for the first serial output from the source */
622 wait_for_serial("src_serial");
624 migrate(from
, uri
, "{}");
627 wait_for_migration_pass(from
);
635 static void migrate_postcopy_complete(QTestState
*from
, QTestState
*to
)
637 wait_for_migration_complete(from
);
639 /* Make sure we get at least one "B" on destination */
640 wait_for_serial("dest_serial");
642 if (uffd_feature_thread_id
) {
646 test_migrate_end(from
, to
, true);
649 static void test_postcopy(void)
651 QTestState
*from
, *to
;
653 if (migrate_postcopy_prepare(&from
, &to
, false)) {
656 migrate_postcopy_start(from
, to
);
657 migrate_postcopy_complete(from
, to
);
660 static void test_postcopy_recovery(void)
662 QTestState
*from
, *to
;
665 if (migrate_postcopy_prepare(&from
, &to
, true)) {
669 /* Turn postcopy speed down, 4K/s is slow enough on any machines */
670 migrate_set_parameter(from
, "max-postcopy-bandwidth", 4096);
672 /* Now we start the postcopy */
673 migrate_postcopy_start(from
, to
);
676 * Wait until postcopy is really started; we can only run the
677 * migrate-pause command during a postcopy
679 wait_for_migration_status(from
, "postcopy-active");
682 * Manually stop the postcopy migration. This emulates a network
683 * failure with the migration socket
688 * Wait for destination side to reach postcopy-paused state. The
689 * migrate-recover command can only succeed if destination machine
690 * is in the paused state
692 wait_for_migration_status(to
, "postcopy-paused");
695 * Create a new socket to emulate a new channel that is different
696 * from the broken migration channel; tell the destination to
697 * listen to the new port
699 uri
= g_strdup_printf("unix:%s/migsocket-recover", tmpfs
);
700 migrate_recover(to
, uri
);
703 * Try to rebuild the migration channel using the resume flag and
704 * the newly created channel
706 wait_for_migration_status(from
, "postcopy-paused");
707 migrate(from
, uri
, "{'resume': true}");
710 /* Restore the postcopy bandwidth to unlimited */
711 migrate_set_parameter(from
, "max-postcopy-bandwidth", 0);
713 migrate_postcopy_complete(from
, to
);
716 static void test_baddest(void)
718 QTestState
*from
, *to
;
723 if (test_migrate_start(&from
, &to
, "tcp:0:0", true)) {
726 migrate(from
, "tcp:0:0", "{}");
728 status
= migrate_query_status(from
);
729 g_assert(!strcmp(status
, "setup") || !(strcmp(status
, "failed")));
730 failed
= !strcmp(status
, "failed");
734 /* Is the machine currently running? */
735 rsp_return
= wait_command(from
, "{ 'execute': 'query-status' }");
736 g_assert(qdict_haskey(rsp_return
, "running"));
737 g_assert(qdict_get_bool(rsp_return
, "running"));
738 qobject_unref(rsp_return
);
740 test_migrate_end(from
, to
, false);
743 static void test_precopy_unix(void)
745 char *uri
= g_strdup_printf("unix:%s/migsocket", tmpfs
);
746 QTestState
*from
, *to
;
748 if (test_migrate_start(&from
, &to
, uri
, false)) {
752 /* We want to pick a speed slow enough that the test completes
753 * quickly, but that it doesn't complete precopy even on a slow
754 * machine, so also set the downtime.
756 /* 1 ms should make it not converge*/
757 migrate_set_parameter(from
, "downtime-limit", 1);
759 migrate_set_parameter(from
, "max-bandwidth", 1000000000);
761 /* Wait for the first serial output from the source */
762 wait_for_serial("src_serial");
764 migrate(from
, uri
, "{}");
766 wait_for_migration_pass(from
);
768 /* 300 ms should converge */
769 migrate_set_parameter(from
, "downtime-limit", 300);
772 qtest_qmp_eventwait(from
, "STOP");
775 qtest_qmp_eventwait(to
, "RESUME");
777 wait_for_serial("dest_serial");
778 wait_for_migration_complete(from
);
780 test_migrate_end(from
, to
, true);
784 int main(int argc
, char **argv
)
786 char template[] = "/tmp/migration-test-XXXXXX";
789 g_test_init(&argc
, &argv
, NULL
);
791 if (!ufd_version_check()) {
796 * On ppc64, the test only works with kvm-hv, but not with kvm-pr and TCG
797 * is touchy due to race conditions on dirty bits (especially on PPC for
800 if (g_str_equal(qtest_get_arch(), "ppc64") &&
801 access("/sys/module/kvm_hv", F_OK
)) {
802 g_test_message("Skipping test: kvm_hv not available");
806 tmpfs
= mkdtemp(template);
808 g_test_message("mkdtemp on path (%s): %s\n", template, strerror(errno
));
812 module_call_init(MODULE_INIT_QOM
);
814 qtest_add_func("/migration/postcopy/unix", test_postcopy
);
815 qtest_add_func("/migration/postcopy/recovery", test_postcopy_recovery
);
816 qtest_add_func("/migration/deprecated", test_deprecated
);
817 qtest_add_func("/migration/bad_dest", test_baddest
);
818 qtest_add_func("/migration/precopy/unix", test_precopy_unix
);
822 g_assert_cmpint(ret
, ==, 0);
826 g_test_message("unable to rmdir: path (%s): %s\n",
827 tmpfs
, strerror(errno
));