xref: /openbmc/qemu/include/sysemu/sysemu.h (revision 438c78da)
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/queue.h"
7 #include "qemu/timer.h"
8 #include "qemu/notify.h"
9 #include "qemu/main-loop.h"
10 #include "qemu/bitmap.h"
11 #include "qemu/uuid.h"
12 #include "qom/object.h"
13 
14 /* vl.c */
15 
16 extern const char *bios_name;
17 extern const char *qemu_name;
18 extern QemuUUID qemu_uuid;
19 extern bool qemu_uuid_set;
20 
21 bool runstate_check(RunState state);
22 void runstate_set(RunState new_state);
23 int runstate_is_running(void);
24 bool runstate_needs_reset(void);
25 bool runstate_store(char *str, size_t size);
26 typedef struct vm_change_state_entry VMChangeStateEntry;
27 typedef void VMChangeStateHandler(void *opaque, int running, RunState state);
28 
29 VMChangeStateEntry *qemu_add_vm_change_state_handler(VMChangeStateHandler *cb,
30                                                      void *opaque);
31 void qemu_del_vm_change_state_handler(VMChangeStateEntry *e);
32 void vm_state_notify(int running, RunState state);
33 
34 /* Enumeration of various causes for shutdown. */
35 typedef enum ShutdownCause {
36     SHUTDOWN_CAUSE_NONE,          /* No shutdown request pending */
37     SHUTDOWN_CAUSE_HOST_ERROR,    /* An error prevents further use of guest */
38     SHUTDOWN_CAUSE_HOST_QMP,      /* Reaction to a QMP command, like 'quit' */
39     SHUTDOWN_CAUSE_HOST_SIGNAL,   /* Reaction to a signal, such as SIGINT */
40     SHUTDOWN_CAUSE_HOST_UI,       /* Reaction to UI event, like window close */
41     SHUTDOWN_CAUSE_GUEST_SHUTDOWN,/* Guest shutdown/suspend request, via
42                                      ACPI or other hardware-specific means */
43     SHUTDOWN_CAUSE_GUEST_RESET,   /* Guest reset request, and command line
44                                      turns that into a shutdown */
45     SHUTDOWN_CAUSE_GUEST_PANIC,   /* Guest panicked, and command line turns
46                                      that into a shutdown */
47     SHUTDOWN_CAUSE_SUBSYSTEM_RESET,/* Partial guest reset that does not trigger
48                                       QMP events and ignores --no-reboot. This
49                                       is useful for sanitize hypercalls on s390
50                                       that are used during kexec/kdump/boot */
51     SHUTDOWN_CAUSE__MAX,
52 } ShutdownCause;
53 
54 static inline bool shutdown_caused_by_guest(ShutdownCause cause)
55 {
56     return cause >= SHUTDOWN_CAUSE_GUEST_SHUTDOWN;
57 }
58 
59 void vm_start(void);
60 int vm_prepare_start(void);
61 int vm_stop(RunState state);
62 int vm_stop_force_state(RunState state);
63 int vm_shutdown(void);
64 
65 typedef enum WakeupReason {
66     /* Always keep QEMU_WAKEUP_REASON_NONE = 0 */
67     QEMU_WAKEUP_REASON_NONE = 0,
68     QEMU_WAKEUP_REASON_RTC,
69     QEMU_WAKEUP_REASON_PMTIMER,
70     QEMU_WAKEUP_REASON_OTHER,
71 } WakeupReason;
72 
73 void qemu_exit_preconfig_request(void);
74 void qemu_system_reset_request(ShutdownCause reason);
75 void qemu_system_suspend_request(void);
76 void qemu_register_suspend_notifier(Notifier *notifier);
77 void qemu_system_wakeup_request(WakeupReason reason);
78 void qemu_system_wakeup_enable(WakeupReason reason, bool enabled);
79 void qemu_register_wakeup_notifier(Notifier *notifier);
80 void qemu_system_shutdown_request(ShutdownCause reason);
81 void qemu_system_powerdown_request(void);
82 void qemu_register_powerdown_notifier(Notifier *notifier);
83 void qemu_system_debug_request(void);
84 void qemu_system_vmstop_request(RunState reason);
85 void qemu_system_vmstop_request_prepare(void);
86 bool qemu_vmstop_requested(RunState *r);
87 ShutdownCause qemu_shutdown_requested_get(void);
88 ShutdownCause qemu_reset_requested_get(void);
89 void qemu_system_killed(int signal, pid_t pid);
90 void qemu_system_reset(ShutdownCause reason);
91 void qemu_system_guest_panicked(GuestPanicInformation *info);
92 
93 void qemu_add_exit_notifier(Notifier *notify);
94 void qemu_remove_exit_notifier(Notifier *notify);
95 
96 extern bool machine_init_done;
97 
98 void qemu_add_machine_init_done_notifier(Notifier *notify);
99 void qemu_remove_machine_init_done_notifier(Notifier *notify);
100 
101 void qemu_announce_self(void);
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, VGA_VIRTIO,
108     VGA_TYPE_MAX,
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 int display_opengl;
118 extern const char *keyboard_layout;
119 extern int win2k_install_hack;
120 extern int alt_grab;
121 extern int ctrl_grab;
122 extern int no_frame;
123 extern int smp_cpus;
124 extern unsigned 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 bool enable_mlock;
135 extern bool enable_cpu_pm;
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 #define NUMA_DISTANCE_MIN         10
144 #define NUMA_DISTANCE_DEFAULT     20
145 #define NUMA_DISTANCE_MAX         254
146 #define NUMA_DISTANCE_UNREACHABLE 255
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 /* generic hotplug */
161 void hmp_drive_add(Monitor *mon, const QDict *qdict);
162 
163 /* pcie aer error injection */
164 void hmp_pcie_aer_inject_error(Monitor *mon, const QDict *qdict);
165 
166 /* serial ports */
167 
168 /* Return the Chardev for serial port i, or NULL if none */
169 Chardev *serial_hd(int i);
170 /* return the number of serial ports defined by the user. serial_hd(i)
171  * will always return NULL for any i which is greater than or equal to this.
172  */
173 int serial_max_hds(void);
174 
175 /* parallel ports */
176 
177 #define MAX_PARALLEL_PORTS 3
178 
179 extern Chardev *parallel_hds[MAX_PARALLEL_PORTS];
180 
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);
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 MachineClass */
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 
206 extern QemuOptsList qemu_legacy_drive_opts;
207 extern QemuOptsList qemu_common_drive_opts;
208 extern QemuOptsList qemu_drive_opts;
209 extern QemuOptsList bdrv_runtime_opts;
210 extern QemuOptsList qemu_chardev_opts;
211 extern QemuOptsList qemu_device_opts;
212 extern QemuOptsList qemu_netdev_opts;
213 extern QemuOptsList qemu_nic_opts;
214 extern QemuOptsList qemu_net_opts;
215 extern QemuOptsList qemu_global_opts;
216 extern QemuOptsList qemu_mon_opts;
217 
218 #endif
219