* [PATCH v3 01/33] qemu-doc: convert user-mode emulation to a separate Sphinx manual
2020-02-28 15:35 [PATCH v3 00/33] Convert qemu-doc to rST Peter Maydell
@ 2020-02-28 15:35 ` Peter Maydell
2020-03-02 11:05 ` Alex Bennée
2020-02-28 15:35 ` [PATCH v3 02/33] qemu-doc: remove target OS documentation Peter Maydell
` (34 subsequent siblings)
35 siblings, 1 reply; 82+ messages in thread
From: Peter Maydell @ 2020-02-28 15:35 UTC (permalink / raw)
To: qemu-devel; +Cc: Paolo Bonzini, Kashyap Chamarthy
From: Paolo Bonzini <pbonzini@redhat.com>
The final addition to the set of QEMU manuals is the user-mode emulation
manual, which right now is included in qemu-doc.texi. Extract it and
convert it to rST, so that qemu-doc.texi covers only full system emulation.
Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
Message-id: 20200226113034.6741-2-pbonzini@redhat.com
[PMM: Fix makefile conflicts; add user manual to
index.rst and index.html.in; don't specify empty man_pages
list; fixed a few comments to say 'user' rather than 'system']
Reviewed-by: Peter Maydell <peter.maydell@linaro.org>
Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
---
Makefile | 8 +-
docs/index.html.in | 1 +
docs/index.rst | 1 +
docs/user/conf.py | 15 ++
docs/user/index.rst | 16 +++
docs/user/main.rst | 295 ++++++++++++++++++++++++++++++++++++++
qemu-doc.texi | 337 --------------------------------------------
7 files changed, 335 insertions(+), 338 deletions(-)
create mode 100644 docs/user/conf.py
create mode 100644 docs/user/index.rst
create mode 100644 docs/user/main.rst
diff --git a/Makefile b/Makefile
index aa9cc0b5847..faa0ffa05b0 100644
--- a/Makefile
+++ b/Makefile
@@ -787,6 +787,7 @@ distclean: clean
$(call clean-manual,specs)
$(call clean-manual,system)
$(call clean-manual,tools)
+ $(call clean-manual,user)
for d in $(TARGET_DIRS); do \
rm -rf $$d || exit 1 ; \
done
@@ -845,6 +846,7 @@ install-sphinxdocs: sphinxdocs
$(call install-manual,specs)
$(call install-manual,system)
$(call install-manual,tools)
+ $(call install-manual,user)
install-doc: $(DOCS) install-sphinxdocs
$(INSTALL_DIR) "$(DESTDIR)$(qemu_docdir)"
@@ -1039,7 +1041,8 @@ sphinxdocs: $(MANUAL_BUILDDIR)/devel/index.html \
$(MANUAL_BUILDDIR)/interop/index.html \
$(MANUAL_BUILDDIR)/specs/index.html \
$(MANUAL_BUILDDIR)/system/index.html \
- $(MANUAL_BUILDDIR)/tools/index.html
+ $(MANUAL_BUILDDIR)/tools/index.html \
+ $(MANUAL_BUILDDIR)/user/index.html
# Canned command to build a single manual
# Arguments: $1 = manual name, $2 = Sphinx builder ('html' or 'man')
@@ -1074,6 +1077,9 @@ $(MANUAL_BUILDDIR)/system/index.html: $(call manual-deps,system)
$(MANUAL_BUILDDIR)/tools/index.html: $(call manual-deps,tools) $(SRC_PATH)/qemu-img-cmds.hx $(SRC_PATH)/docs/qemu-option-trace.rst.inc
$(call build-manual,tools,html)
+$(MANUAL_BUILDDIR)/user/index.html: $(call manual-deps,user)
+ $(call build-manual,user,html)
+
$(call define-manpage-rule,interop,qemu-ga.8)
$(call define-manpage-rule,system,qemu-block-drivers.7)
diff --git a/docs/index.html.in b/docs/index.html.in
index cf61b1cf448..a576ace8a27 100644
--- a/docs/index.html.in
+++ b/docs/index.html.in
@@ -14,6 +14,7 @@
<li><a href="specs/index.html">System Emulation Guest Hardware Specifications</a></li>
<li><a href="system/index.html">System Emulation User's Guide</a></li>
<li><a href="tools/index.html">Tools Guide</a></li>
+ <li><a href="user/index.html">User Mode Emulation User's Guide</a></li>
</ul>
</body>
</html>
diff --git a/docs/index.rst b/docs/index.rst
index acd604fa8a9..376dab28850 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -15,3 +15,4 @@ Welcome to QEMU's documentation!
specs/index
system/index
tools/index
+ user/index
diff --git a/docs/user/conf.py b/docs/user/conf.py
new file mode 100644
index 00000000000..4b09aedd454
--- /dev/null
+++ b/docs/user/conf.py
@@ -0,0 +1,15 @@
+# -*- coding: utf-8 -*-
+#
+# QEMU documentation build configuration file for the 'user' manual.
+#
+# This includes the top level conf file and then makes any necessary tweaks.
+import sys
+import os
+
+qemu_docdir = os.path.abspath("..")
+parent_config = os.path.join(qemu_docdir, "conf.py")
+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'User Mode Emulation User''s Guide'
diff --git a/docs/user/index.rst b/docs/user/index.rst
new file mode 100644
index 00000000000..e030dadf652
--- /dev/null
+++ b/docs/user/index.rst
@@ -0,0 +1,16 @@
+.. This is the top level page for the 'user' manual.
+
+
+QEMU User Mode Emulation User's Guide
+=====================================
+
+This manual is the overall guide for users using QEMU
+for user-mode emulation. In this mode, QEMU can launch
+processes compiled for one CPU on another CPU.
+
+Contents:
+
+.. toctree::
+ :maxdepth: 2
+
+ main
diff --git a/docs/user/main.rst b/docs/user/main.rst
new file mode 100644
index 00000000000..ca69f7727d5
--- /dev/null
+++ b/docs/user/main.rst
@@ -0,0 +1,295 @@
+QEMU User space emulator
+========================
+
+Supported Operating Systems
+---------------------------
+
+The following OS are supported in user space emulation:
+
+- Linux (referred as qemu-linux-user)
+
+- BSD (referred as qemu-bsd-user)
+
+Features
+--------
+
+QEMU user space emulation has the following notable features:
+
+**System call translation:**
+ QEMU includes a generic system call translator. This means that the
+ parameters of the system calls can be converted to fix endianness and
+ 32/64-bit mismatches between hosts and targets. IOCTLs can be
+ converted too.
+
+**POSIX signal handling:**
+ QEMU can redirect to the running program all signals coming from the
+ host (such as ``SIGALRM``), as well as synthesize signals from
+ virtual CPU exceptions (for example ``SIGFPE`` when the program
+ executes a division by zero).
+
+ QEMU relies on the host kernel to emulate most signal system calls,
+ for example to emulate the signal mask. On Linux, QEMU supports both
+ normal and real-time signals.
+
+**Threading:**
+ On Linux, QEMU can emulate the ``clone`` syscall and create a real
+ host thread (with a separate virtual CPU) for each emulated thread.
+ Note that not all targets currently emulate atomic operations
+ correctly. x86 and ARM use a global lock in order to preserve their
+ semantics.
+
+QEMU was conceived so that ultimately it can emulate itself. Although it
+is not very useful, it is an important test to show the power of the
+emulator.
+
+Linux User space emulator
+-------------------------
+
+Quick Start
+~~~~~~~~~~~
+
+In order to launch a Linux process, QEMU needs the process executable
+itself and all the target (x86) dynamic libraries used by it.
+
+- On x86, you can just try to launch any process by using the native
+ libraries::
+
+ qemu-i386 -L / /bin/ls
+
+ ``-L /`` tells that the x86 dynamic linker must be searched with a
+ ``/`` prefix.
+
+- Since QEMU is also a linux process, you can launch QEMU with QEMU
+ (NOTE: you can only do that if you compiled QEMU from the sources)::
+
+ qemu-i386 -L / qemu-i386 -L / /bin/ls
+
+- On non x86 CPUs, you need first to download at least an x86 glibc
+ (``qemu-runtime-i386-XXX-.tar.gz`` on the QEMU web page). Ensure that
+ ``LD_LIBRARY_PATH`` is not set::
+
+ unset LD_LIBRARY_PATH
+
+ Then you can launch the precompiled ``ls`` x86 executable::
+
+ qemu-i386 tests/i386/ls
+
+ You can look at ``scripts/qemu-binfmt-conf.sh`` so that QEMU is
+ automatically launched by the Linux kernel when you try to launch x86
+ executables. It requires the ``binfmt_misc`` module in the Linux
+ kernel.
+
+- The x86 version of QEMU is also included. You can try weird things
+ such as::
+
+ qemu-i386 /usr/local/qemu-i386/bin/qemu-i386 \
+ /usr/local/qemu-i386/bin/ls-i386
+
+Wine launch
+~~~~~~~~~~~
+
+- Ensure that you have a working QEMU with the x86 glibc distribution
+ (see previous section). In order to verify it, you must be able to
+ do::
+
+ qemu-i386 /usr/local/qemu-i386/bin/ls-i386
+
+- Download the binary x86 Wine install (``qemu-XXX-i386-wine.tar.gz``
+ on the QEMU web page).
+
+- Configure Wine on your account. Look at the provided script
+ ``/usr/local/qemu-i386/bin/wine-conf.sh``. Your previous
+ ``${HOME}/.wine`` directory is saved to ``${HOME}/.wine.org``.
+
+- Then you can try the example ``putty.exe``::
+
+ qemu-i386 /usr/local/qemu-i386/wine/bin/wine \
+ /usr/local/qemu-i386/wine/c/Program\ Files/putty.exe
+
+Command line options
+~~~~~~~~~~~~~~~~~~~~
+
+::
+
+ qemu-i386 [-h] [-d] [-L path] [-s size] [-cpu model] [-g port] [-B offset] [-R size] program [arguments...]
+
+``-h``
+ Print the help
+
+``-L path``
+ Set the x86 elf interpreter prefix (default=/usr/local/qemu-i386)
+
+``-s size``
+ Set the x86 stack size in bytes (default=524288)
+
+``-cpu model``
+ Select CPU model (-cpu help for list and additional feature
+ selection)
+
+``-E var=value``
+ Set environment var to value.
+
+``-U var``
+ Remove var from the environment.
+
+``-B offset``
+ Offset guest address by the specified number of bytes. This is useful
+ when the address region required by guest applications is reserved on
+ the host. This option is currently only supported on some hosts.
+
+``-R size``
+ Pre-allocate a guest virtual address space of the given size (in
+ bytes). \"G\", \"M\", and \"k\" suffixes may be used when specifying
+ the size.
+
+Debug options:
+
+``-d item1,...``
+ Activate logging of the specified items (use '-d help' for a list of
+ log items)
+
+``-p pagesize``
+ Act as if the host page size was 'pagesize' bytes
+
+``-g port``
+ Wait gdb connection to port
+
+``-singlestep``
+ Run the emulation in single step mode.
+
+Environment variables:
+
+QEMU_STRACE
+ Print system calls and arguments similar to the 'strace' program
+ (NOTE: the actual 'strace' program will not work because the user
+ space emulator hasn't implemented ptrace). At the moment this is
+ incomplete. All system calls that don't have a specific argument
+ format are printed with information for six arguments. Many
+ flag-style arguments don't have decoders and will show up as numbers.
+
+Other binaries
+~~~~~~~~~~~~~~
+
+user mode (Alpha)
+``qemu-alpha`` TODO.
+
+user mode (ARM)
+``qemu-armeb`` TODO.
+
+user mode (ARM)
+``qemu-arm`` is also capable of running ARM \"Angel\" semihosted ELF
+binaries (as implemented by the arm-elf and arm-eabi Newlib/GDB
+configurations), and arm-uclinux bFLT format binaries.
+
+user mode (ColdFire)
+user mode (M68K)
+``qemu-m68k`` is capable of running semihosted binaries using the BDM
+(m5xxx-ram-hosted.ld) or m68k-sim (sim.ld) syscall interfaces, and
+coldfire uClinux bFLT format binaries.
+
+The binary format is detected automatically.
+
+user mode (Cris)
+``qemu-cris`` TODO.
+
+user mode (i386)
+``qemu-i386`` TODO. ``qemu-x86_64`` TODO.
+
+user mode (Microblaze)
+``qemu-microblaze`` TODO.
+
+user mode (MIPS)
+``qemu-mips`` executes 32-bit big endian MIPS binaries (MIPS O32 ABI).
+
+``qemu-mipsel`` executes 32-bit little endian MIPS binaries (MIPS O32
+ABI).
+
+``qemu-mips64`` executes 64-bit big endian MIPS binaries (MIPS N64 ABI).
+
+``qemu-mips64el`` executes 64-bit little endian MIPS binaries (MIPS N64
+ABI).
+
+``qemu-mipsn32`` executes 32-bit big endian MIPS binaries (MIPS N32
+ABI).
+
+``qemu-mipsn32el`` executes 32-bit little endian MIPS binaries (MIPS N32
+ABI).
+
+user mode (NiosII)
+``qemu-nios2`` TODO.
+
+user mode (PowerPC)
+``qemu-ppc64abi32`` TODO. ``qemu-ppc64`` TODO. ``qemu-ppc`` TODO.
+
+user mode (SH4)
+``qemu-sh4eb`` TODO. ``qemu-sh4`` TODO.
+
+user mode (SPARC)
+``qemu-sparc`` can execute Sparc32 binaries (Sparc32 CPU, 32 bit ABI).
+
+``qemu-sparc32plus`` can execute Sparc32 and SPARC32PLUS binaries
+(Sparc64 CPU, 32 bit ABI).
+
+``qemu-sparc64`` can execute some Sparc64 (Sparc64 CPU, 64 bit ABI) and
+SPARC32PLUS binaries (Sparc64 CPU, 32 bit ABI).
+
+BSD User space emulator
+-----------------------
+
+BSD Status
+~~~~~~~~~~
+
+- target Sparc64 on Sparc64: Some trivial programs work.
+
+Quick Start
+~~~~~~~~~~~
+
+In order to launch a BSD process, QEMU needs the process executable
+itself and all the target dynamic libraries used by it.
+
+- On Sparc64, you can just try to launch any process by using the
+ native libraries::
+
+ qemu-sparc64 /bin/ls
+
+Command line options
+~~~~~~~~~~~~~~~~~~~~
+
+::
+
+ qemu-sparc64 [-h] [-d] [-L path] [-s size] [-bsd type] program [arguments...]
+
+``-h``
+ Print the help
+
+``-L path``
+ Set the library root path (default=/)
+
+``-s size``
+ Set the stack size in bytes (default=524288)
+
+``-ignore-environment``
+ Start with an empty environment. Without this option, the initial
+ environment is a copy of the caller's environment.
+
+``-E var=value``
+ Set environment var to value.
+
+``-U var``
+ Remove var from the environment.
+
+``-bsd type``
+ Set the type of the emulated BSD Operating system. Valid values are
+ FreeBSD, NetBSD and OpenBSD (default).
+
+Debug options:
+
+``-d item1,...``
+ Activate logging of the specified items (use '-d help' for a list of
+ log items)
+
+``-p pagesize``
+ Act as if the host page size was 'pagesize' bytes
+
+``-singlestep``
+ Run the emulation in single step mode.
diff --git a/qemu-doc.texi b/qemu-doc.texi
index 33b9597b1dc..6636816b85f 100644
--- a/qemu-doc.texi
+++ b/qemu-doc.texi
@@ -38,7 +38,6 @@
* Introduction::
* QEMU PC System emulator::
* QEMU System emulator for non PC targets::
-* QEMU User space emulator::
* System requirements::
* Security::
* Implementation notes::
@@ -2487,342 +2486,6 @@ so should only be used with trusted guest OS.
@c man end
-@node QEMU User space emulator
-@chapter QEMU User space emulator
-
-@menu
-* Supported Operating Systems ::
-* Features::
-* Linux User space emulator::
-* BSD User space emulator ::
-@end menu
-
-@node Supported Operating Systems
-@section Supported Operating Systems
-
-The following OS are supported in user space emulation:
-
-@itemize @minus
-@item
-Linux (referred as qemu-linux-user)
-@item
-BSD (referred as qemu-bsd-user)
-@end itemize
-
-@node Features
-@section Features
-
-QEMU user space emulation has the following notable features:
-
-@table @strong
-@item System call translation:
-QEMU includes a generic system call translator. This means that
-the parameters of the system calls can be converted to fix
-endianness and 32/64-bit mismatches between hosts and targets.
-IOCTLs can be converted too.
-
-@item POSIX signal handling:
-QEMU can redirect to the running program all signals coming from
-the host (such as @code{SIGALRM}), as well as synthesize signals from
-virtual CPU exceptions (for example @code{SIGFPE} when the program
-executes a division by zero).
-
-QEMU relies on the host kernel to emulate most signal system
-calls, for example to emulate the signal mask. On Linux, QEMU
-supports both normal and real-time signals.
-
-@item Threading:
-On Linux, QEMU can emulate the @code{clone} syscall and create a real
-host thread (with a separate virtual CPU) for each emulated thread.
-Note that not all targets currently emulate atomic operations correctly.
-x86 and ARM use a global lock in order to preserve their semantics.
-@end table
-
-QEMU was conceived so that ultimately it can emulate itself. Although
-it is not very useful, it is an important test to show the power of the
-emulator.
-
-@node Linux User space emulator
-@section Linux User space emulator
-
-@menu
-* Quick Start::
-* Wine launch::
-* Command line options::
-* Other binaries::
-@end menu
-
-@node Quick Start
-@subsection Quick Start
-
-In order to launch a Linux process, QEMU needs the process executable
-itself and all the target (x86) dynamic libraries used by it.
-
-@itemize
-
-@item On x86, you can just try to launch any process by using the native
-libraries:
-
-@example
-qemu-i386 -L / /bin/ls
-@end example
-
-@code{-L /} tells that the x86 dynamic linker must be searched with a
-@file{/} prefix.
-
-@item Since QEMU is also a linux process, you can launch QEMU with
-QEMU (NOTE: you can only do that if you compiled QEMU from the sources):
-
-@example
-qemu-i386 -L / qemu-i386 -L / /bin/ls
-@end example
-
-@item On non x86 CPUs, you need first to download at least an x86 glibc
-(@file{qemu-runtime-i386-XXX-.tar.gz} on the QEMU web page). Ensure that
-@code{LD_LIBRARY_PATH} is not set:
-
-@example
-unset LD_LIBRARY_PATH
-@end example
-
-Then you can launch the precompiled @file{ls} x86 executable:
-
-@example
-qemu-i386 tests/i386/ls
-@end example
-You can look at @file{scripts/qemu-binfmt-conf.sh} so that
-QEMU is automatically launched by the Linux kernel when you try to
-launch x86 executables. It requires the @code{binfmt_misc} module in the
-Linux kernel.
-
-@item The x86 version of QEMU is also included. You can try weird things such as:
-@example
-qemu-i386 /usr/local/qemu-i386/bin/qemu-i386 \
- /usr/local/qemu-i386/bin/ls-i386
-@end example
-
-@end itemize
-
-@node Wine launch
-@subsection Wine launch
-
-@itemize
-
-@item Ensure that you have a working QEMU with the x86 glibc
-distribution (see previous section). In order to verify it, you must be
-able to do:
-
-@example
-qemu-i386 /usr/local/qemu-i386/bin/ls-i386
-@end example
-
-@item Download the binary x86 Wine install
-(@file{qemu-XXX-i386-wine.tar.gz} on the QEMU web page).
-
-@item Configure Wine on your account. Look at the provided script
-@file{/usr/local/qemu-i386/@/bin/wine-conf.sh}. Your previous
-@code{$@{HOME@}/.wine} directory is saved to @code{$@{HOME@}/.wine.org}.
-
-@item Then you can try the example @file{putty.exe}:
-
-@example
-qemu-i386 /usr/local/qemu-i386/wine/bin/wine \
- /usr/local/qemu-i386/wine/c/Program\ Files/putty.exe
-@end example
-
-@end itemize
-
-@node Command line options
-@subsection Command line options
-
-@example
-@command{qemu-i386} [@option{-h]} [@option{-d]} [@option{-L} @var{path}] [@option{-s} @var{size}] [@option{-cpu} @var{model}] [@option{-g} @var{port}] [@option{-B} @var{offset}] [@option{-R} @var{size}] @var{program} [@var{arguments}...]
-@end example
-
-@table @option
-@item -h
-Print the help
-@item -L path
-Set the x86 elf interpreter prefix (default=/usr/local/qemu-i386)
-@item -s size
-Set the x86 stack size in bytes (default=524288)
-@item -cpu model
-Select CPU model (-cpu help for list and additional feature selection)
-@item -E @var{var}=@var{value}
-Set environment @var{var} to @var{value}.
-@item -U @var{var}
-Remove @var{var} from the environment.
-@item -B offset
-Offset guest address by the specified number of bytes. This is useful when
-the address region required by guest applications is reserved on the host.
-This option is currently only supported on some hosts.
-@item -R size
-Pre-allocate a guest virtual address space of the given size (in bytes).
-"G", "M", and "k" suffixes may be used when specifying the size.
-@end table
-
-Debug options:
-
-@table @option
-@item -d item1,...
-Activate logging of the specified items (use '-d help' for a list of log items)
-@item -p pagesize
-Act as if the host page size was 'pagesize' bytes
-@item -g port
-Wait gdb connection to port
-@item -singlestep
-Run the emulation in single step mode.
-@end table
-
-Environment variables:
-
-@table @env
-@item QEMU_STRACE
-Print system calls and arguments similar to the 'strace' program
-(NOTE: the actual 'strace' program will not work because the user
-space emulator hasn't implemented ptrace). At the moment this is
-incomplete. All system calls that don't have a specific argument
-format are printed with information for six arguments. Many
-flag-style arguments don't have decoders and will show up as numbers.
-@end table
-
-@node Other binaries
-@subsection Other binaries
-
-@cindex user mode (Alpha)
-@command{qemu-alpha} TODO.
-
-@cindex user mode (ARM)
-@command{qemu-armeb} TODO.
-
-@cindex user mode (ARM)
-@command{qemu-arm} is also capable of running ARM "Angel" semihosted ELF
-binaries (as implemented by the arm-elf and arm-eabi Newlib/GDB
-configurations), and arm-uclinux bFLT format binaries.
-
-@cindex user mode (ColdFire)
-@cindex user mode (M68K)
-@command{qemu-m68k} is capable of running semihosted binaries using the BDM
-(m5xxx-ram-hosted.ld) or m68k-sim (sim.ld) syscall interfaces, and
-coldfire uClinux bFLT format binaries.
-
-The binary format is detected automatically.
-
-@cindex user mode (Cris)
-@command{qemu-cris} TODO.
-
-@cindex user mode (i386)
-@command{qemu-i386} TODO.
-@command{qemu-x86_64} TODO.
-
-@cindex user mode (Microblaze)
-@command{qemu-microblaze} TODO.
-
-@cindex user mode (MIPS)
-@command{qemu-mips} executes 32-bit big endian MIPS binaries (MIPS O32 ABI).
-
-@command{qemu-mipsel} executes 32-bit little endian MIPS binaries (MIPS O32 ABI).
-
-@command{qemu-mips64} executes 64-bit big endian MIPS binaries (MIPS N64 ABI).
-
-@command{qemu-mips64el} executes 64-bit little endian MIPS binaries (MIPS N64 ABI).
-
-@command{qemu-mipsn32} executes 32-bit big endian MIPS binaries (MIPS N32 ABI).
-
-@command{qemu-mipsn32el} executes 32-bit little endian MIPS binaries (MIPS N32 ABI).
-
-@cindex user mode (NiosII)
-@command{qemu-nios2} TODO.
-
-@cindex user mode (PowerPC)
-@command{qemu-ppc64abi32} TODO.
-@command{qemu-ppc64} TODO.
-@command{qemu-ppc} TODO.
-
-@cindex user mode (SH4)
-@command{qemu-sh4eb} TODO.
-@command{qemu-sh4} TODO.
-
-@cindex user mode (SPARC)
-@command{qemu-sparc} can execute Sparc32 binaries (Sparc32 CPU, 32 bit ABI).
-
-@command{qemu-sparc32plus} can execute Sparc32 and SPARC32PLUS binaries
-(Sparc64 CPU, 32 bit ABI).
-
-@command{qemu-sparc64} can execute some Sparc64 (Sparc64 CPU, 64 bit ABI) and
-SPARC32PLUS binaries (Sparc64 CPU, 32 bit ABI).
-
-@node BSD User space emulator
-@section BSD User space emulator
-
-@menu
-* BSD Status::
-* BSD Quick Start::
-* BSD Command line options::
-@end menu
-
-@node BSD Status
-@subsection BSD Status
-
-@itemize @minus
-@item
-target Sparc64 on Sparc64: Some trivial programs work.
-@end itemize
-
-@node BSD Quick Start
-@subsection Quick Start
-
-In order to launch a BSD process, QEMU needs the process executable
-itself and all the target dynamic libraries used by it.
-
-@itemize
-
-@item On Sparc64, you can just try to launch any process by using the native
-libraries:
-
-@example
-qemu-sparc64 /bin/ls
-@end example
-
-@end itemize
-
-@node BSD Command line options
-@subsection Command line options
-
-@example
-@command{qemu-sparc64} [@option{-h]} [@option{-d]} [@option{-L} @var{path}] [@option{-s} @var{size}] [@option{-bsd} @var{type}] @var{program} [@var{arguments}...]
-@end example
-
-@table @option
-@item -h
-Print the help
-@item -L path
-Set the library root path (default=/)
-@item -s size
-Set the stack size in bytes (default=524288)
-@item -ignore-environment
-Start with an empty environment. Without this option,
-the initial environment is a copy of the caller's environment.
-@item -E @var{var}=@var{value}
-Set environment @var{var} to @var{value}.
-@item -U @var{var}
-Remove @var{var} from the environment.
-@item -bsd type
-Set the type of the emulated BSD Operating system. Valid values are
-FreeBSD, NetBSD and OpenBSD (default).
-@end table
-
-Debug options:
-
-@table @option
-@item -d item1,...
-Activate logging of the specified items (use '-d help' for a list of log items)
-@item -p pagesize
-Act as if the host page size was 'pagesize' bytes
-@item -singlestep
-Run the emulation in single step mode.
-@end table
-
@node System requirements
@chapter System requirements
--
2.20.1
^ permalink raw reply related [flat|nested] 82+ messages in thread* Re: [PATCH v3 01/33] qemu-doc: convert user-mode emulation to a separate Sphinx manual
2020-02-28 15:35 ` [PATCH v3 01/33] qemu-doc: convert user-mode emulation to a separate Sphinx manual Peter Maydell
@ 2020-03-02 11:05 ` Alex Bennée
0 siblings, 0 replies; 82+ messages in thread
From: Alex Bennée @ 2020-03-02 11:05 UTC (permalink / raw)
To: Peter Maydell; +Cc: Paolo Bonzini, qemu-devel, Kashyap Chamarthy
Peter Maydell <peter.maydell@linaro.org> writes:
> From: Paolo Bonzini <pbonzini@redhat.com>
>
> The final addition to the set of QEMU manuals is the user-mode emulation
> manual, which right now is included in qemu-doc.texi. Extract it and
> convert it to rST, so that qemu-doc.texi covers only full system emulation.
>
> Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
> Message-id: 20200226113034.6741-2-pbonzini@redhat.com
> [PMM: Fix makefile conflicts; add user manual to
> index.rst and index.html.in; don't specify empty man_pages
> list; fixed a few comments to say 'user' rather than 'system']
> Reviewed-by: Peter Maydell <peter.maydell@linaro.org>
> Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
Reviewed-by: Alex Bennée <alex.bennee@linaro.org>
> ---
> Makefile | 8 +-
> docs/index.html.in | 1 +
> docs/index.rst | 1 +
> docs/user/conf.py | 15 ++
> docs/user/index.rst | 16 +++
> docs/user/main.rst | 295 ++++++++++++++++++++++++++++++++++++++
> qemu-doc.texi | 337 --------------------------------------------
> 7 files changed, 335 insertions(+), 338 deletions(-)
> create mode 100644 docs/user/conf.py
> create mode 100644 docs/user/index.rst
> create mode 100644 docs/user/main.rst
>
> diff --git a/Makefile b/Makefile
> index aa9cc0b5847..faa0ffa05b0 100644
> --- a/Makefile
> +++ b/Makefile
> @@ -787,6 +787,7 @@ distclean: clean
> $(call clean-manual,specs)
> $(call clean-manual,system)
> $(call clean-manual,tools)
> + $(call clean-manual,user)
> for d in $(TARGET_DIRS); do \
> rm -rf $$d || exit 1 ; \
> done
> @@ -845,6 +846,7 @@ install-sphinxdocs: sphinxdocs
> $(call install-manual,specs)
> $(call install-manual,system)
> $(call install-manual,tools)
> + $(call install-manual,user)
>
> install-doc: $(DOCS) install-sphinxdocs
> $(INSTALL_DIR) "$(DESTDIR)$(qemu_docdir)"
> @@ -1039,7 +1041,8 @@ sphinxdocs: $(MANUAL_BUILDDIR)/devel/index.html \
> $(MANUAL_BUILDDIR)/interop/index.html \
> $(MANUAL_BUILDDIR)/specs/index.html \
> $(MANUAL_BUILDDIR)/system/index.html \
> - $(MANUAL_BUILDDIR)/tools/index.html
> + $(MANUAL_BUILDDIR)/tools/index.html \
> + $(MANUAL_BUILDDIR)/user/index.html
>
> # Canned command to build a single manual
> # Arguments: $1 = manual name, $2 = Sphinx builder ('html' or 'man')
> @@ -1074,6 +1077,9 @@ $(MANUAL_BUILDDIR)/system/index.html: $(call manual-deps,system)
> $(MANUAL_BUILDDIR)/tools/index.html: $(call manual-deps,tools) $(SRC_PATH)/qemu-img-cmds.hx $(SRC_PATH)/docs/qemu-option-trace.rst.inc
> $(call build-manual,tools,html)
>
> +$(MANUAL_BUILDDIR)/user/index.html: $(call manual-deps,user)
> + $(call build-manual,user,html)
> +
> $(call define-manpage-rule,interop,qemu-ga.8)
>
> $(call define-manpage-rule,system,qemu-block-drivers.7)
> diff --git a/docs/index.html.in b/docs/index.html.in
> index cf61b1cf448..a576ace8a27 100644
> --- a/docs/index.html.in
> +++ b/docs/index.html.in
> @@ -14,6 +14,7 @@
> <li><a href="specs/index.html">System Emulation Guest Hardware Specifications</a></li>
> <li><a href="system/index.html">System Emulation User's Guide</a></li>
> <li><a href="tools/index.html">Tools Guide</a></li>
> + <li><a href="user/index.html">User Mode Emulation User's Guide</a></li>
> </ul>
> </body>
> </html>
> diff --git a/docs/index.rst b/docs/index.rst
> index acd604fa8a9..376dab28850 100644
> --- a/docs/index.rst
> +++ b/docs/index.rst
> @@ -15,3 +15,4 @@ Welcome to QEMU's documentation!
> specs/index
> system/index
> tools/index
> + user/index
> diff --git a/docs/user/conf.py b/docs/user/conf.py
> new file mode 100644
> index 00000000000..4b09aedd454
> --- /dev/null
> +++ b/docs/user/conf.py
> @@ -0,0 +1,15 @@
> +# -*- coding: utf-8 -*-
> +#
> +# QEMU documentation build configuration file for the 'user' manual.
> +#
> +# This includes the top level conf file and then makes any necessary tweaks.
> +import sys
> +import os
> +
> +qemu_docdir = os.path.abspath("..")
> +parent_config = os.path.join(qemu_docdir, "conf.py")
> +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'User Mode Emulation User''s Guide'
> diff --git a/docs/user/index.rst b/docs/user/index.rst
> new file mode 100644
> index 00000000000..e030dadf652
> --- /dev/null
> +++ b/docs/user/index.rst
> @@ -0,0 +1,16 @@
> +.. This is the top level page for the 'user' manual.
> +
> +
> +QEMU User Mode Emulation User's Guide
> +=====================================
> +
> +This manual is the overall guide for users using QEMU
> +for user-mode emulation. In this mode, QEMU can launch
> +processes compiled for one CPU on another CPU.
> +
> +Contents:
> +
> +.. toctree::
> + :maxdepth: 2
> +
> + main
> diff --git a/docs/user/main.rst b/docs/user/main.rst
> new file mode 100644
> index 00000000000..ca69f7727d5
> --- /dev/null
> +++ b/docs/user/main.rst
> @@ -0,0 +1,295 @@
> +QEMU User space emulator
> +========================
> +
> +Supported Operating Systems
> +---------------------------
> +
> +The following OS are supported in user space emulation:
> +
> +- Linux (referred as qemu-linux-user)
> +
> +- BSD (referred as qemu-bsd-user)
> +
> +Features
> +--------
> +
> +QEMU user space emulation has the following notable features:
> +
> +**System call translation:**
> + QEMU includes a generic system call translator. This means that the
> + parameters of the system calls can be converted to fix endianness and
> + 32/64-bit mismatches between hosts and targets. IOCTLs can be
> + converted too.
> +
> +**POSIX signal handling:**
> + QEMU can redirect to the running program all signals coming from the
> + host (such as ``SIGALRM``), as well as synthesize signals from
> + virtual CPU exceptions (for example ``SIGFPE`` when the program
> + executes a division by zero).
> +
> + QEMU relies on the host kernel to emulate most signal system calls,
> + for example to emulate the signal mask. On Linux, QEMU supports both
> + normal and real-time signals.
> +
> +**Threading:**
> + On Linux, QEMU can emulate the ``clone`` syscall and create a real
> + host thread (with a separate virtual CPU) for each emulated thread.
> + Note that not all targets currently emulate atomic operations
> + correctly. x86 and ARM use a global lock in order to preserve their
> + semantics.
> +
> +QEMU was conceived so that ultimately it can emulate itself. Although it
> +is not very useful, it is an important test to show the power of the
> +emulator.
> +
> +Linux User space emulator
> +-------------------------
> +
> +Quick Start
> +~~~~~~~~~~~
> +
> +In order to launch a Linux process, QEMU needs the process executable
> +itself and all the target (x86) dynamic libraries used by it.
> +
> +- On x86, you can just try to launch any process by using the native
> + libraries::
> +
> + qemu-i386 -L / /bin/ls
> +
> + ``-L /`` tells that the x86 dynamic linker must be searched with a
> + ``/`` prefix.
> +
> +- Since QEMU is also a linux process, you can launch QEMU with QEMU
> + (NOTE: you can only do that if you compiled QEMU from the sources)::
> +
> + qemu-i386 -L / qemu-i386 -L / /bin/ls
> +
> +- On non x86 CPUs, you need first to download at least an x86 glibc
> + (``qemu-runtime-i386-XXX-.tar.gz`` on the QEMU web page). Ensure that
> + ``LD_LIBRARY_PATH`` is not set::
> +
> + unset LD_LIBRARY_PATH
> +
> + Then you can launch the precompiled ``ls`` x86 executable::
> +
> + qemu-i386 tests/i386/ls
> +
> + You can look at ``scripts/qemu-binfmt-conf.sh`` so that QEMU is
> + automatically launched by the Linux kernel when you try to launch x86
> + executables. It requires the ``binfmt_misc`` module in the Linux
> + kernel.
> +
> +- The x86 version of QEMU is also included. You can try weird things
> + such as::
> +
> + qemu-i386 /usr/local/qemu-i386/bin/qemu-i386 \
> + /usr/local/qemu-i386/bin/ls-i386
> +
> +Wine launch
> +~~~~~~~~~~~
> +
> +- Ensure that you have a working QEMU with the x86 glibc distribution
> + (see previous section). In order to verify it, you must be able to
> + do::
> +
> + qemu-i386 /usr/local/qemu-i386/bin/ls-i386
> +
> +- Download the binary x86 Wine install (``qemu-XXX-i386-wine.tar.gz``
> + on the QEMU web page).
> +
> +- Configure Wine on your account. Look at the provided script
> + ``/usr/local/qemu-i386/bin/wine-conf.sh``. Your previous
> + ``${HOME}/.wine`` directory is saved to ``${HOME}/.wine.org``.
> +
> +- Then you can try the example ``putty.exe``::
> +
> + qemu-i386 /usr/local/qemu-i386/wine/bin/wine \
> + /usr/local/qemu-i386/wine/c/Program\ Files/putty.exe
> +
> +Command line options
> +~~~~~~~~~~~~~~~~~~~~
> +
> +::
> +
> + qemu-i386 [-h] [-d] [-L path] [-s size] [-cpu model] [-g port] [-B offset] [-R size] program [arguments...]
> +
> +``-h``
> + Print the help
> +
> +``-L path``
> + Set the x86 elf interpreter prefix (default=/usr/local/qemu-i386)
> +
> +``-s size``
> + Set the x86 stack size in bytes (default=524288)
> +
> +``-cpu model``
> + Select CPU model (-cpu help for list and additional feature
> + selection)
> +
> +``-E var=value``
> + Set environment var to value.
> +
> +``-U var``
> + Remove var from the environment.
> +
> +``-B offset``
> + Offset guest address by the specified number of bytes. This is useful
> + when the address region required by guest applications is reserved on
> + the host. This option is currently only supported on some hosts.
> +
> +``-R size``
> + Pre-allocate a guest virtual address space of the given size (in
> + bytes). \"G\", \"M\", and \"k\" suffixes may be used when specifying
> + the size.
> +
> +Debug options:
> +
> +``-d item1,...``
> + Activate logging of the specified items (use '-d help' for a list of
> + log items)
> +
> +``-p pagesize``
> + Act as if the host page size was 'pagesize' bytes
> +
> +``-g port``
> + Wait gdb connection to port
> +
> +``-singlestep``
> + Run the emulation in single step mode.
> +
> +Environment variables:
> +
> +QEMU_STRACE
> + Print system calls and arguments similar to the 'strace' program
> + (NOTE: the actual 'strace' program will not work because the user
> + space emulator hasn't implemented ptrace). At the moment this is
> + incomplete. All system calls that don't have a specific argument
> + format are printed with information for six arguments. Many
> + flag-style arguments don't have decoders and will show up as numbers.
> +
> +Other binaries
> +~~~~~~~~~~~~~~
> +
> +user mode (Alpha)
> +``qemu-alpha`` TODO.
> +
> +user mode (ARM)
> +``qemu-armeb`` TODO.
> +
> +user mode (ARM)
> +``qemu-arm`` is also capable of running ARM \"Angel\" semihosted ELF
> +binaries (as implemented by the arm-elf and arm-eabi Newlib/GDB
> +configurations), and arm-uclinux bFLT format binaries.
> +
> +user mode (ColdFire)
> +user mode (M68K)
> +``qemu-m68k`` is capable of running semihosted binaries using the BDM
> +(m5xxx-ram-hosted.ld) or m68k-sim (sim.ld) syscall interfaces, and
> +coldfire uClinux bFLT format binaries.
> +
> +The binary format is detected automatically.
> +
> +user mode (Cris)
> +``qemu-cris`` TODO.
> +
> +user mode (i386)
> +``qemu-i386`` TODO. ``qemu-x86_64`` TODO.
> +
> +user mode (Microblaze)
> +``qemu-microblaze`` TODO.
> +
> +user mode (MIPS)
> +``qemu-mips`` executes 32-bit big endian MIPS binaries (MIPS O32 ABI).
> +
> +``qemu-mipsel`` executes 32-bit little endian MIPS binaries (MIPS O32
> +ABI).
> +
> +``qemu-mips64`` executes 64-bit big endian MIPS binaries (MIPS N64 ABI).
> +
> +``qemu-mips64el`` executes 64-bit little endian MIPS binaries (MIPS N64
> +ABI).
> +
> +``qemu-mipsn32`` executes 32-bit big endian MIPS binaries (MIPS N32
> +ABI).
> +
> +``qemu-mipsn32el`` executes 32-bit little endian MIPS binaries (MIPS N32
> +ABI).
> +
> +user mode (NiosII)
> +``qemu-nios2`` TODO.
> +
> +user mode (PowerPC)
> +``qemu-ppc64abi32`` TODO. ``qemu-ppc64`` TODO. ``qemu-ppc`` TODO.
> +
> +user mode (SH4)
> +``qemu-sh4eb`` TODO. ``qemu-sh4`` TODO.
> +
> +user mode (SPARC)
> +``qemu-sparc`` can execute Sparc32 binaries (Sparc32 CPU, 32 bit ABI).
> +
> +``qemu-sparc32plus`` can execute Sparc32 and SPARC32PLUS binaries
> +(Sparc64 CPU, 32 bit ABI).
> +
> +``qemu-sparc64`` can execute some Sparc64 (Sparc64 CPU, 64 bit ABI) and
> +SPARC32PLUS binaries (Sparc64 CPU, 32 bit ABI).
> +
> +BSD User space emulator
> +-----------------------
> +
> +BSD Status
> +~~~~~~~~~~
> +
> +- target Sparc64 on Sparc64: Some trivial programs work.
> +
> +Quick Start
> +~~~~~~~~~~~
> +
> +In order to launch a BSD process, QEMU needs the process executable
> +itself and all the target dynamic libraries used by it.
> +
> +- On Sparc64, you can just try to launch any process by using the
> + native libraries::
> +
> + qemu-sparc64 /bin/ls
> +
> +Command line options
> +~~~~~~~~~~~~~~~~~~~~
> +
> +::
> +
> + qemu-sparc64 [-h] [-d] [-L path] [-s size] [-bsd type] program [arguments...]
> +
> +``-h``
> + Print the help
> +
> +``-L path``
> + Set the library root path (default=/)
> +
> +``-s size``
> + Set the stack size in bytes (default=524288)
> +
> +``-ignore-environment``
> + Start with an empty environment. Without this option, the initial
> + environment is a copy of the caller's environment.
> +
> +``-E var=value``
> + Set environment var to value.
> +
> +``-U var``
> + Remove var from the environment.
> +
> +``-bsd type``
> + Set the type of the emulated BSD Operating system. Valid values are
> + FreeBSD, NetBSD and OpenBSD (default).
> +
> +Debug options:
> +
> +``-d item1,...``
> + Activate logging of the specified items (use '-d help' for a list of
> + log items)
> +
> +``-p pagesize``
> + Act as if the host page size was 'pagesize' bytes
> +
> +``-singlestep``
> + Run the emulation in single step mode.
> diff --git a/qemu-doc.texi b/qemu-doc.texi
> index 33b9597b1dc..6636816b85f 100644
> --- a/qemu-doc.texi
> +++ b/qemu-doc.texi
> @@ -38,7 +38,6 @@
> * Introduction::
> * QEMU PC System emulator::
> * QEMU System emulator for non PC targets::
> -* QEMU User space emulator::
> * System requirements::
> * Security::
> * Implementation notes::
> @@ -2487,342 +2486,6 @@ so should only be used with trusted guest OS.
>
> @c man end
>
> -@node QEMU User space emulator
> -@chapter QEMU User space emulator
> -
> -@menu
> -* Supported Operating Systems ::
> -* Features::
> -* Linux User space emulator::
> -* BSD User space emulator ::
> -@end menu
> -
> -@node Supported Operating Systems
> -@section Supported Operating Systems
> -
> -The following OS are supported in user space emulation:
> -
> -@itemize @minus
> -@item
> -Linux (referred as qemu-linux-user)
> -@item
> -BSD (referred as qemu-bsd-user)
> -@end itemize
> -
> -@node Features
> -@section Features
> -
> -QEMU user space emulation has the following notable features:
> -
> -@table @strong
> -@item System call translation:
> -QEMU includes a generic system call translator. This means that
> -the parameters of the system calls can be converted to fix
> -endianness and 32/64-bit mismatches between hosts and targets.
> -IOCTLs can be converted too.
> -
> -@item POSIX signal handling:
> -QEMU can redirect to the running program all signals coming from
> -the host (such as @code{SIGALRM}), as well as synthesize signals from
> -virtual CPU exceptions (for example @code{SIGFPE} when the program
> -executes a division by zero).
> -
> -QEMU relies on the host kernel to emulate most signal system
> -calls, for example to emulate the signal mask. On Linux, QEMU
> -supports both normal and real-time signals.
> -
> -@item Threading:
> -On Linux, QEMU can emulate the @code{clone} syscall and create a real
> -host thread (with a separate virtual CPU) for each emulated thread.
> -Note that not all targets currently emulate atomic operations correctly.
> -x86 and ARM use a global lock in order to preserve their semantics.
> -@end table
> -
> -QEMU was conceived so that ultimately it can emulate itself. Although
> -it is not very useful, it is an important test to show the power of the
> -emulator.
> -
> -@node Linux User space emulator
> -@section Linux User space emulator
> -
> -@menu
> -* Quick Start::
> -* Wine launch::
> -* Command line options::
> -* Other binaries::
> -@end menu
> -
> -@node Quick Start
> -@subsection Quick Start
> -
> -In order to launch a Linux process, QEMU needs the process executable
> -itself and all the target (x86) dynamic libraries used by it.
> -
> -@itemize
> -
> -@item On x86, you can just try to launch any process by using the native
> -libraries:
> -
> -@example
> -qemu-i386 -L / /bin/ls
> -@end example
> -
> -@code{-L /} tells that the x86 dynamic linker must be searched with a
> -@file{/} prefix.
> -
> -@item Since QEMU is also a linux process, you can launch QEMU with
> -QEMU (NOTE: you can only do that if you compiled QEMU from the sources):
> -
> -@example
> -qemu-i386 -L / qemu-i386 -L / /bin/ls
> -@end example
> -
> -@item On non x86 CPUs, you need first to download at least an x86 glibc
> -(@file{qemu-runtime-i386-XXX-.tar.gz} on the QEMU web page). Ensure that
> -@code{LD_LIBRARY_PATH} is not set:
> -
> -@example
> -unset LD_LIBRARY_PATH
> -@end example
> -
> -Then you can launch the precompiled @file{ls} x86 executable:
> -
> -@example
> -qemu-i386 tests/i386/ls
> -@end example
> -You can look at @file{scripts/qemu-binfmt-conf.sh} so that
> -QEMU is automatically launched by the Linux kernel when you try to
> -launch x86 executables. It requires the @code{binfmt_misc} module in the
> -Linux kernel.
> -
> -@item The x86 version of QEMU is also included. You can try weird things such as:
> -@example
> -qemu-i386 /usr/local/qemu-i386/bin/qemu-i386 \
> - /usr/local/qemu-i386/bin/ls-i386
> -@end example
> -
> -@end itemize
> -
> -@node Wine launch
> -@subsection Wine launch
> -
> -@itemize
> -
> -@item Ensure that you have a working QEMU with the x86 glibc
> -distribution (see previous section). In order to verify it, you must be
> -able to do:
> -
> -@example
> -qemu-i386 /usr/local/qemu-i386/bin/ls-i386
> -@end example
> -
> -@item Download the binary x86 Wine install
> -(@file{qemu-XXX-i386-wine.tar.gz} on the QEMU web page).
> -
> -@item Configure Wine on your account. Look at the provided script
> -@file{/usr/local/qemu-i386/@/bin/wine-conf.sh}. Your previous
> -@code{$@{HOME@}/.wine} directory is saved to @code{$@{HOME@}/.wine.org}.
> -
> -@item Then you can try the example @file{putty.exe}:
> -
> -@example
> -qemu-i386 /usr/local/qemu-i386/wine/bin/wine \
> - /usr/local/qemu-i386/wine/c/Program\ Files/putty.exe
> -@end example
> -
> -@end itemize
> -
> -@node Command line options
> -@subsection Command line options
> -
> -@example
> -@command{qemu-i386} [@option{-h]} [@option{-d]} [@option{-L} @var{path}] [@option{-s} @var{size}] [@option{-cpu} @var{model}] [@option{-g} @var{port}] [@option{-B} @var{offset}] [@option{-R} @var{size}] @var{program} [@var{arguments}...]
> -@end example
> -
> -@table @option
> -@item -h
> -Print the help
> -@item -L path
> -Set the x86 elf interpreter prefix (default=/usr/local/qemu-i386)
> -@item -s size
> -Set the x86 stack size in bytes (default=524288)
> -@item -cpu model
> -Select CPU model (-cpu help for list and additional feature selection)
> -@item -E @var{var}=@var{value}
> -Set environment @var{var} to @var{value}.
> -@item -U @var{var}
> -Remove @var{var} from the environment.
> -@item -B offset
> -Offset guest address by the specified number of bytes. This is useful when
> -the address region required by guest applications is reserved on the host.
> -This option is currently only supported on some hosts.
> -@item -R size
> -Pre-allocate a guest virtual address space of the given size (in bytes).
> -"G", "M", and "k" suffixes may be used when specifying the size.
> -@end table
> -
> -Debug options:
> -
> -@table @option
> -@item -d item1,...
> -Activate logging of the specified items (use '-d help' for a list of log items)
> -@item -p pagesize
> -Act as if the host page size was 'pagesize' bytes
> -@item -g port
> -Wait gdb connection to port
> -@item -singlestep
> -Run the emulation in single step mode.
> -@end table
> -
> -Environment variables:
> -
> -@table @env
> -@item QEMU_STRACE
> -Print system calls and arguments similar to the 'strace' program
> -(NOTE: the actual 'strace' program will not work because the user
> -space emulator hasn't implemented ptrace). At the moment this is
> -incomplete. All system calls that don't have a specific argument
> -format are printed with information for six arguments. Many
> -flag-style arguments don't have decoders and will show up as numbers.
> -@end table
> -
> -@node Other binaries
> -@subsection Other binaries
> -
> -@cindex user mode (Alpha)
> -@command{qemu-alpha} TODO.
> -
> -@cindex user mode (ARM)
> -@command{qemu-armeb} TODO.
> -
> -@cindex user mode (ARM)
> -@command{qemu-arm} is also capable of running ARM "Angel" semihosted ELF
> -binaries (as implemented by the arm-elf and arm-eabi Newlib/GDB
> -configurations), and arm-uclinux bFLT format binaries.
> -
> -@cindex user mode (ColdFire)
> -@cindex user mode (M68K)
> -@command{qemu-m68k} is capable of running semihosted binaries using the BDM
> -(m5xxx-ram-hosted.ld) or m68k-sim (sim.ld) syscall interfaces, and
> -coldfire uClinux bFLT format binaries.
> -
> -The binary format is detected automatically.
> -
> -@cindex user mode (Cris)
> -@command{qemu-cris} TODO.
> -
> -@cindex user mode (i386)
> -@command{qemu-i386} TODO.
> -@command{qemu-x86_64} TODO.
> -
> -@cindex user mode (Microblaze)
> -@command{qemu-microblaze} TODO.
> -
> -@cindex user mode (MIPS)
> -@command{qemu-mips} executes 32-bit big endian MIPS binaries (MIPS O32 ABI).
> -
> -@command{qemu-mipsel} executes 32-bit little endian MIPS binaries (MIPS O32 ABI).
> -
> -@command{qemu-mips64} executes 64-bit big endian MIPS binaries (MIPS N64 ABI).
> -
> -@command{qemu-mips64el} executes 64-bit little endian MIPS binaries (MIPS N64 ABI).
> -
> -@command{qemu-mipsn32} executes 32-bit big endian MIPS binaries (MIPS N32 ABI).
> -
> -@command{qemu-mipsn32el} executes 32-bit little endian MIPS binaries (MIPS N32 ABI).
> -
> -@cindex user mode (NiosII)
> -@command{qemu-nios2} TODO.
> -
> -@cindex user mode (PowerPC)
> -@command{qemu-ppc64abi32} TODO.
> -@command{qemu-ppc64} TODO.
> -@command{qemu-ppc} TODO.
> -
> -@cindex user mode (SH4)
> -@command{qemu-sh4eb} TODO.
> -@command{qemu-sh4} TODO.
> -
> -@cindex user mode (SPARC)
> -@command{qemu-sparc} can execute Sparc32 binaries (Sparc32 CPU, 32 bit ABI).
> -
> -@command{qemu-sparc32plus} can execute Sparc32 and SPARC32PLUS binaries
> -(Sparc64 CPU, 32 bit ABI).
> -
> -@command{qemu-sparc64} can execute some Sparc64 (Sparc64 CPU, 64 bit ABI) and
> -SPARC32PLUS binaries (Sparc64 CPU, 32 bit ABI).
> -
> -@node BSD User space emulator
> -@section BSD User space emulator
> -
> -@menu
> -* BSD Status::
> -* BSD Quick Start::
> -* BSD Command line options::
> -@end menu
> -
> -@node BSD Status
> -@subsection BSD Status
> -
> -@itemize @minus
> -@item
> -target Sparc64 on Sparc64: Some trivial programs work.
> -@end itemize
> -
> -@node BSD Quick Start
> -@subsection Quick Start
> -
> -In order to launch a BSD process, QEMU needs the process executable
> -itself and all the target dynamic libraries used by it.
> -
> -@itemize
> -
> -@item On Sparc64, you can just try to launch any process by using the native
> -libraries:
> -
> -@example
> -qemu-sparc64 /bin/ls
> -@end example
> -
> -@end itemize
> -
> -@node BSD Command line options
> -@subsection Command line options
> -
> -@example
> -@command{qemu-sparc64} [@option{-h]} [@option{-d]} [@option{-L} @var{path}] [@option{-s} @var{size}] [@option{-bsd} @var{type}] @var{program} [@var{arguments}...]
> -@end example
> -
> -@table @option
> -@item -h
> -Print the help
> -@item -L path
> -Set the library root path (default=/)
> -@item -s size
> -Set the stack size in bytes (default=524288)
> -@item -ignore-environment
> -Start with an empty environment. Without this option,
> -the initial environment is a copy of the caller's environment.
> -@item -E @var{var}=@var{value}
> -Set environment @var{var} to @var{value}.
> -@item -U @var{var}
> -Remove @var{var} from the environment.
> -@item -bsd type
> -Set the type of the emulated BSD Operating system. Valid values are
> -FreeBSD, NetBSD and OpenBSD (default).
> -@end table
> -
> -Debug options:
> -
> -@table @option
> -@item -d item1,...
> -Activate logging of the specified items (use '-d help' for a list of log items)
> -@item -p pagesize
> -Act as if the host page size was 'pagesize' bytes
> -@item -singlestep
> -Run the emulation in single step mode.
> -@end table
> -
> @node System requirements
> @chapter System requirements
--
Alex Bennée
^ permalink raw reply [flat|nested] 82+ messages in thread
* [PATCH v3 02/33] qemu-doc: remove target OS documentation
2020-02-28 15:35 [PATCH v3 00/33] Convert qemu-doc to rST Peter Maydell
2020-02-28 15:35 ` [PATCH v3 01/33] qemu-doc: convert user-mode emulation to a separate Sphinx manual Peter Maydell
@ 2020-02-28 15:35 ` Peter Maydell
2020-03-02 11:05 ` Alex Bennée
2020-02-28 15:35 ` [PATCH v3 03/33] texi2pod: parse @include directives outside "@c man" blocks Peter Maydell
` (33 subsequent siblings)
35 siblings, 1 reply; 82+ messages in thread
From: Peter Maydell @ 2020-02-28 15:35 UTC (permalink / raw)
To: qemu-devel; +Cc: Paolo Bonzini, Kashyap Chamarthy
From: Paolo Bonzini <pbonzini@redhat.com>
This section covers OSes up to Windows 2000, and as such it is mostly
obsolete. Zap it.
Reviewed-by: Peter Maydell <peter.maydell@linaro.org>
Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
Message-id: 20200226113034.6741-3-pbonzini@redhat.com
Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
---
qemu-doc.texi | 96 ---------------------------------------------------
1 file changed, 96 deletions(-)
diff --git a/qemu-doc.texi b/qemu-doc.texi
index 6636816b85f..e555dea4ef6 100644
--- a/qemu-doc.texi
+++ b/qemu-doc.texi
@@ -148,7 +148,6 @@ 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
-* pcsys_os_specific:: Target OS specific information
@end menu
@node pcsys_introduction
@@ -1605,101 +1604,6 @@ received: "OK"
@end example
@end table
-@node pcsys_os_specific
-@section Target OS specific information
-
-@subsection Linux
-
-To have access to SVGA graphic modes under X11, use the @code{vesa} or
-the @code{cirrus} X11 driver. For optimal performances, use 16 bit
-color depth in the guest and the host OS.
-
-When using a 2.6 guest Linux kernel, you should add the option
-@code{clock=pit} on the kernel command line because the 2.6 Linux
-kernels make very strict real time clock checks by default that QEMU
-cannot simulate exactly.
-
-When using a 2.6 guest Linux kernel, verify that the 4G/4G patch is
-not activated because QEMU is slower with this patch. The QEMU
-Accelerator Module is also much slower in this case. Earlier Fedora
-Core 3 Linux kernel (< 2.6.9-1.724_FC3) were known to incorporate this
-patch by default. Newer kernels don't have it.
-
-@subsection Windows
-
-If you have a slow host, using Windows 95 is better as it gives the
-best speed. Windows 2000 is also a good choice.
-
-@subsubsection SVGA graphic modes support
-
-QEMU emulates a Cirrus Logic GD5446 Video
-card. All Windows versions starting from Windows 95 should recognize
-and use this graphic card. For optimal performances, use 16 bit color
-depth in the guest and the host OS.
-
-If you are using Windows XP as guest OS and if you want to use high
-resolution modes which the Cirrus Logic BIOS does not support (i.e. >=
-1280x1024x16), then you should use the VESA VBE virtual graphic card
-(option @option{-std-vga}).
-
-@subsubsection CPU usage reduction
-
-Windows 9x does not correctly use the CPU HLT
-instruction. The result is that it takes host CPU cycles even when
-idle. You can install the utility from
-@url{https://web.archive.org/web/20060212132151/http://www.user.cityline.ru/~maxamn/amnhltm.zip}
-to solve this problem. Note that no such tool is needed for NT, 2000 or XP.
-
-@subsubsection Windows 2000 disk full problem
-
-Windows 2000 has a bug which gives a disk full problem during its
-installation. When installing it, use the @option{-win2k-hack} QEMU
-option to enable a specific workaround. After Windows 2000 is
-installed, you no longer need this option (this option slows down the
-IDE transfers).
-
-@subsubsection Windows 2000 shutdown
-
-Windows 2000 cannot automatically shutdown in QEMU although Windows 98
-can. It comes from the fact that Windows 2000 does not automatically
-use the APM driver provided by the BIOS.
-
-In order to correct that, do the following (thanks to Struan
-Bartlett): go to the Control Panel => Add/Remove Hardware & Next =>
-Add/Troubleshoot a device => Add a new device & Next => No, select the
-hardware from a list & Next => NT Apm/Legacy Support & Next => Next
-(again) a few times. Now the driver is installed and Windows 2000 now
-correctly instructs QEMU to shutdown at the appropriate moment.
-
-@subsubsection Share a directory between Unix and Windows
-
-See @ref{sec_invocation} about the help of the option
-@option{'-netdev user,smb=...'}.
-
-@subsubsection Windows XP security problem
-
-Some releases of Windows XP install correctly but give a security
-error when booting:
-@example
-A problem is preventing Windows from accurately checking the
-license for this computer. Error code: 0x800703e6.
-@end example
-
-The workaround is to install a service pack for XP after a boot in safe
-mode. Then reboot, and the problem should go away. Since there is no
-network while in safe mode, its recommended to download the full
-installation of SP1 or SP2 and transfer that via an ISO or using the
-vvfat block device ("-hdb fat:directory_which_holds_the_SP").
-
-@subsection MS-DOS and FreeDOS
-
-@subsubsection CPU usage reduction
-
-DOS does not correctly use the CPU HLT instruction. The result is that
-it takes host CPU cycles even when idle. You can install the utility from
-@url{https://web.archive.org/web/20051222085335/http://www.vmware.com/software/dosidle210.zip}
-to solve this problem.
-
@node QEMU System emulator for non PC targets
@chapter QEMU System emulator for non PC targets
--
2.20.1
^ permalink raw reply related [flat|nested] 82+ messages in thread* Re: [PATCH v3 02/33] qemu-doc: remove target OS documentation
2020-02-28 15:35 ` [PATCH v3 02/33] qemu-doc: remove target OS documentation Peter Maydell
@ 2020-03-02 11:05 ` Alex Bennée
0 siblings, 0 replies; 82+ messages in thread
From: Alex Bennée @ 2020-03-02 11:05 UTC (permalink / raw)
To: Peter Maydell; +Cc: Paolo Bonzini, qemu-devel, Kashyap Chamarthy
Peter Maydell <peter.maydell@linaro.org> writes:
> From: Paolo Bonzini <pbonzini@redhat.com>
>
> This section covers OSes up to Windows 2000, and as such it is mostly
> obsolete. Zap it.
>
> Reviewed-by: Peter Maydell <peter.maydell@linaro.org>
> Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
> Message-id: 20200226113034.6741-3-pbonzini@redhat.com
> Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
Reviewed-by: Alex Bennée <alex.bennee@linaro.org>
> ---
> qemu-doc.texi | 96 ---------------------------------------------------
> 1 file changed, 96 deletions(-)
>
> diff --git a/qemu-doc.texi b/qemu-doc.texi
> index 6636816b85f..e555dea4ef6 100644
> --- a/qemu-doc.texi
> +++ b/qemu-doc.texi
> @@ -148,7 +148,6 @@ 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
> -* pcsys_os_specific:: Target OS specific information
> @end menu
>
> @node pcsys_introduction
> @@ -1605,101 +1604,6 @@ received: "OK"
> @end example
> @end table
>
> -@node pcsys_os_specific
> -@section Target OS specific information
> -
> -@subsection Linux
> -
> -To have access to SVGA graphic modes under X11, use the @code{vesa} or
> -the @code{cirrus} X11 driver. For optimal performances, use 16 bit
> -color depth in the guest and the host OS.
> -
> -When using a 2.6 guest Linux kernel, you should add the option
> -@code{clock=pit} on the kernel command line because the 2.6 Linux
> -kernels make very strict real time clock checks by default that QEMU
> -cannot simulate exactly.
> -
> -When using a 2.6 guest Linux kernel, verify that the 4G/4G patch is
> -not activated because QEMU is slower with this patch. The QEMU
> -Accelerator Module is also much slower in this case. Earlier Fedora
> -Core 3 Linux kernel (< 2.6.9-1.724_FC3) were known to incorporate this
> -patch by default. Newer kernels don't have it.
> -
> -@subsection Windows
> -
> -If you have a slow host, using Windows 95 is better as it gives the
> -best speed. Windows 2000 is also a good choice.
> -
> -@subsubsection SVGA graphic modes support
> -
> -QEMU emulates a Cirrus Logic GD5446 Video
> -card. All Windows versions starting from Windows 95 should recognize
> -and use this graphic card. For optimal performances, use 16 bit color
> -depth in the guest and the host OS.
> -
> -If you are using Windows XP as guest OS and if you want to use high
> -resolution modes which the Cirrus Logic BIOS does not support (i.e. >=
> -1280x1024x16), then you should use the VESA VBE virtual graphic card
> -(option @option{-std-vga}).
> -
> -@subsubsection CPU usage reduction
> -
> -Windows 9x does not correctly use the CPU HLT
> -instruction. The result is that it takes host CPU cycles even when
> -idle. You can install the utility from
> -@url{https://web.archive.org/web/20060212132151/http://www.user.cityline.ru/~maxamn/amnhltm.zip}
> -to solve this problem. Note that no such tool is needed for NT, 2000 or XP.
> -
> -@subsubsection Windows 2000 disk full problem
> -
> -Windows 2000 has a bug which gives a disk full problem during its
> -installation. When installing it, use the @option{-win2k-hack} QEMU
> -option to enable a specific workaround. After Windows 2000 is
> -installed, you no longer need this option (this option slows down the
> -IDE transfers).
> -
> -@subsubsection Windows 2000 shutdown
> -
> -Windows 2000 cannot automatically shutdown in QEMU although Windows 98
> -can. It comes from the fact that Windows 2000 does not automatically
> -use the APM driver provided by the BIOS.
> -
> -In order to correct that, do the following (thanks to Struan
> -Bartlett): go to the Control Panel => Add/Remove Hardware & Next =>
> -Add/Troubleshoot a device => Add a new device & Next => No, select the
> -hardware from a list & Next => NT Apm/Legacy Support & Next => Next
> -(again) a few times. Now the driver is installed and Windows 2000 now
> -correctly instructs QEMU to shutdown at the appropriate moment.
> -
> -@subsubsection Share a directory between Unix and Windows
> -
> -See @ref{sec_invocation} about the help of the option
> -@option{'-netdev user,smb=...'}.
> -
> -@subsubsection Windows XP security problem
> -
> -Some releases of Windows XP install correctly but give a security
> -error when booting:
> -@example
> -A problem is preventing Windows from accurately checking the
> -license for this computer. Error code: 0x800703e6.
> -@end example
> -
> -The workaround is to install a service pack for XP after a boot in safe
> -mode. Then reboot, and the problem should go away. Since there is no
> -network while in safe mode, its recommended to download the full
> -installation of SP1 or SP2 and transfer that via an ISO or using the
> -vvfat block device ("-hdb fat:directory_which_holds_the_SP").
> -
> -@subsection MS-DOS and FreeDOS
> -
> -@subsubsection CPU usage reduction
> -
> -DOS does not correctly use the CPU HLT instruction. The result is that
> -it takes host CPU cycles even when idle. You can install the utility from
> -@url{https://web.archive.org/web/20051222085335/http://www.vmware.com/software/dosidle210.zip}
> -to solve this problem.
> -
> @node QEMU System emulator for non PC targets
> @chapter QEMU System emulator for non PC targets
--
Alex Bennée
^ permalink raw reply [flat|nested] 82+ messages in thread
* [PATCH v3 03/33] texi2pod: parse @include directives outside "@c man" blocks
2020-02-28 15:35 [PATCH v3 00/33] Convert qemu-doc to rST Peter Maydell
2020-02-28 15:35 ` [PATCH v3 01/33] qemu-doc: convert user-mode emulation to a separate Sphinx manual Peter Maydell
2020-02-28 15:35 ` [PATCH v3 02/33] qemu-doc: remove target OS documentation Peter Maydell
@ 2020-02-28 15:35 ` Peter Maydell
2020-03-02 11:07 ` Alex Bennée
2020-02-28 15:35 ` [PATCH v3 04/33] qemu-doc: split CPU models doc between MIPS and x86 parts Peter Maydell
` (32 subsequent siblings)
35 siblings, 1 reply; 82+ messages in thread
From: Peter Maydell @ 2020-02-28 15:35 UTC (permalink / raw)
To: qemu-devel; +Cc: Paolo Bonzini, Kashyap Chamarthy
From: Paolo Bonzini <pbonzini@redhat.com>
This enables splitting the huge qemu-doc.texi file and keeping parallel
Texinfo and rST versions of the documentation. texi2pod is not going to
live much longer and hardly anyone cares about its upstream status,
so the temporary fork should be acceptable.
Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
Message-id: 20200226113034.6741-4-pbonzini@redhat.com
Reviewed-by: Peter Maydell <peter.maydell@linaro.org>
Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
---
scripts/texi2pod.pl | 36 ++++++++++++++++++------------------
1 file changed, 18 insertions(+), 18 deletions(-)
diff --git a/scripts/texi2pod.pl b/scripts/texi2pod.pl
index 839b7917cf7..8bfc6f6f4c4 100755
--- a/scripts/texi2pod.pl
+++ b/scripts/texi2pod.pl
@@ -143,6 +143,24 @@ while(<$inf>) {
next;
};
+ # Single line command handlers.
+
+ /^\@include\s+(.+)$/ and do {
+ push @instack, $inf;
+ $inf = gensym();
+ $file = postprocess($1);
+
+ # Try cwd and $ibase, then explicit -I paths.
+ $done = 0;
+ foreach $path ("", $ibase, @ipath) {
+ $mypath = $file;
+ $mypath = $path . "/" . $mypath if ($path ne "");
+ open($inf, "<" . $mypath) and ($done = 1, last);
+ }
+ die "cannot find $file" if !$done;
+ next;
+ };
+
next unless $output;
# Discard comments. (Can't do it above, because then we'd never see
@@ -242,24 +260,6 @@ while(<$inf>) {
s/>/>/g;
}
- # Single line command handlers.
-
- /^\@include\s+(.+)$/ and do {
- push @instack, $inf;
- $inf = gensym();
- $file = postprocess($1);
-
- # Try cwd and $ibase, then explicit -I paths.
- $done = 0;
- foreach $path ("", $ibase, @ipath) {
- $mypath = $file;
- $mypath = $path . "/" . $mypath if ($path ne "");
- open($inf, "<" . $mypath) and ($done = 1, last);
- }
- die "cannot find $file" if !$done;
- next;
- };
-
/^\@(?:section|unnumbered|unnumberedsec|center)\s+(.+)$/
and $_ = "\n=head2 $1\n";
/^\@subsection\s+(.+)$/
--
2.20.1
^ permalink raw reply related [flat|nested] 82+ messages in thread* Re: [PATCH v3 03/33] texi2pod: parse @include directives outside "@c man" blocks
2020-02-28 15:35 ` [PATCH v3 03/33] texi2pod: parse @include directives outside "@c man" blocks Peter Maydell
@ 2020-03-02 11:07 ` Alex Bennée
0 siblings, 0 replies; 82+ messages in thread
From: Alex Bennée @ 2020-03-02 11:07 UTC (permalink / raw)
To: Peter Maydell; +Cc: Paolo Bonzini, qemu-devel, Kashyap Chamarthy
Peter Maydell <peter.maydell@linaro.org> writes:
> From: Paolo Bonzini <pbonzini@redhat.com>
>
> This enables splitting the huge qemu-doc.texi file and keeping parallel
> Texinfo and rST versions of the documentation. texi2pod is not going to
> live much longer and hardly anyone cares about its upstream status,
> so the temporary fork should be acceptable.
>
> Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
> Message-id: 20200226113034.6741-4-pbonzini@redhat.com
> Reviewed-by: Peter Maydell <peter.maydell@linaro.org>
> Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
Reviewed-by: Alex Bennée <alex.bennee@linaro.org>
> ---
> scripts/texi2pod.pl | 36 ++++++++++++++++++------------------
> 1 file changed, 18 insertions(+), 18 deletions(-)
>
> diff --git a/scripts/texi2pod.pl b/scripts/texi2pod.pl
> index 839b7917cf7..8bfc6f6f4c4 100755
> --- a/scripts/texi2pod.pl
> +++ b/scripts/texi2pod.pl
> @@ -143,6 +143,24 @@ while(<$inf>) {
> next;
> };
>
> + # Single line command handlers.
> +
> + /^\@include\s+(.+)$/ and do {
> + push @instack, $inf;
> + $inf = gensym();
> + $file = postprocess($1);
> +
> + # Try cwd and $ibase, then explicit -I paths.
> + $done = 0;
> + foreach $path ("", $ibase, @ipath) {
> + $mypath = $file;
> + $mypath = $path . "/" . $mypath if ($path ne "");
> + open($inf, "<" . $mypath) and ($done = 1, last);
> + }
> + die "cannot find $file" if !$done;
> + next;
> + };
> +
> next unless $output;
>
> # Discard comments. (Can't do it above, because then we'd never see
> @@ -242,24 +260,6 @@ while(<$inf>) {
> s/>/>/g;
> }
>
> - # Single line command handlers.
> -
> - /^\@include\s+(.+)$/ and do {
> - push @instack, $inf;
> - $inf = gensym();
> - $file = postprocess($1);
> -
> - # Try cwd and $ibase, then explicit -I paths.
> - $done = 0;
> - foreach $path ("", $ibase, @ipath) {
> - $mypath = $file;
> - $mypath = $path . "/" . $mypath if ($path ne "");
> - open($inf, "<" . $mypath) and ($done = 1, last);
> - }
> - die "cannot find $file" if !$done;
> - next;
> - };
> -
> /^\@(?:section|unnumbered|unnumberedsec|center)\s+(.+)$/
> and $_ = "\n=head2 $1\n";
> /^\@subsection\s+(.+)$/
--
Alex Bennée
^ permalink raw reply [flat|nested] 82+ messages in thread
* [PATCH v3 04/33] qemu-doc: split CPU models doc between MIPS and x86 parts
2020-02-28 15:35 [PATCH v3 00/33] Convert qemu-doc to rST Peter Maydell
` (2 preceding siblings ...)
2020-02-28 15:35 ` [PATCH v3 03/33] texi2pod: parse @include directives outside "@c man" blocks Peter Maydell
@ 2020-02-28 15:35 ` Peter Maydell
2020-03-02 11:18 ` Alex Bennée
2020-02-28 15:35 ` [PATCH v3 05/33] qemu-doc: split qemu-doc.texi in multiple files Peter Maydell
` (31 subsequent siblings)
35 siblings, 1 reply; 82+ messages in thread
From: Peter Maydell @ 2020-02-28 15:35 UTC (permalink / raw)
To: qemu-devel; +Cc: Paolo Bonzini, Kashyap Chamarthy
From: Paolo Bonzini <pbonzini@redhat.com>
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 <pbonzini@redhat.com>
Message-id: 20200226113034.6741-5-pbonzini@redhat.com
Reviewed-by: Peter Maydell <peter.maydell@linaro.org>
Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
---
Makefile | 11 +-
MAINTAINERS | 3 +-
docs/system/cpu-models-mips.texi | 157 +++++++++++++
.../cpu-models-x86.texi} | 221 ++----------------
docs/system/qemu-cpu-models.texi | 28 +++
qemu-doc.texi | 12 +-
6 files changed, 213 insertions(+), 219 deletions(-)
create mode 100644 docs/system/cpu-models-mips.texi
rename docs/{qemu-cpu-models.texi => system/cpu-models-x86.texi} (71%)
create mode 100644 docs/system/qemu-cpu-models.texi
diff --git a/Makefile b/Makefile
index faa0ffa05b0..f75a7b51938 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/qemu-cpu-models.7
+DOCS+=docs/system/qemu-cpu-models.7
DOCS+=$(MANUAL_BUILDDIR)/index.html
ifdef CONFIG_VIRTFS
DOCS+=$(MANUAL_BUILDDIR)/tools/virtfs-proxy-helper.1
@@ -780,7 +780,7 @@ 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/qemu-cpu-models.7
+ rm -f docs/system/qemu-cpu-models.7
rm -rf .doctrees
$(call clean-manual,devel)
$(call clean-manual,interop)
@@ -861,7 +861,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/qemu-cpu-models.7 "$(DESTDIR)$(mandir)/man7"
+ $(INSTALL_DATA) docs/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"
@@ -1111,7 +1111,7 @@ 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: qemu-option-trace.texi
-docs/qemu-cpu-models.7: docs/qemu-cpu-models.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
@@ -1123,7 +1123,8 @@ 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/qemu-cpu-models.texi docs/security.texi
+ docs/system/cpu-models-x86.texi docs/system/cpu-models-mips.texi \
+ docs/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/MAINTAINERS b/MAINTAINERS
index b66c46dcb9f..8c6d8f533ce 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -215,6 +215,7 @@ S: Maintained
F: target/mips/
F: default-configs/*mips*
F: disas/*mips*
+F: docs/system/cpu-models-mips.texi
F: hw/intc/mips_gic.c
F: hw/mips/
F: hw/misc/mips_*
@@ -319,7 +320,7 @@ F: tests/tcg/i386/
F: tests/tcg/x86_64/
F: hw/i386/
F: disas/i386.c
-F: docs/qemu-cpu-models.texi
+F: docs/system/cpu-models-x86.texi
T: git https://github.com/ehabkost/qemu.git x86-next
Xtensa TCG CPUs
diff --git a/docs/system/cpu-models-mips.texi b/docs/system/cpu-models-mips.texi
new file mode 100644
index 00000000000..6a0370cb693
--- /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/qemu-cpu-models.texi b/docs/system/cpu-models-x86.texi
similarity index 71%
rename from docs/qemu-cpu-models.texi
rename to docs/system/cpu-models-x86.texi
index f88a1def0d0..0cd64b0522e 100644
--- a/docs/qemu-cpu-models.texi
+++ b/docs/system/cpu-models-x86.texi
@@ -1,16 +1,5 @@
-@c man begin SYNOPSIS
-QEMU / KVM CPU model configuration
-@c man end
-
-@set qemu_system_x86 qemu-system-x86_64
-
-@c man begin DESCRIPTION
-
-@menu
-* recommendations_cpu_models_x86:: Recommendations for KVM CPU model configuration on x86 hosts
-* recommendations_cpu_models_MIPS:: Supported CPU model configurations on MIPS hosts
-* cpu_model_syntax_apps:: Syntax for configuring CPU models
-@end menu
+@node cpu_models_x86
+@section Recommendations for KVM CPU model configuration on x86 hosts
QEMU / KVM virtualization supports two ways to configure CPU models
@@ -45,9 +34,6 @@ 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.
-@node recommendations_cpu_models_x86
-@subsection 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
@@ -60,10 +46,11 @@ enabling live migration between hosts with heterogeneous CPU models.
* 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
-@subsubsection Preferred CPU models for Intel x86 hosts
+@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
@@ -136,7 +123,7 @@ Intel Celeron_4x0 (Conroe/Merom Class Core 2, 2006)
@end table
@node important_cpu_features_intel_x86
-@subsubsection Important CPU features for Intel x86 hosts
+@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
@@ -218,7 +205,7 @@ can be used for guest CPUs.
@node preferred_cpu_models_amd_x86
-@subsubsection Preferred CPU models for AMD x86 hosts
+@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
@@ -260,7 +247,7 @@ AMD Opteron 240 (Gen 1 Class Opteron, 2004)
@end table
@node important_cpu_features_amd_x86
-@subsubsection Important CPU features for AMD x86 hosts
+@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
@@ -349,7 +336,7 @@ Note that not all CPU hardware will support this feature.
@node default_cpu_models_x86
-@subsubsection Default x86 CPU models
+@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
@@ -372,7 +359,7 @@ qemu64 is used for x86_64 guests and qemu32 is used for i686 guests, when no
@node other_non_recommended_cpu_models_x86
-@subsubsection Other non-recommended x86 CPUs
+@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
@@ -403,177 +390,13 @@ hardware assisted virtualization, that should thus not be required for
running virtual machines.
@end table
-@node recommendations_cpu_models_MIPS
-@subsection 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
-@subsubsection 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
-@subsubsection 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
-@subsubsection 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
-@subsubsection 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
-
@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
+CPU models / features in QEMU and libvirt.
-@menu
-* cpu_model_syntax_qemu:: QEMU command line
-* cpu_model_syntax_libvirt:: Libvirt guest XML
-@end menu
-
-@node cpu_model_syntax_qemu
-@subsubsection QEMU command line
+QEMU command line:
@table @option
@@ -603,8 +426,8 @@ With feature customization:
@end table
-@node cpu_model_syntax_libvirt
-@subsubsection Libvirt guest XML
+
+Libvirt guest XML:
@table @option
@@ -657,21 +480,3 @@ With feature customization:
@end example
@end table
-
-@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
diff --git a/docs/system/qemu-cpu-models.texi b/docs/system/qemu-cpu-models.texi
new file mode 100644
index 00000000000..f399daf9448
--- /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
diff --git a/qemu-doc.texi b/qemu-doc.texi
index e555dea4ef6..617a701b678 100644
--- a/qemu-doc.texi
+++ b/qemu-doc.texi
@@ -139,7 +139,7 @@ accelerator is required to use more than one host CPU for emulation.
* pcsys_keys:: Keys in the graphical frontends
* mux_keys:: Keys in the character backend multiplexer
* pcsys_monitor:: QEMU Monitor
-* cpu_models:: CPU models
+* cpu_models_x86:: Supported CPU model configurations on x86 hosts
* disk_images:: Disk Images
* pcsys_network:: Network emulation
* pcsys_other_devs:: Other Devices
@@ -614,10 +614,7 @@ 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{$}.
-@node cpu_models
-@section CPU models
-
-@include docs/qemu-cpu-models.texi
+@include docs/system/cpu-models-x86.texi
@node disk_images
@section Disk Images
@@ -1864,6 +1861,7 @@ Set the emulated machine type. The default is sun4u.
@cindex system emulation (MIPS)
@menu
+* recommendations_cpu_models_MIPS:: Supported CPU model configurations on MIPS hosts
* nanoMIPS System emulator ::
@end menu
@@ -1980,6 +1978,10 @@ PC style serial port
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)
--
2.20.1
^ permalink raw reply related [flat|nested] 82+ messages in thread* Re: [PATCH v3 04/33] qemu-doc: split CPU models doc between MIPS and x86 parts
2020-02-28 15:35 ` [PATCH v3 04/33] qemu-doc: split CPU models doc between MIPS and x86 parts Peter Maydell
@ 2020-03-02 11:18 ` Alex Bennée
0 siblings, 0 replies; 82+ messages in thread
From: Alex Bennée @ 2020-03-02 11:18 UTC (permalink / raw)
To: Peter Maydell; +Cc: Paolo Bonzini, qemu-devel, Kashyap Chamarthy
Peter Maydell <peter.maydell@linaro.org> writes:
> From: Paolo Bonzini <pbonzini@redhat.com>
>
> 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.
We really need to flesh that out one day - it's not like ARM hasn't got
it's own tweaks.
>
> Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
> Message-id: 20200226113034.6741-5-pbonzini@redhat.com
> Reviewed-by: Peter Maydell <peter.maydell@linaro.org>
> Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
> ---
> Makefile | 11 +-
> MAINTAINERS | 3 +-
> docs/system/cpu-models-mips.texi | 157 +++++++++++++
> .../cpu-models-x86.texi} | 221 ++----------------
> docs/system/qemu-cpu-models.texi | 28 +++
I wonder if there is something that should go to docs/core? AFAICT the
CPU modelling covers two things:
- system KVM modelling which deals with feature bits and presenting a
common base for the purposes of migration
- TCG modelling which covers what CPUs we can emulate which affects
both linux-user and system emulation
Anyway we can "fix it in post" as they say in the movies ;-)
Reviewed-by: Alex Bennée <alex.bennee@linaro.org>
> qemu-doc.texi | 12 +-
> 6 files changed, 213 insertions(+), 219 deletions(-)
> create mode 100644 docs/system/cpu-models-mips.texi
> rename docs/{qemu-cpu-models.texi => system/cpu-models-x86.texi} (71%)
> create mode 100644 docs/system/qemu-cpu-models.texi
>
> diff --git a/Makefile b/Makefile
> index faa0ffa05b0..f75a7b51938 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/qemu-cpu-models.7
> +DOCS+=docs/system/qemu-cpu-models.7
> DOCS+=$(MANUAL_BUILDDIR)/index.html
> ifdef CONFIG_VIRTFS
> DOCS+=$(MANUAL_BUILDDIR)/tools/virtfs-proxy-helper.1
> @@ -780,7 +780,7 @@ 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/qemu-cpu-models.7
> + rm -f docs/system/qemu-cpu-models.7
> rm -rf .doctrees
> $(call clean-manual,devel)
> $(call clean-manual,interop)
> @@ -861,7 +861,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/qemu-cpu-models.7 "$(DESTDIR)$(mandir)/man7"
> + $(INSTALL_DATA) docs/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"
> @@ -1111,7 +1111,7 @@ 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: qemu-option-trace.texi
> -docs/qemu-cpu-models.7: docs/qemu-cpu-models.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
> @@ -1123,7 +1123,8 @@ 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/qemu-cpu-models.texi docs/security.texi
> + docs/system/cpu-models-x86.texi docs/system/cpu-models-mips.texi \
> + docs/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/MAINTAINERS b/MAINTAINERS
> index b66c46dcb9f..8c6d8f533ce 100644
> --- a/MAINTAINERS
> +++ b/MAINTAINERS
> @@ -215,6 +215,7 @@ S: Maintained
> F: target/mips/
> F: default-configs/*mips*
> F: disas/*mips*
> +F: docs/system/cpu-models-mips.texi
> F: hw/intc/mips_gic.c
> F: hw/mips/
> F: hw/misc/mips_*
> @@ -319,7 +320,7 @@ F: tests/tcg/i386/
> F: tests/tcg/x86_64/
> F: hw/i386/
> F: disas/i386.c
> -F: docs/qemu-cpu-models.texi
> +F: docs/system/cpu-models-x86.texi
> T: git https://github.com/ehabkost/qemu.git x86-next
>
> Xtensa TCG CPUs
> diff --git a/docs/system/cpu-models-mips.texi b/docs/system/cpu-models-mips.texi
> new file mode 100644
> index 00000000000..6a0370cb693
> --- /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/qemu-cpu-models.texi b/docs/system/cpu-models-x86.texi
> similarity index 71%
> rename from docs/qemu-cpu-models.texi
> rename to docs/system/cpu-models-x86.texi
> index f88a1def0d0..0cd64b0522e 100644
> --- a/docs/qemu-cpu-models.texi
> +++ b/docs/system/cpu-models-x86.texi
> @@ -1,16 +1,5 @@
> -@c man begin SYNOPSIS
> -QEMU / KVM CPU model configuration
> -@c man end
> -
> -@set qemu_system_x86 qemu-system-x86_64
> -
> -@c man begin DESCRIPTION
> -
> -@menu
> -* recommendations_cpu_models_x86:: Recommendations for KVM CPU model configuration on x86 hosts
> -* recommendations_cpu_models_MIPS:: Supported CPU model configurations on MIPS hosts
> -* cpu_model_syntax_apps:: Syntax for configuring CPU models
> -@end menu
> +@node cpu_models_x86
> +@section Recommendations for KVM CPU model configuration on x86 hosts
>
> QEMU / KVM virtualization supports two ways to configure CPU models
>
> @@ -45,9 +34,6 @@ 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.
>
> -@node recommendations_cpu_models_x86
> -@subsection 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
> @@ -60,10 +46,11 @@ enabling live migration between hosts with heterogeneous CPU models.
> * 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
> -@subsubsection Preferred CPU models for Intel x86 hosts
> +@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
> @@ -136,7 +123,7 @@ Intel Celeron_4x0 (Conroe/Merom Class Core 2, 2006)
> @end table
>
> @node important_cpu_features_intel_x86
> -@subsubsection Important CPU features for Intel x86 hosts
> +@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
> @@ -218,7 +205,7 @@ can be used for guest CPUs.
>
>
> @node preferred_cpu_models_amd_x86
> -@subsubsection Preferred CPU models for AMD x86 hosts
> +@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
> @@ -260,7 +247,7 @@ AMD Opteron 240 (Gen 1 Class Opteron, 2004)
> @end table
>
> @node important_cpu_features_amd_x86
> -@subsubsection Important CPU features for AMD x86 hosts
> +@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
> @@ -349,7 +336,7 @@ Note that not all CPU hardware will support this feature.
>
>
> @node default_cpu_models_x86
> -@subsubsection Default x86 CPU models
> +@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
> @@ -372,7 +359,7 @@ qemu64 is used for x86_64 guests and qemu32 is used for i686 guests, when no
>
>
> @node other_non_recommended_cpu_models_x86
> -@subsubsection Other non-recommended x86 CPUs
> +@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
> @@ -403,177 +390,13 @@ hardware assisted virtualization, that should thus not be required for
> running virtual machines.
> @end table
>
> -@node recommendations_cpu_models_MIPS
> -@subsection 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
> -@subsubsection 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
> -@subsubsection 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
> -@subsubsection 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
> -@subsubsection 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
> -
> @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
> +CPU models / features in QEMU and libvirt.
>
> -@menu
> -* cpu_model_syntax_qemu:: QEMU command line
> -* cpu_model_syntax_libvirt:: Libvirt guest XML
> -@end menu
> -
> -@node cpu_model_syntax_qemu
> -@subsubsection QEMU command line
> +QEMU command line:
>
> @table @option
>
> @@ -603,8 +426,8 @@ With feature customization:
>
> @end table
>
> -@node cpu_model_syntax_libvirt
> -@subsubsection Libvirt guest XML
> +
> +Libvirt guest XML:
>
> @table @option
>
> @@ -657,21 +480,3 @@ With feature customization:
> @end example
>
> @end table
> -
> -@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
> diff --git a/docs/system/qemu-cpu-models.texi b/docs/system/qemu-cpu-models.texi
> new file mode 100644
> index 00000000000..f399daf9448
> --- /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
> diff --git a/qemu-doc.texi b/qemu-doc.texi
> index e555dea4ef6..617a701b678 100644
> --- a/qemu-doc.texi
> +++ b/qemu-doc.texi
> @@ -139,7 +139,7 @@ accelerator is required to use more than one host CPU for emulation.
> * pcsys_keys:: Keys in the graphical frontends
> * mux_keys:: Keys in the character backend multiplexer
> * pcsys_monitor:: QEMU Monitor
> -* cpu_models:: CPU models
> +* cpu_models_x86:: Supported CPU model configurations on x86 hosts
> * disk_images:: Disk Images
> * pcsys_network:: Network emulation
> * pcsys_other_devs:: Other Devices
> @@ -614,10 +614,7 @@ 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{$}.
>
> -@node cpu_models
> -@section CPU models
> -
> -@include docs/qemu-cpu-models.texi
> +@include docs/system/cpu-models-x86.texi
>
> @node disk_images
> @section Disk Images
> @@ -1864,6 +1861,7 @@ Set the emulated machine type. The default is sun4u.
> @cindex system emulation (MIPS)
>
> @menu
> +* recommendations_cpu_models_MIPS:: Supported CPU model configurations on MIPS hosts
> * nanoMIPS System emulator ::
> @end menu
>
> @@ -1980,6 +1978,10 @@ PC style serial port
> 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)
--
Alex Bennée
^ permalink raw reply [flat|nested] 82+ messages in thread
* [PATCH v3 05/33] qemu-doc: split qemu-doc.texi in multiple files
2020-02-28 15:35 [PATCH v3 00/33] Convert qemu-doc to rST Peter Maydell
` (3 preceding siblings ...)
2020-02-28 15:35 ` [PATCH v3 04/33] qemu-doc: split CPU models doc between MIPS and x86 parts Peter Maydell
@ 2020-02-28 15:35 ` Peter Maydell
2020-03-02 11:22 ` Alex Bennée
2020-02-28 15:35 ` [PATCH v3 06/33] qemu-doc: extract common system emulator documentation from the PC section Peter Maydell
` (30 subsequent siblings)
35 siblings, 1 reply; 82+ messages in thread
From: Peter Maydell @ 2020-02-28 15:35 UTC (permalink / raw)
To: qemu-devel; +Cc: Paolo Bonzini, Kashyap Chamarthy
From: Paolo Bonzini <pbonzini@redhat.com>
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 <pbonzini@redhat.com>
Message-id: 20200226113034.6741-6-pbonzini@redhat.com
Reviewed-by: Peter Maydell <peter.maydell@linaro.org>
Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
---
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
diff --git a/Makefile b/Makefile
index f75a7b51938..9790a0fd15b 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 00000000000..531ef5bed44
--- /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 00000000000..f49bc5891e9
--- /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 00000000000..c5060348ecc
--- /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 00000000000..dac41cc7e55
--- /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://<target-ip>[:<port>]/<target-iqn>/<lun>''
+
+By default qemu will use the iSCSI initiator-name
+'iqn.2008-11.org.linux-kvm[:<name>]' 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://<server-ip>[:<port>]/[<export>]''
+
+Syntax for specifying a NBD device using Unix Domain Sockets; remember
+that '?' is a shell glob character and may need quoting:
+``nbd+unix:///[<export>]?socket=<domain-socket>''
+
+Older syntax that is also recognized:
+``nbd:<server-ip>:<port>[:exportname=<export>]''
+
+Syntax for specifying a NBD device using Unix Domain Sockets
+``nbd:unix:<domain-socket>[:exportname=<export>]''
+
+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
+<protocol>://[<username>[:<password>]@@]<host>/<path>
+@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 <protocol>.
+
+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 00000000000..bd97719eaf7
--- /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 <shm size> 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 00000000000..4c74b3bf4dd
--- /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 00000000000..b682235a7e9
--- /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 00000000000..97c3cefae0a
--- /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 00000000000..c5b6a9b38e4
--- /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 00000000000..c9a2d14cb88
--- /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 00000000000..4a6fb2e6a8a
--- /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 00000000000..8cd5b4bc6e5
--- /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 00000000000..c233531d3a1
--- /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 <<EOF
+cn = Name of your organization
+ca
+cert_signing_key
+EOF
+# certtool --generate-self-signed \
+ --load-privkey ca-key.pem
+ --template ca.info \
+ --outfile ca-cert.pem
+@end example
+
+The @code{ca} keyword in the template sets the v3 basic constraints extension
+to indicate this certificate is for a CA, while @code{cert_signing_key} sets
+the key usage extension to indicate this will be used for signing other keys.
+The generated @code{ca-cert.pem} file should be copied to all servers and
+clients wishing to utilize TLS support in the VNC server. The @code{ca-key.pem}
+must not be disclosed/copied anywhere except the host responsible for issuing
+certificates.
+
+@node tls_generate_server
+@subsection Issuing server certificates
+
+Each server (or host) needs to be issued with a key and certificate. When connecting
+the certificate is sent to the client which validates it against the CA certificate.
+The core pieces of information for a server certificate are the hostnames and/or IP
+addresses that will be used by clients when connecting. The hostname / IP address
+that the client specifies when connecting will be validated against the hostname(s)
+and IP address(es) recorded in the server certificate, and if no match is found
+the client will close the connection.
+
+Thus it is recommended that the server certificate include both the fully qualified
+and unqualified hostnames. If the server will have permanently assigned IP address(es),
+and clients are likely to use them when connecting, they may also be included in the
+certificate. Both IPv4 and IPv6 addresses are supported. Historically certificates
+only included 1 hostname in the @code{CN} field, however, usage of this field for
+validation is now deprecated. Instead modern TLS clients will validate against the
+Subject Alt Name extension data, which allows for multiple entries. In the future
+usage of the @code{CN} field may be discontinued entirely, so providing SAN
+extension data is strongly recommended.
+
+On the host holding the CA, create template files containing the information
+for each server, and use it to issue server certificates.
+
+@example
+# cat > server-hostNNN.info <<EOF
+organization = Name of your organization
+cn = hostNNN.foo.example.com
+dns_name = hostNNN
+dns_name = hostNNN.foo.example.com
+ip_address = 10.0.1.87
+ip_address = 192.8.0.92
+ip_address = 2620:0:cafe::87
+ip_address = 2001:24::92
+tls_www_server
+encryption_key
+signing_key
+EOF
+# certtool --generate-privkey > 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 <<EOF
+country = GB
+state = London
+locality = City Of London
+organization = Name of your organization
+cn = hostNNN.foo.example.com
+tls_www_client
+encryption_key
+signing_key
+EOF
+# certtool --generate-privkey > 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 <<EOF
+country = GB
+state = London
+locality = City Of London
+organization = Name of your organization
+cn = hostNNN.foo.example.com
+dns_name = hostNNN
+dns_name = hostNNN.foo.example.com
+ip_address = 10.0.1.87
+ip_address = 192.8.0.92
+ip_address = 2620:0:cafe::87
+ip_address = 2001:24::92
+tls_www_server
+tls_www_client
+encryption_key
+signing_key
+EOF
+# certtool --generate-privkey > 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 00000000000..840adac9785
--- /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 00000000000..abf7f7fa43a
--- /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 617a701b678..33d24caf946 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://<target-ip>[:<port>]/<target-iqn>/<lun>''
-
-By default qemu will use the iSCSI initiator-name
-'iqn.2008-11.org.linux-kvm[:<name>]' 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://<server-ip>[:<port>]/[<export>]''
-
-Syntax for specifying a NBD device using Unix Domain Sockets; remember
-that '?' is a shell glob character and may need quoting:
-``nbd+unix:///[<export>]?socket=<domain-socket>''
-
-Older syntax that is also recognized:
-``nbd:<server-ip>:<port>[:exportname=<export>]''
-
-Syntax for specifying a NBD device using Unix Domain Sockets
-``nbd:unix:<domain-socket>[:exportname=<export>]''
-
-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
-<protocol>://[<username>[:<password>]@@]<host>/<path>
-@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 <protocol>.
-
-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 <shm size> 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 <<EOF
-cn = Name of your organization
-ca
-cert_signing_key
-EOF
-# certtool --generate-self-signed \
- --load-privkey ca-key.pem
- --template ca.info \
- --outfile ca-cert.pem
-@end example
-
-The @code{ca} keyword in the template sets the v3 basic constraints extension
-to indicate this certificate is for a CA, while @code{cert_signing_key} sets
-the key usage extension to indicate this will be used for signing other keys.
-The generated @code{ca-cert.pem} file should be copied to all servers and
-clients wishing to utilize TLS support in the VNC server. The @code{ca-key.pem}
-must not be disclosed/copied anywhere except the host responsible for issuing
-certificates.
-
-@node tls_generate_server
-@subsection Issuing server certificates
-
-Each server (or host) needs to be issued with a key and certificate. When connecting
-the certificate is sent to the client which validates it against the CA certificate.
-The core pieces of information for a server certificate are the hostnames and/or IP
-addresses that will be used by clients when connecting. The hostname / IP address
-that the client specifies when connecting will be validated against the hostname(s)
-and IP address(es) recorded in the server certificate, and if no match is found
-the client will close the connection.
-
-Thus it is recommended that the server certificate include both the fully qualified
-and unqualified hostnames. If the server will have permanently assigned IP address(es),
-and clients are likely to use them when connecting, they may also be included in the
-certificate. Both IPv4 and IPv6 addresses are supported. Historically certificates
-only included 1 hostname in the @code{CN} field, however, usage of this field for
-validation is now deprecated. Instead modern TLS clients will validate against the
-Subject Alt Name extension data, which allows for multiple entries. In the future
-usage of the @code{CN} field may be discontinued entirely, so providing SAN
-extension data is strongly recommended.
-
-On the host holding the CA, create template files containing the information
-for each server, and use it to issue server certificates.
-
-@example
-# cat > server-hostNNN.info <<EOF
-organization = Name of your organization
-cn = hostNNN.foo.example.com
-dns_name = hostNNN
-dns_name = hostNNN.foo.example.com
-ip_address = 10.0.1.87
-ip_address = 192.8.0.92
-ip_address = 2620:0:cafe::87
-ip_address = 2001:24::92
-tls_www_server
-encryption_key
-signing_key
-EOF
-# certtool --generate-privkey > 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 <<EOF
-country = GB
-state = London
-locality = City Of London
-organization = Name of your organization
-cn = hostNNN.foo.example.com
-tls_www_client
-encryption_key
-signing_key
-EOF
-# certtool --generate-privkey > 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 <<EOF
-country = GB
-state = London
-locality = City Of London
-organization = Name of your organization
-cn = hostNNN.foo.example.com
-dns_name = hostNNN
-dns_name = hostNNN.foo.example.com
-ip_address = 10.0.1.87
-ip_address = 192.8.0.92
-ip_address = 2620:0:cafe::87
-ip_address = 2001:24::92
-tls_www_server
-tls_www_client
-encryption_key
-signing_key
-EOF
-# certtool --generate-privkey > 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
+@include docs/system/build-platforms.texi
-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.
+@include docs/system/license.texi
-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
-
-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}.
@node Index
@appendix Index
--
2.20.1
^ permalink raw reply related [flat|nested] 82+ messages in thread* Re: [PATCH v3 05/33] qemu-doc: split qemu-doc.texi in multiple files
2020-02-28 15:35 ` [PATCH v3 05/33] qemu-doc: split qemu-doc.texi in multiple files Peter Maydell
@ 2020-03-02 11:22 ` Alex Bennée
2020-03-02 12:16 ` Peter Maydell
0 siblings, 1 reply; 82+ messages in thread
From: Alex Bennée @ 2020-03-02 11:22 UTC (permalink / raw)
To: Peter Maydell; +Cc: Paolo Bonzini, qemu-devel, Kashyap Chamarthy
Peter Maydell <peter.maydell@linaro.org> writes:
> From: Paolo Bonzini <pbonzini@redhat.com>
>
> 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 <pbonzini@redhat.com>
> Message-id: 20200226113034.6741-6-pbonzini@redhat.com
> Reviewed-by: Peter Maydell <peter.maydell@linaro.org>
> Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
> ---
> Makefile | 16 +
> docs/system/build-platforms.texi | 67 ++
> docs/system/gdb.texi | 71 ++
The gdb test would be better served in docs/core if we could have
optional sections on invocation rendering depending on if it's built
with system emulation or linux-user docs. Is that something that's
already supported?
Anyway not holding this up:
Reviewed-by: Alex Bennée <alex.bennee@linaro.org>
> 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
>
> diff --git a/Makefile b/Makefile
> index f75a7b51938..9790a0fd15b 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 00000000000..531ef5bed44
> --- /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 00000000000..f49bc5891e9
> --- /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 00000000000..c5060348ecc
> --- /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 00000000000..dac41cc7e55
> --- /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://<target-ip>[:<port>]/<target-iqn>/<lun>''
> +
> +By default qemu will use the iSCSI initiator-name
> +'iqn.2008-11.org.linux-kvm[:<name>]' 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://<server-ip>[:<port>]/[<export>]''
> +
> +Syntax for specifying a NBD device using Unix Domain Sockets; remember
> +that '?' is a shell glob character and may need quoting:
> +``nbd+unix:///[<export>]?socket=<domain-socket>''
> +
> +Older syntax that is also recognized:
> +``nbd:<server-ip>:<port>[:exportname=<export>]''
> +
> +Syntax for specifying a NBD device using Unix Domain Sockets
> +``nbd:unix:<domain-socket>[:exportname=<export>]''
> +
> +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
> +<protocol>://[<username>[:<password>]@@]<host>/<path>
> +@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 <protocol>.
> +
> +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 00000000000..bd97719eaf7
> --- /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 <shm size> 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 00000000000..4c74b3bf4dd
> --- /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 00000000000..b682235a7e9
> --- /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 00000000000..97c3cefae0a
> --- /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 00000000000..c5b6a9b38e4
> --- /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 00000000000..c9a2d14cb88
> --- /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 00000000000..4a6fb2e6a8a
> --- /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 00000000000..8cd5b4bc6e5
> --- /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 00000000000..c233531d3a1
> --- /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 <<EOF
> +cn = Name of your organization
> +ca
> +cert_signing_key
> +EOF
> +# certtool --generate-self-signed \
> + --load-privkey ca-key.pem
> + --template ca.info \
> + --outfile ca-cert.pem
> +@end example
> +
> +The @code{ca} keyword in the template sets the v3 basic constraints extension
> +to indicate this certificate is for a CA, while @code{cert_signing_key} sets
> +the key usage extension to indicate this will be used for signing other keys.
> +The generated @code{ca-cert.pem} file should be copied to all servers and
> +clients wishing to utilize TLS support in the VNC server. The @code{ca-key.pem}
> +must not be disclosed/copied anywhere except the host responsible for issuing
> +certificates.
> +
> +@node tls_generate_server
> +@subsection Issuing server certificates
> +
> +Each server (or host) needs to be issued with a key and certificate. When connecting
> +the certificate is sent to the client which validates it against the CA certificate.
> +The core pieces of information for a server certificate are the hostnames and/or IP
> +addresses that will be used by clients when connecting. The hostname / IP address
> +that the client specifies when connecting will be validated against the hostname(s)
> +and IP address(es) recorded in the server certificate, and if no match is found
> +the client will close the connection.
> +
> +Thus it is recommended that the server certificate include both the fully qualified
> +and unqualified hostnames. If the server will have permanently assigned IP address(es),
> +and clients are likely to use them when connecting, they may also be included in the
> +certificate. Both IPv4 and IPv6 addresses are supported. Historically certificates
> +only included 1 hostname in the @code{CN} field, however, usage of this field for
> +validation is now deprecated. Instead modern TLS clients will validate against the
> +Subject Alt Name extension data, which allows for multiple entries. In the future
> +usage of the @code{CN} field may be discontinued entirely, so providing SAN
> +extension data is strongly recommended.
> +
> +On the host holding the CA, create template files containing the information
> +for each server, and use it to issue server certificates.
> +
> +@example
> +# cat > server-hostNNN.info <<EOF
> +organization = Name of your organization
> +cn = hostNNN.foo.example.com
> +dns_name = hostNNN
> +dns_name = hostNNN.foo.example.com
> +ip_address = 10.0.1.87
> +ip_address = 192.8.0.92
> +ip_address = 2620:0:cafe::87
> +ip_address = 2001:24::92
> +tls_www_server
> +encryption_key
> +signing_key
> +EOF
> +# certtool --generate-privkey > 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 <<EOF
> +country = GB
> +state = London
> +locality = City Of London
> +organization = Name of your organization
> +cn = hostNNN.foo.example.com
> +tls_www_client
> +encryption_key
> +signing_key
> +EOF
> +# certtool --generate-privkey > 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 <<EOF
> +country = GB
> +state = London
> +locality = City Of London
> +organization = Name of your organization
> +cn = hostNNN.foo.example.com
> +dns_name = hostNNN
> +dns_name = hostNNN.foo.example.com
> +ip_address = 10.0.1.87
> +ip_address = 192.8.0.92
> +ip_address = 2620:0:cafe::87
> +ip_address = 2001:24::92
> +tls_www_server
> +tls_www_client
> +encryption_key
> +signing_key
> +EOF
> +# certtool --generate-privkey > 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 00000000000..840adac9785
> --- /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 00000000000..abf7f7fa43a
> --- /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 617a701b678..33d24caf946 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://<target-ip>[:<port>]/<target-iqn>/<lun>''
> -
> -By default qemu will use the iSCSI initiator-name
> -'iqn.2008-11.org.linux-kvm[:<name>]' 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://<server-ip>[:<port>]/[<export>]''
> -
> -Syntax for specifying a NBD device using Unix Domain Sockets; remember
> -that '?' is a shell glob character and may need quoting:
> -``nbd+unix:///[<export>]?socket=<domain-socket>''
> -
> -Older syntax that is also recognized:
> -``nbd:<server-ip>:<port>[:exportname=<export>]''
> -
> -Syntax for specifying a NBD device using Unix Domain Sockets
> -``nbd:unix:<domain-socket>[:exportname=<export>]''
> -
> -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
> -<protocol>://[<username>[:<password>]@@]<host>/<path>
> -@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 <protocol>.
> -
> -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 <shm size> 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 <<EOF
> -cn = Name of your organization
> -ca
> -cert_signing_key
> -EOF
> -# certtool --generate-self-signed \
> - --load-privkey ca-key.pem
> - --template ca.info \
> - --outfile ca-cert.pem
> -@end example
> -
> -The @code{ca} keyword in the template sets the v3 basic constraints extension
> -to indicate this certificate is for a CA, while @code{cert_signing_key} sets
> -the key usage extension to indicate this will be used for signing other keys.
> -The generated @code{ca-cert.pem} file should be copied to all servers and
> -clients wishing to utilize TLS support in the VNC server. The @code{ca-key.pem}
> -must not be disclosed/copied anywhere except the host responsible for issuing
> -certificates.
> -
> -@node tls_generate_server
> -@subsection Issuing server certificates
> -
> -Each server (or host) needs to be issued with a key and certificate. When connecting
> -the certificate is sent to the client which validates it against the CA certificate.
> -The core pieces of information for a server certificate are the hostnames and/or IP
> -addresses that will be used by clients when connecting. The hostname / IP address
> -that the client specifies when connecting will be validated against the hostname(s)
> -and IP address(es) recorded in the server certificate, and if no match is found
> -the client will close the connection.
> -
> -Thus it is recommended that the server certificate include both the fully qualified
> -and unqualified hostnames. If the server will have permanently assigned IP address(es),
> -and clients are likely to use them when connecting, they may also be included in the
> -certificate. Both IPv4 and IPv6 addresses are supported. Historically certificates
> -only included 1 hostname in the @code{CN} field, however, usage of this field for
> -validation is now deprecated. Instead modern TLS clients will validate against the
> -Subject Alt Name extension data, which allows for multiple entries. In the future
> -usage of the @code{CN} field may be discontinued entirely, so providing SAN
> -extension data is strongly recommended.
> -
> -On the host holding the CA, create template files containing the information
> -for each server, and use it to issue server certificates.
> -
> -@example
> -# cat > server-hostNNN.info <<EOF
> -organization = Name of your organization
> -cn = hostNNN.foo.example.com
> -dns_name = hostNNN
> -dns_name = hostNNN.foo.example.com
> -ip_address = 10.0.1.87
> -ip_address = 192.8.0.92
> -ip_address = 2620:0:cafe::87
> -ip_address = 2001:24::92
> -tls_www_server
> -encryption_key
> -signing_key
> -EOF
> -# certtool --generate-privkey > 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 <<EOF
> -country = GB
> -state = London
> -locality = City Of London
> -organization = Name of your organization
> -cn = hostNNN.foo.example.com
> -tls_www_client
> -encryption_key
> -signing_key
> -EOF
> -# certtool --generate-privkey > 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 <<EOF
> -country = GB
> -state = London
> -locality = City Of London
> -organization = Name of your organization
> -cn = hostNNN.foo.example.com
> -dns_name = hostNNN
> -dns_name = hostNNN.foo.example.com
> -ip_address = 10.0.1.87
> -ip_address = 192.8.0.92
> -ip_address = 2620:0:cafe::87
> -ip_address = 2001:24::92
> -tls_www_server
> -tls_www_client
> -encryption_key
> -signing_key
> -EOF
> -# certtool --generate-privkey > 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
> +@include docs/system/build-platforms.texi
>
> -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.
> +@include docs/system/license.texi
>
> -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
> -
> -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}.
>
> @node Index
> @appendix Index
--
Alex Bennée
^ permalink raw reply [flat|nested] 82+ messages in thread* Re: [PATCH v3 05/33] qemu-doc: split qemu-doc.texi in multiple files
2020-03-02 11:22 ` Alex Bennée
@ 2020-03-02 12:16 ` Peter Maydell
2020-03-02 14:18 ` Alex Bennée
0 siblings, 1 reply; 82+ messages in thread
From: Peter Maydell @ 2020-03-02 12:16 UTC (permalink / raw)
To: Alex Bennée; +Cc: Paolo Bonzini, QEMU Developers, Kashyap Chamarthy
On Mon, 2 Mar 2020 at 11:22, Alex Bennée <alex.bennee@linaro.org> wrote:
>
>
> Peter Maydell <peter.maydell@linaro.org> writes:
>
> > From: Paolo Bonzini <pbonzini@redhat.com>
> >
> > 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 <pbonzini@redhat.com>
> > Message-id: 20200226113034.6741-6-pbonzini@redhat.com
> > Reviewed-by: Peter Maydell <peter.maydell@linaro.org>
> > Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
> > ---
> > Makefile | 16 +
> > docs/system/build-platforms.texi | 67 ++
> > docs/system/gdb.texi | 71 ++
>
> The gdb test would be better served in docs/core if we could have
> optional sections on invocation rendering depending on if it's built
> with system emulation or linux-user docs. Is that something that's
> already supported?
No, for three reasons:
(1) we build all the docs, always -- there's no concept
of "skip some bits of docs if some configure feature was
disabled"
(2) there is no docs/core -- the subdirectories of docs/
correspond to the "manuals" which we want to present to
the user, like "Manual for system emulation users" and
"Manual for user-mode users" and "Manual for the
standalone tools"; a "core" manual wouldn't fit into this
classification, and we already have slightly more manuals
than I'm entirely comfortable with.
(3) Sphinx's support for conditional documentation is
not very good, as it is implemented at the "wrong"
end of the pipeline (ie it's not like a preprocessor
ifdef, but instead is just "suppress the output", so
manual pieces inside a disabled ifdef still turn up
in places like the index and table of contents). The
best you can do is to mess around with the include
directive, but if we do that too much then things get
awkward to understand and maintain. (We do it a bit
in this series to handle "manpage vs manual" stuff.)
thanks
-- PMM
^ permalink raw reply [flat|nested] 82+ messages in thread
* Re: [PATCH v3 05/33] qemu-doc: split qemu-doc.texi in multiple files
2020-03-02 12:16 ` Peter Maydell
@ 2020-03-02 14:18 ` Alex Bennée
0 siblings, 0 replies; 82+ messages in thread
From: Alex Bennée @ 2020-03-02 14:18 UTC (permalink / raw)
To: Peter Maydell; +Cc: Paolo Bonzini, QEMU Developers, Kashyap Chamarthy
Peter Maydell <peter.maydell@linaro.org> writes:
> On Mon, 2 Mar 2020 at 11:22, Alex Bennée <alex.bennee@linaro.org> wrote:
>>
>>
>> Peter Maydell <peter.maydell@linaro.org> writes:
>>
>> > From: Paolo Bonzini <pbonzini@redhat.com>
>> >
>> > 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 <pbonzini@redhat.com>
>> > Message-id: 20200226113034.6741-6-pbonzini@redhat.com
>> > Reviewed-by: Peter Maydell <peter.maydell@linaro.org>
>> > Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
>> > ---
>> > Makefile | 16 +
>> > docs/system/build-platforms.texi | 67 ++
>> > docs/system/gdb.texi | 71 ++
>>
>> The gdb test would be better served in docs/core if we could have
>> optional sections on invocation rendering depending on if it's built
>> with system emulation or linux-user docs. Is that something that's
>> already supported?
>
> No, for three reasons:
>
> (1) we build all the docs, always -- there's no concept
> of "skip some bits of docs if some configure feature was
> disabled"
>
> (2) there is no docs/core -- the subdirectories of docs/
> correspond to the "manuals" which we want to present to
> the user, like "Manual for system emulation users" and
> "Manual for user-mode users" and "Manual for the
> standalone tools"; a "core" manual wouldn't fit into this
> classification, and we already have slightly more manuals
> than I'm entirely comfortable with.
I wasn't clear. I don't want an additional document but I'd like to
include information on the gdbstub in both the system and linux-user
manuals. Another candidate for documentation which is common to both
would be the notes about TCG CPU emulation.
> (3) Sphinx's support for conditional documentation is
> not very good, as it is implemented at the "wrong"
> end of the pipeline (ie it's not like a preprocessor
> ifdef, but instead is just "suppress the output", so
> manual pieces inside a disabled ifdef still turn up
> in places like the index and table of contents). The
> best you can do is to mess around with the include
> directive, but if we do that too much then things get
> awkward to understand and maintain. (We do it a bit
> in this series to handle "manpage vs manual" stuff.)
In the case of the gdbstub the only real difference is the invocation
section (-s vs -g). I guess we could just reference both in the section.
It's not like the linux-user documents can't acknowledge the existence
of system emulation and visa-versa.
>
> thanks
> -- PMM
--
Alex Bennée
^ permalink raw reply [flat|nested] 82+ messages in thread
* [PATCH v3 06/33] qemu-doc: extract common system emulator documentation from the PC section
2020-02-28 15:35 [PATCH v3 00/33] Convert qemu-doc to rST Peter Maydell
` (4 preceding siblings ...)
2020-02-28 15:35 ` [PATCH v3 05/33] qemu-doc: split qemu-doc.texi in multiple files Peter Maydell
@ 2020-02-28 15:35 ` Peter Maydell
2020-03-02 11:25 ` Alex Bennée
2020-02-28 15:35 ` [PATCH v3 07/33] qemu-doc: move system requirements chapter inside " Peter Maydell
` (29 subsequent siblings)
35 siblings, 1 reply; 82+ messages in thread
From: Peter Maydell @ 2020-02-28 15:35 UTC (permalink / raw)
To: qemu-devel; +Cc: Paolo Bonzini, Kashyap Chamarthy
From: Paolo Bonzini <pbonzini@redhat.com>
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 <pbonzini@redhat.com>
Message-id: 20200226113034.6741-7-pbonzini@redhat.com
Reviewed-by: Peter Maydell <peter.maydell@linaro.org>
Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
---
docs/system/quickstart.texi | 2 +-
qemu-doc.texi | 102 ++++++++++++++++++++----------------
2 files changed, 57 insertions(+), 47 deletions(-)
diff --git a/docs/system/quickstart.texi b/docs/system/quickstart.texi
index 8cd5b4bc6e5..ed7295de7a2 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 33d24caf946..88e84300e91 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
--
2.20.1
^ permalink raw reply related [flat|nested] 82+ messages in thread* Re: [PATCH v3 06/33] qemu-doc: extract common system emulator documentation from the PC section
2020-02-28 15:35 ` [PATCH v3 06/33] qemu-doc: extract common system emulator documentation from the PC section Peter Maydell
@ 2020-03-02 11:25 ` Alex Bennée
0 siblings, 0 replies; 82+ messages in thread
From: Alex Bennée @ 2020-03-02 11:25 UTC (permalink / raw)
To: Peter Maydell; +Cc: Paolo Bonzini, qemu-devel, Kashyap Chamarthy
Peter Maydell <peter.maydell@linaro.org> writes:
> From: Paolo Bonzini <pbonzini@redhat.com>
>
> 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 <pbonzini@redhat.com>
> Message-id: 20200226113034.6741-7-pbonzini@redhat.com
> Reviewed-by: Peter Maydell <peter.maydell@linaro.org>
> Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
Reviewed-by: Alex Bennée <alex.bennee@linaro.org>
> ---
> docs/system/quickstart.texi | 2 +-
> qemu-doc.texi | 102 ++++++++++++++++++++----------------
> 2 files changed, 57 insertions(+), 47 deletions(-)
>
> diff --git a/docs/system/quickstart.texi b/docs/system/quickstart.texi
> index 8cd5b4bc6e5..ed7295de7a2 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 33d24caf946..88e84300e91 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
--
Alex Bennée
^ permalink raw reply [flat|nested] 82+ messages in thread
* [PATCH v3 07/33] qemu-doc: move system requirements chapter inside PC section
2020-02-28 15:35 [PATCH v3 00/33] Convert qemu-doc to rST Peter Maydell
` (5 preceding siblings ...)
2020-02-28 15:35 ` [PATCH v3 06/33] qemu-doc: extract common system emulator documentation from the PC section Peter Maydell
@ 2020-02-28 15:35 ` Peter Maydell
2020-02-28 15:35 ` [PATCH v3 08/33] qemu-doc: split target sections to separate files Peter Maydell
` (28 subsequent siblings)
35 siblings, 0 replies; 82+ messages in thread
From: Peter Maydell @ 2020-02-28 15:35 UTC (permalink / raw)
To: qemu-devel; +Cc: Paolo Bonzini, Kashyap Chamarthy
From: Paolo Bonzini <pbonzini@redhat.com>
The system requirements documented in this chapter are limited to x86 KVM targets.
Clean them up and move them to the target section.
Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
Message-id: 20200226113034.6741-8-pbonzini@redhat.com
Reviewed-by: Peter Maydell <peter.maydell@linaro.org>
Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
---
qemu-doc.texi | 22 ++++++++--------------
1 file changed, 8 insertions(+), 14 deletions(-)
diff --git a/qemu-doc.texi b/qemu-doc.texi
index 88e84300e91..40fab523f35 100644
--- a/qemu-doc.texi
+++ b/qemu-doc.texi
@@ -38,7 +38,6 @@
* Introduction::
* QEMU System emulator::
* QEMU System emulator targets::
-* System requirements::
* Security::
* Implementation notes::
* Deprecated features::
@@ -190,6 +189,7 @@ various targets are mentioned in the following sections.
@menu
* pcsys_devices:: Peripherals
* cpu_models_x86:: Supported CPU model configurations on x86 hosts
+* pcsys_req:: OS requirements
@end menu
@node pcsys_devices
@@ -267,6 +267,13 @@ CS4231A is the chip used in Windows Sound System and GUSMAX products
@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)
@@ -1038,19 +1045,6 @@ so should only be used with trusted guest OS.
@c man end
-@node System requirements
-@chapter System requirements
-
-@section KVM kernel module
-
-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.
-
-The OpteronG[345] CPU models require KVM support for RDTSCP, which was
-added with Linux 4.5 which is supported by the major distros. And even
-if RHEL7 has kernel 3.10, KVM there has the required functionality there
-to make it close to a 4.5 or newer kernel.
-
@include docs/security.texi
@include qemu-tech.texi
--
2.20.1
^ permalink raw reply related [flat|nested] 82+ messages in thread* [PATCH v3 08/33] qemu-doc: split target sections to separate files
2020-02-28 15:35 [PATCH v3 00/33] Convert qemu-doc to rST Peter Maydell
` (6 preceding siblings ...)
2020-02-28 15:35 ` [PATCH v3 07/33] qemu-doc: move system requirements chapter inside " Peter Maydell
@ 2020-02-28 15:35 ` Peter Maydell
2020-03-02 11:28 ` Alex Bennée
2020-02-28 15:35 ` [PATCH v3 09/33] qemu-doc: Remove the "CPU emulation" part of the "Implementation notes" Peter Maydell
` (27 subsequent siblings)
35 siblings, 1 reply; 82+ messages in thread
From: Peter Maydell @ 2020-02-28 15:35 UTC (permalink / raw)
To: qemu-devel; +Cc: Paolo Bonzini, Kashyap Chamarthy
From: Paolo Bonzini <pbonzini@redhat.com>
Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
Message-id: 20200226113034.6741-9-pbonzini@redhat.com
Reviewed-by: Peter Maydell <peter.maydell@linaro.org>
Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
---
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
diff --git a/docs/system/target-arm.texi b/docs/system/target-arm.texi
new file mode 100644
index 00000000000..040d77b5e05
--- /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 00000000000..edd23fa8df5
--- /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 00000000000..b5bc9df40ae
--- /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 00000000000..f722c00912a
--- /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{<disk_image_file>} from @url{https://mipsdistros.mips.com/LinuxDistro/nanomips/buildroot/index.html}.
+
+Download @code{<kernel_image_file>} 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{<kernel_image_file>} \
+ -M malta -serial stdio -m @code{<memory_size>} -hda @code{<disk_image_file>} \
+ -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 00000000000..c2c254d3d23
--- /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 00000000000..7fe0aec9c39
--- /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 00000000000..9e7a27de0ce
--- /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 00000000000..08b0b362991
--- /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 40fab523f35..f702dce4557 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{<disk_image_file>} from @url{https://mipsdistros.mips.com/LinuxDistro/nanomips/buildroot/index.html}.
-
-Download @code{<kernel_image_file>} 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{<kernel_image_file>} \
- -M malta -serial stdio -m @code{<memory_size>} -hda @code{<disk_image_file>} \
- -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
--
2.20.1
^ permalink raw reply related [flat|nested] 82+ messages in thread* Re: [PATCH v3 08/33] qemu-doc: split target sections to separate files
2020-02-28 15:35 ` [PATCH v3 08/33] qemu-doc: split target sections to separate files Peter Maydell
@ 2020-03-02 11:28 ` Alex Bennée
0 siblings, 0 replies; 82+ messages in thread
From: Alex Bennée @ 2020-03-02 11:28 UTC (permalink / raw)
To: Peter Maydell; +Cc: Paolo Bonzini, qemu-devel, Kashyap Chamarthy
Peter Maydell <peter.maydell@linaro.org> writes:
> From: Paolo Bonzini <pbonzini@redhat.com>
>
> Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
> Message-id: 20200226113034.6741-9-pbonzini@redhat.com
> Reviewed-by: Peter Maydell <peter.maydell@linaro.org>
> Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
Reviewed-by: Alex Bennée <alex.bennee@linaro.org>
> ---
> 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
>
> diff --git a/docs/system/target-arm.texi b/docs/system/target-arm.texi
> new file mode 100644
> index 00000000000..040d77b5e05
> --- /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 00000000000..edd23fa8df5
> --- /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 00000000000..b5bc9df40ae
> --- /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 00000000000..f722c00912a
> --- /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{<disk_image_file>} from @url{https://mipsdistros.mips.com/LinuxDistro/nanomips/buildroot/index.html}.
> +
> +Download @code{<kernel_image_file>} 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{<kernel_image_file>} \
> + -M malta -serial stdio -m @code{<memory_size>} -hda @code{<disk_image_file>} \
> + -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 00000000000..c2c254d3d23
> --- /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 00000000000..7fe0aec9c39
> --- /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 00000000000..9e7a27de0ce
> --- /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 00000000000..08b0b362991
> --- /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 40fab523f35..f702dce4557 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{<disk_image_file>} from @url{https://mipsdistros.mips.com/LinuxDistro/nanomips/buildroot/index.html}.
> -
> -Download @code{<kernel_image_file>} 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{<kernel_image_file>} \
> - -M malta -serial stdio -m @code{<memory_size>} -hda @code{<disk_image_file>} \
> - -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
--
Alex Bennée
^ permalink raw reply [flat|nested] 82+ messages in thread
* [PATCH v3 09/33] qemu-doc: Remove the "CPU emulation" part of the "Implementation notes"
2020-02-28 15:35 [PATCH v3 00/33] Convert qemu-doc to rST Peter Maydell
` (7 preceding siblings ...)
2020-02-28 15:35 ` [PATCH v3 08/33] qemu-doc: split target sections to separate files Peter Maydell
@ 2020-02-28 15:35 ` Peter Maydell
2020-03-02 11:30 ` Alex Bennée
2020-02-28 15:35 ` [PATCH v3 10/33] qemu-doc: move qemu-tech.texi into main section Peter Maydell
` (26 subsequent siblings)
35 siblings, 1 reply; 82+ messages in thread
From: Peter Maydell @ 2020-02-28 15:35 UTC (permalink / raw)
To: qemu-devel; +Cc: Paolo Bonzini, Kashyap Chamarthy
The "CPU emulation" part of the "Implementation notes" in
qemu-tech.texi looks like it is documenting what features of various
CPUs we do or don't emulate. However:
* it covers only six of our 21 guest architectures
* the last time anybody updated it for actual content was in
2011/2012 for Xtensa; the content for the other five
architectures is even older, being from 2008 or before!
What we have is out of date, misleading and incomplete.
Just delete this part of the document rather than trying to
convert it to rST.
(It would be nice eventually to have documentation of the
scope and limitations of our emulation; but we will want to
separate out the generic "system emulation" information from
the parts that are specific to linux-user anyway, as they will
be in different manuals.)
Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
Message-id: 20200226113034.6741-10-pbonzini@redhat.com
Message-Id: <20200225154121.21116-3-peter.maydell@linaro.org>
Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
---
qemu-tech.texi | 153 -------------------------------------------------
1 file changed, 153 deletions(-)
diff --git a/qemu-tech.texi b/qemu-tech.texi
index 0380de77b62..35da6a40af1 100644
--- a/qemu-tech.texi
+++ b/qemu-tech.texi
@@ -2,162 +2,9 @@
@appendix Implementation notes
@menu
-* CPU emulation::
* Managed start up options::
@end menu
-@node CPU emulation
-@section CPU emulation
-
-@menu
-* x86:: x86 and x86-64 emulation
-* ARM:: ARM emulation
-* MIPS:: MIPS emulation
-* PPC:: PowerPC emulation
-* SPARC:: Sparc32 and Sparc64 emulation
-* Xtensa:: Xtensa emulation
-@end menu
-
-@node x86
-@subsection x86 and x86-64 emulation
-
-QEMU x86 target features:
-
-@itemize
-
-@item The virtual x86 CPU supports 16 bit and 32 bit addressing with segmentation.
-LDT/GDT and IDT are emulated. VM86 mode is also supported to run
-DOSEMU. There is some support for MMX/3DNow!, SSE, SSE2, SSE3, SSSE3,
-and SSE4 as well as x86-64 SVM.
-
-@item Support of host page sizes bigger than 4KB in user mode emulation.
-
-@item QEMU can emulate itself on x86.
-
-@item An extensive Linux x86 CPU test program is included @file{tests/test-i386}.
-It can be used to test other x86 virtual CPUs.
-
-@end itemize
-
-Current QEMU limitations:
-
-@itemize
-
-@item Limited x86-64 support.
-
-@item IPC syscalls are missing.
-
-@item The x86 segment limits and access rights are not tested at every
-memory access (yet). Hopefully, very few OSes seem to rely on that for
-normal use.
-
-@end itemize
-
-@node ARM
-@subsection ARM emulation
-
-@itemize
-
-@item Full ARM 7 user emulation.
-
-@item NWFPE FPU support included in user Linux emulation.
-
-@item Can run most ARM Linux binaries.
-
-@end itemize
-
-@node MIPS
-@subsection MIPS emulation
-
-@itemize
-
-@item The system emulation allows full MIPS32/MIPS64 Release 2 emulation,
-including privileged instructions, FPU and MMU, in both little and big
-endian modes.
-
-@item The Linux userland emulation can run many 32 bit MIPS Linux binaries.
-
-@end itemize
-
-Current QEMU limitations:
-
-@itemize
-
-@item Self-modifying code is not always handled correctly.
-
-@item 64 bit userland emulation is not implemented.
-
-@item The system emulation is not complete enough to run real firmware.
-
-@item The watchpoint debug facility is not implemented.
-
-@end itemize
-
-@node PPC
-@subsection PowerPC emulation
-
-@itemize
-
-@item Full PowerPC 32 bit emulation, including privileged instructions,
-FPU and MMU.
-
-@item Can run most PowerPC Linux binaries.
-
-@end itemize
-
-@node SPARC
-@subsection Sparc32 and Sparc64 emulation
-
-@itemize
-
-@item Full SPARC V8 emulation, including privileged
-instructions, FPU and MMU. SPARC V9 emulation includes most privileged
-and VIS instructions, FPU and I/D MMU. Alignment is fully enforced.
-
-@item Can run most 32-bit SPARC Linux binaries, SPARC32PLUS Linux binaries and
-some 64-bit SPARC Linux binaries.
-
-@end itemize
-
-Current QEMU limitations:
-
-@itemize
-
-@item IPC syscalls are missing.
-
-@item Floating point exception support is buggy.
-
-@item Atomic instructions are not correctly implemented.
-
-@item There are still some problems with Sparc64 emulators.
-
-@end itemize
-
-@node Xtensa
-@subsection Xtensa emulation
-
-@itemize
-
-@item Core Xtensa ISA emulation, including most options: code density,
-loop, extended L32R, 16- and 32-bit multiplication, 32-bit division,
-MAC16, miscellaneous operations, boolean, FP coprocessor, coprocessor
-context, debug, multiprocessor synchronization,
-conditional store, exceptions, relocatable vectors, unaligned exception,
-interrupts (including high priority and timer), hardware alignment,
-region protection, region translation, MMU, windowed registers, thread
-pointer, processor ID.
-
-@item Not implemented options: data/instruction cache (including cache
-prefetch and locking), XLMI, processor interface. Also options not
-covered by the core ISA (e.g. FLIX, wide branches) are not implemented.
-
-@item Can run most Xtensa Linux binaries.
-
-@item New core configuration that requires no additional instructions
-may be created from overlay with minimal amount of hand-written code.
-
-@end itemize
-
@node Managed start up options
@section Managed start up options
--
2.20.1
^ permalink raw reply related [flat|nested] 82+ messages in thread* Re: [PATCH v3 09/33] qemu-doc: Remove the "CPU emulation" part of the "Implementation notes"
2020-02-28 15:35 ` [PATCH v3 09/33] qemu-doc: Remove the "CPU emulation" part of the "Implementation notes" Peter Maydell
@ 2020-03-02 11:30 ` Alex Bennée
0 siblings, 0 replies; 82+ messages in thread
From: Alex Bennée @ 2020-03-02 11:30 UTC (permalink / raw)
To: Peter Maydell; +Cc: Paolo Bonzini, qemu-devel, Kashyap Chamarthy
Peter Maydell <peter.maydell@linaro.org> writes:
> The "CPU emulation" part of the "Implementation notes" in
> qemu-tech.texi looks like it is documenting what features of various
> CPUs we do or don't emulate. However:
> * it covers only six of our 21 guest architectures
> * the last time anybody updated it for actual content was in
> 2011/2012 for Xtensa; the content for the other five
> architectures is even older, being from 2008 or before!
>
> What we have is out of date, misleading and incomplete.
> Just delete this part of the document rather than trying to
> convert it to rST.
>
> (It would be nice eventually to have documentation of the
> scope and limitations of our emulation; but we will want to
> separate out the generic "system emulation" information from
> the parts that are specific to linux-user anyway, as they will
> be in different manuals.)
Ahh I guess this is what would be the TCG specifics. I wonder if what
replaces this is more suitable as developer documentation? Anyway happy
to delete the cruft:
Reviewed-by: Alex Bennée <alex.bennee@linaro.org>
>
> Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
> Message-id: 20200226113034.6741-10-pbonzini@redhat.com
> Message-Id: <20200225154121.21116-3-peter.maydell@linaro.org>
> Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
> ---
> qemu-tech.texi | 153 -------------------------------------------------
> 1 file changed, 153 deletions(-)
>
> diff --git a/qemu-tech.texi b/qemu-tech.texi
> index 0380de77b62..35da6a40af1 100644
> --- a/qemu-tech.texi
> +++ b/qemu-tech.texi
> @@ -2,162 +2,9 @@
> @appendix Implementation notes
>
> @menu
> -* CPU emulation::
> * Managed start up options::
> @end menu
>
> -@node CPU emulation
> -@section CPU emulation
> -
> -@menu
> -* x86:: x86 and x86-64 emulation
> -* ARM:: ARM emulation
> -* MIPS:: MIPS emulation
> -* PPC:: PowerPC emulation
> -* SPARC:: Sparc32 and Sparc64 emulation
> -* Xtensa:: Xtensa emulation
> -@end menu
> -
> -@node x86
> -@subsection x86 and x86-64 emulation
> -
> -QEMU x86 target features:
> -
> -@itemize
> -
> -@item The virtual x86 CPU supports 16 bit and 32 bit addressing with segmentation.
> -LDT/GDT and IDT are emulated. VM86 mode is also supported to run
> -DOSEMU. There is some support for MMX/3DNow!, SSE, SSE2, SSE3, SSSE3,
> -and SSE4 as well as x86-64 SVM.
> -
> -@item Support of host page sizes bigger than 4KB in user mode emulation.
> -
> -@item QEMU can emulate itself on x86.
> -
> -@item An extensive Linux x86 CPU test program is included @file{tests/test-i386}.
> -It can be used to test other x86 virtual CPUs.
> -
> -@end itemize
> -
> -Current QEMU limitations:
> -
> -@itemize
> -
> -@item Limited x86-64 support.
> -
> -@item IPC syscalls are missing.
> -
> -@item The x86 segment limits and access rights are not tested at every
> -memory access (yet). Hopefully, very few OSes seem to rely on that for
> -normal use.
> -
> -@end itemize
> -
> -@node ARM
> -@subsection ARM emulation
> -
> -@itemize
> -
> -@item Full ARM 7 user emulation.
> -
> -@item NWFPE FPU support included in user Linux emulation.
> -
> -@item Can run most ARM Linux binaries.
> -
> -@end itemize
> -
> -@node MIPS
> -@subsection MIPS emulation
> -
> -@itemize
> -
> -@item The system emulation allows full MIPS32/MIPS64 Release 2 emulation,
> -including privileged instructions, FPU and MMU, in both little and big
> -endian modes.
> -
> -@item The Linux userland emulation can run many 32 bit MIPS Linux binaries.
> -
> -@end itemize
> -
> -Current QEMU limitations:
> -
> -@itemize
> -
> -@item Self-modifying code is not always handled correctly.
> -
> -@item 64 bit userland emulation is not implemented.
> -
> -@item The system emulation is not complete enough to run real firmware.
> -
> -@item The watchpoint debug facility is not implemented.
> -
> -@end itemize
> -
> -@node PPC
> -@subsection PowerPC emulation
> -
> -@itemize
> -
> -@item Full PowerPC 32 bit emulation, including privileged instructions,
> -FPU and MMU.
> -
> -@item Can run most PowerPC Linux binaries.
> -
> -@end itemize
> -
> -@node SPARC
> -@subsection Sparc32 and Sparc64 emulation
> -
> -@itemize
> -
> -@item Full SPARC V8 emulation, including privileged
> -instructions, FPU and MMU. SPARC V9 emulation includes most privileged
> -and VIS instructions, FPU and I/D MMU. Alignment is fully enforced.
> -
> -@item Can run most 32-bit SPARC Linux binaries, SPARC32PLUS Linux binaries and
> -some 64-bit SPARC Linux binaries.
> -
> -@end itemize
> -
> -Current QEMU limitations:
> -
> -@itemize
> -
> -@item IPC syscalls are missing.
> -
> -@item Floating point exception support is buggy.
> -
> -@item Atomic instructions are not correctly implemented.
> -
> -@item There are still some problems with Sparc64 emulators.
> -
> -@end itemize
> -
> -@node Xtensa
> -@subsection Xtensa emulation
> -
> -@itemize
> -
> -@item Core Xtensa ISA emulation, including most options: code density,
> -loop, extended L32R, 16- and 32-bit multiplication, 32-bit division,
> -MAC16, miscellaneous operations, boolean, FP coprocessor, coprocessor
> -context, debug, multiprocessor synchronization,
> -conditional store, exceptions, relocatable vectors, unaligned exception,
> -interrupts (including high priority and timer), hardware alignment,
> -region protection, region translation, MMU, windowed registers, thread
> -pointer, processor ID.
> -
> -@item Not implemented options: data/instruction cache (including cache
> -prefetch and locking), XLMI, processor interface. Also options not
> -covered by the core ISA (e.g. FLIX, wide branches) are not implemented.
> -
> -@item Can run most Xtensa Linux binaries.
> -
> -@item New core configuration that requires no additional instructions
> -may be created from overlay with minimal amount of hand-written code.
> -
> -@end itemize
> -
> @node Managed start up options
> @section Managed start up options
--
Alex Bennée
^ permalink raw reply [flat|nested] 82+ messages in thread
* [PATCH v3 10/33] qemu-doc: move qemu-tech.texi into main section
2020-02-28 15:35 [PATCH v3 00/33] Convert qemu-doc to rST Peter Maydell
` (8 preceding siblings ...)
2020-02-28 15:35 ` [PATCH v3 09/33] qemu-doc: Remove the "CPU emulation" part of the "Implementation notes" Peter Maydell
@ 2020-02-28 15:35 ` Peter Maydell
2020-03-02 11:31 ` Alex Bennée
2020-02-28 15:35 ` [PATCH v3 11/33] qemu-doc: move included files to docs/system Peter Maydell
` (25 subsequent siblings)
35 siblings, 1 reply; 82+ messages in thread
From: Peter Maydell @ 2020-02-28 15:35 UTC (permalink / raw)
To: qemu-devel; +Cc: Paolo Bonzini, Kashyap Chamarthy
From: Paolo Bonzini <pbonzini@redhat.com>
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 <pbonzini@redhat.com>
Message-id: 20200226113034.6741-11-pbonzini@redhat.com
Reviewed-by: Peter Maydell <peter.maydell@linaro.org>
Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
---
Makefile | 2 +-
qemu-tech.texi => docs/system/managed-startup.texi | 9 +--------
qemu-doc.texi | 5 ++---
3 files changed, 4 insertions(+), 12 deletions(-)
rename qemu-tech.texi => docs/system/managed-startup.texi (92%)
diff --git a/Makefile b/Makefile
index 9790a0fd15b..56382a45936 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/qemu-tech.texi b/docs/system/managed-startup.texi
similarity index 92%
rename from qemu-tech.texi
rename to docs/system/managed-startup.texi
index 35da6a40af1..ec168095cc4 100644
--- a/qemu-tech.texi
+++ b/docs/system/managed-startup.texi
@@ -1,11 +1,4 @@
-@node Implementation notes
-@appendix Implementation notes
-
-@menu
-* Managed start up options::
-@end menu
-
-@node Managed start up options
+@node managed_startup
@section Managed start up options
In system mode emulation, it's possible to create a VM in a paused state using
diff --git a/qemu-doc.texi b/qemu-doc.texi
index f702dce4557..e4bff7edbee 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
--
2.20.1
^ permalink raw reply related [flat|nested] 82+ messages in thread* Re: [PATCH v3 10/33] qemu-doc: move qemu-tech.texi into main section
2020-02-28 15:35 ` [PATCH v3 10/33] qemu-doc: move qemu-tech.texi into main section Peter Maydell
@ 2020-03-02 11:31 ` Alex Bennée
0 siblings, 0 replies; 82+ messages in thread
From: Alex Bennée @ 2020-03-02 11:31 UTC (permalink / raw)
To: Peter Maydell; +Cc: Paolo Bonzini, qemu-devel, Kashyap Chamarthy
Peter Maydell <peter.maydell@linaro.org> writes:
> From: Paolo Bonzini <pbonzini@redhat.com>
>
> 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 <pbonzini@redhat.com>
> Message-id: 20200226113034.6741-11-pbonzini@redhat.com
> Reviewed-by: Peter Maydell <peter.maydell@linaro.org>
> Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
Reviewed-by: Alex Bennée <alex.bennee@linaro.org>
> ---
> Makefile | 2 +-
> qemu-tech.texi => docs/system/managed-startup.texi | 9 +--------
> qemu-doc.texi | 5 ++---
> 3 files changed, 4 insertions(+), 12 deletions(-)
> rename qemu-tech.texi => docs/system/managed-startup.texi (92%)
>
> diff --git a/Makefile b/Makefile
> index 9790a0fd15b..56382a45936 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/qemu-tech.texi b/docs/system/managed-startup.texi
> similarity index 92%
> rename from qemu-tech.texi
> rename to docs/system/managed-startup.texi
> index 35da6a40af1..ec168095cc4 100644
> --- a/qemu-tech.texi
> +++ b/docs/system/managed-startup.texi
> @@ -1,11 +1,4 @@
> -@node Implementation notes
> -@appendix Implementation notes
> -
> -@menu
> -* Managed start up options::
> -@end menu
> -
> -@node Managed start up options
> +@node managed_startup
> @section Managed start up options
>
> In system mode emulation, it's possible to create a VM in a paused state using
> diff --git a/qemu-doc.texi b/qemu-doc.texi
> index f702dce4557..e4bff7edbee 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
--
Alex Bennée
^ permalink raw reply [flat|nested] 82+ messages in thread
* [PATCH v3 11/33] qemu-doc: move included files to docs/system
2020-02-28 15:35 [PATCH v3 00/33] Convert qemu-doc to rST Peter Maydell
` (9 preceding siblings ...)
2020-02-28 15:35 ` [PATCH v3 10/33] qemu-doc: move qemu-tech.texi into main section Peter Maydell
@ 2020-02-28 15:35 ` Peter Maydell
2020-03-02 11:31 ` Alex Bennée
2020-02-28 15:35 ` [PATCH v3 12/33] qemu-doc: remove indices other than findex Peter Maydell
` (24 subsequent siblings)
35 siblings, 1 reply; 82+ messages in thread
From: Peter Maydell @ 2020-02-28 15:35 UTC (permalink / raw)
To: qemu-devel; +Cc: Paolo Bonzini, Kashyap Chamarthy
From: Paolo Bonzini <pbonzini@redhat.com>
Since qemu-doc.texi is mostly including files from docs/system,
move the existing include files there for consistency.
Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
Message-id: 20200226113034.6741-12-pbonzini@redhat.com
[PMM: update MAINTAINERS line for qemu-option-trace.texi]
Reviewed-by: Peter Maydell <peter.maydell@linaro.org>
Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
---
Makefile | 8 ++++----
MAINTAINERS | 5 +++--
qemu-deprecated.texi => docs/system/deprecated.texi | 0
.../system/qemu-option-trace.texi | 0
docs/{ => system}/security.texi | 0
qemu-doc.texi | 4 ++--
qemu-options.hx | 2 +-
7 files changed, 10 insertions(+), 9 deletions(-)
rename qemu-deprecated.texi => docs/system/deprecated.texi (100%)
rename qemu-option-trace.texi => docs/system/qemu-option-trace.texi (100%)
rename docs/{ => system}/security.texi (100%)
diff --git a/Makefile b/Makefile
index 56382a45936..7e60a435426 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/MAINTAINERS b/MAINTAINERS
index 8c6d8f533ce..74b025fb806 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -2232,7 +2232,7 @@ M: Stefan Hajnoczi <stefanha@redhat.com>
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*
@@ -2802,7 +2802,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/qemu-deprecated.texi b/docs/system/deprecated.texi
similarity index 100%
rename from qemu-deprecated.texi
rename to docs/system/deprecated.texi
diff --git a/qemu-option-trace.texi b/docs/system/qemu-option-trace.texi
similarity index 100%
rename from qemu-option-trace.texi
rename to docs/system/qemu-option-trace.texi
diff --git a/docs/security.texi b/docs/system/security.texi
similarity index 100%
rename from docs/security.texi
rename to docs/system/security.texi
diff --git a/qemu-doc.texi b/qemu-doc.texi
index e4bff7edbee..d3e743719ab 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-options.hx b/qemu-options.hx
index ac315c1ac45..5fbfa2797cb 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=]<file>[,arg=<string>]\n"
--
2.20.1
^ permalink raw reply related [flat|nested] 82+ messages in thread* Re: [PATCH v3 11/33] qemu-doc: move included files to docs/system
2020-02-28 15:35 ` [PATCH v3 11/33] qemu-doc: move included files to docs/system Peter Maydell
@ 2020-03-02 11:31 ` Alex Bennée
0 siblings, 0 replies; 82+ messages in thread
From: Alex Bennée @ 2020-03-02 11:31 UTC (permalink / raw)
To: Peter Maydell; +Cc: Paolo Bonzini, qemu-devel, Kashyap Chamarthy
Peter Maydell <peter.maydell@linaro.org> writes:
> From: Paolo Bonzini <pbonzini@redhat.com>
>
> Since qemu-doc.texi is mostly including files from docs/system,
> move the existing include files there for consistency.
>
> Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
> Message-id: 20200226113034.6741-12-pbonzini@redhat.com
> [PMM: update MAINTAINERS line for qemu-option-trace.texi]
> Reviewed-by: Peter Maydell <peter.maydell@linaro.org>
> Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
Reviewed-by: Alex Bennée <alex.bennee@linaro.org>
> ---
> Makefile | 8 ++++----
> MAINTAINERS | 5 +++--
> qemu-deprecated.texi => docs/system/deprecated.texi | 0
> .../system/qemu-option-trace.texi | 0
> docs/{ => system}/security.texi | 0
> qemu-doc.texi | 4 ++--
> qemu-options.hx | 2 +-
> 7 files changed, 10 insertions(+), 9 deletions(-)
> rename qemu-deprecated.texi => docs/system/deprecated.texi (100%)
> rename qemu-option-trace.texi => docs/system/qemu-option-trace.texi (100%)
> rename docs/{ => system}/security.texi (100%)
>
> diff --git a/Makefile b/Makefile
> index 56382a45936..7e60a435426 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/MAINTAINERS b/MAINTAINERS
> index 8c6d8f533ce..74b025fb806 100644
> --- a/MAINTAINERS
> +++ b/MAINTAINERS
> @@ -2232,7 +2232,7 @@ M: Stefan Hajnoczi <stefanha@redhat.com>
> 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*
> @@ -2802,7 +2802,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/qemu-deprecated.texi b/docs/system/deprecated.texi
> similarity index 100%
> rename from qemu-deprecated.texi
> rename to docs/system/deprecated.texi
> diff --git a/qemu-option-trace.texi b/docs/system/qemu-option-trace.texi
> similarity index 100%
> rename from qemu-option-trace.texi
> rename to docs/system/qemu-option-trace.texi
> diff --git a/docs/security.texi b/docs/system/security.texi
> similarity index 100%
> rename from docs/security.texi
> rename to docs/system/security.texi
> diff --git a/qemu-doc.texi b/qemu-doc.texi
> index e4bff7edbee..d3e743719ab 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-options.hx b/qemu-options.hx
> index ac315c1ac45..5fbfa2797cb 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=]<file>[,arg=<string>]\n"
--
Alex Bennée
^ permalink raw reply [flat|nested] 82+ messages in thread
* [PATCH v3 12/33] qemu-doc: remove indices other than findex
2020-02-28 15:35 [PATCH v3 00/33] Convert qemu-doc to rST Peter Maydell
` (10 preceding siblings ...)
2020-02-28 15:35 ` [PATCH v3 11/33] qemu-doc: move included files to docs/system Peter Maydell
@ 2020-02-28 15:35 ` Peter Maydell
2020-03-02 11:32 ` Alex Bennée
2020-02-28 15:35 ` [PATCH v3 13/33] docs/system: put qemu-block-drivers body in an included file Peter Maydell
` (23 subsequent siblings)
35 siblings, 1 reply; 82+ messages in thread
From: Peter Maydell @ 2020-02-28 15:35 UTC (permalink / raw)
To: qemu-devel; +Cc: Paolo Bonzini, Kashyap Chamarthy
From: Paolo Bonzini <pbonzini@redhat.com>
These indices are not well-maintained, and pandoc also chokes on the
directives. Just nuke them.
Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
Message-id: 20200226113034.6741-13-pbonzini@redhat.com
Reviewed-by: Peter Maydell <peter.maydell@linaro.org>
Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
---
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(-)
diff --git a/docs/system/keys.texi b/docs/system/keys.texi
index 4c74b3bf4dd..c04daf54f23 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 c5b6a9b38e4..b41b144885d 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 c9a2d14cb88..b21c2c56540 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 ed7295de7a2..baceaa96eb2 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 040d77b5e05..c56b5f6ebfe 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 edd23fa8df5..cc352b89a84 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 b5bc9df40ae..a77b19ea0f1 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 f722c00912a..fe12ee94c73 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 c2c254d3d23..55f98f65b12 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 7fe0aec9c39..7748001f734 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 9e7a27de0ce..4db4ca3842b 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 08b0b362991..40327de6fa7 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 d3e743719ab..c2b9c87c645 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
--
2.20.1
^ permalink raw reply related [flat|nested] 82+ messages in thread* Re: [PATCH v3 12/33] qemu-doc: remove indices other than findex
2020-02-28 15:35 ` [PATCH v3 12/33] qemu-doc: remove indices other than findex Peter Maydell
@ 2020-03-02 11:32 ` Alex Bennée
0 siblings, 0 replies; 82+ messages in thread
From: Alex Bennée @ 2020-03-02 11:32 UTC (permalink / raw)
To: Peter Maydell; +Cc: Paolo Bonzini, qemu-devel, Kashyap Chamarthy
Peter Maydell <peter.maydell@linaro.org> writes:
> From: Paolo Bonzini <pbonzini@redhat.com>
>
> These indices are not well-maintained, and pandoc also chokes on the
> directives. Just nuke them.
>
> Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
> Message-id: 20200226113034.6741-13-pbonzini@redhat.com
> Reviewed-by: Peter Maydell <peter.maydell@linaro.org>
> Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
Reviewed-by: Alex Bennée <alex.bennee@linaro.org>
> ---
> 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(-)
>
> diff --git a/docs/system/keys.texi b/docs/system/keys.texi
> index 4c74b3bf4dd..c04daf54f23 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 c5b6a9b38e4..b41b144885d 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 c9a2d14cb88..b21c2c56540 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 ed7295de7a2..baceaa96eb2 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 040d77b5e05..c56b5f6ebfe 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 edd23fa8df5..cc352b89a84 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 b5bc9df40ae..a77b19ea0f1 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 f722c00912a..fe12ee94c73 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 c2c254d3d23..55f98f65b12 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 7fe0aec9c39..7748001f734 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 9e7a27de0ce..4db4ca3842b 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 08b0b362991..40327de6fa7 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 d3e743719ab..c2b9c87c645 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
--
Alex Bennée
^ permalink raw reply [flat|nested] 82+ messages in thread
* [PATCH v3 13/33] docs/system: put qemu-block-drivers body in an included file
2020-02-28 15:35 [PATCH v3 00/33] Convert qemu-doc to rST Peter Maydell
` (11 preceding siblings ...)
2020-02-28 15:35 ` [PATCH v3 12/33] qemu-doc: remove indices other than findex Peter Maydell
@ 2020-02-28 15:35 ` Peter Maydell
2020-03-02 11:32 ` Alex Bennée
2020-02-28 15:36 ` [PATCH v3 14/33] docs: Create defs.rst.inc as a place to define substitutions Peter Maydell
` (22 subsequent siblings)
35 siblings, 1 reply; 82+ messages in thread
From: Peter Maydell @ 2020-02-28 15:35 UTC (permalink / raw)
To: qemu-devel; +Cc: Paolo Bonzini, Kashyap Chamarthy
From: Paolo Bonzini <pbonzini@redhat.com>
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 <pbonzini@redhat.com>
Message-id: 20200226113034.6741-14-pbonzini@redhat.com
Reviewed-by: Peter Maydell <peter.maydell@linaro.org>
[PMM: Added commit message note about temporarily losing
qemu-block-drivers from the system manual]
Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
---
docs/system/index.rst | 1 -
docs/system/qemu-block-drivers.rst | 987 +-----------------
...drivers.rst => qemu-block-drivers.rst.inc} | 59 +-
3 files changed, 26 insertions(+), 1021 deletions(-)
copy docs/system/{qemu-block-drivers.rst => qemu-block-drivers.rst.inc} (96%)
diff --git a/docs/system/index.rst b/docs/system/index.rst
index 1a4b2c82ace..fc774a18b54 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 388adbefbf4..7ca890ea23a 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.
+Synopsis
+--------
-.. only:: man
+QEMU block driver reference manual
- Synopsis
- --------
+Description
+-----------
- QEMU block driver reference manual
+.. include:: qemu-block-drivers.rst.inc
-Disk image file formats
------------------------
+See also
+--------
-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>[%<password>]@]<host>[:<port>]/<target-iqn-name>/<lun>
-
-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=<username>
- export LIBISCSI_CHAP_PASSWORD=<password>
- iscsi://<host>/<target-iqn-name>/<lun>
-
-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[:<uuid>'] where <uuid> is the UUID of the
-virtual machine. If the UUID is not specified qemu will use
-'iqn.2008-11.org.linux-kvm[:<name>'] where <name> 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 <<EOF
- [iscsi]
- user = "me"
- password = "my password"
- initiator-name = "iqn.qemu.test:my-initiator"
- header-digest = "CRC32C"
- EOF
-
- |qemu_system| -drive file=iscsi://127.0.0.1/iqn.qemu.test/1 \\
- -readconfig iscsi.conf
-
-How to set up a simple iSCSI target on loopback and access it via QEMU:
-this example shows how to set up an iSCSI target with one CDROM and one DISK
-using the Linux STGT software target. This target is available on Red Hat based
-systems as the package 'scsi-target-utils'.
-
-.. parsed-literal::
-
- tgtd --iscsi portal=127.0.0.1:3260
- tgtadm --lld iscsi --op new --mode target --tid 1 -T iqn.qemu.test
- tgtadm --lld iscsi --mode logicalunit --op new --tid 1 --lun 1 \\
- -b /IMAGES/disk.img --device-type=disk
- tgtadm --lld iscsi --mode logicalunit --op new --tid 1 --lun 2 \\
- -b /IMAGES/cd.iso --device-type=cd
- tgtadm --lld iscsi --op bind --mode target --tid 1 -I ALL
-
- |qemu_system| -iscsi initiator-name=iqn.qemu.test:my-initiator \\
- -boot d -drive file=iscsi://127.0.0.1/iqn.qemu.test/1 \\
- -cdrom iscsi://127.0.0.1/iqn.qemu.test/2
-
-GlusterFS disk images
----------------------
-
-GlusterFS is a user space distributed file system.
-
-You can boot from the GlusterFS disk image with the command:
-
-URI:
-
-.. parsed-literal::
-
- |qemu_system| -drive file=gluster[+TYPE]://[HOST}[:PORT]]/VOLUME/PATH
- [?socket=...][,file.debug=9][,file.logfile=...]
-
-JSON:
-
-.. parsed-literal::
-
- |qemu_system| 'json:{"driver":"qcow2",
- "file":{"driver":"gluster",
- "volume":"testvol","path":"a.img","debug":9,"logfile":"...",
- "server":[{"type":"tcp","host":"...","port":"..."},
- {"type":"unix","socket":"..."}]}}'
-
-*gluster* is the protocol.
-
-*TYPE* specifies the transport type used to connect to gluster
-management daemon (glusterd). Valid transport types are
-tcp and unix. In the URI form, if a transport type isn't specified,
-then tcp type is assumed.
-
-*HOST* specifies the server where the volume file specification for
-the given volume resides. This can be either a hostname or an ipv4 address.
-If transport type is unix, then *HOST* field should not be specified.
-Instead *socket* field needs to be populated with the path to unix domain
-socket.
-
-*PORT* is the port number on which glusterd is listening. This is optional
-and if not specified, it defaults to port 24007. If the transport type is unix,
-then *PORT* should not be specified.
-
-*VOLUME* is the name of the gluster volume which contains the disk image.
-
-*PATH* is the path to the actual disk image that resides on gluster volume.
-
-*debug* is the logging level of the gluster protocol driver. Debug levels
-are 0-9, with 9 being the most verbose, and 0 representing no debugging output.
-The default level is 4. The current logging levels defined in the gluster source
-are 0 - None, 1 - Emergency, 2 - Alert, 3 - Critical, 4 - Error, 5 - Warning,
-6 - Notice, 7 - Info, 8 - Debug, 9 - Trace
-
-*logfile* is a commandline option to mention log file path which helps in
-logging to the specified file and also help in persisting the gfapi logs. The
-default is stderr.
-
-You can create a GlusterFS disk image with the command:
-
-.. parsed-literal::
-
- qemu-img create gluster://HOST/VOLUME/PATH SIZE
-
-Examples
-
-.. parsed-literal::
-
- |qemu_system| -drive file=gluster://1.2.3.4/testvol/a.img
- |qemu_system| -drive file=gluster+tcp://1.2.3.4/testvol/a.img
- |qemu_system| -drive file=gluster+tcp://1.2.3.4:24007/testvol/dir/a.img
- |qemu_system| -drive file=gluster+tcp://[1:2:3:4:5:6:7:8]/testvol/dir/a.img
- |qemu_system| -drive file=gluster+tcp://[1:2:3:4:5:6:7:8]:24007/testvol/dir/a.img
- |qemu_system| -drive file=gluster+tcp://server.domain.com:24007/testvol/dir/a.img
- |qemu_system| -drive file=gluster+unix:///testvol/dir/a.img?socket=/tmp/glusterd.socket
- |qemu_system| -drive file=gluster+rdma://1.2.3.4:24007/testvol/a.img
- |qemu_system| -drive file=gluster://1.2.3.4/testvol/a.img,file.debug=9,file.logfile=/var/log/qemu-gluster.log
- |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
-
-Secure Shell (ssh) disk images
-------------------------------
-
-You can access disk images located on a remote ssh server
-by using the ssh protocol:
-
-.. parsed-literal::
-
- |qemu_system| -drive file=ssh://[USER@]SERVER[:PORT]/PATH[?host_key_check=HOST_KEY_CHECK]
-
-Alternative syntax using properties:
-
-.. parsed-literal::
-
- |qemu_system| -drive file.driver=ssh[,file.user=USER],file.host=SERVER[,file.port=PORT],file.path=PATH[,file.host_key_check=HOST_KEY_CHECK]
-
-*ssh* is the protocol.
-
-*USER* is the remote user. If not specified, then the local
-username is tried.
-
-*SERVER* specifies the remote ssh server. Any ssh server can be
-used, but it must implement the sftp-server protocol. Most Unix/Linux
-systems should work without requiring any extra configuration.
-
-*PORT* is the port number on which sshd is listening. By default
-the standard ssh port (22) is used.
-
-*PATH* is the path to the disk image.
-
-The optional *HOST_KEY_CHECK* parameter controls how the remote
-host's key is checked. The default is ``yes`` which means to use
-the local ``.ssh/known_hosts`` file. Setting this to ``no``
-turns off known-hosts checking. Or you can check that the host key
-matches a specific fingerprint:
-``host_key_check=md5:78:45:8e:14:57:4f:d5:45:83:0a:0e:f3:49:82:c9:c8``
-(``sha1:`` can also be used as a prefix, but note that OpenSSH
-tools only use MD5 to print fingerprints).
-
-Currently authentication must be done using ssh-agent. Other
-authentication methods may be supported in future.
-
-Note: Many ssh servers do not support an ``fsync``-style operation.
-The ssh driver cannot guarantee that disk flush requests are
-obeyed, and this causes a risk of disk corruption if the remote
-server or network goes down during writes. The driver will
-print a warning when ``fsync`` is not supported:
-
-::
-
- warning: ssh server ssh.example.com:22 does not support fsync
-
-With sufficiently new versions of libssh and OpenSSH, ``fsync`` is
-supported.
-
-NVMe disk images
-----------------
-
-NVM Express (NVMe) storage controllers can be accessed directly by a userspace
-driver in QEMU. This bypasses the host kernel file system and block layers
-while retaining QEMU block layer functionalities, such as block jobs, I/O
-throttling, image formats, etc. Disk I/O performance is typically higher than
-with ``-drive file=/dev/sda`` using either thread pool or linux-aio.
-
-The controller will be exclusively used by the QEMU process once started. To be
-able to share storage between multiple VMs and other applications on the host,
-please use the file based protocols.
-
-Before starting QEMU, bind the host NVMe controller to the host vfio-pci
-driver. For example:
-
-.. parsed-literal::
-
- # modprobe vfio-pci
- # lspci -n -s 0000:06:0d.0
- 06:0d.0 0401: 1102:0002 (rev 08)
- # echo 0000:06:0d.0 > /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.
-
-.. only:: man
-
- 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 b/docs/system/qemu-block-drivers.rst.inc
similarity index 96%
copy from docs/system/qemu-block-drivers.rst
copy to docs/system/qemu-block-drivers.rst.inc
index 388adbefbf4..b052a6d14e2 100644
--- a/docs/system/qemu-block-drivers.rst
+++ b/docs/system/qemu-block-drivers.rst.inc
@@ -1,28 +1,5 @@
-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
@@ -394,7 +371,7 @@ This section describes each format and the options that are supported for it.
Log size; min 1 MB.
Read-only formats
------------------
+~~~~~~~~~~~~~~~~~
More disk image file formats are supported in a read-only mode.
@@ -420,13 +397,13 @@ More disk image file formats are supported in a read-only mode.
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
@@ -454,7 +431,7 @@ Hard disks
line option or modify the device permissions accordingly).
Windows
-'''''''
+^^^^^^^
CD
The preferred syntax is the drive letter (e.g. ``d:``). The
@@ -475,7 +452,7 @@ Hard disks
modifications are written in a temporary file).
Mac OS X
-''''''''
+^^^^^^^^
``/dev/cdrom`` is an alias to the first CDROM.
@@ -484,7 +461,7 @@ 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:
@@ -518,7 +495,7 @@ What you should *never* do:
- 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.
@@ -573,7 +550,7 @@ also available. Here are some example of the older syntax:
Sheepdog disk images
---------------------
+~~~~~~~~~~~~~~~~~~~~
Sheepdog is a distributed storage system for QEMU. It provides highly
available block level storage volumes that can be attached to
@@ -640,7 +617,7 @@ specify one of the Sheepdog servers to connect to.
|qemu_system| sheepdog://HOSTNAME:PORT/IMAGE
iSCSI LUNs
-----------
+~~~~~~~~~~
iSCSI is a popular protocol used to access SCSI devices across a computer
network.
@@ -752,7 +729,7 @@ systems as the package 'scsi-target-utils'.
-cdrom iscsi://127.0.0.1/iqn.qemu.test/2
GlusterFS disk images
----------------------
+~~~~~~~~~~~~~~~~~~~~~
GlusterFS is a user space distributed file system.
@@ -837,7 +814,7 @@ Examples
file.server.1.type=unix,file.server.1.socket=/var/run/glusterd.socket
Secure Shell (ssh) disk images
-------------------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
You can access disk images located on a remote ssh server
by using the ssh protocol:
@@ -892,7 +869,7 @@ With sufficiently new versions of libssh and OpenSSH, ``fsync`` is
supported.
NVMe disk images
-----------------
+~~~~~~~~~~~~~~~~
NVM Express (NVMe) storage controllers can be accessed directly by a userspace
driver in QEMU. This bypasses the host kernel file system and block layers
@@ -929,7 +906,7 @@ 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
@@ -975,11 +952,3 @@ 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.
-
-.. only:: man
-
- See also
- --------
-
- The HTML documentation of QEMU for more precise information and Linux
- user mode emulator invocation.
--
2.20.1
^ permalink raw reply related [flat|nested] 82+ messages in thread* Re: [PATCH v3 13/33] docs/system: put qemu-block-drivers body in an included file
2020-02-28 15:35 ` [PATCH v3 13/33] docs/system: put qemu-block-drivers body in an included file Peter Maydell
@ 2020-03-02 11:32 ` Alex Bennée
0 siblings, 0 replies; 82+ messages in thread
From: Alex Bennée @ 2020-03-02 11:32 UTC (permalink / raw)
To: Peter Maydell; +Cc: Paolo Bonzini, qemu-devel, Kashyap Chamarthy
Peter Maydell <peter.maydell@linaro.org> writes:
> From: Paolo Bonzini <pbonzini@redhat.com>
>
> 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 <pbonzini@redhat.com>
> Message-id: 20200226113034.6741-14-pbonzini@redhat.com
> Reviewed-by: Peter Maydell <peter.maydell@linaro.org>
> [PMM: Added commit message note about temporarily losing
> qemu-block-drivers from the system manual]
> Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
Reviewed-by: Alex Bennée <alex.bennee@linaro.org>
> ---
> docs/system/index.rst | 1 -
> docs/system/qemu-block-drivers.rst | 987 +-----------------
> ...drivers.rst => qemu-block-drivers.rst.inc} | 59 +-
> 3 files changed, 26 insertions(+), 1021 deletions(-)
> copy docs/system/{qemu-block-drivers.rst => qemu-block-drivers.rst.inc} (96%)
>
> diff --git a/docs/system/index.rst b/docs/system/index.rst
> index 1a4b2c82ace..fc774a18b54 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 388adbefbf4..7ca890ea23a 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.
> +Synopsis
> +--------
>
> -.. only:: man
> +QEMU block driver reference manual
>
> - Synopsis
> - --------
> +Description
> +-----------
>
> - QEMU block driver reference manual
> +.. include:: qemu-block-drivers.rst.inc
>
> -Disk image file formats
> ------------------------
> +See also
> +--------
>
> -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>[%<password>]@]<host>[:<port>]/<target-iqn-name>/<lun>
> -
> -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=<username>
> - export LIBISCSI_CHAP_PASSWORD=<password>
> - iscsi://<host>/<target-iqn-name>/<lun>
> -
> -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[:<uuid>'] where <uuid> is the UUID of the
> -virtual machine. If the UUID is not specified qemu will use
> -'iqn.2008-11.org.linux-kvm[:<name>'] where <name> 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 <<EOF
> - [iscsi]
> - user = "me"
> - password = "my password"
> - initiator-name = "iqn.qemu.test:my-initiator"
> - header-digest = "CRC32C"
> - EOF
> -
> - |qemu_system| -drive file=iscsi://127.0.0.1/iqn.qemu.test/1 \\
> - -readconfig iscsi.conf
> -
> -How to set up a simple iSCSI target on loopback and access it via QEMU:
> -this example shows how to set up an iSCSI target with one CDROM and one DISK
> -using the Linux STGT software target. This target is available on Red Hat based
> -systems as the package 'scsi-target-utils'.
> -
> -.. parsed-literal::
> -
> - tgtd --iscsi portal=127.0.0.1:3260
> - tgtadm --lld iscsi --op new --mode target --tid 1 -T iqn.qemu.test
> - tgtadm --lld iscsi --mode logicalunit --op new --tid 1 --lun 1 \\
> - -b /IMAGES/disk.img --device-type=disk
> - tgtadm --lld iscsi --mode logicalunit --op new --tid 1 --lun 2 \\
> - -b /IMAGES/cd.iso --device-type=cd
> - tgtadm --lld iscsi --op bind --mode target --tid 1 -I ALL
> -
> - |qemu_system| -iscsi initiator-name=iqn.qemu.test:my-initiator \\
> - -boot d -drive file=iscsi://127.0.0.1/iqn.qemu.test/1 \\
> - -cdrom iscsi://127.0.0.1/iqn.qemu.test/2
> -
> -GlusterFS disk images
> ----------------------
> -
> -GlusterFS is a user space distributed file system.
> -
> -You can boot from the GlusterFS disk image with the command:
> -
> -URI:
> -
> -.. parsed-literal::
> -
> - |qemu_system| -drive file=gluster[+TYPE]://[HOST}[:PORT]]/VOLUME/PATH
> - [?socket=...][,file.debug=9][,file.logfile=...]
> -
> -JSON:
> -
> -.. parsed-literal::
> -
> - |qemu_system| 'json:{"driver":"qcow2",
> - "file":{"driver":"gluster",
> - "volume":"testvol","path":"a.img","debug":9,"logfile":"...",
> - "server":[{"type":"tcp","host":"...","port":"..."},
> - {"type":"unix","socket":"..."}]}}'
> -
> -*gluster* is the protocol.
> -
> -*TYPE* specifies the transport type used to connect to gluster
> -management daemon (glusterd). Valid transport types are
> -tcp and unix. In the URI form, if a transport type isn't specified,
> -then tcp type is assumed.
> -
> -*HOST* specifies the server where the volume file specification for
> -the given volume resides. This can be either a hostname or an ipv4 address.
> -If transport type is unix, then *HOST* field should not be specified.
> -Instead *socket* field needs to be populated with the path to unix domain
> -socket.
> -
> -*PORT* is the port number on which glusterd is listening. This is optional
> -and if not specified, it defaults to port 24007. If the transport type is unix,
> -then *PORT* should not be specified.
> -
> -*VOLUME* is the name of the gluster volume which contains the disk image.
> -
> -*PATH* is the path to the actual disk image that resides on gluster volume.
> -
> -*debug* is the logging level of the gluster protocol driver. Debug levels
> -are 0-9, with 9 being the most verbose, and 0 representing no debugging output.
> -The default level is 4. The current logging levels defined in the gluster source
> -are 0 - None, 1 - Emergency, 2 - Alert, 3 - Critical, 4 - Error, 5 - Warning,
> -6 - Notice, 7 - Info, 8 - Debug, 9 - Trace
> -
> -*logfile* is a commandline option to mention log file path which helps in
> -logging to the specified file and also help in persisting the gfapi logs. The
> -default is stderr.
> -
> -You can create a GlusterFS disk image with the command:
> -
> -.. parsed-literal::
> -
> - qemu-img create gluster://HOST/VOLUME/PATH SIZE
> -
> -Examples
> -
> -.. parsed-literal::
> -
> - |qemu_system| -drive file=gluster://1.2.3.4/testvol/a.img
> - |qemu_system| -drive file=gluster+tcp://1.2.3.4/testvol/a.img
> - |qemu_system| -drive file=gluster+tcp://1.2.3.4:24007/testvol/dir/a.img
> - |qemu_system| -drive file=gluster+tcp://[1:2:3:4:5:6:7:8]/testvol/dir/a.img
> - |qemu_system| -drive file=gluster+tcp://[1:2:3:4:5:6:7:8]:24007/testvol/dir/a.img
> - |qemu_system| -drive file=gluster+tcp://server.domain.com:24007/testvol/dir/a.img
> - |qemu_system| -drive file=gluster+unix:///testvol/dir/a.img?socket=/tmp/glusterd.socket
> - |qemu_system| -drive file=gluster+rdma://1.2.3.4:24007/testvol/a.img
> - |qemu_system| -drive file=gluster://1.2.3.4/testvol/a.img,file.debug=9,file.logfile=/var/log/qemu-gluster.log
> - |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
> -
> -Secure Shell (ssh) disk images
> -------------------------------
> -
> -You can access disk images located on a remote ssh server
> -by using the ssh protocol:
> -
> -.. parsed-literal::
> -
> - |qemu_system| -drive file=ssh://[USER@]SERVER[:PORT]/PATH[?host_key_check=HOST_KEY_CHECK]
> -
> -Alternative syntax using properties:
> -
> -.. parsed-literal::
> -
> - |qemu_system| -drive file.driver=ssh[,file.user=USER],file.host=SERVER[,file.port=PORT],file.path=PATH[,file.host_key_check=HOST_KEY_CHECK]
> -
> -*ssh* is the protocol.
> -
> -*USER* is the remote user. If not specified, then the local
> -username is tried.
> -
> -*SERVER* specifies the remote ssh server. Any ssh server can be
> -used, but it must implement the sftp-server protocol. Most Unix/Linux
> -systems should work without requiring any extra configuration.
> -
> -*PORT* is the port number on which sshd is listening. By default
> -the standard ssh port (22) is used.
> -
> -*PATH* is the path to the disk image.
> -
> -The optional *HOST_KEY_CHECK* parameter controls how the remote
> -host's key is checked. The default is ``yes`` which means to use
> -the local ``.ssh/known_hosts`` file. Setting this to ``no``
> -turns off known-hosts checking. Or you can check that the host key
> -matches a specific fingerprint:
> -``host_key_check=md5:78:45:8e:14:57:4f:d5:45:83:0a:0e:f3:49:82:c9:c8``
> -(``sha1:`` can also be used as a prefix, but note that OpenSSH
> -tools only use MD5 to print fingerprints).
> -
> -Currently authentication must be done using ssh-agent. Other
> -authentication methods may be supported in future.
> -
> -Note: Many ssh servers do not support an ``fsync``-style operation.
> -The ssh driver cannot guarantee that disk flush requests are
> -obeyed, and this causes a risk of disk corruption if the remote
> -server or network goes down during writes. The driver will
> -print a warning when ``fsync`` is not supported:
> -
> -::
> -
> - warning: ssh server ssh.example.com:22 does not support fsync
> -
> -With sufficiently new versions of libssh and OpenSSH, ``fsync`` is
> -supported.
> -
> -NVMe disk images
> -----------------
> -
> -NVM Express (NVMe) storage controllers can be accessed directly by a userspace
> -driver in QEMU. This bypasses the host kernel file system and block layers
> -while retaining QEMU block layer functionalities, such as block jobs, I/O
> -throttling, image formats, etc. Disk I/O performance is typically higher than
> -with ``-drive file=/dev/sda`` using either thread pool or linux-aio.
> -
> -The controller will be exclusively used by the QEMU process once started. To be
> -able to share storage between multiple VMs and other applications on the host,
> -please use the file based protocols.
> -
> -Before starting QEMU, bind the host NVMe controller to the host vfio-pci
> -driver. For example:
> -
> -.. parsed-literal::
> -
> - # modprobe vfio-pci
> - # lspci -n -s 0000:06:0d.0
> - 06:0d.0 0401: 1102:0002 (rev 08)
> - # echo 0000:06:0d.0 > /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.
> -
> -.. only:: man
> -
> - 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 b/docs/system/qemu-block-drivers.rst.inc
> similarity index 96%
> copy from docs/system/qemu-block-drivers.rst
> copy to docs/system/qemu-block-drivers.rst.inc
> index 388adbefbf4..b052a6d14e2 100644
> --- a/docs/system/qemu-block-drivers.rst
> +++ b/docs/system/qemu-block-drivers.rst.inc
> @@ -1,28 +1,5 @@
> -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
> @@ -394,7 +371,7 @@ This section describes each format and the options that are supported for it.
> Log size; min 1 MB.
>
> Read-only formats
> ------------------
> +~~~~~~~~~~~~~~~~~
>
> More disk image file formats are supported in a read-only mode.
>
> @@ -420,13 +397,13 @@ More disk image file formats are supported in a read-only mode.
> 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
> @@ -454,7 +431,7 @@ Hard disks
> line option or modify the device permissions accordingly).
>
> Windows
> -'''''''
> +^^^^^^^
>
> CD
> The preferred syntax is the drive letter (e.g. ``d:``). The
> @@ -475,7 +452,7 @@ Hard disks
> modifications are written in a temporary file).
>
> Mac OS X
> -''''''''
> +^^^^^^^^
>
> ``/dev/cdrom`` is an alias to the first CDROM.
>
> @@ -484,7 +461,7 @@ 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:
> @@ -518,7 +495,7 @@ What you should *never* do:
> - 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.
> @@ -573,7 +550,7 @@ also available. Here are some example of the older syntax:
>
>
> Sheepdog disk images
> ---------------------
> +~~~~~~~~~~~~~~~~~~~~
>
> Sheepdog is a distributed storage system for QEMU. It provides highly
> available block level storage volumes that can be attached to
> @@ -640,7 +617,7 @@ specify one of the Sheepdog servers to connect to.
> |qemu_system| sheepdog://HOSTNAME:PORT/IMAGE
>
> iSCSI LUNs
> -----------
> +~~~~~~~~~~
>
> iSCSI is a popular protocol used to access SCSI devices across a computer
> network.
> @@ -752,7 +729,7 @@ systems as the package 'scsi-target-utils'.
> -cdrom iscsi://127.0.0.1/iqn.qemu.test/2
>
> GlusterFS disk images
> ----------------------
> +~~~~~~~~~~~~~~~~~~~~~
>
> GlusterFS is a user space distributed file system.
>
> @@ -837,7 +814,7 @@ Examples
> file.server.1.type=unix,file.server.1.socket=/var/run/glusterd.socket
>
> Secure Shell (ssh) disk images
> -------------------------------
> +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
>
> You can access disk images located on a remote ssh server
> by using the ssh protocol:
> @@ -892,7 +869,7 @@ With sufficiently new versions of libssh and OpenSSH, ``fsync`` is
> supported.
>
> NVMe disk images
> -----------------
> +~~~~~~~~~~~~~~~~
>
> NVM Express (NVMe) storage controllers can be accessed directly by a userspace
> driver in QEMU. This bypasses the host kernel file system and block layers
> @@ -929,7 +906,7 @@ 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
> @@ -975,11 +952,3 @@ 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.
> -
> -.. only:: man
> -
> - See also
> - --------
> -
> - The HTML documentation of QEMU for more precise information and Linux
> - user mode emulator invocation.
--
Alex Bennée
^ permalink raw reply [flat|nested] 82+ messages in thread
* [PATCH v3 14/33] docs: Create defs.rst.inc as a place to define substitutions
2020-02-28 15:35 [PATCH v3 00/33] Convert qemu-doc to rST Peter Maydell
` (12 preceding siblings ...)
2020-02-28 15:35 ` [PATCH v3 13/33] docs/system: put qemu-block-drivers body in an included file Peter Maydell
@ 2020-02-28 15:36 ` Peter Maydell
2020-03-02 12:40 ` Kashyap Chamarthy
2020-02-28 15:36 ` [PATCH v3 15/33] docs/system: Convert qemu-cpu-models.texi to rST Peter Maydell
` (21 subsequent siblings)
35 siblings, 1 reply; 82+ messages in thread
From: Peter Maydell @ 2020-02-28 15:36 UTC (permalink / raw)
To: qemu-devel; +Cc: Paolo Bonzini, Kashyap Chamarthy
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 <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
diff --git a/Makefile b/Makefile
index 7e60a435426..26bbd334438 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 7588bf192ee..960043cb860 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 00000000000..ae80d2f35d8
--- /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 7ca890ea23a..bd99d4fa8eb 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
--------
--
2.20.1
^ permalink raw reply related [flat|nested] 82+ messages in thread* Re: [PATCH v3 14/33] docs: Create defs.rst.inc as a place to define substitutions
2020-02-28 15:36 ` [PATCH v3 14/33] docs: Create defs.rst.inc as a place to define substitutions Peter Maydell
@ 2020-03-02 12:40 ` Kashyap Chamarthy
0 siblings, 0 replies; 82+ messages in thread
From: Kashyap Chamarthy @ 2020-03-02 12:40 UTC (permalink / raw)
To: Peter Maydell; +Cc: Paolo Bonzini, qemu-devel
On Fri, Feb 28, 2020 at 03:36:00PM +0000, Peter Maydell wrote:
> 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 <peter.maydell@linaro.org>
Reviewed-by: Kashyap Chamarthy <kchamart@redhat.com>
> ---
> 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
>
> diff --git a/Makefile b/Makefile
> index 7e60a435426..26bbd334438 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 7588bf192ee..960043cb860 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:
I didn't know about the above quirk; thanks for the explanatory comment.
> + 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 00000000000..ae80d2f35d8
> --- /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.
Thanks for documenting the above bit here. (I learnt about it from you
on IRC.)
> +.. |qemu_system| replace:: qemu-system-x86_64
> diff --git a/docs/system/qemu-block-drivers.rst b/docs/system/qemu-block-drivers.rst
> index 7ca890ea23a..bd99d4fa8eb 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
> --------
>
> --
> 2.20.1
>
--
/kashyap
^ permalink raw reply [flat|nested] 82+ messages in thread
* [PATCH v3 15/33] docs/system: Convert qemu-cpu-models.texi to rST
2020-02-28 15:35 [PATCH v3 00/33] Convert qemu-doc to rST Peter Maydell
` (13 preceding siblings ...)
2020-02-28 15:36 ` [PATCH v3 14/33] docs: Create defs.rst.inc as a place to define substitutions Peter Maydell
@ 2020-02-28 15:36 ` Peter Maydell
2020-03-02 12:08 ` Alex Bennée
2020-02-28 15:36 ` [PATCH v3 16/33] docs/system: Convert security.texi to rST format Peter Maydell
` (20 subsequent siblings)
35 siblings, 1 reply; 82+ messages in thread
From: Peter Maydell @ 2020-02-28 15:36 UTC (permalink / raw)
To: qemu-devel; +Cc: Paolo Bonzini, Kashyap Chamarthy
From: Kashyap Chamarthy <kchamart@redhat.com>
This doc was originally written by Daniel P. Berrangé
<berrange@redhat.com>, 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 <kchamart@redhat.com>
Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
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 <pbonzini@redhat.com>
[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 <peter.maydell@linaro.org>
---
Makefile | 8 +-
MAINTAINERS | 2 +
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
diff --git a/Makefile b/Makefile
index 26bbd334438..f8642cd28a1 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/MAINTAINERS b/MAINTAINERS
index 74b025fb806..1712eb90851 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/docs/system/conf.py b/docs/system/conf.py
index 7ca115f5e03..23cab3fb364 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 00000000000..499b5b6fedb
--- /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 00000000000..cbad930c700
--- /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 ``<cpu>`` 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::
+
+ <cpu mode='host-passthrough'/>
+
+Host passthrough with feature customization::
+
+ <cpu mode='host-passthrough'>
+ <feature name="vmx" policy="disable"/>
+ ...
+ </cpu>
+
+Host model::
+
+ <cpu mode='host-model'/>
+
+Host model with feature customization::
+
+ <cpu mode='host-model'>
+ <feature name="vmx" policy="disable"/>
+ ...
+ </cpu>
+
+Named model::
+
+ <cpu mode='custom'>
+ <model name="Westmere"/>
+ </cpu>
+
+Named model with feature customization::
+
+ <cpu mode='custom'>
+ <model name="Westmere"/>
+ <feature name="pcid" policy="require"/>
+ ...
+ </cpu>
diff --git a/docs/system/qemu-cpu-models.rst b/docs/system/qemu-cpu-models.rst
new file mode 100644
index 00000000000..53d7538c473
--- /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 f399daf9448..00000000000
--- 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
--
2.20.1
^ permalink raw reply related [flat|nested] 82+ messages in thread* Re: [PATCH v3 15/33] docs/system: Convert qemu-cpu-models.texi to rST
2020-02-28 15:36 ` [PATCH v3 15/33] docs/system: Convert qemu-cpu-models.texi to rST Peter Maydell
@ 2020-03-02 12:08 ` Alex Bennée
0 siblings, 0 replies; 82+ messages in thread
From: Alex Bennée @ 2020-03-02 12:08 UTC (permalink / raw)
To: Peter Maydell; +Cc: Paolo Bonzini, qemu-devel, Kashyap Chamarthy
Peter Maydell <peter.maydell@linaro.org> writes:
> From: Kashyap Chamarthy <kchamart@redhat.com>
>
> This doc was originally written by Daniel P. Berrangé
> <berrange@redhat.com>, 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 <kchamart@redhat.com>
> Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
> 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 <pbonzini@redhat.com>
> [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 <peter.maydell@linaro.org>
Reviewed-by: Alex Bennée <alex.bennee@linaro.org>
> ---
> Makefile | 8 +-
> MAINTAINERS | 2 +
> 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
>
> diff --git a/Makefile b/Makefile
> index 26bbd334438..f8642cd28a1 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/MAINTAINERS b/MAINTAINERS
> index 74b025fb806..1712eb90851 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/docs/system/conf.py b/docs/system/conf.py
> index 7ca115f5e03..23cab3fb364 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 00000000000..499b5b6fedb
> --- /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 00000000000..cbad930c700
> --- /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 ``<cpu>`` 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::
> +
> + <cpu mode='host-passthrough'/>
> +
> +Host passthrough with feature customization::
> +
> + <cpu mode='host-passthrough'>
> + <feature name="vmx" policy="disable"/>
> + ...
> + </cpu>
> +
> +Host model::
> +
> + <cpu mode='host-model'/>
> +
> +Host model with feature customization::
> +
> + <cpu mode='host-model'>
> + <feature name="vmx" policy="disable"/>
> + ...
> + </cpu>
> +
> +Named model::
> +
> + <cpu mode='custom'>
> + <model name="Westmere"/>
> + </cpu>
> +
> +Named model with feature customization::
> +
> + <cpu mode='custom'>
> + <model name="Westmere"/>
> + <feature name="pcid" policy="require"/>
> + ...
> + </cpu>
> diff --git a/docs/system/qemu-cpu-models.rst b/docs/system/qemu-cpu-models.rst
> new file mode 100644
> index 00000000000..53d7538c473
> --- /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 f399daf9448..00000000000
> --- 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
--
Alex Bennée
^ permalink raw reply [flat|nested] 82+ messages in thread
* [PATCH v3 16/33] docs/system: Convert security.texi to rST format
2020-02-28 15:35 [PATCH v3 00/33] Convert qemu-doc to rST Peter Maydell
` (14 preceding siblings ...)
2020-02-28 15:36 ` [PATCH v3 15/33] docs/system: Convert qemu-cpu-models.texi to rST Peter Maydell
@ 2020-02-28 15:36 ` Peter Maydell
2020-03-02 12:10 ` Alex Bennée
2020-02-28 15:36 ` [PATCH v3 17/33] docs/system: convert managed startup to rST Peter Maydell
` (19 subsequent siblings)
35 siblings, 1 reply; 82+ messages in thread
From: Peter Maydell @ 2020-02-28 15:36 UTC (permalink / raw)
To: qemu-devel; +Cc: Paolo Bonzini, Kashyap Chamarthy
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 <peter.maydell@linaro.org>
Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
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
diff --git a/docs/system/index.rst b/docs/system/index.rst
index fc774a18b54..5034f903407 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 00000000000..f2092c8768b
--- /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.
--
2.20.1
^ permalink raw reply related [flat|nested] 82+ messages in thread* Re: [PATCH v3 16/33] docs/system: Convert security.texi to rST format
2020-02-28 15:36 ` [PATCH v3 16/33] docs/system: Convert security.texi to rST format Peter Maydell
@ 2020-03-02 12:10 ` Alex Bennée
0 siblings, 0 replies; 82+ messages in thread
From: Alex Bennée @ 2020-03-02 12:10 UTC (permalink / raw)
To: Peter Maydell; +Cc: Paolo Bonzini, qemu-devel, Kashyap Chamarthy
Peter Maydell <peter.maydell@linaro.org> writes:
> 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 <peter.maydell@linaro.org>
> Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
> Message-id: 20200226113034.6741-16-pbonzini@redhat.com
Reviewed-by: Alex Bennée <alex.bennee@linaro.org>
> ---
> docs/system/index.rst | 1 +
> docs/system/security.rst | 173 +++++++++++++++++++++++++++++++++++++++
> 2 files changed, 174 insertions(+)
> create mode 100644 docs/system/security.rst
>
> diff --git a/docs/system/index.rst b/docs/system/index.rst
> index fc774a18b54..5034f903407 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 00000000000..f2092c8768b
> --- /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.
--
Alex Bennée
^ permalink raw reply [flat|nested] 82+ messages in thread
* [PATCH v3 17/33] docs/system: convert managed startup to rST.
2020-02-28 15:35 [PATCH v3 00/33] Convert qemu-doc to rST Peter Maydell
` (15 preceding siblings ...)
2020-02-28 15:36 ` [PATCH v3 16/33] docs/system: Convert security.texi to rST format Peter Maydell
@ 2020-02-28 15:36 ` Peter Maydell
2020-03-02 12:10 ` Alex Bennée
2020-02-28 15:36 ` [PATCH v3 18/33] docs/system: convert the documentation of deprecated features " Peter Maydell
` (18 subsequent siblings)
35 siblings, 1 reply; 82+ messages in thread
From: Peter Maydell @ 2020-02-28 15:36 UTC (permalink / raw)
To: qemu-devel; +Cc: Paolo Bonzini, Kashyap Chamarthy
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 <peter.maydell@linaro.org>
Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
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
diff --git a/docs/system/index.rst b/docs/system/index.rst
index 5034f903407..d655344fffd 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 00000000000..9bcf98ea790
--- /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``
--
2.20.1
^ permalink raw reply related [flat|nested] 82+ messages in thread* Re: [PATCH v3 17/33] docs/system: convert managed startup to rST.
2020-02-28 15:36 ` [PATCH v3 17/33] docs/system: convert managed startup to rST Peter Maydell
@ 2020-03-02 12:10 ` Alex Bennée
0 siblings, 0 replies; 82+ messages in thread
From: Alex Bennée @ 2020-03-02 12:10 UTC (permalink / raw)
To: Peter Maydell; +Cc: Paolo Bonzini, qemu-devel, Kashyap Chamarthy
Peter Maydell <peter.maydell@linaro.org> writes:
> 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 <peter.maydell@linaro.org>
> Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
> Message-id: 20200226113034.6741-17-pbonzini@redhat.com
Reviewed-by: Alex Bennée <alex.bennee@linaro.org>
> ---
> 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
>
> diff --git a/docs/system/index.rst b/docs/system/index.rst
> index 5034f903407..d655344fffd 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 00000000000..9bcf98ea790
> --- /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``
--
Alex Bennée
^ permalink raw reply [flat|nested] 82+ messages in thread
* [PATCH v3 18/33] docs/system: convert the documentation of deprecated features to rST.
2020-02-28 15:35 [PATCH v3 00/33] Convert qemu-doc to rST Peter Maydell
` (16 preceding siblings ...)
2020-02-28 15:36 ` [PATCH v3 17/33] docs/system: convert managed startup to rST Peter Maydell
@ 2020-02-28 15:36 ` Peter Maydell
2020-03-02 12:12 ` Alex Bennée
2020-02-28 15:36 ` [PATCH v3 19/33] docs/system: convert Texinfo documentation " Peter Maydell
` (17 subsequent siblings)
35 siblings, 1 reply; 82+ messages in thread
From: Peter Maydell @ 2020-02-28 15:36 UTC (permalink / raw)
To: qemu-devel; +Cc: Paolo Bonzini, Kashyap Chamarthy
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 <peter.maydell@linaro.org>
Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
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
diff --git a/docs/system/deprecated.rst b/docs/system/deprecated.rst
new file mode 100644
index 00000000000..1eaa559079b
--- /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 <file>`` - 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 d655344fffd..f2f29fb6d2c 100644
--- a/docs/system/index.rst
+++ b/docs/system/index.rst
@@ -16,3 +16,4 @@ Contents:
managed-startup
security
vfio-ap
+ deprecated
--
2.20.1
^ permalink raw reply related [flat|nested] 82+ messages in thread* Re: [PATCH v3 18/33] docs/system: convert the documentation of deprecated features to rST.
2020-02-28 15:36 ` [PATCH v3 18/33] docs/system: convert the documentation of deprecated features " Peter Maydell
@ 2020-03-02 12:12 ` Alex Bennée
0 siblings, 0 replies; 82+ messages in thread
From: Alex Bennée @ 2020-03-02 12:12 UTC (permalink / raw)
To: Peter Maydell; +Cc: Paolo Bonzini, qemu-devel, Kashyap Chamarthy
Peter Maydell <peter.maydell@linaro.org> writes:
> 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 <peter.maydell@linaro.org>
> Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
> Message-id: 20200226113034.6741-18-pbonzini@redhat.com
Reviewed-by: Alex Bennée <alex.bennee@linaro.org>
> ---
> docs/system/deprecated.rst | 446 +++++++++++++++++++++++++++++++++++++
> docs/system/index.rst | 1 +
> 2 files changed, 447 insertions(+)
> create mode 100644 docs/system/deprecated.rst
>
> diff --git a/docs/system/deprecated.rst b/docs/system/deprecated.rst
> new file mode 100644
> index 00000000000..1eaa559079b
> --- /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 <file>`` - 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 d655344fffd..f2f29fb6d2c 100644
> --- a/docs/system/index.rst
> +++ b/docs/system/index.rst
> @@ -16,3 +16,4 @@ Contents:
> managed-startup
> security
> vfio-ap
> + deprecated
--
Alex Bennée
^ permalink raw reply [flat|nested] 82+ messages in thread
* [PATCH v3 19/33] docs/system: convert Texinfo documentation to rST
2020-02-28 15:35 [PATCH v3 00/33] Convert qemu-doc to rST Peter Maydell
` (17 preceding siblings ...)
2020-02-28 15:36 ` [PATCH v3 18/33] docs/system: convert the documentation of deprecated features " Peter Maydell
@ 2020-02-28 15:36 ` Peter Maydell
2020-03-02 12:13 ` Alex Bennée
2020-02-28 15:36 ` [PATCH v3 20/33] hmp-commands.hx: Add rST documentation fragments Peter Maydell
` (16 subsequent siblings)
35 siblings, 1 reply; 82+ messages in thread
From: Peter Maydell @ 2020-02-28 15:36 UTC (permalink / raw)
To: qemu-devel; +Cc: Paolo Bonzini, Kashyap Chamarthy
From: Paolo Bonzini <pbonzini@redhat.com>
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 <pbonzini@redhat.com>
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 <peter.maydell@linaro.org>
Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
---
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
diff --git a/docs/defs.rst.inc b/docs/defs.rst.inc
index ae80d2f35d8..48d05aaf33e 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 00000000000..c2b92a96987
--- /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 00000000000..639f814b32d
--- /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 00000000000..ff26bf95875
--- /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 f2f29fb6d2c..6e5f20fa133 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 00000000000..c112bcb45a4
--- /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://<target-ip>[:<port>]/<target-iqn>/<lun>"
+
+ By default qemu will use the iSCSI initiator-name
+ 'iqn.2008-11.org.linux-kvm[:<name>]' 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://<server-ip>[:<port>]/[<export>]"
+
+ Syntax for specifying a NBD device using Unix Domain Sockets;
+ remember that '?' is a shell glob character and may need quoting:
+ "nbd+unix:///[<export>]?socket=<domain-socket>"
+
+ Older syntax that is also recognized:
+ "nbd:<server-ip>:<port>[:exportname=<export>]"
+
+ Syntax for specifying a NBD device using Unix Domain Sockets
+ "nbd:unix:<domain-socket>[:exportname=<export>]"
+
+ 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:
+
+ ::
+
+ <protocol>://[<username>[:<password>]@]<host>/<path>
+
+ 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 <protocol>.
+
+ 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 00000000000..b03a48afa3a
--- /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 <shm size> 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 00000000000..bf99ee8d5be
--- /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 00000000000..cde3d2d25d7
--- /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 <https://www.gnu.org/licenses/gpl-2.0.txt>`__, version 2. Parts
+of QEMU have specific licenses, see file
+`LICENSE <https://git.qemu.org/?p=qemu.git;a=blob_plain;f=LICENSE>`__.
diff --git a/docs/system/linuxboot.rst b/docs/system/linuxboot.rst
new file mode 100644
index 00000000000..228650abc5e
--- /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 00000000000..482f391f327
--- /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 00000000000..e50172c0815
--- /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 00000000000..4b2640c448e
--- /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 00000000000..3a3acab5e74
--- /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 00000000000..0490be55871
--- /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 00000000000..92e2038b11e
--- /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 00000000000..50b7dd9d639
--- /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 00000000000..2736fd0509b
--- /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 ``<disk_image_file>`` from
+https://mipsdistros.mips.com/LinuxDistro/nanomips/buildroot/index.html.
+
+Download ``<kernel_image_file>`` 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 <kernel_image_file> \
+ -M malta -serial stdio -m <memory_size> -hda <disk_image_file> \
+ -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 00000000000..43fadf3c00b
--- /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 00000000000..589c88d1756
--- /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 00000000000..ca76ba9c488
--- /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 00000000000..43cab8dc4da
--- /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 00000000000..eba3111247f
--- /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 00000000000..dc2b94257f7
--- /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 <<EOF
+ cn = Name of your organization
+ ca
+ cert_signing_key
+ EOF
+ # certtool --generate-self-signed \
+ --load-privkey ca-key.pem
+ --template ca.info \
+ --outfile ca-cert.pem
+
+The ``ca`` keyword in the template sets the v3 basic constraints
+extension to indicate this certificate is for a CA, while
+``cert_signing_key`` sets the key usage extension to indicate this will
+be used for signing other keys. The generated ``ca-cert.pem`` file
+should be copied to all servers and clients wishing to utilize TLS
+support in the VNC server. The ``ca-key.pem`` must not be
+disclosed/copied anywhere except the host responsible for issuing
+certificates.
+
+.. _tls_005fgenerate_005fserver:
+
+Issuing server certificates
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Each server (or host) needs to be issued with a key and certificate.
+When connecting the certificate is sent to the client which validates it
+against the CA certificate. The core pieces of information for a server
+certificate are the hostnames and/or IP addresses that will be used by
+clients when connecting. The hostname / IP address that the client
+specifies when connecting will be validated against the hostname(s) and
+IP address(es) recorded in the server certificate, and if no match is
+found the client will close the connection.
+
+Thus it is recommended that the server certificate include both the
+fully qualified and unqualified hostnames. If the server will have
+permanently assigned IP address(es), and clients are likely to use them
+when connecting, they may also be included in the certificate. Both IPv4
+and IPv6 addresses are supported. Historically certificates only
+included 1 hostname in the ``CN`` field, however, usage of this field
+for validation is now deprecated. Instead modern TLS clients will
+validate against the Subject Alt Name extension data, which allows for
+multiple entries. In the future usage of the ``CN`` field may be
+discontinued entirely, so providing SAN extension data is strongly
+recommended.
+
+On the host holding the CA, create template files containing the
+information for each server, and use it to issue server certificates.
+
+::
+
+ # cat > server-hostNNN.info <<EOF
+ organization = Name of your organization
+ cn = hostNNN.foo.example.com
+ dns_name = hostNNN
+ dns_name = hostNNN.foo.example.com
+ ip_address = 10.0.1.87
+ ip_address = 192.8.0.92
+ ip_address = 2620:0:cafe::87
+ ip_address = 2001:24::92
+ tls_www_server
+ encryption_key
+ signing_key
+ EOF
+ # certtool --generate-privkey > 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 <<EOF
+ country = GB
+ state = London
+ locality = City Of London
+ organization = Name of your organization
+ cn = hostNNN.foo.example.com
+ tls_www_client
+ encryption_key
+ signing_key
+ EOF
+ # certtool --generate-privkey > 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 <<EOF
+ country = GB
+ state = London
+ locality = City Of London
+ organization = Name of your organization
+ cn = hostNNN.foo.example.com
+ dns_name = hostNNN
+ dns_name = hostNNN.foo.example.com
+ ip_address = 10.0.1.87
+ ip_address = 192.8.0.92
+ ip_address = 2620:0:cafe::87
+ ip_address = 2001:24::92
+ tls_www_server
+ tls_www_client
+ encryption_key
+ signing_key
+ EOF
+ # certtool --generate-privkey > 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 00000000000..ddfa828d74a
--- /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 <https://git.qemu.org/?p=qemu.git;a=blob_plain;f=docs/usb-storage.txt>`__
+ for details
+
+``usb-bot``
+ Bulk-only transport storage device, see
+ `usb-storage.txt <https://git.qemu.org/?p=qemu.git;a=blob_plain;f=docs/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 00000000000..b237b07330d
--- /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.
--
2.20.1
^ permalink raw reply related [flat|nested] 82+ messages in thread* Re: [PATCH v3 19/33] docs/system: convert Texinfo documentation to rST
2020-02-28 15:36 ` [PATCH v3 19/33] docs/system: convert Texinfo documentation " Peter Maydell
@ 2020-03-02 12:13 ` Alex Bennée
0 siblings, 0 replies; 82+ messages in thread
From: Alex Bennée @ 2020-03-02 12:13 UTC (permalink / raw)
To: Peter Maydell; +Cc: Paolo Bonzini, qemu-devel, Kashyap Chamarthy
Peter Maydell <peter.maydell@linaro.org> writes:
<snip>
>
> Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
> 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 <peter.maydell@linaro.org>
> Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
Reviewed-by: Alex Bennée <alex.bennee@linaro.org>
--
Alex Bennée
^ permalink raw reply [flat|nested] 82+ messages in thread
* [PATCH v3 20/33] hmp-commands.hx: Add rST documentation fragments
2020-02-28 15:35 [PATCH v3 00/33] Convert qemu-doc to rST Peter Maydell
` (18 preceding siblings ...)
2020-02-28 15:36 ` [PATCH v3 19/33] docs/system: convert Texinfo documentation " Peter Maydell
@ 2020-02-28 15:36 ` Peter Maydell
2020-03-02 12:16 ` Alex Bennée
2020-02-28 15:36 ` [PATCH v3 21/33] hmp-commands-info.hx: " Peter Maydell
` (15 subsequent siblings)
35 siblings, 1 reply; 82+ messages in thread
From: Peter Maydell @ 2020-02-28 15:36 UTC (permalink / raw)
To: qemu-devel; +Cc: Paolo Bonzini, Kashyap Chamarthy
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 <peter.maydell@linaro.org>
---
Makefile | 2 +-
docs/system/monitor.rst | 10 +-
hmp-commands.hx | 688 ++++++++++++++++++++++++++++++++++++++++
3 files changed, 698 insertions(+), 2 deletions(-)
diff --git a/Makefile b/Makefile
index f8642cd28a1..22427376b48 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 482f391f327..52b0f18cfec 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 dc23185de43..9aa59f52312 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",
--
2.20.1
^ permalink raw reply related [flat|nested] 82+ messages in thread* Re: [PATCH v3 20/33] hmp-commands.hx: Add rST documentation fragments
2020-02-28 15:36 ` [PATCH v3 20/33] hmp-commands.hx: Add rST documentation fragments Peter Maydell
@ 2020-03-02 12:16 ` Alex Bennée
0 siblings, 0 replies; 82+ messages in thread
From: Alex Bennée @ 2020-03-02 12:16 UTC (permalink / raw)
To: Peter Maydell; +Cc: Paolo Bonzini, qemu-devel, Kashyap Chamarthy
Peter Maydell <peter.maydell@linaro.org> writes:
> 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 <peter.maydell@linaro.org>
Reviewed-by: Alex Bennée <alex.bennee@linaro.org>
> ---
> Makefile | 2 +-
> docs/system/monitor.rst | 10 +-
> hmp-commands.hx | 688 ++++++++++++++++++++++++++++++++++++++++
> 3 files changed, 698 insertions(+), 2 deletions(-)
>
> diff --git a/Makefile b/Makefile
> index f8642cd28a1..22427376b48 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 482f391f327..52b0f18cfec 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 dc23185de43..9aa59f52312 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",
--
Alex Bennée
^ permalink raw reply [flat|nested] 82+ messages in thread
* [PATCH v3 21/33] hmp-commands-info.hx: Add rST documentation fragments
2020-02-28 15:35 [PATCH v3 00/33] Convert qemu-doc to rST Peter Maydell
` (19 preceding siblings ...)
2020-02-28 15:36 ` [PATCH v3 20/33] hmp-commands.hx: Add rST documentation fragments Peter Maydell
@ 2020-02-28 15:36 ` Peter Maydell
2020-03-02 12:16 ` Alex Bennée
2020-02-28 15:36 ` [PATCH v3 22/33] doc/scripts/hxtool.py: Strip trailing ':' from DEFHEADING/ARCHHEADING Peter Maydell
` (14 subsequent siblings)
35 siblings, 1 reply; 82+ messages in thread
From: Peter Maydell @ 2020-02-28 15:36 UTC (permalink / raw)
To: qemu-devel; +Cc: Paolo Bonzini, Kashyap Chamarthy
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 <peter.maydell@linaro.org>
---
Makefile | 2 +-
docs/system/monitor.rst | 4 +-
hmp-commands-info.hx | 271 ++++++++++++++++++++++++++++++++++++++++
3 files changed, 273 insertions(+), 4 deletions(-)
diff --git a/Makefile b/Makefile
index 22427376b48..98ef06ab8e8 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 52b0f18cfec..0bcd5da2164 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 257ee7d7a3f..1730f866cde 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
--
2.20.1
^ permalink raw reply related [flat|nested] 82+ messages in thread* Re: [PATCH v3 21/33] hmp-commands-info.hx: Add rST documentation fragments
2020-02-28 15:36 ` [PATCH v3 21/33] hmp-commands-info.hx: " Peter Maydell
@ 2020-03-02 12:16 ` Alex Bennée
0 siblings, 0 replies; 82+ messages in thread
From: Alex Bennée @ 2020-03-02 12:16 UTC (permalink / raw)
To: Peter Maydell; +Cc: Paolo Bonzini, qemu-devel, Kashyap Chamarthy
Peter Maydell <peter.maydell@linaro.org> writes:
> 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 <peter.maydell@linaro.org>
Reviewed-by: Alex Bennée <alex.bennee@linaro.org>
> ---
> Makefile | 2 +-
> docs/system/monitor.rst | 4 +-
> hmp-commands-info.hx | 271 ++++++++++++++++++++++++++++++++++++++++
> 3 files changed, 273 insertions(+), 4 deletions(-)
>
> diff --git a/Makefile b/Makefile
> index 22427376b48..98ef06ab8e8 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 52b0f18cfec..0bcd5da2164 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 257ee7d7a3f..1730f866cde 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
--
Alex Bennée
^ permalink raw reply [flat|nested] 82+ messages in thread
* [PATCH v3 22/33] doc/scripts/hxtool.py: Strip trailing ':' from DEFHEADING/ARCHHEADING
2020-02-28 15:35 [PATCH v3 00/33] Convert qemu-doc to rST Peter Maydell
` (20 preceding siblings ...)
2020-02-28 15:36 ` [PATCH v3 21/33] hmp-commands-info.hx: " Peter Maydell
@ 2020-02-28 15:36 ` Peter Maydell
2020-03-02 12:17 ` Alex Bennée
2020-02-28 15:36 ` [PATCH v3 23/33] docs: Roll semihosting option information into qemu-options.hx Peter Maydell
` (13 subsequent siblings)
35 siblings, 1 reply; 82+ messages in thread
From: Peter Maydell @ 2020-02-28 15:36 UTC (permalink / raw)
To: qemu-devel; +Cc: Paolo Bonzini, Kashyap Chamarthy
In hxtool files, section headings defined with the DEFHEADING
and ARCHHEADING macros have a trailing ':'
DEFHEADING(Standard options:)
This is for the benefit of the --help output. For consistency
with the rest of the rST documentation, strip any trailing ':'
when we construct headings with the Sphinx hxtool extension.
This makes the table of contents look neater.
This only affects generation of documentation from qemu-options.hx,
which we will start doing in a later commit.
Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
---
docs/sphinx/hxtool.py | 10 ++++++----
1 file changed, 6 insertions(+), 4 deletions(-)
diff --git a/docs/sphinx/hxtool.py b/docs/sphinx/hxtool.py
index 5d6736f3002..7dd223fe362 100644
--- a/docs/sphinx/hxtool.py
+++ b/docs/sphinx/hxtool.py
@@ -60,8 +60,9 @@ def parse_defheading(file, lnum, line):
# empty we ignore the directive -- these are used only to add
# blank lines in the plain-text content of the --help output.
#
- # Return the heading text
- match = re.match(r'DEFHEADING\((.*)\)', line)
+ # Return the heading text. We strip out any trailing ':' for
+ # consistency with other headings in the rST documentation.
+ match = re.match(r'DEFHEADING\((.*?):?\)', line)
if match is None:
serror(file, lnum, "Invalid DEFHEADING line")
return match.group(1)
@@ -72,8 +73,9 @@ def parse_archheading(file, lnum, line):
# though note that the 'some string' could be the empty string.
# As with DEFHEADING, empty string ARCHHEADINGs will be ignored.
#
- # Return the heading text
- match = re.match(r'ARCHHEADING\((.*),.*\)', line)
+ # Return the heading text. We strip out any trailing ':' for
+ # consistency with other headings in the rST documentation.
+ match = re.match(r'ARCHHEADING\((.*?):?,.*\)', line)
if match is None:
serror(file, lnum, "Invalid ARCHHEADING line")
return match.group(1)
--
2.20.1
^ permalink raw reply related [flat|nested] 82+ messages in thread* Re: [PATCH v3 22/33] doc/scripts/hxtool.py: Strip trailing ':' from DEFHEADING/ARCHHEADING
2020-02-28 15:36 ` [PATCH v3 22/33] doc/scripts/hxtool.py: Strip trailing ':' from DEFHEADING/ARCHHEADING Peter Maydell
@ 2020-03-02 12:17 ` Alex Bennée
0 siblings, 0 replies; 82+ messages in thread
From: Alex Bennée @ 2020-03-02 12:17 UTC (permalink / raw)
To: Peter Maydell; +Cc: Paolo Bonzini, qemu-devel, Kashyap Chamarthy
Peter Maydell <peter.maydell@linaro.org> writes:
> In hxtool files, section headings defined with the DEFHEADING
> and ARCHHEADING macros have a trailing ':'
> DEFHEADING(Standard options:)
>
> This is for the benefit of the --help output. For consistency
> with the rest of the rST documentation, strip any trailing ':'
> when we construct headings with the Sphinx hxtool extension.
> This makes the table of contents look neater.
>
> This only affects generation of documentation from qemu-options.hx,
> which we will start doing in a later commit.
>
> Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
Reviewed-by: Alex Bennée <alex.bennee@linaro.org>
> ---
> docs/sphinx/hxtool.py | 10 ++++++----
> 1 file changed, 6 insertions(+), 4 deletions(-)
>
> diff --git a/docs/sphinx/hxtool.py b/docs/sphinx/hxtool.py
> index 5d6736f3002..7dd223fe362 100644
> --- a/docs/sphinx/hxtool.py
> +++ b/docs/sphinx/hxtool.py
> @@ -60,8 +60,9 @@ def parse_defheading(file, lnum, line):
> # empty we ignore the directive -- these are used only to add
> # blank lines in the plain-text content of the --help output.
> #
> - # Return the heading text
> - match = re.match(r'DEFHEADING\((.*)\)', line)
> + # Return the heading text. We strip out any trailing ':' for
> + # consistency with other headings in the rST documentation.
> + match = re.match(r'DEFHEADING\((.*?):?\)', line)
> if match is None:
> serror(file, lnum, "Invalid DEFHEADING line")
> return match.group(1)
> @@ -72,8 +73,9 @@ def parse_archheading(file, lnum, line):
> # though note that the 'some string' could be the empty string.
> # As with DEFHEADING, empty string ARCHHEADINGs will be ignored.
> #
> - # Return the heading text
> - match = re.match(r'ARCHHEADING\((.*),.*\)', line)
> + # Return the heading text. We strip out any trailing ':' for
> + # consistency with other headings in the rST documentation.
> + match = re.match(r'ARCHHEADING\((.*?):?,.*\)', line)
> if match is None:
> serror(file, lnum, "Invalid ARCHHEADING line")
> return match.group(1)
--
Alex Bennée
^ permalink raw reply [flat|nested] 82+ messages in thread
* [PATCH v3 23/33] docs: Roll semihosting option information into qemu-options.hx
2020-02-28 15:35 [PATCH v3 00/33] Convert qemu-doc to rST Peter Maydell
` (21 preceding siblings ...)
2020-02-28 15:36 ` [PATCH v3 22/33] doc/scripts/hxtool.py: Strip trailing ':' from DEFHEADING/ARCHHEADING Peter Maydell
@ 2020-02-28 15:36 ` Peter Maydell
2020-03-02 12:18 ` Alex Bennée
2020-02-28 15:36 ` [PATCH v3 24/33] docs: Roll -prom-env and -g target-specific info " Peter Maydell
` (12 subsequent siblings)
35 siblings, 1 reply; 82+ messages in thread
From: Peter Maydell @ 2020-02-28 15:36 UTC (permalink / raw)
To: qemu-devel; +Cc: Paolo Bonzini, Kashyap Chamarthy
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 <peter.maydell@linaro.org>
---
Yes, it would in theory make sense to do this before generating
the rst from the texi docs, but I didn't realize this was a
good idea until well after Paolo had done that part.
---
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(-)
diff --git a/docs/system/target-arm.rst b/docs/system/target-arm.rst
index 0490be55871..d2a3b44ce88 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 c56b5f6ebfe..eb80dd35f0b 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 50b7dd9d639..d28d3b92e5e 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 a77b19ea0f1..dcce7bc8c56 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 43cab8dc4da..8d703ad769e 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 40327de6fa7..1e6c04dccd6 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 5fbfa2797cb..4bc8048f60b 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})
--
2.20.1
^ permalink raw reply related [flat|nested] 82+ messages in thread* Re: [PATCH v3 23/33] docs: Roll semihosting option information into qemu-options.hx
2020-02-28 15:36 ` [PATCH v3 23/33] docs: Roll semihosting option information into qemu-options.hx Peter Maydell
@ 2020-03-02 12:18 ` Alex Bennée
0 siblings, 0 replies; 82+ messages in thread
From: Alex Bennée @ 2020-03-02 12:18 UTC (permalink / raw)
To: Peter Maydell; +Cc: Paolo Bonzini, qemu-devel, Kashyap Chamarthy
Peter Maydell <peter.maydell@linaro.org> writes:
> 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 <peter.maydell@linaro.org>
Reviewed-by: Alex Bennée <alex.bennee@linaro.org>
> ---
> Yes, it would in theory make sense to do this before generating
> the rst from the texi docs, but I didn't realize this was a
> good idea until well after Paolo had done that part.
> ---
> 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(-)
>
> diff --git a/docs/system/target-arm.rst b/docs/system/target-arm.rst
> index 0490be55871..d2a3b44ce88 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 c56b5f6ebfe..eb80dd35f0b 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 50b7dd9d639..d28d3b92e5e 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 a77b19ea0f1..dcce7bc8c56 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 43cab8dc4da..8d703ad769e 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 40327de6fa7..1e6c04dccd6 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 5fbfa2797cb..4bc8048f60b 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})
--
Alex Bennée
^ permalink raw reply [flat|nested] 82+ messages in thread
* [PATCH v3 24/33] docs: Roll -prom-env and -g target-specific info into qemu-options.hx
2020-02-28 15:35 [PATCH v3 00/33] Convert qemu-doc to rST Peter Maydell
` (22 preceding siblings ...)
2020-02-28 15:36 ` [PATCH v3 23/33] docs: Roll semihosting option information into qemu-options.hx Peter Maydell
@ 2020-02-28 15:36 ` Peter Maydell
2020-03-02 12:19 ` Alex Bennée
2020-02-28 15:36 ` [PATCH v3 25/33] scripts/hxtool-conv: Archive script used in qemu-options.hx conversion Peter Maydell
` (11 subsequent siblings)
35 siblings, 1 reply; 82+ messages in thread
From: Peter Maydell @ 2020-02-28 15:36 UTC (permalink / raw)
To: qemu-devel; +Cc: Paolo Bonzini, Kashyap Chamarthy
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 <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(-)
diff --git a/docs/system/target-ppc.rst b/docs/system/target-ppc.rst
index 43fadf3c00b..a2f04c533c2 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 55f98f65b12..5c83d4f68e7 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 589c88d1756..b55f8d09e9c 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 7748001f734..99fbf820b42 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 ca76ba9c488..97e334b9308 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 4db4ca3842b..d381d3af719 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 4bc8048f60b..3b230a17164 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",
--
2.20.1
^ permalink raw reply related [flat|nested] 82+ messages in thread* Re: [PATCH v3 24/33] docs: Roll -prom-env and -g target-specific info into qemu-options.hx
2020-02-28 15:36 ` [PATCH v3 24/33] docs: Roll -prom-env and -g target-specific info " Peter Maydell
@ 2020-03-02 12:19 ` Alex Bennée
0 siblings, 0 replies; 82+ messages in thread
From: Alex Bennée @ 2020-03-02 12:19 UTC (permalink / raw)
To: Peter Maydell; +Cc: Paolo Bonzini, qemu-devel, Kashyap Chamarthy
Peter Maydell <peter.maydell@linaro.org> writes:
> 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 <peter.maydell@linaro.org>
Reviewed-by: Alex Bennée <alex.bennee@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(-)
>
> diff --git a/docs/system/target-ppc.rst b/docs/system/target-ppc.rst
> index 43fadf3c00b..a2f04c533c2 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 55f98f65b12..5c83d4f68e7 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 589c88d1756..b55f8d09e9c 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 7748001f734..99fbf820b42 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 ca76ba9c488..97e334b9308 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 4db4ca3842b..d381d3af719 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 4bc8048f60b..3b230a17164 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",
--
Alex Bennée
^ permalink raw reply [flat|nested] 82+ messages in thread
* [PATCH v3 25/33] scripts/hxtool-conv: Archive script used in qemu-options.hx conversion
2020-02-28 15:35 [PATCH v3 00/33] Convert qemu-doc to rST Peter Maydell
` (23 preceding siblings ...)
2020-02-28 15:36 ` [PATCH v3 24/33] docs: Roll -prom-env and -g target-specific info " Peter Maydell
@ 2020-02-28 15:36 ` Peter Maydell
2020-03-02 12:19 ` Alex Bennée
2020-02-28 15:36 ` [PATCH v3 26/33] qemu-options.hx: Add rST documentation fragments Peter Maydell
` (10 subsequent siblings)
35 siblings, 1 reply; 82+ messages in thread
From: Peter Maydell @ 2020-02-28 15:36 UTC (permalink / raw)
To: qemu-devel; +Cc: Paolo Bonzini, Kashyap Chamarthy
This commit archives the perl script used to do conversion of the
STEXI/ETEXI blocks in qemu-options.hx. (The other .hx files were
manually converted, but qemu-options.hx is complicated enough that
I felt I needed some scripting.)
Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
---
Please don't critique the script, it is purely for a one-off
conversion job, and I then did manual fixups on the output
to get the changes in the following patch. I merely felt it
was potentially useful to archive a copy of the mechanism used.
Or we could drop this patch if that's not needed.
---
scripts/hxtool-conv.pl | 137 +++++++++++++++++++++++++++++++++++++++++
1 file changed, 137 insertions(+)
create mode 100755 scripts/hxtool-conv.pl
diff --git a/scripts/hxtool-conv.pl b/scripts/hxtool-conv.pl
new file mode 100755
index 00000000000..eede40b3462
--- /dev/null
+++ b/scripts/hxtool-conv.pl
@@ -0,0 +1,137 @@
+#!/usr/bin/perl -w
+#
+# Script to convert .hx file STEXI/ETEXI blocks to SRST/ERST
+#
+# Copyright (C) 2020 Linaro
+#
+# This work is licensed under the terms of the GNU GPL, version 2 or
+# (at your option) any later version. See the COPYING file in the
+# top-level directory.
+
+# This script was only ever intended as a one-off conversion operation.
+# Please excuse the places where it is a bit hacky.
+# Some manual intervention after the conversion is expected, as are
+# some warnings from makeinfo.
+# Warning: this script is not idempotent: don't try to run it on
+# a .hx file that already has SRST/ERST sections.
+
+# Expected usage:
+# scripts/hxtool-conv.pl file.hx > file.hx.new
+
+use utf8;
+
+my $reading_texi = 0;
+my $texiblock = '';
+my @tables = ();
+
+sub update_tables($) {
+ my ($texi) = @_;
+ # Update our list of open table directives: every @table
+ # line in the texi fragment is added to the list, and every
+ # @end table line means we remove an entry from the list.
+ # If this fragment had a completely self contained table with
+ # both the @table and @end table lines, this will be a no-op.
+ foreach (split(/\n/, $texi)) {
+ push @tables, $_ if /^\@table/;
+ pop @tables if /^\@end table/;
+ }
+}
+
+sub only_table_directives($) {
+ # Return true if every line in the fragment is a start or end table directive
+ my ($texi) = @_;
+ foreach (split(/\n/, $texi)) {
+ return 0 unless /^\@table/ or /^\@end table/;
+ }
+ return 1;
+}
+
+sub output_rstblock($) {
+ # Write the output to /tmp/frag.texi, wrapped in whatever current @table
+ # lines we need.
+ my ($texi) = @_;
+
+ # As a special case, if this fragment is only table directives and
+ # nothing else, update our set of open table directives but otherwise
+ # ignore it. This avoids emitting an empty SRST/ERST block.
+ if (only_table_directives($texi)) {
+ update_tables($texi);
+ return;
+ }
+
+ open(my $fragfh, '>', '/tmp/frag.texi');
+ # First output the currently active set of open table directives
+ print $fragfh join("\n", @tables);
+ # Next, update our list of open table directives.
+ # We need to do this before we emit the closing table directives
+ # so that we emit the right number if this fragment had an
+ # unbalanced set of directives.
+ update_tables($texi);
+ # Then emit the texi fragment itself.
+ print $fragfh "\n$texi\n";
+ # Finally, add the necessary closing table directives.
+ print $fragfh "\@end table\n" x scalar @tables;
+ close $fragfh;
+
+ # Now invoke makeinfo/pandoc on it and slurp the results into a string
+ open(my $fh, '-|', "makeinfo --force -o - --docbook "
+ . "-D 'qemu_system_x86 QEMU_SYSTEM_X86_MACRO' "
+ . "-D 'qemu_system QEMU_SYSTEM_MACRO' /tmp/frag.texi "
+ . " | pandoc -f docbook -t rst")
+ or die "can't start makeinfo/pandoc: $!";
+
+ binmode $fh, ':encoding(utf8)';
+
+ print "SRST\n";
+
+ # Slurp the whole thing into a string so we can do multiline
+ # string matches on it.
+ my $rst = do {
+ local $/ = undef;
+ <$fh>;
+ };
+ $rst =~ s/^- − /- /gm;
+ $rst =~ s/“/"/gm;
+ $rst =~ s/”/"/gm;
+ $rst =~ s/‘/'/gm;
+ $rst =~ s/’/'/gm;
+ $rst =~ s/QEMU_SYSTEM_MACRO/|qemu_system|/g;
+ $rst =~ s/QEMU_SYSTEM_X86_MACRO/|qemu_system_x86|/g;
+ $rst =~ s/(?=::\n\n +\|qemu)/.. parsed-literal/g;
+ $rst =~ s/:\n\n::$/::/gm;
+
+ # Fix up the invalid reference format makeinfo/pandoc emit:
+ # `Some string here <#anchorname>`__
+ # should be:
+ # :ref:`anchorname`
+ $rst =~ s/\`[^<`]+\<\#([^>]+)\>\`__/:ref:`$1`/gm;
+ print $rst;
+
+ close $fh or die "error on close: $!";
+ print "ERST\n";
+}
+
+# Read the whole .hx input file.
+while (<>) {
+ # Always print the current line
+ print;
+ if (/STEXI/) {
+ $reading_texi = 1;
+ $texiblock = '';
+ next;
+ }
+ if (/ETEXI/) {
+ $reading_texi = 0;
+ # dump RST version of block
+ output_rstblock($texiblock);
+ next;
+ }
+ if ($reading_texi) {
+ # Accumulate the texi into a string
+ # but drop findex entries as they will confuse makeinfo
+ next if /^\@findex/;
+ $texiblock .= $_;
+ }
+}
+
+die "Unexpectedly still in texi block at EOF" if $reading_texi;
--
2.20.1
^ permalink raw reply related [flat|nested] 82+ messages in thread* Re: [PATCH v3 25/33] scripts/hxtool-conv: Archive script used in qemu-options.hx conversion
2020-02-28 15:36 ` [PATCH v3 25/33] scripts/hxtool-conv: Archive script used in qemu-options.hx conversion Peter Maydell
@ 2020-03-02 12:19 ` Alex Bennée
0 siblings, 0 replies; 82+ messages in thread
From: Alex Bennée @ 2020-03-02 12:19 UTC (permalink / raw)
To: Peter Maydell; +Cc: Paolo Bonzini, qemu-devel, Kashyap Chamarthy
Peter Maydell <peter.maydell@linaro.org> writes:
> This commit archives the perl script used to do conversion of the
> STEXI/ETEXI blocks in qemu-options.hx. (The other .hx files were
> manually converted, but qemu-options.hx is complicated enough that
> I felt I needed some scripting.)
>
> Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
Reviewed-by: Alex Bennée <alex.bennee@linaro.org>
> ---
> Please don't critique the script, it is purely for a one-off
> conversion job, and I then did manual fixups on the output
> to get the changes in the following patch. I merely felt it
> was potentially useful to archive a copy of the mechanism used.
> Or we could drop this patch if that's not needed.
> ---
> scripts/hxtool-conv.pl | 137 +++++++++++++++++++++++++++++++++++++++++
> 1 file changed, 137 insertions(+)
> create mode 100755 scripts/hxtool-conv.pl
>
> diff --git a/scripts/hxtool-conv.pl b/scripts/hxtool-conv.pl
> new file mode 100755
> index 00000000000..eede40b3462
> --- /dev/null
> +++ b/scripts/hxtool-conv.pl
> @@ -0,0 +1,137 @@
> +#!/usr/bin/perl -w
> +#
> +# Script to convert .hx file STEXI/ETEXI blocks to SRST/ERST
> +#
> +# Copyright (C) 2020 Linaro
> +#
> +# This work is licensed under the terms of the GNU GPL, version 2 or
> +# (at your option) any later version. See the COPYING file in the
> +# top-level directory.
> +
> +# This script was only ever intended as a one-off conversion operation.
> +# Please excuse the places where it is a bit hacky.
> +# Some manual intervention after the conversion is expected, as are
> +# some warnings from makeinfo.
> +# Warning: this script is not idempotent: don't try to run it on
> +# a .hx file that already has SRST/ERST sections.
> +
> +# Expected usage:
> +# scripts/hxtool-conv.pl file.hx > file.hx.new
> +
> +use utf8;
> +
> +my $reading_texi = 0;
> +my $texiblock = '';
> +my @tables = ();
> +
> +sub update_tables($) {
> + my ($texi) = @_;
> + # Update our list of open table directives: every @table
> + # line in the texi fragment is added to the list, and every
> + # @end table line means we remove an entry from the list.
> + # If this fragment had a completely self contained table with
> + # both the @table and @end table lines, this will be a no-op.
> + foreach (split(/\n/, $texi)) {
> + push @tables, $_ if /^\@table/;
> + pop @tables if /^\@end table/;
> + }
> +}
> +
> +sub only_table_directives($) {
> + # Return true if every line in the fragment is a start or end table directive
> + my ($texi) = @_;
> + foreach (split(/\n/, $texi)) {
> + return 0 unless /^\@table/ or /^\@end table/;
> + }
> + return 1;
> +}
> +
> +sub output_rstblock($) {
> + # Write the output to /tmp/frag.texi, wrapped in whatever current @table
> + # lines we need.
> + my ($texi) = @_;
> +
> + # As a special case, if this fragment is only table directives and
> + # nothing else, update our set of open table directives but otherwise
> + # ignore it. This avoids emitting an empty SRST/ERST block.
> + if (only_table_directives($texi)) {
> + update_tables($texi);
> + return;
> + }
> +
> + open(my $fragfh, '>', '/tmp/frag.texi');
> + # First output the currently active set of open table directives
> + print $fragfh join("\n", @tables);
> + # Next, update our list of open table directives.
> + # We need to do this before we emit the closing table directives
> + # so that we emit the right number if this fragment had an
> + # unbalanced set of directives.
> + update_tables($texi);
> + # Then emit the texi fragment itself.
> + print $fragfh "\n$texi\n";
> + # Finally, add the necessary closing table directives.
> + print $fragfh "\@end table\n" x scalar @tables;
> + close $fragfh;
> +
> + # Now invoke makeinfo/pandoc on it and slurp the results into a string
> + open(my $fh, '-|', "makeinfo --force -o - --docbook "
> + . "-D 'qemu_system_x86 QEMU_SYSTEM_X86_MACRO' "
> + . "-D 'qemu_system QEMU_SYSTEM_MACRO' /tmp/frag.texi "
> + . " | pandoc -f docbook -t rst")
> + or die "can't start makeinfo/pandoc: $!";
> +
> + binmode $fh, ':encoding(utf8)';
> +
> + print "SRST\n";
> +
> + # Slurp the whole thing into a string so we can do multiline
> + # string matches on it.
> + my $rst = do {
> + local $/ = undef;
> + <$fh>;
> + };
> + $rst =~ s/^- − /- /gm;
> + $rst =~ s/“/"/gm;
> + $rst =~ s/”/"/gm;
> + $rst =~ s/‘/'/gm;
> + $rst =~ s/’/'/gm;
> + $rst =~ s/QEMU_SYSTEM_MACRO/|qemu_system|/g;
> + $rst =~ s/QEMU_SYSTEM_X86_MACRO/|qemu_system_x86|/g;
> + $rst =~ s/(?=::\n\n +\|qemu)/.. parsed-literal/g;
> + $rst =~ s/:\n\n::$/::/gm;
> +
> + # Fix up the invalid reference format makeinfo/pandoc emit:
> + # `Some string here <#anchorname>`__
> + # should be:
> + # :ref:`anchorname`
> + $rst =~ s/\`[^<`]+\<\#([^>]+)\>\`__/:ref:`$1`/gm;
> + print $rst;
> +
> + close $fh or die "error on close: $!";
> + print "ERST\n";
> +}
> +
> +# Read the whole .hx input file.
> +while (<>) {
> + # Always print the current line
> + print;
> + if (/STEXI/) {
> + $reading_texi = 1;
> + $texiblock = '';
> + next;
> + }
> + if (/ETEXI/) {
> + $reading_texi = 0;
> + # dump RST version of block
> + output_rstblock($texiblock);
> + next;
> + }
> + if ($reading_texi) {
> + # Accumulate the texi into a string
> + # but drop findex entries as they will confuse makeinfo
> + next if /^\@findex/;
> + $texiblock .= $_;
> + }
> +}
> +
> +die "Unexpectedly still in texi block at EOF" if $reading_texi;
--
Alex Bennée
^ permalink raw reply [flat|nested] 82+ messages in thread
* [PATCH v3 26/33] qemu-options.hx: Add rST documentation fragments
2020-02-28 15:35 [PATCH v3 00/33] Convert qemu-doc to rST Peter Maydell
` (24 preceding siblings ...)
2020-02-28 15:36 ` [PATCH v3 25/33] scripts/hxtool-conv: Archive script used in qemu-options.hx conversion Peter Maydell
@ 2020-02-28 15:36 ` Peter Maydell
2020-03-02 12:20 ` Alex Bennée
2020-02-28 15:36 ` [PATCH v3 27/33] qemu-options.hx: Fix up the autogenerated rST Peter Maydell
` (9 subsequent siblings)
35 siblings, 1 reply; 82+ messages in thread
From: Peter Maydell @ 2020-02-28 15:36 UTC (permalink / raw)
To: qemu-devel; +Cc: Paolo Bonzini, Kashyap Chamarthy
[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #1: Type: text/plain; charset=UTF-8, Size: 200379 bytes --]
Add the rST versions of the documentation fragments to qemu-options.hx.
This is entirely autogenerated using scripts/hxtool-conv.pl.
The result is not quite valid rST in all places; the following
commit will have the manual adjustments needed.
Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
---
qemu-options.hx | 3999 +++++++++++++++++++++++++++++++++++++++++++++++
1 file changed, 3999 insertions(+)
diff --git a/qemu-options.hx b/qemu-options.hx
index 3b230a17164..043e425b61e 100644
--- a/qemu-options.hx
+++ b/qemu-options.hx
@@ -18,6 +18,10 @@ STEXI
@findex -h
Display help and exit
ETEXI
+SRST
+``-h``
+ Display help and exit
+ERST
DEF("version", 0, QEMU_OPTION_version,
"-version display version information and exit\n", QEMU_ARCH_ALL)
@@ -26,6 +30,10 @@ STEXI
@findex -version
Display version information and exit
ETEXI
+SRST
+``-version``
+ Display version information and exit
+ERST
DEF("machine", HAS_ARG, QEMU_OPTION_machine, \
"-machine [type=]name[,prop[=value][,...]]\n"
@@ -100,6 +108,73 @@ Enables or disables ACPI Heterogeneous Memory Attribute Table (HMAT) support.
The default is off.
@end table
ETEXI
+SRST
+``-machine [type=]name[,prop=value[,...]]``
+ Select the emulated machine by name. Use ``-machine help`` to list
+ available machines.
+
+ For architectures which aim to support live migration compatibility
+ across releases, each release will introduce a new versioned machine
+ type. For example, the 2.8.0 release introduced machine types
+ "pc-i440fx-2.8" and "pc-q35-2.8" for the x86\_64/i686 architectures.
+
+ To allow live migration of guests from QEMU version 2.8.0, to QEMU
+ version 2.9.0, the 2.9.0 version must support the "pc-i440fx-2.8"
+ and "pc-q35-2.8" machines too. To allow users live migrating VMs to
+ skip multiple intermediate releases when upgrading, new releases of
+ QEMU will support machine types from many previous versions.
+
+ Supported machine properties are:
+
+ ``accel=accels1[:accels2[:...]]``
+ This is used to enable an accelerator. Depending on the target
+ architecture, kvm, xen, hax, hvf, whpx or tcg can be available.
+ By default, tcg is used. If there is more than one accelerator
+ specified, the next one is used if the previous one fails to
+ initialize.
+
+ ``vmport=on|off|auto``
+ Enables emulation of VMWare IO port, for vmmouse etc. auto says
+ to select the value based on accel. For accel=xen the default is
+ off otherwise the default is on.
+
+ ``dump-guest-core=on|off``
+ Include guest memory in a core dump. The default is on.
+
+ ``mem-merge=on|off``
+ Enables or disables memory merge support. This feature, when
+ supported by the host, de-duplicates identical memory pages
+ among VMs instances (enabled by default).
+
+ ``aes-key-wrap=on|off``
+ Enables or disables AES key wrapping support on s390-ccw hosts.
+ This feature controls whether AES wrapping keys will be created
+ to allow execution of AES cryptographic functions. The default
+ is on.
+
+ ``dea-key-wrap=on|off``
+ Enables or disables DEA key wrapping support on s390-ccw hosts.
+ This feature controls whether DEA wrapping keys will be created
+ to allow execution of DEA cryptographic functions. The default
+ is on.
+
+ ``nvdimm=on|off``
+ Enables or disables NVDIMM support. The default is off.
+
+ ``enforce-config-section=on|off``
+ If ``enforce-config-section`` is set to on, force migration code
+ to send configuration section even if the machine-type sets the
+ ``migration.send-configuration`` property to off. NOTE: this
+ parameter is deprecated. Please use ``-global``
+ ``migration.send-configuration``\ =on\|off instead.
+
+ ``memory-encryption=``
+ Memory encryption object to use. The default is none.
+
+ ``hmat=on|off``
+ Enables or disables ACPI Heterogeneous Memory Attribute Table
+ (HMAT) support. The default is off.
+ERST
HXCOMM Deprecated by -machine
DEF("M", HAS_ARG, QEMU_OPTION_M, "", QEMU_ARCH_ALL)
@@ -111,6 +186,11 @@ STEXI
@findex -cpu
Select CPU model (@code{-cpu help} for list and additional feature selection)
ETEXI
+SRST
+``-cpu model``
+ Select CPU model (``-cpu help`` for list and additional feature
+ selection)
+ERST
DEF("accel", HAS_ARG, QEMU_OPTION_accel,
"-accel [accel=]accelerator[,prop[=value][,...]]\n"
@@ -147,6 +227,40 @@ is to enable multi-threading where both the back-end and front-ends support it a
no incompatible TCG features have been enabled (e.g. icount/replay).
@end table
ETEXI
+SRST
+``-accel name[,prop=value[,...]]``
+ This is used to enable an accelerator. Depending on the target
+ architecture, kvm, xen, hax, hvf, whpx or tcg can be available. By
+ default, tcg is used. If there is more than one accelerator
+ specified, the next one is used if the previous one fails to
+ initialize.
+
+ ``igd-passthru=on|off``
+ When Xen is in use, this option controls whether Intel
+ integrated graphics devices can be passed through to the guest
+ (default=off)
+
+ ``kernel-irqchip=on|off|split``
+ Controls KVM in-kernel irqchip support. The default is full
+ acceleration of the interrupt controllers. On x86, split irqchip
+ reduces the kernel attack surface, at a performance cost for
+ non-MSI interrupts. Disabling the in-kernel irqchip completely
+ is not recommended except for debugging purposes.
+
+ ``kvm-shadow-mem=size``
+ Defines the size of the KVM shadow MMU.
+
+ ``tb-size=n``
+ Controls the size (in MiB) of the TCG translation block cache.
+
+ ``thread=single|multi``
+ Controls number of TCG threads. When the TCG is multi-threaded
+ there will be one thread per vCPU therefor taking advantage of
+ additional host cores. The default is to enable multi-threading
+ where both the back-end and front-ends support it and no
+ incompatible TCG features have been enabled (e.g.
+ icount/replay).
+ERST
DEF("smp", HAS_ARG, QEMU_OPTION_smp,
"-smp [cpus=]n[,maxcpus=cpus][,cores=cores][,threads=threads][,dies=dies][,sockets=sockets]\n"
@@ -170,6 +284,17 @@ per cores, the number of @var{dies} per packages and the total number of
If any on the three values is given, the total number of CPUs @var{n} can be omitted.
@var{maxcpus} specifies the maximum number of hotpluggable CPUs.
ETEXI
+SRST
+``-smp [cpus=]n[,cores=cores][,threads=threads][,dies=dies][,sockets=sockets][,maxcpus=maxcpus]``
+ Simulate an SMP system with n CPUs. On the PC target, up to 255 CPUs
+ are supported. On Sparc32 target, Linux limits the number of usable
+ CPUs to 4. For the PC target, the number of cores per die, the
+ number of threads per cores, the number of dies per packages and the
+ total number of sockets can be specified. Missing values will be
+ computed. If any on the three values is given, the total number of
+ CPUs n can be omitted. maxcpus specifies the maximum number of
+ hotpluggable CPUs.
+ERST
DEF("numa", HAS_ARG, QEMU_OPTION_numa,
"-numa node[,mem=size][,cpus=firstcpu[-lastcpu]][,nodeid=node][,initiator=node]\n"
@@ -322,6 +447,152 @@ cache, size is 10KB, policy is write-back, the cache Line size is 8 bytes:
@end example
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]``
+ 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.
+
+ Legacy VCPU assignment uses '\ ``cpus``\ ' option where firstcpu and
+ lastcpu are CPU indexes. Each '\ ``cpus``\ ' option represent a
+ contiguous range of CPU indexes (or a single VCPU if lastcpu is
+ omitted). A non-contiguous set of VCPUs can be represented by
+ providing multiple '\ ``cpus``\ ' options. If '\ ``cpus``\ ' is
+ omitted on all nodes, VCPUs are automatically split between them.
+
+ For example, the following option assigns VCPUs 0, 1, 2 and 5 to a
+ NUMA node:
+
+ ::
+
+ -numa node,cpus=0-2,cpus=5
+
+ '\ ``cpu``\ ' option is a new alternative to '\ ``cpus``\ ' option
+ which uses '\ ``socket-id|core-id|thread-id``\ ' properties to
+ assign CPU objects to a node using topology layout properties of
+ CPU. The set of properties is machine specific, and depends on used
+ machine type/'\ ``smp``\ ' options. It could be queried with
+ '\ ``hotpluggable-cpus``\ ' monitor command. '\ ``node-id``\ '
+ property specifies node to which CPU object will be assigned, it's
+ required for node to be declared with '\ ``node``\ ' option before
+ it's used with '\ ``cpu``\ ' option.
+
+ For example:
+
+ ::
+
+ -M pc \
+ -smp 1,sockets=2,maxcpus=2 \
+ -numa node,nodeid=0 -numa node,nodeid=1 \
+ -numa cpu,node-id=0,socket-id=0 -numa cpu,node-id=1,socket-id=1
+
+ '\ ``mem``\ ' assigns a given RAM amount to a node. '\ ``memdev``\ '
+ assigns RAM from a given memory backend device to a node. If
+ '\ ``mem``\ ' and '\ ``memdev``\ ' are omitted in all nodes, RAM is
+ split equally between them.
+
+ '\ ``mem``\ ' and '\ ``memdev``\ ' are mutually exclusive.
+ Furthermore, if one node uses '\ ``memdev``\ ', all of them have to
+ use it.
+
+ '\ ``initiator``\ ' is an additional option that points to an
+ initiator NUMA node that has best performance (the lowest latency or
+ largest bandwidth) to this NUMA node. Note that this option can be
+ set only when the machine property 'hmat' is set to 'on'.
+
+ Following example creates a machine with 2 NUMA nodes, node 0 has
+ CPU. node 1 has only memory, and its initiator is node 0. Note that
+ because node 0 has CPU, by default the initiator of node 0 is itself
+ and must be itself.
+
+ ::
+
+ -machine hmat=on \
+ -m 2G,slots=2,maxmem=4G \
+ -object memory-backend-ram,size=1G,id=m0 \
+ -object memory-backend-ram,size=1G,id=m1 \
+ -numa node,nodeid=0,memdev=m0 \
+ -numa node,nodeid=1,memdev=m1,initiator=0 \
+ -smp 2,sockets=2,maxcpus=2 \
+ -numa cpu,node-id=0,socket-id=0 \
+ -numa cpu,node-id=0,socket-id=1
+
+ source and destination are NUMA node IDs. distance is the NUMA
+ distance from source to destination. The distance from a node to
+ itself is always 10. If any pair of nodes is given a distance, then
+ all pairs must be given distances. Although, when distances are only
+ given in one direction for each pair of nodes, then the distances in
+ the opposite directions are assumed to be the same. If, however, an
+ asymmetrical pair of distances is given for even one node pair, then
+ all node pairs must be provided distance values for both directions,
+ even when they are symmetrical. When a node is unreachable from
+ another node, set the pair's distance to 255.
+
+ Note that the -``numa`` option doesn't allocate any of the specified
+ resources, it just assigns existing resources to NUMA nodes. This
+ means that one still has to use the ``-m``, ``-smp`` options to
+ allocate RAM and VCPUs respectively.
+
+ Use '\ ``hmat-lb``\ ' to set System Locality Latency and Bandwidth
+ Information between initiator and target NUMA nodes in ACPI
+ Heterogeneous Attribute Memory Table (HMAT). Initiator NUMA node can
+ create memory requests, usually it has one or more processors.
+ Target NUMA node contains addressable memory.
+
+ In '\ ``hmat-lb``\ ' option, node are NUMA node IDs. hierarchy is
+ the memory hierarchy of the target NUMA node: if hierarchy is
+ 'memory', the structure represents the memory performance; if
+ hierarchy is 'first-level\|second-level\|third-level', this
+ structure represents aggregated performance of memory side caches
+ for each domain. type of 'data-type' is type of data represented by
+ this structure instance: if 'hierarchy' is 'memory', 'data-type' is
+ 'access\|read\|write' latency or 'access\|read\|write' bandwidth of
+ the target memory; if 'hierarchy' is
+ 'first-level\|second-level\|third-level', 'data-type' is
+ 'access\|read\|write' hit latency or 'access\|read\|write' hit
+ bandwidth of the target memory side cache.
+
+ lat is latency value in nanoseconds. bw is bandwidth value, the
+ possible value and units are NUM[M\|G\|T], mean that the bandwidth
+ value are NUM byte per second (or MB/s, GB/s or TB/s depending on
+ used suffix). Note that if latency or bandwidth value is 0, means
+ the corresponding latency or bandwidth information is not provided.
+
+ In '\ ``hmat-cache``\ ' option, node-id is the NUMA-id of the memory
+ belongs. size is the size of memory side cache in bytes. level is
+ the cache level described in this structure, note that the cache
+ level 0 should not be used with '\ ``hmat-cache``\ ' option.
+ associativity is the cache associativity, the possible value is
+ 'none/direct(direct-mapped)/complex(complex cache indexing)'. policy
+ is the write policy. line is the cache Line size in bytes.
+
+ For example, the following options describe 2 NUMA nodes. Node 0 has
+ 2 cpus and a ram, node 1 has only a ram. The processors in node 0
+ access memory in node 0 with access-latency 5 nanoseconds,
+ access-bandwidth is 200 MB/s; The processors in NUMA node 0 access
+ memory in NUMA node 1 with access-latency 10 nanoseconds,
+ access-bandwidth is 100 MB/s. And for memory side cache information,
+ NUMA node 0 and 1 both have 1 level memory cache, size is 10KB,
+ policy is write-back, the cache Line size is 8 bytes:
+
+ ::
+
+ -machine hmat=on \
+ -m 2G \
+ -object memory-backend-ram,size=1G,id=m0 \
+ -object memory-backend-ram,size=1G,id=m1 \
+ -smp 2 \
+ -numa node,nodeid=0,memdev=m0 \
+ -numa node,nodeid=1,memdev=m1,initiator=0 \
+ -numa cpu,node-id=0,socket-id=0 \
+ -numa cpu,node-id=0,socket-id=1 \
+ -numa hmat-lb,initiator=0,target=0,hierarchy=memory,data-type=access-latency,latency=5 \
+ -numa hmat-lb,initiator=0,target=0,hierarchy=memory,data-type=access-bandwidth,bandwidth=200M \
+ -numa hmat-lb,initiator=0,target=1,hierarchy=memory,data-type=access-latency,latency=10 \
+ -numa hmat-lb,initiator=0,target=1,hierarchy=memory,data-type=access-bandwidth,bandwidth=100M \
+ -numa hmat-cache,node-id=0,size=10K,level=1,associativity=direct,policy=write-back,line=8 \
+ -numa hmat-cache,node-id=1,size=10K,level=1,associativity=direct,policy=write-back,line=8
+ERST
DEF("add-fd", HAS_ARG, QEMU_OPTION_add_fd,
"-add-fd fd=fd,set=set[,opaque=opaque]\n"
@@ -350,6 +621,33 @@ You can open an image using pre-opened file descriptors from an fd set:
-drive file=/dev/fdset/2,index=0,media=disk
@end example
ETEXI
+SRST
+``-add-fd fd=fd,set=set[,opaque=opaque]``
+ Add a file descriptor to an fd set. Valid options are:
+
+ ``fd=fd``
+ This option defines the file descriptor of which a duplicate is
+ added to fd set. The file descriptor cannot be stdin, stdout, or
+ stderr.
+
+ ``set=set``
+ This option defines the ID of the fd set to add the file
+ descriptor to.
+
+ ``opaque=opaque``
+ This option defines a free-form string that can be used to
+ describe fd.
+
+ You can open an image using pre-opened file descriptors from an fd
+ set:
+
+ .. parsed-literal::
+
+ |qemu_system| \
+ -add-fd fd=3,set=2,opaque="rdwr:/path/to/file" \
+ -add-fd fd=4,set=2,opaque="rdonly:/path/to/file" \
+ -drive file=/dev/fdset/2,index=0,media=disk
+ERST
DEF("set", HAS_ARG, QEMU_OPTION_set,
"-set group.id.arg=value\n"
@@ -360,6 +658,10 @@ STEXI
@findex -set
Set parameter @var{arg} for item @var{id} of type @var{group}
ETEXI
+SRST
+``-set group.id.arg=value``
+ Set parameter arg for item id of type group
+ERST
DEF("global", HAS_ARG, QEMU_OPTION_global,
"-global driver.property=value\n"
@@ -384,6 +686,23 @@ created automatically and set properties on it, use -@option{device}.
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``
+ Set default value of driver's property prop to value, e.g.:
+
+ .. parsed-literal::
+
+ |qemu_system_x86| -global ide-hd.physical_block_size=4096 disk-image.img
+
+ In particular, you can use this to set driver properties for devices
+ which are created automatically by the machine model. To create a
+ device which is not created automatically and set properties on it,
+ use -``device``.
+
+ -global driver.prop=value is shorthand for -global
+ driver=driver,property=prop,value=value. The longhand syntax works
+ even when driver contains a dot.
+ERST
DEF("boot", HAS_ARG, QEMU_OPTION_boot,
"-boot [order=drives][,once=drives][,menu=on|off]\n"
@@ -437,6 +756,50 @@ bootindex options. The default is non-strict boot.
Note: The legacy format '-boot @var{drives}' is still supported but its
use is discouraged as it may be removed from future versions.
ETEXI
+SRST
+``-boot [order=drives][,once=drives][,menu=on|off][,splash=sp_name][,splash-time=sp_time][,reboot-timeout=rb_timeout][,strict=on|off]``
+ Specify boot order drives as a string of drive letters. Valid drive
+ letters depend on the target architecture. The x86 PC uses: a, b
+ (floppy 1 and 2), c (first hard disk), d (first CD-ROM), n-p
+ (Etherboot from network adapter 1-4), hard disk boot is the default.
+ To apply a particular boot order only on the first startup, specify
+ it via ``once``. Note that the ``order`` or ``once`` parameter
+ should not be used together with the ``bootindex`` property of
+ devices, since the firmware implementations normally do not support
+ both at the same time.
+
+ Interactive boot menus/prompts can be enabled via ``menu=on`` as far
+ as firmware/BIOS supports them. The default is non-interactive boot.
+
+ A splash picture could be passed to bios, enabling user to show it
+ as logo, when option splash=sp\_name is given and menu=on, If
+ firmware/BIOS supports them. Currently Seabios for X86 system
+ support it. limitation: The splash file could be a jpeg file or a
+ BMP file in 24 BPP format(true color). The resolution should be
+ supported by the SVGA mode, so the recommended is 320x240, 640x480,
+ 800x640.
+
+ A timeout could be passed to bios, guest will pause for rb\_timeout
+ ms when boot failed, then reboot. If rb\_timeout is '-1', guest will
+ not reboot, qemu passes '-1' to bios by default. Currently Seabios
+ for X86 system support it.
+
+ Do strict boot via ``strict=on`` as far as firmware/BIOS supports
+ it. This only effects when boot priority is changed by bootindex
+ options. The default is non-strict boot.
+
+ ::
+
+ # try to boot from network first, then from hard disk
+ |qemu_system_x86| -boot order=nc
+ # boot from CD-ROM first, switch back to default order after reboot
+ |qemu_system_x86| -boot once=d
+ # boot with a splash picture for 5 seconds.
+ |qemu_system_x86| -boot menu=on,splash=/root/boot.bmp,splash-time=5000
+
+ Note: The legacy format '-boot drives' is still supported but its
+ use is discouraged as it may be removed from future versions.
+ERST
DEF("m", HAS_ARG, QEMU_OPTION_m,
"-m [size=]megs[,slots=n,maxmem=size]\n"
@@ -466,6 +829,25 @@ memory the guest can reach to 4GB:
If @var{slots} and @var{maxmem} are not specified, memory hotplug won't
be enabled and the guest startup RAM will never increase.
ETEXI
+SRST
+``-m [size=]megs[,slots=n,maxmem=size]``
+ Sets guest startup RAM size to megs megabytes. Default is 128 MiB.
+ Optionally, a suffix of "M" or "G" can be used to signify a value in
+ megabytes or gigabytes respectively. Optional pair slots, maxmem
+ could be used to set amount of hotpluggable memory slots and maximum
+ amount of memory. Note that maxmem must be aligned to the page size.
+
+ For example, the following command-line sets the guest startup RAM
+ size to 1GB, creates 3 slots to hotplug additional memory and sets
+ the maximum memory the guest can reach to 4GB:
+
+ .. parsed-literal::
+
+ |qemu_system| -m 1G,slots=3,maxmem=4G
+
+ If slots and maxmem are not specified, memory hotplug won't be
+ enabled and the guest startup RAM will never increase.
+ERST
DEF("mem-path", HAS_ARG, QEMU_OPTION_mempath,
"-mem-path FILE provide backing storage for guest RAM\n", QEMU_ARCH_ALL)
@@ -474,6 +856,10 @@ STEXI
@findex -mem-path
Allocate guest RAM from a temporarily created file in @var{path}.
ETEXI
+SRST
+``-mem-path path``
+ Allocate guest RAM from a temporarily created file in path.
+ERST
DEF("mem-prealloc", 0, QEMU_OPTION_mem_prealloc,
"-mem-prealloc preallocate guest memory (use with -mem-path)\n",
@@ -483,6 +869,10 @@ STEXI
@findex -mem-prealloc
Preallocate memory when using -mem-path.
ETEXI
+SRST
+``-mem-prealloc``
+ Preallocate memory when using -mem-path.
+ERST
DEF("k", HAS_ARG, QEMU_OPTION_k,
"-k language use keyboard layout (for example 'fr' for French)\n",
@@ -505,6 +895,24 @@ de en-us fi fr-be hr it lv nl-be pt sl tr
The default is @code{en-us}.
ETEXI
+SRST
+``-k language``
+ Use keyboard layout language (for example ``fr`` for French). This
+ option is only needed where it is not easy to get raw PC keycodes
+ (e.g. on Macs, with some X11 servers or with a VNC or curses
+ display). You don't normally need to use it on PC/Linux or
+ PC/Windows hosts.
+
+ The available layouts are:
+
+ ::
+
+ ar de-ch es fo fr-ca hu ja mk no pt-br sv
+ da en-gb et fr fr-ch is lt nl pl ru th
+ de en-us fi fr-be hr it lv nl-be pt sl tr
+
+ The default is ``en-us``.
+ERST
HXCOMM Deprecated by -audiodev
@@ -517,6 +925,11 @@ STEXI
Will show the -audiodev equivalent of the currently specified
(deprecated) environment variables.
ETEXI
+SRST
+``-audio-help``
+ Will show the -audiodev equivalent of the currently specified
+ (deprecated) environment variables.
+ERST
DEF("audiodev", HAS_ARG, QEMU_OPTION_audiodev,
"-audiodev [driver=]driver,id=id[,prop[=value][,...]]\n"
@@ -766,6 +1179,173 @@ Write recorded audio into the specified file. Default is
@end table
ETEXI
+SRST
+``-audiodev [driver=]driver,id=id[,prop[=value][,...]]``
+ Adds a new audio backend driver identified by id. There are global
+ and driver specific properties. Some values can be set differently
+ for input and output, they're marked with ``in|out.``. You can set
+ the input's property with ``in.prop`` and the output's property with
+ ``out.prop``. For example:
+
+ ::
+
+ -audiodev alsa,id=example,in.frequency=44110,out.frequency=8000
+ -audiodev alsa,id=example,out.channels=1 # leaves in.channels unspecified
+
+ NOTE: parameter validation is known to be incomplete, in many cases
+ specifying an invalid option causes QEMU to print an error message
+ and continue emulation without sound.
+
+ Valid global options are:
+
+ ``id=identifier``
+ Identifies the audio backend.
+
+ ``timer-period=period``
+ Sets the timer period used by the audio subsystem in
+ microseconds. Default is 10000 (10 ms).
+
+ ``in|out.mixing-engine=on|off``
+ Use QEMU's mixing engine to mix all streams inside QEMU and
+ convert audio formats when not supported by the backend. When
+ off, fixed-settings must be off too. Note that disabling this
+ option means that the selected backend must support multiple
+ streams and the audio formats used by the virtual cards,
+ otherwise you'll get no sound. It's not recommended to disable
+ this option unless you want to use 5.1 or 7.1 audio, as mixing
+ engine only supports mono and stereo audio. Default is on.
+
+ ``in|out.fixed-settings=on|off``
+ Use fixed settings for host audio. When off, it will change
+ based on how the guest opens the sound card. In this case you
+ must not specify frequency, channels or format. Default is on.
+
+ ``in|out.frequency=frequency``
+ Specify the frequency to use when using fixed-settings. Default
+ is 44100Hz.
+
+ ``in|out.channels=channels``
+ Specify the number of channels to use when using fixed-settings.
+ Default is 2 (stereo).
+
+ ``in|out.format=format``
+ Specify the sample format to use when using fixed-settings.
+ Valid values are: ``s8``, ``s16``, ``s32``, ``u8``, ``u16``,
+ ``u32``. Default is ``s16``.
+
+ ``in|out.voices=voices``
+ Specify the number of voices to use. Default is 1.
+
+ ``in|out.buffer-length=usecs``
+ Sets the size of the buffer in microseconds.
+
+``-audiodev none,id=id[,prop[=value][,...]]``
+ Creates a dummy backend that discards all outputs. This backend has
+ no backend specific properties.
+
+``-audiodev alsa,id=id[,prop[=value][,...]]``
+ Creates backend using the ALSA. This backend is only available on
+ Linux.
+
+ ALSA specific options are:
+
+ ``in|out.dev=device``
+ Specify the ALSA device to use for input and/or output. Default
+ is ``default``.
+
+ ``in|out.period-length=usecs``
+ Sets the period length in microseconds.
+
+ ``in|out.try-poll=on|off``
+ Attempt to use poll mode with the device. Default is on.
+
+ ``threshold=threshold``
+ Threshold (in microseconds) when playback starts. Default is 0.
+
+``-audiodev coreaudio,id=id[,prop[=value][,...]]``
+ Creates a backend using Apple's Core Audio. This backend is only
+ available on Mac OS and only supports playback.
+
+ Core Audio specific options are:
+
+ ``in|out.buffer-count=count``
+ Sets the count of the buffers.
+
+``-audiodev dsound,id=id[,prop[=value][,...]]``
+ Creates a backend using Microsoft's DirectSound. This backend is
+ only available on Windows and only supports playback.
+
+ DirectSound specific options are:
+
+ ``latency=usecs``
+ Add extra usecs microseconds latency to playback. Default is
+ 10000 (10 ms).
+
+``-audiodev oss,id=id[,prop[=value][,...]]``
+ Creates a backend using OSS. This backend is available on most
+ Unix-like systems.
+
+ OSS specific options are:
+
+ ``in|out.dev=device``
+ Specify the file name of the OSS device to use. Default is
+ ``/dev/dsp``.
+
+ ``in|out.buffer-count=count``
+ Sets the count of the buffers.
+
+ ``in|out.try-poll=on|of``
+ Attempt to use poll mode with the device. Default is on.
+
+ ``try-mmap=on|off``
+ Try using memory mapped device access. Default is off.
+
+ ``exclusive=on|off``
+ Open the device in exclusive mode (vmix won't work in this
+ case). Default is off.
+
+ ``dsp-policy=policy``
+ Sets the timing policy (between 0 and 10, where smaller number
+ means smaller latency but higher CPU usage). Use -1 to use
+ buffer sizes specified by ``buffer`` and ``buffer-count``. This
+ option is ignored if you do not have OSS 4. Default is 5.
+
+``-audiodev pa,id=id[,prop[=value][,...]]``
+ Creates a backend using PulseAudio. This backend is available on
+ most systems.
+
+ PulseAudio specific options are:
+
+ ``server=server``
+ Sets the PulseAudio server to connect to.
+
+ ``in|out.name=sink``
+ Use the specified source/sink for recording/playback.
+
+ ``in|out.latency=usecs``
+ Desired latency in microseconds. The PulseAudio server will try
+ to honor this value but actual latencies may be lower or higher.
+
+``-audiodev sdl,id=id[,prop[=value][,...]]``
+ Creates a backend using SDL. This backend is available on most
+ systems, but you should use your platform's native backend if
+ possible. This backend has no backend specific properties.
+
+``-audiodev spice,id=id[,prop[=value][,...]]``
+ Creates a backend that sends audio through SPICE. This backend
+ requires ``-spice`` and automatically selected in that case, so
+ usually you can ignore this option. This backend has no backend
+ specific properties.
+
+``-audiodev wav,id=id[,prop[=value][,...]]``
+ Creates a backend that writes audio to a WAV file.
+
+ Backend specific options are:
+
+ ``path=path``
+ Write recorded audio into the specified file. Default is
+ ``qemu.wav``.
+ERST
DEF("soundhw", HAS_ARG, QEMU_OPTION_soundhw,
"-soundhw c1,... enable audio support\n"
@@ -794,6 +1374,27 @@ require manually specifying clocking.
modprobe i810_audio clocking=48000
@end example
ETEXI
+SRST
+``-soundhw card1[,card2,...] or -soundhw all``
+ Enable audio and selected sound hardware. Use 'help' to print all
+ available sound hardware. For example:
+
+ .. parsed-literal::
+
+ |qemu_system_x86| -soundhw sb16,adlib disk.img
+ |qemu_system_x86| -soundhw es1370 disk.img
+ |qemu_system_x86| -soundhw ac97 disk.img
+ |qemu_system_x86| -soundhw hda disk.img
+ |qemu_system_x86| -soundhw all disk.img
+ |qemu_system_x86| -soundhw help
+
+ Note that Linux's i810\_audio OSS kernel (for AC97) module might
+ require manually specifying clocking.
+
+ ::
+
+ modprobe i810_audio clocking=48000
+ERST
DEF("device", HAS_ARG, QEMU_OPTION_device,
"-device driver[,prop[=value][,...]]\n"
@@ -879,6 +1480,85 @@ Like the KCS interface, but defines a BT interface. The default port is
0xe4 and the default interrupt is 5.
ETEXI
+SRST
+``-device driver[,prop[=value][,...]]``
+ Add device driver. prop=value sets driver properties. Valid
+ properties depend on the driver. To get help on possible drivers and
+ properties, use ``-device help`` and ``-device driver,help``.
+
+ Some drivers are:
+
+``-device ipmi-bmc-sim,id=id[,slave_addr=val][,sdrfile=file][,furareasize=val][,furdatafile=file][,guid=uuid]``
+ Add an IPMI BMC. This is a simulation of a hardware management
+ interface processor that normally sits on a system. It provides a
+ watchdog and the ability to reset and power control the system. You
+ need to connect this to an IPMI interface to make it useful
+
+ The IPMI slave address to use for the BMC. The default is 0x20. This
+ address is the BMC's address on the I2C network of management
+ controllers. If you don't know what this means, it is safe to ignore
+ it.
+
+ ``id=id``
+ The BMC id for interfaces to use this device.
+
+ ``slave_addr=val``
+ Define slave address to use for the BMC. The default is 0x20.
+
+ ``sdrfile=file``
+ file containing raw Sensor Data Records (SDR) data. The default
+ is none.
+
+ ``fruareasize=val``
+ size of a Field Replaceable Unit (FRU) area. The default is
+ 1024.
+
+ ``frudatafile=file``
+ file containing raw Field Replaceable Unit (FRU) inventory data.
+ The default is none.
+
+ ``guid=uuid``
+ value for the GUID for the BMC, in standard UUID format. If this
+ is set, get "Get GUID" command to the BMC will return it.
+ Otherwise "Get GUID" will return an error.
+
+``-device ipmi-bmc-extern,id=id,chardev=id[,slave_addr=val]``
+ Add a connection to an external IPMI BMC simulator. Instead of
+ locally emulating the BMC like the above item, instead connect to an
+ external entity that provides the IPMI services.
+
+ A connection is made to an external BMC simulator. If you do this,
+ it is strongly recommended that you use the "reconnect=" chardev
+ option to reconnect to the simulator if the connection is lost. Note
+ that if this is not used carefully, it can be a security issue, as
+ the interface has the ability to send resets, NMIs, and power off
+ the VM. It's best if QEMU makes a connection to an external
+ simulator running on a secure port on localhost, so neither the
+ simulator nor QEMU is exposed to any outside network.
+
+ See the "lanserv/README.vm" file in the OpenIPMI library for more
+ details on the external interface.
+
+``-device isa-ipmi-kcs,bmc=id[,ioport=val][,irq=val]``
+ Add a KCS IPMI interafce on the ISA bus. This also adds a
+ corresponding ACPI and SMBIOS entries, if appropriate.
+
+ ``bmc=id``
+ The BMC to connect to, one of ipmi-bmc-sim or ipmi-bmc-extern
+ above.
+
+ ``ioport=val``
+ Define the I/O address of the interface. The default is 0xca0
+ for KCS.
+
+ ``irq=val``
+ Define the interrupt to use. The default is 5. To disable
+ interrupts, set this to 0.
+
+``-device isa-ipmi-bt,bmc=id[,ioport=val][,irq=val]``
+ Like the KCS interface, but defines a BT interface. The default port
+ is 0xe4 and the default interrupt is 5.
+ERST
DEF("name", HAS_ARG, QEMU_OPTION_name,
"-name string1[,process=string2][,debug-threads=on|off]\n"
@@ -896,6 +1576,13 @@ The @var{name} will also be used for the VNC server.
Also optionally set the top visible process name in Linux.
Naming of individual threads can also be enabled on Linux to aid debugging.
ETEXI
+SRST
+``-name name``
+ Sets the name of the guest. This name will be displayed in the SDL
+ window caption. The name will also be used for the VNC server. Also
+ optionally set the top visible process name in Linux. Naming of
+ individual threads can also be enabled on Linux to aid debugging.
+ERST
DEF("uuid", HAS_ARG, QEMU_OPTION_uuid,
"-uuid %08x-%04x-%04x-%04x-%012x\n"
@@ -905,6 +1592,10 @@ STEXI
@findex -uuid
Set system UUID.
ETEXI
+SRST
+``-uuid uuid``
+ Set system UUID.
+ERST
STEXI
@end table
@@ -926,6 +1617,11 @@ STEXI
@findex -fdb
Use @var{file} as floppy disk 0/1 image (@pxref{disk_images}).
ETEXI
+SRST
+``-fda file``; \ ``-fdb file``
+ Use file as floppy disk 0/1 image (see
+ :ref:`disk_005fimages`).
+ERST
DEF("hda", HAS_ARG, QEMU_OPTION_hda,
"-hda/-hdb file use 'file' as IDE hard disk 0/1 image\n", QEMU_ARCH_ALL)
@@ -944,6 +1640,11 @@ STEXI
@findex -hdd
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``
+ Use file as hard disk 0, 1, 2 or 3 image (see
+ :ref:`disk_005fimages`).
+ERST
DEF("cdrom", HAS_ARG, QEMU_OPTION_cdrom,
"-cdrom file use 'file' as IDE cdrom image (cdrom is ide1 master)\n",
@@ -955,6 +1656,12 @@ Use @var{file} as CD-ROM image (you cannot use @option{-hdc} and
@option{-cdrom} at the same time). You can use the host CD-ROM by
using @file{/dev/cdrom} as filename.
ETEXI
+SRST
+``-cdrom file``
+ Use file as CD-ROM image (you cannot use ``-hdc`` and ``-cdrom`` at
+ the same time). You can use the host CD-ROM by using ``/dev/cdrom``
+ as filename.
+ERST
DEF("blockdev", HAS_ARG, QEMU_OPTION_blockdev,
"-blockdev [driver=]driver[,node-name=N][,discard=ignore|unmap]\n"
@@ -1150,6 +1857,216 @@ Please refer to the QAPI documentation of the @code{blockdev-add} QMP command.
@end table
ETEXI
+SRST
+``-blockdev option[,option[,option[,...]]]``
+ Define a new block driver node. Some of the options apply to all
+ block drivers, other options are only accepted for a specific block
+ driver. See below for a list of generic options and options for the
+ most common block drivers.
+
+ Options that expect a reference to another node (e.g. ``file``) can
+ be given in two ways. Either you specify the node name of an already
+ existing node (file=node-name), or you define a new node inline,
+ adding options for the referenced node after a dot
+ (file.filename=path,file.aio=native).
+
+ A block driver node created with ``-blockdev`` can be used for a
+ guest device by specifying its node name for the ``drive`` property
+ in a ``-device`` argument that defines a block device.
+
+ ``Valid options for any block driver node:``
+ ``driver``
+ Specifies the block driver to use for the given node.
+
+ ``node-name``
+ This defines the name of the block driver node by which it
+ will be referenced later. The name must be unique, i.e. it
+ must not match the name of a different block driver node, or
+ (if you use ``-drive`` as well) the ID of a drive.
+
+ If no node name is specified, it is automatically generated.
+ The generated node name is not intended to be predictable
+ and changes between QEMU invocations. For the top level, an
+ explicit node name must be specified.
+
+ ``read-only``
+ Open the node read-only. Guest write attempts will fail.
+
+ Note that some block drivers support only read-only access,
+ either generally or in certain configurations. In this case,
+ the default value ``read-only=off`` does not work and the
+ option must be specified explicitly.
+
+ ``auto-read-only``
+ If ``auto-read-only=on`` is set, QEMU may fall back to
+ read-only usage even when ``read-only=off`` is requested, or
+ even switch between modes as needed, e.g. depending on
+ whether the image file is writable or whether a writing user
+ is attached to the node.
+
+ ``force-share``
+ Override the image locking system of QEMU by forcing the
+ node to utilize weaker shared access for permissions where
+ it would normally request exclusive access. When there is
+ the potential for multiple instances to have the same file
+ open (whether this invocation of QEMU is the first or the
+ second instance), both instances must permit shared access
+ for the second instance to succeed at opening the file.
+
+ Enabling ``force-share=on`` requires ``read-only=on``.
+
+ ``cache.direct``
+ The host page cache can be avoided with ``cache.direct=on``.
+ This will attempt to do disk IO directly to the guest's
+ memory. QEMU may still perform an internal copy of the data.
+
+ ``cache.no-flush``
+ In case you don't care about data integrity over host
+ failures, you can use ``cache.no-flush=on``. This option
+ tells QEMU that it never needs to write any data to the disk
+ but can instead keep things in cache. If anything goes
+ wrong, like your host losing power, the disk storage getting
+ disconnected accidentally, etc. your image will most
+ probably be rendered unusable.
+
+ ``discard=discard``
+ discard is one of "ignore" (or "off") or "unmap" (or "on")
+ and controls whether ``discard`` (also known as ``trim`` or
+ ``unmap``) requests are ignored or passed to the filesystem.
+ Some machine types may not support discard requests.
+
+ ``detect-zeroes=detect-zeroes``
+ detect-zeroes is "off", "on" or "unmap" and enables the
+ automatic conversion of plain zero writes by the OS to
+ driver specific optimized zero write commands. You may even
+ choose "unmap" if discard is set to "unmap" to allow a zero
+ write to be converted to an ``unmap`` operation.
+
+ ``Driver-specific options for file``
+ This is the protocol-level block driver for accessing regular
+ files.
+
+ ``filename``
+ The path to the image file in the local filesystem
+
+ ``aio``
+ Specifies the AIO backend (threads/native, default: threads)
+
+ ``locking``
+ Specifies whether the image file is protected with Linux OFD
+ / POSIX locks. The default is to use the Linux Open File
+ Descriptor API if available, otherwise no lock is applied.
+ (auto/on/off, default: auto)
+
+ Example:
+
+ ::
+
+ -blockdev driver=file,node-name=disk,filename=disk.img
+
+ ``Driver-specific options for raw``
+ This is the image format block driver for raw images. It is
+ usually stacked on top of a protocol level block driver such as
+ ``file``.
+
+ ``file``
+ Reference to or definition of the data source block driver
+ node (e.g. a ``file`` driver node)
+
+ Example 1:
+
+ ::
+
+ -blockdev driver=file,node-name=disk_file,filename=disk.img
+ -blockdev driver=raw,node-name=disk,file=disk_file
+
+ Example 2:
+
+ ::
+
+ -blockdev driver=raw,node-name=disk,file.driver=file,file.filename=disk.img
+
+ ``Driver-specific options for qcow2``
+ This is the image format block driver for qcow2 images. It is
+ usually stacked on top of a protocol level block driver such as
+ ``file``.
+
+ ``file``
+ Reference to or definition of the data source block driver
+ node (e.g. a ``file`` driver node)
+
+ ``backing``
+ Reference to or definition of the backing file block device
+ (default is taken from the image file). It is allowed to
+ pass ``null`` here in order to disable the default backing
+ file.
+
+ ``lazy-refcounts``
+ Whether to enable the lazy refcounts feature (on/off;
+ default is taken from the image file)
+
+ ``cache-size``
+ The maximum total size of the L2 table and refcount block
+ caches in bytes (default: the sum of l2-cache-size and
+ refcount-cache-size)
+
+ ``l2-cache-size``
+ The maximum size of the L2 table cache in bytes (default: if
+ cache-size is not specified - 32M on Linux platforms, and 8M
+ on non-Linux platforms; otherwise, as large as possible
+ within the cache-size, while permitting the requested or the
+ minimal refcount cache size)
+
+ ``refcount-cache-size``
+ The maximum size of the refcount block cache in bytes
+ (default: 4 times the cluster size; or if cache-size is
+ specified, the part of it which is not used for the L2
+ cache)
+
+ ``cache-clean-interval``
+ Clean unused entries in the L2 and refcount caches. The
+ interval is in seconds. The default value is 600 on
+ supporting platforms, and 0 on other platforms. Setting it
+ to 0 disables this feature.
+
+ ``pass-discard-request``
+ Whether discard requests to the qcow2 device should be
+ forwarded to the data source (on/off; default: on if
+ discard=unmap is specified, off otherwise)
+
+ ``pass-discard-snapshot``
+ Whether discard requests for the data source should be
+ issued when a snapshot operation (e.g. deleting a snapshot)
+ frees clusters in the qcow2 file (on/off; default: on)
+
+ ``pass-discard-other``
+ Whether discard requests for the data source should be
+ issued on other occasions where a cluster gets freed
+ (on/off; default: off)
+
+ ``overlap-check``
+ Which overlap checks to perform for writes to the image
+ (none/constant/cached/all; default: cached). For details or
+ finer granularity control refer to the QAPI documentation of
+ ``blockdev-add``.
+
+ Example 1:
+
+ ::
+
+ -blockdev driver=file,node-name=my_file,filename=/tmp/disk.qcow2
+ -blockdev driver=qcow2,node-name=hda,file=my_file,overlap-check=none,cache-size=16777216
+
+ Example 2:
+
+ ::
+
+ -blockdev driver=qcow2,node-name=disk,file.driver=http,file.filename=http://example.com/image.qcow2
+
+ ``Driver-specific options for other drivers``
+ Please refer to the QAPI documentation of the ``blockdev-add``
+ QMP command.
+ERST
DEF("drive", HAS_ARG, QEMU_OPTION_drive,
"-drive [file=file][,if=type][,bus=n][,unit=m][,media=d][,index=i]\n"
@@ -1329,6 +2246,197 @@ is interpreted like:
@value{qemu_system_x86} -hda a -hdb b
@end example
ETEXI
+SRST
+``-drive option[,option[,option[,...]]]``
+ Define a new drive. This includes creating a block driver node (the
+ backend) as well as a guest device, and is mostly a shortcut for
+ defining the corresponding ``-blockdev`` and ``-device`` options.
+
+ ``-drive`` accepts all options that are accepted by ``-blockdev``.
+ In addition, it knows the following options:
+
+ ``file=file``
+ This option defines which disk image (see
+ :ref:`disk_005fimages`) to use with this drive. If
+ the filename contains comma, you must double it (for instance,
+ "file=my,,file" to use file "my,file").
+
+ Special files such as iSCSI devices can be specified using
+ protocol specific URLs. See the section for "Device URL Syntax"
+ for more information.
+
+ ``if=interface``
+ This option defines on which type on interface the drive is
+ connected. Available types are: ide, scsi, sd, mtd, floppy,
+ pflash, virtio, none.
+
+ ``bus=bus,unit=unit``
+ These options define where is connected the drive by defining
+ the bus number and the unit id.
+
+ ``index=index``
+ This option defines where is connected the drive by using an
+ index in the list of available connectors of a given interface
+ type.
+
+ ``media=media``
+ This option defines the type of the media: disk or cdrom.
+
+ ``snapshot=snapshot``
+ snapshot is "on" or "off" and controls snapshot mode for the
+ given drive (see ``-snapshot``).
+
+ ``cache=cache``
+ cache is "none", "writeback", "unsafe", "directsync" or
+ "writethrough" and controls how the host cache is used to access
+ block data. This is a shortcut that sets the ``cache.direct``
+ and ``cache.no-flush`` options (as in ``-blockdev``), and
+ additionally ``cache.writeback``, which provides a default for
+ 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
+
+ The default mode is ``cache=writeback``.
+
+ ``aio=aio``
+ aio is "threads", or "native" and selects between pthread based
+ disk I/O and native Linux AIO.
+
+ ``format=format``
+ Specify which disk format will be used rather than detecting the
+ format. Can be used to specify format=raw to avoid interpreting
+ an untrusted format header.
+
+ ``werror=action,rerror=action``
+ Specify which action to take on write and read errors. Valid
+ actions are: "ignore" (ignore the error and try to continue),
+ "stop" (pause QEMU), "report" (report the error to the guest),
+ "enospc" (pause QEMU only if the host disk is full; report the
+ error to the guest otherwise). The default setting is
+ ``werror=enospc`` and ``rerror=report``.
+
+ ``copy-on-read=copy-on-read``
+ copy-on-read is "on" or "off" and enables whether to copy read
+ backing file sectors into the image file.
+
+ ``bps=b,bps_rd=r,bps_wr=w``
+ Specify bandwidth throttling limits in bytes per second, either
+ for all request types or for reads or writes only. Small values
+ can lead to timeouts or hangs inside the guest. A safe minimum
+ for disks is 2 MB/s.
+
+ ``bps_max=bm,bps_rd_max=rm,bps_wr_max=wm``
+ Specify bursts in bytes per second, either for all request types
+ or for reads or writes only. Bursts allow the guest I/O to spike
+ above the limit temporarily.
+
+ ``iops=i,iops_rd=r,iops_wr=w``
+ Specify request rate limits in requests per second, either for
+ all request types or for reads or writes only.
+
+ ``iops_max=bm,iops_rd_max=rm,iops_wr_max=wm``
+ Specify bursts in requests per second, either for all request
+ types or for reads or writes only. Bursts allow the guest I/O to
+ spike above the limit temporarily.
+
+ ``iops_size=is``
+ Let every is bytes of a request count as a new request for iops
+ throttling purposes. Use this option to prevent guests from
+ circumventing iops limits by sending fewer but larger requests.
+
+ ``group=g``
+ Join a throttling quota group with given name g. All drives that
+ are members of the same group are accounted for together. Use
+ this option to prevent guests from circumventing throttling
+ limits by using many small disks instead of a single larger
+ disk.
+
+ By default, the ``cache.writeback=on`` mode is used. It will report
+ data writes as completed as soon as the data is present in the host
+ page cache. This is safe as long as your guest OS makes sure to
+ correctly flush disk caches where needed. If your guest OS does not
+ handle volatile disk write caches correctly and your host crashes or
+ loses power, then the guest may experience data corruption.
+
+ For such guests, you should consider using ``cache.writeback=off``.
+ This means that the host page cache will be used to read and write
+ data, but write notification will be sent to the guest only after
+ QEMU has made sure to flush each write to the disk. Be aware that
+ this has a major impact on performance.
+
+ When using the ``-snapshot`` option, unsafe caching is always used.
+
+ Copy-on-read avoids accessing the same backing file sectors
+ repeatedly and is useful when the backing file is over a slow
+ network. By default copy-on-read is off.
+
+ Instead of ``-cdrom`` you can use:
+
+ .. parsed-literal::
+
+ |qemu_system| -drive file=file,index=2,media=cdrom
+
+ Instead of ``-hda``, ``-hdb``, ``-hdc``, ``-hdd``, you can use:
+
+ .. parsed-literal::
+
+ |qemu_system| -drive file=file,index=0,media=disk
+ |qemu_system| -drive file=file,index=1,media=disk
+ |qemu_system| -drive file=file,index=2,media=disk
+ |qemu_system| -drive file=file,index=3,media=disk
+
+ You can open an image using pre-opened file descriptors from an fd
+ set:
+
+ .. parsed-literal::
+
+ |qemu_system| \
+ -add-fd fd=3,set=2,opaque="rdwr:/path/to/file" \
+ -add-fd fd=4,set=2,opaque="rdonly:/path/to/file" \
+ -drive file=/dev/fdset/2,index=0,media=disk
+
+ You can connect a CDROM to the slave of ide0:
+
+ .. parsed-literal::
+
+ |qemu_system_x86| -drive file=file,if=ide,index=1,media=cdrom
+
+ If you don't specify the "file=" argument, you define an empty
+ drive:
+
+ .. parsed-literal::
+
+ |qemu_system_x86| -drive if=ide,index=1,media=cdrom
+
+ Instead of ``-fda``, ``-fdb``, you can use:
+
+ .. parsed-literal::
+
+ |qemu_system_x86| -drive file=file,index=0,if=floppy
+ |qemu_system_x86| -drive file=file,index=1,if=floppy
+
+ By default, interface is "ide" and index is automatically
+ incremented:
+
+ .. parsed-literal::
+
+ |qemu_system_x86| -drive file=a -drive file=b"
+
+ is interpreted like:
+
+ .. parsed-literal::
+
+ |qemu_system_x86| -hda a -hdb b
+ERST
DEF("mtdblock", HAS_ARG, QEMU_OPTION_mtdblock,
"-mtdblock file use 'file' as on-board Flash memory image\n",
@@ -1338,6 +2446,10 @@ STEXI
@findex -mtdblock
Use @var{file} as on-board Flash memory image.
ETEXI
+SRST
+``-mtdblock file``
+ Use file as on-board Flash memory image.
+ERST
DEF("sd", HAS_ARG, QEMU_OPTION_sd,
"-sd file use 'file' as SecureDigital card image\n", QEMU_ARCH_ALL)
@@ -1346,6 +2458,10 @@ STEXI
@findex -sd
Use @var{file} as SecureDigital card image.
ETEXI
+SRST
+``-sd file``
+ Use file as SecureDigital card image.
+ERST
DEF("pflash", HAS_ARG, QEMU_OPTION_pflash,
"-pflash file use 'file' as a parallel flash image\n", QEMU_ARCH_ALL)
@@ -1354,6 +2470,10 @@ STEXI
@findex -pflash
Use @var{file} as a parallel flash image.
ETEXI
+SRST
+``-pflash file``
+ Use file as a parallel flash image.
+ERST
DEF("snapshot", 0, QEMU_OPTION_snapshot,
"-snapshot write to temporary files instead of disk image files\n",
@@ -1365,6 +2485,13 @@ Write to temporary files instead of disk image files. In this case,
the raw disk image you use is not written back. You can however force
the write back by pressing @key{C-a s} (@pxref{disk_images}).
ETEXI
+SRST
+``-snapshot``
+ Write to temporary files instead of disk image files. In this case,
+ the raw disk image you use is not written back. You can however
+ force the write back by pressing C-a s (see
+ :ref:`disk_005fimages`).
+ERST
DEF("fsdev", HAS_ARG, QEMU_OPTION_fsdev,
"-fsdev local,id=id,path=path,security_model=mapped-xattr|mapped-file|passthrough|none\n"
@@ -1466,6 +2593,112 @@ Specifies the tag name to be used by the guest to mount this export point.
@end table
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]``
+ Define a new file system device. Valid options are:
+
+ ``local``
+ Accesses to the filesystem are done by QEMU.
+
+ ``proxy``
+ Accesses to the filesystem are done by virtfs-proxy-helper(1).
+
+ ``synth``
+ Synthetic filesystem, only used by QTests.
+
+ ``id=id``
+ Specifies identifier for this device.
+
+ ``path=path``
+ Specifies the export path for the file system device. Files
+ under this path will be available to the 9p client on the guest.
+
+ ``security_model=security_model``
+ Specifies the security model to be used for this export path.
+ Supported security models are "passthrough", "mapped-xattr",
+ "mapped-file" and "none". In "passthrough" security model, files
+ are stored using the same credentials as they are created on the
+ guest. This requires QEMU to run as root. In "mapped-xattr"
+ security model, some of the file attributes like uid, gid, mode
+ bits and link target are stored as file attributes. For
+ "mapped-file" these attributes are stored in the hidden
+ .virtfs\_metadata directory. Directories exported by this
+ security model cannot interact with other unix tools. "none"
+ security model is same as passthrough except the sever won't
+ report failures if it fails to set file attributes like
+ ownership. Security model is mandatory only for local fsdriver.
+ Other fsdrivers (like proxy) don't take security model as a
+ parameter.
+
+ ``writeout=writeout``
+ This is an optional argument. The only supported value is
+ "immediate". This means that host page cache will be used to
+ read and write data but write notification will be sent to the
+ guest only when the data has been reported as written by the
+ storage subsystem.
+
+ ``readonly``
+ Enables exporting 9p share as a readonly mount for guests. By
+ default read-write access is given.
+
+ ``socket=socket``
+ Enables proxy filesystem driver to use passed socket file for
+ communicating with virtfs-proxy-helper(1).
+
+ ``sock_fd=sock_fd``
+ Enables proxy filesystem driver to use passed socket descriptor
+ for communicating with virtfs-proxy-helper(1). Usually a helper
+ like libvirt will create socketpair and pass one of the fds as
+ sock\_fd.
+
+ ``fmode=fmode``
+ Specifies the default mode for newly created files on the host.
+ Works only with security models "mapped-xattr" and
+ "mapped-file".
+
+ ``dmode=dmode``
+ Specifies the default mode for newly created directories on the
+ host. Works only with security models "mapped-xattr" and
+ "mapped-file".
+
+ ``throttling.bps-total=b,throttling.bps-read=r,throttling.bps-write=w``
+ Specify bandwidth throttling limits in bytes per second, either
+ for all request types or for reads or writes only.
+
+ ``throttling.bps-total-max=bm,bps-read-max=rm,bps-write-max=wm``
+ Specify bursts in bytes per second, either for all request types
+ or for reads or writes only. Bursts allow the guest I/O to spike
+ above the limit temporarily.
+
+ ``throttling.iops-total=i,throttling.iops-read=r, throttling.iops-write=w``
+ Specify request rate limits in requests per second, either for
+ all request types or for reads or writes only.
+
+ ``throttling.iops-total-max=im,throttling.iops-read-max=irm, throttling.iops-write-max=iwm``
+ Specify bursts in requests per second, either for all request
+ types or for reads or writes only. Bursts allow the guest I/O to
+ spike above the limit temporarily.
+
+ ``throttling.iops-size=is``
+ Let every is bytes of a request count as a new request for iops
+ throttling purposes.
+
+ -fsdev option is used along with -device driver "virtio-9p-...".
+
+``-device virtio-9p-type,fsdev=id,mount_tag=mount_tag``
+ Options for virtio-9p-... driver are:
+
+ ``type``
+ Specifies the variant to be used. Supported values are "pci",
+ "ccw" or "device", depending on the machine type.
+
+ ``fsdev=id``
+ Specifies the id value specified along with -fsdev option.
+
+ ``mount_tag=mount_tag``
+ Specifies the tag name to be used by the guest to mount this
+ export point.
+ERST
DEF("virtfs", HAS_ARG, QEMU_OPTION_virtfs,
"-virtfs local,path=path,mount_tag=tag,security_model=mapped-xattr|mapped-file|passthrough|none\n"
@@ -1557,6 +2790,107 @@ currently not block all possible file access operations (e.g. readdir()
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``
+ 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:
+
+ ``local``
+ Accesses to the filesystem are done by QEMU.
+
+ ``proxy``
+ Accesses to the filesystem are done by virtfs-proxy-helper(1).
+
+ ``synth``
+ Synthetic filesystem, only used by QTests.
+
+ ``id=id``
+ Specifies identifier for the filesystem device
+
+ ``path=path``
+ Specifies the export path for the file system device. Files
+ under this path will be available to the 9p client on the guest.
+
+ ``security_model=security_model``
+ Specifies the security model to be used for this export path.
+ Supported security models are "passthrough", "mapped-xattr",
+ "mapped-file" and "none". In "passthrough" security model, files
+ are stored using the same credentials as they are created on the
+ guest. This requires QEMU to run as root. In "mapped-xattr"
+ security model, some of the file attributes like uid, gid, mode
+ bits and link target are stored as file attributes. For
+ "mapped-file" these attributes are stored in the hidden
+ .virtfs\_metadata directory. Directories exported by this
+ security model cannot interact with other unix tools. "none"
+ security model is same as passthrough except the sever won't
+ report failures if it fails to set file attributes like
+ ownership. Security model is mandatory only for local fsdriver.
+ Other fsdrivers (like proxy) don't take security model as a
+ parameter.
+
+ ``writeout=writeout``
+ This is an optional argument. The only supported value is
+ "immediate". This means that host page cache will be used to
+ read and write data but write notification will be sent to the
+ guest only when the data has been reported as written by the
+ storage subsystem.
+
+ ``readonly``
+ Enables exporting 9p share as a readonly mount for guests. By
+ default read-write access is given.
+
+ ``socket=socket``
+ Enables proxy filesystem driver to use passed socket file for
+ communicating with virtfs-proxy-helper(1). Usually a helper like
+ libvirt will create socketpair and pass one of the fds as
+ sock\_fd.
+
+ ``sock_fd``
+ Enables proxy filesystem driver to use passed 'sock\_fd' as the
+ socket descriptor for interfacing with virtfs-proxy-helper(1).
+
+ ``fmode=fmode``
+ Specifies the default mode for newly created files on the host.
+ Works only with security models "mapped-xattr" and
+ "mapped-file".
+
+ ``dmode=dmode``
+ Specifies the default mode for newly created directories on the
+ host. Works only with security models "mapped-xattr" and
+ "mapped-file".
+
+ ``mount_tag=mount_tag``
+ Specifies the tag name to be used by the guest to mount this
+ export point.
+
+ ``multidevs=multidevs``
+ Specifies how to deal with multiple devices being shared with a
+ 9p export. Supported behaviours are either "remap", "forbid" or
+ "warn". The latter is the default behaviour on which virtfs 9p
+ expects only one device to be shared with the same export, and
+ if more than one device is shared and accessed via the same 9p
+ export then only a warning message is logged (once) by qemu on
+ host side. In order to avoid file ID collisions on guest you
+ should either create a separate virtfs export for each device to
+ be shared with guests (recommended way) or you might use "remap"
+ instead which allows you to share multiple devices with only one
+ export instead, which is achieved by remapping the original
+ inode numbers from host to guest in a way that would prevent
+ such collisions. Remapping inodes in such use cases is required
+ because the original device IDs from host are never passed and
+ exposed on guest. Instead all files of an export shared with
+ virtfs always share the same device id on guest. So two files
+ with identical inode numbers but from actually different devices
+ on host would otherwise cause a file ID collision and hence
+ potential misbehaviours on guest. "forbid" on the other hand
+ assumes like "warn" that only one device is shared by the same
+ export, however it will not only log a warning message but also
+ deny access to additional devices on guest. Note though that
+ "forbid" does currently not block all possible file access
+ operations (e.g. readdir() would still return entries from other
+ devices).
+ERST
DEF("iscsi", HAS_ARG, QEMU_OPTION_iscsi,
"-iscsi [user=user][,password=password]\n"
@@ -1570,6 +2904,10 @@ STEXI
@findex -iscsi
Configure iSCSI session parameters.
ETEXI
+SRST
+``-iscsi``
+ Configure iSCSI session parameters.
+ERST
STEXI
@end table
@@ -1592,6 +2930,13 @@ not enabled by default). Note that on-board USB host controllers may not
support USB 3.0. In this case @option{-device qemu-xhci} can be used instead
on machines with PCI.
ETEXI
+SRST
+``-usb``
+ Enable USB emulation on machine types with an on-board USB host
+ controller (if not enabled by default). Note that on-board USB host
+ controllers may not support USB 3.0. In this case
+ ``-device qemu-xhci`` can be used instead on machines with PCI.
+ERST
DEF("usbdevice", HAS_ARG, QEMU_OPTION_usbdevice,
"-usbdevice name add the host or guest USB device 'name'\n",
@@ -1619,6 +2964,26 @@ or fake device.
@end table
ETEXI
+SRST
+``-usbdevice devname``
+ Add the USB device devname. Note that this option is deprecated,
+ please use ``-device usb-...`` instead. See
+ :ref:`usb_005fdevices`.
+
+ ``mouse``
+ Virtual Mouse. This will override the PS/2 mouse emulation when
+ activated.
+
+ ``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.
+
+ ``braille``
+ Braille device. This will use BrlAPI to display the braille
+ output on a real or fake device.
+ERST
STEXI
@end table
@@ -1705,6 +3070,53 @@ application. The Spice server will redirect the serial consoles and
QEMU monitors. (Since 4.0)
@end table
ETEXI
+SRST
+``-display type``
+ Select type of display to use. This option is a replacement for the
+ old style -sdl/-curses/... options. Use ``-display help`` to list
+ the available display types. Valid values for type are
+
+ ``sdl``
+ Display video output via SDL (usually in a separate graphics
+ window; see the SDL documentation for other possibilities).
+
+ ``curses``
+ Display video output via curses. For graphics device models
+ which support a text mode, QEMU can display this output using a
+ curses/ncurses interface. Nothing is displayed when the graphics
+ device is in graphical mode or if the graphics device does not
+ support a text mode. Generally only the VGA device models
+ support text mode. The font charset used by the guest can be
+ specified with the ``charset`` option, for example
+ ``charset=CP850`` for IBM CP850 encoding. The default is
+ ``CP437``.
+
+ ``none``
+ Do not display video output. The guest will still see an
+ emulated graphics card, but its output will not be displayed to
+ the QEMU user. This option differs from the -nographic option in
+ that it only affects what is done with video output; -nographic
+ also changes the destination of the serial and parallel port
+ data.
+
+ ``gtk``
+ Display video output in a GTK window. This interface provides
+ drop-down menus and other UI elements to configure and control
+ the VM during runtime.
+
+ ``vnc``
+ Start a VNC server on display <arg>
+
+ ``egl-headless``
+ Offload all OpenGL operations to a local DRI device. For any
+ graphical display, this display needs to be paired with either
+ VNC or SPICE displays.
+
+ ``spice-app``
+ Start QEMU as a Spice server and launch the default Spice client
+ application. The Spice server will redirect the serial consoles
+ and QEMU monitors. (Since 4.0)
+ERST
DEF("nographic", 0, QEMU_OPTION_nographic,
"-nographic disable graphical output and redirect serial I/Os to console\n",
@@ -1721,6 +3133,17 @@ redirected elsewhere explicitly). Therefore, you can still use QEMU to
debug a Linux kernel with a serial console. Use @key{C-a h} for help on
switching between the console and monitor.
ETEXI
+SRST
+``-nographic``
+ Normally, if QEMU is compiled with graphical window support, it
+ displays output such as guest graphics, guest console, and the QEMU
+ monitor in a window. With this option, you can totally disable
+ graphical output so that QEMU is a simple command line application.
+ The emulated serial port is redirected on the console and muxed with
+ the monitor (unless redirected elsewhere explicitly). Therefore, you
+ can still use QEMU to debug a Linux kernel with a serial console.
+ Use C-a h for help on switching between the console and monitor.
+ERST
DEF("curses", 0, QEMU_OPTION_curses,
"-curses shorthand for -display curses\n",
@@ -1734,6 +3157,14 @@ window. With this option, QEMU can display the VGA output when in text
mode using a curses/ncurses interface. Nothing is displayed in graphical
mode.
ETEXI
+SRST
+``-curses``
+ Normally, if QEMU is compiled with graphical window support, it
+ displays output such as guest graphics, guest console, and the QEMU
+ monitor in a window. With this option, QEMU can display the VGA
+ output when in text mode using a curses/ncurses interface. Nothing
+ is displayed in graphical mode.
+ERST
DEF("alt-grab", 0, QEMU_OPTION_alt_grab,
"-alt-grab use Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt)\n",
@@ -1744,6 +3175,12 @@ STEXI
Use Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt). Note that this also
affects the special keys (for fullscreen, monitor-mode switching, etc).
ETEXI
+SRST
+``-alt-grab``
+ Use Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt). Note that
+ this also affects the special keys (for fullscreen, monitor-mode
+ switching, etc).
+ERST
DEF("ctrl-grab", 0, QEMU_OPTION_ctrl_grab,
"-ctrl-grab use Right-Ctrl to grab mouse (instead of Ctrl-Alt)\n",
@@ -1754,6 +3191,12 @@ STEXI
Use Right-Ctrl to grab mouse (instead of Ctrl-Alt). Note that this also
affects the special keys (for fullscreen, monitor-mode switching, etc).
ETEXI
+SRST
+``-ctrl-grab``
+ Use Right-Ctrl to grab mouse (instead of Ctrl-Alt). Note that this
+ also affects the special keys (for fullscreen, monitor-mode
+ switching, etc).
+ERST
DEF("no-quit", 0, QEMU_OPTION_no_quit,
"-no-quit disable SDL window close capability\n", QEMU_ARCH_ALL)
@@ -1762,6 +3205,10 @@ STEXI
@findex -no-quit
Disable SDL window close capability.
ETEXI
+SRST
+``-no-quit``
+ Disable SDL window close capability.
+ERST
DEF("sdl", 0, QEMU_OPTION_sdl,
"-sdl shorthand for -display sdl\n", QEMU_ARCH_ALL)
@@ -1770,6 +3217,10 @@ STEXI
@findex -sdl
Enable SDL.
ETEXI
+SRST
+``-sdl``
+ Enable SDL.
+ERST
DEF("spice", HAS_ARG, QEMU_OPTION_spice,
"-spice [port=port][,tls-port=secured-port][,x509-dir=<dir>]\n"
@@ -1887,6 +3338,95 @@ the first available. (Since 2.9)
@end table
ETEXI
+SRST
+``-spice option[,option[,...]]``
+ Enable the spice remote desktop protocol. Valid options are
+
+ ``port=<nr>``
+ Set the TCP port spice is listening on for plaintext channels.
+
+ ``addr=<addr>``
+ Set the IP address spice is listening on. Default is any
+ address.
+
+ ``ipv4``; \ ``ipv6``; \ ``unix``
+ Force using the specified IP version.
+
+ ``password=<secret>``
+ Set the password you need to authenticate.
+
+ ``sasl``
+ Require that the client use SASL to authenticate with the spice.
+ The exact choice of authentication method used is controlled
+ from the system / user's SASL configuration file for the 'qemu'
+ service. This is typically found in /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. While some SASL auth methods
+ can also provide data encryption (eg GSSAPI), it is recommended
+ that SASL always be combined with the 'tls' and 'x509' settings
+ to enable use of SSL and server certificates. This ensures a
+ data encryption preventing compromise of authentication
+ credentials.
+
+ ``disable-ticketing``
+ Allow client connects without authentication.
+
+ ``disable-copy-paste``
+ Disable copy paste between the client and the guest.
+
+ ``disable-agent-file-xfer``
+ Disable spice-vdagent based file-xfer between the client and the
+ guest.
+
+ ``tls-port=<nr>``
+ Set the TCP port spice is listening on for encrypted channels.
+
+ ``x509-dir=<dir>``
+ Set the x509 file directory. Expects same filenames as -vnc
+ $display,x509=$dir
+
+ ``x509-key-file=<file>``; \ ``x509-key-password=<file>``; \ ``x509-cert-file=<file>``; \ ``x509-cacert-file=<file>``; \ ``x509-dh-key-file=<file>``
+ The x509 file names can also be configured individually.
+
+ ``tls-ciphers=<list>``
+ Specify which ciphers to use.
+
+ ``tls-channel=[main|display|cursor|inputs|record|playback]``; \ ``plaintext-channel=[main|display|cursor|inputs|record|playback]``
+ Force specific channel to be used with or without TLS
+ encryption. The options can be specified multiple times to
+ configure multiple channels. The special name "default" can be
+ used to set the default mode. For channels which are not
+ explicitly forced into one mode the spice client is allowed to
+ pick tls/plaintext as he pleases.
+
+ ``image-compression=[auto_glz|auto_lz|quic|glz|lz|off]``
+ Configure image compression (lossless). Default is auto\_glz.
+
+ ``jpeg-wan-compression=[auto|never|always]``; \ ``zlib-glz-wan-compression=[auto|never|always]``
+ Configure wan image compression (lossy for slow links). Default
+ is auto.
+
+ ``streaming-video=[off|all|filter]``
+ Configure video stream detection. Default is off.
+
+ ``agent-mouse=[on|off]``
+ Enable/disable passing mouse events via vdagent. Default is on.
+
+ ``playback-compression=[on|off]``
+ Enable/disable audio stream compression (using celt 0.5.1).
+ Default is on.
+
+ ``seamless-migration=[on|off]``
+ Enable/disable spice seamless migration. Default is off.
+
+ ``gl=[on|off]``
+ Enable/disable OpenGL context. Default is off.
+
+ ``rendernode=<file>``
+ DRM render node for OpenGL rendering. If not specified, it will
+ pick the first available. (Since 2.9)
+ERST
DEF("portrait", 0, QEMU_OPTION_portrait,
"-portrait rotate graphical output 90 deg left (only PXA LCD)\n",
@@ -1896,6 +3436,10 @@ STEXI
@findex -portrait
Rotate graphical output 90 deg left (only PXA LCD).
ETEXI
+SRST
+``-portrait``
+ Rotate graphical output 90 deg left (only PXA LCD).
+ERST
DEF("rotate", HAS_ARG, QEMU_OPTION_rotate,
"-rotate <deg> rotate graphical output some deg left (only PXA LCD)\n",
@@ -1905,6 +3449,10 @@ STEXI
@findex -rotate
Rotate graphical output some deg left (only PXA LCD).
ETEXI
+SRST
+``-rotate deg``
+ Rotate graphical output some deg left (only PXA LCD).
+ERST
DEF("vga", HAS_ARG, QEMU_OPTION_vga,
"-vga [std|cirrus|vmware|qxl|xenfb|tcx|cg3|virtio|none]\n"
@@ -1946,6 +3494,51 @@ Virtio VGA card.
Disable VGA card.
@end table
ETEXI
+SRST
+``-vga type``
+ Select type of VGA card to emulate. Valid values for type are
+
+ ``cirrus``
+ Cirrus Logic GD5446 Video card. All Windows versions starting
+ from Windows 95 should recognize and use this graphic card. For
+ optimal performances, use 16 bit color depth in the guest and
+ the host OS. (This card was the default before QEMU 2.2)
+
+ ``std``
+ Standard VGA card with Bochs VBE extensions. If your guest OS
+ supports the VESA 2.0 VBE extensions (e.g. Windows XP) and if
+ you want to use high resolution modes (>= 1280x1024x16) then you
+ should use this option. (This card is the default since QEMU
+ 2.2)
+
+ ``vmware``
+ VMWare SVGA-II compatible adapter. Use it if you have
+ sufficiently recent XFree86/XOrg server or Windows guest with a
+ driver for this card.
+
+ ``qxl``
+ QXL paravirtual graphic card. It is VGA compatible (including
+ VESA 2.0 VBE support). Works best with qxl guest drivers
+ installed though. Recommended choice when using the spice
+ protocol.
+
+ ``tcx``
+ (sun4m only) Sun TCX framebuffer. This is the default
+ framebuffer for sun4m machines and offers both 8-bit and 24-bit
+ colour depths at a fixed resolution of 1024x768.
+
+ ``cg3``
+ (sun4m only) Sun cgthree framebuffer. This is a simple 8-bit
+ framebuffer for sun4m machines available in both 1024x768
+ (OpenBIOS) and 1152x900 (OBP) resolutions aimed at people
+ wishing to run older Solaris versions.
+
+ ``virtio``
+ Virtio VGA card.
+
+ ``none``
+ Disable VGA card.
+ERST
DEF("full-screen", 0, QEMU_OPTION_full_screen,
"-full-screen start in full screen\n", QEMU_ARCH_ALL)
@@ -1954,6 +3547,10 @@ STEXI
@findex -full-screen
Start in full screen.
ETEXI
+SRST
+``-full-screen``
+ Start in full screen.
+ERST
DEF("g", HAS_ARG, QEMU_OPTION_g ,
"-g WxH[xDEPTH] Set the initial graphical resolution and depth\n",
@@ -1970,6 +3567,17 @@ option of 1024x768x24. For cgthree, the default is 1024x768x8 with the option
of 1152x900x8 for people who wish to use OBP.
ETEXI
+SRST
+``-g widthxheight[xdepth]``
+ 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.
+ERST
DEF("vnc", HAS_ARG, QEMU_OPTION_vnc ,
"-vnc <display> shorthand for -display vnc=<display>\n", QEMU_ARCH_ALL)
@@ -2155,6 +3763,171 @@ be omitted, otherwise is must be present and specify a valid audiodev.
@end table
ETEXI
+SRST
+``-vnc display[,option[,option[,...]]]``
+ Normally, if QEMU is compiled with graphical window support, it
+ displays output such as guest graphics, guest console, and the QEMU
+ monitor in a window. With this option, you can have QEMU listen on
+ VNC display display and redirect the VGA display over the VNC
+ session. It is very useful to enable the usb tablet device when
+ using this option (option ``-device usb-tablet``). When using the
+ VNC display, you must use the ``-k`` parameter to set the keyboard
+ layout if you are not using en-us. Valid syntax for the display is
+
+ ``to=L``
+ With this option, QEMU will try next available VNC displays,
+ until the number L, if the origianlly defined "-vnc display" is
+ not available, e.g. port 5900+display is already used by another
+ application. By default, to=0.
+
+ ``host:d``
+ TCP connections will only be allowed from host on display d. By
+ convention the TCP port is 5900+d. Optionally, host can be
+ omitted in which case the server will accept connections from
+ any host.
+
+ ``unix:path``
+ Connections will be allowed over UNIX domain sockets where path
+ is the location of a unix socket to listen for connections on.
+
+ ``none``
+ VNC is initialized but not started. The monitor ``change``
+ command can be used to later start the VNC server.
+
+ Following the display value there may be one or more option flags
+ separated by commas. Valid options are
+
+ ``reverse``
+ Connect to a listening VNC client via a "reverse" connection.
+ The client is specified by the display. For reverse network
+ connections (host:d,``reverse``), the d argument is a TCP port
+ number, not a display number.
+
+ ``websocket``
+ Opens an additional TCP listening port dedicated to VNC
+ Websocket connections. If a bare websocket option is given, the
+ Websocket port is 5700+display. An alternative port can be
+ specified with the syntax ``websocket``\ =port.
+
+ If host is specified connections will only be allowed from this
+ host. It is possible to control the websocket listen address
+ independently, using the syntax ``websocket``\ =host:port.
+
+ If no TLS credentials are provided, the websocket connection
+ runs in unencrypted mode. If TLS credentials are provided, the
+ websocket connection requires encrypted client connections.
+
+ ``password``
+ Require that password based authentication is used for client
+ connections.
+
+ The password must be set separately using the ``set_password``
+ command in the :ref:`pcsys_005fmonitor`. The
+ syntax to change your password is:
+ ``set_password <protocol> <password>`` where <protocol> could be
+ either "vnc" or "spice".
+
+ If you would like to change <protocol> password expiration, you
+ should use ``expire_password <protocol> <expiration-time>``
+ where expiration time could be one of the following options:
+ now, never, +seconds or UNIX time of expiration, e.g. +60 to
+ make password expire in 60 seconds, or 1335196800 to make
+ password expire on "Mon Apr 23 12:00:00 EDT 2012" (UNIX time for
+ this date and time).
+
+ You can also use keywords "now" or "never" for the expiration
+ time to allow <protocol> password to expire immediately or never
+ expire.
+
+ ``tls-creds=ID``
+ Provides the ID of a set of TLS credentials to use to secure the
+ VNC server. They will apply to both the normal VNC server socket
+ and the websocket socket (if enabled). Setting TLS credentials
+ will cause the VNC server socket to enable the VeNCrypt auth
+ mechanism. The credentials should have been previously created
+ using the ``-object tls-creds`` argument.
+
+ ``tls-authz=ID``
+ Provides the ID of the QAuthZ authorization object against which
+ the client's x509 distinguished name will validated. This object
+ is only resolved at time of use, so can be deleted and recreated
+ on the fly while the VNC server is active. If missing, it will
+ default to denying access.
+
+ ``sasl``
+ Require that the client use SASL to authenticate with the VNC
+ server. The exact choice of authentication method used is
+ controlled from the system / user's SASL configuration file for
+ the 'qemu' service. This is typically found in
+ /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. While some
+ SASL auth methods can also provide data encryption (eg GSSAPI),
+ it is recommended that SASL always be combined with the 'tls'
+ and 'x509' settings to enable use of SSL and server
+ certificates. This ensures a data encryption preventing
+ compromise of authentication credentials. See the
+ :ref:`vnc_005fsecurity` section for details on
+ using SASL authentication.
+
+ ``sasl-authz=ID``
+ Provides the ID of the QAuthZ authorization object against which
+ the client's SASL username will validated. This object is only
+ resolved at time of use, so can be deleted and recreated on the
+ fly while the VNC server is active. If missing, it will default
+ to denying access.
+
+ ``acl``
+ Legacy method for enabling authorization of clients against the
+ x509 distinguished name and SASL username. It results in the
+ creation of two ``authz-list`` objects with IDs of
+ ``vnc.username`` and ``vnc.x509dname``. The rules for these
+ objects must be configured with the HMP ACL commands.
+
+ This option is deprecated and should no longer be used. The new
+ ``sasl-authz`` and ``tls-authz`` options are a replacement.
+
+ ``lossy``
+ Enable lossy compression methods (gradient, JPEG, ...). If this
+ option is set, VNC client may receive lossy framebuffer updates
+ depending on its encoding settings. Enabling this option can
+ save a lot of bandwidth at the expense of quality.
+
+ ``non-adaptive``
+ Disable adaptive encodings. Adaptive encodings are enabled by
+ default. An adaptive encoding will try to detect frequently
+ updated screen regions, and send updates in these regions using
+ a lossy encoding (like JPEG). This can be really helpful to save
+ bandwidth when playing videos. Disabling adaptive encodings
+ restores the original static behavior of encodings like Tight.
+
+ ``share=[allow-exclusive|force-shared|ignore]``
+ Set display sharing policy. 'allow-exclusive' allows clients to
+ ask for exclusive access. As suggested by the rfb spec this is
+ implemented by dropping other connections. Connecting multiple
+ clients in parallel requires all clients asking for a shared
+ session (vncviewer: -shared switch). This is the default.
+ 'force-shared' disables exclusive client access. Useful for
+ shared desktop sessions, where you don't want someone forgetting
+ specify -shared disconnect everybody else. 'ignore' completely
+ ignores the shared flag and allows everybody connect
+ unconditionally. Doesn't conform to the rfb spec but is
+ traditional QEMU behavior.
+
+ ``key-delay-ms``
+ Set keyboard delay, for key down and key up events, in
+ milliseconds. Default is 10. Keyboards are low-bandwidth
+ devices, so this slowdown can help the device and guest to keep
+ up and not lose events in case events are arriving in bulk.
+ Possible causes for the latter are flaky network connections, or
+ scripts for automated testing.
+
+ ``audiodev=audiodev``
+ Use the specified audiodev when the VNC client requests audio
+ transmission. When not using an -audiodev argument, this option
+ must be omitted, otherwise is must be present and specify a
+ valid audiodev.
+ERST
STEXI
@end table
@@ -2176,6 +3949,12 @@ Use it when installing Windows 2000 to avoid a disk full bug. After
Windows 2000 is installed, you no longer need this option (this option
slows down the IDE transfers).
ETEXI
+SRST
+``-win2k-hack``
+ Use it when installing Windows 2000 to avoid a disk full bug. After
+ Windows 2000 is installed, you no longer need this option (this
+ option slows down the IDE transfers).
+ERST
DEF("no-fd-bootchk", 0, QEMU_OPTION_no_fd_bootchk,
"-no-fd-bootchk disable boot signature checking for floppy disks\n",
@@ -2186,6 +3965,11 @@ STEXI
Disable boot signature checking for floppy disks in BIOS. May
be needed to boot from old floppy disks.
ETEXI
+SRST
+``-no-fd-bootchk``
+ Disable boot signature checking for floppy disks in BIOS. May be
+ needed to boot from old floppy disks.
+ERST
DEF("no-acpi", 0, QEMU_OPTION_no_acpi,
"-no-acpi disable ACPI\n", QEMU_ARCH_I386 | QEMU_ARCH_ARM)
@@ -2196,6 +3980,12 @@ Disable ACPI (Advanced Configuration and Power Interface) support. Use
it if your guest OS complains about ACPI problems (PC target machine
only).
ETEXI
+SRST
+``-no-acpi``
+ Disable ACPI (Advanced Configuration and Power Interface) support.
+ Use it if your guest OS complains about ACPI problems (PC target
+ machine only).
+ERST
DEF("no-hpet", 0, QEMU_OPTION_no_hpet,
"-no-hpet disable HPET\n", QEMU_ARCH_I386)
@@ -2204,6 +3994,10 @@ STEXI
@findex -no-hpet
Disable HPET support.
ETEXI
+SRST
+``-no-hpet``
+ Disable HPET support.
+ERST
DEF("acpitable", HAS_ARG, QEMU_OPTION_acpitable,
"-acpitable [sig=str][,rev=n][,oem_id=str][,oem_table_id=str][,oem_rev=n][,asl_compiler_id=str][,asl_compiler_rev=n][,{data|file}=file1[:file2]...]\n"
@@ -2222,6 +4016,18 @@ fields will override the same in the RSDT and the FADT (a.k.a. FACP), in order
to ensure the field matches required by the Microsoft SLIC spec and the ACPI
spec.
ETEXI
+SRST
+``-acpitable [sig=str][,rev=n][,oem_id=str][,oem_table_id=str][,oem_rev=n] [,asl_compiler_id=str][,asl_compiler_rev=n][,data=file1[:file2]...]``
+ Add ACPI table with specified header fields and context from
+ specified files. For file=, take whole ACPI table from the specified
+ files, including all ACPI headers (possible overridden by other
+ options). For data=, only data portion of the table is used, all
+ header information is specified in the command line. If a SLIC table
+ is supplied to QEMU, then the SLIC's oem\_id and oem\_table\_id
+ fields will override the same in the RSDT and the FADT (a.k.a.
+ FACP), in order to ensure the field matches required by the
+ Microsoft SLIC spec and the ACPI spec.
+ERST
DEF("smbios", HAS_ARG, QEMU_OPTION_smbios,
"-smbios file=binary\n"
@@ -2268,6 +4074,28 @@ Specify SMBIOS type 4 fields
@item -smbios type=17[,loc_pfx=@var{str}][,bank=@var{str}][,manufacturer=@var{str}][,serial=@var{str}][,asset=@var{str}][,part=@var{str}][,speed=@var{%d}]
Specify SMBIOS type 17 fields
ETEXI
+SRST
+``-smbios file=binary``
+ Load SMBIOS entry from binary file.
+
+``-smbios type=0[,vendor=str][,version=str][,date=str][,release=%d.%d][,uefi=on|off]``
+ Specify SMBIOS type 0 fields
+
+``-smbios type=1[,manufacturer=str][,product=str][,version=str][,serial=str][,uuid=uuid][,sku=str][,family=str]``
+ Specify SMBIOS type 1 fields
+
+``-smbios type=2[,manufacturer=str][,product=str][,version=str][,serial=str][,asset=str][,location=str]``
+ Specify SMBIOS type 2 fields
+
+``-smbios type=3[,manufacturer=str][,version=str][,serial=str][,asset=str][,sku=str]``
+ Specify SMBIOS type 3 fields
+
+``-smbios type=4[,sock_pfx=str][,manufacturer=str][,version=str][,serial=str][,asset=str][,part=str]``
+ Specify SMBIOS type 4 fields
+
+``-smbios type=17[,loc_pfx=str][,bank=str][,manufacturer=str][,serial=str][,asset=str][,part=str][,speed=%d]``
+ Specify SMBIOS type 17 fields
+ERST
STEXI
@end table
@@ -2866,6 +4694,470 @@ Configure a host network backend (with the options corresponding to the same
@option{-netdev} option) and connect it to the emulated hub 0 (the default
hub). Use @var{name} to specify the name of the hub port.
ETEXI
+SRST
+``-nic [tap|bridge|user|l2tpv3|vde|netmap|vhost-user|socket][,...][,mac=macaddr][,model=mn]``
+ This option is a shortcut for configuring both the on-board
+ (default) guest NIC hardware and the host network backend in one go.
+ The host backend options are the same as with the corresponding
+ ``-netdev`` options below. The guest NIC model can be set with
+ ``model=modelname``. Use ``model=help`` to list the available device
+ types. The hardware MAC address can be set with ``mac=macaddr``.
+
+ The following two example do exactly the same, to show how ``-nic``
+ can be used to shorten the command line length:
+
+ .. parsed-literal::
+
+ |qemu_system| -netdev user,id=n1,ipv6=off -device e1000,netdev=n1,mac=52:54:98:76:54:32
+ |qemu_system| -nic user,ipv6=off,model=e1000,mac=52:54:98:76:54:32
+
+``-nic none``
+ Indicate that no network devices should be configured. It is used to
+ override the default configuration (default NIC with "user" host
+ network backend) which is activated if no other networking options
+ are provided.
+
+``-netdev user,id=id[,option][,option][,...]``
+ Configure user mode host network backend which requires no
+ administrator privilege to run. Valid options are:
+
+ ``id=id``
+ Assign symbolic name for use in monitor commands.
+
+ ``ipv4=on|off and ipv6=on|off``
+ Specify that either IPv4 or IPv6 must be enabled. If neither is
+ specified both protocols are enabled.
+
+ ``net=addr[/mask]``
+ Set IP network address the guest will see. Optionally specify
+ the netmask, either in the form a.b.c.d or as number of valid
+ top-most bits. Default is 10.0.2.0/24.
+
+ ``host=addr``
+ Specify the guest-visible address of the host. Default is the
+ 2nd IP in the guest network, i.e. x.x.x.2.
+
+ ``ipv6-net=addr[/int]``
+ Set IPv6 network address the guest will see (default is
+ fec0::/64). The network prefix is given in the usual hexadecimal
+ IPv6 address notation. The prefix size is optional, and is given
+ as the number of valid top-most bits (default is 64).
+
+ ``ipv6-host=addr``
+ Specify the guest-visible IPv6 address of the host. Default is
+ the 2nd IPv6 in the guest network, i.e. xxxx::2.
+
+ ``restrict=on|off``
+ If this option is enabled, the guest will be isolated, i.e. it
+ will not be able to contact the host and no guest IP packets
+ will be routed over the host to the outside. This option does
+ not affect any explicitly set forwarding rules.
+
+ ``hostname=name``
+ Specifies the client hostname reported by the built-in DHCP
+ server.
+
+ ``dhcpstart=addr``
+ Specify the first of the 16 IPs the built-in DHCP server can
+ assign. Default is the 15th to 31st IP in the guest network,
+ i.e. x.x.x.15 to x.x.x.31.
+
+ ``dns=addr``
+ Specify the guest-visible address of the virtual nameserver. The
+ address must be different from the host address. Default is the
+ 3rd IP in the guest network, i.e. x.x.x.3.
+
+ ``ipv6-dns=addr``
+ Specify the guest-visible address of the IPv6 virtual
+ nameserver. The address must be different from the host address.
+ Default is the 3rd IP in the guest network, i.e. xxxx::3.
+
+ ``dnssearch=domain``
+ Provides an entry for the domain-search list sent by the
+ built-in DHCP server. More than one domain suffix can be
+ transmitted by specifying this option multiple times. If
+ supported, this will cause the guest to automatically try to
+ append the given domain suffix(es) in case a domain name can not
+ be resolved.
+
+ Example:
+
+ .. parsed-literal::
+
+ |qemu_system| -nic user,dnssearch=mgmt.example.org,dnssearch=example.org
+
+ ``domainname=domain``
+ Specifies the client domain name reported by the built-in DHCP
+ server.
+
+ ``tftp=dir``
+ When using the user mode network stack, activate a built-in TFTP
+ server. The files in dir will be exposed as the root of a TFTP
+ server. The TFTP client on the guest must be configured in
+ binary mode (use the command ``bin`` of the Unix TFTP client).
+
+ ``tftp-server-name=name``
+ In BOOTP reply, broadcast name as the "TFTP server name"
+ (RFC2132 option 66). This can be used to advise the guest to
+ load boot files or configurations from a different server than
+ the host address.
+
+ ``bootfile=file``
+ When using the user mode network stack, broadcast file as the
+ BOOTP filename. In conjunction with ``tftp``, this can be used
+ to network boot a guest from a local directory.
+
+ Example (using pxelinux):
+
+ .. parsed-literal::
+
+ |qemu_system| -hda linux.img -boot n -device e1000,netdev=n1 \
+ -netdev user,id=n1,tftp=/path/to/tftp/files,bootfile=/pxelinux.0
+
+ ``smb=dir[,smbserver=addr]``
+ When using the user mode network stack, activate a built-in SMB
+ server so that Windows OSes can access to the host files in
+ ``dir`` transparently. The IP address of the SMB server can be
+ set to addr. By default the 4th IP in the guest network is used,
+ i.e. x.x.x.4.
+
+ In the guest Windows OS, the line:
+
+ ::
+
+ 10.0.2.4 smbserver
+
+ must be added in the file ``C:\WINDOWS\LMHOSTS`` (for windows
+ 9x/Me) or ``C:\WINNT\SYSTEM32\DRIVERS\ETC\LMHOSTS`` (Windows
+ NT/2000).
+
+ Then ``dir`` can be accessed in ``\\smbserver\qemu``.
+
+ Note that a SAMBA server must be installed on the host OS.
+
+ ``hostfwd=[tcp|udp]:[hostaddr]:hostport-[guestaddr]:guestport``
+ Redirect incoming TCP or UDP connections to the host port
+ hostport to the guest IP address guestaddr on guest port
+ guestport. If guestaddr is not specified, its value is x.x.x.15
+ (default first address given by the built-in DHCP server). By
+ specifying hostaddr, the rule can be bound to a specific host
+ interface. If no connection type is set, TCP is used. This
+ option can be given multiple times.
+
+ For example, to redirect host X11 connection from screen 1 to
+ guest screen 0, use the following:
+
+ ::
+
+ # on the host
+ |qemu_system| -nic user,hostfwd=tcp:127.0.0.1:6001-:6000
+ # this host xterm should open in the guest X11 server
+ xterm -display :1
+
+ To redirect telnet connections from host port 5555 to telnet
+ port on the guest, use the following:
+
+ ::
+
+ # on the host
+ |qemu_system| -nic user,hostfwd=tcp::5555-:23
+ telnet localhost 5555
+
+ Then when you use on the host ``telnet localhost 5555``, you
+ connect to the guest telnet server.
+
+ ``guestfwd=[tcp]:server:port-dev``; \ ``guestfwd=[tcp]:server:port-cmd:command``
+ Forward guest TCP connections to the IP address server on port
+ port to the character device dev or to a program executed by
+ cmd:command which gets spawned for each connection. This option
+ can be given multiple times.
+
+ You can either use a chardev directly and have that one used
+ throughout QEMU's lifetime, like in the following example:
+
+ ::
+
+ # open 10.10.1.1:4321 on bootup, connect 10.0.2.100:1234 to it whenever
+ # the guest accesses it
+ |qemu_system| -nic user,guestfwd=tcp:10.0.2.100:1234-tcp:10.10.1.1:4321
+
+ Or you can execute a command on every TCP connection established
+ by the guest, so that QEMU behaves similar to an inetd process
+ for that virtual server:
+
+ ::
+
+ # 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
+ |qemu_system| -nic 'user,id=n1,guestfwd=tcp:10.0.2.100:1234-cmd:netcat 10.10.1.1 4321'
+
+``-netdev tap,id=id[,fd=h][,ifname=name][,script=file][,downscript=dfile][,br=bridge][,helper=helper]``
+ Configure a host TAP network backend with ID id.
+
+ Use the network script file to configure it and the network script
+ dfile to deconfigure it. If name is not provided, the OS
+ automatically provides one. The default network configure script is
+ ``/etc/qemu-ifup`` and the default network deconfigure script is
+ ``/etc/qemu-ifdown``. Use ``script=no`` or ``downscript=no`` to
+ disable script execution.
+
+ If running QEMU as an unprivileged user, use the network helper
+ helper to configure the TAP interface and attach it to the bridge.
+ The default network helper executable is
+ ``/path/to/qemu-bridge-helper`` and the default bridge device is
+ ``br0``.
+
+ ``fd``\ =h can be used to specify the handle of an already opened
+ host TAP interface.
+
+ Examples:
+
+ ::
+
+ #launch a QEMU instance with the default network script
+ |qemu_system| linux.img -nic tap
+
+ ::
+
+ #launch a QEMU instance with two NICs, each one connected
+ #to a TAP device
+ |qemu_system| linux.img \
+ -netdev tap,id=nd0,ifname=tap0 -device e1000,netdev=nd0 \
+ -netdev tap,id=nd1,ifname=tap1 -device rtl8139,netdev=nd1
+
+ ::
+
+ #launch a QEMU instance with the default network helper to
+ #connect a TAP device to bridge br0
+ |qemu_system| linux.img -device virtio-net-pci,netdev=n1 \
+ -netdev tap,id=n1,"helper=/path/to/qemu-bridge-helper"
+
+``-netdev bridge,id=id[,br=bridge][,helper=helper]``
+ Connect a host TAP network interface to a host bridge device.
+
+ Use the network helper helper to configure the TAP interface and
+ attach it to the bridge. The default network helper executable is
+ ``/path/to/qemu-bridge-helper`` and the default bridge device is
+ ``br0``.
+
+ Examples:
+
+ ::
+
+ #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
+
+ ::
+
+ #launch a QEMU instance with the default network helper to
+ #connect a TAP device to bridge qemubr0
+ |qemu_system| linux.img -netdev bridge,br=qemubr0,id=n1 -device virtio-net,netdev=n1
+
+``-netdev socket,id=id[,fd=h][,listen=[host]:port][,connect=host:port]``
+ This host network backend can be used to connect the guest's network
+ to another QEMU virtual machine using a TCP socket connection. If
+ ``listen`` is specified, QEMU waits for incoming connections on port
+ (host is optional). ``connect`` is used to connect to another QEMU
+ instance using the ``listen`` option. ``fd``\ =h specifies an
+ already opened TCP socket.
+
+ Example:
+
+ ::
+
+ # launch a first QEMU instance
+ |qemu_system| linux.img \
+ -device e1000,netdev=n1,mac=52:54:00:12:34:56 \
+ -netdev socket,id=n1,listen=:1234
+ # connect the network of this instance to the network of the first instance
+ |qemu_system| linux.img \
+ -device e1000,netdev=n2,mac=52:54:00:12:34:57 \
+ -netdev socket,id=n2,connect=127.0.0.1:1234
+
+``-netdev socket,id=id[,fd=h][,mcast=maddr:port[,localaddr=addr]]``
+ Configure a socket host network backend to share the guest's network
+ traffic with another QEMU virtual machines using a UDP multicast
+ socket, effectively making a bus for every QEMU with same multicast
+ address maddr and port. NOTES:
+
+ 1. Several QEMU can be running on different hosts and share same bus
+ (assuming correct multicast setup for these hosts).
+
+ 2. mcast support is compatible with User Mode Linux (argument
+ ``ethN=mcast``), see http://user-mode-linux.sf.net.
+
+ 3. Use ``fd=h`` to specify an already opened UDP multicast socket.
+
+ Example:
+
+ ::
+
+ # launch one QEMU instance
+ |qemu_system| linux.img \
+ -device e1000,netdev=n1,mac=52:54:00:12:34:56 \
+ -netdev socket,id=n1,mcast=230.0.0.1:1234
+ # launch another QEMU instance on same "bus"
+ |qemu_system| linux.img \
+ -device e1000,netdev=n2,mac=52:54:00:12:34:57 \
+ -netdev socket,id=n2,mcast=230.0.0.1:1234
+ # launch yet another QEMU instance on same "bus"
+ |qemu_system| linux.img \
+ -device e1000,netdev=n3,mac=52:54:00:12:34:58 \
+ -netdev socket,id=n3,mcast=230.0.0.1:1234
+
+ Example (User Mode Linux compat.):
+
+ ::
+
+ # launch QEMU instance (note mcast address selected is UML's default)
+ |qemu_system| linux.img \
+ -device e1000,netdev=n1,mac=52:54:00:12:34:56 \
+ -netdev socket,id=n1,mcast=239.192.168.1:1102
+ # launch UML
+ /path/to/linux ubd0=/path/to/root_fs eth0=mcast
+
+ Example (send packets from host's 1.2.3.4):
+
+ .. parsed-literal::
+
+ |qemu_system| linux.img \
+ -device e1000,netdev=n1,mac=52:54:00:12:34:56 \
+ -netdev socket,id=n1,mcast=239.192.168.1:1102,localaddr=1.2.3.4
+
+``-netdev l2tpv3,id=id,src=srcaddr,dst=dstaddr[,srcport=srcport][,dstport=dstport],txsession=txsession[,rxsession=rxsession][,ipv6][,udp][,cookie64][,counter][,pincounter][,txcookie=txcookie][,rxcookie=rxcookie][,offset=offset]``
+ Configure a L2TPv3 pseudowire host network backend. L2TPv3 (RFC3391)
+ is a popular protocol to transport Ethernet (and other Layer 2) data
+ frames between two systems. It is present in routers, firewalls and
+ the Linux kernel (from version 3.3 onwards).
+
+ This transport allows a VM to communicate to another VM, router or
+ firewall directly.
+
+ ``src=srcaddr``
+ source address (mandatory)
+
+ ``dst=dstaddr``
+ destination address (mandatory)
+
+ ``udp``
+ select udp encapsulation (default is ip).
+
+ ``srcport=srcport``
+ source udp port.
+
+ ``dstport=dstport``
+ destination udp port.
+
+ ``ipv6``
+ force v6, otherwise defaults to v4.
+
+ ``rxcookie=rxcookie``; \ ``txcookie=txcookie``
+ Cookies are a weak form of security in the l2tpv3 specification.
+ Their function is mostly to prevent misconfiguration. By default
+ they are 32 bit.
+
+ ``cookie64``
+ Set cookie size to 64 bit instead of the default 32
+
+ ``counter=off``
+ Force a 'cut-down' L2TPv3 with no counter as in
+ draft-mkonstan-l2tpext-keyed-ipv6-tunnel-00
+
+ ``pincounter=on``
+ Work around broken counter handling in peer. This may also help
+ on networks which have packet reorder.
+
+ ``offset=offset``
+ Add an extra offset between header and data
+
+ 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:
+
+ ::
+
+ # Setup tunnel on linux host using raw ip as encapsulation
+ # on 1.2.3.4
+ ip l2tp add tunnel remote 4.3.2.1 local 1.2.3.4 tunnel_id 1 peer_tunnel_id 1 \
+ encap udp udp_sport 16384 udp_dport 16384
+ ip l2tp add session tunnel_id 1 name vmtunnel0 session_id \
+ 0xFFFFFFFF peer_session_id 0xFFFFFFFF
+ ifconfig vmtunnel0 mtu 1500
+ ifconfig vmtunnel0 up
+ brctl addif br-lan vmtunnel0
+
+
+ # on 4.3.2.1
+ # launch QEMU instance - if your network has reorder or is very lossy add ,pincounter
+
+ |qemu_system| linux.img -device e1000,netdev=n1 \
+ -netdev l2tpv3,id=n1,src=4.2.3.1,dst=1.2.3.4,udp,srcport=16384,dstport=16384,rxsession=0xffffffff,txsession=0xffffffff,counter
+
+``-netdev vde,id=id[,sock=socketpath][,port=n][,group=groupname][,mode=octalmode]``
+ Configure VDE backend to connect to PORT n of a vde switch running
+ on host and listening for incoming connections on socketpath. Use
+ GROUP groupname and MODE octalmode to change default ownership and
+ permissions for communication port. This option is only available if
+ QEMU has been compiled with vde support enabled.
+
+ Example:
+
+ ::
+
+ # launch vde switch
+ vde_switch -F -sock /tmp/myswitch
+ # launch QEMU instance
+ |qemu_system| linux.img -nic vde,sock=/tmp/myswitch
+
+``-netdev vhost-user,chardev=id[,vhostforce=on|off][,queues=n]``
+ Establish a vhost-user netdev, backed by a chardev id. The chardev
+ should be a unix domain socket backed one. The vhost-user uses a
+ specifically defined protocol to pass vhost ioctl replacement
+ messages to an application on the other end of the socket. On
+ non-MSIX guests, the feature can be forced with vhostforce. Use
+ 'queues=n' to specify the number of queues to be created for
+ multiqueue vhost-user.
+
+ Example:
+
+ ::
+
+ qemu -m 512 -object memory-backend-file,id=mem,size=512M,mem-path=/hugetlbfs,share=on \
+ -numa node,memdev=mem \
+ -chardev socket,id=chr0,path=/path/to/socket \
+ -netdev type=vhost-user,id=net0,chardev=chr0 \
+ -device virtio-net-pci,netdev=net0
+
+``-netdev hubport,id=id,hubid=hubid[,netdev=nd]``
+ Create a hub port on the emulated hub with ID hubid.
+
+ The hubport netdev lets you connect a NIC to a QEMU emulated hub
+ instead of a single netdev. Alternatively, you can also connect the
+ hubport to another netdev with ID nd by using the ``netdev=nd``
+ option.
+
+``-net nic[,netdev=nd][,macaddr=mac][,model=type] [,name=name][,addr=addr][,vectors=v]``
+ Legacy option to configure or create an on-board (or machine
+ default) Network Interface Card(NIC) and connect it either to the
+ emulated hub with ID 0 (i.e. the default hub), or to the netdev nd.
+ If model is omitted, then the default NIC model associated with the
+ machine type is used. Note that the default NIC model may change in
+ future QEMU releases, so it is highly recommended to always specify
+ a model. Optionally, the MAC address can be changed to mac, the
+ device address set to addr (PCI cards only), and a name can be
+ assigned for use in monitor commands. Optionally, for PCI cards, you
+ can specify the number v of MSI-X vectors that the card should have;
+ this option currently only affects virtio cards; set v = 0 to
+ disable MSI-X. If no ``-net`` option is specified, a single NIC is
+ created. QEMU can emulate several different models of network card.
+ Use ``-net nic,model=help`` for a list of available devices for your
+ target.
+
+``-net user|tap|bridge|socket|l2tpv3|vde[,...][,name=name]``
+ Configure a host network backend (with the options corresponding to
+ the same ``-netdev`` option) and connect it to the emulated hub 0
+ (the default hub). Use name to specify the name of the hub port.
+ERST
STEXI
@end table
@@ -3209,6 +5501,264 @@ Connect to a spice virtual machine channel, such as vdiport.
Connect to a spice port, allowing a Spice client to handle the traffic
identified by a name (preferably a fqdn).
ETEXI
+SRST
+The general form of a character device option is:
+
+``-chardev backend,id=id[,mux=on|off][,options]``
+ Backend is one of: ``null``, ``socket``, ``udp``, ``msmouse``,
+ ``vc``, ``ringbuf``, ``file``, ``pipe``, ``console``, ``serial``,
+ ``pty``, ``stdio``, ``braille``, ``tty``, ``parallel``, ``parport``,
+ ``spicevmc``, ``spiceport``. The specific backend will determine the
+ applicable options.
+
+ Use ``-chardev help`` to print all available chardev backend types.
+
+ All devices must have an id, which can be any string up to 127
+ characters long. It is used to uniquely identify this device in
+ other command line directives.
+
+ A character device may be used in multiplexing mode by multiple
+ front-ends. Specify ``mux=on`` to enable this mode. A multiplexer is
+ a "1:N" device, and here the "1" end is your specified chardev
+ backend, and the "N" end is the various parts of QEMU that can talk
+ to a chardev. If you create a chardev with ``id=myid`` and
+ ``mux=on``, QEMU will create a multiplexer with your specified ID,
+ and you can then configure multiple front ends to use that chardev
+ ID for their input/output. Up to four different front ends can be
+ connected to a single multiplexed chardev. (Without multiplexing
+ enabled, a chardev can only be used by a single front end.) For
+ instance you could use this to allow a single stdio chardev to be
+ used by two serial ports and the QEMU monitor:
+
+ ::
+
+ -chardev stdio,mux=on,id=char0 \
+ -mon chardev=char0,mode=readline \
+ -serial chardev:char0 \
+ -serial chardev:char0
+
+ You can have more than one multiplexer in a system configuration;
+ for instance you could have a TCP port multiplexed between UART 0
+ and UART 1, and stdio multiplexed between the QEMU monitor and a
+ parallel port:
+
+ ::
+
+ -chardev stdio,mux=on,id=char0 \
+ -mon chardev=char0,mode=readline \
+ -parallel chardev:char0 \
+ -chardev tcp,...,mux=on,id=char1 \
+ -serial chardev:char1 \
+ -serial chardev:char1
+
+ When you're using a multiplexed character device, some escape
+ sequences are interpreted in the input. See :ref:`mux_005fkeys`.
+
+ Note that some other command line options may implicitly create
+ multiplexed character backends; for instance ``-serial mon:stdio``
+ creates a multiplexed stdio backend connected to the serial port and
+ the QEMU monitor, and ``-nographic`` also multiplexes the console
+ and the monitor to stdio.
+
+ There is currently no support for multiplexing in the other
+ direction (where a single QEMU front end takes input and output from
+ multiple chardevs).
+
+ Every backend supports the ``logfile`` option, which supplies the
+ path to a file to record all data transmitted via the backend. The
+ ``logappend`` option controls whether the log file will be truncated
+ or appended to when opened.
+
+The available backends are:
+
+``-chardev null,id=id``
+ A void device. This device will not emit any data, and will drop any
+ data it receives. The null backend does not take any options.
+
+``-chardev socket,id=id[,TCP options or unix options][,server][,nowait][,telnet][,websocket][,reconnect=seconds][,tls-creds=id][,tls-authz=id]``
+ Create a two-way stream socket, which can be either a TCP or a unix
+ socket. A unix socket will be created if ``path`` is specified.
+ Behaviour is undefined if TCP options are specified for a unix
+ socket.
+
+ ``server`` specifies that the socket shall be a listening socket.
+
+ ``nowait`` specifies that QEMU should not block waiting for a client
+ to connect to a listening socket.
+
+ ``telnet`` specifies that traffic on the socket should interpret
+ telnet escape sequences.
+
+ ``websocket`` specifies that the socket uses WebSocket protocol for
+ communication.
+
+ ``reconnect`` sets the timeout for reconnecting on non-server
+ sockets when the remote end goes away. qemu will delay this many
+ seconds and then attempt to reconnect. Zero disables reconnecting,
+ and is the default.
+
+ ``tls-creds`` requests enablement of the TLS protocol for
+ encryption, and specifies the id of the TLS credentials to use for
+ the handshake. The credentials must be previously created with the
+ ``-object tls-creds`` argument.
+
+ ``tls-auth`` provides the ID of the QAuthZ authorization object
+ against which the client's x509 distinguished name will be
+ validated. This object is only resolved at time of use, so can be
+ deleted and recreated on the fly while the chardev server is active.
+ If missing, it will default to denying access.
+
+ TCP and unix socket options are given below:
+
+ ``TCP options: port=port[,host=host][,to=to][,ipv4][,ipv6][,nodelay]``
+ ``host`` for a listening socket specifies the local address to
+ be bound. For a connecting socket species the remote host to
+ connect to. ``host`` is optional for listening sockets. If not
+ specified it defaults to ``0.0.0.0``.
+
+ ``port`` for a listening socket specifies the local port to be
+ bound. For a connecting socket specifies the port on the remote
+ host to connect to. ``port`` can be given as either a port
+ number or a service name. ``port`` is required.
+
+ ``to`` is only relevant to listening sockets. If it is
+ specified, and ``port`` cannot be bound, QEMU will attempt to
+ bind to subsequent ports up to and including ``to`` until it
+ succeeds. ``to`` must be specified as a port number.
+
+ ``ipv4`` and ``ipv6`` specify that either IPv4 or IPv6 must be
+ used. If neither is specified the socket may use either
+ protocol.
+
+ ``nodelay`` disables the Nagle algorithm.
+
+ ``unix options: path=path``
+ ``path`` specifies the local path of the unix socket. ``path``
+ is required.
+
+``-chardev udp,id=id[,host=host],port=port[,localaddr=localaddr][,localport=localport][,ipv4][,ipv6]``
+ Sends all traffic from the guest to a remote host over UDP.
+
+ ``host`` specifies the remote host to connect to. If not specified
+ it defaults to ``localhost``.
+
+ ``port`` specifies the port on the remote host to connect to.
+ ``port`` is required.
+
+ ``localaddr`` specifies the local address to bind to. If not
+ specified it defaults to ``0.0.0.0``.
+
+ ``localport`` specifies the local port to bind to. If not specified
+ any available local port will be used.
+
+ ``ipv4`` and ``ipv6`` specify that either IPv4 or IPv6 must be used.
+ If neither is specified the device may use either protocol.
+
+``-chardev msmouse,id=id``
+ Forward QEMU's emulated msmouse events to the guest. ``msmouse``
+ does not take any options.
+
+``-chardev vc,id=id[[,width=width][,height=height]][[,cols=cols][,rows=rows]]``
+ Connect to a QEMU text console. ``vc`` may optionally be given a
+ specific size.
+
+ ``width`` and ``height`` specify the width and height respectively
+ of the console, in pixels.
+
+ ``cols`` and ``rows`` specify that the console be sized to fit a
+ text console with the given dimensions.
+
+``-chardev ringbuf,id=id[,size=size]``
+ Create a ring buffer with fixed size ``size``. size must be a power
+ of two and defaults to ``64K``.
+
+``-chardev file,id=id,path=path``
+ Log all traffic received from the guest to a file.
+
+ ``path`` specifies the path of the file to be opened. This file will
+ be created if it does not already exist, and overwritten if it does.
+ ``path`` is required.
+
+``-chardev pipe,id=id,path=path``
+ Create a two-way connection to the guest. The behaviour differs
+ slightly between Windows hosts and other hosts:
+
+ On Windows, a single duplex pipe will be created at
+ ``\\.pipe\path``.
+
+ On other hosts, 2 pipes will be created called ``path.in`` and
+ ``path.out``. Data written to ``path.in`` will be received by the
+ guest. Data written by the guest can be read from ``path.out``. QEMU
+ will not create these fifos, and requires them to be present.
+
+ ``path`` forms part of the pipe path as described above. ``path`` is
+ required.
+
+``-chardev console,id=id``
+ Send traffic from the guest to QEMU's standard output. ``console``
+ does not take any options.
+
+ ``console`` is only available on Windows hosts.
+
+``-chardev serial,id=id,path=path``
+ Send traffic from the guest to a serial device on the host.
+
+ On Unix hosts serial will actually accept any tty device, not only
+ serial lines.
+
+ ``path`` specifies the name of the serial device to open.
+
+``-chardev pty,id=id``
+ Create a new pseudo-terminal on the host and connect to it. ``pty``
+ does not take any options.
+
+ ``pty`` is not available on Windows hosts.
+
+``-chardev stdio,id=id[,signal=on|off]``
+ Connect to standard input and standard output of the QEMU process.
+
+ ``signal`` controls if signals are enabled on the terminal, that
+ includes exiting QEMU with the key sequence Control-c. This option
+ is enabled by default, use ``signal=off`` to disable it.
+
+``-chardev braille,id=id``
+ Connect to a local BrlAPI server. ``braille`` does not take any
+ options.
+
+``-chardev tty,id=id,path=path``
+ ``tty`` is only available on Linux, Sun, FreeBSD, NetBSD, OpenBSD
+ and DragonFlyBSD hosts. It is an alias for ``serial``.
+
+ ``path`` specifies the path to the tty. ``path`` is required.
+
+``-chardev parallel,id=id,path=path``; \ ``-chardev parport,id=id,path=path``
+ ``parallel`` is only available on Linux, FreeBSD and DragonFlyBSD
+ hosts.
+
+ Connect to a local parallel port.
+
+ ``path`` specifies the path to the parallel port device. ``path`` is
+ required.
+
+``-chardev spicevmc,id=id,debug=debug,name=name``
+ ``spicevmc`` is only available when spice support is built in.
+
+ ``debug`` debug level for spicevmc
+
+ ``name`` name of spice channel to connect to
+
+ Connect to a spice virtual machine channel, such as vdiport.
+
+``-chardev spiceport,id=id,debug=debug,name=name``
+ ``spiceport`` is only available when spice support is built in.
+
+ ``debug`` debug level for spicevmc
+
+ ``name`` name of spice port to connect to
+
+ Connect to a spice port, allowing a Spice client to handle the
+ traffic identified by a name (preferably a fqdn).
+ERST
STEXI
@end table
@@ -3298,6 +5848,69 @@ To create a TPM emulator backend device with chardev socket backend:
@end example
ETEXI
+SRST
+The general form of a TPM device option is:
+
+``-tpmdev backend,id=id[,options]``
+ The specific backend type will determine the applicable options. The
+ ``-tpmdev`` option creates the TPM backend and requires a
+ ``-device`` option that specifies the TPM frontend interface model.
+
+ Use ``-tpmdev help`` to print all available TPM backend types.
+
+The available backends are:
+
+``-tpmdev passthrough,id=id,path=path,cancel-path=cancel-path``
+ (Linux-host only) Enable access to the host's TPM using the
+ passthrough driver.
+
+ ``path`` specifies the path to the host's TPM device, i.e., on a
+ Linux host this would be ``/dev/tpm0``. ``path`` is optional and by
+ default ``/dev/tpm0`` is used.
+
+ ``cancel-path`` specifies the path to the host TPM device's sysfs
+ entry allowing for cancellation of an ongoing TPM command.
+ ``cancel-path`` is optional and by default QEMU will search for the
+ sysfs entry to use.
+
+ Some notes about using the host's TPM with the passthrough driver:
+
+ The TPM device accessed by the passthrough driver must not be used
+ by any other application on the host.
+
+ Since the host's firmware (BIOS/UEFI) has already initialized the
+ TPM, the VM's firmware (BIOS/UEFI) will not be able to initialize
+ the TPM again and may therefore not show a TPM-specific menu that
+ would otherwise allow the user to configure the TPM, e.g., allow the
+ user to enable/disable or activate/deactivate the TPM. Further, if
+ TPM ownership is released from within a VM then the host's TPM will
+ get disabled and deactivated. To enable and activate the TPM again
+ afterwards, the host has to be rebooted and the user is required to
+ enter the firmware's menu to enable and activate the TPM. If the TPM
+ is left disabled and/or deactivated most TPM commands will fail.
+
+ To create a passthrough TPM use the following two options:
+
+ ::
+
+ -tpmdev passthrough,id=tpm0 -device tpm-tis,tpmdev=tpm0
+
+ Note that the ``-tpmdev`` id is ``tpm0`` and is referenced by
+ ``tpmdev=tpm0`` in the device option.
+
+``-tpmdev emulator,id=id,chardev=dev``
+ (Linux-host only) Enable access to a TPM emulator using Unix domain
+ socket based chardev backend.
+
+ ``chardev`` specifies the unique ID of a character device backend
+ that provides connection to the software TPM server.
+
+ To create a TPM emulator backend device with chardev socket backend:
+
+ ::
+
+ -chardev socket,id=chrtpm,path=/tmp/swtpm-sock -tpmdev emulator,id=tpm0,chardev=chrtpm -device tpm-tis,tpmdev=tpm0
+ERST
STEXI
@end table
@@ -3315,6 +5928,13 @@ for easier testing of various kernels.
@table @option
ETEXI
+SRST
+When using these options, you can use a given Linux or Multiboot kernel
+without installing it in the disk image. It can be useful for easier
+testing of various kernels.
+
+
+ERST
DEF("kernel", HAS_ARG, QEMU_OPTION_kernel, \
"-kernel bzImage use 'bzImage' as kernel image\n", QEMU_ARCH_ALL)
@@ -3324,6 +5944,11 @@ STEXI
Use @var{bzImage} as kernel image. The kernel can be either a Linux kernel
or in multiboot format.
ETEXI
+SRST
+``-kernel bzImage``
+ Use bzImage as kernel image. The kernel can be either a Linux kernel
+ or in multiboot format.
+ERST
DEF("append", HAS_ARG, QEMU_OPTION_append, \
"-append cmdline use 'cmdline' as kernel command line\n", QEMU_ARCH_ALL)
@@ -3332,6 +5957,10 @@ STEXI
@findex -append
Use @var{cmdline} as kernel command line
ETEXI
+SRST
+``-append cmdline``
+ Use cmdline as kernel command line
+ERST
DEF("initrd", HAS_ARG, QEMU_OPTION_initrd, \
"-initrd file use 'file' as initial ram disk\n", QEMU_ARCH_ALL)
@@ -3347,6 +5976,16 @@ This syntax is only available with multiboot.
Use @var{file1} and @var{file2} as modules and pass arg=foo as parameter to the
first module.
ETEXI
+SRST
+``-initrd file``
+ Use file as initial ram disk.
+
+``-initrd "file1 arg=foo,file2"``
+ This syntax is only available with multiboot.
+
+ Use file1 and file2 as modules and pass arg=foo as parameter to the
+ first module.
+ERST
DEF("dtb", HAS_ARG, QEMU_OPTION_dtb, \
"-dtb file use 'file' as device tree image\n", QEMU_ARCH_ALL)
@@ -3356,6 +5995,11 @@ STEXI
Use @var{file} as a device tree binary (dtb) image and pass it to the kernel
on boot.
ETEXI
+SRST
+``-dtb file``
+ Use file as a device tree binary (dtb) image and pass it to the
+ kernel on boot.
+ERST
STEXI
@end table
@@ -3396,6 +6040,28 @@ creates an fw_cfg entry named opt/com.mycompany/blob with contents
from ./my_blob.bin.
ETEXI
+SRST
+``-fw_cfg [name=]name,file=file``
+ Add named fw\_cfg entry with contents from file file.
+
+``-fw_cfg [name=]name,string=str``
+ Add named fw\_cfg entry with contents from string str.
+
+ The terminating NUL character of the contents of str will not be
+ included as part of the fw\_cfg item data. To insert contents with
+ embedded NUL characters, you have to use the file parameter.
+
+ The fw\_cfg entries are passed by QEMU through to the guest.
+
+ Example:
+
+ ::
+
+ -fw_cfg name=opt/com.mycompany/blob,file=./my_blob.bin
+
+ creates an fw\_cfg entry named opt/com.mycompany/blob with contents
+ from ./my\_blob.bin.
+ERST
DEF("serial", HAS_ARG, QEMU_OPTION_serial, \
"-serial dev redirect the serial port to char device 'dev'\n",
@@ -3534,6 +6200,161 @@ or fake device.
Three button serial mouse. Configure the guest to use Microsoft protocol.
@end table
ETEXI
+SRST
+``-serial dev``
+ Redirect the virtual serial port to host character device dev. The
+ default device is ``vc`` in graphical mode and ``stdio`` in non
+ graphical mode.
+
+ This option can be used several times to simulate up to 4 serial
+ ports.
+
+ Use ``-serial none`` to disable all serial ports.
+
+ Available character devices are:
+
+ ``vc[:WxH]``
+ Virtual console. Optionally, a width and height can be given in
+ pixel with
+
+ ::
+
+ vc:800x600
+
+ It is also possible to specify width or height in characters:
+
+ ::
+
+ vc:80Cx24C
+
+ ``pty``
+ [Linux only] Pseudo TTY (a new PTY is automatically allocated)
+
+ ``none``
+ No device is allocated.
+
+ ``null``
+ void device
+
+ ``chardev:id``
+ Use a named character device defined with the ``-chardev``
+ option.
+
+ ``/dev/XXX``
+ [Linux only] Use host tty, e.g. ``/dev/ttyS0``. The host serial
+ port parameters are set according to the emulated ones.
+
+ ``/dev/parportN``
+ [Linux only, parallel port only] Use host parallel port N.
+ Currently SPP and EPP parallel port features can be used.
+
+ ``file:filename``
+ Write output to filename. No character can be read.
+
+ ``stdio``
+ [Unix only] standard input/output
+
+ ``pipe:filename``
+ name pipe filename
+
+ ``COMn``
+ [Windows only] Use host serial port n
+
+ ``udp:[remote_host]:remote_port[@[src_ip]:src_port]``
+ This implements UDP Net Console. When remote\_host or src\_ip
+ are not specified they default to ``0.0.0.0``. When not using a
+ specified src\_port a random port is automatically chosen.
+
+ If you just want a simple readonly console you can use
+ ``netcat`` or ``nc``, by starting QEMU with:
+ ``-serial udp::4555`` and nc as: ``nc -u -l -p 4555``. Any time
+ QEMU writes something to that port it will appear in the
+ netconsole session.
+
+ If you plan to send characters back via netconsole or you want
+ to stop and start QEMU a lot of times, you should have QEMU use
+ the same source port each time by using something like ``-serial
+ udp::4555@:4556`` to QEMU. Another approach is to use a patched
+ version of netcat which can listen to a TCP port and send and
+ receive characters via udp. If you have a patched version of
+ netcat which activates telnet remote echo and single char
+ transfer, then you can use the following options to set up a
+ netcat redirector to allow telnet on port 5555 to access the
+ QEMU port.
+
+ ``QEMU Options:``
+ -serial udp::4555@:4556
+
+ ``netcat options:``
+ -u -P 4555 -L 0.0.0.0:4556 -t -p 5555 -I -T
+
+ ``telnet options:``
+ localhost 5555
+
+ ``tcp:[host]:port[,server][,nowait][,nodelay][,reconnect=seconds]``
+ The TCP Net Console has two modes of operation. It can send the
+ serial I/O to a location or wait for a connection from a
+ location. By default the TCP Net Console is sent to host at the
+ port. If you use the server option QEMU will wait for a client
+ socket application to connect to the port before continuing,
+ unless the ``nowait`` option was specified. The ``nodelay``
+ option disables the Nagle buffering algorithm. The ``reconnect``
+ option only applies if noserver is set, if the connection goes
+ down it will attempt to reconnect at the given interval. If host
+ is omitted, 0.0.0.0 is assumed. Only one TCP connection at a
+ time is accepted. You can use ``telnet`` to connect to the
+ corresponding character device.
+
+ ``Example to send tcp console to 192.168.0.2 port 4444``
+ -serial tcp:192.168.0.2:4444
+
+ ``Example to listen and wait on port 4444 for connection``
+ -serial tcp::4444,server
+
+ ``Example to not wait and listen on ip 192.168.0.100 port 4444``
+ -serial tcp:192.168.0.100:4444,server,nowait
+
+ ``telnet:host:port[,server][,nowait][,nodelay]``
+ The telnet protocol is used instead of raw tcp sockets. The
+ options work the same as if you had specified ``-serial tcp``.
+ The difference is that the port acts like a telnet server or
+ client using telnet option negotiation. This will also allow you
+ to send the MAGIC\_SYSRQ sequence if you use a telnet that
+ supports sending the break sequence. Typically in unix telnet
+ you do it with Control-] and then type "send break" followed by
+ pressing the enter key.
+
+ ``websocket:host:port,server[,nowait][,nodelay]``
+ The WebSocket protocol is used instead of raw tcp socket. The
+ port acts as a WebSocket server. Client mode is not supported.
+
+ ``unix:path[,server][,nowait][,reconnect=seconds]``
+ A unix domain socket is used instead of a tcp socket. The option
+ works the same as if you had specified ``-serial tcp`` except
+ the unix domain socket path is used for connections.
+
+ ``mon:dev_string``
+ This is a special option to allow the monitor to be multiplexed
+ onto another serial port. The monitor is accessed with key
+ sequence of Control-a and then pressing c. dev\_string should be
+ any one of the serial devices specified above. An example to
+ multiplex the monitor onto a telnet server listening on port
+ 4444 would be:
+
+ ``-serial mon:telnet::4444,server,nowait``
+
+ When the monitor is multiplexed to stdio in this way, Ctrl+C
+ will not terminate QEMU any more but will be passed to the guest
+ instead.
+
+ ``braille``
+ Braille device. This will use BrlAPI to display the braille
+ output on a real or fake device.
+
+ ``msmouse``
+ Three button serial mouse. Configure the guest to use Microsoft
+ protocol.
+ERST
DEF("parallel", HAS_ARG, QEMU_OPTION_parallel, \
"-parallel dev redirect the parallel port to char device 'dev'\n",
@@ -3551,6 +6372,18 @@ ports.
Use @code{-parallel none} to disable all parallel ports.
ETEXI
+SRST
+``-parallel dev``
+ Redirect the virtual parallel port to host device dev (same devices
+ as the serial port). On Linux hosts, ``/dev/parportN`` can be used
+ to use hardware devices connected on the corresponding host parallel
+ port.
+
+ This option can be used several times to simulate up to 3 parallel
+ ports.
+
+ Use ``-parallel none`` to disable all parallel ports.
+ERST
DEF("monitor", HAS_ARG, QEMU_OPTION_monitor, \
"-monitor dev redirect the monitor to char device 'dev'\n",
@@ -3564,6 +6397,13 @@ The default device is @code{vc} in graphical mode and @code{stdio} in
non graphical mode.
Use @code{-monitor none} to disable the default monitor.
ETEXI
+SRST
+``-monitor dev``
+ Redirect the monitor to host device dev (same devices as the serial
+ port). The default device is ``vc`` in graphical mode and ``stdio``
+ in non graphical mode. Use ``-monitor none`` to disable the default
+ monitor.
+ERST
DEF("qmp", HAS_ARG, QEMU_OPTION_qmp, \
"-qmp dev like -monitor but opens in 'control' mode\n",
QEMU_ARCH_ALL)
@@ -3572,6 +6412,10 @@ STEXI
@findex -qmp
Like -monitor but opens in 'control' mode.
ETEXI
+SRST
+``-qmp dev``
+ Like -monitor but opens in 'control' mode.
+ERST
DEF("qmp-pretty", HAS_ARG, QEMU_OPTION_qmp_pretty, \
"-qmp-pretty dev like -qmp but uses pretty JSON formatting\n",
QEMU_ARCH_ALL)
@@ -3580,6 +6424,10 @@ STEXI
@findex -qmp-pretty
Like -qmp but uses pretty JSON formatting.
ETEXI
+SRST
+``-qmp-pretty dev``
+ Like -qmp but uses pretty JSON formatting.
+ERST
DEF("mon", HAS_ARG, QEMU_OPTION_mon, \
"-mon [chardev=]name[,mode=readline|control][,pretty[=on|off]]\n", QEMU_ARCH_ALL)
@@ -3589,6 +6437,11 @@ STEXI
Setup monitor on chardev @var{name}. @code{pretty} turns on JSON pretty printing
easing human reading and debugging.
ETEXI
+SRST
+``-mon [chardev=]name[,mode=readline|control][,pretty[=on|off]]``
+ Setup monitor on chardev name. ``pretty`` turns on JSON pretty
+ printing easing human reading and debugging.
+ERST
DEF("debugcon", HAS_ARG, QEMU_OPTION_debugcon, \
"-debugcon dev redirect the debug console to char device 'dev'\n",
@@ -3602,6 +6455,14 @@ serial port). The debug console is an I/O port which is typically port
The default device is @code{vc} in graphical mode and @code{stdio} in
non graphical mode.
ETEXI
+SRST
+``-debugcon dev``
+ Redirect the debug console to host device dev (same devices as the
+ serial port). The debug console is an I/O port which is typically
+ port 0xe9; writing to that I/O port sends output to this device. The
+ default device is ``vc`` in graphical mode and ``stdio`` in non
+ graphical mode.
+ERST
DEF("pidfile", HAS_ARG, QEMU_OPTION_pidfile, \
"-pidfile file write PID to 'file'\n", QEMU_ARCH_ALL)
@@ -3611,6 +6472,11 @@ STEXI
Store the QEMU process PID in @var{file}. It is useful if you launch QEMU
from a script.
ETEXI
+SRST
+``-pidfile file``
+ Store the QEMU process PID in file. It is useful if you launch QEMU
+ from a script.
+ERST
DEF("singlestep", 0, QEMU_OPTION_singlestep, \
"-singlestep always run in singlestep mode\n", QEMU_ARCH_ALL)
@@ -3619,6 +6485,10 @@ STEXI
@findex -singlestep
Run the emulation in single step mode.
ETEXI
+SRST
+``-singlestep``
+ Run the emulation in single step mode.
+ERST
DEF("preconfig", 0, QEMU_OPTION_preconfig, \
"--preconfig pause QEMU before machine is initialized (experimental)\n",
@@ -3633,6 +6503,15 @@ the preconfig state and move to the next state (i.e. run guest if -S
isn't used or pause the second time if -S is used). This option is
experimental.
ETEXI
+SRST
+``--preconfig``
+ Pause QEMU for interactive configuration before the machine is
+ created, which allows querying and configuring properties that will
+ affect machine initialization. Use QMP command 'x-exit-preconfig' to
+ exit the preconfig state and move to the next state (i.e. run guest
+ if -S isn't used or pause the second time if -S is used). This
+ option is experimental.
+ERST
DEF("S", 0, QEMU_OPTION_S, \
"-S freeze CPU at startup (use 'c' to start execution)\n",
@@ -3642,6 +6521,10 @@ STEXI
@findex -S
Do not start CPU at startup (you must type 'c' in the monitor).
ETEXI
+SRST
+``-S``
+ Do not start CPU at startup (you must type 'c' in the monitor).
+ERST
DEF("realtime", HAS_ARG, QEMU_OPTION_realtime,
"-realtime [mlock=on|off]\n"
@@ -3655,6 +6538,11 @@ Run qemu with realtime features.
mlocking qemu and guest memory can be enabled via @option{mlock=on}
(enabled by default).
ETEXI
+SRST
+``-realtime mlock=on|off``
+ Run qemu with realtime features. mlocking qemu and guest memory can
+ be enabled via ``mlock=on`` (enabled by default).
+ERST
DEF("overcommit", HAS_ARG, QEMU_OPTION_overcommit,
"-overcommit [mem-lock=on|off][cpu-pm=on|off]\n"
@@ -3679,6 +6567,24 @@ enabled via @option{cpu-pm=on} (disabled by default). This works best when
host CPU is not overcommitted. When used, host estimates of CPU cycle and power
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.
+
+ Locking qemu and guest memory can be enabled via ``mem-lock=on``
+ (disabled by default). This works when host memory is not
+ overcommitted and reduces the worst-case latency for guest. This is
+ equivalent to ``realtime``.
+
+ Guest ability to manage power state of host cpus (increasing latency
+ for other processes on the same host cpu, but decreasing latency for
+ guest) can be enabled via ``cpu-pm=on`` (disabled by default). This
+ works best when host CPU is not overcommitted. When used, host
+ estimates of CPU cycle and power utilization will be incorrect, not
+ taking into account guest idle time.
+ERST
DEF("gdb", HAS_ARG, QEMU_OPTION_gdb, \
"-gdb dev wait for gdb connection on 'dev'\n", QEMU_ARCH_ALL)
@@ -3693,6 +6599,18 @@ within gdb and establish the connection via a pipe:
(gdb) target remote | exec @value{qemu_system} -gdb stdio ...
@end example
ETEXI
+SRST
+``-gdb dev``
+ Wait for gdb connection on device dev (see
+ :ref:`gdb_005fusage`). Typical connections will likely be
+ TCP-based, but also UDP, pseudo TTY, or even stdio are reasonable
+ use case. The latter is allowing to start QEMU from within gdb and
+ establish the connection via a pipe:
+
+ ::
+
+ (gdb) target remote | exec |qemu_system| -gdb stdio ...
+ERST
DEF("s", 0, QEMU_OPTION_s, \
"-s shorthand for -gdb tcp::" DEFAULT_GDBSTUB_PORT "\n",
@@ -3703,6 +6621,11 @@ STEXI
Shorthand for -gdb tcp::1234, i.e. open a gdbserver on TCP port 1234
(@pxref{gdb_usage}).
ETEXI
+SRST
+``-s``
+ Shorthand for -gdb tcp::1234, i.e. open a gdbserver on TCP port 1234
+ (see :ref:`gdb_005fusage`).
+ERST
DEF("d", HAS_ARG, QEMU_OPTION_d, \
"-d item1,... enable logging of specified items (use '-d help' for a list of log items)\n",
@@ -3712,6 +6635,11 @@ STEXI
@findex -d
Enable logging of specified items. Use '-d help' for a list of log items.
ETEXI
+SRST
+``-d item1[,...]``
+ Enable logging of specified items. Use '-d help' for a list of log
+ items.
+ERST
DEF("D", HAS_ARG, QEMU_OPTION_D, \
"-D logfile output log to logfile (default stderr)\n",
@@ -3721,6 +6649,10 @@ STEXI
@findex -D
Output log in @var{logfile} instead of to stderr
ETEXI
+SRST
+``-D logfile``
+ Output log in logfile instead of to stderr
+ERST
DEF("dfilter", HAS_ARG, QEMU_OPTION_DFILTER, \
"-dfilter range,.. filter debug output to range of addresses (useful for -d cpu,exec,etc..)\n",
@@ -3739,6 +6671,21 @@ Will dump output for any code in the 0x1000 sized block starting at 0x8000 and
the 0x200 sized block starting at 0xffffffc000080000 and another 0x1000 sized
block starting at 0xffffffc00005f000.
ETEXI
+SRST
+``-dfilter range1[,...]``
+ Filter debug output to that relevant to a range of target addresses.
+ The filter spec can be either start+size, start-size or start..end
+ where start end and size are the addresses and sizes required. For
+ example:
+
+ ::
+
+ -dfilter 0x8000..0x8fff,0xffffffc000080000+0x200,0xffffffc000060000-0x1000
+
+ Will dump output for any code in the 0x1000 sized block starting at
+ 0x8000 and the 0x200 sized block starting at 0xffffffc000080000 and
+ another 0x1000 sized block starting at 0xffffffc00005f000.
+ERST
DEF("seed", HAS_ARG, QEMU_OPTION_seed, \
"-seed number seed the pseudo-random number generator\n",
@@ -3749,6 +6696,12 @@ STEXI
Force the guest to use a deterministic pseudo-random number generator, seeded
with @var{number}. This does not affect crypto routines within the host.
ETEXI
+SRST
+``-seed number``
+ Force the guest to use a deterministic pseudo-random number
+ generator, seeded with number. This does not affect crypto routines
+ within the host.
+ERST
DEF("L", HAS_ARG, QEMU_OPTION_L, \
"-L path set the directory for the BIOS, VGA BIOS and keymaps\n",
@@ -3760,6 +6713,12 @@ Set the directory for the BIOS, VGA BIOS and keymaps.
To list all the data directories, use @code{-L help}.
ETEXI
+SRST
+``-L path``
+ Set the directory for the BIOS, VGA BIOS and keymaps.
+
+ To list all the data directories, use ``-L help``.
+ERST
DEF("bios", HAS_ARG, QEMU_OPTION_bios, \
"-bios file set the filename for the BIOS\n", QEMU_ARCH_ALL)
@@ -3768,6 +6727,10 @@ STEXI
@findex -bios
Set the filename for the BIOS.
ETEXI
+SRST
+``-bios file``
+ Set the filename for the BIOS.
+ERST
DEF("enable-kvm", 0, QEMU_OPTION_enable_kvm, \
"-enable-kvm enable KVM full virtualization support\n", QEMU_ARCH_ALL)
@@ -3777,6 +6740,11 @@ STEXI
Enable KVM full virtualization support. This option is only available
if KVM support is enabled when compiling.
ETEXI
+SRST
+``-enable-kvm``
+ Enable KVM full virtualization support. This option is only
+ available if KVM support is enabled when compiling.
+ERST
DEF("xen-domid", HAS_ARG, QEMU_OPTION_xen_domid,
"-xen-domid id specify xen guest domain id\n", QEMU_ARCH_ALL)
@@ -3800,6 +6768,15 @@ libxl will use this when starting QEMU (XEN only).
@findex -xen-domid-restrict
Restrict set of available xen operations to specified domain id (XEN only).
ETEXI
+SRST
+``-xen-domid id``
+ Specify xen guest domain id (XEN only).
+
+``-xen-attach``
+ Attach to existing xen domain. libxl will use this when starting
+ QEMU (XEN only). Restrict set of available xen operations to
+ specified domain id (XEN only).
+ERST
DEF("no-reboot", 0, QEMU_OPTION_no_reboot, \
"-no-reboot exit instead of rebooting\n", QEMU_ARCH_ALL)
@@ -3808,6 +6785,10 @@ STEXI
@findex -no-reboot
Exit instead of rebooting.
ETEXI
+SRST
+``-no-reboot``
+ Exit instead of rebooting.
+ERST
DEF("no-shutdown", 0, QEMU_OPTION_no_shutdown, \
"-no-shutdown stop before shutdown\n", QEMU_ARCH_ALL)
@@ -3818,6 +6799,12 @@ Don't exit QEMU on guest shutdown, but instead only stop the emulation.
This allows for instance switching to monitor to commit changes to the
disk image.
ETEXI
+SRST
+``-no-shutdown``
+ Don't exit QEMU on guest shutdown, but instead only stop the
+ emulation. This allows for instance switching to monitor to commit
+ changes to the disk image.
+ERST
DEF("loadvm", HAS_ARG, QEMU_OPTION_loadvm, \
"-loadvm [tag|id]\n" \
@@ -3828,6 +6815,10 @@ STEXI
@findex -loadvm
Start right away with a saved state (@code{loadvm} in monitor)
ETEXI
+SRST
+``-loadvm file``
+ Start right away with a saved state (``loadvm`` in monitor)
+ERST
#ifndef _WIN32
DEF("daemonize", 0, QEMU_OPTION_daemonize, \
@@ -3841,6 +6832,14 @@ standard IO until it is ready to receive connections on any of its devices.
This option is a useful way for external programs to launch QEMU without having
to cope with initialization race conditions.
ETEXI
+SRST
+``-daemonize``
+ Daemonize the QEMU process after initialization. QEMU will not
+ detach from standard IO until it is ready to receive connections on
+ any of its devices. This option is a useful way for external
+ programs to launch QEMU without having to cope with initialization
+ race conditions.
+ERST
DEF("option-rom", HAS_ARG, QEMU_OPTION_option_rom, \
"-option-rom rom load a file, rom, into the option ROM space\n",
@@ -3851,6 +6850,11 @@ STEXI
Load the contents of @var{file} as an option ROM.
This option is useful to load things like EtherBoot.
ETEXI
+SRST
+``-option-rom file``
+ Load the contents of file as an option ROM. This option is useful to
+ load things like EtherBoot.
+ERST
DEF("rtc", HAS_ARG, QEMU_OPTION_rtc, \
"-rtc [base=utc|localtime|<datetime>][,clock=host|rt|vm][,driftfix=none|slew]\n" \
@@ -3882,6 +6886,32 @@ specifically with Windows' ACPI HAL. This option will try to figure out how
many timer interrupts were not processed by the Windows guest and will
re-inject them.
ETEXI
+SRST
+``-rtc [base=utc|localtime|datetime][,clock=host|rt|vm][,driftfix=none|slew]``
+ Specify ``base`` as ``utc`` or ``localtime`` to let the RTC start at
+ the current UTC or local time, respectively. ``localtime`` is
+ required for correct date in MS-DOS or Windows. To start at a
+ specific point in time, provide datetime in the format
+ ``2006-06-17T16:01:21`` or ``2006-06-17``. The default base is UTC.
+
+ By default the RTC is driven by the host system time. This allows
+ using of the RTC as accurate reference clock inside the guest,
+ specifically if the host time is smoothly following an accurate
+ external reference clock, e.g. via NTP. If you want to isolate the
+ guest time from the host, you can set ``clock`` to ``rt`` instead,
+ which provides a host monotonic clock if host support it. To even
+ prevent the RTC from progressing during suspension, you can set
+ ``clock`` to ``vm`` (virtual clock). '\ ``clock=vm``\ ' is
+ recommended especially in icount mode in order to preserve
+ determinism; however, note that in icount mode the speed of the
+ virtual clock is variable and can in general differ from the host
+ clock.
+
+ Enable ``driftfix`` (i386 targets only) if you experience time drift
+ problems, specifically with Windows' ACPI HAL. This option will try
+ to figure out how many timer interrupts were not processed by the
+ Windows guest and will re-inject them.
+ERST
DEF("icount", HAS_ARG, QEMU_OPTION_icount, \
"-icount [shift=N|auto][,align=on|off][,sleep=on|off,rr=record|replay,rrfile=<filename>,rrsnapshot=<snapshot>]\n" \
@@ -3927,6 +6957,45 @@ Option rrsnapshot is used to create new vm snapshot named @var{snapshot}
at the start of execution recording. In replay mode this option is used
to load the initial VM state.
ETEXI
+SRST
+``-icount [shift=N|auto][,rr=record|replay,rrfile=filename,rrsnapshot=snapshot]``
+ Enable virtual instruction counter. The virtual cpu will execute one
+ instruction every 2^N ns of virtual time. If ``auto`` is specified
+ then the virtual cpu speed will be automatically adjusted to keep
+ virtual time within a few seconds of real time.
+
+ When the virtual cpu is sleeping, the virtual time will advance at
+ default speed unless ``sleep=on|off`` is specified. With
+ ``sleep=on|off``, the virtual time will jump to the next timer
+ deadline instantly whenever the virtual cpu goes to sleep mode and
+ will not advance if no timer is enabled. This behavior give
+ deterministic execution times from the guest point of view.
+
+ Note that while this option can give deterministic behavior, it does
+ not provide cycle accurate emulation. Modern CPUs contain
+ superscalar out of order cores with complex cache hierarchies. The
+ number of instructions executed often has little or no correlation
+ with actual performance.
+
+ ``align=on`` will activate the delay algorithm which will try to
+ synchronise the host clock and the virtual clock. The goal is to
+ have a guest running at the real frequency imposed by the shift
+ option. Whenever the guest clock is behind the host clock and if
+ ``align=on`` is specified then we print a message to the user to
+ inform about the delay. Currently this option does not work when
+ ``shift`` is ``auto``. Note: The sync algorithm will work for those
+ shift values for which the guest clock runs ahead of the host clock.
+ Typically this happens when the shift value is high (how high
+ depends on the host machine).
+
+ When ``rr`` option is specified deterministic record/replay is
+ enabled. Replay log is written into filename file in record mode and
+ read from this file in replay mode.
+
+ Option rrsnapshot is used to create new vm snapshot named snapshot
+ at the start of execution recording. In replay mode this option is
+ used to load the initial VM state.
+ERST
DEF("watchdog", HAS_ARG, QEMU_OPTION_watchdog, \
"-watchdog model\n" \
@@ -3956,6 +7025,30 @@ A virtual watchdog for s390x backed by the diagnose 288 hypercall
(currently KVM only).
@end table
ETEXI
+SRST
+``-watchdog model``
+ Create a virtual hardware watchdog device. Once enabled (by a guest
+ action), the watchdog must be periodically polled by an agent inside
+ the guest or else the guest will be restarted. Choose a model for
+ which your guest has drivers.
+
+ The model is the model of hardware watchdog to emulate. Use
+ ``-watchdog help`` to list available hardware models. Only one
+ watchdog can be enabled for a guest.
+
+ The following models may be available:
+
+ ``ib700``
+ iBASE 700 is a very simple ISA watchdog with a single timer.
+
+ ``i6300esb``
+ Intel 6300ESB I/O controller hub is a much more featureful
+ PCI-based dual-timer watchdog.
+
+ ``diag288``
+ A virtual watchdog for s390x backed by the diagnose 288
+ hypercall (currently KVM only).
+ERST
DEF("watchdog-action", HAS_ARG, QEMU_OPTION_watchdog_action, \
"-watchdog-action reset|shutdown|poweroff|inject-nmi|pause|debug|none\n" \
@@ -3989,6 +7082,26 @@ Examples:
@itemx -watchdog ib700
@end table
ETEXI
+SRST
+``-watchdog-action action``
+ The action controls what QEMU will do when the watchdog timer
+ expires. The default is ``reset`` (forcefully reset the guest).
+ Other possible actions are: ``shutdown`` (attempt to gracefully
+ shutdown the guest), ``poweroff`` (forcefully poweroff the guest),
+ ``inject-nmi`` (inject a NMI into the guest), ``pause`` (pause the
+ guest), ``debug`` (print a debug message and continue), or ``none``
+ (do nothing).
+
+ Note that the ``shutdown`` action requires that the guest responds
+ to ACPI signals, which it may not be able to do in the sort of
+ situations where the watchdog would have expired, and thus
+ ``-watchdog-action shutdown`` is not recommended for production use.
+
+ Examples:
+
+ ``-watchdog i6300esb -watchdog-action pause``; \ ``-watchdog ib700``
+
+ERST
DEF("echr", HAS_ARG, QEMU_OPTION_echr, \
"-echr chr set terminal escape character instead of ctrl-a\n",
@@ -4009,6 +7122,19 @@ character to Control-t.
@itemx -echr 20
@end table
ETEXI
+SRST
+``-echr numeric_ascii_value``
+ Change the escape character used for switching to the monitor when
+ using monitor and serial sharing. The default is ``0x01`` when using
+ the ``-nographic`` option. ``0x01`` is equal to pressing
+ ``Control-a``. You can select a different character from the ascii
+ control keys where 1 through 26 map to Control-a through Control-z.
+ For instance you could use the either of the following to change the
+ escape character to Control-t.
+
+ ``-echr 0x14``; \ ``-echr 20``
+
+ERST
DEF("show-cursor", 0, QEMU_OPTION_show_cursor, \
"-show-cursor show cursor\n", QEMU_ARCH_ALL)
@@ -4017,6 +7143,10 @@ STEXI
@findex -show-cursor
Show cursor.
ETEXI
+SRST
+``-show-cursor``
+ Show cursor.
+ERST
DEF("tb-size", HAS_ARG, QEMU_OPTION_tb_size, \
"-tb-size n set TB size\n", QEMU_ARCH_ALL)
@@ -4026,6 +7156,11 @@ STEXI
Set TCG translation block cache size. Deprecated, use @samp{-accel tcg,tb-size=@var{n}}
instead.
ETEXI
+SRST
+``-tb-size n``
+ Set TCG translation block cache size. Deprecated, use
+ '\ ``-accel tcg,tb-size=n``\ ' instead.
+ERST
DEF("incoming", HAS_ARG, QEMU_OPTION_incoming, \
"-incoming tcp:[host]:port[,to=maxport][,ipv4][,ipv6]\n" \
@@ -4060,6 +7195,25 @@ Wait for the URI to be specified via migrate_incoming. The monitor can
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]``
+ Prepare for incoming migration, listen on a given tcp port.
+
+``-incoming unix:socketpath``
+ Prepare for incoming migration, listen on a given unix socket.
+
+``-incoming fd:fd``
+ Accept incoming migration from a given filedescriptor.
+
+``-incoming exec:cmdline``
+ Accept incoming migration as an output from specified external
+ command.
+
+``-incoming defer``
+ Wait for the URI to be specified via migrate\_incoming. The monitor
+ can be used to change settings (such as migration parameters) prior
+ to issuing the migrate\_incoming to allow the migration to begin.
+ERST
DEF("only-migratable", 0, QEMU_OPTION_only_migratable, \
"-only-migratable allow only migratable devices\n", QEMU_ARCH_ALL)
@@ -4069,6 +7223,11 @@ STEXI
Only allow migratable devices. Devices will not be allowed to enter an
unmigratable state.
ETEXI
+SRST
+``-only-migratable``
+ Only allow migratable devices. Devices will not be allowed to enter
+ an unmigratable state.
+ERST
DEF("nodefaults", 0, QEMU_OPTION_nodefaults, \
"-nodefaults don't create default devices\n", QEMU_ARCH_ALL)
@@ -4080,6 +7239,13 @@ port, parallel port, virtual console, monitor device, VGA adapter, floppy and
CD-ROM drive and others. The @code{-nodefaults} option will disable all those
default devices.
ETEXI
+SRST
+``-nodefaults``
+ Don't create default devices. Normally, QEMU sets the default
+ devices like serial port, parallel port, virtual console, monitor
+ device, VGA adapter, floppy and CD-ROM drive and others. The
+ ``-nodefaults`` option will disable all those default devices.
+ERST
#ifndef _WIN32
DEF("chroot", HAS_ARG, QEMU_OPTION_chroot, \
@@ -4092,6 +7258,11 @@ STEXI
Immediately before starting guest execution, chroot to the specified
directory. Especially useful in combination with -runas.
ETEXI
+SRST
+``-chroot dir``
+ Immediately before starting guest execution, chroot to the specified
+ directory. Especially useful in combination with -runas.
+ERST
#ifndef _WIN32
DEF("runas", HAS_ARG, QEMU_OPTION_runas, \
@@ -4105,6 +7276,11 @@ STEXI
Immediately before starting guest execution, drop root privileges, switching
to the specified user.
ETEXI
+SRST
+``-runas user``
+ Immediately before starting guest execution, drop root privileges,
+ switching to the specified user.
+ERST
DEF("prom-env", HAS_ARG, QEMU_OPTION_prom_env,
"-prom-env variable=value\n"
@@ -4127,6 +7303,21 @@ qemu-system-ppc -prom-env 'auto-boot?=false' \
@end example
ETEXI
+SRST
+``-prom-env variable=value``
+ Set OpenBIOS nvram variable to given value (PPC, SPARC only).
+
+ ::
+
+ qemu-system-sparc -prom-env 'auto-boot?=false' \
+ -prom-env 'boot-device=sd(0,2,0):d' -prom-env 'boot-args=linux single'
+
+ ::
+
+ qemu-system-ppc -prom-env 'auto-boot?=false' \
+ -prom-env 'boot-device=hd:2,\yaboot' \
+ -prom-env 'boot-args=conf=hd:2,\yaboot.conf'
+ERST
DEF("semihosting", 0, QEMU_OPTION_semihosting,
"-semihosting semihosting mode\n",
QEMU_ARCH_ARM | QEMU_ARCH_M68K | QEMU_ARCH_XTENSA | QEMU_ARCH_LM32 |
@@ -4142,6 +7333,16 @@ should only be used with a trusted guest OS.
See the -semihosting-config option documentation for further information
about the facilities this enables.
ETEXI
+SRST
+``-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.
+ERST
DEF("semihosting-config", HAS_ARG, QEMU_OPTION_semihosting_config,
"-semihosting-config [enable=on|off][,target=native|gdb|auto][,chardev=id][,arg=str[,...]]\n" \
" semihosting configuration\n",
@@ -4178,6 +7379,41 @@ command line is still supported for backward compatibility. If both the
specified, the former is passed to semihosting as it always takes precedence.
@end table
ETEXI
+SRST
+``-semihosting-config [enable=on|off][,target=native|gdb|auto][,chardev=id][,arg=str[,...]]``
+ 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.
+
+ ``target=native|gdb|auto``
+ Defines where the semihosting calls will be addressed, to QEMU
+ (``native``) or to GDB (``gdb``). The default is ``auto``, which
+ means ``gdb`` during debug sessions and ``native`` otherwise.
+
+ ``chardev=str1``
+ Send the output to a chardev backend output for native or auto
+ output when not in gdb
+
+ ``arg=str1,arg=str2,...``
+ Allows the user to pass input arguments, and can be used
+ multiple times to build up a list. The old-style
+ ``-kernel``/``-append`` method of passing a command line is
+ still supported for backward compatibility. If both the
+ ``--semihosting-config arg`` and the ``-kernel``/``-append`` are
+ specified, the former is passed to semihosting as it always
+ takes precedence.
+ERST
DEF("old-param", 0, QEMU_OPTION_old_param,
"-old-param old param mode\n", QEMU_ARCH_ARM)
STEXI
@@ -4185,6 +7421,10 @@ STEXI
@findex -old-param (ARM)
Old param mode (ARM only).
ETEXI
+SRST
+``-old-param``
+ Old param mode (ARM only).
+ERST
DEF("sandbox", HAS_ARG, QEMU_OPTION_sandbox, \
"-sandbox on[,obsolete=allow|deny][,elevateprivileges=allow|deny|children]\n" \
@@ -4217,6 +7457,23 @@ Disable *fork and execve
Disable process affinity and schedular priority
@end table
ETEXI
+SRST
+``-sandbox arg[,obsolete=string][,elevateprivileges=string][,spawn=string][,resourcecontrol=string]``
+ Enable Seccomp mode 2 system call filter. 'on' will enable syscall
+ filtering and 'off' will disable it. The default is 'off'.
+
+ ``obsolete=string``
+ Enable Obsolete system calls
+
+ ``elevateprivileges=string``
+ Disable set\*uid\|gid system calls
+
+ ``spawn=string``
+ Disable \*fork and execve
+
+ ``resourcecontrol=string``
+ Disable process affinity and schedular priority
+ERST
DEF("readconfig", HAS_ARG, QEMU_OPTION_readconfig,
"-readconfig <file>\n", QEMU_ARCH_ALL)
@@ -4227,6 +7484,12 @@ Read device configuration from @var{file}. This approach is useful when you want
QEMU process with many command line options but you don't want to exceed the command line
character limit.
ETEXI
+SRST
+``-readconfig file``
+ Read device configuration from file. This approach is useful when
+ you want to spawn QEMU process with many command line options but
+ you don't want to exceed the command line character limit.
+ERST
DEF("writeconfig", HAS_ARG, QEMU_OPTION_writeconfig,
"-writeconfig <file>\n"
" read/write config file\n", QEMU_ARCH_ALL)
@@ -4237,6 +7500,13 @@ Write device configuration to @var{file}. The @var{file} can be either filename
command line and device configuration into file or dash @code{-}) character to print the
output to stdout. This can be later used as input file for @code{-readconfig} option.
ETEXI
+SRST
+``-writeconfig file``
+ Write device configuration to file. The file can be either filename
+ to save command line and device configuration into file or dash
+ ``-``) character to print the output to stdout. This can be later
+ used as input file for ``-readconfig`` option.
+ERST
DEF("no-user-config", 0, QEMU_OPTION_nouserconfig,
"-no-user-config\n"
@@ -4248,6 +7518,11 @@ STEXI
The @code{-no-user-config} option makes QEMU not load any of the user-provided
config files on @var{sysconfdir}.
ETEXI
+SRST
+``-no-user-config``
+ The ``-no-user-config`` option makes QEMU not load any of the
+ user-provided config files on sysconfdir.
+ERST
DEF("trace", HAS_ARG, QEMU_OPTION_trace,
"-trace [[enable=]<pattern>][,events=<file>][,file=<file>]\n"
@@ -4260,6 +7535,30 @@ HXCOMM HX does not support conditional compilation of text.
@findex -trace
@include docs/system/qemu-option-trace.texi
ETEXI
+SRST
+``-trace [[enable=]pattern][,events=file][,file=file]``
+ Specify tracing options.
+
+ ``[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=]<file>[,arg=<string>]\n"
" load a plugin\n",
@@ -4277,6 +7576,17 @@ Load the given plugin from a shared library file.
Argument string passed to the plugin. (Can be given multiple times.)
@end table
ETEXI
+SRST
+``-plugin file=file[,arg=string]``
+ Load a plugin.
+
+ ``file=file``
+ Load the given plugin from a shared library file.
+
+ ``arg=string``
+ Argument string passed to the plugin. (Can be given multiple
+ times.)
+ERST
HXCOMM Internal use
DEF("qtest", HAS_ARG, QEMU_OPTION_qtest, "", QEMU_ARCH_ALL)
@@ -4292,6 +7602,10 @@ STEXI
@findex -enable-fips
Enable FIPS 140-2 compliance mode.
ETEXI
+SRST
+``-enable-fips``
+ Enable FIPS 140-2 compliance mode.
+ERST
HXCOMM Deprecated by -accel tcg
DEF("no-kvm", 0, QEMU_OPTION_no_kvm, "", QEMU_ARCH_I386)
@@ -4310,6 +7624,13 @@ Control error message format.
Prefix messages with a timestamp. Default is off.
@end table
ETEXI
+SRST
+``-msg timestamp[=on|off]``
+ Control error message format.
+
+ ``timestamp=on|off``
+ Prefix messages with a timestamp. Default is off.
+ERST
DEF("dump-vmstate", HAS_ARG, QEMU_OPTION_dump_vmstate,
"-dump-vmstate <file>\n"
@@ -4324,6 +7645,11 @@ STEXI
Dump json-encoded vmstate information for current machine type to file
in @var{file}
ETEXI
+SRST
+``-dump-vmstate file``
+ Dump json-encoded vmstate information for current machine type to
+ file in file
+ERST
DEF("enable-sync-profile", 0, QEMU_OPTION_enable_sync_profile,
"-enable-sync-profile\n"
@@ -4334,6 +7660,10 @@ STEXI
@findex -enable-sync-profile
Enable synchronization profiling.
ETEXI
+SRST
+``-enable-sync-profile``
+ Enable synchronization profiling.
+ERST
STEXI
@end table
@@ -5014,6 +8344,675 @@ The polling parameters can be modified at run-time using the @code{qom-set} comm
@end table
ETEXI
+SRST
+``-object typename[,prop1=value1,...]``
+ Create a new object of type typename setting properties in the order
+ they are specified. Note that the 'id' property must be set. These
+ objects are placed in the '/objects' path.
+
+ ``-object memory-backend-file,id=id,size=size,mem-path=dir,share=on|off,discard-data=on|off,merge=on|off,dump=on|off,prealloc=on|off,host-nodes=host-nodes,policy=default|preferred|bind|interleave,align=align``
+ Creates a memory file backend object, which can be used to back
+ the guest RAM with huge pages.
+
+ The ``id`` parameter is a unique ID that will be used to
+ reference this memory region when configuring the ``-numa``
+ argument.
+
+ The ``size`` option provides the size of the memory region, and
+ accepts common suffixes, eg ``500M``.
+
+ The ``mem-path`` provides the path to either a shared memory or
+ huge page filesystem mount.
+
+ The ``share`` boolean option determines whether the memory
+ region is marked as private to QEMU, or shared. The latter
+ allows a co-operating external process to access the QEMU memory
+ region.
+
+ The ``share`` is also required for pvrdma devices due to
+ limitations in the RDMA API provided by Linux.
+
+ Setting share=on might affect the ability to configure NUMA
+ bindings for the memory backend under some circumstances, see
+ Documentation/vm/numa\_memory\_policy.txt on the Linux kernel
+ source tree for additional details.
+
+ Setting the ``discard-data`` boolean option to on indicates that
+ file contents can be destroyed when QEMU exits, to avoid
+ unnecessarily flushing data to the backing file. Note that
+ ``discard-data`` is only an optimization, and QEMU might not
+ discard file contents if it aborts unexpectedly or is terminated
+ using SIGKILL.
+
+ The ``merge`` boolean option enables memory merge, also known as
+ MADV\_MERGEABLE, so that Kernel Samepage Merging will consider
+ the pages for memory deduplication.
+
+ Setting the ``dump`` boolean option to off excludes the memory
+ from core dumps. This feature is also known as MADV\_DONTDUMP.
+
+ The ``prealloc`` boolean option enables memory preallocation.
+
+ The ``host-nodes`` option binds the memory range to a list of
+ NUMA host nodes.
+
+ The ``policy`` option sets the NUMA policy to one of the
+ following values:
+
+ ``default``
+ default host policy
+
+ ``preferred``
+ prefer the given host node list for allocation
+
+ ``bind``
+ restrict memory allocation to the given host node list
+
+ ``interleave``
+ interleave memory allocations across the given host node
+ list
+
+ The ``align`` option specifies the base address alignment when
+ QEMU mmap(2) ``mem-path``, and accepts common suffixes, eg
+ ``2M``. Some backend store specified by ``mem-path`` requires an
+ alignment different than the default one used by QEMU, eg the
+ device DAX /dev/dax0.0 requires 2M alignment rather than 4K. In
+ such cases, users can specify the required alignment via this
+ option.
+
+ The ``pmem`` option specifies whether the backing file specified
+ by ``mem-path`` is in host persistent memory that can be
+ accessed using the SNIA NVM programming model (e.g. Intel
+ NVDIMM). If ``pmem`` is set to 'on', QEMU will take necessary
+ operations to guarantee the persistence of its own writes to
+ ``mem-path`` (e.g. in vNVDIMM label emulation and live
+ migration). Also, we will map the backend-file with MAP\_SYNC
+ flag, which ensures the file metadata is in sync for
+ ``mem-path`` in case of host crash or a power failure. MAP\_SYNC
+ requires support from both the host kernel (since Linux kernel
+ 4.15) and the filesystem of ``mem-path`` mounted with DAX
+ option.
+
+ ``-object memory-backend-ram,id=id,merge=on|off,dump=on|off,share=on|off,prealloc=on|off,size=size,host-nodes=host-nodes,policy=default|preferred|bind|interleave``
+ Creates a memory backend object, which can be used to back the
+ guest RAM. Memory backend objects offer more control than the
+ ``-m`` option that is traditionally used to define guest RAM.
+ Please refer to ``memory-backend-file`` for a description of the
+ options.
+
+ ``-object memory-backend-memfd,id=id,merge=on|off,dump=on|off,share=on|off,prealloc=on|off,size=size,host-nodes=host-nodes,policy=default|preferred|bind|interleave,seal=on|off,hugetlb=on|off,hugetlbsize=size``
+ Creates an anonymous memory file backend object, which allows
+ QEMU to share the memory with an external process (e.g. when
+ using vhost-user). The memory is allocated with memfd and
+ optional sealing. (Linux only)
+
+ The ``seal`` option creates a sealed-file, that will block
+ further resizing the memory ('on' by default).
+
+ The ``hugetlb`` option specify the file to be created resides in
+ the hugetlbfs filesystem (since Linux 4.14). Used in conjunction
+ with the ``hugetlb`` option, the ``hugetlbsize`` option specify
+ the hugetlb page size on systems that support multiple hugetlb
+ page sizes (it must be a power of 2 value supported by the
+ system).
+
+ In some versions of Linux, the ``hugetlb`` option is
+ incompatible with the ``seal`` option (requires at least Linux
+ 4.16).
+
+ Please refer to ``memory-backend-file`` for a description of the
+ other options.
+
+ The ``share`` boolean option is on by default with memfd.
+
+ ``-object rng-builtin,id=id``
+ Creates a random number generator backend which obtains entropy
+ from QEMU builtin functions. The ``id`` parameter is a unique ID
+ that will be used to reference this entropy backend from the
+ ``virtio-rng`` device. By default, the ``virtio-rng`` device
+ uses this RNG backend.
+
+ ``-object rng-random,id=id,filename=/dev/random``
+ Creates a random number generator backend which obtains entropy
+ from a device on the host. The ``id`` parameter is a unique ID
+ that will be used to reference this entropy backend from the
+ ``virtio-rng`` device. The ``filename`` parameter specifies
+ which file to obtain entropy from and if omitted defaults to
+ ``/dev/urandom``.
+
+ ``-object rng-egd,id=id,chardev=chardevid``
+ Creates a random number generator backend which obtains entropy
+ from an external daemon running on the host. The ``id``
+ parameter is a unique ID that will be used to reference this
+ entropy backend from the ``virtio-rng`` device. The ``chardev``
+ parameter is the unique ID of a character device backend that
+ provides the connection to the RNG daemon.
+
+ ``-object tls-creds-anon,id=id,endpoint=endpoint,dir=/path/to/cred/dir,verify-peer=on|off``
+ Creates a TLS anonymous credentials object, which can be used to
+ provide TLS support on network backends. The ``id`` parameter is
+ a unique ID which network backends will use to access the
+ credentials. The ``endpoint`` is either ``server`` or ``client``
+ depending on whether the QEMU network backend that uses the
+ credentials will be acting as a client or as a server. If
+ ``verify-peer`` is enabled (the default) then once the handshake
+ is completed, the peer credentials will be verified, though this
+ is a no-op for anonymous credentials.
+
+ The dir parameter tells QEMU where to find the credential files.
+ For server endpoints, this directory may contain a file
+ dh-params.pem providing diffie-hellman parameters to use for the
+ TLS server. If the file is missing, QEMU will generate a set of
+ DH parameters at startup. This is a computationally expensive
+ operation that consumes random pool entropy, so it is
+ recommended that a persistent set of parameters be generated
+ upfront and saved.
+
+ ``-object tls-creds-psk,id=id,endpoint=endpoint,dir=/path/to/keys/dir[,username=username]``
+ Creates a TLS Pre-Shared Keys (PSK) credentials object, which
+ can be used to provide TLS support on network backends. The
+ ``id`` parameter is a unique ID which network backends will use
+ to access the credentials. The ``endpoint`` is either ``server``
+ or ``client`` depending on whether the QEMU network backend that
+ uses the credentials will be acting as a client or as a server.
+ For clients only, ``username`` is the username which will be
+ sent to the server. If omitted it defaults to "qemu".
+
+ The dir parameter tells QEMU where to find the keys file. It is
+ called "dir/keys.psk" and contains "username:key" pairs. This
+ file can most easily be created using the GnuTLS ``psktool``
+ program.
+
+ For server endpoints, dir may also contain a file dh-params.pem
+ providing diffie-hellman parameters to use for the TLS server.
+ If the file is missing, QEMU will generate a set of DH
+ parameters at startup. This is a computationally expensive
+ operation that consumes random pool entropy, so it is
+ recommended that a persistent set of parameters be generated up
+ front and saved.
+
+ ``-object tls-creds-x509,id=id,endpoint=endpoint,dir=/path/to/cred/dir,priority=priority,verify-peer=on|off,passwordid=id``
+ Creates a TLS anonymous credentials object, which can be used to
+ provide TLS support on network backends. The ``id`` parameter is
+ a unique ID which network backends will use to access the
+ credentials. The ``endpoint`` is either ``server`` or ``client``
+ depending on whether the QEMU network backend that uses the
+ credentials will be acting as a client or as a server. If
+ ``verify-peer`` is enabled (the default) then once the handshake
+ is completed, the peer credentials will be verified. With x509
+ certificates, this implies that the clients must be provided
+ with valid client certificates too.
+
+ The dir parameter tells QEMU where to find the credential files.
+ For server endpoints, this directory may contain a file
+ dh-params.pem providing diffie-hellman parameters to use for the
+ TLS server. If the file is missing, QEMU will generate a set of
+ DH parameters at startup. This is a computationally expensive
+ operation that consumes random pool entropy, so it is
+ recommended that a persistent set of parameters be generated
+ upfront and saved.
+
+ For x509 certificate credentials the directory will contain
+ further files providing the x509 certificates. The certificates
+ must be stored in PEM format, in filenames ca-cert.pem,
+ ca-crl.pem (optional), server-cert.pem (only servers),
+ server-key.pem (only servers), client-cert.pem (only clients),
+ and client-key.pem (only clients).
+
+ For the server-key.pem and client-key.pem files which contain
+ sensitive private keys, it is possible to use an encrypted
+ version by providing the passwordid parameter. This provides the
+ ID of a previously created ``secret`` object containing the
+ password for decryption.
+
+ The priority parameter allows to override the global default
+ priority used by gnutls. This can be useful if the system
+ administrator needs to use a weaker set of crypto priorities for
+ QEMU without potentially forcing the weakness onto all
+ applications. Or conversely if one wants wants a stronger
+ default for QEMU than for all other applications, they can do
+ this through this parameter. Its format is a gnutls priority
+ string as described at
+ https://gnutls.org/manual/html_node/Priority-Strings.html.
+
+ ``-object filter-buffer,id=id,netdev=netdevid,interval=t[,queue=all|rx|tx][,status=on|off]``
+ Interval t can't be 0, this filter batches the packet delivery:
+ all packets arriving in a given interval on netdev netdevid are
+ delayed until the end of the interval. Interval is in
+ microseconds. ``status`` is optional that indicate whether the
+ netfilter is on (enabled) or off (disabled), the default status
+ for netfilter will be 'on'.
+
+ queue all\|rx\|tx is an option that can be applied to any
+ netfilter.
+
+ ``all``: the filter is attached both to the receive and the
+ transmit queue of the netdev (default).
+
+ ``rx``: the filter is attached to the receive queue of the
+ netdev, where it will receive packets sent to the netdev.
+
+ ``tx``: the filter is attached to the transmit queue of the
+ netdev, where it will receive packets sent by the netdev.
+
+ ``-object filter-mirror,id=id,netdev=netdevid,outdev=chardevid,queue=all|rx|tx[,vnet_hdr_support]``
+ filter-mirror on netdev netdevid,mirror net packet to
+ chardevchardevid, if it has the vnet\_hdr\_support flag,
+ filter-mirror will mirror packet with vnet\_hdr\_len.
+
+ ``-object filter-redirector,id=id,netdev=netdevid,indev=chardevid,outdev=chardevid,queue=all|rx|tx[,vnet_hdr_support]``
+ filter-redirector on netdev netdevid,redirect filter's net
+ packet to chardev chardevid,and redirect indev's packet to
+ filter.if it has the vnet\_hdr\_support flag, filter-redirector
+ will redirect packet with vnet\_hdr\_len. Create a
+ filter-redirector we need to differ outdev id from indev id, id
+ can not be the same. we can just use indev or outdev, but at
+ least one of indev or outdev need to be specified.
+
+ ``-object filter-rewriter,id=id,netdev=netdevid,queue=all|rx|tx,[vnet_hdr_support]``
+ Filter-rewriter is a part of COLO project.It will rewrite tcp
+ packet to secondary from primary to keep secondary tcp
+ connection,and rewrite tcp packet to primary from secondary make
+ tcp packet can be handled by client.if it has the
+ vnet\_hdr\_support flag, we can parse packet with vnet header.
+
+ usage: colo secondary: -object
+ filter-redirector,id=f1,netdev=hn0,queue=tx,indev=red0 -object
+ filter-redirector,id=f2,netdev=hn0,queue=rx,outdev=red1 -object
+ filter-rewriter,id=rew0,netdev=hn0,queue=all
+
+ ``-object filter-dump,id=id,netdev=dev[,file=filename][,maxlen=len]``
+ Dump the network traffic on netdev dev to the file specified by
+ filename. At most len bytes (64k by default) per packet are
+ stored. The file format is libpcap, so it can be analyzed with
+ tools such as tcpdump or Wireshark.
+
+ ``-object colo-compare,id=id,primary_in=chardevid,secondary_in=chardevid,outdev=chardevid,iothread=id[,vnet_hdr_support][,notify_dev=id]``
+ Colo-compare gets packet from primary\_inchardevid and
+ secondary\_inchardevid, than compare primary packet with
+ secondary packet. If the packets are same, we will output
+ primary packet to outdevchardevid, else we will notify
+ colo-frame do checkpoint and send primary packet to
+ outdevchardevid. In order to improve efficiency, we need to put
+ the task of comparison in another thread. If it has the
+ vnet\_hdr\_support flag, colo compare will send/recv packet with
+ vnet\_hdr\_len. If you want to use Xen COLO, will need the
+ notify\_dev to notify Xen colo-frame to do checkpoint.
+
+ we must use it with the help of filter-mirror and
+ filter-redirector.
+
+ ::
+
+ KVM COLO
+
+ primary:
+ -netdev tap,id=hn0,vhost=off,script=/etc/qemu-ifup,downscript=/etc/qemu-ifdown
+ -device e1000,id=e0,netdev=hn0,mac=52:a4:00:12:78:66
+ -chardev socket,id=mirror0,host=3.3.3.3,port=9003,server,nowait
+ -chardev socket,id=compare1,host=3.3.3.3,port=9004,server,nowait
+ -chardev socket,id=compare0,host=3.3.3.3,port=9001,server,nowait
+ -chardev socket,id=compare0-0,host=3.3.3.3,port=9001
+ -chardev socket,id=compare_out,host=3.3.3.3,port=9005,server,nowait
+ -chardev socket,id=compare_out0,host=3.3.3.3,port=9005
+ -object iothread,id=iothread1
+ -object filter-mirror,id=m0,netdev=hn0,queue=tx,outdev=mirror0
+ -object filter-redirector,netdev=hn0,id=redire0,queue=rx,indev=compare_out
+ -object filter-redirector,netdev=hn0,id=redire1,queue=rx,outdev=compare0
+ -object colo-compare,id=comp0,primary_in=compare0-0,secondary_in=compare1,outdev=compare_out0,iothread=iothread1
+
+ secondary:
+ -netdev tap,id=hn0,vhost=off,script=/etc/qemu-ifup,down script=/etc/qemu-ifdown
+ -device e1000,netdev=hn0,mac=52:a4:00:12:78:66
+ -chardev socket,id=red0,host=3.3.3.3,port=9003
+ -chardev socket,id=red1,host=3.3.3.3,port=9004
+ -object filter-redirector,id=f1,netdev=hn0,queue=tx,indev=red0
+ -object filter-redirector,id=f2,netdev=hn0,queue=rx,outdev=red1
+
+
+ Xen COLO
+
+ primary:
+ -netdev tap,id=hn0,vhost=off,script=/etc/qemu-ifup,downscript=/etc/qemu-ifdown
+ -device e1000,id=e0,netdev=hn0,mac=52:a4:00:12:78:66
+ -chardev socket,id=mirror0,host=3.3.3.3,port=9003,server,nowait
+ -chardev socket,id=compare1,host=3.3.3.3,port=9004,server,nowait
+ -chardev socket,id=compare0,host=3.3.3.3,port=9001,server,nowait
+ -chardev socket,id=compare0-0,host=3.3.3.3,port=9001
+ -chardev socket,id=compare_out,host=3.3.3.3,port=9005,server,nowait
+ -chardev socket,id=compare_out0,host=3.3.3.3,port=9005
+ -chardev socket,id=notify_way,host=3.3.3.3,port=9009,server,nowait
+ -object filter-mirror,id=m0,netdev=hn0,queue=tx,outdev=mirror0
+ -object filter-redirector,netdev=hn0,id=redire0,queue=rx,indev=compare_out
+ -object filter-redirector,netdev=hn0,id=redire1,queue=rx,outdev=compare0
+ -object iothread,id=iothread1
+ -object colo-compare,id=comp0,primary_in=compare0-0,secondary_in=compare1,outdev=compare_out0,notify_dev=nofity_way,iothread=iothread1
+
+ secondary:
+ -netdev tap,id=hn0,vhost=off,script=/etc/qemu-ifup,down script=/etc/qemu-ifdown
+ -device e1000,netdev=hn0,mac=52:a4:00:12:78:66
+ -chardev socket,id=red0,host=3.3.3.3,port=9003
+ -chardev socket,id=red1,host=3.3.3.3,port=9004
+ -object filter-redirector,id=f1,netdev=hn0,queue=tx,indev=red0
+ -object filter-redirector,id=f2,netdev=hn0,queue=rx,outdev=red1
+
+ If you want to know the detail of above command line, you can
+ read the colo-compare git log.
+
+ ``-object cryptodev-backend-builtin,id=id[,queues=queues]``
+ Creates a cryptodev backend which executes crypto opreation from
+ the QEMU cipher APIS. The id parameter is a unique ID that will
+ be used to reference this cryptodev backend from the
+ ``virtio-crypto`` device. The queues parameter is optional,
+ which specify the queue number of cryptodev backend, the default
+ of queues is 1.
+
+ ::
+
+ # |qemu_system| \
+ [...] \
+ -object cryptodev-backend-builtin,id=cryptodev0 \
+ -device virtio-crypto-pci,id=crypto0,cryptodev=cryptodev0 \
+ [...]
+
+ ``-object cryptodev-vhost-user,id=id,chardev=chardevid[,queues=queues]``
+ Creates a vhost-user cryptodev backend, backed by a chardev
+ chardevid. The id parameter is a unique ID that will be used to
+ reference this cryptodev backend from the ``virtio-crypto``
+ device. The chardev should be a unix domain socket backed one.
+ The vhost-user uses a specifically defined protocol to pass
+ vhost ioctl replacement messages to an application on the other
+ end of the socket. The queues parameter is optional, which
+ specify the queue number of cryptodev backend for multiqueue
+ vhost-user, the default of queues is 1.
+
+ ::
+
+ # |qemu_system| \
+ [...] \
+ -chardev socket,id=chardev0,path=/path/to/socket \
+ -object cryptodev-vhost-user,id=cryptodev0,chardev=chardev0 \
+ -device virtio-crypto-pci,id=crypto0,cryptodev=cryptodev0 \
+ [...]
+
+ ``-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
+ directly via the data parameter, or indirectly via the file
+ parameter. Using the data parameter is insecure unless the
+ sensitive data is encrypted.
+
+ The sensitive data can be provided in raw format (the default),
+ or base64. When encoded as JSON, the raw format only supports
+ valid UTF-8 characters, so base64 is recommended for sending
+ binary data. QEMU will convert from which ever format is
+ provided to the format it needs internally. eg, an RBD password
+ can be provided in raw format, even though it will be base64
+ encoded when passed onto the RBD sever.
+
+ For added protection, it is possible to encrypt the data
+ associated with a secret using the AES-256-CBC cipher. Use of
+ encryption is indicated by providing the keyid and iv
+ parameters. The keyid parameter provides the ID of a previously
+ defined secret that contains the AES-256 decryption key. This
+ key should be 32-bytes long and be base64 encoded. The iv
+ parameter provides the random initialization vector used for
+ encryption of this particular secret and should be a base64
+ encrypted string of the 16-byte IV.
+
+ The simplest (insecure) usage is to provide the secret inline
+
+ ::
+
+ # |qemu_system| -object secret,id=sec0,data=letmein,format=raw
+
+ The simplest secure usage is to provide the secret via a file
+
+ # printf "letmein" > mypasswd.txt # QEMU\_SYSTEM\_MACRO -object
+ secret,id=sec0,file=mypasswd.txt,format=raw
+
+ For greater security, AES-256-CBC should be used. To illustrate
+ usage, consider the openssl command line tool which can encrypt
+ the data. Note that when encrypting, the plaintext must be
+ padded to the cipher block size (32 bytes) using the standard
+ PKCS#5/6 compatible padding algorithm.
+
+ First a master key needs to be created in base64 encoding:
+
+ ::
+
+ # openssl rand -base64 32 > key.b64
+ # KEY=$(base64 -d key.b64 | hexdump -v -e '/1 "%02X"')
+
+ Each secret to be encrypted needs to have a random
+ initialization vector generated. These do not need to be kept
+ secret
+
+ ::
+
+ # openssl rand -base64 16 > iv.b64
+ # IV=$(base64 -d iv.b64 | hexdump -v -e '/1 "%02X"')
+
+ The secret to be defined can now be encrypted, in this case
+ we're telling openssl to base64 encode the result, but it could
+ be left as raw bytes if desired.
+
+ ::
+
+ # SECRET=$(printf "letmein" |
+ openssl enc -aes-256-cbc -a -K $KEY -iv $IV)
+
+ When launching QEMU, create a master secret pointing to
+ ``key.b64`` and specify that to be used to decrypt the user
+ password. Pass the contents of ``iv.b64`` to the second secret
+
+ ::
+
+ # |qemu_system| \
+ -object secret,id=secmaster0,format=base64,file=key.b64 \
+ -object secret,id=sec0,keyid=secmaster0,format=base64,\
+ data=$SECRET,iv=$(<iv.b64)
+
+ ``-object sev-guest,id=id,cbitpos=cbitpos,reduced-phys-bits=val,[sev-device=string,policy=policy,handle=handle,dh-cert-file=file,session-file=file]``
+ Create a Secure Encrypted Virtualization (SEV) guest object,
+ which can be used to provide the guest memory encryption support
+ on AMD processors.
+
+ When memory encryption is enabled, one of the physical address
+ bit (aka the C-bit) is utilized to mark if a memory page is
+ protected. The ``cbitpos`` is used to provide the C-bit
+ position. The C-bit position is Host family dependent hence user
+ must provide this value. On EPYC, the value should be 47.
+
+ When memory encryption is enabled, we loose certain bits in
+ physical address space. The ``reduced-phys-bits`` is used to
+ provide the number of bits we loose in physical address space.
+ Similar to C-bit, the value is Host family dependent. On EPYC,
+ the value should be 5.
+
+ The ``sev-device`` provides the device file to use for
+ communicating with the SEV firmware running inside AMD Secure
+ Processor. The default device is '/dev/sev'. If hardware
+ supports memory encryption then /dev/sev devices are created by
+ CCP driver.
+
+ The ``policy`` provides the guest policy to be enforced by the
+ SEV firmware and restrict what configuration and operational
+ commands can be performed on this guest by the hypervisor. The
+ policy should be provided by the guest owner and is bound to the
+ guest and cannot be changed throughout the lifetime of the
+ guest. The default is 0.
+
+ If guest ``policy`` allows sharing the key with another SEV
+ guest then ``handle`` can be use to provide handle of the guest
+ from which to share the key.
+
+ The ``dh-cert-file`` and ``session-file`` provides the guest
+ owner's Public Diffie-Hillman key defined in SEV spec. The PDH
+ and session parameters are used for establishing a cryptographic
+ session with the guest owner to negotiate keys used for
+ attestation. The file must be encoded in base64.
+
+ e.g to launch a SEV guest
+
+ ::
+
+ # |qemu_system_x86| \
+ ......
+ -object sev-guest,id=sev0,cbitpos=47,reduced-phys-bits=5 \
+ -machine ...,memory-encryption=sev0
+ .....
+
+ ``-object authz-simple,id=id,identity=string``
+ Create an authorization object that will control access to
+ network services.
+
+ The ``identity`` parameter is identifies the user and its format
+ depends on the network service that authorization object is
+ associated with. For authorizing based on TLS x509 certificates,
+ the identity must be the x509 distinguished name. Note that care
+ must be taken to escape any commas in the distinguished name.
+
+ An example authorization object to validate a x509 distinguished
+ name would look like:
+
+ ::
+
+ # |qemu_system| \
+ ...
+ -object 'authz-simple,id=auth0,identity=CN=laptop.example.com,,O=Example Org,,L=London,,ST=London,,C=GB' \
+ ...
+
+ Note the use of quotes due to the x509 distinguished name
+ containing whitespace, and escaping of ','.
+
+ ``-object authz-listfile,id=id,filename=path,refresh=yes|no``
+ Create an authorization object that will control access to
+ network services.
+
+ The ``filename`` parameter is the fully qualified path to a file
+ containing the access control list rules in JSON format.
+
+ An example set of rules that match against SASL usernames might
+ look like:
+
+ ::
+
+ {
+ "rules": [
+ { "match": "fred", "policy": "allow", "format": "exact" },
+ { "match": "bob", "policy": "allow", "format": "exact" },
+ { "match": "danb", "policy": "deny", "format": "glob" },
+ { "match": "dan*", "policy": "allow", "format": "exact" },
+ ],
+ "policy": "deny"
+ }
+
+ When checking access the object will iterate over all the rules
+ and the first rule to match will have its ``policy`` value
+ returned as the result. If no rules match, then the default
+ ``policy`` value is returned.
+
+ The rules can either be an exact string match, or they can use
+ the simple UNIX glob pattern matching to allow wildcards to be
+ used.
+
+ If ``refresh`` is set to true the file will be monitored and
+ automatically reloaded whenever its content changes.
+
+ As with the ``authz-simple`` object, the format of the identity
+ strings being matched depends on the network service, but is
+ usually a TLS x509 distinguished name, or a SASL username.
+
+ An example authorization object to validate a SASL username
+ would look like:
+
+ ::
+
+ # |qemu_system| \
+ ...
+ -object authz-simple,id=auth0,filename=/etc/qemu/vnc-sasl.acl,refresh=yes
+ ...
+
+ ``-object authz-pam,id=id,service=string``
+ Create an authorization object that will control access to
+ network services.
+
+ The ``service`` parameter provides the name of a PAM service to
+ use for authorization. It requires that a file
+ ``/etc/pam.d/service`` exist to provide the configuration for
+ the ``account`` subsystem.
+
+ An example authorization object to validate a TLS x509
+ distinguished name would look like:
+
+ ::
+
+ # |qemu_system| \
+ ...
+ -object authz-pam,id=auth0,service=qemu-vnc
+ ...
+
+ There would then be a corresponding config file for PAM at
+ ``/etc/pam.d/qemu-vnc`` that contains:
+
+ ::
+
+ account requisite pam_listfile.so item=user sense=allow \
+ file=/etc/qemu/vnc.allow
+
+ Finally the ``/etc/qemu/vnc.allow`` file would contain the list
+ of x509 distingished names that are permitted access
+
+ ::
+
+ CN=laptop.example.com,O=Example Home,L=London,ST=London,C=GB
+
+ ``-object iothread,id=id,poll-max-ns=poll-max-ns,poll-grow=poll-grow,poll-shrink=poll-shrink``
+ Creates a dedicated event loop thread that devices can be
+ assigned to. This is known as an IOThread. By default device
+ emulation happens in vCPU threads or the main event loop thread.
+ This can become a scalability bottleneck. IOThreads allow device
+ emulation and I/O to run on other host CPUs.
+
+ The ``id`` parameter is a unique ID that will be used to
+ reference this IOThread from ``-device ...,iothread=id``.
+ Multiple devices can be assigned to an IOThread. Note that not
+ all devices support an ``iothread`` parameter.
+
+ The ``query-iothreads`` QMP command lists IOThreads and reports
+ their thread IDs so that the user can configure host CPU
+ pinning/affinity.
+
+ IOThreads use an adaptive polling algorithm to reduce event loop
+ latency. Instead of entering a blocking system call to monitor
+ file descriptors and then pay the cost of being woken up when an
+ event occurs, the polling algorithm spins waiting for events for
+ a short time. The algorithm's default parameters are suitable
+ for many cases but can be adjusted based on knowledge of the
+ workload and/or host device latency.
+
+ The ``poll-max-ns`` parameter is the maximum number of
+ nanoseconds to busy wait for events. Polling can be disabled by
+ setting this value to 0.
+
+ The ``poll-grow`` parameter is the multiplier used to increase
+ the polling time when the algorithm detects it is missing events
+ due to not polling long enough.
+
+ The ``poll-shrink`` parameter is the divisor used to decrease
+ the polling time when the algorithm detects it is spending too
+ long polling without encountering events.
+
+ The polling parameters can be modified at run-time using the
+ ``qom-set`` command (where ``iothread1`` is the IOThread's
+ ``id``):
+
+ ::
+
+ (qemu) qom-set /objects/iothread1 poll-max-ns 100000
+ERST
HXCOMM This is the last statement. Insert new options before this line!
--
2.20.1
^ permalink raw reply related [flat|nested] 82+ messages in thread* Re: [PATCH v3 26/33] qemu-options.hx: Add rST documentation fragments
2020-02-28 15:36 ` [PATCH v3 26/33] qemu-options.hx: Add rST documentation fragments Peter Maydell
@ 2020-03-02 12:20 ` Alex Bennée
0 siblings, 0 replies; 82+ messages in thread
From: Alex Bennée @ 2020-03-02 12:20 UTC (permalink / raw)
To: Peter Maydell; +Cc: Paolo Bonzini, qemu-devel, Kashyap Chamarthy
Peter Maydell <peter.maydell@linaro.org> writes:
> Add the rST versions of the documentation fragments to qemu-options.hx.
>
> This is entirely autogenerated using scripts/hxtool-conv.pl.
> The result is not quite valid rST in all places; the following
> commit will have the manual adjustments needed.
>
> Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
Reviewed-by: Alex Bennée <alex.bennee@linaro.org>
> ---
> qemu-options.hx | 3999 +++++++++++++++++++++++++++++++++++++++++++++++
> 1 file changed, 3999 insertions(+)
>
> diff --git a/qemu-options.hx b/qemu-options.hx
> index 3b230a17164..043e425b61e 100644
> --- a/qemu-options.hx
> +++ b/qemu-options.hx
> @@ -18,6 +18,10 @@ STEXI
> @findex -h
> Display help and exit
> ETEXI
> +SRST
> +``-h``
> + Display help and exit
> +ERST
>
> DEF("version", 0, QEMU_OPTION_version,
> "-version display version information and exit\n", QEMU_ARCH_ALL)
> @@ -26,6 +30,10 @@ STEXI
> @findex -version
> Display version information and exit
> ETEXI
> +SRST
> +``-version``
> + Display version information and exit
> +ERST
>
> DEF("machine", HAS_ARG, QEMU_OPTION_machine, \
> "-machine [type=]name[,prop[=value][,...]]\n"
> @@ -100,6 +108,73 @@ Enables or disables ACPI Heterogeneous Memory Attribute Table (HMAT) support.
> The default is off.
> @end table
> ETEXI
> +SRST
> +``-machine [type=]name[,prop=value[,...]]``
> + Select the emulated machine by name. Use ``-machine help`` to list
> + available machines.
> +
> + For architectures which aim to support live migration compatibility
> + across releases, each release will introduce a new versioned machine
> + type. For example, the 2.8.0 release introduced machine types
> + "pc-i440fx-2.8" and "pc-q35-2.8" for the x86\_64/i686 architectures.
> +
> + To allow live migration of guests from QEMU version 2.8.0, to QEMU
> + version 2.9.0, the 2.9.0 version must support the "pc-i440fx-2.8"
> + and "pc-q35-2.8" machines too. To allow users live migrating VMs to
> + skip multiple intermediate releases when upgrading, new releases of
> + QEMU will support machine types from many previous versions.
> +
> + Supported machine properties are:
> +
> + ``accel=accels1[:accels2[:...]]``
> + This is used to enable an accelerator. Depending on the target
> + architecture, kvm, xen, hax, hvf, whpx or tcg can be available.
> + By default, tcg is used. If there is more than one accelerator
> + specified, the next one is used if the previous one fails to
> + initialize.
> +
> + ``vmport=on|off|auto``
> + Enables emulation of VMWare IO port, for vmmouse etc. auto says
> + to select the value based on accel. For accel=xen the default is
> + off otherwise the default is on.
> +
> + ``dump-guest-core=on|off``
> + Include guest memory in a core dump. The default is on.
> +
> + ``mem-merge=on|off``
> + Enables or disables memory merge support. This feature, when
> + supported by the host, de-duplicates identical memory pages
> + among VMs instances (enabled by default).
> +
> + ``aes-key-wrap=on|off``
> + Enables or disables AES key wrapping support on s390-ccw hosts.
> + This feature controls whether AES wrapping keys will be created
> + to allow execution of AES cryptographic functions. The default
> + is on.
> +
> + ``dea-key-wrap=on|off``
> + Enables or disables DEA key wrapping support on s390-ccw hosts.
> + This feature controls whether DEA wrapping keys will be created
> + to allow execution of DEA cryptographic functions. The default
> + is on.
> +
> + ``nvdimm=on|off``
> + Enables or disables NVDIMM support. The default is off.
> +
> + ``enforce-config-section=on|off``
> + If ``enforce-config-section`` is set to on, force migration code
> + to send configuration section even if the machine-type sets the
> + ``migration.send-configuration`` property to off. NOTE: this
> + parameter is deprecated. Please use ``-global``
> + ``migration.send-configuration``\ =on\|off instead.
> +
> + ``memory-encryption=``
> + Memory encryption object to use. The default is none.
> +
> + ``hmat=on|off``
> + Enables or disables ACPI Heterogeneous Memory Attribute Table
> + (HMAT) support. The default is off.
> +ERST
>
> HXCOMM Deprecated by -machine
> DEF("M", HAS_ARG, QEMU_OPTION_M, "", QEMU_ARCH_ALL)
> @@ -111,6 +186,11 @@ STEXI
> @findex -cpu
> Select CPU model (@code{-cpu help} for list and additional feature selection)
> ETEXI
> +SRST
> +``-cpu model``
> + Select CPU model (``-cpu help`` for list and additional feature
> + selection)
> +ERST
>
> DEF("accel", HAS_ARG, QEMU_OPTION_accel,
> "-accel [accel=]accelerator[,prop[=value][,...]]\n"
> @@ -147,6 +227,40 @@ is to enable multi-threading where both the back-end and front-ends support it a
> no incompatible TCG features have been enabled (e.g. icount/replay).
> @end table
> ETEXI
> +SRST
> +``-accel name[,prop=value[,...]]``
> + This is used to enable an accelerator. Depending on the target
> + architecture, kvm, xen, hax, hvf, whpx or tcg can be available. By
> + default, tcg is used. If there is more than one accelerator
> + specified, the next one is used if the previous one fails to
> + initialize.
> +
> + ``igd-passthru=on|off``
> + When Xen is in use, this option controls whether Intel
> + integrated graphics devices can be passed through to the guest
> + (default=off)
> +
> + ``kernel-irqchip=on|off|split``
> + Controls KVM in-kernel irqchip support. The default is full
> + acceleration of the interrupt controllers. On x86, split irqchip
> + reduces the kernel attack surface, at a performance cost for
> + non-MSI interrupts. Disabling the in-kernel irqchip completely
> + is not recommended except for debugging purposes.
> +
> + ``kvm-shadow-mem=size``
> + Defines the size of the KVM shadow MMU.
> +
> + ``tb-size=n``
> + Controls the size (in MiB) of the TCG translation block cache.
> +
> + ``thread=single|multi``
> + Controls number of TCG threads. When the TCG is multi-threaded
> + there will be one thread per vCPU therefor taking advantage of
> + additional host cores. The default is to enable multi-threading
> + where both the back-end and front-ends support it and no
> + incompatible TCG features have been enabled (e.g.
> + icount/replay).
> +ERST
>
> DEF("smp", HAS_ARG, QEMU_OPTION_smp,
> "-smp [cpus=]n[,maxcpus=cpus][,cores=cores][,threads=threads][,dies=dies][,sockets=sockets]\n"
> @@ -170,6 +284,17 @@ per cores, the number of @var{dies} per packages and the total number of
> If any on the three values is given, the total number of CPUs @var{n} can be omitted.
> @var{maxcpus} specifies the maximum number of hotpluggable CPUs.
> ETEXI
> +SRST
> +``-smp [cpus=]n[,cores=cores][,threads=threads][,dies=dies][,sockets=sockets][,maxcpus=maxcpus]``
> + Simulate an SMP system with n CPUs. On the PC target, up to 255 CPUs
> + are supported. On Sparc32 target, Linux limits the number of usable
> + CPUs to 4. For the PC target, the number of cores per die, the
> + number of threads per cores, the number of dies per packages and the
> + total number of sockets can be specified. Missing values will be
> + computed. If any on the three values is given, the total number of
> + CPUs n can be omitted. maxcpus specifies the maximum number of
> + hotpluggable CPUs.
> +ERST
>
> DEF("numa", HAS_ARG, QEMU_OPTION_numa,
> "-numa node[,mem=size][,cpus=firstcpu[-lastcpu]][,nodeid=node][,initiator=node]\n"
> @@ -322,6 +447,152 @@ cache, size is 10KB, policy is write-back, the cache Line size is 8 bytes:
> @end example
>
> 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]``
> + 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.
> +
> + Legacy VCPU assignment uses '\ ``cpus``\ ' option where firstcpu and
> + lastcpu are CPU indexes. Each '\ ``cpus``\ ' option represent a
> + contiguous range of CPU indexes (or a single VCPU if lastcpu is
> + omitted). A non-contiguous set of VCPUs can be represented by
> + providing multiple '\ ``cpus``\ ' options. If '\ ``cpus``\ ' is
> + omitted on all nodes, VCPUs are automatically split between them.
> +
> + For example, the following option assigns VCPUs 0, 1, 2 and 5 to a
> + NUMA node:
> +
> + ::
> +
> + -numa node,cpus=0-2,cpus=5
> +
> + '\ ``cpu``\ ' option is a new alternative to '\ ``cpus``\ ' option
> + which uses '\ ``socket-id|core-id|thread-id``\ ' properties to
> + assign CPU objects to a node using topology layout properties of
> + CPU. The set of properties is machine specific, and depends on used
> + machine type/'\ ``smp``\ ' options. It could be queried with
> + '\ ``hotpluggable-cpus``\ ' monitor command. '\ ``node-id``\ '
> + property specifies node to which CPU object will be assigned, it's
> + required for node to be declared with '\ ``node``\ ' option before
> + it's used with '\ ``cpu``\ ' option.
> +
> + For example:
> +
> + ::
> +
> + -M pc \
> + -smp 1,sockets=2,maxcpus=2 \
> + -numa node,nodeid=0 -numa node,nodeid=1 \
> + -numa cpu,node-id=0,socket-id=0 -numa cpu,node-id=1,socket-id=1
> +
> + '\ ``mem``\ ' assigns a given RAM amount to a node. '\ ``memdev``\ '
> + assigns RAM from a given memory backend device to a node. If
> + '\ ``mem``\ ' and '\ ``memdev``\ ' are omitted in all nodes, RAM is
> + split equally between them.
> +
> + '\ ``mem``\ ' and '\ ``memdev``\ ' are mutually exclusive.
> + Furthermore, if one node uses '\ ``memdev``\ ', all of them have to
> + use it.
> +
> + '\ ``initiator``\ ' is an additional option that points to an
> + initiator NUMA node that has best performance (the lowest latency or
> + largest bandwidth) to this NUMA node. Note that this option can be
> + set only when the machine property 'hmat' is set to 'on'.
> +
> + Following example creates a machine with 2 NUMA nodes, node 0 has
> + CPU. node 1 has only memory, and its initiator is node 0. Note that
> + because node 0 has CPU, by default the initiator of node 0 is itself
> + and must be itself.
> +
> + ::
> +
> + -machine hmat=on \
> + -m 2G,slots=2,maxmem=4G \
> + -object memory-backend-ram,size=1G,id=m0 \
> + -object memory-backend-ram,size=1G,id=m1 \
> + -numa node,nodeid=0,memdev=m0 \
> + -numa node,nodeid=1,memdev=m1,initiator=0 \
> + -smp 2,sockets=2,maxcpus=2 \
> + -numa cpu,node-id=0,socket-id=0 \
> + -numa cpu,node-id=0,socket-id=1
> +
> + source and destination are NUMA node IDs. distance is the NUMA
> + distance from source to destination. The distance from a node to
> + itself is always 10. If any pair of nodes is given a distance, then
> + all pairs must be given distances. Although, when distances are only
> + given in one direction for each pair of nodes, then the distances in
> + the opposite directions are assumed to be the same. If, however, an
> + asymmetrical pair of distances is given for even one node pair, then
> + all node pairs must be provided distance values for both directions,
> + even when they are symmetrical. When a node is unreachable from
> + another node, set the pair's distance to 255.
> +
> + Note that the -``numa`` option doesn't allocate any of the specified
> + resources, it just assigns existing resources to NUMA nodes. This
> + means that one still has to use the ``-m``, ``-smp`` options to
> + allocate RAM and VCPUs respectively.
> +
> + Use '\ ``hmat-lb``\ ' to set System Locality Latency and Bandwidth
> + Information between initiator and target NUMA nodes in ACPI
> + Heterogeneous Attribute Memory Table (HMAT). Initiator NUMA node can
> + create memory requests, usually it has one or more processors.
> + Target NUMA node contains addressable memory.
> +
> + In '\ ``hmat-lb``\ ' option, node are NUMA node IDs. hierarchy is
> + the memory hierarchy of the target NUMA node: if hierarchy is
> + 'memory', the structure represents the memory performance; if
> + hierarchy is 'first-level\|second-level\|third-level', this
> + structure represents aggregated performance of memory side caches
> + for each domain. type of 'data-type' is type of data represented by
> + this structure instance: if 'hierarchy' is 'memory', 'data-type' is
> + 'access\|read\|write' latency or 'access\|read\|write' bandwidth of
> + the target memory; if 'hierarchy' is
> + 'first-level\|second-level\|third-level', 'data-type' is
> + 'access\|read\|write' hit latency or 'access\|read\|write' hit
> + bandwidth of the target memory side cache.
> +
> + lat is latency value in nanoseconds. bw is bandwidth value, the
> + possible value and units are NUM[M\|G\|T], mean that the bandwidth
> + value are NUM byte per second (or MB/s, GB/s or TB/s depending on
> + used suffix). Note that if latency or bandwidth value is 0, means
> + the corresponding latency or bandwidth information is not provided.
> +
> + In '\ ``hmat-cache``\ ' option, node-id is the NUMA-id of the memory
> + belongs. size is the size of memory side cache in bytes. level is
> + the cache level described in this structure, note that the cache
> + level 0 should not be used with '\ ``hmat-cache``\ ' option.
> + associativity is the cache associativity, the possible value is
> + 'none/direct(direct-mapped)/complex(complex cache indexing)'. policy
> + is the write policy. line is the cache Line size in bytes.
> +
> + For example, the following options describe 2 NUMA nodes. Node 0 has
> + 2 cpus and a ram, node 1 has only a ram. The processors in node 0
> + access memory in node 0 with access-latency 5 nanoseconds,
> + access-bandwidth is 200 MB/s; The processors in NUMA node 0 access
> + memory in NUMA node 1 with access-latency 10 nanoseconds,
> + access-bandwidth is 100 MB/s. And for memory side cache information,
> + NUMA node 0 and 1 both have 1 level memory cache, size is 10KB,
> + policy is write-back, the cache Line size is 8 bytes:
> +
> + ::
> +
> + -machine hmat=on \
> + -m 2G \
> + -object memory-backend-ram,size=1G,id=m0 \
> + -object memory-backend-ram,size=1G,id=m1 \
> + -smp 2 \
> + -numa node,nodeid=0,memdev=m0 \
> + -numa node,nodeid=1,memdev=m1,initiator=0 \
> + -numa cpu,node-id=0,socket-id=0 \
> + -numa cpu,node-id=0,socket-id=1 \
> + -numa hmat-lb,initiator=0,target=0,hierarchy=memory,data-type=access-latency,latency=5 \
> + -numa hmat-lb,initiator=0,target=0,hierarchy=memory,data-type=access-bandwidth,bandwidth=200M \
> + -numa hmat-lb,initiator=0,target=1,hierarchy=memory,data-type=access-latency,latency=10 \
> + -numa hmat-lb,initiator=0,target=1,hierarchy=memory,data-type=access-bandwidth,bandwidth=100M \
> + -numa hmat-cache,node-id=0,size=10K,level=1,associativity=direct,policy=write-back,line=8 \
> + -numa hmat-cache,node-id=1,size=10K,level=1,associativity=direct,policy=write-back,line=8
> +ERST
>
> DEF("add-fd", HAS_ARG, QEMU_OPTION_add_fd,
> "-add-fd fd=fd,set=set[,opaque=opaque]\n"
> @@ -350,6 +621,33 @@ You can open an image using pre-opened file descriptors from an fd set:
> -drive file=/dev/fdset/2,index=0,media=disk
> @end example
> ETEXI
> +SRST
> +``-add-fd fd=fd,set=set[,opaque=opaque]``
> + Add a file descriptor to an fd set. Valid options are:
> +
> + ``fd=fd``
> + This option defines the file descriptor of which a duplicate is
> + added to fd set. The file descriptor cannot be stdin, stdout, or
> + stderr.
> +
> + ``set=set``
> + This option defines the ID of the fd set to add the file
> + descriptor to.
> +
> + ``opaque=opaque``
> + This option defines a free-form string that can be used to
> + describe fd.
> +
> + You can open an image using pre-opened file descriptors from an fd
> + set:
> +
> + .. parsed-literal::
> +
> + |qemu_system| \
> + -add-fd fd=3,set=2,opaque="rdwr:/path/to/file" \
> + -add-fd fd=4,set=2,opaque="rdonly:/path/to/file" \
> + -drive file=/dev/fdset/2,index=0,media=disk
> +ERST
>
> DEF("set", HAS_ARG, QEMU_OPTION_set,
> "-set group.id.arg=value\n"
> @@ -360,6 +658,10 @@ STEXI
> @findex -set
> Set parameter @var{arg} for item @var{id} of type @var{group}
> ETEXI
> +SRST
> +``-set group.id.arg=value``
> + Set parameter arg for item id of type group
> +ERST
>
> DEF("global", HAS_ARG, QEMU_OPTION_global,
> "-global driver.property=value\n"
> @@ -384,6 +686,23 @@ created automatically and set properties on it, use -@option{device}.
> 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``
> + Set default value of driver's property prop to value, e.g.:
> +
> + .. parsed-literal::
> +
> + |qemu_system_x86| -global ide-hd.physical_block_size=4096 disk-image.img
> +
> + In particular, you can use this to set driver properties for devices
> + which are created automatically by the machine model. To create a
> + device which is not created automatically and set properties on it,
> + use -``device``.
> +
> + -global driver.prop=value is shorthand for -global
> + driver=driver,property=prop,value=value. The longhand syntax works
> + even when driver contains a dot.
> +ERST
>
> DEF("boot", HAS_ARG, QEMU_OPTION_boot,
> "-boot [order=drives][,once=drives][,menu=on|off]\n"
> @@ -437,6 +756,50 @@ bootindex options. The default is non-strict boot.
> Note: The legacy format '-boot @var{drives}' is still supported but its
> use is discouraged as it may be removed from future versions.
> ETEXI
> +SRST
> +``-boot [order=drives][,once=drives][,menu=on|off][,splash=sp_name][,splash-time=sp_time][,reboot-timeout=rb_timeout][,strict=on|off]``
> + Specify boot order drives as a string of drive letters. Valid drive
> + letters depend on the target architecture. The x86 PC uses: a, b
> + (floppy 1 and 2), c (first hard disk), d (first CD-ROM), n-p
> + (Etherboot from network adapter 1-4), hard disk boot is the default.
> + To apply a particular boot order only on the first startup, specify
> + it via ``once``. Note that the ``order`` or ``once`` parameter
> + should not be used together with the ``bootindex`` property of
> + devices, since the firmware implementations normally do not support
> + both at the same time.
> +
> + Interactive boot menus/prompts can be enabled via ``menu=on`` as far
> + as firmware/BIOS supports them. The default is non-interactive boot.
> +
> + A splash picture could be passed to bios, enabling user to show it
> + as logo, when option splash=sp\_name is given and menu=on, If
> + firmware/BIOS supports them. Currently Seabios for X86 system
> + support it. limitation: The splash file could be a jpeg file or a
> + BMP file in 24 BPP format(true color). The resolution should be
> + supported by the SVGA mode, so the recommended is 320x240, 640x480,
> + 800x640.
> +
> + A timeout could be passed to bios, guest will pause for rb\_timeout
> + ms when boot failed, then reboot. If rb\_timeout is '-1', guest will
> + not reboot, qemu passes '-1' to bios by default. Currently Seabios
> + for X86 system support it.
> +
> + Do strict boot via ``strict=on`` as far as firmware/BIOS supports
> + it. This only effects when boot priority is changed by bootindex
> + options. The default is non-strict boot.
> +
> + ::
> +
> + # try to boot from network first, then from hard disk
> + |qemu_system_x86| -boot order=nc
> + # boot from CD-ROM first, switch back to default order after reboot
> + |qemu_system_x86| -boot once=d
> + # boot with a splash picture for 5 seconds.
> + |qemu_system_x86| -boot menu=on,splash=/root/boot.bmp,splash-time=5000
> +
> + Note: The legacy format '-boot drives' is still supported but its
> + use is discouraged as it may be removed from future versions.
> +ERST
>
> DEF("m", HAS_ARG, QEMU_OPTION_m,
> "-m [size=]megs[,slots=n,maxmem=size]\n"
> @@ -466,6 +829,25 @@ memory the guest can reach to 4GB:
> If @var{slots} and @var{maxmem} are not specified, memory hotplug won't
> be enabled and the guest startup RAM will never increase.
> ETEXI
> +SRST
> +``-m [size=]megs[,slots=n,maxmem=size]``
> + Sets guest startup RAM size to megs megabytes. Default is 128 MiB.
> + Optionally, a suffix of "M" or "G" can be used to signify a value in
> + megabytes or gigabytes respectively. Optional pair slots, maxmem
> + could be used to set amount of hotpluggable memory slots and maximum
> + amount of memory. Note that maxmem must be aligned to the page size.
> +
> + For example, the following command-line sets the guest startup RAM
> + size to 1GB, creates 3 slots to hotplug additional memory and sets
> + the maximum memory the guest can reach to 4GB:
> +
> + .. parsed-literal::
> +
> + |qemu_system| -m 1G,slots=3,maxmem=4G
> +
> + If slots and maxmem are not specified, memory hotplug won't be
> + enabled and the guest startup RAM will never increase.
> +ERST
>
> DEF("mem-path", HAS_ARG, QEMU_OPTION_mempath,
> "-mem-path FILE provide backing storage for guest RAM\n", QEMU_ARCH_ALL)
> @@ -474,6 +856,10 @@ STEXI
> @findex -mem-path
> Allocate guest RAM from a temporarily created file in @var{path}.
> ETEXI
> +SRST
> +``-mem-path path``
> + Allocate guest RAM from a temporarily created file in path.
> +ERST
>
> DEF("mem-prealloc", 0, QEMU_OPTION_mem_prealloc,
> "-mem-prealloc preallocate guest memory (use with -mem-path)\n",
> @@ -483,6 +869,10 @@ STEXI
> @findex -mem-prealloc
> Preallocate memory when using -mem-path.
> ETEXI
> +SRST
> +``-mem-prealloc``
> + Preallocate memory when using -mem-path.
> +ERST
>
> DEF("k", HAS_ARG, QEMU_OPTION_k,
> "-k language use keyboard layout (for example 'fr' for French)\n",
> @@ -505,6 +895,24 @@ de en-us fi fr-be hr it lv nl-be pt sl tr
>
> The default is @code{en-us}.
> ETEXI
> +SRST
> +``-k language``
> + Use keyboard layout language (for example ``fr`` for French). This
> + option is only needed where it is not easy to get raw PC keycodes
> + (e.g. on Macs, with some X11 servers or with a VNC or curses
> + display). You don't normally need to use it on PC/Linux or
> + PC/Windows hosts.
> +
> + The available layouts are:
> +
> + ::
> +
> + ar de-ch es fo fr-ca hu ja mk no pt-br sv
> + da en-gb et fr fr-ch is lt nl pl ru th
> + de en-us fi fr-be hr it lv nl-be pt sl tr
> +
> + The default is ``en-us``.
> +ERST
>
>
> HXCOMM Deprecated by -audiodev
> @@ -517,6 +925,11 @@ STEXI
> Will show the -audiodev equivalent of the currently specified
> (deprecated) environment variables.
> ETEXI
> +SRST
> +``-audio-help``
> + Will show the -audiodev equivalent of the currently specified
> + (deprecated) environment variables.
> +ERST
>
> DEF("audiodev", HAS_ARG, QEMU_OPTION_audiodev,
> "-audiodev [driver=]driver,id=id[,prop[=value][,...]]\n"
> @@ -766,6 +1179,173 @@ Write recorded audio into the specified file. Default is
>
> @end table
> ETEXI
> +SRST
> +``-audiodev [driver=]driver,id=id[,prop[=value][,...]]``
> + Adds a new audio backend driver identified by id. There are global
> + and driver specific properties. Some values can be set differently
> + for input and output, they're marked with ``in|out.``. You can set
> + the input's property with ``in.prop`` and the output's property with
> + ``out.prop``. For example:
> +
> + ::
> +
> + -audiodev alsa,id=example,in.frequency=44110,out.frequency=8000
> + -audiodev alsa,id=example,out.channels=1 # leaves in.channels unspecified
> +
> + NOTE: parameter validation is known to be incomplete, in many cases
> + specifying an invalid option causes QEMU to print an error message
> + and continue emulation without sound.
> +
> + Valid global options are:
> +
> + ``id=identifier``
> + Identifies the audio backend.
> +
> + ``timer-period=period``
> + Sets the timer period used by the audio subsystem in
> + microseconds. Default is 10000 (10 ms).
> +
> + ``in|out.mixing-engine=on|off``
> + Use QEMU's mixing engine to mix all streams inside QEMU and
> + convert audio formats when not supported by the backend. When
> + off, fixed-settings must be off too. Note that disabling this
> + option means that the selected backend must support multiple
> + streams and the audio formats used by the virtual cards,
> + otherwise you'll get no sound. It's not recommended to disable
> + this option unless you want to use 5.1 or 7.1 audio, as mixing
> + engine only supports mono and stereo audio. Default is on.
> +
> + ``in|out.fixed-settings=on|off``
> + Use fixed settings for host audio. When off, it will change
> + based on how the guest opens the sound card. In this case you
> + must not specify frequency, channels or format. Default is on.
> +
> + ``in|out.frequency=frequency``
> + Specify the frequency to use when using fixed-settings. Default
> + is 44100Hz.
> +
> + ``in|out.channels=channels``
> + Specify the number of channels to use when using fixed-settings.
> + Default is 2 (stereo).
> +
> + ``in|out.format=format``
> + Specify the sample format to use when using fixed-settings.
> + Valid values are: ``s8``, ``s16``, ``s32``, ``u8``, ``u16``,
> + ``u32``. Default is ``s16``.
> +
> + ``in|out.voices=voices``
> + Specify the number of voices to use. Default is 1.
> +
> + ``in|out.buffer-length=usecs``
> + Sets the size of the buffer in microseconds.
> +
> +``-audiodev none,id=id[,prop[=value][,...]]``
> + Creates a dummy backend that discards all outputs. This backend has
> + no backend specific properties.
> +
> +``-audiodev alsa,id=id[,prop[=value][,...]]``
> + Creates backend using the ALSA. This backend is only available on
> + Linux.
> +
> + ALSA specific options are:
> +
> + ``in|out.dev=device``
> + Specify the ALSA device to use for input and/or output. Default
> + is ``default``.
> +
> + ``in|out.period-length=usecs``
> + Sets the period length in microseconds.
> +
> + ``in|out.try-poll=on|off``
> + Attempt to use poll mode with the device. Default is on.
> +
> + ``threshold=threshold``
> + Threshold (in microseconds) when playback starts. Default is 0.
> +
> +``-audiodev coreaudio,id=id[,prop[=value][,...]]``
> + Creates a backend using Apple's Core Audio. This backend is only
> + available on Mac OS and only supports playback.
> +
> + Core Audio specific options are:
> +
> + ``in|out.buffer-count=count``
> + Sets the count of the buffers.
> +
> +``-audiodev dsound,id=id[,prop[=value][,...]]``
> + Creates a backend using Microsoft's DirectSound. This backend is
> + only available on Windows and only supports playback.
> +
> + DirectSound specific options are:
> +
> + ``latency=usecs``
> + Add extra usecs microseconds latency to playback. Default is
> + 10000 (10 ms).
> +
> +``-audiodev oss,id=id[,prop[=value][,...]]``
> + Creates a backend using OSS. This backend is available on most
> + Unix-like systems.
> +
> + OSS specific options are:
> +
> + ``in|out.dev=device``
> + Specify the file name of the OSS device to use. Default is
> + ``/dev/dsp``.
> +
> + ``in|out.buffer-count=count``
> + Sets the count of the buffers.
> +
> + ``in|out.try-poll=on|of``
> + Attempt to use poll mode with the device. Default is on.
> +
> + ``try-mmap=on|off``
> + Try using memory mapped device access. Default is off.
> +
> + ``exclusive=on|off``
> + Open the device in exclusive mode (vmix won't work in this
> + case). Default is off.
> +
> + ``dsp-policy=policy``
> + Sets the timing policy (between 0 and 10, where smaller number
> + means smaller latency but higher CPU usage). Use -1 to use
> + buffer sizes specified by ``buffer`` and ``buffer-count``. This
> + option is ignored if you do not have OSS 4. Default is 5.
> +
> +``-audiodev pa,id=id[,prop[=value][,...]]``
> + Creates a backend using PulseAudio. This backend is available on
> + most systems.
> +
> + PulseAudio specific options are:
> +
> + ``server=server``
> + Sets the PulseAudio server to connect to.
> +
> + ``in|out.name=sink``
> + Use the specified source/sink for recording/playback.
> +
> + ``in|out.latency=usecs``
> + Desired latency in microseconds. The PulseAudio server will try
> + to honor this value but actual latencies may be lower or higher.
> +
> +``-audiodev sdl,id=id[,prop[=value][,...]]``
> + Creates a backend using SDL. This backend is available on most
> + systems, but you should use your platform's native backend if
> + possible. This backend has no backend specific properties.
> +
> +``-audiodev spice,id=id[,prop[=value][,...]]``
> + Creates a backend that sends audio through SPICE. This backend
> + requires ``-spice`` and automatically selected in that case, so
> + usually you can ignore this option. This backend has no backend
> + specific properties.
> +
> +``-audiodev wav,id=id[,prop[=value][,...]]``
> + Creates a backend that writes audio to a WAV file.
> +
> + Backend specific options are:
> +
> + ``path=path``
> + Write recorded audio into the specified file. Default is
> + ``qemu.wav``.
> +ERST
>
> DEF("soundhw", HAS_ARG, QEMU_OPTION_soundhw,
> "-soundhw c1,... enable audio support\n"
> @@ -794,6 +1374,27 @@ require manually specifying clocking.
> modprobe i810_audio clocking=48000
> @end example
> ETEXI
> +SRST
> +``-soundhw card1[,card2,...] or -soundhw all``
> + Enable audio and selected sound hardware. Use 'help' to print all
> + available sound hardware. For example:
> +
> + .. parsed-literal::
> +
> + |qemu_system_x86| -soundhw sb16,adlib disk.img
> + |qemu_system_x86| -soundhw es1370 disk.img
> + |qemu_system_x86| -soundhw ac97 disk.img
> + |qemu_system_x86| -soundhw hda disk.img
> + |qemu_system_x86| -soundhw all disk.img
> + |qemu_system_x86| -soundhw help
> +
> + Note that Linux's i810\_audio OSS kernel (for AC97) module might
> + require manually specifying clocking.
> +
> + ::
> +
> + modprobe i810_audio clocking=48000
> +ERST
>
> DEF("device", HAS_ARG, QEMU_OPTION_device,
> "-device driver[,prop[=value][,...]]\n"
> @@ -879,6 +1480,85 @@ Like the KCS interface, but defines a BT interface. The default port is
> 0xe4 and the default interrupt is 5.
>
> ETEXI
> +SRST
> +``-device driver[,prop[=value][,...]]``
> + Add device driver. prop=value sets driver properties. Valid
> + properties depend on the driver. To get help on possible drivers and
> + properties, use ``-device help`` and ``-device driver,help``.
> +
> + Some drivers are:
> +
> +``-device ipmi-bmc-sim,id=id[,slave_addr=val][,sdrfile=file][,furareasize=val][,furdatafile=file][,guid=uuid]``
> + Add an IPMI BMC. This is a simulation of a hardware management
> + interface processor that normally sits on a system. It provides a
> + watchdog and the ability to reset and power control the system. You
> + need to connect this to an IPMI interface to make it useful
> +
> + The IPMI slave address to use for the BMC. The default is 0x20. This
> + address is the BMC's address on the I2C network of management
> + controllers. If you don't know what this means, it is safe to ignore
> + it.
> +
> + ``id=id``
> + The BMC id for interfaces to use this device.
> +
> + ``slave_addr=val``
> + Define slave address to use for the BMC. The default is 0x20.
> +
> + ``sdrfile=file``
> + file containing raw Sensor Data Records (SDR) data. The default
> + is none.
> +
> + ``fruareasize=val``
> + size of a Field Replaceable Unit (FRU) area. The default is
> + 1024.
> +
> + ``frudatafile=file``
> + file containing raw Field Replaceable Unit (FRU) inventory data.
> + The default is none.
> +
> + ``guid=uuid``
> + value for the GUID for the BMC, in standard UUID format. If this
> + is set, get "Get GUID" command to the BMC will return it.
> + Otherwise "Get GUID" will return an error.
> +
> +``-device ipmi-bmc-extern,id=id,chardev=id[,slave_addr=val]``
> + Add a connection to an external IPMI BMC simulator. Instead of
> + locally emulating the BMC like the above item, instead connect to an
> + external entity that provides the IPMI services.
> +
> + A connection is made to an external BMC simulator. If you do this,
> + it is strongly recommended that you use the "reconnect=" chardev
> + option to reconnect to the simulator if the connection is lost. Note
> + that if this is not used carefully, it can be a security issue, as
> + the interface has the ability to send resets, NMIs, and power off
> + the VM. It's best if QEMU makes a connection to an external
> + simulator running on a secure port on localhost, so neither the
> + simulator nor QEMU is exposed to any outside network.
> +
> + See the "lanserv/README.vm" file in the OpenIPMI library for more
> + details on the external interface.
> +
> +``-device isa-ipmi-kcs,bmc=id[,ioport=val][,irq=val]``
> + Add a KCS IPMI interafce on the ISA bus. This also adds a
> + corresponding ACPI and SMBIOS entries, if appropriate.
> +
> + ``bmc=id``
> + The BMC to connect to, one of ipmi-bmc-sim or ipmi-bmc-extern
> + above.
> +
> + ``ioport=val``
> + Define the I/O address of the interface. The default is 0xca0
> + for KCS.
> +
> + ``irq=val``
> + Define the interrupt to use. The default is 5. To disable
> + interrupts, set this to 0.
> +
> +``-device isa-ipmi-bt,bmc=id[,ioport=val][,irq=val]``
> + Like the KCS interface, but defines a BT interface. The default port
> + is 0xe4 and the default interrupt is 5.
> +ERST
>
> DEF("name", HAS_ARG, QEMU_OPTION_name,
> "-name string1[,process=string2][,debug-threads=on|off]\n"
> @@ -896,6 +1576,13 @@ The @var{name} will also be used for the VNC server.
> Also optionally set the top visible process name in Linux.
> Naming of individual threads can also be enabled on Linux to aid debugging.
> ETEXI
> +SRST
> +``-name name``
> + Sets the name of the guest. This name will be displayed in the SDL
> + window caption. The name will also be used for the VNC server. Also
> + optionally set the top visible process name in Linux. Naming of
> + individual threads can also be enabled on Linux to aid debugging.
> +ERST
>
> DEF("uuid", HAS_ARG, QEMU_OPTION_uuid,
> "-uuid %08x-%04x-%04x-%04x-%012x\n"
> @@ -905,6 +1592,10 @@ STEXI
> @findex -uuid
> Set system UUID.
> ETEXI
> +SRST
> +``-uuid uuid``
> + Set system UUID.
> +ERST
>
> STEXI
> @end table
> @@ -926,6 +1617,11 @@ STEXI
> @findex -fdb
> Use @var{file} as floppy disk 0/1 image (@pxref{disk_images}).
> ETEXI
> +SRST
> +``-fda file``; \ ``-fdb file``
> + Use file as floppy disk 0/1 image (see
> + :ref:`disk_005fimages`).
> +ERST
>
> DEF("hda", HAS_ARG, QEMU_OPTION_hda,
> "-hda/-hdb file use 'file' as IDE hard disk 0/1 image\n", QEMU_ARCH_ALL)
> @@ -944,6 +1640,11 @@ STEXI
> @findex -hdd
> 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``
> + Use file as hard disk 0, 1, 2 or 3 image (see
> + :ref:`disk_005fimages`).
> +ERST
>
> DEF("cdrom", HAS_ARG, QEMU_OPTION_cdrom,
> "-cdrom file use 'file' as IDE cdrom image (cdrom is ide1 master)\n",
> @@ -955,6 +1656,12 @@ Use @var{file} as CD-ROM image (you cannot use @option{-hdc} and
> @option{-cdrom} at the same time). You can use the host CD-ROM by
> using @file{/dev/cdrom} as filename.
> ETEXI
> +SRST
> +``-cdrom file``
> + Use file as CD-ROM image (you cannot use ``-hdc`` and ``-cdrom`` at
> + the same time). You can use the host CD-ROM by using ``/dev/cdrom``
> + as filename.
> +ERST
>
> DEF("blockdev", HAS_ARG, QEMU_OPTION_blockdev,
> "-blockdev [driver=]driver[,node-name=N][,discard=ignore|unmap]\n"
> @@ -1150,6 +1857,216 @@ Please refer to the QAPI documentation of the @code{blockdev-add} QMP command.
> @end table
>
> ETEXI
> +SRST
> +``-blockdev option[,option[,option[,...]]]``
> + Define a new block driver node. Some of the options apply to all
> + block drivers, other options are only accepted for a specific block
> + driver. See below for a list of generic options and options for the
> + most common block drivers.
> +
> + Options that expect a reference to another node (e.g. ``file``) can
> + be given in two ways. Either you specify the node name of an already
> + existing node (file=node-name), or you define a new node inline,
> + adding options for the referenced node after a dot
> + (file.filename=path,file.aio=native).
> +
> + A block driver node created with ``-blockdev`` can be used for a
> + guest device by specifying its node name for the ``drive`` property
> + in a ``-device`` argument that defines a block device.
> +
> + ``Valid options for any block driver node:``
> + ``driver``
> + Specifies the block driver to use for the given node.
> +
> + ``node-name``
> + This defines the name of the block driver node by which it
> + will be referenced later. The name must be unique, i.e. it
> + must not match the name of a different block driver node, or
> + (if you use ``-drive`` as well) the ID of a drive.
> +
> + If no node name is specified, it is automatically generated.
> + The generated node name is not intended to be predictable
> + and changes between QEMU invocations. For the top level, an
> + explicit node name must be specified.
> +
> + ``read-only``
> + Open the node read-only. Guest write attempts will fail.
> +
> + Note that some block drivers support only read-only access,
> + either generally or in certain configurations. In this case,
> + the default value ``read-only=off`` does not work and the
> + option must be specified explicitly.
> +
> + ``auto-read-only``
> + If ``auto-read-only=on`` is set, QEMU may fall back to
> + read-only usage even when ``read-only=off`` is requested, or
> + even switch between modes as needed, e.g. depending on
> + whether the image file is writable or whether a writing user
> + is attached to the node.
> +
> + ``force-share``
> + Override the image locking system of QEMU by forcing the
> + node to utilize weaker shared access for permissions where
> + it would normally request exclusive access. When there is
> + the potential for multiple instances to have the same file
> + open (whether this invocation of QEMU is the first or the
> + second instance), both instances must permit shared access
> + for the second instance to succeed at opening the file.
> +
> + Enabling ``force-share=on`` requires ``read-only=on``.
> +
> + ``cache.direct``
> + The host page cache can be avoided with ``cache.direct=on``.
> + This will attempt to do disk IO directly to the guest's
> + memory. QEMU may still perform an internal copy of the data.
> +
> + ``cache.no-flush``
> + In case you don't care about data integrity over host
> + failures, you can use ``cache.no-flush=on``. This option
> + tells QEMU that it never needs to write any data to the disk
> + but can instead keep things in cache. If anything goes
> + wrong, like your host losing power, the disk storage getting
> + disconnected accidentally, etc. your image will most
> + probably be rendered unusable.
> +
> + ``discard=discard``
> + discard is one of "ignore" (or "off") or "unmap" (or "on")
> + and controls whether ``discard`` (also known as ``trim`` or
> + ``unmap``) requests are ignored or passed to the filesystem.
> + Some machine types may not support discard requests.
> +
> + ``detect-zeroes=detect-zeroes``
> + detect-zeroes is "off", "on" or "unmap" and enables the
> + automatic conversion of plain zero writes by the OS to
> + driver specific optimized zero write commands. You may even
> + choose "unmap" if discard is set to "unmap" to allow a zero
> + write to be converted to an ``unmap`` operation.
> +
> + ``Driver-specific options for file``
> + This is the protocol-level block driver for accessing regular
> + files.
> +
> + ``filename``
> + The path to the image file in the local filesystem
> +
> + ``aio``
> + Specifies the AIO backend (threads/native, default: threads)
> +
> + ``locking``
> + Specifies whether the image file is protected with Linux OFD
> + / POSIX locks. The default is to use the Linux Open File
> + Descriptor API if available, otherwise no lock is applied.
> + (auto/on/off, default: auto)
> +
> + Example:
> +
> + ::
> +
> + -blockdev driver=file,node-name=disk,filename=disk.img
> +
> + ``Driver-specific options for raw``
> + This is the image format block driver for raw images. It is
> + usually stacked on top of a protocol level block driver such as
> + ``file``.
> +
> + ``file``
> + Reference to or definition of the data source block driver
> + node (e.g. a ``file`` driver node)
> +
> + Example 1:
> +
> + ::
> +
> + -blockdev driver=file,node-name=disk_file,filename=disk.img
> + -blockdev driver=raw,node-name=disk,file=disk_file
> +
> + Example 2:
> +
> + ::
> +
> + -blockdev driver=raw,node-name=disk,file.driver=file,file.filename=disk.img
> +
> + ``Driver-specific options for qcow2``
> + This is the image format block driver for qcow2 images. It is
> + usually stacked on top of a protocol level block driver such as
> + ``file``.
> +
> + ``file``
> + Reference to or definition of the data source block driver
> + node (e.g. a ``file`` driver node)
> +
> + ``backing``
> + Reference to or definition of the backing file block device
> + (default is taken from the image file). It is allowed to
> + pass ``null`` here in order to disable the default backing
> + file.
> +
> + ``lazy-refcounts``
> + Whether to enable the lazy refcounts feature (on/off;
> + default is taken from the image file)
> +
> + ``cache-size``
> + The maximum total size of the L2 table and refcount block
> + caches in bytes (default: the sum of l2-cache-size and
> + refcount-cache-size)
> +
> + ``l2-cache-size``
> + The maximum size of the L2 table cache in bytes (default: if
> + cache-size is not specified - 32M on Linux platforms, and 8M
> + on non-Linux platforms; otherwise, as large as possible
> + within the cache-size, while permitting the requested or the
> + minimal refcount cache size)
> +
> + ``refcount-cache-size``
> + The maximum size of the refcount block cache in bytes
> + (default: 4 times the cluster size; or if cache-size is
> + specified, the part of it which is not used for the L2
> + cache)
> +
> + ``cache-clean-interval``
> + Clean unused entries in the L2 and refcount caches. The
> + interval is in seconds. The default value is 600 on
> + supporting platforms, and 0 on other platforms. Setting it
> + to 0 disables this feature.
> +
> + ``pass-discard-request``
> + Whether discard requests to the qcow2 device should be
> + forwarded to the data source (on/off; default: on if
> + discard=unmap is specified, off otherwise)
> +
> + ``pass-discard-snapshot``
> + Whether discard requests for the data source should be
> + issued when a snapshot operation (e.g. deleting a snapshot)
> + frees clusters in the qcow2 file (on/off; default: on)
> +
> + ``pass-discard-other``
> + Whether discard requests for the data source should be
> + issued on other occasions where a cluster gets freed
> + (on/off; default: off)
> +
> + ``overlap-check``
> + Which overlap checks to perform for writes to the image
> + (none/constant/cached/all; default: cached). For details or
> + finer granularity control refer to the QAPI documentation of
> + ``blockdev-add``.
> +
> + Example 1:
> +
> + ::
> +
> + -blockdev driver=file,node-name=my_file,filename=/tmp/disk.qcow2
> + -blockdev driver=qcow2,node-name=hda,file=my_file,overlap-check=none,cache-size=16777216
> +
> + Example 2:
> +
> + ::
> +
> + -blockdev driver=qcow2,node-name=disk,file.driver=http,file.filename=http://example.com/image.qcow2
> +
> + ``Driver-specific options for other drivers``
> + Please refer to the QAPI documentation of the ``blockdev-add``
> + QMP command.
> +ERST
>
> DEF("drive", HAS_ARG, QEMU_OPTION_drive,
> "-drive [file=file][,if=type][,bus=n][,unit=m][,media=d][,index=i]\n"
> @@ -1329,6 +2246,197 @@ is interpreted like:
> @value{qemu_system_x86} -hda a -hdb b
> @end example
> ETEXI
> +SRST
> +``-drive option[,option[,option[,...]]]``
> + Define a new drive. This includes creating a block driver node (the
> + backend) as well as a guest device, and is mostly a shortcut for
> + defining the corresponding ``-blockdev`` and ``-device`` options.
> +
> + ``-drive`` accepts all options that are accepted by ``-blockdev``.
> + In addition, it knows the following options:
> +
> + ``file=file``
> + This option defines which disk image (see
> + :ref:`disk_005fimages`) to use with this drive. If
> + the filename contains comma, you must double it (for instance,
> + "file=my,,file" to use file "my,file").
> +
> + Special files such as iSCSI devices can be specified using
> + protocol specific URLs. See the section for "Device URL Syntax"
> + for more information.
> +
> + ``if=interface``
> + This option defines on which type on interface the drive is
> + connected. Available types are: ide, scsi, sd, mtd, floppy,
> + pflash, virtio, none.
> +
> + ``bus=bus,unit=unit``
> + These options define where is connected the drive by defining
> + the bus number and the unit id.
> +
> + ``index=index``
> + This option defines where is connected the drive by using an
> + index in the list of available connectors of a given interface
> + type.
> +
> + ``media=media``
> + This option defines the type of the media: disk or cdrom.
> +
> + ``snapshot=snapshot``
> + snapshot is "on" or "off" and controls snapshot mode for the
> + given drive (see ``-snapshot``).
> +
> + ``cache=cache``
> + cache is "none", "writeback", "unsafe", "directsync" or
> + "writethrough" and controls how the host cache is used to access
> + block data. This is a shortcut that sets the ``cache.direct``
> + and ``cache.no-flush`` options (as in ``-blockdev``), and
> + additionally ``cache.writeback``, which provides a default for
> + 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
> +
> + The default mode is ``cache=writeback``.
> +
> + ``aio=aio``
> + aio is "threads", or "native" and selects between pthread based
> + disk I/O and native Linux AIO.
> +
> + ``format=format``
> + Specify which disk format will be used rather than detecting the
> + format. Can be used to specify format=raw to avoid interpreting
> + an untrusted format header.
> +
> + ``werror=action,rerror=action``
> + Specify which action to take on write and read errors. Valid
> + actions are: "ignore" (ignore the error and try to continue),
> + "stop" (pause QEMU), "report" (report the error to the guest),
> + "enospc" (pause QEMU only if the host disk is full; report the
> + error to the guest otherwise). The default setting is
> + ``werror=enospc`` and ``rerror=report``.
> +
> + ``copy-on-read=copy-on-read``
> + copy-on-read is "on" or "off" and enables whether to copy read
> + backing file sectors into the image file.
> +
> + ``bps=b,bps_rd=r,bps_wr=w``
> + Specify bandwidth throttling limits in bytes per second, either
> + for all request types or for reads or writes only. Small values
> + can lead to timeouts or hangs inside the guest. A safe minimum
> + for disks is 2 MB/s.
> +
> + ``bps_max=bm,bps_rd_max=rm,bps_wr_max=wm``
> + Specify bursts in bytes per second, either for all request types
> + or for reads or writes only. Bursts allow the guest I/O to spike
> + above the limit temporarily.
> +
> + ``iops=i,iops_rd=r,iops_wr=w``
> + Specify request rate limits in requests per second, either for
> + all request types or for reads or writes only.
> +
> + ``iops_max=bm,iops_rd_max=rm,iops_wr_max=wm``
> + Specify bursts in requests per second, either for all request
> + types or for reads or writes only. Bursts allow the guest I/O to
> + spike above the limit temporarily.
> +
> + ``iops_size=is``
> + Let every is bytes of a request count as a new request for iops
> + throttling purposes. Use this option to prevent guests from
> + circumventing iops limits by sending fewer but larger requests.
> +
> + ``group=g``
> + Join a throttling quota group with given name g. All drives that
> + are members of the same group are accounted for together. Use
> + this option to prevent guests from circumventing throttling
> + limits by using many small disks instead of a single larger
> + disk.
> +
> + By default, the ``cache.writeback=on`` mode is used. It will report
> + data writes as completed as soon as the data is present in the host
> + page cache. This is safe as long as your guest OS makes sure to
> + correctly flush disk caches where needed. If your guest OS does not
> + handle volatile disk write caches correctly and your host crashes or
> + loses power, then the guest may experience data corruption.
> +
> + For such guests, you should consider using ``cache.writeback=off``.
> + This means that the host page cache will be used to read and write
> + data, but write notification will be sent to the guest only after
> + QEMU has made sure to flush each write to the disk. Be aware that
> + this has a major impact on performance.
> +
> + When using the ``-snapshot`` option, unsafe caching is always used.
> +
> + Copy-on-read avoids accessing the same backing file sectors
> + repeatedly and is useful when the backing file is over a slow
> + network. By default copy-on-read is off.
> +
> + Instead of ``-cdrom`` you can use:
> +
> + .. parsed-literal::
> +
> + |qemu_system| -drive file=file,index=2,media=cdrom
> +
> + Instead of ``-hda``, ``-hdb``, ``-hdc``, ``-hdd``, you can use:
> +
> + .. parsed-literal::
> +
> + |qemu_system| -drive file=file,index=0,media=disk
> + |qemu_system| -drive file=file,index=1,media=disk
> + |qemu_system| -drive file=file,index=2,media=disk
> + |qemu_system| -drive file=file,index=3,media=disk
> +
> + You can open an image using pre-opened file descriptors from an fd
> + set:
> +
> + .. parsed-literal::
> +
> + |qemu_system| \
> + -add-fd fd=3,set=2,opaque="rdwr:/path/to/file" \
> + -add-fd fd=4,set=2,opaque="rdonly:/path/to/file" \
> + -drive file=/dev/fdset/2,index=0,media=disk
> +
> + You can connect a CDROM to the slave of ide0:
> +
> + .. parsed-literal::
> +
> + |qemu_system_x86| -drive file=file,if=ide,index=1,media=cdrom
> +
> + If you don't specify the "file=" argument, you define an empty
> + drive:
> +
> + .. parsed-literal::
> +
> + |qemu_system_x86| -drive if=ide,index=1,media=cdrom
> +
> + Instead of ``-fda``, ``-fdb``, you can use:
> +
> + .. parsed-literal::
> +
> + |qemu_system_x86| -drive file=file,index=0,if=floppy
> + |qemu_system_x86| -drive file=file,index=1,if=floppy
> +
> + By default, interface is "ide" and index is automatically
> + incremented:
> +
> + .. parsed-literal::
> +
> + |qemu_system_x86| -drive file=a -drive file=b"
> +
> + is interpreted like:
> +
> + .. parsed-literal::
> +
> + |qemu_system_x86| -hda a -hdb b
> +ERST
>
> DEF("mtdblock", HAS_ARG, QEMU_OPTION_mtdblock,
> "-mtdblock file use 'file' as on-board Flash memory image\n",
> @@ -1338,6 +2446,10 @@ STEXI
> @findex -mtdblock
> Use @var{file} as on-board Flash memory image.
> ETEXI
> +SRST
> +``-mtdblock file``
> + Use file as on-board Flash memory image.
> +ERST
>
> DEF("sd", HAS_ARG, QEMU_OPTION_sd,
> "-sd file use 'file' as SecureDigital card image\n", QEMU_ARCH_ALL)
> @@ -1346,6 +2458,10 @@ STEXI
> @findex -sd
> Use @var{file} as SecureDigital card image.
> ETEXI
> +SRST
> +``-sd file``
> + Use file as SecureDigital card image.
> +ERST
>
> DEF("pflash", HAS_ARG, QEMU_OPTION_pflash,
> "-pflash file use 'file' as a parallel flash image\n", QEMU_ARCH_ALL)
> @@ -1354,6 +2470,10 @@ STEXI
> @findex -pflash
> Use @var{file} as a parallel flash image.
> ETEXI
> +SRST
> +``-pflash file``
> + Use file as a parallel flash image.
> +ERST
>
> DEF("snapshot", 0, QEMU_OPTION_snapshot,
> "-snapshot write to temporary files instead of disk image files\n",
> @@ -1365,6 +2485,13 @@ Write to temporary files instead of disk image files. In this case,
> the raw disk image you use is not written back. You can however force
> the write back by pressing @key{C-a s} (@pxref{disk_images}).
> ETEXI
> +SRST
> +``-snapshot``
> + Write to temporary files instead of disk image files. In this case,
> + the raw disk image you use is not written back. You can however
> + force the write back by pressing C-a s (see
> + :ref:`disk_005fimages`).
> +ERST
>
> DEF("fsdev", HAS_ARG, QEMU_OPTION_fsdev,
> "-fsdev local,id=id,path=path,security_model=mapped-xattr|mapped-file|passthrough|none\n"
> @@ -1466,6 +2593,112 @@ Specifies the tag name to be used by the guest to mount this export point.
> @end table
>
> 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]``
> + Define a new file system device. Valid options are:
> +
> + ``local``
> + Accesses to the filesystem are done by QEMU.
> +
> + ``proxy``
> + Accesses to the filesystem are done by virtfs-proxy-helper(1).
> +
> + ``synth``
> + Synthetic filesystem, only used by QTests.
> +
> + ``id=id``
> + Specifies identifier for this device.
> +
> + ``path=path``
> + Specifies the export path for the file system device. Files
> + under this path will be available to the 9p client on the guest.
> +
> + ``security_model=security_model``
> + Specifies the security model to be used for this export path.
> + Supported security models are "passthrough", "mapped-xattr",
> + "mapped-file" and "none". In "passthrough" security model, files
> + are stored using the same credentials as they are created on the
> + guest. This requires QEMU to run as root. In "mapped-xattr"
> + security model, some of the file attributes like uid, gid, mode
> + bits and link target are stored as file attributes. For
> + "mapped-file" these attributes are stored in the hidden
> + .virtfs\_metadata directory. Directories exported by this
> + security model cannot interact with other unix tools. "none"
> + security model is same as passthrough except the sever won't
> + report failures if it fails to set file attributes like
> + ownership. Security model is mandatory only for local fsdriver.
> + Other fsdrivers (like proxy) don't take security model as a
> + parameter.
> +
> + ``writeout=writeout``
> + This is an optional argument. The only supported value is
> + "immediate". This means that host page cache will be used to
> + read and write data but write notification will be sent to the
> + guest only when the data has been reported as written by the
> + storage subsystem.
> +
> + ``readonly``
> + Enables exporting 9p share as a readonly mount for guests. By
> + default read-write access is given.
> +
> + ``socket=socket``
> + Enables proxy filesystem driver to use passed socket file for
> + communicating with virtfs-proxy-helper(1).
> +
> + ``sock_fd=sock_fd``
> + Enables proxy filesystem driver to use passed socket descriptor
> + for communicating with virtfs-proxy-helper(1). Usually a helper
> + like libvirt will create socketpair and pass one of the fds as
> + sock\_fd.
> +
> + ``fmode=fmode``
> + Specifies the default mode for newly created files on the host.
> + Works only with security models "mapped-xattr" and
> + "mapped-file".
> +
> + ``dmode=dmode``
> + Specifies the default mode for newly created directories on the
> + host. Works only with security models "mapped-xattr" and
> + "mapped-file".
> +
> + ``throttling.bps-total=b,throttling.bps-read=r,throttling.bps-write=w``
> + Specify bandwidth throttling limits in bytes per second, either
> + for all request types or for reads or writes only.
> +
> + ``throttling.bps-total-max=bm,bps-read-max=rm,bps-write-max=wm``
> + Specify bursts in bytes per second, either for all request types
> + or for reads or writes only. Bursts allow the guest I/O to spike
> + above the limit temporarily.
> +
> + ``throttling.iops-total=i,throttling.iops-read=r, throttling.iops-write=w``
> + Specify request rate limits in requests per second, either for
> + all request types or for reads or writes only.
> +
> + ``throttling.iops-total-max=im,throttling.iops-read-max=irm, throttling.iops-write-max=iwm``
> + Specify bursts in requests per second, either for all request
> + types or for reads or writes only. Bursts allow the guest I/O to
> + spike above the limit temporarily.
> +
> + ``throttling.iops-size=is``
> + Let every is bytes of a request count as a new request for iops
> + throttling purposes.
> +
> + -fsdev option is used along with -device driver "virtio-9p-...".
> +
> +``-device virtio-9p-type,fsdev=id,mount_tag=mount_tag``
> + Options for virtio-9p-... driver are:
> +
> + ``type``
> + Specifies the variant to be used. Supported values are "pci",
> + "ccw" or "device", depending on the machine type.
> +
> + ``fsdev=id``
> + Specifies the id value specified along with -fsdev option.
> +
> + ``mount_tag=mount_tag``
> + Specifies the tag name to be used by the guest to mount this
> + export point.
> +ERST
>
> DEF("virtfs", HAS_ARG, QEMU_OPTION_virtfs,
> "-virtfs local,path=path,mount_tag=tag,security_model=mapped-xattr|mapped-file|passthrough|none\n"
> @@ -1557,6 +2790,107 @@ currently not block all possible file access operations (e.g. readdir()
> 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``
> + 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:
> +
> + ``local``
> + Accesses to the filesystem are done by QEMU.
> +
> + ``proxy``
> + Accesses to the filesystem are done by virtfs-proxy-helper(1).
> +
> + ``synth``
> + Synthetic filesystem, only used by QTests.
> +
> + ``id=id``
> + Specifies identifier for the filesystem device
> +
> + ``path=path``
> + Specifies the export path for the file system device. Files
> + under this path will be available to the 9p client on the guest.
> +
> + ``security_model=security_model``
> + Specifies the security model to be used for this export path.
> + Supported security models are "passthrough", "mapped-xattr",
> + "mapped-file" and "none". In "passthrough" security model, files
> + are stored using the same credentials as they are created on the
> + guest. This requires QEMU to run as root. In "mapped-xattr"
> + security model, some of the file attributes like uid, gid, mode
> + bits and link target are stored as file attributes. For
> + "mapped-file" these attributes are stored in the hidden
> + .virtfs\_metadata directory. Directories exported by this
> + security model cannot interact with other unix tools. "none"
> + security model is same as passthrough except the sever won't
> + report failures if it fails to set file attributes like
> + ownership. Security model is mandatory only for local fsdriver.
> + Other fsdrivers (like proxy) don't take security model as a
> + parameter.
> +
> + ``writeout=writeout``
> + This is an optional argument. The only supported value is
> + "immediate". This means that host page cache will be used to
> + read and write data but write notification will be sent to the
> + guest only when the data has been reported as written by the
> + storage subsystem.
> +
> + ``readonly``
> + Enables exporting 9p share as a readonly mount for guests. By
> + default read-write access is given.
> +
> + ``socket=socket``
> + Enables proxy filesystem driver to use passed socket file for
> + communicating with virtfs-proxy-helper(1). Usually a helper like
> + libvirt will create socketpair and pass one of the fds as
> + sock\_fd.
> +
> + ``sock_fd``
> + Enables proxy filesystem driver to use passed 'sock\_fd' as the
> + socket descriptor for interfacing with virtfs-proxy-helper(1).
> +
> + ``fmode=fmode``
> + Specifies the default mode for newly created files on the host.
> + Works only with security models "mapped-xattr" and
> + "mapped-file".
> +
> + ``dmode=dmode``
> + Specifies the default mode for newly created directories on the
> + host. Works only with security models "mapped-xattr" and
> + "mapped-file".
> +
> + ``mount_tag=mount_tag``
> + Specifies the tag name to be used by the guest to mount this
> + export point.
> +
> + ``multidevs=multidevs``
> + Specifies how to deal with multiple devices being shared with a
> + 9p export. Supported behaviours are either "remap", "forbid" or
> + "warn". The latter is the default behaviour on which virtfs 9p
> + expects only one device to be shared with the same export, and
> + if more than one device is shared and accessed via the same 9p
> + export then only a warning message is logged (once) by qemu on
> + host side. In order to avoid file ID collisions on guest you
> + should either create a separate virtfs export for each device to
> + be shared with guests (recommended way) or you might use "remap"
> + instead which allows you to share multiple devices with only one
> + export instead, which is achieved by remapping the original
> + inode numbers from host to guest in a way that would prevent
> + such collisions. Remapping inodes in such use cases is required
> + because the original device IDs from host are never passed and
> + exposed on guest. Instead all files of an export shared with
> + virtfs always share the same device id on guest. So two files
> + with identical inode numbers but from actually different devices
> + on host would otherwise cause a file ID collision and hence
> + potential misbehaviours on guest. "forbid" on the other hand
> + assumes like "warn" that only one device is shared by the same
> + export, however it will not only log a warning message but also
> + deny access to additional devices on guest. Note though that
> + "forbid" does currently not block all possible file access
> + operations (e.g. readdir() would still return entries from other
> + devices).
> +ERST
>
> DEF("iscsi", HAS_ARG, QEMU_OPTION_iscsi,
> "-iscsi [user=user][,password=password]\n"
> @@ -1570,6 +2904,10 @@ STEXI
> @findex -iscsi
> Configure iSCSI session parameters.
> ETEXI
> +SRST
> +``-iscsi``
> + Configure iSCSI session parameters.
> +ERST
>
> STEXI
> @end table
> @@ -1592,6 +2930,13 @@ not enabled by default). Note that on-board USB host controllers may not
> support USB 3.0. In this case @option{-device qemu-xhci} can be used instead
> on machines with PCI.
> ETEXI
> +SRST
> +``-usb``
> + Enable USB emulation on machine types with an on-board USB host
> + controller (if not enabled by default). Note that on-board USB host
> + controllers may not support USB 3.0. In this case
> + ``-device qemu-xhci`` can be used instead on machines with PCI.
> +ERST
>
> DEF("usbdevice", HAS_ARG, QEMU_OPTION_usbdevice,
> "-usbdevice name add the host or guest USB device 'name'\n",
> @@ -1619,6 +2964,26 @@ or fake device.
>
> @end table
> ETEXI
> +SRST
> +``-usbdevice devname``
> + Add the USB device devname. Note that this option is deprecated,
> + please use ``-device usb-...`` instead. See
> + :ref:`usb_005fdevices`.
> +
> + ``mouse``
> + Virtual Mouse. This will override the PS/2 mouse emulation when
> + activated.
> +
> + ``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.
> +
> + ``braille``
> + Braille device. This will use BrlAPI to display the braille
> + output on a real or fake device.
> +ERST
>
> STEXI
> @end table
> @@ -1705,6 +3070,53 @@ application. The Spice server will redirect the serial consoles and
> QEMU monitors. (Since 4.0)
> @end table
> ETEXI
> +SRST
> +``-display type``
> + Select type of display to use. This option is a replacement for the
> + old style -sdl/-curses/... options. Use ``-display help`` to list
> + the available display types. Valid values for type are
> +
> + ``sdl``
> + Display video output via SDL (usually in a separate graphics
> + window; see the SDL documentation for other possibilities).
> +
> + ``curses``
> + Display video output via curses. For graphics device models
> + which support a text mode, QEMU can display this output using a
> + curses/ncurses interface. Nothing is displayed when the graphics
> + device is in graphical mode or if the graphics device does not
> + support a text mode. Generally only the VGA device models
> + support text mode. The font charset used by the guest can be
> + specified with the ``charset`` option, for example
> + ``charset=CP850`` for IBM CP850 encoding. The default is
> + ``CP437``.
> +
> + ``none``
> + Do not display video output. The guest will still see an
> + emulated graphics card, but its output will not be displayed to
> + the QEMU user. This option differs from the -nographic option in
> + that it only affects what is done with video output; -nographic
> + also changes the destination of the serial and parallel port
> + data.
> +
> + ``gtk``
> + Display video output in a GTK window. This interface provides
> + drop-down menus and other UI elements to configure and control
> + the VM during runtime.
> +
> + ``vnc``
> + Start a VNC server on display <arg>
> +
> + ``egl-headless``
> + Offload all OpenGL operations to a local DRI device. For any
> + graphical display, this display needs to be paired with either
> + VNC or SPICE displays.
> +
> + ``spice-app``
> + Start QEMU as a Spice server and launch the default Spice client
> + application. The Spice server will redirect the serial consoles
> + and QEMU monitors. (Since 4.0)
> +ERST
>
> DEF("nographic", 0, QEMU_OPTION_nographic,
> "-nographic disable graphical output and redirect serial I/Os to console\n",
> @@ -1721,6 +3133,17 @@ redirected elsewhere explicitly). Therefore, you can still use QEMU to
> debug a Linux kernel with a serial console. Use @key{C-a h} for help on
> switching between the console and monitor.
> ETEXI
> +SRST
> +``-nographic``
> + Normally, if QEMU is compiled with graphical window support, it
> + displays output such as guest graphics, guest console, and the QEMU
> + monitor in a window. With this option, you can totally disable
> + graphical output so that QEMU is a simple command line application.
> + The emulated serial port is redirected on the console and muxed with
> + the monitor (unless redirected elsewhere explicitly). Therefore, you
> + can still use QEMU to debug a Linux kernel with a serial console.
> + Use C-a h for help on switching between the console and monitor.
> +ERST
>
> DEF("curses", 0, QEMU_OPTION_curses,
> "-curses shorthand for -display curses\n",
> @@ -1734,6 +3157,14 @@ window. With this option, QEMU can display the VGA output when in text
> mode using a curses/ncurses interface. Nothing is displayed in graphical
> mode.
> ETEXI
> +SRST
> +``-curses``
> + Normally, if QEMU is compiled with graphical window support, it
> + displays output such as guest graphics, guest console, and the QEMU
> + monitor in a window. With this option, QEMU can display the VGA
> + output when in text mode using a curses/ncurses interface. Nothing
> + is displayed in graphical mode.
> +ERST
>
> DEF("alt-grab", 0, QEMU_OPTION_alt_grab,
> "-alt-grab use Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt)\n",
> @@ -1744,6 +3175,12 @@ STEXI
> Use Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt). Note that this also
> affects the special keys (for fullscreen, monitor-mode switching, etc).
> ETEXI
> +SRST
> +``-alt-grab``
> + Use Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt). Note that
> + this also affects the special keys (for fullscreen, monitor-mode
> + switching, etc).
> +ERST
>
> DEF("ctrl-grab", 0, QEMU_OPTION_ctrl_grab,
> "-ctrl-grab use Right-Ctrl to grab mouse (instead of Ctrl-Alt)\n",
> @@ -1754,6 +3191,12 @@ STEXI
> Use Right-Ctrl to grab mouse (instead of Ctrl-Alt). Note that this also
> affects the special keys (for fullscreen, monitor-mode switching, etc).
> ETEXI
> +SRST
> +``-ctrl-grab``
> + Use Right-Ctrl to grab mouse (instead of Ctrl-Alt). Note that this
> + also affects the special keys (for fullscreen, monitor-mode
> + switching, etc).
> +ERST
>
> DEF("no-quit", 0, QEMU_OPTION_no_quit,
> "-no-quit disable SDL window close capability\n", QEMU_ARCH_ALL)
> @@ -1762,6 +3205,10 @@ STEXI
> @findex -no-quit
> Disable SDL window close capability.
> ETEXI
> +SRST
> +``-no-quit``
> + Disable SDL window close capability.
> +ERST
>
> DEF("sdl", 0, QEMU_OPTION_sdl,
> "-sdl shorthand for -display sdl\n", QEMU_ARCH_ALL)
> @@ -1770,6 +3217,10 @@ STEXI
> @findex -sdl
> Enable SDL.
> ETEXI
> +SRST
> +``-sdl``
> + Enable SDL.
> +ERST
>
> DEF("spice", HAS_ARG, QEMU_OPTION_spice,
> "-spice [port=port][,tls-port=secured-port][,x509-dir=<dir>]\n"
> @@ -1887,6 +3338,95 @@ the first available. (Since 2.9)
>
> @end table
> ETEXI
> +SRST
> +``-spice option[,option[,...]]``
> + Enable the spice remote desktop protocol. Valid options are
> +
> + ``port=<nr>``
> + Set the TCP port spice is listening on for plaintext channels.
> +
> + ``addr=<addr>``
> + Set the IP address spice is listening on. Default is any
> + address.
> +
> + ``ipv4``; \ ``ipv6``; \ ``unix``
> + Force using the specified IP version.
> +
> + ``password=<secret>``
> + Set the password you need to authenticate.
> +
> + ``sasl``
> + Require that the client use SASL to authenticate with the spice.
> + The exact choice of authentication method used is controlled
> + from the system / user's SASL configuration file for the 'qemu'
> + service. This is typically found in /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. While some SASL auth methods
> + can also provide data encryption (eg GSSAPI), it is recommended
> + that SASL always be combined with the 'tls' and 'x509' settings
> + to enable use of SSL and server certificates. This ensures a
> + data encryption preventing compromise of authentication
> + credentials.
> +
> + ``disable-ticketing``
> + Allow client connects without authentication.
> +
> + ``disable-copy-paste``
> + Disable copy paste between the client and the guest.
> +
> + ``disable-agent-file-xfer``
> + Disable spice-vdagent based file-xfer between the client and the
> + guest.
> +
> + ``tls-port=<nr>``
> + Set the TCP port spice is listening on for encrypted channels.
> +
> + ``x509-dir=<dir>``
> + Set the x509 file directory. Expects same filenames as -vnc
> + $display,x509=$dir
> +
> + ``x509-key-file=<file>``; \ ``x509-key-password=<file>``; \ ``x509-cert-file=<file>``; \ ``x509-cacert-file=<file>``; \ ``x509-dh-key-file=<file>``
> + The x509 file names can also be configured individually.
> +
> + ``tls-ciphers=<list>``
> + Specify which ciphers to use.
> +
> + ``tls-channel=[main|display|cursor|inputs|record|playback]``; \ ``plaintext-channel=[main|display|cursor|inputs|record|playback]``
> + Force specific channel to be used with or without TLS
> + encryption. The options can be specified multiple times to
> + configure multiple channels. The special name "default" can be
> + used to set the default mode. For channels which are not
> + explicitly forced into one mode the spice client is allowed to
> + pick tls/plaintext as he pleases.
> +
> + ``image-compression=[auto_glz|auto_lz|quic|glz|lz|off]``
> + Configure image compression (lossless). Default is auto\_glz.
> +
> + ``jpeg-wan-compression=[auto|never|always]``; \ ``zlib-glz-wan-compression=[auto|never|always]``
> + Configure wan image compression (lossy for slow links). Default
> + is auto.
> +
> + ``streaming-video=[off|all|filter]``
> + Configure video stream detection. Default is off.
> +
> + ``agent-mouse=[on|off]``
> + Enable/disable passing mouse events via vdagent. Default is on.
> +
> + ``playback-compression=[on|off]``
> + Enable/disable audio stream compression (using celt 0.5.1).
> + Default is on.
> +
> + ``seamless-migration=[on|off]``
> + Enable/disable spice seamless migration. Default is off.
> +
> + ``gl=[on|off]``
> + Enable/disable OpenGL context. Default is off.
> +
> + ``rendernode=<file>``
> + DRM render node for OpenGL rendering. If not specified, it will
> + pick the first available. (Since 2.9)
> +ERST
>
> DEF("portrait", 0, QEMU_OPTION_portrait,
> "-portrait rotate graphical output 90 deg left (only PXA LCD)\n",
> @@ -1896,6 +3436,10 @@ STEXI
> @findex -portrait
> Rotate graphical output 90 deg left (only PXA LCD).
> ETEXI
> +SRST
> +``-portrait``
> + Rotate graphical output 90 deg left (only PXA LCD).
> +ERST
>
> DEF("rotate", HAS_ARG, QEMU_OPTION_rotate,
> "-rotate <deg> rotate graphical output some deg left (only PXA LCD)\n",
> @@ -1905,6 +3449,10 @@ STEXI
> @findex -rotate
> Rotate graphical output some deg left (only PXA LCD).
> ETEXI
> +SRST
> +``-rotate deg``
> + Rotate graphical output some deg left (only PXA LCD).
> +ERST
>
> DEF("vga", HAS_ARG, QEMU_OPTION_vga,
> "-vga [std|cirrus|vmware|qxl|xenfb|tcx|cg3|virtio|none]\n"
> @@ -1946,6 +3494,51 @@ Virtio VGA card.
> Disable VGA card.
> @end table
> ETEXI
> +SRST
> +``-vga type``
> + Select type of VGA card to emulate. Valid values for type are
> +
> + ``cirrus``
> + Cirrus Logic GD5446 Video card. All Windows versions starting
> + from Windows 95 should recognize and use this graphic card. For
> + optimal performances, use 16 bit color depth in the guest and
> + the host OS. (This card was the default before QEMU 2.2)
> +
> + ``std``
> + Standard VGA card with Bochs VBE extensions. If your guest OS
> + supports the VESA 2.0 VBE extensions (e.g. Windows XP) and if
> + you want to use high resolution modes (>= 1280x1024x16) then you
> + should use this option. (This card is the default since QEMU
> + 2.2)
> +
> + ``vmware``
> + VMWare SVGA-II compatible adapter. Use it if you have
> + sufficiently recent XFree86/XOrg server or Windows guest with a
> + driver for this card.
> +
> + ``qxl``
> + QXL paravirtual graphic card. It is VGA compatible (including
> + VESA 2.0 VBE support). Works best with qxl guest drivers
> + installed though. Recommended choice when using the spice
> + protocol.
> +
> + ``tcx``
> + (sun4m only) Sun TCX framebuffer. This is the default
> + framebuffer for sun4m machines and offers both 8-bit and 24-bit
> + colour depths at a fixed resolution of 1024x768.
> +
> + ``cg3``
> + (sun4m only) Sun cgthree framebuffer. This is a simple 8-bit
> + framebuffer for sun4m machines available in both 1024x768
> + (OpenBIOS) and 1152x900 (OBP) resolutions aimed at people
> + wishing to run older Solaris versions.
> +
> + ``virtio``
> + Virtio VGA card.
> +
> + ``none``
> + Disable VGA card.
> +ERST
>
> DEF("full-screen", 0, QEMU_OPTION_full_screen,
> "-full-screen start in full screen\n", QEMU_ARCH_ALL)
> @@ -1954,6 +3547,10 @@ STEXI
> @findex -full-screen
> Start in full screen.
> ETEXI
> +SRST
> +``-full-screen``
> + Start in full screen.
> +ERST
>
> DEF("g", HAS_ARG, QEMU_OPTION_g ,
> "-g WxH[xDEPTH] Set the initial graphical resolution and depth\n",
> @@ -1970,6 +3567,17 @@ option of 1024x768x24. For cgthree, the default is 1024x768x8 with the option
> of 1152x900x8 for people who wish to use OBP.
>
> ETEXI
> +SRST
> +``-g widthxheight[xdepth]``
> + 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.
> +ERST
>
> DEF("vnc", HAS_ARG, QEMU_OPTION_vnc ,
> "-vnc <display> shorthand for -display vnc=<display>\n", QEMU_ARCH_ALL)
> @@ -2155,6 +3763,171 @@ be omitted, otherwise is must be present and specify a valid audiodev.
>
> @end table
> ETEXI
> +SRST
> +``-vnc display[,option[,option[,...]]]``
> + Normally, if QEMU is compiled with graphical window support, it
> + displays output such as guest graphics, guest console, and the QEMU
> + monitor in a window. With this option, you can have QEMU listen on
> + VNC display display and redirect the VGA display over the VNC
> + session. It is very useful to enable the usb tablet device when
> + using this option (option ``-device usb-tablet``). When using the
> + VNC display, you must use the ``-k`` parameter to set the keyboard
> + layout if you are not using en-us. Valid syntax for the display is
> +
> + ``to=L``
> + With this option, QEMU will try next available VNC displays,
> + until the number L, if the origianlly defined "-vnc display" is
> + not available, e.g. port 5900+display is already used by another
> + application. By default, to=0.
> +
> + ``host:d``
> + TCP connections will only be allowed from host on display d. By
> + convention the TCP port is 5900+d. Optionally, host can be
> + omitted in which case the server will accept connections from
> + any host.
> +
> + ``unix:path``
> + Connections will be allowed over UNIX domain sockets where path
> + is the location of a unix socket to listen for connections on.
> +
> + ``none``
> + VNC is initialized but not started. The monitor ``change``
> + command can be used to later start the VNC server.
> +
> + Following the display value there may be one or more option flags
> + separated by commas. Valid options are
> +
> + ``reverse``
> + Connect to a listening VNC client via a "reverse" connection.
> + The client is specified by the display. For reverse network
> + connections (host:d,``reverse``), the d argument is a TCP port
> + number, not a display number.
> +
> + ``websocket``
> + Opens an additional TCP listening port dedicated to VNC
> + Websocket connections. If a bare websocket option is given, the
> + Websocket port is 5700+display. An alternative port can be
> + specified with the syntax ``websocket``\ =port.
> +
> + If host is specified connections will only be allowed from this
> + host. It is possible to control the websocket listen address
> + independently, using the syntax ``websocket``\ =host:port.
> +
> + If no TLS credentials are provided, the websocket connection
> + runs in unencrypted mode. If TLS credentials are provided, the
> + websocket connection requires encrypted client connections.
> +
> + ``password``
> + Require that password based authentication is used for client
> + connections.
> +
> + The password must be set separately using the ``set_password``
> + command in the :ref:`pcsys_005fmonitor`. The
> + syntax to change your password is:
> + ``set_password <protocol> <password>`` where <protocol> could be
> + either "vnc" or "spice".
> +
> + If you would like to change <protocol> password expiration, you
> + should use ``expire_password <protocol> <expiration-time>``
> + where expiration time could be one of the following options:
> + now, never, +seconds or UNIX time of expiration, e.g. +60 to
> + make password expire in 60 seconds, or 1335196800 to make
> + password expire on "Mon Apr 23 12:00:00 EDT 2012" (UNIX time for
> + this date and time).
> +
> + You can also use keywords "now" or "never" for the expiration
> + time to allow <protocol> password to expire immediately or never
> + expire.
> +
> + ``tls-creds=ID``
> + Provides the ID of a set of TLS credentials to use to secure the
> + VNC server. They will apply to both the normal VNC server socket
> + and the websocket socket (if enabled). Setting TLS credentials
> + will cause the VNC server socket to enable the VeNCrypt auth
> + mechanism. The credentials should have been previously created
> + using the ``-object tls-creds`` argument.
> +
> + ``tls-authz=ID``
> + Provides the ID of the QAuthZ authorization object against which
> + the client's x509 distinguished name will validated. This object
> + is only resolved at time of use, so can be deleted and recreated
> + on the fly while the VNC server is active. If missing, it will
> + default to denying access.
> +
> + ``sasl``
> + Require that the client use SASL to authenticate with the VNC
> + server. The exact choice of authentication method used is
> + controlled from the system / user's SASL configuration file for
> + the 'qemu' service. This is typically found in
> + /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. While some
> + SASL auth methods can also provide data encryption (eg GSSAPI),
> + it is recommended that SASL always be combined with the 'tls'
> + and 'x509' settings to enable use of SSL and server
> + certificates. This ensures a data encryption preventing
> + compromise of authentication credentials. See the
> + :ref:`vnc_005fsecurity` section for details on
> + using SASL authentication.
> +
> + ``sasl-authz=ID``
> + Provides the ID of the QAuthZ authorization object against which
> + the client's SASL username will validated. This object is only
> + resolved at time of use, so can be deleted and recreated on the
> + fly while the VNC server is active. If missing, it will default
> + to denying access.
> +
> + ``acl``
> + Legacy method for enabling authorization of clients against the
> + x509 distinguished name and SASL username. It results in the
> + creation of two ``authz-list`` objects with IDs of
> + ``vnc.username`` and ``vnc.x509dname``. The rules for these
> + objects must be configured with the HMP ACL commands.
> +
> + This option is deprecated and should no longer be used. The new
> + ``sasl-authz`` and ``tls-authz`` options are a replacement.
> +
> + ``lossy``
> + Enable lossy compression methods (gradient, JPEG, ...). If this
> + option is set, VNC client may receive lossy framebuffer updates
> + depending on its encoding settings. Enabling this option can
> + save a lot of bandwidth at the expense of quality.
> +
> + ``non-adaptive``
> + Disable adaptive encodings. Adaptive encodings are enabled by
> + default. An adaptive encoding will try to detect frequently
> + updated screen regions, and send updates in these regions using
> + a lossy encoding (like JPEG). This can be really helpful to save
> + bandwidth when playing videos. Disabling adaptive encodings
> + restores the original static behavior of encodings like Tight.
> +
> + ``share=[allow-exclusive|force-shared|ignore]``
> + Set display sharing policy. 'allow-exclusive' allows clients to
> + ask for exclusive access. As suggested by the rfb spec this is
> + implemented by dropping other connections. Connecting multiple
> + clients in parallel requires all clients asking for a shared
> + session (vncviewer: -shared switch). This is the default.
> + 'force-shared' disables exclusive client access. Useful for
> + shared desktop sessions, where you don't want someone forgetting
> + specify -shared disconnect everybody else. 'ignore' completely
> + ignores the shared flag and allows everybody connect
> + unconditionally. Doesn't conform to the rfb spec but is
> + traditional QEMU behavior.
> +
> + ``key-delay-ms``
> + Set keyboard delay, for key down and key up events, in
> + milliseconds. Default is 10. Keyboards are low-bandwidth
> + devices, so this slowdown can help the device and guest to keep
> + up and not lose events in case events are arriving in bulk.
> + Possible causes for the latter are flaky network connections, or
> + scripts for automated testing.
> +
> + ``audiodev=audiodev``
> + Use the specified audiodev when the VNC client requests audio
> + transmission. When not using an -audiodev argument, this option
> + must be omitted, otherwise is must be present and specify a
> + valid audiodev.
> +ERST
>
> STEXI
> @end table
> @@ -2176,6 +3949,12 @@ Use it when installing Windows 2000 to avoid a disk full bug. After
> Windows 2000 is installed, you no longer need this option (this option
> slows down the IDE transfers).
> ETEXI
> +SRST
> +``-win2k-hack``
> + Use it when installing Windows 2000 to avoid a disk full bug. After
> + Windows 2000 is installed, you no longer need this option (this
> + option slows down the IDE transfers).
> +ERST
>
> DEF("no-fd-bootchk", 0, QEMU_OPTION_no_fd_bootchk,
> "-no-fd-bootchk disable boot signature checking for floppy disks\n",
> @@ -2186,6 +3965,11 @@ STEXI
> Disable boot signature checking for floppy disks in BIOS. May
> be needed to boot from old floppy disks.
> ETEXI
> +SRST
> +``-no-fd-bootchk``
> + Disable boot signature checking for floppy disks in BIOS. May be
> + needed to boot from old floppy disks.
> +ERST
>
> DEF("no-acpi", 0, QEMU_OPTION_no_acpi,
> "-no-acpi disable ACPI\n", QEMU_ARCH_I386 | QEMU_ARCH_ARM)
> @@ -2196,6 +3980,12 @@ Disable ACPI (Advanced Configuration and Power Interface) support. Use
> it if your guest OS complains about ACPI problems (PC target machine
> only).
> ETEXI
> +SRST
> +``-no-acpi``
> + Disable ACPI (Advanced Configuration and Power Interface) support.
> + Use it if your guest OS complains about ACPI problems (PC target
> + machine only).
> +ERST
>
> DEF("no-hpet", 0, QEMU_OPTION_no_hpet,
> "-no-hpet disable HPET\n", QEMU_ARCH_I386)
> @@ -2204,6 +3994,10 @@ STEXI
> @findex -no-hpet
> Disable HPET support.
> ETEXI
> +SRST
> +``-no-hpet``
> + Disable HPET support.
> +ERST
>
> DEF("acpitable", HAS_ARG, QEMU_OPTION_acpitable,
> "-acpitable [sig=str][,rev=n][,oem_id=str][,oem_table_id=str][,oem_rev=n][,asl_compiler_id=str][,asl_compiler_rev=n][,{data|file}=file1[:file2]...]\n"
> @@ -2222,6 +4016,18 @@ fields will override the same in the RSDT and the FADT (a.k.a. FACP), in order
> to ensure the field matches required by the Microsoft SLIC spec and the ACPI
> spec.
> ETEXI
> +SRST
> +``-acpitable [sig=str][,rev=n][,oem_id=str][,oem_table_id=str][,oem_rev=n] [,asl_compiler_id=str][,asl_compiler_rev=n][,data=file1[:file2]...]``
> + Add ACPI table with specified header fields and context from
> + specified files. For file=, take whole ACPI table from the specified
> + files, including all ACPI headers (possible overridden by other
> + options). For data=, only data portion of the table is used, all
> + header information is specified in the command line. If a SLIC table
> + is supplied to QEMU, then the SLIC's oem\_id and oem\_table\_id
> + fields will override the same in the RSDT and the FADT (a.k.a.
> + FACP), in order to ensure the field matches required by the
> + Microsoft SLIC spec and the ACPI spec.
> +ERST
>
> DEF("smbios", HAS_ARG, QEMU_OPTION_smbios,
> "-smbios file=binary\n"
> @@ -2268,6 +4074,28 @@ Specify SMBIOS type 4 fields
> @item -smbios type=17[,loc_pfx=@var{str}][,bank=@var{str}][,manufacturer=@var{str}][,serial=@var{str}][,asset=@var{str}][,part=@var{str}][,speed=@var{%d}]
> Specify SMBIOS type 17 fields
> ETEXI
> +SRST
> +``-smbios file=binary``
> + Load SMBIOS entry from binary file.
> +
> +``-smbios type=0[,vendor=str][,version=str][,date=str][,release=%d.%d][,uefi=on|off]``
> + Specify SMBIOS type 0 fields
> +
> +``-smbios type=1[,manufacturer=str][,product=str][,version=str][,serial=str][,uuid=uuid][,sku=str][,family=str]``
> + Specify SMBIOS type 1 fields
> +
> +``-smbios type=2[,manufacturer=str][,product=str][,version=str][,serial=str][,asset=str][,location=str]``
> + Specify SMBIOS type 2 fields
> +
> +``-smbios type=3[,manufacturer=str][,version=str][,serial=str][,asset=str][,sku=str]``
> + Specify SMBIOS type 3 fields
> +
> +``-smbios type=4[,sock_pfx=str][,manufacturer=str][,version=str][,serial=str][,asset=str][,part=str]``
> + Specify SMBIOS type 4 fields
> +
> +``-smbios type=17[,loc_pfx=str][,bank=str][,manufacturer=str][,serial=str][,asset=str][,part=str][,speed=%d]``
> + Specify SMBIOS type 17 fields
> +ERST
>
> STEXI
> @end table
> @@ -2866,6 +4694,470 @@ Configure a host network backend (with the options corresponding to the same
> @option{-netdev} option) and connect it to the emulated hub 0 (the default
> hub). Use @var{name} to specify the name of the hub port.
> ETEXI
> +SRST
> +``-nic [tap|bridge|user|l2tpv3|vde|netmap|vhost-user|socket][,...][,mac=macaddr][,model=mn]``
> + This option is a shortcut for configuring both the on-board
> + (default) guest NIC hardware and the host network backend in one go.
> + The host backend options are the same as with the corresponding
> + ``-netdev`` options below. The guest NIC model can be set with
> + ``model=modelname``. Use ``model=help`` to list the available device
> + types. The hardware MAC address can be set with ``mac=macaddr``.
> +
> + The following two example do exactly the same, to show how ``-nic``
> + can be used to shorten the command line length:
> +
> + .. parsed-literal::
> +
> + |qemu_system| -netdev user,id=n1,ipv6=off -device e1000,netdev=n1,mac=52:54:98:76:54:32
> + |qemu_system| -nic user,ipv6=off,model=e1000,mac=52:54:98:76:54:32
> +
> +``-nic none``
> + Indicate that no network devices should be configured. It is used to
> + override the default configuration (default NIC with "user" host
> + network backend) which is activated if no other networking options
> + are provided.
> +
> +``-netdev user,id=id[,option][,option][,...]``
> + Configure user mode host network backend which requires no
> + administrator privilege to run. Valid options are:
> +
> + ``id=id``
> + Assign symbolic name for use in monitor commands.
> +
> + ``ipv4=on|off and ipv6=on|off``
> + Specify that either IPv4 or IPv6 must be enabled. If neither is
> + specified both protocols are enabled.
> +
> + ``net=addr[/mask]``
> + Set IP network address the guest will see. Optionally specify
> + the netmask, either in the form a.b.c.d or as number of valid
> + top-most bits. Default is 10.0.2.0/24.
> +
> + ``host=addr``
> + Specify the guest-visible address of the host. Default is the
> + 2nd IP in the guest network, i.e. x.x.x.2.
> +
> + ``ipv6-net=addr[/int]``
> + Set IPv6 network address the guest will see (default is
> + fec0::/64). The network prefix is given in the usual hexadecimal
> + IPv6 address notation. The prefix size is optional, and is given
> + as the number of valid top-most bits (default is 64).
> +
> + ``ipv6-host=addr``
> + Specify the guest-visible IPv6 address of the host. Default is
> + the 2nd IPv6 in the guest network, i.e. xxxx::2.
> +
> + ``restrict=on|off``
> + If this option is enabled, the guest will be isolated, i.e. it
> + will not be able to contact the host and no guest IP packets
> + will be routed over the host to the outside. This option does
> + not affect any explicitly set forwarding rules.
> +
> + ``hostname=name``
> + Specifies the client hostname reported by the built-in DHCP
> + server.
> +
> + ``dhcpstart=addr``
> + Specify the first of the 16 IPs the built-in DHCP server can
> + assign. Default is the 15th to 31st IP in the guest network,
> + i.e. x.x.x.15 to x.x.x.31.
> +
> + ``dns=addr``
> + Specify the guest-visible address of the virtual nameserver. The
> + address must be different from the host address. Default is the
> + 3rd IP in the guest network, i.e. x.x.x.3.
> +
> + ``ipv6-dns=addr``
> + Specify the guest-visible address of the IPv6 virtual
> + nameserver. The address must be different from the host address.
> + Default is the 3rd IP in the guest network, i.e. xxxx::3.
> +
> + ``dnssearch=domain``
> + Provides an entry for the domain-search list sent by the
> + built-in DHCP server. More than one domain suffix can be
> + transmitted by specifying this option multiple times. If
> + supported, this will cause the guest to automatically try to
> + append the given domain suffix(es) in case a domain name can not
> + be resolved.
> +
> + Example:
> +
> + .. parsed-literal::
> +
> + |qemu_system| -nic user,dnssearch=mgmt.example.org,dnssearch=example.org
> +
> + ``domainname=domain``
> + Specifies the client domain name reported by the built-in DHCP
> + server.
> +
> + ``tftp=dir``
> + When using the user mode network stack, activate a built-in TFTP
> + server. The files in dir will be exposed as the root of a TFTP
> + server. The TFTP client on the guest must be configured in
> + binary mode (use the command ``bin`` of the Unix TFTP client).
> +
> + ``tftp-server-name=name``
> + In BOOTP reply, broadcast name as the "TFTP server name"
> + (RFC2132 option 66). This can be used to advise the guest to
> + load boot files or configurations from a different server than
> + the host address.
> +
> + ``bootfile=file``
> + When using the user mode network stack, broadcast file as the
> + BOOTP filename. In conjunction with ``tftp``, this can be used
> + to network boot a guest from a local directory.
> +
> + Example (using pxelinux):
> +
> + .. parsed-literal::
> +
> + |qemu_system| -hda linux.img -boot n -device e1000,netdev=n1 \
> + -netdev user,id=n1,tftp=/path/to/tftp/files,bootfile=/pxelinux.0
> +
> + ``smb=dir[,smbserver=addr]``
> + When using the user mode network stack, activate a built-in SMB
> + server so that Windows OSes can access to the host files in
> + ``dir`` transparently. The IP address of the SMB server can be
> + set to addr. By default the 4th IP in the guest network is used,
> + i.e. x.x.x.4.
> +
> + In the guest Windows OS, the line:
> +
> + ::
> +
> + 10.0.2.4 smbserver
> +
> + must be added in the file ``C:\WINDOWS\LMHOSTS`` (for windows
> + 9x/Me) or ``C:\WINNT\SYSTEM32\DRIVERS\ETC\LMHOSTS`` (Windows
> + NT/2000).
> +
> + Then ``dir`` can be accessed in ``\\smbserver\qemu``.
> +
> + Note that a SAMBA server must be installed on the host OS.
> +
> + ``hostfwd=[tcp|udp]:[hostaddr]:hostport-[guestaddr]:guestport``
> + Redirect incoming TCP or UDP connections to the host port
> + hostport to the guest IP address guestaddr on guest port
> + guestport. If guestaddr is not specified, its value is x.x.x.15
> + (default first address given by the built-in DHCP server). By
> + specifying hostaddr, the rule can be bound to a specific host
> + interface. If no connection type is set, TCP is used. This
> + option can be given multiple times.
> +
> + For example, to redirect host X11 connection from screen 1 to
> + guest screen 0, use the following:
> +
> + ::
> +
> + # on the host
> + |qemu_system| -nic user,hostfwd=tcp:127.0.0.1:6001-:6000
> + # this host xterm should open in the guest X11 server
> + xterm -display :1
> +
> + To redirect telnet connections from host port 5555 to telnet
> + port on the guest, use the following:
> +
> + ::
> +
> + # on the host
> + |qemu_system| -nic user,hostfwd=tcp::5555-:23
> + telnet localhost 5555
> +
> + Then when you use on the host ``telnet localhost 5555``, you
> + connect to the guest telnet server.
> +
> + ``guestfwd=[tcp]:server:port-dev``; \ ``guestfwd=[tcp]:server:port-cmd:command``
> + Forward guest TCP connections to the IP address server on port
> + port to the character device dev or to a program executed by
> + cmd:command which gets spawned for each connection. This option
> + can be given multiple times.
> +
> + You can either use a chardev directly and have that one used
> + throughout QEMU's lifetime, like in the following example:
> +
> + ::
> +
> + # open 10.10.1.1:4321 on bootup, connect 10.0.2.100:1234 to it whenever
> + # the guest accesses it
> + |qemu_system| -nic user,guestfwd=tcp:10.0.2.100:1234-tcp:10.10.1.1:4321
> +
> + Or you can execute a command on every TCP connection established
> + by the guest, so that QEMU behaves similar to an inetd process
> + for that virtual server:
> +
> + ::
> +
> + # 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
> + |qemu_system| -nic 'user,id=n1,guestfwd=tcp:10.0.2.100:1234-cmd:netcat 10.10.1.1 4321'
> +
> +``-netdev tap,id=id[,fd=h][,ifname=name][,script=file][,downscript=dfile][,br=bridge][,helper=helper]``
> + Configure a host TAP network backend with ID id.
> +
> + Use the network script file to configure it and the network script
> + dfile to deconfigure it. If name is not provided, the OS
> + automatically provides one. The default network configure script is
> + ``/etc/qemu-ifup`` and the default network deconfigure script is
> + ``/etc/qemu-ifdown``. Use ``script=no`` or ``downscript=no`` to
> + disable script execution.
> +
> + If running QEMU as an unprivileged user, use the network helper
> + helper to configure the TAP interface and attach it to the bridge.
> + The default network helper executable is
> + ``/path/to/qemu-bridge-helper`` and the default bridge device is
> + ``br0``.
> +
> + ``fd``\ =h can be used to specify the handle of an already opened
> + host TAP interface.
> +
> + Examples:
> +
> + ::
> +
> + #launch a QEMU instance with the default network script
> + |qemu_system| linux.img -nic tap
> +
> + ::
> +
> + #launch a QEMU instance with two NICs, each one connected
> + #to a TAP device
> + |qemu_system| linux.img \
> + -netdev tap,id=nd0,ifname=tap0 -device e1000,netdev=nd0 \
> + -netdev tap,id=nd1,ifname=tap1 -device rtl8139,netdev=nd1
> +
> + ::
> +
> + #launch a QEMU instance with the default network helper to
> + #connect a TAP device to bridge br0
> + |qemu_system| linux.img -device virtio-net-pci,netdev=n1 \
> + -netdev tap,id=n1,"helper=/path/to/qemu-bridge-helper"
> +
> +``-netdev bridge,id=id[,br=bridge][,helper=helper]``
> + Connect a host TAP network interface to a host bridge device.
> +
> + Use the network helper helper to configure the TAP interface and
> + attach it to the bridge. The default network helper executable is
> + ``/path/to/qemu-bridge-helper`` and the default bridge device is
> + ``br0``.
> +
> + Examples:
> +
> + ::
> +
> + #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
> +
> + ::
> +
> + #launch a QEMU instance with the default network helper to
> + #connect a TAP device to bridge qemubr0
> + |qemu_system| linux.img -netdev bridge,br=qemubr0,id=n1 -device virtio-net,netdev=n1
> +
> +``-netdev socket,id=id[,fd=h][,listen=[host]:port][,connect=host:port]``
> + This host network backend can be used to connect the guest's network
> + to another QEMU virtual machine using a TCP socket connection. If
> + ``listen`` is specified, QEMU waits for incoming connections on port
> + (host is optional). ``connect`` is used to connect to another QEMU
> + instance using the ``listen`` option. ``fd``\ =h specifies an
> + already opened TCP socket.
> +
> + Example:
> +
> + ::
> +
> + # launch a first QEMU instance
> + |qemu_system| linux.img \
> + -device e1000,netdev=n1,mac=52:54:00:12:34:56 \
> + -netdev socket,id=n1,listen=:1234
> + # connect the network of this instance to the network of the first instance
> + |qemu_system| linux.img \
> + -device e1000,netdev=n2,mac=52:54:00:12:34:57 \
> + -netdev socket,id=n2,connect=127.0.0.1:1234
> +
> +``-netdev socket,id=id[,fd=h][,mcast=maddr:port[,localaddr=addr]]``
> + Configure a socket host network backend to share the guest's network
> + traffic with another QEMU virtual machines using a UDP multicast
> + socket, effectively making a bus for every QEMU with same multicast
> + address maddr and port. NOTES:
> +
> + 1. Several QEMU can be running on different hosts and share same bus
> + (assuming correct multicast setup for these hosts).
> +
> + 2. mcast support is compatible with User Mode Linux (argument
> + ``ethN=mcast``), see http://user-mode-linux.sf.net.
> +
> + 3. Use ``fd=h`` to specify an already opened UDP multicast socket.
> +
> + Example:
> +
> + ::
> +
> + # launch one QEMU instance
> + |qemu_system| linux.img \
> + -device e1000,netdev=n1,mac=52:54:00:12:34:56 \
> + -netdev socket,id=n1,mcast=230.0.0.1:1234
> + # launch another QEMU instance on same "bus"
> + |qemu_system| linux.img \
> + -device e1000,netdev=n2,mac=52:54:00:12:34:57 \
> + -netdev socket,id=n2,mcast=230.0.0.1:1234
> + # launch yet another QEMU instance on same "bus"
> + |qemu_system| linux.img \
> + -device e1000,netdev=n3,mac=52:54:00:12:34:58 \
> + -netdev socket,id=n3,mcast=230.0.0.1:1234
> +
> + Example (User Mode Linux compat.):
> +
> + ::
> +
> + # launch QEMU instance (note mcast address selected is UML's default)
> + |qemu_system| linux.img \
> + -device e1000,netdev=n1,mac=52:54:00:12:34:56 \
> + -netdev socket,id=n1,mcast=239.192.168.1:1102
> + # launch UML
> + /path/to/linux ubd0=/path/to/root_fs eth0=mcast
> +
> + Example (send packets from host's 1.2.3.4):
> +
> + .. parsed-literal::
> +
> + |qemu_system| linux.img \
> + -device e1000,netdev=n1,mac=52:54:00:12:34:56 \
> + -netdev socket,id=n1,mcast=239.192.168.1:1102,localaddr=1.2.3.4
> +
> +``-netdev l2tpv3,id=id,src=srcaddr,dst=dstaddr[,srcport=srcport][,dstport=dstport],txsession=txsession[,rxsession=rxsession][,ipv6][,udp][,cookie64][,counter][,pincounter][,txcookie=txcookie][,rxcookie=rxcookie][,offset=offset]``
> + Configure a L2TPv3 pseudowire host network backend. L2TPv3 (RFC3391)
> + is a popular protocol to transport Ethernet (and other Layer 2) data
> + frames between two systems. It is present in routers, firewalls and
> + the Linux kernel (from version 3.3 onwards).
> +
> + This transport allows a VM to communicate to another VM, router or
> + firewall directly.
> +
> + ``src=srcaddr``
> + source address (mandatory)
> +
> + ``dst=dstaddr``
> + destination address (mandatory)
> +
> + ``udp``
> + select udp encapsulation (default is ip).
> +
> + ``srcport=srcport``
> + source udp port.
> +
> + ``dstport=dstport``
> + destination udp port.
> +
> + ``ipv6``
> + force v6, otherwise defaults to v4.
> +
> + ``rxcookie=rxcookie``; \ ``txcookie=txcookie``
> + Cookies are a weak form of security in the l2tpv3 specification.
> + Their function is mostly to prevent misconfiguration. By default
> + they are 32 bit.
> +
> + ``cookie64``
> + Set cookie size to 64 bit instead of the default 32
> +
> + ``counter=off``
> + Force a 'cut-down' L2TPv3 with no counter as in
> + draft-mkonstan-l2tpext-keyed-ipv6-tunnel-00
> +
> + ``pincounter=on``
> + Work around broken counter handling in peer. This may also help
> + on networks which have packet reorder.
> +
> + ``offset=offset``
> + Add an extra offset between header and data
> +
> + 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:
> +
> + ::
> +
> + # Setup tunnel on linux host using raw ip as encapsulation
> + # on 1.2.3.4
> + ip l2tp add tunnel remote 4.3.2.1 local 1.2.3.4 tunnel_id 1 peer_tunnel_id 1 \
> + encap udp udp_sport 16384 udp_dport 16384
> + ip l2tp add session tunnel_id 1 name vmtunnel0 session_id \
> + 0xFFFFFFFF peer_session_id 0xFFFFFFFF
> + ifconfig vmtunnel0 mtu 1500
> + ifconfig vmtunnel0 up
> + brctl addif br-lan vmtunnel0
> +
> +
> + # on 4.3.2.1
> + # launch QEMU instance - if your network has reorder or is very lossy add ,pincounter
> +
> + |qemu_system| linux.img -device e1000,netdev=n1 \
> + -netdev l2tpv3,id=n1,src=4.2.3.1,dst=1.2.3.4,udp,srcport=16384,dstport=16384,rxsession=0xffffffff,txsession=0xffffffff,counter
> +
> +``-netdev vde,id=id[,sock=socketpath][,port=n][,group=groupname][,mode=octalmode]``
> + Configure VDE backend to connect to PORT n of a vde switch running
> + on host and listening for incoming connections on socketpath. Use
> + GROUP groupname and MODE octalmode to change default ownership and
> + permissions for communication port. This option is only available if
> + QEMU has been compiled with vde support enabled.
> +
> + Example:
> +
> + ::
> +
> + # launch vde switch
> + vde_switch -F -sock /tmp/myswitch
> + # launch QEMU instance
> + |qemu_system| linux.img -nic vde,sock=/tmp/myswitch
> +
> +``-netdev vhost-user,chardev=id[,vhostforce=on|off][,queues=n]``
> + Establish a vhost-user netdev, backed by a chardev id. The chardev
> + should be a unix domain socket backed one. The vhost-user uses a
> + specifically defined protocol to pass vhost ioctl replacement
> + messages to an application on the other end of the socket. On
> + non-MSIX guests, the feature can be forced with vhostforce. Use
> + 'queues=n' to specify the number of queues to be created for
> + multiqueue vhost-user.
> +
> + Example:
> +
> + ::
> +
> + qemu -m 512 -object memory-backend-file,id=mem,size=512M,mem-path=/hugetlbfs,share=on \
> + -numa node,memdev=mem \
> + -chardev socket,id=chr0,path=/path/to/socket \
> + -netdev type=vhost-user,id=net0,chardev=chr0 \
> + -device virtio-net-pci,netdev=net0
> +
> +``-netdev hubport,id=id,hubid=hubid[,netdev=nd]``
> + Create a hub port on the emulated hub with ID hubid.
> +
> + The hubport netdev lets you connect a NIC to a QEMU emulated hub
> + instead of a single netdev. Alternatively, you can also connect the
> + hubport to another netdev with ID nd by using the ``netdev=nd``
> + option.
> +
> +``-net nic[,netdev=nd][,macaddr=mac][,model=type] [,name=name][,addr=addr][,vectors=v]``
> + Legacy option to configure or create an on-board (or machine
> + default) Network Interface Card(NIC) and connect it either to the
> + emulated hub with ID 0 (i.e. the default hub), or to the netdev nd.
> + If model is omitted, then the default NIC model associated with the
> + machine type is used. Note that the default NIC model may change in
> + future QEMU releases, so it is highly recommended to always specify
> + a model. Optionally, the MAC address can be changed to mac, the
> + device address set to addr (PCI cards only), and a name can be
> + assigned for use in monitor commands. Optionally, for PCI cards, you
> + can specify the number v of MSI-X vectors that the card should have;
> + this option currently only affects virtio cards; set v = 0 to
> + disable MSI-X. If no ``-net`` option is specified, a single NIC is
> + created. QEMU can emulate several different models of network card.
> + Use ``-net nic,model=help`` for a list of available devices for your
> + target.
> +
> +``-net user|tap|bridge|socket|l2tpv3|vde[,...][,name=name]``
> + Configure a host network backend (with the options corresponding to
> + the same ``-netdev`` option) and connect it to the emulated hub 0
> + (the default hub). Use name to specify the name of the hub port.
> +ERST
>
> STEXI
> @end table
> @@ -3209,6 +5501,264 @@ Connect to a spice virtual machine channel, such as vdiport.
> Connect to a spice port, allowing a Spice client to handle the traffic
> identified by a name (preferably a fqdn).
> ETEXI
> +SRST
> +The general form of a character device option is:
> +
> +``-chardev backend,id=id[,mux=on|off][,options]``
> + Backend is one of: ``null``, ``socket``, ``udp``, ``msmouse``,
> + ``vc``, ``ringbuf``, ``file``, ``pipe``, ``console``, ``serial``,
> + ``pty``, ``stdio``, ``braille``, ``tty``, ``parallel``, ``parport``,
> + ``spicevmc``, ``spiceport``. The specific backend will determine the
> + applicable options.
> +
> + Use ``-chardev help`` to print all available chardev backend types.
> +
> + All devices must have an id, which can be any string up to 127
> + characters long. It is used to uniquely identify this device in
> + other command line directives.
> +
> + A character device may be used in multiplexing mode by multiple
> + front-ends. Specify ``mux=on`` to enable this mode. A multiplexer is
> + a "1:N" device, and here the "1" end is your specified chardev
> + backend, and the "N" end is the various parts of QEMU that can talk
> + to a chardev. If you create a chardev with ``id=myid`` and
> + ``mux=on``, QEMU will create a multiplexer with your specified ID,
> + and you can then configure multiple front ends to use that chardev
> + ID for their input/output. Up to four different front ends can be
> + connected to a single multiplexed chardev. (Without multiplexing
> + enabled, a chardev can only be used by a single front end.) For
> + instance you could use this to allow a single stdio chardev to be
> + used by two serial ports and the QEMU monitor:
> +
> + ::
> +
> + -chardev stdio,mux=on,id=char0 \
> + -mon chardev=char0,mode=readline \
> + -serial chardev:char0 \
> + -serial chardev:char0
> +
> + You can have more than one multiplexer in a system configuration;
> + for instance you could have a TCP port multiplexed between UART 0
> + and UART 1, and stdio multiplexed between the QEMU monitor and a
> + parallel port:
> +
> + ::
> +
> + -chardev stdio,mux=on,id=char0 \
> + -mon chardev=char0,mode=readline \
> + -parallel chardev:char0 \
> + -chardev tcp,...,mux=on,id=char1 \
> + -serial chardev:char1 \
> + -serial chardev:char1
> +
> + When you're using a multiplexed character device, some escape
> + sequences are interpreted in the input. See :ref:`mux_005fkeys`.
> +
> + Note that some other command line options may implicitly create
> + multiplexed character backends; for instance ``-serial mon:stdio``
> + creates a multiplexed stdio backend connected to the serial port and
> + the QEMU monitor, and ``-nographic`` also multiplexes the console
> + and the monitor to stdio.
> +
> + There is currently no support for multiplexing in the other
> + direction (where a single QEMU front end takes input and output from
> + multiple chardevs).
> +
> + Every backend supports the ``logfile`` option, which supplies the
> + path to a file to record all data transmitted via the backend. The
> + ``logappend`` option controls whether the log file will be truncated
> + or appended to when opened.
> +
> +The available backends are:
> +
> +``-chardev null,id=id``
> + A void device. This device will not emit any data, and will drop any
> + data it receives. The null backend does not take any options.
> +
> +``-chardev socket,id=id[,TCP options or unix options][,server][,nowait][,telnet][,websocket][,reconnect=seconds][,tls-creds=id][,tls-authz=id]``
> + Create a two-way stream socket, which can be either a TCP or a unix
> + socket. A unix socket will be created if ``path`` is specified.
> + Behaviour is undefined if TCP options are specified for a unix
> + socket.
> +
> + ``server`` specifies that the socket shall be a listening socket.
> +
> + ``nowait`` specifies that QEMU should not block waiting for a client
> + to connect to a listening socket.
> +
> + ``telnet`` specifies that traffic on the socket should interpret
> + telnet escape sequences.
> +
> + ``websocket`` specifies that the socket uses WebSocket protocol for
> + communication.
> +
> + ``reconnect`` sets the timeout for reconnecting on non-server
> + sockets when the remote end goes away. qemu will delay this many
> + seconds and then attempt to reconnect. Zero disables reconnecting,
> + and is the default.
> +
> + ``tls-creds`` requests enablement of the TLS protocol for
> + encryption, and specifies the id of the TLS credentials to use for
> + the handshake. The credentials must be previously created with the
> + ``-object tls-creds`` argument.
> +
> + ``tls-auth`` provides the ID of the QAuthZ authorization object
> + against which the client's x509 distinguished name will be
> + validated. This object is only resolved at time of use, so can be
> + deleted and recreated on the fly while the chardev server is active.
> + If missing, it will default to denying access.
> +
> + TCP and unix socket options are given below:
> +
> + ``TCP options: port=port[,host=host][,to=to][,ipv4][,ipv6][,nodelay]``
> + ``host`` for a listening socket specifies the local address to
> + be bound. For a connecting socket species the remote host to
> + connect to. ``host`` is optional for listening sockets. If not
> + specified it defaults to ``0.0.0.0``.
> +
> + ``port`` for a listening socket specifies the local port to be
> + bound. For a connecting socket specifies the port on the remote
> + host to connect to. ``port`` can be given as either a port
> + number or a service name. ``port`` is required.
> +
> + ``to`` is only relevant to listening sockets. If it is
> + specified, and ``port`` cannot be bound, QEMU will attempt to
> + bind to subsequent ports up to and including ``to`` until it
> + succeeds. ``to`` must be specified as a port number.
> +
> + ``ipv4`` and ``ipv6`` specify that either IPv4 or IPv6 must be
> + used. If neither is specified the socket may use either
> + protocol.
> +
> + ``nodelay`` disables the Nagle algorithm.
> +
> + ``unix options: path=path``
> + ``path`` specifies the local path of the unix socket. ``path``
> + is required.
> +
> +``-chardev udp,id=id[,host=host],port=port[,localaddr=localaddr][,localport=localport][,ipv4][,ipv6]``
> + Sends all traffic from the guest to a remote host over UDP.
> +
> + ``host`` specifies the remote host to connect to. If not specified
> + it defaults to ``localhost``.
> +
> + ``port`` specifies the port on the remote host to connect to.
> + ``port`` is required.
> +
> + ``localaddr`` specifies the local address to bind to. If not
> + specified it defaults to ``0.0.0.0``.
> +
> + ``localport`` specifies the local port to bind to. If not specified
> + any available local port will be used.
> +
> + ``ipv4`` and ``ipv6`` specify that either IPv4 or IPv6 must be used.
> + If neither is specified the device may use either protocol.
> +
> +``-chardev msmouse,id=id``
> + Forward QEMU's emulated msmouse events to the guest. ``msmouse``
> + does not take any options.
> +
> +``-chardev vc,id=id[[,width=width][,height=height]][[,cols=cols][,rows=rows]]``
> + Connect to a QEMU text console. ``vc`` may optionally be given a
> + specific size.
> +
> + ``width`` and ``height`` specify the width and height respectively
> + of the console, in pixels.
> +
> + ``cols`` and ``rows`` specify that the console be sized to fit a
> + text console with the given dimensions.
> +
> +``-chardev ringbuf,id=id[,size=size]``
> + Create a ring buffer with fixed size ``size``. size must be a power
> + of two and defaults to ``64K``.
> +
> +``-chardev file,id=id,path=path``
> + Log all traffic received from the guest to a file.
> +
> + ``path`` specifies the path of the file to be opened. This file will
> + be created if it does not already exist, and overwritten if it does.
> + ``path`` is required.
> +
> +``-chardev pipe,id=id,path=path``
> + Create a two-way connection to the guest. The behaviour differs
> + slightly between Windows hosts and other hosts:
> +
> + On Windows, a single duplex pipe will be created at
> + ``\\.pipe\path``.
> +
> + On other hosts, 2 pipes will be created called ``path.in`` and
> + ``path.out``. Data written to ``path.in`` will be received by the
> + guest. Data written by the guest can be read from ``path.out``. QEMU
> + will not create these fifos, and requires them to be present.
> +
> + ``path`` forms part of the pipe path as described above. ``path`` is
> + required.
> +
> +``-chardev console,id=id``
> + Send traffic from the guest to QEMU's standard output. ``console``
> + does not take any options.
> +
> + ``console`` is only available on Windows hosts.
> +
> +``-chardev serial,id=id,path=path``
> + Send traffic from the guest to a serial device on the host.
> +
> + On Unix hosts serial will actually accept any tty device, not only
> + serial lines.
> +
> + ``path`` specifies the name of the serial device to open.
> +
> +``-chardev pty,id=id``
> + Create a new pseudo-terminal on the host and connect to it. ``pty``
> + does not take any options.
> +
> + ``pty`` is not available on Windows hosts.
> +
> +``-chardev stdio,id=id[,signal=on|off]``
> + Connect to standard input and standard output of the QEMU process.
> +
> + ``signal`` controls if signals are enabled on the terminal, that
> + includes exiting QEMU with the key sequence Control-c. This option
> + is enabled by default, use ``signal=off`` to disable it.
> +
> +``-chardev braille,id=id``
> + Connect to a local BrlAPI server. ``braille`` does not take any
> + options.
> +
> +``-chardev tty,id=id,path=path``
> + ``tty`` is only available on Linux, Sun, FreeBSD, NetBSD, OpenBSD
> + and DragonFlyBSD hosts. It is an alias for ``serial``.
> +
> + ``path`` specifies the path to the tty. ``path`` is required.
> +
> +``-chardev parallel,id=id,path=path``; \ ``-chardev parport,id=id,path=path``
> + ``parallel`` is only available on Linux, FreeBSD and DragonFlyBSD
> + hosts.
> +
> + Connect to a local parallel port.
> +
> + ``path`` specifies the path to the parallel port device. ``path`` is
> + required.
> +
> +``-chardev spicevmc,id=id,debug=debug,name=name``
> + ``spicevmc`` is only available when spice support is built in.
> +
> + ``debug`` debug level for spicevmc
> +
> + ``name`` name of spice channel to connect to
> +
> + Connect to a spice virtual machine channel, such as vdiport.
> +
> +``-chardev spiceport,id=id,debug=debug,name=name``
> + ``spiceport`` is only available when spice support is built in.
> +
> + ``debug`` debug level for spicevmc
> +
> + ``name`` name of spice port to connect to
> +
> + Connect to a spice port, allowing a Spice client to handle the
> + traffic identified by a name (preferably a fqdn).
> +ERST
>
> STEXI
> @end table
> @@ -3298,6 +5848,69 @@ To create a TPM emulator backend device with chardev socket backend:
> @end example
>
> ETEXI
> +SRST
> +The general form of a TPM device option is:
> +
> +``-tpmdev backend,id=id[,options]``
> + The specific backend type will determine the applicable options. The
> + ``-tpmdev`` option creates the TPM backend and requires a
> + ``-device`` option that specifies the TPM frontend interface model.
> +
> + Use ``-tpmdev help`` to print all available TPM backend types.
> +
> +The available backends are:
> +
> +``-tpmdev passthrough,id=id,path=path,cancel-path=cancel-path``
> + (Linux-host only) Enable access to the host's TPM using the
> + passthrough driver.
> +
> + ``path`` specifies the path to the host's TPM device, i.e., on a
> + Linux host this would be ``/dev/tpm0``. ``path`` is optional and by
> + default ``/dev/tpm0`` is used.
> +
> + ``cancel-path`` specifies the path to the host TPM device's sysfs
> + entry allowing for cancellation of an ongoing TPM command.
> + ``cancel-path`` is optional and by default QEMU will search for the
> + sysfs entry to use.
> +
> + Some notes about using the host's TPM with the passthrough driver:
> +
> + The TPM device accessed by the passthrough driver must not be used
> + by any other application on the host.
> +
> + Since the host's firmware (BIOS/UEFI) has already initialized the
> + TPM, the VM's firmware (BIOS/UEFI) will not be able to initialize
> + the TPM again and may therefore not show a TPM-specific menu that
> + would otherwise allow the user to configure the TPM, e.g., allow the
> + user to enable/disable or activate/deactivate the TPM. Further, if
> + TPM ownership is released from within a VM then the host's TPM will
> + get disabled and deactivated. To enable and activate the TPM again
> + afterwards, the host has to be rebooted and the user is required to
> + enter the firmware's menu to enable and activate the TPM. If the TPM
> + is left disabled and/or deactivated most TPM commands will fail.
> +
> + To create a passthrough TPM use the following two options:
> +
> + ::
> +
> + -tpmdev passthrough,id=tpm0 -device tpm-tis,tpmdev=tpm0
> +
> + Note that the ``-tpmdev`` id is ``tpm0`` and is referenced by
> + ``tpmdev=tpm0`` in the device option.
> +
> +``-tpmdev emulator,id=id,chardev=dev``
> + (Linux-host only) Enable access to a TPM emulator using Unix domain
> + socket based chardev backend.
> +
> + ``chardev`` specifies the unique ID of a character device backend
> + that provides connection to the software TPM server.
> +
> + To create a TPM emulator backend device with chardev socket backend:
> +
> + ::
> +
> + -chardev socket,id=chrtpm,path=/tmp/swtpm-sock -tpmdev emulator,id=tpm0,chardev=chrtpm -device tpm-tis,tpmdev=tpm0
> +ERST
>
> STEXI
> @end table
> @@ -3315,6 +5928,13 @@ for easier testing of various kernels.
>
> @table @option
> ETEXI
> +SRST
> +When using these options, you can use a given Linux or Multiboot kernel
> +without installing it in the disk image. It can be useful for easier
> +testing of various kernels.
> +
> +
> +ERST
>
> DEF("kernel", HAS_ARG, QEMU_OPTION_kernel, \
> "-kernel bzImage use 'bzImage' as kernel image\n", QEMU_ARCH_ALL)
> @@ -3324,6 +5944,11 @@ STEXI
> Use @var{bzImage} as kernel image. The kernel can be either a Linux kernel
> or in multiboot format.
> ETEXI
> +SRST
> +``-kernel bzImage``
> + Use bzImage as kernel image. The kernel can be either a Linux kernel
> + or in multiboot format.
> +ERST
>
> DEF("append", HAS_ARG, QEMU_OPTION_append, \
> "-append cmdline use 'cmdline' as kernel command line\n", QEMU_ARCH_ALL)
> @@ -3332,6 +5957,10 @@ STEXI
> @findex -append
> Use @var{cmdline} as kernel command line
> ETEXI
> +SRST
> +``-append cmdline``
> + Use cmdline as kernel command line
> +ERST
>
> DEF("initrd", HAS_ARG, QEMU_OPTION_initrd, \
> "-initrd file use 'file' as initial ram disk\n", QEMU_ARCH_ALL)
> @@ -3347,6 +5976,16 @@ This syntax is only available with multiboot.
> Use @var{file1} and @var{file2} as modules and pass arg=foo as parameter to the
> first module.
> ETEXI
> +SRST
> +``-initrd file``
> + Use file as initial ram disk.
> +
> +``-initrd "file1 arg=foo,file2"``
> + This syntax is only available with multiboot.
> +
> + Use file1 and file2 as modules and pass arg=foo as parameter to the
> + first module.
> +ERST
>
> DEF("dtb", HAS_ARG, QEMU_OPTION_dtb, \
> "-dtb file use 'file' as device tree image\n", QEMU_ARCH_ALL)
> @@ -3356,6 +5995,11 @@ STEXI
> Use @var{file} as a device tree binary (dtb) image and pass it to the kernel
> on boot.
> ETEXI
> +SRST
> +``-dtb file``
> + Use file as a device tree binary (dtb) image and pass it to the
> + kernel on boot.
> +ERST
>
> STEXI
> @end table
> @@ -3396,6 +6040,28 @@ creates an fw_cfg entry named opt/com.mycompany/blob with contents
> from ./my_blob.bin.
>
> ETEXI
> +SRST
> +``-fw_cfg [name=]name,file=file``
> + Add named fw\_cfg entry with contents from file file.
> +
> +``-fw_cfg [name=]name,string=str``
> + Add named fw\_cfg entry with contents from string str.
> +
> + The terminating NUL character of the contents of str will not be
> + included as part of the fw\_cfg item data. To insert contents with
> + embedded NUL characters, you have to use the file parameter.
> +
> + The fw\_cfg entries are passed by QEMU through to the guest.
> +
> + Example:
> +
> + ::
> +
> + -fw_cfg name=opt/com.mycompany/blob,file=./my_blob.bin
> +
> + creates an fw\_cfg entry named opt/com.mycompany/blob with contents
> + from ./my\_blob.bin.
> +ERST
>
> DEF("serial", HAS_ARG, QEMU_OPTION_serial, \
> "-serial dev redirect the serial port to char device 'dev'\n",
> @@ -3534,6 +6200,161 @@ or fake device.
> Three button serial mouse. Configure the guest to use Microsoft protocol.
> @end table
> ETEXI
> +SRST
> +``-serial dev``
> + Redirect the virtual serial port to host character device dev. The
> + default device is ``vc`` in graphical mode and ``stdio`` in non
> + graphical mode.
> +
> + This option can be used several times to simulate up to 4 serial
> + ports.
> +
> + Use ``-serial none`` to disable all serial ports.
> +
> + Available character devices are:
> +
> + ``vc[:WxH]``
> + Virtual console. Optionally, a width and height can be given in
> + pixel with
> +
> + ::
> +
> + vc:800x600
> +
> + It is also possible to specify width or height in characters:
> +
> + ::
> +
> + vc:80Cx24C
> +
> + ``pty``
> + [Linux only] Pseudo TTY (a new PTY is automatically allocated)
> +
> + ``none``
> + No device is allocated.
> +
> + ``null``
> + void device
> +
> + ``chardev:id``
> + Use a named character device defined with the ``-chardev``
> + option.
> +
> + ``/dev/XXX``
> + [Linux only] Use host tty, e.g. ``/dev/ttyS0``. The host serial
> + port parameters are set according to the emulated ones.
> +
> + ``/dev/parportN``
> + [Linux only, parallel port only] Use host parallel port N.
> + Currently SPP and EPP parallel port features can be used.
> +
> + ``file:filename``
> + Write output to filename. No character can be read.
> +
> + ``stdio``
> + [Unix only] standard input/output
> +
> + ``pipe:filename``
> + name pipe filename
> +
> + ``COMn``
> + [Windows only] Use host serial port n
> +
> + ``udp:[remote_host]:remote_port[@[src_ip]:src_port]``
> + This implements UDP Net Console. When remote\_host or src\_ip
> + are not specified they default to ``0.0.0.0``. When not using a
> + specified src\_port a random port is automatically chosen.
> +
> + If you just want a simple readonly console you can use
> + ``netcat`` or ``nc``, by starting QEMU with:
> + ``-serial udp::4555`` and nc as: ``nc -u -l -p 4555``. Any time
> + QEMU writes something to that port it will appear in the
> + netconsole session.
> +
> + If you plan to send characters back via netconsole or you want
> + to stop and start QEMU a lot of times, you should have QEMU use
> + the same source port each time by using something like ``-serial
> + udp::4555@:4556`` to QEMU. Another approach is to use a patched
> + version of netcat which can listen to a TCP port and send and
> + receive characters via udp. If you have a patched version of
> + netcat which activates telnet remote echo and single char
> + transfer, then you can use the following options to set up a
> + netcat redirector to allow telnet on port 5555 to access the
> + QEMU port.
> +
> + ``QEMU Options:``
> + -serial udp::4555@:4556
> +
> + ``netcat options:``
> + -u -P 4555 -L 0.0.0.0:4556 -t -p 5555 -I -T
> +
> + ``telnet options:``
> + localhost 5555
> +
> + ``tcp:[host]:port[,server][,nowait][,nodelay][,reconnect=seconds]``
> + The TCP Net Console has two modes of operation. It can send the
> + serial I/O to a location or wait for a connection from a
> + location. By default the TCP Net Console is sent to host at the
> + port. If you use the server option QEMU will wait for a client
> + socket application to connect to the port before continuing,
> + unless the ``nowait`` option was specified. The ``nodelay``
> + option disables the Nagle buffering algorithm. The ``reconnect``
> + option only applies if noserver is set, if the connection goes
> + down it will attempt to reconnect at the given interval. If host
> + is omitted, 0.0.0.0 is assumed. Only one TCP connection at a
> + time is accepted. You can use ``telnet`` to connect to the
> + corresponding character device.
> +
> + ``Example to send tcp console to 192.168.0.2 port 4444``
> + -serial tcp:192.168.0.2:4444
> +
> + ``Example to listen and wait on port 4444 for connection``
> + -serial tcp::4444,server
> +
> + ``Example to not wait and listen on ip 192.168.0.100 port 4444``
> + -serial tcp:192.168.0.100:4444,server,nowait
> +
> + ``telnet:host:port[,server][,nowait][,nodelay]``
> + The telnet protocol is used instead of raw tcp sockets. The
> + options work the same as if you had specified ``-serial tcp``.
> + The difference is that the port acts like a telnet server or
> + client using telnet option negotiation. This will also allow you
> + to send the MAGIC\_SYSRQ sequence if you use a telnet that
> + supports sending the break sequence. Typically in unix telnet
> + you do it with Control-] and then type "send break" followed by
> + pressing the enter key.
> +
> + ``websocket:host:port,server[,nowait][,nodelay]``
> + The WebSocket protocol is used instead of raw tcp socket. The
> + port acts as a WebSocket server. Client mode is not supported.
> +
> + ``unix:path[,server][,nowait][,reconnect=seconds]``
> + A unix domain socket is used instead of a tcp socket. The option
> + works the same as if you had specified ``-serial tcp`` except
> + the unix domain socket path is used for connections.
> +
> + ``mon:dev_string``
> + This is a special option to allow the monitor to be multiplexed
> + onto another serial port. The monitor is accessed with key
> + sequence of Control-a and then pressing c. dev\_string should be
> + any one of the serial devices specified above. An example to
> + multiplex the monitor onto a telnet server listening on port
> + 4444 would be:
> +
> + ``-serial mon:telnet::4444,server,nowait``
> +
> + When the monitor is multiplexed to stdio in this way, Ctrl+C
> + will not terminate QEMU any more but will be passed to the guest
> + instead.
> +
> + ``braille``
> + Braille device. This will use BrlAPI to display the braille
> + output on a real or fake device.
> +
> + ``msmouse``
> + Three button serial mouse. Configure the guest to use Microsoft
> + protocol.
> +ERST
>
> DEF("parallel", HAS_ARG, QEMU_OPTION_parallel, \
> "-parallel dev redirect the parallel port to char device 'dev'\n",
> @@ -3551,6 +6372,18 @@ ports.
>
> Use @code{-parallel none} to disable all parallel ports.
> ETEXI
> +SRST
> +``-parallel dev``
> + Redirect the virtual parallel port to host device dev (same devices
> + as the serial port). On Linux hosts, ``/dev/parportN`` can be used
> + to use hardware devices connected on the corresponding host parallel
> + port.
> +
> + This option can be used several times to simulate up to 3 parallel
> + ports.
> +
> + Use ``-parallel none`` to disable all parallel ports.
> +ERST
>
> DEF("monitor", HAS_ARG, QEMU_OPTION_monitor, \
> "-monitor dev redirect the monitor to char device 'dev'\n",
> @@ -3564,6 +6397,13 @@ The default device is @code{vc} in graphical mode and @code{stdio} in
> non graphical mode.
> Use @code{-monitor none} to disable the default monitor.
> ETEXI
> +SRST
> +``-monitor dev``
> + Redirect the monitor to host device dev (same devices as the serial
> + port). The default device is ``vc`` in graphical mode and ``stdio``
> + in non graphical mode. Use ``-monitor none`` to disable the default
> + monitor.
> +ERST
> DEF("qmp", HAS_ARG, QEMU_OPTION_qmp, \
> "-qmp dev like -monitor but opens in 'control' mode\n",
> QEMU_ARCH_ALL)
> @@ -3572,6 +6412,10 @@ STEXI
> @findex -qmp
> Like -monitor but opens in 'control' mode.
> ETEXI
> +SRST
> +``-qmp dev``
> + Like -monitor but opens in 'control' mode.
> +ERST
> DEF("qmp-pretty", HAS_ARG, QEMU_OPTION_qmp_pretty, \
> "-qmp-pretty dev like -qmp but uses pretty JSON formatting\n",
> QEMU_ARCH_ALL)
> @@ -3580,6 +6424,10 @@ STEXI
> @findex -qmp-pretty
> Like -qmp but uses pretty JSON formatting.
> ETEXI
> +SRST
> +``-qmp-pretty dev``
> + Like -qmp but uses pretty JSON formatting.
> +ERST
>
> DEF("mon", HAS_ARG, QEMU_OPTION_mon, \
> "-mon [chardev=]name[,mode=readline|control][,pretty[=on|off]]\n", QEMU_ARCH_ALL)
> @@ -3589,6 +6437,11 @@ STEXI
> Setup monitor on chardev @var{name}. @code{pretty} turns on JSON pretty printing
> easing human reading and debugging.
> ETEXI
> +SRST
> +``-mon [chardev=]name[,mode=readline|control][,pretty[=on|off]]``
> + Setup monitor on chardev name. ``pretty`` turns on JSON pretty
> + printing easing human reading and debugging.
> +ERST
>
> DEF("debugcon", HAS_ARG, QEMU_OPTION_debugcon, \
> "-debugcon dev redirect the debug console to char device 'dev'\n",
> @@ -3602,6 +6455,14 @@ serial port). The debug console is an I/O port which is typically port
> The default device is @code{vc} in graphical mode and @code{stdio} in
> non graphical mode.
> ETEXI
> +SRST
> +``-debugcon dev``
> + Redirect the debug console to host device dev (same devices as the
> + serial port). The debug console is an I/O port which is typically
> + port 0xe9; writing to that I/O port sends output to this device. The
> + default device is ``vc`` in graphical mode and ``stdio`` in non
> + graphical mode.
> +ERST
>
> DEF("pidfile", HAS_ARG, QEMU_OPTION_pidfile, \
> "-pidfile file write PID to 'file'\n", QEMU_ARCH_ALL)
> @@ -3611,6 +6472,11 @@ STEXI
> Store the QEMU process PID in @var{file}. It is useful if you launch QEMU
> from a script.
> ETEXI
> +SRST
> +``-pidfile file``
> + Store the QEMU process PID in file. It is useful if you launch QEMU
> + from a script.
> +ERST
>
> DEF("singlestep", 0, QEMU_OPTION_singlestep, \
> "-singlestep always run in singlestep mode\n", QEMU_ARCH_ALL)
> @@ -3619,6 +6485,10 @@ STEXI
> @findex -singlestep
> Run the emulation in single step mode.
> ETEXI
> +SRST
> +``-singlestep``
> + Run the emulation in single step mode.
> +ERST
>
> DEF("preconfig", 0, QEMU_OPTION_preconfig, \
> "--preconfig pause QEMU before machine is initialized (experimental)\n",
> @@ -3633,6 +6503,15 @@ the preconfig state and move to the next state (i.e. run guest if -S
> isn't used or pause the second time if -S is used). This option is
> experimental.
> ETEXI
> +SRST
> +``--preconfig``
> + Pause QEMU for interactive configuration before the machine is
> + created, which allows querying and configuring properties that will
> + affect machine initialization. Use QMP command 'x-exit-preconfig' to
> + exit the preconfig state and move to the next state (i.e. run guest
> + if -S isn't used or pause the second time if -S is used). This
> + option is experimental.
> +ERST
>
> DEF("S", 0, QEMU_OPTION_S, \
> "-S freeze CPU at startup (use 'c' to start execution)\n",
> @@ -3642,6 +6521,10 @@ STEXI
> @findex -S
> Do not start CPU at startup (you must type 'c' in the monitor).
> ETEXI
> +SRST
> +``-S``
> + Do not start CPU at startup (you must type 'c' in the monitor).
> +ERST
>
> DEF("realtime", HAS_ARG, QEMU_OPTION_realtime,
> "-realtime [mlock=on|off]\n"
> @@ -3655,6 +6538,11 @@ Run qemu with realtime features.
> mlocking qemu and guest memory can be enabled via @option{mlock=on}
> (enabled by default).
> ETEXI
> +SRST
> +``-realtime mlock=on|off``
> + Run qemu with realtime features. mlocking qemu and guest memory can
> + be enabled via ``mlock=on`` (enabled by default).
> +ERST
>
> DEF("overcommit", HAS_ARG, QEMU_OPTION_overcommit,
> "-overcommit [mem-lock=on|off][cpu-pm=on|off]\n"
> @@ -3679,6 +6567,24 @@ enabled via @option{cpu-pm=on} (disabled by default). This works best when
> host CPU is not overcommitted. When used, host estimates of CPU cycle and power
> 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.
> +
> + Locking qemu and guest memory can be enabled via ``mem-lock=on``
> + (disabled by default). This works when host memory is not
> + overcommitted and reduces the worst-case latency for guest. This is
> + equivalent to ``realtime``.
> +
> + Guest ability to manage power state of host cpus (increasing latency
> + for other processes on the same host cpu, but decreasing latency for
> + guest) can be enabled via ``cpu-pm=on`` (disabled by default). This
> + works best when host CPU is not overcommitted. When used, host
> + estimates of CPU cycle and power utilization will be incorrect, not
> + taking into account guest idle time.
> +ERST
>
> DEF("gdb", HAS_ARG, QEMU_OPTION_gdb, \
> "-gdb dev wait for gdb connection on 'dev'\n", QEMU_ARCH_ALL)
> @@ -3693,6 +6599,18 @@ within gdb and establish the connection via a pipe:
> (gdb) target remote | exec @value{qemu_system} -gdb stdio ...
> @end example
> ETEXI
> +SRST
> +``-gdb dev``
> + Wait for gdb connection on device dev (see
> + :ref:`gdb_005fusage`). Typical connections will likely be
> + TCP-based, but also UDP, pseudo TTY, or even stdio are reasonable
> + use case. The latter is allowing to start QEMU from within gdb and
> + establish the connection via a pipe:
> +
> + ::
> +
> + (gdb) target remote | exec |qemu_system| -gdb stdio ...
> +ERST
>
> DEF("s", 0, QEMU_OPTION_s, \
> "-s shorthand for -gdb tcp::" DEFAULT_GDBSTUB_PORT "\n",
> @@ -3703,6 +6621,11 @@ STEXI
> Shorthand for -gdb tcp::1234, i.e. open a gdbserver on TCP port 1234
> (@pxref{gdb_usage}).
> ETEXI
> +SRST
> +``-s``
> + Shorthand for -gdb tcp::1234, i.e. open a gdbserver on TCP port 1234
> + (see :ref:`gdb_005fusage`).
> +ERST
>
> DEF("d", HAS_ARG, QEMU_OPTION_d, \
> "-d item1,... enable logging of specified items (use '-d help' for a list of log items)\n",
> @@ -3712,6 +6635,11 @@ STEXI
> @findex -d
> Enable logging of specified items. Use '-d help' for a list of log items.
> ETEXI
> +SRST
> +``-d item1[,...]``
> + Enable logging of specified items. Use '-d help' for a list of log
> + items.
> +ERST
>
> DEF("D", HAS_ARG, QEMU_OPTION_D, \
> "-D logfile output log to logfile (default stderr)\n",
> @@ -3721,6 +6649,10 @@ STEXI
> @findex -D
> Output log in @var{logfile} instead of to stderr
> ETEXI
> +SRST
> +``-D logfile``
> + Output log in logfile instead of to stderr
> +ERST
>
> DEF("dfilter", HAS_ARG, QEMU_OPTION_DFILTER, \
> "-dfilter range,.. filter debug output to range of addresses (useful for -d cpu,exec,etc..)\n",
> @@ -3739,6 +6671,21 @@ Will dump output for any code in the 0x1000 sized block starting at 0x8000 and
> the 0x200 sized block starting at 0xffffffc000080000 and another 0x1000 sized
> block starting at 0xffffffc00005f000.
> ETEXI
> +SRST
> +``-dfilter range1[,...]``
> + Filter debug output to that relevant to a range of target addresses.
> + The filter spec can be either start+size, start-size or start..end
> + where start end and size are the addresses and sizes required. For
> + example:
> +
> + ::
> +
> + -dfilter 0x8000..0x8fff,0xffffffc000080000+0x200,0xffffffc000060000-0x1000
> +
> + Will dump output for any code in the 0x1000 sized block starting at
> + 0x8000 and the 0x200 sized block starting at 0xffffffc000080000 and
> + another 0x1000 sized block starting at 0xffffffc00005f000.
> +ERST
>
> DEF("seed", HAS_ARG, QEMU_OPTION_seed, \
> "-seed number seed the pseudo-random number generator\n",
> @@ -3749,6 +6696,12 @@ STEXI
> Force the guest to use a deterministic pseudo-random number generator, seeded
> with @var{number}. This does not affect crypto routines within the host.
> ETEXI
> +SRST
> +``-seed number``
> + Force the guest to use a deterministic pseudo-random number
> + generator, seeded with number. This does not affect crypto routines
> + within the host.
> +ERST
>
> DEF("L", HAS_ARG, QEMU_OPTION_L, \
> "-L path set the directory for the BIOS, VGA BIOS and keymaps\n",
> @@ -3760,6 +6713,12 @@ Set the directory for the BIOS, VGA BIOS and keymaps.
>
> To list all the data directories, use @code{-L help}.
> ETEXI
> +SRST
> +``-L path``
> + Set the directory for the BIOS, VGA BIOS and keymaps.
> +
> + To list all the data directories, use ``-L help``.
> +ERST
>
> DEF("bios", HAS_ARG, QEMU_OPTION_bios, \
> "-bios file set the filename for the BIOS\n", QEMU_ARCH_ALL)
> @@ -3768,6 +6727,10 @@ STEXI
> @findex -bios
> Set the filename for the BIOS.
> ETEXI
> +SRST
> +``-bios file``
> + Set the filename for the BIOS.
> +ERST
>
> DEF("enable-kvm", 0, QEMU_OPTION_enable_kvm, \
> "-enable-kvm enable KVM full virtualization support\n", QEMU_ARCH_ALL)
> @@ -3777,6 +6740,11 @@ STEXI
> Enable KVM full virtualization support. This option is only available
> if KVM support is enabled when compiling.
> ETEXI
> +SRST
> +``-enable-kvm``
> + Enable KVM full virtualization support. This option is only
> + available if KVM support is enabled when compiling.
> +ERST
>
> DEF("xen-domid", HAS_ARG, QEMU_OPTION_xen_domid,
> "-xen-domid id specify xen guest domain id\n", QEMU_ARCH_ALL)
> @@ -3800,6 +6768,15 @@ libxl will use this when starting QEMU (XEN only).
> @findex -xen-domid-restrict
> Restrict set of available xen operations to specified domain id (XEN only).
> ETEXI
> +SRST
> +``-xen-domid id``
> + Specify xen guest domain id (XEN only).
> +
> +``-xen-attach``
> + Attach to existing xen domain. libxl will use this when starting
> + QEMU (XEN only). Restrict set of available xen operations to
> + specified domain id (XEN only).
> +ERST
>
> DEF("no-reboot", 0, QEMU_OPTION_no_reboot, \
> "-no-reboot exit instead of rebooting\n", QEMU_ARCH_ALL)
> @@ -3808,6 +6785,10 @@ STEXI
> @findex -no-reboot
> Exit instead of rebooting.
> ETEXI
> +SRST
> +``-no-reboot``
> + Exit instead of rebooting.
> +ERST
>
> DEF("no-shutdown", 0, QEMU_OPTION_no_shutdown, \
> "-no-shutdown stop before shutdown\n", QEMU_ARCH_ALL)
> @@ -3818,6 +6799,12 @@ Don't exit QEMU on guest shutdown, but instead only stop the emulation.
> This allows for instance switching to monitor to commit changes to the
> disk image.
> ETEXI
> +SRST
> +``-no-shutdown``
> + Don't exit QEMU on guest shutdown, but instead only stop the
> + emulation. This allows for instance switching to monitor to commit
> + changes to the disk image.
> +ERST
>
> DEF("loadvm", HAS_ARG, QEMU_OPTION_loadvm, \
> "-loadvm [tag|id]\n" \
> @@ -3828,6 +6815,10 @@ STEXI
> @findex -loadvm
> Start right away with a saved state (@code{loadvm} in monitor)
> ETEXI
> +SRST
> +``-loadvm file``
> + Start right away with a saved state (``loadvm`` in monitor)
> +ERST
>
> #ifndef _WIN32
> DEF("daemonize", 0, QEMU_OPTION_daemonize, \
> @@ -3841,6 +6832,14 @@ standard IO until it is ready to receive connections on any of its devices.
> This option is a useful way for external programs to launch QEMU without having
> to cope with initialization race conditions.
> ETEXI
> +SRST
> +``-daemonize``
> + Daemonize the QEMU process after initialization. QEMU will not
> + detach from standard IO until it is ready to receive connections on
> + any of its devices. This option is a useful way for external
> + programs to launch QEMU without having to cope with initialization
> + race conditions.
> +ERST
>
> DEF("option-rom", HAS_ARG, QEMU_OPTION_option_rom, \
> "-option-rom rom load a file, rom, into the option ROM space\n",
> @@ -3851,6 +6850,11 @@ STEXI
> Load the contents of @var{file} as an option ROM.
> This option is useful to load things like EtherBoot.
> ETEXI
> +SRST
> +``-option-rom file``
> + Load the contents of file as an option ROM. This option is useful to
> + load things like EtherBoot.
> +ERST
>
> DEF("rtc", HAS_ARG, QEMU_OPTION_rtc, \
> "-rtc [base=utc|localtime|<datetime>][,clock=host|rt|vm][,driftfix=none|slew]\n" \
> @@ -3882,6 +6886,32 @@ specifically with Windows' ACPI HAL. This option will try to figure out how
> many timer interrupts were not processed by the Windows guest and will
> re-inject them.
> ETEXI
> +SRST
> +``-rtc [base=utc|localtime|datetime][,clock=host|rt|vm][,driftfix=none|slew]``
> + Specify ``base`` as ``utc`` or ``localtime`` to let the RTC start at
> + the current UTC or local time, respectively. ``localtime`` is
> + required for correct date in MS-DOS or Windows. To start at a
> + specific point in time, provide datetime in the format
> + ``2006-06-17T16:01:21`` or ``2006-06-17``. The default base is UTC.
> +
> + By default the RTC is driven by the host system time. This allows
> + using of the RTC as accurate reference clock inside the guest,
> + specifically if the host time is smoothly following an accurate
> + external reference clock, e.g. via NTP. If you want to isolate the
> + guest time from the host, you can set ``clock`` to ``rt`` instead,
> + which provides a host monotonic clock if host support it. To even
> + prevent the RTC from progressing during suspension, you can set
> + ``clock`` to ``vm`` (virtual clock). '\ ``clock=vm``\ ' is
> + recommended especially in icount mode in order to preserve
> + determinism; however, note that in icount mode the speed of the
> + virtual clock is variable and can in general differ from the host
> + clock.
> +
> + Enable ``driftfix`` (i386 targets only) if you experience time drift
> + problems, specifically with Windows' ACPI HAL. This option will try
> + to figure out how many timer interrupts were not processed by the
> + Windows guest and will re-inject them.
> +ERST
>
> DEF("icount", HAS_ARG, QEMU_OPTION_icount, \
> "-icount [shift=N|auto][,align=on|off][,sleep=on|off,rr=record|replay,rrfile=<filename>,rrsnapshot=<snapshot>]\n" \
> @@ -3927,6 +6957,45 @@ Option rrsnapshot is used to create new vm snapshot named @var{snapshot}
> at the start of execution recording. In replay mode this option is used
> to load the initial VM state.
> ETEXI
> +SRST
> +``-icount [shift=N|auto][,rr=record|replay,rrfile=filename,rrsnapshot=snapshot]``
> + Enable virtual instruction counter. The virtual cpu will execute one
> + instruction every 2^N ns of virtual time. If ``auto`` is specified
> + then the virtual cpu speed will be automatically adjusted to keep
> + virtual time within a few seconds of real time.
> +
> + When the virtual cpu is sleeping, the virtual time will advance at
> + default speed unless ``sleep=on|off`` is specified. With
> + ``sleep=on|off``, the virtual time will jump to the next timer
> + deadline instantly whenever the virtual cpu goes to sleep mode and
> + will not advance if no timer is enabled. This behavior give
> + deterministic execution times from the guest point of view.
> +
> + Note that while this option can give deterministic behavior, it does
> + not provide cycle accurate emulation. Modern CPUs contain
> + superscalar out of order cores with complex cache hierarchies. The
> + number of instructions executed often has little or no correlation
> + with actual performance.
> +
> + ``align=on`` will activate the delay algorithm which will try to
> + synchronise the host clock and the virtual clock. The goal is to
> + have a guest running at the real frequency imposed by the shift
> + option. Whenever the guest clock is behind the host clock and if
> + ``align=on`` is specified then we print a message to the user to
> + inform about the delay. Currently this option does not work when
> + ``shift`` is ``auto``. Note: The sync algorithm will work for those
> + shift values for which the guest clock runs ahead of the host clock.
> + Typically this happens when the shift value is high (how high
> + depends on the host machine).
> +
> + When ``rr`` option is specified deterministic record/replay is
> + enabled. Replay log is written into filename file in record mode and
> + read from this file in replay mode.
> +
> + Option rrsnapshot is used to create new vm snapshot named snapshot
> + at the start of execution recording. In replay mode this option is
> + used to load the initial VM state.
> +ERST
>
> DEF("watchdog", HAS_ARG, QEMU_OPTION_watchdog, \
> "-watchdog model\n" \
> @@ -3956,6 +7025,30 @@ A virtual watchdog for s390x backed by the diagnose 288 hypercall
> (currently KVM only).
> @end table
> ETEXI
> +SRST
> +``-watchdog model``
> + Create a virtual hardware watchdog device. Once enabled (by a guest
> + action), the watchdog must be periodically polled by an agent inside
> + the guest or else the guest will be restarted. Choose a model for
> + which your guest has drivers.
> +
> + The model is the model of hardware watchdog to emulate. Use
> + ``-watchdog help`` to list available hardware models. Only one
> + watchdog can be enabled for a guest.
> +
> + The following models may be available:
> +
> + ``ib700``
> + iBASE 700 is a very simple ISA watchdog with a single timer.
> +
> + ``i6300esb``
> + Intel 6300ESB I/O controller hub is a much more featureful
> + PCI-based dual-timer watchdog.
> +
> + ``diag288``
> + A virtual watchdog for s390x backed by the diagnose 288
> + hypercall (currently KVM only).
> +ERST
>
> DEF("watchdog-action", HAS_ARG, QEMU_OPTION_watchdog_action, \
> "-watchdog-action reset|shutdown|poweroff|inject-nmi|pause|debug|none\n" \
> @@ -3989,6 +7082,26 @@ Examples:
> @itemx -watchdog ib700
> @end table
> ETEXI
> +SRST
> +``-watchdog-action action``
> + The action controls what QEMU will do when the watchdog timer
> + expires. The default is ``reset`` (forcefully reset the guest).
> + Other possible actions are: ``shutdown`` (attempt to gracefully
> + shutdown the guest), ``poweroff`` (forcefully poweroff the guest),
> + ``inject-nmi`` (inject a NMI into the guest), ``pause`` (pause the
> + guest), ``debug`` (print a debug message and continue), or ``none``
> + (do nothing).
> +
> + Note that the ``shutdown`` action requires that the guest responds
> + to ACPI signals, which it may not be able to do in the sort of
> + situations where the watchdog would have expired, and thus
> + ``-watchdog-action shutdown`` is not recommended for production use.
> +
> + Examples:
> +
> + ``-watchdog i6300esb -watchdog-action pause``; \ ``-watchdog ib700``
> +
> +ERST
>
> DEF("echr", HAS_ARG, QEMU_OPTION_echr, \
> "-echr chr set terminal escape character instead of ctrl-a\n",
> @@ -4009,6 +7122,19 @@ character to Control-t.
> @itemx -echr 20
> @end table
> ETEXI
> +SRST
> +``-echr numeric_ascii_value``
> + Change the escape character used for switching to the monitor when
> + using monitor and serial sharing. The default is ``0x01`` when using
> + the ``-nographic`` option. ``0x01`` is equal to pressing
> + ``Control-a``. You can select a different character from the ascii
> + control keys where 1 through 26 map to Control-a through Control-z.
> + For instance you could use the either of the following to change the
> + escape character to Control-t.
> +
> + ``-echr 0x14``; \ ``-echr 20``
> +
> +ERST
>
> DEF("show-cursor", 0, QEMU_OPTION_show_cursor, \
> "-show-cursor show cursor\n", QEMU_ARCH_ALL)
> @@ -4017,6 +7143,10 @@ STEXI
> @findex -show-cursor
> Show cursor.
> ETEXI
> +SRST
> +``-show-cursor``
> + Show cursor.
> +ERST
>
> DEF("tb-size", HAS_ARG, QEMU_OPTION_tb_size, \
> "-tb-size n set TB size\n", QEMU_ARCH_ALL)
> @@ -4026,6 +7156,11 @@ STEXI
> Set TCG translation block cache size. Deprecated, use @samp{-accel tcg,tb-size=@var{n}}
> instead.
> ETEXI
> +SRST
> +``-tb-size n``
> + Set TCG translation block cache size. Deprecated, use
> + '\ ``-accel tcg,tb-size=n``\ ' instead.
> +ERST
>
> DEF("incoming", HAS_ARG, QEMU_OPTION_incoming, \
> "-incoming tcp:[host]:port[,to=maxport][,ipv4][,ipv6]\n" \
> @@ -4060,6 +7195,25 @@ Wait for the URI to be specified via migrate_incoming. The monitor can
> 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]``
> + Prepare for incoming migration, listen on a given tcp port.
> +
> +``-incoming unix:socketpath``
> + Prepare for incoming migration, listen on a given unix socket.
> +
> +``-incoming fd:fd``
> + Accept incoming migration from a given filedescriptor.
> +
> +``-incoming exec:cmdline``
> + Accept incoming migration as an output from specified external
> + command.
> +
> +``-incoming defer``
> + Wait for the URI to be specified via migrate\_incoming. The monitor
> + can be used to change settings (such as migration parameters) prior
> + to issuing the migrate\_incoming to allow the migration to begin.
> +ERST
>
> DEF("only-migratable", 0, QEMU_OPTION_only_migratable, \
> "-only-migratable allow only migratable devices\n", QEMU_ARCH_ALL)
> @@ -4069,6 +7223,11 @@ STEXI
> Only allow migratable devices. Devices will not be allowed to enter an
> unmigratable state.
> ETEXI
> +SRST
> +``-only-migratable``
> + Only allow migratable devices. Devices will not be allowed to enter
> + an unmigratable state.
> +ERST
>
> DEF("nodefaults", 0, QEMU_OPTION_nodefaults, \
> "-nodefaults don't create default devices\n", QEMU_ARCH_ALL)
> @@ -4080,6 +7239,13 @@ port, parallel port, virtual console, monitor device, VGA adapter, floppy and
> CD-ROM drive and others. The @code{-nodefaults} option will disable all those
> default devices.
> ETEXI
> +SRST
> +``-nodefaults``
> + Don't create default devices. Normally, QEMU sets the default
> + devices like serial port, parallel port, virtual console, monitor
> + device, VGA adapter, floppy and CD-ROM drive and others. The
> + ``-nodefaults`` option will disable all those default devices.
> +ERST
>
> #ifndef _WIN32
> DEF("chroot", HAS_ARG, QEMU_OPTION_chroot, \
> @@ -4092,6 +7258,11 @@ STEXI
> Immediately before starting guest execution, chroot to the specified
> directory. Especially useful in combination with -runas.
> ETEXI
> +SRST
> +``-chroot dir``
> + Immediately before starting guest execution, chroot to the specified
> + directory. Especially useful in combination with -runas.
> +ERST
>
> #ifndef _WIN32
> DEF("runas", HAS_ARG, QEMU_OPTION_runas, \
> @@ -4105,6 +7276,11 @@ STEXI
> Immediately before starting guest execution, drop root privileges, switching
> to the specified user.
> ETEXI
> +SRST
> +``-runas user``
> + Immediately before starting guest execution, drop root privileges,
> + switching to the specified user.
> +ERST
>
> DEF("prom-env", HAS_ARG, QEMU_OPTION_prom_env,
> "-prom-env variable=value\n"
> @@ -4127,6 +7303,21 @@ qemu-system-ppc -prom-env 'auto-boot?=false' \
> @end example
>
> ETEXI
> +SRST
> +``-prom-env variable=value``
> + Set OpenBIOS nvram variable to given value (PPC, SPARC only).
> +
> + ::
> +
> + qemu-system-sparc -prom-env 'auto-boot?=false' \
> + -prom-env 'boot-device=sd(0,2,0):d' -prom-env 'boot-args=linux single'
> +
> + ::
> +
> + qemu-system-ppc -prom-env 'auto-boot?=false' \
> + -prom-env 'boot-device=hd:2,\yaboot' \
> + -prom-env 'boot-args=conf=hd:2,\yaboot.conf'
> +ERST
> DEF("semihosting", 0, QEMU_OPTION_semihosting,
> "-semihosting semihosting mode\n",
> QEMU_ARCH_ARM | QEMU_ARCH_M68K | QEMU_ARCH_XTENSA | QEMU_ARCH_LM32 |
> @@ -4142,6 +7333,16 @@ should only be used with a trusted guest OS.
> See the -semihosting-config option documentation for further information
> about the facilities this enables.
> ETEXI
> +SRST
> +``-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.
> +ERST
> DEF("semihosting-config", HAS_ARG, QEMU_OPTION_semihosting_config,
> "-semihosting-config [enable=on|off][,target=native|gdb|auto][,chardev=id][,arg=str[,...]]\n" \
> " semihosting configuration\n",
> @@ -4178,6 +7379,41 @@ command line is still supported for backward compatibility. If both the
> specified, the former is passed to semihosting as it always takes precedence.
> @end table
> ETEXI
> +SRST
> +``-semihosting-config [enable=on|off][,target=native|gdb|auto][,chardev=id][,arg=str[,...]]``
> + 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.
> +
> + ``target=native|gdb|auto``
> + Defines where the semihosting calls will be addressed, to QEMU
> + (``native``) or to GDB (``gdb``). The default is ``auto``, which
> + means ``gdb`` during debug sessions and ``native`` otherwise.
> +
> + ``chardev=str1``
> + Send the output to a chardev backend output for native or auto
> + output when not in gdb
> +
> + ``arg=str1,arg=str2,...``
> + Allows the user to pass input arguments, and can be used
> + multiple times to build up a list. The old-style
> + ``-kernel``/``-append`` method of passing a command line is
> + still supported for backward compatibility. If both the
> + ``--semihosting-config arg`` and the ``-kernel``/``-append`` are
> + specified, the former is passed to semihosting as it always
> + takes precedence.
> +ERST
> DEF("old-param", 0, QEMU_OPTION_old_param,
> "-old-param old param mode\n", QEMU_ARCH_ARM)
> STEXI
> @@ -4185,6 +7421,10 @@ STEXI
> @findex -old-param (ARM)
> Old param mode (ARM only).
> ETEXI
> +SRST
> +``-old-param``
> + Old param mode (ARM only).
> +ERST
>
> DEF("sandbox", HAS_ARG, QEMU_OPTION_sandbox, \
> "-sandbox on[,obsolete=allow|deny][,elevateprivileges=allow|deny|children]\n" \
> @@ -4217,6 +7457,23 @@ Disable *fork and execve
> Disable process affinity and schedular priority
> @end table
> ETEXI
> +SRST
> +``-sandbox arg[,obsolete=string][,elevateprivileges=string][,spawn=string][,resourcecontrol=string]``
> + Enable Seccomp mode 2 system call filter. 'on' will enable syscall
> + filtering and 'off' will disable it. The default is 'off'.
> +
> + ``obsolete=string``
> + Enable Obsolete system calls
> +
> + ``elevateprivileges=string``
> + Disable set\*uid\|gid system calls
> +
> + ``spawn=string``
> + Disable \*fork and execve
> +
> + ``resourcecontrol=string``
> + Disable process affinity and schedular priority
> +ERST
>
> DEF("readconfig", HAS_ARG, QEMU_OPTION_readconfig,
> "-readconfig <file>\n", QEMU_ARCH_ALL)
> @@ -4227,6 +7484,12 @@ Read device configuration from @var{file}. This approach is useful when you want
> QEMU process with many command line options but you don't want to exceed the command line
> character limit.
> ETEXI
> +SRST
> +``-readconfig file``
> + Read device configuration from file. This approach is useful when
> + you want to spawn QEMU process with many command line options but
> + you don't want to exceed the command line character limit.
> +ERST
> DEF("writeconfig", HAS_ARG, QEMU_OPTION_writeconfig,
> "-writeconfig <file>\n"
> " read/write config file\n", QEMU_ARCH_ALL)
> @@ -4237,6 +7500,13 @@ Write device configuration to @var{file}. The @var{file} can be either filename
> command line and device configuration into file or dash @code{-}) character to print the
> output to stdout. This can be later used as input file for @code{-readconfig} option.
> ETEXI
> +SRST
> +``-writeconfig file``
> + Write device configuration to file. The file can be either filename
> + to save command line and device configuration into file or dash
> + ``-``) character to print the output to stdout. This can be later
> + used as input file for ``-readconfig`` option.
> +ERST
>
> DEF("no-user-config", 0, QEMU_OPTION_nouserconfig,
> "-no-user-config\n"
> @@ -4248,6 +7518,11 @@ STEXI
> The @code{-no-user-config} option makes QEMU not load any of the user-provided
> config files on @var{sysconfdir}.
> ETEXI
> +SRST
> +``-no-user-config``
> + The ``-no-user-config`` option makes QEMU not load any of the
> + user-provided config files on sysconfdir.
> +ERST
>
> DEF("trace", HAS_ARG, QEMU_OPTION_trace,
> "-trace [[enable=]<pattern>][,events=<file>][,file=<file>]\n"
> @@ -4260,6 +7535,30 @@ HXCOMM HX does not support conditional compilation of text.
> @findex -trace
> @include docs/system/qemu-option-trace.texi
> ETEXI
> +SRST
> +``-trace [[enable=]pattern][,events=file][,file=file]``
> + Specify tracing options.
> +
> + ``[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=]<file>[,arg=<string>]\n"
> " load a plugin\n",
> @@ -4277,6 +7576,17 @@ Load the given plugin from a shared library file.
> Argument string passed to the plugin. (Can be given multiple times.)
> @end table
> ETEXI
> +SRST
> +``-plugin file=file[,arg=string]``
> + Load a plugin.
> +
> + ``file=file``
> + Load the given plugin from a shared library file.
> +
> + ``arg=string``
> + Argument string passed to the plugin. (Can be given multiple
> + times.)
> +ERST
>
> HXCOMM Internal use
> DEF("qtest", HAS_ARG, QEMU_OPTION_qtest, "", QEMU_ARCH_ALL)
> @@ -4292,6 +7602,10 @@ STEXI
> @findex -enable-fips
> Enable FIPS 140-2 compliance mode.
> ETEXI
> +SRST
> +``-enable-fips``
> + Enable FIPS 140-2 compliance mode.
> +ERST
>
> HXCOMM Deprecated by -accel tcg
> DEF("no-kvm", 0, QEMU_OPTION_no_kvm, "", QEMU_ARCH_I386)
> @@ -4310,6 +7624,13 @@ Control error message format.
> Prefix messages with a timestamp. Default is off.
> @end table
> ETEXI
> +SRST
> +``-msg timestamp[=on|off]``
> + Control error message format.
> +
> + ``timestamp=on|off``
> + Prefix messages with a timestamp. Default is off.
> +ERST
>
> DEF("dump-vmstate", HAS_ARG, QEMU_OPTION_dump_vmstate,
> "-dump-vmstate <file>\n"
> @@ -4324,6 +7645,11 @@ STEXI
> Dump json-encoded vmstate information for current machine type to file
> in @var{file}
> ETEXI
> +SRST
> +``-dump-vmstate file``
> + Dump json-encoded vmstate information for current machine type to
> + file in file
> +ERST
>
> DEF("enable-sync-profile", 0, QEMU_OPTION_enable_sync_profile,
> "-enable-sync-profile\n"
> @@ -4334,6 +7660,10 @@ STEXI
> @findex -enable-sync-profile
> Enable synchronization profiling.
> ETEXI
> +SRST
> +``-enable-sync-profile``
> + Enable synchronization profiling.
> +ERST
>
> STEXI
> @end table
> @@ -5014,6 +8344,675 @@ The polling parameters can be modified at run-time using the @code{qom-set} comm
> @end table
>
> ETEXI
> +SRST
> +``-object typename[,prop1=value1,...]``
> + Create a new object of type typename setting properties in the order
> + they are specified. Note that the 'id' property must be set. These
> + objects are placed in the '/objects' path.
> +
> + ``-object memory-backend-file,id=id,size=size,mem-path=dir,share=on|off,discard-data=on|off,merge=on|off,dump=on|off,prealloc=on|off,host-nodes=host-nodes,policy=default|preferred|bind|interleave,align=align``
> + Creates a memory file backend object, which can be used to back
> + the guest RAM with huge pages.
> +
> + The ``id`` parameter is a unique ID that will be used to
> + reference this memory region when configuring the ``-numa``
> + argument.
> +
> + The ``size`` option provides the size of the memory region, and
> + accepts common suffixes, eg ``500M``.
> +
> + The ``mem-path`` provides the path to either a shared memory or
> + huge page filesystem mount.
> +
> + The ``share`` boolean option determines whether the memory
> + region is marked as private to QEMU, or shared. The latter
> + allows a co-operating external process to access the QEMU memory
> + region.
> +
> + The ``share`` is also required for pvrdma devices due to
> + limitations in the RDMA API provided by Linux.
> +
> + Setting share=on might affect the ability to configure NUMA
> + bindings for the memory backend under some circumstances, see
> + Documentation/vm/numa\_memory\_policy.txt on the Linux kernel
> + source tree for additional details.
> +
> + Setting the ``discard-data`` boolean option to on indicates that
> + file contents can be destroyed when QEMU exits, to avoid
> + unnecessarily flushing data to the backing file. Note that
> + ``discard-data`` is only an optimization, and QEMU might not
> + discard file contents if it aborts unexpectedly or is terminated
> + using SIGKILL.
> +
> + The ``merge`` boolean option enables memory merge, also known as
> + MADV\_MERGEABLE, so that Kernel Samepage Merging will consider
> + the pages for memory deduplication.
> +
> + Setting the ``dump`` boolean option to off excludes the memory
> + from core dumps. This feature is also known as MADV\_DONTDUMP.
> +
> + The ``prealloc`` boolean option enables memory preallocation.
> +
> + The ``host-nodes`` option binds the memory range to a list of
> + NUMA host nodes.
> +
> + The ``policy`` option sets the NUMA policy to one of the
> + following values:
> +
> + ``default``
> + default host policy
> +
> + ``preferred``
> + prefer the given host node list for allocation
> +
> + ``bind``
> + restrict memory allocation to the given host node list
> +
> + ``interleave``
> + interleave memory allocations across the given host node
> + list
> +
> + The ``align`` option specifies the base address alignment when
> + QEMU mmap(2) ``mem-path``, and accepts common suffixes, eg
> + ``2M``. Some backend store specified by ``mem-path`` requires an
> + alignment different than the default one used by QEMU, eg the
> + device DAX /dev/dax0.0 requires 2M alignment rather than 4K. In
> + such cases, users can specify the required alignment via this
> + option.
> +
> + The ``pmem`` option specifies whether the backing file specified
> + by ``mem-path`` is in host persistent memory that can be
> + accessed using the SNIA NVM programming model (e.g. Intel
> + NVDIMM). If ``pmem`` is set to 'on', QEMU will take necessary
> + operations to guarantee the persistence of its own writes to
> + ``mem-path`` (e.g. in vNVDIMM label emulation and live
> + migration). Also, we will map the backend-file with MAP\_SYNC
> + flag, which ensures the file metadata is in sync for
> + ``mem-path`` in case of host crash or a power failure. MAP\_SYNC
> + requires support from both the host kernel (since Linux kernel
> + 4.15) and the filesystem of ``mem-path`` mounted with DAX
> + option.
> +
> + ``-object memory-backend-ram,id=id,merge=on|off,dump=on|off,share=on|off,prealloc=on|off,size=size,host-nodes=host-nodes,policy=default|preferred|bind|interleave``
> + Creates a memory backend object, which can be used to back the
> + guest RAM. Memory backend objects offer more control than the
> + ``-m`` option that is traditionally used to define guest RAM.
> + Please refer to ``memory-backend-file`` for a description of the
> + options.
> +
> + ``-object memory-backend-memfd,id=id,merge=on|off,dump=on|off,share=on|off,prealloc=on|off,size=size,host-nodes=host-nodes,policy=default|preferred|bind|interleave,seal=on|off,hugetlb=on|off,hugetlbsize=size``
> + Creates an anonymous memory file backend object, which allows
> + QEMU to share the memory with an external process (e.g. when
> + using vhost-user). The memory is allocated with memfd and
> + optional sealing. (Linux only)
> +
> + The ``seal`` option creates a sealed-file, that will block
> + further resizing the memory ('on' by default).
> +
> + The ``hugetlb`` option specify the file to be created resides in
> + the hugetlbfs filesystem (since Linux 4.14). Used in conjunction
> + with the ``hugetlb`` option, the ``hugetlbsize`` option specify
> + the hugetlb page size on systems that support multiple hugetlb
> + page sizes (it must be a power of 2 value supported by the
> + system).
> +
> + In some versions of Linux, the ``hugetlb`` option is
> + incompatible with the ``seal`` option (requires at least Linux
> + 4.16).
> +
> + Please refer to ``memory-backend-file`` for a description of the
> + other options.
> +
> + The ``share`` boolean option is on by default with memfd.
> +
> + ``-object rng-builtin,id=id``
> + Creates a random number generator backend which obtains entropy
> + from QEMU builtin functions. The ``id`` parameter is a unique ID
> + that will be used to reference this entropy backend from the
> + ``virtio-rng`` device. By default, the ``virtio-rng`` device
> + uses this RNG backend.
> +
> + ``-object rng-random,id=id,filename=/dev/random``
> + Creates a random number generator backend which obtains entropy
> + from a device on the host. The ``id`` parameter is a unique ID
> + that will be used to reference this entropy backend from the
> + ``virtio-rng`` device. The ``filename`` parameter specifies
> + which file to obtain entropy from and if omitted defaults to
> + ``/dev/urandom``.
> +
> + ``-object rng-egd,id=id,chardev=chardevid``
> + Creates a random number generator backend which obtains entropy
> + from an external daemon running on the host. The ``id``
> + parameter is a unique ID that will be used to reference this
> + entropy backend from the ``virtio-rng`` device. The ``chardev``
> + parameter is the unique ID of a character device backend that
> + provides the connection to the RNG daemon.
> +
> + ``-object tls-creds-anon,id=id,endpoint=endpoint,dir=/path/to/cred/dir,verify-peer=on|off``
> + Creates a TLS anonymous credentials object, which can be used to
> + provide TLS support on network backends. The ``id`` parameter is
> + a unique ID which network backends will use to access the
> + credentials. The ``endpoint`` is either ``server`` or ``client``
> + depending on whether the QEMU network backend that uses the
> + credentials will be acting as a client or as a server. If
> + ``verify-peer`` is enabled (the default) then once the handshake
> + is completed, the peer credentials will be verified, though this
> + is a no-op for anonymous credentials.
> +
> + The dir parameter tells QEMU where to find the credential files.
> + For server endpoints, this directory may contain a file
> + dh-params.pem providing diffie-hellman parameters to use for the
> + TLS server. If the file is missing, QEMU will generate a set of
> + DH parameters at startup. This is a computationally expensive
> + operation that consumes random pool entropy, so it is
> + recommended that a persistent set of parameters be generated
> + upfront and saved.
> +
> + ``-object tls-creds-psk,id=id,endpoint=endpoint,dir=/path/to/keys/dir[,username=username]``
> + Creates a TLS Pre-Shared Keys (PSK) credentials object, which
> + can be used to provide TLS support on network backends. The
> + ``id`` parameter is a unique ID which network backends will use
> + to access the credentials. The ``endpoint`` is either ``server``
> + or ``client`` depending on whether the QEMU network backend that
> + uses the credentials will be acting as a client or as a server.
> + For clients only, ``username`` is the username which will be
> + sent to the server. If omitted it defaults to "qemu".
> +
> + The dir parameter tells QEMU where to find the keys file. It is
> + called "dir/keys.psk" and contains "username:key" pairs. This
> + file can most easily be created using the GnuTLS ``psktool``
> + program.
> +
> + For server endpoints, dir may also contain a file dh-params.pem
> + providing diffie-hellman parameters to use for the TLS server.
> + If the file is missing, QEMU will generate a set of DH
> + parameters at startup. This is a computationally expensive
> + operation that consumes random pool entropy, so it is
> + recommended that a persistent set of parameters be generated up
> + front and saved.
> +
> + ``-object tls-creds-x509,id=id,endpoint=endpoint,dir=/path/to/cred/dir,priority=priority,verify-peer=on|off,passwordid=id``
> + Creates a TLS anonymous credentials object, which can be used to
> + provide TLS support on network backends. The ``id`` parameter is
> + a unique ID which network backends will use to access the
> + credentials. The ``endpoint`` is either ``server`` or ``client``
> + depending on whether the QEMU network backend that uses the
> + credentials will be acting as a client or as a server. If
> + ``verify-peer`` is enabled (the default) then once the handshake
> + is completed, the peer credentials will be verified. With x509
> + certificates, this implies that the clients must be provided
> + with valid client certificates too.
> +
> + The dir parameter tells QEMU where to find the credential files.
> + For server endpoints, this directory may contain a file
> + dh-params.pem providing diffie-hellman parameters to use for the
> + TLS server. If the file is missing, QEMU will generate a set of
> + DH parameters at startup. This is a computationally expensive
> + operation that consumes random pool entropy, so it is
> + recommended that a persistent set of parameters be generated
> + upfront and saved.
> +
> + For x509 certificate credentials the directory will contain
> + further files providing the x509 certificates. The certificates
> + must be stored in PEM format, in filenames ca-cert.pem,
> + ca-crl.pem (optional), server-cert.pem (only servers),
> + server-key.pem (only servers), client-cert.pem (only clients),
> + and client-key.pem (only clients).
> +
> + For the server-key.pem and client-key.pem files which contain
> + sensitive private keys, it is possible to use an encrypted
> + version by providing the passwordid parameter. This provides the
> + ID of a previously created ``secret`` object containing the
> + password for decryption.
> +
> + The priority parameter allows to override the global default
> + priority used by gnutls. This can be useful if the system
> + administrator needs to use a weaker set of crypto priorities for
> + QEMU without potentially forcing the weakness onto all
> + applications. Or conversely if one wants wants a stronger
> + default for QEMU than for all other applications, they can do
> + this through this parameter. Its format is a gnutls priority
> + string as described at
> + https://gnutls.org/manual/html_node/Priority-Strings.html.
> +
> + ``-object filter-buffer,id=id,netdev=netdevid,interval=t[,queue=all|rx|tx][,status=on|off]``
> + Interval t can't be 0, this filter batches the packet delivery:
> + all packets arriving in a given interval on netdev netdevid are
> + delayed until the end of the interval. Interval is in
> + microseconds. ``status`` is optional that indicate whether the
> + netfilter is on (enabled) or off (disabled), the default status
> + for netfilter will be 'on'.
> +
> + queue all\|rx\|tx is an option that can be applied to any
> + netfilter.
> +
> + ``all``: the filter is attached both to the receive and the
> + transmit queue of the netdev (default).
> +
> + ``rx``: the filter is attached to the receive queue of the
> + netdev, where it will receive packets sent to the netdev.
> +
> + ``tx``: the filter is attached to the transmit queue of the
> + netdev, where it will receive packets sent by the netdev.
> +
> + ``-object filter-mirror,id=id,netdev=netdevid,outdev=chardevid,queue=all|rx|tx[,vnet_hdr_support]``
> + filter-mirror on netdev netdevid,mirror net packet to
> + chardevchardevid, if it has the vnet\_hdr\_support flag,
> + filter-mirror will mirror packet with vnet\_hdr\_len.
> +
> + ``-object filter-redirector,id=id,netdev=netdevid,indev=chardevid,outdev=chardevid,queue=all|rx|tx[,vnet_hdr_support]``
> + filter-redirector on netdev netdevid,redirect filter's net
> + packet to chardev chardevid,and redirect indev's packet to
> + filter.if it has the vnet\_hdr\_support flag, filter-redirector
> + will redirect packet with vnet\_hdr\_len. Create a
> + filter-redirector we need to differ outdev id from indev id, id
> + can not be the same. we can just use indev or outdev, but at
> + least one of indev or outdev need to be specified.
> +
> + ``-object filter-rewriter,id=id,netdev=netdevid,queue=all|rx|tx,[vnet_hdr_support]``
> + Filter-rewriter is a part of COLO project.It will rewrite tcp
> + packet to secondary from primary to keep secondary tcp
> + connection,and rewrite tcp packet to primary from secondary make
> + tcp packet can be handled by client.if it has the
> + vnet\_hdr\_support flag, we can parse packet with vnet header.
> +
> + usage: colo secondary: -object
> + filter-redirector,id=f1,netdev=hn0,queue=tx,indev=red0 -object
> + filter-redirector,id=f2,netdev=hn0,queue=rx,outdev=red1 -object
> + filter-rewriter,id=rew0,netdev=hn0,queue=all
> +
> + ``-object filter-dump,id=id,netdev=dev[,file=filename][,maxlen=len]``
> + Dump the network traffic on netdev dev to the file specified by
> + filename. At most len bytes (64k by default) per packet are
> + stored. The file format is libpcap, so it can be analyzed with
> + tools such as tcpdump or Wireshark.
> +
> + ``-object colo-compare,id=id,primary_in=chardevid,secondary_in=chardevid,outdev=chardevid,iothread=id[,vnet_hdr_support][,notify_dev=id]``
> + Colo-compare gets packet from primary\_inchardevid and
> + secondary\_inchardevid, than compare primary packet with
> + secondary packet. If the packets are same, we will output
> + primary packet to outdevchardevid, else we will notify
> + colo-frame do checkpoint and send primary packet to
> + outdevchardevid. In order to improve efficiency, we need to put
> + the task of comparison in another thread. If it has the
> + vnet\_hdr\_support flag, colo compare will send/recv packet with
> + vnet\_hdr\_len. If you want to use Xen COLO, will need the
> + notify\_dev to notify Xen colo-frame to do checkpoint.
> +
> + we must use it with the help of filter-mirror and
> + filter-redirector.
> +
> + ::
> +
> + KVM COLO
> +
> + primary:
> + -netdev tap,id=hn0,vhost=off,script=/etc/qemu-ifup,downscript=/etc/qemu-ifdown
> + -device e1000,id=e0,netdev=hn0,mac=52:a4:00:12:78:66
> + -chardev socket,id=mirror0,host=3.3.3.3,port=9003,server,nowait
> + -chardev socket,id=compare1,host=3.3.3.3,port=9004,server,nowait
> + -chardev socket,id=compare0,host=3.3.3.3,port=9001,server,nowait
> + -chardev socket,id=compare0-0,host=3.3.3.3,port=9001
> + -chardev socket,id=compare_out,host=3.3.3.3,port=9005,server,nowait
> + -chardev socket,id=compare_out0,host=3.3.3.3,port=9005
> + -object iothread,id=iothread1
> + -object filter-mirror,id=m0,netdev=hn0,queue=tx,outdev=mirror0
> + -object filter-redirector,netdev=hn0,id=redire0,queue=rx,indev=compare_out
> + -object filter-redirector,netdev=hn0,id=redire1,queue=rx,outdev=compare0
> + -object colo-compare,id=comp0,primary_in=compare0-0,secondary_in=compare1,outdev=compare_out0,iothread=iothread1
> +
> + secondary:
> + -netdev tap,id=hn0,vhost=off,script=/etc/qemu-ifup,down script=/etc/qemu-ifdown
> + -device e1000,netdev=hn0,mac=52:a4:00:12:78:66
> + -chardev socket,id=red0,host=3.3.3.3,port=9003
> + -chardev socket,id=red1,host=3.3.3.3,port=9004
> + -object filter-redirector,id=f1,netdev=hn0,queue=tx,indev=red0
> + -object filter-redirector,id=f2,netdev=hn0,queue=rx,outdev=red1
> +
> +
> + Xen COLO
> +
> + primary:
> + -netdev tap,id=hn0,vhost=off,script=/etc/qemu-ifup,downscript=/etc/qemu-ifdown
> + -device e1000,id=e0,netdev=hn0,mac=52:a4:00:12:78:66
> + -chardev socket,id=mirror0,host=3.3.3.3,port=9003,server,nowait
> + -chardev socket,id=compare1,host=3.3.3.3,port=9004,server,nowait
> + -chardev socket,id=compare0,host=3.3.3.3,port=9001,server,nowait
> + -chardev socket,id=compare0-0,host=3.3.3.3,port=9001
> + -chardev socket,id=compare_out,host=3.3.3.3,port=9005,server,nowait
> + -chardev socket,id=compare_out0,host=3.3.3.3,port=9005
> + -chardev socket,id=notify_way,host=3.3.3.3,port=9009,server,nowait
> + -object filter-mirror,id=m0,netdev=hn0,queue=tx,outdev=mirror0
> + -object filter-redirector,netdev=hn0,id=redire0,queue=rx,indev=compare_out
> + -object filter-redirector,netdev=hn0,id=redire1,queue=rx,outdev=compare0
> + -object iothread,id=iothread1
> + -object colo-compare,id=comp0,primary_in=compare0-0,secondary_in=compare1,outdev=compare_out0,notify_dev=nofity_way,iothread=iothread1
> +
> + secondary:
> + -netdev tap,id=hn0,vhost=off,script=/etc/qemu-ifup,down script=/etc/qemu-ifdown
> + -device e1000,netdev=hn0,mac=52:a4:00:12:78:66
> + -chardev socket,id=red0,host=3.3.3.3,port=9003
> + -chardev socket,id=red1,host=3.3.3.3,port=9004
> + -object filter-redirector,id=f1,netdev=hn0,queue=tx,indev=red0
> + -object filter-redirector,id=f2,netdev=hn0,queue=rx,outdev=red1
> +
> + If you want to know the detail of above command line, you can
> + read the colo-compare git log.
> +
> + ``-object cryptodev-backend-builtin,id=id[,queues=queues]``
> + Creates a cryptodev backend which executes crypto opreation from
> + the QEMU cipher APIS. The id parameter is a unique ID that will
> + be used to reference this cryptodev backend from the
> + ``virtio-crypto`` device. The queues parameter is optional,
> + which specify the queue number of cryptodev backend, the default
> + of queues is 1.
> +
> + ::
> +
> + # |qemu_system| \
> + [...] \
> + -object cryptodev-backend-builtin,id=cryptodev0 \
> + -device virtio-crypto-pci,id=crypto0,cryptodev=cryptodev0 \
> + [...]
> +
> + ``-object cryptodev-vhost-user,id=id,chardev=chardevid[,queues=queues]``
> + Creates a vhost-user cryptodev backend, backed by a chardev
> + chardevid. The id parameter is a unique ID that will be used to
> + reference this cryptodev backend from the ``virtio-crypto``
> + device. The chardev should be a unix domain socket backed one.
> + The vhost-user uses a specifically defined protocol to pass
> + vhost ioctl replacement messages to an application on the other
> + end of the socket. The queues parameter is optional, which
> + specify the queue number of cryptodev backend for multiqueue
> + vhost-user, the default of queues is 1.
> +
> + ::
> +
> + # |qemu_system| \
> + [...] \
> + -chardev socket,id=chardev0,path=/path/to/socket \
> + -object cryptodev-vhost-user,id=cryptodev0,chardev=chardev0 \
> + -device virtio-crypto-pci,id=crypto0,cryptodev=cryptodev0 \
> + [...]
> +
> + ``-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
> + directly via the data parameter, or indirectly via the file
> + parameter. Using the data parameter is insecure unless the
> + sensitive data is encrypted.
> +
> + The sensitive data can be provided in raw format (the default),
> + or base64. When encoded as JSON, the raw format only supports
> + valid UTF-8 characters, so base64 is recommended for sending
> + binary data. QEMU will convert from which ever format is
> + provided to the format it needs internally. eg, an RBD password
> + can be provided in raw format, even though it will be base64
> + encoded when passed onto the RBD sever.
> +
> + For added protection, it is possible to encrypt the data
> + associated with a secret using the AES-256-CBC cipher. Use of
> + encryption is indicated by providing the keyid and iv
> + parameters. The keyid parameter provides the ID of a previously
> + defined secret that contains the AES-256 decryption key. This
> + key should be 32-bytes long and be base64 encoded. The iv
> + parameter provides the random initialization vector used for
> + encryption of this particular secret and should be a base64
> + encrypted string of the 16-byte IV.
> +
> + The simplest (insecure) usage is to provide the secret inline
> +
> + ::
> +
> + # |qemu_system| -object secret,id=sec0,data=letmein,format=raw
> +
> + The simplest secure usage is to provide the secret via a file
> +
> + # printf "letmein" > mypasswd.txt # QEMU\_SYSTEM\_MACRO -object
> + secret,id=sec0,file=mypasswd.txt,format=raw
> +
> + For greater security, AES-256-CBC should be used. To illustrate
> + usage, consider the openssl command line tool which can encrypt
> + the data. Note that when encrypting, the plaintext must be
> + padded to the cipher block size (32 bytes) using the standard
> + PKCS#5/6 compatible padding algorithm.
> +
> + First a master key needs to be created in base64 encoding:
> +
> + ::
> +
> + # openssl rand -base64 32 > key.b64
> + # KEY=$(base64 -d key.b64 | hexdump -v -e '/1 "%02X"')
> +
> + Each secret to be encrypted needs to have a random
> + initialization vector generated. These do not need to be kept
> + secret
> +
> + ::
> +
> + # openssl rand -base64 16 > iv.b64
> + # IV=$(base64 -d iv.b64 | hexdump -v -e '/1 "%02X"')
> +
> + The secret to be defined can now be encrypted, in this case
> + we're telling openssl to base64 encode the result, but it could
> + be left as raw bytes if desired.
> +
> + ::
> +
> + # SECRET=$(printf "letmein" |
> + openssl enc -aes-256-cbc -a -K $KEY -iv $IV)
> +
> + When launching QEMU, create a master secret pointing to
> + ``key.b64`` and specify that to be used to decrypt the user
> + password. Pass the contents of ``iv.b64`` to the second secret
> +
> + ::
> +
> + # |qemu_system| \
> + -object secret,id=secmaster0,format=base64,file=key.b64 \
> + -object secret,id=sec0,keyid=secmaster0,format=base64,\
> + data=$SECRET,iv=$(<iv.b64)
> +
> + ``-object sev-guest,id=id,cbitpos=cbitpos,reduced-phys-bits=val,[sev-device=string,policy=policy,handle=handle,dh-cert-file=file,session-file=file]``
> + Create a Secure Encrypted Virtualization (SEV) guest object,
> + which can be used to provide the guest memory encryption support
> + on AMD processors.
> +
> + When memory encryption is enabled, one of the physical address
> + bit (aka the C-bit) is utilized to mark if a memory page is
> + protected. The ``cbitpos`` is used to provide the C-bit
> + position. The C-bit position is Host family dependent hence user
> + must provide this value. On EPYC, the value should be 47.
> +
> + When memory encryption is enabled, we loose certain bits in
> + physical address space. The ``reduced-phys-bits`` is used to
> + provide the number of bits we loose in physical address space.
> + Similar to C-bit, the value is Host family dependent. On EPYC,
> + the value should be 5.
> +
> + The ``sev-device`` provides the device file to use for
> + communicating with the SEV firmware running inside AMD Secure
> + Processor. The default device is '/dev/sev'. If hardware
> + supports memory encryption then /dev/sev devices are created by
> + CCP driver.
> +
> + The ``policy`` provides the guest policy to be enforced by the
> + SEV firmware and restrict what configuration and operational
> + commands can be performed on this guest by the hypervisor. The
> + policy should be provided by the guest owner and is bound to the
> + guest and cannot be changed throughout the lifetime of the
> + guest. The default is 0.
> +
> + If guest ``policy`` allows sharing the key with another SEV
> + guest then ``handle`` can be use to provide handle of the guest
> + from which to share the key.
> +
> + The ``dh-cert-file`` and ``session-file`` provides the guest
> + owner's Public Diffie-Hillman key defined in SEV spec. The PDH
> + and session parameters are used for establishing a cryptographic
> + session with the guest owner to negotiate keys used for
> + attestation. The file must be encoded in base64.
> +
> + e.g to launch a SEV guest
> +
> + ::
> +
> + # |qemu_system_x86| \
> + ......
> + -object sev-guest,id=sev0,cbitpos=47,reduced-phys-bits=5 \
> + -machine ...,memory-encryption=sev0
> + .....
> +
> + ``-object authz-simple,id=id,identity=string``
> + Create an authorization object that will control access to
> + network services.
> +
> + The ``identity`` parameter is identifies the user and its format
> + depends on the network service that authorization object is
> + associated with. For authorizing based on TLS x509 certificates,
> + the identity must be the x509 distinguished name. Note that care
> + must be taken to escape any commas in the distinguished name.
> +
> + An example authorization object to validate a x509 distinguished
> + name would look like:
> +
> + ::
> +
> + # |qemu_system| \
> + ...
> + -object 'authz-simple,id=auth0,identity=CN=laptop.example.com,,O=Example Org,,L=London,,ST=London,,C=GB' \
> + ...
> +
> + Note the use of quotes due to the x509 distinguished name
> + containing whitespace, and escaping of ','.
> +
> + ``-object authz-listfile,id=id,filename=path,refresh=yes|no``
> + Create an authorization object that will control access to
> + network services.
> +
> + The ``filename`` parameter is the fully qualified path to a file
> + containing the access control list rules in JSON format.
> +
> + An example set of rules that match against SASL usernames might
> + look like:
> +
> + ::
> +
> + {
> + "rules": [
> + { "match": "fred", "policy": "allow", "format": "exact" },
> + { "match": "bob", "policy": "allow", "format": "exact" },
> + { "match": "danb", "policy": "deny", "format": "glob" },
> + { "match": "dan*", "policy": "allow", "format": "exact" },
> + ],
> + "policy": "deny"
> + }
> +
> + When checking access the object will iterate over all the rules
> + and the first rule to match will have its ``policy`` value
> + returned as the result. If no rules match, then the default
> + ``policy`` value is returned.
> +
> + The rules can either be an exact string match, or they can use
> + the simple UNIX glob pattern matching to allow wildcards to be
> + used.
> +
> + If ``refresh`` is set to true the file will be monitored and
> + automatically reloaded whenever its content changes.
> +
> + As with the ``authz-simple`` object, the format of the identity
> + strings being matched depends on the network service, but is
> + usually a TLS x509 distinguished name, or a SASL username.
> +
> + An example authorization object to validate a SASL username
> + would look like:
> +
> + ::
> +
> + # |qemu_system| \
> + ...
> + -object authz-simple,id=auth0,filename=/etc/qemu/vnc-sasl.acl,refresh=yes
> + ...
> +
> + ``-object authz-pam,id=id,service=string``
> + Create an authorization object that will control access to
> + network services.
> +
> + The ``service`` parameter provides the name of a PAM service to
> + use for authorization. It requires that a file
> + ``/etc/pam.d/service`` exist to provide the configuration for
> + the ``account`` subsystem.
> +
> + An example authorization object to validate a TLS x509
> + distinguished name would look like:
> +
> + ::
> +
> + # |qemu_system| \
> + ...
> + -object authz-pam,id=auth0,service=qemu-vnc
> + ...
> +
> + There would then be a corresponding config file for PAM at
> + ``/etc/pam.d/qemu-vnc`` that contains:
> +
> + ::
> +
> + account requisite pam_listfile.so item=user sense=allow \
> + file=/etc/qemu/vnc.allow
> +
> + Finally the ``/etc/qemu/vnc.allow`` file would contain the list
> + of x509 distingished names that are permitted access
> +
> + ::
> +
> + CN=laptop.example.com,O=Example Home,L=London,ST=London,C=GB
> +
> + ``-object iothread,id=id,poll-max-ns=poll-max-ns,poll-grow=poll-grow,poll-shrink=poll-shrink``
> + Creates a dedicated event loop thread that devices can be
> + assigned to. This is known as an IOThread. By default device
> + emulation happens in vCPU threads or the main event loop thread.
> + This can become a scalability bottleneck. IOThreads allow device
> + emulation and I/O to run on other host CPUs.
> +
> + The ``id`` parameter is a unique ID that will be used to
> + reference this IOThread from ``-device ...,iothread=id``.
> + Multiple devices can be assigned to an IOThread. Note that not
> + all devices support an ``iothread`` parameter.
> +
> + The ``query-iothreads`` QMP command lists IOThreads and reports
> + their thread IDs so that the user can configure host CPU
> + pinning/affinity.
> +
> + IOThreads use an adaptive polling algorithm to reduce event loop
> + latency. Instead of entering a blocking system call to monitor
> + file descriptors and then pay the cost of being woken up when an
> + event occurs, the polling algorithm spins waiting for events for
> + a short time. The algorithm's default parameters are suitable
> + for many cases but can be adjusted based on knowledge of the
> + workload and/or host device latency.
> +
> + The ``poll-max-ns`` parameter is the maximum number of
> + nanoseconds to busy wait for events. Polling can be disabled by
> + setting this value to 0.
> +
> + The ``poll-grow`` parameter is the multiplier used to increase
> + the polling time when the algorithm detects it is missing events
> + due to not polling long enough.
> +
> + The ``poll-shrink`` parameter is the divisor used to decrease
> + the polling time when the algorithm detects it is spending too
> + long polling without encountering events.
> +
> + The polling parameters can be modified at run-time using the
> + ``qom-set`` command (where ``iothread1`` is the IOThread's
> + ``id``):
> +
> + ::
> +
> + (qemu) qom-set /objects/iothread1 poll-max-ns 100000
> +ERST
>
>
> HXCOMM This is the last statement. Insert new options before this line!
--
Alex Bennée
^ permalink raw reply [flat|nested] 82+ messages in thread
* [PATCH v3 27/33] qemu-options.hx: Fix up the autogenerated rST
2020-02-28 15:35 [PATCH v3 00/33] Convert qemu-doc to rST Peter Maydell
` (25 preceding siblings ...)
2020-02-28 15:36 ` [PATCH v3 26/33] qemu-options.hx: Add rST documentation fragments Peter Maydell
@ 2020-02-28 15:36 ` Peter Maydell
2020-03-02 12:23 ` Alex Bennée
2020-02-28 15:36 ` [PATCH v3 28/33] docs: Split out sections for the manpage into .rst.inc files Peter Maydell
` (8 subsequent siblings)
35 siblings, 1 reply; 82+ messages in thread
From: Peter Maydell @ 2020-02-28 15:36 UTC (permalink / raw)
To: qemu-devel; +Cc: Paolo Bonzini, Kashyap Chamarthy
[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #1: Type: text/plain; charset=UTF-8, Size: 17498 bytes --]
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 <peter.maydell@linaro.org>
---
I opted not to try to reinstate all the italics-vs-fixed
distinctions in the option headings, in the interests
of expediency. I'm happy to go back and add this in later
once the whole conversion has landed but I think we are
better off doing a mostly-good-enough conversion quickly
and then refining it in-tree rather than having it out
of tree for a long time and getting hit by problems as
documentation is updated by other patches...
---
Makefile | 2 +-
docs/system/invocation.rst | 2 +
qemu-options.hx | 143 +++++++++++++++++++++----------------
3 files changed, 84 insertions(+), 63 deletions(-)
diff --git a/Makefile b/Makefile
index 98ef06ab8e8..f7d08997dbf 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 c112bcb45a4..d77dd13d4f7 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 043e425b61e..f7061212ceb 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=]<file>[,arg=<string>]\n"
@@ -8707,7 +8725,7 @@ SRST
which specify the queue number of cryptodev backend, the default
of queues is 1.
- ::
+ .. parsed-literal::
# |qemu_system| \
[...] \
@@ -8726,7 +8744,7 @@ SRST
specify the queue number of cryptodev backend for multiqueue
vhost-user, the default of queues is 1.
- ::
+ .. parsed-literal::
# |qemu_system| \
[...] \
@@ -8736,6 +8754,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
@@ -8763,7 +8782,7 @@ SRST
The simplest (insecure) usage is to provide the secret inline
- ::
+ .. parsed-literal::
# |qemu_system| -object secret,id=sec0,data=letmein,format=raw
@@ -8807,7 +8826,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 \
@@ -8856,7 +8875,7 @@ SRST
e.g to launch a SEV guest
- ::
+ .. parsed-literal::
# |qemu_system_x86| \
......
@@ -8877,7 +8896,7 @@ SRST
An example authorization object to validate a x509 distinguished
name would look like:
- ::
+ .. parsed-literal::
# |qemu_system| \
...
@@ -8928,7 +8947,7 @@ SRST
An example authorization object to validate a SASL username
would look like:
- ::
+ .. parsed-literal::
# |qemu_system| \
...
@@ -8947,7 +8966,7 @@ SRST
An example authorization object to validate a TLS x509
distinguished name would look like:
- ::
+ .. parsed-literal::
# |qemu_system| \
...
--
2.20.1
^ permalink raw reply related [flat|nested] 82+ messages in thread* Re: [PATCH v3 27/33] qemu-options.hx: Fix up the autogenerated rST
2020-02-28 15:36 ` [PATCH v3 27/33] qemu-options.hx: Fix up the autogenerated rST Peter Maydell
@ 2020-03-02 12:23 ` Alex Bennée
0 siblings, 0 replies; 82+ messages in thread
From: Alex Bennée @ 2020-03-02 12:23 UTC (permalink / raw)
To: Peter Maydell; +Cc: Paolo Bonzini, qemu-devel, Kashyap Chamarthy
Peter Maydell <peter.maydell@linaro.org> writes:
> 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 <peter.maydell@linaro.org>
Reviewed-by: Alex Bennée <alex.bennee@linaro.org>
--
Alex Bennée
^ permalink raw reply [flat|nested] 82+ messages in thread
* [PATCH v3 28/33] docs: Split out sections for the manpage into .rst.inc files
2020-02-28 15:35 [PATCH v3 00/33] Convert qemu-doc to rST Peter Maydell
` (26 preceding siblings ...)
2020-02-28 15:36 ` [PATCH v3 27/33] qemu-options.hx: Fix up the autogenerated rST Peter Maydell
@ 2020-02-28 15:36 ` Peter Maydell
2020-03-02 12:24 ` Alex Bennée
2020-02-28 15:36 ` [PATCH v3 29/33] docs: Generate qemu.1 manpage with Sphinx Peter Maydell
` (7 subsequent siblings)
35 siblings, 1 reply; 82+ messages in thread
From: Peter Maydell @ 2020-02-28 15:36 UTC (permalink / raw)
To: qemu-devel; +Cc: Paolo Bonzini, Kashyap Chamarthy
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 <peter.maydell@linaro.org>
---
...vocation.rst => device-url-syntax.rst.inc} | 16 --
docs/system/invocation.rst | 228 +-----------------
docs/system/keys.rst | 36 +--
docs/system/{keys.rst => keys.rst.inc} | 5 -
docs/system/mux-chardev.rst | 28 +--
.../{mux-chardev.rst => mux-chardev.rst.inc} | 5 -
...rget-i386.rst => target-i386-desc.rst.inc} | 22 --
docs/system/target-i386.rst | 63 +----
8 files changed, 4 insertions(+), 399 deletions(-)
copy docs/system/{invocation.rst => device-url-syntax.rst.inc} (96%)
copy docs/system/{keys.rst => keys.rst.inc} (90%)
copy docs/system/{mux-chardev.rst => mux-chardev.rst.inc} (87%)
copy docs/system/{target-i386.rst => target-i386-desc.rst.inc} (76%)
diff --git a/docs/system/invocation.rst b/docs/system/device-url-syntax.rst.inc
similarity index 96%
copy from docs/system/invocation.rst
copy to docs/system/device-url-syntax.rst.inc
index d77dd13d4f7..88d7a372a74 100644
--- a/docs/system/invocation.rst
+++ b/docs/system/device-url-syntax.rst.inc
@@ -1,19 +1,3 @@
-.. _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.
-
-.. hxtool-doc:: qemu-options.hx
-
-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.
diff --git a/docs/system/invocation.rst b/docs/system/invocation.rst
index d77dd13d4f7..4ba38fc23d2 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://<target-ip>[:<port>]/<target-iqn>/<lun>"
-
- By default qemu will use the iSCSI initiator-name
- 'iqn.2008-11.org.linux-kvm[:<name>]' 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://<server-ip>[:<port>]/[<export>]"
-
- Syntax for specifying a NBD device using Unix Domain Sockets;
- remember that '?' is a shell glob character and may need quoting:
- "nbd+unix:///[<export>]?socket=<domain-socket>"
-
- Older syntax that is also recognized:
- "nbd:<server-ip>:<port>[:exportname=<export>]"
-
- Syntax for specifying a NBD device using Unix Domain Sockets
- "nbd:unix:<domain-socket>[:exportname=<export>]"
-
- 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:
-
- ::
-
- <protocol>://[<username>[:<password>]@]<host>/<path>
-
- 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 <protocol>.
-
- 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 bf99ee8d5be..e596ae6c4e7 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 b/docs/system/keys.rst.inc
similarity index 90%
copy from docs/system/keys.rst
copy to docs/system/keys.rst.inc
index bf99ee8d5be..bd9b8e5f6f5 100644
--- a/docs/system/keys.rst
+++ b/docs/system/keys.rst.inc
@@ -1,8 +1,3 @@
-.. _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)
diff --git a/docs/system/mux-chardev.rst b/docs/system/mux-chardev.rst
index e50172c0815..413a6b34460 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 b/docs/system/mux-chardev.rst.inc
similarity index 87%
copy from docs/system/mux-chardev.rst
copy to docs/system/mux-chardev.rst.inc
index e50172c0815..84ea12cbf58 100644
--- a/docs/system/mux-chardev.rst
+++ b/docs/system/mux-chardev.rst.inc
@@ -1,8 +1,3 @@
-.. _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
diff --git a/docs/system/target-i386.rst b/docs/system/target-i386-desc.rst.inc
similarity index 76%
copy from docs/system/target-i386.rst
copy to docs/system/target-i386-desc.rst.inc
index 92e2038b11e..47a169e0ae2 100644
--- a/docs/system/target-i386.rst
+++ b/docs/system/target-i386-desc.rst.inc
@@ -1,13 +1,3 @@
-.. _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
@@ -70,15 +60,3 @@ Alternatively:
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-i386.rst b/docs/system/target-i386.rst
index 92e2038b11e..51be03d881f 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
--
2.20.1
^ permalink raw reply related [flat|nested] 82+ messages in thread* Re: [PATCH v3 28/33] docs: Split out sections for the manpage into .rst.inc files
2020-02-28 15:36 ` [PATCH v3 28/33] docs: Split out sections for the manpage into .rst.inc files Peter Maydell
@ 2020-03-02 12:24 ` Alex Bennée
0 siblings, 0 replies; 82+ messages in thread
From: Alex Bennée @ 2020-03-02 12:24 UTC (permalink / raw)
To: Peter Maydell; +Cc: Paolo Bonzini, qemu-devel, Kashyap Chamarthy
Peter Maydell <peter.maydell@linaro.org> writes:
> 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 <peter.maydell@linaro.org>
Reviewed-by: Alex Bennée <alex.bennee@linaro.org>
--
Alex Bennée
^ permalink raw reply [flat|nested] 82+ messages in thread
* [PATCH v3 29/33] docs: Generate qemu.1 manpage with Sphinx
2020-02-28 15:35 [PATCH v3 00/33] Convert qemu-doc to rST Peter Maydell
` (27 preceding siblings ...)
2020-02-28 15:36 ` [PATCH v3 28/33] docs: Split out sections for the manpage into .rst.inc files Peter Maydell
@ 2020-02-28 15:36 ` Peter Maydell
2020-03-02 12:24 ` Alex Bennée
2020-02-28 15:36 ` [PATCH v3 30/33] ui/cocoa.m: Update documentation file and pathname Peter Maydell
` (6 subsequent siblings)
35 siblings, 1 reply; 82+ messages in thread
From: Peter Maydell @ 2020-02-28 15:36 UTC (permalink / raw)
To: qemu-devel; +Cc: Paolo Bonzini, Kashyap Chamarthy
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 <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
diff --git a/Makefile b/Makefile
index f7d08997dbf..ef10b9a031d 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 23cab3fb364..6251849fefc 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 00000000000..e9a25d0680f
--- /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.
--
2.20.1
^ permalink raw reply related [flat|nested] 82+ messages in thread* Re: [PATCH v3 29/33] docs: Generate qemu.1 manpage with Sphinx
2020-02-28 15:36 ` [PATCH v3 29/33] docs: Generate qemu.1 manpage with Sphinx Peter Maydell
@ 2020-03-02 12:24 ` Alex Bennée
0 siblings, 0 replies; 82+ messages in thread
From: Alex Bennée @ 2020-03-02 12:24 UTC (permalink / raw)
To: Peter Maydell; +Cc: Paolo Bonzini, qemu-devel, Kashyap Chamarthy
Peter Maydell <peter.maydell@linaro.org> writes:
> 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 <peter.maydell@linaro.org>
Reviewed-by: Alex Bennée <alex.bennee@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
>
> diff --git a/Makefile b/Makefile
> index f7d08997dbf..ef10b9a031d 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 23cab3fb364..6251849fefc 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 00000000000..e9a25d0680f
> --- /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.
--
Alex Bennée
^ permalink raw reply [flat|nested] 82+ messages in thread
* [PATCH v3 30/33] ui/cocoa.m: Update documentation file and pathname
2020-02-28 15:35 [PATCH v3 00/33] Convert qemu-doc to rST Peter Maydell
` (28 preceding siblings ...)
2020-02-28 15:36 ` [PATCH v3 29/33] docs: Generate qemu.1 manpage with Sphinx Peter Maydell
@ 2020-02-28 15:36 ` Peter Maydell
2020-03-02 12:28 ` Alex Bennée
2020-02-28 15:36 ` [PATCH v3 31/33] docs: Stop building qemu-doc Peter Maydell
` (5 subsequent siblings)
35 siblings, 1 reply; 82+ messages in thread
From: Peter Maydell @ 2020-02-28 15:36 UTC (permalink / raw)
To: qemu-devel; +Cc: Paolo Bonzini, Kashyap Chamarthy
We want to stop generating the old qemu-doc.html; first we
must update places that refer to it so they instead go to
our top level index.html documentation landing page.
The Cocoa UI has a menu option to bring up the documentation;
make it point to the new top level index.html instead.
Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
---
ui/cocoa.m | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/ui/cocoa.m b/ui/cocoa.m
index 747a70839af..cb556e4e668 100644
--- a/ui/cocoa.m
+++ b/ui/cocoa.m
@@ -1174,7 +1174,7 @@ QemuCocoaView *cocoaView;
- (void) openDocumentation: (NSString *) filename
{
/* Where to look for local files */
- NSString *path_array[] = {@"../share/doc/qemu/", @"../doc/qemu/", @"../"};
+ NSString *path_array[] = {@"../share/doc/qemu/", @"../doc/qemu/", @"../docs/"};
NSString *full_file_path;
/* iterate thru the possible paths until the file is found */
@@ -1198,7 +1198,7 @@ QemuCocoaView *cocoaView;
{
COCOA_DEBUG("QemuCocoaAppController: showQEMUDoc\n");
- [self openDocumentation: @"qemu-doc.html"];
+ [self openDocumentation: @"index.html"];
}
/* Stretches video to fit host monitor size */
--
2.20.1
^ permalink raw reply related [flat|nested] 82+ messages in thread* Re: [PATCH v3 30/33] ui/cocoa.m: Update documentation file and pathname
2020-02-28 15:36 ` [PATCH v3 30/33] ui/cocoa.m: Update documentation file and pathname Peter Maydell
@ 2020-03-02 12:28 ` Alex Bennée
0 siblings, 0 replies; 82+ messages in thread
From: Alex Bennée @ 2020-03-02 12:28 UTC (permalink / raw)
To: Peter Maydell; +Cc: Paolo Bonzini, qemu-devel, Kashyap Chamarthy
Peter Maydell <peter.maydell@linaro.org> writes:
> We want to stop generating the old qemu-doc.html; first we
> must update places that refer to it so they instead go to
> our top level index.html documentation landing page.
> The Cocoa UI has a menu option to bring up the documentation;
> make it point to the new top level index.html instead.
>
> Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
Reviewed-by: Alex Bennée <alex.bennee@linaro.org>
--
Alex Bennée
^ permalink raw reply [flat|nested] 82+ messages in thread
* [PATCH v3 31/33] docs: Stop building qemu-doc
2020-02-28 15:35 [PATCH v3 00/33] Convert qemu-doc to rST Peter Maydell
` (29 preceding siblings ...)
2020-02-28 15:36 ` [PATCH v3 30/33] ui/cocoa.m: Update documentation file and pathname Peter Maydell
@ 2020-02-28 15:36 ` Peter Maydell
2020-03-02 12:32 ` Alex Bennée
2020-03-11 14:53 ` Markus Armbruster
2020-02-28 15:36 ` [PATCH v3 32/33] docs: Remove old texinfo sources Peter Maydell
` (4 subsequent siblings)
35 siblings, 2 replies; 82+ messages in thread
From: Peter Maydell @ 2020-02-28 15:36 UTC (permalink / raw)
To: qemu-devel; +Cc: Paolo Bonzini, Kashyap Chamarthy
Stop building the old texinfo qemu-doc; all its contents are
now available in the Sphinx-generated manuals and manpages.
Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
---
docs/specs/ivshmem-spec.txt | 4 ++--
Makefile | 39 ++++---------------------------------
.gitignore | 3 ---
docs/index.html.in | 1 -
4 files changed, 6 insertions(+), 41 deletions(-)
diff --git a/docs/specs/ivshmem-spec.txt b/docs/specs/ivshmem-spec.txt
index 042f7eae225..1beb3a01ec3 100644
--- a/docs/specs/ivshmem-spec.txt
+++ b/docs/specs/ivshmem-spec.txt
@@ -38,8 +38,8 @@ There are two basic configurations:
Interrupts are message-signaled (MSI-X). vectors=N configures the
number of vectors to use.
-For more details on ivshmem device properties, see The QEMU Emulator
-User Documentation (qemu-doc.*).
+For more details on ivshmem device properties, see the QEMU Emulator
+user documentation.
== The ivshmem PCI device's guest interface ==
diff --git a/Makefile b/Makefile
index ef10b9a031d..9d4b2241265 100644
--- a/Makefile
+++ b/Makefile
@@ -344,7 +344,6 @@ MANUAL_BUILDDIR := docs
endif
ifdef BUILD_DOCS
-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
@@ -768,10 +767,6 @@ distclean: clean
rm -f $(SUBDIR_DEVICES_MAK)
rm -f po/*.mo tests/qemu-iotests/common.env
rm -f roms/seabios/config.mak roms/vgabios/config.mak
- rm -f qemu-doc.info qemu-doc.aux qemu-doc.cp qemu-doc.cps
- rm -f qemu-doc.fn qemu-doc.fns qemu-doc.info qemu-doc.ky qemu-doc.kys
- rm -f qemu-doc.log qemu-doc.pdf qemu-doc.pg qemu-doc.toc qemu-doc.tp
- rm -f qemu-doc.vr qemu-doc.txt
rm -f qemu-plugins-ld.symbols qemu-plugins-ld64.symbols
rm -f config.log
rm -f linux-headers/asm
@@ -851,8 +846,6 @@ install-sphinxdocs: sphinxdocs
install-doc: $(DOCS) install-sphinxdocs
$(INSTALL_DIR) "$(DESTDIR)$(qemu_docdir)"
$(INSTALL_DATA) $(MANUAL_BUILDDIR)/index.html "$(DESTDIR)$(qemu_docdir)"
- $(INSTALL_DATA) qemu-doc.html "$(DESTDIR)$(qemu_docdir)"
- $(INSTALL_DATA) qemu-doc.txt "$(DESTDIR)$(qemu_docdir)"
$(INSTALL_DATA) docs/interop/qemu-qmp-ref.html "$(DESTDIR)$(qemu_docdir)"
$(INSTALL_DATA) docs/interop/qemu-qmp-ref.txt "$(DESTDIR)$(qemu_docdir)"
ifdef CONFIG_POSIX
@@ -1110,34 +1103,10 @@ 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 $< $@
-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
-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-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/system/deprecated.texi docs/system/qemu-option-trace.texi \
- docs/system/security.texi
+html: docs/interop/qemu-qmp-ref.html docs/interop/qemu-ga-ref.html sphinxdocs
+info: docs/interop/qemu-qmp-ref.info docs/interop/qemu-ga-ref.info
+pdf: docs/interop/qemu-qmp-ref.pdf docs/interop/qemu-ga-ref.pdf
+txt: docs/interop/qemu-qmp-ref.txt docs/interop/qemu-ga-ref.txt
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/.gitignore b/.gitignore
index bc0a035f9cc..0c5af83aa74 100644
--- a/.gitignore
+++ b/.gitignore
@@ -46,9 +46,6 @@
!/qapi/qapi-visit-core.c
/qapi/qapi-visit.[ch]
/qapi/qapi-doc.texi
-/qemu-doc.html
-/qemu-doc.info
-/qemu-doc.txt
/qemu-edid
/qemu-img
/qemu-nbd
diff --git a/docs/index.html.in b/docs/index.html.in
index a576ace8a27..cc19aad2ec5 100644
--- a/docs/index.html.in
+++ b/docs/index.html.in
@@ -7,7 +7,6 @@
<body>
<h1>QEMU @@VERSION@@ Documentation</h1>
<ul>
- <li><a href="qemu-doc.html">User Documentation</a></li>
<li><a href="qemu-qmp-ref.html">QMP Reference Manual</a></li>
<li><a href="qemu-ga-ref.html">Guest Agent Protocol Reference</a></li>
<li><a href="interop/index.html">System Emulation Management and Interoperability Guide</a></li>
--
2.20.1
^ permalink raw reply related [flat|nested] 82+ messages in thread* Re: [PATCH v3 31/33] docs: Stop building qemu-doc
2020-02-28 15:36 ` [PATCH v3 31/33] docs: Stop building qemu-doc Peter Maydell
@ 2020-03-02 12:32 ` Alex Bennée
2020-03-11 14:53 ` Markus Armbruster
1 sibling, 0 replies; 82+ messages in thread
From: Alex Bennée @ 2020-03-02 12:32 UTC (permalink / raw)
To: Peter Maydell; +Cc: Paolo Bonzini, qemu-devel, Kashyap Chamarthy
Peter Maydell <peter.maydell@linaro.org> writes:
> Stop building the old texinfo qemu-doc; all its contents are
> now available in the Sphinx-generated manuals and manpages.
>
> Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
Reviewed-by: Alex Bennée <alex.bennee@linaro.org>
--
Alex Bennée
^ permalink raw reply [flat|nested] 82+ messages in thread
* Re: [PATCH v3 31/33] docs: Stop building qemu-doc
2020-02-28 15:36 ` [PATCH v3 31/33] docs: Stop building qemu-doc Peter Maydell
2020-03-02 12:32 ` Alex Bennée
@ 2020-03-11 14:53 ` Markus Armbruster
2020-03-11 15:15 ` Peter Maydell
1 sibling, 1 reply; 82+ messages in thread
From: Markus Armbruster @ 2020-03-11 14:53 UTC (permalink / raw)
To: Peter Maydell; +Cc: Paolo Bonzini, qemu-devel, Kashyap Chamarthy
Peter Maydell <peter.maydell@linaro.org> writes:
> Stop building the old texinfo qemu-doc; all its contents are
> now available in the Sphinx-generated manuals and manpages.
>
> Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
This appears to lose plain text, PDF and info output. Any chance to get
plain text back?
^ permalink raw reply [flat|nested] 82+ messages in thread
* Re: [PATCH v3 31/33] docs: Stop building qemu-doc
2020-03-11 14:53 ` Markus Armbruster
@ 2020-03-11 15:15 ` Peter Maydell
2020-03-12 6:06 ` Markus Armbruster
0 siblings, 1 reply; 82+ messages in thread
From: Peter Maydell @ 2020-03-11 15:15 UTC (permalink / raw)
To: Markus Armbruster; +Cc: Paolo Bonzini, QEMU Developers, Kashyap Chamarthy
On Wed, 11 Mar 2020 at 14:53, Markus Armbruster <armbru@redhat.com> wrote:
> This appears to lose plain text, PDF and info output. Any chance to get
> plain text back?
This is deliberate. Consensus when we decided on the docs
transition plan was that plain text was not a useful output
format. (discussed in
https://lists.gnu.org/archive/html/qemu-devel/2019-05/msg04932.html
and following thread).
Sphinx does support text file generation, so you can if
you really want it generate it with something like
sphinx-build docs /tmp/docs-out -b text
but:
* it produces one text file per input file, so you might
as well just read the rST sources
* at least in the version of Sphinx I have, the text builder
does not implement some of the table markup we use,
so it will fall over partway with a NotImplementedError
PDF similarly is in theory possible via 'latex' builder
(and then running LaTeX on the results). You can also
download a PDF from
https://readthedocs.org/projects/qemu/downloads/
You will find that there are some bits where rendering
is not good (eg long lines that didn't get wrapped so were
just truncated).
Personally I think it's difficult enough managing two
output formats and checking that they look reasonable
(we already found places in the QAPI docs where
clearly nobody had looked at *any* of the rendered
formats) so I think settling on "our supported document
formats are HTML and manpage" is reasonable.
thanks
-- PMM
^ permalink raw reply [flat|nested] 82+ messages in thread
* Re: [PATCH v3 31/33] docs: Stop building qemu-doc
2020-03-11 15:15 ` Peter Maydell
@ 2020-03-12 6:06 ` Markus Armbruster
2020-03-12 10:11 ` Peter Maydell
0 siblings, 1 reply; 82+ messages in thread
From: Markus Armbruster @ 2020-03-12 6:06 UTC (permalink / raw)
To: Peter Maydell; +Cc: Paolo Bonzini, QEMU Developers, Kashyap Chamarthy
Peter Maydell <peter.maydell@linaro.org> writes:
> On Wed, 11 Mar 2020 at 14:53, Markus Armbruster <armbru@redhat.com> wrote:
>> This appears to lose plain text, PDF and info output. Any chance to get
>> plain text back?
>
> This is deliberate. Consensus when we decided on the docs
> transition plan was that plain text was not a useful output
> format. (discussed in
> https://lists.gnu.org/archive/html/qemu-devel/2019-05/msg04932.html
> and following thread).
I missed this part. Not your fault.
> Sphinx does support text file generation, so you can if
> you really want it generate it with something like
> sphinx-build docs /tmp/docs-out -b text
> but:
> * it produces one text file per input file, so you might
> as well just read the rST sources
> * at least in the version of Sphinx I have, the text builder
> does not implement some of the table markup we use,
> so it will fall over partway with a NotImplementedError
>
> PDF similarly is in theory possible via 'latex' builder
> (and then running LaTeX on the results). You can also
> download a PDF from
> https://readthedocs.org/projects/qemu/downloads/
> You will find that there are some bits where rendering
> is not good (eg long lines that didn't get wrapped so were
> just truncated).
>
> Personally I think it's difficult enough managing two
> output formats and checking that they look reasonable
> (we already found places in the QAPI docs where
> clearly nobody had looked at *any* of the rendered
> formats) so I think settling on "our supported document
> formats are HTML and manpage" is reasonable.
I see.
With plain text gone, I'll certainly look at any of the rendered stuff
even less than before.
Would it be possible to additionally render a complete manual as one
humongous .html? Without an index, there's only search, and the
ergonomics of searching within a single page are so much better.
I'm tempted to write a trivial QAPI doc comment backend to spit out
minimally processed doc comments as one plain text file just for that.
^ permalink raw reply [flat|nested] 82+ messages in thread
* Re: [PATCH v3 31/33] docs: Stop building qemu-doc
2020-03-12 6:06 ` Markus Armbruster
@ 2020-03-12 10:11 ` Peter Maydell
2020-03-12 13:16 ` Markus Armbruster
0 siblings, 1 reply; 82+ messages in thread
From: Peter Maydell @ 2020-03-12 10:11 UTC (permalink / raw)
To: Markus Armbruster; +Cc: Paolo Bonzini, QEMU Developers, Kashyap Chamarthy
On Thu, 12 Mar 2020 at 06:06, Markus Armbruster <armbru@redhat.com> wrote:
> Would it be possible to additionally render a complete manual as one
> humongous .html? Without an index, there's only search, and the
> ergonomics of searching within a single page are so much better.
There is a "build one big fat HTML page" Sphinx builder,
I think. But again, I'm dubious about increasing the number
of supported output formats -- it's all extra makefile complexity
and more things to get right in 'make install' and so on.
PS: assuming you have js enabled, each HTML manual has a js
search engine built in, eg the 'quick search' box at the bottom
of the LHS navigation bar on
https://www.qemu.org/docs/master/system/index.html
> I'm tempted to write a trivial QAPI doc comment backend to spit out
> minimally processed doc comments as one plain text file just for that.
What would be the difference there compared to just looking
at the manpage? The manpages don't have the full content
of all the HTML manuals, but the QAPI reference manpages
will have all the QAPI content.
thanks
-- PMM
^ permalink raw reply [flat|nested] 82+ messages in thread
* Re: [PATCH v3 31/33] docs: Stop building qemu-doc
2020-03-12 10:11 ` Peter Maydell
@ 2020-03-12 13:16 ` Markus Armbruster
0 siblings, 0 replies; 82+ messages in thread
From: Markus Armbruster @ 2020-03-12 13:16 UTC (permalink / raw)
To: Peter Maydell; +Cc: Paolo Bonzini, QEMU Developers, Kashyap Chamarthy
Peter Maydell <peter.maydell@linaro.org> writes:
> On Thu, 12 Mar 2020 at 06:06, Markus Armbruster <armbru@redhat.com> wrote:
>> Would it be possible to additionally render a complete manual as one
>> humongous .html? Without an index, there's only search, and the
>> ergonomics of searching within a single page are so much better.
>
> There is a "build one big fat HTML page" Sphinx builder,
> I think. But again, I'm dubious about increasing the number
> of supported output formats -- it's all extra makefile complexity
> and more things to get right in 'make install' and so on.
>
> PS: assuming you have js enabled, each HTML manual has a js
> search engine built in, eg the 'quick search' box at the bottom
> of the LHS navigation bar on
> https://www.qemu.org/docs/master/system/index.html
>
>> I'm tempted to write a trivial QAPI doc comment backend to spit out
>> minimally processed doc comments as one plain text file just for that.
>
> What would be the difference there compared to just looking
> at the manpage? The manpages don't have the full content
> of all the HTML manuals, but the QAPI reference manpages
> will have all the QAPI content.
I forgot qemu-qmp-ref.7 exists, and missed Paolo's hint earlier in this
thread. Thanks!
^ permalink raw reply [flat|nested] 82+ messages in thread
* [PATCH v3 32/33] docs: Remove old texinfo sources
2020-02-28 15:35 [PATCH v3 00/33] Convert qemu-doc to rST Peter Maydell
` (30 preceding siblings ...)
2020-02-28 15:36 ` [PATCH v3 31/33] docs: Stop building qemu-doc Peter Maydell
@ 2020-02-28 15:36 ` Peter Maydell
2020-03-02 12:34 ` Alex Bennée
2020-03-02 12:42 ` Kashyap Chamarthy
2020-02-28 15:36 ` [PATCH v3 33/33] *.hx: Remove all the STEXI/ETEXI blocks Peter Maydell
` (3 subsequent siblings)
35 siblings, 2 replies; 82+ messages in thread
From: Peter Maydell @ 2020-02-28 15:36 UTC (permalink / raw)
To: qemu-devel; +Cc: Paolo Bonzini, Kashyap Chamarthy
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 <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
diff --git a/MAINTAINERS b/MAINTAINERS
index 1712eb90851..45dd83b8b56 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
@@ -2234,7 +2232,7 @@ M: Stefan Hajnoczi <stefanha@redhat.com>
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*
@@ -2804,7 +2802,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 531ef5bed44..00000000000
--- 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 6a0370cb693..00000000000
--- 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 0cd64b0522e..00000000000
--- 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 <cpu> 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
- <cpu mode='host-passthrough'/>
-@end example
-
-With feature customization:
-
-@example
- <cpu mode='host-passthrough'>
- <feature name="vmx" policy="disable"/>
- ...
- </cpu>
-@end example
-
-@item Host model
-
-@example
- <cpu mode='host-model'/>
-@end example
-
-With feature customization:
-
-@example
- <cpu mode='host-model'>
- <feature name="vmx" policy="disable"/>
- ...
- </cpu>
-@end example
-
-@item Named model
-
-@example
- <cpu mode='custom'>
- <model name="Westmere"/>
- </cpu>
-@end example
-
-With feature customization:
-
-@example
- <cpu mode='custom'>
- <model name="Westmere"/>
- <feature name="pcid" policy="require"/>
- ...
- </cpu>
-@end example
-
-@end table
diff --git a/docs/system/deprecated.texi b/docs/system/deprecated.texi
deleted file mode 100644
index 66eca3a1ded..00000000000
--- 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 <file>`` - 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 f49bc5891e9..00000000000
--- 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 c5060348ecc..00000000000
--- 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 dac41cc7e55..00000000000
--- 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://<target-ip>[:<port>]/<target-iqn>/<lun>''
-
-By default qemu will use the iSCSI initiator-name
-'iqn.2008-11.org.linux-kvm[:<name>]' 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://<server-ip>[:<port>]/[<export>]''
-
-Syntax for specifying a NBD device using Unix Domain Sockets; remember
-that '?' is a shell glob character and may need quoting:
-``nbd+unix:///[<export>]?socket=<domain-socket>''
-
-Older syntax that is also recognized:
-``nbd:<server-ip>:<port>[:exportname=<export>]''
-
-Syntax for specifying a NBD device using Unix Domain Sockets
-``nbd:unix:<domain-socket>[:exportname=<export>]''
-
-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
-<protocol>://[<username>[:<password>]@@]<host>/<path>
-@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 <protocol>.
-
-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 bd97719eaf7..00000000000
--- 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 <shm size> 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 c04daf54f23..00000000000
--- 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 b682235a7e9..00000000000
--- 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 97c3cefae0a..00000000000
--- 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 ec168095cc4..00000000000
--- 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 b41b144885d..00000000000
--- 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 b21c2c56540..00000000000
--- 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 4a6fb2e6a8a..00000000000
--- 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 162f1528d21..00000000000
--- 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 baceaa96eb2..00000000000
--- 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 0d6b30edfc0..00000000000
--- 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 eb80dd35f0b..00000000000
--- 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 cc352b89a84..00000000000
--- 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 dcce7bc8c56..00000000000
--- 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 fe12ee94c73..00000000000
--- 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{<disk_image_file>} from @url{https://mipsdistros.mips.com/LinuxDistro/nanomips/buildroot/index.html}.
-
-Download @code{<kernel_image_file>} 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{<kernel_image_file>} \
- -M malta -serial stdio -m @code{<memory_size>} -hda @code{<disk_image_file>} \
- -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 5c83d4f68e7..00000000000
--- 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 99fbf820b42..00000000000
--- 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 d381d3af719..00000000000
--- 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 1e6c04dccd6..00000000000
--- 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 c233531d3a1..00000000000
--- 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 <<EOF
-cn = Name of your organization
-ca
-cert_signing_key
-EOF
-# certtool --generate-self-signed \
- --load-privkey ca-key.pem
- --template ca.info \
- --outfile ca-cert.pem
-@end example
-
-The @code{ca} keyword in the template sets the v3 basic constraints extension
-to indicate this certificate is for a CA, while @code{cert_signing_key} sets
-the key usage extension to indicate this will be used for signing other keys.
-The generated @code{ca-cert.pem} file should be copied to all servers and
-clients wishing to utilize TLS support in the VNC server. The @code{ca-key.pem}
-must not be disclosed/copied anywhere except the host responsible for issuing
-certificates.
-
-@node tls_generate_server
-@subsection Issuing server certificates
-
-Each server (or host) needs to be issued with a key and certificate. When connecting
-the certificate is sent to the client which validates it against the CA certificate.
-The core pieces of information for a server certificate are the hostnames and/or IP
-addresses that will be used by clients when connecting. The hostname / IP address
-that the client specifies when connecting will be validated against the hostname(s)
-and IP address(es) recorded in the server certificate, and if no match is found
-the client will close the connection.
-
-Thus it is recommended that the server certificate include both the fully qualified
-and unqualified hostnames. If the server will have permanently assigned IP address(es),
-and clients are likely to use them when connecting, they may also be included in the
-certificate. Both IPv4 and IPv6 addresses are supported. Historically certificates
-only included 1 hostname in the @code{CN} field, however, usage of this field for
-validation is now deprecated. Instead modern TLS clients will validate against the
-Subject Alt Name extension data, which allows for multiple entries. In the future
-usage of the @code{CN} field may be discontinued entirely, so providing SAN
-extension data is strongly recommended.
-
-On the host holding the CA, create template files containing the information
-for each server, and use it to issue server certificates.
-
-@example
-# cat > server-hostNNN.info <<EOF
-organization = Name of your organization
-cn = hostNNN.foo.example.com
-dns_name = hostNNN
-dns_name = hostNNN.foo.example.com
-ip_address = 10.0.1.87
-ip_address = 192.8.0.92
-ip_address = 2620:0:cafe::87
-ip_address = 2001:24::92
-tls_www_server
-encryption_key
-signing_key
-EOF
-# certtool --generate-privkey > 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 <<EOF
-country = GB
-state = London
-locality = City Of London
-organization = Name of your organization
-cn = hostNNN.foo.example.com
-tls_www_client
-encryption_key
-signing_key
-EOF
-# certtool --generate-privkey > 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 <<EOF
-country = GB
-state = London
-locality = City Of London
-organization = Name of your organization
-cn = hostNNN.foo.example.com
-dns_name = hostNNN
-dns_name = hostNNN.foo.example.com
-ip_address = 10.0.1.87
-ip_address = 192.8.0.92
-ip_address = 2620:0:cafe::87
-ip_address = 2001:24::92
-tls_www_server
-tls_www_client
-encryption_key
-signing_key
-EOF
-# certtool --generate-privkey > 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 840adac9785..00000000000
--- 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 abf7f7fa43a..00000000000
--- 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 c2b9c87c645..00000000000
--- 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
--
2.20.1
^ permalink raw reply related [flat|nested] 82+ messages in thread* Re: [PATCH v3 32/33] docs: Remove old texinfo sources
2020-02-28 15:36 ` [PATCH v3 32/33] docs: Remove old texinfo sources Peter Maydell
@ 2020-03-02 12:34 ` Alex Bennée
2020-03-02 12:42 ` Kashyap Chamarthy
1 sibling, 0 replies; 82+ messages in thread
From: Alex Bennée @ 2020-03-02 12:34 UTC (permalink / raw)
To: Peter Maydell; +Cc: Paolo Bonzini, qemu-devel, Kashyap Chamarthy
Peter Maydell <peter.maydell@linaro.org> writes:
> 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 <peter.maydell@linaro.org>
Reviewed-by: Alex Bennée <alex.bennee@linaro.org>
--
Alex Bennée
^ permalink raw reply [flat|nested] 82+ messages in thread
* Re: [PATCH v3 32/33] docs: Remove old texinfo sources
2020-02-28 15:36 ` [PATCH v3 32/33] docs: Remove old texinfo sources Peter Maydell
2020-03-02 12:34 ` Alex Bennée
@ 2020-03-02 12:42 ` Kashyap Chamarthy
1 sibling, 0 replies; 82+ messages in thread
From: Kashyap Chamarthy @ 2020-03-02 12:42 UTC (permalink / raw)
To: Peter Maydell; +Cc: Paolo Bonzini, qemu-devel
On Fri, Feb 28, 2020 at 03:36:18PM +0000, Peter Maydell wrote:
> 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 <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(-)
Nice diff-stat; "negative code" for the win! :-)
(Yes, yes, we do add them back in a different form elsewhere...)
Reviewed-by: Kashyap Chamarthy <kchamart@redhat.com>
[...]
--
/kashyap
^ permalink raw reply [flat|nested] 82+ messages in thread
* [PATCH v3 33/33] *.hx: Remove all the STEXI/ETEXI blocks
2020-02-28 15:35 [PATCH v3 00/33] Convert qemu-doc to rST Peter Maydell
` (31 preceding siblings ...)
2020-02-28 15:36 ` [PATCH v3 32/33] docs: Remove old texinfo sources Peter Maydell
@ 2020-02-28 15:36 ` Peter Maydell
2020-03-02 12:36 ` Alex Bennée
2020-02-28 18:36 ` [PATCH v3 00/33] Convert qemu-doc to rST Peter Maydell
` (2 subsequent siblings)
35 siblings, 1 reply; 82+ messages in thread
From: Peter Maydell @ 2020-02-28 15:36 UTC (permalink / raw)
To: qemu-devel; +Cc: Paolo Bonzini, Kashyap Chamarthy
We no longer generate texinfo from the hxtool input files,
so delete all the STEXI/ETEXI blocks.
This commit was created using the following Perl one-liner:
perl -i -n -e '$suppress = 1,next if /^STEXI/;$suppress=0,next if /^ETEXI/; print if !$suppress;' *.hx
Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
---
hmp-commands-info.hx | 329 ----
hmp-commands.hx | 821 ---------
qemu-options.hx | 4054 ------------------------------------------
3 files changed, 5204 deletions(-)
diff --git a/hmp-commands-info.hx b/hmp-commands-info.hx
index 1730f866cde..499d6d54b01 100644
--- a/hmp-commands-info.hx
+++ b/hmp-commands-info.hx
@@ -11,13 +11,6 @@ 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
-@item info @var{subcommand}
-@findex info
-Show various information about the system state.
-@table @option
-ETEXI
SRST
``info`` *subcommand*
Show various information about the system state.
@@ -33,11 +26,6 @@ ERST
.flags = "p",
},
-STEXI
-@item info version
-@findex info version
-Show the version of QEMU.
-ETEXI
SRST
``info version``
Show the version of QEMU.
@@ -51,11 +39,6 @@ ERST
.cmd = hmp_info_network,
},
-STEXI
-@item info network
-@findex info network
-Show the network state.
-ETEXI
SRST
``info network``
Show the network state.
@@ -70,11 +53,6 @@ ERST
.flags = "p",
},
-STEXI
-@item info chardev
-@findex info chardev
-Show the character devices.
-ETEXI
SRST
``info chardev``
Show the character devices.
@@ -89,11 +67,6 @@ ERST
.cmd = hmp_info_block,
},
-STEXI
-@item info block
-@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.
@@ -107,11 +80,6 @@ ERST
.cmd = hmp_info_blockstats,
},
-STEXI
-@item info blockstats
-@findex info blockstats
-Show block device statistics.
-ETEXI
SRST
``info blockstats``
Show block device statistics.
@@ -125,11 +93,6 @@ ERST
.cmd = hmp_info_block_jobs,
},
-STEXI
-@item info block-jobs
-@findex info block-jobs
-Show progress of ongoing block device operations.
-ETEXI
SRST
``info block-jobs``
Show progress of ongoing block device operations.
@@ -143,11 +106,6 @@ ERST
.cmd = hmp_info_registers,
},
-STEXI
-@item info registers
-@findex info registers
-Show the cpu registers.
-ETEXI
SRST
``info registers``
Show the cpu registers.
@@ -164,11 +122,6 @@ ERST
},
#endif
-STEXI
-@item info lapic
-@findex info lapic
-Show local APIC state
-ETEXI
SRST
``info lapic``
Show local APIC state
@@ -184,11 +137,6 @@ ERST
},
#endif
-STEXI
-@item info ioapic
-@findex info ioapic
-Show io APIC state
-ETEXI
SRST
``info ioapic``
Show io APIC state
@@ -202,11 +150,6 @@ ERST
.cmd = hmp_info_cpus,
},
-STEXI
-@item info cpus
-@findex info cpus
-Show infos for each CPU.
-ETEXI
SRST
``info cpus``
Show infos for each CPU.
@@ -221,11 +164,6 @@ ERST
.flags = "p",
},
-STEXI
-@item info history
-@findex info history
-Show the command line history.
-ETEXI
SRST
``info history``
Show the command line history.
@@ -239,11 +177,6 @@ ERST
.cmd = hmp_info_irq,
},
-STEXI
-@item info irq
-@findex info irq
-Show the interrupts statistics (if available).
-ETEXI
SRST
``info irq``
Show the interrupts statistics (if available).
@@ -257,11 +190,6 @@ ERST
.cmd = hmp_info_pic,
},
-STEXI
-@item info pic
-@findex info pic
-Show PIC state.
-ETEXI
SRST
``info pic``
Show PIC state.
@@ -275,11 +203,6 @@ ERST
.cmd = hmp_info_rdma,
},
-STEXI
-@item info rdma
-@findex info rdma
-Show RDMA state.
-ETEXI
SRST
``info rdma``
Show RDMA state.
@@ -293,11 +216,6 @@ ERST
.cmd = hmp_info_pci,
},
-STEXI
-@item info pci
-@findex info pci
-Show PCI information.
-ETEXI
SRST
``info pci``
Show PCI information.
@@ -314,11 +232,6 @@ ERST
},
#endif
-STEXI
-@item info tlb
-@findex info tlb
-Show virtual to physical memory mappings.
-ETEXI
SRST
``info tlb``
Show virtual to physical memory mappings.
@@ -334,11 +247,6 @@ ERST
},
#endif
-STEXI
-@item info mem
-@findex info mem
-Show the active virtual memory mappings.
-ETEXI
SRST
``info mem``
Show the active virtual memory mappings.
@@ -354,11 +262,6 @@ ERST
.cmd = hmp_info_mtree,
},
-STEXI
-@item info mtree
-@findex info mtree
-Show memory tree.
-ETEXI
SRST
``info mtree``
Show memory tree.
@@ -374,11 +277,6 @@ ERST
},
#endif
-STEXI
-@item info jit
-@findex info jit
-Show dynamic compiler info.
-ETEXI
SRST
``info jit``
Show dynamic compiler info.
@@ -394,11 +292,6 @@ ERST
},
#endif
-STEXI
-@item info opcount
-@findex info opcount
-Show dynamic compiler opcode counters
-ETEXI
SRST
``info opcount``
Show dynamic compiler opcode counters
@@ -415,16 +308,6 @@ ERST
.cmd = hmp_info_sync_profile,
},
-STEXI
-@item info sync-profile [-m|-n] [@var{max}]
-@findex info sync-profile
-Show synchronization profiling info, up to @var{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.
-ETEXI
SRST
``info sync-profile [-m|-n]`` [*max*]
Show synchronization profiling info, up to *max* entries (default: 10),
@@ -448,11 +331,6 @@ ERST
.cmd = hmp_info_kvm,
},
-STEXI
-@item info kvm
-@findex info kvm
-Show KVM information.
-ETEXI
SRST
``info kvm``
Show KVM information.
@@ -466,11 +344,6 @@ ERST
.cmd = hmp_info_numa,
},
-STEXI
-@item info numa
-@findex info numa
-Show NUMA information.
-ETEXI
SRST
``info numa``
Show NUMA information.
@@ -484,11 +357,6 @@ ERST
.cmd = hmp_info_usb,
},
-STEXI
-@item info usb
-@findex info usb
-Show guest USB devices.
-ETEXI
SRST
``info usb``
Show guest USB devices.
@@ -502,11 +370,6 @@ ERST
.cmd = hmp_info_usbhost,
},
-STEXI
-@item info usbhost
-@findex info usbhost
-Show host USB devices.
-ETEXI
SRST
``info usbhost``
Show host USB devices.
@@ -520,11 +383,6 @@ ERST
.cmd = hmp_info_profile,
},
-STEXI
-@item info profile
-@findex info profile
-Show profiling information.
-ETEXI
SRST
``info profile``
Show profiling information.
@@ -538,11 +396,6 @@ ERST
.cmd = hmp_info_capture,
},
-STEXI
-@item info capture
-@findex info capture
-Show capture information.
-ETEXI
SRST
``info capture``
Show capture information.
@@ -556,11 +409,6 @@ ERST
.cmd = hmp_info_snapshots,
},
-STEXI
-@item info snapshots
-@findex info snapshots
-Show the currently saved VM snapshots.
-ETEXI
SRST
``info snapshots``
Show the currently saved VM snapshots.
@@ -575,11 +423,6 @@ ERST
.flags = "p",
},
-STEXI
-@item info status
-@findex info status
-Show the current VM status (running|paused).
-ETEXI
SRST
``info status``
Show the current VM status (running|paused).
@@ -593,11 +436,6 @@ ERST
.cmd = hmp_info_mice,
},
-STEXI
-@item info mice
-@findex info mice
-Show which guest mouse is receiving events.
-ETEXI
SRST
``info mice``
Show which guest mouse is receiving events.
@@ -613,11 +451,6 @@ ERST
},
#endif
-STEXI
-@item info vnc
-@findex info vnc
-Show the vnc server status.
-ETEXI
SRST
``info vnc``
Show the vnc server status.
@@ -633,11 +466,6 @@ ERST
},
#endif
-STEXI
-@item info spice
-@findex info spice
-Show the spice server status.
-ETEXI
SRST
``info spice``
Show the spice server status.
@@ -652,11 +480,6 @@ ERST
.flags = "p",
},
-STEXI
-@item info name
-@findex info name
-Show the current VM name.
-ETEXI
SRST
``info name``
Show the current VM name.
@@ -671,11 +494,6 @@ ERST
.flags = "p",
},
-STEXI
-@item info uuid
-@findex info uuid
-Show the current VM UUID.
-ETEXI
SRST
``info uuid``
Show the current VM UUID.
@@ -689,11 +507,6 @@ ERST
.cmd = hmp_info_cpustats,
},
-STEXI
-@item info cpustats
-@findex info cpustats
-Show CPU statistics.
-ETEXI
SRST
``info cpustats``
Show CPU statistics.
@@ -709,11 +522,6 @@ ERST
},
#endif
-STEXI
-@item info usernet
-@findex info usernet
-Show user network stack connection states.
-ETEXI
SRST
``info usernet``
Show user network stack connection states.
@@ -727,11 +535,6 @@ ERST
.cmd = hmp_info_migrate,
},
-STEXI
-@item info migrate
-@findex info migrate
-Show migration status.
-ETEXI
SRST
``info migrate``
Show migration status.
@@ -745,11 +548,6 @@ ERST
.cmd = hmp_info_migrate_capabilities,
},
-STEXI
-@item info migrate_capabilities
-@findex info migrate_capabilities
-Show current migration capabilities.
-ETEXI
SRST
``info migrate_capabilities``
Show current migration capabilities.
@@ -763,11 +561,6 @@ ERST
.cmd = hmp_info_migrate_parameters,
},
-STEXI
-@item info migrate_parameters
-@findex info migrate_parameters
-Show current migration parameters.
-ETEXI
SRST
``info migrate_parameters``
Show current migration parameters.
@@ -781,11 +574,6 @@ ERST
.cmd = hmp_info_migrate_cache_size,
},
-STEXI
-@item info migrate_cache_size
-@findex info migrate_cache_size
-Show current migration xbzrle cache size.
-ETEXI
SRST
``info migrate_cache_size``
Show current migration xbzrle cache size.
@@ -799,11 +587,6 @@ ERST
.cmd = hmp_info_balloon,
},
-STEXI
-@item info balloon
-@findex info balloon
-Show balloon information.
-ETEXI
SRST
``info balloon``
Show balloon information.
@@ -817,11 +600,6 @@ ERST
.cmd = hmp_info_qtree,
},
-STEXI
-@item info qtree
-@findex info qtree
-Show device tree.
-ETEXI
SRST
``info qtree``
Show device tree.
@@ -835,11 +613,6 @@ ERST
.cmd = hmp_info_qdm,
},
-STEXI
-@item info qdm
-@findex info qdm
-Show qdev device model list.
-ETEXI
SRST
``info qdm``
Show qdev device model list.
@@ -854,11 +627,6 @@ ERST
.flags = "p",
},
-STEXI
-@item info qom-tree
-@findex info qom-tree
-Show QOM composition tree.
-ETEXI
SRST
``info qom-tree``
Show QOM composition tree.
@@ -872,11 +640,6 @@ ERST
.cmd = hmp_info_roms,
},
-STEXI
-@item info roms
-@findex info roms
-Show roms.
-ETEXI
SRST
``info roms``
Show roms.
@@ -892,11 +655,6 @@ ERST
.command_completion = info_trace_events_completion,
},
-STEXI
-@item info trace-events
-@findex info trace-events
-Show available trace-events & their state.
-ETEXI
SRST
``info trace-events``
Show available trace-events & their state.
@@ -910,11 +668,6 @@ ERST
.cmd = hmp_info_tpm,
},
-STEXI
-@item info tpm
-@findex info tpm
-Show the TPM device.
-ETEXI
SRST
``info tpm``
Show the TPM device.
@@ -929,11 +682,6 @@ ERST
.flags = "p",
},
-STEXI
-@item info memdev
-@findex info memdev
-Show memory backends
-ETEXI
SRST
``info memdev``
Show memory backends
@@ -947,11 +695,6 @@ ERST
.cmd = hmp_info_memory_devices,
},
-STEXI
-@item info memory-devices
-@findex info memory-devices
-Show memory devices.
-ETEXI
SRST
``info memory-devices``
Show memory devices.
@@ -966,11 +709,6 @@ ERST
.flags = "p",
},
-STEXI
-@item info iothreads
-@findex info iothreads
-Show iothread's identifiers.
-ETEXI
SRST
``info iothreads``
Show iothread's identifiers.
@@ -984,11 +722,6 @@ ERST
.cmd = hmp_rocker,
},
-STEXI
-@item info rocker @var{name}
-@findex info rocker
-Show rocker switch.
-ETEXI
SRST
``info rocker`` *name*
Show rocker switch.
@@ -1002,11 +735,6 @@ ERST
.cmd = hmp_rocker_ports,
},
-STEXI
-@item info rocker-ports @var{name}-ports
-@findex info rocker-ports
-Show rocker ports.
-ETEXI
SRST
``info rocker-ports`` *name*-ports
Show rocker ports.
@@ -1020,11 +748,6 @@ ERST
.cmd = hmp_rocker_of_dpa_flows,
},
-STEXI
-@item info rocker-of-dpa-flows @var{name} [@var{tbl_id}]
-@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.
@@ -1038,11 +761,6 @@ ERST
.cmd = hmp_rocker_of_dpa_groups,
},
-STEXI
-@item info rocker-of-dpa-groups @var{name} [@var{type}]
-@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.
@@ -1058,11 +776,6 @@ ERST
},
#endif
-STEXI
-@item info skeys @var{address}
-@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)
@@ -1078,11 +791,6 @@ ERST
},
#endif
-STEXI
-@item info cmma @var{address}
-@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
@@ -1097,11 +805,6 @@ ERST
.cmd = hmp_info_dump,
},
-STEXI
-@item info dump
-@findex info dump
-Display the latest dump status.
-ETEXI
SRST
``info dump``
Display the latest dump status.
@@ -1115,11 +818,6 @@ ERST
.cmd = hmp_info_ramblock,
},
-STEXI
-@item info ramblock
-@findex info ramblock
-Dump all the ramblocks of the system.
-ETEXI
SRST
``info ramblock``
Dump all the ramblocks of the system.
@@ -1134,11 +832,6 @@ ERST
.flags = "p",
},
-STEXI
-@item info hotpluggable-cpus
-@findex info hotpluggable-cpus
-Show information about hotpluggable CPUs
-ETEXI
SRST
``info hotpluggable-cpus``
Show information about hotpluggable CPUs
@@ -1152,11 +845,6 @@ ERST
.cmd = hmp_info_vm_generation_id,
},
-STEXI
-@item info vm-generation-id
-@findex info vm-generation-id
-Show Virtual Machine Generation ID
-ETEXI
SRST
``info vm-generation-id``
Show Virtual Machine Generation ID
@@ -1171,12 +859,6 @@ ERST
.cmd = hmp_info_memory_size_summary,
},
-STEXI
-@item info memory_size_summary
-@findex info memory_size_summary
-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
@@ -1193,20 +875,9 @@ ERST
},
#endif
-STEXI
-@item info sev
-@findex info sev
-Show SEV information.
-ETEXI
SRST
``info sev``
Show SEV information.
ERST
-STEXI
-@end table
-ETEXI
-STEXI
-@end table
-ETEXI
diff --git a/hmp-commands.hx b/hmp-commands.hx
index 9aa59f52312..eb3d1605fd6 100644
--- a/hmp-commands.hx
+++ b/hmp-commands.hx
@@ -5,9 +5,6 @@ HXCOMM DEF(command, args, callback, arg_string, help) is used to construct
HXCOMM monitor commands
HXCOMM HXCOMM can be used for comments, discarded from both texi and C
-STEXI
-@table @option
-ETEXI
{
.name = "help|?",
@@ -18,11 +15,6 @@ ETEXI
.flags = "p",
},
-STEXI
-@item help or ? [@var{cmd}]
-@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*.
@@ -36,16 +28,6 @@ ERST
.cmd = hmp_commit,
},
-STEXI
-@item commit
-@findex 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.
-ETEXI
SRST
``commit``
Commit changes to the disk images (if -snapshot is used) or backing files.
@@ -65,11 +47,6 @@ ERST
.cmd = hmp_quit,
},
-STEXI
-@item q or quit
-@findex quit
-Quit the emulator.
-ETEXI
SRST
``q`` or ``quit``
Quit the emulator.
@@ -84,15 +61,6 @@ ERST
.flags = "p",
},
-STEXI
-@item exit_preconfig
-@findex 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).
-ETEXI
SRST
``exit_preconfig``
This command makes QEMU exit the preconfig state and proceed with
@@ -110,14 +78,6 @@ ERST
.cmd = hmp_block_resize,
},
-STEXI
-@item block_resize
-@findex 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.
-ETEXI
SRST
``block_resize``
Resize a block image while a guest is running. Usually requires guest
@@ -134,11 +94,6 @@ ERST
.cmd = hmp_block_stream,
},
-STEXI
-@item block_stream
-@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.
@@ -152,11 +107,6 @@ ERST
.cmd = hmp_block_job_set_speed,
},
-STEXI
-@item block_job_set_speed
-@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.
@@ -172,11 +122,6 @@ ERST
.cmd = hmp_block_job_cancel,
},
-STEXI
-@item block_job_cancel
-@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).
@@ -190,12 +135,6 @@ ERST
.cmd = hmp_block_job_complete,
},
-STEXI
-@item block_job_complete
-@findex block_job_complete
-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.
@@ -210,11 +149,6 @@ ERST
.cmd = hmp_block_job_pause,
},
-STEXI
-@item block_job_pause
-@findex block_job_pause
-Pause an active block streaming operation.
-ETEXI
SRST
``block_job_pause``
Pause an active block streaming operation.
@@ -228,11 +162,6 @@ ERST
.cmd = hmp_block_job_resume,
},
-STEXI
-@item block_job_resume
-@findex block_job_resume
-Resume a paused block streaming operation.
-ETEXI
SRST
``block_job_resume``
Resume a paused block streaming operation.
@@ -246,11 +175,6 @@ ERST
.cmd = hmp_eject,
},
-STEXI
-@item eject [-f] @var{device}
-@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).
@@ -264,16 +188,6 @@ ERST
.cmd = hmp_drive_del,
},
-STEXI
-@item drive_del @var{device}
-@findex drive_del
-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).
-ETEXI
SRST
``drive_del`` *device*
Remove host block device. The result is that guest generated IO is no longer
@@ -292,56 +206,6 @@ ERST
.cmd = hmp_change,
},
-STEXI
-@item change @var{device} @var{setting}
-@findex change
-Change the configuration of a device.
-
-@table @option
-@item change @var{diskdevice} @var{filename} [@var{format} [@var{read-only-mode}]]
-Change the medium for a removable disk device to point to @var{filename}. eg
-
-@example
-(qemu) change ide1-cd0 /path/to/some.iso
-@end example
-
-@var{format} is optional.
-
-@var{read-only-mode} may be used to change the read-only status of the device.
-It accepts the following values:
-
-@table @var
-@item retain
-Retains the current status; this is the default.
-
-@item read-only
-Makes the device read-only.
-
-@item read-write
-Makes the device writable.
-@end table
-
-@item change vnc @var{display},@var{options}
-Change the configuration of the VNC server. The valid syntax for @var{display}
-and @var{options} are described at @ref{sec_invocation}. eg
-
-@example
-(qemu) change vnc localhost:1
-@end example
-
-@item change vnc password [@var{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
-
-@example
-(qemu) change vnc password
-Password: ********
-@end example
-
-@end table
-ETEXI
SRST
``change`` *device* *setting*
Change the configuration of a device.
@@ -391,11 +255,6 @@ ERST
.cmd = hmp_screendump,
},
-STEXI
-@item screendump @var{filename}
-@findex screendump
-Save screen into PPM image @var{filename}.
-ETEXI
SRST
``screendump`` *filename*
Save screen into PPM image *filename*.
@@ -409,11 +268,6 @@ ERST
.cmd = hmp_logfile,
},
-STEXI
-@item logfile @var{filename}
-@findex logfile
-Output logs to @var{filename}.
-ETEXI
SRST
``logfile`` *filename*
Output logs to *filename*.
@@ -429,11 +283,6 @@ ERST
.command_completion = trace_event_completion,
},
-STEXI
-@item trace-event
-@findex trace-event
-changes status of a trace event
-ETEXI
SRST
``trace-event``
changes status of a trace event
@@ -448,11 +297,6 @@ ERST
.cmd = hmp_trace_file,
},
-STEXI
-@item trace-file on|off|flush
-@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
@@ -468,11 +312,6 @@ ERST
.cmd = hmp_log,
},
-STEXI
-@item log @var{item1}[,...]
-@findex log
-Activate logging of the specified items.
-ETEXI
SRST
``log`` *item1*\ [,...]
Activate logging of the specified items.
@@ -486,17 +325,6 @@ ERST
.cmd = hmp_savevm,
},
-STEXI
-@item savevm @var{tag}
-@findex savevm
-Create a snapshot of the whole virtual machine. If @var{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_snapshots}.
-
-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
@@ -517,14 +345,6 @@ ERST
.command_completion = loadvm_completion,
},
-STEXI
-@item loadvm @var{tag}
-@findex loadvm
-Set the whole virtual machine to the snapshot identified by the tag
-@var{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
@@ -542,14 +362,6 @@ ERST
.command_completion = delvm_completion,
},
-STEXI
-@item delvm @var{tag}
-@findex delvm
-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*.
@@ -566,12 +378,6 @@ ERST
.cmd = hmp_singlestep,
},
-STEXI
-@item singlestep [off]
-@findex singlestep
-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.
@@ -586,11 +392,6 @@ ERST
.cmd = hmp_stop,
},
-STEXI
-@item stop
-@findex stop
-Stop emulation.
-ETEXI
SRST
``stop``
Stop emulation.
@@ -604,11 +405,6 @@ ERST
.cmd = hmp_cont,
},
-STEXI
-@item c or cont
-@findex cont
-Resume emulation.
-ETEXI
SRST
``c`` or ``cont``
Resume emulation.
@@ -622,11 +418,6 @@ ERST
.cmd = hmp_system_wakeup,
},
-STEXI
-@item system_wakeup
-@findex system_wakeup
-Wakeup guest from suspend.
-ETEXI
SRST
``system_wakeup``
Wakeup guest from suspend.
@@ -640,11 +431,6 @@ ERST
.cmd = hmp_gdbserver,
},
-STEXI
-@item gdbserver [@var{port}]
-@findex gdbserver
-Start gdbserver session (default @var{port}=1234)
-ETEXI
SRST
``gdbserver`` [*port*]
Start gdbserver session (default *port*\=1234)
@@ -658,11 +444,6 @@ ERST
.cmd = hmp_memory_dump,
},
-STEXI
-@item x/fmt @var{addr}
-@findex x
-Virtual memory dump starting at @var{addr}.
-ETEXI
SRST
``x/``\ *fmt* *addr*
Virtual memory dump starting at *addr*.
@@ -676,64 +457,6 @@ ERST
.cmd = hmp_physical_memory_dump,
},
-STEXI
-@item xp /@var{fmt} @var{addr}
-@findex xp
-Physical memory dump starting at @var{addr}.
-
-@var{fmt} is a format which tells the command how to format the
-data. Its syntax is: @option{/@{count@}@{format@}@{size@}}
-
-@table @var
-@item count
-is the number of items to be dumped.
-
-@item format
-can be x (hex), d (signed decimal), u (unsigned decimal), o (octal),
-c (char) or i (asm instruction).
-
-@item size
-can be b (8 bits), h (16 bits), w (32 bits) or g (64 bits). On x86,
-@code{h} or @code{w} can be specified with the @code{i} format to
-respectively select 16 or 32 bit code instruction size.
-
-@end table
-
-Examples:
-@itemize
-@item
-Dump 10 instructions at the current instruction pointer:
-@example
-(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
-@end example
-
-@item
-Dump 80 16 bit values at the start of the video memory.
-@smallexample
-(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
-@end smallexample
-@end itemize
-ETEXI
SRST
``xp /``\ *fmt* *addr*
Physical memory dump starting at *addr*.
@@ -791,12 +514,6 @@ ERST
.cmd = hmp_gpa2hva,
},
-STEXI
-@item gpa2hva @var{addr}
-@findex gpa2hva
-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*
@@ -813,12 +530,6 @@ ERST
},
#endif
-STEXI
-@item gpa2hpa @var{addr}
-@findex gpa2hpa
-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*
@@ -833,12 +544,6 @@ ERST
.cmd = hmp_gva2gpa,
},
-STEXI
-@item gva2gpa @var{addr}
-@findex gva2gpa
-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*
@@ -853,12 +558,6 @@ ERST
.cmd = do_print,
},
-STEXI
-@item p or print/@var{fmt} @var{expr}
-@findex print
-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
@@ -873,11 +572,6 @@ ERST
.cmd = hmp_ioport_read,
},
-STEXI
-@item i/@var{fmt} @var{addr} [.@var{index}]
-@findex i
-Read I/O port.
-ETEXI
SRST
``i/``\ *fmt* *addr* [.\ *index*\ ]
Read I/O port.
@@ -891,11 +585,6 @@ ERST
.cmd = hmp_ioport_write,
},
-STEXI
-@item o/@var{fmt} @var{addr} @var{val}
-@findex o
-Write to I/O port.
-ETEXI
SRST
``o/``\ *fmt* *addr* *val*
Write to I/O port.
@@ -910,19 +599,6 @@ ERST
.command_completion = sendkey_completion,
},
-STEXI
-@item sendkey @var{keys}
-@findex sendkey
-Send @var{keys} to the guest. @var{keys} could be the name of the
-key or the raw value in hexadecimal format. Use @code{-} to press
-several keys simultaneously. Example:
-@example
-sendkey ctrl-alt-f1
-@end example
-
-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
@@ -943,12 +619,6 @@ ERST
.cmd = hmp_sync_profile,
},
-STEXI
-@item sync-profile [on|off|reset]
-@findex sync-profile
-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
@@ -963,11 +633,6 @@ ERST
.cmd = hmp_system_reset,
},
-STEXI
-@item system_reset
-@findex system_reset
-Reset the system.
-ETEXI
SRST
``system_reset``
Reset the system.
@@ -981,11 +646,6 @@ ERST
.cmd = hmp_system_powerdown,
},
-STEXI
-@item system_powerdown
-@findex system_powerdown
-Power down the system (if supported).
-ETEXI
SRST
``system_powerdown``
Power down the system (if supported).
@@ -999,11 +659,6 @@ ERST
.cmd = hmp_sum,
},
-STEXI
-@item sum @var{addr} @var{size}
-@findex sum
-Compute the checksum of a memory region.
-ETEXI
SRST
``sum`` *addr* *size*
Compute the checksum of a memory region.
@@ -1018,11 +673,6 @@ ERST
.command_completion = device_add_completion,
},
-STEXI
-@item device_add @var{config}
-@findex device_add
-Add device.
-ETEXI
SRST
``device_add`` *config*
Add device.
@@ -1037,12 +687,6 @@ ERST
.command_completion = device_del_completion,
},
-STEXI
-@item device_del @var{id}
-@findex device_del
-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
@@ -1057,11 +701,6 @@ ERST
.cmd = hmp_cpu,
},
-STEXI
-@item cpu @var{index}
-@findex cpu
-Set the default CPU.
-ETEXI
SRST
``cpu`` *index*
Set the default CPU.
@@ -1075,12 +714,6 @@ ERST
.cmd = hmp_mouse_move,
},
-STEXI
-@item mouse_move @var{dx} @var{dy} [@var{dz}]
-@findex mouse_move
-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*
@@ -1095,11 +728,6 @@ ERST
.cmd = hmp_mouse_button,
},
-STEXI
-@item mouse_button @var{val}
-@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).
@@ -1113,15 +741,6 @@ ERST
.cmd = hmp_mouse_set,
},
-STEXI
-@item mouse_set @var{index}
-@findex mouse_set
-Set which mouse device receives events at given @var{index}, index
-can be obtained with
-@example
-info mice
-@end example
-ETEXI
SRST
``mouse_set`` *index*
Set which mouse device receives events at given *index*, index
@@ -1138,20 +757,6 @@ ERST
.help = "capture audio to a wave file (default frequency=44100 bits=16 channels=2)",
.cmd = hmp_wavcapture,
},
-STEXI
-@item wavcapture @var{filename} @var{audiodev} [@var{frequency} [@var{bits} [@var{channels}]]]
-@findex wavcapture
-Capture audio into @var{filename} from @var{audiodev}, using sample rate
-@var{frequency} bits per sample @var{bits} and number of channels
-@var{channels}.
-
-Defaults:
-@itemize @minus
-@item Sample rate = 44100 Hz - CD quality
-@item Bits = 16
-@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
@@ -1172,14 +777,6 @@ ERST
.help = "stop capture",
.cmd = hmp_stopcapture,
},
-STEXI
-@item stopcapture @var{index}
-@findex stopcapture
-Stop capture with a given @var{index}, index can be obtained with
-@example
-info capture
-@end example
-ETEXI
SRST
``stopcapture`` *index*
Stop capture with a given *index*, index can be obtained with::
@@ -1196,11 +793,6 @@ ERST
.cmd = hmp_memsave,
},
-STEXI
-@item memsave @var{addr} @var{size} @var{file}
-@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*.
@@ -1214,11 +806,6 @@ ERST
.cmd = hmp_pmemsave,
},
-STEXI
-@item pmemsave @var{addr} @var{size} @var{file}
-@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*.
@@ -1232,15 +819,6 @@ ERST
.cmd = hmp_boot_set,
},
-STEXI
-@item boot_set @var{bootdevicelist}
-@findex boot_set
-Define new values for the boot device list. Those values will override
-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
@@ -1257,12 +835,6 @@ ERST
.help = "inject an NMI",
.cmd = hmp_nmi,
},
-STEXI
-@item nmi @var{cpu}
-@findex nmi
-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).
@@ -1277,13 +849,6 @@ ERST
.command_completion = ringbuf_write_completion,
},
-STEXI
-@item ringbuf_write @var{device} @var{data}
-@findex ringbuf_write
-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*.
@@ -1299,18 +864,6 @@ ERST
.command_completion = ringbuf_write_completion,
},
-STEXI
-@item ringbuf_read @var{device}
-@findex ringbuf_read
-Read and print up to @var{size} bytes from ring buffer character
-device @var{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.
-
-ETEXI
SRST
``ringbuf_read`` *device*
Read and print up to *size* bytes from ring buffer character
@@ -1330,16 +883,6 @@ ERST
.cmd = hmp_announce_self,
},
-STEXI
-@item announce_self
-@findex 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 @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
@@ -1364,13 +907,6 @@ ERST
},
-STEXI
-@item migrate [-d] [-b] [-i] @var{uri}
-@findex migrate
-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).
@@ -1389,11 +925,6 @@ ERST
.cmd = hmp_migrate_cancel,
},
-STEXI
-@item migrate_cancel
-@findex migrate_cancel
-Cancel the current VM migration.
-ETEXI
SRST
``migrate_cancel``
Cancel the current VM migration.
@@ -1406,11 +937,6 @@ ERST
.help = "Continue migration from the given paused state",
.cmd = hmp_migrate_continue,
},
-STEXI
-@item migrate_continue @var{state}
-@findex migrate_continue
-Continue migration from the paused state @var{state}
-ETEXI
SRST
``migrate_continue`` *state*
Continue migration from the paused state *state*
@@ -1424,12 +950,6 @@ ERST
.cmd = hmp_migrate_incoming,
},
-STEXI
-@item migrate_incoming @var{uri}
-@findex migrate_incoming
-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
@@ -1444,11 +964,6 @@ ERST
.cmd = hmp_migrate_recover,
},
-STEXI
-@item migrate_recover @var{uri}
-@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*.
@@ -1462,11 +977,6 @@ ERST
.cmd = hmp_migrate_pause,
},
-STEXI
-@item migrate_pause
-@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.
@@ -1485,11 +995,6 @@ ERST
.cmd = hmp_migrate_set_cache_size,
},
-STEXI
-@item migrate_set_cache_size @var{value}
-@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.
@@ -1504,11 +1009,6 @@ ERST
.cmd = hmp_migrate_set_speed,
},
-STEXI
-@item migrate_set_speed @var{value}
-@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.
@@ -1522,11 +1022,6 @@ ERST
.cmd = hmp_migrate_set_downtime,
},
-STEXI
-@item migrate_set_downtime @var{second}
-@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.
@@ -1541,11 +1036,6 @@ ERST
.command_completion = migrate_set_capability_completion,
},
-STEXI
-@item migrate_set_capability @var{capability} @var{state}
-@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.
@@ -1560,11 +1050,6 @@ ERST
.command_completion = migrate_set_parameter_completion,
},
-STEXI
-@item migrate_set_parameter @var{parameter} @var{value}
-@findex migrate_set_parameter
-Set the parameter @var{parameter} for migration.
-ETEXI
SRST
``migrate_set_parameter`` *parameter* *value*
Set the parameter *parameter* for migration.
@@ -1581,12 +1066,6 @@ ERST
.cmd = hmp_migrate_start_postcopy,
},
-STEXI
-@item migrate_start_postcopy
-@findex migrate_start_postcopy
-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
@@ -1602,11 +1081,6 @@ ERST
.cmd = hmp_x_colo_lost_heartbeat,
},
-STEXI
-@item x_colo_lost_heartbeat
-@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.
@@ -1620,13 +1094,6 @@ ERST
.cmd = hmp_client_migrate_info,
},
-STEXI
-@item client_migrate_info @var{protocol} @var{hostname} @var{port} @var{tls-port} @var{cert-subject}
-@findex client_migrate_info
-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
@@ -1651,24 +1118,6 @@ ERST
.cmd = hmp_dump_guest_memory,
},
-STEXI
-@item dump-guest-memory [-p] @var{filename} @var{begin} @var{length}
-@item dump-guest-memory [-z|-l|-s|-w] @var{filename}
-@findex dump-guest-memory
-Dump guest memory to @var{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.
-ETEXI
SRST
``dump-guest-memory [-p]`` *filename* *begin* *length*
\
@@ -1708,11 +1157,6 @@ ERST
},
#endif
-STEXI
-@item dump-skeys @var{filename}
-@findex dump-skeys
-Save guest storage keys to a file.
-ETEXI
SRST
``dump-skeys`` *filename*
Save guest storage keys to a file.
@@ -1728,11 +1172,6 @@ ERST
},
#endif
-STEXI
-@item migration_mode @var{mode}
-@findex migration_mode
-Enables or disables migration mode.
-ETEXI
SRST
``migration_mode`` *mode*
Enables or disables migration mode.
@@ -1753,11 +1192,6 @@ ERST
.cmd = hmp_snapshot_blkdev,
},
-STEXI
-@item snapshot_blkdev
-@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
@@ -1773,11 +1207,6 @@ ERST
.cmd = hmp_snapshot_blkdev_internal,
},
-STEXI
-@item snapshot_blkdev_internal
-@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
@@ -1795,11 +1224,6 @@ ERST
.cmd = hmp_snapshot_delete_blkdev_internal,
},
-STEXI
-@item snapshot_delete_blkdev_internal
-@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
@@ -1819,12 +1243,6 @@ ERST
"so that the result does not need a backing file.\n\t\t\t",
.cmd = hmp_drive_mirror,
},
-STEXI
-@item drive_mirror
-@findex drive_mirror
-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,
@@ -1847,11 +1265,6 @@ ERST
"(if the target format supports it).\n\t\t\t",
.cmd = hmp_drive_backup,
},
-STEXI
-@item drive_backup
-@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.
@@ -1869,11 +1282,6 @@ ERST
.cmd = hmp_drive_add,
},
-STEXI
-@item drive_add
-@findex drive_add
-Add drive to PCI storage controller.
-ETEXI
SRST
``drive_add``
Add drive to PCI storage controller.
@@ -1897,11 +1305,6 @@ ERST
.cmd = hmp_pcie_aer_inject_error,
},
-STEXI
-@item pcie_aer_inject_error
-@findex pcie_aer_inject_error
-Inject PCIe AER error
-ETEXI
SRST
``pcie_aer_inject_error``
Inject PCIe AER error
@@ -1916,11 +1319,6 @@ ERST
.command_completion = netdev_add_completion,
},
-STEXI
-@item netdev_add
-@findex netdev_add
-Add host network device.
-ETEXI
SRST
``netdev_add``
Add host network device.
@@ -1935,11 +1333,6 @@ ERST
.command_completion = netdev_del_completion,
},
-STEXI
-@item netdev_del
-@findex netdev_del
-Remove host network device.
-ETEXI
SRST
``netdev_del``
Remove host network device.
@@ -1954,11 +1347,6 @@ ERST
.command_completion = object_add_completion,
},
-STEXI
-@item object_add
-@findex object_add
-Create QOM object.
-ETEXI
SRST
``object_add``
Create QOM object.
@@ -1973,11 +1361,6 @@ ERST
.command_completion = object_del_completion,
},
-STEXI
-@item object_del
-@findex object_del
-Destroy QOM object.
-ETEXI
SRST
``object_del``
Destroy QOM object.
@@ -1992,11 +1375,6 @@ ERST
.cmd = hmp_hostfwd_add,
},
#endif
-STEXI
-@item hostfwd_add
-@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).
@@ -2012,11 +1390,6 @@ ERST
},
#endif
-STEXI
-@item hostfwd_remove
-@findex hostfwd_remove
-Remove host-to-guest TCP or UDP redirection.
-ETEXI
SRST
``hostfwd_remove``
Remove host-to-guest TCP or UDP redirection.
@@ -2030,11 +1403,6 @@ ERST
.cmd = hmp_balloon,
},
-STEXI
-@item balloon @var{value}
-@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).
@@ -2049,11 +1417,6 @@ ERST
.command_completion = set_link_completion,
},
-STEXI
-@item set_link @var{name} [on|off]
-@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).
@@ -2068,11 +1431,6 @@ ERST
.command_completion = watchdog_action_completion,
},
-STEXI
-@item watchdog_action
-@findex watchdog_action
-Change watchdog action.
-ETEXI
SRST
``watchdog_action``
Change watchdog action.
@@ -2086,14 +1444,6 @@ ERST
.cmd = hmp_acl_show,
},
-STEXI
-@item acl_show @var{aclname}
-@findex acl_show
-List all the matching rules in the access control list, and the default
-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
@@ -2110,13 +1460,6 @@ ERST
.cmd = hmp_acl_policy,
},
-STEXI
-@item acl_policy @var{aclname} @code{allow|deny}
-@findex acl_policy
-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
@@ -2132,16 +1475,6 @@ ERST
.cmd = hmp_acl_add,
},
-STEXI
-@item acl_add @var{aclname} @var{match} @code{allow|deny} [@var{index}]
-@findex acl_add
-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 @code{*@@EXAMPLE.COM} to
-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.
@@ -2160,11 +1493,6 @@ ERST
.cmd = hmp_acl_remove,
},
-STEXI
-@item acl_remove @var{aclname} @var{match}
-@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.
@@ -2178,12 +1506,6 @@ ERST
.cmd = hmp_acl_reset,
},
-STEXI
-@item acl_reset @var{aclname}
-@findex acl_reset
-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
@@ -2197,14 +1519,6 @@ ERST
.help = "serve block devices on the given host and port",
.cmd = hmp_nbd_server_start,
},
-STEXI
-@item nbd_server_start @var{host}:@var{port}
-@findex nbd_server_start
-Start an NBD server on the given host and/or port. If the @option{-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 @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``
@@ -2220,14 +1534,6 @@ ERST
.help = "export a block device via NBD",
.cmd = hmp_nbd_server_add,
},
-STEXI
-@item nbd_server_add @var{device} [ @var{name} ]
-@findex nbd_server_add
-Export a block device through QEMU's NBD server, which must be started
-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
@@ -2243,15 +1549,6 @@ ERST
.help = "remove an export previously exposed via NBD",
.cmd = hmp_nbd_server_remove,
},
-STEXI
-@item nbd_server_remove [-f] @var{name}
-@findex nbd_server_remove
-Stop exporting a block device through QEMU's NBD server, which was
-previously started with @command{nbd_server_add}. The @option{-f}
-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
@@ -2268,11 +1565,6 @@ ERST
.help = "stop serving block devices using the NBD protocol",
.cmd = hmp_nbd_server_stop,
},
-STEXI
-@item nbd_server_stop
-@findex nbd_server_stop
-Stop the QEMU embedded NBD server.
-ETEXI
SRST
``nbd_server_stop``
Stop the QEMU embedded NBD server.
@@ -2290,11 +1582,6 @@ ERST
},
#endif
-STEXI
-@item mce @var{cpu} @var{bank} @var{status} @var{mcgstatus} @var{addr} @var{misc}
-@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).
@@ -2308,13 +1595,6 @@ ERST
.cmd = hmp_getfd,
},
-STEXI
-@item getfd @var{fdname}
-@findex getfd
-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
@@ -2330,13 +1610,6 @@ ERST
.cmd = hmp_closefd,
},
-STEXI
-@item closefd @var{fdname}
-@findex closefd
-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
@@ -2352,13 +1625,6 @@ ERST
.cmd = hmp_block_passwd,
},
-STEXI
-@item block_passwd @var{device} @var{password}
-@findex block_passwd
-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*
@@ -2374,12 +1640,6 @@ ERST
.cmd = hmp_block_set_io_throttle,
},
-STEXI
-@item block_set_io_throttle @var{device} @var{bps} @var{bps_rd} @var{bps_wr} @var{iops} @var{iops_rd} @var{iops_wr}
-@findex block_set_io_throttle
-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
@@ -2395,16 +1655,6 @@ ERST
.cmd = hmp_set_password,
},
-STEXI
-@item set_password [ vnc | spice ] password [ action-if-connected ]
-@findex set_password
-Change spice/vnc password. Use zero to make the password stay valid
-forever. @var{action-if-connected} specifies what should happen in
-case a connection is established: @var{fail} makes the password change
-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
@@ -2423,28 +1673,6 @@ ERST
.cmd = hmp_expire_password,
},
-STEXI
-@item expire_password [ vnc | spice ] expire-time
-@findex expire_password
-Specify when a password for spice/vnc becomes
-invalid. @var{expire-time} accepts:
-
-@table @var
-@item now
-Invalidate password instantly.
-
-@item never
-Password stays valid forever.
-
-@item +nsec
-Password stays valid for @var{nsec} seconds starting now.
-
-@item nsec
-Password is invalidated at the given time. @var{nsec} are the seconds
-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
@@ -2471,12 +1699,6 @@ ERST
.command_completion = chardev_add_completion,
},
-STEXI
-@item chardev-add args
-@findex chardev-add
-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.
@@ -2490,13 +1712,6 @@ ERST
.cmd = hmp_chardev_change,
},
-STEXI
-@item chardev-change args
-@findex chardev-change
-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
@@ -2512,12 +1727,6 @@ ERST
.command_completion = chardev_remove_completion,
},
-STEXI
-@item chardev-remove id
-@findex chardev-remove
-Removes the chardev @var{id}.
-
-ETEXI
SRST
``chardev-remove`` *id*
Removes the chardev *id*.
@@ -2532,12 +1741,6 @@ ERST
.command_completion = chardev_remove_completion,
},
-STEXI
-@item chardev-send-break id
-@findex chardev-send-break
-Send a break on the chardev @var{id}.
-
-ETEXI
SRST
``chardev-send-break`` *id*
Send a break on the chardev *id*.
@@ -2553,12 +1756,6 @@ ERST
.cmd = hmp_qemu_io,
},
-STEXI
-@item qemu-io @var{device} @var{command}
-@findex qemu-io
-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.
@@ -2572,13 +1769,6 @@ ERST
.cmd = hmp_cpu_add,
},
-STEXI
-@item cpu-add @var{id}
-@findex cpu-add
-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
@@ -2595,10 +1785,6 @@ ERST
.flags = "p",
},
-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*
@@ -2613,10 +1799,6 @@ ERST
.flags = "p",
},
-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*
@@ -2632,6 +1814,3 @@ ERST
.flags = "p",
},
-STEXI
-@end table
-ETEXI
diff --git a/qemu-options.hx b/qemu-options.hx
index f7061212ceb..3358979091d 100644
--- a/qemu-options.hx
+++ b/qemu-options.hx
@@ -7,17 +7,9 @@ HXCOMM architectures.
HXCOMM HXCOMM can be used for comments, discarded from both texi and C
DEFHEADING(Standard options:)
-STEXI
-@table @option
-ETEXI
DEF("help", 0, QEMU_OPTION_h,
"-h or -help display this help and exit\n", QEMU_ARCH_ALL)
-STEXI
-@item -h
-@findex -h
-Display help and exit
-ETEXI
SRST
``-h``
Display help and exit
@@ -25,11 +17,6 @@ ERST
DEF("version", 0, QEMU_OPTION_version,
"-version display version information and exit\n", QEMU_ARCH_ALL)
-STEXI
-@item -version
-@findex -version
-Display version information and exit
-ETEXI
SRST
``-version``
Display version information and exit
@@ -51,63 +38,6 @@ DEF("machine", HAS_ARG, QEMU_OPTION_machine, \
" memory-encryption=@var{} memory encryption object to use (default=none)\n"
" hmat=on|off controls ACPI HMAT support (default=off)\n",
QEMU_ARCH_ALL)
-STEXI
-@item -machine [type=]@var{name}[,prop=@var{value}[,...]]
-@findex -machine
-Select the emulated machine by @var{name}. Use @code{-machine help} to list
-available machines.
-
-For architectures which aim to support live migration compatibility
-across releases, each release will introduce a new versioned machine
-type. For example, the 2.8.0 release introduced machine types
-``pc-i440fx-2.8'' and ``pc-q35-2.8'' for the x86_64/i686 architectures.
-
-To allow live migration of guests from QEMU version 2.8.0, to QEMU
-version 2.9.0, the 2.9.0 version must support the ``pc-i440fx-2.8''
-and ``pc-q35-2.8'' machines too. To allow users live migrating VMs
-to skip multiple intermediate releases when upgrading, new releases
-of QEMU will support machine types from many previous versions.
-
-Supported machine properties are:
-@table @option
-@item accel=@var{accels1}[:@var{accels2}[:...]]
-This is used to enable an accelerator. Depending on the target architecture,
-kvm, xen, hax, hvf, whpx or tcg can be available. By default, tcg is used. If there is
-more than one accelerator specified, the next one is used if the previous one
-fails to initialize.
-@item vmport=on|off|auto
-Enables emulation of VMWare IO port, for vmmouse etc. auto says to select the
-value based on accel. For accel=xen the default is off otherwise the default
-is on.
-@item dump-guest-core=on|off
-Include guest memory in a core dump. The default is on.
-@item mem-merge=on|off
-Enables or disables memory merge support. This feature, when supported by
-the host, de-duplicates identical memory pages among VMs instances
-(enabled by default).
-@item aes-key-wrap=on|off
-Enables or disables AES key wrapping support on s390-ccw hosts. This feature
-controls whether AES wrapping keys will be created to allow
-execution of AES cryptographic functions. The default is on.
-@item dea-key-wrap=on|off
-Enables or disables DEA key wrapping support on s390-ccw hosts. This feature
-controls whether DEA wrapping keys will be created to allow
-execution of DEA cryptographic functions. The default is on.
-@item nvdimm=on|off
-Enables or disables NVDIMM support. The default is off.
-@item enforce-config-section=on|off
-If @option{enforce-config-section} is set to @var{on}, force migration
-code to send configuration section even if the machine-type sets the
-@option{migration.send-configuration} property to @var{off}.
-NOTE: this parameter is deprecated. Please use @option{-global}
-@option{migration.send-configuration}=@var{on|off} instead.
-@item memory-encryption=@var{}
-Memory encryption object to use. The default is none.
-@item hmat=on|off
-Enables or disables ACPI Heterogeneous Memory Attribute Table (HMAT) support.
-The default is off.
-@end table
-ETEXI
SRST
``-machine [type=]name[,prop=value[,...]]``
Select the emulated machine by name. Use ``-machine help`` to list
@@ -181,11 +111,6 @@ DEF("M", HAS_ARG, QEMU_OPTION_M, "", QEMU_ARCH_ALL)
DEF("cpu", HAS_ARG, QEMU_OPTION_cpu,
"-cpu cpu select CPU ('-cpu help' for list)\n", QEMU_ARCH_ALL)
-STEXI
-@item -cpu @var{model}
-@findex -cpu
-Select CPU model (@code{-cpu help} for list and additional feature selection)
-ETEXI
SRST
``-cpu model``
Select CPU model (``-cpu help`` for list and additional feature
@@ -200,33 +125,6 @@ DEF("accel", HAS_ARG, QEMU_OPTION_accel,
" kvm-shadow-mem=size of KVM shadow MMU in bytes\n"
" tb-size=n (TCG translation block cache size)\n"
" thread=single|multi (enable multi-threaded TCG)\n", QEMU_ARCH_ALL)
-STEXI
-@item -accel @var{name}[,prop=@var{value}[,...]]
-@findex -accel
-This is used to enable an accelerator. Depending on the target architecture,
-kvm, xen, hax, hvf, whpx or tcg can be available. By default, tcg is used. If there is
-more than one accelerator specified, the next one is used if the previous one
-fails to initialize.
-@table @option
-@item igd-passthru=on|off
-When Xen is in use, this option controls whether Intel integrated graphics
-devices can be passed through to the guest (default=off)
-@item kernel-irqchip=on|off|split
-Controls KVM in-kernel irqchip support. The default is full acceleration of the
-interrupt controllers. On x86, split irqchip reduces the kernel attack
-surface, at a performance cost for non-MSI interrupts. Disabling the in-kernel
-irqchip completely is not recommended except for debugging purposes.
-@item kvm-shadow-mem=size
-Defines the size of the KVM shadow MMU.
-@item tb-size=@var{n}
-Controls the size (in MiB) of the TCG translation block cache.
-@item thread=single|multi
-Controls number of TCG threads. When the TCG is multi-threaded there will be one
-thread per vCPU therefor taking advantage of additional host cores. The default
-is to enable multi-threading where both the back-end and front-ends support it and
-no incompatible TCG features have been enabled (e.g. icount/replay).
-@end table
-ETEXI
SRST
``-accel name[,prop=value[,...]]``
This is used to enable an accelerator. Depending on the target
@@ -272,18 +170,6 @@ DEF("smp", HAS_ARG, QEMU_OPTION_smp,
" dies= number of CPU dies on one socket (for PC only)\n"
" sockets= number of discrete sockets in the system\n",
QEMU_ARCH_ALL)
-STEXI
-@item -smp [cpus=]@var{n}[,cores=@var{cores}][,threads=@var{threads}][,dies=dies][,sockets=@var{sockets}][,maxcpus=@var{maxcpus}]
-@findex -smp
-Simulate an SMP system with @var{n} CPUs. On the PC target, up to 255
-CPUs are supported. On Sparc32 target, Linux limits the number of usable CPUs
-to 4.
-For the PC target, the number of @var{cores} per die, the number of @var{threads}
-per cores, the number of @var{dies} per packages and the total number of
-@var{sockets} can be specified. Missing values will be computed.
-If any on the three values is given, the total number of CPUs @var{n} can be omitted.
-@var{maxcpus} specifies the maximum number of hotpluggable CPUs.
-ETEXI
SRST
``-smp [cpus=]n[,cores=cores][,threads=threads][,dies=dies][,sockets=sockets][,maxcpus=maxcpus]``
Simulate an SMP system with n CPUs. On the PC target, up to 255 CPUs
@@ -304,149 +190,6 @@ DEF("numa", HAS_ARG, QEMU_OPTION_numa,
"-numa hmat-lb,initiator=node,target=node,hierarchy=memory|first-level|second-level|third-level,data-type=access-latency|read-latency|write-latency[,latency=lat][,bandwidth=bw]\n"
"-numa hmat-cache,node-id=node,size=size,level=level[,associativity=none|direct|complex][,policy=none|write-back|write-through][,line=size]\n",
QEMU_ARCH_ALL)
-STEXI
-@item -numa node[,mem=@var{size}][,cpus=@var{firstcpu}[-@var{lastcpu}]][,nodeid=@var{node}][,initiator=@var{initiator}]
-@itemx -numa node[,memdev=@var{id}][,cpus=@var{firstcpu}[-@var{lastcpu}]][,nodeid=@var{node}][,initiator=@var{initiator}]
-@itemx -numa dist,src=@var{source},dst=@var{destination},val=@var{distance}
-@itemx -numa cpu,node-id=@var{node}[,socket-id=@var{x}][,core-id=@var{y}][,thread-id=@var{z}]
-@itemx -numa hmat-lb,initiator=@var{node},target=@var{node},hierarchy=@var{hierarchy},data-type=@var{tpye}[,latency=@var{lat}][,bandwidth=@var{bw}]
-@itemx -numa hmat-cache,node-id=@var{node},size=@var{size},level=@var{level}[,associativity=@var{str}][,policy=@var{str}][,line=@var{size}]
-@findex -numa
-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.
-
-Legacy VCPU assignment uses @samp{cpus} option where
-@var{firstcpu} and @var{lastcpu} are CPU indexes. Each
-@samp{cpus} option represent a contiguous range of CPU indexes
-(or a single VCPU if @var{lastcpu} is omitted). A non-contiguous
-set of VCPUs can be represented by providing multiple @samp{cpus}
-options. If @samp{cpus} is omitted on all nodes, VCPUs are automatically
-split between them.
-
-For example, the following option assigns VCPUs 0, 1, 2 and 5 to
-a NUMA node:
-@example
--numa node,cpus=0-2,cpus=5
-@end example
-
-@samp{cpu} option is a new alternative to @samp{cpus} option
-which uses @samp{socket-id|core-id|thread-id} properties to assign
-CPU objects to a @var{node} using topology layout properties of CPU.
-The set of properties is machine specific, and depends on used
-machine type/@samp{smp} options. It could be queried with
-@samp{hotpluggable-cpus} monitor command.
-@samp{node-id} property specifies @var{node} to which CPU object
-will be assigned, it's required for @var{node} to be declared
-with @samp{node} option before it's used with @samp{cpu} option.
-
-For example:
-@example
--M pc \
--smp 1,sockets=2,maxcpus=2 \
--numa node,nodeid=0 -numa node,nodeid=1 \
--numa cpu,node-id=0,socket-id=0 -numa cpu,node-id=1,socket-id=1
-@end example
-
-@samp{mem} assigns a given RAM amount to a node. @samp{memdev}
-assigns RAM from a given memory backend device to a node. If
-@samp{mem} and @samp{memdev} are omitted in all nodes, RAM is
-split equally between them.
-
-@samp{mem} and @samp{memdev} are mutually exclusive. Furthermore,
-if one node uses @samp{memdev}, all of them have to use it.
-
-@samp{initiator} is an additional option that points to an @var{initiator}
-NUMA node that has best performance (the lowest latency or largest bandwidth)
-to this NUMA @var{node}. Note that this option can be set only when
-the machine property 'hmat' is set to 'on'.
-
-Following example creates a machine with 2 NUMA nodes, node 0 has CPU.
-node 1 has only memory, and its initiator is node 0. Note that because
-node 0 has CPU, by default the initiator of node 0 is itself and must be
-itself.
-@example
--machine hmat=on \
--m 2G,slots=2,maxmem=4G \
--object memory-backend-ram,size=1G,id=m0 \
--object memory-backend-ram,size=1G,id=m1 \
--numa node,nodeid=0,memdev=m0 \
--numa node,nodeid=1,memdev=m1,initiator=0 \
--smp 2,sockets=2,maxcpus=2 \
--numa cpu,node-id=0,socket-id=0 \
--numa cpu,node-id=0,socket-id=1
-@end example
-
-@var{source} and @var{destination} are NUMA node IDs.
-@var{distance} is the NUMA distance from @var{source} to @var{destination}.
-The distance from a node to itself is always 10. If any pair of nodes is
-given a distance, then all pairs must be given distances. Although, when
-distances are only given in one direction for each pair of nodes, then
-the distances in the opposite directions are assumed to be the same. If,
-however, an asymmetrical pair of distances is given for even one node
-pair, then all node pairs must be provided distance values for both
-directions, even when they are symmetrical. When a node is unreachable
-from another node, set the pair's distance to 255.
-
-Note that the -@option{numa} option doesn't allocate any of the
-specified resources, it just assigns existing resources to NUMA
-nodes. This means that one still has to use the @option{-m},
-@option{-smp} options to allocate RAM and VCPUs respectively.
-
-Use @samp{hmat-lb} to set System Locality Latency and Bandwidth Information
-between initiator and target NUMA nodes in ACPI Heterogeneous Attribute Memory Table (HMAT).
-Initiator NUMA node can create memory requests, usually it has one or more processors.
-Target NUMA node contains addressable memory.
-
-In @samp{hmat-lb} option, @var{node} are NUMA node IDs. @var{hierarchy} is the memory
-hierarchy of the target NUMA node: if @var{hierarchy} is 'memory', the structure
-represents the memory performance; if @var{hierarchy} is 'first-level|second-level|third-level',
-this structure represents aggregated performance of memory side caches for each domain.
-@var{type} of 'data-type' is type of data represented by this structure instance:
-if 'hierarchy' is 'memory', 'data-type' is 'access|read|write' latency or 'access|read|write'
-bandwidth of the target memory; if 'hierarchy' is 'first-level|second-level|third-level',
-'data-type' is 'access|read|write' hit latency or 'access|read|write' hit bandwidth of the
-target memory side cache.
-
-@var{lat} is latency value in nanoseconds. @var{bw} is bandwidth value,
-the possible value and units are NUM[M|G|T], mean that the bandwidth value are
-NUM byte per second (or MB/s, GB/s or TB/s depending on used suffix).
-Note that if latency or bandwidth value is 0, means the corresponding latency or
-bandwidth information is not provided.
-
-In @samp{hmat-cache} option, @var{node-id} is the NUMA-id of the memory belongs.
-@var{size} is the size of memory side cache in bytes. @var{level} is the cache
-level described in this structure, note that the cache level 0 should not be used
-with @samp{hmat-cache} option. @var{associativity} is the cache associativity,
-the possible value is 'none/direct(direct-mapped)/complex(complex cache indexing)'.
-@var{policy} is the write policy. @var{line} is the cache Line size in bytes.
-
-For example, the following options describe 2 NUMA nodes. Node 0 has 2 cpus and
-a ram, node 1 has only a ram. The processors in node 0 access memory in node
-0 with access-latency 5 nanoseconds, access-bandwidth is 200 MB/s;
-The processors in NUMA node 0 access memory in NUMA node 1 with access-latency 10
-nanoseconds, access-bandwidth is 100 MB/s.
-And for memory side cache information, NUMA node 0 and 1 both have 1 level memory
-cache, size is 10KB, policy is write-back, the cache Line size is 8 bytes:
-@example
--machine hmat=on \
--m 2G \
--object memory-backend-ram,size=1G,id=m0 \
--object memory-backend-ram,size=1G,id=m1 \
--smp 2 \
--numa node,nodeid=0,memdev=m0 \
--numa node,nodeid=1,memdev=m1,initiator=0 \
--numa cpu,node-id=0,socket-id=0 \
--numa cpu,node-id=0,socket-id=1 \
--numa hmat-lb,initiator=0,target=0,hierarchy=memory,data-type=access-latency,latency=5 \
--numa hmat-lb,initiator=0,target=0,hierarchy=memory,data-type=access-bandwidth,bandwidth=200M \
--numa hmat-lb,initiator=0,target=1,hierarchy=memory,data-type=access-latency,latency=10 \
--numa hmat-lb,initiator=0,target=1,hierarchy=memory,data-type=access-bandwidth,bandwidth=100M \
--numa hmat-cache,node-id=0,size=10K,level=1,associativity=direct,policy=write-back,line=8 \
--numa hmat-cache,node-id=1,size=10K,level=1,associativity=direct,policy=write-back,line=8
-@end example
-
-ETEXI
SRST
``-numa node[,mem=size][,cpus=firstcpu[-lastcpu]][,nodeid=node][,initiator=initiator]``
\
@@ -607,30 +350,6 @@ ERST
DEF("add-fd", HAS_ARG, QEMU_OPTION_add_fd,
"-add-fd fd=fd,set=set[,opaque=opaque]\n"
" Add 'fd' to fd 'set'\n", QEMU_ARCH_ALL)
-STEXI
-@item -add-fd fd=@var{fd},set=@var{set}[,opaque=@var{opaque}]
-@findex -add-fd
-
-Add a file descriptor to an fd set. Valid options are:
-
-@table @option
-@item fd=@var{fd}
-This option defines the file descriptor of which a duplicate is added to fd set.
-The file descriptor cannot be stdin, stdout, or stderr.
-@item set=@var{set}
-This option defines the ID of the fd set to add the file descriptor to.
-@item opaque=@var{opaque}
-This option defines a free-form string that can be used to describe @var{fd}.
-@end table
-
-You can open an image using pre-opened file descriptors from an fd set:
-@example
-@value{qemu_system} \
- -add-fd fd=3,set=2,opaque="rdwr:/path/to/file" \
- -add-fd fd=4,set=2,opaque="rdonly:/path/to/file" \
- -drive file=/dev/fdset/2,index=0,media=disk
-@end example
-ETEXI
SRST
``-add-fd fd=fd,set=set[,opaque=opaque]``
Add a file descriptor to an fd set. Valid options are:
@@ -663,11 +382,6 @@ DEF("set", HAS_ARG, QEMU_OPTION_set,
"-set group.id.arg=value\n"
" set <arg> parameter for item <id> of type <group>\n"
" i.e. -set drive.$id.file=/path/to/image\n", QEMU_ARCH_ALL)
-STEXI
-@item -set @var{group}.@var{id}.@var{arg}=@var{value}
-@findex -set
-Set parameter @var{arg} for item @var{id} of type @var{group}
-ETEXI
SRST
``-set group.id.arg=value``
Set parameter arg for item id of type group
@@ -678,24 +392,6 @@ DEF("global", HAS_ARG, QEMU_OPTION_global,
"-global driver=driver,property=property,value=value\n"
" set a global default for a driver property\n",
QEMU_ARCH_ALL)
-STEXI
-@item -global @var{driver}.@var{prop}=@var{value}
-@itemx -global driver=@var{driver},property=@var{property},value=@var{value}
-@findex -global
-Set default value of @var{driver}'s property @var{prop} to @var{value}, e.g.:
-
-@example
-@value{qemu_system_x86} -global ide-hd.physical_block_size=4096 disk-image.img
-@end example
-
-In particular, you can use this to set driver properties for devices which are
-created automatically by the machine model. To create a device which is not
-created automatically and set properties on it, use -@option{device}.
-
--global @var{driver}.@var{prop}=@var{value} is shorthand for -global
-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``
\
@@ -724,50 +420,6 @@ DEF("boot", HAS_ARG, QEMU_OPTION_boot,
" 'sp_time': the period that splash picture last if menu=on, unit is ms\n"
" 'rb_timeout': the timeout before guest reboot when boot failed, unit is ms\n",
QEMU_ARCH_ALL)
-STEXI
-@item -boot [order=@var{drives}][,once=@var{drives}][,menu=on|off][,splash=@var{sp_name}][,splash-time=@var{sp_time}][,reboot-timeout=@var{rb_timeout}][,strict=on|off]
-@findex -boot
-Specify boot order @var{drives} as a string of drive letters. Valid
-drive letters depend on the target architecture. The x86 PC uses: a, b
-(floppy 1 and 2), c (first hard disk), d (first CD-ROM), n-p (Etherboot
-from network adapter 1-4), hard disk boot is the default. To apply a
-particular boot order only on the first startup, specify it via
-@option{once}. Note that the @option{order} or @option{once} parameter
-should not be used together with the @option{bootindex} property of
-devices, since the firmware implementations normally do not support both
-at the same time.
-
-Interactive boot menus/prompts can be enabled via @option{menu=on} as far
-as firmware/BIOS supports them. The default is non-interactive boot.
-
-A splash picture could be passed to bios, enabling user to show it as logo,
-when option splash=@var{sp_name} is given and menu=on, If firmware/BIOS
-supports them. Currently Seabios for X86 system support it.
-limitation: The splash file could be a jpeg file or a BMP file in 24 BPP
-format(true color). The resolution should be supported by the SVGA mode, so
-the recommended is 320x240, 640x480, 800x640.
-
-A timeout could be passed to bios, guest will pause for @var{rb_timeout} ms
-when boot failed, then reboot. If @var{rb_timeout} is '-1', guest will not
-reboot, qemu passes '-1' to bios by default. Currently Seabios for X86
-system support it.
-
-Do strict boot via @option{strict=on} as far as firmware/BIOS
-supports it. This only effects when boot priority is changed by
-bootindex options. The default is non-strict boot.
-
-@example
-# try to boot from network first, then from hard disk
-@value{qemu_system_x86} -boot order=nc
-# boot from CD-ROM first, switch back to default order after reboot
-@value{qemu_system_x86} -boot once=d
-# boot with a splash picture for 5 seconds.
-@value{qemu_system_x86} -boot menu=on,splash=/root/boot.bmp,splash-time=5000
-@end example
-
-Note: The legacy format '-boot @var{drives}' is still supported but its
-use is discouraged as it may be removed from future versions.
-ETEXI
SRST
``-boot [order=drives][,once=drives][,menu=on|off][,splash=sp_name][,splash-time=sp_time][,reboot-timeout=rb_timeout][,strict=on|off]``
Specify boot order drives as a string of drive letters. Valid drive
@@ -821,26 +473,6 @@ DEF("m", HAS_ARG, QEMU_OPTION_m,
" maxmem: maximum amount of guest memory (default: none)\n"
"NOTE: Some architectures might enforce a specific granularity\n",
QEMU_ARCH_ALL)
-STEXI
-@item -m [size=]@var{megs}[,slots=n,maxmem=size]
-@findex -m
-Sets guest startup RAM size to @var{megs} megabytes. Default is 128 MiB.
-Optionally, a suffix of ``M'' or ``G'' can be used to signify a value in
-megabytes or gigabytes respectively. Optional pair @var{slots}, @var{maxmem}
-could be used to set amount of hotpluggable memory slots and maximum amount of
-memory. Note that @var{maxmem} must be aligned to the page size.
-
-For example, the following command-line sets the guest startup RAM size to
-1GB, creates 3 slots to hotplug additional memory and sets the maximum
-memory the guest can reach to 4GB:
-
-@example
-@value{qemu_system} -m 1G,slots=3,maxmem=4G
-@end example
-
-If @var{slots} and @var{maxmem} are not specified, memory hotplug won't
-be enabled and the guest startup RAM will never increase.
-ETEXI
SRST
``-m [size=]megs[,slots=n,maxmem=size]``
Sets guest startup RAM size to megs megabytes. Default is 128 MiB.
@@ -863,11 +495,6 @@ ERST
DEF("mem-path", HAS_ARG, QEMU_OPTION_mempath,
"-mem-path FILE provide backing storage for guest RAM\n", QEMU_ARCH_ALL)
-STEXI
-@item -mem-path @var{path}
-@findex -mem-path
-Allocate guest RAM from a temporarily created file in @var{path}.
-ETEXI
SRST
``-mem-path path``
Allocate guest RAM from a temporarily created file in path.
@@ -876,11 +503,6 @@ ERST
DEF("mem-prealloc", 0, QEMU_OPTION_mem_prealloc,
"-mem-prealloc preallocate guest memory (use with -mem-path)\n",
QEMU_ARCH_ALL)
-STEXI
-@item -mem-prealloc
-@findex -mem-prealloc
-Preallocate memory when using -mem-path.
-ETEXI
SRST
``-mem-prealloc``
Preallocate memory when using -mem-path.
@@ -889,24 +511,6 @@ ERST
DEF("k", HAS_ARG, QEMU_OPTION_k,
"-k language use keyboard layout (for example 'fr' for French)\n",
QEMU_ARCH_ALL)
-STEXI
-@item -k @var{language}
-@findex -k
-Use keyboard layout @var{language} (for example @code{fr} for
-French). This option is only needed where it is not easy to get raw PC
-keycodes (e.g. on Macs, with some X11 servers or with a VNC or curses
-display). You don't normally need to use it on PC/Linux or PC/Windows
-hosts.
-
-The available layouts are:
-@example
-ar de-ch es fo fr-ca hu ja mk no pt-br sv
-da en-gb et fr fr-ch is lt nl pl ru th
-de en-us fi fr-be hr it lv nl-be pt sl tr
-@end example
-
-The default is @code{en-us}.
-ETEXI
SRST
``-k language``
Use keyboard layout language (for example ``fr`` for French). This
@@ -931,12 +535,6 @@ HXCOMM Deprecated by -audiodev
DEF("audio-help", 0, QEMU_OPTION_audio_help,
"-audio-help show -audiodev equivalent of the currently specified audio settings\n",
QEMU_ARCH_ALL)
-STEXI
-@item -audio-help
-@findex -audio-help
-Will show the -audiodev equivalent of the currently specified
-(deprecated) environment variables.
-ETEXI
SRST
``-audio-help``
Will show the -audiodev equivalent of the currently specified
@@ -997,200 +595,6 @@ DEF("audiodev", HAS_ARG, QEMU_OPTION_audiodev,
"-audiodev wav,id=id[,prop[=value][,...]]\n"
" path= path of wav file to record\n",
QEMU_ARCH_ALL)
-STEXI
-@item -audiodev [driver=]@var{driver},id=@var{id}[,@var{prop}[=@var{value}][,...]]
-@findex -audiodev
-Adds a new audio backend @var{driver} identified by @var{id}. There are
-global and driver specific properties. Some values can be set
-differently for input and output, they're marked with @code{in|out.}.
-You can set the input's property with @code{in.@var{prop}} and the
-output's property with @code{out.@var{prop}}. For example:
-@example
--audiodev alsa,id=example,in.frequency=44110,out.frequency=8000
--audiodev alsa,id=example,out.channels=1 # leaves in.channels unspecified
-@end example
-
-NOTE: parameter validation is known to be incomplete, in many cases
-specifying an invalid option causes QEMU to print an error message and
-continue emulation without sound.
-
-Valid global options are:
-
-@table @option
-@item id=@var{identifier}
-Identifies the audio backend.
-
-@item timer-period=@var{period}
-Sets the timer @var{period} used by the audio subsystem in microseconds.
-Default is 10000 (10 ms).
-
-@item in|out.mixing-engine=on|off
-Use QEMU's mixing engine to mix all streams inside QEMU and convert
-audio formats when not supported by the backend. When off,
-@var{fixed-settings} must be off too. Note that disabling this option
-means that the selected backend must support multiple streams and the
-audio formats used by the virtual cards, otherwise you'll get no sound.
-It's not recommended to disable this option unless you want to use 5.1
-or 7.1 audio, as mixing engine only supports mono and stereo audio.
-Default is on.
-
-@item in|out.fixed-settings=on|off
-Use fixed settings for host audio. When off, it will change based on
-how the guest opens the sound card. In this case you must not specify
-@var{frequency}, @var{channels} or @var{format}. Default is on.
-
-@item in|out.frequency=@var{frequency}
-Specify the @var{frequency} to use when using @var{fixed-settings}.
-Default is 44100Hz.
-
-@item in|out.channels=@var{channels}
-Specify the number of @var{channels} to use when using
-@var{fixed-settings}. Default is 2 (stereo).
-
-@item in|out.format=@var{format}
-Specify the sample @var{format} to use when using @var{fixed-settings}.
-Valid values are: @code{s8}, @code{s16}, @code{s32}, @code{u8},
-@code{u16}, @code{u32}. Default is @code{s16}.
-
-@item in|out.voices=@var{voices}
-Specify the number of @var{voices} to use. Default is 1.
-
-@item in|out.buffer-length=@var{usecs}
-Sets the size of the buffer in microseconds.
-
-@end table
-
-@item -audiodev none,id=@var{id}[,@var{prop}[=@var{value}][,...]]
-Creates a dummy backend that discards all outputs. This backend has no
-backend specific properties.
-
-@item -audiodev alsa,id=@var{id}[,@var{prop}[=@var{value}][,...]]
-Creates backend using the ALSA. This backend is only available on
-Linux.
-
-ALSA specific options are:
-
-@table @option
-
-@item in|out.dev=@var{device}
-Specify the ALSA @var{device} to use for input and/or output. Default
-is @code{default}.
-
-@item in|out.period-length=@var{usecs}
-Sets the period length in microseconds.
-
-@item in|out.try-poll=on|off
-Attempt to use poll mode with the device. Default is on.
-
-@item threshold=@var{threshold}
-Threshold (in microseconds) when playback starts. Default is 0.
-
-@end table
-
-@item -audiodev coreaudio,id=@var{id}[,@var{prop}[=@var{value}][,...]]
-Creates a backend using Apple's Core Audio. This backend is only
-available on Mac OS and only supports playback.
-
-Core Audio specific options are:
-
-@table @option
-
-@item in|out.buffer-count=@var{count}
-Sets the @var{count} of the buffers.
-
-@end table
-
-@item -audiodev dsound,id=@var{id}[,@var{prop}[=@var{value}][,...]]
-Creates a backend using Microsoft's DirectSound. This backend is only
-available on Windows and only supports playback.
-
-DirectSound specific options are:
-
-@table @option
-
-@item latency=@var{usecs}
-Add extra @var{usecs} microseconds latency to playback. Default is
-10000 (10 ms).
-
-@end table
-
-@item -audiodev oss,id=@var{id}[,@var{prop}[=@var{value}][,...]]
-Creates a backend using OSS. This backend is available on most
-Unix-like systems.
-
-OSS specific options are:
-
-@table @option
-
-@item in|out.dev=@var{device}
-Specify the file name of the OSS @var{device} to use. Default is
-@code{/dev/dsp}.
-
-@item in|out.buffer-count=@var{count}
-Sets the @var{count} of the buffers.
-
-@item in|out.try-poll=on|of
-Attempt to use poll mode with the device. Default is on.
-
-@item try-mmap=on|off
-Try using memory mapped device access. Default is off.
-
-@item exclusive=on|off
-Open the device in exclusive mode (vmix won't work in this case).
-Default is off.
-
-@item dsp-policy=@var{policy}
-Sets the timing policy (between 0 and 10, where smaller number means
-smaller latency but higher CPU usage). Use -1 to use buffer sizes
-specified by @code{buffer} and @code{buffer-count}. This option is
-ignored if you do not have OSS 4. Default is 5.
-
-@end table
-
-@item -audiodev pa,id=@var{id}[,@var{prop}[=@var{value}][,...]]
-Creates a backend using PulseAudio. This backend is available on most
-systems.
-
-PulseAudio specific options are:
-
-@table @option
-
-@item server=@var{server}
-Sets the PulseAudio @var{server} to connect to.
-
-@item in|out.name=@var{sink}
-Use the specified source/sink for recording/playback.
-
-@item in|out.latency=@var{usecs}
-Desired latency in microseconds. The PulseAudio server will try to honor this
-value but actual latencies may be lower or higher.
-
-@end table
-
-@item -audiodev sdl,id=@var{id}[,@var{prop}[=@var{value}][,...]]
-Creates a backend using SDL. This backend is available on most systems,
-but you should use your platform's native backend if possible. This
-backend has no backend specific properties.
-
-@item -audiodev spice,id=@var{id}[,@var{prop}[=@var{value}][,...]]
-Creates a backend that sends audio through SPICE. This backend requires
-@code{-spice} and automatically selected in that case, so usually you
-can ignore this option. This backend has no backend specific
-properties.
-
-@item -audiodev wav,id=@var{id}[,@var{prop}[=@var{value}][,...]]
-Creates a backend that writes audio to a WAV file.
-
-Backend specific options are:
-
-@table @option
-
-@item path=@var{path}
-Write recorded audio into the specified file. Default is
-@code{qemu.wav}.
-
-@end table
-ETEXI
SRST
``-audiodev [driver=]driver,id=id[,prop[=value][,...]]``
Adds a new audio backend driver identified by id. There are global
@@ -1364,28 +768,6 @@ DEF("soundhw", HAS_ARG, QEMU_OPTION_soundhw,
" and only specified sound cards (comma separated list)\n"
" use '-soundhw help' to get the list of supported cards\n"
" use '-soundhw all' to enable all of them\n", QEMU_ARCH_ALL)
-STEXI
-@item -soundhw @var{card1}[,@var{card2},...] or -soundhw all
-@findex -soundhw
-Enable audio and selected sound hardware. Use 'help' to print all
-available sound hardware. For example:
-
-@example
-@value{qemu_system_x86} -soundhw sb16,adlib disk.img
-@value{qemu_system_x86} -soundhw es1370 disk.img
-@value{qemu_system_x86} -soundhw ac97 disk.img
-@value{qemu_system_x86} -soundhw hda disk.img
-@value{qemu_system_x86} -soundhw all disk.img
-@value{qemu_system_x86} -soundhw help
-@end example
-
-Note that Linux's i810_audio OSS kernel (for AC97) module might
-require manually specifying clocking.
-
-@example
-modprobe i810_audio clocking=48000
-@end example
-ETEXI
SRST
``-soundhw card1[,card2,...] or -soundhw all``
Enable audio and selected sound hardware. Use 'help' to print all
@@ -1415,83 +797,6 @@ DEF("device", HAS_ARG, QEMU_OPTION_device,
" use '-device help' to print all possible drivers\n"
" use '-device driver,help' to print all possible properties\n",
QEMU_ARCH_ALL)
-STEXI
-@item -device @var{driver}[,@var{prop}[=@var{value}][,...]]
-@findex -device
-Add device @var{driver}. @var{prop}=@var{value} sets driver
-properties. Valid properties depend on the driver. To get help on
-possible drivers and properties, use @code{-device help} and
-@code{-device @var{driver},help}.
-
-Some drivers are:
-@item -device ipmi-bmc-sim,id=@var{id}[,slave_addr=@var{val}][,sdrfile=@var{file}][,furareasize=@var{val}][,furdatafile=@var{file}][,guid=@var{uuid}]
-
-Add an IPMI BMC. This is a simulation of a hardware management
-interface processor that normally sits on a system. It provides
-a watchdog and the ability to reset and power control the system.
-You need to connect this to an IPMI interface to make it useful
-
-The IPMI slave address to use for the BMC. The default is 0x20.
-This address is the BMC's address on the I2C network of management
-controllers. If you don't know what this means, it is safe to ignore
-it.
-
-@table @option
-@item id=@var{id}
-The BMC id for interfaces to use this device.
-@item slave_addr=@var{val}
-Define slave address to use for the BMC. The default is 0x20.
-@item sdrfile=@var{file}
-file containing raw Sensor Data Records (SDR) data. The default is none.
-@item fruareasize=@var{val}
-size of a Field Replaceable Unit (FRU) area. The default is 1024.
-@item frudatafile=@var{file}
-file containing raw Field Replaceable Unit (FRU) inventory data. The default is none.
-@item guid=@var{uuid}
-value for the GUID for the BMC, in standard UUID format. If this is set,
-get "Get GUID" command to the BMC will return it. Otherwise "Get GUID"
-will return an error.
-@end table
-
-@item -device ipmi-bmc-extern,id=@var{id},chardev=@var{id}[,slave_addr=@var{val}]
-
-Add a connection to an external IPMI BMC simulator. Instead of
-locally emulating the BMC like the above item, instead connect
-to an external entity that provides the IPMI services.
-
-A connection is made to an external BMC simulator. If you do this, it
-is strongly recommended that you use the "reconnect=" chardev option
-to reconnect to the simulator if the connection is lost. Note that if
-this is not used carefully, it can be a security issue, as the
-interface has the ability to send resets, NMIs, and power off the VM.
-It's best if QEMU makes a connection to an external simulator running
-on a secure port on localhost, so neither the simulator nor QEMU is
-exposed to any outside network.
-
-See the "lanserv/README.vm" file in the OpenIPMI library for more
-details on the external interface.
-
-@item -device isa-ipmi-kcs,bmc=@var{id}[,ioport=@var{val}][,irq=@var{val}]
-
-Add a KCS IPMI interafce on the ISA bus. This also adds a
-corresponding ACPI and SMBIOS entries, if appropriate.
-
-@table @option
-@item bmc=@var{id}
-The BMC to connect to, one of ipmi-bmc-sim or ipmi-bmc-extern above.
-@item ioport=@var{val}
-Define the I/O address of the interface. The default is 0xca0 for KCS.
-@item irq=@var{val}
-Define the interrupt to use. The default is 5. To disable interrupts,
-set this to 0.
-@end table
-
-@item -device isa-ipmi-bt,bmc=@var{id}[,ioport=@var{val}][,irq=@var{val}]
-
-Like the KCS interface, but defines a BT interface. The default port is
-0xe4 and the default interrupt is 5.
-
-ETEXI
SRST
``-device driver[,prop[=value][,...]]``
Add device driver. prop=value sets driver properties. Valid
@@ -1579,15 +884,6 @@ DEF("name", HAS_ARG, QEMU_OPTION_name,
" When debug-threads is enabled, individual threads are given a separate name\n"
" NOTE: The thread names are for debugging and not a stable API.\n",
QEMU_ARCH_ALL)
-STEXI
-@item -name @var{name}
-@findex -name
-Sets the @var{name} of the guest.
-This name will be displayed in the SDL window caption.
-The @var{name} will also be used for the VNC server.
-Also optionally set the top visible process name in Linux.
-Naming of individual threads can also be enabled on Linux to aid debugging.
-ETEXI
SRST
``-name name``
Sets the name of the guest. This name will be displayed in the SDL
@@ -1599,36 +895,18 @@ ERST
DEF("uuid", HAS_ARG, QEMU_OPTION_uuid,
"-uuid %08x-%04x-%04x-%04x-%012x\n"
" specify machine UUID\n", QEMU_ARCH_ALL)
-STEXI
-@item -uuid @var{uuid}
-@findex -uuid
-Set system UUID.
-ETEXI
SRST
``-uuid uuid``
Set system UUID.
ERST
-STEXI
-@end table
-ETEXI
DEFHEADING()
DEFHEADING(Block device options:)
-STEXI
-@table @option
-ETEXI
DEF("fda", HAS_ARG, QEMU_OPTION_fda,
"-fda/-fdb file use 'file' as floppy disk 0/1 image\n", QEMU_ARCH_ALL)
DEF("fdb", HAS_ARG, QEMU_OPTION_fdb, "", QEMU_ARCH_ALL)
-STEXI
-@item -fda @var{file}
-@itemx -fdb @var{file}
-@findex -fda
-@findex -fdb
-Use @var{file} as floppy disk 0/1 image (@pxref{disk_images}).
-ETEXI
SRST
``-fda file``
\
@@ -1643,17 +921,6 @@ DEF("hdb", HAS_ARG, QEMU_OPTION_hdb, "", QEMU_ARCH_ALL)
DEF("hdc", HAS_ARG, QEMU_OPTION_hdc,
"-hdc/-hdd file use 'file' as IDE hard disk 2/3 image\n", QEMU_ARCH_ALL)
DEF("hdd", HAS_ARG, QEMU_OPTION_hdd, "", QEMU_ARCH_ALL)
-STEXI
-@item -hda @var{file}
-@itemx -hdb @var{file}
-@itemx -hdc @var{file}
-@itemx -hdd @var{file}
-@findex -hda
-@findex -hdb
-@findex -hdc
-@findex -hdd
-Use @var{file} as hard disk 0, 1, 2 or 3 image (@pxref{disk_images}).
-ETEXI
SRST
``-hda file``
\
@@ -1669,13 +936,6 @@ ERST
DEF("cdrom", HAS_ARG, QEMU_OPTION_cdrom,
"-cdrom file use 'file' as IDE cdrom image (cdrom is ide1 master)\n",
QEMU_ARCH_ALL)
-STEXI
-@item -cdrom @var{file}
-@findex -cdrom
-Use @var{file} as CD-ROM image (you cannot use @option{-hdc} and
-@option{-cdrom} at the same time). You can use the host CD-ROM by
-using @file{/dev/cdrom} as filename.
-ETEXI
SRST
``-cdrom file``
Use file as CD-ROM image (you cannot use ``-hdc`` and ``-cdrom`` at
@@ -1690,193 +950,6 @@ DEF("blockdev", HAS_ARG, QEMU_OPTION_blockdev,
" [,force-share=on|off][,detect-zeroes=on|off|unmap]\n"
" [,driver specific parameters...]\n"
" configure a block backend\n", QEMU_ARCH_ALL)
-STEXI
-@item -blockdev @var{option}[,@var{option}[,@var{option}[,...]]]
-@findex -blockdev
-
-Define a new block driver node. Some of the options apply to all block drivers,
-other options are only accepted for a specific block driver. See below for a
-list of generic options and options for the most common block drivers.
-
-Options that expect a reference to another node (e.g. @code{file}) can be
-given in two ways. Either you specify the node name of an already existing node
-(file=@var{node-name}), or you define a new node inline, adding options
-for the referenced node after a dot (file.filename=@var{path},file.aio=native).
-
-A block driver node created with @option{-blockdev} can be used for a guest
-device by specifying its node name for the @code{drive} property in a
-@option{-device} argument that defines a block device.
-
-@table @option
-@item Valid options for any block driver node:
-
-@table @code
-@item driver
-Specifies the block driver to use for the given node.
-@item node-name
-This defines the name of the block driver node by which it will be referenced
-later. The name must be unique, i.e. it must not match the name of a different
-block driver node, or (if you use @option{-drive} as well) the ID of a drive.
-
-If no node name is specified, it is automatically generated. The generated node
-name is not intended to be predictable and changes between QEMU invocations.
-For the top level, an explicit node name must be specified.
-@item read-only
-Open the node read-only. Guest write attempts will fail.
-
-Note that some block drivers support only read-only access, either generally or
-in certain configurations. In this case, the default value
-@option{read-only=off} does not work and the option must be specified
-explicitly.
-@item auto-read-only
-If @option{auto-read-only=on} is set, QEMU may fall back to read-only usage
-even when @option{read-only=off} is requested, or even switch between modes as
-needed, e.g. depending on whether the image file is writable or whether a
-writing user is attached to the node.
-@item force-share
-Override the image locking system of QEMU by forcing the node to utilize
-weaker shared access for permissions where it would normally request exclusive
-access. When there is the potential for multiple instances to have the same
-file open (whether this invocation of QEMU is the first or the second
-instance), both instances must permit shared access for the second instance to
-succeed at opening the file.
-
-Enabling @option{force-share=on} requires @option{read-only=on}.
-@item cache.direct
-The host page cache can be avoided with @option{cache.direct=on}. This will
-attempt to do disk IO directly to the guest's memory. QEMU may still perform an
-internal copy of the data.
-@item cache.no-flush
-In case you don't care about data integrity over host failures, you can use
-@option{cache.no-flush=on}. This option tells QEMU that it never needs to write
-any data to the disk but can instead keep things in cache. If anything goes
-wrong, like your host losing power, the disk storage getting disconnected
-accidentally, etc. your image will most probably be rendered unusable.
-@item discard=@var{discard}
-@var{discard} is one of "ignore" (or "off") or "unmap" (or "on") and controls
-whether @code{discard} (also known as @code{trim} or @code{unmap}) requests are
-ignored or passed to the filesystem. Some machine types may not support
-discard requests.
-@item detect-zeroes=@var{detect-zeroes}
-@var{detect-zeroes} is "off", "on" or "unmap" and enables the automatic
-conversion of plain zero writes by the OS to driver specific optimized
-zero write commands. You may even choose "unmap" if @var{discard} is set
-to "unmap" to allow a zero write to be converted to an @code{unmap} operation.
-@end table
-
-@item Driver-specific options for @code{file}
-
-This is the protocol-level block driver for accessing regular files.
-
-@table @code
-@item filename
-The path to the image file in the local filesystem
-@item aio
-Specifies the AIO backend (threads/native, default: threads)
-@item locking
-Specifies whether the image file is protected with Linux OFD / POSIX locks. The
-default is to use the Linux Open File Descriptor API if available, otherwise no
-lock is applied. (auto/on/off, default: auto)
-@end table
-Example:
-@example
--blockdev driver=file,node-name=disk,filename=disk.img
-@end example
-
-@item Driver-specific options for @code{raw}
-
-This is the image format block driver for raw images. It is usually
-stacked on top of a protocol level block driver such as @code{file}.
-
-@table @code
-@item file
-Reference to or definition of the data source block driver node
-(e.g. a @code{file} driver node)
-@end table
-Example 1:
-@example
--blockdev driver=file,node-name=disk_file,filename=disk.img
--blockdev driver=raw,node-name=disk,file=disk_file
-@end example
-Example 2:
-@example
--blockdev driver=raw,node-name=disk,file.driver=file,file.filename=disk.img
-@end example
-
-@item Driver-specific options for @code{qcow2}
-
-This is the image format block driver for qcow2 images. It is usually
-stacked on top of a protocol level block driver such as @code{file}.
-
-@table @code
-@item file
-Reference to or definition of the data source block driver node
-(e.g. a @code{file} driver node)
-
-@item backing
-Reference to or definition of the backing file block device (default is taken
-from the image file). It is allowed to pass @code{null} here in order to disable
-the default backing file.
-
-@item lazy-refcounts
-Whether to enable the lazy refcounts feature (on/off; default is taken from the
-image file)
-
-@item cache-size
-The maximum total size of the L2 table and refcount block caches in bytes
-(default: the sum of l2-cache-size and refcount-cache-size)
-
-@item l2-cache-size
-The maximum size of the L2 table cache in bytes
-(default: if cache-size is not specified - 32M on Linux platforms, and 8M on
-non-Linux platforms; otherwise, as large as possible within the cache-size,
-while permitting the requested or the minimal refcount cache size)
-
-@item refcount-cache-size
-The maximum size of the refcount block cache in bytes
-(default: 4 times the cluster size; or if cache-size is specified, the part of
-it which is not used for the L2 cache)
-
-@item cache-clean-interval
-Clean unused entries in the L2 and refcount caches. The interval is in seconds.
-The default value is 600 on supporting platforms, and 0 on other platforms.
-Setting it to 0 disables this feature.
-
-@item pass-discard-request
-Whether discard requests to the qcow2 device should be forwarded to the data
-source (on/off; default: on if discard=unmap is specified, off otherwise)
-
-@item pass-discard-snapshot
-Whether discard requests for the data source should be issued when a snapshot
-operation (e.g. deleting a snapshot) frees clusters in the qcow2 file (on/off;
-default: on)
-
-@item pass-discard-other
-Whether discard requests for the data source should be issued on other
-occasions where a cluster gets freed (on/off; default: off)
-
-@item overlap-check
-Which overlap checks to perform for writes to the image
-(none/constant/cached/all; default: cached). For details or finer
-granularity control refer to the QAPI documentation of @code{blockdev-add}.
-@end table
-
-Example 1:
-@example
--blockdev driver=file,node-name=my_file,filename=/tmp/disk.qcow2
--blockdev driver=qcow2,node-name=hda,file=my_file,overlap-check=none,cache-size=16777216
-@end example
-Example 2:
-@example
--blockdev driver=qcow2,node-name=disk,file.driver=http,file.filename=http://example.com/image.qcow2
-@end example
-
-@item Driver-specific options for other drivers
-Please refer to the QAPI documentation of the @code{blockdev-add} QMP command.
-
-@end table
-
-ETEXI
SRST
``-blockdev option[,option[,option[,...]]]``
Define a new block driver node. Some of the options apply to all
@@ -2102,170 +1175,6 @@ DEF("drive", HAS_ARG, QEMU_OPTION_drive,
" [[,iops_size=is]]\n"
" [[,group=g]]\n"
" use 'file' as a drive image\n", QEMU_ARCH_ALL)
-STEXI
-@item -drive @var{option}[,@var{option}[,@var{option}[,...]]]
-@findex -drive
-
-Define a new drive. This includes creating a block driver node (the backend) as
-well as a guest device, and is mostly a shortcut for defining the corresponding
-@option{-blockdev} and @option{-device} options.
-
-@option{-drive} accepts all options that are accepted by @option{-blockdev}. In
-addition, it knows the following options:
-
-@table @option
-@item file=@var{file}
-This option defines which disk image (@pxref{disk_images}) to use with
-this drive. If the filename contains comma, you must double it
-(for instance, "file=my,,file" to use file "my,file").
-
-Special files such as iSCSI devices can be specified using protocol
-specific URLs. See the section for "Device URL Syntax" for more information.
-@item if=@var{interface}
-This option defines on which type on interface the drive is connected.
-Available types are: ide, scsi, sd, mtd, floppy, pflash, virtio, none.
-@item bus=@var{bus},unit=@var{unit}
-These options define where is connected the drive by defining the bus number and
-the unit id.
-@item index=@var{index}
-This option defines where is connected the drive by using an index in the list
-of available connectors of a given interface type.
-@item media=@var{media}
-This option defines the type of the media: disk or cdrom.
-@item snapshot=@var{snapshot}
-@var{snapshot} is "on" or "off" and controls snapshot mode for the given drive
-(see @option{-snapshot}).
-@item cache=@var{cache}
-@var{cache} is "none", "writeback", "unsafe", "directsync" or "writethrough"
-and controls how the host cache is used to access block data. This is a
-shortcut that sets the @option{cache.direct} and @option{cache.no-flush}
-options (as in @option{-blockdev}), and additionally @option{cache.writeback},
-which provides a default for the @option{write-cache} option of block guest
-devices (as in @option{-device}). The modes correspond to the following
-settings:
-
-@c Our texi2pod.pl script doesn't support @multitable, so fall back to using
-@c plain ASCII art (well, UTF-8 art really). This looks okay both in the manpage
-@c and the HTML output.
-@example
-@ │ 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
-@end example
-
-The default mode is @option{cache=writeback}.
-
-@item aio=@var{aio}
-@var{aio} is "threads", or "native" and selects between pthread based disk I/O and native Linux AIO.
-@item format=@var{format}
-Specify which disk @var{format} will be used rather than detecting
-the format. Can be used to specify format=raw to avoid interpreting
-an untrusted format header.
-@item werror=@var{action},rerror=@var{action}
-Specify which @var{action} to take on write and read errors. Valid actions are:
-"ignore" (ignore the error and try to continue), "stop" (pause QEMU),
-"report" (report the error to the guest), "enospc" (pause QEMU only if the
-host disk is full; report the error to the guest otherwise).
-The default setting is @option{werror=enospc} and @option{rerror=report}.
-@item copy-on-read=@var{copy-on-read}
-@var{copy-on-read} is "on" or "off" and enables whether to copy read backing
-file sectors into the image file.
-@item bps=@var{b},bps_rd=@var{r},bps_wr=@var{w}
-Specify bandwidth throttling limits in bytes per second, either for all request
-types or for reads or writes only. Small values can lead to timeouts or hangs
-inside the guest. A safe minimum for disks is 2 MB/s.
-@item bps_max=@var{bm},bps_rd_max=@var{rm},bps_wr_max=@var{wm}
-Specify bursts in bytes per second, either for all request types or for reads
-or writes only. Bursts allow the guest I/O to spike above the limit
-temporarily.
-@item iops=@var{i},iops_rd=@var{r},iops_wr=@var{w}
-Specify request rate limits in requests per second, either for all request
-types or for reads or writes only.
-@item iops_max=@var{bm},iops_rd_max=@var{rm},iops_wr_max=@var{wm}
-Specify bursts in requests per second, either for all request types or for reads
-or writes only. Bursts allow the guest I/O to spike above the limit
-temporarily.
-@item iops_size=@var{is}
-Let every @var{is} bytes of a request count as a new request for iops
-throttling purposes. Use this option to prevent guests from circumventing iops
-limits by sending fewer but larger requests.
-@item group=@var{g}
-Join a throttling quota group with given name @var{g}. All drives that are
-members of the same group are accounted for together. Use this option to
-prevent guests from circumventing throttling limits by using many small disks
-instead of a single larger disk.
-@end table
-
-By default, the @option{cache.writeback=on} mode is used. It will report data
-writes as completed as soon as the data is present in the host page cache.
-This is safe as long as your guest OS makes sure to correctly flush disk caches
-where needed. If your guest OS does not handle volatile disk write caches
-correctly and your host crashes or loses power, then the guest may experience
-data corruption.
-
-For such guests, you should consider using @option{cache.writeback=off}. This
-means that the host page cache will be used to read and write data, but write
-notification will be sent to the guest only after QEMU has made sure to flush
-each write to the disk. Be aware that this has a major impact on performance.
-
-When using the @option{-snapshot} option, unsafe caching is always used.
-
-Copy-on-read avoids accessing the same backing file sectors repeatedly and is
-useful when the backing file is over a slow network. By default copy-on-read
-is off.
-
-Instead of @option{-cdrom} you can use:
-@example
-@value{qemu_system} -drive file=file,index=2,media=cdrom
-@end example
-
-Instead of @option{-hda}, @option{-hdb}, @option{-hdc}, @option{-hdd}, you can
-use:
-@example
-@value{qemu_system} -drive file=file,index=0,media=disk
-@value{qemu_system} -drive file=file,index=1,media=disk
-@value{qemu_system} -drive file=file,index=2,media=disk
-@value{qemu_system} -drive file=file,index=3,media=disk
-@end example
-
-You can open an image using pre-opened file descriptors from an fd set:
-@example
-@value{qemu_system} \
- -add-fd fd=3,set=2,opaque="rdwr:/path/to/file" \
- -add-fd fd=4,set=2,opaque="rdonly:/path/to/file" \
- -drive file=/dev/fdset/2,index=0,media=disk
-@end example
-
-You can connect a CDROM to the slave of ide0:
-@example
-@value{qemu_system_x86} -drive file=file,if=ide,index=1,media=cdrom
-@end example
-
-If you don't specify the "file=" argument, you define an empty drive:
-@example
-@value{qemu_system_x86} -drive if=ide,index=1,media=cdrom
-@end example
-
-Instead of @option{-fda}, @option{-fdb}, you can use:
-@example
-@value{qemu_system_x86} -drive file=file,index=0,if=floppy
-@value{qemu_system_x86} -drive file=file,index=1,if=floppy
-@end example
-
-By default, @var{interface} is "ide" and @var{index} is automatically
-incremented:
-@example
-@value{qemu_system_x86} -drive file=a -drive file=b"
-@end example
-is interpreted like:
-@example
-@value{qemu_system_x86} -hda a -hdb b
-@end example
-ETEXI
SRST
``-drive option[,option[,option[,...]]]``
Define a new drive. This includes creating a block driver node (the
@@ -2461,11 +1370,6 @@ ERST
DEF("mtdblock", HAS_ARG, QEMU_OPTION_mtdblock,
"-mtdblock file use 'file' as on-board Flash memory image\n",
QEMU_ARCH_ALL)
-STEXI
-@item -mtdblock @var{file}
-@findex -mtdblock
-Use @var{file} as on-board Flash memory image.
-ETEXI
SRST
``-mtdblock file``
Use file as on-board Flash memory image.
@@ -2473,11 +1377,6 @@ ERST
DEF("sd", HAS_ARG, QEMU_OPTION_sd,
"-sd file use 'file' as SecureDigital card image\n", QEMU_ARCH_ALL)
-STEXI
-@item -sd @var{file}
-@findex -sd
-Use @var{file} as SecureDigital card image.
-ETEXI
SRST
``-sd file``
Use file as SecureDigital card image.
@@ -2485,11 +1384,6 @@ ERST
DEF("pflash", HAS_ARG, QEMU_OPTION_pflash,
"-pflash file use 'file' as a parallel flash image\n", QEMU_ARCH_ALL)
-STEXI
-@item -pflash @var{file}
-@findex -pflash
-Use @var{file} as a parallel flash image.
-ETEXI
SRST
``-pflash file``
Use file as a parallel flash image.
@@ -2498,13 +1392,6 @@ ERST
DEF("snapshot", 0, QEMU_OPTION_snapshot,
"-snapshot write to temporary files instead of disk image files\n",
QEMU_ARCH_ALL)
-STEXI
-@item -snapshot
-@findex -snapshot
-Write to temporary files instead of disk image files. In this case,
-the raw disk image you use is not written back. You can however force
-the write back by pressing @key{C-a s} (@pxref{disk_images}).
-ETEXI
SRST
``-snapshot``
Write to temporary files instead of disk image files. In this case,
@@ -2526,93 +1413,6 @@ DEF("fsdev", HAS_ARG, QEMU_OPTION_fsdev,
"-fsdev synth,id=id\n",
QEMU_ARCH_ALL)
-STEXI
-
-@item -fsdev local,id=@var{id},path=@var{path},security_model=@var{security_model} [,writeout=@var{writeout}][,readonly][,fmode=@var{fmode}][,dmode=@var{dmode}] [,throttling.@var{option}=@var{value}[,throttling.@var{option}=@var{value}[,...]]]
-@itemx -fsdev proxy,id=@var{id},socket=@var{socket}[,writeout=@var{writeout}][,readonly]
-@itemx -fsdev proxy,id=@var{id},sock_fd=@var{sock_fd}[,writeout=@var{writeout}][,readonly]
-@itemx -fsdev synth,id=@var{id}[,readonly]
-@findex -fsdev
-Define a new file system device. Valid options are:
-@table @option
-@item local
-Accesses to the filesystem are done by QEMU.
-@item proxy
-Accesses to the filesystem are done by virtfs-proxy-helper(1).
-@item synth
-Synthetic filesystem, only used by QTests.
-@item id=@var{id}
-Specifies identifier for this device.
-@item path=@var{path}
-Specifies the export path for the file system device. Files under
-this path will be available to the 9p client on the guest.
-@item security_model=@var{security_model}
-Specifies the security model to be used for this export path.
-Supported security models are "passthrough", "mapped-xattr", "mapped-file" and "none".
-In "passthrough" security model, files are stored using the same
-credentials as they are created on the guest. This requires QEMU
-to run as root. In "mapped-xattr" security model, some of the file
-attributes like uid, gid, mode bits and link target are stored as
-file attributes. For "mapped-file" these attributes are stored in the
-hidden .virtfs_metadata directory. Directories exported by this security model cannot
-interact with other unix tools. "none" security model is same as
-passthrough except the sever won't report failures if it fails to
-set file attributes like ownership. Security model is mandatory
-only for local fsdriver. Other fsdrivers (like proxy) don't take
-security model as a parameter.
-@item writeout=@var{writeout}
-This is an optional argument. The only supported value is "immediate".
-This means that host page cache will be used to read and write data but
-write notification will be sent to the guest only when the data has been
-reported as written by the storage subsystem.
-@item readonly
-Enables exporting 9p share as a readonly mount for guests. By default
-read-write access is given.
-@item socket=@var{socket}
-Enables proxy filesystem driver to use passed socket file for communicating
-with virtfs-proxy-helper(1).
-@item sock_fd=@var{sock_fd}
-Enables proxy filesystem driver to use passed socket descriptor for
-communicating with virtfs-proxy-helper(1). Usually a helper like libvirt
-will create socketpair and pass one of the fds as sock_fd.
-@item fmode=@var{fmode}
-Specifies the default mode for newly created files on the host. Works only
-with security models "mapped-xattr" and "mapped-file".
-@item dmode=@var{dmode}
-Specifies the default mode for newly created directories on the host. Works
-only with security models "mapped-xattr" and "mapped-file".
-@item throttling.bps-total=@var{b},throttling.bps-read=@var{r},throttling.bps-write=@var{w}
-Specify bandwidth throttling limits in bytes per second, either for all request
-types or for reads or writes only.
-@item throttling.bps-total-max=@var{bm},bps-read-max=@var{rm},bps-write-max=@var{wm}
-Specify bursts in bytes per second, either for all request types or for reads
-or writes only. Bursts allow the guest I/O to spike above the limit
-temporarily.
-@item throttling.iops-total=@var{i},throttling.iops-read=@var{r}, throttling.iops-write=@var{w}
-Specify request rate limits in requests per second, either for all request
-types or for reads or writes only.
-@item throttling.iops-total-max=@var{im},throttling.iops-read-max=@var{irm}, throttling.iops-write-max=@var{iwm}
-Specify bursts in requests per second, either for all request types or for reads
-or writes only. Bursts allow the guest I/O to spike above the limit temporarily.
-@item throttling.iops-size=@var{is}
-Let every @var{is} bytes of a request count as a new request for iops
-throttling purposes.
-@end table
-
--fsdev option is used along with -device driver "virtio-9p-...".
-@item -device virtio-9p-@var{type},fsdev=@var{id},mount_tag=@var{mount_tag}
-Options for virtio-9p-... driver are:
-@table @option
-@item @var{type}
-Specifies the variant to be used. Supported values are "pci", "ccw" or "device",
-depending on the machine type.
-@item fsdev=@var{id}
-Specifies the id value specified along with -fsdev option.
-@item mount_tag=@var{mount_tag}
-Specifies the tag name to be used by the guest to mount this export point.
-@end table
-
-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[,...]]]``
\
@@ -2734,88 +1534,6 @@ DEF("virtfs", HAS_ARG, QEMU_OPTION_virtfs,
"-virtfs synth,mount_tag=tag[,id=id][,readonly]\n",
QEMU_ARCH_ALL)
-STEXI
-
-@item -virtfs local,path=@var{path},mount_tag=@var{mount_tag} ,security_model=@var{security_model}[,writeout=@var{writeout}][,readonly] [,fmode=@var{fmode}][,dmode=@var{dmode}][,multidevs=@var{multidevs}]
-@itemx -virtfs proxy,socket=@var{socket},mount_tag=@var{mount_tag} [,writeout=@var{writeout}][,readonly]
-@itemx -virtfs proxy,sock_fd=@var{sock_fd},mount_tag=@var{mount_tag} [,writeout=@var{writeout}][,readonly]
-@itemx -virtfs synth,mount_tag=@var{mount_tag}
-@findex -virtfs
-
-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:
-@table @option
-@item local
-Accesses to the filesystem are done by QEMU.
-@item proxy
-Accesses to the filesystem are done by virtfs-proxy-helper(1).
-@item synth
-Synthetic filesystem, only used by QTests.
-@item id=@var{id}
-Specifies identifier for the filesystem device
-@item path=@var{path}
-Specifies the export path for the file system device. Files under
-this path will be available to the 9p client on the guest.
-@item security_model=@var{security_model}
-Specifies the security model to be used for this export path.
-Supported security models are "passthrough", "mapped-xattr", "mapped-file" and "none".
-In "passthrough" security model, files are stored using the same
-credentials as they are created on the guest. This requires QEMU
-to run as root. In "mapped-xattr" security model, some of the file
-attributes like uid, gid, mode bits and link target are stored as
-file attributes. For "mapped-file" these attributes are stored in the
-hidden .virtfs_metadata directory. Directories exported by this security model cannot
-interact with other unix tools. "none" security model is same as
-passthrough except the sever won't report failures if it fails to
-set file attributes like ownership. Security model is mandatory only
-for local fsdriver. Other fsdrivers (like proxy) don't take security
-model as a parameter.
-@item writeout=@var{writeout}
-This is an optional argument. The only supported value is "immediate".
-This means that host page cache will be used to read and write data but
-write notification will be sent to the guest only when the data has been
-reported as written by the storage subsystem.
-@item readonly
-Enables exporting 9p share as a readonly mount for guests. By default
-read-write access is given.
-@item socket=@var{socket}
-Enables proxy filesystem driver to use passed socket file for
-communicating with virtfs-proxy-helper(1). Usually a helper like libvirt
-will create socketpair and pass one of the fds as sock_fd.
-@item sock_fd
-Enables proxy filesystem driver to use passed 'sock_fd' as the socket
-descriptor for interfacing with virtfs-proxy-helper(1).
-@item fmode=@var{fmode}
-Specifies the default mode for newly created files on the host. Works only
-with security models "mapped-xattr" and "mapped-file".
-@item dmode=@var{dmode}
-Specifies the default mode for newly created directories on the host. Works
-only with security models "mapped-xattr" and "mapped-file".
-@item mount_tag=@var{mount_tag}
-Specifies the tag name to be used by the guest to mount this export point.
-@item multidevs=@var{multidevs}
-Specifies how to deal with multiple devices being shared with a 9p export.
-Supported behaviours are either "remap", "forbid" or "warn". The latter is
-the default behaviour on which virtfs 9p expects only one device to be
-shared with the same export, and if more than one device is shared and
-accessed via the same 9p export then only a warning message is logged
-(once) by qemu on host side. In order to avoid file ID collisions on guest
-you should either create a separate virtfs export for each device to be
-shared with guests (recommended way) or you might use "remap" instead which
-allows you to share multiple devices with only one export instead, which is
-achieved by remapping the original inode numbers from host to guest in a
-way that would prevent such collisions. Remapping inodes in such use cases
-is required because the original device IDs from host are never passed and
-exposed on guest. Instead all files of an export shared with virtfs always
-share the same device id on guest. So two files with identical inode
-numbers but from actually different devices on host would otherwise cause a
-file ID collision and hence potential misbehaviours on guest. "forbid" on
-the other hand assumes like "warn" that only one device is shared by the
-same export, however it will not only log a warning message but also
-deny access to additional devices on guest. Note though that "forbid" does
-currently not block all possible file access operations (e.g. readdir()
-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]``
\
@@ -2931,37 +1649,18 @@ DEF("iscsi", HAS_ARG, QEMU_OPTION_iscsi,
" [,timeout=timeout]\n"
" iSCSI session parameters\n", QEMU_ARCH_ALL)
-STEXI
-@item -iscsi
-@findex -iscsi
-Configure iSCSI session parameters.
-ETEXI
SRST
``-iscsi``
Configure iSCSI session parameters.
ERST
-STEXI
-@end table
-ETEXI
DEFHEADING()
DEFHEADING(USB options:)
-STEXI
-@table @option
-ETEXI
DEF("usb", 0, QEMU_OPTION_usb,
"-usb enable on-board USB host controller (if not enabled by default)\n",
QEMU_ARCH_ALL)
-STEXI
-@item -usb
-@findex -usb
-Enable USB emulation on machine types with an on-board USB host controller (if
-not enabled by default). Note that on-board USB host controllers may not
-support USB 3.0. In this case @option{-device qemu-xhci} can be used instead
-on machines with PCI.
-ETEXI
SRST
``-usb``
Enable USB emulation on machine types with an on-board USB host
@@ -2973,29 +1672,6 @@ ERST
DEF("usbdevice", HAS_ARG, QEMU_OPTION_usbdevice,
"-usbdevice name add the host or guest USB device 'name'\n",
QEMU_ARCH_ALL)
-STEXI
-
-@item -usbdevice @var{devname}
-@findex -usbdevice
-Add the USB device @var{devname}. Note that this option is deprecated,
-please use @code{-device usb-...} instead. @xref{usb_devices}.
-
-@table @option
-
-@item mouse
-Virtual Mouse. This will override the PS/2 mouse emulation when activated.
-
-@item 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 braille
-Braille device. This will use BrlAPI to display the braille output on a real
-or fake device.
-
-@end table
-ETEXI
SRST
``-usbdevice devname``
Add the USB device devname. Note that this option is deprecated,
@@ -3017,15 +1693,9 @@ SRST
output on a real or fake device.
ERST
-STEXI
-@end table
-ETEXI
DEFHEADING()
DEFHEADING(Display options:)
-STEXI
-@table @option
-ETEXI
DEF("display", HAS_ARG, QEMU_OPTION_display,
#if defined(CONFIG_SPICE)
@@ -3062,46 +1732,6 @@ DEF("display", HAS_ARG, QEMU_OPTION_display,
"\"-display none\"\n"
#endif
, QEMU_ARCH_ALL)
-STEXI
-@item -display @var{type}
-@findex -display
-Select type of display to use. This option is a replacement for the
-old style -sdl/-curses/... options. Use @code{-display help} to list
-the available display types. Valid values for @var{type} are
-@table @option
-@item sdl
-Display video output via SDL (usually in a separate graphics
-window; see the SDL documentation for other possibilities).
-@item curses
-Display video output via curses. For graphics device models which
-support a text mode, QEMU can display this output using a
-curses/ncurses interface. Nothing is displayed when the graphics
-device is in graphical mode or if the graphics device does not support
-a text mode. Generally only the VGA device models support text mode.
-The font charset used by the guest can be specified with the
-@code{charset} option, for example @code{charset=CP850} for IBM CP850
-encoding. The default is @code{CP437}.
-@item none
-Do not display video output. The guest will still see an emulated
-graphics card, but its output will not be displayed to the QEMU
-user. This option differs from the -nographic option in that it
-only affects what is done with video output; -nographic also changes
-the destination of the serial and parallel port data.
-@item gtk
-Display video output in a GTK window. This interface provides drop-down
-menus and other UI elements to configure and control the VM during
-runtime.
-@item vnc
-Start a VNC server on display <arg>
-@item egl-headless
-Offload all OpenGL operations to a local DRI device. For any graphical display,
-this display needs to be paired with either VNC or SPICE displays.
-@item spice-app
-Start QEMU as a Spice server and launch the default Spice client
-application. The Spice server will redirect the serial consoles and
-QEMU monitors. (Since 4.0)
-@end table
-ETEXI
SRST
``-display type``
Select type of display to use. This option is a replacement for the
@@ -3153,18 +1783,6 @@ ERST
DEF("nographic", 0, QEMU_OPTION_nographic,
"-nographic disable graphical output and redirect serial I/Os to console\n",
QEMU_ARCH_ALL)
-STEXI
-@item -nographic
-@findex -nographic
-Normally, if QEMU is compiled with graphical window support, it displays
-output such as guest graphics, guest console, and the QEMU monitor in a
-window. With this option, you can totally disable graphical output so
-that QEMU is a simple command line application. The emulated serial port
-is redirected on the console and muxed with the monitor (unless
-redirected elsewhere explicitly). Therefore, you can still use QEMU to
-debug a Linux kernel with a serial console. Use @key{C-a h} for help on
-switching between the console and monitor.
-ETEXI
SRST
``-nographic``
Normally, if QEMU is compiled with graphical window support, it
@@ -3180,15 +1798,6 @@ ERST
DEF("curses", 0, QEMU_OPTION_curses,
"-curses shorthand for -display curses\n",
QEMU_ARCH_ALL)
-STEXI
-@item -curses
-@findex -curses
-Normally, if QEMU is compiled with graphical window support, it displays
-output such as guest graphics, guest console, and the QEMU monitor in a
-window. With this option, QEMU can display the VGA output when in text
-mode using a curses/ncurses interface. Nothing is displayed in graphical
-mode.
-ETEXI
SRST
``-curses``
Normally, if QEMU is compiled with graphical window support, it
@@ -3201,12 +1810,6 @@ ERST
DEF("alt-grab", 0, QEMU_OPTION_alt_grab,
"-alt-grab use Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt)\n",
QEMU_ARCH_ALL)
-STEXI
-@item -alt-grab
-@findex -alt-grab
-Use Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt). Note that this also
-affects the special keys (for fullscreen, monitor-mode switching, etc).
-ETEXI
SRST
``-alt-grab``
Use Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt). Note that
@@ -3217,12 +1820,6 @@ ERST
DEF("ctrl-grab", 0, QEMU_OPTION_ctrl_grab,
"-ctrl-grab use Right-Ctrl to grab mouse (instead of Ctrl-Alt)\n",
QEMU_ARCH_ALL)
-STEXI
-@item -ctrl-grab
-@findex -ctrl-grab
-Use Right-Ctrl to grab mouse (instead of Ctrl-Alt). Note that this also
-affects the special keys (for fullscreen, monitor-mode switching, etc).
-ETEXI
SRST
``-ctrl-grab``
Use Right-Ctrl to grab mouse (instead of Ctrl-Alt). Note that this
@@ -3232,11 +1829,6 @@ ERST
DEF("no-quit", 0, QEMU_OPTION_no_quit,
"-no-quit disable SDL window close capability\n", QEMU_ARCH_ALL)
-STEXI
-@item -no-quit
-@findex -no-quit
-Disable SDL window close capability.
-ETEXI
SRST
``-no-quit``
Disable SDL window close capability.
@@ -3244,11 +1836,6 @@ ERST
DEF("sdl", 0, QEMU_OPTION_sdl,
"-sdl shorthand for -display sdl\n", QEMU_ARCH_ALL)
-STEXI
-@item -sdl
-@findex -sdl
-Enable SDL.
-ETEXI
SRST
``-sdl``
Enable SDL.
@@ -3273,103 +1860,6 @@ DEF("spice", HAS_ARG, QEMU_OPTION_spice,
" enable spice\n"
" at least one of {port, tls-port} is mandatory\n",
QEMU_ARCH_ALL)
-STEXI
-@item -spice @var{option}[,@var{option}[,...]]
-@findex -spice
-Enable the spice remote desktop protocol. Valid options are
-
-@table @option
-
-@item port=<nr>
-Set the TCP port spice is listening on for plaintext channels.
-
-@item addr=<addr>
-Set the IP address spice is listening on. Default is any address.
-
-@item ipv4
-@itemx ipv6
-@itemx unix
-Force using the specified IP version.
-
-@item password=<secret>
-Set the password you need to authenticate.
-
-@item sasl
-Require that the client use SASL to authenticate with the spice.
-The exact choice of authentication method used is controlled from the
-system / user's SASL configuration file for the 'qemu' service. This
-is typically found in /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.
-While some SASL auth methods can also provide data encryption (eg GSSAPI),
-it is recommended that SASL always be combined with the 'tls' and
-'x509' settings to enable use of SSL and server certificates. This
-ensures a data encryption preventing compromise of authentication
-credentials.
-
-@item disable-ticketing
-Allow client connects without authentication.
-
-@item disable-copy-paste
-Disable copy paste between the client and the guest.
-
-@item disable-agent-file-xfer
-Disable spice-vdagent based file-xfer between the client and the guest.
-
-@item tls-port=<nr>
-Set the TCP port spice is listening on for encrypted channels.
-
-@item x509-dir=<dir>
-Set the x509 file directory. Expects same filenames as -vnc $display,x509=$dir
-
-@item x509-key-file=<file>
-@itemx x509-key-password=<file>
-@itemx x509-cert-file=<file>
-@itemx x509-cacert-file=<file>
-@itemx x509-dh-key-file=<file>
-The x509 file names can also be configured individually.
-
-@item tls-ciphers=<list>
-Specify which ciphers to use.
-
-@item tls-channel=[main|display|cursor|inputs|record|playback]
-@itemx plaintext-channel=[main|display|cursor|inputs|record|playback]
-Force specific channel to be used with or without TLS encryption. The
-options can be specified multiple times to configure multiple
-channels. The special name "default" can be used to set the default
-mode. For channels which are not explicitly forced into one mode the
-spice client is allowed to pick tls/plaintext as he pleases.
-
-@item image-compression=[auto_glz|auto_lz|quic|glz|lz|off]
-Configure image compression (lossless).
-Default is auto_glz.
-
-@item jpeg-wan-compression=[auto|never|always]
-@itemx zlib-glz-wan-compression=[auto|never|always]
-Configure wan image compression (lossy for slow links).
-Default is auto.
-
-@item streaming-video=[off|all|filter]
-Configure video stream detection. Default is off.
-
-@item agent-mouse=[on|off]
-Enable/disable passing mouse events via vdagent. Default is on.
-
-@item playback-compression=[on|off]
-Enable/disable audio stream compression (using celt 0.5.1). Default is on.
-
-@item seamless-migration=[on|off]
-Enable/disable spice seamless migration. Default is off.
-
-@item gl=[on|off]
-Enable/disable OpenGL context. Default is off.
-
-@item rendernode=<file>
-DRM render node for OpenGL rendering. If not specified, it will pick
-the first available. (Since 2.9)
-
-@end table
-ETEXI
SRST
``-spice option[,option[,...]]``
Enable the spice remote desktop protocol. Valid options are
@@ -3463,11 +1953,6 @@ ERST
DEF("portrait", 0, QEMU_OPTION_portrait,
"-portrait rotate graphical output 90 deg left (only PXA LCD)\n",
QEMU_ARCH_ALL)
-STEXI
-@item -portrait
-@findex -portrait
-Rotate graphical output 90 deg left (only PXA LCD).
-ETEXI
SRST
``-portrait``
Rotate graphical output 90 deg left (only PXA LCD).
@@ -3476,11 +1961,6 @@ ERST
DEF("rotate", HAS_ARG, QEMU_OPTION_rotate,
"-rotate <deg> rotate graphical output some deg left (only PXA LCD)\n",
QEMU_ARCH_ALL)
-STEXI
-@item -rotate @var{deg}
-@findex -rotate
-Rotate graphical output some deg left (only PXA LCD).
-ETEXI
SRST
``-rotate deg``
Rotate graphical output some deg left (only PXA LCD).
@@ -3489,43 +1969,6 @@ ERST
DEF("vga", HAS_ARG, QEMU_OPTION_vga,
"-vga [std|cirrus|vmware|qxl|xenfb|tcx|cg3|virtio|none]\n"
" select video card type\n", QEMU_ARCH_ALL)
-STEXI
-@item -vga @var{type}
-@findex -vga
-Select type of VGA card to emulate. Valid values for @var{type} are
-@table @option
-@item cirrus
-Cirrus Logic GD5446 Video card. All Windows versions starting from
-Windows 95 should recognize and use this graphic card. For optimal
-performances, use 16 bit color depth in the guest and the host OS.
-(This card was the default before QEMU 2.2)
-@item std
-Standard VGA card with Bochs VBE extensions. If your guest OS
-supports the VESA 2.0 VBE extensions (e.g. Windows XP) and if you want
-to use high resolution modes (>= 1280x1024x16) then you should use
-this option. (This card is the default since QEMU 2.2)
-@item vmware
-VMWare SVGA-II compatible adapter. Use it if you have sufficiently
-recent XFree86/XOrg server or Windows guest with a driver for this
-card.
-@item qxl
-QXL paravirtual graphic card. It is VGA compatible (including VESA
-2.0 VBE support). Works best with qxl guest drivers installed though.
-Recommended choice when using the spice protocol.
-@item tcx
-(sun4m only) Sun TCX framebuffer. This is the default framebuffer for
-sun4m machines and offers both 8-bit and 24-bit colour depths at a
-fixed resolution of 1024x768.
-@item cg3
-(sun4m only) Sun cgthree framebuffer. This is a simple 8-bit framebuffer
-for sun4m machines available in both 1024x768 (OpenBIOS) and 1152x900 (OBP)
-resolutions aimed at people wishing to run older Solaris versions.
-@item virtio
-Virtio VGA card.
-@item none
-Disable VGA card.
-@end table
-ETEXI
SRST
``-vga type``
Select type of VGA card to emulate. Valid values for type are
@@ -3574,11 +2017,6 @@ ERST
DEF("full-screen", 0, QEMU_OPTION_full_screen,
"-full-screen start in full screen\n", QEMU_ARCH_ALL)
-STEXI
-@item -full-screen
-@findex -full-screen
-Start in full screen.
-ETEXI
SRST
``-full-screen``
Start in full screen.
@@ -3587,18 +2025,6 @@ ERST
DEF("g", HAS_ARG, QEMU_OPTION_g ,
"-g WxH[xDEPTH] Set the initial graphical resolution and depth\n",
QEMU_ARCH_PPC | QEMU_ARCH_SPARC | QEMU_ARCH_M68K)
-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
SRST
``-g`` *width*\ ``x``\ *height*\ ``[x``\ *depth*\ ``]``
Set the initial graphical resolution and depth (PPC, SPARC only).
@@ -3613,188 +2039,6 @@ ERST
DEF("vnc", HAS_ARG, QEMU_OPTION_vnc ,
"-vnc <display> shorthand for -display vnc=<display>\n", QEMU_ARCH_ALL)
-STEXI
-@item -vnc @var{display}[,@var{option}[,@var{option}[,...]]]
-@findex -vnc
-Normally, if QEMU is compiled with graphical window support, it displays
-output such as guest graphics, guest console, and the QEMU monitor in a
-window. With this option, you can have QEMU listen on VNC display
-@var{display} and redirect the VGA display over the VNC session. It is
-very useful to enable the usb tablet device when using this option
-(option @option{-device usb-tablet}). When using the VNC display, you
-must use the @option{-k} parameter to set the keyboard layout if you are
-not using en-us. Valid syntax for the @var{display} is
-
-@table @option
-
-@item to=@var{L}
-
-With this option, QEMU will try next available VNC @var{display}s, until the
-number @var{L}, if the origianlly defined "-vnc @var{display}" is not
-available, e.g. port 5900+@var{display} is already used by another
-application. By default, to=0.
-
-@item @var{host}:@var{d}
-
-TCP connections will only be allowed from @var{host} on display @var{d}.
-By convention the TCP port is 5900+@var{d}. Optionally, @var{host} can
-be omitted in which case the server will accept connections from any host.
-
-@item unix:@var{path}
-
-Connections will be allowed over UNIX domain sockets where @var{path} is the
-location of a unix socket to listen for connections on.
-
-@item none
-
-VNC is initialized but not started. The monitor @code{change} command
-can be used to later start the VNC server.
-
-@end table
-
-Following the @var{display} value there may be one or more @var{option} flags
-separated by commas. Valid options are
-
-@table @option
-
-@item reverse
-
-Connect to a listening VNC client via a ``reverse'' connection. The
-client is specified by the @var{display}. For reverse network
-connections (@var{host}:@var{d},@code{reverse}), the @var{d} argument
-is a TCP port number, not a display number.
-
-@item websocket
-
-Opens an additional TCP listening port dedicated to VNC Websocket connections.
-If a bare @var{websocket} option is given, the Websocket port is
-5700+@var{display}. An alternative port can be specified with the
-syntax @code{websocket}=@var{port}.
-
-If @var{host} is specified connections will only be allowed from this host.
-It is possible to control the websocket listen address independently, using
-the syntax @code{websocket}=@var{host}:@var{port}.
-
-If no TLS credentials are provided, the websocket connection runs in
-unencrypted mode. If TLS credentials are provided, the websocket connection
-requires encrypted client connections.
-
-@item password
-
-Require that password based authentication is used for client connections.
-
-The password must be set separately using the @code{set_password} command in
-the @ref{pcsys_monitor}. The syntax to change your password is:
-@code{set_password <protocol> <password>} where <protocol> could be either
-"vnc" or "spice".
-
-If you would like to change <protocol> password expiration, you should use
-@code{expire_password <protocol> <expiration-time>} where expiration time could
-be one of the following options: now, never, +seconds or UNIX time of
-expiration, e.g. +60 to make password expire in 60 seconds, or 1335196800
-to make password expire on "Mon Apr 23 12:00:00 EDT 2012" (UNIX time for this
-date and time).
-
-You can also use keywords "now" or "never" for the expiration time to
-allow <protocol> password to expire immediately or never expire.
-
-@item tls-creds=@var{ID}
-
-Provides the ID of a set of TLS credentials to use to secure the
-VNC server. They will apply to both the normal VNC server socket
-and the websocket socket (if enabled). Setting TLS credentials
-will cause the VNC server socket to enable the VeNCrypt auth
-mechanism. The credentials should have been previously created
-using the @option{-object tls-creds} argument.
-
-@item tls-authz=@var{ID}
-
-Provides the ID of the QAuthZ authorization object against which
-the client's x509 distinguished name will validated. This object is
-only resolved at time of use, so can be deleted and recreated on the
-fly while the VNC server is active. If missing, it will default
-to denying access.
-
-@item sasl
-
-Require that the client use SASL to authenticate with the VNC server.
-The exact choice of authentication method used is controlled from the
-system / user's SASL configuration file for the 'qemu' service. This
-is typically found in /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.
-While some SASL auth methods can also provide data encryption (eg GSSAPI),
-it is recommended that SASL always be combined with the 'tls' and
-'x509' settings to enable use of SSL and server certificates. This
-ensures a data encryption preventing compromise of authentication
-credentials. See the @ref{vnc_security} section for details on using
-SASL authentication.
-
-@item sasl-authz=@var{ID}
-
-Provides the ID of the QAuthZ authorization object against which
-the client's SASL username will validated. This object is
-only resolved at time of use, so can be deleted and recreated on the
-fly while the VNC server is active. If missing, it will default
-to denying access.
-
-@item acl
-
-Legacy method for enabling authorization of clients against the
-x509 distinguished name and SASL username. It results in the creation
-of two @code{authz-list} objects with IDs of @code{vnc.username} and
-@code{vnc.x509dname}. The rules for these objects must be configured
-with the HMP ACL commands.
-
-This option is deprecated and should no longer be used. The new
-@option{sasl-authz} and @option{tls-authz} options are a
-replacement.
-
-@item lossy
-
-Enable lossy compression methods (gradient, JPEG, ...). If this
-option is set, VNC client may receive lossy framebuffer updates
-depending on its encoding settings. Enabling this option can save
-a lot of bandwidth at the expense of quality.
-
-@item non-adaptive
-
-Disable adaptive encodings. Adaptive encodings are enabled by default.
-An adaptive encoding will try to detect frequently updated screen regions,
-and send updates in these regions using a lossy encoding (like JPEG).
-This can be really helpful to save bandwidth when playing videos. Disabling
-adaptive encodings restores the original static behavior of encodings
-like Tight.
-
-@item share=[allow-exclusive|force-shared|ignore]
-
-Set display sharing policy. 'allow-exclusive' allows clients to ask
-for exclusive access. As suggested by the rfb spec this is
-implemented by dropping other connections. Connecting multiple
-clients in parallel requires all clients asking for a shared session
-(vncviewer: -shared switch). This is the default. 'force-shared'
-disables exclusive client access. Useful for shared desktop sessions,
-where you don't want someone forgetting specify -shared disconnect
-everybody else. 'ignore' completely ignores the shared flag and
-allows everybody connect unconditionally. Doesn't conform to the rfb
-spec but is traditional QEMU behavior.
-
-@item key-delay-ms
-
-Set keyboard delay, for key down and key up events, in milliseconds.
-Default is 10. Keyboards are low-bandwidth devices, so this slowdown
-can help the device and guest to keep up and not lose events in case
-events are arriving in bulk. Possible causes for the latter are flaky
-network connections, or scripts for automated testing.
-
-@item audiodev=@var{audiodev}
-
-Use the specified @var{audiodev} when the VNC client requests audio
-transmission. When not using an -audiodev argument, this option must
-be omitted, otherwise is must be present and specify a valid audiodev.
-
-@end table
-ETEXI
SRST
``-vnc display[,option[,option[,...]]]``
Normally, if QEMU is compiled with graphical window support, it
@@ -3961,26 +2205,13 @@ SRST
valid audiodev.
ERST
-STEXI
-@end table
-ETEXI
ARCHHEADING(, QEMU_ARCH_I386)
ARCHHEADING(i386 target only:, QEMU_ARCH_I386)
-STEXI
-@table @option
-ETEXI
DEF("win2k-hack", 0, QEMU_OPTION_win2k_hack,
"-win2k-hack use it when installing Windows 2000 to avoid a disk full bug\n",
QEMU_ARCH_I386)
-STEXI
-@item -win2k-hack
-@findex -win2k-hack
-Use it when installing Windows 2000 to avoid a disk full bug. After
-Windows 2000 is installed, you no longer need this option (this option
-slows down the IDE transfers).
-ETEXI
SRST
``-win2k-hack``
Use it when installing Windows 2000 to avoid a disk full bug. After
@@ -3991,12 +2222,6 @@ ERST
DEF("no-fd-bootchk", 0, QEMU_OPTION_no_fd_bootchk,
"-no-fd-bootchk disable boot signature checking for floppy disks\n",
QEMU_ARCH_I386)
-STEXI
-@item -no-fd-bootchk
-@findex -no-fd-bootchk
-Disable boot signature checking for floppy disks in BIOS. May
-be needed to boot from old floppy disks.
-ETEXI
SRST
``-no-fd-bootchk``
Disable boot signature checking for floppy disks in BIOS. May be
@@ -4005,13 +2230,6 @@ ERST
DEF("no-acpi", 0, QEMU_OPTION_no_acpi,
"-no-acpi disable ACPI\n", QEMU_ARCH_I386 | QEMU_ARCH_ARM)
-STEXI
-@item -no-acpi
-@findex -no-acpi
-Disable ACPI (Advanced Configuration and Power Interface) support. Use
-it if your guest OS complains about ACPI problems (PC target machine
-only).
-ETEXI
SRST
``-no-acpi``
Disable ACPI (Advanced Configuration and Power Interface) support.
@@ -4021,11 +2239,6 @@ ERST
DEF("no-hpet", 0, QEMU_OPTION_no_hpet,
"-no-hpet disable HPET\n", QEMU_ARCH_I386)
-STEXI
-@item -no-hpet
-@findex -no-hpet
-Disable HPET support.
-ETEXI
SRST
``-no-hpet``
Disable HPET support.
@@ -4034,20 +2247,6 @@ ERST
DEF("acpitable", HAS_ARG, QEMU_OPTION_acpitable,
"-acpitable [sig=str][,rev=n][,oem_id=str][,oem_table_id=str][,oem_rev=n][,asl_compiler_id=str][,asl_compiler_rev=n][,{data|file}=file1[:file2]...]\n"
" ACPI table description\n", QEMU_ARCH_I386)
-STEXI
-@item -acpitable [sig=@var{str}][,rev=@var{n}][,oem_id=@var{str}][,oem_table_id=@var{str}][,oem_rev=@var{n}] [,asl_compiler_id=@var{str}][,asl_compiler_rev=@var{n}][,data=@var{file1}[:@var{file2}]...]
-@findex -acpitable
-Add ACPI table with specified header fields and context from specified files.
-For file=, take whole ACPI table from the specified files, including all
-ACPI headers (possible overridden by other options).
-For data=, only data
-portion of the table is used, all header information is specified in the
-command line.
-If a SLIC table is supplied to QEMU, then the SLIC's oem_id and oem_table_id
-fields will override the same in the RSDT and the FADT (a.k.a. FACP), in order
-to ensure the field matches required by the Microsoft SLIC spec and the ACPI
-spec.
-ETEXI
SRST
``-acpitable [sig=str][,rev=n][,oem_id=str][,oem_table_id=str][,oem_rev=n] [,asl_compiler_id=str][,asl_compiler_rev=n][,data=file1[:file2]...]``
Add ACPI table with specified header fields and context from
@@ -4083,29 +2282,6 @@ DEF("smbios", HAS_ARG, QEMU_OPTION_smbios,
" [,asset=str][,part=str][,speed=%d]\n"
" specify SMBIOS type 17 fields\n",
QEMU_ARCH_I386 | QEMU_ARCH_ARM)
-STEXI
-@item -smbios file=@var{binary}
-@findex -smbios
-Load SMBIOS entry from binary file.
-
-@item -smbios type=0[,vendor=@var{str}][,version=@var{str}][,date=@var{str}][,release=@var{%d.%d}][,uefi=on|off]
-Specify SMBIOS type 0 fields
-
-@item -smbios type=1[,manufacturer=@var{str}][,product=@var{str}][,version=@var{str}][,serial=@var{str}][,uuid=@var{uuid}][,sku=@var{str}][,family=@var{str}]
-Specify SMBIOS type 1 fields
-
-@item -smbios type=2[,manufacturer=@var{str}][,product=@var{str}][,version=@var{str}][,serial=@var{str}][,asset=@var{str}][,location=@var{str}]
-Specify SMBIOS type 2 fields
-
-@item -smbios type=3[,manufacturer=@var{str}][,version=@var{str}][,serial=@var{str}][,asset=@var{str}][,sku=@var{str}]
-Specify SMBIOS type 3 fields
-
-@item -smbios type=4[,sock_pfx=@var{str}][,manufacturer=@var{str}][,version=@var{str}][,serial=@var{str}][,asset=@var{str}][,part=@var{str}]
-Specify SMBIOS type 4 fields
-
-@item -smbios type=17[,loc_pfx=@var{str}][,bank=@var{str}][,manufacturer=@var{str}][,serial=@var{str}][,asset=@var{str}][,part=@var{str}][,speed=@var{%d}]
-Specify SMBIOS type 17 fields
-ETEXI
SRST
``-smbios file=binary``
Load SMBIOS entry from binary file.
@@ -4129,15 +2305,9 @@ SRST
Specify SMBIOS type 17 fields
ERST
-STEXI
-@end table
-ETEXI
DEFHEADING()
DEFHEADING(Network options:)
-STEXI
-@table @option
-ETEXI
DEF("netdev", HAS_ARG, QEMU_OPTION_netdev,
#ifdef CONFIG_SLIRP
@@ -4284,448 +2454,6 @@ DEF("net", HAS_ARG, QEMU_OPTION_net,
"socket][,option][,option][,...]\n"
" old way to initialize a host network interface\n"
" (use the -netdev option if possible instead)\n", QEMU_ARCH_ALL)
-STEXI
-@item -nic [tap|bridge|user|l2tpv3|vde|netmap|vhost-user|socket][,...][,mac=macaddr][,model=mn]
-@findex -nic
-This option is a shortcut for configuring both the on-board (default) guest
-NIC hardware and the host network backend in one go. The host backend options
-are the same as with the corresponding @option{-netdev} options below.
-The guest NIC model can be set with @option{model=@var{modelname}}.
-Use @option{model=help} to list the available device types.
-The hardware MAC address can be set with @option{mac=@var{macaddr}}.
-
-The following two example do exactly the same, to show how @option{-nic} can
-be used to shorten the command line length:
-@example
-@value{qemu_system} -netdev user,id=n1,ipv6=off -device e1000,netdev=n1,mac=52:54:98:76:54:32
-@value{qemu_system} -nic user,ipv6=off,model=e1000,mac=52:54:98:76:54:32
-@end example
-
-@item -nic none
-Indicate that no network devices should be configured. It is used to override
-the default configuration (default NIC with ``user'' host network backend)
-which is activated if no other networking options are provided.
-
-@item -netdev user,id=@var{id}[,@var{option}][,@var{option}][,...]
-@findex -netdev
-Configure user mode host network backend which requires no administrator
-privilege to run. Valid options are:
-
-@table @option
-@item id=@var{id}
-Assign symbolic name for use in monitor commands.
-
-@item ipv4=on|off and ipv6=on|off
-Specify that either IPv4 or IPv6 must be enabled. If neither is specified
-both protocols are enabled.
-
-@item net=@var{addr}[/@var{mask}]
-Set IP network address the guest will see. Optionally specify the netmask,
-either in the form a.b.c.d or as number of valid top-most bits. Default is
-10.0.2.0/24.
-
-@item host=@var{addr}
-Specify the guest-visible address of the host. Default is the 2nd IP in the
-guest network, i.e. x.x.x.2.
-
-@item ipv6-net=@var{addr}[/@var{int}]
-Set IPv6 network address the guest will see (default is fec0::/64). The
-network prefix is given in the usual hexadecimal IPv6 address
-notation. The prefix size is optional, and is given as the number of
-valid top-most bits (default is 64).
-
-@item ipv6-host=@var{addr}
-Specify the guest-visible IPv6 address of the host. Default is the 2nd IPv6 in
-the guest network, i.e. xxxx::2.
-
-@item restrict=on|off
-If this option is enabled, the guest will be isolated, i.e. it will not be
-able to contact the host and no guest IP packets will be routed over the host
-to the outside. This option does not affect any explicitly set forwarding rules.
-
-@item hostname=@var{name}
-Specifies the client hostname reported by the built-in DHCP server.
-
-@item dhcpstart=@var{addr}
-Specify the first of the 16 IPs the built-in DHCP server can assign. Default
-is the 15th to 31st IP in the guest network, i.e. x.x.x.15 to x.x.x.31.
-
-@item dns=@var{addr}
-Specify the guest-visible address of the virtual nameserver. The address must
-be different from the host address. Default is the 3rd IP in the guest network,
-i.e. x.x.x.3.
-
-@item ipv6-dns=@var{addr}
-Specify the guest-visible address of the IPv6 virtual nameserver. The address
-must be different from the host address. Default is the 3rd IP in the guest
-network, i.e. xxxx::3.
-
-@item dnssearch=@var{domain}
-Provides an entry for the domain-search list sent by the built-in
-DHCP server. More than one domain suffix can be transmitted by specifying
-this option multiple times. If supported, this will cause the guest to
-automatically try to append the given domain suffix(es) in case a domain name
-can not be resolved.
-
-Example:
-@example
-@value{qemu_system} -nic user,dnssearch=mgmt.example.org,dnssearch=example.org
-@end example
-
-@item domainname=@var{domain}
-Specifies the client domain name reported by the built-in DHCP server.
-
-@item tftp=@var{dir}
-When using the user mode network stack, activate a built-in TFTP
-server. The files in @var{dir} will be exposed as the root of a TFTP server.
-The TFTP client on the guest must be configured in binary mode (use the command
-@code{bin} of the Unix TFTP client).
-
-@item tftp-server-name=@var{name}
-In BOOTP reply, broadcast @var{name} as the "TFTP server name" (RFC2132 option
-66). This can be used to advise the guest to load boot files or configurations
-from a different server than the host address.
-
-@item bootfile=@var{file}
-When using the user mode network stack, broadcast @var{file} as the BOOTP
-filename. In conjunction with @option{tftp}, this can be used to network boot
-a guest from a local directory.
-
-Example (using pxelinux):
-@example
-@value{qemu_system} -hda linux.img -boot n -device e1000,netdev=n1 \
- -netdev user,id=n1,tftp=/path/to/tftp/files,bootfile=/pxelinux.0
-@end example
-
-@item smb=@var{dir}[,smbserver=@var{addr}]
-When using the user mode network stack, activate a built-in SMB
-server so that Windows OSes can access to the host files in @file{@var{dir}}
-transparently. The IP address of the SMB server can be set to @var{addr}. By
-default the 4th IP in the guest network is used, i.e. x.x.x.4.
-
-In the guest Windows OS, the line:
-@example
-10.0.2.4 smbserver
-@end example
-must be added in the file @file{C:\WINDOWS\LMHOSTS} (for windows 9x/Me)
-or @file{C:\WINNT\SYSTEM32\DRIVERS\ETC\LMHOSTS} (Windows NT/2000).
-
-Then @file{@var{dir}} can be accessed in @file{\\smbserver\qemu}.
-
-Note that a SAMBA server must be installed on the host OS.
-
-@item hostfwd=[tcp|udp]:[@var{hostaddr}]:@var{hostport}-[@var{guestaddr}]:@var{guestport}
-Redirect incoming TCP or UDP connections to the host port @var{hostport} to
-the guest IP address @var{guestaddr} on guest port @var{guestport}. If
-@var{guestaddr} is not specified, its value is x.x.x.15 (default first address
-given by the built-in DHCP server). By specifying @var{hostaddr}, the rule can
-be bound to a specific host interface. If no connection type is set, TCP is
-used. This option can be given multiple times.
-
-For example, to redirect host X11 connection from screen 1 to guest
-screen 0, use the following:
-
-@example
-# on the host
-@value{qemu_system} -nic user,hostfwd=tcp:127.0.0.1:6001-:6000
-# this host xterm should open in the guest X11 server
-xterm -display :1
-@end example
-
-To redirect telnet connections from host port 5555 to telnet port on
-the guest, use the following:
-
-@example
-# on the host
-@value{qemu_system} -nic user,hostfwd=tcp::5555-:23
-telnet localhost 5555
-@end example
-
-Then when you use on the host @code{telnet localhost 5555}, you
-connect to the guest telnet server.
-
-@item guestfwd=[tcp]:@var{server}:@var{port}-@var{dev}
-@itemx guestfwd=[tcp]:@var{server}:@var{port}-@var{cmd:command}
-Forward guest TCP connections to the IP address @var{server} on port @var{port}
-to the character device @var{dev} or to a program executed by @var{cmd:command}
-which gets spawned for each connection. This option can be given multiple times.
-
-You can either use a chardev directly and have that one used throughout QEMU's
-lifetime, like in the following example:
-
-@example
-# open 10.10.1.1:4321 on bootup, connect 10.0.2.100:1234 to it whenever
-# the guest accesses it
-@value{qemu_system} -nic user,guestfwd=tcp:10.0.2.100:1234-tcp:10.10.1.1:4321
-@end example
-
-Or you can execute a command on every TCP connection established by the guest,
-so that QEMU behaves similar to an inetd process for that virtual server:
-
-@example
-# 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
-@value{qemu_system} -nic 'user,id=n1,guestfwd=tcp:10.0.2.100:1234-cmd:netcat 10.10.1.1 4321'
-@end example
-
-@end table
-
-@item -netdev tap,id=@var{id}[,fd=@var{h}][,ifname=@var{name}][,script=@var{file}][,downscript=@var{dfile}][,br=@var{bridge}][,helper=@var{helper}]
-Configure a host TAP network backend with ID @var{id}.
-
-Use the network script @var{file} to configure it and the network script
-@var{dfile} to deconfigure it. If @var{name} is not provided, the OS
-automatically provides one. The default network configure script is
-@file{/etc/qemu-ifup} and the default network deconfigure script is
-@file{/etc/qemu-ifdown}. Use @option{script=no} or @option{downscript=no}
-to disable script execution.
-
-If running QEMU as an unprivileged user, use the network helper
-@var{helper} to configure the TAP interface and attach it to the bridge.
-The default network helper executable is @file{/path/to/qemu-bridge-helper}
-and the default bridge device is @file{br0}.
-
-@option{fd}=@var{h} can be used to specify the handle of an already
-opened host TAP interface.
-
-Examples:
-
-@example
-#launch a QEMU instance with the default network script
-@value{qemu_system} linux.img -nic tap
-@end example
-
-@example
-#launch a QEMU instance with two NICs, each one connected
-#to a TAP device
-@value{qemu_system} linux.img \
- -netdev tap,id=nd0,ifname=tap0 -device e1000,netdev=nd0 \
- -netdev tap,id=nd1,ifname=tap1 -device rtl8139,netdev=nd1
-@end example
-
-@example
-#launch a QEMU instance with the default network helper to
-#connect a TAP device to bridge br0
-@value{qemu_system} linux.img -device virtio-net-pci,netdev=n1 \
- -netdev tap,id=n1,"helper=/path/to/qemu-bridge-helper"
-@end example
-
-@item -netdev bridge,id=@var{id}[,br=@var{bridge}][,helper=@var{helper}]
-Connect a host TAP network interface to a host bridge device.
-
-Use the network helper @var{helper} to configure the TAP interface and
-attach it to the bridge. The default network helper executable is
-@file{/path/to/qemu-bridge-helper} and the default bridge
-device is @file{br0}.
-
-Examples:
-
-@example
-#launch a QEMU instance with the default network helper to
-#connect a TAP device to bridge br0
-@value{qemu_system} linux.img -netdev bridge,id=n1 -device virtio-net,netdev=n1
-@end example
-
-@example
-#launch a QEMU instance with the default network helper to
-#connect a TAP device to bridge qemubr0
-@value{qemu_system} linux.img -netdev bridge,br=qemubr0,id=n1 -device virtio-net,netdev=n1
-@end example
-
-@item -netdev socket,id=@var{id}[,fd=@var{h}][,listen=[@var{host}]:@var{port}][,connect=@var{host}:@var{port}]
-
-This host network backend can be used to connect the guest's network to
-another QEMU virtual machine using a TCP socket connection. If @option{listen}
-is specified, QEMU waits for incoming connections on @var{port}
-(@var{host} is optional). @option{connect} is used to connect to
-another QEMU instance using the @option{listen} option. @option{fd}=@var{h}
-specifies an already opened TCP socket.
-
-Example:
-@example
-# launch a first QEMU instance
-@value{qemu_system} linux.img \
- -device e1000,netdev=n1,mac=52:54:00:12:34:56 \
- -netdev socket,id=n1,listen=:1234
-# connect the network of this instance to the network of the first instance
-@value{qemu_system} linux.img \
- -device e1000,netdev=n2,mac=52:54:00:12:34:57 \
- -netdev socket,id=n2,connect=127.0.0.1:1234
-@end example
-
-@item -netdev socket,id=@var{id}[,fd=@var{h}][,mcast=@var{maddr}:@var{port}[,localaddr=@var{addr}]]
-
-Configure a socket host network backend to share the guest's network traffic
-with another QEMU virtual machines using a UDP multicast socket, effectively
-making a bus for every QEMU with same multicast address @var{maddr} and @var{port}.
-NOTES:
-@enumerate
-@item
-Several QEMU can be running on different hosts and share same bus (assuming
-correct multicast setup for these hosts).
-@item
-mcast support is compatible with User Mode Linux (argument @option{eth@var{N}=mcast}), see
-@url{http://user-mode-linux.sf.net}.
-@item
-Use @option{fd=h} to specify an already opened UDP multicast socket.
-@end enumerate
-
-Example:
-@example
-# launch one QEMU instance
-@value{qemu_system} linux.img \
- -device e1000,netdev=n1,mac=52:54:00:12:34:56 \
- -netdev socket,id=n1,mcast=230.0.0.1:1234
-# launch another QEMU instance on same "bus"
-@value{qemu_system} linux.img \
- -device e1000,netdev=n2,mac=52:54:00:12:34:57 \
- -netdev socket,id=n2,mcast=230.0.0.1:1234
-# launch yet another QEMU instance on same "bus"
-@value{qemu_system} linux.img \
- -device e1000,netdev=n3,mac=52:54:00:12:34:58 \
- -netdev socket,id=n3,mcast=230.0.0.1:1234
-@end example
-
-Example (User Mode Linux compat.):
-@example
-# launch QEMU instance (note mcast address selected is UML's default)
-@value{qemu_system} linux.img \
- -device e1000,netdev=n1,mac=52:54:00:12:34:56 \
- -netdev socket,id=n1,mcast=239.192.168.1:1102
-# launch UML
-/path/to/linux ubd0=/path/to/root_fs eth0=mcast
-@end example
-
-Example (send packets from host's 1.2.3.4):
-@example
-@value{qemu_system} linux.img \
- -device e1000,netdev=n1,mac=52:54:00:12:34:56 \
- -netdev socket,id=n1,mcast=239.192.168.1:1102,localaddr=1.2.3.4
-@end example
-
-@item -netdev l2tpv3,id=@var{id},src=@var{srcaddr},dst=@var{dstaddr}[,srcport=@var{srcport}][,dstport=@var{dstport}],txsession=@var{txsession}[,rxsession=@var{rxsession}][,ipv6][,udp][,cookie64][,counter][,pincounter][,txcookie=@var{txcookie}][,rxcookie=@var{rxcookie}][,offset=@var{offset}]
-Configure a L2TPv3 pseudowire host network backend. L2TPv3 (RFC3391) is a
-popular protocol to transport Ethernet (and other Layer 2) data frames between
-two systems. It is present in routers, firewalls and the Linux kernel
-(from version 3.3 onwards).
-
-This transport allows a VM to communicate to another VM, router or firewall directly.
-
-@table @option
-@item src=@var{srcaddr}
- source address (mandatory)
-@item dst=@var{dstaddr}
- destination address (mandatory)
-@item udp
- select udp encapsulation (default is ip).
-@item srcport=@var{srcport}
- source udp port.
-@item dstport=@var{dstport}
- destination udp port.
-@item ipv6
- force v6, otherwise defaults to v4.
-@item rxcookie=@var{rxcookie}
-@itemx txcookie=@var{txcookie}
- Cookies are a weak form of security in the l2tpv3 specification.
-Their function is mostly to prevent misconfiguration. By default they are 32
-bit.
-@item cookie64
- Set cookie size to 64 bit instead of the default 32
-@item counter=off
- Force a 'cut-down' L2TPv3 with no counter as in
-draft-mkonstan-l2tpext-keyed-ipv6-tunnel-00
-@item pincounter=on
- Work around broken counter handling in peer. This may also help on
-networks which have packet reorder.
-@item offset=@var{offset}
- Add an extra offset between header and data
-@end table
-
-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:
-@example
-# Setup tunnel on linux host using raw ip as encapsulation
-# on 1.2.3.4
-ip l2tp add tunnel remote 4.3.2.1 local 1.2.3.4 tunnel_id 1 peer_tunnel_id 1 \
- encap udp udp_sport 16384 udp_dport 16384
-ip l2tp add session tunnel_id 1 name vmtunnel0 session_id \
- 0xFFFFFFFF peer_session_id 0xFFFFFFFF
-ifconfig vmtunnel0 mtu 1500
-ifconfig vmtunnel0 up
-brctl addif br-lan vmtunnel0
-
-
-# on 4.3.2.1
-# launch QEMU instance - if your network has reorder or is very lossy add ,pincounter
-
-@value{qemu_system} linux.img -device e1000,netdev=n1 \
- -netdev l2tpv3,id=n1,src=4.2.3.1,dst=1.2.3.4,udp,srcport=16384,dstport=16384,rxsession=0xffffffff,txsession=0xffffffff,counter
-
-@end example
-
-@item -netdev vde,id=@var{id}[,sock=@var{socketpath}][,port=@var{n}][,group=@var{groupname}][,mode=@var{octalmode}]
-Configure VDE backend to connect to PORT @var{n} of a vde switch running on host and
-listening for incoming connections on @var{socketpath}. Use GROUP @var{groupname}
-and MODE @var{octalmode} to change default ownership and permissions for
-communication port. This option is only available if QEMU has been compiled
-with vde support enabled.
-
-Example:
-@example
-# launch vde switch
-vde_switch -F -sock /tmp/myswitch
-# launch QEMU instance
-@value{qemu_system} linux.img -nic vde,sock=/tmp/myswitch
-@end example
-
-@item -netdev vhost-user,chardev=@var{id}[,vhostforce=on|off][,queues=n]
-
-Establish a vhost-user netdev, backed by a chardev @var{id}. The chardev should
-be a unix domain socket backed one. The vhost-user uses a specifically defined
-protocol to pass vhost ioctl replacement messages to an application on the other
-end of the socket. On non-MSIX guests, the feature can be forced with
-@var{vhostforce}. Use 'queues=@var{n}' to specify the number of queues to
-be created for multiqueue vhost-user.
-
-Example:
-@example
-qemu -m 512 -object memory-backend-file,id=mem,size=512M,mem-path=/hugetlbfs,share=on \
- -numa node,memdev=mem \
- -chardev socket,id=chr0,path=/path/to/socket \
- -netdev type=vhost-user,id=net0,chardev=chr0 \
- -device virtio-net-pci,netdev=net0
-@end example
-
-@item -netdev hubport,id=@var{id},hubid=@var{hubid}[,netdev=@var{nd}]
-
-Create a hub port on the emulated hub with ID @var{hubid}.
-
-The hubport netdev lets you connect a NIC to a QEMU emulated hub instead of a
-single netdev. Alternatively, you can also connect the hubport to another
-netdev with ID @var{nd} by using the @option{netdev=@var{nd}} option.
-
-@item -net nic[,netdev=@var{nd}][,macaddr=@var{mac}][,model=@var{type}] [,name=@var{name}][,addr=@var{addr}][,vectors=@var{v}]
-@findex -net
-Legacy option to configure or create an on-board (or machine default) Network
-Interface Card(NIC) and connect it either to the emulated hub with ID 0 (i.e.
-the default hub), or to the netdev @var{nd}.
-If @var{model} is omitted, then the default NIC model associated with
-the machine type is used. Note that the default NIC model may change in
-future QEMU releases, so it is highly recommended to always specify a model.
-Optionally, the MAC address can be changed to @var{mac}, the device
-address set to @var{addr} (PCI cards only), and a @var{name} can be
-assigned for use in monitor commands.
-Optionally, for PCI cards, you can specify the number @var{v} of MSI-X vectors
-that the card should have; this option currently only affects virtio cards; set
-@var{v} = 0 to disable MSI-X. If no @option{-net} option is specified, a single
-NIC is created. QEMU can emulate several different models of network card.
-Use @code{-net nic,model=help} for a list of available devices for your target.
-
-@item -net user|tap|bridge|socket|l2tpv3|vde[,...][,name=@var{name}]
-Configure a host network backend (with the options corresponding to the same
-@option{-netdev} option) and connect it to the emulated hub 0 (the default
-hub). Use @var{name} to specify the name of the hub port.
-ETEXI
SRST
``-nic [tap|bridge|user|l2tpv3|vde|netmap|vhost-user|socket][,...][,mac=macaddr][,model=mn]``
This option is a shortcut for configuring both the on-board
@@ -5191,9 +2919,6 @@ SRST
(the default hub). Use name to specify the name of the hub port.
ERST
-STEXI
-@end table
-ETEXI
DEFHEADING()
DEFHEADING(Character device options:)
@@ -5241,298 +2966,6 @@ DEF("chardev", HAS_ARG, QEMU_OPTION_chardev,
, QEMU_ARCH_ALL
)
-STEXI
-
-The general form of a character device option is:
-@table @option
-@item -chardev @var{backend},id=@var{id}[,mux=on|off][,@var{options}]
-@findex -chardev
-Backend is one of:
-@option{null},
-@option{socket},
-@option{udp},
-@option{msmouse},
-@option{vc},
-@option{ringbuf},
-@option{file},
-@option{pipe},
-@option{console},
-@option{serial},
-@option{pty},
-@option{stdio},
-@option{braille},
-@option{tty},
-@option{parallel},
-@option{parport},
-@option{spicevmc},
-@option{spiceport}.
-The specific backend will determine the applicable options.
-
-Use @code{-chardev help} to print all available chardev backend types.
-
-All devices must have an id, which can be any string up to 127 characters long.
-It is used to uniquely identify this device in other command line directives.
-
-A character device may be used in multiplexing mode by multiple front-ends.
-Specify @option{mux=on} to enable this mode.
-A multiplexer is a "1:N" device, and here the "1" end is your specified chardev
-backend, and the "N" end is the various parts of QEMU that can talk to a chardev.
-If you create a chardev with @option{id=myid} and @option{mux=on}, QEMU will
-create a multiplexer with your specified ID, and you can then configure multiple
-front ends to use that chardev ID for their input/output. Up to four different
-front ends can be connected to a single multiplexed chardev. (Without
-multiplexing enabled, a chardev can only be used by a single front end.)
-For instance you could use this to allow a single stdio chardev to be used by
-two serial ports and the QEMU monitor:
-
-@example
--chardev stdio,mux=on,id=char0 \
--mon chardev=char0,mode=readline \
--serial chardev:char0 \
--serial chardev:char0
-@end example
-
-You can have more than one multiplexer in a system configuration; for instance
-you could have a TCP port multiplexed between UART 0 and UART 1, and stdio
-multiplexed between the QEMU monitor and a parallel port:
-
-@example
--chardev stdio,mux=on,id=char0 \
--mon chardev=char0,mode=readline \
--parallel chardev:char0 \
--chardev tcp,...,mux=on,id=char1 \
--serial chardev:char1 \
--serial chardev:char1
-@end example
-
-When you're using a multiplexed character device, some escape sequences are
-interpreted in the input. @xref{mux_keys, Keys in the character backend
-multiplexer}.
-
-Note that some other command line options may implicitly create multiplexed
-character backends; for instance @option{-serial mon:stdio} creates a
-multiplexed stdio backend connected to the serial port and the QEMU monitor,
-and @option{-nographic} also multiplexes the console and the monitor to
-stdio.
-
-There is currently no support for multiplexing in the other direction
-(where a single QEMU front end takes input and output from multiple chardevs).
-
-Every backend supports the @option{logfile} option, which supplies the path
-to a file to record all data transmitted via the backend. The @option{logappend}
-option controls whether the log file will be truncated or appended to when
-opened.
-
-@end table
-
-The available backends are:
-
-@table @option
-@item -chardev null,id=@var{id}
-A void device. This device will not emit any data, and will drop any data it
-receives. The null backend does not take any options.
-
-@item -chardev socket,id=@var{id}[,@var{TCP options} or @var{unix options}][,server][,nowait][,telnet][,websocket][,reconnect=@var{seconds}][,tls-creds=@var{id}][,tls-authz=@var{id}]
-
-Create a two-way stream socket, which can be either a TCP or a unix socket. A
-unix socket will be created if @option{path} is specified. Behaviour is
-undefined if TCP options are specified for a unix socket.
-
-@option{server} specifies that the socket shall be a listening socket.
-
-@option{nowait} specifies that QEMU should not block waiting for a client to
-connect to a listening socket.
-
-@option{telnet} specifies that traffic on the socket should interpret telnet
-escape sequences.
-
-@option{websocket} specifies that the socket uses WebSocket protocol for
-communication.
-
-@option{reconnect} sets the timeout for reconnecting on non-server sockets when
-the remote end goes away. qemu will delay this many seconds and then attempt
-to reconnect. Zero disables reconnecting, and is the default.
-
-@option{tls-creds} requests enablement of the TLS protocol for encryption,
-and specifies the id of the TLS credentials to use for the handshake. The
-credentials must be previously created with the @option{-object tls-creds}
-argument.
-
-@option{tls-auth} provides the ID of the QAuthZ authorization object against
-which the client's x509 distinguished name will be validated. This object is
-only resolved at time of use, so can be deleted and recreated on the fly
-while the chardev server is active. If missing, it will default to denying
-access.
-
-TCP and unix socket options are given below:
-
-@table @option
-
-@item TCP options: port=@var{port}[,host=@var{host}][,to=@var{to}][,ipv4][,ipv6][,nodelay]
-
-@option{host} for a listening socket specifies the local address to be bound.
-For a connecting socket species the remote host to connect to. @option{host} is
-optional for listening sockets. If not specified it defaults to @code{0.0.0.0}.
-
-@option{port} for a listening socket specifies the local port to be bound. For a
-connecting socket specifies the port on the remote host to connect to.
-@option{port} can be given as either a port number or a service name.
-@option{port} is required.
-
-@option{to} is only relevant to listening sockets. If it is specified, and
-@option{port} cannot be bound, QEMU will attempt to bind to subsequent ports up
-to and including @option{to} until it succeeds. @option{to} must be specified
-as a port number.
-
-@option{ipv4} and @option{ipv6} specify that either IPv4 or IPv6 must be used.
-If neither is specified the socket may use either protocol.
-
-@option{nodelay} disables the Nagle algorithm.
-
-@item unix options: path=@var{path}
-
-@option{path} specifies the local path of the unix socket. @option{path} is
-required.
-
-@end table
-
-@item -chardev udp,id=@var{id}[,host=@var{host}],port=@var{port}[,localaddr=@var{localaddr}][,localport=@var{localport}][,ipv4][,ipv6]
-
-Sends all traffic from the guest to a remote host over UDP.
-
-@option{host} specifies the remote host to connect to. If not specified it
-defaults to @code{localhost}.
-
-@option{port} specifies the port on the remote host to connect to. @option{port}
-is required.
-
-@option{localaddr} specifies the local address to bind to. If not specified it
-defaults to @code{0.0.0.0}.
-
-@option{localport} specifies the local port to bind to. If not specified any
-available local port will be used.
-
-@option{ipv4} and @option{ipv6} specify that either IPv4 or IPv6 must be used.
-If neither is specified the device may use either protocol.
-
-@item -chardev msmouse,id=@var{id}
-
-Forward QEMU's emulated msmouse events to the guest. @option{msmouse} does not
-take any options.
-
-@item -chardev vc,id=@var{id}[[,width=@var{width}][,height=@var{height}]][[,cols=@var{cols}][,rows=@var{rows}]]
-
-Connect to a QEMU text console. @option{vc} may optionally be given a specific
-size.
-
-@option{width} and @option{height} specify the width and height respectively of
-the console, in pixels.
-
-@option{cols} and @option{rows} specify that the console be sized to fit a text
-console with the given dimensions.
-
-@item -chardev ringbuf,id=@var{id}[,size=@var{size}]
-
-Create a ring buffer with fixed size @option{size}.
-@var{size} must be a power of two and defaults to @code{64K}.
-
-@item -chardev file,id=@var{id},path=@var{path}
-
-Log all traffic received from the guest to a file.
-
-@option{path} specifies the path of the file to be opened. This file will be
-created if it does not already exist, and overwritten if it does. @option{path}
-is required.
-
-@item -chardev pipe,id=@var{id},path=@var{path}
-
-Create a two-way connection to the guest. The behaviour differs slightly between
-Windows hosts and other hosts:
-
-On Windows, a single duplex pipe will be created at
-@file{\\.pipe\@option{path}}.
-
-On other hosts, 2 pipes will be created called @file{@option{path}.in} and
-@file{@option{path}.out}. Data written to @file{@option{path}.in} will be
-received by the guest. Data written by the guest can be read from
-@file{@option{path}.out}. QEMU will not create these fifos, and requires them to
-be present.
-
-@option{path} forms part of the pipe path as described above. @option{path} is
-required.
-
-@item -chardev console,id=@var{id}
-
-Send traffic from the guest to QEMU's standard output. @option{console} does not
-take any options.
-
-@option{console} is only available on Windows hosts.
-
-@item -chardev serial,id=@var{id},path=@option{path}
-
-Send traffic from the guest to a serial device on the host.
-
-On Unix hosts serial will actually accept any tty device,
-not only serial lines.
-
-@option{path} specifies the name of the serial device to open.
-
-@item -chardev pty,id=@var{id}
-
-Create a new pseudo-terminal on the host and connect to it. @option{pty} does
-not take any options.
-
-@option{pty} is not available on Windows hosts.
-
-@item -chardev stdio,id=@var{id}[,signal=on|off]
-Connect to standard input and standard output of the QEMU process.
-
-@option{signal} controls if signals are enabled on the terminal, that includes
-exiting QEMU with the key sequence @key{Control-c}. This option is enabled by
-default, use @option{signal=off} to disable it.
-
-@item -chardev braille,id=@var{id}
-
-Connect to a local BrlAPI server. @option{braille} does not take any options.
-
-@item -chardev tty,id=@var{id},path=@var{path}
-
-@option{tty} is only available on Linux, Sun, FreeBSD, NetBSD, OpenBSD and
-DragonFlyBSD hosts. It is an alias for @option{serial}.
-
-@option{path} specifies the path to the tty. @option{path} is required.
-
-@item -chardev parallel,id=@var{id},path=@var{path}
-@itemx -chardev parport,id=@var{id},path=@var{path}
-
-@option{parallel} is only available on Linux, FreeBSD and DragonFlyBSD hosts.
-
-Connect to a local parallel port.
-
-@option{path} specifies the path to the parallel port device. @option{path} is
-required.
-
-@item -chardev spicevmc,id=@var{id},debug=@var{debug},name=@var{name}
-
-@option{spicevmc} is only available when spice support is built in.
-
-@option{debug} debug level for spicevmc
-
-@option{name} name of spice channel to connect to
-
-Connect to a spice virtual machine channel, such as vdiport.
-
-@item -chardev spiceport,id=@var{id},debug=@var{debug},name=@var{name}
-
-@option{spiceport} is only available when spice support is built in.
-
-@option{debug} debug level for spicevmc
-
-@option{name} name of spice port to connect to
-
-Connect to a spice port, allowing a Spice client to handle the traffic
-identified by a name (preferably a fqdn).
-ETEXI
SRST
The general form of a character device option is:
@@ -5794,9 +3227,6 @@ The available backends are:
traffic identified by a name (preferably a fqdn).
ERST
-STEXI
-@end table
-ETEXI
DEFHEADING()
#ifdef CONFIG_TPM
@@ -5810,78 +3240,6 @@ DEF("tpmdev", HAS_ARG, QEMU_OPTION_tpmdev, \
"-tpmdev emulator,id=id,chardev=dev\n"
" configure the TPM device using chardev backend\n",
QEMU_ARCH_ALL)
-STEXI
-
-The general form of a TPM device option is:
-@table @option
-
-@item -tpmdev @var{backend},id=@var{id}[,@var{options}]
-@findex -tpmdev
-
-The specific backend type will determine the applicable options.
-The @code{-tpmdev} option creates the TPM backend and requires a
-@code{-device} option that specifies the TPM frontend interface model.
-
-Use @code{-tpmdev help} to print all available TPM backend types.
-
-@end table
-
-The available backends are:
-
-@table @option
-
-@item -tpmdev passthrough,id=@var{id},path=@var{path},cancel-path=@var{cancel-path}
-
-(Linux-host only) Enable access to the host's TPM using the passthrough
-driver.
-
-@option{path} specifies the path to the host's TPM device, i.e., on
-a Linux host this would be @code{/dev/tpm0}.
-@option{path} is optional and by default @code{/dev/tpm0} is used.
-
-@option{cancel-path} specifies the path to the host TPM device's sysfs
-entry allowing for cancellation of an ongoing TPM command.
-@option{cancel-path} is optional and by default QEMU will search for the
-sysfs entry to use.
-
-Some notes about using the host's TPM with the passthrough driver:
-
-The TPM device accessed by the passthrough driver must not be
-used by any other application on the host.
-
-Since the host's firmware (BIOS/UEFI) has already initialized the TPM,
-the VM's firmware (BIOS/UEFI) will not be able to initialize the
-TPM again and may therefore not show a TPM-specific menu that would
-otherwise allow the user to configure the TPM, e.g., allow the user to
-enable/disable or activate/deactivate the TPM.
-Further, if TPM ownership is released from within a VM then the host's TPM
-will get disabled and deactivated. To enable and activate the
-TPM again afterwards, the host has to be rebooted and the user is
-required to enter the firmware's menu to enable and activate the TPM.
-If the TPM is left disabled and/or deactivated most TPM commands will fail.
-
-To create a passthrough TPM use the following two options:
-@example
--tpmdev passthrough,id=tpm0 -device tpm-tis,tpmdev=tpm0
-@end example
-Note that the @code{-tpmdev} id is @code{tpm0} and is referenced by
-@code{tpmdev=tpm0} in the device option.
-
-@item -tpmdev emulator,id=@var{id},chardev=@var{dev}
-
-(Linux-host only) Enable access to a TPM emulator using Unix domain socket based
-chardev backend.
-
-@option{chardev} specifies the unique ID of a character device backend that provides connection to the software TPM server.
-
-To create a TPM emulator backend device with chardev socket backend:
-@example
-
--chardev socket,id=chrtpm,path=/tmp/swtpm-sock -tpmdev emulator,id=tpm0,chardev=chrtpm -device tpm-tis,tpmdev=tpm0
-
-@end example
-
-ETEXI
SRST
The general form of a TPM device option is:
@@ -5946,22 +3304,11 @@ The available backends are:
-chardev socket,id=chrtpm,path=/tmp/swtpm-sock -tpmdev emulator,id=tpm0,chardev=chrtpm -device tpm-tis,tpmdev=tpm0
ERST
-STEXI
-@end table
-ETEXI
DEFHEADING()
#endif
DEFHEADING(Linux/Multiboot boot specific:)
-STEXI
-
-When using these options, you can use a given Linux or Multiboot
-kernel without installing it in the disk image. It can be useful
-for easier testing of various kernels.
-
-@table @option
-ETEXI
SRST
When using these options, you can use a given Linux or Multiboot kernel
without installing it in the disk image. It can be useful for easier
@@ -5972,12 +3319,6 @@ ERST
DEF("kernel", HAS_ARG, QEMU_OPTION_kernel, \
"-kernel bzImage use 'bzImage' as kernel image\n", QEMU_ARCH_ALL)
-STEXI
-@item -kernel @var{bzImage}
-@findex -kernel
-Use @var{bzImage} as kernel image. The kernel can be either a Linux kernel
-or in multiboot format.
-ETEXI
SRST
``-kernel bzImage``
Use bzImage as kernel image. The kernel can be either a Linux kernel
@@ -5986,11 +3327,6 @@ ERST
DEF("append", HAS_ARG, QEMU_OPTION_append, \
"-append cmdline use 'cmdline' as kernel command line\n", QEMU_ARCH_ALL)
-STEXI
-@item -append @var{cmdline}
-@findex -append
-Use @var{cmdline} as kernel command line
-ETEXI
SRST
``-append cmdline``
Use cmdline as kernel command line
@@ -5998,18 +3334,6 @@ ERST
DEF("initrd", HAS_ARG, QEMU_OPTION_initrd, \
"-initrd file use 'file' as initial ram disk\n", QEMU_ARCH_ALL)
-STEXI
-@item -initrd @var{file}
-@findex -initrd
-Use @var{file} as initial ram disk.
-
-@item -initrd "@var{file1} arg=foo,@var{file2}"
-
-This syntax is only available with multiboot.
-
-Use @var{file1} and @var{file2} as modules and pass arg=foo as parameter to the
-first module.
-ETEXI
SRST
``-initrd file``
Use file as initial ram disk.
@@ -6023,27 +3347,15 @@ ERST
DEF("dtb", HAS_ARG, QEMU_OPTION_dtb, \
"-dtb file use 'file' as device tree image\n", QEMU_ARCH_ALL)
-STEXI
-@item -dtb @var{file}
-@findex -dtb
-Use @var{file} as a device tree binary (dtb) image and pass it to the kernel
-on boot.
-ETEXI
SRST
``-dtb file``
Use file as a device tree binary (dtb) image and pass it to the
kernel on boot.
ERST
-STEXI
-@end table
-ETEXI
DEFHEADING()
DEFHEADING(Debug/Expert options:)
-STEXI
-@table @option
-ETEXI
DEF("fw_cfg", HAS_ARG, QEMU_OPTION_fwcfg,
"-fw_cfg [name=]<name>,file=<file>\n"
@@ -6051,29 +3363,6 @@ DEF("fw_cfg", HAS_ARG, QEMU_OPTION_fwcfg,
"-fw_cfg [name=]<name>,string=<str>\n"
" add named fw_cfg entry with contents from string\n",
QEMU_ARCH_ALL)
-STEXI
-
-@item -fw_cfg [name=]@var{name},file=@var{file}
-@findex -fw_cfg
-Add named fw_cfg entry with contents from file @var{file}.
-
-@item -fw_cfg [name=]@var{name},string=@var{str}
-Add named fw_cfg entry with contents from string @var{str}.
-
-The terminating NUL character of the contents of @var{str} will not be
-included as part of the fw_cfg item data. To insert contents with
-embedded NUL characters, you have to use the @var{file} parameter.
-
-The fw_cfg entries are passed by QEMU through to the guest.
-
-Example:
-@example
- -fw_cfg name=opt/com.mycompany/blob,file=./my_blob.bin
-@end example
-creates an fw_cfg entry named opt/com.mycompany/blob with contents
-from ./my_blob.bin.
-
-ETEXI
SRST
``-fw_cfg [name=]name,file=file``
Add named fw\_cfg entry with contents from file file.
@@ -6100,140 +3389,6 @@ ERST
DEF("serial", HAS_ARG, QEMU_OPTION_serial, \
"-serial dev redirect the serial port to char device 'dev'\n",
QEMU_ARCH_ALL)
-STEXI
-@item -serial @var{dev}
-@findex -serial
-Redirect the virtual serial port to host character device
-@var{dev}. The default device is @code{vc} in graphical mode and
-@code{stdio} in non graphical mode.
-
-This option can be used several times to simulate up to 4 serial
-ports.
-
-Use @code{-serial none} to disable all serial ports.
-
-Available character devices are:
-@table @option
-@item vc[:@var{W}x@var{H}]
-Virtual console. Optionally, a width and height can be given in pixel with
-@example
-vc:800x600
-@end example
-It is also possible to specify width or height in characters:
-@example
-vc:80Cx24C
-@end example
-@item pty
-[Linux only] Pseudo TTY (a new PTY is automatically allocated)
-@item none
-No device is allocated.
-@item null
-void device
-@item chardev:@var{id}
-Use a named character device defined with the @code{-chardev} option.
-@item /dev/XXX
-[Linux only] Use host tty, e.g. @file{/dev/ttyS0}. The host serial port
-parameters are set according to the emulated ones.
-@item /dev/parport@var{N}
-[Linux only, parallel port only] Use host parallel port
-@var{N}. Currently SPP and EPP parallel port features can be used.
-@item file:@var{filename}
-Write output to @var{filename}. No character can be read.
-@item stdio
-[Unix only] standard input/output
-@item pipe:@var{filename}
-name pipe @var{filename}
-@item COM@var{n}
-[Windows only] Use host serial port @var{n}
-@item udp:[@var{remote_host}]:@var{remote_port}[@@[@var{src_ip}]:@var{src_port}]
-This implements UDP Net Console.
-When @var{remote_host} or @var{src_ip} are not specified
-they default to @code{0.0.0.0}.
-When not using a specified @var{src_port} a random port is automatically chosen.
-
-If you just want a simple readonly console you can use @code{netcat} or
-@code{nc}, by starting QEMU with: @code{-serial udp::4555} and nc as:
-@code{nc -u -l -p 4555}. Any time QEMU writes something to that port it
-will appear in the netconsole session.
-
-If you plan to send characters back via netconsole or you want to stop
-and start QEMU a lot of times, you should have QEMU use the same
-source port each time by using something like @code{-serial
-udp::4555@@:4556} to QEMU. Another approach is to use a patched
-version of netcat which can listen to a TCP port and send and receive
-characters via udp. If you have a patched version of netcat which
-activates telnet remote echo and single char transfer, then you can
-use the following options to set up a netcat redirector to allow
-telnet on port 5555 to access the QEMU port.
-@table @code
-@item QEMU Options:
--serial udp::4555@@:4556
-@item netcat options:
--u -P 4555 -L 0.0.0.0:4556 -t -p 5555 -I -T
-@item telnet options:
-localhost 5555
-@end table
-
-@item tcp:[@var{host}]:@var{port}[,@var{server}][,nowait][,nodelay][,reconnect=@var{seconds}]
-The TCP Net Console has two modes of operation. It can send the serial
-I/O to a location or wait for a connection from a location. By default
-the TCP Net Console is sent to @var{host} at the @var{port}. If you use
-the @var{server} option QEMU will wait for a client socket application
-to connect to the port before continuing, unless the @code{nowait}
-option was specified. The @code{nodelay} option disables the Nagle buffering
-algorithm. The @code{reconnect} option only applies if @var{noserver} is
-set, if the connection goes down it will attempt to reconnect at the
-given interval. If @var{host} is omitted, 0.0.0.0 is assumed. Only
-one TCP connection at a time is accepted. You can use @code{telnet} to
-connect to the corresponding character device.
-@table @code
-@item Example to send tcp console to 192.168.0.2 port 4444
--serial tcp:192.168.0.2:4444
-@item Example to listen and wait on port 4444 for connection
--serial tcp::4444,server
-@item Example to not wait and listen on ip 192.168.0.100 port 4444
--serial tcp:192.168.0.100:4444,server,nowait
-@end table
-
-@item telnet:@var{host}:@var{port}[,server][,nowait][,nodelay]
-The telnet protocol is used instead of raw tcp sockets. The options
-work the same as if you had specified @code{-serial tcp}. The
-difference is that the port acts like a telnet server or client using
-telnet option negotiation. This will also allow you to send the
-MAGIC_SYSRQ sequence if you use a telnet that supports sending the break
-sequence. Typically in unix telnet you do it with Control-] and then
-type "send break" followed by pressing the enter key.
-
-@item websocket:@var{host}:@var{port},server[,nowait][,nodelay]
-The WebSocket protocol is used instead of raw tcp socket. The port acts as
-a WebSocket server. Client mode is not supported.
-
-@item unix:@var{path}[,server][,nowait][,reconnect=@var{seconds}]
-A unix domain socket is used instead of a tcp socket. The option works the
-same as if you had specified @code{-serial tcp} except the unix domain socket
-@var{path} is used for connections.
-
-@item mon:@var{dev_string}
-This is a special option to allow the monitor to be multiplexed onto
-another serial port. The monitor is accessed with key sequence of
-@key{Control-a} and then pressing @key{c}.
-@var{dev_string} should be any one of the serial devices specified
-above. An example to multiplex the monitor onto a telnet server
-listening on port 4444 would be:
-@table @code
-@item -serial mon:telnet::4444,server,nowait
-@end table
-When the monitor is multiplexed to stdio in this way, Ctrl+C will not terminate
-QEMU any more but will be passed to the guest instead.
-
-@item braille
-Braille device. This will use BrlAPI to display the braille output on a real
-or fake device.
-
-@item msmouse
-Three button serial mouse. Configure the guest to use Microsoft protocol.
-@end table
-ETEXI
SRST
``-serial dev``
Redirect the virtual serial port to host character device dev. The
@@ -6393,19 +3548,6 @@ ERST
DEF("parallel", HAS_ARG, QEMU_OPTION_parallel, \
"-parallel dev redirect the parallel port to char device 'dev'\n",
QEMU_ARCH_ALL)
-STEXI
-@item -parallel @var{dev}
-@findex -parallel
-Redirect the virtual parallel port to host device @var{dev} (same
-devices as the serial port). On Linux hosts, @file{/dev/parportN} can
-be used to use hardware devices connected on the corresponding host
-parallel port.
-
-This option can be used several times to simulate up to 3 parallel
-ports.
-
-Use @code{-parallel none} to disable all parallel ports.
-ETEXI
SRST
``-parallel dev``
Redirect the virtual parallel port to host device dev (same devices
@@ -6422,15 +3564,6 @@ ERST
DEF("monitor", HAS_ARG, QEMU_OPTION_monitor, \
"-monitor dev redirect the monitor to char device 'dev'\n",
QEMU_ARCH_ALL)
-STEXI
-@item -monitor @var{dev}
-@findex -monitor
-Redirect the monitor to host device @var{dev} (same devices as the
-serial port).
-The default device is @code{vc} in graphical mode and @code{stdio} in
-non graphical mode.
-Use @code{-monitor none} to disable the default monitor.
-ETEXI
SRST
``-monitor dev``
Redirect the monitor to host device dev (same devices as the serial
@@ -6441,11 +3574,6 @@ ERST
DEF("qmp", HAS_ARG, QEMU_OPTION_qmp, \
"-qmp dev like -monitor but opens in 'control' mode\n",
QEMU_ARCH_ALL)
-STEXI
-@item -qmp @var{dev}
-@findex -qmp
-Like -monitor but opens in 'control' mode.
-ETEXI
SRST
``-qmp dev``
Like -monitor but opens in 'control' mode.
@@ -6453,11 +3581,6 @@ ERST
DEF("qmp-pretty", HAS_ARG, QEMU_OPTION_qmp_pretty, \
"-qmp-pretty dev like -qmp but uses pretty JSON formatting\n",
QEMU_ARCH_ALL)
-STEXI
-@item -qmp-pretty @var{dev}
-@findex -qmp-pretty
-Like -qmp but uses pretty JSON formatting.
-ETEXI
SRST
``-qmp-pretty dev``
Like -qmp but uses pretty JSON formatting.
@@ -6465,12 +3588,6 @@ ERST
DEF("mon", HAS_ARG, QEMU_OPTION_mon, \
"-mon [chardev=]name[,mode=readline|control][,pretty[=on|off]]\n", QEMU_ARCH_ALL)
-STEXI
-@item -mon [chardev=]name[,mode=readline|control][,pretty[=on|off]]
-@findex -mon
-Setup monitor on chardev @var{name}. @code{pretty} turns on JSON pretty printing
-easing human reading and debugging.
-ETEXI
SRST
``-mon [chardev=]name[,mode=readline|control][,pretty[=on|off]]``
Setup monitor on chardev name. ``pretty`` turns on JSON pretty
@@ -6480,15 +3597,6 @@ ERST
DEF("debugcon", HAS_ARG, QEMU_OPTION_debugcon, \
"-debugcon dev redirect the debug console to char device 'dev'\n",
QEMU_ARCH_ALL)
-STEXI
-@item -debugcon @var{dev}
-@findex -debugcon
-Redirect the debug console to host device @var{dev} (same devices as the
-serial port). The debug console is an I/O port which is typically port
-0xe9; writing to that I/O port sends output to this device.
-The default device is @code{vc} in graphical mode and @code{stdio} in
-non graphical mode.
-ETEXI
SRST
``-debugcon dev``
Redirect the debug console to host device dev (same devices as the
@@ -6500,12 +3608,6 @@ ERST
DEF("pidfile", HAS_ARG, QEMU_OPTION_pidfile, \
"-pidfile file write PID to 'file'\n", QEMU_ARCH_ALL)
-STEXI
-@item -pidfile @var{file}
-@findex -pidfile
-Store the QEMU process PID in @var{file}. It is useful if you launch QEMU
-from a script.
-ETEXI
SRST
``-pidfile file``
Store the QEMU process PID in file. It is useful if you launch QEMU
@@ -6514,11 +3616,6 @@ ERST
DEF("singlestep", 0, QEMU_OPTION_singlestep, \
"-singlestep always run in singlestep mode\n", QEMU_ARCH_ALL)
-STEXI
-@item -singlestep
-@findex -singlestep
-Run the emulation in single step mode.
-ETEXI
SRST
``-singlestep``
Run the emulation in single step mode.
@@ -6527,16 +3624,6 @@ ERST
DEF("preconfig", 0, QEMU_OPTION_preconfig, \
"--preconfig pause QEMU before machine is initialized (experimental)\n",
QEMU_ARCH_ALL)
-STEXI
-@item --preconfig
-@findex --preconfig
-Pause QEMU for interactive configuration before the machine is created,
-which allows querying and configuring properties that will affect
-machine initialization. Use QMP command 'x-exit-preconfig' to exit
-the preconfig state and move to the next state (i.e. run guest if -S
-isn't used or pause the second time if -S is used). This option is
-experimental.
-ETEXI
SRST
``--preconfig``
Pause QEMU for interactive configuration before the machine is
@@ -6550,11 +3637,6 @@ ERST
DEF("S", 0, QEMU_OPTION_S, \
"-S freeze CPU at startup (use 'c' to start execution)\n",
QEMU_ARCH_ALL)
-STEXI
-@item -S
-@findex -S
-Do not start CPU at startup (you must type 'c' in the monitor).
-ETEXI
SRST
``-S``
Do not start CPU at startup (you must type 'c' in the monitor).
@@ -6565,13 +3647,6 @@ DEF("realtime", HAS_ARG, QEMU_OPTION_realtime,
" run qemu with realtime features\n"
" mlock=on|off controls mlock support (default: on)\n",
QEMU_ARCH_ALL)
-STEXI
-@item -realtime mlock=on|off
-@findex -realtime
-Run qemu with realtime features.
-mlocking qemu and guest memory can be enabled via @option{mlock=on}
-(enabled by default).
-ETEXI
SRST
``-realtime mlock=on|off``
Run qemu with realtime features. mlocking qemu and guest memory can
@@ -6584,23 +3659,6 @@ DEF("overcommit", HAS_ARG, QEMU_OPTION_overcommit,
" mem-lock=on|off controls memory lock support (default: off)\n"
" cpu-pm=on|off controls cpu power management (default: off)\n",
QEMU_ARCH_ALL)
-STEXI
-@item -overcommit mem-lock=on|off
-@item -overcommit cpu-pm=on|off
-@findex -overcommit
-Run qemu with hints about host resource overcommit. The default is
-to assume that host overcommits all resources.
-
-Locking qemu and guest memory can be enabled via @option{mem-lock=on} (disabled
-by default). This works when host memory is not overcommitted and reduces the
-worst-case latency for guest. This is equivalent to @option{realtime}.
-
-Guest ability to manage power state of host cpus (increasing latency for other
-processes on the same host cpu, but decreasing latency for guest) can be
-enabled via @option{cpu-pm=on} (disabled by default). This works best when
-host CPU is not overcommitted. When used, host estimates of CPU cycle and power
-utilization will be incorrect, not taking into account guest idle time.
-ETEXI
SRST
``-overcommit mem-lock=on|off``
\
@@ -6623,17 +3681,6 @@ ERST
DEF("gdb", HAS_ARG, QEMU_OPTION_gdb, \
"-gdb dev wait for gdb connection on 'dev'\n", QEMU_ARCH_ALL)
-STEXI
-@item -gdb @var{dev}
-@findex -gdb
-Wait for gdb connection on device @var{dev} (@pxref{gdb_usage}). Typical
-connections will likely be TCP-based, but also UDP, pseudo TTY, or even
-stdio are reasonable use case. The latter is allowing to start QEMU from
-within gdb and establish the connection via a pipe:
-@example
-(gdb) target remote | exec @value{qemu_system} -gdb stdio ...
-@end example
-ETEXI
SRST
``-gdb dev``
Wait for gdb connection on device dev (see
@@ -6650,12 +3697,6 @@ ERST
DEF("s", 0, QEMU_OPTION_s, \
"-s shorthand for -gdb tcp::" DEFAULT_GDBSTUB_PORT "\n",
QEMU_ARCH_ALL)
-STEXI
-@item -s
-@findex -s
-Shorthand for -gdb tcp::1234, i.e. open a gdbserver on TCP port 1234
-(@pxref{gdb_usage}).
-ETEXI
SRST
``-s``
Shorthand for -gdb tcp::1234, i.e. open a gdbserver on TCP port 1234
@@ -6665,11 +3706,6 @@ ERST
DEF("d", HAS_ARG, QEMU_OPTION_d, \
"-d item1,... enable logging of specified items (use '-d help' for a list of log items)\n",
QEMU_ARCH_ALL)
-STEXI
-@item -d @var{item1}[,...]
-@findex -d
-Enable logging of specified items. Use '-d help' for a list of log items.
-ETEXI
SRST
``-d item1[,...]``
Enable logging of specified items. Use '-d help' for a list of log
@@ -6679,11 +3715,6 @@ ERST
DEF("D", HAS_ARG, QEMU_OPTION_D, \
"-D logfile output log to logfile (default stderr)\n",
QEMU_ARCH_ALL)
-STEXI
-@item -D @var{logfile}
-@findex -D
-Output log in @var{logfile} instead of to stderr
-ETEXI
SRST
``-D logfile``
Output log in logfile instead of to stderr
@@ -6692,20 +3723,6 @@ ERST
DEF("dfilter", HAS_ARG, QEMU_OPTION_DFILTER, \
"-dfilter range,.. filter debug output to range of addresses (useful for -d cpu,exec,etc..)\n",
QEMU_ARCH_ALL)
-STEXI
-@item -dfilter @var{range1}[,...]
-@findex -dfilter
-Filter debug output to that relevant to a range of target addresses. The filter
-spec can be either @var{start}+@var{size}, @var{start}-@var{size} or
-@var{start}..@var{end} where @var{start} @var{end} and @var{size} are the
-addresses and sizes required. For example:
-@example
- -dfilter 0x8000..0x8fff,0xffffffc000080000+0x200,0xffffffc000060000-0x1000
-@end example
-Will dump output for any code in the 0x1000 sized block starting at 0x8000 and
-the 0x200 sized block starting at 0xffffffc000080000 and another 0x1000 sized
-block starting at 0xffffffc00005f000.
-ETEXI
SRST
``-dfilter range1[,...]``
Filter debug output to that relevant to a range of target addresses.
@@ -6725,12 +3742,6 @@ ERST
DEF("seed", HAS_ARG, QEMU_OPTION_seed, \
"-seed number seed the pseudo-random number generator\n",
QEMU_ARCH_ALL)
-STEXI
-@item -seed @var{number}
-@findex -seed
-Force the guest to use a deterministic pseudo-random number generator, seeded
-with @var{number}. This does not affect crypto routines within the host.
-ETEXI
SRST
``-seed number``
Force the guest to use a deterministic pseudo-random number
@@ -6741,13 +3752,6 @@ ERST
DEF("L", HAS_ARG, QEMU_OPTION_L, \
"-L path set the directory for the BIOS, VGA BIOS and keymaps\n",
QEMU_ARCH_ALL)
-STEXI
-@item -L @var{path}
-@findex -L
-Set the directory for the BIOS, VGA BIOS and keymaps.
-
-To list all the data directories, use @code{-L help}.
-ETEXI
SRST
``-L path``
Set the directory for the BIOS, VGA BIOS and keymaps.
@@ -6757,11 +3761,6 @@ ERST
DEF("bios", HAS_ARG, QEMU_OPTION_bios, \
"-bios file set the filename for the BIOS\n", QEMU_ARCH_ALL)
-STEXI
-@item -bios @var{file}
-@findex -bios
-Set the filename for the BIOS.
-ETEXI
SRST
``-bios file``
Set the filename for the BIOS.
@@ -6769,12 +3768,6 @@ ERST
DEF("enable-kvm", 0, QEMU_OPTION_enable_kvm, \
"-enable-kvm enable KVM full virtualization support\n", QEMU_ARCH_ALL)
-STEXI
-@item -enable-kvm
-@findex -enable-kvm
-Enable KVM full virtualization support. This option is only available
-if KVM support is enabled when compiling.
-ETEXI
SRST
``-enable-kvm``
Enable KVM full virtualization support. This option is only
@@ -6792,17 +3785,6 @@ DEF("xen-domid-restrict", 0, QEMU_OPTION_xen_domid_restrict,
" to specified domain id. (Does not affect\n"
" xenpv machine type).\n",
QEMU_ARCH_ALL)
-STEXI
-@item -xen-domid @var{id}
-@findex -xen-domid
-Specify xen guest domain @var{id} (XEN only).
-@item -xen-attach
-@findex -xen-attach
-Attach to existing xen domain.
-libxl will use this when starting QEMU (XEN only).
-@findex -xen-domid-restrict
-Restrict set of available xen operations to specified domain id (XEN only).
-ETEXI
SRST
``-xen-domid id``
Specify xen guest domain id (XEN only).
@@ -6815,11 +3797,6 @@ ERST
DEF("no-reboot", 0, QEMU_OPTION_no_reboot, \
"-no-reboot exit instead of rebooting\n", QEMU_ARCH_ALL)
-STEXI
-@item -no-reboot
-@findex -no-reboot
-Exit instead of rebooting.
-ETEXI
SRST
``-no-reboot``
Exit instead of rebooting.
@@ -6827,13 +3804,6 @@ ERST
DEF("no-shutdown", 0, QEMU_OPTION_no_shutdown, \
"-no-shutdown stop before shutdown\n", QEMU_ARCH_ALL)
-STEXI
-@item -no-shutdown
-@findex -no-shutdown
-Don't exit QEMU on guest shutdown, but instead only stop the emulation.
-This allows for instance switching to monitor to commit changes to the
-disk image.
-ETEXI
SRST
``-no-shutdown``
Don't exit QEMU on guest shutdown, but instead only stop the
@@ -6845,11 +3815,6 @@ DEF("loadvm", HAS_ARG, QEMU_OPTION_loadvm, \
"-loadvm [tag|id]\n" \
" start right away with a saved state (loadvm in monitor)\n",
QEMU_ARCH_ALL)
-STEXI
-@item -loadvm @var{file}
-@findex -loadvm
-Start right away with a saved state (@code{loadvm} in monitor)
-ETEXI
SRST
``-loadvm file``
Start right away with a saved state (``loadvm`` in monitor)
@@ -6859,14 +3824,6 @@ ERST
DEF("daemonize", 0, QEMU_OPTION_daemonize, \
"-daemonize daemonize QEMU after initializing\n", QEMU_ARCH_ALL)
#endif
-STEXI
-@item -daemonize
-@findex -daemonize
-Daemonize the QEMU process after initialization. QEMU will not detach from
-standard IO until it is ready to receive connections on any of its devices.
-This option is a useful way for external programs to launch QEMU without having
-to cope with initialization race conditions.
-ETEXI
SRST
``-daemonize``
Daemonize the QEMU process after initialization. QEMU will not
@@ -6879,12 +3836,6 @@ ERST
DEF("option-rom", HAS_ARG, QEMU_OPTION_option_rom, \
"-option-rom rom load a file, rom, into the option ROM space\n",
QEMU_ARCH_ALL)
-STEXI
-@item -option-rom @var{file}
-@findex -option-rom
-Load the contents of @var{file} as an option ROM.
-This option is useful to load things like EtherBoot.
-ETEXI
SRST
``-option-rom file``
Load the contents of file as an option ROM. This option is useful to
@@ -6896,31 +3847,6 @@ DEF("rtc", HAS_ARG, QEMU_OPTION_rtc, \
" set the RTC base and clock, enable drift fix for clock ticks (x86 only)\n",
QEMU_ARCH_ALL)
-STEXI
-
-@item -rtc [base=utc|localtime|@var{datetime}][,clock=host|rt|vm][,driftfix=none|slew]
-@findex -rtc
-Specify @option{base} as @code{utc} or @code{localtime} to let the RTC start at the current
-UTC or local time, respectively. @code{localtime} is required for correct date in
-MS-DOS or Windows. To start at a specific point in time, provide @var{datetime} in the
-format @code{2006-06-17T16:01:21} or @code{2006-06-17}. The default base is UTC.
-
-By default the RTC is driven by the host system time. This allows using of the
-RTC as accurate reference clock inside the guest, specifically if the host
-time is smoothly following an accurate external reference clock, e.g. via NTP.
-If you want to isolate the guest time from the host, you can set @option{clock}
-to @code{rt} instead, which provides a host monotonic clock if host support it.
-To even prevent the RTC from progressing during suspension, you can set @option{clock}
-to @code{vm} (virtual clock). @samp{clock=vm} is recommended especially in
-icount mode in order to preserve determinism; however, note that in icount mode
-the speed of the virtual clock is variable and can in general differ from the
-host clock.
-
-Enable @option{driftfix} (i386 targets only) if you experience time drift problems,
-specifically with Windows' ACPI HAL. This option will try to figure out how
-many timer interrupts were not processed by the Windows guest and will
-re-inject them.
-ETEXI
SRST
``-rtc [base=utc|localtime|datetime][,clock=host|rt|vm][,driftfix=none|slew]``
Specify ``base`` as ``utc`` or ``localtime`` to let the RTC start at
@@ -6953,45 +3879,6 @@ DEF("icount", HAS_ARG, QEMU_OPTION_icount, \
" enable virtual instruction counter with 2^N clock ticks per\n" \
" instruction, enable aligning the host and virtual clocks\n" \
" or disable real time cpu sleeping\n", QEMU_ARCH_ALL)
-STEXI
-@item -icount [shift=@var{N}|auto][,rr=record|replay,rrfile=@var{filename},rrsnapshot=@var{snapshot}]
-@findex -icount
-Enable virtual instruction counter. The virtual cpu will execute one
-instruction every 2^@var{N} ns of virtual time. If @code{auto} is specified
-then the virtual cpu speed will be automatically adjusted to keep virtual
-time within a few seconds of real time.
-
-When the virtual cpu is sleeping, the virtual time will advance at default
-speed unless @option{sleep=on|off} is specified.
-With @option{sleep=on|off}, the virtual time will jump to the next timer deadline
-instantly whenever the virtual cpu goes to sleep mode and will not advance
-if no timer is enabled. This behavior give deterministic execution times from
-the guest point of view.
-
-Note that while this option can give deterministic behavior, it does not
-provide cycle accurate emulation. Modern CPUs contain superscalar out of
-order cores with complex cache hierarchies. The number of instructions
-executed often has little or no correlation with actual performance.
-
-@option{align=on} will activate the delay algorithm which will try
-to synchronise the host clock and the virtual clock. The goal is to
-have a guest running at the real frequency imposed by the shift option.
-Whenever the guest clock is behind the host clock and if
-@option{align=on} is specified then we print a message to the user
-to inform about the delay.
-Currently this option does not work when @option{shift} is @code{auto}.
-Note: The sync algorithm will work for those shift values for which
-the guest clock runs ahead of the host clock. Typically this happens
-when the shift value is high (how high depends on the host machine).
-
-When @option{rr} option is specified deterministic record/replay is enabled.
-Replay log is written into @var{filename} file in record mode and
-read from this file in replay mode.
-
-Option rrsnapshot is used to create new vm snapshot named @var{snapshot}
-at the start of execution recording. In replay mode this option is used
-to load the initial VM state.
-ETEXI
SRST
``-icount [shift=N|auto][,rr=record|replay,rrfile=filename,rrsnapshot=snapshot]``
Enable virtual instruction counter. The virtual cpu will execute one
@@ -7036,30 +3923,6 @@ DEF("watchdog", HAS_ARG, QEMU_OPTION_watchdog, \
"-watchdog model\n" \
" enable virtual hardware watchdog [default=none]\n",
QEMU_ARCH_ALL)
-STEXI
-@item -watchdog @var{model}
-@findex -watchdog
-Create a virtual hardware watchdog device. Once enabled (by a guest
-action), the watchdog must be periodically polled by an agent inside
-the guest or else the guest will be restarted. Choose a model for
-which your guest has drivers.
-
-The @var{model} is the model of hardware watchdog to emulate. Use
-@code{-watchdog help} to list available hardware models. Only one
-watchdog can be enabled for a guest.
-
-The following models may be available:
-@table @option
-@item ib700
-iBASE 700 is a very simple ISA watchdog with a single timer.
-@item i6300esb
-Intel 6300ESB I/O controller hub is a much more featureful PCI-based
-dual-timer watchdog.
-@item diag288
-A virtual watchdog for s390x backed by the diagnose 288 hypercall
-(currently KVM only).
-@end table
-ETEXI
SRST
``-watchdog model``
Create a virtual hardware watchdog device. Once enabled (by a guest
@@ -7089,34 +3952,6 @@ DEF("watchdog-action", HAS_ARG, QEMU_OPTION_watchdog_action, \
"-watchdog-action reset|shutdown|poweroff|inject-nmi|pause|debug|none\n" \
" action when watchdog fires [default=reset]\n",
QEMU_ARCH_ALL)
-STEXI
-@item -watchdog-action @var{action}
-@findex -watchdog-action
-
-The @var{action} controls what QEMU will do when the watchdog timer
-expires.
-The default is
-@code{reset} (forcefully reset the guest).
-Other possible actions are:
-@code{shutdown} (attempt to gracefully shutdown the guest),
-@code{poweroff} (forcefully poweroff the guest),
-@code{inject-nmi} (inject a NMI into the guest),
-@code{pause} (pause the guest),
-@code{debug} (print a debug message and continue), or
-@code{none} (do nothing).
-
-Note that the @code{shutdown} action requires that the guest responds
-to ACPI signals, which it may not be able to do in the sort of
-situations where the watchdog would have expired, and thus
-@code{-watchdog-action shutdown} is not recommended for production use.
-
-Examples:
-
-@table @code
-@item -watchdog i6300esb -watchdog-action pause
-@itemx -watchdog ib700
-@end table
-ETEXI
SRST
``-watchdog-action action``
The action controls what QEMU will do when the watchdog timer
@@ -7141,22 +3976,6 @@ ERST
DEF("echr", HAS_ARG, QEMU_OPTION_echr, \
"-echr chr set terminal escape character instead of ctrl-a\n",
QEMU_ARCH_ALL)
-STEXI
-
-@item -echr @var{numeric_ascii_value}
-@findex -echr
-Change the escape character used for switching to the monitor when using
-monitor and serial sharing. The default is @code{0x01} when using the
-@code{-nographic} option. @code{0x01} is equal to pressing
-@code{Control-a}. You can select a different character from the ascii
-control keys where 1 through 26 map to Control-a through Control-z. For
-instance you could use the either of the following to change the escape
-character to Control-t.
-@table @code
-@item -echr 0x14
-@itemx -echr 20
-@end table
-ETEXI
SRST
``-echr numeric_ascii_value``
Change the escape character used for switching to the monitor when
@@ -7173,11 +3992,6 @@ ERST
DEF("show-cursor", 0, QEMU_OPTION_show_cursor, \
"-show-cursor show cursor\n", QEMU_ARCH_ALL)
-STEXI
-@item -show-cursor
-@findex -show-cursor
-Show cursor.
-ETEXI
SRST
``-show-cursor``
Show cursor.
@@ -7185,12 +3999,6 @@ ERST
DEF("tb-size", HAS_ARG, QEMU_OPTION_tb_size, \
"-tb-size n set TB size\n", QEMU_ARCH_ALL)
-STEXI
-@item -tb-size @var{n}
-@findex -tb-size
-Set TCG translation block cache size. Deprecated, use @samp{-accel tcg,tb-size=@var{n}}
-instead.
-ETEXI
SRST
``-tb-size n``
Set TCG translation block cache size. Deprecated, use
@@ -7210,26 +4018,6 @@ DEF("incoming", HAS_ARG, QEMU_OPTION_incoming, \
"-incoming defer\n" \
" wait for the URI to be specified via migrate_incoming\n",
QEMU_ARCH_ALL)
-STEXI
-@item -incoming tcp:[@var{host}]:@var{port}[,to=@var{maxport}][,ipv4][,ipv6]
-@itemx -incoming rdma:@var{host}:@var{port}[,ipv4][,ipv6]
-@findex -incoming
-Prepare for incoming migration, listen on a given tcp port.
-
-@item -incoming unix:@var{socketpath}
-Prepare for incoming migration, listen on a given unix socket.
-
-@item -incoming fd:@var{fd}
-Accept incoming migration from a given filedescriptor.
-
-@item -incoming exec:@var{cmdline}
-Accept incoming migration as an output from specified external command.
-
-@item -incoming defer
-Wait for the URI to be specified via migrate_incoming. The monitor can
-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]``
\
@@ -7254,12 +4042,6 @@ ERST
DEF("only-migratable", 0, QEMU_OPTION_only_migratable, \
"-only-migratable allow only migratable devices\n", QEMU_ARCH_ALL)
-STEXI
-@item -only-migratable
-@findex -only-migratable
-Only allow migratable devices. Devices will not be allowed to enter an
-unmigratable state.
-ETEXI
SRST
``-only-migratable``
Only allow migratable devices. Devices will not be allowed to enter
@@ -7268,14 +4050,6 @@ ERST
DEF("nodefaults", 0, QEMU_OPTION_nodefaults, \
"-nodefaults don't create default devices\n", QEMU_ARCH_ALL)
-STEXI
-@item -nodefaults
-@findex -nodefaults
-Don't create default devices. Normally, QEMU sets the default devices like serial
-port, parallel port, virtual console, monitor device, VGA adapter, floppy and
-CD-ROM drive and others. The @code{-nodefaults} option will disable all those
-default devices.
-ETEXI
SRST
``-nodefaults``
Don't create default devices. Normally, QEMU sets the default
@@ -7289,12 +4063,6 @@ DEF("chroot", HAS_ARG, QEMU_OPTION_chroot, \
"-chroot dir chroot to dir just before starting the VM\n",
QEMU_ARCH_ALL)
#endif
-STEXI
-@item -chroot @var{dir}
-@findex -chroot
-Immediately before starting guest execution, chroot to the specified
-directory. Especially useful in combination with -runas.
-ETEXI
SRST
``-chroot dir``
Immediately before starting guest execution, chroot to the specified
@@ -7307,12 +4075,6 @@ DEF("runas", HAS_ARG, QEMU_OPTION_runas, \
" user can be numeric uid:gid instead\n",
QEMU_ARCH_ALL)
#endif
-STEXI
-@item -runas @var{user}
-@findex -runas
-Immediately before starting guest execution, drop root privileges, switching
-to the specified user.
-ETEXI
SRST
``-runas user``
Immediately before starting guest execution, drop root privileges,
@@ -7323,23 +4085,6 @@ DEF("prom-env", HAS_ARG, QEMU_OPTION_prom_env,
"-prom-env variable=value\n"
" set OpenBIOS nvram variables\n",
QEMU_ARCH_PPC | QEMU_ARCH_SPARC)
-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
SRST
``-prom-env variable=value``
Set OpenBIOS nvram variable to given value (PPC, SPARC only).
@@ -7359,17 +4104,6 @@ DEF("semihosting", 0, QEMU_OPTION_semihosting,
"-semihosting semihosting mode\n",
QEMU_ARCH_ARM | QEMU_ARCH_M68K | QEMU_ARCH_XTENSA | QEMU_ARCH_LM32 |
QEMU_ARCH_MIPS | QEMU_ARCH_NIOS2)
-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
SRST
``-semihosting``
Enable semihosting mode (ARM, M68K, Xtensa, MIPS, Nios II only).
@@ -7385,37 +4119,6 @@ DEF("semihosting-config", HAS_ARG, QEMU_OPTION_semihosting_config,
" semihosting configuration\n",
QEMU_ARCH_ARM | QEMU_ARCH_M68K | QEMU_ARCH_XTENSA | QEMU_ARCH_LM32 |
QEMU_ARCH_MIPS | QEMU_ARCH_NIOS2)
-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})
-or to GDB (@code{gdb}). The default is @code{auto}, which means @code{gdb}
-during debug sessions and @code{native} otherwise.
-@item chardev=@var{str1}
-Send the output to a chardev backend output for native or auto output when not in gdb
-@item arg=@var{str1},arg=@var{str2},...
-Allows the user to pass input arguments, and can be used multiple times to build
-up a list. The old-style @code{-kernel}/@code{-append} method of passing a
-command line is still supported for backward compatibility. If both the
-@code{--semihosting-config arg} and the @code{-kernel}/@code{-append} are
-specified, the former is passed to semihosting as it always takes precedence.
-@end table
-ETEXI
SRST
``-semihosting-config [enable=on|off][,target=native|gdb|auto][,chardev=id][,arg=str[,...]]``
Enable and configure semihosting (ARM, M68K, Xtensa, MIPS, Nios II
@@ -7453,11 +4156,6 @@ SRST
ERST
DEF("old-param", 0, QEMU_OPTION_old_param,
"-old-param old param mode\n", QEMU_ARCH_ARM)
-STEXI
-@item -old-param
-@findex -old-param (ARM)
-Old param mode (ARM only).
-ETEXI
SRST
``-old-param``
Old param mode (ARM only).
@@ -7478,22 +4176,6 @@ DEF("sandbox", HAS_ARG, QEMU_OPTION_sandbox, \
" blacklisting *fork and execve\n" \
" use 'resourcecontrol' to disable process affinity and schedular priority\n",
QEMU_ARCH_ALL)
-STEXI
-@item -sandbox @var{arg}[,obsolete=@var{string}][,elevateprivileges=@var{string}][,spawn=@var{string}][,resourcecontrol=@var{string}]
-@findex -sandbox
-Enable Seccomp mode 2 system call filter. 'on' will enable syscall filtering and 'off' will
-disable it. The default is 'off'.
-@table @option
-@item obsolete=@var{string}
-Enable Obsolete system calls
-@item elevateprivileges=@var{string}
-Disable set*uid|gid system calls
-@item spawn=@var{string}
-Disable *fork and execve
-@item resourcecontrol=@var{string}
-Disable process affinity and schedular priority
-@end table
-ETEXI
SRST
``-sandbox arg[,obsolete=string][,elevateprivileges=string][,spawn=string][,resourcecontrol=string]``
Enable Seccomp mode 2 system call filter. 'on' will enable syscall
@@ -7514,13 +4196,6 @@ ERST
DEF("readconfig", HAS_ARG, QEMU_OPTION_readconfig,
"-readconfig <file>\n", QEMU_ARCH_ALL)
-STEXI
-@item -readconfig @var{file}
-@findex -readconfig
-Read device configuration from @var{file}. This approach is useful when you want to spawn
-QEMU process with many command line options but you don't want to exceed the command line
-character limit.
-ETEXI
SRST
``-readconfig file``
Read device configuration from file. This approach is useful when
@@ -7530,13 +4205,6 @@ ERST
DEF("writeconfig", HAS_ARG, QEMU_OPTION_writeconfig,
"-writeconfig <file>\n"
" read/write config file\n", QEMU_ARCH_ALL)
-STEXI
-@item -writeconfig @var{file}
-@findex -writeconfig
-Write device configuration to @var{file}. The @var{file} can be either filename to save
-command line and device configuration into file or dash @code{-}) character to print the
-output to stdout. This can be later used as input file for @code{-readconfig} option.
-ETEXI
SRST
``-writeconfig file``
Write device configuration to file. The file can be either filename
@@ -7549,12 +4217,6 @@ DEF("no-user-config", 0, QEMU_OPTION_nouserconfig,
"-no-user-config\n"
" do not load default user-provided config files at startup\n",
QEMU_ARCH_ALL)
-STEXI
-@item -no-user-config
-@findex -no-user-config
-The @code{-no-user-config} option makes QEMU not load any of the user-provided
-config files on @var{sysconfdir}.
-ETEXI
SRST
``-no-user-config``
The ``-no-user-config`` option makes QEMU not load any of the
@@ -7565,13 +4227,6 @@ DEF("trace", HAS_ARG, QEMU_OPTION_trace,
"-trace [[enable=]<pattern>][,events=<file>][,file=<file>]\n"
" specify tracing options\n",
QEMU_ARCH_ALL)
-STEXI
-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 docs/system/qemu-option-trace.texi
-ETEXI
SRST
``-trace [[enable=]pattern][,events=file][,file=file]``
.. include:: ../qemu-option-trace.rst.inc
@@ -7581,19 +4236,6 @@ DEF("plugin", HAS_ARG, QEMU_OPTION_plugin,
"-plugin [file=]<file>[,arg=<string>]\n"
" load a plugin\n",
QEMU_ARCH_ALL)
-STEXI
-@item -plugin file=@var{file}[,arg=@var{string}]
-@findex -plugin
-
-Load a plugin.
-
-@table @option
-@item file=@var{file}
-Load the given plugin from a shared library file.
-@item arg=@var{string}
-Argument string passed to the plugin. (Can be given multiple times.)
-@end table
-ETEXI
SRST
``-plugin file=file[,arg=string]``
Load a plugin.
@@ -7615,11 +4257,6 @@ DEF("enable-fips", 0, QEMU_OPTION_enablefips,
"-enable-fips enable FIPS 140-2 compliance\n",
QEMU_ARCH_ALL)
#endif
-STEXI
-@item -enable-fips
-@findex -enable-fips
-Enable FIPS 140-2 compliance mode.
-ETEXI
SRST
``-enable-fips``
Enable FIPS 140-2 compliance mode.
@@ -7633,15 +4270,6 @@ DEF("msg", HAS_ARG, QEMU_OPTION_msg,
" control error message format\n"
" timestamp=on enables timestamps (default: off)\n",
QEMU_ARCH_ALL)
-STEXI
-@item -msg timestamp[=on|off]
-@findex -msg
-Control error message format.
-@table @option
-@item timestamp=on|off
-Prefix messages with a timestamp. Default is off.
-@end table
-ETEXI
SRST
``-msg timestamp[=on|off]``
Control error message format.
@@ -7657,12 +4285,6 @@ DEF("dump-vmstate", HAS_ARG, QEMU_OPTION_dump_vmstate,
" check for possible regressions in migration code\n"
" by comparing two such vmstate dumps.\n",
QEMU_ARCH_ALL)
-STEXI
-@item -dump-vmstate @var{file}
-@findex -dump-vmstate
-Dump json-encoded vmstate information for current machine type to file
-in @var{file}
-ETEXI
SRST
``-dump-vmstate file``
Dump json-encoded vmstate information for current machine type to
@@ -7673,25 +4295,14 @@ DEF("enable-sync-profile", 0, QEMU_OPTION_enable_sync_profile,
"-enable-sync-profile\n"
" enable synchronization profiling\n",
QEMU_ARCH_ALL)
-STEXI
-@item -enable-sync-profile
-@findex -enable-sync-profile
-Enable synchronization profiling.
-ETEXI
SRST
``-enable-sync-profile``
Enable synchronization profiling.
ERST
-STEXI
-@end table
-ETEXI
DEFHEADING()
DEFHEADING(Generic object creation:)
-STEXI
-@table @option
-ETEXI
DEF("object", HAS_ARG, QEMU_OPTION_object,
"-object TYPENAME[,PROP1=VALUE1,...]\n"
@@ -7700,668 +4311,6 @@ DEF("object", HAS_ARG, QEMU_OPTION_object,
" property must be set. These objects are placed in the\n"
" '/objects' path.\n",
QEMU_ARCH_ALL)
-STEXI
-@item -object @var{typename}[,@var{prop1}=@var{value1},...]
-@findex -object
-Create a new object of type @var{typename} setting properties
-in the order they are specified. Note that the 'id'
-property must be set. These objects are placed in the
-'/objects' path.
-
-@table @option
-
-@item -object memory-backend-file,id=@var{id},size=@var{size},mem-path=@var{dir},share=@var{on|off},discard-data=@var{on|off},merge=@var{on|off},dump=@var{on|off},prealloc=@var{on|off},host-nodes=@var{host-nodes},policy=@var{default|preferred|bind|interleave},align=@var{align}
-
-Creates a memory file backend object, which can be used to back
-the guest RAM with huge pages.
-
-The @option{id} parameter is a unique ID that will be used to reference this
-memory region when configuring the @option{-numa} argument.
-
-The @option{size} option provides the size of the memory region, and accepts
-common suffixes, eg @option{500M}.
-
-The @option{mem-path} provides the path to either a shared memory or huge page
-filesystem mount.
-
-The @option{share} boolean option determines whether the memory
-region is marked as private to QEMU, or shared. The latter allows
-a co-operating external process to access the QEMU memory region.
-
-The @option{share} is also required for pvrdma devices due to
-limitations in the RDMA API provided by Linux.
-
-Setting share=on might affect the ability to configure NUMA
-bindings for the memory backend under some circumstances, see
-Documentation/vm/numa_memory_policy.txt on the Linux kernel
-source tree for additional details.
-
-Setting the @option{discard-data} boolean option to @var{on}
-indicates that file contents can be destroyed when QEMU exits,
-to avoid unnecessarily flushing data to the backing file. Note
-that @option{discard-data} is only an optimization, and QEMU
-might not discard file contents if it aborts unexpectedly or is
-terminated using SIGKILL.
-
-The @option{merge} boolean option enables memory merge, also known as
-MADV_MERGEABLE, so that Kernel Samepage Merging will consider the pages for
-memory deduplication.
-
-Setting the @option{dump} boolean option to @var{off} excludes the memory from
-core dumps. This feature is also known as MADV_DONTDUMP.
-
-The @option{prealloc} boolean option enables memory preallocation.
-
-The @option{host-nodes} option binds the memory range to a list of NUMA host
-nodes.
-
-The @option{policy} option sets the NUMA policy to one of the following values:
-
-@table @option
-@item @var{default}
-default host policy
-
-@item @var{preferred}
-prefer the given host node list for allocation
-
-@item @var{bind}
-restrict memory allocation to the given host node list
-
-@item @var{interleave}
-interleave memory allocations across the given host node list
-@end table
-
-The @option{align} option specifies the base address alignment when
-QEMU mmap(2) @option{mem-path}, and accepts common suffixes, eg
-@option{2M}. Some backend store specified by @option{mem-path}
-requires an alignment different than the default one used by QEMU, eg
-the device DAX /dev/dax0.0 requires 2M alignment rather than 4K. In
-such cases, users can specify the required alignment via this option.
-
-The @option{pmem} option specifies whether the backing file specified
-by @option{mem-path} is in host persistent memory that can be accessed
-using the SNIA NVM programming model (e.g. Intel NVDIMM).
-If @option{pmem} is set to 'on', QEMU will take necessary operations to
-guarantee the persistence of its own writes to @option{mem-path}
-(e.g. in vNVDIMM label emulation and live migration).
-Also, we will map the backend-file with MAP_SYNC flag, which ensures the
-file metadata is in sync for @option{mem-path} in case of host crash
-or a power failure. MAP_SYNC requires support from both the host kernel
-(since Linux kernel 4.15) and the filesystem of @option{mem-path} mounted
-with DAX option.
-
-@item -object memory-backend-ram,id=@var{id},merge=@var{on|off},dump=@var{on|off},share=@var{on|off},prealloc=@var{on|off},size=@var{size},host-nodes=@var{host-nodes},policy=@var{default|preferred|bind|interleave}
-
-Creates a memory backend object, which can be used to back the guest RAM.
-Memory backend objects offer more control than the @option{-m} option that is
-traditionally used to define guest RAM. Please refer to
-@option{memory-backend-file} for a description of the options.
-
-@item -object memory-backend-memfd,id=@var{id},merge=@var{on|off},dump=@var{on|off},share=@var{on|off},prealloc=@var{on|off},size=@var{size},host-nodes=@var{host-nodes},policy=@var{default|preferred|bind|interleave},seal=@var{on|off},hugetlb=@var{on|off},hugetlbsize=@var{size}
-
-Creates an anonymous memory file backend object, which allows QEMU to
-share the memory with an external process (e.g. when using
-vhost-user). The memory is allocated with memfd and optional
-sealing. (Linux only)
-
-The @option{seal} option creates a sealed-file, that will block
-further resizing the memory ('on' by default).
-
-The @option{hugetlb} option specify the file to be created resides in
-the hugetlbfs filesystem (since Linux 4.14). Used in conjunction with
-the @option{hugetlb} option, the @option{hugetlbsize} option specify
-the hugetlb page size on systems that support multiple hugetlb page
-sizes (it must be a power of 2 value supported by the system).
-
-In some versions of Linux, the @option{hugetlb} option is incompatible
-with the @option{seal} option (requires at least Linux 4.16).
-
-Please refer to @option{memory-backend-file} for a description of the
-other options.
-
-The @option{share} boolean option is @var{on} by default with memfd.
-
-@item -object rng-builtin,id=@var{id}
-
-Creates a random number generator backend which obtains entropy from
-QEMU builtin functions. The @option{id} parameter is a unique ID that
-will be used to reference this entropy backend from the @option{virtio-rng}
-device. By default, the @option{virtio-rng} device uses this RNG backend.
-
-@item -object rng-random,id=@var{id},filename=@var{/dev/random}
-
-Creates a random number generator backend which obtains entropy from
-a device on the host. The @option{id} parameter is a unique ID that
-will be used to reference this entropy backend from the @option{virtio-rng}
-device. The @option{filename} parameter specifies which file to obtain
-entropy from and if omitted defaults to @option{/dev/urandom}.
-
-@item -object rng-egd,id=@var{id},chardev=@var{chardevid}
-
-Creates a random number generator backend which obtains entropy from
-an external daemon running on the host. The @option{id} parameter is
-a unique ID that will be used to reference this entropy backend from
-the @option{virtio-rng} device. The @option{chardev} parameter is
-the unique ID of a character device backend that provides the connection
-to the RNG daemon.
-
-@item -object tls-creds-anon,id=@var{id},endpoint=@var{endpoint},dir=@var{/path/to/cred/dir},verify-peer=@var{on|off}
-
-Creates a TLS anonymous credentials object, which can be used to provide
-TLS support on network backends. The @option{id} parameter is a unique
-ID which network backends will use to access the credentials. The
-@option{endpoint} is either @option{server} or @option{client} depending
-on whether the QEMU network backend that uses the credentials will be
-acting as a client or as a server. If @option{verify-peer} is enabled
-(the default) then once the handshake is completed, the peer credentials
-will be verified, though this is a no-op for anonymous credentials.
-
-The @var{dir} parameter tells QEMU where to find the credential
-files. For server endpoints, this directory may contain a file
-@var{dh-params.pem} providing diffie-hellman parameters to use
-for the TLS server. If the file is missing, QEMU will generate
-a set of DH parameters at startup. This is a computationally
-expensive operation that consumes random pool entropy, so it is
-recommended that a persistent set of parameters be generated
-upfront and saved.
-
-@item -object tls-creds-psk,id=@var{id},endpoint=@var{endpoint},dir=@var{/path/to/keys/dir}[,username=@var{username}]
-
-Creates a TLS Pre-Shared Keys (PSK) credentials object, which can be used to provide
-TLS support on network backends. The @option{id} parameter is a unique
-ID which network backends will use to access the credentials. The
-@option{endpoint} is either @option{server} or @option{client} depending
-on whether the QEMU network backend that uses the credentials will be
-acting as a client or as a server. For clients only, @option{username}
-is the username which will be sent to the server. If omitted
-it defaults to ``qemu''.
-
-The @var{dir} parameter tells QEMU where to find the keys file.
-It is called ``@var{dir}/keys.psk'' and contains ``username:key''
-pairs. This file can most easily be created using the GnuTLS
-@code{psktool} program.
-
-For server endpoints, @var{dir} may also contain a file
-@var{dh-params.pem} providing diffie-hellman parameters to use
-for the TLS server. If the file is missing, QEMU will generate
-a set of DH parameters at startup. This is a computationally
-expensive operation that consumes random pool entropy, so it is
-recommended that a persistent set of parameters be generated
-up front and saved.
-
-@item -object tls-creds-x509,id=@var{id},endpoint=@var{endpoint},dir=@var{/path/to/cred/dir},priority=@var{priority},verify-peer=@var{on|off},passwordid=@var{id}
-
-Creates a TLS anonymous credentials object, which can be used to provide
-TLS support on network backends. The @option{id} parameter is a unique
-ID which network backends will use to access the credentials. The
-@option{endpoint} is either @option{server} or @option{client} depending
-on whether the QEMU network backend that uses the credentials will be
-acting as a client or as a server. If @option{verify-peer} is enabled
-(the default) then once the handshake is completed, the peer credentials
-will be verified. With x509 certificates, this implies that the clients
-must be provided with valid client certificates too.
-
-The @var{dir} parameter tells QEMU where to find the credential
-files. For server endpoints, this directory may contain a file
-@var{dh-params.pem} providing diffie-hellman parameters to use
-for the TLS server. If the file is missing, QEMU will generate
-a set of DH parameters at startup. This is a computationally
-expensive operation that consumes random pool entropy, so it is
-recommended that a persistent set of parameters be generated
-upfront and saved.
-
-For x509 certificate credentials the directory will contain further files
-providing the x509 certificates. The certificates must be stored
-in PEM format, in filenames @var{ca-cert.pem}, @var{ca-crl.pem} (optional),
-@var{server-cert.pem} (only servers), @var{server-key.pem} (only servers),
-@var{client-cert.pem} (only clients), and @var{client-key.pem} (only clients).
-
-For the @var{server-key.pem} and @var{client-key.pem} files which
-contain sensitive private keys, it is possible to use an encrypted
-version by providing the @var{passwordid} parameter. This provides
-the ID of a previously created @code{secret} object containing the
-password for decryption.
-
-The @var{priority} parameter allows to override the global default
-priority used by gnutls. This can be useful if the system administrator
-needs to use a weaker set of crypto priorities for QEMU without
-potentially forcing the weakness onto all applications. Or conversely
-if one wants wants a stronger default for QEMU than for all other
-applications, they can do this through this parameter. Its format is
-a gnutls priority string as described at
-@url{https://gnutls.org/manual/html_node/Priority-Strings.html}.
-
-@item -object filter-buffer,id=@var{id},netdev=@var{netdevid},interval=@var{t}[,queue=@var{all|rx|tx}][,status=@var{on|off}]
-
-Interval @var{t} can't be 0, this filter batches the packet delivery: all
-packets arriving in a given interval on netdev @var{netdevid} are delayed
-until the end of the interval. Interval is in microseconds.
-@option{status} is optional that indicate whether the netfilter is
-on (enabled) or off (disabled), the default status for netfilter will be 'on'.
-
-queue @var{all|rx|tx} is an option that can be applied to any netfilter.
-
-@option{all}: the filter is attached both to the receive and the transmit
- queue of the netdev (default).
-
-@option{rx}: the filter is attached to the receive queue of the netdev,
- where it will receive packets sent to the netdev.
-
-@option{tx}: the filter is attached to the transmit queue of the netdev,
- where it will receive packets sent by the netdev.
-
-@item -object filter-mirror,id=@var{id},netdev=@var{netdevid},outdev=@var{chardevid},queue=@var{all|rx|tx}[,vnet_hdr_support]
-
-filter-mirror on netdev @var{netdevid},mirror net packet to chardev@var{chardevid}, if it has the vnet_hdr_support flag, filter-mirror will mirror packet with vnet_hdr_len.
-
-@item -object filter-redirector,id=@var{id},netdev=@var{netdevid},indev=@var{chardevid},outdev=@var{chardevid},queue=@var{all|rx|tx}[,vnet_hdr_support]
-
-filter-redirector on netdev @var{netdevid},redirect filter's net packet to chardev
-@var{chardevid},and redirect indev's packet to filter.if it has the vnet_hdr_support flag,
-filter-redirector will redirect packet with vnet_hdr_len.
-Create a filter-redirector we need to differ outdev id from indev id, id can not
-be the same. we can just use indev or outdev, but at least one of indev or outdev
-need to be specified.
-
-@item -object filter-rewriter,id=@var{id},netdev=@var{netdevid},queue=@var{all|rx|tx},[vnet_hdr_support]
-
-Filter-rewriter is a part of COLO project.It will rewrite tcp packet to
-secondary from primary to keep secondary tcp connection,and rewrite
-tcp packet to primary from secondary make tcp packet can be handled by
-client.if it has the vnet_hdr_support flag, we can parse packet with vnet header.
-
-usage:
-colo secondary:
--object filter-redirector,id=f1,netdev=hn0,queue=tx,indev=red0
--object filter-redirector,id=f2,netdev=hn0,queue=rx,outdev=red1
--object filter-rewriter,id=rew0,netdev=hn0,queue=all
-
-@item -object filter-dump,id=@var{id},netdev=@var{dev}[,file=@var{filename}][,maxlen=@var{len}]
-
-Dump the network traffic on netdev @var{dev} to the file specified by
-@var{filename}. At most @var{len} bytes (64k by default) per packet are stored.
-The file format is libpcap, so it can be analyzed with tools such as tcpdump
-or Wireshark.
-
-@item -object colo-compare,id=@var{id},primary_in=@var{chardevid},secondary_in=@var{chardevid},outdev=@var{chardevid},iothread=@var{id}[,vnet_hdr_support][,notify_dev=@var{id}]
-
-Colo-compare gets packet from primary_in@var{chardevid} and secondary_in@var{chardevid}, than compare primary packet with
-secondary packet. If the packets are same, we will output primary
-packet to outdev@var{chardevid}, else we will notify colo-frame
-do checkpoint and send primary packet to outdev@var{chardevid}.
-In order to improve efficiency, we need to put the task of comparison
-in another thread. If it has the vnet_hdr_support flag, colo compare
-will send/recv packet with vnet_hdr_len.
-If you want to use Xen COLO, will need the notify_dev to notify Xen
-colo-frame to do checkpoint.
-
-we must use it with the help of filter-mirror and filter-redirector.
-
-@example
-
-KVM COLO
-
-primary:
--netdev tap,id=hn0,vhost=off,script=/etc/qemu-ifup,downscript=/etc/qemu-ifdown
--device e1000,id=e0,netdev=hn0,mac=52:a4:00:12:78:66
--chardev socket,id=mirror0,host=3.3.3.3,port=9003,server,nowait
--chardev socket,id=compare1,host=3.3.3.3,port=9004,server,nowait
--chardev socket,id=compare0,host=3.3.3.3,port=9001,server,nowait
--chardev socket,id=compare0-0,host=3.3.3.3,port=9001
--chardev socket,id=compare_out,host=3.3.3.3,port=9005,server,nowait
--chardev socket,id=compare_out0,host=3.3.3.3,port=9005
--object iothread,id=iothread1
--object filter-mirror,id=m0,netdev=hn0,queue=tx,outdev=mirror0
--object filter-redirector,netdev=hn0,id=redire0,queue=rx,indev=compare_out
--object filter-redirector,netdev=hn0,id=redire1,queue=rx,outdev=compare0
--object colo-compare,id=comp0,primary_in=compare0-0,secondary_in=compare1,outdev=compare_out0,iothread=iothread1
-
-secondary:
--netdev tap,id=hn0,vhost=off,script=/etc/qemu-ifup,down script=/etc/qemu-ifdown
--device e1000,netdev=hn0,mac=52:a4:00:12:78:66
--chardev socket,id=red0,host=3.3.3.3,port=9003
--chardev socket,id=red1,host=3.3.3.3,port=9004
--object filter-redirector,id=f1,netdev=hn0,queue=tx,indev=red0
--object filter-redirector,id=f2,netdev=hn0,queue=rx,outdev=red1
-
-
-Xen COLO
-
-primary:
--netdev tap,id=hn0,vhost=off,script=/etc/qemu-ifup,downscript=/etc/qemu-ifdown
--device e1000,id=e0,netdev=hn0,mac=52:a4:00:12:78:66
--chardev socket,id=mirror0,host=3.3.3.3,port=9003,server,nowait
--chardev socket,id=compare1,host=3.3.3.3,port=9004,server,nowait
--chardev socket,id=compare0,host=3.3.3.3,port=9001,server,nowait
--chardev socket,id=compare0-0,host=3.3.3.3,port=9001
--chardev socket,id=compare_out,host=3.3.3.3,port=9005,server,nowait
--chardev socket,id=compare_out0,host=3.3.3.3,port=9005
--chardev socket,id=notify_way,host=3.3.3.3,port=9009,server,nowait
--object filter-mirror,id=m0,netdev=hn0,queue=tx,outdev=mirror0
--object filter-redirector,netdev=hn0,id=redire0,queue=rx,indev=compare_out
--object filter-redirector,netdev=hn0,id=redire1,queue=rx,outdev=compare0
--object iothread,id=iothread1
--object colo-compare,id=comp0,primary_in=compare0-0,secondary_in=compare1,outdev=compare_out0,notify_dev=nofity_way,iothread=iothread1
-
-secondary:
--netdev tap,id=hn0,vhost=off,script=/etc/qemu-ifup,down script=/etc/qemu-ifdown
--device e1000,netdev=hn0,mac=52:a4:00:12:78:66
--chardev socket,id=red0,host=3.3.3.3,port=9003
--chardev socket,id=red1,host=3.3.3.3,port=9004
--object filter-redirector,id=f1,netdev=hn0,queue=tx,indev=red0
--object filter-redirector,id=f2,netdev=hn0,queue=rx,outdev=red1
-
-@end example
-
-If you want to know the detail of above command line, you can read
-the colo-compare git log.
-
-@item -object cryptodev-backend-builtin,id=@var{id}[,queues=@var{queues}]
-
-Creates a cryptodev backend which executes crypto opreation from
-the QEMU cipher APIS. The @var{id} parameter is
-a unique ID that will be used to reference this cryptodev backend from
-the @option{virtio-crypto} device. The @var{queues} parameter is optional,
-which specify the queue number of cryptodev backend, the default of
-@var{queues} is 1.
-
-@example
-
- # @value{qemu_system} \
- [...] \
- -object cryptodev-backend-builtin,id=cryptodev0 \
- -device virtio-crypto-pci,id=crypto0,cryptodev=cryptodev0 \
- [...]
-@end example
-
-@item -object cryptodev-vhost-user,id=@var{id},chardev=@var{chardevid}[,queues=@var{queues}]
-
-Creates a vhost-user cryptodev backend, backed by a chardev @var{chardevid}.
-The @var{id} parameter is a unique ID that will be used to reference this
-cryptodev backend from the @option{virtio-crypto} device.
-The chardev should be a unix domain socket backed one. The vhost-user uses
-a specifically defined protocol to pass vhost ioctl replacement messages
-to an application on the other end of the socket.
-The @var{queues} parameter is optional, which specify the queue number
-of cryptodev backend for multiqueue vhost-user, the default of @var{queues} is 1.
-
-@example
-
- # @value{qemu_system} \
- [...] \
- -chardev socket,id=chardev0,path=/path/to/socket \
- -object cryptodev-vhost-user,id=cryptodev0,chardev=chardev0 \
- -device virtio-crypto-pci,id=crypto0,cryptodev=cryptodev0 \
- [...]
-@end example
-
-@item -object secret,id=@var{id},data=@var{string},format=@var{raw|base64}[,keyid=@var{secretid},iv=@var{string}]
-@item -object secret,id=@var{id},file=@var{filename},format=@var{raw|base64}[,keyid=@var{secretid},iv=@var{string}]
-
-Defines a secret to store a password, encryption key, or some other sensitive
-data. The sensitive data can either be passed directly via the @var{data}
-parameter, or indirectly via the @var{file} parameter. Using the @var{data}
-parameter is insecure unless the sensitive data is encrypted.
-
-The sensitive data can be provided in raw format (the default), or base64.
-When encoded as JSON, the raw format only supports valid UTF-8 characters,
-so base64 is recommended for sending binary data. QEMU will convert from
-which ever format is provided to the format it needs internally. eg, an
-RBD password can be provided in raw format, even though it will be base64
-encoded when passed onto the RBD sever.
-
-For added protection, it is possible to encrypt the data associated with
-a secret using the AES-256-CBC cipher. Use of encryption is indicated
-by providing the @var{keyid} and @var{iv} parameters. The @var{keyid}
-parameter provides the ID of a previously defined secret that contains
-the AES-256 decryption key. This key should be 32-bytes long and be
-base64 encoded. The @var{iv} parameter provides the random initialization
-vector used for encryption of this particular secret and should be a
-base64 encrypted string of the 16-byte IV.
-
-The simplest (insecure) usage is to provide the secret inline
-
-@example
-
- # @value{qemu_system} -object secret,id=sec0,data=letmein,format=raw
-
-@end example
-
-The simplest secure usage is to provide the secret via a file
-
- # printf "letmein" > mypasswd.txt
- # @value{qemu_system} -object secret,id=sec0,file=mypasswd.txt,format=raw
-
-For greater security, AES-256-CBC should be used. To illustrate usage,
-consider the openssl command line tool which can encrypt the data. Note
-that when encrypting, the plaintext must be padded to the cipher block
-size (32 bytes) using the standard PKCS#5/6 compatible padding algorithm.
-
-First a master key needs to be created in base64 encoding:
-
-@example
- # openssl rand -base64 32 > key.b64
- # KEY=$(base64 -d key.b64 | hexdump -v -e '/1 "%02X"')
-@end example
-
-Each secret to be encrypted needs to have a random initialization vector
-generated. These do not need to be kept secret
-
-@example
- # openssl rand -base64 16 > iv.b64
- # IV=$(base64 -d iv.b64 | hexdump -v -e '/1 "%02X"')
-@end example
-
-The secret to be defined can now be encrypted, in this case we're
-telling openssl to base64 encode the result, but it could be left
-as raw bytes if desired.
-
-@example
- # SECRET=$(printf "letmein" |
- openssl enc -aes-256-cbc -a -K $KEY -iv $IV)
-@end example
-
-When launching QEMU, create a master secret pointing to @code{key.b64}
-and specify that to be used to decrypt the user password. Pass the
-contents of @code{iv.b64} to the second secret
-
-@example
- # @value{qemu_system} \
- -object secret,id=secmaster0,format=base64,file=key.b64 \
- -object secret,id=sec0,keyid=secmaster0,format=base64,\
- data=$SECRET,iv=$(<iv.b64)
-@end example
-
-@item -object sev-guest,id=@var{id},cbitpos=@var{cbitpos},reduced-phys-bits=@var{val},[sev-device=@var{string},policy=@var{policy},handle=@var{handle},dh-cert-file=@var{file},session-file=@var{file}]
-
-Create a Secure Encrypted Virtualization (SEV) guest object, which can be used
-to provide the guest memory encryption support on AMD processors.
-
-When memory encryption is enabled, one of the physical address bit (aka the
-C-bit) is utilized to mark if a memory page is protected. The @option{cbitpos}
-is used to provide the C-bit position. The C-bit position is Host family dependent
-hence user must provide this value. On EPYC, the value should be 47.
-
-When memory encryption is enabled, we loose certain bits in physical address space.
-The @option{reduced-phys-bits} is used to provide the number of bits we loose in
-physical address space. Similar to C-bit, the value is Host family dependent.
-On EPYC, the value should be 5.
-
-The @option{sev-device} provides the device file to use for communicating with
-the SEV firmware running inside AMD Secure Processor. The default device is
-'/dev/sev'. If hardware supports memory encryption then /dev/sev devices are
-created by CCP driver.
-
-The @option{policy} provides the guest policy to be enforced by the SEV firmware
-and restrict what configuration and operational commands can be performed on this
-guest by the hypervisor. The policy should be provided by the guest owner and is
-bound to the guest and cannot be changed throughout the lifetime of the guest.
-The default is 0.
-
-If guest @option{policy} allows sharing the key with another SEV guest then
-@option{handle} can be use to provide handle of the guest from which to share
-the key.
-
-The @option{dh-cert-file} and @option{session-file} provides the guest owner's
-Public Diffie-Hillman key defined in SEV spec. The PDH and session parameters
-are used for establishing a cryptographic session with the guest owner to
-negotiate keys used for attestation. The file must be encoded in base64.
-
-e.g to launch a SEV guest
-@example
- # @value{qemu_system_x86} \
- ......
- -object sev-guest,id=sev0,cbitpos=47,reduced-phys-bits=5 \
- -machine ...,memory-encryption=sev0
- .....
-
-@end example
-
-
-@item -object authz-simple,id=@var{id},identity=@var{string}
-
-Create an authorization object that will control access to network services.
-
-The @option{identity} parameter is identifies the user and its format
-depends on the network service that authorization object is associated
-with. For authorizing based on TLS x509 certificates, the identity must
-be the x509 distinguished name. Note that care must be taken to escape
-any commas in the distinguished name.
-
-An example authorization object to validate a x509 distinguished name
-would look like:
-@example
- # @value{qemu_system} \
- ...
- -object 'authz-simple,id=auth0,identity=CN=laptop.example.com,,O=Example Org,,L=London,,ST=London,,C=GB' \
- ...
-@end example
-
-Note the use of quotes due to the x509 distinguished name containing
-whitespace, and escaping of ','.
-
-@item -object authz-listfile,id=@var{id},filename=@var{path},refresh=@var{yes|no}
-
-Create an authorization object that will control access to network services.
-
-The @option{filename} parameter is the fully qualified path to a file
-containing the access control list rules in JSON format.
-
-An example set of rules that match against SASL usernames might look
-like:
-
-@example
- @{
- "rules": [
- @{ "match": "fred", "policy": "allow", "format": "exact" @},
- @{ "match": "bob", "policy": "allow", "format": "exact" @},
- @{ "match": "danb", "policy": "deny", "format": "glob" @},
- @{ "match": "dan*", "policy": "allow", "format": "exact" @},
- ],
- "policy": "deny"
- @}
-@end example
-
-When checking access the object will iterate over all the rules and
-the first rule to match will have its @option{policy} value returned
-as the result. If no rules match, then the default @option{policy}
-value is returned.
-
-The rules can either be an exact string match, or they can use the
-simple UNIX glob pattern matching to allow wildcards to be used.
-
-If @option{refresh} is set to true the file will be monitored
-and automatically reloaded whenever its content changes.
-
-As with the @code{authz-simple} object, the format of the identity
-strings being matched depends on the network service, but is usually
-a TLS x509 distinguished name, or a SASL username.
-
-An example authorization object to validate a SASL username
-would look like:
-@example
- # @value{qemu_system} \
- ...
- -object authz-simple,id=auth0,filename=/etc/qemu/vnc-sasl.acl,refresh=yes
- ...
-@end example
-
-@item -object authz-pam,id=@var{id},service=@var{string}
-
-Create an authorization object that will control access to network services.
-
-The @option{service} parameter provides the name of a PAM service to use
-for authorization. It requires that a file @code{/etc/pam.d/@var{service}}
-exist to provide the configuration for the @code{account} subsystem.
-
-An example authorization object to validate a TLS x509 distinguished
-name would look like:
-
-@example
- # @value{qemu_system} \
- ...
- -object authz-pam,id=auth0,service=qemu-vnc
- ...
-@end example
-
-There would then be a corresponding config file for PAM at
-@code{/etc/pam.d/qemu-vnc} that contains:
-
-@example
-account requisite pam_listfile.so item=user sense=allow \
- file=/etc/qemu/vnc.allow
-@end example
-
-Finally the @code{/etc/qemu/vnc.allow} file would contain
-the list of x509 distingished names that are permitted
-access
-
-@example
-CN=laptop.example.com,O=Example Home,L=London,ST=London,C=GB
-@end example
-
-@item -object iothread,id=@var{id},poll-max-ns=@var{poll-max-ns},poll-grow=@var{poll-grow},poll-shrink=@var{poll-shrink}
-
-Creates a dedicated event loop thread that devices can be assigned to. This is
-known as an IOThread. By default device emulation happens in vCPU threads or
-the main event loop thread. This can become a scalability bottleneck.
-IOThreads allow device emulation and I/O to run on other host CPUs.
-
-The @option{id} parameter is a unique ID that will be used to reference this
-IOThread from @option{-device ...,iothread=@var{id}}. Multiple devices can be
-assigned to an IOThread. Note that not all devices support an
-@option{iothread} parameter.
-
-The @code{query-iothreads} QMP command lists IOThreads and reports their thread
-IDs so that the user can configure host CPU pinning/affinity.
-
-IOThreads use an adaptive polling algorithm to reduce event loop latency.
-Instead of entering a blocking system call to monitor file descriptors and then
-pay the cost of being woken up when an event occurs, the polling algorithm
-spins waiting for events for a short time. The algorithm's default parameters
-are suitable for many cases but can be adjusted based on knowledge of the
-workload and/or host device latency.
-
-The @option{poll-max-ns} parameter is the maximum number of nanoseconds to busy
-wait for events. Polling can be disabled by setting this value to 0.
-
-The @option{poll-grow} parameter is the multiplier used to increase the polling
-time when the algorithm detects it is missing events due to not polling long
-enough.
-
-The @option{poll-shrink} parameter is the divisor used to decrease the polling
-time when the algorithm detects it is spending too long polling without
-encountering events.
-
-The polling parameters can be modified at run-time using the @code{qom-set} command (where @code{iothread1} is the IOThread's @code{id}):
-
-@example
-(qemu) qom-set /objects/iothread1 poll-max-ns 100000
-@end example
-
-@end table
-
-ETEXI
SRST
``-object typename[,prop1=value1,...]``
Create a new object of type typename setting properties in the order
@@ -9035,6 +4984,3 @@ ERST
HXCOMM This is the last statement. Insert new options before this line!
-STEXI
-@end table
-ETEXI
--
2.20.1
^ permalink raw reply related [flat|nested] 82+ messages in thread* Re: [PATCH v3 33/33] *.hx: Remove all the STEXI/ETEXI blocks
2020-02-28 15:36 ` [PATCH v3 33/33] *.hx: Remove all the STEXI/ETEXI blocks Peter Maydell
@ 2020-03-02 12:36 ` Alex Bennée
0 siblings, 0 replies; 82+ messages in thread
From: Alex Bennée @ 2020-03-02 12:36 UTC (permalink / raw)
To: Peter Maydell; +Cc: Paolo Bonzini, qemu-devel, Kashyap Chamarthy
Peter Maydell <peter.maydell@linaro.org> writes:
> We no longer generate texinfo from the hxtool input files,
> so delete all the STEXI/ETEXI blocks.
>
> This commit was created using the following Perl one-liner:
> perl -i -n -e '$suppress = 1,next if /^STEXI/;$suppress=0,next if /^ETEXI/; print if !$suppress;' *.hx
>
> Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
> ---
> hmp-commands-info.hx | 329 ----
> hmp-commands.hx | 821 ---------
> qemu-options.hx | 4054 ------------------------------------------
> 3 files changed, 5204 deletions(-)
>
> diff --git a/hmp-commands-info.hx b/hmp-commands-info.hx
> index 1730f866cde..499d6d54b01 100644
> --- a/hmp-commands-info.hx
> +++ b/hmp-commands-info.hx
> @@ -11,13 +11,6 @@ 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.
We still mention them in the preamble just before:
HXCOMM Text between STEXI and ETEXI are copied to texi version and
HXCOMM discarded from C version
And don't mention the SRST/ERST sections. It might be worth tweaking
that while we are at it.
Otherwise:
Reviewed-by: Alex Bennée <alex.bennee@linaro.org>
--
Alex Bennée
^ permalink raw reply [flat|nested] 82+ messages in thread
* Re: [PATCH v3 00/33] Convert qemu-doc to rST
2020-02-28 15:35 [PATCH v3 00/33] Convert qemu-doc to rST Peter Maydell
` (32 preceding siblings ...)
2020-02-28 15:36 ` [PATCH v3 33/33] *.hx: Remove all the STEXI/ETEXI blocks Peter Maydell
@ 2020-02-28 18:36 ` Peter Maydell
2020-02-28 21:20 ` Stefan Weil
2020-03-02 12:41 ` Alex Bennée
2020-03-03 17:35 ` Peter Maydell
35 siblings, 1 reply; 82+ messages in thread
From: Peter Maydell @ 2020-02-28 18:36 UTC (permalink / raw)
To: QEMU Developers; +Cc: Paolo Bonzini, Stefan Weil, Kashyap Chamarthy
Hi Stefan -- I meant to cc you on these but forgot, relating to the
"qemu.nsi needs updating to know that it should install
Sphinx documentation these days" part...
On Fri, 28 Feb 2020 at 15:36, Peter Maydell <peter.maydell@linaro.org> wrote:
>
> Hi; this series does a complete conversion of qemu-doc from
> Texinfo to rST, including the hxtool-generated parts and
> creation of the qemu.1 manpage from rST.
>
> It's marked v3 because it's a development of the v2 that
> Paolo sent out earlier this week.
>
> Changes from v2:
> * I made the various review-comment fixes I suggested in
> replies to Paolo's series
> * rebased on current master
> * new patches at the end of the series which do the conversion
> of the .hx file doc fragments to rST
> (I did part of this semi-by-hand and then qemu-options.hx
> entirely automatically)
> * new patches which generate the qemu.1 manpage with Sphinx
> * new patches which remove the old qemu-doc makefile runes
> and other references to it
> * new patches which delete the old texinfo sources, etc
>
> The only thing left still using Texinfo after this is the
> docs autogenerated from the QAPI doc-comments, which are
> their own standalone html and manpages so not affected by this.
>
> A couple of notes:
> * I haven't actually been in a position to test the cocoa.m
> update of the HTML filename
> * qemu.nsi (the Windows installer config file) thinks that
> qemu-doc.html is the only doc file it needs to know about,
> which is clearly wrong. However I don't have any idea about
> the Windows installer to be able to update or test it...
>
> The conversion is a little rough around the edges in a few
> place (mostly I have noted in commit messages when this is
> the case) but I would like to argue for (assuming we're happy
> with the series broadly) taking it into master and then refining
> it in-place. Having it out-of-tree for long is an invitation
> to conflicts and to accidentally losing docs updates if they
> hit master as changes to the texi or hx files before this
> series goes in.
>
> You can find a prerendered set of docs at
> https://people.linaro.org/~peter.maydell/qdoc-no-texi/
> (the interesting part is the system emulation user's guide,
> mostly), and a copy of the new manpage at
> https://people.linaro.org/~peter.maydell/qemu.1
> (download and examine with 'man -l path/to/qemu.1').
>
> thanks
> -- PMM
^ permalink raw reply [flat|nested] 82+ messages in thread* Re: [PATCH v3 00/33] Convert qemu-doc to rST
2020-02-28 18:36 ` [PATCH v3 00/33] Convert qemu-doc to rST Peter Maydell
@ 2020-02-28 21:20 ` Stefan Weil
2020-02-29 11:50 ` Peter Maydell
0 siblings, 1 reply; 82+ messages in thread
From: Stefan Weil @ 2020-02-28 21:20 UTC (permalink / raw)
To: Peter Maydell, QEMU Developers; +Cc: Paolo Bonzini, Kashyap Chamarthy
Am 28.02.20 um 19:36 schrieb Peter Maydell:
> Hi Stefan -- I meant to cc you on these but forgot, relating to the
> "qemu.nsi needs updating to know that it should install
> Sphinx documentation these days" part...
>
> On Fri, 28 Feb 2020 at 15:36, Peter Maydell <peter.maydell@linaro.org> wrote:
[...]
>> A couple of notes:
>> * I haven't actually been in a position to test the cocoa.m
>> update of the HTML filename
>> * qemu.nsi (the Windows installer config file) thinks that
>> qemu-doc.html is the only doc file it needs to know about,
>> which is clearly wrong. However I don't have any idea about
>> the Windows installer to be able to update or test it...
Maybe it is sufficient to update qemu.nsi after that series was merged.
Do you think that all documentation should be part of the Windows
installer, although it is also available online? Too much documentation
can be confusing, because it makes it more difficult to find the right
entry.
Kind regards
Stefan
^ permalink raw reply [flat|nested] 82+ messages in thread
* Re: [PATCH v3 00/33] Convert qemu-doc to rST
2020-02-28 21:20 ` Stefan Weil
@ 2020-02-29 11:50 ` Peter Maydell
0 siblings, 0 replies; 82+ messages in thread
From: Peter Maydell @ 2020-02-29 11:50 UTC (permalink / raw)
To: Stefan Weil; +Cc: Paolo Bonzini, QEMU Developers, Kashyap Chamarthy
On Fri, 28 Feb 2020 at 21:20, Stefan Weil <sw@weilnetz.de> wrote:
> Maybe it is sufficient to update qemu.nsi after that series was merged.
If you're happy to do it that way round I think that would certainly
make life easier in trying to get this series merged without too
much delay.
> Do you think that all documentation should be part of the Windows
> installer, although it is also available online? Too much documentation
> can be confusing, because it makes it more difficult to find the right
> entry.
I don't have a strong opinion here, but:
* the contents that were in qemu-doc.html will now be in the
various Sphinx manuals, so if we want to install any
docs locally at all then installing at least the system/
manual would be the equivalent of the old qemu-doc
* is there a strong reason for the Windows installer not
to just install the same set of HTML docs that the Linux
'make install' does?
Three possible choices:
(1) don't install any docs locally at all (rely on the online docs)
(2) install just the 'system' manual (this will catch most of the
documentation relevant for Windows, but misses a few bits
like the guest-agent docs which might still matter for Windows users)
(3) install all the manuals (this will include some manuals or sections
definitely not of interest for Windows, like the linux-user manual)
thanks
-- PMM
^ permalink raw reply [flat|nested] 82+ messages in thread
* Re: [PATCH v3 00/33] Convert qemu-doc to rST
2020-02-28 15:35 [PATCH v3 00/33] Convert qemu-doc to rST Peter Maydell
` (33 preceding siblings ...)
2020-02-28 18:36 ` [PATCH v3 00/33] Convert qemu-doc to rST Peter Maydell
@ 2020-03-02 12:41 ` Alex Bennée
2020-03-03 17:35 ` Peter Maydell
35 siblings, 0 replies; 82+ messages in thread
From: Alex Bennée @ 2020-03-02 12:41 UTC (permalink / raw)
To: Peter Maydell; +Cc: Paolo Bonzini, qemu-devel, Kashyap Chamarthy
Peter Maydell <peter.maydell@linaro.org> writes:
> Hi; this series does a complete conversion of qemu-doc from
> Texinfo to rST, including the hxtool-generated parts and
> creation of the qemu.1 manpage from rST.
>
> It's marked v3 because it's a development of the v2 that
> Paolo sent out earlier this week.
<snip>
I should mention the whole thing is:
Tested-by: Alex Bennée <alex.bennee@linaro.org>
by virtue of my custom rtd branch:
https://qemu-stsquad.readthedocs.io/en/doc-updates/index.html
--
Alex Bennée
^ permalink raw reply [flat|nested] 82+ messages in thread* Re: [PATCH v3 00/33] Convert qemu-doc to rST
2020-02-28 15:35 [PATCH v3 00/33] Convert qemu-doc to rST Peter Maydell
` (34 preceding siblings ...)
2020-03-02 12:41 ` Alex Bennée
@ 2020-03-03 17:35 ` Peter Maydell
2020-03-03 17:44 ` Paolo Bonzini
` (2 more replies)
35 siblings, 3 replies; 82+ messages in thread
From: Peter Maydell @ 2020-03-03 17:35 UTC (permalink / raw)
To: QEMU Developers; +Cc: Paolo Bonzini, Kashyap Chamarthy
On Fri, 28 Feb 2020 at 15:36, Peter Maydell <peter.maydell@linaro.org> wrote:
>
> Hi; this series does a complete conversion of qemu-doc from
> Texinfo to rST, including the hxtool-generated parts and
> creation of the qemu.1 manpage from rST.
>
Advance notice: I would like to put these into a pull
request at the end of this week. This is your opportunity
to say "that would be a bad idea", "I need X more time
to review it", etc :-)
thanks
-- PMM
^ permalink raw reply [flat|nested] 82+ messages in thread* Re: [PATCH v3 00/33] Convert qemu-doc to rST
2020-03-03 17:35 ` Peter Maydell
@ 2020-03-03 17:44 ` Paolo Bonzini
2020-03-03 18:19 ` Alex Bennée
2020-03-04 9:12 ` Kashyap Chamarthy
2 siblings, 0 replies; 82+ messages in thread
From: Paolo Bonzini @ 2020-03-03 17:44 UTC (permalink / raw)
To: Peter Maydell, QEMU Developers; +Cc: Kashyap Chamarthy
On 03/03/20 18:35, Peter Maydell wrote:
> Advance notice: I would like to put these into a pull
> request at the end of this week. This is your opportunity
> to say "that would be a bad idea", "I need X more time
> to review it", etc :-)
>
On the contrary, it's a great idea. :)
Paolo
^ permalink raw reply [flat|nested] 82+ messages in thread
* Re: [PATCH v3 00/33] Convert qemu-doc to rST
2020-03-03 17:35 ` Peter Maydell
2020-03-03 17:44 ` Paolo Bonzini
@ 2020-03-03 18:19 ` Alex Bennée
2020-03-04 9:12 ` Kashyap Chamarthy
2 siblings, 0 replies; 82+ messages in thread
From: Alex Bennée @ 2020-03-03 18:19 UTC (permalink / raw)
To: Peter Maydell; +Cc: Paolo Bonzini, qemu-devel, Kashyap Chamarthy
Peter Maydell <peter.maydell@linaro.org> writes:
> On Fri, 28 Feb 2020 at 15:36, Peter Maydell <peter.maydell@linaro.org> wrote:
>>
>> Hi; this series does a complete conversion of qemu-doc from
>> Texinfo to rST, including the hxtool-generated parts and
>> creation of the qemu.1 manpage from rST.
>>
>
> Advance notice: I would like to put these into a pull
> request at the end of this week. This is your opportunity
> to say "that would be a bad idea", "I need X more time
> to review it", etc :-)
Just merge it, we can fix things up afterwards if we need to but it's a
big step in the right direction.
>
> thanks
> -- PMM
--
Alex Bennée
^ permalink raw reply [flat|nested] 82+ messages in thread
* Re: [PATCH v3 00/33] Convert qemu-doc to rST
2020-03-03 17:35 ` Peter Maydell
2020-03-03 17:44 ` Paolo Bonzini
2020-03-03 18:19 ` Alex Bennée
@ 2020-03-04 9:12 ` Kashyap Chamarthy
2 siblings, 0 replies; 82+ messages in thread
From: Kashyap Chamarthy @ 2020-03-04 9:12 UTC (permalink / raw)
To: Peter Maydell; +Cc: Paolo Bonzini, QEMU Developers
On Tue, Mar 03, 2020 at 05:35:01PM +0000, Peter Maydell wrote:
> On Fri, 28 Feb 2020 at 15:36, Peter Maydell <peter.maydell@linaro.org> wrote:
> >
> > Hi; this series does a complete conversion of qemu-doc from
> > Texinfo to rST, including the hxtool-generated parts and
> > creation of the qemu.1 manpage from rST.
> >
>
> Advance notice: I would like to put these into a pull
> request at the end of this week. This is your opportunity
> to say "that would be a bad idea", "I need X more time
> to review it", etc :-)
I tried to probe some of the generated docs; I couldn't spot something
that is glaring. (Granted, I didn't spend a _whole_ lot of time.)
And I'm with Paolo — yes, let's get this merged, and address other
issues as follow-ups :-)
--
/kashyap
^ permalink raw reply [flat|nested] 82+ messages in thread