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 ram_mig_init(void); 43 void qemu_guest_free_page_hint(void *addr, size_t len); 44 bool migrate_ram_is_ignored(RAMBlock *block); 45 46 /* migration/block.c */ 47 48 #ifdef CONFIG_LIVE_BLOCK_MIGRATION 49 void blk_mig_init(void); 50 #else 51 static inline void blk_mig_init(void) {} 52 #endif 53 54 AnnounceParameters *migrate_announce_params(void); 55 /* migration/savevm.c */ 56 57 void dump_vmstate_json_to_file(FILE *out_fp); 58 59 /* migration/migration.c */ 60 void migration_object_init(void); 61 void migration_shutdown(void); 62 bool migration_is_idle(void); 63 bool migration_is_active(void); 64 bool migration_is_setup_or_active(void); 65 bool migrate_mode_is_cpr(MigrationState *); 66 67 typedef enum MigrationEventType { 68 MIG_EVENT_PRECOPY_SETUP, 69 MIG_EVENT_PRECOPY_DONE, 70 MIG_EVENT_PRECOPY_FAILED, 71 MIG_EVENT_MAX 72 } MigrationEventType; 73 74 typedef struct MigrationEvent { 75 MigrationEventType type; 76 } MigrationEvent; 77 78 /* 79 * A MigrationNotifyFunc may return an error code and an Error object, 80 * but only when @e->type is MIG_EVENT_PRECOPY_SETUP. The code is an int 81 * to allow for different failure modes and recovery actions. 82 */ 83 typedef int (*MigrationNotifyFunc)(NotifierWithReturn *notify, 84 MigrationEvent *e, Error **errp); 85 86 /* 87 * Register the notifier @notify to be called when a migration event occurs 88 * for MIG_MODE_NORMAL, as specified by the MigrationEvent passed to @func. 89 * Notifiers may receive events in any of the following orders: 90 * - MIG_EVENT_PRECOPY_SETUP -> MIG_EVENT_PRECOPY_DONE 91 * - MIG_EVENT_PRECOPY_SETUP -> MIG_EVENT_PRECOPY_FAILED 92 * - MIG_EVENT_PRECOPY_FAILED 93 */ 94 void migration_add_notifier(NotifierWithReturn *notify, 95 MigrationNotifyFunc func); 96 97 /* 98 * Same as migration_add_notifier, but applies to be specified @mode. 99 */ 100 void migration_add_notifier_mode(NotifierWithReturn *notify, 101 MigrationNotifyFunc func, MigMode mode); 102 103 void migration_remove_notifier(NotifierWithReturn *notify); 104 int migration_call_notifiers(MigrationState *s, MigrationEventType type, 105 Error **errp); 106 bool migration_in_setup(MigrationState *); 107 bool migration_has_finished(MigrationState *); 108 bool migration_has_failed(MigrationState *); 109 /* ...and after the device transmission */ 110 /* True if incoming migration entered POSTCOPY_INCOMING_DISCARD */ 111 bool migration_in_incoming_postcopy(void); 112 /* True if incoming migration entered POSTCOPY_INCOMING_ADVISE */ 113 bool migration_incoming_postcopy_advised(void); 114 /* True if background snapshot is active */ 115 bool migration_in_bg_snapshot(void); 116 117 /* migration/block-dirty-bitmap.c */ 118 void dirty_bitmap_mig_init(void); 119 120 #endif 121