QEMU With E2K User Support
Go to file
Eric Blake 0a4795455c nbd: Prepare for NBD_CMD_FLAG_FAST_ZERO
Commit fe0480d6 and friends added BDRV_REQ_NO_FALLBACK as a way to
avoid wasting time on a preliminary write-zero request that will later
be rewritten by actual data, if it is known that the write-zero
request will use a slow fallback; but in doing so, could not optimize
for NBD.  The NBD specification is now considering an extension that
will allow passing on those semantics; this patch updates the new
protocol bits and 'qemu-nbd --list' output to recognize the bit, as
well as the new errno value possible when using the new flag; while
upcoming patches will improve the client to use the feature when
present, and the server to advertise support for it.

The NBD spec recommends (but not requires) that ENOTSUP be avoided for
all but failures of a fast zero (the only time it is mandatory to
avoid an ENOTSUP failure is when fast zero is supported but not
requested during write zeroes; the questionable use is for ENOTSUP to
other actions like a normal write request).  However, clients that get
an unexpected ENOTSUP will either already be treating it the same as
EINVAL, or may appreciate the extra bit of information.  We were
equally loose for returning EOVERFLOW in more situations than
recommended by the spec, so if it turns out to be a problem in
practice, a later patch can tighten handling for both error codes.

Signed-off-by: Eric Blake <eblake@redhat.com>
Message-Id: <20190823143726.27062-3-eblake@redhat.com>
Reviewed-by: Vladimir Sementsov-Ogievskiy <vsementsov@virtuozzo.com>
[eblake: tweak commit message, also handle EOPNOTSUPP]
2019-09-05 16:03:13 -05:00
accel Allow page table bit to swap endianness. 2019-09-04 16:29:18 +01:00
audio audio: omitting audiodev= parameter is only deprecated 2019-08-28 11:57:45 +02:00
authz Include qemu/module.h where needed, drop it from qemu-common.h 2019-06-12 13:18:33 +02:00
backends virtio,vhost: fixes, features, cleanups. 2019-09-04 17:22:34 +01:00
block block: workaround for unaligned byte range in fallocate() 2019-09-05 16:01:31 -05:00
bsd-user Include qemu-common.h exactly where needed 2019-06-12 13:20:20 +02:00
capstone@22ead3e0bf disas: Add capstone as submodule 2017-10-26 11:56:20 +02:00
chardev socket: Add num connections to qio_net_listener_open_sync() 2019-09-03 23:24:42 +02:00
contrib virtio,vhost: fixes, features, cleanups. 2019-09-04 17:22:34 +01:00
crypto crypto: use auto cleanup for many stack variables 2019-08-22 10:56:57 +01:00
default-configs MIPS queue for July 2nd, 2019 2019-07-03 21:19:03 +01:00
disas ppc: Add support for 'mffsl' instruction 2019-08-21 17:17:39 +10:00
docs nbd: Prepare for NBD_CMD_FLAG_FAST_ZERO 2019-09-05 16:03:13 -05:00
dtc@88f18909db Update dtc/libfdt submodule to v1.4.7 2018-10-02 13:53:26 +10:00
dump sysemu: Split sysemu/runstate.h off sysemu/sysemu.h 2019-08-16 13:37:36 +02:00
fpu fpu: rename softfloat-specialize.h -> .inc.c 2019-08-19 12:07:13 +01:00
fsdev 9p: simplify source file selection 2019-08-20 17:26:19 +02:00
gdb-xml RISC-V: Add 64-bit gdb xml files. 2019-03-19 05:13:24 -07:00
hw virtio,vhost: fixes, features, cleanups. 2019-09-04 17:22:34 +01:00
include nbd: Prepare for NBD_CMD_FLAG_FAST_ZERO 2019-09-05 16:03:13 -05:00
io socket: Add num connections to qio_net_listener_open_sync() 2019-09-03 23:24:42 +02:00
libdecnumber build: remove CONFIG_LIBDECNUMBER 2017-10-16 18:03:52 +02:00
linux-headers linux-headers: sync with latest KVM headers from Linux 5.2 2019-06-21 13:23:47 +02:00
linux-user target/openrisc: Add support for ORFPX64A32 2019-09-04 12:53:33 -07:00
migration multifd: Use number of channels as listen backlog 2019-09-03 23:24:42 +02:00
monitor Monitor patches for 2019-08-21 2019-08-22 10:31:21 +01:00
nbd nbd: Prepare for NBD_CMD_FLAG_FAST_ZERO 2019-09-05 16:03:13 -05:00
net sysemu: Split sysemu/runstate.h off sysemu/sysemu.h 2019-08-16 13:37:36 +02:00
pc-bios pseries: Update SLOF firmware image 2019-08-29 09:46:07 +10:00
po po/Makefile: Modern shell scripting (use $() instead of ``) 2018-10-24 07:39:10 +01:00
python/qemu iotests: Add @has_quit to vm.shutdown() 2019-07-19 13:19:17 +02:00
qapi qapi: report the default CPU type for each machine 2019-09-03 14:39:46 -03:00
qga socket: Add backlog parameter to socket_listen 2019-09-03 23:24:42 +02:00
qobject json: Move switch 'fall through' comment to correct place 2019-08-21 10:54:31 +02:00
qom hw/core: Move cpu.c, cpu.h from qom/ to hw/core/ 2019-08-21 13:24:01 +02:00
replay audio: second batch of -audiodev support, adding support for multiple backends. 2019-08-21 15:18:50 +01:00
roms pseries: Update SLOF firmware image 2019-08-29 09:46:07 +10:00
scripts minikconf: don't print CONFIG_FOO=n lines 2019-08-21 16:29:57 +02:00
scsi socket: Add num connections to qio_channel_socket_sync() 2019-09-03 23:24:42 +02:00
slirp@126c04acba slirp: update with CVE-2019-14378 fix 2019-08-02 15:14:56 +04:00
stubs sysemu: Split sysemu/runstate.h off sysemu/sysemu.h 2019-08-16 13:37:36 +02:00
target target/arm: Inline gen_bx_im into callers 2019-09-05 13:23:04 +01:00
tcg Allow page table bit to swap endianness. 2019-09-04 16:29:18 +01:00
tests nbd: Improve per-export flag handling in server 2019-09-05 16:02:54 -05:00
trace tcg: TCGMemOp is now accelerator independent MemOp 2019-09-03 08:30:38 -07:00
ui socket: Add num connections to qio_net_listener_open_sync() 2019-09-03 23:24:42 +02:00
util socket: Add backlog parameter to socket_listen 2019-09-03 23:24:42 +02:00
.cirrus.yml cirrus / travis: Add gnu-sed and bash for macOS and FreeBSD 2019-05-21 10:12:47 +02:00
.dir-locals.el Add .dir-locals.el file to configure emacs coding style 2015-10-08 19:46:01 +03:00
.editorconfig editorconfig: add setting for shell scripts 2019-06-12 17:53:22 +01: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
.gitignore .gitignore: ignore some vhost-user* related files 2019-08-21 10:40:41 +02:00
.gitlab-ci.yml gitlab-ci: Remove qcow2 tests that are handled by "make check" already 2019-08-17 09:06:17 +02:00
.gitmodules roms: Add OpenSBI version 0.4 2019-07-18 14:18:43 -07:00
.gitpublish Add a git-publish configuration file 2018-03-05 09:03:17 +00:00
.mailmap .mailmap/aliases: add some further commentary 2019-09-02 10:52:22 +01:00
.patchew.yml ci: store Patchew configuration in the tree 2019-06-03 14:03:02 +02:00
.shippable.yml shippable: re-enable the windows cross builds 2019-07-23 15:53:25 +01:00
.travis.yml Boot Linux Console Test: add a test for ppc64 + pseries 2019-08-28 21:10:03 -04:00
CODING_STYLE CODING_STYLE: indent example code as all others 2019-05-02 18:12:58 +02: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
Changelog Use HTTPS for qemu.org and other domains 2017-11-21 13:34:13 +00:00
HACKING HACKING: Document 'struct' keyword usage 2019-08-20 20:00:51 +02:00
Kconfig.host 9p: simplify source file selection 2019-08-20 17:26:19 +02:00
LICENSE roms: Add OpenSBI version 0.4 2019-07-18 14:18:43 -07:00
MAINTAINERS tcg: TCGMemOp is now accelerator independent MemOp 2019-09-03 08:30:38 -07:00
Makefile tests/docker: add podman support 2019-08-22 17:30:25 +04:00
Makefile.objs dump: Move HMP command handlers to dump/ 2019-07-02 13:37:00 +02:00
Makefile.target configure: only link capstone to emulation targets 2019-07-19 12:52:04 +01:00
README README: use 'https://' instead of 'git://' 2018-11-12 11:26:02 +00:00
VERSION Open 4.2 development tree 2019-08-15 17:20:55 +01:00
arch_init.c qapi: Move query-target from misc.json to machine.json 2019-08-21 13:24:01 +02:00
balloon.c Clean up inclusion of exec/cpu-common.h 2019-08-16 13:31:52 +02:00
block.c block: fix permission update in bdrv_replace_node 2019-09-03 14:55:35 +02:00
blockdev-nbd.c nbd: Improve per-export flag handling in server 2019-09-05 16:02:54 -05:00
blockdev.c mirror: Fix bdrv_has_zero_init() use 2019-08-19 17:13:26 +02:00
blockjob.c Block layer patches: 2019-08-16 16:43:46 +01:00
bootdevice.c fw_cfg: ignore suffixes in the bootdevice list dependent on machine class 2018-08-16 22:27:43 -03:00
bt-host.c all: Clean up includes 2016-02-04 17:41:30 +00:00
bt-vhci.c Include qemu-common.h exactly where needed 2019-06-12 13:20:20 +02:00
configure configure: more resilient Python version capture 2019-08-27 16:57:24 -03:00
cpus-common.c Monitor patches for 2019-08-21 2019-08-22 10:31:21 +01:00
cpus.c util/qemu-timer: refactor deadline calculation for external timers 2019-08-20 17:26:21 +02:00
device-hotplug.c Include hw/hw.h exactly where needed 2019-08-16 13:31:52 +02:00
device_tree.c device_tree: Fix integer overflowing in load_device_tree() 2019-04-09 16:35:40 -07:00
disas.c Include qemu-common.h exactly where needed 2019-06-12 13:20:20 +02:00
dma-helpers.c dma-helpers: ensure AIO callback is invoked after cancellation 2019-08-16 19:14:04 -04:00
exec.c Allow page table bit to swap endianness. 2019-09-04 16:29:18 +01:00
gdbstub.c gdbstub: Fix handler for 'F' packet 2019-08-28 10:11:15 +01:00
gitdm.config contrib: gitdm: add a mapping for Janus Technologies 2019-03-12 19:31:29 +00:00
hmp-commands-info.hx {hmp, hw/pvrdma}: Expose device internals via monitor interface 2019-03-16 15:52:44 +02:00
hmp-commands.hx audio: add audiodev property to vnc and wav_capture 2019-08-21 09:13:37 +02:00
ioport.c Include qemu-common.h exactly where needed 2019-06-12 13:20:20 +02:00
iothread.c iothread: document about why we need explicit aio_poll() 2019-03-08 10:20:57 +00:00
job-qmp.c Include qemu-common.h exactly where needed 2019-06-12 13:20:20 +02:00
job.c Include qemu-common.h exactly where needed 2019-06-12 13:20:20 +02:00
memory.c Allow page table bit to swap endianness. 2019-09-04 16:29:18 +01:00
memory_ldst.inc.c memory: Single byte swap along the I/O path 2019-09-03 08:30:39 -07:00
memory_mapping.c Include qemu-common.h exactly where needed 2019-06-12 13:20:20 +02:00
module-common.c all: Clean up includes 2016-02-04 17:41:30 +00:00
os-posix.c sysemu: Split sysemu/runstate.h off sysemu/sysemu.h 2019-08-16 13:37:36 +02:00
os-win32.c sysemu: Split sysemu/runstate.h off sysemu/sysemu.h 2019-08-16 13:37:36 +02:00
qdev-monitor.c qdev: Collect HMP handlers command handlers in qdev-monitor.c 2019-08-21 13:24:01 +02:00
qemu-bridge-helper.c qemu-bridge-helper: move repeating code in parse_acl_file 2019-07-29 16:29:30 +08:00
qemu-deprecated.texi audio: omitting audiodev= parameter is only deprecated 2019-08-28 11:57:45 +02:00
qemu-doc.texi docs: Update preferred NBD device syntax 2019-09-05 16:01:47 -05:00
qemu-edid.c Include qemu-common.h exactly where needed 2019-06-12 13:20:20 +02:00
qemu-ga.texi doc: fix the configuration path 2019-05-03 13:03:04 +02:00
qemu-img-cmds.hx qemu-img: Add salvaging mode to convert 2019-06-14 14:16:57 +02:00
qemu-img.c block: define .*_part io handlers in BlockDriver 2019-08-27 14:58:42 +01:00
qemu-img.texi doc: Preallocation does not require writing zeroes 2019-08-19 17:13:26 +02:00
qemu-io-cmds.c qemu-io: add pattern file for write command 2019-09-03 14:55:35 +02:00
qemu-io.c Include qemu-common.h exactly where needed 2019-06-12 13:20:20 +02:00
qemu-keymap.c Include qemu-common.h exactly where needed 2019-06-12 13:20:20 +02:00
qemu-nbd.c nbd: Prepare for NBD_CMD_FLAG_FAST_ZERO 2019-09-05 16:03:13 -05:00
qemu-nbd.texi qemu-nbd: Add --pid-file option 2019-06-13 08:50:47 -05:00
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 Clean up ill-advised or unusual header guards 2016-07-12 16:20:46 +02:00
qemu-options.hx virtio-rng: change default backend to rng-builtin 2019-09-04 06:32:51 -04:00
qemu-seccomp.c seccomp: report more useful errors from seccomp 2019-03-27 13:11:38 +01:00
qemu-tech.texi qemu-tech: Fix dangling @menu entries 2019-07-15 21:10:29 +02:00
qemu.nsi NSIS: Add missing firmware blobs 2019-07-23 15:53:25 +01:00
qemu.sasl Default to GSSAPI (Kerberos) instead of DIGEST-MD5 for SASL 2017-05-09 14:41:47 +01:00
qtest.c tests: add module loading test 2019-08-21 16:29:57 +02: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 contrib: add vhost-user-gpu 2019-05-29 06:30:45 +02:00
thunk.c thunk: improve readability of allocation loop 2019-03-11 18:48:20 +01:00
tpm.c tpm: Clean up error reporting in tpm_init_tpmdev() 2018-10-19 14:51:34 +02:00
trace-events hw/core: Move cpu.c, cpu.h from qom/ to hw/core/ 2019-08-21 13:24:01 +02:00
version.rc Use HTTPS for qemu.org and other domains 2017-11-21 13:34:13 +00:00
vl.c Various trivial fixes 2019-08-21 16:59:22 +01:00

README

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

  $ 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