QEMU With E2K User Support
Go to file
Daniel P. Berrangé 336a7451e8 docs: convert README, CODING_STYLE and HACKING to RST syntax
Reviewed-by: Alex Bennée <alex.bennee@linaro.org>
Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
2019-09-05 14:27:06 +01:00
accel Allow page table bit to swap endianness. 2019-09-04 16:29:18 +01:00
audio audio: omitting audiodev= parameter is only deprecated 2019-08-28 11:57:45 +02:00
authz
backends virtio,vhost: fixes, features, cleanups. 2019-09-04 17:22:34 +01:00
block file-posix: fix request_alignment typo 2019-09-03 14:55:35 +02:00
bsd-user
capstone@22ead3e0bf
chardev socket: Add num connections to qio_net_listener_open_sync() 2019-09-03 23:24:42 +02:00
contrib virtio,vhost: fixes, features, cleanups. 2019-09-04 17:22:34 +01:00
crypto crypto: use auto cleanup for many stack variables 2019-08-22 10:56:57 +01:00
default-configs
disas ppc: Add support for 'mffsl' instruction 2019-08-21 17:17:39 +10:00
docs Monitor patches for 2019-08-21 2019-08-22 10:31:21 +01:00
dtc@88f18909db
dump sysemu: Split sysemu/runstate.h off sysemu/sysemu.h 2019-08-16 13:37:36 +02:00
fpu fpu: rename softfloat-specialize.h -> .inc.c 2019-08-19 12:07:13 +01:00
fsdev 9p: simplify source file selection 2019-08-20 17:26:19 +02:00
gdb-xml
hw virtio,vhost: fixes, features, cleanups. 2019-09-04 17:22:34 +01:00
include virtio,vhost: fixes, features, cleanups. 2019-09-04 17:22:34 +01:00
io socket: Add num connections to qio_net_listener_open_sync() 2019-09-03 23:24:42 +02:00
libdecnumber
linux-headers
linux-user target/openrisc: Add support for ORFPX64A32 2019-09-04 12:53:33 -07:00
migration multifd: Use number of channels as listen backlog 2019-09-03 23:24:42 +02:00
monitor Monitor patches for 2019-08-21 2019-08-22 10:31:21 +01:00
nbd block/dirty-bitmap: add bdrv_dirty_bitmap_get 2019-08-16 16:28:02 -04:00
net sysemu: Split sysemu/runstate.h off sysemu/sysemu.h 2019-08-16 13:37:36 +02:00
pc-bios pseries: Update SLOF firmware image 2019-08-29 09:46:07 +10:00
po
python/qemu
qapi qapi: report the default CPU type for each machine 2019-09-03 14:39:46 -03:00
qga socket: Add backlog parameter to socket_listen 2019-09-03 23:24:42 +02:00
qobject json: Move switch 'fall through' comment to correct place 2019-08-21 10:54:31 +02:00
qom hw/core: Move cpu.c, cpu.h from qom/ to hw/core/ 2019-08-21 13:24:01 +02:00
replay audio: second batch of -audiodev support, adding support for multiple backends. 2019-08-21 15:18:50 +01:00
roms pseries: Update SLOF firmware image 2019-08-29 09:46:07 +10:00
scripts docs: convert README, CODING_STYLE and HACKING to RST syntax 2019-09-05 14:27:06 +01:00
scsi socket: Add num connections to qio_channel_socket_sync() 2019-09-03 23:24:42 +02:00
slirp@126c04acba slirp: update with CVE-2019-14378 fix 2019-08-02 15:14:56 +04:00
stubs sysemu: Split sysemu/runstate.h off sysemu/sysemu.h 2019-08-16 13:37:36 +02:00
target target/openrisc: Update cpu "any" to v1.3 2019-09-04 13:01:56 -07:00
tcg Allow page table bit to swap endianness. 2019-09-04 16:29:18 +01:00
tests Fix multifd with big number of channels 2019-09-04 15:38:27 +01:00
trace tcg: TCGMemOp is now accelerator independent MemOp 2019-09-03 08:30:38 -07:00
ui socket: Add num connections to qio_net_listener_open_sync() 2019-09-03 23:24:42 +02:00
util socket: Add backlog parameter to socket_listen 2019-09-03 23:24:42 +02:00
.cirrus.yml
.dir-locals.el
.editorconfig
.exrc
.gdbinit
.gitignore .gitignore: ignore some vhost-user* related files 2019-08-21 10:40:41 +02:00
.gitlab-ci.yml gitlab-ci: Remove qcow2 tests that are handled by "make check" already 2019-08-17 09:06:17 +02:00
.gitmodules
.gitpublish
.mailmap .mailmap/aliases: add some further commentary 2019-09-02 10:52:22 +01:00
.patchew.yml
.shippable.yml
.travis.yml Boot Linux Console Test: add a test for ppc64 + pseries 2019-08-28 21:10:03 -04:00
arch_init.c qapi: Move query-target from misc.json to machine.json 2019-08-21 13:24:01 +02:00
balloon.c Clean up inclusion of exec/cpu-common.h 2019-08-16 13:31:52 +02:00
block.c block: fix permission update in bdrv_replace_node 2019-09-03 14:55:35 +02:00
blockdev-nbd.c socket: Add num connections to qio_net_listener_open_sync() 2019-09-03 23:24:42 +02:00
blockdev.c mirror: Fix bdrv_has_zero_init() use 2019-08-19 17:13:26 +02:00
blockjob.c Block layer patches: 2019-08-16 16:43:46 +01:00
bootdevice.c
bt-host.c
bt-vhci.c
Changelog
CODING_STYLE.rst docs: convert README, CODING_STYLE and HACKING to RST syntax 2019-09-05 14:27:06 +01:00
configure configure: more resilient Python version capture 2019-08-27 16:57:24 -03:00
COPYING
COPYING.LIB
cpus-common.c Monitor patches for 2019-08-21 2019-08-22 10:31:21 +01:00
cpus.c util/qemu-timer: refactor deadline calculation for external timers 2019-08-20 17:26:21 +02:00
device_tree.c
device-hotplug.c Include hw/hw.h exactly where needed 2019-08-16 13:31:52 +02:00
disas.c
dma-helpers.c dma-helpers: ensure AIO callback is invoked after cancellation 2019-08-16 19:14:04 -04:00
exec.c Allow page table bit to swap endianness. 2019-09-04 16:29:18 +01:00
gdbstub.c gdbstub: Fix handler for 'F' packet 2019-08-28 10:11:15 +01:00
gitdm.config
HACKING.rst docs: convert README, CODING_STYLE and HACKING to RST syntax 2019-09-05 14:27:06 +01:00
hmp-commands-info.hx
hmp-commands.hx audio: add audiodev property to vnc and wav_capture 2019-08-21 09:13:37 +02:00
ioport.c
iothread.c
job-qmp.c
job.c
Kconfig.host 9p: simplify source file selection 2019-08-20 17:26:19 +02:00
LICENSE
MAINTAINERS tcg: TCGMemOp is now accelerator independent MemOp 2019-09-03 08:30:38 -07:00
Makefile tests/docker: add podman support 2019-08-22 17:30:25 +04:00
Makefile.objs
Makefile.target
memory_ldst.inc.c memory: Single byte swap along the I/O path 2019-09-03 08:30:39 -07:00
memory_mapping.c
memory.c Allow page table bit to swap endianness. 2019-09-04 16:29:18 +01:00
module-common.c
os-posix.c sysemu: Split sysemu/runstate.h off sysemu/sysemu.h 2019-08-16 13:37:36 +02:00
os-win32.c sysemu: Split sysemu/runstate.h off sysemu/sysemu.h 2019-08-16 13:37:36 +02:00
qdev-monitor.c qdev: Collect HMP handlers command handlers in qdev-monitor.c 2019-08-21 13:24:01 +02:00
qemu-bridge-helper.c
qemu-deprecated.texi audio: omitting audiodev= parameter is only deprecated 2019-08-28 11:57:45 +02:00
qemu-doc.texi
qemu-edid.c
qemu-ga.texi
qemu-img-cmds.hx
qemu-img.c block: define .*_part io handlers in BlockDriver 2019-08-27 14:58:42 +01:00
qemu-img.texi doc: Preallocation does not require writing zeroes 2019-08-19 17:13:26 +02:00
qemu-io-cmds.c qemu-io: add pattern file for write command 2019-09-03 14:55:35 +02:00
qemu-io.c
qemu-keymap.c
qemu-nbd.c socket: Add num connections to qio_net_listener_open_sync() 2019-09-03 23:24:42 +02:00
qemu-nbd.texi
qemu-option-trace.texi
qemu-options-wrapper.h
qemu-options.h
qemu-options.hx virtio-rng: change default backend to rng-builtin 2019-09-04 06:32:51 -04:00
qemu-seccomp.c
qemu-tech.texi
qemu.nsi
qemu.sasl
qtest.c tests: add module loading test 2019-08-21 16:29:57 +02:00
README.rst docs: convert README, CODING_STYLE and HACKING to RST syntax 2019-09-05 14:27:06 +01:00
replication.c
replication.h
rules.mak
thunk.c
tpm.c
trace-events hw/core: Move cpu.c, cpu.h from qom/ to hw/core/ 2019-08-21 13:24:01 +02:00
VERSION Open 4.2 development tree 2019-08-15 17:20:55 +01:00
version.rc
vl.c Various trivial fixes 2019-08-21 16:59:22 +01:00

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


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


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

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

.. code-block:: shell

   git clone https://git.qemu.org/git/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 HACKING.rst and CODING_STYLE.rst files.

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

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

The QEMU website is also maintained under source control.

.. code-block:: shell

  git clone https://git.qemu.org/git/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 Launchpad as its primary upstream bug tracker. Bugs
found when running code built from QEMU git or upstream released sources
should be reported via:

* `<https://bugs.launchpad.net/qemu/>`_

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

For additional information on bug reporting consult:

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


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