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