QEMU With E2K User Support
Go to file
Alex Bennée bda8bebad0 docs/devel: mention our .editorconfig
Ideally we should keep all our automatic formatting gubins in here.

Signed-off-by: Alex Bennée <alex.bennee@linaro.org>
Reviewed-by: Richard Henderson <richard.henderson@linaro.org>
Tested-by: Philippe Mathieu-Daudé <f4bug@amsat.org>
Reviewed-by: Philippe Mathieu-Daudé <f4bug@amsat.org>
Message-Id: <20220204204335.1689602-13-alex.bennee@linaro.org>
2022-02-09 12:08:42 +00:00
.github/workflows
.gitlab/issue_templates
.gitlab-ci.d tests: Manually remove libxml2 on MSYS2 runners 2022-02-09 12:08:42 +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 docs: move D-Bus VMState documentation to source XML 2021-12-21 10:50:21 +04:00
block drop libxml2 checks since libxml is not actually used (for parallels) 2022-02-09 12:08:42 +00:00
bsd-user bsd-user/signal.c: Only copy the _capsicum for FreeBSD_version > 1400026 2022-02-01 14:43:20 -07: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/devel: mention our .editorconfig 2022-02-09 12:08:42 +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/sensor: Add lsm303dlhc magnetometer device 2022-02-08 10:56:29 +00:00
include hw/intc/arm_gicv3_its: Drop TableDesc and CmdQDesc valid fields 2022-02-08 10:56:29 +00:00
io aio-posix: split poll check from ready handler 2022-01-12 17:09:39 +00:00
libdecnumber
linux-headers update-linux-headers: Add asm-riscv/kvm.h 2022-01-21 15:52:56 +10:00
linux-user linux-user/syscall: Translate TARGET_RLIMIT_RTTIME 2022-02-01 08:01:44 +01:00
meson@12f9f04ba0
migration migration: Move temp page setup and cleanup into separate functions 2022-01-28 15:38:23 +01:00
monitor migration: Tally pre-copy, downtime and post-copy bytes independently 2022-01-28 15:38:23 +01:00
nbd nbd/server.c: Remove unused field 2022-01-28 16:48:28 -06:00
net rtc: Move RTC function prototypes to their own header 2022-01-28 14:29:46 +00:00
pc-bios Fixes and updates for hppa target 2022-02-02 19:54:30 +00:00
plugins configure: simplify creation of plugin symbol list 2022-01-12 14:09:06 +01:00
po
python python/aqmp: add socket bind step to legacy.py 2022-02-02 14:12:22 -05:00
qapi nbd patches for 2022-01-28 2022-01-30 10:00:28 +00:00
qga * configure and meson fixes 2022-01-28 14:04:01 +00:00
qobject
qom monitor: Fix find_device_state() for IDs containing slashes 2021-11-10 06:14:51 +01:00
replay
roms Fixes and updates for hppa target 2022-02-02 19:54:30 +00:00
scripts drop libxml2 checks since libxml is not actually used (for parallels) 2022-02-09 12:08:42 +00:00
scsi
semihosting
slirp@a88d9ace23
softmmu rtc: Move RTC function prototypes to their own header 2022-01-28 14:29:46 +00:00
storage-daemon qsd: Document fuse's allow-other option 2022-02-01 13:49:15 +01:00
stubs hw/pci: Restrict pci-bus stub to sysemu 2022-01-18 10:45:35 +01:00
subprojects/libvhost-user libvhost-user: Map shared RAM with MAP_NORESERVE to support virtio-mem with hugetlb 2022-02-04 09:07:43 -05:00
target arm: force flag recalculation when messing with DAIF 2022-02-08 10:56:28 +00:00
tcg cpuid: use unsigned for max cpuid 2022-02-04 09:07:43 -05:00
tests tests/lcitool: Install libibumad to cover RDMA on Debian based distros 2022-02-09 12:08:42 +00:00
tools virtiofsd: Drop membership of all supplementary groups (CVE-2022-0358) 2022-01-26 10:32:05 +00:00
trace meson: generate trace events for qmp commands 2022-01-27 11:26:40 +01:00
ui spice: Update QXLInterface for spice >= 0.15.0 2022-01-18 16:42:41 +00:00
util util/oslib-posix: Fix missing unlock in the error path of os_mem_prealloc() 2022-02-06 04:33:50 -05:00
.cirrus.yml tests: Manually remove libxml2 on MSYS2 runners 2022-02-09 12:08:42 +00:00
.dir-locals.el
.editorconfig
.exrc
.gdbinit
.gitattributes
.gitignore .gitignore: add .gcov pattern 2022-02-09 12:08:41 +00:00
.gitlab-ci.yml
.gitmodules gitmodules: Correct libvirt-ci submodule URL 2022-02-09 12:08: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: bdrv_set_backing_hd(): use drained section 2022-02-01 13:49:15 +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 cpuid: use unsigned for max cpuid 2022-02-04 09:07:43 -05:00
COPYING
COPYING.LIB
cpu.c cpu.c: Make start-powered-off settable after realize 2022-02-08 10:56:27 +00: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
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 MAINTAINERS: Cover lcitool submodule with build test / automation 2022-02-09 12:08:41 +00:00
Makefile Makefile: also remove .gcno files when cleaning 2022-02-09 12:08:41 +00:00
memory_ldst.c.inc
meson_options.txt drop libxml2 checks since libxml is not actually used (for parallels) 2022-02-09 12:08:42 +00:00
meson.build drop libxml2 checks since libxml is not actually used (for parallels) 2022-02-09 12:08:42 +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: Unify [-b [-F]] documentation 2022-02-01 13:49:15 +01:00
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>`_