Original Xbox Emulator for Windows, macOS, and Linux (Active Development)
Go to file
Daniel Henrique Barboza 6ca080453e block/snapshot.c: eliminate use of ID input in snapshot operations
At this moment, QEMU attempts to create/load/delete snapshots
by using either an ID (id_str) or a name. The problem is that the code
isn't consistent of whether the entered argument is an ID or a name,
causing unexpected behaviors.

For example, when creating snapshots via savevm <arg>, what happens is that
"arg" is treated as both name and id_str. In a guest without snapshots, create
a single snapshot via savevm:

(qemu) savevm 0
(qemu) info snapshots
List of snapshots present on all disks:
ID        TAG                 VM SIZE                DATE       VM CLOCK
--        0                      741M 2018-07-31 13:39:56   00:41:25.313

A snapshot with name "0" is created. ID is hidden from the user, but the
ID is a non-zero integer that starts at "1". Thus, this snapshot has
id_str=1, TAG="0". Creating a second snapshot with arg = 1, the first one
is deleted:

(qemu) savevm 1
(qemu) info snapshots
List of snapshots present on all disks:
ID        TAG                 VM SIZE                DATE       VM CLOCK
--        1                      741M 2018-07-31 13:42:14   00:41:55.252

What happened?

- when creating the second snapshot, a verification is done inside
bdrv_all_delete_snapshot to delete any existing snapshots that matches an
string argument. Here, the code calls bdrv_all_delete_snapshot("1", ...);

- bdrv_all_delete_snapshot calls bdrv_snapshot_find(..., "1") for each
BlockDriverState of the guest. And this is where things goes tilting:
bdrv_snapshot_find does a search by both id_str and name. It finds
out that there is a snapshot that has id_str = 1, stores a reference
to the snapshot in the sn_info pointer and then returns match found;

- since a match was found, a call to bdrv_snapshot_delete_by_id_or_name() is
made. This function ignores the pointer written by bdrv_snapshot_find. Instead,
it deletes the snapshot using bdrv_snapshot_delete() calling it first with
id_str = 1. If it fails to delete, then it calls it again with name = 1.

- after all that, QEMU creates the new snapshot, that has id_str = 1 and
name = 1. The user is left wondering that happened with the first snapshot
created. Similar bugs can be triggered when using loadvm and delvm.

Before contemplating discarding the use of ID input in these operations,
I've searched the code of what would be the implications. My findings
are:

- the RBD and Sheepdog drivers don't care. Both uses the 'name' field as
key in their logic, making id_str = name when appropriate.
replay-snapshot.c does not make any special use of id_str;

- qcow2 uses id_str as an unique identifier but it is automatically
calculated, not being influenced by user input. Other than that, there are
no distinguish operations made only with id_str;

- in blockdev.c, the delete operation uses a match of both id_str AND
name. Given that id_str is either a copy of 'name' or auto-generated,
we're fine here.

This gives motivation to not consider ID as a valid user input in HMP
commands - sticking with 'name' input only is more consistent. To
accomplish that, the following changes were made in this patch:

