cli: Remove deprecated '-singlestep' command line option
[qemu/ar7.git] / docs / about / removed-features.rst
blob54081a6c19663c44f72a823daf2070a519115a71
2 Removed features
3 ================
5 What follows is a record of recently removed, formerly deprecated
6 features that serves as a record for users who have encountered
7 trouble after a recent upgrade.
9 System emulator command line arguments
10 --------------------------------------
12 ``-hdachs`` (removed in 2.12)
13 '''''''''''''''''''''''''''''
15 The geometry defined by ``-hdachs c,h,s,t`` should now be specified via
16 ``-device ide-hd,drive=dr,cyls=c,heads=h,secs=s,bios-chs-trans=t``
17 (together with ``-drive if=none,id=dr,...``).
19 ``-net channel`` (removed in 2.12)
20 ''''''''''''''''''''''''''''''''''
22 This option has been replaced by ``-net user,guestfwd=...``.
24 ``-net dump`` (removed in 2.12)
25 '''''''''''''''''''''''''''''''
27 ``-net dump[,vlan=n][,file=filename][,len=maxlen]`` has been replaced by
28 ``-object filter-dump,id=id,netdev=dev[,file=filename][,maxlen=maxlen]``.
29 Note that the new syntax works with netdev IDs instead of the old "vlan" hubs.
31 ``-no-kvm-pit`` (removed in 2.12)
32 '''''''''''''''''''''''''''''''''
34 This was just a dummy option that has been ignored, since the in-kernel PIT
35 cannot be disabled separately from the irqchip anymore. A similar effect
36 (which also disables the KVM IOAPIC) can be obtained with
37 ``-M kernel_irqchip=split``.
39 ``-tdf`` (removed in 2.12)
40 ''''''''''''''''''''''''''
42 There is no replacement, the ``-tdf`` option has just been ignored since the
43 behaviour that could be changed by this option in qemu-kvm is now the default
44 when using the KVM PIT. It still can be requested explicitly using
45 ``-global kvm-pit.lost_tick_policy=delay``.
47 ``-drive secs=s``, ``-drive heads=h`` & ``-drive cyls=c`` (removed in 3.0)
48 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
50 The drive geometry should now be specified via
51 ``-device ...,drive=dr,cyls=c,heads=h,secs=s`` (together with
52 ``-drive if=none,id=dr,...``).
54 ``-drive serial=``, ``-drive trans=`` & ``-drive addr=`` (removed in 3.0)
55 '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
57 Use ``-device ...,drive=dr,serial=r,bios-chs-trans=t,addr=a`` instead
58 (together with ``-drive if=none,id=dr,...``).
60 ``-net ...,vlan=x`` (removed in 3.0)
61 ''''''''''''''''''''''''''''''''''''
63 The term "vlan" was very confusing for most users in this context (it's about
64 specifying a hub ID, not about IEEE 802.1Q or something similar), so this
65 has been removed. To connect one NIC frontend with a network backend, either
66 use ``-nic ...`` (e.g. for on-board NICs) or use ``-netdev ...,id=n`` together
67 with ``-device ...,netdev=n`` (for full control over pluggable NICs). To
68 connect multiple NICs or network backends via a hub device (which is what
69 vlan did), use ``-nic hubport,hubid=x,...`` or
70 ``-netdev hubport,id=n,hubid=x,...`` (with ``-device ...,netdev=n``) instead.
72 ``-no-kvm-irqchip`` (removed in 3.0)
73 ''''''''''''''''''''''''''''''''''''
75 Use ``-machine kernel_irqchip=off`` instead.
77 ``-no-kvm-pit-reinjection`` (removed in 3.0)
78 ''''''''''''''''''''''''''''''''''''''''''''
80 Use ``-global kvm-pit.lost_tick_policy=discard`` instead.
82 ``-balloon`` (removed in 3.1)
83 '''''''''''''''''''''''''''''
85 The ``-balloon virtio`` option has been replaced by ``-device virtio-balloon``.
86 The ``-balloon none`` option was a no-op and has no replacement.
88 ``-bootp`` (removed in 3.1)
89 '''''''''''''''''''''''''''
91 The ``-bootp /some/file`` argument is replaced by either
92 ``-netdev user,id=x,bootp=/some/file`` (for pluggable NICs, accompanied with
93 ``-device ...,netdev=x``), or ``-nic user,bootp=/some/file`` (for on-board NICs).
94 The new syntax allows different settings to be provided per NIC.
96 ``-redir`` (removed in 3.1)
97 '''''''''''''''''''''''''''
99 The ``-redir [tcp|udp]:hostport:[guestaddr]:guestport`` option is replaced
100 by either ``-netdev
101 user,id=x,hostfwd=[tcp|udp]:[hostaddr]:hostport-[guestaddr]:guestport``
102 (for pluggable NICs, accompanied with ``-device ...,netdev=x``) or by the option
103 ``-nic user,hostfwd=[tcp|udp]:[hostaddr]:hostport-[guestaddr]:guestport``
104 (for on-board NICs). The new syntax allows different settings to be provided
105 per NIC.
107 ``-smb`` (removed in 3.1)
108 '''''''''''''''''''''''''
110 The ``-smb /some/dir`` argument is replaced by either
111 ``-netdev user,id=x,smb=/some/dir`` (for pluggable NICs, accompanied with
112 ``-device ...,netdev=x``), or ``-nic user,smb=/some/dir`` (for on-board NICs).
113 The new syntax allows different settings to be provided per NIC.
115 ``-tftp`` (removed in 3.1)
116 ''''''''''''''''''''''''''
118 The ``-tftp /some/dir`` argument is replaced by either
119 ``-netdev user,id=x,tftp=/some/dir`` (for pluggable NICs, accompanied with
120 ``-device ...,netdev=x``), or ``-nic user,tftp=/some/dir`` (for embedded NICs).
121 The new syntax allows different settings to be provided per NIC.
123 ``-localtime`` (removed in 3.1)
124 '''''''''''''''''''''''''''''''
126 Replaced by ``-rtc base=localtime``.
128 ``-nodefconfig`` (removed in 3.1)
129 '''''''''''''''''''''''''''''''''
131 Use ``-no-user-config`` instead.
133 ``-rtc-td-hack`` (removed in 3.1)
134 '''''''''''''''''''''''''''''''''
136 Use ``-rtc driftfix=slew`` instead.
138 ``-startdate`` (removed in 3.1)
139 '''''''''''''''''''''''''''''''
141 Replaced by ``-rtc base=date``.
143 ``-vnc ...,tls=...``, ``-vnc ...,x509=...`` & ``-vnc ...,x509verify=...`` (removed in 3.1)
144 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
146 The "tls-creds" option should be used instead to point to a "tls-creds-x509"
147 object created using "-object".
149 ``-mem-path`` fallback to RAM (removed in 5.0)
150 ''''''''''''''''''''''''''''''''''''''''''''''
152 If guest RAM allocation from file pointed by ``mem-path`` failed,
153 QEMU was falling back to allocating from RAM, which might have resulted
154 in unpredictable behavior since the backing file specified by the user
155 as ignored. Currently, users are responsible for making sure the backing storage
156 specified with ``-mem-path`` can actually provide the guest RAM configured with
157 ``-m`` and QEMU fails to start up if RAM allocation is unsuccessful.
159 ``-net ...,name=...`` (removed in 5.1)
160 ''''''''''''''''''''''''''''''''''''''
162 The ``name`` parameter of the ``-net`` option was a synonym
163 for the ``id`` parameter, which should now be used instead.
165 ``-numa node,mem=...`` (removed in 5.1)
166 '''''''''''''''''''''''''''''''''''''''
168 The parameter ``mem`` of ``-numa node`` was used to assign a part of guest RAM
169 to a NUMA node. But when using it, it's impossible to manage a specified RAM
170 chunk on the host side (like bind it to a host node, setting bind policy, ...),
171 so the guest ends up with the fake NUMA configuration with suboptiomal
172 performance.
173 However since 2014 there is an alternative way to assign RAM to a NUMA node
174 using parameter ``memdev``, which does the same as ``mem`` and adds
175 means to actually manage node RAM on the host side. Use parameter ``memdev``
176 with *memory-backend-ram* backend as replacement for parameter ``mem``
177 to achieve the same fake NUMA effect or a properly configured
178 *memory-backend-file* backend to actually benefit from NUMA configuration.
179 New machine versions (since 5.1) will not accept the option but it will still
180 work with old machine types. User can check the QAPI schema to see if the legacy
181 option is supported by looking at MachineInfo::numa-mem-supported property.
183 ``-numa`` node (without memory specified) (removed in 5.2)
184 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
186 Splitting RAM by default between NUMA nodes had the same issues as ``mem``
187 parameter with the difference that the role of the user plays QEMU using
188 implicit generic or board specific splitting rule.
189 Use ``memdev`` with *memory-backend-ram* backend or ``mem`` (if
190 it's supported by used machine type) to define mapping explicitly instead.
191 Users of existing VMs, wishing to preserve the same RAM distribution, should
192 configure it explicitly using ``-numa node,memdev`` options. Current RAM
193 distribution can be retrieved using HMP command ``info numa`` and if separate
194 memory devices (pc|nv-dimm) are present use ``info memory-device`` and subtract
195 device memory from output of ``info numa``.
197 ``-smp`` (invalid topologies) (removed in 5.2)
198 ''''''''''''''''''''''''''''''''''''''''''''''
200 CPU topology properties should describe whole machine topology including
201 possible CPUs.
203 However, historically it was possible to start QEMU with an incorrect topology
204 where *n* <= *sockets* * *cores* * *threads* < *maxcpus*,
205 which could lead to an incorrect topology enumeration by the guest.
206 Support for invalid topologies is removed, the user must ensure
207 topologies described with -smp include all possible cpus, i.e.
208 *sockets* * *cores* * *threads* = *maxcpus*.
210 ``-machine enforce-config-section=on|off`` (removed in 5.2)
211 '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
213 The ``enforce-config-section`` property was replaced by the
214 ``-global migration.send-configuration={on|off}`` option.
216 ``-no-kvm`` (removed in 5.2)
217 ''''''''''''''''''''''''''''
219 The ``-no-kvm`` argument was a synonym for setting ``-machine accel=tcg``.
221 ``-realtime`` (removed in 6.0)
222 ''''''''''''''''''''''''''''''
224 The ``-realtime mlock=on|off`` argument has been replaced by the
225 ``-overcommit mem-lock=on|off`` argument.
227 ``-show-cursor`` option (removed in 6.0)
228 ''''''''''''''''''''''''''''''''''''''''
230 Use ``-display sdl,show-cursor=on``, ``-display gtk,show-cursor=on``
231 or ``-display default,show-cursor=on`` instead.
233 ``-tb-size`` option (removed in 6.0)
234 ''''''''''''''''''''''''''''''''''''
236 QEMU 5.0 introduced an alternative syntax to specify the size of the translation
237 block cache, ``-accel tcg,tb-size=``.
239 ``-usbdevice audio`` (removed in 6.0)
240 '''''''''''''''''''''''''''''''''''''
242 This option lacked the possibility to specify an audio backend device.
243 Use ``-device usb-audio`` now instead (and specify a corresponding USB
244 host controller or ``-usb`` if necessary).
246 ``-vnc acl`` (removed in 6.0)
247 '''''''''''''''''''''''''''''
249 The ``acl`` option to the ``-vnc`` argument has been replaced
250 by the ``tls-authz`` and ``sasl-authz`` options.
252 ``-mon ...,control=readline,pretty=on|off`` (removed in 6.0)
253 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
255 The ``pretty=on|off`` switch has no effect for HMP monitors and
256 its use is rejected.
258 ``-drive file=json:{...{'driver':'file'}}`` (removed in 6.0)
259 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
261 The 'file' driver for drives is no longer appropriate for character or host
262 devices and will only accept regular files (S_IFREG). The correct driver
263 for these file types is 'host_cdrom' or 'host_device' as appropriate.
265 Floppy controllers' drive properties (removed in 6.0)
266 '''''''''''''''''''''''''''''''''''''''''''''''''''''
268 Use ``-device floppy,...`` instead.  When configuring onboard floppy
269 controllers
272     -global isa-fdc.driveA=...
273     -global sysbus-fdc.driveA=...
274     -global SUNW,fdtwo.drive=...
276 become
279     -device floppy,unit=0,drive=...
284     -global isa-fdc.driveB=...
285     -global sysbus-fdc.driveB=...
287 become
290     -device floppy,unit=1,drive=...
292 When plugging in a floppy controller
295     -device isa-fdc,...,driveA=...
297 becomes
300     -device isa-fdc,...
301     -device floppy,unit=0,drive=...
306     -device isa-fdc,...,driveB=...
308 becomes
311     -device isa-fdc,...
312     -device floppy,unit=1,drive=...
314 ``-drive`` with bogus interface type (removed in 6.0)
315 '''''''''''''''''''''''''''''''''''''''''''''''''''''
317 Drives with interface types other than ``if=none`` are for onboard
318 devices.  Drives the board doesn't pick up can no longer be used with
319 -device.  Use ``if=none`` instead.
321 ``-usbdevice ccid`` (removed in 6.0)
322 '''''''''''''''''''''''''''''''''''''
324 This option was undocumented and not used in the field.
325 Use ``-device usb-ccid`` instead.
327 RISC-V firmware not booted by default (removed in 5.1)
328 ''''''''''''''''''''''''''''''''''''''''''''''''''''''
330 QEMU 5.1 changes the default behaviour from ``-bios none`` to ``-bios default``
331 for the RISC-V ``virt`` machine and ``sifive_u`` machine.
333 ``-no-quit`` (removed in 7.0)
334 '''''''''''''''''''''''''''''
336 The ``-no-quit`` was a synonym for ``-display ...,window-close=off`` which
337 should be used instead.
339 ``--enable-fips`` (removed in 7.1)
340 ''''''''''''''''''''''''''''''''''
342 This option restricted usage of certain cryptographic algorithms when
343 the host is operating in FIPS mode.
345 If FIPS compliance is required, QEMU should be built with the ``libgcrypt``
346 or ``gnutls`` library enabled as a cryptography provider.
348 Neither the ``nettle`` library, or the built-in cryptography provider are
349 supported on FIPS enabled hosts.
351 ``-writeconfig`` (removed in 7.1)
352 '''''''''''''''''''''''''''''''''
354 The ``-writeconfig`` option was not able to serialize the entire contents
355 of the QEMU command line.  It is thus considered a failed experiment
356 and removed without a replacement.
358 ``loaded`` property of ``secret`` and ``secret_keyring`` objects (removed in 7.1)
359 '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
361 The ``loaded=on`` option in the command line or QMP ``object-add`` either had
362 no effect (if ``loaded`` was the last option) or caused options to be
363 effectively ignored as if they were not given.  The property is therefore
364 useless and should simply be removed.
366 ``opened`` property of ``rng-*`` objects (removed in 7.1)
367 '''''''''''''''''''''''''''''''''''''''''''''''''''''''''
369 The ``opened=on`` option in the command line or QMP ``object-add`` either had
370 no effect (if ``opened`` was the last option) or caused errors.  The property
371 is therefore useless and should simply be removed.
373 ``-display sdl,window_close=...`` (removed in 7.1)
374 ''''''''''''''''''''''''''''''''''''''''''''''''''
376 Use ``-display sdl,window-close=...`` instead (i.e. with a minus instead of
377 an underscore between "window" and "close").
379 ``-alt-grab`` and ``-display sdl,alt_grab=on`` (removed in 7.1)
380 '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
382 Use ``-display sdl,grab-mod=lshift-lctrl-lalt`` instead.
384 ``-ctrl-grab`` and ``-display sdl,ctrl_grab=on`` (removed in 7.1)
385 '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
387 Use ``-display sdl,grab-mod=rctrl`` instead.
389 ``-sdl`` (removed in 7.1)
390 '''''''''''''''''''''''''
392 Use ``-display sdl`` instead.
394 ``-curses`` (removed in 7.1)
395 ''''''''''''''''''''''''''''
397 Use ``-display curses`` instead.
399 Creating sound card devices using ``-soundhw`` (removed in 7.1)
400 '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
402 Sound card devices should be created using ``-device`` or ``-audio``.
403 The exception is ``pcspk`` which can be activated using ``-machine
404 pcspk-audiodev=<name>``.
406 ``-watchdog`` (since 7.2)
407 '''''''''''''''''''''''''
409 Use ``-device`` instead.
411 Hexadecimal sizes with scaling multipliers (since 8.0)
412 ''''''''''''''''''''''''''''''''''''''''''''''''''''''
414 Input parameters that take a size value should only use a size suffix
415 (such as 'k' or 'M') when the base is written in decimal, and not when
416 the value is hexadecimal.  That is, '0x20M' should be written either as
417 '32M' or as '0x2000000'.
419 ``-chardev`` backend aliases ``tty`` and ``parport`` (removed in 8.0)
420 '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
422 ``tty`` and ``parport`` used to be aliases for ``serial`` and ``parallel``
423 respectively. The actual backend names should be used instead.
425 ``-drive if=none`` for the sifive_u OTP device (removed in 8.0)
426 '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
428 Use ``-drive if=pflash`` to configure the OTP device of the sifive_u
429 RISC-V machine instead.
431 ``-spice password=string`` (removed in 8.0)
432 '''''''''''''''''''''''''''''''''''''''''''
434 This option was insecure because the SPICE password remained visible in
435 the process listing. This was replaced by the new ``password-secret``
436 option which lets the password be securely provided on the command
437 line using a ``secret`` object instance.
439 ``QEMU_AUDIO_`` environment variables and ``-audio-help`` (removed in 8.2)
440 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
442 The ``-audiodev`` and ``-audio`` command line options are now the only
443 way to specify audio backend settings.
445 Using ``-audiodev`` to define the default audio backend (removed in 8.2)
446 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
448 If no audiodev property is specified, previous versions would use the
449 first ``-audiodev`` command line option as a fallback.  Starting with
450 version 8.2, audio backends created with ``-audiodev`` will only be
451 used by clients (sound cards, machines with embedded sound hardware, VNC)
452 that refer to it in an ``audiodev=`` property.
454 In order to configure a default audio backend, use the ``-audio``
455 command line option without specifying a ``model``; while previous
456 versions of QEMU required a model, starting with version 8.2
457 QEMU does not require a model and will not create any sound card
458 in this case.
460 Note that the default audio backend must be configured on the command
461 line if the ``-nodefaults`` options is used.
463 ``-no-hpet`` (removed in 9.0)
464 '''''''''''''''''''''''''''''
466 The HPET setting has been turned into a machine property.
467 Use ``-machine hpet=off`` instead.
469 ``-no-acpi`` (removed in 9.0)
470 '''''''''''''''''''''''''''''
472 The ``-no-acpi`` setting has been turned into a machine property.
473 Use ``-machine acpi=off`` instead.
475 ``-async-teardown`` (removed in 9.0)
476 ''''''''''''''''''''''''''''''''''''
478 Use ``-run-with async-teardown=on`` instead.
480 ``-chroot`` (removed in 9.0)
481 ''''''''''''''''''''''''''''
483 Use ``-run-with chroot=dir`` instead.
485 ``-singlestep`` (removed in 9.0)
486 ''''''''''''''''''''''''''''''''
488 The ``-singlestep`` option has been turned into an accelerator property,
489 and given a name that better reflects what it actually does.
490 Use ``-accel tcg,one-insn-per-tb=on`` instead.
493 User-mode emulator command line arguments
494 -----------------------------------------
496 ``-singlestep`` (removed in 9.0)
497 ''''''''''''''''''''''''''''''''
499 The ``-singlestep`` option has been given a name that better reflects
500 what it actually does. For both linux-user and bsd-user, use the
501 ``-one-insn-per-tb`` option instead.
504 QEMU Machine Protocol (QMP) commands
505 ------------------------------------
507 ``block-dirty-bitmap-add`` "autoload" parameter (removed in 4.2)
508 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
510 The "autoload" parameter has been ignored since 2.12.0. All bitmaps
511 are automatically loaded from qcow2 images.
513 ``cpu-add`` (removed in 5.2)
514 ''''''''''''''''''''''''''''
516 Use ``device_add`` for hotplugging vCPUs instead of ``cpu-add``.  See
517 documentation of ``query-hotpluggable-cpus`` for additional details.
519 ``change`` (removed in 6.0)
520 '''''''''''''''''''''''''''
522 Use ``blockdev-change-medium`` or ``change-vnc-password`` or
523 ``display-update`` instead.
525 ``query-events`` (removed in 6.0)
526 '''''''''''''''''''''''''''''''''
528 The ``query-events`` command has been superseded by the more powerful
529 and accurate ``query-qmp-schema`` command.
531 ``migrate_set_cache_size`` and ``query-migrate-cache-size`` (removed in 6.0)
532 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
534 Use ``migrate_set_parameter`` and ``info migrate_parameters`` instead.
536 ``migrate_set_downtime`` and ``migrate_set_speed`` (removed in 6.0)
537 '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
539 Use ``migrate_set_parameter`` instead.
541 ``query-cpus`` (removed in 6.0)
542 '''''''''''''''''''''''''''''''
544 The ``query-cpus`` command is replaced by the ``query-cpus-fast`` command.
546 ``query-cpus-fast`` ``arch`` output member (removed in 6.0)
547 '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
549 The ``arch`` output member of the ``query-cpus-fast`` command is
550 replaced by the ``target`` output member.
552 chardev client socket with ``wait`` option (removed in 6.0)
553 '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
555 Character devices creating sockets in client mode should not specify
556 the 'wait' field, which is only applicable to sockets in server mode
558 ``query-named-block-nodes`` result ``encryption_key_missing`` (removed in 6.0)
559 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
561 Removed with no replacement.
563 ``query-block`` result ``inserted.encryption_key_missing`` (removed in 6.0)
564 '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
566 Removed with no replacement.
568 ``query-named-block-nodes`` and ``query-block`` result dirty-bitmaps[i].status (removed in 6.0)
569 '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
571 The ``status`` field of the ``BlockDirtyInfo`` structure, returned by
572 these commands is removed. Two new boolean fields, ``recording`` and
573 ``busy`` effectively replace it.
575 ``query-block`` result field ``dirty-bitmaps`` (removed in 6.0)
576 '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
578 The ``dirty-bitmaps`` field of the ``BlockInfo`` structure, returned by
579 the query-block command is itself now removed. The ``dirty-bitmaps``
580 field of the ``BlockDeviceInfo`` struct should be used instead, which is the
581 type of the ``inserted`` field in query-block replies, as well as the
582 type of array items in query-named-block-nodes.
584 ``object-add`` option ``props`` (removed in 6.0)
585 ''''''''''''''''''''''''''''''''''''''''''''''''
587 Specify the properties for the object as top-level arguments instead.
589 ``query-sgx`` return value member ``section-size`` (removed in 8.0)
590 '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
592 Member ``section-size`` in the return value of ``query-sgx``
593 was superseded by ``sections``.
596 ``query-sgx-capabilities`` return value member ``section-size`` (removed in 8.0)
597 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
599 Member ``section-size`` in the return value of ``query-sgx-capabilities``
600 was superseded by ``sections``.
602 Human Monitor Protocol (HMP) commands
603 -------------------------------------
605 ``usb_add`` and ``usb_remove`` (removed in 2.12)
606 ''''''''''''''''''''''''''''''''''''''''''''''''
608 Replaced by ``device_add`` and ``device_del`` (use ``device_add help`` for a
609 list of available devices).
611 ``host_net_add`` and ``host_net_remove`` (removed in 2.12)
612 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
614 Replaced by ``netdev_add`` and ``netdev_del``.
616 The ``hub_id`` parameter of ``hostfwd_add`` / ``hostfwd_remove`` (removed in 5.0)
617 '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
619 The ``[hub_id name]`` parameter tuple of the 'hostfwd_add' and
620 'hostfwd_remove' HMP commands has been replaced by ``netdev_id``.
622 ``cpu-add`` (removed in 5.2)
623 ''''''''''''''''''''''''''''
625 Use ``device_add`` for hotplugging vCPUs instead of ``cpu-add``.  See
626 documentation of ``query-hotpluggable-cpus`` for additional details.
628 ``change vnc TARGET`` (removed in 6.0)
629 ''''''''''''''''''''''''''''''''''''''
631 No replacement.  The ``change vnc password`` and ``change DEVICE MEDIUM``
632 commands are not affected.
634 ``acl_show``, ``acl_reset``, ``acl_policy``, ``acl_add``, ``acl_remove`` (removed in 6.0)
635 '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
637 The ``acl_show``, ``acl_reset``, ``acl_policy``, ``acl_add``, and
638 ``acl_remove`` commands were removed with no replacement. Authorization
639 for VNC should be performed using the pluggable QAuthZ objects.
641 ``migrate-set-cache-size`` and ``info migrate-cache-size`` (removed in 6.0)
642 '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
644 Use ``migrate-set-parameters`` and ``info migrate-parameters`` instead.
646 ``migrate_set_downtime`` and ``migrate_set_speed`` (removed in 6.0)
647 '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
649 Use ``migrate-set-parameters`` instead.
651 ``info cpustats`` (removed in 6.1)
652 ''''''''''''''''''''''''''''''''''
654 This command didn't produce any output already. Removed with no replacement.
656 ``singlestep`` (removed in 9.0)
657 '''''''''''''''''''''''''''''''
659 The ``singlestep`` command has been replaced by the ``one-insn-per-tb``
660 command, which has the same behaviour but a less misleading name.
662 Guest Emulator ISAs
663 -------------------
665 RISC-V ISA privilege specification version 1.09.1 (removed in 5.1)
666 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
668 The RISC-V ISA privilege specification version 1.09.1 has been removed.
669 QEMU supports both the newer version 1.10.0 and the ratified version 1.11.0, these
670 should be used instead of the 1.09.1 version.
672 System emulator CPUS
673 --------------------
675 KVM guest support on 32-bit Arm hosts (removed in 5.2)
676 ''''''''''''''''''''''''''''''''''''''''''''''''''''''
678 The Linux kernel has dropped support for allowing 32-bit Arm systems
679 to host KVM guests as of the 5.7 kernel, and was thus removed from QEMU
680 as well.  Running 32-bit guests on a 64-bit Arm host remains supported.
682 RISC-V ISA Specific CPUs (removed in 5.1)
683 '''''''''''''''''''''''''''''''''''''''''
685 The RISC-V cpus with the ISA version in the CPU name have been removed. The
686 four CPUs are: ``rv32gcsu-v1.9.1``, ``rv32gcsu-v1.10.0``, ``rv64gcsu-v1.9.1`` and
687 ``rv64gcsu-v1.10.0``. Instead the version can be specified via the CPU ``priv_spec``
688 option when using the ``rv32`` or ``rv64`` CPUs.
690 RISC-V no MMU CPUs (removed in 5.1)
691 '''''''''''''''''''''''''''''''''''
693 The RISC-V no MMU cpus have been removed. The two CPUs: ``rv32imacu-nommu`` and
694 ``rv64imacu-nommu`` can no longer be used. Instead the MMU status can be specified
695 via the CPU ``mmu`` option when using the ``rv32`` or ``rv64`` CPUs.
697 ``compat`` property of server class POWER CPUs (removed in 6.0)
698 '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
700 The ``max-cpu-compat`` property of the ``pseries`` machine type should be used
701 instead.
703 ``moxie`` CPU (removed in 6.1)
704 ''''''''''''''''''''''''''''''
706 Nobody was using this CPU emulation in QEMU, and there were no test images
707 available to make sure that the code is still working, so it has been removed
708 without replacement.
710 ``lm32`` CPUs (removed in 6.1)
711 ''''''''''''''''''''''''''''''
713 The only public user of this architecture was the milkymist project,
714 which has been dead for years; there was never an upstream Linux
715 port.  Removed without replacement.
717 ``unicore32`` CPUs (removed in 6.1)
718 '''''''''''''''''''''''''''''''''''
720 Support for this CPU was removed from the upstream Linux kernel, and
721 there is no available upstream toolchain to build binaries for it.
722 Removed without replacement.
724 x86 ``Icelake-Client`` CPU (removed in 7.1)
725 '''''''''''''''''''''''''''''''''''''''''''
727 There isn't ever Icelake Client CPU, it is some wrong and imaginary one.
728 Use ``Icelake-Server`` instead.
730 System accelerators
731 -------------------
733 Userspace local APIC with KVM (x86, removed in 8.0)
734 '''''''''''''''''''''''''''''''''''''''''''''''''''
736 ``-M kernel-irqchip=off`` cannot be used on KVM if the CPU model includes
737 a local APIC.  The ``split`` setting is supported, as is using ``-M
738 kernel-irqchip=off`` when the CPU does not have a local APIC.
740 HAXM (``-accel hax``) (removed in 8.2)
741 ''''''''''''''''''''''''''''''''''''''
743 The HAXM project has been retired (see https://github.com/intel/haxm#status).
744 Use "whpx" (on Windows) or "hvf" (on macOS) instead.
746 MIPS "Trap-and-Emulate" KVM support (removed in 8.0)
747 ''''''''''''''''''''''''''''''''''''''''''''''''''''
749 The MIPS "Trap-and-Emulate" KVM host and guest support was removed
750 from Linux in 2021, and is not supported anymore by QEMU either.
752 System emulator machines
753 ------------------------
755 ``s390-virtio`` (removed in 2.6)
756 ''''''''''''''''''''''''''''''''
758 Use the ``s390-ccw-virtio`` machine instead.
760 The m68k ``dummy`` machine (removed in 2.9)
761 '''''''''''''''''''''''''''''''''''''''''''
763 Use the ``none`` machine with the ``loader`` device instead.
765 ``xlnx-ep108`` (removed in 3.0)
766 '''''''''''''''''''''''''''''''
768 The EP108 was an early access development board that is no longer used.
769 Use the ``xlnx-zcu102`` machine instead.
771 ``spike_v1.9.1`` and ``spike_v1.10`` (removed in 5.1)
772 '''''''''''''''''''''''''''''''''''''''''''''''''''''
774 The version specific Spike machines have been removed in favour of the
775 generic ``spike`` machine. If you need to specify an older version of the RISC-V
776 spec you can use the ``-cpu rv64gcsu,priv_spec=v1.10.0`` command line argument.
778 mips ``r4k`` platform (removed in 5.2)
779 ''''''''''''''''''''''''''''''''''''''
781 This machine type was very old and unmaintained. Users should use the ``malta``
782 machine type instead.
784 mips ``fulong2e`` machine alias (removed in 6.0)
785 ''''''''''''''''''''''''''''''''''''''''''''''''
787 This machine has been renamed ``fuloong2e``.
789 ``pc-0.10`` up to ``pc-i440fx-1.7`` (removed in 4.0 up to 8.2)
790 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
792 These machine types were very old and likely could not be used for live
793 migration from old QEMU versions anymore. Use a newer machine type instead.
795 Raspberry Pi ``raspi2`` and ``raspi3`` machines (removed in 6.2)
796 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
798 The Raspberry Pi machines come in various models (A, A+, B, B+). To be able
799 to distinguish which model QEMU is implementing, the ``raspi2`` and ``raspi3``
800 machines have been renamed ``raspi2b`` and ``raspi3b``.
802 Aspeed ``swift-bmc`` machine (removed in 7.0)
803 '''''''''''''''''''''''''''''''''''''''''''''
805 This machine was removed because it was unused. Alternative AST2500 based
806 OpenPOWER machines are ``witherspoon-bmc`` and ``romulus-bmc``.
808 ppc ``taihu`` machine (removed in 7.2)
809 '''''''''''''''''''''''''''''''''''''''''''''
811 This machine was removed because it was partially emulated and 405
812 machines are very similar. Use the ``ref405ep`` machine instead.
814 linux-user mode CPUs
815 --------------------
817 ``tilegx`` CPUs (removed in 6.0)
818 ''''''''''''''''''''''''''''''''
820 The ``tilegx`` guest CPU support has been removed without replacement. It was
821 only implemented in linux-user mode, but support for this CPU was removed from
822 the upstream Linux kernel in 2018, and it has also been dropped from glibc, so
823 there is no new Linux development taking place with this architecture. For
824 running the old binaries, you can use older versions of QEMU.
826 ``ppc64abi32`` CPUs (removed in 7.0)
827 ''''''''''''''''''''''''''''''''''''
829 The ``ppc64abi32`` architecture has a number of issues which regularly
830 tripped up the CI testing and was suspected to be quite broken. For that
831 reason the maintainers strongly suspected no one actually used it.
834 TCG introspection features
835 --------------------------
837 TCG trace-events (since 6.2)
838 ''''''''''''''''''''''''''''
840 The ability to add new TCG trace points had bit rotted and as the
841 feature can be replicated with TCG plugins it was removed. If
842 any user is currently using this feature and needs help with
843 converting to using TCG plugins they should contact the qemu-devel
844 mailing list.
847 System emulator devices
848 -----------------------
850 ``spapr-pci-vfio-host-bridge`` (removed in 2.12)
851 '''''''''''''''''''''''''''''''''''''''''''''''''
853 The ``spapr-pci-vfio-host-bridge`` device type has been replaced by the
854 ``spapr-pci-host-bridge`` device type.
856 ``ivshmem`` (removed in 4.0)
857 ''''''''''''''''''''''''''''
859 Replaced by either the ``ivshmem-plain`` or ``ivshmem-doorbell``.
861 ``ide-drive`` (removed in 6.0)
862 ''''''''''''''''''''''''''''''
864 The 'ide-drive' device has been removed. Users should use 'ide-hd' or
865 'ide-cd' as appropriate to get an IDE hard disk or CD-ROM as needed.
867 ``scsi-disk`` (removed in 6.0)
868 ''''''''''''''''''''''''''''''
870 The 'scsi-disk' device has been removed. Users should use 'scsi-hd' or
871 'scsi-cd' as appropriate to get a SCSI hard disk or CD-ROM as needed.
873 ``sga`` (removed in 8.0)
874 ''''''''''''''''''''''''
876 The ``sga`` device loaded an option ROM for x86 targets which enabled
877 SeaBIOS to send messages to the serial console. SeaBIOS 1.11.0 onwards
878 contains native support for this feature and thus use of the option
879 ROM approach was obsolete. The native SeaBIOS support can be activated
880 by using ``-machine graphics=off``.
883 Related binaries
884 ----------------
886 ``qemu-nbd --partition`` (removed in 5.0)
887 '''''''''''''''''''''''''''''''''''''''''
889 The ``qemu-nbd --partition $digit`` code (also spelled ``-P``)
890 could only handle MBR partitions, and never correctly handled logical
891 partitions beyond partition 5.  Exporting a partition can still be
892 done by utilizing the ``--image-opts`` option with a raw blockdev
893 using the ``offset`` and ``size`` parameters layered on top of
894 any other existing blockdev. For example, if partition 1 is 100MiB
895 long starting at 1MiB, the old command::
897   qemu-nbd -t -P 1 -f qcow2 file.qcow2
899 can be rewritten as::
901   qemu-nbd -t --image-opts driver=raw,offset=1M,size=100M,file.driver=qcow2,file.file.driver=file,file.file.filename=file.qcow2
903 ``qemu-img convert -n -o`` (removed in 5.1)
904 '''''''''''''''''''''''''''''''''''''''''''
906 All options specified in ``-o`` are image creation options, so
907 they are now rejected when used with ``-n`` to skip image creation.
910 ``qemu-img create -b bad file $size`` (removed in 5.1)
911 ''''''''''''''''''''''''''''''''''''''''''''''''''''''
913 When creating an image with a backing file that could not be opened,
914 ``qemu-img create`` used to issue a warning about the failure but
915 proceed with the image creation if an explicit size was provided.
916 However, as the ``-u`` option exists for this purpose, it is safer to
917 enforce that any failure to open the backing image (including if the
918 backing file is missing or an incorrect format was specified) is an
919 error when ``-u`` is not used.
921 ``qemu-img amend`` to adjust backing file (removed in 6.1)
922 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
924 The use of ``qemu-img amend`` to modify the name or format of a qcow2
925 backing image was never fully documented or tested, and interferes
926 with other amend operations that need access to the original backing
927 image (such as deciding whether a v3 zero cluster may be left
928 unallocated when converting to a v2 image).  Any changes to the
929 backing chain should be performed with ``qemu-img rebase -u`` either
930 before or after the remaining changes being performed by amend, as
931 appropriate.
933 ``qemu-img`` backing file without format (removed in 6.1)
934 '''''''''''''''''''''''''''''''''''''''''''''''''''''''''
936 The use of ``qemu-img create``, ``qemu-img rebase``, or ``qemu-img
937 convert`` to create or modify an image that depends on a backing file
938 now requires that an explicit backing format be provided.  This is
939 for safety: if QEMU probes a different format than what you thought,
940 the data presented to the guest will be corrupt; similarly, presenting
941 a raw image to a guest allows a potential security exploit if a future
942 probe sees a non-raw image based on guest writes.
944 To avoid creating unsafe backing chains, you must pass ``-o
945 backing_fmt=`` (or the shorthand ``-F`` during create) to specify the
946 intended backing format.  You may use ``qemu-img rebase -u`` to
947 retroactively add a backing format to an existing image.  However, be
948 aware that there are already potential security risks to blindly using
949 ``qemu-img info`` to probe the format of an untrusted backing image,
950 when deciding what format to add into an existing image.
952 Block devices
953 -------------
955 VXHS backend (removed in 5.1)
956 '''''''''''''''''''''''''''''
958 The VXHS code did not compile since v2.12.0. It was removed in 5.1.
960 ``sheepdog`` driver (removed in 6.0)
961 ''''''''''''''''''''''''''''''''''''
963 The corresponding upstream server project is no longer maintained.
964 Users are recommended to switch to an alternative distributed block
965 device driver such as RBD.
967 Tools
968 -----
970 virtiofsd (removed in 8.0)
971 ''''''''''''''''''''''''''
973 There is a newer Rust implementation of ``virtiofsd`` at
974 ``https://gitlab.com/virtio-fs/virtiofsd``; this has been
975 stable for some time and is now widely used.
976 The command line and feature set is very close to the removed
977 C implementation.