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