xref: /openbmc/qemu/include/sysemu/sysemu.h (revision 91bfcdb0)
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 #include "qemu/bitmap.h"
13 #include "qom/object.h"
14 
15 /* vl.c */
16 
17 extern const char *bios_name;
18 
19 extern const char *qemu_name;
20 extern uint8_t qemu_uuid[];
21 extern bool qemu_uuid_set;
22 int qemu_uuid_parse(const char *str, uint8_t *uuid);
23 
24 #define UUID_FMT "%02hhx%02hhx%02hhx%02hhx-%02hhx%02hhx-%02hhx%02hhx-%02hhx%02hhx-%02hhx%02hhx%02hhx%02hhx%02hhx%02hhx"
25 #define UUID_NONE "00000000-0000-0000-0000-000000000000"
26 
27 bool runstate_check(RunState state);
28 void runstate_set(RunState new_state);
29 int runstate_is_running(void);
30 bool runstate_needs_reset(void);
31 bool runstate_store(char *str, size_t size);
32 typedef struct vm_change_state_entry VMChangeStateEntry;
33 typedef void VMChangeStateHandler(void *opaque, int running, RunState state);
34 
35 VMChangeStateEntry *qemu_add_vm_change_state_handler(VMChangeStateHandler *cb,
36                                                      void *opaque);
37 void qemu_del_vm_change_state_handler(VMChangeStateEntry *e);
38 void vm_state_notify(int running, RunState state);
39 
40 #define VMRESET_SILENT   false
41 #define VMRESET_REPORT   true
42 
43 void vm_start(void);
44 int vm_stop(RunState state);
45 int vm_stop_force_state(RunState state);
46 
47 typedef enum WakeupReason {
48     /* Always keep QEMU_WAKEUP_REASON_NONE = 0 */
49     QEMU_WAKEUP_REASON_NONE = 0,
50     QEMU_WAKEUP_REASON_RTC,
51     QEMU_WAKEUP_REASON_PMTIMER,
52     QEMU_WAKEUP_REASON_OTHER,
53 } WakeupReason;
54 
55 void qemu_system_reset_request(void);
56 void qemu_system_suspend_request(void);
57 void qemu_register_suspend_notifier(Notifier *notifier);
58 void qemu_system_wakeup_request(WakeupReason reason);
59 void qemu_system_wakeup_enable(WakeupReason reason, bool enabled);
60 void qemu_register_wakeup_notifier(Notifier *notifier);
61 void qemu_system_shutdown_request(void);
62 void qemu_system_powerdown_request(void);
63 void qemu_register_powerdown_notifier(Notifier *notifier);
64 void qemu_system_debug_request(void);
65 void qemu_system_vmstop_request(RunState reason);
66 void qemu_system_vmstop_request_prepare(void);
67 int qemu_shutdown_requested_get(void);
68 int qemu_reset_requested_get(void);
69 void qemu_system_killed(int signal, pid_t pid);
70 void qemu_devices_reset(void);
71 void qemu_system_reset(bool report);
72 void qemu_system_guest_panicked(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 bool qemu_savevm_state_blocked(Error **errp);
87 void qemu_savevm_state_begin(QEMUFile *f,
88                              const MigrationParams *params);
89 void qemu_savevm_state_header(QEMUFile *f);
90 int qemu_savevm_state_iterate(QEMUFile *f);
91 void qemu_savevm_state_complete(QEMUFile *f);
92 void qemu_savevm_state_cancel(void);
93 uint64_t qemu_savevm_state_pending(QEMUFile *f, uint64_t max_size);
94 int qemu_loadvm_state(QEMUFile *f);
95 
96 typedef enum DisplayType
97 {
98     DT_DEFAULT,
99     DT_CURSES,
100     DT_SDL,
101     DT_GTK,
102     DT_NOGRAPHIC,
103     DT_NONE,
104 } DisplayType;
105 
106 extern int autostart;
107 
108 typedef enum {
109     VGA_NONE, VGA_STD, VGA_CIRRUS, VGA_VMWARE, VGA_XENFB, VGA_QXL,
110     VGA_TCX, VGA_CG3, VGA_DEVICE, VGA_VIRTIO,
111 } VGAInterfaceType;
112 
113 extern int vga_interface_type;
114 #define xenfb_enabled (vga_interface_type == VGA_XENFB)
115 
116 extern int graphic_width;
117 extern int graphic_height;
118 extern int graphic_depth;
119 extern DisplayType display_type;
120 extern int display_opengl;
121 extern const char *keyboard_layout;
122 extern int win2k_install_hack;
123 extern int alt_grab;
124 extern int ctrl_grab;
125 extern int smp_cpus;
126 extern int max_cpus;
127 extern int cursor_hide;
128 extern int graphic_rotate;
129 extern int no_quit;
130 extern int no_shutdown;
131 extern int old_param;
132 extern int boot_menu;
133 extern bool boot_strict;
134 extern uint8_t *boot_splash_filedata;
135 extern size_t boot_splash_filedata_size;
136 extern uint8_t qemu_extra_params_fw[2];
137 extern QEMUClockType rtc_clock;
138 extern const char *mem_path;
139 extern int mem_prealloc;
140 
141 #define MAX_NODES 128
142 #define NUMA_NODE_UNASSIGNED MAX_NODES
143 
144 /* The following shall be true for all CPUs:
145  *   cpu->cpu_index < max_cpus <= MAX_CPUMASK_BITS
146  *
147  * Note that cpu->get_arch_id() may be larger than MAX_CPUMASK_BITS.
148  */
149 #define MAX_CPUMASK_BITS 255
150 
151 #define MAX_OPTION_ROMS 16
152 typedef struct QEMUOptionRom {
153     const char *name;
154     int32_t bootindex;
155 } QEMUOptionRom;
156 extern QEMUOptionRom option_rom[MAX_OPTION_ROMS];
157 extern int nb_option_roms;
158 
159 #define MAX_PROM_ENVS 128
160 extern const char *prom_envs[MAX_PROM_ENVS];
161 extern unsigned int nb_prom_envs;
162 
163 /* generic hotplug */
164 void hmp_drive_add(Monitor *mon, const QDict *qdict);
165 
166 /* pcie aer error injection */
167 void hmp_pcie_aer_inject_error(Monitor *mon, const QDict *qdict);
168 
169 /* serial ports */
170 
171 #define MAX_SERIAL_PORTS 4
172 
173 extern CharDriverState *serial_hds[MAX_SERIAL_PORTS];
174 
175 /* parallel ports */
176 
177 #define MAX_PARALLEL_PORTS 3
178 
179 extern CharDriverState *parallel_hds[MAX_PARALLEL_PORTS];
180 
181 void hmp_usb_add(Monitor *mon, const QDict *qdict);
182 void hmp_usb_del(Monitor *mon, const QDict *qdict);
183 void hmp_info_usb(Monitor *mon, const QDict *qdict);
184 
185 void add_boot_device_path(int32_t bootindex, DeviceState *dev,
186                           const char *suffix);
187 char *get_boot_devices_list(size_t *size, bool ignore_suffixes);
188 
189 DeviceState *get_boot_device(uint32_t position);
190 void check_boot_index(int32_t bootindex, Error **errp);
191 void del_boot_device_path(DeviceState *dev, const char *suffix);
192 void device_add_bootindex_property(Object *obj, int32_t *bootindex,
193                                    const char *name, const char *suffix,
194                                    DeviceState *dev, Error **errp);
195 void restore_boot_order(void *opaque);
196 void validate_bootdevices(const char *devices, Error **errp);
197 
198 /* handler to set the boot_device order for a specific type of MachineClass */
199 typedef void QEMUBootSetHandler(void *opaque, const char *boot_order,
200                                 Error **errp);
201 void qemu_register_boot_set(QEMUBootSetHandler *func, void *opaque);
202 void qemu_boot_set(const char *boot_order, Error **errp);
203 
204 QemuOpts *qemu_get_machine_opts(void);
205 
206 bool defaults_enabled(void);
207 bool usb_enabled(void);
208 
209 extern QemuOptsList qemu_legacy_drive_opts;
210 extern QemuOptsList qemu_common_drive_opts;
211 extern QemuOptsList qemu_drive_opts;
212 extern QemuOptsList qemu_chardev_opts;
213 extern QemuOptsList qemu_device_opts;
214 extern QemuOptsList qemu_netdev_opts;
215 extern QemuOptsList qemu_net_opts;
216 extern QemuOptsList qemu_global_opts;
217 extern QemuOptsList qemu_mon_opts;
218 
219 #endif
220