Find a file
Max Reitz 0b877d09df block: Leave BDS.backing_{file,format} constant
Parts of the block layer treat BDS.backing_file as if it were whatever
the image header says (i.e., if it is a relative path, it is relative to
the overlay), other parts treat it like a cache for
bs->backing->bs->filename (relative paths are relative to the CWD).
Considering bs->backing->bs->filename exists, let us make it mean the
former.

Among other things, this now allows the user to specify a base when
using qemu-img to commit an image file in a directory that is not the
CWD (assuming, everything uses relative filenames).

Before this patch:

$ ./qemu-img create -f qcow2 foo/bot.qcow2 1M
$ ./qemu-img create -f qcow2 -b bot.qcow2 foo/mid.qcow2
$ ./qemu-img create -f qcow2 -b mid.qcow2 foo/top.qcow2
$ ./qemu-img commit -b mid.qcow2 foo/top.qcow2
qemu-img: Did not find 'mid.qcow2' in the backing chain of 'foo/top.qcow2'
$ ./qemu-img commit -b foo/mid.qcow2 foo/top.qcow2
qemu-img: Did not find 'foo/mid.qcow2' in the backing chain of 'foo/top.qcow2'
$ ./qemu-img commit -b $PWD/foo/mid.qcow2 foo/top.qcow2
qemu-img: Did not find '[...]/foo/mid.qcow2' in the backing chain of 'foo/top.qcow2'

After this patch:

$ ./qemu-img commit -b mid.qcow2 foo/top.qcow2
Image committed.
$ ./qemu-img commit -b foo/mid.qcow2 foo/top.qcow2
qemu-img: Did not find 'foo/mid.qcow2' in the backing chain of 'foo/top.qcow2'
$ ./qemu-img commit -b $PWD/foo/mid.qcow2 foo/top.qcow2
Image committed.

With this change, bdrv_find_backing_image() must look at whether the
user has overridden a BDS's backing file.  If so, it can no longer use
bs->backing_file, but must instead compare the given filename against
the backing node's filename directly.

Note that this changes the QAPI output for a node's backing_file.  We
had very inconsistent output there (sometimes what the image header
said, sometimes the actual filename of the backing image).  This
inconsistent output was effectively useless, so we have to decide one
way or the other.  Considering that bs->backing_file usually at runtime
contained the path to the image relative to qemu's CWD (or absolute),
this patch changes QAPI's backing_file to always report the
bs->backing->bs->filename from now on.  If you want to receive the image
header information, you have to refer to full-backing-filename.

This necessitates a change to iotest 228.  The interesting information
it really wanted is the image header, and it can get that now, but it
has to use full-backing-filename instead of backing_file.  Because of
this patch's changes to bs->backing_file's behavior, we also need some
reference output changes.

Along with the changes to bs->backing_file, stop updating
BDS.backing_format in bdrv_backing_attach() as well.  This way,
ImageInfo's backing-filename and backing-filename-format fields will
represent what the image header says and nothing else.

iotest 245 changes in behavior: With the backing node no longer
overriding the parent node's backing_file string, you can now omit the
@backing option when reopening a node with neither a default nor a
current backing file even if it used to have a backing node at some
point.

273 also changes: The base image is opened without a format layer, so
ImageInfo.backing-filename-format used to report "file" for the base
image's overlay after blockdev-snapshot.  However, the image header
never says "file" anywhere, so it now reports $IMGFMT.

