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