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 void memory_region_allocate_system_memory(MemoryRegion *mr, Object *owner,
  13                                           const char *name,
  14                                           uint64_t ram_size);
  15
  16 #define TYPE_MACHINE_SUFFIX "-machine"
  17
  18 /* Machine class name that needs to be used for class-name-based machine
  19  * type lookup to work.
  20  */
  21 #define MACHINE_TYPE_NAME(machinename) (machinename TYPE_MACHINE_SUFFIX)
  22
  23 #define TYPE_MACHINE "machine"
  24 #undef MACHINE  /* BSD defines it and QEMU does not use it */
  25 #define MACHINE(obj) \
  26     OBJECT_CHECK(MachineState, (obj), TYPE_MACHINE)
  27 #define MACHINE_GET_CLASS(obj) \
  28     OBJECT_GET_CLASS(MachineClass, (obj), TYPE_MACHINE)
  29 #define MACHINE_CLASS(klass) \
  30     OBJECT_CLASS_CHECK(MachineClass, (klass), TYPE_MACHINE)
  31
  32 MachineClass *find_default_machine(void);
  33 extern MachineState *current_machine;
  34
  35 bool machine_usb(MachineState *machine);
  36 bool machine_kernel_irqchip_allowed(MachineState *machine);
  37 bool machine_kernel_irqchip_required(MachineState *machine);
  38 bool machine_kernel_irqchip_split(MachineState *machine);
  39 int machine_kvm_shadow_mem(MachineState *machine);
  40 int machine_phandle_start(MachineState *machine);
  41 bool machine_dump_guest_core(MachineState *machine);
  42 bool machine_mem_merge(MachineState *machine);
  43 void machine_register_compat_props(MachineState *machine);
  44 HotpluggableCPUList *machine_query_hotpluggable_cpus(MachineState *machine);
  45
  46 /**
  47  * CPUArchId:
  48  * @arch_id - architecture-dependent CPU ID of present or possible CPU
  49  * @cpu - pointer to corresponding CPU object if it's present on NULL otherwise
  50  * @props - CPU object properties, initialized by board
  51  * #vcpus_count - number of threads provided by @cpu object
  52  */
  53 typedef struct {
  54     uint64_t arch_id;
  55     int64_t vcpus_count;
  56     CpuInstanceProperties props;
  57     Object *cpu;
  58 } CPUArchId;
  59
  60 /**
  61  * CPUArchIdList:
  62  * @len - number of @CPUArchId items in @cpus array
  63  * @cpus - array of present or possible CPUs for current machine configuration
  64  */
  65 typedef struct {
  66     int len;
  67     CPUArchId cpus[0];
  68 } CPUArchIdList;
  69
  70 /**
  71  * MachineClass:
  72  * @get_hotplug_handler: this function is called during bus-less
  73  *    device hotplug. If defined it returns pointer to an instance
  74  *    of HotplugHandler object, which handles hotplug operation
  75  *    for a given @dev. It may return NULL if @dev doesn't require
  76  *    any actions to be performed by hotplug handler.
  77  * @cpu_index_to_instance_props:
  78  *    used to provide @cpu_index to socket/core/thread number mapping, allowing
  79  *    legacy code to perform maping from cpu_index to topology properties
  80  *    Returns: tuple of socket/core/thread ids given cpu_index belongs to.
  81  *    used to provide @cpu_index to socket number mapping, allowing
  82  *    a machine to group CPU threads belonging to the same socket/package
  83  *    Returns: socket number given cpu_index belongs to.
  84  * @hw_version:
  85  *    Value of QEMU_VERSION when the machine was added to QEMU.
  86  *    Set only by old machines because they need to keep
  87  *    compatibility on code that exposed QEMU_VERSION to guests in
  88  *    the past (and now use qemu_hw_version()).
  89  * @possible_cpu_arch_ids:
  90  *    Returns an array of @CPUArchId architecture-dependent CPU IDs
  91  *    which includes CPU IDs for present and possible to hotplug CPUs.
  92  *    Caller is responsible for freeing returned list.
  93  * @has_hotpluggable_cpus:
  94  *    If true, board supports CPUs creation with -device/device_add.
  95  * @minimum_page_bits:
  96  *    If non-zero, the board promises never to create a CPU with a page size
  97  *    smaller than this, so QEMU can use a more efficient larger page
  98  *    size than the target architecture's minimum. (Attempting to create
  99  *    such a CPU will fail.) Note that changing this is a migration
 100  *    compatibility break for the machine.
 101  */
 102 struct MachineClass {
 103     /*< private >*/
 104     ObjectClass parent_class;
 105     /*< public >*/
 106
 107     const char *family; /* NULL iff @name identifies a standalone machtype */
 108     char *name;
 109     const char *alias;
 110     const char *desc;
 111
 112     void (*init)(MachineState *state);
 113     void (*reset)(void);
 114     void (*hot_add_cpu)(const int64_t id, Error **errp);
 115     int (*kvm_type)(const char *arg);
 116
 117     BlockInterfaceType block_default_type;
 118     int units_per_default_bus;
 119     int max_cpus;
 120     unsigned int no_serial:1,
 121         no_parallel:1,
 122         use_virtcon:1,
 123         use_sclp:1,
 124         no_floppy:1,
 125         no_cdrom:1,
 126         no_sdcard:1,
 127         has_dynamic_sysbus:1,
 128         pci_allow_0_address:1,
 129         legacy_fw_cfg_order:1;
 130     int is_default;
 131     const char *default_machine_opts;
 132     const char *default_boot_order;
 133     const char *default_display;
 134     GArray *compat_props;
 135     const char *hw_version;
 136     ram_addr_t default_ram_size;
 137     bool option_rom_has_mr;
 138     bool rom_file_has_mr;
 139     int minimum_page_bits;
 140     bool has_hotpluggable_cpus;
 141     int numa_mem_align_shift;
 142     void (*numa_auto_assign_ram)(MachineClass *mc, NodeInfo *nodes,
 143                                  int nb_nodes, ram_addr_t size);
 144
 145     HotplugHandler *(*get_hotplug_handler)(MachineState *machine,
 146                                            DeviceState *dev);
 147     CpuInstanceProperties (*cpu_index_to_instance_props)(MachineState *machine,
 148                                                          unsigned cpu_index);
 149     const CPUArchIdList *(*possible_cpu_arch_ids)(MachineState *machine);
 150 };
 151
 152 /**
 153  * MachineState:
 154  */
 155 struct MachineState {
 156     /*< private >*/
 157     Object parent_obj;
 158     Notifier sysbus_notifier;
 159
 160     /*< public >*/
 161
 162     char *accel;
 163     bool kernel_irqchip_allowed;
 164     bool kernel_irqchip_required;
 165     bool kernel_irqchip_split;
 166     int kvm_shadow_mem;
 167     char *dtb;
 168     char *dumpdtb;
 169     int phandle_start;
 170     char *dt_compatible;
 171     bool dump_guest_core;
 172     bool mem_merge;
 173     bool usb;
 174     bool usb_disabled;
 175     bool igd_gfx_passthru;
 176     char *firmware;
 177     bool iommu;
 178     bool suppress_vmdesc;
 179     bool enforce_config_section;
 180     bool enable_graphics;
 181
 182     ram_addr_t ram_size;
 183     ram_addr_t maxram_size;
 184     uint64_t   ram_slots;
 185     const char *boot_order;
 186     char *kernel_filename;
 187     char *kernel_cmdline;
 188     char *initrd_filename;
 189     const char *cpu_model;
 190     AccelState *accelerator;
 191     CPUArchIdList *possible_cpus;
 192 };
 193
 194 #define DEFINE_MACHINE(namestr, machine_initfn) \
 195     static void machine_initfn##_class_init(ObjectClass *oc, void *data) \
 196     { \
 197         MachineClass *mc = MACHINE_CLASS(oc); \
 198         machine_initfn(mc); \
 199     } \
 200     static const TypeInfo machine_initfn##_typeinfo = { \
 201         .name       = MACHINE_TYPE_NAME(namestr), \
 202         .parent     = TYPE_MACHINE, \
 203         .class_init = machine_initfn##_class_init, \
 204     }; \
 205     static void machine_initfn##_register_types(void) \
 206     { \
 207         type_register_static(&machine_initfn##_typeinfo); \
 208     } \
 209     type_init(machine_initfn##_register_types)
 210
 211 #define SET_MACHINE_COMPAT(m, COMPAT) \
 212     do {                              \
 213         int i;                        \
 214         static GlobalProperty props[] = {       \
 215             COMPAT                              \
 216             { /* end of list */ }               \
 217         };                                      \
 218         if (!m->compat_props) { \
 219             m->compat_props = g_array_new(false, false, sizeof(void *)); \
 220         } \
 221         for (i = 0; props[i].driver != NULL; i++) {    \
 222             GlobalProperty *prop = &props[i];          \
 223             g_array_append_val(m->compat_props, prop); \
 224         }                                              \
 225     } while (0)
 226
 227 #endif