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