xref: /openbmc/qemu/include/sysemu/sysemu.h (revision 9af23989)
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 
60 typedef enum WakeupReason {
61     /* Always keep QEMU_WAKEUP_REASON_NONE = 0 */
62     QEMU_WAKEUP_REASON_NONE = 0,
63     QEMU_WAKEUP_REASON_RTC,
64     QEMU_WAKEUP_REASON_PMTIMER,
65     QEMU_WAKEUP_REASON_OTHER,
66 } WakeupReason;
67 
68 void qemu_system_reset_request(ShutdownCause reason);
69 void qemu_system_suspend_request(void);
70 void qemu_register_suspend_notifier(Notifier *notifier);
71 void qemu_system_wakeup_request(WakeupReason reason);
72 void qemu_system_wakeup_enable(WakeupReason reason, bool enabled);
73 void qemu_register_wakeup_notifier(Notifier *notifier);
74 void qemu_system_shutdown_request(ShutdownCause reason);
75 void qemu_system_powerdown_request(void);
76 void qemu_register_powerdown_notifier(Notifier *notifier);
77 void qemu_system_debug_request(void);
78 void qemu_system_vmstop_request(RunState reason);
79 void qemu_system_vmstop_request_prepare(void);
80 bool qemu_vmstop_requested(RunState *r);
81 ShutdownCause qemu_shutdown_requested_get(void);
82 ShutdownCause qemu_reset_requested_get(void);
83 void qemu_system_killed(int signal, pid_t pid);
84 void qemu_system_reset(ShutdownCause reason);
85 void qemu_system_guest_panicked(GuestPanicInformation *info);
86 
87 void qemu_add_exit_notifier(Notifier *notify);
88 void qemu_remove_exit_notifier(Notifier *notify);
89 
90 void qemu_add_machine_init_done_notifier(Notifier *notify);
91 void qemu_remove_machine_init_done_notifier(Notifier *notify);
92 
93 void qemu_announce_self(void);
94 
95 extern int autostart;
96 
97 typedef enum {
98     VGA_NONE, VGA_STD, VGA_CIRRUS, VGA_VMWARE, VGA_XENFB, VGA_QXL,
99     VGA_TCX, VGA_CG3, VGA_DEVICE, VGA_VIRTIO,
100     VGA_TYPE_MAX,
101 } VGAInterfaceType;
102 
103 extern int vga_interface_type;
104 #define xenfb_enabled (vga_interface_type == VGA_XENFB)
105 
106 extern int graphic_width;
107 extern int graphic_height;
108 extern int graphic_depth;
109 extern int display_opengl;
110 extern const char *keyboard_layout;
111 extern int win2k_install_hack;
112 extern int alt_grab;
113 extern int ctrl_grab;
114 extern int no_frame;
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_info_usb(Monitor *mon, const QDict *qdict);
170 
171 void add_boot_device_path(int32_t bootindex, DeviceState *dev,
172                           const char *suffix);
173 char *get_boot_devices_list(size_t *size, bool ignore_suffixes);
174 
175 DeviceState *get_boot_device(uint32_t position);
176 void check_boot_index(int32_t bootindex, Error **errp);
177 void del_boot_device_path(DeviceState *dev, const char *suffix);
178 void device_add_bootindex_property(Object *obj, int32_t *bootindex,
179                                    const char *name, const char *suffix,
180                                    DeviceState *dev, Error **errp);
181 void restore_boot_order(void *opaque);
182 void validate_bootdevices(const char *devices, Error **errp);
183 
184 /* handler to set the boot_device order for a specific type of MachineClass */
185 typedef void QEMUBootSetHandler(void *opaque, const char *boot_order,
186                                 Error **errp);
187 void qemu_register_boot_set(QEMUBootSetHandler *func, void *opaque);
188 void qemu_boot_set(const char *boot_order, Error **errp);
189 
190 QemuOpts *qemu_get_machine_opts(void);
191 
192 bool defaults_enabled(void);
193 
194 extern QemuOptsList qemu_legacy_drive_opts;
195 extern QemuOptsList qemu_common_drive_opts;
196 extern QemuOptsList qemu_drive_opts;
197 extern QemuOptsList bdrv_runtime_opts;
198 extern QemuOptsList qemu_chardev_opts;
199 extern QemuOptsList qemu_device_opts;
200 extern QemuOptsList qemu_netdev_opts;
201 extern QemuOptsList qemu_net_opts;
202 extern QemuOptsList qemu_global_opts;
203 extern QemuOptsList qemu_mon_opts;
204 
205 #endif
206