1 /* Declarations for use by board files for creating devices. */
6 #include "sysemu/blockdev.h"
7 #include "sysemu/accel.h"
9 #include "qom/object.h"
13 * memory_region_allocate_system_memory - Allocate a board's main memory
14 * @mr: the #MemoryRegion to be initialized
15 * @owner: the object that tracks the region's reference count
16 * @name: name of the memory region
17 * @ram_size: size of the region in bytes
19 * This function allocates the main memory for a board model, and
20 * initializes @mr appropriately. It also arranges for the memory
21 * to be migrated (by calling vmstate_register_ram_global()).
23 * Memory allocated via this function will be backed with the memory
24 * backend the user provided using "-mem-path" or "-numa node,memdev=..."
25 * if appropriate; this is typically used to cause host huge pages to be
26 * used. This function should therefore be called by a board exactly once,
27 * for the primary or largest RAM area it implements.
29 * For boards where the major RAM is split into two parts in the memory
30 * map, you can deal with this by calling memory_region_allocate_system_memory()
31 * once to get a MemoryRegion with enough RAM for both parts, and then
32 * creating alias MemoryRegions via memory_region_init_alias() which
33 * alias into different parts of the RAM MemoryRegion and can be mapped
34 * into the memory map in the appropriate places.
36 * Smaller pieces of memory (display RAM, static RAMs, etc) don't need
37 * to be backed via the -mem-path memory backend and can simply
38 * be created via memory_region_allocate_aux_memory() or
39 * memory_region_init_ram().
41 void memory_region_allocate_system_memory(MemoryRegion
*mr
, Object
*owner
,
45 #define TYPE_MACHINE_SUFFIX "-machine"
47 /* Machine class name that needs to be used for class-name-based machine
48 * type lookup to work.
50 #define MACHINE_TYPE_NAME(machinename) (machinename TYPE_MACHINE_SUFFIX)
52 #define TYPE_MACHINE "machine"
53 #undef MACHINE /* BSD defines it and QEMU does not use it */
54 #define MACHINE(obj) \
55 OBJECT_CHECK(MachineState, (obj), TYPE_MACHINE)
56 #define MACHINE_GET_CLASS(obj) \
57 OBJECT_GET_CLASS(MachineClass, (obj), TYPE_MACHINE)
58 #define MACHINE_CLASS(klass) \
59 OBJECT_CLASS_CHECK(MachineClass, (klass), TYPE_MACHINE)
61 MachineClass
*find_default_machine(void);
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 void machine_register_compat_props(MachineState
*machine
);
74 HotpluggableCPUList
*machine_query_hotpluggable_cpus(MachineState
*machine
);
75 void machine_set_cpu_numa_node(MachineState
*machine
,
76 const CpuInstanceProperties
*props
,
79 void machine_class_allow_dynamic_sysbus_dev(MachineClass
*mc
, const char *type
);
84 * @arch_id - architecture-dependent CPU ID of present or possible CPU
85 * @cpu - pointer to corresponding CPU object if it's present on NULL otherwise
86 * @type - QOM class name of possible @cpu object
87 * @props - CPU object properties, initialized by board
88 * #vcpus_count - number of threads provided by @cpu object
93 CpuInstanceProperties props
;
100 * @len - number of @CPUArchId items in @cpus array
101 * @cpus - array of present or possible CPUs for current machine configuration
110 * @deprecation_reason: If set, the machine is marked as deprecated. The
111 * string should provide some clear information about what to use instead.
112 * @max_cpus: maximum number of CPUs supported. Default: 1
113 * @min_cpus: minimum number of CPUs supported. Default: 1
114 * @default_cpus: number of CPUs instantiated if none are specified. Default: 1
115 * @get_hotplug_handler: this function is called during bus-less
116 * device hotplug. If defined it returns pointer to an instance
117 * of HotplugHandler object, which handles hotplug operation
118 * for a given @dev. It may return NULL if @dev doesn't require
119 * any actions to be performed by hotplug handler.
120 * @cpu_index_to_instance_props:
121 * used to provide @cpu_index to socket/core/thread number mapping, allowing
122 * legacy code to perform maping from cpu_index to topology properties
123 * Returns: tuple of socket/core/thread ids given cpu_index belongs to.
124 * used to provide @cpu_index to socket number mapping, allowing
125 * a machine to group CPU threads belonging to the same socket/package
126 * Returns: socket number given cpu_index belongs to.
128 * Value of QEMU_VERSION when the machine was added to QEMU.
129 * Set only by old machines because they need to keep
130 * compatibility on code that exposed QEMU_VERSION to guests in
131 * the past (and now use qemu_hw_version()).
132 * @possible_cpu_arch_ids:
133 * Returns an array of @CPUArchId architecture-dependent CPU IDs
134 * which includes CPU IDs for present and possible to hotplug CPUs.
135 * Caller is responsible for freeing returned list.
136 * @get_default_cpu_node_id:
137 * returns default board specific node_id value for CPU slot specified by
138 * index @idx in @ms->possible_cpus[]
139 * @has_hotpluggable_cpus:
140 * If true, board supports CPUs creation with -device/device_add.
142 * specifies default CPU_TYPE, which will be used for parsing target
143 * specific features and for creating CPUs if CPU name wasn't provided
145 * @minimum_page_bits:
146 * If non-zero, the board promises never to create a CPU with a page size
147 * smaller than this, so QEMU can use a more efficient larger page
148 * size than the target architecture's minimum. (Attempting to create
149 * such a CPU will fail.) Note that changing this is a migration
150 * compatibility break for the machine.
151 * @ignore_memory_transaction_failures:
152 * If this is flag is true then the CPU will ignore memory transaction
153 * failures which should cause the CPU to take an exception due to an
154 * access to an unassigned physical address; the transaction will instead
155 * return zero (for a read) or be ignored (for a write). This should be
156 * set only by legacy board models which rely on the old RAZ/WI behaviour
157 * for handling devices that QEMU does not yet model. New board models
158 * should instead use "unimplemented-device" for all memory ranges where
159 * the guest will attempt to probe for a device that QEMU doesn't
160 * implement and a stub device is required.
162 struct MachineClass
{
164 ObjectClass parent_class
;
167 const char *family
; /* NULL iff @name identifies a standalone machtype */
171 const char *deprecation_reason
;
173 void (*init
)(MachineState
*state
);
175 void (*hot_add_cpu
)(const int64_t id
, Error
**errp
);
176 int (*kvm_type
)(const char *arg
);
178 BlockInterfaceType block_default_type
;
179 int units_per_default_bus
;
183 unsigned int no_serial
:1,
189 pci_allow_0_address
:1,
190 legacy_fw_cfg_order
:1;
192 const char *default_machine_opts
;
193 const char *default_boot_order
;
194 const char *default_display
;
195 GArray
*compat_props
;
196 const char *hw_version
;
197 ram_addr_t default_ram_size
;
198 const char *default_cpu_type
;
199 bool option_rom_has_mr
;
200 bool rom_file_has_mr
;
201 int minimum_page_bits
;
202 bool has_hotpluggable_cpus
;
203 bool ignore_memory_transaction_failures
;
204 int numa_mem_align_shift
;
205 const char **valid_cpu_types
;
206 strList
*allowed_dynamic_sysbus_devices
;
207 bool auto_enable_numa_with_memhp
;
208 void (*numa_auto_assign_ram
)(MachineClass
*mc
, NodeInfo
*nodes
,
209 int nb_nodes
, ram_addr_t size
);
211 HotplugHandler
*(*get_hotplug_handler
)(MachineState
*machine
,
213 CpuInstanceProperties (*cpu_index_to_instance_props
)(MachineState
*machine
,
215 const CPUArchIdList
*(*possible_cpu_arch_ids
)(MachineState
*machine
);
216 int64_t (*get_default_cpu_node_id
)(const MachineState
*ms
, int idx
);
221 * @base: address in guest physical address space where the memory
222 * address space for memory devices starts
223 * @mr: address space container for memory devices
225 typedef struct DeviceMemoryState
{
233 struct MachineState
{
236 Notifier sysbus_notifier
;
241 bool kernel_irqchip_allowed
;
242 bool kernel_irqchip_required
;
243 bool kernel_irqchip_split
;
249 bool dump_guest_core
;
253 bool igd_gfx_passthru
;
256 bool suppress_vmdesc
;
257 bool enforce_config_section
;
258 bool enable_graphics
;
259 char *memory_encryption
;
260 DeviceMemoryState
*device_memory
;
263 ram_addr_t maxram_size
;
265 const char *boot_order
;
266 char *kernel_filename
;
267 char *kernel_cmdline
;
268 char *initrd_filename
;
269 const char *cpu_type
;
270 AccelState
*accelerator
;
271 CPUArchIdList
*possible_cpus
;
274 #define DEFINE_MACHINE(namestr, machine_initfn) \
275 static void machine_initfn##_class_init(ObjectClass *oc, void *data) \
277 MachineClass *mc = MACHINE_CLASS(oc); \
278 machine_initfn(mc); \
280 static const TypeInfo machine_initfn##_typeinfo = { \
281 .name = MACHINE_TYPE_NAME(namestr), \
282 .parent = TYPE_MACHINE, \
283 .class_init = machine_initfn##_class_init, \
285 static void machine_initfn##_register_types(void) \
287 type_register_static(&machine_initfn##_typeinfo); \
289 type_init(machine_initfn##_register_types)
291 #define SET_MACHINE_COMPAT(m, COMPAT) \
294 static GlobalProperty props[] = { \
296 { /* end of list */ } \
298 if (!m->compat_props) { \
299 m->compat_props = g_array_new(false, false, sizeof(void *)); \
301 for (i = 0; props[i].driver != NULL; i++) { \
302 GlobalProperty *prop = &props[i]; \
303 g_array_append_val(m->compat_props, prop); \