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