QEMU With E2K User Support
Go to file
Peter Maydell ef011555da hw/intc/arm_gicv3_its: Use enum for return value of process_* functions
When an ITS detects an error in a command, it has an
implementation-defined (CONSTRAINED UNPREDICTABLE) choice of whether
to ignore the command, proceeding to the next one in the queue, or to
stall the ITS command queue, processing nothing further.  The
behaviour required when the read of the command packet from memory
fails is less clearly documented, but the same set of choices as for
command errors seem reasonable.

The intention of the QEMU implementation, as documented in the
comments, is that if we encounter a memory error reading the command
packet or one of the various data tables then we should stall, but
for command parameter errors we should ignore the queue and continue.
However, we don't actually do this.  To get the desired behaviour,
the various process_* functions need to return true to cause
process_cmdq() to advance to the next command and keep processing,
and false to stall command processing.  What they mostly do is return
false for any kind of error.

To make the code clearer, replace the 'bool' return from the process_
functions with an enum which may be either CMD_STALL or CMD_CONTINUE.
In this commit no behaviour changes; in subsequent commits we will
adjust the error-return paths for the process_ functions one by one.

Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
Reviewed-by: Alex Bennée <alex.bennee@linaro.org>
Reviewed-by: Richard Henderson <richard.henderson@linaro.org>
Reviewed-by: Philippe Mathieu-Daudé <f4bug@amsat.org>
Message-id: 20220111171048.3545974-6-peter.maydell@linaro.org
2022-01-20 16:04:58 +00:00
.github/workflows
.gitlab/issue_templates
.gitlab-ci.d FreeBSD: Upgrade to 12.3 release 2022-01-18 16:44:16 +00:00
accel monitor: move x-query-profile into accel/tcg to fix build 2022-01-18 16:42:42 +00:00
audio dsoundaudio: fix crackling audio recordings 2022-01-13 10:47:52 +01:00
authz
backends
block Block layer patches 2022-01-14 15:56:30 +00:00
bsd-user user: move common-user includes to a subdirectory of {bsd,linux}-user/ 2022-01-12 14:08:29 +01:00
capstone@f8b1b83301
chardev
common-user meson: cleanup common-user/ build 2022-01-12 14:08:29 +01:00
configs hw/display: Rename VGA_ISA_MM -> VGA_MMIO 2022-01-13 10:58:54 +01:00
contrib meson: build contrib/ executables after generated headers 2022-01-12 14:09:06 +01:00
crypto
disas target/riscv: setup everything for rv64 to support rv128 execution 2022-01-08 15:46:10 +10:00
docs docs/can: convert to restructuredText 2022-01-20 11:47:52 +00:00
dtc@b6910bec11
dump
ebpf
fpu
fsdev
gdb-xml
hw hw/intc/arm_gicv3_its: Use enum for return value of process_* functions 2022-01-20 16:04:58 +00:00
include hw/arm/aspeed: Add the i3c device to the AST2600 SoC 2022-01-20 16:04:57 +00:00
io aio-posix: split poll check from ready handler 2022-01-12 17:09:39 +00:00
libdecnumber
linux-headers
linux-user Various testing and other misc updates: 2022-01-19 11:49:56 +00:00
meson@12f9f04ba0
migration aio-posix: split poll check from ready handler 2022-01-12 17:09:39 +00:00
monitor monitor: move x-query-profile into accel/tcg to fix build 2022-01-18 16:42:42 +00:00
nbd
net
pc-bios seabios: update binaries to snapshot 2022-01-18 12:19:36 +01:00
plugins configure: simplify creation of plugin symbol list 2022-01-12 14:09:06 +01:00
po
python python: update type hints for mypy 0.930 2022-01-10 18:22:59 -05:00
qapi monitor: move x-query-profile into accel/tcg to fix build 2022-01-18 16:42:42 +00:00
qga qga-win: Detect Windows 11 by build number 2022-01-10 13:05:25 +00:00
qobject
qom
replay
roms seabios: update submodule to snapshot 2022-01-18 12:19:15 +01:00
scripts block: drop BLK_PERM_GRAPH_MOD 2022-01-14 12:03:16 +01:00
scsi
semihosting
slirp@a88d9ace23
softmmu trivial patches pull request 20220118 2022-01-18 22:27:13 +00:00
storage-daemon qemu-storage-daemon: Add vhost-user-blk help 2022-01-14 12:03:16 +01:00
stubs hw/pci: Restrict pci-bus stub to sysemu 2022-01-18 10:45:35 +01:00
subprojects/libvhost-user
target hw/arm/virt: KVM: Enable PAuth when supported by the host 2022-01-20 11:47:52 +00:00
tcg exec/memop: Adding signedness to quad definitions 2022-01-08 15:46:10 +10:00
tests tests/acpi/bios-table-test: Update expected virt/PPTT file 2022-01-20 11:47:52 +00:00
tools
trace
ui spice: Update QXLInterface for spice >= 0.15.0 2022-01-18 16:42:41 +00:00
util Pull request 2022-01-14 10:43:32 +00:00
.cirrus.yml
.dir-locals.el
.editorconfig
.exrc
.gdbinit
.gitattributes
.gitignore
.gitlab-ci.yml
.gitmodules tests: integrate lcitool for generating build env manifests 2022-01-18 16:42:41 +00:00
.gitpublish
.mailmap
.patchew.yml
.readthedocs.yml
.travis.yml
block.c block: drop BLK_PERM_GRAPH_MOD 2022-01-14 12:03:16 +01:00
blockdev-nbd.c
blockdev.c include/sysemu/blockdev.h: remove drive_get_max_devs 2022-01-14 12:03:16 +01:00
blockjob.c
configure configure: do not create roms/seabios/config.mak if SeaBIOS not present 2022-01-12 14:09:06 +01:00
COPYING
COPYING.LIB
cpu.c
cpus-common.c
disas.c
gdbstub.c
gitdm.config
hmp-commands-info.hx monitor: move x-query-profile into accel/tcg to fix build 2022-01-18 16:42:42 +00:00
hmp-commands.hx
iothread.c
job-qmp.c
job.c
Kconfig
Kconfig.host
LICENSE
MAINTAINERS hw/net: Move MV88W8618 network device out of hw/arm/ directory 2022-01-20 11:47:52 +00:00
Makefile tests: integrate lcitool for generating build env manifests 2022-01-18 16:42:41 +00:00
memory_ldst.c.inc
meson_options.txt
meson.build meson: require liburing >= 0.3 2022-01-18 16:42:41 +00:00
module-common.c
os-posix.c
os-win32.c
page-vary-common.c
page-vary.c
qemu-bridge-helper.c
qemu-edid.c edid: set default resolution to 1280x800 (WXGA) 2022-01-13 10:59:16 +01:00
qemu-img-cmds.hx
qemu-img.c qemu-img: make is_allocated_sectors() more efficient 2022-01-14 12:03:16 +01:00
qemu-io-cmds.c
qemu-io.c
qemu-keymap.c
qemu-nbd.c
qemu-options.hx hw/arm/virt: Support CPU cluster on ARM virt machine 2022-01-20 11:47:52 +00:00
qemu.nsi
qemu.sasl
README.rst
replication.c
trace-events
VERSION
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>`_