QEMU With E2K User Support
Go to file
Alex Bennée c2118e9e1a configure: don't try a "native" cross for linux-user
As 32 bit x86 become rarer we are starting to run into problems with
search paths. Although we switched to a Debian container we still
favour the native CC on a Bookworm host. As a result we have a broken
cross compile setup which then fails to build with:

    BUILD   i386-linux-user guest-tests
  In file included from /usr/include/linux/stat.h:5,
                   from /usr/include/bits/statx.h:31,
                   from /usr/include/sys/stat.h:465,
                   from /home/alex/lsrc/qemu.git/tests/tcg/multiarch/linux/linux-test.c:28:
  /usr/include/linux/types.h:5:10: fatal error: asm/types.h: No such file or directory
      5 | #include <asm/types.h>
        |          ^~~~~~~~~~~~~
  compilation terminated.
  make[1]: *** [Makefile:119: linux-test] Error 1
  make: *** [/home/alex/lsrc/qemu.git/tests/Makefile.include:50: build-tcg-tests-i386-linux-user] Error 2

This is likely to affect more and more linux-user builds so wrap the
whole check in a test for softmmu targets (aka bare metal) which don't
worry about such header niceties. This allows us to keep using the
host compiler for softmmu tests and the roms.

Signed-off-by: Alex Bennée <alex.bennee@linaro.org>
Message-Id: <20231120150833.2552739-14-alex.bennee@linaro.org>
2023-11-23 14:10:06 +00:00
.github/workflows
.gitlab/issue_templates
.gitlab-ci.d plugins: fix win plugin tests on cross compile 2023-11-23 14:10:04 +00:00
accel accel/tcg: Forward probe size on to notdirty_write 2023-11-14 10:40:54 -08:00
audio
authz
backends
block stream: Fix AioContext locking during bdrv_graph_wrlock() 2023-11-21 12:45:21 +01:00
bsd-user bsd-user: spelling fixes: necesary, agrument, undocummented 2023-11-15 11:09:17 +03:00
chardev
common-user
configs
contrib plugins: fix win plugin tests on cross compile 2023-11-23 14:10:04 +00:00
crypto
disas disas/hppa: Show hexcode of instruction along with disassembly 2023-11-17 18:36:36 +01:00
docs docs/system: clarify limits of using gdbstub in system emulation 2023-11-23 14:10:06 +00:00
dump dump: Add arch cleanup function 2023-11-14 10:42:32 +01:00
ebpf
fpu
fsdev
gdb-xml
gdbstub gdbstub: spelling fix: respectivelly 2023-11-15 11:09:17 +03:00
host/include
hw hw/core: skip loading debug on all failures 2023-11-23 14:10:06 +00:00
include Block layer patches 2023-11-21 10:26:43 -05:00
io
libdecnumber
linux-headers
linux-user linux-user/riscv: Add Zicboz block size to hwprobe 2023-11-22 13:54:02 +10:00
migration migration/rdma.c: spelling fix: asume 2023-11-15 11:59:54 +03:00
monitor hmp: Improve sync-profile error message 2023-11-17 10:07:52 +01:00
nbd
net net: do not delete nics in net_cleanup() 2023-11-21 15:42:34 +08:00
pc-bios target/hppa: Update SeaBIOS-hppa to version 13 2023-11-21 21:23:03 +01:00
plugins plugins: fix win plugin tests on cross compile 2023-11-23 14:10:04 +00:00
po
python
qapi qapi/migration.json: spelling: transfering 2023-11-15 11:09:17 +03:00
qga qga: Improve guest-exec-status error message 2023-11-17 10:07:52 +01:00
qobject
qom
replay
roms target/hppa: Update SeaBIOS-hppa to version 13 2023-11-21 21:23:03 +01:00
scripts block: Fix deadlocks in bdrv_graph_wrunlock() 2023-11-21 12:45:21 +01:00
scsi
semihosting
stats
storage-daemon
stubs
subprojects
system Xen fixes for 8.2-rc1 2023-11-21 10:27:10 -05:00
target target/riscv/cpu_helper.c: Fix mxr bit behavior 2023-11-22 14:03:37 +10:00
tcg tcg/loongarch64: Fix tcg_out_mov() Aborted 2023-11-21 10:32:42 +08:00
tests tests/tcg: enable semiconsole test for Arm 2023-11-23 14:10:06 +00:00
tools
trace
ui ui/console: fix default VC when there are no display 2023-11-21 14:38:14 +04:00
util util/range.c: spelling fix: inbetween 2023-11-15 12:06:05 +03:00
.dir-locals.el
.editorconfig
.exrc
.gdbinit
.git-blame-ignore-revs
.gitattributes
.gitignore
.gitlab-ci.yml
.gitmodules
.gitpublish
.mailmap
.patchew.yml
.readthedocs.yml
.travis.yml
block.c block: Fix deadlocks in bdrv_graph_wrunlock() 2023-11-21 12:45:21 +01:00
blockdev-nbd.c
blockdev.c block: Fix deadlocks in bdrv_graph_wrunlock() 2023-11-21 12:45:21 +01:00
blockjob.c block: Fix deadlocks in bdrv_graph_wrunlock() 2023-11-21 12:45:21 +01:00
configure configure: don't try a "native" cross for linux-user 2023-11-23 14:10:06 +00:00
COPYING
COPYING.LIB
cpu-common.c
cpu-target.c
event-loop-base.c
gitdm.config
hmp-commands-info.hx
hmp-commands.hx
iothread.c
job-qmp.c
job.c
Kconfig
Kconfig.host
LICENSE
MAINTAINERS MAINTAINERS: Add tests/decode/ to the "Overall TCG CPUs" section 2023-11-15 11:09:17 +03:00
Makefile
memory_ldst.c.inc
meson_options.txt
meson.build
module-common.c
os-posix.c
os-win32.c
page-vary-common.c
page-vary-target.c
pythondeps.toml
qemu-bridge-helper.c
qemu-edid.c
qemu-img-cmds.hx
qemu-img.c
qemu-io-cmds.c
qemu-io.c
qemu-keymap.c
qemu-nbd.c
qemu-options.hx
qemu.nsi
qemu.sasl
README.rst
replication.c
trace-events
VERSION Update version for v8.2.0-rc1 release 2023-11-21 13:56:12 -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>`_