Merge remote-tracking branch 'remotes/ehabkost/tags/machine-next-pull-request' into...
[qemu/ar7.git] / docs / system / deprecated.rst
blob09c8f380bc82ded38074900aded28e9d42c11ba1
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.  As part of this deprecation, where ``nbd-server-add`` used a
261 single ``bitmap``, the new ``block-export-add`` uses a list of ``bitmaps``.
263 Human Monitor Protocol (HMP) commands
264 -------------------------------------
266 ``acl_show``, ``acl_reset``, ``acl_policy``, ``acl_add``, ``acl_remove`` (since 4.0.0)
267 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
269 The ``acl_show``, ``acl_reset``, ``acl_policy``, ``acl_add``, and
270 ``acl_remove`` commands are deprecated with no replacement. Authorization
271 for VNC should be performed using the pluggable QAuthZ objects.
273 System emulator CPUS
274 --------------------
276 ``moxie`` CPU (since 5.2.0)
277 '''''''''''''''''''''''''''
279 The ``moxie`` guest CPU support is deprecated and will be removed in
280 a future version of QEMU. It's unclear whether anybody is still using
281 CPU emulation in QEMU, and there are no test images available to make
282 sure that the code is still working.
284 ``lm32`` CPUs (since 5.2.0)
285 '''''''''''''''''''''''''''
287 The ``lm32`` guest CPU support is deprecated and will be removed in
288 a future version of QEMU. The only public user of this architecture
289 was the milkymist project, which has been dead for years; there was
290 never an upstream Linux port.
292 ``unicore32`` CPUs (since 5.2.0)
293 ''''''''''''''''''''''''''''''''
295 The ``unicore32`` guest CPU support is deprecated and will be removed in
296 a future version of QEMU. Support for this CPU was removed from the
297 upstream Linux kernel, and there is no available upstream toolchain
298 to build binaries for it.
300 ``Icelake-Client`` CPU Model (since 5.2.0)
301 ''''''''''''''''''''''''''''''''''''''''''
303 ``Icelake-Client`` CPU Models are deprecated. Use ``Icelake-Server`` CPU
304 Models instead.
306 MIPS ``I7200`` CPU Model (since 5.2)
307 ''''''''''''''''''''''''''''''''''''
309 The ``I7200`` guest CPU relies on the nanoMIPS ISA, which is deprecated
310 (the ISA has never been upstreamed to a compiler toolchain). Therefore
311 this CPU is also deprecated.
313 System emulator devices
314 -----------------------
316 ``ide-drive`` (since 4.2)
317 '''''''''''''''''''''''''
319 The 'ide-drive' device is deprecated. Users should use 'ide-hd' or
320 'ide-cd' as appropriate to get an IDE hard disk or CD-ROM as needed.
322 ``scsi-disk`` (since 4.2)
323 '''''''''''''''''''''''''
325 The 'scsi-disk' device is deprecated. Users should use 'scsi-hd' or
326 'scsi-cd' as appropriate to get a SCSI hard disk or CD-ROM as needed.
328 System emulator machines
329 ------------------------
331 mips ``fulong2e`` machine (since 5.1)
332 '''''''''''''''''''''''''''''''''''''
334 This machine has been renamed ``fuloong2e``.
336 ``pc-1.0``, ``pc-1.1``, ``pc-1.2`` and ``pc-1.3`` (since 5.0)
337 '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
339 These machine types are very old and likely can not be used for live migration
340 from old QEMU versions anymore. A newer machine type should be used instead.
342 Raspberry Pi ``raspi2`` and ``raspi3`` machines (since 5.2)
343 '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
345 The Raspberry Pi machines come in various models (A, A+, B, B+). To be able
346 to distinguish which model QEMU is implementing, the ``raspi2`` and ``raspi3``
347 machines have been renamed ``raspi2b`` and ``raspi3b``.
349 Device options
350 --------------
352 Emulated device options
353 '''''''''''''''''''''''
355 ``-device virtio-blk,scsi=on|off`` (since 5.0.0)
356 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
358 The virtio-blk SCSI passthrough feature is a legacy VIRTIO feature.  VIRTIO 1.0
359 and later do not support it because the virtio-scsi device was introduced for
360 full SCSI support.  Use virtio-scsi instead when SCSI passthrough is required.
362 Note this also applies to ``-device virtio-blk-pci,scsi=on|off``, which is an
363 alias.
365 Block device options
366 ''''''''''''''''''''
368 ``"backing": ""`` (since 2.12.0)
369 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
371 In order to prevent QEMU from automatically opening an image's backing
372 chain, use ``"backing": null`` instead.
374 ``rbd`` keyvalue pair encoded filenames: ``""`` (since 3.1.0)
375 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
377 Options for ``rbd`` should be specified according to its runtime options,
378 like other block drivers.  Legacy parsing of keyvalue pair encoded
379 filenames is useful to open images with the old format for backing files;
380 These image files should be updated to use the current format.
382 Example of legacy encoding::
384   json:{"file.driver":"rbd", "file.filename":"rbd:rbd/name"}
386 The above, converted to the current supported format::
388   json:{"file.driver":"rbd", "file.pool":"rbd", "file.image":"name"}
390 ``sheepdog`` driver (since 5.2.0)
391 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
393 The ``sheepdog`` block device driver is deprecated. The corresponding upstream
394 server project is no longer actively maintained. Users are recommended to switch
395 to an alternative distributed block device driver such as RBD. The
396 ``qemu-img convert`` command can be used to liberate existing data by moving
397 it out of sheepdog volumes into an alternative storage backend.
399 linux-user mode CPUs
400 --------------------
402 ``tilegx`` CPUs (since 5.1.0)
403 '''''''''''''''''''''''''''''
405 The ``tilegx`` guest CPU support (which was only implemented in
406 linux-user mode) is deprecated and will be removed in a future version
407 of QEMU. Support for this CPU was removed from the upstream Linux
408 kernel in 2018, and has also been dropped from glibc.
410 ``ppc64abi32`` CPUs (since 5.2.0)
411 '''''''''''''''''''''''''''''''''
413 The ``ppc64abi32`` architecture has a number of issues which regularly
414 trip up our CI testing and is suspected to be quite broken. For that
415 reason the maintainers strongly suspect no one actually uses it.
417 MIPS ``I7200`` CPU (since 5.2)
418 ''''''''''''''''''''''''''''''
420 The ``I7200`` guest CPU relies on the nanoMIPS ISA, which is deprecated
421 (the ISA has never been upstreamed to a compiler toolchain). Therefore
422 this CPU is also deprecated.
424 Related binaries
425 ----------------
427 qemu-img amend to adjust backing file (since 5.1)
428 '''''''''''''''''''''''''''''''''''''''''''''''''
430 The use of ``qemu-img amend`` to modify the name or format of a qcow2
431 backing image is deprecated; this functionality was never fully
432 documented or tested, and interferes with other amend operations that
433 need access to the original backing image (such as deciding whether a
434 v3 zero cluster may be left unallocated when converting to a v2
435 image).  Rather, any changes to the backing chain should be performed
436 with ``qemu-img rebase -u`` either before or after the remaining
437 changes being performed by amend, as appropriate.
439 qemu-img backing file without format (since 5.1)
440 ''''''''''''''''''''''''''''''''''''''''''''''''
442 The use of ``qemu-img create``, ``qemu-img rebase``, or ``qemu-img
443 convert`` to create or modify an image that depends on a backing file
444 now recommends that an explicit backing format be provided.  This is
445 for safety: if QEMU probes a different format than what you thought,
446 the data presented to the guest will be corrupt; similarly, presenting
447 a raw image to a guest allows a potential security exploit if a future
448 probe sees a non-raw image based on guest writes.
450 To avoid the warning message, or even future refusal to create an
451 unsafe image, you must pass ``-o backing_fmt=`` (or the shorthand
452 ``-F`` during create) to specify the intended backing format.  You may
453 use ``qemu-img rebase -u`` to retroactively add a backing format to an
454 existing image.  However, be aware that there are already potential
455 security risks to blindly using ``qemu-img info`` to probe the format
456 of an untrusted backing image, when deciding what format to add into
457 an existing image.
459 Backwards compatibility
460 -----------------------
462 Runnability guarantee of CPU models (since 4.1.0)
463 '''''''''''''''''''''''''''''''''''''''''''''''''
465 Previous versions of QEMU never changed existing CPU models in
466 ways that introduced additional host software or hardware
467 requirements to the VM.  This allowed management software to
468 safely change the machine type of an existing VM without
469 introducing new requirements ("runnability guarantee").  This
470 prevented CPU models from being updated to include CPU
471 vulnerability mitigations, leaving guests vulnerable in the
472 default configuration.
474 The CPU model runnability guarantee won't apply anymore to
475 existing CPU models.  Management software that needs runnability
476 guarantees must resolve the CPU model aliases using the
477 ``alias-of`` field returned by the ``query-cpu-definitions`` QMP
478 command.
480 While those guarantees are kept, the return value of
481 ``query-cpu-definitions`` will have existing CPU model aliases
482 point to a version that doesn't break runnability guarantees
483 (specifically, version 1 of those CPU models).  In future QEMU
484 versions, aliases will point to newer CPU model versions
485 depending on the machine type, so management software must
486 resolve CPU model aliases before starting a virtual machine.
488 Guest Emulator ISAs
489 -------------------
491 nanoMIPS ISA
492 ''''''''''''
494 The ``nanoMIPS`` ISA has never been upstreamed to any compiler toolchain.
495 As it is hard to generate binaries for it, declare it deprecated.
498 Recently removed features
499 =========================
501 What follows is a record of recently removed, formerly deprecated
502 features that serves as a record for users who have encountered
503 trouble after a recent upgrade.
505 System emulator command line arguments
506 --------------------------------------
508 ``-net ...,name=``\ *name* (removed in 5.1)
509 '''''''''''''''''''''''''''''''''''''''''''
511 The ``name`` parameter of the ``-net`` option was a synonym
512 for the ``id`` parameter, which should now be used instead.
514 ``-no-kvm`` (removed in 5.2)
515 ''''''''''''''''''''''''''''
517 The ``-no-kvm`` argument was a synonym for setting ``-machine accel=tcg``.
520 QEMU Machine Protocol (QMP) commands
521 ------------------------------------
523 ``block-dirty-bitmap-add`` "autoload" parameter (since 4.2.0)
524 '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
526 The "autoload" parameter has been ignored since 2.12.0. All bitmaps
527 are automatically loaded from qcow2 images.
529 ``cpu-add`` (removed in 5.2)
530 ''''''''''''''''''''''''''''
532 Use ``device_add`` for hotplugging vCPUs instead of ``cpu-add``.  See
533 documentation of ``query-hotpluggable-cpus`` for additional details.
535 Human Monitor Protocol (HMP) commands
536 -------------------------------------
538 The ``hub_id`` parameter of ``hostfwd_add`` / ``hostfwd_remove`` (removed in 5.0)
539 '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
541 The ``[hub_id name]`` parameter tuple of the 'hostfwd_add' and
542 'hostfwd_remove' HMP commands has been replaced by ``netdev_id``.
544 ``cpu-add`` (removed in 5.2)
545 ''''''''''''''''''''''''''''
547 Use ``device_add`` for hotplugging vCPUs instead of ``cpu-add``.  See
548 documentation of ``query-hotpluggable-cpus`` for additional details.
550 Guest Emulator ISAs
551 -------------------
553 RISC-V ISA privilege specification version 1.09.1 (removed in 5.1)
554 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
556 The RISC-V ISA privilege specification version 1.09.1 has been removed.
557 QEMU supports both the newer version 1.10.0 and the ratified version 1.11.0, these
558 should be used instead of the 1.09.1 version.
560 System emulator CPUS
561 --------------------
563 KVM guest support on 32-bit Arm hosts (removed in 5.2)
564 ''''''''''''''''''''''''''''''''''''''''''''''''''''''
566 The Linux kernel has dropped support for allowing 32-bit Arm systems
567 to host KVM guests as of the 5.7 kernel. Accordingly, QEMU is deprecating
568 its support for this configuration and will remove it in a future version.
569 Running 32-bit guests on a 64-bit Arm host remains supported.
571 RISC-V ISA Specific CPUs (removed in 5.1)
572 '''''''''''''''''''''''''''''''''''''''''
574 The RISC-V cpus with the ISA version in the CPU name have been removed. The
575 four CPUs are: ``rv32gcsu-v1.9.1``, ``rv32gcsu-v1.10.0``, ``rv64gcsu-v1.9.1`` and
576 ``rv64gcsu-v1.10.0``. Instead the version can be specified via the CPU ``priv_spec``
577 option when using the ``rv32`` or ``rv64`` CPUs.
579 RISC-V no MMU CPUs (removed in 5.1)
580 '''''''''''''''''''''''''''''''''''
582 The RISC-V no MMU cpus have been removed. The two CPUs: ``rv32imacu-nommu`` and
583 ``rv64imacu-nommu`` can no longer be used. Instead the MMU status can be specified
584 via the CPU ``mmu`` option when using the ``rv32`` or ``rv64`` CPUs.
586 System emulator machines
587 ------------------------
589 ``spike_v1.9.1`` and ``spike_v1.10`` (removed in 5.1)
590 '''''''''''''''''''''''''''''''''''''''''''''''''''''
592 The version specific Spike machines have been removed in favour of the
593 generic ``spike`` machine. If you need to specify an older version of the RISC-V
594 spec you can use the ``-cpu rv64gcsu,priv_spec=v1.10.0`` command line argument.
596 mips ``r4k`` platform (removed in 5.2)
597 ''''''''''''''''''''''''''''''''''''''
599 This machine type was very old and unmaintained. Users should use the ``malta``
600 machine type instead.
602 Related binaries
603 ----------------
605 ``qemu-nbd --partition`` (removed in 5.0)
606 '''''''''''''''''''''''''''''''''''''''''
608 The ``qemu-nbd --partition $digit`` code (also spelled ``-P``)
609 could only handle MBR partitions, and never correctly handled logical
610 partitions beyond partition 5.  Exporting a partition can still be
611 done by utilizing the ``--image-opts`` option with a raw blockdev
612 using the ``offset`` and ``size`` parameters layered on top of
613 any other existing blockdev. For example, if partition 1 is 100MiB
614 long starting at 1MiB, the old command::
616   qemu-nbd -t -P 1 -f qcow2 file.qcow2
618 can be rewritten as::
620   qemu-nbd -t --image-opts driver=raw,offset=1M,size=100M,file.driver=qcow2,file.file.driver=file,file.file.filename=file.qcow2
622 ``qemu-img convert -n -o`` (removed in 5.1)
623 '''''''''''''''''''''''''''''''''''''''''''
625 All options specified in ``-o`` are image creation options, so
626 they are now rejected when used with ``-n`` to skip image creation.
629 ``qemu-img create -b bad file $size`` (removed in 5.1)
630 ''''''''''''''''''''''''''''''''''''''''''''''''''''''
632 When creating an image with a backing file that could not be opened,
633 ``qemu-img create`` used to issue a warning about the failure but
634 proceed with the image creation if an explicit size was provided.
635 However, as the ``-u`` option exists for this purpose, it is safer to
636 enforce that any failure to open the backing image (including if the
637 backing file is missing or an incorrect format was specified) is an
638 error when ``-u`` is not used.
640 Command line options
641 --------------------
643 ``-smp`` (invalid topologies) (removed 5.2)
644 '''''''''''''''''''''''''''''''''''''''''''
646 CPU topology properties should describe whole machine topology including
647 possible CPUs.
649 However, historically it was possible to start QEMU with an incorrect topology
650 where *n* <= *sockets* * *cores* * *threads* < *maxcpus*,
651 which could lead to an incorrect topology enumeration by the guest.
652 Support for invalid topologies is removed, the user must ensure
653 topologies described with -smp include all possible cpus, i.e.
654 *sockets* * *cores* * *threads* = *maxcpus*.
656 ``-numa`` node (without memory specified) (removed 5.2)
657 '''''''''''''''''''''''''''''''''''''''''''''''''''''''
659 Splitting RAM by default between NUMA nodes had the same issues as ``mem``
660 parameter with the difference that the role of the user plays QEMU using
661 implicit generic or board specific splitting rule.
662 Use ``memdev`` with *memory-backend-ram* backend or ``mem`` (if
663 it's supported by used machine type) to define mapping explicitly instead.
664 Users of existing VMs, wishing to preserve the same RAM distribution, should
665 configure it explicitly using ``-numa node,memdev`` options. Current RAM
666 distribution can be retrieved using HMP command ``info numa`` and if separate
667 memory devices (pc|nv-dimm) are present use ``info memory-device`` and subtract
668 device memory from output of ``info numa``.
670 ``-numa node,mem=``\ *size* (removed in 5.1)
671 ''''''''''''''''''''''''''''''''''''''''''''
673 The parameter ``mem`` of ``-numa node`` was used to assign a part of
674 guest RAM to a NUMA node. But when using it, it's impossible to manage a specified
675 RAM chunk on the host side (like bind it to a host node, setting bind policy, ...),
676 so the guest ends up with the fake NUMA configuration with suboptiomal performance.
677 However since 2014 there is an alternative way to assign RAM to a NUMA node
678 using parameter ``memdev``, which does the same as ``mem`` and adds
679 means to actually manage node RAM on the host side. Use parameter ``memdev``
680 with *memory-backend-ram* backend as replacement for parameter ``mem``
681 to achieve the same fake NUMA effect or a properly configured
682 *memory-backend-file* backend to actually benefit from NUMA configuration.
683 New machine versions (since 5.1) will not accept the option but it will still
684 work with old machine types. User can check the QAPI schema to see if the legacy
685 option is supported by looking at MachineInfo::numa-mem-supported property.
687 ``-mem-path`` fallback to RAM (removed in 5.0)
688 ''''''''''''''''''''''''''''''''''''''''''''''
690 If guest RAM allocation from file pointed by ``mem-path`` failed,
691 QEMU was falling back to allocating from RAM, which might have resulted
692 in unpredictable behavior since the backing file specified by the user
693 as ignored. Currently, users are responsible for making sure the backing storage
694 specified with ``-mem-path`` can actually provide the guest RAM configured with
695 ``-m`` and QEMU fails to start up if RAM allocation is unsuccessful.
697 ``-smp`` (invalid topologies) (removed 5.2)
698 '''''''''''''''''''''''''''''''''''''''''''
700 CPU topology properties should describe whole machine topology including
701 possible CPUs.
703 However, historically it was possible to start QEMU with an incorrect topology
704 where *n* <= *sockets* * *cores* * *threads* < *maxcpus*,
705 which could lead to an incorrect topology enumeration by the guest.
706 Support for invalid topologies is removed, the user must ensure
707 topologies described with -smp include all possible cpus, i.e.
708 *sockets* * *cores* * *threads* = *maxcpus*.
710 ``-machine enforce-config-section=on|off`` (removed 5.2)
711 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''
713 The ``enforce-config-section`` property was replaced by the
714 ``-global migration.send-configuration={on|off}`` option.
716 Block devices
717 -------------
719 VXHS backend (removed in 5.1)
720 '''''''''''''''''''''''''''''
722 The VXHS code does not compile since v2.12.0. It was removed in 5.1.