QEMU With E2K User Support
Go to file
Peter Xu c73a843b4a monitor: flush qmp responses when CLOSED
Previously we clean up the queues when we got CLOSED event.  It was used
to make sure we won't send leftover replies/events of a old client to a
new client which makes perfect sense. However this will also drop the
replies/events even if the output port of the previous chardev backend
is still open, which can lead to missing of the last replies/events.
Now this patch does an extra operation to flush the response queue
before cleaning up.

In most cases, a QMP session will be based on a bidirectional channel (a
TCP port, for example, we read/write to the same socket handle), so in
port and out port of the backend chardev are fundamentally the same
port. In these cases, it does not really matter much on whether we'll
flush the response queue since flushing will fail anyway.  However there
can be cases where in & out ports of the QMP monitor's backend chardev
are separated.  Here is an example:

  cat $QMP_COMMANDS | qemu -qmp stdio ... | filter_commands

In this case, the backend is fd-typed, and it is connected to stdio
where in port is stdin and out port is stdout.  Now if we drop all the
events on the response queue then filter_command process might miss some
events that it might expect.  The thing is that, when stdin closes,
stdout might still be there alive!

In practice, I encountered SHUTDOWN event missing when running test with
iotest 087 with Out-Of-Band enabled.  Here is one of the ways that this
can happen (after "quit" command is executed and QEMU quits the main
loop):

1. [main thread] QEMU queues a SHUTDOWN event into response queue.

2. "cat" terminates (to distinguish it from the animal, I quote it).

3. [monitor iothread] QEMU's monitor iothread reads EOF from stdin.

4. [monitor iothread] QEMU's monitor iothread calls the CLOSED event
   hook for the monitor, which will destroy the response queue of the
   monitor, then the SHUTDOWN event is dropped.

5. [main thread] QEMU's main thread cleans up the monitors in
   monitor_cleanup().  When trying to flush pending responses, it sees
   nothing.  SHUTDOWN is lost forever.

Note that before the monitor iothread was introduced, step [4]/[5] could
never happen since the main loop was the only place to detect the EOF
event of stdin and run the CLOSED event hooks.  Now things can happen in
parallel in the iothread.

