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