QEMU With E2K User Support
Go to file
Philippe Mathieu-Daudé 9ada9fd259 docs: Document GitLab custom CI/CD variables
We introduced the QEMU_CI_AVOCADO_TESTING variable in commit f56bf4caf
("gitlab: Run Avocado tests manually (except mainstream CI)"), but
forgot to document it properly. Do it now.

Suggested-by: Thomas Huth <thuth@redhat.com>
Signed-off-by: Philippe Mathieu-Daudé <philmd@redhat.com>
Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>
Reviewed-by: Willian Rampazzo <willianr@redhat.com>
Reviewed-by: Thomas Huth <thuth@redhat.com>
Message-Id: <20210727142431.1672530-2-philmd@redhat.com>
Signed-off-by: Thomas Huth <thuth@redhat.com>
2021-07-29 07:56:01 +02:00
.github Update documentation to refer to new location for issues 2021-06-21 05:43:11 +02:00
.gitlab/issue_templates GitLab: Add "Feature Request" issue template. 2021-06-25 10:08:37 +01:00
.gitlab-ci.d Doc, metadata, plugin and testing updates for 6.1-rc1: 2021-07-26 11:00:15 +01:00
accel accel/tcg: Remove unused variable in cpu_exec 2021-07-26 07:06:49 -10:00
audio modules: add audio module annotations 2021-07-09 18:20:27 +02:00
authz configure, meson: convert pam detection to meson 2021-06-25 10:54:10 +02:00
backends vhost: Add Error parameter to vhost_dev_init() 2021-06-30 13:15:44 +02:00
block block/nvme: Fix VFIO_MAP_DMA failed: No space left on device 2021-07-26 09:38:12 +01:00
bsd-user tcg/plugins: implement a qemu_plugin_user_exit helper 2021-07-23 17:22:16 +01:00
capstone@f8b1b83301 capstone: Update to upstream "next" branch 2020-10-03 04:23:14 -05:00
chardev chardev-spice: add missing module_obj directive 2021-07-22 14:44:47 +02:00
configs hw/tricore: fix inclusion of tricore_testboard 2021-07-20 20:10:21 +02:00
contrib plugins/cache: Fixed "function decl. is not a prototype" warnings 2021-07-23 17:22:16 +01:00
crypto crypto: add gnutls pbkdf provider 2021-07-14 14:15:52 +01:00
disas disas/libvixl: Protect C system header for C++ compiler 2021-05-25 16:01:43 +01:00
docs docs: Document GitLab custom CI/CD variables 2021-07-29 07:56:01 +02:00
dtc@85e5d83984 Makefile: dtc: update, build the libfdt target 2020-06-16 14:49:05 +01:00
dump Do not include cpu.h if it's not really necessary 2021-05-02 17:24:51 +02:00
ebpf ebpf: Added eBPF RSS loader. 2021-06-04 15:25:46 +08:00
fpu softfloat: Use _Generic instead of QEMU_GENERIC 2021-06-15 18:31:00 -07:00
fsdev meson: Declare have_virtfs_proxy_helper in main meson.build 2021-01-23 15:55:04 -05:00
gdb-xml target/riscv: Remove built-in GDB XML files for CSRs 2021-01-16 10:57:21 -08:00
hw target-arm queue: 2021-07-27 15:32:00 +01:00
include hw/nvme fixes 2021-07-27 13:24:56 +01:00
io io: use GDateTime for formatting timestamp for websock headers 2021-07-14 14:15:52 +01:00
libdecnumber qemu/: fix some comment spelling errors 2020-09-17 20:35:43 +02:00
linux-headers linux-headers: Update 2021-07-09 11:01:06 +10:00
linux-user linux-user/syscall: Remove unused variable from execve 2021-07-26 07:07:28 -10:00
meson@776acd2a80 submodules: bump meson to 0.55.3 2020-10-17 10:45:42 -04:00
migration migration: clear the memory region dirty bitmap when skipping free pages 2021-07-26 12:50:13 +01:00
monitor iothread: add aio-max-batch parameter 2021-07-21 13:47:50 +01:00
nbd nbd/server: Mark variable unused in nbd_negotiate_meta_queries 2021-07-26 07:06:25 -10:00
net net/checksum: Remove unused variable in net_checksum_add_iov 2021-07-26 07:06:58 -10:00
pc-bios pseries: Update SLOF firmware image 2021-07-13 10:04:30 +10:00
plugins plugins: Fix physical address calculation for IO regions 2021-07-23 17:22:16 +01:00
po configure: move gettext detection to meson.build 2021-01-02 21:03:09 +01:00
python python: Configure tox to skip missing interpreters 2021-07-13 15:44:16 -04:00
qapi qapi: introduce forwarding visitor 2021-07-23 18:17:17 +02:00
qga qga-win: Add support of Windows Server 2022 in get-osinfo command 2021-07-12 11:26:47 -05:00
qobject qobject: braces {} are necessary for all arms of this statement 2021-02-04 13:20:29 +01:00
qom qom: use correct field name when getting/setting alias properties 2021-07-23 18:17:17 +02:00
replay replay: notify CPU on event 2021-04-01 10:37:20 +02:00
roms pseries: Update SLOF firmware image 2021-07-13 10:04:30 +10:00
scripts QAPI patches patches for 2021-07-15 2021-07-16 10:56:03 +01:00
scsi docs: fix references to docs/devel/tracing.rst 2021-06-02 06:51:09 +02:00
semihosting Do not include cpu.h if it's not really necessary 2021-05-02 17:24:51 +02:00
slirp@8f43a99191 slirp: update to fix CVE-2020-29129 CVE-2020-29130 2020-11-27 20:57:11 +04:00
softmmu vl: Don't continue after -smp help. 2021-07-27 16:52:37 +02:00
storage-daemon qsd: Document FUSE exports 2021-03-29 18:28:33 +02:00
stubs meson: fix condition for io_uring stubs 2021-07-14 14:31:48 +01:00
subprojects/libvhost-user build-sys: add libvhost-user missing dependencies 2021-01-23 09:26:41 -05:00
target target/arm: Add sve-default-vector-length cpu property 2021-07-27 10:57:40 +01:00
tcg accel/tcg: Add CF_NO_GOTO_TB and CF_NO_GOTO_PTR 2021-07-21 07:47:04 -10:00
tests hw/nvme fixes 2021-07-27 13:24:56 +01:00
tools virtiofsd: Add missing newline in error message 2021-07-09 18:42:46 +02:00
trace trace: Fold mem-internal.h into mem.h 2021-07-21 07:45:38 -10:00
ui ui/gtk: add a keyboard fifo to the VTE consoles 2021-07-26 10:24:49 +02:00
util util/selfmap: Discard mapping on error 2021-07-26 07:06:49 -10:00
.cirrus.yml cirrus: delete FreeBSD and macOS jobs 2021-07-14 14:33:53 +01:00
.dir-locals.el Add .dir-locals.el file to configure emacs coding style 2015-10-08 19:46:01 +03:00
.editorconfig .editorconfig: update the automatic mode setting for Emacs 2021-03-10 15:34:11 +00:00
.exrc qemu: add .exrc 2012-09-07 09:02:44 +03:00
.gdbinit .gdbinit: load QEMU sub-commands when gdb starts 2017-06-07 14:38:45 +01:00
.gitattributes maint: Tell git that *.py files should use python diff hunks 2021-02-15 22:13:34 -05:00
.gitignore gitignore: Update with some filetypes 2021-07-23 17:22:15 +01:00
.gitlab-ci.yml docs: Document GitLab custom CI/CD variables 2021-07-29 07:56:01 +02:00
.gitmodules gitmodules: use GitLab repos instead of qemu.org 2021-02-09 20:53:56 +00:00
.gitpublish Add a git-publish configuration file 2018-03-05 09:03:17 +00:00
.mailmap .mailmap: fix up some broken commit authors 2021-07-23 17:22:16 +01:00
.patchew.yml scripts/checkpatch: roll diff tweaking into checkpatch itself 2021-06-25 10:08:33 +01:00
.readthedocs.yml readthedocs: build with Python 3.6 2020-10-05 16:30:45 +01:00
.travis.yml hw/usb/ccid: remove references to NSS 2021-07-14 14:33:53 +01:00
COPYING COPYING: update from FSF 2008-10-12 17:54:42 +00:00
COPYING.LIB COPYING.LIB: Synchronize the LGPL 2.1 with the version from gnu.org 2019-01-30 11:01:22 +01:00
Kconfig meson: Introduce target-specific Kconfig 2021-07-09 18:21:34 +02:00
Kconfig.host multi-process: Add config option for multi-process QEMU 2021-02-09 20:53:56 +00:00
LICENSE tcg/LICENSE: Remove out of date claim about TCG subdirectory licensing 2019-11-11 15:11:21 +01:00
MAINTAINERS docs: Update path that mentions deprecated.rst 2021-07-27 10:57:40 +01:00
Makefile Makefile: Remove /usr/bin/env wrapper from the SHELL variable 2021-07-05 19:20:46 +02:00
README.rst Update documentation to refer to new location for issues 2021-06-21 05:43:11 +02:00
VERSION Update version for v6.1.0-rc1 release 2021-07-27 18:07:52 +01:00
block.c block: Add option to use driver whitelist even in tools 2021-07-20 13:14:45 +02:00
blockdev-nbd.c block/nbd: Use qcrypto_tls_creds_check_endpoint() 2021-06-29 18:29:47 +01:00
blockdev.c block: Make blockdev-reopen stable API 2021-07-09 13:19:11 +02:00
blockjob.c progressmeter: protect with a mutex 2021-06-25 14:24:24 +03:00
configure docs: Update path that mentions deprecated.rst 2021-07-27 10:57:40 +01:00
cpu.c accel/tcg: Record singlestep_enabled in tb->cflags 2021-07-21 07:47:05 -10:00
cpus-common.c overall/alpha tcg cpus|hppa: Fix Lesser GPL version number 2020-11-15 16:43:54 +01:00
disas.c Do not include cpu.h if it's not really necessary 2021-05-02 17:24:51 +02:00
gdbstub.c gdbstub: tidy away reverse debugging check into function 2021-05-25 16:52:50 +01:00
gitdm.config contrib/gitdm: add a new interns group-map for GSoC/Outreachy work 2021-07-23 17:22:16 +01:00
hmp-commands-info.hx monitor/tcg: move tcg hmp commands to accel/tcg, register them dynamically 2021-07-09 18:21:33 +02:00
hmp-commands.hx netdev: add more commands to preconfig mode 2021-06-11 10:30:13 +08:00
iothread.c iothread: add aio-max-batch parameter 2021-07-21 13:47:50 +01:00
job-qmp.c progressmeter: protect with a mutex 2021-06-25 14:24:24 +03:00
job.c progressmeter: protect with a mutex 2021-06-25 14:24:24 +03:00
memory_ldst.c.inc exec/memory_ldst: Use correct type sizes 2021-05-26 08:35:51 -07:00
meson.build meson: fix dependencies for modinfo #2 2021-07-23 15:45:52 +02:00
meson_options.txt configure, meson: convert libxml2 detection to meson 2021-07-06 08:33:51 +02:00
module-common.c all: Clean up includes 2016-02-04 17:41:30 +00:00
os-posix.c remove qemu-options* from root directory 2021-05-26 14:49:46 +02:00
os-win32.c remove qemu-options* from root directory 2021-05-26 14:49:46 +02:00
page-vary-common.c exec: Build page-vary-common.c with -fno-lto 2021-03-23 19:36:47 -06:00
page-vary.c exec: Build page-vary-common.c with -fno-lto 2021-03-23 19:36:47 -06:00
qemu-bridge-helper.c qemu-bridge-helper: relocate path to default ACL 2020-09-30 19:11:36 +02:00
qemu-edid.c qemu-edid: use qemu_edid_size() 2021-05-10 11:41:02 +02:00
qemu-img-cmds.hx qemu-img: add support for rate limit in qemu-img convert 2020-10-27 15:26:20 +01:00
qemu-img.c qemu-img: Add --skip-broken-bitmaps for 'convert --bitmaps' 2021-07-21 14:14:41 -05:00
qemu-io-cmds.c block: Acquire AioContexts during bdrv_reopen_multiple() 2021-07-09 13:19:11 +02:00
qemu-io.c monitor: hmp_qemu_io: acquire aio contex, fix crash 2021-05-14 16:14:10 +02:00
qemu-keymap.c Include qemu-common.h exactly where needed 2019-06-12 13:20:20 +02:00
qemu-nbd.c qemu-nbd: Use qcrypto_tls_creds_check_endpoint() 2021-06-29 18:29:49 +01:00
qemu-options.hx qemu-options.hx: Fix formatting of -machine memory-backend option 2021-07-27 10:57:39 +01:00
qemu.nsi nsis: adjust for new MinGW paths 2021-01-23 15:55:05 -05:00
qemu.sasl sasl: remove comment about obsolete kerberos versions 2021-06-14 13:28:50 +01:00
replication.c replication: move include out of root directory 2021-05-26 14:49:46 +02:00
thunk.c overall usermode...: Fix Lesser GPL version number 2020-11-15 16:43:40 +01:00
trace-events cpu: Add breakpoint tracepoints 2021-07-09 21:31:11 -07:00
version.rc configure: remove CONFIG_FILEVERSION and CONFIG_PRODUCTVERSION 2021-01-02 21:03:37 +01:00

