2021-08-23 16:28:03 +03:00
|
|
|
.. _Deprecated features:
|
|
|
|
|
2020-02-28 18:36:04 +03:00
|
|
|
Deprecated features
|
|
|
|
===================
|
|
|
|
|
|
|
|
In general features are intended to be supported indefinitely once
|
|
|
|
introduced into QEMU. In the event that a feature needs to be removed,
|
2020-09-15 18:07:34 +03:00
|
|
|
it will be listed in this section. The feature will remain functional for the
|
|
|
|
release in which it was deprecated and one further release. After these two
|
|
|
|
releases, the feature is liable to be removed. Deprecated features may also
|
|
|
|
generate warnings on the console when QEMU starts up, or if activated via a
|
|
|
|
monitor command, however, this is not a mandatory requirement.
|
2020-02-28 18:36:04 +03:00
|
|
|
|
2024-06-20 19:57:42 +03:00
|
|
|
As a special exception to this general timeframe, rather than have an
|
|
|
|
indefinite lifetime, versioned machine types are only intended to be
|
|
|
|
supported for a period of 6 years, equivalent to 18 QEMU releases. All
|
|
|
|
versioned machine types will be automatically marked deprecated after an
|
|
|
|
initial 3 years (9 QEMU releases) has passed, and will then be deleted after
|
|
|
|
a further 3 year period has passed. It is recommended that a deprecated
|
|
|
|
machine type is only used for incoming migrations and restore of saved state,
|
|
|
|
for pre-existing VM deployments. They should be scheduled for updating to a
|
|
|
|
newer machine type during an appropriate service window. Newly deployed VMs
|
|
|
|
should exclusively use a non-deprecated machine type, with use of the most
|
|
|
|
recent version highly recommended. Non-versioned machine types follow the
|
|
|
|
general feature deprecation policy.
|
|
|
|
|
2020-02-28 18:36:04 +03:00
|
|
|
Prior to the 2.10.0 release there was no official policy on how
|
|
|
|
long features would be deprecated prior to their removal, nor
|
|
|
|
any documented list of which features were deprecated. Thus
|
|
|
|
any features deprecated prior to 2.10.0 will be treated as if
|
|
|
|
they were first deprecated in the 2.10.0 release.
|
|
|
|
|
|
|
|
What follows is a list of all features currently marked as
|
|
|
|
deprecated.
|
|
|
|
|
|
|
|
System emulator command line arguments
|
|
|
|
--------------------------------------
|
|
|
|
|
2020-11-09 12:13:39 +03:00
|
|
|
Short-form boolean options (since 6.0)
|
|
|
|
''''''''''''''''''''''''''''''''''''''
|
|
|
|
|
|
|
|
Boolean options such as ``share=on``/``share=off`` could be written
|
|
|
|
in short form as ``share`` and ``noshare``. This is now deprecated
|
|
|
|
and will cause a warning.
|
blockdev: Deprecate -drive with bogus interface type
Drives with interface types other than if=none are for onboard
devices. Unfortunately, any such drives the board doesn't pick up can
still be used with -device, like this:
$ qemu-system-x86_64 -nodefaults -display none -S -drive if=floppy,id=bogus,unit=7 -device ide-cd,drive=bogus -monitor stdio
QEMU 5.0.50 monitor - type 'help' for more information
(qemu) info block
bogus: [not inserted]
Attached to: /machine/peripheral-anon/device[0]
Removable device: not locked, tray closed
(qemu) info qtree
bus: main-system-bus
type System
[...]
bus: ide.1
type IDE
dev: ide-cd, id ""
---> drive = "bogus"
[...]
unit = 0 (0x0)
[...]
This kind of abuse has always worked. Deprecate it:
qemu-system-x86_64: -drive if=floppy,id=bogus,unit=7: warning: bogus if=floppy is deprecated, use if=none
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Message-Id: <20200622094227.1271650-9-armbru@redhat.com>
2020-06-22 12:42:19 +03:00
|
|
|
|
2021-02-25 13:51:30 +03:00
|
|
|
``delay`` option for socket character devices (since 6.0)
|
|
|
|
'''''''''''''''''''''''''''''''''''''''''''''''''''''''''
|
|
|
|
|
|
|
|
The replacement for the ``nodelay`` short-form boolean option is ``nodelay=on``
|
|
|
|
rather than ``delay=off``.
|
|
|
|
|
2021-08-02 16:44:14 +03:00
|
|
|
Plugin argument passing through ``arg=<string>`` (since 6.1)
|
|
|
|
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
|
|
|
|
|
|
|
|
Passing TCG plugins arguments through ``arg=`` is redundant is makes the
|
|
|
|
command-line less readable, especially when the argument itself consist of a
|
|
|
|
name and a value, e.g. ``-plugin plugin_name,arg="arg_name=arg_value"``.
|
|
|
|
Therefore, the usage of ``arg`` is redundant. Single-word arguments are treated
|
|
|
|
as short-form boolean values, and passed to plugins as ``arg_name=on``.
|
|
|
|
However, short-form booleans are deprecated and full explicit ``arg_name=on``
|
|
|
|
form is preferred.
|
|
|
|
|
2024-03-08 19:01:37 +03:00
|
|
|
``-smp`` (Unsupported "parameter=1" SMP configurations) (since 9.0)
|
|
|
|
'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
|
|
|
|
|
|
|
|
Specified CPU topology parameters must be supported by the machine.
|
|
|
|
|
|
|
|
In the SMP configuration, users should provide the CPU topology parameters that
|
|
|
|
are supported by the target machine.
|
|
|
|
|
|
|
|
However, historically it was allowed for users to specify the unsupported
|
|
|
|
topology parameter as "1", which is meaningless. So support for this kind of
|
|
|
|
configurations (e.g. -smp drawers=1,books=1,clusters=1 for x86 PC machine) is
|
|
|
|
marked deprecated since 9.0, users have to ensure that all the topology members
|
|
|
|
described with -smp are supported by the target machine.
|
|
|
|
|
2024-05-06 14:20:58 +03:00
|
|
|
``-runas`` (since 9.1)
|
|
|
|
----------------------
|
|
|
|
|
|
|
|
Use ``-run-with user=..`` instead.
|
|
|
|
|
|
|
|
|
2024-03-12 10:15:12 +03:00
|
|
|
User-mode emulator command line arguments
|
|
|
|
-----------------------------------------
|
|
|
|
|
|
|
|
``-p`` (since 9.0)
|
|
|
|
''''''''''''''''''
|
|
|
|
|
|
|
|
The ``-p`` option pretends to control the host page size. However,
|
|
|
|
it is not possible to change the host page size, and using the
|
|
|
|
option only causes failures.
|
|
|
|
|
2020-02-28 18:36:04 +03:00
|
|
|
QEMU Machine Protocol (QMP) commands
|
|
|
|
------------------------------------
|
|
|
|
|
2021-08-23 06:00:04 +03:00
|
|
|
``blockdev-open-tray``, ``blockdev-close-tray`` argument ``device`` (since 2.8)
|
|
|
|
'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
|
2020-03-17 14:54:26 +03:00
|
|
|
|
|
|
|
Use argument ``id`` instead.
|
|
|
|
|
2021-08-23 06:00:04 +03:00
|
|
|
``eject`` argument ``device`` (since 2.8)
|
|
|
|
'''''''''''''''''''''''''''''''''''''''''
|
2020-03-17 14:54:26 +03:00
|
|
|
|
|
|
|
Use argument ``id`` instead.
|
|
|
|
|
2021-08-23 06:00:04 +03:00
|
|
|
``blockdev-change-medium`` argument ``device`` (since 2.8)
|
|
|
|
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
|
2020-03-17 14:54:26 +03:00
|
|
|
|
|
|
|
Use argument ``id`` instead.
|
|
|
|
|
2021-08-23 06:00:04 +03:00
|
|
|
``block_set_io_throttle`` argument ``device`` (since 2.8)
|
|
|
|
'''''''''''''''''''''''''''''''''''''''''''''''''''''''''
|
2020-03-17 14:54:26 +03:00
|
|
|
|
|
|
|
Use argument ``id`` instead.
|
|
|
|
|
2021-08-23 06:00:04 +03:00
|
|
|
``blockdev-add`` empty string argument ``backing`` (since 2.10)
|
|
|
|
'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
|
2020-03-17 14:54:26 +03:00
|
|
|
|
|
|
|
Use argument value ``null`` instead.
|
|
|
|
|
2021-08-23 06:00:04 +03:00
|
|
|
``block-commit`` arguments ``base`` and ``top`` (since 3.1)
|
|
|
|
'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
|
2020-03-17 14:54:26 +03:00
|
|
|
|
|
|
|
Use arguments ``base-node`` and ``top-node`` instead.
|
|
|
|
|
2020-09-24 18:27:13 +03:00
|
|
|
``nbd-server-add`` and ``nbd-server-remove`` (since 5.2)
|
|
|
|
''''''''''''''''''''''''''''''''''''''''''''''''''''''''
|
|
|
|
|
|
|
|
Use the more generic commands ``block-export-add`` and ``block-export-del``
|
2020-10-27 08:05:49 +03:00
|
|
|
instead. As part of this deprecation, where ``nbd-server-add`` used a
|
|
|
|
single ``bitmap``, the new ``block-export-add`` uses a list of ``bitmaps``.
|
2020-09-24 18:27:13 +03:00
|
|
|
|
qapi: Enable enum member introspection to show more than name
The next commit will add feature flags to enum members. There's a
problem, though: query-qmp-schema shows an enum type's members as an
array of member names (SchemaInfoEnum member @values). If it showed
an array of objects with a name member, we could simply add more
members to these objects. Since it's just strings, we can't.
I can see three ways to correct this design mistake:
1. Do it the way we should have done it, plus compatibility goo.
We want a ['SchemaInfoEnumMember'] member in SchemaInfoEnum. Since
changing @values would be a compatibility break, add a new member
@members instead.
@values is now redundant. In my testing, output of
qemu-system-x86_64's query-qmp-schema grows by 11% (18.5KiB).
We can deprecate @values now and drop it later. This will break
outmoded clients. Well-behaved clients such as libvirt are
expected to break cleanly.
2. Like 1, but omit "boring" elements of @member, and empty @member.
@values does not become redundant. @members augments it. Somewhat
cumbersome, but output of query-qmp-schema grows only as we make
enum members non-boring.
There is nothing to deprecate here.
3. Versioned query-qmp-schema.
query-qmp-schema provides either @values or @members. The QMP
client can select which version it wants. There is no redundant
output.
We can deprecate old versions and eventually drop them. This will
break outmoded clients. Breaking cleanly is easier than for 1.
While 1 and 2 operate within the common rules for compatible
evolution apply (section "Compatibility considerations" in
docs/devel/qapi-code-gen.rst), 3 bypasses them. Attractive when
operating within the rules is just too awkward. Not the case here.
This commit implements 1. Libvirt developers prefer it.
Deprecate @values in favour of @members. Since query-qmp-schema
compatibility is pretty fundamental for management applications, an
extended grace period is advised.
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Reviewed-by: Eric Blake <eblake@redhat.com>
Tested-by: Peter Krempa <pkrempa@redhat.com>
Acked-by: Peter Krempa <pkrempa@redhat.com>
Message-Id: <20211025042405.3762351-2-armbru@redhat.com>
Reviewed-by: John Snow <jsnow@redhat.com>
2021-10-25 07:24:01 +03:00
|
|
|
``query-qmp-schema`` return value member ``values`` (since 6.2)
|
|
|
|
'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
|
|
|
|
|
|
|
|
Member ``values`` in return value elements with meta-type ``enum`` is
|
|
|
|
deprecated. Use ``members`` instead.
|
|
|
|
|
2021-11-04 11:58:11 +03:00
|
|
|
``drive-backup`` (since 6.2)
|
|
|
|
''''''''''''''''''''''''''''
|
|
|
|
|
|
|
|
Use ``blockdev-backup`` in combination with ``blockdev-add`` instead.
|
|
|
|
This change primarily separates the creation/opening process of the backup
|
|
|
|
target with explicit, separate steps. ``blockdev-backup`` uses mostly the
|
|
|
|
same arguments as ``drive-backup``, except the ``format`` and ``mode``
|
|
|
|
options are removed in favor of using explicit ``blockdev-create`` and
|
|
|
|
``blockdev-add`` calls. See :doc:`/interop/live-block-operations` for
|
|
|
|
details.
|
|
|
|
|
2024-10-22 22:45:01 +03:00
|
|
|
``query-migrationthreads`` (since 9.2)
|
|
|
|
''''''''''''''''''''''''''''''''''''''
|
|
|
|
|
|
|
|
To be removed with no replacement, as it reports only a limited set of
|
|
|
|
threads (for example, it only reports source side of multifd threads,
|
|
|
|
without reporting any destination threads, or non-multifd source threads).
|
|
|
|
For debugging purpose, please use ``-name $VM,debug-threads=on`` instead.
|
|
|
|
|
2021-11-15 17:54:07 +03:00
|
|
|
Incorrectly typed ``device_add`` arguments (since 6.2)
|
|
|
|
''''''''''''''''''''''''''''''''''''''''''''''''''''''
|
|
|
|
|
|
|
|
Due to shortcomings in the internal implementation of ``device_add``, QEMU
|
|
|
|
incorrectly accepts certain invalid arguments: Any object or list arguments are
|
|
|
|
silently ignored. Other argument types are not checked, but an implicit
|
|
|
|
conversion happens, so that e.g. string values can be assigned to integer
|
|
|
|
device properties or vice versa.
|
|
|
|
|
|
|
|
This is a bug in QEMU that will be fixed in the future so that previously
|
|
|
|
accepted incorrect commands will return an error. Users should make sure that
|
|
|
|
all arguments passed to ``device_add`` are consistent with the documented
|
|
|
|
property types.
|
|
|
|
|
2022-09-14 18:59:41 +03:00
|
|
|
Host Architectures
|
|
|
|
------------------
|
|
|
|
|
2024-10-27 16:07:01 +03:00
|
|
|
Big endian MIPS since 7.2; 32-bit little endian MIPS since 9.2
|
|
|
|
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
|
2022-09-14 18:59:41 +03:00
|
|
|
|
|
|
|
As Debian 10 ("Buster") moved into LTS the big endian 32 bit version of
|
|
|
|
MIPS moved out of support making it hard to maintain our
|
|
|
|
cross-compilation CI tests of the architecture. As we no longer have
|
|
|
|
CI coverage support may bitrot away before the deprecation process
|
2024-10-27 16:07:01 +03:00
|
|
|
completes.
|
|
|
|
|
|
|
|
Likewise, the little endian variant of 32 bit MIPS is not supported by
|
|
|
|
Debian 13 ("Trixie") and newer.
|
|
|
|
|
|
|
|
64 bit little endian MIPS is still a supported host architecture.
|
2022-09-14 18:59:41 +03:00
|
|
|
|
2023-03-06 11:46:54 +03:00
|
|
|
System emulation on 32-bit x86 hosts (since 8.0)
|
|
|
|
''''''''''''''''''''''''''''''''''''''''''''''''
|
|
|
|
|
|
|
|
Support for 32-bit x86 host deployments is increasingly uncommon in mainstream
|
|
|
|
OS distributions given the widespread availability of 64-bit x86 hardware.
|
|
|
|
The QEMU project no longer considers 32-bit x86 support for system emulation to
|
|
|
|
be an effective use of its limited resources, and thus intends to discontinue
|
|
|
|
it. Since all recent x86 hardware from the past >10 years is capable of the
|
|
|
|
64-bit x86 extensions, a corresponding 64-bit OS should be used instead.
|
|
|
|
|
2024-09-16 11:53:43 +03:00
|
|
|
TCG Plugin support not enabled by default on 32-bit hosts (since 9.2)
|
|
|
|
'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
|
|
|
|
|
|
|
|
While it is still possible to enable TCG plugin support for 32-bit
|
|
|
|
hosts there are a number of potential pitfalls when instrumenting
|
|
|
|
64-bit guests. The plugin APIs typically pass most addresses as
|
|
|
|
uint64_t but practices like encoding that address in a host pointer
|
|
|
|
for passing as user-data will lose data. As most software analysis
|
|
|
|
benefits from having plenty of host memory it seems reasonable to
|
|
|
|
encourage users to use 64 bit builds of QEMU for analysis work
|
|
|
|
whatever targets they are instrumenting.
|
2023-03-06 11:46:54 +03:00
|
|
|
|
2024-09-16 11:53:44 +03:00
|
|
|
TCG Plugin support not enabled by default with TCI (since 9.2)
|
|
|
|
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
|
|
|
|
|
|
|
|
While the TCG interpreter can interpret the TCG ops used by plugins it
|
|
|
|
is going to be so much slower it wouldn't make sense for any serious
|
|
|
|
instrumentation. Due to implementation differences there will also be
|
|
|
|
anomalies in things like memory instrumentation.
|
|
|
|
|
2023-11-20 18:08:24 +03:00
|
|
|
System emulator CPUs
|
|
|
|
--------------------
|
|
|
|
|
2024-01-17 17:10:54 +03:00
|
|
|
``power5+`` and ``power7+`` CPU names (since 9.0)
|
|
|
|
'''''''''''''''''''''''''''''''''''''''''''''''''
|
|
|
|
|
|
|
|
The character "+" in device (and thus also CPU) names is not allowed
|
|
|
|
in the QEMU object model anymore. ``power5+``, ``power5+_v2.1``,
|
|
|
|
``power7+`` and ``power7+_v2.1`` are currently still supported via
|
|
|
|
an alias, but for consistency these will get removed in a future
|
|
|
|
release, too. Use ``power5p_v2.1`` and ``power7p_v2.1`` instead.
|
|
|
|
|
2024-04-19 11:48:12 +03:00
|
|
|
``Sun-UltraSparc-IIIi+`` and ``Sun-UltraSparc-IV+`` CPU names (since 9.1)
|
|
|
|
'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
|
|
|
|
|
|
|
|
The character "+" in device (and thus also CPU) names is not allowed
|
|
|
|
in the QEMU object model anymore. ``Sun-UltraSparc-IIIi+`` and
|
|
|
|
``Sun-UltraSparc-IV+`` are currently still supported via a workaround,
|
|
|
|
but for consistency these will get removed in a future release, too.
|
|
|
|
Use ``Sun-UltraSparc-IIIi-plus`` and ``Sun-UltraSparc-IV-plus`` instead.
|
|
|
|
|
2020-02-28 18:36:04 +03:00
|
|
|
System emulator machines
|
|
|
|
------------------------
|
|
|
|
|
2023-04-20 15:22:56 +03:00
|
|
|
Arm ``virt`` machine ``dtb-kaslr-seed`` property (since 7.1)
|
|
|
|
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
|
2022-07-07 13:36:07 +03:00
|
|
|
|
|
|
|
The ``dtb-kaslr-seed`` property on the ``virt`` board has been
|
|
|
|
deprecated; use the new name ``dtb-randomness`` instead. The new name
|
|
|
|
better reflects the way this property affects all random data within
|
|
|
|
the device tree blob, not just the ``kaslr-seed`` node.
|
|
|
|
|
2024-02-28 12:34:35 +03:00
|
|
|
``pc-i440fx-2.4`` up to ``pc-i440fx-2.12`` (since 9.1)
|
|
|
|
''''''''''''''''''''''''''''''''''''''''''''''''''''''
|
2023-10-06 10:52:47 +03:00
|
|
|
|
|
|
|
These old machine types are quite neglected nowadays and thus might have
|
|
|
|
various pitfalls with regards to live migration. Use a newer machine type
|
|
|
|
instead.
|
2024-01-23 09:37:02 +03:00
|
|
|
|
2024-05-07 15:33:32 +03:00
|
|
|
PPC 405 ``ref405ep`` machine (since 9.1)
|
|
|
|
''''''''''''''''''''''''''''''''''''''''
|
|
|
|
|
|
|
|
The ``ref405ep`` machine and PPC 405 CPU have no known users, firmware
|
|
|
|
images are not available, OpenWRT dropped support in 2019, U-Boot in
|
|
|
|
2017, Linux also is dropping support in 2024. It is time to let go of
|
|
|
|
this ancient hardware and focus on newer CPUs and platforms.
|
|
|
|
|
2024-06-24 20:29:18 +03:00
|
|
|
Arm ``tacoma-bmc`` machine (since 9.1)
|
|
|
|
''''''''''''''''''''''''''''''''''''''''
|
|
|
|
|
|
|
|
The ``tacoma-bmc`` machine was a board including an AST2600 SoC based
|
|
|
|
BMC and a witherspoon like OpenPOWER system. It was used for bring up
|
|
|
|
of the AST2600 SoC in labs. It can be easily replaced by the
|
|
|
|
``rainier-bmc`` machine which is a real product.
|
|
|
|
|
2024-09-25 01:08:12 +03:00
|
|
|
Big-Endian variants of MicroBlaze ``petalogix-ml605`` and ``xlnx-zynqmp-pmu`` machines (since 9.2)
|
|
|
|
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
|
|
|
|
|
|
|
|
Both ``petalogix-ml605`` and ``xlnx-zynqmp-pmu`` were added for little endian
|
|
|
|
CPUs. Big endian support is not tested.
|
|
|
|
|
2021-01-11 23:33:32 +03:00
|
|
|
Backend options
|
|
|
|
---------------
|
|
|
|
|
|
|
|
Using non-persistent backing file with pmem=on (since 6.1)
|
|
|
|
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
|
|
|
|
|
|
|
|
This option is used when ``memory-backend-file`` is consumed by emulated NVDIMM
|
|
|
|
device. However enabling ``memory-backend-file.pmem`` option, when backing file
|
|
|
|
is (a) not DAX capable or (b) not on a filesystem that support direct mapping
|
|
|
|
of persistent memory, is not safe and may lead to data loss or corruption in case
|
|
|
|
of host crash.
|
|
|
|
Options are:
|
|
|
|
|
|
|
|
- modify VM configuration to set ``pmem=off`` to continue using fake NVDIMM
|
|
|
|
(without persistence guaranties) with backing file on non DAX storage
|
|
|
|
- move backing file to NVDIMM storage and keep ``pmem=on``
|
|
|
|
(to have NVDIMM with persistence guaranties).
|
|
|
|
|
2020-02-28 18:36:04 +03:00
|
|
|
Device options
|
|
|
|
--------------
|
|
|
|
|
|
|
|
Emulated device options
|
|
|
|
'''''''''''''''''''''''
|
|
|
|
|
2022-04-29 11:33:33 +03:00
|
|
|
``-device nvme-ns,eui64-default=on|off`` (since 7.1)
|
|
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
|
|
|
|
In QEMU versions 6.1, 6.2 and 7.0, the ``nvme-ns`` generates an EUI-64
|
2022-08-12 10:56:42 +03:00
|
|
|
identifier that is not globally unique. If an EUI-64 identifier is required, the
|
2022-04-29 11:33:33 +03:00
|
|
|
user must set it explicitly using the ``nvme-ns`` device parameter ``eui64``.
|
|
|
|
|
2022-04-19 14:24:23 +03:00
|
|
|
``-device nvme,use-intel-id=on|off`` (since 7.1)
|
|
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
|
|
|
|
The ``nvme`` device originally used a PCI Vendor/Device Identifier combination
|
|
|
|
from Intel that was not properly allocated. Since version 5.2, the controller
|
|
|
|
has used a properly allocated identifier. Deprecate the ``use-intel-id``
|
|
|
|
machine compatibility parameter.
|
|
|
|
|
2023-04-21 19:08:27 +03:00
|
|
|
``-device cxl-type3,memdev=xxxx`` (since 8.0)
|
|
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
|
|
|
|
The ``cxl-type3`` device initially only used a single memory backend. With
|
|
|
|
the addition of volatile memory support, it is now necessary to distinguish
|
|
|
|
between persistent and volatile memory backends. As such, memdev is deprecated
|
|
|
|
in favor of persistent-memdev.
|
|
|
|
|
2023-06-26 14:49:06 +03:00
|
|
|
|
target/riscv: deprecate capital 'Z' CPU properties
At this moment there are eleven CPU extension properties that starts
with capital 'Z': Zifencei, Zicsr, Zihintntl, Zihintpause, Zawrs, Zfa,
Zfh, Zfhmin, Zve32f, Zve64f and Zve64d. All other extensions are named
with lower-case letters.
We want all properties to be named with lower-case letters since it's
consistent with the riscv-isa string that we create in the FDT. Having
these 11 properties to be exceptions can be confusing.
Deprecate all of them. Create their lower-case counterpart to be used as
maintained CPU properties. When trying to use any deprecated property a
warning message will be displayed, recommending users to switch to the
lower-case variant:
./build/qemu-system-riscv64 -M virt -cpu rv64,Zifencei=true --nographic
qemu-system-riscv64: warning: CPU property 'Zifencei' is deprecated. Please use 'zifencei' instead
This will give users some time to change their scripts before we remove
the capital 'Z' properties entirely.
Signed-off-by: Daniel Henrique Barboza <dbarboza@ventanamicro.com>
Reviewed-by: Alistair Francis <alistair.francis@wdc.com>
Reviewed-by: Andrew Jones <ajones@ventanamicro.com>
Message-ID: <20231009112817.8896-2-dbarboza@ventanamicro.com>
Signed-off-by: Alistair Francis <alistair.francis@wdc.com>
2023-10-09 14:28:17 +03:00
|
|
|
RISC-V CPU properties which start with capital 'Z' (since 8.2)
|
|
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
|
|
|
|
All RISC-V CPU properties which start with capital 'Z' are being deprecated
|
|
|
|
starting in 8.2. The reason is that they were wrongly added with capital 'Z'
|
|
|
|
in the past. CPU properties were later added with lower-case names, which
|
|
|
|
is the format we want to use from now on.
|
|
|
|
|
|
|
|
Users which try to use these deprecated properties will receive a warning
|
|
|
|
recommending to switch to their stable counterparts:
|
|
|
|
|
|
|
|
- "Zifencei" should be replaced with "zifencei"
|
|
|
|
- "Zicsr" should be replaced with "zicsr"
|
|
|
|
- "Zihintntl" should be replaced with "zihintntl"
|
|
|
|
- "Zihintpause" should be replaced with "zihintpause"
|
|
|
|
- "Zawrs" should be replaced with "zawrs"
|
|
|
|
- "Zfa" should be replaced with "zfa"
|
|
|
|
- "Zfh" should be replaced with "zfh"
|
|
|
|
- "Zfhmin" should be replaced with "zfhmin"
|
|
|
|
- "Zve32f" should be replaced with "zve32f"
|
|
|
|
- "Zve64f" should be replaced with "zve64f"
|
|
|
|
- "Zve64d" should be replaced with "zve64d"
|
|
|
|
|
2024-06-27 09:57:38 +03:00
|
|
|
``-device sd-card,spec_version=1`` (since 9.1)
|
|
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
|
|
|
|
SD physical layer specification v2.00 supersedes the v1.10 one.
|
|
|
|
v2.00 is the default since QEMU 3.0.0.
|
|
|
|
|
2020-02-28 18:36:04 +03:00
|
|
|
Block device options
|
|
|
|
''''''''''''''''''''
|
|
|
|
|
2021-08-23 06:00:04 +03:00
|
|
|
``"backing": ""`` (since 2.12)
|
|
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
2020-02-28 18:36:04 +03:00
|
|
|
|
|
|
|
In order to prevent QEMU from automatically opening an image's backing
|
|
|
|
chain, use ``"backing": null`` instead.
|
|
|
|
|
2021-08-23 06:00:04 +03:00
|
|
|
``rbd`` keyvalue pair encoded filenames: ``""`` (since 3.1)
|
|
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
2020-02-28 18:36:04 +03:00
|
|
|
|
|
|
|
Options for ``rbd`` should be specified according to its runtime options,
|
|
|
|
like other block drivers. Legacy parsing of keyvalue pair encoded
|
|
|
|
filenames is useful to open images with the old format for backing files;
|
|
|
|
These image files should be updated to use the current format.
|
|
|
|
|
|
|
|
Example of legacy encoding::
|
|
|
|
|
|
|
|
json:{"file.driver":"rbd", "file.filename":"rbd:rbd/name"}
|
|
|
|
|
|
|
|
The above, converted to the current supported format::
|
|
|
|
|
|
|
|
json:{"file.driver":"rbd", "file.pool":"rbd", "file.image":"name"}
|
|
|
|
|
2022-12-01 12:08:07 +03:00
|
|
|
``iscsi,password=xxx`` (since 8.0)
|
|
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
|
|
|
|
Specifying the iSCSI password in plain text on the command line using the
|
|
|
|
``password`` option is insecure. The ``password-secret`` option should be
|
|
|
|
used instead, to refer to a ``--object secret...`` instance that provides
|
|
|
|
a password via a file, or encrypted.
|
|
|
|
|
2024-10-02 11:20:33 +03:00
|
|
|
``gluster`` backend (since 9.2)
|
|
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
|
|
|
|
According to https://marc.info/?l=fedora-devel-list&m=171934833215726
|
|
|
|
the GlusterFS development effectively ended. Unless the development
|
|
|
|
gains momentum again, the QEMU project will remove the gluster backend
|
|
|
|
in a future release.
|
|
|
|
|
|
|
|
|
2024-02-03 11:02:28 +03:00
|
|
|
Character device options
|
|
|
|
''''''''''''''''''''''''
|
|
|
|
|
|
|
|
Backend ``memory`` (since 9.0)
|
|
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
|
|
|
|
``memory`` is a deprecated synonym for ``ringbuf``.
|
|
|
|
|
2024-09-13 12:46:04 +03:00
|
|
|
``reconnect`` (since 9.2)
|
|
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
|
|
|
|
The ``reconnect`` option only allows specifiying second granularity timeouts,
|
|
|
|
which is not enough for all types of use cases, use ``reconnect-ms`` instead.
|
|
|
|
|
2024-10-25 10:35:24 +03:00
|
|
|
|
|
|
|
Net device options
|
|
|
|
''''''''''''''''''
|
|
|
|
|
|
|
|
Stream ``reconnect`` (since 9.2)
|
|
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
|
|
|
|
The ``reconnect`` option only allows specifiying second granularity timeouts,
|
|
|
|
which is not enough for all types of use cases, use ``reconnect-ms`` instead.
|
|
|
|
|
2023-10-31 18:37:17 +03:00
|
|
|
CPU device properties
|
|
|
|
'''''''''''''''''''''
|
|
|
|
|
2024-05-08 18:44:12 +03:00
|
|
|
``pcommit`` on x86 (since 9.1)
|
|
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
|
|
|
|
The PCOMMIT instruction was never included in any physical processor.
|
|
|
|
It was implemented as a no-op instruction in TCG up to QEMU 9.0, but
|
|
|
|
only with ``-cpu max`` (which does not guarantee migration compatibility
|
|
|
|
across versions).
|
|
|
|
|
2023-10-31 18:37:17 +03:00
|
|
|
``pmu-num=n`` on RISC-V CPUs (since 8.2)
|
|
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
|
|
|
|
In order to support more flexible counter configurations this has been replaced
|
|
|
|
by a ``pmu-mask`` property. If set of counters is continuous then the mask can
|
|
|
|
be calculated with ``((2 ^ n) - 1) << 3``. The least significant three bits
|
|
|
|
must be left clear.
|
|
|
|
|
|
|
|
|
2020-02-28 18:36:04 +03:00
|
|
|
Backwards compatibility
|
|
|
|
-----------------------
|
|
|
|
|
2021-08-23 06:00:04 +03:00
|
|
|
Runnability guarantee of CPU models (since 4.1)
|
|
|
|
'''''''''''''''''''''''''''''''''''''''''''''''
|
2020-02-28 18:36:04 +03:00
|
|
|
|
|
|
|
Previous versions of QEMU never changed existing CPU models in
|
|
|
|
ways that introduced additional host software or hardware
|
|
|
|
requirements to the VM. This allowed management software to
|
|
|
|
safely change the machine type of an existing VM without
|
|
|
|
introducing new requirements ("runnability guarantee"). This
|
|
|
|
prevented CPU models from being updated to include CPU
|
|
|
|
vulnerability mitigations, leaving guests vulnerable in the
|
|
|
|
default configuration.
|
|
|
|
|
|
|
|
The CPU model runnability guarantee won't apply anymore to
|
|
|
|
existing CPU models. Management software that needs runnability
|
2020-11-17 22:34:48 +03:00
|
|
|
guarantees must resolve the CPU model aliases using the
|
2020-02-28 18:36:04 +03:00
|
|
|
``alias-of`` field returned by the ``query-cpu-definitions`` QMP
|
|
|
|
command.
|
|
|
|
|
|
|
|
While those guarantees are kept, the return value of
|
|
|
|
``query-cpu-definitions`` will have existing CPU model aliases
|
|
|
|
point to a version that doesn't break runnability guarantees
|
|
|
|
(specifically, version 1 of those CPU models). In future QEMU
|
|
|
|
versions, aliases will point to newer CPU model versions
|
|
|
|
depending on the machine type, so management software must
|
|
|
|
resolve CPU model aliases before starting a virtual machine.
|
|
|
|
|
hw/riscv/virt.c: re-insert and deprecate 'riscv,delegate'
Commit b1f1e9dcfa renamed 'riscv,delegate' to 'riscv,delegation' since
it is the correct name as per dt-bindings, and the absence of the
correct name will result in validation fails when dumping the dtb and
using dt-validate.
But this change has a side-effect: every other firmware available that
is AIA capable is using 'riscv,delegate', and it will fault/misbehave if
this property isn't present. The property was added back in QEMU 7.0,
meaning we have 2 years of firmware development using the wrong
property.
Re-introducing 'riscv,delegate' while keeping 'riscv,delegation' allows
older firmwares to keep booting with the 'virt' machine.
'riscv,delegate' is then marked for future deprecation with its use
being discouraged from now on.
Cc: Conor Dooley <conor@kernel.org>
Cc: Anup Patel <apatel@ventanamicro.com>
Fixes: b1f1e9dcfa ("hw/riscv/virt.c: aplic DT: rename prop to 'riscv, delegation'")
Signed-off-by: Daniel Henrique Barboza <dbarboza@ventanamicro.com>
Reviewed-by: Alistair Francis <alistair.francis@wdc.com>
Message-ID: <20240715090455.145888-1-dbarboza@ventanamicro.com>
Signed-off-by: Alistair Francis <alistair.francis@wdc.com>
2024-07-15 12:04:55 +03:00
|
|
|
RISC-V "virt" board "riscv,delegate" DT property (since 9.1)
|
|
|
|
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
|
|
|
|
|
|
|
|
The "riscv,delegate" DT property was added in QEMU 7.0 as part of
|
|
|
|
the AIA APLIC support. The property changed name during the review
|
|
|
|
process in Linux and the correct name ended up being
|
|
|
|
"riscv,delegation". Changing the DT property name will break all
|
|
|
|
available firmwares that are using the current (wrong) name. The
|
|
|
|
property is kept as is in 9.1, together with "riscv,delegation", to
|
|
|
|
give more time for firmware developers to change their code.
|
|
|
|
|
2023-06-12 22:33:39 +03:00
|
|
|
Migration
|
|
|
|
---------
|
|
|
|
|
2024-04-30 17:27:37 +03:00
|
|
|
``fd:`` URI when used for file migration (since 9.1)
|
|
|
|
''''''''''''''''''''''''''''''''''''''''''''''''''''
|
|
|
|
|
|
|
|
The ``fd:`` URI can currently provide a file descriptor that
|
|
|
|
references either a socket or a plain file. These are two different
|
|
|
|
types of migration. In order to reduce ambiguity, the ``fd:`` URI
|
|
|
|
usage of providing a file descriptor to a plain file has been
|
|
|
|
deprecated in favor of explicitly using the ``file:`` URI with the
|
|
|
|
file descriptor being passed as an ``fdset``. Refer to the ``add-fd``
|
|
|
|
command documentation for details on the ``fdset`` usage.
|
2024-09-19 16:46:22 +03:00
|
|
|
|
|
|
|
``zero-blocks`` capability (since 9.2)
|
|
|
|
''''''''''''''''''''''''''''''''''''''
|
|
|
|
|
|
|
|
The ``zero-blocks`` capability was part of the block migration which
|
|
|
|
doesn't exist anymore since it was removed in QEMU v9.1.
|