You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Peter Maydell 7fb38daf25 Add model of the Netduino Plus 2 board 1 day ago
accel tcg: Search includes from the project root source directory 2 days ago
audio audio: fix integer overflow 1 week ago
authz Include qemu/module.h where needed, drop it from qemu-common.h 7 months ago
backends chardev: Use QEMUChrEvent enum in IOEventHandler typedef 1 week ago
block linux-aio: increasing MAX_EVENTS to a larger hardcoded value 5 days ago
bsd-user tcg: Search includes from the project root source directory 2 days ago
capstone @ 22ead3e0bf disas: Add capstone as submodule 2 years ago
chardev * Compat machines fix (Denis) 1 week ago
contrib Implement backend program convention command for vhost-user-blk 1 week ago
crypto * More uses of RCU_READ_LOCK_GUARD (Dave, myself) 4 weeks ago
default-configs hw/misc: Add the STM32F4xx Sysconfig device 1 day ago
disas libvixl: remove per-target compiler flags 1 month ago
docs Add cpu_{ld,st}*_mmuidx_ra 1 day ago
dtc @ 88f18909db Update dtc/libfdt submodule to v1.4.7 1 year ago
dump hmp: drop Error pointer indirection in hmp_handle_error 1 month ago
fpu softfp: Added hardfloat conversion from float32 to float64 2 months ago
fsdev virtfs-proxy-helper: switch from libcap to libcap-ng 1 month ago
gdb-xml target/riscv: Expose "priv" register for GDB for reads 2 months ago
hw arm/gicv3: update virtual irq state after IAR register read 1 day ago
include i.MX: add an emulation for RNGC 1 day ago
io socket: Add num connections to qio_net_listener_open_sync() 4 months ago
libdecnumber build: remove CONFIG_LIBDECNUMBER 2 years ago
linux-headers linux-headers: Update 1 week ago
linux-user tcg: Search includes from the project root source directory 2 days ago
migration vmstate: replace DeviceState with VMStateIf 1 week ago
monitor QAPI patches for 2020-01-14 4 days ago
nbd nbd: fix uninitialized variable warning 1 week ago
net chardev: Use QEMUChrEvent enum in IOEventHandler typedef 1 week ago
pc-bios seabios: update to 1.13.0 final 2 weeks ago
plugins plugins: Include trace/mem.h in api.c 2 days ago
po ui/gtk: fix gettext message's charset. 1 month ago
python/qemu python/qemu: Remove unneeded imports in __init__ 1 month ago
qapi qapi: Generate command registration stuff into separate files 4 days ago
qga qapi: Generate command registration stuff into separate files 4 days ago
qobject json: Move switch 'fall through' comment to correct place 5 months ago
qom qdev/qom: remove some TODO limitations now that PROP_PTR is gone 1 week ago
replay replay: record and replay random number sources 1 week ago
roms seabios: update to 1.13.0 final 4 weeks ago
scripts QAPI patches for 2020-01-14 4 days ago
scsi build: rename CONFIG_LIBCAP to CONFIG_LIBCAP_NG 1 month ago
slirp @ 126c04acba slirp: update with CVE-2019-14378 fix 5 months ago
stubs * Compat machines fix (Denis) 1 week ago
target Add model of the Netduino Plus 2 board 1 day ago
tcg tcg: Move TCG headers to include/tcg/ 2 days ago
tests Add model of the Netduino Plus 2 board 1 day ago
trace trace: Remove trace_mem_build_info_no_se_[bl]e 2 days ago
ui ui/gtk: Get display refresh rate with GDK version 3.22 or later 2 days ago
util Fix some uninitialized variable warnings, 5 days ago
.cirrus.yml ci: build out-of-tree 1 month ago
.dir-locals.el Add .dir-locals.el file to configure emacs coding style 4 years ago
.editorconfig editorconfig: add setting for shell scripts 7 months ago
.exrc qemu: add .exrc 7 years ago
.gdbinit .gdbinit: load QEMU sub-commands when gdb starts 2 years ago
.gitignore qapi: Generate command registration stuff into separate files 4 days ago
.gitlab-ci.yml gitlab-ci.yml: Run tcg test with tci 2 days ago
.gitmodules roms: add microvm-bios (qboot) as binary and git submodule 2 months ago
.gitpublish Add a git-publish configuration file 1 year ago
.mailmap MAINTAINERS: Update mail address of Aleksandar Rikalo 2 months ago
.patchew.yml ci: store Patchew configuration in the tree 7 months ago
.shippable.yml ci: build out-of-tree 1 month ago
.travis.yml travis.yml: install homebrew python for OS X 1 week ago
CODING_STYLE.rst docs: split the CODING_STYLE doc into distinct groups 4 months ago
COPYING COPYING: update from FSF 11 years ago
COPYING.LIB COPYING.LIB: Synchronize the LGPL 2.1 with the version from gnu.org 11 months ago
Changelog Use HTTPS for qemu.org and other domains 2 years ago
Kconfig.host configure: simplify vhost condition with Kconfig 1 month ago
LICENSE tcg/LICENSE: Remove out of date claim about TCG subdirectory licensing 2 months ago
MAINTAINERS hw/arm: Add the Netduino Plus 2 1 day ago
Makefile QAPI patches for 2020-01-14 4 days ago
Makefile.objs Add dbus-vmstate object 1 week ago
Makefile.target crypto: move common bits for all emulators to libqemuutil 1 month ago
README.rst docs: merge HACKING.rst contents into CODING_STYLE.rst 4 months ago
VERSION Open 5.0 development tree 1 month ago
arch_init.c hw/m68k: add Nubus macfb video card 2 months ago
balloon.c Clean up inclusion of exec/cpu-common.h 5 months ago
block.c block: Use bdrv_qapi_perm_to_blk_perm() 1 week ago
blockdev-nbd.c nbd: Don't send oversize strings 2 months ago
blockdev.c block: Add @exact parameter to bdrv_co_truncate() 2 months ago
blockjob.c blockjob: Fix error message for negative speed 1 month ago
bootdevice.c bootdevice: FW_CFG interface for LCHS values 2 months ago
configure configure: Remove tcg/ from the preprocessor include search list 2 days ago
cpus-common.c cpu: introduce cpu_in_exclusive_context() 2 months ago
cpus.c tcg: Search includes from the project root source directory 2 days ago
device-hotplug.c Include hw/hw.h exactly where needed 5 months ago
device_tree.c device_tree: Fix integer overflowing in load_device_tree() 9 months ago
disas.c plugin: add qemu_plugin_insn_disas helper 2 months ago
dma-helpers.c dma-helpers: ensure AIO callback is invoked after cancellation 5 months ago
exec-vary.c exec: Cache TARGET_PAGE_MASK for TARGET_PAGE_BITS_VARY 2 months ago
exec.c tcg: Search includes from the project root source directory 2 days ago
gdbstub.c chardev: Use QEMUChrEvent enum in IOEventHandler typedef 1 week ago
gitdm.config contrib: gitdm: add a mapping for Janus Technologies 10 months ago
hmp-commands-info.hx riscv: hmp: Add a command to show virtual memory mappings 4 months ago
hmp-commands.hx hmp: Allow using qdev ID for qemu-io command 1 month ago
ioport.c Include qemu-common.h exactly where needed 7 months ago
iothread.c iothread: document about why we need explicit aio_poll() 10 months ago
job-qmp.c Include qemu-common.h exactly where needed 7 months ago
job.c job: drop job_drain 4 months ago
memory.c memory: do not look at current_machine->accel 1 month ago
memory_ldst.inc.c memory: Single byte swap along the I/O path 4 months ago
memory_mapping.c Include qemu-common.h exactly where needed 7 months ago
module-common.c all: Clean up includes 4 years ago
os-posix.c os-posix: simplify os_find_datadir 1 month ago
os-win32.c glib: use portable g_setenv() 1 month ago
qdev-monitor.c qdev-monitor: make Error **errp const where it is appropriate 1 month ago
qemu-bridge-helper.c build: rename CONFIG_LIBCAP to CONFIG_LIBCAP_NG 1 month ago
qemu-deprecated.texi x86 and machine queue, 2019-12-20 1 week ago
qemu-doc.texi qemu-doc: Remove the unused "Guest Agent" node 1 month ago
qemu-edid.c Include qemu-common.h exactly where needed 7 months ago
qemu-img-cmds.hx qemu-img: Add salvaging mode to convert 7 months ago
qemu-img.c qemu-img: fix info --backing-chain --image-opts 1 month ago
qemu-img.texi doc: Preallocation does not require writing zeroes 5 months ago
qemu-io-cmds.c block: Pass truncate exact=true where reasonable 2 months ago
qemu-io.c qemu-io: Support help options for --object 3 months ago
qemu-keymap.c Include qemu-common.h exactly where needed 7 months ago
qemu-nbd.c nbd: Don't send oversize strings 2 months ago
qemu-nbd.texi qemu-nbd: Add --pid-file option 7 months ago
qemu-option-trace.texi qemu-option-trace: -trace enable= is a pattern, not a file 1 year ago
qemu-options-wrapper.h qemu-img: remove references to GEN_DOCS 1 year ago
qemu-options.h Clean up ill-advised or unusual header guards 3 years ago
qemu-options.hx ui: Print available display backends with '-display help' 4 days ago
qemu-seccomp.c seccomp: report more useful errors from seccomp 9 months ago
qemu-tech.texi qemu-tech: Fix dangling @menu entries 6 months ago
qemu.nsi win32: fix README file in NSIS installer 4 months ago
qemu.sasl Default to GSSAPI (Kerberos) instead of DIGEST-MD5 for SASL 2 years ago
qtest.c chardev: Use QEMUChrEvent enum in IOEventHandler typedef 1 week ago
replication.c replication: Introduce new APIs to do replication operation 3 years ago
replication.h Include qemu/module.h where needed, drop it from qemu-common.h 7 months ago
rules.mak contrib: add vhost-user-gpu 7 months ago
thunk.c thunk: improve readability of allocation loop 10 months ago
tpm.c tpm: Clean up error reporting in tpm_init_tpmdev() 1 year ago
trace-events trace: add mmu_index to mem_info 2 months ago
version.rc Use HTTPS for qemu.org and other domains 2 years ago
vl.c ui: Print available display backends with '-display help' 4 days ago

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