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/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 int vm_shutdown(void);
  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 no_frame;
 116 extern int smp_cpus;
 117 extern unsigned int max_cpus;
 118 extern int cursor_hide;
 119 extern int graphic_rotate;
 120 extern int no_quit;
 121 extern int no_shutdown;
 122 extern int old_param;
 123 extern int boot_menu;
 124 extern bool boot_strict;
 125 extern uint8_t *boot_splash_filedata;
 126 extern size_t boot_splash_filedata_size;
 127 extern bool enable_mlock;
 128 extern uint8_t qemu_extra_params_fw[2];
 129 extern QEMUClockType rtc_clock;
 130 extern const char *mem_path;
 131 extern int mem_prealloc;
 132
 133 #define MAX_NODES 128
 134 #define NUMA_NODE_UNASSIGNED MAX_NODES
 135 #define NUMA_DISTANCE_MIN         10
 136 #define NUMA_DISTANCE_DEFAULT     20
 137 #define NUMA_DISTANCE_MAX         254
 138 #define NUMA_DISTANCE_UNREACHABLE 255
 139
 140 #define MAX_OPTION_ROMS 16
 141 typedef struct QEMUOptionRom {
 142     const char *name;
 143     int32_t bootindex;
 144 } QEMUOptionRom;
 145 extern QEMUOptionRom option_rom[MAX_OPTION_ROMS];
 146 extern int nb_option_roms;
 147
 148 #define MAX_PROM_ENVS 128
 149 extern const char *prom_envs[MAX_PROM_ENVS];
 150 extern unsigned int nb_prom_envs;
 151
 152 /* generic hotplug */
 153 void hmp_drive_add(Monitor *mon, const QDict *qdict);
 154
 155 /* pcie aer error injection */
 156 void hmp_pcie_aer_inject_error(Monitor *mon, const QDict *qdict);
 157
 158 /* serial ports */
 159
 160 #define MAX_SERIAL_PORTS 4
 161
 162 extern Chardev *serial_hds[MAX_SERIAL_PORTS];
 163
 164 /* parallel ports */
 165
 166 #define MAX_PARALLEL_PORTS 3
 167
 168 extern Chardev *parallel_hds[MAX_PARALLEL_PORTS];
 169
 170 void hmp_info_usb(Monitor *mon, const QDict *qdict);
 171
 172 void add_boot_device_path(int32_t bootindex, DeviceState *dev,
 173                           const char *suffix);
 174 char *get_boot_devices_list(size_t *size, bool ignore_suffixes);
 175
 176 DeviceState *get_boot_device(uint32_t position);
 177 void check_boot_index(int32_t bootindex, Error **errp);
 178 void del_boot_device_path(DeviceState *dev, const char *suffix);
 179 void device_add_bootindex_property(Object *obj, int32_t *bootindex,
 180                                    const char *name, const char *suffix,
 181                                    DeviceState *dev, Error **errp);
 182 void restore_boot_order(void *opaque);
 183 void validate_bootdevices(const char *devices, Error **errp);
 184
 185 /* handler to set the boot_device order for a specific type of MachineClass */
 186 typedef void QEMUBootSetHandler(void *opaque, const char *boot_order,
 187                                 Error **errp);
 188 void qemu_register_boot_set(QEMUBootSetHandler *func, void *opaque);
 189 void qemu_boot_set(const char *boot_order, Error **errp);
 190
 191 QemuOpts *qemu_get_machine_opts(void);
 192
 193 bool defaults_enabled(void);
 194
 195 extern QemuOptsList qemu_legacy_drive_opts;
 196 extern QemuOptsList qemu_common_drive_opts;
 197 extern QemuOptsList qemu_drive_opts;
 198 extern QemuOptsList bdrv_runtime_opts;
 199 extern QemuOptsList qemu_chardev_opts;
 200 extern QemuOptsList qemu_device_opts;
 201 extern QemuOptsList qemu_netdev_opts;
 202 extern QemuOptsList qemu_nic_opts;
 203 extern QemuOptsList qemu_net_opts;
 204 extern QemuOptsList qemu_global_opts;
 205 extern QemuOptsList qemu_mon_opts;
 206
 207 #endif