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