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_init_ram(). 39 */ 40 void memory_region_allocate_system_memory(MemoryRegion *mr, Object *owner, 41 const char *name, 42 uint64_t ram_size); 43 44 #define TYPE_MACHINE_SUFFIX "-machine" 45 46 /* Machine class name that needs to be used for class-name-based machine 47 * type lookup to work. 48 */ 49 #define MACHINE_TYPE_NAME(machinename) (machinename TYPE_MACHINE_SUFFIX) 50 51 #define TYPE_MACHINE "machine" 52 #undef MACHINE /* BSD defines it and QEMU does not use it */ 53 #define MACHINE(obj) \ 54 OBJECT_CHECK(MachineState, (obj), TYPE_MACHINE) 55 #define MACHINE_GET_CLASS(obj) \ 56 OBJECT_GET_CLASS(MachineClass, (obj), TYPE_MACHINE) 57 #define MACHINE_CLASS(klass) \ 58 OBJECT_CLASS_CHECK(MachineClass, (klass), TYPE_MACHINE) 59 60 extern MachineState *current_machine; 61 62 void machine_run_board_init(MachineState *machine); 63 bool machine_usb(MachineState *machine); 64 bool machine_kernel_irqchip_allowed(MachineState *machine); 65 bool machine_kernel_irqchip_required(MachineState *machine); 66 bool machine_kernel_irqchip_split(MachineState *machine); 67 int machine_kvm_shadow_mem(MachineState *machine); 68 int machine_phandle_start(MachineState *machine); 69 bool machine_dump_guest_core(MachineState *machine); 70 bool machine_mem_merge(MachineState *machine); 71 HotpluggableCPUList *machine_query_hotpluggable_cpus(MachineState *machine); 72 void machine_set_cpu_numa_node(MachineState *machine, 73 const CpuInstanceProperties *props, 74 Error **errp); 75 76 void machine_class_allow_dynamic_sysbus_dev(MachineClass *mc, const char *type); 77 78 79 /** 80 * CPUArchId: 81 * @arch_id - architecture-dependent CPU ID of present or possible CPU 82 * @cpu - pointer to corresponding CPU object if it's present on NULL otherwise 83 * @type - QOM class name of possible @cpu object 84 * @props - CPU object properties, initialized by board 85 * #vcpus_count - number of threads provided by @cpu object 86 */ 87 typedef struct { 88 uint64_t arch_id; 89 int64_t vcpus_count; 90 CpuInstanceProperties props; 91 Object *cpu; 92 const char *type; 93 } CPUArchId; 94 95 /** 96 * CPUArchIdList: 97 * @len - number of @CPUArchId items in @cpus array 98 * @cpus - array of present or possible CPUs for current machine configuration 99 */ 100 typedef struct { 101 int len; 102 CPUArchId cpus[0]; 103 } CPUArchIdList; 104 105 /** 106 * MachineClass: 107 * @deprecation_reason: If set, the machine is marked as deprecated. The 108 * string should provide some clear information about what to use instead. 109 * @max_cpus: maximum number of CPUs supported. Default: 1 110 * @min_cpus: minimum number of CPUs supported. Default: 1 111 * @default_cpus: number of CPUs instantiated if none are specified. Default: 1 112 * @get_hotplug_handler: this function is called during bus-less 113 * device hotplug. If defined it returns pointer to an instance 114 * of HotplugHandler object, which handles hotplug operation 115 * for a given @dev. It may return NULL if @dev doesn't require 116 * any actions to be performed by hotplug handler. 117 * @cpu_index_to_instance_props: 118 * used to provide @cpu_index to socket/core/thread number mapping, allowing 119 * legacy code to perform maping from cpu_index to topology properties 120 * Returns: tuple of socket/core/thread ids given cpu_index belongs to. 121 * used to provide @cpu_index to socket number mapping, allowing 122 * a machine to group CPU threads belonging to the same socket/package 123 * Returns: socket number given cpu_index belongs to. 124 * @hw_version: 125 * Value of QEMU_VERSION when the machine was added to QEMU. 126 * Set only by old machines because they need to keep 127 * compatibility on code that exposed QEMU_VERSION to guests in 128 * the past (and now use qemu_hw_version()). 129 * @possible_cpu_arch_ids: 130 * Returns an array of @CPUArchId architecture-dependent CPU IDs 131 * which includes CPU IDs for present and possible to hotplug CPUs. 132 * Caller is responsible for freeing returned list. 133 * @get_default_cpu_node_id: 134 * returns default board specific node_id value for CPU slot specified by 135 * index @idx in @ms->possible_cpus[] 136 * @has_hotpluggable_cpus: 137 * If true, board supports CPUs creation with -device/device_add. 138 * @default_cpu_type: 139 * specifies default CPU_TYPE, which will be used for parsing target 140 * specific features and for creating CPUs if CPU name wasn't provided 141 * explicitly at CLI 142 * @minimum_page_bits: 143 * If non-zero, the board promises never to create a CPU with a page size 144 * smaller than this, so QEMU can use a more efficient larger page 145 * size than the target architecture's minimum. (Attempting to create 146 * such a CPU will fail.) Note that changing this is a migration 147 * compatibility break for the machine. 148 * @ignore_memory_transaction_failures: 149 * If this is flag is true then the CPU will ignore memory transaction 150 * failures which should cause the CPU to take an exception due to an 151 * access to an unassigned physical address; the transaction will instead 152 * return zero (for a read) or be ignored (for a write). This should be 153 * set only by legacy board models which rely on the old RAZ/WI behaviour 154 * for handling devices that QEMU does not yet model. New board models 155 * should instead use "unimplemented-device" for all memory ranges where 156 * the guest will attempt to probe for a device that QEMU doesn't 157 * implement and a stub device is required. 158 * @kvm_type: 159 * Return the type of KVM corresponding to the kvm-type string option or 160 * computed based on other criteria such as the host kernel capabilities. 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)(void); 175 void (*hot_add_cpu)(const int64_t id, Error **errp); 176 int (*kvm_type)(MachineState *machine, const char *arg); 177 178 BlockInterfaceType block_default_type; 179 int units_per_default_bus; 180 int max_cpus; 181 int min_cpus; 182 int default_cpus; 183 unsigned int no_serial:1, 184 no_parallel:1, 185 no_floppy:1, 186 no_cdrom:1, 187 no_sdcard:1, 188 pci_allow_0_address:1, 189 legacy_fw_cfg_order:1; 190 int is_default; 191 const char *default_machine_opts; 192 const char *default_boot_order; 193 const char *default_display; 194 GPtrArray *compat_props; 195 const char *hw_version; 196 ram_addr_t default_ram_size; 197 const char *default_cpu_type; 198 bool default_kernel_irqchip_split; 199 bool option_rom_has_mr; 200 bool rom_file_has_mr; 201 int minimum_page_bits; 202 bool has_hotpluggable_cpus; 203 bool ignore_memory_transaction_failures; 204 int numa_mem_align_shift; 205 const char **valid_cpu_types; 206 strList *allowed_dynamic_sysbus_devices; 207 bool auto_enable_numa_with_memhp; 208 void (*numa_auto_assign_ram)(MachineClass *mc, NodeInfo *nodes, 209 int nb_nodes, ram_addr_t size); 210 bool ignore_boot_device_suffixes; 211 bool smbus_no_migration_support; 212 bool nvdimm_supported; 213 214 HotplugHandler *(*get_hotplug_handler)(MachineState *machine, 215 DeviceState *dev); 216 CpuInstanceProperties (*cpu_index_to_instance_props)(MachineState *machine, 217 unsigned cpu_index); 218 const CPUArchIdList *(*possible_cpu_arch_ids)(MachineState *machine); 219 int64_t (*get_default_cpu_node_id)(const MachineState *ms, int idx); 220 }; 221 222 /** 223 * DeviceMemoryState: 224 * @base: address in guest physical address space where the memory 225 * address space for memory devices starts 226 * @mr: address space container for memory devices 227 */ 228 typedef struct DeviceMemoryState { 229 hwaddr base; 230 MemoryRegion mr; 231 } DeviceMemoryState; 232 233 /** 234 * MachineState: 235 */ 236 struct MachineState { 237 /*< private >*/ 238 Object parent_obj; 239 Notifier sysbus_notifier; 240 241 /*< public >*/ 242 243 char *accel; 244 bool kernel_irqchip_allowed; 245 bool kernel_irqchip_required; 246 bool kernel_irqchip_split; 247 int kvm_shadow_mem; 248 char *dtb; 249 char *dumpdtb; 250 int phandle_start; 251 char *dt_compatible; 252 bool dump_guest_core; 253 bool mem_merge; 254 bool usb; 255 bool usb_disabled; 256 bool igd_gfx_passthru; 257 char *firmware; 258 bool iommu; 259 bool suppress_vmdesc; 260 bool enforce_config_section; 261 bool enable_graphics; 262 char *memory_encryption; 263 DeviceMemoryState *device_memory; 264 265 ram_addr_t ram_size; 266 ram_addr_t maxram_size; 267 uint64_t ram_slots; 268 const char *boot_order; 269 char *kernel_filename; 270 char *kernel_cmdline; 271 char *initrd_filename; 272 const char *cpu_type; 273 AccelState *accelerator; 274 CPUArchIdList *possible_cpus; 275 struct NVDIMMState *nvdimms_state; 276 }; 277 278 #define DEFINE_MACHINE(namestr, machine_initfn) \ 279 static void machine_initfn##_class_init(ObjectClass *oc, void *data) \ 280 { \ 281 MachineClass *mc = MACHINE_CLASS(oc); \ 282 machine_initfn(mc); \ 283 } \ 284 static const TypeInfo machine_initfn##_typeinfo = { \ 285 .name = MACHINE_TYPE_NAME(namestr), \ 286 .parent = TYPE_MACHINE, \ 287 .class_init = machine_initfn##_class_init, \ 288 }; \ 289 static void machine_initfn##_register_types(void) \ 290 { \ 291 type_register_static(&machine_initfn##_typeinfo); \ 292 } \ 293 type_init(machine_initfn##_register_types) 294 295 extern GlobalProperty hw_compat_4_0[]; 296 extern const size_t hw_compat_4_0_len; 297 298 extern GlobalProperty hw_compat_3_1[]; 299 extern const size_t hw_compat_3_1_len; 300 301 extern GlobalProperty hw_compat_3_0[]; 302 extern const size_t hw_compat_3_0_len; 303 304 extern GlobalProperty hw_compat_2_12[]; 305 extern const size_t hw_compat_2_12_len; 306 307 extern GlobalProperty hw_compat_2_11[]; 308 extern const size_t hw_compat_2_11_len; 309 310 extern GlobalProperty hw_compat_2_10[]; 311 extern const size_t hw_compat_2_10_len; 312 313 extern GlobalProperty hw_compat_2_9[]; 314 extern const size_t hw_compat_2_9_len; 315 316 extern GlobalProperty hw_compat_2_8[]; 317 extern const size_t hw_compat_2_8_len; 318 319 extern GlobalProperty hw_compat_2_7[]; 320 extern const size_t hw_compat_2_7_len; 321 322 extern GlobalProperty hw_compat_2_6[]; 323 extern const size_t hw_compat_2_6_len; 324 325 extern GlobalProperty hw_compat_2_5[]; 326 extern const size_t hw_compat_2_5_len; 327 328 extern GlobalProperty hw_compat_2_4[]; 329 extern const size_t hw_compat_2_4_len; 330 331 extern GlobalProperty hw_compat_2_3[]; 332 extern const size_t hw_compat_2_3_len; 333 334 extern GlobalProperty hw_compat_2_2[]; 335 extern const size_t hw_compat_2_2_len; 336 337 extern GlobalProperty hw_compat_2_1[]; 338 extern const size_t hw_compat_2_1_len; 339 340 #endif 341