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
36 #     base model name and property delta changes.  As the static base
37 #     model will never change, the expanded CPU model will be the
40 #     model can be used by tooling without having to specify a
41 #     compatibility machine - e.g. when displaying the "host" model.
44 # @full: Expand all properties.  The produced model is not guaranteed
46 #     work with model details.
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
69 # @incompatible: If model A is incompatible to model B, model A is not
70 #     guaranteed to run where model B runs and the other way around.
72 # @identical: If model A is identical to model B, model A is
73 #     guaranteed to run where model B runs and the other way around.
75 # @superset: If model A is a superset of model B, model B is
76 #     guaranteed to run where model A runs.  There are no guarantees
79 # @subset: If model A is a subset of model B, model A is guaranteed to
80 #     run where model B runs.  There are no guarantees about the other
91 # The result of a CPU model baseline.
93 # @model: the baselined CpuModelInfo.
98   'data': { 'model': 'CpuModelInfo' },
104 # The result of a CPU model comparison.
126 # @query-cpu-model-comparison:
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
136 # model of a certain configuration (e.g. the "host" model for KVM).
137 # If that CPU model is identical or a subset, it will run in that
145 # * machine-type: CPU model may look different depending on the
154 #   Using query-cpu-model-expansion while using these is not advised.
159 # @modela: description of the first CPU model to compare, referred to
160 #     as "model A" in CpuModelCompareResult
162 # @modelb: description of the second CPU model to compare, referred to
163 #     as "model B" in CpuModelCompareResult
170 #     - if a model cannot be used
171 #     - if a model contains an unknown cpu definition name, unknown
179 { 'command': 'query-cpu-model-comparison',
185 # @query-cpu-model-baseline:
188 # third model.  The created model will always be a static,
189 # migration-safe CPU model (see "static" CPU model expansion for
193 # model out two CPU models.  The created CPU model will be identical
195 # the created CPU model is guaranteed to run where the given CPU
203 # * machine-type: CPU model may look different depending on the
212 #   Using query-cpu-model-expansion while using these is not advised.
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
225 #     - if a model cannot be used
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.
245 # @model: the expanded CpuModelInfo.
250 #     enabled-properties for the expanded model; "full" properties are
257   'data': { 'model': 'CpuModelInfo',
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.
281 # * machine-type: CPU model may look different depending on the
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
303 #     - if the model cannot be expanded
304 #     - if the model contains an unknown CPU definition name, unknown
310 { 'command': 'query-cpu-model-expansion',
312             'model': 'CpuModelInfo' },
336 #     accelerator options.  A static model is always migration-safe.
339 # @unavailable-features: List of properties that prevent the CPU model
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