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