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