xref: /openbmc/qemu/include/sysemu/sysemu.h (revision 46517dd4)
1 #ifndef SYSEMU_H
2 #define SYSEMU_H
3 /* Misc. things related to the system emulator.  */
4 
5 #include "qapi/qapi-types-run-state.h"
6 #include "qemu/timer.h"
7 #include "qemu/notify.h"
8 #include "qemu/bitmap.h"
9 #include "qemu/uuid.h"
10 #include "qom/object.h"
11 
12 /* vl.c */
13 
14 extern const char *bios_name;
15 extern int only_migratable;
16 extern const char *qemu_name;
17 extern QemuUUID qemu_uuid;
18 extern bool qemu_uuid_set;
19 
20 bool runstate_check(RunState state);
21 void runstate_set(RunState new_state);
22 int runstate_is_running(void);
23 bool runstate_needs_reset(void);
24 bool runstate_store(char *str, size_t size);
25 typedef struct vm_change_state_entry VMChangeStateEntry;
26 typedef void VMChangeStateHandler(void *opaque, int running, RunState state);
27 
28 VMChangeStateEntry *qemu_add_vm_change_state_handler(VMChangeStateHandler *cb,
29                                                      void *opaque);
30 VMChangeStateEntry *qemu_add_vm_change_state_handler_prio(
31         VMChangeStateHandler *cb, void *opaque, int priority);
32 VMChangeStateEntry *qdev_add_vm_change_state_handler(DeviceState *dev,
33                                                      VMChangeStateHandler *cb,
34                                                      void *opaque);
35 void qemu_del_vm_change_state_handler(VMChangeStateEntry *e);
36 void vm_state_notify(int running, RunState state);
37 
38 static inline bool shutdown_caused_by_guest(ShutdownCause cause)
39 {
40     return cause >= SHUTDOWN_CAUSE_GUEST_SHUTDOWN;
41 }
42 
43 void vm_start(void);
44 int vm_prepare_start(void);
45 int vm_stop(RunState state);
46 int vm_stop_force_state(RunState state);
47 int vm_shutdown(void);
48 
49 typedef enum WakeupReason {
50     /* Always keep QEMU_WAKEUP_REASON_NONE = 0 */
51     QEMU_WAKEUP_REASON_NONE = 0,
52     QEMU_WAKEUP_REASON_RTC,
53     QEMU_WAKEUP_REASON_PMTIMER,
54     QEMU_WAKEUP_REASON_OTHER,
55 } WakeupReason;
56 
57 void qemu_exit_preconfig_request(void);
58 void qemu_system_reset_request(ShutdownCause reason);
59 void qemu_system_suspend_request(void);
60 void qemu_register_suspend_notifier(Notifier *notifier);
61 bool qemu_wakeup_suspend_enabled(void);
62 void qemu_system_wakeup_request(WakeupReason reason, Error **errp);
63 void qemu_system_wakeup_enable(WakeupReason reason, bool enabled);
64 void qemu_register_wakeup_notifier(Notifier *notifier);
65 void qemu_register_wakeup_support(void);
66 void qemu_system_shutdown_request(ShutdownCause reason);
67 void qemu_system_powerdown_request(void);
68 void qemu_register_powerdown_notifier(Notifier *notifier);
69 void qemu_register_shutdown_notifier(Notifier *notifier);
70 void qemu_system_debug_request(void);
71 void qemu_system_vmstop_request(RunState reason);
72 void qemu_system_vmstop_request_prepare(void);
73 bool qemu_vmstop_requested(RunState *r);
74 ShutdownCause qemu_shutdown_requested_get(void);
75 ShutdownCause qemu_reset_requested_get(void);
76 void qemu_system_killed(int signal, pid_t pid);
77 void qemu_system_reset(ShutdownCause reason);
78 void qemu_system_guest_panicked(GuestPanicInformation *info);
79 
80 void qemu_add_exit_notifier(Notifier *notify);
81 void qemu_remove_exit_notifier(Notifier *notify);
82 
83 extern bool machine_init_done;
84 
85 void qemu_add_machine_init_done_notifier(Notifier *notify);
86 void qemu_remove_machine_init_done_notifier(Notifier *notify);
87 
88 extern int autostart;
89 
90 typedef enum {
91     VGA_NONE, VGA_STD, VGA_CIRRUS, VGA_VMWARE, VGA_XENFB, VGA_QXL,
92     VGA_TCX, VGA_CG3, VGA_DEVICE, VGA_VIRTIO,
93     VGA_TYPE_MAX,
94 } VGAInterfaceType;
95 
96 extern int vga_interface_type;
97 #define xenfb_enabled (vga_interface_type == VGA_XENFB)
98 
99 extern int graphic_width;
100 extern int graphic_height;
101 extern int graphic_depth;
102 extern int display_opengl;
103 extern const char *keyboard_layout;
104 extern int win2k_install_hack;
105 extern int alt_grab;
106 extern int ctrl_grab;
107 extern int smp_cpus;
108 extern unsigned int max_cpus;
109 extern int cursor_hide;
110 extern int graphic_rotate;
111 extern int no_quit;
112 extern int no_shutdown;
113 extern int old_param;
114 extern int boot_menu;
115 extern bool boot_strict;
116 extern uint8_t *boot_splash_filedata;
117 extern bool enable_mlock;
118 extern bool enable_cpu_pm;
119 extern QEMUClockType rtc_clock;
120 extern const char *mem_path;
121 extern int mem_prealloc;
122 
123 #define MAX_OPTION_ROMS 16
124 typedef struct QEMUOptionRom {
125     const char *name;
126     int32_t bootindex;
127 } QEMUOptionRom;
128 extern QEMUOptionRom option_rom[MAX_OPTION_ROMS];
129 extern int nb_option_roms;
130 
131 #define MAX_PROM_ENVS 128
132 extern const char *prom_envs[MAX_PROM_ENVS];
133 extern unsigned int nb_prom_envs;
134 
135 /* generic hotplug */
136 void hmp_drive_add(Monitor *mon, const QDict *qdict);
137 
138 /* pcie aer error injection */
139 void hmp_pcie_aer_inject_error(Monitor *mon, const QDict *qdict);
140 
141 /* serial ports */
142 
143 /* Return the Chardev for serial port i, or NULL if none */
144 Chardev *serial_hd(int i);
145 /* return the number of serial ports defined by the user. serial_hd(i)
146  * will always return NULL for any i which is greater than or equal to this.
147  */
148 int serial_max_hds(void);
149 
150 /* parallel ports */
151 
152 #define MAX_PARALLEL_PORTS 3
153 
154 extern Chardev *parallel_hds[MAX_PARALLEL_PORTS];
155 
156 void hmp_info_usb(Monitor *mon, const QDict *qdict);
157 
158 void add_boot_device_path(int32_t bootindex, DeviceState *dev,
159                           const char *suffix);
160 char *get_boot_devices_list(size_t *size);
161 
162 DeviceState *get_boot_device(uint32_t position);
163 void check_boot_index(int32_t bootindex, Error **errp);
164 void del_boot_device_path(DeviceState *dev, const char *suffix);
165 void device_add_bootindex_property(Object *obj, int32_t *bootindex,
166                                    const char *name, const char *suffix,
167                                    DeviceState *dev, Error **errp);
168 void restore_boot_order(void *opaque);
169 void validate_bootdevices(const char *devices, Error **errp);
170 
171 /* handler to set the boot_device order for a specific type of MachineClass */
172 typedef void QEMUBootSetHandler(void *opaque, const char *boot_order,
173                                 Error **errp);
174 void qemu_register_boot_set(QEMUBootSetHandler *func, void *opaque);
175 void qemu_boot_set(const char *boot_order, Error **errp);
176 
177 QemuOpts *qemu_get_machine_opts(void);
178 
179 bool defaults_enabled(void);
180 
181 extern QemuOptsList qemu_legacy_drive_opts;
182 extern QemuOptsList qemu_common_drive_opts;
183 extern QemuOptsList qemu_drive_opts;
184 extern QemuOptsList bdrv_runtime_opts;
185 extern QemuOptsList qemu_chardev_opts;
186 extern QemuOptsList qemu_device_opts;
187 extern QemuOptsList qemu_netdev_opts;
188 extern QemuOptsList qemu_nic_opts;
189 extern QemuOptsList qemu_net_opts;
190 extern QemuOptsList qemu_global_opts;
191 extern QemuOptsList qemu_mon_opts;
192 extern QemuOptsList qemu_semihosting_config_opts;
193 
194 #endif
195