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