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 "qemu-common.h"
  18 #include "qemu/thread.h"
  19 #include "qapi-types.h"
  20 #include "exec/cpu-common.h"
  21 #include "qemu/coroutine_int.h"
  22 #include "hw/qdev.h"
  23 #include "io/channel.h"
  24
  25 struct PostcopyBlocktimeContext;
  26
  27 /* State for the incoming migration */
  28 struct MigrationIncomingState {
  29     QEMUFile *from_src_file;
  30
  31     /*
  32      * Free at the start of the main state load, set as the main thread finishes
  33      * loading state.
  34      */
  35     QemuEvent main_thread_load_event;
  36
  37     size_t         largest_page_size;
  38     bool           have_fault_thread;
  39     QemuThread     fault_thread;
  40     QemuSemaphore  fault_thread_sem;
  41
  42     bool           have_listen_thread;
  43     QemuThread     listen_thread;
  44     QemuSemaphore  listen_thread_sem;
  45
  46     /* For the kernel to send us notifications */
  47     int       userfault_fd;
  48     /* To tell the fault_thread to quit */
  49     int       userfault_quit_fd;
  50     QEMUFile *to_src_file;
  51     QemuMutex rp_mutex;    /* We send replies from multiple threads */
  52     void     *postcopy_tmp_page;
  53     void     *postcopy_tmp_zero_page;
  54
  55     QEMUBH *bh;
  56
  57     int state;
  58
  59     bool have_colo_incoming_thread;
  60     QemuThread colo_incoming_thread;
  61     /* The coroutine we should enter (back) after failover */
  62     Coroutine *migration_incoming_co;
  63     QemuSemaphore colo_incoming_sem;
  64
  65     /*
  66      * PostcopyBlocktimeContext to keep information for postcopy
  67      * live migration, to calculate vCPU block time
  68      * */
  69     struct PostcopyBlocktimeContext *blocktime_ctx;
  70 };
  71
  72 MigrationIncomingState *migration_incoming_get_current(void);
  73 void migration_incoming_state_destroy(void);
  74
  75 #define TYPE_MIGRATION "migration"
  76
  77 #define MIGRATION_CLASS(klass) \
  78     OBJECT_CLASS_CHECK(MigrationClass, (klass), TYPE_MIGRATION)
  79 #define MIGRATION_OBJ(obj) \
  80     OBJECT_CHECK(MigrationState, (obj), TYPE_MIGRATION)
  81 #define MIGRATION_GET_CLASS(obj) \
  82     OBJECT_GET_CLASS(MigrationClass, (obj), TYPE_MIGRATION)
  83
  84 typedef struct MigrationClass {
  85     /*< private >*/
  86     DeviceClass parent_class;
  87 } MigrationClass;
  88
  89 struct MigrationState
  90 {
  91     /*< private >*/
  92     DeviceState parent_obj;
  93
  94     /*< public >*/
  95     size_t bytes_xfer;
  96     size_t xfer_limit;
  97     QemuThread thread;
  98     QEMUBH *cleanup_bh;
  99     QEMUFile *to_dst_file;
 100
 101     /* params from 'migrate-set-parameters' */
 102     MigrationParameters parameters;
 103
 104     int state;
 105
 106     /* State related to return path */
 107     struct {
 108         QEMUFile     *from_dst_file;
 109         QemuThread    rp_thread;
 110         bool          error;
 111     } rp_state;
 112
 113     double mbps;
 114     int64_t total_time;
 115     int64_t downtime;
 116     int64_t expected_downtime;
 117     bool enabled_capabilities[MIGRATION_CAPABILITY__MAX];
 118     int64_t setup_time;
 119
 120     /* Flag set once the migration has been asked to enter postcopy */
 121     bool start_postcopy;
 122     /* Flag set after postcopy has sent the device state */
 123     bool postcopy_after_devices;
 124
 125     /* Flag set once the migration thread is running (and needs joining) */
 126     bool migration_thread_running;
 127
 128     /* Flag set once the migration thread called bdrv_inactivate_all */
 129     bool block_inactive;
 130
 131     /* Migration is paused due to pause-before-switchover */
 132     QemuSemaphore pause_sem;
 133
 134     /* The semaphore is used to notify COLO thread that failover is finished */
 135     QemuSemaphore colo_exit_sem;
 136
 137     /* The semaphore is used to notify COLO thread to do checkpoint */
 138     QemuSemaphore colo_checkpoint_sem;
 139     int64_t colo_checkpoint_time;
 140     QEMUTimer *colo_delay_timer;
 141
 142     /* The first error that has occurred.
 143        We used the mutex to be able to return the 1st error message */
 144     Error *error;
 145     /* mutex to protect errp */
 146     QemuMutex error_mutex;
 147
 148     /* Do we have to clean up -b/-i from old migrate parameters */
 149     /* This feature is deprecated and will be removed */
 150     bool must_remove_block_options;
 151
 152     /*
 153      * Global switch on whether we need to store the global state
 154      * during migration.
 155      */
 156     bool store_global_state;
 157
 158     /* Whether the VM is only allowing for migratable devices */
 159     bool only_migratable;
 160
 161     /* Whether we send QEMU_VM_CONFIGURATION during migration */
 162     bool send_configuration;
 163     /* Whether we send section footer during migration */
 164     bool send_section_footer;
 165 };
 166
 167 void migrate_set_state(int *state, int old_state, int new_state);
 168
 169 void migration_fd_process_incoming(QEMUFile *f);
 170 void migration_ioc_process_incoming(QIOChannel *ioc);
 171
 172 bool  migration_has_all_channels(void);
 173
 174 uint64_t migrate_max_downtime(void);
 175
 176 void migrate_set_error(MigrationState *s, const Error *error);
 177 void migrate_fd_error(MigrationState *s, const Error *error);
 178
 179 void migrate_fd_connect(MigrationState *s);
 180
 181 MigrationState *migrate_init(void);
 182 bool migration_is_blocked(Error **errp);
 183 /* True if outgoing migration has entered postcopy phase */
 184 bool migration_in_postcopy(void);
 185 MigrationState *migrate_get_current(void);
 186
 187 bool migrate_postcopy(void);
 188
 189 bool migrate_release_ram(void);
 190 bool migrate_postcopy_ram(void);
 191 bool migrate_zero_blocks(void);
 192
 193 bool migrate_auto_converge(void);
 194 bool migrate_use_multifd(void);
 195 bool migrate_pause_before_switchover(void);
 196 int migrate_multifd_channels(void);
 197 int migrate_multifd_page_count(void);
 198
 199 int migrate_use_xbzrle(void);
 200 int64_t migrate_xbzrle_cache_size(void);
 201 bool migrate_colo_enabled(void);
 202
 203 bool migrate_use_block(void);
 204 bool migrate_use_block_incremental(void);
 205 bool migrate_use_return_path(void);
 206
 207 bool migrate_use_compression(void);
 208 int migrate_compress_level(void);
 209 int migrate_compress_threads(void);
 210 int migrate_decompress_threads(void);
 211 bool migrate_use_events(void);
 212 bool migrate_postcopy_blocktime(void);
 213
 214 /* Sending on the return path - generic and then for each message type */
 215 void migrate_send_rp_shut(MigrationIncomingState *mis,
 216                           uint32_t value);
 217 void migrate_send_rp_pong(MigrationIncomingState *mis,
 218                           uint32_t value);
 219 void migrate_send_rp_req_pages(MigrationIncomingState *mis, const char* rbname,
 220                               ram_addr_t start, size_t len);
 221
 222 #endif