QEMU With E2K User Support
Go to file
Rainer Müller 5b63de6b54 linux-user: Use memfd for open syscall emulation
For certain paths in /proc, the open syscall is intercepted and the
returned file descriptor points to a temporary file with emulated
contents.

If TMPDIR is not accessible or writable for the current user (for
example in a read-only mounted chroot or container) tools such as ps
from procps may fail unexpectedly. Trying to read one of these paths
such as /proc/self/stat would return an error such as ENOENT or EROFS.

To relax the requirement on a writable TMPDIR, use memfd_create()
instead to create an anonymous file and return its file descriptor.

Signed-off-by: Rainer Müller <raimue@codingfarm.de>
Reviewed-by: Richard Henderson <richard.henderson@linaro.org>
Message-Id: <20220729154951.76268-1-raimue@codingfarm.de>
Signed-off-by: Laurent Vivier <laurent@vivier.eu>
2022-08-02 15:44:27 +02:00
.github/workflows github: fix config mistake preventing repo lockdown commenting 2022-04-26 16:12:26 +01:00
.gitlab/issue_templates GitLab: Add "Feature Request" issue template. 2021-06-25 10:08:37 +01:00
.gitlab-ci.d Revert "gitlab: disable accelerated zlib for s390x" 2022-07-20 12:15:09 +01:00
accel accel/kvm: Avoid Coverity warning in query_stats() 2022-07-22 19:01:44 +02:00
audio audio/dbus: fix building 2022-07-08 11:03:36 +02:00
authz configure, meson: convert pam detection to meson 2021-06-25 10:54:10 +02:00
backends crypto: Introduce RSA algorithm 2022-06-16 12:54:58 -04:00
block block/parallels: Fix buffer-based write call 2022-07-26 22:04:59 +03:00
bsd-user bsd-user: Remove stray 'inline' from do_bsd_close 2022-07-02 07:52:48 -06:00
chardev QIOChannel: Add flags on io_writev and introduce io_flush callback 2022-05-16 13:56:24 +01:00
common-user common-user: Only compile the common user code if have_user is set 2022-06-28 11:12:05 +02:00
configs hw/loongarch: Add fdt support 2022-07-19 22:55:10 +05:30
contrib contrib/vhost-user-blk: fix 32 bit build and enable 2022-06-27 18:53:18 -04:00
crypto crypto: Make block callbacks return 0 on success 2022-07-12 12:14:55 +02:00
disas disas: Remove libvixl disassembler 2022-07-05 10:15:49 +02:00
docs docs: Add caveats for Windows as the build platform 2022-07-22 19:01:44 +02:00
dtc@b6910bec11 dtc: Update to version 1.6.1 2021-10-14 08:08:11 +02:00
dump dump/win_dump: add 32-bit guest Windows support 2022-04-22 13:41:56 +04:00
ebpf ebpf: replace deprecated bpf_program__set_socket_filter 2022-07-06 11:39:09 +08:00
fpu * Fixes for s390x floating point vector instructions 2022-07-20 14:13:32 +01:00
fsdev Remove qemu-common.h include from most units 2022-04-06 14:31:55 +02:00
gdb-xml target/loongarch: Add gdb support. 2022-06-06 18:14:13 +00:00
hw pc,virtio: fixes 2022-07-26 12:57:20 -07:00
include i386/pc: restrict AMD only enforcing of 1Tb hole to new machine type 2022-07-26 10:40:58 -04:00
io QIOChannelSocket: Fix zero-copy flush returning code 1 when nothing sent 2022-07-20 12:15:09 +01:00
libdecnumber libdecnumber: Introduce decNumberIntegralToInt128 2021-11-09 10:32:52 +11:00
linux-headers kvm: add support for boolean statistics 2022-07-18 18:51:32 +02:00
linux-user linux-user: Use memfd for open syscall emulation 2022-08-02 15:44:27 +02:00
meson@12f9f04ba0 meson: bump submodule to 0.59.3 2021-11-02 15:57:28 +01:00
migration migration: Avoid false-positive on non-supported scenarios for zero-copy-send 2022-07-20 12:15:09 +01:00
monitor * Boolean statistics for KVM 2022-07-21 11:13:01 +01:00
nbd block: Change blk_{pread,pwrite}() param order 2022-07-12 12:14:56 +02:00
net net/colo.c: fix segmentation fault when packet is not parsed correctly 2022-07-20 16:58:08 +08:00
pc-bios pc-bios/s390-ccw: add -Wno-array-bounds 2022-07-13 16:58:58 +02:00
plugins Clean up header guards that don't match their file name 2022-05-11 16:49:06 +02:00
po po: add ukrainian translation 2022-07-05 10:15:49 +02:00
python python/qemu/qmp/legacy: Replace 'returns-whitelist' with the correct type 2022-07-18 20:28:06 +02:00
qapi * Boolean statistics for KVM 2022-07-21 11:13:01 +01:00
qga qga: treat get-guest-fsinfo as "best effort" 2022-07-18 20:24:36 +02:00
qobject include/qapi: add g_autoptr support for qobject types 2022-04-06 10:50:38 +02:00
qom include: add qemu/keyval.h 2022-04-21 17:03:51 +04:00
replay replay: simplify async event processing 2022-06-06 09:26:53 +02:00
roms New SeaBIOS-hppa version 6 2022-05-26 12:54:29 +02:00
scripts scripts/coverity-scan/COMPONENTS.md: Update slirp component info 2022-07-26 13:37:44 +01:00
scsi QIOChannel: Add flags on io_writev and introduce io_flush callback 2022-05-16 13:56:24 +01:00
semihosting semihosting: Remove qemu_semihosting_log_out 2022-07-12 22:32:12 +02:00
slirp@9d59bb775d slirp: bump submodule past 4.7 release 2022-05-12 12:29:44 +02:00
softmmu Migration pull 2022-07-20 2022-07-20 22:33:35 +01:00
storage-daemon qsd: Unlink absolute PID file path 2022-07-12 14:30:38 +02:00
stubs hw/i386/xen/xen-hvm: Inline xen_piix_pci_write_config_client() and remove it 2022-06-29 00:24:59 +02:00
subprojects libvhost-user: Fix VHOST_USER_ADD_MEM_REG reply 2022-06-27 18:53:18 -04:00
target target/arm: Add MO_128 entry to pred_esz_masks[] 2022-07-26 13:38:23 +01:00
tcg tcg: Fix returned type in alloc_code_gen_buffer_splitwx_memfd() 2022-07-12 10:30:10 +05:30
tests iotests/131: Add parallels regression test 2022-07-26 22:05:20 +03:00
tools Trivial: 3 char repeat typos 2022-06-28 11:06:02 +02:00
trace error: use GLib to remember the program name 2022-03-22 14:46:18 +04:00
ui gtk: Add show_tabs=on|off command line option. 2022-07-19 14:36:42 +02:00
util util: Fix broken build on Haiku 2022-07-19 11:32:21 +02:00
.cirrus.yml cirrus/win32: upgrade mingw base packages 2022-05-09 08:21:14 +02:00
.dir-locals.el Add .dir-locals.el file to configure emacs coding style 2015-10-08 19:46:01 +03:00
.editorconfig .editorconfig: update the automatic mode setting for Emacs 2021-03-10 15:34:11 +00:00
.exrc
.gdbinit .gdbinit: load QEMU sub-commands when gdb starts 2017-06-07 14:38:45 +01:00
.gitattributes gitattributes: Cover Objective-C source files 2022-03-29 00:15:14 +02:00
.gitignore .gitignore: add .gcov pattern 2022-02-09 12:08:41 +00:00
.gitlab-ci.yml docs: Document GitLab custom CI/CD variables 2021-07-29 07:56:01 +02:00
.gitmodules vfio-user: build library 2022-06-15 16:42:33 +01:00
.gitpublish Add a git-publish configuration file 2018-03-05 09:03:17 +00:00
.mailmap MAINTAINERS/.mailmap: update email for Leif Lindholm 2022-05-09 11:47:53 +01:00
.patchew.yml scripts/checkpatch: roll diff tweaking into checkpatch itself 2021-06-25 10:08:33 +01:00
.readthedocs.yml readthedocs: build with Python 3.6 2020-10-05 16:30:45 +01:00
.travis.yml Revert "gitlab: disable accelerated zlib for s390x" 2022-07-20 12:15:09 +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
Kconfig meson: Introduce target-specific Kconfig 2021-07-09 18:21:34 +02:00
Kconfig.host vfio-user: build library 2022-06-15 16:42:33 +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 myself as Guest Agent co-maintainer 2022-07-18 11:56:09 +03:00
Makefile cutils: Introduce bundle mechanism 2022-07-13 16:58:57 +02:00
README.rst README: Fix some documentation URLs 2021-10-23 20:28:12 +02:00
VERSION Update version for v7.1.0-rc0 release 2022-07-26 18:03:16 -07:00
block.c block: Change blk_{pread,pwrite}() param order 2022-07-12 12:14:56 +02:00
blockdev-nbd.c nbd/server: Allow MULTI_CONN for shared writable exports 2022-05-12 13:10:52 +02:00
blockdev.c Replace qemu_gettimeofday() with g_get_real_time() 2022-04-06 10:50:37 +02:00
blockjob.c assertions for blockjob.h global state API 2022-03-04 18:18:25 +01:00
configure configure: Avoid '==' bashism 2022-07-26 13:42:04 +01:00
cpu.c util/log: Remove qemu_log_close 2022-04-20 10:51:11 -07:00
cpus-common.c cpus: Introduce cpu_list_generation_id 2022-07-20 12:15:08 +01:00
disas.c disas: Remove libvixl disassembler 2022-07-05 10:15:49 +02:00
event-loop-base.c util/event-loop-base: Introduce options to set the thread pool size 2022-05-09 10:43:23 +01:00
gdbstub.c gdbstub: Adjust gdb_syscall_complete_cb declaration 2022-06-28 04:35:52 +05:30
gitdm.config contrib/gitdm: add a new interns group-map for GSoC/Outreachy work 2021-07-23 17:22:16 +01:00
hmp-commands-info.hx softmmu/dirtylimit: Implement dirty page rate limit 2022-07-20 12:15:08 +01:00
hmp-commands.hx softmmu/dirtylimit: Implement dirty page rate limit 2022-07-20 12:15:08 +01:00
iothread.c util/event-loop-base: Introduce options to set the thread pool size 2022-05-09 10:43:23 +01:00
job-qmp.c progressmeter: protect with a mutex 2021-06-25 14:24:24 +03:00
job.c job.h: assertions in the callers of JobDriver function pointers 2022-03-04 18:18:26 +01:00
memory_ldst.c.inc exec/memory_ldst: Use correct type sizes 2021-05-26 08:35:51 -07:00
meson.build linux-user: Unconditionally use pipe2() syscall 2022-07-25 10:42:11 +02:00
meson_options.txt meson: Prefix each element of firmware path 2022-07-13 16:58:57 +02:00
module-common.c all: Clean up includes 2016-02-04 17:41:30 +00:00
os-posix.c os-posix: replace pipe()+cloexec with g_unix_open_pipe(CLOEXEC) 2022-05-03 15:46:17 +04:00
os-win32.c Remove qemu-common.h include from most units 2022-04-06 14:31:55 +02:00
page-vary-common.c Remove qemu-common.h include from most units 2022-04-06 14:31:55 +02:00
page-vary.c include: move target page bits declaration to page-vary.h 2022-04-06 14:31:43 +02:00
qemu-bridge-helper.c qemu-bridge-helper: relocate path to default ACL 2020-09-30 19:11:36 +02:00
qemu-edid.c edid: set default resolution to 1280x800 (WXGA) 2022-01-13 10:59:16 +01:00
qemu-img-cmds.hx qemu-img: Unify [-b [-F]] documentation 2022-02-01 13:49:15 +01:00
qemu-img.c block: Change blk_pwrite_compressed() param order 2022-07-12 12:14:56 +02:00
qemu-io-cmds.c block: Change blk_pwrite_compressed() param order 2022-07-12 12:14:56 +02:00
qemu-io.c include: move qemu_*_exec_dir() to cutils 2022-05-28 11:42:56 +02:00
qemu-keymap.c qemu-keymap: Add license in generated files 2021-12-17 10:41:50 +01:00
qemu-nbd.c qemu-nbd: Pass max connections to blockdev layer 2022-05-12 13:10:52 +02:00
qemu-options.hx gtk: Add show_tabs=on|off command line option. 2022-07-19 14:36:42 +02:00
qemu.nsi nsis installer: Fix mouse-over descriptions for emulators 2022-03-18 10:55:15 +00:00
qemu.sasl sasl: remove comment about obsolete kerberos versions 2021-06-14 13:28:50 +01:00
replication.c replication: move include out of root directory 2021-05-26 14:49:46 +02:00
trace-events tracing: remove TCG memory access tracing 2022-02-09 12:08:42 +00:00
version.rc configure: remove CONFIG_FILEVERSION and CONFIG_PRODUCTVERSION 2021-01-02 21:03:37 +01: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.


