Reviewed-by: Thomas Huth <thuth@redhat.com>

Signed-off-by: Pierrick Bouvier <pierrick.bouvier@linaro.org>

---

docs/devel/submitting-a-patch.rst | 5 +----

1 file changed, 1 insertion(+), 4 deletions(-)

diff --git a/docs/devel/submitting-a-patch.rst b/docs/devel/submitting-a-patch.rst

index XXXXXXX..XXXXXXX 100644

--- a/docs/devel/submitting-a-patch.rst

+++ b/docs/devel/submitting-a-patch.rst

@@ -XXX,XX +XXX,XX @@ patches to the QEMU mailing list by following these steps:

#. Send your patches to the QEMU mailing list using the web-based

``git-send-email`` UI at https://git.sr.ht/~USERNAME/qemu/send-email

-`This video

-<https://spacepub.space/videos/watch/ad258d23-0ac6-488c-83fc-2bacf578de3a>`__

-shows the web-based ``git-send-email`` workflow. Documentation is

-available `here

+Documentation for sourcehut is available `here

<https://man.sr.ht/git.sr.ht/#sending-patches-upstream>`__.

.. _cc_the_relevant_maintainer:

--

2.39.5

Signed-off-by: Pierrick Bouvier <pierrick.bouvier@linaro.org>

---

docs/devel/submitting-a-patch.rst | 10 ++++++++++

1 file changed, 10 insertions(+)

diff --git a/docs/devel/submitting-a-patch.rst b/docs/devel/submitting-a-patch.rst

index XXXXXXX..XXXXXXX 100644

--- a/docs/devel/submitting-a-patch.rst

+++ b/docs/devel/submitting-a-patch.rst

@@ -XXX,XX +XXX,XX @@ For more details on how QEMU's stable process works, refer to the

.. _participating_in_code_review:

+Retrieve an existing series

+---------------------------

+

+If you want to apply an existing series on top of your tree, you can simply use

+`b4 <https://github.com/mricon/b4>`__.

+

+::

+

+ b4 shazam $msg-id

+

Participating in Code Review

----------------------------

--

2.39.5

MacOS and Linux are straightforward, but Windows needs a bit more

details.

Signed-off-by: Pierrick Bouvier <pierrick.bouvier@linaro.org>

---

docs/about/build-platforms.rst | 4 +-

docs/devel/build-environment.rst | 118 +++++++++++++++++++++++++++++++

docs/devel/index-build.rst | 1 +

3 files changed, 122 insertions(+), 1 deletion(-)

create mode 100644 docs/devel/build-environment.rst

diff --git a/docs/about/build-platforms.rst b/docs/about/build-platforms.rst

index XXXXXXX..XXXXXXX 100644

--- a/docs/about/build-platforms.rst

+++ b/docs/about/build-platforms.rst

@@ -XXX,XX +XXX,XX @@ The `Repology`_ site is a useful resource to identify

currently shipped versions of software in various operating systems,

though it does not cover all distros listed below.

+You can find how to install build dependencies for different systems on the

+:ref:`setup-build-env` page.

+

Supported host architectures

----------------------------

@@ -XXX,XX +XXX,XX @@ Optional build dependencies

cross compilation using ``docker`` or ``podman``, or to use pre-built

binaries distributed with QEMU.

-

Windows

-------

diff --git a/docs/devel/build-environment.rst b/docs/devel/build-environment.rst

new file mode 100644

index XXXXXXX..XXXXXXX

--- /dev/null

+++ b/docs/devel/build-environment.rst

@@ -XXX,XX +XXX,XX @@

+

+.. _setup-build-env:

+

+Setup build environment

+=======================

+

+QEMU uses a lot of dependencies on the host system. glib2 is used everywhere in

+the code base, and most of the other dependencies are optional.

+

+We present here simple instructions to enable native builds on most popular

+systems.

+

+You can find additional instructions on `QEMU wiki <https://wiki.qemu.org/>`_:

+

+- `Linux <https://wiki.qemu.org/Hosts/Linux>`_

+- `MacOS <https://wiki.qemu.org/Hosts/Mac>`_

+- `Windows <https://wiki.qemu.org/Hosts/W32>`_

+- `BSD <https://wiki.qemu.org/Hosts/BSD>`_

+

+Note: Installing dependencies using your package manager build dependencies may

+miss out on deps that have been newly introduced in qemu.git. In more, it misses

+deps the distribution has decided to exclude.

+

+Linux

+-----

+

+Fedora

+++++++

+

+::

+

+ sudo dnf update && sudo dnf builddep qemu

+

+Debian/Ubuntu

++++++++++++++

+

+You first need to enable `Sources List <https://wiki.debian.org/SourcesList>`_.

+Then, use apt to install dependencies:

+

+::

+

+ sudo apt update && sudo apt build-dep qemu

+

+MacOS

+-----

+

+You first need to install `Homebrew <https://brew.sh/>`_. Then, use it to

+install dependencies:

+

+::

+

+ brew update && brew install $(brew deps --include-build qemu)

+

+Windows

+-------

+

+You first need to install `MSYS2 <https://www.msys2.org/>`_.

+MSYS2 offers `different environments <https://www.msys2.org/docs/environments/>`_.

+x86_64 environments are based on GCC, while aarch64 is based on Clang.

+

+We recommend to use MINGW64 for windows-x86_64 and CLANGARM64 for windows-aarch64

