qemu/qapi/machine.json

49 # CPU
59 # Additional information about a virtual S390 CPU
61 # @cpu-state: the virtual CPU's state
63 # @dedicated: the virtual CPU's dedication (since 8.2)
65 # @entitlement: the virtual CPU's entitlement (since 8.2)
77 # Information about a virtual CPU
79 # @cpu-index: index of the virtual CPU
81 # @qom-type: QOM type name of the CPU (since 10.1)
83 # @qom-path: path to the CPU object in the QOM tree
87 # @props: properties associated with a virtual CPU, e.g. the socket id
185 # @default-cpu-type: default CPU model typename if none is requested
433 # Injects a Non-Maskable Interrupt into the default CPU (x86/s390) or
456 # @cpu: property based CPU(s) to node mapping (Since: 2.10)
589 # Information about a X86 CPU feature word
804 # @cpu-index: the index of the virtual CPU to use for translating the
805 #     virtual address (defaults to CPU 0)
934 # Properties identifying a CPU.
941 # The ids other than the node-id specify the position of the CPU
942 # within the CPU topology (as defined by the machine property "smp",
945 # @node-id: NUMA node ID the CPU belongs to
947 # @drawer-id: drawer number within CPU topology the CPU belongs to
950 # @book-id: book number within parent container the CPU belongs to
953 # @socket-id: socket number within parent container the CPU belongs to
955 # @die-id: die number within the parent container the CPU belongs to
958 # @cluster-id: cluster number within the parent container the CPU
961 # @module-id: module number within the parent container the CPU
964 # @core-id: core number within the parent container the CPU belongs to
966 # @thread-id: thread number within the core the CPU  belongs to
987 # @type: CPU object type for usage with `device_add` command
989 # @props: list of properties to pass for hotplugging a CPU with
995 # @qom-path: link to existing CPU object if CPU is present or omitted
996 #     if CPU is not present.
1620 # Schema for CPU topology configuration.  A missing value lets QEMU
1640 # @drawers: number of drawers in the CPU topology (since 8.2)
1642 # @books: number of books in the CPU topology (since 8.2)
1892 # Virtual CPU model.
1894 # A CPU model consists of the name of a CPU definition, to which delta
1900 # @name: the name of the CPU definition the model is based on
1913 # An enumeration of CPU model expansion types.
1915 # @static: Expand to a static CPU model, a combination of a static
1917 #     model will never change, the expanded CPU model will be the
1922 #     The @static CPU models are migration-safe.
1928 # .. note:: When a non-migration-safe CPU model is expanded in static
1929 #    mode, some features enabled by the CPU model may be omitted,
1930 #    because they can't be implemented by a static CPU model
1933 #    enabled by a non-migration-safe CPU model, use @full.  If you
1946 # An enumeration of CPU model comparison results.  The result is
1947 # usually calculated using e.g. CPU features or CPU generations.
1971 # The result of a CPU model baseline.
1983 # The result of a CPU model comparison.
1993 # there's no known way to make the CPU models identical.  If the
2006 # Compares two CPU models, @modela and @modelb, returning how they
2009 # tooling to make decisions if a certain CPU model will run in a
2010 # certain configuration or if a compatible CPU model has to be created
2013 # Usually, a CPU model is compared against the maximum possible CPU
2015 # If that CPU model is identical or a subset, it will run in that
2020 # * QEMU version: CPU models may look different depending on the QEMU
2021 #   version.  (Except for CPU models reported as "static" in
2023 # * machine-type: CPU model may look different depending on the
2024 #   machine-type.  (Except for CPU models reported as "static" in
2027 #   CPU models may look different depending on machine and accelerator
2028 #   options.  (Except for CPU models reported as "static" in
2031 #   option and global properties may affect expansion of CPU models.
2035 # Some architectures may not support comparing CPU models.  s390x
2036 # supports comparing CPU models.
2038 # @modela: description of the first CPU model to compare, referred to
2041 # @modelb: description of the second CPU model to compare, referred to
2044 # Returns: a `CpuModelCompareInfo` describing how both CPU models
2048 #     - if comparing CPU models is not supported by the target
2062 # Baseline two CPU models, @modela and @modelb, creating a compatible
2064 # migration-safe CPU model (see "static" CPU model expansion for
2067 # This interface can be used by tooling to create a compatible CPU
2068 # model out two CPU models.  The created CPU model will be identical
2069 # to or a subset of both CPU models when comparing them.  Therefore,
2070 # the created CPU model is guaranteed to run where the given CPU
2075 # * QEMU version: CPU models may look different depending on the QEMU
2076 #   version.  (Except for CPU models reported as "static" in
2078 # * machine-type: CPU model may look different depending on the
2079 #   machine-type.  (Except for CPU models reported as "static" in
2082 #   CPU models may look different depending on machine and accelerator
2083 #   options.  (Except for CPU models reported as "static" in
2086 #   option and global properties may affect expansion of CPU models.
2090 # Some architectures may not support baselining CPU models.  s390x
2091 # supports baselining CPU models.
2093 # @modela: description of the first CPU model to baseline
2095 # @modelb: description of the second CPU model to baseline
2097 # Returns: a `CpuModelBaselineInfo` describing the baselined CPU model
2100 #     - if baselining CPU models is not supported by the target
2120 #     as deprecated by the CPU vendor.  The list depends on the
2135 # Expands a given CPU model, @model, (or a combination of CPU model +
2137 # allowing tooling to get an understanding what a specific CPU model
2140 # This interface can be used to query the "host" CPU model.
2144 # * QEMU version: CPU models may look different depending on the QEMU
2145 #   version.  (Except for CPU models reported as "static" in
2147 # * machine-type: CPU model may look different depending on the
2148 #   machine-type.  (Except for CPU models reported as "static" in
2151 #   CPU models may look different depending on machine and accelerator
2152 #   options.  (Except for CPU models reported as "static" in
2155 #   option and global properties may affect expansion of CPU models.
2162 # @model: description of the CPU model to expand
2164 # @type: expansion type, specifying how to expand the CPU model
2166 # Returns: a `CpuModelExpansionInfo` describing the expanded CPU model
2169 #     - if expanding CPU models is not supported
2171 #     - if the model contains an unknown CPU definition name, unknown
2185 # Virtual CPU definition.
2187 # @name: the name of the CPU definition
2189 # @migration-safe: whether a CPU definition can be safely used for
2194 #     assume the CPU definition to be migration-safe.  (since 2.8)
2196 # @static: whether a CPU definition is static and will not change
2201 # @unavailable-features: List of properties that prevent the CPU model
2208 # @alias-of: Name of CPU model this model is an alias for.  The target
2209 #     of the CPU model alias may change depending on the machine type.
2210 #     Management software is supposed to translate CPU model aliases
2214 # @deprecated: If true, this CPU model is deprecated and may be
2219 # CPU model attributes that prevent the CPU from running.  If the QOM
2221 # CPU model run in the current host.  Implementations that choose not
2224 # the CPU model in the current host if that property is changed.
2227 # messages explaining why the CPU model can't be used.  If
2228 # @unavailable-features is an empty list, the CPU model is runnable
2230 # is not present, runnability information for the CPU is not
2247 # Return a list of supported virtual CPU definitions