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 "migration/failover.h"
27 #ifdef CONFIG_REPLICATION
28 #include "replication.h"
30 #include "net/colo-compare.h"
32 #include "block/block.h"
33 #include "qapi/qapi-events-migration.h"
34 #include "qapi/qmp/qerror.h"
35 #include "sysemu/cpus.h"
36 #include "net/filter.h"
38 static bool vmstate_loading;
39 static Notifier packets_compare_notifier;
41 #define COLO_BUFFER_BASE_SIZE (4 * 1024 * 1024)
43 bool migration_in_colo_state(void)
45 MigrationState *s = migrate_get_current();
47 return (s->state == MIGRATION_STATUS_COLO);
50 bool migration_incoming_in_colo_state(void)
52 MigrationIncomingState *mis = migration_incoming_get_current();
54 return mis && (mis->state == MIGRATION_STATUS_COLO);
57 static bool colo_runstate_is_stopped(void)
59 return runstate_check(RUN_STATE_COLO) || !runstate_is_running();
62 static void secondary_vm_do_failover(void)
64 /* COLO needs enable block-replication */
65 #ifdef CONFIG_REPLICATION
67 MigrationIncomingState *mis = migration_incoming_get_current();
68 Error *local_err = NULL;
70 /* Can not do failover during the process of VM's loading VMstate, Or
71 * it will break the secondary VM.
73 if (vmstate_loading) {
74 old_state = failover_set_state(FAILOVER_STATUS_ACTIVE,
75 FAILOVER_STATUS_RELAUNCH);
76 if (old_state != FAILOVER_STATUS_ACTIVE) {
77 error_report("Unknown error while do failover for secondary VM,"
78 "old_state: %s", FailoverStatus_str(old_state));
83 migrate_set_state(&mis->state, MIGRATION_STATUS_COLO,
84 MIGRATION_STATUS_COMPLETED);
86 replication_stop_all(true, &local_err);
88 error_report_err(local_err);
91 /* Notify all filters of all NIC to do checkpoint */
92 colo_notify_filters_event(COLO_EVENT_FAILOVER, &local_err);
94 error_report_err(local_err);
98 error_report("\"-S\" qemu option will be ignored in secondary side");
99 /* recover runstate to normal migration finish state */
103 * Make sure COLO incoming thread not block in recv or send,
104 * If mis->from_src_file and mis->to_src_file use the same fd,
105 * The second shutdown() will return -1, we ignore this value,
108 if (mis->from_src_file) {
109 qemu_file_shutdown(mis->from_src_file);
111 if (mis->to_src_file) {
112 qemu_file_shutdown(mis->to_src_file);
115 old_state = failover_set_state(FAILOVER_STATUS_ACTIVE,
116 FAILOVER_STATUS_COMPLETED);
117 if (old_state != FAILOVER_STATUS_ACTIVE) {
118 error_report("Incorrect state (%s) while doing failover for "
119 "secondary VM", FailoverStatus_str(old_state));
122 /* Notify COLO incoming thread that failover work is finished */
123 qemu_sem_post(&mis->colo_incoming_sem);
125 /* For Secondary VM, jump to incoming co */
126 if (mis->migration_incoming_co) {
127 qemu_coroutine_enter(mis->migration_incoming_co);
134 static void primary_vm_do_failover(void)
136 #ifdef CONFIG_REPLICATION
137 MigrationState *s = migrate_get_current();
139 Error *local_err = NULL;
141 migrate_set_state(&s->state, MIGRATION_STATUS_COLO,
142 MIGRATION_STATUS_COMPLETED);
144 * kick COLO thread which might wait at
145 * qemu_sem_wait(&s->colo_checkpoint_sem).
147 colo_checkpoint_notify(migrate_get_current());
150 * Wake up COLO thread which may blocked in recv() or send(),
151 * The s->rp_state.from_dst_file and s->to_dst_file may use the
152 * same fd, but we still shutdown the fd for twice, it is harmless.
154 if (s->to_dst_file) {
155 qemu_file_shutdown(s->to_dst_file);
157 if (s->rp_state.from_dst_file) {
158 qemu_file_shutdown(s->rp_state.from_dst_file);
161 old_state = failover_set_state(FAILOVER_STATUS_ACTIVE,
162 FAILOVER_STATUS_COMPLETED);
163 if (old_state != FAILOVER_STATUS_ACTIVE) {
164 error_report("Incorrect state (%s) while doing failover for Primary VM",
165 FailoverStatus_str(old_state));
169 replication_stop_all(true, &local_err);
171 error_report_err(local_err);
175 /* Notify COLO thread that failover work is finished */
176 qemu_sem_post(&s->colo_exit_sem);
182 COLOMode get_colo_mode(void)
184 if (migration_in_colo_state()) {
185 return COLO_MODE_PRIMARY;
186 } else if (migration_incoming_in_colo_state()) {
187 return COLO_MODE_SECONDARY;
189 return COLO_MODE_NONE;
193 void colo_do_failover(MigrationState *s)
195 /* Make sure VM stopped while failover happened. */
196 if (!colo_runstate_is_stopped()) {
197 vm_stop_force_state(RUN_STATE_COLO);
200 switch (get_colo_mode()) {
201 case COLO_MODE_PRIMARY:
202 primary_vm_do_failover();
204 case COLO_MODE_SECONDARY:
205 secondary_vm_do_failover();
208 error_report("colo_do_failover failed because the colo mode"
209 " could not be obtained");
213 #ifdef CONFIG_REPLICATION
214 void qmp_xen_set_replication(bool enable, bool primary,
215 bool has_failover, bool failover,
218 ReplicationMode mode = primary ?
219 REPLICATION_MODE_PRIMARY :
220 REPLICATION_MODE_SECONDARY;
222 if (has_failover && enable) {
223 error_setg(errp, "Parameter 'failover' is only for"
224 " stopping replication");
229 replication_start_all(mode, errp);
234 replication_stop_all(failover, failover ? NULL : errp);
238 ReplicationStatus *qmp_query_xen_replication_status(Error **errp)
241 ReplicationStatus *s = g_new0(ReplicationStatus, 1);
243 replication_get_error_all(&err);
247 s->desc = g_strdup(error_get_pretty(err));
256 void qmp_xen_colo_do_checkpoint(Error **errp)
258 replication_do_checkpoint_all(errp);
262 COLOStatus *qmp_query_colo_status(Error **errp)
264 COLOStatus *s = g_new0(COLOStatus, 1);
266 s->mode = get_colo_mode();
268 switch (failover_get_state()) {
269 case FAILOVER_STATUS_NONE:
270 s->reason = COLO_EXIT_REASON_NONE;
272 case FAILOVER_STATUS_COMPLETED:
273 s->reason = COLO_EXIT_REASON_REQUEST;
276 if (migration_in_colo_state()) {
277 s->reason = COLO_EXIT_REASON_PROCESSING;
279 s->reason = COLO_EXIT_REASON_ERROR;
286 static void colo_send_message(QEMUFile *f, COLOMessage msg,
291 if (msg >= COLO_MESSAGE__MAX) {
292 error_setg(errp, "%s: Invalid message", __func__);
295 qemu_put_be32(f, msg);
298 ret = qemu_file_get_error(f);
300 error_setg_errno(errp, -ret, "Can't send COLO message");
302 trace_colo_send_message(COLOMessage_str(msg));
305 static void colo_send_message_value(QEMUFile *f, COLOMessage msg,
306 uint64_t value, Error **errp)
308 Error *local_err = NULL;
311 colo_send_message(f, msg, &local_err);
313 error_propagate(errp, local_err);
316 qemu_put_be64(f, value);
319 ret = qemu_file_get_error(f);
321 error_setg_errno(errp, -ret, "Failed to send value for message:%s",
322 COLOMessage_str(msg));
326 static COLOMessage colo_receive_message(QEMUFile *f, Error **errp)
331 msg = qemu_get_be32(f);
332 ret = qemu_file_get_error(f);
334 error_setg_errno(errp, -ret, "Can't receive COLO message");
337 if (msg >= COLO_MESSAGE__MAX) {
338 error_setg(errp, "%s: Invalid message", __func__);
341 trace_colo_receive_message(COLOMessage_str(msg));
345 static void colo_receive_check_message(QEMUFile *f, COLOMessage expect_msg,
349 Error *local_err = NULL;
351 msg = colo_receive_message(f, &local_err);
353 error_propagate(errp, local_err);
356 if (msg != expect_msg) {
357 error_setg(errp, "Unexpected COLO message %d, expected %d",
362 static uint64_t colo_receive_message_value(QEMUFile *f, uint32_t expect_msg,
365 Error *local_err = NULL;
369 colo_receive_check_message(f, expect_msg, &local_err);
371 error_propagate(errp, local_err);
375 value = qemu_get_be64(f);
376 ret = qemu_file_get_error(f);
378 error_setg_errno(errp, -ret, "Failed to get value for COLO message: %s",
379 COLOMessage_str(expect_msg));
384 static int colo_do_checkpoint_transaction(MigrationState *s,
385 QIOChannelBuffer *bioc,
388 Error *local_err = NULL;
391 colo_send_message(s->to_dst_file, COLO_MESSAGE_CHECKPOINT_REQUEST,
397 colo_receive_check_message(s->rp_state.from_dst_file,
398 COLO_MESSAGE_CHECKPOINT_REPLY, &local_err);
402 /* Reset channel-buffer directly */
403 qio_channel_io_seek(QIO_CHANNEL(bioc), 0, 0, NULL);
406 qemu_mutex_lock_iothread();
407 if (failover_get_state() != FAILOVER_STATUS_NONE) {
408 qemu_mutex_unlock_iothread();
411 vm_stop_force_state(RUN_STATE_COLO);
412 qemu_mutex_unlock_iothread();
413 trace_colo_vm_state_change("run", "stop");
415 * Failover request bh could be called after vm_stop_force_state(),
416 * So we need check failover_request_is_active() again.
418 if (failover_get_state() != FAILOVER_STATUS_NONE) {
422 colo_notify_compares_event(NULL, COLO_EVENT_CHECKPOINT, &local_err);
427 /* Disable block migration */
428 migrate_set_block_enabled(false, &local_err);
429 qemu_mutex_lock_iothread();
431 #ifdef CONFIG_REPLICATION
432 replication_do_checkpoint_all(&local_err);
434 qemu_mutex_unlock_iothread();
441 colo_send_message(s->to_dst_file, COLO_MESSAGE_VMSTATE_SEND, &local_err);
443 qemu_mutex_unlock_iothread();
446 /* Note: device state is saved into buffer */
447 ret = qemu_save_device_state(fb);
449 qemu_mutex_unlock_iothread();
454 * Only save VM's live state, which not including device state.
455 * TODO: We may need a timeout mechanism to prevent COLO process
456 * to be blocked here.
458 qemu_savevm_live_state(s->to_dst_file);
463 * We need the size of the VMstate data in Secondary side,
464 * With which we can decide how much data should be read.
466 colo_send_message_value(s->to_dst_file, COLO_MESSAGE_VMSTATE_SIZE,
467 bioc->usage, &local_err);
472 qemu_put_buffer(s->to_dst_file, bioc->data, bioc->usage);
473 qemu_fflush(s->to_dst_file);
474 ret = qemu_file_get_error(s->to_dst_file);
479 colo_receive_check_message(s->rp_state.from_dst_file,
480 COLO_MESSAGE_VMSTATE_RECEIVED, &local_err);
485 colo_receive_check_message(s->rp_state.from_dst_file,
486 COLO_MESSAGE_VMSTATE_LOADED, &local_err);
493 qemu_mutex_lock_iothread();
495 qemu_mutex_unlock_iothread();
496 trace_colo_vm_state_change("stop", "run");
500 error_report_err(local_err);
505 static void colo_compare_notify_checkpoint(Notifier *notifier, void *data)
507 colo_checkpoint_notify(data);
510 static void colo_process_checkpoint(MigrationState *s)
512 QIOChannelBuffer *bioc;
514 int64_t current_time = qemu_clock_get_ms(QEMU_CLOCK_HOST);
515 Error *local_err = NULL;
518 failover_init_state();
520 s->rp_state.from_dst_file = qemu_file_get_return_path(s->to_dst_file);
521 if (!s->rp_state.from_dst_file) {
522 error_report("Open QEMUFile from_dst_file failed");
526 packets_compare_notifier.notify = colo_compare_notify_checkpoint;
527 colo_compare_register_notifier(&packets_compare_notifier);
530 * Wait for Secondary finish loading VM states and enter COLO
533 colo_receive_check_message(s->rp_state.from_dst_file,
534 COLO_MESSAGE_CHECKPOINT_READY, &local_err);
538 bioc = qio_channel_buffer_new(COLO_BUFFER_BASE_SIZE);
539 fb = qemu_fopen_channel_output(QIO_CHANNEL(bioc));
540 object_unref(OBJECT(bioc));
542 qemu_mutex_lock_iothread();
543 #ifdef CONFIG_REPLICATION
544 replication_start_all(REPLICATION_MODE_PRIMARY, &local_err);
546 qemu_mutex_unlock_iothread();
554 qemu_mutex_unlock_iothread();
555 trace_colo_vm_state_change("stop", "run");
557 timer_mod(s->colo_delay_timer,
558 current_time + s->parameters.x_checkpoint_delay);
560 while (s->state == MIGRATION_STATUS_COLO) {
561 if (failover_get_state() != FAILOVER_STATUS_NONE) {
562 error_report("failover request");
566 qemu_sem_wait(&s->colo_checkpoint_sem);
568 if (s->state != MIGRATION_STATUS_COLO) {
571 ret = colo_do_checkpoint_transaction(s, bioc, fb);
578 /* Throw the unreported error message after exited from loop */
580 error_report_err(local_err);
588 * There are only two reasons we can get here, some error happened
589 * or the user triggered failover.
591 switch (failover_get_state()) {
592 case FAILOVER_STATUS_COMPLETED:
593 qapi_event_send_colo_exit(COLO_MODE_PRIMARY,
594 COLO_EXIT_REASON_REQUEST);
597 qapi_event_send_colo_exit(COLO_MODE_PRIMARY,
598 COLO_EXIT_REASON_ERROR);
601 /* Hope this not to be too long to wait here */
602 qemu_sem_wait(&s->colo_exit_sem);
603 qemu_sem_destroy(&s->colo_exit_sem);
606 * It is safe to unregister notifier after failover finished.
607 * Besides, colo_delay_timer and colo_checkpoint_sem can't be
608 * released befor unregister notifier, or there will be use-after-free
611 colo_compare_unregister_notifier(&packets_compare_notifier);
612 timer_del(s->colo_delay_timer);
613 timer_free(s->colo_delay_timer);
614 qemu_sem_destroy(&s->colo_checkpoint_sem);
617 * Must be called after failover BH is completed,
618 * Or the failover BH may shutdown the wrong fd that
619 * re-used by other threads after we release here.
621 if (s->rp_state.from_dst_file) {
622 qemu_fclose(s->rp_state.from_dst_file);
626 void colo_checkpoint_notify(void *opaque)
628 MigrationState *s = opaque;
629 int64_t next_notify_time;
631 qemu_sem_post(&s->colo_checkpoint_sem);
632 s->colo_checkpoint_time = qemu_clock_get_ms(QEMU_CLOCK_HOST);
633 next_notify_time = s->colo_checkpoint_time +
634 s->parameters.x_checkpoint_delay;
635 timer_mod(s->colo_delay_timer, next_notify_time);
638 void migrate_start_colo_process(MigrationState *s)
640 qemu_mutex_unlock_iothread();
641 qemu_sem_init(&s->colo_checkpoint_sem, 0);
642 s->colo_delay_timer = timer_new_ms(QEMU_CLOCK_HOST,
643 colo_checkpoint_notify, s);
645 qemu_sem_init(&s->colo_exit_sem, 0);
646 migrate_set_state(&s->state, MIGRATION_STATUS_ACTIVE,
647 MIGRATION_STATUS_COLO);
648 colo_process_checkpoint(s);
649 qemu_mutex_lock_iothread();
652 static void colo_wait_handle_message(QEMUFile *f, int *checkpoint_request,
656 Error *local_err = NULL;
658 msg = colo_receive_message(f, &local_err);
660 error_propagate(errp, local_err);
665 case COLO_MESSAGE_CHECKPOINT_REQUEST:
666 *checkpoint_request = 1;
669 *checkpoint_request = 0;
670 error_setg(errp, "Got unknown COLO message: %d", msg);
675 void *colo_process_incoming_thread(void *opaque)
677 MigrationIncomingState *mis = opaque;
679 QIOChannelBuffer *bioc = NULL; /* Cache incoming device state */
682 Error *local_err = NULL;
685 rcu_register_thread();
686 qemu_sem_init(&mis->colo_incoming_sem, 0);
688 migrate_set_state(&mis->state, MIGRATION_STATUS_ACTIVE,
689 MIGRATION_STATUS_COLO);
691 failover_init_state();
693 mis->to_src_file = qemu_file_get_return_path(mis->from_src_file);
694 if (!mis->to_src_file) {
695 error_report("COLO incoming thread: Open QEMUFile to_src_file failed");
699 * Note: the communication between Primary side and Secondary side
700 * should be sequential, we set the fd to unblocked in migration incoming
701 * coroutine, and here we are in the COLO incoming thread, so it is ok to
702 * set the fd back to blocked.
704 qemu_file_set_blocking(mis->from_src_file, true);
706 bioc = qio_channel_buffer_new(COLO_BUFFER_BASE_SIZE);
707 fb = qemu_fopen_channel_input(QIO_CHANNEL(bioc));
708 object_unref(OBJECT(bioc));
710 qemu_mutex_lock_iothread();
711 #ifdef CONFIG_REPLICATION
712 replication_start_all(REPLICATION_MODE_SECONDARY, &local_err);
714 qemu_mutex_unlock_iothread();
721 trace_colo_vm_state_change("stop", "run");
722 qemu_mutex_unlock_iothread();
724 colo_send_message(mis->to_src_file, COLO_MESSAGE_CHECKPOINT_READY,
730 while (mis->state == MIGRATION_STATUS_COLO) {
733 colo_wait_handle_message(mis->from_src_file, &request, &local_err);
738 if (failover_get_state() != FAILOVER_STATUS_NONE) {
739 error_report("failover request");
743 qemu_mutex_lock_iothread();
744 vm_stop_force_state(RUN_STATE_COLO);
745 trace_colo_vm_state_change("run", "stop");
746 qemu_mutex_unlock_iothread();
748 /* FIXME: This is unnecessary for periodic checkpoint mode */
749 colo_send_message(mis->to_src_file, COLO_MESSAGE_CHECKPOINT_REPLY,
755 colo_receive_check_message(mis->from_src_file,
756 COLO_MESSAGE_VMSTATE_SEND, &local_err);
761 qemu_mutex_lock_iothread();
762 cpu_synchronize_all_pre_loadvm();
763 ret = qemu_loadvm_state_main(mis->from_src_file, mis);
764 qemu_mutex_unlock_iothread();
767 error_report("Load VM's live state (ram) error");
771 value = colo_receive_message_value(mis->from_src_file,
772 COLO_MESSAGE_VMSTATE_SIZE, &local_err);
778 * Read VM device state data into channel buffer,
779 * It's better to re-use the memory allocated.
780 * Here we need to handle the channel buffer directly.
782 if (value > bioc->capacity) {
783 bioc->capacity = value;
784 bioc->data = g_realloc(bioc->data, bioc->capacity);
786 total_size = qemu_get_buffer(mis->from_src_file, bioc->data, value);
787 if (total_size != value) {
788 error_report("Got %" PRIu64 " VMState data, less than expected"
789 " %" PRIu64, total_size, value);
792 bioc->usage = total_size;
793 qio_channel_io_seek(QIO_CHANNEL(bioc), 0, 0, NULL);
795 colo_send_message(mis->to_src_file, COLO_MESSAGE_VMSTATE_RECEIVED,
801 qemu_mutex_lock_iothread();
802 vmstate_loading = true;
803 ret = qemu_load_device_state(fb);
805 error_report("COLO: load device state failed");
806 qemu_mutex_unlock_iothread();
810 #ifdef CONFIG_REPLICATION
811 replication_get_error_all(&local_err);
813 qemu_mutex_unlock_iothread();
817 /* discard colo disk buffer */
818 replication_do_checkpoint_all(&local_err);
820 qemu_mutex_unlock_iothread();
826 /* Notify all filters of all NIC to do checkpoint */
827 colo_notify_filters_event(COLO_EVENT_CHECKPOINT, &local_err);
830 qemu_mutex_unlock_iothread();
834 vmstate_loading = false;
836 trace_colo_vm_state_change("stop", "run");
837 qemu_mutex_unlock_iothread();
839 if (failover_get_state() == FAILOVER_STATUS_RELAUNCH) {
840 failover_set_state(FAILOVER_STATUS_RELAUNCH,
841 FAILOVER_STATUS_NONE);
842 failover_request_active(NULL);
846 colo_send_message(mis->to_src_file, COLO_MESSAGE_VMSTATE_LOADED,
854 vmstate_loading = false;
855 /* Throw the unreported error message after exited from loop */
857 error_report_err(local_err);
861 * There are only two reasons we can get here, some error happened
862 * or the user triggered failover.
864 switch (failover_get_state()) {
865 case FAILOVER_STATUS_COMPLETED:
866 qapi_event_send_colo_exit(COLO_MODE_SECONDARY,
867 COLO_EXIT_REASON_REQUEST);
870 qapi_event_send_colo_exit(COLO_MODE_SECONDARY,
871 COLO_EXIT_REASON_ERROR);
878 /* Hope this not to be too long to loop here */
879 qemu_sem_wait(&mis->colo_incoming_sem);
880 qemu_sem_destroy(&mis->colo_incoming_sem);
881 /* Must be called after failover BH is completed */
882 if (mis->to_src_file) {
883 qemu_fclose(mis->to_src_file);
884 mis->to_src_file = NULL;
887 rcu_unregister_thread();