2 * COarse-grain LOck-stepping Virtual Machines for Non-stop Service (COLO)
3 * (a.k.a. Fault Tolerance or Continuous Replication)
5 * Copyright (c) 2016 HUAWEI TECHNOLOGIES CO., LTD.
6 * Copyright (c) 2016 FUJITSU LIMITED
7 * Copyright (c) 2016 Intel Corporation
9 * This work is licensed under the terms of the GNU GPL, version 2 or
10 * later. See the COPYING file in the top-level directory.
13 #include "qemu/osdep.h"
14 #include "sysemu/sysemu.h"
15 #include "qapi/error.h"
16 #include "qapi/qapi-commands-migration.h"
17 #include "qemu-file-channel.h"
18 #include "migration.h"
19 #include "qemu-file.h"
21 #include "migration/colo.h"
23 #include "io/channel-buffer.h"
25 #include "qemu/error-report.h"
26 #include "qemu/main-loop.h"
28 #include "migration/failover.h"
29 #include "migration/ram.h"
30 #ifdef CONFIG_REPLICATION
31 #include "replication.h"
33 #include "net/colo-compare.h"
35 #include "block/block.h"
36 #include "qapi/qapi-events-migration.h"
37 #include "qapi/qmp/qerror.h"
38 #include "sysemu/cpus.h"
39 #include "sysemu/runstate.h"
40 #include "net/filter.h"
42 static bool vmstate_loading;
43 static Notifier packets_compare_notifier;
45 /* User need to know colo mode after COLO failover */
46 static COLOMode last_colo_mode;
48 #define COLO_BUFFER_BASE_SIZE (4 * 1024 * 1024)
50 bool migration_in_colo_state(void)
52 MigrationState *s = migrate_get_current();
54 return (s->state == MIGRATION_STATUS_COLO);
57 bool migration_incoming_in_colo_state(void)
59 MigrationIncomingState *mis = migration_incoming_get_current();
61 return mis && (mis->state == MIGRATION_STATUS_COLO);
64 static bool colo_runstate_is_stopped(void)
66 return runstate_check(RUN_STATE_COLO) || !runstate_is_running();
69 static void secondary_vm_do_failover(void)
71 /* COLO needs enable block-replication */
72 #ifdef CONFIG_REPLICATION
74 MigrationIncomingState *mis = migration_incoming_get_current();
75 Error *local_err = NULL;
77 /* Can not do failover during the process of VM's loading VMstate, Or
78 * it will break the secondary VM.
80 if (vmstate_loading) {
81 old_state = failover_set_state(FAILOVER_STATUS_ACTIVE,
82 FAILOVER_STATUS_RELAUNCH);
83 if (old_state != FAILOVER_STATUS_ACTIVE) {
84 error_report("Unknown error while do failover for secondary VM,"
85 "old_state: %s", FailoverStatus_str(old_state));
90 migrate_set_state(&mis->state, MIGRATION_STATUS_COLO,
91 MIGRATION_STATUS_COMPLETED);
93 replication_stop_all(true, &local_err);
95 error_report_err(local_err);
99 /* Notify all filters of all NIC to do checkpoint */
100 colo_notify_filters_event(COLO_EVENT_FAILOVER, &local_err);
102 error_report_err(local_err);
106 error_report("\"-S\" qemu option will be ignored in secondary side");
107 /* recover runstate to normal migration finish state */
111 * Make sure COLO incoming thread not block in recv or send,
112 * If mis->from_src_file and mis->to_src_file use the same fd,
113 * The second shutdown() will return -1, we ignore this value,
116 if (mis->from_src_file) {
117 qemu_file_shutdown(mis->from_src_file);
119 if (mis->to_src_file) {
120 qemu_file_shutdown(mis->to_src_file);
123 old_state = failover_set_state(FAILOVER_STATUS_ACTIVE,
124 FAILOVER_STATUS_COMPLETED);
125 if (old_state != FAILOVER_STATUS_ACTIVE) {
126 error_report("Incorrect state (%s) while doing failover for "
127 "secondary VM", FailoverStatus_str(old_state));
130 /* Notify COLO incoming thread that failover work is finished */
131 qemu_sem_post(&mis->colo_incoming_sem);
133 /* For Secondary VM, jump to incoming co */
134 if (mis->migration_incoming_co) {
135 qemu_coroutine_enter(mis->migration_incoming_co);
142 static void primary_vm_do_failover(void)
144 #ifdef CONFIG_REPLICATION
145 MigrationState *s = migrate_get_current();
147 Error *local_err = NULL;
149 migrate_set_state(&s->state, MIGRATION_STATUS_COLO,
150 MIGRATION_STATUS_COMPLETED);
152 * kick COLO thread which might wait at
153 * qemu_sem_wait(&s->colo_checkpoint_sem).
155 colo_checkpoint_notify(migrate_get_current());
158 * Wake up COLO thread which may blocked in recv() or send(),
159 * The s->rp_state.from_dst_file and s->to_dst_file may use the
160 * same fd, but we still shutdown the fd for twice, it is harmless.
162 if (s->to_dst_file) {
163 qemu_file_shutdown(s->to_dst_file);
165 if (s->rp_state.from_dst_file) {
166 qemu_file_shutdown(s->rp_state.from_dst_file);
169 old_state = failover_set_state(FAILOVER_STATUS_ACTIVE,
170 FAILOVER_STATUS_COMPLETED);
171 if (old_state != FAILOVER_STATUS_ACTIVE) {
172 error_report("Incorrect state (%s) while doing failover for Primary VM",
173 FailoverStatus_str(old_state));
177 replication_stop_all(true, &local_err);
179 error_report_err(local_err);
183 /* Notify COLO thread that failover work is finished */
184 qemu_sem_post(&s->colo_exit_sem);
190 COLOMode get_colo_mode(void)
192 if (migration_in_colo_state()) {
193 return COLO_MODE_PRIMARY;
194 } else if (migration_incoming_in_colo_state()) {
195 return COLO_MODE_SECONDARY;
197 return COLO_MODE_NONE;
201 void colo_do_failover(void)
203 /* Make sure VM stopped while failover happened. */
204 if (!colo_runstate_is_stopped()) {
205 vm_stop_force_state(RUN_STATE_COLO);
208 switch (get_colo_mode()) {
209 case COLO_MODE_PRIMARY:
210 primary_vm_do_failover();
212 case COLO_MODE_SECONDARY:
213 secondary_vm_do_failover();
216 error_report("colo_do_failover failed because the colo mode"
217 " could not be obtained");
221 #ifdef CONFIG_REPLICATION
222 void qmp_xen_set_replication(bool enable, bool primary,
223 bool has_failover, bool failover,
226 ReplicationMode mode = primary ?
227 REPLICATION_MODE_PRIMARY :
228 REPLICATION_MODE_SECONDARY;
230 if (has_failover && enable) {
231 error_setg(errp, "Parameter 'failover' is only for"
232 " stopping replication");
237 replication_start_all(mode, errp);
242 replication_stop_all(failover, failover ? NULL : errp);
246 ReplicationStatus *qmp_query_xen_replication_status(Error **errp)
249 ReplicationStatus *s = g_new0(ReplicationStatus, 1);
251 replication_get_error_all(&err);
255 s->desc = g_strdup(error_get_pretty(err));
264 void qmp_xen_colo_do_checkpoint(Error **errp)
268 replication_do_checkpoint_all(&err);
270 error_propagate(errp, err);
273 /* Notify all filters of all NIC to do checkpoint */
274 colo_notify_filters_event(COLO_EVENT_CHECKPOINT, errp);
278 COLOStatus *qmp_query_colo_status(Error **errp)
280 COLOStatus *s = g_new0(COLOStatus, 1);
282 s->mode = get_colo_mode();
283 s->last_mode = last_colo_mode;
285 switch (failover_get_state()) {
286 case FAILOVER_STATUS_NONE:
287 s->reason = COLO_EXIT_REASON_NONE;
289 case FAILOVER_STATUS_COMPLETED:
290 s->reason = COLO_EXIT_REASON_REQUEST;
293 if (migration_in_colo_state()) {
294 s->reason = COLO_EXIT_REASON_PROCESSING;
296 s->reason = COLO_EXIT_REASON_ERROR;
303 static void colo_send_message(QEMUFile *f, COLOMessage msg,
308 if (msg >= COLO_MESSAGE__MAX) {
309 error_setg(errp, "%s: Invalid message", __func__);
312 qemu_put_be32(f, msg);
315 ret = qemu_file_get_error(f);
317 error_setg_errno(errp, -ret, "Can't send COLO message");
319 trace_colo_send_message(COLOMessage_str(msg));
322 static void colo_send_message_value(QEMUFile *f, COLOMessage msg,
323 uint64_t value, Error **errp)
325 Error *local_err = NULL;
328 colo_send_message(f, msg, &local_err);
330 error_propagate(errp, local_err);
333 qemu_put_be64(f, value);
336 ret = qemu_file_get_error(f);
338 error_setg_errno(errp, -ret, "Failed to send value for message:%s",
339 COLOMessage_str(msg));
343 static COLOMessage colo_receive_message(QEMUFile *f, Error **errp)
348 msg = qemu_get_be32(f);
349 ret = qemu_file_get_error(f);
351 error_setg_errno(errp, -ret, "Can't receive COLO message");
354 if (msg >= COLO_MESSAGE__MAX) {
355 error_setg(errp, "%s: Invalid message", __func__);
358 trace_colo_receive_message(COLOMessage_str(msg));
362 static void colo_receive_check_message(QEMUFile *f, COLOMessage expect_msg,
366 Error *local_err = NULL;
368 msg = colo_receive_message(f, &local_err);
370 error_propagate(errp, local_err);
373 if (msg != expect_msg) {
374 error_setg(errp, "Unexpected COLO message %d, expected %d",
379 static uint64_t colo_receive_message_value(QEMUFile *f, uint32_t expect_msg,
382 Error *local_err = NULL;
386 colo_receive_check_message(f, expect_msg, &local_err);
388 error_propagate(errp, local_err);
392 value = qemu_get_be64(f);
393 ret = qemu_file_get_error(f);
395 error_setg_errno(errp, -ret, "Failed to get value for COLO message: %s",
396 COLOMessage_str(expect_msg));
401 static int colo_do_checkpoint_transaction(MigrationState *s,
402 QIOChannelBuffer *bioc,
405 Error *local_err = NULL;
408 colo_send_message(s->to_dst_file, COLO_MESSAGE_CHECKPOINT_REQUEST,
414 colo_receive_check_message(s->rp_state.from_dst_file,
415 COLO_MESSAGE_CHECKPOINT_REPLY, &local_err);
419 /* Reset channel-buffer directly */
420 qio_channel_io_seek(QIO_CHANNEL(bioc), 0, 0, NULL);
423 qemu_mutex_lock_iothread();
424 if (failover_get_state() != FAILOVER_STATUS_NONE) {
425 qemu_mutex_unlock_iothread();
428 vm_stop_force_state(RUN_STATE_COLO);
429 qemu_mutex_unlock_iothread();
430 trace_colo_vm_state_change("run", "stop");
432 * Failover request bh could be called after vm_stop_force_state(),
433 * So we need check failover_request_is_active() again.
435 if (failover_get_state() != FAILOVER_STATUS_NONE) {
439 qemu_event_reset(&s->colo_checkpoint_event);
440 colo_notify_compares_event(NULL, COLO_EVENT_CHECKPOINT, &local_err);
445 /* Disable block migration */
446 migrate_set_block_enabled(false, &local_err);
450 qemu_mutex_lock_iothread();
452 #ifdef CONFIG_REPLICATION
453 replication_do_checkpoint_all(&local_err);
455 qemu_mutex_unlock_iothread();
462 colo_send_message(s->to_dst_file, COLO_MESSAGE_VMSTATE_SEND, &local_err);
464 qemu_mutex_unlock_iothread();
467 /* Note: device state is saved into buffer */
468 ret = qemu_save_device_state(fb);
470 qemu_mutex_unlock_iothread();
475 * Only save VM's live state, which not including device state.
476 * TODO: We may need a timeout mechanism to prevent COLO process
477 * to be blocked here.
479 qemu_savevm_live_state(s->to_dst_file);
484 * We need the size of the VMstate data in Secondary side,
485 * With which we can decide how much data should be read.
487 colo_send_message_value(s->to_dst_file, COLO_MESSAGE_VMSTATE_SIZE,
488 bioc->usage, &local_err);
493 qemu_put_buffer(s->to_dst_file, bioc->data, bioc->usage);
494 qemu_fflush(s->to_dst_file);
495 ret = qemu_file_get_error(s->to_dst_file);
500 colo_receive_check_message(s->rp_state.from_dst_file,
501 COLO_MESSAGE_VMSTATE_RECEIVED, &local_err);
506 colo_receive_check_message(s->rp_state.from_dst_file,
507 COLO_MESSAGE_VMSTATE_LOADED, &local_err);
514 qemu_mutex_lock_iothread();
516 qemu_mutex_unlock_iothread();
517 trace_colo_vm_state_change("stop", "run");
521 error_report_err(local_err);
526 static void colo_compare_notify_checkpoint(Notifier *notifier, void *data)
528 colo_checkpoint_notify(data);
531 static void colo_process_checkpoint(MigrationState *s)
533 QIOChannelBuffer *bioc;
535 int64_t current_time = qemu_clock_get_ms(QEMU_CLOCK_HOST);
536 Error *local_err = NULL;
539 last_colo_mode = get_colo_mode();
540 if (last_colo_mode != COLO_MODE_PRIMARY) {
541 error_report("COLO mode must be COLO_MODE_PRIMARY");
545 failover_init_state();
547 s->rp_state.from_dst_file = qemu_file_get_return_path(s->to_dst_file);
548 if (!s->rp_state.from_dst_file) {
549 error_report("Open QEMUFile from_dst_file failed");
553 packets_compare_notifier.notify = colo_compare_notify_checkpoint;
554 colo_compare_register_notifier(&packets_compare_notifier);
557 * Wait for Secondary finish loading VM states and enter COLO
560 colo_receive_check_message(s->rp_state.from_dst_file,
561 COLO_MESSAGE_CHECKPOINT_READY, &local_err);
565 bioc = qio_channel_buffer_new(COLO_BUFFER_BASE_SIZE);
566 fb = qemu_fopen_channel_output(QIO_CHANNEL(bioc));
567 object_unref(OBJECT(bioc));
569 qemu_mutex_lock_iothread();
570 #ifdef CONFIG_REPLICATION
571 replication_start_all(REPLICATION_MODE_PRIMARY, &local_err);
573 qemu_mutex_unlock_iothread();
581 qemu_mutex_unlock_iothread();
582 trace_colo_vm_state_change("stop", "run");
584 timer_mod(s->colo_delay_timer,
585 current_time + s->parameters.x_checkpoint_delay);
587 while (s->state == MIGRATION_STATUS_COLO) {
588 if (failover_get_state() != FAILOVER_STATUS_NONE) {
589 error_report("failover request");
593 qemu_event_wait(&s->colo_checkpoint_event);
595 if (s->state != MIGRATION_STATUS_COLO) {
598 ret = colo_do_checkpoint_transaction(s, bioc, fb);
605 /* Throw the unreported error message after exited from loop */
607 error_report_err(local_err);
615 * There are only two reasons we can get here, some error happened
616 * or the user triggered failover.
618 switch (failover_get_state()) {
619 case FAILOVER_STATUS_COMPLETED:
620 qapi_event_send_colo_exit(COLO_MODE_PRIMARY,
621 COLO_EXIT_REASON_REQUEST);
624 qapi_event_send_colo_exit(COLO_MODE_PRIMARY,
625 COLO_EXIT_REASON_ERROR);
628 /* Hope this not to be too long to wait here */
629 qemu_sem_wait(&s->colo_exit_sem);
630 qemu_sem_destroy(&s->colo_exit_sem);
633 * It is safe to unregister notifier after failover finished.
634 * Besides, colo_delay_timer and colo_checkpoint_sem can't be
635 * released befor unregister notifier, or there will be use-after-free
638 colo_compare_unregister_notifier(&packets_compare_notifier);
639 timer_del(s->colo_delay_timer);
640 timer_free(s->colo_delay_timer);
641 qemu_event_destroy(&s->colo_checkpoint_event);
644 * Must be called after failover BH is completed,
645 * Or the failover BH may shutdown the wrong fd that
646 * re-used by other threads after we release here.
648 if (s->rp_state.from_dst_file) {
649 qemu_fclose(s->rp_state.from_dst_file);
653 void colo_checkpoint_notify(void *opaque)
655 MigrationState *s = opaque;
656 int64_t next_notify_time;
658 qemu_event_set(&s->colo_checkpoint_event);
659 s->colo_checkpoint_time = qemu_clock_get_ms(QEMU_CLOCK_HOST);
660 next_notify_time = s->colo_checkpoint_time +
661 s->parameters.x_checkpoint_delay;
662 timer_mod(s->colo_delay_timer, next_notify_time);
665 void migrate_start_colo_process(MigrationState *s)
667 qemu_mutex_unlock_iothread();
668 qemu_event_init(&s->colo_checkpoint_event, false);
669 s->colo_delay_timer = timer_new_ms(QEMU_CLOCK_HOST,
670 colo_checkpoint_notify, s);
672 qemu_sem_init(&s->colo_exit_sem, 0);
673 migrate_set_state(&s->state, MIGRATION_STATUS_ACTIVE,
674 MIGRATION_STATUS_COLO);
675 colo_process_checkpoint(s);
676 qemu_mutex_lock_iothread();
679 static void colo_incoming_process_checkpoint(MigrationIncomingState *mis,
680 QEMUFile *fb, QIOChannelBuffer *bioc, Error **errp)
684 Error *local_err = NULL;
687 qemu_mutex_lock_iothread();
688 vm_stop_force_state(RUN_STATE_COLO);
689 trace_colo_vm_state_change("run", "stop");
690 qemu_mutex_unlock_iothread();
692 /* FIXME: This is unnecessary for periodic checkpoint mode */
693 colo_send_message(mis->to_src_file, COLO_MESSAGE_CHECKPOINT_REPLY,
696 error_propagate(errp, local_err);
700 colo_receive_check_message(mis->from_src_file,
701 COLO_MESSAGE_VMSTATE_SEND, &local_err);
703 error_propagate(errp, local_err);
707 qemu_mutex_lock_iothread();
708 cpu_synchronize_all_pre_loadvm();
709 ret = qemu_loadvm_state_main(mis->from_src_file, mis);
710 qemu_mutex_unlock_iothread();
713 error_setg(errp, "Load VM's live state (ram) error");
717 value = colo_receive_message_value(mis->from_src_file,
718 COLO_MESSAGE_VMSTATE_SIZE, &local_err);
720 error_propagate(errp, local_err);
725 * Read VM device state data into channel buffer,
726 * It's better to re-use the memory allocated.
727 * Here we need to handle the channel buffer directly.
729 if (value > bioc->capacity) {
730 bioc->capacity = value;
731 bioc->data = g_realloc(bioc->data, bioc->capacity);
733 total_size = qemu_get_buffer(mis->from_src_file, bioc->data, value);
734 if (total_size != value) {
735 error_setg(errp, "Got %" PRIu64 " VMState data, less than expected"
736 " %" PRIu64, total_size, value);
739 bioc->usage = total_size;
740 qio_channel_io_seek(QIO_CHANNEL(bioc), 0, 0, NULL);
742 colo_send_message(mis->to_src_file, COLO_MESSAGE_VMSTATE_RECEIVED,
745 error_propagate(errp, local_err);
749 qemu_mutex_lock_iothread();
750 vmstate_loading = true;
751 ret = qemu_load_device_state(fb);
753 error_setg(errp, "COLO: load device state failed");
754 qemu_mutex_unlock_iothread();
758 #ifdef CONFIG_REPLICATION
759 replication_get_error_all(&local_err);
761 error_propagate(errp, local_err);
762 qemu_mutex_unlock_iothread();
766 /* discard colo disk buffer */
767 replication_do_checkpoint_all(&local_err);
769 error_propagate(errp, local_err);
770 qemu_mutex_unlock_iothread();
776 /* Notify all filters of all NIC to do checkpoint */
777 colo_notify_filters_event(COLO_EVENT_CHECKPOINT, &local_err);
780 error_propagate(errp, local_err);
781 qemu_mutex_unlock_iothread();
785 vmstate_loading = false;
787 trace_colo_vm_state_change("stop", "run");
788 qemu_mutex_unlock_iothread();
790 if (failover_get_state() == FAILOVER_STATUS_RELAUNCH) {
791 failover_set_state(FAILOVER_STATUS_RELAUNCH,
792 FAILOVER_STATUS_NONE);
793 failover_request_active(NULL);
797 colo_send_message(mis->to_src_file, COLO_MESSAGE_VMSTATE_LOADED,
800 error_propagate(errp, local_err);
804 static void colo_wait_handle_message(MigrationIncomingState *mis,
805 QEMUFile *fb, QIOChannelBuffer *bioc, Error **errp)
808 Error *local_err = NULL;
810 msg = colo_receive_message(mis->from_src_file, &local_err);
812 error_propagate(errp, local_err);
817 case COLO_MESSAGE_CHECKPOINT_REQUEST:
818 colo_incoming_process_checkpoint(mis, fb, bioc, errp);
821 error_setg(errp, "Got unknown COLO message: %d", msg);
826 void *colo_process_incoming_thread(void *opaque)
828 MigrationIncomingState *mis = opaque;
830 QIOChannelBuffer *bioc = NULL; /* Cache incoming device state */
831 Error *local_err = NULL;
833 rcu_register_thread();
834 qemu_sem_init(&mis->colo_incoming_sem, 0);
836 migrate_set_state(&mis->state, MIGRATION_STATUS_ACTIVE,
837 MIGRATION_STATUS_COLO);
839 last_colo_mode = get_colo_mode();
840 if (last_colo_mode != COLO_MODE_SECONDARY) {
841 error_report("COLO mode must be COLO_MODE_SECONDARY");
845 failover_init_state();
847 mis->to_src_file = qemu_file_get_return_path(mis->from_src_file);
848 if (!mis->to_src_file) {
849 error_report("COLO incoming thread: Open QEMUFile to_src_file failed");
853 * Note: the communication between Primary side and Secondary side
854 * should be sequential, we set the fd to unblocked in migration incoming
855 * coroutine, and here we are in the COLO incoming thread, so it is ok to
856 * set the fd back to blocked.
858 qemu_file_set_blocking(mis->from_src_file, true);
860 colo_incoming_start_dirty_log();
862 bioc = qio_channel_buffer_new(COLO_BUFFER_BASE_SIZE);
863 fb = qemu_fopen_channel_input(QIO_CHANNEL(bioc));
864 object_unref(OBJECT(bioc));
866 qemu_mutex_lock_iothread();
867 #ifdef CONFIG_REPLICATION
868 replication_start_all(REPLICATION_MODE_SECONDARY, &local_err);
870 qemu_mutex_unlock_iothread();
877 trace_colo_vm_state_change("stop", "run");
878 qemu_mutex_unlock_iothread();
880 colo_send_message(mis->to_src_file, COLO_MESSAGE_CHECKPOINT_READY,
886 while (mis->state == MIGRATION_STATUS_COLO) {
887 colo_wait_handle_message(mis, fb, bioc, &local_err);
889 error_report_err(local_err);
892 if (failover_get_state() != FAILOVER_STATUS_NONE) {
893 error_report("failover request");
899 vmstate_loading = false;
902 * There are only two reasons we can get here, some error happened
903 * or the user triggered failover.
905 switch (failover_get_state()) {
906 case FAILOVER_STATUS_COMPLETED:
907 qapi_event_send_colo_exit(COLO_MODE_SECONDARY,
908 COLO_EXIT_REASON_REQUEST);
911 qapi_event_send_colo_exit(COLO_MODE_SECONDARY,
912 COLO_EXIT_REASON_ERROR);
919 /* Hope this not to be too long to loop here */
920 qemu_sem_wait(&mis->colo_incoming_sem);
921 qemu_sem_destroy(&mis->colo_incoming_sem);
922 /* Must be called after failover BH is completed */
923 if (mis->to_src_file) {
924 qemu_fclose(mis->to_src_file);
925 mis->to_src_file = NULL;
928 rcu_unregister_thread();