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 "qapi/qapi-types-machine.h" 10 #include "qemu/module.h" 11 #include "qom/object.h" 12 #include "hw/core/cpu.h" 13 14 #define TYPE_MACHINE_SUFFIX "-machine" 15 16 /* Machine class name that needs to be used for class-name-based machine 17 * type lookup to work. 18 */ 19 #define MACHINE_TYPE_NAME(machinename) (machinename TYPE_MACHINE_SUFFIX) 20 21 #define TYPE_MACHINE "machine" 22 #undef MACHINE /* BSD defines it and QEMU does not use it */ 23 OBJECT_DECLARE_TYPE(MachineState, MachineClass, MACHINE) 24 25 extern MachineState *current_machine; 26 27 void machine_run_board_init(MachineState *machine, const char *mem_path, Error **errp); 28 bool machine_usb(MachineState *machine); 29 int machine_phandle_start(MachineState *machine); 30 bool machine_dump_guest_core(MachineState *machine); 31 bool machine_mem_merge(MachineState *machine); 32 HotpluggableCPUList *machine_query_hotpluggable_cpus(MachineState *machine); 33 void machine_set_cpu_numa_node(MachineState *machine, 34 const CpuInstanceProperties *props, 35 Error **errp); 36 void machine_parse_smp_config(MachineState *ms, 37 const SMPConfiguration *config, Error **errp); 38 unsigned int machine_topo_get_cores_per_socket(const MachineState *ms); 39 unsigned int machine_topo_get_threads_per_socket(const MachineState *ms); 40 void machine_memory_devices_init(MachineState *ms, hwaddr base, uint64_t size); 41 42 /** 43 * machine_class_allow_dynamic_sysbus_dev: Add type to list of valid devices 44 * @mc: Machine class 45 * @type: type to allow (should be a subtype of TYPE_SYS_BUS_DEVICE) 46 * 47 * Add the QOM type @type to the list of devices of which are subtypes 48 * of TYPE_SYS_BUS_DEVICE but which are still permitted to be dynamically 49 * created (eg by the user on the command line with -device). 50 * By default if the user tries to create any devices on the command line 51 * that are subtypes of TYPE_SYS_BUS_DEVICE they will get an error message; 52 * for the special cases which are permitted for this machine model, the 53 * machine model class init code must call this function to add them 54 * to the list of specifically permitted devices. 55 */ 56 void machine_class_allow_dynamic_sysbus_dev(MachineClass *mc, const char *type); 57 58 /** 59 * device_type_is_dynamic_sysbus: Check if type is an allowed sysbus device 60 * type for the machine class. 61 * @mc: Machine class 62 * @type: type to check (should be a subtype of TYPE_SYS_BUS_DEVICE) 63 * 64 * Returns: true if @type is a type in the machine's list of 65 * dynamically pluggable sysbus devices; otherwise false. 66 * 67 * Check if the QOM type @type is in the list of allowed sysbus device 68 * types (see machine_class_allowed_dynamic_sysbus_dev()). 69 * Note that if @type has a parent type in the list, it is allowed too. 70 */ 71 bool device_type_is_dynamic_sysbus(MachineClass *mc, const char *type); 72 73 /** 74 * device_is_dynamic_sysbus: test whether device is a dynamic sysbus device 75 * @mc: Machine class 76 * @dev: device to check 77 * 78 * Returns: true if @dev is a sysbus device on the machine's list 79 * of dynamically pluggable sysbus devices; otherwise false. 80 * 81 * This function checks whether @dev is a valid dynamic sysbus device, 82 * by first confirming that it is a sysbus device and then checking it 83 * against the list of permitted dynamic sysbus devices which has been 84 * set up by the machine using machine_class_allow_dynamic_sysbus_dev(). 85 * 86 * It is valid to call this with something that is not a subclass of 87 * TYPE_SYS_BUS_DEVICE; the function will return false in this case. 88 * This allows hotplug callback functions to be written as: 89 * if (device_is_dynamic_sysbus(mc, dev)) { 90 * handle dynamic sysbus case; 91 * } else if (some other kind of hotplug) { 92 * handle that; 93 * } 94 */ 95 bool device_is_dynamic_sysbus(MachineClass *mc, DeviceState *dev); 96 97 /* 98 * Checks that backend isn't used, preps it for exclusive usage and 99 * returns migratable MemoryRegion provided by backend. 100 */ 101 MemoryRegion *machine_consume_memdev(MachineState *machine, 102 HostMemoryBackend *backend); 103 104 /** 105 * CPUArchId: 106 * @arch_id - architecture-dependent CPU ID of present or possible CPU 107 * @cpu - pointer to corresponding CPU object if it's present on NULL otherwise 108 * @type - QOM class name of possible @cpu object 109 * @props - CPU object properties, initialized by board 110 * #vcpus_count - number of threads provided by @cpu object 111 */ 112 typedef struct CPUArchId { 113 uint64_t arch_id; 114 int64_t vcpus_count; 115 CpuInstanceProperties props; 116 Object *cpu; 117 const char *type; 118 } CPUArchId; 119 120 /** 121 * CPUArchIdList: 122 * @len - number of @CPUArchId items in @cpus array 123 * @cpus - array of present or possible CPUs for current machine configuration 124 */ 125 typedef struct { 126 int len; 127 CPUArchId cpus[]; 128 } CPUArchIdList; 129 130 /** 131 * SMPCompatProps: 132 * @prefer_sockets - whether sockets are preferred over cores in smp parsing 133 * @dies_supported - whether dies are supported by the machine 134 * @clusters_supported - whether clusters are supported by the machine 135 * @has_clusters - whether clusters are explicitly specified in the user 136 * provided SMP configuration 137 */ 138 typedef struct { 139 bool prefer_sockets; 140 bool dies_supported; 141 bool clusters_supported; 142 bool has_clusters; 143 } SMPCompatProps; 144 145 /** 146 * MachineClass: 147 * @deprecation_reason: If set, the machine is marked as deprecated. The 148 * string should provide some clear information about what to use instead. 149 * @max_cpus: maximum number of CPUs supported. Default: 1 150 * @min_cpus: minimum number of CPUs supported. Default: 1 151 * @default_cpus: number of CPUs instantiated if none are specified. Default: 1 152 * @is_default: 153 * If true QEMU will use this machine by default if no '-M' option is given. 154 * @get_hotplug_handler: this function is called during bus-less 155 * device hotplug. If defined it returns pointer to an instance 156 * of HotplugHandler object, which handles hotplug operation 157 * for a given @dev. It may return NULL if @dev doesn't require 158 * any actions to be performed by hotplug handler. 159 * @cpu_index_to_instance_props: 160 * used to provide @cpu_index to socket/core/thread number mapping, allowing 161 * legacy code to perform mapping from cpu_index to topology properties 162 * Returns: tuple of socket/core/thread ids given cpu_index belongs to. 163 * used to provide @cpu_index to socket number mapping, allowing 164 * a machine to group CPU threads belonging to the same socket/package 165 * Returns: socket number given cpu_index belongs to. 166 * @hw_version: 167 * Value of QEMU_VERSION when the machine was added to QEMU. 168 * Set only by old machines because they need to keep 169 * compatibility on code that exposed QEMU_VERSION to guests in 170 * the past (and now use qemu_hw_version()). 171 * @possible_cpu_arch_ids: 172 * Returns an array of @CPUArchId architecture-dependent CPU IDs 173 * which includes CPU IDs for present and possible to hotplug CPUs. 174 * Caller is responsible for freeing returned list. 175 * @get_default_cpu_node_id: 176 * returns default board specific node_id value for CPU slot specified by 177 * index @idx in @ms->possible_cpus[] 178 * @has_hotpluggable_cpus: 179 * If true, board supports CPUs creation with -device/device_add. 180 * @default_cpu_type: 181 * specifies default CPU_TYPE, which will be used for parsing target 182 * specific features and for creating CPUs if CPU name wasn't provided 183 * explicitly at CLI 184 * @minimum_page_bits: 185 * If non-zero, the board promises never to create a CPU with a page size 186 * smaller than this, so QEMU can use a more efficient larger page 187 * size than the target architecture's minimum. (Attempting to create 188 * such a CPU will fail.) Note that changing this is a migration 189 * compatibility break for the machine. 190 * @ignore_memory_transaction_failures: 191 * If this is flag is true then the CPU will ignore memory transaction 192 * failures which should cause the CPU to take an exception due to an 193 * access to an unassigned physical address; the transaction will instead 194 * return zero (for a read) or be ignored (for a write). This should be 195 * set only by legacy board models which rely on the old RAZ/WI behaviour 196 * for handling devices that QEMU does not yet model. New board models 197 * should instead use "unimplemented-device" for all memory ranges where 198 * the guest will attempt to probe for a device that QEMU doesn't 199 * implement and a stub device is required. 200 * @kvm_type: 201 * Return the type of KVM corresponding to the kvm-type string option or 202 * computed based on other criteria such as the host kernel capabilities. 203 * kvm-type may be NULL if it is not needed. 204 * @numa_mem_supported: 205 * true if '--numa node.mem' option is supported and false otherwise 206 * @hotplug_allowed: 207 * If the hook is provided, then it'll be called for each device 208 * hotplug to check whether the device hotplug is allowed. Return 209 * true to grant allowance or false to reject the hotplug. When 210 * false is returned, an error must be set to show the reason of 211 * the rejection. If the hook is not provided, all hotplug will be 212 * allowed. 213 * @default_ram_id: 214 * Specifies initial RAM MemoryRegion name to be used for default backend 215 * creation if user explicitly hasn't specified backend with "memory-backend" 216 * property. 217 * It also will be used as a way to option into "-m" option support. 218 * If it's not set by board, '-m' will be ignored and generic code will 219 * not create default RAM MemoryRegion. 220 * @fixup_ram_size: 221 * Amends user provided ram size (with -m option) using machine 222 * specific algorithm. To be used by old machine types for compat 223 * purposes only. 224 * Applies only to default memory backend, i.e., explicit memory backend 225 * wasn't used. 226 */ 227 struct MachineClass { 228 /*< private >*/ 229 ObjectClass parent_class; 230 /*< public >*/ 231 232 const char *family; /* NULL iff @name identifies a standalone machtype */ 233 char *name; 234 const char *alias; 235 const char *desc; 236 const char *deprecation_reason; 237 238 void (*init)(MachineState *state); 239 void (*reset)(MachineState *state, ShutdownCause reason); 240 void (*wakeup)(MachineState *state); 241 int (*kvm_type)(MachineState *machine, const char *arg); 242 243 BlockInterfaceType block_default_type; 244 int units_per_default_bus; 245 int max_cpus; 246 int min_cpus; 247 int default_cpus; 248 unsigned int no_serial:1, 249 no_parallel:1, 250 no_floppy:1, 251 no_cdrom:1, 252 no_sdcard:1, 253 pci_allow_0_address:1, 254 legacy_fw_cfg_order:1; 255 bool is_default; 256 const char *default_machine_opts; 257 const char *default_boot_order; 258 const char *default_display; 259 const char *default_nic; 260 GPtrArray *compat_props; 261 const char *hw_version; 262 ram_addr_t default_ram_size; 263 const char *default_cpu_type; 264 bool default_kernel_irqchip_split; 265 bool option_rom_has_mr; 266 bool rom_file_has_mr; 267 int minimum_page_bits; 268 bool has_hotpluggable_cpus; 269 bool ignore_memory_transaction_failures; 270 int numa_mem_align_shift; 271 const char **valid_cpu_types; 272 strList *allowed_dynamic_sysbus_devices; 273 bool auto_enable_numa_with_memhp; 274 bool auto_enable_numa_with_memdev; 275 bool ignore_boot_device_suffixes; 276 bool smbus_no_migration_support; 277 bool nvdimm_supported; 278 bool numa_mem_supported; 279 bool auto_enable_numa; 280 bool cpu_cluster_has_numa_boundary; 281 SMPCompatProps smp_props; 282 const char *default_ram_id; 283 284 HotplugHandler *(*get_hotplug_handler)(MachineState *machine, 285 DeviceState *dev); 286 bool (*hotplug_allowed)(MachineState *state, DeviceState *dev, 287 Error **errp); 288 CpuInstanceProperties (*cpu_index_to_instance_props)(MachineState *machine, 289 unsigned cpu_index); 290 const CPUArchIdList *(*possible_cpu_arch_ids)(MachineState *machine); 291 int64_t (*get_default_cpu_node_id)(const MachineState *ms, int idx); 292 ram_addr_t (*fixup_ram_size)(ram_addr_t size); 293 }; 294 295 /** 296 * DeviceMemoryState: 297 * @base: address in guest physical address space where the memory 298 * address space for memory devices starts 299 * @mr: address space container for memory devices 300 * @dimm_size: the sum of plugged DIMMs' sizes 301 * @used_region_size: the part of @mr already used by memory devices 302 */ 303 typedef struct DeviceMemoryState { 304 hwaddr base; 305 MemoryRegion mr; 306 uint64_t dimm_size; 307 uint64_t used_region_size; 308 } DeviceMemoryState; 309 310 /** 311 * CpuTopology: 312 * @cpus: the number of present logical processors on the machine 313 * @sockets: the number of sockets on the machine 314 * @dies: the number of dies in one socket 315 * @clusters: the number of clusters in one die 316 * @cores: the number of cores in one cluster 317 * @threads: the number of threads in one core 318 * @max_cpus: the maximum number of logical processors on the machine 319 */ 320 typedef struct CpuTopology { 321 unsigned int cpus; 322 unsigned int sockets; 323 unsigned int dies; 324 unsigned int clusters; 325 unsigned int cores; 326 unsigned int threads; 327 unsigned int max_cpus; 328 } CpuTopology; 329 330 /** 331 * MachineState: 332 */ 333 struct MachineState { 334 /*< private >*/ 335 Object parent_obj; 336 337 /*< public >*/ 338 339 void *fdt; 340 char *dtb; 341 char *dumpdtb; 342 int phandle_start; 343 char *dt_compatible; 344 bool dump_guest_core; 345 bool mem_merge; 346 bool usb; 347 bool usb_disabled; 348 char *firmware; 349 bool iommu; 350 bool suppress_vmdesc; 351 bool enable_graphics; 352 ConfidentialGuestSupport *cgs; 353 HostMemoryBackend *memdev; 354 /* 355 * convenience alias to ram_memdev_id backend memory region 356 * or to numa container memory region 357 */ 358 MemoryRegion *ram; 359 DeviceMemoryState *device_memory; 360 361 ram_addr_t ram_size; 362 ram_addr_t maxram_size; 363 uint64_t ram_slots; 364 BootConfiguration boot_config; 365 char *kernel_filename; 366 char *kernel_cmdline; 367 char *initrd_filename; 368 const char *cpu_type; 369 AccelState *accelerator; 370 CPUArchIdList *possible_cpus; 371 CpuTopology smp; 372 struct NVDIMMState *nvdimms_state; 373 struct NumaState *numa_state; 374 }; 375 376 #define DEFINE_MACHINE(namestr, machine_initfn) \ 377 static void machine_initfn##_class_init(ObjectClass *oc, void *data) \ 378 { \ 379 MachineClass *mc = MACHINE_CLASS(oc); \ 380 machine_initfn(mc); \ 381 } \ 382 static const TypeInfo machine_initfn##_typeinfo = { \ 383 .name = MACHINE_TYPE_NAME(namestr), \ 384 .parent = TYPE_MACHINE, \ 385 .class_init = machine_initfn##_class_init, \ 386 }; \ 387 static void machine_initfn##_register_types(void) \ 388 { \ 389 type_register_static(&machine_initfn##_typeinfo); \ 390 } \ 391 type_init(machine_initfn##_register_types) 392 393 extern GlobalProperty hw_compat_8_1[]; 394 extern const size_t hw_compat_8_1_len; 395 396 extern GlobalProperty hw_compat_8_0[]; 397 extern const size_t hw_compat_8_0_len; 398 399 extern GlobalProperty hw_compat_7_2[]; 400 extern const size_t hw_compat_7_2_len; 401 402 extern GlobalProperty hw_compat_7_1[]; 403 extern const size_t hw_compat_7_1_len; 404 405 extern GlobalProperty hw_compat_7_0[]; 406 extern const size_t hw_compat_7_0_len; 407 408 extern GlobalProperty hw_compat_6_2[]; 409 extern const size_t hw_compat_6_2_len; 410 411 extern GlobalProperty hw_compat_6_1[]; 412 extern const size_t hw_compat_6_1_len; 413 414 extern GlobalProperty hw_compat_6_0[]; 415 extern const size_t hw_compat_6_0_len; 416 417 extern GlobalProperty hw_compat_5_2[]; 418 extern const size_t hw_compat_5_2_len; 419 420 extern GlobalProperty hw_compat_5_1[]; 421 extern const size_t hw_compat_5_1_len; 422 423 extern GlobalProperty hw_compat_5_0[]; 424 extern const size_t hw_compat_5_0_len; 425 426 extern GlobalProperty hw_compat_4_2[]; 427 extern const size_t hw_compat_4_2_len; 428 429 extern GlobalProperty hw_compat_4_1[]; 430 extern const size_t hw_compat_4_1_len; 431 432 extern GlobalProperty hw_compat_4_0[]; 433 extern const size_t hw_compat_4_0_len; 434 435 extern GlobalProperty hw_compat_3_1[]; 436 extern const size_t hw_compat_3_1_len; 437 438 extern GlobalProperty hw_compat_3_0[]; 439 extern const size_t hw_compat_3_0_len; 440 441 extern GlobalProperty hw_compat_2_12[]; 442 extern const size_t hw_compat_2_12_len; 443 444 extern GlobalProperty hw_compat_2_11[]; 445 extern const size_t hw_compat_2_11_len; 446 447 extern GlobalProperty hw_compat_2_10[]; 448 extern const size_t hw_compat_2_10_len; 449 450 extern GlobalProperty hw_compat_2_9[]; 451 extern const size_t hw_compat_2_9_len; 452 453 extern GlobalProperty hw_compat_2_8[]; 454 extern const size_t hw_compat_2_8_len; 455 456 extern GlobalProperty hw_compat_2_7[]; 457 extern const size_t hw_compat_2_7_len; 458 459 extern GlobalProperty hw_compat_2_6[]; 460 extern const size_t hw_compat_2_6_len; 461 462 extern GlobalProperty hw_compat_2_5[]; 463 extern const size_t hw_compat_2_5_len; 464 465 extern GlobalProperty hw_compat_2_4[]; 466 extern const size_t hw_compat_2_4_len; 467 468 extern GlobalProperty hw_compat_2_3[]; 469 extern const size_t hw_compat_2_3_len; 470 471 extern GlobalProperty hw_compat_2_2[]; 472 extern const size_t hw_compat_2_2_len; 473 474 extern GlobalProperty hw_compat_2_1[]; 475 extern const size_t hw_compat_2_1_len; 476 477 #endif 478