+(only available on windows-aarch64 hosts).

+

+Then, you can open a windows shell, and enter msys2 env using:

+

+::

+

+ c:/msys64/msys2_shell.cmd -defterm -here -no-start -mingw64

+ # Replace -ucrt64 by -clangarm64 or -ucrt64 for other environments.

+

+MSYS2 package manager does not offer a built-in way to install build

+dependencies. You can start with this list of packages using pacman:

+

+Note: Dependencies need to be installed again if you use a different MSYS2

+environment.

+

+::

+

+ # update MSYS2 itself, you need to reopen your shell at the end.

+ pacman -Syu

+ pacman -S \

+ base-devel binutils bison diffutils flex git grep make sed \

+ ${MINGW_PACKAGE_PREFIX}-toolchain \

+ ${MINGW_PACKAGE_PREFIX}-glib2 \

+ ${MINGW_PACKAGE_PREFIX}-gtk3 \

+ ${MINGW_PACKAGE_PREFIX}-libnfs \

+ ${MINGW_PACKAGE_PREFIX}-libssh \

+ ${MINGW_PACKAGE_PREFIX}-ninja \

+ ${MINGW_PACKAGE_PREFIX}-pixman \

+ ${MINGW_PACKAGE_PREFIX}-pkgconf \

+ ${MINGW_PACKAGE_PREFIX}-python \

+ ${MINGW_PACKAGE_PREFIX}-SDL2 \

+ ${MINGW_PACKAGE_PREFIX}-zstd

+

+If you want to install all dependencies, it's possible to use recipe used to

+build QEMU in MSYS2 itself.

+

+::

+

+ pacman -S wget

+ wget https://raw.githubusercontent.com/msys2/MINGW-packages/refs/heads/master/mingw-w64-qemu/PKGBUILD

+ # Some packages may be missing for your environment, installation will still

+ # be done though.

+ makepkg -s PKGBUILD || true

+

+Build on windows-aarch64

+++++++++++++++++++++++++

+

+When trying to cross compile meson for x86_64 using UCRT64 or MINGW64 env,

+configure will run into an error because the cpu detected is not correct.

+

+Meson detects x86_64 processes emulated, so you need to manually set the cpu,

+and force a cross compilation (with empty prefix).

+

+::

+

+ ./configure --cpu=x86_64 --cross-prefix=

+

diff --git a/docs/devel/index-build.rst b/docs/devel/index-build.rst

index XXXXXXX..XXXXXXX 100644

--- a/docs/devel/index-build.rst

+++ b/docs/devel/index-build.rst

@@ -XXX,XX +XXX,XX @@ some of the basics if you are adding new files and targets to the build.

:maxdepth: 3

build-system

+ build-environment

kconfig

docs

qapi-code-gen

--

2.39.5

Present the various parts of QEMU and organization of codebase.

Signed-off-by: Pierrick Bouvier <pierrick.bouvier@linaro.org>

---

docs/about/emulation.rst | 2 +

docs/devel/codebase.rst | 218 +++++++++++++++++++++++++

docs/devel/decodetree.rst | 2 +

docs/devel/ebpf_rss.rst | 2 +

docs/devel/index-internals.rst | 2 +

docs/devel/index.rst | 1 +

docs/devel/migration/main.rst | 2 +

docs/devel/qapi-code-gen.rst | 1 +

docs/devel/testing/main.rst | 9 +-

docs/devel/testing/qtest.rst | 2 +

docs/index.rst | 2 +

docs/interop/qemu-ga.rst | 2 +

docs/system/qemu-block-drivers.rst.inc | 2 +

docs/tools/qemu-storage-daemon.rst | 2 +

docs/user/main.rst | 6 +

15 files changed, 254 insertions(+), 1 deletion(-)

create mode 100644 docs/devel/codebase.rst

diff --git a/docs/about/emulation.rst b/docs/about/emulation.rst

index XXXXXXX..XXXXXXX 100644

--- a/docs/about/emulation.rst

+++ b/docs/about/emulation.rst

@@ -XXX,XX +XXX,XX @@ for that architecture.

- System

- Tensilica ISS SIMCALL

+.. _tcg-plugins:

+

TCG Plugins

-----------

diff --git a/docs/devel/codebase.rst b/docs/devel/codebase.rst

new file mode 100644

index XXXXXXX..XXXXXXX

--- /dev/null

+++ b/docs/devel/codebase.rst

@@ -XXX,XX +XXX,XX @@

+========

+Codebase

+========

+

+This section presents the various parts of QEMU and how the codebase is

+organized.

+

+Beyond giving succint descriptions, the goal is to offer links to various

+parts of the documentation/codebase.

+

+Subsystems

+----------

+

+An exhaustive list of subsystems and associated files can be found in the

+`MAINTAINERS <https://gitlab.com/qemu-project/qemu/-/blob/master/MAINTAINERS>`_

+file.

+

+Some of the main QEMU subsystems are:

+

+- `Accelerators<Accelerators>`

+- Block devices and `disk images<disk images>` support

+- `CI<ci>` and `Tests<testing>`

+- `Devices<device-emulation>` & Board models

+- `Documentation <documentation-root>`

+- `GDB support<GDB usage>`

+- `Migration<migration>`

+- `Monitor<QEMU monitor>`

+- :ref:`QOM (QEMU Object Model)<qom>`

+- `System mode<System emulation>`

