include/hw/boards.h

   1 /* Declarations for use by board files for creating devices.  */
   2
   3 #ifndef HW_BOARDS_H
   4 #define HW_BOARDS_H
   5
   6 #include "exec/memory.h"
   7 #include "sysemu/hostmem.h"
   8 #include "sysemu/blockdev.h"
   9 #include "qemu/accel.h"
  10 #include "qapi/qapi-types-machine.h"
  11 #include "qemu/module.h"
  12 #include "qom/object.h"
  13 #include "hw/core/cpu.h"
  14
  15 #define TYPE_MACHINE_SUFFIX "-machine"
  16
  17 /* Machine class name that needs to be used for class-name-based machine
  18  * type lookup to work.
  19  */
  20 #define MACHINE_TYPE_NAME(machinename) (machinename TYPE_MACHINE_SUFFIX)
  21
  22 #define TYPE_MACHINE "machine"
  23 #undef MACHINE  /* BSD defines it and QEMU does not use it */
  24 OBJECT_DECLARE_TYPE(MachineState, MachineClass, MACHINE)
  25
  26 extern MachineState *current_machine;
  27
  28 void machine_run_board_init(MachineState *machine, const char *mem_path, Error **errp);
  29 bool machine_usb(MachineState *machine);
  30 int machine_phandle_start(MachineState *machine);
  31 bool machine_dump_guest_core(MachineState *machine);
  32 bool machine_mem_merge(MachineState *machine);
  33 HotpluggableCPUList *machine_query_hotpluggable_cpus(MachineState *machine);
  34 void machine_set_cpu_numa_node(MachineState *machine,
  35                                const CpuInstanceProperties *props,
  36                                Error **errp);
  37 void machine_parse_smp_config(MachineState *ms,
  38                               const SMPConfiguration *config, Error **errp);
  39
  40 /**
  41  * machine_class_allow_dynamic_sysbus_dev: Add type to list of valid devices
  42  * @mc: Machine class
  43  * @type: type to allow (should be a subtype of TYPE_SYS_BUS_DEVICE)
  44  *
  45  * Add the QOM type @type to the list of devices of which are subtypes
  46  * of TYPE_SYS_BUS_DEVICE but which are still permitted to be dynamically
  47  * created (eg by the user on the command line with -device).
  48  * By default if the user tries to create any devices on the command line
  49  * that are subtypes of TYPE_SYS_BUS_DEVICE they will get an error message;
  50  * for the special cases which are permitted for this machine model, the
  51  * machine model class init code must call this function to add them
  52  * to the list of specifically permitted devices.
  53  */
  54 void machine_class_allow_dynamic_sysbus_dev(MachineClass *mc, const char *type);
  55
  56 /**
  57  * device_type_is_dynamic_sysbus: Check if type is an allowed sysbus device
  58  * type for the machine class.
  59  * @mc: Machine class
  60  * @type: type to check (should be a subtype of TYPE_SYS_BUS_DEVICE)
  61  *
  62  * Returns: true if @type is a type in the machine's list of
  63  * dynamically pluggable sysbus devices; otherwise false.
  64  *
  65  * Check if the QOM type @type is in the list of allowed sysbus device
  66  * types (see machine_class_allowed_dynamic_sysbus_dev()).
  67  * Note that if @type has a parent type in the list, it is allowed too.
  68  */
  69 bool device_type_is_dynamic_sysbus(MachineClass *mc, const char *type);
  70
  71 /**
  72  * device_is_dynamic_sysbus: test whether device is a dynamic sysbus device
  73  * @mc: Machine class
  74  * @dev: device to check
  75  *
  76  * Returns: true if @dev is a sysbus device on the machine's list
  77  * of dynamically pluggable sysbus devices; otherwise false.
  78  *
  79  * This function checks whether @dev is a valid dynamic sysbus device,
  80  * by first confirming that it is a sysbus device and then checking it
  81  * against the list of permitted dynamic sysbus devices which has been
  82  * set up by the machine using machine_class_allow_dynamic_sysbus_dev().
  83  *
  84  * It is valid to call this with something that is not a subclass of
  85  * TYPE_SYS_BUS_DEVICE; the function will return false in this case.
  86  * This allows hotplug callback functions to be written as:
  87  *     if (device_is_dynamic_sysbus(mc, dev)) {
  88  *         handle dynamic sysbus case;
  89  *     } else if (some other kind of hotplug) {
  90  *         handle that;
  91  *     }
  92  */
  93 bool device_is_dynamic_sysbus(MachineClass *mc, DeviceState *dev);
  94
  95 /*
  96  * Checks that backend isn't used, preps it for exclusive usage and
  97  * returns migratable MemoryRegion provided by backend.
  98  */
  99 MemoryRegion *machine_consume_memdev(MachineState *machine,
 100                                      HostMemoryBackend *backend);
 101
 102 /**
 103  * CPUArchId:
 104  * @arch_id - architecture-dependent CPU ID of present or possible CPU
 105  * @cpu - pointer to corresponding CPU object if it's present on NULL otherwise
 106  * @type - QOM class name of possible @cpu object
 107  * @props - CPU object properties, initialized by board
 108  * #vcpus_count - number of threads provided by @cpu object
 109  */
 110 typedef struct CPUArchId {
 111     uint64_t arch_id;
 112     int64_t vcpus_count;
 113     CpuInstanceProperties props;
 114     Object *cpu;
 115     const char *type;
 116 } CPUArchId;
 117
 118 /**
 119  * CPUArchIdList:
 120  * @len - number of @CPUArchId items in @cpus array
 121  * @cpus - array of present or possible CPUs for current machine configuration
 122  */
 123 typedef struct {
 124     int len;
 125     CPUArchId cpus[];
 126 } CPUArchIdList;
 127
 128 /**
 129  * SMPCompatProps:
 130  * @prefer_sockets - whether sockets are preferred over cores in smp parsing
 131  * @dies_supported - whether dies are supported by the machine
 132  * @clusters_supported - whether clusters are supported by the machine
 133  */
 134 typedef struct {
 135     bool prefer_sockets;
 136     bool dies_supported;
 137     bool clusters_supported;
 138 } SMPCompatProps;
 139
 140 /**
 141  * MachineClass:
 142  * @deprecation_reason: If set, the machine is marked as deprecated. The
 143  *    string should provide some clear information about what to use instead.
 144  * @max_cpus: maximum number of CPUs supported. Default: 1
 145  * @min_cpus: minimum number of CPUs supported. Default: 1
 146  * @default_cpus: number of CPUs instantiated if none are specified. Default: 1
 147  * @is_default:
 148  *    If true QEMU will use this machine by default if no '-M' option is given.
 149  * @get_hotplug_handler: this function is called during bus-less
 150  *    device hotplug. If defined it returns pointer to an instance
 151  *    of HotplugHandler object, which handles hotplug operation
 152  *    for a given @dev. It may return NULL if @dev doesn't require
 153  *    any actions to be performed by hotplug handler.
 154  * @cpu_index_to_instance_props:
 155  *    used to provide @cpu_index to socket/core/thread number mapping, allowing
 156  *    legacy code to perform maping from cpu_index to topology properties
 157  *    Returns: tuple of socket/core/thread ids given cpu_index belongs to.
 158  *    used to provide @cpu_index to socket number mapping, allowing
 159  *    a machine to group CPU threads belonging to the same socket/package
 160  *    Returns: socket number given cpu_index belongs to.
 161  * @hw_version:
 162  *    Value of QEMU_VERSION when the machine was added to QEMU.
 163  *    Set only by old machines because they need to keep
 164  *    compatibility on code that exposed QEMU_VERSION to guests in
 165  *    the past (and now use qemu_hw_version()).
 166  * @possible_cpu_arch_ids:
 167  *    Returns an array of @CPUArchId architecture-dependent CPU IDs
 168  *    which includes CPU IDs for present and possible to hotplug CPUs.
 169  *    Caller is responsible for freeing returned list.
 170  * @get_default_cpu_node_id:
 171  *    returns default board specific node_id value for CPU slot specified by
 172  *    index @idx in @ms->possible_cpus[]
 173  * @has_hotpluggable_cpus:
 174  *    If true, board supports CPUs creation with -device/device_add.
 175  * @default_cpu_type:
 176  *    specifies default CPU_TYPE, which will be used for parsing target
 177  *    specific features and for creating CPUs if CPU name wasn't provided
 178  *    explicitly at CLI
 179  * @minimum_page_bits:
 180  *    If non-zero, the board promises never to create a CPU with a page size
 181  *    smaller than this, so QEMU can use a more efficient larger page
 182  *    size than the target architecture's minimum. (Attempting to create
 183  *    such a CPU will fail.) Note that changing this is a migration
 184  *    compatibility break for the machine.
 185  * @ignore_memory_transaction_failures:
 186  *    If this is flag is true then the CPU will ignore memory transaction
 187  *    failures which should cause the CPU to take an exception due to an
 188  *    access to an unassigned physical address; the transaction will instead
 189  *    return zero (for a read) or be ignored (for a write). This should be
 190  *    set only by legacy board models which rely on the old RAZ/WI behaviour
 191  *    for handling devices that QEMU does not yet model. New board models
 192  *    should instead use "unimplemented-device" for all memory ranges where
 193  *    the guest will attempt to probe for a device that QEMU doesn't
 194  *    implement and a stub device is required.
 195  * @kvm_type:
 196  *    Return the type of KVM corresponding to the kvm-type string option or
 197  *    computed based on other criteria such as the host kernel capabilities.
 198  *    kvm-type may be NULL if it is not needed.
 199  * @numa_mem_supported:
 200  *    true if '--numa node.mem' option is supported and false otherwise
 201  * @hotplug_allowed:
 202  *    If the hook is provided, then it'll be called for each device
 203  *    hotplug to check whether the device hotplug is allowed.  Return
 204  *    true to grant allowance or false to reject the hotplug.  When
 205  *    false is returned, an error must be set to show the reason of
 206  *    the rejection.  If the hook is not provided, all hotplug will be
 207  *    allowed.
 208  * @default_ram_id:
 209  *    Specifies inital RAM MemoryRegion name to be used for default backend
 210  *    creation if user explicitly hasn't specified backend with "memory-backend"
 211  *    property.
 212  *    It also will be used as a way to optin into "-m" option support.
 213  *    If it's not set by board, '-m' will be ignored and generic code will
 214  *    not create default RAM MemoryRegion.
 215  * @fixup_ram_size:
 216  *    Amends user provided ram size (with -m option) using machine
 217  *    specific algorithm. To be used by old machine types for compat
 218  *    purposes only.
 219  *    Applies only to default memory backend, i.e., explicit memory backend
 220  *    wasn't used.
 221  */
 222 struct MachineClass {
 223     /*< private >*/
 224     ObjectClass parent_class;
 225     /*< public >*/
 226
 227     const char *family; /* NULL iff @name identifies a standalone machtype */
 228     char *name;
 229     const char *alias;
 230     const char *desc;
 231     const char *deprecation_reason;
 232
 233     void (*init)(MachineState *state);
 234     void (*reset)(MachineState *state);
 235     void (*wakeup)(MachineState *state);
 236     int (*kvm_type)(MachineState *machine, const char *arg);
 237
 238     BlockInterfaceType block_default_type;
 239     int units_per_default_bus;
 240     int max_cpus;
 241     int min_cpus;
 242     int default_cpus;
 243     unsigned int no_serial:1,
 244         no_parallel:1,
 245         no_floppy:1,
 246         no_cdrom:1,
 247         no_sdcard:1,
 248         pci_allow_0_address:1,
 249         legacy_fw_cfg_order:1;
 250     bool is_default;
 251     const char *default_machine_opts;
 252     const char *default_boot_order;
 253     const char *default_display;
 254     GPtrArray *compat_props;
 255     const char *hw_version;
 256     ram_addr_t default_ram_size;
 257     const char *default_cpu_type;
 258     bool default_kernel_irqchip_split;
 259     bool option_rom_has_mr;
 260     bool rom_file_has_mr;
 261     int minimum_page_bits;
 262     bool has_hotpluggable_cpus;
 263     bool ignore_memory_transaction_failures;
 264     int numa_mem_align_shift;
 265     const char **valid_cpu_types;
 266     strList *allowed_dynamic_sysbus_devices;
 267     bool auto_enable_numa_with_memhp;
 268     bool auto_enable_numa_with_memdev;
 269     bool ignore_boot_device_suffixes;
 270     bool smbus_no_migration_support;
 271     bool nvdimm_supported;
 272     bool cxl_supported;
 273     bool numa_mem_supported;
 274     bool auto_enable_numa;
 275     SMPCompatProps smp_props;
 276     const char *default_ram_id;
 277
 278     HotplugHandler *(*get_hotplug_handler)(MachineState *machine,
 279                                            DeviceState *dev);
 280     bool (*hotplug_allowed)(MachineState *state, DeviceState *dev,
 281                             Error **errp);
 282     CpuInstanceProperties (*cpu_index_to_instance_props)(MachineState *machine,
 283                                                          unsigned cpu_index);
 284     const CPUArchIdList *(*possible_cpu_arch_ids)(MachineState *machine);
 285     int64_t (*get_default_cpu_node_id)(const MachineState *ms, int idx);
 286     ram_addr_t (*fixup_ram_size)(ram_addr_t size);
 287 };
 288
 289 /**
 290  * DeviceMemoryState:
 291  * @base: address in guest physical address space where the memory
 292  * address space for memory devices starts
 293  * @mr: address space container for memory devices
 294  */
 295 typedef struct DeviceMemoryState {
 296     hwaddr base;
 297     MemoryRegion mr;
 298 } DeviceMemoryState;
 299
 300 /**
 301  * CpuTopology:
 302  * @cpus: the number of present logical processors on the machine
 303  * @sockets: the number of sockets on the machine
 304  * @dies: the number of dies in one socket
 305  * @clusters: the number of clusters in one die
 306  * @cores: the number of cores in one cluster
 307  * @threads: the number of threads in one core
 308  * @max_cpus: the maximum number of logical processors on the machine
 309  */
 310 typedef struct CpuTopology {
 311     unsigned int cpus;
 312     unsigned int sockets;
 313     unsigned int dies;
 314     unsigned int clusters;
 315     unsigned int cores;
 316     unsigned int threads;
 317     unsigned int max_cpus;
 318 } CpuTopology;
 319
 320 /**
 321  * MachineState:
 322  */
 323 struct MachineState {
 324     /*< private >*/
 325     Object parent_obj;
 326
 327     /*< public >*/
 328
 329     void *fdt;
 330     char *dtb;
 331     char *dumpdtb;
 332     int phandle_start;
 333     char *dt_compatible;
 334     bool dump_guest_core;
 335     bool mem_merge;
 336     bool usb;
 337     bool usb_disabled;
 338     char *firmware;
 339     bool iommu;
 340     bool suppress_vmdesc;
 341     bool enable_graphics;
 342     ConfidentialGuestSupport *cgs;
 343     HostMemoryBackend *memdev;
 344     /*
 345      * convenience alias to ram_memdev_id backend memory region
 346      * or to numa container memory region
 347      */
 348     MemoryRegion *ram;
 349     DeviceMemoryState *device_memory;
 350
 351     ram_addr_t ram_size;
 352     ram_addr_t maxram_size;
 353     uint64_t   ram_slots;
 354     BootConfiguration boot_config;
 355     char *kernel_filename;
 356     char *kernel_cmdline;
 357     char *initrd_filename;
 358     const char *cpu_type;
 359     AccelState *accelerator;
 360     CPUArchIdList *possible_cpus;
 361     CpuTopology smp;
 362     struct NVDIMMState *nvdimms_state;
 363     struct CXLState *cxl_devices_state;
 364     struct NumaState *numa_state;
 365 };
 366
 367 #define DEFINE_MACHINE(namestr, machine_initfn) \
 368     static void machine_initfn##_class_init(ObjectClass *oc, void *data) \
 369     { \
 370         MachineClass *mc = MACHINE_CLASS(oc); \
 371         machine_initfn(mc); \
 372     } \
 373     static const TypeInfo machine_initfn##_typeinfo = { \
 374         .name       = MACHINE_TYPE_NAME(namestr), \
 375         .parent     = TYPE_MACHINE, \
 376         .class_init = machine_initfn##_class_init, \
 377     }; \
 378     static void machine_initfn##_register_types(void) \
 379     { \
 380         type_register_static(&machine_initfn##_typeinfo); \
 381     } \
 382     type_init(machine_initfn##_register_types)
 383
 384 extern GlobalProperty hw_compat_7_0[];
 385 extern const size_t hw_compat_7_0_len;
 386
 387 extern GlobalProperty hw_compat_6_2[];
 388 extern const size_t hw_compat_6_2_len;
 389
 390 extern GlobalProperty hw_compat_6_1[];
 391 extern const size_t hw_compat_6_1_len;
 392
 393 extern GlobalProperty hw_compat_6_0[];
 394 extern const size_t hw_compat_6_0_len;
 395
 396 extern GlobalProperty hw_compat_5_2[];
 397 extern const size_t hw_compat_5_2_len;
 398
 399 extern GlobalProperty hw_compat_5_1[];
 400 extern const size_t hw_compat_5_1_len;
 401
 402 extern GlobalProperty hw_compat_5_0[];
 403 extern const size_t hw_compat_5_0_len;
 404
 405 extern GlobalProperty hw_compat_4_2[];
 406 extern const size_t hw_compat_4_2_len;
 407
 408 extern GlobalProperty hw_compat_4_1[];
 409 extern const size_t hw_compat_4_1_len;
 410
 411 extern GlobalProperty hw_compat_4_0[];
 412 extern const size_t hw_compat_4_0_len;
 413
 414 extern GlobalProperty hw_compat_3_1[];
 415 extern const size_t hw_compat_3_1_len;
 416
 417 extern GlobalProperty hw_compat_3_0[];
 418 extern const size_t hw_compat_3_0_len;
 419
 420 extern GlobalProperty hw_compat_2_12[];
 421 extern const size_t hw_compat_2_12_len;
 422
 423 extern GlobalProperty hw_compat_2_11[];
 424 extern const size_t hw_compat_2_11_len;
 425
 426 extern GlobalProperty hw_compat_2_10[];
 427 extern const size_t hw_compat_2_10_len;
 428
 429 extern GlobalProperty hw_compat_2_9[];
 430 extern const size_t hw_compat_2_9_len;
 431
 432 extern GlobalProperty hw_compat_2_8[];
 433 extern const size_t hw_compat_2_8_len;
 434
 435 extern GlobalProperty hw_compat_2_7[];
 436 extern const size_t hw_compat_2_7_len;
 437
 438 extern GlobalProperty hw_compat_2_6[];
 439 extern const size_t hw_compat_2_6_len;
 440
 441 extern GlobalProperty hw_compat_2_5[];
 442 extern const size_t hw_compat_2_5_len;
 443
 444 extern GlobalProperty hw_compat_2_4[];
 445 extern const size_t hw_compat_2_4_len;
 446
 447 extern GlobalProperty hw_compat_2_3[];
 448 extern const size_t hw_compat_2_3_len;
 449
 450 extern GlobalProperty hw_compat_2_2[];
 451 extern const size_t hw_compat_2_2_len;
 452
 453 extern GlobalProperty hw_compat_2_1[];
 454 extern const size_t hw_compat_2_1_len;
 455
 456 #endif