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.
14 #ifndef QEMU_MIGRATION_H
15 #define QEMU_MIGRATION_H
17 #include "qemu-common.h"
18 #include "qemu/thread.h"
19 #include "qapi-types.h"
20 #include "exec/cpu-common.h"
21 #include "qemu/coroutine_int.h"
23 #include "io/channel.h"
25 /* State for the incoming migration */
26 struct MigrationIncomingState
{
27 QEMUFile
*from_src_file
;
30 * Free at the start of the main state load, set as the main thread finishes
33 QemuEvent main_thread_load_event
;
35 size_t largest_page_size
;
36 bool have_fault_thread
;
37 QemuThread fault_thread
;
38 QemuSemaphore fault_thread_sem
;
40 bool have_listen_thread
;
41 QemuThread listen_thread
;
42 QemuSemaphore listen_thread_sem
;
44 /* For the kernel to send us notifications */
46 /* To tell the fault_thread to quit */
47 int userfault_quit_fd
;
48 QEMUFile
*to_src_file
;
49 QemuMutex rp_mutex
; /* We send replies from multiple threads */
50 void *postcopy_tmp_page
;
51 void *postcopy_tmp_zero_page
;
57 bool have_colo_incoming_thread
;
58 QemuThread colo_incoming_thread
;
59 /* The coroutine we should enter (back) after failover */
60 Coroutine
*migration_incoming_co
;
61 QemuSemaphore colo_incoming_sem
;
64 MigrationIncomingState
*migration_incoming_get_current(void);
65 void migration_incoming_state_destroy(void);
67 #define TYPE_MIGRATION "migration"
69 #define MIGRATION_CLASS(klass) \
70 OBJECT_CLASS_CHECK(MigrationClass, (klass), TYPE_MIGRATION)
71 #define MIGRATION_OBJ(obj) \
72 OBJECT_CHECK(MigrationState, (obj), TYPE_MIGRATION)
73 #define MIGRATION_GET_CLASS(obj) \
74 OBJECT_GET_CLASS(MigrationClass, (obj), TYPE_MIGRATION)
76 typedef struct MigrationClass
{
78 DeviceClass parent_class
;
84 DeviceState parent_obj
;
91 QEMUFile
*to_dst_file
;
93 /* params from 'migrate-set-parameters' */
94 MigrationParameters parameters
;
98 /* State related to return path */
100 QEMUFile
*from_dst_file
;
101 QemuThread rp_thread
;
108 int64_t expected_downtime
;
109 bool enabled_capabilities
[MIGRATION_CAPABILITY__MAX
];
110 int64_t xbzrle_cache_size
;
113 /* Flag set once the migration has been asked to enter postcopy */
115 /* Flag set after postcopy has sent the device state */
116 bool postcopy_after_devices
;
118 /* Flag set once the migration thread is running (and needs joining) */
119 bool migration_thread_running
;
121 /* Flag set once the migration thread called bdrv_inactivate_all */
124 /* Migration is paused due to pause-before-switchover */
125 QemuSemaphore pause_sem
;
127 /* The semaphore is used to notify COLO thread that failover is finished */
128 QemuSemaphore colo_exit_sem
;
130 /* The semaphore is used to notify COLO thread to do checkpoint */
131 QemuSemaphore colo_checkpoint_sem
;
132 int64_t colo_checkpoint_time
;
133 QEMUTimer
*colo_delay_timer
;
135 /* The last error that occurred */
137 /* Do we have to clean up -b/-i from old migrate parameters */
138 /* This feature is deprecated and will be removed */
139 bool must_remove_block_options
;
142 * Global switch on whether we need to store the global state
145 bool store_global_state
;
147 /* Whether the VM is only allowing for migratable devices */
148 bool only_migratable
;
150 /* Whether we send QEMU_VM_CONFIGURATION during migration */
151 bool send_configuration
;
152 /* Whether we send section footer during migration */
153 bool send_section_footer
;
156 void migrate_set_state(int *state
, int old_state
, int new_state
);
158 void migration_fd_process_incoming(QEMUFile
*f
);
159 void migration_ioc_process_incoming(QIOChannel
*ioc
);
161 bool migration_has_all_channels(void);
163 uint64_t migrate_max_downtime(void);
165 void migrate_fd_error(MigrationState
*s
, const Error
*error
);
167 void migrate_fd_connect(MigrationState
*s
);
169 MigrationState
*migrate_init(void);
170 bool migration_is_blocked(Error
**errp
);
171 /* True if outgoing migration has entered postcopy phase */
172 bool migration_in_postcopy(void);
173 MigrationState
*migrate_get_current(void);
175 bool migrate_postcopy(void);
177 bool migrate_release_ram(void);
178 bool migrate_postcopy_ram(void);
179 bool migrate_zero_blocks(void);
181 bool migrate_auto_converge(void);
182 bool migrate_use_multifd(void);
183 bool migrate_pause_before_switchover(void);
184 int migrate_multifd_channels(void);
185 int migrate_multifd_page_count(void);
187 int migrate_use_xbzrle(void);
188 int64_t migrate_xbzrle_cache_size(void);
189 bool migrate_colo_enabled(void);
191 bool migrate_use_block(void);
192 bool migrate_use_block_incremental(void);
193 bool migrate_use_return_path(void);
195 bool migrate_use_compression(void);
196 int migrate_compress_level(void);
197 int migrate_compress_threads(void);
198 int migrate_decompress_threads(void);
199 bool migrate_use_events(void);
201 /* Sending on the return path - generic and then for each message type */
202 void migrate_send_rp_shut(MigrationIncomingState
*mis
,
204 void migrate_send_rp_pong(MigrationIncomingState
*mis
,
206 void migrate_send_rp_req_pages(MigrationIncomingState
*mis
, const char* rbname
,
207 ram_addr_t start
, size_t len
);