QEMU With E2K User Support
Go to file
Daniel P. Berrange 409437e16d tests: introduce a framework for testing migration performance
This introduces a moderately general purpose framework for
testing performance of migration.

The initial guest workload is provided by the included 'stress'
program, which is configured to spawn one thread per guest CPU
and run a maximally memory intensive workload. It will loop
over GB of memory, xor'ing each byte with data from a 4k array
of random bytes. This ensures heavy read and write load across
all of guest memory to stress the migration performance. While
running the 'stress' program will record how long it takes to
xor each GB of memory and print this data for later reporting.

The test engine will spawn a pair of QEMU processes, either on
the same host, or with the target on a remote host via ssh,
using the host kernel and a custom initrd built with 'stress'
as the /init binary. Kernel command line args are set to ensure
a fast kernel boot time (< 1 second) between launching QEMU and
the stress program starting execution.

None the less, the test engine will initially wait N seconds for
the guest workload to stablize, before starting the migration
operation. When migration is running, the engine will use pause,
post-copy, autoconverge, xbzrle compression and multithread
compression features, as well as downtime & bandwidth tuning
to encourage completion. If migration completes, the test engine
will wait N seconds again for the guest workooad to stablize on
the target host. If migration does not complete after a preset
number of iterations, it will be aborted.

While the QEMU process is running on the source host, the test
engine will sample the host CPU usage of QEMU as a whole, and
each vCPU thread. While migration is running, it will record
all the stats reported by 'query-migration'. Finally, it will
capture the output of the stress program running in the guest.

All the data produced from a single test execution is recorded
in a structured JSON file. A separate program is then able to
create interactive charts using the "plotly" python + javascript
libraries, showing the characteristics of the migration.

The data output provides visualization of the effect on guest
vCPU workloads from the migration process, the corresponding
vCPU utilization on the host, and the overall CPU hit from
QEMU on the host. This is correlated from statistics from the
migration process, such as downtime, vCPU throttling and iteration
number.

While the tests can be run individually with arbitrary parameters,
there is also a facility for producing batch reports for a number
of pre-defined scenarios / comparisons, in order to be able to
get standardized results across different hardware configurations
(eg TCP vs RDMA, or comparing different VCPU counts / memory
sizes, etc).

To use this, first you must build the initrd image

 $ make tests/migration/initrd-stress.img

To run a a one-shot test with all default parameters

 $ ./tests/migration/guestperf.py > result.json

This has many command line args for varying its behaviour.
For example, to increase the RAM size and CPU count and
bind it to specific host NUMA nodes

 $ ./tests/migration/guestperf.py \
       --mem 4 --cpus 2 \
       --src-mem-bind 0 --src-cpu-bind 0,1 \
       --dst-mem-bind 1 --dst-cpu-bind 2,3 \
       > result.json

Using mem + cpu binding is strongly recommended on NUMA
machines, otherwise the guest performance results will
vary wildly between runs of the test due to lucky/unlucky
NUMA placement, making sensible data analysis impossible.

To make it run across separate hosts:

 $ ./tests/migration/guestperf.py \
       --dst-host somehostname > result.json

To request that post-copy is enabled, with switchover
after 5 iterations

 $ ./tests/migration/guestperf.py \
       --post-copy --post-copy-iters 5 > result.json

Once a result.json file is created, a graph of the data
can be generated, showing guest workload performance per
thread and the migration iteration points:

 $ ./tests/migration/guestperf-plot.py --output result.html \
        --migration-iters --split-guest-cpu result.json

To further include host vCPU utilization and overall QEMU
utilization

 $ ./tests/migration/guestperf-plot.py --output result.html \
        --migration-iters --split-guest-cpu \
	--qemu-cpu --vcpu-cpu result.json

NB, the 'guestperf-plot.py' command requires that you have
the plotly python library installed. eg you must do

 $ pip install --user  plotly

Viewing the result.html file requires that you have the
plotly.min.js file in the same directory as the HTML
output. This js file is installed as part of the plotly
python library, so can be found in

  $HOME/.local/lib/python2.7/site-packages/plotly/offline/plotly.min.js

