xref: /openbmc/qemu/include/sysemu/sysemu.h (revision 83974cf4)
1 #ifndef SYSEMU_H
2 #define SYSEMU_H
3 /* Misc. things related to the system emulator.  */
4 
5 #include "qemu/option.h"
6 #include "qemu/queue.h"
7 #include "qemu/timer.h"
8 #include "qapi-types.h"
9 #include "qemu/notify.h"
10 #include "qemu/main-loop.h"
11 #include "qemu/bitmap.h"
12 #include "qemu/uuid.h"
13 #include "qom/object.h"
14 
15 /* vl.c */
16 
17 extern const char *bios_name;
18 extern const char *qemu_name;
19 extern QemuUUID qemu_uuid;
20 extern bool qemu_uuid_set;
21 
22 bool runstate_check(RunState state);
23 void runstate_set(RunState new_state);
24 int runstate_is_running(void);
25 bool runstate_needs_reset(void);
26 bool runstate_store(char *str, size_t size);
27 typedef struct vm_change_state_entry VMChangeStateEntry;
28 typedef void VMChangeStateHandler(void *opaque, int running, RunState state);
29 
30 VMChangeStateEntry *qemu_add_vm_change_state_handler(VMChangeStateHandler *cb,
31                                                      void *opaque);
32 void qemu_del_vm_change_state_handler(VMChangeStateEntry *e);
33 void vm_state_notify(int running, RunState state);
34 
35 /* Enumeration of various causes for shutdown. */
36 typedef enum ShutdownCause {
37     SHUTDOWN_CAUSE_NONE,          /* No shutdown request pending */
38     SHUTDOWN_CAUSE_HOST_ERROR,    /* An error prevents further use of guest */
39     SHUTDOWN_CAUSE_HOST_QMP,      /* Reaction to a QMP command, like 'quit' */
40     SHUTDOWN_CAUSE_HOST_SIGNAL,   /* Reaction to a signal, such as SIGINT */
41     SHUTDOWN_CAUSE_HOST_UI,       /* Reaction to UI event, like window close */
42     SHUTDOWN_CAUSE_GUEST_SHUTDOWN,/* Guest shutdown/suspend request, via
43                                      ACPI or other hardware-specific means */
44     SHUTDOWN_CAUSE_GUEST_RESET,   /* Guest reset request, and command line
45                                      turns that into a shutdown */
46     SHUTDOWN_CAUSE_GUEST_PANIC,   /* Guest panicked, and command line turns
47                                      that into a shutdown */
48     SHUTDOWN_CAUSE__MAX,
49 } ShutdownCause;
50 
51 static inline bool shutdown_caused_by_guest(ShutdownCause cause)
52 {
53     return cause >= SHUTDOWN_CAUSE_GUEST_SHUTDOWN;
54 }
55 
56 void vm_start(void);
57 int vm_prepare_start(void);
58 int vm_stop(RunState state);
59 int vm_stop_force_state(RunState state);
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_system_reset_request(ShutdownCause reason);
70 void qemu_system_suspend_request(void);
71 void qemu_register_suspend_notifier(Notifier *notifier);
72 void qemu_system_wakeup_request(WakeupReason reason);
73 void qemu_system_wakeup_enable(WakeupReason reason, bool enabled);
74 void qemu_register_wakeup_notifier(Notifier *notifier);
75 void qemu_system_shutdown_request(ShutdownCause reason);
76 void qemu_system_powerdown_request(void);
77 void qemu_register_powerdown_notifier(Notifier *notifier);
78 void qemu_system_debug_request(void);
79 void qemu_system_vmstop_request(RunState reason);
80 void qemu_system_vmstop_request_prepare(void);
81 bool qemu_vmstop_requested(RunState *r);
82 ShutdownCause qemu_shutdown_requested_get(void);
83 ShutdownCause qemu_reset_requested_get(void);
84 void qemu_system_killed(int signal, pid_t pid);
85 void qemu_system_reset(ShutdownCause reason);
86 void qemu_system_guest_panicked(GuestPanicInformation *info);
87 
88 void qemu_add_exit_notifier(Notifier *notify);
89 void qemu_remove_exit_notifier(Notifier *notify);
90 
91 void qemu_add_machine_init_done_notifier(Notifier *notify);
92 void qemu_remove_machine_init_done_notifier(Notifier *notify);
93 
94 void qemu_announce_self(void);
95 
96 extern int autostart;
97 
98 typedef enum {
99     VGA_NONE, VGA_STD, VGA_CIRRUS, VGA_VMWARE, VGA_XENFB, VGA_QXL,
100     VGA_TCX, VGA_CG3, VGA_DEVICE, VGA_VIRTIO,
101     VGA_TYPE_MAX,
102 } VGAInterfaceType;
103 
104 extern int vga_interface_type;
105 #define xenfb_enabled (vga_interface_type == VGA_XENFB)
106 
107 extern int graphic_width;
108 extern int graphic_height;
109 extern int graphic_depth;
110 extern int display_opengl;
111 extern const char *keyboard_layout;
112 extern int win2k_install_hack;
113 extern int alt_grab;
114 extern int ctrl_grab;
115 extern int smp_cpus;
116 extern unsigned int max_cpus;
117 extern int cursor_hide;
118 extern int graphic_rotate;
119 extern int no_quit;
120 extern int no_shutdown;
121 extern int old_param;
122 extern int boot_menu;
123 extern bool boot_strict;
124 extern uint8_t *boot_splash_filedata;
125 extern size_t boot_splash_filedata_size;
126 extern bool enable_mlock;
127 extern uint8_t qemu_extra_params_fw[2];
128 extern QEMUClockType rtc_clock;
129 extern const char *mem_path;
130 extern int mem_prealloc;
131 
132 #define MAX_NODES 128
133 #define NUMA_NODE_UNASSIGNED MAX_NODES
134 #define NUMA_DISTANCE_MIN         10
135 #define NUMA_DISTANCE_DEFAULT     20
136 #define NUMA_DISTANCE_MAX         254
137 #define NUMA_DISTANCE_UNREACHABLE 255
138 
139 #define MAX_OPTION_ROMS 16
140 typedef struct QEMUOptionRom {
141     const char *name;
142     int32_t bootindex;
143 } QEMUOptionRom;
144 extern QEMUOptionRom option_rom[MAX_OPTION_ROMS];
145 extern int nb_option_roms;
146 
147 #define MAX_PROM_ENVS 128
148 extern const char *prom_envs[MAX_PROM_ENVS];
149 extern unsigned int nb_prom_envs;
150 
151 /* generic hotplug */
152 void hmp_drive_add(Monitor *mon, const QDict *qdict);
153 
154 /* pcie aer error injection */
155 void hmp_pcie_aer_inject_error(Monitor *mon, const QDict *qdict);
156 
157 /* serial ports */
158 
159 #define MAX_SERIAL_PORTS 4
160 
161 extern Chardev *serial_hds[MAX_SERIAL_PORTS];
162 
163 /* parallel ports */
164 
165 #define MAX_PARALLEL_PORTS 3
166 
167 extern Chardev *parallel_hds[MAX_PARALLEL_PORTS];
168 
169 void hmp_usb_add(Monitor *mon, const QDict *qdict);
170 void hmp_usb_del(Monitor *mon, const QDict *qdict);
171 void hmp_info_usb(Monitor *mon, const QDict *qdict);
172 
173 void add_boot_device_path(int32_t bootindex, DeviceState *dev,
174                           const char *suffix);
175 char *get_boot_devices_list(size_t *size, bool ignore_suffixes);
176 
177 DeviceState *get_boot_device(uint32_t position);
178 void check_boot_index(int32_t bootindex, Error **errp);
179 void del_boot_device_path(DeviceState *dev, const char *suffix);
180 void device_add_bootindex_property(Object *obj, int32_t *bootindex,
181                                    const char *name, const char *suffix,
182                                    DeviceState *dev, Error **errp);
183 void restore_boot_order(void *opaque);
184 void validate_bootdevices(const char *devices, Error **errp);
185 
186 /* handler to set the boot_device order for a specific type of MachineClass */
187 typedef void QEMUBootSetHandler(void *opaque, const char *boot_order,
188                                 Error **errp);
189 void qemu_register_boot_set(QEMUBootSetHandler *func, void *opaque);
190 void qemu_boot_set(const char *boot_order, Error **errp);
191 
192 QemuOpts *qemu_get_machine_opts(void);
193 
194 bool defaults_enabled(void);
195 
196 extern QemuOptsList qemu_legacy_drive_opts;
197 extern QemuOptsList qemu_common_drive_opts;
198 extern QemuOptsList qemu_drive_opts;
199 extern QemuOptsList bdrv_runtime_opts;
200 extern QemuOptsList qemu_chardev_opts;
201 extern QemuOptsList qemu_device_opts;
202 extern QemuOptsList qemu_netdev_opts;
203 extern QemuOptsList qemu_net_opts;
204 extern QemuOptsList qemu_global_opts;
205 extern QemuOptsList qemu_mon_opts;
206 
207 #endif
208