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