Go to file
Paolo Bonzini a56650518f configure: integrate Meson in the build system
The Meson build system is integrated in the existing configure/make steps
by invoking Meson from the configure script and converting Meson's build.ninja
rules to an included Makefile.

build.ninja already provides tags/ctags/cscope rules, so they are removed.

Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
2020-08-21 06:30:05 -04:00
.github .github: Enable repo-lockdown bot to refuse GitHub pull requests 2020-04-07 16:19:18 +01:00
.gitlab-ci.d gitlab-ci/containers: Add missing wildcard where we should look for changes 2020-07-15 11:52:43 +01:00
accel meson: rename included C source files to .c.inc 2020-08-21 06:18:30 -04:00
audio trace: switch position of headers to what Meson requires 2020-08-21 06:18:24 -04:00
authz trace: switch position of headers to what Meson requires 2020-08-21 06:18:24 -04:00
backends trace: switch position of headers to what Meson requires 2020-08-21 06:18:24 -04:00
block trace: switch position of headers to what Meson requires 2020-08-21 06:18:24 -04:00
bsd-user linux-user/sparc64: Fix the handling of window spill trap 2020-06-29 13:00:23 +02:00
capstone@22ead3e0bf disas: Add capstone as submodule 2017-10-26 11:56:20 +02:00
chardev trace: switch position of headers to what Meson requires 2020-08-21 06:18:24 -04:00
contrib meson: rename included C source files to .c.inc 2020-08-21 06:18:30 -04:00
crypto trace: switch position of headers to what Meson requires 2020-08-21 06:18:24 -04:00
default-configs hw/avr: Add limited support for some Arduino boards 2020-07-11 11:02:05 +02:00
disas disas/sh4: Add missing fallthrough annotations 2020-07-13 11:40:52 +02:00
docs docs/devel: Document decodetree no-overlap groups 2020-08-04 16:33:47 +01:00
dtc@85e5d83984 Makefile: dtc: update, build the libfdt target 2020-06-16 14:49:05 +01:00
dump error: Eliminate error_propagate() manually 2020-07-10 15:18:08 +02:00
fpu meson: rename included C source files to .c.inc 2020-08-21 06:18:30 -04:00
fsdev 9p: null terminate fs driver options list 2020-07-10 12:48:06 +02:00
gdb-xml target/avr: CPU class: Add GDB support 2020-07-10 17:58:32 +02:00
hw trace: switch position of headers to what Meson requires 2020-08-21 06:18:24 -04:00
include meson: rename .inc.h files to .h.inc 2020-08-21 06:18:35 -04:00
io trace: switch position of headers to what Meson requires 2020-08-21 06:18:24 -04:00
libdecnumber build: remove CONFIG_LIBDECNUMBER 2017-10-16 18:03:52 +02:00
linux-headers linux-headers: update again to 5.8 2020-07-10 19:26:55 -04:00
linux-user trace: switch position of headers to what Meson requires 2020-08-21 06:18:24 -04:00
migration trace: switch position of headers to what Meson requires 2020-08-21 06:18:24 -04:00
monitor trace: switch position of headers to what Meson requires 2020-08-21 06:18:24 -04:00
nbd trace: switch position of headers to what Meson requires 2020-08-21 06:18:24 -04:00
net trace: switch position of headers to what Meson requires 2020-08-21 06:18:24 -04:00
pc-bios pc-bios/s390-ccw: do not use rules.mak 2020-08-21 06:18:23 -04:00
plugins qemu/qemu-plugin: Make qemu_plugin_hwaddr_is_io() hwaddr argument const 2020-05-15 15:25:16 +01:00
po translations: Add Swedish language 2020-06-15 20:51:10 +02:00
python/qemu python/qemu: Change ConsoleSocket to optionally drain socket. 2020-07-27 09:41:56 +01:00
qapi trace: switch position of headers to what Meson requires 2020-08-21 06:18:24 -04:00
qga schemas: Add vim modeline 2020-08-03 08:28:08 +02:00
qobject qobject: Eliminate qdict_iter(), use qdict_first(), qdict_next() 2020-04-30 06:51:15 +02:00
qom trace: switch position of headers to what Meson requires 2020-08-21 06:18:24 -04:00
replay replay: synchronize on every virtual timer callback 2020-06-26 06:45:30 -04:00
roms seabios: update to master snapshot 2020-08-03 07:01:02 +02:00
scripts configure: integrate Meson in the build system 2020-08-21 06:30:05 -04:00
scsi trace: switch position of headers to what Meson requires 2020-08-21 06:18:24 -04:00
slirp@ce94eba204 slirp: update to latest stable-4.2 branch 2020-07-28 18:27:59 +04:00
softmmu configure: prepare CFLAGS/CXXFLAGS/LDFLAGS for Meson 2020-08-21 06:18:36 -04:00
storage-daemon schemas: Add vim modeline 2020-08-03 08:28:08 +02:00
stubs Revert "tpm: Clean up error reporting in tpm_init_tpmdev()" 2020-07-24 12:44:13 -04:00
target meson: rename .inc.h files to .h.inc 2020-08-21 06:18:35 -04:00
tcg meson: rename included C source files to .c.inc 2020-08-21 06:18:30 -04:00
tests tests/vm: include setuptools 2020-08-21 06:18:36 -04:00
tools/virtiofsd virtiofsd: Allow addition or removal of capabilities 2020-07-03 16:23:05 +01:00
trace trace: switch position of headers to what Meson requires 2020-08-21 06:18:24 -04:00
ui meson: rename included C source files to .c.inc 2020-08-21 06:18:30 -04:00
util trace: switch position of headers to what Meson requires 2020-08-21 06:18:24 -04:00
.cirrus.yml .cirrus.yml: add bash to the brew packages 2020-07-11 15:53:29 +01:00
.dir-locals.el Add .dir-locals.el file to configure emacs coding style 2015-10-08 19:46:01 +03:00
.editorconfig meson: rename included C source files to .c.inc 2020-08-21 06:18:30 -04: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 configure: add support for pseudo-"in source tree" builds 2020-08-21 06:29:58 -04:00
.gitlab-ci.yml gitlab-ci: Fix Avocado cache usage 2020-08-05 10:39:55 +02:00
.gitmodules hw/ppc/prep: Remove the deprecated "prep" machine and the OpenHackware BIOS 2020-02-02 14:07:57 +11:00
.gitpublish Add a git-publish configuration file 2018-03-05 09:03:17 +00:00
.mailmap MAINTAINERS: Update Radoslaw Biernacki email address 2020-07-07 12:38:50 +02:00
.patchew.yml ci: store Patchew configuration in the tree 2019-06-03 14:03:02 +02:00
.readthedocs.yml .readthedocs.yml: specify some minimum python requirements 2020-02-07 15:15:16 +01:00
.shippable.yml shippable: add one more qemu to registry url 2020-07-27 09:39:57 +01:00
.travis.yml .travis.yml: skip ppc64abi32-linux-user with plugins 2020-07-15 11:57:17 +01:00
block.c block: Require aligned image size to avoid assertion failure 2020-07-17 14:20:57 +02:00
blockdev-nbd.c blockdev-nbd: Boxed argument type for nbd-server-add 2020-03-06 17:21:28 +01:00
blockdev.c block: Add support to warn on backing file change without format 2020-07-14 15:18:59 +02:00
blockjob.c block: Add BdrvChildRole to BdrvChild 2020-05-18 19:05:25 +02:00
bootdevice.c error: Eliminate error_propagate() manually 2020-07-10 15:18:08 +02:00
Changelog Use HTTPS for qemu.org and other domains 2017-11-21 13:34:13 +00:00
CODING_STYLE.rst docs: split the CODING_STYLE doc into distinct groups 2019-09-05 14:41:00 +01:00
configure configure: integrate Meson in the build system 2020-08-21 06:30:05 -04:00
COPYING
COPYING.LIB COPYING.LIB: Synchronize the LGPL 2.1 with the version from gnu.org 2019-01-30 11:01:22 +01:00
cpus-common.c cpus: Move CPU code from exec.c to cpus-common.c 2020-07-10 18:02:24 -04:00
device_tree.c device_tree: Constify compat in qemu_fdt_node_path() 2020-04-30 15:35:41 +01:00
disas.c disas: Let disas::read_memory() handler return EIO on error 2020-06-10 12:10:23 -04:00
dma-helpers.c trace: switch position of headers to what Meson requires 2020-08-21 06:18:24 -04:00
exec-vary.c exec: Cache TARGET_PAGE_MASK for TARGET_PAGE_BITS_VARY 2019-10-28 10:35:20 +01:00
exec.c meson: rename included C source files to .c.inc 2020-08-21 06:18:30 -04:00
gdbstub.c trace: switch position of headers to what Meson requires 2020-08-21 06:18:24 -04:00
gitdm.config contrib: gitdm: add a mapping for Janus Technologies 2019-03-12 19:31:29 +00:00
hmp-commands-info.hx memory: Make 'info mtree' not display disabled regions by default 2020-06-10 12:10:49 -04:00
hmp-commands.hx hmp: Make json format optional for qom-set 2020-06-17 17:48:39 +01:00
iothread.c qom: Change object_get_canonical_path_component() not to malloc 2020-07-21 16:23:43 +02:00
job-qmp.c trace: switch position of headers to what Meson requires 2020-08-21 06:18:24 -04:00
job.c trace: switch position of headers to what Meson requires 2020-08-21 06:18:24 -04:00
Kconfig Makefile: simplify MINIKCONF rules 2020-07-10 18:02:21 -04:00
Kconfig.host accel/Kconfig: Extract accel selectors into their own config 2020-07-10 18:02:21 -04:00
LICENSE tcg/LICENSE: Remove out of date claim about TCG subdirectory licensing 2019-11-11 15:11:21 +01:00
MAINTAINERS MAINTAINERS: Cover the firmware JSON schema 2020-07-27 10:28:28 -04:00
Makefile configure: integrate Meson in the build system 2020-08-21 06:30:05 -04:00
Makefile.objs trace: switch position of headers to what Meson requires 2020-08-21 06:18:24 -04:00
Makefile.target softmmu: move softmmu only files from root 2020-07-10 18:02:24 -04:00
memory_ldst.c.inc meson: rename included C source files to .c.inc 2020-08-21 06:18:30 -04:00
meson.build configure: integrate Meson in the build system 2020-08-21 06:30:05 -04:00
module-common.c all: Clean up includes 2016-02-04 17:41:30 +00:00
os-posix.c qemu/osdep: Document os_find_datadir() return value 2020-07-21 16:13:04 +02:00
os-win32.c qemu/osdep: Document os_find_datadir() return value 2020-07-21 16:13:04 +02:00
qdev-monitor.c qdev: Fix device_add DRIVER,help to print to monitor 2020-07-21 17:22:44 +02:00
qemu-bridge-helper.c build: rename CONFIG_LIBCAP to CONFIG_LIBCAP_NG 2019-12-17 19:35:47 +01:00
qemu-edid.c Include qemu-common.h exactly where needed 2019-06-12 13:20:20 +02:00
qemu-img-cmds.hx block/amend: add 'force' option 2020-07-06 08:49:28 +02:00
qemu-img.c qemu-img resize: Require --shrink for shrinking all image formats 2020-07-17 14:20:57 +02:00
qemu-io-cmds.c block: nbd: Fix convert qcow2 compressed to nbd 2020-07-28 09:54:19 -05:00
qemu-io.c qemu-io: adds option to use aio engine 2020-01-30 20:59:42 +00:00
qemu-keymap.c Include qemu-common.h exactly where needed 2019-06-12 13:20:20 +02:00
qemu-nbd.c error: Use error_reportf_err() where appropriate 2020-05-27 07:45:30 +02: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 ipmi: Fix a man page entry 2020-07-17 11:39:46 -05:00
qemu-seccomp.c seccomp: report more useful errors from seccomp 2019-03-27 13:11:38 +01:00
qemu-storage-daemon.c qemu-storage-daemon: add missing cleanup calls 2020-07-03 09:37:03 +02:00
qemu.nsi qemu.nsi: Install Sphinx documentation 2020-03-09 16:45:00 +00:00
qemu.sasl Default to GSSAPI (Kerberos) instead of DIGEST-MD5 for SASL 2017-05-09 14:41:47 +01:00
README.rst docs: merge HACKING.rst contents into CODING_STYLE.rst 2019-09-05 14:27:06 +01: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 configure: prepare CFLAGS/CXXFLAGS/LDFLAGS for Meson 2020-08-21 06:18:36 -04:00
thunk.c linux-user: Add strace support for printing arguments of ioctl() 2020-07-04 18:08:51 +02:00
tpm.c tpm: Improve help on TPM types when none are available 2020-07-24 12:44:13 -04:00
trace-events trace: add mmu_index to mem_info 2019-10-28 15:12:38 +00:00
VERSION Open 5.2 development tree 2020-08-18 13:44:04 +01:00
version.rc Use HTTPS for qemu.org and other domains 2017-11-21 13:34:13 +00: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 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>`_