Without this patch, iotest 087 will have ~10% chance to miss the
SHUTDOWN event and fail when with Out-Of-Band enabled:

  --- /home/peterx/git/qemu/tests/qemu-iotests/087.out
  +++ /home/peterx/git/qemu/bin/tests/qemu-iotests/087.out.bad
  @@ -8,7 +8,6 @@
  {"return": {}}
  {"error": {"class": "GenericError", "desc": "'node-name' must be
  specified for the root node"}}
  {"return": {}}
  -{"timestamp": {"seconds": TIMESTAMP, "microseconds": TIMESTAMP}, "event": "SHUTDOWN", "data": {"guest": false}}

  === Duplicate ID ===
  @@ -53,7 +52,6 @@
  {"return": {}}
  {"return": {}}
  {"return": {}}

  -{"timestamp": {"seconds": TIMESTAMP, "microseconds": TIMESTAMP}, "event": "SHUTDOWN", "data": {"guest": false}}

This patch fixes the problem.

Fixes: 6d2d563f8c ("qmp: cleanup qmp queues properly", 2018-03-27)
Suggested-by: Markus Armbruster <armbru@redhat.com>
Signed-off-by: Peter Xu <peterx@redhat.com>
Message-Id: <20180620073223.31964-4-peterx@redhat.com>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
[Commit message and a comment touched up]
Signed-off-by: Markus Armbruster <armbru@redhat.com>
2018-06-30 17:50:48 +02:00
accel * "info mtree" improvements (Alexey) 2018-06-29 12:30:29 +01:00
audio audio: Convert use of atoi to qemu_strtoi 2018-06-25 14:03:30 +02:00
backends hostmem: drop error variable from host_memory_backend_get_memory() 2018-06-28 19:05:33 +02:00
block block: Remove unused sector-based vectored I/O 2018-06-29 14:20:56 +02:00
bsd-user target: Do not include "exec/exec-all.h" if it is not necessary 2018-06-01 14:15:10 +02:00
capstone@22ead3e0bf disas: Add capstone as submodule 2017-10-26 11:56:20 +02:00
chardev * "info mtree" improvements (Alexey) 2018-06-29 12:30:29 +01:00
contrib vhost-blk: turn on pre-defined RO feature bit 2018-06-01 19:20:38 +03:00
crypto glib: bump min required glib library version to 2.40 2018-06-29 12:22:28 +01:00
default-configs target-arm queue: 2018-06-22 16:03:31 +01:00
disas RISC-V: Fix missing break statement in disassembler 2018-05-06 10:39:38 +12:00
docs Replace '-enable-kvm' with '-accel kvm' in docs and help texts 2018-06-28 19:05:32 +02:00
dtc@e54388015a Update dtc to fix compilation problem on Mac OS 10.6 2018-01-10 12:53:00 +11:00
fpu fpu/softfloat: Define floatN_silence_nan in terms of parts_silence_nan 2018-05-17 15:27:15 -07:00
fsdev use g_path_get_basename instead of basename 2018-03-06 14:01:29 +01:00
gdb-xml
hw Pull request 2018-06-30 13:59:53 +01:00
include chardev: comment details for CLOSED event 2018-06-30 17:50:48 +02:00
io Delete AF_UNIX socket after close 2018-06-28 13:36:59 +01:00
libdecnumber build: remove CONFIG_LIBDECNUMBER 2017-10-16 18:03:52 +02:00
linux-headers linux-headers: Update to kernel mainline commit b357bf602 2018-06-22 13:28:35 +01:00
linux-user target/arm: Implement ARMv8.2-DotProd 2018-06-29 15:11:15 +01:00
migration migration/next for 20180627 2018-06-28 15:31:42 +01:00
nbd nbd/server: Silence gcc false positive 2018-06-22 14:18:36 +01:00
net vhost-user: delete net client if necessary 2018-06-15 10:39:53 +08:00
pc-bios pseries: Update SLOF firmware image to qemu-slof-20180621 2018-06-22 14:19:07 +10:00
po
qapi Block layer patches: 2018-06-29 18:29:15 +01:00
qga glib: bump min required glib library version to 2.40 2018-06-29 12:22:28 +01:00
qobject block-qdict: Pacify Coverity after commit f1b34a248e 2018-06-29 14:20:56 +02:00
qom Purge uses of banned g_assert_FOO() 2018-06-13 13:47:35 +02:00
replay replay: save vmstate of the asynchronous events 2018-03-12 17:10:38 +01:00
roms pseries: Update SLOF firmware image to qemu-slof-20180621 2018-06-22 14:19:07 +10:00
scripts trace: Fix format string for the struct timeval members casted to size_t 2018-06-29 15:04:18 +01:00
scsi pr-manager-helper: report event on connection/disconnection 2018-06-28 19:05:35 +02:00
slirp slirp: reformat m_inc routine 2018-06-08 09:08:30 +03:00
stubs linux-aio: properly bubble up errors from initialization 2018-06-27 13:06:34 +01:00
target target/arm: Add ID_ISAR6 2018-06-29 15:30:54 +01:00
tcg tcg: Reduce max TB opcode count 2018-06-15 09:39:53 -10:00
tests Block layer patches: 2018-06-29 18:29:15 +01:00
trace glib: update the min required version 2018-06-29 15:04:20 +01:00
ui sdl2: add checking for NULL 2018-06-26 13:48:49 +02:00
util The Darwin host support still needs some more work. It won't make it for 2018-06-29 16:56:45 +01:00
.dir-locals.el
.editorconfig
.exrc
.gdbinit
.gitignore block: Ignore generated job QAPI files 2018-06-13 10:51:49 -04:00
.gitmodules roms/u-boot-sam460ex: Change to qemu git mirror and update 2018-04-10 10:05:38 +10:00
.gitpublish Add a git-publish configuration file 2018-03-05 09:03:17 +00:00
.mailmap maint: Add .mailmap entries for patches claiming list authorship 2018-04-09 16:36:40 +02:00
.shippable.yml shippable: Remove Debian 8 libfdt kludge 2018-05-11 14:33:40 +02:00
.travis.yml .travis.yml: add check-tcg test 2018-06-20 22:13:39 +01:00
arch_init.c arch_init: sort architectures 2018-06-01 19:20:38 +03:00
balloon.c qapi: Empty out qapi-schema.json 2018-03-02 13:45:50 -06:00
block.c block: Move bdrv_truncate() implementation to io.c 2018-06-29 14:20:56 +02:00
blockdev-nbd.c qapi: new qmp command nbd-server-add-bitmap 2018-06-21 09:23:59 -05:00
blockdev.c block/mirror: Add copy mode QAPI interface 2018-06-18 17:05:16 +02:00
blockjob.c block: Really pause block jobs on drain 2018-06-18 15:03:25 +02:00
bootdevice.c
bt-host.c
bt-vhci.c
Changelog Use HTTPS for qemu.org and other domains 2017-11-21 13:34:13 +00:00
CODING_STYLE CODING_STYLE: Define our preferred form for multiline comments 2018-06-15 15:23:34 +01:00
configure The Darwin host support still needs some more work. It won't make it for 2018-06-29 16:56:45 +01:00
COPYING
COPYING.LIB
cpus-common.c
cpus.c tcg: fix --disable-tcg build breakage 2018-06-22 18:55:24 +01:00
device_tree.c device_tree: Add qemu_fdt_node_unit_path 2018-06-29 15:11:01 +01:00
device-hotplug.c block: Remove deprecated -drive option addr 2018-06-15 14:49:44 +02:00
disas.c RISC-V Disassembler 2018-03-07 08:30:28 +13:00
dma-helpers.c
dump.c dump: add Windows dump format to dump-guest-memory 2018-06-29 13:02:48 +02:00
exec.c exec: check that alignment is a power of two 2018-06-28 19:05:31 +02:00
gdbstub.c gdbstub: Prevent fd leakage 2018-06-01 15:14:31 +02:00
HACKING HACKING: document preference for g_new instead of g_malloc 2018-05-20 08:32:09 +03:00
hmp-commands-info.hx doc: another fix to "info pic" 2018-06-28 19:05:37 +02:00
hmp-commands.hx dump: add Windows dump format to dump-guest-memory 2018-06-29 13:02:48 +02:00
hmp.c The Darwin host support still needs some more work. It won't make it for 2018-06-29 16:56:45 +01:00
hmp.h hmp: add exit_preconfig 2018-06-21 13:18:05 +01:00
ioport.c
iothread.c iothread: workaround glib bug which hangs qmp-test 2018-04-10 07:43:52 -05:00
job-qmp.c job: Add error message for failing jobs 2018-05-30 13:31:01 +02:00
job.c job: Add job_progress_increase_remaining() 2018-06-18 17:05:11 +02:00
LICENSE
MAINTAINERS MAINTAINERS: update target-mips maintainers 2018-06-27 20:10:42 +02:00
Makefile Revert commit d4e5ec877c 2018-06-22 16:33:47 +02:00
Makefile.objs hw/i2c: Add trace events 2018-06-08 13:15:33 +01:00
Makefile.target dump: add Windows dump format to dump-guest-memory 2018-06-29 13:02:48 +02:00
memory_ldst.inc.c exec: Fix MAP_RAM for cached access 2018-06-28 19:05:30 +02:00
memory_mapping.c Replace all occurances of __FUNCTION__ with __func__ 2018-01-22 09:46:18 +01:00
memory.c memory/hmp: Print owners/parents in "info mtree" 2018-06-28 19:05:36 +02:00
module-common.c
monitor.c monitor: flush qmp responses when CLOSED 2018-06-30 17:50:48 +02:00
numa.c numa: report all DIMM/NVDIMMs as plugged memory 2018-06-28 19:05:34 +02:00
os-posix.c qemu-options: Bail out on unsupported options instead of silently ignoring them 2018-05-09 00:13:39 +02:00
os-win32.c qemu-options: Bail out on unsupported options instead of silently ignoring them 2018-05-09 00:13:39 +02:00
qdev-monitor.c qom: introduce object_class_get_list_sorted 2018-03-12 15:21:10 +01:00
qdict-test-data.txt
qemu-bridge-helper.c
qemu-doc.texi Deprecate the -enable-hax option 2018-06-28 19:05:34 +02:00
qemu-ga.texi
qemu-img-cmds.hx qemu-img: Remove deprecated -s snapshot_id_or_name option 2018-06-11 16:18:45 +02:00
qemu-img.c qemu-img: Fix assert when mapping unaligned raw file 2018-06-15 14:49:44 +02:00
qemu-img.texi qemu-img: Remove deprecated -s snapshot_id_or_name option 2018-06-11 16:18:45 +02:00
qemu-io-cmds.c qemu-io: Let command functions return error code 2018-06-11 16:18:45 +02:00
qemu-io.c qemu-io: Exit with error when a command failed 2018-06-11 16:18:45 +02:00
qemu-keymap.c Drop superfluous includes of qapi-types.h and test-qapi-types.h 2018-02-09 05:05:11 +01:00
qemu-nbd.c block: Cancel job in bdrv_close_all() callers 2018-05-23 14:30:51 +02:00
qemu-nbd.texi
qemu-option-trace.texi qemu-option-trace: -trace enable= is a pattern, not a file 2018-05-20 08:29:01 +03:00
qemu-options-wrapper.h qemu-img: remove references to GEN_DOCS 2018-05-20 08:35:54 +03:00
qemu-options.h
qemu-options.hx kvm: support -overcommit cpu-pm=on|off 2018-06-28 19:05:37 +02:00
qemu-seccomp.c sandbox: disable -sandbox if CONFIG_SECCOMP undefined 2018-06-01 13:44:15 +02:00
qemu-tech.texi cli: add --preconfig option 2018-05-30 13:19:14 -03:00
qemu.nsi Use HTTPS for qemu.org and other domains 2017-11-21 13:34:13 +00:00
qemu.sasl
qmp.c cli: add --preconfig option 2018-05-30 13:19:14 -03:00
qtest.c qtest: Don't perform side effects inside assertion 2017-09-15 09:05:19 +02:00
README README: Fix typo 'git-publish' 2018-03-08 15:45:14 +00:00
replication.c
replication.h block/replication: Remove protocol_name field 2018-03-26 12:16:00 +02:00
rules.mak tests/docker/Makefile.include: handle empty TARGET_LIST 2018-06-04 14:39:18 +08:00
thunk.c
tpm.c qapi: Move qapi-schema.json to qapi/, rename generated files 2018-03-02 13:45:57 -06:00
trace-events job: Add lifecycle QMP commands 2018-05-23 14:30:51 +02:00
VERSION Open 2.13 development tree 2018-04-26 11:48:27 +01:00
version.rc Use HTTPS for qemu.org and other domains 2017-11-21 13:34:13 +00:00
vl.c kvm: support -overcommit cpu-pm=on|off 2018-06-28 19:05:37 +02:00
win_dump.c dump: add Windows live system dump 2018-06-29 13:02:50 +02:00
win_dump.h dump: add Windows live system dump 2018-06-29 13:02:50 +02: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:

  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.

   git clone git://git.qemu.org/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 HACKING and CODING_STYLE files.

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.

  git clone git://git.qemu.org/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:

  $ 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:

  $ 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

 - 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

-- End