Go to file
Peter Xu 6621883f93 migration: Fix potential race on postcopy_qemufile_src
postcopy_qemufile_src object should be owned by one thread, either the main
thread (e.g. when at the beginning, or at the end of migration), or by the
return path thread (when during a preempt enabled postcopy migration).  If
that's not the case the access to the object might be racy.

postcopy_preempt_shutdown_file() can be potentially racy, because it's
called at the end phase of migration on the main thread, however during
which the return path thread hasn't yet been recycled; the recycle happens
in await_return_path_close_on_source() which is after this point.

It means, logically it's posslbe the main thread and the return path thread
are both operating on the same qemufile.  While I don't think qemufile is
thread safe at all.

postcopy_preempt_shutdown_file() used to be needed because that's where we
send EOS to dest so that dest can safely shutdown the preempt thread.

To avoid the possible race, remove this only place that a race can happen.
Instead we figure out another way to safely close the preempt thread on
dest.

The core idea during postcopy on deciding "when to stop" is that dest will
send a postcopy SHUT message to src, telling src that all data is there.
Hence to shut the dest preempt thread maybe better to do it directly on
dest node.

This patch proposed such a way that we change postcopy_prio_thread_created
into PreemptThreadStatus, so that we kick the preempt thread on dest qemu
by a sequence of:

  mis->preempt_thread_status = PREEMPT_THREAD_QUIT;
  qemu_file_shutdown(mis->postcopy_qemufile_dst);

While here shutdown() is probably so far the easiest way to kick preempt
thread from a blocked qemu_get_be64().  Then it reads preempt_thread_status
to make sure it's not a network failure but a willingness to quit the
thread.

We could have avoided that extra status but just rely on migration status.
The problem is postcopy_ram_incoming_cleanup() is just called early enough
so we're still during POSTCOPY_ACTIVE no matter what.. So just make it
simple to have the status introduced.

One flag x-preempt-pre-7-2 is added to keep old pre-7.2 behaviors of
postcopy preempt.

