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 "qapi/qapi-types-machine.h" 10 #include "qemu/module.h" 11 #include "qom/object.h" 12 #include "hw/core/cpu.h" 13 14 #define TYPE_MACHINE_SUFFIX "-machine" 15 16 /* Machine class name that needs to be used for class-name-based machine 17 * type lookup to work. 18 */ 19 #define MACHINE_TYPE_NAME(machinename) (machinename TYPE_MACHINE_SUFFIX) 20 21 #define TYPE_MACHINE "machine" 22 #undef MACHINE /* BSD defines it and QEMU does not use it */ 23 OBJECT_DECLARE_TYPE(MachineState, MachineClass, MACHINE) 24 25 extern MachineState *current_machine; 26 27 /** 28 * machine_class_default_cpu_type: Return the machine default CPU type. 29 * @mc: Machine class 30 */ 31 const char *machine_class_default_cpu_type(MachineClass *mc); 32 33 void machine_add_audiodev_property(MachineClass *mc); 34 void machine_run_board_init(MachineState *machine, const char *mem_path, Error **errp); 35 bool machine_usb(MachineState *machine); 36 int machine_phandle_start(MachineState *machine); 37 bool machine_dump_guest_core(MachineState *machine); 38 bool machine_mem_merge(MachineState *machine); 39 bool machine_require_guest_memfd(MachineState *machine); 40 HotpluggableCPUList *machine_query_hotpluggable_cpus(MachineState *machine); 41 void machine_set_cpu_numa_node(MachineState *machine, 42 const CpuInstanceProperties *props, 43 Error **errp); 44 void machine_parse_smp_config(MachineState *ms, 45 const SMPConfiguration *config, Error **errp); 46 unsigned int machine_topo_get_cores_per_socket(const MachineState *ms); 47 unsigned int machine_topo_get_threads_per_socket(const MachineState *ms); 48 void machine_memory_devices_init(MachineState *ms, hwaddr base, uint64_t size); 49 50 /** 51 * machine_class_allow_dynamic_sysbus_dev: Add type to list of valid devices 52 * @mc: Machine class 53 * @type: type to allow (should be a subtype of TYPE_SYS_BUS_DEVICE) 54 * 55 * Add the QOM type @type to the list of devices of which are subtypes 56 * of TYPE_SYS_BUS_DEVICE but which are still permitted to be dynamically 57 * created (eg by the user on the command line with -device). 58 * By default if the user tries to create any devices on the command line 59 * that are subtypes of TYPE_SYS_BUS_DEVICE they will get an error message; 60 * for the special cases which are permitted for this machine model, the 61 * machine model class init code must call this function to add them 62 * to the list of specifically permitted devices. 63 */ 64 void machine_class_allow_dynamic_sysbus_dev(MachineClass *mc, const char *type); 65 66 /** 67 * device_type_is_dynamic_sysbus: Check if type is an allowed sysbus device 68 * type for the machine class. 69 * @mc: Machine class 70 * @type: type to check (should be a subtype of TYPE_SYS_BUS_DEVICE) 71 * 72 * Returns: true if @type is a type in the machine's list of 73 * dynamically pluggable sysbus devices; otherwise false. 74 * 75 * Check if the QOM type @type is in the list of allowed sysbus device 76 * types (see machine_class_allowed_dynamic_sysbus_dev()). 77 * Note that if @type has a parent type in the list, it is allowed too. 78 */ 79 bool device_type_is_dynamic_sysbus(MachineClass *mc, const char *type); 80 81 /** 82 * device_is_dynamic_sysbus: test whether device is a dynamic sysbus device 83 * @mc: Machine class 84 * @dev: device to check 85 * 86 * Returns: true if @dev is a sysbus device on the machine's list 87 * of dynamically pluggable sysbus devices; otherwise false. 88 * 89 * This function checks whether @dev is a valid dynamic sysbus device, 90 * by first confirming that it is a sysbus device and then checking it 91 * against the list of permitted dynamic sysbus devices which has been 92 * set up by the machine using machine_class_allow_dynamic_sysbus_dev(). 93 * 94 * It is valid to call this with something that is not a subclass of 95 * TYPE_SYS_BUS_DEVICE; the function will return false in this case. 96 * This allows hotplug callback functions to be written as: 97 * if (device_is_dynamic_sysbus(mc, dev)) { 98 * handle dynamic sysbus case; 99 * } else if (some other kind of hotplug) { 100 * handle that; 101 * } 102 */ 103 bool device_is_dynamic_sysbus(MachineClass *mc, DeviceState *dev); 104 105 /* 106 * Checks that backend isn't used, preps it for exclusive usage and 107 * returns migratable MemoryRegion provided by backend. 108 */ 109 MemoryRegion *machine_consume_memdev(MachineState *machine, 110 HostMemoryBackend *backend); 111 112 /** 113 * CPUArchId: 114 * @arch_id - architecture-dependent CPU ID of present or possible CPU 115 * @cpu - pointer to corresponding CPU object if it's present on NULL otherwise 116 * @type - QOM class name of possible @cpu object 117 * @props - CPU object properties, initialized by board 118 * #vcpus_count - number of threads provided by @cpu object 119 */ 120 typedef struct CPUArchId { 121 uint64_t arch_id; 122 int64_t vcpus_count; 123 CpuInstanceProperties props; 124 CPUState *cpu; 125 const char *type; 126 } CPUArchId; 127 128 /** 129 * CPUArchIdList: 130 * @len - number of @CPUArchId items in @cpus array 131 * @cpus - array of present or possible CPUs for current machine configuration 132 */ 133 typedef struct { 134 int len; 135 CPUArchId cpus[]; 136 } CPUArchIdList; 137 138 /** 139 * SMPCompatProps: 140 * @prefer_sockets - whether sockets are preferred over cores in smp parsing 141 * @dies_supported - whether dies are supported by the machine 142 * @clusters_supported - whether clusters are supported by the machine 143 * @has_clusters - whether clusters are explicitly specified in the user 144 * provided SMP configuration 145 * @books_supported - whether books are supported by the machine 146 * @drawers_supported - whether drawers are supported by the machine 147 * @modules_supported - whether modules are supported by the machine 148 */ 149 typedef struct { 150 bool prefer_sockets; 151 bool dies_supported; 152 bool clusters_supported; 153 bool has_clusters; 154 bool books_supported; 155 bool drawers_supported; 156 bool modules_supported; 157 } SMPCompatProps; 158 159 /** 160 * MachineClass: 161 * @deprecation_reason: If set, the machine is marked as deprecated. The 162 * string should provide some clear information about what to use instead. 163 * @max_cpus: maximum number of CPUs supported. Default: 1 164 * @min_cpus: minimum number of CPUs supported. Default: 1 165 * @default_cpus: number of CPUs instantiated if none are specified. Default: 1 166 * @is_default: 167 * If true QEMU will use this machine by default if no '-M' option is given. 168 * @get_hotplug_handler: this function is called during bus-less 169 * device hotplug. If defined it returns pointer to an instance 170 * of HotplugHandler object, which handles hotplug operation 171 * for a given @dev. It may return NULL if @dev doesn't require 172 * any actions to be performed by hotplug handler. 173 * @cpu_index_to_instance_props: 174 * used to provide @cpu_index to socket/core/thread number mapping, allowing 175 * legacy code to perform mapping from cpu_index to topology properties 176 * Returns: tuple of socket/core/thread ids given cpu_index belongs to. 177 * used to provide @cpu_index to socket number mapping, allowing 178 * a machine to group CPU threads belonging to the same socket/package 179 * Returns: socket number given cpu_index belongs to. 180 * @hw_version: 181 * Value of QEMU_VERSION when the machine was added to QEMU. 182 * Set only by old machines because they need to keep 183 * compatibility on code that exposed QEMU_VERSION to guests in 184 * the past (and now use qemu_hw_version()). 185 * @possible_cpu_arch_ids: 186 * Returns an array of @CPUArchId architecture-dependent CPU IDs 187 * which includes CPU IDs for present and possible to hotplug CPUs. 188 * Caller is responsible for freeing returned list. 189 * @get_default_cpu_node_id: 190 * returns default board specific node_id value for CPU slot specified by 191 * index @idx in @ms->possible_cpus[] 192 * @has_hotpluggable_cpus: 193 * If true, board supports CPUs creation with -device/device_add. 194 * @default_cpu_type: 195 * specifies default CPU_TYPE, which will be used for parsing target 196 * specific features and for creating CPUs if CPU name wasn't provided 197 * explicitly at CLI 198 * @minimum_page_bits: 199 * If non-zero, the board promises never to create a CPU with a page size 200 * smaller than this, so QEMU can use a more efficient larger page 201 * size than the target architecture's minimum. (Attempting to create 202 * such a CPU will fail.) Note that changing this is a migration 203 * compatibility break for the machine. 204 * @ignore_memory_transaction_failures: 205 * If this is flag is true then the CPU will ignore memory transaction 206 * failures which should cause the CPU to take an exception due to an 207 * access to an unassigned physical address; the transaction will instead 208 * return zero (for a read) or be ignored (for a write). This should be 209 * set only by legacy board models which rely on the old RAZ/WI behaviour 210 * for handling devices that QEMU does not yet model. New board models 211 * should instead use "unimplemented-device" for all memory ranges where 212 * the guest will attempt to probe for a device that QEMU doesn't 213 * implement and a stub device is required. 214 * @kvm_type: 215 * Return the type of KVM corresponding to the kvm-type string option or 216 * computed based on other criteria such as the host kernel capabilities. 217 * kvm-type may be NULL if it is not needed. 218 * @numa_mem_supported: 219 * true if '--numa node.mem' option is supported and false otherwise 220 * @hotplug_allowed: 221 * If the hook is provided, then it'll be called for each device 222 * hotplug to check whether the device hotplug is allowed. Return 223 * true to grant allowance or false to reject the hotplug. When 224 * false is returned, an error must be set to show the reason of 225 * the rejection. If the hook is not provided, all hotplug will be 226 * allowed. 227 * @default_ram_id: 228 * Specifies initial RAM MemoryRegion name to be used for default backend 229 * creation if user explicitly hasn't specified backend with "memory-backend" 230 * property. 231 * It also will be used as a way to option into "-m" option support. 232 * If it's not set by board, '-m' will be ignored and generic code will 233 * not create default RAM MemoryRegion. 234 * @fixup_ram_size: 235 * Amends user provided ram size (with -m option) using machine 236 * specific algorithm. To be used by old machine types for compat 237 * purposes only. 238 * Applies only to default memory backend, i.e., explicit memory backend 239 * wasn't used. 240 * @smbios_memory_device_size: 241 * Default size of memory device, 242 * SMBIOS 3.1.0 "7.18 Memory Device (Type 17)" 243 */ 244 struct MachineClass { 245 /*< private >*/ 246 ObjectClass parent_class; 247 /*< public >*/ 248 249 const char *family; /* NULL iff @name identifies a standalone machtype */ 250 char *name; 251 const char *alias; 252 const char *desc; 253 const char *deprecation_reason; 254 255 void (*init)(MachineState *state); 256 void (*reset)(MachineState *state, ShutdownCause reason); 257 void (*wakeup)(MachineState *state); 258 int (*kvm_type)(MachineState *machine, const char *arg); 259 260 BlockInterfaceType block_default_type; 261 int units_per_default_bus; 262 int max_cpus; 263 int min_cpus; 264 int default_cpus; 265 unsigned int no_serial:1, 266 no_parallel:1, 267 no_floppy:1, 268 no_cdrom:1, 269 no_sdcard:1, 270 pci_allow_0_address:1, 271 legacy_fw_cfg_order:1; 272 bool is_default; 273 const char *default_machine_opts; 274 const char *default_boot_order; 275 const char *default_display; 276 const char *default_nic; 277 GPtrArray *compat_props; 278 const char *hw_version; 279 ram_addr_t default_ram_size; 280 const char *default_cpu_type; 281 bool default_kernel_irqchip_split; 282 bool option_rom_has_mr; 283 bool rom_file_has_mr; 284 int minimum_page_bits; 285 bool has_hotpluggable_cpus; 286 bool ignore_memory_transaction_failures; 287 int numa_mem_align_shift; 288 const char * const *valid_cpu_types; 289 strList *allowed_dynamic_sysbus_devices; 290 bool auto_enable_numa_with_memhp; 291 bool auto_enable_numa_with_memdev; 292 bool ignore_boot_device_suffixes; 293 bool smbus_no_migration_support; 294 bool nvdimm_supported; 295 bool numa_mem_supported; 296 bool auto_enable_numa; 297 bool cpu_cluster_has_numa_boundary; 298 SMPCompatProps smp_props; 299 const char *default_ram_id; 300 301 HotplugHandler *(*get_hotplug_handler)(MachineState *machine, 302 DeviceState *dev); 303 bool (*hotplug_allowed)(MachineState *state, DeviceState *dev, 304 Error **errp); 305 CpuInstanceProperties (*cpu_index_to_instance_props)(MachineState *machine, 306 unsigned cpu_index); 307 const CPUArchIdList *(*possible_cpu_arch_ids)(MachineState *machine); 308 int64_t (*get_default_cpu_node_id)(const MachineState *ms, int idx); 309 ram_addr_t (*fixup_ram_size)(ram_addr_t size); 310 uint64_t smbios_memory_device_size; 311 }; 312 313 /** 314 * DeviceMemoryState: 315 * @base: address in guest physical address space where the memory 316 * address space for memory devices starts 317 * @mr: memory region container for memory devices 318 * @as: address space for memory devices 319 * @listener: memory listener used to track used memslots in the address space 320 * @dimm_size: the sum of plugged DIMMs' sizes 321 * @used_region_size: the part of @mr already used by memory devices 322 * @required_memslots: the number of memslots required by memory devices 323 * @used_memslots: the number of memslots currently used by memory devices 324 * @memslot_auto_decision_active: whether any plugged memory device 325 * automatically decided to use more than 326 * one memslot 327 */ 328 typedef struct DeviceMemoryState { 329 hwaddr base; 330 MemoryRegion mr; 331 AddressSpace as; 332 MemoryListener listener; 333 uint64_t dimm_size; 334 uint64_t used_region_size; 335 unsigned int required_memslots; 336 unsigned int used_memslots; 337 unsigned int memslot_auto_decision_active; 338 } DeviceMemoryState; 339 340 /** 341 * CpuTopology: 342 * @cpus: the number of present logical processors on the machine 343 * @drawers: the number of drawers on the machine 344 * @books: the number of books in one drawer 345 * @sockets: the number of sockets in one book 346 * @dies: the number of dies in one socket 347 * @clusters: the number of clusters in one die 348 * @modules: the number of modules in one cluster 349 * @cores: the number of cores in one cluster 350 * @threads: the number of threads in one core 351 * @max_cpus: the maximum number of logical processors on the machine 352 */ 353 typedef struct CpuTopology { 354 unsigned int cpus; 355 unsigned int drawers; 356 unsigned int books; 357 unsigned int sockets; 358 unsigned int dies; 359 unsigned int clusters; 360 unsigned int modules; 361 unsigned int cores; 362 unsigned int threads; 363 unsigned int max_cpus; 364 } CpuTopology; 365 366 /** 367 * MachineState: 368 */ 369 struct MachineState { 370 /*< private >*/ 371 Object parent_obj; 372 373 /*< public >*/ 374 375 void *fdt; 376 char *dtb; 377 char *dumpdtb; 378 int phandle_start; 379 char *dt_compatible; 380 bool dump_guest_core; 381 bool mem_merge; 382 bool usb; 383 bool usb_disabled; 384 char *firmware; 385 bool iommu; 386 bool suppress_vmdesc; 387 bool enable_graphics; 388 ConfidentialGuestSupport *cgs; 389 HostMemoryBackend *memdev; 390 /* 391 * convenience alias to ram_memdev_id backend memory region 392 * or to numa container memory region 393 */ 394 MemoryRegion *ram; 395 DeviceMemoryState *device_memory; 396 397 /* 398 * Included in MachineState for simplicity, but not supported 399 * unless machine_add_audiodev_property is called. Boards 400 * that have embedded audio devices can call it from the 401 * machine init function and forward the property to the device. 402 */ 403 char *audiodev; 404 405 ram_addr_t ram_size; 406 ram_addr_t maxram_size; 407 uint64_t ram_slots; 408 BootConfiguration boot_config; 409 char *kernel_filename; 410 char *kernel_cmdline; 411 char *initrd_filename; 412 const char *cpu_type; 413 AccelState *accelerator; 414 CPUArchIdList *possible_cpus; 415 CpuTopology smp; 416 struct NVDIMMState *nvdimms_state; 417 struct NumaState *numa_state; 418 }; 419 420 /* 421 * The macros which follow are intended to facilitate the 422 * definition of versioned machine types, using a somewhat 423 * similar pattern across targets. 424 * 425 * For example, a macro that can be used to define versioned 426 * 'virt' machine types would look like: 427 * 428 * #define DEFINE_VIRT_MACHINE_IMPL(latest, ...) \ 429 * static void MACHINE_VER_SYM(class_init, virt, __VA_ARGS__)( \ 430 * ObjectClass *oc, \ 431 * void *data) \ 432 * { \ 433 * MachineClass *mc = MACHINE_CLASS(oc); \ 434 * MACHINE_VER_SYM(options, virt, __VA_ARGS__)(mc); \ 435 * mc->desc = "QEMU " MACHINE_VER_STR(__VA_ARGS__) " Virtual Machine"; \ 436 * MACHINE_VER_DEPRECATION(__VA_ARGS__); \ 437 * if (latest) { \ 438 * mc->alias = "virt"; \ 439 * } \ 440 * } \ 441 * static const TypeInfo MACHINE_VER_SYM(info, virt, __VA_ARGS__) = { \ 442 * .name = MACHINE_VER_TYPE_NAME("virt", __VA_ARGS__), \ 443 * .parent = TYPE_VIRT_MACHINE, \ 444 * .class_init = MACHINE_VER_SYM(class_init, virt, __VA_ARGS__), \ 445 * }; \ 446 * static void MACHINE_VER_SYM(register, virt, __VA_ARGS__)(void) \ 447 * { \ 448 * MACHINE_VER_DELETION(__VA_ARGS__); \ 449 * type_register_static(&MACHINE_VER_SYM(info, virt, __VA_ARGS__)); \ 450 * } \ 451 * type_init(MACHINE_VER_SYM(register, virt, __VA_ARGS__)); 452 * 453 * Following this, one (or more) helpers can be added for 454 * whichever scenarios need to be catered for with a machine: 455 * 456 * // Normal 2 digit, marked as latest e.g. 'virt-9.0' 457 * #define DEFINE_VIRT_MACHINE_LATEST(major, minor) \ 458 * DEFINE_VIRT_MACHINE_IMPL(true, major, minor) 459 * 460 * // Normal 2 digit e.g. 'virt-9.0' 461 * #define DEFINE_VIRT_MACHINE(major, minor) \ 462 * DEFINE_VIRT_MACHINE_IMPL(false, major, minor) 463 * 464 * // Bugfix 3 digit e.g. 'virt-9.0.1' 465 * #define DEFINE_VIRT_MACHINE_BUGFIX(major, minor, micro) \ 466 * DEFINE_VIRT_MACHINE_IMPL(false, major, minor, micro) 467 * 468 * // Tagged 2 digit e.g. 'virt-9.0-extra' 469 * #define DEFINE_VIRT_MACHINE_TAGGED(major, minor, tag) \ 470 * DEFINE_VIRT_MACHINE_IMPL(false, major, minor, _, tag) 471 * 472 * // Tagged bugfix 2 digit e.g. 'virt-9.0.1-extra' 473 * #define DEFINE_VIRT_MACHINE_TAGGED(major, minor, micro, tag) \ 474 * DEFINE_VIRT_MACHINE_IMPL(false, major, minor, micro, _, tag) 475 */ 476 477 /* 478 * Helper for dispatching different macros based on how 479 * many __VA_ARGS__ are passed. Supports 1 to 5 variadic 480 * arguments, with the called target able to be prefixed 481 * with 0 or more fixed arguments too. To be called thus: 482 * 483 * _MACHINE_VER_PICK(__VA_ARGS, 484 * MACRO_MATCHING_5_ARGS, 485 * MACRO_MATCHING_4_ARGS, 486 * MACRO_MATCHING_3_ARGS, 487 * MACRO_MATCHING_2_ARGS, 488 * MACRO_MATCHING_1_ARG) (FIXED-ARG-1, 489 * ..., 490 * FIXED-ARG-N, 491 * __VA_ARGS__) 492 */ 493 #define _MACHINE_VER_PICK(x1, x2, x3, x4, x5, x6, ...) x6 494 495 /* 496 * Construct a human targeted machine version string. 497 * 498 * Can be invoked with various signatures 499 * 500 * MACHINE_VER_STR(sym, prefix, major, minor) 501 * MACHINE_VER_STR(sym, prefix, major, minor, micro) 502 * MACHINE_VER_STR(sym, prefix, major, minor, _, tag) 503 * MACHINE_VER_STR(sym, prefix, major, minor, micro, _, tag) 504 * 505 * Respectively emitting symbols with the format 506 * 507 * "{major}.{minor}" 508 * "{major}.{minor}-{tag}" 509 * "{major}.{minor}.{micro}" 510 * "{major}.{minor}.{micro}-{tag}" 511 */ 512 #define _MACHINE_VER_STR2(major, minor) \ 513 #major "." #minor 514 515 #define _MACHINE_VER_STR3(major, minor, micro) \ 516 #major "." #minor "." #micro 517 518 #define _MACHINE_VER_STR4(major, minor, _unused_, tag) \ 519 #major "." #minor "-" #tag 520 521 #define _MACHINE_VER_STR5(major, minor, micro, _unused_, tag) \ 522 #major "." #minor "." #micro "-" #tag 523 524 #define MACHINE_VER_STR(...) \ 525 _MACHINE_VER_PICK(__VA_ARGS__, \ 526 _MACHINE_VER_STR5, \ 527 _MACHINE_VER_STR4, \ 528 _MACHINE_VER_STR3, \ 529 _MACHINE_VER_STR2) (__VA_ARGS__) 530 531 532 /* 533 * Construct a QAPI type name for a versioned machine 534 * type 535 * 536 * Can be invoked with various signatures 537 * 538 * MACHINE_VER_TYPE_NAME(prefix, major, minor) 539 * MACHINE_VER_TYPE_NAME(prefix, major, minor, micro) 540 * MACHINE_VER_TYPE_NAME(prefix, major, minor, _, tag) 541 * MACHINE_VER_TYPE_NAME(prefix, major, minor, micro, _, tag) 542 * 543 * Respectively emitting symbols with the format 544 * 545 * "{prefix}-{major}.{minor}" 546 * "{prefix}-{major}.{minor}.{micro}" 547 * "{prefix}-{major}.{minor}-{tag}" 548 * "{prefix}-{major}.{minor}.{micro}-{tag}" 549 */ 550 #define _MACHINE_VER_TYPE_NAME2(prefix, major, minor) \ 551 prefix "-" #major "." #minor TYPE_MACHINE_SUFFIX 552 553 #define _MACHINE_VER_TYPE_NAME3(prefix, major, minor, micro) \ 554 prefix "-" #major "." #minor "." #micro TYPE_MACHINE_SUFFIX 555 556 #define _MACHINE_VER_TYPE_NAME4(prefix, major, minor, _unused_, tag) \ 557 prefix "-" #major "." #minor "-" #tag TYPE_MACHINE_SUFFIX 558 559 #define _MACHINE_VER_TYPE_NAME5(prefix, major, minor, micro, _unused_, tag) \ 560 prefix "-" #major "." #minor "." #micro "-" #tag TYPE_MACHINE_SUFFIX 561 562 #define MACHINE_VER_TYPE_NAME(prefix, ...) \ 563 _MACHINE_VER_PICK(__VA_ARGS__, \ 564 _MACHINE_VER_TYPE_NAME5, \ 565 _MACHINE_VER_TYPE_NAME4, \ 566 _MACHINE_VER_TYPE_NAME3, \ 567 _MACHINE_VER_TYPE_NAME2) (prefix, __VA_ARGS__) 568 569 /* 570 * Construct a name for a versioned machine type that is 571 * suitable for use as a C symbol (function/variable/etc). 572 * 573 * Can be invoked with various signatures 574 * 575 * MACHINE_VER_SYM(sym, prefix, major, minor) 576 * MACHINE_VER_SYM(sym, prefix, major, minor, micro) 577 * MACHINE_VER_SYM(sym, prefix, major, minor, _, tag) 578 * MACHINE_VER_SYM(sym, prefix, major, minor, micro, _, tag) 579 * 580 * Respectively emitting symbols with the format 581 * 582 * {prefix}_machine_{major}_{minor}_{sym} 583 * {prefix}_machine_{major}_{minor}_{micro}_{sym} 584 * {prefix}_machine_{major}_{minor}_{tag}_{sym} 585 * {prefix}_machine_{major}_{minor}_{micro}_{tag}_{sym} 586 */ 587 #define _MACHINE_VER_SYM2(sym, prefix, major, minor) \ 588 prefix ## _machine_ ## major ## _ ## minor ## _ ## sym 589 590 #define _MACHINE_VER_SYM3(sym, prefix, major, minor, micro) \ 591 prefix ## _machine_ ## major ## _ ## minor ## _ ## micro ## _ ## sym 592 593 #define _MACHINE_VER_SYM4(sym, prefix, major, minor, _unused_, tag) \ 594 prefix ## _machine_ ## major ## _ ## minor ## _ ## tag ## _ ## sym 595 596 #define _MACHINE_VER_SYM5(sym, prefix, major, minor, micro, _unused_, tag) \ 597 prefix ## _machine_ ## major ## _ ## minor ## _ ## micro ## _ ## tag ## _ ## sym 598 599 #define MACHINE_VER_SYM(sym, prefix, ...) \ 600 _MACHINE_VER_PICK(__VA_ARGS__, \ 601 _MACHINE_VER_SYM5, \ 602 _MACHINE_VER_SYM4, \ 603 _MACHINE_VER_SYM3, \ 604 _MACHINE_VER_SYM2) (sym, prefix, __VA_ARGS__) 605 606 607 /* 608 * How many years/major releases for each phase 609 * of the life cycle. Assumes use of versioning 610 * scheme where major is bumped each year 611 */ 612 #define MACHINE_VER_DELETION_MAJOR 6 613 #define MACHINE_VER_DEPRECATION_MAJOR 3 614 615 /* 616 * Expands to a static string containing a deprecation 617 * message for a versioned machine type 618 */ 619 #define MACHINE_VER_DEPRECATION_MSG \ 620 "machines more than " stringify(MACHINE_VER_DEPRECATION_MAJOR) \ 621 " years old are subject to deletion after " \ 622 stringify(MACHINE_VER_DELETION_MAJOR) " years" 623 624 #define _MACHINE_VER_IS_EXPIRED_IMPL(cutoff, major, minor) \ 625 (((QEMU_VERSION_MAJOR - major) > cutoff) || \ 626 (((QEMU_VERSION_MAJOR - major) == cutoff) && \ 627 (QEMU_VERSION_MINOR - minor) >= 0)) 628 629 #define _MACHINE_VER_IS_EXPIRED2(cutoff, major, minor) \ 630 _MACHINE_VER_IS_EXPIRED_IMPL(cutoff, major, minor) 631 #define _MACHINE_VER_IS_EXPIRED3(cutoff, major, minor, micro) \ 632 _MACHINE_VER_IS_EXPIRED_IMPL(cutoff, major, minor) 633 #define _MACHINE_VER_IS_EXPIRED4(cutoff, major, minor, _unused, tag) \ 634 _MACHINE_VER_IS_EXPIRED_IMPL(cutoff, major, minor) 635 #define _MACHINE_VER_IS_EXPIRED5(cutoff, major, minor, micro, _unused, tag) \ 636 _MACHINE_VER_IS_EXPIRED_IMPL(cutoff, major, minor) 637 638 #define _MACHINE_IS_EXPIRED(cutoff, ...) \ 639 _MACHINE_VER_PICK(__VA_ARGS__, \ 640 _MACHINE_VER_IS_EXPIRED5, \ 641 _MACHINE_VER_IS_EXPIRED4, \ 642 _MACHINE_VER_IS_EXPIRED3, \ 643 _MACHINE_VER_IS_EXPIRED2) (cutoff, __VA_ARGS__) 644 645 /* 646 * Evaluates true when a machine type with (major, minor) 647 * or (major, minor, micro) version should be considered 648 * deprecated based on the current versioned machine type 649 * lifecycle rules 650 */ 651 #define MACHINE_VER_IS_DEPRECATED(...) \ 652 _MACHINE_IS_EXPIRED(MACHINE_VER_DEPRECATION_MAJOR, __VA_ARGS__) 653 654 /* 655 * Evaluates true when a machine type with (major, minor) 656 * or (major, minor, micro) version should be considered 657 * for deletion based on the current versioned machine type 658 * lifecycle rules 659 */ 660 #define MACHINE_VER_SHOULD_DELETE(...) \ 661 _MACHINE_IS_EXPIRED(MACHINE_VER_DELETION_MAJOR, __VA_ARGS__) 662 663 /* 664 * Sets the deprecation reason for a versioned machine based 665 * on its age 666 * 667 * This must be unconditionally used in the _class_init 668 * function for all machine types which support versioning. 669 * 670 * Initially it will effectively be a no-op, but after a 671 * suitable period of time has passed, it will set the 672 * 'deprecation_reason' field on the machine, to warn users 673 * about forthcoming removal. 674 */ 675 #define MACHINE_VER_DEPRECATION(...) \ 676 do { \ 677 if (MACHINE_VER_IS_DEPRECATED(__VA_ARGS__)) { \ 678 mc->deprecation_reason = MACHINE_VER_DEPRECATION_MSG; \ 679 } \ 680 } while (0) 681 682 /* 683 * Prevents registration of a versioned machined based on 684 * its age 685 * 686 * This must be unconditionally used in the register 687 * method for all machine types which support versioning. 688 * 689 * Inijtially it will effectively be a no-op, but after a 690 * suitable period of time has passed, it will cause 691 * execution of the method to return, avoiding registration 692 * of the machine 693 * 694 * The new deprecation and deletion policy for versioned 695 * machine types was introduced in QEMU 9.1.0. 696 * 697 * Under the new policy a number of old machine types (any 698 * prior to 2.12) would be liable for immediate deletion 699 * which would be a violation of our historical deprecation 700 * and removal policy 701 * 702 * Thus deletions are temporarily gated on existance of 703 * the env variable "QEMU_DELETE_MACHINES" / QEMU version 704 * number >= 10.1.0. This gate can be deleted in the 10.1.0 705 * dev cycle 706 */ 707 #define MACHINE_VER_DELETION(...) \ 708 do { \ 709 if (MACHINE_VER_SHOULD_DELETE(__VA_ARGS__)) { \ 710 if (getenv("QEMU_DELETE_MACHINES") || \ 711 QEMU_VERSION_MAJOR > 10 || (QEMU_VERSION_MAJOR == 10 && \ 712 QEMU_VERSION_MINOR >= 1)) { \ 713 return; \ 714 } \ 715 } \ 716 } while (0) 717 718 #define DEFINE_MACHINE(namestr, machine_initfn) \ 719 static void machine_initfn##_class_init(ObjectClass *oc, void *data) \ 720 { \ 721 MachineClass *mc = MACHINE_CLASS(oc); \ 722 machine_initfn(mc); \ 723 } \ 724 static const TypeInfo machine_initfn##_typeinfo = { \ 725 .name = MACHINE_TYPE_NAME(namestr), \ 726 .parent = TYPE_MACHINE, \ 727 .class_init = machine_initfn##_class_init, \ 728 }; \ 729 static void machine_initfn##_register_types(void) \ 730 { \ 731 type_register_static(&machine_initfn##_typeinfo); \ 732 } \ 733 type_init(machine_initfn##_register_types) 734 735 extern GlobalProperty hw_compat_9_0[]; 736 extern const size_t hw_compat_9_0_len; 737 738 extern GlobalProperty hw_compat_8_2[]; 739 extern const size_t hw_compat_8_2_len; 740 741 extern GlobalProperty hw_compat_8_1[]; 742 extern const size_t hw_compat_8_1_len; 743 744 extern GlobalProperty hw_compat_8_0[]; 745 extern const size_t hw_compat_8_0_len; 746 747 extern GlobalProperty hw_compat_7_2[]; 748 extern const size_t hw_compat_7_2_len; 749 750 extern GlobalProperty hw_compat_7_1[]; 751 extern const size_t hw_compat_7_1_len; 752 753 extern GlobalProperty hw_compat_7_0[]; 754 extern const size_t hw_compat_7_0_len; 755 756 extern GlobalProperty hw_compat_6_2[]; 757 extern const size_t hw_compat_6_2_len; 758 759 extern GlobalProperty hw_compat_6_1[]; 760 extern const size_t hw_compat_6_1_len; 761 762 extern GlobalProperty hw_compat_6_0[]; 763 extern const size_t hw_compat_6_0_len; 764 765 extern GlobalProperty hw_compat_5_2[]; 766 extern const size_t hw_compat_5_2_len; 767 768 extern GlobalProperty hw_compat_5_1[]; 769 extern const size_t hw_compat_5_1_len; 770 771 extern GlobalProperty hw_compat_5_0[]; 772 extern const size_t hw_compat_5_0_len; 773 774 extern GlobalProperty hw_compat_4_2[]; 775 extern const size_t hw_compat_4_2_len; 776 777 extern GlobalProperty hw_compat_4_1[]; 778 extern const size_t hw_compat_4_1_len; 779 780 extern GlobalProperty hw_compat_4_0[]; 781 extern const size_t hw_compat_4_0_len; 782 783 extern GlobalProperty hw_compat_3_1[]; 784 extern const size_t hw_compat_3_1_len; 785 786 extern GlobalProperty hw_compat_3_0[]; 787 extern const size_t hw_compat_3_0_len; 788 789 extern GlobalProperty hw_compat_2_12[]; 790 extern const size_t hw_compat_2_12_len; 791 792 extern GlobalProperty hw_compat_2_11[]; 793 extern const size_t hw_compat_2_11_len; 794 795 extern GlobalProperty hw_compat_2_10[]; 796 extern const size_t hw_compat_2_10_len; 797 798 extern GlobalProperty hw_compat_2_9[]; 799 extern const size_t hw_compat_2_9_len; 800 801 extern GlobalProperty hw_compat_2_8[]; 802 extern const size_t hw_compat_2_8_len; 803 804 extern GlobalProperty hw_compat_2_7[]; 805 extern const size_t hw_compat_2_7_len; 806 807 extern GlobalProperty hw_compat_2_6[]; 808 extern const size_t hw_compat_2_6_len; 809 810 extern GlobalProperty hw_compat_2_5[]; 811 extern const size_t hw_compat_2_5_len; 812 813 extern GlobalProperty hw_compat_2_4[]; 814 extern const size_t hw_compat_2_4_len; 815 816 extern GlobalProperty hw_compat_2_3[]; 817 extern const size_t hw_compat_2_3_len; 818 819 extern GlobalProperty hw_compat_2_2[]; 820 extern const size_t hw_compat_2_2_len; 821 822 extern GlobalProperty hw_compat_2_1[]; 823 extern const size_t hw_compat_2_1_len; 824 825 #endif 826