1 /* Declarations for use by board files for creating devices. */
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"
15 #define TYPE_MACHINE_SUFFIX "-machine"
17 /* Machine class name that needs to be used for class-name-based machine
18 * type lookup to work.
20 #define MACHINE_TYPE_NAME(machinename) (machinename TYPE_MACHINE_SUFFIX)
22 #define TYPE_MACHINE "machine"
23 #undef MACHINE /* BSD defines it and QEMU does not use it */
24 OBJECT_DECLARE_TYPE(MachineState
, MachineClass
, MACHINE
)
26 extern MachineState
*current_machine
;
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
,
37 void machine_parse_smp_config(MachineState
*ms
,
38 const SMPConfiguration
*config
, Error
**errp
);
41 * machine_class_allow_dynamic_sysbus_dev: Add type to list of valid devices
43 * @type: type to allow (should be a subtype of TYPE_SYS_BUS_DEVICE)
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.
54 void machine_class_allow_dynamic_sysbus_dev(MachineClass
*mc
, const char *type
);
57 * device_type_is_dynamic_sysbus: Check if type is an allowed sysbus device
58 * type for the machine class.
60 * @type: type to check (should be a subtype of TYPE_SYS_BUS_DEVICE)
62 * Returns: true if @type is a type in the machine's list of
63 * dynamically pluggable sysbus devices; otherwise false.
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.
69 bool device_type_is_dynamic_sysbus(MachineClass
*mc
, const char *type
);
72 * device_is_dynamic_sysbus: test whether device is a dynamic sysbus device
74 * @dev: device to check
76 * Returns: true if @dev is a sysbus device on the machine's list
77 * of dynamically pluggable sysbus devices; otherwise false.
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().
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) {
93 bool device_is_dynamic_sysbus(MachineClass
*mc
, DeviceState
*dev
);
96 * Checks that backend isn't used, preps it for exclusive usage and
97 * returns migratable MemoryRegion provided by backend.
99 MemoryRegion
*machine_consume_memdev(MachineState
*machine
,
100 HostMemoryBackend
*backend
);
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
110 typedef struct CPUArchId
{
113 CpuInstanceProperties props
;
120 * @len - number of @CPUArchId items in @cpus array
121 * @cpus - array of present or possible CPUs for current machine configuration
130 * @prefer_sockets - whether sockets are preferred over cores in smp parsing
131 * @dies_supported - whether dies are supported by the machine
140 * @deprecation_reason: If set, the machine is marked as deprecated. The
141 * string should provide some clear information about what to use instead.
142 * @max_cpus: maximum number of CPUs supported. Default: 1
143 * @min_cpus: minimum number of CPUs supported. Default: 1
144 * @default_cpus: number of CPUs instantiated if none are specified. Default: 1
146 * If true QEMU will use this machine by default if no '-M' option is given.
147 * @get_hotplug_handler: this function is called during bus-less
148 * device hotplug. If defined it returns pointer to an instance
149 * of HotplugHandler object, which handles hotplug operation
150 * for a given @dev. It may return NULL if @dev doesn't require
151 * any actions to be performed by hotplug handler.
152 * @cpu_index_to_instance_props:
153 * used to provide @cpu_index to socket/core/thread number mapping, allowing
154 * legacy code to perform maping from cpu_index to topology properties
155 * Returns: tuple of socket/core/thread ids given cpu_index belongs to.
156 * used to provide @cpu_index to socket number mapping, allowing
157 * a machine to group CPU threads belonging to the same socket/package
158 * Returns: socket number given cpu_index belongs to.
160 * Value of QEMU_VERSION when the machine was added to QEMU.
161 * Set only by old machines because they need to keep
162 * compatibility on code that exposed QEMU_VERSION to guests in
163 * the past (and now use qemu_hw_version()).
164 * @possible_cpu_arch_ids:
165 * Returns an array of @CPUArchId architecture-dependent CPU IDs
166 * which includes CPU IDs for present and possible to hotplug CPUs.
167 * Caller is responsible for freeing returned list.
168 * @get_default_cpu_node_id:
169 * returns default board specific node_id value for CPU slot specified by
170 * index @idx in @ms->possible_cpus[]
171 * @has_hotpluggable_cpus:
172 * If true, board supports CPUs creation with -device/device_add.
174 * specifies default CPU_TYPE, which will be used for parsing target
175 * specific features and for creating CPUs if CPU name wasn't provided
177 * @minimum_page_bits:
178 * If non-zero, the board promises never to create a CPU with a page size
179 * smaller than this, so QEMU can use a more efficient larger page
180 * size than the target architecture's minimum. (Attempting to create
181 * such a CPU will fail.) Note that changing this is a migration
182 * compatibility break for the machine.
183 * @ignore_memory_transaction_failures:
184 * If this is flag is true then the CPU will ignore memory transaction
185 * failures which should cause the CPU to take an exception due to an
186 * access to an unassigned physical address; the transaction will instead
187 * return zero (for a read) or be ignored (for a write). This should be
188 * set only by legacy board models which rely on the old RAZ/WI behaviour
189 * for handling devices that QEMU does not yet model. New board models
190 * should instead use "unimplemented-device" for all memory ranges where
191 * the guest will attempt to probe for a device that QEMU doesn't
192 * implement and a stub device is required.
194 * Return the type of KVM corresponding to the kvm-type string option or
195 * computed based on other criteria such as the host kernel capabilities.
196 * kvm-type may be NULL if it is not needed.
197 * @numa_mem_supported:
198 * true if '--numa node.mem' option is supported and false otherwise
200 * If the hook is provided, then it'll be called for each device
201 * hotplug to check whether the device hotplug is allowed. Return
202 * true to grant allowance or false to reject the hotplug. When
203 * false is returned, an error must be set to show the reason of
204 * the rejection. If the hook is not provided, all hotplug will be
207 * Specifies inital RAM MemoryRegion name to be used for default backend
208 * creation if user explicitly hasn't specified backend with "memory-backend"
210 * It also will be used as a way to optin into "-m" option support.
211 * If it's not set by board, '-m' will be ignored and generic code will
212 * not create default RAM MemoryRegion.
214 * Amends user provided ram size (with -m option) using machine
215 * specific algorithm. To be used by old machine types for compat
217 * Applies only to default memory backend, i.e., explicit memory backend
220 struct MachineClass
{
222 ObjectClass parent_class
;
225 const char *family
; /* NULL iff @name identifies a standalone machtype */
229 const char *deprecation_reason
;
231 void (*init
)(MachineState
*state
);
232 void (*reset
)(MachineState
*state
);
233 void (*wakeup
)(MachineState
*state
);
234 int (*kvm_type
)(MachineState
*machine
, const char *arg
);
236 BlockInterfaceType block_default_type
;
237 int units_per_default_bus
;
241 unsigned int no_serial
:1,
246 pci_allow_0_address
:1,
247 legacy_fw_cfg_order
:1;
249 const char *default_machine_opts
;
250 const char *default_boot_order
;
251 const char *default_display
;
252 GPtrArray
*compat_props
;
253 const char *hw_version
;
254 ram_addr_t default_ram_size
;
255 const char *default_cpu_type
;
256 bool default_kernel_irqchip_split
;
257 bool option_rom_has_mr
;
258 bool rom_file_has_mr
;
259 int minimum_page_bits
;
260 bool has_hotpluggable_cpus
;
261 bool ignore_memory_transaction_failures
;
262 int numa_mem_align_shift
;
263 const char **valid_cpu_types
;
264 strList
*allowed_dynamic_sysbus_devices
;
265 bool auto_enable_numa_with_memhp
;
266 bool auto_enable_numa_with_memdev
;
267 bool ignore_boot_device_suffixes
;
268 bool smbus_no_migration_support
;
269 bool nvdimm_supported
;
270 bool numa_mem_supported
;
271 bool auto_enable_numa
;
272 SMPCompatProps smp_props
;
273 const char *default_ram_id
;
275 HotplugHandler
*(*get_hotplug_handler
)(MachineState
*machine
,
277 bool (*hotplug_allowed
)(MachineState
*state
, DeviceState
*dev
,
279 CpuInstanceProperties (*cpu_index_to_instance_props
)(MachineState
*machine
,
281 const CPUArchIdList
*(*possible_cpu_arch_ids
)(MachineState
*machine
);
282 int64_t (*get_default_cpu_node_id
)(const MachineState
*ms
, int idx
);
283 ram_addr_t (*fixup_ram_size
)(ram_addr_t size
);
288 * @base: address in guest physical address space where the memory
289 * address space for memory devices starts
290 * @mr: address space container for memory devices
292 typedef struct DeviceMemoryState
{
299 * @cpus: the number of present logical processors on the machine
300 * @sockets: the number of sockets on the machine
301 * @dies: the number of dies in one socket
302 * @cores: the number of cores in one die
303 * @threads: the number of threads in one core
304 * @max_cpus: the maximum number of logical processors on the machine
306 typedef struct CpuTopology
{
308 unsigned int sockets
;
311 unsigned int threads
;
312 unsigned int max_cpus
;
318 struct MachineState
{
329 bool dump_guest_core
;
335 bool suppress_vmdesc
;
336 bool enable_graphics
;
337 ConfidentialGuestSupport
*cgs
;
340 * convenience alias to ram_memdev_id backend memory region
341 * or to numa container memory region
344 DeviceMemoryState
*device_memory
;
347 ram_addr_t maxram_size
;
349 const char *boot_order
;
350 const char *boot_once
;
351 char *kernel_filename
;
352 char *kernel_cmdline
;
353 char *initrd_filename
;
354 const char *cpu_type
;
355 AccelState
*accelerator
;
356 CPUArchIdList
*possible_cpus
;
358 struct NVDIMMState
*nvdimms_state
;
359 struct NumaState
*numa_state
;
362 #define DEFINE_MACHINE(namestr, machine_initfn) \
363 static void machine_initfn##_class_init(ObjectClass *oc, void *data) \
365 MachineClass *mc = MACHINE_CLASS(oc); \
366 machine_initfn(mc); \
368 static const TypeInfo machine_initfn##_typeinfo = { \
369 .name = MACHINE_TYPE_NAME(namestr), \
370 .parent = TYPE_MACHINE, \
371 .class_init = machine_initfn##_class_init, \
373 static void machine_initfn##_register_types(void) \
375 type_register_static(&machine_initfn##_typeinfo); \
377 type_init(machine_initfn##_register_types)
379 extern GlobalProperty hw_compat_6_1
[];
380 extern const size_t hw_compat_6_1_len
;
382 extern GlobalProperty hw_compat_6_0
[];
383 extern const size_t hw_compat_6_0_len
;
385 extern GlobalProperty hw_compat_5_2
[];
386 extern const size_t hw_compat_5_2_len
;
388 extern GlobalProperty hw_compat_5_1
[];
389 extern const size_t hw_compat_5_1_len
;
391 extern GlobalProperty hw_compat_5_0
[];
392 extern const size_t hw_compat_5_0_len
;
394 extern GlobalProperty hw_compat_4_2
[];
395 extern const size_t hw_compat_4_2_len
;
397 extern GlobalProperty hw_compat_4_1
[];
398 extern const size_t hw_compat_4_1_len
;
400 extern GlobalProperty hw_compat_4_0
[];
401 extern const size_t hw_compat_4_0_len
;
403 extern GlobalProperty hw_compat_3_1
[];
404 extern const size_t hw_compat_3_1_len
;
406 extern GlobalProperty hw_compat_3_0
[];
407 extern const size_t hw_compat_3_0_len
;
409 extern GlobalProperty hw_compat_2_12
[];
410 extern const size_t hw_compat_2_12_len
;
412 extern GlobalProperty hw_compat_2_11
[];
413 extern const size_t hw_compat_2_11_len
;
415 extern GlobalProperty hw_compat_2_10
[];
416 extern const size_t hw_compat_2_10_len
;
418 extern GlobalProperty hw_compat_2_9
[];
419 extern const size_t hw_compat_2_9_len
;
421 extern GlobalProperty hw_compat_2_8
[];
422 extern const size_t hw_compat_2_8_len
;
424 extern GlobalProperty hw_compat_2_7
[];
425 extern const size_t hw_compat_2_7_len
;
427 extern GlobalProperty hw_compat_2_6
[];
428 extern const size_t hw_compat_2_6_len
;
430 extern GlobalProperty hw_compat_2_5
[];
431 extern const size_t hw_compat_2_5_len
;
433 extern GlobalProperty hw_compat_2_4
[];
434 extern const size_t hw_compat_2_4_len
;
436 extern GlobalProperty hw_compat_2_3
[];
437 extern const size_t hw_compat_2_3_len
;
439 extern GlobalProperty hw_compat_2_2
[];
440 extern const size_t hw_compat_2_2_len
;
442 extern GlobalProperty hw_compat_2_1
[];
443 extern const size_t hw_compat_2_1_len
;