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