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 typedef QLIST_HEAD(, LoadStateEntry) LoadStateEntry_Head;
  47 /* State for the incoming migration */
  48 struct MigrationIncomingState {
  49     QEMUFile *from_src_file;
  50
  51     QEMUFile *to_src_file;
  52
  53     /* See savevm.c */
  54     LoadStateEntry_Head loadvm_handlers;
  55 };
  56
  57 MigrationIncomingState *migration_incoming_get_current(void);
  58 MigrationIncomingState *migration_incoming_state_new(QEMUFile *f);
  59 void migration_incoming_state_destroy(void);
  60
  61 struct MigrationState
  62 {
  63     int64_t bandwidth_limit;
  64     size_t bytes_xfer;
  65     size_t xfer_limit;
  66     QemuThread thread;
  67     QEMUBH *cleanup_bh;
  68     QEMUFile *file;
  69     int parameters[MIGRATION_PARAMETER_MAX];
  70
  71     int state;
  72     MigrationParams params;
  73     double mbps;
  74     int64_t total_time;
  75     int64_t downtime;
  76     int64_t expected_downtime;
  77     int64_t dirty_pages_rate;
  78     int64_t dirty_bytes_rate;
  79     bool enabled_capabilities[MIGRATION_CAPABILITY_MAX];
  80     int64_t xbzrle_cache_size;
  81     int64_t setup_time;
  82     int64_t dirty_sync_count;
  83 };
  84
  85 void process_incoming_migration(QEMUFile *f);
  86
  87 void qemu_start_incoming_migration(const char *uri, Error **errp);
  88
  89 uint64_t migrate_max_downtime(void);
  90
  91 void exec_start_incoming_migration(const char *host_port, Error **errp);
  92
  93 void exec_start_outgoing_migration(MigrationState *s, const char *host_port, Error **errp);
  94
  95 void tcp_start_incoming_migration(const char *host_port, Error **errp);
  96
  97 void tcp_start_outgoing_migration(MigrationState *s, const char *host_port, Error **errp);
  98
  99 void unix_start_incoming_migration(const char *path, Error **errp);
 100
 101 void unix_start_outgoing_migration(MigrationState *s, const char *path, Error **errp);
 102
 103 void fd_start_incoming_migration(const char *path, Error **errp);
 104
 105 void fd_start_outgoing_migration(MigrationState *s, const char *fdname, Error **errp);
 106
 107 void rdma_start_outgoing_migration(void *opaque, const char *host_port, Error **errp);
 108
 109 void rdma_start_incoming_migration(const char *host_port, Error **errp);
 110
 111 void migrate_fd_error(MigrationState *s);
 112
 113 void migrate_fd_connect(MigrationState *s);
 114
 115 int migrate_fd_close(MigrationState *s);
 116
 117 void add_migration_state_change_notifier(Notifier *notify);
 118 void remove_migration_state_change_notifier(Notifier *notify);
 119 MigrationState *migrate_init(const MigrationParams *params);
 120 bool migration_in_setup(MigrationState *);
 121 bool migration_has_finished(MigrationState *);
 122 bool migration_has_failed(MigrationState *);
 123 MigrationState *migrate_get_current(void);
 124
 125 void migrate_compress_threads_create(void);
 126 void migrate_compress_threads_join(void);
 127 void migrate_decompress_threads_create(void);
 128 void migrate_decompress_threads_join(void);
 129 uint64_t ram_bytes_remaining(void);
 130 uint64_t ram_bytes_transferred(void);
 131 uint64_t ram_bytes_total(void);
 132 void free_xbzrle_decoded_buf(void);
 133
 134 void acct_update_position(QEMUFile *f, size_t size, bool zero);
 135
 136 uint64_t dup_mig_bytes_transferred(void);
 137 uint64_t dup_mig_pages_transferred(void);
 138 uint64_t skipped_mig_bytes_transferred(void);
 139 uint64_t skipped_mig_pages_transferred(void);
 140 uint64_t norm_mig_bytes_transferred(void);
 141 uint64_t norm_mig_pages_transferred(void);
 142 uint64_t xbzrle_mig_bytes_transferred(void);
 143 uint64_t xbzrle_mig_pages_transferred(void);
 144 uint64_t xbzrle_mig_pages_overflow(void);
 145 uint64_t xbzrle_mig_pages_cache_miss(void);
 146 double xbzrle_mig_cache_miss_rate(void);
 147
 148 void ram_handle_compressed(void *host, uint8_t ch, uint64_t size);
 149 void ram_debug_dump_bitmap(unsigned long *todump, bool expected);
 150
 151 /**
 152  * @migrate_add_blocker - prevent migration from proceeding
 153  *
 154  * @reason - an error to be returned whenever migration is attempted
 155  */
 156 void migrate_add_blocker(Error *reason);
 157
 158 /**
 159  * @migrate_del_blocker - remove a blocking error from migration
 160  *
 161  * @reason - the error blocking migration
 162  */
 163 void migrate_del_blocker(Error *reason);
 164
 165 bool migrate_zero_blocks(void);
 166
 167 bool migrate_auto_converge(void);
 168
 169 int xbzrle_encode_buffer(uint8_t *old_buf, uint8_t *new_buf, int slen,
 170                          uint8_t *dst, int dlen);
 171 int xbzrle_decode_buffer(uint8_t *src, int slen, uint8_t *dst, int dlen);
 172
 173 int migrate_use_xbzrle(void);
 174 int64_t migrate_xbzrle_cache_size(void);
 175
 176 int64_t xbzrle_cache_resize(int64_t new_size);
 177
 178 bool migrate_use_compression(void);
 179 int migrate_compress_level(void);
 180 int migrate_compress_threads(void);
 181 int migrate_decompress_threads(void);
 182 bool migrate_use_events(void);
 183
 184 void ram_control_before_iterate(QEMUFile *f, uint64_t flags);
 185 void ram_control_after_iterate(QEMUFile *f, uint64_t flags);
 186 void ram_control_load_hook(QEMUFile *f, uint64_t flags, void *data);
 187
 188 /* Whenever this is found in the data stream, the flags
 189  * will be passed to ram_control_load_hook in the incoming-migration
 190  * side. This lets before_ram_iterate/after_ram_iterate add
 191  * transport-specific sections to the RAM migration data.
 192  */
 193 #define RAM_SAVE_FLAG_HOOK     0x80
 194
 195 #define RAM_SAVE_CONTROL_NOT_SUPP -1000
 196 #define RAM_SAVE_CONTROL_DELAYED  -2000
 197
 198 size_t ram_control_save_page(QEMUFile *f, ram_addr_t block_offset,
 199                              ram_addr_t offset, size_t size,
 200                              uint64_t *bytes_sent);
 201
 202 void ram_mig_init(void);
 203 void savevm_skip_section_footers(void);
 204 void register_global_state(void);
 205 void global_state_set_optional(void);
 206 void savevm_skip_configuration(void);
 207 int global_state_store(void);
 208 void global_state_store_running(void);
 209 #endif