migration: convert post-copy to use QIOChannelBuffer
[qemu.git] / include / sysemu / sysemu.h
1 #ifndef SYSEMU_H
2 #define SYSEMU_H
3 /* Misc. things related to the system emulator. */
4
5 #include "qemu/option.h"
6 #include "qemu/queue.h"
7 #include "qemu/timer.h"
8 #include "qapi-types.h"
9 #include "qemu/notify.h"
10 #include "qemu/main-loop.h"
11 #include "qemu/bitmap.h"
12 #include "qom/object.h"
13
14 /* vl.c */
15
16 extern const char *bios_name;
17
18 extern const char *qemu_name;
19 extern uint8_t qemu_uuid[];
20 extern bool qemu_uuid_set;
21 int qemu_uuid_parse(const char *str, uint8_t *uuid);
22
23 #define UUID_FMT "%02hhx%02hhx%02hhx%02hhx-%02hhx%02hhx-%02hhx%02hhx-%02hhx%02hhx-%02hhx%02hhx%02hhx%02hhx%02hhx%02hhx"
24 #define UUID_NONE "00000000-0000-0000-0000-000000000000"
25
26 bool runstate_check(RunState state);
27 void runstate_set(RunState new_state);
28 int runstate_is_running(void);
29 bool runstate_needs_reset(void);
30 bool runstate_store(char *str, size_t size);
31 typedef struct vm_change_state_entry VMChangeStateEntry;
32 typedef void VMChangeStateHandler(void *opaque, int running, RunState state);
33
34 VMChangeStateEntry *qemu_add_vm_change_state_handler(VMChangeStateHandler *cb,
35 void *opaque);
36 void qemu_del_vm_change_state_handler(VMChangeStateEntry *e);
37 void vm_state_notify(int running, RunState state);
38
39 #define VMRESET_SILENT false
40 #define VMRESET_REPORT true
41
42 void vm_start(void);
43 int vm_stop(RunState state);
44 int vm_stop_force_state(RunState state);
45
46 typedef enum WakeupReason {
47 /* Always keep QEMU_WAKEUP_REASON_NONE = 0 */
48 QEMU_WAKEUP_REASON_NONE = 0,
49 QEMU_WAKEUP_REASON_RTC,
50 QEMU_WAKEUP_REASON_PMTIMER,
51 QEMU_WAKEUP_REASON_OTHER,
52 } WakeupReason;
53
54 void qemu_system_reset_request(void);
55 void qemu_system_suspend_request(void);
56 void qemu_register_suspend_notifier(Notifier *notifier);
57 void qemu_system_wakeup_request(WakeupReason reason);
58 void qemu_system_wakeup_enable(WakeupReason reason, bool enabled);
59 void qemu_register_wakeup_notifier(Notifier *notifier);
60 void qemu_system_shutdown_request(void);
61 void qemu_system_powerdown_request(void);
62 void qemu_register_powerdown_notifier(Notifier *notifier);
63 void qemu_system_debug_request(void);
64 void qemu_system_vmstop_request(RunState reason);
65 void qemu_system_vmstop_request_prepare(void);
66 int qemu_shutdown_requested_get(void);
67 int qemu_reset_requested_get(void);
68 void qemu_system_killed(int signal, pid_t pid);
69 void qemu_devices_reset(void);
70 void qemu_system_reset(bool report);
71 void qemu_system_guest_panicked(void);
72 size_t qemu_target_page_bits(void);
73
74 void qemu_add_exit_notifier(Notifier *notify);
75 void qemu_remove_exit_notifier(Notifier *notify);
76
77 void qemu_add_machine_init_done_notifier(Notifier *notify);
78
79 void hmp_savevm(Monitor *mon, const QDict *qdict);
80 int load_vmstate(const char *name);
81 void hmp_delvm(Monitor *mon, const QDict *qdict);
82 void hmp_info_snapshots(Monitor *mon, const QDict *qdict);
83
84 void qemu_announce_self(void);
85
86 /* Subcommands for QEMU_VM_COMMAND */
87 enum qemu_vm_cmd {
88 MIG_CMD_INVALID = 0, /* Must be 0 */
89 MIG_CMD_OPEN_RETURN_PATH, /* Tell the dest to open the Return path */
90 MIG_CMD_PING, /* Request a PONG on the RP */
91
92 MIG_CMD_POSTCOPY_ADVISE, /* Prior to any page transfers, just
93 warn we might want to do PC */
94 MIG_CMD_POSTCOPY_LISTEN, /* Start listening for incoming
95 pages as it's running. */
96 MIG_CMD_POSTCOPY_RUN, /* Start execution */
97
98 MIG_CMD_POSTCOPY_RAM_DISCARD, /* A list of pages to discard that
99 were previously sent during
100 precopy but are dirty. */
101 MIG_CMD_PACKAGED, /* Send a wrapped stream within this stream */
102 MIG_CMD_MAX
103 };
104
105 #define MAX_VM_CMD_PACKAGED_SIZE (1ul << 24)
106
107 bool qemu_savevm_state_blocked(Error **errp);
108 void qemu_savevm_state_begin(QEMUFile *f,
109 const MigrationParams *params);
110 void qemu_savevm_state_header(QEMUFile *f);
111 int qemu_savevm_state_iterate(QEMUFile *f, bool postcopy);
112 void qemu_savevm_state_cleanup(void);
113 void qemu_savevm_state_complete_postcopy(QEMUFile *f);
114 void qemu_savevm_state_complete_precopy(QEMUFile *f, bool iterable_only);
115 void qemu_savevm_state_pending(QEMUFile *f, uint64_t max_size,
116 uint64_t *res_non_postcopiable,
117 uint64_t *res_postcopiable);
118 void qemu_savevm_command_send(QEMUFile *f, enum qemu_vm_cmd command,
119 uint16_t len, uint8_t *data);
120 void qemu_savevm_send_ping(QEMUFile *f, uint32_t value);
121 void qemu_savevm_send_open_return_path(QEMUFile *f);
122 int qemu_savevm_send_packaged(QEMUFile *f, const uint8_t *buf, size_t len);
123 void qemu_savevm_send_postcopy_advise(QEMUFile *f);
124 void qemu_savevm_send_postcopy_listen(QEMUFile *f);
125 void qemu_savevm_send_postcopy_run(QEMUFile *f);
126
127 void qemu_savevm_send_postcopy_ram_discard(QEMUFile *f, const char *name,
128 uint16_t len,
129 uint64_t *start_list,
130 uint64_t *length_list);
131
132 int qemu_loadvm_state(QEMUFile *f);
133
134 extern int autostart;
135
136 typedef enum {
137 VGA_NONE, VGA_STD, VGA_CIRRUS, VGA_VMWARE, VGA_XENFB, VGA_QXL,
138 VGA_TCX, VGA_CG3, VGA_DEVICE, VGA_VIRTIO,
139 VGA_TYPE_MAX,
140 } VGAInterfaceType;
141
142 extern int vga_interface_type;
143 #define xenfb_enabled (vga_interface_type == VGA_XENFB)
144
145 extern int graphic_width;
146 extern int graphic_height;
147 extern int graphic_depth;
148 extern int display_opengl;
149 extern const char *keyboard_layout;
150 extern int win2k_install_hack;
151 extern int alt_grab;
152 extern int ctrl_grab;
153 extern int smp_cpus;
154 extern int max_cpus;
155 extern int cursor_hide;
156 extern int graphic_rotate;
157 extern int no_quit;
158 extern int no_shutdown;
159 extern int old_param;
160 extern int boot_menu;
161 extern bool boot_strict;
162 extern uint8_t *boot_splash_filedata;
163 extern size_t boot_splash_filedata_size;
164 extern bool enable_mlock;
165 extern uint8_t qemu_extra_params_fw[2];
166 extern QEMUClockType rtc_clock;
167 extern const char *mem_path;
168 extern int mem_prealloc;
169
170 #define MAX_NODES 128
171 #define NUMA_NODE_UNASSIGNED MAX_NODES
172
173 /* The following shall be true for all CPUs:
174 * cpu->cpu_index < max_cpus <= MAX_CPUMASK_BITS
175 *
176 * Note that cpu->get_arch_id() may be larger than MAX_CPUMASK_BITS.
177 */
178 #define MAX_CPUMASK_BITS 255
179
180 #define MAX_OPTION_ROMS 16
181 typedef struct QEMUOptionRom {
182 const char *name;
183 int32_t bootindex;
184 } QEMUOptionRom;
185 extern QEMUOptionRom option_rom[MAX_OPTION_ROMS];
186 extern int nb_option_roms;
187
188 #define MAX_PROM_ENVS 128
189 extern const char *prom_envs[MAX_PROM_ENVS];
190 extern unsigned int nb_prom_envs;
191
192 /* generic hotplug */
193 void hmp_drive_add(Monitor *mon, const QDict *qdict);
194
195 /* pcie aer error injection */
196 void hmp_pcie_aer_inject_error(Monitor *mon, const QDict *qdict);
197
198 /* serial ports */
199
200 #define MAX_SERIAL_PORTS 4
201
202 extern CharDriverState *serial_hds[MAX_SERIAL_PORTS];
203
204 /* parallel ports */
205
206 #define MAX_PARALLEL_PORTS 3
207
208 extern CharDriverState *parallel_hds[MAX_PARALLEL_PORTS];
209
210 void hmp_usb_add(Monitor *mon, const QDict *qdict);
211 void hmp_usb_del(Monitor *mon, const QDict *qdict);
212 void hmp_info_usb(Monitor *mon, const QDict *qdict);
213
214 void add_boot_device_path(int32_t bootindex, DeviceState *dev,
215 const char *suffix);
216 char *get_boot_devices_list(size_t *size, bool ignore_suffixes);
217
218 DeviceState *get_boot_device(uint32_t position);
219 void check_boot_index(int32_t bootindex, Error **errp);
220 void del_boot_device_path(DeviceState *dev, const char *suffix);
221 void device_add_bootindex_property(Object *obj, int32_t *bootindex,
222 const char *name, const char *suffix,
223 DeviceState *dev, Error **errp);
224 void restore_boot_order(void *opaque);
225 void validate_bootdevices(const char *devices, Error **errp);
226
227 /* handler to set the boot_device order for a specific type of MachineClass */
228 typedef void QEMUBootSetHandler(void *opaque, const char *boot_order,
229 Error **errp);
230 void qemu_register_boot_set(QEMUBootSetHandler *func, void *opaque);
231 void qemu_boot_set(const char *boot_order, Error **errp);
232
233 QemuOpts *qemu_get_machine_opts(void);
234
235 bool defaults_enabled(void);
236 bool usb_enabled(void);
237
238 extern QemuOptsList qemu_legacy_drive_opts;
239 extern QemuOptsList qemu_common_drive_opts;
240 extern QemuOptsList qemu_drive_opts;
241 extern QemuOptsList qemu_chardev_opts;
242 extern QemuOptsList qemu_device_opts;
243 extern QemuOptsList qemu_netdev_opts;
244 extern QemuOptsList qemu_net_opts;
245 extern QemuOptsList qemu_global_opts;
246 extern QemuOptsList qemu_mon_opts;
247
248 #endif