Fixes: 9358982744 ("migration: Send requested page directly in rp-return thread")
Signed-off-by: Peter Xu <peterx@redhat.com>
Reviewed-by: Juan Quintela <quintela@redhat.com>
Signed-off-by: Juan Quintela <quintela@redhat.com>
2023-04-12 21:44:38 +02:00
.github/workflows github: fix config mistake preventing repo lockdown commenting 2022-04-26 16:12:26 +01:00
.gitlab/issue_templates .gitlab/issue_templates: Move suggestions into comments 2022-12-15 15:19:24 +01:00
.gitlab-ci.d gitlab: fix typo 2023-04-04 15:56:44 +01:00
accel Fix race condition that can cause a crash at startup. 2023-04-04 19:50:22 +01:00
audio audio/dbus: there are no sender for p2p mode 2023-03-13 22:57:39 +04:00
authz error: Drop superfluous #include "qapi/qmp/qerror.h" 2023-02-23 13:56:14 +01:00
backends win32: replace closesocket() with close() wrapper 2023-03-13 15:39:31 +04:00
block block, block-backend: write some hot coroutine wrappers by hand 2023-04-11 16:46:49 +02:00
bsd-user include/exec: Change reserved_va semantics to last byte 2023-03-28 15:23:10 -07:00
chardev replace TABs with spaces 2023-03-20 12:43:50 +01:00
common-user common-user/host/ppc: Implement safe-syscall.inc.S 2023-01-23 14:39:48 -10:00
configs target/arm: Implement gdbstub pauth extension 2023-03-06 14:08:11 +00:00
contrib contrib/gitdm: add group map for AMD 2023-03-22 15:08:26 +00:00
crypto win32: replace closesocket() with close() wrapper 2023-03-13 15:39:31 +04:00
disas Fix incorrect register name in disassembler for fmv,fabs,fneg instructions 2023-03-14 16:36:43 +10:00
docs Revert "docs/about/deprecated: Deprecate 32-bit arm hosts for system emulation" 2023-03-24 12:10:49 +01:00
dtc@b6910bec11 dtc: Update to version 1.6.1 2021-10-14 08:08:11 +02:00
dump *: Add missing includes of qemu/error-report.h 2023-03-22 15:06:57 +00:00
ebpf ebpf: fix compatibility with libbpf 1.0+ 2023-03-10 17:26:47 +08:00
fpu softfloat: logB(0) should raise divideByZero exception 2022-10-17 10:28:35 +08:00
fsdev Don't include headers already included by qemu/osdep.h 2023-02-08 07:28:05 +01:00
gdb-xml target/arm: Implement gdbstub pauth extension 2023-03-06 14:08:11 +00:00
gdbstub gdbstub: don't report auxv feature unless on Linux 2023-04-04 15:56:44 +01:00
hw migration: Fix potential race on postcopy_qemufile_src 2023-04-12 21:44:38 +02:00
include block, block-backend: write some hot coroutine wrappers by hand 2023-04-11 16:46:49 +02:00
io io: tls: Inherit QIO_CHANNEL_FEATURE_SHUTDOWN on server side 2023-04-12 21:19:05 +02:00
libdecnumber libdecnumber/dpd/decimal64: Fix compiler warning from Clang 15 2022-11-11 09:13:52 +01:00
linux-headers linux-headers: Update to v6.2-rc8 2023-02-16 12:13:46 -07:00
linux-user Revert "linux-user/arm: Take more care allocating commpage" 2023-04-04 07:48:27 -07:00
meson@3a9b285a55 meson: require 0.61.3 2022-10-01 21:16:36 +02:00
migration migration: Fix potential race on postcopy_qemufile_src 2023-04-12 21:44:38 +02:00
monitor monitor: restrict command getfd to POSIX hosts 2023-03-13 15:46:09 +04:00
nbd nbd/server: Request TCP_NODELAY 2023-04-04 08:13:15 -05:00
net win32: replace closesocket() with close() wrapper 2023-03-13 15:39:31 +04:00
pc-bios update edk2 to 202302 stable tag 2023-03-20 13:43:35 +00:00
plugins include/qemu/plugin: Inline qemu_plugin_disable_mem_helpers 2023-03-22 15:06:57 +00:00
po po: add ukrainian translation 2022-07-05 10:15:49 +02:00
python python: drop pipenv 2023-02-22 23:35:03 -05:00
qapi Add qemu qcode support for keys F13 to F24 2023-03-14 13:41:21 +00:00
qga qga-pull-2023-03-22 2023-03-24 16:08:07 +00:00
qobject include/qapi: add g_autoptr support for qobject types 2022-04-06 10:50:38 +02:00
qom qom/object_interfaces: Fix QAPI headers included 2023-02-27 22:29:01 +01:00
replay replay: Simplify setting replay blockers 2023-02-23 14:10:17 +01:00
roms edk2: replace build scripts 2023-03-20 10:36:31 +01:00
scripts scripts/coverage: initial coverage comparison script 2023-04-04 15:16:29 +01:00
scsi io: Add support for MSG_PEEK for socket channel 2023-02-06 19:22:56 +01:00
semihosting gdbstub: Adjust gdb_do_syscall to only use uint32_t and uint64_t 2023-03-07 20:44:09 +00:00
softmmu Revert "memory: Optimize replay of guest mapping" 2023-04-05 13:31:52 +01:00
stats cryptodev: Support query-stats QMP command 2023-03-07 12:38:59 -05:00
storage-daemon monitor: Loosen coupling between misc.c and monitor.c slightly 2023-02-04 07:56:54 +01:00
stubs stubs: split semihosting_get_target from system only stubs 2023-03-07 20:44:09 +00:00
subprojects libvhost-user: check for NULL when allocating a virtqueue element 2023-03-02 19:13:51 -05:00
target target/arm: Copy guarded bit in combine_cacheattrs 2023-04-10 14:31:40 +01:00
tcg tcg/ppc: Fix TCG_TARGET_CALL_{ARG,RET}_I128 for ppc32 2023-04-10 08:29:24 -07:00
tests iotests: Regression test for vhdx log corruption 2023-04-11 13:54:43 +02:00
tools ebpf: fix compatibility with libbpf 1.0+ 2023-03-10 17:26:47 +08:00
trace trace: Do not try to include QMP commands in user emulation binaries 2023-02-27 22:29:01 +01:00
ui ui/spice: fix compilation on win32 2023-03-24 11:55:55 +01:00
util Fix use-after-free in util/error.c 2023-04-10 11:47:40 +01:00
.dir-locals.el
.editorconfig .editorconfig: update the automatic mode setting for Emacs 2021-03-10 15:34:11 +00:00
.exrc
.gdbinit .gdbinit: load QEMU sub-commands when gdb starts 2017-06-07 14:38:45 +01:00
.git-blame-ignore-revs metadata: add .git-blame-ignore-revs 2023-04-04 15:56:44 +01:00
.gitattributes gitattributes: Cover Objective-C source files 2022-03-29 00:15:14 +02:00
.gitignore .gitignore: add multiple items to .gitignore 2022-10-22 22:48:17 +02:00
.gitlab-ci.yml docs: Document GitLab custom CI/CD variables 2021-07-29 07:56:01 +02:00
.gitmodules hw/misc/sga: Remove the deprecated "sga" device 2023-02-14 09:02:42 +01:00
.gitpublish Add a git-publish configuration file 2018-03-05 09:03:17 +00:00
.mailmap MAINTAINERS: update my email address for the clock framework 2023-03-14 14:46:33 +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 travis.yml: Remove the generic addons section 2023-01-26 13:25:07 +01:00
block.c block, block-backend: write some hot coroutine wrappers by hand 2023-04-11 16:46:49 +02:00
blockdev-nbd.c qapi block: Elide redundant has_FOO in generated C 2022-12-14 20:03:25 +01:00
blockdev.c block: Convert bdrv_is_inserted() to co_wrapper 2023-02-01 16:52:32 +01:00
blockjob.c include/block: Untangle inclusion loops 2023-01-20 07:24:28 +01:00
configure util: import GTree as QTree 2023-03-28 15:23:10 -07:00
COPYING
COPYING.LIB COPYING.LIB: Synchronize the LGPL 2.1 with the version from gnu.org 2019-01-30 11:01:22 +01:00
cpu.c *: Add missing includes of qemu/plugin.h 2023-03-22 15:06:57 +00:00
cpus-common.c cpu: Move breakpoint helpers to common code 2023-02-27 22:28:54 +01:00
disas.c target/loongarch: Enable the disassembler for host tcg 2023-01-23 15:36:36 -10:00
event-loop-base.c util/event-loop-base: Introduce options to set the thread pool size 2022-05-09 10:43:23 +01:00
gitdm.config contrib/gitdm: add group map for AMD 2023-03-22 15:08:26 +00:00
hmp-commands-info.hx hmp: add cryptodev info command 2023-03-07 12:38:59 -05:00
hmp-commands.hx monitor: restrict command getfd to POSIX hosts 2023-03-13 15:46:09 +04:00
iothread.c iothread: Remove unused IOThreadClass / IOTHREAD_CLASS 2023-02-27 13:27:05 +00:00
job-qmp.c qapi job: Elide redundant has_FOO in generated C 2022-12-14 20:04:47 +01:00
job.c block: remove bdrv_try_set_aio_context and replace it with bdrv_try_change_aio_context 2022-10-27 20:14:11 +02:00
Kconfig meson: Introduce target-specific Kconfig 2021-07-09 18:21:34 +02:00
Kconfig.host vfio-user: build library 2022-06-15 16:42:33 +01:00
LICENSE tcg/LICENSE: Remove out of date claim about TCG subdirectory licensing 2019-11-11 15:11:21 +01:00
MAINTAINERS Final test and misc fixes: 2023-04-04 17:02:01 +01:00
Makefile Makefile: qemu-bundle is a directory 2023-03-01 13:08:20 +01:00
memory_ldst.c.inc exec/memory_ldst: Use correct type sizes 2021-05-26 08:35:51 -07:00
meson_options.txt meson: stop looking for 'sphinx-build-3' 2023-02-27 11:01:30 +01:00
meson.build util: import GTree as QTree 2023-03-28 15:23:10 -07:00
module-common.c
os-posix.c Refactoring: refactor TFR() macro to RETRY_ON_EINTR() 2023-01-09 13:50:47 +01:00
os-win32.c Remove qemu-common.h include from most units 2022-04-06 14:31:55 +02:00
page-vary-common.c Remove qemu-common.h include from most units 2022-04-06 14:31:55 +02:00
page-vary.c include: move target page bits declaration to page-vary.h 2022-04-06 14:31:43 +02: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: Restrict input parameter -d to avoid division by zero 2022-10-12 13:38:15 +02:00
qemu-img-cmds.hx qemu-img: Unify [-b [-F]] documentation 2022-02-01 13:49:15 +01:00
qemu-img.c block: Mark bdrv_co_copy_range() GRAPH_RDLOCK 2023-02-23 19:49:20 +01:00
qemu-io-cmds.c qemu-io: add -r option to register I/O buffer 2023-02-09 10:22:30 -05:00
qemu-io.c include: move qemu_*_exec_dir() to cutils 2022-05-28 11:42:56 +02:00
qemu-keymap.c qemu-keymap: Silence memory leak warning from Clang's sanitizer 2023-02-27 09:15:39 +01:00
qemu-nbd.c qapi block: Elide redundant has_FOO in generated C 2022-12-14 20:03:25 +01:00
qemu-options.hx qemu-options.hx: remove stray quote 2023-03-13 18:36:38 +01:00
qemu.nsi nsis installer: Fix mouse-over descriptions for emulators 2022-03-18 10:55:15 +00:00
qemu.sasl sasl: remove comment about obsolete kerberos versions 2021-06-14 13:28:50 +01:00
README.rst README.rst: fix link formatting 2022-08-04 13:44:21 +02:00
replication.c replication: move include out of root directory 2021-05-26 14:49:46 +02:00
trace-events accel/tcg: Remove trace events from trace-root.h 2022-12-20 17:11:12 -08:00
VERSION Update version for v8.0.0-rc3 release 2023-04-05 17:26:14 +01:00
version.rc configure: remove CONFIG_FILEVERSION and CONFIG_PRODUCTVERSION 2021-01-02 21:03:37 +01:00

===========
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://wiki.qemu.org/Hosts/Linux>`_
* `<https://wiki.qemu.org/Hosts/Mac>`_
* `<https://wiki.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://wiki.qemu.org/Contribute/SubmitAPatch>`_
* `<https://wiki.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://wiki.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://wiki.qemu.org/Contribute/StartHere>`_