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 "qemu/option.h"
   6#include "qemu/queue.h"
   7#include "qemu/timer.h"
   8#include "qapi-types.h"
   9#include "qemu/notify.h"
  10#include "qemu/main-loop.h"
  11#include "qemu/bitmap.h"
  12#include "qom/object.h"
  13
  14/* vl.c */
  15
  16extern const char *bios_name;
  17
  18extern const char *qemu_name;
  19extern uint8_t qemu_uuid[];
  20extern bool qemu_uuid_set;
  21int qemu_uuid_parse(const char *str, uint8_t *uuid);
  22
  23#define UUID_FMT "%02hhx%02hhx%02hhx%02hhx-%02hhx%02hhx-%02hhx%02hhx-%02hhx%02hhx-%02hhx%02hhx%02hhx%02hhx%02hhx%02hhx"
  24#define UUID_NONE "00000000-0000-0000-0000-000000000000"
  25
  26bool runstate_check(RunState state);
  27void runstate_set(RunState new_state);
  28int runstate_is_running(void);
  29bool runstate_needs_reset(void);
  30bool runstate_store(char *str, size_t size);
  31typedef struct vm_change_state_entry VMChangeStateEntry;
  32typedef void VMChangeStateHandler(void *opaque, int running, RunState state);
  33
  34VMChangeStateEntry *qemu_add_vm_change_state_handler(VMChangeStateHandler *cb,
  35                                                     void *opaque);
  36void qemu_del_vm_change_state_handler(VMChangeStateEntry *e);
  37void vm_state_notify(int running, RunState state);
  38
  39#define VMRESET_SILENT   false
  40#define VMRESET_REPORT   true
  41
  42void vm_start(void);
  43int vm_stop(RunState state);
  44int vm_stop_force_state(RunState state);
  45
  46typedef enum WakeupReason {
  47    /* Always keep QEMU_WAKEUP_REASON_NONE = 0 */
  48    QEMU_WAKEUP_REASON_NONE = 0,
  49    QEMU_WAKEUP_REASON_RTC,
  50    QEMU_WAKEUP_REASON_PMTIMER,
  51    QEMU_WAKEUP_REASON_OTHER,
  52} WakeupReason;
  53
  54void qemu_system_reset_request(void);
  55void qemu_system_suspend_request(void);
  56void qemu_register_suspend_notifier(Notifier *notifier);
  57void qemu_system_wakeup_request(WakeupReason reason);
  58void qemu_system_wakeup_enable(WakeupReason reason, bool enabled);
  59void qemu_register_wakeup_notifier(Notifier *notifier);
  60void qemu_system_shutdown_request(void);
  61void qemu_system_powerdown_request(void);
  62void qemu_register_powerdown_notifier(Notifier *notifier);
  63void qemu_system_debug_request(void);
  64void qemu_system_vmstop_request(RunState reason);
  65void qemu_system_vmstop_request_prepare(void);
  66int qemu_shutdown_requested_get(void);
  67int qemu_reset_requested_get(void);
  68void qemu_system_killed(int signal, pid_t pid);
  69void qemu_devices_reset(void);
  70void qemu_system_reset(bool report);
  71void qemu_system_guest_panicked(void);
  72size_t qemu_target_page_bits(void);
  73
  74void qemu_add_exit_notifier(Notifier *notify);
  75void qemu_remove_exit_notifier(Notifier *notify);
  76
  77void qemu_add_machine_init_done_notifier(Notifier *notify);
  78
  79void hmp_savevm(Monitor *mon, const QDict *qdict);
  80int load_vmstate(const char *name);
  81void hmp_delvm(Monitor *mon, const QDict *qdict);
  82void hmp_info_snapshots(Monitor *mon, const QDict *qdict);
  83
  84void qemu_announce_self(void);
  85
  86/* Subcommands for QEMU_VM_COMMAND */
  87enum qemu_vm_cmd {
  88    MIG_CMD_INVALID = 0,   /* Must be 0 */
  89    MIG_CMD_OPEN_RETURN_PATH,  /* Tell the dest to open the Return path */
  90    MIG_CMD_PING,              /* Request a PONG on the RP */
  91
  92    MIG_CMD_POSTCOPY_ADVISE,       /* Prior to any page transfers, just
  93                                      warn we might want to do PC */
  94    MIG_CMD_POSTCOPY_LISTEN,       /* Start listening for incoming
  95                                      pages as it's running. */
  96    MIG_CMD_POSTCOPY_RUN,          /* Start execution */
  97
  98    MIG_CMD_POSTCOPY_RAM_DISCARD,  /* A list of pages to discard that
  99                                      were previously sent during
 100                                      precopy but are dirty. */
 101    MIG_CMD_PACKAGED,          /* Send a wrapped stream within this stream */
 102    MIG_CMD_MAX
 103};
 104
 105#define MAX_VM_CMD_PACKAGED_SIZE (1ul << 24)
 106
 107bool qemu_savevm_state_blocked(Error **errp);
 108void qemu_savevm_state_begin(QEMUFile *f,
 109                             const MigrationParams *params);
 110void qemu_savevm_state_header(QEMUFile *f);
 111int qemu_savevm_state_iterate(QEMUFile *f, bool postcopy);
 112void qemu_savevm_state_cleanup(void);
 113void qemu_savevm_state_complete_postcopy(QEMUFile *f);
 114void qemu_savevm_state_complete_precopy(QEMUFile *f, bool iterable_only);
 115void qemu_savevm_state_pending(QEMUFile *f, uint64_t max_size,
 116                               uint64_t *res_non_postcopiable,
 117                               uint64_t *res_postcopiable);
 118void qemu_savevm_command_send(QEMUFile *f, enum qemu_vm_cmd command,
 119                              uint16_t len, uint8_t *data);
 120void qemu_savevm_send_ping(QEMUFile *f, uint32_t value);
 121void qemu_savevm_send_open_return_path(QEMUFile *f);
 122int qemu_savevm_send_packaged(QEMUFile *f, const QEMUSizedBuffer *qsb);
 123void qemu_savevm_send_postcopy_advise(QEMUFile *f);
 124void qemu_savevm_send_postcopy_listen(QEMUFile *f);
 125void qemu_savevm_send_postcopy_run(QEMUFile *f);
 126
 127void qemu_savevm_send_postcopy_ram_discard(QEMUFile *f, const char *name,
 128                                           uint16_t len,
 129                                           uint64_t *start_list,
 130                                           uint64_t *length_list);
 131
 132int qemu_loadvm_state(QEMUFile *f);
 133
 134typedef enum DisplayType
 135{
 136    DT_DEFAULT,
 137    DT_CURSES,
 138    DT_SDL,
 139    DT_GTK,
 140    DT_NOGRAPHIC,
 141    DT_NONE,
 142} DisplayType;
 143
 144extern int autostart;
 145
 146typedef enum {
 147    VGA_NONE, VGA_STD, VGA_CIRRUS, VGA_VMWARE, VGA_XENFB, VGA_QXL,
 148    VGA_TCX, VGA_CG3, VGA_DEVICE, VGA_VIRTIO,
 149} VGAInterfaceType;
 150
 151extern int vga_interface_type;
 152#define xenfb_enabled (vga_interface_type == VGA_XENFB)
 153
 154extern int graphic_width;
 155extern int graphic_height;
 156extern int graphic_depth;
 157extern DisplayType display_type;
 158extern int display_opengl;
 159extern const char *keyboard_layout;
 160extern int win2k_install_hack;
 161extern int alt_grab;
 162extern int ctrl_grab;
 163extern int smp_cpus;
 164extern int max_cpus;
 165extern int cursor_hide;
 166extern int graphic_rotate;
 167extern int no_quit;
 168extern int no_shutdown;
 169extern int old_param;
 170extern int boot_menu;
 171extern bool boot_strict;
 172extern uint8_t *boot_splash_filedata;
 173extern size_t boot_splash_filedata_size;
 174extern bool enable_mlock;
 175extern uint8_t qemu_extra_params_fw[2];
 176extern QEMUClockType rtc_clock;
 177extern const char *mem_path;
 178extern int mem_prealloc;
 179
 180#define MAX_NODES 128
 181#define NUMA_NODE_UNASSIGNED MAX_NODES
 182
 183/* The following shall be true for all CPUs:
 184 *   cpu->cpu_index < max_cpus <= MAX_CPUMASK_BITS
 185 *
 186 * Note that cpu->get_arch_id() may be larger than MAX_CPUMASK_BITS.
 187 */
 188#define MAX_CPUMASK_BITS 255
 189
 190#define MAX_OPTION_ROMS 16
 191typedef struct QEMUOptionRom {
 192    const char *name;
 193    int32_t bootindex;
 194} QEMUOptionRom;
 195extern QEMUOptionRom option_rom[MAX_OPTION_ROMS];
 196extern int nb_option_roms;
 197
 198#define MAX_PROM_ENVS 128
 199extern const char *prom_envs[MAX_PROM_ENVS];
 200extern unsigned int nb_prom_envs;
 201
 202/* generic hotplug */
 203void hmp_drive_add(Monitor *mon, const QDict *qdict);
 204
 205/* pcie aer error injection */
 206void hmp_pcie_aer_inject_error(Monitor *mon, const QDict *qdict);
 207
 208/* serial ports */
 209
 210#define MAX_SERIAL_PORTS 4
 211
 212extern CharDriverState *serial_hds[MAX_SERIAL_PORTS];
 213
 214/* parallel ports */
 215
 216#define MAX_PARALLEL_PORTS 3
 217
 218extern CharDriverState *parallel_hds[MAX_PARALLEL_PORTS];
 219
 220void hmp_usb_add(Monitor *mon, const QDict *qdict);
 221void hmp_usb_del(Monitor *mon, const QDict *qdict);
 222void hmp_info_usb(Monitor *mon, const QDict *qdict);
 223
 224void add_boot_device_path(int32_t bootindex, DeviceState *dev,
 225                          const char *suffix);
 226char *get_boot_devices_list(size_t *size, bool ignore_suffixes);
 227
 228DeviceState *get_boot_device(uint32_t position);
 229void check_boot_index(int32_t bootindex, Error **errp);
 230void del_boot_device_path(DeviceState *dev, const char *suffix);
 231void device_add_bootindex_property(Object *obj, int32_t *bootindex,
 232                                   const char *name, const char *suffix,
 233                                   DeviceState *dev, Error **errp);
 234void restore_boot_order(void *opaque);
 235void validate_bootdevices(const char *devices, Error **errp);
 236
 237/* handler to set the boot_device order for a specific type of MachineClass */
 238typedef void QEMUBootSetHandler(void *opaque, const char *boot_order,
 239                                Error **errp);
 240void qemu_register_boot_set(QEMUBootSetHandler *func, void *opaque);
 241void qemu_boot_set(const char *boot_order, Error **errp);
 242
 243QemuOpts *qemu_get_machine_opts(void);
 244
 245bool defaults_enabled(void);
 246bool usb_enabled(void);
 247
 248extern QemuOptsList qemu_legacy_drive_opts;
 249extern QemuOptsList qemu_common_drive_opts;
 250extern QemuOptsList qemu_drive_opts;
 251extern QemuOptsList qemu_chardev_opts;
 252extern QemuOptsList qemu_device_opts;
 253extern QemuOptsList qemu_netdev_opts;
 254extern QemuOptsList qemu_net_opts;
 255extern QemuOptsList qemu_global_opts;
 256extern QemuOptsList qemu_mon_opts;
 257
 258#endif
 259