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