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 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
  72 void qemu_add_exit_notifier(Notifier *notify);
  73 void qemu_remove_exit_notifier(Notifier *notify);
  74
  75 void qemu_add_machine_init_done_notifier(Notifier *notify);
  76
  77 void do_savevm(Monitor *mon, const QDict *qdict);
  78 int load_vmstate(const char *name);
  79 void do_delvm(Monitor *mon, const QDict *qdict);
  80 void do_info_snapshots(Monitor *mon, const QDict *qdict);
  81
  82 void qemu_announce_self(void);
  83
  84 bool qemu_savevm_state_blocked(Error **errp);
  85 void qemu_savevm_state_begin(QEMUFile *f,
  86                              const MigrationParams *params);
  87 int qemu_savevm_state_iterate(QEMUFile *f);
  88 void qemu_savevm_state_complete(QEMUFile *f);
  89 void qemu_savevm_state_cancel(void);
  90 uint64_t qemu_savevm_state_pending(QEMUFile *f, uint64_t max_size);
  91 int qemu_loadvm_state(QEMUFile *f);
  92
  93 /* SLIRP */
  94 void do_info_slirp(Monitor *mon);
  95
  96 typedef enum DisplayType
  97 {
  98     DT_DEFAULT,
  99     DT_CURSES,
 100     DT_SDL,
 101     DT_GTK,
 102     DT_NOGRAPHIC,
 103     DT_NONE,
 104 } DisplayType;
 105
 106 extern int autostart;
 107
 108 typedef enum {
 109     VGA_NONE, VGA_STD, VGA_CIRRUS, VGA_VMWARE, VGA_XENFB, VGA_QXL,
 110     VGA_TCX, VGA_CG3, VGA_DEVICE
 111 } VGAInterfaceType;
 112
 113 extern int vga_interface_type;
 114 #define xenfb_enabled (vga_interface_type == VGA_XENFB)
 115
 116 extern int graphic_width;
 117 extern int graphic_height;
 118 extern int graphic_depth;
 119 extern DisplayType display_type;
 120 extern const char *keyboard_layout;
 121 extern int win2k_install_hack;
 122 extern int alt_grab;
 123 extern int ctrl_grab;
 124 extern int smp_cpus;
 125 extern int max_cpus;
 126 extern int cursor_hide;
 127 extern int graphic_rotate;
 128 extern int no_quit;
 129 extern int no_shutdown;
 130 extern int semihosting_enabled;
 131 extern int old_param;
 132 extern int boot_menu;
 133 extern bool boot_strict;
 134 extern uint8_t *boot_splash_filedata;
 135 extern size_t boot_splash_filedata_size;
 136 extern uint8_t qemu_extra_params_fw[2];
 137 extern QEMUClockType rtc_clock;
 138 extern const char *mem_path;
 139 extern int mem_prealloc;
 140
 141 #define MAX_NODES 128
 142
 143 /* The following shall be true for all CPUs:
 144  *   cpu->cpu_index < max_cpus <= MAX_CPUMASK_BITS
 145  *
 146  * Note that cpu->get_arch_id() may be larger than MAX_CPUMASK_BITS.
 147  */
 148 #define MAX_CPUMASK_BITS 255
 149
 150 extern int nb_numa_nodes;   /* Number of NUMA nodes */
 151 extern int max_numa_nodeid; /* Highest specified NUMA node ID, plus one.
 152                              * For all nodes, nodeid < max_numa_nodeid
 153                              */
 154
 155 typedef struct node_info {
 156     uint64_t node_mem;
 157     DECLARE_BITMAP(node_cpu, MAX_CPUMASK_BITS);
 158     struct HostMemoryBackend *node_memdev;
 159     bool present;
 160 } NodeInfo;
 161 extern NodeInfo numa_info[MAX_NODES];
 162 void set_numa_nodes(void);
 163 void set_numa_modes(void);
 164 extern QemuOptsList qemu_numa_opts;
 165 int numa_init_func(QemuOpts *opts, void *opaque);
 166
 167 #define MAX_OPTION_ROMS 16
 168 typedef struct QEMUOptionRom {
 169     const char *name;
 170     int32_t bootindex;
 171 } QEMUOptionRom;
 172 extern QEMUOptionRom option_rom[MAX_OPTION_ROMS];
 173 extern int nb_option_roms;
 174
 175 #define MAX_PROM_ENVS 128
 176 extern const char *prom_envs[MAX_PROM_ENVS];
 177 extern unsigned int nb_prom_envs;
 178
 179 /* pci-hotplug */
 180 void pci_device_hot_add(Monitor *mon, const QDict *qdict);
 181 int pci_drive_hot_add(Monitor *mon, const QDict *qdict, DriveInfo *dinfo);
 182 void do_pci_device_hot_remove(Monitor *mon, const QDict *qdict);
 183
 184 /* generic hotplug */
 185 void drive_hot_add(Monitor *mon, const QDict *qdict);
 186
 187 /* CPU hotplug */
 188 void qemu_register_cpu_added_notifier(Notifier *notifier);
 189
 190 /* pcie aer error injection */
 191 void pcie_aer_inject_error_print(Monitor *mon, const QObject *data);
 192 int do_pcie_aer_inject_error(Monitor *mon,
 193                              const QDict *qdict, QObject **ret_data);
 194
 195 /* serial ports */
 196
 197 #define MAX_SERIAL_PORTS 4
 198
 199 extern CharDriverState *serial_hds[MAX_SERIAL_PORTS];
 200
 201 /* parallel ports */
 202
 203 #define MAX_PARALLEL_PORTS 3
 204
 205 extern CharDriverState *parallel_hds[MAX_PARALLEL_PORTS];
 206
 207 void do_usb_add(Monitor *mon, const QDict *qdict);
 208 void do_usb_del(Monitor *mon, const QDict *qdict);
 209 void usb_info(Monitor *mon, const QDict *qdict);
 210
 211 void add_boot_device_path(int32_t bootindex, DeviceState *dev,
 212                           const char *suffix);
 213 char *get_boot_devices_list(size_t *size, bool ignore_suffixes);
 214
 215 DeviceState *get_boot_device(uint32_t position);
 216
 217 QemuOpts *qemu_get_machine_opts(void);
 218
 219 bool usb_enabled(bool default_usb);
 220
 221 extern QemuOptsList qemu_legacy_drive_opts;
 222 extern QemuOptsList qemu_common_drive_opts;
 223 extern QemuOptsList qemu_drive_opts;
 224 extern QemuOptsList qemu_chardev_opts;
 225 extern QemuOptsList qemu_device_opts;
 226 extern QemuOptsList qemu_netdev_opts;
 227 extern QemuOptsList qemu_net_opts;
 228 extern QemuOptsList qemu_global_opts;
 229 extern QemuOptsList qemu_mon_opts;
 230
 231 #endif