qapi/qom: Drop deprecated 'props' from object-add
[qemu/kevin.git] / docs / system / removed-features.rst
blobd0244fb22e25fb9dc8fa6f21ae2723b46606b0de
2 Removed features
3 ================
5 What follows is a record of recently removed, formerly deprecated
6 features that serves as a record for users who have encountered
7 trouble after a recent upgrade.
9 System emulator command line arguments
10 --------------------------------------
12 ``-net ...,name=``\ *name* (removed in 5.1)
13 '''''''''''''''''''''''''''''''''''''''''''
15 The ``name`` parameter of the ``-net`` option was a synonym
16 for the ``id`` parameter, which should now be used instead.
18 ``-no-kvm`` (removed in 5.2)
19 ''''''''''''''''''''''''''''
21 The ``-no-kvm`` argument was a synonym for setting ``-machine accel=tcg``.
23 ``-realtime`` (removed in 6.0)
24 ''''''''''''''''''''''''''''''
26 The ``-realtime mlock=on|off`` argument has been replaced by the
27 ``-overcommit mem-lock=on|off`` argument.
29 ``-show-cursor`` option (removed in 6.0)
30 ''''''''''''''''''''''''''''''''''''''''
32 Use ``-display sdl,show-cursor=on``, ``-display gtk,show-cursor=on``
33 or ``-display default,show-cursor=on`` instead.
35 ``-tb-size`` option (removed in 6.0)
36 ''''''''''''''''''''''''''''''''''''
38 QEMU 5.0 introduced an alternative syntax to specify the size of the translation
39 block cache, ``-accel tcg,tb-size=``.
41 ``-usbdevice audio`` (removed in 6.0)
42 '''''''''''''''''''''''''''''''''''''
44 This option lacked the possibility to specify an audio backend device.
45 Use ``-device usb-audio`` now instead (and specify a corresponding USB
46 host controller or ``-usb`` if necessary).
48 ``-vnc acl`` (removed in 6.0)
49 '''''''''''''''''''''''''''''
51 The ``acl`` option to the ``-vnc`` argument has been replaced
52 by the ``tls-authz`` and ``sasl-authz`` options.
54 ``-mon ...,control=readline,pretty=on|off`` (removed in 6.0)
55 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
57 The ``pretty=on|off`` switch has no effect for HMP monitors and
58 its use is rejected.
60 ``-drive file=json:{...{'driver':'file'}}`` (removed 6.0)
61 '''''''''''''''''''''''''''''''''''''''''''''''''''''''''
63 The 'file' driver for drives is no longer appropriate for character or host
64 devices and will only accept regular files (S_IFREG). The correct driver
65 for these file types is 'host_cdrom' or 'host_device' as appropriate.
67 QEMU Machine Protocol (QMP) commands
68 ------------------------------------
70 ``block-dirty-bitmap-add`` "autoload" parameter (removed in 4.2.0)
71 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
73 The "autoload" parameter has been ignored since 2.12.0. All bitmaps
74 are automatically loaded from qcow2 images.
76 ``cpu-add`` (removed in 5.2)
77 ''''''''''''''''''''''''''''
79 Use ``device_add`` for hotplugging vCPUs instead of ``cpu-add``.  See
80 documentation of ``query-hotpluggable-cpus`` for additional details.
82 ``change`` (removed in 6.0)
83 '''''''''''''''''''''''''''
85 Use ``blockdev-change-medium`` or ``change-vnc-password`` instead.
87 ``query-events`` (removed in 6.0)
88 '''''''''''''''''''''''''''''''''
90 The ``query-events`` command has been superseded by the more powerful
91 and accurate ``query-qmp-schema`` command.
93 ``migrate_set_cache_size`` and ``query-migrate-cache-size`` (removed in 6.0)
94 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
96 Use ``migrate_set_parameter`` and ``info migrate_parameters`` instead.
98 ``migrate_set_downtime`` and ``migrate_set_speed`` (removed in 6.0)
99 '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
101 Use ``migrate_set_parameter`` instead.
103 ``query-cpus`` (removed in 6.0)
104 '''''''''''''''''''''''''''''''
106 The ``query-cpus`` command is replaced by the ``query-cpus-fast`` command.
108 ``query-cpus-fast`` ``arch`` output member (removed in 6.0)
109 '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
111 The ``arch`` output member of the ``query-cpus-fast`` command is
112 replaced by the ``target`` output member.
114 chardev client socket with ``wait`` option (removed in 6.0)
115 '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
117 Character devices creating sockets in client mode should not specify
118 the 'wait' field, which is only applicable to sockets in server mode
120 ``query-named-block-nodes`` result ``encryption_key_missing`` (removed in 6.0)
121 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
123 Removed with no replacement.
125 ``query-block`` result ``inserted.encryption_key_missing`` (removed in 6.0)
126 '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
128 Removed with no replacement.
130 ``query-named-block-nodes`` and ``query-block`` result dirty-bitmaps[i].status (removed in 6.0)
131 '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
133 The ``status`` field of the ``BlockDirtyInfo`` structure, returned by
134 these commands is removed. Two new boolean fields, ``recording`` and
135 ``busy`` effectively replace it.
137 ``query-block`` result field ``dirty-bitmaps`` (removed in 6.0)
138 '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
140 The ``dirty-bitmaps`` field of the ``BlockInfo`` structure, returned by
141 the query-block command is itself now removed. The ``dirty-bitmaps``
142 field of the ``BlockDeviceInfo`` struct should be used instead, which is the
143 type of the ``inserted`` field in query-block replies, as well as the
144 type of array items in query-named-block-nodes.
146 ``object-add`` option ``props`` (removed in 6.0)
147 ''''''''''''''''''''''''''''''''''''''''''''''''
149 Specify the properties for the object as top-level arguments instead.
151 Human Monitor Protocol (HMP) commands
152 -------------------------------------
154 The ``hub_id`` parameter of ``hostfwd_add`` / ``hostfwd_remove`` (removed in 5.0)
155 '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
157 The ``[hub_id name]`` parameter tuple of the 'hostfwd_add' and
158 'hostfwd_remove' HMP commands has been replaced by ``netdev_id``.
160 ``cpu-add`` (removed in 5.2)
161 ''''''''''''''''''''''''''''
163 Use ``device_add`` for hotplugging vCPUs instead of ``cpu-add``.  See
164 documentation of ``query-hotpluggable-cpus`` for additional details.
166 ``change vnc TARGET`` (removed in 6.0)
167 ''''''''''''''''''''''''''''''''''''''
169 No replacement.  The ``change vnc password`` and ``change DEVICE MEDIUM``
170 commands are not affected.
172 ``acl_show``, ``acl_reset``, ``acl_policy``, ``acl_add``, ``acl_remove`` (removed in 6.0)
173 '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
175 The ``acl_show``, ``acl_reset``, ``acl_policy``, ``acl_add``, and
176 ``acl_remove`` commands were removed with no replacement. Authorization
177 for VNC should be performed using the pluggable QAuthZ objects.
179 ``migrate-set-cache-size`` and ``info migrate-cache-size`` (removed in 6.0)
180 '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
182 Use ``migrate-set-parameters`` and ``info migrate-parameters`` instead.
184 ``migrate_set_downtime`` and ``migrate_set_speed`` (removed in 6.0)
185 '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
187 Use ``migrate-set-parameters`` instead.
189 Guest Emulator ISAs
190 -------------------
192 RISC-V ISA privilege specification version 1.09.1 (removed in 5.1)
193 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
195 The RISC-V ISA privilege specification version 1.09.1 has been removed.
196 QEMU supports both the newer version 1.10.0 and the ratified version 1.11.0, these
197 should be used instead of the 1.09.1 version.
199 System emulator CPUS
200 --------------------
202 KVM guest support on 32-bit Arm hosts (removed in 5.2)
203 ''''''''''''''''''''''''''''''''''''''''''''''''''''''
205 The Linux kernel has dropped support for allowing 32-bit Arm systems
206 to host KVM guests as of the 5.7 kernel. Accordingly, QEMU is deprecating
207 its support for this configuration and will remove it in a future version.
208 Running 32-bit guests on a 64-bit Arm host remains supported.
210 RISC-V ISA Specific CPUs (removed in 5.1)
211 '''''''''''''''''''''''''''''''''''''''''
213 The RISC-V cpus with the ISA version in the CPU name have been removed. The
214 four CPUs are: ``rv32gcsu-v1.9.1``, ``rv32gcsu-v1.10.0``, ``rv64gcsu-v1.9.1`` and
215 ``rv64gcsu-v1.10.0``. Instead the version can be specified via the CPU ``priv_spec``
216 option when using the ``rv32`` or ``rv64`` CPUs.
218 RISC-V no MMU CPUs (removed in 5.1)
219 '''''''''''''''''''''''''''''''''''
221 The RISC-V no MMU cpus have been removed. The two CPUs: ``rv32imacu-nommu`` and
222 ``rv64imacu-nommu`` can no longer be used. Instead the MMU status can be specified
223 via the CPU ``mmu`` option when using the ``rv32`` or ``rv64`` CPUs.
225 System emulator machines
226 ------------------------
228 ``spike_v1.9.1`` and ``spike_v1.10`` (removed in 5.1)
229 '''''''''''''''''''''''''''''''''''''''''''''''''''''
231 The version specific Spike machines have been removed in favour of the
232 generic ``spike`` machine. If you need to specify an older version of the RISC-V
233 spec you can use the ``-cpu rv64gcsu,priv_spec=v1.10.0`` command line argument.
235 mips ``r4k`` platform (removed in 5.2)
236 ''''''''''''''''''''''''''''''''''''''
238 This machine type was very old and unmaintained. Users should use the ``malta``
239 machine type instead.
241 mips ``fulong2e`` machine alias (removed in 6.0)
242 ''''''''''''''''''''''''''''''''''''''''''''''''
244 This machine has been renamed ``fuloong2e``.
246 ``pc-1.0``, ``pc-1.1``, ``pc-1.2`` and ``pc-1.3`` (removed in 6.0)
247 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
249 These machine types were very old and likely could not be used for live
250 migration from old QEMU versions anymore. Use a newer machine type instead.
253 linux-user mode CPUs
254 --------------------
256 ``tilegx`` CPUs (removed in 6.0)
257 ''''''''''''''''''''''''''''''''
259 The ``tilegx`` guest CPU support has been removed without replacement. It was
260 only implemented in linux-user mode, but support for this CPU was removed from
261 the upstream Linux kernel in 2018, and it has also been dropped from glibc, so
262 there is no new Linux development taking place with this architecture. For
263 running the old binaries, you can use older versions of QEMU.
265 System emulator devices
266 -----------------------
268 ``ide-drive`` (removed in 6.0)
269 ''''''''''''''''''''''''''''''
271 The 'ide-drive' device has been removed. Users should use 'ide-hd' or
272 'ide-cd' as appropriate to get an IDE hard disk or CD-ROM as needed.
274 ``scsi-disk`` (removed in 6.0)
275 ''''''''''''''''''''''''''''''
277 The 'scsi-disk' device has been removed. Users should use 'scsi-hd' or
278 'scsi-cd' as appropriate to get a SCSI hard disk or CD-ROM as needed.
280 Related binaries
281 ----------------
283 ``qemu-nbd --partition`` (removed in 5.0)
284 '''''''''''''''''''''''''''''''''''''''''
286 The ``qemu-nbd --partition $digit`` code (also spelled ``-P``)
287 could only handle MBR partitions, and never correctly handled logical
288 partitions beyond partition 5.  Exporting a partition can still be
289 done by utilizing the ``--image-opts`` option with a raw blockdev
290 using the ``offset`` and ``size`` parameters layered on top of
291 any other existing blockdev. For example, if partition 1 is 100MiB
292 long starting at 1MiB, the old command::
294   qemu-nbd -t -P 1 -f qcow2 file.qcow2
296 can be rewritten as::
298   qemu-nbd -t --image-opts driver=raw,offset=1M,size=100M,file.driver=qcow2,file.file.driver=file,file.file.filename=file.qcow2
300 ``qemu-img convert -n -o`` (removed in 5.1)
301 '''''''''''''''''''''''''''''''''''''''''''
303 All options specified in ``-o`` are image creation options, so
304 they are now rejected when used with ``-n`` to skip image creation.
307 ``qemu-img create -b bad file $size`` (removed in 5.1)
308 ''''''''''''''''''''''''''''''''''''''''''''''''''''''
310 When creating an image with a backing file that could not be opened,
311 ``qemu-img create`` used to issue a warning about the failure but
312 proceed with the image creation if an explicit size was provided.
313 However, as the ``-u`` option exists for this purpose, it is safer to
314 enforce that any failure to open the backing image (including if the
315 backing file is missing or an incorrect format was specified) is an
316 error when ``-u`` is not used.
318 Command line options
319 --------------------
321 ``-smp`` (invalid topologies) (removed 5.2)
322 '''''''''''''''''''''''''''''''''''''''''''
324 CPU topology properties should describe whole machine topology including
325 possible CPUs.
327 However, historically it was possible to start QEMU with an incorrect topology
328 where *n* <= *sockets* * *cores* * *threads* < *maxcpus*,
329 which could lead to an incorrect topology enumeration by the guest.
330 Support for invalid topologies is removed, the user must ensure
331 topologies described with -smp include all possible cpus, i.e.
332 *sockets* * *cores* * *threads* = *maxcpus*.
334 ``-numa`` node (without memory specified) (removed 5.2)
335 '''''''''''''''''''''''''''''''''''''''''''''''''''''''
337 Splitting RAM by default between NUMA nodes had the same issues as ``mem``
338 parameter with the difference that the role of the user plays QEMU using
339 implicit generic or board specific splitting rule.
340 Use ``memdev`` with *memory-backend-ram* backend or ``mem`` (if
341 it's supported by used machine type) to define mapping explicitly instead.
342 Users of existing VMs, wishing to preserve the same RAM distribution, should
343 configure it explicitly using ``-numa node,memdev`` options. Current RAM
344 distribution can be retrieved using HMP command ``info numa`` and if separate
345 memory devices (pc|nv-dimm) are present use ``info memory-device`` and subtract
346 device memory from output of ``info numa``.
348 ``-numa node,mem=``\ *size* (removed in 5.1)
349 ''''''''''''''''''''''''''''''''''''''''''''
351 The parameter ``mem`` of ``-numa node`` was used to assign a part of
352 guest RAM to a NUMA node. But when using it, it's impossible to manage a specified
353 RAM chunk on the host side (like bind it to a host node, setting bind policy, ...),
354 so the guest ends up with the fake NUMA configuration with suboptiomal performance.
355 However since 2014 there is an alternative way to assign RAM to a NUMA node
356 using parameter ``memdev``, which does the same as ``mem`` and adds
357 means to actually manage node RAM on the host side. Use parameter ``memdev``
358 with *memory-backend-ram* backend as replacement for parameter ``mem``
359 to achieve the same fake NUMA effect or a properly configured
360 *memory-backend-file* backend to actually benefit from NUMA configuration.
361 New machine versions (since 5.1) will not accept the option but it will still
362 work with old machine types. User can check the QAPI schema to see if the legacy
363 option is supported by looking at MachineInfo::numa-mem-supported property.
365 ``-mem-path`` fallback to RAM (removed in 5.0)
366 ''''''''''''''''''''''''''''''''''''''''''''''
368 If guest RAM allocation from file pointed by ``mem-path`` failed,
369 QEMU was falling back to allocating from RAM, which might have resulted
370 in unpredictable behavior since the backing file specified by the user
371 as ignored. Currently, users are responsible for making sure the backing storage
372 specified with ``-mem-path`` can actually provide the guest RAM configured with
373 ``-m`` and QEMU fails to start up if RAM allocation is unsuccessful.
375 ``-smp`` (invalid topologies) (removed 5.2)
376 '''''''''''''''''''''''''''''''''''''''''''
378 CPU topology properties should describe whole machine topology including
379 possible CPUs.
381 However, historically it was possible to start QEMU with an incorrect topology
382 where *n* <= *sockets* * *cores* * *threads* < *maxcpus*,
383 which could lead to an incorrect topology enumeration by the guest.
384 Support for invalid topologies is removed, the user must ensure
385 topologies described with -smp include all possible cpus, i.e.
386 *sockets* * *cores* * *threads* = *maxcpus*.
388 ``-machine enforce-config-section=on|off`` (removed 5.2)
389 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''
391 The ``enforce-config-section`` property was replaced by the
392 ``-global migration.send-configuration={on|off}`` option.
394 Block devices
395 -------------
397 VXHS backend (removed in 5.1)
398 '''''''''''''''''''''''''''''
400 The VXHS code did not compile since v2.12.0. It was removed in 5.1.