Original Xbox Emulator for Windows, macOS, and Linux (Active Development)
Go to file
Jonathan Davies f30815390a usb: drop unnecessary usb_device_post_load checks
In usb_device_post_load, certain values of dev->setup_len or
dev->setup_index can cause -EINVAL to be returned. One example is when
setup_len exceeds 4096, the hard-coded value of sizeof(dev->data_buf).
This can happen through legitimate guest activity and will cause all
subsequent attempts to migrate the guest to fail in vmstate_load_state.

The values of these variables can be set by USB packets originating in
the guest. There are two ways in which they can be set: in
do_token_setup and in do_parameter in hw/usb/core.c.

It is easy to craft a USB packet in a guest that causes do_token_setup
to set setup_len to a value larger than 4096. When this has been done
once, all subsequent attempts to migrate the VM will fail in
usb_device_post_load until the VM is next power-cycled or a
smaller-sized USB packet is sent to the device.

Sample code for achieving this in a VM started with "-device usb-tablet"
running Linux with CONFIG_HIDRAW=y and HID_MAX_BUFFER_SIZE > 4096:

  #include <sys/types.h>
  #include <sys/stat.h>
  #include <fcntl.h>
  #include <unistd.h>

  int main() {
           char buf[4097];
           int fd = open("/dev/hidraw0", O_RDWR|O_NONBLOCK);

           buf[0] = 0x1;
           write(fd, buf, 4097);

           return 0;
  }

When this code is run in the VM, qemu will output:

  usb_generic_handle_packet: ctrl buffer too small (4097 > 4096)

A subsequent attempt to migrate the VM will fail and output the
following on the destination host:

  qemu-kvm: error while loading state for instance 0x0 of device '0000:00:06.7/1/usb-ptr'
  qemu-kvm: load of migration failed: Invalid argument

The idea behind checking the values of setup_len and setup_index before
they are used is correct, but doing it in usb_device_post_load feels
arbitrary, and will cause unnecessary migration failures. Indeed, none
of the commit messages for c60174e8, 9f8e9895 and 719ffe1f justify why
post_load is the right place to do these checks. They correctly point
out that the important thing to protect is the usb_packet_copy.

Instead, the right place to do the checks is in do_token_setup and
do_parameter. Indeed, there are already some checks here. We can examine
each of the disjuncts currently tested in usb_device_post_load to see
whether any need adding to do_token_setup or do_parameter to improve
safety there:

  * dev->setup_index < 0
     - This test is not needed because setup_index is explicitly set to
0 in do_token_setup and do_parameter.

  * dev->setup_len < 0
     - In both do_token_setup and do_parameter, the value of setup_len
is computed by (s->setup_buf[7] << 8) | s->setup_buf[6]. Since
s->setup_buf is a byte array and setup_len is an int32_t, it's
impossible for this arithmetic to set setup_len's top bit, so it can
never be negative.

  * dev->setup_index > dev->setup_len
     - Since setup_index is 0, this is equivalent to the previous test,
so is redundant.

  * dev->setup_len > sizeof(dev->data_buf)
     - This condition is already explicitly checked in both
do_token_setup and do_parameter.

Hence there is no need to bolster the existing checks in do_token_setup
or do_parameter, and we can safely remove these checks from
usb_device_post_load without reducing safety but allowing migrations to
proceed regardless of what USB packets have been generated by the guest.

