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 "qemu/main-loop.h"
20 #include "migration/blocker.h"
24 #include "sysemu/runstate.h"
25 #include "sysemu/sysemu.h"
28 #include "migration/global_state.h"
29 #include "migration/misc.h"
30 #include "migration.h"
32 #include "qemu-file-channel.h"
33 #include "qemu-file.h"
34 #include "migration/vmstate.h"
35 #include "block/block.h"
36 #include "qapi/error.h"
37 #include "qapi/clone-visitor.h"
38 #include "qapi/qapi-visit-sockets.h"
39 #include "qapi/qapi-commands-migration.h"
40 #include "qapi/qapi-events-migration.h"
41 #include "qapi/qmp/qerror.h"
42 #include "qapi/qmp/qnull.h"
45 #include "postcopy-ram.h"
46 #include "qemu/thread.h"
48 #include "exec/target_page.h"
49 #include "io/channel-buffer.h"
50 #include "migration/colo.h"
51 #include "hw/boards.h"
52 #include "hw/qdev-properties.h"
53 #include "monitor/monitor.h"
54 #include "net/announce.h"
55 #include "qemu/queue.h"
58 #define MAX_THROTTLE (32 << 20) /* Migration transfer speed throttling */
60 /* Amount of time to allocate to each "chunk" of bandwidth-throttled
62 #define BUFFER_DELAY 100
63 #define XFER_LIMIT_RATIO (1000 / BUFFER_DELAY)
65 /* Time in milliseconds we are allowed to stop the source,
66 * for sending the last part */
67 #define DEFAULT_MIGRATE_SET_DOWNTIME 300
69 /* Maximum migrate downtime set to 2000 seconds */
70 #define MAX_MIGRATE_DOWNTIME_SECONDS 2000
71 #define MAX_MIGRATE_DOWNTIME (MAX_MIGRATE_DOWNTIME_SECONDS * 1000)
73 /* Default compression thread count */
74 #define DEFAULT_MIGRATE_COMPRESS_THREAD_COUNT 8
75 /* Default decompression thread count, usually decompression is at
76 * least 4 times as fast as compression.*/
77 #define DEFAULT_MIGRATE_DECOMPRESS_THREAD_COUNT 2
78 /*0: means nocompress, 1: best speed, ... 9: best compress ratio */
79 #define DEFAULT_MIGRATE_COMPRESS_LEVEL 1
80 /* Define default autoconverge cpu throttle migration parameters */
81 #define DEFAULT_MIGRATE_CPU_THROTTLE_INITIAL 20
82 #define DEFAULT_MIGRATE_CPU_THROTTLE_INCREMENT 10
83 #define DEFAULT_MIGRATE_MAX_CPU_THROTTLE 99
85 /* Migration XBZRLE default cache size */
86 #define DEFAULT_MIGRATE_XBZRLE_CACHE_SIZE (64 * 1024 * 1024)
88 /* The delay time (in ms) between two COLO checkpoints */
89 #define DEFAULT_MIGRATE_X_CHECKPOINT_DELAY (200 * 100)
90 #define DEFAULT_MIGRATE_MULTIFD_CHANNELS 2
92 /* Background transfer rate for postcopy, 0 means unlimited, note
93 * that page requests can still exceed this limit.
95 #define DEFAULT_MIGRATE_MAX_POSTCOPY_BANDWIDTH 0
98 * Parameters for self_announce_delay giving a stream of RARP/ARP
99 * packets after migration.
101 #define DEFAULT_MIGRATE_ANNOUNCE_INITIAL 50
102 #define DEFAULT_MIGRATE_ANNOUNCE_MAX 550
103 #define DEFAULT_MIGRATE_ANNOUNCE_ROUNDS 5
104 #define DEFAULT_MIGRATE_ANNOUNCE_STEP 100
106 static NotifierList migration_state_notifiers
=
107 NOTIFIER_LIST_INITIALIZER(migration_state_notifiers
);
109 static bool deferred_incoming
;
111 /* Messages sent on the return path from destination to source */
112 enum mig_rp_message_type
{
113 MIG_RP_MSG_INVALID
= 0, /* Must be 0 */
114 MIG_RP_MSG_SHUT
, /* sibling will not send any more RP messages */
115 MIG_RP_MSG_PONG
, /* Response to a PING; data (seq: be32 ) */
117 MIG_RP_MSG_REQ_PAGES_ID
, /* data (start: be64, len: be32, id: string) */
118 MIG_RP_MSG_REQ_PAGES
, /* data (start: be64, len: be32) */
119 MIG_RP_MSG_RECV_BITMAP
, /* send recved_bitmap back to source */
120 MIG_RP_MSG_RESUME_ACK
, /* tell source that we are ready to resume */
125 /* When we add fault tolerance, we could have several
126 migrations at once. For now we don't need to add
127 dynamic creation of migration */
129 static MigrationState
*current_migration
;
130 static MigrationIncomingState
*current_incoming
;
132 static bool migration_object_check(MigrationState
*ms
, Error
**errp
);
133 static int migration_maybe_pause(MigrationState
*s
,
134 int *current_active_state
,
136 static void migrate_fd_cancel(MigrationState
*s
);
138 void migration_object_init(void)
140 MachineState
*ms
= MACHINE(qdev_get_machine());
143 /* This can only be called once. */
144 assert(!current_migration
);
145 current_migration
= MIGRATION_OBJ(object_new(TYPE_MIGRATION
));
148 * Init the migrate incoming object as well no matter whether
149 * we'll use it or not.
151 assert(!current_incoming
);
152 current_incoming
= g_new0(MigrationIncomingState
, 1);
153 current_incoming
->state
= MIGRATION_STATUS_NONE
;
154 current_incoming
->postcopy_remote_fds
=
155 g_array_new(FALSE
, TRUE
, sizeof(struct PostCopyFD
));
156 qemu_mutex_init(¤t_incoming
->rp_mutex
);
157 qemu_event_init(¤t_incoming
->main_thread_load_event
, false);
158 qemu_sem_init(¤t_incoming
->postcopy_pause_sem_dst
, 0);
159 qemu_sem_init(¤t_incoming
->postcopy_pause_sem_fault
, 0);
161 init_dirty_bitmap_incoming_migration();
163 if (!migration_object_check(current_migration
, &err
)) {
164 error_report_err(err
);
169 * We cannot really do this in migration_instance_init() since at
170 * that time global properties are not yet applied, then this
171 * value will be definitely replaced by something else.
173 if (ms
->enforce_config_section
) {
174 current_migration
->send_configuration
= true;
178 void migration_shutdown(void)
181 * Cancel the current migration - that will (eventually)
182 * stop the migration using this structure
184 migrate_fd_cancel(current_migration
);
185 object_unref(OBJECT(current_migration
));
189 MigrationState
*migrate_get_current(void)
191 /* This can only be called after the object created. */
192 assert(current_migration
);
193 return current_migration
;
196 MigrationIncomingState
*migration_incoming_get_current(void)
198 assert(current_incoming
);
199 return current_incoming
;
202 void migration_incoming_state_destroy(void)
204 struct MigrationIncomingState
*mis
= migration_incoming_get_current();
206 if (mis
->to_src_file
) {
207 /* Tell source that we are done */
208 migrate_send_rp_shut(mis
, qemu_file_get_error(mis
->from_src_file
) != 0);
209 qemu_fclose(mis
->to_src_file
);
210 mis
->to_src_file
= NULL
;
213 if (mis
->from_src_file
) {
214 qemu_fclose(mis
->from_src_file
);
215 mis
->from_src_file
= NULL
;
217 if (mis
->postcopy_remote_fds
) {
218 g_array_free(mis
->postcopy_remote_fds
, TRUE
);
219 mis
->postcopy_remote_fds
= NULL
;
222 qemu_event_reset(&mis
->main_thread_load_event
);
224 if (mis
->socket_address_list
) {
225 qapi_free_SocketAddressList(mis
->socket_address_list
);
226 mis
->socket_address_list
= NULL
;
230 static void migrate_generate_event(int new_state
)
232 if (migrate_use_events()) {
233 qapi_event_send_migration(new_state
);
237 static bool migrate_late_block_activate(void)
241 s
= migrate_get_current();
243 return s
->enabled_capabilities
[
244 MIGRATION_CAPABILITY_LATE_BLOCK_ACTIVATE
];
248 * Called on -incoming with a defer: uri.
249 * The migration can be started later after any parameters have been
252 static void deferred_incoming_migration(Error
**errp
)
254 if (deferred_incoming
) {
255 error_setg(errp
, "Incoming migration already deferred");
257 deferred_incoming
= true;
261 * Send a message on the return channel back to the source
264 static int migrate_send_rp_message(MigrationIncomingState
*mis
,
265 enum mig_rp_message_type message_type
,
266 uint16_t len
, void *data
)
270 trace_migrate_send_rp_message((int)message_type
, len
);
271 qemu_mutex_lock(&mis
->rp_mutex
);
274 * It's possible that the file handle got lost due to network
277 if (!mis
->to_src_file
) {
282 qemu_put_be16(mis
->to_src_file
, (unsigned int)message_type
);
283 qemu_put_be16(mis
->to_src_file
, len
);
284 qemu_put_buffer(mis
->to_src_file
, data
, len
);
285 qemu_fflush(mis
->to_src_file
);
287 /* It's possible that qemu file got error during sending */
288 ret
= qemu_file_get_error(mis
->to_src_file
);
291 qemu_mutex_unlock(&mis
->rp_mutex
);
295 /* Request a range of pages from the source VM at the given
297 * rbname: Name of the RAMBlock to request the page in, if NULL it's the same
298 * as the last request (a name must have been given previously)
299 * Start: Address offset within the RB
300 * Len: Length in bytes required - must be a multiple of pagesize
302 int migrate_send_rp_req_pages(MigrationIncomingState
*mis
, const char *rbname
,
303 ram_addr_t start
, size_t len
)
305 uint8_t bufc
[12 + 1 + 255]; /* start (8), len (4), rbname up to 256 */
306 size_t msglen
= 12; /* start + len */
307 enum mig_rp_message_type msg_type
;
309 *(uint64_t *)bufc
= cpu_to_be64((uint64_t)start
);
310 *(uint32_t *)(bufc
+ 8) = cpu_to_be32((uint32_t)len
);
313 int rbname_len
= strlen(rbname
);
314 assert(rbname_len
< 256);
316 bufc
[msglen
++] = rbname_len
;
317 memcpy(bufc
+ msglen
, rbname
, rbname_len
);
318 msglen
+= rbname_len
;
319 msg_type
= MIG_RP_MSG_REQ_PAGES_ID
;
321 msg_type
= MIG_RP_MSG_REQ_PAGES
;
324 return migrate_send_rp_message(mis
, msg_type
, msglen
, bufc
);
327 static bool migration_colo_enabled
;
328 bool migration_incoming_colo_enabled(void)
330 return migration_colo_enabled
;
333 void migration_incoming_disable_colo(void)
335 migration_colo_enabled
= false;
338 void migration_incoming_enable_colo(void)
340 migration_colo_enabled
= true;
343 void migrate_add_address(SocketAddress
*address
)
345 MigrationIncomingState
*mis
= migration_incoming_get_current();
346 SocketAddressList
*addrs
;
348 addrs
= g_new0(SocketAddressList
, 1);
349 addrs
->next
= mis
->socket_address_list
;
350 mis
->socket_address_list
= addrs
;
351 addrs
->value
= QAPI_CLONE(SocketAddress
, address
);
354 void qemu_start_incoming_migration(const char *uri
, Error
**errp
)
358 qapi_event_send_migration(MIGRATION_STATUS_SETUP
);
359 if (!strcmp(uri
, "defer")) {
360 deferred_incoming_migration(errp
);
361 } else if (strstart(uri
, "tcp:", &p
)) {
362 tcp_start_incoming_migration(p
, errp
);
364 } else if (strstart(uri
, "rdma:", &p
)) {
365 rdma_start_incoming_migration(p
, errp
);
367 } else if (strstart(uri
, "exec:", &p
)) {
368 exec_start_incoming_migration(p
, errp
);
369 } else if (strstart(uri
, "unix:", &p
)) {
370 unix_start_incoming_migration(p
, errp
);
371 } else if (strstart(uri
, "fd:", &p
)) {
372 fd_start_incoming_migration(p
, errp
);
374 error_setg(errp
, "unknown migration protocol: %s", uri
);
378 static void process_incoming_migration_bh(void *opaque
)
380 Error
*local_err
= NULL
;
381 MigrationIncomingState
*mis
= opaque
;
383 /* If capability late_block_activate is set:
384 * Only fire up the block code now if we're going to restart the
385 * VM, else 'cont' will do it.
386 * This causes file locking to happen; so we don't want it to happen
387 * unless we really are starting the VM.
389 if (!migrate_late_block_activate() ||
390 (autostart
&& (!global_state_received() ||
391 global_state_get_runstate() == RUN_STATE_RUNNING
))) {
392 /* Make sure all file formats flush their mutable metadata.
393 * If we get an error here, just don't restart the VM yet. */
394 bdrv_invalidate_cache_all(&local_err
);
396 error_report_err(local_err
);
403 * This must happen after all error conditions are dealt with and
404 * we're sure the VM is going to be running on this host.
406 qemu_announce_self(&mis
->announce_timer
, migrate_announce_params());
408 if (multifd_load_cleanup(&local_err
) != 0) {
409 error_report_err(local_err
);
412 /* If global state section was not received or we are in running
413 state, we need to obey autostart. Any other state is set with
416 dirty_bitmap_mig_before_vm_start();
418 if (!global_state_received() ||
419 global_state_get_runstate() == RUN_STATE_RUNNING
) {
423 runstate_set(RUN_STATE_PAUSED
);
425 } else if (migration_incoming_colo_enabled()) {
426 migration_incoming_disable_colo();
429 runstate_set(global_state_get_runstate());
432 * This must happen after any state changes since as soon as an external
433 * observer sees this event they might start to prod at the VM assuming
436 migrate_set_state(&mis
->state
, MIGRATION_STATUS_ACTIVE
,
437 MIGRATION_STATUS_COMPLETED
);
438 qemu_bh_delete(mis
->bh
);
439 migration_incoming_state_destroy();
442 static void process_incoming_migration_co(void *opaque
)
444 MigrationIncomingState
*mis
= migration_incoming_get_current();
447 Error
*local_err
= NULL
;
449 assert(mis
->from_src_file
);
450 mis
->migration_incoming_co
= qemu_coroutine_self();
451 mis
->largest_page_size
= qemu_ram_pagesize_largest();
452 postcopy_state_set(POSTCOPY_INCOMING_NONE
);
453 migrate_set_state(&mis
->state
, MIGRATION_STATUS_NONE
,
454 MIGRATION_STATUS_ACTIVE
);
455 ret
= qemu_loadvm_state(mis
->from_src_file
);
457 ps
= postcopy_state_get();
458 trace_process_incoming_migration_co_end(ret
, ps
);
459 if (ps
!= POSTCOPY_INCOMING_NONE
) {
460 if (ps
== POSTCOPY_INCOMING_ADVISE
) {
462 * Where a migration had postcopy enabled (and thus went to advise)
463 * but managed to complete within the precopy period, we can use
466 postcopy_ram_incoming_cleanup(mis
);
467 } else if (ret
>= 0) {
469 * Postcopy was started, cleanup should happen at the end of the
472 trace_process_incoming_migration_co_postcopy_end_main();
475 /* Else if something went wrong then just fall out of the normal exit */
478 /* we get COLO info, and know if we are in COLO mode */
479 if (!ret
&& migration_incoming_colo_enabled()) {
480 /* Make sure all file formats flush their mutable metadata */
481 bdrv_invalidate_cache_all(&local_err
);
483 error_report_err(local_err
);
487 if (colo_init_ram_cache() < 0) {
488 error_report("Init ram cache failed");
492 qemu_thread_create(&mis
->colo_incoming_thread
, "COLO incoming",
493 colo_process_incoming_thread
, mis
, QEMU_THREAD_JOINABLE
);
494 mis
->have_colo_incoming_thread
= true;
495 qemu_coroutine_yield();
497 /* Wait checkpoint incoming thread exit before free resource */
498 qemu_thread_join(&mis
->colo_incoming_thread
);
499 /* We hold the global iothread lock, so it is safe here */
500 colo_release_ram_cache();
504 error_report("load of migration failed: %s", strerror(-ret
));
507 mis
->bh
= qemu_bh_new(process_incoming_migration_bh
, mis
);
508 qemu_bh_schedule(mis
->bh
);
509 mis
->migration_incoming_co
= NULL
;
513 migrate_set_state(&mis
->state
, MIGRATION_STATUS_ACTIVE
,
514 MIGRATION_STATUS_FAILED
);
515 qemu_fclose(mis
->from_src_file
);
516 if (multifd_load_cleanup(&local_err
) != 0) {
517 error_report_err(local_err
);
523 * @migration_incoming_setup: Setup incoming migration
525 * Returns 0 for no error or 1 for error
527 * @f: file for main migration channel
528 * @errp: where to put errors
530 static int migration_incoming_setup(QEMUFile
*f
, Error
**errp
)
532 MigrationIncomingState
*mis
= migration_incoming_get_current();
533 Error
*local_err
= NULL
;
535 if (multifd_load_setup(&local_err
) != 0) {
536 /* We haven't been able to create multifd threads
537 nothing better to do */
538 error_report_err(local_err
);
542 if (!mis
->from_src_file
) {
543 mis
->from_src_file
= f
;
545 qemu_file_set_blocking(f
, false);
549 void migration_incoming_process(void)
551 Coroutine
*co
= qemu_coroutine_create(process_incoming_migration_co
, NULL
);
552 qemu_coroutine_enter(co
);
555 /* Returns true if recovered from a paused migration, otherwise false */
556 static bool postcopy_try_recover(QEMUFile
*f
)
558 MigrationIncomingState
*mis
= migration_incoming_get_current();
560 if (mis
->state
== MIGRATION_STATUS_POSTCOPY_PAUSED
) {
561 /* Resumed from a paused postcopy migration */
563 mis
->from_src_file
= f
;
564 /* Postcopy has standalone thread to do vm load */
565 qemu_file_set_blocking(f
, true);
567 /* Re-configure the return path */
568 mis
->to_src_file
= qemu_file_get_return_path(f
);
570 migrate_set_state(&mis
->state
, MIGRATION_STATUS_POSTCOPY_PAUSED
,
571 MIGRATION_STATUS_POSTCOPY_RECOVER
);
574 * Here, we only wake up the main loading thread (while the
575 * fault thread will still be waiting), so that we can receive
576 * commands from source now, and answer it if needed. The
577 * fault thread will be woken up afterwards until we are sure
578 * that source is ready to reply to page requests.
580 qemu_sem_post(&mis
->postcopy_pause_sem_dst
);
587 void migration_fd_process_incoming(QEMUFile
*f
, Error
**errp
)
589 Error
*local_err
= NULL
;
591 if (postcopy_try_recover(f
)) {
595 if (migration_incoming_setup(f
, &local_err
)) {
597 error_propagate(errp
, local_err
);
601 migration_incoming_process();
604 void migration_ioc_process_incoming(QIOChannel
*ioc
, Error
**errp
)
606 MigrationIncomingState
*mis
= migration_incoming_get_current();
607 Error
*local_err
= NULL
;
608 bool start_migration
;
610 if (!mis
->from_src_file
) {
611 /* The first connection (multifd may have multiple) */
612 QEMUFile
*f
= qemu_fopen_channel_input(ioc
);
614 /* If it's a recovery, we're done */
615 if (postcopy_try_recover(f
)) {
619 if (migration_incoming_setup(f
, &local_err
)) {
621 error_propagate(errp
, local_err
);
627 * Common migration only needs one channel, so we can start
628 * right now. Multifd needs more than one channel, we wait.
630 start_migration
= !migrate_use_multifd();
632 /* Multiple connections */
633 assert(migrate_use_multifd());
634 start_migration
= multifd_recv_new_channel(ioc
, &local_err
);
636 error_propagate(errp
, local_err
);
641 if (start_migration
) {
642 migration_incoming_process();
647 * @migration_has_all_channels: We have received all channels that we need
649 * Returns true when we have got connections to all the channels that
650 * we need for migration.
652 bool migration_has_all_channels(void)
654 MigrationIncomingState
*mis
= migration_incoming_get_current();
657 all_channels
= multifd_recv_all_channels_created();
659 return all_channels
&& mis
->from_src_file
!= NULL
;
663 * Send a 'SHUT' message on the return channel with the given value
664 * to indicate that we've finished with the RP. Non-0 value indicates
667 void migrate_send_rp_shut(MigrationIncomingState
*mis
,
672 buf
= cpu_to_be32(value
);
673 migrate_send_rp_message(mis
, MIG_RP_MSG_SHUT
, sizeof(buf
), &buf
);
677 * Send a 'PONG' message on the return channel with the given value
678 * (normally in response to a 'PING')
680 void migrate_send_rp_pong(MigrationIncomingState
*mis
,
685 buf
= cpu_to_be32(value
);
686 migrate_send_rp_message(mis
, MIG_RP_MSG_PONG
, sizeof(buf
), &buf
);
689 void migrate_send_rp_recv_bitmap(MigrationIncomingState
*mis
,
697 * First, we send the header part. It contains only the len of
698 * idstr, and the idstr itself.
700 len
= strlen(block_name
);
702 memcpy(buf
+ 1, block_name
, len
);
704 if (mis
->state
!= MIGRATION_STATUS_POSTCOPY_RECOVER
) {
705 error_report("%s: MSG_RP_RECV_BITMAP only used for recovery",
710 migrate_send_rp_message(mis
, MIG_RP_MSG_RECV_BITMAP
, len
+ 1, buf
);
713 * Next, we dump the received bitmap to the stream.
715 * TODO: currently we are safe since we are the only one that is
716 * using the to_src_file handle (fault thread is still paused),
717 * and it's ok even not taking the mutex. However the best way is
718 * to take the lock before sending the message header, and release
719 * the lock after sending the bitmap.
721 qemu_mutex_lock(&mis
->rp_mutex
);
722 res
= ramblock_recv_bitmap_send(mis
->to_src_file
, block_name
);
723 qemu_mutex_unlock(&mis
->rp_mutex
);
725 trace_migrate_send_rp_recv_bitmap(block_name
, res
);
728 void migrate_send_rp_resume_ack(MigrationIncomingState
*mis
, uint32_t value
)
732 buf
= cpu_to_be32(value
);
733 migrate_send_rp_message(mis
, MIG_RP_MSG_RESUME_ACK
, sizeof(buf
), &buf
);
736 MigrationCapabilityStatusList
*qmp_query_migrate_capabilities(Error
**errp
)
738 MigrationCapabilityStatusList
*head
= NULL
;
739 MigrationCapabilityStatusList
*caps
;
740 MigrationState
*s
= migrate_get_current();
743 caps
= NULL
; /* silence compiler warning */
744 for (i
= 0; i
< MIGRATION_CAPABILITY__MAX
; i
++) {
745 #ifndef CONFIG_LIVE_BLOCK_MIGRATION
746 if (i
== MIGRATION_CAPABILITY_BLOCK
) {
751 head
= g_malloc0(sizeof(*caps
));
754 caps
->next
= g_malloc0(sizeof(*caps
));
758 g_malloc(sizeof(*caps
->value
));
759 caps
->value
->capability
= i
;
760 caps
->value
->state
= s
->enabled_capabilities
[i
];
766 MigrationParameters
*qmp_query_migrate_parameters(Error
**errp
)
768 MigrationParameters
*params
;
769 MigrationState
*s
= migrate_get_current();
771 /* TODO use QAPI_CLONE() instead of duplicating it inline */
772 params
= g_malloc0(sizeof(*params
));
773 params
->has_compress_level
= true;
774 params
->compress_level
= s
->parameters
.compress_level
;
775 params
->has_compress_threads
= true;
776 params
->compress_threads
= s
->parameters
.compress_threads
;
777 params
->has_compress_wait_thread
= true;
778 params
->compress_wait_thread
= s
->parameters
.compress_wait_thread
;
779 params
->has_decompress_threads
= true;
780 params
->decompress_threads
= s
->parameters
.decompress_threads
;
781 params
->has_cpu_throttle_initial
= true;
782 params
->cpu_throttle_initial
= s
->parameters
.cpu_throttle_initial
;
783 params
->has_cpu_throttle_increment
= true;
784 params
->cpu_throttle_increment
= s
->parameters
.cpu_throttle_increment
;
785 params
->has_tls_creds
= true;
786 params
->tls_creds
= g_strdup(s
->parameters
.tls_creds
);
787 params
->has_tls_hostname
= true;
788 params
->tls_hostname
= g_strdup(s
->parameters
.tls_hostname
);
789 params
->has_tls_authz
= true;
790 params
->tls_authz
= g_strdup(s
->parameters
.tls_authz
);
791 params
->has_max_bandwidth
= true;
792 params
->max_bandwidth
= s
->parameters
.max_bandwidth
;
793 params
->has_downtime_limit
= true;
794 params
->downtime_limit
= s
->parameters
.downtime_limit
;
795 params
->has_x_checkpoint_delay
= true;
796 params
->x_checkpoint_delay
= s
->parameters
.x_checkpoint_delay
;
797 params
->has_block_incremental
= true;
798 params
->block_incremental
= s
->parameters
.block_incremental
;
799 params
->has_multifd_channels
= true;
800 params
->multifd_channels
= s
->parameters
.multifd_channels
;
801 params
->has_xbzrle_cache_size
= true;
802 params
->xbzrle_cache_size
= s
->parameters
.xbzrle_cache_size
;
803 params
->has_max_postcopy_bandwidth
= true;
804 params
->max_postcopy_bandwidth
= s
->parameters
.max_postcopy_bandwidth
;
805 params
->has_max_cpu_throttle
= true;
806 params
->max_cpu_throttle
= s
->parameters
.max_cpu_throttle
;
807 params
->has_announce_initial
= true;
808 params
->announce_initial
= s
->parameters
.announce_initial
;
809 params
->has_announce_max
= true;
810 params
->announce_max
= s
->parameters
.announce_max
;
811 params
->has_announce_rounds
= true;
812 params
->announce_rounds
= s
->parameters
.announce_rounds
;
813 params
->has_announce_step
= true;
814 params
->announce_step
= s
->parameters
.announce_step
;
819 AnnounceParameters
*migrate_announce_params(void)
821 static AnnounceParameters ap
;
823 MigrationState
*s
= migrate_get_current();
825 ap
.initial
= s
->parameters
.announce_initial
;
826 ap
.max
= s
->parameters
.announce_max
;
827 ap
.rounds
= s
->parameters
.announce_rounds
;
828 ap
.step
= s
->parameters
.announce_step
;
834 * Return true if we're already in the middle of a migration
835 * (i.e. any of the active or setup states)
837 bool migration_is_setup_or_active(int state
)
840 case MIGRATION_STATUS_ACTIVE
:
841 case MIGRATION_STATUS_POSTCOPY_ACTIVE
:
842 case MIGRATION_STATUS_POSTCOPY_PAUSED
:
843 case MIGRATION_STATUS_POSTCOPY_RECOVER
:
844 case MIGRATION_STATUS_SETUP
:
845 case MIGRATION_STATUS_PRE_SWITCHOVER
:
846 case MIGRATION_STATUS_DEVICE
:
847 case MIGRATION_STATUS_WAIT_UNPLUG
:
856 bool migration_is_running(int state
)
859 case MIGRATION_STATUS_ACTIVE
:
860 case MIGRATION_STATUS_POSTCOPY_ACTIVE
:
861 case MIGRATION_STATUS_POSTCOPY_PAUSED
:
862 case MIGRATION_STATUS_POSTCOPY_RECOVER
:
863 case MIGRATION_STATUS_SETUP
:
864 case MIGRATION_STATUS_PRE_SWITCHOVER
:
865 case MIGRATION_STATUS_DEVICE
:
866 case MIGRATION_STATUS_WAIT_UNPLUG
:
867 case MIGRATION_STATUS_CANCELLING
:
868 case MIGRATION_STATUS_COLO
:
877 static void populate_time_info(MigrationInfo
*info
, MigrationState
*s
)
879 info
->has_status
= true;
880 info
->has_setup_time
= true;
881 info
->setup_time
= s
->setup_time
;
882 if (s
->state
== MIGRATION_STATUS_COMPLETED
) {
883 info
->has_total_time
= true;
884 info
->total_time
= s
->total_time
;
885 info
->has_downtime
= true;
886 info
->downtime
= s
->downtime
;
888 info
->has_total_time
= true;
889 info
->total_time
= qemu_clock_get_ms(QEMU_CLOCK_REALTIME
) -
891 info
->has_expected_downtime
= true;
892 info
->expected_downtime
= s
->expected_downtime
;
896 static void populate_ram_info(MigrationInfo
*info
, MigrationState
*s
)
898 info
->has_ram
= true;
899 info
->ram
= g_malloc0(sizeof(*info
->ram
));
900 info
->ram
->transferred
= ram_counters
.transferred
;
901 info
->ram
->total
= ram_bytes_total();
902 info
->ram
->duplicate
= ram_counters
.duplicate
;
903 /* legacy value. It is not used anymore */
904 info
->ram
->skipped
= 0;
905 info
->ram
->normal
= ram_counters
.normal
;
906 info
->ram
->normal_bytes
= ram_counters
.normal
*
907 qemu_target_page_size();
908 info
->ram
->mbps
= s
->mbps
;
909 info
->ram
->dirty_sync_count
= ram_counters
.dirty_sync_count
;
910 info
->ram
->postcopy_requests
= ram_counters
.postcopy_requests
;
911 info
->ram
->page_size
= qemu_target_page_size();
912 info
->ram
->multifd_bytes
= ram_counters
.multifd_bytes
;
913 info
->ram
->pages_per_second
= s
->pages_per_second
;
915 if (migrate_use_xbzrle()) {
916 info
->has_xbzrle_cache
= true;
917 info
->xbzrle_cache
= g_malloc0(sizeof(*info
->xbzrle_cache
));
918 info
->xbzrle_cache
->cache_size
= migrate_xbzrle_cache_size();
919 info
->xbzrle_cache
->bytes
= xbzrle_counters
.bytes
;
920 info
->xbzrle_cache
->pages
= xbzrle_counters
.pages
;
921 info
->xbzrle_cache
->cache_miss
= xbzrle_counters
.cache_miss
;
922 info
->xbzrle_cache
->cache_miss_rate
= xbzrle_counters
.cache_miss_rate
;
923 info
->xbzrle_cache
->overflow
= xbzrle_counters
.overflow
;
926 if (migrate_use_compression()) {
927 info
->has_compression
= true;
928 info
->compression
= g_malloc0(sizeof(*info
->compression
));
929 info
->compression
->pages
= compression_counters
.pages
;
930 info
->compression
->busy
= compression_counters
.busy
;
931 info
->compression
->busy_rate
= compression_counters
.busy_rate
;
932 info
->compression
->compressed_size
=
933 compression_counters
.compressed_size
;
934 info
->compression
->compression_rate
=
935 compression_counters
.compression_rate
;
938 if (cpu_throttle_active()) {
939 info
->has_cpu_throttle_percentage
= true;
940 info
->cpu_throttle_percentage
= cpu_throttle_get_percentage();
943 if (s
->state
!= MIGRATION_STATUS_COMPLETED
) {
944 info
->ram
->remaining
= ram_bytes_remaining();
945 info
->ram
->dirty_pages_rate
= ram_counters
.dirty_pages_rate
;
949 static void populate_disk_info(MigrationInfo
*info
)
951 if (blk_mig_active()) {
952 info
->has_disk
= true;
953 info
->disk
= g_malloc0(sizeof(*info
->disk
));
954 info
->disk
->transferred
= blk_mig_bytes_transferred();
955 info
->disk
->remaining
= blk_mig_bytes_remaining();
956 info
->disk
->total
= blk_mig_bytes_total();
960 static void fill_source_migration_info(MigrationInfo
*info
)
962 MigrationState
*s
= migrate_get_current();
965 case MIGRATION_STATUS_NONE
:
966 /* no migration has happened ever */
967 /* do not overwrite destination migration status */
970 case MIGRATION_STATUS_SETUP
:
971 info
->has_status
= true;
972 info
->has_total_time
= false;
974 case MIGRATION_STATUS_ACTIVE
:
975 case MIGRATION_STATUS_CANCELLING
:
976 case MIGRATION_STATUS_POSTCOPY_ACTIVE
:
977 case MIGRATION_STATUS_PRE_SWITCHOVER
:
978 case MIGRATION_STATUS_DEVICE
:
979 case MIGRATION_STATUS_POSTCOPY_PAUSED
:
980 case MIGRATION_STATUS_POSTCOPY_RECOVER
:
981 /* TODO add some postcopy stats */
982 populate_time_info(info
, s
);
983 populate_ram_info(info
, s
);
984 populate_disk_info(info
);
986 case MIGRATION_STATUS_COLO
:
987 info
->has_status
= true;
988 /* TODO: display COLO specific information (checkpoint info etc.) */
990 case MIGRATION_STATUS_COMPLETED
:
991 populate_time_info(info
, s
);
992 populate_ram_info(info
, s
);
994 case MIGRATION_STATUS_FAILED
:
995 info
->has_status
= true;
997 info
->has_error_desc
= true;
998 info
->error_desc
= g_strdup(error_get_pretty(s
->error
));
1001 case MIGRATION_STATUS_CANCELLED
:
1002 info
->has_status
= true;
1004 case MIGRATION_STATUS_WAIT_UNPLUG
:
1005 info
->has_status
= true;
1008 info
->status
= s
->state
;
1012 * @migration_caps_check - check capability validity
1014 * @cap_list: old capability list, array of bool
1015 * @params: new capabilities to be applied soon
1016 * @errp: set *errp if the check failed, with reason
1018 * Returns true if check passed, otherwise false.
1020 static bool migrate_caps_check(bool *cap_list
,
1021 MigrationCapabilityStatusList
*params
,
1024 MigrationCapabilityStatusList
*cap
;
1025 bool old_postcopy_cap
;
1026 MigrationIncomingState
*mis
= migration_incoming_get_current();
1028 old_postcopy_cap
= cap_list
[MIGRATION_CAPABILITY_POSTCOPY_RAM
];
1030 for (cap
= params
; cap
; cap
= cap
->next
) {
1031 cap_list
[cap
->value
->capability
] = cap
->value
->state
;
1034 #ifndef CONFIG_LIVE_BLOCK_MIGRATION
1035 if (cap_list
[MIGRATION_CAPABILITY_BLOCK
]) {
1036 error_setg(errp
, "QEMU compiled without old-style (blk/-b, inc/-i) "
1038 error_append_hint(errp
, "Use drive_mirror+NBD instead.\n");
1043 #ifndef CONFIG_REPLICATION
1044 if (cap_list
[MIGRATION_CAPABILITY_X_COLO
]) {
1045 error_setg(errp
, "QEMU compiled without replication module"
1046 " can't enable COLO");
1047 error_append_hint(errp
, "Please enable replication before COLO.\n");
1052 if (cap_list
[MIGRATION_CAPABILITY_POSTCOPY_RAM
]) {
1053 /* This check is reasonably expensive, so only when it's being
1054 * set the first time, also it's only the destination that needs
1057 if (!old_postcopy_cap
&& runstate_check(RUN_STATE_INMIGRATE
) &&
1058 !postcopy_ram_supported_by_host(mis
)) {
1059 /* postcopy_ram_supported_by_host will have emitted a more
1062 error_setg(errp
, "Postcopy is not supported");
1066 if (cap_list
[MIGRATION_CAPABILITY_X_IGNORE_SHARED
]) {
1067 error_setg(errp
, "Postcopy is not compatible with ignore-shared");
1075 static void fill_destination_migration_info(MigrationInfo
*info
)
1077 MigrationIncomingState
*mis
= migration_incoming_get_current();
1079 if (mis
->socket_address_list
) {
1080 info
->has_socket_address
= true;
1081 info
->socket_address
=
1082 QAPI_CLONE(SocketAddressList
, mis
->socket_address_list
);
1085 switch (mis
->state
) {
1086 case MIGRATION_STATUS_NONE
:
1089 case MIGRATION_STATUS_SETUP
:
1090 case MIGRATION_STATUS_CANCELLING
:
1091 case MIGRATION_STATUS_CANCELLED
:
1092 case MIGRATION_STATUS_ACTIVE
:
1093 case MIGRATION_STATUS_POSTCOPY_ACTIVE
:
1094 case MIGRATION_STATUS_POSTCOPY_PAUSED
:
1095 case MIGRATION_STATUS_POSTCOPY_RECOVER
:
1096 case MIGRATION_STATUS_FAILED
:
1097 case MIGRATION_STATUS_COLO
:
1098 info
->has_status
= true;
1100 case MIGRATION_STATUS_COMPLETED
:
1101 info
->has_status
= true;
1102 fill_destination_postcopy_migration_info(info
);
1105 info
->status
= mis
->state
;
1108 MigrationInfo
*qmp_query_migrate(Error
**errp
)
1110 MigrationInfo
*info
= g_malloc0(sizeof(*info
));
1112 fill_destination_migration_info(info
);
1113 fill_source_migration_info(info
);
1118 void qmp_migrate_set_capabilities(MigrationCapabilityStatusList
*params
,
1121 MigrationState
*s
= migrate_get_current();
1122 MigrationCapabilityStatusList
*cap
;
1123 bool cap_list
[MIGRATION_CAPABILITY__MAX
];
1125 if (migration_is_running(s
->state
)) {
1126 error_setg(errp
, QERR_MIGRATION_ACTIVE
);
1130 memcpy(cap_list
, s
->enabled_capabilities
, sizeof(cap_list
));
1131 if (!migrate_caps_check(cap_list
, params
, errp
)) {
1135 for (cap
= params
; cap
; cap
= cap
->next
) {
1136 s
->enabled_capabilities
[cap
->value
->capability
] = cap
->value
->state
;
1141 * Check whether the parameters are valid. Error will be put into errp
1142 * (if provided). Return true if valid, otherwise false.
1144 static bool migrate_params_check(MigrationParameters
*params
, Error
**errp
)
1146 if (params
->has_compress_level
&&
1147 (params
->compress_level
> 9)) {
1148 error_setg(errp
, QERR_INVALID_PARAMETER_VALUE
, "compress_level",
1149 "is invalid, it should be in the range of 0 to 9");
1153 if (params
->has_compress_threads
&& (params
->compress_threads
< 1)) {
1154 error_setg(errp
, QERR_INVALID_PARAMETER_VALUE
,
1156 "is invalid, it should be in the range of 1 to 255");
1160 if (params
->has_decompress_threads
&& (params
->decompress_threads
< 1)) {
1161 error_setg(errp
, QERR_INVALID_PARAMETER_VALUE
,
1162 "decompress_threads",
1163 "is invalid, it should be in the range of 1 to 255");
1167 if (params
->has_cpu_throttle_initial
&&
1168 (params
->cpu_throttle_initial
< 1 ||
1169 params
->cpu_throttle_initial
> 99)) {
1170 error_setg(errp
, QERR_INVALID_PARAMETER_VALUE
,
1171 "cpu_throttle_initial",
1172 "an integer in the range of 1 to 99");
1176 if (params
->has_cpu_throttle_increment
&&
1177 (params
->cpu_throttle_increment
< 1 ||
1178 params
->cpu_throttle_increment
> 99)) {
1179 error_setg(errp
, QERR_INVALID_PARAMETER_VALUE
,
1180 "cpu_throttle_increment",
1181 "an integer in the range of 1 to 99");
1185 if (params
->has_max_bandwidth
&& (params
->max_bandwidth
> SIZE_MAX
)) {
1186 error_setg(errp
, "Parameter 'max_bandwidth' expects an integer in the"
1187 " range of 0 to %zu bytes/second", SIZE_MAX
);
1191 if (params
->has_downtime_limit
&&
1192 (params
->downtime_limit
> MAX_MIGRATE_DOWNTIME
)) {
1193 error_setg(errp
, "Parameter 'downtime_limit' expects an integer in "
1194 "the range of 0 to %d milliseconds",
1195 MAX_MIGRATE_DOWNTIME
);
1199 /* x_checkpoint_delay is now always positive */
1201 if (params
->has_multifd_channels
&& (params
->multifd_channels
< 1)) {
1202 error_setg(errp
, QERR_INVALID_PARAMETER_VALUE
,
1204 "is invalid, it should be in the range of 1 to 255");
1208 if (params
->has_xbzrle_cache_size
&&
1209 (params
->xbzrle_cache_size
< qemu_target_page_size() ||
1210 !is_power_of_2(params
->xbzrle_cache_size
))) {
1211 error_setg(errp
, QERR_INVALID_PARAMETER_VALUE
,
1212 "xbzrle_cache_size",
1213 "is invalid, it should be bigger than target page size"
1214 " and a power of two");
1218 if (params
->has_max_cpu_throttle
&&
1219 (params
->max_cpu_throttle
< params
->cpu_throttle_initial
||
1220 params
->max_cpu_throttle
> 99)) {
1221 error_setg(errp
, QERR_INVALID_PARAMETER_VALUE
,
1223 "an integer in the range of cpu_throttle_initial to 99");
1227 if (params
->has_announce_initial
&&
1228 params
->announce_initial
> 100000) {
1229 error_setg(errp
, QERR_INVALID_PARAMETER_VALUE
,
1231 "is invalid, it must be less than 100000 ms");
1234 if (params
->has_announce_max
&&
1235 params
->announce_max
> 100000) {
1236 error_setg(errp
, QERR_INVALID_PARAMETER_VALUE
,
1238 "is invalid, it must be less than 100000 ms");
1241 if (params
->has_announce_rounds
&&
1242 params
->announce_rounds
> 1000) {
1243 error_setg(errp
, QERR_INVALID_PARAMETER_VALUE
,
1245 "is invalid, it must be in the range of 0 to 1000");
1248 if (params
->has_announce_step
&&
1249 (params
->announce_step
< 1 ||
1250 params
->announce_step
> 10000)) {
1251 error_setg(errp
, QERR_INVALID_PARAMETER_VALUE
,
1253 "is invalid, it must be in the range of 1 to 10000 ms");
1259 static void migrate_params_test_apply(MigrateSetParameters
*params
,
1260 MigrationParameters
*dest
)
1262 *dest
= migrate_get_current()->parameters
;
1264 /* TODO use QAPI_CLONE() instead of duplicating it inline */
1266 if (params
->has_compress_level
) {
1267 dest
->compress_level
= params
->compress_level
;
1270 if (params
->has_compress_threads
) {
1271 dest
->compress_threads
= params
->compress_threads
;
1274 if (params
->has_compress_wait_thread
) {
1275 dest
->compress_wait_thread
= params
->compress_wait_thread
;
1278 if (params
->has_decompress_threads
) {
1279 dest
->decompress_threads
= params
->decompress_threads
;
1282 if (params
->has_cpu_throttle_initial
) {
1283 dest
->cpu_throttle_initial
= params
->cpu_throttle_initial
;
1286 if (params
->has_cpu_throttle_increment
) {
1287 dest
->cpu_throttle_increment
= params
->cpu_throttle_increment
;
1290 if (params
->has_tls_creds
) {
1291 assert(params
->tls_creds
->type
== QTYPE_QSTRING
);
1292 dest
->tls_creds
= g_strdup(params
->tls_creds
->u
.s
);
1295 if (params
->has_tls_hostname
) {
1296 assert(params
->tls_hostname
->type
== QTYPE_QSTRING
);
1297 dest
->tls_hostname
= g_strdup(params
->tls_hostname
->u
.s
);
1300 if (params
->has_max_bandwidth
) {
1301 dest
->max_bandwidth
= params
->max_bandwidth
;
1304 if (params
->has_downtime_limit
) {
1305 dest
->downtime_limit
= params
->downtime_limit
;
1308 if (params
->has_x_checkpoint_delay
) {
1309 dest
->x_checkpoint_delay
= params
->x_checkpoint_delay
;
1312 if (params
->has_block_incremental
) {
1313 dest
->block_incremental
= params
->block_incremental
;
1315 if (params
->has_multifd_channels
) {
1316 dest
->multifd_channels
= params
->multifd_channels
;
1318 if (params
->has_xbzrle_cache_size
) {
1319 dest
->xbzrle_cache_size
= params
->xbzrle_cache_size
;
1321 if (params
->has_max_postcopy_bandwidth
) {
1322 dest
->max_postcopy_bandwidth
= params
->max_postcopy_bandwidth
;
1324 if (params
->has_max_cpu_throttle
) {
1325 dest
->max_cpu_throttle
= params
->max_cpu_throttle
;
1327 if (params
->has_announce_initial
) {
1328 dest
->announce_initial
= params
->announce_initial
;
1330 if (params
->has_announce_max
) {
1331 dest
->announce_max
= params
->announce_max
;
1333 if (params
->has_announce_rounds
) {
1334 dest
->announce_rounds
= params
->announce_rounds
;
1336 if (params
->has_announce_step
) {
1337 dest
->announce_step
= params
->announce_step
;
1341 static void migrate_params_apply(MigrateSetParameters
*params
, Error
**errp
)
1343 MigrationState
*s
= migrate_get_current();
1345 /* TODO use QAPI_CLONE() instead of duplicating it inline */
1347 if (params
->has_compress_level
) {
1348 s
->parameters
.compress_level
= params
->compress_level
;
1351 if (params
->has_compress_threads
) {
1352 s
->parameters
.compress_threads
= params
->compress_threads
;
1355 if (params
->has_compress_wait_thread
) {
1356 s
->parameters
.compress_wait_thread
= params
->compress_wait_thread
;
1359 if (params
->has_decompress_threads
) {
1360 s
->parameters
.decompress_threads
= params
->decompress_threads
;
1363 if (params
->has_cpu_throttle_initial
) {
1364 s
->parameters
.cpu_throttle_initial
= params
->cpu_throttle_initial
;
1367 if (params
->has_cpu_throttle_increment
) {
1368 s
->parameters
.cpu_throttle_increment
= params
->cpu_throttle_increment
;
1371 if (params
->has_tls_creds
) {
1372 g_free(s
->parameters
.tls_creds
);
1373 assert(params
->tls_creds
->type
== QTYPE_QSTRING
);
1374 s
->parameters
.tls_creds
= g_strdup(params
->tls_creds
->u
.s
);
1377 if (params
->has_tls_hostname
) {
1378 g_free(s
->parameters
.tls_hostname
);
1379 assert(params
->tls_hostname
->type
== QTYPE_QSTRING
);
1380 s
->parameters
.tls_hostname
= g_strdup(params
->tls_hostname
->u
.s
);
1383 if (params
->has_tls_authz
) {
1384 g_free(s
->parameters
.tls_authz
);
1385 assert(params
->tls_authz
->type
== QTYPE_QSTRING
);
1386 s
->parameters
.tls_authz
= g_strdup(params
->tls_authz
->u
.s
);
1389 if (params
->has_max_bandwidth
) {
1390 s
->parameters
.max_bandwidth
= params
->max_bandwidth
;
1391 if (s
->to_dst_file
&& !migration_in_postcopy()) {
1392 qemu_file_set_rate_limit(s
->to_dst_file
,
1393 s
->parameters
.max_bandwidth
/ XFER_LIMIT_RATIO
);
1397 if (params
->has_downtime_limit
) {
1398 s
->parameters
.downtime_limit
= params
->downtime_limit
;
1401 if (params
->has_x_checkpoint_delay
) {
1402 s
->parameters
.x_checkpoint_delay
= params
->x_checkpoint_delay
;
1403 if (migration_in_colo_state()) {
1404 colo_checkpoint_notify(s
);
1408 if (params
->has_block_incremental
) {
1409 s
->parameters
.block_incremental
= params
->block_incremental
;
1411 if (params
->has_multifd_channels
) {
1412 s
->parameters
.multifd_channels
= params
->multifd_channels
;
1414 if (params
->has_xbzrle_cache_size
) {
1415 s
->parameters
.xbzrle_cache_size
= params
->xbzrle_cache_size
;
1416 xbzrle_cache_resize(params
->xbzrle_cache_size
, errp
);
1418 if (params
->has_max_postcopy_bandwidth
) {
1419 s
->parameters
.max_postcopy_bandwidth
= params
->max_postcopy_bandwidth
;
1420 if (s
->to_dst_file
&& migration_in_postcopy()) {
1421 qemu_file_set_rate_limit(s
->to_dst_file
,
1422 s
->parameters
.max_postcopy_bandwidth
/ XFER_LIMIT_RATIO
);
1425 if (params
->has_max_cpu_throttle
) {
1426 s
->parameters
.max_cpu_throttle
= params
->max_cpu_throttle
;
1428 if (params
->has_announce_initial
) {
1429 s
->parameters
.announce_initial
= params
->announce_initial
;
1431 if (params
->has_announce_max
) {
1432 s
->parameters
.announce_max
= params
->announce_max
;
1434 if (params
->has_announce_rounds
) {
1435 s
->parameters
.announce_rounds
= params
->announce_rounds
;
1437 if (params
->has_announce_step
) {
1438 s
->parameters
.announce_step
= params
->announce_step
;
1442 void qmp_migrate_set_parameters(MigrateSetParameters
*params
, Error
**errp
)
1444 MigrationParameters tmp
;
1446 /* TODO Rewrite "" to null instead */
1447 if (params
->has_tls_creds
1448 && params
->tls_creds
->type
== QTYPE_QNULL
) {
1449 qobject_unref(params
->tls_creds
->u
.n
);
1450 params
->tls_creds
->type
= QTYPE_QSTRING
;
1451 params
->tls_creds
->u
.s
= strdup("");
1453 /* TODO Rewrite "" to null instead */
1454 if (params
->has_tls_hostname
1455 && params
->tls_hostname
->type
== QTYPE_QNULL
) {
1456 qobject_unref(params
->tls_hostname
->u
.n
);
1457 params
->tls_hostname
->type
= QTYPE_QSTRING
;
1458 params
->tls_hostname
->u
.s
= strdup("");
1461 migrate_params_test_apply(params
, &tmp
);
1463 if (!migrate_params_check(&tmp
, errp
)) {
1464 /* Invalid parameter */
1468 migrate_params_apply(params
, errp
);
1472 void qmp_migrate_start_postcopy(Error
**errp
)
1474 MigrationState
*s
= migrate_get_current();
1476 if (!migrate_postcopy()) {
1477 error_setg(errp
, "Enable postcopy with migrate_set_capability before"
1478 " the start of migration");
1482 if (s
->state
== MIGRATION_STATUS_NONE
) {
1483 error_setg(errp
, "Postcopy must be started after migration has been"
1488 * we don't error if migration has finished since that would be racy
1489 * with issuing this command.
1491 atomic_set(&s
->start_postcopy
, true);
1494 /* shared migration helpers */
1496 void migrate_set_state(int *state
, int old_state
, int new_state
)
1498 assert(new_state
< MIGRATION_STATUS__MAX
);
1499 if (atomic_cmpxchg(state
, old_state
, new_state
) == old_state
) {
1500 trace_migrate_set_state(MigrationStatus_str(new_state
));
1501 migrate_generate_event(new_state
);
1505 static MigrationCapabilityStatusList
*migrate_cap_add(
1506 MigrationCapabilityStatusList
*list
,
1507 MigrationCapability index
,
1510 MigrationCapabilityStatusList
*cap
;
1512 cap
= g_new0(MigrationCapabilityStatusList
, 1);
1513 cap
->value
= g_new0(MigrationCapabilityStatus
, 1);
1514 cap
->value
->capability
= index
;
1515 cap
->value
->state
= state
;
1521 void migrate_set_block_enabled(bool value
, Error
**errp
)
1523 MigrationCapabilityStatusList
*cap
;
1525 cap
= migrate_cap_add(NULL
, MIGRATION_CAPABILITY_BLOCK
, value
);
1526 qmp_migrate_set_capabilities(cap
, errp
);
1527 qapi_free_MigrationCapabilityStatusList(cap
);
1530 static void migrate_set_block_incremental(MigrationState
*s
, bool value
)
1532 s
->parameters
.block_incremental
= value
;
1535 static void block_cleanup_parameters(MigrationState
*s
)
1537 if (s
->must_remove_block_options
) {
1538 /* setting to false can never fail */
1539 migrate_set_block_enabled(false, &error_abort
);
1540 migrate_set_block_incremental(s
, false);
1541 s
->must_remove_block_options
= false;
1545 static void migrate_fd_cleanup(MigrationState
*s
)
1547 qemu_bh_delete(s
->cleanup_bh
);
1548 s
->cleanup_bh
= NULL
;
1550 qemu_savevm_state_cleanup();
1552 if (s
->to_dst_file
) {
1555 trace_migrate_fd_cleanup();
1556 qemu_mutex_unlock_iothread();
1557 if (s
->migration_thread_running
) {
1558 qemu_thread_join(&s
->thread
);
1559 s
->migration_thread_running
= false;
1561 qemu_mutex_lock_iothread();
1563 multifd_save_cleanup();
1564 qemu_mutex_lock(&s
->qemu_file_lock
);
1565 tmp
= s
->to_dst_file
;
1566 s
->to_dst_file
= NULL
;
1567 qemu_mutex_unlock(&s
->qemu_file_lock
);
1569 * Close the file handle without the lock to make sure the
1570 * critical section won't block for long.
1575 assert(!migration_is_active(s
));
1577 if (s
->state
== MIGRATION_STATUS_CANCELLING
) {
1578 migrate_set_state(&s
->state
, MIGRATION_STATUS_CANCELLING
,
1579 MIGRATION_STATUS_CANCELLED
);
1583 /* It is used on info migrate. We can't free it */
1584 error_report_err(error_copy(s
->error
));
1586 notifier_list_notify(&migration_state_notifiers
, s
);
1587 block_cleanup_parameters(s
);
1590 static void migrate_fd_cleanup_schedule(MigrationState
*s
)
1593 * Ref the state for bh, because it may be called when
1594 * there're already no other refs
1596 object_ref(OBJECT(s
));
1597 qemu_bh_schedule(s
->cleanup_bh
);
1600 static void migrate_fd_cleanup_bh(void *opaque
)
1602 MigrationState
*s
= opaque
;
1603 migrate_fd_cleanup(s
);
1604 object_unref(OBJECT(s
));
1607 void migrate_set_error(MigrationState
*s
, const Error
*error
)
1609 qemu_mutex_lock(&s
->error_mutex
);
1611 s
->error
= error_copy(error
);
1613 qemu_mutex_unlock(&s
->error_mutex
);
1616 void migrate_fd_error(MigrationState
*s
, const Error
*error
)
1618 trace_migrate_fd_error(error_get_pretty(error
));
1619 assert(s
->to_dst_file
== NULL
);
1620 migrate_set_state(&s
->state
, MIGRATION_STATUS_SETUP
,
1621 MIGRATION_STATUS_FAILED
);
1622 migrate_set_error(s
, error
);
1625 static void migrate_fd_cancel(MigrationState
*s
)
1628 QEMUFile
*f
= migrate_get_current()->to_dst_file
;
1629 trace_migrate_fd_cancel();
1631 if (s
->rp_state
.from_dst_file
) {
1632 /* shutdown the rp socket, so causing the rp thread to shutdown */
1633 qemu_file_shutdown(s
->rp_state
.from_dst_file
);
1637 old_state
= s
->state
;
1638 if (!migration_is_running(old_state
)) {
1641 /* If the migration is paused, kick it out of the pause */
1642 if (old_state
== MIGRATION_STATUS_PRE_SWITCHOVER
) {
1643 qemu_sem_post(&s
->pause_sem
);
1645 migrate_set_state(&s
->state
, old_state
, MIGRATION_STATUS_CANCELLING
);
1646 } while (s
->state
!= MIGRATION_STATUS_CANCELLING
);
1649 * If we're unlucky the migration code might be stuck somewhere in a
1650 * send/write while the network has failed and is waiting to timeout;
1651 * if we've got shutdown(2) available then we can force it to quit.
1652 * The outgoing qemu file gets closed in migrate_fd_cleanup that is
1653 * called in a bh, so there is no race against this cancel.
1655 if (s
->state
== MIGRATION_STATUS_CANCELLING
&& f
) {
1656 qemu_file_shutdown(f
);
1658 if (s
->state
== MIGRATION_STATUS_CANCELLING
&& s
->block_inactive
) {
1659 Error
*local_err
= NULL
;
1661 bdrv_invalidate_cache_all(&local_err
);
1663 error_report_err(local_err
);
1665 s
->block_inactive
= false;
1670 void add_migration_state_change_notifier(Notifier
*notify
)
1672 notifier_list_add(&migration_state_notifiers
, notify
);
1675 void remove_migration_state_change_notifier(Notifier
*notify
)
1677 notifier_remove(notify
);
1680 bool migration_in_setup(MigrationState
*s
)
1682 return s
->state
== MIGRATION_STATUS_SETUP
;
1685 bool migration_has_finished(MigrationState
*s
)
1687 return s
->state
== MIGRATION_STATUS_COMPLETED
;
1690 bool migration_has_failed(MigrationState
*s
)
1692 return (s
->state
== MIGRATION_STATUS_CANCELLED
||
1693 s
->state
== MIGRATION_STATUS_FAILED
);
1696 bool migration_in_postcopy(void)
1698 MigrationState
*s
= migrate_get_current();
1701 case MIGRATION_STATUS_POSTCOPY_ACTIVE
:
1702 case MIGRATION_STATUS_POSTCOPY_PAUSED
:
1703 case MIGRATION_STATUS_POSTCOPY_RECOVER
:
1710 bool migration_in_postcopy_after_devices(MigrationState
*s
)
1712 return migration_in_postcopy() && s
->postcopy_after_devices
;
1715 bool migration_is_idle(void)
1717 MigrationState
*s
= current_migration
;
1724 case MIGRATION_STATUS_NONE
:
1725 case MIGRATION_STATUS_CANCELLED
:
1726 case MIGRATION_STATUS_COMPLETED
:
1727 case MIGRATION_STATUS_FAILED
:
1729 case MIGRATION_STATUS_SETUP
:
1730 case MIGRATION_STATUS_CANCELLING
:
1731 case MIGRATION_STATUS_ACTIVE
:
1732 case MIGRATION_STATUS_POSTCOPY_ACTIVE
:
1733 case MIGRATION_STATUS_COLO
:
1734 case MIGRATION_STATUS_PRE_SWITCHOVER
:
1735 case MIGRATION_STATUS_DEVICE
:
1736 case MIGRATION_STATUS_WAIT_UNPLUG
:
1738 case MIGRATION_STATUS__MAX
:
1739 g_assert_not_reached();
1745 bool migration_is_active(MigrationState
*s
)
1747 return (s
->state
== MIGRATION_STATUS_ACTIVE
||
1748 s
->state
== MIGRATION_STATUS_POSTCOPY_ACTIVE
);
1751 void migrate_init(MigrationState
*s
)
1754 * Reinitialise all migration state, except
1755 * parameters/capabilities that the user set, and
1759 s
->to_dst_file
= NULL
;
1760 s
->state
= MIGRATION_STATUS_NONE
;
1761 s
->rp_state
.from_dst_file
= NULL
;
1762 s
->rp_state
.error
= false;
1764 s
->pages_per_second
= 0.0;
1766 s
->expected_downtime
= 0;
1768 s
->start_postcopy
= false;
1769 s
->postcopy_after_devices
= false;
1770 s
->migration_thread_running
= false;
1771 error_free(s
->error
);
1774 migrate_set_state(&s
->state
, MIGRATION_STATUS_NONE
, MIGRATION_STATUS_SETUP
);
1776 s
->start_time
= qemu_clock_get_ms(QEMU_CLOCK_REALTIME
);
1778 s
->vm_was_running
= false;
1779 s
->iteration_initial_bytes
= 0;
1780 s
->threshold_size
= 0;
1783 static GSList
*migration_blockers
;
1785 int migrate_add_blocker(Error
*reason
, Error
**errp
)
1787 if (only_migratable
) {
1788 error_propagate_prepend(errp
, error_copy(reason
),
1789 "disallowing migration blocker "
1790 "(--only-migratable) for: ");
1794 if (migration_is_idle()) {
1795 migration_blockers
= g_slist_prepend(migration_blockers
, reason
);
1799 error_propagate_prepend(errp
, error_copy(reason
),
1800 "disallowing migration blocker "
1801 "(migration in progress) for: ");
1805 void migrate_del_blocker(Error
*reason
)
1807 migration_blockers
= g_slist_remove(migration_blockers
, reason
);
1810 void qmp_migrate_incoming(const char *uri
, Error
**errp
)
1812 Error
*local_err
= NULL
;
1813 static bool once
= true;
1815 if (!deferred_incoming
) {
1816 error_setg(errp
, "For use with '-incoming defer'");
1820 error_setg(errp
, "The incoming migration has already been started");
1824 qemu_start_incoming_migration(uri
, &local_err
);
1827 error_propagate(errp
, local_err
);
1834 void qmp_migrate_recover(const char *uri
, Error
**errp
)
1836 MigrationIncomingState
*mis
= migration_incoming_get_current();
1838 if (mis
->state
!= MIGRATION_STATUS_POSTCOPY_PAUSED
) {
1839 error_setg(errp
, "Migrate recover can only be run "
1840 "when postcopy is paused.");
1844 if (atomic_cmpxchg(&mis
->postcopy_recover_triggered
,
1845 false, true) == true) {
1846 error_setg(errp
, "Migrate recovery is triggered already");
1851 * Note that this call will never start a real migration; it will
1852 * only re-setup the migration stream and poke existing migration
1853 * to continue using that newly established channel.
1855 qemu_start_incoming_migration(uri
, errp
);
1858 void qmp_migrate_pause(Error
**errp
)
1860 MigrationState
*ms
= migrate_get_current();
1861 MigrationIncomingState
*mis
= migration_incoming_get_current();
1864 if (ms
->state
== MIGRATION_STATUS_POSTCOPY_ACTIVE
) {
1865 /* Source side, during postcopy */
1866 qemu_mutex_lock(&ms
->qemu_file_lock
);
1867 ret
= qemu_file_shutdown(ms
->to_dst_file
);
1868 qemu_mutex_unlock(&ms
->qemu_file_lock
);
1870 error_setg(errp
, "Failed to pause source migration");
1875 if (mis
->state
== MIGRATION_STATUS_POSTCOPY_ACTIVE
) {
1876 ret
= qemu_file_shutdown(mis
->from_src_file
);
1878 error_setg(errp
, "Failed to pause destination migration");
1883 error_setg(errp
, "migrate-pause is currently only supported "
1884 "during postcopy-active state");
1887 bool migration_is_blocked(Error
**errp
)
1889 if (qemu_savevm_state_blocked(errp
)) {
1893 if (migration_blockers
) {
1894 error_propagate(errp
, error_copy(migration_blockers
->data
));
1901 /* Returns true if continue to migrate, or false if error detected */
1902 static bool migrate_prepare(MigrationState
*s
, bool blk
, bool blk_inc
,
1903 bool resume
, Error
**errp
)
1905 Error
*local_err
= NULL
;
1908 if (s
->state
!= MIGRATION_STATUS_POSTCOPY_PAUSED
) {
1909 error_setg(errp
, "Cannot resume if there is no "
1910 "paused migration");
1915 * Postcopy recovery won't work well with release-ram
1916 * capability since release-ram will drop the page buffer as
1917 * long as the page is put into the send buffer. So if there
1918 * is a network failure happened, any page buffers that have
1919 * not yet reached the destination VM but have already been
1920 * sent from the source VM will be lost forever. Let's refuse
1921 * the client from resuming such a postcopy migration.
1922 * Luckily release-ram was designed to only be used when src
1923 * and destination VMs are on the same host, so it should be
1926 if (migrate_release_ram()) {
1927 error_setg(errp
, "Postcopy recovery cannot work "
1928 "when release-ram capability is set");
1932 /* This is a resume, skip init status */
1936 if (migration_is_running(s
->state
)) {
1937 error_setg(errp
, QERR_MIGRATION_ACTIVE
);
1941 if (runstate_check(RUN_STATE_INMIGRATE
)) {
1942 error_setg(errp
, "Guest is waiting for an incoming migration");
1946 if (migration_is_blocked(errp
)) {
1950 if (blk
|| blk_inc
) {
1951 if (migrate_use_block() || migrate_use_block_incremental()) {
1952 error_setg(errp
, "Command options are incompatible with "
1953 "current migration capabilities");
1956 migrate_set_block_enabled(true, &local_err
);
1958 error_propagate(errp
, local_err
);
1961 s
->must_remove_block_options
= true;
1965 migrate_set_block_incremental(s
, true);
1970 * set ram_counters memory to zero for a
1973 memset(&ram_counters
, 0, sizeof(ram_counters
));
1978 void qmp_migrate(const char *uri
, bool has_blk
, bool blk
,
1979 bool has_inc
, bool inc
, bool has_detach
, bool detach
,
1980 bool has_resume
, bool resume
, Error
**errp
)
1982 Error
*local_err
= NULL
;
1983 MigrationState
*s
= migrate_get_current();
1986 if (!migrate_prepare(s
, has_blk
&& blk
, has_inc
&& inc
,
1987 has_resume
&& resume
, errp
)) {
1988 /* Error detected, put into errp */
1992 if (strstart(uri
, "tcp:", &p
)) {
1993 tcp_start_outgoing_migration(s
, p
, &local_err
);
1995 } else if (strstart(uri
, "rdma:", &p
)) {
1996 rdma_start_outgoing_migration(s
, p
, &local_err
);
1998 } else if (strstart(uri
, "exec:", &p
)) {
1999 exec_start_outgoing_migration(s
, p
, &local_err
);
2000 } else if (strstart(uri
, "unix:", &p
)) {
2001 unix_start_outgoing_migration(s
, p
, &local_err
);
2002 } else if (strstart(uri
, "fd:", &p
)) {
2003 fd_start_outgoing_migration(s
, p
, &local_err
);
2005 error_setg(errp
, QERR_INVALID_PARAMETER_VALUE
, "uri",
2006 "a valid migration protocol");
2007 migrate_set_state(&s
->state
, MIGRATION_STATUS_SETUP
,
2008 MIGRATION_STATUS_FAILED
);
2009 block_cleanup_parameters(s
);
2014 migrate_fd_error(s
, local_err
);
2015 error_propagate(errp
, local_err
);
2020 void qmp_migrate_cancel(Error
**errp
)
2022 migrate_fd_cancel(migrate_get_current());
2025 void qmp_migrate_continue(MigrationStatus state
, Error
**errp
)
2027 MigrationState
*s
= migrate_get_current();
2028 if (s
->state
!= state
) {
2029 error_setg(errp
, "Migration not in expected state: %s",
2030 MigrationStatus_str(s
->state
));
2033 qemu_sem_post(&s
->pause_sem
);
2036 void qmp_migrate_set_cache_size(int64_t value
, Error
**errp
)
2038 MigrateSetParameters p
= {
2039 .has_xbzrle_cache_size
= true,
2040 .xbzrle_cache_size
= value
,
2043 qmp_migrate_set_parameters(&p
, errp
);
2046 int64_t qmp_query_migrate_cache_size(Error
**errp
)
2048 return migrate_xbzrle_cache_size();
2051 void qmp_migrate_set_speed(int64_t value
, Error
**errp
)
2053 MigrateSetParameters p
= {
2054 .has_max_bandwidth
= true,
2055 .max_bandwidth
= value
,
2058 qmp_migrate_set_parameters(&p
, errp
);
2061 void qmp_migrate_set_downtime(double value
, Error
**errp
)
2063 if (value
< 0 || value
> MAX_MIGRATE_DOWNTIME_SECONDS
) {
2064 error_setg(errp
, "Parameter 'downtime_limit' expects an integer in "
2065 "the range of 0 to %d seconds",
2066 MAX_MIGRATE_DOWNTIME_SECONDS
);
2070 value
*= 1000; /* Convert to milliseconds */
2072 MigrateSetParameters p
= {
2073 .has_downtime_limit
= true,
2074 .downtime_limit
= (int64_t)value
,
2077 qmp_migrate_set_parameters(&p
, errp
);
2080 bool migrate_release_ram(void)
2084 s
= migrate_get_current();
2086 return s
->enabled_capabilities
[MIGRATION_CAPABILITY_RELEASE_RAM
];
2089 bool migrate_postcopy_ram(void)
2093 s
= migrate_get_current();
2095 return s
->enabled_capabilities
[MIGRATION_CAPABILITY_POSTCOPY_RAM
];
2098 bool migrate_postcopy(void)
2100 return migrate_postcopy_ram() || migrate_dirty_bitmaps();
2103 bool migrate_auto_converge(void)
2107 s
= migrate_get_current();
2109 return s
->enabled_capabilities
[MIGRATION_CAPABILITY_AUTO_CONVERGE
];
2112 bool migrate_zero_blocks(void)
2116 s
= migrate_get_current();
2118 return s
->enabled_capabilities
[MIGRATION_CAPABILITY_ZERO_BLOCKS
];
2121 bool migrate_postcopy_blocktime(void)
2125 s
= migrate_get_current();
2127 return s
->enabled_capabilities
[MIGRATION_CAPABILITY_POSTCOPY_BLOCKTIME
];
2130 bool migrate_use_compression(void)
2134 s
= migrate_get_current();
2136 return s
->enabled_capabilities
[MIGRATION_CAPABILITY_COMPRESS
];
2139 int migrate_compress_level(void)
2143 s
= migrate_get_current();
2145 return s
->parameters
.compress_level
;
2148 int migrate_compress_threads(void)
2152 s
= migrate_get_current();
2154 return s
->parameters
.compress_threads
;
2157 int migrate_compress_wait_thread(void)
2161 s
= migrate_get_current();
2163 return s
->parameters
.compress_wait_thread
;
2166 int migrate_decompress_threads(void)
2170 s
= migrate_get_current();
2172 return s
->parameters
.decompress_threads
;
2175 bool migrate_dirty_bitmaps(void)
2179 s
= migrate_get_current();
2181 return s
->enabled_capabilities
[MIGRATION_CAPABILITY_DIRTY_BITMAPS
];
2184 bool migrate_ignore_shared(void)
2188 s
= migrate_get_current();
2190 return s
->enabled_capabilities
[MIGRATION_CAPABILITY_X_IGNORE_SHARED
];
2193 bool migrate_validate_uuid(void)
2197 s
= migrate_get_current();
2199 return s
->enabled_capabilities
[MIGRATION_CAPABILITY_VALIDATE_UUID
];
2202 bool migrate_use_events(void)
2206 s
= migrate_get_current();
2208 return s
->enabled_capabilities
[MIGRATION_CAPABILITY_EVENTS
];
2211 bool migrate_use_multifd(void)
2215 s
= migrate_get_current();
2217 return s
->enabled_capabilities
[MIGRATION_CAPABILITY_MULTIFD
];
2220 bool migrate_pause_before_switchover(void)
2224 s
= migrate_get_current();
2226 return s
->enabled_capabilities
[
2227 MIGRATION_CAPABILITY_PAUSE_BEFORE_SWITCHOVER
];
2230 int migrate_multifd_channels(void)
2234 s
= migrate_get_current();
2236 return s
->parameters
.multifd_channels
;
2239 int migrate_use_xbzrle(void)
2243 s
= migrate_get_current();
2245 return s
->enabled_capabilities
[MIGRATION_CAPABILITY_XBZRLE
];
2248 int64_t migrate_xbzrle_cache_size(void)
2252 s
= migrate_get_current();
2254 return s
->parameters
.xbzrle_cache_size
;
2257 static int64_t migrate_max_postcopy_bandwidth(void)
2261 s
= migrate_get_current();
2263 return s
->parameters
.max_postcopy_bandwidth
;
2266 bool migrate_use_block(void)
2270 s
= migrate_get_current();
2272 return s
->enabled_capabilities
[MIGRATION_CAPABILITY_BLOCK
];
2275 bool migrate_use_return_path(void)
2279 s
= migrate_get_current();
2281 return s
->enabled_capabilities
[MIGRATION_CAPABILITY_RETURN_PATH
];
2284 bool migrate_use_block_incremental(void)
2288 s
= migrate_get_current();
2290 return s
->parameters
.block_incremental
;
2293 /* migration thread support */
2295 * Something bad happened to the RP stream, mark an error
2296 * The caller shall print or trace something to indicate why
2298 static void mark_source_rp_bad(MigrationState
*s
)
2300 s
->rp_state
.error
= true;
2303 static struct rp_cmd_args
{
2304 ssize_t len
; /* -1 = variable */
2307 [MIG_RP_MSG_INVALID
] = { .len
= -1, .name
= "INVALID" },
2308 [MIG_RP_MSG_SHUT
] = { .len
= 4, .name
= "SHUT" },
2309 [MIG_RP_MSG_PONG
] = { .len
= 4, .name
= "PONG" },
2310 [MIG_RP_MSG_REQ_PAGES
] = { .len
= 12, .name
= "REQ_PAGES" },
2311 [MIG_RP_MSG_REQ_PAGES_ID
] = { .len
= -1, .name
= "REQ_PAGES_ID" },
2312 [MIG_RP_MSG_RECV_BITMAP
] = { .len
= -1, .name
= "RECV_BITMAP" },
2313 [MIG_RP_MSG_RESUME_ACK
] = { .len
= 4, .name
= "RESUME_ACK" },
2314 [MIG_RP_MSG_MAX
] = { .len
= -1, .name
= "MAX" },
2318 * Process a request for pages received on the return path,
2319 * We're allowed to send more than requested (e.g. to round to our page size)
2320 * and we don't need to send pages that have already been sent.
2322 static void migrate_handle_rp_req_pages(MigrationState
*ms
, const char* rbname
,
2323 ram_addr_t start
, size_t len
)
2325 long our_host_ps
= qemu_real_host_page_size
;
2327 trace_migrate_handle_rp_req_pages(rbname
, start
, len
);
2330 * Since we currently insist on matching page sizes, just sanity check
2331 * we're being asked for whole host pages.
2333 if (start
& (our_host_ps
-1) ||
2334 (len
& (our_host_ps
-1))) {
2335 error_report("%s: Misaligned page request, start: " RAM_ADDR_FMT
2336 " len: %zd", __func__
, start
, len
);
2337 mark_source_rp_bad(ms
);
2341 if (ram_save_queue_pages(rbname
, start
, len
)) {
2342 mark_source_rp_bad(ms
);
2346 /* Return true to retry, false to quit */
2347 static bool postcopy_pause_return_path_thread(MigrationState
*s
)
2349 trace_postcopy_pause_return_path();
2351 qemu_sem_wait(&s
->postcopy_pause_rp_sem
);
2353 trace_postcopy_pause_return_path_continued();
2358 static int migrate_handle_rp_recv_bitmap(MigrationState
*s
, char *block_name
)
2360 RAMBlock
*block
= qemu_ram_block_by_name(block_name
);
2363 error_report("%s: invalid block name '%s'", __func__
, block_name
);
2367 /* Fetch the received bitmap and refresh the dirty bitmap */
2368 return ram_dirty_bitmap_reload(s
, block
);
2371 static int migrate_handle_rp_resume_ack(MigrationState
*s
, uint32_t value
)
2373 trace_source_return_path_thread_resume_ack(value
);
2375 if (value
!= MIGRATION_RESUME_ACK_VALUE
) {
2376 error_report("%s: illegal resume_ack value %"PRIu32
,
2381 /* Now both sides are active. */
2382 migrate_set_state(&s
->state
, MIGRATION_STATUS_POSTCOPY_RECOVER
,
2383 MIGRATION_STATUS_POSTCOPY_ACTIVE
);
2385 /* Notify send thread that time to continue send pages */
2386 qemu_sem_post(&s
->rp_state
.rp_sem
);
2392 * Handles messages sent on the return path towards the source VM
2395 static void *source_return_path_thread(void *opaque
)
2397 MigrationState
*ms
= opaque
;
2398 QEMUFile
*rp
= ms
->rp_state
.from_dst_file
;
2399 uint16_t header_len
, header_type
;
2401 uint32_t tmp32
, sibling_error
;
2402 ram_addr_t start
= 0; /* =0 to silence warning */
2403 size_t len
= 0, expected_len
;
2406 trace_source_return_path_thread_entry();
2407 rcu_register_thread();
2410 while (!ms
->rp_state
.error
&& !qemu_file_get_error(rp
) &&
2411 migration_is_setup_or_active(ms
->state
)) {
2412 trace_source_return_path_thread_loop_top();
2413 header_type
= qemu_get_be16(rp
);
2414 header_len
= qemu_get_be16(rp
);
2416 if (qemu_file_get_error(rp
)) {
2417 mark_source_rp_bad(ms
);
2421 if (header_type
>= MIG_RP_MSG_MAX
||
2422 header_type
== MIG_RP_MSG_INVALID
) {
2423 error_report("RP: Received invalid message 0x%04x length 0x%04x",
2424 header_type
, header_len
);
2425 mark_source_rp_bad(ms
);
2429 if ((rp_cmd_args
[header_type
].len
!= -1 &&
2430 header_len
!= rp_cmd_args
[header_type
].len
) ||
2431 header_len
> sizeof(buf
)) {
2432 error_report("RP: Received '%s' message (0x%04x) with"
2433 "incorrect length %d expecting %zu",
2434 rp_cmd_args
[header_type
].name
, header_type
, header_len
,
2435 (size_t)rp_cmd_args
[header_type
].len
);
2436 mark_source_rp_bad(ms
);
2440 /* We know we've got a valid header by this point */
2441 res
= qemu_get_buffer(rp
, buf
, header_len
);
2442 if (res
!= header_len
) {
2443 error_report("RP: Failed reading data for message 0x%04x"
2444 " read %d expected %d",
2445 header_type
, res
, header_len
);
2446 mark_source_rp_bad(ms
);
2450 /* OK, we have the message and the data */
2451 switch (header_type
) {
2452 case MIG_RP_MSG_SHUT
:
2453 sibling_error
= ldl_be_p(buf
);
2454 trace_source_return_path_thread_shut(sibling_error
);
2455 if (sibling_error
) {
2456 error_report("RP: Sibling indicated error %d", sibling_error
);
2457 mark_source_rp_bad(ms
);
2460 * We'll let the main thread deal with closing the RP
2461 * we could do a shutdown(2) on it, but we're the only user
2462 * anyway, so there's nothing gained.
2466 case MIG_RP_MSG_PONG
:
2467 tmp32
= ldl_be_p(buf
);
2468 trace_source_return_path_thread_pong(tmp32
);
2471 case MIG_RP_MSG_REQ_PAGES
:
2472 start
= ldq_be_p(buf
);
2473 len
= ldl_be_p(buf
+ 8);
2474 migrate_handle_rp_req_pages(ms
, NULL
, start
, len
);
2477 case MIG_RP_MSG_REQ_PAGES_ID
:
2478 expected_len
= 12 + 1; /* header + termination */
2480 if (header_len
>= expected_len
) {
2481 start
= ldq_be_p(buf
);
2482 len
= ldl_be_p(buf
+ 8);
2483 /* Now we expect an idstr */
2484 tmp32
= buf
[12]; /* Length of the following idstr */
2485 buf
[13 + tmp32
] = '\0';
2486 expected_len
+= tmp32
;
2488 if (header_len
!= expected_len
) {
2489 error_report("RP: Req_Page_id with length %d expecting %zd",
2490 header_len
, expected_len
);
2491 mark_source_rp_bad(ms
);
2494 migrate_handle_rp_req_pages(ms
, (char *)&buf
[13], start
, len
);
2497 case MIG_RP_MSG_RECV_BITMAP
:
2498 if (header_len
< 1) {
2499 error_report("%s: missing block name", __func__
);
2500 mark_source_rp_bad(ms
);
2503 /* Format: len (1B) + idstr (<255B). This ends the idstr. */
2504 buf
[buf
[0] + 1] = '\0';
2505 if (migrate_handle_rp_recv_bitmap(ms
, (char *)(buf
+ 1))) {
2506 mark_source_rp_bad(ms
);
2511 case MIG_RP_MSG_RESUME_ACK
:
2512 tmp32
= ldl_be_p(buf
);
2513 if (migrate_handle_rp_resume_ack(ms
, tmp32
)) {
2514 mark_source_rp_bad(ms
);
2525 res
= qemu_file_get_error(rp
);
2527 if (res
== -EIO
&& migration_in_postcopy()) {
2529 * Maybe there is something we can do: it looks like a
2530 * network down issue, and we pause for a recovery.
2532 if (postcopy_pause_return_path_thread(ms
)) {
2533 /* Reload rp, reset the rest */
2534 if (rp
!= ms
->rp_state
.from_dst_file
) {
2536 rp
= ms
->rp_state
.from_dst_file
;
2538 ms
->rp_state
.error
= false;
2543 trace_source_return_path_thread_bad_end();
2544 mark_source_rp_bad(ms
);
2547 trace_source_return_path_thread_end();
2548 ms
->rp_state
.from_dst_file
= NULL
;
2550 rcu_unregister_thread();
2554 static int open_return_path_on_source(MigrationState
*ms
,
2558 ms
->rp_state
.from_dst_file
= qemu_file_get_return_path(ms
->to_dst_file
);
2559 if (!ms
->rp_state
.from_dst_file
) {
2563 trace_open_return_path_on_source();
2565 if (!create_thread
) {
2570 qemu_thread_create(&ms
->rp_state
.rp_thread
, "return path",
2571 source_return_path_thread
, ms
, QEMU_THREAD_JOINABLE
);
2573 trace_open_return_path_on_source_continue();
2578 /* Returns 0 if the RP was ok, otherwise there was an error on the RP */
2579 static int await_return_path_close_on_source(MigrationState
*ms
)
2582 * If this is a normal exit then the destination will send a SHUT and the
2583 * rp_thread will exit, however if there's an error we need to cause
2586 if (qemu_file_get_error(ms
->to_dst_file
) && ms
->rp_state
.from_dst_file
) {
2588 * shutdown(2), if we have it, will cause it to unblock if it's stuck
2589 * waiting for the destination.
2591 qemu_file_shutdown(ms
->rp_state
.from_dst_file
);
2592 mark_source_rp_bad(ms
);
2594 trace_await_return_path_close_on_source_joining();
2595 qemu_thread_join(&ms
->rp_state
.rp_thread
);
2596 trace_await_return_path_close_on_source_close();
2597 return ms
->rp_state
.error
;
2601 * Switch from normal iteration to postcopy
2602 * Returns non-0 on error
2604 static int postcopy_start(MigrationState
*ms
)
2607 QIOChannelBuffer
*bioc
;
2609 int64_t time_at_stop
= qemu_clock_get_ms(QEMU_CLOCK_REALTIME
);
2610 int64_t bandwidth
= migrate_max_postcopy_bandwidth();
2611 bool restart_block
= false;
2612 int cur_state
= MIGRATION_STATUS_ACTIVE
;
2613 if (!migrate_pause_before_switchover()) {
2614 migrate_set_state(&ms
->state
, MIGRATION_STATUS_ACTIVE
,
2615 MIGRATION_STATUS_POSTCOPY_ACTIVE
);
2618 trace_postcopy_start();
2619 qemu_mutex_lock_iothread();
2620 trace_postcopy_start_set_run();
2622 qemu_system_wakeup_request(QEMU_WAKEUP_REASON_OTHER
, NULL
);
2623 global_state_store();
2624 ret
= vm_stop_force_state(RUN_STATE_FINISH_MIGRATE
);
2629 ret
= migration_maybe_pause(ms
, &cur_state
,
2630 MIGRATION_STATUS_POSTCOPY_ACTIVE
);
2635 ret
= bdrv_inactivate_all();
2639 restart_block
= true;
2642 * Cause any non-postcopiable, but iterative devices to
2643 * send out their final data.
2645 qemu_savevm_state_complete_precopy(ms
->to_dst_file
, true, false);
2648 * in Finish migrate and with the io-lock held everything should
2649 * be quiet, but we've potentially still got dirty pages and we
2650 * need to tell the destination to throw any pages it's already received
2653 if (migrate_postcopy_ram()) {
2654 if (ram_postcopy_send_discard_bitmap(ms
)) {
2655 error_report("postcopy send discard bitmap failed");
2661 * send rest of state - note things that are doing postcopy
2662 * will notice we're in POSTCOPY_ACTIVE and not actually
2663 * wrap their state up here
2665 /* 0 max-postcopy-bandwidth means unlimited */
2667 qemu_file_set_rate_limit(ms
->to_dst_file
, INT64_MAX
);
2669 qemu_file_set_rate_limit(ms
->to_dst_file
, bandwidth
/ XFER_LIMIT_RATIO
);
2671 if (migrate_postcopy_ram()) {
2672 /* Ping just for debugging, helps line traces up */
2673 qemu_savevm_send_ping(ms
->to_dst_file
, 2);
2677 * While loading the device state we may trigger page transfer
2678 * requests and the fd must be free to process those, and thus
2679 * the destination must read the whole device state off the fd before
2680 * it starts processing it. Unfortunately the ad-hoc migration format
2681 * doesn't allow the destination to know the size to read without fully
2682 * parsing it through each devices load-state code (especially the open
2683 * coded devices that use get/put).
2684 * So we wrap the device state up in a package with a length at the start;
2685 * to do this we use a qemu_buf to hold the whole of the device state.
2687 bioc
= qio_channel_buffer_new(4096);
2688 qio_channel_set_name(QIO_CHANNEL(bioc
), "migration-postcopy-buffer");
2689 fb
= qemu_fopen_channel_output(QIO_CHANNEL(bioc
));
2690 object_unref(OBJECT(bioc
));
2693 * Make sure the receiver can get incoming pages before we send the rest
2696 qemu_savevm_send_postcopy_listen(fb
);
2698 qemu_savevm_state_complete_precopy(fb
, false, false);
2699 if (migrate_postcopy_ram()) {
2700 qemu_savevm_send_ping(fb
, 3);
2703 qemu_savevm_send_postcopy_run(fb
);
2705 /* <><> end of stuff going into the package */
2707 /* Last point of recovery; as soon as we send the package the destination
2708 * can open devices and potentially start running.
2709 * Lets just check again we've not got any errors.
2711 ret
= qemu_file_get_error(ms
->to_dst_file
);
2713 error_report("postcopy_start: Migration stream errored (pre package)");
2717 restart_block
= false;
2719 /* Now send that blob */
2720 if (qemu_savevm_send_packaged(ms
->to_dst_file
, bioc
->data
, bioc
->usage
)) {
2725 /* Send a notify to give a chance for anything that needs to happen
2726 * at the transition to postcopy and after the device state; in particular
2727 * spice needs to trigger a transition now
2729 ms
->postcopy_after_devices
= true;
2730 notifier_list_notify(&migration_state_notifiers
, ms
);
2732 ms
->downtime
= qemu_clock_get_ms(QEMU_CLOCK_REALTIME
) - time_at_stop
;
2734 qemu_mutex_unlock_iothread();
2736 if (migrate_postcopy_ram()) {
2738 * Although this ping is just for debug, it could potentially be
2739 * used for getting a better measurement of downtime at the source.
2741 qemu_savevm_send_ping(ms
->to_dst_file
, 4);
2744 if (migrate_release_ram()) {
2745 ram_postcopy_migrated_memory_release(ms
);
2748 ret
= qemu_file_get_error(ms
->to_dst_file
);
2750 error_report("postcopy_start: Migration stream errored");
2751 migrate_set_state(&ms
->state
, MIGRATION_STATUS_POSTCOPY_ACTIVE
,
2752 MIGRATION_STATUS_FAILED
);
2760 migrate_set_state(&ms
->state
, MIGRATION_STATUS_POSTCOPY_ACTIVE
,
2761 MIGRATION_STATUS_FAILED
);
2762 if (restart_block
) {
2763 /* A failure happened early enough that we know the destination hasn't
2764 * accessed block devices, so we're safe to recover.
2766 Error
*local_err
= NULL
;
2768 bdrv_invalidate_cache_all(&local_err
);
2770 error_report_err(local_err
);
2773 qemu_mutex_unlock_iothread();
2778 * migration_maybe_pause: Pause if required to by
2779 * migrate_pause_before_switchover called with the iothread locked
2780 * Returns: 0 on success
2782 static int migration_maybe_pause(MigrationState
*s
,
2783 int *current_active_state
,
2786 if (!migrate_pause_before_switchover()) {
2790 /* Since leaving this state is not atomic with posting the semaphore
2791 * it's possible that someone could have issued multiple migrate_continue
2792 * and the semaphore is incorrectly positive at this point;
2793 * the docs say it's undefined to reinit a semaphore that's already
2794 * init'd, so use timedwait to eat up any existing posts.
2796 while (qemu_sem_timedwait(&s
->pause_sem
, 1) == 0) {
2797 /* This block intentionally left blank */
2801 * If the migration is cancelled when it is in the completion phase,
2802 * the migration state is set to MIGRATION_STATUS_CANCELLING.
2803 * So we don't need to wait a semaphore, otherwise we would always
2804 * wait for the 'pause_sem' semaphore.
2806 if (s
->state
!= MIGRATION_STATUS_CANCELLING
) {
2807 qemu_mutex_unlock_iothread();
2808 migrate_set_state(&s
->state
, *current_active_state
,
2809 MIGRATION_STATUS_PRE_SWITCHOVER
);
2810 qemu_sem_wait(&s
->pause_sem
);
2811 migrate_set_state(&s
->state
, MIGRATION_STATUS_PRE_SWITCHOVER
,
2813 *current_active_state
= new_state
;
2814 qemu_mutex_lock_iothread();
2817 return s
->state
== new_state
? 0 : -EINVAL
;
2821 * migration_completion: Used by migration_thread when there's not much left.
2822 * The caller 'breaks' the loop when this returns.
2824 * @s: Current migration state
2826 static void migration_completion(MigrationState
*s
)
2829 int current_active_state
= s
->state
;
2831 if (s
->state
== MIGRATION_STATUS_ACTIVE
) {
2832 qemu_mutex_lock_iothread();
2833 s
->downtime_start
= qemu_clock_get_ms(QEMU_CLOCK_REALTIME
);
2834 qemu_system_wakeup_request(QEMU_WAKEUP_REASON_OTHER
, NULL
);
2835 s
->vm_was_running
= runstate_is_running();
2836 ret
= global_state_store();
2839 bool inactivate
= !migrate_colo_enabled();
2840 ret
= vm_stop_force_state(RUN_STATE_FINISH_MIGRATE
);
2842 ret
= migration_maybe_pause(s
, ¤t_active_state
,
2843 MIGRATION_STATUS_DEVICE
);
2846 qemu_file_set_rate_limit(s
->to_dst_file
, INT64_MAX
);
2847 ret
= qemu_savevm_state_complete_precopy(s
->to_dst_file
, false,
2850 if (inactivate
&& ret
>= 0) {
2851 s
->block_inactive
= true;
2854 qemu_mutex_unlock_iothread();
2859 } else if (s
->state
== MIGRATION_STATUS_POSTCOPY_ACTIVE
) {
2860 trace_migration_completion_postcopy_end();
2862 qemu_savevm_state_complete_postcopy(s
->to_dst_file
);
2863 trace_migration_completion_postcopy_end_after_complete();
2867 * If rp was opened we must clean up the thread before
2868 * cleaning everything else up (since if there are no failures
2869 * it will wait for the destination to send it's status in
2872 if (s
->rp_state
.from_dst_file
) {
2874 trace_migration_return_path_end_before();
2875 rp_error
= await_return_path_close_on_source(s
);
2876 trace_migration_return_path_end_after(rp_error
);
2878 goto fail_invalidate
;
2882 if (qemu_file_get_error(s
->to_dst_file
)) {
2883 trace_migration_completion_file_err();
2884 goto fail_invalidate
;
2887 if (!migrate_colo_enabled()) {
2888 migrate_set_state(&s
->state
, current_active_state
,
2889 MIGRATION_STATUS_COMPLETED
);
2895 /* If not doing postcopy, vm_start() will be called: let's regain
2896 * control on images.
2898 if (s
->state
== MIGRATION_STATUS_ACTIVE
||
2899 s
->state
== MIGRATION_STATUS_DEVICE
) {
2900 Error
*local_err
= NULL
;
2902 qemu_mutex_lock_iothread();
2903 bdrv_invalidate_cache_all(&local_err
);
2905 error_report_err(local_err
);
2907 s
->block_inactive
= false;
2909 qemu_mutex_unlock_iothread();
2913 migrate_set_state(&s
->state
, current_active_state
,
2914 MIGRATION_STATUS_FAILED
);
2917 bool migrate_colo_enabled(void)
2919 MigrationState
*s
= migrate_get_current();
2920 return s
->enabled_capabilities
[MIGRATION_CAPABILITY_X_COLO
];
2923 typedef enum MigThrError
{
2924 /* No error detected */
2925 MIG_THR_ERR_NONE
= 0,
2926 /* Detected error, but resumed successfully */
2927 MIG_THR_ERR_RECOVERED
= 1,
2928 /* Detected fatal error, need to exit */
2929 MIG_THR_ERR_FATAL
= 2,
2932 static int postcopy_resume_handshake(MigrationState
*s
)
2934 qemu_savevm_send_postcopy_resume(s
->to_dst_file
);
2936 while (s
->state
== MIGRATION_STATUS_POSTCOPY_RECOVER
) {
2937 qemu_sem_wait(&s
->rp_state
.rp_sem
);
2940 if (s
->state
== MIGRATION_STATUS_POSTCOPY_ACTIVE
) {
2947 /* Return zero if success, or <0 for error */
2948 static int postcopy_do_resume(MigrationState
*s
)
2953 * Call all the resume_prepare() hooks, so that modules can be
2954 * ready for the migration resume.
2956 ret
= qemu_savevm_state_resume_prepare(s
);
2958 error_report("%s: resume_prepare() failure detected: %d",
2964 * Last handshake with destination on the resume (destination will
2965 * switch to postcopy-active afterwards)
2967 ret
= postcopy_resume_handshake(s
);
2969 error_report("%s: handshake failed: %d", __func__
, ret
);
2977 * We don't return until we are in a safe state to continue current
2978 * postcopy migration. Returns MIG_THR_ERR_RECOVERED if recovered, or
2979 * MIG_THR_ERR_FATAL if unrecovery failure happened.
2981 static MigThrError
postcopy_pause(MigrationState
*s
)
2983 assert(s
->state
== MIGRATION_STATUS_POSTCOPY_ACTIVE
);
2988 migrate_set_state(&s
->state
, s
->state
,
2989 MIGRATION_STATUS_POSTCOPY_PAUSED
);
2991 /* Current channel is possibly broken. Release it. */
2992 assert(s
->to_dst_file
);
2993 qemu_mutex_lock(&s
->qemu_file_lock
);
2994 file
= s
->to_dst_file
;
2995 s
->to_dst_file
= NULL
;
2996 qemu_mutex_unlock(&s
->qemu_file_lock
);
2998 qemu_file_shutdown(file
);
3001 error_report("Detected IO failure for postcopy. "
3002 "Migration paused.");
3005 * We wait until things fixed up. Then someone will setup the
3006 * status back for us.
3008 while (s
->state
== MIGRATION_STATUS_POSTCOPY_PAUSED
) {
3009 qemu_sem_wait(&s
->postcopy_pause_sem
);
3012 if (s
->state
== MIGRATION_STATUS_POSTCOPY_RECOVER
) {
3013 /* Woken up by a recover procedure. Give it a shot */
3016 * Firstly, let's wake up the return path now, with a new
3017 * return path channel.
3019 qemu_sem_post(&s
->postcopy_pause_rp_sem
);
3021 /* Do the resume logic */
3022 if (postcopy_do_resume(s
) == 0) {
3023 /* Let's continue! */
3024 trace_postcopy_pause_continued();
3025 return MIG_THR_ERR_RECOVERED
;
3028 * Something wrong happened during the recovery, let's
3029 * pause again. Pause is always better than throwing
3035 /* This is not right... Time to quit. */
3036 return MIG_THR_ERR_FATAL
;
3041 static MigThrError
migration_detect_error(MigrationState
*s
)
3044 int state
= s
->state
;
3045 Error
*local_error
= NULL
;
3047 if (state
== MIGRATION_STATUS_CANCELLING
||
3048 state
== MIGRATION_STATUS_CANCELLED
) {
3049 /* End the migration, but don't set the state to failed */
3050 return MIG_THR_ERR_FATAL
;
3053 /* Try to detect any file errors */
3054 ret
= qemu_file_get_error_obj(s
->to_dst_file
, &local_error
);
3056 /* Everything is fine */
3057 assert(!local_error
);
3058 return MIG_THR_ERR_NONE
;
3062 migrate_set_error(s
, local_error
);
3063 error_free(local_error
);
3066 if (state
== MIGRATION_STATUS_POSTCOPY_ACTIVE
&& ret
== -EIO
) {
3068 * For postcopy, we allow the network to be down for a
3069 * while. After that, it can be continued by a
3072 return postcopy_pause(s
);
3075 * For precopy (or postcopy with error outside IO), we fail
3078 migrate_set_state(&s
->state
, state
, MIGRATION_STATUS_FAILED
);
3079 trace_migration_thread_file_err();
3081 /* Time to stop the migration, now. */
3082 return MIG_THR_ERR_FATAL
;
3086 /* How many bytes have we transferred since the beginning of the migration */
3087 static uint64_t migration_total_bytes(MigrationState
*s
)
3089 return qemu_ftell(s
->to_dst_file
) + ram_counters
.multifd_bytes
;
3092 static void migration_calculate_complete(MigrationState
*s
)
3094 uint64_t bytes
= migration_total_bytes(s
);
3095 int64_t end_time
= qemu_clock_get_ms(QEMU_CLOCK_REALTIME
);
3096 int64_t transfer_time
;
3098 s
->total_time
= end_time
- s
->start_time
;
3101 * It's still not set, so we are precopy migration. For
3102 * postcopy, downtime is calculated during postcopy_start().
3104 s
->downtime
= end_time
- s
->downtime_start
;
3107 transfer_time
= s
->total_time
- s
->setup_time
;
3108 if (transfer_time
) {
3109 s
->mbps
= ((double) bytes
* 8.0) / transfer_time
/ 1000;
3113 static void update_iteration_initial_status(MigrationState
*s
)
3116 * Update these three fields at the same time to avoid mismatch info lead
3117 * wrong speed calculation.
3119 s
->iteration_start_time
= qemu_clock_get_ms(QEMU_CLOCK_REALTIME
);
3120 s
->iteration_initial_bytes
= migration_total_bytes(s
);
3121 s
->iteration_initial_pages
= ram_get_total_transferred_pages();
3124 static void migration_update_counters(MigrationState
*s
,
3125 int64_t current_time
)
3127 uint64_t transferred
, transferred_pages
, time_spent
;
3128 uint64_t current_bytes
; /* bytes transferred since the beginning */
3131 if (current_time
< s
->iteration_start_time
+ BUFFER_DELAY
) {
3135 current_bytes
= migration_total_bytes(s
);
3136 transferred
= current_bytes
- s
->iteration_initial_bytes
;
3137 time_spent
= current_time
- s
->iteration_start_time
;
3138 bandwidth
= (double)transferred
/ time_spent
;
3139 s
->threshold_size
= bandwidth
* s
->parameters
.downtime_limit
;
3141 s
->mbps
= (((double) transferred
* 8.0) /
3142 ((double) time_spent
/ 1000.0)) / 1000.0 / 1000.0;
3144 transferred_pages
= ram_get_total_transferred_pages() -
3145 s
->iteration_initial_pages
;
3146 s
->pages_per_second
= (double) transferred_pages
/
3147 (((double) time_spent
/ 1000.0));
3150 * if we haven't sent anything, we don't want to
3151 * recalculate. 10000 is a small enough number for our purposes
3153 if (ram_counters
.dirty_pages_rate
&& transferred
> 10000) {
3154 s
->expected_downtime
= ram_counters
.remaining
/ bandwidth
;
3157 qemu_file_reset_rate_limit(s
->to_dst_file
);
3159 update_iteration_initial_status(s
);
3161 trace_migrate_transferred(transferred
, time_spent
,
3162 bandwidth
, s
->threshold_size
);
3165 /* Migration thread iteration status */
3167 MIG_ITERATE_RESUME
, /* Resume current iteration */
3168 MIG_ITERATE_SKIP
, /* Skip current iteration */
3169 MIG_ITERATE_BREAK
, /* Break the loop */
3173 * Return true if continue to the next iteration directly, false
3176 static MigIterateState
migration_iteration_run(MigrationState
*s
)
3178 uint64_t pending_size
, pend_pre
, pend_compat
, pend_post
;
3179 bool in_postcopy
= s
->state
== MIGRATION_STATUS_POSTCOPY_ACTIVE
;
3181 qemu_savevm_state_pending(s
->to_dst_file
, s
->threshold_size
, &pend_pre
,
3182 &pend_compat
, &pend_post
);
3183 pending_size
= pend_pre
+ pend_compat
+ pend_post
;
3185 trace_migrate_pending(pending_size
, s
->threshold_size
,
3186 pend_pre
, pend_compat
, pend_post
);
3188 if (pending_size
&& pending_size
>= s
->threshold_size
) {
3189 /* Still a significant amount to transfer */
3190 if (!in_postcopy
&& pend_pre
<= s
->threshold_size
&&
3191 atomic_read(&s
->start_postcopy
)) {
3192 if (postcopy_start(s
)) {
3193 error_report("%s: postcopy failed to start", __func__
);
3195 return MIG_ITERATE_SKIP
;
3197 /* Just another iteration step */
3198 qemu_savevm_state_iterate(s
->to_dst_file
, in_postcopy
);
3200 trace_migration_thread_low_pending(pending_size
);
3201 migration_completion(s
);
3202 return MIG_ITERATE_BREAK
;
3205 return MIG_ITERATE_RESUME
;
3208 static void migration_iteration_finish(MigrationState
*s
)
3210 /* If we enabled cpu throttling for auto-converge, turn it off. */
3211 cpu_throttle_stop();
3213 qemu_mutex_lock_iothread();
3215 case MIGRATION_STATUS_COMPLETED
:
3216 migration_calculate_complete(s
);
3217 runstate_set(RUN_STATE_POSTMIGRATE
);
3220 case MIGRATION_STATUS_ACTIVE
:
3222 * We should really assert here, but since it's during
3223 * migration, let's try to reduce the usage of assertions.
3225 if (!migrate_colo_enabled()) {
3226 error_report("%s: critical error: calling COLO code without "
3227 "COLO enabled", __func__
);
3229 migrate_start_colo_process(s
);
3231 * Fixme: we will run VM in COLO no matter its old running state.
3232 * After exited COLO, we will keep running.
3234 s
->vm_was_running
= true;
3236 case MIGRATION_STATUS_FAILED
:
3237 case MIGRATION_STATUS_CANCELLED
:
3238 case MIGRATION_STATUS_CANCELLING
:
3239 if (s
->vm_was_running
) {
3242 if (runstate_check(RUN_STATE_FINISH_MIGRATE
)) {
3243 runstate_set(RUN_STATE_POSTMIGRATE
);
3249 /* Should not reach here, but if so, forgive the VM. */
3250 error_report("%s: Unknown ending state %d", __func__
, s
->state
);
3253 migrate_fd_cleanup_schedule(s
);
3254 qemu_mutex_unlock_iothread();
3257 void migration_make_urgent_request(void)
3259 qemu_sem_post(&migrate_get_current()->rate_limit_sem
);
3262 void migration_consume_urgent_request(void)
3264 qemu_sem_wait(&migrate_get_current()->rate_limit_sem
);
3267 /* Returns true if the rate limiting was broken by an urgent request */
3268 bool migration_rate_limit(void)
3270 int64_t now
= qemu_clock_get_ms(QEMU_CLOCK_REALTIME
);
3271 MigrationState
*s
= migrate_get_current();
3273 bool urgent
= false;
3274 migration_update_counters(s
, now
);
3275 if (qemu_file_rate_limit(s
->to_dst_file
)) {
3277 * Wait for a delay to do rate limiting OR
3278 * something urgent to post the semaphore.
3280 int ms
= s
->iteration_start_time
+ BUFFER_DELAY
- now
;
3281 trace_migration_rate_limit_pre(ms
);
3282 if (qemu_sem_timedwait(&s
->rate_limit_sem
, ms
) == 0) {
3284 * We were woken by one or more urgent things but
3285 * the timedwait will have consumed one of them.
3286 * The service routine for the urgent wake will dec
3287 * the semaphore itself for each item it consumes,
3288 * so add this one we just eat back.
3290 qemu_sem_post(&s
->rate_limit_sem
);
3293 trace_migration_rate_limit_post(urgent
);
3299 * Master migration thread on the source VM.
3300 * It drives the migration and pumps the data down the outgoing channel.
3302 static void *migration_thread(void *opaque
)
3304 MigrationState
*s
= opaque
;
3305 int64_t setup_start
= qemu_clock_get_ms(QEMU_CLOCK_HOST
);
3306 MigThrError thr_error
;
3307 bool urgent
= false;
3309 rcu_register_thread();
3311 object_ref(OBJECT(s
));
3312 update_iteration_initial_status(s
);
3314 qemu_savevm_state_header(s
->to_dst_file
);
3317 * If we opened the return path, we need to make sure dst has it
3320 if (s
->rp_state
.from_dst_file
) {
3321 /* Now tell the dest that it should open its end so it can reply */
3322 qemu_savevm_send_open_return_path(s
->to_dst_file
);
3324 /* And do a ping that will make stuff easier to debug */
3325 qemu_savevm_send_ping(s
->to_dst_file
, 1);
3328 if (migrate_postcopy()) {
3330 * Tell the destination that we *might* want to do postcopy later;
3331 * if the other end can't do postcopy it should fail now, nice and
3334 qemu_savevm_send_postcopy_advise(s
->to_dst_file
);
3337 if (migrate_colo_enabled()) {
3338 /* Notify migration destination that we enable COLO */
3339 qemu_savevm_send_colo_enable(s
->to_dst_file
);
3342 qemu_savevm_state_setup(s
->to_dst_file
);
3344 if (qemu_savevm_state_guest_unplug_pending()) {
3345 migrate_set_state(&s
->state
, MIGRATION_STATUS_SETUP
,
3346 MIGRATION_STATUS_WAIT_UNPLUG
);
3348 while (s
->state
== MIGRATION_STATUS_WAIT_UNPLUG
&&
3349 qemu_savevm_state_guest_unplug_pending()) {
3350 qemu_sem_timedwait(&s
->wait_unplug_sem
, 250);
3353 migrate_set_state(&s
->state
, MIGRATION_STATUS_WAIT_UNPLUG
,
3354 MIGRATION_STATUS_ACTIVE
);
3357 s
->setup_time
= qemu_clock_get_ms(QEMU_CLOCK_HOST
) - setup_start
;
3358 migrate_set_state(&s
->state
, MIGRATION_STATUS_SETUP
,
3359 MIGRATION_STATUS_ACTIVE
);
3361 trace_migration_thread_setup_complete();
3363 while (migration_is_active(s
)) {
3364 if (urgent
|| !qemu_file_rate_limit(s
->to_dst_file
)) {
3365 MigIterateState iter_state
= migration_iteration_run(s
);
3366 if (iter_state
== MIG_ITERATE_SKIP
) {
3368 } else if (iter_state
== MIG_ITERATE_BREAK
) {
3374 * Try to detect any kind of failures, and see whether we
3375 * should stop the migration now.
3377 thr_error
= migration_detect_error(s
);
3378 if (thr_error
== MIG_THR_ERR_FATAL
) {
3379 /* Stop migration */
3381 } else if (thr_error
== MIG_THR_ERR_RECOVERED
) {
3383 * Just recovered from a e.g. network failure, reset all
3384 * the local variables. This is important to avoid
3385 * breaking transferred_bytes and bandwidth calculation
3387 update_iteration_initial_status(s
);
3390 urgent
= migration_rate_limit();
3393 trace_migration_thread_after_loop();
3394 migration_iteration_finish(s
);
3395 object_unref(OBJECT(s
));
3396 rcu_unregister_thread();
3400 void migrate_fd_connect(MigrationState
*s
, Error
*error_in
)
3402 Error
*local_err
= NULL
;
3404 bool resume
= s
->state
== MIGRATION_STATUS_POSTCOPY_PAUSED
;
3406 s
->expected_downtime
= s
->parameters
.downtime_limit
;
3407 s
->cleanup_bh
= qemu_bh_new(migrate_fd_cleanup_bh
, s
);
3409 migrate_fd_error(s
, error_in
);
3410 migrate_fd_cleanup(s
);
3415 /* This is a resumed migration */
3416 rate_limit
= s
->parameters
.max_postcopy_bandwidth
/
3419 /* This is a fresh new migration */
3420 rate_limit
= s
->parameters
.max_bandwidth
/ XFER_LIMIT_RATIO
;
3422 /* Notify before starting migration thread */
3423 notifier_list_notify(&migration_state_notifiers
, s
);
3426 qemu_file_set_rate_limit(s
->to_dst_file
, rate_limit
);
3427 qemu_file_set_blocking(s
->to_dst_file
, true);
3430 * Open the return path. For postcopy, it is used exclusively. For
3431 * precopy, only if user specified "return-path" capability would
3432 * QEMU uses the return path.
3434 if (migrate_postcopy_ram() || migrate_use_return_path()) {
3435 if (open_return_path_on_source(s
, !resume
)) {
3436 error_report("Unable to open return-path for postcopy");
3437 migrate_set_state(&s
->state
, s
->state
, MIGRATION_STATUS_FAILED
);
3438 migrate_fd_cleanup(s
);
3444 /* Wakeup the main migration thread to do the recovery */
3445 migrate_set_state(&s
->state
, MIGRATION_STATUS_POSTCOPY_PAUSED
,
3446 MIGRATION_STATUS_POSTCOPY_RECOVER
);
3447 qemu_sem_post(&s
->postcopy_pause_sem
);
3451 if (multifd_save_setup(&local_err
) != 0) {
3452 error_report_err(local_err
);
3453 migrate_set_state(&s
->state
, MIGRATION_STATUS_SETUP
,
3454 MIGRATION_STATUS_FAILED
);
3455 migrate_fd_cleanup(s
);
3458 qemu_thread_create(&s
->thread
, "live_migration", migration_thread
, s
,
3459 QEMU_THREAD_JOINABLE
);
3460 s
->migration_thread_running
= true;
3463 void migration_global_dump(Monitor
*mon
)
3465 MigrationState
*ms
= migrate_get_current();
3467 monitor_printf(mon
, "globals:\n");
3468 monitor_printf(mon
, "store-global-state: %s\n",
3469 ms
->store_global_state
? "on" : "off");
3470 monitor_printf(mon
, "only-migratable: %s\n",
3471 only_migratable
? "on" : "off");
3472 monitor_printf(mon
, "send-configuration: %s\n",
3473 ms
->send_configuration
? "on" : "off");
3474 monitor_printf(mon
, "send-section-footer: %s\n",
3475 ms
->send_section_footer
? "on" : "off");
3476 monitor_printf(mon
, "decompress-error-check: %s\n",
3477 ms
->decompress_error_check
? "on" : "off");
3478 monitor_printf(mon
, "clear-bitmap-shift: %u\n",
3479 ms
->clear_bitmap_shift
);
3482 #define DEFINE_PROP_MIG_CAP(name, x) \
3483 DEFINE_PROP_BOOL(name, MigrationState, enabled_capabilities[x], false)
3485 static Property migration_properties
[] = {
3486 DEFINE_PROP_BOOL("store-global-state", MigrationState
,
3487 store_global_state
, true),
3488 DEFINE_PROP_BOOL("send-configuration", MigrationState
,
3489 send_configuration
, true),
3490 DEFINE_PROP_BOOL("send-section-footer", MigrationState
,
3491 send_section_footer
, true),
3492 DEFINE_PROP_BOOL("decompress-error-check", MigrationState
,
3493 decompress_error_check
, true),
3494 DEFINE_PROP_UINT8("x-clear-bitmap-shift", MigrationState
,
3495 clear_bitmap_shift
, CLEAR_BITMAP_SHIFT_DEFAULT
),
3497 /* Migration parameters */
3498 DEFINE_PROP_UINT8("x-compress-level", MigrationState
,
3499 parameters
.compress_level
,
3500 DEFAULT_MIGRATE_COMPRESS_LEVEL
),
3501 DEFINE_PROP_UINT8("x-compress-threads", MigrationState
,
3502 parameters
.compress_threads
,
3503 DEFAULT_MIGRATE_COMPRESS_THREAD_COUNT
),
3504 DEFINE_PROP_BOOL("x-compress-wait-thread", MigrationState
,
3505 parameters
.compress_wait_thread
, true),
3506 DEFINE_PROP_UINT8("x-decompress-threads", MigrationState
,
3507 parameters
.decompress_threads
,
3508 DEFAULT_MIGRATE_DECOMPRESS_THREAD_COUNT
),
3509 DEFINE_PROP_UINT8("x-cpu-throttle-initial", MigrationState
,
3510 parameters
.cpu_throttle_initial
,
3511 DEFAULT_MIGRATE_CPU_THROTTLE_INITIAL
),
3512 DEFINE_PROP_UINT8("x-cpu-throttle-increment", MigrationState
,
3513 parameters
.cpu_throttle_increment
,
3514 DEFAULT_MIGRATE_CPU_THROTTLE_INCREMENT
),
3515 DEFINE_PROP_SIZE("x-max-bandwidth", MigrationState
,
3516 parameters
.max_bandwidth
, MAX_THROTTLE
),
3517 DEFINE_PROP_UINT64("x-downtime-limit", MigrationState
,
3518 parameters
.downtime_limit
,
3519 DEFAULT_MIGRATE_SET_DOWNTIME
),
3520 DEFINE_PROP_UINT32("x-checkpoint-delay", MigrationState
,
3521 parameters
.x_checkpoint_delay
,
3522 DEFAULT_MIGRATE_X_CHECKPOINT_DELAY
),
3523 DEFINE_PROP_UINT8("multifd-channels", MigrationState
,
3524 parameters
.multifd_channels
,
3525 DEFAULT_MIGRATE_MULTIFD_CHANNELS
),
3526 DEFINE_PROP_SIZE("xbzrle-cache-size", MigrationState
,
3527 parameters
.xbzrle_cache_size
,
3528 DEFAULT_MIGRATE_XBZRLE_CACHE_SIZE
),
3529 DEFINE_PROP_SIZE("max-postcopy-bandwidth", MigrationState
,
3530 parameters
.max_postcopy_bandwidth
,
3531 DEFAULT_MIGRATE_MAX_POSTCOPY_BANDWIDTH
),
3532 DEFINE_PROP_UINT8("max-cpu-throttle", MigrationState
,
3533 parameters
.max_cpu_throttle
,
3534 DEFAULT_MIGRATE_MAX_CPU_THROTTLE
),
3535 DEFINE_PROP_SIZE("announce-initial", MigrationState
,
3536 parameters
.announce_initial
,
3537 DEFAULT_MIGRATE_ANNOUNCE_INITIAL
),
3538 DEFINE_PROP_SIZE("announce-max", MigrationState
,
3539 parameters
.announce_max
,
3540 DEFAULT_MIGRATE_ANNOUNCE_MAX
),
3541 DEFINE_PROP_SIZE("announce-rounds", MigrationState
,
3542 parameters
.announce_rounds
,
3543 DEFAULT_MIGRATE_ANNOUNCE_ROUNDS
),
3544 DEFINE_PROP_SIZE("announce-step", MigrationState
,
3545 parameters
.announce_step
,
3546 DEFAULT_MIGRATE_ANNOUNCE_STEP
),
3548 /* Migration capabilities */
3549 DEFINE_PROP_MIG_CAP("x-xbzrle", MIGRATION_CAPABILITY_XBZRLE
),
3550 DEFINE_PROP_MIG_CAP("x-rdma-pin-all", MIGRATION_CAPABILITY_RDMA_PIN_ALL
),
3551 DEFINE_PROP_MIG_CAP("x-auto-converge", MIGRATION_CAPABILITY_AUTO_CONVERGE
),
3552 DEFINE_PROP_MIG_CAP("x-zero-blocks", MIGRATION_CAPABILITY_ZERO_BLOCKS
),
3553 DEFINE_PROP_MIG_CAP("x-compress", MIGRATION_CAPABILITY_COMPRESS
),
3554 DEFINE_PROP_MIG_CAP("x-events", MIGRATION_CAPABILITY_EVENTS
),
3555 DEFINE_PROP_MIG_CAP("x-postcopy-ram", MIGRATION_CAPABILITY_POSTCOPY_RAM
),
3556 DEFINE_PROP_MIG_CAP("x-colo", MIGRATION_CAPABILITY_X_COLO
),
3557 DEFINE_PROP_MIG_CAP("x-release-ram", MIGRATION_CAPABILITY_RELEASE_RAM
),
3558 DEFINE_PROP_MIG_CAP("x-block", MIGRATION_CAPABILITY_BLOCK
),
3559 DEFINE_PROP_MIG_CAP("x-return-path", MIGRATION_CAPABILITY_RETURN_PATH
),
3560 DEFINE_PROP_MIG_CAP("x-multifd", MIGRATION_CAPABILITY_MULTIFD
),
3562 DEFINE_PROP_END_OF_LIST(),
3565 static void migration_class_init(ObjectClass
*klass
, void *data
)
3567 DeviceClass
*dc
= DEVICE_CLASS(klass
);
3569 dc
->user_creatable
= false;
3570 device_class_set_props(dc
, migration_properties
);
3573 static void migration_instance_finalize(Object
*obj
)
3575 MigrationState
*ms
= MIGRATION_OBJ(obj
);
3576 MigrationParameters
*params
= &ms
->parameters
;
3578 qemu_mutex_destroy(&ms
->error_mutex
);
3579 qemu_mutex_destroy(&ms
->qemu_file_lock
);
3580 g_free(params
->tls_hostname
);
3581 g_free(params
->tls_creds
);
3582 qemu_sem_destroy(&ms
->wait_unplug_sem
);
3583 qemu_sem_destroy(&ms
->rate_limit_sem
);
3584 qemu_sem_destroy(&ms
->pause_sem
);
3585 qemu_sem_destroy(&ms
->postcopy_pause_sem
);
3586 qemu_sem_destroy(&ms
->postcopy_pause_rp_sem
);
3587 qemu_sem_destroy(&ms
->rp_state
.rp_sem
);
3588 error_free(ms
->error
);
3591 static void migration_instance_init(Object
*obj
)
3593 MigrationState
*ms
= MIGRATION_OBJ(obj
);
3594 MigrationParameters
*params
= &ms
->parameters
;
3596 ms
->state
= MIGRATION_STATUS_NONE
;
3598 ms
->pages_per_second
= -1;
3599 qemu_sem_init(&ms
->pause_sem
, 0);
3600 qemu_mutex_init(&ms
->error_mutex
);
3602 params
->tls_hostname
= g_strdup("");
3603 params
->tls_creds
= g_strdup("");
3605 /* Set has_* up only for parameter checks */
3606 params
->has_compress_level
= true;
3607 params
->has_compress_threads
= true;
3608 params
->has_decompress_threads
= true;
3609 params
->has_cpu_throttle_initial
= true;
3610 params
->has_cpu_throttle_increment
= true;
3611 params
->has_max_bandwidth
= true;
3612 params
->has_downtime_limit
= true;
3613 params
->has_x_checkpoint_delay
= true;
3614 params
->has_block_incremental
= true;
3615 params
->has_multifd_channels
= true;
3616 params
->has_xbzrle_cache_size
= true;
3617 params
->has_max_postcopy_bandwidth
= true;
3618 params
->has_max_cpu_throttle
= true;
3619 params
->has_announce_initial
= true;
3620 params
->has_announce_max
= true;
3621 params
->has_announce_rounds
= true;
3622 params
->has_announce_step
= true;
3624 qemu_sem_init(&ms
->postcopy_pause_sem
, 0);
3625 qemu_sem_init(&ms
->postcopy_pause_rp_sem
, 0);
3626 qemu_sem_init(&ms
->rp_state
.rp_sem
, 0);
3627 qemu_sem_init(&ms
->rate_limit_sem
, 0);
3628 qemu_sem_init(&ms
->wait_unplug_sem
, 0);
3629 qemu_mutex_init(&ms
->qemu_file_lock
);
3633 * Return true if check pass, false otherwise. Error will be put
3634 * inside errp if provided.
3636 static bool migration_object_check(MigrationState
*ms
, Error
**errp
)
3638 MigrationCapabilityStatusList
*head
= NULL
;
3639 /* Assuming all off */
3640 bool cap_list
[MIGRATION_CAPABILITY__MAX
] = { 0 }, ret
;
3643 if (!migrate_params_check(&ms
->parameters
, errp
)) {
3647 for (i
= 0; i
< MIGRATION_CAPABILITY__MAX
; i
++) {
3648 if (ms
->enabled_capabilities
[i
]) {
3649 head
= migrate_cap_add(head
, i
, true);
3653 ret
= migrate_caps_check(cap_list
, head
, errp
);
3655 /* It works with head == NULL */
3656 qapi_free_MigrationCapabilityStatusList(head
);
3661 static const TypeInfo migration_type
= {
3662 .name
= TYPE_MIGRATION
,
3664 * NOTE: TYPE_MIGRATION is not really a device, as the object is
3665 * not created using qdev_create(), it is not attached to the qdev
3666 * device tree, and it is never realized.
3668 * TODO: Make this TYPE_OBJECT once QOM provides something like
3669 * TYPE_DEVICE's "-global" properties.
3671 .parent
= TYPE_DEVICE
,
3672 .class_init
= migration_class_init
,
3673 .class_size
= sizeof(MigrationClass
),
3674 .instance_size
= sizeof(MigrationState
),
3675 .instance_init
= migration_instance_init
,
3676 .instance_finalize
= migration_instance_finalize
,
3679 static void register_migration_types(void)
3681 type_register_static(&migration_type
);
3684 type_init(register_migration_types
);