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