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