LXR qemu/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
  16extern const char *bios_name;
  17extern const char *qemu_name;
  18extern QemuUUID qemu_uuid;
  19extern bool qemu_uuid_set;
  20
  21bool runstate_check(RunState state);
  22void runstate_set(RunState new_state);
  23int runstate_is_running(void);
  24bool runstate_needs_reset(void);
  25bool runstate_store(char *str, size_t size);
  26typedef struct vm_change_state_entry VMChangeStateEntry;
  27typedef void VMChangeStateHandler(void *opaque, int running, RunState state);
  28
  29VMChangeStateEntry *qemu_add_vm_change_state_handler(VMChangeStateHandler *cb,
  30                                                     void *opaque);
  31void qemu_del_vm_change_state_handler(VMChangeStateEntry *e);
  32void vm_state_notify(int running, RunState state);
  33
  34/* Enumeration of various causes for shutdown. */
  35typedef 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_SUBSYSTEM_RESET,/* Partial guest reset that does not trigger
  48                                      QMP events and ignores --no-reboot. This
  49                                      is useful for sanitize hypercalls on s390
  50                                      that are used during kexec/kdump/boot */
  51    SHUTDOWN_CAUSE__MAX,
  52} ShutdownCause;
  53
  54static inline bool shutdown_caused_by_guest(ShutdownCause cause)
  55{
  56    return cause >= SHUTDOWN_CAUSE_GUEST_SHUTDOWN;
  57}
  58
  59void vm_start(void);
  60int vm_prepare_start(void);
  61int vm_stop(RunState state);
  62int vm_stop_force_state(RunState state);
  63int vm_shutdown(void);
  64
  65typedef enum WakeupReason {
  66    /* Always keep QEMU_WAKEUP_REASON_NONE = 0 */
  67    QEMU_WAKEUP_REASON_NONE = 0,
  68    QEMU_WAKEUP_REASON_RTC,
  69    QEMU_WAKEUP_REASON_PMTIMER,
  70    QEMU_WAKEUP_REASON_OTHER,
  71} WakeupReason;
  72
  73void qemu_exit_preconfig_request(void);
  74void qemu_system_reset_request(ShutdownCause reason);
  75void qemu_system_suspend_request(void);
  76void qemu_register_suspend_notifier(Notifier *notifier);
  77void qemu_system_wakeup_request(WakeupReason reason);
  78void qemu_system_wakeup_enable(WakeupReason reason, bool enabled);
  79void qemu_register_wakeup_notifier(Notifier *notifier);
  80void qemu_system_shutdown_request(ShutdownCause reason);
  81void qemu_system_powerdown_request(void);
  82void qemu_register_powerdown_notifier(Notifier *notifier);
  83void qemu_system_debug_request(void);
  84void qemu_system_vmstop_request(RunState reason);
  85void qemu_system_vmstop_request_prepare(void);
  86bool qemu_vmstop_requested(RunState *r);
  87ShutdownCause qemu_shutdown_requested_get(void);
  88ShutdownCause qemu_reset_requested_get(void);
  89void qemu_system_killed(int signal, pid_t pid);
  90void qemu_system_reset(ShutdownCause reason);
  91void qemu_system_guest_panicked(GuestPanicInformation *info);
  92
  93void qemu_add_exit_notifier(Notifier *notify);
  94void qemu_remove_exit_notifier(Notifier *notify);
  95
  96extern bool machine_init_done;
  97
  98void qemu_add_machine_init_done_notifier(Notifier *notify);
  99void qemu_remove_machine_init_done_notifier(Notifier *notify);
 100
 101void qemu_announce_self(void);
 102
 103extern int autostart;
 104
 105typedef enum {
 106    VGA_NONE, VGA_STD, VGA_CIRRUS, VGA_VMWARE, VGA_XENFB, VGA_QXL,
 107    VGA_TCX, VGA_CG3, VGA_DEVICE, VGA_VIRTIO,
 108    VGA_TYPE_MAX,
 109} VGAInterfaceType;
 110
 111extern int vga_interface_type;
 112#define xenfb_enabled (vga_interface_type == VGA_XENFB)
 113
 114extern int graphic_width;
 115extern int graphic_height;
 116extern int graphic_depth;
 117extern int display_opengl;
 118extern const char *keyboard_layout;
 119extern int win2k_install_hack;
 120extern int alt_grab;
 121extern int ctrl_grab;
 122extern int no_frame;
 123extern int smp_cpus;
 124extern unsigned int max_cpus;
 125extern int cursor_hide;
 126extern int graphic_rotate;
 127extern int no_quit;
 128extern int no_shutdown;
 129extern int old_param;
 130extern int boot_menu;
 131extern bool boot_strict;
 132extern uint8_t *boot_splash_filedata;
 133extern size_t boot_splash_filedata_size;
 134extern bool enable_mlock;
 135extern bool enable_cpu_pm;
 136extern uint8_t qemu_extra_params_fw[2];
 137extern QEMUClockType rtc_clock;
 138extern const char *mem_path;
 139extern int mem_prealloc;
 140
 141#define MAX_NODES 128
 142#define NUMA_NODE_UNASSIGNED MAX_NODES
 143#define NUMA_DISTANCE_MIN         10
 144#define NUMA_DISTANCE_DEFAULT     20
 145#define NUMA_DISTANCE_MAX         254
 146#define NUMA_DISTANCE_UNREACHABLE 255
 147
 148#define MAX_OPTION_ROMS 16
 149typedef struct QEMUOptionRom {
 150    const char *name;
 151    int32_t bootindex;
 152} QEMUOptionRom;
 153extern QEMUOptionRom option_rom[MAX_OPTION_ROMS];
 154extern int nb_option_roms;
 155
 156#define MAX_PROM_ENVS 128
 157extern const char *prom_envs[MAX_PROM_ENVS];
 158extern unsigned int nb_prom_envs;
 159
 160/* generic hotplug */
 161void hmp_drive_add(Monitor *mon, const QDict *qdict);
 162
 163/* pcie aer error injection */
 164void hmp_pcie_aer_inject_error(Monitor *mon, const QDict *qdict);
 165
 166/* serial ports */
 167
 168/* Return the Chardev for serial port i, or NULL if none */
 169Chardev *serial_hd(int i);
 170/* return the number of serial ports defined by the user. serial_hd(i)
 171 * will always return NULL for any i which is greater than or equal to this.
 172 */
 173int serial_max_hds(void);
 174
 175/* parallel ports */
 176
 177#define MAX_PARALLEL_PORTS 3
 178
 179extern Chardev *parallel_hds[MAX_PARALLEL_PORTS];
 180
 181void hmp_info_usb(Monitor *mon, const QDict *qdict);
 182
 183void add_boot_device_path(int32_t bootindex, DeviceState *dev,
 184                          const char *suffix);
 185char *get_boot_devices_list(size_t *size);
 186
 187DeviceState *get_boot_device(uint32_t position);
 188void check_boot_index(int32_t bootindex, Error **errp);
 189void del_boot_device_path(DeviceState *dev, const char *suffix);
 190void device_add_bootindex_property(Object *obj, int32_t *bootindex,
 191                                   const char *name, const char *suffix,
 192                                   DeviceState *dev, Error **errp);
 193void restore_boot_order(void *opaque);
 194void validate_bootdevices(const char *devices, Error **errp);
 195
 196/* handler to set the boot_device order for a specific type of MachineClass */
 197typedef void QEMUBootSetHandler(void *opaque, const char *boot_order,
 198                                Error **errp);
 199void qemu_register_boot_set(QEMUBootSetHandler *func, void *opaque);
 200void qemu_boot_set(const char *boot_order, Error **errp);
 201
 202QemuOpts *qemu_get_machine_opts(void);
 203
 204bool defaults_enabled(void);
 205
 206extern QemuOptsList qemu_legacy_drive_opts;
 207extern QemuOptsList qemu_common_drive_opts;
 208extern QemuOptsList qemu_drive_opts;
 209extern QemuOptsList bdrv_runtime_opts;
 210extern QemuOptsList qemu_chardev_opts;
 211extern QemuOptsList qemu_device_opts;
 212extern QemuOptsList qemu_netdev_opts;
 213extern QemuOptsList qemu_nic_opts;
 214extern QemuOptsList qemu_net_opts;
 215extern QemuOptsList qemu_global_opts;
 216extern QemuOptsList qemu_mon_opts;
 217
 218#endif
 219