Merge remote-tracking branch 'remotes/mst/tags/for_upstream' into staging
[sdk/emulator/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/typedefs.h"
6 #include "qemu/option.h"
7 #include "qemu/queue.h"
8 #include "qemu/timer.h"
9 #include "qapi-types.h"
10 #include "qemu/notify.h"
11 #include "qemu/main-loop.h"
12
13 /* vl.c */
14
15 extern const char *bios_name;
16
17 extern const char *qemu_name;
18 extern uint8_t qemu_uuid[];
19 extern bool qemu_uuid_set;
20 int qemu_uuid_parse(const char *str, uint8_t *uuid);
21
22 #define UUID_FMT "%02hhx%02hhx%02hhx%02hhx-%02hhx%02hhx-%02hhx%02hhx-%02hhx%02hhx-%02hhx%02hhx%02hhx%02hhx%02hhx%02hhx"
23 #define UUID_NONE "00000000-0000-0000-0000-000000000000"
24
25 bool runstate_check(RunState state);
26 void runstate_set(RunState new_state);
27 int runstate_is_running(void);
28 bool runstate_needs_reset(void);
29 typedef struct vm_change_state_entry VMChangeStateEntry;
30 typedef void VMChangeStateHandler(void *opaque, int running, RunState state);
31
32 VMChangeStateEntry *qemu_add_vm_change_state_handler(VMChangeStateHandler *cb,
33                                                      void *opaque);
34 void qemu_del_vm_change_state_handler(VMChangeStateEntry *e);
35 void vm_state_notify(int running, RunState state);
36
37 #define VMRESET_SILENT   false
38 #define VMRESET_REPORT   true
39
40 void vm_start(void);
41 int vm_stop(RunState state);
42 int vm_stop_force_state(RunState state);
43
44 typedef enum WakeupReason {
45     /* Always keep QEMU_WAKEUP_REASON_NONE = 0 */
46     QEMU_WAKEUP_REASON_NONE = 0,
47     QEMU_WAKEUP_REASON_RTC,
48     QEMU_WAKEUP_REASON_PMTIMER,
49     QEMU_WAKEUP_REASON_OTHER,
50 } WakeupReason;
51
52 void qemu_system_reset_request(void);
53 void qemu_system_suspend_request(void);
54 void qemu_register_suspend_notifier(Notifier *notifier);
55 void qemu_system_wakeup_request(WakeupReason reason);
56 void qemu_system_wakeup_enable(WakeupReason reason, bool enabled);
57 void qemu_register_wakeup_notifier(Notifier *notifier);
58 void qemu_system_shutdown_request(void);
59 void qemu_system_powerdown_request(void);
60 void qemu_register_powerdown_notifier(Notifier *notifier);
61 void qemu_system_debug_request(void);
62 void qemu_system_vmstop_request(RunState reason);
63 int qemu_shutdown_requested_get(void);
64 int qemu_reset_requested_get(void);
65 void qemu_system_killed(int signal, pid_t pid);
66 void qemu_devices_reset(void);
67 void qemu_system_reset(bool report);
68
69 void qemu_add_exit_notifier(Notifier *notify);
70 void qemu_remove_exit_notifier(Notifier *notify);
71
72 void qemu_add_machine_init_done_notifier(Notifier *notify);
73
74 void do_savevm(Monitor *mon, const QDict *qdict);
75 int load_vmstate(const char *name);
76 void do_delvm(Monitor *mon, const QDict *qdict);
77 void do_info_snapshots(Monitor *mon, const QDict *qdict);
78
79 void qemu_announce_self(void);
80
81 bool qemu_savevm_state_blocked(Error **errp);
82 void qemu_savevm_state_begin(QEMUFile *f,
83                              const MigrationParams *params);
84 int qemu_savevm_state_iterate(QEMUFile *f);
85 void qemu_savevm_state_complete(QEMUFile *f);
86 void qemu_savevm_state_cancel(void);
87 uint64_t qemu_savevm_state_pending(QEMUFile *f, uint64_t max_size);
88 int qemu_loadvm_state(QEMUFile *f);
89
90 /* SLIRP */
91 void do_info_slirp(Monitor *mon);
92
93 typedef enum DisplayType
94 {
95     DT_DEFAULT,
96     DT_CURSES,
97     DT_SDL,
98     DT_GTK,
99     DT_NOGRAPHIC,
100     DT_NONE,
101 } DisplayType;
102
103 extern int autostart;
104
105 typedef enum {
106     VGA_NONE, VGA_STD, VGA_CIRRUS, VGA_VMWARE, VGA_XENFB, VGA_QXL,
107     VGA_TCX, VGA_CG3, VGA_DEVICE
108 } VGAInterfaceType;
109
110 extern int vga_interface_type;
111 #define xenfb_enabled (vga_interface_type == VGA_XENFB)
112
113 extern int graphic_width;
114 extern int graphic_height;
115 extern int graphic_depth;
116 extern DisplayType display_type;
117 extern const char *keyboard_layout;
118 extern int win2k_install_hack;
119 extern int alt_grab;
120 extern int ctrl_grab;
121 extern int smp_cpus;
122 extern int max_cpus;
123 extern int cursor_hide;
124 extern int graphic_rotate;
125 extern int no_quit;
126 extern int no_shutdown;
127 extern int semihosting_enabled;
128 extern int old_param;
129 extern int boot_menu;
130 extern uint8_t *boot_splash_filedata;
131 extern size_t boot_splash_filedata_size;
132 extern uint8_t qemu_extra_params_fw[2];
133 extern QEMUClockType rtc_clock;
134
135 #define MAX_NODES 64
136
137 /* The following shall be true for all CPUs:
138  *   cpu->cpu_index < max_cpus <= MAX_CPUMASK_BITS
139  *
140  * Note that cpu->get_arch_id() may be larger than MAX_CPUMASK_BITS.
141  */
142 #define MAX_CPUMASK_BITS 255
143
144 extern int nb_numa_nodes;
145 extern uint64_t node_mem[MAX_NODES];
146 extern unsigned long *node_cpumask[MAX_NODES];
147
148 #define MAX_OPTION_ROMS 16
149 typedef struct QEMUOptionRom {
150     const char *name;
151     int32_t bootindex;
152 } QEMUOptionRom;
153 extern QEMUOptionRom option_rom[MAX_OPTION_ROMS];
154 extern int nb_option_roms;
155
156 #define MAX_PROM_ENVS 128
157 extern const char *prom_envs[MAX_PROM_ENVS];
158 extern unsigned int nb_prom_envs;
159
160 /* pci-hotplug */
161 void pci_device_hot_add(Monitor *mon, const QDict *qdict);
162 int pci_drive_hot_add(Monitor *mon, const QDict *qdict, DriveInfo *dinfo);
163 void do_pci_device_hot_remove(Monitor *mon, const QDict *qdict);
164
165 /* generic hotplug */
166 void drive_hot_add(Monitor *mon, const QDict *qdict);
167
168 /* CPU hotplug */
169 void qemu_register_cpu_added_notifier(Notifier *notifier);
170
171 /* pcie aer error injection */
172 void pcie_aer_inject_error_print(Monitor *mon, const QObject *data);
173 int do_pcie_aer_inject_error(Monitor *mon,
174                              const QDict *qdict, QObject **ret_data);
175
176 /* serial ports */
177
178 #define MAX_SERIAL_PORTS 4
179
180 extern CharDriverState *serial_hds[MAX_SERIAL_PORTS];
181
182 /* parallel ports */
183
184 #define MAX_PARALLEL_PORTS 3
185
186 extern CharDriverState *parallel_hds[MAX_PARALLEL_PORTS];
187
188 void do_usb_add(Monitor *mon, const QDict *qdict);
189 void do_usb_del(Monitor *mon, const QDict *qdict);
190 void usb_info(Monitor *mon, const QDict *qdict);
191
192 void rtc_change_mon_event(struct tm *tm);
193
194 void add_boot_device_path(int32_t bootindex, DeviceState *dev,
195                           const char *suffix);
196 char *get_boot_devices_list(size_t *size, bool ignore_suffixes);
197
198 DeviceState *get_boot_device(uint32_t position);
199
200 QemuOpts *qemu_get_machine_opts(void);
201
202 bool usb_enabled(bool default_usb);
203
204 extern QemuOptsList qemu_legacy_drive_opts;
205 extern QemuOptsList qemu_common_drive_opts;
206 extern QemuOptsList qemu_drive_opts;
207 extern QemuOptsList qemu_chardev_opts;
208 extern QemuOptsList qemu_device_opts;
209 extern QemuOptsList qemu_netdev_opts;
210 extern QemuOptsList qemu_net_opts;
211 extern QemuOptsList qemu_global_opts;
212 extern QemuOptsList qemu_mon_opts;
213
214 #endif