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