Go to file
Kevin Wolf e35bdc123a block: Add auto-read-only option
If a management application builds the block graph node by node, the
protocol layer doesn't inherit its read-only option from the format
layer any more, so it must be set explicitly.

Backing files should work on read-only storage, but at the same time, a
block job like commit should be able to reopen them read-write if they
are on read-write storage. However, without option inheritance, reopen
only changes the read-only option for the root node (typically the
format layer), but not the protocol layer, so reopening fails (the
format layer wants to get write permissions, but the protocol layer is
still read-only).

A simple workaround for the problem in the management tool would be to
open the protocol layer always read-write and to make only the format
layer read-only for backing files. However, sometimes the file is
actually stored on read-only storage and we don't know whether the image
can be opened read-write (for example, for NBD it depends on the server
we're trying to connect to). This adds an option that makes QEMU try to
open the image read-write, but allows it to degrade to a read-only mode
without returning an error.

The documentation for this option is consciously phrased in a way that
allows QEMU to switch to a better model eventually: Instead of trying
when the image is first opened, making the read-only flag dynamic and
changing it automatically whenever the first BLK_PERM_WRITE user is
attached or the last one is detached would be much more useful
behaviour.

Unfortunately, this more useful behaviour is also a lot harder to
implement, and libvirt needs a solution now before it can switch to
-blockdev, so let's start with this easier approach for now.

Instead of adding a new auto-read-only option, turning the existing
read-only into an enum (with a bool alternate for compatibility) was
considered, but it complicated the implementation to the point that it
didn't seem to be worth it.

Signed-off-by: Kevin Wolf <kwolf@redhat.com>
Reviewed-by: Eric Blake <eblake@redhat.com>
2018-11-05 15:09:55 +01:00
accel cputlb: Remove tlb_c.pending_flushes 2018-10-31 12:16:39 +00:00
audio audio: add audio timer trace points 2018-07-03 11:46:47 +02:00
backends hostmem-file: fixed the memory leak while get pmem path. 2018-10-24 06:44:59 -03:00
block block: Add auto-read-only option 2018-11-05 15:09:55 +01:00
bsd-user bsd-user: Use the IEC binary prefix definitions 2018-07-02 15:41:18 +02:00
capstone@22ead3e0bf disas: Add capstone as submodule 2017-10-26 11:56:20 +02:00
chardev chardev: Add websocket support 2018-11-01 12:12:58 +04:00
contrib contrib: add elf2dmp tool 2018-10-02 19:09:12 +02:00
crypto crypto: initialize sector size even when opening with no IO flag 2018-11-05 15:09:54 +01:00
default-configs hw/arm: versal: Add a model of Xilinx Versal SoC 2018-11-02 14:10:53 +00:00
disas target/mips: Add disassembler support for nanoMIPS 2018-10-25 22:13:33 +02:00
docs Minor migration fixes 2018-10-31 2018-11-02 09:49:35 +00:00
dtc@88f18909db Update dtc/libfdt submodule to v1.4.7 2018-10-02 13:53:26 +10:00
fpu qemu/compiler: Wrap __attribute__((flatten)) in a macro 2018-10-17 08:36:28 +02:00
fsdev fsdev: Clean up error reporting in qemu_fsdev_add() 2018-10-19 14:51:34 +02:00
gdb-xml
hw hw/arm: versal: Add a virtual Xilinx Versal board 2018-11-02 14:11:31 +00:00
include block: Add auto-read-only option 2018-11-05 15:09:55 +01:00
io websock: fix handshake leak 2018-11-01 12:12:09 +04:00
libdecnumber build: remove CONFIG_LIBDECNUMBER 2017-10-16 18:03:52 +02:00
linux-headers linux-headers: update to 4.20-rc1 2018-10-19 13:44:11 +02:00
linux-user target/m68k: use EXCP_ILLEGAL instead of EXCP_UNSUPPORTED 2018-11-01 12:12:24 +01:00
migration migration: avoid segmentfault when take a snapshot of a VM which being migrated 2018-10-31 09:38:59 +00:00
nbd nbd: forbid use of frozen bitmaps 2018-10-29 16:23:16 -04:00
net Error reporting patches for 2018-10-22 2018-10-23 17:20:23 +01:00
pc-bios Update OpenBIOS images to 441a84d3 built from submodule. 2018-10-05 09:25:14 +01:00
po po/Makefile: Modern shell scripting (use $() instead of ``) 2018-10-24 07:39:10 +01:00
qapi block: Add auto-read-only option 2018-11-05 15:09:55 +01:00
qga qga-win: changing --retry-path option behavior 2018-10-31 09:04:20 -05:00
qobject qobject: Catch another straggler for use of qdict_put_str() 2018-10-26 17:17:32 +02:00
qom Error reporting patches for 2018-10-22 2018-10-23 17:20:23 +01:00
replay replay: pass raw icount value to replay_save_clock 2018-10-19 13:44:15 +02:00
roms Update OpenBIOS images to 441a84d3 built from submodule. 2018-10-05 09:25:14 +01:00
scripts Updates to decodetree.py for risc-v. 2018-11-01 18:28:29 +00:00
scsi util: add qemu_write_pidfile() 2018-10-02 18:47:55 +02:00
slirp slirp: Implement RFC2132 TFTP server name 2018-10-21 21:24:55 +02:00
stubs Error reporting patches for 2018-10-22 2018-10-23 17:20:23 +01:00
target target/arm: Conditionalize some asserts on aarch32 support 2018-11-02 14:08:38 +00:00
tcg tcg: Split CONFIG_ATOMIC128 2018-10-18 19:46:36 -07:00
tests iotest: Test x-blockdev-change on a Quorum 2018-11-05 15:09:54 +01:00
trace tracing: Use double-dash spelling for trace option 2018-07-19 13:09:04 +01:00
ui spice: prepare for upcoming spice-server change 2018-10-29 14:38:17 +01:00
util bitmap: Update count after a merge 2018-10-29 16:23:17 -04:00
.dir-locals.el
.editorconfig editorconfig: set emacs mode 2018-11-01 12:13:12 +04:00
.exrc
.gdbinit
.gitignore edid: Ignore built binary 2018-10-05 11:20:55 +02:00
.gitmodules gitmodules: add berkeley's softfloat + testfloat version 3 2018-10-05 12:57:41 -05:00
.gitpublish Add a git-publish configuration file 2018-03-05 09:03:17 +00:00
.mailmap mailmap: Add an item for Yongbok Kim 2018-10-18 20:37:20 +02:00
.shippable.yml shippable: Remove Debian 8 libfdt kludge 2018-05-11 14:33:40 +02:00
.travis.yml Travis support for the acceptance tests 2018-10-30 21:13:54 -03:00
arch_init.c arch_init: sort architectures 2018-06-01 19:20:38 +03:00
balloon.c balloon: Allow multiple inhibit users 2018-08-17 09:27:15 -06:00
block.c block: Add auto-read-only option 2018-11-05 15:09:55 +01:00
blockdev-nbd.c nbd/server: drop old-style negotiation 2018-10-03 15:52:32 -05:00
blockdev.c block: Add auto-read-only option 2018-11-05 15:09:55 +01:00
blockjob.c block: Use a single global AioWait 2018-09-25 15:50:15 +02: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 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 qemu-ga patch queue for soft-freeze 2018-11-01 17:26:16 +00:00
COPYING
COPYING.LIB
cpus-common.c qom: convert the CPU list to RCU 2018-08-23 18:46:25 +02:00
cpus.c Error reporting patches for 2018-10-22 2018-10-23 17:20:23 +01:00
device_tree.c device_tree: Add qemu_fdt_node_unit_path 2018-06-29 15:11:01 +01:00
device-hotplug.c blockdev: Convert drive_new() to Error 2018-10-19 14:51:34 +02:00
disas.c RISC-V Disassembler 2018-03-07 08:30:28 +13:00
dma-helpers.c
dump.c qapi: Drop qapi_event_send_FOO()'s Error ** argument 2018-08-28 18:21:38 +02:00
exec.c exec: introduce tlb_init 2018-10-18 18:58:10 -07:00
gdbstub.c gdbstub: Remove unused include 2018-10-16 18:10:55 +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 hmp-commands-info: add sync-profile 2018-08-23 18:46:25 +02:00
hmp-commands.hx hmp-commands: add sync-profile 2018-08-23 18:46:25 +02:00
hmp.c qmp, hmp: make subsystem/system-vendor identities optional 2018-10-11 19:58:26 +01:00
hmp.h hmp-commands: add sync-profile 2018-08-23 18:46:25 +02:00
ioport.c
iothread.c iothread: fix crash with invalid properties 2018-10-12 09:46:14 +08:00
job-qmp.c jobs: canonize Error object 2018-08-31 16:28:33 +02:00
job.c block: Use a single global AioWait 2018-09-25 15:50:15 +02:00
LICENSE
MAINTAINERS MAINTAINERS: Remove bouncing email in ARM ACPI 2018-11-02 14:03:33 +00:00
Makefile Makefile: Install new vgabios binaries 2018-10-15 09:57:33 +02:00
Makefile.objs contrib: add elf2dmp tool 2018-10-02 19:09:12 +02: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 target-i386 : add coalesced_pio API 2018-10-19 13:44:11 +02:00
module-common.c
monitor.c tcg: distribute tcg_time into TCG contexts 2018-10-18 18:58:10 -07:00
numa.c numa: Clean up error reporting in parse_numa() 2018-10-19 14:51:34 +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-monitor: print help to stdout 2018-10-05 16:14:22 +04:00
qdict-test-data.txt
qemu-bridge-helper.c
qemu-deprecated.texi vl.c deprecate incorrect CPUs topology 2018-10-24 06:44:59 -03:00
qemu-doc.texi doc: replace x-root with rootdir for usb-mtp 2018-10-01 10:49:54 +02: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: fix regression copying secrets during convert 2018-08-15 12:50:39 +02: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-cmds: Fix two format strings 2018-11-05 15:09:54 +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 qom: Clean up error reporting in user_creatable_add_opts_foreach() 2018-10-19 14:51:34 +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 chardev: Add websocket support 2018-11-01 12:12:58 +04:00
qemu-seccomp.c seccomp: Clean up error reporting in parse_sandbox() 2018-10-19 14:51:34 +02:00
qemu-tech.texi cli qmp: Mark --preconfig, exit-preconfig experimental 2018-07-16 15:38:19 +02:00
qemu.nsi Use HTTPS for qemu.org and other domains 2017-11-21 13:34:13 +00:00
qemu.sasl
qmp.c cli qmp: Mark --preconfig, exit-preconfig experimental 2018-07-16 15:38:19 +02:00
qtest.c qtest: Use cpu address space instead of system memory 2018-07-06 18:39: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 tpm: Clean up error reporting in tpm_init_tpmdev() 2018-10-19 14:51:34 +02:00
trace-events jobs: remove ret argument to job_completed; privatize it 2018-08-31 16:28:33 +02:00
VERSION Open 3.1 development tree 2018-08-14 17:10:49 +01:00
version.rc Use HTTPS for qemu.org and other domains 2017-11-21 13:34:13 +00:00
vl.c vl:c: make sure that sockets are calculated correctly in '-smp X' case 2018-10-24 06:44:59 -03: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 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