README.rst

===========
QEMU README
===========

QEMU is a generic and open source machine & userspace emulator and
virtualizer.

QEMU is capable of emulating a complete machine in software without any
need for hardware virtualization support. By using dynamic translation,
it achieves very good performance. QEMU can also integrate with the Xen
and KVM hypervisors to provide emulated hardware while allowing the
hypervisor to manage the CPU. With hypervisor support, QEMU can achieve
near native performance for CPUs. When QEMU emulates CPUs directly it is
capable of running operating systems made for one machine (e.g. an ARMv7
board) on a different machine (e.g. an x86_64 PC board).

QEMU is also capable of providing userspace API virtualization for Linux
and BSD kernel interfaces. This allows binaries compiled against one
architecture ABI (e.g. the Linux PPC64 ABI) to be run on a host using a
different architecture ABI (e.g. the Linux x86_64 ABI). This does not
involve any hardware emulation, simply CPU and syscall emulation.

QEMU aims to fit into a variety of use cases. It can be invoked directly
by users wishing to have full control over its behaviour and settings.
It also aims to facilitate integration into higher level management
layers, by providing a stable command line interface and monitor API.
It is commonly invoked indirectly via the libvirt library when using
open source applications such as oVirt, OpenStack and virt-manager.

QEMU as a whole is released under the GNU General Public License,
version 2. For full licensing details, consult the LICENSE file.


