]>
Commit | Line | Data |
---|---|---|
5bb7910a AL |
1 | /* |
2 | * QEMU live migration | |
3 | * | |
4 | * Copyright IBM, Corp. 2008 | |
5 | * | |
6 | * Authors: | |
7 | * Anthony Liguori <aliguori@us.ibm.com> | |
8 | * | |
9 | * This work is licensed under the terms of the GNU GPL, version 2. See | |
10 | * the COPYING file in the top-level directory. | |
11 | * | |
12 | */ | |
13 | ||
14 | #ifndef QEMU_MIGRATION_H | |
15 | #define QEMU_MIGRATION_H | |
16 | ||
7b1b5d19 | 17 | #include "qapi/qmp/qdict.h" |
376253ec | 18 | #include "qemu-common.h" |
9848a404 | 19 | #include "qemu/thread.h" |
1de7afc9 | 20 | #include "qemu/notify.h" |
caf71f86 | 21 | #include "migration/vmstate.h" |
bbf6da32 | 22 | #include "qapi-types.h" |
43487c67 | 23 | #include "exec/cpu-common.h" |
376253ec | 24 | |
b5503338 EH |
25 | #define QEMU_VM_FILE_MAGIC 0x5145564d |
26 | #define QEMU_VM_FILE_VERSION_COMPAT 0x00000002 | |
27 | #define QEMU_VM_FILE_VERSION 0x00000003 | |
28 | ||
29 | #define QEMU_VM_EOF 0x00 | |
30 | #define QEMU_VM_SECTION_START 0x01 | |
31 | #define QEMU_VM_SECTION_PART 0x02 | |
32 | #define QEMU_VM_SECTION_END 0x03 | |
33 | #define QEMU_VM_SECTION_FULL 0x04 | |
34 | #define QEMU_VM_SUBSECTION 0x05 | |
8118f095 | 35 | #define QEMU_VM_VMDESCRIPTION 0x06 |
61964c23 | 36 | #define QEMU_VM_CONFIGURATION 0x07 |
c76ca188 | 37 | #define QEMU_VM_COMMAND 0x08 |
f68945d4 | 38 | #define QEMU_VM_SECTION_FOOTER 0x7e |
b5503338 | 39 | |
6607ae23 IY |
40 | struct MigrationParams { |
41 | bool blk; | |
42 | bool shared; | |
43 | }; | |
44 | ||
6decec93 DDAG |
45 | /* Messages sent on the return path from destination to source */ |
46 | enum mig_rp_message_type { | |
47 | MIG_RP_MSG_INVALID = 0, /* Must be 0 */ | |
48 | MIG_RP_MSG_SHUT, /* sibling will not send any more RP messages */ | |
49 | MIG_RP_MSG_PONG, /* Response to a PING; data (seq: be32 ) */ | |
50 | ||
1e2d90eb DDAG |
51 | MIG_RP_MSG_REQ_PAGES_ID, /* data (start: be64, len: be32, id: string) */ |
52 | MIG_RP_MSG_REQ_PAGES, /* data (start: be64, len: be32) */ | |
53 | ||
6decec93 DDAG |
54 | MIG_RP_MSG_MAX |
55 | }; | |
56 | ||
1a8f46f8 | 57 | typedef QLIST_HEAD(, LoadStateEntry) LoadStateEntry_Head; |
093e3c42 DDAG |
58 | |
59 | /* The current postcopy state is read/set by postcopy_state_get/set | |
60 | * which update it atomically. | |
61 | * The state is updated as postcopy messages are received, and | |
62 | * in general only one thread should be writing to the state at any one | |
63 | * time, initially the main thread and then the listen thread; | |
64 | * Corner cases are where either thread finishes early and/or errors. | |
65 | * The state is checked as messages are received to ensure that | |
66 | * the source is sending us messages in the correct order. | |
67 | * The state is also used by the RAM reception code to know if it | |
68 | * has to place pages atomically, and the cleanup code at the end of | |
69 | * the main thread to know if it has to delay cleanup until the end | |
70 | * of postcopy. | |
71 | */ | |
72 | typedef enum { | |
73 | POSTCOPY_INCOMING_NONE = 0, /* Initial state - no postcopy */ | |
74 | POSTCOPY_INCOMING_ADVISE, | |
75 | POSTCOPY_INCOMING_DISCARD, | |
76 | POSTCOPY_INCOMING_LISTENING, | |
77 | POSTCOPY_INCOMING_RUNNING, | |
78 | POSTCOPY_INCOMING_END | |
79 | } PostcopyState; | |
80 | ||
bca7856a DDAG |
81 | /* State for the incoming migration */ |
82 | struct MigrationIncomingState { | |
42e2aa56 | 83 | QEMUFile *from_src_file; |
1a8f46f8 | 84 | |
7b89bf27 DDAG |
85 | /* |
86 | * Free at the start of the main state load, set as the main thread finishes | |
87 | * loading state. | |
88 | */ | |
89 | QemuEvent main_thread_load_event; | |
90 | ||
c4faeed2 | 91 | bool have_fault_thread; |
f0a227ad DDAG |
92 | QemuThread fault_thread; |
93 | QemuSemaphore fault_thread_sem; | |
94 | ||
c76201ab DDAG |
95 | bool have_listen_thread; |
96 | QemuThread listen_thread; | |
97 | QemuSemaphore listen_thread_sem; | |
98 | ||
1caddf8a DDAG |
99 | /* For the kernel to send us notifications */ |
100 | int userfault_fd; | |
c4faeed2 DDAG |
101 | /* To tell the fault_thread to quit */ |
102 | int userfault_quit_fd; | |
2e37701e | 103 | QEMUFile *to_src_file; |
6decec93 | 104 | QemuMutex rp_mutex; /* We send replies from multiple threads */ |
696ed9a9 | 105 | void *postcopy_tmp_page; |
2e37701e | 106 | |
0aa6aefc DL |
107 | QEMUBH *bh; |
108 | ||
93d7af6f | 109 | int state; |
1a8f46f8 DDAG |
110 | /* See savevm.c */ |
111 | LoadStateEntry_Head loadvm_handlers; | |
bca7856a DDAG |
112 | }; |
113 | ||
114 | MigrationIncomingState *migration_incoming_get_current(void); | |
115 | MigrationIncomingState *migration_incoming_state_new(QEMUFile *f); | |
116 | void migration_incoming_state_destroy(void); | |
117 | ||
6c595cde DDAG |
118 | /* |
119 | * An outstanding page request, on the source, having been received | |
120 | * and queued | |
121 | */ | |
122 | struct MigrationSrcPageRequest { | |
123 | RAMBlock *rb; | |
124 | hwaddr offset; | |
125 | hwaddr len; | |
126 | ||
127 | QSIMPLEQ_ENTRY(MigrationSrcPageRequest) next_req; | |
128 | }; | |
129 | ||
22f00a44 | 130 | struct MigrationState |
065e2813 | 131 | { |
9848a404 JQ |
132 | size_t bytes_xfer; |
133 | size_t xfer_limit; | |
9848a404 | 134 | QemuThread thread; |
bb1fadc4 | 135 | QEMUBH *cleanup_bh; |
89a02a9f | 136 | QEMUFile *to_dst_file; |
2594f56d DB |
137 | |
138 | /* New style params from 'migrate-set-parameters' */ | |
139 | MigrationParameters parameters; | |
f8bbc128 | 140 | |
f8bbc128 | 141 | int state; |
2594f56d | 142 | /* Old style params from 'migrate' command */ |
6607ae23 | 143 | MigrationParams params; |
70b20477 DDAG |
144 | |
145 | /* State related to return path */ | |
146 | struct { | |
147 | QEMUFile *from_dst_file; | |
148 | QemuThread rp_thread; | |
149 | bool error; | |
150 | } rp_state; | |
151 | ||
7e114f8c | 152 | double mbps; |
d5f8a570 | 153 | int64_t total_time; |
9c5a9fcf | 154 | int64_t downtime; |
2c52ddf1 | 155 | int64_t expected_downtime; |
8d017193 | 156 | int64_t dirty_pages_rate; |
90f8ae72 | 157 | int64_t dirty_bytes_rate; |
7fb1cf16 | 158 | bool enabled_capabilities[MIGRATION_CAPABILITY__MAX]; |
17ad9b35 | 159 | int64_t xbzrle_cache_size; |
ed4fbd10 | 160 | int64_t setup_time; |
58570ed8 | 161 | int64_t dirty_sync_count; |
d3bf5418 DDAG |
162 | /* Count of requests incoming from destination */ |
163 | int64_t postcopy_requests; | |
4886a1bc DDAG |
164 | |
165 | /* Flag set once the migration has been asked to enter postcopy */ | |
166 | bool start_postcopy; | |
b82fc321 DDAG |
167 | /* Flag set after postcopy has sent the device state */ |
168 | bool postcopy_after_devices; | |
1d34e4bf DDAG |
169 | |
170 | /* Flag set once the migration thread is running (and needs joining) */ | |
171 | bool migration_thread_running; | |
6c595cde DDAG |
172 | |
173 | /* Queue of outstanding page requests from the destination */ | |
174 | QemuMutex src_page_req_mutex; | |
175 | QSIMPLEQ_HEAD(src_page_requests, MigrationSrcPageRequest) src_page_requests; | |
176 | /* The RAMBlock used in the last src_page_request */ | |
177 | RAMBlock *last_req_rb; | |
d59ce6f3 DB |
178 | |
179 | /* The last error that occurred */ | |
180 | Error *error; | |
065e2813 AL |
181 | }; |
182 | ||
48781e5b HZ |
183 | void migrate_set_state(int *state, int old_state, int new_state); |
184 | ||
22724f49 | 185 | void migration_fd_process_incoming(QEMUFile *f); |
511c0231 | 186 | |
43eaae28 | 187 | void qemu_start_incoming_migration(const char *uri, Error **errp); |
5bb7910a | 188 | |
22724f49 DB |
189 | void migration_channel_process_incoming(MigrationState *s, |
190 | QIOChannel *ioc); | |
48f07489 | 191 | |
22724f49 DB |
192 | void migration_tls_channel_process_incoming(MigrationState *s, |
193 | QIOChannel *ioc, | |
194 | Error **errp); | |
e1226365 | 195 | |
22724f49 DB |
196 | void migration_channel_connect(MigrationState *s, |
197 | QIOChannel *ioc, | |
198 | const char *hostname); | |
e1226365 | 199 | |
22724f49 DB |
200 | void migration_tls_channel_connect(MigrationState *s, |
201 | QIOChannel *ioc, | |
202 | const char *hostname, | |
203 | Error **errp); | |
48f07489 | 204 | |
a0a3fd60 GC |
205 | uint64_t migrate_max_downtime(void); |
206 | ||
43eaae28 | 207 | void exec_start_incoming_migration(const char *host_port, Error **errp); |
065e2813 | 208 | |
f37afb5a | 209 | void exec_start_outgoing_migration(MigrationState *s, const char *host_port, Error **errp); |
065e2813 | 210 | |
43eaae28 | 211 | void tcp_start_incoming_migration(const char *host_port, Error **errp); |
34c9dd8e | 212 | |
f37afb5a | 213 | void tcp_start_outgoing_migration(MigrationState *s, const char *host_port, Error **errp); |
34c9dd8e | 214 | |
43eaae28 | 215 | void unix_start_incoming_migration(const char *path, Error **errp); |
4951f65b | 216 | |
f37afb5a | 217 | void unix_start_outgoing_migration(MigrationState *s, const char *path, Error **errp); |
4951f65b | 218 | |
43eaae28 | 219 | void fd_start_incoming_migration(const char *path, Error **errp); |
5ac1fad3 | 220 | |
f37afb5a | 221 | void fd_start_outgoing_migration(MigrationState *s, const char *fdname, Error **errp); |
5ac1fad3 | 222 | |
2da776db MH |
223 | void rdma_start_outgoing_migration(void *opaque, const char *host_port, Error **errp); |
224 | ||
225 | void rdma_start_incoming_migration(const char *host_port, Error **errp); | |
226 | ||
d59ce6f3 | 227 | void migrate_fd_error(MigrationState *s, const Error *error); |
065e2813 | 228 | |
22f00a44 | 229 | void migrate_fd_connect(MigrationState *s); |
065e2813 | 230 | |
99a0db9b GH |
231 | void add_migration_state_change_notifier(Notifier *notify); |
232 | void remove_migration_state_change_notifier(Notifier *notify); | |
aefeb18b | 233 | MigrationState *migrate_init(const MigrationParams *params); |
24f3902b | 234 | bool migration_is_blocked(Error **errp); |
02edd2e7 | 235 | bool migration_in_setup(MigrationState *); |
7073693b | 236 | bool migration_has_finished(MigrationState *); |
afe2df69 | 237 | bool migration_has_failed(MigrationState *); |
9ec055ae DDAG |
238 | /* True if outgoing migration has entered postcopy phase */ |
239 | bool migration_in_postcopy(MigrationState *); | |
b82fc321 DDAG |
240 | /* ...and after the device transmission */ |
241 | bool migration_in_postcopy_after_devices(MigrationState *); | |
859bc756 | 242 | MigrationState *migrate_get_current(void); |
99a0db9b | 243 | |
8706d2d5 LL |
244 | void migrate_compress_threads_create(void); |
245 | void migrate_compress_threads_join(void); | |
3fcb38c2 LL |
246 | void migrate_decompress_threads_create(void); |
247 | void migrate_decompress_threads_join(void); | |
adc56dda BS |
248 | uint64_t ram_bytes_remaining(void); |
249 | uint64_t ram_bytes_transferred(void); | |
250 | uint64_t ram_bytes_total(void); | |
905f26f2 | 251 | void free_xbzrle_decoded_buf(void); |
adc56dda | 252 | |
2b0ce079 MH |
253 | void acct_update_position(QEMUFile *f, size_t size, bool zero); |
254 | ||
004d4c10 OW |
255 | uint64_t dup_mig_bytes_transferred(void); |
256 | uint64_t dup_mig_pages_transferred(void); | |
f1c72795 PL |
257 | uint64_t skipped_mig_bytes_transferred(void); |
258 | uint64_t skipped_mig_pages_transferred(void); | |
004d4c10 OW |
259 | uint64_t norm_mig_bytes_transferred(void); |
260 | uint64_t norm_mig_pages_transferred(void); | |
f36d55af OW |
261 | uint64_t xbzrle_mig_bytes_transferred(void); |
262 | uint64_t xbzrle_mig_pages_transferred(void); | |
263 | uint64_t xbzrle_mig_pages_overflow(void); | |
264 | uint64_t xbzrle_mig_pages_cache_miss(void); | |
8bc39233 | 265 | double xbzrle_mig_cache_miss_rate(void); |
004d4c10 | 266 | |
44c3b58c | 267 | void ram_handle_compressed(void *host, uint8_t ch, uint64_t size); |
4f2e4252 | 268 | void ram_debug_dump_bitmap(unsigned long *todump, bool expected); |
e0b266f0 DDAG |
269 | /* For outgoing discard bitmap */ |
270 | int ram_postcopy_send_discard_bitmap(MigrationState *ms); | |
271 | /* For incoming postcopy discard */ | |
272 | int ram_discard_range(MigrationIncomingState *mis, const char *block_name, | |
273 | uint64_t start, size_t length); | |
1caddf8a | 274 | int ram_postcopy_incoming_init(MigrationIncomingState *mis); |
44c3b58c | 275 | |
fa2756b7 AL |
276 | /** |
277 | * @migrate_add_blocker - prevent migration from proceeding | |
278 | * | |
279 | * @reason - an error to be returned whenever migration is attempted | |
280 | */ | |
281 | void migrate_add_blocker(Error *reason); | |
282 | ||
283 | /** | |
284 | * @migrate_del_blocker - remove a blocking error from migration | |
285 | * | |
286 | * @reason - the error blocking migration | |
287 | */ | |
288 | void migrate_del_blocker(Error *reason); | |
289 | ||
53dd370c | 290 | bool migrate_postcopy_ram(void); |
323004a3 | 291 | bool migrate_zero_blocks(void); |
60d9222c | 292 | |
bde1e2ec CV |
293 | bool migrate_auto_converge(void); |
294 | ||
302dfbeb OW |
295 | int xbzrle_encode_buffer(uint8_t *old_buf, uint8_t *new_buf, int slen, |
296 | uint8_t *dst, int dlen); | |
297 | int xbzrle_decode_buffer(uint8_t *src, int slen, uint8_t *dst, int dlen); | |
298 | ||
17ad9b35 OW |
299 | int migrate_use_xbzrle(void); |
300 | int64_t migrate_xbzrle_cache_size(void); | |
301 | ||
9e1ba4cc | 302 | int64_t xbzrle_cache_resize(int64_t new_size); |
43487c67 | 303 | |
8706d2d5 LL |
304 | bool migrate_use_compression(void); |
305 | int migrate_compress_level(void); | |
306 | int migrate_compress_threads(void); | |
3fcb38c2 | 307 | int migrate_decompress_threads(void); |
b05dc723 | 308 | bool migrate_use_events(void); |
8706d2d5 | 309 | |
6decec93 DDAG |
310 | /* Sending on the return path - generic and then for each message type */ |
311 | void migrate_send_rp_message(MigrationIncomingState *mis, | |
312 | enum mig_rp_message_type message_type, | |
313 | uint16_t len, void *data); | |
314 | void migrate_send_rp_shut(MigrationIncomingState *mis, | |
315 | uint32_t value); | |
316 | void migrate_send_rp_pong(MigrationIncomingState *mis, | |
317 | uint32_t value); | |
1e2d90eb DDAG |
318 | void migrate_send_rp_req_pages(MigrationIncomingState *mis, const char* rbname, |
319 | ram_addr_t start, size_t len); | |
6decec93 | 320 | |
43487c67 MH |
321 | void ram_control_before_iterate(QEMUFile *f, uint64_t flags); |
322 | void ram_control_after_iterate(QEMUFile *f, uint64_t flags); | |
632e3a5c | 323 | void ram_control_load_hook(QEMUFile *f, uint64_t flags, void *data); |
43487c67 MH |
324 | |
325 | /* Whenever this is found in the data stream, the flags | |
326 | * will be passed to ram_control_load_hook in the incoming-migration | |
327 | * side. This lets before_ram_iterate/after_ram_iterate add | |
328 | * transport-specific sections to the RAM migration data. | |
329 | */ | |
330 | #define RAM_SAVE_FLAG_HOOK 0x80 | |
331 | ||
332 | #define RAM_SAVE_CONTROL_NOT_SUPP -1000 | |
333 | #define RAM_SAVE_CONTROL_DELAYED -2000 | |
334 | ||
335 | size_t ram_control_save_page(QEMUFile *f, ram_addr_t block_offset, | |
336 | ram_addr_t offset, size_t size, | |
6e1dea46 | 337 | uint64_t *bytes_sent); |
43487c67 | 338 | |
56e93d26 | 339 | void ram_mig_init(void); |
37fb569c | 340 | void savevm_skip_section_footers(void); |
df4b1024 | 341 | void register_global_state(void); |
13d16814 | 342 | void global_state_set_optional(void); |
61964c23 | 343 | void savevm_skip_configuration(void); |
560d027b | 344 | int global_state_store(void); |
c69adea4 | 345 | void global_state_store_running(void); |
093e3c42 | 346 | |
6c595cde DDAG |
347 | void flush_page_queue(MigrationState *ms); |
348 | int ram_save_queue_pages(MigrationState *ms, const char *rbname, | |
349 | ram_addr_t start, ram_addr_t len); | |
350 | ||
093e3c42 DDAG |
351 | PostcopyState postcopy_state_get(void); |
352 | /* Set the state and return the old state */ | |
353 | PostcopyState postcopy_state_set(PostcopyState new_state); | |
5bb7910a | 354 | #endif |