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