QEMU With E2K User Support
Go to file
Eric Blake 7da537f70d nbd/client: Lower min_block for block-status, unaligned size
We have a latent bug in our NBD client code, tickled by the brand new
nbdkit 1.11.10 block status support:

$ nbdkit --filter=log --filter=truncate -U - \
           data data="1" size=511 truncate=64K logfile=/dev/stdout \
           --run 'qemu-img convert $nbd /var/tmp/out'
...
qemu-img: block/io.c:2122: bdrv_co_block_status: Assertion `*pnum && QEMU_IS_ALIGNED(*pnum, align) && align > offset - aligned_offset' failed.

The culprit? Our implementation of .bdrv_co_block_status can return
unaligned block status for any server that operates with a lower
actual alignment than what we tell the block layer in
request_alignment, in violation of the block layer's constraints. To
date, we've been unable to trip the bug, because qemu as NBD server
always advertises block sizing (at which point it is a server bug if
the server sends unaligned status - although qemu 3.1 is such a server
and I've sent separate patches for 4.0 both to get the server to obey
the spec, and to let the client to tolerate server oddities at EOF).

But nbdkit does not (yet) advertise block sizing, and therefore is not
in violation of the spec for returning block status at whatever
boundaries it wants, and those unaligned results can occur anywhere
rather than just at EOF. While we are still wise to avoid sending
sub-sector read/write requests to a server of unknown origin, we MUST
consider that a server telling us block status without an advertised
block size is correct.  So, we either have to munge unaligned answers
from the server into aligned ones that we hand back to the block
layer, or we have to tell the block layer about a smaller alignment.

Similarly, if the server advertises an image size that is not
sector-aligned, we might as well assume that the server intends to let
us access those tail bytes, and therefore supports a minimum block
size of 1, regardless of whether the server supports block status
(although we still need more patches to fix the problem that with an
unaligned image, we can send read or block status requests that exceed
EOF to the server). Again, qemu as server cannot trip this problem
(because it rounds images to sector alignment), but nbdkit advertised
unaligned size even before it gained block status support.

Solve both alignment problems at once by using better heuristics on
what alignment to report to the block layer when the server did not
give us something to work with. Note that very few NBD servers
implement block status (to date, only qemu and nbdkit are known to do
so); and as the NBD spec mentioned block sizing constraints prior to
documenting block status, it can be assumed that any future
implementations of block status are aware that they must advertise
block size if they want a minimum size other than 1.

We've had a long history of struggles with picking the right alignment
to use in the block layer, as evidenced by the commit message of
fd8d372d (v2.12) that introduced the current choice of forced 512-byte
alignment.

There is no iotest coverage for this fix, because qemu can't provoke
it, and I didn't want to make test 241 dependent on nbdkit.

Fixes: fd8d372d
Reported-by: Richard W.M. Jones <rjones@redhat.com>
Signed-off-by: Eric Blake <eblake@redhat.com>
Message-Id: <20190329042750.14704-3-eblake@redhat.com>
Reviewed-by: Vladimir Sementsov-Ogievskiy <vsementsov@virtuozzo.com>
Tested-by: Richard W.M. Jones <rjones@redhat.com>
2019-03-30 20:52:19 -05:00
accel trace-events: Consistently point to docs/devel/tracing.txt 2019-03-22 16:17:37 +00:00
audio trace-events: Shorten file names in comments 2019-03-22 16:18:07 +00:00
authz trace-events: Fix attribution of trace points to source 2019-03-22 16:18:07 +00:00
backends vhost-user: simplify vhost_user_init/vhost_user_cleanup 2019-03-12 21:22:31 -04:00
block nbd/client: Lower min_block for block-status, unaligned size 2019-03-30 20:52:19 -05:00
bsd-user avoid TABs in files that only contain a few 2019-01-11 15:46:56 +01:00
capstone@22ead3e0bf
chardev trace-events: Shorten file names in comments 2019-03-22 16:18:07 +00:00
contrib contrib/rdmacm-mux: Fix out-of-bounds risk 2019-03-16 15:45:12 +02:00
crypto trace-events: Shorten file names in comments 2019-03-22 16:18:07 +00:00
default-configs * Kconfig improvements (msi_nonbroken, imply for default PCI devices) 2019-03-28 09:18:53 +00:00
disas RISC-V: Remove unnecessary disassembler constraints 2019-03-19 05:14:39 -07:00
docs docs: add note about stibp CPU feature for spectre v2 2019-03-20 12:18:15 -03:00
dtc@88f18909db Update dtc/libfdt submodule to v1.4.7 2018-10-02 13:53:26 +10:00
fpu hardfloat: fix float32/64 fused multiply-add 2019-03-25 10:35:32 +00:00
fsdev qemu/queue.h: leave head structs anonymous unless necessary 2019-01-11 15:46:55 +01:00
gdb-xml RISC-V: Add 64-bit gdb xml files. 2019-03-19 05:13:24 -07:00
hw -----BEGIN PGP SIGNATURE----- 2019-03-29 11:51:54 +00:00
include spapr: Simplify handling of host-serial and host-model values 2019-03-29 10:25:50 +11:00
io trace-events: Shorten file names in comments 2019-03-22 16:18:07 +00:00
libdecnumber
linux-headers include: update Linux headers to 4.21-rc1/5.0-rc1 2019-02-04 00:08:58 -05:00
linux-user trace-events: Fix attribution of trace points to source 2019-03-22 16:18:07 +00:00
migration Pull request 2019-03-25 18:15:43 +00:00
nbd trace-events: Delete unused trace points 2019-03-22 16:18:07 +00:00
net net: tap: use qemu_set_nonblock 2019-03-29 15:22:18 +08:00
pc-bios pc-bios: Update palcode-clipper 2019-03-25 13:37:18 -07:00
po po/Makefile: Modern shell scripting (use $() instead of ``) 2018-10-24 07:39:10 +01:00
python/qemu Python queue, 2019-02-22 2019-03-07 16:16:02 +00:00
qapi Miscellaneous patches for 2019-03-26 2019-03-26 09:28:24 +00:00
qga qga: process_event() simplification 2019-03-18 10:48:06 -05:00
qobject json: Fix off-by-one assert check in next_state() 2019-03-26 08:10:11 +01:00
qom trace-events: Shorten file names in comments 2019-03-22 16:18:07 +00:00
replay replay: Exit on errors reading from replay log 2018-11-08 13:24:35 +00:00
roms pc-bios: Update palcode-clipper 2019-03-25 13:37:18 -07:00
scripts * Kconfig improvements (msi_nonbroken, imply for default PCI devices) 2019-03-28 09:18:53 +00:00
scsi trace-events: Shorten file names in comments 2019-03-22 16:18:07 +00:00
slirp slirp: is not maintained by Kelly Price for a long time 2019-03-22 17:31:42 +01:00
stubs exec: Change RAMBlockIterFunc definition 2019-03-06 10:49:17 +00:00
target target/ppc: Fix QEMU crash with stxsdx 2019-03-29 10:22:22 +11:00
tcg tcg: Remove TODO file 2019-02-21 10:22:24 -08:00
tests iotests: Add 241 to test NBD on unaligned images 2019-03-30 20:50:58 -05:00
trace trace: handle tracefs path truncation 2019-03-22 15:55:50 +00:00
ui trace-events: Fix attribution of trace points to source 2019-03-22 16:18:07 +00:00
util util/error: Remove an unnecessary NULL check 2019-03-26 08:10:11 +01:00
.cirrus.yml cirrus.yml: Add macOS continuous integration task 2019-03-08 09:54:29 +01:00
.dir-locals.el
.editorconfig editorconfig: set emacs mode 2018-11-01 12:13:12 +04:00
.exrc
.gdbinit
.gitignore .gitignore: ignore docs/built created for in-tree builds 2019-03-14 16:01:55 +01:00
.gitlab-ci.yml Add a gitlab-ci file for Continuous Integration testing on Gitlab 2019-02-22 09:32:32 +00:00
.gitmodules roms: add the edk2 project as a git submodule 2019-02-21 12:28:41 -05:00
.gitpublish
.mailmap maint: Grammar fix to mailmap 2018-12-11 18:35:54 +01:00
.shippable.yml .shippable.yml: disable the win cross tests 2018-12-17 13:02:12 +00:00
.travis.yml .travis.yml: reduce number of targets built while disabling things 2019-03-25 10:34:46 +00:00
arch_init.c
balloon.c balloon: Allow multiple inhibit users 2018-08-17 09:27:15 -06:00
block.c block: Silence Coverity in bdrv_drop_intermediate() 2019-03-19 15:49:29 +01:00
blockdev-nbd.c nbd: allow authorization with nbd-server-start QMP command 2019-03-06 11:05:27 -06:00
blockdev.c blockdev: Check @replaces in blockdev_mirror_common 2019-03-19 15:50:20 +01:00
blockjob.c blockjob: fix user pause in block_job_error_action 2019-03-19 15:49:29 +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
bt-vhci.c
Changelog
CODING_STYLE CODING_STYLE: Define our preferred form for multiline comments 2018-06-15 15:23:34 +01:00
configure configure: add --target-list-exclude 2019-03-25 10:34:38 +00: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 qemu/queue.h: simplify reverse access to QTAILQ 2019-01-11 15:46:55 +01:00
cpus.c cpus: Properly release the iothread lock when killing a dummy VCPU 2019-02-26 09:21:25 +11:00
device_tree.c device_tree.c: Don't use load_image() 2018-12-14 13:30:52 +00:00
device-hotplug.c blockdev: Convert drive_new() to Error 2018-10-19 14:51:34 +02:00
disas.c disas: Add RISC-V support 2018-12-26 06:40:02 +11:00
dma-helpers.c
dump.c dump: Set correct vaddr for ELF dump 2019-02-06 15:51:12 +01:00
exec.c exec: Only count mapped memory backends for qemu_getrampagesize() 2019-03-29 14:24:08 +11:00
gdbstub.c gdbstub: fix vCont packet handling when no thread is specified 2019-03-26 12:53:26 +00:00
gitdm.config contrib: gitdm: add a mapping for Janus Technologies 2019-03-12 19:31:29 +00:00
HACKING
hmp-commands-info.hx {hmp, hw/pvrdma}: Expose device internals via monitor interface 2019-03-16 15:52:44 +02:00
hmp-commands.hx hmp: Add hmp_announce_self 2019-03-05 11:27:41 +08:00
hmp.c migration: add support for a "tls-authz" migration parameter 2019-03-25 18:13:47 +01:00
hmp.h {hmp, hw/pvrdma}: Expose device internals via monitor interface 2019-03-16 15:52:44 +02:00
ioport.c
iothread.c iothread: document about why we need explicit aio_poll() 2019-03-08 10:20:57 +00:00
job-qmp.c jobs: canonize Error object 2018-08-31 16:28:33 +02:00
job.c job: Fix off-by-one assert checks for JobSTT and JobVerbTable 2018-11-12 17:49:21 +01:00
Kconfig.host kconfig: add dependencies on CONFIG_MSI_NONBROKEN 2019-03-18 09:39:57 +01:00
LICENSE
MAINTAINERS MAINTAINERS: Update the latest email address 2019-03-29 15:22:18 +08:00
Makefile config-all-devices.mak: rebuild on reconfigure 2019-03-20 11:44:13 +01:00
Makefile.objs RISC-V: Convert trap debugging to trace events 2019-03-19 05:14:40 -07:00
Makefile.target tests/tcg: enable tcg tests for softmmu 2019-03-12 17:05:21 +00:00
memory_ldst.inc.c exec: Fix MAP_RAM for cached access 2018-06-28 19:05:30 +02:00
memory_mapping.c qemu/queue.h: simplify reverse access to QTAILQ 2019-01-11 15:46:55 +01:00
memory.c memory: Fix the memory region type assignment order 2019-03-18 09:39:57 +01:00
module-common.c
monitor.c qmp: common 'id' handling & make QGA conform to QMP spec 2019-03-18 10:48:06 -05:00
numa.c numa: Fixed the memory leak of numa error message 2019-01-28 15:52:05 -02:00
os-posix.c util: add qemu_write_pidfile() 2018-10-02 18:47:55 +02:00
os-win32.c util: add qemu_write_pidfile() 2018-10-02 18:47:55 +02:00
qdev-monitor.c qdev: Let the hotplug_handler_unplug() caller delete the device 2019-03-06 11:51:08 -03:00
qemu-bridge-helper.c
qemu-deprecated.texi Pull request 2019-03-13 17:30:34 +00:00
qemu-doc.texi qemu-doc: Add section on MIPS' Boston board 2019-02-27 14:26:14 +01:00
qemu-edid.c display/edid: add edid generator to qemu. 2018-09-27 08:07:51 +02:00
qemu-ga.texi
qemu-img-cmds.hx qemu-img: Add -C option for convert with copy offloading 2018-07-30 15:35:37 +02:00
qemu-img.c qemu-img: Gracefully shutdown when map can't finish 2019-03-30 10:06:08 -05:00
qemu-img.texi qemu-img: Add -C option for convert with copy offloading 2018-07-30 15:35:37 +02:00
qemu-io-cmds.c qemu-io: Add write -n for BDRV_REQ_NO_FALLBACK 2019-03-26 11:37:51 +01:00
qemu-io.c qom: Clean up error reporting in user_creatable_add_opts_foreach() 2018-10-19 14:51:34 +02:00
qemu-keymap.c ui: use enum to string helpers 2018-08-24 08:40:10 +02:00
qemu-nbd.c qemu-nbd: add support for authorization of TLS clients 2019-03-06 11:05:27 -06:00
qemu-nbd.texi qemu-nbd: add support for authorization of TLS clients 2019-03-06 11:05:27 -06:00
qemu-option-trace.texi
qemu-options-wrapper.h
qemu-options.h
qemu-options.hx ui: better unicode support for curses, v2. 2019-03-13 20:11:06 +00:00
qemu-seccomp.c seccomp: report more useful errors from seccomp 2019-03-27 13:11:38 +01:00
qemu-tech.texi cli qmp: Mark --preconfig, exit-preconfig experimental 2018-07-16 15:38:19 +02:00
qemu.nsi
qemu.sasl
qmp.c qapi: make query-cpu-definitions depend on specific targets 2019-02-18 14:44:05 +01:00
qtest.c char: allow specifying a GMainContext at opening time 2019-02-13 14:23:39 +01:00
README README: use 'https://' instead of 'git://' 2018-11-12 11:26:02 +00:00
replication.c
replication.h
rules.mak build: switch to Kconfig 2019-03-07 21:45:53 +01: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 trace-events: Fix attribution of trace points to source 2019-03-22 16:18:07 +00:00
VERSION Update version for v4.0.0-rc1 release 2019-03-26 17:02:29 +00:00
version.rc
vl.c vl: Fix to create migration object before block backends again 2019-03-19 15:49:29 +01:00
win_dump.c dump: fix Windows dump memory run mapping 2018-10-02 18:47:55 +02:00
win_dump.h dump: move Windows dump structures definitions 2018-10-02 19:09:12 +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 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