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
  16 extern const char *bios_name;
  17
  18 extern const char *qemu_name;
  19 extern uint8_t qemu_uuid[];
  20 extern bool qemu_uuid_set;
  21 int 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
  26 bool runstate_check(RunState state);
  27 void runstate_set(RunState new_state);
  28 int runstate_is_running(void);
  29 bool runstate_needs_reset(void);
  30 bool runstate_store(char *str, size_t size);
  31 typedef struct vm_change_state_entry VMChangeStateEntry;
  32 typedef void VMChangeStateHandler(void *opaque, int running, RunState state);
  33
  34 VMChangeStateEntry *qemu_add_vm_change_state_handler(VMChangeStateHandler *cb,
  35                                                      void *opaque);
  36 void qemu_del_vm_change_state_handler(VMChangeStateEntry *e);
  37 void vm_state_notify(int running, RunState state);
  38
  39 #define VMRESET_SILENT   false
  40 #define VMRESET_REPORT   true
  41
  42 void vm_start(void);
  43 int vm_stop(RunState state);
  44 int vm_stop_force_state(RunState state);
  45
  46 typedef 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
  54 void qemu_system_reset_request(void);
  55 void qemu_system_suspend_request(void);
  56 void qemu_register_suspend_notifier(Notifier *notifier);
  57 void qemu_system_wakeup_request(WakeupReason reason);
  58 void qemu_system_wakeup_enable(WakeupReason reason, bool enabled);
  59 void qemu_register_wakeup_notifier(Notifier *notifier);
  60 void qemu_system_shutdown_request(void);
  61 void qemu_system_powerdown_request(void);
  62 void qemu_register_powerdown_notifier(Notifier *notifier);
  63 void qemu_system_debug_request(void);
  64 void qemu_system_vmstop_request(RunState reason);
  65 void qemu_system_vmstop_request_prepare(void);
  66 int qemu_shutdown_requested_get(void);
  67 int qemu_reset_requested_get(void);
  68 void qemu_system_killed(int signal, pid_t pid);
  69 void qemu_devices_reset(void);
  70 void qemu_system_reset(bool report);
  71 void qemu_system_guest_panicked(void);
  72 size_t qemu_target_page_bits(void);
  73
  74 void qemu_add_exit_notifier(Notifier *notify);
  75 void qemu_remove_exit_notifier(Notifier *notify);
  76
  77 void qemu_add_machine_init_done_notifier(Notifier *notify);
  78 void qemu_remove_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 uint8_t *buf, size_t len);
 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 extern int autostart;
 136
 137 typedef enum {
 138     VGA_NONE, VGA_STD, VGA_CIRRUS, VGA_VMWARE, VGA_XENFB, VGA_QXL,
 139     VGA_TCX, VGA_CG3, VGA_DEVICE, VGA_VIRTIO,
 140     VGA_TYPE_MAX,
 141 } VGAInterfaceType;
 142
 143 extern int vga_interface_type;
 144 #define xenfb_enabled (vga_interface_type == VGA_XENFB)
 145
 146 extern int graphic_width;
 147 extern int graphic_height;
 148 extern int graphic_depth;
 149 extern int display_opengl;
 150 extern const char *keyboard_layout;
 151 extern int win2k_install_hack;
 152 extern int alt_grab;
 153 extern int ctrl_grab;
 154 extern int smp_cpus;
 155 extern int max_cpus;
 156 extern int cursor_hide;
 157 extern int graphic_rotate;
 158 extern int no_quit;
 159 extern int no_shutdown;
 160 extern int old_param;
 161 extern int boot_menu;
 162 extern bool boot_strict;
 163 extern uint8_t *boot_splash_filedata;
 164 extern size_t boot_splash_filedata_size;
 165 extern bool enable_mlock;
 166 extern uint8_t qemu_extra_params_fw[2];
 167 extern QEMUClockType rtc_clock;
 168 extern const char *mem_path;
 169 extern int mem_prealloc;
 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 255
 180
 181 #define MAX_OPTION_ROMS 16
 182 typedef struct QEMUOptionRom {
 183     const char *name;
 184     int32_t bootindex;
 185 } QEMUOptionRom;
 186 extern QEMUOptionRom option_rom[MAX_OPTION_ROMS];
 187 extern int nb_option_roms;
 188
 189 #define MAX_PROM_ENVS 128
 190 extern const char *prom_envs[MAX_PROM_ENVS];
 191 extern unsigned int nb_prom_envs;
 192
 193 /* generic hotplug */
 194 void hmp_drive_add(Monitor *mon, const QDict *qdict);
 195
 196 /* pcie aer error injection */
 197 void hmp_pcie_aer_inject_error(Monitor *mon, const QDict *qdict);
 198
 199 /* serial ports */
 200
 201 #define MAX_SERIAL_PORTS 4
 202
 203 extern CharDriverState *serial_hds[MAX_SERIAL_PORTS];
 204
 205 /* parallel ports */
 206
 207 #define MAX_PARALLEL_PORTS 3
 208
 209 extern CharDriverState *parallel_hds[MAX_PARALLEL_PORTS];
 210
 211 void hmp_usb_add(Monitor *mon, const QDict *qdict);
 212 void hmp_usb_del(Monitor *mon, const QDict *qdict);
 213 void hmp_info_usb(Monitor *mon, const QDict *qdict);
 214
 215 void add_boot_device_path(int32_t bootindex, DeviceState *dev,
 216                           const char *suffix);
 217 char *get_boot_devices_list(size_t *size, bool ignore_suffixes);
 218
 219 DeviceState *get_boot_device(uint32_t position);
 220 void check_boot_index(int32_t bootindex, Error **errp);
 221 void del_boot_device_path(DeviceState *dev, const char *suffix);
 222 void device_add_bootindex_property(Object *obj, int32_t *bootindex,
 223                                    const char *name, const char *suffix,
 224                                    DeviceState *dev, Error **errp);
 225 void restore_boot_order(void *opaque);
 226 void validate_bootdevices(const char *devices, Error **errp);
 227
 228 /* handler to set the boot_device order for a specific type of MachineClass */
 229 typedef void QEMUBootSetHandler(void *opaque, const char *boot_order,
 230                                 Error **errp);
 231 void qemu_register_boot_set(QEMUBootSetHandler *func, void *opaque);
 232 void qemu_boot_set(const char *boot_order, Error **errp);
 233
 234 QemuOpts *qemu_get_machine_opts(void);
 235
 236 bool defaults_enabled(void);
 237
 238 extern QemuOptsList qemu_legacy_drive_opts;
 239 extern QemuOptsList qemu_common_drive_opts;
 240 extern QemuOptsList qemu_drive_opts;
 241 extern QemuOptsList qemu_chardev_opts;
 242 extern QemuOptsList qemu_device_opts;
 243 extern QemuOptsList qemu_netdev_opts;
 244 extern QemuOptsList qemu_net_opts;
 245 extern QemuOptsList qemu_global_opts;
 246 extern QemuOptsList qemu_mon_opts;
 247
 248 #endif