xref: /openbmc/qemu/migration/options.c (revision 4ed49feb)
1 /*
2  * QEMU migration capabilities
3  *
4  * Copyright (c) 2012-2023 Red Hat Inc
5  *
6  * Authors:
7  *   Orit Wasserman <owasserm@redhat.com>
8  *   Juan Quintela <quintela@redhat.com>
9  *
10  * This work is licensed under the terms of the GNU GPL, version 2 or later.
11  * See the COPYING file in the top-level directory.
12  */
13 
14 #include "qemu/osdep.h"
15 #include "qemu/error-report.h"
16 #include "exec/target_page.h"
17 #include "qapi/clone-visitor.h"
18 #include "qapi/error.h"
19 #include "qapi/qapi-commands-migration.h"
20 #include "qapi/qapi-visit-migration.h"
21 #include "qapi/qmp/qerror.h"
22 #include "qapi/qmp/qnull.h"
23 #include "sysemu/runstate.h"
24 #include "migration/colo.h"
25 #include "migration/misc.h"
26 #include "migration.h"
27 #include "migration-stats.h"
28 #include "qemu-file.h"
29 #include "ram.h"
30 #include "options.h"
31 #include "sysemu/kvm.h"
32 
33 /* Maximum migrate downtime set to 2000 seconds */
34 #define MAX_MIGRATE_DOWNTIME_SECONDS 2000
35 #define MAX_MIGRATE_DOWNTIME (MAX_MIGRATE_DOWNTIME_SECONDS * 1000)
36 
37 #define MAX_THROTTLE  (128 << 20)      /* Migration transfer speed throttling */
38 
39 /* Time in milliseconds we are allowed to stop the source,
40  * for sending the last part */
41 #define DEFAULT_MIGRATE_SET_DOWNTIME 300
42 
43 /* Default compression thread count */
44 #define DEFAULT_MIGRATE_COMPRESS_THREAD_COUNT 8
45 /* Default decompression thread count, usually decompression is at
46  * least 4 times as fast as compression.*/
47 #define DEFAULT_MIGRATE_DECOMPRESS_THREAD_COUNT 2
48 /*0: means nocompress, 1: best speed, ... 9: best compress ratio */
49 #define DEFAULT_MIGRATE_COMPRESS_LEVEL 1
50 /* Define default autoconverge cpu throttle migration parameters */
51 #define DEFAULT_MIGRATE_THROTTLE_TRIGGER_THRESHOLD 50
52 #define DEFAULT_MIGRATE_CPU_THROTTLE_INITIAL 20
53 #define DEFAULT_MIGRATE_CPU_THROTTLE_INCREMENT 10
54 #define DEFAULT_MIGRATE_MAX_CPU_THROTTLE 99
55 
56 /* Migration XBZRLE default cache size */
57 #define DEFAULT_MIGRATE_XBZRLE_CACHE_SIZE (64 * 1024 * 1024)
58 
59 /* The delay time (in ms) between two COLO checkpoints */
60 #define DEFAULT_MIGRATE_X_CHECKPOINT_DELAY (200 * 100)
61 #define DEFAULT_MIGRATE_MULTIFD_CHANNELS 2
62 #define DEFAULT_MIGRATE_MULTIFD_COMPRESSION MULTIFD_COMPRESSION_NONE
63 /* 0: means nocompress, 1: best speed, ... 9: best compress ratio */
64 #define DEFAULT_MIGRATE_MULTIFD_ZLIB_LEVEL 1
65 /* 0: means nocompress, 1: best speed, ... 20: best compress ratio */
66 #define DEFAULT_MIGRATE_MULTIFD_ZSTD_LEVEL 1
67 
68 /* Background transfer rate for postcopy, 0 means unlimited, note
69  * that page requests can still exceed this limit.
70  */
71 #define DEFAULT_MIGRATE_MAX_POSTCOPY_BANDWIDTH 0
72 
73 /*
74  * Parameters for self_announce_delay giving a stream of RARP/ARP
75  * packets after migration.
76  */
77 #define DEFAULT_MIGRATE_ANNOUNCE_INITIAL  50
78 #define DEFAULT_MIGRATE_ANNOUNCE_MAX     550
79 #define DEFAULT_MIGRATE_ANNOUNCE_ROUNDS    5
80 #define DEFAULT_MIGRATE_ANNOUNCE_STEP    100
81 
82 #define DEFINE_PROP_MIG_CAP(name, x)             \
83     DEFINE_PROP_BOOL(name, MigrationState, capabilities[x], false)
84 
85 #define DEFAULT_MIGRATE_VCPU_DIRTY_LIMIT_PERIOD     1000    /* milliseconds */
86 #define DEFAULT_MIGRATE_VCPU_DIRTY_LIMIT            1       /* MB/s */
87 
88 Property migration_properties[] = {
89     DEFINE_PROP_BOOL("store-global-state", MigrationState,
90                      store_global_state, true),
91     DEFINE_PROP_BOOL("send-configuration", MigrationState,
92                      send_configuration, true),
93     DEFINE_PROP_BOOL("send-section-footer", MigrationState,
94                      send_section_footer, true),
95     DEFINE_PROP_BOOL("decompress-error-check", MigrationState,
96                       decompress_error_check, true),
97     DEFINE_PROP_BOOL("multifd-flush-after-each-section", MigrationState,
98                       multifd_flush_after_each_section, false),
99     DEFINE_PROP_UINT8("x-clear-bitmap-shift", MigrationState,
100                       clear_bitmap_shift, CLEAR_BITMAP_SHIFT_DEFAULT),
101     DEFINE_PROP_BOOL("x-preempt-pre-7-2", MigrationState,
102                      preempt_pre_7_2, false),
103 
104     /* Migration parameters */
105     DEFINE_PROP_UINT8("x-compress-level", MigrationState,
106                       parameters.compress_level,
107                       DEFAULT_MIGRATE_COMPRESS_LEVEL),
108     DEFINE_PROP_UINT8("x-compress-threads", MigrationState,
109                       parameters.compress_threads,
110                       DEFAULT_MIGRATE_COMPRESS_THREAD_COUNT),
111     DEFINE_PROP_BOOL("x-compress-wait-thread", MigrationState,
112                       parameters.compress_wait_thread, true),
113     DEFINE_PROP_UINT8("x-decompress-threads", MigrationState,
114                       parameters.decompress_threads,
115                       DEFAULT_MIGRATE_DECOMPRESS_THREAD_COUNT),
116     DEFINE_PROP_UINT8("x-throttle-trigger-threshold", MigrationState,
117                       parameters.throttle_trigger_threshold,
118                       DEFAULT_MIGRATE_THROTTLE_TRIGGER_THRESHOLD),
119     DEFINE_PROP_UINT8("x-cpu-throttle-initial", MigrationState,
120                       parameters.cpu_throttle_initial,
121                       DEFAULT_MIGRATE_CPU_THROTTLE_INITIAL),
122     DEFINE_PROP_UINT8("x-cpu-throttle-increment", MigrationState,
123                       parameters.cpu_throttle_increment,
124                       DEFAULT_MIGRATE_CPU_THROTTLE_INCREMENT),
125     DEFINE_PROP_BOOL("x-cpu-throttle-tailslow", MigrationState,
126                       parameters.cpu_throttle_tailslow, false),
127     DEFINE_PROP_SIZE("x-max-bandwidth", MigrationState,
128                       parameters.max_bandwidth, MAX_THROTTLE),
129     DEFINE_PROP_SIZE("avail-switchover-bandwidth", MigrationState,
130                       parameters.avail_switchover_bandwidth, 0),
131     DEFINE_PROP_UINT64("x-downtime-limit", MigrationState,
132                       parameters.downtime_limit,
133                       DEFAULT_MIGRATE_SET_DOWNTIME),
134     DEFINE_PROP_UINT32("x-checkpoint-delay", MigrationState,
135                       parameters.x_checkpoint_delay,
136                       DEFAULT_MIGRATE_X_CHECKPOINT_DELAY),
137     DEFINE_PROP_UINT8("multifd-channels", MigrationState,
138                       parameters.multifd_channels,
139                       DEFAULT_MIGRATE_MULTIFD_CHANNELS),
140     DEFINE_PROP_MULTIFD_COMPRESSION("multifd-compression", MigrationState,
141                       parameters.multifd_compression,
142                       DEFAULT_MIGRATE_MULTIFD_COMPRESSION),
143     DEFINE_PROP_UINT8("multifd-zlib-level", MigrationState,
144                       parameters.multifd_zlib_level,
145                       DEFAULT_MIGRATE_MULTIFD_ZLIB_LEVEL),
146     DEFINE_PROP_UINT8("multifd-zstd-level", MigrationState,
147                       parameters.multifd_zstd_level,
148                       DEFAULT_MIGRATE_MULTIFD_ZSTD_LEVEL),
149     DEFINE_PROP_SIZE("xbzrle-cache-size", MigrationState,
150                       parameters.xbzrle_cache_size,
151                       DEFAULT_MIGRATE_XBZRLE_CACHE_SIZE),
152     DEFINE_PROP_SIZE("max-postcopy-bandwidth", MigrationState,
153                       parameters.max_postcopy_bandwidth,
154                       DEFAULT_MIGRATE_MAX_POSTCOPY_BANDWIDTH),
155     DEFINE_PROP_UINT8("max-cpu-throttle", MigrationState,
156                       parameters.max_cpu_throttle,
157                       DEFAULT_MIGRATE_MAX_CPU_THROTTLE),
158     DEFINE_PROP_SIZE("announce-initial", MigrationState,
159                       parameters.announce_initial,
160                       DEFAULT_MIGRATE_ANNOUNCE_INITIAL),
161     DEFINE_PROP_SIZE("announce-max", MigrationState,
162                       parameters.announce_max,
163                       DEFAULT_MIGRATE_ANNOUNCE_MAX),
164     DEFINE_PROP_SIZE("announce-rounds", MigrationState,
165                       parameters.announce_rounds,
166                       DEFAULT_MIGRATE_ANNOUNCE_ROUNDS),
167     DEFINE_PROP_SIZE("announce-step", MigrationState,
168                       parameters.announce_step,
169                       DEFAULT_MIGRATE_ANNOUNCE_STEP),
170     DEFINE_PROP_STRING("tls-creds", MigrationState, parameters.tls_creds),
171     DEFINE_PROP_STRING("tls-hostname", MigrationState, parameters.tls_hostname),
172     DEFINE_PROP_STRING("tls-authz", MigrationState, parameters.tls_authz),
173     DEFINE_PROP_UINT64("x-vcpu-dirty-limit-period", MigrationState,
174                        parameters.x_vcpu_dirty_limit_period,
175                        DEFAULT_MIGRATE_VCPU_DIRTY_LIMIT_PERIOD),
176     DEFINE_PROP_UINT64("vcpu-dirty-limit", MigrationState,
177                        parameters.vcpu_dirty_limit,
178                        DEFAULT_MIGRATE_VCPU_DIRTY_LIMIT),
179     DEFINE_PROP_MIG_MODE("mode", MigrationState,
180                       parameters.mode,
181                       MIG_MODE_NORMAL),
182 
183     /* Migration capabilities */
184     DEFINE_PROP_MIG_CAP("x-xbzrle", MIGRATION_CAPABILITY_XBZRLE),
185     DEFINE_PROP_MIG_CAP("x-rdma-pin-all", MIGRATION_CAPABILITY_RDMA_PIN_ALL),
186     DEFINE_PROP_MIG_CAP("x-auto-converge", MIGRATION_CAPABILITY_AUTO_CONVERGE),
187     DEFINE_PROP_MIG_CAP("x-zero-blocks", MIGRATION_CAPABILITY_ZERO_BLOCKS),
188     DEFINE_PROP_MIG_CAP("x-compress", MIGRATION_CAPABILITY_COMPRESS),
189     DEFINE_PROP_MIG_CAP("x-events", MIGRATION_CAPABILITY_EVENTS),
190     DEFINE_PROP_MIG_CAP("x-postcopy-ram", MIGRATION_CAPABILITY_POSTCOPY_RAM),
191     DEFINE_PROP_MIG_CAP("x-postcopy-preempt",
192                         MIGRATION_CAPABILITY_POSTCOPY_PREEMPT),
193     DEFINE_PROP_MIG_CAP("x-colo", MIGRATION_CAPABILITY_X_COLO),
194     DEFINE_PROP_MIG_CAP("x-release-ram", MIGRATION_CAPABILITY_RELEASE_RAM),
195     DEFINE_PROP_MIG_CAP("x-block", MIGRATION_CAPABILITY_BLOCK),
196     DEFINE_PROP_MIG_CAP("x-return-path", MIGRATION_CAPABILITY_RETURN_PATH),
197     DEFINE_PROP_MIG_CAP("x-multifd", MIGRATION_CAPABILITY_MULTIFD),
198     DEFINE_PROP_MIG_CAP("x-background-snapshot",
199             MIGRATION_CAPABILITY_BACKGROUND_SNAPSHOT),
200 #ifdef CONFIG_LINUX
201     DEFINE_PROP_MIG_CAP("x-zero-copy-send",
202             MIGRATION_CAPABILITY_ZERO_COPY_SEND),
203 #endif
204     DEFINE_PROP_MIG_CAP("x-switchover-ack",
205                         MIGRATION_CAPABILITY_SWITCHOVER_ACK),
206     DEFINE_PROP_MIG_CAP("x-dirty-limit", MIGRATION_CAPABILITY_DIRTY_LIMIT),
207     DEFINE_PROP_MIG_CAP("mapped-ram", MIGRATION_CAPABILITY_MAPPED_RAM),
208     DEFINE_PROP_END_OF_LIST(),
209 };
210 
211 bool migrate_auto_converge(void)
212 {
213     MigrationState *s = migrate_get_current();
214 
215     return s->capabilities[MIGRATION_CAPABILITY_AUTO_CONVERGE];
216 }
217 
218 bool migrate_background_snapshot(void)
219 {
220     MigrationState *s = migrate_get_current();
221 
222     return s->capabilities[MIGRATION_CAPABILITY_BACKGROUND_SNAPSHOT];
223 }
224 
225 bool migrate_block(void)
226 {
227     MigrationState *s = migrate_get_current();
228 
229     return s->capabilities[MIGRATION_CAPABILITY_BLOCK];
230 }
231 
232 bool migrate_colo(void)
233 {
234     MigrationState *s = migrate_get_current();
235 
236     return s->capabilities[MIGRATION_CAPABILITY_X_COLO];
237 }
238 
239 bool migrate_compress(void)
240 {
241     MigrationState *s = migrate_get_current();
242 
243     return s->capabilities[MIGRATION_CAPABILITY_COMPRESS];
244 }
245 
246 bool migrate_dirty_bitmaps(void)
247 {
248     MigrationState *s = migrate_get_current();
249 
250     return s->capabilities[MIGRATION_CAPABILITY_DIRTY_BITMAPS];
251 }
252 
253 bool migrate_dirty_limit(void)
254 {
255     MigrationState *s = migrate_get_current();
256 
257     return s->capabilities[MIGRATION_CAPABILITY_DIRTY_LIMIT];
258 }
259 
260 bool migrate_events(void)
261 {
262     MigrationState *s = migrate_get_current();
263 
264     return s->capabilities[MIGRATION_CAPABILITY_EVENTS];
265 }
266 
267 bool migrate_mapped_ram(void)
268 {
269     MigrationState *s = migrate_get_current();
270 
271     return s->capabilities[MIGRATION_CAPABILITY_MAPPED_RAM];
272 }
273 
274 bool migrate_ignore_shared(void)
275 {
276     MigrationState *s = migrate_get_current();
277 
278     return s->capabilities[MIGRATION_CAPABILITY_X_IGNORE_SHARED];
279 }
280 
281 bool migrate_late_block_activate(void)
282 {
283     MigrationState *s = migrate_get_current();
284 
285     return s->capabilities[MIGRATION_CAPABILITY_LATE_BLOCK_ACTIVATE];
286 }
287 
288 bool migrate_multifd(void)
289 {
290     MigrationState *s = migrate_get_current();
291 
292     return s->capabilities[MIGRATION_CAPABILITY_MULTIFD];
293 }
294 
295 bool migrate_pause_before_switchover(void)
296 {
297     MigrationState *s = migrate_get_current();
298 
299     return s->capabilities[MIGRATION_CAPABILITY_PAUSE_BEFORE_SWITCHOVER];
300 }
301 
302 bool migrate_postcopy_blocktime(void)
303 {
304     MigrationState *s = migrate_get_current();
305 
306     return s->capabilities[MIGRATION_CAPABILITY_POSTCOPY_BLOCKTIME];
307 }
308 
309 bool migrate_postcopy_preempt(void)
310 {
311     MigrationState *s = migrate_get_current();
312 
313     return s->capabilities[MIGRATION_CAPABILITY_POSTCOPY_PREEMPT];
314 }
315 
316 bool migrate_postcopy_ram(void)
317 {
318     MigrationState *s = migrate_get_current();
319 
320     return s->capabilities[MIGRATION_CAPABILITY_POSTCOPY_RAM];
321 }
322 
323 bool migrate_rdma_pin_all(void)
324 {
325     MigrationState *s = migrate_get_current();
326 
327     return s->capabilities[MIGRATION_CAPABILITY_RDMA_PIN_ALL];
328 }
329 
330 bool migrate_release_ram(void)
331 {
332     MigrationState *s = migrate_get_current();
333 
334     return s->capabilities[MIGRATION_CAPABILITY_RELEASE_RAM];
335 }
336 
337 bool migrate_return_path(void)
338 {
339     MigrationState *s = migrate_get_current();
340 
341     return s->capabilities[MIGRATION_CAPABILITY_RETURN_PATH];
342 }
343 
344 bool migrate_switchover_ack(void)
345 {
346     MigrationState *s = migrate_get_current();
347 
348     return s->capabilities[MIGRATION_CAPABILITY_SWITCHOVER_ACK];
349 }
350 
351 bool migrate_validate_uuid(void)
352 {
353     MigrationState *s = migrate_get_current();
354 
355     return s->capabilities[MIGRATION_CAPABILITY_VALIDATE_UUID];
356 }
357 
358 bool migrate_xbzrle(void)
359 {
360     MigrationState *s = migrate_get_current();
361 
362     return s->capabilities[MIGRATION_CAPABILITY_XBZRLE];
363 }
364 
365 bool migrate_zero_blocks(void)
366 {
367     MigrationState *s = migrate_get_current();
368 
369     return s->capabilities[MIGRATION_CAPABILITY_ZERO_BLOCKS];
370 }
371 
372 bool migrate_zero_copy_send(void)
373 {
374     MigrationState *s = migrate_get_current();
375 
376     return s->capabilities[MIGRATION_CAPABILITY_ZERO_COPY_SEND];
377 }
378 
379 /* pseudo capabilities */
380 
381 bool migrate_multifd_flush_after_each_section(void)
382 {
383     MigrationState *s = migrate_get_current();
384 
385     return s->multifd_flush_after_each_section;
386 }
387 
388 bool migrate_postcopy(void)
389 {
390     return migrate_postcopy_ram() || migrate_dirty_bitmaps();
391 }
392 
393 bool migrate_rdma(void)
394 {
395     MigrationState *s = migrate_get_current();
396 
397     return s->rdma_migration;
398 }
399 
400 bool migrate_tls(void)
401 {
402     MigrationState *s = migrate_get_current();
403 
404     return s->parameters.tls_creds && *s->parameters.tls_creds;
405 }
406 
407 typedef enum WriteTrackingSupport {
408     WT_SUPPORT_UNKNOWN = 0,
409     WT_SUPPORT_ABSENT,
410     WT_SUPPORT_AVAILABLE,
411     WT_SUPPORT_COMPATIBLE
412 } WriteTrackingSupport;
413 
414 static
415 WriteTrackingSupport migrate_query_write_tracking(void)
416 {
417     /* Check if kernel supports required UFFD features */
418     if (!ram_write_tracking_available()) {
419         return WT_SUPPORT_ABSENT;
420     }
421     /*
422      * Check if current memory configuration is
423      * compatible with required UFFD features.
424      */
425     if (!ram_write_tracking_compatible()) {
426         return WT_SUPPORT_AVAILABLE;
427     }
428 
429     return WT_SUPPORT_COMPATIBLE;
430 }
431 
432 /* Migration capabilities set */
433 struct MigrateCapsSet {
434     int size;                       /* Capability set size */
435     MigrationCapability caps[];     /* Variadic array of capabilities */
436 };
437 typedef struct MigrateCapsSet MigrateCapsSet;
438 
439 /* Define and initialize MigrateCapsSet */
440 #define INITIALIZE_MIGRATE_CAPS_SET(_name, ...)   \
441     MigrateCapsSet _name = {    \
442         .size = sizeof((int []) { __VA_ARGS__ }) / sizeof(int), \
443         .caps = { __VA_ARGS__ } \
444     }
445 
446 /* Background-snapshot compatibility check list */
447 static const
448 INITIALIZE_MIGRATE_CAPS_SET(check_caps_background_snapshot,
449     MIGRATION_CAPABILITY_POSTCOPY_RAM,
450     MIGRATION_CAPABILITY_DIRTY_BITMAPS,
451     MIGRATION_CAPABILITY_POSTCOPY_BLOCKTIME,
452     MIGRATION_CAPABILITY_LATE_BLOCK_ACTIVATE,
453     MIGRATION_CAPABILITY_RETURN_PATH,
454     MIGRATION_CAPABILITY_MULTIFD,
455     MIGRATION_CAPABILITY_PAUSE_BEFORE_SWITCHOVER,
456     MIGRATION_CAPABILITY_AUTO_CONVERGE,
457     MIGRATION_CAPABILITY_RELEASE_RAM,
458     MIGRATION_CAPABILITY_RDMA_PIN_ALL,
459     MIGRATION_CAPABILITY_COMPRESS,
460     MIGRATION_CAPABILITY_XBZRLE,
461     MIGRATION_CAPABILITY_X_COLO,
462     MIGRATION_CAPABILITY_VALIDATE_UUID,
463     MIGRATION_CAPABILITY_ZERO_COPY_SEND);
464 
465 static bool migrate_incoming_started(void)
466 {
467     return !!migration_incoming_get_current()->transport_data;
468 }
469 
470 /**
471  * @migration_caps_check - check capability compatibility
472  *
473  * @old_caps: old capability list
474  * @new_caps: new capability list
475  * @errp: set *errp if the check failed, with reason
476  *
477  * Returns true if check passed, otherwise false.
478  */
479 bool migrate_caps_check(bool *old_caps, bool *new_caps, Error **errp)
480 {
481     MigrationIncomingState *mis = migration_incoming_get_current();
482 
483     ERRP_GUARD();
484 #ifndef CONFIG_LIVE_BLOCK_MIGRATION
485     if (new_caps[MIGRATION_CAPABILITY_BLOCK]) {
486         error_setg(errp, "QEMU compiled without old-style (blk/-b, inc/-i) "
487                    "block migration");
488         error_append_hint(errp, "Use blockdev-mirror with NBD instead.\n");
489         return false;
490     }
491 #endif
492     if (new_caps[MIGRATION_CAPABILITY_BLOCK]) {
493         warn_report("block migration is deprecated;"
494                     " use blockdev-mirror with NBD instead");
495     }
496 
497     if (new_caps[MIGRATION_CAPABILITY_COMPRESS]) {
498         warn_report("old compression method is deprecated;"
499                     " use multifd compression methods instead");
500     }
501 
502 #ifndef CONFIG_REPLICATION
503     if (new_caps[MIGRATION_CAPABILITY_X_COLO]) {
504         error_setg(errp, "QEMU compiled without replication module"
505                    " can't enable COLO");
506         error_append_hint(errp, "Please enable replication before COLO.\n");
507         return false;
508     }
509 #endif
510 
511     if (new_caps[MIGRATION_CAPABILITY_POSTCOPY_RAM]) {
512         /* This check is reasonably expensive, so only when it's being
513          * set the first time, also it's only the destination that needs
514          * special support.
515          */
516         if (!old_caps[MIGRATION_CAPABILITY_POSTCOPY_RAM] &&
517             runstate_check(RUN_STATE_INMIGRATE) &&
518             !postcopy_ram_supported_by_host(mis, errp)) {
519             error_prepend(errp, "Postcopy is not supported: ");
520             return false;
521         }
522 
523         if (new_caps[MIGRATION_CAPABILITY_X_IGNORE_SHARED]) {
524             error_setg(errp, "Postcopy is not compatible with ignore-shared");
525             return false;
526         }
527 
528         if (new_caps[MIGRATION_CAPABILITY_MULTIFD]) {
529             error_setg(errp, "Postcopy is not yet compatible with multifd");
530             return false;
531         }
532     }
533 
534     if (new_caps[MIGRATION_CAPABILITY_BACKGROUND_SNAPSHOT]) {
535         WriteTrackingSupport wt_support;
536         int idx;
537         /*
538          * Check if 'background-snapshot' capability is supported by
539          * host kernel and compatible with guest memory configuration.
540          */
541         wt_support = migrate_query_write_tracking();
542         if (wt_support < WT_SUPPORT_AVAILABLE) {
543             error_setg(errp, "Background-snapshot is not supported by host kernel");
544             return false;
545         }
546         if (wt_support < WT_SUPPORT_COMPATIBLE) {
547             error_setg(errp, "Background-snapshot is not compatible "
548                     "with guest memory configuration");
549             return false;
550         }
551 
552         /*
553          * Check if there are any migration capabilities
554          * incompatible with 'background-snapshot'.
555          */
556         for (idx = 0; idx < check_caps_background_snapshot.size; idx++) {
557             int incomp_cap = check_caps_background_snapshot.caps[idx];
558             if (new_caps[incomp_cap]) {
559                 error_setg(errp,
560                         "Background-snapshot is not compatible with %s",
561                         MigrationCapability_str(incomp_cap));
562                 return false;
563             }
564         }
565     }
566 
567 #ifdef CONFIG_LINUX
568     if (new_caps[MIGRATION_CAPABILITY_ZERO_COPY_SEND] &&
569         (!new_caps[MIGRATION_CAPABILITY_MULTIFD] ||
570          new_caps[MIGRATION_CAPABILITY_COMPRESS] ||
571          new_caps[MIGRATION_CAPABILITY_XBZRLE] ||
572          migrate_multifd_compression() ||
573          migrate_tls())) {
574         error_setg(errp,
575                    "Zero copy only available for non-compressed non-TLS multifd migration");
576         return false;
577     }
578 #else
579     if (new_caps[MIGRATION_CAPABILITY_ZERO_COPY_SEND]) {
580         error_setg(errp,
581                    "Zero copy currently only available on Linux");
582         return false;
583     }
584 #endif
585 
586     if (new_caps[MIGRATION_CAPABILITY_POSTCOPY_PREEMPT]) {
587         if (!new_caps[MIGRATION_CAPABILITY_POSTCOPY_RAM]) {
588             error_setg(errp, "Postcopy preempt requires postcopy-ram");
589             return false;
590         }
591 
592         /*
593          * Preempt mode requires urgent pages to be sent in separate
594          * channel, OTOH compression logic will disorder all pages into
595          * different compression channels, which is not compatible with the
596          * preempt assumptions on channel assignments.
597          */
598         if (new_caps[MIGRATION_CAPABILITY_COMPRESS]) {
599             error_setg(errp, "Postcopy preempt not compatible with compress");
600             return false;
601         }
602 
603         if (migrate_incoming_started()) {
604             error_setg(errp,
605                        "Postcopy preempt must be set before incoming starts");
606             return false;
607         }
608     }
609 
610     if (new_caps[MIGRATION_CAPABILITY_MULTIFD]) {
611         if (new_caps[MIGRATION_CAPABILITY_COMPRESS]) {
612             error_setg(errp, "Multifd is not compatible with compress");
613             return false;
614         }
615         if (migrate_incoming_started()) {
616             error_setg(errp, "Multifd must be set before incoming starts");
617             return false;
618         }
619     }
620 
621     if (new_caps[MIGRATION_CAPABILITY_SWITCHOVER_ACK]) {
622         if (!new_caps[MIGRATION_CAPABILITY_RETURN_PATH]) {
623             error_setg(errp, "Capability 'switchover-ack' requires capability "
624                              "'return-path'");
625             return false;
626         }
627     }
628     if (new_caps[MIGRATION_CAPABILITY_DIRTY_LIMIT]) {
629         if (new_caps[MIGRATION_CAPABILITY_AUTO_CONVERGE]) {
630             error_setg(errp, "dirty-limit conflicts with auto-converge"
631                        " either of then available currently");
632             return false;
633         }
634 
635         if (!kvm_enabled() || !kvm_dirty_ring_enabled()) {
636             error_setg(errp, "dirty-limit requires KVM with accelerator"
637                    " property 'dirty-ring-size' set");
638             return false;
639         }
640     }
641 
642     if (new_caps[MIGRATION_CAPABILITY_MULTIFD]) {
643         if (new_caps[MIGRATION_CAPABILITY_XBZRLE]) {
644             error_setg(errp, "Multifd is not compatible with xbzrle");
645             return false;
646         }
647     }
648 
649     if (new_caps[MIGRATION_CAPABILITY_COMPRESS]) {
650         if (new_caps[MIGRATION_CAPABILITY_XBZRLE]) {
651             error_setg(errp, "Compression is not compatible with xbzrle");
652             return false;
653         }
654     }
655 
656     if (new_caps[MIGRATION_CAPABILITY_MAPPED_RAM]) {
657         if (new_caps[MIGRATION_CAPABILITY_MULTIFD]) {
658             error_setg(errp,
659                        "Mapped-ram migration is incompatible with multifd");
660             return false;
661         }
662 
663         if (new_caps[MIGRATION_CAPABILITY_XBZRLE]) {
664             error_setg(errp,
665                        "Mapped-ram migration is incompatible with xbzrle");
666             return false;
667         }
668 
669         if (new_caps[MIGRATION_CAPABILITY_COMPRESS]) {
670             error_setg(errp,
671                        "Mapped-ram migration is incompatible with compression");
672             return false;
673         }
674 
675         if (new_caps[MIGRATION_CAPABILITY_POSTCOPY_RAM]) {
676             error_setg(errp,
677                        "Mapped-ram migration is incompatible with postcopy");
678             return false;
679         }
680     }
681 
682     return true;
683 }
684 
685 bool migrate_cap_set(int cap, bool value, Error **errp)
686 {
687     MigrationState *s = migrate_get_current();
688     bool new_caps[MIGRATION_CAPABILITY__MAX];
689 
690     if (migration_is_running(s->state)) {
691         error_setg(errp, QERR_MIGRATION_ACTIVE);
692         return false;
693     }
694 
695     memcpy(new_caps, s->capabilities, sizeof(new_caps));
696     new_caps[cap] = value;
697 
698     if (!migrate_caps_check(s->capabilities, new_caps, errp)) {
699         return false;
700     }
701     s->capabilities[cap] = value;
702     return true;
703 }
704 
705 MigrationCapabilityStatusList *qmp_query_migrate_capabilities(Error **errp)
706 {
707     MigrationCapabilityStatusList *head = NULL, **tail = &head;
708     MigrationCapabilityStatus *caps;
709     MigrationState *s = migrate_get_current();
710     int i;
711 
712     for (i = 0; i < MIGRATION_CAPABILITY__MAX; i++) {
713 #ifndef CONFIG_LIVE_BLOCK_MIGRATION
714         if (i == MIGRATION_CAPABILITY_BLOCK) {
715             continue;
716         }
717 #endif
718         caps = g_malloc0(sizeof(*caps));
719         caps->capability = i;
720         caps->state = s->capabilities[i];
721         QAPI_LIST_APPEND(tail, caps);
722     }
723 
724     return head;
725 }
726 
727 void qmp_migrate_set_capabilities(MigrationCapabilityStatusList *params,
728                                   Error **errp)
729 {
730     MigrationState *s = migrate_get_current();
731     MigrationCapabilityStatusList *cap;
732     bool new_caps[MIGRATION_CAPABILITY__MAX];
733 
734     if (migration_is_running(s->state) || migration_in_colo_state()) {
735         error_setg(errp, QERR_MIGRATION_ACTIVE);
736         return;
737     }
738 
739     memcpy(new_caps, s->capabilities, sizeof(new_caps));
740     for (cap = params; cap; cap = cap->next) {
741         new_caps[cap->value->capability] = cap->value->state;
742     }
743 
744     if (!migrate_caps_check(s->capabilities, new_caps, errp)) {
745         return;
746     }
747 
748     for (cap = params; cap; cap = cap->next) {
749         s->capabilities[cap->value->capability] = cap->value->state;
750     }
751 }
752 
753 /* parameters */
754 
755 const BitmapMigrationNodeAliasList *migrate_block_bitmap_mapping(void)
756 {
757     MigrationState *s = migrate_get_current();
758 
759     return s->parameters.block_bitmap_mapping;
760 }
761 
762 bool migrate_has_block_bitmap_mapping(void)
763 {
764     MigrationState *s = migrate_get_current();
765 
766     return s->parameters.has_block_bitmap_mapping;
767 }
768 
769 bool migrate_block_incremental(void)
770 {
771     MigrationState *s = migrate_get_current();
772 
773     return s->parameters.block_incremental;
774 }
775 
776 uint32_t migrate_checkpoint_delay(void)
777 {
778     MigrationState *s = migrate_get_current();
779 
780     return s->parameters.x_checkpoint_delay;
781 }
782 
783 int migrate_compress_level(void)
784 {
785     MigrationState *s = migrate_get_current();
786 
787     return s->parameters.compress_level;
788 }
789 
790 int migrate_compress_threads(void)
791 {
792     MigrationState *s = migrate_get_current();
793 
794     return s->parameters.compress_threads;
795 }
796 
797 int migrate_compress_wait_thread(void)
798 {
799     MigrationState *s = migrate_get_current();
800 
801     return s->parameters.compress_wait_thread;
802 }
803 
804 uint8_t migrate_cpu_throttle_increment(void)
805 {
806     MigrationState *s = migrate_get_current();
807 
808     return s->parameters.cpu_throttle_increment;
809 }
810 
811 uint8_t migrate_cpu_throttle_initial(void)
812 {
813     MigrationState *s = migrate_get_current();
814 
815     return s->parameters.cpu_throttle_initial;
816 }
817 
818 bool migrate_cpu_throttle_tailslow(void)
819 {
820     MigrationState *s = migrate_get_current();
821 
822     return s->parameters.cpu_throttle_tailslow;
823 }
824 
825 int migrate_decompress_threads(void)
826 {
827     MigrationState *s = migrate_get_current();
828 
829     return s->parameters.decompress_threads;
830 }
831 
832 uint64_t migrate_downtime_limit(void)
833 {
834     MigrationState *s = migrate_get_current();
835 
836     return s->parameters.downtime_limit;
837 }
838 
839 uint8_t migrate_max_cpu_throttle(void)
840 {
841     MigrationState *s = migrate_get_current();
842 
843     return s->parameters.max_cpu_throttle;
844 }
845 
846 uint64_t migrate_max_bandwidth(void)
847 {
848     MigrationState *s = migrate_get_current();
849 
850     return s->parameters.max_bandwidth;
851 }
852 
853 uint64_t migrate_avail_switchover_bandwidth(void)
854 {
855     MigrationState *s = migrate_get_current();
856 
857     return s->parameters.avail_switchover_bandwidth;
858 }
859 
860 uint64_t migrate_max_postcopy_bandwidth(void)
861 {
862     MigrationState *s = migrate_get_current();
863 
864     return s->parameters.max_postcopy_bandwidth;
865 }
866 
867 MigMode migrate_mode(void)
868 {
869     MigrationState *s = migrate_get_current();
870     MigMode mode = s->parameters.mode;
871 
872     assert(mode >= 0 && mode < MIG_MODE__MAX);
873     return mode;
874 }
875 
876 int migrate_multifd_channels(void)
877 {
878     MigrationState *s = migrate_get_current();
879 
880     return s->parameters.multifd_channels;
881 }
882 
883 MultiFDCompression migrate_multifd_compression(void)
884 {
885     MigrationState *s = migrate_get_current();
886 
887     assert(s->parameters.multifd_compression < MULTIFD_COMPRESSION__MAX);
888     return s->parameters.multifd_compression;
889 }
890 
891 int migrate_multifd_zlib_level(void)
892 {
893     MigrationState *s = migrate_get_current();
894 
895     return s->parameters.multifd_zlib_level;
896 }
897 
898 int migrate_multifd_zstd_level(void)
899 {
900     MigrationState *s = migrate_get_current();
901 
902     return s->parameters.multifd_zstd_level;
903 }
904 
905 uint8_t migrate_throttle_trigger_threshold(void)
906 {
907     MigrationState *s = migrate_get_current();
908 
909     return s->parameters.throttle_trigger_threshold;
910 }
911 
912 const char *migrate_tls_authz(void)
913 {
914     MigrationState *s = migrate_get_current();
915 
916     return s->parameters.tls_authz;
917 }
918 
919 const char *migrate_tls_creds(void)
920 {
921     MigrationState *s = migrate_get_current();
922 
923     return s->parameters.tls_creds;
924 }
925 
926 const char *migrate_tls_hostname(void)
927 {
928     MigrationState *s = migrate_get_current();
929 
930     return s->parameters.tls_hostname;
931 }
932 
933 uint64_t migrate_xbzrle_cache_size(void)
934 {
935     MigrationState *s = migrate_get_current();
936 
937     return s->parameters.xbzrle_cache_size;
938 }
939 
940 /* parameter setters */
941 
942 void migrate_set_block_incremental(bool value)
943 {
944     MigrationState *s = migrate_get_current();
945 
946     s->parameters.block_incremental = value;
947 }
948 
949 /* parameters helpers */
950 
951 void block_cleanup_parameters(void)
952 {
953     MigrationState *s = migrate_get_current();
954 
955     if (s->must_remove_block_options) {
956         /* setting to false can never fail */
957         migrate_cap_set(MIGRATION_CAPABILITY_BLOCK, false, &error_abort);
958         migrate_set_block_incremental(false);
959         s->must_remove_block_options = false;
960     }
961 }
962 
963 AnnounceParameters *migrate_announce_params(void)
964 {
965     static AnnounceParameters ap;
966 
967     MigrationState *s = migrate_get_current();
968 
969     ap.initial = s->parameters.announce_initial;
970     ap.max = s->parameters.announce_max;
971     ap.rounds = s->parameters.announce_rounds;
972     ap.step = s->parameters.announce_step;
973 
974     return &ap;
975 }
976 
977 MigrationParameters *qmp_query_migrate_parameters(Error **errp)
978 {
979     MigrationParameters *params;
980     MigrationState *s = migrate_get_current();
981 
982     /* TODO use QAPI_CLONE() instead of duplicating it inline */
983     params = g_malloc0(sizeof(*params));
984     params->has_compress_level = true;
985     params->compress_level = s->parameters.compress_level;
986     params->has_compress_threads = true;
987     params->compress_threads = s->parameters.compress_threads;
988     params->has_compress_wait_thread = true;
989     params->compress_wait_thread = s->parameters.compress_wait_thread;
990     params->has_decompress_threads = true;
991     params->decompress_threads = s->parameters.decompress_threads;
992     params->has_throttle_trigger_threshold = true;
993     params->throttle_trigger_threshold = s->parameters.throttle_trigger_threshold;
994     params->has_cpu_throttle_initial = true;
995     params->cpu_throttle_initial = s->parameters.cpu_throttle_initial;
996     params->has_cpu_throttle_increment = true;
997     params->cpu_throttle_increment = s->parameters.cpu_throttle_increment;
998     params->has_cpu_throttle_tailslow = true;
999     params->cpu_throttle_tailslow = s->parameters.cpu_throttle_tailslow;
1000     params->tls_creds = g_strdup(s->parameters.tls_creds);
1001     params->tls_hostname = g_strdup(s->parameters.tls_hostname);
1002     params->tls_authz = g_strdup(s->parameters.tls_authz ?
1003                                  s->parameters.tls_authz : "");
1004     params->has_max_bandwidth = true;
1005     params->max_bandwidth = s->parameters.max_bandwidth;
1006     params->has_avail_switchover_bandwidth = true;
1007     params->avail_switchover_bandwidth = s->parameters.avail_switchover_bandwidth;
1008     params->has_downtime_limit = true;
1009     params->downtime_limit = s->parameters.downtime_limit;
1010     params->has_x_checkpoint_delay = true;
1011     params->x_checkpoint_delay = s->parameters.x_checkpoint_delay;
1012     params->has_block_incremental = true;
1013     params->block_incremental = s->parameters.block_incremental;
1014     params->has_multifd_channels = true;
1015     params->multifd_channels = s->parameters.multifd_channels;
1016     params->has_multifd_compression = true;
1017     params->multifd_compression = s->parameters.multifd_compression;
1018     params->has_multifd_zlib_level = true;
1019     params->multifd_zlib_level = s->parameters.multifd_zlib_level;
1020     params->has_multifd_zstd_level = true;
1021     params->multifd_zstd_level = s->parameters.multifd_zstd_level;
1022     params->has_xbzrle_cache_size = true;
1023     params->xbzrle_cache_size = s->parameters.xbzrle_cache_size;
1024     params->has_max_postcopy_bandwidth = true;
1025     params->max_postcopy_bandwidth = s->parameters.max_postcopy_bandwidth;
1026     params->has_max_cpu_throttle = true;
1027     params->max_cpu_throttle = s->parameters.max_cpu_throttle;
1028     params->has_announce_initial = true;
1029     params->announce_initial = s->parameters.announce_initial;
1030     params->has_announce_max = true;
1031     params->announce_max = s->parameters.announce_max;
1032     params->has_announce_rounds = true;
1033     params->announce_rounds = s->parameters.announce_rounds;
1034     params->has_announce_step = true;
1035     params->announce_step = s->parameters.announce_step;
1036 
1037     if (s->parameters.has_block_bitmap_mapping) {
1038         params->has_block_bitmap_mapping = true;
1039         params->block_bitmap_mapping =
1040             QAPI_CLONE(BitmapMigrationNodeAliasList,
1041                        s->parameters.block_bitmap_mapping);
1042     }
1043 
1044     params->has_x_vcpu_dirty_limit_period = true;
1045     params->x_vcpu_dirty_limit_period = s->parameters.x_vcpu_dirty_limit_period;
1046     params->has_vcpu_dirty_limit = true;
1047     params->vcpu_dirty_limit = s->parameters.vcpu_dirty_limit;
1048     params->has_mode = true;
1049     params->mode = s->parameters.mode;
1050 
1051     return params;
1052 }
1053 
1054 void migrate_params_init(MigrationParameters *params)
1055 {
1056     params->tls_hostname = g_strdup("");
1057     params->tls_creds = g_strdup("");
1058 
1059     /* Set has_* up only for parameter checks */
1060     params->has_compress_level = true;
1061     params->has_compress_threads = true;
1062     params->has_compress_wait_thread = true;
1063     params->has_decompress_threads = true;
1064     params->has_throttle_trigger_threshold = true;
1065     params->has_cpu_throttle_initial = true;
1066     params->has_cpu_throttle_increment = true;
1067     params->has_cpu_throttle_tailslow = true;
1068     params->has_max_bandwidth = true;
1069     params->has_downtime_limit = true;
1070     params->has_x_checkpoint_delay = true;
1071     params->has_block_incremental = true;
1072     params->has_multifd_channels = true;
1073     params->has_multifd_compression = true;
1074     params->has_multifd_zlib_level = true;
1075     params->has_multifd_zstd_level = true;
1076     params->has_xbzrle_cache_size = true;
1077     params->has_max_postcopy_bandwidth = true;
1078     params->has_max_cpu_throttle = true;
1079     params->has_announce_initial = true;
1080     params->has_announce_max = true;
1081     params->has_announce_rounds = true;
1082     params->has_announce_step = true;
1083     params->has_x_vcpu_dirty_limit_period = true;
1084     params->has_vcpu_dirty_limit = true;
1085     params->has_mode = true;
1086 }
1087 
1088 /*
1089  * Check whether the parameters are valid. Error will be put into errp
1090  * (if provided). Return true if valid, otherwise false.
1091  */
1092 bool migrate_params_check(MigrationParameters *params, Error **errp)
1093 {
1094     if (params->has_compress_level &&
1095         (params->compress_level > 9)) {
1096         error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "compress_level",
1097                    "a value between 0 and 9");
1098         return false;
1099     }
1100 
1101     if (params->has_compress_threads && (params->compress_threads < 1)) {
1102         error_setg(errp, QERR_INVALID_PARAMETER_VALUE,
1103                    "compress_threads",
1104                    "a value between 1 and 255");
1105         return false;
1106     }
1107 
1108     if (params->has_decompress_threads && (params->decompress_threads < 1)) {
1109         error_setg(errp, QERR_INVALID_PARAMETER_VALUE,
1110                    "decompress_threads",
1111                    "a value between 1 and 255");
1112         return false;
1113     }
1114 
1115     if (params->has_throttle_trigger_threshold &&
1116         (params->throttle_trigger_threshold < 1 ||
1117          params->throttle_trigger_threshold > 100)) {
1118         error_setg(errp, QERR_INVALID_PARAMETER_VALUE,
1119                    "throttle_trigger_threshold",
1120                    "an integer in the range of 1 to 100");
1121         return false;
1122     }
1123 
1124     if (params->has_cpu_throttle_initial &&
1125         (params->cpu_throttle_initial < 1 ||
1126          params->cpu_throttle_initial > 99)) {
1127         error_setg(errp, QERR_INVALID_PARAMETER_VALUE,
1128                    "cpu_throttle_initial",
1129                    "an integer in the range of 1 to 99");
1130         return false;
1131     }
1132 
1133     if (params->has_cpu_throttle_increment &&
1134         (params->cpu_throttle_increment < 1 ||
1135          params->cpu_throttle_increment > 99)) {
1136         error_setg(errp, QERR_INVALID_PARAMETER_VALUE,
1137                    "cpu_throttle_increment",
1138                    "an integer in the range of 1 to 99");
1139         return false;
1140     }
1141 
1142     if (params->has_max_bandwidth && (params->max_bandwidth > SIZE_MAX)) {
1143         error_setg(errp, QERR_INVALID_PARAMETER_VALUE,
1144                    "max_bandwidth",
1145                    "an integer in the range of 0 to "stringify(SIZE_MAX)
1146                    " bytes/second");
1147         return false;
1148     }
1149 
1150     if (params->has_avail_switchover_bandwidth &&
1151         (params->avail_switchover_bandwidth > SIZE_MAX)) {
1152         error_setg(errp, QERR_INVALID_PARAMETER_VALUE,
1153                    "avail_switchover_bandwidth",
1154                    "an integer in the range of 0 to "stringify(SIZE_MAX)
1155                    " bytes/second");
1156         return false;
1157     }
1158 
1159     if (params->has_downtime_limit &&
1160         (params->downtime_limit > MAX_MIGRATE_DOWNTIME)) {
1161         error_setg(errp, QERR_INVALID_PARAMETER_VALUE,
1162                    "downtime_limit",
1163                    "an integer in the range of 0 to "
1164                     stringify(MAX_MIGRATE_DOWNTIME)" ms");
1165         return false;
1166     }
1167 
1168     /* x_checkpoint_delay is now always positive */
1169 
1170     if (params->has_multifd_channels && (params->multifd_channels < 1)) {
1171         error_setg(errp, QERR_INVALID_PARAMETER_VALUE,
1172                    "multifd_channels",
1173                    "a value between 1 and 255");
1174         return false;
1175     }
1176 
1177     if (params->has_multifd_zlib_level &&
1178         (params->multifd_zlib_level > 9)) {
1179         error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "multifd_zlib_level",
1180                    "a value between 0 and 9");
1181         return false;
1182     }
1183 
1184     if (params->has_multifd_zstd_level &&
1185         (params->multifd_zstd_level > 20)) {
1186         error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "multifd_zstd_level",
1187                    "a value between 0 and 20");
1188         return false;
1189     }
1190 
1191     if (params->has_xbzrle_cache_size &&
1192         (params->xbzrle_cache_size < qemu_target_page_size() ||
1193          !is_power_of_2(params->xbzrle_cache_size))) {
1194         error_setg(errp, QERR_INVALID_PARAMETER_VALUE,
1195                    "xbzrle_cache_size",
1196                    "a power of two no less than the target page size");
1197         return false;
1198     }
1199 
1200     if (params->has_max_cpu_throttle &&
1201         (params->max_cpu_throttle < params->cpu_throttle_initial ||
1202          params->max_cpu_throttle > 99)) {
1203         error_setg(errp, QERR_INVALID_PARAMETER_VALUE,
1204                    "max_cpu_throttle",
1205                    "an integer in the range of cpu_throttle_initial to 99");
1206         return false;
1207     }
1208 
1209     if (params->has_announce_initial &&
1210         params->announce_initial > 100000) {
1211         error_setg(errp, QERR_INVALID_PARAMETER_VALUE,
1212                    "announce_initial",
1213                    "a value between 0 and 100000");
1214         return false;
1215     }
1216     if (params->has_announce_max &&
1217         params->announce_max > 100000) {
1218         error_setg(errp, QERR_INVALID_PARAMETER_VALUE,
1219                    "announce_max",
1220                    "a value between 0 and 100000");
1221        return false;
1222     }
1223     if (params->has_announce_rounds &&
1224         params->announce_rounds > 1000) {
1225         error_setg(errp, QERR_INVALID_PARAMETER_VALUE,
1226                    "announce_rounds",
1227                    "a value between 0 and 1000");
1228        return false;
1229     }
1230     if (params->has_announce_step &&
1231         (params->announce_step < 1 ||
1232         params->announce_step > 10000)) {
1233         error_setg(errp, QERR_INVALID_PARAMETER_VALUE,
1234                    "announce_step",
1235                    "a value between 0 and 10000");
1236        return false;
1237     }
1238 
1239     if (params->has_block_bitmap_mapping &&
1240         !check_dirty_bitmap_mig_alias_map(params->block_bitmap_mapping, errp)) {
1241         error_prepend(errp, "Invalid mapping given for block-bitmap-mapping: ");
1242         return false;
1243     }
1244 
1245 #ifdef CONFIG_LINUX
1246     if (migrate_zero_copy_send() &&
1247         ((params->has_multifd_compression && params->multifd_compression) ||
1248          (params->tls_creds && *params->tls_creds))) {
1249         error_setg(errp,
1250                    "Zero copy only available for non-compressed non-TLS multifd migration");
1251         return false;
1252     }
1253 #endif
1254 
1255     if (params->has_x_vcpu_dirty_limit_period &&
1256         (params->x_vcpu_dirty_limit_period < 1 ||
1257          params->x_vcpu_dirty_limit_period > 1000)) {
1258         error_setg(errp, QERR_INVALID_PARAMETER_VALUE,
1259                    "x-vcpu-dirty-limit-period",
1260                    "a value between 1 and 1000");
1261         return false;
1262     }
1263 
1264     if (params->has_vcpu_dirty_limit &&
1265         (params->vcpu_dirty_limit < 1)) {
1266         error_setg(errp, QERR_INVALID_PARAMETER_VALUE,
1267                    "vcpu_dirty_limit",
1268                    "is invalid, it must greater then 1 MB/s");
1269         return false;
1270     }
1271 
1272     return true;
1273 }
1274 
1275 static void migrate_params_test_apply(MigrateSetParameters *params,
1276                                       MigrationParameters *dest)
1277 {
1278     *dest = migrate_get_current()->parameters;
1279 
1280     /* TODO use QAPI_CLONE() instead of duplicating it inline */
1281 
1282     if (params->has_compress_level) {
1283         dest->compress_level = params->compress_level;
1284     }
1285 
1286     if (params->has_compress_threads) {
1287         dest->compress_threads = params->compress_threads;
1288     }
1289 
1290     if (params->has_compress_wait_thread) {
1291         dest->compress_wait_thread = params->compress_wait_thread;
1292     }
1293 
1294     if (params->has_decompress_threads) {
1295         dest->decompress_threads = params->decompress_threads;
1296     }
1297 
1298     if (params->has_throttle_trigger_threshold) {
1299         dest->throttle_trigger_threshold = params->throttle_trigger_threshold;
1300     }
1301 
1302     if (params->has_cpu_throttle_initial) {
1303         dest->cpu_throttle_initial = params->cpu_throttle_initial;
1304     }
1305 
1306     if (params->has_cpu_throttle_increment) {
1307         dest->cpu_throttle_increment = params->cpu_throttle_increment;
1308     }
1309 
1310     if (params->has_cpu_throttle_tailslow) {
1311         dest->cpu_throttle_tailslow = params->cpu_throttle_tailslow;
1312     }
1313 
1314     if (params->tls_creds) {
1315         assert(params->tls_creds->type == QTYPE_QSTRING);
1316         dest->tls_creds = params->tls_creds->u.s;
1317     }
1318 
1319     if (params->tls_hostname) {
1320         assert(params->tls_hostname->type == QTYPE_QSTRING);
1321         dest->tls_hostname = params->tls_hostname->u.s;
1322     }
1323 
1324     if (params->has_max_bandwidth) {
1325         dest->max_bandwidth = params->max_bandwidth;
1326     }
1327 
1328     if (params->has_avail_switchover_bandwidth) {
1329         dest->avail_switchover_bandwidth = params->avail_switchover_bandwidth;
1330     }
1331 
1332     if (params->has_downtime_limit) {
1333         dest->downtime_limit = params->downtime_limit;
1334     }
1335 
1336     if (params->has_x_checkpoint_delay) {
1337         dest->x_checkpoint_delay = params->x_checkpoint_delay;
1338     }
1339 
1340     if (params->has_block_incremental) {
1341         dest->block_incremental = params->block_incremental;
1342     }
1343     if (params->has_multifd_channels) {
1344         dest->multifd_channels = params->multifd_channels;
1345     }
1346     if (params->has_multifd_compression) {
1347         dest->multifd_compression = params->multifd_compression;
1348     }
1349     if (params->has_multifd_zlib_level) {
1350         dest->multifd_zlib_level = params->multifd_zlib_level;
1351     }
1352     if (params->has_multifd_zstd_level) {
1353         dest->multifd_zstd_level = params->multifd_zstd_level;
1354     }
1355     if (params->has_xbzrle_cache_size) {
1356         dest->xbzrle_cache_size = params->xbzrle_cache_size;
1357     }
1358     if (params->has_max_postcopy_bandwidth) {
1359         dest->max_postcopy_bandwidth = params->max_postcopy_bandwidth;
1360     }
1361     if (params->has_max_cpu_throttle) {
1362         dest->max_cpu_throttle = params->max_cpu_throttle;
1363     }
1364     if (params->has_announce_initial) {
1365         dest->announce_initial = params->announce_initial;
1366     }
1367     if (params->has_announce_max) {
1368         dest->announce_max = params->announce_max;
1369     }
1370     if (params->has_announce_rounds) {
1371         dest->announce_rounds = params->announce_rounds;
1372     }
1373     if (params->has_announce_step) {
1374         dest->announce_step = params->announce_step;
1375     }
1376 
1377     if (params->has_block_bitmap_mapping) {
1378         dest->has_block_bitmap_mapping = true;
1379         dest->block_bitmap_mapping = params->block_bitmap_mapping;
1380     }
1381 
1382     if (params->has_x_vcpu_dirty_limit_period) {
1383         dest->x_vcpu_dirty_limit_period =
1384             params->x_vcpu_dirty_limit_period;
1385     }
1386     if (params->has_vcpu_dirty_limit) {
1387         dest->vcpu_dirty_limit = params->vcpu_dirty_limit;
1388     }
1389 
1390     if (params->has_mode) {
1391         dest->mode = params->mode;
1392     }
1393 }
1394 
1395 static void migrate_params_apply(MigrateSetParameters *params, Error **errp)
1396 {
1397     MigrationState *s = migrate_get_current();
1398 
1399     /* TODO use QAPI_CLONE() instead of duplicating it inline */
1400 
1401     if (params->has_compress_level) {
1402         warn_report("old compression is deprecated;"
1403                     " use multifd compression methods instead");
1404         s->parameters.compress_level = params->compress_level;
1405     }
1406 
1407     if (params->has_compress_threads) {
1408         warn_report("old compression is deprecated;"
1409                     " use multifd compression methods instead");
1410         s->parameters.compress_threads = params->compress_threads;
1411     }
1412 
1413     if (params->has_compress_wait_thread) {
1414         warn_report("old compression is deprecated;"
1415                     " use multifd compression methods instead");
1416         s->parameters.compress_wait_thread = params->compress_wait_thread;
1417     }
1418 
1419     if (params->has_decompress_threads) {
1420         warn_report("old compression is deprecated;"
1421                     " use multifd compression methods instead");
1422         s->parameters.decompress_threads = params->decompress_threads;
1423     }
1424 
1425     if (params->has_throttle_trigger_threshold) {
1426         s->parameters.throttle_trigger_threshold = params->throttle_trigger_threshold;
1427     }
1428 
1429     if (params->has_cpu_throttle_initial) {
1430         s->parameters.cpu_throttle_initial = params->cpu_throttle_initial;
1431     }
1432 
1433     if (params->has_cpu_throttle_increment) {
1434         s->parameters.cpu_throttle_increment = params->cpu_throttle_increment;
1435     }
1436 
1437     if (params->has_cpu_throttle_tailslow) {
1438         s->parameters.cpu_throttle_tailslow = params->cpu_throttle_tailslow;
1439     }
1440 
1441     if (params->tls_creds) {
1442         g_free(s->parameters.tls_creds);
1443         assert(params->tls_creds->type == QTYPE_QSTRING);
1444         s->parameters.tls_creds = g_strdup(params->tls_creds->u.s);
1445     }
1446 
1447     if (params->tls_hostname) {
1448         g_free(s->parameters.tls_hostname);
1449         assert(params->tls_hostname->type == QTYPE_QSTRING);
1450         s->parameters.tls_hostname = g_strdup(params->tls_hostname->u.s);
1451     }
1452 
1453     if (params->tls_authz) {
1454         g_free(s->parameters.tls_authz);
1455         assert(params->tls_authz->type == QTYPE_QSTRING);
1456         s->parameters.tls_authz = g_strdup(params->tls_authz->u.s);
1457     }
1458 
1459     if (params->has_max_bandwidth) {
1460         s->parameters.max_bandwidth = params->max_bandwidth;
1461         if (s->to_dst_file && !migration_in_postcopy()) {
1462             migration_rate_set(s->parameters.max_bandwidth);
1463         }
1464     }
1465 
1466     if (params->has_avail_switchover_bandwidth) {
1467         s->parameters.avail_switchover_bandwidth = params->avail_switchover_bandwidth;
1468     }
1469 
1470     if (params->has_downtime_limit) {
1471         s->parameters.downtime_limit = params->downtime_limit;
1472     }
1473 
1474     if (params->has_x_checkpoint_delay) {
1475         s->parameters.x_checkpoint_delay = params->x_checkpoint_delay;
1476         colo_checkpoint_delay_set();
1477     }
1478 
1479     if (params->has_block_incremental) {
1480         warn_report("block migration is deprecated;"
1481                     " use blockdev-mirror with NBD instead");
1482         s->parameters.block_incremental = params->block_incremental;
1483     }
1484     if (params->has_multifd_channels) {
1485         s->parameters.multifd_channels = params->multifd_channels;
1486     }
1487     if (params->has_multifd_compression) {
1488         s->parameters.multifd_compression = params->multifd_compression;
1489     }
1490     if (params->has_multifd_zlib_level) {
1491         s->parameters.multifd_zlib_level = params->multifd_zlib_level;
1492     }
1493     if (params->has_multifd_zstd_level) {
1494         s->parameters.multifd_zstd_level = params->multifd_zstd_level;
1495     }
1496     if (params->has_xbzrle_cache_size) {
1497         s->parameters.xbzrle_cache_size = params->xbzrle_cache_size;
1498         xbzrle_cache_resize(params->xbzrle_cache_size, errp);
1499     }
1500     if (params->has_max_postcopy_bandwidth) {
1501         s->parameters.max_postcopy_bandwidth = params->max_postcopy_bandwidth;
1502         if (s->to_dst_file && migration_in_postcopy()) {
1503             migration_rate_set(s->parameters.max_postcopy_bandwidth);
1504         }
1505     }
1506     if (params->has_max_cpu_throttle) {
1507         s->parameters.max_cpu_throttle = params->max_cpu_throttle;
1508     }
1509     if (params->has_announce_initial) {
1510         s->parameters.announce_initial = params->announce_initial;
1511     }
1512     if (params->has_announce_max) {
1513         s->parameters.announce_max = params->announce_max;
1514     }
1515     if (params->has_announce_rounds) {
1516         s->parameters.announce_rounds = params->announce_rounds;
1517     }
1518     if (params->has_announce_step) {
1519         s->parameters.announce_step = params->announce_step;
1520     }
1521 
1522     if (params->has_block_bitmap_mapping) {
1523         qapi_free_BitmapMigrationNodeAliasList(
1524             s->parameters.block_bitmap_mapping);
1525 
1526         s->parameters.has_block_bitmap_mapping = true;
1527         s->parameters.block_bitmap_mapping =
1528             QAPI_CLONE(BitmapMigrationNodeAliasList,
1529                        params->block_bitmap_mapping);
1530     }
1531 
1532     if (params->has_x_vcpu_dirty_limit_period) {
1533         s->parameters.x_vcpu_dirty_limit_period =
1534             params->x_vcpu_dirty_limit_period;
1535     }
1536     if (params->has_vcpu_dirty_limit) {
1537         s->parameters.vcpu_dirty_limit = params->vcpu_dirty_limit;
1538     }
1539 
1540     if (params->has_mode) {
1541         s->parameters.mode = params->mode;
1542     }
1543 }
1544 
1545 void qmp_migrate_set_parameters(MigrateSetParameters *params, Error **errp)
1546 {
1547     MigrationParameters tmp;
1548 
1549     /* TODO Rewrite "" to null instead for all three tls_* parameters */
1550     if (params->tls_creds
1551         && params->tls_creds->type == QTYPE_QNULL) {
1552         qobject_unref(params->tls_creds->u.n);
1553         params->tls_creds->type = QTYPE_QSTRING;
1554         params->tls_creds->u.s = strdup("");
1555     }
1556     if (params->tls_hostname
1557         && params->tls_hostname->type == QTYPE_QNULL) {
1558         qobject_unref(params->tls_hostname->u.n);
1559         params->tls_hostname->type = QTYPE_QSTRING;
1560         params->tls_hostname->u.s = strdup("");
1561     }
1562     if (params->tls_authz
1563         && params->tls_authz->type == QTYPE_QNULL) {
1564         qobject_unref(params->tls_authz->u.n);
1565         params->tls_authz->type = QTYPE_QSTRING;
1566         params->tls_authz->u.s = strdup("");
1567     }
1568 
1569     migrate_params_test_apply(params, &tmp);
1570 
1571     if (!migrate_params_check(&tmp, errp)) {
1572         /* Invalid parameter */
1573         return;
1574     }
1575 
1576     migrate_params_apply(params, errp);
1577 }
1578