include/hw/boards.h

   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  */
 241 struct MachineClass {
 242     /*< private >*/
 243     ObjectClass parent_class;
 244     /*< public >*/
 245
 246     const char *family; /* NULL iff @name identifies a standalone machtype */
 247     char *name;
 248     const char *alias;
 249     const char *desc;
 250     const char *deprecation_reason;
 251
 252     void (*init)(MachineState *state);
 253     void (*reset)(MachineState *state, ShutdownCause reason);
 254     void (*wakeup)(MachineState *state);
 255     int (*kvm_type)(MachineState *machine, const char *arg);
 256
 257     BlockInterfaceType block_default_type;
 258     int units_per_default_bus;
 259     int max_cpus;
 260     int min_cpus;
 261     int default_cpus;
 262     unsigned int no_serial:1,
 263         no_parallel:1,
 264         no_floppy:1,
 265         no_cdrom:1,
 266         no_sdcard:1,
 267         pci_allow_0_address:1,
 268         legacy_fw_cfg_order:1;
 269     bool is_default;
 270     const char *default_machine_opts;
 271     const char *default_boot_order;
 272     const char *default_display;
 273     const char *default_nic;
 274     GPtrArray *compat_props;
 275     const char *hw_version;
 276     ram_addr_t default_ram_size;
 277     const char *default_cpu_type;
 278     bool default_kernel_irqchip_split;
 279     bool option_rom_has_mr;
 280     bool rom_file_has_mr;
 281     int minimum_page_bits;
 282     bool has_hotpluggable_cpus;
 283     bool ignore_memory_transaction_failures;
 284     int numa_mem_align_shift;
 285     const char * const *valid_cpu_types;
 286     strList *allowed_dynamic_sysbus_devices;
 287     bool auto_enable_numa_with_memhp;
 288     bool auto_enable_numa_with_memdev;
 289     bool ignore_boot_device_suffixes;
 290     bool smbus_no_migration_support;
 291     bool nvdimm_supported;
 292     bool numa_mem_supported;
 293     bool auto_enable_numa;
 294     bool cpu_cluster_has_numa_boundary;
 295     SMPCompatProps smp_props;
 296     const char *default_ram_id;
 297
 298     HotplugHandler *(*get_hotplug_handler)(MachineState *machine,
 299                                            DeviceState *dev);
 300     bool (*hotplug_allowed)(MachineState *state, DeviceState *dev,
 301                             Error **errp);
 302     CpuInstanceProperties (*cpu_index_to_instance_props)(MachineState *machine,
 303                                                          unsigned cpu_index);
 304     const CPUArchIdList *(*possible_cpu_arch_ids)(MachineState *machine);
 305     int64_t (*get_default_cpu_node_id)(const MachineState *ms, int idx);
 306     ram_addr_t (*fixup_ram_size)(ram_addr_t size);
 307 };
 308
 309 /**
 310  * DeviceMemoryState:
 311  * @base: address in guest physical address space where the memory
 312  * address space for memory devices starts
 313  * @mr: memory region container for memory devices
 314  * @as: address space for memory devices
 315  * @listener: memory listener used to track used memslots in the address space
 316  * @dimm_size: the sum of plugged DIMMs' sizes
 317  * @used_region_size: the part of @mr already used by memory devices
 318  * @required_memslots: the number of memslots required by memory devices
 319  * @used_memslots: the number of memslots currently used by memory devices
 320  * @memslot_auto_decision_active: whether any plugged memory device
 321  *                                automatically decided to use more than
 322  *                                one memslot
 323  */
 324 typedef struct DeviceMemoryState {
 325     hwaddr base;
 326     MemoryRegion mr;
 327     AddressSpace as;
 328     MemoryListener listener;
 329     uint64_t dimm_size;
 330     uint64_t used_region_size;
 331     unsigned int required_memslots;
 332     unsigned int used_memslots;
 333     unsigned int memslot_auto_decision_active;
 334 } DeviceMemoryState;
 335
 336 /**
 337  * CpuTopology:
 338  * @cpus: the number of present logical processors on the machine
 339  * @drawers: the number of drawers on the machine
 340  * @books: the number of books in one drawer
 341  * @sockets: the number of sockets in one book
 342  * @dies: the number of dies in one socket
 343  * @clusters: the number of clusters in one die
 344  * @modules: the number of modules in one cluster
 345  * @cores: the number of cores in one cluster
 346  * @threads: the number of threads in one core
 347  * @max_cpus: the maximum number of logical processors on the machine
 348  */
 349 typedef struct CpuTopology {
 350     unsigned int cpus;
 351     unsigned int drawers;
 352     unsigned int books;
 353     unsigned int sockets;
 354     unsigned int dies;
 355     unsigned int clusters;
 356     unsigned int modules;
 357     unsigned int cores;
 358     unsigned int threads;
 359     unsigned int max_cpus;
 360 } CpuTopology;
 361
 362 /**
 363  * MachineState:
 364  */
 365 struct MachineState {
 366     /*< private >*/
 367     Object parent_obj;
 368
 369     /*< public >*/
 370
 371     void *fdt;
 372     char *dtb;
 373     char *dumpdtb;
 374     int phandle_start;
 375     char *dt_compatible;
 376     bool dump_guest_core;
 377     bool mem_merge;
 378     bool usb;
 379     bool usb_disabled;
 380     char *firmware;
 381     bool iommu;
 382     bool suppress_vmdesc;
 383     bool enable_graphics;
 384     ConfidentialGuestSupport *cgs;
 385     HostMemoryBackend *memdev;
 386     /*
 387      * convenience alias to ram_memdev_id backend memory region
 388      * or to numa container memory region
 389      */
 390     MemoryRegion *ram;
 391     DeviceMemoryState *device_memory;
 392
 393     /*
 394      * Included in MachineState for simplicity, but not supported
 395      * unless machine_add_audiodev_property is called.  Boards
 396      * that have embedded audio devices can call it from the
 397      * machine init function and forward the property to the device.
 398      */
 399     char *audiodev;
 400
 401     ram_addr_t ram_size;
 402     ram_addr_t maxram_size;
 403     uint64_t   ram_slots;
 404     BootConfiguration boot_config;
 405     char *kernel_filename;
 406     char *kernel_cmdline;
 407     char *initrd_filename;
 408     const char *cpu_type;
 409     AccelState *accelerator;
 410     CPUArchIdList *possible_cpus;
 411     CpuTopology smp;
 412     struct NVDIMMState *nvdimms_state;
 413     struct NumaState *numa_state;
 414 };
 415
 416 /*
 417  * The macros which follow are intended to facilitate the
 418  * definition of versioned machine types, using a somewhat
 419  * similar pattern across targets.
 420  *
 421  * For example, a macro that can be used to define versioned
 422  * 'virt' machine types would look like:
 423  *
 424  *  #define DEFINE_VIRT_MACHINE_IMPL(latest, ...) \
 425  *      static void MACHINE_VER_SYM(class_init, virt, __VA_ARGS__)( \
 426  *          ObjectClass *oc, \
 427  *          void *data) \
 428  *      { \
 429  *          MachineClass *mc = MACHINE_CLASS(oc); \
 430  *          MACHINE_VER_SYM(options, virt, __VA_ARGS__)(mc); \
 431  *          mc->desc = "QEMU " MACHINE_VER_STR(__VA_ARGS__) " Virtual Machine"; \
 432  *          MACHINE_VER_DEPRECATION(__VA_ARGS__); \
 433  *          if (latest) { \
 434  *              mc->alias = "virt"; \
 435  *          } \
 436  *      } \
 437  *      static const TypeInfo MACHINE_VER_SYM(info, virt, __VA_ARGS__) = { \
 438  *          .name = MACHINE_VER_TYPE_NAME("virt", __VA_ARGS__), \
 439  *          .parent = TYPE_VIRT_MACHINE, \
 440  *          .class_init = MACHINE_VER_SYM(class_init, virt, __VA_ARGS__), \
 441  *      }; \
 442  *      static void MACHINE_VER_SYM(register, virt, __VA_ARGS__)(void) \
 443  *      { \
 444  *          MACHINE_VER_DELETION(__VA_ARGS__); \
 445  *          type_register_static(&MACHINE_VER_SYM(info, virt, __VA_ARGS__)); \
 446  *      } \
 447  *      type_init(MACHINE_VER_SYM(register, virt, __VA_ARGS__));
 448  *
 449  * Following this, one (or more) helpers can be added for
 450  * whichever scenarios need to be catered for with a machine:
 451  *
 452  *  // Normal 2 digit, marked as latest e.g. 'virt-9.0'
 453  *  #define DEFINE_VIRT_MACHINE_LATEST(major, minor) \
 454  *      DEFINE_VIRT_MACHINE_IMPL(true, major, minor)
 455  *
 456  *  // Normal 2 digit e.g. 'virt-9.0'
 457  *  #define DEFINE_VIRT_MACHINE(major, minor) \
 458  *      DEFINE_VIRT_MACHINE_IMPL(false, major, minor)
 459  *
 460  *  // Bugfix 3 digit e.g. 'virt-9.0.1'
 461  *  #define DEFINE_VIRT_MACHINE_BUGFIX(major, minor, micro) \
 462  *      DEFINE_VIRT_MACHINE_IMPL(false, major, minor, micro)
 463  *
 464  *  // Tagged 2 digit e.g. 'virt-9.0-extra'
 465  *  #define DEFINE_VIRT_MACHINE_TAGGED(major, minor, tag) \
 466  *      DEFINE_VIRT_MACHINE_IMPL(false, major, minor, _, tag)
 467  *
 468  *  // Tagged bugfix 2 digit e.g. 'virt-9.0.1-extra'
 469  *  #define DEFINE_VIRT_MACHINE_TAGGED(major, minor, micro, tag) \
 470  *      DEFINE_VIRT_MACHINE_IMPL(false, major, minor, micro, _, tag)
 471  */
 472
 473 /*
 474  * Helper for dispatching different macros based on how
 475  * many __VA_ARGS__ are passed. Supports 1 to 5 variadic
 476  * arguments, with the called target able to be prefixed
 477  * with 0 or more fixed arguments too. To be called thus:
 478  *
 479  *  _MACHINE_VER_PICK(__VA_ARGS,
 480  *                    MACRO_MATCHING_5_ARGS,
 481  *                    MACRO_MATCHING_4_ARGS,
 482  *                    MACRO_MATCHING_3_ARGS,
 483  *                    MACRO_MATCHING_2_ARGS,
 484  *                    MACRO_MATCHING_1_ARG) (FIXED-ARG-1,
 485  *                                           ...,
 486  *                                           FIXED-ARG-N,
 487  *                                           __VA_ARGS__)
 488  */
 489 #define _MACHINE_VER_PICK(x1, x2, x3, x4, x5, x6, ...) x6
 490
 491 /*
 492  * Construct a human targeted machine version string.
 493  *
 494  * Can be invoked with various signatures
 495  *
 496  *  MACHINE_VER_STR(sym, prefix, major, minor)
 497  *  MACHINE_VER_STR(sym, prefix, major, minor, micro)
 498  *  MACHINE_VER_STR(sym, prefix, major, minor, _, tag)
 499  *  MACHINE_VER_STR(sym, prefix, major, minor, micro, _, tag)
 500  *
 501  * Respectively emitting symbols with the format
 502  *
 503  *   "{major}.{minor}"
 504  *   "{major}.{minor}-{tag}"
 505  *   "{major}.{minor}.{micro}"
 506  *   "{major}.{minor}.{micro}-{tag}"
 507  */
 508 #define _MACHINE_VER_STR2(major, minor) \
 509     #major "." #minor
 510
 511 #define _MACHINE_VER_STR3(major, minor, micro) \
 512     #major "." #minor "." #micro
 513
 514 #define _MACHINE_VER_STR4(major, minor, _unused_, tag) \
 515     #major "." #minor "-" #tag
 516
 517 #define _MACHINE_VER_STR5(major, minor, micro, _unused_, tag) \
 518     #major "." #minor "." #micro "-" #tag
 519
 520 #define MACHINE_VER_STR(...) \
 521     _MACHINE_VER_PICK(__VA_ARGS__, \
 522                       _MACHINE_VER_STR5, \
 523                       _MACHINE_VER_STR4, \
 524                       _MACHINE_VER_STR3, \
 525                       _MACHINE_VER_STR2) (__VA_ARGS__)
 526
 527
 528 /*
 529  * Construct a QAPI type name for a versioned machine
 530  * type
 531  *
 532  * Can be invoked with various signatures
 533  *
 534  *  MACHINE_VER_TYPE_NAME(prefix, major, minor)
 535  *  MACHINE_VER_TYPE_NAME(prefix, major, minor, micro)
 536  *  MACHINE_VER_TYPE_NAME(prefix, major, minor, _, tag)
 537  *  MACHINE_VER_TYPE_NAME(prefix, major, minor, micro, _, tag)
 538  *
 539  * Respectively emitting symbols with the format
 540  *
 541  *   "{prefix}-{major}.{minor}"
 542  *   "{prefix}-{major}.{minor}.{micro}"
 543  *   "{prefix}-{major}.{minor}-{tag}"
 544  *   "{prefix}-{major}.{minor}.{micro}-{tag}"
 545  */
 546 #define _MACHINE_VER_TYPE_NAME2(prefix, major, minor)   \
 547     prefix "-" #major "." #minor TYPE_MACHINE_SUFFIX
 548
 549 #define _MACHINE_VER_TYPE_NAME3(prefix, major, minor, micro) \
 550     prefix "-" #major "." #minor "." #micro TYPE_MACHINE_SUFFIX
 551
 552 #define _MACHINE_VER_TYPE_NAME4(prefix, major, minor, _unused_, tag) \
 553     prefix "-" #major "." #minor "-" #tag TYPE_MACHINE_SUFFIX
 554
 555 #define _MACHINE_VER_TYPE_NAME5(prefix, major, minor, micro, _unused_, tag) \
 556     prefix "-" #major "." #minor "." #micro "-" #tag TYPE_MACHINE_SUFFIX
 557
 558 #define MACHINE_VER_TYPE_NAME(prefix, ...) \
 559     _MACHINE_VER_PICK(__VA_ARGS__, \
 560                       _MACHINE_VER_TYPE_NAME5, \
 561                       _MACHINE_VER_TYPE_NAME4, \
 562                       _MACHINE_VER_TYPE_NAME3, \
 563                       _MACHINE_VER_TYPE_NAME2) (prefix, __VA_ARGS__)
 564
 565 /*
 566  * Construct a name for a versioned machine type that is
 567  * suitable for use as a C symbol (function/variable/etc).
 568  *
 569  * Can be invoked with various signatures
 570  *
 571  *  MACHINE_VER_SYM(sym, prefix, major, minor)
 572  *  MACHINE_VER_SYM(sym, prefix, major, minor, micro)
 573  *  MACHINE_VER_SYM(sym, prefix, major, minor, _, tag)
 574  *  MACHINE_VER_SYM(sym, prefix, major, minor, micro, _, tag)
 575  *
 576  * Respectively emitting symbols with the format
 577  *
 578  *   {prefix}_machine_{major}_{minor}_{sym}
 579  *   {prefix}_machine_{major}_{minor}_{micro}_{sym}
 580  *   {prefix}_machine_{major}_{minor}_{tag}_{sym}
 581  *   {prefix}_machine_{major}_{minor}_{micro}_{tag}_{sym}
 582  */
 583 #define _MACHINE_VER_SYM2(sym, prefix, major, minor) \
 584     prefix ## _machine_ ## major ## _ ## minor ## _ ## sym
 585
 586 #define _MACHINE_VER_SYM3(sym, prefix, major, minor, micro) \
 587     prefix ## _machine_ ## major ## _ ## minor ## _ ## micro ## _ ## sym
 588
 589 #define _MACHINE_VER_SYM4(sym, prefix, major, minor, _unused_, tag) \
 590     prefix ## _machine_ ## major ## _ ## minor ## _ ## tag ## _ ## sym
 591
 592 #define _MACHINE_VER_SYM5(sym, prefix, major, minor, micro, _unused_, tag) \
 593     prefix ## _machine_ ## major ## _ ## minor ## _ ## micro ## _ ## tag ## _ ## sym
 594
 595 #define MACHINE_VER_SYM(sym, prefix, ...) \
 596     _MACHINE_VER_PICK(__VA_ARGS__, \
 597                       _MACHINE_VER_SYM5, \
 598                       _MACHINE_VER_SYM4, \
 599                       _MACHINE_VER_SYM3, \
 600                       _MACHINE_VER_SYM2) (sym, prefix, __VA_ARGS__)
 601
 602
 603 /*
 604  * How many years/major releases for each phase
 605  * of the life cycle. Assumes use of versioning
 606  * scheme where major is bumped each year
 607  */
 608 #define MACHINE_VER_DELETION_MAJOR 6
 609 #define MACHINE_VER_DEPRECATION_MAJOR 3
 610
 611 /*
 612  * Expands to a static string containing a deprecation
 613  * message for a versioned machine type
 614  */
 615 #define MACHINE_VER_DEPRECATION_MSG \
 616     "machines more than " stringify(MACHINE_VER_DEPRECATION_MAJOR) \
 617     " years old are subject to deletion after " \
 618     stringify(MACHINE_VER_DELETION_MAJOR) " years"
 619
 620 #define _MACHINE_VER_IS_EXPIRED_IMPL(cutoff, major, minor) \
 621     (((QEMU_VERSION_MAJOR - major) > cutoff) || \
 622      (((QEMU_VERSION_MAJOR - major) == cutoff) && \
 623       (QEMU_VERSION_MINOR - minor) >= 0))
 624
 625 #define _MACHINE_VER_IS_EXPIRED2(cutoff, major, minor) \
 626     _MACHINE_VER_IS_EXPIRED_IMPL(cutoff, major, minor)
 627 #define _MACHINE_VER_IS_EXPIRED3(cutoff, major, minor, micro) \
 628     _MACHINE_VER_IS_EXPIRED_IMPL(cutoff, major, minor)
 629 #define _MACHINE_VER_IS_EXPIRED4(cutoff, major, minor, _unused, tag) \
 630     _MACHINE_VER_IS_EXPIRED_IMPL(cutoff, major, minor)
 631 #define _MACHINE_VER_IS_EXPIRED5(cutoff, major, minor, micro, _unused, tag)   \
 632     _MACHINE_VER_IS_EXPIRED_IMPL(cutoff, major, minor)
 633
 634 #define _MACHINE_IS_EXPIRED(cutoff, ...) \
 635     _MACHINE_VER_PICK(__VA_ARGS__, \
 636                       _MACHINE_VER_IS_EXPIRED5, \
 637                       _MACHINE_VER_IS_EXPIRED4, \
 638                       _MACHINE_VER_IS_EXPIRED3, \
 639                       _MACHINE_VER_IS_EXPIRED2) (cutoff, __VA_ARGS__)
 640
 641 /*
 642  * Evaluates true when a machine type with (major, minor)
 643  * or (major, minor, micro) version should be considered
 644  * deprecated based on the current versioned machine type
 645  * lifecycle rules
 646  */
 647 #define MACHINE_VER_IS_DEPRECATED(...) \
 648     _MACHINE_IS_EXPIRED(MACHINE_VER_DEPRECATION_MAJOR, __VA_ARGS__)
 649
 650 /*
 651  * Evaluates true when a machine type with (major, minor)
 652  * or (major, minor, micro) version should be considered
 653  * for deletion based on the current versioned machine type
 654  * lifecycle rules
 655  */
 656 #define MACHINE_VER_SHOULD_DELETE(...) \
 657     _MACHINE_IS_EXPIRED(MACHINE_VER_DELETION_MAJOR, __VA_ARGS__)
 658
 659 /*
 660  * Sets the deprecation reason for a versioned machine based
 661  * on its age
 662  *
 663  * This must be unconditionally used in the _class_init
 664  * function for all machine types which support versioning.
 665  *
 666  * Initially it will effectively be a no-op, but after a
 667  * suitable period of time has passed, it will set the
 668  * 'deprecation_reason' field on the machine, to warn users
 669  * about forthcoming removal.
 670  */
 671 #define MACHINE_VER_DEPRECATION(...) \
 672     do { \
 673         if (MACHINE_VER_IS_DEPRECATED(__VA_ARGS__)) { \
 674             mc->deprecation_reason = MACHINE_VER_DEPRECATION_MSG; \
 675         } \
 676     } while (0)
 677
 678 /*
 679  * Prevents registration of a versioned machined based on
 680  * its age
 681  *
 682  * This must be unconditionally used in the register
 683  * method for all machine types which support versioning.
 684  *
 685  * Inijtially it will effectively be a no-op, but after a
 686  * suitable period of time has passed, it will cause
 687  * execution of the method to return, avoiding registration
 688  * of the machine
 689  *
 690  * The new deprecation and deletion policy for versioned
 691  * machine types was introduced in QEMU 9.1.0.
 692  *
 693  * Under the new policy a number of old machine types (any
 694  * prior to 2.12) would be liable for immediate deletion
 695  * which would be a violation of our historical deprecation
 696  * and removal policy
 697  *
 698  * Thus deletions are temporarily gated on existance of
 699  * the env variable "QEMU_DELETE_MACHINES" / QEMU version
 700  * number >= 10.1.0. This gate can be deleted in the 10.1.0
 701  * dev cycle
 702  */
 703 #define MACHINE_VER_DELETION(...) \
 704     do { \
 705         if (MACHINE_VER_SHOULD_DELETE(__VA_ARGS__)) { \
 706             if (getenv("QEMU_DELETE_MACHINES") || \
 707                 QEMU_VERSION_MAJOR > 10 || (QEMU_VERSION_MAJOR == 10 && \
 708                                             QEMU_VERSION_MINOR >= 1)) { \
 709                 return; \
 710             } \
 711         } \
 712     } while (0)
 713
 714 #define DEFINE_MACHINE(namestr, machine_initfn) \
 715     static void machine_initfn##_class_init(ObjectClass *oc, void *data) \
 716     { \
 717         MachineClass *mc = MACHINE_CLASS(oc); \
 718         machine_initfn(mc); \
 719     } \
 720     static const TypeInfo machine_initfn##_typeinfo = { \
 721         .name       = MACHINE_TYPE_NAME(namestr), \
 722         .parent     = TYPE_MACHINE, \
 723         .class_init = machine_initfn##_class_init, \
 724     }; \
 725     static void machine_initfn##_register_types(void) \
 726     { \
 727         type_register_static(&machine_initfn##_typeinfo); \
 728     } \
 729     type_init(machine_initfn##_register_types)
 730
 731 extern GlobalProperty hw_compat_9_0[];
 732 extern const size_t hw_compat_9_0_len;
 733
 734 extern GlobalProperty hw_compat_8_2[];
 735 extern const size_t hw_compat_8_2_len;
 736
 737 extern GlobalProperty hw_compat_8_1[];
 738 extern const size_t hw_compat_8_1_len;
 739
 740 extern GlobalProperty hw_compat_8_0[];
 741 extern const size_t hw_compat_8_0_len;
 742
 743 extern GlobalProperty hw_compat_7_2[];
 744 extern const size_t hw_compat_7_2_len;
 745
 746 extern GlobalProperty hw_compat_7_1[];
 747 extern const size_t hw_compat_7_1_len;
 748
 749 extern GlobalProperty hw_compat_7_0[];
 750 extern const size_t hw_compat_7_0_len;
 751
 752 extern GlobalProperty hw_compat_6_2[];
 753 extern const size_t hw_compat_6_2_len;
 754
 755 extern GlobalProperty hw_compat_6_1[];
 756 extern const size_t hw_compat_6_1_len;
 757
 758 extern GlobalProperty hw_compat_6_0[];
 759 extern const size_t hw_compat_6_0_len;
 760
 761 extern GlobalProperty hw_compat_5_2[];
 762 extern const size_t hw_compat_5_2_len;
 763
 764 extern GlobalProperty hw_compat_5_1[];
 765 extern const size_t hw_compat_5_1_len;
 766
 767 extern GlobalProperty hw_compat_5_0[];
 768 extern const size_t hw_compat_5_0_len;
 769
 770 extern GlobalProperty hw_compat_4_2[];
 771 extern const size_t hw_compat_4_2_len;
 772
 773 extern GlobalProperty hw_compat_4_1[];
 774 extern const size_t hw_compat_4_1_len;
 775
 776 extern GlobalProperty hw_compat_4_0[];
 777 extern const size_t hw_compat_4_0_len;
 778
 779 extern GlobalProperty hw_compat_3_1[];
 780 extern const size_t hw_compat_3_1_len;
 781
 782 extern GlobalProperty hw_compat_3_0[];
 783 extern const size_t hw_compat_3_0_len;
 784
 785 extern GlobalProperty hw_compat_2_12[];
 786 extern const size_t hw_compat_2_12_len;
 787
 788 extern GlobalProperty hw_compat_2_11[];
 789 extern const size_t hw_compat_2_11_len;
 790
 791 extern GlobalProperty hw_compat_2_10[];
 792 extern const size_t hw_compat_2_10_len;
 793
 794 extern GlobalProperty hw_compat_2_9[];
 795 extern const size_t hw_compat_2_9_len;
 796
 797 extern GlobalProperty hw_compat_2_8[];
 798 extern const size_t hw_compat_2_8_len;
 799
 800 extern GlobalProperty hw_compat_2_7[];
 801 extern const size_t hw_compat_2_7_len;
 802
 803 extern GlobalProperty hw_compat_2_6[];
 804 extern const size_t hw_compat_2_6_len;
 805
 806 extern GlobalProperty hw_compat_2_5[];
 807 extern const size_t hw_compat_2_5_len;
 808
 809 extern GlobalProperty hw_compat_2_4[];
 810 extern const size_t hw_compat_2_4_len;
 811
 812 extern GlobalProperty hw_compat_2_3[];
 813 extern const size_t hw_compat_2_3_len;
 814
 815 extern GlobalProperty hw_compat_2_2[];
 816 extern const size_t hw_compat_2_2_len;
 817
 818 extern GlobalProperty hw_compat_2_1[];
 819 extern const size_t hw_compat_2_1_len;
 820
 821 #endif