qemu/qapi/machine-target.json

12 # Virtual CPU model.
14 # A CPU model consists of the name of a CPU definition, to which delta
20 # @name: the name of the CPU definition the model is based on
33 # An enumeration of CPU model expansion types.
35 # @static: Expand to a static CPU model, a combination of a static
37 #     model will never change, the expanded CPU model will be the
42 #     The @static CPU models are migration-safe.
48 # .. note:: When a non-migration-safe CPU model is expanded in static
49 #    mode, some features enabled by the CPU model may be omitted,
50 #    because they can't be implemented by a static CPU model
53 #    enabled by a non-migration-safe CPU model, use @full.  If you
66 # An enumeration of CPU model comparison results.  The result is
67 # usually calculated using e.g. CPU features or CPU generations.
91 # The result of a CPU model baseline.
104 # The result of a CPU model comparison.
114 # there's no known way to make the CPU models identical.  If the
126 # @query-cpu-model-comparison:
128 # Compares two CPU models, @modela and @modelb, returning how they
131 # used by tooling to make decisions if a certain CPU model will
132 # run in a certain configuration or if a compatible CPU model has
135 # Usually, a CPU model is compared against the maximum possible CPU
137 # If that CPU model is identical or a subset, it will run in that
142 # * QEMU version: CPU models may look different depending on the QEMU
143 #   version.  (Except for CPU models reported as "static" in
144 #   query-cpu-definitions.)
145 # * machine-type: CPU model may look different depending on the
146 #   machine-type.  (Except for CPU models reported as "static" in
147 #   query-cpu-definitions.)
149 #   CPU models may look different depending on machine and accelerator
150 #   options.  (Except for CPU models reported as "static" in
151 #   query-cpu-definitions.)
152 # * "-cpu" arguments and global properties: arguments to the -cpu
153 #   option and global properties may affect expansion of CPU models.
154 #   Using query-cpu-model-expansion while using these is not advised.
156 # Some architectures may not support comparing CPU models.  s390x
157 # supports comparing CPU models.
159 # @modela: description of the first CPU model to compare, referred to
162 # @modelb: description of the second CPU model to compare, referred to
165 # Returns: a CpuModelCompareInfo describing how both CPU models
169 #     - if comparing CPU models is not supported
171 #     - if a model contains an unknown cpu definition name, unknown
179 { 'command': 'query-cpu-model-comparison',
185 # @query-cpu-model-baseline:
187 # Baseline two CPU models, @modela and @modelb, creating a compatible
189 # migration-safe CPU model (see "static" CPU model expansion for
192 # This interface can be used by tooling to create a compatible CPU
193 # model out two CPU models.  The created CPU model will be identical
194 # to or a subset of both CPU models when comparing them.  Therefore,
195 # the created CPU model is guaranteed to run where the given CPU
200 # * QEMU version: CPU models may look different depending on the QEMU
201 #   version.  (Except for CPU models reported as "static" in
202 #   query-cpu-definitions.)
203 # * machine-type: CPU model may look different depending on the
204 #   machine-type.  (Except for CPU models reported as "static" in
205 #   query-cpu-definitions.)
207 #   CPU models may look different depending on machine and accelerator
208 #   options.  (Except for CPU models reported as "static" in
209 #   query-cpu-definitions.)
210 # * "-cpu" arguments and global properties: arguments to the -cpu
211 #   option and global properties may affect expansion of CPU models.
212 #   Using query-cpu-model-expansion while using these is not advised.
214 # Some architectures may not support baselining CPU models.  s390x
215 # supports baselining CPU models.
217 # @modela: description of the first CPU model to baseline
219 # @modelb: description of the second CPU model to baseline
221 # Returns: a CpuModelBaselineInfo describing the baselined CPU model
224 #     - if baselining CPU models is not supported
226 #     - if a model contains an unknown cpu definition name, unknown
234 { 'command': 'query-cpu-model-baseline',
243 # The result of a cpu model expansion.
248 #     deprecated by the CPU vendor.  The list depends on the
267 # @query-cpu-model-expansion:
269 # Expands a given CPU model, @model, (or a combination of CPU model +
271 # allowing tooling to get an understanding what a specific CPU model
274 # This interface can be used to query the "host" CPU model.
278 # * QEMU version: CPU models may look different depending on the QEMU
279 #   version.  (Except for CPU models reported as "static" in
280 #   query-cpu-definitions.)
281 # * machine-type: CPU model may look different depending on the
282 #   machine-type.  (Except for CPU models reported as "static" in
283 #   query-cpu-definitions.)
285 #   CPU models may look different depending on machine and accelerator
286 #   options.  (Except for CPU models reported as "static" in
287 #   query-cpu-definitions.)
288 # * "-cpu" arguments and global properties: arguments to the -cpu
289 #   option and global properties may affect expansion of CPU models.
290 #   Using query-cpu-model-expansion while using these is not advised.
295 # @model: description of the CPU model to expand
297 # @type: expansion type, specifying how to expand the CPU model
299 # Returns: a CpuModelExpansionInfo describing the expanded CPU model
302 #     - if expanding CPU models is not supported
304 #     - if the model contains an unknown CPU definition name, unknown
310 { 'command': 'query-cpu-model-expansion',
323 # Virtual CPU definition.
325 # @name: the name of the CPU definition
327 # @migration-safe: whether a CPU definition can be safely used for
332 #     assume the CPU definition to be migration-safe.  (since 2.8)
334 # @static: whether a CPU definition is static and will not change
339 # @unavailable-features: List of properties that prevent the CPU model
344 #     using -cpu or -global.  (since 2.9)
346 # @alias-of: Name of CPU model this model is an alias for.  The target
347 #     of the CPU model alias may change depending on the machine type.
348 #     Management software is supposed to translate CPU model aliases
352 # @deprecated: If true, this CPU model is deprecated and may be
357 # CPU model attributes that prevent the CPU from running.  If the QOM
359 # CPU model run in the current host.  Implementations that choose not
362 # the CPU model in the current host if that property is changed.
365 # messages explaining why the CPU model can't be used.  If
366 # @unavailable-features is an empty list, the CPU model is runnable
368 # is not present, runnability information for the CPU is not
390 # @query-cpu-definitions:
392 # Return a list of supported virtual CPU definitions
398 { 'command': 'query-cpu-definitions', 'returns': ['CpuDefinitionInfo'],
410 # An enumeration of CPU polarization that can be assumed by a virtual
411 # S390 CPU
421 # @set-cpu-topology:
423 # Modify the topology by moving the CPU inside the topology tree, or
424 # by changing a modifier attribute of a CPU.  Absent values will not
437 # @dedicated: whether the provisioning of real to virtual CPU is
446 { 'command': 'set-cpu-topology',
498 # The result of a CPU polarization query.
500 # @polarization: the CPU polarization
510 # @query-s390x-cpu-polarization:
516 # Returns: the machine's CPU polarization
520 { 'command': 'query-s390x-cpu-polarization', 'returns': 'CpuPolarizationInfo',