The guestperf-plot.py program can accept multiple json files
to plot, enabling results from different configurations to
be compared.

Finally, to run the entire standardized set of comparisons

  $ ./tests/migration/guestperf-batch.py \
       --dst-host somehost \
       --mem 4 --cpus 2 \
       --src-mem-bind 0 --src-cpu-bind 0,1 \
       --dst-mem-bind 1 --dst-cpu-bind 2,3
       --output tcp-somehost-4gb-2cpu

will store JSON files from all scenarios in the directory
named tcp-somehost-4gb-2cpu

Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
Message-Id: <1469020993-29426-7-git-send-email-berrange@redhat.com>
Signed-off-by: Amit Shah <amit.shah@redhat.com>
2016-07-22 13:23:39 +05:30
audio Clean up decorations and whitespace around header guards 2016-07-12 16:20:46 +02:00
backends * SCSI scanner support 2016-07-14 13:44:06 +01:00
block pc, pci, virtio: new features, cleanups, fixes 2016-07-21 20:12:37 +01:00
bsd-user * two old patches from prospective GSoC students 2016-07-19 15:08:05 +01:00
contrib Clean up ill-advised or unusual header guards 2016-07-12 16:20:46 +02:00
crypto crypto: don't open-code qcrypto_hash_supports 2016-07-21 10:46:27 +01:00
default-configs dma: Add Xilinx Zynq devcfg device model 2016-07-04 13:15:22 +01:00
disas disas: Fix ATTRIBUTE_UNUSED define clash with ALSA headers 2016-07-19 16:40:39 +01:00
docs pc, pci, virtio: new features, cleanups, fixes 2016-07-21 20:12:37 +01:00
dtc@65cc4d2748
fpu softfloat: Handle snan_bit_is_one == 0 in MIPS pickNaNMulAdd() 2016-06-24 13:41:32 +01:00
fsdev Clean up #include "..." vs <...> and header guards 2016-07-12 16:04:36 +01:00
gdb-xml
hw pc, pci, virtio: new features, cleanups, fixes 2016-07-21 20:12:37 +01:00
include pc, pci, virtio: new features, cleanups, fixes 2016-07-21 20:12:37 +01:00
io coroutine: move entry argument to qemu_coroutine_create 2016-07-13 13:26:02 +02:00
libdecnumber
linux-headers linux-headers: update 2016-06-14 13:34:50 +02:00
linux-user linux-user: AArch64 has sync_file_range, not sync_file_range2 2016-07-19 16:18:11 +03:00
migration migration: set state to post-migrate on failure 2016-07-22 13:23:09 +05:30
nbd block: Convert BB interface to byte-based discards 2016-07-20 14:11:55 +01:00
net QAPI patches for 2016-07-19 2016-07-20 14:34:08 +01:00
pc-bios Update OpenBIOS images to e79bca6 built from submodule. 2016-07-19 07:41:52 +01:00
pixman@87eea99e44
po Added Bulgarian translation 2016-07-01 16:06:57 +01:00
qapi -----BEGIN PGP SIGNATURE----- 2016-07-20 17:05:35 +01:00
qga Clean up header guards that don't match their file name 2016-07-12 16:19:16 +02:00
qobject json-streamer: fix double-free on exiting during a parse 2016-07-12 18:31:27 +02:00
qom trace: Add per-vCPU tracing states for events with the 'vcpu' property 2016-07-18 18:23:12 +01:00
replay replay: Use new QAPI cloning 2016-07-06 10:52:04 +02:00
roms Update OpenBIOS images to e79bca6 built from submodule. 2016-07-19 07:41:52 +01:00
scripts scripts: ensure monitor socket has SO_REUSEADDR set 2016-07-22 13:23:35 +05:30
slirp Clean up decorations and whitespace around header guards 2016-07-12 16:20:46 +02:00
stubs trace: Add per-vCPU tracing states for events with the 'vcpu' property 2016-07-18 18:23:12 +01:00
target-alpha target-*: Clean up cpu.h header guards 2016-07-12 16:19:16 +02:00
target-arm pc, pci, virtio: new features, cleanups, fixes 2016-07-21 20:12:37 +01:00
target-cris Clean up decorations and whitespace around header guards 2016-07-12 16:20:46 +02:00
target-i386 pc, pci, virtio: new features, cleanups, fixes 2016-07-21 20:12:37 +01:00
target-lm32 target-*: Clean up cpu.h header guards 2016-07-12 16:19:16 +02:00
target-m68k target-*: Clean up cpu.h header guards 2016-07-12 16:19:16 +02:00
target-microblaze target-*: Clean up cpu.h header guards 2016-07-12 16:19:16 +02:00
target-mips kvm-irqchip: i386: add hook for add/remove virq 2016-07-21 20:44:19 +03:00
target-moxie target-*: Clean up cpu.h header guards 2016-07-12 16:19:16 +02:00
target-openrisc Clean up header guards that don't match their file name 2016-07-12 16:19:16 +02:00
target-ppc kvm-irqchip: i386: add hook for add/remove virq 2016-07-21 20:44:19 +03:00
target-s390x kvm-irqchip: i386: add hook for add/remove virq 2016-07-21 20:44:19 +03:00
target-sh4 target-*: Clean up cpu.h header guards 2016-07-12 16:19:16 +02:00
target-sparc target-sparc: Elide duplicate updates to fprs 2016-07-12 11:03:01 -07:00
target-tilegx Clean up header guards that don't match their file name 2016-07-12 16:19:16 +02:00
target-tricore Clean up decorations and whitespace around header guards 2016-07-12 16:20:46 +02:00
target-unicore32 target-*: Clean up cpu.h header guards 2016-07-12 16:19:16 +02:00
target-xtensa Clean up header guards that don't match their file name 2016-07-12 16:19:16 +02:00
tcg compiler: never omit assertions if using a static analysis tool 2016-07-17 09:59:21 +02:00
tests tests: introduce a framework for testing migration performance 2016-07-22 13:23:39 +05:30
trace trace: Add QAPI/QMP interfaces to query and control per-vCPU tracing state 2016-07-18 18:23:12 +01:00
ui vnc-tight: fix regression with libxenstore 2016-07-15 12:11:55 +02:00
util use g_path_get_dirname instead of dirname 2016-07-17 09:59:21 +02:00
.dir-locals.el
.exrc
.gitignore Add optionrom compatible with fw_cfg DMA version 2016-07-14 15:50:52 +02:00
.gitmodules
.mailmap
.travis.yml .travis.yml: Disable IRC build status updates from forks 2016-07-18 16:40:58 +01:00
accel.c accel: make configure_accelerator return void 2016-05-18 15:04:27 +03:00
aio-posix.c aio-posix: remove useless parameter 2016-07-18 15:10:52 +01:00
aio-win32.c aio-posix: remove useless parameter 2016-07-18 15:10:52 +01:00
arch_init.c cpu: Eliminate cpudef_init(), cpudef_setup() 2016-05-23 19:47:37 -03:00
async.c aio-posix: remove useless parameter 2016-07-18 15:10:52 +01:00
balloon.c
block.c block: remove extra condition in bdrv_can_write_zeroes_with_unmap 2016-07-19 16:54:46 -04:00
blockdev-nbd.c
blockdev.c block: Simplify drive-mirror 2016-07-19 13:21:09 +02:00
blockjob.c block/qdev: Allow configuring rerror/werror with qdev properties 2016-07-13 13:32:27 +02:00
bootdevice.c error: Remove NULL checks on error_propagate() calls 2016-06-20 16:38:13 +02:00
bt-host.c
bt-vhci.c
Changelog
CODING_STYLE
configure tests: introduce a framework for testing migration performance 2016-07-22 13:23:39 +05:30
COPYING
COPYING.LIB
cpu-exec-common.c cpu-exec: Rename cpu_resume_from_signal() to cpu_loop_exit_noexc() 2016-06-09 15:55:02 +01:00
cpu-exec.c cpu-exec: Move down some declarations in cpu_exec() 2016-07-17 09:59:22 +02:00
cpus.c seqlock: rename write_lock/unlock to write_begin/end 2016-06-11 22:59:34 +00:00
cputlb.c cputlb: Add address parameter to VICTIM_TLB_HIT 2016-07-08 13:04:41 -07:00
device_tree.c qemu-common: stop including qemu/bswap.h from qemu-common.h 2016-05-19 16:42:28 +02:00
device-hotplug.c
disas.c
dma-helpers.c dma-helpers: dma_blk_io() cancel support 2016-06-28 13:08:31 +01:00
dump.c error: Remove NULL checks on error_propagate() calls 2016-06-20 16:38:13 +02:00
exec.c exec: avoid realloc in phys_map_node_reserve 2016-07-17 09:59:21 +02:00
gdbstub.c linux-user pull request for June 2016 2016-06-08 18:34:32 +01:00
HACKING
hmp-commands-info.hx trace: Add QAPI/QMP interfaces to query and control per-vCPU tracing state 2016-07-18 18:23:12 +01:00
hmp-commands.hx trace: Add QAPI/QMP interfaces to query and control per-vCPU tracing state 2016-07-18 18:23:12 +01:00
hmp.c block: Simplify drive-mirror 2016-07-19 13:21:09 +02:00
hmp.h trace: Allow event name pattern in "info trace-events" 2016-07-18 18:23:12 +01:00
iohandler.c iohandler: Introduce iohandler_get_aio_context 2016-04-22 16:43:42 +02:00
ioport.c hw: remove pio_addr_t 2016-05-19 16:42:30 +02:00
iothread.c
kvm-all.c kvm-all: add trace events for kvm irqchip ops 2016-07-21 20:44:19 +03:00
kvm-stub.c kvm-irqchip: do explicit commit when update irq 2016-07-21 20:44:19 +03:00
LICENSE
main-loop.c main-loop: check return value before using pointer 2016-07-12 18:31:27 +02:00
MAINTAINERS -----BEGIN PGP SIGNATURE----- 2016-07-19 13:00:35 +01:00
Makefile * Updated fw_cfg option ROM to include DMA support 2016-07-14 16:49:18 +01:00
Makefile.objs intel_iommu: add support for split irqchip 2016-07-21 20:43:49 +03:00
Makefile.target linux-user: Create a hostdep.h for each host architecture 2016-06-26 13:17:21 +03:00
memory_mapping.c all: Remove unnecessary glib.h includes 2016-06-07 18:19:24 +03:00
memory.c memory: Assert that memory_region_init_rom_device() ops aren't NULL 2016-07-04 13:06:35 +01:00
module-common.c
monitor.c qapi: Change Netdev into a flat union 2016-07-19 20:18:02 +02:00
numa.c opts-visitor: Favor new visit_free() function 2016-07-06 10:52:04 +02:00
os-posix.c use g_path_get_dirname instead of dirname 2016-07-17 09:59:21 +02:00
os-win32.c
page_cache.c coccinelle: Remove unnecessary variables for function return value 2016-06-20 16:38:13 +02:00
qapi-schema.json qapi: Change Netdev into a flat union 2016-07-19 20:18:02 +02:00
qdev-monitor.c util: move declarations out of qemu-common.h 2016-03-22 22:20:17 +01:00
qdict-test-data.txt
qemu-bridge-helper.c all: Remove unnecessary glib.h includes 2016-06-07 18:19:24 +03:00
qemu-char.c char: do not use atexit cleanup handler 2016-07-13 13:30:00 +02:00
qemu-doc.texi Allow users to specify the vmdk virtual hardware version. 2016-05-12 15:22:08 +02:00
qemu-ga.texi
qemu-img-cmds.hx qemu-img bench: Add --flush-interval 2016-06-08 10:21:09 +02:00
qemu-img.c qemu-img: Use strerror() for generic resize error 2016-07-13 13:41:38 +02:00
qemu-img.texi trace: enable tracing in qemu-img 2016-06-28 21:14:12 +01:00
qemu-io-cmds.c block: Convert BB interface to byte-based discards 2016-07-20 14:11:55 +01:00
qemu-io.c trace: enable tracing in qemu-io 2016-06-28 21:14:12 +01:00
qemu-nbd.c trace: enable tracing in qemu-nbd 2016-06-28 21:14:12 +01:00
qemu-nbd.texi trace: enable tracing in qemu-nbd 2016-06-28 21:14:12 +01:00
qemu-option-trace.texi doc: move text describing --trace to specific .texi file 2016-06-28 21:14:12 +01:00
qemu-options-wrapper.h
qemu-options.h Clean up ill-advised or unusual header guards 2016-07-12 16:20:46 +02:00
qemu-options.hx tap: vhost busy polling support 2016-07-07 14:29:04 +08:00
qemu-seccomp.c seccomp: adding sysinfo system call to whitelist 2016-04-16 20:27:44 +02:00
qemu-tech.texi
qemu-timer.c qemu-timer: Use DIV_ROUND_UP 2016-06-07 18:19:25 +03:00
qemu.nsi
qemu.sasl
qmp-commands.hx pc: Implement query-hotpluggable-cpus callback 2016-07-20 12:02:19 -03:00
qmp.c qmp-input-visitor: Favor new visit_free() function 2016-07-06 10:52:04 +02:00
qtest.c qemu-common: push cpu.h inclusion out of qemu-common.h 2016-05-19 16:42:29 +02:00
README Revert e5dfc5e8e("Move README to markdown") 2016-07-21 10:46:41 +01:00
rules.mak build: Use $(AS) for optionrom explicitly 2016-07-10 10:05:46 -07:00
softmmu_template.h cputlb: Fix for self-modifying writes across page boundaries 2016-07-08 13:05:07 -07:00
spice-qemu-char.c
tcg-runtime.c
tci.c tci: do not include exec/exec-all.h 2016-05-20 15:07:46 +01:00
thread-pool.c coroutine: move entry argument to qemu_coroutine_create 2016-07-13 13:26:02 +02:00
thunk.c thunk: Rename args and fields in host-target bitmask conversion code 2016-06-07 18:19:24 +03:00
tpm.c
trace-events kvm-all: add trace events for kvm irqchip ops 2016-07-21 20:44:19 +03:00
translate-all.c translate-all: Fix user-mode self-modifying code in 2 page long TB 2016-07-08 13:17:38 -07:00
translate-all.h trace: Add per-vCPU tracing states for events with the 'vcpu' property 2016-07-18 18:23:12 +01:00
translate-common.c include: move CPU-related definitions out of qemu-common.h 2016-05-19 13:08:04 +02:00
user-exec.c user-exec: Remove unused code for OSX hosts 2016-06-26 13:17:20 +03:00
VERSION Open 2.7 development tree 2016-05-12 12:35:25 +01:00
version.rc
vl.c trace: Add per-vCPU tracing states for events with the 'vcpu' property 2016-07-18 18:23:12 +01:00
xen-common-stub.c
xen-common.c
xen-hvm-stub.c
xen-hvm.c xen: fix ram init regression 2016-07-04 14:50:00 +03:00
xen-mapcache.c os-posix: include sys/mman.h 2016-06-16 18:39:03 +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

Complete details of the process for building and configuring QEMU for
all supported host platforms can be found in the qemu-tech.html file.
Additional information can also be found online via the QEMU website:

  http://qemu-project.org/Hosts/Linux
  http://qemu-project.org/Hosts/W32


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

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

   git clone git://git.qemu-project.org/qemu.git

When submitting patches, the preferred 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

  http://qemu-project.org/Contribute/SubmitAPatch
  http://qemu-project.org/Contribute/TrivialPatches


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:

  http://qemu-project.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
   http://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:

  http://qemu-project.org/Contribute/StartHere

-- End