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