Signed-off-by: Jonathan Davies <jonathan.davies@nutanix.com>
Message-Id: <20190107175117.23769-1-jonathan.davies@nutanix.com>
Signed-off-by: Gerd Hoffmann <kraxel@redhat.com>
2019-01-08 12:37:52 +01:00
accel tcg: Add RISC-V cpu signal handler 2018-12-26 06:40:02 +11:00
audio audio/alsaaudio: Remove compiler check around pragma 2018-12-12 10:01:13 +01:00
backends hostmem: Validate host-nodes before setting bitmap 2018-12-11 15:45:22 -02:00
block dmg: don't skip zero chunk 2019-01-04 11:15:09 +00: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 char: add a QEMU_CHAR_FEATURE_GCONTEXT flag 2018-12-12 09:55:57 +01:00
contrib contrib/rdmacm-mux: Add implementation of RDMA User MAD multiplexer 2018-12-22 11:09:56 +02:00
crypto crypto: support multiple threads accessing one QCryptoBlock 2018-12-12 11:16:49 +00:00
default-configs RISC-V Changes for 3.2, Part 1 2019-01-03 13:26:30 +00:00
disas disas: nanoMIPS: Add a note on documentation 2019-01-03 17:52:52 +01:00
docs docs: Update pvrdma device documentation 2018-12-22 11:09:57 +02:00
dtc@88f18909db Update dtc/libfdt submodule to v1.4.7 2018-10-02 13:53:26 +10:00
fpu hardfloat: implement float32/64 comparison 2018-12-17 08:25:25 +00:00
fsdev 9p: remove support for the "handle" backend 2018-12-12 14:18:10 +01:00
gdb-xml s390x/gdb: add gs registers 2017-07-14 12:29:49 +02:00
hw usb: drop unnecessary usb_device_post_load checks 2019-01-08 12:37:52 +01:00
include fw_cfg: Make qemu_extra_params_fw locally 2019-01-04 15:30:52 +01:00
io io: return 0 for EOF in TLS session read after shutdown 2018-11-19 11:16:46 -06: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 linux-user: Add safe_syscall for riscv64 host 2018-12-26 06:40:02 +11:00
migration qmp hmp: Make system_wakeup check wake-up support and run state 2018-12-18 07:55:47 +01:00
nbd nbd/server: Advertise all contexts in response to bare LIST 2018-11-30 13:55:18 -06:00
net colo: check chardev can switch context 2018-12-12 09:55:57 +01:00
pc-bios update seabios to 1.12 2018-11-20 06:57:53 +01:00
po po/Makefile: Modern shell scripting (use $() instead of ``) 2018-10-24 07:39:10 +01:00
qapi qapi: Define new QMP message for pvrdma 2018-12-22 11:09:56 +02:00
qga Trivial patches (2018-12-18) 2018-12-19 15:31:02 +00:00
qobject json: Fix to reject duplicate object member names 2018-12-13 19:20:11 +01:00
qom qom: remove unimplemented class_finalize 2018-12-11 15:45:23 -02:00
replay replay: Exit on errors reading from replay log 2018-11-08 13:24:35 +00:00
roms update seabios to 1.12 2018-11-20 06:57:53 +01:00
scripts qapi: fix flat union on uncovered branches conditionals 2018-12-18 07:57:36 +01:00
scsi file-posix: Switch to .bdrv_co_ioctl 2018-12-14 11:52:41 +01:00
slirp slirp: fork_exec(): create and connect child socket before fork() 2018-11-10 15:07:53 +01:00
stubs Error reporting patches for 2018-10-22 2018-10-23 17:20:23 +01:00
target MIPS queue for December 2018 - v3 2019-01-04 10:11:18 +00:00
tcg tcg: Improve call argument loading 2018-12-26 06:58:43 +11:00
tests tests/tcg: mips: Test R5900 three-operand MADDU1 2019-01-03 17:52:52 +01:00
trace trace: simple style changes 2018-12-12 10:04:59 +00:00
ui ui: Allow specifying 'rendernode' display option for egl-headless 2018-11-16 11:44:22 +01:00
util Clean up includes 2018-12-20 10:29:08 +01: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: Reduce Makefile boilerplate 2018-12-11 18:28:46 +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: split MacOSX builds and reduce target list 2018-11-14 10:20:23 +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 block: Assert that flags are up-to-date in bdrv_reopen_prepare() 2018-12-14 11:55:02 +01:00
blockdev-nbd.c nbd/server: drop old-style negotiation 2018-10-03 15:52:32 -05:00
blockdev.c error: Remove NULL checks on error_propagate() calls 2018-12-18 14:57:48 +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 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
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 configure: Add support for building RISC-V host 2018-12-26 06:40:02 +11:00
COPYING
COPYING.LIB
cpus-common.c qom: convert the CPU list to RCU 2018-08-23 18:46:25 +02:00
cpus.c cpus: run work items for all vCPUs if single-threaded 2018-11-27 15:06:14 +01: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 block: explicitly acquire aiocontext in bottom halves that need it 2017-02-21 11:39:39 +00:00
dump.c qapi: Drop qapi_event_send_FOO()'s Error ** argument 2018-08-28 18:21:38 +02:00
exec.c Rename cpu_physical_memory_write_rom() to address_space_write_rom() 2018-12-14 13:30:48 +00:00
gdbstub.c gdbstub: Remove unused include 2018-10-16 18:10:55 +02:00
gitdm.config contrib: add a basic gitdm config 2018-12-17 08:25:10 +00: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 Deprecate HMP cpu-add 2018-12-11 15:45:22 -02:00
hmp.c qmp hmp: Make system_wakeup check wake-up support and run state 2018-12-18 07:55:47 +01: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 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 job: Fix off-by-one assert checks for JobSTT and JobVerbTable 2018-11-12 17:49:21 +01: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 MIPS queue for December 2018 - v3 2019-01-04 10:11:18 +00:00
Makefile contrib/rdmacm-mux: Add implementation of RDMA User MAD multiplexer 2018-12-22 11:09:56 +02:00
Makefile.objs qapi: Define new QMP message for pvrdma 2018-12-22 11:09:56 +02:00
Makefile.target configure: Remove old -fno-gcse workaround for GCC 4.6.x and 4.7.[012] 2018-12-12 10:01:12 +01:00
memory_ldst.inc.c exec: Fix MAP_RAM for cached access 2018-06-28 19:05:30 +02:00
memory_mapping.c memory-mapping: skip non-volatile memory regions in GuestPhysBlockList 2018-11-06 21:35:05 +01:00
memory.c memory: learn about non-volatile memory region 2018-11-06 21:35:05 +01:00
module-common.c all: Clean up includes 2016-02-04 17:41:30 +00:00
monitor.c miscellaneous patches: 2018-12-16 16:32:43 +00: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: Make device options help nicer 2018-11-05 15:18:04 +01:00
qdict-test-data.txt
qemu-bridge-helper.c all: Remove unnecessary glib.h includes 2016-06-07 18:19:24 +03:00
qemu-deprecated.texi hw/i386: Remove deprecated machines pc-0.10 and pc-0.11 2018-12-20 11:19:12 -05: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-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-img: Fix leak 2018-11-21 15:17:46 +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 block: Remove flags parameter from bdrv_reopen_queue() 2018-12-14 11:55:02 +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 nbd: Add qemu-nbd -D for human-readable description 2016-11-02 09:28:55 +01: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 9p: remove support for the "handle" backend 2018-12-12 14:18:10 +01: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 Default to GSSAPI (Kerberos) instead of DIGEST-MD5 for SASL 2017-05-09 14:41:47 +01:00
qmp.c qmp hmp: Make system_wakeup check wake-up support and run state 2018-12-18 07:55:47 +01:00
qtest.c qtest: Use cpu address space instead of system memory 2018-07-06 18:39:19 +02:00
README README: use 'https://' instead of 'git://' 2018-11-12 11:26:02 +00: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 tests/docker/Makefile.include: handle empty TARGET_LIST 2018-06-04 14:39:18 +08: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 jobs: remove ret argument to job_completed; privatize it 2018-08-31 16:28:33 +02:00
VERSION Open 4.0 development tree 2018-12-11 17:27:58 +00:00
version.rc Use HTTPS for qemu.org and other domains 2017-11-21 13:34:13 +00:00
vl.c fw_cfg: Make qemu_extra_params_fw locally 2019-01-04 15:30:52 +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