include/sysemu/sysemu.h

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