Documentation
=============

Documentation can be found hosted online at
`<https://www.qemu.org/documentation/>`_. The documentation for the
current development version that is available at
`<https://www.qemu.org/docs/master/>`_ is generated from the ``docs/``
folder in the source tree, and is built by `Sphinx
<https://www.sphinx-doc.org/en/master/>_`.


Building
========

QEMU is multi-platform software intended to be buildable on all modern
Linux platforms, OS-X, Win32 (via the Mingw64 toolchain) and a variety
of other UNIX targets. The simple steps to build QEMU are:


.. code-block:: shell

  mkdir build
  cd build
  ../configure
  make

Additional information can also be found online via the QEMU website:

* `<https://qemu.org/Hosts/Linux>`_
* `<https://qemu.org/Hosts/Mac>`_
* `<https://qemu.org/Hosts/W32>`_


Submitting patches
==================

The QEMU source code is maintained under the GIT version control system.

.. code-block:: shell

   git clone https://gitlab.com/qemu-project/qemu.git

When submitting patches, one common approach is to use 'git
format-patch' and/or 'git send-email' to format & send the mail to the
qemu-devel@nongnu.org mailing list. All patches submitted must contain
a 'Signed-off-by' line from the author. Patches should follow the
guidelines set out in the `style section
<https://www.qemu.org/docs/master/devel/style.html>` of
the Developers Guide.

