xref: /openbmc/qemu/tests/qtest/migration-test.c (revision 701bff24)
1 /*
2  * QTest testcase for migration
3  *
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.
7  *
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.
10  *
11  */
12 
13 #include "qemu/osdep.h"
14 
15 #include "libqtest.h"
16 #include "qapi/error.h"
17 #include "qapi/qmp/qdict.h"
18 #include "qemu/module.h"
19 #include "qemu/option.h"
20 #include "qemu/range.h"
21 #include "qemu/sockets.h"
22 #include "chardev/char.h"
23 #include "qapi/qapi-visit-sockets.h"
24 #include "qapi/qobject-input-visitor.h"
25 #include "qapi/qobject-output-visitor.h"
26 #include "crypto/tlscredspsk.h"
27 #include "qapi/qmp/qlist.h"
28 
29 #include "migration-helpers.h"
30 #include "tests/migration/migration-test.h"
31 #ifdef CONFIG_GNUTLS
32 # include "tests/unit/crypto-tls-psk-helpers.h"
33 # ifdef CONFIG_TASN1
34 #  include "tests/unit/crypto-tls-x509-helpers.h"
35 # endif /* CONFIG_TASN1 */
36 #endif /* CONFIG_GNUTLS */
37 
38 /* For dirty ring test; so far only x86_64 is supported */
39 #if defined(__linux__) && defined(HOST_X86_64)
40 #include "linux/kvm.h"
41 #endif
42 
43 /* TODO actually test the results and get rid of this */
44 #define qtest_qmp_discard_response(...) qobject_unref(qtest_qmp(__VA_ARGS__))
45 
46 unsigned start_address;
47 unsigned end_address;
48 static bool uffd_feature_thread_id;
49 
50 /*
51  * Dirtylimit stop working if dirty page rate error
52  * value less than DIRTYLIMIT_TOLERANCE_RANGE
53  */
54 #define DIRTYLIMIT_TOLERANCE_RANGE  25  /* MB/s */
55 
56 #if defined(__linux__)
57 #include <sys/syscall.h>
58 #include <sys/vfs.h>
59 #endif
60 
61 #if defined(__linux__) && defined(__NR_userfaultfd) && defined(CONFIG_EVENTFD)
62 #include <sys/eventfd.h>
63 #include <sys/ioctl.h>
64 #include <linux/userfaultfd.h>
65 
66 static bool ufd_version_check(void)
67 {
68     struct uffdio_api api_struct;
69     uint64_t ioctl_mask;
70 
71     int ufd = syscall(__NR_userfaultfd, O_CLOEXEC);
72 
73     if (ufd == -1) {
74         g_test_message("Skipping test: userfaultfd not available");
75         return false;
76     }
77 
78     api_struct.api = UFFD_API;
79     api_struct.features = 0;
80     if (ioctl(ufd, UFFDIO_API, &api_struct)) {
81         g_test_message("Skipping test: UFFDIO_API failed");
82         return false;
83     }
84     uffd_feature_thread_id = api_struct.features & UFFD_FEATURE_THREAD_ID;
85 
86     ioctl_mask = (__u64)1 << _UFFDIO_REGISTER |
87                  (__u64)1 << _UFFDIO_UNREGISTER;
88     if ((api_struct.ioctls & ioctl_mask) != ioctl_mask) {
89         g_test_message("Skipping test: Missing userfault feature");
90         return false;
91     }
92 
93     return true;
94 }
95 
96 #else
97 static bool ufd_version_check(void)
98 {
99     g_test_message("Skipping test: Userfault not available (builtdtime)");
100     return false;
101 }
102 
103 #endif
104 
105 static char *tmpfs;
106 
107 /* The boot file modifies memory area in [start_address, end_address)
108  * repeatedly. It outputs a 'B' at a fixed rate while it's still running.
109  */
110 #include "tests/migration/i386/a-b-bootblock.h"
111 #include "tests/migration/aarch64/a-b-kernel.h"
112 #include "tests/migration/s390x/a-b-bios.h"
113 
114 static void init_bootfile(const char *bootpath, void *content, size_t len)
115 {
116     FILE *bootfile = fopen(bootpath, "wb");
117 
118     g_assert_cmpint(fwrite(content, len, 1, bootfile), ==, 1);
119     fclose(bootfile);
120 }
121 
122 /*
123  * Wait for some output in the serial output file,
124  * we get an 'A' followed by an endless string of 'B's
125  * but on the destination we won't have the A.
126  */
127 static void wait_for_serial(const char *side)
128 {
129     g_autofree char *serialpath = g_strdup_printf("%s/%s", tmpfs, side);
130     FILE *serialfile = fopen(serialpath, "r");
131     const char *arch = qtest_get_arch();
132     int started = (strcmp(side, "src_serial") == 0 &&
133                    strcmp(arch, "ppc64") == 0) ? 0 : 1;
134 
135     do {
136         int readvalue = fgetc(serialfile);
137 
138         if (!started) {
139             /* SLOF prints its banner before starting test,
140              * to ignore it, mark the start of the test with '_',
141              * ignore all characters until this marker
142              */
143             switch (readvalue) {
144             case '_':
145                 started = 1;
146                 break;
147             case EOF:
148                 fseek(serialfile, 0, SEEK_SET);
149                 usleep(1000);
150                 break;
151             }
152             continue;
153         }
154         switch (readvalue) {
155         case 'A':
156             /* Fine */
157             break;
158 
159         case 'B':
160             /* It's alive! */
161             fclose(serialfile);
162             return;
163 
164         case EOF:
165             started = (strcmp(side, "src_serial") == 0 &&
166                        strcmp(arch, "ppc64") == 0) ? 0 : 1;
167             fseek(serialfile, 0, SEEK_SET);
168             usleep(1000);
169             break;
170 
171         default:
172             fprintf(stderr, "Unexpected %d on %s serial\n", readvalue, side);
173             g_assert_not_reached();
174         }
175     } while (true);
176 }
177 
178 /*
179  * It's tricky to use qemu's migration event capability with qtest,
180  * events suddenly appearing confuse the qmp()/hmp() responses.
181  */
182 
183 static int64_t read_ram_property_int(QTestState *who, const char *property)
184 {
185     QDict *rsp_return, *rsp_ram;
186     int64_t result;
187 
188     rsp_return = migrate_query_not_failed(who);
189     if (!qdict_haskey(rsp_return, "ram")) {
190         /* Still in setup */
191         result = 0;
192     } else {
193         rsp_ram = qdict_get_qdict(rsp_return, "ram");
194         result = qdict_get_try_int(rsp_ram, property, 0);
195     }
196     qobject_unref(rsp_return);
197     return result;
198 }
199 
200 static int64_t read_migrate_property_int(QTestState *who, const char *property)
201 {
202     QDict *rsp_return;
203     int64_t result;
204 
205     rsp_return = migrate_query_not_failed(who);
206     result = qdict_get_try_int(rsp_return, property, 0);
207     qobject_unref(rsp_return);
208     return result;
209 }
210 
211 static uint64_t get_migration_pass(QTestState *who)
212 {
213     return read_ram_property_int(who, "dirty-sync-count");
214 }
215 
216 static void read_blocktime(QTestState *who)
217 {
218     QDict *rsp_return;
219 
220     rsp_return = migrate_query_not_failed(who);
221     g_assert(qdict_haskey(rsp_return, "postcopy-blocktime"));
222     qobject_unref(rsp_return);
223 }
224 
225 static void wait_for_migration_pass(QTestState *who)
226 {
227     uint64_t initial_pass = get_migration_pass(who);
228     uint64_t pass;
229 
230     /* Wait for the 1st sync */
231     while (!got_stop && !initial_pass) {
232         usleep(1000);
233         initial_pass = get_migration_pass(who);
234     }
235 
236     do {
237         usleep(1000);
238         pass = get_migration_pass(who);
239     } while (pass == initial_pass && !got_stop);
240 }
241 
242 static void check_guests_ram(QTestState *who)
243 {
244     /* Our ASM test will have been incrementing one byte from each page from
245      * start_address to < end_address in order. This gives us a constraint
246      * that any page's byte should be equal or less than the previous pages
247      * byte (mod 256); and they should all be equal except for one transition
248      * at the point where we meet the incrementer. (We're running this with
249      * the guest stopped).
250      */
251     unsigned address;
252     uint8_t first_byte;
253     uint8_t last_byte;
254     bool hit_edge = false;
255     int bad = 0;
256 
257     qtest_memread(who, start_address, &first_byte, 1);
258     last_byte = first_byte;
259 
260     for (address = start_address + TEST_MEM_PAGE_SIZE; address < end_address;
261          address += TEST_MEM_PAGE_SIZE)
262     {
263         uint8_t b;
264         qtest_memread(who, address, &b, 1);
265         if (b != last_byte) {
266             if (((b + 1) % 256) == last_byte && !hit_edge) {
267                 /* This is OK, the guest stopped at the point of
268                  * incrementing the previous page but didn't get
269                  * to us yet.
270                  */
271                 hit_edge = true;
272                 last_byte = b;
273             } else {
274                 bad++;
275                 if (bad <= 10) {
276                     fprintf(stderr, "Memory content inconsistency at %x"
277                             " first_byte = %x last_byte = %x current = %x"
278                             " hit_edge = %x\n",
279                             address, first_byte, last_byte, b, hit_edge);
280                 }
281             }
282         }
283     }
284     if (bad >= 10) {
285         fprintf(stderr, "and in another %d pages", bad - 10);
286     }
287     g_assert(bad == 0);
288 }
289 
290 static void cleanup(const char *filename)
291 {
292     g_autofree char *path = g_strdup_printf("%s/%s", tmpfs, filename);
293 
294     unlink(path);
295 }
296 
297 static char *SocketAddress_to_str(SocketAddress *addr)
298 {
299     switch (addr->type) {
300     case SOCKET_ADDRESS_TYPE_INET:
301         return g_strdup_printf("tcp:%s:%s",
302                                addr->u.inet.host,
303                                addr->u.inet.port);
304     case SOCKET_ADDRESS_TYPE_UNIX:
305         return g_strdup_printf("unix:%s",
306                                addr->u.q_unix.path);
307     case SOCKET_ADDRESS_TYPE_FD:
308         return g_strdup_printf("fd:%s", addr->u.fd.str);
309     case SOCKET_ADDRESS_TYPE_VSOCK:
310         return g_strdup_printf("tcp:%s:%s",
311                                addr->u.vsock.cid,
312                                addr->u.vsock.port);
313     default:
314         return g_strdup("unknown address type");
315     }
316 }
317 
318 static char *migrate_get_socket_address(QTestState *who, const char *parameter)
319 {
320     QDict *rsp;
321     char *result;
322     SocketAddressList *addrs;
323     Visitor *iv = NULL;
324     QObject *object;
325 
326     rsp = migrate_query(who);
327     object = qdict_get(rsp, parameter);
328 
329     iv = qobject_input_visitor_new(object);
330     visit_type_SocketAddressList(iv, NULL, &addrs, &error_abort);
331     visit_free(iv);
332 
333     /* we are only using a single address */
334     result = SocketAddress_to_str(addrs->value);
335 
336     qapi_free_SocketAddressList(addrs);
337     qobject_unref(rsp);
338     return result;
339 }
340 
341 static long long migrate_get_parameter_int(QTestState *who,
342                                            const char *parameter)
343 {
344     QDict *rsp;
345     long long result;
346 
347     rsp = wait_command(who, "{ 'execute': 'query-migrate-parameters' }");
348     result = qdict_get_int(rsp, parameter);
349     qobject_unref(rsp);
350     return result;
351 }
352 
353 static void migrate_check_parameter_int(QTestState *who, const char *parameter,
354                                         long long value)
355 {
356     long long result;
357 
358     result = migrate_get_parameter_int(who, parameter);
359     g_assert_cmpint(result, ==, value);
360 }
361 
362 static void migrate_set_parameter_int(QTestState *who, const char *parameter,
363                                       long long value)
364 {
365     QDict *rsp;
366 
367     rsp = qtest_qmp(who,
368                     "{ 'execute': 'migrate-set-parameters',"
369                     "'arguments': { %s: %lld } }",
370                     parameter, value);
371     g_assert(qdict_haskey(rsp, "return"));
372     qobject_unref(rsp);
373     migrate_check_parameter_int(who, parameter, value);
374 }
375 
376 static char *migrate_get_parameter_str(QTestState *who,
377                                        const char *parameter)
378 {
379     QDict *rsp;
380     char *result;
381 
382     rsp = wait_command(who, "{ 'execute': 'query-migrate-parameters' }");
383     result = g_strdup(qdict_get_str(rsp, parameter));
384     qobject_unref(rsp);
385     return result;
386 }
387 
388 static void migrate_check_parameter_str(QTestState *who, const char *parameter,
389                                         const char *value)
390 {
391     g_autofree char *result = migrate_get_parameter_str(who, parameter);
392     g_assert_cmpstr(result, ==, value);
393 }
394 
395 static void migrate_set_parameter_str(QTestState *who, const char *parameter,
396                                       const char *value)
397 {
398     QDict *rsp;
399 
400     rsp = qtest_qmp(who,
401                     "{ 'execute': 'migrate-set-parameters',"
402                     "'arguments': { %s: %s } }",
403                     parameter, value);
404     g_assert(qdict_haskey(rsp, "return"));
405     qobject_unref(rsp);
406     migrate_check_parameter_str(who, parameter, value);
407 }
408 
409 static void migrate_ensure_non_converge(QTestState *who)
410 {
411     /* Can't converge with 1ms downtime + 30 mbs bandwidth limit */
412     migrate_set_parameter_int(who, "max-bandwidth", 30 * 1000 * 1000);
413     migrate_set_parameter_int(who, "downtime-limit", 1);
414 }
415 
416 static void migrate_ensure_converge(QTestState *who)
417 {
418     /* Should converge with 30s downtime + 1 gbs bandwidth limit */
419     migrate_set_parameter_int(who, "max-bandwidth", 1 * 1000 * 1000 * 1000);
420     migrate_set_parameter_int(who, "downtime-limit", 30 * 1000);
421 }
422 
423 static void migrate_pause(QTestState *who)
424 {
425     QDict *rsp;
426 
427     rsp = wait_command(who, "{ 'execute': 'migrate-pause' }");
428     qobject_unref(rsp);
429 }
430 
431 static void migrate_continue(QTestState *who, const char *state)
432 {
433     QDict *rsp;
434 
435     rsp = wait_command(who,
436                        "{ 'execute': 'migrate-continue',"
437                        "  'arguments': { 'state': %s } }",
438                        state);
439     qobject_unref(rsp);
440 }
441 
442 static void migrate_recover(QTestState *who, const char *uri)
443 {
444     QDict *rsp;
445 
446     rsp = wait_command(who,
447                        "{ 'execute': 'migrate-recover', "
448                        "  'id': 'recover-cmd', "
449                        "  'arguments': { 'uri': %s } }",
450                        uri);
451     qobject_unref(rsp);
452 }
453 
454 static void migrate_cancel(QTestState *who)
455 {
456     QDict *rsp;
457 
458     rsp = wait_command(who, "{ 'execute': 'migrate_cancel' }");
459     qobject_unref(rsp);
460 }
461 
462 static void migrate_set_capability(QTestState *who, const char *capability,
463                                    bool value)
464 {
465     QDict *rsp;
466 
467     rsp = qtest_qmp(who,
468                     "{ 'execute': 'migrate-set-capabilities',"
469                     "'arguments': { "
470                     "'capabilities': [ { "
471                     "'capability': %s, 'state': %i } ] } }",
472                     capability, value);
473     g_assert(qdict_haskey(rsp, "return"));
474     qobject_unref(rsp);
475 }
476 
477 static void migrate_postcopy_start(QTestState *from, QTestState *to)
478 {
479     QDict *rsp;
480 
481     rsp = wait_command(from, "{ 'execute': 'migrate-start-postcopy' }");
482     qobject_unref(rsp);
483 
484     if (!got_stop) {
485         qtest_qmp_eventwait(from, "STOP");
486     }
487 
488     qtest_qmp_eventwait(to, "RESUME");
489 }
490 
491 typedef struct {
492     /*
493      * QTEST_LOG=1 may override this.  When QTEST_LOG=1, we always dump errors
494      * unconditionally, because it means the user would like to be verbose.
495      */
496     bool hide_stderr;
497     bool use_shmem;
498     /* only launch the target process */
499     bool only_target;
500     /* Use dirty ring if true; dirty logging otherwise */
501     bool use_dirty_ring;
502     const char *opts_source;
503     const char *opts_target;
504 } MigrateStart;
505 
506 /*
507  * A hook that runs after the src and dst QEMUs have been
508  * created, but before the migration is started. This can
509  * be used to set migration parameters and capabilities.
510  *
511  * Returns: NULL, or a pointer to opaque state to be
512  *          later passed to the TestMigrateFinishHook
513  */
514 typedef void * (*TestMigrateStartHook)(QTestState *from,
515                                        QTestState *to);
516 
517 /*
518  * A hook that runs after the migration has finished,
519  * regardless of whether it succeeded or failed, but
520  * before QEMU has terminated (unless it self-terminated
521  * due to migration error)
522  *
523  * @opaque is a pointer to state previously returned
524  * by the TestMigrateStartHook if any, or NULL.
525  */
526 typedef void (*TestMigrateFinishHook)(QTestState *from,
527                                       QTestState *to,
528                                       void *opaque);
529 
530 typedef struct {
531     /* Optional: fine tune start parameters */
532     MigrateStart start;
533 
534     /* Required: the URI for the dst QEMU to listen on */
535     const char *listen_uri;
536 
537     /*
538      * Optional: the URI for the src QEMU to connect to
539      * If NULL, then it will query the dst QEMU for its actual
540      * listening address and use that as the connect address.
541      * This allows for dynamically picking a free TCP port.
542      */
543     const char *connect_uri;
544 
545     /* Optional: callback to run at start to set migration parameters */
546     TestMigrateStartHook start_hook;
547     /* Optional: callback to run at finish to cleanup */
548     TestMigrateFinishHook finish_hook;
549 
550     /*
551      * Optional: normally we expect the migration process to complete.
552      *
553      * There can be a variety of reasons and stages in which failure
554      * can happen during tests.
555      *
556      * If a failure is expected to happen at time of establishing
557      * the connection, then MIG_TEST_FAIL will indicate that the dst
558      * QEMU is expected to stay running and accept future migration
559      * connections.
560      *
561      * If a failure is expected to happen while processing the
562      * migration stream, then MIG_TEST_FAIL_DEST_QUIT_ERR will indicate
563      * that the dst QEMU is expected to quit with non-zero exit status
564      */
565     enum {
566         /* This test should succeed, the default */
567         MIG_TEST_SUCCEED = 0,
568         /* This test should fail, dest qemu should keep alive */
569         MIG_TEST_FAIL,
570         /* This test should fail, dest qemu should fail with abnormal status */
571         MIG_TEST_FAIL_DEST_QUIT_ERR,
572     } result;
573 
574     /* Optional: set number of migration passes to wait for */
575     unsigned int iterations;
576 
577     /* Postcopy specific fields */
578     void *postcopy_data;
579     bool postcopy_preempt;
580 } MigrateCommon;
581 
582 static int test_migrate_start(QTestState **from, QTestState **to,
583                               const char *uri, MigrateStart *args)
584 {
585     g_autofree gchar *arch_source = NULL;
586     g_autofree gchar *arch_target = NULL;
587     g_autofree gchar *cmd_source = NULL;
588     g_autofree gchar *cmd_target = NULL;
589     const gchar *ignore_stderr;
590     g_autofree char *bootpath = NULL;
591     g_autofree char *shmem_opts = NULL;
592     g_autofree char *shmem_path = NULL;
593     const char *arch = qtest_get_arch();
594     const char *machine_opts = NULL;
595     const char *memory_size;
596 
597     if (args->use_shmem) {
598         if (!g_file_test("/dev/shm", G_FILE_TEST_IS_DIR)) {
599             g_test_skip("/dev/shm is not supported");
600             return -1;
601         }
602     }
603 
604     got_stop = false;
605     bootpath = g_strdup_printf("%s/bootsect", tmpfs);
606     if (strcmp(arch, "i386") == 0 || strcmp(arch, "x86_64") == 0) {
607         /* the assembled x86 boot sector should be exactly one sector large */
608         assert(sizeof(x86_bootsect) == 512);
609         init_bootfile(bootpath, x86_bootsect, sizeof(x86_bootsect));
610         memory_size = "150M";
611         arch_source = g_strdup_printf("-drive file=%s,format=raw", bootpath);
612         arch_target = g_strdup(arch_source);
613         start_address = X86_TEST_MEM_START;
614         end_address = X86_TEST_MEM_END;
615     } else if (g_str_equal(arch, "s390x")) {
616         init_bootfile(bootpath, s390x_elf, sizeof(s390x_elf));
617         memory_size = "128M";
618         arch_source = g_strdup_printf("-bios %s", bootpath);
619         arch_target = g_strdup(arch_source);
620         start_address = S390_TEST_MEM_START;
621         end_address = S390_TEST_MEM_END;
622     } else if (strcmp(arch, "ppc64") == 0) {
623         machine_opts = "vsmt=8";
624         memory_size = "256M";
625         start_address = PPC_TEST_MEM_START;
626         end_address = PPC_TEST_MEM_END;
627         arch_source = g_strdup_printf("-nodefaults "
628                                       "-prom-env 'use-nvramrc?=true' -prom-env "
629                                       "'nvramrc=hex .\" _\" begin %x %x "
630                                       "do i c@ 1 + i c! 1000 +loop .\" B\" 0 "
631                                       "until'", end_address, start_address);
632         arch_target = g_strdup("");
633     } else if (strcmp(arch, "aarch64") == 0) {
634         init_bootfile(bootpath, aarch64_kernel, sizeof(aarch64_kernel));
635         machine_opts = "virt,gic-version=max";
636         memory_size = "150M";
637         arch_source = g_strdup_printf("-cpu max "
638                                       "-kernel %s",
639                                       bootpath);
640         arch_target = g_strdup(arch_source);
641         start_address = ARM_TEST_MEM_START;
642         end_address = ARM_TEST_MEM_END;
643 
644         g_assert(sizeof(aarch64_kernel) <= ARM_TEST_MAX_KERNEL_SIZE);
645     } else {
646         g_assert_not_reached();
647     }
648 
649     if (!getenv("QTEST_LOG") && args->hide_stderr) {
650 #ifndef _WIN32
651         ignore_stderr = "2>/dev/null";
652 #else
653         /*
654          * On Windows the QEMU executable is created via CreateProcess() and
655          * IO redirection does not work, so don't bother adding IO redirection
656          * to the command line.
657          */
658         ignore_stderr = "";
659 #endif
660     } else {
661         ignore_stderr = "";
662     }
663 
664     if (args->use_shmem) {
665         shmem_path = g_strdup_printf("/dev/shm/qemu-%d", getpid());
666         shmem_opts = g_strdup_printf(
667             "-object memory-backend-file,id=mem0,size=%s"
668             ",mem-path=%s,share=on -numa node,memdev=mem0",
669             memory_size, shmem_path);
670     } else {
671         shmem_path = NULL;
672         shmem_opts = g_strdup("");
673     }
674 
675     cmd_source = g_strdup_printf("-accel kvm%s -accel tcg%s%s "
676                                  "-name source,debug-threads=on "
677                                  "-m %s "
678                                  "-serial file:%s/src_serial "
679                                  "%s %s %s %s",
680                                  args->use_dirty_ring ?
681                                  ",dirty-ring-size=4096" : "",
682                                  machine_opts ? " -machine " : "",
683                                  machine_opts ? machine_opts : "",
684                                  memory_size, tmpfs,
685                                  arch_source, shmem_opts,
686                                  args->opts_source ? args->opts_source : "",
687                                  ignore_stderr);
688     if (!args->only_target) {
689         *from = qtest_init(cmd_source);
690     }
691 
692     cmd_target = g_strdup_printf("-accel kvm%s -accel tcg%s%s "
693                                  "-name target,debug-threads=on "
694                                  "-m %s "
695                                  "-serial file:%s/dest_serial "
696                                  "-incoming %s "
697                                  "%s %s %s %s",
698                                  args->use_dirty_ring ?
699                                  ",dirty-ring-size=4096" : "",
700                                  machine_opts ? " -machine " : "",
701                                  machine_opts ? machine_opts : "",
702                                  memory_size, tmpfs, uri,
703                                  arch_target, shmem_opts,
704                                  args->opts_target ? args->opts_target : "",
705                                  ignore_stderr);
706     *to = qtest_init(cmd_target);
707 
708     /*
709      * Remove shmem file immediately to avoid memory leak in test failed case.
710      * It's valid becase QEMU has already opened this file
711      */
712     if (args->use_shmem) {
713         unlink(shmem_path);
714     }
715 
716     return 0;
717 }
718 
719 static void test_migrate_end(QTestState *from, QTestState *to, bool test_dest)
720 {
721     unsigned char dest_byte_a, dest_byte_b, dest_byte_c, dest_byte_d;
722 
723     qtest_quit(from);
724 
725     if (test_dest) {
726         qtest_memread(to, start_address, &dest_byte_a, 1);
727 
728         /* Destination still running, wait for a byte to change */
729         do {
730             qtest_memread(to, start_address, &dest_byte_b, 1);
731             usleep(1000 * 10);
732         } while (dest_byte_a == dest_byte_b);
733 
734         qtest_qmp_discard_response(to, "{ 'execute' : 'stop'}");
735 
736         /* With it stopped, check nothing changes */
737         qtest_memread(to, start_address, &dest_byte_c, 1);
738         usleep(1000 * 200);
739         qtest_memread(to, start_address, &dest_byte_d, 1);
740         g_assert_cmpint(dest_byte_c, ==, dest_byte_d);
741 
742         check_guests_ram(to);
743     }
744 
745     qtest_quit(to);
746 
747     cleanup("bootsect");
748     cleanup("migsocket");
749     cleanup("src_serial");
750     cleanup("dest_serial");
751 }
752 
753 #ifdef CONFIG_GNUTLS
754 struct TestMigrateTLSPSKData {
755     char *workdir;
756     char *workdiralt;
757     char *pskfile;
758     char *pskfilealt;
759 };
760 
761 static void *
762 test_migrate_tls_psk_start_common(QTestState *from,
763                                   QTestState *to,
764                                   bool mismatch)
765 {
766     struct TestMigrateTLSPSKData *data =
767         g_new0(struct TestMigrateTLSPSKData, 1);
768     QDict *rsp;
769 
770     data->workdir = g_strdup_printf("%s/tlscredspsk0", tmpfs);
771     data->pskfile = g_strdup_printf("%s/%s", data->workdir,
772                                     QCRYPTO_TLS_CREDS_PSKFILE);
773     g_mkdir_with_parents(data->workdir, 0700);
774     test_tls_psk_init(data->pskfile);
775 
776     if (mismatch) {
777         data->workdiralt = g_strdup_printf("%s/tlscredspskalt0", tmpfs);
778         data->pskfilealt = g_strdup_printf("%s/%s", data->workdiralt,
779                                            QCRYPTO_TLS_CREDS_PSKFILE);
780         g_mkdir_with_parents(data->workdiralt, 0700);
781         test_tls_psk_init_alt(data->pskfilealt);
782     }
783 
784     rsp = wait_command(from,
785                        "{ 'execute': 'object-add',"
786                        "  'arguments': { 'qom-type': 'tls-creds-psk',"
787                        "                 'id': 'tlscredspsk0',"
788                        "                 'endpoint': 'client',"
789                        "                 'dir': %s,"
790                        "                 'username': 'qemu'} }",
791                        data->workdir);
792     qobject_unref(rsp);
793 
794     rsp = wait_command(to,
795                        "{ 'execute': 'object-add',"
796                        "  'arguments': { 'qom-type': 'tls-creds-psk',"
797                        "                 'id': 'tlscredspsk0',"
798                        "                 'endpoint': 'server',"
799                        "                 'dir': %s } }",
800                        mismatch ? data->workdiralt : data->workdir);
801     qobject_unref(rsp);
802 
803     migrate_set_parameter_str(from, "tls-creds", "tlscredspsk0");
804     migrate_set_parameter_str(to, "tls-creds", "tlscredspsk0");
805 
806     return data;
807 }
808 
809 static void *
810 test_migrate_tls_psk_start_match(QTestState *from,
811                                  QTestState *to)
812 {
813     return test_migrate_tls_psk_start_common(from, to, false);
814 }
815 
816 static void *
817 test_migrate_tls_psk_start_mismatch(QTestState *from,
818                                     QTestState *to)
819 {
820     return test_migrate_tls_psk_start_common(from, to, true);
821 }
822 
823 static void
824 test_migrate_tls_psk_finish(QTestState *from,
825                             QTestState *to,
826                             void *opaque)
827 {
828     struct TestMigrateTLSPSKData *data = opaque;
829 
830     test_tls_psk_cleanup(data->pskfile);
831     if (data->pskfilealt) {
832         test_tls_psk_cleanup(data->pskfilealt);
833     }
834     rmdir(data->workdir);
835     if (data->workdiralt) {
836         rmdir(data->workdiralt);
837     }
838 
839     g_free(data->workdiralt);
840     g_free(data->pskfilealt);
841     g_free(data->workdir);
842     g_free(data->pskfile);
843     g_free(data);
844 }
845 
846 #ifdef CONFIG_TASN1
847 typedef struct {
848     char *workdir;
849     char *keyfile;
850     char *cacert;
851     char *servercert;
852     char *serverkey;
853     char *clientcert;
854     char *clientkey;
855 } TestMigrateTLSX509Data;
856 
857 typedef struct {
858     bool verifyclient;
859     bool clientcert;
860     bool hostileclient;
861     bool authzclient;
862     const char *certhostname;
863     const char *certipaddr;
864 } TestMigrateTLSX509;
865 
866 static void *
867 test_migrate_tls_x509_start_common(QTestState *from,
868                                    QTestState *to,
869                                    TestMigrateTLSX509 *args)
870 {
871     TestMigrateTLSX509Data *data = g_new0(TestMigrateTLSX509Data, 1);
872     QDict *rsp;
873 
874     data->workdir = g_strdup_printf("%s/tlscredsx5090", tmpfs);
875     data->keyfile = g_strdup_printf("%s/key.pem", data->workdir);
876 
877     data->cacert = g_strdup_printf("%s/ca-cert.pem", data->workdir);
878     data->serverkey = g_strdup_printf("%s/server-key.pem", data->workdir);
879     data->servercert = g_strdup_printf("%s/server-cert.pem", data->workdir);
880     if (args->clientcert) {
881         data->clientkey = g_strdup_printf("%s/client-key.pem", data->workdir);
882         data->clientcert = g_strdup_printf("%s/client-cert.pem", data->workdir);
883     }
884 
885     g_mkdir_with_parents(data->workdir, 0700);
886 
887     test_tls_init(data->keyfile);
888 #ifndef _WIN32
889     g_assert(link(data->keyfile, data->serverkey) == 0);
890 #else
891     g_assert(CreateHardLink(data->serverkey, data->keyfile, NULL) != 0);
892 #endif
893     if (args->clientcert) {
894 #ifndef _WIN32
895         g_assert(link(data->keyfile, data->clientkey) == 0);
896 #else
897         g_assert(CreateHardLink(data->clientkey, data->keyfile, NULL) != 0);
898 #endif
899     }
900 
901     TLS_ROOT_REQ_SIMPLE(cacertreq, data->cacert);
902     if (args->clientcert) {
903         TLS_CERT_REQ_SIMPLE_CLIENT(servercertreq, cacertreq,
904                                    args->hostileclient ?
905                                    QCRYPTO_TLS_TEST_CLIENT_HOSTILE_NAME :
906                                    QCRYPTO_TLS_TEST_CLIENT_NAME,
907                                    data->clientcert);
908     }
909 
910     TLS_CERT_REQ_SIMPLE_SERVER(clientcertreq, cacertreq,
911                                data->servercert,
912                                args->certhostname,
913                                args->certipaddr);
914 
915     rsp = wait_command(from,
916                        "{ 'execute': 'object-add',"
917                        "  'arguments': { 'qom-type': 'tls-creds-x509',"
918                        "                 'id': 'tlscredsx509client0',"
919                        "                 'endpoint': 'client',"
920                        "                 'dir': %s,"
921                        "                 'sanity-check': true,"
922                        "                 'verify-peer': true} }",
923                        data->workdir);
924     qobject_unref(rsp);
925     migrate_set_parameter_str(from, "tls-creds", "tlscredsx509client0");
926     if (args->certhostname) {
927         migrate_set_parameter_str(from, "tls-hostname", args->certhostname);
928     }
929 
930     rsp = wait_command(to,
931                        "{ 'execute': 'object-add',"
932                        "  'arguments': { 'qom-type': 'tls-creds-x509',"
933                        "                 'id': 'tlscredsx509server0',"
934                        "                 'endpoint': 'server',"
935                        "                 'dir': %s,"
936                        "                 'sanity-check': true,"
937                        "                 'verify-peer': %i} }",
938                        data->workdir, args->verifyclient);
939     qobject_unref(rsp);
940     migrate_set_parameter_str(to, "tls-creds", "tlscredsx509server0");
941 
942     if (args->authzclient) {
943         rsp = wait_command(to,
944                            "{ 'execute': 'object-add',"
945                            "  'arguments': { 'qom-type': 'authz-simple',"
946                            "                 'id': 'tlsauthz0',"
947                            "                 'identity': %s} }",
948                            "CN=" QCRYPTO_TLS_TEST_CLIENT_NAME);
949         migrate_set_parameter_str(to, "tls-authz", "tlsauthz0");
950     }
951 
952     return data;
953 }
954 
955 /*
956  * The normal case: match server's cert hostname against
957  * whatever host we were telling QEMU to connect to (if any)
958  */
959 static void *
960 test_migrate_tls_x509_start_default_host(QTestState *from,
961                                          QTestState *to)
962 {
963     TestMigrateTLSX509 args = {
964         .verifyclient = true,
965         .clientcert = true,
966         .certipaddr = "127.0.0.1"
967     };
968     return test_migrate_tls_x509_start_common(from, to, &args);
969 }
970 
971 /*
972  * The unusual case: the server's cert is different from
973  * the address we're telling QEMU to connect to (if any),
974  * so we must give QEMU an explicit hostname to validate
975  */
976 static void *
977 test_migrate_tls_x509_start_override_host(QTestState *from,
978                                           QTestState *to)
979 {
980     TestMigrateTLSX509 args = {
981         .verifyclient = true,
982         .clientcert = true,
983         .certhostname = "qemu.org",
984     };
985     return test_migrate_tls_x509_start_common(from, to, &args);
986 }
987 
988 /*
989  * The unusual case: the server's cert is different from
990  * the address we're telling QEMU to connect to, and so we
991  * expect the client to reject the server
992  */
993 static void *
994 test_migrate_tls_x509_start_mismatch_host(QTestState *from,
995                                           QTestState *to)
996 {
997     TestMigrateTLSX509 args = {
998         .verifyclient = true,
999         .clientcert = true,
1000         .certipaddr = "10.0.0.1",
1001     };
1002     return test_migrate_tls_x509_start_common(from, to, &args);
1003 }
1004 
1005 static void *
1006 test_migrate_tls_x509_start_friendly_client(QTestState *from,
1007                                             QTestState *to)
1008 {
1009     TestMigrateTLSX509 args = {
1010         .verifyclient = true,
1011         .clientcert = true,
1012         .authzclient = true,
1013         .certipaddr = "127.0.0.1",
1014     };
1015     return test_migrate_tls_x509_start_common(from, to, &args);
1016 }
1017 
1018 static void *
1019 test_migrate_tls_x509_start_hostile_client(QTestState *from,
1020                                            QTestState *to)
1021 {
1022     TestMigrateTLSX509 args = {
1023         .verifyclient = true,
1024         .clientcert = true,
1025         .hostileclient = true,
1026         .authzclient = true,
1027         .certipaddr = "127.0.0.1",
1028     };
1029     return test_migrate_tls_x509_start_common(from, to, &args);
1030 }
1031 
1032 /*
1033  * The case with no client certificate presented,
1034  * and no server verification
1035  */
1036 static void *
1037 test_migrate_tls_x509_start_allow_anon_client(QTestState *from,
1038                                               QTestState *to)
1039 {
1040     TestMigrateTLSX509 args = {
1041         .certipaddr = "127.0.0.1",
1042     };
1043     return test_migrate_tls_x509_start_common(from, to, &args);
1044 }
1045 
1046 /*
1047  * The case with no client certificate presented,
1048  * and server verification rejecting
1049  */
1050 static void *
1051 test_migrate_tls_x509_start_reject_anon_client(QTestState *from,
1052                                                QTestState *to)
1053 {
1054     TestMigrateTLSX509 args = {
1055         .verifyclient = true,
1056         .certipaddr = "127.0.0.1",
1057     };
1058     return test_migrate_tls_x509_start_common(from, to, &args);
1059 }
1060 
1061 static void
1062 test_migrate_tls_x509_finish(QTestState *from,
1063                              QTestState *to,
1064                              void *opaque)
1065 {
1066     TestMigrateTLSX509Data *data = opaque;
1067 
1068     test_tls_cleanup(data->keyfile);
1069     unlink(data->cacert);
1070     unlink(data->servercert);
1071     unlink(data->serverkey);
1072     unlink(data->clientcert);
1073     unlink(data->clientkey);
1074     rmdir(data->workdir);
1075 
1076     g_free(data->workdir);
1077     g_free(data->keyfile);
1078     g_free(data);
1079 }
1080 #endif /* CONFIG_TASN1 */
1081 #endif /* CONFIG_GNUTLS */
1082 
1083 static int migrate_postcopy_prepare(QTestState **from_ptr,
1084                                     QTestState **to_ptr,
1085                                     MigrateCommon *args)
1086 {
1087     g_autofree char *uri = g_strdup_printf("unix:%s/migsocket", tmpfs);
1088     QTestState *from, *to;
1089 
1090     if (test_migrate_start(&from, &to, uri, &args->start)) {
1091         return -1;
1092     }
1093 
1094     if (args->start_hook) {
1095         args->postcopy_data = args->start_hook(from, to);
1096     }
1097 
1098     migrate_set_capability(from, "postcopy-ram", true);
1099     migrate_set_capability(to, "postcopy-ram", true);
1100     migrate_set_capability(to, "postcopy-blocktime", true);
1101 
1102     if (args->postcopy_preempt) {
1103         migrate_set_capability(from, "postcopy-preempt", true);
1104         migrate_set_capability(to, "postcopy-preempt", true);
1105     }
1106 
1107     migrate_ensure_non_converge(from);
1108 
1109     /* Wait for the first serial output from the source */
1110     wait_for_serial("src_serial");
1111 
1112     migrate_qmp(from, uri, "{}");
1113 
1114     wait_for_migration_pass(from);
1115 
1116     *from_ptr = from;
1117     *to_ptr = to;
1118 
1119     return 0;
1120 }
1121 
1122 static void migrate_postcopy_complete(QTestState *from, QTestState *to,
1123                                       MigrateCommon *args)
1124 {
1125     wait_for_migration_complete(from);
1126 
1127     /* Make sure we get at least one "B" on destination */
1128     wait_for_serial("dest_serial");
1129 
1130     if (uffd_feature_thread_id) {
1131         read_blocktime(to);
1132     }
1133 
1134     if (args->finish_hook) {
1135         args->finish_hook(from, to, args->postcopy_data);
1136         args->postcopy_data = NULL;
1137     }
1138 
1139     test_migrate_end(from, to, true);
1140 }
1141 
1142 static void test_postcopy_common(MigrateCommon *args)
1143 {
1144     QTestState *from, *to;
1145 
1146     if (migrate_postcopy_prepare(&from, &to, args)) {
1147         return;
1148     }
1149     migrate_postcopy_start(from, to);
1150     migrate_postcopy_complete(from, to, args);
1151 }
1152 
1153 static void test_postcopy(void)
1154 {
1155     MigrateCommon args = { };
1156 
1157     test_postcopy_common(&args);
1158 }
1159 
1160 static void test_postcopy_preempt(void)
1161 {
1162     MigrateCommon args = {
1163         .postcopy_preempt = true,
1164     };
1165 
1166     test_postcopy_common(&args);
1167 }
1168 
1169 #ifdef CONFIG_GNUTLS
1170 static void test_postcopy_tls_psk(void)
1171 {
1172     MigrateCommon args = {
1173         .start_hook = test_migrate_tls_psk_start_match,
1174         .finish_hook = test_migrate_tls_psk_finish,
1175     };
1176 
1177     test_postcopy_common(&args);
1178 }
1179 
1180 static void test_postcopy_preempt_tls_psk(void)
1181 {
1182     MigrateCommon args = {
1183         .postcopy_preempt = true,
1184         .start_hook = test_migrate_tls_psk_start_match,
1185         .finish_hook = test_migrate_tls_psk_finish,
1186     };
1187 
1188     test_postcopy_common(&args);
1189 }
1190 #endif
1191 
1192 static void test_postcopy_recovery_common(MigrateCommon *args)
1193 {
1194     QTestState *from, *to;
1195     g_autofree char *uri = NULL;
1196 
1197     /* Always hide errors for postcopy recover tests since they're expected */
1198     args->start.hide_stderr = true;
1199 
1200     if (migrate_postcopy_prepare(&from, &to, args)) {
1201         return;
1202     }
1203 
1204     /* Turn postcopy speed down, 4K/s is slow enough on any machines */
1205     migrate_set_parameter_int(from, "max-postcopy-bandwidth", 4096);
1206 
1207     /* Now we start the postcopy */
1208     migrate_postcopy_start(from, to);
1209 
1210     /*
1211      * Wait until postcopy is really started; we can only run the
1212      * migrate-pause command during a postcopy
1213      */
1214     wait_for_migration_status(from, "postcopy-active", NULL);
1215 
1216     /*
1217      * Manually stop the postcopy migration. This emulates a network
1218      * failure with the migration socket
1219      */
1220     migrate_pause(from);
1221 
1222     /*
1223      * Wait for destination side to reach postcopy-paused state.  The
1224      * migrate-recover command can only succeed if destination machine
1225      * is in the paused state
1226      */
1227     wait_for_migration_status(to, "postcopy-paused",
1228                               (const char * []) { "failed", "active",
1229                                                   "completed", NULL });
1230 
1231     /*
1232      * Create a new socket to emulate a new channel that is different
1233      * from the broken migration channel; tell the destination to
1234      * listen to the new port
1235      */
1236     uri = g_strdup_printf("unix:%s/migsocket-recover", tmpfs);
1237     migrate_recover(to, uri);
1238 
1239     /*
1240      * Try to rebuild the migration channel using the resume flag and
1241      * the newly created channel
1242      */
1243     wait_for_migration_status(from, "postcopy-paused",
1244                               (const char * []) { "failed", "active",
1245                                                   "completed", NULL });
1246     migrate_qmp(from, uri, "{'resume': true}");
1247 
1248     /* Restore the postcopy bandwidth to unlimited */
1249     migrate_set_parameter_int(from, "max-postcopy-bandwidth", 0);
1250 
1251     migrate_postcopy_complete(from, to, args);
1252 }
1253 
1254 static void test_postcopy_recovery(void)
1255 {
1256     MigrateCommon args = { };
1257 
1258     test_postcopy_recovery_common(&args);
1259 }
1260 
1261 #ifdef CONFIG_GNUTLS
1262 static void test_postcopy_recovery_tls_psk(void)
1263 {
1264     MigrateCommon args = {
1265         .start_hook = test_migrate_tls_psk_start_match,
1266         .finish_hook = test_migrate_tls_psk_finish,
1267     };
1268 
1269     test_postcopy_recovery_common(&args);
1270 }
1271 #endif
1272 
1273 static void test_postcopy_preempt_recovery(void)
1274 {
1275     MigrateCommon args = {
1276         .postcopy_preempt = true,
1277     };
1278 
1279     test_postcopy_recovery_common(&args);
1280 }
1281 
1282 #ifdef CONFIG_GNUTLS
1283 /* This contains preempt+recovery+tls test altogether */
1284 static void test_postcopy_preempt_all(void)
1285 {
1286     MigrateCommon args = {
1287         .postcopy_preempt = true,
1288         .start_hook = test_migrate_tls_psk_start_match,
1289         .finish_hook = test_migrate_tls_psk_finish,
1290     };
1291 
1292     test_postcopy_recovery_common(&args);
1293 }
1294 #endif
1295 
1296 static void test_baddest(void)
1297 {
1298     MigrateStart args = {
1299         .hide_stderr = true
1300     };
1301     QTestState *from, *to;
1302 
1303     if (test_migrate_start(&from, &to, "tcp:127.0.0.1:0", &args)) {
1304         return;
1305     }
1306     migrate_qmp(from, "tcp:127.0.0.1:0", "{}");
1307     wait_for_migration_fail(from, false);
1308     test_migrate_end(from, to, false);
1309 }
1310 
1311 static void test_precopy_common(MigrateCommon *args)
1312 {
1313     QTestState *from, *to;
1314     void *data_hook = NULL;
1315 
1316     if (test_migrate_start(&from, &to, args->listen_uri, &args->start)) {
1317         return;
1318     }
1319 
1320     migrate_ensure_non_converge(from);
1321 
1322     if (args->start_hook) {
1323         data_hook = args->start_hook(from, to);
1324     }
1325 
1326     /* Wait for the first serial output from the source */
1327     if (args->result == MIG_TEST_SUCCEED) {
1328         wait_for_serial("src_serial");
1329     }
1330 
1331     if (!args->connect_uri) {
1332         g_autofree char *local_connect_uri =
1333             migrate_get_socket_address(to, "socket-address");
1334         migrate_qmp(from, local_connect_uri, "{}");
1335     } else {
1336         migrate_qmp(from, args->connect_uri, "{}");
1337     }
1338 
1339 
1340     if (args->result != MIG_TEST_SUCCEED) {
1341         bool allow_active = args->result == MIG_TEST_FAIL;
1342         wait_for_migration_fail(from, allow_active);
1343 
1344         if (args->result == MIG_TEST_FAIL_DEST_QUIT_ERR) {
1345             qtest_set_expected_status(to, 1);
1346         }
1347     } else {
1348         if (args->iterations) {
1349             while (args->iterations--) {
1350                 wait_for_migration_pass(from);
1351             }
1352         } else {
1353             wait_for_migration_pass(from);
1354         }
1355 
1356         migrate_ensure_converge(from);
1357 
1358         /* We do this first, as it has a timeout to stop us
1359          * hanging forever if migration didn't converge */
1360         wait_for_migration_complete(from);
1361 
1362         if (!got_stop) {
1363             qtest_qmp_eventwait(from, "STOP");
1364         }
1365 
1366         qtest_qmp_eventwait(to, "RESUME");
1367 
1368         wait_for_serial("dest_serial");
1369     }
1370 
1371     if (args->finish_hook) {
1372         args->finish_hook(from, to, data_hook);
1373     }
1374 
1375     test_migrate_end(from, to, args->result == MIG_TEST_SUCCEED);
1376 }
1377 
1378 static void test_precopy_unix_plain(void)
1379 {
1380     g_autofree char *uri = g_strdup_printf("unix:%s/migsocket", tmpfs);
1381     MigrateCommon args = {
1382         .listen_uri = uri,
1383         .connect_uri = uri,
1384     };
1385 
1386     test_precopy_common(&args);
1387 }
1388 
1389 
1390 static void test_precopy_unix_dirty_ring(void)
1391 {
1392     g_autofree char *uri = g_strdup_printf("unix:%s/migsocket", tmpfs);
1393     MigrateCommon args = {
1394         .start = {
1395             .use_dirty_ring = true,
1396         },
1397         .listen_uri = uri,
1398         .connect_uri = uri,
1399     };
1400 
1401     test_precopy_common(&args);
1402 }
1403 
1404 #ifdef CONFIG_GNUTLS
1405 #ifndef _WIN32
1406 static void test_precopy_unix_tls_psk(void)
1407 {
1408     g_autofree char *uri = g_strdup_printf("unix:%s/migsocket", tmpfs);
1409     MigrateCommon args = {
1410         .connect_uri = uri,
1411         .listen_uri = uri,
1412         .start_hook = test_migrate_tls_psk_start_match,
1413         .finish_hook = test_migrate_tls_psk_finish,
1414     };
1415 
1416     test_precopy_common(&args);
1417 }
1418 #endif /* _WIN32 */
1419 
1420 #ifdef CONFIG_TASN1
1421 static void test_precopy_unix_tls_x509_default_host(void)
1422 {
1423     g_autofree char *uri = g_strdup_printf("unix:%s/migsocket", tmpfs);
1424     MigrateCommon args = {
1425         .start = {
1426             .hide_stderr = true,
1427         },
1428         .connect_uri = uri,
1429         .listen_uri = uri,
1430         .start_hook = test_migrate_tls_x509_start_default_host,
1431         .finish_hook = test_migrate_tls_x509_finish,
1432         .result = MIG_TEST_FAIL_DEST_QUIT_ERR,
1433     };
1434 
1435     test_precopy_common(&args);
1436 }
1437 
1438 static void test_precopy_unix_tls_x509_override_host(void)
1439 {
1440     g_autofree char *uri = g_strdup_printf("unix:%s/migsocket", tmpfs);
1441     MigrateCommon args = {
1442         .connect_uri = uri,
1443         .listen_uri = uri,
1444         .start_hook = test_migrate_tls_x509_start_override_host,
1445         .finish_hook = test_migrate_tls_x509_finish,
1446     };
1447 
1448     test_precopy_common(&args);
1449 }
1450 #endif /* CONFIG_TASN1 */
1451 #endif /* CONFIG_GNUTLS */
1452 
1453 #if 0
1454 /* Currently upset on aarch64 TCG */
1455 static void test_ignore_shared(void)
1456 {
1457     g_autofree char *uri = g_strdup_printf("unix:%s/migsocket", tmpfs);
1458     QTestState *from, *to;
1459 
1460     if (test_migrate_start(&from, &to, uri, false, true, NULL, NULL)) {
1461         return;
1462     }
1463 
1464     migrate_set_capability(from, "x-ignore-shared", true);
1465     migrate_set_capability(to, "x-ignore-shared", true);
1466 
1467     /* Wait for the first serial output from the source */
1468     wait_for_serial("src_serial");
1469 
1470     migrate_qmp(from, uri, "{}");
1471 
1472     wait_for_migration_pass(from);
1473 
1474     if (!got_stop) {
1475         qtest_qmp_eventwait(from, "STOP");
1476     }
1477 
1478     qtest_qmp_eventwait(to, "RESUME");
1479 
1480     wait_for_serial("dest_serial");
1481     wait_for_migration_complete(from);
1482 
1483     /* Check whether shared RAM has been really skipped */
1484     g_assert_cmpint(read_ram_property_int(from, "transferred"), <, 1024 * 1024);
1485 
1486     test_migrate_end(from, to, true);
1487 }
1488 #endif
1489 
1490 static void *
1491 test_migrate_xbzrle_start(QTestState *from,
1492                           QTestState *to)
1493 {
1494     migrate_set_parameter_int(from, "xbzrle-cache-size", 33554432);
1495 
1496     migrate_set_capability(from, "xbzrle", true);
1497     migrate_set_capability(to, "xbzrle", true);
1498 
1499     return NULL;
1500 }
1501 
1502 static void test_precopy_unix_xbzrle(void)
1503 {
1504     g_autofree char *uri = g_strdup_printf("unix:%s/migsocket", tmpfs);
1505     MigrateCommon args = {
1506         .connect_uri = uri,
1507         .listen_uri = uri,
1508 
1509         .start_hook = test_migrate_xbzrle_start,
1510 
1511         .iterations = 2,
1512     };
1513 
1514     test_precopy_common(&args);
1515 }
1516 
1517 static void test_precopy_tcp_plain(void)
1518 {
1519     MigrateCommon args = {
1520         .listen_uri = "tcp:127.0.0.1:0",
1521     };
1522 
1523     test_precopy_common(&args);
1524 }
1525 
1526 #ifdef CONFIG_GNUTLS
1527 #ifndef _WIN32
1528 static void test_precopy_tcp_tls_psk_match(void)
1529 {
1530     MigrateCommon args = {
1531         .listen_uri = "tcp:127.0.0.1:0",
1532         .start_hook = test_migrate_tls_psk_start_match,
1533         .finish_hook = test_migrate_tls_psk_finish,
1534     };
1535 
1536     test_precopy_common(&args);
1537 }
1538 #endif /* _WIN32 */
1539 
1540 static void test_precopy_tcp_tls_psk_mismatch(void)
1541 {
1542     MigrateCommon args = {
1543         .start = {
1544             .hide_stderr = true,
1545         },
1546         .listen_uri = "tcp:127.0.0.1:0",
1547         .start_hook = test_migrate_tls_psk_start_mismatch,
1548         .finish_hook = test_migrate_tls_psk_finish,
1549         .result = MIG_TEST_FAIL,
1550     };
1551 
1552     test_precopy_common(&args);
1553 }
1554 
1555 #ifdef CONFIG_TASN1
1556 static void test_precopy_tcp_tls_x509_default_host(void)
1557 {
1558     MigrateCommon args = {
1559         .listen_uri = "tcp:127.0.0.1:0",
1560         .start_hook = test_migrate_tls_x509_start_default_host,
1561         .finish_hook = test_migrate_tls_x509_finish,
1562     };
1563 
1564     test_precopy_common(&args);
1565 }
1566 
1567 static void test_precopy_tcp_tls_x509_override_host(void)
1568 {
1569     MigrateCommon args = {
1570         .listen_uri = "tcp:127.0.0.1:0",
1571         .start_hook = test_migrate_tls_x509_start_override_host,
1572         .finish_hook = test_migrate_tls_x509_finish,
1573     };
1574 
1575     test_precopy_common(&args);
1576 }
1577 
1578 static void test_precopy_tcp_tls_x509_mismatch_host(void)
1579 {
1580     MigrateCommon args = {
1581         .start = {
1582             .hide_stderr = true,
1583         },
1584         .listen_uri = "tcp:127.0.0.1:0",
1585         .start_hook = test_migrate_tls_x509_start_mismatch_host,
1586         .finish_hook = test_migrate_tls_x509_finish,
1587         .result = MIG_TEST_FAIL_DEST_QUIT_ERR,
1588     };
1589 
1590     test_precopy_common(&args);
1591 }
1592 
1593 static void test_precopy_tcp_tls_x509_friendly_client(void)
1594 {
1595     MigrateCommon args = {
1596         .listen_uri = "tcp:127.0.0.1:0",
1597         .start_hook = test_migrate_tls_x509_start_friendly_client,
1598         .finish_hook = test_migrate_tls_x509_finish,
1599     };
1600 
1601     test_precopy_common(&args);
1602 }
1603 
1604 static void test_precopy_tcp_tls_x509_hostile_client(void)
1605 {
1606     MigrateCommon args = {
1607         .start = {
1608             .hide_stderr = true,
1609         },
1610         .listen_uri = "tcp:127.0.0.1:0",
1611         .start_hook = test_migrate_tls_x509_start_hostile_client,
1612         .finish_hook = test_migrate_tls_x509_finish,
1613         .result = MIG_TEST_FAIL,
1614     };
1615 
1616     test_precopy_common(&args);
1617 }
1618 
1619 static void test_precopy_tcp_tls_x509_allow_anon_client(void)
1620 {
1621     MigrateCommon args = {
1622         .listen_uri = "tcp:127.0.0.1:0",
1623         .start_hook = test_migrate_tls_x509_start_allow_anon_client,
1624         .finish_hook = test_migrate_tls_x509_finish,
1625     };
1626 
1627     test_precopy_common(&args);
1628 }
1629 
1630 static void test_precopy_tcp_tls_x509_reject_anon_client(void)
1631 {
1632     MigrateCommon args = {
1633         .start = {
1634             .hide_stderr = true,
1635         },
1636         .listen_uri = "tcp:127.0.0.1:0",
1637         .start_hook = test_migrate_tls_x509_start_reject_anon_client,
1638         .finish_hook = test_migrate_tls_x509_finish,
1639         .result = MIG_TEST_FAIL,
1640     };
1641 
1642     test_precopy_common(&args);
1643 }
1644 #endif /* CONFIG_TASN1 */
1645 #endif /* CONFIG_GNUTLS */
1646 
1647 #ifndef _WIN32
1648 static void *test_migrate_fd_start_hook(QTestState *from,
1649                                         QTestState *to)
1650 {
1651     QDict *rsp;
1652     int ret;
1653     int pair[2];
1654 
1655     /* Create two connected sockets for migration */
1656     ret = socketpair(PF_LOCAL, SOCK_STREAM, 0, pair);
1657     g_assert_cmpint(ret, ==, 0);
1658 
1659     /* Send the 1st socket to the target */
1660     rsp = wait_command_fd(to, pair[0],
1661                           "{ 'execute': 'getfd',"
1662                           "  'arguments': { 'fdname': 'fd-mig' }}");
1663     qobject_unref(rsp);
1664     close(pair[0]);
1665 
1666     /* Start incoming migration from the 1st socket */
1667     rsp = wait_command(to, "{ 'execute': 'migrate-incoming',"
1668                            "  'arguments': { 'uri': 'fd:fd-mig' }}");
1669     qobject_unref(rsp);
1670 
1671     /* Send the 2nd socket to the target */
1672     rsp = wait_command_fd(from, pair[1],
1673                           "{ 'execute': 'getfd',"
1674                           "  'arguments': { 'fdname': 'fd-mig' }}");
1675     qobject_unref(rsp);
1676     close(pair[1]);
1677 
1678     return NULL;
1679 }
1680 
1681 static void test_migrate_fd_finish_hook(QTestState *from,
1682                                         QTestState *to,
1683                                         void *opaque)
1684 {
1685     QDict *rsp;
1686     const char *error_desc;
1687 
1688     /* Test closing fds */
1689     /* We assume, that QEMU removes named fd from its list,
1690      * so this should fail */
1691     rsp = qtest_qmp(from, "{ 'execute': 'closefd',"
1692                           "  'arguments': { 'fdname': 'fd-mig' }}");
1693     g_assert_true(qdict_haskey(rsp, "error"));
1694     error_desc = qdict_get_str(qdict_get_qdict(rsp, "error"), "desc");
1695     g_assert_cmpstr(error_desc, ==, "File descriptor named 'fd-mig' not found");
1696     qobject_unref(rsp);
1697 
1698     rsp = qtest_qmp(to, "{ 'execute': 'closefd',"
1699                         "  'arguments': { 'fdname': 'fd-mig' }}");
1700     g_assert_true(qdict_haskey(rsp, "error"));
1701     error_desc = qdict_get_str(qdict_get_qdict(rsp, "error"), "desc");
1702     g_assert_cmpstr(error_desc, ==, "File descriptor named 'fd-mig' not found");
1703     qobject_unref(rsp);
1704 }
1705 
1706 static void test_migrate_fd_proto(void)
1707 {
1708     MigrateCommon args = {
1709         .listen_uri = "defer",
1710         .connect_uri = "fd:fd-mig",
1711         .start_hook = test_migrate_fd_start_hook,
1712         .finish_hook = test_migrate_fd_finish_hook
1713     };
1714     test_precopy_common(&args);
1715 }
1716 #endif /* _WIN32 */
1717 
1718 static void do_test_validate_uuid(MigrateStart *args, bool should_fail)
1719 {
1720     g_autofree char *uri = g_strdup_printf("unix:%s/migsocket", tmpfs);
1721     QTestState *from, *to;
1722 
1723     if (test_migrate_start(&from, &to, uri, args)) {
1724         return;
1725     }
1726 
1727     /*
1728      * UUID validation is at the begin of migration. So, the main process of
1729      * migration is not interesting for us here. Thus, set huge downtime for
1730      * very fast migration.
1731      */
1732     migrate_set_parameter_int(from, "downtime-limit", 1000000);
1733     migrate_set_capability(from, "validate-uuid", true);
1734 
1735     /* Wait for the first serial output from the source */
1736     wait_for_serial("src_serial");
1737 
1738     migrate_qmp(from, uri, "{}");
1739 
1740     if (should_fail) {
1741         qtest_set_expected_status(to, 1);
1742         wait_for_migration_fail(from, true);
1743     } else {
1744         wait_for_migration_complete(from);
1745     }
1746 
1747     test_migrate_end(from, to, false);
1748 }
1749 
1750 static void test_validate_uuid(void)
1751 {
1752     MigrateStart args = {
1753         .opts_source = "-uuid 11111111-1111-1111-1111-111111111111",
1754         .opts_target = "-uuid 11111111-1111-1111-1111-111111111111",
1755     };
1756 
1757     do_test_validate_uuid(&args, false);
1758 }
1759 
1760 static void test_validate_uuid_error(void)
1761 {
1762     MigrateStart args = {
1763         .opts_source = "-uuid 11111111-1111-1111-1111-111111111111",
1764         .opts_target = "-uuid 22222222-2222-2222-2222-222222222222",
1765         .hide_stderr = true,
1766     };
1767 
1768     do_test_validate_uuid(&args, true);
1769 }
1770 
1771 static void test_validate_uuid_src_not_set(void)
1772 {
1773     MigrateStart args = {
1774         .opts_target = "-uuid 22222222-2222-2222-2222-222222222222",
1775         .hide_stderr = true,
1776     };
1777 
1778     do_test_validate_uuid(&args, false);
1779 }
1780 
1781 static void test_validate_uuid_dst_not_set(void)
1782 {
1783     MigrateStart args = {
1784         .opts_source = "-uuid 11111111-1111-1111-1111-111111111111",
1785         .hide_stderr = true,
1786     };
1787 
1788     do_test_validate_uuid(&args, false);
1789 }
1790 
1791 static void test_migrate_auto_converge(void)
1792 {
1793     g_autofree char *uri = g_strdup_printf("unix:%s/migsocket", tmpfs);
1794     MigrateStart args = {};
1795     QTestState *from, *to;
1796     int64_t percentage;
1797 
1798     /*
1799      * We want the test to be stable and as fast as possible.
1800      * E.g., with 1Gb/s bandwith migration may pass without throttling,
1801      * so we need to decrease a bandwidth.
1802      */
1803     const int64_t init_pct = 5, inc_pct = 50, max_pct = 95;
1804 
1805     if (test_migrate_start(&from, &to, uri, &args)) {
1806         return;
1807     }
1808 
1809     migrate_set_capability(from, "auto-converge", true);
1810     migrate_set_parameter_int(from, "cpu-throttle-initial", init_pct);
1811     migrate_set_parameter_int(from, "cpu-throttle-increment", inc_pct);
1812     migrate_set_parameter_int(from, "max-cpu-throttle", max_pct);
1813 
1814     /*
1815      * Set the initial parameters so that the migration could not converge
1816      * without throttling.
1817      */
1818     migrate_ensure_non_converge(from);
1819 
1820     /* To check remaining size after precopy */
1821     migrate_set_capability(from, "pause-before-switchover", true);
1822 
1823     /* Wait for the first serial output from the source */
1824     wait_for_serial("src_serial");
1825 
1826     migrate_qmp(from, uri, "{}");
1827 
1828     /* Wait for throttling begins */
1829     percentage = 0;
1830     while (percentage == 0) {
1831         percentage = read_migrate_property_int(from, "cpu-throttle-percentage");
1832         usleep(100);
1833         g_assert_false(got_stop);
1834     }
1835     /* The first percentage of throttling should be equal to init_pct */
1836     g_assert_cmpint(percentage, ==, init_pct);
1837     /* Now, when we tested that throttling works, let it converge */
1838     migrate_ensure_converge(from);
1839 
1840     /*
1841      * Wait for pre-switchover status to check last throttle percentage
1842      * and remaining. These values will be zeroed later
1843      */
1844     wait_for_migration_status(from, "pre-switchover", NULL);
1845 
1846     /* The final percentage of throttling shouldn't be greater than max_pct */
1847     percentage = read_migrate_property_int(from, "cpu-throttle-percentage");
1848     g_assert_cmpint(percentage, <=, max_pct);
1849     migrate_continue(from, "pre-switchover");
1850 
1851     qtest_qmp_eventwait(to, "RESUME");
1852 
1853     wait_for_serial("dest_serial");
1854     wait_for_migration_complete(from);
1855 
1856     test_migrate_end(from, to, true);
1857 }
1858 
1859 static void *
1860 test_migrate_precopy_tcp_multifd_start_common(QTestState *from,
1861                                               QTestState *to,
1862                                               const char *method)
1863 {
1864     QDict *rsp;
1865 
1866     migrate_set_parameter_int(from, "multifd-channels", 16);
1867     migrate_set_parameter_int(to, "multifd-channels", 16);
1868 
1869     migrate_set_parameter_str(from, "multifd-compression", method);
1870     migrate_set_parameter_str(to, "multifd-compression", method);
1871 
1872     migrate_set_capability(from, "multifd", true);
1873     migrate_set_capability(to, "multifd", true);
1874 
1875     /* Start incoming migration from the 1st socket */
1876     rsp = wait_command(to, "{ 'execute': 'migrate-incoming',"
1877                            "  'arguments': { 'uri': 'tcp:127.0.0.1:0' }}");
1878     qobject_unref(rsp);
1879 
1880     return NULL;
1881 }
1882 
1883 static void *
1884 test_migrate_precopy_tcp_multifd_start(QTestState *from,
1885                                        QTestState *to)
1886 {
1887     return test_migrate_precopy_tcp_multifd_start_common(from, to, "none");
1888 }
1889 
1890 static void *
1891 test_migrate_precopy_tcp_multifd_zlib_start(QTestState *from,
1892                                             QTestState *to)
1893 {
1894     return test_migrate_precopy_tcp_multifd_start_common(from, to, "zlib");
1895 }
1896 
1897 #ifdef CONFIG_ZSTD
1898 static void *
1899 test_migrate_precopy_tcp_multifd_zstd_start(QTestState *from,
1900                                             QTestState *to)
1901 {
1902     return test_migrate_precopy_tcp_multifd_start_common(from, to, "zstd");
1903 }
1904 #endif /* CONFIG_ZSTD */
1905 
1906 static void test_multifd_tcp_none(void)
1907 {
1908     MigrateCommon args = {
1909         .listen_uri = "defer",
1910         .start_hook = test_migrate_precopy_tcp_multifd_start,
1911     };
1912     test_precopy_common(&args);
1913 }
1914 
1915 static void test_multifd_tcp_zlib(void)
1916 {
1917     MigrateCommon args = {
1918         .listen_uri = "defer",
1919         .start_hook = test_migrate_precopy_tcp_multifd_zlib_start,
1920     };
1921     test_precopy_common(&args);
1922 }
1923 
1924 #ifdef CONFIG_ZSTD
1925 static void test_multifd_tcp_zstd(void)
1926 {
1927     MigrateCommon args = {
1928         .listen_uri = "defer",
1929         .start_hook = test_migrate_precopy_tcp_multifd_zstd_start,
1930     };
1931     test_precopy_common(&args);
1932 }
1933 #endif
1934 
1935 #ifdef CONFIG_GNUTLS
1936 #ifndef _WIN32
1937 static void *
1938 test_migrate_multifd_tcp_tls_psk_start_match(QTestState *from,
1939                                              QTestState *to)
1940 {
1941     test_migrate_precopy_tcp_multifd_start_common(from, to, "none");
1942     return test_migrate_tls_psk_start_match(from, to);
1943 }
1944 #endif /* _WIN32 */
1945 
1946 static void *
1947 test_migrate_multifd_tcp_tls_psk_start_mismatch(QTestState *from,
1948                                                 QTestState *to)
1949 {
1950     test_migrate_precopy_tcp_multifd_start_common(from, to, "none");
1951     return test_migrate_tls_psk_start_mismatch(from, to);
1952 }
1953 
1954 #ifdef CONFIG_TASN1
1955 static void *
1956 test_migrate_multifd_tls_x509_start_default_host(QTestState *from,
1957                                                  QTestState *to)
1958 {
1959     test_migrate_precopy_tcp_multifd_start_common(from, to, "none");
1960     return test_migrate_tls_x509_start_default_host(from, to);
1961 }
1962 
1963 static void *
1964 test_migrate_multifd_tls_x509_start_override_host(QTestState *from,
1965                                                   QTestState *to)
1966 {
1967     test_migrate_precopy_tcp_multifd_start_common(from, to, "none");
1968     return test_migrate_tls_x509_start_override_host(from, to);
1969 }
1970 
1971 static void *
1972 test_migrate_multifd_tls_x509_start_mismatch_host(QTestState *from,
1973                                                   QTestState *to)
1974 {
1975     test_migrate_precopy_tcp_multifd_start_common(from, to, "none");
1976     return test_migrate_tls_x509_start_mismatch_host(from, to);
1977 }
1978 
1979 static void *
1980 test_migrate_multifd_tls_x509_start_allow_anon_client(QTestState *from,
1981                                                       QTestState *to)
1982 {
1983     test_migrate_precopy_tcp_multifd_start_common(from, to, "none");
1984     return test_migrate_tls_x509_start_allow_anon_client(from, to);
1985 }
1986 
1987 static void *
1988 test_migrate_multifd_tls_x509_start_reject_anon_client(QTestState *from,
1989                                                        QTestState *to)
1990 {
1991     test_migrate_precopy_tcp_multifd_start_common(from, to, "none");
1992     return test_migrate_tls_x509_start_reject_anon_client(from, to);
1993 }
1994 #endif /* CONFIG_TASN1 */
1995 
1996 #ifndef _WIN32
1997 static void test_multifd_tcp_tls_psk_match(void)
1998 {
1999     MigrateCommon args = {
2000         .listen_uri = "defer",
2001         .start_hook = test_migrate_multifd_tcp_tls_psk_start_match,
2002         .finish_hook = test_migrate_tls_psk_finish,
2003     };
2004     test_precopy_common(&args);
2005 }
2006 #endif /* _WIN32 */
2007 
2008 static void test_multifd_tcp_tls_psk_mismatch(void)
2009 {
2010     MigrateCommon args = {
2011         .start = {
2012             .hide_stderr = true,
2013         },
2014         .listen_uri = "defer",
2015         .start_hook = test_migrate_multifd_tcp_tls_psk_start_mismatch,
2016         .finish_hook = test_migrate_tls_psk_finish,
2017         .result = MIG_TEST_FAIL,
2018     };
2019     test_precopy_common(&args);
2020 }
2021 
2022 #ifdef CONFIG_TASN1
2023 static void test_multifd_tcp_tls_x509_default_host(void)
2024 {
2025     MigrateCommon args = {
2026         .listen_uri = "defer",
2027         .start_hook = test_migrate_multifd_tls_x509_start_default_host,
2028         .finish_hook = test_migrate_tls_x509_finish,
2029     };
2030     test_precopy_common(&args);
2031 }
2032 
2033 static void test_multifd_tcp_tls_x509_override_host(void)
2034 {
2035     MigrateCommon args = {
2036         .listen_uri = "defer",
2037         .start_hook = test_migrate_multifd_tls_x509_start_override_host,
2038         .finish_hook = test_migrate_tls_x509_finish,
2039     };
2040     test_precopy_common(&args);
2041 }
2042 
2043 static void test_multifd_tcp_tls_x509_mismatch_host(void)
2044 {
2045     /*
2046      * This has different behaviour to the non-multifd case.
2047      *
2048      * In non-multifd case when client aborts due to mismatched
2049      * cert host, the server has already started trying to load
2050      * migration state, and so it exits with I/O failure.
2051      *
2052      * In multifd case when client aborts due to mismatched
2053      * cert host, the server is still waiting for the other
2054      * multifd connections to arrive so hasn't started trying
2055      * to load migration state, and thus just aborts the migration
2056      * without exiting.
2057      */
2058     MigrateCommon args = {
2059         .start = {
2060             .hide_stderr = true,
2061         },
2062         .listen_uri = "defer",
2063         .start_hook = test_migrate_multifd_tls_x509_start_mismatch_host,
2064         .finish_hook = test_migrate_tls_x509_finish,
2065         .result = MIG_TEST_FAIL,
2066     };
2067     test_precopy_common(&args);
2068 }
2069 
2070 static void test_multifd_tcp_tls_x509_allow_anon_client(void)
2071 {
2072     MigrateCommon args = {
2073         .listen_uri = "defer",
2074         .start_hook = test_migrate_multifd_tls_x509_start_allow_anon_client,
2075         .finish_hook = test_migrate_tls_x509_finish,
2076     };
2077     test_precopy_common(&args);
2078 }
2079 
2080 static void test_multifd_tcp_tls_x509_reject_anon_client(void)
2081 {
2082     MigrateCommon args = {
2083         .start = {
2084             .hide_stderr = true,
2085         },
2086         .listen_uri = "defer",
2087         .start_hook = test_migrate_multifd_tls_x509_start_reject_anon_client,
2088         .finish_hook = test_migrate_tls_x509_finish,
2089         .result = MIG_TEST_FAIL,
2090     };
2091     test_precopy_common(&args);
2092 }
2093 #endif /* CONFIG_TASN1 */
2094 #endif /* CONFIG_GNUTLS */
2095 
2096 /*
2097  * This test does:
2098  *  source               target
2099  *                       migrate_incoming
2100  *     migrate
2101  *     migrate_cancel
2102  *                       launch another target
2103  *     migrate
2104  *
2105  *  And see that it works
2106  */
2107 static void test_multifd_tcp_cancel(void)
2108 {
2109     MigrateStart args = {
2110         .hide_stderr = true,
2111     };
2112     QTestState *from, *to, *to2;
2113     QDict *rsp;
2114     g_autofree char *uri = NULL;
2115 
2116     if (test_migrate_start(&from, &to, "defer", &args)) {
2117         return;
2118     }
2119 
2120     migrate_ensure_non_converge(from);
2121 
2122     migrate_set_parameter_int(from, "multifd-channels", 16);
2123     migrate_set_parameter_int(to, "multifd-channels", 16);
2124 
2125     migrate_set_capability(from, "multifd", true);
2126     migrate_set_capability(to, "multifd", true);
2127 
2128     /* Start incoming migration from the 1st socket */
2129     rsp = wait_command(to, "{ 'execute': 'migrate-incoming',"
2130                            "  'arguments': { 'uri': 'tcp:127.0.0.1:0' }}");
2131     qobject_unref(rsp);
2132 
2133     /* Wait for the first serial output from the source */
2134     wait_for_serial("src_serial");
2135 
2136     uri = migrate_get_socket_address(to, "socket-address");
2137 
2138     migrate_qmp(from, uri, "{}");
2139 
2140     wait_for_migration_pass(from);
2141 
2142     migrate_cancel(from);
2143 
2144     args = (MigrateStart){
2145         .only_target = true,
2146     };
2147 
2148     if (test_migrate_start(&from, &to2, "defer", &args)) {
2149         return;
2150     }
2151 
2152     migrate_set_parameter_int(to2, "multifd-channels", 16);
2153 
2154     migrate_set_capability(to2, "multifd", true);
2155 
2156     /* Start incoming migration from the 1st socket */
2157     rsp = wait_command(to2, "{ 'execute': 'migrate-incoming',"
2158                             "  'arguments': { 'uri': 'tcp:127.0.0.1:0' }}");
2159     qobject_unref(rsp);
2160 
2161     g_free(uri);
2162     uri = migrate_get_socket_address(to2, "socket-address");
2163 
2164     wait_for_migration_status(from, "cancelled", NULL);
2165 
2166     migrate_ensure_converge(from);
2167 
2168     migrate_qmp(from, uri, "{}");
2169 
2170     wait_for_migration_pass(from);
2171 
2172     if (!got_stop) {
2173         qtest_qmp_eventwait(from, "STOP");
2174     }
2175     qtest_qmp_eventwait(to2, "RESUME");
2176 
2177     wait_for_serial("dest_serial");
2178     wait_for_migration_complete(from);
2179     test_migrate_end(from, to2, true);
2180 }
2181 
2182 static void calc_dirty_rate(QTestState *who, uint64_t calc_time)
2183 {
2184     qobject_unref(qmp_command(who,
2185                   "{ 'execute': 'calc-dirty-rate',"
2186                   "'arguments': { "
2187                   "'calc-time': %ld,"
2188                   "'mode': 'dirty-ring' }}",
2189                   calc_time));
2190 }
2191 
2192 static QDict *query_dirty_rate(QTestState *who)
2193 {
2194     return qmp_command(who, "{ 'execute': 'query-dirty-rate' }");
2195 }
2196 
2197 static void dirtylimit_set_all(QTestState *who, uint64_t dirtyrate)
2198 {
2199     qobject_unref(qmp_command(who,
2200                   "{ 'execute': 'set-vcpu-dirty-limit',"
2201                   "'arguments': { "
2202                   "'dirty-rate': %ld } }",
2203                   dirtyrate));
2204 }
2205 
2206 static void cancel_vcpu_dirty_limit(QTestState *who)
2207 {
2208     qobject_unref(qmp_command(who,
2209                   "{ 'execute': 'cancel-vcpu-dirty-limit' }"));
2210 }
2211 
2212 static QDict *query_vcpu_dirty_limit(QTestState *who)
2213 {
2214     QDict *rsp;
2215 
2216     rsp = qtest_qmp(who, "{ 'execute': 'query-vcpu-dirty-limit' }");
2217     g_assert(!qdict_haskey(rsp, "error"));
2218     g_assert(qdict_haskey(rsp, "return"));
2219 
2220     return rsp;
2221 }
2222 
2223 static bool calc_dirtyrate_ready(QTestState *who)
2224 {
2225     QDict *rsp_return;
2226     gchar *status;
2227 
2228     rsp_return = query_dirty_rate(who);
2229     g_assert(rsp_return);
2230 
2231     status = g_strdup(qdict_get_str(rsp_return, "status"));
2232     g_assert(status);
2233 
2234     return g_strcmp0(status, "measuring");
2235 }
2236 
2237 static void wait_for_calc_dirtyrate_complete(QTestState *who,
2238                                              int64_t time_s)
2239 {
2240     int max_try_count = 10000;
2241     usleep(time_s * 1000000);
2242 
2243     while (!calc_dirtyrate_ready(who) && max_try_count--) {
2244         usleep(1000);
2245     }
2246 
2247     /*
2248      * Set the timeout with 10 s(max_try_count * 1000us),
2249      * if dirtyrate measurement not complete, fail test.
2250      */
2251     g_assert_cmpint(max_try_count, !=, 0);
2252 }
2253 
2254 static int64_t get_dirty_rate(QTestState *who)
2255 {
2256     QDict *rsp_return;
2257     gchar *status;
2258     QList *rates;
2259     const QListEntry *entry;
2260     QDict *rate;
2261     int64_t dirtyrate;
2262 
2263     rsp_return = query_dirty_rate(who);
2264     g_assert(rsp_return);
2265 
2266     status = g_strdup(qdict_get_str(rsp_return, "status"));
2267     g_assert(status);
2268     g_assert_cmpstr(status, ==, "measured");
2269 
2270     rates = qdict_get_qlist(rsp_return, "vcpu-dirty-rate");
2271     g_assert(rates && !qlist_empty(rates));
2272 
2273     entry = qlist_first(rates);
2274     g_assert(entry);
2275 
2276     rate = qobject_to(QDict, qlist_entry_obj(entry));
2277     g_assert(rate);
2278 
2279     dirtyrate = qdict_get_try_int(rate, "dirty-rate", -1);
2280 
2281     qobject_unref(rsp_return);
2282     return dirtyrate;
2283 }
2284 
2285 static int64_t get_limit_rate(QTestState *who)
2286 {
2287     QDict *rsp_return;
2288     QList *rates;
2289     const QListEntry *entry;
2290     QDict *rate;
2291     int64_t dirtyrate;
2292 
2293     rsp_return = query_vcpu_dirty_limit(who);
2294     g_assert(rsp_return);
2295 
2296     rates = qdict_get_qlist(rsp_return, "return");
2297     g_assert(rates && !qlist_empty(rates));
2298 
2299     entry = qlist_first(rates);
2300     g_assert(entry);
2301 
2302     rate = qobject_to(QDict, qlist_entry_obj(entry));
2303     g_assert(rate);
2304 
2305     dirtyrate = qdict_get_try_int(rate, "limit-rate", -1);
2306 
2307     qobject_unref(rsp_return);
2308     return dirtyrate;
2309 }
2310 
2311 static QTestState *dirtylimit_start_vm(void)
2312 {
2313     QTestState *vm = NULL;
2314     g_autofree gchar *cmd = NULL;
2315     const char *arch = qtest_get_arch();
2316     g_autofree char *bootpath = NULL;
2317 
2318     assert((strcmp(arch, "x86_64") == 0));
2319     bootpath = g_strdup_printf("%s/bootsect", tmpfs);
2320     assert(sizeof(x86_bootsect) == 512);
2321     init_bootfile(bootpath, x86_bootsect, sizeof(x86_bootsect));
2322 
2323     cmd = g_strdup_printf("-accel kvm,dirty-ring-size=4096 "
2324                           "-name dirtylimit-test,debug-threads=on "
2325                           "-m 150M -smp 1 "
2326                           "-serial file:%s/vm_serial "
2327                           "-drive file=%s,format=raw ",
2328                           tmpfs, bootpath);
2329 
2330     vm = qtest_init(cmd);
2331     return vm;
2332 }
2333 
2334 static void dirtylimit_stop_vm(QTestState *vm)
2335 {
2336     qtest_quit(vm);
2337     cleanup("bootsect");
2338     cleanup("vm_serial");
2339 }
2340 
2341 static void test_vcpu_dirty_limit(void)
2342 {
2343     QTestState *vm;
2344     int64_t origin_rate;
2345     int64_t quota_rate;
2346     int64_t rate ;
2347     int max_try_count = 20;
2348     int hit = 0;
2349 
2350     /* Start vm for vcpu dirtylimit test */
2351     vm = dirtylimit_start_vm();
2352 
2353     /* Wait for the first serial output from the vm*/
2354     wait_for_serial("vm_serial");
2355 
2356     /* Do dirtyrate measurement with calc time equals 1s */
2357     calc_dirty_rate(vm, 1);
2358 
2359     /* Sleep calc time and wait for calc dirtyrate complete */
2360     wait_for_calc_dirtyrate_complete(vm, 1);
2361 
2362     /* Query original dirty page rate */
2363     origin_rate = get_dirty_rate(vm);
2364 
2365     /* VM booted from bootsect should dirty memory steadily */
2366     assert(origin_rate != 0);
2367 
2368     /* Setup quota dirty page rate at half of origin */
2369     quota_rate = origin_rate / 2;
2370 
2371     /* Set dirtylimit */
2372     dirtylimit_set_all(vm, quota_rate);
2373 
2374     /*
2375      * Check if set-vcpu-dirty-limit and query-vcpu-dirty-limit
2376      * works literally
2377      */
2378     g_assert_cmpint(quota_rate, ==, get_limit_rate(vm));
2379 
2380     /* Sleep a bit to check if it take effect */
2381     usleep(2000000);
2382 
2383     /*
2384      * Check if dirtylimit take effect realistically, set the
2385      * timeout with 20 s(max_try_count * 1s), if dirtylimit
2386      * doesn't take effect, fail test.
2387      */
2388     while (--max_try_count) {
2389         calc_dirty_rate(vm, 1);
2390         wait_for_calc_dirtyrate_complete(vm, 1);
2391         rate = get_dirty_rate(vm);
2392 
2393         /*
2394          * Assume hitting if current rate is less
2395          * than quota rate (within accepting error)
2396          */
2397         if (rate < (quota_rate + DIRTYLIMIT_TOLERANCE_RANGE)) {
2398             hit = 1;
2399             break;
2400         }
2401     }
2402 
2403     g_assert_cmpint(hit, ==, 1);
2404 
2405     hit = 0;
2406     max_try_count = 20;
2407 
2408     /* Check if dirtylimit cancellation take effect */
2409     cancel_vcpu_dirty_limit(vm);
2410     while (--max_try_count) {
2411         calc_dirty_rate(vm, 1);
2412         wait_for_calc_dirtyrate_complete(vm, 1);
2413         rate = get_dirty_rate(vm);
2414 
2415         /*
2416          * Assume dirtylimit be canceled if current rate is
2417          * greater than quota rate (within accepting error)
2418          */
2419         if (rate > (quota_rate + DIRTYLIMIT_TOLERANCE_RANGE)) {
2420             hit = 1;
2421             break;
2422         }
2423     }
2424 
2425     g_assert_cmpint(hit, ==, 1);
2426     dirtylimit_stop_vm(vm);
2427 }
2428 
2429 static bool kvm_dirty_ring_supported(void)
2430 {
2431 #if defined(__linux__) && defined(HOST_X86_64)
2432     int ret, kvm_fd = open("/dev/kvm", O_RDONLY);
2433 
2434     if (kvm_fd < 0) {
2435         return false;
2436     }
2437 
2438     ret = ioctl(kvm_fd, KVM_CHECK_EXTENSION, KVM_CAP_DIRTY_LOG_RING);
2439     close(kvm_fd);
2440 
2441     /* We test with 4096 slots */
2442     if (ret < 4096) {
2443         return false;
2444     }
2445 
2446     return true;
2447 #else
2448     return false;
2449 #endif
2450 }
2451 
2452 int main(int argc, char **argv)
2453 {
2454     const bool has_kvm = qtest_has_accel("kvm");
2455     const bool has_uffd = ufd_version_check();
2456     const char *arch = qtest_get_arch();
2457     g_autoptr(GError) err = NULL;
2458     int ret;
2459 
2460     g_test_init(&argc, &argv, NULL);
2461 
2462     /*
2463      * On ppc64, the test only works with kvm-hv, but not with kvm-pr and TCG
2464      * is touchy due to race conditions on dirty bits (especially on PPC for
2465      * some reason)
2466      */
2467     if (g_str_equal(arch, "ppc64") &&
2468         (!has_kvm || access("/sys/module/kvm_hv", F_OK))) {
2469         g_test_message("Skipping test: kvm_hv not available");
2470         return g_test_run();
2471     }
2472 
2473     /*
2474      * Similar to ppc64, s390x seems to be touchy with TCG, so disable it
2475      * there until the problems are resolved
2476      */
2477     if (g_str_equal(arch, "s390x") && !has_kvm) {
2478         g_test_message("Skipping test: s390x host with KVM is required");
2479         return g_test_run();
2480     }
2481 
2482     tmpfs = g_dir_make_tmp("migration-test-XXXXXX", &err);
2483     if (!tmpfs) {
2484         g_test_message("Can't create temporary directory in %s: %s",
2485                        g_get_tmp_dir(), err->message);
2486     }
2487     g_assert(tmpfs);
2488 
2489     module_call_init(MODULE_INIT_QOM);
2490 
2491     if (has_uffd) {
2492         qtest_add_func("/migration/postcopy/plain", test_postcopy);
2493         qtest_add_func("/migration/postcopy/recovery/plain",
2494                        test_postcopy_recovery);
2495         qtest_add_func("/migration/postcopy/preempt/plain", test_postcopy_preempt);
2496         qtest_add_func("/migration/postcopy/preempt/recovery/plain",
2497                        test_postcopy_preempt_recovery);
2498     }
2499 
2500     qtest_add_func("/migration/bad_dest", test_baddest);
2501     qtest_add_func("/migration/precopy/unix/plain", test_precopy_unix_plain);
2502     qtest_add_func("/migration/precopy/unix/xbzrle", test_precopy_unix_xbzrle);
2503 #ifdef CONFIG_GNUTLS
2504 #ifndef _WIN32
2505     qtest_add_func("/migration/precopy/unix/tls/psk",
2506                    test_precopy_unix_tls_psk);
2507 #endif
2508 
2509     if (has_uffd) {
2510         /*
2511          * NOTE: psk test is enough for postcopy, as other types of TLS
2512          * channels are tested under precopy.  Here what we want to test is the
2513          * general postcopy path that has TLS channel enabled.
2514          */
2515         qtest_add_func("/migration/postcopy/tls/psk", test_postcopy_tls_psk);
2516         qtest_add_func("/migration/postcopy/recovery/tls/psk",
2517                        test_postcopy_recovery_tls_psk);
2518         qtest_add_func("/migration/postcopy/preempt/tls/psk",
2519                        test_postcopy_preempt_tls_psk);
2520         qtest_add_func("/migration/postcopy/preempt/recovery/tls/psk",
2521                        test_postcopy_preempt_all);
2522     }
2523 #ifdef CONFIG_TASN1
2524     qtest_add_func("/migration/precopy/unix/tls/x509/default-host",
2525                    test_precopy_unix_tls_x509_default_host);
2526     qtest_add_func("/migration/precopy/unix/tls/x509/override-host",
2527                    test_precopy_unix_tls_x509_override_host);
2528 #endif /* CONFIG_TASN1 */
2529 #endif /* CONFIG_GNUTLS */
2530 
2531     qtest_add_func("/migration/precopy/tcp/plain", test_precopy_tcp_plain);
2532 #ifdef CONFIG_GNUTLS
2533 #ifndef _WIN32
2534     qtest_add_func("/migration/precopy/tcp/tls/psk/match",
2535                    test_precopy_tcp_tls_psk_match);
2536 #endif
2537     qtest_add_func("/migration/precopy/tcp/tls/psk/mismatch",
2538                    test_precopy_tcp_tls_psk_mismatch);
2539 #ifdef CONFIG_TASN1
2540     qtest_add_func("/migration/precopy/tcp/tls/x509/default-host",
2541                    test_precopy_tcp_tls_x509_default_host);
2542     qtest_add_func("/migration/precopy/tcp/tls/x509/override-host",
2543                    test_precopy_tcp_tls_x509_override_host);
2544     qtest_add_func("/migration/precopy/tcp/tls/x509/mismatch-host",
2545                    test_precopy_tcp_tls_x509_mismatch_host);
2546     qtest_add_func("/migration/precopy/tcp/tls/x509/friendly-client",
2547                    test_precopy_tcp_tls_x509_friendly_client);
2548     qtest_add_func("/migration/precopy/tcp/tls/x509/hostile-client",
2549                    test_precopy_tcp_tls_x509_hostile_client);
2550     qtest_add_func("/migration/precopy/tcp/tls/x509/allow-anon-client",
2551                    test_precopy_tcp_tls_x509_allow_anon_client);
2552     qtest_add_func("/migration/precopy/tcp/tls/x509/reject-anon-client",
2553                    test_precopy_tcp_tls_x509_reject_anon_client);
2554 #endif /* CONFIG_TASN1 */
2555 #endif /* CONFIG_GNUTLS */
2556 
2557     /* qtest_add_func("/migration/ignore_shared", test_ignore_shared); */
2558 #ifndef _WIN32
2559     qtest_add_func("/migration/fd_proto", test_migrate_fd_proto);
2560 #endif
2561     qtest_add_func("/migration/validate_uuid", test_validate_uuid);
2562     qtest_add_func("/migration/validate_uuid_error", test_validate_uuid_error);
2563     qtest_add_func("/migration/validate_uuid_src_not_set",
2564                    test_validate_uuid_src_not_set);
2565     qtest_add_func("/migration/validate_uuid_dst_not_set",
2566                    test_validate_uuid_dst_not_set);
2567 
2568     qtest_add_func("/migration/auto_converge", test_migrate_auto_converge);
2569     qtest_add_func("/migration/multifd/tcp/plain/none",
2570                    test_multifd_tcp_none);
2571     qtest_add_func("/migration/multifd/tcp/plain/cancel",
2572                    test_multifd_tcp_cancel);
2573     qtest_add_func("/migration/multifd/tcp/plain/zlib",
2574                    test_multifd_tcp_zlib);
2575 #ifdef CONFIG_ZSTD
2576     qtest_add_func("/migration/multifd/tcp/plain/zstd",
2577                    test_multifd_tcp_zstd);
2578 #endif
2579 #ifdef CONFIG_GNUTLS
2580 #ifndef _WIN32
2581     qtest_add_func("/migration/multifd/tcp/tls/psk/match",
2582                    test_multifd_tcp_tls_psk_match);
2583 #endif
2584     qtest_add_func("/migration/multifd/tcp/tls/psk/mismatch",
2585                    test_multifd_tcp_tls_psk_mismatch);
2586 #ifdef CONFIG_TASN1
2587     qtest_add_func("/migration/multifd/tcp/tls/x509/default-host",
2588                    test_multifd_tcp_tls_x509_default_host);
2589     qtest_add_func("/migration/multifd/tcp/tls/x509/override-host",
2590                    test_multifd_tcp_tls_x509_override_host);
2591     qtest_add_func("/migration/multifd/tcp/tls/x509/mismatch-host",
2592                    test_multifd_tcp_tls_x509_mismatch_host);
2593     qtest_add_func("/migration/multifd/tcp/tls/x509/allow-anon-client",
2594                    test_multifd_tcp_tls_x509_allow_anon_client);
2595     qtest_add_func("/migration/multifd/tcp/tls/x509/reject-anon-client",
2596                    test_multifd_tcp_tls_x509_reject_anon_client);
2597 #endif /* CONFIG_TASN1 */
2598 #endif /* CONFIG_GNUTLS */
2599 
2600     if (g_str_equal(arch, "x86_64") && has_kvm && kvm_dirty_ring_supported()) {
2601         qtest_add_func("/migration/dirty_ring",
2602                        test_precopy_unix_dirty_ring);
2603         qtest_add_func("/migration/vcpu_dirty_limit",
2604                        test_vcpu_dirty_limit);
2605     }
2606 
2607     ret = g_test_run();
2608 
2609     g_assert_cmpint(ret, ==, 0);
2610 
2611     ret = rmdir(tmpfs);
2612     if (ret != 0) {
2613         g_test_message("unable to rmdir: path (%s): %s",
2614                        tmpfs, strerror(errno));
2615     }
2616     g_free(tmpfs);
2617 
2618     return ret;
2619 }
2620