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