+- :ref:`TCG (Tiny Code Generator)<tcg>`

+- `User mode<user-mode>` (`Linux<linux-user-mode>` & `BSD<bsd-user-mode>`)

+- User Interfaces

+

+More documentation on QEMU subsystems can be found on :ref:`internal-subsystem`

+page.

+

+The Grand tour

+--------------

+

+We present briefly here what every folder of the codebase contains. Hop on!

+

+The folder name links here will take you to that folder in our gitlab

+repository. Other links will take you to more detailed documentation for that

+subsystem, where we have it. Unfortunately not every subsystem has documentation

+yet, so sometimes the source code is all you have.

+

+* `accel <https://gitlab.com/qemu-project/qemu/-/tree/master/accel>`_:

+ Infrastructure and architecture agnostic code related to the various

+ `accelerators <Accelerators>` supported by QEMU

+ (TCG, KVM, hvf, whpx, xen, nvmm).

+ Contains interfaces for operations that will be implemented per

+ `target <https://gitlab.com/qemu-project/qemu/-/tree/master/target>`_.

+* `audio <https://gitlab.com/qemu-project/qemu/-/tree/master/audio>`_:

+ Audio (host) support.

+* `authz <https://gitlab.com/qemu-project/qemu/-/tree/master/authz>`_:

+ `QEMU Authorization framework<client authorization>`.

+* `backends <https://gitlab.com/qemu-project/qemu/-/tree/master/backends>`_:

+ Various backends used for device emulation.

+* `block <https://gitlab.com/qemu-project/qemu/-/tree/master/block>`_:

+ Block devices and `image formats<disk images>` implementation.

+* `bsd-user <https://gitlab.com/qemu-project/qemu/-/tree/master/bsd-user>`_:

+ `BSD User mode<bsd-user-mode>`.

+* build: Where the code built goes by default. You can tell the QEMU build

+ system to put the built code anywhere else you like.

+* `chardev <https://gitlab.com/qemu-project/qemu/-/tree/master/chardev>`_:

+ Various backends used by char devices.

+* `common-user <https://gitlab.com/qemu-project/qemu/-/tree/master/common-user>`_:

+ User-mode assembly code for dealing with signals occuring during syscalls.

+* `configs <https://gitlab.com/qemu-project/qemu/-/tree/master/configs>`_:

+ Makefiles defining configurations to build QEMU.

+* `contrib <https://gitlab.com/qemu-project/qemu/-/tree/master/contrib>`_:

+ Community contributed devices/plugins/tools.

+* `crypto <https://gitlab.com/qemu-project/qemu/-/tree/master/crypto>`_:

+ Cryptographic algorithms used in QEMU.

+* `disas <https://gitlab.com/qemu-project/qemu/-/tree/master/disas>`_:

+ Disassembly functions used by QEMU target code.

+* `docs <https://gitlab.com/qemu-project/qemu/-/tree/master/docs>`_:

+ QEMU Documentation.

+* `dump <https://gitlab.com/qemu-project/qemu/-/tree/master/dump>`_:

+ Code to dump memory of a running VM.

+* `ebpf <https://gitlab.com/qemu-project/qemu/-/tree/master/ebpf>`_:

+ eBPF program support in QEMU. `virtio-net RSS<ebpf-rss>` uses it.

+* `fpu <https://gitlab.com/qemu-project/qemu/-/tree/master/fpu>`_:

+ Floating-point software emulation.

+* `fsdev <https://gitlab.com/qemu-project/qemu/-/tree/master/fsdev>`_:

+ `VirtFS <https://www.linux-kvm.org/page/VirtFS>`_ support.

+* `gdbstub <https://gitlab.com/qemu-project/qemu/-/tree/master/gdbstub>`_:

+ `GDB <GDB usage>` support.

+* `gdb-xml <https://gitlab.com/qemu-project/qemu/-/tree/master/gdb-xml>`_:

+ Set of XML files describing architectures and used by `gdbstub <GDB usage>`.

+* `host <https://gitlab.com/qemu-project/qemu/-/tree/master/host>`_:

+ Various architecture specific header files (crypto, atomic, memory

+ operations).

+* `linux-headers <https://gitlab.com/qemu-project/qemu/-/tree/master/linux-headers>`_:

+ A subset of headers imported from Linux kernel and used for implementing

+ KVM support and user-mode.

+* `linux-user <https://gitlab.com/qemu-project/qemu/-/tree/master/linux-user>`_:

+ `User mode <user-mode>` implementation. Contains one folder per target

+ architecture.

+* `.gitlab-ci.d <https://gitlab.com/qemu-project/qemu/-/tree/master/.gitlab-ci.d>`_:

+ `CI <ci>` yaml and scripts.

+* `include <https://gitlab.com/qemu-project/qemu/-/tree/master/include>`_:

+ All headers associated to different subsystems in QEMU. The hierachy used

+ mirrors source code organization and naming.

+* `hw <https://gitlab.com/qemu-project/qemu/-/tree/master/hw>`_:

+ `Devices <device-emulation>` and boards emulation. Devices are categorized by

+ type/protocol/architecture and located in associated subfolder.

+* `io <https://gitlab.com/qemu-project/qemu/-/tree/master/io>`_:

+ QEMU `I/O channels <https://lists.gnu.org/archive/html/qemu-devel/2015-11/msg04208.html>`_.

