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 "sysemu/blockdev.h"
   7 #include "sysemu/accel.h"
   8 #include "hw/qdev.h"
   9 #include "qom/object.h"
  10 #include "qom/cpu.h"
  11
  12 /**
  13  * memory_region_allocate_system_memory - Allocate a board's main memory
  14  * @mr: the #MemoryRegion to be initialized
  15  * @owner: the object that tracks the region's reference count
  16  * @name: name of the memory region
  17  * @ram_size: size of the region in bytes
  18  *
  19  * This function allocates the main memory for a board model, and
  20  * initializes @mr appropriately. It also arranges for the memory
  21  * to be migrated (by calling vmstate_register_ram_global()).
  22  *
  23  * Memory allocated via this function will be backed with the memory
  24  * backend the user provided using "-mem-path" or "-numa node,memdev=..."
  25  * if appropriate; this is typically used to cause host huge pages to be
  26  * used. This function should therefore be called by a board exactly once,
  27  * for the primary or largest RAM area it implements.
  28  *
  29  * For boards where the major RAM is split into two parts in the memory
  30  * map, you can deal with this by calling memory_region_allocate_system_memory()
  31  * once to get a MemoryRegion with enough RAM for both parts, and then
  32  * creating alias MemoryRegions via memory_region_init_alias() which
  33  * alias into different parts of the RAM MemoryRegion and can be mapped
  34  * into the memory map in the appropriate places.
  35  *
  36  * Smaller pieces of memory (display RAM, static RAMs, etc) don't need
  37  * to be backed via the -mem-path memory backend and can simply
  38  * be created via memory_region_allocate_aux_memory() or
  39  * memory_region_init_ram().
  40  */
  41 void memory_region_allocate_system_memory(MemoryRegion *mr, Object *owner,
  42                                           const char *name,
  43                                           uint64_t ram_size);
  44
  45 #define TYPE_MACHINE_SUFFIX "-machine"
  46
  47 /* Machine class name that needs to be used for class-name-based machine
  48  * type lookup to work.
  49  */
  50 #define MACHINE_TYPE_NAME(machinename) (machinename TYPE_MACHINE_SUFFIX)
  51
  52 #define TYPE_MACHINE "machine"
  53 #undef MACHINE  /* BSD defines it and QEMU does not use it */
  54 #define MACHINE(obj) \
  55     OBJECT_CHECK(MachineState, (obj), TYPE_MACHINE)
  56 #define MACHINE_GET_CLASS(obj) \
  57     OBJECT_GET_CLASS(MachineClass, (obj), TYPE_MACHINE)
  58 #define MACHINE_CLASS(klass) \
  59     OBJECT_CLASS_CHECK(MachineClass, (klass), TYPE_MACHINE)
  60
  61 MachineClass *find_default_machine(void);
  62 extern MachineState *current_machine;
  63
  64 void machine_run_board_init(MachineState *machine);
  65 bool machine_usb(MachineState *machine);
  66 bool machine_kernel_irqchip_allowed(MachineState *machine);
  67 bool machine_kernel_irqchip_required(MachineState *machine);
  68 bool machine_kernel_irqchip_split(MachineState *machine);
  69 int machine_kvm_shadow_mem(MachineState *machine);
  70 int machine_phandle_start(MachineState *machine);
  71 bool machine_dump_guest_core(MachineState *machine);
  72 bool machine_mem_merge(MachineState *machine);
  73 void machine_register_compat_props(MachineState *machine);
  74 HotpluggableCPUList *machine_query_hotpluggable_cpus(MachineState *machine);
  75 void machine_set_cpu_numa_node(MachineState *machine,
  76                                const CpuInstanceProperties *props,
  77                                Error **errp);
  78
  79 void machine_class_allow_dynamic_sysbus_dev(MachineClass *mc, const char *type);
  80
  81
  82 /**
  83  * CPUArchId:
  84  * @arch_id - architecture-dependent CPU ID of present or possible CPU
  85  * @cpu - pointer to corresponding CPU object if it's present on NULL otherwise
  86  * @type - QOM class name of possible @cpu object
  87  * @props - CPU object properties, initialized by board
  88  * #vcpus_count - number of threads provided by @cpu object
  89  */
  90 typedef struct {
  91     uint64_t arch_id;
  92     int64_t vcpus_count;
  93     CpuInstanceProperties props;
  94     Object *cpu;
  95     const char *type;
  96 } CPUArchId;
  97
  98 /**
  99  * CPUArchIdList:
 100  * @len - number of @CPUArchId items in @cpus array
 101  * @cpus - array of present or possible CPUs for current machine configuration
 102  */
 103 typedef struct {
 104     int len;
 105     CPUArchId cpus[0];
 106 } CPUArchIdList;
 107
 108 /**
 109  * MachineClass:
 110  * @max_cpus: maximum number of CPUs supported. Default: 1
 111  * @min_cpus: minimum number of CPUs supported. Default: 1
 112  * @default_cpus: number of CPUs instantiated if none are specified. Default: 1
 113  * @get_hotplug_handler: this function is called during bus-less
 114  *    device hotplug. If defined it returns pointer to an instance
 115  *    of HotplugHandler object, which handles hotplug operation
 116  *    for a given @dev. It may return NULL if @dev doesn't require
 117  *    any actions to be performed by hotplug handler.
 118  * @cpu_index_to_instance_props:
 119  *    used to provide @cpu_index to socket/core/thread number mapping, allowing
 120  *    legacy code to perform maping from cpu_index to topology properties
 121  *    Returns: tuple of socket/core/thread ids given cpu_index belongs to.
 122  *    used to provide @cpu_index to socket number mapping, allowing
 123  *    a machine to group CPU threads belonging to the same socket/package
 124  *    Returns: socket number given cpu_index belongs to.
 125  * @hw_version:
 126  *    Value of QEMU_VERSION when the machine was added to QEMU.
 127  *    Set only by old machines because they need to keep
 128  *    compatibility on code that exposed QEMU_VERSION to guests in
 129  *    the past (and now use qemu_hw_version()).
 130  * @possible_cpu_arch_ids:
 131  *    Returns an array of @CPUArchId architecture-dependent CPU IDs
 132  *    which includes CPU IDs for present and possible to hotplug CPUs.
 133  *    Caller is responsible for freeing returned list.
 134  * @get_default_cpu_node_id:
 135  *    returns default board specific node_id value for CPU slot specified by
 136  *    index @idx in @ms->possible_cpus[]
 137  * @has_hotpluggable_cpus:
 138  *    If true, board supports CPUs creation with -device/device_add.
 139  * @default_cpu_type:
 140  *    specifies default CPU_TYPE, which will be used for parsing target
 141  *    specific features and for creating CPUs if CPU name wasn't provided
 142  *    explicitly at CLI
 143  * @minimum_page_bits:
 144  *    If non-zero, the board promises never to create a CPU with a page size
 145  *    smaller than this, so QEMU can use a more efficient larger page
 146  *    size than the target architecture's minimum. (Attempting to create
 147  *    such a CPU will fail.) Note that changing this is a migration
 148  *    compatibility break for the machine.
 149  * @ignore_memory_transaction_failures:
 150  *    If this is flag is true then the CPU will ignore memory transaction
 151  *    failures which should cause the CPU to take an exception due to an
 152  *    access to an unassigned physical address; the transaction will instead
 153  *    return zero (for a read) or be ignored (for a write). This should be
 154  *    set only by legacy board models which rely on the old RAZ/WI behaviour
 155  *    for handling devices that QEMU does not yet model. New board models
 156  *    should instead use "unimplemented-device" for all memory ranges where
 157  *    the guest will attempt to probe for a device that QEMU doesn't
 158  *    implement and a stub device is required.
 159  */
 160 struct MachineClass {
 161     /*< private >*/
 162     ObjectClass parent_class;
 163     /*< public >*/
 164
 165     const char *family; /* NULL iff @name identifies a standalone machtype */
 166     char *name;
 167     const char *alias;
 168     const char *desc;
 169
 170     void (*init)(MachineState *state);
 171     void (*reset)(void);
 172     void (*hot_add_cpu)(const int64_t id, Error **errp);
 173     int (*kvm_type)(const char *arg);
 174
 175     BlockInterfaceType block_default_type;
 176     int units_per_default_bus;
 177     int max_cpus;
 178     int min_cpus;
 179     int default_cpus;
 180     unsigned int no_serial:1,
 181         no_parallel:1,
 182         use_virtcon:1,
 183         no_floppy:1,
 184         no_cdrom:1,
 185         no_sdcard:1,
 186         pci_allow_0_address:1,
 187         legacy_fw_cfg_order:1;
 188     int is_default;
 189     const char *default_machine_opts;
 190     const char *default_boot_order;
 191     const char *default_display;
 192     GArray *compat_props;
 193     const char *hw_version;
 194     ram_addr_t default_ram_size;
 195     const char *default_cpu_type;
 196     bool option_rom_has_mr;
 197     bool rom_file_has_mr;
 198     int minimum_page_bits;
 199     bool has_hotpluggable_cpus;
 200     bool ignore_memory_transaction_failures;
 201     int numa_mem_align_shift;
 202     const char **valid_cpu_types;
 203     strList *allowed_dynamic_sysbus_devices;
 204     bool auto_enable_numa_with_memhp;
 205     void (*numa_auto_assign_ram)(MachineClass *mc, NodeInfo *nodes,
 206                                  int nb_nodes, ram_addr_t size);
 207
 208     HotplugHandler *(*get_hotplug_handler)(MachineState *machine,
 209                                            DeviceState *dev);
 210     CpuInstanceProperties (*cpu_index_to_instance_props)(MachineState *machine,
 211                                                          unsigned cpu_index);
 212     const CPUArchIdList *(*possible_cpu_arch_ids)(MachineState *machine);
 213     int64_t (*get_default_cpu_node_id)(const MachineState *ms, int idx);
 214 };
 215
 216 /**
 217  * DeviceMemoryState:
 218  * @base: address in guest physical address space where the memory
 219  * address space for memory devices starts
 220  * @mr: address space container for memory devices
 221  */
 222 typedef struct DeviceMemoryState {
 223     hwaddr base;
 224     MemoryRegion mr;
 225 } DeviceMemoryState;
 226
 227 /**
 228  * MachineState:
 229  */
 230 struct MachineState {
 231     /*< private >*/
 232     Object parent_obj;
 233     Notifier sysbus_notifier;
 234
 235     /*< public >*/
 236
 237     char *accel;
 238     bool kernel_irqchip_allowed;
 239     bool kernel_irqchip_required;
 240     bool kernel_irqchip_split;
 241     int kvm_shadow_mem;
 242     char *dtb;
 243     char *dumpdtb;
 244     int phandle_start;
 245     char *dt_compatible;
 246     bool dump_guest_core;
 247     bool mem_merge;
 248     bool usb;
 249     bool usb_disabled;
 250     bool igd_gfx_passthru;
 251     char *firmware;
 252     bool iommu;
 253     bool suppress_vmdesc;
 254     bool enforce_config_section;
 255     bool enable_graphics;
 256     char *memory_encryption;
 257     DeviceMemoryState *device_memory;
 258
 259     ram_addr_t ram_size;
 260     ram_addr_t maxram_size;
 261     uint64_t   ram_slots;
 262     const char *boot_order;
 263     char *kernel_filename;
 264     char *kernel_cmdline;
 265     char *initrd_filename;
 266     const char *cpu_type;
 267     AccelState *accelerator;
 268     CPUArchIdList *possible_cpus;
 269 };
 270
 271 #define DEFINE_MACHINE(namestr, machine_initfn) \
 272     static void machine_initfn##_class_init(ObjectClass *oc, void *data) \
 273     { \
 274         MachineClass *mc = MACHINE_CLASS(oc); \
 275         machine_initfn(mc); \
 276     } \
 277     static const TypeInfo machine_initfn##_typeinfo = { \
 278         .name       = MACHINE_TYPE_NAME(namestr), \
 279         .parent     = TYPE_MACHINE, \
 280         .class_init = machine_initfn##_class_init, \
 281     }; \
 282     static void machine_initfn##_register_types(void) \
 283     { \
 284         type_register_static(&machine_initfn##_typeinfo); \
 285     } \
 286     type_init(machine_initfn##_register_types)
 287
 288 #define SET_MACHINE_COMPAT(m, COMPAT) \
 289     do {                              \
 290         int i;                        \
 291         static GlobalProperty props[] = {       \
 292             COMPAT                              \
 293             { /* end of list */ }               \
 294         };                                      \
 295         if (!m->compat_props) { \
 296             m->compat_props = g_array_new(false, false, sizeof(void *)); \
 297         } \
 298         for (i = 0; props[i].driver != NULL; i++) {    \
 299             GlobalProperty *prop = &props[i];          \
 300             g_array_append_val(m->compat_props, prop); \
 301         }                                              \
 302     } while (0)
 303
 304 #endif