Go to file
Eric Blake 474a6e64f2 tools: Fix use of fcntl(F_SETFD) during socket activation
Blindly setting FD_CLOEXEC without a read-modify-write will
inadvertently clear any other intentionally-set bits, such as a
proposed new bit for designating a fd that must behave in 32-bit mode.
However, we cannot use our wrapper qemu_set_cloexec(), because that
wrapper intentionally abort()s on failure, whereas the probe here
intentionally tolerates failure to deal with incorrect socket
activation gracefully.  Instead, fix the code to do the proper
read-modify-write.

Signed-off-by: Eric Blake <eblake@redhat.com>
Message-Id: <20200420175309.75894-3-eblake@redhat.com>
Reviewed-by: Peter Maydell <peter.maydell@linaro.org>
2020-05-04 14:54:35 -05: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.yml: Add jobs to build OpenSBI firmware binaries 2020-03-16 17:03:50 -07:00
accel tcg: Remove softmmu code_gen_buffer fixed address 2020-03-28 14:09:44 -07:00
audio dsoundaudio: dsound_get_buffer_in should honor *size 2020-04-06 13:29:53 +02:00
authz authz: fix usage of bool in listfile.c 2020-02-07 12:22:19 +00:00
backends cryptodev: Fix cryptodev_builtin_cleanup() error API violation 2020-04-29 08:01:52 +02:00
block qcow2: Forward ZERO_WRITE flag for full preallocation 2020-04-30 17:51:07 +02: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 vhost-user-gpu: Release memory returned by vu_queue_pop() with free() 2020-04-15 19:00:39 +01:00
crypto luks: extract qcrypto_block_calculate_payload_offset() 2020-03-11 12:42:29 +01:00
default-configs Add rx-softmmu 2020-03-19 17:58:05 +01:00
disas target/mips: Add implementation of GINVT instruction 2020-01-29 19:28:52 +01:00
docs hw/arm/virt: Add nvdimm hotplug support 2020-05-04 10:25:02 -04:00
dtc@88f18909db Update dtc/libfdt submodule to v1.4.7 2018-10-02 13:53:26 +10:00
dump various: Remove suspicious '\' character outside of #define in C code 2020-04-29 08:01:51 +02:00
fpu softfloat: Fix BAD_SHIFT from normalizeFloatx80Subnormal 2020-04-07 16:19:49 +01:00
fsdev virtfs-proxy-helper: Make the helper_opts[] array const 2020-03-09 15:59:31 +01:00
gdb-xml target/rx: CPU definitions 2020-03-19 17:58:05 +01:00
hw hw/i386: Make vmmouse helpers static 2020-05-04 10:25:03 -04:00
include hw/i386: Make vmmouse helpers static 2020-05-04 10:25:03 -04:00
io io: Fix qio_channel_socket_close() error handling 2020-04-29 08:01:52 +02:00
libdecnumber build: remove CONFIG_LIBDECNUMBER 2017-10-16 18:03:52 +02:00
linux-headers linux-headers: update against Linux 5.7-rc3 2020-04-28 12:29:01 +02:00
linux-user linux-user/riscv: fix up struct target_ucontext definition 2020-04-29 13:16:37 -07:00
migration migration/colo: Fix qmp_xen_colo_do_checkpoint() error handling 2020-04-29 08:01:52 +02:00
monitor qapi: Disallow qmp_marshal_FOO(NULL, ...) 2020-04-30 07:26:41 +02:00
nbd nbd/server: use bdrv_dirty_bitmap_next_dirty_area 2020-03-18 14:03:46 -04:00
net net/colo-compare.c: Expose "expired_scan_cycle" to users 2020-03-31 21:14:35 +08:00
pc-bios roms: opensbi: Upgrade from v0.6 to v0.7 2020-04-29 13:16:38 -07:00
plugins lockable: add QemuRecMutex support 2020-03-17 15:18:45 +01:00
po ui/gtk: fix gettext message's charset. 2019-11-21 09:42:30 +01:00
python/qemu python/qemu: Kill QEMU process if 'quit' doesn't work 2020-03-21 22:37:32 +00:00
qapi qapi: Assert non-input visitors see only valid narrow integers 2020-04-30 07:26:40 +02:00
qga qga: Fix qmp_guest_suspend_{disk, ram}() error handling 2020-04-29 08:01:52 +02:00
qobject qobject: Eliminate qdict_iter(), use qdict_first(), qdict_next() 2020-04-30 06:51:15 +02:00
qom qemu-storage-daemon: Fix non-string --object properties 2020-04-30 17:51:07 +02:00
replay replay: record and replay random number sources 2020-01-07 12:08:39 +01:00
roms roms: opensbi: Upgrade from v0.6 to v0.7 2020-04-29 13:16:38 -07:00
scripts checkpatch: ignore allowed diff list 2020-05-04 10:25:02 -04:00
scsi scsi/qemu-pr-helper: Fix out-of-bounds access to trnptid_list[] 2020-03-16 22:07:24 +01:00
slirp@2faae0f778 slirp: update to fix CVE-2020-1983 2020-04-21 18:39:20 +01:00
softmmu qemu-option: pass NULL rather than 0 to the id of qemu_opts_set() 2020-04-29 08:01:52 +02: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 target/arm: Move gen_ function typedefs to translate.h 2020-05-04 12:59:26 +01:00
tcg tcg/mips: mips sync* encode error 2020-04-12 14:07:07 -07:00
tests acpi: unit-test: Update WAET ACPI Table expected binaries 2020-05-04 10:25:03 -04:00
tools/virtiofsd virtiofsd: drop all capabilities in the wait parent process 2020-05-01 20:05:37 +01:00
trace tracing: only allow -trace to override -D if set 2020-02-25 20:20:23 +00:00
ui ui/input-linux: Do not ignore ioctl() return value 2020-03-25 09:55:03 +01:00
util tools: Fix use of fcntl(F_SETFD) during socket activation 2020-05-04 14:54:35 -05:00
.cirrus.yml ci: build out-of-tree 2019-12-18 20:17:55 +00:00
.dir-locals.el
.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-opensbi.yml gitlab-ci.yml: Add jobs to build OpenSBI firmware binaries 2020-03-16 17:03:50 -07:00
.gitlab-ci.yml gitlab-ci.yml: Add jobs to build OpenSBI firmware binaries 2020-03-16 17:03:50 -07: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: Adjust maintainer's email 2020-03-17 13:51:24 +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: Cache acceptance-test assets 2020-04-06 20:03:14 +02:00
arch_init.c Add rx-softmmu 2020-03-19 17:58:05 +01:00
balloon.c Clean up inclusion of exec/cpu-common.h 2019-08-16 13:31:52 +02:00
block.c block-backend: Add flags to blk_truncate() 2020-04-30 17:51:07 +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-backend: Add flags to blk_truncate() 2020-04-30 17:51:07 +02: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 configure: disable PIE for Windows builds 2020-04-15 11:38:23 +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: Proper range-checking for -icount shift=N 2020-04-29 08:01:52 +02:00
device_tree.c device_tree: Constify compat in qemu_fdt_node_path() 2020-04-30 15:35:41 +01: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 exec: Fix for qemu_ram_resize() callback 2020-04-13 06:55:54 -04:00
gdbstub.c gdbstub: fix compiler complaining 2020-04-07 16:19:49 +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: take each job's lock individually in job_txn_apply 2020-04-07 14:34:47 +02:00
job.c job: take each job's lock individually in job_txn_apply 2020-04-07 14:34:47 +02: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 target-arm queue: 2020-04-30 15:45:34 +01:00
Makefile Makefile: Drop unused, broken target recurse-fuzz 2020-04-29 08:01:52 +02:00
Makefile.objs aspeed/smc: Add some tracing 2020-03-12 16:01:37 +00:00
Makefile.target update syscall numbers to linux 5.5 (with scripts) 2020-03-20 16:00:21 +00: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 memory: Simplify memory_region_init_rom_nomigrate() to ease review 2020-03-17 15:18:46 +01:00
module-common.c
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 qdev-monitor: print the device's clock with info qtree 2020-04-30 15:35:41 +01: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 block-backend: Add flags to blk_truncate() 2020-04-30 17:51:07 +02:00
qemu-io-cmds.c block-backend: Add flags to blk_truncate() 2020-04-30 17:51:07 +02: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
qemu-options.hx docs: Improve our gdbstub documentation 2020-04-14 13:15:40 +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: Fix non-string --object properties 2020-04-30 17:51:07 +02:00
qemu.nsi qemu.nsi: Install Sphinx documentation 2020-03-09 16:45:00 +00:00
qemu.sasl
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.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.1 development tree 2020-04-29 15:07:10 +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>`_