+* `libdecnumber <https://gitlab.com/qemu-project/qemu/-/tree/master/libdecnumber>`_:

+ Import of gcc library, used to implement decimal number arithmetic.

+* `migration <https://gitlab.com/qemu-project/qemu/-/tree/master/migration>`__:

+ `Migration framework <migration>`.

+* `monitor <https://gitlab.com/qemu-project/qemu/-/tree/master/monitor>`_:

+ `Monitor <QEMU monitor>` implementation (HMP & QMP).

+* `nbd <https://gitlab.com/qemu-project/qemu/-/tree/master/nbd>`_:

+ QEMU `NBD (Network Block Device) <nbd>` server.

+* `net <https://gitlab.com/qemu-project/qemu/-/tree/master/net>`_:

+ Network (host) support.

+* `pc-bios <https://gitlab.com/qemu-project/qemu/-/tree/master/pc-bios>`_:

+ Contains pre-built firmware binaries and boot images, ready to use in

+ QEMU without compilation.

+* `plugins <https://gitlab.com/qemu-project/qemu/-/tree/master/plugins>`_:

+ :ref:`TCG plugins <tcg-plugins>` core implementation. Plugins can be found in

+ `tests <https://gitlab.com/qemu-project/qemu/-/tree/master/tests/tcg/plugins>`__

+ and `contrib <https://gitlab.com/qemu-project/qemu/-/tree/master/contrib/plugins>`__

+ folders.

+* `po <https://gitlab.com/qemu-project/qemu/-/tree/master/po>`_:

+ Translation files.

+* `python <https://gitlab.com/qemu-project/qemu/-/tree/master/python>`_:

+ Python part of our build/test system.

+* `qapi <https://gitlab.com/qemu-project/qemu/-/tree/master/qapi>`_:

+ `QAPI <qapi>` implementation.

+* `qobject <https://gitlab.com/qemu-project/qemu/-/tree/master/qobject>`_:

+ QEMU Object implementation.

+* `qga <https://gitlab.com/qemu-project/qemu/-/tree/master/qga>`_:

+ QEMU `Guest agent <qemu-ga>` implementation.

+* `qom <https://gitlab.com/qemu-project/qemu/-/tree/master/qom>`_:

+ QEMU :ref:`Object model <qom>` implementation, with monitor associated commands.

+* `replay <https://gitlab.com/qemu-project/qemu/-/tree/master/replay>`_:

+ QEMU :ref:`Record/replay <replay>` implementation.

+* `roms <https://gitlab.com/qemu-project/qemu/-/tree/master/roms>`_:

+ Contains source code for various firmware and ROMs, which can be compiled if

+ custom or updated versions are needed.

+* `rust <https://gitlab.com/qemu-project/qemu/-/tree/master/rust>`_:

+ Rust integration in QEMU. It contains the new interfaces defined and

+ associated devices using it.

+* `scripts <https://gitlab.com/qemu-project/qemu/-/tree/master/scripts>`_:

+ Collection of scripts used in build and test systems, and various

+ tools for QEMU codebase and execution traces.

+* `scsi <https://gitlab.com/qemu-project/qemu/-/tree/master/scsi>`_:

+ Code related to SCSI support, used by SCSI devices.

+* `semihosting <https://gitlab.com/qemu-project/qemu/-/tree/master/semihosting>`_:

+ QEMU `Semihosting <Semihosting>` implementation.

+* `stats <https://gitlab.com/qemu-project/qemu/-/tree/master/stats>`_:

+ `Monitor <QEMU monitor>` stats commands implementation.

+* `storage-daemon <https://gitlab.com/qemu-project/qemu/-/tree/master/storage-daemon>`_:

+ QEMU `Storage daemon <storage-daemon>` implementation.

+* `stubs <https://gitlab.com/qemu-project/qemu/-/tree/master/stubs>`_:

+ Various stubs (empty functions) used to compile QEMU with specific

+ configurations.

+* `subprojects <https://gitlab.com/qemu-project/qemu/-/tree/master/subprojects>`_:

+ QEMU submodules used by QEMU build system.

+* `system <https://gitlab.com/qemu-project/qemu/-/tree/master/system>`_:

+ QEMU `system mode <System emulation>` implementation (cpu, mmu, boot support).

+* `target <https://gitlab.com/qemu-project/qemu/-/tree/master/target>`_:

+ Contains code for all target architectures supported (one subfolder

+ per arch). For every architecture, you can find accelerator specific

+ implementations.

+* `tcg <https://gitlab.com/qemu-project/qemu/-/tree/master/tcg>`_:

+ :ref:`TCG <tcg>` related code.

+ Contains one subfolder per host supported architecture.

+* `tests <https://gitlab.com/qemu-project/qemu/-/tree/master/tests>`_:

+ QEMU `test <testing>` suite

+

+ - `avocado <https://gitlab.com/qemu-project/qemu/-/tree/master/tests/avocado>`_:

+ Functional tests booting full VM using `Avocado framework <checkavocado-ref>`.

+ Those tests will be transformed and moved into

+ `tests/functional <https://gitlab.com/qemu-project/qemu/-/tree/master/tests/functional>`_

+ in the future.

+ - `data <https://gitlab.com/qemu-project/qemu/-/tree/master/tests/data>`_:

+ Data for various tests.

+ - `decode <https://gitlab.com/qemu-project/qemu/-/tree/master/tests/decode>`_:

