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