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 "sysemu/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
,
38 void machine_class_allow_dynamic_sysbus_dev(MachineClass
*mc
, const char *type
);
40 * Checks that backend isn't used, preps it for exclusive usage and
41 * returns migratable MemoryRegion provided by backend.
43 MemoryRegion
*machine_consume_memdev(MachineState
*machine
,
44 HostMemoryBackend
*backend
);
48 * @arch_id - architecture-dependent CPU ID of present or possible CPU
49 * @cpu - pointer to corresponding CPU object if it's present on NULL otherwise
50 * @type - QOM class name of possible @cpu object
51 * @props - CPU object properties, initialized by board
52 * #vcpus_count - number of threads provided by @cpu object
54 typedef struct CPUArchId
{
57 CpuInstanceProperties props
;
64 * @len - number of @CPUArchId items in @cpus array
65 * @cpus - array of present or possible CPUs for current machine configuration
74 * @deprecation_reason: If set, the machine is marked as deprecated. The
75 * string should provide some clear information about what to use instead.
76 * @max_cpus: maximum number of CPUs supported. Default: 1
77 * @min_cpus: minimum number of CPUs supported. Default: 1
78 * @default_cpus: number of CPUs instantiated if none are specified. Default: 1
80 * If true QEMU will use this machine by default if no '-M' option is given.
81 * @get_hotplug_handler: this function is called during bus-less
82 * device hotplug. If defined it returns pointer to an instance
83 * of HotplugHandler object, which handles hotplug operation
84 * for a given @dev. It may return NULL if @dev doesn't require
85 * any actions to be performed by hotplug handler.
86 * @cpu_index_to_instance_props:
87 * used to provide @cpu_index to socket/core/thread number mapping, allowing
88 * legacy code to perform maping from cpu_index to topology properties
89 * Returns: tuple of socket/core/thread ids given cpu_index belongs to.
90 * used to provide @cpu_index to socket number mapping, allowing
91 * a machine to group CPU threads belonging to the same socket/package
92 * Returns: socket number given cpu_index belongs to.
94 * Value of QEMU_VERSION when the machine was added to QEMU.
95 * Set only by old machines because they need to keep
96 * compatibility on code that exposed QEMU_VERSION to guests in
97 * the past (and now use qemu_hw_version()).
98 * @possible_cpu_arch_ids:
99 * Returns an array of @CPUArchId architecture-dependent CPU IDs
100 * which includes CPU IDs for present and possible to hotplug CPUs.
101 * Caller is responsible for freeing returned list.
102 * @get_default_cpu_node_id:
103 * returns default board specific node_id value for CPU slot specified by
104 * index @idx in @ms->possible_cpus[]
105 * @has_hotpluggable_cpus:
106 * If true, board supports CPUs creation with -device/device_add.
108 * specifies default CPU_TYPE, which will be used for parsing target
109 * specific features and for creating CPUs if CPU name wasn't provided
111 * @minimum_page_bits:
112 * If non-zero, the board promises never to create a CPU with a page size
113 * smaller than this, so QEMU can use a more efficient larger page
114 * size than the target architecture's minimum. (Attempting to create
115 * such a CPU will fail.) Note that changing this is a migration
116 * compatibility break for the machine.
117 * @ignore_memory_transaction_failures:
118 * If this is flag is true then the CPU will ignore memory transaction
119 * failures which should cause the CPU to take an exception due to an
120 * access to an unassigned physical address; the transaction will instead
121 * return zero (for a read) or be ignored (for a write). This should be
122 * set only by legacy board models which rely on the old RAZ/WI behaviour
123 * for handling devices that QEMU does not yet model. New board models
124 * should instead use "unimplemented-device" for all memory ranges where
125 * the guest will attempt to probe for a device that QEMU doesn't
126 * implement and a stub device is required.
128 * Return the type of KVM corresponding to the kvm-type string option or
129 * computed based on other criteria such as the host kernel capabilities.
130 * @numa_mem_supported:
131 * true if '--numa node.mem' option is supported and false otherwise
133 * The function pointer to hook different machine specific functions for
134 * parsing "smp-opts" from QemuOpts to MachineState::CpuTopology and more
135 * machine specific topology fields, such as smp_dies for PCMachine.
137 * If the hook is provided, then it'll be called for each device
138 * hotplug to check whether the device hotplug is allowed. Return
139 * true to grant allowance or false to reject the hotplug. When
140 * false is returned, an error must be set to show the reason of
141 * the rejection. If the hook is not provided, all hotplug will be
144 * Specifies inital RAM MemoryRegion name to be used for default backend
145 * creation if user explicitly hasn't specified backend with "memory-backend"
147 * It also will be used as a way to optin into "-m" option support.
148 * If it's not set by board, '-m' will be ignored and generic code will
149 * not create default RAM MemoryRegion.
151 * Amends user provided ram size (with -m option) using machine
152 * specific algorithm. To be used by old machine types for compat
154 * Applies only to default memory backend, i.e., explicit memory backend
157 struct MachineClass
{
159 ObjectClass parent_class
;
162 const char *family
; /* NULL iff @name identifies a standalone machtype */
166 const char *deprecation_reason
;
168 void (*init
)(MachineState
*state
);
169 void (*reset
)(MachineState
*state
);
170 void (*wakeup
)(MachineState
*state
);
171 int (*kvm_type
)(MachineState
*machine
, const char *arg
);
172 void (*smp_parse
)(MachineState
*ms
, QemuOpts
*opts
);
174 BlockInterfaceType block_default_type
;
175 int units_per_default_bus
;
179 unsigned int no_serial
:1,
184 pci_allow_0_address
:1,
185 legacy_fw_cfg_order
:1;
187 const char *default_machine_opts
;
188 const char *default_boot_order
;
189 const char *default_display
;
190 GPtrArray
*compat_props
;
191 const char *hw_version
;
192 ram_addr_t default_ram_size
;
193 const char *default_cpu_type
;
194 bool default_kernel_irqchip_split
;
195 bool option_rom_has_mr
;
196 bool rom_file_has_mr
;
197 int minimum_page_bits
;
198 bool has_hotpluggable_cpus
;
199 bool ignore_memory_transaction_failures
;
200 int numa_mem_align_shift
;
201 const char **valid_cpu_types
;
202 strList
*allowed_dynamic_sysbus_devices
;
203 bool auto_enable_numa_with_memhp
;
204 bool auto_enable_numa_with_memdev
;
205 bool ignore_boot_device_suffixes
;
206 bool smbus_no_migration_support
;
207 bool nvdimm_supported
;
208 bool numa_mem_supported
;
209 bool auto_enable_numa
;
210 const char *default_ram_id
;
212 HotplugHandler
*(*get_hotplug_handler
)(MachineState
*machine
,
214 bool (*hotplug_allowed
)(MachineState
*state
, DeviceState
*dev
,
216 CpuInstanceProperties (*cpu_index_to_instance_props
)(MachineState
*machine
,
218 const CPUArchIdList
*(*possible_cpu_arch_ids
)(MachineState
*machine
);
219 int64_t (*get_default_cpu_node_id
)(const MachineState
*ms
, int idx
);
220 ram_addr_t (*fixup_ram_size
)(ram_addr_t size
);
225 * @base: address in guest physical address space where the memory
226 * address space for memory devices starts
227 * @mr: address space container for memory devices
229 typedef struct DeviceMemoryState
{
236 * @cpus: the number of present logical processors on the machine
237 * @cores: the number of cores in one package
238 * @threads: the number of threads in one core
239 * @sockets: the number of sockets on the machine
240 * @max_cpus: the maximum number of logical processors on the machine
242 typedef struct CpuTopology
{
245 unsigned int threads
;
246 unsigned int sockets
;
247 unsigned int max_cpus
;
253 struct MachineState
{
256 Notifier sysbus_notifier
;
264 bool dump_guest_core
;
270 bool suppress_vmdesc
;
271 bool enable_graphics
;
272 char *memory_encryption
;
275 * convenience alias to ram_memdev_id backend memory region
276 * or to numa container memory region
279 DeviceMemoryState
*device_memory
;
282 ram_addr_t maxram_size
;
284 const char *boot_order
;
285 char *kernel_filename
;
286 char *kernel_cmdline
;
287 char *initrd_filename
;
288 const char *cpu_type
;
289 AccelState
*accelerator
;
290 CPUArchIdList
*possible_cpus
;
292 struct NVDIMMState
*nvdimms_state
;
293 struct NumaState
*numa_state
;
296 #define DEFINE_MACHINE(namestr, machine_initfn) \
297 static void machine_initfn##_class_init(ObjectClass *oc, void *data) \
299 MachineClass *mc = MACHINE_CLASS(oc); \
300 machine_initfn(mc); \
302 static const TypeInfo machine_initfn##_typeinfo = { \
303 .name = MACHINE_TYPE_NAME(namestr), \
304 .parent = TYPE_MACHINE, \
305 .class_init = machine_initfn##_class_init, \
307 static void machine_initfn##_register_types(void) \
309 type_register_static(&machine_initfn##_typeinfo); \
311 type_init(machine_initfn##_register_types)
313 extern GlobalProperty hw_compat_5_1
[];
314 extern const size_t hw_compat_5_1_len
;
316 extern GlobalProperty hw_compat_5_0
[];
317 extern const size_t hw_compat_5_0_len
;
319 extern GlobalProperty hw_compat_4_2
[];
320 extern const size_t hw_compat_4_2_len
;
322 extern GlobalProperty hw_compat_4_1
[];
323 extern const size_t hw_compat_4_1_len
;
325 extern GlobalProperty hw_compat_4_0
[];
326 extern const size_t hw_compat_4_0_len
;
328 extern GlobalProperty hw_compat_3_1
[];
329 extern const size_t hw_compat_3_1_len
;
331 extern GlobalProperty hw_compat_3_0
[];
332 extern const size_t hw_compat_3_0_len
;
334 extern GlobalProperty hw_compat_2_12
[];
335 extern const size_t hw_compat_2_12_len
;
337 extern GlobalProperty hw_compat_2_11
[];
338 extern const size_t hw_compat_2_11_len
;
340 extern GlobalProperty hw_compat_2_10
[];
341 extern const size_t hw_compat_2_10_len
;
343 extern GlobalProperty hw_compat_2_9
[];
344 extern const size_t hw_compat_2_9_len
;
346 extern GlobalProperty hw_compat_2_8
[];
347 extern const size_t hw_compat_2_8_len
;
349 extern GlobalProperty hw_compat_2_7
[];
350 extern const size_t hw_compat_2_7_len
;
352 extern GlobalProperty hw_compat_2_6
[];
353 extern const size_t hw_compat_2_6_len
;
355 extern GlobalProperty hw_compat_2_5
[];
356 extern const size_t hw_compat_2_5_len
;
358 extern GlobalProperty hw_compat_2_4
[];
359 extern const size_t hw_compat_2_4_len
;
361 extern GlobalProperty hw_compat_2_3
[];
362 extern const size_t hw_compat_2_3_len
;
364 extern GlobalProperty hw_compat_2_2
[];
365 extern const size_t hw_compat_2_2_len
;
367 extern GlobalProperty hw_compat_2_1
[];
368 extern const size_t hw_compat_2_1_len
;