+ Testsuite for :ref:`decodetree <decodetree>` implementation.

+ - `docker <https://gitlab.com/qemu-project/qemu/-/tree/master/tests/docker>`_:

+ Code and scripts to create `containers <container-ref>` used in `CI <ci>`.

+ - `fp <https://gitlab.com/qemu-project/qemu/-/tree/master/tests/fp>`_:

+ QEMU testsuite for soft float implementation.

+ - `functional <https://gitlab.com/qemu-project/qemu/-/tree/master/tests/functional>`_:

+ `Functional tests <checkfunctional-ref>` (full VM boot).

+ - `lcitool <https://gitlab.com/qemu-project/qemu/-/tree/master/tests/lcitool>`_:

+ Generate dockerfiles for CI containers.

+ - `migration <https://gitlab.com/qemu-project/qemu/-/tree/master/tests/migration>`_:

+ Test scripts and data for `Migration framework <migration>`.

+ - `multiboot <https://gitlab.com/qemu-project/qemu/-/tree/master/tests/multiboot>`_:

+ Test multiboot functionality for x86_64/i386.

+ - `qapi-schema <https://gitlab.com/qemu-project/qemu/-/tree/master/tests/qapi-schema>`_:

+ Test scripts and data for `QAPI <qapi-tests>`.

+ - `qemu-iotests <https://gitlab.com/qemu-project/qemu/-/tree/master/tests/qemu-iotests>`_:

+ `Disk image and block tests <qemu-iotests>`.

+ - `qtest <https://gitlab.com/qemu-project/qemu/-/tree/master/tests/qtest>`_:

+ `Device emulation testing <qtest>`.

+ - `tcg <https://gitlab.com/qemu-project/qemu/-/tree/master/tests/tcg>`__:

+ `TCG related tests <checktcg-ref>`. Contains code per architecture

+ (subfolder) and multiarch tests as well.

+ - `tsan <https://gitlab.com/qemu-project/qemu/-/tree/master/tests/tsan>`_:

+ `Suppressions <tsan-suppressions>` for thread sanitizer.

+ - `uefi-test-tools <https://gitlab.com/qemu-project/qemu/-/tree/master/tests/uefi-test-tools>`_:

+ Test tool for UEFI support.

+ - `unit <https://gitlab.com/qemu-project/qemu/-/tree/master/tests/unit>`_:

+ QEMU `Unit tests <unit-tests>`.

+* `trace <https://gitlab.com/qemu-project/qemu/-/tree/master/trace>`_:

+ :ref:`Tracing framework <tracing>`. Used to print information associated to various

+ events during execution.

+* `ui <https://gitlab.com/qemu-project/qemu/-/tree/master/ui>`_:

+ QEMU User interfaces.

+* `util <https://gitlab.com/qemu-project/qemu/-/tree/master/util>`_:

+ Utility code used by other parts of QEMU.

diff --git a/docs/devel/decodetree.rst b/docs/devel/decodetree.rst

index XXXXXXX..XXXXXXX 100644

--- a/docs/devel/decodetree.rst

+++ b/docs/devel/decodetree.rst

@@ -XXX,XX +XXX,XX @@

+.. _decodetree:

+

========================

Decodetree Specification

========================

diff --git a/docs/devel/ebpf_rss.rst b/docs/devel/ebpf_rss.rst

index XXXXXXX..XXXXXXX 100644

--- a/docs/devel/ebpf_rss.rst

+++ b/docs/devel/ebpf_rss.rst

@@ -XXX,XX +XXX,XX @@

+.. _ebpf-rss:

+

===========================

eBPF RSS virtio-net support

===========================

diff --git a/docs/devel/index-internals.rst b/docs/devel/index-internals.rst

index XXXXXXX..XXXXXXX 100644

--- a/docs/devel/index-internals.rst

+++ b/docs/devel/index-internals.rst

@@ -XXX,XX +XXX,XX @@

+.. _internal-subsystem:

+

Internal Subsystem Information

------------------------------

diff --git a/docs/devel/index.rst b/docs/devel/index.rst

index XXXXXXX..XXXXXXX 100644

--- a/docs/devel/index.rst

+++ b/docs/devel/index.rst

@@ -XXX,XX +XXX,XX @@ the :ref:`tcg_internals`.

index-api

index-internals

index-tcg

+ codebase

diff --git a/docs/devel/migration/main.rst b/docs/devel/migration/main.rst

index XXXXXXX..XXXXXXX 100644

--- a/docs/devel/migration/main.rst

+++ b/docs/devel/migration/main.rst

@@ -XXX,XX +XXX,XX @@

+.. _migration:

+

===================

Migration framework

===================

diff --git a/docs/devel/qapi-code-gen.rst b/docs/devel/qapi-code-gen.rst

index XXXXXXX..XXXXXXX 100644

--- a/docs/devel/qapi-code-gen.rst

+++ b/docs/devel/qapi-code-gen.rst

@@ -XXX,XX +XXX,XX @@ How to use the QAPI code generator

This work is licensed under the terms of the GNU GPL, version 2 or

later. See the COPYING file in the top-level directory.

+.. _qapi:

Introduction

============

diff --git a/docs/devel/testing/main.rst b/docs/devel/testing/main.rst

index XXXXXXX..XXXXXXX 100644

--- a/docs/devel/testing/main.rst

+++ b/docs/devel/testing/main.rst

