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
  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
  35 #define QEMU_VM_VMDESCRIPTION        0x06
  36 #define QEMU_VM_CONFIGURATION        0x07
  37 #define QEMU_VM_COMMAND              0x08
  38 #define QEMU_VM_SECTION_FOOTER       0x7e
  39
  40 struct MigrationParams {
  41     bool blk;
  42     bool shared;
  43 };
  44
  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
  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
  54     MIG_RP_MSG_MAX
  55 };
  56
  57 typedef QLIST_HEAD(, LoadStateEntry) LoadStateEntry_Head;
  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
  81 /* State for the incoming migration */
  82 struct MigrationIncomingState {
  83     QEMUFile *from_src_file;
  84
  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
  91     bool           have_fault_thread;
  92     QemuThread     fault_thread;
  93     QemuSemaphore  fault_thread_sem;
  94
  95     bool           have_listen_thread;
  96     QemuThread     listen_thread;
  97     QemuSemaphore  listen_thread_sem;
  98
  99     /* For the kernel to send us notifications */
 100     int       userfault_fd;
 101     /* To tell the fault_thread to quit */
 102     int       userfault_quit_fd;
 103     QEMUFile *to_src_file;
 104     QemuMutex rp_mutex;    /* We send replies from multiple threads */
 105     void     *postcopy_tmp_page;
 106
 107     QEMUBH *bh;
 108
 109     int state;
 110     /* See savevm.c */
 111     LoadStateEntry_Head loadvm_handlers;
 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
 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
 130 struct MigrationState
 131 {
 132     size_t bytes_xfer;
 133     size_t xfer_limit;
 134     QemuThread thread;
 135     QEMUBH *cleanup_bh;
 136     QEMUFile *to_dst_file;
 137
 138     /* New style params from 'migrate-set-parameters' */
 139     MigrationParameters parameters;
 140
 141     int state;
 142     /* Old style params from 'migrate' command */
 143     MigrationParams params;
 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
 152     double mbps;
 153     int64_t total_time;
 154     int64_t downtime;
 155     int64_t expected_downtime;
 156     int64_t dirty_pages_rate;
 157     int64_t dirty_bytes_rate;
 158     bool enabled_capabilities[MIGRATION_CAPABILITY__MAX];
 159     int64_t xbzrle_cache_size;
 160     int64_t setup_time;
 161     int64_t dirty_sync_count;
 162     /* Count of requests incoming from destination */
 163     int64_t postcopy_requests;
 164
 165     /* Flag set once the migration has been asked to enter postcopy */
 166     bool start_postcopy;
 167     /* Flag set after postcopy has sent the device state */
 168     bool postcopy_after_devices;
 169
 170     /* Flag set once the migration thread is running (and needs joining) */
 171     bool migration_thread_running;
 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;
 178
 179     /* The last error that occurred */
 180     Error *error;
 181 };
 182
 183 void migrate_set_state(int *state, int old_state, int new_state);
 184
 185 void migration_fd_process_incoming(QEMUFile *f);
 186
 187 void qemu_start_incoming_migration(const char *uri, Error **errp);
 188
 189 void migration_channel_process_incoming(MigrationState *s,
 190                                         QIOChannel *ioc);
 191
 192 void migration_tls_channel_process_incoming(MigrationState *s,
 193                                             QIOChannel *ioc,
 194                                             Error **errp);
 195
 196 void migration_channel_connect(MigrationState *s,
 197                                QIOChannel *ioc,
 198                                const char *hostname);
 199
 200 void migration_tls_channel_connect(MigrationState *s,
 201                                    QIOChannel *ioc,
 202                                    const char *hostname,
 203                                    Error **errp);
 204
 205 uint64_t migrate_max_downtime(void);
 206
 207 void exec_start_incoming_migration(const char *host_port, Error **errp);
 208
 209 void exec_start_outgoing_migration(MigrationState *s, const char *host_port, Error **errp);
 210
 211 void tcp_start_incoming_migration(const char *host_port, Error **errp);
 212
 213 void tcp_start_outgoing_migration(MigrationState *s, const char *host_port, Error **errp);
 214
 215 void unix_start_incoming_migration(const char *path, Error **errp);
 216
 217 void unix_start_outgoing_migration(MigrationState *s, const char *path, Error **errp);
 218
 219 void fd_start_incoming_migration(const char *path, Error **errp);
 220
 221 void fd_start_outgoing_migration(MigrationState *s, const char *fdname, Error **errp);
 222
 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
 227 void migrate_fd_error(MigrationState *s, const Error *error);
 228
 229 void migrate_fd_connect(MigrationState *s);
 230
 231 void add_migration_state_change_notifier(Notifier *notify);
 232 void remove_migration_state_change_notifier(Notifier *notify);
 233 MigrationState *migrate_init(const MigrationParams *params);
 234 bool migration_is_blocked(Error **errp);
 235 bool migration_in_setup(MigrationState *);
 236 bool migration_has_finished(MigrationState *);
 237 bool migration_has_failed(MigrationState *);
 238 /* True if outgoing migration has entered postcopy phase */
 239 bool migration_in_postcopy(MigrationState *);
 240 /* ...and after the device transmission */
 241 bool migration_in_postcopy_after_devices(MigrationState *);
 242 MigrationState *migrate_get_current(void);
 243
 244 void migrate_compress_threads_create(void);
 245 void migrate_compress_threads_join(void);
 246 void migrate_decompress_threads_create(void);
 247 void migrate_decompress_threads_join(void);
 248 uint64_t ram_bytes_remaining(void);
 249 uint64_t ram_bytes_transferred(void);
 250 uint64_t ram_bytes_total(void);
 251 void free_xbzrle_decoded_buf(void);
 252
 253 void acct_update_position(QEMUFile *f, size_t size, bool zero);
 254
 255 uint64_t dup_mig_bytes_transferred(void);
 256 uint64_t dup_mig_pages_transferred(void);
 257 uint64_t skipped_mig_bytes_transferred(void);
 258 uint64_t skipped_mig_pages_transferred(void);
 259 uint64_t norm_mig_bytes_transferred(void);
 260 uint64_t norm_mig_pages_transferred(void);
 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);
 265 double xbzrle_mig_cache_miss_rate(void);
 266
 267 void ram_handle_compressed(void *host, uint8_t ch, uint64_t size);
 268 void ram_debug_dump_bitmap(unsigned long *todump, bool expected);
 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);
 274 int ram_postcopy_incoming_init(MigrationIncomingState *mis);
 275
 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
 290 bool migrate_postcopy_ram(void);
 291 bool migrate_zero_blocks(void);
 292
 293 bool migrate_auto_converge(void);
 294
 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
 299 int migrate_use_xbzrle(void);
 300 int64_t migrate_xbzrle_cache_size(void);
 301 bool migrate_colo_enabled(void);
 302
 303 int64_t xbzrle_cache_resize(int64_t new_size);
 304
 305 bool migrate_use_compression(void);
 306 int migrate_compress_level(void);
 307 int migrate_compress_threads(void);
 308 int migrate_decompress_threads(void);
 309 bool migrate_use_events(void);
 310
 311 /* Sending on the return path - generic and then for each message type */
 312 void migrate_send_rp_message(MigrationIncomingState *mis,
 313                              enum mig_rp_message_type message_type,
 314                              uint16_t len, void *data);
 315 void migrate_send_rp_shut(MigrationIncomingState *mis,
 316                           uint32_t value);
 317 void migrate_send_rp_pong(MigrationIncomingState *mis,
 318                           uint32_t value);
 319 void migrate_send_rp_req_pages(MigrationIncomingState *mis, const char* rbname,
 320                               ram_addr_t start, size_t len);
 321
 322 void ram_control_before_iterate(QEMUFile *f, uint64_t flags);
 323 void ram_control_after_iterate(QEMUFile *f, uint64_t flags);
 324 void ram_control_load_hook(QEMUFile *f, uint64_t flags, void *data);
 325
 326 /* Whenever this is found in the data stream, the flags
 327  * will be passed to ram_control_load_hook in the incoming-migration
 328  * side. This lets before_ram_iterate/after_ram_iterate add
 329  * transport-specific sections to the RAM migration data.
 330  */
 331 #define RAM_SAVE_FLAG_HOOK     0x80
 332
 333 #define RAM_SAVE_CONTROL_NOT_SUPP -1000
 334 #define RAM_SAVE_CONTROL_DELAYED  -2000
 335
 336 size_t ram_control_save_page(QEMUFile *f, ram_addr_t block_offset,
 337                              ram_addr_t offset, size_t size,
 338                              uint64_t *bytes_sent);
 339
 340 void ram_mig_init(void);
 341 void savevm_skip_section_footers(void);
 342 void register_global_state(void);
 343 void global_state_set_optional(void);
 344 void savevm_skip_configuration(void);
 345 int global_state_store(void);
 346 void global_state_store_running(void);
 347
 348 void flush_page_queue(MigrationState *ms);
 349 int ram_save_queue_pages(MigrationState *ms, const char *rbname,
 350                          ram_addr_t start, ram_addr_t len);
 351
 352 PostcopyState postcopy_state_get(void);
 353 /* Set the state and return the old state */
 354 PostcopyState postcopy_state_set(PostcopyState new_state);
 355 #endif