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