Documentation
=============

Documentation can be found hosted online at
`<https://www.qemu.org/documentation/>`_. The documentation for the
current development version that is available at
`<https://www.qemu.org/docs/master/>`_ is generated from the ``docs/``
folder in the source tree, and is built by `Sphinx
<https://www.sphinx-doc.org/en/master/>_`.


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://wiki.qemu.org/Hosts/Linux>`_
* `<https://wiki.qemu.org/Hosts/Mac>`_
* `<https://wiki.qemu.org/Hosts/W32>`_


Submitting patches
==================

The QEMU source code is maintained under the GIT version control system.

.. code-block:: shell

   git clone https://gitlab.com/qemu-project/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 `style section
<https://www.qemu.org/docs/master/devel/style.html>` of
the Developers Guide.

Additional information on submitting patches can be found online via
the QEMU website

* `<https://wiki.qemu.org/Contribute/SubmitAPatch>`_
* `<https://wiki.qemu.org/Contribute/TrivialPatches>`_

The QEMU website is also maintained under source control.

.. code-block:: shell

  git clone https://gitlab.com/qemu-project/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 GitLab issues to track bugs. Bugs
found when running code built from QEMU git or upstream released sources
should be reported via:

* `<https://gitlab.com/qemu-project/qemu/-/issues>`_

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 GitLab.

For additional information on bug reporting consult:

* `<https://wiki.qemu.org/Contribute/ReportABug>`_


ChangeLog
=========

For version history and release notes, please visit
`<https://wiki.qemu.org/ChangeLog/>`_ or look at the git history for
more detailed information.


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://wiki.qemu.org/Contribute/StartHere>`_