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