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