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