include/sysemu/sysemu.h

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