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
  25 struct MigrationParams {
  26     bool blk;
  27     bool shared;
  28 };
  29
  30 typedef struct MigrationState MigrationState;
  31
  32 struct MigrationState
  33 {
  34     int64_t bandwidth_limit;
  35     size_t bytes_xfer;
  36     size_t xfer_limit;
  37     uint8_t *buffer;
  38     size_t buffer_size;
  39     size_t buffer_capacity;
  40     QemuThread thread;
  41     QEMUBH *cleanup_bh;
  42
  43     QEMUFile *file;
  44     int fd;
  45     int state;
  46     int (*get_error)(MigrationState *s);
  47     int (*close)(MigrationState *s);
  48     int (*write)(MigrationState *s, const void *buff, size_t size);
  49     void *opaque;
  50     MigrationParams params;
  51     int64_t total_time;
  52     int64_t downtime;
  53     int64_t expected_downtime;
  54     int64_t dirty_pages_rate;
  55     int64_t dirty_bytes_rate;
  56     bool enabled_capabilities[MIGRATION_CAPABILITY_MAX];
  57     int64_t xbzrle_cache_size;
  58 };
  59
  60 void process_incoming_migration(QEMUFile *f);
  61
  62 void qemu_start_incoming_migration(const char *uri, Error **errp);
  63
  64 uint64_t migrate_max_downtime(void);
  65
  66 void do_info_migrate_print(Monitor *mon, const QObject *data);
  67
  68 void do_info_migrate(Monitor *mon, QObject **ret_data);
  69
  70 void exec_start_incoming_migration(const char *host_port, Error **errp);
  71
  72 void exec_start_outgoing_migration(MigrationState *s, const char *host_port, Error **errp);
  73
  74 void tcp_start_incoming_migration(const char *host_port, Error **errp);
  75
  76 void tcp_start_outgoing_migration(MigrationState *s, const char *host_port, Error **errp);
  77
  78 void unix_start_incoming_migration(const char *path, Error **errp);
  79
  80 void unix_start_outgoing_migration(MigrationState *s, const char *path, Error **errp);
  81
  82 void fd_start_incoming_migration(const char *path, Error **errp);
  83
  84 void fd_start_outgoing_migration(MigrationState *s, const char *fdname, Error **errp);
  85
  86 void migrate_fd_error(MigrationState *s);
  87
  88 void migrate_fd_connect(MigrationState *s);
  89
  90 int migrate_fd_close(MigrationState *s);
  91
  92 void add_migration_state_change_notifier(Notifier *notify);
  93 void remove_migration_state_change_notifier(Notifier *notify);
  94 bool migration_is_active(MigrationState *);
  95 bool migration_has_finished(MigrationState *);
  96 bool migration_has_failed(MigrationState *);
  97 MigrationState *migrate_get_current(void);
  98
  99 uint64_t ram_bytes_remaining(void);
 100 uint64_t ram_bytes_transferred(void);
 101 uint64_t ram_bytes_total(void);
 102
 103 extern SaveVMHandlers savevm_ram_handlers;
 104
 105 uint64_t dup_mig_bytes_transferred(void);
 106 uint64_t dup_mig_pages_transferred(void);
 107 uint64_t norm_mig_bytes_transferred(void);
 108 uint64_t norm_mig_pages_transferred(void);
 109 uint64_t xbzrle_mig_bytes_transferred(void);
 110 uint64_t xbzrle_mig_pages_transferred(void);
 111 uint64_t xbzrle_mig_pages_overflow(void);
 112 uint64_t xbzrle_mig_pages_cache_miss(void);
 113
 114 /**
 115  * @migrate_add_blocker - prevent migration from proceeding
 116  *
 117  * @reason - an error to be returned whenever migration is attempted
 118  */
 119 void migrate_add_blocker(Error *reason);
 120
 121 /**
 122  * @migrate_del_blocker - remove a blocking error from migration
 123  *
 124  * @reason - the error blocking migration
 125  */
 126 void migrate_del_blocker(Error *reason);
 127
 128 int xbzrle_encode_buffer(uint8_t *old_buf, uint8_t *new_buf, int slen,
 129                          uint8_t *dst, int dlen);
 130 int xbzrle_decode_buffer(uint8_t *src, int slen, uint8_t *dst, int dlen);
 131
 132 int migrate_use_xbzrle(void);
 133 int64_t migrate_xbzrle_cache_size(void);
 134
 135 int64_t xbzrle_cache_resize(int64_t new_size);
 136 #endif