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