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
38 struct MigrationParams
{
43 typedef struct MigrationState MigrationState
;
47 int64_t bandwidth_limit
;
53 int parameters
[MIGRATION_PARAMETER_MAX
];
56 MigrationParams params
;
60 int64_t expected_downtime
;
61 int64_t dirty_pages_rate
;
62 int64_t dirty_bytes_rate
;
63 bool enabled_capabilities
[MIGRATION_CAPABILITY_MAX
];
64 int64_t xbzrle_cache_size
;
66 int64_t dirty_sync_count
;
69 void process_incoming_migration(QEMUFile
*f
);
71 void qemu_start_incoming_migration(const char *uri
, Error
**errp
);
73 uint64_t migrate_max_downtime(void);
75 void exec_start_incoming_migration(const char *host_port
, Error
**errp
);
77 void exec_start_outgoing_migration(MigrationState
*s
, const char *host_port
, Error
**errp
);
79 void tcp_start_incoming_migration(const char *host_port
, Error
**errp
);
81 void tcp_start_outgoing_migration(MigrationState
*s
, const char *host_port
, Error
**errp
);
83 void unix_start_incoming_migration(const char *path
, Error
**errp
);
85 void unix_start_outgoing_migration(MigrationState
*s
, const char *path
, Error
**errp
);
87 void fd_start_incoming_migration(const char *path
, Error
**errp
);
89 void fd_start_outgoing_migration(MigrationState
*s
, const char *fdname
, Error
**errp
);
91 void rdma_start_outgoing_migration(void *opaque
, const char *host_port
, Error
**errp
);
93 void rdma_start_incoming_migration(const char *host_port
, Error
**errp
);
95 void migrate_fd_error(MigrationState
*s
);
97 void migrate_fd_connect(MigrationState
*s
);
99 int migrate_fd_close(MigrationState
*s
);
101 void add_migration_state_change_notifier(Notifier
*notify
);
102 void remove_migration_state_change_notifier(Notifier
*notify
);
103 bool migration_in_setup(MigrationState
*);
104 bool migration_has_finished(MigrationState
*);
105 bool migration_has_failed(MigrationState
*);
106 MigrationState
*migrate_get_current(void);
108 void migrate_compress_threads_create(void);
109 void migrate_compress_threads_join(void);
110 void migrate_decompress_threads_create(void);
111 void migrate_decompress_threads_join(void);
112 uint64_t ram_bytes_remaining(void);
113 uint64_t ram_bytes_transferred(void);
114 uint64_t ram_bytes_total(void);
115 void free_xbzrle_decoded_buf(void);
117 void acct_update_position(QEMUFile
*f
, size_t size
, bool zero
);
119 uint64_t dup_mig_bytes_transferred(void);
120 uint64_t dup_mig_pages_transferred(void);
121 uint64_t skipped_mig_bytes_transferred(void);
122 uint64_t skipped_mig_pages_transferred(void);
123 uint64_t norm_mig_bytes_transferred(void);
124 uint64_t norm_mig_pages_transferred(void);
125 uint64_t xbzrle_mig_bytes_transferred(void);
126 uint64_t xbzrle_mig_pages_transferred(void);
127 uint64_t xbzrle_mig_pages_overflow(void);
128 uint64_t xbzrle_mig_pages_cache_miss(void);
129 double xbzrle_mig_cache_miss_rate(void);
131 void ram_handle_compressed(void *host
, uint8_t ch
, uint64_t size
);
134 * @migrate_add_blocker - prevent migration from proceeding
136 * @reason - an error to be returned whenever migration is attempted
138 void migrate_add_blocker(Error
*reason
);
141 * @migrate_del_blocker - remove a blocking error from migration
143 * @reason - the error blocking migration
145 void migrate_del_blocker(Error
*reason
);
147 bool migrate_zero_blocks(void);
149 bool migrate_auto_converge(void);
151 int xbzrle_encode_buffer(uint8_t *old_buf
, uint8_t *new_buf
, int slen
,
152 uint8_t *dst
, int dlen
);
153 int xbzrle_decode_buffer(uint8_t *src
, int slen
, uint8_t *dst
, int dlen
);
155 int migrate_use_xbzrle(void);
156 int64_t migrate_xbzrle_cache_size(void);
158 int64_t xbzrle_cache_resize(int64_t new_size
);
160 bool migrate_use_compression(void);
161 int migrate_compress_level(void);
162 int migrate_compress_threads(void);
163 int migrate_decompress_threads(void);
165 void ram_control_before_iterate(QEMUFile
*f
, uint64_t flags
);
166 void ram_control_after_iterate(QEMUFile
*f
, uint64_t flags
);
167 void ram_control_load_hook(QEMUFile
*f
, uint64_t flags
);
169 /* Whenever this is found in the data stream, the flags
170 * will be passed to ram_control_load_hook in the incoming-migration
171 * side. This lets before_ram_iterate/after_ram_iterate add
172 * transport-specific sections to the RAM migration data.
174 #define RAM_SAVE_FLAG_HOOK 0x80
176 #define RAM_SAVE_CONTROL_NOT_SUPP -1000
177 #define RAM_SAVE_CONTROL_DELAYED -2000
179 size_t ram_control_save_page(QEMUFile
*f
, ram_addr_t block_offset
,
180 ram_addr_t offset
, size_t size
,
181 uint64_t *bytes_sent
);