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