Original Xbox Emulator for Windows, macOS, and Linux (Active Development)
Go to file
Stefan Hajnoczi 3284c3ddc4 lockable: add lock guards
This patch introduces two lock guard macros that automatically unlock a
lock object (QemuMutex and others):

  void f(void) {
      QEMU_LOCK_GUARD(&mutex);
      if (!may_fail()) {
          return; /* automatically unlocks mutex */
      }
      ...
  }

and:

  WITH_QEMU_LOCK_GUARD(&mutex) {
      if (!may_fail()) {
          return; /* automatically unlocks mutex */
      }
  }
  /* automatically unlocks mutex here */
  ...

Convert qemu-timer.c functions that benefit from these macros as an
example.  Manual qemu_mutex_lock/unlock() callers are left unmodified in
cases where clarity would not improve by switching to the macros.

Many other QemuMutex users remain in the codebase that might benefit
from lock guards.  Over time they can be converted, if that is
desirable.

Signed-off-by: Stefan Hajnoczi <stefanha@redhat.com>
[Use QEMU_MAKE_LOCKABLE_NONNULL. - Paolo]
Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
2020-03-17 15:18:45 +01:00
.gitlab-ci.d/edk2 gitlab-ci.yml: Add jobs to build EDK2 firmware binaries 2020-01-21 14:15:48 +01:00
accel accel/tcg: increase default code gen buffer size for 64 bit 2020-02-28 17:43:31 -08:00
audio audio: fix saturation nonlinearity in clip_* functions 2020-03-16 10:18:07 +01:00
authz authz: fix usage of bool in listfile.c 2020-02-07 12:22:19 +00:00
backends hostmem: fix strict bind policy 2020-02-19 16:50:02 +00:00
block misc: Replace zero-length arrays with flexible array member (manual) 2020-03-16 22:07:42 +01:00
bsd-user misc: Replace zero-length arrays with flexible array member (automatic) 2020-03-16 22:07:42 +01:00
capstone@22ead3e0bf disas: Add capstone as submodule 2017-10-26 11:56:20 +02:00
chardev chardev: Improve error report by calling error_setg_win32() 2020-03-09 13:36:15 +01:00
contrib build-sys: do not make qemu-ga link with pixman 2020-03-16 23:02:22 +01:00
crypto luks: extract qcrypto_block_calculate_payload_offset() 2020-03-11 12:42:29 +01:00
default-configs hw/arm: add Allwinner H3 System-on-Chip 2020-03-12 16:27:33 +00:00
disas target/mips: Add implementation of GINVT instruction 2020-01-29 19:28:52 +01:00
docs qemu-cpu-models.rst: Document -noTSX, mds-no, taa-no, and tsx-ctrl 2020-03-16 23:02:25 +01:00
dtc@88f18909db Update dtc/libfdt submodule to v1.4.7 2018-10-02 13:53:26 +10:00
dump hmp: drop Error pointer indirection in hmp_handle_error 2019-12-18 08:36:16 +01:00
fpu softfp: Added hardfloat conversion from float32 to float64 2019-10-30 19:03:37 +01:00
fsdev virtfs-proxy-helper: Make the helper_opts[] array const 2020-03-09 15:59:31 +01:00
gdb-xml target/riscv: Expose "priv" register for GDB for reads 2019-10-28 07:47:29 -07:00
hw exec/rom_reset: Free rom data during inmigrate skip 2020-03-16 23:02:26 +01:00
include lockable: add lock guards 2020-03-17 15:18:45 +01:00
io io/channel-websock: treat 'binary' and no sub-protocol as the same 2020-02-07 12:22:18 +00:00
libdecnumber build: remove CONFIG_LIBDECNUMBER 2017-10-16 18:03:52 +02:00
linux-headers linux-headers: update 2020-02-26 18:57:07 +01:00
linux-user target/arm: Implement v8.4-RCPC 2020-02-28 16:14:57 +00:00
migration migration: recognize COLO as part of activating process 2020-03-13 09:36:30 +00:00
monitor migration/throttle: Add throttle-trig-thres migration parameter 2020-03-13 09:36:30 +00:00
nbd nbd: Fix regression with multiple meta contexts 2020-02-26 14:45:02 -06:00
net misc: Replace zero-length arrays with flexible array member (automatic) 2020-03-16 22:07:42 +01:00
pc-bios misc: Replace zero-length arrays with flexible array member (automatic) 2020-03-16 22:07:42 +01:00
plugins plugins/core: add missing break in cb_to_tcg_flags 2020-02-25 20:20:23 +00:00
po ui/gtk: fix gettext message's charset. 2019-11-21 09:42:30 +01:00
python/qemu python/qemu/machine: Allow to use other serial consoles than default 2020-02-07 15:12:48 +01:00
qapi qapi/audio: add documentation for AudioFormat 2020-03-16 10:18:07 +01:00
qga qga: Fix a memory leak 2020-03-09 13:36:15 +01:00
qobject qstring: add qstring_free() 2020-01-24 20:59:13 +01:00
qom qom/object: enable setter for uint types 2020-03-16 23:02:23 +01:00
replay replay: record and replay random number sources 2020-01-07 12:08:39 +01:00
roms hw/ppc/prep: Remove the deprecated "prep" machine and the OpenHackware BIOS 2020-02-02 14:07:57 +11:00
scripts hxtool: Remove Texinfo generation support 2020-03-12 11:14:05 +00:00
scsi scsi/qemu-pr-helper: Fix out-of-bounds access to trnptid_list[] 2020-03-16 22:07:24 +01:00
slirp@126c04acba slirp: update with CVE-2019-14378 fix 2019-08-02 15:14:56 +04:00
softmmu softmmu/vl.c: Handle '-cpu help' and '-device help' before 'no default machine' 2020-03-16 23:02:25 +01:00
storage-daemon qemu-storage-daemon: Add --monitor option 2020-03-06 17:21:28 +01:00
stubs hmp: Fail gracefully if chardev is already in use 2020-03-06 17:21:28 +01:00
target WHPX: Use proper synchronization primitives while processing 2020-03-16 23:02:24 +01:00
tcg tcg/arm: Expand epilogue inline 2020-02-28 10:58:41 -08:00
tests tests/docker: Install SASL library to extend code coverage on amd64 2020-03-16 23:02:23 +01:00
tools/virtiofsd virtiofsd: Fix xattr operations 2020-03-03 15:13:24 +00:00
trace tracing: only allow -trace to override -D if set 2020-02-25 20:20:23 +00:00
ui ui/curses: Move arrays to .heap to save 74KiB of .bss 2020-03-16 23:02:25 +01:00
util lockable: add lock guards 2020-03-17 15:18:45 +01:00
.cirrus.yml ci: build out-of-tree 2019-12-18 20:17:55 +00: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
.gdbinit .gdbinit: load QEMU sub-commands when gdb starts 2017-06-07 14:38:45 +01:00
.gitignore docs: Stop building qemu-doc 2020-03-06 11:06:55 +00:00
.gitlab-ci-edk2.yml gitlab-ci.yml: Add jobs to build EDK2 firmware binaries 2020-01-21 14:15:48 +01:00
.gitlab-ci.yml configure: Enable test and libs for zstd 2020-02-28 09:24:43 +01: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 mailmap: Add entry for Yu-Chen Lin 2020-02-18 20:20:49 +01: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: --disable-docs for cross-compile tests 2020-02-04 17:13:29 +00:00
.travis.yml travis.yml: install python3 numpy and opencv libraries 2020-03-04 09:57:33 +00:00
arch_init.c hw/m68k: add Nubus macfb video card 2019-10-28 19:06:49 +01:00
balloon.c Clean up inclusion of exec/cpu-common.h 2019-08-16 13:31:52 +02:00
block.c block.c: adding bdrv_co_delete_file 2020-03-11 15:54:38 +01:00
blockdev-nbd.c blockdev-nbd: Boxed argument type for nbd-server-add 2020-03-06 17:21:28 +01:00
blockdev.c block: Fix cross-AioContext blockdev-snapshot 2020-03-11 15:54:38 +01:00
blockjob.c job: refactor progress to separate object 2020-03-11 12:42:30 +01:00
bootdevice.c bootdevice: FW_CFG interface for LCHS values 2019-10-31 11:47:38 -04: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 Use -isystem for linux-headers dir 2020-03-16 23:02:26 +01: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 cpu: introduce cpu_in_exclusive_context() 2019-10-28 15:12:38 +00:00
cpus.c cpus: avoid pause_all_vcpus getting stuck due to race 2020-03-16 23:02:26 +01: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 Avoid address_space_rw() with a constant is_write argument 2020-02-20 14:47:08 +01:00
exec-vary.c exec: Cache TARGET_PAGE_MASK for TARGET_PAGE_BITS_VARY 2019-10-28 10:35:20 +01:00
exec.c memory: Fix start offset for bitmap log_clear hook 2020-03-16 23:02:23 +01:00
gdbstub.c hmp: Fail gracefully if chardev is already in use 2020-03-06 17:21:28 +01:00
gitdm.config contrib: gitdm: add a mapping for Janus Technologies 2019-03-12 19:31:29 +00:00
hmp-commands-info.hx Update comments in .hx files that mention Texinfo 2020-03-12 11:14:05 +00:00
hmp-commands.hx Update comments in .hx files that mention Texinfo 2020-03-12 11:14:05 +00: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 job: refactor progress to separate object 2020-03-11 12:42:30 +01:00
job.c job: refactor progress to separate object 2020-03-11 12:42:30 +01:00
Kconfig.host configure: simplify vhost condition with Kconfig 2019-12-17 19:32:48 +01:00
LICENSE tcg/LICENSE: Remove out of date claim about TCG subdirectory licensing 2019-11-11 15:11:21 +01:00
MAINTAINERS MAINTAINERS: Add entry for Guest X86 HAXM CPUs 2020-03-16 23:02:22 +01:00
Makefile Makefile: Let the 'help' target list the tools targets 2020-03-16 23:02:24 +01:00
Makefile.objs aspeed/smc: Add some tracing 2020-03-12 16:01:37 +00:00
Makefile.target Use -isystem for linux-headers dir 2020-03-16 23:02:26 +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
memory.c qom/object: Use common get/set uint helpers 2020-03-16 23:02:24 +01:00
module-common.c all: Clean up includes 2016-02-04 17:41:30 +00:00
os-posix.c os-posix: simplify os_find_datadir 2019-12-17 19:32:47 +01:00
os-win32.c glib: use portable g_setenv() 2019-12-17 09:05:23 +01:00
qdev-monitor.c virtio, pc: fixes, features 2020-02-27 19:15:15 +00: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 qemu-img: Add --target-is-zero to convert 2020-02-20 16:43:42 +01:00
qemu-img.c job: refactor progress to separate object 2020-03-11 12:42:30 +01:00
qemu-io-cmds.c block: Pass truncate exact=true where reasonable 2019-10-28 12:08:45 +01: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 qemu-nbd: Removed deprecated --partition option 2020-02-05 17:29:49 -06: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 audio: add audiodev format=f32 option documentation 2020-03-16 10:18:07 +01: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 --monitor option 2020-03-06 17:21:28 +01: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
qtest.c qtest: fix fuzzer-related 80-char limit violations 2020-03-06 10:33:26 +00: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 build-sys: Move the print-variable rule to rules.mak 2020-03-09 15:59:31 +01: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 Open 5.0 development tree 2019-12-13 11:59:06 +00: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>`_