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/blockdev.h" 8 #include "sysemu/accel.h" 9 #include "qapi/qapi-types-machine.h" 10 #include "qemu/module.h" 11 #include "qom/object.h" 12 #include "hw/core/cpu.h" 13 14 /** 15 * memory_region_allocate_system_memory - Allocate a board's main memory 16 * @mr: the #MemoryRegion to be initialized 17 * @owner: the object that tracks the region's reference count 18 * @name: name of the memory region 19 * @ram_size: size of the region in bytes 20 * 21 * This function allocates the main memory for a board model, and 22 * initializes @mr appropriately. It also arranges for the memory 23 * to be migrated (by calling vmstate_register_ram_global()). 24 * 25 * Memory allocated via this function will be backed with the memory 26 * backend the user provided using "-mem-path" or "-numa node,memdev=..." 27 * if appropriate; this is typically used to cause host huge pages to be 28 * used. This function should therefore be called by a board exactly once, 29 * for the primary or largest RAM area it implements. 30 * 31 * For boards where the major RAM is split into two parts in the memory 32 * map, you can deal with this by calling memory_region_allocate_system_memory() 33 * once to get a MemoryRegion with enough RAM for both parts, and then 34 * creating alias MemoryRegions via memory_region_init_alias() which 35 * alias into different parts of the RAM MemoryRegion and can be mapped 36 * into the memory map in the appropriate places. 37 * 38 * Smaller pieces of memory (display RAM, static RAMs, etc) don't need 39 * to be backed via the -mem-path memory backend and can simply 40 * be created via memory_region_init_ram(). 41 */ 42 void memory_region_allocate_system_memory(MemoryRegion *mr, Object *owner, 43 const char *name, 44 uint64_t ram_size); 45 46 #define TYPE_MACHINE_SUFFIX "-machine" 47 48 /* Machine class name that needs to be used for class-name-based machine 49 * type lookup to work. 50 */ 51 #define MACHINE_TYPE_NAME(machinename) (machinename TYPE_MACHINE_SUFFIX) 52 53 #define TYPE_MACHINE "machine" 54 #undef MACHINE /* BSD defines it and QEMU does not use it */ 55 #define MACHINE(obj) \ 56 OBJECT_CHECK(MachineState, (obj), TYPE_MACHINE) 57 #define MACHINE_GET_CLASS(obj) \ 58 OBJECT_GET_CLASS(MachineClass, (obj), TYPE_MACHINE) 59 #define MACHINE_CLASS(klass) \ 60 OBJECT_CLASS_CHECK(MachineClass, (klass), TYPE_MACHINE) 61 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 HotpluggableCPUList *machine_query_hotpluggable_cpus(MachineState *machine); 74 void machine_set_cpu_numa_node(MachineState *machine, 75 const CpuInstanceProperties *props, 76 Error **errp); 77 78 void machine_class_allow_dynamic_sysbus_dev(MachineClass *mc, const char *type); 79 80 81 /** 82 * CPUArchId: 83 * @arch_id - architecture-dependent CPU ID of present or possible CPU 84 * @cpu - pointer to corresponding CPU object if it's present on NULL otherwise 85 * @type - QOM class name of possible @cpu object 86 * @props - CPU object properties, initialized by board 87 * #vcpus_count - number of threads provided by @cpu object 88 */ 89 typedef struct CPUArchId { 90 uint64_t arch_id; 91 int64_t vcpus_count; 92 CpuInstanceProperties props; 93 Object *cpu; 94 const char *type; 95 } CPUArchId; 96 97 /** 98 * CPUArchIdList: 99 * @len - number of @CPUArchId items in @cpus array 100 * @cpus - array of present or possible CPUs for current machine configuration 101 */ 102 typedef struct { 103 int len; 104 CPUArchId cpus[0]; 105 } CPUArchIdList; 106 107 /** 108 * MachineClass: 109 * @deprecation_reason: If set, the machine is marked as deprecated. The 110 * string should provide some clear information about what to use instead. 111 * @max_cpus: maximum number of CPUs supported. Default: 1 112 * @min_cpus: minimum number of CPUs supported. Default: 1 113 * @default_cpus: number of CPUs instantiated if none are specified. Default: 1 114 * @get_hotplug_handler: this function is called during bus-less 115 * device hotplug. If defined it returns pointer to an instance 116 * of HotplugHandler object, which handles hotplug operation 117 * for a given @dev. It may return NULL if @dev doesn't require 118 * any actions to be performed by hotplug handler. 119 * @cpu_index_to_instance_props: 120 * used to provide @cpu_index to socket/core/thread number mapping, allowing 121 * legacy code to perform maping from cpu_index to topology properties 122 * Returns: tuple of socket/core/thread ids given cpu_index belongs to. 123 * used to provide @cpu_index to socket number mapping, allowing 124 * a machine to group CPU threads belonging to the same socket/package 125 * Returns: socket number given cpu_index belongs to. 126 * @hw_version: 127 * Value of QEMU_VERSION when the machine was added to QEMU. 128 * Set only by old machines because they need to keep 129 * compatibility on code that exposed QEMU_VERSION to guests in 130 * the past (and now use qemu_hw_version()). 131 * @possible_cpu_arch_ids: 132 * Returns an array of @CPUArchId architecture-dependent CPU IDs 133 * which includes CPU IDs for present and possible to hotplug CPUs. 134 * Caller is responsible for freeing returned list. 135 * @get_default_cpu_node_id: 136 * returns default board specific node_id value for CPU slot specified by 137 * index @idx in @ms->possible_cpus[] 138 * @has_hotpluggable_cpus: 139 * If true, board supports CPUs creation with -device/device_add. 140 * @default_cpu_type: 141 * specifies default CPU_TYPE, which will be used for parsing target 142 * specific features and for creating CPUs if CPU name wasn't provided 143 * explicitly at CLI 144 * @minimum_page_bits: 145 * If non-zero, the board promises never to create a CPU with a page size 146 * smaller than this, so QEMU can use a more efficient larger page 147 * size than the target architecture's minimum. (Attempting to create 148 * such a CPU will fail.) Note that changing this is a migration 149 * compatibility break for the machine. 150 * @ignore_memory_transaction_failures: 151 * If this is flag is true then the CPU will ignore memory transaction 152 * failures which should cause the CPU to take an exception due to an 153 * access to an unassigned physical address; the transaction will instead 154 * return zero (for a read) or be ignored (for a write). This should be 155 * set only by legacy board models which rely on the old RAZ/WI behaviour 156 * for handling devices that QEMU does not yet model. New board models 157 * should instead use "unimplemented-device" for all memory ranges where 158 * the guest will attempt to probe for a device that QEMU doesn't 159 * implement and a stub device is required. 160 * @kvm_type: 161 * Return the type of KVM corresponding to the kvm-type string option or 162 * computed based on other criteria such as the host kernel capabilities. 163 * @numa_mem_supported: 164 * true if '--numa node.mem' option is supported and false otherwise 165 * @smp_parse: 166 * The function pointer to hook different machine specific functions for 167 * parsing "smp-opts" from QemuOpts to MachineState::CpuTopology and more 168 * machine specific topology fields, such as smp_dies for PCMachine. 169 * @hotplug_allowed: 170 * If the hook is provided, then it'll be called for each device 171 * hotplug to check whether the device hotplug is allowed. Return 172 * true to grant allowance or false to reject the hotplug. When 173 * false is returned, an error must be set to show the reason of 174 * the rejection. If the hook is not provided, all hotplug will be 175 * allowed. 176 */ 177 struct MachineClass { 178 /*< private >*/ 179 ObjectClass parent_class; 180 /*< public >*/ 181 182 const char *family; /* NULL iff @name identifies a standalone machtype */ 183 char *name; 184 const char *alias; 185 const char *desc; 186 const char *deprecation_reason; 187 188 void (*init)(MachineState *state); 189 void (*reset)(MachineState *state); 190 void (*wakeup)(MachineState *state); 191 void (*hot_add_cpu)(MachineState *state, const int64_t id, Error **errp); 192 int (*kvm_type)(MachineState *machine, const char *arg); 193 void (*smp_parse)(MachineState *ms, QemuOpts *opts); 194 195 BlockInterfaceType block_default_type; 196 int units_per_default_bus; 197 int max_cpus; 198 int min_cpus; 199 int default_cpus; 200 unsigned int no_serial:1, 201 no_parallel:1, 202 no_floppy:1, 203 no_cdrom:1, 204 no_sdcard:1, 205 pci_allow_0_address:1, 206 legacy_fw_cfg_order:1; 207 int is_default; 208 const char *default_machine_opts; 209 const char *default_boot_order; 210 const char *default_display; 211 GPtrArray *compat_props; 212 const char *hw_version; 213 ram_addr_t default_ram_size; 214 const char *default_cpu_type; 215 bool default_kernel_irqchip_split; 216 bool option_rom_has_mr; 217 bool rom_file_has_mr; 218 int minimum_page_bits; 219 bool has_hotpluggable_cpus; 220 bool ignore_memory_transaction_failures; 221 int numa_mem_align_shift; 222 const char **valid_cpu_types; 223 strList *allowed_dynamic_sysbus_devices; 224 bool auto_enable_numa_with_memhp; 225 void (*numa_auto_assign_ram)(MachineClass *mc, NodeInfo *nodes, 226 int nb_nodes, ram_addr_t size); 227 bool ignore_boot_device_suffixes; 228 bool smbus_no_migration_support; 229 bool nvdimm_supported; 230 bool numa_mem_supported; 231 bool auto_enable_numa; 232 233 HotplugHandler *(*get_hotplug_handler)(MachineState *machine, 234 DeviceState *dev); 235 bool (*hotplug_allowed)(MachineState *state, DeviceState *dev, 236 Error **errp); 237 CpuInstanceProperties (*cpu_index_to_instance_props)(MachineState *machine, 238 unsigned cpu_index); 239 const CPUArchIdList *(*possible_cpu_arch_ids)(MachineState *machine); 240 int64_t (*get_default_cpu_node_id)(const MachineState *ms, int idx); 241 }; 242 243 /** 244 * DeviceMemoryState: 245 * @base: address in guest physical address space where the memory 246 * address space for memory devices starts 247 * @mr: address space container for memory devices 248 */ 249 typedef struct DeviceMemoryState { 250 hwaddr base; 251 MemoryRegion mr; 252 } DeviceMemoryState; 253 254 /** 255 * CpuTopology: 256 * @cpus: the number of present logical processors on the machine 257 * @cores: the number of cores in one package 258 * @threads: the number of threads in one core 259 * @max_cpus: the maximum number of logical processors on the machine 260 */ 261 typedef struct CpuTopology { 262 unsigned int cpus; 263 unsigned int cores; 264 unsigned int threads; 265 unsigned int max_cpus; 266 } CpuTopology; 267 268 /** 269 * MachineState: 270 */ 271 struct MachineState { 272 /*< private >*/ 273 Object parent_obj; 274 Notifier sysbus_notifier; 275 276 /*< public >*/ 277 278 char *accel; 279 bool kernel_irqchip_allowed; 280 bool kernel_irqchip_required; 281 bool kernel_irqchip_split; 282 int kvm_shadow_mem; 283 char *dtb; 284 char *dumpdtb; 285 int phandle_start; 286 char *dt_compatible; 287 bool dump_guest_core; 288 bool mem_merge; 289 bool usb; 290 bool usb_disabled; 291 bool igd_gfx_passthru; 292 char *firmware; 293 bool iommu; 294 bool suppress_vmdesc; 295 bool enforce_config_section; 296 bool enable_graphics; 297 char *memory_encryption; 298 DeviceMemoryState *device_memory; 299 300 ram_addr_t ram_size; 301 ram_addr_t maxram_size; 302 uint64_t ram_slots; 303 const char *boot_order; 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_4_2[]; 333 extern const size_t hw_compat_4_2_len; 334 335 extern GlobalProperty hw_compat_4_1[]; 336 extern const size_t hw_compat_4_1_len; 337 338 extern GlobalProperty hw_compat_4_0[]; 339 extern const size_t hw_compat_4_0_len; 340 341 extern GlobalProperty hw_compat_3_1[]; 342 extern const size_t hw_compat_3_1_len; 343 344 extern GlobalProperty hw_compat_3_0[]; 345 extern const size_t hw_compat_3_0_len; 346 347 extern GlobalProperty hw_compat_2_12[]; 348 extern const size_t hw_compat_2_12_len; 349 350 extern GlobalProperty hw_compat_2_11[]; 351 extern const size_t hw_compat_2_11_len; 352 353 extern GlobalProperty hw_compat_2_10[]; 354 extern const size_t hw_compat_2_10_len; 355 356 extern GlobalProperty hw_compat_2_9[]; 357 extern const size_t hw_compat_2_9_len; 358 359 extern GlobalProperty hw_compat_2_8[]; 360 extern const size_t hw_compat_2_8_len; 361 362 extern GlobalProperty hw_compat_2_7[]; 363 extern const size_t hw_compat_2_7_len; 364 365 extern GlobalProperty hw_compat_2_6[]; 366 extern const size_t hw_compat_2_6_len; 367 368 extern GlobalProperty hw_compat_2_5[]; 369 extern const size_t hw_compat_2_5_len; 370 371 extern GlobalProperty hw_compat_2_4[]; 372 extern const size_t hw_compat_2_4_len; 373 374 extern GlobalProperty hw_compat_2_3[]; 375 extern const size_t hw_compat_2_3_len; 376 377 extern GlobalProperty hw_compat_2_2[]; 378 extern const size_t hw_compat_2_2_len; 379 380 extern GlobalProperty hw_compat_2_1[]; 381 extern const size_t hw_compat_2_1_len; 382 383 #endif 384