]> git.ipfire.org Git - thirdparty/qemu.git/blame - docs/system/deprecated.rst
nbd: Merge nbd_export_new() and nbd_export_create()
[thirdparty/qemu.git] / docs / system / deprecated.rst
CommitLineData
41fba161
PM
1Deprecated features
2===================
3
4In general features are intended to be supported indefinitely once
5introduced into QEMU. In the event that a feature needs to be removed,
ef1f5b0a
SH
6it will be listed in this section. The feature will remain functional for the
7release in which it was deprecated and one further release. After these two
8releases, the feature is liable to be removed. Deprecated features may also
9generate warnings on the console when QEMU starts up, or if activated via a
10monitor command, however, this is not a mandatory requirement.
41fba161
PM
11
12Prior to the 2.10.0 release there was no official policy on how
13long features would be deprecated prior to their removal, nor
14any documented list of which features were deprecated. Thus
15any features deprecated prior to 2.10.0 will be treated as if
16they were first deprecated in the 2.10.0 release.
17
18What follows is a list of all features currently marked as
19deprecated.
20
21System emulator command line arguments
22--------------------------------------
23
24``-machine enforce-config-section=on|off`` (since 3.1)
25''''''''''''''''''''''''''''''''''''''''''''''''''''''
26
27The ``enforce-config-section`` parameter is replaced by the
28``-global migration.send-configuration={on|off}`` option.
29
30``-no-kvm`` (since 1.3.0)
31'''''''''''''''''''''''''
32
33The ``-no-kvm`` argument is now a synonym for setting ``-accel tcg``.
34
35``-usbdevice`` (since 2.10.0)
36'''''''''''''''''''''''''''''
37
38The ``-usbdevice DEV`` argument is now a synonym for setting
39the ``-device usb-DEV`` argument instead. The deprecated syntax
40would automatically enable USB support on the machine type.
41If using the new syntax, USB support must be explicitly
42enabled via the ``-machine usb=on`` argument.
43
44``-drive file=json:{...{'driver':'file'}}`` (since 3.0)
45'''''''''''''''''''''''''''''''''''''''''''''''''''''''
46
47The 'file' driver for drives is no longer appropriate for character or host
48devices and will only accept regular files (S_IFREG). The correct driver
49for these file types is 'host_cdrom' or 'host_device' as appropriate.
50
41fba161
PM
51``-vnc acl`` (since 4.0.0)
52''''''''''''''''''''''''''
53
54The ``acl`` option to the ``-vnc`` argument has been replaced
55by the ``tls-authz`` and ``sasl-authz`` options.
56
57``QEMU_AUDIO_`` environment variables and ``-audio-help`` (since 4.0)
58'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
59
60The ``-audiodev`` argument is now the preferred way to specify audio
61backend settings instead of environment variables. To ease migration to
62the new format, the ``-audiodev-help`` option can be used to convert
63the current values of the environment variables to ``-audiodev`` options.
64
65Creating sound card devices and vnc without ``audiodev=`` property (since 4.2)
66''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
67
68When not using the deprecated legacy audio config, each sound card
69should specify an ``audiodev=`` property. Additionally, when using
76ca4b58 70vnc, you should specify an ``audiodev=`` property if you plan to
41fba161
PM
71transmit audio through the VNC protocol.
72
825ff029
GH
73Creating sound card devices using ``-soundhw`` (since 5.1)
74''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
75
76Sound card devices should be created using ``-device`` instead. The
77names are the same for most devices. The exceptions are ``hda`` which
78needs two devices (``-device intel-hda -device hda-duplex``) and
79``pcspk`` which can be activated using ``-machine
80pcspk-audiodev=<name>``.
81
41fba161
PM
82``-mon ...,control=readline,pretty=on|off`` (since 4.1)
83'''''''''''''''''''''''''''''''''''''''''''''''''''''''
84
85The ``pretty=on|off`` switch has no effect for HMP monitors, but is
86silently ignored. Using the switch with HMP monitors will become an
87error in the future.
88
89``-realtime`` (since 4.1)
90'''''''''''''''''''''''''
91
92The ``-realtime mlock=on|off`` argument has been replaced by the
93``-overcommit mem-lock=on|off`` argument.
94
f33559a4 95RISC-V ``-bios`` (since 5.1)
41fba161
PM
96''''''''''''''''''''''''''''
97
98QEMU 4.1 introduced support for the -bios option in QEMU for RISC-V for the
f33559a4
AF
99RISC-V virt machine and sifive_u machine. QEMU 4.1 had no changes to the
100default behaviour to avoid breakages.
101
102QEMU 5.1 changes the default behaviour from ``-bios none`` to ``-bios default``.
103
104QEMU 5.1 has three options:
105 1. ``-bios default`` - This is the current default behavior if no -bios option
106 is included. This option will load the default OpenSBI firmware automatically.
107 The firmware is included with the QEMU release and no user interaction is
108 required. All a user needs to do is specify the kernel they want to boot
109 with the -kernel option
110 2. ``-bios none`` - QEMU will not automatically load any firmware. It is up
41fba161 111 to the user to load all the images they need.
41fba161
PM
112 3. ``-bios <file>`` - Tells QEMU to load the specified file as the firmwrae.
113
114``-tb-size`` option (since 5.0)
115'''''''''''''''''''''''''''''''
116
117QEMU 5.0 introduced an alternative syntax to specify the size of the translation
118block cache, ``-accel tcg,tb-size=``. The new syntax deprecates the
119previously available ``-tb-size`` option.
120
121``-show-cursor`` option (since 5.0)
122'''''''''''''''''''''''''''''''''''
123
124Use ``-display sdl,show-cursor=on`` or
125 ``-display gtk,show-cursor=on`` instead.
126
4a27a638
MA
127``Configuring floppies with ``-global``
128'''''''''''''''''''''''''''''''''''''''
129
130Use ``-device floppy,...`` instead:
131::
132
133 -global isa-fdc.driveA=...
134 -global sysbus-fdc.driveA=...
135 -global SUNW,fdtwo.drive=...
136
137become
138::
139
140 -device floppy,unit=0,drive=...
141
142and
143::
144
145 -global isa-fdc.driveB=...
146 -global sysbus-fdc.driveB=...
147
148become
149::
150
151 -device floppy,unit=1,drive=...
152
a1b40bda
MA
153``-drive`` with bogus interface type
154''''''''''''''''''''''''''''''''''''
155
156Drives with interface types other than ``if=none`` are for onboard
157devices. It is possible to use drives the board doesn't pick up with
158-device. This usage is now deprecated. Use ``if=none`` instead.
159
160
41fba161
PM
161QEMU Machine Protocol (QMP) commands
162------------------------------------
163
164``change`` (since 2.5.0)
165''''''''''''''''''''''''
166
167Use ``blockdev-change-medium`` or ``change-vnc-password`` instead.
168
73756ae3
MA
169``blockdev-open-tray``, ``blockdev-close-tray`` argument ``device`` (since 2.8.0)
170'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
171
172Use argument ``id`` instead.
173
174``eject`` argument ``device`` (since 2.8.0)
175'''''''''''''''''''''''''''''''''''''''''''
176
177Use argument ``id`` instead.
178
179``blockdev-change-medium`` argument ``device`` (since 2.8.0)
180''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
181
182Use argument ``id`` instead.
183
184``block_set_io_throttle`` argument ``device`` (since 2.8.0)
185'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
186
187Use argument ``id`` instead.
188
41fba161
PM
189``migrate_set_downtime`` and ``migrate_set_speed`` (since 2.8.0)
190''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
191
192Use ``migrate-set-parameters`` instead.
193
73756ae3
MA
194``query-named-block-nodes`` result ``encryption_key_missing`` (since 2.10.0)
195''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
196
197Always false.
198
199``query-block`` result ``inserted.encryption_key_missing`` (since 2.10.0)
200'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
201
202Always false.
203
204``blockdev-add`` empty string argument ``backing`` (since 2.10.0)
205'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
206
207Use argument value ``null`` instead.
208
41fba161
PM
209``migrate-set-cache-size`` and ``query-migrate-cache-size`` (since 2.11.0)
210''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
211
212Use ``migrate-set-parameters`` and ``query-migrate-parameters`` instead.
213
73756ae3
MA
214``block-commit`` arguments ``base`` and ``top`` (since 3.1.0)
215'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
216
217Use arguments ``base-node`` and ``top-node`` instead.
218
5f07c4d6
KW
219``object-add`` option ``props`` (since 5.0)
220'''''''''''''''''''''''''''''''''''''''''''
221
222Specify the properties for the object as top-level arguments instead.
223
73756ae3
MA
224``query-named-block-nodes`` and ``query-block`` result dirty-bitmaps[i].status (since 4.0)
225''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
41fba161
PM
226
227The ``status`` field of the ``BlockDirtyInfo`` structure, returned by
73756ae3
MA
228these commands is deprecated. Two new boolean fields, ``recording`` and
229``busy`` effectively replace it.
41fba161
PM
230
231``query-block`` result field ``dirty-bitmaps`` (Since 4.2)
232''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
233
234The ``dirty-bitmaps`` field of the ``BlockInfo`` structure, returned by
235the query-block command is itself now deprecated. The ``dirty-bitmaps``
236field of the ``BlockDeviceInfo`` struct should be used instead, which is the
237type of the ``inserted`` field in query-block replies, as well as the
238type of array items in query-named-block-nodes.
239
240Since the ``dirty-bitmaps`` field is optionally present in both the old and
241new locations, clients must use introspection to learn where to anticipate
242the field if/when it does appear in command output.
243
244``query-cpus`` (since 2.12.0)
245'''''''''''''''''''''''''''''
246
247The ``query-cpus`` command is replaced by the ``query-cpus-fast`` command.
248
249``query-cpus-fast`` ``arch`` output member (since 3.0.0)
250''''''''''''''''''''''''''''''''''''''''''''''''''''''''
251
252The ``arch`` output member of the ``query-cpus-fast`` command is
253replaced by the ``target`` output member.
254
41fba161
PM
255``query-events`` (since 4.0)
256''''''''''''''''''''''''''''
257
258The ``query-events`` command has been superseded by the more powerful
259and accurate ``query-qmp-schema`` command.
260
261chardev client socket with ``wait`` option (since 4.0)
262''''''''''''''''''''''''''''''''''''''''''''''''''''''
263
264Character devices creating sockets in client mode should not specify
265the 'wait' field, which is only applicable to sockets in server mode
266
267Human Monitor Protocol (HMP) commands
268-------------------------------------
269
41fba161
PM
270``acl_show``, ``acl_reset``, ``acl_policy``, ``acl_add``, ``acl_remove`` (since 4.0.0)
271''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
272
273The ``acl_show``, ``acl_reset``, ``acl_policy``, ``acl_add``, and
274``acl_remove`` commands are deprecated with no replacement. Authorization
275for VNC should be performed using the pluggable QAuthZ objects.
276
41fba161
PM
277System emulator CPUS
278--------------------
279
22062e54
GK
280``compat`` property of server class POWER CPUs (since 5.0)
281''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
282
283The ``compat`` property used to set backwards compatibility modes for
284the processor has been deprecated. The ``max-cpu-compat`` property of
285the ``pseries`` machine type should be used instead.
286
c66790b5
TH
287``lm32`` CPUs (since 5.2.0)
288'''''''''''''''''''''''''''
289
290The ``lm32`` guest CPU support is deprecated and will be removed in
291a future version of QEMU. The only public user of this architecture
292was the milkymist project, which has been dead for years; there was
293never an upstream Linux port.
294
295``unicore32`` CPUs (since 5.2.0)
296''''''''''''''''''''''''''''''''
297
298The ``unicore32`` guest CPU support is deprecated and will be removed in
299a future version of QEMU. Support for this CPU was removed from the
300upstream Linux kernel, and there is no available upstream toolchain
301to build binaries for it.
302
41fba161
PM
303System emulator devices
304-----------------------
305
306``ide-drive`` (since 4.2)
307'''''''''''''''''''''''''
308
309The 'ide-drive' device is deprecated. Users should use 'ide-hd' or
310'ide-cd' as appropriate to get an IDE hard disk or CD-ROM as needed.
311
312``scsi-disk`` (since 4.2)
313'''''''''''''''''''''''''
314
315The 'scsi-disk' device is deprecated. Users should use 'scsi-hd' or
316'scsi-cd' as appropriate to get a SCSI hard disk or CD-ROM as needed.
317
318System emulator machines
319------------------------
320
321mips ``r4k`` platform (since 5.0)
322'''''''''''''''''''''''''''''''''
323
324This machine type is very old and unmaintained. Users should use the ``malta``
325machine type instead.
326
c3a09ff6
PMD
327mips ``fulong2e`` machine (since 5.1)
328'''''''''''''''''''''''''''''''''''''
329
330This machine has been renamed ``fuloong2e``.
331
41fba161
PM
332``pc-1.0``, ``pc-1.1``, ``pc-1.2`` and ``pc-1.3`` (since 5.0)
333'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
334
335These machine types are very old and likely can not be used for live migration
336from old QEMU versions anymore. A newer machine type should be used instead.
337
41fba161
PM
338Device options
339--------------
340
341Emulated device options
342'''''''''''''''''''''''
343
344``-device virtio-blk,scsi=on|off`` (since 5.0.0)
345^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
346
347The virtio-blk SCSI passthrough feature is a legacy VIRTIO feature. VIRTIO 1.0
348and later do not support it because the virtio-scsi device was introduced for
349full SCSI support. Use virtio-scsi instead when SCSI passthrough is required.
350
351Note this also applies to ``-device virtio-blk-pci,scsi=on|off``, which is an
352alias.
353
354Block device options
355''''''''''''''''''''
356
357``"backing": ""`` (since 2.12.0)
358^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
359
360In order to prevent QEMU from automatically opening an image's backing
361chain, use ``"backing": null`` instead.
362
363``rbd`` keyvalue pair encoded filenames: ``""`` (since 3.1.0)
364^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
365
366Options for ``rbd`` should be specified according to its runtime options,
367like other block drivers. Legacy parsing of keyvalue pair encoded
368filenames is useful to open images with the old format for backing files;
369These image files should be updated to use the current format.
370
371Example of legacy encoding::
372
373 json:{"file.driver":"rbd", "file.filename":"rbd:rbd/name"}
374
375The above, converted to the current supported format::
376
377 json:{"file.driver":"rbd", "file.pool":"rbd", "file.image":"name"}
378
0f10bf84
PM
379linux-user mode CPUs
380--------------------
381
382``tilegx`` CPUs (since 5.1.0)
383'''''''''''''''''''''''''''''
384
385The ``tilegx`` guest CPU support (which was only implemented in
386linux-user mode) is deprecated and will be removed in a future version
387of QEMU. Support for this CPU was removed from the upstream Linux
388kernel in 2018, and has also been dropped from glibc.
389
c609274b
AB
390``ppc64abi32`` CPUs (since 5.2.0)
391'''''''''''''''''''''''''''''''''
392
393The ``ppc64abi32`` architecture has a number of issues which regularly
394trip up our CI testing and is suspected to be quite broken. For that
395reason the maintainers strongly suspect no one actually uses it.
396
41fba161
PM
397Related binaries
398----------------
399
bc5ee6da
EB
400qemu-img amend to adjust backing file (since 5.1)
401'''''''''''''''''''''''''''''''''''''''''''''''''
402
403The use of ``qemu-img amend`` to modify the name or format of a qcow2
404backing image is deprecated; this functionality was never fully
405documented or tested, and interferes with other amend operations that
406need access to the original backing image (such as deciding whether a
407v3 zero cluster may be left unallocated when converting to a v2
408image). Rather, any changes to the backing chain should be performed
409with ``qemu-img rebase -u`` either before or after the remaining
410changes being performed by amend, as appropriate.
411
d9f059aa
EB
412qemu-img backing file without format (since 5.1)
413''''''''''''''''''''''''''''''''''''''''''''''''
414
415The use of ``qemu-img create``, ``qemu-img rebase``, or ``qemu-img
416convert`` to create or modify an image that depends on a backing file
417now recommends that an explicit backing format be provided. This is
418for safety: if QEMU probes a different format than what you thought,
419the data presented to the guest will be corrupt; similarly, presenting
420a raw image to a guest allows a potential security exploit if a future
421probe sees a non-raw image based on guest writes.
422
423To avoid the warning message, or even future refusal to create an
424unsafe image, you must pass ``-o backing_fmt=`` (or the shorthand
425``-F`` during create) to specify the intended backing format. You may
426use ``qemu-img rebase -u`` to retroactively add a backing format to an
427existing image. However, be aware that there are already potential
428security risks to blindly using ``qemu-img info`` to probe the format
429of an untrusted backing image, when deciding what format to add into
430an existing image.
431
41fba161
PM
432Backwards compatibility
433-----------------------
434
435Runnability guarantee of CPU models (since 4.1.0)
436'''''''''''''''''''''''''''''''''''''''''''''''''
437
438Previous versions of QEMU never changed existing CPU models in
439ways that introduced additional host software or hardware
440requirements to the VM. This allowed management software to
441safely change the machine type of an existing VM without
442introducing new requirements ("runnability guarantee"). This
443prevented CPU models from being updated to include CPU
444vulnerability mitigations, leaving guests vulnerable in the
445default configuration.
446
447The CPU model runnability guarantee won't apply anymore to
448existing CPU models. Management software that needs runnability
449guarantees must resolve the CPU model aliases using te
450``alias-of`` field returned by the ``query-cpu-definitions`` QMP
451command.
452
453While those guarantees are kept, the return value of
454``query-cpu-definitions`` will have existing CPU model aliases
455point to a version that doesn't break runnability guarantees
456(specifically, version 1 of those CPU models). In future QEMU
457versions, aliases will point to newer CPU model versions
458depending on the machine type, so management software must
459resolve CPU model aliases before starting a virtual machine.
460
461
462Recently removed features
463=========================
464
465What follows is a record of recently removed, formerly deprecated
466features that serves as a record for users who have encountered
467trouble after a recent upgrade.
468
9d903f30
TH
469System emulator command line arguments
470--------------------------------------
471
472``-net ...,name=``\ *name* (removed in 5.1)
473'''''''''''''''''''''''''''''''''''''''''''
474
475The ``name`` parameter of the ``-net`` option was a synonym
476for the ``id`` parameter, which should now be used instead.
477
41fba161
PM
478QEMU Machine Protocol (QMP) commands
479------------------------------------
480
481``block-dirty-bitmap-add`` "autoload" parameter (since 4.2.0)
482'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
483
484The "autoload" parameter has been ignored since 2.12.0. All bitmaps
485are automatically loaded from qcow2 images.
486
63e79833
IM
487``cpu-add`` (removed in 5.2)
488''''''''''''''''''''''''''''
489
490Use ``device_add`` for hotplugging vCPUs instead of ``cpu-add``. See
491documentation of ``query-hotpluggable-cpus`` for additional details.
492
b4983c57
TH
493Human Monitor Protocol (HMP) commands
494-------------------------------------
495
496The ``hub_id`` parameter of ``hostfwd_add`` / ``hostfwd_remove`` (removed in 5.0)
497'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
498
499The ``[hub_id name]`` parameter tuple of the 'hostfwd_add' and
500'hostfwd_remove' HMP commands has been replaced by ``netdev_id``.
501
63e79833
IM
502``cpu-add`` (removed in 5.2)
503''''''''''''''''''''''''''''
504
505Use ``device_add`` for hotplugging vCPUs instead of ``cpu-add``. See
506documentation of ``query-hotpluggable-cpus`` for additional details.
507
1a9540d1
AF
508Guest Emulator ISAs
509-------------------
510
76ca4b58 511RISC-V ISA privilege specification version 1.09.1 (removed in 5.1)
1a9540d1
AF
512''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
513
76ca4b58 514The RISC-V ISA privilege specification version 1.09.1 has been removed.
1a9540d1
AF
515QEMU supports both the newer version 1.10.0 and the ratified version 1.11.0, these
516should be used instead of the 1.09.1 version.
517
65a117da
AF
518System emulator CPUS
519--------------------
520
82bf7ae8
PM
521KVM guest support on 32-bit Arm hosts (removed in 5.2)
522''''''''''''''''''''''''''''''''''''''''''''''''''''''
523
524The Linux kernel has dropped support for allowing 32-bit Arm systems
525to host KVM guests as of the 5.7 kernel. Accordingly, QEMU is deprecating
526its support for this configuration and will remove it in a future version.
527Running 32-bit guests on a 64-bit Arm host remains supported.
528
65a117da
AF
529RISC-V ISA Specific CPUs (removed in 5.1)
530'''''''''''''''''''''''''''''''''''''''''
531
532The RISC-V cpus with the ISA version in the CPU name have been removed. The
533four CPUs are: ``rv32gcsu-v1.9.1``, ``rv32gcsu-v1.10.0``, ``rv64gcsu-v1.9.1`` and
534``rv64gcsu-v1.10.0``. Instead the version can be specified via the CPU ``priv_spec``
535option when using the ``rv32`` or ``rv64`` CPUs.
536
537RISC-V no MMU CPUs (removed in 5.1)
538'''''''''''''''''''''''''''''''''''
539
540The RISC-V no MMU cpus have been removed. The two CPUs: ``rv32imacu-nommu`` and
541``rv64imacu-nommu`` can no longer be used. Instead the MMU status can be specified
542via the CPU ``mmu`` option when using the ``rv32`` or ``rv64`` CPUs.
543
26cd0362
AF
544System emulator machines
545------------------------
546
547``spike_v1.9.1`` and ``spike_v1.10`` (removed in 5.1)
548'''''''''''''''''''''''''''''''''''''''''''''''''''''
549
550The version specific Spike machines have been removed in favour of the
551generic ``spike`` machine. If you need to specify an older version of the RISC-V
552spec you can use the ``-cpu rv64gcsu,priv_spec=v1.10.0`` command line argument.
553
41fba161
PM
554Related binaries
555----------------
556
25956af3
EB
557``qemu-nbd --partition`` (removed in 5.0)
558'''''''''''''''''''''''''''''''''''''''''
41fba161
PM
559
560The ``qemu-nbd --partition $digit`` code (also spelled ``-P``)
561could only handle MBR partitions, and never correctly handled logical
562partitions beyond partition 5. Exporting a partition can still be
563done by utilizing the ``--image-opts`` option with a raw blockdev
564using the ``offset`` and ``size`` parameters layered on top of
565any other existing blockdev. For example, if partition 1 is 100MiB
566long starting at 1MiB, the old command::
567
568 qemu-nbd -t -P 1 -f qcow2 file.qcow2
569
570can be rewritten as::
571
572 qemu-nbd -t --image-opts driver=raw,offset=1M,size=100M,file.driver=qcow2,file.file.driver=file,file.file.filename=file.qcow2
32a354dc 573
25956af3
EB
574``qemu-img convert -n -o`` (removed in 5.1)
575'''''''''''''''''''''''''''''''''''''''''''
576
577All options specified in ``-o`` are image creation options, so
578they are now rejected when used with ``-n`` to skip image creation.
579
add8200d
EB
580
581``qemu-img create -b bad file $size`` (removed in 5.1)
582''''''''''''''''''''''''''''''''''''''''''''''''''''''
583
584When creating an image with a backing file that could not be opened,
585``qemu-img create`` used to issue a warning about the failure but
586proceed with the image creation if an explicit size was provided.
587However, as the ``-u`` option exists for this purpose, it is safer to
588enforce that any failure to open the backing image (including if the
589backing file is missing or an incorrect format was specified) is an
590error when ``-u`` is not used.
591
32a354dc
IM
592Command line options
593--------------------
594
c01f250c
IM
595``-smp`` (invalid topologies) (removed 5.2)
596'''''''''''''''''''''''''''''''''''''''''''
597
598CPU topology properties should describe whole machine topology including
599possible CPUs.
600
601However, historically it was possible to start QEMU with an incorrect topology
602where *n* <= *sockets* * *cores* * *threads* < *maxcpus*,
603which could lead to an incorrect topology enumeration by the guest.
604Support for invalid topologies is removed, the user must ensure
605topologies described with -smp include all possible cpus, i.e.
606*sockets* * *cores* * *threads* = *maxcpus*.
607
b21aa7e0
IM
608``-numa`` node (without memory specified) (removed 5.2)
609'''''''''''''''''''''''''''''''''''''''''''''''''''''''
610
611Splitting RAM by default between NUMA nodes had the same issues as ``mem``
612parameter with the difference that the role of the user plays QEMU using
613implicit generic or board specific splitting rule.
614Use ``memdev`` with *memory-backend-ram* backend or ``mem`` (if
615it's supported by used machine type) to define mapping explictly instead.
616Users of existing VMs, wishing to preserve the same RAM distribution, should
617configure it explicitly using ``-numa node,memdev`` options. Current RAM
618distribution can be retrieved using HMP command ``info numa`` and if separate
619memory devices (pc|nv-dimm) are present use ``info memory-device`` and subtract
620device memory from output of ``info numa``.
621
32a354dc
IM
622``-numa node,mem=``\ *size* (removed in 5.1)
623''''''''''''''''''''''''''''''''''''''''''''
624
625The parameter ``mem`` of ``-numa node`` was used to assign a part of
626guest RAM to a NUMA node. But when using it, it's impossible to manage a specified
627RAM chunk on the host side (like bind it to a host node, setting bind policy, ...),
628so the guest ends up with the fake NUMA configuration with suboptiomal performance.
629However since 2014 there is an alternative way to assign RAM to a NUMA node
630using parameter ``memdev``, which does the same as ``mem`` and adds
631means to actually manage node RAM on the host side. Use parameter ``memdev``
632with *memory-backend-ram* backend as replacement for parameter ``mem``
633to achieve the same fake NUMA effect or a properly configured
634*memory-backend-file* backend to actually benefit from NUMA configuration.
635New machine versions (since 5.1) will not accept the option but it will still
636work with old machine types. User can check the QAPI schema to see if the legacy
637option is supported by looking at MachineInfo::numa-mem-supported property.
a0846452 638
c01f250c
IM
639``-mem-path`` fallback to RAM (removed in 5.0)
640''''''''''''''''''''''''''''''''''''''''''''''
c4332cd1 641
c01f250c
IM
642If guest RAM allocation from file pointed by ``mem-path`` failed,
643QEMU was falling back to allocating from RAM, which might have resulted
644in unpredictable behavior since the backing file specified by the user
645as ignored. Currently, users are responsible for making sure the backing storage
646specified with ``-mem-path`` can actually provide the guest RAM configured with
647``-m`` and QEMU fails to start up if RAM allocation is unsuccessful.
c4332cd1 648
b057f096
IM
649``-smp`` (invalid topologies) (removed 5.2)
650'''''''''''''''''''''''''''''''''''''''''''
651
652CPU topology properties should describe whole machine topology including
653possible CPUs.
654
655However, historically it was possible to start QEMU with an incorrect topology
656where *n* <= *sockets* * *cores* * *threads* < *maxcpus*,
657which could lead to an incorrect topology enumeration by the guest.
658Support for invalid topologies is removed, the user must ensure
659topologies described with -smp include all possible cpus, i.e.
660*sockets* * *cores* * *threads* = *maxcpus*.
661
a0846452
MAL
662Block devices
663-------------
664
665VXHS backend (removed in 5.1)
666'''''''''''''''''''''''''''''
667
668The VXHS code does not compile since v2.12.0. It was removed in 5.1.