Go to file
Vladimir Sementsov-Ogievskiy 1dc4718d84 block/nbd: use non-blocking connect: fix vm hang on connect()
This makes nbd's connection_co yield during reconnects, so that
reconnect doesn't block the main thread. This is very important in
case of an unavailable nbd server host: connect() call may take a long
time, blocking the main thread (and due to reconnect, it will hang
again and again with small gaps of working time during pauses between
connection attempts).

Realization notes:

 - We don't want to implement non-blocking connect() over non-blocking
 socket, because getaddrinfo() doesn't have portable non-blocking
 realization anyway, so let's just use a thread for both getaddrinfo()
 and connect().

 - We can't use qio_channel_socket_connect_async (which behaves
 similarly and starts a thread to execute connect() call), as it's relying
 on someone iterating main loop (g_main_loop_run() or something like
 this), which is not always the case.

 - We can't use thread_pool_submit_co API, as thread pool waits for all
 threads to finish (but we don't want to wait for blocking reconnect
 attempt on shutdown.

 So, we just create the thread by hand. Some additional difficulties
 are:

 - We want our connect to avoid blocking drained sections and aio context
 switches. To achieve this, we make it possible to "cancel" synchronous
 wait for the connect (which is a coroutine yield actually), still,
 the thread continues in background, and if successful, its result may be
 reused on next reconnect attempt.

 - We don't want to wait for reconnect on shutdown, so there is
 CONNECT_THREAD_RUNNING_DETACHED thread state, which means that the block
 layer is no longer interested in a result, and thread should close new
 connected socket on finish and free the state.

How to reproduce the bug, fixed with this commit:

1. Create an image on node1:
   qemu-img create -f qcow2 xx 100M

2. Start NBD server on node1:
   qemu-nbd xx

3. Start vm with second nbd disk on node2, like this:

  ./x86_64-softmmu/qemu-system-x86_64 -nodefaults -drive \
    file=/work/images/cent7.qcow2 -drive file=nbd+tcp://192.168.100.2 \
    -vnc :0 -qmp stdio -m 2G -enable-kvm -vga std

4. Access the vm through vnc (or some other way?), and check that NBD
   drive works:

   dd if=/dev/sdb of=/dev/null bs=1M count=10

   - the command should succeed.

5. Now, let's trigger nbd-reconnect loop in Qemu process. For this:

5.1 Kill NBD server on node1

5.2 run "dd if=/dev/sdb of=/dev/null bs=1M count=10" in the guest
    again. The command should fail and a lot of error messages about
    failing disk may appear as well.

    Now NBD client driver in Qemu tries to reconnect.
    Still, VM works well.

6. Make node1 unavailable on NBD port, so connect() from node2 will
   last for a long time:

   On node1 (Note, that 10809 is just a default NBD port):

   sudo iptables -A INPUT -p tcp --dport 10809 -j DROP

   After some time the guest hangs, and you may check in gdb that Qemu
   hangs in connect() call, issued from the main thread. This is the
   BUG.

7. Don't forget to drop iptables rule from your node1:

   sudo iptables -D INPUT -p tcp --dport 10809 -j DROP

Signed-off-by: Vladimir Sementsov-Ogievskiy <vsementsov@virtuozzo.com>
Message-Id: <20200812145237.4396-1-vsementsov@virtuozzo.com>
Reviewed-by: Eric Blake <eblake@redhat.com>
[eblake: minor wording and formatting tweaks]
Signed-off-by: Eric Blake <eblake@redhat.com>
2020-09-02 16:47:23 -05:00
.github .github: Enable repo-lockdown bot to refuse GitHub pull requests 2020-04-07 16:19:18 +01:00
.gitlab-ci.d gitlab-ci/opensbi: Update GitLab CI to build generic platform 2020-08-21 22:37:55 -07:00
accel meson: accel 2020-08-21 06:30:36 -04:00
audio meson: convert audio directory to Meson 2020-08-21 06:30:21 -04:00
authz meson: convert authz directory to Meson 2020-08-21 06:30:15 -04:00
backends meson: convert backends directory to Meson 2020-08-21 06:30:23 -04:00
block block/nbd: use non-blocking connect: fix vm hang on connect() 2020-09-02 16:47:23 -05:00
bsd-user meson: bsd-user 2020-08-21 06:30:38 -04:00
capstone@22ead3e0bf disas: Add capstone as submodule 2017-10-26 11:56:20 +02:00
chardev meson: add pixman dependency to chardev/baum module 2020-09-01 08:51:34 -04:00
contrib meson: use meson datadir instead of qemu_datadir 2020-09-01 08:51:33 -04:00
crypto tls-cipher-suites: Correct instance_size 2020-09-02 07:29:25 -04:00
default-configs hw/avr: Add limited support for some Arduino boards 2020-07-11 11:02:05 +02:00
disas meson: convert disas directory to Meson 2020-08-21 06:30:24 -04:00
docs meson fixes: 2020-09-01 22:50:23 +01:00
dtc@85e5d83984 Makefile: dtc: update, build the libfdt target 2020-06-16 14:49:05 +01:00
dump meson: convert dump/ 2020-08-21 06:30:22 -04:00
fpu softfloat: Define misc operations for bfloat16 2020-08-28 10:48:07 -07:00
fsdev meson: convert fsdev/ 2020-08-21 06:30:24 -04:00
gdb-xml target/avr: CPU class: Add GDB support 2020-07-10 17:58:32 +02:00
hw virtio: add Virtio*BusClass sizes 2020-09-02 07:29:26 -04:00
include x86 and machine queue, 2020-09-02 2020-09-02 15:26:38 +01:00
io meson: convert io directory to Meson 2020-08-21 06:30:16 -04:00
libdecnumber meson: target 2020-08-21 06:30:35 -04:00
linux-headers linux-headers: update again to 5.8 2020-07-10 19:26:55 -04:00
linux-user Convert microblaze to generic translator loop 2020-09-02 13:56:56 +01:00
meson@68ed748f84 meson: bump submodule to 0.55.1 2020-09-01 01:51:51 -04:00
migration migration: tls: fix memory leak in migration_tls_get_creds 2020-08-28 13:34:52 +01:00
monitor migration: Add block-bitmap-mapping parameter 2020-08-21 08:56:09 -05:00
nbd meson: convert block 2020-08-21 06:30:18 -04:00
net meson: convert net directory to Meson 2020-08-21 06:30:23 -04:00
pc-bios build: fix recurse-all target 2020-09-01 08:51:35 -04:00
plugins meson: link emulators without Makefile.target 2020-08-21 06:30:40 -04:00
po meson: convert po/ 2020-08-21 06:30:45 -04:00
python/qemu python/qemu: Change ConsoleSocket to optionally drain socket. 2020-07-27 09:41:56 +01:00
qapi qcow2: Add the 'extended_l2' option and the QCOW2_INCOMPAT_EXTL2 bit 2020-08-25 09:19:55 +02:00
qga meson: install $localstatedir/run for qga 2020-09-01 01:51:52 -04:00
qobject libqemuutil, qapi, trace: convert to meson 2020-08-21 06:30:08 -04:00
qom meson: convert common QMP bits for qemu and qemu-storage-daemon 2020-08-21 06:30:22 -04:00
replay meson: convert replay directory to Meson 2020-08-21 06:30:23 -04:00
roms artist out of bounds fixes 2020-08-26 22:23:53 +01:00
scripts meson: add NSIS building 2020-09-01 08:51:34 -04:00
scsi scsi: Remove superfluous breaks 2020-09-01 08:35:10 +02:00
slirp@ce94eba204 slirp: update to latest stable-4.2 branch 2020-07-28 18:27:59 +04:00
softmmu meson: move SDL and SDL-image detection to meson 2020-08-21 06:30:44 -04:00
storage-daemon meson: convert qemu-storage-daemon 2020-08-21 06:30:23 -04:00
stubs stubs/cmos: Use correct include 2020-09-01 09:10:58 +02:00
target x86 and machine queue, 2020-09-02 2020-09-02 15:26:38 +01:00
tcg ppc patch queue 2020-08-18 2020-08-24 09:35:21 +01:00
tests iotests/259: Fix reference output 2020-09-02 16:32:14 -05:00
tools meson: use meson datadir instead of qemu_datadir 2020-09-01 08:51:33 -04:00
trace meson: use meson datadir instead of qemu_datadir 2020-09-01 08:51:33 -04:00
ui meson fixes: 2020-09-01 22:50:23 +01:00
util util/vfio-helpers: Unify trace-events size format 2020-09-01 11:35:43 +02:00
.cirrus.yml .cirrus.yml: add bash to the brew packages 2020-07-11 15:53:29 +01:00
.dir-locals.el
.editorconfig meson: rename included C source files to .c.inc 2020-08-21 06:18:30 -04:00
.exrc
.gdbinit .gdbinit: load QEMU sub-commands when gdb starts 2017-06-07 14:38:45 +01:00
.gitignore rules.mak: drop unneeded macros 2020-08-21 06:30:42 -04:00
.gitlab-ci.yml meson: link emulators without Makefile.target 2020-08-21 06:30:40 -04:00
.gitmodules build-sys: add meson submodule 2020-08-21 06:30:06 -04:00
.gitpublish Add a git-publish configuration file 2018-03-05 09:03:17 +00:00
.mailmap mailmap: Add entry for Greg Kurz 2020-09-01 11:13:02 +02:00
.patchew.yml ci: store Patchew configuration in the tree 2019-06-03 14:03:02 +02:00
.readthedocs.yml .readthedocs.yml: specify some minimum python requirements 2020-02-07 15:15:16 +01:00
.shippable.yml shippable: add one more qemu to registry url 2020-07-27 09:39:57 +01:00
.travis.yml .travis.yml: skip ppc64abi32-linux-user with plugins 2020-07-15 11:57:17 +01:00
block.c meson: replace create-config with meson configure_file 2020-08-21 06:30:43 -04:00
blockdev-nbd.c blockdev-nbd: Boxed argument type for nbd-server-add 2020-03-06 17:21:28 +01:00
blockdev.c block: Add support to warn on backing file change without format 2020-07-14 15:18:59 +02:00
blockjob.c block: Add BdrvChildRole to BdrvChild 2020-05-18 19:05:25 +02:00
bootdevice.c error: Eliminate error_propagate() manually 2020-07-10 15:18:08 +02:00
Changelog Use HTTPS for qemu.org and other domains 2017-11-21 13:34:13 +00:00
CODING_STYLE.rst docs: split the CODING_STYLE doc into distinct groups 2019-09-05 14:41:00 +01:00
configure configure: do not include ${prefix} in firmwarepath 2020-09-01 08:51:34 -04: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
cpus-common.c cpus: Move CPU code from exec.c to cpus-common.c 2020-07-10 18:02:24 -04:00
device_tree.c device_tree: Constify compat in qemu_fdt_node_path() 2020-04-30 15:35:41 +01:00
disas.c disas: Let disas::read_memory() handler return EIO on error 2020-06-10 12:10:23 -04:00
dma-helpers.c trace: switch position of headers to what Meson requires 2020-08-21 06:18:24 -04:00
exec-vary.c exec: Cache TARGET_PAGE_MASK for TARGET_PAGE_BITS_VARY 2019-10-28 10:35:20 +01:00
exec.c meson: rename included C source files to .c.inc 2020-08-21 06:18:30 -04:00
gdbstub.c trace: switch position of headers to what Meson requires 2020-08-21 06:18:24 -04:00
gitdm.config contrib: gitdm: add a mapping for Janus Technologies 2019-03-12 19:31:29 +00:00
hmp-commands-info.hx memory: Make 'info mtree' not display disabled regions by default 2020-06-10 12:10:49 -04:00
hmp-commands.hx hmp: Make json format optional for qom-set 2020-06-17 17:48:39 +01:00
iothread.c qom: Change object_get_canonical_path_component() not to malloc 2020-07-21 16:23:43 +02:00
job-qmp.c trace: switch position of headers to what Meson requires 2020-08-21 06:18:24 -04:00
job.c trace: switch position of headers to what Meson requires 2020-08-21 06:18:24 -04:00
Kconfig Makefile: simplify MINIKCONF rules 2020-07-10 18:02:21 -04:00
Kconfig.host accel/Kconfig: Extract accel selectors into their own config 2020-07-10 18:02:21 -04:00
LICENSE tcg/LICENSE: Remove out of date claim about TCG subdirectory licensing 2019-11-11 15:11:21 +01:00
MAINTAINERS docs/system/target-avr: Improve the AVR docs and add to MAINTAINERS 2020-09-01 11:15:00 +02:00
Makefile Makefile: Fix in-tree clean/distclean 2020-09-01 12:11:00 -04:00
Makefile.objs rules.mak: remove version.o 2020-08-21 06:30:41 -04:00
memory_ldst.c.inc meson: rename included C source files to .c.inc 2020-08-21 06:18:30 -04:00
meson_options.txt meson: add description to options 2020-09-01 08:51:44 -04:00
meson.build meson: use pkg-config method to find dependencies 2020-09-01 08:51:35 -04:00
module-common.c all: Clean up includes 2016-02-04 17:41:30 +00:00
os-posix.c meson: link emulators without Makefile.target 2020-08-21 06:30:40 -04:00
os-win32.c qemu/osdep: Document os_find_datadir() return value 2020-07-21 16:13:04 +02:00
qdev-monitor.c qdev: Fix device_add DRIVER,help to print to monitor 2020-07-21 17:22:44 +02:00
qemu-bridge-helper.c build: rename CONFIG_LIBCAP to CONFIG_LIBCAP_NG 2019-12-17 19:35:47 +01:00
qemu-edid.c Include qemu-common.h exactly where needed 2019-06-12 13:20:20 +02:00
qemu-img-cmds.hx block/amend: add 'force' option 2020-07-06 08:49:28 +02:00
qemu-img.c qemu-img resize: Require --shrink for shrinking all image formats 2020-07-17 14:20:57 +02:00
qemu-io-cmds.c block: nbd: Fix convert qcow2 compressed to nbd 2020-07-28 09:54:19 -05:00
qemu-io.c qemu-io: adds option to use aio engine 2020-01-30 20:59:42 +00:00
qemu-keymap.c Include qemu-common.h exactly where needed 2019-06-12 13:20:20 +02:00
qemu-nbd.c error: Use error_reportf_err() where appropriate 2020-05-27 07:45:30 +02:00
qemu-options-wrapper.h qemu-img: remove references to GEN_DOCS 2018-05-20 08:35:54 +03:00
qemu-options.h Clean up ill-advised or unusual header guards 2016-07-12 16:20:46 +02:00
qemu-options.hx qemu-options.hx: Fix typo for netdev documentation 2020-09-01 09:17:58 +02:00
qemu-seccomp.c seccomp: report more useful errors from seccomp 2019-03-27 13:11:38 +01:00
qemu.nsi qemu.nsi: Install Sphinx documentation 2020-03-09 16:45:00 +00:00
qemu.sasl Default to GSSAPI (Kerberos) instead of DIGEST-MD5 for SASL 2017-05-09 14:41:47 +01:00
README.rst docs: merge HACKING.rst contents into CODING_STYLE.rst 2019-09-05 14:27:06 +01:00
replication.c replication: Introduce new APIs to do replication operation 2016-09-13 11:00:56 +01:00
replication.h Include qemu/module.h where needed, drop it from qemu-common.h 2019-06-12 13:18:33 +02:00
rules.mak rules.mak: drop unneeded macros 2020-08-21 06:30:42 -04:00
thunk.c linux-user: Add strace support for printing arguments for ioctls used for terminals and serial lines 2020-08-27 12:29:50 +02:00
tpm.c tpm: Improve help on TPM types when none are available 2020-07-24 12:44:13 -04:00
trace-events trace: add mmu_index to mem_info 2019-10-28 15:12:38 +00:00
VERSION Open 5.2 development tree 2020-08-18 13:44:04 +01:00
version.rc Use HTTPS for qemu.org and other domains 2017-11-21 13:34:13 +00:00
version.texi.in meson: build texi doc 2020-08-21 06:30:42 -04: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.


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://git.qemu.org/git/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 CODING_STYLE.rst file.

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://git.qemu.org/git/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 Launchpad as its primary upstream bug tracker. Bugs
found when running code built from QEMU git or upstream released sources
should be reported via:

* `<https://bugs.launchpad.net/qemu/>`_

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 launchpad.

For additional information on bug reporting consult:

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


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>`_