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