4 * Copyright IBM, Corp. 2008
7 * Anthony Liguori <aliguori@us.ibm.com>
9 * This work is licensed under the terms of the GNU GPL, version 2. See
10 * the COPYING file in the top-level directory.
12 * Contributions after 2012-01-13 are licensed under the terms of the
13 * GNU GPL, version 2 or (at your option) any later version.
16 #include "qemu/osdep.h"
17 #include "qemu/cutils.h"
18 #include "qemu/error-report.h"
19 #include "migration/blocker.h"
25 #include "migration/global_state.h"
26 #include "migration/misc.h"
27 #include "migration.h"
29 #include "qemu-file-channel.h"
30 #include "qemu-file.h"
31 #include "migration/vmstate.h"
32 #include "block/block.h"
33 #include "qapi/error.h"
34 #include "qapi/qapi-commands-migration.h"
35 #include "qapi/qapi-events-migration.h"
36 #include "qapi/qmp/qerror.h"
37 #include "qapi/qmp/qnull.h"
40 #include "postcopy-ram.h"
41 #include "qemu/thread.h"
43 #include "exec/target_page.h"
44 #include "io/channel-buffer.h"
45 #include "migration/colo.h"
46 #include "hw/boards.h"
47 #include "monitor/monitor.h"
49 #define MAX_THROTTLE (32 << 20) /* Migration transfer speed throttling */
51 /* Amount of time to allocate to each "chunk" of bandwidth-throttled
53 #define BUFFER_DELAY 100
54 #define XFER_LIMIT_RATIO (1000 / BUFFER_DELAY)
56 /* Time in milliseconds we are allowed to stop the source,
57 * for sending the last part */
58 #define DEFAULT_MIGRATE_SET_DOWNTIME 300
60 /* Maximum migrate downtime set to 2000 seconds */
61 #define MAX_MIGRATE_DOWNTIME_SECONDS 2000
62 #define MAX_MIGRATE_DOWNTIME (MAX_MIGRATE_DOWNTIME_SECONDS * 1000)
64 /* Default compression thread count */
65 #define DEFAULT_MIGRATE_COMPRESS_THREAD_COUNT 8
66 /* Default decompression thread count, usually decompression is at
67 * least 4 times as fast as compression.*/
68 #define DEFAULT_MIGRATE_DECOMPRESS_THREAD_COUNT 2
69 /*0: means nocompress, 1: best speed, ... 9: best compress ratio */
70 #define DEFAULT_MIGRATE_COMPRESS_LEVEL 1
71 /* Define default autoconverge cpu throttle migration parameters */
72 #define DEFAULT_MIGRATE_CPU_THROTTLE_INITIAL 20
73 #define DEFAULT_MIGRATE_CPU_THROTTLE_INCREMENT 10
74 #define DEFAULT_MIGRATE_MAX_CPU_THROTTLE 99
76 /* Migration XBZRLE default cache size */
77 #define DEFAULT_MIGRATE_XBZRLE_CACHE_SIZE (64 * 1024 * 1024)
79 /* The delay time (in ms) between two COLO checkpoints */
80 #define DEFAULT_MIGRATE_X_CHECKPOINT_DELAY (200 * 100)
81 #define DEFAULT_MIGRATE_MULTIFD_CHANNELS 2
82 #define DEFAULT_MIGRATE_MULTIFD_PAGE_COUNT 16
84 /* Background transfer rate for postcopy, 0 means unlimited, note
85 * that page requests can still exceed this limit.
87 #define DEFAULT_MIGRATE_MAX_POSTCOPY_BANDWIDTH 0
89 static NotifierList migration_state_notifiers
=
90 NOTIFIER_LIST_INITIALIZER(migration_state_notifiers
);
92 static bool deferred_incoming
;
94 /* Messages sent on the return path from destination to source */
95 enum mig_rp_message_type
{
96 MIG_RP_MSG_INVALID
= 0, /* Must be 0 */
97 MIG_RP_MSG_SHUT
, /* sibling will not send any more RP messages */
98 MIG_RP_MSG_PONG
, /* Response to a PING; data (seq: be32 ) */
100 MIG_RP_MSG_REQ_PAGES_ID
, /* data (start: be64, len: be32, id: string) */
101 MIG_RP_MSG_REQ_PAGES
, /* data (start: be64, len: be32) */
102 MIG_RP_MSG_RECV_BITMAP
, /* send recved_bitmap back to source */
103 MIG_RP_MSG_RESUME_ACK
, /* tell source that we are ready to resume */
108 /* When we add fault tolerance, we could have several
109 migrations at once. For now we don't need to add
110 dynamic creation of migration */
112 static MigrationState
*current_migration
;
113 static MigrationIncomingState
*current_incoming
;
115 static bool migration_object_check(MigrationState
*ms
, Error
**errp
);
116 static int migration_maybe_pause(MigrationState
*s
,
117 int *current_active_state
,
120 void migration_object_init(void)
122 MachineState
*ms
= MACHINE(qdev_get_machine());
125 /* This can only be called once. */
126 assert(!current_migration
);
127 current_migration
= MIGRATION_OBJ(object_new(TYPE_MIGRATION
));
130 * Init the migrate incoming object as well no matter whether
131 * we'll use it or not.
133 assert(!current_incoming
);
134 current_incoming
= g_new0(MigrationIncomingState
, 1);
135 current_incoming
->state
= MIGRATION_STATUS_NONE
;
136 current_incoming
->postcopy_remote_fds
=
137 g_array_new(FALSE
, TRUE
, sizeof(struct PostCopyFD
));
138 qemu_mutex_init(¤t_incoming
->rp_mutex
);
139 qemu_event_init(¤t_incoming
->main_thread_load_event
, false);
140 qemu_sem_init(¤t_incoming
->postcopy_pause_sem_dst
, 0);
141 qemu_sem_init(¤t_incoming
->postcopy_pause_sem_fault
, 0);
143 init_dirty_bitmap_incoming_migration();
145 if (!migration_object_check(current_migration
, &err
)) {
146 error_report_err(err
);
151 * We cannot really do this in migration_instance_init() since at
152 * that time global properties are not yet applied, then this
153 * value will be definitely replaced by something else.
155 if (ms
->enforce_config_section
) {
156 current_migration
->send_configuration
= true;
160 void migration_object_finalize(void)
162 object_unref(OBJECT(current_migration
));
166 MigrationState
*migrate_get_current(void)
168 /* This can only be called after the object created. */
169 assert(current_migration
);
170 return current_migration
;
173 MigrationIncomingState
*migration_incoming_get_current(void)
175 assert(current_incoming
);
176 return current_incoming
;
179 void migration_incoming_state_destroy(void)
181 struct MigrationIncomingState
*mis
= migration_incoming_get_current();
183 if (mis
->to_src_file
) {
184 /* Tell source that we are done */
185 migrate_send_rp_shut(mis
, qemu_file_get_error(mis
->from_src_file
) != 0);
186 qemu_fclose(mis
->to_src_file
);
187 mis
->to_src_file
= NULL
;
190 if (mis
->from_src_file
) {
191 qemu_fclose(mis
->from_src_file
);
192 mis
->from_src_file
= NULL
;
194 if (mis
->postcopy_remote_fds
) {
195 g_array_free(mis
->postcopy_remote_fds
, TRUE
);
196 mis
->postcopy_remote_fds
= NULL
;
199 qemu_event_reset(&mis
->main_thread_load_event
);
202 static void migrate_generate_event(int new_state
)
204 if (migrate_use_events()) {
205 qapi_event_send_migration(new_state
);
209 static bool migrate_late_block_activate(void)
213 s
= migrate_get_current();
215 return s
->enabled_capabilities
[
216 MIGRATION_CAPABILITY_LATE_BLOCK_ACTIVATE
];
220 * Called on -incoming with a defer: uri.
221 * The migration can be started later after any parameters have been
224 static void deferred_incoming_migration(Error
**errp
)
226 if (deferred_incoming
) {
227 error_setg(errp
, "Incoming migration already deferred");
229 deferred_incoming
= true;
233 * Send a message on the return channel back to the source
236 static int migrate_send_rp_message(MigrationIncomingState
*mis
,
237 enum mig_rp_message_type message_type
,
238 uint16_t len
, void *data
)
242 trace_migrate_send_rp_message((int)message_type
, len
);
243 qemu_mutex_lock(&mis
->rp_mutex
);
246 * It's possible that the file handle got lost due to network
249 if (!mis
->to_src_file
) {
254 qemu_put_be16(mis
->to_src_file
, (unsigned int)message_type
);
255 qemu_put_be16(mis
->to_src_file
, len
);
256 qemu_put_buffer(mis
->to_src_file
, data
, len
);
257 qemu_fflush(mis
->to_src_file
);
259 /* It's possible that qemu file got error during sending */
260 ret
= qemu_file_get_error(mis
->to_src_file
);
263 qemu_mutex_unlock(&mis
->rp_mutex
);
267 /* Request a range of pages from the source VM at the given
269 * rbname: Name of the RAMBlock to request the page in, if NULL it's the same
270 * as the last request (a name must have been given previously)
271 * Start: Address offset within the RB
272 * Len: Length in bytes required - must be a multiple of pagesize
274 int migrate_send_rp_req_pages(MigrationIncomingState
*mis
, const char *rbname
,
275 ram_addr_t start
, size_t len
)
277 uint8_t bufc
[12 + 1 + 255]; /* start (8), len (4), rbname up to 256 */
278 size_t msglen
= 12; /* start + len */
279 enum mig_rp_message_type msg_type
;
281 *(uint64_t *)bufc
= cpu_to_be64((uint64_t)start
);
282 *(uint32_t *)(bufc
+ 8) = cpu_to_be32((uint32_t)len
);
285 int rbname_len
= strlen(rbname
);
286 assert(rbname_len
< 256);
288 bufc
[msglen
++] = rbname_len
;
289 memcpy(bufc
+ msglen
, rbname
, rbname_len
);
290 msglen
+= rbname_len
;
291 msg_type
= MIG_RP_MSG_REQ_PAGES_ID
;
293 msg_type
= MIG_RP_MSG_REQ_PAGES
;
296 return migrate_send_rp_message(mis
, msg_type
, msglen
, bufc
);
299 static bool migration_colo_enabled
;
300 bool migration_incoming_colo_enabled(void)
302 return migration_colo_enabled
;
305 void migration_incoming_disable_colo(void)
307 migration_colo_enabled
= false;
310 void migration_incoming_enable_colo(void)
312 migration_colo_enabled
= true;
315 void qemu_start_incoming_migration(const char *uri
, Error
**errp
)
319 qapi_event_send_migration(MIGRATION_STATUS_SETUP
);
320 if (!strcmp(uri
, "defer")) {
321 deferred_incoming_migration(errp
);
322 } else if (strstart(uri
, "tcp:", &p
)) {
323 tcp_start_incoming_migration(p
, errp
);
325 } else if (strstart(uri
, "rdma:", &p
)) {
326 rdma_start_incoming_migration(p
, errp
);
328 } else if (strstart(uri
, "exec:", &p
)) {
329 exec_start_incoming_migration(p
, errp
);
330 } else if (strstart(uri
, "unix:", &p
)) {
331 unix_start_incoming_migration(p
, errp
);
332 } else if (strstart(uri
, "fd:", &p
)) {
333 fd_start_incoming_migration(p
, errp
);
335 error_setg(errp
, "unknown migration protocol: %s", uri
);
339 static void process_incoming_migration_bh(void *opaque
)
341 Error
*local_err
= NULL
;
342 MigrationIncomingState
*mis
= opaque
;
344 /* If capability late_block_activate is set:
345 * Only fire up the block code now if we're going to restart the
346 * VM, else 'cont' will do it.
347 * This causes file locking to happen; so we don't want it to happen
348 * unless we really are starting the VM.
350 if (!migrate_late_block_activate() ||
351 (autostart
&& (!global_state_received() ||
352 global_state_get_runstate() == RUN_STATE_RUNNING
))) {
353 /* Make sure all file formats flush their mutable metadata.
354 * If we get an error here, just don't restart the VM yet. */
355 bdrv_invalidate_cache_all(&local_err
);
357 error_report_err(local_err
);
364 * This must happen after all error conditions are dealt with and
365 * we're sure the VM is going to be running on this host.
367 qemu_announce_self();
369 if (multifd_load_cleanup(&local_err
) != 0) {
370 error_report_err(local_err
);
373 /* If global state section was not received or we are in running
374 state, we need to obey autostart. Any other state is set with
377 dirty_bitmap_mig_before_vm_start();
379 if (!global_state_received() ||
380 global_state_get_runstate() == RUN_STATE_RUNNING
) {
384 runstate_set(RUN_STATE_PAUSED
);
387 runstate_set(global_state_get_runstate());
390 * This must happen after any state changes since as soon as an external
391 * observer sees this event they might start to prod at the VM assuming
394 migrate_set_state(&mis
->state
, MIGRATION_STATUS_ACTIVE
,
395 MIGRATION_STATUS_COMPLETED
);
396 qemu_bh_delete(mis
->bh
);
397 migration_incoming_state_destroy();
400 static void process_incoming_migration_co(void *opaque
)
402 MigrationIncomingState
*mis
= migration_incoming_get_current();
405 Error
*local_err
= NULL
;
407 assert(mis
->from_src_file
);
408 mis
->migration_incoming_co
= qemu_coroutine_self();
409 mis
->largest_page_size
= qemu_ram_pagesize_largest();
410 postcopy_state_set(POSTCOPY_INCOMING_NONE
);
411 migrate_set_state(&mis
->state
, MIGRATION_STATUS_NONE
,
412 MIGRATION_STATUS_ACTIVE
);
413 ret
= qemu_loadvm_state(mis
->from_src_file
);
415 ps
= postcopy_state_get();
416 trace_process_incoming_migration_co_end(ret
, ps
);
417 if (ps
!= POSTCOPY_INCOMING_NONE
) {
418 if (ps
== POSTCOPY_INCOMING_ADVISE
) {
420 * Where a migration had postcopy enabled (and thus went to advise)
421 * but managed to complete within the precopy period, we can use
424 postcopy_ram_incoming_cleanup(mis
);
425 } else if (ret
>= 0) {
427 * Postcopy was started, cleanup should happen at the end of the
430 trace_process_incoming_migration_co_postcopy_end_main();
433 /* Else if something went wrong then just fall out of the normal exit */
436 /* we get COLO info, and know if we are in COLO mode */
437 if (!ret
&& migration_incoming_colo_enabled()) {
438 /* Make sure all file formats flush their mutable metadata */
439 bdrv_invalidate_cache_all(&local_err
);
441 error_report_err(local_err
);
445 if (colo_init_ram_cache() < 0) {
446 error_report("Init ram cache failed");
450 qemu_thread_create(&mis
->colo_incoming_thread
, "COLO incoming",
451 colo_process_incoming_thread
, mis
, QEMU_THREAD_JOINABLE
);
452 mis
->have_colo_incoming_thread
= true;
453 qemu_coroutine_yield();
455 /* Wait checkpoint incoming thread exit before free resource */
456 qemu_thread_join(&mis
->colo_incoming_thread
);
457 /* We hold the global iothread lock, so it is safe here */
458 colo_release_ram_cache();
462 error_report("load of migration failed: %s", strerror(-ret
));
465 mis
->bh
= qemu_bh_new(process_incoming_migration_bh
, mis
);
466 qemu_bh_schedule(mis
->bh
);
467 mis
->migration_incoming_co
= NULL
;
471 migrate_set_state(&mis
->state
, MIGRATION_STATUS_ACTIVE
,
472 MIGRATION_STATUS_FAILED
);
473 qemu_fclose(mis
->from_src_file
);
474 if (multifd_load_cleanup(&local_err
) != 0) {
475 error_report_err(local_err
);
480 static void migration_incoming_setup(QEMUFile
*f
)
482 MigrationIncomingState
*mis
= migration_incoming_get_current();
484 if (multifd_load_setup() != 0) {
485 /* We haven't been able to create multifd threads
486 nothing better to do */
490 if (!mis
->from_src_file
) {
491 mis
->from_src_file
= f
;
493 qemu_file_set_blocking(f
, false);
496 void migration_incoming_process(void)
498 Coroutine
*co
= qemu_coroutine_create(process_incoming_migration_co
, NULL
);
499 qemu_coroutine_enter(co
);
502 /* Returns true if recovered from a paused migration, otherwise false */
503 static bool postcopy_try_recover(QEMUFile
*f
)
505 MigrationIncomingState
*mis
= migration_incoming_get_current();
507 if (mis
->state
== MIGRATION_STATUS_POSTCOPY_PAUSED
) {
508 /* Resumed from a paused postcopy migration */
510 mis
->from_src_file
= f
;
511 /* Postcopy has standalone thread to do vm load */
512 qemu_file_set_blocking(f
, true);
514 /* Re-configure the return path */
515 mis
->to_src_file
= qemu_file_get_return_path(f
);
517 migrate_set_state(&mis
->state
, MIGRATION_STATUS_POSTCOPY_PAUSED
,
518 MIGRATION_STATUS_POSTCOPY_RECOVER
);
521 * Here, we only wake up the main loading thread (while the
522 * fault thread will still be waiting), so that we can receive
523 * commands from source now, and answer it if needed. The
524 * fault thread will be woken up afterwards until we are sure
525 * that source is ready to reply to page requests.
527 qemu_sem_post(&mis
->postcopy_pause_sem_dst
);
534 void migration_fd_process_incoming(QEMUFile
*f
)
536 if (postcopy_try_recover(f
)) {
540 migration_incoming_setup(f
);
541 migration_incoming_process();
544 void migration_ioc_process_incoming(QIOChannel
*ioc
, Error
**errp
)
546 MigrationIncomingState
*mis
= migration_incoming_get_current();
547 bool start_migration
;
549 if (!mis
->from_src_file
) {
550 /* The first connection (multifd may have multiple) */
551 QEMUFile
*f
= qemu_fopen_channel_input(ioc
);
553 /* If it's a recovery, we're done */
554 if (postcopy_try_recover(f
)) {
558 migration_incoming_setup(f
);
561 * Common migration only needs one channel, so we can start
562 * right now. Multifd needs more than one channel, we wait.
564 start_migration
= !migrate_use_multifd();
566 Error
*local_err
= NULL
;
567 /* Multiple connections */
568 assert(migrate_use_multifd());
569 start_migration
= multifd_recv_new_channel(ioc
, &local_err
);
571 error_propagate(errp
, local_err
);
576 if (start_migration
) {
577 migration_incoming_process();
582 * @migration_has_all_channels: We have received all channels that we need
584 * Returns true when we have got connections to all the channels that
585 * we need for migration.
587 bool migration_has_all_channels(void)
589 MigrationIncomingState
*mis
= migration_incoming_get_current();
592 all_channels
= multifd_recv_all_channels_created();
594 return all_channels
&& mis
->from_src_file
!= NULL
;
598 * Send a 'SHUT' message on the return channel with the given value
599 * to indicate that we've finished with the RP. Non-0 value indicates
602 void migrate_send_rp_shut(MigrationIncomingState
*mis
,
607 buf
= cpu_to_be32(value
);
608 migrate_send_rp_message(mis
, MIG_RP_MSG_SHUT
, sizeof(buf
), &buf
);
612 * Send a 'PONG' message on the return channel with the given value
613 * (normally in response to a 'PING')
615 void migrate_send_rp_pong(MigrationIncomingState
*mis
,
620 buf
= cpu_to_be32(value
);
621 migrate_send_rp_message(mis
, MIG_RP_MSG_PONG
, sizeof(buf
), &buf
);
624 void migrate_send_rp_recv_bitmap(MigrationIncomingState
*mis
,
632 * First, we send the header part. It contains only the len of
633 * idstr, and the idstr itself.
635 len
= strlen(block_name
);
637 memcpy(buf
+ 1, block_name
, len
);
639 if (mis
->state
!= MIGRATION_STATUS_POSTCOPY_RECOVER
) {
640 error_report("%s: MSG_RP_RECV_BITMAP only used for recovery",
645 migrate_send_rp_message(mis
, MIG_RP_MSG_RECV_BITMAP
, len
+ 1, buf
);
648 * Next, we dump the received bitmap to the stream.
650 * TODO: currently we are safe since we are the only one that is
651 * using the to_src_file handle (fault thread is still paused),
652 * and it's ok even not taking the mutex. However the best way is
653 * to take the lock before sending the message header, and release
654 * the lock after sending the bitmap.
656 qemu_mutex_lock(&mis
->rp_mutex
);
657 res
= ramblock_recv_bitmap_send(mis
->to_src_file
, block_name
);
658 qemu_mutex_unlock(&mis
->rp_mutex
);
660 trace_migrate_send_rp_recv_bitmap(block_name
, res
);
663 void migrate_send_rp_resume_ack(MigrationIncomingState
*mis
, uint32_t value
)
667 buf
= cpu_to_be32(value
);
668 migrate_send_rp_message(mis
, MIG_RP_MSG_RESUME_ACK
, sizeof(buf
), &buf
);
671 MigrationCapabilityStatusList
*qmp_query_migrate_capabilities(Error
**errp
)
673 MigrationCapabilityStatusList
*head
= NULL
;
674 MigrationCapabilityStatusList
*caps
;
675 MigrationState
*s
= migrate_get_current();
678 caps
= NULL
; /* silence compiler warning */
679 for (i
= 0; i
< MIGRATION_CAPABILITY__MAX
; i
++) {
680 #ifndef CONFIG_LIVE_BLOCK_MIGRATION
681 if (i
== MIGRATION_CAPABILITY_BLOCK
) {
686 head
= g_malloc0(sizeof(*caps
));
689 caps
->next
= g_malloc0(sizeof(*caps
));
693 g_malloc(sizeof(*caps
->value
));
694 caps
->value
->capability
= i
;
695 caps
->value
->state
= s
->enabled_capabilities
[i
];
701 MigrationParameters
*qmp_query_migrate_parameters(Error
**errp
)
703 MigrationParameters
*params
;
704 MigrationState
*s
= migrate_get_current();
706 /* TODO use QAPI_CLONE() instead of duplicating it inline */
707 params
= g_malloc0(sizeof(*params
));
708 params
->has_compress_level
= true;
709 params
->compress_level
= s
->parameters
.compress_level
;
710 params
->has_compress_threads
= true;
711 params
->compress_threads
= s
->parameters
.compress_threads
;
712 params
->has_compress_wait_thread
= true;
713 params
->compress_wait_thread
= s
->parameters
.compress_wait_thread
;
714 params
->has_decompress_threads
= true;
715 params
->decompress_threads
= s
->parameters
.decompress_threads
;
716 params
->has_cpu_throttle_initial
= true;
717 params
->cpu_throttle_initial
= s
->parameters
.cpu_throttle_initial
;
718 params
->has_cpu_throttle_increment
= true;
719 params
->cpu_throttle_increment
= s
->parameters
.cpu_throttle_increment
;
720 params
->has_tls_creds
= true;
721 params
->tls_creds
= g_strdup(s
->parameters
.tls_creds
);
722 params
->has_tls_hostname
= true;
723 params
->tls_hostname
= g_strdup(s
->parameters
.tls_hostname
);
724 params
->has_max_bandwidth
= true;
725 params
->max_bandwidth
= s
->parameters
.max_bandwidth
;
726 params
->has_downtime_limit
= true;
727 params
->downtime_limit
= s
->parameters
.downtime_limit
;
728 params
->has_x_checkpoint_delay
= true;
729 params
->x_checkpoint_delay
= s
->parameters
.x_checkpoint_delay
;
730 params
->has_block_incremental
= true;
731 params
->block_incremental
= s
->parameters
.block_incremental
;
732 params
->has_x_multifd_channels
= true;
733 params
->x_multifd_channels
= s
->parameters
.x_multifd_channels
;
734 params
->has_x_multifd_page_count
= true;
735 params
->x_multifd_page_count
= s
->parameters
.x_multifd_page_count
;
736 params
->has_xbzrle_cache_size
= true;
737 params
->xbzrle_cache_size
= s
->parameters
.xbzrle_cache_size
;
738 params
->has_max_postcopy_bandwidth
= true;
739 params
->max_postcopy_bandwidth
= s
->parameters
.max_postcopy_bandwidth
;
740 params
->has_max_cpu_throttle
= true;
741 params
->max_cpu_throttle
= s
->parameters
.max_cpu_throttle
;
747 * Return true if we're already in the middle of a migration
748 * (i.e. any of the active or setup states)
750 bool migration_is_setup_or_active(int state
)
753 case MIGRATION_STATUS_ACTIVE
:
754 case MIGRATION_STATUS_POSTCOPY_ACTIVE
:
755 case MIGRATION_STATUS_POSTCOPY_PAUSED
:
756 case MIGRATION_STATUS_POSTCOPY_RECOVER
:
757 case MIGRATION_STATUS_SETUP
:
758 case MIGRATION_STATUS_PRE_SWITCHOVER
:
759 case MIGRATION_STATUS_DEVICE
:
768 static void populate_ram_info(MigrationInfo
*info
, MigrationState
*s
)
770 info
->has_ram
= true;
771 info
->ram
= g_malloc0(sizeof(*info
->ram
));
772 info
->ram
->transferred
= ram_counters
.transferred
;
773 info
->ram
->total
= ram_bytes_total();
774 info
->ram
->duplicate
= ram_counters
.duplicate
;
775 /* legacy value. It is not used anymore */
776 info
->ram
->skipped
= 0;
777 info
->ram
->normal
= ram_counters
.normal
;
778 info
->ram
->normal_bytes
= ram_counters
.normal
*
779 qemu_target_page_size();
780 info
->ram
->mbps
= s
->mbps
;
781 info
->ram
->dirty_sync_count
= ram_counters
.dirty_sync_count
;
782 info
->ram
->postcopy_requests
= ram_counters
.postcopy_requests
;
783 info
->ram
->page_size
= qemu_target_page_size();
784 info
->ram
->multifd_bytes
= ram_counters
.multifd_bytes
;
785 info
->ram
->pages_per_second
= s
->pages_per_second
;
787 if (migrate_use_xbzrle()) {
788 info
->has_xbzrle_cache
= true;
789 info
->xbzrle_cache
= g_malloc0(sizeof(*info
->xbzrle_cache
));
790 info
->xbzrle_cache
->cache_size
= migrate_xbzrle_cache_size();
791 info
->xbzrle_cache
->bytes
= xbzrle_counters
.bytes
;
792 info
->xbzrle_cache
->pages
= xbzrle_counters
.pages
;
793 info
->xbzrle_cache
->cache_miss
= xbzrle_counters
.cache_miss
;
794 info
->xbzrle_cache
->cache_miss_rate
= xbzrle_counters
.cache_miss_rate
;
795 info
->xbzrle_cache
->overflow
= xbzrle_counters
.overflow
;
798 if (migrate_use_compression()) {
799 info
->has_compression
= true;
800 info
->compression
= g_malloc0(sizeof(*info
->compression
));
801 info
->compression
->pages
= compression_counters
.pages
;
802 info
->compression
->busy
= compression_counters
.busy
;
803 info
->compression
->busy_rate
= compression_counters
.busy_rate
;
804 info
->compression
->compressed_size
=
805 compression_counters
.compressed_size
;
806 info
->compression
->compression_rate
=
807 compression_counters
.compression_rate
;
810 if (cpu_throttle_active()) {
811 info
->has_cpu_throttle_percentage
= true;
812 info
->cpu_throttle_percentage
= cpu_throttle_get_percentage();
815 if (s
->state
!= MIGRATION_STATUS_COMPLETED
) {
816 info
->ram
->remaining
= ram_bytes_remaining();
817 info
->ram
->dirty_pages_rate
= ram_counters
.dirty_pages_rate
;
821 static void populate_disk_info(MigrationInfo
*info
)
823 if (blk_mig_active()) {
824 info
->has_disk
= true;
825 info
->disk
= g_malloc0(sizeof(*info
->disk
));
826 info
->disk
->transferred
= blk_mig_bytes_transferred();
827 info
->disk
->remaining
= blk_mig_bytes_remaining();
828 info
->disk
->total
= blk_mig_bytes_total();
832 static void fill_source_migration_info(MigrationInfo
*info
)
834 MigrationState
*s
= migrate_get_current();
837 case MIGRATION_STATUS_NONE
:
838 /* no migration has happened ever */
839 /* do not overwrite destination migration status */
842 case MIGRATION_STATUS_SETUP
:
843 info
->has_status
= true;
844 info
->has_total_time
= false;
846 case MIGRATION_STATUS_ACTIVE
:
847 case MIGRATION_STATUS_CANCELLING
:
848 case MIGRATION_STATUS_POSTCOPY_ACTIVE
:
849 case MIGRATION_STATUS_PRE_SWITCHOVER
:
850 case MIGRATION_STATUS_DEVICE
:
851 case MIGRATION_STATUS_POSTCOPY_PAUSED
:
852 case MIGRATION_STATUS_POSTCOPY_RECOVER
:
853 /* TODO add some postcopy stats */
854 info
->has_status
= true;
855 info
->has_total_time
= true;
856 info
->total_time
= qemu_clock_get_ms(QEMU_CLOCK_REALTIME
)
858 info
->has_expected_downtime
= true;
859 info
->expected_downtime
= s
->expected_downtime
;
860 info
->has_setup_time
= true;
861 info
->setup_time
= s
->setup_time
;
863 populate_ram_info(info
, s
);
864 populate_disk_info(info
);
866 case MIGRATION_STATUS_COLO
:
867 info
->has_status
= true;
868 /* TODO: display COLO specific information (checkpoint info etc.) */
870 case MIGRATION_STATUS_COMPLETED
:
871 info
->has_status
= true;
872 info
->has_total_time
= true;
873 info
->total_time
= s
->total_time
;
874 info
->has_downtime
= true;
875 info
->downtime
= s
->downtime
;
876 info
->has_setup_time
= true;
877 info
->setup_time
= s
->setup_time
;
879 populate_ram_info(info
, s
);
881 case MIGRATION_STATUS_FAILED
:
882 info
->has_status
= true;
884 info
->has_error_desc
= true;
885 info
->error_desc
= g_strdup(error_get_pretty(s
->error
));
888 case MIGRATION_STATUS_CANCELLED
:
889 info
->has_status
= true;
892 info
->status
= s
->state
;
896 * @migration_caps_check - check capability validity
898 * @cap_list: old capability list, array of bool
899 * @params: new capabilities to be applied soon
900 * @errp: set *errp if the check failed, with reason
902 * Returns true if check passed, otherwise false.
904 static bool migrate_caps_check(bool *cap_list
,
905 MigrationCapabilityStatusList
*params
,
908 MigrationCapabilityStatusList
*cap
;
909 bool old_postcopy_cap
;
910 MigrationIncomingState
*mis
= migration_incoming_get_current();
912 old_postcopy_cap
= cap_list
[MIGRATION_CAPABILITY_POSTCOPY_RAM
];
914 for (cap
= params
; cap
; cap
= cap
->next
) {
915 cap_list
[cap
->value
->capability
] = cap
->value
->state
;
918 #ifndef CONFIG_LIVE_BLOCK_MIGRATION
919 if (cap_list
[MIGRATION_CAPABILITY_BLOCK
]) {
920 error_setg(errp
, "QEMU compiled without old-style (blk/-b, inc/-i) "
922 error_append_hint(errp
, "Use drive_mirror+NBD instead.\n");
927 #ifndef CONFIG_REPLICATION
928 if (cap_list
[MIGRATION_CAPABILITY_X_COLO
]) {
929 error_setg(errp
, "QEMU compiled without replication module"
930 " can't enable COLO");
931 error_append_hint(errp
, "Please enable replication before COLO.\n");
936 if (cap_list
[MIGRATION_CAPABILITY_POSTCOPY_RAM
]) {
937 if (cap_list
[MIGRATION_CAPABILITY_COMPRESS
]) {
938 /* The decompression threads asynchronously write into RAM
939 * rather than use the atomic copies needed to avoid
940 * userfaulting. It should be possible to fix the decompression
941 * threads for compatibility in future.
943 error_setg(errp
, "Postcopy is not currently compatible "
948 /* This check is reasonably expensive, so only when it's being
949 * set the first time, also it's only the destination that needs
952 if (!old_postcopy_cap
&& runstate_check(RUN_STATE_INMIGRATE
) &&
953 !postcopy_ram_supported_by_host(mis
)) {
954 /* postcopy_ram_supported_by_host will have emitted a more
957 error_setg(errp
, "Postcopy is not supported");
965 static void fill_destination_migration_info(MigrationInfo
*info
)
967 MigrationIncomingState
*mis
= migration_incoming_get_current();
969 switch (mis
->state
) {
970 case MIGRATION_STATUS_NONE
:
973 case MIGRATION_STATUS_SETUP
:
974 case MIGRATION_STATUS_CANCELLING
:
975 case MIGRATION_STATUS_CANCELLED
:
976 case MIGRATION_STATUS_ACTIVE
:
977 case MIGRATION_STATUS_POSTCOPY_ACTIVE
:
978 case MIGRATION_STATUS_POSTCOPY_PAUSED
:
979 case MIGRATION_STATUS_POSTCOPY_RECOVER
:
980 case MIGRATION_STATUS_FAILED
:
981 case MIGRATION_STATUS_COLO
:
982 info
->has_status
= true;
984 case MIGRATION_STATUS_COMPLETED
:
985 info
->has_status
= true;
986 fill_destination_postcopy_migration_info(info
);
989 info
->status
= mis
->state
;
992 MigrationInfo
*qmp_query_migrate(Error
**errp
)
994 MigrationInfo
*info
= g_malloc0(sizeof(*info
));
996 fill_destination_migration_info(info
);
997 fill_source_migration_info(info
);
1002 void qmp_migrate_set_capabilities(MigrationCapabilityStatusList
*params
,
1005 MigrationState
*s
= migrate_get_current();
1006 MigrationCapabilityStatusList
*cap
;
1007 bool cap_list
[MIGRATION_CAPABILITY__MAX
];
1009 if (migration_is_setup_or_active(s
->state
)) {
1010 error_setg(errp
, QERR_MIGRATION_ACTIVE
);
1014 memcpy(cap_list
, s
->enabled_capabilities
, sizeof(cap_list
));
1015 if (!migrate_caps_check(cap_list
, params
, errp
)) {
1019 for (cap
= params
; cap
; cap
= cap
->next
) {
1020 s
->enabled_capabilities
[cap
->value
->capability
] = cap
->value
->state
;
1025 * Check whether the parameters are valid. Error will be put into errp
1026 * (if provided). Return true if valid, otherwise false.
1028 static bool migrate_params_check(MigrationParameters
*params
, Error
**errp
)
1030 if (params
->has_compress_level
&&
1031 (params
->compress_level
> 9)) {
1032 error_setg(errp
, QERR_INVALID_PARAMETER_VALUE
, "compress_level",
1033 "is invalid, it should be in the range of 0 to 9");
1037 if (params
->has_compress_threads
&& (params
->compress_threads
< 1)) {
1038 error_setg(errp
, QERR_INVALID_PARAMETER_VALUE
,
1040 "is invalid, it should be in the range of 1 to 255");
1044 if (params
->has_decompress_threads
&& (params
->decompress_threads
< 1)) {
1045 error_setg(errp
, QERR_INVALID_PARAMETER_VALUE
,
1046 "decompress_threads",
1047 "is invalid, it should be in the range of 1 to 255");
1051 if (params
->has_cpu_throttle_initial
&&
1052 (params
->cpu_throttle_initial
< 1 ||
1053 params
->cpu_throttle_initial
> 99)) {
1054 error_setg(errp
, QERR_INVALID_PARAMETER_VALUE
,
1055 "cpu_throttle_initial",
1056 "an integer in the range of 1 to 99");
1060 if (params
->has_cpu_throttle_increment
&&
1061 (params
->cpu_throttle_increment
< 1 ||
1062 params
->cpu_throttle_increment
> 99)) {
1063 error_setg(errp
, QERR_INVALID_PARAMETER_VALUE
,
1064 "cpu_throttle_increment",
1065 "an integer in the range of 1 to 99");
1069 if (params
->has_max_bandwidth
&& (params
->max_bandwidth
> SIZE_MAX
)) {
1070 error_setg(errp
, "Parameter 'max_bandwidth' expects an integer in the"
1071 " range of 0 to %zu bytes/second", SIZE_MAX
);
1075 if (params
->has_downtime_limit
&&
1076 (params
->downtime_limit
> MAX_MIGRATE_DOWNTIME
)) {
1077 error_setg(errp
, "Parameter 'downtime_limit' expects an integer in "
1078 "the range of 0 to %d milliseconds",
1079 MAX_MIGRATE_DOWNTIME
);
1083 /* x_checkpoint_delay is now always positive */
1085 if (params
->has_x_multifd_channels
&& (params
->x_multifd_channels
< 1)) {
1086 error_setg(errp
, QERR_INVALID_PARAMETER_VALUE
,
1088 "is invalid, it should be in the range of 1 to 255");
1091 if (params
->has_x_multifd_page_count
&&
1092 (params
->x_multifd_page_count
< 1 ||
1093 params
->x_multifd_page_count
> 10000)) {
1094 error_setg(errp
, QERR_INVALID_PARAMETER_VALUE
,
1095 "multifd_page_count",
1096 "is invalid, it should be in the range of 1 to 10000");
1100 if (params
->has_xbzrle_cache_size
&&
1101 (params
->xbzrle_cache_size
< qemu_target_page_size() ||
1102 !is_power_of_2(params
->xbzrle_cache_size
))) {
1103 error_setg(errp
, QERR_INVALID_PARAMETER_VALUE
,
1104 "xbzrle_cache_size",
1105 "is invalid, it should be bigger than target page size"
1106 " and a power of two");
1110 if (params
->has_max_cpu_throttle
&&
1111 (params
->max_cpu_throttle
< params
->cpu_throttle_initial
||
1112 params
->max_cpu_throttle
> 99)) {
1113 error_setg(errp
, QERR_INVALID_PARAMETER_VALUE
,
1115 "an integer in the range of cpu_throttle_initial to 99");
1122 static void migrate_params_test_apply(MigrateSetParameters
*params
,
1123 MigrationParameters
*dest
)
1125 *dest
= migrate_get_current()->parameters
;
1127 /* TODO use QAPI_CLONE() instead of duplicating it inline */
1129 if (params
->has_compress_level
) {
1130 dest
->compress_level
= params
->compress_level
;
1133 if (params
->has_compress_threads
) {
1134 dest
->compress_threads
= params
->compress_threads
;
1137 if (params
->has_compress_wait_thread
) {
1138 dest
->compress_wait_thread
= params
->compress_wait_thread
;
1141 if (params
->has_decompress_threads
) {
1142 dest
->decompress_threads
= params
->decompress_threads
;
1145 if (params
->has_cpu_throttle_initial
) {
1146 dest
->cpu_throttle_initial
= params
->cpu_throttle_initial
;
1149 if (params
->has_cpu_throttle_increment
) {
1150 dest
->cpu_throttle_increment
= params
->cpu_throttle_increment
;
1153 if (params
->has_tls_creds
) {
1154 assert(params
->tls_creds
->type
== QTYPE_QSTRING
);
1155 dest
->tls_creds
= g_strdup(params
->tls_creds
->u
.s
);
1158 if (params
->has_tls_hostname
) {
1159 assert(params
->tls_hostname
->type
== QTYPE_QSTRING
);
1160 dest
->tls_hostname
= g_strdup(params
->tls_hostname
->u
.s
);
1163 if (params
->has_max_bandwidth
) {
1164 dest
->max_bandwidth
= params
->max_bandwidth
;
1167 if (params
->has_downtime_limit
) {
1168 dest
->downtime_limit
= params
->downtime_limit
;
1171 if (params
->has_x_checkpoint_delay
) {
1172 dest
->x_checkpoint_delay
= params
->x_checkpoint_delay
;
1175 if (params
->has_block_incremental
) {
1176 dest
->block_incremental
= params
->block_incremental
;
1178 if (params
->has_x_multifd_channels
) {
1179 dest
->x_multifd_channels
= params
->x_multifd_channels
;
1181 if (params
->has_x_multifd_page_count
) {
1182 dest
->x_multifd_page_count
= params
->x_multifd_page_count
;
1184 if (params
->has_xbzrle_cache_size
) {
1185 dest
->xbzrle_cache_size
= params
->xbzrle_cache_size
;
1187 if (params
->has_max_postcopy_bandwidth
) {
1188 dest
->max_postcopy_bandwidth
= params
->max_postcopy_bandwidth
;
1190 if (params
->has_max_cpu_throttle
) {
1191 dest
->max_cpu_throttle
= params
->max_cpu_throttle
;
1195 static void migrate_params_apply(MigrateSetParameters
*params
, Error
**errp
)
1197 MigrationState
*s
= migrate_get_current();
1199 /* TODO use QAPI_CLONE() instead of duplicating it inline */
1201 if (params
->has_compress_level
) {
1202 s
->parameters
.compress_level
= params
->compress_level
;
1205 if (params
->has_compress_threads
) {
1206 s
->parameters
.compress_threads
= params
->compress_threads
;
1209 if (params
->has_compress_wait_thread
) {
1210 s
->parameters
.compress_wait_thread
= params
->compress_wait_thread
;
1213 if (params
->has_decompress_threads
) {
1214 s
->parameters
.decompress_threads
= params
->decompress_threads
;
1217 if (params
->has_cpu_throttle_initial
) {
1218 s
->parameters
.cpu_throttle_initial
= params
->cpu_throttle_initial
;
1221 if (params
->has_cpu_throttle_increment
) {
1222 s
->parameters
.cpu_throttle_increment
= params
->cpu_throttle_increment
;
1225 if (params
->has_tls_creds
) {
1226 g_free(s
->parameters
.tls_creds
);
1227 assert(params
->tls_creds
->type
== QTYPE_QSTRING
);
1228 s
->parameters
.tls_creds
= g_strdup(params
->tls_creds
->u
.s
);
1231 if (params
->has_tls_hostname
) {
1232 g_free(s
->parameters
.tls_hostname
);
1233 assert(params
->tls_hostname
->type
== QTYPE_QSTRING
);
1234 s
->parameters
.tls_hostname
= g_strdup(params
->tls_hostname
->u
.s
);
1237 if (params
->has_max_bandwidth
) {
1238 s
->parameters
.max_bandwidth
= params
->max_bandwidth
;
1239 if (s
->to_dst_file
) {
1240 qemu_file_set_rate_limit(s
->to_dst_file
,
1241 s
->parameters
.max_bandwidth
/ XFER_LIMIT_RATIO
);
1245 if (params
->has_downtime_limit
) {
1246 s
->parameters
.downtime_limit
= params
->downtime_limit
;
1249 if (params
->has_x_checkpoint_delay
) {
1250 s
->parameters
.x_checkpoint_delay
= params
->x_checkpoint_delay
;
1251 if (migration_in_colo_state()) {
1252 colo_checkpoint_notify(s
);
1256 if (params
->has_block_incremental
) {
1257 s
->parameters
.block_incremental
= params
->block_incremental
;
1259 if (params
->has_x_multifd_channels
) {
1260 s
->parameters
.x_multifd_channels
= params
->x_multifd_channels
;
1262 if (params
->has_x_multifd_page_count
) {
1263 s
->parameters
.x_multifd_page_count
= params
->x_multifd_page_count
;
1265 if (params
->has_xbzrle_cache_size
) {
1266 s
->parameters
.xbzrle_cache_size
= params
->xbzrle_cache_size
;
1267 xbzrle_cache_resize(params
->xbzrle_cache_size
, errp
);
1269 if (params
->has_max_postcopy_bandwidth
) {
1270 s
->parameters
.max_postcopy_bandwidth
= params
->max_postcopy_bandwidth
;
1272 if (params
->has_max_cpu_throttle
) {
1273 s
->parameters
.max_cpu_throttle
= params
->max_cpu_throttle
;
1277 void qmp_migrate_set_parameters(MigrateSetParameters
*params
, Error
**errp
)
1279 MigrationParameters tmp
;
1281 /* TODO Rewrite "" to null instead */
1282 if (params
->has_tls_creds
1283 && params
->tls_creds
->type
== QTYPE_QNULL
) {
1284 qobject_unref(params
->tls_creds
->u
.n
);
1285 params
->tls_creds
->type
= QTYPE_QSTRING
;
1286 params
->tls_creds
->u
.s
= strdup("");
1288 /* TODO Rewrite "" to null instead */
1289 if (params
->has_tls_hostname
1290 && params
->tls_hostname
->type
== QTYPE_QNULL
) {
1291 qobject_unref(params
->tls_hostname
->u
.n
);
1292 params
->tls_hostname
->type
= QTYPE_QSTRING
;
1293 params
->tls_hostname
->u
.s
= strdup("");
1296 migrate_params_test_apply(params
, &tmp
);
1298 if (!migrate_params_check(&tmp
, errp
)) {
1299 /* Invalid parameter */
1303 migrate_params_apply(params
, errp
);
1307 void qmp_migrate_start_postcopy(Error
**errp
)
1309 MigrationState
*s
= migrate_get_current();
1311 if (!migrate_postcopy()) {
1312 error_setg(errp
, "Enable postcopy with migrate_set_capability before"
1313 " the start of migration");
1317 if (s
->state
== MIGRATION_STATUS_NONE
) {
1318 error_setg(errp
, "Postcopy must be started after migration has been"
1323 * we don't error if migration has finished since that would be racy
1324 * with issuing this command.
1326 atomic_set(&s
->start_postcopy
, true);
1329 /* shared migration helpers */
1331 void migrate_set_state(int *state
, int old_state
, int new_state
)
1333 assert(new_state
< MIGRATION_STATUS__MAX
);
1334 if (atomic_cmpxchg(state
, old_state
, new_state
) == old_state
) {
1335 trace_migrate_set_state(MigrationStatus_str(new_state
));
1336 migrate_generate_event(new_state
);
1340 static MigrationCapabilityStatusList
*migrate_cap_add(
1341 MigrationCapabilityStatusList
*list
,
1342 MigrationCapability index
,
1345 MigrationCapabilityStatusList
*cap
;
1347 cap
= g_new0(MigrationCapabilityStatusList
, 1);
1348 cap
->value
= g_new0(MigrationCapabilityStatus
, 1);
1349 cap
->value
->capability
= index
;
1350 cap
->value
->state
= state
;
1356 void migrate_set_block_enabled(bool value
, Error
**errp
)
1358 MigrationCapabilityStatusList
*cap
;
1360 cap
= migrate_cap_add(NULL
, MIGRATION_CAPABILITY_BLOCK
, value
);
1361 qmp_migrate_set_capabilities(cap
, errp
);
1362 qapi_free_MigrationCapabilityStatusList(cap
);
1365 static void migrate_set_block_incremental(MigrationState
*s
, bool value
)
1367 s
->parameters
.block_incremental
= value
;
1370 static void block_cleanup_parameters(MigrationState
*s
)
1372 if (s
->must_remove_block_options
) {
1373 /* setting to false can never fail */
1374 migrate_set_block_enabled(false, &error_abort
);
1375 migrate_set_block_incremental(s
, false);
1376 s
->must_remove_block_options
= false;
1380 static void migrate_fd_cleanup(void *opaque
)
1382 MigrationState
*s
= opaque
;
1384 qemu_bh_delete(s
->cleanup_bh
);
1385 s
->cleanup_bh
= NULL
;
1387 qemu_savevm_state_cleanup();
1389 if (s
->to_dst_file
) {
1392 trace_migrate_fd_cleanup();
1393 qemu_mutex_unlock_iothread();
1394 if (s
->migration_thread_running
) {
1395 qemu_thread_join(&s
->thread
);
1396 s
->migration_thread_running
= false;
1398 qemu_mutex_lock_iothread();
1400 multifd_save_cleanup();
1401 qemu_mutex_lock(&s
->qemu_file_lock
);
1402 tmp
= s
->to_dst_file
;
1403 s
->to_dst_file
= NULL
;
1404 qemu_mutex_unlock(&s
->qemu_file_lock
);
1406 * Close the file handle without the lock to make sure the
1407 * critical section won't block for long.
1412 assert((s
->state
!= MIGRATION_STATUS_ACTIVE
) &&
1413 (s
->state
!= MIGRATION_STATUS_POSTCOPY_ACTIVE
));
1415 if (s
->state
== MIGRATION_STATUS_CANCELLING
) {
1416 migrate_set_state(&s
->state
, MIGRATION_STATUS_CANCELLING
,
1417 MIGRATION_STATUS_CANCELLED
);
1421 /* It is used on info migrate. We can't free it */
1422 error_report_err(error_copy(s
->error
));
1424 notifier_list_notify(&migration_state_notifiers
, s
);
1425 block_cleanup_parameters(s
);
1428 void migrate_set_error(MigrationState
*s
, const Error
*error
)
1430 qemu_mutex_lock(&s
->error_mutex
);
1432 s
->error
= error_copy(error
);
1434 qemu_mutex_unlock(&s
->error_mutex
);
1437 void migrate_fd_error(MigrationState
*s
, const Error
*error
)
1439 trace_migrate_fd_error(error_get_pretty(error
));
1440 assert(s
->to_dst_file
== NULL
);
1441 migrate_set_state(&s
->state
, MIGRATION_STATUS_SETUP
,
1442 MIGRATION_STATUS_FAILED
);
1443 migrate_set_error(s
, error
);
1446 static void migrate_fd_cancel(MigrationState
*s
)
1449 QEMUFile
*f
= migrate_get_current()->to_dst_file
;
1450 trace_migrate_fd_cancel();
1452 if (s
->rp_state
.from_dst_file
) {
1453 /* shutdown the rp socket, so causing the rp thread to shutdown */
1454 qemu_file_shutdown(s
->rp_state
.from_dst_file
);
1458 old_state
= s
->state
;
1459 if (!migration_is_setup_or_active(old_state
)) {
1462 /* If the migration is paused, kick it out of the pause */
1463 if (old_state
== MIGRATION_STATUS_PRE_SWITCHOVER
) {
1464 qemu_sem_post(&s
->pause_sem
);
1466 migrate_set_state(&s
->state
, old_state
, MIGRATION_STATUS_CANCELLING
);
1467 } while (s
->state
!= MIGRATION_STATUS_CANCELLING
);
1470 * If we're unlucky the migration code might be stuck somewhere in a
1471 * send/write while the network has failed and is waiting to timeout;
1472 * if we've got shutdown(2) available then we can force it to quit.
1473 * The outgoing qemu file gets closed in migrate_fd_cleanup that is
1474 * called in a bh, so there is no race against this cancel.
1476 if (s
->state
== MIGRATION_STATUS_CANCELLING
&& f
) {
1477 qemu_file_shutdown(f
);
1479 if (s
->state
== MIGRATION_STATUS_CANCELLING
&& s
->block_inactive
) {
1480 Error
*local_err
= NULL
;
1482 bdrv_invalidate_cache_all(&local_err
);
1484 error_report_err(local_err
);
1486 s
->block_inactive
= false;
1491 void add_migration_state_change_notifier(Notifier
*notify
)
1493 notifier_list_add(&migration_state_notifiers
, notify
);
1496 void remove_migration_state_change_notifier(Notifier
*notify
)
1498 notifier_remove(notify
);
1501 bool migration_in_setup(MigrationState
*s
)
1503 return s
->state
== MIGRATION_STATUS_SETUP
;
1506 bool migration_has_finished(MigrationState
*s
)
1508 return s
->state
== MIGRATION_STATUS_COMPLETED
;
1511 bool migration_has_failed(MigrationState
*s
)
1513 return (s
->state
== MIGRATION_STATUS_CANCELLED
||
1514 s
->state
== MIGRATION_STATUS_FAILED
);
1517 bool migration_in_postcopy(void)
1519 MigrationState
*s
= migrate_get_current();
1521 return (s
->state
== MIGRATION_STATUS_POSTCOPY_ACTIVE
);
1524 bool migration_in_postcopy_after_devices(MigrationState
*s
)
1526 return migration_in_postcopy() && s
->postcopy_after_devices
;
1529 bool migration_is_idle(void)
1531 MigrationState
*s
= migrate_get_current();
1534 case MIGRATION_STATUS_NONE
:
1535 case MIGRATION_STATUS_CANCELLED
:
1536 case MIGRATION_STATUS_COMPLETED
:
1537 case MIGRATION_STATUS_FAILED
:
1539 case MIGRATION_STATUS_SETUP
:
1540 case MIGRATION_STATUS_CANCELLING
:
1541 case MIGRATION_STATUS_ACTIVE
:
1542 case MIGRATION_STATUS_POSTCOPY_ACTIVE
:
1543 case MIGRATION_STATUS_COLO
:
1544 case MIGRATION_STATUS_PRE_SWITCHOVER
:
1545 case MIGRATION_STATUS_DEVICE
:
1547 case MIGRATION_STATUS__MAX
:
1548 g_assert_not_reached();
1554 void migrate_init(MigrationState
*s
)
1557 * Reinitialise all migration state, except
1558 * parameters/capabilities that the user set, and
1564 s
->to_dst_file
= NULL
;
1565 s
->state
= MIGRATION_STATUS_NONE
;
1566 s
->rp_state
.from_dst_file
= NULL
;
1567 s
->rp_state
.error
= false;
1569 s
->pages_per_second
= 0.0;
1571 s
->expected_downtime
= 0;
1573 s
->start_postcopy
= false;
1574 s
->postcopy_after_devices
= false;
1575 s
->migration_thread_running
= false;
1576 error_free(s
->error
);
1579 migrate_set_state(&s
->state
, MIGRATION_STATUS_NONE
, MIGRATION_STATUS_SETUP
);
1581 s
->start_time
= qemu_clock_get_ms(QEMU_CLOCK_REALTIME
);
1583 s
->vm_was_running
= false;
1584 s
->iteration_initial_bytes
= 0;
1585 s
->threshold_size
= 0;
1588 static GSList
*migration_blockers
;
1590 int migrate_add_blocker(Error
*reason
, Error
**errp
)
1592 if (migrate_get_current()->only_migratable
) {
1593 error_propagate_prepend(errp
, error_copy(reason
),
1594 "disallowing migration blocker "
1595 "(--only_migratable) for: ");
1599 if (migration_is_idle()) {
1600 migration_blockers
= g_slist_prepend(migration_blockers
, reason
);
1604 error_propagate_prepend(errp
, error_copy(reason
),
1605 "disallowing migration blocker "
1606 "(migration in progress) for: ");
1610 void migrate_del_blocker(Error
*reason
)
1612 migration_blockers
= g_slist_remove(migration_blockers
, reason
);
1615 void qmp_migrate_incoming(const char *uri
, Error
**errp
)
1617 Error
*local_err
= NULL
;
1618 static bool once
= true;
1620 if (!deferred_incoming
) {
1621 error_setg(errp
, "For use with '-incoming defer'");
1625 error_setg(errp
, "The incoming migration has already been started");
1628 qemu_start_incoming_migration(uri
, &local_err
);
1631 error_propagate(errp
, local_err
);
1638 void qmp_migrate_recover(const char *uri
, Error
**errp
)
1640 MigrationIncomingState
*mis
= migration_incoming_get_current();
1642 if (mis
->state
!= MIGRATION_STATUS_POSTCOPY_PAUSED
) {
1643 error_setg(errp
, "Migrate recover can only be run "
1644 "when postcopy is paused.");
1648 if (atomic_cmpxchg(&mis
->postcopy_recover_triggered
,
1649 false, true) == true) {
1650 error_setg(errp
, "Migrate recovery is triggered already");
1655 * Note that this call will never start a real migration; it will
1656 * only re-setup the migration stream and poke existing migration
1657 * to continue using that newly established channel.
1659 qemu_start_incoming_migration(uri
, errp
);
1662 void qmp_migrate_pause(Error
**errp
)
1664 MigrationState
*ms
= migrate_get_current();
1665 MigrationIncomingState
*mis
= migration_incoming_get_current();
1668 if (ms
->state
== MIGRATION_STATUS_POSTCOPY_ACTIVE
) {
1669 /* Source side, during postcopy */
1670 qemu_mutex_lock(&ms
->qemu_file_lock
);
1671 ret
= qemu_file_shutdown(ms
->to_dst_file
);
1672 qemu_mutex_unlock(&ms
->qemu_file_lock
);
1674 error_setg(errp
, "Failed to pause source migration");
1679 if (mis
->state
== MIGRATION_STATUS_POSTCOPY_ACTIVE
) {
1680 ret
= qemu_file_shutdown(mis
->from_src_file
);
1682 error_setg(errp
, "Failed to pause destination migration");
1687 error_setg(errp
, "migrate-pause is currently only supported "
1688 "during postcopy-active state");
1691 bool migration_is_blocked(Error
**errp
)
1693 if (qemu_savevm_state_blocked(errp
)) {
1697 if (migration_blockers
) {
1698 error_propagate(errp
, error_copy(migration_blockers
->data
));
1705 /* Returns true if continue to migrate, or false if error detected */
1706 static bool migrate_prepare(MigrationState
*s
, bool blk
, bool blk_inc
,
1707 bool resume
, Error
**errp
)
1709 Error
*local_err
= NULL
;
1712 if (s
->state
!= MIGRATION_STATUS_POSTCOPY_PAUSED
) {
1713 error_setg(errp
, "Cannot resume if there is no "
1714 "paused migration");
1719 * Postcopy recovery won't work well with release-ram
1720 * capability since release-ram will drop the page buffer as
1721 * long as the page is put into the send buffer. So if there
1722 * is a network failure happened, any page buffers that have
1723 * not yet reached the destination VM but have already been
1724 * sent from the source VM will be lost forever. Let's refuse
1725 * the client from resuming such a postcopy migration.
1726 * Luckily release-ram was designed to only be used when src
1727 * and destination VMs are on the same host, so it should be
1730 if (migrate_release_ram()) {
1731 error_setg(errp
, "Postcopy recovery cannot work "
1732 "when release-ram capability is set");
1736 /* This is a resume, skip init status */
1740 if (migration_is_setup_or_active(s
->state
) ||
1741 s
->state
== MIGRATION_STATUS_CANCELLING
||
1742 s
->state
== MIGRATION_STATUS_COLO
) {
1743 error_setg(errp
, QERR_MIGRATION_ACTIVE
);
1747 if (runstate_check(RUN_STATE_INMIGRATE
)) {
1748 error_setg(errp
, "Guest is waiting for an incoming migration");
1752 if (migration_is_blocked(errp
)) {
1756 if (blk
|| blk_inc
) {
1757 if (migrate_use_block() || migrate_use_block_incremental()) {
1758 error_setg(errp
, "Command options are incompatible with "
1759 "current migration capabilities");
1762 migrate_set_block_enabled(true, &local_err
);
1764 error_propagate(errp
, local_err
);
1767 s
->must_remove_block_options
= true;
1771 migrate_set_block_incremental(s
, true);
1779 void qmp_migrate(const char *uri
, bool has_blk
, bool blk
,
1780 bool has_inc
, bool inc
, bool has_detach
, bool detach
,
1781 bool has_resume
, bool resume
, Error
**errp
)
1783 Error
*local_err
= NULL
;
1784 MigrationState
*s
= migrate_get_current();
1787 if (!migrate_prepare(s
, has_blk
&& blk
, has_inc
&& inc
,
1788 has_resume
&& resume
, errp
)) {
1789 /* Error detected, put into errp */
1793 if (strstart(uri
, "tcp:", &p
)) {
1794 tcp_start_outgoing_migration(s
, p
, &local_err
);
1796 } else if (strstart(uri
, "rdma:", &p
)) {
1797 rdma_start_outgoing_migration(s
, p
, &local_err
);
1799 } else if (strstart(uri
, "exec:", &p
)) {
1800 exec_start_outgoing_migration(s
, p
, &local_err
);
1801 } else if (strstart(uri
, "unix:", &p
)) {
1802 unix_start_outgoing_migration(s
, p
, &local_err
);
1803 } else if (strstart(uri
, "fd:", &p
)) {
1804 fd_start_outgoing_migration(s
, p
, &local_err
);
1806 error_setg(errp
, QERR_INVALID_PARAMETER_VALUE
, "uri",
1807 "a valid migration protocol");
1808 migrate_set_state(&s
->state
, MIGRATION_STATUS_SETUP
,
1809 MIGRATION_STATUS_FAILED
);
1810 block_cleanup_parameters(s
);
1815 migrate_fd_error(s
, local_err
);
1816 error_propagate(errp
, local_err
);
1821 void qmp_migrate_cancel(Error
**errp
)
1823 migrate_fd_cancel(migrate_get_current());
1826 void qmp_migrate_continue(MigrationStatus state
, Error
**errp
)
1828 MigrationState
*s
= migrate_get_current();
1829 if (s
->state
!= state
) {
1830 error_setg(errp
, "Migration not in expected state: %s",
1831 MigrationStatus_str(s
->state
));
1834 qemu_sem_post(&s
->pause_sem
);
1837 void qmp_migrate_set_cache_size(int64_t value
, Error
**errp
)
1839 MigrateSetParameters p
= {
1840 .has_xbzrle_cache_size
= true,
1841 .xbzrle_cache_size
= value
,
1844 qmp_migrate_set_parameters(&p
, errp
);
1847 int64_t qmp_query_migrate_cache_size(Error
**errp
)
1849 return migrate_xbzrle_cache_size();
1852 void qmp_migrate_set_speed(int64_t value
, Error
**errp
)
1854 MigrateSetParameters p
= {
1855 .has_max_bandwidth
= true,
1856 .max_bandwidth
= value
,
1859 qmp_migrate_set_parameters(&p
, errp
);
1862 void qmp_migrate_set_downtime(double value
, Error
**errp
)
1864 if (value
< 0 || value
> MAX_MIGRATE_DOWNTIME_SECONDS
) {
1865 error_setg(errp
, "Parameter 'downtime_limit' expects an integer in "
1866 "the range of 0 to %d seconds",
1867 MAX_MIGRATE_DOWNTIME_SECONDS
);
1871 value
*= 1000; /* Convert to milliseconds */
1872 value
= MAX(0, MIN(INT64_MAX
, value
));
1874 MigrateSetParameters p
= {
1875 .has_downtime_limit
= true,
1876 .downtime_limit
= value
,
1879 qmp_migrate_set_parameters(&p
, errp
);
1882 bool migrate_release_ram(void)
1886 s
= migrate_get_current();
1888 return s
->enabled_capabilities
[MIGRATION_CAPABILITY_RELEASE_RAM
];
1891 bool migrate_postcopy_ram(void)
1895 s
= migrate_get_current();
1897 return s
->enabled_capabilities
[MIGRATION_CAPABILITY_POSTCOPY_RAM
];
1900 bool migrate_postcopy(void)
1902 return migrate_postcopy_ram() || migrate_dirty_bitmaps();
1905 bool migrate_auto_converge(void)
1909 s
= migrate_get_current();
1911 return s
->enabled_capabilities
[MIGRATION_CAPABILITY_AUTO_CONVERGE
];
1914 bool migrate_zero_blocks(void)
1918 s
= migrate_get_current();
1920 return s
->enabled_capabilities
[MIGRATION_CAPABILITY_ZERO_BLOCKS
];
1923 bool migrate_postcopy_blocktime(void)
1927 s
= migrate_get_current();
1929 return s
->enabled_capabilities
[MIGRATION_CAPABILITY_POSTCOPY_BLOCKTIME
];
1932 bool migrate_use_compression(void)
1936 s
= migrate_get_current();
1938 return s
->enabled_capabilities
[MIGRATION_CAPABILITY_COMPRESS
];
1941 int migrate_compress_level(void)
1945 s
= migrate_get_current();
1947 return s
->parameters
.compress_level
;
1950 int migrate_compress_threads(void)
1954 s
= migrate_get_current();
1956 return s
->parameters
.compress_threads
;
1959 int migrate_compress_wait_thread(void)
1963 s
= migrate_get_current();
1965 return s
->parameters
.compress_wait_thread
;
1968 int migrate_decompress_threads(void)
1972 s
= migrate_get_current();
1974 return s
->parameters
.decompress_threads
;
1977 bool migrate_dirty_bitmaps(void)
1981 s
= migrate_get_current();
1983 return s
->enabled_capabilities
[MIGRATION_CAPABILITY_DIRTY_BITMAPS
];
1986 bool migrate_use_events(void)
1990 s
= migrate_get_current();
1992 return s
->enabled_capabilities
[MIGRATION_CAPABILITY_EVENTS
];
1995 bool migrate_use_multifd(void)
1999 s
= migrate_get_current();
2001 return s
->enabled_capabilities
[MIGRATION_CAPABILITY_X_MULTIFD
];
2004 bool migrate_pause_before_switchover(void)
2008 s
= migrate_get_current();
2010 return s
->enabled_capabilities
[
2011 MIGRATION_CAPABILITY_PAUSE_BEFORE_SWITCHOVER
];
2014 int migrate_multifd_channels(void)
2018 s
= migrate_get_current();
2020 return s
->parameters
.x_multifd_channels
;
2023 int migrate_multifd_page_count(void)
2027 s
= migrate_get_current();
2029 return s
->parameters
.x_multifd_page_count
;
2032 int migrate_use_xbzrle(void)
2036 s
= migrate_get_current();
2038 return s
->enabled_capabilities
[MIGRATION_CAPABILITY_XBZRLE
];
2041 int64_t migrate_xbzrle_cache_size(void)
2045 s
= migrate_get_current();
2047 return s
->parameters
.xbzrle_cache_size
;
2050 static int64_t migrate_max_postcopy_bandwidth(void)
2054 s
= migrate_get_current();
2056 return s
->parameters
.max_postcopy_bandwidth
;
2059 bool migrate_use_block(void)
2063 s
= migrate_get_current();
2065 return s
->enabled_capabilities
[MIGRATION_CAPABILITY_BLOCK
];
2068 bool migrate_use_return_path(void)
2072 s
= migrate_get_current();
2074 return s
->enabled_capabilities
[MIGRATION_CAPABILITY_RETURN_PATH
];
2077 bool migrate_use_block_incremental(void)
2081 s
= migrate_get_current();
2083 return s
->parameters
.block_incremental
;
2086 /* migration thread support */
2088 * Something bad happened to the RP stream, mark an error
2089 * The caller shall print or trace something to indicate why
2091 static void mark_source_rp_bad(MigrationState
*s
)
2093 s
->rp_state
.error
= true;
2096 static struct rp_cmd_args
{
2097 ssize_t len
; /* -1 = variable */
2100 [MIG_RP_MSG_INVALID
] = { .len
= -1, .name
= "INVALID" },
2101 [MIG_RP_MSG_SHUT
] = { .len
= 4, .name
= "SHUT" },
2102 [MIG_RP_MSG_PONG
] = { .len
= 4, .name
= "PONG" },
2103 [MIG_RP_MSG_REQ_PAGES
] = { .len
= 12, .name
= "REQ_PAGES" },
2104 [MIG_RP_MSG_REQ_PAGES_ID
] = { .len
= -1, .name
= "REQ_PAGES_ID" },
2105 [MIG_RP_MSG_RECV_BITMAP
] = { .len
= -1, .name
= "RECV_BITMAP" },
2106 [MIG_RP_MSG_RESUME_ACK
] = { .len
= 4, .name
= "RESUME_ACK" },
2107 [MIG_RP_MSG_MAX
] = { .len
= -1, .name
= "MAX" },
2111 * Process a request for pages received on the return path,
2112 * We're allowed to send more than requested (e.g. to round to our page size)
2113 * and we don't need to send pages that have already been sent.
2115 static void migrate_handle_rp_req_pages(MigrationState
*ms
, const char* rbname
,
2116 ram_addr_t start
, size_t len
)
2118 long our_host_ps
= getpagesize();
2120 trace_migrate_handle_rp_req_pages(rbname
, start
, len
);
2123 * Since we currently insist on matching page sizes, just sanity check
2124 * we're being asked for whole host pages.
2126 if (start
& (our_host_ps
-1) ||
2127 (len
& (our_host_ps
-1))) {
2128 error_report("%s: Misaligned page request, start: " RAM_ADDR_FMT
2129 " len: %zd", __func__
, start
, len
);
2130 mark_source_rp_bad(ms
);
2134 if (ram_save_queue_pages(rbname
, start
, len
)) {
2135 mark_source_rp_bad(ms
);
2139 /* Return true to retry, false to quit */
2140 static bool postcopy_pause_return_path_thread(MigrationState
*s
)
2142 trace_postcopy_pause_return_path();
2144 qemu_sem_wait(&s
->postcopy_pause_rp_sem
);
2146 trace_postcopy_pause_return_path_continued();
2151 static int migrate_handle_rp_recv_bitmap(MigrationState
*s
, char *block_name
)
2153 RAMBlock
*block
= qemu_ram_block_by_name(block_name
);
2156 error_report("%s: invalid block name '%s'", __func__
, block_name
);
2160 /* Fetch the received bitmap and refresh the dirty bitmap */
2161 return ram_dirty_bitmap_reload(s
, block
);
2164 static int migrate_handle_rp_resume_ack(MigrationState
*s
, uint32_t value
)
2166 trace_source_return_path_thread_resume_ack(value
);
2168 if (value
!= MIGRATION_RESUME_ACK_VALUE
) {
2169 error_report("%s: illegal resume_ack value %"PRIu32
,
2174 /* Now both sides are active. */
2175 migrate_set_state(&s
->state
, MIGRATION_STATUS_POSTCOPY_RECOVER
,
2176 MIGRATION_STATUS_POSTCOPY_ACTIVE
);
2178 /* Notify send thread that time to continue send pages */
2179 qemu_sem_post(&s
->rp_state
.rp_sem
);
2185 * Handles messages sent on the return path towards the source VM
2188 static void *source_return_path_thread(void *opaque
)
2190 MigrationState
*ms
= opaque
;
2191 QEMUFile
*rp
= ms
->rp_state
.from_dst_file
;
2192 uint16_t header_len
, header_type
;
2194 uint32_t tmp32
, sibling_error
;
2195 ram_addr_t start
= 0; /* =0 to silence warning */
2196 size_t len
= 0, expected_len
;
2199 trace_source_return_path_thread_entry();
2200 rcu_register_thread();
2203 while (!ms
->rp_state
.error
&& !qemu_file_get_error(rp
) &&
2204 migration_is_setup_or_active(ms
->state
)) {
2205 trace_source_return_path_thread_loop_top();
2206 header_type
= qemu_get_be16(rp
);
2207 header_len
= qemu_get_be16(rp
);
2209 if (qemu_file_get_error(rp
)) {
2210 mark_source_rp_bad(ms
);
2214 if (header_type
>= MIG_RP_MSG_MAX
||
2215 header_type
== MIG_RP_MSG_INVALID
) {
2216 error_report("RP: Received invalid message 0x%04x length 0x%04x",
2217 header_type
, header_len
);
2218 mark_source_rp_bad(ms
);
2222 if ((rp_cmd_args
[header_type
].len
!= -1 &&
2223 header_len
!= rp_cmd_args
[header_type
].len
) ||
2224 header_len
> sizeof(buf
)) {
2225 error_report("RP: Received '%s' message (0x%04x) with"
2226 "incorrect length %d expecting %zu",
2227 rp_cmd_args
[header_type
].name
, header_type
, header_len
,
2228 (size_t)rp_cmd_args
[header_type
].len
);
2229 mark_source_rp_bad(ms
);
2233 /* We know we've got a valid header by this point */
2234 res
= qemu_get_buffer(rp
, buf
, header_len
);
2235 if (res
!= header_len
) {
2236 error_report("RP: Failed reading data for message 0x%04x"
2237 " read %d expected %d",
2238 header_type
, res
, header_len
);
2239 mark_source_rp_bad(ms
);
2243 /* OK, we have the message and the data */
2244 switch (header_type
) {
2245 case MIG_RP_MSG_SHUT
:
2246 sibling_error
= ldl_be_p(buf
);
2247 trace_source_return_path_thread_shut(sibling_error
);
2248 if (sibling_error
) {
2249 error_report("RP: Sibling indicated error %d", sibling_error
);
2250 mark_source_rp_bad(ms
);
2253 * We'll let the main thread deal with closing the RP
2254 * we could do a shutdown(2) on it, but we're the only user
2255 * anyway, so there's nothing gained.
2259 case MIG_RP_MSG_PONG
:
2260 tmp32
= ldl_be_p(buf
);
2261 trace_source_return_path_thread_pong(tmp32
);
2264 case MIG_RP_MSG_REQ_PAGES
:
2265 start
= ldq_be_p(buf
);
2266 len
= ldl_be_p(buf
+ 8);
2267 migrate_handle_rp_req_pages(ms
, NULL
, start
, len
);
2270 case MIG_RP_MSG_REQ_PAGES_ID
:
2271 expected_len
= 12 + 1; /* header + termination */
2273 if (header_len
>= expected_len
) {
2274 start
= ldq_be_p(buf
);
2275 len
= ldl_be_p(buf
+ 8);
2276 /* Now we expect an idstr */
2277 tmp32
= buf
[12]; /* Length of the following idstr */
2278 buf
[13 + tmp32
] = '\0';
2279 expected_len
+= tmp32
;
2281 if (header_len
!= expected_len
) {
2282 error_report("RP: Req_Page_id with length %d expecting %zd",
2283 header_len
, expected_len
);
2284 mark_source_rp_bad(ms
);
2287 migrate_handle_rp_req_pages(ms
, (char *)&buf
[13], start
, len
);
2290 case MIG_RP_MSG_RECV_BITMAP
:
2291 if (header_len
< 1) {
2292 error_report("%s: missing block name", __func__
);
2293 mark_source_rp_bad(ms
);
2296 /* Format: len (1B) + idstr (<255B). This ends the idstr. */
2297 buf
[buf
[0] + 1] = '\0';
2298 if (migrate_handle_rp_recv_bitmap(ms
, (char *)(buf
+ 1))) {
2299 mark_source_rp_bad(ms
);
2304 case MIG_RP_MSG_RESUME_ACK
:
2305 tmp32
= ldl_be_p(buf
);
2306 if (migrate_handle_rp_resume_ack(ms
, tmp32
)) {
2307 mark_source_rp_bad(ms
);
2318 res
= qemu_file_get_error(rp
);
2322 * Maybe there is something we can do: it looks like a
2323 * network down issue, and we pause for a recovery.
2325 if (postcopy_pause_return_path_thread(ms
)) {
2326 /* Reload rp, reset the rest */
2327 if (rp
!= ms
->rp_state
.from_dst_file
) {
2329 rp
= ms
->rp_state
.from_dst_file
;
2331 ms
->rp_state
.error
= false;
2336 trace_source_return_path_thread_bad_end();
2337 mark_source_rp_bad(ms
);
2340 trace_source_return_path_thread_end();
2341 ms
->rp_state
.from_dst_file
= NULL
;
2343 rcu_unregister_thread();
2347 static int open_return_path_on_source(MigrationState
*ms
,
2351 ms
->rp_state
.from_dst_file
= qemu_file_get_return_path(ms
->to_dst_file
);
2352 if (!ms
->rp_state
.from_dst_file
) {
2356 trace_open_return_path_on_source();
2358 if (!create_thread
) {
2363 qemu_thread_create(&ms
->rp_state
.rp_thread
, "return path",
2364 source_return_path_thread
, ms
, QEMU_THREAD_JOINABLE
);
2366 trace_open_return_path_on_source_continue();
2371 /* Returns 0 if the RP was ok, otherwise there was an error on the RP */
2372 static int await_return_path_close_on_source(MigrationState
*ms
)
2375 * If this is a normal exit then the destination will send a SHUT and the
2376 * rp_thread will exit, however if there's an error we need to cause
2379 if (qemu_file_get_error(ms
->to_dst_file
) && ms
->rp_state
.from_dst_file
) {
2381 * shutdown(2), if we have it, will cause it to unblock if it's stuck
2382 * waiting for the destination.
2384 qemu_file_shutdown(ms
->rp_state
.from_dst_file
);
2385 mark_source_rp_bad(ms
);
2387 trace_await_return_path_close_on_source_joining();
2388 qemu_thread_join(&ms
->rp_state
.rp_thread
);
2389 trace_await_return_path_close_on_source_close();
2390 return ms
->rp_state
.error
;
2394 * Switch from normal iteration to postcopy
2395 * Returns non-0 on error
2397 static int postcopy_start(MigrationState
*ms
)
2400 QIOChannelBuffer
*bioc
;
2402 int64_t time_at_stop
= qemu_clock_get_ms(QEMU_CLOCK_REALTIME
);
2403 int64_t bandwidth
= migrate_max_postcopy_bandwidth();
2404 bool restart_block
= false;
2405 int cur_state
= MIGRATION_STATUS_ACTIVE
;
2406 if (!migrate_pause_before_switchover()) {
2407 migrate_set_state(&ms
->state
, MIGRATION_STATUS_ACTIVE
,
2408 MIGRATION_STATUS_POSTCOPY_ACTIVE
);
2411 trace_postcopy_start();
2412 qemu_mutex_lock_iothread();
2413 trace_postcopy_start_set_run();
2415 qemu_system_wakeup_request(QEMU_WAKEUP_REASON_OTHER
, NULL
);
2416 global_state_store();
2417 ret
= vm_stop_force_state(RUN_STATE_FINISH_MIGRATE
);
2422 ret
= migration_maybe_pause(ms
, &cur_state
,
2423 MIGRATION_STATUS_POSTCOPY_ACTIVE
);
2428 ret
= bdrv_inactivate_all();
2432 restart_block
= true;
2435 * Cause any non-postcopiable, but iterative devices to
2436 * send out their final data.
2438 qemu_savevm_state_complete_precopy(ms
->to_dst_file
, true, false);
2441 * in Finish migrate and with the io-lock held everything should
2442 * be quiet, but we've potentially still got dirty pages and we
2443 * need to tell the destination to throw any pages it's already received
2446 if (migrate_postcopy_ram()) {
2447 if (ram_postcopy_send_discard_bitmap(ms
)) {
2448 error_report("postcopy send discard bitmap failed");
2454 * send rest of state - note things that are doing postcopy
2455 * will notice we're in POSTCOPY_ACTIVE and not actually
2456 * wrap their state up here
2458 /* 0 max-postcopy-bandwidth means unlimited */
2460 qemu_file_set_rate_limit(ms
->to_dst_file
, INT64_MAX
);
2462 qemu_file_set_rate_limit(ms
->to_dst_file
, bandwidth
/ XFER_LIMIT_RATIO
);
2464 if (migrate_postcopy_ram()) {
2465 /* Ping just for debugging, helps line traces up */
2466 qemu_savevm_send_ping(ms
->to_dst_file
, 2);
2470 * While loading the device state we may trigger page transfer
2471 * requests and the fd must be free to process those, and thus
2472 * the destination must read the whole device state off the fd before
2473 * it starts processing it. Unfortunately the ad-hoc migration format
2474 * doesn't allow the destination to know the size to read without fully
2475 * parsing it through each devices load-state code (especially the open
2476 * coded devices that use get/put).
2477 * So we wrap the device state up in a package with a length at the start;
2478 * to do this we use a qemu_buf to hold the whole of the device state.
2480 bioc
= qio_channel_buffer_new(4096);
2481 qio_channel_set_name(QIO_CHANNEL(bioc
), "migration-postcopy-buffer");
2482 fb
= qemu_fopen_channel_output(QIO_CHANNEL(bioc
));
2483 object_unref(OBJECT(bioc
));
2486 * Make sure the receiver can get incoming pages before we send the rest
2489 qemu_savevm_send_postcopy_listen(fb
);
2491 qemu_savevm_state_complete_precopy(fb
, false, false);
2492 if (migrate_postcopy_ram()) {
2493 qemu_savevm_send_ping(fb
, 3);
2496 qemu_savevm_send_postcopy_run(fb
);
2498 /* <><> end of stuff going into the package */
2500 /* Last point of recovery; as soon as we send the package the destination
2501 * can open devices and potentially start running.
2502 * Lets just check again we've not got any errors.
2504 ret
= qemu_file_get_error(ms
->to_dst_file
);
2506 error_report("postcopy_start: Migration stream errored (pre package)");
2510 restart_block
= false;
2512 /* Now send that blob */
2513 if (qemu_savevm_send_packaged(ms
->to_dst_file
, bioc
->data
, bioc
->usage
)) {
2518 /* Send a notify to give a chance for anything that needs to happen
2519 * at the transition to postcopy and after the device state; in particular
2520 * spice needs to trigger a transition now
2522 ms
->postcopy_after_devices
= true;
2523 notifier_list_notify(&migration_state_notifiers
, ms
);
2525 ms
->downtime
= qemu_clock_get_ms(QEMU_CLOCK_REALTIME
) - time_at_stop
;
2527 qemu_mutex_unlock_iothread();
2529 if (migrate_postcopy_ram()) {
2531 * Although this ping is just for debug, it could potentially be
2532 * used for getting a better measurement of downtime at the source.
2534 qemu_savevm_send_ping(ms
->to_dst_file
, 4);
2537 if (migrate_release_ram()) {
2538 ram_postcopy_migrated_memory_release(ms
);
2541 ret
= qemu_file_get_error(ms
->to_dst_file
);
2543 error_report("postcopy_start: Migration stream errored");
2544 migrate_set_state(&ms
->state
, MIGRATION_STATUS_POSTCOPY_ACTIVE
,
2545 MIGRATION_STATUS_FAILED
);
2553 migrate_set_state(&ms
->state
, MIGRATION_STATUS_POSTCOPY_ACTIVE
,
2554 MIGRATION_STATUS_FAILED
);
2555 if (restart_block
) {
2556 /* A failure happened early enough that we know the destination hasn't
2557 * accessed block devices, so we're safe to recover.
2559 Error
*local_err
= NULL
;
2561 bdrv_invalidate_cache_all(&local_err
);
2563 error_report_err(local_err
);
2566 qemu_mutex_unlock_iothread();
2571 * migration_maybe_pause: Pause if required to by
2572 * migrate_pause_before_switchover called with the iothread locked
2573 * Returns: 0 on success
2575 static int migration_maybe_pause(MigrationState
*s
,
2576 int *current_active_state
,
2579 if (!migrate_pause_before_switchover()) {
2583 /* Since leaving this state is not atomic with posting the semaphore
2584 * it's possible that someone could have issued multiple migrate_continue
2585 * and the semaphore is incorrectly positive at this point;
2586 * the docs say it's undefined to reinit a semaphore that's already
2587 * init'd, so use timedwait to eat up any existing posts.
2589 while (qemu_sem_timedwait(&s
->pause_sem
, 1) == 0) {
2590 /* This block intentionally left blank */
2593 qemu_mutex_unlock_iothread();
2594 migrate_set_state(&s
->state
, *current_active_state
,
2595 MIGRATION_STATUS_PRE_SWITCHOVER
);
2596 qemu_sem_wait(&s
->pause_sem
);
2597 migrate_set_state(&s
->state
, MIGRATION_STATUS_PRE_SWITCHOVER
,
2599 *current_active_state
= new_state
;
2600 qemu_mutex_lock_iothread();
2602 return s
->state
== new_state
? 0 : -EINVAL
;
2606 * migration_completion: Used by migration_thread when there's not much left.
2607 * The caller 'breaks' the loop when this returns.
2609 * @s: Current migration state
2611 static void migration_completion(MigrationState
*s
)
2614 int current_active_state
= s
->state
;
2616 if (s
->state
== MIGRATION_STATUS_ACTIVE
) {
2617 qemu_mutex_lock_iothread();
2618 s
->downtime_start
= qemu_clock_get_ms(QEMU_CLOCK_REALTIME
);
2619 qemu_system_wakeup_request(QEMU_WAKEUP_REASON_OTHER
, NULL
);
2620 s
->vm_was_running
= runstate_is_running();
2621 ret
= global_state_store();
2624 bool inactivate
= !migrate_colo_enabled();
2625 ret
= vm_stop_force_state(RUN_STATE_FINISH_MIGRATE
);
2627 ret
= migration_maybe_pause(s
, ¤t_active_state
,
2628 MIGRATION_STATUS_DEVICE
);
2631 qemu_file_set_rate_limit(s
->to_dst_file
, INT64_MAX
);
2632 ret
= qemu_savevm_state_complete_precopy(s
->to_dst_file
, false,
2635 if (inactivate
&& ret
>= 0) {
2636 s
->block_inactive
= true;
2639 qemu_mutex_unlock_iothread();
2644 } else if (s
->state
== MIGRATION_STATUS_POSTCOPY_ACTIVE
) {
2645 trace_migration_completion_postcopy_end();
2647 qemu_savevm_state_complete_postcopy(s
->to_dst_file
);
2648 trace_migration_completion_postcopy_end_after_complete();
2652 * If rp was opened we must clean up the thread before
2653 * cleaning everything else up (since if there are no failures
2654 * it will wait for the destination to send it's status in
2657 if (s
->rp_state
.from_dst_file
) {
2659 trace_migration_return_path_end_before();
2660 rp_error
= await_return_path_close_on_source(s
);
2661 trace_migration_return_path_end_after(rp_error
);
2663 goto fail_invalidate
;
2667 if (qemu_file_get_error(s
->to_dst_file
)) {
2668 trace_migration_completion_file_err();
2669 goto fail_invalidate
;
2672 if (!migrate_colo_enabled()) {
2673 migrate_set_state(&s
->state
, current_active_state
,
2674 MIGRATION_STATUS_COMPLETED
);
2680 /* If not doing postcopy, vm_start() will be called: let's regain
2681 * control on images.
2683 if (s
->state
== MIGRATION_STATUS_ACTIVE
||
2684 s
->state
== MIGRATION_STATUS_DEVICE
) {
2685 Error
*local_err
= NULL
;
2687 qemu_mutex_lock_iothread();
2688 bdrv_invalidate_cache_all(&local_err
);
2690 error_report_err(local_err
);
2692 s
->block_inactive
= false;
2694 qemu_mutex_unlock_iothread();
2698 migrate_set_state(&s
->state
, current_active_state
,
2699 MIGRATION_STATUS_FAILED
);
2702 bool migrate_colo_enabled(void)
2704 MigrationState
*s
= migrate_get_current();
2705 return s
->enabled_capabilities
[MIGRATION_CAPABILITY_X_COLO
];
2708 typedef enum MigThrError
{
2709 /* No error detected */
2710 MIG_THR_ERR_NONE
= 0,
2711 /* Detected error, but resumed successfully */
2712 MIG_THR_ERR_RECOVERED
= 1,
2713 /* Detected fatal error, need to exit */
2714 MIG_THR_ERR_FATAL
= 2,
2717 static int postcopy_resume_handshake(MigrationState
*s
)
2719 qemu_savevm_send_postcopy_resume(s
->to_dst_file
);
2721 while (s
->state
== MIGRATION_STATUS_POSTCOPY_RECOVER
) {
2722 qemu_sem_wait(&s
->rp_state
.rp_sem
);
2725 if (s
->state
== MIGRATION_STATUS_POSTCOPY_ACTIVE
) {
2732 /* Return zero if success, or <0 for error */
2733 static int postcopy_do_resume(MigrationState
*s
)
2738 * Call all the resume_prepare() hooks, so that modules can be
2739 * ready for the migration resume.
2741 ret
= qemu_savevm_state_resume_prepare(s
);
2743 error_report("%s: resume_prepare() failure detected: %d",
2749 * Last handshake with destination on the resume (destination will
2750 * switch to postcopy-active afterwards)
2752 ret
= postcopy_resume_handshake(s
);
2754 error_report("%s: handshake failed: %d", __func__
, ret
);
2762 * We don't return until we are in a safe state to continue current
2763 * postcopy migration. Returns MIG_THR_ERR_RECOVERED if recovered, or
2764 * MIG_THR_ERR_FATAL if unrecovery failure happened.
2766 static MigThrError
postcopy_pause(MigrationState
*s
)
2768 assert(s
->state
== MIGRATION_STATUS_POSTCOPY_ACTIVE
);
2773 migrate_set_state(&s
->state
, s
->state
,
2774 MIGRATION_STATUS_POSTCOPY_PAUSED
);
2776 /* Current channel is possibly broken. Release it. */
2777 assert(s
->to_dst_file
);
2778 qemu_mutex_lock(&s
->qemu_file_lock
);
2779 file
= s
->to_dst_file
;
2780 s
->to_dst_file
= NULL
;
2781 qemu_mutex_unlock(&s
->qemu_file_lock
);
2783 qemu_file_shutdown(file
);
2786 error_report("Detected IO failure for postcopy. "
2787 "Migration paused.");
2790 * We wait until things fixed up. Then someone will setup the
2791 * status back for us.
2793 while (s
->state
== MIGRATION_STATUS_POSTCOPY_PAUSED
) {
2794 qemu_sem_wait(&s
->postcopy_pause_sem
);
2797 if (s
->state
== MIGRATION_STATUS_POSTCOPY_RECOVER
) {
2798 /* Woken up by a recover procedure. Give it a shot */
2801 * Firstly, let's wake up the return path now, with a new
2802 * return path channel.
2804 qemu_sem_post(&s
->postcopy_pause_rp_sem
);
2806 /* Do the resume logic */
2807 if (postcopy_do_resume(s
) == 0) {
2808 /* Let's continue! */
2809 trace_postcopy_pause_continued();
2810 return MIG_THR_ERR_RECOVERED
;
2813 * Something wrong happened during the recovery, let's
2814 * pause again. Pause is always better than throwing
2820 /* This is not right... Time to quit. */
2821 return MIG_THR_ERR_FATAL
;
2826 static MigThrError
migration_detect_error(MigrationState
*s
)
2830 /* Try to detect any file errors */
2831 ret
= qemu_file_get_error(s
->to_dst_file
);
2834 /* Everything is fine */
2835 return MIG_THR_ERR_NONE
;
2838 if (s
->state
== MIGRATION_STATUS_POSTCOPY_ACTIVE
&& ret
== -EIO
) {
2840 * For postcopy, we allow the network to be down for a
2841 * while. After that, it can be continued by a
2844 return postcopy_pause(s
);
2847 * For precopy (or postcopy with error outside IO), we fail
2850 migrate_set_state(&s
->state
, s
->state
, MIGRATION_STATUS_FAILED
);
2851 trace_migration_thread_file_err();
2853 /* Time to stop the migration, now. */
2854 return MIG_THR_ERR_FATAL
;
2858 /* How many bytes have we transferred since the beggining of the migration */
2859 static uint64_t migration_total_bytes(MigrationState
*s
)
2861 return qemu_ftell(s
->to_dst_file
) + ram_counters
.multifd_bytes
;
2864 static void migration_calculate_complete(MigrationState
*s
)
2866 uint64_t bytes
= migration_total_bytes(s
);
2867 int64_t end_time
= qemu_clock_get_ms(QEMU_CLOCK_REALTIME
);
2868 int64_t transfer_time
;
2870 s
->total_time
= end_time
- s
->start_time
;
2873 * It's still not set, so we are precopy migration. For
2874 * postcopy, downtime is calculated during postcopy_start().
2876 s
->downtime
= end_time
- s
->downtime_start
;
2879 transfer_time
= s
->total_time
- s
->setup_time
;
2880 if (transfer_time
) {
2881 s
->mbps
= ((double) bytes
* 8.0) / transfer_time
/ 1000;
2885 static void migration_update_counters(MigrationState
*s
,
2886 int64_t current_time
)
2888 uint64_t transferred
, transferred_pages
, time_spent
;
2889 uint64_t current_bytes
; /* bytes transferred since the beginning */
2892 if (current_time
< s
->iteration_start_time
+ BUFFER_DELAY
) {
2896 current_bytes
= migration_total_bytes(s
);
2897 transferred
= current_bytes
- s
->iteration_initial_bytes
;
2898 time_spent
= current_time
- s
->iteration_start_time
;
2899 bandwidth
= (double)transferred
/ time_spent
;
2900 s
->threshold_size
= bandwidth
* s
->parameters
.downtime_limit
;
2902 s
->mbps
= (((double) transferred
* 8.0) /
2903 ((double) time_spent
/ 1000.0)) / 1000.0 / 1000.0;
2905 transferred_pages
= ram_get_total_transferred_pages() -
2906 s
->iteration_initial_pages
;
2907 s
->pages_per_second
= (double) transferred_pages
/
2908 (((double) time_spent
/ 1000.0));
2911 * if we haven't sent anything, we don't want to
2912 * recalculate. 10000 is a small enough number for our purposes
2914 if (ram_counters
.dirty_pages_rate
&& transferred
> 10000) {
2915 s
->expected_downtime
= ram_counters
.remaining
/ bandwidth
;
2918 qemu_file_reset_rate_limit(s
->to_dst_file
);
2920 s
->iteration_start_time
= current_time
;
2921 s
->iteration_initial_bytes
= current_bytes
;
2922 s
->iteration_initial_pages
= ram_get_total_transferred_pages();
2924 trace_migrate_transferred(transferred
, time_spent
,
2925 bandwidth
, s
->threshold_size
);
2928 /* Migration thread iteration status */
2930 MIG_ITERATE_RESUME
, /* Resume current iteration */
2931 MIG_ITERATE_SKIP
, /* Skip current iteration */
2932 MIG_ITERATE_BREAK
, /* Break the loop */
2936 * Return true if continue to the next iteration directly, false
2939 static MigIterateState
migration_iteration_run(MigrationState
*s
)
2941 uint64_t pending_size
, pend_pre
, pend_compat
, pend_post
;
2942 bool in_postcopy
= s
->state
== MIGRATION_STATUS_POSTCOPY_ACTIVE
;
2944 qemu_savevm_state_pending(s
->to_dst_file
, s
->threshold_size
, &pend_pre
,
2945 &pend_compat
, &pend_post
);
2946 pending_size
= pend_pre
+ pend_compat
+ pend_post
;
2948 trace_migrate_pending(pending_size
, s
->threshold_size
,
2949 pend_pre
, pend_compat
, pend_post
);
2951 if (pending_size
&& pending_size
>= s
->threshold_size
) {
2952 /* Still a significant amount to transfer */
2953 if (migrate_postcopy() && !in_postcopy
&&
2954 pend_pre
<= s
->threshold_size
&&
2955 atomic_read(&s
->start_postcopy
)) {
2956 if (postcopy_start(s
)) {
2957 error_report("%s: postcopy failed to start", __func__
);
2959 return MIG_ITERATE_SKIP
;
2961 /* Just another iteration step */
2962 qemu_savevm_state_iterate(s
->to_dst_file
,
2963 s
->state
== MIGRATION_STATUS_POSTCOPY_ACTIVE
);
2965 trace_migration_thread_low_pending(pending_size
);
2966 migration_completion(s
);
2967 return MIG_ITERATE_BREAK
;
2970 return MIG_ITERATE_RESUME
;
2973 static void migration_iteration_finish(MigrationState
*s
)
2975 /* If we enabled cpu throttling for auto-converge, turn it off. */
2976 cpu_throttle_stop();
2978 qemu_mutex_lock_iothread();
2980 case MIGRATION_STATUS_COMPLETED
:
2981 migration_calculate_complete(s
);
2982 runstate_set(RUN_STATE_POSTMIGRATE
);
2985 case MIGRATION_STATUS_ACTIVE
:
2987 * We should really assert here, but since it's during
2988 * migration, let's try to reduce the usage of assertions.
2990 if (!migrate_colo_enabled()) {
2991 error_report("%s: critical error: calling COLO code without "
2992 "COLO enabled", __func__
);
2994 migrate_start_colo_process(s
);
2996 * Fixme: we will run VM in COLO no matter its old running state.
2997 * After exited COLO, we will keep running.
2999 s
->vm_was_running
= true;
3001 case MIGRATION_STATUS_FAILED
:
3002 case MIGRATION_STATUS_CANCELLED
:
3003 case MIGRATION_STATUS_CANCELLING
:
3004 if (s
->vm_was_running
) {
3007 if (runstate_check(RUN_STATE_FINISH_MIGRATE
)) {
3008 runstate_set(RUN_STATE_POSTMIGRATE
);
3014 /* Should not reach here, but if so, forgive the VM. */
3015 error_report("%s: Unknown ending state %d", __func__
, s
->state
);
3018 qemu_bh_schedule(s
->cleanup_bh
);
3019 qemu_mutex_unlock_iothread();
3022 void migration_make_urgent_request(void)
3024 qemu_sem_post(&migrate_get_current()->rate_limit_sem
);
3027 void migration_consume_urgent_request(void)
3029 qemu_sem_wait(&migrate_get_current()->rate_limit_sem
);
3033 * Master migration thread on the source VM.
3034 * It drives the migration and pumps the data down the outgoing channel.
3036 static void *migration_thread(void *opaque
)
3038 MigrationState
*s
= opaque
;
3039 int64_t setup_start
= qemu_clock_get_ms(QEMU_CLOCK_HOST
);
3040 MigThrError thr_error
;
3041 bool urgent
= false;
3043 rcu_register_thread();
3045 s
->iteration_start_time
= qemu_clock_get_ms(QEMU_CLOCK_REALTIME
);
3047 qemu_savevm_state_header(s
->to_dst_file
);
3050 * If we opened the return path, we need to make sure dst has it
3053 if (s
->rp_state
.from_dst_file
) {
3054 /* Now tell the dest that it should open its end so it can reply */
3055 qemu_savevm_send_open_return_path(s
->to_dst_file
);
3057 /* And do a ping that will make stuff easier to debug */
3058 qemu_savevm_send_ping(s
->to_dst_file
, 1);
3061 if (migrate_postcopy()) {
3063 * Tell the destination that we *might* want to do postcopy later;
3064 * if the other end can't do postcopy it should fail now, nice and
3067 qemu_savevm_send_postcopy_advise(s
->to_dst_file
);
3070 if (migrate_colo_enabled()) {
3071 /* Notify migration destination that we enable COLO */
3072 qemu_savevm_send_colo_enable(s
->to_dst_file
);
3075 qemu_savevm_state_setup(s
->to_dst_file
);
3077 s
->setup_time
= qemu_clock_get_ms(QEMU_CLOCK_HOST
) - setup_start
;
3078 migrate_set_state(&s
->state
, MIGRATION_STATUS_SETUP
,
3079 MIGRATION_STATUS_ACTIVE
);
3081 trace_migration_thread_setup_complete();
3083 while (s
->state
== MIGRATION_STATUS_ACTIVE
||
3084 s
->state
== MIGRATION_STATUS_POSTCOPY_ACTIVE
) {
3085 int64_t current_time
;
3087 if (urgent
|| !qemu_file_rate_limit(s
->to_dst_file
)) {
3088 MigIterateState iter_state
= migration_iteration_run(s
);
3089 if (iter_state
== MIG_ITERATE_SKIP
) {
3091 } else if (iter_state
== MIG_ITERATE_BREAK
) {
3097 * Try to detect any kind of failures, and see whether we
3098 * should stop the migration now.
3100 thr_error
= migration_detect_error(s
);
3101 if (thr_error
== MIG_THR_ERR_FATAL
) {
3102 /* Stop migration */
3104 } else if (thr_error
== MIG_THR_ERR_RECOVERED
) {
3106 * Just recovered from a e.g. network failure, reset all
3107 * the local variables. This is important to avoid
3108 * breaking transferred_bytes and bandwidth calculation
3110 s
->iteration_start_time
= qemu_clock_get_ms(QEMU_CLOCK_REALTIME
);
3111 s
->iteration_initial_bytes
= 0;
3114 current_time
= qemu_clock_get_ms(QEMU_CLOCK_REALTIME
);
3116 migration_update_counters(s
, current_time
);
3119 if (qemu_file_rate_limit(s
->to_dst_file
)) {
3120 /* Wait for a delay to do rate limiting OR
3121 * something urgent to post the semaphore.
3123 int ms
= s
->iteration_start_time
+ BUFFER_DELAY
- current_time
;
3124 trace_migration_thread_ratelimit_pre(ms
);
3125 if (qemu_sem_timedwait(&s
->rate_limit_sem
, ms
) == 0) {
3126 /* We were worken by one or more urgent things but
3127 * the timedwait will have consumed one of them.
3128 * The service routine for the urgent wake will dec
3129 * the semaphore itself for each item it consumes,
3130 * so add this one we just eat back.
3132 qemu_sem_post(&s
->rate_limit_sem
);
3135 trace_migration_thread_ratelimit_post(urgent
);
3139 trace_migration_thread_after_loop();
3140 migration_iteration_finish(s
);
3141 rcu_unregister_thread();
3145 void migrate_fd_connect(MigrationState
*s
, Error
*error_in
)
3148 bool resume
= s
->state
== MIGRATION_STATUS_POSTCOPY_PAUSED
;
3150 s
->expected_downtime
= s
->parameters
.downtime_limit
;
3151 s
->cleanup_bh
= qemu_bh_new(migrate_fd_cleanup
, s
);
3153 migrate_fd_error(s
, error_in
);
3154 migrate_fd_cleanup(s
);
3159 /* This is a resumed migration */
3160 rate_limit
= INT64_MAX
;
3162 /* This is a fresh new migration */
3163 rate_limit
= s
->parameters
.max_bandwidth
/ XFER_LIMIT_RATIO
;
3165 /* Notify before starting migration thread */
3166 notifier_list_notify(&migration_state_notifiers
, s
);
3169 qemu_file_set_rate_limit(s
->to_dst_file
, rate_limit
);
3170 qemu_file_set_blocking(s
->to_dst_file
, true);
3173 * Open the return path. For postcopy, it is used exclusively. For
3174 * precopy, only if user specified "return-path" capability would
3175 * QEMU uses the return path.
3177 if (migrate_postcopy_ram() || migrate_use_return_path()) {
3178 if (open_return_path_on_source(s
, !resume
)) {
3179 error_report("Unable to open return-path for postcopy");
3180 migrate_set_state(&s
->state
, s
->state
, MIGRATION_STATUS_FAILED
);
3181 migrate_fd_cleanup(s
);
3187 /* Wakeup the main migration thread to do the recovery */
3188 migrate_set_state(&s
->state
, MIGRATION_STATUS_POSTCOPY_PAUSED
,
3189 MIGRATION_STATUS_POSTCOPY_RECOVER
);
3190 qemu_sem_post(&s
->postcopy_pause_sem
);
3194 if (multifd_save_setup() != 0) {
3195 migrate_set_state(&s
->state
, MIGRATION_STATUS_SETUP
,
3196 MIGRATION_STATUS_FAILED
);
3197 migrate_fd_cleanup(s
);
3200 qemu_thread_create(&s
->thread
, "live_migration", migration_thread
, s
,
3201 QEMU_THREAD_JOINABLE
);
3202 s
->migration_thread_running
= true;
3205 void migration_global_dump(Monitor
*mon
)
3207 MigrationState
*ms
= migrate_get_current();
3209 monitor_printf(mon
, "globals:\n");
3210 monitor_printf(mon
, "store-global-state: %s\n",
3211 ms
->store_global_state
? "on" : "off");
3212 monitor_printf(mon
, "only-migratable: %s\n",
3213 ms
->only_migratable
? "on" : "off");
3214 monitor_printf(mon
, "send-configuration: %s\n",
3215 ms
->send_configuration
? "on" : "off");
3216 monitor_printf(mon
, "send-section-footer: %s\n",
3217 ms
->send_section_footer
? "on" : "off");
3218 monitor_printf(mon
, "decompress-error-check: %s\n",
3219 ms
->decompress_error_check
? "on" : "off");
3222 #define DEFINE_PROP_MIG_CAP(name, x) \
3223 DEFINE_PROP_BOOL(name, MigrationState, enabled_capabilities[x], false)
3225 static Property migration_properties
[] = {
3226 DEFINE_PROP_BOOL("store-global-state", MigrationState
,
3227 store_global_state
, true),
3228 DEFINE_PROP_BOOL("only-migratable", MigrationState
, only_migratable
, false),
3229 DEFINE_PROP_BOOL("send-configuration", MigrationState
,
3230 send_configuration
, true),
3231 DEFINE_PROP_BOOL("send-section-footer", MigrationState
,
3232 send_section_footer
, true),
3233 DEFINE_PROP_BOOL("decompress-error-check", MigrationState
,
3234 decompress_error_check
, true),
3236 /* Migration parameters */
3237 DEFINE_PROP_UINT8("x-compress-level", MigrationState
,
3238 parameters
.compress_level
,
3239 DEFAULT_MIGRATE_COMPRESS_LEVEL
),
3240 DEFINE_PROP_UINT8("x-compress-threads", MigrationState
,
3241 parameters
.compress_threads
,
3242 DEFAULT_MIGRATE_COMPRESS_THREAD_COUNT
),
3243 DEFINE_PROP_BOOL("x-compress-wait-thread", MigrationState
,
3244 parameters
.compress_wait_thread
, true),
3245 DEFINE_PROP_UINT8("x-decompress-threads", MigrationState
,
3246 parameters
.decompress_threads
,
3247 DEFAULT_MIGRATE_DECOMPRESS_THREAD_COUNT
),
3248 DEFINE_PROP_UINT8("x-cpu-throttle-initial", MigrationState
,
3249 parameters
.cpu_throttle_initial
,
3250 DEFAULT_MIGRATE_CPU_THROTTLE_INITIAL
),
3251 DEFINE_PROP_UINT8("x-cpu-throttle-increment", MigrationState
,
3252 parameters
.cpu_throttle_increment
,
3253 DEFAULT_MIGRATE_CPU_THROTTLE_INCREMENT
),
3254 DEFINE_PROP_SIZE("x-max-bandwidth", MigrationState
,
3255 parameters
.max_bandwidth
, MAX_THROTTLE
),
3256 DEFINE_PROP_UINT64("x-downtime-limit", MigrationState
,
3257 parameters
.downtime_limit
,
3258 DEFAULT_MIGRATE_SET_DOWNTIME
),
3259 DEFINE_PROP_UINT32("x-checkpoint-delay", MigrationState
,
3260 parameters
.x_checkpoint_delay
,
3261 DEFAULT_MIGRATE_X_CHECKPOINT_DELAY
),
3262 DEFINE_PROP_UINT8("x-multifd-channels", MigrationState
,
3263 parameters
.x_multifd_channels
,
3264 DEFAULT_MIGRATE_MULTIFD_CHANNELS
),
3265 DEFINE_PROP_UINT32("x-multifd-page-count", MigrationState
,
3266 parameters
.x_multifd_page_count
,
3267 DEFAULT_MIGRATE_MULTIFD_PAGE_COUNT
),
3268 DEFINE_PROP_SIZE("xbzrle-cache-size", MigrationState
,
3269 parameters
.xbzrle_cache_size
,
3270 DEFAULT_MIGRATE_XBZRLE_CACHE_SIZE
),
3271 DEFINE_PROP_SIZE("max-postcopy-bandwidth", MigrationState
,
3272 parameters
.max_postcopy_bandwidth
,
3273 DEFAULT_MIGRATE_MAX_POSTCOPY_BANDWIDTH
),
3274 DEFINE_PROP_UINT8("max-cpu-throttle", MigrationState
,
3275 parameters
.max_cpu_throttle
,
3276 DEFAULT_MIGRATE_MAX_CPU_THROTTLE
),
3278 /* Migration capabilities */
3279 DEFINE_PROP_MIG_CAP("x-xbzrle", MIGRATION_CAPABILITY_XBZRLE
),
3280 DEFINE_PROP_MIG_CAP("x-rdma-pin-all", MIGRATION_CAPABILITY_RDMA_PIN_ALL
),
3281 DEFINE_PROP_MIG_CAP("x-auto-converge", MIGRATION_CAPABILITY_AUTO_CONVERGE
),
3282 DEFINE_PROP_MIG_CAP("x-zero-blocks", MIGRATION_CAPABILITY_ZERO_BLOCKS
),
3283 DEFINE_PROP_MIG_CAP("x-compress", MIGRATION_CAPABILITY_COMPRESS
),
3284 DEFINE_PROP_MIG_CAP("x-events", MIGRATION_CAPABILITY_EVENTS
),
3285 DEFINE_PROP_MIG_CAP("x-postcopy-ram", MIGRATION_CAPABILITY_POSTCOPY_RAM
),
3286 DEFINE_PROP_MIG_CAP("x-colo", MIGRATION_CAPABILITY_X_COLO
),
3287 DEFINE_PROP_MIG_CAP("x-release-ram", MIGRATION_CAPABILITY_RELEASE_RAM
),
3288 DEFINE_PROP_MIG_CAP("x-block", MIGRATION_CAPABILITY_BLOCK
),
3289 DEFINE_PROP_MIG_CAP("x-return-path", MIGRATION_CAPABILITY_RETURN_PATH
),
3290 DEFINE_PROP_MIG_CAP("x-multifd", MIGRATION_CAPABILITY_X_MULTIFD
),
3292 DEFINE_PROP_END_OF_LIST(),
3295 static void migration_class_init(ObjectClass
*klass
, void *data
)
3297 DeviceClass
*dc
= DEVICE_CLASS(klass
);
3299 dc
->user_creatable
= false;
3300 dc
->props
= migration_properties
;
3303 static void migration_instance_finalize(Object
*obj
)
3305 MigrationState
*ms
= MIGRATION_OBJ(obj
);
3306 MigrationParameters
*params
= &ms
->parameters
;
3308 qemu_mutex_destroy(&ms
->error_mutex
);
3309 qemu_mutex_destroy(&ms
->qemu_file_lock
);
3310 g_free(params
->tls_hostname
);
3311 g_free(params
->tls_creds
);
3312 qemu_sem_destroy(&ms
->rate_limit_sem
);
3313 qemu_sem_destroy(&ms
->pause_sem
);
3314 qemu_sem_destroy(&ms
->postcopy_pause_sem
);
3315 qemu_sem_destroy(&ms
->postcopy_pause_rp_sem
);
3316 qemu_sem_destroy(&ms
->rp_state
.rp_sem
);
3317 error_free(ms
->error
);
3320 static void migration_instance_init(Object
*obj
)
3322 MigrationState
*ms
= MIGRATION_OBJ(obj
);
3323 MigrationParameters
*params
= &ms
->parameters
;
3325 ms
->state
= MIGRATION_STATUS_NONE
;
3327 ms
->pages_per_second
= -1;
3328 qemu_sem_init(&ms
->pause_sem
, 0);
3329 qemu_mutex_init(&ms
->error_mutex
);
3331 params
->tls_hostname
= g_strdup("");
3332 params
->tls_creds
= g_strdup("");
3334 /* Set has_* up only for parameter checks */
3335 params
->has_compress_level
= true;
3336 params
->has_compress_threads
= true;
3337 params
->has_decompress_threads
= true;
3338 params
->has_cpu_throttle_initial
= true;
3339 params
->has_cpu_throttle_increment
= true;
3340 params
->has_max_bandwidth
= true;
3341 params
->has_downtime_limit
= true;
3342 params
->has_x_checkpoint_delay
= true;
3343 params
->has_block_incremental
= true;
3344 params
->has_x_multifd_channels
= true;
3345 params
->has_x_multifd_page_count
= true;
3346 params
->has_xbzrle_cache_size
= true;
3347 params
->has_max_postcopy_bandwidth
= true;
3348 params
->has_max_cpu_throttle
= true;
3350 qemu_sem_init(&ms
->postcopy_pause_sem
, 0);
3351 qemu_sem_init(&ms
->postcopy_pause_rp_sem
, 0);
3352 qemu_sem_init(&ms
->rp_state
.rp_sem
, 0);
3353 qemu_sem_init(&ms
->rate_limit_sem
, 0);
3354 qemu_mutex_init(&ms
->qemu_file_lock
);
3358 * Return true if check pass, false otherwise. Error will be put
3359 * inside errp if provided.
3361 static bool migration_object_check(MigrationState
*ms
, Error
**errp
)
3363 MigrationCapabilityStatusList
*head
= NULL
;
3364 /* Assuming all off */
3365 bool cap_list
[MIGRATION_CAPABILITY__MAX
] = { 0 }, ret
;
3368 if (!migrate_params_check(&ms
->parameters
, errp
)) {
3372 for (i
= 0; i
< MIGRATION_CAPABILITY__MAX
; i
++) {
3373 if (ms
->enabled_capabilities
[i
]) {
3374 head
= migrate_cap_add(head
, i
, true);
3378 ret
= migrate_caps_check(cap_list
, head
, errp
);
3380 /* It works with head == NULL */
3381 qapi_free_MigrationCapabilityStatusList(head
);
3386 static const TypeInfo migration_type
= {
3387 .name
= TYPE_MIGRATION
,
3389 * NOTE: TYPE_MIGRATION is not really a device, as the object is
3390 * not created using qdev_create(), it is not attached to the qdev
3391 * device tree, and it is never realized.
3393 * TODO: Make this TYPE_OBJECT once QOM provides something like
3394 * TYPE_DEVICE's "-global" properties.
3396 .parent
= TYPE_DEVICE
,
3397 .class_init
= migration_class_init
,
3398 .class_size
= sizeof(MigrationClass
),
3399 .instance_size
= sizeof(MigrationState
),
3400 .instance_init
= migration_instance_init
,
3401 .instance_finalize
= migration_instance_finalize
,
3404 static void register_migration_types(void)
3406 type_register_static(&migration_type
);
3409 type_init(register_migration_types
);