@@ -XXX,XX +XXX,XX @@ Before running tests, it is best to build QEMU programs first. Some tests

expect the executables to exist and will fail with obscure messages if they

cannot find them.

+.. _unit-tests:

+

Unit tests

~~~~~~~~~~

@@ -XXX,XX +XXX,XX @@ successfully on various hosts. The following list shows some best practices:

#ifdef in the codes. If the whole test suite cannot run on Windows, disable

the build in the meson.build file.

+.. _qapi-tests:

+

QAPI schema tests

~~~~~~~~~~~~~~~~~

@@ -XXX,XX +XXX,XX @@ check-block

are in the "auto" group).

See the "QEMU iotests" section below for more information.

+.. _qemu-iotests:

+

QEMU iotests

------------

@@ -XXX,XX +XXX,XX @@ The above exitcode=0 has TSan continue without error if any warnings are found.

This allows for running the test and then checking the warnings afterwards.

If you want TSan to stop and exit with error on warnings, use exitcode=66.

+.. _tsan-suppressions:

+

TSan Suppressions

~~~~~~~~~~~~~~~~~

Keep in mind that for any data race warning, although there might be a data race

@@ -XXX,XX +XXX,XX @@ You can run the avocado tests simply by executing:

See :ref:`checkavocado-ref` for more details.

-

.. _checktcg-ref:

Testing with "make check-tcg"

diff --git a/docs/devel/testing/qtest.rst b/docs/devel/testing/qtest.rst

index XXXXXXX..XXXXXXX 100644

--- a/docs/devel/testing/qtest.rst

+++ b/docs/devel/testing/qtest.rst

@@ -XXX,XX +XXX,XX @@

+.. _qtest:

+

========================================

QTest Device Emulation Testing Framework

========================================

diff --git a/docs/index.rst b/docs/index.rst

index XXXXXXX..XXXXXXX 100644

--- a/docs/index.rst

+++ b/docs/index.rst

@@ -XXX,XX +XXX,XX @@

You can adapt this file completely to your liking, but it should at least

contain the root `toctree` directive.

+.. _documentation-root:

+

================================

Welcome to QEMU's documentation!

================================

diff --git a/docs/interop/qemu-ga.rst b/docs/interop/qemu-ga.rst

index XXXXXXX..XXXXXXX 100644

--- a/docs/interop/qemu-ga.rst

+++ b/docs/interop/qemu-ga.rst

@@ -XXX,XX +XXX,XX @@

+.. _qemu-ga:

+

QEMU Guest Agent

================

diff --git a/docs/system/qemu-block-drivers.rst.inc b/docs/system/qemu-block-drivers.rst.inc

index XXXXXXX..XXXXXXX 100644

--- a/docs/system/qemu-block-drivers.rst.inc

+++ b/docs/system/qemu-block-drivers.rst.inc

@@ -XXX,XX +XXX,XX @@ What you should *never* do:

- expect it to work when loadvm'ing

- write to the FAT directory on the host system while accessing it with the guest system

+.. _nbd:

+

NBD access

~~~~~~~~~~

diff --git a/docs/tools/qemu-storage-daemon.rst b/docs/tools/qemu-storage-daemon.rst

index XXXXXXX..XXXXXXX 100644

--- a/docs/tools/qemu-storage-daemon.rst

+++ b/docs/tools/qemu-storage-daemon.rst

@@ -XXX,XX +XXX,XX @@

+.. _storage-daemon:

+

===================

QEMU Storage Daemon

===================

diff --git a/docs/user/main.rst b/docs/user/main.rst

index XXXXXXX..XXXXXXX 100644

--- a/docs/user/main.rst

+++ b/docs/user/main.rst

@@ -XXX,XX +XXX,XX @@

+.. _user-mode:

+

QEMU User space emulator

========================

@@ -XXX,XX +XXX,XX @@ 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-mode:

+

Linux User space emulator

-------------------------

@@ -XXX,XX +XXX,XX @@ Other binaries

* ``qemu-sparc64`` can execute some Sparc64 (Sparc64 CPU, 64 bit ABI) and

SPARC32PLUS binaries (Sparc64 CPU, 32 bit ABI).

+.. _bsd-user-mode:

+

BSD User space emulator

-----------------------

--

2.39.5

Signed-off-by: Pierrick Bouvier <pierrick.bouvier@linaro.org>

---

docs/devel/control-flow-integrity.rst | 2 +

docs/devel/multi-thread-tcg.rst | 2 +

docs/glossary.rst | 280 ++++++++++++++++++++++++++

docs/index.rst | 1 +

docs/system/arm/virt.rst | 2 +

docs/system/images.rst | 2 +

docs/tools/qemu-nbd.rst | 2 +

7 files changed, 291 insertions(+)

create mode 100644 docs/glossary.rst

diff --git a/docs/devel/control-flow-integrity.rst b/docs/devel/control-flow-integrity.rst

index XXXXXXX..XXXXXXX 100644

--- a/docs/devel/control-flow-integrity.rst

+++ b/docs/devel/control-flow-integrity.rst

@@ -XXX,XX +XXX,XX @@

+.. _cfi:

+

============================

Control-Flow Integrity (CFI)

============================

diff --git a/docs/devel/multi-thread-tcg.rst b/docs/devel/multi-thread-tcg.rst

index XXXXXXX..XXXXXXX 100644

--- a/docs/devel/multi-thread-tcg.rst

