1 /* 2 * QEMU migration miscellaneus exported functions 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 MIGRATION_MISC_H 15 #define MIGRATION_MISC_H 16 17 #include "qemu/notify.h" 18 #include "qapi/qapi-types-migration.h" 19 #include "qapi/qapi-types-net.h" 20 #include "migration/client-options.h" 21 22 /* migration/ram.c */ 23 24 typedef enum PrecopyNotifyReason { 25 PRECOPY_NOTIFY_SETUP = 0, 26 PRECOPY_NOTIFY_BEFORE_BITMAP_SYNC = 1, 27 PRECOPY_NOTIFY_AFTER_BITMAP_SYNC = 2, 28 PRECOPY_NOTIFY_COMPLETE = 3, 29 PRECOPY_NOTIFY_CLEANUP = 4, 30 PRECOPY_NOTIFY_MAX = 5, 31 } PrecopyNotifyReason; 32 33 typedef struct PrecopyNotifyData { 34 enum PrecopyNotifyReason reason; 35 } PrecopyNotifyData; 36 37 void precopy_infrastructure_init(void); 38 void precopy_add_notifier(NotifierWithReturn *n); 39 void precopy_remove_notifier(NotifierWithReturn *n); 40 int precopy_notify(PrecopyNotifyReason reason, Error **errp); 41 42 void qemu_guest_free_page_hint(void *addr, size_t len); 43 bool migrate_ram_is_ignored(RAMBlock *block); 44 45 /* migration/block.c */ 46 47 AnnounceParameters *migrate_announce_params(void); 48 49 /* migration/savevm.c */ 50 51 void dump_vmstate_json_to_file(FILE *out_fp); 52 void qemu_loadvm_start_load_thread(MigrationLoadThread function, 53 void *opaque); 54 55 /* migration/migration.c */ 56 void migration_object_init(void); 57 void migration_shutdown(void); 58 59 bool migration_is_running(void); 60 bool migration_thread_is_self(void); 61 62 typedef enum MigrationEventType { 63 MIG_EVENT_PRECOPY_SETUP, 64 MIG_EVENT_PRECOPY_DONE, 65 MIG_EVENT_PRECOPY_FAILED, 66 MIG_EVENT_MAX 67 } MigrationEventType; 68 69 typedef struct MigrationEvent { 70 MigrationEventType type; 71 } MigrationEvent; 72 73 /* 74 * A MigrationNotifyFunc may return an error code and an Error object, 75 * but only when @e->type is MIG_EVENT_PRECOPY_SETUP. The code is an int 76 * to allow for different failure modes and recovery actions. 77 */ 78 typedef int (*MigrationNotifyFunc)(NotifierWithReturn *notify, 79 MigrationEvent *e, Error **errp); 80 81 /* 82 * Register the notifier @notify to be called when a migration event occurs 83 * for MIG_MODE_NORMAL, as specified by the MigrationEvent passed to @func. 84 * Notifiers may receive events in any of the following orders: 85 * - MIG_EVENT_PRECOPY_SETUP -> MIG_EVENT_PRECOPY_DONE 86 * - MIG_EVENT_PRECOPY_SETUP -> MIG_EVENT_PRECOPY_FAILED 87 * - MIG_EVENT_PRECOPY_FAILED 88 */ 89 void migration_add_notifier(NotifierWithReturn *notify, 90 MigrationNotifyFunc func); 91 92 /* 93 * Same as migration_add_notifier, but applies to the specified @mode 94 * instead of MIG_MODE_NORMAL. 95 */ 96 void migration_add_notifier_mode(NotifierWithReturn *notify, 97 MigrationNotifyFunc func, MigMode mode); 98 99 /* 100 * Same as migration_add_notifier, but applies to the specified @modes 101 * (a bitset of MigMode). 102 */ 103 void migration_add_notifier_modes(NotifierWithReturn *notify, 104 MigrationNotifyFunc func, unsigned modes); 105 106 /* 107 * Remove a notifier from all modes. 108 */ 109 void migration_remove_notifier(NotifierWithReturn *notify); 110 111 void migration_file_set_error(int ret, Error *err); 112 113 /* True if incoming migration entered POSTCOPY_INCOMING_DISCARD */ 114 bool migration_in_incoming_postcopy(void); 115 116 /* True if incoming migration entered POSTCOPY_INCOMING_ADVISE */ 117 bool migration_incoming_postcopy_advised(void); 118 119 /* True if background snapshot is active */ 120 bool migration_in_bg_snapshot(void); 121 122 /* Wrapper for block active/inactive operations */ 123 bool migration_block_activate(Error **errp); 124 bool migration_block_inactivate(void); 125 126 /* True if @uri starts with a syntactically valid URI prefix */ 127 bool migrate_is_uri(const char *uri); 128 129 /* Parse @uri and return @channel, returning true on success */ 130 bool migrate_uri_parse(const char *uri, MigrationChannel **channel, 131 Error **errp); 132 133 /* migration/multifd-device-state.c */ 134 typedef struct SaveCompletePrecopyThreadData { 135 SaveCompletePrecopyThreadHandler hdlr; 136 char *idstr; 137 uint32_t instance_id; 138 void *handler_opaque; 139 } SaveCompletePrecopyThreadData; 140 141 bool multifd_queue_device_state(char *idstr, uint32_t instance_id, 142 char *data, size_t len); 143 bool multifd_device_state_supported(void); 144 145 void 146 multifd_spawn_device_state_save_thread(SaveCompletePrecopyThreadHandler hdlr, 147 char *idstr, uint32_t instance_id, 148 void *opaque); 149 150 bool multifd_device_state_save_thread_should_exit(void); 151 152 void multifd_abort_device_state_save_threads(void); 153 bool multifd_join_device_state_save_threads(void); 154 155 #endif 156