xref: /openbmc/qemu/include/sysemu/sysemu.h (revision 3ae8a100)
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__MAX,
48 } ShutdownCause;
49 
50 static inline bool shutdown_caused_by_guest(ShutdownCause cause)
51 {
52     return cause >= SHUTDOWN_CAUSE_GUEST_SHUTDOWN;
53 }
54 
55 void vm_start(void);
56 int vm_prepare_start(void);
57 int vm_stop(RunState state);
58 int vm_stop_force_state(RunState state);
59 int vm_shutdown(void);
60 
61 typedef enum WakeupReason {
62     /* Always keep QEMU_WAKEUP_REASON_NONE = 0 */
63     QEMU_WAKEUP_REASON_NONE = 0,
64     QEMU_WAKEUP_REASON_RTC,
65     QEMU_WAKEUP_REASON_PMTIMER,
66     QEMU_WAKEUP_REASON_OTHER,
67 } WakeupReason;
68 
69 void qemu_exit_preconfig_request(void);
70 void qemu_system_reset_request(ShutdownCause reason);
71 void qemu_system_suspend_request(void);
72 void qemu_register_suspend_notifier(Notifier *notifier);
73 void qemu_system_wakeup_request(WakeupReason reason);
74 void qemu_system_wakeup_enable(WakeupReason reason, bool enabled);
75 void qemu_register_wakeup_notifier(Notifier *notifier);
76 void qemu_system_shutdown_request(ShutdownCause reason);
77 void qemu_system_powerdown_request(void);
78 void qemu_register_powerdown_notifier(Notifier *notifier);
79 void qemu_system_debug_request(void);
80 void qemu_system_vmstop_request(RunState reason);
81 void qemu_system_vmstop_request_prepare(void);
82 bool qemu_vmstop_requested(RunState *r);
83 ShutdownCause qemu_shutdown_requested_get(void);
84 ShutdownCause qemu_reset_requested_get(void);
85 void qemu_system_killed(int signal, pid_t pid);
86 void qemu_system_reset(ShutdownCause reason);
87 void qemu_system_guest_panicked(GuestPanicInformation *info);
88 
89 void qemu_add_exit_notifier(Notifier *notify);
90 void qemu_remove_exit_notifier(Notifier *notify);
91 
92 extern bool machine_init_done;
93 
94 void qemu_add_machine_init_done_notifier(Notifier *notify);
95 void qemu_remove_machine_init_done_notifier(Notifier *notify);
96 
97 void qemu_announce_self(void);
98 
99 extern int autostart;
100 
101 typedef enum {
102     VGA_NONE, VGA_STD, VGA_CIRRUS, VGA_VMWARE, VGA_XENFB, VGA_QXL,
103     VGA_TCX, VGA_CG3, VGA_DEVICE, VGA_VIRTIO,
104     VGA_TYPE_MAX,
105 } VGAInterfaceType;
106 
107 extern int vga_interface_type;
108 #define xenfb_enabled (vga_interface_type == VGA_XENFB)
109 
110 extern int graphic_width;
111 extern int graphic_height;
112 extern int graphic_depth;
113 extern int display_opengl;
114 extern const char *keyboard_layout;
115 extern int win2k_install_hack;
116 extern int alt_grab;
117 extern int ctrl_grab;
118 extern int no_frame;
119 extern int smp_cpus;
120 extern unsigned int max_cpus;
121 extern int cursor_hide;
122 extern int graphic_rotate;
123 extern int no_quit;
124 extern int no_shutdown;
125 extern int old_param;
126 extern int boot_menu;
127 extern bool boot_strict;
128 extern uint8_t *boot_splash_filedata;
129 extern size_t boot_splash_filedata_size;
130 extern bool enable_mlock;
131 extern uint8_t qemu_extra_params_fw[2];
132 extern QEMUClockType rtc_clock;
133 extern const char *mem_path;
134 extern int mem_prealloc;
135 
136 #define MAX_NODES 128
137 #define NUMA_NODE_UNASSIGNED MAX_NODES
138 #define NUMA_DISTANCE_MIN         10
139 #define NUMA_DISTANCE_DEFAULT     20
140 #define NUMA_DISTANCE_MAX         254
141 #define NUMA_DISTANCE_UNREACHABLE 255
142 
143 #define MAX_OPTION_ROMS 16
144 typedef struct QEMUOptionRom {
145     const char *name;
146     int32_t bootindex;
147 } QEMUOptionRom;
148 extern QEMUOptionRom option_rom[MAX_OPTION_ROMS];
149 extern int nb_option_roms;
150 
151 #define MAX_PROM_ENVS 128
152 extern const char *prom_envs[MAX_PROM_ENVS];
153 extern unsigned int nb_prom_envs;
154 
155 /* generic hotplug */
156 void hmp_drive_add(Monitor *mon, const QDict *qdict);
157 
158 /* pcie aer error injection */
159 void hmp_pcie_aer_inject_error(Monitor *mon, const QDict *qdict);
160 
161 /* serial ports */
162 
163 /* Return the Chardev for serial port i, or NULL if none */
164 Chardev *serial_hd(int i);
165 /* return the number of serial ports defined by the user. serial_hd(i)
166  * will always return NULL for any i which is greater than or equal to this.
167  */
168 int serial_max_hds(void);
169 
170 /* parallel ports */
171 
172 #define MAX_PARALLEL_PORTS 3
173 
174 extern Chardev *parallel_hds[MAX_PARALLEL_PORTS];
175 
176 void hmp_info_usb(Monitor *mon, const QDict *qdict);
177 
178 void add_boot_device_path(int32_t bootindex, DeviceState *dev,
179                           const char *suffix);
180 char *get_boot_devices_list(size_t *size, bool ignore_suffixes);
181 
182 DeviceState *get_boot_device(uint32_t position);
183 void check_boot_index(int32_t bootindex, Error **errp);
184 void del_boot_device_path(DeviceState *dev, const char *suffix);
185 void device_add_bootindex_property(Object *obj, int32_t *bootindex,
186                                    const char *name, const char *suffix,
187                                    DeviceState *dev, Error **errp);
188 void restore_boot_order(void *opaque);
189 void validate_bootdevices(const char *devices, Error **errp);
190 
191 /* handler to set the boot_device order for a specific type of MachineClass */
192 typedef void QEMUBootSetHandler(void *opaque, const char *boot_order,
193                                 Error **errp);
194 void qemu_register_boot_set(QEMUBootSetHandler *func, void *opaque);
195 void qemu_boot_set(const char *boot_order, Error **errp);
196 
197 QemuOpts *qemu_get_machine_opts(void);
198 
199 bool defaults_enabled(void);
200 
201 extern QemuOptsList qemu_legacy_drive_opts;
202 extern QemuOptsList qemu_common_drive_opts;
203 extern QemuOptsList qemu_drive_opts;
204 extern QemuOptsList bdrv_runtime_opts;
205 extern QemuOptsList qemu_chardev_opts;
206 extern QemuOptsList qemu_device_opts;
207 extern QemuOptsList qemu_netdev_opts;
208 extern QemuOptsList qemu_nic_opts;
209 extern QemuOptsList qemu_net_opts;
210 extern QemuOptsList qemu_global_opts;
211 extern QemuOptsList qemu_mon_opts;
212 
213 #endif
214