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 /* migration/savevm.c */ 49 50 void dump_vmstate_json_to_file(FILE *out_fp); 51 52 /* migration/migration.c */ 53 void migration_object_init(void); 54 void migration_shutdown(void); 55 56 bool migration_is_running(void); 57 bool migration_thread_is_self(void); 58 59 typedef enum MigrationEventType { 60 MIG_EVENT_PRECOPY_SETUP, 61 MIG_EVENT_PRECOPY_DONE, 62 MIG_EVENT_PRECOPY_FAILED, 63 MIG_EVENT_MAX 64 } MigrationEventType; 65 66 typedef struct MigrationEvent { 67 MigrationEventType type; 68 } MigrationEvent; 69 70 /* 71 * A MigrationNotifyFunc may return an error code and an Error object, 72 * but only when @e->type is MIG_EVENT_PRECOPY_SETUP. The code is an int 73 * to allow for different failure modes and recovery actions. 74 */ 75 typedef int (*MigrationNotifyFunc)(NotifierWithReturn *notify, 76 MigrationEvent *e, Error **errp); 77 78 /* 79 * Register the notifier @notify to be called when a migration event occurs 80 * for MIG_MODE_NORMAL, as specified by the MigrationEvent passed to @func. 81 * Notifiers may receive events in any of the following orders: 82 * - MIG_EVENT_PRECOPY_SETUP -> MIG_EVENT_PRECOPY_DONE 83 * - MIG_EVENT_PRECOPY_SETUP -> MIG_EVENT_PRECOPY_FAILED 84 * - MIG_EVENT_PRECOPY_FAILED 85 */ 86 void migration_add_notifier(NotifierWithReturn *notify, 87 MigrationNotifyFunc func); 88 89 /* 90 * Same as migration_add_notifier, but applies to be specified @mode. 91 */ 92 void migration_add_notifier_mode(NotifierWithReturn *notify, 93 MigrationNotifyFunc func, MigMode mode); 94 95 void migration_remove_notifier(NotifierWithReturn *notify); 96 void migration_file_set_error(int ret, Error *err); 97 98 /* True if incoming migration entered POSTCOPY_INCOMING_DISCARD */ 99 bool migration_in_incoming_postcopy(void); 100 101 /* True if incoming migration entered POSTCOPY_INCOMING_ADVISE */ 102 bool migration_incoming_postcopy_advised(void); 103 104 /* True if background snapshot is active */ 105 bool migration_in_bg_snapshot(void); 106 107 /* Wrapper for block active/inactive operations */ 108 bool migration_block_activate(Error **errp); 109 bool migration_block_inactivate(void); 110 111 /* True if @uri starts with a syntactically valid URI prefix */ 112 bool migrate_is_uri(const char *uri); 113 114 /* Parse @uri and return @channel, returning true on success */ 115 bool migrate_uri_parse(const char *uri, MigrationChannel **channel, 116 Error **errp); 117 118 #endif 119