4 * Copyright IBM, Corp. 2008
7 * Anthony Liguori <aliguori@us.ibm.com>
9 * This work is licensed under the terms of the GNU GPL, version 2. See
10 * the COPYING file in the top-level directory.
12 * Contributions after 2012-01-13 are licensed under the terms of the
13 * GNU GPL, version 2 or (at your option) any later version.
16 #include "qemu-common.h"
17 #include "migration.h"
19 #include "buffered_file.h"
22 #include "qemu_socket.h"
23 #include "block-migration.h"
24 #include "qmp-commands.h"
26 //#define DEBUG_MIGRATION
28 #ifdef DEBUG_MIGRATION
29 #define DPRINTF(fmt, ...) \
30 do { printf("migration: " fmt, ## __VA_ARGS__); } while (0)
32 #define DPRINTF(fmt, ...) \
44 #define MAX_THROTTLE (32 << 20) /* Migration speed throttling */
46 /* Migration XBZRLE default cache size */
47 #define DEFAULT_MIGRATE_CACHE_SIZE (64 * 1024 * 1024)
49 static NotifierList migration_state_notifiers
=
50 NOTIFIER_LIST_INITIALIZER(migration_state_notifiers
);
52 /* When we add fault tolerance, we could have several
53 migrations at once. For now we don't need to add
54 dynamic creation of migration */
56 MigrationState
*migrate_get_current(void)
58 static MigrationState current_migration
= {
59 .state
= MIG_STATE_SETUP
,
60 .bandwidth_limit
= MAX_THROTTLE
,
61 .xbzrle_cache_size
= DEFAULT_MIGRATE_CACHE_SIZE
,
64 return ¤t_migration
;
67 int qemu_start_incoming_migration(const char *uri
, Error
**errp
)
72 if (strstart(uri
, "tcp:", &p
))
73 ret
= tcp_start_incoming_migration(p
, errp
);
75 else if (strstart(uri
, "exec:", &p
))
76 ret
= exec_start_incoming_migration(p
);
77 else if (strstart(uri
, "unix:", &p
))
78 ret
= unix_start_incoming_migration(p
, errp
);
79 else if (strstart(uri
, "fd:", &p
))
80 ret
= fd_start_incoming_migration(p
);
83 fprintf(stderr
, "unknown migration protocol: %s\n", uri
);
84 ret
= -EPROTONOSUPPORT
;
89 void process_incoming_migration(QEMUFile
*f
)
91 if (qemu_loadvm_state(f
) < 0) {
92 fprintf(stderr
, "load of migration failed\n");
96 DPRINTF("successfully loaded vm state\n");
98 bdrv_clear_incoming_migration_all();
99 /* Make sure all file formats flush their mutable metadata */
100 bdrv_invalidate_cache_all();
105 runstate_set(RUN_STATE_PRELAUNCH
);
109 /* amount of nanoseconds we are willing to wait for migration to be down.
110 * the choice of nanoseconds is because it is the maximum resolution that
111 * get_clock() can achieve. It is an internal measure. All user-visible
112 * units must be in seconds */
113 static uint64_t max_downtime
= 30000000;
115 uint64_t migrate_max_downtime(void)
120 MigrationCapabilityStatusList
*qmp_query_migrate_capabilities(Error
**errp
)
122 MigrationCapabilityStatusList
*head
= NULL
;
123 MigrationCapabilityStatusList
*caps
;
124 MigrationState
*s
= migrate_get_current();
127 for (i
= 0; i
< MIGRATION_CAPABILITY_MAX
; i
++) {
129 head
= g_malloc0(sizeof(*caps
));
132 caps
->next
= g_malloc0(sizeof(*caps
));
136 g_malloc(sizeof(*caps
->value
));
137 caps
->value
->capability
= i
;
138 caps
->value
->state
= s
->enabled_capabilities
[i
];
144 static void get_xbzrle_cache_stats(MigrationInfo
*info
)
146 if (migrate_use_xbzrle()) {
147 info
->has_xbzrle_cache
= true;
148 info
->xbzrle_cache
= g_malloc0(sizeof(*info
->xbzrle_cache
));
149 info
->xbzrle_cache
->cache_size
= migrate_xbzrle_cache_size();
150 info
->xbzrle_cache
->bytes
= xbzrle_mig_bytes_transferred();
151 info
->xbzrle_cache
->pages
= xbzrle_mig_pages_transferred();
152 info
->xbzrle_cache
->cache_miss
= xbzrle_mig_pages_cache_miss();
153 info
->xbzrle_cache
->overflow
= xbzrle_mig_pages_overflow();
157 MigrationInfo
*qmp_query_migrate(Error
**errp
)
159 MigrationInfo
*info
= g_malloc0(sizeof(*info
));
160 MigrationState
*s
= migrate_get_current();
163 case MIG_STATE_SETUP
:
164 /* no migration has happened ever */
166 case MIG_STATE_ACTIVE
:
167 info
->has_status
= true;
168 info
->status
= g_strdup("active");
169 info
->has_total_time
= true;
170 info
->total_time
= qemu_get_clock_ms(rt_clock
)
172 info
->has_expected_downtime
= true;
173 info
->expected_downtime
= s
->expected_downtime
;
175 info
->has_ram
= true;
176 info
->ram
= g_malloc0(sizeof(*info
->ram
));
177 info
->ram
->transferred
= ram_bytes_transferred();
178 info
->ram
->remaining
= ram_bytes_remaining();
179 info
->ram
->total
= ram_bytes_total();
180 info
->ram
->duplicate
= dup_mig_pages_transferred();
181 info
->ram
->normal
= norm_mig_pages_transferred();
182 info
->ram
->normal_bytes
= norm_mig_bytes_transferred();
183 info
->ram
->dirty_pages_rate
= s
->dirty_pages_rate
;
186 if (blk_mig_active()) {
187 info
->has_disk
= true;
188 info
->disk
= g_malloc0(sizeof(*info
->disk
));
189 info
->disk
->transferred
= blk_mig_bytes_transferred();
190 info
->disk
->remaining
= blk_mig_bytes_remaining();
191 info
->disk
->total
= blk_mig_bytes_total();
194 get_xbzrle_cache_stats(info
);
196 case MIG_STATE_COMPLETED
:
197 get_xbzrle_cache_stats(info
);
199 info
->has_status
= true;
200 info
->status
= g_strdup("completed");
201 info
->total_time
= s
->total_time
;
202 info
->has_downtime
= true;
203 info
->downtime
= s
->downtime
;
205 info
->has_ram
= true;
206 info
->ram
= g_malloc0(sizeof(*info
->ram
));
207 info
->ram
->transferred
= ram_bytes_transferred();
208 info
->ram
->remaining
= 0;
209 info
->ram
->total
= ram_bytes_total();
210 info
->ram
->duplicate
= dup_mig_pages_transferred();
211 info
->ram
->normal
= norm_mig_pages_transferred();
212 info
->ram
->normal_bytes
= norm_mig_bytes_transferred();
214 case MIG_STATE_ERROR
:
215 info
->has_status
= true;
216 info
->status
= g_strdup("failed");
218 case MIG_STATE_CANCELLED
:
219 info
->has_status
= true;
220 info
->status
= g_strdup("cancelled");
227 void qmp_migrate_set_capabilities(MigrationCapabilityStatusList
*params
,
230 MigrationState
*s
= migrate_get_current();
231 MigrationCapabilityStatusList
*cap
;
233 if (s
->state
== MIG_STATE_ACTIVE
) {
234 error_set(errp
, QERR_MIGRATION_ACTIVE
);
238 for (cap
= params
; cap
; cap
= cap
->next
) {
239 s
->enabled_capabilities
[cap
->value
->capability
] = cap
->value
->state
;
243 /* shared migration helpers */
245 static int migrate_fd_cleanup(MigrationState
*s
)
250 qemu_set_fd_handler2(s
->fd
, NULL
, NULL
, NULL
, NULL
);
254 DPRINTF("closing file\n");
255 ret
= qemu_fclose(s
->file
);
267 void migrate_fd_error(MigrationState
*s
)
269 DPRINTF("setting error state\n");
270 s
->state
= MIG_STATE_ERROR
;
271 notifier_list_notify(&migration_state_notifiers
, s
);
272 migrate_fd_cleanup(s
);
275 static void migrate_fd_completed(MigrationState
*s
)
277 DPRINTF("setting completed state\n");
278 if (migrate_fd_cleanup(s
) < 0) {
279 s
->state
= MIG_STATE_ERROR
;
281 s
->state
= MIG_STATE_COMPLETED
;
282 runstate_set(RUN_STATE_POSTMIGRATE
);
284 notifier_list_notify(&migration_state_notifiers
, s
);
287 static void migrate_fd_put_notify(void *opaque
)
289 MigrationState
*s
= opaque
;
292 qemu_set_fd_handler2(s
->fd
, NULL
, NULL
, NULL
, NULL
);
293 ret
= qemu_file_put_notify(s
->file
);
299 ssize_t
migrate_fd_put_buffer(MigrationState
*s
, const void *data
,
304 if (s
->state
!= MIG_STATE_ACTIVE
) {
309 ret
= s
->write(s
, data
, size
);
310 } while (ret
== -1 && ((s
->get_error(s
)) == EINTR
));
313 ret
= -(s
->get_error(s
));
315 if (ret
== -EAGAIN
) {
316 qemu_set_fd_handler2(s
->fd
, NULL
, NULL
, migrate_fd_put_notify
, s
);
322 void migrate_fd_put_ready(MigrationState
*s
)
326 if (s
->state
!= MIG_STATE_ACTIVE
) {
327 DPRINTF("put_ready returning because of non-active state\n");
331 DPRINTF("iterate\n");
332 ret
= qemu_savevm_state_iterate(s
->file
);
335 } else if (ret
== 1) {
336 int old_vm_running
= runstate_is_running();
337 int64_t start_time
, end_time
;
339 DPRINTF("done iterating\n");
340 start_time
= qemu_get_clock_ms(rt_clock
);
341 qemu_system_wakeup_request(QEMU_WAKEUP_REASON_OTHER
);
342 vm_stop_force_state(RUN_STATE_FINISH_MIGRATE
);
344 if (qemu_savevm_state_complete(s
->file
) < 0) {
347 migrate_fd_completed(s
);
349 end_time
= qemu_get_clock_ms(rt_clock
);
350 s
->total_time
= end_time
- s
->total_time
;
351 s
->downtime
= end_time
- start_time
;
352 if (s
->state
!= MIG_STATE_COMPLETED
) {
353 if (old_vm_running
) {
360 static void migrate_fd_cancel(MigrationState
*s
)
362 if (s
->state
!= MIG_STATE_ACTIVE
)
365 DPRINTF("cancelling migration\n");
367 s
->state
= MIG_STATE_CANCELLED
;
368 notifier_list_notify(&migration_state_notifiers
, s
);
369 qemu_savevm_state_cancel(s
->file
);
371 migrate_fd_cleanup(s
);
374 int migrate_fd_wait_for_unfreeze(MigrationState
*s
)
378 DPRINTF("wait for unfreeze\n");
379 if (s
->state
!= MIG_STATE_ACTIVE
)
386 FD_SET(s
->fd
, &wfds
);
388 ret
= select(s
->fd
+ 1, NULL
, &wfds
, NULL
, NULL
);
389 } while (ret
== -1 && (s
->get_error(s
)) == EINTR
);
392 return -s
->get_error(s
);
397 int migrate_fd_close(MigrationState
*s
)
399 qemu_set_fd_handler2(s
->fd
, NULL
, NULL
, NULL
, NULL
);
403 void add_migration_state_change_notifier(Notifier
*notify
)
405 notifier_list_add(&migration_state_notifiers
, notify
);
408 void remove_migration_state_change_notifier(Notifier
*notify
)
410 notifier_remove(notify
);
413 bool migration_is_active(MigrationState
*s
)
415 return s
->state
== MIG_STATE_ACTIVE
;
418 bool migration_has_finished(MigrationState
*s
)
420 return s
->state
== MIG_STATE_COMPLETED
;
423 bool migration_has_failed(MigrationState
*s
)
425 return (s
->state
== MIG_STATE_CANCELLED
||
426 s
->state
== MIG_STATE_ERROR
);
429 void migrate_fd_connect(MigrationState
*s
)
433 s
->state
= MIG_STATE_ACTIVE
;
434 s
->file
= qemu_fopen_ops_buffered(s
);
436 DPRINTF("beginning savevm\n");
437 ret
= qemu_savevm_state_begin(s
->file
, &s
->params
);
439 DPRINTF("failed, %d\n", ret
);
443 migrate_fd_put_ready(s
);
446 static MigrationState
*migrate_init(const MigrationParams
*params
)
448 MigrationState
*s
= migrate_get_current();
449 int64_t bandwidth_limit
= s
->bandwidth_limit
;
450 bool enabled_capabilities
[MIGRATION_CAPABILITY_MAX
];
451 int64_t xbzrle_cache_size
= s
->xbzrle_cache_size
;
453 memcpy(enabled_capabilities
, s
->enabled_capabilities
,
454 sizeof(enabled_capabilities
));
456 memset(s
, 0, sizeof(*s
));
457 s
->bandwidth_limit
= bandwidth_limit
;
459 memcpy(s
->enabled_capabilities
, enabled_capabilities
,
460 sizeof(enabled_capabilities
));
461 s
->xbzrle_cache_size
= xbzrle_cache_size
;
463 s
->bandwidth_limit
= bandwidth_limit
;
464 s
->state
= MIG_STATE_SETUP
;
465 s
->total_time
= qemu_get_clock_ms(rt_clock
);
470 static GSList
*migration_blockers
;
472 void migrate_add_blocker(Error
*reason
)
474 migration_blockers
= g_slist_prepend(migration_blockers
, reason
);
477 void migrate_del_blocker(Error
*reason
)
479 migration_blockers
= g_slist_remove(migration_blockers
, reason
);
482 void qmp_migrate(const char *uri
, bool has_blk
, bool blk
,
483 bool has_inc
, bool inc
, bool has_detach
, bool detach
,
486 Error
*local_err
= NULL
;
487 MigrationState
*s
= migrate_get_current();
488 MigrationParams params
;
494 if (s
->state
== MIG_STATE_ACTIVE
) {
495 error_set(errp
, QERR_MIGRATION_ACTIVE
);
499 if (qemu_savevm_state_blocked(errp
)) {
503 if (migration_blockers
) {
504 *errp
= error_copy(migration_blockers
->data
);
508 s
= migrate_init(¶ms
);
510 if (strstart(uri
, "tcp:", &p
)) {
511 tcp_start_outgoing_migration(s
, p
, &local_err
);
513 } else if (strstart(uri
, "exec:", &p
)) {
514 exec_start_outgoing_migration(s
, p
, &local_err
);
515 } else if (strstart(uri
, "unix:", &p
)) {
516 unix_start_outgoing_migration(s
, p
, &local_err
);
517 } else if (strstart(uri
, "fd:", &p
)) {
518 fd_start_outgoing_migration(s
, p
, &local_err
);
521 error_set(errp
, QERR_INVALID_PARAMETER_VALUE
, "uri", "a valid migration protocol");
527 error_propagate(errp
, local_err
);
531 notifier_list_notify(&migration_state_notifiers
, s
);
534 void qmp_migrate_cancel(Error
**errp
)
536 migrate_fd_cancel(migrate_get_current());
539 void qmp_migrate_set_cache_size(int64_t value
, Error
**errp
)
541 MigrationState
*s
= migrate_get_current();
543 /* Check for truncation */
544 if (value
!= (size_t)value
) {
545 error_set(errp
, QERR_INVALID_PARAMETER_VALUE
, "cache size",
546 "exceeding address space");
550 s
->xbzrle_cache_size
= xbzrle_cache_resize(value
);
553 int64_t qmp_query_migrate_cache_size(Error
**errp
)
555 return migrate_xbzrle_cache_size();
558 void qmp_migrate_set_speed(int64_t value
, Error
**errp
)
566 s
= migrate_get_current();
567 s
->bandwidth_limit
= value
;
568 qemu_file_set_rate_limit(s
->file
, s
->bandwidth_limit
);
571 void qmp_migrate_set_downtime(double value
, Error
**errp
)
574 value
= MAX(0, MIN(UINT64_MAX
, value
));
575 max_downtime
= (uint64_t)value
;
578 int migrate_use_xbzrle(void)
582 s
= migrate_get_current();
584 return s
->enabled_capabilities
[MIGRATION_CAPABILITY_XBZRLE
];
587 int64_t migrate_xbzrle_cache_size(void)
591 s
= migrate_get_current();
593 return s
->xbzrle_cache_size
;