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