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