QEMU With E2K User Support
Go to file
John Snow 1e4d8b31be python: pin setuptools below v60.0.0
setuptools is a package that replaces the python stdlib 'distutils'. It
is generally installed by all venv-creating tools "by default". It isn't
actually needed at runtime for the qemu package, so our own setup.cfg
does not mention it as a dependency.

However, tox will create virtual environments that include it, and will
upgrade it to the very latest version. the 'venv' tool will also include
whichever version your host system happens to have.

Unfortunately, setuptools version 60.0.0 and above include a hack to
forcibly overwrite python's built-in distutils. The pylint tool that we
use to run code analysis checks on this package relies on distutils and
suffers regressions when setuptools >= 60.0.0 is present at all, see
https://github.com/PyCQA/pylint/issues/5704

Instruct tox and the 'check-dev' targets to avoid setuptools packages
that are too new, for now. Pipenv is unaffected, because setuptools 60
does not offer Python 3.6 support, and our pipenv config is pinned
against Python 3.6.

Signed-off-by: John Snow <jsnow@redhat.com>
Reviewed-by: Beraldo Leal <bleal@redhat.com>
Reviewed-by: Cleber Rosa <crosa@redhat.com>
Tested-by: Cleber Rosa <crosa@redhat.com>
Message-id: 20220121005221.142236-1-jsnow@redhat.com
Signed-off-by: John Snow <jsnow@redhat.com>
2022-01-21 16:01:09 -05:00
.github/workflows
.gitlab/issue_templates
.gitlab-ci.d roms/opensbi: Remove ELF images 2022-01-21 15:52:57 +10: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 docs: move D-Bus VMState documentation to source XML 2021-12-21 10:50:21 +04:00
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 chardev/char-socket: tcp_chr_sync_read: don't clobber errno 2022-01-07 05:19:55 -05:00
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 dump: Remove is_zero_page() 2021-12-15 10:31:42 +01:00
ebpf
fpu softfloat: Add float64r32 arithmetic routines 2021-12-17 17:57:15 +01:00
fsdev
gdb-xml
hw hw/riscv: Remove macros for ELF BIOS image names 2022-01-21 15:52:57 +10:00
include hw/riscv: Remove macros for ELF BIOS image names 2022-01-21 15:52:57 +10:00
io aio-posix: split poll check from ready handler 2022-01-12 17:09:39 +00:00
libdecnumber libdecnumber: Introduce decNumberIntegralToInt128 2021-11-09 10:32:52 +11:00
linux-headers update-linux-headers: Add asm-riscv/kvm.h 2022-01-21 15:52:56 +10:00
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 nbd/client-connection: improve error message of cancelled attempt 2021-12-21 14:52:19 +01:00
net vdpa: Add dummy receive callback 2021-11-28 17:03:52 -05:00
pc-bios roms/opensbi: Remove ELF images 2022-01-21 15:52:57 +10:00
plugins configure: simplify creation of plugin symbol list 2022-01-12 14:09:06 +01:00
po
python python: pin setuptools below v60.0.0 2022-01-21 16:01:09 -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 monitor: Fix find_device_state() for IDs containing slashes 2021-11-10 06:14:51 +01:00
replay
roms roms/opensbi: Remove ELF images 2022-01-21 15:52:57 +10:00
scripts block: drop BLK_PERM_GRAPH_MOD 2022-01-14 12:03:16 +01:00
scsi
semihosting
slirp@a88d9ace23
softmmu softmmu/device_tree: Remove redundant pointer assignment 2022-01-21 15:52:56 +10: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 target/riscv: Relax UXL field for debugging 2022-01-21 15:52:57 +10: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 MAINTAINERS: Change philmd's email address 2021-12-31 13:42:54 +01:00
.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 blockjob: drop BlockJob.blk field 2021-12-28 15:18:59 +01:00
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 linux-user: Add code for PR_GET/SET_UNALIGN 2022-01-06 11:40:52 +01:00
cpus-common.c
disas.c
gdbstub.c gdbstub, kvm: let KVM report supported singlestep flags 2021-12-10 09:47:18 +01:00
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 hmp: Add shortcut to stop command to match cont 2021-11-09 10:11:27 +01:00
iothread.c
job-qmp.c
job.c job.c: add missing notifier initialization 2021-12-28 15:16:31 +01:00
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 ui: add a D-Bus display backend 2021-12-21 10:50:22 +04:00
meson.build target/riscv: enable riscv kvm accel 2022-01-21 15:52:56 +10: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-keymap: Add license in generated files 2021-12-17 10:41:50 +01:00
qemu-nbd.c nbd/server: Add --selinux-label option 2021-11-16 10:16:38 -06:00
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 Open 6.3 development tree 2021-12-14 12:40:12 -08: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>`_