+++ b/docs/devel/multi-thread-tcg.rst

@@ -XXX,XX +XXX,XX @@

This work is licensed under the terms of the GNU GPL, version 2 or

later. See the COPYING file in the top-level directory.

+.. _mttcg:

+

==================

Multi-threaded TCG

==================

diff --git a/docs/glossary.rst b/docs/glossary.rst

new file mode 100644

index XXXXXXX..XXXXXXX

--- /dev/null

+++ b/docs/glossary.rst

@@ -XXX,XX +XXX,XX @@

+.. _Glossary:

+

+--------

+Glossary

+--------

+

+This section of the manual presents brief definitions of acronyms and terms used

+by QEMU developers.

+

+Accelerator

+-----------

+

+A specific API used to accelerate execution of guest instructions. It can be

+hardware-based, through a virtualization API provided by the host OS (kvm, hvf,

+whpx, ...), or software-based (tcg). See this description of `supported

+accelerators<Accelerators>`.

+

+Board

+-----

+

+Another name for :ref:`machine`.

+

+Block

+-----

+

+Block drivers are the available `disk formats and front-ends

+<block-drivers>` available, and block devices `(see Block device section on

+options page)<sec_005finvocation>` are using them to implement disks for a

+virtual machine.

+

+CFI

+---

+

+Control Flow Integrity is a hardening technique used to prevent exploits

+targeting QEMU by detecting unexpected branches during execution. QEMU `actively

+supports<cfi>` being compiled with CFI enabled.

+

+Device

+------

+

+In QEMU, a device is a piece of hardware visible to the guest. Examples include

+UARTs, PCI controllers, PCI cards, VGA controllers, and many more.

+

+QEMU is able to emulate a CPU, and all the hardware interacting with it,

+including `many devices<device-emulation>`. When QEMU runs a virtual machine

+using a hardware-based accelerator, it is responsible for emulating, using

+software, all devices.

+

+EDK2

+----

+

+EDK2, as known as `TianoCore <https://www.tianocore.org/>`_, is an open source

+implementation of UEFI standard. QEMU virtual machines that boot a UEFI firmware

+usually use EDK2.

+

+gdbstub

+-------

+

+QEMU implements a `gdb server <GDB usage>`, allowing gdb to attach to it and

+debug a running virtual machine, or a program in user-mode. This allows

+debugging the guest code that is running inside QEMU.

+

+glib2

+-----

+

+`GLib2 <https://docs.gtk.org/glib/>`_ is one of the most important libraries we

+are using through the codebase. It provides many data structures, macros, string

+and thread utilities and portable functions across different OS. It's required

+to build QEMU.

+

+Guest agent

+-----------

+

+The `QEMU Guest Agent <qemu-ga>` is a daemon intended to be run within virtual

+machines. It provides various services to help QEMU to interact with it.

+

+.. _guest:

+

+Guest

+-----

+

+Guest is the architecture of the virtual machine, which is emulated.

+See also :ref:`host`.

+

+Sometimes this is called the :ref:`target` architecture, but that term

+can be ambiguous.

+

+.. _host:

+

+Host

+----

+

+Host is the architecture on which QEMU is running on, which is native.

+See also :ref:`guest`.

+

+Hypervisor

+----------

+

+The formal definition of an hypervisor is a program or API than can be used to

+manage a virtual machine. QEMU is a virtualizer, that interacts with various

+hypervisors.

+

+In the context of QEMU, an hypervisor is an API, provided by the Host OS,

+allowing to execute virtual machines. Linux implementation is KVM (and supports

+Xen as well). For MacOS, it's HVF. Windows defines WHPX. And NetBSD provides

+NVMM.

+

+.. _machine:

+

+Machine

+-------

+

+QEMU's system emulation models many different types of hardware. A machine model

+(sometimes called a board model) is the model of a complete virtual system with

+RAM, one or more CPUs, and various devices. It can be selected with the option

+``-machine`` of qemu-system. Our machine models can be found on this `page

+<system-targets-ref>`.

+

+Migration

+---------

+

+QEMU can save and restore the execution of a virtual machine between different

+host systems. This is provided by the `Migration framework<migration>`.

+

+NBD

+---

+

+The `QEMU Network Block Device server <qemu-nbd>` is a tool that can be used to

+mount and access QEMU images, providing functionality similar to a loop device.

+

+Mailing List

+------------

+

+This is `where <https://wiki.qemu.org/Contribute/MailingLists>`_ all the

+development happens! Changes are posted as series, that all developers can

+review and share feedback for.

+

+For reporting issues, our `GitLab

+<https://gitlab.com/qemu-project/qemu/-/issues>`_ tracker is the best place.

+

+.. _softmmu:

+

+MMU / softmmu

+-------------

+

+The Memory Management Unit is responsible for translating virtual addresses to

+physical addresses and managing memory protection. QEMU system mode is named

+"softmmu" precisely because it implements this in software, including a TLB

+(Translation lookaside buffer), for the guest virtual machine.

+

+QEMU user-mode does not implement a full software MMU, but "simply" translates

+virtual addresses by adding a specific offset, and relying on host MMU/OS

+instead.

+

+Monitor / QMP / HMP

+-------------------

+

+The `QEMU Monitor <QEMU monitor>` is a text interface which can be used to interact

+with a running virtual machine.

+

+QMP stands for QEMU Monitor Protocol and is a json based interface.

