1 /* Declarations for use by board files for creating devices. */
6 #include "sysemu/blockdev.h"
7 #include "sysemu/accel.h"
9 #include "qapi/qapi-types-machine.h"
10 #include "qemu/module.h"
11 #include "qom/object.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 bool machine_kernel_irqchip_allowed(MachineState
*machine
);
67 bool machine_kernel_irqchip_required(MachineState
*machine
);
68 bool machine_kernel_irqchip_split(MachineState
*machine
);
69 int machine_kvm_shadow_mem(MachineState
*machine
);
70 int machine_phandle_start(MachineState
*machine
);
71 bool machine_dump_guest_core(MachineState
*machine
);
72 bool machine_mem_merge(MachineState
*machine
);
73 HotpluggableCPUList
*machine_query_hotpluggable_cpus(MachineState
*machine
);
74 void machine_set_cpu_numa_node(MachineState
*machine
,
75 const CpuInstanceProperties
*props
,
78 void machine_class_allow_dynamic_sysbus_dev(MachineClass
*mc
, const char *type
);
83 * @arch_id - architecture-dependent CPU ID of present or possible CPU
84 * @cpu - pointer to corresponding CPU object if it's present on NULL otherwise
85 * @type - QOM class name of possible @cpu object
86 * @props - CPU object properties, initialized by board
87 * #vcpus_count - number of threads provided by @cpu object
92 CpuInstanceProperties props
;
99 * @len - number of @CPUArchId items in @cpus array
100 * @cpus - array of present or possible CPUs for current machine configuration
109 * @deprecation_reason: If set, the machine is marked as deprecated. The
110 * string should provide some clear information about what to use instead.
111 * @max_cpus: maximum number of CPUs supported. Default: 1
112 * @min_cpus: minimum number of CPUs supported. Default: 1
113 * @default_cpus: number of CPUs instantiated if none are specified. Default: 1
114 * @get_hotplug_handler: this function is called during bus-less
115 * device hotplug. If defined it returns pointer to an instance
116 * of HotplugHandler object, which handles hotplug operation
117 * for a given @dev. It may return NULL if @dev doesn't require
118 * any actions to be performed by hotplug handler.
119 * @cpu_index_to_instance_props:
120 * used to provide @cpu_index to socket/core/thread number mapping, allowing
121 * legacy code to perform maping from cpu_index to topology properties
122 * Returns: tuple of socket/core/thread ids given cpu_index belongs to.
123 * used to provide @cpu_index to socket number mapping, allowing
124 * a machine to group CPU threads belonging to the same socket/package
125 * Returns: socket number given cpu_index belongs to.
127 * Value of QEMU_VERSION when the machine was added to QEMU.
128 * Set only by old machines because they need to keep
129 * compatibility on code that exposed QEMU_VERSION to guests in
130 * the past (and now use qemu_hw_version()).
131 * @possible_cpu_arch_ids:
132 * Returns an array of @CPUArchId architecture-dependent CPU IDs
133 * which includes CPU IDs for present and possible to hotplug CPUs.
134 * Caller is responsible for freeing returned list.
135 * @get_default_cpu_node_id:
136 * returns default board specific node_id value for CPU slot specified by
137 * index @idx in @ms->possible_cpus[]
138 * @has_hotpluggable_cpus:
139 * If true, board supports CPUs creation with -device/device_add.
141 * specifies default CPU_TYPE, which will be used for parsing target
142 * specific features and for creating CPUs if CPU name wasn't provided
144 * @minimum_page_bits:
145 * If non-zero, the board promises never to create a CPU with a page size
146 * smaller than this, so QEMU can use a more efficient larger page
147 * size than the target architecture's minimum. (Attempting to create
148 * such a CPU will fail.) Note that changing this is a migration
149 * compatibility break for the machine.
150 * @ignore_memory_transaction_failures:
151 * If this is flag is true then the CPU will ignore memory transaction
152 * failures which should cause the CPU to take an exception due to an
153 * access to an unassigned physical address; the transaction will instead
154 * return zero (for a read) or be ignored (for a write). This should be
155 * set only by legacy board models which rely on the old RAZ/WI behaviour
156 * for handling devices that QEMU does not yet model. New board models
157 * should instead use "unimplemented-device" for all memory ranges where
158 * the guest will attempt to probe for a device that QEMU doesn't
159 * implement and a stub device is required.
161 * Return the type of KVM corresponding to the kvm-type string option or
162 * computed based on other criteria such as the host kernel capabilities.
164 struct MachineClass
{
166 ObjectClass parent_class
;
169 const char *family
; /* NULL iff @name identifies a standalone machtype */
173 const char *deprecation_reason
;
175 void (*init
)(MachineState
*state
);
177 void (*hot_add_cpu
)(const int64_t id
, Error
**errp
);
178 int (*kvm_type
)(MachineState
*machine
, const char *arg
);
180 BlockInterfaceType block_default_type
;
181 int units_per_default_bus
;
185 unsigned int no_serial
:1,
190 pci_allow_0_address
:1,
191 legacy_fw_cfg_order
:1;
193 const char *default_machine_opts
;
194 const char *default_boot_order
;
195 const char *default_display
;
196 GPtrArray
*compat_props
;
197 const char *hw_version
;
198 ram_addr_t default_ram_size
;
199 const char *default_cpu_type
;
200 bool default_kernel_irqchip_split
;
201 bool option_rom_has_mr
;
202 bool rom_file_has_mr
;
203 int minimum_page_bits
;
204 bool has_hotpluggable_cpus
;
205 bool ignore_memory_transaction_failures
;
206 int numa_mem_align_shift
;
207 const char **valid_cpu_types
;
208 strList
*allowed_dynamic_sysbus_devices
;
209 bool auto_enable_numa_with_memhp
;
210 void (*numa_auto_assign_ram
)(MachineClass
*mc
, NodeInfo
*nodes
,
211 int nb_nodes
, ram_addr_t size
);
212 bool ignore_boot_device_suffixes
;
213 bool smbus_no_migration_support
;
214 bool nvdimm_supported
;
216 HotplugHandler
*(*get_hotplug_handler
)(MachineState
*machine
,
218 CpuInstanceProperties (*cpu_index_to_instance_props
)(MachineState
*machine
,
220 const CPUArchIdList
*(*possible_cpu_arch_ids
)(MachineState
*machine
);
221 int64_t (*get_default_cpu_node_id
)(const MachineState
*ms
, int idx
);
226 * @base: address in guest physical address space where the memory
227 * address space for memory devices starts
228 * @mr: address space container for memory devices
230 typedef struct DeviceMemoryState
{
238 struct MachineState
{
241 Notifier sysbus_notifier
;
246 bool kernel_irqchip_allowed
;
247 bool kernel_irqchip_required
;
248 bool kernel_irqchip_split
;
254 bool dump_guest_core
;
258 bool igd_gfx_passthru
;
261 bool suppress_vmdesc
;
262 bool enforce_config_section
;
263 bool enable_graphics
;
264 char *memory_encryption
;
265 DeviceMemoryState
*device_memory
;
268 ram_addr_t maxram_size
;
270 const char *boot_order
;
271 char *kernel_filename
;
272 char *kernel_cmdline
;
273 char *initrd_filename
;
274 const char *cpu_type
;
275 AccelState
*accelerator
;
276 CPUArchIdList
*possible_cpus
;
277 struct NVDIMMState
*nvdimms_state
;
280 #define DEFINE_MACHINE(namestr, machine_initfn) \
281 static void machine_initfn##_class_init(ObjectClass *oc, void *data) \
283 MachineClass *mc = MACHINE_CLASS(oc); \
284 machine_initfn(mc); \
286 static const TypeInfo machine_initfn##_typeinfo = { \
287 .name = MACHINE_TYPE_NAME(namestr), \
288 .parent = TYPE_MACHINE, \
289 .class_init = machine_initfn##_class_init, \
291 static void machine_initfn##_register_types(void) \
293 type_register_static(&machine_initfn##_typeinfo); \
295 type_init(machine_initfn##_register_types)
297 extern GlobalProperty hw_compat_4_0
[];
298 extern const size_t hw_compat_4_0_len
;
300 extern GlobalProperty hw_compat_3_1
[];
301 extern const size_t hw_compat_3_1_len
;
303 extern GlobalProperty hw_compat_3_0
[];
304 extern const size_t hw_compat_3_0_len
;
306 extern GlobalProperty hw_compat_2_12
[];
307 extern const size_t hw_compat_2_12_len
;
309 extern GlobalProperty hw_compat_2_11
[];
310 extern const size_t hw_compat_2_11_len
;
312 extern GlobalProperty hw_compat_2_10
[];
313 extern const size_t hw_compat_2_10_len
;
315 extern GlobalProperty hw_compat_2_9
[];
316 extern const size_t hw_compat_2_9_len
;
318 extern GlobalProperty hw_compat_2_8
[];
319 extern const size_t hw_compat_2_8_len
;
321 extern GlobalProperty hw_compat_2_7
[];
322 extern const size_t hw_compat_2_7_len
;
324 extern GlobalProperty hw_compat_2_6
[];
325 extern const size_t hw_compat_2_6_len
;
327 extern GlobalProperty hw_compat_2_5
[];
328 extern const size_t hw_compat_2_5_len
;
330 extern GlobalProperty hw_compat_2_4
[];
331 extern const size_t hw_compat_2_4_len
;
333 extern GlobalProperty hw_compat_2_3
[];
334 extern const size_t hw_compat_2_3_len
;
336 extern GlobalProperty hw_compat_2_2
[];
337 extern const size_t hw_compat_2_2_len
;
339 extern GlobalProperty hw_compat_2_1
[];
340 extern const size_t hw_compat_2_1_len
;