QEMU With E2K User Support
Go to file
Emilio G. Cota 671f760b93 tests/plugin: add sample plugins
Pass arguments with -plugin=libfoo.so,arg=bar,arg=baz

Signed-off-by: Emilio G. Cota <cota@braap.org>
Signed-off-by: Alex Bennée <alex.bennee@linaro.org>
Reviewed-by: Richard Henderson <richard.henderson@linaro.org>
2019-10-28 15:12:38 +00:00
accel translator: inject instrumentation from plugins 2019-10-28 15:12:38 +00:00
audio audio: fix missing break 2019-10-26 15:38:06 +02:00
authz Include qemu/module.h where needed, drop it from qemu-common.h 2019-06-12 13:18:33 +02:00
backends core: replace getpagesize() with qemu_real_host_page_size 2019-10-26 15:38:06 +02:00
block core: replace getpagesize() with qemu_real_host_page_size 2019-10-26 15:38:06 +02:00
bsd-user *-user: plugin syscalls 2019-10-28 15:12:38 +00:00
capstone@22ead3e0bf disas: Add capstone as submodule 2017-10-26 11:56:20 +02:00
chardev socket: Add num connections to qio_net_listener_open_sync() 2019-09-03 23:24:42 +02:00
contrib core: replace getpagesize() with qemu_real_host_page_size 2019-10-26 15:38:06 +02:00
crypto qcrypto-luks: more rigorous header checking 2019-09-26 16:34:02 +01:00
default-configs Merge commit 'df84f17' into HEAD 2019-10-26 15:38:02 +02:00
disas cris: do not leak struct cris_disasm_data 2019-10-04 18:49:17 +02:00
docs docs/devel: add plugins.rst design document 2019-10-28 15:12:38 +00:00
dtc@88f18909db Update dtc/libfdt submodule to v1.4.7 2018-10-02 13:53:26 +10:00
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: Added virtfs option 'multidevs=remap|forbid|warn' 2019-10-10 11:36:05 +02:00
gdb-xml RISC-V: Add 64-bit gdb xml files. 2019-03-19 05:13:24 -07:00
hw cpu: hook plugin vcpu events 2019-10-28 15:12:38 +00:00
include plugin: add qemu_plugin_outs helper 2019-10-28 15:12:38 +00:00
io socket: Add num connections to qio_net_listener_open_sync() 2019-09-03 23:24:42 +02:00
libdecnumber build: remove CONFIG_LIBDECNUMBER 2017-10-16 18:03:52 +02:00
linux-headers linux headers: update against v5.4-rc1 2019-10-15 18:09:02 +01:00
linux-user linux-user: support -plugin option 2019-10-28 15:12:38 +00:00
migration core: replace getpagesize() with qemu_real_host_page_size 2019-10-26 15:38:06 +02:00
monitor core: replace getpagesize() with qemu_real_host_page_size 2019-10-26 15:38:06 +02:00
nbd nbd: Grab aio context lock in more places 2019-09-24 07:30:19 -05:00
net virtio, vhost, acpi: features, fixes, tests 2019-10-17 15:30:44 +01:00
pc-bios Merge commit 'df84f17' into HEAD 2019-10-26 15:38:02 +02:00
plugins plugin: add qemu_plugin_outs helper 2019-10-28 15:12:38 +00:00
po Updated Bulgarian translation (19) - 4.1.0 2019-10-22 09:38:42 +02:00
python/qemu Replace '-machine accel=xyz' with '-accel xyz' 2019-09-19 12:01:48 +02:00
qapi qapi: add support for blkreplay driver 2019-10-25 15:15:01 +02: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 vl: Split off user_creatable_print_help() 2019-10-14 17:12:48 +02:00
replay replay: add BH oneshot event for block layer 2019-10-14 17:12:48 +02:00
roms Merge commit 'df84f17' into HEAD 2019-10-26 15:38:02 +02:00
scripts trace: add mmu_index to mem_info 2019-10-28 15:12:38 +00:00
scsi qemu-pr-helper: fix crash in mpath_reconstruct_sense 2019-10-03 12:58:02 +02:00
slirp@126c04acba slirp: update with CVE-2019-14378 fix 2019-08-02 15:14:56 +04:00
stubs replay: add BH oneshot event for block layer 2019-10-14 17:12:48 +02:00
target target/openrisc: fetch code with translator_ld 2019-10-28 15:12:38 +00:00
tcg cputlb: ensure _cmmu helper functions follow the naming standard 2019-10-28 15:12:38 +00:00
tests tests/plugin: add sample plugins 2019-10-28 15:12:38 +00:00
trace trace: add mmu_index to mem_info 2019-10-28 15:12:38 +00:00
ui ui: fix keymap file search in input-barrier object 2019-10-18 10:40:46 +02:00
util plugin: add qemu_plugin_outs helper 2019-10-28 15:12:38 +00:00
.cirrus.yml cirrus.yml: add latest Xcode build target 2019-10-25 19:23:53 +01:00
.dir-locals.el Add .dir-locals.el file to configure emacs coding style 2015-10-08 19:46:01 +03:00
.editorconfig editorconfig: add setting for shell scripts 2019-06-12 17:53:22 +01:00
.exrc qemu: add .exrc 2012-09-07 09:02:44 +03:00
.gdbinit .gdbinit: load QEMU sub-commands when gdb starts 2017-06-07 14:38:45 +01:00
.gitignore build: Don't ignore qapi-visit-core.c 2019-09-19 12:14:04 +02:00
.gitlab-ci.yml gitlab-ci.yml: Use libvdeplug-dev to compile-test the VDE network backend 2019-10-25 19:24:21 +01:00
.gitmodules roms: add microvm-bios (qboot) as binary and git submodule 2019-10-22 09:39:54 +02:00
.gitpublish Add a git-publish configuration file 2018-03-05 09:03:17 +00:00
.mailmap MAINTAINERS: Update mail address of Aleksandar Rikalo 2019-10-25 18:37:01 +02:00
.patchew.yml ci: store Patchew configuration in the tree 2019-06-03 14:03:02 +02:00
.shippable.yml tests/docker: set HOST_ARCH if we don't have ARCH 2019-10-25 19:24:21 +01:00
.travis.yml travis.yml: --enable-debug-tcg to check-tcg 2019-10-25 19:24:21 +01:00
CODING_STYLE.rst docs: split the CODING_STYLE doc into distinct groups 2019-09-05 14:41:00 +01:00
COPYING COPYING: update from FSF 2008-10-12 17:54:42 +00:00
COPYING.LIB COPYING.LIB: Synchronize the LGPL 2.1 with the version from gnu.org 2019-01-30 11:01:22 +01:00
Changelog Use HTTPS for qemu.org and other domains 2017-11-21 13:34:13 +00:00
Kconfig.host 9p: simplify source file selection 2019-08-20 17:26:19 +02:00
LICENSE roms: Add OpenSBI version 0.4 2019-07-18 14:18:43 -07:00
MAINTAINERS Merge commit 'df84f17' into HEAD 2019-10-26 15:38:02 +02:00
Makefile plugin: add API symbols to qemu-plugins.symbols 2019-10-28 15:12:38 +00:00
Makefile.objs hw: Move PL031 device from hw/timer/ to hw/rtc/ subdirectory 2019-10-24 20:10:27 +02:00
Makefile.target plugin: add core code 2019-10-28 15:12:38 +00:00
README.rst docs: merge HACKING.rst contents into CODING_STYLE.rst 2019-09-05 14:27:06 +01:00
VERSION Open 4.2 development tree 2019-08-15 17:20:55 +01: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 core: replace getpagesize() with qemu_real_host_page_size 2019-10-26 15:38:06 +02:00
blockdev-nbd.c nbd: Grab aio context lock in more places 2019-09-24 07:30:19 -05:00
blockdev.c blockdev: Use error_report() in hmp_commit() 2019-10-25 15:15:01 +02:00
blockjob.c blockjob: update nodes head while removing all bdrv 2019-09-16 15:31:12 +02:00
bootdevice.c fw_cfg: ignore suffixes in the bootdevice list dependent on machine class 2018-08-16 22:27:43 -03:00
bt-host.c all: Clean up includes 2016-02-04 17:41:30 +00:00
bt-vhci.c Include qemu-common.h exactly where needed 2019-06-12 13:20:20 +02:00
configure tests/plugin: add sample plugins 2019-10-28 15:12:38 +00:00
cpus-common.c cpu: introduce cpu_in_exclusive_context() 2019-10-28 15:12:38 +00:00
cpus.c cpu: hook plugin vcpu events 2019-10-28 15:12:38 +00:00
device-hotplug.c Include hw/hw.h exactly where needed 2019-08-16 13:31:52 +02:00
device_tree.c device_tree: Fix integer overflowing in load_device_tree() 2019-04-09 16:35:40 -07:00
disas.c plugin: add qemu_plugin_insn_disas helper 2019-10-28 15:12:38 +00:00
dma-helpers.c dma-helpers: ensure AIO callback is invoked after cancellation 2019-08-16 19:14:04 -04:00
exec.c cpu: hook plugin vcpu events 2019-10-28 15:12:38 +00:00
gdbstub.c gdbstub: Fix handler for 'F' packet 2019-08-28 10:11:15 +01:00
gitdm.config contrib: gitdm: add a mapping for Janus Technologies 2019-03-12 19:31:29 +00:00
hmp-commands-info.hx riscv: hmp: Add a command to show virtual memory mappings 2019-09-17 08:42:43 -07:00
hmp-commands.hx audio: add audiodev property to vnc and wav_capture 2019-08-21 09:13:37 +02:00
ioport.c Include qemu-common.h exactly where needed 2019-06-12 13:20:20 +02:00
iothread.c iothread: document about why we need explicit aio_poll() 2019-03-08 10:20:57 +00:00
job-qmp.c Include qemu-common.h exactly where needed 2019-06-12 13:20:20 +02:00
job.c job: drop job_drain 2019-09-10 08:58:43 +02:00
memory.c rcu: Use automatic rc_read unlock in core memory/exec code 2019-10-11 14:20:02 +01:00
memory_ldst.inc.c memory: Single byte swap along the I/O path 2019-09-03 08:30:39 -07:00
memory_mapping.c Include qemu-common.h exactly where needed 2019-06-12 13:20:20 +02:00
module-common.c all: Clean up includes 2016-02-04 17:41:30 +00:00
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/machine: Introduce hotplug_allowed hook 2019-09-16 06:57:24 -04:00
qemu-bridge-helper.c qemu-bridge-helper: move repeating code in parse_acl_file 2019-07-29 16:29:30 +08:00
qemu-deprecated.texi dirty-bitmaps: remove deprecated autoload parameter 2019-10-17 17:53:28 -04:00
qemu-doc.texi qemu-doc: Remove paragraph about requiring a HD image with -kernel 2019-10-21 18:04:31 +02:00
qemu-edid.c Include qemu-common.h exactly where needed 2019-06-12 13:20:20 +02:00
qemu-img-cmds.hx qemu-img: Add salvaging mode to convert 2019-06-14 14:16:57 +02:00
qemu-img.c qemu-img: Support help options for --object 2019-10-14 17:12:48 +02: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: Don't leak pattern file in error path 2019-09-13 12:18:37 +02:00
qemu-io.c qemu-io: Support help options for --object 2019-10-14 17:12:48 +02:00
qemu-keymap.c Include qemu-common.h exactly where needed 2019-06-12 13:20:20 +02:00
qemu-nbd.c qemu-nbd: Support help options for --object 2019-10-14 17:12:48 +02:00
qemu-nbd.texi qemu-nbd: Add --pid-file option 2019-06-13 08:50:47 -05:00
qemu-option-trace.texi qemu-option-trace: -trace enable= is a pattern, not a file 2018-05-20 08:29:01 +03:00
qemu-options-wrapper.h qemu-img: remove references to GEN_DOCS 2018-05-20 08:35:54 +03:00
qemu-options.h Clean up ill-advised or unusual header guards 2016-07-12 16:20:46 +02:00
qemu-options.hx vl: support -plugin option 2019-10-28 15:12:38 +00:00
qemu-seccomp.c seccomp: report more useful errors from seccomp 2019-03-27 13:11:38 +01:00
qemu-tech.texi qemu-tech: Fix dangling @menu entries 2019-07-15 21:10:29 +02:00
qemu.nsi win32: fix README file in NSIS installer 2019-09-16 12:32:21 +02:00
qemu.sasl Default to GSSAPI (Kerberos) instead of DIGEST-MD5 for SASL 2017-05-09 14:41:47 +01:00
qtest.c tests: add module loading test 2019-08-21 16:29:57 +02:00
replication.c replication: Introduce new APIs to do replication operation 2016-09-13 11:00:56 +01:00
replication.h Include qemu/module.h where needed, drop it from qemu-common.h 2019-06-12 13:18:33 +02:00
rules.mak contrib: add vhost-user-gpu 2019-05-29 06:30:45 +02:00
thunk.c thunk: improve readability of allocation loop 2019-03-11 18:48:20 +01:00
tpm.c tpm: Clean up error reporting in tpm_init_tpmdev() 2018-10-19 14:51:34 +02:00
trace-events trace: add mmu_index to mem_info 2019-10-28 15:12:38 +00:00
version.rc Use HTTPS for qemu.org and other domains 2017-11-21 13:34:13 +00:00
vl.c vl: support -plugin option 2019-10-28 15:12:38 +00:00

README.rst

===========
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 CODING_STYLE.rst file.

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>`_