Additional information on submitting patches can be found online via
the QEMU website

* `<https://qemu.org/Contribute/SubmitAPatch>`_
* `<https://qemu.org/Contribute/TrivialPatches>`_

The QEMU website is also maintained under source control.

.. code-block:: shell

  git clone https://gitlab.com/qemu-project/qemu-web.git

* `<https://www.qemu.org/2017/02/04/the-new-qemu-website-is-up/>`_

A 'git-publish' utility was created to make above process less
cumbersome, and is highly recommended for making regular contributions,
or even just for sending consecutive patch series revisions. It also
requires a working 'git send-email' setup, and by default doesn't
automate everything, so you may want to go through the above steps
manually for once.

For installation instructions, please go to

*  `<https://github.com/stefanha/git-publish>`_

The workflow with 'git-publish' is:

.. code-block:: shell

  $ git checkout master -b my-feature
  $ # work on new commits, add your 'Signed-off-by' lines to each
  $ git publish

Your patch series will be sent and tagged as my-feature-v1 if you need to refer
back to it in the future.

Sending v2:

.. code-block:: shell

  $ git checkout my-feature # same topic branch
  $ # making changes to the commits (using 'git rebase', for example)
  $ git publish

Your patch series will be sent with 'v2' tag in the subject and the git tip
will be tagged as my-feature-v2.

Bug reporting
=============

The QEMU project uses GitLab issues to track bugs. Bugs
found when running code built from QEMU git or upstream released sources
should be reported via:

* `<https://gitlab.com/qemu-project/qemu/-/issues>`_

If using QEMU via an operating system vendor pre-built binary package, it
is preferable to report bugs to the vendor's own bug tracker first. If
the bug is also known to affect latest upstream code, it can also be
reported via GitLab.

For additional information on bug reporting consult:

* `<https://qemu.org/Contribute/ReportABug>`_


ChangeLog
=========

For version history and release notes, please visit
`<https://wiki.qemu.org/ChangeLog/>`_ or look at the git history for
more detailed information.


Contact
=======

The QEMU community can be contacted in a number of ways, with the two
main methods being email and IRC

* `<mailto:qemu-devel@nongnu.org>`_
* `<https://lists.nongnu.org/mailman/listinfo/qemu-devel>`_
* #qemu on irc.oftc.net

Information on additional methods of contacting the community can be
found online via the QEMU website:

* `<https://qemu.org/Contribute/StartHere>`_