+HMP stands for Human Monitor Protocol and is a set of text commands available

+for users who prefer natural language to json.

+

+MTTCG

+-----

+

+Multiple CPU support was first implemented using a round-robin algorithm

+running on a single thread. Later on, `Multi-threaded TCG <mttcg>` was developed

+to benefit from multiple cores to speed up execution.

+

+Plugins

+-------

+

+`TCG Plugins <TCG Plugins>` is an API used to instrument guest code, in system

+and user mode. The end goal is to have a similar set of functionality compared

+to `DynamoRIO <https://dynamorio.org/>`_ or `valgrind <https://valgrind.org/>`_.

+

+One key advantage of QEMU plugins is that they can be used to perform

+architecture agnostic instrumentation.

+

+Patchew

+-------

+

+`Patchew <https://patchew.org/QEMU/>`_ is a website that tracks patches on the

+Mailing List.

+

+PR

+--

+

+Once a series is reviewed and accepted by a subsystem maintainer, it will be

+included in a PR (Pull Request) that the project maintainer will merge into QEMU

+main branch, after running tests.

+

+The QEMU project doesn't currently expect most developers to directly submit

+pull requests.

+

+QCOW2

+-----

+

+QEMU Copy On Write is a disk format developed by QEMU. It provides transparent

+compression, automatic extension, and many other advantages over a raw image.

+

+qcow2 is the recommended format to use.

+

+QEMU

+----

+

+`QEMU (Quick Emulator) <https://www.qemu.org/>`_ is a generic and open source

+machine emulator and virtualizer.

+

+QOM

+---

+

+`QEMU Object Model <qom>` is an object oriented API used to define various

+devices and hardware in the QEMU codebase.

+

+Record/replay

+-------------

+

+`Record/replay <replay>` is a feature of QEMU allowing to have a deterministic

+and reproducible execution of a virtual machine.

+

+Rust

+----

+

+`A new programming language <https://www.rust-lang.org/>`_, memory safe by

+default. There is a work in progress to integrate it in QEMU codebase for

+various subsystems.

+

+System mode

+-----------

+

+QEMU System mode provides a virtual model of an entire machine (CPU, memory and

+emulated devices) to run a guest OS. In this mode the CPU may be fully emulated,

+or it may work with a hypervisor such as KVM, Xen or Hypervisor.Framework to

+allow the guest to run directly on the host CPU.

+

+QEMU System mode is called :ref:`softmmu <softmmu>` as well.

+

+.. _target:

+

+Target

+------

+

+The term "target" can be ambiguous. In most places in QEMU it is used as a

+synonym for :ref:`guest`. For example the code for emulating Arm CPUs is in

+``target/arm/``. However in the :ref:`TCG subsystem <tcg>` "target" refers to the

+architecture which QEMU is running on, i.e. the :ref:`host`.

+

+TCG

+---

+

+TCG is the QEMU `Tiny Code Generator <tcg>`. It is the JIT (just-in-time)

+compiler we use to emulate a guest CPU in software.

+

+It is one of the accelerators supported by QEMU, and supports a lot of

+guest/host architectures.

+

+User mode

+---------

+

+QEMU User mode can launch processes compiled for one CPU on another CPU. In this

+mode the CPU is always emulated. In this mode, QEMU translate system calls from

+guest to host kernel. It is available for Linux and BSD.

+

+VirtIO

+------

+

+VirtIO is an open standard used to define and implement virtual devices with a

+minimal overhead, defining a set of data structures and hypercalls (similar to

+system calls, but targeting an hypervisor, which happens to be QEMU in our

+case). It's designed to be more efficient than emulating a real device, by

+minimizing the amount of interactions between a guest VM and its hypervisor.

+

+vhost-user

+----------

+

+`Vhost-user <vhost_user>` is an interface used to implement VirtIO devices

+outside of QEMU itself.

diff --git a/docs/index.rst b/docs/index.rst

index XXXXXXX..XXXXXXX 100644

--- a/docs/index.rst

+++ b/docs/index.rst

@@ -XXX,XX +XXX,XX @@ Welcome to QEMU's documentation!

interop/index

specs/index

devel/index

+ glossary

diff --git a/docs/system/arm/virt.rst b/docs/system/arm/virt.rst

index XXXXXXX..XXXXXXX 100644

--- a/docs/system/arm/virt.rst

+++ b/docs/system/arm/virt.rst

@@ -XXX,XX +XXX,XX @@

+.. _arm-virt:

+

'virt' generic virtual platform (``virt``)

==========================================

diff --git a/docs/system/images.rst b/docs/system/images.rst

index XXXXXXX..XXXXXXX 100644

--- a/docs/system/images.rst

+++ b/docs/system/images.rst

@@ -XXX,XX +XXX,XX @@ VM snapshots currently have the following known limitations:

- A few device drivers still have incomplete snapshot support so their

state is not saved or restored properly (in particular USB).

+.. _block-drivers:

+

.. include:: qemu-block-drivers.rst.inc

diff --git a/docs/tools/qemu-nbd.rst b/docs/tools/qemu-nbd.rst

index XXXXXXX..XXXXXXX 100644

--- a/docs/tools/qemu-nbd.rst

+++ b/docs/tools/qemu-nbd.rst

@@ -XXX,XX +XXX,XX @@

+.. _qemu-nbd:

+

=====================================

QEMU Disk Network Block Device Server

=====================================

--

2.39.5