xref: /openbmc/qemu/include/sysemu/sysemu.h (revision ddbb0d09)
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 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 
72 void qemu_add_exit_notifier(Notifier *notify);
73 void qemu_remove_exit_notifier(Notifier *notify);
74 
75 void qemu_add_machine_init_done_notifier(Notifier *notify);
76 
77 void hmp_savevm(Monitor *mon, const QDict *qdict);
78 int load_vmstate(const char *name);
79 void hmp_delvm(Monitor *mon, const QDict *qdict);
80 void hmp_info_snapshots(Monitor *mon, const QDict *qdict);
81 
82 void qemu_announce_self(void);
83 
84 bool qemu_savevm_state_blocked(Error **errp);
85 void qemu_savevm_state_begin(QEMUFile *f,
86                              const MigrationParams *params);
87 void qemu_savevm_state_header(QEMUFile *f);
88 int qemu_savevm_state_iterate(QEMUFile *f);
89 void qemu_savevm_state_complete(QEMUFile *f);
90 void qemu_savevm_state_cancel(void);
91 uint64_t qemu_savevm_state_pending(QEMUFile *f, uint64_t max_size);
92 int qemu_loadvm_state(QEMUFile *f);
93 
94 typedef enum DisplayType
95 {
96     DT_DEFAULT,
97     DT_CURSES,
98     DT_SDL,
99     DT_GTK,
100     DT_NOGRAPHIC,
101     DT_NONE,
102 } DisplayType;
103 
104 extern int autostart;
105 
106 typedef enum {
107     VGA_NONE, VGA_STD, VGA_CIRRUS, VGA_VMWARE, VGA_XENFB, VGA_QXL,
108     VGA_TCX, VGA_CG3, VGA_DEVICE, VGA_VIRTIO,
109 } VGAInterfaceType;
110 
111 extern int vga_interface_type;
112 #define xenfb_enabled (vga_interface_type == VGA_XENFB)
113 
114 extern int graphic_width;
115 extern int graphic_height;
116 extern int graphic_depth;
117 extern DisplayType display_type;
118 extern int display_opengl;
119 extern const char *keyboard_layout;
120 extern int win2k_install_hack;
121 extern int alt_grab;
122 extern int ctrl_grab;
123 extern int smp_cpus;
124 extern int max_cpus;
125 extern int cursor_hide;
126 extern int graphic_rotate;
127 extern int no_quit;
128 extern int no_shutdown;
129 extern int old_param;
130 extern int boot_menu;
131 extern bool boot_strict;
132 extern uint8_t *boot_splash_filedata;
133 extern size_t boot_splash_filedata_size;
134 extern uint8_t qemu_extra_params_fw[2];
135 extern QEMUClockType rtc_clock;
136 extern const char *mem_path;
137 extern int mem_prealloc;
138 
139 #define MAX_NODES 128
140 #define NUMA_NODE_UNASSIGNED MAX_NODES
141 
142 /* The following shall be true for all CPUs:
143  *   cpu->cpu_index < max_cpus <= MAX_CPUMASK_BITS
144  *
145  * Note that cpu->get_arch_id() may be larger than MAX_CPUMASK_BITS.
146  */
147 #define MAX_CPUMASK_BITS 255
148 
149 #define MAX_OPTION_ROMS 16
150 typedef struct QEMUOptionRom {
151     const char *name;
152     int32_t bootindex;
153 } QEMUOptionRom;
154 extern QEMUOptionRom option_rom[MAX_OPTION_ROMS];
155 extern int nb_option_roms;
156 
157 #define MAX_PROM_ENVS 128
158 extern const char *prom_envs[MAX_PROM_ENVS];
159 extern unsigned int nb_prom_envs;
160 
161 /* generic hotplug */
162 void hmp_drive_add(Monitor *mon, const QDict *qdict);
163 
164 /* pcie aer error injection */
165 void hmp_pcie_aer_inject_error(Monitor *mon, const QDict *qdict);
166 
167 /* serial ports */
168 
169 #define MAX_SERIAL_PORTS 4
170 
171 extern CharDriverState *serial_hds[MAX_SERIAL_PORTS];
172 
173 /* parallel ports */
174 
175 #define MAX_PARALLEL_PORTS 3
176 
177 extern CharDriverState *parallel_hds[MAX_PARALLEL_PORTS];
178 
179 void hmp_usb_add(Monitor *mon, const QDict *qdict);
180 void hmp_usb_del(Monitor *mon, const QDict *qdict);
181 void hmp_info_usb(Monitor *mon, const QDict *qdict);
182 
183 void add_boot_device_path(int32_t bootindex, DeviceState *dev,
184                           const char *suffix);
185 char *get_boot_devices_list(size_t *size, bool ignore_suffixes);
186 
187 DeviceState *get_boot_device(uint32_t position);
188 void check_boot_index(int32_t bootindex, Error **errp);
189 void del_boot_device_path(DeviceState *dev, const char *suffix);
190 void device_add_bootindex_property(Object *obj, int32_t *bootindex,
191                                    const char *name, const char *suffix,
192                                    DeviceState *dev, Error **errp);
193 void restore_boot_order(void *opaque);
194 void validate_bootdevices(const char *devices, Error **errp);
195 
196 /* handler to set the boot_device order for a specific type of QEMUMachine */
197 typedef void QEMUBootSetHandler(void *opaque, const char *boot_order,
198                                 Error **errp);
199 void qemu_register_boot_set(QEMUBootSetHandler *func, void *opaque);
200 void qemu_boot_set(const char *boot_order, Error **errp);
201 
202 QemuOpts *qemu_get_machine_opts(void);
203 
204 bool defaults_enabled(void);
205 bool usb_enabled(void);
206 
207 extern QemuOptsList qemu_legacy_drive_opts;
208 extern QemuOptsList qemu_common_drive_opts;
209 extern QemuOptsList qemu_drive_opts;
210 extern QemuOptsList qemu_chardev_opts;
211 extern QemuOptsList qemu_device_opts;
212 extern QemuOptsList qemu_netdev_opts;
213 extern QemuOptsList qemu_net_opts;
214 extern QemuOptsList qemu_global_opts;
215 extern QemuOptsList qemu_mon_opts;
216 
217 #endif
218