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