hw/arm/virt-acpi-build: don't save VirtGuestInfo on AcpiBuildState
[qemu.git] / include / migration / migration.h
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
17 #include "qapi/qmp/qdict.h"
18 #include "qemu-common.h"
19 #include "qemu/thread.h"
20 #include "qemu/notify.h"
21 #include "migration/vmstate.h"
22 #include "qapi-types.h"
23 #include "exec/cpu-common.h"
24 #include "qemu/coroutine_int.h"
25
26 #define QEMU_VM_FILE_MAGIC 0x5145564d
27 #define QEMU_VM_FILE_VERSION_COMPAT 0x00000002
28 #define QEMU_VM_FILE_VERSION 0x00000003
29
30 #define QEMU_VM_EOF 0x00
31 #define QEMU_VM_SECTION_START 0x01
32 #define QEMU_VM_SECTION_PART 0x02
33 #define QEMU_VM_SECTION_END 0x03
34 #define QEMU_VM_SECTION_FULL 0x04
35 #define QEMU_VM_SUBSECTION 0x05
36 #define QEMU_VM_VMDESCRIPTION 0x06
37 #define QEMU_VM_CONFIGURATION 0x07
38 #define QEMU_VM_COMMAND 0x08
39 #define QEMU_VM_SECTION_FOOTER 0x7e
40
41 struct MigrationParams {
42 bool blk;
43 bool shared;
44 };
45
46 /* Messages sent on the return path from destination to source */
47 enum mig_rp_message_type {
48 MIG_RP_MSG_INVALID = 0, /* Must be 0 */
49 MIG_RP_MSG_SHUT, /* sibling will not send any more RP messages */
50 MIG_RP_MSG_PONG, /* Response to a PING; data (seq: be32 ) */
51
52 MIG_RP_MSG_REQ_PAGES_ID, /* data (start: be64, len: be32, id: string) */
53 MIG_RP_MSG_REQ_PAGES, /* data (start: be64, len: be32) */
54
55 MIG_RP_MSG_MAX
56 };
57
58 typedef QLIST_HEAD(, LoadStateEntry) LoadStateEntry_Head;
59
60 /* The current postcopy state is read/set by postcopy_state_get/set
61 * which update it atomically.
62 * The state is updated as postcopy messages are received, and
63 * in general only one thread should be writing to the state at any one
64 * time, initially the main thread and then the listen thread;
65 * Corner cases are where either thread finishes early and/or errors.
66 * The state is checked as messages are received to ensure that
67 * the source is sending us messages in the correct order.
68 * The state is also used by the RAM reception code to know if it
69 * has to place pages atomically, and the cleanup code at the end of
70 * the main thread to know if it has to delay cleanup until the end
71 * of postcopy.
72 */
73 typedef enum {
74 POSTCOPY_INCOMING_NONE = 0, /* Initial state - no postcopy */
75 POSTCOPY_INCOMING_ADVISE,
76 POSTCOPY_INCOMING_DISCARD,
77 POSTCOPY_INCOMING_LISTENING,
78 POSTCOPY_INCOMING_RUNNING,
79 POSTCOPY_INCOMING_END
80 } PostcopyState;
81
82 /* State for the incoming migration */
83 struct MigrationIncomingState {
84 QEMUFile *from_src_file;
85
86 /*
87 * Free at the start of the main state load, set as the main thread finishes
88 * loading state.
89 */
90 QemuEvent main_thread_load_event;
91
92 bool have_fault_thread;
93 QemuThread fault_thread;
94 QemuSemaphore fault_thread_sem;
95
96 bool have_listen_thread;
97 QemuThread listen_thread;
98 QemuSemaphore listen_thread_sem;
99
100 /* For the kernel to send us notifications */
101 int userfault_fd;
102 /* To tell the fault_thread to quit */
103 int userfault_quit_fd;
104 QEMUFile *to_src_file;
105 QemuMutex rp_mutex; /* We send replies from multiple threads */
106 void *postcopy_tmp_page;
107
108 QEMUBH *bh;
109
110 int state;
111
112 bool have_colo_incoming_thread;
113 QemuThread colo_incoming_thread;
114 /* The coroutine we should enter (back) after failover */
115 Coroutine *migration_incoming_co;
116
117 /* See savevm.c */
118 LoadStateEntry_Head loadvm_handlers;
119 };
120
121 MigrationIncomingState *migration_incoming_get_current(void);
122 MigrationIncomingState *migration_incoming_state_new(QEMUFile *f);
123 void migration_incoming_state_destroy(void);
124
125 /*
126 * An outstanding page request, on the source, having been received
127 * and queued
128 */
129 struct MigrationSrcPageRequest {
130 RAMBlock *rb;
131 hwaddr offset;
132 hwaddr len;
133
134 QSIMPLEQ_ENTRY(MigrationSrcPageRequest) next_req;
135 };
136
137 struct MigrationState
138 {
139 size_t bytes_xfer;
140 size_t xfer_limit;
141 QemuThread thread;
142 QEMUBH *cleanup_bh;
143 QEMUFile *to_dst_file;
144
145 /* New style params from 'migrate-set-parameters' */
146 MigrationParameters parameters;
147
148 int state;
149 /* Old style params from 'migrate' command */
150 MigrationParams params;
151
152 /* State related to return path */
153 struct {
154 QEMUFile *from_dst_file;
155 QemuThread rp_thread;
156 bool error;
157 } rp_state;
158
159 double mbps;
160 int64_t total_time;
161 int64_t downtime;
162 int64_t expected_downtime;
163 int64_t dirty_pages_rate;
164 int64_t dirty_bytes_rate;
165 bool enabled_capabilities[MIGRATION_CAPABILITY__MAX];
166 int64_t xbzrle_cache_size;
167 int64_t setup_time;
168 int64_t dirty_sync_count;
169 /* Count of requests incoming from destination */
170 int64_t postcopy_requests;
171
172 /* Flag set once the migration has been asked to enter postcopy */
173 bool start_postcopy;
174 /* Flag set after postcopy has sent the device state */
175 bool postcopy_after_devices;
176
177 /* Flag set once the migration thread is running (and needs joining) */
178 bool migration_thread_running;
179
180 /* Queue of outstanding page requests from the destination */
181 QemuMutex src_page_req_mutex;
182 QSIMPLEQ_HEAD(src_page_requests, MigrationSrcPageRequest) src_page_requests;
183 /* The RAMBlock used in the last src_page_request */
184 RAMBlock *last_req_rb;
185
186 /* The last error that occurred */
187 Error *error;
188 };
189
190 void migrate_set_state(int *state, int old_state, int new_state);
191
192 void migration_fd_process_incoming(QEMUFile *f);
193
194 void qemu_start_incoming_migration(const char *uri, Error **errp);
195
196 void migration_channel_process_incoming(MigrationState *s,
197 QIOChannel *ioc);
198
199 void migration_tls_channel_process_incoming(MigrationState *s,
200 QIOChannel *ioc,
201 Error **errp);
202
203 void migration_channel_connect(MigrationState *s,
204 QIOChannel *ioc,
205 const char *hostname);
206
207 void migration_tls_channel_connect(MigrationState *s,
208 QIOChannel *ioc,
209 const char *hostname,
210 Error **errp);
211
212 uint64_t migrate_max_downtime(void);
213
214 void exec_start_incoming_migration(const char *host_port, Error **errp);
215
216 void exec_start_outgoing_migration(MigrationState *s, const char *host_port, Error **errp);
217
218 void tcp_start_incoming_migration(const char *host_port, Error **errp);
219
220 void tcp_start_outgoing_migration(MigrationState *s, const char *host_port, Error **errp);
221
222 void unix_start_incoming_migration(const char *path, Error **errp);
223
224 void unix_start_outgoing_migration(MigrationState *s, const char *path, Error **errp);
225
226 void fd_start_incoming_migration(const char *path, Error **errp);
227
228 void fd_start_outgoing_migration(MigrationState *s, const char *fdname, Error **errp);
229
230 void rdma_start_outgoing_migration(void *opaque, const char *host_port, Error **errp);
231
232 void rdma_start_incoming_migration(const char *host_port, Error **errp);
233
234 void migrate_fd_error(MigrationState *s, const Error *error);
235
236 void migrate_fd_connect(MigrationState *s);
237
238 void add_migration_state_change_notifier(Notifier *notify);
239 void remove_migration_state_change_notifier(Notifier *notify);
240 MigrationState *migrate_init(const MigrationParams *params);
241 bool migration_is_blocked(Error **errp);
242 bool migration_in_setup(MigrationState *);
243 bool migration_has_finished(MigrationState *);
244 bool migration_has_failed(MigrationState *);
245 /* True if outgoing migration has entered postcopy phase */
246 bool migration_in_postcopy(MigrationState *);
247 /* ...and after the device transmission */
248 bool migration_in_postcopy_after_devices(MigrationState *);
249 MigrationState *migrate_get_current(void);
250
251 void migrate_compress_threads_create(void);
252 void migrate_compress_threads_join(void);
253 void migrate_decompress_threads_create(void);
254 void migrate_decompress_threads_join(void);
255 uint64_t ram_bytes_remaining(void);
256 uint64_t ram_bytes_transferred(void);
257 uint64_t ram_bytes_total(void);
258 void free_xbzrle_decoded_buf(void);
259
260 void acct_update_position(QEMUFile *f, size_t size, bool zero);
261
262 uint64_t dup_mig_bytes_transferred(void);
263 uint64_t dup_mig_pages_transferred(void);
264 uint64_t skipped_mig_bytes_transferred(void);
265 uint64_t skipped_mig_pages_transferred(void);
266 uint64_t norm_mig_bytes_transferred(void);
267 uint64_t norm_mig_pages_transferred(void);
268 uint64_t xbzrle_mig_bytes_transferred(void);
269 uint64_t xbzrle_mig_pages_transferred(void);
270 uint64_t xbzrle_mig_pages_overflow(void);
271 uint64_t xbzrle_mig_pages_cache_miss(void);
272 double xbzrle_mig_cache_miss_rate(void);
273
274 void ram_handle_compressed(void *host, uint8_t ch, uint64_t size);
275 void ram_debug_dump_bitmap(unsigned long *todump, bool expected);
276 /* For outgoing discard bitmap */
277 int ram_postcopy_send_discard_bitmap(MigrationState *ms);
278 /* For incoming postcopy discard */
279 int ram_discard_range(MigrationIncomingState *mis, const char *block_name,
280 uint64_t start, size_t length);
281 int ram_postcopy_incoming_init(MigrationIncomingState *mis);
282
283 /**
284 * @migrate_add_blocker - prevent migration from proceeding
285 *
286 * @reason - an error to be returned whenever migration is attempted
287 */
288 void migrate_add_blocker(Error *reason);
289
290 /**
291 * @migrate_del_blocker - remove a blocking error from migration
292 *
293 * @reason - the error blocking migration
294 */
295 void migrate_del_blocker(Error *reason);
296
297 bool migrate_postcopy_ram(void);
298 bool migrate_zero_blocks(void);
299
300 bool migrate_auto_converge(void);
301
302 int xbzrle_encode_buffer(uint8_t *old_buf, uint8_t *new_buf, int slen,
303 uint8_t *dst, int dlen);
304 int xbzrle_decode_buffer(uint8_t *src, int slen, uint8_t *dst, int dlen);
305
306 int migrate_use_xbzrle(void);
307 int64_t migrate_xbzrle_cache_size(void);
308 bool migrate_colo_enabled(void);
309
310 int64_t xbzrle_cache_resize(int64_t new_size);
311
312 bool migrate_use_compression(void);
313 int migrate_compress_level(void);
314 int migrate_compress_threads(void);
315 int migrate_decompress_threads(void);
316 bool migrate_use_events(void);
317
318 /* Sending on the return path - generic and then for each message type */
319 void migrate_send_rp_message(MigrationIncomingState *mis,
320 enum mig_rp_message_type message_type,
321 uint16_t len, void *data);
322 void migrate_send_rp_shut(MigrationIncomingState *mis,
323 uint32_t value);
324 void migrate_send_rp_pong(MigrationIncomingState *mis,
325 uint32_t value);
326 void migrate_send_rp_req_pages(MigrationIncomingState *mis, const char* rbname,
327 ram_addr_t start, size_t len);
328
329 void ram_control_before_iterate(QEMUFile *f, uint64_t flags);
330 void ram_control_after_iterate(QEMUFile *f, uint64_t flags);
331 void ram_control_load_hook(QEMUFile *f, uint64_t flags, void *data);
332
333 /* Whenever this is found in the data stream, the flags
334 * will be passed to ram_control_load_hook in the incoming-migration
335 * side. This lets before_ram_iterate/after_ram_iterate add
336 * transport-specific sections to the RAM migration data.
337 */
338 #define RAM_SAVE_FLAG_HOOK 0x80
339
340 #define RAM_SAVE_CONTROL_NOT_SUPP -1000
341 #define RAM_SAVE_CONTROL_DELAYED -2000
342
343 size_t ram_control_save_page(QEMUFile *f, ram_addr_t block_offset,
344 ram_addr_t offset, size_t size,
345 uint64_t *bytes_sent);
346
347 void ram_mig_init(void);
348 void savevm_skip_section_footers(void);
349 void register_global_state(void);
350 void global_state_set_optional(void);
351 void savevm_skip_configuration(void);
352 int global_state_store(void);
353 void global_state_store_running(void);
354
355 void flush_page_queue(MigrationState *ms);
356 int ram_save_queue_pages(MigrationState *ms, const char *rbname,
357 ram_addr_t start, ram_addr_t len);
358
359 PostcopyState postcopy_state_get(void);
360 /* Set the state and return the old state */
361 PostcopyState postcopy_state_set(PostcopyState new_state);
362 #endif