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