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
blk_mig_init(void)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_device(void);
65 bool migration_thread_is_self(void);
66 bool migration_is_setup_or_active(void);
67
68 typedef enum MigrationEventType {
69 MIG_EVENT_PRECOPY_SETUP,
70 MIG_EVENT_PRECOPY_DONE,
71 MIG_EVENT_PRECOPY_FAILED,
72 MIG_EVENT_MAX
73 } MigrationEventType;
74
75 typedef struct MigrationEvent {
76 MigrationEventType type;
77 } MigrationEvent;
78
79 /*
80 * A MigrationNotifyFunc may return an error code and an Error object,
81 * but only when @e->type is MIG_EVENT_PRECOPY_SETUP. The code is an int
82 * to allow for different failure modes and recovery actions.
83 */
84 typedef int (*MigrationNotifyFunc)(NotifierWithReturn *notify,
85 MigrationEvent *e, Error **errp);
86
87 /*
88 * Register the notifier @notify to be called when a migration event occurs
89 * for MIG_MODE_NORMAL, as specified by the MigrationEvent passed to @func.
90 * Notifiers may receive events in any of the following orders:
91 * - MIG_EVENT_PRECOPY_SETUP -> MIG_EVENT_PRECOPY_DONE
92 * - MIG_EVENT_PRECOPY_SETUP -> MIG_EVENT_PRECOPY_FAILED
93 * - MIG_EVENT_PRECOPY_FAILED
94 */
95 void migration_add_notifier(NotifierWithReturn *notify,
96 MigrationNotifyFunc func);
97
98 /*
99 * Same as migration_add_notifier, but applies to be specified @mode.
100 */
101 void migration_add_notifier_mode(NotifierWithReturn *notify,
102 MigrationNotifyFunc func, MigMode mode);
103
104 void migration_remove_notifier(NotifierWithReturn *notify);
105 bool migration_is_running(void);
106 void migration_file_set_error(int err);
107
108 /* True if incoming migration entered POSTCOPY_INCOMING_DISCARD */
109 bool migration_in_incoming_postcopy(void);
110
111 /* True if incoming migration entered POSTCOPY_INCOMING_ADVISE */
112 bool migration_incoming_postcopy_advised(void);
113
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