From 5600d275d52aa822393edd8b52b397dfff8a499c Mon Sep 17 00:00:00 2001 From: Paolo Bonzini Date: Fri, 28 Feb 2020 15:35:50 +0000 Subject: qemu-doc: split CPU models doc between MIPS and x86 parts The MIPS CPU models end up in the middle of the PC documentation. Move them to a separate file so that they can be placed in the right section. The man page still includes both x86 and MIPS content. Signed-off-by: Paolo Bonzini Reviewed-by: Peter Maydell Reviewed-by: Alex Bennée Tested-by: Alex Bennée Signed-off-by: Peter Maydell Message-id: 20200228153619.9906-5-peter.maydell@linaro.org Message-id: 20200226113034.6741-5-pbonzini@redhat.com Reviewed-by: Peter Maydell Signed-off-by: Peter Maydell --- docs/system/cpu-models-mips.texi | 157 +++++++++++++ docs/system/cpu-models-x86.texi | 482 +++++++++++++++++++++++++++++++++++++++ docs/system/qemu-cpu-models.texi | 28 +++ 3 files changed, 667 insertions(+) create mode 100644 docs/system/cpu-models-mips.texi create mode 100644 docs/system/cpu-models-x86.texi create mode 100644 docs/system/qemu-cpu-models.texi (limited to 'docs/system') diff --git a/docs/system/cpu-models-mips.texi b/docs/system/cpu-models-mips.texi new file mode 100644 index 0000000000..6a0370cb69 --- /dev/null +++ b/docs/system/cpu-models-mips.texi @@ -0,0 +1,157 @@ +@node recommendations_cpu_models_MIPS +@section Supported CPU model configurations on MIPS hosts + +QEMU supports variety of MIPS CPU models: + +@menu +* cpu_models_MIPS32:: Supported CPU models for MIPS32 hosts +* cpu_models_MIPS64:: Supported CPU models for MIPS64 hosts +* cpu_models_nanoMIPS:: Supported CPU models for nanoMIPS hosts +* preferred_cpu_models_MIPS:: Preferred CPU models for MIPS hosts +@end menu + +@node cpu_models_MIPS32 +@subsection Supported CPU models for MIPS32 hosts + +The following CPU models are supported for use on MIPS32 hosts. Administrators / +applications are recommended to use the CPU model that matches the generation +of the host CPUs in use. In a deployment with a mixture of host CPU models +between machines, if live migration compatibility is required, use the newest +CPU model that is compatible across all desired hosts. + +@table @option +@item @code{mips32r6-generic} + +MIPS32 Processor (Release 6, 2015) + + +@item @code{P5600} + +MIPS32 Processor (P5600, 2014) + + +@item @code{M14K} +@item @code{M14Kc} + +MIPS32 Processor (M14K, 2009) + + +@item @code{74Kf} + +MIPS32 Processor (74K, 2007) + + +@item @code{34Kf} + +MIPS32 Processor (34K, 2006) + + +@item @code{24Kc} +@item @code{24KEc} +@item @code{24Kf} + +MIPS32 Processor (24K, 2003) + + +@item @code{4Kc} +@item @code{4Km} +@item @code{4KEcR1} +@item @code{4KEmR1} +@item @code{4KEc} +@item @code{4KEm} + +MIPS32 Processor (4K, 1999) +@end table + +@node cpu_models_MIPS64 +@subsection Supported CPU models for MIPS64 hosts + +The following CPU models are supported for use on MIPS64 hosts. Administrators / +applications are recommended to use the CPU model that matches the generation +of the host CPUs in use. In a deployment with a mixture of host CPU models +between machines, if live migration compatibility is required, use the newest +CPU model that is compatible across all desired hosts. + +@table @option +@item @code{I6400} + +MIPS64 Processor (Release 6, 2014) + + +@item @code{Loongson-2F} + +MIPS64 Processor (Loongson 2, 2008) + + +@item @code{Loongson-2E} + +MIPS64 Processor (Loongson 2, 2006) + + +@item @code{mips64dspr2} + +MIPS64 Processor (Release 2, 2006) + + +@item @code{MIPS64R2-generic} +@item @code{5KEc} +@item @code{5KEf} + +MIPS64 Processor (Release 2, 2002) + + +@item @code{20Kc} + +MIPS64 Processor (20K, 2000) + + +@item @code{5Kc} +@item @code{5Kf} + +MIPS64 Processor (5K, 1999) + + +@item @code{VR5432} + +MIPS64 Processor (VR, 1998) + + +@item @code{R4000} + +MIPS64 Processor (MIPS III, 1991) +@end table + +@node cpu_models_nanoMIPS +@subsection Supported CPU models for nanoMIPS hosts + +The following CPU models are supported for use on nanoMIPS hosts. Administrators / +applications are recommended to use the CPU model that matches the generation +of the host CPUs in use. In a deployment with a mixture of host CPU models +between machines, if live migration compatibility is required, use the newest +CPU model that is compatible across all desired hosts. + +@table @option +@item @code{I7200} + +MIPS I7200 (nanoMIPS, 2018) + +@end table + +@node preferred_cpu_models_MIPS +@subsection Preferred CPU models for MIPS hosts + +The following CPU models are preferred for use on different MIPS hosts: + +@table @option +@item @code{MIPS III} +R4000 + +@item @code{MIPS32R2} +34Kf + +@item @code{MIPS64R6} +I6400 + +@item @code{nanoMIPS} +I7200 +@end table diff --git a/docs/system/cpu-models-x86.texi b/docs/system/cpu-models-x86.texi new file mode 100644 index 0000000000..0cd64b0522 --- /dev/null +++ b/docs/system/cpu-models-x86.texi @@ -0,0 +1,482 @@ +@node cpu_models_x86 +@section Recommendations for KVM CPU model configuration on x86 hosts + +QEMU / KVM virtualization supports two ways to configure CPU models + +@table @option + +@item Host passthrough + +This passes the host CPU model features, model, stepping, exactly to the +guest. Note that KVM may filter out some host CPU model features if they +cannot be supported with virtualization. Live migration is unsafe when +this mode is used as libvirt / QEMU cannot guarantee a stable CPU is +exposed to the guest across hosts. This is the recommended CPU to use, +provided live migration is not required. + +@item Named model + +QEMU comes with a number of predefined named CPU models, that typically +refer to specific generations of hardware released by Intel and AMD. +These allow the guest VMs to have a degree of isolation from the host CPU, +allowing greater flexibility in live migrating between hosts with differing +hardware. +@end table + +In both cases, it is possible to optionally add or remove individual CPU +features, to alter what is presented to the guest by default. + +Libvirt supports a third way to configure CPU models known as "Host model". +This uses the QEMU "Named model" feature, automatically picking a CPU model +that is similar the host CPU, and then adding extra features to approximate +the host model as closely as possible. This does not guarantee the CPU family, +stepping, etc will precisely match the host CPU, as they would with "Host +passthrough", but gives much of the benefit of passthrough, while making +live migration safe. + +The information that follows provides recommendations for configuring +CPU models on x86 hosts. The goals are to maximise performance, while +protecting guest OS against various CPU hardware flaws, and optionally +enabling live migration between hosts with heterogeneous CPU models. + +@menu +* preferred_cpu_models_intel_x86:: Preferred CPU models for Intel x86 hosts +* important_cpu_features_intel_x86:: Important CPU features for Intel x86 hosts +* preferred_cpu_models_amd_x86:: Preferred CPU models for AMD x86 hosts +* important_cpu_features_amd_x86:: Important CPU features for AMD x86 hosts +* default_cpu_models_x86:: Default x86 CPU models +* other_non_recommended_cpu_models_x86:: Other non-recommended x86 CPUs +* cpu_model_syntax_apps:: Syntax for configuring CPU models +@end menu + +@node preferred_cpu_models_intel_x86 +@subsection Preferred CPU models for Intel x86 hosts + +The following CPU models are preferred for use on Intel hosts. Administrators / +applications are recommended to use the CPU model that matches the generation +of the host CPUs in use. In a deployment with a mixture of host CPU models +between machines, if live migration compatibility is required, use the newest +CPU model that is compatible across all desired hosts. + +@table @option +@item @code{Skylake-Server} +@item @code{Skylake-Server-IBRS} + +Intel Xeon Processor (Skylake, 2016) + + +@item @code{Skylake-Client} +@item @code{Skylake-Client-IBRS} + +Intel Core Processor (Skylake, 2015) + + +@item @code{Broadwell} +@item @code{Broadwell-IBRS} +@item @code{Broadwell-noTSX} +@item @code{Broadwell-noTSX-IBRS} + +Intel Core Processor (Broadwell, 2014) + + +@item @code{Haswell} +@item @code{Haswell-IBRS} +@item @code{Haswell-noTSX} +@item @code{Haswell-noTSX-IBRS} + +Intel Core Processor (Haswell, 2013) + + +@item @code{IvyBridge} +@item @code{IvyBridge-IBRS} + +Intel Xeon E3-12xx v2 (Ivy Bridge, 2012) + + +@item @code{SandyBridge} +@item @code{SandyBridge-IBRS} + +Intel Xeon E312xx (Sandy Bridge, 2011) + + +@item @code{Westmere} +@item @code{Westmere-IBRS} + +Westmere E56xx/L56xx/X56xx (Nehalem-C, 2010) + + +@item @code{Nehalem} +@item @code{Nehalem-IBRS} + +Intel Core i7 9xx (Nehalem Class Core i7, 2008) + + +@item @code{Penryn} + +Intel Core 2 Duo P9xxx (Penryn Class Core 2, 2007) + + +@item @code{Conroe} + +Intel Celeron_4x0 (Conroe/Merom Class Core 2, 2006) + +@end table + +@node important_cpu_features_intel_x86 +@subsection Important CPU features for Intel x86 hosts + +The following are important CPU features that should be used on Intel x86 +hosts, when available in the host CPU. Some of them require explicit +configuration to enable, as they are not included by default in some, or all, +of the named CPU models listed above. In general all of these features are +included if using "Host passthrough" or "Host model". + + +@table @option + +@item @code{pcid} + +Recommended to mitigate the cost of the Meltdown (CVE-2017-5754) fix + +Included by default in Haswell, Broadwell & Skylake Intel CPU models. + +Should be explicitly turned on for Westmere, SandyBridge, and IvyBridge +Intel CPU models. Note that some desktop/mobile Westmere CPUs cannot +support this feature. + + +@item @code{spec-ctrl} + +Required to enable the Spectre v2 (CVE-2017-5715) fix. + +Included by default in Intel CPU models with -IBRS suffix. + +Must be explicitly turned on for Intel CPU models without -IBRS suffix. + +Requires the host CPU microcode to support this feature before it +can be used for guest CPUs. + + +@item @code{stibp} + +Required to enable stronger Spectre v2 (CVE-2017-5715) fixes in some +operating systems. + +Must be explicitly turned on for all Intel CPU models. + +Requires the host CPU microcode to support this feature before it +can be used for guest CPUs. + + +@item @code{ssbd} + +Required to enable the CVE-2018-3639 fix + +Not included by default in any Intel CPU model. + +Must be explicitly turned on for all Intel CPU models. + +Requires the host CPU microcode to support this feature before it +can be used for guest CPUs. + + +@item @code{pdpe1gb} + +Recommended to allow guest OS to use 1GB size pages + +Not included by default in any Intel CPU model. + +Should be explicitly turned on for all Intel CPU models. + +Note that not all CPU hardware will support this feature. + +@item @code{md-clear} + +Required to confirm the MDS (CVE-2018-12126, CVE-2018-12127, CVE-2018-12130, +CVE-2019-11091) fixes. + +Not included by default in any Intel CPU model. + +Must be explicitly turned on for all Intel CPU models. + +Requires the host CPU microcode to support this feature before it +can be used for guest CPUs. +@end table + + +@node preferred_cpu_models_amd_x86 +@subsection Preferred CPU models for AMD x86 hosts + +The following CPU models are preferred for use on Intel hosts. Administrators / +applications are recommended to use the CPU model that matches the generation +of the host CPUs in use. In a deployment with a mixture of host CPU models +between machines, if live migration compatibility is required, use the newest +CPU model that is compatible across all desired hosts. + +@table @option + +@item @code{EPYC} +@item @code{EPYC-IBPB} + +AMD EPYC Processor (2017) + + +@item @code{Opteron_G5} + +AMD Opteron 63xx class CPU (2012) + + +@item @code{Opteron_G4} + +AMD Opteron 62xx class CPU (2011) + + +@item @code{Opteron_G3} + +AMD Opteron 23xx (Gen 3 Class Opteron, 2009) + + +@item @code{Opteron_G2} + +AMD Opteron 22xx (Gen 2 Class Opteron, 2006) + + +@item @code{Opteron_G1} + +AMD Opteron 240 (Gen 1 Class Opteron, 2004) +@end table + +@node important_cpu_features_amd_x86 +@subsection Important CPU features for AMD x86 hosts + +The following are important CPU features that should be used on AMD x86 +hosts, when available in the host CPU. Some of them require explicit +configuration to enable, as they are not included by default in some, or all, +of the named CPU models listed above. In general all of these features are +included if using "Host passthrough" or "Host model". + + +@table @option + +@item @code{ibpb} + +Required to enable the Spectre v2 (CVE-2017-5715) fix. + +Included by default in AMD CPU models with -IBPB suffix. + +Must be explicitly turned on for AMD CPU models without -IBPB suffix. + +Requires the host CPU microcode to support this feature before it +can be used for guest CPUs. + + +@item @code{stibp} + +Required to enable stronger Spectre v2 (CVE-2017-5715) fixes in some +operating systems. + +Must be explicitly turned on for all AMD CPU models. + +Requires the host CPU microcode to support this feature before it +can be used for guest CPUs. + + +@item @code{virt-ssbd} + +Required to enable the CVE-2018-3639 fix + +Not included by default in any AMD CPU model. + +Must be explicitly turned on for all AMD CPU models. + +This should be provided to guests, even if amd-ssbd is also +provided, for maximum guest compatibility. + +Note for some QEMU / libvirt versions, this must be force enabled +when when using "Host model", because this is a virtual feature +that doesn't exist in the physical host CPUs. + + +@item @code{amd-ssbd} + +Required to enable the CVE-2018-3639 fix + +Not included by default in any AMD CPU model. + +Must be explicitly turned on for all AMD CPU models. + +This provides higher performance than virt-ssbd so should be +exposed to guests whenever available in the host. virt-ssbd +should none the less also be exposed for maximum guest +compatibility as some kernels only know about virt-ssbd. + + +@item @code{amd-no-ssb} + +Recommended to indicate the host is not vulnerable CVE-2018-3639 + +Not included by default in any AMD CPU model. + +Future hardware generations of CPU will not be vulnerable to +CVE-2018-3639, and thus the guest should be told not to enable +its mitigations, by exposing amd-no-ssb. This is mutually +exclusive with virt-ssbd and amd-ssbd. + + +@item @code{pdpe1gb} + +Recommended to allow guest OS to use 1GB size pages + +Not included by default in any AMD CPU model. + +Should be explicitly turned on for all AMD CPU models. + +Note that not all CPU hardware will support this feature. +@end table + + +@node default_cpu_models_x86 +@subsection Default x86 CPU models + +The default QEMU CPU models are designed such that they can run on all hosts. +If an application does not wish to do perform any host compatibility checks +before launching guests, the default is guaranteed to work. + +The default CPU models will, however, leave the guest OS vulnerable to various +CPU hardware flaws, so their use is strongly discouraged. Applications should +follow the earlier guidance to setup a better CPU configuration, with host +passthrough recommended if live migration is not needed. + +@table @option +@item @code{qemu32} +@item @code{qemu64} + +QEMU Virtual CPU version 2.5+ (32 & 64 bit variants) + +qemu64 is used for x86_64 guests and qemu32 is used for i686 guests, when no +-cpu argument is given to QEMU, or no is provided in libvirt XML. +@end table + + +@node other_non_recommended_cpu_models_x86 +@subsection Other non-recommended x86 CPUs + +The following CPUs models are compatible with most AMD and Intel x86 hosts, but +their usage is discouraged, as they expose a very limited featureset, which +prevents guests having optimal performance. + +@table @option + +@item @code{kvm32} +@item @code{kvm64} + +Common KVM processor (32 & 64 bit variants) + +Legacy models just for historical compatibility with ancient QEMU versions. + + +@item @code{486} +@item @code{athlon} +@item @code{phenom} +@item @code{coreduo} +@item @code{core2duo} +@item @code{n270} +@item @code{pentium} +@item @code{pentium2} +@item @code{pentium3} + +Various very old x86 CPU models, mostly predating the introduction of +hardware assisted virtualization, that should thus not be required for +running virtual machines. +@end table + +@node cpu_model_syntax_apps +@subsection Syntax for configuring CPU models + +The example below illustrate the approach to configuring the various +CPU models / features in QEMU and libvirt. + +QEMU command line: + +@table @option + +@item Host passthrough + +@example + $ @value{qemu_system_x86} -cpu host +@end example + +With feature customization: + +@example + $ @value{qemu_system_x86} -cpu host,-vmx,... +@end example + +@item Named CPU models + +@example + $ @value{qemu_system_x86} -cpu Westmere +@end example + +With feature customization: + +@example + $ @value{qemu_system_x86} -cpu Westmere,+pcid,... +@end example + +@end table + + +Libvirt guest XML: + +@table @option + +@item Host passthrough + +@example + +@end example + +With feature customization: + +@example + + + ... + +@end example + +@item Host model + +@example + +@end example + +With feature customization: + +@example + + + ... + +@end example + +@item Named model + +@example + + + +@end example + +With feature customization: + +@example + + + + ... + +@end example + +@end table diff --git a/docs/system/qemu-cpu-models.texi b/docs/system/qemu-cpu-models.texi new file mode 100644 index 0000000000..f399daf944 --- /dev/null +++ b/docs/system/qemu-cpu-models.texi @@ -0,0 +1,28 @@ +@c man begin SYNOPSIS +QEMU / KVM CPU model configuration +@c man end + +@set qemu_system_x86 qemu-system-x86_64 + +@c man begin DESCRIPTION + +@include cpu-models-x86.texi +@include cpu-models-mips.texi + +@c man end + +@ignore + +@setfilename qemu-cpu-models +@settitle QEMU / KVM CPU model configuration + +@c man begin SEEALSO +The HTML documentation of QEMU for more precise information and Linux +user mode emulator invocation. +@c man end + +@c man begin AUTHOR +Daniel P. Berrange +@c man end + +@end ignore -- cgit v1.2.3-55-g7522 From fdeccf932d05c527b3ea57207a03392d15001b73 Mon Sep 17 00:00:00 2001 From: Paolo Bonzini Date: Fri, 28 Feb 2020 15:35:51 +0000 Subject: qemu-doc: split qemu-doc.texi in multiple files In order to facilitate the reorganization of qemu-doc.texi content, as well as the conversion to rST/Sphinx, split it in multiple .texi files that are included from docs/system. The "other devices" section is renamed to ivshmem and placed last. Signed-off-by: Paolo Bonzini Reviewed-by: Peter Maydell Reviewed-by: Alex Bennée Tested-by: Alex Bennée Signed-off-by: Peter Maydell Message-id: 20200228153619.9906-6-peter.maydell@linaro.org Message-id: 20200226113034.6741-6-pbonzini@redhat.com Reviewed-by: Peter Maydell Signed-off-by: Peter Maydell --- Makefile | 16 + docs/system/build-platforms.texi | 67 ++ docs/system/gdb.texi | 71 ++ docs/system/images.texi | 88 +++ docs/system/invocation.texi | 240 +++++++ docs/system/ivshmem.texi | 60 ++ docs/system/keys.texi | 53 ++ docs/system/license.texi | 9 + docs/system/linuxboot.texi | 27 + docs/system/monitor.texi | 35 + docs/system/mux-chardev.texi | 51 ++ docs/system/net.texi | 96 +++ docs/system/quickstart.texi | 13 + docs/system/tls.texi | 329 +++++++++ docs/system/usb.texi | 115 +++ docs/system/vnc-security.texi | 196 +++++ qemu-doc.texi | 1471 +------------------------------------- 17 files changed, 1483 insertions(+), 1454 deletions(-) create mode 100644 docs/system/build-platforms.texi create mode 100644 docs/system/gdb.texi create mode 100644 docs/system/images.texi create mode 100644 docs/system/invocation.texi create mode 100644 docs/system/ivshmem.texi create mode 100644 docs/system/keys.texi create mode 100644 docs/system/license.texi create mode 100644 docs/system/linuxboot.texi create mode 100644 docs/system/monitor.texi create mode 100644 docs/system/mux-chardev.texi create mode 100644 docs/system/net.texi create mode 100644 docs/system/quickstart.texi create mode 100644 docs/system/tls.texi create mode 100644 docs/system/usb.texi create mode 100644 docs/system/vnc-security.texi (limited to 'docs/system') diff --git a/Makefile b/Makefile index f75a7b5193..9790a0fd15 100644 --- a/Makefile +++ b/Makefile @@ -1123,6 +1123,22 @@ qemu-doc.html qemu-doc.info qemu-doc.pdf qemu-doc.txt: \ qemu-tech.texi qemu-option-trace.texi \ qemu-deprecated.texi qemu-monitor.texi \ qemu-monitor-info.texi \ + docs/system/quickstart.texi \ + docs/system/invocation.texi \ + docs/system/keys.texi \ + docs/system/mux-chardev.texi \ + docs/system/monitor.texi \ + docs/system/cpu-models-x86.texi \ + docs/system/images.texi \ + docs/system/net.texi \ + docs/system/usb.texi \ + docs/system/ivshmem.texi \ + docs/system/linuxboot.texi \ + docs/system/vnc-security.texi \ + docs/system/tls.texi \ + docs/system/gdb.texi \ + docs/system/build-platforms.texi \ + docs/system/license.texi \ docs/system/cpu-models-x86.texi docs/system/cpu-models-mips.texi \ docs/security.texi diff --git a/docs/system/build-platforms.texi b/docs/system/build-platforms.texi new file mode 100644 index 0000000000..531ef5bed4 --- /dev/null +++ b/docs/system/build-platforms.texi @@ -0,0 +1,67 @@ +@node Supported build platforms +@appendix Supported build platforms + +QEMU aims to support building and executing on multiple host OS platforms. +This appendix outlines which platforms are the major build targets. These +platforms are used as the basis for deciding upon the minimum required +versions of 3rd party software QEMU depends on. The supported platforms +are the targets for automated testing performed by the project when patches +are submitted for review, and tested before and after merge. + +If a platform is not listed here, it does not imply that QEMU won't work. +If an unlisted platform has comparable software versions to a listed platform, +there is every expectation that it will work. Bug reports are welcome for +problems encountered on unlisted platforms unless they are clearly older +vintage than what is described here. + +Note that when considering software versions shipped in distros as support +targets, QEMU considers only the version number, and assumes the features in +that distro match the upstream release with the same version. In other words, +if a distro backports extra features to the software in their distro, QEMU +upstream code will not add explicit support for those backports, unless the +feature is auto-detectable in a manner that works for the upstream releases +too. + +The Repology site @url{https://repology.org} is a useful resource to identify +currently shipped versions of software in various operating systems, though +it does not cover all distros listed below. + +@section Linux OS + +For distributions with frequent, short-lifetime releases, the project will +aim to support all versions that are not end of life by their respective +vendors. For the purposes of identifying supported software versions, the +project will look at Fedora, Ubuntu, and openSUSE distros. Other short- +lifetime distros will be assumed to ship similar software versions. + +For distributions with long-lifetime releases, the project will aim to support +the most recent major version at all times. Support for the previous major +version will be dropped 2 years after the new major version is released, +or when it reaches ``end of life''. For the purposes of identifying +supported software versions, the project will look at RHEL, Debian, +Ubuntu LTS, and SLES distros. Other long-lifetime distros will be +assumed to ship similar software versions. + +@section Windows + +The project supports building with current versions of the MinGW toolchain, +hosted on Linux. + +@section macOS + +The project supports building with the two most recent versions of macOS, with +the current homebrew package set available. + +@section FreeBSD + +The project aims to support the all the versions which are not end of life. + +@section NetBSD + +The project aims to support the most recent major version at all times. Support +for the previous major version will be dropped 2 years after the new major +version is released. + +@section OpenBSD + +The project aims to support the all the versions which are not end of life. diff --git a/docs/system/gdb.texi b/docs/system/gdb.texi new file mode 100644 index 0000000000..f49bc5891e --- /dev/null +++ b/docs/system/gdb.texi @@ -0,0 +1,71 @@ +@node gdb_usage +@section GDB usage + +QEMU has a primitive support to work with gdb, so that you can do +'Ctrl-C' while the virtual machine is running and inspect its state. + +In order to use gdb, launch QEMU with the '-s' option. It will wait for a +gdb connection: +@example +@value{qemu_system} -s -kernel bzImage -hda rootdisk.img -append "root=/dev/hda" +Connected to host network interface: tun0 +Waiting gdb connection on port 1234 +@end example + +Then launch gdb on the 'vmlinux' executable: +@example +> gdb vmlinux +@end example + +In gdb, connect to QEMU: +@example +(gdb) target remote localhost:1234 +@end example + +Then you can use gdb normally. For example, type 'c' to launch the kernel: +@example +(gdb) c +@end example + +Here are some useful tips in order to use gdb on system code: + +@enumerate +@item +Use @code{info reg} to display all the CPU registers. +@item +Use @code{x/10i $eip} to display the code at the PC position. +@item +Use @code{set architecture i8086} to dump 16 bit code. Then use +@code{x/10i $cs*16+$eip} to dump the code at the PC position. +@end enumerate + +Advanced debugging options: + +The default single stepping behavior is step with the IRQs and timer service routines off. It is set this way because when gdb executes a single step it expects to advance beyond the current instruction. With the IRQs and timer service routines on, a single step might jump into the one of the interrupt or exception vectors instead of executing the current instruction. This means you may hit the same breakpoint a number of times before executing the instruction gdb wants to have executed. Because there are rare circumstances where you want to single step into an interrupt vector the behavior can be controlled from GDB. There are three commands you can query and set the single step behavior: +@table @code +@item maintenance packet qqemu.sstepbits + +This will display the MASK bits used to control the single stepping IE: +@example +(gdb) maintenance packet qqemu.sstepbits +sending: "qqemu.sstepbits" +received: "ENABLE=1,NOIRQ=2,NOTIMER=4" +@end example +@item maintenance packet qqemu.sstep + +This will display the current value of the mask used when single stepping IE: +@example +(gdb) maintenance packet qqemu.sstep +sending: "qqemu.sstep" +received: "0x7" +@end example +@item maintenance packet Qqemu.sstep=HEX_VALUE + +This will change the single step mask, so if wanted to enable IRQs on the single step, but not timers, you would use: +@example +(gdb) maintenance packet Qqemu.sstep=0x5 +sending: "qemu.sstep=0x5" +received: "OK" +@end example +@end table + diff --git a/docs/system/images.texi b/docs/system/images.texi new file mode 100644 index 0000000000..c5060348ec --- /dev/null +++ b/docs/system/images.texi @@ -0,0 +1,88 @@ +@node disk_images +@section Disk Images + +QEMU supports many disk image formats, including growable disk images +(their size increase as non empty sectors are written), compressed and +encrypted disk images. + +@menu +* disk_images_quickstart:: Quick start for disk image creation +* disk_images_snapshot_mode:: Snapshot mode +* vm_snapshots:: VM snapshots +@end menu + +@node disk_images_quickstart +@subsection Quick start for disk image creation + +You can create a disk image with the command: +@example +qemu-img create myimage.img mysize +@end example +where @var{myimage.img} is the disk image filename and @var{mysize} is its +size in kilobytes. You can add an @code{M} suffix to give the size in +megabytes and a @code{G} suffix for gigabytes. + +@c When this document is converted to rst we should make this into +@c a proper linked reference to the qemu-img documentation again: +See the qemu-img invocation documentation for more information. + +@node disk_images_snapshot_mode +@subsection Snapshot mode + +If you use the option @option{-snapshot}, all disk images are +considered as read only. When sectors in written, they are written in +a temporary file created in @file{/tmp}. You can however force the +write back to the raw disk images by using the @code{commit} monitor +command (or @key{C-a s} in the serial console). + +@node vm_snapshots +@subsection VM snapshots + +VM snapshots are snapshots of the complete virtual machine including +CPU state, RAM, device state and the content of all the writable +disks. In order to use VM snapshots, you must have at least one non +removable and writable block device using the @code{qcow2} disk image +format. Normally this device is the first virtual hard drive. + +Use the monitor command @code{savevm} to create a new VM snapshot or +replace an existing one. A human readable name can be assigned to each +snapshot in addition to its numerical ID. + +Use @code{loadvm} to restore a VM snapshot and @code{delvm} to remove +a VM snapshot. @code{info snapshots} lists the available snapshots +with their associated information: + +@example +(qemu) info snapshots +Snapshot devices: hda +Snapshot list (from hda): +ID TAG VM SIZE DATE VM CLOCK +1 start 41M 2006-08-06 12:38:02 00:00:14.954 +2 40M 2006-08-06 12:43:29 00:00:18.633 +3 msys 40M 2006-08-06 12:44:04 00:00:23.514 +@end example + +A VM snapshot is made of a VM state info (its size is shown in +@code{info snapshots}) and a snapshot of every writable disk image. +The VM state info is stored in the first @code{qcow2} non removable +and writable block device. The disk image snapshots are stored in +every disk image. The size of a snapshot in a disk image is difficult +to evaluate and is not shown by @code{info snapshots} because the +associated disk sectors are shared among all the snapshots to save +disk space (otherwise each snapshot would need a full copy of all the +disk images). + +When using the (unrelated) @code{-snapshot} option +(@ref{disk_images_snapshot_mode}), you can always make VM snapshots, +but they are deleted as soon as you exit QEMU. + +VM snapshots currently have the following known limitations: +@itemize +@item +They cannot cope with removable devices if they are removed or +inserted after a snapshot is done. +@item +A few device drivers still have incomplete snapshot support so their +state is not saved or restored properly (in particular USB). +@end itemize + diff --git a/docs/system/invocation.texi b/docs/system/invocation.texi new file mode 100644 index 0000000000..dac41cc7e5 --- /dev/null +++ b/docs/system/invocation.texi @@ -0,0 +1,240 @@ +@node sec_invocation +@section Invocation + +@example +@c man begin SYNOPSIS +@command{@value{qemu_system}} [@var{options}] [@var{disk_image}] +@c man end +@end example + +@c man begin OPTIONS +@var{disk_image} is a raw hard disk image for IDE hard disk 0. Some +targets do not need a disk image. + +@include qemu-options.texi + +@c man end + +@subsection Device URL Syntax +@c TODO merge this with section Disk Images + +@c man begin NOTES + +In addition to using normal file images for the emulated storage devices, +QEMU can also use networked resources such as iSCSI devices. These are +specified using a special URL syntax. + +@table @option +@item iSCSI +iSCSI support allows QEMU to access iSCSI resources directly and use as +images for the guest storage. Both disk and cdrom images are supported. + +Syntax for specifying iSCSI LUNs is +``iscsi://[:]//'' + +By default qemu will use the iSCSI initiator-name +'iqn.2008-11.org.linux-kvm[:]' but this can also be set from the command +line or a configuration file. + +Since version Qemu 2.4 it is possible to specify a iSCSI request timeout to detect +stalled requests and force a reestablishment of the session. The timeout +is specified in seconds. The default is 0 which means no timeout. Libiscsi +1.15.0 or greater is required for this feature. + +Example (without authentication): +@example +@value{qemu_system} -iscsi initiator-name=iqn.2001-04.com.example:my-initiator \ + -cdrom iscsi://192.0.2.1/iqn.2001-04.com.example/2 \ + -drive file=iscsi://192.0.2.1/iqn.2001-04.com.example/1 +@end example + +Example (CHAP username/password via URL): +@example +@value{qemu_system} -drive file=iscsi://user%password@@192.0.2.1/iqn.2001-04.com.example/1 +@end example + +Example (CHAP username/password via environment variables): +@example +LIBISCSI_CHAP_USERNAME="user" \ +LIBISCSI_CHAP_PASSWORD="password" \ +@value{qemu_system} -drive file=iscsi://192.0.2.1/iqn.2001-04.com.example/1 +@end example + +@item NBD +QEMU supports NBD (Network Block Devices) both using TCP protocol as well +as Unix Domain Sockets. With TCP, the default port is 10809. + +Syntax for specifying a NBD device using TCP, in preferred URI form: +``nbd://[:]/[]'' + +Syntax for specifying a NBD device using Unix Domain Sockets; remember +that '?' is a shell glob character and may need quoting: +``nbd+unix:///[]?socket='' + +Older syntax that is also recognized: +``nbd::[:exportname=]'' + +Syntax for specifying a NBD device using Unix Domain Sockets +``nbd:unix:[:exportname=]'' + +Example for TCP +@example +@value{qemu_system} --drive file=nbd:192.0.2.1:30000 +@end example + +Example for Unix Domain Sockets +@example +@value{qemu_system} --drive file=nbd:unix:/tmp/nbd-socket +@end example + +@item SSH +QEMU supports SSH (Secure Shell) access to remote disks. + +Examples: +@example +@value{qemu_system} -drive file=ssh://user@@host/path/to/disk.img +@value{qemu_system} -drive file.driver=ssh,file.user=user,file.host=host,file.port=22,file.path=/path/to/disk.img +@end example + +Currently authentication must be done using ssh-agent. Other +authentication methods may be supported in future. + +@item Sheepdog +Sheepdog is a distributed storage system for QEMU. +QEMU supports using either local sheepdog devices or remote networked +devices. + +Syntax for specifying a sheepdog device +@example +sheepdog[+tcp|+unix]://[host:port]/vdiname[?socket=path][#snapid|#tag] +@end example + +Example +@example +@value{qemu_system} --drive file=sheepdog://192.0.2.1:30000/MyVirtualMachine +@end example + +See also @url{https://sheepdog.github.io/sheepdog/}. + +@item GlusterFS +GlusterFS is a user space distributed file system. +QEMU supports the use of GlusterFS volumes for hosting VM disk images using +TCP, Unix Domain Sockets and RDMA transport protocols. + +Syntax for specifying a VM disk image on GlusterFS volume is +@example + +URI: +gluster[+type]://[host[:port]]/volume/path[?socket=...][,debug=N][,logfile=...] + +JSON: +'json:@{"driver":"qcow2","file":@{"driver":"gluster","volume":"testvol","path":"a.img","debug":N,"logfile":"...", +@ "server":[@{"type":"tcp","host":"...","port":"..."@}, +@ @{"type":"unix","socket":"..."@}]@}@}' +@end example + + +Example +@example +URI: +@value{qemu_system} --drive file=gluster://192.0.2.1/testvol/a.img, +@ file.debug=9,file.logfile=/var/log/qemu-gluster.log + +JSON: +@value{qemu_system} 'json:@{"driver":"qcow2", +@ "file":@{"driver":"gluster", +@ "volume":"testvol","path":"a.img", +@ "debug":9,"logfile":"/var/log/qemu-gluster.log", +@ "server":[@{"type":"tcp","host":"1.2.3.4","port":24007@}, +@ @{"type":"unix","socket":"/var/run/glusterd.socket"@}]@}@}' +@value{qemu_system} -drive driver=qcow2,file.driver=gluster,file.volume=testvol,file.path=/path/a.img, +@ file.debug=9,file.logfile=/var/log/qemu-gluster.log, +@ file.server.0.type=tcp,file.server.0.host=1.2.3.4,file.server.0.port=24007, +@ file.server.1.type=unix,file.server.1.socket=/var/run/glusterd.socket +@end example + +See also @url{http://www.gluster.org}. + +@item HTTP/HTTPS/FTP/FTPS +QEMU supports read-only access to files accessed over http(s) and ftp(s). + +Syntax using a single filename: +@example +://[[:]@@]/ +@end example + +where: +@table @option +@item protocol +'http', 'https', 'ftp', or 'ftps'. + +@item username +Optional username for authentication to the remote server. + +@item password +Optional password for authentication to the remote server. + +@item host +Address of the remote server. + +@item path +Path on the remote server, including any query string. +@end table + +The following options are also supported: +@table @option +@item url +The full URL when passing options to the driver explicitly. + +@item readahead +The amount of data to read ahead with each range request to the remote server. +This value may optionally have the suffix 'T', 'G', 'M', 'K', 'k' or 'b'. If it +does not have a suffix, it will be assumed to be in bytes. The value must be a +multiple of 512 bytes. It defaults to 256k. + +@item sslverify +Whether to verify the remote server's certificate when connecting over SSL. It +can have the value 'on' or 'off'. It defaults to 'on'. + +@item cookie +Send this cookie (it can also be a list of cookies separated by ';') with +each outgoing request. Only supported when using protocols such as HTTP +which support cookies, otherwise ignored. + +@item timeout +Set the timeout in seconds of the CURL connection. This timeout is the time +that CURL waits for a response from the remote server to get the size of the +image to be downloaded. If not set, the default timeout of 5 seconds is used. +@end table + +Note that when passing options to qemu explicitly, @option{driver} is the value +of . + +Example: boot from a remote Fedora 20 live ISO image +@example +@value{qemu_system_x86} --drive media=cdrom,file=https://archives.fedoraproject.org/pub/archive/fedora/linux/releases/20/Live/x86_64/Fedora-Live-Desktop-x86_64-20-1.iso,readonly + +@value{qemu_system_x86} --drive media=cdrom,file.driver=http,file.url=http://archives.fedoraproject.org/pub/fedora/linux/releases/20/Live/x86_64/Fedora-Live-Desktop-x86_64-20-1.iso,readonly +@end example + +Example: boot from a remote Fedora 20 cloud image using a local overlay for +writes, copy-on-read, and a readahead of 64k +@example +qemu-img create -f qcow2 -o backing_file='json:@{"file.driver":"http",, "file.url":"http://archives.fedoraproject.org/pub/archive/fedora/linux/releases/20/Images/x86_64/Fedora-x86_64-20-20131211.1-sda.qcow2",, "file.readahead":"64k"@}' /tmp/Fedora-x86_64-20-20131211.1-sda.qcow2 + +@value{qemu_system_x86} -drive file=/tmp/Fedora-x86_64-20-20131211.1-sda.qcow2,copy-on-read=on +@end example + +Example: boot from an image stored on a VMware vSphere server with a self-signed +certificate using a local overlay for writes, a readahead of 64k and a timeout +of 10 seconds. +@example +qemu-img create -f qcow2 -o backing_file='json:@{"file.driver":"https",, "file.url":"https://user:password@@vsphere.example.com/folder/test/test-flat.vmdk?dcPath=Datacenter&dsName=datastore1",, "file.sslverify":"off",, "file.readahead":"64k",, "file.timeout":10@}' /tmp/test.qcow2 + +@value{qemu_system_x86} -drive file=/tmp/test.qcow2 +@end example + +@end table + +@c man end + diff --git a/docs/system/ivshmem.texi b/docs/system/ivshmem.texi new file mode 100644 index 0000000000..bd97719eaf --- /dev/null +++ b/docs/system/ivshmem.texi @@ -0,0 +1,60 @@ +@node pcsys_ivshmem +@section Inter-VM Shared Memory device + +On Linux hosts, a shared memory device is available. The basic syntax +is: + +@example +@value{qemu_system_x86} -device ivshmem-plain,memdev=@var{hostmem} +@end example + +where @var{hostmem} names a host memory backend. For a POSIX shared +memory backend, use something like + +@example +-object memory-backend-file,size=1M,share,mem-path=/dev/shm/ivshmem,id=@var{hostmem} +@end example + +If desired, interrupts can be sent between guest VMs accessing the same shared +memory region. Interrupt support requires using a shared memory server and +using a chardev socket to connect to it. The code for the shared memory server +is qemu.git/contrib/ivshmem-server. An example syntax when using the shared +memory server is: + +@example +# First start the ivshmem server once and for all +ivshmem-server -p @var{pidfile} -S @var{path} -m @var{shm-name} -l @var{shm-size} -n @var{vectors} + +# Then start your qemu instances with matching arguments +@value{qemu_system_x86} -device ivshmem-doorbell,vectors=@var{vectors},chardev=@var{id} + -chardev socket,path=@var{path},id=@var{id} +@end example + +When using the server, the guest will be assigned a VM ID (>=0) that allows guests +using the same server to communicate via interrupts. Guests can read their +VM ID from a device register (see ivshmem-spec.txt). + +@subsection Migration with ivshmem + +With device property @option{master=on}, the guest will copy the shared +memory on migration to the destination host. With @option{master=off}, +the guest will not be able to migrate with the device attached. In the +latter case, the device should be detached and then reattached after +migration using the PCI hotplug support. + +At most one of the devices sharing the same memory can be master. The +master must complete migration before you plug back the other devices. + +@subsection ivshmem and hugepages + +Instead of specifying the using POSIX shm, you may specify +a memory backend that has hugepage support: + +@example +@value{qemu_system_x86} -object memory-backend-file,size=1G,mem-path=/dev/hugepages/my-shmem-file,share,id=mb1 + -device ivshmem-plain,memdev=mb1 +@end example + +ivshmem-server also supports hugepages mount points with the +@option{-m} memory path argument. + diff --git a/docs/system/keys.texi b/docs/system/keys.texi new file mode 100644 index 0000000000..4c74b3bf4d --- /dev/null +++ b/docs/system/keys.texi @@ -0,0 +1,53 @@ +@node pcsys_keys +@section Keys in the graphical frontends + +@c man begin OPTIONS + +During the graphical emulation, you can use special key combinations to change +modes. The default key mappings are shown below, but if you use @code{-alt-grab} +then the modifier is Ctrl-Alt-Shift (instead of Ctrl-Alt) and if you use +@code{-ctrl-grab} then the modifier is the right Ctrl key (instead of Ctrl-Alt): + +@table @key +@item Ctrl-Alt-f +@kindex Ctrl-Alt-f +Toggle full screen + +@item Ctrl-Alt-+ +@kindex Ctrl-Alt-+ +Enlarge the screen + +@item Ctrl-Alt-- +@kindex Ctrl-Alt-- +Shrink the screen + +@item Ctrl-Alt-u +@kindex Ctrl-Alt-u +Restore the screen's un-scaled dimensions + +@item Ctrl-Alt-n +@kindex Ctrl-Alt-n +Switch to virtual console 'n'. Standard console mappings are: +@table @emph +@item 1 +Target system display +@item 2 +Monitor +@item 3 +Serial port +@end table + +@item Ctrl-Alt +@kindex Ctrl-Alt +Toggle mouse and keyboard grab. +@end table + +@kindex Ctrl-Up +@kindex Ctrl-Down +@kindex Ctrl-PageUp +@kindex Ctrl-PageDown +In the virtual consoles, you can use @key{Ctrl-Up}, @key{Ctrl-Down}, +@key{Ctrl-PageUp} and @key{Ctrl-PageDown} to move in the back log. + +@c man end + diff --git a/docs/system/license.texi b/docs/system/license.texi new file mode 100644 index 0000000000..b682235a7e --- /dev/null +++ b/docs/system/license.texi @@ -0,0 +1,9 @@ +@node License +@appendix License + +QEMU is a trademark of Fabrice Bellard. + +QEMU is released under the +@url{https://www.gnu.org/licenses/gpl-2.0.txt,GNU General Public License}, +version 2. Parts of QEMU have specific licenses, see file +@url{https://git.qemu.org/?p=qemu.git;a=blob_plain;f=LICENSE,LICENSE}. diff --git a/docs/system/linuxboot.texi b/docs/system/linuxboot.texi new file mode 100644 index 0000000000..97c3cefae0 --- /dev/null +++ b/docs/system/linuxboot.texi @@ -0,0 +1,27 @@ +@node direct_linux_boot +@section Direct Linux Boot + +This section explains how to launch a Linux kernel inside QEMU without +having to make a full bootable image. It is very useful for fast Linux +kernel testing. + +The syntax is: +@example +@value{qemu_system} -kernel bzImage -hda rootdisk.img -append "root=/dev/hda" +@end example + +Use @option{-kernel} to provide the Linux kernel image and +@option{-append} to give the kernel command line arguments. The +@option{-initrd} option can be used to provide an INITRD image. + +If you do not need graphical output, you can disable it and redirect +the virtual serial port and the QEMU monitor to the console with the +@option{-nographic} option. The typical command line is: +@example +@value{qemu_system} -kernel bzImage -hda rootdisk.img \ + -append "root=/dev/hda console=ttyS0" -nographic +@end example + +Use @key{Ctrl-a c} to switch between the serial console and the +monitor (@pxref{pcsys_keys}). + diff --git a/docs/system/monitor.texi b/docs/system/monitor.texi new file mode 100644 index 0000000000..c5b6a9b38e --- /dev/null +++ b/docs/system/monitor.texi @@ -0,0 +1,35 @@ +@node pcsys_monitor +@section QEMU Monitor +@cindex QEMU monitor + +The QEMU monitor is used to give complex commands to the QEMU +emulator. You can use it to: + +@itemize @minus + +@item +Remove or insert removable media images +(such as CD-ROM or floppies). + +@item +Freeze/unfreeze the Virtual Machine (VM) and save or restore its state +from a disk file. + +@item Inspect the VM state without an external debugger. + +@end itemize + +@subsection Commands + +The following commands are available: + +@include qemu-monitor.texi + +@include qemu-monitor-info.texi + +@subsection Integer expressions + +The monitor understands integers expressions for every integer +argument. You can use register names to get the value of specifics +CPU registers by prefixing them with @emph{$}. + diff --git a/docs/system/mux-chardev.texi b/docs/system/mux-chardev.texi new file mode 100644 index 0000000000..c9a2d14cb8 --- /dev/null +++ b/docs/system/mux-chardev.texi @@ -0,0 +1,51 @@ +@node mux_keys +@section Keys in the character backend multiplexer + +@c man begin OPTIONS + +During emulation, if you are using a character backend multiplexer +(which is the default if you are using @option{-nographic}) then +several commands are available via an escape sequence. These +key sequences all start with an escape character, which is @key{Ctrl-a} +by default, but can be changed with @option{-echr}. The list below assumes +you're using the default. + +@table @key +@item Ctrl-a h +@kindex Ctrl-a h +Print this help +@item Ctrl-a x +@kindex Ctrl-a x +Exit emulator +@item Ctrl-a s +@kindex Ctrl-a s +Save disk data back to file (if -snapshot) +@item Ctrl-a t +@kindex Ctrl-a t +Toggle console timestamps +@item Ctrl-a b +@kindex Ctrl-a b +Send break (magic sysrq in Linux) +@item Ctrl-a c +@kindex Ctrl-a c +Rotate between the frontends connected to the multiplexer (usually +this switches between the monitor and the console) +@item Ctrl-a Ctrl-a +@kindex Ctrl-a Ctrl-a +Send the escape character to the frontend +@end table +@c man end + +@ignore + +@c man begin SEEALSO +The HTML documentation of QEMU for more precise information and Linux +user mode emulator invocation. +@c man end + +@c man begin AUTHOR +Fabrice Bellard +@c man end + +@end ignore + diff --git a/docs/system/net.texi b/docs/system/net.texi new file mode 100644 index 0000000000..4a6fb2e6a8 --- /dev/null +++ b/docs/system/net.texi @@ -0,0 +1,96 @@ +@node pcsys_network +@section Network emulation + +QEMU can simulate several network cards (e.g. PCI or ISA cards on the PC +target) and can connect them to a network backend on the host or an emulated +hub. The various host network backends can either be used to connect the NIC of +the guest to a real network (e.g. by using a TAP devices or the non-privileged +user mode network stack), or to other guest instances running in another QEMU +process (e.g. by using the socket host network backend). + +@subsection Using TAP network interfaces + +This is the standard way to connect QEMU to a real network. QEMU adds +a virtual network device on your host (called @code{tapN}), and you +can then configure it as if it was a real ethernet card. + +@subsubsection Linux host + +As an example, you can download the @file{linux-test-xxx.tar.gz} +archive and copy the script @file{qemu-ifup} in @file{/etc} and +configure properly @code{sudo} so that the command @code{ifconfig} +contained in @file{qemu-ifup} can be executed as root. You must verify +that your host kernel supports the TAP network interfaces: the +device @file{/dev/net/tun} must be present. + +See @ref{sec_invocation} to have examples of command lines using the +TAP network interfaces. + +@subsubsection Windows host + +There is a virtual ethernet driver for Windows 2000/XP systems, called +TAP-Win32. But it is not included in standard QEMU for Windows, +so you will need to get it separately. It is part of OpenVPN package, +so download OpenVPN from : @url{https://openvpn.net/}. + +@subsection Using the user mode network stack + +By using the option @option{-net user} (default configuration if no +@option{-net} option is specified), QEMU uses a completely user mode +network stack (you don't need root privilege to use the virtual +network). The virtual network configuration is the following: + +@example + + guest (10.0.2.15) <------> Firewall/DHCP server <-----> Internet + | (10.0.2.2) + | + ----> DNS server (10.0.2.3) + | + ----> SMB server (10.0.2.4) +@end example + +The QEMU VM behaves as if it was behind a firewall which blocks all +incoming connections. You can use a DHCP client to automatically +configure the network in the QEMU VM. The DHCP server assign addresses +to the hosts starting from 10.0.2.15. + +In order to check that the user mode network is working, you can ping +the address 10.0.2.2 and verify that you got an address in the range +10.0.2.x from the QEMU virtual DHCP server. + +Note that ICMP traffic in general does not work with user mode networking. +@code{ping}, aka. ICMP echo, to the local router (10.0.2.2) shall work, +however. If you're using QEMU on Linux >= 3.0, it can use unprivileged ICMP +ping sockets to allow @code{ping} to the Internet. The host admin has to set +the ping_group_range in order to grant access to those sockets. To allow ping +for GID 100 (usually users group): + +@example +echo 100 100 > /proc/sys/net/ipv4/ping_group_range +@end example + +When using the built-in TFTP server, the router is also the TFTP +server. + +When using the @option{'-netdev user,hostfwd=...'} option, TCP or UDP +connections can be redirected from the host to the guest. It allows for +example to redirect X11, telnet or SSH connections. + +@subsection Hubs + +QEMU can simulate several hubs. A hub can be thought of as a virtual connection +between several network devices. These devices can be for example QEMU virtual +ethernet cards or virtual Host ethernet devices (TAP devices). You can connect +guest NICs or host network backends to such a hub using the @option{-netdev +hubport} or @option{-nic hubport} options. The legacy @option{-net} option +also connects the given device to the emulated hub with ID 0 (i.e. the default +hub) unless you specify a netdev with @option{-net nic,netdev=xxx} here. + +@subsection Connecting emulated networks between QEMU instances + +Using the @option{-netdev socket} (or @option{-nic socket} or +@option{-net socket}) option, it is possible to create emulated +networks that span several QEMU instances. +See the description of the @option{-netdev socket} option in the +@ref{sec_invocation,,Invocation chapter} to have a basic example. diff --git a/docs/system/quickstart.texi b/docs/system/quickstart.texi new file mode 100644 index 0000000000..8cd5b4bc6e --- /dev/null +++ b/docs/system/quickstart.texi @@ -0,0 +1,13 @@ +@node pcsys_quickstart +@section Quick Start +@cindex quick start + +Download and uncompress a hard disk image with Linux installed (e.g. +@file{linux.img}) and type: + +@example +@value{qemu_system} linux.img +@end example + +Linux should boot and give you a prompt. + diff --git a/docs/system/tls.texi b/docs/system/tls.texi new file mode 100644 index 0000000000..c233531d3a --- /dev/null +++ b/docs/system/tls.texi @@ -0,0 +1,329 @@ +@node network_tls +@section TLS setup for network services + +Almost all network services in QEMU have the ability to use TLS for +session data encryption, along with x509 certificates for simple +client authentication. What follows is a description of how to +generate certificates suitable for usage with QEMU, and applies to +the VNC server, character devices with the TCP backend, NBD server +and client, and migration server and client. + +At a high level, QEMU requires certificates and private keys to be +provided in PEM format. Aside from the core fields, the certificates +should include various extension data sets, including v3 basic +constraints data, key purpose, key usage and subject alt name. + +The GnuTLS package includes a command called @code{certtool} which can +be used to easily generate certificates and keys in the required format +with expected data present. Alternatively a certificate management +service may be used. + +At a minimum it is necessary to setup a certificate authority, and +issue certificates to each server. If using x509 certificates for +authentication, then each client will also need to be issued a +certificate. + +Assuming that the QEMU network services will only ever be exposed to +clients on a private intranet, there is no need to use a commercial +certificate authority to create certificates. A self-signed CA is +sufficient, and in fact likely to be more secure since it removes +the ability of malicious 3rd parties to trick the CA into mis-issuing +certs for impersonating your services. The only likely exception +where a commercial CA might be desirable is if enabling the VNC +websockets server and exposing it directly to remote browser clients. +In such a case it might be useful to use a commercial CA to avoid +needing to install custom CA certs in the web browsers. + +The recommendation is for the server to keep its certificates in either +@code{/etc/pki/qemu} or for unprivileged users in @code{$HOME/.pki/qemu}. + +@menu +* tls_generate_ca:: +* tls_generate_server:: +* tls_generate_client:: +* tls_creds_setup:: +* tls_psk:: +@end menu +@node tls_generate_ca +@subsection Setup the Certificate Authority + +This step only needs to be performed once per organization / organizational +unit. First the CA needs a private key. This key must be kept VERY secret +and secure. If this key is compromised the entire trust chain of the certificates +issued with it is lost. + +@example +# certtool --generate-privkey > ca-key.pem +@end example + +To generate a self-signed certificate requires one core piece of information, +the name of the organization. A template file @code{ca.info} should be +populated with the desired data to avoid having to deal with interactive +prompts from certtool: +@example +# cat > ca.info < server-hostNNN.info < server-hostNNN-key.pem +# certtool --generate-certificate \ + --load-ca-certificate ca-cert.pem \ + --load-ca-privkey ca-key.pem \ + --load-privkey server-hostNNN-key.pem \ + --template server-hostNNN.info \ + --outfile server-hostNNN-cert.pem +@end example + +The @code{dns_name} and @code{ip_address} fields in the template are setting +the subject alt name extension data. The @code{tls_www_server} keyword is the +key purpose extension to indicate this certificate is intended for usage in +a web server. Although QEMU network services are not in fact HTTP servers +(except for VNC websockets), setting this key purpose is still recommended. +The @code{encryption_key} and @code{signing_key} keyword is the key usage +extension to indicate this certificate is intended for usage in the data +session. + +The @code{server-hostNNN-key.pem} and @code{server-hostNNN-cert.pem} files +should now be securely copied to the server for which they were generated, +and renamed to @code{server-key.pem} and @code{server-cert.pem} when added +to the @code{/etc/pki/qemu} directory on the target host. The @code{server-key.pem} +file is security sensitive and should be kept protected with file mode 0600 +to prevent disclosure. + +@node tls_generate_client +@subsection Issuing client certificates + +The QEMU x509 TLS credential setup defaults to enabling client verification +using certificates, providing a simple authentication mechanism. If this +default is used, each client also needs to be issued a certificate. The client +certificate contains enough metadata to uniquely identify the client with the +scope of the certificate authority. The client certificate would typically +include fields for organization, state, city, building, etc. + +Once again on the host holding the CA, create template files containing the +information for each client, and use it to issue client certificates. + + +@example +# cat > client-hostNNN.info < client-hostNNN-key.pem +# certtool --generate-certificate \ + --load-ca-certificate ca-cert.pem \ + --load-ca-privkey ca-key.pem \ + --load-privkey client-hostNNN-key.pem \ + --template client-hostNNN.info \ + --outfile client-hostNNN-cert.pem +@end example + +The subject alt name extension data is not required for clients, so the +the @code{dns_name} and @code{ip_address} fields are not included. +The @code{tls_www_client} keyword is the key purpose extension to indicate +this certificate is intended for usage in a web client. Although QEMU +network clients are not in fact HTTP clients, setting this key purpose is +still recommended. The @code{encryption_key} and @code{signing_key} keyword +is the key usage extension to indicate this certificate is intended for +usage in the data session. + +The @code{client-hostNNN-key.pem} and @code{client-hostNNN-cert.pem} files +should now be securely copied to the client for which they were generated, +and renamed to @code{client-key.pem} and @code{client-cert.pem} when added +to the @code{/etc/pki/qemu} directory on the target host. The @code{client-key.pem} +file is security sensitive and should be kept protected with file mode 0600 +to prevent disclosure. + +If a single host is going to be using TLS in both a client and server +role, it is possible to create a single certificate to cover both roles. +This would be quite common for the migration and NBD services, where a +QEMU process will be started by accepting a TLS protected incoming migration, +and later itself be migrated out to another host. To generate a single +certificate, simply include the template data from both the client and server +instructions in one. + +@example +# cat > both-hostNNN.info < both-hostNNN-key.pem +# certtool --generate-certificate \ + --load-ca-certificate ca-cert.pem \ + --load-ca-privkey ca-key.pem \ + --load-privkey both-hostNNN-key.pem \ + --template both-hostNNN.info \ + --outfile both-hostNNN-cert.pem +@end example + +When copying the PEM files to the target host, save them twice, +once as @code{server-cert.pem} and @code{server-key.pem}, and +again as @code{client-cert.pem} and @code{client-key.pem}. + +@node tls_creds_setup +@subsection TLS x509 credential configuration + +QEMU has a standard mechanism for loading x509 credentials that will be +used for network services and clients. It requires specifying the +@code{tls-creds-x509} class name to the @code{--object} command line +argument for the system emulators. Each set of credentials loaded should +be given a unique string identifier via the @code{id} parameter. A single +set of TLS credentials can be used for multiple network backends, so VNC, +migration, NBD, character devices can all share the same credentials. Note, +however, that credentials for use in a client endpoint must be loaded +separately from those used in a server endpoint. + +When specifying the object, the @code{dir} parameters specifies which +directory contains the credential files. This directory is expected to +contain files with the names mentioned previously, @code{ca-cert.pem}, +@code{server-key.pem}, @code{server-cert.pem}, @code{client-key.pem} +and @code{client-cert.pem} as appropriate. It is also possible to +include a set of pre-generated Diffie-Hellman (DH) parameters in a file +@code{dh-params.pem}, which can be created using the +@code{certtool --generate-dh-params} command. If omitted, QEMU will +dynamically generate DH parameters when loading the credentials. + +The @code{endpoint} parameter indicates whether the credentials will +be used for a network client or server, and determines which PEM +files are loaded. + +The @code{verify} parameter determines whether x509 certificate +validation should be performed. This defaults to enabled, meaning +clients will always validate the server hostname against the +certificate subject alt name fields and/or CN field. It also +means that servers will request that clients provide a certificate +and validate them. Verification should never be turned off for +client endpoints, however, it may be turned off for server endpoints +if an alternative mechanism is used to authenticate clients. For +example, the VNC server can use SASL to authenticate clients +instead. + +To load server credentials with client certificate validation +enabled + +@example +@value{qemu_system} -object tls-creds-x509,id=tls0,dir=/etc/pki/qemu,endpoint=server +@end example + +while to load client credentials use + +@example +@value{qemu_system} -object tls-creds-x509,id=tls0,dir=/etc/pki/qemu,endpoint=client +@end example + +Network services which support TLS will all have a @code{tls-creds} +parameter which expects the ID of the TLS credentials object. For +example with VNC: + +@example +@value{qemu_system} -vnc 0.0.0.0:0,tls-creds=tls0 +@end example + +@node tls_psk +@subsection TLS Pre-Shared Keys (PSK) + +Instead of using certificates, you may also use TLS Pre-Shared Keys +(TLS-PSK). This can be simpler to set up than certificates but is +less scalable. + +Use the GnuTLS @code{psktool} program to generate a @code{keys.psk} +file containing one or more usernames and random keys: + +@example +mkdir -m 0700 /tmp/keys +psktool -u rich -p /tmp/keys/keys.psk +@end example + +TLS-enabled servers such as qemu-nbd can use this directory like so: + +@example +qemu-nbd \ + -t -x / \ + --object tls-creds-psk,id=tls0,endpoint=server,dir=/tmp/keys \ + --tls-creds tls0 \ + image.qcow2 +@end example + +When connecting from a qemu-based client you must specify the +directory containing @code{keys.psk} and an optional @var{username} +(defaults to ``qemu''): + +@example +qemu-img info \ + --object tls-creds-psk,id=tls0,dir=/tmp/keys,username=rich,endpoint=client \ + --image-opts \ + file.driver=nbd,file.host=localhost,file.port=10809,file.tls-creds=tls0,file.export=/ +@end example + diff --git a/docs/system/usb.texi b/docs/system/usb.texi new file mode 100644 index 0000000000..840adac978 --- /dev/null +++ b/docs/system/usb.texi @@ -0,0 +1,115 @@ +@node pcsys_usb +@section USB emulation + +QEMU can emulate a PCI UHCI, OHCI, EHCI or XHCI USB controller. You can +plug virtual USB devices or real host USB devices (only works with certain +host operating systems). QEMU will automatically create and connect virtual +USB hubs as necessary to connect multiple USB devices. + +@menu +* usb_devices:: +* host_usb_devices:: +@end menu +@node usb_devices +@subsection Connecting USB devices + +USB devices can be connected with the @option{-device usb-...} command line +option or the @code{device_add} monitor command. Available devices are: + +@table @code +@item usb-mouse +Virtual Mouse. This will override the PS/2 mouse emulation when activated. +@item usb-tablet +Pointer device that uses absolute coordinates (like a touchscreen). +This means QEMU is able to report the mouse position without having +to grab the mouse. Also overrides the PS/2 mouse emulation when activated. +@item usb-storage,drive=@var{drive_id} +Mass storage device backed by @var{drive_id} (@pxref{disk_images}) +@item usb-uas +USB attached SCSI device, see +@url{https://git.qemu.org/?p=qemu.git;a=blob_plain;f=docs/usb-storage.txt,usb-storage.txt} +for details +@item usb-bot +Bulk-only transport storage device, see +@url{https://git.qemu.org/?p=qemu.git;a=blob_plain;f=docs/usb-storage.txt,usb-storage.txt} +for details here, too +@item usb-mtp,rootdir=@var{dir} +Media transfer protocol device, using @var{dir} as root of the file tree +that is presented to the guest. +@item usb-host,hostbus=@var{bus},hostaddr=@var{addr} +Pass through the host device identified by @var{bus} and @var{addr} +@item usb-host,vendorid=@var{vendor},productid=@var{product} +Pass through the host device identified by @var{vendor} and @var{product} ID +@item usb-wacom-tablet +Virtual Wacom PenPartner tablet. This device is similar to the @code{tablet} +above but it can be used with the tslib library because in addition to touch +coordinates it reports touch pressure. +@item usb-kbd +Standard USB keyboard. Will override the PS/2 keyboard (if present). +@item usb-serial,chardev=@var{id} +Serial converter. This emulates an FTDI FT232BM chip connected to host character +device @var{id}. +@item usb-braille,chardev=@var{id} +Braille device. This will use BrlAPI to display the braille output on a real +or fake device referenced by @var{id}. +@item usb-net[,netdev=@var{id}] +Network adapter that supports CDC ethernet and RNDIS protocols. @var{id} +specifies a netdev defined with @code{-netdev @dots{},id=@var{id}}. +For instance, user-mode networking can be used with +@example +@value{qemu_system} [...] -netdev user,id=net0 -device usb-net,netdev=net0 +@end example +@item usb-ccid +Smartcard reader device +@item usb-audio +USB audio device +@end table + +@node host_usb_devices +@subsection Using host USB devices on a Linux host + +WARNING: this is an experimental feature. QEMU will slow down when +using it. USB devices requiring real time streaming (i.e. USB Video +Cameras) are not supported yet. + +@enumerate +@item If you use an early Linux 2.4 kernel, verify that no Linux driver +is actually using the USB device. A simple way to do that is simply to +disable the corresponding kernel module by renaming it from @file{mydriver.o} +to @file{mydriver.o.disabled}. + +@item Verify that @file{/proc/bus/usb} is working (most Linux distributions should enable it by default). You should see something like that: +@example +ls /proc/bus/usb +001 devices drivers +@end example + +@item Since only root can access to the USB devices directly, you can either launch QEMU as root or change the permissions of the USB devices you want to use. For testing, the following suffices: +@example +chown -R myuid /proc/bus/usb +@end example + +@item Launch QEMU and do in the monitor: +@example +info usbhost + Device 1.2, speed 480 Mb/s + Class 00: USB device 1234:5678, USB DISK +@end example +You should see the list of the devices you can use (Never try to use +hubs, it won't work). + +@item Add the device in QEMU by using: +@example +device_add usb-host,vendorid=0x1234,productid=0x5678 +@end example + +Normally the guest OS should report that a new USB device is plugged. +You can use the option @option{-device usb-host,...} to do the same. + +@item Now you can try to use the host USB device in QEMU. + +@end enumerate + +When relaunching QEMU, you may have to unplug and plug again the USB +device to make it work again (this is a bug). + diff --git a/docs/system/vnc-security.texi b/docs/system/vnc-security.texi new file mode 100644 index 0000000000..abf7f7fa43 --- /dev/null +++ b/docs/system/vnc-security.texi @@ -0,0 +1,196 @@ +@node vnc_security +@section VNC security + +The VNC server capability provides access to the graphical console +of the guest VM across the network. This has a number of security +considerations depending on the deployment scenarios. + +@menu +* vnc_sec_none:: +* vnc_sec_password:: +* vnc_sec_certificate:: +* vnc_sec_certificate_verify:: +* vnc_sec_certificate_pw:: +* vnc_sec_sasl:: +* vnc_sec_certificate_sasl:: +* vnc_setup_sasl:: +@end menu +@node vnc_sec_none +@subsection Without passwords + +The simplest VNC server setup does not include any form of authentication. +For this setup it is recommended to restrict it to listen on a UNIX domain +socket only. For example + +@example +@value{qemu_system} [...OPTIONS...] -vnc unix:/home/joebloggs/.qemu-myvm-vnc +@end example + +This ensures that only users on local box with read/write access to that +path can access the VNC server. To securely access the VNC server from a +remote machine, a combination of netcat+ssh can be used to provide a secure +tunnel. + +@node vnc_sec_password +@subsection With passwords + +The VNC protocol has limited support for password based authentication. Since +the protocol limits passwords to 8 characters it should not be considered +to provide high security. The password can be fairly easily brute-forced by +a client making repeat connections. For this reason, a VNC server using password +authentication should be restricted to only listen on the loopback interface +or UNIX domain sockets. Password authentication is not supported when operating +in FIPS 140-2 compliance mode as it requires the use of the DES cipher. Password +authentication is requested with the @code{password} option, and then once QEMU +is running the password is set with the monitor. Until the monitor is used to +set the password all clients will be rejected. + +@example +@value{qemu_system} [...OPTIONS...] -vnc :1,password -monitor stdio +(qemu) change vnc password +Password: ******** +(qemu) +@end example + +@node vnc_sec_certificate +@subsection With x509 certificates + +The QEMU VNC server also implements the VeNCrypt extension allowing use of +TLS for encryption of the session, and x509 certificates for authentication. +The use of x509 certificates is strongly recommended, because TLS on its +own is susceptible to man-in-the-middle attacks. Basic x509 certificate +support provides a secure session, but no authentication. This allows any +client to connect, and provides an encrypted session. + +@example +@value{qemu_system} [...OPTIONS...] \ + -object tls-creds-x509,id=tls0,dir=/etc/pki/qemu,endpoint=server,verify-peer=no \ + -vnc :1,tls-creds=tls0 -monitor stdio +@end example + +In the above example @code{/etc/pki/qemu} should contain at least three files, +@code{ca-cert.pem}, @code{server-cert.pem} and @code{server-key.pem}. Unprivileged +users will want to use a private directory, for example @code{$HOME/.pki/qemu}. +NB the @code{server-key.pem} file should be protected with file mode 0600 to +only be readable by the user owning it. + +@node vnc_sec_certificate_verify +@subsection With x509 certificates and client verification + +Certificates can also provide a means to authenticate the client connecting. +The server will request that the client provide a certificate, which it will +then validate against the CA certificate. This is a good choice if deploying +in an environment with a private internal certificate authority. It uses the +same syntax as previously, but with @code{verify-peer} set to @code{yes} +instead. + +@example +@value{qemu_system} [...OPTIONS...] \ + -object tls-creds-x509,id=tls0,dir=/etc/pki/qemu,endpoint=server,verify-peer=yes \ + -vnc :1,tls-creds=tls0 -monitor stdio +@end example + + +@node vnc_sec_certificate_pw +@subsection With x509 certificates, client verification and passwords + +Finally, the previous method can be combined with VNC password authentication +to provide two layers of authentication for clients. + +@example +@value{qemu_system} [...OPTIONS...] \ + -object tls-creds-x509,id=tls0,dir=/etc/pki/qemu,endpoint=server,verify-peer=yes \ + -vnc :1,tls-creds=tls0,password -monitor stdio +(qemu) change vnc password +Password: ******** +(qemu) +@end example + + +@node vnc_sec_sasl +@subsection With SASL authentication + +The SASL authentication method is a VNC extension, that provides an +easily extendable, pluggable authentication method. This allows for +integration with a wide range of authentication mechanisms, such as +PAM, GSSAPI/Kerberos, LDAP, SQL databases, one-time keys and more. +The strength of the authentication depends on the exact mechanism +configured. If the chosen mechanism also provides a SSF layer, then +it will encrypt the datastream as well. + +Refer to the later docs on how to choose the exact SASL mechanism +used for authentication, but assuming use of one supporting SSF, +then QEMU can be launched with: + +@example +@value{qemu_system} [...OPTIONS...] -vnc :1,sasl -monitor stdio +@end example + +@node vnc_sec_certificate_sasl +@subsection With x509 certificates and SASL authentication + +If the desired SASL authentication mechanism does not supported +SSF layers, then it is strongly advised to run it in combination +with TLS and x509 certificates. This provides securely encrypted +data stream, avoiding risk of compromising of the security +credentials. This can be enabled, by combining the 'sasl' option +with the aforementioned TLS + x509 options: + +@example +@value{qemu_system} [...OPTIONS...] \ + -object tls-creds-x509,id=tls0,dir=/etc/pki/qemu,endpoint=server,verify-peer=yes \ + -vnc :1,tls-creds=tls0,sasl -monitor stdio +@end example + +@node vnc_setup_sasl + +@subsection Configuring SASL mechanisms + +The following documentation assumes use of the Cyrus SASL implementation on a +Linux host, but the principles should apply to any other SASL implementation +or host. When SASL is enabled, the mechanism configuration will be loaded from +system default SASL service config /etc/sasl2/qemu.conf. If running QEMU as an +unprivileged user, an environment variable SASL_CONF_PATH can be used to make +it search alternate locations for the service config file. + +If the TLS option is enabled for VNC, then it will provide session encryption, +otherwise the SASL mechanism will have to provide encryption. In the latter +case the list of possible plugins that can be used is drastically reduced. In +fact only the GSSAPI SASL mechanism provides an acceptable level of security +by modern standards. Previous versions of QEMU referred to the DIGEST-MD5 +mechanism, however, it has multiple serious flaws described in detail in +RFC 6331 and thus should never be used any more. The SCRAM-SHA-1 mechanism +provides a simple username/password auth facility similar to DIGEST-MD5, but +does not support session encryption, so can only be used in combination with +TLS. + +When not using TLS the recommended configuration is + +@example +mech_list: gssapi +keytab: /etc/qemu/krb5.tab +@end example + +This says to use the 'GSSAPI' mechanism with the Kerberos v5 protocol, with +the server principal stored in /etc/qemu/krb5.tab. For this to work the +administrator of your KDC must generate a Kerberos principal for the server, +with a name of 'qemu/somehost.example.com@@EXAMPLE.COM' replacing +'somehost.example.com' with the fully qualified host name of the machine +running QEMU, and 'EXAMPLE.COM' with the Kerberos Realm. + +When using TLS, if username+password authentication is desired, then a +reasonable configuration is + +@example +mech_list: scram-sha-1 +sasldb_path: /etc/qemu/passwd.db +@end example + +The @code{saslpasswd2} program can be used to populate the @code{passwd.db} +file with accounts. + +Other SASL configurations will be left as an exercise for the reader. Note that +all mechanisms, except GSSAPI, should be combined with use of TLS to ensure a +secure data channel. + + diff --git a/qemu-doc.texi b/qemu-doc.texi index 617a701b67..33d24caf94 100644 --- a/qemu-doc.texi +++ b/qemu-doc.texi @@ -142,9 +142,9 @@ accelerator is required to use more than one host CPU for emulation. * cpu_models_x86:: Supported CPU model configurations on x86 hosts * disk_images:: Disk Images * pcsys_network:: Network emulation -* pcsys_other_devs:: Other Devices -* direct_linux_boot:: Direct Linux Boot * pcsys_usb:: USB emulation +* pcsys_ivshmem:: Inter-VM Shared Memory device +* direct_linux_boot:: Direct Linux Boot * vnc_security:: VNC security * network_tls:: TLS setup for network services * gdb_usage:: GDB usage @@ -222,1384 +222,20 @@ CS4231A is the chip used in Windows Sound System and GUSMAX products @c man end -@node pcsys_quickstart -@section Quick Start -@cindex quick start - -Download and uncompress a hard disk image with Linux installed (e.g. -@file{linux.img}) and type: - -@example -@value{qemu_system} linux.img -@end example - -Linux should boot and give you a prompt. - -@node sec_invocation -@section Invocation - -@example -@c man begin SYNOPSIS -@command{@value{qemu_system}} [@var{options}] [@var{disk_image}] -@c man end -@end example - -@c man begin OPTIONS -@var{disk_image} is a raw hard disk image for IDE hard disk 0. Some -targets do not need a disk image. - -@include qemu-options.texi - -@c man end - -@subsection Device URL Syntax -@c TODO merge this with section Disk Images - -@c man begin NOTES - -In addition to using normal file images for the emulated storage devices, -QEMU can also use networked resources such as iSCSI devices. These are -specified using a special URL syntax. - -@table @option -@item iSCSI -iSCSI support allows QEMU to access iSCSI resources directly and use as -images for the guest storage. Both disk and cdrom images are supported. - -Syntax for specifying iSCSI LUNs is -``iscsi://[:]//'' - -By default qemu will use the iSCSI initiator-name -'iqn.2008-11.org.linux-kvm[:]' but this can also be set from the command -line or a configuration file. - -Since version Qemu 2.4 it is possible to specify a iSCSI request timeout to detect -stalled requests and force a reestablishment of the session. The timeout -is specified in seconds. The default is 0 which means no timeout. Libiscsi -1.15.0 or greater is required for this feature. - -Example (without authentication): -@example -@value{qemu_system} -iscsi initiator-name=iqn.2001-04.com.example:my-initiator \ - -cdrom iscsi://192.0.2.1/iqn.2001-04.com.example/2 \ - -drive file=iscsi://192.0.2.1/iqn.2001-04.com.example/1 -@end example - -Example (CHAP username/password via URL): -@example -@value{qemu_system} -drive file=iscsi://user%password@@192.0.2.1/iqn.2001-04.com.example/1 -@end example - -Example (CHAP username/password via environment variables): -@example -LIBISCSI_CHAP_USERNAME="user" \ -LIBISCSI_CHAP_PASSWORD="password" \ -@value{qemu_system} -drive file=iscsi://192.0.2.1/iqn.2001-04.com.example/1 -@end example - -@item NBD -QEMU supports NBD (Network Block Devices) both using TCP protocol as well -as Unix Domain Sockets. With TCP, the default port is 10809. - -Syntax for specifying a NBD device using TCP, in preferred URI form: -``nbd://[:]/[]'' - -Syntax for specifying a NBD device using Unix Domain Sockets; remember -that '?' is a shell glob character and may need quoting: -``nbd+unix:///[]?socket='' - -Older syntax that is also recognized: -``nbd::[:exportname=]'' - -Syntax for specifying a NBD device using Unix Domain Sockets -``nbd:unix:[:exportname=]'' - -Example for TCP -@example -@value{qemu_system} --drive file=nbd:192.0.2.1:30000 -@end example - -Example for Unix Domain Sockets -@example -@value{qemu_system} --drive file=nbd:unix:/tmp/nbd-socket -@end example - -@item SSH -QEMU supports SSH (Secure Shell) access to remote disks. - -Examples: -@example -@value{qemu_system} -drive file=ssh://user@@host/path/to/disk.img -@value{qemu_system} -drive file.driver=ssh,file.user=user,file.host=host,file.port=22,file.path=/path/to/disk.img -@end example - -Currently authentication must be done using ssh-agent. Other -authentication methods may be supported in future. - -@item Sheepdog -Sheepdog is a distributed storage system for QEMU. -QEMU supports using either local sheepdog devices or remote networked -devices. - -Syntax for specifying a sheepdog device -@example -sheepdog[+tcp|+unix]://[host:port]/vdiname[?socket=path][#snapid|#tag] -@end example - -Example -@example -@value{qemu_system} --drive file=sheepdog://192.0.2.1:30000/MyVirtualMachine -@end example - -See also @url{https://sheepdog.github.io/sheepdog/}. - -@item GlusterFS -GlusterFS is a user space distributed file system. -QEMU supports the use of GlusterFS volumes for hosting VM disk images using -TCP, Unix Domain Sockets and RDMA transport protocols. - -Syntax for specifying a VM disk image on GlusterFS volume is -@example - -URI: -gluster[+type]://[host[:port]]/volume/path[?socket=...][,debug=N][,logfile=...] - -JSON: -'json:@{"driver":"qcow2","file":@{"driver":"gluster","volume":"testvol","path":"a.img","debug":N,"logfile":"...", -@ "server":[@{"type":"tcp","host":"...","port":"..."@}, -@ @{"type":"unix","socket":"..."@}]@}@}' -@end example - - -Example -@example -URI: -@value{qemu_system} --drive file=gluster://192.0.2.1/testvol/a.img, -@ file.debug=9,file.logfile=/var/log/qemu-gluster.log - -JSON: -@value{qemu_system} 'json:@{"driver":"qcow2", -@ "file":@{"driver":"gluster", -@ "volume":"testvol","path":"a.img", -@ "debug":9,"logfile":"/var/log/qemu-gluster.log", -@ "server":[@{"type":"tcp","host":"1.2.3.4","port":24007@}, -@ @{"type":"unix","socket":"/var/run/glusterd.socket"@}]@}@}' -@value{qemu_system} -drive driver=qcow2,file.driver=gluster,file.volume=testvol,file.path=/path/a.img, -@ file.debug=9,file.logfile=/var/log/qemu-gluster.log, -@ file.server.0.type=tcp,file.server.0.host=1.2.3.4,file.server.0.port=24007, -@ file.server.1.type=unix,file.server.1.socket=/var/run/glusterd.socket -@end example - -See also @url{http://www.gluster.org}. - -@item HTTP/HTTPS/FTP/FTPS -QEMU supports read-only access to files accessed over http(s) and ftp(s). - -Syntax using a single filename: -@example -://[[:]@@]/ -@end example - -where: -@table @option -@item protocol -'http', 'https', 'ftp', or 'ftps'. - -@item username -Optional username for authentication to the remote server. - -@item password -Optional password for authentication to the remote server. - -@item host -Address of the remote server. - -@item path -Path on the remote server, including any query string. -@end table - -The following options are also supported: -@table @option -@item url -The full URL when passing options to the driver explicitly. - -@item readahead -The amount of data to read ahead with each range request to the remote server. -This value may optionally have the suffix 'T', 'G', 'M', 'K', 'k' or 'b'. If it -does not have a suffix, it will be assumed to be in bytes. The value must be a -multiple of 512 bytes. It defaults to 256k. - -@item sslverify -Whether to verify the remote server's certificate when connecting over SSL. It -can have the value 'on' or 'off'. It defaults to 'on'. - -@item cookie -Send this cookie (it can also be a list of cookies separated by ';') with -each outgoing request. Only supported when using protocols such as HTTP -which support cookies, otherwise ignored. - -@item timeout -Set the timeout in seconds of the CURL connection. This timeout is the time -that CURL waits for a response from the remote server to get the size of the -image to be downloaded. If not set, the default timeout of 5 seconds is used. -@end table - -Note that when passing options to qemu explicitly, @option{driver} is the value -of . - -Example: boot from a remote Fedora 20 live ISO image -@example -@value{qemu_system_x86} --drive media=cdrom,file=https://archives.fedoraproject.org/pub/archive/fedora/linux/releases/20/Live/x86_64/Fedora-Live-Desktop-x86_64-20-1.iso,readonly - -@value{qemu_system_x86} --drive media=cdrom,file.driver=http,file.url=http://archives.fedoraproject.org/pub/fedora/linux/releases/20/Live/x86_64/Fedora-Live-Desktop-x86_64-20-1.iso,readonly -@end example - -Example: boot from a remote Fedora 20 cloud image using a local overlay for -writes, copy-on-read, and a readahead of 64k -@example -qemu-img create -f qcow2 -o backing_file='json:@{"file.driver":"http",, "file.url":"http://archives.fedoraproject.org/pub/archive/fedora/linux/releases/20/Images/x86_64/Fedora-x86_64-20-20131211.1-sda.qcow2",, "file.readahead":"64k"@}' /tmp/Fedora-x86_64-20-20131211.1-sda.qcow2 - -@value{qemu_system_x86} -drive file=/tmp/Fedora-x86_64-20-20131211.1-sda.qcow2,copy-on-read=on -@end example - -Example: boot from an image stored on a VMware vSphere server with a self-signed -certificate using a local overlay for writes, a readahead of 64k and a timeout -of 10 seconds. -@example -qemu-img create -f qcow2 -o backing_file='json:@{"file.driver":"https",, "file.url":"https://user:password@@vsphere.example.com/folder/test/test-flat.vmdk?dcPath=Datacenter&dsName=datastore1",, "file.sslverify":"off",, "file.readahead":"64k",, "file.timeout":10@}' /tmp/test.qcow2 - -@value{qemu_system_x86} -drive file=/tmp/test.qcow2 -@end example - -@end table - -@c man end - -@node pcsys_keys -@section Keys in the graphical frontends - -@c man begin OPTIONS - -During the graphical emulation, you can use special key combinations to change -modes. The default key mappings are shown below, but if you use @code{-alt-grab} -then the modifier is Ctrl-Alt-Shift (instead of Ctrl-Alt) and if you use -@code{-ctrl-grab} then the modifier is the right Ctrl key (instead of Ctrl-Alt): - -@table @key -@item Ctrl-Alt-f -@kindex Ctrl-Alt-f -Toggle full screen - -@item Ctrl-Alt-+ -@kindex Ctrl-Alt-+ -Enlarge the screen - -@item Ctrl-Alt-- -@kindex Ctrl-Alt-- -Shrink the screen - -@item Ctrl-Alt-u -@kindex Ctrl-Alt-u -Restore the screen's un-scaled dimensions - -@item Ctrl-Alt-n -@kindex Ctrl-Alt-n -Switch to virtual console 'n'. Standard console mappings are: -@table @emph -@item 1 -Target system display -@item 2 -Monitor -@item 3 -Serial port -@end table - -@item Ctrl-Alt -@kindex Ctrl-Alt -Toggle mouse and keyboard grab. -@end table - -@kindex Ctrl-Up -@kindex Ctrl-Down -@kindex Ctrl-PageUp -@kindex Ctrl-PageDown -In the virtual consoles, you can use @key{Ctrl-Up}, @key{Ctrl-Down}, -@key{Ctrl-PageUp} and @key{Ctrl-PageDown} to move in the back log. - -@c man end - -@node mux_keys -@section Keys in the character backend multiplexer - -@c man begin OPTIONS - -During emulation, if you are using a character backend multiplexer -(which is the default if you are using @option{-nographic}) then -several commands are available via an escape sequence. These -key sequences all start with an escape character, which is @key{Ctrl-a} -by default, but can be changed with @option{-echr}. The list below assumes -you're using the default. - -@table @key -@item Ctrl-a h -@kindex Ctrl-a h -Print this help -@item Ctrl-a x -@kindex Ctrl-a x -Exit emulator -@item Ctrl-a s -@kindex Ctrl-a s -Save disk data back to file (if -snapshot) -@item Ctrl-a t -@kindex Ctrl-a t -Toggle console timestamps -@item Ctrl-a b -@kindex Ctrl-a b -Send break (magic sysrq in Linux) -@item Ctrl-a c -@kindex Ctrl-a c -Rotate between the frontends connected to the multiplexer (usually -this switches between the monitor and the console) -@item Ctrl-a Ctrl-a -@kindex Ctrl-a Ctrl-a -Send the escape character to the frontend -@end table -@c man end - -@ignore - -@c man begin SEEALSO -The HTML documentation of QEMU for more precise information and Linux -user mode emulator invocation. -@c man end - -@c man begin AUTHOR -Fabrice Bellard -@c man end - -@end ignore - -@node pcsys_monitor -@section QEMU Monitor -@cindex QEMU monitor - -The QEMU monitor is used to give complex commands to the QEMU -emulator. You can use it to: - -@itemize @minus - -@item -Remove or insert removable media images -(such as CD-ROM or floppies). - -@item -Freeze/unfreeze the Virtual Machine (VM) and save or restore its state -from a disk file. - -@item Inspect the VM state without an external debugger. - -@end itemize - -@subsection Commands - -The following commands are available: - -@include qemu-monitor.texi - -@include qemu-monitor-info.texi - -@subsection Integer expressions - -The monitor understands integers expressions for every integer -argument. You can use register names to get the value of specifics -CPU registers by prefixing them with @emph{$}. - +@include docs/system/quickstart.texi +@include docs/system/invocation.texi +@include docs/system/keys.texi +@include docs/system/mux-chardev.texi +@include docs/system/monitor.texi @include docs/system/cpu-models-x86.texi - -@node disk_images -@section Disk Images - -QEMU supports many disk image formats, including growable disk images -(their size increase as non empty sectors are written), compressed and -encrypted disk images. - -@menu -* disk_images_quickstart:: Quick start for disk image creation -* disk_images_snapshot_mode:: Snapshot mode -* vm_snapshots:: VM snapshots -@end menu - -@node disk_images_quickstart -@subsection Quick start for disk image creation - -You can create a disk image with the command: -@example -qemu-img create myimage.img mysize -@end example -where @var{myimage.img} is the disk image filename and @var{mysize} is its -size in kilobytes. You can add an @code{M} suffix to give the size in -megabytes and a @code{G} suffix for gigabytes. - -@c When this document is converted to rst we should make this into -@c a proper linked reference to the qemu-img documentation again: -See the qemu-img invocation documentation for more information. - -@node disk_images_snapshot_mode -@subsection Snapshot mode - -If you use the option @option{-snapshot}, all disk images are -considered as read only. When sectors in written, they are written in -a temporary file created in @file{/tmp}. You can however force the -write back to the raw disk images by using the @code{commit} monitor -command (or @key{C-a s} in the serial console). - -@node vm_snapshots -@subsection VM snapshots - -VM snapshots are snapshots of the complete virtual machine including -CPU state, RAM, device state and the content of all the writable -disks. In order to use VM snapshots, you must have at least one non -removable and writable block device using the @code{qcow2} disk image -format. Normally this device is the first virtual hard drive. - -Use the monitor command @code{savevm} to create a new VM snapshot or -replace an existing one. A human readable name can be assigned to each -snapshot in addition to its numerical ID. - -Use @code{loadvm} to restore a VM snapshot and @code{delvm} to remove -a VM snapshot. @code{info snapshots} lists the available snapshots -with their associated information: - -@example -(qemu) info snapshots -Snapshot devices: hda -Snapshot list (from hda): -ID TAG VM SIZE DATE VM CLOCK -1 start 41M 2006-08-06 12:38:02 00:00:14.954 -2 40M 2006-08-06 12:43:29 00:00:18.633 -3 msys 40M 2006-08-06 12:44:04 00:00:23.514 -@end example - -A VM snapshot is made of a VM state info (its size is shown in -@code{info snapshots}) and a snapshot of every writable disk image. -The VM state info is stored in the first @code{qcow2} non removable -and writable block device. The disk image snapshots are stored in -every disk image. The size of a snapshot in a disk image is difficult -to evaluate and is not shown by @code{info snapshots} because the -associated disk sectors are shared among all the snapshots to save -disk space (otherwise each snapshot would need a full copy of all the -disk images). - -When using the (unrelated) @code{-snapshot} option -(@ref{disk_images_snapshot_mode}), you can always make VM snapshots, -but they are deleted as soon as you exit QEMU. - -VM snapshots currently have the following known limitations: -@itemize -@item -They cannot cope with removable devices if they are removed or -inserted after a snapshot is done. -@item -A few device drivers still have incomplete snapshot support so their -state is not saved or restored properly (in particular USB). -@end itemize - -@node pcsys_network -@section Network emulation - -QEMU can simulate several network cards (e.g. PCI or ISA cards on the PC -target) and can connect them to a network backend on the host or an emulated -hub. The various host network backends can either be used to connect the NIC of -the guest to a real network (e.g. by using a TAP devices or the non-privileged -user mode network stack), or to other guest instances running in another QEMU -process (e.g. by using the socket host network backend). - -@subsection Using TAP network interfaces - -This is the standard way to connect QEMU to a real network. QEMU adds -a virtual network device on your host (called @code{tapN}), and you -can then configure it as if it was a real ethernet card. - -@subsubsection Linux host - -As an example, you can download the @file{linux-test-xxx.tar.gz} -archive and copy the script @file{qemu-ifup} in @file{/etc} and -configure properly @code{sudo} so that the command @code{ifconfig} -contained in @file{qemu-ifup} can be executed as root. You must verify -that your host kernel supports the TAP network interfaces: the -device @file{/dev/net/tun} must be present. - -See @ref{sec_invocation} to have examples of command lines using the -TAP network interfaces. - -@subsubsection Windows host - -There is a virtual ethernet driver for Windows 2000/XP systems, called -TAP-Win32. But it is not included in standard QEMU for Windows, -so you will need to get it separately. It is part of OpenVPN package, -so download OpenVPN from : @url{https://openvpn.net/}. - -@subsection Using the user mode network stack - -By using the option @option{-net user} (default configuration if no -@option{-net} option is specified), QEMU uses a completely user mode -network stack (you don't need root privilege to use the virtual -network). The virtual network configuration is the following: - -@example - - guest (10.0.2.15) <------> Firewall/DHCP server <-----> Internet - | (10.0.2.2) - | - ----> DNS server (10.0.2.3) - | - ----> SMB server (10.0.2.4) -@end example - -The QEMU VM behaves as if it was behind a firewall which blocks all -incoming connections. You can use a DHCP client to automatically -configure the network in the QEMU VM. The DHCP server assign addresses -to the hosts starting from 10.0.2.15. - -In order to check that the user mode network is working, you can ping -the address 10.0.2.2 and verify that you got an address in the range -10.0.2.x from the QEMU virtual DHCP server. - -Note that ICMP traffic in general does not work with user mode networking. -@code{ping}, aka. ICMP echo, to the local router (10.0.2.2) shall work, -however. If you're using QEMU on Linux >= 3.0, it can use unprivileged ICMP -ping sockets to allow @code{ping} to the Internet. The host admin has to set -the ping_group_range in order to grant access to those sockets. To allow ping -for GID 100 (usually users group): - -@example -echo 100 100 > /proc/sys/net/ipv4/ping_group_range -@end example - -When using the built-in TFTP server, the router is also the TFTP -server. - -When using the @option{'-netdev user,hostfwd=...'} option, TCP or UDP -connections can be redirected from the host to the guest. It allows for -example to redirect X11, telnet or SSH connections. - -@subsection Hubs - -QEMU can simulate several hubs. A hub can be thought of as a virtual connection -between several network devices. These devices can be for example QEMU virtual -ethernet cards or virtual Host ethernet devices (TAP devices). You can connect -guest NICs or host network backends to such a hub using the @option{-netdev -hubport} or @option{-nic hubport} options. The legacy @option{-net} option -also connects the given device to the emulated hub with ID 0 (i.e. the default -hub) unless you specify a netdev with @option{-net nic,netdev=xxx} here. - -@subsection Connecting emulated networks between QEMU instances - -Using the @option{-netdev socket} (or @option{-nic socket} or -@option{-net socket}) option, it is possible to create emulated -networks that span several QEMU instances. -See the description of the @option{-netdev socket} option in the -@ref{sec_invocation,,Invocation chapter} to have a basic example. - -@node pcsys_other_devs -@section Other Devices - -@subsection Inter-VM Shared Memory device - -On Linux hosts, a shared memory device is available. The basic syntax -is: - -@example -@value{qemu_system_x86} -device ivshmem-plain,memdev=@var{hostmem} -@end example - -where @var{hostmem} names a host memory backend. For a POSIX shared -memory backend, use something like - -@example --object memory-backend-file,size=1M,share,mem-path=/dev/shm/ivshmem,id=@var{hostmem} -@end example - -If desired, interrupts can be sent between guest VMs accessing the same shared -memory region. Interrupt support requires using a shared memory server and -using a chardev socket to connect to it. The code for the shared memory server -is qemu.git/contrib/ivshmem-server. An example syntax when using the shared -memory server is: - -@example -# First start the ivshmem server once and for all -ivshmem-server -p @var{pidfile} -S @var{path} -m @var{shm-name} -l @var{shm-size} -n @var{vectors} - -# Then start your qemu instances with matching arguments -@value{qemu_system_x86} -device ivshmem-doorbell,vectors=@var{vectors},chardev=@var{id} - -chardev socket,path=@var{path},id=@var{id} -@end example - -When using the server, the guest will be assigned a VM ID (>=0) that allows guests -using the same server to communicate via interrupts. Guests can read their -VM ID from a device register (see ivshmem-spec.txt). - -@subsubsection Migration with ivshmem - -With device property @option{master=on}, the guest will copy the shared -memory on migration to the destination host. With @option{master=off}, -the guest will not be able to migrate with the device attached. In the -latter case, the device should be detached and then reattached after -migration using the PCI hotplug support. - -At most one of the devices sharing the same memory can be master. The -master must complete migration before you plug back the other devices. - -@subsubsection ivshmem and hugepages - -Instead of specifying the using POSIX shm, you may specify -a memory backend that has hugepage support: - -@example -@value{qemu_system_x86} -object memory-backend-file,size=1G,mem-path=/dev/hugepages/my-shmem-file,share,id=mb1 - -device ivshmem-plain,memdev=mb1 -@end example - -ivshmem-server also supports hugepages mount points with the -@option{-m} memory path argument. - -@node direct_linux_boot -@section Direct Linux Boot - -This section explains how to launch a Linux kernel inside QEMU without -having to make a full bootable image. It is very useful for fast Linux -kernel testing. - -The syntax is: -@example -@value{qemu_system} -kernel bzImage -hda rootdisk.img -append "root=/dev/hda" -@end example - -Use @option{-kernel} to provide the Linux kernel image and -@option{-append} to give the kernel command line arguments. The -@option{-initrd} option can be used to provide an INITRD image. - -If you do not need graphical output, you can disable it and redirect -the virtual serial port and the QEMU monitor to the console with the -@option{-nographic} option. The typical command line is: -@example -@value{qemu_system} -kernel bzImage -hda rootdisk.img \ - -append "root=/dev/hda console=ttyS0" -nographic -@end example - -Use @key{Ctrl-a c} to switch between the serial console and the -monitor (@pxref{pcsys_keys}). - -@node pcsys_usb -@section USB emulation - -QEMU can emulate a PCI UHCI, OHCI, EHCI or XHCI USB controller. You can -plug virtual USB devices or real host USB devices (only works with certain -host operating systems). QEMU will automatically create and connect virtual -USB hubs as necessary to connect multiple USB devices. - -@menu -* usb_devices:: -* host_usb_devices:: -@end menu -@node usb_devices -@subsection Connecting USB devices - -USB devices can be connected with the @option{-device usb-...} command line -option or the @code{device_add} monitor command. Available devices are: - -@table @code -@item usb-mouse -Virtual Mouse. This will override the PS/2 mouse emulation when activated. -@item usb-tablet -Pointer device that uses absolute coordinates (like a touchscreen). -This means QEMU is able to report the mouse position without having -to grab the mouse. Also overrides the PS/2 mouse emulation when activated. -@item usb-storage,drive=@var{drive_id} -Mass storage device backed by @var{drive_id} (@pxref{disk_images}) -@item usb-uas -USB attached SCSI device, see -@url{https://git.qemu.org/?p=qemu.git;a=blob_plain;f=docs/usb-storage.txt,usb-storage.txt} -for details -@item usb-bot -Bulk-only transport storage device, see -@url{https://git.qemu.org/?p=qemu.git;a=blob_plain;f=docs/usb-storage.txt,usb-storage.txt} -for details here, too -@item usb-mtp,rootdir=@var{dir} -Media transfer protocol device, using @var{dir} as root of the file tree -that is presented to the guest. -@item usb-host,hostbus=@var{bus},hostaddr=@var{addr} -Pass through the host device identified by @var{bus} and @var{addr} -@item usb-host,vendorid=@var{vendor},productid=@var{product} -Pass through the host device identified by @var{vendor} and @var{product} ID -@item usb-wacom-tablet -Virtual Wacom PenPartner tablet. This device is similar to the @code{tablet} -above but it can be used with the tslib library because in addition to touch -coordinates it reports touch pressure. -@item usb-kbd -Standard USB keyboard. Will override the PS/2 keyboard (if present). -@item usb-serial,chardev=@var{id} -Serial converter. This emulates an FTDI FT232BM chip connected to host character -device @var{id}. -@item usb-braille,chardev=@var{id} -Braille device. This will use BrlAPI to display the braille output on a real -or fake device referenced by @var{id}. -@item usb-net[,netdev=@var{id}] -Network adapter that supports CDC ethernet and RNDIS protocols. @var{id} -specifies a netdev defined with @code{-netdev @dots{},id=@var{id}}. -For instance, user-mode networking can be used with -@example -@value{qemu_system} [...] -netdev user,id=net0 -device usb-net,netdev=net0 -@end example -@item usb-ccid -Smartcard reader device -@item usb-audio -USB audio device -@end table - -@node host_usb_devices -@subsection Using host USB devices on a Linux host - -WARNING: this is an experimental feature. QEMU will slow down when -using it. USB devices requiring real time streaming (i.e. USB Video -Cameras) are not supported yet. - -@enumerate -@item If you use an early Linux 2.4 kernel, verify that no Linux driver -is actually using the USB device. A simple way to do that is simply to -disable the corresponding kernel module by renaming it from @file{mydriver.o} -to @file{mydriver.o.disabled}. - -@item Verify that @file{/proc/bus/usb} is working (most Linux distributions should enable it by default). You should see something like that: -@example -ls /proc/bus/usb -001 devices drivers -@end example - -@item Since only root can access to the USB devices directly, you can either launch QEMU as root or change the permissions of the USB devices you want to use. For testing, the following suffices: -@example -chown -R myuid /proc/bus/usb -@end example - -@item Launch QEMU and do in the monitor: -@example -info usbhost - Device 1.2, speed 480 Mb/s - Class 00: USB device 1234:5678, USB DISK -@end example -You should see the list of the devices you can use (Never try to use -hubs, it won't work). - -@item Add the device in QEMU by using: -@example -device_add usb-host,vendorid=0x1234,productid=0x5678 -@end example - -Normally the guest OS should report that a new USB device is plugged. -You can use the option @option{-device usb-host,...} to do the same. - -@item Now you can try to use the host USB device in QEMU. - -@end enumerate - -When relaunching QEMU, you may have to unplug and plug again the USB -device to make it work again (this is a bug). - -@node vnc_security -@section VNC security - -The VNC server capability provides access to the graphical console -of the guest VM across the network. This has a number of security -considerations depending on the deployment scenarios. - -@menu -* vnc_sec_none:: -* vnc_sec_password:: -* vnc_sec_certificate:: -* vnc_sec_certificate_verify:: -* vnc_sec_certificate_pw:: -* vnc_sec_sasl:: -* vnc_sec_certificate_sasl:: -* vnc_setup_sasl:: -@end menu -@node vnc_sec_none -@subsection Without passwords - -The simplest VNC server setup does not include any form of authentication. -For this setup it is recommended to restrict it to listen on a UNIX domain -socket only. For example - -@example -@value{qemu_system} [...OPTIONS...] -vnc unix:/home/joebloggs/.qemu-myvm-vnc -@end example - -This ensures that only users on local box with read/write access to that -path can access the VNC server. To securely access the VNC server from a -remote machine, a combination of netcat+ssh can be used to provide a secure -tunnel. - -@node vnc_sec_password -@subsection With passwords - -The VNC protocol has limited support for password based authentication. Since -the protocol limits passwords to 8 characters it should not be considered -to provide high security. The password can be fairly easily brute-forced by -a client making repeat connections. For this reason, a VNC server using password -authentication should be restricted to only listen on the loopback interface -or UNIX domain sockets. Password authentication is not supported when operating -in FIPS 140-2 compliance mode as it requires the use of the DES cipher. Password -authentication is requested with the @code{password} option, and then once QEMU -is running the password is set with the monitor. Until the monitor is used to -set the password all clients will be rejected. - -@example -@value{qemu_system} [...OPTIONS...] -vnc :1,password -monitor stdio -(qemu) change vnc password -Password: ******** -(qemu) -@end example - -@node vnc_sec_certificate -@subsection With x509 certificates - -The QEMU VNC server also implements the VeNCrypt extension allowing use of -TLS for encryption of the session, and x509 certificates for authentication. -The use of x509 certificates is strongly recommended, because TLS on its -own is susceptible to man-in-the-middle attacks. Basic x509 certificate -support provides a secure session, but no authentication. This allows any -client to connect, and provides an encrypted session. - -@example -@value{qemu_system} [...OPTIONS...] \ - -object tls-creds-x509,id=tls0,dir=/etc/pki/qemu,endpoint=server,verify-peer=no \ - -vnc :1,tls-creds=tls0 -monitor stdio -@end example - -In the above example @code{/etc/pki/qemu} should contain at least three files, -@code{ca-cert.pem}, @code{server-cert.pem} and @code{server-key.pem}. Unprivileged -users will want to use a private directory, for example @code{$HOME/.pki/qemu}. -NB the @code{server-key.pem} file should be protected with file mode 0600 to -only be readable by the user owning it. - -@node vnc_sec_certificate_verify -@subsection With x509 certificates and client verification - -Certificates can also provide a means to authenticate the client connecting. -The server will request that the client provide a certificate, which it will -then validate against the CA certificate. This is a good choice if deploying -in an environment with a private internal certificate authority. It uses the -same syntax as previously, but with @code{verify-peer} set to @code{yes} -instead. - -@example -@value{qemu_system} [...OPTIONS...] \ - -object tls-creds-x509,id=tls0,dir=/etc/pki/qemu,endpoint=server,verify-peer=yes \ - -vnc :1,tls-creds=tls0 -monitor stdio -@end example - - -@node vnc_sec_certificate_pw -@subsection With x509 certificates, client verification and passwords - -Finally, the previous method can be combined with VNC password authentication -to provide two layers of authentication for clients. - -@example -@value{qemu_system} [...OPTIONS...] \ - -object tls-creds-x509,id=tls0,dir=/etc/pki/qemu,endpoint=server,verify-peer=yes \ - -vnc :1,tls-creds=tls0,password -monitor stdio -(qemu) change vnc password -Password: ******** -(qemu) -@end example - - -@node vnc_sec_sasl -@subsection With SASL authentication - -The SASL authentication method is a VNC extension, that provides an -easily extendable, pluggable authentication method. This allows for -integration with a wide range of authentication mechanisms, such as -PAM, GSSAPI/Kerberos, LDAP, SQL databases, one-time keys and more. -The strength of the authentication depends on the exact mechanism -configured. If the chosen mechanism also provides a SSF layer, then -it will encrypt the datastream as well. - -Refer to the later docs on how to choose the exact SASL mechanism -used for authentication, but assuming use of one supporting SSF, -then QEMU can be launched with: - -@example -@value{qemu_system} [...OPTIONS...] -vnc :1,sasl -monitor stdio -@end example - -@node vnc_sec_certificate_sasl -@subsection With x509 certificates and SASL authentication - -If the desired SASL authentication mechanism does not supported -SSF layers, then it is strongly advised to run it in combination -with TLS and x509 certificates. This provides securely encrypted -data stream, avoiding risk of compromising of the security -credentials. This can be enabled, by combining the 'sasl' option -with the aforementioned TLS + x509 options: - -@example -@value{qemu_system} [...OPTIONS...] \ - -object tls-creds-x509,id=tls0,dir=/etc/pki/qemu,endpoint=server,verify-peer=yes \ - -vnc :1,tls-creds=tls0,sasl -monitor stdio -@end example - -@node vnc_setup_sasl - -@subsection Configuring SASL mechanisms - -The following documentation assumes use of the Cyrus SASL implementation on a -Linux host, but the principles should apply to any other SASL implementation -or host. When SASL is enabled, the mechanism configuration will be loaded from -system default SASL service config /etc/sasl2/qemu.conf. If running QEMU as an -unprivileged user, an environment variable SASL_CONF_PATH can be used to make -it search alternate locations for the service config file. - -If the TLS option is enabled for VNC, then it will provide session encryption, -otherwise the SASL mechanism will have to provide encryption. In the latter -case the list of possible plugins that can be used is drastically reduced. In -fact only the GSSAPI SASL mechanism provides an acceptable level of security -by modern standards. Previous versions of QEMU referred to the DIGEST-MD5 -mechanism, however, it has multiple serious flaws described in detail in -RFC 6331 and thus should never be used any more. The SCRAM-SHA-1 mechanism -provides a simple username/password auth facility similar to DIGEST-MD5, but -does not support session encryption, so can only be used in combination with -TLS. - -When not using TLS the recommended configuration is - -@example -mech_list: gssapi -keytab: /etc/qemu/krb5.tab -@end example - -This says to use the 'GSSAPI' mechanism with the Kerberos v5 protocol, with -the server principal stored in /etc/qemu/krb5.tab. For this to work the -administrator of your KDC must generate a Kerberos principal for the server, -with a name of 'qemu/somehost.example.com@@EXAMPLE.COM' replacing -'somehost.example.com' with the fully qualified host name of the machine -running QEMU, and 'EXAMPLE.COM' with the Kerberos Realm. - -When using TLS, if username+password authentication is desired, then a -reasonable configuration is - -@example -mech_list: scram-sha-1 -sasldb_path: /etc/qemu/passwd.db -@end example - -The @code{saslpasswd2} program can be used to populate the @code{passwd.db} -file with accounts. - -Other SASL configurations will be left as an exercise for the reader. Note that -all mechanisms, except GSSAPI, should be combined with use of TLS to ensure a -secure data channel. - - -@node network_tls -@section TLS setup for network services - -Almost all network services in QEMU have the ability to use TLS for -session data encryption, along with x509 certificates for simple -client authentication. What follows is a description of how to -generate certificates suitable for usage with QEMU, and applies to -the VNC server, character devices with the TCP backend, NBD server -and client, and migration server and client. - -At a high level, QEMU requires certificates and private keys to be -provided in PEM format. Aside from the core fields, the certificates -should include various extension data sets, including v3 basic -constraints data, key purpose, key usage and subject alt name. - -The GnuTLS package includes a command called @code{certtool} which can -be used to easily generate certificates and keys in the required format -with expected data present. Alternatively a certificate management -service may be used. - -At a minimum it is necessary to setup a certificate authority, and -issue certificates to each server. If using x509 certificates for -authentication, then each client will also need to be issued a -certificate. - -Assuming that the QEMU network services will only ever be exposed to -clients on a private intranet, there is no need to use a commercial -certificate authority to create certificates. A self-signed CA is -sufficient, and in fact likely to be more secure since it removes -the ability of malicious 3rd parties to trick the CA into mis-issuing -certs for impersonating your services. The only likely exception -where a commercial CA might be desirable is if enabling the VNC -websockets server and exposing it directly to remote browser clients. -In such a case it might be useful to use a commercial CA to avoid -needing to install custom CA certs in the web browsers. - -The recommendation is for the server to keep its certificates in either -@code{/etc/pki/qemu} or for unprivileged users in @code{$HOME/.pki/qemu}. - -@menu -* tls_generate_ca:: -* tls_generate_server:: -* tls_generate_client:: -* tls_creds_setup:: -* tls_psk:: -@end menu -@node tls_generate_ca -@subsection Setup the Certificate Authority - -This step only needs to be performed once per organization / organizational -unit. First the CA needs a private key. This key must be kept VERY secret -and secure. If this key is compromised the entire trust chain of the certificates -issued with it is lost. - -@example -# certtool --generate-privkey > ca-key.pem -@end example - -To generate a self-signed certificate requires one core piece of information, -the name of the organization. A template file @code{ca.info} should be -populated with the desired data to avoid having to deal with interactive -prompts from certtool: -@example -# cat > ca.info < server-hostNNN.info < server-hostNNN-key.pem -# certtool --generate-certificate \ - --load-ca-certificate ca-cert.pem \ - --load-ca-privkey ca-key.pem \ - --load-privkey server-hostNNN-key.pem \ - --template server-hostNNN.info \ - --outfile server-hostNNN-cert.pem -@end example - -The @code{dns_name} and @code{ip_address} fields in the template are setting -the subject alt name extension data. The @code{tls_www_server} keyword is the -key purpose extension to indicate this certificate is intended for usage in -a web server. Although QEMU network services are not in fact HTTP servers -(except for VNC websockets), setting this key purpose is still recommended. -The @code{encryption_key} and @code{signing_key} keyword is the key usage -extension to indicate this certificate is intended for usage in the data -session. - -The @code{server-hostNNN-key.pem} and @code{server-hostNNN-cert.pem} files -should now be securely copied to the server for which they were generated, -and renamed to @code{server-key.pem} and @code{server-cert.pem} when added -to the @code{/etc/pki/qemu} directory on the target host. The @code{server-key.pem} -file is security sensitive and should be kept protected with file mode 0600 -to prevent disclosure. - -@node tls_generate_client -@subsection Issuing client certificates - -The QEMU x509 TLS credential setup defaults to enabling client verification -using certificates, providing a simple authentication mechanism. If this -default is used, each client also needs to be issued a certificate. The client -certificate contains enough metadata to uniquely identify the client with the -scope of the certificate authority. The client certificate would typically -include fields for organization, state, city, building, etc. - -Once again on the host holding the CA, create template files containing the -information for each client, and use it to issue client certificates. - - -@example -# cat > client-hostNNN.info < client-hostNNN-key.pem -# certtool --generate-certificate \ - --load-ca-certificate ca-cert.pem \ - --load-ca-privkey ca-key.pem \ - --load-privkey client-hostNNN-key.pem \ - --template client-hostNNN.info \ - --outfile client-hostNNN-cert.pem -@end example - -The subject alt name extension data is not required for clients, so the -the @code{dns_name} and @code{ip_address} fields are not included. -The @code{tls_www_client} keyword is the key purpose extension to indicate -this certificate is intended for usage in a web client. Although QEMU -network clients are not in fact HTTP clients, setting this key purpose is -still recommended. The @code{encryption_key} and @code{signing_key} keyword -is the key usage extension to indicate this certificate is intended for -usage in the data session. - -The @code{client-hostNNN-key.pem} and @code{client-hostNNN-cert.pem} files -should now be securely copied to the client for which they were generated, -and renamed to @code{client-key.pem} and @code{client-cert.pem} when added -to the @code{/etc/pki/qemu} directory on the target host. The @code{client-key.pem} -file is security sensitive and should be kept protected with file mode 0600 -to prevent disclosure. - -If a single host is going to be using TLS in both a client and server -role, it is possible to create a single certificate to cover both roles. -This would be quite common for the migration and NBD services, where a -QEMU process will be started by accepting a TLS protected incoming migration, -and later itself be migrated out to another host. To generate a single -certificate, simply include the template data from both the client and server -instructions in one. - -@example -# cat > both-hostNNN.info < both-hostNNN-key.pem -# certtool --generate-certificate \ - --load-ca-certificate ca-cert.pem \ - --load-ca-privkey ca-key.pem \ - --load-privkey both-hostNNN-key.pem \ - --template both-hostNNN.info \ - --outfile both-hostNNN-cert.pem -@end example - -When copying the PEM files to the target host, save them twice, -once as @code{server-cert.pem} and @code{server-key.pem}, and -again as @code{client-cert.pem} and @code{client-key.pem}. - -@node tls_creds_setup -@subsection TLS x509 credential configuration - -QEMU has a standard mechanism for loading x509 credentials that will be -used for network services and clients. It requires specifying the -@code{tls-creds-x509} class name to the @code{--object} command line -argument for the system emulators. Each set of credentials loaded should -be given a unique string identifier via the @code{id} parameter. A single -set of TLS credentials can be used for multiple network backends, so VNC, -migration, NBD, character devices can all share the same credentials. Note, -however, that credentials for use in a client endpoint must be loaded -separately from those used in a server endpoint. - -When specifying the object, the @code{dir} parameters specifies which -directory contains the credential files. This directory is expected to -contain files with the names mentioned previously, @code{ca-cert.pem}, -@code{server-key.pem}, @code{server-cert.pem}, @code{client-key.pem} -and @code{client-cert.pem} as appropriate. It is also possible to -include a set of pre-generated Diffie-Hellman (DH) parameters in a file -@code{dh-params.pem}, which can be created using the -@code{certtool --generate-dh-params} command. If omitted, QEMU will -dynamically generate DH parameters when loading the credentials. - -The @code{endpoint} parameter indicates whether the credentials will -be used for a network client or server, and determines which PEM -files are loaded. - -The @code{verify} parameter determines whether x509 certificate -validation should be performed. This defaults to enabled, meaning -clients will always validate the server hostname against the -certificate subject alt name fields and/or CN field. It also -means that servers will request that clients provide a certificate -and validate them. Verification should never be turned off for -client endpoints, however, it may be turned off for server endpoints -if an alternative mechanism is used to authenticate clients. For -example, the VNC server can use SASL to authenticate clients -instead. - -To load server credentials with client certificate validation -enabled - -@example -@value{qemu_system} -object tls-creds-x509,id=tls0,dir=/etc/pki/qemu,endpoint=server -@end example - -while to load client credentials use - -@example -@value{qemu_system} -object tls-creds-x509,id=tls0,dir=/etc/pki/qemu,endpoint=client -@end example - -Network services which support TLS will all have a @code{tls-creds} -parameter which expects the ID of the TLS credentials object. For -example with VNC: - -@example -@value{qemu_system} -vnc 0.0.0.0:0,tls-creds=tls0 -@end example - -@node tls_psk -@subsection TLS Pre-Shared Keys (PSK) - -Instead of using certificates, you may also use TLS Pre-Shared Keys -(TLS-PSK). This can be simpler to set up than certificates but is -less scalable. - -Use the GnuTLS @code{psktool} program to generate a @code{keys.psk} -file containing one or more usernames and random keys: - -@example -mkdir -m 0700 /tmp/keys -psktool -u rich -p /tmp/keys/keys.psk -@end example - -TLS-enabled servers such as qemu-nbd can use this directory like so: - -@example -qemu-nbd \ - -t -x / \ - --object tls-creds-psk,id=tls0,endpoint=server,dir=/tmp/keys \ - --tls-creds tls0 \ - image.qcow2 -@end example - -When connecting from a qemu-based client you must specify the -directory containing @code{keys.psk} and an optional @var{username} -(defaults to ``qemu''): - -@example -qemu-img info \ - --object tls-creds-psk,id=tls0,dir=/tmp/keys,username=rich,endpoint=client \ - --image-opts \ - file.driver=nbd,file.host=localhost,file.port=10809,file.tls-creds=tls0,file.export=/ -@end example - -@node gdb_usage -@section GDB usage - -QEMU has a primitive support to work with gdb, so that you can do -'Ctrl-C' while the virtual machine is running and inspect its state. - -In order to use gdb, launch QEMU with the '-s' option. It will wait for a -gdb connection: -@example -@value{qemu_system} -s -kernel bzImage -hda rootdisk.img -append "root=/dev/hda" -Connected to host network interface: tun0 -Waiting gdb connection on port 1234 -@end example - -Then launch gdb on the 'vmlinux' executable: -@example -> gdb vmlinux -@end example - -In gdb, connect to QEMU: -@example -(gdb) target remote localhost:1234 -@end example - -Then you can use gdb normally. For example, type 'c' to launch the kernel: -@example -(gdb) c -@end example - -Here are some useful tips in order to use gdb on system code: - -@enumerate -@item -Use @code{info reg} to display all the CPU registers. -@item -Use @code{x/10i $eip} to display the code at the PC position. -@item -Use @code{set architecture i8086} to dump 16 bit code. Then use -@code{x/10i $cs*16+$eip} to dump the code at the PC position. -@end enumerate - -Advanced debugging options: - -The default single stepping behavior is step with the IRQs and timer service routines off. It is set this way because when gdb executes a single step it expects to advance beyond the current instruction. With the IRQs and timer service routines on, a single step might jump into the one of the interrupt or exception vectors instead of executing the current instruction. This means you may hit the same breakpoint a number of times before executing the instruction gdb wants to have executed. Because there are rare circumstances where you want to single step into an interrupt vector the behavior can be controlled from GDB. There are three commands you can query and set the single step behavior: -@table @code -@item maintenance packet qqemu.sstepbits - -This will display the MASK bits used to control the single stepping IE: -@example -(gdb) maintenance packet qqemu.sstepbits -sending: "qqemu.sstepbits" -received: "ENABLE=1,NOIRQ=2,NOTIMER=4" -@end example -@item maintenance packet qqemu.sstep - -This will display the current value of the mask used when single stepping IE: -@example -(gdb) maintenance packet qqemu.sstep -sending: "qqemu.sstep" -received: "0x7" -@end example -@item maintenance packet Qqemu.sstep=HEX_VALUE - -This will change the single step mask, so if wanted to enable IRQs on the single step, but not timers, you would use: -@example -(gdb) maintenance packet Qqemu.sstep=0x5 -sending: "qemu.sstep=0x5" -received: "OK" -@end example -@end table +@include docs/system/images.texi +@include docs/system/net.texi +@include docs/system/usb.texi +@include docs/system/ivshmem.texi +@include docs/system/linuxboot.texi +@include docs/system/vnc-security.texi +@include docs/system/tls.texi +@include docs/system/gdb.texi @node QEMU System emulator for non PC targets @chapter QEMU System emulator for non PC targets @@ -2411,83 +1047,10 @@ to make it close to a 4.5 or newer kernel. @include qemu-deprecated.texi -@node Supported build platforms -@appendix Supported build platforms - -QEMU aims to support building and executing on multiple host OS platforms. -This appendix outlines which platforms are the major build targets. These -platforms are used as the basis for deciding upon the minimum required -versions of 3rd party software QEMU depends on. The supported platforms -are the targets for automated testing performed by the project when patches -are submitted for review, and tested before and after merge. - -If a platform is not listed here, it does not imply that QEMU won't work. -If an unlisted platform has comparable software versions to a listed platform, -there is every expectation that it will work. Bug reports are welcome for -problems encountered on unlisted platforms unless they are clearly older -vintage than what is described here. - -Note that when considering software versions shipped in distros as support -targets, QEMU considers only the version number, and assumes the features in -that distro match the upstream release with the same version. In other words, -if a distro backports extra features to the software in their distro, QEMU -upstream code will not add explicit support for those backports, unless the -feature is auto-detectable in a manner that works for the upstream releases -too. - -The Repology site @url{https://repology.org} is a useful resource to identify -currently shipped versions of software in various operating systems, though -it does not cover all distros listed below. - -@section Linux OS - -For distributions with frequent, short-lifetime releases, the project will -aim to support all versions that are not end of life by their respective -vendors. For the purposes of identifying supported software versions, the -project will look at Fedora, Ubuntu, and openSUSE distros. Other short- -lifetime distros will be assumed to ship similar software versions. - -For distributions with long-lifetime releases, the project will aim to support -the most recent major version at all times. Support for the previous major -version will be dropped 2 years after the new major version is released, -or when it reaches ``end of life''. For the purposes of identifying -supported software versions, the project will look at RHEL, Debian, -Ubuntu LTS, and SLES distros. Other long-lifetime distros will be -assumed to ship similar software versions. - -@section Windows - -The project supports building with current versions of the MinGW toolchain, -hosted on Linux. - -@section macOS - -The project supports building with the two most recent versions of macOS, with -the current homebrew package set available. - -@section FreeBSD - -The project aims to support the all the versions which are not end of life. - -@section NetBSD - -The project aims to support the most recent major version at all times. Support -for the previous major version will be dropped 2 years after the new major -version is released. - -@section OpenBSD - -The project aims to support the all the versions which are not end of life. - -@node License -@appendix License +@include docs/system/build-platforms.texi -QEMU is a trademark of Fabrice Bellard. +@include docs/system/license.texi -QEMU is released under the -@url{https://www.gnu.org/licenses/gpl-2.0.txt,GNU General Public License}, -version 2. Parts of QEMU have specific licenses, see file -@url{https://git.qemu.org/?p=qemu.git;a=blob_plain;f=LICENSE,LICENSE}. @node Index @appendix Index -- cgit v1.2.3-55-g7522 From ce9fc5834c74a9e1b2ad2f51324cd1f0d5a13335 Mon Sep 17 00:00:00 2001 From: Paolo Bonzini Date: Fri, 28 Feb 2020 15:35:52 +0000 Subject: qemu-doc: extract common system emulator documentation from the PC section Move the section on PC peripherals together with other targets. While some x86-specific information remains in the main system emulation chapter, it can be tackled more easily a section at a time. Signed-off-by: Paolo Bonzini Reviewed-by: Peter Maydell Reviewed-by: Alex Bennée Tested-by: Alex Bennée Signed-off-by: Peter Maydell Message-id: 20200228153619.9906-7-peter.maydell@linaro.org Message-id: 20200226113034.6741-7-pbonzini@redhat.com Reviewed-by: Peter Maydell Signed-off-by: Peter Maydell --- docs/system/quickstart.texi | 2 +- qemu-doc.texi | 102 ++++++++++++++++++++++++-------------------- 2 files changed, 57 insertions(+), 47 deletions(-) (limited to 'docs/system') diff --git a/docs/system/quickstart.texi b/docs/system/quickstart.texi index 8cd5b4bc6e..ed7295de7a 100644 --- a/docs/system/quickstart.texi +++ b/docs/system/quickstart.texi @@ -2,7 +2,7 @@ @section Quick Start @cindex quick start -Download and uncompress a hard disk image with Linux installed (e.g. +Download and uncompress a PC hard disk image with Linux installed (e.g. @file{linux.img}) and type: @example diff --git a/qemu-doc.texi b/qemu-doc.texi index 33d24caf94..88e84300e9 100644 --- a/qemu-doc.texi +++ b/qemu-doc.texi @@ -36,8 +36,8 @@ @menu * Introduction:: -* QEMU PC System emulator:: -* QEMU System emulator for non PC targets:: +* QEMU System emulator:: +* QEMU System emulator targets:: * System requirements:: * Security:: * Implementation notes:: @@ -127,19 +127,16 @@ accelerator is required to use more than one host CPU for emulation. @end itemize - -@node QEMU PC System emulator -@chapter QEMU PC System emulator -@cindex system emulation (PC) +@node QEMU System emulator +@chapter QEMU System emulator +@cindex system emulation @menu -* pcsys_introduction:: Introduction -* pcsys_quickstart:: Quick Start +* pcsys_quickstart:: Quick start * sec_invocation:: Invocation * pcsys_keys:: Keys in the graphical frontends * mux_keys:: Keys in the character backend multiplexer * pcsys_monitor:: QEMU Monitor -* cpu_models_x86:: Supported CPU model configurations on x86 hosts * disk_images:: Disk Images * pcsys_network:: Network emulation * pcsys_usb:: USB emulation @@ -150,13 +147,57 @@ accelerator is required to use more than one host CPU for emulation. * gdb_usage:: GDB usage @end menu -@node pcsys_introduction -@section Introduction +@include docs/system/quickstart.texi +@include docs/system/invocation.texi +@include docs/system/keys.texi +@include docs/system/mux-chardev.texi +@include docs/system/monitor.texi +@include docs/system/images.texi +@include docs/system/net.texi +@include docs/system/usb.texi +@include docs/system/ivshmem.texi +@include docs/system/linuxboot.texi +@include docs/system/vnc-security.texi +@include docs/system/tls.texi +@include docs/system/gdb.texi + +@node QEMU System emulator targets +@chapter QEMU System emulator targets +@cindex system emulation (PC) + +QEMU is a generic emulator and it emulates many machines. Most of the +options are similar for all machines. Specific information about the +various targets are mentioned in the following sections. + +@menu +* x86 (PC) System emulator:: +* PowerPC System emulator:: +* Sparc32 System emulator:: +* Sparc64 System emulator:: +* MIPS System emulator:: +* ARM System emulator:: +* ColdFire System emulator:: +* Cris System emulator:: +* Microblaze System emulator:: +* SH4 System emulator:: +* Xtensa System emulator:: +@end menu + +@node x86 (PC) System emulator +@section x86 (PC) System emulator +@cindex system emulation (PC) + +@menu +* pcsys_devices:: Peripherals +* cpu_models_x86:: Supported CPU model configurations on x86 hosts +@end menu + +@node pcsys_devices +@subsection Peripherals @c man begin DESCRIPTION -The QEMU PC System emulator simulates the -following peripherals: +The QEMU PC System emulator simulates the following peripherals: @itemize @minus @item @@ -222,40 +263,9 @@ CS4231A is the chip used in Windows Sound System and GUSMAX products @c man end -@include docs/system/quickstart.texi -@include docs/system/invocation.texi -@include docs/system/keys.texi -@include docs/system/mux-chardev.texi -@include docs/system/monitor.texi +@lowersections @include docs/system/cpu-models-x86.texi -@include docs/system/images.texi -@include docs/system/net.texi -@include docs/system/usb.texi -@include docs/system/ivshmem.texi -@include docs/system/linuxboot.texi -@include docs/system/vnc-security.texi -@include docs/system/tls.texi -@include docs/system/gdb.texi - -@node QEMU System emulator for non PC targets -@chapter QEMU System emulator for non PC targets - -QEMU is a generic emulator and it emulates many non PC -machines. Most of the options are similar to the PC emulator. The -differences are mentioned in the following sections. - -@menu -* PowerPC System emulator:: -* Sparc32 System emulator:: -* Sparc64 System emulator:: -* MIPS System emulator:: -* ARM System emulator:: -* ColdFire System emulator:: -* Cris System emulator:: -* Microblaze System emulator:: -* SH4 System emulator:: -* Xtensa System emulator:: -@end menu +@raisesections @node PowerPC System emulator @section PowerPC System emulator -- cgit v1.2.3-55-g7522 From 9d0ba2cd943a8baa1b29380308e53095843415cc Mon Sep 17 00:00:00 2001 From: Paolo Bonzini Date: Fri, 28 Feb 2020 15:35:54 +0000 Subject: qemu-doc: split target sections to separate files Signed-off-by: Paolo Bonzini Reviewed-by: Peter Maydell Reviewed-by: Alex Bennée Tested-by: Alex Bennée Signed-off-by: Peter Maydell Message-id: 20200228153619.9906-9-peter.maydell@linaro.org Message-id: 20200226113034.6741-9-pbonzini@redhat.com Reviewed-by: Peter Maydell Signed-off-by: Peter Maydell --- docs/system/target-arm.texi | 264 ++++++++++++ docs/system/target-i386.texi | 92 +++++ docs/system/target-m68k.texi | 46 +++ docs/system/target-mips.texi | 152 +++++++ docs/system/target-ppc.texi | 78 ++++ docs/system/target-sparc.texi | 96 +++++ docs/system/target-sparc64.texi | 61 +++ docs/system/target-xtensa.texi | 56 +++ qemu-doc.texi | 873 +--------------------------------------- 9 files changed, 853 insertions(+), 865 deletions(-) create mode 100644 docs/system/target-arm.texi create mode 100644 docs/system/target-i386.texi create mode 100644 docs/system/target-m68k.texi create mode 100644 docs/system/target-mips.texi create mode 100644 docs/system/target-ppc.texi create mode 100644 docs/system/target-sparc.texi create mode 100644 docs/system/target-sparc64.texi create mode 100644 docs/system/target-xtensa.texi (limited to 'docs/system') diff --git a/docs/system/target-arm.texi b/docs/system/target-arm.texi new file mode 100644 index 0000000000..040d77b5e0 --- /dev/null +++ b/docs/system/target-arm.texi @@ -0,0 +1,264 @@ +@node ARM System emulator +@section ARM System emulator +@cindex system emulation (ARM) + +Use the executable @file{qemu-system-arm} to simulate a ARM +machine. The ARM Integrator/CP board is emulated with the following +devices: + +@itemize @minus +@item +ARM926E, ARM1026E, ARM946E, ARM1136 or Cortex-A8 CPU +@item +Two PL011 UARTs +@item +SMC 91c111 Ethernet adapter +@item +PL110 LCD controller +@item +PL050 KMI with PS/2 keyboard and mouse. +@item +PL181 MultiMedia Card Interface with SD card. +@end itemize + +The ARM Versatile baseboard is emulated with the following devices: + +@itemize @minus +@item +ARM926E, ARM1136 or Cortex-A8 CPU +@item +PL190 Vectored Interrupt Controller +@item +Four PL011 UARTs +@item +SMC 91c111 Ethernet adapter +@item +PL110 LCD controller +@item +PL050 KMI with PS/2 keyboard and mouse. +@item +PCI host bridge. Note the emulated PCI bridge only provides access to +PCI memory space. It does not provide access to PCI IO space. +This means some devices (eg. ne2k_pci NIC) are not usable, and others +(eg. rtl8139 NIC) are only usable when the guest drivers use the memory +mapped control registers. +@item +PCI OHCI USB controller. +@item +LSI53C895A PCI SCSI Host Bus Adapter with hard disk and CD-ROM devices. +@item +PL181 MultiMedia Card Interface with SD card. +@end itemize + +Several variants of the ARM RealView baseboard are emulated, +including the EB, PB-A8 and PBX-A9. Due to interactions with the +bootloader, only certain Linux kernel configurations work out +of the box on these boards. + +Kernels for the PB-A8 board should have CONFIG_REALVIEW_HIGH_PHYS_OFFSET +enabled in the kernel, and expect 512M RAM. Kernels for The PBX-A9 board +should have CONFIG_SPARSEMEM enabled, CONFIG_REALVIEW_HIGH_PHYS_OFFSET +disabled and expect 1024M RAM. + +The following devices are emulated: + +@itemize @minus +@item +ARM926E, ARM1136, ARM11MPCore, Cortex-A8 or Cortex-A9 MPCore CPU +@item +ARM AMBA Generic/Distributed Interrupt Controller +@item +Four PL011 UARTs +@item +SMC 91c111 or SMSC LAN9118 Ethernet adapter +@item +PL110 LCD controller +@item +PL050 KMI with PS/2 keyboard and mouse +@item +PCI host bridge +@item +PCI OHCI USB controller +@item +LSI53C895A PCI SCSI Host Bus Adapter with hard disk and CD-ROM devices +@item +PL181 MultiMedia Card Interface with SD card. +@end itemize + +The XScale-based clamshell PDA models ("Spitz", "Akita", "Borzoi" +and "Terrier") emulation includes the following peripherals: + +@itemize @minus +@item +Intel PXA270 System-on-chip (ARM V5TE core) +@item +NAND Flash memory +@item +IBM/Hitachi DSCM microdrive in a PXA PCMCIA slot - not in "Akita" +@item +On-chip OHCI USB controller +@item +On-chip LCD controller +@item +On-chip Real Time Clock +@item +TI ADS7846 touchscreen controller on SSP bus +@item +Maxim MAX1111 analog-digital converter on I@math{^2}C bus +@item +GPIO-connected keyboard controller and LEDs +@item +Secure Digital card connected to PXA MMC/SD host +@item +Three on-chip UARTs +@item +WM8750 audio CODEC on I@math{^2}C and I@math{^2}S busses +@end itemize + +The Palm Tungsten|E PDA (codename "Cheetah") emulation includes the +following elements: + +@itemize @minus +@item +Texas Instruments OMAP310 System-on-chip (ARM 925T core) +@item +ROM and RAM memories (ROM firmware image can be loaded with -option-rom) +@item +On-chip LCD controller +@item +On-chip Real Time Clock +@item +TI TSC2102i touchscreen controller / analog-digital converter / Audio +CODEC, connected through MicroWire and I@math{^2}S busses +@item +GPIO-connected matrix keypad +@item +Secure Digital card connected to OMAP MMC/SD host +@item +Three on-chip UARTs +@end itemize + +Nokia N800 and N810 internet tablets (known also as RX-34 and RX-44 / 48) +emulation supports the following elements: + +@itemize @minus +@item +Texas Instruments OMAP2420 System-on-chip (ARM 1136 core) +@item +RAM and non-volatile OneNAND Flash memories +@item +Display connected to EPSON remote framebuffer chip and OMAP on-chip +display controller and a LS041y3 MIPI DBI-C controller +@item +TI TSC2301 (in N800) and TI TSC2005 (in N810) touchscreen controllers +driven through SPI bus +@item +National Semiconductor LM8323-controlled qwerty keyboard driven +through I@math{^2}C bus +@item +Secure Digital card connected to OMAP MMC/SD host +@item +Three OMAP on-chip UARTs and on-chip STI debugging console +@item +Mentor Graphics "Inventra" dual-role USB controller embedded in a TI +TUSB6010 chip - only USB host mode is supported +@item +TI TMP105 temperature sensor driven through I@math{^2}C bus +@item +TI TWL92230C power management companion with an RTC on I@math{^2}C bus +@item +Nokia RETU and TAHVO multi-purpose chips with an RTC, connected +through CBUS +@end itemize + +The Luminary Micro Stellaris LM3S811EVB emulation includes the following +devices: + +@itemize @minus +@item +Cortex-M3 CPU core. +@item +64k Flash and 8k SRAM. +@item +Timers, UARTs, ADC and I@math{^2}C interface. +@item +OSRAM Pictiva 96x16 OLED with SSD0303 controller on I@math{^2}C bus. +@end itemize + +The Luminary Micro Stellaris LM3S6965EVB emulation includes the following +devices: + +@itemize @minus +@item +Cortex-M3 CPU core. +@item +256k Flash and 64k SRAM. +@item +Timers, UARTs, ADC, I@math{^2}C and SSI interfaces. +@item +OSRAM Pictiva 128x64 OLED with SSD0323 controller connected via SSI. +@end itemize + +The Freecom MusicPal internet radio emulation includes the following +elements: + +@itemize @minus +@item +Marvell MV88W8618 ARM core. +@item +32 MB RAM, 256 KB SRAM, 8 MB flash. +@item +Up to 2 16550 UARTs +@item +MV88W8xx8 Ethernet controller +@item +MV88W8618 audio controller, WM8750 CODEC and mixer +@item +128×64 display with brightness control +@item +2 buttons, 2 navigation wheels with button function +@end itemize + +The Siemens SX1 models v1 and v2 (default) basic emulation. +The emulation includes the following elements: + +@itemize @minus +@item +Texas Instruments OMAP310 System-on-chip (ARM 925T core) +@item +ROM and RAM memories (ROM firmware image can be loaded with -pflash) +V1 +1 Flash of 16MB and 1 Flash of 8MB +V2 +1 Flash of 32MB +@item +On-chip LCD controller +@item +On-chip Real Time Clock +@item +Secure Digital card connected to OMAP MMC/SD host +@item +Three on-chip UARTs +@end itemize + +A Linux 2.6 test image is available on the QEMU web site. More +information is available in the QEMU mailing-list archive. + +@c man begin OPTIONS + +The following options are specific to the ARM emulation: + +@table @option + +@item -semihosting +Enable semihosting syscall emulation. + +On ARM this implements the "Angel" interface. + +Note that this allows guest direct access to the host filesystem, +so should only be used with trusted guest OS. + +@end table + +@c man end + diff --git a/docs/system/target-i386.texi b/docs/system/target-i386.texi new file mode 100644 index 0000000000..edd23fa8df --- /dev/null +++ b/docs/system/target-i386.texi @@ -0,0 +1,92 @@ +@node x86 (PC) System emulator +@section x86 (PC) System emulator +@cindex system emulation (PC) + +@menu +* pcsys_devices:: Peripherals +* cpu_models_x86:: CPU models +* pcsys_req:: OS requirements +@end menu + +@node pcsys_devices +@subsection Peripherals + +@c man begin DESCRIPTION + +The QEMU PC System emulator simulates the following peripherals: + +@itemize @minus +@item +i440FX host PCI bridge and PIIX3 PCI to ISA bridge +@item +Cirrus CLGD 5446 PCI VGA card or dummy VGA card with Bochs VESA +extensions (hardware level, including all non standard modes). +@item +PS/2 mouse and keyboard +@item +2 PCI IDE interfaces with hard disk and CD-ROM support +@item +Floppy disk +@item +PCI and ISA network adapters +@item +Serial ports +@item +IPMI BMC, either and internal or external one +@item +Creative SoundBlaster 16 sound card +@item +ENSONIQ AudioPCI ES1370 sound card +@item +Intel 82801AA AC97 Audio compatible sound card +@item +Intel HD Audio Controller and HDA codec +@item +Adlib (OPL2) - Yamaha YM3812 compatible chip +@item +Gravis Ultrasound GF1 sound card +@item +CS4231A compatible sound card +@item +PCI UHCI, OHCI, EHCI or XHCI USB controller and a virtual USB-1.1 hub. +@end itemize + +SMP is supported with up to 255 CPUs. + +QEMU uses the PC BIOS from the Seabios project and the Plex86/Bochs LGPL +VGA BIOS. + +QEMU uses YM3812 emulation by Tatsuyuki Satoh. + +QEMU uses GUS emulation (GUSEMU32 @url{http://www.deinmeister.de/gusemu/}) +by Tibor "TS" Schütz. + +Note that, by default, GUS shares IRQ(7) with parallel ports and so +QEMU must be told to not have parallel ports to have working GUS. + +@example +@value{qemu_system_x86} dos.img -soundhw gus -parallel none +@end example + +Alternatively: +@example +@value{qemu_system_x86} dos.img -device gus,irq=5 +@end example + +Or some other unclaimed IRQ. + +CS4231A is the chip used in Windows Sound System and GUSMAX products + +@c man end + +@lowersections +@include docs/system/cpu-models-x86.texi +@raisesections + +@node pcsys_req +@subsection OS requirements + +On x86_64 hosts, the default set of CPU features enabled by the KVM accelerator +require the host to be running Linux v4.5 or newer. Red Hat Enterprise Linux +7 is also supported, since the required functionality was backported. + diff --git a/docs/system/target-m68k.texi b/docs/system/target-m68k.texi new file mode 100644 index 0000000000..b5bc9df40a --- /dev/null +++ b/docs/system/target-m68k.texi @@ -0,0 +1,46 @@ +@node ColdFire System emulator +@section ColdFire System emulator +@cindex system emulation (ColdFire) +@cindex system emulation (M68K) + +Use the executable @file{qemu-system-m68k} to simulate a ColdFire machine. +The emulator is able to boot a uClinux kernel. + +The M5208EVB emulation includes the following devices: + +@itemize @minus +@item +MCF5208 ColdFire V2 Microprocessor (ISA A+ with EMAC). +@item +Three Two on-chip UARTs. +@item +Fast Ethernet Controller (FEC) +@end itemize + +The AN5206 emulation includes the following devices: + +@itemize @minus +@item +MCF5206 ColdFire V2 Microprocessor. +@item +Two on-chip UARTs. +@end itemize + +@c man begin OPTIONS + +The following options are specific to the ColdFire emulation: + +@table @option + +@item -semihosting +Enable semihosting syscall emulation. + +On M68K this implements the "ColdFire GDB" interface used by libgloss. + +Note that this allows guest direct access to the host filesystem, +so should only be used with trusted guest OS. + +@end table + +@c man end + diff --git a/docs/system/target-mips.texi b/docs/system/target-mips.texi new file mode 100644 index 0000000000..f722c00912 --- /dev/null +++ b/docs/system/target-mips.texi @@ -0,0 +1,152 @@ +@node MIPS System emulator +@section MIPS System emulator +@cindex system emulation (MIPS) + +@menu +* recommendations_cpu_models_MIPS:: Supported CPU model configurations on MIPS hosts +* nanoMIPS System emulator :: +@end menu + +Four executables cover simulation of 32 and 64-bit MIPS systems in +both endian options, @file{qemu-system-mips}, @file{qemu-system-mipsel} +@file{qemu-system-mips64} and @file{qemu-system-mips64el}. +Five different machine types are emulated: + +@itemize @minus +@item +A generic ISA PC-like machine "mips" +@item +The MIPS Malta prototype board "malta" +@item +An ACER Pica "pica61". This machine needs the 64-bit emulator. +@item +MIPS emulator pseudo board "mipssim" +@item +A MIPS Magnum R4000 machine "magnum". This machine needs the 64-bit emulator. +@end itemize + +The generic emulation is supported by Debian 'Etch' and is able to +install Debian into a virtual disk image. The following devices are +emulated: + +@itemize @minus +@item +A range of MIPS CPUs, default is the 24Kf +@item +PC style serial port +@item +PC style IDE disk +@item +NE2000 network card +@end itemize + +The Malta emulation supports the following devices: + +@itemize @minus +@item +Core board with MIPS 24Kf CPU and Galileo system controller +@item +PIIX4 PCI/USB/SMbus controller +@item +The Multi-I/O chip's serial device +@item +PCI network cards (PCnet32 and others) +@item +Malta FPGA serial device +@item +Cirrus (default) or any other PCI VGA graphics card +@end itemize + +The Boston board emulation supports the following devices: + +@itemize @minus +@item +Xilinx FPGA, which includes a PCIe root port and an UART +@item +Intel EG20T PCH connects the I/O peripherals, but only the SATA bus is emulated +@end itemize + +The ACER Pica emulation supports: + +@itemize @minus +@item +MIPS R4000 CPU +@item +PC-style IRQ and DMA controllers +@item +PC Keyboard +@item +IDE controller +@end itemize + +The MIPS Magnum R4000 emulation supports: + +@itemize @minus +@item +MIPS R4000 CPU +@item +PC-style IRQ controller +@item +PC Keyboard +@item +SCSI controller +@item +G364 framebuffer +@end itemize + +The Fulong 2E emulation supports: + +@itemize @minus +@item +Loongson 2E CPU +@item +Bonito64 system controller as North Bridge +@item +VT82C686 chipset as South Bridge +@item +RTL8139D as a network card chipset +@end itemize + +The mipssim pseudo board emulation provides an environment similar +to what the proprietary MIPS emulator uses for running Linux. +It supports: + +@itemize @minus +@item +A range of MIPS CPUs, default is the 24Kf +@item +PC style serial port +@item +MIPSnet network emulation +@end itemize + +@lowersections +@include docs/system/cpu-models-mips.texi +@raisesections + +@node nanoMIPS System emulator +@subsection nanoMIPS System emulator +@cindex system emulation (nanoMIPS) + +Executable @file{qemu-system-mipsel} also covers simulation of +32-bit nanoMIPS system in little endian mode: + +@itemize @minus +@item +nanoMIPS I7200 CPU +@end itemize + +Example of @file{qemu-system-mipsel} usage for nanoMIPS is shown below: + +Download @code{} from @url{https://mipsdistros.mips.com/LinuxDistro/nanomips/buildroot/index.html}. + +Download @code{} from @url{https://mipsdistros.mips.com/LinuxDistro/nanomips/kernels/v4.15.18-432-gb2eb9a8b07a1-20180627102142/index.html}. + +Start system emulation of Malta board with nanoMIPS I7200 CPU: +@example +qemu-system-mipsel -cpu I7200 -kernel @code{} \ + -M malta -serial stdio -m @code{} -hda @code{} \ + -append "mem=256m@@0x0 rw console=ttyS0 vga=cirrus vesa=0x111 root=/dev/sda" +@end example + + diff --git a/docs/system/target-ppc.texi b/docs/system/target-ppc.texi new file mode 100644 index 0000000000..c2c254d3d2 --- /dev/null +++ b/docs/system/target-ppc.texi @@ -0,0 +1,78 @@ +@node PowerPC System emulator +@section PowerPC System emulator +@cindex system emulation (PowerPC) + +Use the executable @file{qemu-system-ppc} to simulate a complete 40P (PREP) +or PowerMac PowerPC system. + +QEMU emulates the following PowerMac peripherals: + +@itemize @minus +@item +UniNorth or Grackle PCI Bridge +@item +PCI VGA compatible card with VESA Bochs Extensions +@item +2 PMAC IDE interfaces with hard disk and CD-ROM support +@item +NE2000 PCI adapters +@item +Non Volatile RAM +@item +VIA-CUDA with ADB keyboard and mouse. +@end itemize + +QEMU emulates the following 40P (PREP) peripherals: + +@itemize @minus +@item +PCI Bridge +@item +PCI VGA compatible card with VESA Bochs Extensions +@item +2 IDE interfaces with hard disk and CD-ROM support +@item +Floppy disk +@item +PCnet network adapters +@item +Serial port +@item +PREP Non Volatile RAM +@item +PC compatible keyboard and mouse. +@end itemize + +Since version 0.9.1, QEMU uses OpenBIOS @url{https://www.openbios.org/} +for the g3beige and mac99 PowerMac and the 40p machines. OpenBIOS is a free +(GPL v2) portable firmware implementation. The goal is to implement a 100% +IEEE 1275-1994 (referred to as Open Firmware) compliant firmware. + +@c man begin OPTIONS + +The following options are specific to the PowerPC emulation: + +@table @option + +@item -g @var{W}x@var{H}[x@var{DEPTH}] + +Set the initial VGA graphic mode. The default is 800x600x32. + +@item -prom-env @var{string} + +Set OpenBIOS variables in NVRAM, for example: + +@example +qemu-system-ppc -prom-env 'auto-boot?=false' \ + -prom-env 'boot-device=hd:2,\yaboot' \ + -prom-env 'boot-args=conf=hd:2,\yaboot.conf' +@end example + +@end table + +@c man end + + +More information is available at +@url{http://perso.magic.fr/l_indien/qemu-ppc/}. + diff --git a/docs/system/target-sparc.texi b/docs/system/target-sparc.texi new file mode 100644 index 0000000000..7fe0aec9c3 --- /dev/null +++ b/docs/system/target-sparc.texi @@ -0,0 +1,96 @@ +@node Sparc32 System emulator +@section Sparc32 System emulator +@cindex system emulation (Sparc32) + +Use the executable @file{qemu-system-sparc} to simulate the following +Sun4m architecture machines: +@itemize @minus +@item +SPARCstation 4 +@item +SPARCstation 5 +@item +SPARCstation 10 +@item +SPARCstation 20 +@item +SPARCserver 600MP +@item +SPARCstation LX +@item +SPARCstation Voyager +@item +SPARCclassic +@item +SPARCbook +@end itemize + +The emulation is somewhat complete. SMP up to 16 CPUs is supported, +but Linux limits the number of usable CPUs to 4. + +QEMU emulates the following sun4m peripherals: + +@itemize @minus +@item +IOMMU +@item +TCX or cgthree Frame buffer +@item +Lance (Am7990) Ethernet +@item +Non Volatile RAM M48T02/M48T08 +@item +Slave I/O: timers, interrupt controllers, Zilog serial ports, keyboard +and power/reset logic +@item +ESP SCSI controller with hard disk and CD-ROM support +@item +Floppy drive (not on SS-600MP) +@item +CS4231 sound device (only on SS-5, not working yet) +@end itemize + +The number of peripherals is fixed in the architecture. Maximum +memory size depends on the machine type, for SS-5 it is 256MB and for +others 2047MB. + +Since version 0.8.2, QEMU uses OpenBIOS +@url{https://www.openbios.org/}. OpenBIOS is a free (GPL v2) portable +firmware implementation. The goal is to implement a 100% IEEE +1275-1994 (referred to as Open Firmware) compliant firmware. + +A sample Linux 2.6 series kernel and ram disk image are available on +the QEMU web site. There are still issues with NetBSD and OpenBSD, but +most kernel versions work. Please note that currently older Solaris kernels +don't work probably due to interface issues between OpenBIOS and +Solaris. + +@c man begin OPTIONS + +The following options are specific to the Sparc32 emulation: + +@table @option + +@item -g @var{W}x@var{H}x[x@var{DEPTH}] + +Set the initial graphics mode. For TCX, the default is 1024x768x8 with the +option of 1024x768x24. For cgthree, the default is 1024x768x8 with the option +of 1152x900x8 for people who wish to use OBP. + +@item -prom-env @var{string} + +Set OpenBIOS variables in NVRAM, for example: + +@example +qemu-system-sparc -prom-env 'auto-boot?=false' \ + -prom-env 'boot-device=sd(0,2,0):d' -prom-env 'boot-args=linux single' +@end example + +@item -M [SS-4|SS-5|SS-10|SS-20|SS-600MP|LX|Voyager|SPARCClassic] [|SPARCbook] + +Set the emulated machine type. Default is SS-5. + +@end table + +@c man end + diff --git a/docs/system/target-sparc64.texi b/docs/system/target-sparc64.texi new file mode 100644 index 0000000000..9e7a27de0c --- /dev/null +++ b/docs/system/target-sparc64.texi @@ -0,0 +1,61 @@ +@node Sparc64 System emulator +@section Sparc64 System emulator +@cindex system emulation (Sparc64) + +Use the executable @file{qemu-system-sparc64} to simulate a Sun4u +(UltraSPARC PC-like machine), Sun4v (T1 PC-like machine), or generic +Niagara (T1) machine. The Sun4u emulator is mostly complete, being +able to run Linux, NetBSD and OpenBSD in headless (-nographic) mode. The +Sun4v emulator is still a work in progress. + +The Niagara T1 emulator makes use of firmware and OS binaries supplied in the S10image/ directory +of the OpenSPARC T1 project @url{http://download.oracle.com/technetwork/systems/opensparc/OpenSPARCT1_Arch.1.5.tar.bz2} +and is able to boot the disk.s10hw2 Solaris image. +@example +qemu-system-sparc64 -M niagara -L /path-to/S10image/ \ + -nographic -m 256 \ + -drive if=pflash,readonly=on,file=/S10image/disk.s10hw2 +@end example + + +QEMU emulates the following peripherals: + +@itemize @minus +@item +UltraSparc IIi APB PCI Bridge +@item +PCI VGA compatible card with VESA Bochs Extensions +@item +PS/2 mouse and keyboard +@item +Non Volatile RAM M48T59 +@item +PC-compatible serial ports +@item +2 PCI IDE interfaces with hard disk and CD-ROM support +@item +Floppy disk +@end itemize + +@c man begin OPTIONS + +The following options are specific to the Sparc64 emulation: + +@table @option + +@item -prom-env @var{string} + +Set OpenBIOS variables in NVRAM, for example: + +@example +qemu-system-sparc64 -prom-env 'auto-boot?=false' +@end example + +@item -M [sun4u|sun4v|niagara] + +Set the emulated machine type. The default is sun4u. + +@end table + +@c man end + diff --git a/docs/system/target-xtensa.texi b/docs/system/target-xtensa.texi new file mode 100644 index 0000000000..08b0b36299 --- /dev/null +++ b/docs/system/target-xtensa.texi @@ -0,0 +1,56 @@ +@node Xtensa System emulator +@section Xtensa System emulator +@cindex system emulation (Xtensa) + +Two executables cover simulation of both Xtensa endian options, +@file{qemu-system-xtensa} and @file{qemu-system-xtensaeb}. +Two different machine types are emulated: + +@itemize @minus +@item +Xtensa emulator pseudo board "sim" +@item +Avnet LX60/LX110/LX200 board +@end itemize + +The sim pseudo board emulation provides an environment similar +to one provided by the proprietary Tensilica ISS. +It supports: + +@itemize @minus +@item +A range of Xtensa CPUs, default is the DC232B +@item +Console and filesystem access via semihosting calls +@end itemize + +The Avnet LX60/LX110/LX200 emulation supports: + +@itemize @minus +@item +A range of Xtensa CPUs, default is the DC232B +@item +16550 UART +@item +OpenCores 10/100 Mbps Ethernet MAC +@end itemize + +@c man begin OPTIONS + +The following options are specific to the Xtensa emulation: + +@table @option + +@item -semihosting +Enable semihosting syscall emulation. + +Xtensa semihosting provides basic file IO calls, such as open/read/write/seek/select. +Tensilica baremetal libc for ISS and linux platform "sim" use this interface. + +Note that this allows guest direct access to the host filesystem, +so should only be used with trusted guest OS. + +@end table + +@c man end + diff --git a/qemu-doc.texi b/qemu-doc.texi index 40fab523f3..f702dce455 100644 --- a/qemu-doc.texi +++ b/qemu-doc.texi @@ -176,874 +176,17 @@ various targets are mentioned in the following sections. * MIPS System emulator:: * ARM System emulator:: * ColdFire System emulator:: -* Cris System emulator:: -* Microblaze System emulator:: -* SH4 System emulator:: * Xtensa System emulator:: @end menu -@node x86 (PC) System emulator -@section x86 (PC) System emulator -@cindex system emulation (PC) - -@menu -* pcsys_devices:: Peripherals -* cpu_models_x86:: Supported CPU model configurations on x86 hosts -* pcsys_req:: OS requirements -@end menu - -@node pcsys_devices -@subsection Peripherals - -@c man begin DESCRIPTION - -The QEMU PC System emulator simulates the following peripherals: - -@itemize @minus -@item -i440FX host PCI bridge and PIIX3 PCI to ISA bridge -@item -Cirrus CLGD 5446 PCI VGA card or dummy VGA card with Bochs VESA -extensions (hardware level, including all non standard modes). -@item -PS/2 mouse and keyboard -@item -2 PCI IDE interfaces with hard disk and CD-ROM support -@item -Floppy disk -@item -PCI and ISA network adapters -@item -Serial ports -@item -IPMI BMC, either and internal or external one -@item -Creative SoundBlaster 16 sound card -@item -ENSONIQ AudioPCI ES1370 sound card -@item -Intel 82801AA AC97 Audio compatible sound card -@item -Intel HD Audio Controller and HDA codec -@item -Adlib (OPL2) - Yamaha YM3812 compatible chip -@item -Gravis Ultrasound GF1 sound card -@item -CS4231A compatible sound card -@item -PCI UHCI, OHCI, EHCI or XHCI USB controller and a virtual USB-1.1 hub. -@end itemize - -SMP is supported with up to 255 CPUs. - -QEMU uses the PC BIOS from the Seabios project and the Plex86/Bochs LGPL -VGA BIOS. - -QEMU uses YM3812 emulation by Tatsuyuki Satoh. - -QEMU uses GUS emulation (GUSEMU32 @url{http://www.deinmeister.de/gusemu/}) -by Tibor "TS" Schütz. - -Note that, by default, GUS shares IRQ(7) with parallel ports and so -QEMU must be told to not have parallel ports to have working GUS. - -@example -@value{qemu_system_x86} dos.img -soundhw gus -parallel none -@end example - -Alternatively: -@example -@value{qemu_system_x86} dos.img -device gus,irq=5 -@end example - -Or some other unclaimed IRQ. - -CS4231A is the chip used in Windows Sound System and GUSMAX products - -@c man end - -@lowersections -@include docs/system/cpu-models-x86.texi -@raisesections - -@node pcsys_req -@subsection OS requirements - -On x86_64 hosts, the default set of CPU features enabled by the KVM accelerator -require the host to be running Linux v4.5 or newer. Red Hat Enterprise Linux -7 is also supported, since the required functionality was backported. - -@node PowerPC System emulator -@section PowerPC System emulator -@cindex system emulation (PowerPC) - -Use the executable @file{qemu-system-ppc} to simulate a complete 40P (PREP) -or PowerMac PowerPC system. - -QEMU emulates the following PowerMac peripherals: - -@itemize @minus -@item -UniNorth or Grackle PCI Bridge -@item -PCI VGA compatible card with VESA Bochs Extensions -@item -2 PMAC IDE interfaces with hard disk and CD-ROM support -@item -NE2000 PCI adapters -@item -Non Volatile RAM -@item -VIA-CUDA with ADB keyboard and mouse. -@end itemize - -QEMU emulates the following 40P (PREP) peripherals: - -@itemize @minus -@item -PCI Bridge -@item -PCI VGA compatible card with VESA Bochs Extensions -@item -2 IDE interfaces with hard disk and CD-ROM support -@item -Floppy disk -@item -PCnet network adapters -@item -Serial port -@item -PREP Non Volatile RAM -@item -PC compatible keyboard and mouse. -@end itemize - -Since version 0.9.1, QEMU uses OpenBIOS @url{https://www.openbios.org/} -for the g3beige and mac99 PowerMac and the 40p machines. OpenBIOS is a free -(GPL v2) portable firmware implementation. The goal is to implement a 100% -IEEE 1275-1994 (referred to as Open Firmware) compliant firmware. - -@c man begin OPTIONS - -The following options are specific to the PowerPC emulation: - -@table @option - -@item -g @var{W}x@var{H}[x@var{DEPTH}] - -Set the initial VGA graphic mode. The default is 800x600x32. - -@item -prom-env @var{string} - -Set OpenBIOS variables in NVRAM, for example: - -@example -qemu-system-ppc -prom-env 'auto-boot?=false' \ - -prom-env 'boot-device=hd:2,\yaboot' \ - -prom-env 'boot-args=conf=hd:2,\yaboot.conf' -@end example - -@end table - -@c man end - - -More information is available at -@url{http://perso.magic.fr/l_indien/qemu-ppc/}. - -@node Sparc32 System emulator -@section Sparc32 System emulator -@cindex system emulation (Sparc32) - -Use the executable @file{qemu-system-sparc} to simulate the following -Sun4m architecture machines: -@itemize @minus -@item -SPARCstation 4 -@item -SPARCstation 5 -@item -SPARCstation 10 -@item -SPARCstation 20 -@item -SPARCserver 600MP -@item -SPARCstation LX -@item -SPARCstation Voyager -@item -SPARCclassic -@item -SPARCbook -@end itemize - -The emulation is somewhat complete. SMP up to 16 CPUs is supported, -but Linux limits the number of usable CPUs to 4. - -QEMU emulates the following sun4m peripherals: - -@itemize @minus -@item -IOMMU -@item -TCX or cgthree Frame buffer -@item -Lance (Am7990) Ethernet -@item -Non Volatile RAM M48T02/M48T08 -@item -Slave I/O: timers, interrupt controllers, Zilog serial ports, keyboard -and power/reset logic -@item -ESP SCSI controller with hard disk and CD-ROM support -@item -Floppy drive (not on SS-600MP) -@item -CS4231 sound device (only on SS-5, not working yet) -@end itemize - -The number of peripherals is fixed in the architecture. Maximum -memory size depends on the machine type, for SS-5 it is 256MB and for -others 2047MB. - -Since version 0.8.2, QEMU uses OpenBIOS -@url{https://www.openbios.org/}. OpenBIOS is a free (GPL v2) portable -firmware implementation. The goal is to implement a 100% IEEE -1275-1994 (referred to as Open Firmware) compliant firmware. - -A sample Linux 2.6 series kernel and ram disk image are available on -the QEMU web site. There are still issues with NetBSD and OpenBSD, but -most kernel versions work. Please note that currently older Solaris kernels -don't work probably due to interface issues between OpenBIOS and -Solaris. - -@c man begin OPTIONS - -The following options are specific to the Sparc32 emulation: - -@table @option - -@item -g @var{W}x@var{H}x[x@var{DEPTH}] - -Set the initial graphics mode. For TCX, the default is 1024x768x8 with the -option of 1024x768x24. For cgthree, the default is 1024x768x8 with the option -of 1152x900x8 for people who wish to use OBP. - -@item -prom-env @var{string} - -Set OpenBIOS variables in NVRAM, for example: - -@example -qemu-system-sparc -prom-env 'auto-boot?=false' \ - -prom-env 'boot-device=sd(0,2,0):d' -prom-env 'boot-args=linux single' -@end example - -@item -M [SS-4|SS-5|SS-10|SS-20|SS-600MP|LX|Voyager|SPARCClassic] [|SPARCbook] - -Set the emulated machine type. Default is SS-5. - -@end table - -@c man end - -@node Sparc64 System emulator -@section Sparc64 System emulator -@cindex system emulation (Sparc64) - -Use the executable @file{qemu-system-sparc64} to simulate a Sun4u -(UltraSPARC PC-like machine), Sun4v (T1 PC-like machine), or generic -Niagara (T1) machine. The Sun4u emulator is mostly complete, being -able to run Linux, NetBSD and OpenBSD in headless (-nographic) mode. The -Sun4v emulator is still a work in progress. - -The Niagara T1 emulator makes use of firmware and OS binaries supplied in the S10image/ directory -of the OpenSPARC T1 project @url{http://download.oracle.com/technetwork/systems/opensparc/OpenSPARCT1_Arch.1.5.tar.bz2} -and is able to boot the disk.s10hw2 Solaris image. -@example -qemu-system-sparc64 -M niagara -L /path-to/S10image/ \ - -nographic -m 256 \ - -drive if=pflash,readonly=on,file=/S10image/disk.s10hw2 -@end example - - -QEMU emulates the following peripherals: - -@itemize @minus -@item -UltraSparc IIi APB PCI Bridge -@item -PCI VGA compatible card with VESA Bochs Extensions -@item -PS/2 mouse and keyboard -@item -Non Volatile RAM M48T59 -@item -PC-compatible serial ports -@item -2 PCI IDE interfaces with hard disk and CD-ROM support -@item -Floppy disk -@end itemize - -@c man begin OPTIONS - -The following options are specific to the Sparc64 emulation: - -@table @option - -@item -prom-env @var{string} - -Set OpenBIOS variables in NVRAM, for example: - -@example -qemu-system-sparc64 -prom-env 'auto-boot?=false' -@end example - -@item -M [sun4u|sun4v|niagara] - -Set the emulated machine type. The default is sun4u. - -@end table - -@c man end - -@node MIPS System emulator -@section MIPS System emulator -@cindex system emulation (MIPS) - -@menu -* recommendations_cpu_models_MIPS:: Supported CPU model configurations on MIPS hosts -* nanoMIPS System emulator :: -@end menu - -Four executables cover simulation of 32 and 64-bit MIPS systems in -both endian options, @file{qemu-system-mips}, @file{qemu-system-mipsel} -@file{qemu-system-mips64} and @file{qemu-system-mips64el}. -Five different machine types are emulated: - -@itemize @minus -@item -A generic ISA PC-like machine "mips" -@item -The MIPS Malta prototype board "malta" -@item -An ACER Pica "pica61". This machine needs the 64-bit emulator. -@item -MIPS emulator pseudo board "mipssim" -@item -A MIPS Magnum R4000 machine "magnum". This machine needs the 64-bit emulator. -@end itemize - -The generic emulation is supported by Debian 'Etch' and is able to -install Debian into a virtual disk image. The following devices are -emulated: - -@itemize @minus -@item -A range of MIPS CPUs, default is the 24Kf -@item -PC style serial port -@item -PC style IDE disk -@item -NE2000 network card -@end itemize - -The Malta emulation supports the following devices: - -@itemize @minus -@item -Core board with MIPS 24Kf CPU and Galileo system controller -@item -PIIX4 PCI/USB/SMbus controller -@item -The Multi-I/O chip's serial device -@item -PCI network cards (PCnet32 and others) -@item -Malta FPGA serial device -@item -Cirrus (default) or any other PCI VGA graphics card -@end itemize - -The Boston board emulation supports the following devices: - -@itemize @minus -@item -Xilinx FPGA, which includes a PCIe root port and an UART -@item -Intel EG20T PCH connects the I/O peripherals, but only the SATA bus is emulated -@end itemize - -The ACER Pica emulation supports: - -@itemize @minus -@item -MIPS R4000 CPU -@item -PC-style IRQ and DMA controllers -@item -PC Keyboard -@item -IDE controller -@end itemize - -The MIPS Magnum R4000 emulation supports: - -@itemize @minus -@item -MIPS R4000 CPU -@item -PC-style IRQ controller -@item -PC Keyboard -@item -SCSI controller -@item -G364 framebuffer -@end itemize - -The Fulong 2E emulation supports: - -@itemize @minus -@item -Loongson 2E CPU -@item -Bonito64 system controller as North Bridge -@item -VT82C686 chipset as South Bridge -@item -RTL8139D as a network card chipset -@end itemize - -The mipssim pseudo board emulation provides an environment similar -to what the proprietary MIPS emulator uses for running Linux. -It supports: - -@itemize @minus -@item -A range of MIPS CPUs, default is the 24Kf -@item -PC style serial port -@item -MIPSnet network emulation -@end itemize - -@lowersections -@include docs/system/cpu-models-mips.texi -@raisesections - -@node nanoMIPS System emulator -@subsection nanoMIPS System emulator -@cindex system emulation (nanoMIPS) - -Executable @file{qemu-system-mipsel} also covers simulation of -32-bit nanoMIPS system in little endian mode: - -@itemize @minus -@item -nanoMIPS I7200 CPU -@end itemize - -Example of @file{qemu-system-mipsel} usage for nanoMIPS is shown below: - -Download @code{} from @url{https://mipsdistros.mips.com/LinuxDistro/nanomips/buildroot/index.html}. - -Download @code{} from @url{https://mipsdistros.mips.com/LinuxDistro/nanomips/kernels/v4.15.18-432-gb2eb9a8b07a1-20180627102142/index.html}. - -Start system emulation of Malta board with nanoMIPS I7200 CPU: -@example -qemu-system-mipsel -cpu I7200 -kernel @code{} \ - -M malta -serial stdio -m @code{} -hda @code{} \ - -append "mem=256m@@0x0 rw console=ttyS0 vga=cirrus vesa=0x111 root=/dev/sda" -@end example - - -@node ARM System emulator -@section ARM System emulator -@cindex system emulation (ARM) - -Use the executable @file{qemu-system-arm} to simulate a ARM -machine. The ARM Integrator/CP board is emulated with the following -devices: - -@itemize @minus -@item -ARM926E, ARM1026E, ARM946E, ARM1136 or Cortex-A8 CPU -@item -Two PL011 UARTs -@item -SMC 91c111 Ethernet adapter -@item -PL110 LCD controller -@item -PL050 KMI with PS/2 keyboard and mouse. -@item -PL181 MultiMedia Card Interface with SD card. -@end itemize - -The ARM Versatile baseboard is emulated with the following devices: - -@itemize @minus -@item -ARM926E, ARM1136 or Cortex-A8 CPU -@item -PL190 Vectored Interrupt Controller -@item -Four PL011 UARTs -@item -SMC 91c111 Ethernet adapter -@item -PL110 LCD controller -@item -PL050 KMI with PS/2 keyboard and mouse. -@item -PCI host bridge. Note the emulated PCI bridge only provides access to -PCI memory space. It does not provide access to PCI IO space. -This means some devices (eg. ne2k_pci NIC) are not usable, and others -(eg. rtl8139 NIC) are only usable when the guest drivers use the memory -mapped control registers. -@item -PCI OHCI USB controller. -@item -LSI53C895A PCI SCSI Host Bus Adapter with hard disk and CD-ROM devices. -@item -PL181 MultiMedia Card Interface with SD card. -@end itemize - -Several variants of the ARM RealView baseboard are emulated, -including the EB, PB-A8 and PBX-A9. Due to interactions with the -bootloader, only certain Linux kernel configurations work out -of the box on these boards. - -Kernels for the PB-A8 board should have CONFIG_REALVIEW_HIGH_PHYS_OFFSET -enabled in the kernel, and expect 512M RAM. Kernels for The PBX-A9 board -should have CONFIG_SPARSEMEM enabled, CONFIG_REALVIEW_HIGH_PHYS_OFFSET -disabled and expect 1024M RAM. - -The following devices are emulated: - -@itemize @minus -@item -ARM926E, ARM1136, ARM11MPCore, Cortex-A8 or Cortex-A9 MPCore CPU -@item -ARM AMBA Generic/Distributed Interrupt Controller -@item -Four PL011 UARTs -@item -SMC 91c111 or SMSC LAN9118 Ethernet adapter -@item -PL110 LCD controller -@item -PL050 KMI with PS/2 keyboard and mouse -@item -PCI host bridge -@item -PCI OHCI USB controller -@item -LSI53C895A PCI SCSI Host Bus Adapter with hard disk and CD-ROM devices -@item -PL181 MultiMedia Card Interface with SD card. -@end itemize - -The XScale-based clamshell PDA models ("Spitz", "Akita", "Borzoi" -and "Terrier") emulation includes the following peripherals: - -@itemize @minus -@item -Intel PXA270 System-on-chip (ARM V5TE core) -@item -NAND Flash memory -@item -IBM/Hitachi DSCM microdrive in a PXA PCMCIA slot - not in "Akita" -@item -On-chip OHCI USB controller -@item -On-chip LCD controller -@item -On-chip Real Time Clock -@item -TI ADS7846 touchscreen controller on SSP bus -@item -Maxim MAX1111 analog-digital converter on I@math{^2}C bus -@item -GPIO-connected keyboard controller and LEDs -@item -Secure Digital card connected to PXA MMC/SD host -@item -Three on-chip UARTs -@item -WM8750 audio CODEC on I@math{^2}C and I@math{^2}S busses -@end itemize - -The Palm Tungsten|E PDA (codename "Cheetah") emulation includes the -following elements: - -@itemize @minus -@item -Texas Instruments OMAP310 System-on-chip (ARM 925T core) -@item -ROM and RAM memories (ROM firmware image can be loaded with -option-rom) -@item -On-chip LCD controller -@item -On-chip Real Time Clock -@item -TI TSC2102i touchscreen controller / analog-digital converter / Audio -CODEC, connected through MicroWire and I@math{^2}S busses -@item -GPIO-connected matrix keypad -@item -Secure Digital card connected to OMAP MMC/SD host -@item -Three on-chip UARTs -@end itemize - -Nokia N800 and N810 internet tablets (known also as RX-34 and RX-44 / 48) -emulation supports the following elements: - -@itemize @minus -@item -Texas Instruments OMAP2420 System-on-chip (ARM 1136 core) -@item -RAM and non-volatile OneNAND Flash memories -@item -Display connected to EPSON remote framebuffer chip and OMAP on-chip -display controller and a LS041y3 MIPI DBI-C controller -@item -TI TSC2301 (in N800) and TI TSC2005 (in N810) touchscreen controllers -driven through SPI bus -@item -National Semiconductor LM8323-controlled qwerty keyboard driven -through I@math{^2}C bus -@item -Secure Digital card connected to OMAP MMC/SD host -@item -Three OMAP on-chip UARTs and on-chip STI debugging console -@item -Mentor Graphics "Inventra" dual-role USB controller embedded in a TI -TUSB6010 chip - only USB host mode is supported -@item -TI TMP105 temperature sensor driven through I@math{^2}C bus -@item -TI TWL92230C power management companion with an RTC on I@math{^2}C bus -@item -Nokia RETU and TAHVO multi-purpose chips with an RTC, connected -through CBUS -@end itemize - -The Luminary Micro Stellaris LM3S811EVB emulation includes the following -devices: - -@itemize @minus -@item -Cortex-M3 CPU core. -@item -64k Flash and 8k SRAM. -@item -Timers, UARTs, ADC and I@math{^2}C interface. -@item -OSRAM Pictiva 96x16 OLED with SSD0303 controller on I@math{^2}C bus. -@end itemize - -The Luminary Micro Stellaris LM3S6965EVB emulation includes the following -devices: - -@itemize @minus -@item -Cortex-M3 CPU core. -@item -256k Flash and 64k SRAM. -@item -Timers, UARTs, ADC, I@math{^2}C and SSI interfaces. -@item -OSRAM Pictiva 128x64 OLED with SSD0323 controller connected via SSI. -@end itemize - -The Freecom MusicPal internet radio emulation includes the following -elements: - -@itemize @minus -@item -Marvell MV88W8618 ARM core. -@item -32 MB RAM, 256 KB SRAM, 8 MB flash. -@item -Up to 2 16550 UARTs -@item -MV88W8xx8 Ethernet controller -@item -MV88W8618 audio controller, WM8750 CODEC and mixer -@item -128×64 display with brightness control -@item -2 buttons, 2 navigation wheels with button function -@end itemize - -The Siemens SX1 models v1 and v2 (default) basic emulation. -The emulation includes the following elements: - -@itemize @minus -@item -Texas Instruments OMAP310 System-on-chip (ARM 925T core) -@item -ROM and RAM memories (ROM firmware image can be loaded with -pflash) -V1 -1 Flash of 16MB and 1 Flash of 8MB -V2 -1 Flash of 32MB -@item -On-chip LCD controller -@item -On-chip Real Time Clock -@item -Secure Digital card connected to OMAP MMC/SD host -@item -Three on-chip UARTs -@end itemize - -A Linux 2.6 test image is available on the QEMU web site. More -information is available in the QEMU mailing-list archive. - -@c man begin OPTIONS - -The following options are specific to the ARM emulation: - -@table @option - -@item -semihosting -Enable semihosting syscall emulation. - -On ARM this implements the "Angel" interface. - -Note that this allows guest direct access to the host filesystem, -so should only be used with trusted guest OS. - -@end table - -@c man end - -@node ColdFire System emulator -@section ColdFire System emulator -@cindex system emulation (ColdFire) -@cindex system emulation (M68K) - -Use the executable @file{qemu-system-m68k} to simulate a ColdFire machine. -The emulator is able to boot a uClinux kernel. - -The M5208EVB emulation includes the following devices: - -@itemize @minus -@item -MCF5208 ColdFire V2 Microprocessor (ISA A+ with EMAC). -@item -Three Two on-chip UARTs. -@item -Fast Ethernet Controller (FEC) -@end itemize - -The AN5206 emulation includes the following devices: - -@itemize @minus -@item -MCF5206 ColdFire V2 Microprocessor. -@item -Two on-chip UARTs. -@end itemize - -@c man begin OPTIONS - -The following options are specific to the ColdFire emulation: - -@table @option - -@item -semihosting -Enable semihosting syscall emulation. - -On M68K this implements the "ColdFire GDB" interface used by libgloss. - -Note that this allows guest direct access to the host filesystem, -so should only be used with trusted guest OS. - -@end table - -@c man end - -@node Cris System emulator -@section Cris System emulator -@cindex system emulation (Cris) - -TODO - -@node Microblaze System emulator -@section Microblaze System emulator -@cindex system emulation (Microblaze) - -TODO - -@node SH4 System emulator -@section SH4 System emulator -@cindex system emulation (SH4) - -TODO - -@node Xtensa System emulator -@section Xtensa System emulator -@cindex system emulation (Xtensa) - -Two executables cover simulation of both Xtensa endian options, -@file{qemu-system-xtensa} and @file{qemu-system-xtensaeb}. -Two different machine types are emulated: - -@itemize @minus -@item -Xtensa emulator pseudo board "sim" -@item -Avnet LX60/LX110/LX200 board -@end itemize - -The sim pseudo board emulation provides an environment similar -to one provided by the proprietary Tensilica ISS. -It supports: - -@itemize @minus -@item -A range of Xtensa CPUs, default is the DC232B -@item -Console and filesystem access via semihosting calls -@end itemize - -The Avnet LX60/LX110/LX200 emulation supports: - -@itemize @minus -@item -A range of Xtensa CPUs, default is the DC232B -@item -16550 UART -@item -OpenCores 10/100 Mbps Ethernet MAC -@end itemize - -@c man begin OPTIONS - -The following options are specific to the Xtensa emulation: - -@table @option - -@item -semihosting -Enable semihosting syscall emulation. - -Xtensa semihosting provides basic file IO calls, such as open/read/write/seek/select. -Tensilica baremetal libc for ISS and linux platform "sim" use this interface. - -Note that this allows guest direct access to the host filesystem, -so should only be used with trusted guest OS. - -@end table - -@c man end +@include docs/system/target-i386.texi +@include docs/system/target-ppc.texi +@include docs/system/target-sparc.texi +@include docs/system/target-sparc64.texi +@include docs/system/target-mips.texi +@include docs/system/target-arm.texi +@include docs/system/target-m68k.texi +@include docs/system/target-xtensa.texi @include docs/security.texi -- cgit v1.2.3-55-g7522 From 2147106172266c3f38b167ead97bd17eeaab85a0 Mon Sep 17 00:00:00 2001 From: Paolo Bonzini Date: Fri, 28 Feb 2020 15:35:56 +0000 Subject: qemu-doc: move qemu-tech.texi into main section The only remaining content in qemu-tech.texi is a few paragraphs about managed start up options. Move them in the main section about full system emulation. Signed-off-by: Paolo Bonzini Reviewed-by: Peter Maydell Reviewed-by: Alex Bennée Tested-by: Alex Bennée Signed-off-by: Peter Maydell Message-id: 20200228153619.9906-11-peter.maydell@linaro.org Message-id: 20200226113034.6741-11-pbonzini@redhat.com Reviewed-by: Peter Maydell Signed-off-by: Peter Maydell --- Makefile | 2 +- docs/system/managed-startup.texi | 35 +++++++++++++++++++++++++++++++++ qemu-doc.texi | 5 ++--- qemu-tech.texi | 42 ---------------------------------------- 4 files changed, 38 insertions(+), 46 deletions(-) create mode 100644 docs/system/managed-startup.texi delete mode 100644 qemu-tech.texi (limited to 'docs/system') diff --git a/Makefile b/Makefile index 9790a0fd15..56382a4593 100644 --- a/Makefile +++ b/Makefile @@ -1120,7 +1120,7 @@ txt: qemu-doc.txt docs/interop/qemu-qmp-ref.txt docs/interop/qemu-ga-ref.txt qemu-doc.html qemu-doc.info qemu-doc.pdf qemu-doc.txt: \ qemu-options.texi \ - qemu-tech.texi qemu-option-trace.texi \ + qemu-option-trace.texi \ qemu-deprecated.texi qemu-monitor.texi \ qemu-monitor-info.texi \ docs/system/quickstart.texi \ diff --git a/docs/system/managed-startup.texi b/docs/system/managed-startup.texi new file mode 100644 index 0000000000..ec168095cc --- /dev/null +++ b/docs/system/managed-startup.texi @@ -0,0 +1,35 @@ +@node managed_startup +@section Managed start up options + +In system mode emulation, it's possible to create a VM in a paused state using +the -S command line option. In this state the machine is completely initialized +according to command line options and ready to execute VM code but VCPU threads +are not executing any code. The VM state in this paused state depends on the way +QEMU was started. It could be in: +@table @asis +@item initial state (after reset/power on state) +@item with direct kernel loading, the initial state could be amended to execute +code loaded by QEMU in the VM's RAM and with incoming migration +@item with incoming migration, initial state will by amended with the migrated +machine state after migration completes. +@end table + +This paused state is typically used by users to query machine state and/or +additionally configure the machine (by hotplugging devices) in runtime before +allowing VM code to run. + +However, at the -S pause point, it's impossible to configure options that affect +initial VM creation (like: -smp/-m/-numa ...) or cold plug devices. The +experimental --preconfig command line option allows pausing QEMU +before the initial VM creation, in a ``preconfig'' state, where additional +queries and configuration can be performed via QMP before moving on to +the resulting configuration startup. In the preconfig state, QEMU only allows +a limited set of commands over the QMP monitor, where the commands do not +depend on an initialized machine, including but not limited to: +@table @asis +@item qmp_capabilities +@item query-qmp-schema +@item query-commands +@item query-status +@item x-exit-preconfig +@end table diff --git a/qemu-doc.texi b/qemu-doc.texi index f702dce455..e4bff7edbe 100644 --- a/qemu-doc.texi +++ b/qemu-doc.texi @@ -39,7 +39,6 @@ * QEMU System emulator:: * QEMU System emulator targets:: * Security:: -* Implementation notes:: * Deprecated features:: * Recently removed features:: * Supported build platforms:: @@ -144,6 +143,7 @@ accelerator is required to use more than one host CPU for emulation. * vnc_security:: VNC security * network_tls:: TLS setup for network services * gdb_usage:: GDB usage +* managed_startup:: Managed startup options @end menu @include docs/system/quickstart.texi @@ -159,6 +159,7 @@ accelerator is required to use more than one host CPU for emulation. @include docs/system/vnc-security.texi @include docs/system/tls.texi @include docs/system/gdb.texi +@include docs/system/managed-startup.texi @node QEMU System emulator targets @chapter QEMU System emulator targets @@ -190,8 +191,6 @@ various targets are mentioned in the following sections. @include docs/security.texi -@include qemu-tech.texi - @include qemu-deprecated.texi @include docs/system/build-platforms.texi diff --git a/qemu-tech.texi b/qemu-tech.texi deleted file mode 100644 index 35da6a40af..0000000000 --- a/qemu-tech.texi +++ /dev/null @@ -1,42 +0,0 @@ -@node Implementation notes -@appendix Implementation notes - -@menu -* Managed start up options:: -@end menu - -@node Managed start up options -@section Managed start up options - -In system mode emulation, it's possible to create a VM in a paused state using -the -S command line option. In this state the machine is completely initialized -according to command line options and ready to execute VM code but VCPU threads -are not executing any code. The VM state in this paused state depends on the way -QEMU was started. It could be in: -@table @asis -@item initial state (after reset/power on state) -@item with direct kernel loading, the initial state could be amended to execute -code loaded by QEMU in the VM's RAM and with incoming migration -@item with incoming migration, initial state will by amended with the migrated -machine state after migration completes. -@end table - -This paused state is typically used by users to query machine state and/or -additionally configure the machine (by hotplugging devices) in runtime before -allowing VM code to run. - -However, at the -S pause point, it's impossible to configure options that affect -initial VM creation (like: -smp/-m/-numa ...) or cold plug devices. The -experimental --preconfig command line option allows pausing QEMU -before the initial VM creation, in a ``preconfig'' state, where additional -queries and configuration can be performed via QMP before moving on to -the resulting configuration startup. In the preconfig state, QEMU only allows -a limited set of commands over the QMP monitor, where the commands do not -depend on an initialized machine, including but not limited to: -@table @asis -@item qmp_capabilities -@item query-qmp-schema -@item query-commands -@item query-status -@item x-exit-preconfig -@end table -- cgit v1.2.3-55-g7522 From abcd92db6a7b725e16826ee2e3fcb13cfe3a96c2 Mon Sep 17 00:00:00 2001 From: Paolo Bonzini Date: Fri, 28 Feb 2020 15:35:57 +0000 Subject: qemu-doc: move included files to docs/system Since qemu-doc.texi is mostly including files from docs/system, move the existing include files there for consistency. Signed-off-by: Paolo Bonzini Reviewed-by: Peter Maydell Reviewed-by: Alex Bennée Tested-by: Alex Bennée Signed-off-by: Peter Maydell Message-id: 20200228153619.9906-12-peter.maydell@linaro.org Message-id: 20200226113034.6741-12-pbonzini@redhat.com [PMM: update MAINTAINERS line for qemu-option-trace.texi] Reviewed-by: Peter Maydell Signed-off-by: Peter Maydell --- MAINTAINERS | 5 +- Makefile | 8 +- docs/security.texi | 167 ---------------- docs/system/deprecated.texi | 377 +++++++++++++++++++++++++++++++++++++ docs/system/qemu-option-trace.texi | 28 +++ docs/system/security.texi | 167 ++++++++++++++++ qemu-deprecated.texi | 377 ------------------------------------- qemu-doc.texi | 4 +- qemu-option-trace.texi | 28 --- qemu-options.hx | 2 +- 10 files changed, 582 insertions(+), 581 deletions(-) delete mode 100644 docs/security.texi create mode 100644 docs/system/deprecated.texi create mode 100644 docs/system/qemu-option-trace.texi create mode 100644 docs/system/security.texi delete mode 100644 qemu-deprecated.texi delete mode 100644 qemu-option-trace.texi (limited to 'docs/system') diff --git a/MAINTAINERS b/MAINTAINERS index 615615c32f..584264535c 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -2234,7 +2234,7 @@ M: Stefan Hajnoczi S: Maintained F: trace/ F: trace-events -F: qemu-option-trace.texi +F: docs/system/qemu-option-trace.texi F: scripts/tracetool.py F: scripts/tracetool/ F: scripts/qemu-trace-stap* @@ -2804,7 +2804,8 @@ F: contrib/gitdm/* Incompatible changes R: libvir-list@redhat.com -F: qemu-deprecated.texi +F: docs/system/deprecated.texi +F: docs/system/deprecated.rst Build System ------------ diff --git a/Makefile b/Makefile index 56382a4593..7e60a43542 100644 --- a/Makefile +++ b/Makefile @@ -1110,7 +1110,7 @@ docs/interop/qemu-ga-qapi.texi: qga/qapi-generated/qga-qapi-doc.texi @cp -p $< $@ qemu.1: qemu-doc.texi qemu-options.texi qemu-monitor.texi qemu-monitor-info.texi -qemu.1: qemu-option-trace.texi +qemu.1: docs/system/qemu-option-trace.texi docs/system/qemu-cpu-models.7: docs/system/qemu-cpu-models.texi docs/system/cpu-models-x86.texi docs/system/cpu-models-mips.texi html: qemu-doc.html docs/interop/qemu-qmp-ref.html docs/interop/qemu-ga-ref.html sphinxdocs @@ -1120,8 +1120,7 @@ txt: qemu-doc.txt docs/interop/qemu-qmp-ref.txt docs/interop/qemu-ga-ref.txt qemu-doc.html qemu-doc.info qemu-doc.pdf qemu-doc.txt: \ qemu-options.texi \ - qemu-option-trace.texi \ - qemu-deprecated.texi qemu-monitor.texi \ + qemu-monitor.texi \ qemu-monitor-info.texi \ docs/system/quickstart.texi \ docs/system/invocation.texi \ @@ -1140,7 +1139,8 @@ qemu-doc.html qemu-doc.info qemu-doc.pdf qemu-doc.txt: \ docs/system/build-platforms.texi \ docs/system/license.texi \ docs/system/cpu-models-x86.texi docs/system/cpu-models-mips.texi \ - docs/security.texi + docs/system/deprecated.texi docs/system/qemu-option-trace.texi \ + docs/system/security.texi docs/interop/qemu-ga-ref.dvi docs/interop/qemu-ga-ref.html \ docs/interop/qemu-ga-ref.info docs/interop/qemu-ga-ref.pdf \ diff --git a/docs/security.texi b/docs/security.texi deleted file mode 100644 index 0d6b30edfc..0000000000 --- a/docs/security.texi +++ /dev/null @@ -1,167 +0,0 @@ -@node Security -@chapter Security - -@section Overview - -This chapter explains the security requirements that QEMU is designed to meet -and principles for securely deploying QEMU. - -@section Security Requirements - -QEMU supports many different use cases, some of which have stricter security -requirements than others. The community has agreed on the overall security -requirements that users may depend on. These requirements define what is -considered supported from a security perspective. - -@subsection Virtualization Use Case - -The virtualization use case covers cloud and virtual private server (VPS) -hosting, as well as traditional data center and desktop virtualization. These -use cases rely on hardware virtualization extensions to execute guest code -safely on the physical CPU at close-to-native speed. - -The following entities are untrusted, meaning that they may be buggy or -malicious: - -@itemize -@item Guest -@item User-facing interfaces (e.g. VNC, SPICE, WebSocket) -@item Network protocols (e.g. NBD, live migration) -@item User-supplied files (e.g. disk images, kernels, device trees) -@item Passthrough devices (e.g. PCI, USB) -@end itemize - -Bugs affecting these entities are evaluated on whether they can cause damage in -real-world use cases and treated as security bugs if this is the case. - -@subsection Non-virtualization Use Case - -The non-virtualization use case covers emulation using the Tiny Code Generator -(TCG). In principle the TCG and device emulation code used in conjunction with -the non-virtualization use case should meet the same security requirements as -the virtualization use case. However, for historical reasons much of the -non-virtualization use case code was not written with these security -requirements in mind. - -Bugs affecting the non-virtualization use case are not considered security -bugs at this time. Users with non-virtualization use cases must not rely on -QEMU to provide guest isolation or any security guarantees. - -@section Architecture - -This section describes the design principles that ensure the security -requirements are met. - -@subsection Guest Isolation - -Guest isolation is the confinement of guest code to the virtual machine. When -guest code gains control of execution on the host this is called escaping the -virtual machine. Isolation also includes resource limits such as throttling of -CPU, memory, disk, or network. Guests must be unable to exceed their resource -limits. - -QEMU presents an attack surface to the guest in the form of emulated devices. -The guest must not be able to gain control of QEMU. Bugs in emulated devices -could allow malicious guests to gain code execution in QEMU. At this point the -guest has escaped the virtual machine and is able to act in the context of the -QEMU process on the host. - -Guests often interact with other guests and share resources with them. A -malicious guest must not gain control of other guests or access their data. -Disk image files and network traffic must be protected from other guests unless -explicitly shared between them by the user. - -@subsection Principle of Least Privilege - -The principle of least privilege states that each component only has access to -the privileges necessary for its function. In the case of QEMU this means that -each process only has access to resources belonging to the guest. - -The QEMU process should not have access to any resources that are inaccessible -to the guest. This way the guest does not gain anything by escaping into the -QEMU process since it already has access to those same resources from within -the guest. - -Following the principle of least privilege immediately fulfills guest isolation -requirements. For example, guest A only has access to its own disk image file -@code{a.img} and not guest B's disk image file @code{b.img}. - -In reality certain resources are inaccessible to the guest but must be -available to QEMU to perform its function. For example, host system calls are -necessary for QEMU but are not exposed to guests. A guest that escapes into -the QEMU process can then begin invoking host system calls. - -New features must be designed to follow the principle of least privilege. -Should this not be possible for technical reasons, the security risk must be -clearly documented so users are aware of the trade-off of enabling the feature. - -@subsection Isolation mechanisms - -Several isolation mechanisms are available to realize this architecture of -guest isolation and the principle of least privilege. With the exception of -Linux seccomp, these mechanisms are all deployed by management tools that -launch QEMU, such as libvirt. They are also platform-specific so they are only -described briefly for Linux here. - -The fundamental isolation mechanism is that QEMU processes must run as -unprivileged users. Sometimes it seems more convenient to launch QEMU as -root to give it access to host devices (e.g. @code{/dev/net/tun}) but this poses a -huge security risk. File descriptor passing can be used to give an otherwise -unprivileged QEMU process access to host devices without running QEMU as root. -It is also possible to launch QEMU as a non-root user and configure UNIX groups -for access to @code{/dev/kvm}, @code{/dev/net/tun}, and other device nodes. -Some Linux distros already ship with UNIX groups for these devices by default. - -@itemize -@item SELinux and AppArmor make it possible to confine processes beyond the -traditional UNIX process and file permissions model. They restrict the QEMU -process from accessing processes and files on the host system that are not -needed by QEMU. - -@item Resource limits and cgroup controllers provide throughput and utilization -limits on key resources such as CPU time, memory, and I/O bandwidth. - -@item Linux namespaces can be used to make process, file system, and other system -resources unavailable to QEMU. A namespaced QEMU process is restricted to only -those resources that were granted to it. - -@item Linux seccomp is available via the QEMU @option{--sandbox} option. It disables -system calls that are not needed by QEMU, thereby reducing the host kernel -attack surface. -@end itemize - -@section Sensitive configurations - -There are aspects of QEMU that can have security implications which users & -management applications must be aware of. - -@subsection Monitor console (QMP and HMP) - -The monitor console (whether used with QMP or HMP) provides an interface -to dynamically control many aspects of QEMU's runtime operation. Many of the -commands exposed will instruct QEMU to access content on the host file system -and/or trigger spawning of external processes. - -For example, the @code{migrate} command allows for the spawning of arbitrary -processes for the purpose of tunnelling the migration data stream. The -@code{blockdev-add} command instructs QEMU to open arbitrary files, exposing -their content to the guest as a virtual disk. - -Unless QEMU is otherwise confined using technologies such as SELinux, AppArmor, -or Linux namespaces, the monitor console should be considered to have privileges -equivalent to those of the user account QEMU is running under. - -It is further important to consider the security of the character device backend -over which the monitor console is exposed. It needs to have protection against -malicious third parties which might try to make unauthorized connections, or -perform man-in-the-middle attacks. Many of the character device backends do not -satisfy this requirement and so must not be used for the monitor console. - -The general recommendation is that the monitor console should be exposed over -a UNIX domain socket backend to the local host only. Use of the TCP based -character device backend is inappropriate unless configured to use both TLS -encryption and authorization control policy on client connections. - -In summary, the monitor console is considered a privileged control interface to -QEMU and as such should only be made accessible to a trusted management -application or user. diff --git a/docs/system/deprecated.texi b/docs/system/deprecated.texi new file mode 100644 index 0000000000..66eca3a1de --- /dev/null +++ b/docs/system/deprecated.texi @@ -0,0 +1,377 @@ +@node Deprecated features +@appendix Deprecated features + +In general features are intended to be supported indefinitely once +introduced into QEMU. In the event that a feature needs to be removed, +it will be listed in this appendix. The feature will remain functional +for 2 releases prior to actual removal. Deprecated features may also +generate warnings on the console when QEMU starts up, or if activated +via a monitor command, however, this is not a mandatory requirement. + +Prior to the 2.10.0 release there was no official policy on how +long features would be deprecated prior to their removal, nor +any documented list of which features were deprecated. Thus +any features deprecated prior to 2.10.0 will be treated as if +they were first deprecated in the 2.10.0 release. + +What follows is a list of all features currently marked as +deprecated. + +@section System emulator command line arguments + +@subsection -machine enforce-config-section=on|off (since 3.1) + +The @option{enforce-config-section} parameter is replaced by the +@option{-global migration.send-configuration=@var{on|off}} option. + +@subsection -no-kvm (since 1.3.0) + +The ``-no-kvm'' argument is now a synonym for setting ``-accel tcg''. + +@subsection -usbdevice (since 2.10.0) + +The ``-usbdevice DEV'' argument is now a synonym for setting +the ``-device usb-DEV'' argument instead. The deprecated syntax +would automatically enable USB support on the machine type. +If using the new syntax, USB support must be explicitly +enabled via the ``-machine usb=on'' argument. + +@subsection -drive file=json:@{...@{'driver':'file'@}@} (since 3.0) + +The 'file' driver for drives is no longer appropriate for character or host +devices and will only accept regular files (S_IFREG). The correct driver +for these file types is 'host_cdrom' or 'host_device' as appropriate. + +@subsection -net ...,name=@var{name} (since 3.1) + +The @option{name} parameter of the @option{-net} option is a synonym +for the @option{id} parameter, which should now be used instead. + +@subsection -smp (invalid topologies) (since 3.1) + +CPU topology properties should describe whole machine topology including +possible CPUs. + +However, historically it was possible to start QEMU with an incorrect topology +where @math{@var{n} <= @var{sockets} * @var{cores} * @var{threads} < @var{maxcpus}}, +which could lead to an incorrect topology enumeration by the guest. +Support for invalid topologies will be removed, the user must ensure +topologies described with -smp include all possible cpus, i.e. + @math{@var{sockets} * @var{cores} * @var{threads} = @var{maxcpus}}. + +@subsection -vnc acl (since 4.0.0) + +The @code{acl} option to the @code{-vnc} argument has been replaced +by the @code{tls-authz} and @code{sasl-authz} options. + +@subsection QEMU_AUDIO_ environment variables and -audio-help (since 4.0) + +The ``-audiodev'' argument is now the preferred way to specify audio +backend settings instead of environment variables. To ease migration to +the new format, the ``-audiodev-help'' option can be used to convert +the current values of the environment variables to ``-audiodev'' options. + +@subsection Creating sound card devices and vnc without audiodev= property (since 4.2) + +When not using the deprecated legacy audio config, each sound card +should specify an @code{audiodev=} property. Additionally, when using +vnc, you should specify an @code{audiodev=} propery if you plan to +transmit audio through the VNC protocol. + +@subsection -mon ...,control=readline,pretty=on|off (since 4.1) + +The @code{pretty=on|off} switch has no effect for HMP monitors, but is +silently ignored. Using the switch with HMP monitors will become an +error in the future. + +@subsection -realtime (since 4.1) + +The @code{-realtime mlock=on|off} argument has been replaced by the +@code{-overcommit mem-lock=on|off} argument. + +@subsection -numa node,mem=@var{size} (since 4.1) + +The parameter @option{mem} of @option{-numa node} is used to assign a part of +guest RAM to a NUMA node. But when using it, it's impossible to manage specified +RAM chunk on the host side (like bind it to a host node, setting bind policy, ...), +so guest end-ups with the fake NUMA configuration with suboptiomal performance. +However since 2014 there is an alternative way to assign RAM to a NUMA node +using parameter @option{memdev}, which does the same as @option{mem} and adds +means to actualy manage node RAM on the host side. Use parameter @option{memdev} +with @var{memory-backend-ram} backend as an replacement for parameter @option{mem} +to achieve the same fake NUMA effect or a properly configured +@var{memory-backend-file} backend to actually benefit from NUMA configuration. +In future new machine versions will not accept the option but it will still +work with old machine types. User can check QAPI schema to see if the legacy +option is supported by looking at MachineInfo::numa-mem-supported property. + +@subsection -numa node (without memory specified) (since 4.1) + +Splitting RAM by default between NUMA nodes has the same issues as @option{mem} +parameter described above with the difference that the role of the user plays +QEMU using implicit generic or board specific splitting rule. +Use @option{memdev} with @var{memory-backend-ram} backend or @option{mem} (if +it's supported by used machine type) to define mapping explictly instead. + +@subsection RISC-V -bios (since 4.1) + +QEMU 4.1 introduced support for the -bios option in QEMU for RISC-V for the +RISC-V virt machine and sifive_u machine. + +QEMU 4.1 has no changes to the default behaviour to avoid breakages. This +default will change in a future QEMU release, so please prepare now. All users +of the virt or sifive_u machine must change their command line usage. + +QEMU 4.1 has three options, please migrate to one of these three: + 1. ``-bios none`` - This is the current default behavior if no -bios option + is included. QEMU will not automatically load any firmware. It is up + to the user to load all the images they need. + 2. ``-bios default`` - In a future QEMU release this will become the default + behaviour if no -bios option is specified. This option will load the + default OpenSBI firmware automatically. The firmware is included with + the QEMU release and no user interaction is required. All a user needs + to do is specify the kernel they want to boot with the -kernel option + 3. ``-bios `` - Tells QEMU to load the specified file as the firmwrae. + +@subsection -tb-size option (since 5.0) + +QEMU 5.0 introduced an alternative syntax to specify the size of the translation +block cache, @option{-accel tcg,tb-size=}. The new syntax deprecates the +previously available @option{-tb-size} option. + +@subsection -show-cursor option (since 5.0) + +Use @option{-display sdl,show-cursor=on} or + @option{-display gtk,show-cursor=on} instead. + +@section QEMU Machine Protocol (QMP) commands + +@subsection change (since 2.5.0) + +Use ``blockdev-change-medium'' or ``change-vnc-password'' instead. + +@subsection migrate_set_downtime and migrate_set_speed (since 2.8.0) + +Use ``migrate-set-parameters'' instead. + +@subsection migrate-set-cache-size and query-migrate-cache-size (since 2.11.0) + +Use ``migrate-set-parameters'' and ``query-migrate-parameters'' instead. + +@subsection query-block result field dirty-bitmaps[i].status (since 4.0) + +The ``status'' field of the ``BlockDirtyInfo'' structure, returned by +the query-block command is deprecated. Two new boolean fields, +``recording'' and ``busy'' effectively replace it. + +@subsection query-block result field dirty-bitmaps (Since 4.2) + +The ``dirty-bitmaps`` field of the ``BlockInfo`` structure, returned by +the query-block command is itself now deprecated. The ``dirty-bitmaps`` +field of the ``BlockDeviceInfo`` struct should be used instead, which is the +type of the ``inserted`` field in query-block replies, as well as the +type of array items in query-named-block-nodes. + +Since the ``dirty-bitmaps`` field is optionally present in both the old and +new locations, clients must use introspection to learn where to anticipate +the field if/when it does appear in command output. + +@subsection query-cpus (since 2.12.0) + +The ``query-cpus'' command is replaced by the ``query-cpus-fast'' command. + +@subsection query-cpus-fast "arch" output member (since 3.0.0) + +The ``arch'' output member of the ``query-cpus-fast'' command is +replaced by the ``target'' output member. + +@subsection cpu-add (since 4.0) + +Use ``device_add'' for hotplugging vCPUs instead of ``cpu-add''. See +documentation of ``query-hotpluggable-cpus'' for additional +details. + +@subsection query-events (since 4.0) + +The ``query-events'' command has been superseded by the more powerful +and accurate ``query-qmp-schema'' command. + +@subsection chardev client socket with 'wait' option (since 4.0) + +Character devices creating sockets in client mode should not specify +the 'wait' field, which is only applicable to sockets in server mode + +@section Human Monitor Protocol (HMP) commands + +@subsection The hub_id parameter of 'hostfwd_add' / 'hostfwd_remove' (since 3.1) + +The @option{[hub_id name]} parameter tuple of the 'hostfwd_add' and +'hostfwd_remove' HMP commands has been replaced by @option{netdev_id}. + +@subsection cpu-add (since 4.0) + +Use ``device_add'' for hotplugging vCPUs instead of ``cpu-add''. See +documentation of ``query-hotpluggable-cpus'' for additional details. + +@subsection acl_show, acl_reset, acl_policy, acl_add, acl_remove (since 4.0.0) + +The ``acl_show'', ``acl_reset'', ``acl_policy'', ``acl_add'', and +``acl_remove'' commands are deprecated with no replacement. Authorization +for VNC should be performed using the pluggable QAuthZ objects. + +@section Guest Emulator ISAs + +@subsection RISC-V ISA privledge specification version 1.09.1 (since 4.1) + +The RISC-V ISA privledge specification version 1.09.1 has been deprecated. +QEMU supports both the newer version 1.10.0 and the ratified version 1.11.0, these +should be used instead of the 1.09.1 version. + +@section System emulator CPUS + +@subsection RISC-V ISA CPUs (since 4.1) + +The RISC-V cpus with the ISA version in the CPU name have been depcreated. The +four CPUs are: ``rv32gcsu-v1.9.1``, ``rv32gcsu-v1.10.0``, ``rv64gcsu-v1.9.1`` and +``rv64gcsu-v1.10.0``. Instead the version can be specified via the CPU ``priv_spec`` +option when using the ``rv32`` or ``rv64`` CPUs. + +@subsection RISC-V ISA CPUs (since 4.1) + +The RISC-V no MMU cpus have been depcreated. The two CPUs: ``rv32imacu-nommu`` and +``rv64imacu-nommu`` should no longer be used. Instead the MMU status can be specified +via the CPU ``mmu`` option when using the ``rv32`` or ``rv64`` CPUs. + +@section System emulator devices + +@subsection ide-drive (since 4.2) + +The 'ide-drive' device is deprecated. Users should use 'ide-hd' or +'ide-cd' as appropriate to get an IDE hard disk or CD-ROM as needed. + +@subsection scsi-disk (since 4.2) + +The 'scsi-disk' device is deprecated. Users should use 'scsi-hd' or +'scsi-cd' as appropriate to get a SCSI hard disk or CD-ROM as needed. + +@section System emulator machines + +@subsection mips r4k platform (since 5.0) + +This machine type is very old and unmaintained. Users should use the 'malta' +machine type instead. + +@subsection pc-1.0, pc-1.1, pc-1.2 and pc-1.3 (since 5.0) + +These machine types are very old and likely can not be used for live migration +from old QEMU versions anymore. A newer machine type should be used instead. + +@subsection spike_v1.9.1 and spike_v1.10 (since 4.1) + +The version specific Spike machines have been deprecated in favour of the +generic ``spike`` machine. If you need to specify an older version of the RISC-V +spec you can use the ``-cpu rv64gcsu,priv_spec=v1.9.1`` command line argument. + +@section Device options + +@subsection Emulated device options + +@subsubsection -device virtio-blk,scsi=on|off (since 5.0.0) + +The virtio-blk SCSI passthrough feature is a legacy VIRTIO feature. VIRTIO 1.0 +and later do not support it because the virtio-scsi device was introduced for +full SCSI support. Use virtio-scsi instead when SCSI passthrough is required. + +Note this also applies to ``-device virtio-blk-pci,scsi=on|off'', which is an +alias. + +@subsection Block device options + +@subsubsection "backing": "" (since 2.12.0) + +In order to prevent QEMU from automatically opening an image's backing +chain, use ``"backing": null'' instead. + +@subsubsection rbd keyvalue pair encoded filenames: "" (since 3.1.0) + +Options for ``rbd'' should be specified according to its runtime options, +like other block drivers. Legacy parsing of keyvalue pair encoded +filenames is useful to open images with the old format for backing files; +These image files should be updated to use the current format. + +Example of legacy encoding: + +@code{json:@{"file.driver":"rbd", "file.filename":"rbd:rbd/name"@}} + +The above, converted to the current supported format: + +@code{json:@{"file.driver":"rbd", "file.pool":"rbd", "file.image":"name"@}} + +@section Related binaries + +@subsection qemu-img convert -n -o (since 4.2.0) + +All options specified in @option{-o} are image creation options, so +they have no effect when used with @option{-n} to skip image creation. +Silently ignored options can be confusing, so this combination of +options will be made an error in future versions. + +@section Backwards compatibility + +@subsection Runnability guarantee of CPU models (since 4.1.0) + +Previous versions of QEMU never changed existing CPU models in +ways that introduced additional host software or hardware +requirements to the VM. This allowed management software to +safely change the machine type of an existing VM without +introducing new requirements ("runnability guarantee"). This +prevented CPU models from being updated to include CPU +vulnerability mitigations, leaving guests vulnerable in the +default configuration. + +The CPU model runnability guarantee won't apply anymore to +existing CPU models. Management software that needs runnability +guarantees must resolve the CPU model aliases using te +``alias-of'' field returned by the ``query-cpu-definitions'' QMP +command. + +While those guarantees are kept, the return value of +``query-cpu-definitions'' will have existing CPU model aliases +point to a version that doesn't break runnability guarantees +(specifically, version 1 of those CPU models). In future QEMU +versions, aliases will point to newer CPU model versions +depending on the machine type, so management software must +resolve CPU model aliases before starting a virtual machine. + + +@node Recently removed features +@appendix Recently removed features + +What follows is a record of recently removed, formerly deprecated +features that serves as a record for users who have encountered +trouble after a recent upgrade. + +@section QEMU Machine Protocol (QMP) commands + +@subsection block-dirty-bitmap-add "autoload" parameter (since 4.2.0) + +The "autoload" parameter has been ignored since 2.12.0. All bitmaps +are automatically loaded from qcow2 images. + +@section Related binaries + +@subsection qemu-nbd --partition (removed in 5.0.0) + +The ``qemu-nbd --partition $digit'' code (also spelled @option{-P}) +could only handle MBR partitions, and never correctly handled logical +partitions beyond partition 5. Exporting a partition can still be +done by utilizing the @option{--image-opts} option with a raw blockdev +using the @code{offset} and @code{size} parameters layered on top of +any other existing blockdev. For example, if partition 1 is 100MiB +long starting at 1MiB, the old command: + +@code{qemu-nbd -t -P 1 -f qcow2 file.qcow2} + +can be rewritten as: + +@code{qemu-nbd -t --image-opts driver=raw,offset=1M,size=100M,file.driver=qcow2,file.file.driver=file,file.file.filename=file.qcow2} diff --git a/docs/system/qemu-option-trace.texi b/docs/system/qemu-option-trace.texi new file mode 100644 index 0000000000..162f1528d2 --- /dev/null +++ b/docs/system/qemu-option-trace.texi @@ -0,0 +1,28 @@ +@c The contents of this file must be kept in sync with qemu-option-trace.rst.inc +@c until all the users of the texi file have been converted to rst and +@c the texi file can be removed. + +Specify tracing options. + +@table @option +@item [enable=]@var{pattern} +Immediately enable events matching @var{pattern} +(either event name or a globbing pattern). This option is only +available if QEMU has been compiled with the @var{simple}, @var{log} +or @var{ftrace} tracing backend. To specify multiple events or patterns, +specify the @option{-trace} option multiple times. + +Use @code{-trace help} to print a list of names of trace points. + +@item events=@var{file} +Immediately enable events listed in @var{file}. +The file must contain one event name (as listed in the @file{trace-events-all} +file) per line; globbing patterns are accepted too. This option is only +available if QEMU has been compiled with the @var{simple}, @var{log} or +@var{ftrace} tracing backend. + +@item file=@var{file} +Log output traces to @var{file}. +This option is only available if QEMU has been compiled with +the @var{simple} tracing backend. +@end table diff --git a/docs/system/security.texi b/docs/system/security.texi new file mode 100644 index 0000000000..0d6b30edfc --- /dev/null +++ b/docs/system/security.texi @@ -0,0 +1,167 @@ +@node Security +@chapter Security + +@section Overview + +This chapter explains the security requirements that QEMU is designed to meet +and principles for securely deploying QEMU. + +@section Security Requirements + +QEMU supports many different use cases, some of which have stricter security +requirements than others. The community has agreed on the overall security +requirements that users may depend on. These requirements define what is +considered supported from a security perspective. + +@subsection Virtualization Use Case + +The virtualization use case covers cloud and virtual private server (VPS) +hosting, as well as traditional data center and desktop virtualization. These +use cases rely on hardware virtualization extensions to execute guest code +safely on the physical CPU at close-to-native speed. + +The following entities are untrusted, meaning that they may be buggy or +malicious: + +@itemize +@item Guest +@item User-facing interfaces (e.g. VNC, SPICE, WebSocket) +@item Network protocols (e.g. NBD, live migration) +@item User-supplied files (e.g. disk images, kernels, device trees) +@item Passthrough devices (e.g. PCI, USB) +@end itemize + +Bugs affecting these entities are evaluated on whether they can cause damage in +real-world use cases and treated as security bugs if this is the case. + +@subsection Non-virtualization Use Case + +The non-virtualization use case covers emulation using the Tiny Code Generator +(TCG). In principle the TCG and device emulation code used in conjunction with +the non-virtualization use case should meet the same security requirements as +the virtualization use case. However, for historical reasons much of the +non-virtualization use case code was not written with these security +requirements in mind. + +Bugs affecting the non-virtualization use case are not considered security +bugs at this time. Users with non-virtualization use cases must not rely on +QEMU to provide guest isolation or any security guarantees. + +@section Architecture + +This section describes the design principles that ensure the security +requirements are met. + +@subsection Guest Isolation + +Guest isolation is the confinement of guest code to the virtual machine. When +guest code gains control of execution on the host this is called escaping the +virtual machine. Isolation also includes resource limits such as throttling of +CPU, memory, disk, or network. Guests must be unable to exceed their resource +limits. + +QEMU presents an attack surface to the guest in the form of emulated devices. +The guest must not be able to gain control of QEMU. Bugs in emulated devices +could allow malicious guests to gain code execution in QEMU. At this point the +guest has escaped the virtual machine and is able to act in the context of the +QEMU process on the host. + +Guests often interact with other guests and share resources with them. A +malicious guest must not gain control of other guests or access their data. +Disk image files and network traffic must be protected from other guests unless +explicitly shared between them by the user. + +@subsection Principle of Least Privilege + +The principle of least privilege states that each component only has access to +the privileges necessary for its function. In the case of QEMU this means that +each process only has access to resources belonging to the guest. + +The QEMU process should not have access to any resources that are inaccessible +to the guest. This way the guest does not gain anything by escaping into the +QEMU process since it already has access to those same resources from within +the guest. + +Following the principle of least privilege immediately fulfills guest isolation +requirements. For example, guest A only has access to its own disk image file +@code{a.img} and not guest B's disk image file @code{b.img}. + +In reality certain resources are inaccessible to the guest but must be +available to QEMU to perform its function. For example, host system calls are +necessary for QEMU but are not exposed to guests. A guest that escapes into +the QEMU process can then begin invoking host system calls. + +New features must be designed to follow the principle of least privilege. +Should this not be possible for technical reasons, the security risk must be +clearly documented so users are aware of the trade-off of enabling the feature. + +@subsection Isolation mechanisms + +Several isolation mechanisms are available to realize this architecture of +guest isolation and the principle of least privilege. With the exception of +Linux seccomp, these mechanisms are all deployed by management tools that +launch QEMU, such as libvirt. They are also platform-specific so they are only +described briefly for Linux here. + +The fundamental isolation mechanism is that QEMU processes must run as +unprivileged users. Sometimes it seems more convenient to launch QEMU as +root to give it access to host devices (e.g. @code{/dev/net/tun}) but this poses a +huge security risk. File descriptor passing can be used to give an otherwise +unprivileged QEMU process access to host devices without running QEMU as root. +It is also possible to launch QEMU as a non-root user and configure UNIX groups +for access to @code{/dev/kvm}, @code{/dev/net/tun}, and other device nodes. +Some Linux distros already ship with UNIX groups for these devices by default. + +@itemize +@item SELinux and AppArmor make it possible to confine processes beyond the +traditional UNIX process and file permissions model. They restrict the QEMU +process from accessing processes and files on the host system that are not +needed by QEMU. + +@item Resource limits and cgroup controllers provide throughput and utilization +limits on key resources such as CPU time, memory, and I/O bandwidth. + +@item Linux namespaces can be used to make process, file system, and other system +resources unavailable to QEMU. A namespaced QEMU process is restricted to only +those resources that were granted to it. + +@item Linux seccomp is available via the QEMU @option{--sandbox} option. It disables +system calls that are not needed by QEMU, thereby reducing the host kernel +attack surface. +@end itemize + +@section Sensitive configurations + +There are aspects of QEMU that can have security implications which users & +management applications must be aware of. + +@subsection Monitor console (QMP and HMP) + +The monitor console (whether used with QMP or HMP) provides an interface +to dynamically control many aspects of QEMU's runtime operation. Many of the +commands exposed will instruct QEMU to access content on the host file system +and/or trigger spawning of external processes. + +For example, the @code{migrate} command allows for the spawning of arbitrary +processes for the purpose of tunnelling the migration data stream. The +@code{blockdev-add} command instructs QEMU to open arbitrary files, exposing +their content to the guest as a virtual disk. + +Unless QEMU is otherwise confined using technologies such as SELinux, AppArmor, +or Linux namespaces, the monitor console should be considered to have privileges +equivalent to those of the user account QEMU is running under. + +It is further important to consider the security of the character device backend +over which the monitor console is exposed. It needs to have protection against +malicious third parties which might try to make unauthorized connections, or +perform man-in-the-middle attacks. Many of the character device backends do not +satisfy this requirement and so must not be used for the monitor console. + +The general recommendation is that the monitor console should be exposed over +a UNIX domain socket backend to the local host only. Use of the TCP based +character device backend is inappropriate unless configured to use both TLS +encryption and authorization control policy on client connections. + +In summary, the monitor console is considered a privileged control interface to +QEMU and as such should only be made accessible to a trusted management +application or user. diff --git a/qemu-deprecated.texi b/qemu-deprecated.texi deleted file mode 100644 index 66eca3a1de..0000000000 --- a/qemu-deprecated.texi +++ /dev/null @@ -1,377 +0,0 @@ -@node Deprecated features -@appendix Deprecated features - -In general features are intended to be supported indefinitely once -introduced into QEMU. In the event that a feature needs to be removed, -it will be listed in this appendix. The feature will remain functional -for 2 releases prior to actual removal. Deprecated features may also -generate warnings on the console when QEMU starts up, or if activated -via a monitor command, however, this is not a mandatory requirement. - -Prior to the 2.10.0 release there was no official policy on how -long features would be deprecated prior to their removal, nor -any documented list of which features were deprecated. Thus -any features deprecated prior to 2.10.0 will be treated as if -they were first deprecated in the 2.10.0 release. - -What follows is a list of all features currently marked as -deprecated. - -@section System emulator command line arguments - -@subsection -machine enforce-config-section=on|off (since 3.1) - -The @option{enforce-config-section} parameter is replaced by the -@option{-global migration.send-configuration=@var{on|off}} option. - -@subsection -no-kvm (since 1.3.0) - -The ``-no-kvm'' argument is now a synonym for setting ``-accel tcg''. - -@subsection -usbdevice (since 2.10.0) - -The ``-usbdevice DEV'' argument is now a synonym for setting -the ``-device usb-DEV'' argument instead. The deprecated syntax -would automatically enable USB support on the machine type. -If using the new syntax, USB support must be explicitly -enabled via the ``-machine usb=on'' argument. - -@subsection -drive file=json:@{...@{'driver':'file'@}@} (since 3.0) - -The 'file' driver for drives is no longer appropriate for character or host -devices and will only accept regular files (S_IFREG). The correct driver -for these file types is 'host_cdrom' or 'host_device' as appropriate. - -@subsection -net ...,name=@var{name} (since 3.1) - -The @option{name} parameter of the @option{-net} option is a synonym -for the @option{id} parameter, which should now be used instead. - -@subsection -smp (invalid topologies) (since 3.1) - -CPU topology properties should describe whole machine topology including -possible CPUs. - -However, historically it was possible to start QEMU with an incorrect topology -where @math{@var{n} <= @var{sockets} * @var{cores} * @var{threads} < @var{maxcpus}}, -which could lead to an incorrect topology enumeration by the guest. -Support for invalid topologies will be removed, the user must ensure -topologies described with -smp include all possible cpus, i.e. - @math{@var{sockets} * @var{cores} * @var{threads} = @var{maxcpus}}. - -@subsection -vnc acl (since 4.0.0) - -The @code{acl} option to the @code{-vnc} argument has been replaced -by the @code{tls-authz} and @code{sasl-authz} options. - -@subsection QEMU_AUDIO_ environment variables and -audio-help (since 4.0) - -The ``-audiodev'' argument is now the preferred way to specify audio -backend settings instead of environment variables. To ease migration to -the new format, the ``-audiodev-help'' option can be used to convert -the current values of the environment variables to ``-audiodev'' options. - -@subsection Creating sound card devices and vnc without audiodev= property (since 4.2) - -When not using the deprecated legacy audio config, each sound card -should specify an @code{audiodev=} property. Additionally, when using -vnc, you should specify an @code{audiodev=} propery if you plan to -transmit audio through the VNC protocol. - -@subsection -mon ...,control=readline,pretty=on|off (since 4.1) - -The @code{pretty=on|off} switch has no effect for HMP monitors, but is -silently ignored. Using the switch with HMP monitors will become an -error in the future. - -@subsection -realtime (since 4.1) - -The @code{-realtime mlock=on|off} argument has been replaced by the -@code{-overcommit mem-lock=on|off} argument. - -@subsection -numa node,mem=@var{size} (since 4.1) - -The parameter @option{mem} of @option{-numa node} is used to assign a part of -guest RAM to a NUMA node. But when using it, it's impossible to manage specified -RAM chunk on the host side (like bind it to a host node, setting bind policy, ...), -so guest end-ups with the fake NUMA configuration with suboptiomal performance. -However since 2014 there is an alternative way to assign RAM to a NUMA node -using parameter @option{memdev}, which does the same as @option{mem} and adds -means to actualy manage node RAM on the host side. Use parameter @option{memdev} -with @var{memory-backend-ram} backend as an replacement for parameter @option{mem} -to achieve the same fake NUMA effect or a properly configured -@var{memory-backend-file} backend to actually benefit from NUMA configuration. -In future new machine versions will not accept the option but it will still -work with old machine types. User can check QAPI schema to see if the legacy -option is supported by looking at MachineInfo::numa-mem-supported property. - -@subsection -numa node (without memory specified) (since 4.1) - -Splitting RAM by default between NUMA nodes has the same issues as @option{mem} -parameter described above with the difference that the role of the user plays -QEMU using implicit generic or board specific splitting rule. -Use @option{memdev} with @var{memory-backend-ram} backend or @option{mem} (if -it's supported by used machine type) to define mapping explictly instead. - -@subsection RISC-V -bios (since 4.1) - -QEMU 4.1 introduced support for the -bios option in QEMU for RISC-V for the -RISC-V virt machine and sifive_u machine. - -QEMU 4.1 has no changes to the default behaviour to avoid breakages. This -default will change in a future QEMU release, so please prepare now. All users -of the virt or sifive_u machine must change their command line usage. - -QEMU 4.1 has three options, please migrate to one of these three: - 1. ``-bios none`` - This is the current default behavior if no -bios option - is included. QEMU will not automatically load any firmware. It is up - to the user to load all the images they need. - 2. ``-bios default`` - In a future QEMU release this will become the default - behaviour if no -bios option is specified. This option will load the - default OpenSBI firmware automatically. The firmware is included with - the QEMU release and no user interaction is required. All a user needs - to do is specify the kernel they want to boot with the -kernel option - 3. ``-bios `` - Tells QEMU to load the specified file as the firmwrae. - -@subsection -tb-size option (since 5.0) - -QEMU 5.0 introduced an alternative syntax to specify the size of the translation -block cache, @option{-accel tcg,tb-size=}. The new syntax deprecates the -previously available @option{-tb-size} option. - -@subsection -show-cursor option (since 5.0) - -Use @option{-display sdl,show-cursor=on} or - @option{-display gtk,show-cursor=on} instead. - -@section QEMU Machine Protocol (QMP) commands - -@subsection change (since 2.5.0) - -Use ``blockdev-change-medium'' or ``change-vnc-password'' instead. - -@subsection migrate_set_downtime and migrate_set_speed (since 2.8.0) - -Use ``migrate-set-parameters'' instead. - -@subsection migrate-set-cache-size and query-migrate-cache-size (since 2.11.0) - -Use ``migrate-set-parameters'' and ``query-migrate-parameters'' instead. - -@subsection query-block result field dirty-bitmaps[i].status (since 4.0) - -The ``status'' field of the ``BlockDirtyInfo'' structure, returned by -the query-block command is deprecated. Two new boolean fields, -``recording'' and ``busy'' effectively replace it. - -@subsection query-block result field dirty-bitmaps (Since 4.2) - -The ``dirty-bitmaps`` field of the ``BlockInfo`` structure, returned by -the query-block command is itself now deprecated. The ``dirty-bitmaps`` -field of the ``BlockDeviceInfo`` struct should be used instead, which is the -type of the ``inserted`` field in query-block replies, as well as the -type of array items in query-named-block-nodes. - -Since the ``dirty-bitmaps`` field is optionally present in both the old and -new locations, clients must use introspection to learn where to anticipate -the field if/when it does appear in command output. - -@subsection query-cpus (since 2.12.0) - -The ``query-cpus'' command is replaced by the ``query-cpus-fast'' command. - -@subsection query-cpus-fast "arch" output member (since 3.0.0) - -The ``arch'' output member of the ``query-cpus-fast'' command is -replaced by the ``target'' output member. - -@subsection cpu-add (since 4.0) - -Use ``device_add'' for hotplugging vCPUs instead of ``cpu-add''. See -documentation of ``query-hotpluggable-cpus'' for additional -details. - -@subsection query-events (since 4.0) - -The ``query-events'' command has been superseded by the more powerful -and accurate ``query-qmp-schema'' command. - -@subsection chardev client socket with 'wait' option (since 4.0) - -Character devices creating sockets in client mode should not specify -the 'wait' field, which is only applicable to sockets in server mode - -@section Human Monitor Protocol (HMP) commands - -@subsection The hub_id parameter of 'hostfwd_add' / 'hostfwd_remove' (since 3.1) - -The @option{[hub_id name]} parameter tuple of the 'hostfwd_add' and -'hostfwd_remove' HMP commands has been replaced by @option{netdev_id}. - -@subsection cpu-add (since 4.0) - -Use ``device_add'' for hotplugging vCPUs instead of ``cpu-add''. See -documentation of ``query-hotpluggable-cpus'' for additional details. - -@subsection acl_show, acl_reset, acl_policy, acl_add, acl_remove (since 4.0.0) - -The ``acl_show'', ``acl_reset'', ``acl_policy'', ``acl_add'', and -``acl_remove'' commands are deprecated with no replacement. Authorization -for VNC should be performed using the pluggable QAuthZ objects. - -@section Guest Emulator ISAs - -@subsection RISC-V ISA privledge specification version 1.09.1 (since 4.1) - -The RISC-V ISA privledge specification version 1.09.1 has been deprecated. -QEMU supports both the newer version 1.10.0 and the ratified version 1.11.0, these -should be used instead of the 1.09.1 version. - -@section System emulator CPUS - -@subsection RISC-V ISA CPUs (since 4.1) - -The RISC-V cpus with the ISA version in the CPU name have been depcreated. The -four CPUs are: ``rv32gcsu-v1.9.1``, ``rv32gcsu-v1.10.0``, ``rv64gcsu-v1.9.1`` and -``rv64gcsu-v1.10.0``. Instead the version can be specified via the CPU ``priv_spec`` -option when using the ``rv32`` or ``rv64`` CPUs. - -@subsection RISC-V ISA CPUs (since 4.1) - -The RISC-V no MMU cpus have been depcreated. The two CPUs: ``rv32imacu-nommu`` and -``rv64imacu-nommu`` should no longer be used. Instead the MMU status can be specified -via the CPU ``mmu`` option when using the ``rv32`` or ``rv64`` CPUs. - -@section System emulator devices - -@subsection ide-drive (since 4.2) - -The 'ide-drive' device is deprecated. Users should use 'ide-hd' or -'ide-cd' as appropriate to get an IDE hard disk or CD-ROM as needed. - -@subsection scsi-disk (since 4.2) - -The 'scsi-disk' device is deprecated. Users should use 'scsi-hd' or -'scsi-cd' as appropriate to get a SCSI hard disk or CD-ROM as needed. - -@section System emulator machines - -@subsection mips r4k platform (since 5.0) - -This machine type is very old and unmaintained. Users should use the 'malta' -machine type instead. - -@subsection pc-1.0, pc-1.1, pc-1.2 and pc-1.3 (since 5.0) - -These machine types are very old and likely can not be used for live migration -from old QEMU versions anymore. A newer machine type should be used instead. - -@subsection spike_v1.9.1 and spike_v1.10 (since 4.1) - -The version specific Spike machines have been deprecated in favour of the -generic ``spike`` machine. If you need to specify an older version of the RISC-V -spec you can use the ``-cpu rv64gcsu,priv_spec=v1.9.1`` command line argument. - -@section Device options - -@subsection Emulated device options - -@subsubsection -device virtio-blk,scsi=on|off (since 5.0.0) - -The virtio-blk SCSI passthrough feature is a legacy VIRTIO feature. VIRTIO 1.0 -and later do not support it because the virtio-scsi device was introduced for -full SCSI support. Use virtio-scsi instead when SCSI passthrough is required. - -Note this also applies to ``-device virtio-blk-pci,scsi=on|off'', which is an -alias. - -@subsection Block device options - -@subsubsection "backing": "" (since 2.12.0) - -In order to prevent QEMU from automatically opening an image's backing -chain, use ``"backing": null'' instead. - -@subsubsection rbd keyvalue pair encoded filenames: "" (since 3.1.0) - -Options for ``rbd'' should be specified according to its runtime options, -like other block drivers. Legacy parsing of keyvalue pair encoded -filenames is useful to open images with the old format for backing files; -These image files should be updated to use the current format. - -Example of legacy encoding: - -@code{json:@{"file.driver":"rbd", "file.filename":"rbd:rbd/name"@}} - -The above, converted to the current supported format: - -@code{json:@{"file.driver":"rbd", "file.pool":"rbd", "file.image":"name"@}} - -@section Related binaries - -@subsection qemu-img convert -n -o (since 4.2.0) - -All options specified in @option{-o} are image creation options, so -they have no effect when used with @option{-n} to skip image creation. -Silently ignored options can be confusing, so this combination of -options will be made an error in future versions. - -@section Backwards compatibility - -@subsection Runnability guarantee of CPU models (since 4.1.0) - -Previous versions of QEMU never changed existing CPU models in -ways that introduced additional host software or hardware -requirements to the VM. This allowed management software to -safely change the machine type of an existing VM without -introducing new requirements ("runnability guarantee"). This -prevented CPU models from being updated to include CPU -vulnerability mitigations, leaving guests vulnerable in the -default configuration. - -The CPU model runnability guarantee won't apply anymore to -existing CPU models. Management software that needs runnability -guarantees must resolve the CPU model aliases using te -``alias-of'' field returned by the ``query-cpu-definitions'' QMP -command. - -While those guarantees are kept, the return value of -``query-cpu-definitions'' will have existing CPU model aliases -point to a version that doesn't break runnability guarantees -(specifically, version 1 of those CPU models). In future QEMU -versions, aliases will point to newer CPU model versions -depending on the machine type, so management software must -resolve CPU model aliases before starting a virtual machine. - - -@node Recently removed features -@appendix Recently removed features - -What follows is a record of recently removed, formerly deprecated -features that serves as a record for users who have encountered -trouble after a recent upgrade. - -@section QEMU Machine Protocol (QMP) commands - -@subsection block-dirty-bitmap-add "autoload" parameter (since 4.2.0) - -The "autoload" parameter has been ignored since 2.12.0. All bitmaps -are automatically loaded from qcow2 images. - -@section Related binaries - -@subsection qemu-nbd --partition (removed in 5.0.0) - -The ``qemu-nbd --partition $digit'' code (also spelled @option{-P}) -could only handle MBR partitions, and never correctly handled logical -partitions beyond partition 5. Exporting a partition can still be -done by utilizing the @option{--image-opts} option with a raw blockdev -using the @code{offset} and @code{size} parameters layered on top of -any other existing blockdev. For example, if partition 1 is 100MiB -long starting at 1MiB, the old command: - -@code{qemu-nbd -t -P 1 -f qcow2 file.qcow2} - -can be rewritten as: - -@code{qemu-nbd -t --image-opts driver=raw,offset=1M,size=100M,file.driver=qcow2,file.file.driver=file,file.file.filename=file.qcow2} diff --git a/qemu-doc.texi b/qemu-doc.texi index e4bff7edbe..d3e743719a 100644 --- a/qemu-doc.texi +++ b/qemu-doc.texi @@ -189,9 +189,9 @@ various targets are mentioned in the following sections. @include docs/system/target-m68k.texi @include docs/system/target-xtensa.texi -@include docs/security.texi +@include docs/system/security.texi -@include qemu-deprecated.texi +@include docs/system/deprecated.texi @include docs/system/build-platforms.texi diff --git a/qemu-option-trace.texi b/qemu-option-trace.texi deleted file mode 100644 index 162f1528d2..0000000000 --- a/qemu-option-trace.texi +++ /dev/null @@ -1,28 +0,0 @@ -@c The contents of this file must be kept in sync with qemu-option-trace.rst.inc -@c until all the users of the texi file have been converted to rst and -@c the texi file can be removed. - -Specify tracing options. - -@table @option -@item [enable=]@var{pattern} -Immediately enable events matching @var{pattern} -(either event name or a globbing pattern). This option is only -available if QEMU has been compiled with the @var{simple}, @var{log} -or @var{ftrace} tracing backend. To specify multiple events or patterns, -specify the @option{-trace} option multiple times. - -Use @code{-trace help} to print a list of names of trace points. - -@item events=@var{file} -Immediately enable events listed in @var{file}. -The file must contain one event name (as listed in the @file{trace-events-all} -file) per line; globbing patterns are accepted too. This option is only -available if QEMU has been compiled with the @var{simple}, @var{log} or -@var{ftrace} tracing backend. - -@item file=@var{file} -Log output traces to @var{file}. -This option is only available if QEMU has been compiled with -the @var{simple} tracing backend. -@end table diff --git a/qemu-options.hx b/qemu-options.hx index 084a1c1f8c..5a4ac8e239 100644 --- a/qemu-options.hx +++ b/qemu-options.hx @@ -4221,7 +4221,7 @@ HXCOMM This line is not accurate, as some sub-options are backend-specific but HXCOMM HX does not support conditional compilation of text. @item -trace [[enable=]@var{pattern}][,events=@var{file}][,file=@var{file}] @findex -trace -@include qemu-option-trace.texi +@include docs/system/qemu-option-trace.texi ETEXI DEF("plugin", HAS_ARG, QEMU_OPTION_plugin, "-plugin [file=][,arg=]\n" -- cgit v1.2.3-55-g7522 From c9a38ce6abf7d5f1c6a64237cead9b298d03c118 Mon Sep 17 00:00:00 2001 From: Paolo Bonzini Date: Fri, 28 Feb 2020 15:35:58 +0000 Subject: qemu-doc: remove indices other than findex These indices are not well-maintained, and pandoc also chokes on the directives. Just nuke them. Signed-off-by: Paolo Bonzini Reviewed-by: Peter Maydell Reviewed-by: Alex Bennée Tested-by: Alex Bennée Signed-off-by: Peter Maydell Message-id: 20200228153619.9906-13-peter.maydell@linaro.org Message-id: 20200226113034.6741-13-pbonzini@redhat.com Reviewed-by: Peter Maydell Signed-off-by: Peter Maydell --- docs/system/keys.texi | 10 ---------- docs/system/monitor.texi | 1 - docs/system/mux-chardev.texi | 7 ------- docs/system/quickstart.texi | 1 - docs/system/target-arm.texi | 1 - docs/system/target-i386.texi | 1 - docs/system/target-m68k.texi | 2 -- docs/system/target-mips.texi | 2 -- docs/system/target-ppc.texi | 1 - docs/system/target-sparc.texi | 1 - docs/system/target-sparc64.texi | 1 - docs/system/target-xtensa.texi | 1 - qemu-doc.texi | 44 ----------------------------------------- 13 files changed, 73 deletions(-) (limited to 'docs/system') diff --git a/docs/system/keys.texi b/docs/system/keys.texi index 4c74b3bf4d..c04daf54f2 100644 --- a/docs/system/keys.texi +++ b/docs/system/keys.texi @@ -10,23 +10,18 @@ then the modifier is Ctrl-Alt-Shift (instead of Ctrl-Alt) and if you use @table @key @item Ctrl-Alt-f -@kindex Ctrl-Alt-f Toggle full screen @item Ctrl-Alt-+ -@kindex Ctrl-Alt-+ Enlarge the screen @item Ctrl-Alt-- -@kindex Ctrl-Alt-- Shrink the screen @item Ctrl-Alt-u -@kindex Ctrl-Alt-u Restore the screen's un-scaled dimensions @item Ctrl-Alt-n -@kindex Ctrl-Alt-n Switch to virtual console 'n'. Standard console mappings are: @table @emph @item 1 @@ -38,14 +33,9 @@ Serial port @end table @item Ctrl-Alt -@kindex Ctrl-Alt Toggle mouse and keyboard grab. @end table -@kindex Ctrl-Up -@kindex Ctrl-Down -@kindex Ctrl-PageUp -@kindex Ctrl-PageDown In the virtual consoles, you can use @key{Ctrl-Up}, @key{Ctrl-Down}, @key{Ctrl-PageUp} and @key{Ctrl-PageDown} to move in the back log. diff --git a/docs/system/monitor.texi b/docs/system/monitor.texi index c5b6a9b38e..b41b144885 100644 --- a/docs/system/monitor.texi +++ b/docs/system/monitor.texi @@ -1,6 +1,5 @@ @node pcsys_monitor @section QEMU Monitor -@cindex QEMU monitor The QEMU monitor is used to give complex commands to the QEMU emulator. You can use it to: diff --git a/docs/system/mux-chardev.texi b/docs/system/mux-chardev.texi index c9a2d14cb8..b21c2c5654 100644 --- a/docs/system/mux-chardev.texi +++ b/docs/system/mux-chardev.texi @@ -12,26 +12,19 @@ you're using the default. @table @key @item Ctrl-a h -@kindex Ctrl-a h Print this help @item Ctrl-a x -@kindex Ctrl-a x Exit emulator @item Ctrl-a s -@kindex Ctrl-a s Save disk data back to file (if -snapshot) @item Ctrl-a t -@kindex Ctrl-a t Toggle console timestamps @item Ctrl-a b -@kindex Ctrl-a b Send break (magic sysrq in Linux) @item Ctrl-a c -@kindex Ctrl-a c Rotate between the frontends connected to the multiplexer (usually this switches between the monitor and the console) @item Ctrl-a Ctrl-a -@kindex Ctrl-a Ctrl-a Send the escape character to the frontend @end table @c man end diff --git a/docs/system/quickstart.texi b/docs/system/quickstart.texi index ed7295de7a..baceaa96eb 100644 --- a/docs/system/quickstart.texi +++ b/docs/system/quickstart.texi @@ -1,6 +1,5 @@ @node pcsys_quickstart @section Quick Start -@cindex quick start Download and uncompress a PC hard disk image with Linux installed (e.g. @file{linux.img}) and type: diff --git a/docs/system/target-arm.texi b/docs/system/target-arm.texi index 040d77b5e0..c56b5f6ebf 100644 --- a/docs/system/target-arm.texi +++ b/docs/system/target-arm.texi @@ -1,6 +1,5 @@ @node ARM System emulator @section ARM System emulator -@cindex system emulation (ARM) Use the executable @file{qemu-system-arm} to simulate a ARM machine. The ARM Integrator/CP board is emulated with the following diff --git a/docs/system/target-i386.texi b/docs/system/target-i386.texi index edd23fa8df..cc352b89a8 100644 --- a/docs/system/target-i386.texi +++ b/docs/system/target-i386.texi @@ -1,6 +1,5 @@ @node x86 (PC) System emulator @section x86 (PC) System emulator -@cindex system emulation (PC) @menu * pcsys_devices:: Peripherals diff --git a/docs/system/target-m68k.texi b/docs/system/target-m68k.texi index b5bc9df40a..a77b19ea0f 100644 --- a/docs/system/target-m68k.texi +++ b/docs/system/target-m68k.texi @@ -1,7 +1,5 @@ @node ColdFire System emulator @section ColdFire System emulator -@cindex system emulation (ColdFire) -@cindex system emulation (M68K) Use the executable @file{qemu-system-m68k} to simulate a ColdFire machine. The emulator is able to boot a uClinux kernel. diff --git a/docs/system/target-mips.texi b/docs/system/target-mips.texi index f722c00912..fe12ee94c7 100644 --- a/docs/system/target-mips.texi +++ b/docs/system/target-mips.texi @@ -1,6 +1,5 @@ @node MIPS System emulator @section MIPS System emulator -@cindex system emulation (MIPS) @menu * recommendations_cpu_models_MIPS:: Supported CPU model configurations on MIPS hosts @@ -126,7 +125,6 @@ MIPSnet network emulation @node nanoMIPS System emulator @subsection nanoMIPS System emulator -@cindex system emulation (nanoMIPS) Executable @file{qemu-system-mipsel} also covers simulation of 32-bit nanoMIPS system in little endian mode: diff --git a/docs/system/target-ppc.texi b/docs/system/target-ppc.texi index c2c254d3d2..55f98f65b1 100644 --- a/docs/system/target-ppc.texi +++ b/docs/system/target-ppc.texi @@ -1,6 +1,5 @@ @node PowerPC System emulator @section PowerPC System emulator -@cindex system emulation (PowerPC) Use the executable @file{qemu-system-ppc} to simulate a complete 40P (PREP) or PowerMac PowerPC system. diff --git a/docs/system/target-sparc.texi b/docs/system/target-sparc.texi index 7fe0aec9c3..7748001f73 100644 --- a/docs/system/target-sparc.texi +++ b/docs/system/target-sparc.texi @@ -1,6 +1,5 @@ @node Sparc32 System emulator @section Sparc32 System emulator -@cindex system emulation (Sparc32) Use the executable @file{qemu-system-sparc} to simulate the following Sun4m architecture machines: diff --git a/docs/system/target-sparc64.texi b/docs/system/target-sparc64.texi index 9e7a27de0c..4db4ca3842 100644 --- a/docs/system/target-sparc64.texi +++ b/docs/system/target-sparc64.texi @@ -1,6 +1,5 @@ @node Sparc64 System emulator @section Sparc64 System emulator -@cindex system emulation (Sparc64) Use the executable @file{qemu-system-sparc64} to simulate a Sun4u (UltraSPARC PC-like machine), Sun4v (T1 PC-like machine), or generic diff --git a/docs/system/target-xtensa.texi b/docs/system/target-xtensa.texi index 08b0b36299..40327de6fa 100644 --- a/docs/system/target-xtensa.texi +++ b/docs/system/target-xtensa.texi @@ -1,6 +1,5 @@ @node Xtensa System emulator @section Xtensa System emulator -@cindex system emulation (Xtensa) Two executables cover simulation of both Xtensa endian options, @file{qemu-system-xtensa} and @file{qemu-system-xtensaeb}. diff --git a/qemu-doc.texi b/qemu-doc.texi index d3e743719a..c2b9c87c64 100644 --- a/qemu-doc.texi +++ b/qemu-doc.texi @@ -62,17 +62,14 @@ QEMU is a FAST! processor emulator using dynamic translation to achieve good emulation speed. -@cindex operating modes QEMU has two operating modes: @itemize -@cindex system emulation @item Full system emulation. In this mode, QEMU emulates a full system (for example a PC), including one or several processors and various peripherals. It can be used to launch different Operating Systems without rebooting the PC or to debug system code. -@cindex user mode emulation @item User mode emulation. In this mode, QEMU can launch processes compiled for one CPU on another CPU. It can be used to launch the Wine Windows API emulator (@url{https://www.winehq.org}) or @@ -127,7 +124,6 @@ accelerator is required to use more than one host CPU for emulation. @node QEMU System emulator @chapter QEMU System emulator -@cindex system emulation @menu * pcsys_quickstart:: Quick start @@ -163,7 +159,6 @@ accelerator is required to use more than one host CPU for emulation. @node QEMU System emulator targets @chapter QEMU System emulator targets -@cindex system emulation (PC) QEMU is a generic emulator and it emulates many machines. Most of the options are similar for all machines. Specific information about the @@ -200,46 +195,7 @@ various targets are mentioned in the following sections. @node Index @appendix Index -@menu -* Concept Index:: -* Function Index:: -* Keystroke Index:: -* Program Index:: -* Data Type Index:: -* Variable Index:: -@end menu - -@node Concept Index -@section Concept Index -This is the main index. Should we combine all keywords in one index? TODO -@printindex cp -@node Function Index -@section Function Index -This index could be used for command line options and monitor functions. @printindex fn -@node Keystroke Index -@section Keystroke Index - -This is a list of all keystrokes which have a special function -in system emulation. - -@printindex ky - -@node Program Index -@section Program Index -@printindex pg - -@node Data Type Index -@section Data Type Index - -This index could be used for qdev device names and options. - -@printindex tp - -@node Variable Index -@section Variable Index -@printindex vr - @bye -- cgit v1.2.3-55-g7522 From bccb135e54f746c8e18dc6146c1a678dc670a05c Mon Sep 17 00:00:00 2001 From: Paolo Bonzini Date: Fri, 28 Feb 2020 15:35:59 +0000 Subject: docs/system: put qemu-block-drivers body in an included file This removes the "only" directives, and lets us use the conventional "DESCRIPTION" section in the manpage. This temporarily drops the qemu-block-drivers documentation from the system manual, but it will be put back (in the right place in the toctree) in a later commit. Signed-off-by: Paolo Bonzini Reviewed-by: Peter Maydell Reviewed-by: Alex Bennée Tested-by: Alex Bennée Signed-off-by: Peter Maydell Message-id: 20200228153619.9906-14-peter.maydell@linaro.org Message-id: 20200226113034.6741-14-pbonzini@redhat.com Reviewed-by: Peter Maydell [PMM: Added commit message note about temporarily losing qemu-block-drivers from the system manual] Signed-off-by: Peter Maydell --- docs/system/index.rst | 1 - docs/system/qemu-block-drivers.rst | 987 +-------------------------------- docs/system/qemu-block-drivers.rst.inc | 954 +++++++++++++++++++++++++++++++ 3 files changed, 966 insertions(+), 976 deletions(-) create mode 100644 docs/system/qemu-block-drivers.rst.inc (limited to 'docs/system') diff --git a/docs/system/index.rst b/docs/system/index.rst index 1a4b2c82ac..fc774a18b5 100644 --- a/docs/system/index.rst +++ b/docs/system/index.rst @@ -14,5 +14,4 @@ Contents: .. toctree:: :maxdepth: 2 - qemu-block-drivers vfio-ap diff --git a/docs/system/qemu-block-drivers.rst b/docs/system/qemu-block-drivers.rst index 388adbefbf..7ca890ea23 100644 --- a/docs/system/qemu-block-drivers.rst +++ b/docs/system/qemu-block-drivers.rst @@ -1,985 +1,22 @@ +:orphan: + QEMU block drivers reference ============================ .. |qemu_system| replace:: qemu-system-x86_64 -.. - We put the 'Synopsis' and 'See also' sections into the manpage, but not - the HTML. This makes the HTML docs read better and means the ToC in - the index has a more useful set of entries. Ideally, the section - headings 'Disk image file formats' would be top-level headings for - the HTML, but sub-headings of the conventional manpage 'Description' - header for the manpage. Unfortunately, due to deficiencies in - the Sphinx 'only' directive, this isn't possible: they must be headers - at the same level as 'Synopsis' and 'See also', otherwise Sphinx's - identification of which header underline style is which gets confused. - -.. only:: man - - Synopsis - -------- - - QEMU block driver reference manual - -Disk image file formats ------------------------ - -QEMU supports many image file formats that can be used with VMs as well as with -any of the tools (like ``qemu-img``). This includes the preferred formats -raw and qcow2 as well as formats that are supported for compatibility with -older QEMU versions or other hypervisors. - -Depending on the image format, different options can be passed to -``qemu-img create`` and ``qemu-img convert`` using the ``-o`` option. -This section describes each format and the options that are supported for it. - -.. program:: image-formats -.. option:: raw - - Raw disk image format. This format has the advantage of - being simple and easily exportable to all other emulators. If your - file system supports *holes* (for example in ext2 or ext3 on - Linux or NTFS on Windows), then only the written sectors will reserve - space. Use ``qemu-img info`` to know the real size used by the - image or ``ls -ls`` on Unix/Linux. - - Supported options: - - .. program:: raw - .. option:: preallocation - - Preallocation mode (allowed values: ``off``, ``falloc``, - ``full``). ``falloc`` mode preallocates space for image by - calling ``posix_fallocate()``. ``full`` mode preallocates space - for image by writing data to underlying storage. This data may or - may not be zero, depending on the storage location. - -.. program:: image-formats -.. option:: qcow2 - - QEMU image format, the most versatile format. Use it to have smaller - images (useful if your filesystem does not supports holes, for example - on Windows), zlib based compression and support of multiple VM - snapshots. - - Supported options: - - .. program:: qcow2 - .. option:: compat - - Determines the qcow2 version to use. ``compat=0.10`` uses the - traditional image format that can be read by any QEMU since 0.10. - ``compat=1.1`` enables image format extensions that only QEMU 1.1 and - newer understand (this is the default). Amongst others, this includes - zero clusters, which allow efficient copy-on-read for sparse images. - - .. option:: backing_file - - File name of a base image (see ``create`` subcommand) - - .. option:: backing_fmt - - Image format of the base image - - .. option:: encryption - - This option is deprecated and equivalent to ``encrypt.format=aes`` - - .. option:: encrypt.format - - If this is set to ``luks``, it requests that the qcow2 payload (not - qcow2 header) be encrypted using the LUKS format. The passphrase to - use to unlock the LUKS key slot is given by the ``encrypt.key-secret`` - parameter. LUKS encryption parameters can be tuned with the other - ``encrypt.*`` parameters. - - If this is set to ``aes``, the image is encrypted with 128-bit AES-CBC. - The encryption key is given by the ``encrypt.key-secret`` parameter. - This encryption format is considered to be flawed by modern cryptography - standards, suffering from a number of design problems: - - - The AES-CBC cipher is used with predictable initialization vectors based - on the sector number. This makes it vulnerable to chosen plaintext attacks - which can reveal the existence of encrypted data. - - The user passphrase is directly used as the encryption key. A poorly - chosen or short passphrase will compromise the security of the encryption. - - In the event of the passphrase being compromised there is no way to - change the passphrase to protect data in any qcow images. The files must - be cloned, using a different encryption passphrase in the new file. The - original file must then be securely erased using a program like shred, - though even this is ineffective with many modern storage technologies. - - The use of this is no longer supported in system emulators. Support only - remains in the command line utilities, for the purposes of data liberation - and interoperability with old versions of QEMU. The ``luks`` format - should be used instead. - - .. option:: encrypt.key-secret - - Provides the ID of a ``secret`` object that contains the passphrase - (``encrypt.format=luks``) or encryption key (``encrypt.format=aes``). - - .. option:: encrypt.cipher-alg - - Name of the cipher algorithm and key length. Currently defaults - to ``aes-256``. Only used when ``encrypt.format=luks``. - - .. option:: encrypt.cipher-mode - - Name of the encryption mode to use. Currently defaults to ``xts``. - Only used when ``encrypt.format=luks``. - - .. option:: encrypt.ivgen-alg - - Name of the initialization vector generator algorithm. Currently defaults - to ``plain64``. Only used when ``encrypt.format=luks``. - - .. option:: encrypt.ivgen-hash-alg - - Name of the hash algorithm to use with the initialization vector generator - (if required). Defaults to ``sha256``. Only used when ``encrypt.format=luks``. - - .. option:: encrypt.hash-alg - - Name of the hash algorithm to use for PBKDF algorithm - Defaults to ``sha256``. Only used when ``encrypt.format=luks``. - - .. option:: encrypt.iter-time - - Amount of time, in milliseconds, to use for PBKDF algorithm per key slot. - Defaults to ``2000``. Only used when ``encrypt.format=luks``. - - .. option:: cluster_size - - Changes the qcow2 cluster size (must be between 512 and 2M). Smaller cluster - sizes can improve the image file size whereas larger cluster sizes generally - provide better performance. - - .. option:: preallocation - - Preallocation mode (allowed values: ``off``, ``metadata``, ``falloc``, - ``full``). An image with preallocated metadata is initially larger but can - improve performance when the image needs to grow. ``falloc`` and ``full`` - preallocations are like the same options of ``raw`` format, but sets up - metadata also. - - .. option:: lazy_refcounts - - If this option is set to ``on``, reference count updates are postponed with - the goal of avoiding metadata I/O and improving performance. This is - particularly interesting with :option:`cache=writethrough` which doesn't batch - metadata updates. The tradeoff is that after a host crash, the reference count - tables must be rebuilt, i.e. on the next open an (automatic) ``qemu-img - check -r all`` is required, which may take some time. - - This option can only be enabled if ``compat=1.1`` is specified. - - .. option:: nocow - - If this option is set to ``on``, it will turn off COW of the file. It's only - valid on btrfs, no effect on other file systems. - - Btrfs has low performance when hosting a VM image file, even more - when the guest on the VM also using btrfs as file system. Turning off - COW is a way to mitigate this bad performance. Generally there are two - ways to turn off COW on btrfs: - - - Disable it by mounting with nodatacow, then all newly created files - will be NOCOW. - - For an empty file, add the NOCOW file attribute. That's what this - option does. - - Note: this option is only valid to new or empty files. If there is - an existing file which is COW and has data blocks already, it couldn't - be changed to NOCOW by setting ``nocow=on``. One can issue ``lsattr - filename`` to check if the NOCOW flag is set or not (Capital 'C' is - NOCOW flag). - -.. program:: image-formats -.. option:: qed - - Old QEMU image format with support for backing files and compact image files - (when your filesystem or transport medium does not support holes). - - When converting QED images to qcow2, you might want to consider using the - ``lazy_refcounts=on`` option to get a more QED-like behaviour. - - Supported options: - - .. program:: qed - .. option:: backing_file - - File name of a base image (see ``create`` subcommand). - - .. option:: backing_fmt - - Image file format of backing file (optional). Useful if the format cannot be - autodetected because it has no header, like some vhd/vpc files. - - .. option:: cluster_size - - Changes the cluster size (must be power-of-2 between 4K and 64K). Smaller - cluster sizes can improve the image file size whereas larger cluster sizes - generally provide better performance. - - .. option:: table_size - - Changes the number of clusters per L1/L2 table (must be - power-of-2 between 1 and 16). There is normally no need to - change this value but this option can between used for - performance benchmarking. - -.. program:: image-formats -.. option:: qcow - - Old QEMU image format with support for backing files, compact image files, - encryption and compression. - - Supported options: - - .. program:: qcow - .. option:: backing_file - - File name of a base image (see ``create`` subcommand) - - .. option:: encryption - - This option is deprecated and equivalent to ``encrypt.format=aes`` - - .. option:: encrypt.format - - If this is set to ``aes``, the image is encrypted with 128-bit AES-CBC. - The encryption key is given by the ``encrypt.key-secret`` parameter. - This encryption format is considered to be flawed by modern cryptography - standards, suffering from a number of design problems enumerated previously - against the ``qcow2`` image format. - - The use of this is no longer supported in system emulators. Support only - remains in the command line utilities, for the purposes of data liberation - and interoperability with old versions of QEMU. - - Users requiring native encryption should use the ``qcow2`` format - instead with ``encrypt.format=luks``. - - .. option:: encrypt.key-secret - - Provides the ID of a ``secret`` object that contains the encryption - key (``encrypt.format=aes``). - -.. program:: image-formats -.. option:: luks - - LUKS v1 encryption format, compatible with Linux dm-crypt/cryptsetup - - Supported options: - - .. program:: luks - .. option:: key-secret - - Provides the ID of a ``secret`` object that contains the passphrase. - - .. option:: cipher-alg - - Name of the cipher algorithm and key length. Currently defaults - to ``aes-256``. - - .. option:: cipher-mode - - Name of the encryption mode to use. Currently defaults to ``xts``. - - .. option:: ivgen-alg - - Name of the initialization vector generator algorithm. Currently defaults - to ``plain64``. - - .. option:: ivgen-hash-alg - - Name of the hash algorithm to use with the initialization vector generator - (if required). Defaults to ``sha256``. - - .. option:: hash-alg - - Name of the hash algorithm to use for PBKDF algorithm - Defaults to ``sha256``. - - .. option:: iter-time - - Amount of time, in milliseconds, to use for PBKDF algorithm per key slot. - Defaults to ``2000``. - -.. program:: image-formats -.. option:: vdi - - VirtualBox 1.1 compatible image format. - - Supported options: - - .. program:: vdi - .. option:: static - - If this option is set to ``on``, the image is created with metadata - preallocation. - -.. program:: image-formats -.. option:: vmdk - - VMware 3 and 4 compatible image format. - - Supported options: - - .. program: vmdk - .. option:: backing_file - - File name of a base image (see ``create`` subcommand). - - .. option:: compat6 - - Create a VMDK version 6 image (instead of version 4) - - .. option:: hwversion - - Specify vmdk virtual hardware version. Compat6 flag cannot be enabled - if hwversion is specified. - - .. option:: subformat - - Specifies which VMDK subformat to use. Valid options are - ``monolithicSparse`` (default), - ``monolithicFlat``, - ``twoGbMaxExtentSparse``, - ``twoGbMaxExtentFlat`` and - ``streamOptimized``. - -.. program:: image-formats -.. option:: vpc - - VirtualPC compatible image format (VHD). - - Supported options: - - .. program:: vpc - .. option:: subformat - - Specifies which VHD subformat to use. Valid options are - ``dynamic`` (default) and ``fixed``. - -.. program:: image-formats -.. option:: VHDX - - Hyper-V compatible image format (VHDX). - - Supported options: - - .. program:: VHDX - .. option:: subformat - - Specifies which VHDX subformat to use. Valid options are - ``dynamic`` (default) and ``fixed``. - - .. option:: block_state_zero - - Force use of payload blocks of type 'ZERO'. Can be set to ``on`` (default) - or ``off``. When set to ``off``, new blocks will be created as - ``PAYLOAD_BLOCK_NOT_PRESENT``, which means parsers are free to return - arbitrary data for those blocks. Do not set to ``off`` when using - ``qemu-img convert`` with ``subformat=dynamic``. - - .. option:: block_size - - Block size; min 1 MB, max 256 MB. 0 means auto-calculate based on - image size. - - .. option:: log_size - - Log size; min 1 MB. - -Read-only formats ------------------ - -More disk image file formats are supported in a read-only mode. - -.. program:: image-formats -.. option:: bochs - - Bochs images of ``growing`` type. - -.. program:: image-formats -.. option:: cloop - - Linux Compressed Loop image, useful only to reuse directly compressed - CD-ROM images present for example in the Knoppix CD-ROMs. - -.. program:: image-formats -.. option:: dmg - - Apple disk image. - -.. program:: image-formats -.. option:: parallels - - Parallels disk image format. - -Using host drives ------------------ - -In addition to disk image files, QEMU can directly access host -devices. We describe here the usage for QEMU version >= 0.8.3. - -Linux -''''' - -On Linux, you can directly use the host device filename instead of a -disk image filename provided you have enough privileges to access -it. For example, use ``/dev/cdrom`` to access to the CDROM. - -CD - You can specify a CDROM device even if no CDROM is loaded. QEMU has - specific code to detect CDROM insertion or removal. CDROM ejection by - the guest OS is supported. Currently only data CDs are supported. - -Floppy - You can specify a floppy device even if no floppy is loaded. Floppy - removal is currently not detected accurately (if you change floppy - without doing floppy access while the floppy is not loaded, the guest - OS will think that the same floppy is loaded). - Use of the host's floppy device is deprecated, and support for it will - be removed in a future release. - -Hard disks - Hard disks can be used. Normally you must specify the whole disk - (``/dev/hdb`` instead of ``/dev/hdb1``) so that the guest OS can - see it as a partitioned disk. WARNING: unless you know what you do, it - is better to only make READ-ONLY accesses to the hard disk otherwise - you may corrupt your host data (use the ``-snapshot`` command - line option or modify the device permissions accordingly). - -Windows -''''''' - -CD - The preferred syntax is the drive letter (e.g. ``d:``). The - alternate syntax ``\\.\d:`` is supported. ``/dev/cdrom`` is - supported as an alias to the first CDROM drive. - - Currently there is no specific code to handle removable media, so it - is better to use the ``change`` or ``eject`` monitor commands to - change or eject media. - -Hard disks - Hard disks can be used with the syntax: ``\\.\PhysicalDriveN`` - where *N* is the drive number (0 is the first hard disk). - - WARNING: unless you know what you do, it is better to only make - READ-ONLY accesses to the hard disk otherwise you may corrupt your - host data (use the ``-snapshot`` command line so that the - modifications are written in a temporary file). - -Mac OS X -'''''''' - -``/dev/cdrom`` is an alias to the first CDROM. - -Currently there is no specific code to handle removable media, so it -is better to use the ``change`` or ``eject`` monitor commands to -change or eject media. - -Virtual FAT disk images ------------------------ - -QEMU can automatically create a virtual FAT disk image from a -directory tree. In order to use it, just type: - -.. parsed-literal:: - - |qemu_system| linux.img -hdb fat:/my_directory - -Then you access access to all the files in the ``/my_directory`` -directory without having to copy them in a disk image or to export -them via SAMBA or NFS. The default access is *read-only*. - -Floppies can be emulated with the ``:floppy:`` option: - -.. parsed-literal:: - - |qemu_system| linux.img -fda fat:floppy:/my_directory - -A read/write support is available for testing (beta stage) with the -``:rw:`` option: - -.. parsed-literal:: - - |qemu_system| linux.img -fda fat:floppy:rw:/my_directory - -What you should *never* do: - -- use non-ASCII filenames -- use "-snapshot" together with ":rw:" -- expect it to work when loadvm'ing -- write to the FAT directory on the host system while accessing it with the guest system - -NBD access ----------- - -QEMU can access directly to block device exported using the Network Block Device -protocol. - -.. parsed-literal:: - - |qemu_system| linux.img -hdb nbd://my_nbd_server.mydomain.org:1024/ - -If the NBD server is located on the same host, you can use an unix socket instead -of an inet socket: - -.. parsed-literal:: - - |qemu_system| linux.img -hdb nbd+unix://?socket=/tmp/my_socket - -In this case, the block device must be exported using qemu-nbd: - -.. parsed-literal:: - - qemu-nbd --socket=/tmp/my_socket my_disk.qcow2 - -The use of qemu-nbd allows sharing of a disk between several guests: - -.. parsed-literal:: - - qemu-nbd --socket=/tmp/my_socket --share=2 my_disk.qcow2 - -and then you can use it with two guests: - -.. parsed-literal:: - - |qemu_system| linux1.img -hdb nbd+unix://?socket=/tmp/my_socket - |qemu_system| linux2.img -hdb nbd+unix://?socket=/tmp/my_socket - -If the nbd-server uses named exports (supported since NBD 2.9.18, or with QEMU's -own embedded NBD server), you must specify an export name in the URI: - -.. parsed-literal:: - - |qemu_system| -cdrom nbd://localhost/debian-500-ppc-netinst - |qemu_system| -cdrom nbd://localhost/openSUSE-11.1-ppc-netinst - -The URI syntax for NBD is supported since QEMU 1.3. An alternative syntax is -also available. Here are some example of the older syntax: - -.. parsed-literal:: - - |qemu_system| linux.img -hdb nbd:my_nbd_server.mydomain.org:1024 - |qemu_system| linux2.img -hdb nbd:unix:/tmp/my_socket - |qemu_system| -cdrom nbd:localhost:10809:exportname=debian-500-ppc-netinst - - - -Sheepdog disk images --------------------- - -Sheepdog is a distributed storage system for QEMU. It provides highly -available block level storage volumes that can be attached to -QEMU-based virtual machines. - -You can create a Sheepdog disk image with the command: - -.. parsed-literal:: - - qemu-img create sheepdog:///IMAGE SIZE - -where *IMAGE* is the Sheepdog image name and *SIZE* is its -size. - -To import the existing *FILENAME* to Sheepdog, you can use a -convert command. - -.. parsed-literal:: - - qemu-img convert FILENAME sheepdog:///IMAGE - -You can boot from the Sheepdog disk image with the command: - -.. parsed-literal:: - - |qemu_system| sheepdog:///IMAGE - -You can also create a snapshot of the Sheepdog image like qcow2. - -.. parsed-literal:: - - qemu-img snapshot -c TAG sheepdog:///IMAGE - -where *TAG* is a tag name of the newly created snapshot. - -To boot from the Sheepdog snapshot, specify the tag name of the -snapshot. - -.. parsed-literal:: - - |qemu_system| sheepdog:///IMAGE#TAG - -You can create a cloned image from the existing snapshot. - -.. parsed-literal:: - - qemu-img create -b sheepdog:///BASE#TAG sheepdog:///IMAGE - -where *BASE* is an image name of the source snapshot and *TAG* -is its tag name. - -You can use an unix socket instead of an inet socket: - -.. parsed-literal:: - - |qemu_system| sheepdog+unix:///IMAGE?socket=PATH - -If the Sheepdog daemon doesn't run on the local host, you need to -specify one of the Sheepdog servers to connect to. - -.. parsed-literal:: - - qemu-img create sheepdog://HOSTNAME:PORT/IMAGE SIZE - |qemu_system| sheepdog://HOSTNAME:PORT/IMAGE - -iSCSI LUNs ----------- - -iSCSI is a popular protocol used to access SCSI devices across a computer -network. - -There are two different ways iSCSI devices can be used by QEMU. - -The first method is to mount the iSCSI LUN on the host, and make it appear as -any other ordinary SCSI device on the host and then to access this device as a -/dev/sd device from QEMU. How to do this differs between host OSes. - -The second method involves using the iSCSI initiator that is built into -QEMU. This provides a mechanism that works the same way regardless of which -host OS you are running QEMU on. This section will describe this second method -of using iSCSI together with QEMU. - -In QEMU, iSCSI devices are described using special iSCSI URLs. URL syntax: - -:: - - iscsi://[[%]@][:]// - -Username and password are optional and only used if your target is set up -using CHAP authentication for access control. -Alternatively the username and password can also be set via environment -variables to have these not show up in the process list: - -:: - - export LIBISCSI_CHAP_USERNAME= - export LIBISCSI_CHAP_PASSWORD= - iscsi://// - -Various session related parameters can be set via special options, either -in a configuration file provided via '-readconfig' or directly on the -command line. - -If the initiator-name is not specified qemu will use a default name -of 'iqn.2008-11.org.linux-kvm[:'] where is the UUID of the -virtual machine. If the UUID is not specified qemu will use -'iqn.2008-11.org.linux-kvm[:'] where is the name of the -virtual machine. - -Setting a specific initiator name to use when logging in to the target: - -:: - - -iscsi initiator-name=iqn.qemu.test:my-initiator - -Controlling which type of header digest to negotiate with the target: - -:: - - -iscsi header-digest=CRC32C|CRC32C-NONE|NONE-CRC32C|NONE - -These can also be set via a configuration file: - -:: - - [iscsi] - user = "CHAP username" - password = "CHAP password" - initiator-name = "iqn.qemu.test:my-initiator" - # header digest is one of CRC32C|CRC32C-NONE|NONE-CRC32C|NONE - header-digest = "CRC32C" - -Setting the target name allows different options for different targets: - -:: - - [iscsi "iqn.target.name"] - user = "CHAP username" - password = "CHAP password" - initiator-name = "iqn.qemu.test:my-initiator" - # header digest is one of CRC32C|CRC32C-NONE|NONE-CRC32C|NONE - header-digest = "CRC32C" - -How to use a configuration file to set iSCSI configuration options: - -.. parsed-literal:: - - cat >iscsi.conf < /sys/bus/pci/devices/0000:06:0d.0/driver/unbind - # echo 1102 0002 > /sys/bus/pci/drivers/vfio-pci/new_id - - # |qemu_system| -drive file=nvme://HOST:BUS:SLOT.FUNC/NAMESPACE - -Alternative syntax using properties: - -.. parsed-literal:: - - |qemu_system| -drive file.driver=nvme,file.device=HOST:BUS:SLOT.FUNC,file.namespace=NAMESPACE - -*HOST*:*BUS*:*SLOT*.\ *FUNC* is the NVMe controller's PCI device -address on the host. - -*NAMESPACE* is the NVMe namespace number, starting from 1. - -Disk image file locking ------------------------ - -By default, QEMU tries to protect image files from unexpected concurrent -access, as long as it's supported by the block protocol driver and host -operating system. If multiple QEMU processes (including QEMU emulators and -utilities) try to open the same image with conflicting accessing modes, all but -the first one will get an error. - -This feature is currently supported by the file protocol on Linux with the Open -File Descriptor (OFD) locking API, and can be configured to fall back to POSIX -locking if the POSIX host doesn't support Linux OFD locking. - -To explicitly enable image locking, specify "locking=on" in the file protocol -driver options. If OFD locking is not possible, a warning will be printed and -the POSIX locking API will be used. In this case there is a risk that the lock -will get silently lost when doing hot plugging and block jobs, due to the -shortcomings of the POSIX locking API. - -QEMU transparently handles lock handover during shared storage migration. For -shared virtual disk images between multiple VMs, the "share-rw" device option -should be used. - -By default, the guest has exclusive write access to its disk image. If the -guest can safely share the disk image with other writers the -``-device ...,share-rw=on`` parameter can be used. This is only safe if -the guest is running software, such as a cluster file system, that -coordinates disk accesses to avoid corruption. - -Note that share-rw=on only declares the guest's ability to share the disk. -Some QEMU features, such as image file formats, require exclusive write access -to the disk image and this is unaffected by the share-rw=on option. - -Alternatively, locking can be fully disabled by "locking=off" block device -option. In the command line, the option is usually in the form of -"file.locking=off" as the protocol driver is normally placed as a "file" child -under a format driver. For example: - -:: +Synopsis +-------- - -blockdev driver=qcow2,file.filename=/path/to/image,file.locking=off,file.driver=file +QEMU block driver reference manual -To check if image locking is active, check the output of the "lslocks" command -on host and see if there are locks held by the QEMU process on the image file. -More than one byte could be locked by the QEMU instance, each byte of which -reflects a particular permission that is acquired or protected by the running -block driver. +Description +----------- -.. only:: man +.. include:: qemu-block-drivers.rst.inc - See also - -------- +See also +-------- - The HTML documentation of QEMU for more precise information and Linux - user mode emulator invocation. +The HTML documentation of QEMU for more precise information and Linux +user mode emulator invocation. diff --git a/docs/system/qemu-block-drivers.rst.inc b/docs/system/qemu-block-drivers.rst.inc new file mode 100644 index 0000000000..b052a6d14e --- /dev/null +++ b/docs/system/qemu-block-drivers.rst.inc @@ -0,0 +1,954 @@ +Disk image file formats +~~~~~~~~~~~~~~~~~~~~~~~ + +QEMU supports many image file formats that can be used with VMs as well as with +any of the tools (like ``qemu-img``). This includes the preferred formats +raw and qcow2 as well as formats that are supported for compatibility with +older QEMU versions or other hypervisors. + +Depending on the image format, different options can be passed to +``qemu-img create`` and ``qemu-img convert`` using the ``-o`` option. +This section describes each format and the options that are supported for it. + +.. program:: image-formats +.. option:: raw + + Raw disk image format. This format has the advantage of + being simple and easily exportable to all other emulators. If your + file system supports *holes* (for example in ext2 or ext3 on + Linux or NTFS on Windows), then only the written sectors will reserve + space. Use ``qemu-img info`` to know the real size used by the + image or ``ls -ls`` on Unix/Linux. + + Supported options: + + .. program:: raw + .. option:: preallocation + + Preallocation mode (allowed values: ``off``, ``falloc``, + ``full``). ``falloc`` mode preallocates space for image by + calling ``posix_fallocate()``. ``full`` mode preallocates space + for image by writing data to underlying storage. This data may or + may not be zero, depending on the storage location. + +.. program:: image-formats +.. option:: qcow2 + + QEMU image format, the most versatile format. Use it to have smaller + images (useful if your filesystem does not supports holes, for example + on Windows), zlib based compression and support of multiple VM + snapshots. + + Supported options: + + .. program:: qcow2 + .. option:: compat + + Determines the qcow2 version to use. ``compat=0.10`` uses the + traditional image format that can be read by any QEMU since 0.10. + ``compat=1.1`` enables image format extensions that only QEMU 1.1 and + newer understand (this is the default). Amongst others, this includes + zero clusters, which allow efficient copy-on-read for sparse images. + + .. option:: backing_file + + File name of a base image (see ``create`` subcommand) + + .. option:: backing_fmt + + Image format of the base image + + .. option:: encryption + + This option is deprecated and equivalent to ``encrypt.format=aes`` + + .. option:: encrypt.format + + If this is set to ``luks``, it requests that the qcow2 payload (not + qcow2 header) be encrypted using the LUKS format. The passphrase to + use to unlock the LUKS key slot is given by the ``encrypt.key-secret`` + parameter. LUKS encryption parameters can be tuned with the other + ``encrypt.*`` parameters. + + If this is set to ``aes``, the image is encrypted with 128-bit AES-CBC. + The encryption key is given by the ``encrypt.key-secret`` parameter. + This encryption format is considered to be flawed by modern cryptography + standards, suffering from a number of design problems: + + - The AES-CBC cipher is used with predictable initialization vectors based + on the sector number. This makes it vulnerable to chosen plaintext attacks + which can reveal the existence of encrypted data. + - The user passphrase is directly used as the encryption key. A poorly + chosen or short passphrase will compromise the security of the encryption. + - In the event of the passphrase being compromised there is no way to + change the passphrase to protect data in any qcow images. The files must + be cloned, using a different encryption passphrase in the new file. The + original file must then be securely erased using a program like shred, + though even this is ineffective with many modern storage technologies. + + The use of this is no longer supported in system emulators. Support only + remains in the command line utilities, for the purposes of data liberation + and interoperability with old versions of QEMU. The ``luks`` format + should be used instead. + + .. option:: encrypt.key-secret + + Provides the ID of a ``secret`` object that contains the passphrase + (``encrypt.format=luks``) or encryption key (``encrypt.format=aes``). + + .. option:: encrypt.cipher-alg + + Name of the cipher algorithm and key length. Currently defaults + to ``aes-256``. Only used when ``encrypt.format=luks``. + + .. option:: encrypt.cipher-mode + + Name of the encryption mode to use. Currently defaults to ``xts``. + Only used when ``encrypt.format=luks``. + + .. option:: encrypt.ivgen-alg + + Name of the initialization vector generator algorithm. Currently defaults + to ``plain64``. Only used when ``encrypt.format=luks``. + + .. option:: encrypt.ivgen-hash-alg + + Name of the hash algorithm to use with the initialization vector generator + (if required). Defaults to ``sha256``. Only used when ``encrypt.format=luks``. + + .. option:: encrypt.hash-alg + + Name of the hash algorithm to use for PBKDF algorithm + Defaults to ``sha256``. Only used when ``encrypt.format=luks``. + + .. option:: encrypt.iter-time + + Amount of time, in milliseconds, to use for PBKDF algorithm per key slot. + Defaults to ``2000``. Only used when ``encrypt.format=luks``. + + .. option:: cluster_size + + Changes the qcow2 cluster size (must be between 512 and 2M). Smaller cluster + sizes can improve the image file size whereas larger cluster sizes generally + provide better performance. + + .. option:: preallocation + + Preallocation mode (allowed values: ``off``, ``metadata``, ``falloc``, + ``full``). An image with preallocated metadata is initially larger but can + improve performance when the image needs to grow. ``falloc`` and ``full`` + preallocations are like the same options of ``raw`` format, but sets up + metadata also. + + .. option:: lazy_refcounts + + If this option is set to ``on``, reference count updates are postponed with + the goal of avoiding metadata I/O and improving performance. This is + particularly interesting with :option:`cache=writethrough` which doesn't batch + metadata updates. The tradeoff is that after a host crash, the reference count + tables must be rebuilt, i.e. on the next open an (automatic) ``qemu-img + check -r all`` is required, which may take some time. + + This option can only be enabled if ``compat=1.1`` is specified. + + .. option:: nocow + + If this option is set to ``on``, it will turn off COW of the file. It's only + valid on btrfs, no effect on other file systems. + + Btrfs has low performance when hosting a VM image file, even more + when the guest on the VM also using btrfs as file system. Turning off + COW is a way to mitigate this bad performance. Generally there are two + ways to turn off COW on btrfs: + + - Disable it by mounting with nodatacow, then all newly created files + will be NOCOW. + - For an empty file, add the NOCOW file attribute. That's what this + option does. + + Note: this option is only valid to new or empty files. If there is + an existing file which is COW and has data blocks already, it couldn't + be changed to NOCOW by setting ``nocow=on``. One can issue ``lsattr + filename`` to check if the NOCOW flag is set or not (Capital 'C' is + NOCOW flag). + +.. program:: image-formats +.. option:: qed + + Old QEMU image format with support for backing files and compact image files + (when your filesystem or transport medium does not support holes). + + When converting QED images to qcow2, you might want to consider using the + ``lazy_refcounts=on`` option to get a more QED-like behaviour. + + Supported options: + + .. program:: qed + .. option:: backing_file + + File name of a base image (see ``create`` subcommand). + + .. option:: backing_fmt + + Image file format of backing file (optional). Useful if the format cannot be + autodetected because it has no header, like some vhd/vpc files. + + .. option:: cluster_size + + Changes the cluster size (must be power-of-2 between 4K and 64K). Smaller + cluster sizes can improve the image file size whereas larger cluster sizes + generally provide better performance. + + .. option:: table_size + + Changes the number of clusters per L1/L2 table (must be + power-of-2 between 1 and 16). There is normally no need to + change this value but this option can between used for + performance benchmarking. + +.. program:: image-formats +.. option:: qcow + + Old QEMU image format with support for backing files, compact image files, + encryption and compression. + + Supported options: + + .. program:: qcow + .. option:: backing_file + + File name of a base image (see ``create`` subcommand) + + .. option:: encryption + + This option is deprecated and equivalent to ``encrypt.format=aes`` + + .. option:: encrypt.format + + If this is set to ``aes``, the image is encrypted with 128-bit AES-CBC. + The encryption key is given by the ``encrypt.key-secret`` parameter. + This encryption format is considered to be flawed by modern cryptography + standards, suffering from a number of design problems enumerated previously + against the ``qcow2`` image format. + + The use of this is no longer supported in system emulators. Support only + remains in the command line utilities, for the purposes of data liberation + and interoperability with old versions of QEMU. + + Users requiring native encryption should use the ``qcow2`` format + instead with ``encrypt.format=luks``. + + .. option:: encrypt.key-secret + + Provides the ID of a ``secret`` object that contains the encryption + key (``encrypt.format=aes``). + +.. program:: image-formats +.. option:: luks + + LUKS v1 encryption format, compatible with Linux dm-crypt/cryptsetup + + Supported options: + + .. program:: luks + .. option:: key-secret + + Provides the ID of a ``secret`` object that contains the passphrase. + + .. option:: cipher-alg + + Name of the cipher algorithm and key length. Currently defaults + to ``aes-256``. + + .. option:: cipher-mode + + Name of the encryption mode to use. Currently defaults to ``xts``. + + .. option:: ivgen-alg + + Name of the initialization vector generator algorithm. Currently defaults + to ``plain64``. + + .. option:: ivgen-hash-alg + + Name of the hash algorithm to use with the initialization vector generator + (if required). Defaults to ``sha256``. + + .. option:: hash-alg + + Name of the hash algorithm to use for PBKDF algorithm + Defaults to ``sha256``. + + .. option:: iter-time + + Amount of time, in milliseconds, to use for PBKDF algorithm per key slot. + Defaults to ``2000``. + +.. program:: image-formats +.. option:: vdi + + VirtualBox 1.1 compatible image format. + + Supported options: + + .. program:: vdi + .. option:: static + + If this option is set to ``on``, the image is created with metadata + preallocation. + +.. program:: image-formats +.. option:: vmdk + + VMware 3 and 4 compatible image format. + + Supported options: + + .. program: vmdk + .. option:: backing_file + + File name of a base image (see ``create`` subcommand). + + .. option:: compat6 + + Create a VMDK version 6 image (instead of version 4) + + .. option:: hwversion + + Specify vmdk virtual hardware version. Compat6 flag cannot be enabled + if hwversion is specified. + + .. option:: subformat + + Specifies which VMDK subformat to use. Valid options are + ``monolithicSparse`` (default), + ``monolithicFlat``, + ``twoGbMaxExtentSparse``, + ``twoGbMaxExtentFlat`` and + ``streamOptimized``. + +.. program:: image-formats +.. option:: vpc + + VirtualPC compatible image format (VHD). + + Supported options: + + .. program:: vpc + .. option:: subformat + + Specifies which VHD subformat to use. Valid options are + ``dynamic`` (default) and ``fixed``. + +.. program:: image-formats +.. option:: VHDX + + Hyper-V compatible image format (VHDX). + + Supported options: + + .. program:: VHDX + .. option:: subformat + + Specifies which VHDX subformat to use. Valid options are + ``dynamic`` (default) and ``fixed``. + + .. option:: block_state_zero + + Force use of payload blocks of type 'ZERO'. Can be set to ``on`` (default) + or ``off``. When set to ``off``, new blocks will be created as + ``PAYLOAD_BLOCK_NOT_PRESENT``, which means parsers are free to return + arbitrary data for those blocks. Do not set to ``off`` when using + ``qemu-img convert`` with ``subformat=dynamic``. + + .. option:: block_size + + Block size; min 1 MB, max 256 MB. 0 means auto-calculate based on + image size. + + .. option:: log_size + + Log size; min 1 MB. + +Read-only formats +~~~~~~~~~~~~~~~~~ + +More disk image file formats are supported in a read-only mode. + +.. program:: image-formats +.. option:: bochs + + Bochs images of ``growing`` type. + +.. program:: image-formats +.. option:: cloop + + Linux Compressed Loop image, useful only to reuse directly compressed + CD-ROM images present for example in the Knoppix CD-ROMs. + +.. program:: image-formats +.. option:: dmg + + Apple disk image. + +.. program:: image-formats +.. option:: parallels + + Parallels disk image format. + +Using host drives +~~~~~~~~~~~~~~~~~ + +In addition to disk image files, QEMU can directly access host +devices. We describe here the usage for QEMU version >= 0.8.3. + +Linux +^^^^^ + +On Linux, you can directly use the host device filename instead of a +disk image filename provided you have enough privileges to access +it. For example, use ``/dev/cdrom`` to access to the CDROM. + +CD + You can specify a CDROM device even if no CDROM is loaded. QEMU has + specific code to detect CDROM insertion or removal. CDROM ejection by + the guest OS is supported. Currently only data CDs are supported. + +Floppy + You can specify a floppy device even if no floppy is loaded. Floppy + removal is currently not detected accurately (if you change floppy + without doing floppy access while the floppy is not loaded, the guest + OS will think that the same floppy is loaded). + Use of the host's floppy device is deprecated, and support for it will + be removed in a future release. + +Hard disks + Hard disks can be used. Normally you must specify the whole disk + (``/dev/hdb`` instead of ``/dev/hdb1``) so that the guest OS can + see it as a partitioned disk. WARNING: unless you know what you do, it + is better to only make READ-ONLY accesses to the hard disk otherwise + you may corrupt your host data (use the ``-snapshot`` command + line option or modify the device permissions accordingly). + +Windows +^^^^^^^ + +CD + The preferred syntax is the drive letter (e.g. ``d:``). The + alternate syntax ``\\.\d:`` is supported. ``/dev/cdrom`` is + supported as an alias to the first CDROM drive. + + Currently there is no specific code to handle removable media, so it + is better to use the ``change`` or ``eject`` monitor commands to + change or eject media. + +Hard disks + Hard disks can be used with the syntax: ``\\.\PhysicalDriveN`` + where *N* is the drive number (0 is the first hard disk). + + WARNING: unless you know what you do, it is better to only make + READ-ONLY accesses to the hard disk otherwise you may corrupt your + host data (use the ``-snapshot`` command line so that the + modifications are written in a temporary file). + +Mac OS X +^^^^^^^^ + +``/dev/cdrom`` is an alias to the first CDROM. + +Currently there is no specific code to handle removable media, so it +is better to use the ``change`` or ``eject`` monitor commands to +change or eject media. + +Virtual FAT disk images +~~~~~~~~~~~~~~~~~~~~~~~ + +QEMU can automatically create a virtual FAT disk image from a +directory tree. In order to use it, just type: + +.. parsed-literal:: + + |qemu_system| linux.img -hdb fat:/my_directory + +Then you access access to all the files in the ``/my_directory`` +directory without having to copy them in a disk image or to export +them via SAMBA or NFS. The default access is *read-only*. + +Floppies can be emulated with the ``:floppy:`` option: + +.. parsed-literal:: + + |qemu_system| linux.img -fda fat:floppy:/my_directory + +A read/write support is available for testing (beta stage) with the +``:rw:`` option: + +.. parsed-literal:: + + |qemu_system| linux.img -fda fat:floppy:rw:/my_directory + +What you should *never* do: + +- use non-ASCII filenames +- use "-snapshot" together with ":rw:" +- expect it to work when loadvm'ing +- write to the FAT directory on the host system while accessing it with the guest system + +NBD access +~~~~~~~~~~ + +QEMU can access directly to block device exported using the Network Block Device +protocol. + +.. parsed-literal:: + + |qemu_system| linux.img -hdb nbd://my_nbd_server.mydomain.org:1024/ + +If the NBD server is located on the same host, you can use an unix socket instead +of an inet socket: + +.. parsed-literal:: + + |qemu_system| linux.img -hdb nbd+unix://?socket=/tmp/my_socket + +In this case, the block device must be exported using qemu-nbd: + +.. parsed-literal:: + + qemu-nbd --socket=/tmp/my_socket my_disk.qcow2 + +The use of qemu-nbd allows sharing of a disk between several guests: + +.. parsed-literal:: + + qemu-nbd --socket=/tmp/my_socket --share=2 my_disk.qcow2 + +and then you can use it with two guests: + +.. parsed-literal:: + + |qemu_system| linux1.img -hdb nbd+unix://?socket=/tmp/my_socket + |qemu_system| linux2.img -hdb nbd+unix://?socket=/tmp/my_socket + +If the nbd-server uses named exports (supported since NBD 2.9.18, or with QEMU's +own embedded NBD server), you must specify an export name in the URI: + +.. parsed-literal:: + + |qemu_system| -cdrom nbd://localhost/debian-500-ppc-netinst + |qemu_system| -cdrom nbd://localhost/openSUSE-11.1-ppc-netinst + +The URI syntax for NBD is supported since QEMU 1.3. An alternative syntax is +also available. Here are some example of the older syntax: + +.. parsed-literal:: + + |qemu_system| linux.img -hdb nbd:my_nbd_server.mydomain.org:1024 + |qemu_system| linux2.img -hdb nbd:unix:/tmp/my_socket + |qemu_system| -cdrom nbd:localhost:10809:exportname=debian-500-ppc-netinst + + + +Sheepdog disk images +~~~~~~~~~~~~~~~~~~~~ + +Sheepdog is a distributed storage system for QEMU. It provides highly +available block level storage volumes that can be attached to +QEMU-based virtual machines. + +You can create a Sheepdog disk image with the command: + +.. parsed-literal:: + + qemu-img create sheepdog:///IMAGE SIZE + +where *IMAGE* is the Sheepdog image name and *SIZE* is its +size. + +To import the existing *FILENAME* to Sheepdog, you can use a +convert command. + +.. parsed-literal:: + + qemu-img convert FILENAME sheepdog:///IMAGE + +You can boot from the Sheepdog disk image with the command: + +.. parsed-literal:: + + |qemu_system| sheepdog:///IMAGE + +You can also create a snapshot of the Sheepdog image like qcow2. + +.. parsed-literal:: + + qemu-img snapshot -c TAG sheepdog:///IMAGE + +where *TAG* is a tag name of the newly created snapshot. + +To boot from the Sheepdog snapshot, specify the tag name of the +snapshot. + +.. parsed-literal:: + + |qemu_system| sheepdog:///IMAGE#TAG + +You can create a cloned image from the existing snapshot. + +.. parsed-literal:: + + qemu-img create -b sheepdog:///BASE#TAG sheepdog:///IMAGE + +where *BASE* is an image name of the source snapshot and *TAG* +is its tag name. + +You can use an unix socket instead of an inet socket: + +.. parsed-literal:: + + |qemu_system| sheepdog+unix:///IMAGE?socket=PATH + +If the Sheepdog daemon doesn't run on the local host, you need to +specify one of the Sheepdog servers to connect to. + +.. parsed-literal:: + + qemu-img create sheepdog://HOSTNAME:PORT/IMAGE SIZE + |qemu_system| sheepdog://HOSTNAME:PORT/IMAGE + +iSCSI LUNs +~~~~~~~~~~ + +iSCSI is a popular protocol used to access SCSI devices across a computer +network. + +There are two different ways iSCSI devices can be used by QEMU. + +The first method is to mount the iSCSI LUN on the host, and make it appear as +any other ordinary SCSI device on the host and then to access this device as a +/dev/sd device from QEMU. How to do this differs between host OSes. + +The second method involves using the iSCSI initiator that is built into +QEMU. This provides a mechanism that works the same way regardless of which +host OS you are running QEMU on. This section will describe this second method +of using iSCSI together with QEMU. + +In QEMU, iSCSI devices are described using special iSCSI URLs. URL syntax: + +:: + + iscsi://[[%]@][:]// + +Username and password are optional and only used if your target is set up +using CHAP authentication for access control. +Alternatively the username and password can also be set via environment +variables to have these not show up in the process list: + +:: + + export LIBISCSI_CHAP_USERNAME= + export LIBISCSI_CHAP_PASSWORD= + iscsi://// + +Various session related parameters can be set via special options, either +in a configuration file provided via '-readconfig' or directly on the +command line. + +If the initiator-name is not specified qemu will use a default name +of 'iqn.2008-11.org.linux-kvm[:'] where is the UUID of the +virtual machine. If the UUID is not specified qemu will use +'iqn.2008-11.org.linux-kvm[:'] where is the name of the +virtual machine. + +Setting a specific initiator name to use when logging in to the target: + +:: + + -iscsi initiator-name=iqn.qemu.test:my-initiator + +Controlling which type of header digest to negotiate with the target: + +:: + + -iscsi header-digest=CRC32C|CRC32C-NONE|NONE-CRC32C|NONE + +These can also be set via a configuration file: + +:: + + [iscsi] + user = "CHAP username" + password = "CHAP password" + initiator-name = "iqn.qemu.test:my-initiator" + # header digest is one of CRC32C|CRC32C-NONE|NONE-CRC32C|NONE + header-digest = "CRC32C" + +Setting the target name allows different options for different targets: + +:: + + [iscsi "iqn.target.name"] + user = "CHAP username" + password = "CHAP password" + initiator-name = "iqn.qemu.test:my-initiator" + # header digest is one of CRC32C|CRC32C-NONE|NONE-CRC32C|NONE + header-digest = "CRC32C" + +How to use a configuration file to set iSCSI configuration options: + +.. parsed-literal:: + + cat >iscsi.conf < /sys/bus/pci/devices/0000:06:0d.0/driver/unbind + # echo 1102 0002 > /sys/bus/pci/drivers/vfio-pci/new_id + + # |qemu_system| -drive file=nvme://HOST:BUS:SLOT.FUNC/NAMESPACE + +Alternative syntax using properties: + +.. parsed-literal:: + + |qemu_system| -drive file.driver=nvme,file.device=HOST:BUS:SLOT.FUNC,file.namespace=NAMESPACE + +*HOST*:*BUS*:*SLOT*.\ *FUNC* is the NVMe controller's PCI device +address on the host. + +*NAMESPACE* is the NVMe namespace number, starting from 1. + +Disk image file locking +~~~~~~~~~~~~~~~~~~~~~~~ + +By default, QEMU tries to protect image files from unexpected concurrent +access, as long as it's supported by the block protocol driver and host +operating system. If multiple QEMU processes (including QEMU emulators and +utilities) try to open the same image with conflicting accessing modes, all but +the first one will get an error. + +This feature is currently supported by the file protocol on Linux with the Open +File Descriptor (OFD) locking API, and can be configured to fall back to POSIX +locking if the POSIX host doesn't support Linux OFD locking. + +To explicitly enable image locking, specify "locking=on" in the file protocol +driver options. If OFD locking is not possible, a warning will be printed and +the POSIX locking API will be used. In this case there is a risk that the lock +will get silently lost when doing hot plugging and block jobs, due to the +shortcomings of the POSIX locking API. + +QEMU transparently handles lock handover during shared storage migration. For +shared virtual disk images between multiple VMs, the "share-rw" device option +should be used. + +By default, the guest has exclusive write access to its disk image. If the +guest can safely share the disk image with other writers the +``-device ...,share-rw=on`` parameter can be used. This is only safe if +the guest is running software, such as a cluster file system, that +coordinates disk accesses to avoid corruption. + +Note that share-rw=on only declares the guest's ability to share the disk. +Some QEMU features, such as image file formats, require exclusive write access +to the disk image and this is unaffected by the share-rw=on option. + +Alternatively, locking can be fully disabled by "locking=off" block device +option. In the command line, the option is usually in the form of +"file.locking=off" as the protocol driver is normally placed as a "file" child +under a format driver. For example: + +:: + + -blockdev driver=qcow2,file.filename=/path/to/image,file.locking=off,file.driver=file + +To check if image locking is active, check the output of the "lslocks" command +on host and see if there are locks held by the QEMU process on the image file. +More than one byte could be locked by the QEMU instance, each byte of which +reflects a particular permission that is acquired or protected by the running +block driver. -- cgit v1.2.3-55-g7522 From de1572ca4902c057b100d5c3434f254dfc677ddd Mon Sep 17 00:00:00 2001 From: Peter Maydell Date: Fri, 28 Feb 2020 15:36:00 +0000 Subject: docs: Create defs.rst.inc as a place to define substitutions Rather than accumulating generally useful rST substitution definitions in individual rST files, create a defs.rst.inc where we can define these. To start with it has the |qemu_system| definition from qemu-block-drivers.rst. Add a comment noting a pitfall where putting literal markup in the definition of |qemu_system| makes it misrender manpage output; this means the point-of-use must handle the literal markup (which is almost always done by having it inside a parsed-literal block). Signed-off-by: Peter Maydell Reviewed-by: Kashyap Chamarthy Tested-by: Alex Bennée Message-id: 20200228153619.9906-15-peter.maydell@linaro.org --- Makefile | 1 + docs/conf.py | 6 ++++++ docs/defs.rst.inc | 11 +++++++++++ docs/system/qemu-block-drivers.rst | 2 -- 4 files changed, 18 insertions(+), 2 deletions(-) create mode 100644 docs/defs.rst.inc (limited to 'docs/system') diff --git a/Makefile b/Makefile index 7e60a43542..26bbd33443 100644 --- a/Makefile +++ b/Makefile @@ -1052,6 +1052,7 @@ sphinxdocs: $(MANUAL_BUILDDIR)/devel/index.html \ build-manual = $(call quiet-command,CONFDIR="$(qemu_confdir)" $(SPHINX_BUILD) $(if $(V),,-q) -W -b $2 -D version=$(VERSION) -D release="$(FULL_VERSION)" -d .doctrees/$1-$2 $(SRC_PATH)/docs/$1 $(MANUAL_BUILDDIR)/$1 ,"SPHINX","$(MANUAL_BUILDDIR)/$1") # We assume all RST files in the manual's directory are used in it manual-deps = $(wildcard $(SRC_PATH)/docs/$1/*.rst) \ + $(SRC_PATH)/docs/defs.rst.inc \ $(SRC_PATH)/docs/$1/conf.py $(SRC_PATH)/docs/conf.py # Macro to write out the rule and dependencies for building manpages # Usage: $(call define-manpage-rule,manualname,manpage1 manpage2...[,extradeps]) diff --git a/docs/conf.py b/docs/conf.py index 7588bf192e..960043cb86 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -132,6 +132,12 @@ suppress_warnings = ["ref.option"] # style document building; our Makefile always sets the variable. confdir = os.getenv('CONFDIR', "/etc/qemu") rst_epilog = ".. |CONFDIR| replace:: ``" + confdir + "``\n" +# We slurp in the defs.rst.inc and literally include it into rst_epilog, +# because Sphinx's include:: directive doesn't work with absolute paths +# and there isn't any one single relative path that will work for all +# documents and for both via-make and direct sphinx-build invocation. +with open(os.path.join(qemu_docdir, 'defs.rst.inc')) as f: + rst_epilog += f.read() # -- Options for HTML output ---------------------------------------------- diff --git a/docs/defs.rst.inc b/docs/defs.rst.inc new file mode 100644 index 0000000000..ae80d2f35d --- /dev/null +++ b/docs/defs.rst.inc @@ -0,0 +1,11 @@ +.. + Generally useful rST substitution definitions. This is included for + all rST files as part of the epilogue by docs/conf.py. conf.py + also defines some dynamically generated substitutions like CONFDIR. + + Note that |qemu_system| is intended to be used inside a parsed-literal + block: the definition must not include extra literal formatting with + ``..``: this works in the HTML output but the manpages will end up + misrendered with following normal text incorrectly in boldface. + +.. |qemu_system| replace:: qemu-system-x86_64 diff --git a/docs/system/qemu-block-drivers.rst b/docs/system/qemu-block-drivers.rst index 7ca890ea23..bd99d4fa8e 100644 --- a/docs/system/qemu-block-drivers.rst +++ b/docs/system/qemu-block-drivers.rst @@ -3,8 +3,6 @@ QEMU block drivers reference ============================ -.. |qemu_system| replace:: qemu-system-x86_64 - Synopsis -------- -- cgit v1.2.3-55-g7522 From 1bf84a1e2e8f3262c63469b11fb641fcc9747e6a Mon Sep 17 00:00:00 2001 From: Kashyap Chamarthy Date: Fri, 28 Feb 2020 15:36:01 +0000 Subject: docs/system: Convert qemu-cpu-models.texi to rST This doc was originally written by Daniel P. Berrangé , introduced via commit[1]: 2544e9e4aa (docs: add guidance on configuring CPU models for x86, 2018-06-27). In this patch: - 1-1 conversion of Texinfo to rST, besides a couple of minor tweaks that are too trivial to mention. (Thanks to Stephen Finucane on IRC for the suggestion to use rST "definition lists" instead of bullets in some places.) Further modifications will be done via a separate patch. - rST and related infra changes: manual page generation, Makefile fixes, clean up references to qemu-cpu-models.texi, update year in the copyright notice, etc. [1] https://git.qemu.org/?p=qemu.git;a=commit;h=2544e9e4aa As part of the conversion, we use a more generic 'author' attribution for the manpage than we previously had, as agreed with the original author Dan Berrange. Signed-off-by: Kashyap Chamarthy Signed-off-by: Paolo Bonzini Reviewed-by: Alex Bennée Tested-by: Alex Bennée Signed-off-by: Peter Maydell Message-id: 20200228153619.9906-16-peter.maydell@linaro.org Message-id: 20200226113034.6741-15-pbonzini@redhat.com [Move macros to defs.rst.inc, split in x86 and MIPS parts, make qemu-cpu-models.rst a standalone document. - Paolo] Signed-off-by: Paolo Bonzini [PMM: Move defs.rst.inc setup to its own commit; fix minor issues with MAINTAINERS file updates; drop copyright date change; keep capitalization of "QEMU Project developers" consistent with other uses; minor Makefile fixups] Signed-off-by: Peter Maydell --- MAINTAINERS | 2 + Makefile | 8 +- docs/system/conf.py | 6 +- docs/system/cpu-models-mips.rst.inc | 105 +++++++++++ docs/system/cpu-models-x86.rst.inc | 365 ++++++++++++++++++++++++++++++++++++ docs/system/qemu-cpu-models.rst | 20 ++ docs/system/qemu-cpu-models.texi | 28 --- 7 files changed, 500 insertions(+), 34 deletions(-) create mode 100644 docs/system/cpu-models-mips.rst.inc create mode 100644 docs/system/cpu-models-x86.rst.inc create mode 100644 docs/system/qemu-cpu-models.rst delete mode 100644 docs/system/qemu-cpu-models.texi (limited to 'docs/system') diff --git a/MAINTAINERS b/MAINTAINERS index 584264535c..4cdd2d5276 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -216,6 +216,7 @@ F: target/mips/ F: default-configs/*mips* F: disas/*mips* F: docs/system/cpu-models-mips.texi +F: docs/system/cpu-models-mips.rst.inc F: hw/intc/mips_gic.c F: hw/mips/ F: hw/misc/mips_* @@ -321,6 +322,7 @@ F: tests/tcg/x86_64/ F: hw/i386/ F: disas/i386.c F: docs/system/cpu-models-x86.texi +F: docs/system/cpu-models-x86.rst.inc T: git https://github.com/ehabkost/qemu.git x86-next Xtensa TCG CPUs diff --git a/Makefile b/Makefile index 26bbd33443..f8642cd28a 100644 --- a/Makefile +++ b/Makefile @@ -354,7 +354,7 @@ endif DOCS+=$(MANUAL_BUILDDIR)/system/qemu-block-drivers.7 DOCS+=docs/interop/qemu-qmp-ref.html docs/interop/qemu-qmp-ref.txt docs/interop/qemu-qmp-ref.7 DOCS+=docs/interop/qemu-ga-ref.html docs/interop/qemu-ga-ref.txt docs/interop/qemu-ga-ref.7 -DOCS+=docs/system/qemu-cpu-models.7 +DOCS+=$(MANUAL_BUILDDIR)/system/qemu-cpu-models.7 DOCS+=$(MANUAL_BUILDDIR)/index.html ifdef CONFIG_VIRTFS DOCS+=$(MANUAL_BUILDDIR)/tools/virtfs-proxy-helper.1 @@ -780,7 +780,6 @@ distclean: clean rm -f docs/interop/qemu-qmp-ref.txt docs/interop/qemu-ga-ref.txt rm -f docs/interop/qemu-qmp-ref.pdf docs/interop/qemu-ga-ref.pdf rm -f docs/interop/qemu-qmp-ref.html docs/interop/qemu-ga-ref.html - rm -f docs/system/qemu-cpu-models.7 rm -rf .doctrees $(call clean-manual,devel) $(call clean-manual,interop) @@ -861,7 +860,7 @@ ifdef CONFIG_POSIX $(INSTALL_DIR) "$(DESTDIR)$(mandir)/man7" $(INSTALL_DATA) docs/interop/qemu-qmp-ref.7 "$(DESTDIR)$(mandir)/man7" $(INSTALL_DATA) $(MANUAL_BUILDDIR)/system/qemu-block-drivers.7 "$(DESTDIR)$(mandir)/man7" - $(INSTALL_DATA) docs/system/qemu-cpu-models.7 "$(DESTDIR)$(mandir)/man7" + $(INSTALL_DATA) $(MANUAL_BUILDDIR)/system/qemu-cpu-models.7 "$(DESTDIR)$(mandir)/man7" ifeq ($(CONFIG_TOOLS),y) $(INSTALL_DATA) $(MANUAL_BUILDDIR)/tools/qemu-img.1 "$(DESTDIR)$(mandir)/man1" $(INSTALL_DIR) "$(DESTDIR)$(mandir)/man8" @@ -1083,7 +1082,7 @@ $(MANUAL_BUILDDIR)/user/index.html: $(call manual-deps,user) $(call define-manpage-rule,interop,qemu-ga.8) -$(call define-manpage-rule,system,qemu-block-drivers.7) +$(call define-manpage-rule,system,qemu-block-drivers.7 qemu-cpu-models.7) $(call define-manpage-rule,tools,\ qemu-img.1 qemu-nbd.8 qemu-trace-stap.1\ @@ -1112,7 +1111,6 @@ docs/interop/qemu-ga-qapi.texi: qga/qapi-generated/qga-qapi-doc.texi qemu.1: qemu-doc.texi qemu-options.texi qemu-monitor.texi qemu-monitor-info.texi qemu.1: docs/system/qemu-option-trace.texi -docs/system/qemu-cpu-models.7: docs/system/qemu-cpu-models.texi docs/system/cpu-models-x86.texi docs/system/cpu-models-mips.texi html: qemu-doc.html docs/interop/qemu-qmp-ref.html docs/interop/qemu-ga-ref.html sphinxdocs info: qemu-doc.info docs/interop/qemu-qmp-ref.info docs/interop/qemu-ga-ref.info diff --git a/docs/system/conf.py b/docs/system/conf.py index 7ca115f5e0..23cab3fb36 100644 --- a/docs/system/conf.py +++ b/docs/system/conf.py @@ -13,10 +13,14 @@ exec(compile(open(parent_config, "rb").read(), parent_config, 'exec')) # This slightly misuses the 'description', but is the best way to get # the manual title to appear in the sidebar. html_theme_options['description'] = u'System Emulation User''s Guide' + # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ ('qemu-block-drivers', 'qemu-block-drivers', u'QEMU block drivers reference', - ['Fabrice Bellard and the QEMU Project developers'], 7) + ['Fabrice Bellard and the QEMU Project developers'], 7), + ('qemu-cpu-models', 'qemu-cpu-models', + u'QEMU CPU Models', + ['The QEMU Project developers'], 7) ] diff --git a/docs/system/cpu-models-mips.rst.inc b/docs/system/cpu-models-mips.rst.inc new file mode 100644 index 0000000000..499b5b6fed --- /dev/null +++ b/docs/system/cpu-models-mips.rst.inc @@ -0,0 +1,105 @@ +Supported CPU model configurations on MIPS hosts +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +QEMU supports variety of MIPS CPU models: + +Supported CPU models for MIPS32 hosts +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +The following CPU models are supported for use on MIPS32 hosts. +Administrators / applications are recommended to use the CPU model that +matches the generation of the host CPUs in use. In a deployment with a +mixture of host CPU models between machines, if live migration +compatibility is required, use the newest CPU model that is compatible +across all desired hosts. + +``mips32r6-generic`` + MIPS32 Processor (Release 6, 2015) + +``P5600`` + MIPS32 Processor (P5600, 2014) + +``M14K``, ``M14Kc`` + MIPS32 Processor (M14K, 2009) + +``74Kf`` + MIPS32 Processor (74K, 2007) + +``34Kf`` + MIPS32 Processor (34K, 2006) + +``24Kc``, ``24KEc``, ``24Kf`` + MIPS32 Processor (24K, 2003) + +``4Kc``, ``4Km``, ``4KEcR1``, ``4KEmR1``, ``4KEc``, ``4KEm`` + MIPS32 Processor (4K, 1999) + + +Supported CPU models for MIPS64 hosts +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +The following CPU models are supported for use on MIPS64 hosts. +Administrators / applications are recommended to use the CPU model that +matches the generation of the host CPUs in use. In a deployment with a +mixture of host CPU models between machines, if live migration +compatibility is required, use the newest CPU model that is compatible +across all desired hosts. + +``I6400`` + MIPS64 Processor (Release 6, 2014) + +``Loongson-2F`` + MIPS64 Processor (Loongson 2, 2008) + +``Loongson-2E`` + MIPS64 Processor (Loongson 2, 2006) + +``mips64dspr2`` + MIPS64 Processor (Release 2, 2006) + +``MIPS64R2-generic``, ``5KEc``, ``5KEf`` + MIPS64 Processor (Release 2, 2002) + +``20Kc`` + MIPS64 Processor (20K, 2000 + +``5Kc``, ``5Kf`` + MIPS64 Processor (5K, 1999) + +``VR5432`` + MIPS64 Processor (VR, 1998) + +``R4000`` + MIPS64 Processor (MIPS III, 1991) + + +Supported CPU models for nanoMIPS hosts +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +The following CPU models are supported for use on nanoMIPS hosts. +Administrators / applications are recommended to use the CPU model that +matches the generation of the host CPUs in use. In a deployment with a +mixture of host CPU models between machines, if live migration +compatibility is required, use the newest CPU model that is compatible +across all desired hosts. + +``I7200`` + MIPS I7200 (nanoMIPS, 2018) + +Preferred CPU models for MIPS hosts +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +The following CPU models are preferred for use on different MIPS hosts: + +``MIPS III`` + R4000 + +``MIPS32R2`` + 34Kf + +``MIPS64R6`` + I6400 + +``nanoMIPS`` + I7200 + diff --git a/docs/system/cpu-models-x86.rst.inc b/docs/system/cpu-models-x86.rst.inc new file mode 100644 index 0000000000..cbad930c70 --- /dev/null +++ b/docs/system/cpu-models-x86.rst.inc @@ -0,0 +1,365 @@ +Recommendations for KVM CPU model configuration on x86 hosts +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The information that follows provides recommendations for configuring +CPU models on x86 hosts. The goals are to maximise performance, while +protecting guest OS against various CPU hardware flaws, and optionally +enabling live migration between hosts with heterogeneous CPU models. + + +Two ways to configure CPU models with QEMU / KVM +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +(1) **Host passthrough** + + This passes the host CPU model features, model, stepping, exactly to + the guest. Note that KVM may filter out some host CPU model features + if they cannot be supported with virtualization. Live migration is + unsafe when this mode is used as libvirt / QEMU cannot guarantee a + stable CPU is exposed to the guest across hosts. This is the + recommended CPU to use, provided live migration is not required. + +(2) **Named model** + + QEMU comes with a number of predefined named CPU models, that + typically refer to specific generations of hardware released by + Intel and AMD. These allow the guest VMs to have a degree of + isolation from the host CPU, allowing greater flexibility in live + migrating between hosts with differing hardware. @end table + +In both cases, it is possible to optionally add or remove individual CPU +features, to alter what is presented to the guest by default. + +Libvirt supports a third way to configure CPU models known as "Host +model". This uses the QEMU "Named model" feature, automatically picking +a CPU model that is similar the host CPU, and then adding extra features +to approximate the host model as closely as possible. This does not +guarantee the CPU family, stepping, etc will precisely match the host +CPU, as they would with "Host passthrough", but gives much of the +benefit of passthrough, while making live migration safe. + + +Preferred CPU models for Intel x86 hosts +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +The following CPU models are preferred for use on Intel hosts. +Administrators / applications are recommended to use the CPU model that +matches the generation of the host CPUs in use. In a deployment with a +mixture of host CPU models between machines, if live migration +compatibility is required, use the newest CPU model that is compatible +across all desired hosts. + +``Skylake-Server``, ``Skylake-Server-IBRS`` + Intel Xeon Processor (Skylake, 2016) + +``Skylake-Client``, ``Skylake-Client-IBRS`` + Intel Core Processor (Skylake, 2015) + +``Broadwell``, ``Broadwell-IBRS``, ``Broadwell-noTSX``, ``Broadwell-noTSX-IBRS`` + Intel Core Processor (Broadwell, 2014) + +``Haswell``, ``Haswell-IBRS``, ``Haswell-noTSX``, ``Haswell-noTSX-IBRS`` + Intel Core Processor (Haswell, 2013) + +``IvyBridge``, ``IvyBridge-IBR`` + Intel Xeon E3-12xx v2 (Ivy Bridge, 2012) + +``SandyBridge``, ``SandyBridge-IBRS`` + Intel Xeon E312xx (Sandy Bridge, 2011) + +``Westmere``, ``Westmere-IBRS`` + Westmere E56xx/L56xx/X56xx (Nehalem-C, 2010) + +``Nehalem``, ``Nehalem-IBRS`` + Intel Core i7 9xx (Nehalem Class Core i7, 2008) + +``Penryn`` + Intel Core 2 Duo P9xxx (Penryn Class Core 2, 2007) + +``Conroe`` + Intel Celeron_4x0 (Conroe/Merom Class Core 2, 2006) + + +Important CPU features for Intel x86 hosts +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +The following are important CPU features that should be used on Intel +x86 hosts, when available in the host CPU. Some of them require explicit +configuration to enable, as they are not included by default in some, or +all, of the named CPU models listed above. In general all of these +features are included if using "Host passthrough" or "Host model". + +``pcid`` + Recommended to mitigate the cost of the Meltdown (CVE-2017-5754) fix. + + Included by default in Haswell, Broadwell & Skylake Intel CPU models. + + Should be explicitly turned on for Westmere, SandyBridge, and + IvyBridge Intel CPU models. Note that some desktop/mobile Westmere + CPUs cannot support this feature. + +``spec-ctrl`` + Required to enable the Spectre v2 (CVE-2017-5715) fix. + + Included by default in Intel CPU models with -IBRS suffix. + + Must be explicitly turned on for Intel CPU models without -IBRS + suffix. + + Requires the host CPU microcode to support this feature before it + can be used for guest CPUs. + +``stibp`` + Required to enable stronger Spectre v2 (CVE-2017-5715) fixes in some + operating systems. + + Must be explicitly turned on for all Intel CPU models. + + Requires the host CPU microcode to support this feature before it can + be used for guest CPUs. + +``ssbd`` + Required to enable the CVE-2018-3639 fix. + + Not included by default in any Intel CPU model. + + Must be explicitly turned on for all Intel CPU models. + + Requires the host CPU microcode to support this feature before it + can be used for guest CPUs. + +``pdpe1gb`` + Recommended to allow guest OS to use 1GB size pages. + + Not included by default in any Intel CPU model. + + Should be explicitly turned on for all Intel CPU models. + + Note that not all CPU hardware will support this feature. + +``md-clear`` + Required to confirm the MDS (CVE-2018-12126, CVE-2018-12127, + CVE-2018-12130, CVE-2019-11091) fixes. + + Not included by default in any Intel CPU model. + + Must be explicitly turned on for all Intel CPU models. + + Requires the host CPU microcode to support this feature before it + can be used for guest CPUs. + + +Preferred CPU models for AMD x86 hosts +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +The following CPU models are preferred for use on Intel hosts. +Administrators / applications are recommended to use the CPU model that +matches the generation of the host CPUs in use. In a deployment with a +mixture of host CPU models between machines, if live migration +compatibility is required, use the newest CPU model that is compatible +across all desired hosts. + +``EPYC``, ``EPYC-IBPB`` + AMD EPYC Processor (2017) + +``Opteron_G5`` + AMD Opteron 63xx class CPU (2012) + +``Opteron_G4`` + AMD Opteron 62xx class CPU (2011) + +``Opteron_G3`` + AMD Opteron 23xx (Gen 3 Class Opteron, 2009) + +``Opteron_G2`` + AMD Opteron 22xx (Gen 2 Class Opteron, 2006) + +``Opteron_G1`` + AMD Opteron 240 (Gen 1 Class Opteron, 2004) + + +Important CPU features for AMD x86 hosts +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +The following are important CPU features that should be used on AMD x86 +hosts, when available in the host CPU. Some of them require explicit +configuration to enable, as they are not included by default in some, or +all, of the named CPU models listed above. In general all of these +features are included if using "Host passthrough" or "Host model". + +``ibpb`` + Required to enable the Spectre v2 (CVE-2017-5715) fix. + + Included by default in AMD CPU models with -IBPB suffix. + + Must be explicitly turned on for AMD CPU models without -IBPB suffix. + + Requires the host CPU microcode to support this feature before it + can be used for guest CPUs. + +``stibp`` + Required to enable stronger Spectre v2 (CVE-2017-5715) fixes in some + operating systems. + + Must be explicitly turned on for all AMD CPU models. + + Requires the host CPU microcode to support this feature before it + can be used for guest CPUs. + +``virt-ssbd`` + Required to enable the CVE-2018-3639 fix + + Not included by default in any AMD CPU model. + + Must be explicitly turned on for all AMD CPU models. + + This should be provided to guests, even if amd-ssbd is also provided, + for maximum guest compatibility. + + Note for some QEMU / libvirt versions, this must be force enabled when + when using "Host model", because this is a virtual feature that + doesn't exist in the physical host CPUs. + +``amd-ssbd`` + Required to enable the CVE-2018-3639 fix + + Not included by default in any AMD CPU model. + + Must be explicitly turned on for all AMD CPU models. + + This provides higher performance than ``virt-ssbd`` so should be + exposed to guests whenever available in the host. ``virt-ssbd`` should + none the less also be exposed for maximum guest compatibility as some + kernels only know about ``virt-ssbd``. + +``amd-no-ssb`` + Recommended to indicate the host is not vulnerable CVE-2018-3639 + + Not included by default in any AMD CPU model. + + Future hardware generations of CPU will not be vulnerable to + CVE-2018-3639, and thus the guest should be told not to enable + its mitigations, by exposing amd-no-ssb. This is mutually + exclusive with virt-ssbd and amd-ssbd. + +``pdpe1gb`` + Recommended to allow guest OS to use 1GB size pages + + Not included by default in any AMD CPU model. + + Should be explicitly turned on for all AMD CPU models. + + Note that not all CPU hardware will support this feature. + + +Default x86 CPU models +^^^^^^^^^^^^^^^^^^^^^^ + +The default QEMU CPU models are designed such that they can run on all +hosts. If an application does not wish to do perform any host +compatibility checks before launching guests, the default is guaranteed +to work. + +The default CPU models will, however, leave the guest OS vulnerable to +various CPU hardware flaws, so their use is strongly discouraged. +Applications should follow the earlier guidance to setup a better CPU +configuration, with host passthrough recommended if live migration is +not needed. + +``qemu32``, ``qemu64`` + QEMU Virtual CPU version 2.5+ (32 & 64 bit variants) + +``qemu64`` is used for x86_64 guests and ``qemu32`` is used for i686 +guests, when no ``-cpu`` argument is given to QEMU, or no ```` is +provided in libvirt XML. + +Other non-recommended x86 CPUs +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +The following CPUs models are compatible with most AMD and Intel x86 +hosts, but their usage is discouraged, as they expose a very limited +featureset, which prevents guests having optimal performance. + +``kvm32``, ``kvm64`` + Common KVM processor (32 & 64 bit variants). + + Legacy models just for historical compatibility with ancient QEMU + versions. + +``486``, ``athlon``, ``phenom``, ``coreduo``, ``core2duo``, ``n270``, ``pentium``, ``pentium2``, ``pentium3`` + Various very old x86 CPU models, mostly predating the introduction + of hardware assisted virtualization, that should thus not be + required for running virtual machines. + + +Syntax for configuring CPU models +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The examples below illustrate the approach to configuring the various +CPU models / features in QEMU and libvirt. + +QEMU command line +^^^^^^^^^^^^^^^^^ + +Host passthrough: + +.. parsed-literal:: + + |qemu_system| -cpu host + +Host passthrough with feature customization: + +.. parsed-literal:: + + |qemu_system| -cpu host,-vmx,... + +Named CPU models: + +.. parsed-literal:: + + |qemu_system| -cpu Westmere + +Named CPU models with feature customization: + +.. parsed-literal:: + + |qemu_system| -cpu Westmere,+pcid,... + +Libvirt guest XML +^^^^^^^^^^^^^^^^^ + +Host passthrough:: + + + +Host passthrough with feature customization:: + + + + ... + + +Host model:: + + + +Host model with feature customization:: + + + + ... + + +Named model:: + + + + + +Named model with feature customization:: + + + + + ... + diff --git a/docs/system/qemu-cpu-models.rst b/docs/system/qemu-cpu-models.rst new file mode 100644 index 0000000000..53d7538c47 --- /dev/null +++ b/docs/system/qemu-cpu-models.rst @@ -0,0 +1,20 @@ +:orphan: + +QEMU / KVM CPU model configuration +================================== + +Synopsis +'''''''' + +QEMU CPU Modelling Infrastructure manual + +Description +''''''''''' + +.. include:: cpu-models-x86.rst.inc +.. include:: cpu-models-mips.rst.inc + +See also +'''''''' + +The HTML documentation of QEMU for more precise information and Linux user mode emulator invocation. diff --git a/docs/system/qemu-cpu-models.texi b/docs/system/qemu-cpu-models.texi deleted file mode 100644 index f399daf944..0000000000 --- a/docs/system/qemu-cpu-models.texi +++ /dev/null @@ -1,28 +0,0 @@ -@c man begin SYNOPSIS -QEMU / KVM CPU model configuration -@c man end - -@set qemu_system_x86 qemu-system-x86_64 - -@c man begin DESCRIPTION - -@include cpu-models-x86.texi -@include cpu-models-mips.texi - -@c man end - -@ignore - -@setfilename qemu-cpu-models -@settitle QEMU / KVM CPU model configuration - -@c man begin SEEALSO -The HTML documentation of QEMU for more precise information and Linux -user mode emulator invocation. -@c man end - -@c man begin AUTHOR -Daniel P. Berrange -@c man end - -@end ignore -- cgit v1.2.3-55-g7522 From c02c112a2ca66da9bf0843d428e27eac5107b365 Mon Sep 17 00:00:00 2001 From: Peter Maydell Date: Fri, 28 Feb 2020 15:36:02 +0000 Subject: docs/system: Convert security.texi to rST format security.texi is included from qemu-doc.texi but is not used in the qemu.1 manpage. So we can do a straightforward conversion of the contents, which go into the system manual. Signed-off-by: Peter Maydell Signed-off-by: Paolo Bonzini Reviewed-by: Alex Bennée Tested-by: Alex Bennée Message-id: 20200228153619.9906-17-peter.maydell@linaro.org Message-id: 20200226113034.6741-16-pbonzini@redhat.com --- docs/system/index.rst | 1 + docs/system/security.rst | 173 +++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 174 insertions(+) create mode 100644 docs/system/security.rst (limited to 'docs/system') diff --git a/docs/system/index.rst b/docs/system/index.rst index fc774a18b5..5034f90340 100644 --- a/docs/system/index.rst +++ b/docs/system/index.rst @@ -14,4 +14,5 @@ Contents: .. toctree:: :maxdepth: 2 + security vfio-ap diff --git a/docs/system/security.rst b/docs/system/security.rst new file mode 100644 index 0000000000..f2092c8768 --- /dev/null +++ b/docs/system/security.rst @@ -0,0 +1,173 @@ +Security +======== + +Overview +-------- + +This chapter explains the security requirements that QEMU is designed to meet +and principles for securely deploying QEMU. + +Security Requirements +--------------------- + +QEMU supports many different use cases, some of which have stricter security +requirements than others. The community has agreed on the overall security +requirements that users may depend on. These requirements define what is +considered supported from a security perspective. + +Virtualization Use Case +''''''''''''''''''''''' + +The virtualization use case covers cloud and virtual private server (VPS) +hosting, as well as traditional data center and desktop virtualization. These +use cases rely on hardware virtualization extensions to execute guest code +safely on the physical CPU at close-to-native speed. + +The following entities are untrusted, meaning that they may be buggy or +malicious: + +- Guest +- User-facing interfaces (e.g. VNC, SPICE, WebSocket) +- Network protocols (e.g. NBD, live migration) +- User-supplied files (e.g. disk images, kernels, device trees) +- Passthrough devices (e.g. PCI, USB) + +Bugs affecting these entities are evaluated on whether they can cause damage in +real-world use cases and treated as security bugs if this is the case. + +Non-virtualization Use Case +''''''''''''''''''''''''''' + +The non-virtualization use case covers emulation using the Tiny Code Generator +(TCG). In principle the TCG and device emulation code used in conjunction with +the non-virtualization use case should meet the same security requirements as +the virtualization use case. However, for historical reasons much of the +non-virtualization use case code was not written with these security +requirements in mind. + +Bugs affecting the non-virtualization use case are not considered security +bugs at this time. Users with non-virtualization use cases must not rely on +QEMU to provide guest isolation or any security guarantees. + +Architecture +------------ + +This section describes the design principles that ensure the security +requirements are met. + +Guest Isolation +''''''''''''''' + +Guest isolation is the confinement of guest code to the virtual machine. When +guest code gains control of execution on the host this is called escaping the +virtual machine. Isolation also includes resource limits such as throttling of +CPU, memory, disk, or network. Guests must be unable to exceed their resource +limits. + +QEMU presents an attack surface to the guest in the form of emulated devices. +The guest must not be able to gain control of QEMU. Bugs in emulated devices +could allow malicious guests to gain code execution in QEMU. At this point the +guest has escaped the virtual machine and is able to act in the context of the +QEMU process on the host. + +Guests often interact with other guests and share resources with them. A +malicious guest must not gain control of other guests or access their data. +Disk image files and network traffic must be protected from other guests unless +explicitly shared between them by the user. + +Principle of Least Privilege +'''''''''''''''''''''''''''' + +The principle of least privilege states that each component only has access to +the privileges necessary for its function. In the case of QEMU this means that +each process only has access to resources belonging to the guest. + +The QEMU process should not have access to any resources that are inaccessible +to the guest. This way the guest does not gain anything by escaping into the +QEMU process since it already has access to those same resources from within +the guest. + +Following the principle of least privilege immediately fulfills guest isolation +requirements. For example, guest A only has access to its own disk image file +``a.img`` and not guest B's disk image file ``b.img``. + +In reality certain resources are inaccessible to the guest but must be +available to QEMU to perform its function. For example, host system calls are +necessary for QEMU but are not exposed to guests. A guest that escapes into +the QEMU process can then begin invoking host system calls. + +New features must be designed to follow the principle of least privilege. +Should this not be possible for technical reasons, the security risk must be +clearly documented so users are aware of the trade-off of enabling the feature. + +Isolation mechanisms +'''''''''''''''''''' + +Several isolation mechanisms are available to realize this architecture of +guest isolation and the principle of least privilege. With the exception of +Linux seccomp, these mechanisms are all deployed by management tools that +launch QEMU, such as libvirt. They are also platform-specific so they are only +described briefly for Linux here. + +The fundamental isolation mechanism is that QEMU processes must run as +unprivileged users. Sometimes it seems more convenient to launch QEMU as +root to give it access to host devices (e.g. ``/dev/net/tun``) but this poses a +huge security risk. File descriptor passing can be used to give an otherwise +unprivileged QEMU process access to host devices without running QEMU as root. +It is also possible to launch QEMU as a non-root user and configure UNIX groups +for access to ``/dev/kvm``, ``/dev/net/tun``, and other device nodes. +Some Linux distros already ship with UNIX groups for these devices by default. + +- SELinux and AppArmor make it possible to confine processes beyond the + traditional UNIX process and file permissions model. They restrict the QEMU + process from accessing processes and files on the host system that are not + needed by QEMU. + +- Resource limits and cgroup controllers provide throughput and utilization + limits on key resources such as CPU time, memory, and I/O bandwidth. + +- Linux namespaces can be used to make process, file system, and other system + resources unavailable to QEMU. A namespaced QEMU process is restricted to only + those resources that were granted to it. + +- Linux seccomp is available via the QEMU ``--sandbox`` option. It disables + system calls that are not needed by QEMU, thereby reducing the host kernel + attack surface. + +Sensitive configurations +------------------------ + +There are aspects of QEMU that can have security implications which users & +management applications must be aware of. + +Monitor console (QMP and HMP) +''''''''''''''''''''''''''''' + +The monitor console (whether used with QMP or HMP) provides an interface +to dynamically control many aspects of QEMU's runtime operation. Many of the +commands exposed will instruct QEMU to access content on the host file system +and/or trigger spawning of external processes. + +For example, the ``migrate`` command allows for the spawning of arbitrary +processes for the purpose of tunnelling the migration data stream. The +``blockdev-add`` command instructs QEMU to open arbitrary files, exposing +their content to the guest as a virtual disk. + +Unless QEMU is otherwise confined using technologies such as SELinux, AppArmor, +or Linux namespaces, the monitor console should be considered to have privileges +equivalent to those of the user account QEMU is running under. + +It is further important to consider the security of the character device backend +over which the monitor console is exposed. It needs to have protection against +malicious third parties which might try to make unauthorized connections, or +perform man-in-the-middle attacks. Many of the character device backends do not +satisfy this requirement and so must not be used for the monitor console. + +The general recommendation is that the monitor console should be exposed over +a UNIX domain socket backend to the local host only. Use of the TCP based +character device backend is inappropriate unless configured to use both TLS +encryption and authorization control policy on client connections. + +In summary, the monitor console is considered a privileged control interface to +QEMU and as such should only be made accessible to a trusted management +application or user. -- cgit v1.2.3-55-g7522 From 2f4325df9e82507c7d55d1c7e2c72f2fdaf0237a Mon Sep 17 00:00:00 2001 From: Peter Maydell Date: Fri, 28 Feb 2020 15:36:03 +0000 Subject: docs/system: convert managed startup to rST. Fix one typo in the process and format more option and command names as literal text, but make no significant changes to the content. Signed-off-by: Peter Maydell Signed-off-by: Paolo Bonzini Reviewed-by: Alex Bennée Tested-by: Alex Bennée Message-id: 20200228153619.9906-18-peter.maydell@linaro.org Message-id: 20200226113034.6741-17-pbonzini@redhat.com --- docs/system/index.rst | 2 +- docs/system/managed-startup.rst | 35 +++++++++++++++++++++++++++++++++++ 2 files changed, 36 insertions(+), 1 deletion(-) create mode 100644 docs/system/managed-startup.rst (limited to 'docs/system') diff --git a/docs/system/index.rst b/docs/system/index.rst index 5034f90340..d655344fff 100644 --- a/docs/system/index.rst +++ b/docs/system/index.rst @@ -13,6 +13,6 @@ Contents: .. toctree:: :maxdepth: 2 - + managed-startup security vfio-ap diff --git a/docs/system/managed-startup.rst b/docs/system/managed-startup.rst new file mode 100644 index 0000000000..9bcf98ea79 --- /dev/null +++ b/docs/system/managed-startup.rst @@ -0,0 +1,35 @@ +Managed start up options +======================== + +In system mode emulation, it's possible to create a VM in a paused +state using the ``-S`` command line option. In this state the machine +is completely initialized according to command line options and ready +to execute VM code but VCPU threads are not executing any code. The VM +state in this paused state depends on the way QEMU was started. It +could be in: + +- initial state (after reset/power on state) +- with direct kernel loading, the initial state could be amended to execute + code loaded by QEMU in the VM's RAM and with incoming migration +- with incoming migration, initial state will be amended with the migrated + machine state after migration completes + +This paused state is typically used by users to query machine state and/or +additionally configure the machine (by hotplugging devices) in runtime before +allowing VM code to run. + +However, at the ``-S`` pause point, it's impossible to configure options +that affect initial VM creation (like: ``-smp``/``-m``/``-numa`` ...) or +cold plug devices. The experimental ``--preconfig`` command line option +allows pausing QEMU before the initial VM creation, in a "preconfig" state, +where additional queries and configuration can be performed via QMP +before moving on to the resulting configuration startup. In the +preconfig state, QEMU only allows a limited set of commands over the +QMP monitor, where the commands do not depend on an initialized +machine, including but not limited to: + +- ``qmp_capabilities`` +- ``query-qmp-schema`` +- ``query-commands`` +- ``query-status`` +- ``x-exit-preconfig`` -- cgit v1.2.3-55-g7522 From 41fba1618b7a743740670f528ba409478678cc7c Mon Sep 17 00:00:00 2001 From: Peter Maydell Date: Fri, 28 Feb 2020 15:36:04 +0000 Subject: docs/system: convert the documentation of deprecated features to rST. We put the whole of this document into the system manual, though technically a few parts of it apply to qemu-img or qemu-nbd which are otherwise documented in tools/. We only make formatting fixes, except for one use of 'appendix' which we change to 'section' because this isn't an appendix in the Sphinx manual. Signed-off-by: Peter Maydell Signed-off-by: Paolo Bonzini Reviewed-by: Alex Bennée Tested-by: Alex Bennée Message-id: 20200228153619.9906-19-peter.maydell@linaro.org Message-id: 20200226113034.6741-18-pbonzini@redhat.com --- docs/system/deprecated.rst | 446 +++++++++++++++++++++++++++++++++++++++++++++ docs/system/index.rst | 1 + 2 files changed, 447 insertions(+) create mode 100644 docs/system/deprecated.rst (limited to 'docs/system') diff --git a/docs/system/deprecated.rst b/docs/system/deprecated.rst new file mode 100644 index 0000000000..1eaa559079 --- /dev/null +++ b/docs/system/deprecated.rst @@ -0,0 +1,446 @@ +Deprecated features +=================== + +In general features are intended to be supported indefinitely once +introduced into QEMU. In the event that a feature needs to be removed, +it will be listed in this section. The feature will remain functional +for 2 releases prior to actual removal. Deprecated features may also +generate warnings on the console when QEMU starts up, or if activated +via a monitor command, however, this is not a mandatory requirement. + +Prior to the 2.10.0 release there was no official policy on how +long features would be deprecated prior to their removal, nor +any documented list of which features were deprecated. Thus +any features deprecated prior to 2.10.0 will be treated as if +they were first deprecated in the 2.10.0 release. + +What follows is a list of all features currently marked as +deprecated. + +System emulator command line arguments +-------------------------------------- + +``-machine enforce-config-section=on|off`` (since 3.1) +'''''''''''''''''''''''''''''''''''''''''''''''''''''' + +The ``enforce-config-section`` parameter is replaced by the +``-global migration.send-configuration={on|off}`` option. + +``-no-kvm`` (since 1.3.0) +''''''''''''''''''''''''' + +The ``-no-kvm`` argument is now a synonym for setting ``-accel tcg``. + +``-usbdevice`` (since 2.10.0) +''''''''''''''''''''''''''''' + +The ``-usbdevice DEV`` argument is now a synonym for setting +the ``-device usb-DEV`` argument instead. The deprecated syntax +would automatically enable USB support on the machine type. +If using the new syntax, USB support must be explicitly +enabled via the ``-machine usb=on`` argument. + +``-drive file=json:{...{'driver':'file'}}`` (since 3.0) +''''''''''''''''''''''''''''''''''''''''''''''''''''''' + +The 'file' driver for drives is no longer appropriate for character or host +devices and will only accept regular files (S_IFREG). The correct driver +for these file types is 'host_cdrom' or 'host_device' as appropriate. + +``-net ...,name=``\ *name* (since 3.1) +'''''''''''''''''''''''''''''''''''''' + +The ``name`` parameter of the ``-net`` option is a synonym +for the ``id`` parameter, which should now be used instead. + +``-smp`` (invalid topologies) (since 3.1) +''''''''''''''''''''''''''''''''''''''''' + +CPU topology properties should describe whole machine topology including +possible CPUs. + +However, historically it was possible to start QEMU with an incorrect topology +where *n* <= *sockets* * *cores* * *threads* < *maxcpus*, +which could lead to an incorrect topology enumeration by the guest. +Support for invalid topologies will be removed, the user must ensure +topologies described with -smp include all possible cpus, i.e. +*sockets* * *cores* * *threads* = *maxcpus*. + +``-vnc acl`` (since 4.0.0) +'''''''''''''''''''''''''' + +The ``acl`` option to the ``-vnc`` argument has been replaced +by the ``tls-authz`` and ``sasl-authz`` options. + +``QEMU_AUDIO_`` environment variables and ``-audio-help`` (since 4.0) +''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''' + +The ``-audiodev`` argument is now the preferred way to specify audio +backend settings instead of environment variables. To ease migration to +the new format, the ``-audiodev-help`` option can be used to convert +the current values of the environment variables to ``-audiodev`` options. + +Creating sound card devices and vnc without ``audiodev=`` property (since 4.2) +'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''' + +When not using the deprecated legacy audio config, each sound card +should specify an ``audiodev=`` property. Additionally, when using +vnc, you should specify an ``audiodev=`` propery if you plan to +transmit audio through the VNC protocol. + +``-mon ...,control=readline,pretty=on|off`` (since 4.1) +''''''''''''''''''''''''''''''''''''''''''''''''''''''' + +The ``pretty=on|off`` switch has no effect for HMP monitors, but is +silently ignored. Using the switch with HMP monitors will become an +error in the future. + +``-realtime`` (since 4.1) +''''''''''''''''''''''''' + +The ``-realtime mlock=on|off`` argument has been replaced by the +``-overcommit mem-lock=on|off`` argument. + +``-numa node,mem=``\ *size* (since 4.1) +''''''''''''''''''''''''''''''''''''''' + +The parameter ``mem`` of ``-numa node`` is used to assign a part of +guest RAM to a NUMA node. But when using it, it's impossible to manage specified +RAM chunk on the host side (like bind it to a host node, setting bind policy, ...), +so guest end-ups with the fake NUMA configuration with suboptiomal performance. +However since 2014 there is an alternative way to assign RAM to a NUMA node +using parameter ``memdev``, which does the same as ``mem`` and adds +means to actualy manage node RAM on the host side. Use parameter ``memdev`` +with *memory-backend-ram* backend as an replacement for parameter ``mem`` +to achieve the same fake NUMA effect or a properly configured +*memory-backend-file* backend to actually benefit from NUMA configuration. +In future new machine versions will not accept the option but it will still +work with old machine types. User can check QAPI schema to see if the legacy +option is supported by looking at MachineInfo::numa-mem-supported property. + +``-numa`` node (without memory specified) (since 4.1) +''''''''''''''''''''''''''''''''''''''''''''''''''''' + +Splitting RAM by default between NUMA nodes has the same issues as ``mem`` +parameter described above with the difference that the role of the user plays +QEMU using implicit generic or board specific splitting rule. +Use ``memdev`` with *memory-backend-ram* backend or ``mem`` (if +it's supported by used machine type) to define mapping explictly instead. + +``-mem-path`` fallback to RAM (since 4.1) +''''''''''''''''''''''''''''''''''''''''' + +Currently if guest RAM allocation from file pointed by ``mem-path`` +fails, QEMU falls back to allocating from RAM, which might result +in unpredictable behavior since the backing file specified by the user +is ignored. In the future, users will be responsible for making sure +the backing storage specified with ``-mem-path`` can actually provide +the guest RAM configured with ``-m`` and QEMU will fail to start up if +RAM allocation is unsuccessful. + +RISC-V ``-bios`` (since 4.1) +'''''''''''''''''''''''''''' + +QEMU 4.1 introduced support for the -bios option in QEMU for RISC-V for the +RISC-V virt machine and sifive_u machine. + +QEMU 4.1 has no changes to the default behaviour to avoid breakages. This +default will change in a future QEMU release, so please prepare now. All users +of the virt or sifive_u machine must change their command line usage. + +QEMU 4.1 has three options, please migrate to one of these three: + 1. ``-bios none`` - This is the current default behavior if no -bios option + is included. QEMU will not automatically load any firmware. It is up + to the user to load all the images they need. + 2. ``-bios default`` - In a future QEMU release this will become the default + behaviour if no -bios option is specified. This option will load the + default OpenSBI firmware automatically. The firmware is included with + the QEMU release and no user interaction is required. All a user needs + to do is specify the kernel they want to boot with the -kernel option + 3. ``-bios `` - Tells QEMU to load the specified file as the firmwrae. + +``-tb-size`` option (since 5.0) +''''''''''''''''''''''''''''''' + +QEMU 5.0 introduced an alternative syntax to specify the size of the translation +block cache, ``-accel tcg,tb-size=``. The new syntax deprecates the +previously available ``-tb-size`` option. + +``-show-cursor`` option (since 5.0) +''''''''''''''''''''''''''''''''''' + +Use ``-display sdl,show-cursor=on`` or + ``-display gtk,show-cursor=on`` instead. + +QEMU Machine Protocol (QMP) commands +------------------------------------ + +``change`` (since 2.5.0) +'''''''''''''''''''''''' + +Use ``blockdev-change-medium`` or ``change-vnc-password`` instead. + +``migrate_set_downtime`` and ``migrate_set_speed`` (since 2.8.0) +'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''' + +Use ``migrate-set-parameters`` instead. + +``migrate-set-cache-size`` and ``query-migrate-cache-size`` (since 2.11.0) +'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''' + +Use ``migrate-set-parameters`` and ``query-migrate-parameters`` instead. + +``query-block`` result field ``dirty-bitmaps[i].status`` (since 4.0) +'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''' + +The ``status`` field of the ``BlockDirtyInfo`` structure, returned by +the query-block command is deprecated. Two new boolean fields, +``recording`` and ``busy`` effectively replace it. + +``query-block`` result field ``dirty-bitmaps`` (Since 4.2) +'''''''''''''''''''''''''''''''''''''''''''''''''''''''''' + +The ``dirty-bitmaps`` field of the ``BlockInfo`` structure, returned by +the query-block command is itself now deprecated. The ``dirty-bitmaps`` +field of the ``BlockDeviceInfo`` struct should be used instead, which is the +type of the ``inserted`` field in query-block replies, as well as the +type of array items in query-named-block-nodes. + +Since the ``dirty-bitmaps`` field is optionally present in both the old and +new locations, clients must use introspection to learn where to anticipate +the field if/when it does appear in command output. + +``query-cpus`` (since 2.12.0) +''''''''''''''''''''''''''''' + +The ``query-cpus`` command is replaced by the ``query-cpus-fast`` command. + +``query-cpus-fast`` ``arch`` output member (since 3.0.0) +'''''''''''''''''''''''''''''''''''''''''''''''''''''''' + +The ``arch`` output member of the ``query-cpus-fast`` command is +replaced by the ``target`` output member. + +``cpu-add`` (since 4.0) +''''''''''''''''''''''' + +Use ``device_add`` for hotplugging vCPUs instead of ``cpu-add``. See +documentation of ``query-hotpluggable-cpus`` for additional +details. + +``query-events`` (since 4.0) +'''''''''''''''''''''''''''' + +The ``query-events`` command has been superseded by the more powerful +and accurate ``query-qmp-schema`` command. + +chardev client socket with ``wait`` option (since 4.0) +'''''''''''''''''''''''''''''''''''''''''''''''''''''' + +Character devices creating sockets in client mode should not specify +the 'wait' field, which is only applicable to sockets in server mode + +Human Monitor Protocol (HMP) commands +------------------------------------- + +The ``hub_id`` parameter of ``hostfwd_add`` / ``hostfwd_remove`` (since 3.1) +'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''' + +The ``[hub_id name]`` parameter tuple of the 'hostfwd_add' and +'hostfwd_remove' HMP commands has been replaced by ``netdev_id``. + +``cpu-add`` (since 4.0) +''''''''''''''''''''''' + +Use ``device_add`` for hotplugging vCPUs instead of ``cpu-add``. See +documentation of ``query-hotpluggable-cpus`` for additional details. + +``acl_show``, ``acl_reset``, ``acl_policy``, ``acl_add``, ``acl_remove`` (since 4.0.0) +'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''' + +The ``acl_show``, ``acl_reset``, ``acl_policy``, ``acl_add``, and +``acl_remove`` commands are deprecated with no replacement. Authorization +for VNC should be performed using the pluggable QAuthZ objects. + +Guest Emulator ISAs +------------------- + +RISC-V ISA privledge specification version 1.09.1 (since 4.1) +''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''' + +The RISC-V ISA privledge specification version 1.09.1 has been deprecated. +QEMU supports both the newer version 1.10.0 and the ratified version 1.11.0, these +should be used instead of the 1.09.1 version. + +System emulator CPUS +-------------------- + +RISC-V ISA CPUs (since 4.1) +''''''''''''''''''''''''''' + +The RISC-V cpus with the ISA version in the CPU name have been depcreated. The +four CPUs are: ``rv32gcsu-v1.9.1``, ``rv32gcsu-v1.10.0``, ``rv64gcsu-v1.9.1`` and +``rv64gcsu-v1.10.0``. Instead the version can be specified via the CPU ``priv_spec`` +option when using the ``rv32`` or ``rv64`` CPUs. + +RISC-V ISA CPUs (since 4.1) +''''''''''''''''''''''''''' + +The RISC-V no MMU cpus have been depcreated. The two CPUs: ``rv32imacu-nommu`` and +``rv64imacu-nommu`` should no longer be used. Instead the MMU status can be specified +via the CPU ``mmu`` option when using the ``rv32`` or ``rv64`` CPUs. + +System emulator devices +----------------------- + +``ide-drive`` (since 4.2) +''''''''''''''''''''''''' + +The 'ide-drive' device is deprecated. Users should use 'ide-hd' or +'ide-cd' as appropriate to get an IDE hard disk or CD-ROM as needed. + +``scsi-disk`` (since 4.2) +''''''''''''''''''''''''' + +The 'scsi-disk' device is deprecated. Users should use 'scsi-hd' or +'scsi-cd' as appropriate to get a SCSI hard disk or CD-ROM as needed. + +System emulator machines +------------------------ + +mips ``r4k`` platform (since 5.0) +''''''''''''''''''''''''''''''''' + +This machine type is very old and unmaintained. Users should use the ``malta`` +machine type instead. + +``pc-1.0``, ``pc-1.1``, ``pc-1.2`` and ``pc-1.3`` (since 5.0) +''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''' + +These machine types are very old and likely can not be used for live migration +from old QEMU versions anymore. A newer machine type should be used instead. + +``spike_v1.9.1`` and ``spike_v1.10`` (since 4.1) +'''''''''''''''''''''''''''''''''''''''''''''''' + +The version specific Spike machines have been deprecated in favour of the +generic ``spike`` machine. If you need to specify an older version of the RISC-V +spec you can use the ``-cpu rv64gcsu,priv_spec=v1.9.1`` command line argument. + +Device options +-------------- + +Emulated device options +''''''''''''''''''''''' + +``-device virtio-blk,scsi=on|off`` (since 5.0.0) +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +The virtio-blk SCSI passthrough feature is a legacy VIRTIO feature. VIRTIO 1.0 +and later do not support it because the virtio-scsi device was introduced for +full SCSI support. Use virtio-scsi instead when SCSI passthrough is required. + +Note this also applies to ``-device virtio-blk-pci,scsi=on|off``, which is an +alias. + +Block device options +'''''''''''''''''''' + +``"backing": ""`` (since 2.12.0) +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +In order to prevent QEMU from automatically opening an image's backing +chain, use ``"backing": null`` instead. + +``rbd`` keyvalue pair encoded filenames: ``""`` (since 3.1.0) +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Options for ``rbd`` should be specified according to its runtime options, +like other block drivers. Legacy parsing of keyvalue pair encoded +filenames is useful to open images with the old format for backing files; +These image files should be updated to use the current format. + +Example of legacy encoding:: + + json:{"file.driver":"rbd", "file.filename":"rbd:rbd/name"} + +The above, converted to the current supported format:: + + json:{"file.driver":"rbd", "file.pool":"rbd", "file.image":"name"} + +Related binaries +---------------- + +``qemu-img convert -n -o`` (since 4.2.0) +'''''''''''''''''''''''''''''''''''''''' + +All options specified in ``-o`` are image creation options, so +they have no effect when used with ``-n`` to skip image creation. +Silently ignored options can be confusing, so this combination of +options will be made an error in future versions. + +Backwards compatibility +----------------------- + +Runnability guarantee of CPU models (since 4.1.0) +''''''''''''''''''''''''''''''''''''''''''''''''' + +Previous versions of QEMU never changed existing CPU models in +ways that introduced additional host software or hardware +requirements to the VM. This allowed management software to +safely change the machine type of an existing VM without +introducing new requirements ("runnability guarantee"). This +prevented CPU models from being updated to include CPU +vulnerability mitigations, leaving guests vulnerable in the +default configuration. + +The CPU model runnability guarantee won't apply anymore to +existing CPU models. Management software that needs runnability +guarantees must resolve the CPU model aliases using te +``alias-of`` field returned by the ``query-cpu-definitions`` QMP +command. + +While those guarantees are kept, the return value of +``query-cpu-definitions`` will have existing CPU model aliases +point to a version that doesn't break runnability guarantees +(specifically, version 1 of those CPU models). In future QEMU +versions, aliases will point to newer CPU model versions +depending on the machine type, so management software must +resolve CPU model aliases before starting a virtual machine. + + +Recently removed features +========================= + +What follows is a record of recently removed, formerly deprecated +features that serves as a record for users who have encountered +trouble after a recent upgrade. + +QEMU Machine Protocol (QMP) commands +------------------------------------ + +``block-dirty-bitmap-add`` "autoload" parameter (since 4.2.0) +''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''' + +The "autoload" parameter has been ignored since 2.12.0. All bitmaps +are automatically loaded from qcow2 images. + +Related binaries +---------------- + +``qemu-nbd --partition`` (removed in 5.0.0) +''''''''''''''''''''''''''''''''''''''''''' + +The ``qemu-nbd --partition $digit`` code (also spelled ``-P``) +could only handle MBR partitions, and never correctly handled logical +partitions beyond partition 5. Exporting a partition can still be +done by utilizing the ``--image-opts`` option with a raw blockdev +using the ``offset`` and ``size`` parameters layered on top of +any other existing blockdev. For example, if partition 1 is 100MiB +long starting at 1MiB, the old command:: + + qemu-nbd -t -P 1 -f qcow2 file.qcow2 + +can be rewritten as:: + + qemu-nbd -t --image-opts driver=raw,offset=1M,size=100M,file.driver=qcow2,file.file.driver=file,file.file.filename=file.qcow2 diff --git a/docs/system/index.rst b/docs/system/index.rst index d655344fff..f2f29fb6d2 100644 --- a/docs/system/index.rst +++ b/docs/system/index.rst @@ -16,3 +16,4 @@ Contents: managed-startup security vfio-ap + deprecated -- cgit v1.2.3-55-g7522 From 324b2298feab35533d44301cfdae332c086463cf Mon Sep 17 00:00:00 2001 From: Paolo Bonzini Date: Fri, 28 Feb 2020 15:36:05 +0000 Subject: docs/system: convert Texinfo documentation to rST Apart from targets.rst, which was written by hand, this is an automated conversion obtained with the following command: makeinfo --force -o - --docbook \ -D 'qemu_system_x86 QEMU_SYSTEM_X86_MACRO' \ -D 'qemu_system QEMU_SYSTEM_MACRO' \ $texi | pandoc -f docbook -t rst+smart | perl -e ' $/=undef; $_ = <>; s/^- − /- /gm; s/QEMU_SYSTEM_MACRO/|qemu_system|/g; s/QEMU_SYSTEM_X86_MACRO/|qemu_system_x86|/g; s/(?=::\n\n +\|qemu)/.. parsed-literal/g; s/:\n\n::$/::/gm; print' > $rst In addition, the following changes were made manually: - target-i386.rst and target-mips.rst: replace CPU model documentation with an include directive - monitor.rst: replace the command section with a comment - images.rst: add toctree - target-arm.rst: Replace use of :math: (which Sphinx complains about) with :sup:, and hide it behind |I2C| and |I2C| substitutions. Content that is not @included remains exclusive to qemu-doc.texi. Signed-off-by: Paolo Bonzini Reviewed-by: Peter Maydell Reviewed-by: Alex Bennée Tested-by: Alex Bennée Signed-off-by: Peter Maydell Message-id: 20200228153619.9906-20-peter.maydell@linaro.org Message-id: 20200226113034.6741-19-pbonzini@redhat.com [PMM: Fixed target-arm.rst use of :math:; remove out of date note about images.rst from commit message; fixed expansion of |qemu_system_x86|; use parsed-literal in invocation.rst when we want to use |qemu_system_x86|; fix incorrect subsection level for "OS requirements" in target-i386.rst; fix incorrect syntax for making links to other sections of the manual] Reviewed-by: Peter Maydell Signed-off-by: Peter Maydell --- docs/defs.rst.inc | 12 +- docs/system/build-platforms.rst | 79 ++++++++++ docs/system/gdb.rst | 81 ++++++++++ docs/system/images.rst | 85 +++++++++++ docs/system/index.rst | 19 ++- docs/system/invocation.rst | 242 +++++++++++++++++++++++++++++ docs/system/ivshmem.rst | 64 ++++++++ docs/system/keys.rst | 40 +++++ docs/system/license.rst | 11 ++ docs/system/linuxboot.rst | 30 ++++ docs/system/monitor.rst | 25 +++ docs/system/mux-chardev.rst | 32 ++++ docs/system/net.rst | 100 ++++++++++++ docs/system/quickstart.rst | 13 ++ docs/system/target-arm.rst | 227 +++++++++++++++++++++++++++ docs/system/target-i386.rst | 84 ++++++++++ docs/system/target-m68k.rst | 32 ++++ docs/system/target-mips.rst | 120 +++++++++++++++ docs/system/target-ppc.rst | 61 ++++++++ docs/system/target-sparc.rst | 81 ++++++++++ docs/system/target-sparc64.rst | 49 ++++++ docs/system/target-xtensa.rst | 39 +++++ docs/system/targets.rst | 19 +++ docs/system/tls.rst | 328 ++++++++++++++++++++++++++++++++++++++++ docs/system/usb.rst | 137 +++++++++++++++++ docs/system/vnc-security.rst | 202 +++++++++++++++++++++++++ 26 files changed, 2207 insertions(+), 5 deletions(-) create mode 100644 docs/system/build-platforms.rst create mode 100644 docs/system/gdb.rst create mode 100644 docs/system/images.rst create mode 100644 docs/system/invocation.rst create mode 100644 docs/system/ivshmem.rst create mode 100644 docs/system/keys.rst create mode 100644 docs/system/license.rst create mode 100644 docs/system/linuxboot.rst create mode 100644 docs/system/monitor.rst create mode 100644 docs/system/mux-chardev.rst create mode 100644 docs/system/net.rst create mode 100644 docs/system/quickstart.rst create mode 100644 docs/system/target-arm.rst create mode 100644 docs/system/target-i386.rst create mode 100644 docs/system/target-m68k.rst create mode 100644 docs/system/target-mips.rst create mode 100644 docs/system/target-ppc.rst create mode 100644 docs/system/target-sparc.rst create mode 100644 docs/system/target-sparc64.rst create mode 100644 docs/system/target-xtensa.rst create mode 100644 docs/system/targets.rst create mode 100644 docs/system/tls.rst create mode 100644 docs/system/usb.rst create mode 100644 docs/system/vnc-security.rst (limited to 'docs/system') diff --git a/docs/defs.rst.inc b/docs/defs.rst.inc index ae80d2f35d..48d05aaf33 100644 --- a/docs/defs.rst.inc +++ b/docs/defs.rst.inc @@ -3,9 +3,13 @@ all rST files as part of the epilogue by docs/conf.py. conf.py also defines some dynamically generated substitutions like CONFDIR. - Note that |qemu_system| is intended to be used inside a parsed-literal - block: the definition must not include extra literal formatting with - ``..``: this works in the HTML output but the manpages will end up - misrendered with following normal text incorrectly in boldface. + Note that |qemu_system| and |qemu_system_x86| are intended to be + used inside a parsed-literal block: the definition must not include + extra literal formatting with ``..``: this works in the HTML output + but the manpages will end up misrendered with following normal text + incorrectly in boldface. .. |qemu_system| replace:: qemu-system-x86_64 +.. |qemu_system_x86| replace:: qemu_system-x86_64 +.. |I2C| replace:: I\ :sup:`2`\ C +.. |I2S| replace:: I\ :sup:`2`\ S diff --git a/docs/system/build-platforms.rst b/docs/system/build-platforms.rst new file mode 100644 index 0000000000..c2b92a9698 --- /dev/null +++ b/docs/system/build-platforms.rst @@ -0,0 +1,79 @@ +.. _Supported-build-platforms: + +Supported build platforms +========================= + +QEMU aims to support building and executing on multiple host OS +platforms. This appendix outlines which platforms are the major build +targets. These platforms are used as the basis for deciding upon the +minimum required versions of 3rd party software QEMU depends on. The +supported platforms are the targets for automated testing performed by +the project when patches are submitted for review, and tested before and +after merge. + +If a platform is not listed here, it does not imply that QEMU won't +work. If an unlisted platform has comparable software versions to a +listed platform, there is every expectation that it will work. Bug +reports are welcome for problems encountered on unlisted platforms +unless they are clearly older vintage than what is described here. + +Note that when considering software versions shipped in distros as +support targets, QEMU considers only the version number, and assumes the +features in that distro match the upstream release with the same +version. In other words, if a distro backports extra features to the +software in their distro, QEMU upstream code will not add explicit +support for those backports, unless the feature is auto-detectable in a +manner that works for the upstream releases too. + +The Repology site https://repology.org is a useful resource to identify +currently shipped versions of software in various operating systems, +though it does not cover all distros listed below. + +Linux OS +-------- + +For distributions with frequent, short-lifetime releases, the project +will aim to support all versions that are not end of life by their +respective vendors. For the purposes of identifying supported software +versions, the project will look at Fedora, Ubuntu, and openSUSE distros. +Other short- lifetime distros will be assumed to ship similar software +versions. + +For distributions with long-lifetime releases, the project will aim to +support the most recent major version at all times. Support for the +previous major version will be dropped 2 years after the new major +version is released, or when it reaches "end of life". For the purposes +of identifying supported software versions, the project will look at +RHEL, Debian, Ubuntu LTS, and SLES distros. Other long-lifetime distros +will be assumed to ship similar software versions. + +Windows +------- + +The project supports building with current versions of the MinGW +toolchain, hosted on Linux. + +macOS +----- + +The project supports building with the two most recent versions of +macOS, with the current homebrew package set available. + +FreeBSD +------- + +The project aims to support the all the versions which are not end of +life. + +NetBSD +------ + +The project aims to support the most recent major version at all times. +Support for the previous major version will be dropped 2 years after the +new major version is released. + +OpenBSD +------- + +The project aims to support the all the versions which are not end of +life. diff --git a/docs/system/gdb.rst b/docs/system/gdb.rst new file mode 100644 index 0000000000..639f814b32 --- /dev/null +++ b/docs/system/gdb.rst @@ -0,0 +1,81 @@ +.. _gdb_005fusage: + +GDB usage +--------- + +QEMU has a primitive support to work with gdb, so that you can do +'Ctrl-C' while the virtual machine is running and inspect its state. + +In order to use gdb, launch QEMU with the '-s' option. It will wait for +a gdb connection: + +.. parsed-literal:: + + |qemu_system| -s -kernel bzImage -hda rootdisk.img -append "root=/dev/hda" + Connected to host network interface: tun0 + Waiting gdb connection on port 1234 + +Then launch gdb on the 'vmlinux' executable:: + + > gdb vmlinux + +In gdb, connect to QEMU:: + + (gdb) target remote localhost:1234 + +Then you can use gdb normally. For example, type 'c' to launch the +kernel:: + + (gdb) c + +Here are some useful tips in order to use gdb on system code: + +1. Use ``info reg`` to display all the CPU registers. + +2. Use ``x/10i $eip`` to display the code at the PC position. + +3. Use ``set architecture i8086`` to dump 16 bit code. Then use + ``x/10i $cs*16+$eip`` to dump the code at the PC position. + +Advanced debugging options: + +The default single stepping behavior is step with the IRQs and timer +service routines off. It is set this way because when gdb executes a +single step it expects to advance beyond the current instruction. With +the IRQs and timer service routines on, a single step might jump into +the one of the interrupt or exception vectors instead of executing the +current instruction. This means you may hit the same breakpoint a number +of times before executing the instruction gdb wants to have executed. +Because there are rare circumstances where you want to single step into +an interrupt vector the behavior can be controlled from GDB. There are +three commands you can query and set the single step behavior: + +``maintenance packet qqemu.sstepbits`` + This will display the MASK bits used to control the single stepping + IE: + + :: + + (gdb) maintenance packet qqemu.sstepbits + sending: "qqemu.sstepbits" + received: "ENABLE=1,NOIRQ=2,NOTIMER=4" + +``maintenance packet qqemu.sstep`` + This will display the current value of the mask used when single + stepping IE: + + :: + + (gdb) maintenance packet qqemu.sstep + sending: "qqemu.sstep" + received: "0x7" + +``maintenance packet Qqemu.sstep=HEX_VALUE`` + This will change the single step mask, so if wanted to enable IRQs on + the single step, but not timers, you would use: + + :: + + (gdb) maintenance packet Qqemu.sstep=0x5 + sending: "qemu.sstep=0x5" + received: "OK" diff --git a/docs/system/images.rst b/docs/system/images.rst new file mode 100644 index 0000000000..ff26bf9587 --- /dev/null +++ b/docs/system/images.rst @@ -0,0 +1,85 @@ +.. _disk_005fimages: + +Disk Images +----------- + +QEMU supports many disk image formats, including growable disk images +(their size increase as non empty sectors are written), compressed and +encrypted disk images. + +.. _disk_005fimages_005fquickstart: + +Quick start for disk image creation +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +You can create a disk image with the command:: + + qemu-img create myimage.img mysize + +where myimage.img is the disk image filename and mysize is its size in +kilobytes. You can add an ``M`` suffix to give the size in megabytes and +a ``G`` suffix for gigabytes. + +See the qemu-img invocation documentation for more information. + +.. _disk_005fimages_005fsnapshot_005fmode: + +Snapshot mode +~~~~~~~~~~~~~ + +If you use the option ``-snapshot``, all disk images are considered as +read only. When sectors in written, they are written in a temporary file +created in ``/tmp``. You can however force the write back to the raw +disk images by using the ``commit`` monitor command (or C-a s in the +serial console). + +.. _vm_005fsnapshots: + +VM snapshots +~~~~~~~~~~~~ + +VM snapshots are snapshots of the complete virtual machine including CPU +state, RAM, device state and the content of all the writable disks. In +order to use VM snapshots, you must have at least one non removable and +writable block device using the ``qcow2`` disk image format. Normally +this device is the first virtual hard drive. + +Use the monitor command ``savevm`` to create a new VM snapshot or +replace an existing one. A human readable name can be assigned to each +snapshot in addition to its numerical ID. + +Use ``loadvm`` to restore a VM snapshot and ``delvm`` to remove a VM +snapshot. ``info snapshots`` lists the available snapshots with their +associated information:: + + (qemu) info snapshots + Snapshot devices: hda + Snapshot list (from hda): + ID TAG VM SIZE DATE VM CLOCK + 1 start 41M 2006-08-06 12:38:02 00:00:14.954 + 2 40M 2006-08-06 12:43:29 00:00:18.633 + 3 msys 40M 2006-08-06 12:44:04 00:00:23.514 + +A VM snapshot is made of a VM state info (its size is shown in +``info snapshots``) and a snapshot of every writable disk image. The VM +state info is stored in the first ``qcow2`` non removable and writable +block device. The disk image snapshots are stored in every disk image. +The size of a snapshot in a disk image is difficult to evaluate and is +not shown by ``info snapshots`` because the associated disk sectors are +shared among all the snapshots to save disk space (otherwise each +snapshot would need a full copy of all the disk images). + +When using the (unrelated) ``-snapshot`` option +(:ref:`disk_005fimages_005fsnapshot_005fmode`), +you can always make VM snapshots, but they are deleted as soon as you +exit QEMU. + +VM snapshots currently have the following known limitations: + +- They cannot cope with removable devices if they are removed or + inserted after a snapshot is done. + +- A few device drivers still have incomplete snapshot support so their + state is not saved or restored properly (in particular USB). + +.. include:: qemu-block-drivers.rst.inc diff --git a/docs/system/index.rst b/docs/system/index.rst index f2f29fb6d2..6e5f20fa13 100644 --- a/docs/system/index.rst +++ b/docs/system/index.rst @@ -12,8 +12,25 @@ or Hypervisor.Framework. Contents: .. toctree:: - :maxdepth: 2 + :maxdepth: 3 + + quickstart + invocation + keys + mux-chardev + monitor + images + net + usb + ivshmem + linuxboot + vnc-security + tls + gdb managed-startup + targets security vfio-ap deprecated + build-platforms + license diff --git a/docs/system/invocation.rst b/docs/system/invocation.rst new file mode 100644 index 0000000000..c112bcb45a --- /dev/null +++ b/docs/system/invocation.rst @@ -0,0 +1,242 @@ +.. _sec_005finvocation: + +Invocation +---------- + +.. parsed-literal:: + + |qemu_system| [options] [disk_image] + +disk_image is a raw hard disk image for IDE hard disk 0. Some targets do +not need a disk image. + +Device URL Syntax +~~~~~~~~~~~~~~~~~ + +In addition to using normal file images for the emulated storage +devices, QEMU can also use networked resources such as iSCSI devices. +These are specified using a special URL syntax. + +``iSCSI`` + iSCSI support allows QEMU to access iSCSI resources directly and use + as images for the guest storage. Both disk and cdrom images are + supported. + + Syntax for specifying iSCSI LUNs is + "iscsi://[:]//" + + By default qemu will use the iSCSI initiator-name + 'iqn.2008-11.org.linux-kvm[:]' but this can also be set from + the command line or a configuration file. + + Since version Qemu 2.4 it is possible to specify a iSCSI request + timeout to detect stalled requests and force a reestablishment of the + session. The timeout is specified in seconds. The default is 0 which + means no timeout. Libiscsi 1.15.0 or greater is required for this + feature. + + Example (without authentication): + + .. parsed-literal:: + + |qemu_system| -iscsi initiator-name=iqn.2001-04.com.example:my-initiator \ + -cdrom iscsi://192.0.2.1/iqn.2001-04.com.example/2 \ + -drive file=iscsi://192.0.2.1/iqn.2001-04.com.example/1 + + Example (CHAP username/password via URL): + + .. parsed-literal:: + + |qemu_system| -drive file=iscsi://user%password@192.0.2.1/iqn.2001-04.com.example/1 + + Example (CHAP username/password via environment variables): + + .. parsed-literal:: + + LIBISCSI_CHAP_USERNAME="user" \ + LIBISCSI_CHAP_PASSWORD="password" \ + |qemu_system| -drive file=iscsi://192.0.2.1/iqn.2001-04.com.example/1 + +``NBD`` + QEMU supports NBD (Network Block Devices) both using TCP protocol as + well as Unix Domain Sockets. With TCP, the default port is 10809. + + Syntax for specifying a NBD device using TCP, in preferred URI form: + "nbd://[:]/[]" + + Syntax for specifying a NBD device using Unix Domain Sockets; + remember that '?' is a shell glob character and may need quoting: + "nbd+unix:///[]?socket=" + + Older syntax that is also recognized: + "nbd::[:exportname=]" + + Syntax for specifying a NBD device using Unix Domain Sockets + "nbd:unix:[:exportname=]" + + Example for TCP + + .. parsed-literal:: + + |qemu_system| --drive file=nbd:192.0.2.1:30000 + + Example for Unix Domain Sockets + + .. parsed-literal:: + + |qemu_system| --drive file=nbd:unix:/tmp/nbd-socket + +``SSH`` + QEMU supports SSH (Secure Shell) access to remote disks. + + Examples: + + .. parsed-literal:: + + |qemu_system| -drive file=ssh://user@host/path/to/disk.img + |qemu_system| -drive file.driver=ssh,file.user=user,file.host=host,file.port=22,file.path=/path/to/disk.img + + Currently authentication must be done using ssh-agent. Other + authentication methods may be supported in future. + +``Sheepdog`` + Sheepdog is a distributed storage system for QEMU. QEMU supports + using either local sheepdog devices or remote networked devices. + + Syntax for specifying a sheepdog device + + :: + + sheepdog[+tcp|+unix]://[host:port]/vdiname[?socket=path][#snapid|#tag] + + Example + + .. parsed-literal:: + + |qemu_system| --drive file=sheepdog://192.0.2.1:30000/MyVirtualMachine + + See also https://sheepdog.github.io/sheepdog/. + +``GlusterFS`` + GlusterFS is a user space distributed file system. QEMU supports the + use of GlusterFS volumes for hosting VM disk images using TCP, Unix + Domain Sockets and RDMA transport protocols. + + Syntax for specifying a VM disk image on GlusterFS volume is + + .. parsed-literal:: + + URI: + gluster[+type]://[host[:port]]/volume/path[?socket=...][,debug=N][,logfile=...] + + JSON: + 'json:{"driver":"qcow2","file":{"driver":"gluster","volume":"testvol","path":"a.img","debug":N,"logfile":"...", +   "server":[{"type":"tcp","host":"...","port":"..."}, +   {"type":"unix","socket":"..."}]}}' + + Example + + .. parsed-literal:: + + URI: + |qemu_system| --drive file=gluster://192.0.2.1/testvol/a.img, +   file.debug=9,file.logfile=/var/log/qemu-gluster.log + + JSON: + |qemu_system| 'json:{"driver":"qcow2", +   "file":{"driver":"gluster", +   "volume":"testvol","path":"a.img", +   "debug":9,"logfile":"/var/log/qemu-gluster.log", +   "server":[{"type":"tcp","host":"1.2.3.4","port":24007}, +   {"type":"unix","socket":"/var/run/glusterd.socket"}]}}' + |qemu_system| -drive driver=qcow2,file.driver=gluster,file.volume=testvol,file.path=/path/a.img, +   file.debug=9,file.logfile=/var/log/qemu-gluster.log, +   file.server.0.type=tcp,file.server.0.host=1.2.3.4,file.server.0.port=24007, +   file.server.1.type=unix,file.server.1.socket=/var/run/glusterd.socket + + See also http://www.gluster.org. + +``HTTP/HTTPS/FTP/FTPS`` + QEMU supports read-only access to files accessed over http(s) and + ftp(s). + + Syntax using a single filename: + + :: + + ://[[:]@]/ + + where: + + ``protocol`` + 'http', 'https', 'ftp', or 'ftps'. + + ``username`` + Optional username for authentication to the remote server. + + ``password`` + Optional password for authentication to the remote server. + + ``host`` + Address of the remote server. + + ``path`` + Path on the remote server, including any query string. + + The following options are also supported: + + ``url`` + The full URL when passing options to the driver explicitly. + + ``readahead`` + The amount of data to read ahead with each range request to the + remote server. This value may optionally have the suffix 'T', 'G', + 'M', 'K', 'k' or 'b'. If it does not have a suffix, it will be + assumed to be in bytes. The value must be a multiple of 512 bytes. + It defaults to 256k. + + ``sslverify`` + Whether to verify the remote server's certificate when connecting + over SSL. It can have the value 'on' or 'off'. It defaults to + 'on'. + + ``cookie`` + Send this cookie (it can also be a list of cookies separated by + ';') with each outgoing request. Only supported when using + protocols such as HTTP which support cookies, otherwise ignored. + + ``timeout`` + Set the timeout in seconds of the CURL connection. This timeout is + the time that CURL waits for a response from the remote server to + get the size of the image to be downloaded. If not set, the + default timeout of 5 seconds is used. + + Note that when passing options to qemu explicitly, ``driver`` is the + value of . + + Example: boot from a remote Fedora 20 live ISO image + + .. parsed-literal:: + + |qemu_system_x86| --drive media=cdrom,file=https://archives.fedoraproject.org/pub/archive/fedora/linux/releases/20/Live/x86_64/Fedora-Live-Desktop-x86_64-20-1.iso,readonly + + |qemu_system_x86| --drive media=cdrom,file.driver=http,file.url=http://archives.fedoraproject.org/pub/fedora/linux/releases/20/Live/x86_64/Fedora-Live-Desktop-x86_64-20-1.iso,readonly + + Example: boot from a remote Fedora 20 cloud image using a local + overlay for writes, copy-on-read, and a readahead of 64k + + .. parsed-literal:: + + qemu-img create -f qcow2 -o backing_file='json:{"file.driver":"http",, "file.url":"http://archives.fedoraproject.org/pub/archive/fedora/linux/releases/20/Images/x86_64/Fedora-x86_64-20-20131211.1-sda.qcow2",, "file.readahead":"64k"}' /tmp/Fedora-x86_64-20-20131211.1-sda.qcow2 + + |qemu_system_x86| -drive file=/tmp/Fedora-x86_64-20-20131211.1-sda.qcow2,copy-on-read=on + + Example: boot from an image stored on a VMware vSphere server with a + self-signed certificate using a local overlay for writes, a readahead + of 64k and a timeout of 10 seconds. + + .. parsed-literal:: + + qemu-img create -f qcow2 -o backing_file='json:{"file.driver":"https",, "file.url":"https://user:password@vsphere.example.com/folder/test/test-flat.vmdk?dcPath=Datacenter&dsName=datastore1",, "file.sslverify":"off",, "file.readahead":"64k",, "file.timeout":10}' /tmp/test.qcow2 + + |qemu_system_x86| -drive file=/tmp/test.qcow2 diff --git a/docs/system/ivshmem.rst b/docs/system/ivshmem.rst new file mode 100644 index 0000000000..b03a48afa3 --- /dev/null +++ b/docs/system/ivshmem.rst @@ -0,0 +1,64 @@ +.. _pcsys_005fivshmem: + +Inter-VM Shared Memory device +----------------------------- + +On Linux hosts, a shared memory device is available. The basic syntax +is: + +.. parsed-literal:: + + |qemu_system_x86| -device ivshmem-plain,memdev=hostmem + +where hostmem names a host memory backend. For a POSIX shared memory +backend, use something like + +:: + + -object memory-backend-file,size=1M,share,mem-path=/dev/shm/ivshmem,id=hostmem + +If desired, interrupts can be sent between guest VMs accessing the same +shared memory region. Interrupt support requires using a shared memory +server and using a chardev socket to connect to it. The code for the +shared memory server is qemu.git/contrib/ivshmem-server. An example +syntax when using the shared memory server is: + +.. parsed-literal:: + + # First start the ivshmem server once and for all + ivshmem-server -p pidfile -S path -m shm-name -l shm-size -n vectors + + # Then start your qemu instances with matching arguments + |qemu_system_x86| -device ivshmem-doorbell,vectors=vectors,chardev=id + -chardev socket,path=path,id=id + +When using the server, the guest will be assigned a VM ID (>=0) that +allows guests using the same server to communicate via interrupts. +Guests can read their VM ID from a device register (see +ivshmem-spec.txt). + +Migration with ivshmem +~~~~~~~~~~~~~~~~~~~~~~ + +With device property ``master=on``, the guest will copy the shared +memory on migration to the destination host. With ``master=off``, the +guest will not be able to migrate with the device attached. In the +latter case, the device should be detached and then reattached after +migration using the PCI hotplug support. + +At most one of the devices sharing the same memory can be master. The +master must complete migration before you plug back the other devices. + +ivshmem and hugepages +~~~~~~~~~~~~~~~~~~~~~ + +Instead of specifying the using POSIX shm, you may specify a +memory backend that has hugepage support: + +.. parsed-literal:: + + |qemu_system_x86| -object memory-backend-file,size=1G,mem-path=/dev/hugepages/my-shmem-file,share,id=mb1 + -device ivshmem-plain,memdev=mb1 + +ivshmem-server also supports hugepages mount points with the ``-m`` +memory path argument. diff --git a/docs/system/keys.rst b/docs/system/keys.rst new file mode 100644 index 0000000000..bf99ee8d5b --- /dev/null +++ b/docs/system/keys.rst @@ -0,0 +1,40 @@ +.. _pcsys_005fkeys: + +Keys in the graphical frontends +------------------------------- + +During the graphical emulation, you can use special key combinations to +change modes. The default key mappings are shown below, but if you use +``-alt-grab`` then the modifier is Ctrl-Alt-Shift (instead of Ctrl-Alt) +and if you use ``-ctrl-grab`` then the modifier is the right Ctrl key +(instead of Ctrl-Alt): + +Ctrl-Alt-f + Toggle full screen + +Ctrl-Alt-+ + Enlarge the screen + +Ctrl-Alt\-- + Shrink the screen + +Ctrl-Alt-u + Restore the screen's un-scaled dimensions + +Ctrl-Alt-n + Switch to virtual console 'n'. Standard console mappings are: + + *1* + Target system display + + *2* + Monitor + + *3* + Serial port + +Ctrl-Alt + Toggle mouse and keyboard grab. + +In the virtual consoles, you can use Ctrl-Up, Ctrl-Down, Ctrl-PageUp and +Ctrl-PageDown to move in the back log. diff --git a/docs/system/license.rst b/docs/system/license.rst new file mode 100644 index 0000000000..cde3d2d25d --- /dev/null +++ b/docs/system/license.rst @@ -0,0 +1,11 @@ +.. _License: + +License +======= + +QEMU is a trademark of Fabrice Bellard. + +QEMU is released under the `GNU General Public +License `__, version 2. Parts +of QEMU have specific licenses, see file +`LICENSE `__. diff --git a/docs/system/linuxboot.rst b/docs/system/linuxboot.rst new file mode 100644 index 0000000000..228650abc5 --- /dev/null +++ b/docs/system/linuxboot.rst @@ -0,0 +1,30 @@ +.. _direct_005flinux_005fboot: + +Direct Linux Boot +----------------- + +This section explains how to launch a Linux kernel inside QEMU without +having to make a full bootable image. It is very useful for fast Linux +kernel testing. + +The syntax is: + +.. parsed-literal:: + + |qemu_system| -kernel bzImage -hda rootdisk.img -append "root=/dev/hda" + +Use ``-kernel`` to provide the Linux kernel image and ``-append`` to +give the kernel command line arguments. The ``-initrd`` option can be +used to provide an INITRD image. + +If you do not need graphical output, you can disable it and redirect the +virtual serial port and the QEMU monitor to the console with the +``-nographic`` option. The typical command line is: + +.. parsed-literal:: + + |qemu_system| -kernel bzImage -hda rootdisk.img \ + -append "root=/dev/hda console=ttyS0" -nographic + +Use Ctrl-a c to switch between the serial console and the monitor (see +:ref:`pcsys_005fkeys`). diff --git a/docs/system/monitor.rst b/docs/system/monitor.rst new file mode 100644 index 0000000000..482f391f32 --- /dev/null +++ b/docs/system/monitor.rst @@ -0,0 +1,25 @@ +.. _pcsys_005fmonitor: + +QEMU Monitor +------------ + +The QEMU monitor is used to give complex commands to the QEMU emulator. +You can use it to: + +- Remove or insert removable media images (such as CD-ROM or + floppies). + +- Freeze/unfreeze the Virtual Machine (VM) and save or restore its + state from a disk file. + +- Inspect the VM state without an external debugger. + +.. + The commands section goes here once it's converted from Texinfo to RST. + +Integer expressions +~~~~~~~~~~~~~~~~~~~ + +The monitor understands integers expressions for every integer argument. +You can use register names to get the value of specifics CPU registers +by prefixing them with *$*. diff --git a/docs/system/mux-chardev.rst b/docs/system/mux-chardev.rst new file mode 100644 index 0000000000..e50172c081 --- /dev/null +++ b/docs/system/mux-chardev.rst @@ -0,0 +1,32 @@ +.. _mux_005fkeys: + +Keys in the character backend multiplexer +----------------------------------------- + +During emulation, if you are using a character backend multiplexer +(which is the default if you are using ``-nographic``) then several +commands are available via an escape sequence. These key sequences all +start with an escape character, which is Ctrl-a by default, but can be +changed with ``-echr``. The list below assumes you're using the default. + +Ctrl-a h + Print this help + +Ctrl-a x + Exit emulator + +Ctrl-a s + Save disk data back to file (if -snapshot) + +Ctrl-a t + Toggle console timestamps + +Ctrl-a b + Send break (magic sysrq in Linux) + +Ctrl-a c + Rotate between the frontends connected to the multiplexer (usually + this switches between the monitor and the console) + +Ctrl-a Ctrl-a + Send the escape character to the frontend diff --git a/docs/system/net.rst b/docs/system/net.rst new file mode 100644 index 0000000000..4b2640c448 --- /dev/null +++ b/docs/system/net.rst @@ -0,0 +1,100 @@ +.. _pcsys_005fnetwork: + +Network emulation +----------------- + +QEMU can simulate several network cards (e.g. PCI or ISA cards on the PC +target) and can connect them to a network backend on the host or an +emulated hub. The various host network backends can either be used to +connect the NIC of the guest to a real network (e.g. by using a TAP +devices or the non-privileged user mode network stack), or to other +guest instances running in another QEMU process (e.g. by using the +socket host network backend). + +Using TAP network interfaces +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +This is the standard way to connect QEMU to a real network. QEMU adds a +virtual network device on your host (called ``tapN``), and you can then +configure it as if it was a real ethernet card. + +Linux host +^^^^^^^^^^ + +As an example, you can download the ``linux-test-xxx.tar.gz`` archive +and copy the script ``qemu-ifup`` in ``/etc`` and configure properly +``sudo`` so that the command ``ifconfig`` contained in ``qemu-ifup`` can +be executed as root. You must verify that your host kernel supports the +TAP network interfaces: the device ``/dev/net/tun`` must be present. + +See :ref:`sec_005finvocation` to have examples of command +lines using the TAP network interfaces. + +Windows host +^^^^^^^^^^^^ + +There is a virtual ethernet driver for Windows 2000/XP systems, called +TAP-Win32. But it is not included in standard QEMU for Windows, so you +will need to get it separately. It is part of OpenVPN package, so +download OpenVPN from : https://openvpn.net/. + +Using the user mode network stack +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +By using the option ``-net user`` (default configuration if no ``-net`` +option is specified), QEMU uses a completely user mode network stack +(you don't need root privilege to use the virtual network). The virtual +network configuration is the following:: + + guest (10.0.2.15) <------> Firewall/DHCP server <-----> Internet + | (10.0.2.2) + | + ----> DNS server (10.0.2.3) + | + ----> SMB server (10.0.2.4) + +The QEMU VM behaves as if it was behind a firewall which blocks all +incoming connections. You can use a DHCP client to automatically +configure the network in the QEMU VM. The DHCP server assign addresses +to the hosts starting from 10.0.2.15. + +In order to check that the user mode network is working, you can ping +the address 10.0.2.2 and verify that you got an address in the range +10.0.2.x from the QEMU virtual DHCP server. + +Note that ICMP traffic in general does not work with user mode +networking. ``ping``, aka. ICMP echo, to the local router (10.0.2.2) +shall work, however. If you're using QEMU on Linux >= 3.0, it can use +unprivileged ICMP ping sockets to allow ``ping`` to the Internet. The +host admin has to set the ping_group_range in order to grant access to +those sockets. To allow ping for GID 100 (usually users group):: + + echo 100 100 > /proc/sys/net/ipv4/ping_group_range + +When using the built-in TFTP server, the router is also the TFTP server. + +When using the ``'-netdev user,hostfwd=...'`` option, TCP or UDP +connections can be redirected from the host to the guest. It allows for +example to redirect X11, telnet or SSH connections. + +Hubs +~~~~ + +QEMU can simulate several hubs. A hub can be thought of as a virtual +connection between several network devices. These devices can be for +example QEMU virtual ethernet cards or virtual Host ethernet devices +(TAP devices). You can connect guest NICs or host network backends to +such a hub using the ``-netdev +hubport`` or ``-nic hubport`` options. The legacy ``-net`` option also +connects the given device to the emulated hub with ID 0 (i.e. the +default hub) unless you specify a netdev with ``-net nic,netdev=xxx`` +here. + +Connecting emulated networks between QEMU instances +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Using the ``-netdev socket`` (or ``-nic socket`` or ``-net socket``) +option, it is possible to create emulated networks that span several +QEMU instances. See the description of the ``-netdev socket`` option in +:ref:`sec_005finvocation` to have a basic +example. diff --git a/docs/system/quickstart.rst b/docs/system/quickstart.rst new file mode 100644 index 0000000000..3a3acab5e7 --- /dev/null +++ b/docs/system/quickstart.rst @@ -0,0 +1,13 @@ +.. _pcsys_005fquickstart: + +Quick Start +----------- + +Download and uncompress a PC hard disk image with Linux installed (e.g. +``linux.img``) and type: + +.. parsed-literal:: + + |qemu_system| linux.img + +Linux should boot and give you a prompt. diff --git a/docs/system/target-arm.rst b/docs/system/target-arm.rst new file mode 100644 index 0000000000..0490be5587 --- /dev/null +++ b/docs/system/target-arm.rst @@ -0,0 +1,227 @@ +.. _ARM-System-emulator: + +ARM System emulator +------------------- + +Use the executable ``qemu-system-arm`` to simulate a ARM machine. The +ARM Integrator/CP board is emulated with the following devices: + +- ARM926E, ARM1026E, ARM946E, ARM1136 or Cortex-A8 CPU + +- Two PL011 UARTs + +- SMC 91c111 Ethernet adapter + +- PL110 LCD controller + +- PL050 KMI with PS/2 keyboard and mouse. + +- PL181 MultiMedia Card Interface with SD card. + +The ARM Versatile baseboard is emulated with the following devices: + +- ARM926E, ARM1136 or Cortex-A8 CPU + +- PL190 Vectored Interrupt Controller + +- Four PL011 UARTs + +- SMC 91c111 Ethernet adapter + +- PL110 LCD controller + +- PL050 KMI with PS/2 keyboard and mouse. + +- PCI host bridge. Note the emulated PCI bridge only provides access + to PCI memory space. It does not provide access to PCI IO space. This + means some devices (eg. ne2k_pci NIC) are not usable, and others (eg. + rtl8139 NIC) are only usable when the guest drivers use the memory + mapped control registers. + +- PCI OHCI USB controller. + +- LSI53C895A PCI SCSI Host Bus Adapter with hard disk and CD-ROM + devices. + +- PL181 MultiMedia Card Interface with SD card. + +Several variants of the ARM RealView baseboard are emulated, including +the EB, PB-A8 and PBX-A9. Due to interactions with the bootloader, only +certain Linux kernel configurations work out of the box on these boards. + +Kernels for the PB-A8 board should have CONFIG_REALVIEW_HIGH_PHYS_OFFSET +enabled in the kernel, and expect 512M RAM. Kernels for The PBX-A9 board +should have CONFIG_SPARSEMEM enabled, CONFIG_REALVIEW_HIGH_PHYS_OFFSET +disabled and expect 1024M RAM. + +The following devices are emulated: + +- ARM926E, ARM1136, ARM11MPCore, Cortex-A8 or Cortex-A9 MPCore CPU + +- ARM AMBA Generic/Distributed Interrupt Controller + +- Four PL011 UARTs + +- SMC 91c111 or SMSC LAN9118 Ethernet adapter + +- PL110 LCD controller + +- PL050 KMI with PS/2 keyboard and mouse + +- PCI host bridge + +- PCI OHCI USB controller + +- LSI53C895A PCI SCSI Host Bus Adapter with hard disk and CD-ROM + devices + +- PL181 MultiMedia Card Interface with SD card. + +The XScale-based clamshell PDA models (\"Spitz\", \"Akita\", \"Borzoi\" +and \"Terrier\") emulation includes the following peripherals: + +- Intel PXA270 System-on-chip (ARM V5TE core) + +- NAND Flash memory + +- IBM/Hitachi DSCM microdrive in a PXA PCMCIA slot - not in \"Akita\" + +- On-chip OHCI USB controller + +- On-chip LCD controller + +- On-chip Real Time Clock + +- TI ADS7846 touchscreen controller on SSP bus + +- Maxim MAX1111 analog-digital converter on |I2C| bus + +- GPIO-connected keyboard controller and LEDs + +- Secure Digital card connected to PXA MMC/SD host + +- Three on-chip UARTs + +- WM8750 audio CODEC on |I2C| and |I2S| busses + +The Palm Tungsten|E PDA (codename \"Cheetah\") emulation includes the +following elements: + +- Texas Instruments OMAP310 System-on-chip (ARM 925T core) + +- ROM and RAM memories (ROM firmware image can be loaded with + -option-rom) + +- On-chip LCD controller + +- On-chip Real Time Clock + +- TI TSC2102i touchscreen controller / analog-digital converter / + Audio CODEC, connected through MicroWire and |I2S| busses + +- GPIO-connected matrix keypad + +- Secure Digital card connected to OMAP MMC/SD host + +- Three on-chip UARTs + +Nokia N800 and N810 internet tablets (known also as RX-34 and RX-44 / +48) emulation supports the following elements: + +- Texas Instruments OMAP2420 System-on-chip (ARM 1136 core) + +- RAM and non-volatile OneNAND Flash memories + +- Display connected to EPSON remote framebuffer chip and OMAP on-chip + display controller and a LS041y3 MIPI DBI-C controller + +- TI TSC2301 (in N800) and TI TSC2005 (in N810) touchscreen + controllers driven through SPI bus + +- National Semiconductor LM8323-controlled qwerty keyboard driven + through |I2C| bus + +- Secure Digital card connected to OMAP MMC/SD host + +- Three OMAP on-chip UARTs and on-chip STI debugging console + +- Mentor Graphics \"Inventra\" dual-role USB controller embedded in a + TI TUSB6010 chip - only USB host mode is supported + +- TI TMP105 temperature sensor driven through |I2C| bus + +- TI TWL92230C power management companion with an RTC on + |I2C| bus + +- Nokia RETU and TAHVO multi-purpose chips with an RTC, connected + through CBUS + +The Luminary Micro Stellaris LM3S811EVB emulation includes the following +devices: + +- Cortex-M3 CPU core. + +- 64k Flash and 8k SRAM. + +- Timers, UARTs, ADC and |I2C| interface. + +- OSRAM Pictiva 96x16 OLED with SSD0303 controller on + |I2C| bus. + +The Luminary Micro Stellaris LM3S6965EVB emulation includes the +following devices: + +- Cortex-M3 CPU core. + +- 256k Flash and 64k SRAM. + +- Timers, UARTs, ADC, |I2C| and SSI interfaces. + +- OSRAM Pictiva 128x64 OLED with SSD0323 controller connected via + SSI. + +The Freecom MusicPal internet radio emulation includes the following +elements: + +- Marvell MV88W8618 ARM core. + +- 32 MB RAM, 256 KB SRAM, 8 MB flash. + +- Up to 2 16550 UARTs + +- MV88W8xx8 Ethernet controller + +- MV88W8618 audio controller, WM8750 CODEC and mixer + +- 128x64 display with brightness control + +- 2 buttons, 2 navigation wheels with button function + +The Siemens SX1 models v1 and v2 (default) basic emulation. The +emulation includes the following elements: + +- Texas Instruments OMAP310 System-on-chip (ARM 925T core) + +- ROM and RAM memories (ROM firmware image can be loaded with + -pflash) V1 1 Flash of 16MB and 1 Flash of 8MB V2 1 Flash of 32MB + +- On-chip LCD controller + +- On-chip Real Time Clock + +- Secure Digital card connected to OMAP MMC/SD host + +- Three on-chip UARTs + +A Linux 2.6 test image is available on the QEMU web site. More +information is available in the QEMU mailing-list archive. + +The following options are specific to the ARM emulation: + +``-semihosting`` + Enable semihosting syscall emulation. + + On ARM this implements the \"Angel\" interface. + + Note that this allows guest direct access to the host filesystem, so + should only be used with trusted guest OS. diff --git a/docs/system/target-i386.rst b/docs/system/target-i386.rst new file mode 100644 index 0000000000..92e2038b11 --- /dev/null +++ b/docs/system/target-i386.rst @@ -0,0 +1,84 @@ +.. _QEMU-PC-System-emulator: + +x86 (PC) System emulator +------------------------ + +.. _pcsys_005fdevices: + +Peripherals +~~~~~~~~~~~ + +The QEMU PC System emulator simulates the following peripherals: + +- i440FX host PCI bridge and PIIX3 PCI to ISA bridge + +- Cirrus CLGD 5446 PCI VGA card or dummy VGA card with Bochs VESA + extensions (hardware level, including all non standard modes). + +- PS/2 mouse and keyboard + +- 2 PCI IDE interfaces with hard disk and CD-ROM support + +- Floppy disk + +- PCI and ISA network adapters + +- Serial ports + +- IPMI BMC, either and internal or external one + +- Creative SoundBlaster 16 sound card + +- ENSONIQ AudioPCI ES1370 sound card + +- Intel 82801AA AC97 Audio compatible sound card + +- Intel HD Audio Controller and HDA codec + +- Adlib (OPL2) - Yamaha YM3812 compatible chip + +- Gravis Ultrasound GF1 sound card + +- CS4231A compatible sound card + +- PCI UHCI, OHCI, EHCI or XHCI USB controller and a virtual USB-1.1 + hub. + +SMP is supported with up to 255 CPUs. + +QEMU uses the PC BIOS from the Seabios project and the Plex86/Bochs LGPL +VGA BIOS. + +QEMU uses YM3812 emulation by Tatsuyuki Satoh. + +QEMU uses GUS emulation (GUSEMU32 http://www.deinmeister.de/gusemu/) by +Tibor \"TS\" Schütz. + +Note that, by default, GUS shares IRQ(7) with parallel ports and so QEMU +must be told to not have parallel ports to have working GUS. + +.. parsed-literal:: + + |qemu_system_x86| dos.img -soundhw gus -parallel none + +Alternatively: + +.. parsed-literal:: + + |qemu_system_x86| dos.img -device gus,irq=5 + +Or some other unclaimed IRQ. + +CS4231A is the chip used in Windows Sound System and GUSMAX products + +.. include:: cpu-models-x86.rst.inc + +.. _pcsys_005freq: + +OS requirements +~~~~~~~~~~~~~~~ + +On x86_64 hosts, the default set of CPU features enabled by the KVM +accelerator require the host to be running Linux v4.5 or newer. Red Hat +Enterprise Linux 7 is also supported, since the required +functionality was backported. diff --git a/docs/system/target-m68k.rst b/docs/system/target-m68k.rst new file mode 100644 index 0000000000..50b7dd9d63 --- /dev/null +++ b/docs/system/target-m68k.rst @@ -0,0 +1,32 @@ +.. _ColdFire-System-emulator: + +ColdFire System emulator +------------------------ + +Use the executable ``qemu-system-m68k`` to simulate a ColdFire machine. +The emulator is able to boot a uClinux kernel. + +The M5208EVB emulation includes the following devices: + +- MCF5208 ColdFire V2 Microprocessor (ISA A+ with EMAC). + +- Three Two on-chip UARTs. + +- Fast Ethernet Controller (FEC) + +The AN5206 emulation includes the following devices: + +- MCF5206 ColdFire V2 Microprocessor. + +- Two on-chip UARTs. + +The following options are specific to the ColdFire emulation: + +``-semihosting`` + Enable semihosting syscall emulation. + + On M68K this implements the \"ColdFire GDB\" interface used by + libgloss. + + Note that this allows guest direct access to the host filesystem, so + should only be used with trusted guest OS. diff --git a/docs/system/target-mips.rst b/docs/system/target-mips.rst new file mode 100644 index 0000000000..2736fd0509 --- /dev/null +++ b/docs/system/target-mips.rst @@ -0,0 +1,120 @@ +.. _MIPS-System-emulator: + +MIPS System emulator +-------------------- + +Four executables cover simulation of 32 and 64-bit MIPS systems in both +endian options, ``qemu-system-mips``, ``qemu-system-mipsel`` +``qemu-system-mips64`` and ``qemu-system-mips64el``. Five different +machine types are emulated: + +- A generic ISA PC-like machine \"mips\" + +- The MIPS Malta prototype board \"malta\" + +- An ACER Pica \"pica61\". This machine needs the 64-bit emulator. + +- MIPS emulator pseudo board \"mipssim\" + +- A MIPS Magnum R4000 machine \"magnum\". This machine needs the + 64-bit emulator. + +The generic emulation is supported by Debian 'Etch' and is able to +install Debian into a virtual disk image. The following devices are +emulated: + +- A range of MIPS CPUs, default is the 24Kf + +- PC style serial port + +- PC style IDE disk + +- NE2000 network card + +The Malta emulation supports the following devices: + +- Core board with MIPS 24Kf CPU and Galileo system controller + +- PIIX4 PCI/USB/SMbus controller + +- The Multi-I/O chip's serial device + +- PCI network cards (PCnet32 and others) + +- Malta FPGA serial device + +- Cirrus (default) or any other PCI VGA graphics card + +The Boston board emulation supports the following devices: + +- Xilinx FPGA, which includes a PCIe root port and an UART + +- Intel EG20T PCH connects the I/O peripherals, but only the SATA bus + is emulated + +The ACER Pica emulation supports: + +- MIPS R4000 CPU + +- PC-style IRQ and DMA controllers + +- PC Keyboard + +- IDE controller + +The MIPS Magnum R4000 emulation supports: + +- MIPS R4000 CPU + +- PC-style IRQ controller + +- PC Keyboard + +- SCSI controller + +- G364 framebuffer + +The Fulong 2E emulation supports: + +- Loongson 2E CPU + +- Bonito64 system controller as North Bridge + +- VT82C686 chipset as South Bridge + +- RTL8139D as a network card chipset + +The mipssim pseudo board emulation provides an environment similar to +what the proprietary MIPS emulator uses for running Linux. It supports: + +- A range of MIPS CPUs, default is the 24Kf + +- PC style serial port + +- MIPSnet network emulation + +.. include:: cpu-models-mips.rst.inc + +.. _nanoMIPS-System-emulator: + +nanoMIPS System emulator +~~~~~~~~~~~~~~~~~~~~~~~~ + +Executable ``qemu-system-mipsel`` also covers simulation of 32-bit +nanoMIPS system in little endian mode: + +- nanoMIPS I7200 CPU + +Example of ``qemu-system-mipsel`` usage for nanoMIPS is shown below: + +Download ```` from +https://mipsdistros.mips.com/LinuxDistro/nanomips/buildroot/index.html. + +Download ```` from +https://mipsdistros.mips.com/LinuxDistro/nanomips/kernels/v4.15.18-432-gb2eb9a8b07a1-20180627102142/index.html. + +Start system emulation of Malta board with nanoMIPS I7200 CPU:: + + qemu-system-mipsel -cpu I7200 -kernel \ + -M malta -serial stdio -m -hda \ + -append "mem=256m@0x0 rw console=ttyS0 vga=cirrus vesa=0x111 root=/dev/sda" diff --git a/docs/system/target-ppc.rst b/docs/system/target-ppc.rst new file mode 100644 index 0000000000..43fadf3c00 --- /dev/null +++ b/docs/system/target-ppc.rst @@ -0,0 +1,61 @@ +.. _PowerPC-System-emulator: + +PowerPC System emulator +----------------------- + +Use the executable ``qemu-system-ppc`` to simulate a complete 40P (PREP) +or PowerMac PowerPC system. + +QEMU emulates the following PowerMac peripherals: + +- UniNorth or Grackle PCI Bridge + +- PCI VGA compatible card with VESA Bochs Extensions + +- 2 PMAC IDE interfaces with hard disk and CD-ROM support + +- NE2000 PCI adapters + +- Non Volatile RAM + +- VIA-CUDA with ADB keyboard and mouse. + +QEMU emulates the following 40P (PREP) peripherals: + +- PCI Bridge + +- PCI VGA compatible card with VESA Bochs Extensions + +- 2 IDE interfaces with hard disk and CD-ROM support + +- Floppy disk + +- PCnet network adapters + +- Serial port + +- PREP Non Volatile RAM + +- PC compatible keyboard and mouse. + +Since version 0.9.1, QEMU uses OpenBIOS https://www.openbios.org/ for +the g3beige and mac99 PowerMac and the 40p machines. OpenBIOS is a free +(GPL v2) portable firmware implementation. The goal is to implement a +100% IEEE 1275-1994 (referred to as Open Firmware) compliant firmware. + +The following options are specific to the PowerPC emulation: + +``-g WxH[xDEPTH]`` + Set the initial VGA graphic mode. The default is 800x600x32. + +``-prom-env string`` + Set OpenBIOS variables in NVRAM, for example: + + :: + + qemu-system-ppc -prom-env 'auto-boot?=false' \ + -prom-env 'boot-device=hd:2,\yaboot' \ + -prom-env 'boot-args=conf=hd:2,\yaboot.conf' + +More information is available at +http://perso.magic.fr/l_indien/qemu-ppc/. diff --git a/docs/system/target-sparc.rst b/docs/system/target-sparc.rst new file mode 100644 index 0000000000..589c88d175 --- /dev/null +++ b/docs/system/target-sparc.rst @@ -0,0 +1,81 @@ +.. _Sparc32-System-emulator: + +Sparc32 System emulator +----------------------- + +Use the executable ``qemu-system-sparc`` to simulate the following Sun4m +architecture machines: + +- SPARCstation 4 + +- SPARCstation 5 + +- SPARCstation 10 + +- SPARCstation 20 + +- SPARCserver 600MP + +- SPARCstation LX + +- SPARCstation Voyager + +- SPARCclassic + +- SPARCbook + +The emulation is somewhat complete. SMP up to 16 CPUs is supported, but +Linux limits the number of usable CPUs to 4. + +QEMU emulates the following sun4m peripherals: + +- IOMMU + +- TCX or cgthree Frame buffer + +- Lance (Am7990) Ethernet + +- Non Volatile RAM M48T02/M48T08 + +- Slave I/O: timers, interrupt controllers, Zilog serial ports, + keyboard and power/reset logic + +- ESP SCSI controller with hard disk and CD-ROM support + +- Floppy drive (not on SS-600MP) + +- CS4231 sound device (only on SS-5, not working yet) + +The number of peripherals is fixed in the architecture. Maximum memory +size depends on the machine type, for SS-5 it is 256MB and for others +2047MB. + +Since version 0.8.2, QEMU uses OpenBIOS https://www.openbios.org/. +OpenBIOS is a free (GPL v2) portable firmware implementation. The goal +is to implement a 100% IEEE 1275-1994 (referred to as Open Firmware) +compliant firmware. + +A sample Linux 2.6 series kernel and ram disk image are available on the +QEMU web site. There are still issues with NetBSD and OpenBSD, but most +kernel versions work. Please note that currently older Solaris kernels +don't work probably due to interface issues between OpenBIOS and +Solaris. + +The following options are specific to the Sparc32 emulation: + +``-g WxHx[xDEPTH]`` + Set the initial graphics mode. For TCX, the default is 1024x768x8 + with the option of 1024x768x24. For cgthree, the default is + 1024x768x8 with the option of 1152x900x8 for people who wish to use + OBP. + +``-prom-env string`` + Set OpenBIOS variables in NVRAM, for example: + + :: + + qemu-system-sparc -prom-env 'auto-boot?=false' \ + -prom-env 'boot-device=sd(0,2,0):d' -prom-env 'boot-args=linux single' + +``-M [SS-4|SS-5|SS-10|SS-20|SS-600MP|LX|Voyager|SPARCClassic] [|SPARCbook]`` + Set the emulated machine type. Default is SS-5. diff --git a/docs/system/target-sparc64.rst b/docs/system/target-sparc64.rst new file mode 100644 index 0000000000..ca76ba9c48 --- /dev/null +++ b/docs/system/target-sparc64.rst @@ -0,0 +1,49 @@ +.. _Sparc64-System-emulator: + +Sparc64 System emulator +----------------------- + +Use the executable ``qemu-system-sparc64`` to simulate a Sun4u +(UltraSPARC PC-like machine), Sun4v (T1 PC-like machine), or generic +Niagara (T1) machine. The Sun4u emulator is mostly complete, being able +to run Linux, NetBSD and OpenBSD in headless (-nographic) mode. The +Sun4v emulator is still a work in progress. + +The Niagara T1 emulator makes use of firmware and OS binaries supplied +in the S10image/ directory of the OpenSPARC T1 project +http://download.oracle.com/technetwork/systems/opensparc/OpenSPARCT1_Arch.1.5.tar.bz2 +and is able to boot the disk.s10hw2 Solaris image. + +:: + + qemu-system-sparc64 -M niagara -L /path-to/S10image/ \ + -nographic -m 256 \ + -drive if=pflash,readonly=on,file=/S10image/disk.s10hw2 + +QEMU emulates the following peripherals: + +- UltraSparc IIi APB PCI Bridge + +- PCI VGA compatible card with VESA Bochs Extensions + +- PS/2 mouse and keyboard + +- Non Volatile RAM M48T59 + +- PC-compatible serial ports + +- 2 PCI IDE interfaces with hard disk and CD-ROM support + +- Floppy disk + +The following options are specific to the Sparc64 emulation: + +``-prom-env string`` + Set OpenBIOS variables in NVRAM, for example: + + :: + + qemu-system-sparc64 -prom-env 'auto-boot?=false' + +``-M [sun4u|sun4v|niagara]`` + Set the emulated machine type. The default is sun4u. diff --git a/docs/system/target-xtensa.rst b/docs/system/target-xtensa.rst new file mode 100644 index 0000000000..43cab8dc4d --- /dev/null +++ b/docs/system/target-xtensa.rst @@ -0,0 +1,39 @@ +.. _Xtensa-System-emulator: + +Xtensa System emulator +---------------------- + +Two executables cover simulation of both Xtensa endian options, +``qemu-system-xtensa`` and ``qemu-system-xtensaeb``. Two different +machine types are emulated: + +- Xtensa emulator pseudo board \"sim\" + +- Avnet LX60/LX110/LX200 board + +The sim pseudo board emulation provides an environment similar to one +provided by the proprietary Tensilica ISS. It supports: + +- A range of Xtensa CPUs, default is the DC232B + +- Console and filesystem access via semihosting calls + +The Avnet LX60/LX110/LX200 emulation supports: + +- A range of Xtensa CPUs, default is the DC232B + +- 16550 UART + +- OpenCores 10/100 Mbps Ethernet MAC + +The following options are specific to the Xtensa emulation: + +``-semihosting`` + Enable semihosting syscall emulation. + + Xtensa semihosting provides basic file IO calls, such as + open/read/write/seek/select. Tensilica baremetal libc for ISS and + linux platform \"sim\" use this interface. + + Note that this allows guest direct access to the host filesystem, so + should only be used with trusted guest OS. diff --git a/docs/system/targets.rst b/docs/system/targets.rst new file mode 100644 index 0000000000..eba3111247 --- /dev/null +++ b/docs/system/targets.rst @@ -0,0 +1,19 @@ +QEMU System Emulator Targets +============================ + +QEMU is a generic emulator and it emulates many machines. Most of the +options are similar for all machines. Specific information about the +various targets are mentioned in the following sections. + +Contents: + +.. toctree:: + + target-i386 + target-ppc + target-sparc + target-sparc64 + target-mips + target-arm + target-m68k + target-xtensa diff --git a/docs/system/tls.rst b/docs/system/tls.rst new file mode 100644 index 0000000000..dc2b94257f --- /dev/null +++ b/docs/system/tls.rst @@ -0,0 +1,328 @@ +.. _network_005ftls: + +TLS setup for network services +------------------------------ + +Almost all network services in QEMU have the ability to use TLS for +session data encryption, along with x509 certificates for simple client +authentication. What follows is a description of how to generate +certificates suitable for usage with QEMU, and applies to the VNC +server, character devices with the TCP backend, NBD server and client, +and migration server and client. + +At a high level, QEMU requires certificates and private keys to be +provided in PEM format. Aside from the core fields, the certificates +should include various extension data sets, including v3 basic +constraints data, key purpose, key usage and subject alt name. + +The GnuTLS package includes a command called ``certtool`` which can be +used to easily generate certificates and keys in the required format +with expected data present. Alternatively a certificate management +service may be used. + +At a minimum it is necessary to setup a certificate authority, and issue +certificates to each server. If using x509 certificates for +authentication, then each client will also need to be issued a +certificate. + +Assuming that the QEMU network services will only ever be exposed to +clients on a private intranet, there is no need to use a commercial +certificate authority to create certificates. A self-signed CA is +sufficient, and in fact likely to be more secure since it removes the +ability of malicious 3rd parties to trick the CA into mis-issuing certs +for impersonating your services. The only likely exception where a +commercial CA might be desirable is if enabling the VNC websockets +server and exposing it directly to remote browser clients. In such a +case it might be useful to use a commercial CA to avoid needing to +install custom CA certs in the web browsers. + +The recommendation is for the server to keep its certificates in either +``/etc/pki/qemu`` or for unprivileged users in ``$HOME/.pki/qemu``. + +.. _tls_005fgenerate_005fca: + +Setup the Certificate Authority +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +This step only needs to be performed once per organization / +organizational unit. First the CA needs a private key. This key must be +kept VERY secret and secure. If this key is compromised the entire trust +chain of the certificates issued with it is lost. + +:: + + # certtool --generate-privkey > ca-key.pem + +To generate a self-signed certificate requires one core piece of +information, the name of the organization. A template file ``ca.info`` +should be populated with the desired data to avoid having to deal with +interactive prompts from certtool:: + + # cat > ca.info < server-hostNNN.info < server-hostNNN-key.pem + # certtool --generate-certificate \ + --load-ca-certificate ca-cert.pem \ + --load-ca-privkey ca-key.pem \ + --load-privkey server-hostNNN-key.pem \ + --template server-hostNNN.info \ + --outfile server-hostNNN-cert.pem + +The ``dns_name`` and ``ip_address`` fields in the template are setting +the subject alt name extension data. The ``tls_www_server`` keyword is +the key purpose extension to indicate this certificate is intended for +usage in a web server. Although QEMU network services are not in fact +HTTP servers (except for VNC websockets), setting this key purpose is +still recommended. The ``encryption_key`` and ``signing_key`` keyword is +the key usage extension to indicate this certificate is intended for +usage in the data session. + +The ``server-hostNNN-key.pem`` and ``server-hostNNN-cert.pem`` files +should now be securely copied to the server for which they were +generated, and renamed to ``server-key.pem`` and ``server-cert.pem`` +when added to the ``/etc/pki/qemu`` directory on the target host. The +``server-key.pem`` file is security sensitive and should be kept +protected with file mode 0600 to prevent disclosure. + +.. _tls_005fgenerate_005fclient: + +Issuing client certificates +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The QEMU x509 TLS credential setup defaults to enabling client +verification using certificates, providing a simple authentication +mechanism. If this default is used, each client also needs to be issued +a certificate. The client certificate contains enough metadata to +uniquely identify the client with the scope of the certificate +authority. The client certificate would typically include fields for +organization, state, city, building, etc. + +Once again on the host holding the CA, create template files containing +the information for each client, and use it to issue client +certificates. + +:: + + # cat > client-hostNNN.info < client-hostNNN-key.pem + # certtool --generate-certificate \ + --load-ca-certificate ca-cert.pem \ + --load-ca-privkey ca-key.pem \ + --load-privkey client-hostNNN-key.pem \ + --template client-hostNNN.info \ + --outfile client-hostNNN-cert.pem + +The subject alt name extension data is not required for clients, so the +the ``dns_name`` and ``ip_address`` fields are not included. The +``tls_www_client`` keyword is the key purpose extension to indicate this +certificate is intended for usage in a web client. Although QEMU network +clients are not in fact HTTP clients, setting this key purpose is still +recommended. The ``encryption_key`` and ``signing_key`` keyword is the +key usage extension to indicate this certificate is intended for usage +in the data session. + +The ``client-hostNNN-key.pem`` and ``client-hostNNN-cert.pem`` files +should now be securely copied to the client for which they were +generated, and renamed to ``client-key.pem`` and ``client-cert.pem`` +when added to the ``/etc/pki/qemu`` directory on the target host. The +``client-key.pem`` file is security sensitive and should be kept +protected with file mode 0600 to prevent disclosure. + +If a single host is going to be using TLS in both a client and server +role, it is possible to create a single certificate to cover both roles. +This would be quite common for the migration and NBD services, where a +QEMU process will be started by accepting a TLS protected incoming +migration, and later itself be migrated out to another host. To generate +a single certificate, simply include the template data from both the +client and server instructions in one. + +:: + + # cat > both-hostNNN.info < both-hostNNN-key.pem + # certtool --generate-certificate \ + --load-ca-certificate ca-cert.pem \ + --load-ca-privkey ca-key.pem \ + --load-privkey both-hostNNN-key.pem \ + --template both-hostNNN.info \ + --outfile both-hostNNN-cert.pem + +When copying the PEM files to the target host, save them twice, once as +``server-cert.pem`` and ``server-key.pem``, and again as +``client-cert.pem`` and ``client-key.pem``. + +.. _tls_005fcreds_005fsetup: + +TLS x509 credential configuration +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +QEMU has a standard mechanism for loading x509 credentials that will be +used for network services and clients. It requires specifying the +``tls-creds-x509`` class name to the ``--object`` command line argument +for the system emulators. Each set of credentials loaded should be given +a unique string identifier via the ``id`` parameter. A single set of TLS +credentials can be used for multiple network backends, so VNC, +migration, NBD, character devices can all share the same credentials. +Note, however, that credentials for use in a client endpoint must be +loaded separately from those used in a server endpoint. + +When specifying the object, the ``dir`` parameters specifies which +directory contains the credential files. This directory is expected to +contain files with the names mentioned previously, ``ca-cert.pem``, +``server-key.pem``, ``server-cert.pem``, ``client-key.pem`` and +``client-cert.pem`` as appropriate. It is also possible to include a set +of pre-generated Diffie-Hellman (DH) parameters in a file +``dh-params.pem``, which can be created using the +``certtool --generate-dh-params`` command. If omitted, QEMU will +dynamically generate DH parameters when loading the credentials. + +The ``endpoint`` parameter indicates whether the credentials will be +used for a network client or server, and determines which PEM files are +loaded. + +The ``verify`` parameter determines whether x509 certificate validation +should be performed. This defaults to enabled, meaning clients will +always validate the server hostname against the certificate subject alt +name fields and/or CN field. It also means that servers will request +that clients provide a certificate and validate them. Verification +should never be turned off for client endpoints, however, it may be +turned off for server endpoints if an alternative mechanism is used to +authenticate clients. For example, the VNC server can use SASL to +authenticate clients instead. + +To load server credentials with client certificate validation enabled + +.. parsed-literal:: + + |qemu_system| -object tls-creds-x509,id=tls0,dir=/etc/pki/qemu,endpoint=server + +while to load client credentials use + +.. parsed-literal:: + + |qemu_system| -object tls-creds-x509,id=tls0,dir=/etc/pki/qemu,endpoint=client + +Network services which support TLS will all have a ``tls-creds`` +parameter which expects the ID of the TLS credentials object. For +example with VNC: + +.. parsed-literal:: + + |qemu_system| -vnc 0.0.0.0:0,tls-creds=tls0 + +.. _tls_005fpsk: + +TLS Pre-Shared Keys (PSK) +~~~~~~~~~~~~~~~~~~~~~~~~~ + +Instead of using certificates, you may also use TLS Pre-Shared Keys +(TLS-PSK). This can be simpler to set up than certificates but is less +scalable. + +Use the GnuTLS ``psktool`` program to generate a ``keys.psk`` file +containing one or more usernames and random keys:: + + mkdir -m 0700 /tmp/keys + psktool -u rich -p /tmp/keys/keys.psk + +TLS-enabled servers such as qemu-nbd can use this directory like so:: + + qemu-nbd \ + -t -x / \ + --object tls-creds-psk,id=tls0,endpoint=server,dir=/tmp/keys \ + --tls-creds tls0 \ + image.qcow2 + +When connecting from a qemu-based client you must specify the directory +containing ``keys.psk`` and an optional username (defaults to "qemu"):: + + qemu-img info \ + --object tls-creds-psk,id=tls0,dir=/tmp/keys,username=rich,endpoint=client \ + --image-opts \ + file.driver=nbd,file.host=localhost,file.port=10809,file.tls-creds=tls0,file.export=/ diff --git a/docs/system/usb.rst b/docs/system/usb.rst new file mode 100644 index 0000000000..ddfa828d74 --- /dev/null +++ b/docs/system/usb.rst @@ -0,0 +1,137 @@ +.. _pcsys_005fusb: + +USB emulation +------------- + +QEMU can emulate a PCI UHCI, OHCI, EHCI or XHCI USB controller. You can +plug virtual USB devices or real host USB devices (only works with +certain host operating systems). QEMU will automatically create and +connect virtual USB hubs as necessary to connect multiple USB devices. + +.. _usb_005fdevices: + +Connecting USB devices +~~~~~~~~~~~~~~~~~~~~~~ + +USB devices can be connected with the ``-device usb-...`` command line +option or the ``device_add`` monitor command. Available devices are: + +``usb-mouse`` + Virtual Mouse. This will override the PS/2 mouse emulation when + activated. + +``usb-tablet`` + Pointer device that uses absolute coordinates (like a touchscreen). + This means QEMU is able to report the mouse position without having + to grab the mouse. Also overrides the PS/2 mouse emulation when + activated. + +``usb-storage,drive=drive_id`` + Mass storage device backed by drive_id (see + :ref:`disk_005fimages`) + +``usb-uas`` + USB attached SCSI device, see + `usb-storage.txt `__ + for details + +``usb-bot`` + Bulk-only transport storage device, see + `usb-storage.txt `__ + for details here, too + +``usb-mtp,rootdir=dir`` + Media transfer protocol device, using dir as root of the file tree + that is presented to the guest. + +``usb-host,hostbus=bus,hostaddr=addr`` + Pass through the host device identified by bus and addr + +``usb-host,vendorid=vendor,productid=product`` + Pass through the host device identified by vendor and product ID + +``usb-wacom-tablet`` + Virtual Wacom PenPartner tablet. This device is similar to the + ``tablet`` above but it can be used with the tslib library because in + addition to touch coordinates it reports touch pressure. + +``usb-kbd`` + Standard USB keyboard. Will override the PS/2 keyboard (if present). + +``usb-serial,chardev=id`` + Serial converter. This emulates an FTDI FT232BM chip connected to + host character device id. + +``usb-braille,chardev=id`` + Braille device. This will use BrlAPI to display the braille output on + a real or fake device referenced by id. + +``usb-net[,netdev=id]`` + Network adapter that supports CDC ethernet and RNDIS protocols. id + specifies a netdev defined with ``-netdev …,id=id``. For instance, + user-mode networking can be used with + + .. parsed-literal:: + + |qemu_system| [...] -netdev user,id=net0 -device usb-net,netdev=net0 + +``usb-ccid`` + Smartcard reader device + +``usb-audio`` + USB audio device + +.. _host_005fusb_005fdevices: + +Using host USB devices on a Linux host +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +WARNING: this is an experimental feature. QEMU will slow down when using +it. USB devices requiring real time streaming (i.e. USB Video Cameras) +are not supported yet. + +1. If you use an early Linux 2.4 kernel, verify that no Linux driver is + actually using the USB device. A simple way to do that is simply to + disable the corresponding kernel module by renaming it from + ``mydriver.o`` to ``mydriver.o.disabled``. + +2. Verify that ``/proc/bus/usb`` is working (most Linux distributions + should enable it by default). You should see something like that: + + :: + + ls /proc/bus/usb + 001 devices drivers + +3. Since only root can access to the USB devices directly, you can + either launch QEMU as root or change the permissions of the USB + devices you want to use. For testing, the following suffices: + + :: + + chown -R myuid /proc/bus/usb + +4. Launch QEMU and do in the monitor: + + :: + + info usbhost + Device 1.2, speed 480 Mb/s + Class 00: USB device 1234:5678, USB DISK + + You should see the list of the devices you can use (Never try to use + hubs, it won't work). + +5. Add the device in QEMU by using: + + :: + + device_add usb-host,vendorid=0x1234,productid=0x5678 + + Normally the guest OS should report that a new USB device is plugged. + You can use the option ``-device usb-host,...`` to do the same. + +6. Now you can try to use the host USB device in QEMU. + +When relaunching QEMU, you may have to unplug and plug again the USB +device to make it work again (this is a bug). diff --git a/docs/system/vnc-security.rst b/docs/system/vnc-security.rst new file mode 100644 index 0000000000..b237b07330 --- /dev/null +++ b/docs/system/vnc-security.rst @@ -0,0 +1,202 @@ +.. _vnc_005fsecurity: + +VNC security +------------ + +The VNC server capability provides access to the graphical console of +the guest VM across the network. This has a number of security +considerations depending on the deployment scenarios. + +.. _vnc_005fsec_005fnone: + +Without passwords +~~~~~~~~~~~~~~~~~ + +The simplest VNC server setup does not include any form of +authentication. For this setup it is recommended to restrict it to +listen on a UNIX domain socket only. For example + +.. parsed-literal:: + + |qemu_system| [...OPTIONS...] -vnc unix:/home/joebloggs/.qemu-myvm-vnc + +This ensures that only users on local box with read/write access to that +path can access the VNC server. To securely access the VNC server from a +remote machine, a combination of netcat+ssh can be used to provide a +secure tunnel. + +.. _vnc_005fsec_005fpassword: + +With passwords +~~~~~~~~~~~~~~ + +The VNC protocol has limited support for password based authentication. +Since the protocol limits passwords to 8 characters it should not be +considered to provide high security. The password can be fairly easily +brute-forced by a client making repeat connections. For this reason, a +VNC server using password authentication should be restricted to only +listen on the loopback interface or UNIX domain sockets. Password +authentication is not supported when operating in FIPS 140-2 compliance +mode as it requires the use of the DES cipher. Password authentication +is requested with the ``password`` option, and then once QEMU is running +the password is set with the monitor. Until the monitor is used to set +the password all clients will be rejected. + +.. parsed-literal:: + + |qemu_system| [...OPTIONS...] -vnc :1,password -monitor stdio + (qemu) change vnc password + Password: ******** + (qemu) + +.. _vnc_005fsec_005fcertificate: + +With x509 certificates +~~~~~~~~~~~~~~~~~~~~~~ + +The QEMU VNC server also implements the VeNCrypt extension allowing use +of TLS for encryption of the session, and x509 certificates for +authentication. The use of x509 certificates is strongly recommended, +because TLS on its own is susceptible to man-in-the-middle attacks. +Basic x509 certificate support provides a secure session, but no +authentication. This allows any client to connect, and provides an +encrypted session. + +.. parsed-literal:: + + |qemu_system| [...OPTIONS...] \ + -object tls-creds-x509,id=tls0,dir=/etc/pki/qemu,endpoint=server,verify-peer=no \ + -vnc :1,tls-creds=tls0 -monitor stdio + +In the above example ``/etc/pki/qemu`` should contain at least three +files, ``ca-cert.pem``, ``server-cert.pem`` and ``server-key.pem``. +Unprivileged users will want to use a private directory, for example +``$HOME/.pki/qemu``. NB the ``server-key.pem`` file should be protected +with file mode 0600 to only be readable by the user owning it. + +.. _vnc_005fsec_005fcertificate_005fverify: + +With x509 certificates and client verification +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Certificates can also provide a means to authenticate the client +connecting. The server will request that the client provide a +certificate, which it will then validate against the CA certificate. +This is a good choice if deploying in an environment with a private +internal certificate authority. It uses the same syntax as previously, +but with ``verify-peer`` set to ``yes`` instead. + +.. parsed-literal:: + + |qemu_system| [...OPTIONS...] \ + -object tls-creds-x509,id=tls0,dir=/etc/pki/qemu,endpoint=server,verify-peer=yes \ + -vnc :1,tls-creds=tls0 -monitor stdio + +.. _vnc_005fsec_005fcertificate_005fpw: + +With x509 certificates, client verification and passwords +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Finally, the previous method can be combined with VNC password +authentication to provide two layers of authentication for clients. + +.. parsed-literal:: + + |qemu_system| [...OPTIONS...] \ + -object tls-creds-x509,id=tls0,dir=/etc/pki/qemu,endpoint=server,verify-peer=yes \ + -vnc :1,tls-creds=tls0,password -monitor stdio + (qemu) change vnc password + Password: ******** + (qemu) + +.. _vnc_005fsec_005fsasl: + +With SASL authentication +~~~~~~~~~~~~~~~~~~~~~~~~ + +The SASL authentication method is a VNC extension, that provides an +easily extendable, pluggable authentication method. This allows for +integration with a wide range of authentication mechanisms, such as PAM, +GSSAPI/Kerberos, LDAP, SQL databases, one-time keys and more. The +strength of the authentication depends on the exact mechanism +configured. If the chosen mechanism also provides a SSF layer, then it +will encrypt the datastream as well. + +Refer to the later docs on how to choose the exact SASL mechanism used +for authentication, but assuming use of one supporting SSF, then QEMU +can be launched with: + +.. parsed-literal:: + + |qemu_system| [...OPTIONS...] -vnc :1,sasl -monitor stdio + +.. _vnc_005fsec_005fcertificate_005fsasl: + +With x509 certificates and SASL authentication +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +If the desired SASL authentication mechanism does not supported SSF +layers, then it is strongly advised to run it in combination with TLS +and x509 certificates. This provides securely encrypted data stream, +avoiding risk of compromising of the security credentials. This can be +enabled, by combining the 'sasl' option with the aforementioned TLS + +x509 options: + +.. parsed-literal:: + + |qemu_system| [...OPTIONS...] \ + -object tls-creds-x509,id=tls0,dir=/etc/pki/qemu,endpoint=server,verify-peer=yes \ + -vnc :1,tls-creds=tls0,sasl -monitor stdio + +.. _vnc_005fsetup_005fsasl: + +Configuring SASL mechanisms +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The following documentation assumes use of the Cyrus SASL implementation +on a Linux host, but the principles should apply to any other SASL +implementation or host. When SASL is enabled, the mechanism +configuration will be loaded from system default SASL service config +/etc/sasl2/qemu.conf. If running QEMU as an unprivileged user, an +environment variable SASL_CONF_PATH can be used to make it search +alternate locations for the service config file. + +If the TLS option is enabled for VNC, then it will provide session +encryption, otherwise the SASL mechanism will have to provide +encryption. In the latter case the list of possible plugins that can be +used is drastically reduced. In fact only the GSSAPI SASL mechanism +provides an acceptable level of security by modern standards. Previous +versions of QEMU referred to the DIGEST-MD5 mechanism, however, it has +multiple serious flaws described in detail in RFC 6331 and thus should +never be used any more. The SCRAM-SHA-1 mechanism provides a simple +username/password auth facility similar to DIGEST-MD5, but does not +support session encryption, so can only be used in combination with TLS. + +When not using TLS the recommended configuration is + +:: + + mech_list: gssapi + keytab: /etc/qemu/krb5.tab + +This says to use the 'GSSAPI' mechanism with the Kerberos v5 protocol, +with the server principal stored in /etc/qemu/krb5.tab. For this to work +the administrator of your KDC must generate a Kerberos principal for the +server, with a name of 'qemu/somehost.example.com@EXAMPLE.COM' replacing +'somehost.example.com' with the fully qualified host name of the machine +running QEMU, and 'EXAMPLE.COM' with the Kerberos Realm. + +When using TLS, if username+password authentication is desired, then a +reasonable configuration is + +:: + + mech_list: scram-sha-1 + sasldb_path: /etc/qemu/passwd.db + +The ``saslpasswd2`` program can be used to populate the ``passwd.db`` +file with accounts. + +Other SASL configurations will be left as an exercise for the reader. +Note that all mechanisms, except GSSAPI, should be combined with use of +TLS to ensure a secure data channel. -- cgit v1.2.3-55-g7522 From a6b30bcae6ebc71bae83e0ac7a5f0dfc93bb5b3e Mon Sep 17 00:00:00 2001 From: Peter Maydell Date: Fri, 28 Feb 2020 15:36:06 +0000 Subject: hmp-commands.hx: Add rST documentation fragments Add the rST versions of the documentation fragments. Once we've converted fully from Texinfo to rST we can remove the ETEXI fragments; for the moment we need both. Since the only consumer of the hmp-commands hxtool documentation is the HTML manual, all we need to do for the monitor command documentation to appear in the Sphinx system manual is add the one line that invokes the hxtool extension on the .hx file. Signed-off-by: Peter Maydell Reviewed-by: Alex Bennée Tested-by: Alex Bennée Message-id: 20200228153619.9906-21-peter.maydell@linaro.org --- Makefile | 2 +- docs/system/monitor.rst | 10 +- hmp-commands.hx | 688 ++++++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 698 insertions(+), 2 deletions(-) (limited to 'docs/system') diff --git a/Makefile b/Makefile index f8642cd28a..22427376b4 100644 --- a/Makefile +++ b/Makefile @@ -1071,7 +1071,7 @@ $(MANUAL_BUILDDIR)/interop/index.html: $(call manual-deps,interop) $(MANUAL_BUILDDIR)/specs/index.html: $(call manual-deps,specs) $(call build-manual,specs,html) -$(MANUAL_BUILDDIR)/system/index.html: $(call manual-deps,system) +$(MANUAL_BUILDDIR)/system/index.html: $(call manual-deps,system) $(SRC_PATH)/hmp-commands.hx $(call build-manual,system,html) $(MANUAL_BUILDDIR)/tools/index.html: $(call manual-deps,tools) $(SRC_PATH)/qemu-img-cmds.hx $(SRC_PATH)/docs/qemu-option-trace.rst.inc diff --git a/docs/system/monitor.rst b/docs/system/monitor.rst index 482f391f32..52b0f18cfe 100644 --- a/docs/system/monitor.rst +++ b/docs/system/monitor.rst @@ -14,8 +14,16 @@ You can use it to: - Inspect the VM state without an external debugger. +Commands +~~~~~~~~ + +The following commands are available: + +.. hxtool-doc:: hmp-commands.hx + .. - The commands section goes here once it's converted from Texinfo to RST. + TODO: convert and reference hmp-commands-info.hx + Integer expressions ~~~~~~~~~~~~~~~~~~~ diff --git a/hmp-commands.hx b/hmp-commands.hx index dc23185de4..9aa59f5231 100644 --- a/hmp-commands.hx +++ b/hmp-commands.hx @@ -23,6 +23,10 @@ STEXI @findex help Show the help for all commands or just for command @var{cmd}. ETEXI +SRST +``help`` or ``?`` [*cmd*] + Show the help for all commands or just for command *cmd*. +ERST { .name = "commit", @@ -42,6 +46,16 @@ the backing file, the backing file will not be truncated. If you want the backing file to match the size of the smaller snapshot, you can safely truncate it yourself once the commit operation successfully completes. ETEXI +SRST +``commit`` + Commit changes to the disk images (if -snapshot is used) or backing files. + If the backing file is smaller than the snapshot, then the backing file + will be resized to be the same size as the snapshot. If the snapshot is + smaller than the backing file, the backing file will not be truncated. + If you want the backing file to match the size of the smaller snapshot, + you can safely truncate it yourself once the commit operation successfully + completes. +ERST { .name = "q|quit", @@ -56,6 +70,10 @@ STEXI @findex quit Quit the emulator. ETEXI +SRST +``q`` or ``quit`` + Quit the emulator. +ERST { .name = "exit_preconfig", @@ -75,6 +93,14 @@ and via the QMP monitor during the preconfig state. The command is only available during the preconfig state (i.e. when the --preconfig command line option was in use). ETEXI +SRST +``exit_preconfig`` + This command makes QEMU exit the preconfig state and proceed with + VM initialization using configuration data provided on the command line + and via the QMP monitor during the preconfig state. The command is only + available during the preconfig state (i.e. when the --preconfig command + line option was in use). +ERST { .name = "block_resize", @@ -92,6 +118,13 @@ action to see the updated size. Resize to a lower size is supported, but should be used with extreme caution. Note that this command only resizes image files, it can not resize block devices like LVM volumes. ETEXI +SRST +``block_resize`` + Resize a block image while a guest is running. Usually requires guest + action to see the updated size. Resize to a lower size is supported, + but should be used with extreme caution. Note that this command only + resizes image files, it can not resize block devices like LVM volumes. +ERST { .name = "block_stream", @@ -106,6 +139,10 @@ STEXI @findex block_stream Copy data from a backing file into a block device. ETEXI +SRST +``block_stream`` + Copy data from a backing file into a block device. +ERST { .name = "block_job_set_speed", @@ -120,6 +157,10 @@ STEXI @findex block_job_set_speed Set maximum speed for a background block operation. ETEXI +SRST +``block_job_set_speed`` + Set maximum speed for a background block operation. +ERST { .name = "block_job_cancel", @@ -136,6 +177,10 @@ STEXI @findex block_job_cancel Stop an active background block operation (streaming, mirroring). ETEXI +SRST +``block_job_cancel`` + Stop an active background block operation (streaming, mirroring). +ERST { .name = "block_job_complete", @@ -151,6 +196,11 @@ STEXI Manually trigger completion of an active background block operation. For mirroring, this will switch the device to the destination path. ETEXI +SRST +``block_job_complete`` + Manually trigger completion of an active background block operation. + For mirroring, this will switch the device to the destination path. +ERST { .name = "block_job_pause", @@ -165,6 +215,10 @@ STEXI @findex block_job_pause Pause an active block streaming operation. ETEXI +SRST +``block_job_pause`` + Pause an active block streaming operation. +ERST { .name = "block_job_resume", @@ -179,6 +233,10 @@ STEXI @findex block_job_resume Resume a paused block streaming operation. ETEXI +SRST +``block_job_resume`` + Resume a paused block streaming operation. +ERST { .name = "eject", @@ -193,6 +251,10 @@ STEXI @findex eject Eject a removable medium (use -f to force it). ETEXI +SRST +``eject [-f]`` *device* + Eject a removable medium (use -f to force it). +ERST { .name = "drive_del", @@ -212,6 +274,15 @@ errors in the guest for applications that are reading/writing to the device. These errors are always reported to the guest, regardless of the drive's error actions (drive options rerror, werror). ETEXI +SRST +``drive_del`` *device* + Remove host block device. The result is that guest generated IO is no longer + submitted against the host device underlying the disk. Once a drive has + been deleted, the QEMU Block layer returns -EIO which results in IO + errors in the guest for applications that are reading/writing to the device. + These errors are always reported to the guest, regardless of the drive's error + actions (drive options rerror, werror). +ERST { .name = "change", @@ -271,6 +342,45 @@ Password: ******** @end table ETEXI +SRST +``change`` *device* *setting* + Change the configuration of a device. + + ``change`` *diskdevice* *filename* [*format* [*read-only-mode*]] + Change the medium for a removable disk device to point to *filename*. eg:: + + (qemu) change ide1-cd0 /path/to/some.iso + + *format* is optional. + + *read-only-mode* may be used to change the read-only status of the device. + It accepts the following values: + + retain + Retains the current status; this is the default. + + read-only + Makes the device read-only. + + read-write + Makes the device writable. + + ``change vnc`` *display*,\ *options* + Change the configuration of the VNC server. The valid syntax for *display* + and *options* are described at :ref:`sec_005finvocation`. eg:: + + (qemu) change vnc localhost:1 + + ``change vnc password`` [*password*] + + Change the password associated with the VNC server. If the new password + is not supplied, the monitor will prompt for it to be entered. VNC + passwords are only significant up to 8 letters. eg:: + + (qemu) change vnc password + Password: ******** + +ERST { .name = "screendump", @@ -286,6 +396,10 @@ STEXI @findex screendump Save screen into PPM image @var{filename}. ETEXI +SRST +``screendump`` *filename* + Save screen into PPM image *filename*. +ERST { .name = "logfile", @@ -300,6 +414,10 @@ STEXI @findex logfile Output logs to @var{filename}. ETEXI +SRST +``logfile`` *filename* + Output logs to *filename*. +ERST { .name = "trace-event", @@ -316,6 +434,10 @@ STEXI @findex trace-event changes status of a trace event ETEXI +SRST +``trace-event`` + changes status of a trace event +ERST #if defined(CONFIG_TRACE_SIMPLE) { @@ -331,6 +453,11 @@ STEXI @findex trace-file Open, close, or flush the trace file. If no argument is given, the status of the trace file is displayed. ETEXI +SRST +``trace-file on|off|flush`` + Open, close, or flush the trace file. If no argument is given, the + status of the trace file is displayed. +ERST #endif { @@ -346,6 +473,10 @@ STEXI @findex log Activate logging of the specified items. ETEXI +SRST +``log`` *item1*\ [,...] + Activate logging of the specified items. +ERST { .name = "savevm", @@ -366,6 +497,16 @@ a snapshot with the same tag, it is replaced. More info at Since 4.0, savevm stopped allowing the snapshot id to be set, accepting only @var{tag} as parameter. ETEXI +SRST +``savevm`` *tag* + Create a snapshot of the whole virtual machine. If *tag* is + provided, it is used as human readable identifier. If there is already + a snapshot with the same tag, it is replaced. More info at + :ref:`vm_005fsnapshots`. + + Since 4.0, savevm stopped allowing the snapshot id to be set, accepting + only *tag* as parameter. +ERST { .name = "loadvm", @@ -384,6 +525,13 @@ Set the whole virtual machine to the snapshot identified by the tag Since 4.0, loadvm stopped accepting snapshot id as parameter. ETEXI +SRST +``loadvm`` *tag* + Set the whole virtual machine to the snapshot identified by the tag + *tag*. + + Since 4.0, loadvm stopped accepting snapshot id as parameter. +ERST { .name = "delvm", @@ -402,6 +550,13 @@ Delete the snapshot identified by @var{tag}. Since 4.0, delvm stopped deleting snapshots by snapshot id, accepting only @var{tag} as parameter. ETEXI +SRST +``delvm`` *tag* + Delete the snapshot identified by *tag*. + + Since 4.0, delvm stopped deleting snapshots by snapshot id, accepting + only *tag* as parameter. +ERST { .name = "singlestep", @@ -417,6 +572,11 @@ STEXI Run the emulation in single step mode. If called with option off, the emulation returns to normal mode. ETEXI +SRST +``singlestep [off]`` + Run the emulation in single step mode. + If called with option off, the emulation returns to normal mode. +ERST { .name = "stop", @@ -431,6 +591,10 @@ STEXI @findex stop Stop emulation. ETEXI +SRST +``stop`` + Stop emulation. +ERST { .name = "c|cont", @@ -445,6 +609,10 @@ STEXI @findex cont Resume emulation. ETEXI +SRST +``c`` or ``cont`` + Resume emulation. +ERST { .name = "system_wakeup", @@ -459,6 +627,10 @@ STEXI @findex system_wakeup Wakeup guest from suspend. ETEXI +SRST +``system_wakeup`` + Wakeup guest from suspend. +ERST { .name = "gdbserver", @@ -473,6 +645,10 @@ STEXI @findex gdbserver Start gdbserver session (default @var{port}=1234) ETEXI +SRST +``gdbserver`` [*port*] + Start gdbserver session (default *port*\=1234) +ERST { .name = "x", @@ -487,6 +663,10 @@ STEXI @findex x Virtual memory dump starting at @var{addr}. ETEXI +SRST +``x/``\ *fmt* *addr* + Virtual memory dump starting at *addr*. +ERST { .name = "xp", @@ -554,6 +734,54 @@ Dump 80 16 bit values at the start of the video memory. @end smallexample @end itemize ETEXI +SRST +``xp /``\ *fmt* *addr* + Physical memory dump starting at *addr*. + + *fmt* is a format which tells the command how to format the + data. Its syntax is: ``/{count}{format}{size}`` + + *count* + is the number of items to be dumped. + *format* + can be x (hex), d (signed decimal), u (unsigned decimal), o (octal), + c (char) or i (asm instruction). + *size* + can be b (8 bits), h (16 bits), w (32 bits) or g (64 bits). On x86, + ``h`` or ``w`` can be specified with the ``i`` format to + respectively select 16 or 32 bit code instruction size. + + Examples: + + Dump 10 instructions at the current instruction pointer:: + + (qemu) x/10i $eip + 0x90107063: ret + 0x90107064: sti + 0x90107065: lea 0x0(%esi,1),%esi + 0x90107069: lea 0x0(%edi,1),%edi + 0x90107070: ret + 0x90107071: jmp 0x90107080 + 0x90107073: nop + 0x90107074: nop + 0x90107075: nop + 0x90107076: nop + + Dump 80 16 bit values at the start of the video memory:: + + (qemu) xp/80hx 0xb8000 + 0x000b8000: 0x0b50 0x0b6c 0x0b65 0x0b78 0x0b38 0x0b36 0x0b2f 0x0b42 + 0x000b8010: 0x0b6f 0x0b63 0x0b68 0x0b73 0x0b20 0x0b56 0x0b47 0x0b41 + 0x000b8020: 0x0b42 0x0b69 0x0b6f 0x0b73 0x0b20 0x0b63 0x0b75 0x0b72 + 0x000b8030: 0x0b72 0x0b65 0x0b6e 0x0b74 0x0b2d 0x0b63 0x0b76 0x0b73 + 0x000b8040: 0x0b20 0x0b30 0x0b35 0x0b20 0x0b4e 0x0b6f 0x0b76 0x0b20 + 0x000b8050: 0x0b32 0x0b30 0x0b30 0x0b33 0x0720 0x0720 0x0720 0x0720 + 0x000b8060: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 + 0x000b8070: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 + 0x000b8080: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 + 0x000b8090: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 + +ERST { .name = "gpa2hva", @@ -569,6 +797,11 @@ STEXI Print the host virtual address at which the guest's physical address @var{addr} is mapped. ETEXI +SRST +``gpa2hva`` *addr* + Print the host virtual address at which the guest's physical address *addr* + is mapped. +ERST #ifdef CONFIG_LINUX { @@ -586,6 +819,11 @@ STEXI Print the host physical address at which the guest's physical address @var{addr} is mapped. ETEXI +SRST +``gpa2hpa`` *addr* + Print the host physical address at which the guest's physical address *addr* + is mapped. +ERST { .name = "gva2gpa", @@ -601,6 +839,11 @@ STEXI Print the guest physical address at which the guest's virtual address @var{addr} is mapped based on the mapping for the current CPU. ETEXI +SRST +``gva2gpa`` *addr* + Print the guest physical address at which the guest's virtual address *addr* + is mapped based on the mapping for the current CPU. +ERST { .name = "p|print", @@ -616,6 +859,11 @@ STEXI Print expression value. Only the @var{format} part of @var{fmt} is used. ETEXI +SRST +``p`` or ``print/``\ *fmt* *expr* + Print expression value. Only the *format* part of *fmt* is + used. +ERST { .name = "i", @@ -630,6 +878,10 @@ STEXI @findex i Read I/O port. ETEXI +SRST +``i/``\ *fmt* *addr* [.\ *index*\ ] + Read I/O port. +ERST { .name = "o", @@ -644,6 +896,10 @@ STEXI @findex o Write to I/O port. ETEXI +SRST +``o/``\ *fmt* *addr* *val* + Write to I/O port. +ERST { .name = "sendkey", @@ -667,6 +923,17 @@ sendkey ctrl-alt-f1 This command is useful to send keys that your graphical user interface intercepts at low level, such as @code{ctrl-alt-f1} in X Window. ETEXI +SRST +``sendkey`` *keys* + Send *keys* to the guest. *keys* could be the name of the + key or the raw value in hexadecimal format. Use ``-`` to press + several keys simultaneously. Example:: + + sendkey ctrl-alt-f1 + + This command is useful to send keys that your graphical user interface + intercepts at low level, such as ``ctrl-alt-f1`` in X Window. +ERST { .name = "sync-profile", .args_type = "op:s?", @@ -682,6 +949,11 @@ STEXI Enable, disable or reset synchronization profiling. With no arguments, prints whether profiling is on or off. ETEXI +SRST +``sync-profile [on|off|reset]`` + Enable, disable or reset synchronization profiling. With no arguments, prints + whether profiling is on or off. +ERST { .name = "system_reset", @@ -696,6 +968,10 @@ STEXI @findex system_reset Reset the system. ETEXI +SRST +``system_reset`` + Reset the system. +ERST { .name = "system_powerdown", @@ -710,6 +986,10 @@ STEXI @findex system_powerdown Power down the system (if supported). ETEXI +SRST +``system_powerdown`` + Power down the system (if supported). +ERST { .name = "sum", @@ -724,6 +1004,10 @@ STEXI @findex sum Compute the checksum of a memory region. ETEXI +SRST +``sum`` *addr* *size* + Compute the checksum of a memory region. +ERST { .name = "device_add", @@ -739,6 +1023,10 @@ STEXI @findex device_add Add device. ETEXI +SRST +``device_add`` *config* + Add device. +ERST { .name = "device_del", @@ -755,6 +1043,11 @@ STEXI Remove device @var{id}. @var{id} may be a short ID or a QOM object path. ETEXI +SRST +``device_del`` *id* + Remove device *id*. *id* may be a short ID + or a QOM object path. +ERST { .name = "cpu", @@ -769,6 +1062,10 @@ STEXI @findex cpu Set the default CPU. ETEXI +SRST +``cpu`` *index* + Set the default CPU. +ERST { .name = "mouse_move", @@ -784,6 +1081,11 @@ STEXI Move the active mouse to the specified coordinates @var{dx} @var{dy} with optional scroll axis @var{dz}. ETEXI +SRST +``mouse_move`` *dx* *dy* [*dz*] + Move the active mouse to the specified coordinates *dx* *dy* + with optional scroll axis *dz*. +ERST { .name = "mouse_button", @@ -798,6 +1100,10 @@ STEXI @findex mouse_button Change the active mouse button state @var{val} (1=L, 2=M, 4=R). ETEXI +SRST +``mouse_button`` *val* + Change the active mouse button state *val* (1=L, 2=M, 4=R). +ERST { .name = "mouse_set", @@ -816,6 +1122,14 @@ can be obtained with info mice @end example ETEXI +SRST +``mouse_set`` *index* + Set which mouse device receives events at given *index*, index + can be obtained with:: + + info mice + +ERST { .name = "wavcapture", @@ -838,6 +1152,18 @@ Defaults: @item Number of channels = 2 - Stereo @end itemize ETEXI +SRST +``wavcapture`` *filename* *audiodev* [*frequency* [*bits* [*channels*]]] + Capture audio into *filename* from *audiodev*, using sample rate + *frequency* bits per sample *bits* and number of channels + *channels*. + + Defaults: + + - Sample rate = 44100 Hz - CD quality + - Bits = 16 + - Number of channels = 2 - Stereo +ERST { .name = "stopcapture", @@ -854,6 +1180,13 @@ Stop capture with a given @var{index}, index can be obtained with info capture @end example ETEXI +SRST +``stopcapture`` *index* + Stop capture with a given *index*, index can be obtained with:: + + info capture + +ERST { .name = "memsave", @@ -868,6 +1201,10 @@ STEXI @findex memsave save to disk virtual memory dump starting at @var{addr} of size @var{size}. ETEXI +SRST +``memsave`` *addr* *size* *file* + save to disk virtual memory dump starting at *addr* of size *size*. +ERST { .name = "pmemsave", @@ -882,6 +1219,10 @@ STEXI @findex pmemsave save to disk physical memory dump starting at @var{addr} of size @var{size}. ETEXI +SRST +``pmemsave`` *addr* *size* *file* + save to disk physical memory dump starting at *addr* of size *size*. +ERST { .name = "boot_set", @@ -900,6 +1241,14 @@ the values specified on the command line through the @code{-boot} option. The values that can be specified here depend on the machine type, but are the same that can be specified in the @code{-boot} command line option. ETEXI +SRST +``boot_set`` *bootdevicelist* + Define new values for the boot device list. Those values will override + the values specified on the command line through the ``-boot`` option. + + The values that can be specified here depend on the machine type, but are + the same that can be specified in the ``-boot`` command line option. +ERST { .name = "nmi", @@ -914,6 +1263,10 @@ STEXI Inject an NMI on the default CPU (x86/s390) or all CPUs (ppc64). ETEXI +SRST +``nmi`` *cpu* + Inject an NMI on the default CPU (x86/s390) or all CPUs (ppc64). +ERST { .name = "ringbuf_write", @@ -931,6 +1284,11 @@ Write @var{data} to ring buffer character device @var{device}. @var{data} must be a UTF-8 string. ETEXI +SRST +``ringbuf_write`` *device* *data* + Write *data* to ring buffer character device *device*. + *data* must be a UTF-8 string. +ERST { .name = "ringbuf_read", @@ -953,6 +1311,16 @@ NUL characters, after the ring buffer lost data, and when reading stops because the size limit is reached. ETEXI +SRST +``ringbuf_read`` *device* + Read and print up to *size* bytes from ring buffer character + device *device*. + Certain non-printable characters are printed ``\uXXXX``, where ``XXXX`` is the + character code in hexadecimal. Character ``\`` is printed ``\\``. + Bug: can screw up when the buffer contains invalid UTF-8 sequences, + NUL characters, after the ring buffer lost data, and when reading + stops because the size limit is reached. +ERST { .name = "announce_self", @@ -972,6 +1340,15 @@ An optional comma separated @var{interfaces} list restricts the announce to the named set of interfaces. An optional @var{id} can be used to start a separate announce timer and to change the parameters of it later. ETEXI +SRST +``announce_self`` + Trigger a round of GARP/RARP broadcasts; this is useful for explicitly + updating the network infrastructure after a reconfiguration or some forms + of migration. The timings of the round are set by the migration announce + parameters. An optional comma separated *interfaces* list restricts the + announce to the named set of interfaces. An optional *id* can be used to + start a separate announce timer and to change the parameters of it later. +ERST { .name = "migrate", @@ -994,6 +1371,15 @@ Migrate to @var{uri} (using -d to not wait for completion). -b for migration with full copy of disk -i for migration with incremental copy of disk (base image is shared) ETEXI +SRST +``migrate [-d] [-b] [-i]`` *uri* + Migrate to *uri* (using -d to not wait for completion). + + ``-b`` + for migration with full copy of disk + ``-i`` + for migration with incremental copy of disk (base image is shared) +ERST { .name = "migrate_cancel", @@ -1008,6 +1394,10 @@ STEXI @findex migrate_cancel Cancel the current VM migration. ETEXI +SRST +``migrate_cancel`` + Cancel the current VM migration. +ERST { .name = "migrate_continue", @@ -1021,6 +1411,10 @@ STEXI @findex migrate_continue Continue migration from the paused state @var{state} ETEXI +SRST +``migrate_continue`` *state* + Continue migration from the paused state *state* +ERST { .name = "migrate_incoming", @@ -1036,6 +1430,11 @@ STEXI Continue an incoming migration using the @var{uri} (that has the same syntax as the -incoming option). ETEXI +SRST +``migrate_incoming`` *uri* + Continue an incoming migration using the *uri* (that has the same syntax + as the ``-incoming`` option). +ERST { .name = "migrate_recover", @@ -1050,6 +1449,10 @@ STEXI @findex migrate_recover Continue a paused incoming postcopy migration using the @var{uri}. ETEXI +SRST +``migrate_recover`` *uri* + Continue a paused incoming postcopy migration using the *uri*. +ERST { .name = "migrate_pause", @@ -1064,6 +1467,10 @@ STEXI @findex migrate_pause Pause an ongoing migration. Currently it only supports postcopy. ETEXI +SRST +``migrate_pause`` + Pause an ongoing migration. Currently it only supports postcopy. +ERST { .name = "migrate_set_cache_size", @@ -1083,6 +1490,10 @@ STEXI @findex migrate_set_cache_size Set cache size to @var{value} (in bytes) for xbzrle migrations. ETEXI +SRST +``migrate_set_cache_size`` *value* + Set cache size to *value* (in bytes) for xbzrle migrations. +ERST { .name = "migrate_set_speed", @@ -1098,6 +1509,10 @@ STEXI @findex migrate_set_speed Set maximum speed to @var{value} (in bytes) for migrations. ETEXI +SRST +``migrate_set_speed`` *value* + Set maximum speed to *value* (in bytes) for migrations. +ERST { .name = "migrate_set_downtime", @@ -1112,6 +1527,10 @@ STEXI @findex migrate_set_downtime Set maximum tolerated downtime (in seconds) for migration. ETEXI +SRST +``migrate_set_downtime`` *second* + Set maximum tolerated downtime (in seconds) for migration. +ERST { .name = "migrate_set_capability", @@ -1127,6 +1546,10 @@ STEXI @findex migrate_set_capability Enable/Disable the usage of a capability @var{capability} for migration. ETEXI +SRST +``migrate_set_capability`` *capability* *state* + Enable/Disable the usage of a capability *capability* for migration. +ERST { .name = "migrate_set_parameter", @@ -1142,6 +1565,10 @@ STEXI @findex migrate_set_parameter Set the parameter @var{parameter} for migration. ETEXI +SRST +``migrate_set_parameter`` *parameter* *value* + Set the parameter *parameter* for migration. +ERST { .name = "migrate_start_postcopy", @@ -1160,6 +1587,11 @@ STEXI Switch in-progress migration to postcopy mode. Ignored after the end of migration (or once already in postcopy). ETEXI +SRST +``migrate_start_postcopy`` + Switch in-progress migration to postcopy mode. Ignored after the end of + migration (or once already in postcopy). +ERST { .name = "x_colo_lost_heartbeat", @@ -1175,6 +1607,10 @@ STEXI @findex x_colo_lost_heartbeat Tell COLO that heartbeat is lost, a failover or takeover is needed. ETEXI +SRST +``x_colo_lost_heartbeat`` + Tell COLO that heartbeat is lost, a failover or takeover is needed. +ERST { .name = "client_migrate_info", @@ -1191,6 +1627,12 @@ Set migration information for remote display. This makes the server ask the client to automatically reconnect using the new parameters once migration finished successfully. Only implemented for SPICE. ETEXI +SRST +``client_migrate_info`` *protocol* *hostname* *port* *tls-port* *cert-subject* + Set migration information for remote display. This makes the server + ask the client to automatically reconnect using the new parameters + once migration finished successfully. Only implemented for SPICE. +ERST { .name = "dump-guest-memory", @@ -1227,6 +1669,34 @@ gdb. Without -z|-l|-s|-w, the dump format is ELF. length: the memory size, in bytes. It's optional, and should be specified together with begin. ETEXI +SRST +``dump-guest-memory [-p]`` *filename* *begin* *length* + \ +``dump-guest-memory [-z|-l|-s|-w]`` *filename* + Dump guest memory to *protocol*. The file can be processed with crash or + gdb. Without ``-z|-l|-s|-w``, the dump format is ELF. + + ``-p`` + do paging to get guest's memory mapping. + ``-z`` + dump in kdump-compressed format, with zlib compression. + ``-l`` + dump in kdump-compressed format, with lzo compression. + ``-s`` + dump in kdump-compressed format, with snappy compression. + ``-w`` + dump in Windows crashdump format (can be used instead of ELF-dump converting), + for Windows x64 guests with vmcoreinfo driver only + *filename* + dump file name. + *begin* + the starting physical address. It's optional, and should be + specified together with *length*. + *length* + the memory size, in bytes. It's optional, and should be specified + together with *begin*. + +ERST #if defined(TARGET_S390X) { @@ -1243,6 +1713,10 @@ STEXI @findex dump-skeys Save guest storage keys to a file. ETEXI +SRST +``dump-skeys`` *filename* + Save guest storage keys to a file. +ERST #if defined(TARGET_S390X) { @@ -1259,6 +1733,10 @@ STEXI @findex migration_mode Enables or disables migration mode. ETEXI +SRST +``migration_mode`` *mode* + Enables or disables migration mode. +ERST { .name = "snapshot_blkdev", @@ -1280,6 +1758,10 @@ STEXI @findex snapshot_blkdev Snapshot device, using snapshot file as target if provided ETEXI +SRST +``snapshot_blkdev`` + Snapshot device, using snapshot file as target if provided +ERST { .name = "snapshot_blkdev_internal", @@ -1296,6 +1778,10 @@ STEXI @findex snapshot_blkdev_internal Take an internal snapshot on device if it support ETEXI +SRST +``snapshot_blkdev_internal`` + Take an internal snapshot on device if it support +ERST { .name = "snapshot_delete_blkdev_internal", @@ -1314,6 +1800,10 @@ STEXI @findex snapshot_delete_blkdev_internal Delete an internal snapshot on device if it support ETEXI +SRST +``snapshot_delete_blkdev_internal`` + Delete an internal snapshot on device if it support +ERST { .name = "drive_mirror", @@ -1335,6 +1825,11 @@ STEXI Start mirroring a block device's writes to a new destination, using the specified target. ETEXI +SRST +``drive_mirror`` + Start mirroring a block device's writes to a new destination, + using the specified target. +ERST { .name = "drive_backup", @@ -1357,6 +1852,10 @@ STEXI @findex drive_backup Start a point-in-time copy of a block device to a specificed target. ETEXI +SRST +``drive_backup`` + Start a point-in-time copy of a block device to a specificed target. +ERST { .name = "drive_add", @@ -1375,6 +1874,10 @@ STEXI @findex drive_add Add drive to PCI storage controller. ETEXI +SRST +``drive_add`` + Add drive to PCI storage controller. +ERST { .name = "pcie_aer_inject_error", @@ -1399,6 +1902,10 @@ STEXI @findex pcie_aer_inject_error Inject PCIe AER error ETEXI +SRST +``pcie_aer_inject_error`` + Inject PCIe AER error +ERST { .name = "netdev_add", @@ -1414,6 +1921,10 @@ STEXI @findex netdev_add Add host network device. ETEXI +SRST +``netdev_add`` + Add host network device. +ERST { .name = "netdev_del", @@ -1429,6 +1940,10 @@ STEXI @findex netdev_del Remove host network device. ETEXI +SRST +``netdev_del`` + Remove host network device. +ERST { .name = "object_add", @@ -1444,6 +1959,10 @@ STEXI @findex object_add Create QOM object. ETEXI +SRST +``object_add`` + Create QOM object. +ERST { .name = "object_del", @@ -1459,6 +1978,10 @@ STEXI @findex object_del Destroy QOM object. ETEXI +SRST +``object_del`` + Destroy QOM object. +ERST #ifdef CONFIG_SLIRP { @@ -1474,6 +1997,10 @@ STEXI @findex hostfwd_add Redirect TCP or UDP connections from host to guest (requires -net user). ETEXI +SRST +``hostfwd_add`` + Redirect TCP or UDP connections from host to guest (requires -net user). +ERST #ifdef CONFIG_SLIRP { @@ -1490,6 +2017,10 @@ STEXI @findex hostfwd_remove Remove host-to-guest TCP or UDP redirection. ETEXI +SRST +``hostfwd_remove`` + Remove host-to-guest TCP or UDP redirection. +ERST { .name = "balloon", @@ -1504,6 +2035,10 @@ STEXI @findex balloon Request VM to change its memory allocation to @var{value} (in MB). ETEXI +SRST +``balloon`` *value* + Request VM to change its memory allocation to *value* (in MB). +ERST { .name = "set_link", @@ -1519,6 +2054,10 @@ STEXI @findex set_link Switch link @var{name} on (i.e. up) or off (i.e. down). ETEXI +SRST +``set_link`` *name* ``[on|off]`` + Switch link *name* on (i.e. up) or off (i.e. down). +ERST { .name = "watchdog_action", @@ -1534,6 +2073,10 @@ STEXI @findex watchdog_action Change watchdog action. ETEXI +SRST +``watchdog_action`` + Change watchdog action. +ERST { .name = "acl_show", @@ -1551,6 +2094,13 @@ policy. There are currently two named access control lists, @var{vnc.x509dname} and @var{vnc.username} matching on the x509 client certificate distinguished name, and SASL username respectively. ETEXI +SRST +``acl_show`` *aclname* + List all the matching rules in the access control list, and the default + policy. There are currently two named access control lists, + *vnc.x509dname* and *vnc.username* matching on the x509 client + certificate distinguished name, and SASL username respectively. +ERST { .name = "acl_policy", @@ -1567,6 +2117,12 @@ Set the default access control list policy, used in the event that none of the explicit rules match. The default policy at startup is always @code{deny}. ETEXI +SRST +``acl_policy`` *aclname* ``allow|deny`` + Set the default access control list policy, used in the event that + none of the explicit rules match. The default policy at startup is + always ``deny``. +ERST { .name = "acl_add", @@ -1586,6 +2142,15 @@ allow all users in the @code{EXAMPLE.COM} kerberos realm. The match will normally be appended to the end of the ACL, but can be inserted earlier in the list if the optional @var{index} parameter is supplied. ETEXI +SRST +``acl_add`` *aclname* *match* ``allow|deny`` [*index*] + Add a match rule to the access control list, allowing or denying access. + The match will normally be an exact username or x509 distinguished name, + but can optionally include wildcard globs. eg ``*@EXAMPLE.COM`` to + allow all users in the ``EXAMPLE.COM`` kerberos realm. The match will + normally be appended to the end of the ACL, but can be inserted + earlier in the list if the optional *index* parameter is supplied. +ERST { .name = "acl_remove", @@ -1600,6 +2165,10 @@ STEXI @findex acl_remove Remove the specified match rule from the access control list. ETEXI +SRST +``acl_remove`` *aclname* *match* + Remove the specified match rule from the access control list. +ERST { .name = "acl_reset", @@ -1615,6 +2184,11 @@ STEXI Remove all matches from the access control list, and set the default policy back to @code{deny}. ETEXI +SRST +``acl_reset`` *aclname* + Remove all matches from the access control list, and set the default + policy back to ``deny``. +ERST { .name = "nbd_server_start", @@ -1631,6 +2205,13 @@ option is included, all of the virtual machine's block devices that have an inserted media on them are automatically exported; in this case, the @option{-w} option makes the devices writable too. ETEXI +SRST +``nbd_server_start`` *host*:*port* + Start an NBD server on the given host and/or port. If the ``-a`` + option is included, all of the virtual machine's block devices that + have an inserted media on them are automatically exported; in this case, + the ``-w`` option makes the devices writable too. +ERST { .name = "nbd_server_add", @@ -1647,6 +2228,13 @@ beforehand with @command{nbd_server_start}. The @option{-w} option makes the exported device writable too. The export name is controlled by @var{name}, defaulting to @var{device}. ETEXI +SRST +``nbd_server_add`` *device* [ *name* ] + Export a block device through QEMU's NBD server, which must be started + beforehand with ``nbd_server_start``. The ``-w`` option makes the + exported device writable too. The export name is controlled by *name*, + defaulting to *device*. +ERST { .name = "nbd_server_remove", @@ -1664,6 +2252,14 @@ option forces the server to drop the export immediately even if clients are connected; otherwise the command fails unless there are no clients. ETEXI +SRST +``nbd_server_remove [-f]`` *name* + Stop exporting a block device through QEMU's NBD server, which was + previously started with ``nbd_server_add``. The ``-f`` + option forces the server to drop the export immediately even if + clients are connected; otherwise the command fails unless there are no + clients. +ERST { .name = "nbd_server_stop", @@ -1677,6 +2273,10 @@ STEXI @findex nbd_server_stop Stop the QEMU embedded NBD server. ETEXI +SRST +``nbd_server_stop`` + Stop the QEMU embedded NBD server. +ERST #if defined(TARGET_I386) @@ -1695,6 +2295,10 @@ STEXI @findex mce (x86) Inject an MCE on the given CPU (x86 only). ETEXI +SRST +``mce`` *cpu* *bank* *status* *mcgstatus* *addr* *misc* + Inject an MCE on the given CPU (x86 only). +ERST { .name = "getfd", @@ -1711,6 +2315,12 @@ If a file descriptor is passed alongside this command using the SCM_RIGHTS mechanism on unix sockets, it is stored using the name @var{fdname} for later use by other monitor commands. ETEXI +SRST +``getfd`` *fdname* + If a file descriptor is passed alongside this command using the SCM_RIGHTS + mechanism on unix sockets, it is stored using the name *fdname* for + later use by other monitor commands. +ERST { .name = "closefd", @@ -1727,6 +2337,12 @@ Close the file descriptor previously assigned to @var{fdname} using the @code{getfd} command. This is only needed if the file descriptor was never used by another monitor command. ETEXI +SRST +``closefd`` *fdname* + Close the file descriptor previously assigned to *fdname* using the + ``getfd`` command. This is only needed if the file descriptor was never + used by another monitor command. +ERST { .name = "block_passwd", @@ -1743,6 +2359,12 @@ Set the encrypted device @var{device} password to @var{password} This command is now obsolete and will always return an error since 2.10 ETEXI +SRST +``block_passwd`` *device* *password* + Set the encrypted device *device* password to *password* + + This command is now obsolete and will always return an error since 2.10 +ERST { .name = "block_set_io_throttle", @@ -1758,6 +2380,12 @@ STEXI Change I/O throttle limits for a block drive to @var{bps} @var{bps_rd} @var{bps_wr} @var{iops} @var{iops_rd} @var{iops_wr}. @var{device} can be a block device name, a qdev ID or a QOM path. ETEXI +SRST +``block_set_io_throttle`` *device* *bps* *bps_rd* *bps_wr* *iops* *iops_rd* *iops_wr* + Change I/O throttle limits for a block drive to + *bps* *bps_rd* *bps_wr* *iops* *iops_rd* *iops_wr*. + *device* can be a block device name, a qdev ID or a QOM path. +ERST { .name = "set_password", @@ -1777,6 +2405,15 @@ fail. @var{disconnect} changes the password and disconnects the client. @var{keep} changes the password and keeps the connection up. @var{keep} is the default. ETEXI +SRST +``set_password [ vnc | spice ] password [ action-if-connected ]`` + Change spice/vnc password. Use zero to make the password stay valid + forever. *action-if-connected* specifies what should happen in + case a connection is established: *fail* makes the password change + fail. *disconnect* changes the password and disconnects the + client. *keep* changes the password and keeps the connection up. + *keep* is the default. +ERST { .name = "expire_password", @@ -1808,6 +2445,22 @@ passed since 1970, i.e. unix epoch. @end table ETEXI +SRST +``expire_password [ vnc | spice ]`` *expire-time* + Specify when a password for spice/vnc becomes + invalid. *expire-time* accepts: + + ``now`` + Invalidate password instantly. + ``never`` + Password stays valid forever. + ``+``\ *nsec* + Password stays valid for *nsec* seconds starting now. + *nsec* + Password is invalidated at the given time. *nsec* are the seconds + passed since 1970, i.e. unix epoch. + +ERST { .name = "chardev-add", @@ -1824,6 +2477,10 @@ STEXI chardev-add accepts the same parameters as the -chardev command line switch. ETEXI +SRST +``chardev-add`` *args* + chardev-add accepts the same parameters as the -chardev command line switch. +ERST { .name = "chardev-change", @@ -1840,6 +2497,11 @@ chardev-change accepts existing chardev @var{id} and then the same arguments as the -chardev command line switch (except for "id"). ETEXI +SRST +``chardev-change`` *args* + chardev-change accepts existing chardev *id* and then the same arguments + as the -chardev command line switch (except for "id"). +ERST { .name = "chardev-remove", @@ -1856,6 +2518,10 @@ STEXI Removes the chardev @var{id}. ETEXI +SRST +``chardev-remove`` *id* + Removes the chardev *id*. +ERST { .name = "chardev-send-break", @@ -1872,6 +2538,10 @@ STEXI Send a break on the chardev @var{id}. ETEXI +SRST +``chardev-send-break`` *id* + Send a break on the chardev *id*. +ERST { .name = "qemu-io", @@ -1889,6 +2559,10 @@ STEXI Executes a qemu-io command on the given block device. ETEXI +SRST +``qemu-io`` *device* *command* + Executes a qemu-io command on the given block device. +ERST { .name = "cpu-add", @@ -1905,6 +2579,12 @@ Add CPU with id @var{id}. This command is deprecated, please +use @code{device_add} instead. For details, refer to 'docs/cpu-hotplug.rst'. ETEXI +SRST +``cpu-add`` *id* + Add CPU with id *id*. This command is deprecated, please + +use ``device_add`` instead. For details, refer to + 'docs/cpu-hotplug.rst'. +ERST { .name = "qom-list", @@ -1919,6 +2599,10 @@ STEXI @item qom-list [@var{path}] Print QOM properties of object at location @var{path} ETEXI +SRST +``qom-list`` [*path*] + Print QOM properties of object at location *path* +ERST { .name = "qom-set", @@ -1933,6 +2617,10 @@ STEXI @item qom-set @var{path} @var{property} @var{value} Set QOM property @var{property} of object at location @var{path} to value @var{value} ETEXI +SRST +``qom-set`` *path* *property* *value* + Set QOM property *property* of object at location *path* to value *value* +ERST { .name = "info", -- cgit v1.2.3-55-g7522 From a12e74cc5236e0ebe06d44e8e159e07c066ba842 Mon Sep 17 00:00:00 2001 From: Peter Maydell Date: Fri, 28 Feb 2020 15:36:07 +0000 Subject: hmp-commands-info.hx: Add rST documentation fragments Add the rST versions of the documentation fragments. Once we've converted fully from Texinfo to rST we can remove the ETEXI fragments; for the moment we need both. Note that most of the SRST fragments are 2-space indented so that the 'info foo' documentation entries appear as a sublist under the 'info' entry in the top level list. Again, all we need to do to put the documentation in the Sphinx manual is a one-line hxtool-doc invocation. Signed-off-by: Peter Maydell Reviewed-by: Alex Bennée Tested-by: Alex Bennée Message-id: 20200228153619.9906-22-peter.maydell@linaro.org --- Makefile | 2 +- docs/system/monitor.rst | 4 +- hmp-commands-info.hx | 271 ++++++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 273 insertions(+), 4 deletions(-) (limited to 'docs/system') diff --git a/Makefile b/Makefile index 22427376b4..98ef06ab8e 100644 --- a/Makefile +++ b/Makefile @@ -1071,7 +1071,7 @@ $(MANUAL_BUILDDIR)/interop/index.html: $(call manual-deps,interop) $(MANUAL_BUILDDIR)/specs/index.html: $(call manual-deps,specs) $(call build-manual,specs,html) -$(MANUAL_BUILDDIR)/system/index.html: $(call manual-deps,system) $(SRC_PATH)/hmp-commands.hx +$(MANUAL_BUILDDIR)/system/index.html: $(call manual-deps,system) $(SRC_PATH)/hmp-commands.hx $(SRC_PATH)/hmp-commands-info.hx $(call build-manual,system,html) $(MANUAL_BUILDDIR)/tools/index.html: $(call manual-deps,tools) $(SRC_PATH)/qemu-img-cmds.hx $(SRC_PATH)/docs/qemu-option-trace.rst.inc diff --git a/docs/system/monitor.rst b/docs/system/monitor.rst index 52b0f18cfe..0bcd5da216 100644 --- a/docs/system/monitor.rst +++ b/docs/system/monitor.rst @@ -21,9 +21,7 @@ The following commands are available: .. hxtool-doc:: hmp-commands.hx -.. - TODO: convert and reference hmp-commands-info.hx - +.. hxtool-doc:: hmp-commands-info.hx Integer expressions ~~~~~~~~~~~~~~~~~~~ diff --git a/hmp-commands-info.hx b/hmp-commands-info.hx index 257ee7d7a3..1730f866cd 100644 --- a/hmp-commands-info.hx +++ b/hmp-commands-info.hx @@ -4,6 +4,12 @@ HXCOMM discarded from C version HXCOMM DEF(command, args, callback, arg_string, help) is used to construct HXCOMM monitor info commands HXCOMM HXCOMM can be used for comments, discarded from both texi and C +HXCOMM +HXCOMM In this file, generally SRST fragments should have two extra +HXCOMM spaces of indent, so that the documentation list item for "info foo" +HXCOMM appears inside the documentation list item for the top level +HXCOMM "info" documentation entry. The exception is the first SRST +HXCOMM fragment that defines that top level entry. STEXI @table @option @@ -12,6 +18,11 @@ STEXI Show various information about the system state. @table @option ETEXI +SRST +``info`` *subcommand* + Show various information about the system state. + +ERST { .name = "version", @@ -27,6 +38,10 @@ STEXI @findex info version Show the version of QEMU. ETEXI +SRST + ``info version`` + Show the version of QEMU. +ERST { .name = "network", @@ -41,6 +56,10 @@ STEXI @findex info network Show the network state. ETEXI +SRST + ``info network`` + Show the network state. +ERST { .name = "chardev", @@ -56,6 +75,10 @@ STEXI @findex info chardev Show the character devices. ETEXI +SRST + ``info chardev`` + Show the character devices. +ERST { .name = "block", @@ -71,6 +94,10 @@ STEXI @findex info block Show info of one block device or all block devices. ETEXI +SRST + ``info block`` + Show info of one block device or all block devices. +ERST { .name = "blockstats", @@ -85,6 +112,10 @@ STEXI @findex info blockstats Show block device statistics. ETEXI +SRST + ``info blockstats`` + Show block device statistics. +ERST { .name = "block-jobs", @@ -99,6 +130,10 @@ STEXI @findex info block-jobs Show progress of ongoing block device operations. ETEXI +SRST + ``info block-jobs`` + Show progress of ongoing block device operations. +ERST { .name = "registers", @@ -113,6 +148,10 @@ STEXI @findex info registers Show the cpu registers. ETEXI +SRST + ``info registers`` + Show the cpu registers. +ERST #if defined(TARGET_I386) { @@ -130,6 +169,10 @@ STEXI @findex info lapic Show local APIC state ETEXI +SRST + ``info lapic`` + Show local APIC state +ERST #if defined(TARGET_I386) { @@ -146,6 +189,10 @@ STEXI @findex info ioapic Show io APIC state ETEXI +SRST + ``info ioapic`` + Show io APIC state +ERST { .name = "cpus", @@ -160,6 +207,10 @@ STEXI @findex info cpus Show infos for each CPU. ETEXI +SRST + ``info cpus`` + Show infos for each CPU. +ERST { .name = "history", @@ -175,6 +226,10 @@ STEXI @findex info history Show the command line history. ETEXI +SRST + ``info history`` + Show the command line history. +ERST { .name = "irq", @@ -189,6 +244,10 @@ STEXI @findex info irq Show the interrupts statistics (if available). ETEXI +SRST + ``info irq`` + Show the interrupts statistics (if available). +ERST { .name = "pic", @@ -203,6 +262,10 @@ STEXI @findex info pic Show PIC state. ETEXI +SRST + ``info pic`` + Show PIC state. +ERST { .name = "rdma", @@ -217,6 +280,10 @@ STEXI @findex info rdma Show RDMA state. ETEXI +SRST + ``info rdma`` + Show RDMA state. +ERST { .name = "pci", @@ -231,6 +298,10 @@ STEXI @findex info pci Show PCI information. ETEXI +SRST + ``info pci`` + Show PCI information. +ERST #if defined(TARGET_I386) || defined(TARGET_SH4) || defined(TARGET_SPARC) || \ defined(TARGET_PPC) || defined(TARGET_XTENSA) || defined(TARGET_M68K) @@ -248,6 +319,10 @@ STEXI @findex info tlb Show virtual to physical memory mappings. ETEXI +SRST + ``info tlb`` + Show virtual to physical memory mappings. +ERST #if defined(TARGET_I386) || defined(TARGET_RISCV) { @@ -264,6 +339,10 @@ STEXI @findex info mem Show the active virtual memory mappings. ETEXI +SRST + ``info mem`` + Show the active virtual memory mappings. +ERST { .name = "mtree", @@ -280,6 +359,10 @@ STEXI @findex info mtree Show memory tree. ETEXI +SRST + ``info mtree`` + Show memory tree. +ERST #if defined(CONFIG_TCG) { @@ -296,6 +379,10 @@ STEXI @findex info jit Show dynamic compiler info. ETEXI +SRST + ``info jit`` + Show dynamic compiler info. +ERST #if defined(CONFIG_TCG) { @@ -312,6 +399,10 @@ STEXI @findex info opcount Show dynamic compiler opcode counters ETEXI +SRST + ``info opcount`` + Show dynamic compiler opcode counters +ERST { .name = "sync-profile", @@ -334,6 +425,20 @@ sorted by total wait time. When different objects that share the same call site are coalesced, the "Object" field shows---enclosed in brackets---the number of objects being coalesced. ETEXI +SRST + ``info sync-profile [-m|-n]`` [*max*] + Show synchronization profiling info, up to *max* entries (default: 10), + sorted by total wait time. + + ``-m`` + sort by mean wait time + ``-n`` + do not coalesce objects with the same call site + + When different objects that share the same call site are coalesced, + the "Object" field shows---enclosed in brackets---the number of objects + being coalesced. +ERST { .name = "kvm", @@ -348,6 +453,10 @@ STEXI @findex info kvm Show KVM information. ETEXI +SRST + ``info kvm`` + Show KVM information. +ERST { .name = "numa", @@ -362,6 +471,10 @@ STEXI @findex info numa Show NUMA information. ETEXI +SRST + ``info numa`` + Show NUMA information. +ERST { .name = "usb", @@ -376,6 +489,10 @@ STEXI @findex info usb Show guest USB devices. ETEXI +SRST + ``info usb`` + Show guest USB devices. +ERST { .name = "usbhost", @@ -390,6 +507,10 @@ STEXI @findex info usbhost Show host USB devices. ETEXI +SRST + ``info usbhost`` + Show host USB devices. +ERST { .name = "profile", @@ -404,6 +525,10 @@ STEXI @findex info profile Show profiling information. ETEXI +SRST + ``info profile`` + Show profiling information. +ERST { .name = "capture", @@ -418,6 +543,10 @@ STEXI @findex info capture Show capture information. ETEXI +SRST + ``info capture`` + Show capture information. +ERST { .name = "snapshots", @@ -432,6 +561,10 @@ STEXI @findex info snapshots Show the currently saved VM snapshots. ETEXI +SRST + ``info snapshots`` + Show the currently saved VM snapshots. +ERST { .name = "status", @@ -447,6 +580,10 @@ STEXI @findex info status Show the current VM status (running|paused). ETEXI +SRST + ``info status`` + Show the current VM status (running|paused). +ERST { .name = "mice", @@ -461,6 +598,10 @@ STEXI @findex info mice Show which guest mouse is receiving events. ETEXI +SRST + ``info mice`` + Show which guest mouse is receiving events. +ERST #if defined(CONFIG_VNC) { @@ -477,6 +618,10 @@ STEXI @findex info vnc Show the vnc server status. ETEXI +SRST + ``info vnc`` + Show the vnc server status. +ERST #if defined(CONFIG_SPICE) { @@ -493,6 +638,10 @@ STEXI @findex info spice Show the spice server status. ETEXI +SRST + ``info spice`` + Show the spice server status. +ERST { .name = "name", @@ -508,6 +657,10 @@ STEXI @findex info name Show the current VM name. ETEXI +SRST + ``info name`` + Show the current VM name. +ERST { .name = "uuid", @@ -523,6 +676,10 @@ STEXI @findex info uuid Show the current VM UUID. ETEXI +SRST + ``info uuid`` + Show the current VM UUID. +ERST { .name = "cpustats", @@ -537,6 +694,10 @@ STEXI @findex info cpustats Show CPU statistics. ETEXI +SRST + ``info cpustats`` + Show CPU statistics. +ERST #if defined(CONFIG_SLIRP) { @@ -553,6 +714,10 @@ STEXI @findex info usernet Show user network stack connection states. ETEXI +SRST + ``info usernet`` + Show user network stack connection states. +ERST { .name = "migrate", @@ -567,6 +732,10 @@ STEXI @findex info migrate Show migration status. ETEXI +SRST + ``info migrate`` + Show migration status. +ERST { .name = "migrate_capabilities", @@ -581,6 +750,10 @@ STEXI @findex info migrate_capabilities Show current migration capabilities. ETEXI +SRST + ``info migrate_capabilities`` + Show current migration capabilities. +ERST { .name = "migrate_parameters", @@ -595,6 +768,10 @@ STEXI @findex info migrate_parameters Show current migration parameters. ETEXI +SRST + ``info migrate_parameters`` + Show current migration parameters. +ERST { .name = "migrate_cache_size", @@ -609,6 +786,10 @@ STEXI @findex info migrate_cache_size Show current migration xbzrle cache size. ETEXI +SRST + ``info migrate_cache_size`` + Show current migration xbzrle cache size. +ERST { .name = "balloon", @@ -623,6 +804,10 @@ STEXI @findex info balloon Show balloon information. ETEXI +SRST + ``info balloon`` + Show balloon information. +ERST { .name = "qtree", @@ -637,6 +822,10 @@ STEXI @findex info qtree Show device tree. ETEXI +SRST + ``info qtree`` + Show device tree. +ERST { .name = "qdm", @@ -651,6 +840,10 @@ STEXI @findex info qdm Show qdev device model list. ETEXI +SRST + ``info qdm`` + Show qdev device model list. +ERST { .name = "qom-tree", @@ -666,6 +859,10 @@ STEXI @findex info qom-tree Show QOM composition tree. ETEXI +SRST + ``info qom-tree`` + Show QOM composition tree. +ERST { .name = "roms", @@ -680,6 +877,10 @@ STEXI @findex info roms Show roms. ETEXI +SRST + ``info roms`` + Show roms. +ERST { .name = "trace-events", @@ -696,6 +897,10 @@ STEXI @findex info trace-events Show available trace-events & their state. ETEXI +SRST + ``info trace-events`` + Show available trace-events & their state. +ERST { .name = "tpm", @@ -710,6 +915,10 @@ STEXI @findex info tpm Show the TPM device. ETEXI +SRST + ``info tpm`` + Show the TPM device. +ERST { .name = "memdev", @@ -725,6 +934,10 @@ STEXI @findex info memdev Show memory backends ETEXI +SRST + ``info memdev`` + Show memory backends +ERST { .name = "memory-devices", @@ -739,6 +952,10 @@ STEXI @findex info memory-devices Show memory devices. ETEXI +SRST + ``info memory-devices`` + Show memory devices. +ERST { .name = "iothreads", @@ -754,6 +971,10 @@ STEXI @findex info iothreads Show iothread's identifiers. ETEXI +SRST + ``info iothreads`` + Show iothread's identifiers. +ERST { .name = "rocker", @@ -768,6 +989,10 @@ STEXI @findex info rocker Show rocker switch. ETEXI +SRST + ``info rocker`` *name* + Show rocker switch. +ERST { .name = "rocker-ports", @@ -782,6 +1007,10 @@ STEXI @findex info rocker-ports Show rocker ports. ETEXI +SRST + ``info rocker-ports`` *name*-ports + Show rocker ports. +ERST { .name = "rocker-of-dpa-flows", @@ -796,6 +1025,10 @@ STEXI @findex info rocker-of-dpa-flows Show rocker OF-DPA flow tables. ETEXI +SRST + ``info rocker-of-dpa-flows`` *name* [*tbl_id*] + Show rocker OF-DPA flow tables. +ERST { .name = "rocker-of-dpa-groups", @@ -810,6 +1043,10 @@ STEXI @findex info rocker-of-dpa-groups Show rocker OF-DPA groups. ETEXI +SRST + ``info rocker-of-dpa-groups`` *name* [*type*] + Show rocker OF-DPA groups. +ERST #if defined(TARGET_S390X) { @@ -826,6 +1063,10 @@ STEXI @findex info skeys Display the value of a storage key (s390 only) ETEXI +SRST + ``info skeys`` *address* + Display the value of a storage key (s390 only) +ERST #if defined(TARGET_S390X) { @@ -842,6 +1083,11 @@ STEXI @findex info cmma Display the values of the CMMA storage attributes for a range of pages (s390 only) ETEXI +SRST + ``info cmma`` *address* + Display the values of the CMMA storage attributes for a range of + pages (s390 only) +ERST { .name = "dump", @@ -856,6 +1102,10 @@ STEXI @findex info dump Display the latest dump status. ETEXI +SRST + ``info dump`` + Display the latest dump status. +ERST { .name = "ramblock", @@ -870,6 +1120,10 @@ STEXI @findex info ramblock Dump all the ramblocks of the system. ETEXI +SRST + ``info ramblock`` + Dump all the ramblocks of the system. +ERST { .name = "hotpluggable-cpus", @@ -885,6 +1139,10 @@ STEXI @findex info hotpluggable-cpus Show information about hotpluggable CPUs ETEXI +SRST + ``info hotpluggable-cpus`` + Show information about hotpluggable CPUs +ERST { .name = "vm-generation-id", @@ -899,6 +1157,10 @@ STEXI @findex info vm-generation-id Show Virtual Machine Generation ID ETEXI +SRST + ``info vm-generation-id`` + Show Virtual Machine Generation ID +ERST { .name = "memory_size_summary", @@ -915,6 +1177,11 @@ STEXI Display the amount of initially allocated and present hotpluggable (if enabled) memory in bytes. ETEXI +SRST + ``info memory_size_summary`` + Display the amount of initially allocated and present hotpluggable (if + enabled) memory in bytes. +ERST #if defined(TARGET_I386) { @@ -931,6 +1198,10 @@ STEXI @findex info sev Show SEV information. ETEXI +SRST + ``info sev`` + Show SEV information. +ERST STEXI @end table -- cgit v1.2.3-55-g7522 From 44d79a6bd74b1e98394f456957f3c919c44cf4aa Mon Sep 17 00:00:00 2001 From: Peter Maydell Date: Fri, 28 Feb 2020 15:36:09 +0000 Subject: docs: Roll semihosting option information into qemu-options.hx Currently the per-target documentation for those targets that implement semihosting includes a bit of text that goes into both the manual and the manpage about options specific to the target. This text is redundant with the earlier generic option description of the semihosting option produced from qemu-options.hx. To avoid having to create a lot of stub include files to include into the rST generated qemu.1 manpage, roll target-specific bits of information into the qemu-options.hx text, so the user doesn't have to look in two places for this information. Signed-off-by: Peter Maydell Reviewed-by: Alex Bennée Tested-by: Alex Bennée Message-id: 20200228153619.9906-24-peter.maydell@linaro.org --- docs/system/target-arm.rst | 10 ---------- docs/system/target-arm.texi | 18 ------------------ docs/system/target-m68k.rst | 11 ----------- docs/system/target-m68k.texi | 19 ------------------- docs/system/target-xtensa.rst | 12 ------------ docs/system/target-xtensa.texi | 20 -------------------- qemu-options.hx | 18 ++++++++++++++++++ 7 files changed, 18 insertions(+), 90 deletions(-) (limited to 'docs/system') diff --git a/docs/system/target-arm.rst b/docs/system/target-arm.rst index 0490be5587..d2a3b44ce8 100644 --- a/docs/system/target-arm.rst +++ b/docs/system/target-arm.rst @@ -215,13 +215,3 @@ emulation includes the following elements: A Linux 2.6 test image is available on the QEMU web site. More information is available in the QEMU mailing-list archive. - -The following options are specific to the ARM emulation: - -``-semihosting`` - Enable semihosting syscall emulation. - - On ARM this implements the \"Angel\" interface. - - Note that this allows guest direct access to the host filesystem, so - should only be used with trusted guest OS. diff --git a/docs/system/target-arm.texi b/docs/system/target-arm.texi index c56b5f6ebf..eb80dd35f0 100644 --- a/docs/system/target-arm.texi +++ b/docs/system/target-arm.texi @@ -243,21 +243,3 @@ Three on-chip UARTs A Linux 2.6 test image is available on the QEMU web site. More information is available in the QEMU mailing-list archive. -@c man begin OPTIONS - -The following options are specific to the ARM emulation: - -@table @option - -@item -semihosting -Enable semihosting syscall emulation. - -On ARM this implements the "Angel" interface. - -Note that this allows guest direct access to the host filesystem, -so should only be used with trusted guest OS. - -@end table - -@c man end - diff --git a/docs/system/target-m68k.rst b/docs/system/target-m68k.rst index 50b7dd9d63..d28d3b92e5 100644 --- a/docs/system/target-m68k.rst +++ b/docs/system/target-m68k.rst @@ -19,14 +19,3 @@ The AN5206 emulation includes the following devices: - MCF5206 ColdFire V2 Microprocessor. - Two on-chip UARTs. - -The following options are specific to the ColdFire emulation: - -``-semihosting`` - Enable semihosting syscall emulation. - - On M68K this implements the \"ColdFire GDB\" interface used by - libgloss. - - Note that this allows guest direct access to the host filesystem, so - should only be used with trusted guest OS. diff --git a/docs/system/target-m68k.texi b/docs/system/target-m68k.texi index a77b19ea0f..dcce7bc8c5 100644 --- a/docs/system/target-m68k.texi +++ b/docs/system/target-m68k.texi @@ -23,22 +23,3 @@ MCF5206 ColdFire V2 Microprocessor. @item Two on-chip UARTs. @end itemize - -@c man begin OPTIONS - -The following options are specific to the ColdFire emulation: - -@table @option - -@item -semihosting -Enable semihosting syscall emulation. - -On M68K this implements the "ColdFire GDB" interface used by libgloss. - -Note that this allows guest direct access to the host filesystem, -so should only be used with trusted guest OS. - -@end table - -@c man end - diff --git a/docs/system/target-xtensa.rst b/docs/system/target-xtensa.rst index 43cab8dc4d..8d703ad769 100644 --- a/docs/system/target-xtensa.rst +++ b/docs/system/target-xtensa.rst @@ -25,15 +25,3 @@ The Avnet LX60/LX110/LX200 emulation supports: - 16550 UART - OpenCores 10/100 Mbps Ethernet MAC - -The following options are specific to the Xtensa emulation: - -``-semihosting`` - Enable semihosting syscall emulation. - - Xtensa semihosting provides basic file IO calls, such as - open/read/write/seek/select. Tensilica baremetal libc for ISS and - linux platform \"sim\" use this interface. - - Note that this allows guest direct access to the host filesystem, so - should only be used with trusted guest OS. diff --git a/docs/system/target-xtensa.texi b/docs/system/target-xtensa.texi index 40327de6fa..1e6c04dccd 100644 --- a/docs/system/target-xtensa.texi +++ b/docs/system/target-xtensa.texi @@ -33,23 +33,3 @@ A range of Xtensa CPUs, default is the DC232B @item OpenCores 10/100 Mbps Ethernet MAC @end itemize - -@c man begin OPTIONS - -The following options are specific to the Xtensa emulation: - -@table @option - -@item -semihosting -Enable semihosting syscall emulation. - -Xtensa semihosting provides basic file IO calls, such as open/read/write/seek/select. -Tensilica baremetal libc for ISS and linux platform "sim" use this interface. - -Note that this allows guest direct access to the host filesystem, -so should only be used with trusted guest OS. - -@end table - -@c man end - diff --git a/qemu-options.hx b/qemu-options.hx index 5a4ac8e239..753bfce411 100644 --- a/qemu-options.hx +++ b/qemu-options.hx @@ -4116,6 +4116,12 @@ STEXI @item -semihosting @findex -semihosting Enable semihosting mode (ARM, M68K, Xtensa, MIPS, Nios II only). + +Note that this allows guest direct access to the host filesystem, so +should only be used with a trusted guest OS. + +See the -semihosting-config option documentation for further information +about the facilities this enables. ETEXI DEF("semihosting-config", HAS_ARG, QEMU_OPTION_semihosting_config, "-semihosting-config [enable=on|off][,target=native|gdb|auto][,chardev=id][,arg=str[,...]]\n" \ @@ -4126,6 +4132,18 @@ STEXI @item -semihosting-config [enable=on|off][,target=native|gdb|auto][,chardev=id][,arg=str[,...]] @findex -semihosting-config Enable and configure semihosting (ARM, M68K, Xtensa, MIPS, Nios II only). + +Note that this allows guest direct access to the host filesystem, so +should only be used with a trusted guest OS. + +On Arm this implements the standard semihosting API, version 2.0. + +On M68K this implements the "ColdFire GDB" interface used by libgloss. + +Xtensa semihosting provides basic file IO calls, such as +open/read/write/seek/select. Tensilica baremetal libc for ISS and +linux platform "sim" use this interface. + @table @option @item target=@code{native|gdb|auto} Defines where the semihosting calls will be addressed, to QEMU (@code{native}) -- cgit v1.2.3-55-g7522 From 196afbb0949daf41c3742b5f1ac2173bb51a684e Mon Sep 17 00:00:00 2001 From: Peter Maydell Date: Fri, 28 Feb 2020 15:36:10 +0000 Subject: docs: Roll -prom-env and -g target-specific info into qemu-options.hx The SPARC and PPC targets currently have a fragment of target-specific information about the -g and -prom options which would be better placed as part of the general documentation of those options in qemu-options.hx. Move the relevant information to those locations. SPARC also has a bit of text about the -M option which is out of date and provides no useful information over the generic documentation of that option, so just delete it. The motivation here is again to avoid having to awkwardly include this text into the rST version of the qemu.1 manpage. Signed-off-by: Peter Maydell Reviewed-by: Alex Bennée Tested-by: Alex Bennée Message-id: 20200228153619.9906-25-peter.maydell@linaro.org --- docs/system/target-ppc.rst | 14 -------------- docs/system/target-ppc.texi | 25 ------------------------- docs/system/target-sparc.rst | 19 ------------------- docs/system/target-sparc.texi | 27 --------------------------- docs/system/target-sparc64.rst | 12 ------------ docs/system/target-sparc64.texi | 22 ---------------------- qemu-options.hx | 19 +++++++++++++++++++ 7 files changed, 19 insertions(+), 119 deletions(-) (limited to 'docs/system') diff --git a/docs/system/target-ppc.rst b/docs/system/target-ppc.rst index 43fadf3c00..a2f04c533c 100644 --- a/docs/system/target-ppc.rst +++ b/docs/system/target-ppc.rst @@ -43,19 +43,5 @@ the g3beige and mac99 PowerMac and the 40p machines. OpenBIOS is a free (GPL v2) portable firmware implementation. The goal is to implement a 100% IEEE 1275-1994 (referred to as Open Firmware) compliant firmware. -The following options are specific to the PowerPC emulation: - -``-g WxH[xDEPTH]`` - Set the initial VGA graphic mode. The default is 800x600x32. - -``-prom-env string`` - Set OpenBIOS variables in NVRAM, for example: - - :: - - qemu-system-ppc -prom-env 'auto-boot?=false' \ - -prom-env 'boot-device=hd:2,\yaboot' \ - -prom-env 'boot-args=conf=hd:2,\yaboot.conf' - More information is available at http://perso.magic.fr/l_indien/qemu-ppc/. diff --git a/docs/system/target-ppc.texi b/docs/system/target-ppc.texi index 55f98f65b1..5c83d4f68e 100644 --- a/docs/system/target-ppc.texi +++ b/docs/system/target-ppc.texi @@ -47,31 +47,6 @@ for the g3beige and mac99 PowerMac and the 40p machines. OpenBIOS is a free (GPL v2) portable firmware implementation. The goal is to implement a 100% IEEE 1275-1994 (referred to as Open Firmware) compliant firmware. -@c man begin OPTIONS - -The following options are specific to the PowerPC emulation: - -@table @option - -@item -g @var{W}x@var{H}[x@var{DEPTH}] - -Set the initial VGA graphic mode. The default is 800x600x32. - -@item -prom-env @var{string} - -Set OpenBIOS variables in NVRAM, for example: - -@example -qemu-system-ppc -prom-env 'auto-boot?=false' \ - -prom-env 'boot-device=hd:2,\yaboot' \ - -prom-env 'boot-args=conf=hd:2,\yaboot.conf' -@end example - -@end table - -@c man end - - More information is available at @url{http://perso.magic.fr/l_indien/qemu-ppc/}. diff --git a/docs/system/target-sparc.rst b/docs/system/target-sparc.rst index 589c88d175..b55f8d09e9 100644 --- a/docs/system/target-sparc.rst +++ b/docs/system/target-sparc.rst @@ -60,22 +60,3 @@ QEMU web site. There are still issues with NetBSD and OpenBSD, but most kernel versions work. Please note that currently older Solaris kernels don't work probably due to interface issues between OpenBIOS and Solaris. - -The following options are specific to the Sparc32 emulation: - -``-g WxHx[xDEPTH]`` - Set the initial graphics mode. For TCX, the default is 1024x768x8 - with the option of 1024x768x24. For cgthree, the default is - 1024x768x8 with the option of 1152x900x8 for people who wish to use - OBP. - -``-prom-env string`` - Set OpenBIOS variables in NVRAM, for example: - - :: - - qemu-system-sparc -prom-env 'auto-boot?=false' \ - -prom-env 'boot-device=sd(0,2,0):d' -prom-env 'boot-args=linux single' - -``-M [SS-4|SS-5|SS-10|SS-20|SS-600MP|LX|Voyager|SPARCClassic] [|SPARCbook]`` - Set the emulated machine type. Default is SS-5. diff --git a/docs/system/target-sparc.texi b/docs/system/target-sparc.texi index 7748001f73..99fbf820b4 100644 --- a/docs/system/target-sparc.texi +++ b/docs/system/target-sparc.texi @@ -64,32 +64,5 @@ most kernel versions work. Please note that currently older Solaris kernels don't work probably due to interface issues between OpenBIOS and Solaris. -@c man begin OPTIONS - -The following options are specific to the Sparc32 emulation: - -@table @option - -@item -g @var{W}x@var{H}x[x@var{DEPTH}] - -Set the initial graphics mode. For TCX, the default is 1024x768x8 with the -option of 1024x768x24. For cgthree, the default is 1024x768x8 with the option -of 1152x900x8 for people who wish to use OBP. - -@item -prom-env @var{string} - -Set OpenBIOS variables in NVRAM, for example: - -@example -qemu-system-sparc -prom-env 'auto-boot?=false' \ - -prom-env 'boot-device=sd(0,2,0):d' -prom-env 'boot-args=linux single' -@end example - -@item -M [SS-4|SS-5|SS-10|SS-20|SS-600MP|LX|Voyager|SPARCClassic] [|SPARCbook] - -Set the emulated machine type. Default is SS-5. - -@end table - @c man end diff --git a/docs/system/target-sparc64.rst b/docs/system/target-sparc64.rst index ca76ba9c48..97e334b930 100644 --- a/docs/system/target-sparc64.rst +++ b/docs/system/target-sparc64.rst @@ -35,15 +35,3 @@ QEMU emulates the following peripherals: - 2 PCI IDE interfaces with hard disk and CD-ROM support - Floppy disk - -The following options are specific to the Sparc64 emulation: - -``-prom-env string`` - Set OpenBIOS variables in NVRAM, for example: - - :: - - qemu-system-sparc64 -prom-env 'auto-boot?=false' - -``-M [sun4u|sun4v|niagara]`` - Set the emulated machine type. The default is sun4u. diff --git a/docs/system/target-sparc64.texi b/docs/system/target-sparc64.texi index 4db4ca3842..d381d3af71 100644 --- a/docs/system/target-sparc64.texi +++ b/docs/system/target-sparc64.texi @@ -36,25 +36,3 @@ PC-compatible serial ports Floppy disk @end itemize -@c man begin OPTIONS - -The following options are specific to the Sparc64 emulation: - -@table @option - -@item -prom-env @var{string} - -Set OpenBIOS variables in NVRAM, for example: - -@example -qemu-system-sparc64 -prom-env 'auto-boot?=false' -@end example - -@item -M [sun4u|sun4v|niagara] - -Set the emulated machine type. The default is sun4u. - -@end table - -@c man end - diff --git a/qemu-options.hx b/qemu-options.hx index 753bfce411..4436690971 100644 --- a/qemu-options.hx +++ b/qemu-options.hx @@ -1962,6 +1962,13 @@ STEXI @item -g @var{width}x@var{height}[x@var{depth}] @findex -g Set the initial graphical resolution and depth (PPC, SPARC only). + +For PPC the default is 800x600x32. + +For SPARC with the TCX graphics device, the default is 1024x768x8 with the +option of 1024x768x24. For cgthree, the default is 1024x768x8 with the option +of 1152x900x8 for people who wish to use OBP. + ETEXI DEF("vnc", HAS_ARG, QEMU_OPTION_vnc , @@ -4107,6 +4114,18 @@ STEXI @item -prom-env @var{variable}=@var{value} @findex -prom-env Set OpenBIOS nvram @var{variable} to given @var{value} (PPC, SPARC only). + +@example +qemu-system-sparc -prom-env 'auto-boot?=false' \ + -prom-env 'boot-device=sd(0,2,0):d' -prom-env 'boot-args=linux single' +@end example + +@example +qemu-system-ppc -prom-env 'auto-boot?=false' \ + -prom-env 'boot-device=hd:2,\yaboot' \ + -prom-env 'boot-args=conf=hd:2,\yaboot.conf' +@end example + ETEXI DEF("semihosting", 0, QEMU_OPTION_semihosting, "-semihosting semihosting mode\n", -- cgit v1.2.3-55-g7522 From 09ce5f2d6bd6739144a9bcebd71115fb825371e6 Mon Sep 17 00:00:00 2001 From: Peter Maydell Date: Fri, 28 Feb 2020 15:36:13 +0000 Subject: qemu-options.hx: Fix up the autogenerated rST This commit contains hand-written fixes for some issues with the autogenerated rST fragments in qemu-options.hx: * Sphinx complains about the UTF-8 art table in the documentation of the -drive option. Replace it with a proper rST format table. * rST does not like definition list entries with no actual definition, but it is possible to work around this by putting a single escaped literal space as the definition line. * The "-g widthxheight" option documentation suffers particularly badly from losing the distinction between italics and fixed-width as a result of the auto conversion, so put it back in again. * The script missed some places that use the |qemu_system| etc macros and need to be marked up as parsed-literal blocks. * The script autogenerated an expanded out version of the contents of qemu-option-trace.texi; replace it with an qemu-option-trace.rst.inc include. This is sufficient that we can enable inclusion of the option documentation from invocation.rst. Signed-off-by: Peter Maydell Reviewed-by: Alex Bennée Tested-by: Alex Bennée Message-id: 20200228153619.9906-28-peter.maydell@linaro.org --- Makefile | 2 +- docs/system/invocation.rst | 2 + qemu-options.hx | 143 +++++++++++++++++++++++++-------------------- 3 files changed, 84 insertions(+), 63 deletions(-) (limited to 'docs/system') diff --git a/Makefile b/Makefile index 98ef06ab8e..f7d08997db 100644 --- a/Makefile +++ b/Makefile @@ -1071,7 +1071,7 @@ $(MANUAL_BUILDDIR)/interop/index.html: $(call manual-deps,interop) $(MANUAL_BUILDDIR)/specs/index.html: $(call manual-deps,specs) $(call build-manual,specs,html) -$(MANUAL_BUILDDIR)/system/index.html: $(call manual-deps,system) $(SRC_PATH)/hmp-commands.hx $(SRC_PATH)/hmp-commands-info.hx +$(MANUAL_BUILDDIR)/system/index.html: $(call manual-deps,system) $(SRC_PATH)/hmp-commands.hx $(SRC_PATH)/hmp-commands-info.hx $(SRC_PATH)/qemu-options.hx $(call build-manual,system,html) $(MANUAL_BUILDDIR)/tools/index.html: $(call manual-deps,tools) $(SRC_PATH)/qemu-img-cmds.hx $(SRC_PATH)/docs/qemu-option-trace.rst.inc diff --git a/docs/system/invocation.rst b/docs/system/invocation.rst index c112bcb45a..d77dd13d4f 100644 --- a/docs/system/invocation.rst +++ b/docs/system/invocation.rst @@ -10,6 +10,8 @@ Invocation disk_image is a raw hard disk image for IDE hard disk 0. Some targets do not need a disk image. +.. hxtool-doc:: qemu-options.hx + Device URL Syntax ~~~~~~~~~~~~~~~~~ diff --git a/qemu-options.hx b/qemu-options.hx index 37b5c75cf2..62b7f3b38a 100644 --- a/qemu-options.hx +++ b/qemu-options.hx @@ -448,7 +448,17 @@ cache, size is 10KB, policy is write-back, the cache Line size is 8 bytes: ETEXI SRST -``-numa node[,mem=size][,cpus=firstcpu[-lastcpu]][,nodeid=node][,initiator=initiator]``; \ ``-numa node[,memdev=id][,cpus=firstcpu[-lastcpu]][,nodeid=node][,initiator=initiator]``; \ ``-numa dist,src=source,dst=destination,val=distance``; \ ``-numa cpu,node-id=node[,socket-id=x][,core-id=y][,thread-id=z]``; \ ``-numa hmat-lb,initiator=node,target=node,hierarchy=hierarchy,data-type=tpye[,latency=lat][,bandwidth=bw]``; \ ``-numa hmat-cache,node-id=node,size=size,level=level[,associativity=str][,policy=str][,line=size]`` +``-numa node[,mem=size][,cpus=firstcpu[-lastcpu]][,nodeid=node][,initiator=initiator]`` + \ +``-numa node[,memdev=id][,cpus=firstcpu[-lastcpu]][,nodeid=node][,initiator=initiator]`` + \ +``-numa dist,src=source,dst=destination,val=distance`` + \ +``-numa cpu,node-id=node[,socket-id=x][,core-id=y][,thread-id=z]`` + \ +``-numa hmat-lb,initiator=node,target=node,hierarchy=hierarchy,data-type=tpye[,latency=lat][,bandwidth=bw]`` + \ +``-numa hmat-cache,node-id=node,size=size,level=level[,associativity=str][,policy=str][,line=size]`` Define a NUMA node and assign RAM and VCPUs to it. Set the NUMA distance from a source node to a destination node. Set the ACPI Heterogeneous Memory Attributes for the given nodes. @@ -687,7 +697,9 @@ driver=@var{driver},property=@var{prop},value=@var{value}. The longhand syntax works even when @var{driver} contains a dot. ETEXI SRST -``-global driver.prop=value``; \ ``-global driver=driver,property=property,value=value`` +``-global driver.prop=value`` + \ +``-global driver=driver,property=property,value=value`` Set default value of driver's property prop to value, e.g.: .. parsed-literal:: @@ -788,7 +800,7 @@ SRST it. This only effects when boot priority is changed by bootindex options. The default is non-strict boot. - :: + .. parsed-literal:: # try to boot from network first, then from hard disk |qemu_system_x86| -boot order=nc @@ -1618,7 +1630,9 @@ STEXI Use @var{file} as floppy disk 0/1 image (@pxref{disk_images}). ETEXI SRST -``-fda file``; \ ``-fdb file`` +``-fda file`` + \ +``-fdb file`` Use file as floppy disk 0/1 image (see :ref:`disk_005fimages`). ERST @@ -1641,7 +1655,13 @@ STEXI Use @var{file} as hard disk 0, 1, 2 or 3 image (@pxref{disk_images}). ETEXI SRST -``-hda file``; \ ``-hdb file``; \ ``-hdc file``; \ ``-hdd file`` +``-hda file`` + \ +``-hdb file`` + \ +``-hdc file`` + \ +``-hdd file`` Use file as hard disk 0, 1, 2 or 3 image (see :ref:`disk_005fimages`). ERST @@ -2295,15 +2315,15 @@ SRST the ``write-cache`` option of block guest devices (as in ``-device``). The modes correspond to the following settings: - :: - -   │ cache.writeback cache.direct cache.no-flush - ─────────────┼───────────────────────────────────────────────── - writeback │ on off off - none │ on on off - writethrough │ off off off - directsync │ off on off - unsafe │ on off on + ============= =============== ============ ============== + \ cache.writeback cache.direct cache.no-flush + ============= =============== ============ ============== + writeback on off off + none on on off + writethrough off off off + directsync off on off + unsafe on off on + ============= =============== ============ ============== The default mode is ``cache=writeback``. @@ -2594,7 +2614,13 @@ Specifies the tag name to be used by the guest to mount this export point. ETEXI SRST -``-fsdev local,id=id,path=path,security_model=security_model [,writeout=writeout][,readonly][,fmode=fmode][,dmode=dmode] [,throttling.option=value[,throttling.option=value[,...]]]``; \ ``-fsdev proxy,id=id,socket=socket[,writeout=writeout][,readonly]``; \ ``-fsdev proxy,id=id,sock_fd=sock_fd[,writeout=writeout][,readonly]``; \ ``-fsdev synth,id=id[,readonly]`` +``-fsdev local,id=id,path=path,security_model=security_model [,writeout=writeout][,readonly][,fmode=fmode][,dmode=dmode] [,throttling.option=value[,throttling.option=value[,...]]]`` + \ +``-fsdev proxy,id=id,socket=socket[,writeout=writeout][,readonly]`` + \ +``-fsdev proxy,id=id,sock_fd=sock_fd[,writeout=writeout][,readonly]`` + \ +``-fsdev synth,id=id[,readonly]`` Define a new file system device. Valid options are: ``local`` @@ -2791,7 +2817,13 @@ would still return entries from other devices). @end table ETEXI SRST -``-virtfs local,path=path,mount_tag=mount_tag ,security_model=security_model[,writeout=writeout][,readonly] [,fmode=fmode][,dmode=dmode][,multidevs=multidevs]``; \ ``-virtfs proxy,socket=socket,mount_tag=mount_tag [,writeout=writeout][,readonly]``; \ ``-virtfs proxy,sock_fd=sock_fd,mount_tag=mount_tag [,writeout=writeout][,readonly]``; \ ``-virtfs synth,mount_tag=mount_tag`` +``-virtfs local,path=path,mount_tag=mount_tag ,security_model=security_model[,writeout=writeout][,readonly] [,fmode=fmode][,dmode=dmode][,multidevs=multidevs]`` + \ +``-virtfs proxy,socket=socket,mount_tag=mount_tag [,writeout=writeout][,readonly]`` + \ +``-virtfs proxy,sock_fd=sock_fd,mount_tag=mount_tag [,writeout=writeout][,readonly]`` + \ +``-virtfs synth,mount_tag=mount_tag`` Define a new filesystem device and expose it to the guest using a virtio-9p-device. The general form of a Virtual File system pass-through options are: @@ -3568,7 +3600,7 @@ of 1152x900x8 for people who wish to use OBP. ETEXI SRST -``-g widthxheight[xdepth]`` +``-g`` *width*\ ``x``\ *height*\ ``[x``\ *depth*\ ``]`` Set the initial graphical resolution and depth (PPC, SPARC only). For PPC the default is 800x600x32. @@ -4847,7 +4879,7 @@ SRST For example, to redirect host X11 connection from screen 1 to guest screen 0, use the following: - :: + .. parsed-literal:: # on the host |qemu_system| -nic user,hostfwd=tcp:127.0.0.1:6001-:6000 @@ -4857,7 +4889,7 @@ SRST To redirect telnet connections from host port 5555 to telnet port on the guest, use the following: - :: + .. parsed-literal:: # on the host |qemu_system| -nic user,hostfwd=tcp::5555-:23 @@ -4875,7 +4907,7 @@ SRST You can either use a chardev directly and have that one used throughout QEMU's lifetime, like in the following example: - :: + .. parsed-literal:: # open 10.10.1.1:4321 on bootup, connect 10.0.2.100:1234 to it whenever # the guest accesses it @@ -4885,7 +4917,7 @@ SRST by the guest, so that QEMU behaves similar to an inetd process for that virtual server: - :: + .. parsed-literal:: # call "netcat 10.10.1.1 4321" on every TCP connection to 10.0.2.100:1234 # and connect the TCP stream to its stdin/stdout @@ -4912,12 +4944,12 @@ SRST Examples: - :: + .. parsed-literal:: #launch a QEMU instance with the default network script |qemu_system| linux.img -nic tap - :: + .. parsed-literal:: #launch a QEMU instance with two NICs, each one connected #to a TAP device @@ -4925,7 +4957,7 @@ SRST -netdev tap,id=nd0,ifname=tap0 -device e1000,netdev=nd0 \ -netdev tap,id=nd1,ifname=tap1 -device rtl8139,netdev=nd1 - :: + .. parsed-literal:: #launch a QEMU instance with the default network helper to #connect a TAP device to bridge br0 @@ -4942,13 +4974,13 @@ SRST Examples: - :: + .. parsed-literal:: #launch a QEMU instance with the default network helper to #connect a TAP device to bridge br0 |qemu_system| linux.img -netdev bridge,id=n1 -device virtio-net,netdev=n1 - :: + .. parsed-literal:: #launch a QEMU instance with the default network helper to #connect a TAP device to bridge qemubr0 @@ -4964,7 +4996,7 @@ SRST Example: - :: + .. parsed-literal:: # launch a first QEMU instance |qemu_system| linux.img \ @@ -4991,7 +5023,7 @@ SRST Example: - :: + .. parsed-literal:: # launch one QEMU instance |qemu_system| linux.img \ @@ -5008,7 +5040,7 @@ SRST Example (User Mode Linux compat.): - :: + .. parsed-literal:: # launch QEMU instance (note mcast address selected is UML's default) |qemu_system| linux.img \ @@ -5074,7 +5106,7 @@ SRST For example, to attach a VM running on host 4.3.2.1 via L2TPv3 to the bridge br-lan on the remote Linux host 1.2.3.4: - :: + .. parsed-literal:: # Setup tunnel on linux host using raw ip as encapsulation # on 1.2.3.4 @@ -5102,7 +5134,7 @@ SRST Example: - :: + .. parsed-literal:: # launch vde switch vde_switch -F -sock /tmp/myswitch @@ -5731,7 +5763,9 @@ The available backends are: ``path`` specifies the path to the tty. ``path`` is required. -``-chardev parallel,id=id,path=path``; \ ``-chardev parport,id=id,path=path`` +``-chardev parallel,id=id,path=path`` + \ +``-chardev parport,id=id,path=path`` ``parallel`` is only available on Linux, FreeBSD and DragonFlyBSD hosts. @@ -6569,6 +6603,7 @@ utilization will be incorrect, not taking into account guest idle time. ETEXI SRST ``-overcommit mem-lock=on|off`` + \ ``-overcommit cpu-pm=on|off`` Run qemu with hints about host resource overcommit. The default is to assume that host overcommits all resources. @@ -6607,7 +6642,7 @@ SRST use case. The latter is allowing to start QEMU from within gdb and establish the connection via a pipe: - :: + .. parsed-literal:: (gdb) target remote | exec |qemu_system| -gdb stdio ... ERST @@ -7196,7 +7231,9 @@ be used to change settings (such as migration parameters) prior to issuing the migrate_incoming to allow the migration to begin. ETEXI SRST -``-incoming tcp:[host]:port[,to=maxport][,ipv4][,ipv6]``; \ ``-incoming rdma:host:port[,ipv4][,ipv6]`` +``-incoming tcp:[host]:port[,to=maxport][,ipv4][,ipv6]`` + \ +``-incoming rdma:host:port[,ipv4][,ipv6]`` Prepare for incoming migration, listen on a given tcp port. ``-incoming unix:socketpath`` @@ -7537,27 +7574,8 @@ HXCOMM HX does not support conditional compilation of text. ETEXI SRST ``-trace [[enable=]pattern][,events=file][,file=file]`` - Specify tracing options. + .. include:: ../qemu-option-trace.rst.inc - ``[enable=]pattern`` - Immediately enable events matching pattern (either event name or - a globbing pattern). This option is only available if QEMU has - been compiled with the simple, log or ftrace tracing backend. To - specify multiple events or patterns, specify the ``-trace`` - option multiple times. - - Use ``-trace help`` to print a list of names of trace points. - - ``events=file`` - Immediately enable events listed in file. The file must contain - one event name (as listed in the ``trace-events-all`` file) per - line; globbing patterns are accepted too. This option is only - available if QEMU has been compiled with the simple, log or - ftrace tracing backend. - - ``file=file`` - Log output traces to file. This option is only available if QEMU - has been compiled with the simple tracing backend. ERST DEF("plugin", HAS_ARG, QEMU_OPTION_plugin, "-plugin [file=][,arg=]\n" @@ -8749,7 +8767,7 @@ SRST which specify the queue number of cryptodev backend, the default of queues is 1. - :: + .. parsed-literal:: # |qemu_system| \ [...] \ @@ -8768,7 +8786,7 @@ SRST specify the queue number of cryptodev backend for multiqueue vhost-user, the default of queues is 1. - :: + .. parsed-literal:: # |qemu_system| \ [...] \ @@ -8778,6 +8796,7 @@ SRST [...] ``-object secret,id=id,data=string,format=raw|base64[,keyid=secretid,iv=string]`` + \ ``-object secret,id=id,file=filename,format=raw|base64[,keyid=secretid,iv=string]`` Defines a secret to store a password, encryption key, or some other sensitive data. The sensitive data can either be passed @@ -8805,7 +8824,7 @@ SRST The simplest (insecure) usage is to provide the secret inline - :: + .. parsed-literal:: # |qemu_system| -object secret,id=sec0,data=letmein,format=raw @@ -8849,7 +8868,7 @@ SRST ``key.b64`` and specify that to be used to decrypt the user password. Pass the contents of ``iv.b64`` to the second secret - :: + .. parsed-literal:: # |qemu_system| \ -object secret,id=secmaster0,format=base64,file=key.b64 \ @@ -8898,7 +8917,7 @@ SRST e.g to launch a SEV guest - :: + .. parsed-literal:: # |qemu_system_x86| \ ...... @@ -8919,7 +8938,7 @@ SRST An example authorization object to validate a x509 distinguished name would look like: - :: + .. parsed-literal:: # |qemu_system| \ ... @@ -8970,7 +8989,7 @@ SRST An example authorization object to validate a SASL username would look like: - :: + .. parsed-literal:: # |qemu_system| \ ... @@ -8989,7 +9008,7 @@ SRST An example authorization object to validate a TLS x509 distinguished name would look like: - :: + .. parsed-literal:: # |qemu_system| \ ... -- cgit v1.2.3-55-g7522 From bf87bef09197da1e25980438056f9494e1b7cb7d Mon Sep 17 00:00:00 2001 From: Peter Maydell Date: Fri, 28 Feb 2020 15:36:14 +0000 Subject: docs: Split out sections for the manpage into .rst.inc files Sphinx doesn't have very good facilities for marking chunks of documentation as "put this in the manpage only". So instead we move the parts we want to put into both the HTML manuals and the manpage into their own .rst.inc files, which we can include from both the main manual rst files and a new toplevel rst file that will be the skeleton of the qemu.1 manpage. In this commit, just split out the parts of the documentation that go in the manpage. Signed-off-by: Peter Maydell Reviewed-by: Alex Bennée Tested-by: Alex Bennée Message-id: 20200228153619.9906-29-peter.maydell@linaro.org --- docs/system/device-url-syntax.rst.inc | 228 ++++++++++++++++++++++++++++++++++ docs/system/invocation.rst | 228 +--------------------------------- docs/system/keys.rst | 36 +----- docs/system/keys.rst.inc | 35 ++++++ docs/system/mux-chardev.rst | 28 +---- docs/system/mux-chardev.rst.inc | 27 ++++ docs/system/target-i386-desc.rst.inc | 62 +++++++++ docs/system/target-i386.rst | 63 +--------- 8 files changed, 356 insertions(+), 351 deletions(-) create mode 100644 docs/system/device-url-syntax.rst.inc create mode 100644 docs/system/keys.rst.inc create mode 100644 docs/system/mux-chardev.rst.inc create mode 100644 docs/system/target-i386-desc.rst.inc (limited to 'docs/system') diff --git a/docs/system/device-url-syntax.rst.inc b/docs/system/device-url-syntax.rst.inc new file mode 100644 index 0000000000..88d7a372a7 --- /dev/null +++ b/docs/system/device-url-syntax.rst.inc @@ -0,0 +1,228 @@ + +In addition to using normal file images for the emulated storage +devices, QEMU can also use networked resources such as iSCSI devices. +These are specified using a special URL syntax. + +``iSCSI`` + iSCSI support allows QEMU to access iSCSI resources directly and use + as images for the guest storage. Both disk and cdrom images are + supported. + + Syntax for specifying iSCSI LUNs is + "iscsi://[:]//" + + By default qemu will use the iSCSI initiator-name + 'iqn.2008-11.org.linux-kvm[:]' but this can also be set from + the command line or a configuration file. + + Since version Qemu 2.4 it is possible to specify a iSCSI request + timeout to detect stalled requests and force a reestablishment of the + session. The timeout is specified in seconds. The default is 0 which + means no timeout. Libiscsi 1.15.0 or greater is required for this + feature. + + Example (without authentication): + + .. parsed-literal:: + + |qemu_system| -iscsi initiator-name=iqn.2001-04.com.example:my-initiator \ + -cdrom iscsi://192.0.2.1/iqn.2001-04.com.example/2 \ + -drive file=iscsi://192.0.2.1/iqn.2001-04.com.example/1 + + Example (CHAP username/password via URL): + + .. parsed-literal:: + + |qemu_system| -drive file=iscsi://user%password@192.0.2.1/iqn.2001-04.com.example/1 + + Example (CHAP username/password via environment variables): + + .. parsed-literal:: + + LIBISCSI_CHAP_USERNAME="user" \ + LIBISCSI_CHAP_PASSWORD="password" \ + |qemu_system| -drive file=iscsi://192.0.2.1/iqn.2001-04.com.example/1 + +``NBD`` + QEMU supports NBD (Network Block Devices) both using TCP protocol as + well as Unix Domain Sockets. With TCP, the default port is 10809. + + Syntax for specifying a NBD device using TCP, in preferred URI form: + "nbd://[:]/[]" + + Syntax for specifying a NBD device using Unix Domain Sockets; + remember that '?' is a shell glob character and may need quoting: + "nbd+unix:///[]?socket=" + + Older syntax that is also recognized: + "nbd::[:exportname=]" + + Syntax for specifying a NBD device using Unix Domain Sockets + "nbd:unix:[:exportname=]" + + Example for TCP + + .. parsed-literal:: + + |qemu_system| --drive file=nbd:192.0.2.1:30000 + + Example for Unix Domain Sockets + + .. parsed-literal:: + + |qemu_system| --drive file=nbd:unix:/tmp/nbd-socket + +``SSH`` + QEMU supports SSH (Secure Shell) access to remote disks. + + Examples: + + .. parsed-literal:: + + |qemu_system| -drive file=ssh://user@host/path/to/disk.img + |qemu_system| -drive file.driver=ssh,file.user=user,file.host=host,file.port=22,file.path=/path/to/disk.img + + Currently authentication must be done using ssh-agent. Other + authentication methods may be supported in future. + +``Sheepdog`` + Sheepdog is a distributed storage system for QEMU. QEMU supports + using either local sheepdog devices or remote networked devices. + + Syntax for specifying a sheepdog device + + :: + + sheepdog[+tcp|+unix]://[host:port]/vdiname[?socket=path][#snapid|#tag] + + Example + + .. parsed-literal:: + + |qemu_system| --drive file=sheepdog://192.0.2.1:30000/MyVirtualMachine + + See also https://sheepdog.github.io/sheepdog/. + +``GlusterFS`` + GlusterFS is a user space distributed file system. QEMU supports the + use of GlusterFS volumes for hosting VM disk images using TCP, Unix + Domain Sockets and RDMA transport protocols. + + Syntax for specifying a VM disk image on GlusterFS volume is + + .. parsed-literal:: + + URI: + gluster[+type]://[host[:port]]/volume/path[?socket=...][,debug=N][,logfile=...] + + JSON: + 'json:{"driver":"qcow2","file":{"driver":"gluster","volume":"testvol","path":"a.img","debug":N,"logfile":"...", +   "server":[{"type":"tcp","host":"...","port":"..."}, +   {"type":"unix","socket":"..."}]}}' + + Example + + .. parsed-literal:: + + URI: + |qemu_system| --drive file=gluster://192.0.2.1/testvol/a.img, +   file.debug=9,file.logfile=/var/log/qemu-gluster.log + + JSON: + |qemu_system| 'json:{"driver":"qcow2", +   "file":{"driver":"gluster", +   "volume":"testvol","path":"a.img", +   "debug":9,"logfile":"/var/log/qemu-gluster.log", +   "server":[{"type":"tcp","host":"1.2.3.4","port":24007}, +   {"type":"unix","socket":"/var/run/glusterd.socket"}]}}' + |qemu_system| -drive driver=qcow2,file.driver=gluster,file.volume=testvol,file.path=/path/a.img, +   file.debug=9,file.logfile=/var/log/qemu-gluster.log, +   file.server.0.type=tcp,file.server.0.host=1.2.3.4,file.server.0.port=24007, +   file.server.1.type=unix,file.server.1.socket=/var/run/glusterd.socket + + See also http://www.gluster.org. + +``HTTP/HTTPS/FTP/FTPS`` + QEMU supports read-only access to files accessed over http(s) and + ftp(s). + + Syntax using a single filename: + + :: + + ://[[:]@]/ + + where: + + ``protocol`` + 'http', 'https', 'ftp', or 'ftps'. + + ``username`` + Optional username for authentication to the remote server. + + ``password`` + Optional password for authentication to the remote server. + + ``host`` + Address of the remote server. + + ``path`` + Path on the remote server, including any query string. + + The following options are also supported: + + ``url`` + The full URL when passing options to the driver explicitly. + + ``readahead`` + The amount of data to read ahead with each range request to the + remote server. This value may optionally have the suffix 'T', 'G', + 'M', 'K', 'k' or 'b'. If it does not have a suffix, it will be + assumed to be in bytes. The value must be a multiple of 512 bytes. + It defaults to 256k. + + ``sslverify`` + Whether to verify the remote server's certificate when connecting + over SSL. It can have the value 'on' or 'off'. It defaults to + 'on'. + + ``cookie`` + Send this cookie (it can also be a list of cookies separated by + ';') with each outgoing request. Only supported when using + protocols such as HTTP which support cookies, otherwise ignored. + + ``timeout`` + Set the timeout in seconds of the CURL connection. This timeout is + the time that CURL waits for a response from the remote server to + get the size of the image to be downloaded. If not set, the + default timeout of 5 seconds is used. + + Note that when passing options to qemu explicitly, ``driver`` is the + value of . + + Example: boot from a remote Fedora 20 live ISO image + + .. parsed-literal:: + + |qemu_system_x86| --drive media=cdrom,file=https://archives.fedoraproject.org/pub/archive/fedora/linux/releases/20/Live/x86_64/Fedora-Live-Desktop-x86_64-20-1.iso,readonly + + |qemu_system_x86| --drive media=cdrom,file.driver=http,file.url=http://archives.fedoraproject.org/pub/fedora/linux/releases/20/Live/x86_64/Fedora-Live-Desktop-x86_64-20-1.iso,readonly + + Example: boot from a remote Fedora 20 cloud image using a local + overlay for writes, copy-on-read, and a readahead of 64k + + .. parsed-literal:: + + qemu-img create -f qcow2 -o backing_file='json:{"file.driver":"http",, "file.url":"http://archives.fedoraproject.org/pub/archive/fedora/linux/releases/20/Images/x86_64/Fedora-x86_64-20-20131211.1-sda.qcow2",, "file.readahead":"64k"}' /tmp/Fedora-x86_64-20-20131211.1-sda.qcow2 + + |qemu_system_x86| -drive file=/tmp/Fedora-x86_64-20-20131211.1-sda.qcow2,copy-on-read=on + + Example: boot from an image stored on a VMware vSphere server with a + self-signed certificate using a local overlay for writes, a readahead + of 64k and a timeout of 10 seconds. + + .. parsed-literal:: + + qemu-img create -f qcow2 -o backing_file='json:{"file.driver":"https",, "file.url":"https://user:password@vsphere.example.com/folder/test/test-flat.vmdk?dcPath=Datacenter&dsName=datastore1",, "file.sslverify":"off",, "file.readahead":"64k",, "file.timeout":10}' /tmp/test.qcow2 + + |qemu_system_x86| -drive file=/tmp/test.qcow2 diff --git a/docs/system/invocation.rst b/docs/system/invocation.rst index d77dd13d4f..4ba38fc23d 100644 --- a/docs/system/invocation.rst +++ b/docs/system/invocation.rst @@ -15,230 +15,4 @@ not need a disk image. Device URL Syntax ~~~~~~~~~~~~~~~~~ -In addition to using normal file images for the emulated storage -devices, QEMU can also use networked resources such as iSCSI devices. -These are specified using a special URL syntax. - -``iSCSI`` - iSCSI support allows QEMU to access iSCSI resources directly and use - as images for the guest storage. Both disk and cdrom images are - supported. - - Syntax for specifying iSCSI LUNs is - "iscsi://[:]//" - - By default qemu will use the iSCSI initiator-name - 'iqn.2008-11.org.linux-kvm[:]' but this can also be set from - the command line or a configuration file. - - Since version Qemu 2.4 it is possible to specify a iSCSI request - timeout to detect stalled requests and force a reestablishment of the - session. The timeout is specified in seconds. The default is 0 which - means no timeout. Libiscsi 1.15.0 or greater is required for this - feature. - - Example (without authentication): - - .. parsed-literal:: - - |qemu_system| -iscsi initiator-name=iqn.2001-04.com.example:my-initiator \ - -cdrom iscsi://192.0.2.1/iqn.2001-04.com.example/2 \ - -drive file=iscsi://192.0.2.1/iqn.2001-04.com.example/1 - - Example (CHAP username/password via URL): - - .. parsed-literal:: - - |qemu_system| -drive file=iscsi://user%password@192.0.2.1/iqn.2001-04.com.example/1 - - Example (CHAP username/password via environment variables): - - .. parsed-literal:: - - LIBISCSI_CHAP_USERNAME="user" \ - LIBISCSI_CHAP_PASSWORD="password" \ - |qemu_system| -drive file=iscsi://192.0.2.1/iqn.2001-04.com.example/1 - -``NBD`` - QEMU supports NBD (Network Block Devices) both using TCP protocol as - well as Unix Domain Sockets. With TCP, the default port is 10809. - - Syntax for specifying a NBD device using TCP, in preferred URI form: - "nbd://[:]/[]" - - Syntax for specifying a NBD device using Unix Domain Sockets; - remember that '?' is a shell glob character and may need quoting: - "nbd+unix:///[]?socket=" - - Older syntax that is also recognized: - "nbd::[:exportname=]" - - Syntax for specifying a NBD device using Unix Domain Sockets - "nbd:unix:[:exportname=]" - - Example for TCP - - .. parsed-literal:: - - |qemu_system| --drive file=nbd:192.0.2.1:30000 - - Example for Unix Domain Sockets - - .. parsed-literal:: - - |qemu_system| --drive file=nbd:unix:/tmp/nbd-socket - -``SSH`` - QEMU supports SSH (Secure Shell) access to remote disks. - - Examples: - - .. parsed-literal:: - - |qemu_system| -drive file=ssh://user@host/path/to/disk.img - |qemu_system| -drive file.driver=ssh,file.user=user,file.host=host,file.port=22,file.path=/path/to/disk.img - - Currently authentication must be done using ssh-agent. Other - authentication methods may be supported in future. - -``Sheepdog`` - Sheepdog is a distributed storage system for QEMU. QEMU supports - using either local sheepdog devices or remote networked devices. - - Syntax for specifying a sheepdog device - - :: - - sheepdog[+tcp|+unix]://[host:port]/vdiname[?socket=path][#snapid|#tag] - - Example - - .. parsed-literal:: - - |qemu_system| --drive file=sheepdog://192.0.2.1:30000/MyVirtualMachine - - See also https://sheepdog.github.io/sheepdog/. - -``GlusterFS`` - GlusterFS is a user space distributed file system. QEMU supports the - use of GlusterFS volumes for hosting VM disk images using TCP, Unix - Domain Sockets and RDMA transport protocols. - - Syntax for specifying a VM disk image on GlusterFS volume is - - .. parsed-literal:: - - URI: - gluster[+type]://[host[:port]]/volume/path[?socket=...][,debug=N][,logfile=...] - - JSON: - 'json:{"driver":"qcow2","file":{"driver":"gluster","volume":"testvol","path":"a.img","debug":N,"logfile":"...", -   "server":[{"type":"tcp","host":"...","port":"..."}, -   {"type":"unix","socket":"..."}]}}' - - Example - - .. parsed-literal:: - - URI: - |qemu_system| --drive file=gluster://192.0.2.1/testvol/a.img, -   file.debug=9,file.logfile=/var/log/qemu-gluster.log - - JSON: - |qemu_system| 'json:{"driver":"qcow2", -   "file":{"driver":"gluster", -   "volume":"testvol","path":"a.img", -   "debug":9,"logfile":"/var/log/qemu-gluster.log", -   "server":[{"type":"tcp","host":"1.2.3.4","port":24007}, -   {"type":"unix","socket":"/var/run/glusterd.socket"}]}}' - |qemu_system| -drive driver=qcow2,file.driver=gluster,file.volume=testvol,file.path=/path/a.img, -   file.debug=9,file.logfile=/var/log/qemu-gluster.log, -   file.server.0.type=tcp,file.server.0.host=1.2.3.4,file.server.0.port=24007, -   file.server.1.type=unix,file.server.1.socket=/var/run/glusterd.socket - - See also http://www.gluster.org. - -``HTTP/HTTPS/FTP/FTPS`` - QEMU supports read-only access to files accessed over http(s) and - ftp(s). - - Syntax using a single filename: - - :: - - ://[[:]@]/ - - where: - - ``protocol`` - 'http', 'https', 'ftp', or 'ftps'. - - ``username`` - Optional username for authentication to the remote server. - - ``password`` - Optional password for authentication to the remote server. - - ``host`` - Address of the remote server. - - ``path`` - Path on the remote server, including any query string. - - The following options are also supported: - - ``url`` - The full URL when passing options to the driver explicitly. - - ``readahead`` - The amount of data to read ahead with each range request to the - remote server. This value may optionally have the suffix 'T', 'G', - 'M', 'K', 'k' or 'b'. If it does not have a suffix, it will be - assumed to be in bytes. The value must be a multiple of 512 bytes. - It defaults to 256k. - - ``sslverify`` - Whether to verify the remote server's certificate when connecting - over SSL. It can have the value 'on' or 'off'. It defaults to - 'on'. - - ``cookie`` - Send this cookie (it can also be a list of cookies separated by - ';') with each outgoing request. Only supported when using - protocols such as HTTP which support cookies, otherwise ignored. - - ``timeout`` - Set the timeout in seconds of the CURL connection. This timeout is - the time that CURL waits for a response from the remote server to - get the size of the image to be downloaded. If not set, the - default timeout of 5 seconds is used. - - Note that when passing options to qemu explicitly, ``driver`` is the - value of . - - Example: boot from a remote Fedora 20 live ISO image - - .. parsed-literal:: - - |qemu_system_x86| --drive media=cdrom,file=https://archives.fedoraproject.org/pub/archive/fedora/linux/releases/20/Live/x86_64/Fedora-Live-Desktop-x86_64-20-1.iso,readonly - - |qemu_system_x86| --drive media=cdrom,file.driver=http,file.url=http://archives.fedoraproject.org/pub/fedora/linux/releases/20/Live/x86_64/Fedora-Live-Desktop-x86_64-20-1.iso,readonly - - Example: boot from a remote Fedora 20 cloud image using a local - overlay for writes, copy-on-read, and a readahead of 64k - - .. parsed-literal:: - - qemu-img create -f qcow2 -o backing_file='json:{"file.driver":"http",, "file.url":"http://archives.fedoraproject.org/pub/archive/fedora/linux/releases/20/Images/x86_64/Fedora-x86_64-20-20131211.1-sda.qcow2",, "file.readahead":"64k"}' /tmp/Fedora-x86_64-20-20131211.1-sda.qcow2 - - |qemu_system_x86| -drive file=/tmp/Fedora-x86_64-20-20131211.1-sda.qcow2,copy-on-read=on - - Example: boot from an image stored on a VMware vSphere server with a - self-signed certificate using a local overlay for writes, a readahead - of 64k and a timeout of 10 seconds. - - .. parsed-literal:: - - qemu-img create -f qcow2 -o backing_file='json:{"file.driver":"https",, "file.url":"https://user:password@vsphere.example.com/folder/test/test-flat.vmdk?dcPath=Datacenter&dsName=datastore1",, "file.sslverify":"off",, "file.readahead":"64k",, "file.timeout":10}' /tmp/test.qcow2 - - |qemu_system_x86| -drive file=/tmp/test.qcow2 +.. include:: device-url-syntax.rst.inc diff --git a/docs/system/keys.rst b/docs/system/keys.rst index bf99ee8d5b..e596ae6c4e 100644 --- a/docs/system/keys.rst +++ b/docs/system/keys.rst @@ -3,38 +3,4 @@ Keys in the graphical frontends ------------------------------- -During the graphical emulation, you can use special key combinations to -change modes. The default key mappings are shown below, but if you use -``-alt-grab`` then the modifier is Ctrl-Alt-Shift (instead of Ctrl-Alt) -and if you use ``-ctrl-grab`` then the modifier is the right Ctrl key -(instead of Ctrl-Alt): - -Ctrl-Alt-f - Toggle full screen - -Ctrl-Alt-+ - Enlarge the screen - -Ctrl-Alt\-- - Shrink the screen - -Ctrl-Alt-u - Restore the screen's un-scaled dimensions - -Ctrl-Alt-n - Switch to virtual console 'n'. Standard console mappings are: - - *1* - Target system display - - *2* - Monitor - - *3* - Serial port - -Ctrl-Alt - Toggle mouse and keyboard grab. - -In the virtual consoles, you can use Ctrl-Up, Ctrl-Down, Ctrl-PageUp and -Ctrl-PageDown to move in the back log. +.. include:: keys.rst.inc diff --git a/docs/system/keys.rst.inc b/docs/system/keys.rst.inc new file mode 100644 index 0000000000..bd9b8e5f6f --- /dev/null +++ b/docs/system/keys.rst.inc @@ -0,0 +1,35 @@ +During the graphical emulation, you can use special key combinations to +change modes. The default key mappings are shown below, but if you use +``-alt-grab`` then the modifier is Ctrl-Alt-Shift (instead of Ctrl-Alt) +and if you use ``-ctrl-grab`` then the modifier is the right Ctrl key +(instead of Ctrl-Alt): + +Ctrl-Alt-f + Toggle full screen + +Ctrl-Alt-+ + Enlarge the screen + +Ctrl-Alt\-- + Shrink the screen + +Ctrl-Alt-u + Restore the screen's un-scaled dimensions + +Ctrl-Alt-n + Switch to virtual console 'n'. Standard console mappings are: + + *1* + Target system display + + *2* + Monitor + + *3* + Serial port + +Ctrl-Alt + Toggle mouse and keyboard grab. + +In the virtual consoles, you can use Ctrl-Up, Ctrl-Down, Ctrl-PageUp and +Ctrl-PageDown to move in the back log. diff --git a/docs/system/mux-chardev.rst b/docs/system/mux-chardev.rst index e50172c081..413a6b3446 100644 --- a/docs/system/mux-chardev.rst +++ b/docs/system/mux-chardev.rst @@ -3,30 +3,4 @@ Keys in the character backend multiplexer ----------------------------------------- -During emulation, if you are using a character backend multiplexer -(which is the default if you are using ``-nographic``) then several -commands are available via an escape sequence. These key sequences all -start with an escape character, which is Ctrl-a by default, but can be -changed with ``-echr``. The list below assumes you're using the default. - -Ctrl-a h - Print this help - -Ctrl-a x - Exit emulator - -Ctrl-a s - Save disk data back to file (if -snapshot) - -Ctrl-a t - Toggle console timestamps - -Ctrl-a b - Send break (magic sysrq in Linux) - -Ctrl-a c - Rotate between the frontends connected to the multiplexer (usually - this switches between the monitor and the console) - -Ctrl-a Ctrl-a - Send the escape character to the frontend +.. include:: mux-chardev.rst.inc diff --git a/docs/system/mux-chardev.rst.inc b/docs/system/mux-chardev.rst.inc new file mode 100644 index 0000000000..84ea12cbf5 --- /dev/null +++ b/docs/system/mux-chardev.rst.inc @@ -0,0 +1,27 @@ +During emulation, if you are using a character backend multiplexer +(which is the default if you are using ``-nographic``) then several +commands are available via an escape sequence. These key sequences all +start with an escape character, which is Ctrl-a by default, but can be +changed with ``-echr``. The list below assumes you're using the default. + +Ctrl-a h + Print this help + +Ctrl-a x + Exit emulator + +Ctrl-a s + Save disk data back to file (if -snapshot) + +Ctrl-a t + Toggle console timestamps + +Ctrl-a b + Send break (magic sysrq in Linux) + +Ctrl-a c + Rotate between the frontends connected to the multiplexer (usually + this switches between the monitor and the console) + +Ctrl-a Ctrl-a + Send the escape character to the frontend diff --git a/docs/system/target-i386-desc.rst.inc b/docs/system/target-i386-desc.rst.inc new file mode 100644 index 0000000000..47a169e0ae --- /dev/null +++ b/docs/system/target-i386-desc.rst.inc @@ -0,0 +1,62 @@ +The QEMU PC System emulator simulates the following peripherals: + +- i440FX host PCI bridge and PIIX3 PCI to ISA bridge + +- Cirrus CLGD 5446 PCI VGA card or dummy VGA card with Bochs VESA + extensions (hardware level, including all non standard modes). + +- PS/2 mouse and keyboard + +- 2 PCI IDE interfaces with hard disk and CD-ROM support + +- Floppy disk + +- PCI and ISA network adapters + +- Serial ports + +- IPMI BMC, either and internal or external one + +- Creative SoundBlaster 16 sound card + +- ENSONIQ AudioPCI ES1370 sound card + +- Intel 82801AA AC97 Audio compatible sound card + +- Intel HD Audio Controller and HDA codec + +- Adlib (OPL2) - Yamaha YM3812 compatible chip + +- Gravis Ultrasound GF1 sound card + +- CS4231A compatible sound card + +- PCI UHCI, OHCI, EHCI or XHCI USB controller and a virtual USB-1.1 + hub. + +SMP is supported with up to 255 CPUs. + +QEMU uses the PC BIOS from the Seabios project and the Plex86/Bochs LGPL +VGA BIOS. + +QEMU uses YM3812 emulation by Tatsuyuki Satoh. + +QEMU uses GUS emulation (GUSEMU32 http://www.deinmeister.de/gusemu/) by +Tibor \"TS\" Schütz. + +Note that, by default, GUS shares IRQ(7) with parallel ports and so QEMU +must be told to not have parallel ports to have working GUS. + +.. parsed-literal:: + + |qemu_system_x86| dos.img -soundhw gus -parallel none + +Alternatively: + +.. parsed-literal:: + + |qemu_system_x86| dos.img -device gus,irq=5 + +Or some other unclaimed IRQ. + +CS4231A is the chip used in Windows Sound System and GUSMAX products diff --git a/docs/system/target-i386.rst b/docs/system/target-i386.rst index 92e2038b11..51be03d881 100644 --- a/docs/system/target-i386.rst +++ b/docs/system/target-i386.rst @@ -8,68 +8,7 @@ x86 (PC) System emulator Peripherals ~~~~~~~~~~~ -The QEMU PC System emulator simulates the following peripherals: - -- i440FX host PCI bridge and PIIX3 PCI to ISA bridge - -- Cirrus CLGD 5446 PCI VGA card or dummy VGA card with Bochs VESA - extensions (hardware level, including all non standard modes). - -- PS/2 mouse and keyboard - -- 2 PCI IDE interfaces with hard disk and CD-ROM support - -- Floppy disk - -- PCI and ISA network adapters - -- Serial ports - -- IPMI BMC, either and internal or external one - -- Creative SoundBlaster 16 sound card - -- ENSONIQ AudioPCI ES1370 sound card - -- Intel 82801AA AC97 Audio compatible sound card - -- Intel HD Audio Controller and HDA codec - -- Adlib (OPL2) - Yamaha YM3812 compatible chip - -- Gravis Ultrasound GF1 sound card - -- CS4231A compatible sound card - -- PCI UHCI, OHCI, EHCI or XHCI USB controller and a virtual USB-1.1 - hub. - -SMP is supported with up to 255 CPUs. - -QEMU uses the PC BIOS from the Seabios project and the Plex86/Bochs LGPL -VGA BIOS. - -QEMU uses YM3812 emulation by Tatsuyuki Satoh. - -QEMU uses GUS emulation (GUSEMU32 http://www.deinmeister.de/gusemu/) by -Tibor \"TS\" Schütz. - -Note that, by default, GUS shares IRQ(7) with parallel ports and so QEMU -must be told to not have parallel ports to have working GUS. - -.. parsed-literal:: - - |qemu_system_x86| dos.img -soundhw gus -parallel none - -Alternatively: - -.. parsed-literal:: - - |qemu_system_x86| dos.img -device gus,irq=5 - -Or some other unclaimed IRQ. - -CS4231A is the chip used in Windows Sound System and GUSMAX products +.. include:: target-i386-desc.rst.inc .. include:: cpu-models-x86.rst.inc -- cgit v1.2.3-55-g7522 From d06118bfbd8c0ab5b665aee9e0561aa58d3e45e1 Mon Sep 17 00:00:00 2001 From: Peter Maydell Date: Fri, 28 Feb 2020 15:36:15 +0000 Subject: docs: Generate qemu.1 manpage with Sphinx Generate the qemu.1 manpage using Sphinx; we do this with a new top-level rst source file which is just the skeleton of the manpage and which includes .rst.inc fragments where it needs to incorporate sections from the larger HTML manuals. Signed-off-by: Peter Maydell Reviewed-by: Alex Bennée Tested-by: Alex Bennée Message-id: 20200228153619.9906-30-peter.maydell@linaro.org --- Makefile | 10 ++++------ docs/system/conf.py | 2 ++ docs/system/qemu-manpage.rst | 45 ++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 51 insertions(+), 6 deletions(-) create mode 100644 docs/system/qemu-manpage.rst (limited to 'docs/system') diff --git a/Makefile b/Makefile index f7d08997db..ef10b9a031 100644 --- a/Makefile +++ b/Makefile @@ -344,7 +344,8 @@ MANUAL_BUILDDIR := docs endif ifdef BUILD_DOCS -DOCS=qemu-doc.html qemu-doc.txt qemu.1 +DOCS=qemu-doc.html qemu-doc.txt +DOCS+=$(MANUAL_BUILDDIR)/system/qemu.1 DOCS+=$(MANUAL_BUILDDIR)/tools/qemu-img.1 DOCS+=$(MANUAL_BUILDDIR)/tools/qemu-nbd.8 DOCS+=$(MANUAL_BUILDDIR)/interop/qemu-ga.8 @@ -856,7 +857,7 @@ install-doc: $(DOCS) install-sphinxdocs $(INSTALL_DATA) docs/interop/qemu-qmp-ref.txt "$(DESTDIR)$(qemu_docdir)" ifdef CONFIG_POSIX $(INSTALL_DIR) "$(DESTDIR)$(mandir)/man1" - $(INSTALL_DATA) qemu.1 "$(DESTDIR)$(mandir)/man1" + $(INSTALL_DATA) $(MANUAL_BUILDDIR)/system/qemu.1 "$(DESTDIR)$(mandir)/man1" $(INSTALL_DIR) "$(DESTDIR)$(mandir)/man7" $(INSTALL_DATA) docs/interop/qemu-qmp-ref.7 "$(DESTDIR)$(mandir)/man7" $(INSTALL_DATA) $(MANUAL_BUILDDIR)/system/qemu-block-drivers.7 "$(DESTDIR)$(mandir)/man7" @@ -1082,7 +1083,7 @@ $(MANUAL_BUILDDIR)/user/index.html: $(call manual-deps,user) $(call define-manpage-rule,interop,qemu-ga.8) -$(call define-manpage-rule,system,qemu-block-drivers.7 qemu-cpu-models.7) +$(call define-manpage-rule,system,qemu.1 qemu-block-drivers.7 qemu-cpu-models.7) $(call define-manpage-rule,tools,\ qemu-img.1 qemu-nbd.8 qemu-trace-stap.1\ @@ -1109,9 +1110,6 @@ docs/interop/qemu-qmp-qapi.texi: qapi/qapi-doc.texi docs/interop/qemu-ga-qapi.texi: qga/qapi-generated/qga-qapi-doc.texi @cp -p $< $@ -qemu.1: qemu-doc.texi qemu-options.texi qemu-monitor.texi qemu-monitor-info.texi -qemu.1: docs/system/qemu-option-trace.texi - html: qemu-doc.html docs/interop/qemu-qmp-ref.html docs/interop/qemu-ga-ref.html sphinxdocs info: qemu-doc.info docs/interop/qemu-qmp-ref.info docs/interop/qemu-ga-ref.info pdf: qemu-doc.pdf docs/interop/qemu-qmp-ref.pdf docs/interop/qemu-ga-ref.pdf diff --git a/docs/system/conf.py b/docs/system/conf.py index 23cab3fb36..6251849fef 100644 --- a/docs/system/conf.py +++ b/docs/system/conf.py @@ -17,6 +17,8 @@ html_theme_options['description'] = u'System Emulation User''s Guide' # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ + ('qemu-manpage', 'qemu', u'QEMU User Documentation', + ['Fabrice Bellard'], 1), ('qemu-block-drivers', 'qemu-block-drivers', u'QEMU block drivers reference', ['Fabrice Bellard and the QEMU Project developers'], 7), diff --git a/docs/system/qemu-manpage.rst b/docs/system/qemu-manpage.rst new file mode 100644 index 0000000000..e9a25d0680 --- /dev/null +++ b/docs/system/qemu-manpage.rst @@ -0,0 +1,45 @@ +:orphan: + +.. + This file is the skeleton for the qemu.1 manpage. It mostly + should simply include the .rst.inc files corresponding to the + parts of the documentation that go in the manpage as well as the + HTML manual. + +Title +===== + +Synopsis +-------- + +.. parsed-literal:: + + |qemu_system| [options] [disk_image] + +Description +----------- + +.. include:: target-i386-desc.rst.inc + +Options +------- + +disk_image is a raw hard disk image for IDE hard disk 0. Some targets do +not need a disk image. + +.. hxtool-doc:: qemu-options.hx + +.. include:: keys.rst.inc + +.. include:: mux-chardev.rst.inc + +Notes +----- + +.. include:: device-url-syntax.rst.inc + +See also +-------- + +The HTML documentation of QEMU for more precise information and Linux +user mode emulator invocation. -- cgit v1.2.3-55-g7522 From 3a8273b1ab3299cf92f7f72b41f56471ecb8e5cf Mon Sep 17 00:00:00 2001 From: Peter Maydell Date: Fri, 28 Feb 2020 15:36:18 +0000 Subject: docs: Remove old texinfo sources We can now delete the old .texi files, which we have been keeping in the tree as a parallel set of documentation to the new rST sources. The only remaining use of Texinfo is the autogenerated manuals and HTML documents created from the QAPI JSON doc comments. Signed-off-by: Peter Maydell Reviewed-by: Alex Bennée Reviewed-by: Kashyap Chamarthy Tested-by: Alex Bennée Message-id: 20200228153619.9906-33-peter.maydell@linaro.org --- MAINTAINERS | 5 +- docs/system/build-platforms.texi | 67 ------ docs/system/cpu-models-mips.texi | 157 ------------ docs/system/cpu-models-x86.texi | 482 ------------------------------------- docs/system/deprecated.texi | 377 ----------------------------- docs/system/gdb.texi | 71 ------ docs/system/images.texi | 88 ------- docs/system/invocation.texi | 240 ------------------ docs/system/ivshmem.texi | 60 ----- docs/system/keys.texi | 43 ---- docs/system/license.texi | 9 - docs/system/linuxboot.texi | 27 --- docs/system/managed-startup.texi | 35 --- docs/system/monitor.texi | 34 --- docs/system/mux-chardev.texi | 44 ---- docs/system/net.texi | 96 -------- docs/system/qemu-option-trace.texi | 28 --- docs/system/quickstart.texi | 12 - docs/system/security.texi | 167 ------------- docs/system/target-arm.texi | 245 ------------------- docs/system/target-i386.texi | 91 ------- docs/system/target-m68k.texi | 25 -- docs/system/target-mips.texi | 150 ------------ docs/system/target-ppc.texi | 52 ---- docs/system/target-sparc.texi | 68 ------ docs/system/target-sparc64.texi | 38 --- docs/system/target-xtensa.texi | 35 --- docs/system/tls.texi | 329 ------------------------- docs/system/usb.texi | 115 --------- docs/system/vnc-security.texi | 196 --------------- qemu-doc.texi | 201 ---------------- 31 files changed, 1 insertion(+), 3586 deletions(-) delete mode 100644 docs/system/build-platforms.texi delete mode 100644 docs/system/cpu-models-mips.texi delete mode 100644 docs/system/cpu-models-x86.texi delete mode 100644 docs/system/deprecated.texi delete mode 100644 docs/system/gdb.texi delete mode 100644 docs/system/images.texi delete mode 100644 docs/system/invocation.texi delete mode 100644 docs/system/ivshmem.texi delete mode 100644 docs/system/keys.texi delete mode 100644 docs/system/license.texi delete mode 100644 docs/system/linuxboot.texi delete mode 100644 docs/system/managed-startup.texi delete mode 100644 docs/system/monitor.texi delete mode 100644 docs/system/mux-chardev.texi delete mode 100644 docs/system/net.texi delete mode 100644 docs/system/qemu-option-trace.texi delete mode 100644 docs/system/quickstart.texi delete mode 100644 docs/system/security.texi delete mode 100644 docs/system/target-arm.texi delete mode 100644 docs/system/target-i386.texi delete mode 100644 docs/system/target-m68k.texi delete mode 100644 docs/system/target-mips.texi delete mode 100644 docs/system/target-ppc.texi delete mode 100644 docs/system/target-sparc.texi delete mode 100644 docs/system/target-sparc64.texi delete mode 100644 docs/system/target-xtensa.texi delete mode 100644 docs/system/tls.texi delete mode 100644 docs/system/usb.texi delete mode 100644 docs/system/vnc-security.texi delete mode 100644 qemu-doc.texi (limited to 'docs/system') diff --git a/MAINTAINERS b/MAINTAINERS index 4cdd2d5276..36d0c6887a 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -215,7 +215,6 @@ S: Maintained F: target/mips/ F: default-configs/*mips* F: disas/*mips* -F: docs/system/cpu-models-mips.texi F: docs/system/cpu-models-mips.rst.inc F: hw/intc/mips_gic.c F: hw/mips/ @@ -321,7 +320,6 @@ F: tests/tcg/i386/ F: tests/tcg/x86_64/ F: hw/i386/ F: disas/i386.c -F: docs/system/cpu-models-x86.texi F: docs/system/cpu-models-x86.rst.inc T: git https://github.com/ehabkost/qemu.git x86-next @@ -2236,7 +2234,7 @@ M: Stefan Hajnoczi S: Maintained F: trace/ F: trace-events -F: docs/system/qemu-option-trace.texi +F: docs/qemu-option-trace.rst.inc F: scripts/tracetool.py F: scripts/tracetool/ F: scripts/qemu-trace-stap* @@ -2806,7 +2804,6 @@ F: contrib/gitdm/* Incompatible changes R: libvir-list@redhat.com -F: docs/system/deprecated.texi F: docs/system/deprecated.rst Build System diff --git a/docs/system/build-platforms.texi b/docs/system/build-platforms.texi deleted file mode 100644 index 531ef5bed4..0000000000 --- a/docs/system/build-platforms.texi +++ /dev/null @@ -1,67 +0,0 @@ -@node Supported build platforms -@appendix Supported build platforms - -QEMU aims to support building and executing on multiple host OS platforms. -This appendix outlines which platforms are the major build targets. These -platforms are used as the basis for deciding upon the minimum required -versions of 3rd party software QEMU depends on. The supported platforms -are the targets for automated testing performed by the project when patches -are submitted for review, and tested before and after merge. - -If a platform is not listed here, it does not imply that QEMU won't work. -If an unlisted platform has comparable software versions to a listed platform, -there is every expectation that it will work. Bug reports are welcome for -problems encountered on unlisted platforms unless they are clearly older -vintage than what is described here. - -Note that when considering software versions shipped in distros as support -targets, QEMU considers only the version number, and assumes the features in -that distro match the upstream release with the same version. In other words, -if a distro backports extra features to the software in their distro, QEMU -upstream code will not add explicit support for those backports, unless the -feature is auto-detectable in a manner that works for the upstream releases -too. - -The Repology site @url{https://repology.org} is a useful resource to identify -currently shipped versions of software in various operating systems, though -it does not cover all distros listed below. - -@section Linux OS - -For distributions with frequent, short-lifetime releases, the project will -aim to support all versions that are not end of life by their respective -vendors. For the purposes of identifying supported software versions, the -project will look at Fedora, Ubuntu, and openSUSE distros. Other short- -lifetime distros will be assumed to ship similar software versions. - -For distributions with long-lifetime releases, the project will aim to support -the most recent major version at all times. Support for the previous major -version will be dropped 2 years after the new major version is released, -or when it reaches ``end of life''. For the purposes of identifying -supported software versions, the project will look at RHEL, Debian, -Ubuntu LTS, and SLES distros. Other long-lifetime distros will be -assumed to ship similar software versions. - -@section Windows - -The project supports building with current versions of the MinGW toolchain, -hosted on Linux. - -@section macOS - -The project supports building with the two most recent versions of macOS, with -the current homebrew package set available. - -@section FreeBSD - -The project aims to support the all the versions which are not end of life. - -@section NetBSD - -The project aims to support the most recent major version at all times. Support -for the previous major version will be dropped 2 years after the new major -version is released. - -@section OpenBSD - -The project aims to support the all the versions which are not end of life. diff --git a/docs/system/cpu-models-mips.texi b/docs/system/cpu-models-mips.texi deleted file mode 100644 index 6a0370cb69..0000000000 --- a/docs/system/cpu-models-mips.texi +++ /dev/null @@ -1,157 +0,0 @@ -@node recommendations_cpu_models_MIPS -@section Supported CPU model configurations on MIPS hosts - -QEMU supports variety of MIPS CPU models: - -@menu -* cpu_models_MIPS32:: Supported CPU models for MIPS32 hosts -* cpu_models_MIPS64:: Supported CPU models for MIPS64 hosts -* cpu_models_nanoMIPS:: Supported CPU models for nanoMIPS hosts -* preferred_cpu_models_MIPS:: Preferred CPU models for MIPS hosts -@end menu - -@node cpu_models_MIPS32 -@subsection Supported CPU models for MIPS32 hosts - -The following CPU models are supported for use on MIPS32 hosts. Administrators / -applications are recommended to use the CPU model that matches the generation -of the host CPUs in use. In a deployment with a mixture of host CPU models -between machines, if live migration compatibility is required, use the newest -CPU model that is compatible across all desired hosts. - -@table @option -@item @code{mips32r6-generic} - -MIPS32 Processor (Release 6, 2015) - - -@item @code{P5600} - -MIPS32 Processor (P5600, 2014) - - -@item @code{M14K} -@item @code{M14Kc} - -MIPS32 Processor (M14K, 2009) - - -@item @code{74Kf} - -MIPS32 Processor (74K, 2007) - - -@item @code{34Kf} - -MIPS32 Processor (34K, 2006) - - -@item @code{24Kc} -@item @code{24KEc} -@item @code{24Kf} - -MIPS32 Processor (24K, 2003) - - -@item @code{4Kc} -@item @code{4Km} -@item @code{4KEcR1} -@item @code{4KEmR1} -@item @code{4KEc} -@item @code{4KEm} - -MIPS32 Processor (4K, 1999) -@end table - -@node cpu_models_MIPS64 -@subsection Supported CPU models for MIPS64 hosts - -The following CPU models are supported for use on MIPS64 hosts. Administrators / -applications are recommended to use the CPU model that matches the generation -of the host CPUs in use. In a deployment with a mixture of host CPU models -between machines, if live migration compatibility is required, use the newest -CPU model that is compatible across all desired hosts. - -@table @option -@item @code{I6400} - -MIPS64 Processor (Release 6, 2014) - - -@item @code{Loongson-2F} - -MIPS64 Processor (Loongson 2, 2008) - - -@item @code{Loongson-2E} - -MIPS64 Processor (Loongson 2, 2006) - - -@item @code{mips64dspr2} - -MIPS64 Processor (Release 2, 2006) - - -@item @code{MIPS64R2-generic} -@item @code{5KEc} -@item @code{5KEf} - -MIPS64 Processor (Release 2, 2002) - - -@item @code{20Kc} - -MIPS64 Processor (20K, 2000) - - -@item @code{5Kc} -@item @code{5Kf} - -MIPS64 Processor (5K, 1999) - - -@item @code{VR5432} - -MIPS64 Processor (VR, 1998) - - -@item @code{R4000} - -MIPS64 Processor (MIPS III, 1991) -@end table - -@node cpu_models_nanoMIPS -@subsection Supported CPU models for nanoMIPS hosts - -The following CPU models are supported for use on nanoMIPS hosts. Administrators / -applications are recommended to use the CPU model that matches the generation -of the host CPUs in use. In a deployment with a mixture of host CPU models -between machines, if live migration compatibility is required, use the newest -CPU model that is compatible across all desired hosts. - -@table @option -@item @code{I7200} - -MIPS I7200 (nanoMIPS, 2018) - -@end table - -@node preferred_cpu_models_MIPS -@subsection Preferred CPU models for MIPS hosts - -The following CPU models are preferred for use on different MIPS hosts: - -@table @option -@item @code{MIPS III} -R4000 - -@item @code{MIPS32R2} -34Kf - -@item @code{MIPS64R6} -I6400 - -@item @code{nanoMIPS} -I7200 -@end table diff --git a/docs/system/cpu-models-x86.texi b/docs/system/cpu-models-x86.texi deleted file mode 100644 index 0cd64b0522..0000000000 --- a/docs/system/cpu-models-x86.texi +++ /dev/null @@ -1,482 +0,0 @@ -@node cpu_models_x86 -@section Recommendations for KVM CPU model configuration on x86 hosts - -QEMU / KVM virtualization supports two ways to configure CPU models - -@table @option - -@item Host passthrough - -This passes the host CPU model features, model, stepping, exactly to the -guest. Note that KVM may filter out some host CPU model features if they -cannot be supported with virtualization. Live migration is unsafe when -this mode is used as libvirt / QEMU cannot guarantee a stable CPU is -exposed to the guest across hosts. This is the recommended CPU to use, -provided live migration is not required. - -@item Named model - -QEMU comes with a number of predefined named CPU models, that typically -refer to specific generations of hardware released by Intel and AMD. -These allow the guest VMs to have a degree of isolation from the host CPU, -allowing greater flexibility in live migrating between hosts with differing -hardware. -@end table - -In both cases, it is possible to optionally add or remove individual CPU -features, to alter what is presented to the guest by default. - -Libvirt supports a third way to configure CPU models known as "Host model". -This uses the QEMU "Named model" feature, automatically picking a CPU model -that is similar the host CPU, and then adding extra features to approximate -the host model as closely as possible. This does not guarantee the CPU family, -stepping, etc will precisely match the host CPU, as they would with "Host -passthrough", but gives much of the benefit of passthrough, while making -live migration safe. - -The information that follows provides recommendations for configuring -CPU models on x86 hosts. The goals are to maximise performance, while -protecting guest OS against various CPU hardware flaws, and optionally -enabling live migration between hosts with heterogeneous CPU models. - -@menu -* preferred_cpu_models_intel_x86:: Preferred CPU models for Intel x86 hosts -* important_cpu_features_intel_x86:: Important CPU features for Intel x86 hosts -* preferred_cpu_models_amd_x86:: Preferred CPU models for AMD x86 hosts -* important_cpu_features_amd_x86:: Important CPU features for AMD x86 hosts -* default_cpu_models_x86:: Default x86 CPU models -* other_non_recommended_cpu_models_x86:: Other non-recommended x86 CPUs -* cpu_model_syntax_apps:: Syntax for configuring CPU models -@end menu - -@node preferred_cpu_models_intel_x86 -@subsection Preferred CPU models for Intel x86 hosts - -The following CPU models are preferred for use on Intel hosts. Administrators / -applications are recommended to use the CPU model that matches the generation -of the host CPUs in use. In a deployment with a mixture of host CPU models -between machines, if live migration compatibility is required, use the newest -CPU model that is compatible across all desired hosts. - -@table @option -@item @code{Skylake-Server} -@item @code{Skylake-Server-IBRS} - -Intel Xeon Processor (Skylake, 2016) - - -@item @code{Skylake-Client} -@item @code{Skylake-Client-IBRS} - -Intel Core Processor (Skylake, 2015) - - -@item @code{Broadwell} -@item @code{Broadwell-IBRS} -@item @code{Broadwell-noTSX} -@item @code{Broadwell-noTSX-IBRS} - -Intel Core Processor (Broadwell, 2014) - - -@item @code{Haswell} -@item @code{Haswell-IBRS} -@item @code{Haswell-noTSX} -@item @code{Haswell-noTSX-IBRS} - -Intel Core Processor (Haswell, 2013) - - -@item @code{IvyBridge} -@item @code{IvyBridge-IBRS} - -Intel Xeon E3-12xx v2 (Ivy Bridge, 2012) - - -@item @code{SandyBridge} -@item @code{SandyBridge-IBRS} - -Intel Xeon E312xx (Sandy Bridge, 2011) - - -@item @code{Westmere} -@item @code{Westmere-IBRS} - -Westmere E56xx/L56xx/X56xx (Nehalem-C, 2010) - - -@item @code{Nehalem} -@item @code{Nehalem-IBRS} - -Intel Core i7 9xx (Nehalem Class Core i7, 2008) - - -@item @code{Penryn} - -Intel Core 2 Duo P9xxx (Penryn Class Core 2, 2007) - - -@item @code{Conroe} - -Intel Celeron_4x0 (Conroe/Merom Class Core 2, 2006) - -@end table - -@node important_cpu_features_intel_x86 -@subsection Important CPU features for Intel x86 hosts - -The following are important CPU features that should be used on Intel x86 -hosts, when available in the host CPU. Some of them require explicit -configuration to enable, as they are not included by default in some, or all, -of the named CPU models listed above. In general all of these features are -included if using "Host passthrough" or "Host model". - - -@table @option - -@item @code{pcid} - -Recommended to mitigate the cost of the Meltdown (CVE-2017-5754) fix - -Included by default in Haswell, Broadwell & Skylake Intel CPU models. - -Should be explicitly turned on for Westmere, SandyBridge, and IvyBridge -Intel CPU models. Note that some desktop/mobile Westmere CPUs cannot -support this feature. - - -@item @code{spec-ctrl} - -Required to enable the Spectre v2 (CVE-2017-5715) fix. - -Included by default in Intel CPU models with -IBRS suffix. - -Must be explicitly turned on for Intel CPU models without -IBRS suffix. - -Requires the host CPU microcode to support this feature before it -can be used for guest CPUs. - - -@item @code{stibp} - -Required to enable stronger Spectre v2 (CVE-2017-5715) fixes in some -operating systems. - -Must be explicitly turned on for all Intel CPU models. - -Requires the host CPU microcode to support this feature before it -can be used for guest CPUs. - - -@item @code{ssbd} - -Required to enable the CVE-2018-3639 fix - -Not included by default in any Intel CPU model. - -Must be explicitly turned on for all Intel CPU models. - -Requires the host CPU microcode to support this feature before it -can be used for guest CPUs. - - -@item @code{pdpe1gb} - -Recommended to allow guest OS to use 1GB size pages - -Not included by default in any Intel CPU model. - -Should be explicitly turned on for all Intel CPU models. - -Note that not all CPU hardware will support this feature. - -@item @code{md-clear} - -Required to confirm the MDS (CVE-2018-12126, CVE-2018-12127, CVE-2018-12130, -CVE-2019-11091) fixes. - -Not included by default in any Intel CPU model. - -Must be explicitly turned on for all Intel CPU models. - -Requires the host CPU microcode to support this feature before it -can be used for guest CPUs. -@end table - - -@node preferred_cpu_models_amd_x86 -@subsection Preferred CPU models for AMD x86 hosts - -The following CPU models are preferred for use on Intel hosts. Administrators / -applications are recommended to use the CPU model that matches the generation -of the host CPUs in use. In a deployment with a mixture of host CPU models -between machines, if live migration compatibility is required, use the newest -CPU model that is compatible across all desired hosts. - -@table @option - -@item @code{EPYC} -@item @code{EPYC-IBPB} - -AMD EPYC Processor (2017) - - -@item @code{Opteron_G5} - -AMD Opteron 63xx class CPU (2012) - - -@item @code{Opteron_G4} - -AMD Opteron 62xx class CPU (2011) - - -@item @code{Opteron_G3} - -AMD Opteron 23xx (Gen 3 Class Opteron, 2009) - - -@item @code{Opteron_G2} - -AMD Opteron 22xx (Gen 2 Class Opteron, 2006) - - -@item @code{Opteron_G1} - -AMD Opteron 240 (Gen 1 Class Opteron, 2004) -@end table - -@node important_cpu_features_amd_x86 -@subsection Important CPU features for AMD x86 hosts - -The following are important CPU features that should be used on AMD x86 -hosts, when available in the host CPU. Some of them require explicit -configuration to enable, as they are not included by default in some, or all, -of the named CPU models listed above. In general all of these features are -included if using "Host passthrough" or "Host model". - - -@table @option - -@item @code{ibpb} - -Required to enable the Spectre v2 (CVE-2017-5715) fix. - -Included by default in AMD CPU models with -IBPB suffix. - -Must be explicitly turned on for AMD CPU models without -IBPB suffix. - -Requires the host CPU microcode to support this feature before it -can be used for guest CPUs. - - -@item @code{stibp} - -Required to enable stronger Spectre v2 (CVE-2017-5715) fixes in some -operating systems. - -Must be explicitly turned on for all AMD CPU models. - -Requires the host CPU microcode to support this feature before it -can be used for guest CPUs. - - -@item @code{virt-ssbd} - -Required to enable the CVE-2018-3639 fix - -Not included by default in any AMD CPU model. - -Must be explicitly turned on for all AMD CPU models. - -This should be provided to guests, even if amd-ssbd is also -provided, for maximum guest compatibility. - -Note for some QEMU / libvirt versions, this must be force enabled -when when using "Host model", because this is a virtual feature -that doesn't exist in the physical host CPUs. - - -@item @code{amd-ssbd} - -Required to enable the CVE-2018-3639 fix - -Not included by default in any AMD CPU model. - -Must be explicitly turned on for all AMD CPU models. - -This provides higher performance than virt-ssbd so should be -exposed to guests whenever available in the host. virt-ssbd -should none the less also be exposed for maximum guest -compatibility as some kernels only know about virt-ssbd. - - -@item @code{amd-no-ssb} - -Recommended to indicate the host is not vulnerable CVE-2018-3639 - -Not included by default in any AMD CPU model. - -Future hardware generations of CPU will not be vulnerable to -CVE-2018-3639, and thus the guest should be told not to enable -its mitigations, by exposing amd-no-ssb. This is mutually -exclusive with virt-ssbd and amd-ssbd. - - -@item @code{pdpe1gb} - -Recommended to allow guest OS to use 1GB size pages - -Not included by default in any AMD CPU model. - -Should be explicitly turned on for all AMD CPU models. - -Note that not all CPU hardware will support this feature. -@end table - - -@node default_cpu_models_x86 -@subsection Default x86 CPU models - -The default QEMU CPU models are designed such that they can run on all hosts. -If an application does not wish to do perform any host compatibility checks -before launching guests, the default is guaranteed to work. - -The default CPU models will, however, leave the guest OS vulnerable to various -CPU hardware flaws, so their use is strongly discouraged. Applications should -follow the earlier guidance to setup a better CPU configuration, with host -passthrough recommended if live migration is not needed. - -@table @option -@item @code{qemu32} -@item @code{qemu64} - -QEMU Virtual CPU version 2.5+ (32 & 64 bit variants) - -qemu64 is used for x86_64 guests and qemu32 is used for i686 guests, when no --cpu argument is given to QEMU, or no is provided in libvirt XML. -@end table - - -@node other_non_recommended_cpu_models_x86 -@subsection Other non-recommended x86 CPUs - -The following CPUs models are compatible with most AMD and Intel x86 hosts, but -their usage is discouraged, as they expose a very limited featureset, which -prevents guests having optimal performance. - -@table @option - -@item @code{kvm32} -@item @code{kvm64} - -Common KVM processor (32 & 64 bit variants) - -Legacy models just for historical compatibility with ancient QEMU versions. - - -@item @code{486} -@item @code{athlon} -@item @code{phenom} -@item @code{coreduo} -@item @code{core2duo} -@item @code{n270} -@item @code{pentium} -@item @code{pentium2} -@item @code{pentium3} - -Various very old x86 CPU models, mostly predating the introduction of -hardware assisted virtualization, that should thus not be required for -running virtual machines. -@end table - -@node cpu_model_syntax_apps -@subsection Syntax for configuring CPU models - -The example below illustrate the approach to configuring the various -CPU models / features in QEMU and libvirt. - -QEMU command line: - -@table @option - -@item Host passthrough - -@example - $ @value{qemu_system_x86} -cpu host -@end example - -With feature customization: - -@example - $ @value{qemu_system_x86} -cpu host,-vmx,... -@end example - -@item Named CPU models - -@example - $ @value{qemu_system_x86} -cpu Westmere -@end example - -With feature customization: - -@example - $ @value{qemu_system_x86} -cpu Westmere,+pcid,... -@end example - -@end table - - -Libvirt guest XML: - -@table @option - -@item Host passthrough - -@example - -@end example - -With feature customization: - -@example - - - ... - -@end example - -@item Host model - -@example - -@end example - -With feature customization: - -@example - - - ... - -@end example - -@item Named model - -@example - - - -@end example - -With feature customization: - -@example - - - - ... - -@end example - -@end table diff --git a/docs/system/deprecated.texi b/docs/system/deprecated.texi deleted file mode 100644 index 66eca3a1de..0000000000 --- a/docs/system/deprecated.texi +++ /dev/null @@ -1,377 +0,0 @@ -@node Deprecated features -@appendix Deprecated features - -In general features are intended to be supported indefinitely once -introduced into QEMU. In the event that a feature needs to be removed, -it will be listed in this appendix. The feature will remain functional -for 2 releases prior to actual removal. Deprecated features may also -generate warnings on the console when QEMU starts up, or if activated -via a monitor command, however, this is not a mandatory requirement. - -Prior to the 2.10.0 release there was no official policy on how -long features would be deprecated prior to their removal, nor -any documented list of which features were deprecated. Thus -any features deprecated prior to 2.10.0 will be treated as if -they were first deprecated in the 2.10.0 release. - -What follows is a list of all features currently marked as -deprecated. - -@section System emulator command line arguments - -@subsection -machine enforce-config-section=on|off (since 3.1) - -The @option{enforce-config-section} parameter is replaced by the -@option{-global migration.send-configuration=@var{on|off}} option. - -@subsection -no-kvm (since 1.3.0) - -The ``-no-kvm'' argument is now a synonym for setting ``-accel tcg''. - -@subsection -usbdevice (since 2.10.0) - -The ``-usbdevice DEV'' argument is now a synonym for setting -the ``-device usb-DEV'' argument instead. The deprecated syntax -would automatically enable USB support on the machine type. -If using the new syntax, USB support must be explicitly -enabled via the ``-machine usb=on'' argument. - -@subsection -drive file=json:@{...@{'driver':'file'@}@} (since 3.0) - -The 'file' driver for drives is no longer appropriate for character or host -devices and will only accept regular files (S_IFREG). The correct driver -for these file types is 'host_cdrom' or 'host_device' as appropriate. - -@subsection -net ...,name=@var{name} (since 3.1) - -The @option{name} parameter of the @option{-net} option is a synonym -for the @option{id} parameter, which should now be used instead. - -@subsection -smp (invalid topologies) (since 3.1) - -CPU topology properties should describe whole machine topology including -possible CPUs. - -However, historically it was possible to start QEMU with an incorrect topology -where @math{@var{n} <= @var{sockets} * @var{cores} * @var{threads} < @var{maxcpus}}, -which could lead to an incorrect topology enumeration by the guest. -Support for invalid topologies will be removed, the user must ensure -topologies described with -smp include all possible cpus, i.e. - @math{@var{sockets} * @var{cores} * @var{threads} = @var{maxcpus}}. - -@subsection -vnc acl (since 4.0.0) - -The @code{acl} option to the @code{-vnc} argument has been replaced -by the @code{tls-authz} and @code{sasl-authz} options. - -@subsection QEMU_AUDIO_ environment variables and -audio-help (since 4.0) - -The ``-audiodev'' argument is now the preferred way to specify audio -backend settings instead of environment variables. To ease migration to -the new format, the ``-audiodev-help'' option can be used to convert -the current values of the environment variables to ``-audiodev'' options. - -@subsection Creating sound card devices and vnc without audiodev= property (since 4.2) - -When not using the deprecated legacy audio config, each sound card -should specify an @code{audiodev=} property. Additionally, when using -vnc, you should specify an @code{audiodev=} propery if you plan to -transmit audio through the VNC protocol. - -@subsection -mon ...,control=readline,pretty=on|off (since 4.1) - -The @code{pretty=on|off} switch has no effect for HMP monitors, but is -silently ignored. Using the switch with HMP monitors will become an -error in the future. - -@subsection -realtime (since 4.1) - -The @code{-realtime mlock=on|off} argument has been replaced by the -@code{-overcommit mem-lock=on|off} argument. - -@subsection -numa node,mem=@var{size} (since 4.1) - -The parameter @option{mem} of @option{-numa node} is used to assign a part of -guest RAM to a NUMA node. But when using it, it's impossible to manage specified -RAM chunk on the host side (like bind it to a host node, setting bind policy, ...), -so guest end-ups with the fake NUMA configuration with suboptiomal performance. -However since 2014 there is an alternative way to assign RAM to a NUMA node -using parameter @option{memdev}, which does the same as @option{mem} and adds -means to actualy manage node RAM on the host side. Use parameter @option{memdev} -with @var{memory-backend-ram} backend as an replacement for parameter @option{mem} -to achieve the same fake NUMA effect or a properly configured -@var{memory-backend-file} backend to actually benefit from NUMA configuration. -In future new machine versions will not accept the option but it will still -work with old machine types. User can check QAPI schema to see if the legacy -option is supported by looking at MachineInfo::numa-mem-supported property. - -@subsection -numa node (without memory specified) (since 4.1) - -Splitting RAM by default between NUMA nodes has the same issues as @option{mem} -parameter described above with the difference that the role of the user plays -QEMU using implicit generic or board specific splitting rule. -Use @option{memdev} with @var{memory-backend-ram} backend or @option{mem} (if -it's supported by used machine type) to define mapping explictly instead. - -@subsection RISC-V -bios (since 4.1) - -QEMU 4.1 introduced support for the -bios option in QEMU for RISC-V for the -RISC-V virt machine and sifive_u machine. - -QEMU 4.1 has no changes to the default behaviour to avoid breakages. This -default will change in a future QEMU release, so please prepare now. All users -of the virt or sifive_u machine must change their command line usage. - -QEMU 4.1 has three options, please migrate to one of these three: - 1. ``-bios none`` - This is the current default behavior if no -bios option - is included. QEMU will not automatically load any firmware. It is up - to the user to load all the images they need. - 2. ``-bios default`` - In a future QEMU release this will become the default - behaviour if no -bios option is specified. This option will load the - default OpenSBI firmware automatically. The firmware is included with - the QEMU release and no user interaction is required. All a user needs - to do is specify the kernel they want to boot with the -kernel option - 3. ``-bios `` - Tells QEMU to load the specified file as the firmwrae. - -@subsection -tb-size option (since 5.0) - -QEMU 5.0 introduced an alternative syntax to specify the size of the translation -block cache, @option{-accel tcg,tb-size=}. The new syntax deprecates the -previously available @option{-tb-size} option. - -@subsection -show-cursor option (since 5.0) - -Use @option{-display sdl,show-cursor=on} or - @option{-display gtk,show-cursor=on} instead. - -@section QEMU Machine Protocol (QMP) commands - -@subsection change (since 2.5.0) - -Use ``blockdev-change-medium'' or ``change-vnc-password'' instead. - -@subsection migrate_set_downtime and migrate_set_speed (since 2.8.0) - -Use ``migrate-set-parameters'' instead. - -@subsection migrate-set-cache-size and query-migrate-cache-size (since 2.11.0) - -Use ``migrate-set-parameters'' and ``query-migrate-parameters'' instead. - -@subsection query-block result field dirty-bitmaps[i].status (since 4.0) - -The ``status'' field of the ``BlockDirtyInfo'' structure, returned by -the query-block command is deprecated. Two new boolean fields, -``recording'' and ``busy'' effectively replace it. - -@subsection query-block result field dirty-bitmaps (Since 4.2) - -The ``dirty-bitmaps`` field of the ``BlockInfo`` structure, returned by -the query-block command is itself now deprecated. The ``dirty-bitmaps`` -field of the ``BlockDeviceInfo`` struct should be used instead, which is the -type of the ``inserted`` field in query-block replies, as well as the -type of array items in query-named-block-nodes. - -Since the ``dirty-bitmaps`` field is optionally present in both the old and -new locations, clients must use introspection to learn where to anticipate -the field if/when it does appear in command output. - -@subsection query-cpus (since 2.12.0) - -The ``query-cpus'' command is replaced by the ``query-cpus-fast'' command. - -@subsection query-cpus-fast "arch" output member (since 3.0.0) - -The ``arch'' output member of the ``query-cpus-fast'' command is -replaced by the ``target'' output member. - -@subsection cpu-add (since 4.0) - -Use ``device_add'' for hotplugging vCPUs instead of ``cpu-add''. See -documentation of ``query-hotpluggable-cpus'' for additional -details. - -@subsection query-events (since 4.0) - -The ``query-events'' command has been superseded by the more powerful -and accurate ``query-qmp-schema'' command. - -@subsection chardev client socket with 'wait' option (since 4.0) - -Character devices creating sockets in client mode should not specify -the 'wait' field, which is only applicable to sockets in server mode - -@section Human Monitor Protocol (HMP) commands - -@subsection The hub_id parameter of 'hostfwd_add' / 'hostfwd_remove' (since 3.1) - -The @option{[hub_id name]} parameter tuple of the 'hostfwd_add' and -'hostfwd_remove' HMP commands has been replaced by @option{netdev_id}. - -@subsection cpu-add (since 4.0) - -Use ``device_add'' for hotplugging vCPUs instead of ``cpu-add''. See -documentation of ``query-hotpluggable-cpus'' for additional details. - -@subsection acl_show, acl_reset, acl_policy, acl_add, acl_remove (since 4.0.0) - -The ``acl_show'', ``acl_reset'', ``acl_policy'', ``acl_add'', and -``acl_remove'' commands are deprecated with no replacement. Authorization -for VNC should be performed using the pluggable QAuthZ objects. - -@section Guest Emulator ISAs - -@subsection RISC-V ISA privledge specification version 1.09.1 (since 4.1) - -The RISC-V ISA privledge specification version 1.09.1 has been deprecated. -QEMU supports both the newer version 1.10.0 and the ratified version 1.11.0, these -should be used instead of the 1.09.1 version. - -@section System emulator CPUS - -@subsection RISC-V ISA CPUs (since 4.1) - -The RISC-V cpus with the ISA version in the CPU name have been depcreated. The -four CPUs are: ``rv32gcsu-v1.9.1``, ``rv32gcsu-v1.10.0``, ``rv64gcsu-v1.9.1`` and -``rv64gcsu-v1.10.0``. Instead the version can be specified via the CPU ``priv_spec`` -option when using the ``rv32`` or ``rv64`` CPUs. - -@subsection RISC-V ISA CPUs (since 4.1) - -The RISC-V no MMU cpus have been depcreated. The two CPUs: ``rv32imacu-nommu`` and -``rv64imacu-nommu`` should no longer be used. Instead the MMU status can be specified -via the CPU ``mmu`` option when using the ``rv32`` or ``rv64`` CPUs. - -@section System emulator devices - -@subsection ide-drive (since 4.2) - -The 'ide-drive' device is deprecated. Users should use 'ide-hd' or -'ide-cd' as appropriate to get an IDE hard disk or CD-ROM as needed. - -@subsection scsi-disk (since 4.2) - -The 'scsi-disk' device is deprecated. Users should use 'scsi-hd' or -'scsi-cd' as appropriate to get a SCSI hard disk or CD-ROM as needed. - -@section System emulator machines - -@subsection mips r4k platform (since 5.0) - -This machine type is very old and unmaintained. Users should use the 'malta' -machine type instead. - -@subsection pc-1.0, pc-1.1, pc-1.2 and pc-1.3 (since 5.0) - -These machine types are very old and likely can not be used for live migration -from old QEMU versions anymore. A newer machine type should be used instead. - -@subsection spike_v1.9.1 and spike_v1.10 (since 4.1) - -The version specific Spike machines have been deprecated in favour of the -generic ``spike`` machine. If you need to specify an older version of the RISC-V -spec you can use the ``-cpu rv64gcsu,priv_spec=v1.9.1`` command line argument. - -@section Device options - -@subsection Emulated device options - -@subsubsection -device virtio-blk,scsi=on|off (since 5.0.0) - -The virtio-blk SCSI passthrough feature is a legacy VIRTIO feature. VIRTIO 1.0 -and later do not support it because the virtio-scsi device was introduced for -full SCSI support. Use virtio-scsi instead when SCSI passthrough is required. - -Note this also applies to ``-device virtio-blk-pci,scsi=on|off'', which is an -alias. - -@subsection Block device options - -@subsubsection "backing": "" (since 2.12.0) - -In order to prevent QEMU from automatically opening an image's backing -chain, use ``"backing": null'' instead. - -@subsubsection rbd keyvalue pair encoded filenames: "" (since 3.1.0) - -Options for ``rbd'' should be specified according to its runtime options, -like other block drivers. Legacy parsing of keyvalue pair encoded -filenames is useful to open images with the old format for backing files; -These image files should be updated to use the current format. - -Example of legacy encoding: - -@code{json:@{"file.driver":"rbd", "file.filename":"rbd:rbd/name"@}} - -The above, converted to the current supported format: - -@code{json:@{"file.driver":"rbd", "file.pool":"rbd", "file.image":"name"@}} - -@section Related binaries - -@subsection qemu-img convert -n -o (since 4.2.0) - -All options specified in @option{-o} are image creation options, so -they have no effect when used with @option{-n} to skip image creation. -Silently ignored options can be confusing, so this combination of -options will be made an error in future versions. - -@section Backwards compatibility - -@subsection Runnability guarantee of CPU models (since 4.1.0) - -Previous versions of QEMU never changed existing CPU models in -ways that introduced additional host software or hardware -requirements to the VM. This allowed management software to -safely change the machine type of an existing VM without -introducing new requirements ("runnability guarantee"). This -prevented CPU models from being updated to include CPU -vulnerability mitigations, leaving guests vulnerable in the -default configuration. - -The CPU model runnability guarantee won't apply anymore to -existing CPU models. Management software that needs runnability -guarantees must resolve the CPU model aliases using te -``alias-of'' field returned by the ``query-cpu-definitions'' QMP -command. - -While those guarantees are kept, the return value of -``query-cpu-definitions'' will have existing CPU model aliases -point to a version that doesn't break runnability guarantees -(specifically, version 1 of those CPU models). In future QEMU -versions, aliases will point to newer CPU model versions -depending on the machine type, so management software must -resolve CPU model aliases before starting a virtual machine. - - -@node Recently removed features -@appendix Recently removed features - -What follows is a record of recently removed, formerly deprecated -features that serves as a record for users who have encountered -trouble after a recent upgrade. - -@section QEMU Machine Protocol (QMP) commands - -@subsection block-dirty-bitmap-add "autoload" parameter (since 4.2.0) - -The "autoload" parameter has been ignored since 2.12.0. All bitmaps -are automatically loaded from qcow2 images. - -@section Related binaries - -@subsection qemu-nbd --partition (removed in 5.0.0) - -The ``qemu-nbd --partition $digit'' code (also spelled @option{-P}) -could only handle MBR partitions, and never correctly handled logical -partitions beyond partition 5. Exporting a partition can still be -done by utilizing the @option{--image-opts} option with a raw blockdev -using the @code{offset} and @code{size} parameters layered on top of -any other existing blockdev. For example, if partition 1 is 100MiB -long starting at 1MiB, the old command: - -@code{qemu-nbd -t -P 1 -f qcow2 file.qcow2} - -can be rewritten as: - -@code{qemu-nbd -t --image-opts driver=raw,offset=1M,size=100M,file.driver=qcow2,file.file.driver=file,file.file.filename=file.qcow2} diff --git a/docs/system/gdb.texi b/docs/system/gdb.texi deleted file mode 100644 index f49bc5891e..0000000000 --- a/docs/system/gdb.texi +++ /dev/null @@ -1,71 +0,0 @@ -@node gdb_usage -@section GDB usage - -QEMU has a primitive support to work with gdb, so that you can do -'Ctrl-C' while the virtual machine is running and inspect its state. - -In order to use gdb, launch QEMU with the '-s' option. It will wait for a -gdb connection: -@example -@value{qemu_system} -s -kernel bzImage -hda rootdisk.img -append "root=/dev/hda" -Connected to host network interface: tun0 -Waiting gdb connection on port 1234 -@end example - -Then launch gdb on the 'vmlinux' executable: -@example -> gdb vmlinux -@end example - -In gdb, connect to QEMU: -@example -(gdb) target remote localhost:1234 -@end example - -Then you can use gdb normally. For example, type 'c' to launch the kernel: -@example -(gdb) c -@end example - -Here are some useful tips in order to use gdb on system code: - -@enumerate -@item -Use @code{info reg} to display all the CPU registers. -@item -Use @code{x/10i $eip} to display the code at the PC position. -@item -Use @code{set architecture i8086} to dump 16 bit code. Then use -@code{x/10i $cs*16+$eip} to dump the code at the PC position. -@end enumerate - -Advanced debugging options: - -The default single stepping behavior is step with the IRQs and timer service routines off. It is set this way because when gdb executes a single step it expects to advance beyond the current instruction. With the IRQs and timer service routines on, a single step might jump into the one of the interrupt or exception vectors instead of executing the current instruction. This means you may hit the same breakpoint a number of times before executing the instruction gdb wants to have executed. Because there are rare circumstances where you want to single step into an interrupt vector the behavior can be controlled from GDB. There are three commands you can query and set the single step behavior: -@table @code -@item maintenance packet qqemu.sstepbits - -This will display the MASK bits used to control the single stepping IE: -@example -(gdb) maintenance packet qqemu.sstepbits -sending: "qqemu.sstepbits" -received: "ENABLE=1,NOIRQ=2,NOTIMER=4" -@end example -@item maintenance packet qqemu.sstep - -This will display the current value of the mask used when single stepping IE: -@example -(gdb) maintenance packet qqemu.sstep -sending: "qqemu.sstep" -received: "0x7" -@end example -@item maintenance packet Qqemu.sstep=HEX_VALUE - -This will change the single step mask, so if wanted to enable IRQs on the single step, but not timers, you would use: -@example -(gdb) maintenance packet Qqemu.sstep=0x5 -sending: "qemu.sstep=0x5" -received: "OK" -@end example -@end table - diff --git a/docs/system/images.texi b/docs/system/images.texi deleted file mode 100644 index c5060348ec..0000000000 --- a/docs/system/images.texi +++ /dev/null @@ -1,88 +0,0 @@ -@node disk_images -@section Disk Images - -QEMU supports many disk image formats, including growable disk images -(their size increase as non empty sectors are written), compressed and -encrypted disk images. - -@menu -* disk_images_quickstart:: Quick start for disk image creation -* disk_images_snapshot_mode:: Snapshot mode -* vm_snapshots:: VM snapshots -@end menu - -@node disk_images_quickstart -@subsection Quick start for disk image creation - -You can create a disk image with the command: -@example -qemu-img create myimage.img mysize -@end example -where @var{myimage.img} is the disk image filename and @var{mysize} is its -size in kilobytes. You can add an @code{M} suffix to give the size in -megabytes and a @code{G} suffix for gigabytes. - -@c When this document is converted to rst we should make this into -@c a proper linked reference to the qemu-img documentation again: -See the qemu-img invocation documentation for more information. - -@node disk_images_snapshot_mode -@subsection Snapshot mode - -If you use the option @option{-snapshot}, all disk images are -considered as read only. When sectors in written, they are written in -a temporary file created in @file{/tmp}. You can however force the -write back to the raw disk images by using the @code{commit} monitor -command (or @key{C-a s} in the serial console). - -@node vm_snapshots -@subsection VM snapshots - -VM snapshots are snapshots of the complete virtual machine including -CPU state, RAM, device state and the content of all the writable -disks. In order to use VM snapshots, you must have at least one non -removable and writable block device using the @code{qcow2} disk image -format. Normally this device is the first virtual hard drive. - -Use the monitor command @code{savevm} to create a new VM snapshot or -replace an existing one. A human readable name can be assigned to each -snapshot in addition to its numerical ID. - -Use @code{loadvm} to restore a VM snapshot and @code{delvm} to remove -a VM snapshot. @code{info snapshots} lists the available snapshots -with their associated information: - -@example -(qemu) info snapshots -Snapshot devices: hda -Snapshot list (from hda): -ID TAG VM SIZE DATE VM CLOCK -1 start 41M 2006-08-06 12:38:02 00:00:14.954 -2 40M 2006-08-06 12:43:29 00:00:18.633 -3 msys 40M 2006-08-06 12:44:04 00:00:23.514 -@end example - -A VM snapshot is made of a VM state info (its size is shown in -@code{info snapshots}) and a snapshot of every writable disk image. -The VM state info is stored in the first @code{qcow2} non removable -and writable block device. The disk image snapshots are stored in -every disk image. The size of a snapshot in a disk image is difficult -to evaluate and is not shown by @code{info snapshots} because the -associated disk sectors are shared among all the snapshots to save -disk space (otherwise each snapshot would need a full copy of all the -disk images). - -When using the (unrelated) @code{-snapshot} option -(@ref{disk_images_snapshot_mode}), you can always make VM snapshots, -but they are deleted as soon as you exit QEMU. - -VM snapshots currently have the following known limitations: -@itemize -@item -They cannot cope with removable devices if they are removed or -inserted after a snapshot is done. -@item -A few device drivers still have incomplete snapshot support so their -state is not saved or restored properly (in particular USB). -@end itemize - diff --git a/docs/system/invocation.texi b/docs/system/invocation.texi deleted file mode 100644 index dac41cc7e5..0000000000 --- a/docs/system/invocation.texi +++ /dev/null @@ -1,240 +0,0 @@ -@node sec_invocation -@section Invocation - -@example -@c man begin SYNOPSIS -@command{@value{qemu_system}} [@var{options}] [@var{disk_image}] -@c man end -@end example - -@c man begin OPTIONS -@var{disk_image} is a raw hard disk image for IDE hard disk 0. Some -targets do not need a disk image. - -@include qemu-options.texi - -@c man end - -@subsection Device URL Syntax -@c TODO merge this with section Disk Images - -@c man begin NOTES - -In addition to using normal file images for the emulated storage devices, -QEMU can also use networked resources such as iSCSI devices. These are -specified using a special URL syntax. - -@table @option -@item iSCSI -iSCSI support allows QEMU to access iSCSI resources directly and use as -images for the guest storage. Both disk and cdrom images are supported. - -Syntax for specifying iSCSI LUNs is -``iscsi://[:]//'' - -By default qemu will use the iSCSI initiator-name -'iqn.2008-11.org.linux-kvm[:]' but this can also be set from the command -line or a configuration file. - -Since version Qemu 2.4 it is possible to specify a iSCSI request timeout to detect -stalled requests and force a reestablishment of the session. The timeout -is specified in seconds. The default is 0 which means no timeout. Libiscsi -1.15.0 or greater is required for this feature. - -Example (without authentication): -@example -@value{qemu_system} -iscsi initiator-name=iqn.2001-04.com.example:my-initiator \ - -cdrom iscsi://192.0.2.1/iqn.2001-04.com.example/2 \ - -drive file=iscsi://192.0.2.1/iqn.2001-04.com.example/1 -@end example - -Example (CHAP username/password via URL): -@example -@value{qemu_system} -drive file=iscsi://user%password@@192.0.2.1/iqn.2001-04.com.example/1 -@end example - -Example (CHAP username/password via environment variables): -@example -LIBISCSI_CHAP_USERNAME="user" \ -LIBISCSI_CHAP_PASSWORD="password" \ -@value{qemu_system} -drive file=iscsi://192.0.2.1/iqn.2001-04.com.example/1 -@end example - -@item NBD -QEMU supports NBD (Network Block Devices) both using TCP protocol as well -as Unix Domain Sockets. With TCP, the default port is 10809. - -Syntax for specifying a NBD device using TCP, in preferred URI form: -``nbd://[:]/[]'' - -Syntax for specifying a NBD device using Unix Domain Sockets; remember -that '?' is a shell glob character and may need quoting: -``nbd+unix:///[]?socket='' - -Older syntax that is also recognized: -``nbd::[:exportname=]'' - -Syntax for specifying a NBD device using Unix Domain Sockets -``nbd:unix:[:exportname=]'' - -Example for TCP -@example -@value{qemu_system} --drive file=nbd:192.0.2.1:30000 -@end example - -Example for Unix Domain Sockets -@example -@value{qemu_system} --drive file=nbd:unix:/tmp/nbd-socket -@end example - -@item SSH -QEMU supports SSH (Secure Shell) access to remote disks. - -Examples: -@example -@value{qemu_system} -drive file=ssh://user@@host/path/to/disk.img -@value{qemu_system} -drive file.driver=ssh,file.user=user,file.host=host,file.port=22,file.path=/path/to/disk.img -@end example - -Currently authentication must be done using ssh-agent. Other -authentication methods may be supported in future. - -@item Sheepdog -Sheepdog is a distributed storage system for QEMU. -QEMU supports using either local sheepdog devices or remote networked -devices. - -Syntax for specifying a sheepdog device -@example -sheepdog[+tcp|+unix]://[host:port]/vdiname[?socket=path][#snapid|#tag] -@end example - -Example -@example -@value{qemu_system} --drive file=sheepdog://192.0.2.1:30000/MyVirtualMachine -@end example - -See also @url{https://sheepdog.github.io/sheepdog/}. - -@item GlusterFS -GlusterFS is a user space distributed file system. -QEMU supports the use of GlusterFS volumes for hosting VM disk images using -TCP, Unix Domain Sockets and RDMA transport protocols. - -Syntax for specifying a VM disk image on GlusterFS volume is -@example - -URI: -gluster[+type]://[host[:port]]/volume/path[?socket=...][,debug=N][,logfile=...] - -JSON: -'json:@{"driver":"qcow2","file":@{"driver":"gluster","volume":"testvol","path":"a.img","debug":N,"logfile":"...", -@ "server":[@{"type":"tcp","host":"...","port":"..."@}, -@ @{"type":"unix","socket":"..."@}]@}@}' -@end example - - -Example -@example -URI: -@value{qemu_system} --drive file=gluster://192.0.2.1/testvol/a.img, -@ file.debug=9,file.logfile=/var/log/qemu-gluster.log - -JSON: -@value{qemu_system} 'json:@{"driver":"qcow2", -@ "file":@{"driver":"gluster", -@ "volume":"testvol","path":"a.img", -@ "debug":9,"logfile":"/var/log/qemu-gluster.log", -@ "server":[@{"type":"tcp","host":"1.2.3.4","port":24007@}, -@ @{"type":"unix","socket":"/var/run/glusterd.socket"@}]@}@}' -@value{qemu_system} -drive driver=qcow2,file.driver=gluster,file.volume=testvol,file.path=/path/a.img, -@ file.debug=9,file.logfile=/var/log/qemu-gluster.log, -@ file.server.0.type=tcp,file.server.0.host=1.2.3.4,file.server.0.port=24007, -@ file.server.1.type=unix,file.server.1.socket=/var/run/glusterd.socket -@end example - -See also @url{http://www.gluster.org}. - -@item HTTP/HTTPS/FTP/FTPS -QEMU supports read-only access to files accessed over http(s) and ftp(s). - -Syntax using a single filename: -@example -://[[:]@@]/ -@end example - -where: -@table @option -@item protocol -'http', 'https', 'ftp', or 'ftps'. - -@item username -Optional username for authentication to the remote server. - -@item password -Optional password for authentication to the remote server. - -@item host -Address of the remote server. - -@item path -Path on the remote server, including any query string. -@end table - -The following options are also supported: -@table @option -@item url -The full URL when passing options to the driver explicitly. - -@item readahead -The amount of data to read ahead with each range request to the remote server. -This value may optionally have the suffix 'T', 'G', 'M', 'K', 'k' or 'b'. If it -does not have a suffix, it will be assumed to be in bytes. The value must be a -multiple of 512 bytes. It defaults to 256k. - -@item sslverify -Whether to verify the remote server's certificate when connecting over SSL. It -can have the value 'on' or 'off'. It defaults to 'on'. - -@item cookie -Send this cookie (it can also be a list of cookies separated by ';') with -each outgoing request. Only supported when using protocols such as HTTP -which support cookies, otherwise ignored. - -@item timeout -Set the timeout in seconds of the CURL connection. This timeout is the time -that CURL waits for a response from the remote server to get the size of the -image to be downloaded. If not set, the default timeout of 5 seconds is used. -@end table - -Note that when passing options to qemu explicitly, @option{driver} is the value -of . - -Example: boot from a remote Fedora 20 live ISO image -@example -@value{qemu_system_x86} --drive media=cdrom,file=https://archives.fedoraproject.org/pub/archive/fedora/linux/releases/20/Live/x86_64/Fedora-Live-Desktop-x86_64-20-1.iso,readonly - -@value{qemu_system_x86} --drive media=cdrom,file.driver=http,file.url=http://archives.fedoraproject.org/pub/fedora/linux/releases/20/Live/x86_64/Fedora-Live-Desktop-x86_64-20-1.iso,readonly -@end example - -Example: boot from a remote Fedora 20 cloud image using a local overlay for -writes, copy-on-read, and a readahead of 64k -@example -qemu-img create -f qcow2 -o backing_file='json:@{"file.driver":"http",, "file.url":"http://archives.fedoraproject.org/pub/archive/fedora/linux/releases/20/Images/x86_64/Fedora-x86_64-20-20131211.1-sda.qcow2",, "file.readahead":"64k"@}' /tmp/Fedora-x86_64-20-20131211.1-sda.qcow2 - -@value{qemu_system_x86} -drive file=/tmp/Fedora-x86_64-20-20131211.1-sda.qcow2,copy-on-read=on -@end example - -Example: boot from an image stored on a VMware vSphere server with a self-signed -certificate using a local overlay for writes, a readahead of 64k and a timeout -of 10 seconds. -@example -qemu-img create -f qcow2 -o backing_file='json:@{"file.driver":"https",, "file.url":"https://user:password@@vsphere.example.com/folder/test/test-flat.vmdk?dcPath=Datacenter&dsName=datastore1",, "file.sslverify":"off",, "file.readahead":"64k",, "file.timeout":10@}' /tmp/test.qcow2 - -@value{qemu_system_x86} -drive file=/tmp/test.qcow2 -@end example - -@end table - -@c man end - diff --git a/docs/system/ivshmem.texi b/docs/system/ivshmem.texi deleted file mode 100644 index bd97719eaf..0000000000 --- a/docs/system/ivshmem.texi +++ /dev/null @@ -1,60 +0,0 @@ -@node pcsys_ivshmem -@section Inter-VM Shared Memory device - -On Linux hosts, a shared memory device is available. The basic syntax -is: - -@example -@value{qemu_system_x86} -device ivshmem-plain,memdev=@var{hostmem} -@end example - -where @var{hostmem} names a host memory backend. For a POSIX shared -memory backend, use something like - -@example --object memory-backend-file,size=1M,share,mem-path=/dev/shm/ivshmem,id=@var{hostmem} -@end example - -If desired, interrupts can be sent between guest VMs accessing the same shared -memory region. Interrupt support requires using a shared memory server and -using a chardev socket to connect to it. The code for the shared memory server -is qemu.git/contrib/ivshmem-server. An example syntax when using the shared -memory server is: - -@example -# First start the ivshmem server once and for all -ivshmem-server -p @var{pidfile} -S @var{path} -m @var{shm-name} -l @var{shm-size} -n @var{vectors} - -# Then start your qemu instances with matching arguments -@value{qemu_system_x86} -device ivshmem-doorbell,vectors=@var{vectors},chardev=@var{id} - -chardev socket,path=@var{path},id=@var{id} -@end example - -When using the server, the guest will be assigned a VM ID (>=0) that allows guests -using the same server to communicate via interrupts. Guests can read their -VM ID from a device register (see ivshmem-spec.txt). - -@subsection Migration with ivshmem - -With device property @option{master=on}, the guest will copy the shared -memory on migration to the destination host. With @option{master=off}, -the guest will not be able to migrate with the device attached. In the -latter case, the device should be detached and then reattached after -migration using the PCI hotplug support. - -At most one of the devices sharing the same memory can be master. The -master must complete migration before you plug back the other devices. - -@subsection ivshmem and hugepages - -Instead of specifying the using POSIX shm, you may specify -a memory backend that has hugepage support: - -@example -@value{qemu_system_x86} -object memory-backend-file,size=1G,mem-path=/dev/hugepages/my-shmem-file,share,id=mb1 - -device ivshmem-plain,memdev=mb1 -@end example - -ivshmem-server also supports hugepages mount points with the -@option{-m} memory path argument. - diff --git a/docs/system/keys.texi b/docs/system/keys.texi deleted file mode 100644 index c04daf54f2..0000000000 --- a/docs/system/keys.texi +++ /dev/null @@ -1,43 +0,0 @@ -@node pcsys_keys -@section Keys in the graphical frontends - -@c man begin OPTIONS - -During the graphical emulation, you can use special key combinations to change -modes. The default key mappings are shown below, but if you use @code{-alt-grab} -then the modifier is Ctrl-Alt-Shift (instead of Ctrl-Alt) and if you use -@code{-ctrl-grab} then the modifier is the right Ctrl key (instead of Ctrl-Alt): - -@table @key -@item Ctrl-Alt-f -Toggle full screen - -@item Ctrl-Alt-+ -Enlarge the screen - -@item Ctrl-Alt-- -Shrink the screen - -@item Ctrl-Alt-u -Restore the screen's un-scaled dimensions - -@item Ctrl-Alt-n -Switch to virtual console 'n'. Standard console mappings are: -@table @emph -@item 1 -Target system display -@item 2 -Monitor -@item 3 -Serial port -@end table - -@item Ctrl-Alt -Toggle mouse and keyboard grab. -@end table - -In the virtual consoles, you can use @key{Ctrl-Up}, @key{Ctrl-Down}, -@key{Ctrl-PageUp} and @key{Ctrl-PageDown} to move in the back log. - -@c man end - diff --git a/docs/system/license.texi b/docs/system/license.texi deleted file mode 100644 index b682235a7e..0000000000 --- a/docs/system/license.texi +++ /dev/null @@ -1,9 +0,0 @@ -@node License -@appendix License - -QEMU is a trademark of Fabrice Bellard. - -QEMU is released under the -@url{https://www.gnu.org/licenses/gpl-2.0.txt,GNU General Public License}, -version 2. Parts of QEMU have specific licenses, see file -@url{https://git.qemu.org/?p=qemu.git;a=blob_plain;f=LICENSE,LICENSE}. diff --git a/docs/system/linuxboot.texi b/docs/system/linuxboot.texi deleted file mode 100644 index 97c3cefae0..0000000000 --- a/docs/system/linuxboot.texi +++ /dev/null @@ -1,27 +0,0 @@ -@node direct_linux_boot -@section Direct Linux Boot - -This section explains how to launch a Linux kernel inside QEMU without -having to make a full bootable image. It is very useful for fast Linux -kernel testing. - -The syntax is: -@example -@value{qemu_system} -kernel bzImage -hda rootdisk.img -append "root=/dev/hda" -@end example - -Use @option{-kernel} to provide the Linux kernel image and -@option{-append} to give the kernel command line arguments. The -@option{-initrd} option can be used to provide an INITRD image. - -If you do not need graphical output, you can disable it and redirect -the virtual serial port and the QEMU monitor to the console with the -@option{-nographic} option. The typical command line is: -@example -@value{qemu_system} -kernel bzImage -hda rootdisk.img \ - -append "root=/dev/hda console=ttyS0" -nographic -@end example - -Use @key{Ctrl-a c} to switch between the serial console and the -monitor (@pxref{pcsys_keys}). - diff --git a/docs/system/managed-startup.texi b/docs/system/managed-startup.texi deleted file mode 100644 index ec168095cc..0000000000 --- a/docs/system/managed-startup.texi +++ /dev/null @@ -1,35 +0,0 @@ -@node managed_startup -@section Managed start up options - -In system mode emulation, it's possible to create a VM in a paused state using -the -S command line option. In this state the machine is completely initialized -according to command line options and ready to execute VM code but VCPU threads -are not executing any code. The VM state in this paused state depends on the way -QEMU was started. It could be in: -@table @asis -@item initial state (after reset/power on state) -@item with direct kernel loading, the initial state could be amended to execute -code loaded by QEMU in the VM's RAM and with incoming migration -@item with incoming migration, initial state will by amended with the migrated -machine state after migration completes. -@end table - -This paused state is typically used by users to query machine state and/or -additionally configure the machine (by hotplugging devices) in runtime before -allowing VM code to run. - -However, at the -S pause point, it's impossible to configure options that affect -initial VM creation (like: -smp/-m/-numa ...) or cold plug devices. The -experimental --preconfig command line option allows pausing QEMU -before the initial VM creation, in a ``preconfig'' state, where additional -queries and configuration can be performed via QMP before moving on to -the resulting configuration startup. In the preconfig state, QEMU only allows -a limited set of commands over the QMP monitor, where the commands do not -depend on an initialized machine, including but not limited to: -@table @asis -@item qmp_capabilities -@item query-qmp-schema -@item query-commands -@item query-status -@item x-exit-preconfig -@end table diff --git a/docs/system/monitor.texi b/docs/system/monitor.texi deleted file mode 100644 index b41b144885..0000000000 --- a/docs/system/monitor.texi +++ /dev/null @@ -1,34 +0,0 @@ -@node pcsys_monitor -@section QEMU Monitor - -The QEMU monitor is used to give complex commands to the QEMU -emulator. You can use it to: - -@itemize @minus - -@item -Remove or insert removable media images -(such as CD-ROM or floppies). - -@item -Freeze/unfreeze the Virtual Machine (VM) and save or restore its state -from a disk file. - -@item Inspect the VM state without an external debugger. - -@end itemize - -@subsection Commands - -The following commands are available: - -@include qemu-monitor.texi - -@include qemu-monitor-info.texi - -@subsection Integer expressions - -The monitor understands integers expressions for every integer -argument. You can use register names to get the value of specifics -CPU registers by prefixing them with @emph{$}. - diff --git a/docs/system/mux-chardev.texi b/docs/system/mux-chardev.texi deleted file mode 100644 index b21c2c5654..0000000000 --- a/docs/system/mux-chardev.texi +++ /dev/null @@ -1,44 +0,0 @@ -@node mux_keys -@section Keys in the character backend multiplexer - -@c man begin OPTIONS - -During emulation, if you are using a character backend multiplexer -(which is the default if you are using @option{-nographic}) then -several commands are available via an escape sequence. These -key sequences all start with an escape character, which is @key{Ctrl-a} -by default, but can be changed with @option{-echr}. The list below assumes -you're using the default. - -@table @key -@item Ctrl-a h -Print this help -@item Ctrl-a x -Exit emulator -@item Ctrl-a s -Save disk data back to file (if -snapshot) -@item Ctrl-a t -Toggle console timestamps -@item Ctrl-a b -Send break (magic sysrq in Linux) -@item Ctrl-a c -Rotate between the frontends connected to the multiplexer (usually -this switches between the monitor and the console) -@item Ctrl-a Ctrl-a -Send the escape character to the frontend -@end table -@c man end - -@ignore - -@c man begin SEEALSO -The HTML documentation of QEMU for more precise information and Linux -user mode emulator invocation. -@c man end - -@c man begin AUTHOR -Fabrice Bellard -@c man end - -@end ignore - diff --git a/docs/system/net.texi b/docs/system/net.texi deleted file mode 100644 index 4a6fb2e6a8..0000000000 --- a/docs/system/net.texi +++ /dev/null @@ -1,96 +0,0 @@ -@node pcsys_network -@section Network emulation - -QEMU can simulate several network cards (e.g. PCI or ISA cards on the PC -target) and can connect them to a network backend on the host or an emulated -hub. The various host network backends can either be used to connect the NIC of -the guest to a real network (e.g. by using a TAP devices or the non-privileged -user mode network stack), or to other guest instances running in another QEMU -process (e.g. by using the socket host network backend). - -@subsection Using TAP network interfaces - -This is the standard way to connect QEMU to a real network. QEMU adds -a virtual network device on your host (called @code{tapN}), and you -can then configure it as if it was a real ethernet card. - -@subsubsection Linux host - -As an example, you can download the @file{linux-test-xxx.tar.gz} -archive and copy the script @file{qemu-ifup} in @file{/etc} and -configure properly @code{sudo} so that the command @code{ifconfig} -contained in @file{qemu-ifup} can be executed as root. You must verify -that your host kernel supports the TAP network interfaces: the -device @file{/dev/net/tun} must be present. - -See @ref{sec_invocation} to have examples of command lines using the -TAP network interfaces. - -@subsubsection Windows host - -There is a virtual ethernet driver for Windows 2000/XP systems, called -TAP-Win32. But it is not included in standard QEMU for Windows, -so you will need to get it separately. It is part of OpenVPN package, -so download OpenVPN from : @url{https://openvpn.net/}. - -@subsection Using the user mode network stack - -By using the option @option{-net user} (default configuration if no -@option{-net} option is specified), QEMU uses a completely user mode -network stack (you don't need root privilege to use the virtual -network). The virtual network configuration is the following: - -@example - - guest (10.0.2.15) <------> Firewall/DHCP server <-----> Internet - | (10.0.2.2) - | - ----> DNS server (10.0.2.3) - | - ----> SMB server (10.0.2.4) -@end example - -The QEMU VM behaves as if it was behind a firewall which blocks all -incoming connections. You can use a DHCP client to automatically -configure the network in the QEMU VM. The DHCP server assign addresses -to the hosts starting from 10.0.2.15. - -In order to check that the user mode network is working, you can ping -the address 10.0.2.2 and verify that you got an address in the range -10.0.2.x from the QEMU virtual DHCP server. - -Note that ICMP traffic in general does not work with user mode networking. -@code{ping}, aka. ICMP echo, to the local router (10.0.2.2) shall work, -however. If you're using QEMU on Linux >= 3.0, it can use unprivileged ICMP -ping sockets to allow @code{ping} to the Internet. The host admin has to set -the ping_group_range in order to grant access to those sockets. To allow ping -for GID 100 (usually users group): - -@example -echo 100 100 > /proc/sys/net/ipv4/ping_group_range -@end example - -When using the built-in TFTP server, the router is also the TFTP -server. - -When using the @option{'-netdev user,hostfwd=...'} option, TCP or UDP -connections can be redirected from the host to the guest. It allows for -example to redirect X11, telnet or SSH connections. - -@subsection Hubs - -QEMU can simulate several hubs. A hub can be thought of as a virtual connection -between several network devices. These devices can be for example QEMU virtual -ethernet cards or virtual Host ethernet devices (TAP devices). You can connect -guest NICs or host network backends to such a hub using the @option{-netdev -hubport} or @option{-nic hubport} options. The legacy @option{-net} option -also connects the given device to the emulated hub with ID 0 (i.e. the default -hub) unless you specify a netdev with @option{-net nic,netdev=xxx} here. - -@subsection Connecting emulated networks between QEMU instances - -Using the @option{-netdev socket} (or @option{-nic socket} or -@option{-net socket}) option, it is possible to create emulated -networks that span several QEMU instances. -See the description of the @option{-netdev socket} option in the -@ref{sec_invocation,,Invocation chapter} to have a basic example. diff --git a/docs/system/qemu-option-trace.texi b/docs/system/qemu-option-trace.texi deleted file mode 100644 index 162f1528d2..0000000000 --- a/docs/system/qemu-option-trace.texi +++ /dev/null @@ -1,28 +0,0 @@ -@c The contents of this file must be kept in sync with qemu-option-trace.rst.inc -@c until all the users of the texi file have been converted to rst and -@c the texi file can be removed. - -Specify tracing options. - -@table @option -@item [enable=]@var{pattern} -Immediately enable events matching @var{pattern} -(either event name or a globbing pattern). This option is only -available if QEMU has been compiled with the @var{simple}, @var{log} -or @var{ftrace} tracing backend. To specify multiple events or patterns, -specify the @option{-trace} option multiple times. - -Use @code{-trace help} to print a list of names of trace points. - -@item events=@var{file} -Immediately enable events listed in @var{file}. -The file must contain one event name (as listed in the @file{trace-events-all} -file) per line; globbing patterns are accepted too. This option is only -available if QEMU has been compiled with the @var{simple}, @var{log} or -@var{ftrace} tracing backend. - -@item file=@var{file} -Log output traces to @var{file}. -This option is only available if QEMU has been compiled with -the @var{simple} tracing backend. -@end table diff --git a/docs/system/quickstart.texi b/docs/system/quickstart.texi deleted file mode 100644 index baceaa96eb..0000000000 --- a/docs/system/quickstart.texi +++ /dev/null @@ -1,12 +0,0 @@ -@node pcsys_quickstart -@section Quick Start - -Download and uncompress a PC hard disk image with Linux installed (e.g. -@file{linux.img}) and type: - -@example -@value{qemu_system} linux.img -@end example - -Linux should boot and give you a prompt. - diff --git a/docs/system/security.texi b/docs/system/security.texi deleted file mode 100644 index 0d6b30edfc..0000000000 --- a/docs/system/security.texi +++ /dev/null @@ -1,167 +0,0 @@ -@node Security -@chapter Security - -@section Overview - -This chapter explains the security requirements that QEMU is designed to meet -and principles for securely deploying QEMU. - -@section Security Requirements - -QEMU supports many different use cases, some of which have stricter security -requirements than others. The community has agreed on the overall security -requirements that users may depend on. These requirements define what is -considered supported from a security perspective. - -@subsection Virtualization Use Case - -The virtualization use case covers cloud and virtual private server (VPS) -hosting, as well as traditional data center and desktop virtualization. These -use cases rely on hardware virtualization extensions to execute guest code -safely on the physical CPU at close-to-native speed. - -The following entities are untrusted, meaning that they may be buggy or -malicious: - -@itemize -@item Guest -@item User-facing interfaces (e.g. VNC, SPICE, WebSocket) -@item Network protocols (e.g. NBD, live migration) -@item User-supplied files (e.g. disk images, kernels, device trees) -@item Passthrough devices (e.g. PCI, USB) -@end itemize - -Bugs affecting these entities are evaluated on whether they can cause damage in -real-world use cases and treated as security bugs if this is the case. - -@subsection Non-virtualization Use Case - -The non-virtualization use case covers emulation using the Tiny Code Generator -(TCG). In principle the TCG and device emulation code used in conjunction with -the non-virtualization use case should meet the same security requirements as -the virtualization use case. However, for historical reasons much of the -non-virtualization use case code was not written with these security -requirements in mind. - -Bugs affecting the non-virtualization use case are not considered security -bugs at this time. Users with non-virtualization use cases must not rely on -QEMU to provide guest isolation or any security guarantees. - -@section Architecture - -This section describes the design principles that ensure the security -requirements are met. - -@subsection Guest Isolation - -Guest isolation is the confinement of guest code to the virtual machine. When -guest code gains control of execution on the host this is called escaping the -virtual machine. Isolation also includes resource limits such as throttling of -CPU, memory, disk, or network. Guests must be unable to exceed their resource -limits. - -QEMU presents an attack surface to the guest in the form of emulated devices. -The guest must not be able to gain control of QEMU. Bugs in emulated devices -could allow malicious guests to gain code execution in QEMU. At this point the -guest has escaped the virtual machine and is able to act in the context of the -QEMU process on the host. - -Guests often interact with other guests and share resources with them. A -malicious guest must not gain control of other guests or access their data. -Disk image files and network traffic must be protected from other guests unless -explicitly shared between them by the user. - -@subsection Principle of Least Privilege - -The principle of least privilege states that each component only has access to -the privileges necessary for its function. In the case of QEMU this means that -each process only has access to resources belonging to the guest. - -The QEMU process should not have access to any resources that are inaccessible -to the guest. This way the guest does not gain anything by escaping into the -QEMU process since it already has access to those same resources from within -the guest. - -Following the principle of least privilege immediately fulfills guest isolation -requirements. For example, guest A only has access to its own disk image file -@code{a.img} and not guest B's disk image file @code{b.img}. - -In reality certain resources are inaccessible to the guest but must be -available to QEMU to perform its function. For example, host system calls are -necessary for QEMU but are not exposed to guests. A guest that escapes into -the QEMU process can then begin invoking host system calls. - -New features must be designed to follow the principle of least privilege. -Should this not be possible for technical reasons, the security risk must be -clearly documented so users are aware of the trade-off of enabling the feature. - -@subsection Isolation mechanisms - -Several isolation mechanisms are available to realize this architecture of -guest isolation and the principle of least privilege. With the exception of -Linux seccomp, these mechanisms are all deployed by management tools that -launch QEMU, such as libvirt. They are also platform-specific so they are only -described briefly for Linux here. - -The fundamental isolation mechanism is that QEMU processes must run as -unprivileged users. Sometimes it seems more convenient to launch QEMU as -root to give it access to host devices (e.g. @code{/dev/net/tun}) but this poses a -huge security risk. File descriptor passing can be used to give an otherwise -unprivileged QEMU process access to host devices without running QEMU as root. -It is also possible to launch QEMU as a non-root user and configure UNIX groups -for access to @code{/dev/kvm}, @code{/dev/net/tun}, and other device nodes. -Some Linux distros already ship with UNIX groups for these devices by default. - -@itemize -@item SELinux and AppArmor make it possible to confine processes beyond the -traditional UNIX process and file permissions model. They restrict the QEMU -process from accessing processes and files on the host system that are not -needed by QEMU. - -@item Resource limits and cgroup controllers provide throughput and utilization -limits on key resources such as CPU time, memory, and I/O bandwidth. - -@item Linux namespaces can be used to make process, file system, and other system -resources unavailable to QEMU. A namespaced QEMU process is restricted to only -those resources that were granted to it. - -@item Linux seccomp is available via the QEMU @option{--sandbox} option. It disables -system calls that are not needed by QEMU, thereby reducing the host kernel -attack surface. -@end itemize - -@section Sensitive configurations - -There are aspects of QEMU that can have security implications which users & -management applications must be aware of. - -@subsection Monitor console (QMP and HMP) - -The monitor console (whether used with QMP or HMP) provides an interface -to dynamically control many aspects of QEMU's runtime operation. Many of the -commands exposed will instruct QEMU to access content on the host file system -and/or trigger spawning of external processes. - -For example, the @code{migrate} command allows for the spawning of arbitrary -processes for the purpose of tunnelling the migration data stream. The -@code{blockdev-add} command instructs QEMU to open arbitrary files, exposing -their content to the guest as a virtual disk. - -Unless QEMU is otherwise confined using technologies such as SELinux, AppArmor, -or Linux namespaces, the monitor console should be considered to have privileges -equivalent to those of the user account QEMU is running under. - -It is further important to consider the security of the character device backend -over which the monitor console is exposed. It needs to have protection against -malicious third parties which might try to make unauthorized connections, or -perform man-in-the-middle attacks. Many of the character device backends do not -satisfy this requirement and so must not be used for the monitor console. - -The general recommendation is that the monitor console should be exposed over -a UNIX domain socket backend to the local host only. Use of the TCP based -character device backend is inappropriate unless configured to use both TLS -encryption and authorization control policy on client connections. - -In summary, the monitor console is considered a privileged control interface to -QEMU and as such should only be made accessible to a trusted management -application or user. diff --git a/docs/system/target-arm.texi b/docs/system/target-arm.texi deleted file mode 100644 index eb80dd35f0..0000000000 --- a/docs/system/target-arm.texi +++ /dev/null @@ -1,245 +0,0 @@ -@node ARM System emulator -@section ARM System emulator - -Use the executable @file{qemu-system-arm} to simulate a ARM -machine. The ARM Integrator/CP board is emulated with the following -devices: - -@itemize @minus -@item -ARM926E, ARM1026E, ARM946E, ARM1136 or Cortex-A8 CPU -@item -Two PL011 UARTs -@item -SMC 91c111 Ethernet adapter -@item -PL110 LCD controller -@item -PL050 KMI with PS/2 keyboard and mouse. -@item -PL181 MultiMedia Card Interface with SD card. -@end itemize - -The ARM Versatile baseboard is emulated with the following devices: - -@itemize @minus -@item -ARM926E, ARM1136 or Cortex-A8 CPU -@item -PL190 Vectored Interrupt Controller -@item -Four PL011 UARTs -@item -SMC 91c111 Ethernet adapter -@item -PL110 LCD controller -@item -PL050 KMI with PS/2 keyboard and mouse. -@item -PCI host bridge. Note the emulated PCI bridge only provides access to -PCI memory space. It does not provide access to PCI IO space. -This means some devices (eg. ne2k_pci NIC) are not usable, and others -(eg. rtl8139 NIC) are only usable when the guest drivers use the memory -mapped control registers. -@item -PCI OHCI USB controller. -@item -LSI53C895A PCI SCSI Host Bus Adapter with hard disk and CD-ROM devices. -@item -PL181 MultiMedia Card Interface with SD card. -@end itemize - -Several variants of the ARM RealView baseboard are emulated, -including the EB, PB-A8 and PBX-A9. Due to interactions with the -bootloader, only certain Linux kernel configurations work out -of the box on these boards. - -Kernels for the PB-A8 board should have CONFIG_REALVIEW_HIGH_PHYS_OFFSET -enabled in the kernel, and expect 512M RAM. Kernels for The PBX-A9 board -should have CONFIG_SPARSEMEM enabled, CONFIG_REALVIEW_HIGH_PHYS_OFFSET -disabled and expect 1024M RAM. - -The following devices are emulated: - -@itemize @minus -@item -ARM926E, ARM1136, ARM11MPCore, Cortex-A8 or Cortex-A9 MPCore CPU -@item -ARM AMBA Generic/Distributed Interrupt Controller -@item -Four PL011 UARTs -@item -SMC 91c111 or SMSC LAN9118 Ethernet adapter -@item -PL110 LCD controller -@item -PL050 KMI with PS/2 keyboard and mouse -@item -PCI host bridge -@item -PCI OHCI USB controller -@item -LSI53C895A PCI SCSI Host Bus Adapter with hard disk and CD-ROM devices -@item -PL181 MultiMedia Card Interface with SD card. -@end itemize - -The XScale-based clamshell PDA models ("Spitz", "Akita", "Borzoi" -and "Terrier") emulation includes the following peripherals: - -@itemize @minus -@item -Intel PXA270 System-on-chip (ARM V5TE core) -@item -NAND Flash memory -@item -IBM/Hitachi DSCM microdrive in a PXA PCMCIA slot - not in "Akita" -@item -On-chip OHCI USB controller -@item -On-chip LCD controller -@item -On-chip Real Time Clock -@item -TI ADS7846 touchscreen controller on SSP bus -@item -Maxim MAX1111 analog-digital converter on I@math{^2}C bus -@item -GPIO-connected keyboard controller and LEDs -@item -Secure Digital card connected to PXA MMC/SD host -@item -Three on-chip UARTs -@item -WM8750 audio CODEC on I@math{^2}C and I@math{^2}S busses -@end itemize - -The Palm Tungsten|E PDA (codename "Cheetah") emulation includes the -following elements: - -@itemize @minus -@item -Texas Instruments OMAP310 System-on-chip (ARM 925T core) -@item -ROM and RAM memories (ROM firmware image can be loaded with -option-rom) -@item -On-chip LCD controller -@item -On-chip Real Time Clock -@item -TI TSC2102i touchscreen controller / analog-digital converter / Audio -CODEC, connected through MicroWire and I@math{^2}S busses -@item -GPIO-connected matrix keypad -@item -Secure Digital card connected to OMAP MMC/SD host -@item -Three on-chip UARTs -@end itemize - -Nokia N800 and N810 internet tablets (known also as RX-34 and RX-44 / 48) -emulation supports the following elements: - -@itemize @minus -@item -Texas Instruments OMAP2420 System-on-chip (ARM 1136 core) -@item -RAM and non-volatile OneNAND Flash memories -@item -Display connected to EPSON remote framebuffer chip and OMAP on-chip -display controller and a LS041y3 MIPI DBI-C controller -@item -TI TSC2301 (in N800) and TI TSC2005 (in N810) touchscreen controllers -driven through SPI bus -@item -National Semiconductor LM8323-controlled qwerty keyboard driven -through I@math{^2}C bus -@item -Secure Digital card connected to OMAP MMC/SD host -@item -Three OMAP on-chip UARTs and on-chip STI debugging console -@item -Mentor Graphics "Inventra" dual-role USB controller embedded in a TI -TUSB6010 chip - only USB host mode is supported -@item -TI TMP105 temperature sensor driven through I@math{^2}C bus -@item -TI TWL92230C power management companion with an RTC on I@math{^2}C bus -@item -Nokia RETU and TAHVO multi-purpose chips with an RTC, connected -through CBUS -@end itemize - -The Luminary Micro Stellaris LM3S811EVB emulation includes the following -devices: - -@itemize @minus -@item -Cortex-M3 CPU core. -@item -64k Flash and 8k SRAM. -@item -Timers, UARTs, ADC and I@math{^2}C interface. -@item -OSRAM Pictiva 96x16 OLED with SSD0303 controller on I@math{^2}C bus. -@end itemize - -The Luminary Micro Stellaris LM3S6965EVB emulation includes the following -devices: - -@itemize @minus -@item -Cortex-M3 CPU core. -@item -256k Flash and 64k SRAM. -@item -Timers, UARTs, ADC, I@math{^2}C and SSI interfaces. -@item -OSRAM Pictiva 128x64 OLED with SSD0323 controller connected via SSI. -@end itemize - -The Freecom MusicPal internet radio emulation includes the following -elements: - -@itemize @minus -@item -Marvell MV88W8618 ARM core. -@item -32 MB RAM, 256 KB SRAM, 8 MB flash. -@item -Up to 2 16550 UARTs -@item -MV88W8xx8 Ethernet controller -@item -MV88W8618 audio controller, WM8750 CODEC and mixer -@item -128×64 display with brightness control -@item -2 buttons, 2 navigation wheels with button function -@end itemize - -The Siemens SX1 models v1 and v2 (default) basic emulation. -The emulation includes the following elements: - -@itemize @minus -@item -Texas Instruments OMAP310 System-on-chip (ARM 925T core) -@item -ROM and RAM memories (ROM firmware image can be loaded with -pflash) -V1 -1 Flash of 16MB and 1 Flash of 8MB -V2 -1 Flash of 32MB -@item -On-chip LCD controller -@item -On-chip Real Time Clock -@item -Secure Digital card connected to OMAP MMC/SD host -@item -Three on-chip UARTs -@end itemize - -A Linux 2.6 test image is available on the QEMU web site. More -information is available in the QEMU mailing-list archive. - diff --git a/docs/system/target-i386.texi b/docs/system/target-i386.texi deleted file mode 100644 index cc352b89a8..0000000000 --- a/docs/system/target-i386.texi +++ /dev/null @@ -1,91 +0,0 @@ -@node x86 (PC) System emulator -@section x86 (PC) System emulator - -@menu -* pcsys_devices:: Peripherals -* cpu_models_x86:: CPU models -* pcsys_req:: OS requirements -@end menu - -@node pcsys_devices -@subsection Peripherals - -@c man begin DESCRIPTION - -The QEMU PC System emulator simulates the following peripherals: - -@itemize @minus -@item -i440FX host PCI bridge and PIIX3 PCI to ISA bridge -@item -Cirrus CLGD 5446 PCI VGA card or dummy VGA card with Bochs VESA -extensions (hardware level, including all non standard modes). -@item -PS/2 mouse and keyboard -@item -2 PCI IDE interfaces with hard disk and CD-ROM support -@item -Floppy disk -@item -PCI and ISA network adapters -@item -Serial ports -@item -IPMI BMC, either and internal or external one -@item -Creative SoundBlaster 16 sound card -@item -ENSONIQ AudioPCI ES1370 sound card -@item -Intel 82801AA AC97 Audio compatible sound card -@item -Intel HD Audio Controller and HDA codec -@item -Adlib (OPL2) - Yamaha YM3812 compatible chip -@item -Gravis Ultrasound GF1 sound card -@item -CS4231A compatible sound card -@item -PCI UHCI, OHCI, EHCI or XHCI USB controller and a virtual USB-1.1 hub. -@end itemize - -SMP is supported with up to 255 CPUs. - -QEMU uses the PC BIOS from the Seabios project and the Plex86/Bochs LGPL -VGA BIOS. - -QEMU uses YM3812 emulation by Tatsuyuki Satoh. - -QEMU uses GUS emulation (GUSEMU32 @url{http://www.deinmeister.de/gusemu/}) -by Tibor "TS" Schütz. - -Note that, by default, GUS shares IRQ(7) with parallel ports and so -QEMU must be told to not have parallel ports to have working GUS. - -@example -@value{qemu_system_x86} dos.img -soundhw gus -parallel none -@end example - -Alternatively: -@example -@value{qemu_system_x86} dos.img -device gus,irq=5 -@end example - -Or some other unclaimed IRQ. - -CS4231A is the chip used in Windows Sound System and GUSMAX products - -@c man end - -@lowersections -@include docs/system/cpu-models-x86.texi -@raisesections - -@node pcsys_req -@subsection OS requirements - -On x86_64 hosts, the default set of CPU features enabled by the KVM accelerator -require the host to be running Linux v4.5 or newer. Red Hat Enterprise Linux -7 is also supported, since the required functionality was backported. - diff --git a/docs/system/target-m68k.texi b/docs/system/target-m68k.texi deleted file mode 100644 index dcce7bc8c5..0000000000 --- a/docs/system/target-m68k.texi +++ /dev/null @@ -1,25 +0,0 @@ -@node ColdFire System emulator -@section ColdFire System emulator - -Use the executable @file{qemu-system-m68k} to simulate a ColdFire machine. -The emulator is able to boot a uClinux kernel. - -The M5208EVB emulation includes the following devices: - -@itemize @minus -@item -MCF5208 ColdFire V2 Microprocessor (ISA A+ with EMAC). -@item -Three Two on-chip UARTs. -@item -Fast Ethernet Controller (FEC) -@end itemize - -The AN5206 emulation includes the following devices: - -@itemize @minus -@item -MCF5206 ColdFire V2 Microprocessor. -@item -Two on-chip UARTs. -@end itemize diff --git a/docs/system/target-mips.texi b/docs/system/target-mips.texi deleted file mode 100644 index fe12ee94c7..0000000000 --- a/docs/system/target-mips.texi +++ /dev/null @@ -1,150 +0,0 @@ -@node MIPS System emulator -@section MIPS System emulator - -@menu -* recommendations_cpu_models_MIPS:: Supported CPU model configurations on MIPS hosts -* nanoMIPS System emulator :: -@end menu - -Four executables cover simulation of 32 and 64-bit MIPS systems in -both endian options, @file{qemu-system-mips}, @file{qemu-system-mipsel} -@file{qemu-system-mips64} and @file{qemu-system-mips64el}. -Five different machine types are emulated: - -@itemize @minus -@item -A generic ISA PC-like machine "mips" -@item -The MIPS Malta prototype board "malta" -@item -An ACER Pica "pica61". This machine needs the 64-bit emulator. -@item -MIPS emulator pseudo board "mipssim" -@item -A MIPS Magnum R4000 machine "magnum". This machine needs the 64-bit emulator. -@end itemize - -The generic emulation is supported by Debian 'Etch' and is able to -install Debian into a virtual disk image. The following devices are -emulated: - -@itemize @minus -@item -A range of MIPS CPUs, default is the 24Kf -@item -PC style serial port -@item -PC style IDE disk -@item -NE2000 network card -@end itemize - -The Malta emulation supports the following devices: - -@itemize @minus -@item -Core board with MIPS 24Kf CPU and Galileo system controller -@item -PIIX4 PCI/USB/SMbus controller -@item -The Multi-I/O chip's serial device -@item -PCI network cards (PCnet32 and others) -@item -Malta FPGA serial device -@item -Cirrus (default) or any other PCI VGA graphics card -@end itemize - -The Boston board emulation supports the following devices: - -@itemize @minus -@item -Xilinx FPGA, which includes a PCIe root port and an UART -@item -Intel EG20T PCH connects the I/O peripherals, but only the SATA bus is emulated -@end itemize - -The ACER Pica emulation supports: - -@itemize @minus -@item -MIPS R4000 CPU -@item -PC-style IRQ and DMA controllers -@item -PC Keyboard -@item -IDE controller -@end itemize - -The MIPS Magnum R4000 emulation supports: - -@itemize @minus -@item -MIPS R4000 CPU -@item -PC-style IRQ controller -@item -PC Keyboard -@item -SCSI controller -@item -G364 framebuffer -@end itemize - -The Fulong 2E emulation supports: - -@itemize @minus -@item -Loongson 2E CPU -@item -Bonito64 system controller as North Bridge -@item -VT82C686 chipset as South Bridge -@item -RTL8139D as a network card chipset -@end itemize - -The mipssim pseudo board emulation provides an environment similar -to what the proprietary MIPS emulator uses for running Linux. -It supports: - -@itemize @minus -@item -A range of MIPS CPUs, default is the 24Kf -@item -PC style serial port -@item -MIPSnet network emulation -@end itemize - -@lowersections -@include docs/system/cpu-models-mips.texi -@raisesections - -@node nanoMIPS System emulator -@subsection nanoMIPS System emulator - -Executable @file{qemu-system-mipsel} also covers simulation of -32-bit nanoMIPS system in little endian mode: - -@itemize @minus -@item -nanoMIPS I7200 CPU -@end itemize - -Example of @file{qemu-system-mipsel} usage for nanoMIPS is shown below: - -Download @code{} from @url{https://mipsdistros.mips.com/LinuxDistro/nanomips/buildroot/index.html}. - -Download @code{} from @url{https://mipsdistros.mips.com/LinuxDistro/nanomips/kernels/v4.15.18-432-gb2eb9a8b07a1-20180627102142/index.html}. - -Start system emulation of Malta board with nanoMIPS I7200 CPU: -@example -qemu-system-mipsel -cpu I7200 -kernel @code{} \ - -M malta -serial stdio -m @code{} -hda @code{} \ - -append "mem=256m@@0x0 rw console=ttyS0 vga=cirrus vesa=0x111 root=/dev/sda" -@end example - - diff --git a/docs/system/target-ppc.texi b/docs/system/target-ppc.texi deleted file mode 100644 index 5c83d4f68e..0000000000 --- a/docs/system/target-ppc.texi +++ /dev/null @@ -1,52 +0,0 @@ -@node PowerPC System emulator -@section PowerPC System emulator - -Use the executable @file{qemu-system-ppc} to simulate a complete 40P (PREP) -or PowerMac PowerPC system. - -QEMU emulates the following PowerMac peripherals: - -@itemize @minus -@item -UniNorth or Grackle PCI Bridge -@item -PCI VGA compatible card with VESA Bochs Extensions -@item -2 PMAC IDE interfaces with hard disk and CD-ROM support -@item -NE2000 PCI adapters -@item -Non Volatile RAM -@item -VIA-CUDA with ADB keyboard and mouse. -@end itemize - -QEMU emulates the following 40P (PREP) peripherals: - -@itemize @minus -@item -PCI Bridge -@item -PCI VGA compatible card with VESA Bochs Extensions -@item -2 IDE interfaces with hard disk and CD-ROM support -@item -Floppy disk -@item -PCnet network adapters -@item -Serial port -@item -PREP Non Volatile RAM -@item -PC compatible keyboard and mouse. -@end itemize - -Since version 0.9.1, QEMU uses OpenBIOS @url{https://www.openbios.org/} -for the g3beige and mac99 PowerMac and the 40p machines. OpenBIOS is a free -(GPL v2) portable firmware implementation. The goal is to implement a 100% -IEEE 1275-1994 (referred to as Open Firmware) compliant firmware. - -More information is available at -@url{http://perso.magic.fr/l_indien/qemu-ppc/}. - diff --git a/docs/system/target-sparc.texi b/docs/system/target-sparc.texi deleted file mode 100644 index 99fbf820b4..0000000000 --- a/docs/system/target-sparc.texi +++ /dev/null @@ -1,68 +0,0 @@ -@node Sparc32 System emulator -@section Sparc32 System emulator - -Use the executable @file{qemu-system-sparc} to simulate the following -Sun4m architecture machines: -@itemize @minus -@item -SPARCstation 4 -@item -SPARCstation 5 -@item -SPARCstation 10 -@item -SPARCstation 20 -@item -SPARCserver 600MP -@item -SPARCstation LX -@item -SPARCstation Voyager -@item -SPARCclassic -@item -SPARCbook -@end itemize - -The emulation is somewhat complete. SMP up to 16 CPUs is supported, -but Linux limits the number of usable CPUs to 4. - -QEMU emulates the following sun4m peripherals: - -@itemize @minus -@item -IOMMU -@item -TCX or cgthree Frame buffer -@item -Lance (Am7990) Ethernet -@item -Non Volatile RAM M48T02/M48T08 -@item -Slave I/O: timers, interrupt controllers, Zilog serial ports, keyboard -and power/reset logic -@item -ESP SCSI controller with hard disk and CD-ROM support -@item -Floppy drive (not on SS-600MP) -@item -CS4231 sound device (only on SS-5, not working yet) -@end itemize - -The number of peripherals is fixed in the architecture. Maximum -memory size depends on the machine type, for SS-5 it is 256MB and for -others 2047MB. - -Since version 0.8.2, QEMU uses OpenBIOS -@url{https://www.openbios.org/}. OpenBIOS is a free (GPL v2) portable -firmware implementation. The goal is to implement a 100% IEEE -1275-1994 (referred to as Open Firmware) compliant firmware. - -A sample Linux 2.6 series kernel and ram disk image are available on -the QEMU web site. There are still issues with NetBSD and OpenBSD, but -most kernel versions work. Please note that currently older Solaris kernels -don't work probably due to interface issues between OpenBIOS and -Solaris. - -@c man end - diff --git a/docs/system/target-sparc64.texi b/docs/system/target-sparc64.texi deleted file mode 100644 index d381d3af71..0000000000 --- a/docs/system/target-sparc64.texi +++ /dev/null @@ -1,38 +0,0 @@ -@node Sparc64 System emulator -@section Sparc64 System emulator - -Use the executable @file{qemu-system-sparc64} to simulate a Sun4u -(UltraSPARC PC-like machine), Sun4v (T1 PC-like machine), or generic -Niagara (T1) machine. The Sun4u emulator is mostly complete, being -able to run Linux, NetBSD and OpenBSD in headless (-nographic) mode. The -Sun4v emulator is still a work in progress. - -The Niagara T1 emulator makes use of firmware and OS binaries supplied in the S10image/ directory -of the OpenSPARC T1 project @url{http://download.oracle.com/technetwork/systems/opensparc/OpenSPARCT1_Arch.1.5.tar.bz2} -and is able to boot the disk.s10hw2 Solaris image. -@example -qemu-system-sparc64 -M niagara -L /path-to/S10image/ \ - -nographic -m 256 \ - -drive if=pflash,readonly=on,file=/S10image/disk.s10hw2 -@end example - - -QEMU emulates the following peripherals: - -@itemize @minus -@item -UltraSparc IIi APB PCI Bridge -@item -PCI VGA compatible card with VESA Bochs Extensions -@item -PS/2 mouse and keyboard -@item -Non Volatile RAM M48T59 -@item -PC-compatible serial ports -@item -2 PCI IDE interfaces with hard disk and CD-ROM support -@item -Floppy disk -@end itemize - diff --git a/docs/system/target-xtensa.texi b/docs/system/target-xtensa.texi deleted file mode 100644 index 1e6c04dccd..0000000000 --- a/docs/system/target-xtensa.texi +++ /dev/null @@ -1,35 +0,0 @@ -@node Xtensa System emulator -@section Xtensa System emulator - -Two executables cover simulation of both Xtensa endian options, -@file{qemu-system-xtensa} and @file{qemu-system-xtensaeb}. -Two different machine types are emulated: - -@itemize @minus -@item -Xtensa emulator pseudo board "sim" -@item -Avnet LX60/LX110/LX200 board -@end itemize - -The sim pseudo board emulation provides an environment similar -to one provided by the proprietary Tensilica ISS. -It supports: - -@itemize @minus -@item -A range of Xtensa CPUs, default is the DC232B -@item -Console and filesystem access via semihosting calls -@end itemize - -The Avnet LX60/LX110/LX200 emulation supports: - -@itemize @minus -@item -A range of Xtensa CPUs, default is the DC232B -@item -16550 UART -@item -OpenCores 10/100 Mbps Ethernet MAC -@end itemize diff --git a/docs/system/tls.texi b/docs/system/tls.texi deleted file mode 100644 index c233531d3a..0000000000 --- a/docs/system/tls.texi +++ /dev/null @@ -1,329 +0,0 @@ -@node network_tls -@section TLS setup for network services - -Almost all network services in QEMU have the ability to use TLS for -session data encryption, along with x509 certificates for simple -client authentication. What follows is a description of how to -generate certificates suitable for usage with QEMU, and applies to -the VNC server, character devices with the TCP backend, NBD server -and client, and migration server and client. - -At a high level, QEMU requires certificates and private keys to be -provided in PEM format. Aside from the core fields, the certificates -should include various extension data sets, including v3 basic -constraints data, key purpose, key usage and subject alt name. - -The GnuTLS package includes a command called @code{certtool} which can -be used to easily generate certificates and keys in the required format -with expected data present. Alternatively a certificate management -service may be used. - -At a minimum it is necessary to setup a certificate authority, and -issue certificates to each server. If using x509 certificates for -authentication, then each client will also need to be issued a -certificate. - -Assuming that the QEMU network services will only ever be exposed to -clients on a private intranet, there is no need to use a commercial -certificate authority to create certificates. A self-signed CA is -sufficient, and in fact likely to be more secure since it removes -the ability of malicious 3rd parties to trick the CA into mis-issuing -certs for impersonating your services. The only likely exception -where a commercial CA might be desirable is if enabling the VNC -websockets server and exposing it directly to remote browser clients. -In such a case it might be useful to use a commercial CA to avoid -needing to install custom CA certs in the web browsers. - -The recommendation is for the server to keep its certificates in either -@code{/etc/pki/qemu} or for unprivileged users in @code{$HOME/.pki/qemu}. - -@menu -* tls_generate_ca:: -* tls_generate_server:: -* tls_generate_client:: -* tls_creds_setup:: -* tls_psk:: -@end menu -@node tls_generate_ca -@subsection Setup the Certificate Authority - -This step only needs to be performed once per organization / organizational -unit. First the CA needs a private key. This key must be kept VERY secret -and secure. If this key is compromised the entire trust chain of the certificates -issued with it is lost. - -@example -# certtool --generate-privkey > ca-key.pem -@end example - -To generate a self-signed certificate requires one core piece of information, -the name of the organization. A template file @code{ca.info} should be -populated with the desired data to avoid having to deal with interactive -prompts from certtool: -@example -# cat > ca.info < server-hostNNN.info < server-hostNNN-key.pem -# certtool --generate-certificate \ - --load-ca-certificate ca-cert.pem \ - --load-ca-privkey ca-key.pem \ - --load-privkey server-hostNNN-key.pem \ - --template server-hostNNN.info \ - --outfile server-hostNNN-cert.pem -@end example - -The @code{dns_name} and @code{ip_address} fields in the template are setting -the subject alt name extension data. The @code{tls_www_server} keyword is the -key purpose extension to indicate this certificate is intended for usage in -a web server. Although QEMU network services are not in fact HTTP servers -(except for VNC websockets), setting this key purpose is still recommended. -The @code{encryption_key} and @code{signing_key} keyword is the key usage -extension to indicate this certificate is intended for usage in the data -session. - -The @code{server-hostNNN-key.pem} and @code{server-hostNNN-cert.pem} files -should now be securely copied to the server for which they were generated, -and renamed to @code{server-key.pem} and @code{server-cert.pem} when added -to the @code{/etc/pki/qemu} directory on the target host. The @code{server-key.pem} -file is security sensitive and should be kept protected with file mode 0600 -to prevent disclosure. - -@node tls_generate_client -@subsection Issuing client certificates - -The QEMU x509 TLS credential setup defaults to enabling client verification -using certificates, providing a simple authentication mechanism. If this -default is used, each client also needs to be issued a certificate. The client -certificate contains enough metadata to uniquely identify the client with the -scope of the certificate authority. The client certificate would typically -include fields for organization, state, city, building, etc. - -Once again on the host holding the CA, create template files containing the -information for each client, and use it to issue client certificates. - - -@example -# cat > client-hostNNN.info < client-hostNNN-key.pem -# certtool --generate-certificate \ - --load-ca-certificate ca-cert.pem \ - --load-ca-privkey ca-key.pem \ - --load-privkey client-hostNNN-key.pem \ - --template client-hostNNN.info \ - --outfile client-hostNNN-cert.pem -@end example - -The subject alt name extension data is not required for clients, so the -the @code{dns_name} and @code{ip_address} fields are not included. -The @code{tls_www_client} keyword is the key purpose extension to indicate -this certificate is intended for usage in a web client. Although QEMU -network clients are not in fact HTTP clients, setting this key purpose is -still recommended. The @code{encryption_key} and @code{signing_key} keyword -is the key usage extension to indicate this certificate is intended for -usage in the data session. - -The @code{client-hostNNN-key.pem} and @code{client-hostNNN-cert.pem} files -should now be securely copied to the client for which they were generated, -and renamed to @code{client-key.pem} and @code{client-cert.pem} when added -to the @code{/etc/pki/qemu} directory on the target host. The @code{client-key.pem} -file is security sensitive and should be kept protected with file mode 0600 -to prevent disclosure. - -If a single host is going to be using TLS in both a client and server -role, it is possible to create a single certificate to cover both roles. -This would be quite common for the migration and NBD services, where a -QEMU process will be started by accepting a TLS protected incoming migration, -and later itself be migrated out to another host. To generate a single -certificate, simply include the template data from both the client and server -instructions in one. - -@example -# cat > both-hostNNN.info < both-hostNNN-key.pem -# certtool --generate-certificate \ - --load-ca-certificate ca-cert.pem \ - --load-ca-privkey ca-key.pem \ - --load-privkey both-hostNNN-key.pem \ - --template both-hostNNN.info \ - --outfile both-hostNNN-cert.pem -@end example - -When copying the PEM files to the target host, save them twice, -once as @code{server-cert.pem} and @code{server-key.pem}, and -again as @code{client-cert.pem} and @code{client-key.pem}. - -@node tls_creds_setup -@subsection TLS x509 credential configuration - -QEMU has a standard mechanism for loading x509 credentials that will be -used for network services and clients. It requires specifying the -@code{tls-creds-x509} class name to the @code{--object} command line -argument for the system emulators. Each set of credentials loaded should -be given a unique string identifier via the @code{id} parameter. A single -set of TLS credentials can be used for multiple network backends, so VNC, -migration, NBD, character devices can all share the same credentials. Note, -however, that credentials for use in a client endpoint must be loaded -separately from those used in a server endpoint. - -When specifying the object, the @code{dir} parameters specifies which -directory contains the credential files. This directory is expected to -contain files with the names mentioned previously, @code{ca-cert.pem}, -@code{server-key.pem}, @code{server-cert.pem}, @code{client-key.pem} -and @code{client-cert.pem} as appropriate. It is also possible to -include a set of pre-generated Diffie-Hellman (DH) parameters in a file -@code{dh-params.pem}, which can be created using the -@code{certtool --generate-dh-params} command. If omitted, QEMU will -dynamically generate DH parameters when loading the credentials. - -The @code{endpoint} parameter indicates whether the credentials will -be used for a network client or server, and determines which PEM -files are loaded. - -The @code{verify} parameter determines whether x509 certificate -validation should be performed. This defaults to enabled, meaning -clients will always validate the server hostname against the -certificate subject alt name fields and/or CN field. It also -means that servers will request that clients provide a certificate -and validate them. Verification should never be turned off for -client endpoints, however, it may be turned off for server endpoints -if an alternative mechanism is used to authenticate clients. For -example, the VNC server can use SASL to authenticate clients -instead. - -To load server credentials with client certificate validation -enabled - -@example -@value{qemu_system} -object tls-creds-x509,id=tls0,dir=/etc/pki/qemu,endpoint=server -@end example - -while to load client credentials use - -@example -@value{qemu_system} -object tls-creds-x509,id=tls0,dir=/etc/pki/qemu,endpoint=client -@end example - -Network services which support TLS will all have a @code{tls-creds} -parameter which expects the ID of the TLS credentials object. For -example with VNC: - -@example -@value{qemu_system} -vnc 0.0.0.0:0,tls-creds=tls0 -@end example - -@node tls_psk -@subsection TLS Pre-Shared Keys (PSK) - -Instead of using certificates, you may also use TLS Pre-Shared Keys -(TLS-PSK). This can be simpler to set up than certificates but is -less scalable. - -Use the GnuTLS @code{psktool} program to generate a @code{keys.psk} -file containing one or more usernames and random keys: - -@example -mkdir -m 0700 /tmp/keys -psktool -u rich -p /tmp/keys/keys.psk -@end example - -TLS-enabled servers such as qemu-nbd can use this directory like so: - -@example -qemu-nbd \ - -t -x / \ - --object tls-creds-psk,id=tls0,endpoint=server,dir=/tmp/keys \ - --tls-creds tls0 \ - image.qcow2 -@end example - -When connecting from a qemu-based client you must specify the -directory containing @code{keys.psk} and an optional @var{username} -(defaults to ``qemu''): - -@example -qemu-img info \ - --object tls-creds-psk,id=tls0,dir=/tmp/keys,username=rich,endpoint=client \ - --image-opts \ - file.driver=nbd,file.host=localhost,file.port=10809,file.tls-creds=tls0,file.export=/ -@end example - diff --git a/docs/system/usb.texi b/docs/system/usb.texi deleted file mode 100644 index 840adac978..0000000000 --- a/docs/system/usb.texi +++ /dev/null @@ -1,115 +0,0 @@ -@node pcsys_usb -@section USB emulation - -QEMU can emulate a PCI UHCI, OHCI, EHCI or XHCI USB controller. You can -plug virtual USB devices or real host USB devices (only works with certain -host operating systems). QEMU will automatically create and connect virtual -USB hubs as necessary to connect multiple USB devices. - -@menu -* usb_devices:: -* host_usb_devices:: -@end menu -@node usb_devices -@subsection Connecting USB devices - -USB devices can be connected with the @option{-device usb-...} command line -option or the @code{device_add} monitor command. Available devices are: - -@table @code -@item usb-mouse -Virtual Mouse. This will override the PS/2 mouse emulation when activated. -@item usb-tablet -Pointer device that uses absolute coordinates (like a touchscreen). -This means QEMU is able to report the mouse position without having -to grab the mouse. Also overrides the PS/2 mouse emulation when activated. -@item usb-storage,drive=@var{drive_id} -Mass storage device backed by @var{drive_id} (@pxref{disk_images}) -@item usb-uas -USB attached SCSI device, see -@url{https://git.qemu.org/?p=qemu.git;a=blob_plain;f=docs/usb-storage.txt,usb-storage.txt} -for details -@item usb-bot -Bulk-only transport storage device, see -@url{https://git.qemu.org/?p=qemu.git;a=blob_plain;f=docs/usb-storage.txt,usb-storage.txt} -for details here, too -@item usb-mtp,rootdir=@var{dir} -Media transfer protocol device, using @var{dir} as root of the file tree -that is presented to the guest. -@item usb-host,hostbus=@var{bus},hostaddr=@var{addr} -Pass through the host device identified by @var{bus} and @var{addr} -@item usb-host,vendorid=@var{vendor},productid=@var{product} -Pass through the host device identified by @var{vendor} and @var{product} ID -@item usb-wacom-tablet -Virtual Wacom PenPartner tablet. This device is similar to the @code{tablet} -above but it can be used with the tslib library because in addition to touch -coordinates it reports touch pressure. -@item usb-kbd -Standard USB keyboard. Will override the PS/2 keyboard (if present). -@item usb-serial,chardev=@var{id} -Serial converter. This emulates an FTDI FT232BM chip connected to host character -device @var{id}. -@item usb-braille,chardev=@var{id} -Braille device. This will use BrlAPI to display the braille output on a real -or fake device referenced by @var{id}. -@item usb-net[,netdev=@var{id}] -Network adapter that supports CDC ethernet and RNDIS protocols. @var{id} -specifies a netdev defined with @code{-netdev @dots{},id=@var{id}}. -For instance, user-mode networking can be used with -@example -@value{qemu_system} [...] -netdev user,id=net0 -device usb-net,netdev=net0 -@end example -@item usb-ccid -Smartcard reader device -@item usb-audio -USB audio device -@end table - -@node host_usb_devices -@subsection Using host USB devices on a Linux host - -WARNING: this is an experimental feature. QEMU will slow down when -using it. USB devices requiring real time streaming (i.e. USB Video -Cameras) are not supported yet. - -@enumerate -@item If you use an early Linux 2.4 kernel, verify that no Linux driver -is actually using the USB device. A simple way to do that is simply to -disable the corresponding kernel module by renaming it from @file{mydriver.o} -to @file{mydriver.o.disabled}. - -@item Verify that @file{/proc/bus/usb} is working (most Linux distributions should enable it by default). You should see something like that: -@example -ls /proc/bus/usb -001 devices drivers -@end example - -@item Since only root can access to the USB devices directly, you can either launch QEMU as root or change the permissions of the USB devices you want to use. For testing, the following suffices: -@example -chown -R myuid /proc/bus/usb -@end example - -@item Launch QEMU and do in the monitor: -@example -info usbhost - Device 1.2, speed 480 Mb/s - Class 00: USB device 1234:5678, USB DISK -@end example -You should see the list of the devices you can use (Never try to use -hubs, it won't work). - -@item Add the device in QEMU by using: -@example -device_add usb-host,vendorid=0x1234,productid=0x5678 -@end example - -Normally the guest OS should report that a new USB device is plugged. -You can use the option @option{-device usb-host,...} to do the same. - -@item Now you can try to use the host USB device in QEMU. - -@end enumerate - -When relaunching QEMU, you may have to unplug and plug again the USB -device to make it work again (this is a bug). - diff --git a/docs/system/vnc-security.texi b/docs/system/vnc-security.texi deleted file mode 100644 index abf7f7fa43..0000000000 --- a/docs/system/vnc-security.texi +++ /dev/null @@ -1,196 +0,0 @@ -@node vnc_security -@section VNC security - -The VNC server capability provides access to the graphical console -of the guest VM across the network. This has a number of security -considerations depending on the deployment scenarios. - -@menu -* vnc_sec_none:: -* vnc_sec_password:: -* vnc_sec_certificate:: -* vnc_sec_certificate_verify:: -* vnc_sec_certificate_pw:: -* vnc_sec_sasl:: -* vnc_sec_certificate_sasl:: -* vnc_setup_sasl:: -@end menu -@node vnc_sec_none -@subsection Without passwords - -The simplest VNC server setup does not include any form of authentication. -For this setup it is recommended to restrict it to listen on a UNIX domain -socket only. For example - -@example -@value{qemu_system} [...OPTIONS...] -vnc unix:/home/joebloggs/.qemu-myvm-vnc -@end example - -This ensures that only users on local box with read/write access to that -path can access the VNC server. To securely access the VNC server from a -remote machine, a combination of netcat+ssh can be used to provide a secure -tunnel. - -@node vnc_sec_password -@subsection With passwords - -The VNC protocol has limited support for password based authentication. Since -the protocol limits passwords to 8 characters it should not be considered -to provide high security. The password can be fairly easily brute-forced by -a client making repeat connections. For this reason, a VNC server using password -authentication should be restricted to only listen on the loopback interface -or UNIX domain sockets. Password authentication is not supported when operating -in FIPS 140-2 compliance mode as it requires the use of the DES cipher. Password -authentication is requested with the @code{password} option, and then once QEMU -is running the password is set with the monitor. Until the monitor is used to -set the password all clients will be rejected. - -@example -@value{qemu_system} [...OPTIONS...] -vnc :1,password -monitor stdio -(qemu) change vnc password -Password: ******** -(qemu) -@end example - -@node vnc_sec_certificate -@subsection With x509 certificates - -The QEMU VNC server also implements the VeNCrypt extension allowing use of -TLS for encryption of the session, and x509 certificates for authentication. -The use of x509 certificates is strongly recommended, because TLS on its -own is susceptible to man-in-the-middle attacks. Basic x509 certificate -support provides a secure session, but no authentication. This allows any -client to connect, and provides an encrypted session. - -@example -@value{qemu_system} [...OPTIONS...] \ - -object tls-creds-x509,id=tls0,dir=/etc/pki/qemu,endpoint=server,verify-peer=no \ - -vnc :1,tls-creds=tls0 -monitor stdio -@end example - -In the above example @code{/etc/pki/qemu} should contain at least three files, -@code{ca-cert.pem}, @code{server-cert.pem} and @code{server-key.pem}. Unprivileged -users will want to use a private directory, for example @code{$HOME/.pki/qemu}. -NB the @code{server-key.pem} file should be protected with file mode 0600 to -only be readable by the user owning it. - -@node vnc_sec_certificate_verify -@subsection With x509 certificates and client verification - -Certificates can also provide a means to authenticate the client connecting. -The server will request that the client provide a certificate, which it will -then validate against the CA certificate. This is a good choice if deploying -in an environment with a private internal certificate authority. It uses the -same syntax as previously, but with @code{verify-peer} set to @code{yes} -instead. - -@example -@value{qemu_system} [...OPTIONS...] \ - -object tls-creds-x509,id=tls0,dir=/etc/pki/qemu,endpoint=server,verify-peer=yes \ - -vnc :1,tls-creds=tls0 -monitor stdio -@end example - - -@node vnc_sec_certificate_pw -@subsection With x509 certificates, client verification and passwords - -Finally, the previous method can be combined with VNC password authentication -to provide two layers of authentication for clients. - -@example -@value{qemu_system} [...OPTIONS...] \ - -object tls-creds-x509,id=tls0,dir=/etc/pki/qemu,endpoint=server,verify-peer=yes \ - -vnc :1,tls-creds=tls0,password -monitor stdio -(qemu) change vnc password -Password: ******** -(qemu) -@end example - - -@node vnc_sec_sasl -@subsection With SASL authentication - -The SASL authentication method is a VNC extension, that provides an -easily extendable, pluggable authentication method. This allows for -integration with a wide range of authentication mechanisms, such as -PAM, GSSAPI/Kerberos, LDAP, SQL databases, one-time keys and more. -The strength of the authentication depends on the exact mechanism -configured. If the chosen mechanism also provides a SSF layer, then -it will encrypt the datastream as well. - -Refer to the later docs on how to choose the exact SASL mechanism -used for authentication, but assuming use of one supporting SSF, -then QEMU can be launched with: - -@example -@value{qemu_system} [...OPTIONS...] -vnc :1,sasl -monitor stdio -@end example - -@node vnc_sec_certificate_sasl -@subsection With x509 certificates and SASL authentication - -If the desired SASL authentication mechanism does not supported -SSF layers, then it is strongly advised to run it in combination -with TLS and x509 certificates. This provides securely encrypted -data stream, avoiding risk of compromising of the security -credentials. This can be enabled, by combining the 'sasl' option -with the aforementioned TLS + x509 options: - -@example -@value{qemu_system} [...OPTIONS...] \ - -object tls-creds-x509,id=tls0,dir=/etc/pki/qemu,endpoint=server,verify-peer=yes \ - -vnc :1,tls-creds=tls0,sasl -monitor stdio -@end example - -@node vnc_setup_sasl - -@subsection Configuring SASL mechanisms - -The following documentation assumes use of the Cyrus SASL implementation on a -Linux host, but the principles should apply to any other SASL implementation -or host. When SASL is enabled, the mechanism configuration will be loaded from -system default SASL service config /etc/sasl2/qemu.conf. If running QEMU as an -unprivileged user, an environment variable SASL_CONF_PATH can be used to make -it search alternate locations for the service config file. - -If the TLS option is enabled for VNC, then it will provide session encryption, -otherwise the SASL mechanism will have to provide encryption. In the latter -case the list of possible plugins that can be used is drastically reduced. In -fact only the GSSAPI SASL mechanism provides an acceptable level of security -by modern standards. Previous versions of QEMU referred to the DIGEST-MD5 -mechanism, however, it has multiple serious flaws described in detail in -RFC 6331 and thus should never be used any more. The SCRAM-SHA-1 mechanism -provides a simple username/password auth facility similar to DIGEST-MD5, but -does not support session encryption, so can only be used in combination with -TLS. - -When not using TLS the recommended configuration is - -@example -mech_list: gssapi -keytab: /etc/qemu/krb5.tab -@end example - -This says to use the 'GSSAPI' mechanism with the Kerberos v5 protocol, with -the server principal stored in /etc/qemu/krb5.tab. For this to work the -administrator of your KDC must generate a Kerberos principal for the server, -with a name of 'qemu/somehost.example.com@@EXAMPLE.COM' replacing -'somehost.example.com' with the fully qualified host name of the machine -running QEMU, and 'EXAMPLE.COM' with the Kerberos Realm. - -When using TLS, if username+password authentication is desired, then a -reasonable configuration is - -@example -mech_list: scram-sha-1 -sasldb_path: /etc/qemu/passwd.db -@end example - -The @code{saslpasswd2} program can be used to populate the @code{passwd.db} -file with accounts. - -Other SASL configurations will be left as an exercise for the reader. Note that -all mechanisms, except GSSAPI, should be combined with use of TLS to ensure a -secure data channel. - - diff --git a/qemu-doc.texi b/qemu-doc.texi deleted file mode 100644 index c2b9c87c64..0000000000 --- a/qemu-doc.texi +++ /dev/null @@ -1,201 +0,0 @@ -\input texinfo @c -*- texinfo -*- -@c %**start of header -@setfilename qemu-doc.info -@include version.texi - -@documentlanguage en -@documentencoding UTF-8 - -@settitle QEMU version @value{VERSION} User Documentation -@exampleindent 0 -@paragraphindent 0 -@c %**end of header - -@set qemu_system qemu-system-x86_64 -@set qemu_system_x86 qemu-system-x86_64 - -@ifinfo -@direntry -* QEMU: (qemu-doc). The QEMU Emulator User Documentation. -@end direntry -@end ifinfo - -@iftex -@titlepage -@sp 7 -@center @titlefont{QEMU version @value{VERSION}} -@sp 1 -@center @titlefont{User Documentation} -@sp 3 -@end titlepage -@end iftex - -@ifnottex -@node Top -@top - -@menu -* Introduction:: -* QEMU System emulator:: -* QEMU System emulator targets:: -* Security:: -* Deprecated features:: -* Recently removed features:: -* Supported build platforms:: -* License:: -* Index:: -@end menu -@end ifnottex - -@contents - -@node Introduction -@chapter Introduction - -@menu -* intro_features:: Features -@end menu - -@node intro_features -@section Features - -QEMU is a FAST! processor emulator using dynamic translation to -achieve good emulation speed. - -QEMU has two operating modes: - -@itemize -@item Full system emulation. In this mode, QEMU emulates a full system (for -example a PC), including one or several processors and various -peripherals. It can be used to launch different Operating Systems -without rebooting the PC or to debug system code. - -@item User mode emulation. In this mode, QEMU can launch -processes compiled for one CPU on another CPU. It can be used to -launch the Wine Windows API emulator (@url{https://www.winehq.org}) or -to ease cross-compilation and cross-debugging. - -@end itemize - -QEMU has the following features: - -@itemize -@item QEMU can run without a host kernel driver and yet gives acceptable -performance. It uses dynamic translation to native code for reasonable speed, -with support for self-modifying code and precise exceptions. - -@item It is portable to several operating systems (GNU/Linux, *BSD, Mac OS X, -Windows) and architectures. - -@item It performs accurate software emulation of the FPU. -@end itemize - -QEMU user mode emulation has the following features: -@itemize -@item Generic Linux system call converter, including most ioctls. - -@item clone() emulation using native CPU clone() to use Linux scheduler for threads. - -@item Accurate signal handling by remapping host signals to target signals. -@end itemize - -QEMU full system emulation has the following features: -@itemize -@item -QEMU uses a full software MMU for maximum portability. - -@item -QEMU can optionally use an in-kernel accelerator, like kvm. The accelerators -execute most of the guest code natively, while -continuing to emulate the rest of the machine. - -@item -Various hardware devices can be emulated and in some cases, host -devices (e.g. serial and parallel ports, USB, drives) can be used -transparently by the guest Operating System. Host device passthrough -can be used for talking to external physical peripherals (e.g. a -webcam, modem or tape drive). - -@item -Symmetric multiprocessing (SMP) support. Currently, an in-kernel -accelerator is required to use more than one host CPU for emulation. - -@end itemize - -@node QEMU System emulator -@chapter QEMU System emulator - -@menu -* pcsys_quickstart:: Quick start -* sec_invocation:: Invocation -* pcsys_keys:: Keys in the graphical frontends -* mux_keys:: Keys in the character backend multiplexer -* pcsys_monitor:: QEMU Monitor -* disk_images:: Disk Images -* pcsys_network:: Network emulation -* pcsys_usb:: USB emulation -* pcsys_ivshmem:: Inter-VM Shared Memory device -* direct_linux_boot:: Direct Linux Boot -* vnc_security:: VNC security -* network_tls:: TLS setup for network services -* gdb_usage:: GDB usage -* managed_startup:: Managed startup options -@end menu - -@include docs/system/quickstart.texi -@include docs/system/invocation.texi -@include docs/system/keys.texi -@include docs/system/mux-chardev.texi -@include docs/system/monitor.texi -@include docs/system/images.texi -@include docs/system/net.texi -@include docs/system/usb.texi -@include docs/system/ivshmem.texi -@include docs/system/linuxboot.texi -@include docs/system/vnc-security.texi -@include docs/system/tls.texi -@include docs/system/gdb.texi -@include docs/system/managed-startup.texi - -@node QEMU System emulator targets -@chapter QEMU System emulator targets - -QEMU is a generic emulator and it emulates many machines. Most of the -options are similar for all machines. Specific information about the -various targets are mentioned in the following sections. - -@menu -* x86 (PC) System emulator:: -* PowerPC System emulator:: -* Sparc32 System emulator:: -* Sparc64 System emulator:: -* MIPS System emulator:: -* ARM System emulator:: -* ColdFire System emulator:: -* Xtensa System emulator:: -@end menu - -@include docs/system/target-i386.texi -@include docs/system/target-ppc.texi -@include docs/system/target-sparc.texi -@include docs/system/target-sparc64.texi -@include docs/system/target-mips.texi -@include docs/system/target-arm.texi -@include docs/system/target-m68k.texi -@include docs/system/target-xtensa.texi - -@include docs/system/security.texi - -@include docs/system/deprecated.texi - -@include docs/system/build-platforms.texi - -@include docs/system/license.texi - - -@node Index -@appendix Index - -@printindex fn - -@bye -- cgit v1.2.3-55-g7522