1 /* Declarations for use by board files for creating devices. */
6 #include "exec/memory.h"
7 #include "sysemu/blockdev.h"
8 #include "sysemu/accel.h"
9 #include "qapi/qapi-types-machine.h"
10 #include "qemu/module.h"
11 #include "qom/object.h"
12 #include "hw/core/cpu.h"
15 * memory_region_allocate_system_memory - Allocate a board's main memory
16 * @mr: the #MemoryRegion to be initialized
17 * @owner: the object that tracks the region's reference count
18 * @name: name of the memory region
19 * @ram_size: size of the region in bytes
21 * This function allocates the main memory for a board model, and
22 * initializes @mr appropriately. It also arranges for the memory
23 * to be migrated (by calling vmstate_register_ram_global()).
25 * Memory allocated via this function will be backed with the memory
26 * backend the user provided using "-mem-path" or "-numa node,memdev=..."
27 * if appropriate; this is typically used to cause host huge pages to be
28 * used. This function should therefore be called by a board exactly once,
29 * for the primary or largest RAM area it implements.
31 * For boards where the major RAM is split into two parts in the memory
32 * map, you can deal with this by calling memory_region_allocate_system_memory()
33 * once to get a MemoryRegion with enough RAM for both parts, and then
34 * creating alias MemoryRegions via memory_region_init_alias() which
35 * alias into different parts of the RAM MemoryRegion and can be mapped
36 * into the memory map in the appropriate places.
38 * Smaller pieces of memory (display RAM, static RAMs, etc) don't need
39 * to be backed via the -mem-path memory backend and can simply
40 * be created via memory_region_init_ram().
42 void memory_region_allocate_system_memory(MemoryRegion
*mr
, Object
*owner
,
46 #define TYPE_MACHINE_SUFFIX "-machine"
48 /* Machine class name that needs to be used for class-name-based machine
49 * type lookup to work.
51 #define MACHINE_TYPE_NAME(machinename) (machinename TYPE_MACHINE_SUFFIX)
53 #define TYPE_MACHINE "machine"
54 #undef MACHINE /* BSD defines it and QEMU does not use it */
55 #define MACHINE(obj) \
56 OBJECT_CHECK(MachineState, (obj), TYPE_MACHINE)
57 #define MACHINE_GET_CLASS(obj) \
58 OBJECT_GET_CLASS(MachineClass, (obj), TYPE_MACHINE)
59 #define MACHINE_CLASS(klass) \
60 OBJECT_CLASS_CHECK(MachineClass, (klass), TYPE_MACHINE)
62 extern MachineState
*current_machine
;
64 void machine_run_board_init(MachineState
*machine
);
65 bool machine_usb(MachineState
*machine
);
66 int machine_phandle_start(MachineState
*machine
);
67 bool machine_dump_guest_core(MachineState
*machine
);
68 bool machine_mem_merge(MachineState
*machine
);
69 HotpluggableCPUList
*machine_query_hotpluggable_cpus(MachineState
*machine
);
70 void machine_set_cpu_numa_node(MachineState
*machine
,
71 const CpuInstanceProperties
*props
,
74 void machine_class_allow_dynamic_sysbus_dev(MachineClass
*mc
, const char *type
);
79 * @arch_id - architecture-dependent CPU ID of present or possible CPU
80 * @cpu - pointer to corresponding CPU object if it's present on NULL otherwise
81 * @type - QOM class name of possible @cpu object
82 * @props - CPU object properties, initialized by board
83 * #vcpus_count - number of threads provided by @cpu object
85 typedef struct CPUArchId
{
88 CpuInstanceProperties props
;
95 * @len - number of @CPUArchId items in @cpus array
96 * @cpus - array of present or possible CPUs for current machine configuration
105 * @deprecation_reason: If set, the machine is marked as deprecated. The
106 * string should provide some clear information about what to use instead.
107 * @max_cpus: maximum number of CPUs supported. Default: 1
108 * @min_cpus: minimum number of CPUs supported. Default: 1
109 * @default_cpus: number of CPUs instantiated if none are specified. Default: 1
110 * @get_hotplug_handler: this function is called during bus-less
111 * device hotplug. If defined it returns pointer to an instance
112 * of HotplugHandler object, which handles hotplug operation
113 * for a given @dev. It may return NULL if @dev doesn't require
114 * any actions to be performed by hotplug handler.
115 * @cpu_index_to_instance_props:
116 * used to provide @cpu_index to socket/core/thread number mapping, allowing
117 * legacy code to perform maping from cpu_index to topology properties
118 * Returns: tuple of socket/core/thread ids given cpu_index belongs to.
119 * used to provide @cpu_index to socket number mapping, allowing
120 * a machine to group CPU threads belonging to the same socket/package
121 * Returns: socket number given cpu_index belongs to.
123 * Value of QEMU_VERSION when the machine was added to QEMU.
124 * Set only by old machines because they need to keep
125 * compatibility on code that exposed QEMU_VERSION to guests in
126 * the past (and now use qemu_hw_version()).
127 * @possible_cpu_arch_ids:
128 * Returns an array of @CPUArchId architecture-dependent CPU IDs
129 * which includes CPU IDs for present and possible to hotplug CPUs.
130 * Caller is responsible for freeing returned list.
131 * @get_default_cpu_node_id:
132 * returns default board specific node_id value for CPU slot specified by
133 * index @idx in @ms->possible_cpus[]
134 * @has_hotpluggable_cpus:
135 * If true, board supports CPUs creation with -device/device_add.
137 * specifies default CPU_TYPE, which will be used for parsing target
138 * specific features and for creating CPUs if CPU name wasn't provided
140 * @minimum_page_bits:
141 * If non-zero, the board promises never to create a CPU with a page size
142 * smaller than this, so QEMU can use a more efficient larger page
143 * size than the target architecture's minimum. (Attempting to create
144 * such a CPU will fail.) Note that changing this is a migration
145 * compatibility break for the machine.
146 * @ignore_memory_transaction_failures:
147 * If this is flag is true then the CPU will ignore memory transaction
148 * failures which should cause the CPU to take an exception due to an
149 * access to an unassigned physical address; the transaction will instead
150 * return zero (for a read) or be ignored (for a write). This should be
151 * set only by legacy board models which rely on the old RAZ/WI behaviour
152 * for handling devices that QEMU does not yet model. New board models
153 * should instead use "unimplemented-device" for all memory ranges where
154 * the guest will attempt to probe for a device that QEMU doesn't
155 * implement and a stub device is required.
157 * Return the type of KVM corresponding to the kvm-type string option or
158 * computed based on other criteria such as the host kernel capabilities.
159 * @numa_mem_supported:
160 * true if '--numa node.mem' option is supported and false otherwise
162 * The function pointer to hook different machine specific functions for
163 * parsing "smp-opts" from QemuOpts to MachineState::CpuTopology and more
164 * machine specific topology fields, such as smp_dies for PCMachine.
166 * If the hook is provided, then it'll be called for each device
167 * hotplug to check whether the device hotplug is allowed. Return
168 * true to grant allowance or false to reject the hotplug. When
169 * false is returned, an error must be set to show the reason of
170 * the rejection. If the hook is not provided, all hotplug will be
173 struct MachineClass
{
175 ObjectClass parent_class
;
178 const char *family
; /* NULL iff @name identifies a standalone machtype */
182 const char *deprecation_reason
;
184 void (*init
)(MachineState
*state
);
185 void (*reset
)(MachineState
*state
);
186 void (*wakeup
)(MachineState
*state
);
187 void (*hot_add_cpu
)(MachineState
*state
, const int64_t id
, Error
**errp
);
188 int (*kvm_type
)(MachineState
*machine
, const char *arg
);
189 void (*smp_parse
)(MachineState
*ms
, QemuOpts
*opts
);
191 BlockInterfaceType block_default_type
;
192 int units_per_default_bus
;
196 unsigned int no_serial
:1,
201 pci_allow_0_address
:1,
202 legacy_fw_cfg_order
:1;
204 const char *default_machine_opts
;
205 const char *default_boot_order
;
206 const char *default_display
;
207 GPtrArray
*compat_props
;
208 const char *hw_version
;
209 ram_addr_t default_ram_size
;
210 const char *default_cpu_type
;
211 bool default_kernel_irqchip_split
;
212 bool option_rom_has_mr
;
213 bool rom_file_has_mr
;
214 int minimum_page_bits
;
215 bool has_hotpluggable_cpus
;
216 bool ignore_memory_transaction_failures
;
217 int numa_mem_align_shift
;
218 const char **valid_cpu_types
;
219 strList
*allowed_dynamic_sysbus_devices
;
220 bool auto_enable_numa_with_memhp
;
221 void (*numa_auto_assign_ram
)(MachineClass
*mc
, NodeInfo
*nodes
,
222 int nb_nodes
, ram_addr_t size
);
223 bool ignore_boot_device_suffixes
;
224 bool smbus_no_migration_support
;
225 bool nvdimm_supported
;
226 bool numa_mem_supported
;
227 bool auto_enable_numa
;
229 HotplugHandler
*(*get_hotplug_handler
)(MachineState
*machine
,
231 bool (*hotplug_allowed
)(MachineState
*state
, DeviceState
*dev
,
233 CpuInstanceProperties (*cpu_index_to_instance_props
)(MachineState
*machine
,
235 const CPUArchIdList
*(*possible_cpu_arch_ids
)(MachineState
*machine
);
236 int64_t (*get_default_cpu_node_id
)(const MachineState
*ms
, int idx
);
241 * @base: address in guest physical address space where the memory
242 * address space for memory devices starts
243 * @mr: address space container for memory devices
245 typedef struct DeviceMemoryState
{
252 * @cpus: the number of present logical processors on the machine
253 * @cores: the number of cores in one package
254 * @threads: the number of threads in one core
255 * @max_cpus: the maximum number of logical processors on the machine
257 typedef struct CpuTopology
{
260 unsigned int threads
;
261 unsigned int max_cpus
;
267 struct MachineState
{
270 Notifier sysbus_notifier
;
278 bool dump_guest_core
;
284 bool suppress_vmdesc
;
285 bool enforce_config_section
;
286 bool enable_graphics
;
287 char *memory_encryption
;
288 DeviceMemoryState
*device_memory
;
291 ram_addr_t maxram_size
;
293 const char *boot_order
;
294 char *kernel_filename
;
295 char *kernel_cmdline
;
296 char *initrd_filename
;
297 const char *cpu_type
;
298 AccelState
*accelerator
;
299 CPUArchIdList
*possible_cpus
;
301 struct NVDIMMState
*nvdimms_state
;
302 struct NumaState
*numa_state
;
305 #define DEFINE_MACHINE(namestr, machine_initfn) \
306 static void machine_initfn##_class_init(ObjectClass *oc, void *data) \
308 MachineClass *mc = MACHINE_CLASS(oc); \
309 machine_initfn(mc); \
311 static const TypeInfo machine_initfn##_typeinfo = { \
312 .name = MACHINE_TYPE_NAME(namestr), \
313 .parent = TYPE_MACHINE, \
314 .class_init = machine_initfn##_class_init, \
316 static void machine_initfn##_register_types(void) \
318 type_register_static(&machine_initfn##_typeinfo); \
320 type_init(machine_initfn##_register_types)
322 extern GlobalProperty hw_compat_4_2
[];
323 extern const size_t hw_compat_4_2_len
;
325 extern GlobalProperty hw_compat_4_1
[];
326 extern const size_t hw_compat_4_1_len
;
328 extern GlobalProperty hw_compat_4_0
[];
329 extern const size_t hw_compat_4_0_len
;
331 extern GlobalProperty hw_compat_3_1
[];
332 extern const size_t hw_compat_3_1_len
;
334 extern GlobalProperty hw_compat_3_0
[];
335 extern const size_t hw_compat_3_0_len
;
337 extern GlobalProperty hw_compat_2_12
[];
338 extern const size_t hw_compat_2_12_len
;
340 extern GlobalProperty hw_compat_2_11
[];
341 extern const size_t hw_compat_2_11_len
;
343 extern GlobalProperty hw_compat_2_10
[];
344 extern const size_t hw_compat_2_10_len
;
346 extern GlobalProperty hw_compat_2_9
[];
347 extern const size_t hw_compat_2_9_len
;
349 extern GlobalProperty hw_compat_2_8
[];
350 extern const size_t hw_compat_2_8_len
;
352 extern GlobalProperty hw_compat_2_7
[];
353 extern const size_t hw_compat_2_7_len
;
355 extern GlobalProperty hw_compat_2_6
[];
356 extern const size_t hw_compat_2_6_len
;
358 extern GlobalProperty hw_compat_2_5
[];
359 extern const size_t hw_compat_2_5_len
;
361 extern GlobalProperty hw_compat_2_4
[];
362 extern const size_t hw_compat_2_4_len
;
364 extern GlobalProperty hw_compat_2_3
[];
365 extern const size_t hw_compat_2_3_len
;
367 extern GlobalProperty hw_compat_2_2
[];
368 extern const size_t hw_compat_2_2_len
;
370 extern GlobalProperty hw_compat_2_1
[];
371 extern const size_t hw_compat_2_1_len
;