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 "qapi/qapi-types-migration.h" 19 #include "qemu/thread.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 /* Set this when we want the fault thread to quit */ 40 bool fault_thread_quit; 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 notify the fault_thread to wake, e.g., when need to quit */ 49 int userfault_event_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 MigrationIncomingState *migration_incoming_get_current(void); 67 void migration_incoming_state_destroy(void); 68 69 #define TYPE_MIGRATION "migration" 70 71 #define MIGRATION_CLASS(klass) \ 72 OBJECT_CLASS_CHECK(MigrationClass, (klass), TYPE_MIGRATION) 73 #define MIGRATION_OBJ(obj) \ 74 OBJECT_CHECK(MigrationState, (obj), TYPE_MIGRATION) 75 #define MIGRATION_GET_CLASS(obj) \ 76 OBJECT_GET_CLASS(MigrationClass, (obj), TYPE_MIGRATION) 77 78 typedef struct MigrationClass { 79 /*< private >*/ 80 DeviceClass parent_class; 81 } MigrationClass; 82 83 struct MigrationState 84 { 85 /*< private >*/ 86 DeviceState parent_obj; 87 88 /*< public >*/ 89 size_t bytes_xfer; 90 size_t xfer_limit; 91 QemuThread thread; 92 QEMUBH *cleanup_bh; 93 QEMUFile *to_dst_file; 94 95 /* bytes already send at the beggining of current interation */ 96 uint64_t iteration_initial_bytes; 97 /* time at the start of current iteration */ 98 int64_t iteration_start_time; 99 /* 100 * The final stage happens when the remaining data is smaller than 101 * this threshold; it's calculated from the requested downtime and 102 * measured bandwidth 103 */ 104 int64_t threshold_size; 105 106 /* params from 'migrate-set-parameters' */ 107 MigrationParameters parameters; 108 109 int state; 110 111 /* State related to return path */ 112 struct { 113 QEMUFile *from_dst_file; 114 QemuThread rp_thread; 115 bool error; 116 } rp_state; 117 118 double mbps; 119 /* Timestamp when recent migration starts (ms) */ 120 int64_t start_time; 121 /* Total time used by latest migration (ms) */ 122 int64_t total_time; 123 /* Timestamp when VM is down (ms) to migrate the last stuff */ 124 int64_t downtime_start; 125 int64_t downtime; 126 int64_t expected_downtime; 127 bool enabled_capabilities[MIGRATION_CAPABILITY__MAX]; 128 int64_t setup_time; 129 /* 130 * Whether guest was running when we enter the completion stage. 131 * If migration is interrupted by any reason, we need to continue 132 * running the guest on source. 133 */ 134 bool vm_was_running; 135 136 /* Flag set once the migration has been asked to enter postcopy */ 137 bool start_postcopy; 138 /* Flag set after postcopy has sent the device state */ 139 bool postcopy_after_devices; 140 141 /* Flag set once the migration thread is running (and needs joining) */ 142 bool migration_thread_running; 143 144 /* Flag set once the migration thread called bdrv_inactivate_all */ 145 bool block_inactive; 146 147 /* Migration is paused due to pause-before-switchover */ 148 QemuSemaphore pause_sem; 149 150 /* The semaphore is used to notify COLO thread that failover is finished */ 151 QemuSemaphore colo_exit_sem; 152 153 /* The semaphore is used to notify COLO thread to do checkpoint */ 154 QemuSemaphore colo_checkpoint_sem; 155 int64_t colo_checkpoint_time; 156 QEMUTimer *colo_delay_timer; 157 158 /* The first error that has occurred. 159 We used the mutex to be able to return the 1st error message */ 160 Error *error; 161 /* mutex to protect errp */ 162 QemuMutex error_mutex; 163 164 /* Do we have to clean up -b/-i from old migrate parameters */ 165 /* This feature is deprecated and will be removed */ 166 bool must_remove_block_options; 167 168 /* 169 * Global switch on whether we need to store the global state 170 * during migration. 171 */ 172 bool store_global_state; 173 174 /* Whether the VM is only allowing for migratable devices */ 175 bool only_migratable; 176 177 /* Whether we send QEMU_VM_CONFIGURATION during migration */ 178 bool send_configuration; 179 /* Whether we send section footer during migration */ 180 bool send_section_footer; 181 }; 182 183 void migrate_set_state(int *state, int old_state, int new_state); 184 185 void migration_fd_process_incoming(QEMUFile *f); 186 void migration_ioc_process_incoming(QIOChannel *ioc); 187 188 bool migration_has_all_channels(void); 189 190 uint64_t migrate_max_downtime(void); 191 192 void migrate_set_error(MigrationState *s, const Error *error); 193 void migrate_fd_error(MigrationState *s, const Error *error); 194 195 void migrate_fd_connect(MigrationState *s, Error *error_in); 196 197 void migrate_init(MigrationState *s); 198 bool migration_is_blocked(Error **errp); 199 /* True if outgoing migration has entered postcopy phase */ 200 bool migration_in_postcopy(void); 201 MigrationState *migrate_get_current(void); 202 203 bool migrate_postcopy(void); 204 205 bool migrate_release_ram(void); 206 bool migrate_postcopy_ram(void); 207 bool migrate_zero_blocks(void); 208 209 bool migrate_auto_converge(void); 210 bool migrate_use_multifd(void); 211 bool migrate_pause_before_switchover(void); 212 int migrate_multifd_channels(void); 213 int migrate_multifd_page_count(void); 214 215 int migrate_use_xbzrle(void); 216 int64_t migrate_xbzrle_cache_size(void); 217 bool migrate_colo_enabled(void); 218 219 bool migrate_use_block(void); 220 bool migrate_use_block_incremental(void); 221 bool migrate_use_return_path(void); 222 223 bool migrate_use_compression(void); 224 int migrate_compress_level(void); 225 int migrate_compress_threads(void); 226 int migrate_decompress_threads(void); 227 bool migrate_use_events(void); 228 229 /* Sending on the return path - generic and then for each message type */ 230 void migrate_send_rp_shut(MigrationIncomingState *mis, 231 uint32_t value); 232 void migrate_send_rp_pong(MigrationIncomingState *mis, 233 uint32_t value); 234 int migrate_send_rp_req_pages(MigrationIncomingState *mis, const char* rbname, 235 ram_addr_t start, size_t len); 236 237 #endif 238