- bdrv_snapshot_find() does not match for id_str anymore, only 'name'. The
function is called in save_snapshot(), load_snapshot(), bdrv_all_delete_snapshot()
and bdrv_all_find_snapshot(). This change makes the search function more
predictable and does not change the behavior of any underlying code that uses
these affected functions, which are related to HMP (which is fine) and the
main loop inside vl.c (which doesn't care about it anyways);

- bdrv_all_delete_snapshot() does not call bdrv_snapshot_delete_by_id_or_name
anymore. Instead, it uses the pointer returned by bdrv_snapshot_find to
erase the snapshot with the exact match of id_str an name. This function
is called in save_snapshot and hmp_delvm, thus this change  produces the
intended effect;

- documentation changes to reflect the new behavior. I consider this to
be an API fix instead of an API change - the user was already creating
snapshots using 'name', but now he/she will also enjoy a consistent
behavior.

Ideally we would get rid of the id_str field entirely, but this would have
repercussions on existing snapshots. Another day perhaps.

Signed-off-by: Daniel Henrique Barboza <danielhb413@gmail.com>
Acked-by: Dr. David Alan Gilbert <dgilbert@redhat.com>
Signed-off-by: Kevin Wolf <kwolf@redhat.com>
2019-02-25 15:03:18 +01:00
accel kvm: Add kvm_set_ioeventfd* traces 2019-02-14 11:46:30 +01:00
audio wavcapture: Convert to error_report 2019-02-14 11:46:30 +01:00
backends hostmem: add more information in error messages 2019-01-28 15:52:05 -02:00
block block/snapshot.c: eliminate use of ID input in snapshot operations 2019-02-25 15:03:18 +01:00
bsd-user avoid TABs in files that only contain a few 2019-01-11 15:46:56 +01:00
capstone@22ead3e0bf disas: Add capstone as submodule 2017-10-26 11:56:20 +02:00
chardev char: register spice ports after spice started 2019-02-21 14:09:17 +01:00
contrib * cpu-exec fixes (Emilio, Laurent) 2019-02-05 19:39:22 +00:00
crypto crypto: finish removing TABs 2019-02-05 16:50:18 +01:00
default-configs hw/arm/musca.c: Implement models of the Musca-A and -B1 boards 2019-02-21 18:17:47 +00:00
disas disas: nanoMIPS: Amend DSP instructions related comments 2019-01-24 17:48:33 +01:00
docs qapi: Generate QAPIEvent stuff into separate files 2019-02-18 14:44:04 +01:00
dtc@88f18909db Update dtc/libfdt submodule to v1.4.7 2018-10-02 13:53:26 +10:00
fpu softfloat: enforce softfloat if the host's FMA is broken 2019-01-22 20:48:17 +00:00
fsdev qemu/queue.h: leave head structs anonymous unless necessary 2019-01-11 15:46:55 +01:00
gdb-xml gdbstub: Fix i386/x86_64 machine description and add control registers 2019-02-05 16:50:18 +01:00
hw vga: bugfixes and edid support for virtio-vga 2019-02-25 12:49:07 +00:00
include vga: bugfixes and edid support for virtio-vga 2019-02-25 12:49:07 +00:00
io io: add qio_task_wait_thread to join with a background thread 2019-02-12 17:35:56 +01:00
libdecnumber build: remove CONFIG_LIBDECNUMBER 2017-10-16 18:03:52 +02:00
linux-headers include: update Linux headers to 4.21-rc1/5.0-rc1 2019-02-04 00:08:58 -05:00
linux-user s390x: Fix the confusing contributions-after-2012 license statements 2019-02-18 11:25:43 +01:00
migration migration: introduce pages-per-second 2019-01-23 15:51:47 +00:00
nbd nbd/server: Kill pointless shadowed variable 2019-02-11 14:35:43 -06:00
net char: allow specifying a GMainContext at opening time 2019-02-13 14:23:39 +01:00
pc-bios hw/hppa/dino: mask out lower 2 bits of PCI config addr 2019-02-21 10:16:19 -08:00
po po/Makefile: Modern shell scripting (use $() instead of ``) 2018-10-24 07:39:10 +01:00
qapi ui: add support for -display spice-app 2019-02-25 09:05:41 +00:00
qga qemu/queue.h: simplify reverse access to QTAILQ 2019-01-11 15:46:55 +01:00
qobject json: Fix % handling when not interpolating 2019-01-24 15:20:59 +01:00
qom qom/cpu: Add cluster_index to CPUState 2019-01-29 11:46:05 +00:00
replay replay: Exit on errors reading from replay log 2018-11-08 13:24:35 +00:00
roms Update OpenBIOS images to 3464681b built from submodule. 2019-02-15 10:07:40 +00:00
scripts Revert "qapi-events: add 'if' condition to implicit event enum" 2019-02-18 14:44:05 +01:00
scsi file-posix: Switch to .bdrv_co_ioctl 2018-12-14 11:52:41 +01:00
slirp slirp: wrap the remaining socket functions 2019-02-12 20:49:13 +01:00
stubs qapi: make query-cpu-definitions depend on specific targets 2019-02-18 14:44:05 +01:00
target MIPS queue for February 21st, 2019, v2 2019-02-22 11:26:17 +00:00
tcg tcg: Remove TODO file 2019-02-21 10:22:24 -08:00
tests tests/tcg: target/mips: Add wrappers for MSA integer compare instructions 2019-02-21 19:36:47 +01:00
trace trace: simple style changes 2018-12-12 10:04:59 +00:00
ui display: add -display spice-app launching a Spice client 2019-02-22 07:42:59 +01:00
util slirp: replace global polling with per-instance & notifier 2019-02-07 15:49:08 +02:00
.cirrus.yml .cirrus.yml: basic compile and test for FreeBSD 2019-02-08 17:32:35 +00:00
.dir-locals.el Add .dir-locals.el file to configure emacs coding style 2015-10-08 19:46:01 +03:00
.editorconfig editorconfig: set emacs mode 2018-11-01 12:13:12 +04: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 qapi: Generate QAPIEvent stuff into separate files 2019-02-18 14:44:04 +01:00
.gitmodules gitmodules: use 'https://' instead of 'git://' 2018-11-12 11:26:02 +00:00
.gitpublish Add a git-publish configuration file 2018-03-05 09:03:17 +00:00
.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: fold --disable-tcg into alternate coroutine builds 2019-02-08 17:32:35 +00:00
CODING_STYLE CODING_STYLE: Define our preferred form for multiline comments 2018-06-15 15:23:34 +01: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 preference for g_new instead of g_malloc 2018-05-20 08:32:09 +03:00
LICENSE vfio: move hw/misc/vfio.c to hw/vfio/pci.c Move vfio.h into include/hw/vfio 2014-12-19 15:24:06 -07:00
MAINTAINERS MAINTAINERS: Remove myself as block maintainer 2019-02-25 15:03:18 +01:00
Makefile build: Deal with all of QAPI's .o in qapi/Makefile.objs 2019-02-18 14:44:04 +01:00
Makefile.objs build: Deal with all of QAPI's .o in qapi/Makefile.objs 2019-02-18 14:44:04 +01:00
Makefile.target build: Deal with all of QAPI's .o in qapi/Makefile.objs 2019-02-18 14:44:04 +01:00
README README: use 'https://' instead of 'git://' 2018-11-12 11:26:02 +00:00
VERSION Open 4.0 development tree 2018-12-11 17:27:58 +00: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 bdrv_query_image_info Error parameter added 2019-02-11 14:35:43 -06:00
blockdev-nbd.c nbd/server: Hoist length check to qmp_nbd_server_add 2019-01-21 15:49:51 -06:00
blockdev.c blockdev: acquire aio_context for bitmap add/remove 2019-02-19 17:49:43 -05: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 all: Clean up includes 2016-02-04 17:41:30 +00:00
bt-vhci.c all: Clean up includes 2016-02-04 17:41:30 +00:00
configure build-sys: add gio-2.0 check 2019-02-21 14:09:17 +01:00
cpus-common.c qemu/queue.h: simplify reverse access to QTAILQ 2019-01-11 15:46:55 +01:00
cpus.c cpus: ignore ESRCH in qemu_cpu_kick_thread() 2019-02-05 16:50:16 +01:00
device-hotplug.c blockdev: Convert drive_new() to Error 2018-10-19 14:51:34 +02:00
device_tree.c device_tree.c: Don't use load_image() 2018-12-14 13:30:52 +00:00
disas.c disas: Add RISC-V support 2018-12-26 06:40:02 +11:00
dma-helpers.c block: explicitly acquire aiocontext in bottom halves that need it 2017-02-21 11:39:39 +00:00
dump.c dump: Set correct vaddr for ELF dump 2019-02-06 15:51:12 +01:00
exec.c mmap-alloc: fix hugetlbfs misaligned length in ppc64 2019-02-05 10:58:33 -05:00
gdbstub.c gdbstub: Send a reply to the vKill packet. 2019-02-15 09:56:41 +00:00
gitdm.config contrib: add a basic gitdm config 2018-12-17 08:25:10 +00:00
hmp-commands-info.hx hmp-commands-info: add sync-profile 2018-08-23 18:46:25 +02:00
hmp-commands.hx block/snapshot.c: eliminate use of ID input in snapshot operations 2019-02-25 15:03:18 +01:00
hmp.c - some configure updates (HAX/NetBSD, remove "wav", -Waddress-of-packed-member) 2019-02-14 17:42:25 +00:00
hmp.h hmp-commands: add sync-profile 2018-08-23 18:46:25 +02:00
ioport.c trace: switch to modular code generation for sub-directories 2017-01-31 17:11:18 +00:00
iothread.c iothread: fix iothread hang when stop too soon 2019-02-12 11:49:17 +08: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
memory.c qemu/queue.h: simplify reverse access to QTAILQ 2019-01-11 15:46:55 +01: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
module-common.c all: Clean up includes 2016-02-04 17:41:30 +00:00
monitor.c qmp: Deprecate query-events in favor of query-qmp-schema 2019-02-18 14:44:05 +01: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-monitor: Make device options help nicer 2018-11-05 15:18:04 +01:00
qdict-test-data.txt Introduce QDict test data file 2009-09-04 09:37:34 -05:00
qemu-bridge-helper.c all: Remove unnecessary glib.h includes 2016-06-07 18:19:24 +03:00
qemu-deprecated.texi qmp: Deprecate query-events in favor of query-qmp-schema 2019-02-18 14:44:05 +01:00
qemu-doc.texi qemu-doc: Add nanoMIPS ISA information 2019-01-24 17:48:33 +01:00
qemu-edid.c display/edid: add edid generator to qemu. 2018-09-27 08:07:51 +02:00
qemu-ga.texi qemu-ga: Remove stray 'q' in documentation 2016-10-28 18:17:23 +03:00
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-io: Add generic function for reinitializing optind. 2019-01-31 00:38:19 +01: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 bdrv_query_image_info Error parameter added 2019-02-11 14:35:43 -06: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: Deprecate qemu-nbd --partition 2019-02-04 15:11:27 -06:00
qemu-nbd.texi qemu-nbd: Deprecate qemu-nbd --partition 2019-02-04 15:11:27 -06: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 display: add -display spice-app launching a Spice client 2019-02-22 07:42:59 +01:00
qemu-seccomp.c seccomp: Work-around GCC 4.x bug in gnu99 mode 2019-01-22 06:26:32 +01: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 Default to GSSAPI (Kerberos) instead of DIGEST-MD5 for SASL 2017-05-09 14:41:47 +01:00
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
replication.c replication: Introduce new APIs to do replication operation 2016-09-13 11:00:56 +01:00
replication.h block/replication: Remove protocol_name field 2018-03-26 12:16:00 +02:00
rules.mak test: replace gtester with a TAP driver 2019-01-11 15:46:52 +01:00
thunk.c thunk: assert nb_fields is valid 2017-07-31 13:06:39 +03:00
tpm.c tpm: Clean up error reporting in tpm_init_tpmdev() 2018-10-19 14:51:34 +02:00
trace-events trace: improve runstate tracing 2019-01-25 10:21:27 +00:00
version.rc Use HTTPS for qemu.org and other domains 2017-11-21 13:34:13 +00:00
vl.c - some configure updates (HAX/NetBSD, remove "wav", -Waddress-of-packed-member) 2019-02-14 17:42:25 +00: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

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