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