Merge tag 'block-pull-request' of https://gitlab.com/stefanha/qemu into staging
[qemu.git] / include / hw / boards.h
1 /* Declarations for use by board files for creating devices. */
2
3 #ifndef HW_BOARDS_H
4 #define HW_BOARDS_H
5
6 #include "exec/memory.h"
7 #include "sysemu/hostmem.h"
8 #include "sysemu/blockdev.h"
9 #include "qapi/qapi-types-machine.h"
10 #include "qemu/module.h"
11 #include "qom/object.h"
12 #include "hw/core/cpu.h"
13
14 #define TYPE_MACHINE_SUFFIX "-machine"
15
16 /* Machine class name that needs to be used for class-name-based machine
17 * type lookup to work.
18 */
19 #define MACHINE_TYPE_NAME(machinename) (machinename TYPE_MACHINE_SUFFIX)
20
21 #define TYPE_MACHINE "machine"
22 #undef MACHINE /* BSD defines it and QEMU does not use it */
23 OBJECT_DECLARE_TYPE(MachineState, MachineClass, MACHINE)
24
25 extern MachineState *current_machine;
26
27 void machine_run_board_init(MachineState *machine, const char *mem_path, Error **errp);
28 bool machine_usb(MachineState *machine);
29 int machine_phandle_start(MachineState *machine);
30 bool machine_dump_guest_core(MachineState *machine);
31 bool machine_mem_merge(MachineState *machine);
32 HotpluggableCPUList *machine_query_hotpluggable_cpus(MachineState *machine);
33 void machine_set_cpu_numa_node(MachineState *machine,
34 const CpuInstanceProperties *props,
35 Error **errp);
36 void machine_parse_smp_config(MachineState *ms,
37 const SMPConfiguration *config, Error **errp);
38
39 /**
40 * machine_class_allow_dynamic_sysbus_dev: Add type to list of valid devices
41 * @mc: Machine class
42 * @type: type to allow (should be a subtype of TYPE_SYS_BUS_DEVICE)
43 *
44 * Add the QOM type @type to the list of devices of which are subtypes
45 * of TYPE_SYS_BUS_DEVICE but which are still permitted to be dynamically
46 * created (eg by the user on the command line with -device).
47 * By default if the user tries to create any devices on the command line
48 * that are subtypes of TYPE_SYS_BUS_DEVICE they will get an error message;
49 * for the special cases which are permitted for this machine model, the
50 * machine model class init code must call this function to add them
51 * to the list of specifically permitted devices.
52 */
53 void machine_class_allow_dynamic_sysbus_dev(MachineClass *mc, const char *type);
54
55 /**
56 * device_type_is_dynamic_sysbus: Check if type is an allowed sysbus device
57 * type for the machine class.
58 * @mc: Machine class
59 * @type: type to check (should be a subtype of TYPE_SYS_BUS_DEVICE)
60 *
61 * Returns: true if @type is a type in the machine's list of
62 * dynamically pluggable sysbus devices; otherwise false.
63 *
64 * Check if the QOM type @type is in the list of allowed sysbus device
65 * types (see machine_class_allowed_dynamic_sysbus_dev()).
66 * Note that if @type has a parent type in the list, it is allowed too.
67 */
68 bool device_type_is_dynamic_sysbus(MachineClass *mc, const char *type);
69
70 /**
71 * device_is_dynamic_sysbus: test whether device is a dynamic sysbus device
72 * @mc: Machine class
73 * @dev: device to check
74 *
75 * Returns: true if @dev is a sysbus device on the machine's list
76 * of dynamically pluggable sysbus devices; otherwise false.
77 *
78 * This function checks whether @dev is a valid dynamic sysbus device,
79 * by first confirming that it is a sysbus device and then checking it
80 * against the list of permitted dynamic sysbus devices which has been
81 * set up by the machine using machine_class_allow_dynamic_sysbus_dev().
82 *
83 * It is valid to call this with something that is not a subclass of
84 * TYPE_SYS_BUS_DEVICE; the function will return false in this case.
85 * This allows hotplug callback functions to be written as:
86 * if (device_is_dynamic_sysbus(mc, dev)) {
87 * handle dynamic sysbus case;
88 * } else if (some other kind of hotplug) {
89 * handle that;
90 * }
91 */
92 bool device_is_dynamic_sysbus(MachineClass *mc, DeviceState *dev);
93
94 /*
95 * Checks that backend isn't used, preps it for exclusive usage and
96 * returns migratable MemoryRegion provided by backend.
97 */
98 MemoryRegion *machine_consume_memdev(MachineState *machine,
99 HostMemoryBackend *backend);
100
101 /**
102 * CPUArchId:
103 * @arch_id - architecture-dependent CPU ID of present or possible CPU
104 * @cpu - pointer to corresponding CPU object if it's present on NULL otherwise
105 * @type - QOM class name of possible @cpu object
106 * @props - CPU object properties, initialized by board
107 * #vcpus_count - number of threads provided by @cpu object
108 */
109 typedef struct CPUArchId {
110 uint64_t arch_id;
111 int64_t vcpus_count;
112 CpuInstanceProperties props;
113 Object *cpu;
114 const char *type;
115 } CPUArchId;
116
117 /**
118 * CPUArchIdList:
119 * @len - number of @CPUArchId items in @cpus array
120 * @cpus - array of present or possible CPUs for current machine configuration
121 */
122 typedef struct {
123 int len;
124 CPUArchId cpus[];
125 } CPUArchIdList;
126
127 /**
128 * SMPCompatProps:
129 * @prefer_sockets - whether sockets are preferred over cores in smp parsing
130 * @dies_supported - whether dies are supported by the machine
131 * @clusters_supported - whether clusters are supported by the machine
132 * @has_clusters - whether clusters are explicitly specified in the user
133 * provided SMP configuration
134 */
135 typedef struct {
136 bool prefer_sockets;
137 bool dies_supported;
138 bool clusters_supported;
139 bool has_clusters;
140 } SMPCompatProps;
141
142 /**
143 * MachineClass:
144 * @deprecation_reason: If set, the machine is marked as deprecated. The
145 * string should provide some clear information about what to use instead.
146 * @max_cpus: maximum number of CPUs supported. Default: 1
147 * @min_cpus: minimum number of CPUs supported. Default: 1
148 * @default_cpus: number of CPUs instantiated if none are specified. Default: 1
149 * @is_default:
150 * If true QEMU will use this machine by default if no '-M' option is given.
151 * @get_hotplug_handler: this function is called during bus-less
152 * device hotplug. If defined it returns pointer to an instance
153 * of HotplugHandler object, which handles hotplug operation
154 * for a given @dev. It may return NULL if @dev doesn't require
155 * any actions to be performed by hotplug handler.
156 * @cpu_index_to_instance_props:
157 * used to provide @cpu_index to socket/core/thread number mapping, allowing
158 * legacy code to perform maping from cpu_index to topology properties
159 * Returns: tuple of socket/core/thread ids given cpu_index belongs to.
160 * used to provide @cpu_index to socket number mapping, allowing
161 * a machine to group CPU threads belonging to the same socket/package
162 * Returns: socket number given cpu_index belongs to.
163 * @hw_version:
164 * Value of QEMU_VERSION when the machine was added to QEMU.
165 * Set only by old machines because they need to keep
166 * compatibility on code that exposed QEMU_VERSION to guests in
167 * the past (and now use qemu_hw_version()).
168 * @possible_cpu_arch_ids:
169 * Returns an array of @CPUArchId architecture-dependent CPU IDs
170 * which includes CPU IDs for present and possible to hotplug CPUs.
171 * Caller is responsible for freeing returned list.
172 * @get_default_cpu_node_id:
173 * returns default board specific node_id value for CPU slot specified by
174 * index @idx in @ms->possible_cpus[]
175 * @has_hotpluggable_cpus:
176 * If true, board supports CPUs creation with -device/device_add.
177 * @default_cpu_type:
178 * specifies default CPU_TYPE, which will be used for parsing target
179 * specific features and for creating CPUs if CPU name wasn't provided
180 * explicitly at CLI
181 * @minimum_page_bits:
182 * If non-zero, the board promises never to create a CPU with a page size
183 * smaller than this, so QEMU can use a more efficient larger page
184 * size than the target architecture's minimum. (Attempting to create
185 * such a CPU will fail.) Note that changing this is a migration
186 * compatibility break for the machine.
187 * @ignore_memory_transaction_failures:
188 * If this is flag is true then the CPU will ignore memory transaction
189 * failures which should cause the CPU to take an exception due to an
190 * access to an unassigned physical address; the transaction will instead
191 * return zero (for a read) or be ignored (for a write). This should be
192 * set only by legacy board models which rely on the old RAZ/WI behaviour
193 * for handling devices that QEMU does not yet model. New board models
194 * should instead use "unimplemented-device" for all memory ranges where
195 * the guest will attempt to probe for a device that QEMU doesn't
196 * implement and a stub device is required.
197 * @kvm_type:
198 * Return the type of KVM corresponding to the kvm-type string option or
199 * computed based on other criteria such as the host kernel capabilities.
200 * kvm-type may be NULL if it is not needed.
201 * @numa_mem_supported:
202 * true if '--numa node.mem' option is supported and false otherwise
203 * @hotplug_allowed:
204 * If the hook is provided, then it'll be called for each device
205 * hotplug to check whether the device hotplug is allowed. Return
206 * true to grant allowance or false to reject the hotplug. When
207 * false is returned, an error must be set to show the reason of
208 * the rejection. If the hook is not provided, all hotplug will be
209 * allowed.
210 * @default_ram_id:
211 * Specifies inital RAM MemoryRegion name to be used for default backend
212 * creation if user explicitly hasn't specified backend with "memory-backend"
213 * property.
214 * It also will be used as a way to optin into "-m" option support.
215 * If it's not set by board, '-m' will be ignored and generic code will
216 * not create default RAM MemoryRegion.
217 * @fixup_ram_size:
218 * Amends user provided ram size (with -m option) using machine
219 * specific algorithm. To be used by old machine types for compat
220 * purposes only.
221 * Applies only to default memory backend, i.e., explicit memory backend
222 * wasn't used.
223 */
224 struct MachineClass {
225 /*< private >*/
226 ObjectClass parent_class;
227 /*< public >*/
228
229 const char *family; /* NULL iff @name identifies a standalone machtype */
230 char *name;
231 const char *alias;
232 const char *desc;
233 const char *deprecation_reason;
234
235 void (*init)(MachineState *state);
236 void (*reset)(MachineState *state, ShutdownCause reason);
237 void (*wakeup)(MachineState *state);
238 int (*kvm_type)(MachineState *machine, const char *arg);
239
240 BlockInterfaceType block_default_type;
241 int units_per_default_bus;
242 int max_cpus;
243 int min_cpus;
244 int default_cpus;
245 unsigned int no_serial:1,
246 no_parallel:1,
247 no_floppy:1,
248 no_cdrom:1,
249 no_sdcard:1,
250 pci_allow_0_address:1,
251 legacy_fw_cfg_order:1;
252 bool is_default;
253 const char *default_machine_opts;
254 const char *default_boot_order;
255 const char *default_display;
256 GPtrArray *compat_props;
257 const char *hw_version;
258 ram_addr_t default_ram_size;
259 const char *default_cpu_type;
260 bool default_kernel_irqchip_split;
261 bool option_rom_has_mr;
262 bool rom_file_has_mr;
263 int minimum_page_bits;
264 bool has_hotpluggable_cpus;
265 bool ignore_memory_transaction_failures;
266 int numa_mem_align_shift;
267 const char **valid_cpu_types;
268 strList *allowed_dynamic_sysbus_devices;
269 bool auto_enable_numa_with_memhp;
270 bool auto_enable_numa_with_memdev;
271 bool ignore_boot_device_suffixes;
272 bool smbus_no_migration_support;
273 bool nvdimm_supported;
274 bool numa_mem_supported;
275 bool auto_enable_numa;
276 SMPCompatProps smp_props;
277 const char *default_ram_id;
278
279 HotplugHandler *(*get_hotplug_handler)(MachineState *machine,
280 DeviceState *dev);
281 bool (*hotplug_allowed)(MachineState *state, DeviceState *dev,
282 Error **errp);
283 CpuInstanceProperties (*cpu_index_to_instance_props)(MachineState *machine,
284 unsigned cpu_index);
285 const CPUArchIdList *(*possible_cpu_arch_ids)(MachineState *machine);
286 int64_t (*get_default_cpu_node_id)(const MachineState *ms, int idx);
287 ram_addr_t (*fixup_ram_size)(ram_addr_t size);
288 };
289
290 /**
291 * DeviceMemoryState:
292 * @base: address in guest physical address space where the memory
293 * address space for memory devices starts
294 * @mr: address space container for memory devices
295 */
296 typedef struct DeviceMemoryState {
297 hwaddr base;
298 MemoryRegion mr;
299 } DeviceMemoryState;
300
301 /**
302 * CpuTopology:
303 * @cpus: the number of present logical processors on the machine
304 * @sockets: the number of sockets on the machine
305 * @dies: the number of dies in one socket
306 * @clusters: the number of clusters in one die
307 * @cores: the number of cores in one cluster
308 * @threads: the number of threads in one core
309 * @max_cpus: the maximum number of logical processors on the machine
310 */
311 typedef struct CpuTopology {
312 unsigned int cpus;
313 unsigned int sockets;
314 unsigned int dies;
315 unsigned int clusters;
316 unsigned int cores;
317 unsigned int threads;
318 unsigned int max_cpus;
319 } CpuTopology;
320
321 /**
322 * MachineState:
323 */
324 struct MachineState {
325 /*< private >*/
326 Object parent_obj;
327
328 /*< public >*/
329
330 void *fdt;
331 char *dtb;
332 char *dumpdtb;
333 int phandle_start;
334 char *dt_compatible;
335 bool dump_guest_core;
336 bool mem_merge;
337 bool usb;
338 bool usb_disabled;
339 char *firmware;
340 bool iommu;
341 bool suppress_vmdesc;
342 bool enable_graphics;
343 ConfidentialGuestSupport *cgs;
344 HostMemoryBackend *memdev;
345 /*
346 * convenience alias to ram_memdev_id backend memory region
347 * or to numa container memory region
348 */
349 MemoryRegion *ram;
350 DeviceMemoryState *device_memory;
351
352 ram_addr_t ram_size;
353 ram_addr_t maxram_size;
354 uint64_t ram_slots;
355 BootConfiguration boot_config;
356 char *kernel_filename;
357 char *kernel_cmdline;
358 char *initrd_filename;
359 const char *cpu_type;
360 AccelState *accelerator;
361 CPUArchIdList *possible_cpus;
362 CpuTopology smp;
363 struct NVDIMMState *nvdimms_state;
364 struct NumaState *numa_state;
365 };
366
367 #define DEFINE_MACHINE(namestr, machine_initfn) \
368 static void machine_initfn##_class_init(ObjectClass *oc, void *data) \
369 { \
370 MachineClass *mc = MACHINE_CLASS(oc); \
371 machine_initfn(mc); \
372 } \
373 static const TypeInfo machine_initfn##_typeinfo = { \
374 .name = MACHINE_TYPE_NAME(namestr), \
375 .parent = TYPE_MACHINE, \
376 .class_init = machine_initfn##_class_init, \
377 }; \
378 static void machine_initfn##_register_types(void) \
379 { \
380 type_register_static(&machine_initfn##_typeinfo); \
381 } \
382 type_init(machine_initfn##_register_types)
383
384 extern GlobalProperty hw_compat_7_2[];
385 extern const size_t hw_compat_7_2_len;
386
387 extern GlobalProperty hw_compat_7_1[];
388 extern const size_t hw_compat_7_1_len;
389
390 extern GlobalProperty hw_compat_7_0[];
391 extern const size_t hw_compat_7_0_len;
392
393 extern GlobalProperty hw_compat_6_2[];
394 extern const size_t hw_compat_6_2_len;
395
396 extern GlobalProperty hw_compat_6_1[];
397 extern const size_t hw_compat_6_1_len;
398
399 extern GlobalProperty hw_compat_6_0[];
400 extern const size_t hw_compat_6_0_len;
401
402 extern GlobalProperty hw_compat_5_2[];
403 extern const size_t hw_compat_5_2_len;
404
405 extern GlobalProperty hw_compat_5_1[];
406 extern const size_t hw_compat_5_1_len;
407
408 extern GlobalProperty hw_compat_5_0[];
409 extern const size_t hw_compat_5_0_len;
410
411 extern GlobalProperty hw_compat_4_2[];
412 extern const size_t hw_compat_4_2_len;
413
414 extern GlobalProperty hw_compat_4_1[];
415 extern const size_t hw_compat_4_1_len;
416
417 extern GlobalProperty hw_compat_4_0[];
418 extern const size_t hw_compat_4_0_len;
419
420 extern GlobalProperty hw_compat_3_1[];
421 extern const size_t hw_compat_3_1_len;
422
423 extern GlobalProperty hw_compat_3_0[];
424 extern const size_t hw_compat_3_0_len;
425
426 extern GlobalProperty hw_compat_2_12[];
427 extern const size_t hw_compat_2_12_len;
428
429 extern GlobalProperty hw_compat_2_11[];
430 extern const size_t hw_compat_2_11_len;
431
432 extern GlobalProperty hw_compat_2_10[];
433 extern const size_t hw_compat_2_10_len;
434
435 extern GlobalProperty hw_compat_2_9[];
436 extern const size_t hw_compat_2_9_len;
437
438 extern GlobalProperty hw_compat_2_8[];
439 extern const size_t hw_compat_2_8_len;
440
441 extern GlobalProperty hw_compat_2_7[];
442 extern const size_t hw_compat_2_7_len;
443
444 extern GlobalProperty hw_compat_2_6[];
445 extern const size_t hw_compat_2_6_len;
446
447 extern GlobalProperty hw_compat_2_5[];
448 extern const size_t hw_compat_2_5_len;
449
450 extern GlobalProperty hw_compat_2_4[];
451 extern const size_t hw_compat_2_4_len;
452
453 extern GlobalProperty hw_compat_2_3[];
454 extern const size_t hw_compat_2_3_len;
455
456 extern GlobalProperty hw_compat_2_2[];
457 extern const size_t hw_compat_2_2_len;
458
459 extern GlobalProperty hw_compat_2_1[];
460 extern const size_t hw_compat_2_1_len;
461
462 #endif