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 "qapi/error.h"
  22 #include "migration/vmstate.h"
  23 #include "qapi-types.h"
  24 #include "exec/cpu-common.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_MAX
  53 };
  54
  55 typedef QLIST_HEAD(, LoadStateEntry) LoadStateEntry_Head;
  56 /* State for the incoming migration */
  57 struct MigrationIncomingState {
  58     QEMUFile *from_src_file;
  59
  60     /*
  61      * Free at the start of the main state load, set as the main thread finishes
  62      * loading state.
  63      */
  64     QemuEvent main_thread_load_event;
  65
  66     QEMUFile *to_src_file;
  67     QemuMutex rp_mutex;    /* We send replies from multiple threads */
  68
  69     /* See savevm.c */
  70     LoadStateEntry_Head loadvm_handlers;
  71 };
  72
  73 MigrationIncomingState *migration_incoming_get_current(void);
  74 MigrationIncomingState *migration_incoming_state_new(QEMUFile *f);
  75 void migration_incoming_state_destroy(void);
  76
  77 struct MigrationState
  78 {
  79     int64_t bandwidth_limit;
  80     size_t bytes_xfer;
  81     size_t xfer_limit;
  82     QemuThread thread;
  83     QEMUBH *cleanup_bh;
  84     QEMUFile *file;
  85     int parameters[MIGRATION_PARAMETER_MAX];
  86
  87     int state;
  88     MigrationParams params;
  89
  90     /* State related to return path */
  91     struct {
  92         QEMUFile     *from_dst_file;
  93         QemuThread    rp_thread;
  94         bool          error;
  95     } rp_state;
  96
  97     double mbps;
  98     int64_t total_time;
  99     int64_t downtime;
 100     int64_t expected_downtime;
 101     int64_t dirty_pages_rate;
 102     int64_t dirty_bytes_rate;
 103     bool enabled_capabilities[MIGRATION_CAPABILITY_MAX];
 104     int64_t xbzrle_cache_size;
 105     int64_t setup_time;
 106     int64_t dirty_sync_count;
 107 };
 108
 109 void process_incoming_migration(QEMUFile *f);
 110
 111 void qemu_start_incoming_migration(const char *uri, Error **errp);
 112
 113 uint64_t migrate_max_downtime(void);
 114
 115 void exec_start_incoming_migration(const char *host_port, Error **errp);
 116
 117 void exec_start_outgoing_migration(MigrationState *s, const char *host_port, Error **errp);
 118
 119 void tcp_start_incoming_migration(const char *host_port, Error **errp);
 120
 121 void tcp_start_outgoing_migration(MigrationState *s, const char *host_port, Error **errp);
 122
 123 void unix_start_incoming_migration(const char *path, Error **errp);
 124
 125 void unix_start_outgoing_migration(MigrationState *s, const char *path, Error **errp);
 126
 127 void fd_start_incoming_migration(const char *path, Error **errp);
 128
 129 void fd_start_outgoing_migration(MigrationState *s, const char *fdname, Error **errp);
 130
 131 void rdma_start_outgoing_migration(void *opaque, const char *host_port, Error **errp);
 132
 133 void rdma_start_incoming_migration(const char *host_port, Error **errp);
 134
 135 void migrate_fd_error(MigrationState *s);
 136
 137 void migrate_fd_connect(MigrationState *s);
 138
 139 int migrate_fd_close(MigrationState *s);
 140
 141 void add_migration_state_change_notifier(Notifier *notify);
 142 void remove_migration_state_change_notifier(Notifier *notify);
 143 MigrationState *migrate_init(const MigrationParams *params);
 144 bool migration_in_setup(MigrationState *);
 145 bool migration_has_finished(MigrationState *);
 146 bool migration_has_failed(MigrationState *);
 147 MigrationState *migrate_get_current(void);
 148
 149 void migrate_compress_threads_create(void);
 150 void migrate_compress_threads_join(void);
 151 void migrate_decompress_threads_create(void);
 152 void migrate_decompress_threads_join(void);
 153 uint64_t ram_bytes_remaining(void);
 154 uint64_t ram_bytes_transferred(void);
 155 uint64_t ram_bytes_total(void);
 156 void free_xbzrle_decoded_buf(void);
 157
 158 void acct_update_position(QEMUFile *f, size_t size, bool zero);
 159
 160 uint64_t dup_mig_bytes_transferred(void);
 161 uint64_t dup_mig_pages_transferred(void);
 162 uint64_t skipped_mig_bytes_transferred(void);
 163 uint64_t skipped_mig_pages_transferred(void);
 164 uint64_t norm_mig_bytes_transferred(void);
 165 uint64_t norm_mig_pages_transferred(void);
 166 uint64_t xbzrle_mig_bytes_transferred(void);
 167 uint64_t xbzrle_mig_pages_transferred(void);
 168 uint64_t xbzrle_mig_pages_overflow(void);
 169 uint64_t xbzrle_mig_pages_cache_miss(void);
 170 double xbzrle_mig_cache_miss_rate(void);
 171
 172 void ram_handle_compressed(void *host, uint8_t ch, uint64_t size);
 173 void ram_debug_dump_bitmap(unsigned long *todump, bool expected);
 174
 175 /**
 176  * @migrate_add_blocker - prevent migration from proceeding
 177  *
 178  * @reason - an error to be returned whenever migration is attempted
 179  */
 180 void migrate_add_blocker(Error *reason);
 181
 182 /**
 183  * @migrate_del_blocker - remove a blocking error from migration
 184  *
 185  * @reason - the error blocking migration
 186  */
 187 void migrate_del_blocker(Error *reason);
 188
 189 bool migrate_postcopy_ram(void);
 190 bool migrate_zero_blocks(void);
 191
 192 bool migrate_auto_converge(void);
 193
 194 int xbzrle_encode_buffer(uint8_t *old_buf, uint8_t *new_buf, int slen,
 195                          uint8_t *dst, int dlen);
 196 int xbzrle_decode_buffer(uint8_t *src, int slen, uint8_t *dst, int dlen);
 197
 198 int migrate_use_xbzrle(void);
 199 int64_t migrate_xbzrle_cache_size(void);
 200
 201 int64_t xbzrle_cache_resize(int64_t new_size);
 202
 203 bool migrate_use_compression(void);
 204 int migrate_compress_level(void);
 205 int migrate_compress_threads(void);
 206 int migrate_decompress_threads(void);
 207 bool migrate_use_events(void);
 208
 209 /* Sending on the return path - generic and then for each message type */
 210 void migrate_send_rp_message(MigrationIncomingState *mis,
 211                              enum mig_rp_message_type message_type,
 212                              uint16_t len, void *data);
 213 void migrate_send_rp_shut(MigrationIncomingState *mis,
 214                           uint32_t value);
 215 void migrate_send_rp_pong(MigrationIncomingState *mis,
 216                           uint32_t value);
 217
 218 void ram_control_before_iterate(QEMUFile *f, uint64_t flags);
 219 void ram_control_after_iterate(QEMUFile *f, uint64_t flags);
 220 void ram_control_load_hook(QEMUFile *f, uint64_t flags, void *data);
 221
 222 /* Whenever this is found in the data stream, the flags
 223  * will be passed to ram_control_load_hook in the incoming-migration
 224  * side. This lets before_ram_iterate/after_ram_iterate add
 225  * transport-specific sections to the RAM migration data.
 226  */
 227 #define RAM_SAVE_FLAG_HOOK     0x80
 228
 229 #define RAM_SAVE_CONTROL_NOT_SUPP -1000
 230 #define RAM_SAVE_CONTROL_DELAYED  -2000
 231
 232 size_t ram_control_save_page(QEMUFile *f, ram_addr_t block_offset,
 233                              ram_addr_t offset, size_t size,
 234                              uint64_t *bytes_sent);
 235
 236 void ram_mig_init(void);
 237 void savevm_skip_section_footers(void);
 238 void register_global_state(void);
 239 void global_state_set_optional(void);
 240 void savevm_skip_configuration(void);
 241 int global_state_store(void);
 242 void global_state_store_running(void);
 243 #endif