Signed-off-by: Max Reitz <mreitz@redhat.com>
2020-09-07 12:31:31 +02:00
.github
.gitlab-ci.d gitlab-ci/opensbi: Update GitLab CI to build generic platform 2020-08-21 22:37:55 -07:00
accel cputlb: Make store_helper less fragile to compiler optimizations 2020-09-03 13:13:58 -07: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: Leave BDS.backing_{file,format} constant 2020-09-07 12:31:31 +02:00
bsd-user meson: bsd-user 2020-08-21 06:30:38 -04:00
capstone@22ead3e0bf
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
disas meson: convert disas directory to Meson 2020-08-21 06:30:24 -04:00
docs docs/qdev-device-use: Don't suggest -drive and -net can do USB 2020-09-03 09:58:39 +02:00
dtc@85e5d83984
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
hw * Cirrus-CI improvements and fixes (compile with -Werror & fix for 1h problem) 2020-09-03 16:58:25 +01:00
include block: Leave BDS.backing_{file,format} constant 2020-09-07 12:31:31 +02: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-user Add btrfs support 2020-09-04 15:53:56 +01:00
meson@68ed748f84 meson: bump submodule to 0.55.1 2020-09-01 01:51:51 -04:00
migration block: Use bdrv_filter_(bs|child) where obvious 2020-09-07 12:31:31 +02:00
monitor migration: Add block-bitmap-mapping parameter 2020-08-21 08:56:09 -05:00
nbd nbd: Use CAF when looking for dirty bitmap 2020-09-07 12:31:31 +02:00
net meson: convert net directory to Meson 2020-08-21 06:30:23 -04:00
pc-bios meson: fix keymaps without qemu-keymap 2020-09-03 12:46:56 +02: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 blockdev: Fix active commit choice 2020-09-07 12:31:31 +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 scripts/qmp/qom-fuse: Fix getattr(), read() for files in / 2020-09-03 09:44:33 +02: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 softmmu/cpus: Only set parallel_cpus for SMP 2020-09-03 13:13:58 -07: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 tcg: Implement 256-bit dup for tcg_gen_gvec_dup_mem 2020-09-03 13:13:58 -07:00
tests block: Leave BDS.backing_{file,format} constant 2020-09-07 12:31:31 +02: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 ui/gtk: Update refresh interval after widget is realized 2020-09-04 07:32:28 +02:00
util util/vfio-helpers: Unify trace-events size format 2020-09-01 11:35:43 +02:00
.cirrus.yml cirrus.yml: Split FreeBSD job into two parts 2020-09-03 12:46:56 +02:00
.dir-locals.el
.editorconfig meson: rename included C source files to .c.inc 2020-08-21 06:18:30 -04:00
.exrc
.gdbinit
.gitignore rules.mak: drop unneeded macros 2020-08-21 06:30:42 -04:00
.gitlab-ci.yml gitlab-ci.yml: Set artifacts expiration time 2020-09-03 12:47:33 +02:00
.gitmodules build-sys: add meson submodule 2020-08-21 06:30:06 -04:00
.gitpublish
.mailmap mailmap: Add entry for Greg Kurz 2020-09-01 11:13:02 +02:00
.patchew.yml
.readthedocs.yml
.shippable.yml shippable: add one more qemu to registry url 2020-07-27 09:39:57 +01:00
.travis.yml gitlab/travis: Rework the disabled features tests 2020-09-03 12:47:33 +02:00
block.c block: Leave BDS.backing_{file,format} constant 2020-09-07 12:31:31 +02:00
blockdev-nbd.c
blockdev.c blockdev: Fix active commit choice 2020-09-07 12:31:31 +02:00
blockjob.c
bootdevice.c
Changelog
CODING_STYLE.rst
configure Add btrfs support 2020-09-04 15:53:56 +01:00
COPYING
COPYING.LIB
cpus-common.c
device_tree.c
disas.c
dma-helpers.c trace: switch position of headers to what Meson requires 2020-08-21 06:18:24 -04:00
exec-vary.c
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
hmp-commands-info.hx
hmp-commands.hx
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
Kconfig.host
LICENSE
MAINTAINERS MAINTAINERS: update nvme entry 2020-09-02 08:48:49 +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.build nbd: disable signals and forking on Windows builds 2020-09-02 16:48:21 -05:00
meson_options.txt meson: add description to options 2020-09-01 08:51:44 -04:00
module-common.c
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
qemu-edid.c
qemu-img-cmds.hx
qemu-img.c qemu-img: Use child access functions 2020-09-07 12:31:31 +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 block: add missing socket_init() calls to tools 2020-09-02 16:47:39 -05:00
qemu-keymap.c
qemu-nbd.c nbd: disable signals and forking on Windows builds 2020-09-02 16:48:21 -05:00
qemu-options-wrapper.h
qemu-options.h
qemu-options.hx qemu-options.hx: Fix typo for netdev documentation 2020-09-01 09:17:58 +02:00
qemu-seccomp.c
qemu.nsi
qemu.sasl
README.rst
replication.c
replication.h
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
VERSION Open 5.2 development tree 2020-08-18 13:44:04 +01:00
version.rc
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>`_