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 "qapi/qmp/qdict.h"
18 #include "qemu-common.h"
19 #include "qemu/thread.h"
20 #include "qemu/notify.h"
21 #include "qapi/error.h"
22 #include "migration/vmstate.h"
23 #include "qapi-types.h"
24 #include "exec/cpu-common.h"
26 #define QEMU_VM_FILE_MAGIC 0x5145564d
27 #define QEMU_VM_FILE_VERSION_COMPAT 0x00000002
28 #define QEMU_VM_FILE_VERSION 0x00000003
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
41 struct MigrationParams
{
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 ) */
55 typedef QLIST_HEAD(, LoadStateEntry
) LoadStateEntry_Head
;
57 /* The current postcopy state is read/set by postcopy_state_get/set
58 * which update it atomically.
59 * The state is updated as postcopy messages are received, and
60 * in general only one thread should be writing to the state at any one
61 * time, initially the main thread and then the listen thread;
62 * Corner cases are where either thread finishes early and/or errors.
63 * The state is checked as messages are received to ensure that
64 * the source is sending us messages in the correct order.
65 * The state is also used by the RAM reception code to know if it
66 * has to place pages atomically, and the cleanup code at the end of
67 * the main thread to know if it has to delay cleanup until the end
71 POSTCOPY_INCOMING_NONE
= 0, /* Initial state - no postcopy */
72 POSTCOPY_INCOMING_ADVISE
,
73 POSTCOPY_INCOMING_DISCARD
,
74 POSTCOPY_INCOMING_LISTENING
,
75 POSTCOPY_INCOMING_RUNNING
,
79 /* State for the incoming migration */
80 struct MigrationIncomingState
{
81 QEMUFile
*from_src_file
;
84 * Free at the start of the main state load, set as the main thread finishes
87 QemuEvent main_thread_load_event
;
89 /* For the kernel to send us notifications */
91 QEMUFile
*to_src_file
;
92 QemuMutex rp_mutex
; /* We send replies from multiple threads */
95 LoadStateEntry_Head loadvm_handlers
;
98 MigrationIncomingState
*migration_incoming_get_current(void);
99 MigrationIncomingState
*migration_incoming_state_new(QEMUFile
*f
);
100 void migration_incoming_state_destroy(void);
102 struct MigrationState
104 int64_t bandwidth_limit
;
110 int parameters
[MIGRATION_PARAMETER_MAX
];
113 MigrationParams params
;
115 /* State related to return path */
117 QEMUFile
*from_dst_file
;
118 QemuThread rp_thread
;
125 int64_t expected_downtime
;
126 int64_t dirty_pages_rate
;
127 int64_t dirty_bytes_rate
;
128 bool enabled_capabilities
[MIGRATION_CAPABILITY_MAX
];
129 int64_t xbzrle_cache_size
;
131 int64_t dirty_sync_count
;
133 /* Flag set once the migration has been asked to enter postcopy */
137 void process_incoming_migration(QEMUFile
*f
);
139 void qemu_start_incoming_migration(const char *uri
, Error
**errp
);
141 uint64_t migrate_max_downtime(void);
143 void exec_start_incoming_migration(const char *host_port
, Error
**errp
);
145 void exec_start_outgoing_migration(MigrationState
*s
, const char *host_port
, Error
**errp
);
147 void tcp_start_incoming_migration(const char *host_port
, Error
**errp
);
149 void tcp_start_outgoing_migration(MigrationState
*s
, const char *host_port
, Error
**errp
);
151 void unix_start_incoming_migration(const char *path
, Error
**errp
);
153 void unix_start_outgoing_migration(MigrationState
*s
, const char *path
, Error
**errp
);
155 void fd_start_incoming_migration(const char *path
, Error
**errp
);
157 void fd_start_outgoing_migration(MigrationState
*s
, const char *fdname
, Error
**errp
);
159 void rdma_start_outgoing_migration(void *opaque
, const char *host_port
, Error
**errp
);
161 void rdma_start_incoming_migration(const char *host_port
, Error
**errp
);
163 void migrate_fd_error(MigrationState
*s
);
165 void migrate_fd_connect(MigrationState
*s
);
167 int migrate_fd_close(MigrationState
*s
);
169 void add_migration_state_change_notifier(Notifier
*notify
);
170 void remove_migration_state_change_notifier(Notifier
*notify
);
171 MigrationState
*migrate_init(const MigrationParams
*params
);
172 bool migration_in_setup(MigrationState
*);
173 bool migration_has_finished(MigrationState
*);
174 bool migration_has_failed(MigrationState
*);
175 /* True if outgoing migration has entered postcopy phase */
176 bool migration_in_postcopy(MigrationState
*);
177 MigrationState
*migrate_get_current(void);
179 void migrate_compress_threads_create(void);
180 void migrate_compress_threads_join(void);
181 void migrate_decompress_threads_create(void);
182 void migrate_decompress_threads_join(void);
183 uint64_t ram_bytes_remaining(void);
184 uint64_t ram_bytes_transferred(void);
185 uint64_t ram_bytes_total(void);
186 void free_xbzrle_decoded_buf(void);
188 void acct_update_position(QEMUFile
*f
, size_t size
, bool zero
);
190 uint64_t dup_mig_bytes_transferred(void);
191 uint64_t dup_mig_pages_transferred(void);
192 uint64_t skipped_mig_bytes_transferred(void);
193 uint64_t skipped_mig_pages_transferred(void);
194 uint64_t norm_mig_bytes_transferred(void);
195 uint64_t norm_mig_pages_transferred(void);
196 uint64_t xbzrle_mig_bytes_transferred(void);
197 uint64_t xbzrle_mig_pages_transferred(void);
198 uint64_t xbzrle_mig_pages_overflow(void);
199 uint64_t xbzrle_mig_pages_cache_miss(void);
200 double xbzrle_mig_cache_miss_rate(void);
202 void ram_handle_compressed(void *host
, uint8_t ch
, uint64_t size
);
203 void ram_debug_dump_bitmap(unsigned long *todump
, bool expected
);
204 /* For outgoing discard bitmap */
205 int ram_postcopy_send_discard_bitmap(MigrationState
*ms
);
206 /* For incoming postcopy discard */
207 int ram_discard_range(MigrationIncomingState
*mis
, const char *block_name
,
208 uint64_t start
, size_t length
);
209 int ram_postcopy_incoming_init(MigrationIncomingState
*mis
);
212 * @migrate_add_blocker - prevent migration from proceeding
214 * @reason - an error to be returned whenever migration is attempted
216 void migrate_add_blocker(Error
*reason
);
219 * @migrate_del_blocker - remove a blocking error from migration
221 * @reason - the error blocking migration
223 void migrate_del_blocker(Error
*reason
);
225 bool migrate_postcopy_ram(void);
226 bool migrate_zero_blocks(void);
228 bool migrate_auto_converge(void);
230 int xbzrle_encode_buffer(uint8_t *old_buf
, uint8_t *new_buf
, int slen
,
231 uint8_t *dst
, int dlen
);
232 int xbzrle_decode_buffer(uint8_t *src
, int slen
, uint8_t *dst
, int dlen
);
234 int migrate_use_xbzrle(void);
235 int64_t migrate_xbzrle_cache_size(void);
237 int64_t xbzrle_cache_resize(int64_t new_size
);
239 bool migrate_use_compression(void);
240 int migrate_compress_level(void);
241 int migrate_compress_threads(void);
242 int migrate_decompress_threads(void);
243 bool migrate_use_events(void);
245 /* Sending on the return path - generic and then for each message type */
246 void migrate_send_rp_message(MigrationIncomingState
*mis
,
247 enum mig_rp_message_type message_type
,
248 uint16_t len
, void *data
);
249 void migrate_send_rp_shut(MigrationIncomingState
*mis
,
251 void migrate_send_rp_pong(MigrationIncomingState
*mis
,
254 void ram_control_before_iterate(QEMUFile
*f
, uint64_t flags
);
255 void ram_control_after_iterate(QEMUFile
*f
, uint64_t flags
);
256 void ram_control_load_hook(QEMUFile
*f
, uint64_t flags
, void *data
);
258 /* Whenever this is found in the data stream, the flags
259 * will be passed to ram_control_load_hook in the incoming-migration
260 * side. This lets before_ram_iterate/after_ram_iterate add
261 * transport-specific sections to the RAM migration data.
263 #define RAM_SAVE_FLAG_HOOK 0x80
265 #define RAM_SAVE_CONTROL_NOT_SUPP -1000
266 #define RAM_SAVE_CONTROL_DELAYED -2000
268 size_t ram_control_save_page(QEMUFile
*f
, ram_addr_t block_offset
,
269 ram_addr_t offset
, size_t size
,
270 uint64_t *bytes_sent
);
272 void ram_mig_init(void);
273 void savevm_skip_section_footers(void);
274 void register_global_state(void);
275 void global_state_set_optional(void);
276 void savevm_skip_configuration(void);
277 int global_state_store(void);
278 void global_state_store_running(void);
280 PostcopyState
postcopy_state_get(void);
281 /* Set the state and return the old state */
282 PostcopyState
postcopy_state_set(PostcopyState new_state
);