Go to file
Carlos López e4dd39c699 vhost: avoid a potential use of an uninitialized variable in vhost_svq_poll()
In vhost_svq_poll(), if vhost_svq_get_buf() fails due to a device
providing invalid descriptors, len is left uninitialized and returned
to the caller, potentally leaking stack data or causing undefined
behavior.

Fix this by initializing len to 0.

Found with GCC 13 and -fanalyzer (abridged):

../hw/virtio/vhost-shadow-virtqueue.c: In function ‘vhost_svq_poll’:
../hw/virtio/vhost-shadow-virtqueue.c:538:12: warning: use of uninitialized value ‘len’ [CWE-457] [-Wanalyzer-use-of-uninitialized-value]
  538 |     return len;
      |            ^~~
  ‘vhost_svq_poll’: events 1-4
    |
    |  522 | size_t vhost_svq_poll(VhostShadowVirtqueue *svq)
    |      |        ^~~~~~~~~~~~~~
    |      |        |
    |      |        (1) entry to ‘vhost_svq_poll’
    |......
    |  525 |     uint32_t len;
    |      |              ~~~
    |      |              |
    |      |              (2) region created on stack here
    |      |              (3) capacity: 4 bytes
    |......
    |  528 |         if (vhost_svq_more_used(svq)) {
    |      |             ~
    |      |             |
    |      |             (4) inlined call to ‘vhost_svq_more_used’ from ‘vhost_svq_poll’

    (...)

    |  528 |         if (vhost_svq_more_used(svq)) {
    |      |            ^~~~~~~~~~~~~~~~~~~~~~~~~
    |      |            ||
    |      |            |(8) ...to here
    |      |            (7) following ‘true’ branch...
    |......
    |  537 |     vhost_svq_get_buf(svq, &len);
    |      |     ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    |      |     |
    |      |     (9) calling ‘vhost_svq_get_buf’ from ‘vhost_svq_poll’
    |
    +--> ‘vhost_svq_get_buf’: events 10-11
           |
           |  416 | static VirtQueueElement *vhost_svq_get_buf(VhostShadowVirtqueue *svq,
           |      |                          ^~~~~~~~~~~~~~~~~
           |      |                          |
           |      |                          (10) entry to ‘vhost_svq_get_buf’
           |......
           |  423 |     if (!vhost_svq_more_used(svq)) {
           |      |          ~
           |      |          |
           |      |          (11) inlined call to ‘vhost_svq_more_used’ from ‘vhost_svq_get_buf’
           |

           (...)

           |
         ‘vhost_svq_get_buf’: event 14
           |
           |  423 |     if (!vhost_svq_more_used(svq)) {
           |      |        ^
           |      |        |
           |      |        (14) following ‘false’ branch...
           |
         ‘vhost_svq_get_buf’: event 15
           |
           |cc1:
           | (15): ...to here
           |
    <------+
    |
  ‘vhost_svq_poll’: events 16-17
    |
    |  537 |     vhost_svq_get_buf(svq, &len);
    |      |     ^~~~~~~~~~~~~~~~~~~~~~~~~~~~
    |      |     |
    |      |     (16) returning to ‘vhost_svq_poll’ from ‘vhost_svq_get_buf’
    |  538 |     return len;
    |      |            ~~~
    |      |            |
    |      |            (17) use of uninitialized value ‘len’ here

Note by  Laurent Vivier <lvivier@redhat.com>:

    The return value is only used to detect an error:

    vhost_svq_poll
        vhost_vdpa_net_cvq_add
            vhost_vdpa_net_load_cmd
                vhost_vdpa_net_load_mac
                  -> a negative return is only used to detect error
                vhost_vdpa_net_load_mq
                  -> a negative return is only used to detect error
            vhost_vdpa_net_handle_ctrl_avail
              -> a negative return is only used to detect error

Fixes: d368c0b052 ("vhost: Do not depend on !NULL VirtQueueElement on vhost_svq_flush")
Signed-off-by: Carlos López <clopez@suse.de>
Message-Id: <20230213085747.19956-1-clopez@suse.de>
Reviewed-by: Michael S. Tsirkin <mst@redhat.com>
Signed-off-by: Michael S. Tsirkin <mst@redhat.com>
2023-03-02 19:13:51 -05:00
.github/workflows
.gitlab/issue_templates .gitlab/issue_templates: Move suggestions into comments 2022-12-15 15:19:24 +01:00
.gitlab-ci.d gitlab-ci.d/base: Mark jobs as interruptible by default 2023-02-27 09:23:21 +01:00
accel hw/cpu: Extend CPUState::cluster_index documentation 2023-02-27 22:29:01 +01:00
audio Fix non-first inclusions of qemu/osdep.h 2023-02-08 07:28:05 +01:00
authz error: Drop superfluous #include "qapi/qmp/qerror.h" 2023-02-23 13:56:14 +01:00
backends backends/vhost-user: remove the ioeventfd check 2023-03-02 03:10:47 -05:00
block block/vvfat: Remove pointless check of NDEBUG 2023-02-27 22:29:02 +01:00
bsd-user bsd-user/mmap: use TSA_NO_TSA to suppress clang TSA warnings in FreeBSD 2023-02-17 11:22:19 +01:00
chardev io: Add support for MSG_PEEK for socket channel 2023-02-06 19:22:56 +01:00
common-user common-user/host/ppc: Implement safe-syscall.inc.S 2023-01-23 14:39:48 -10:00
configs target/microblaze: Add gdbstub xml 2023-02-21 08:52:17 -10:00
contrib Updated the FSF address to <https://www.gnu.org/licenses/> 2023-02-27 09:15:39 +01:00
crypto crypto: TLS: introduce check_pending 2023-02-15 11:01:03 -05:00
disas target/riscv: update disas.c for xnor/orn/andn and slli.uw 2023-02-07 08:19:22 +10:00
docs docs: vhost-user: replace _SLAVE_ with _BACKEND_ 2023-03-02 03:10:47 -05:00
dtc@b6910bec11
dump dump: Add create_win_dump() stub for non-x86 targets 2023-02-27 22:29:02 +01:00
ebpf
fpu softfloat: logB(0) should raise divideByZero exception 2022-10-17 10:28:35 +08:00
fsdev Don't include headers already included by qemu/osdep.h 2023-02-08 07:28:05 +01:00
gdb-xml target/microblaze: Add gdbstub xml 2023-02-21 08:52:17 -10:00
gdbstub replay: Extract core API to 'exec/replay-core.h' 2023-02-27 22:29:01 +01:00
hw vhost: avoid a potential use of an uninitialized variable in vhost_svq_poll() 2023-03-02 19:13:51 -05:00
include pcie: drop unused PCIExpressIndicator 2023-03-02 03:10:49 -05:00
io io/channel-tls: fix handling of bigger read buffers 2023-02-15 11:01:04 -05:00
libdecnumber libdecnumber/dpd/decimal64: Fix compiler warning from Clang 15 2022-11-11 09:13:52 +01:00
linux-headers linux-headers: Update to v6.2-rc8 2023-02-16 12:13:46 -07:00
linux-user linux-user/microblaze: Handle privileged exception 2023-02-21 08:44:13 -10:00
meson@3a9b285a55 meson: require 0.61.3 2022-10-01 21:16:36 +02:00
migration migration/colo: Improve an x-colo-lost-heartbeat error message 2023-02-23 14:10:17 +01:00
monitor monitor: Rename misc.c to hmp-target.c 2023-02-04 07:56:54 +01:00
nbd include/block: Untangle inclusion loops 2023-01-20 07:24:28 +01:00
net vdpa: fix VHOST_BACKEND_F_IOTLB_ASID flag check 2023-02-17 13:31:33 +08:00
pc-bios meson: fix dependency on qemu-keymap 2023-02-27 09:15:39 +01:00
plugins plugins: Iterate on cb_lists in qemu_plugin_user_exit 2023-02-02 11:48:20 +00:00
po
python python: drop pipenv 2023-02-22 23:35:03 -05:00
qapi block/rbd: Add support for layered encryption 2023-02-23 19:49:35 +01:00
qga qga: Drop dangling reference to QERR_QGA_LOGGING_DISABLED 2023-02-23 14:10:17 +01:00
qobject
qom qom/object_interfaces: Fix QAPI headers included 2023-02-27 22:29:01 +01:00
replay replay: Simplify setting replay blockers 2023-02-23 14:10:17 +01:00
roms hw/misc/sga: Remove the deprecated "sga" device 2023-02-14 09:02:42 +01:00
scripts - buildsys 2023-02-28 15:09:18 +00:00
scsi io: Add support for MSG_PEEK for socket channel 2023-02-06 19:22:56 +01:00
semihosting semihosting: add O_BINARY flag in host_open for NT compatibility 2023-02-02 11:48:20 +00:00
softmmu softmmu: Extract watchpoint API from physmem.c 2023-02-27 22:29:01 +01:00
stats stats: Move HMP commands from monitor/ to stats/ 2023-02-04 07:56:54 +01:00
storage-daemon monitor: Loosen coupling between misc.c and monitor.c slightly 2023-02-04 07:56:54 +01:00
stubs replay: Extract core API to 'exec/replay-core.h' 2023-02-27 22:29:01 +01:00
subprojects libvhost-user: Adopt new backend naming 2023-03-02 03:10:47 -05:00
target - buildsys 2023-02-28 15:09:18 +00:00
tcg tcg/tcg-op-gvec: Remove unused "qemu/main-loop.h" header 2023-02-27 22:29:01 +01:00
tests - buildsys 2023-02-28 15:09:18 +00:00
tools virtiofsd: Remove source 2023-02-16 18:15:08 +00:00
trace trace: Do not try to include QMP commands in user emulation binaries 2023-02-27 22:29:01 +01:00
ui ui/cocoa: user friendly characters for release mouse 2023-02-27 22:29:02 +01:00
util replay: Extract core API to 'exec/replay-core.h' 2023-02-27 22:29:01 +01:00
.cirrus.yml
.dir-locals.el
.editorconfig
.exrc
.gdbinit
.gitattributes
.gitignore .gitignore: add multiple items to .gitignore 2022-10-22 22:48:17 +02:00
.gitlab-ci.yml
.gitmodules hw/misc/sga: Remove the deprecated "sga" device 2023-02-14 09:02:42 +01:00
.gitpublish
.mailmap mailmap: Fix Stefan Weil author email 2022-12-13 15:56:57 -05:00
.patchew.yml
.readthedocs.yml
.travis.yml travis.yml: Remove the generic addons section 2023-01-26 13:25:07 +01:00
block.c block: Mark bdrv_co_refresh_total_sectors() and callers GRAPH_RDLOCK 2023-02-23 19:49:33 +01:00
blockdev-nbd.c qapi block: Elide redundant has_FOO in generated C 2022-12-14 20:03:25 +01:00
blockdev.c block: Convert bdrv_is_inserted() to co_wrapper 2023-02-01 16:52:32 +01:00
blockjob.c include/block: Untangle inclusion loops 2023-01-20 07:24:28 +01:00
configure * New Sapphire Rapids model support 2023-02-27 18:23:58 +00:00
COPYING
COPYING.LIB
cpu.c replay: Extract core API to 'exec/replay-core.h' 2023-02-27 22:29:01 +01:00
cpus-common.c cpu: Move breakpoint helpers to common code 2023-02-27 22:28:54 +01:00
disas.c target/loongarch: Enable the disassembler for host tcg 2023-01-23 15:36:36 -10:00
event-loop-base.c
gitdm.config
hmp-commands-info.hx hmp: add virtio commands 2022-10-09 16:38:45 -04:00
hmp-commands.hx monitor: Move remaining HMP commands from misc.c to hmp-cmds.c 2023-02-04 07:56:54 +01:00
iothread.c iothread: Remove unused IOThreadClass / IOTHREAD_CLASS 2023-02-27 13:27:05 +00:00
job-qmp.c qapi job: Elide redundant has_FOO in generated C 2022-12-14 20:04:47 +01:00
job.c block: remove bdrv_try_set_aio_context and replace it with bdrv_try_change_aio_context 2022-10-27 20:14:11 +02:00
Kconfig
Kconfig.host
LICENSE
MAINTAINERS - buildsys 2023-02-28 15:09:18 +00:00
Makefile Makefile: allow 'make uninstall' 2023-01-18 10:06:34 +01:00
memory_ldst.c.inc
meson_options.txt meson: stop looking for 'sphinx-build-3' 2023-02-27 11:01:30 +01:00
meson.build cpu: Remove capstone meson dependency 2023-02-27 22:28:54 +01:00
module-common.c
os-posix.c Refactoring: refactor TFR() macro to RETRY_ON_EINTR() 2023-01-09 13:50:47 +01:00
os-win32.c
page-vary-common.c
page-vary.c
qemu-bridge-helper.c
qemu-edid.c qemu-edid: Restrict input parameter -d to avoid division by zero 2022-10-12 13:38:15 +02:00
qemu-img-cmds.hx
qemu-img.c block: Mark bdrv_co_copy_range() GRAPH_RDLOCK 2023-02-23 19:49:20 +01:00
qemu-io-cmds.c qemu-io: add -r option to register I/O buffer 2023-02-09 10:22:30 -05:00
qemu-io.c
qemu-keymap.c qemu-keymap: Silence memory leak warning from Clang's sanitizer 2023-02-27 09:15:39 +01:00
qemu-nbd.c qapi block: Elide redundant has_FOO in generated C 2022-12-14 20:03:25 +01:00
qemu-options.hx net: stream: add a new option to automatically reconnect 2023-02-17 13:31:33 +08:00
qemu.nsi
qemu.sasl
README.rst
replication.c
trace-events accel/tcg: Remove trace events from trace-root.h 2022-12-20 17:11:12 -08:00
VERSION Open 8.0 development tree 2022-12-13 15:56:26 -05:00
version.rc

===========
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.


Documentation
=============

Documentation can be found hosted online at
`<https://www.qemu.org/documentation/>`_. The documentation for the
current development version that is available at
`<https://www.qemu.org/docs/master/>`_ is generated from the ``docs/``
folder in the source tree, and is built by `Sphinx
<https://www.sphinx-doc.org/en/master/>`_.


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://wiki.qemu.org/Hosts/Linux>`_
* `<https://wiki.qemu.org/Hosts/Mac>`_
* `<https://wiki.qemu.org/Hosts/W32>`_


Submitting patches
==================

The QEMU source code is maintained under the GIT version control system.

.. code-block:: shell

   git clone https://gitlab.com/qemu-project/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 `style section
<https://www.qemu.org/docs/master/devel/style.html>`_ of
the Developers Guide.

Additional information on submitting patches can be found online via
the QEMU website

* `<https://wiki.qemu.org/Contribute/SubmitAPatch>`_
* `<https://wiki.qemu.org/Contribute/TrivialPatches>`_

The QEMU website is also maintained under source control.

.. code-block:: shell

  git clone https://gitlab.com/qemu-project/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 GitLab issues to track bugs. Bugs
found when running code built from QEMU git or upstream released sources
should be reported via:

* `<https://gitlab.com/qemu-project/qemu/-/issues>`_

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 GitLab.

For additional information on bug reporting consult:

* `<https://wiki.qemu.org/Contribute/ReportABug>`_


ChangeLog
=========

For version history and release notes, please visit
`<https://wiki.qemu.org/ChangeLog/>`_ or look at the git history for
more detailed information.


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://wiki.qemu.org/Contribute/StartHere>`_