QEMU With E2K User Support
Go to file
David Gibson 6c8ebe30ea spapr: Add PEF based confidential guest support
Some upcoming POWER machines have a system called PEF (Protected
Execution Facility) which uses a small ultravisor to allow guests to
run in a way that they can't be eavesdropped by the hypervisor.  The
effect is roughly similar to AMD SEV, although the mechanisms are
quite different.

Most of the work of this is done between the guest, KVM and the
ultravisor, with little need for involvement by qemu.  However qemu
does need to tell KVM to allow secure VMs.

Because the availability of secure mode is a guest visible difference
which depends on having the right hardware and firmware, we don't
enable this by default.  In order to run a secure guest you need to
create a "pef-guest" object and set the confidential-guest-support
property to point to it.

Note that this just *allows* secure guests, the architecture of PEF is
such that the guest still needs to talk to the ultravisor to enter
secure mode.  Qemu has no direct way of knowing if the guest is in
secure mode, and certainly can't know until well after machine
creation time.

To start a PEF-capable guest, use the command line options:
    -object pef-guest,id=pef0 -machine confidential-guest-support=pef0

Signed-off-by: David Gibson <david@gibson.dropbear.id.au>
Reviewed-by: Greg Kurz <groug@kaod.org>
2021-02-08 16:57:38 +11: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: Add alpine to pipeline 2021-01-20 10:46:54 +01:00
accel confidential guest support: Move SEV initialization into arch specific code 2021-02-08 16:57:38 +11:00
audio audio: space prohibited between function name and parenthesis'(' 2021-01-15 11:49:26 +01:00
authz authz-simple: Check that 'identity' property is set 2020-11-18 10:51:35 +00:00
backends confidential guest support: Introduce new confidential guest support class 2021-02-08 16:57:37 +11:00
block block/nbd: only enter connection coroutine if it's present 2021-02-03 08:17:12 -06:00
bsd-user accel: replace struct CpusAccel with AccelOpsClass 2021-02-05 10:24:15 -10:00
capstone@f8b1b83301 capstone: Update to upstream "next" branch 2020-10-03 04:23:14 -05:00
chardev chardev: check if the chardev is registered for yanking 2021-02-04 15:58:54 +01:00
contrib vhost-user-gpu: handle display-info in a callback 2021-02-04 15:58:54 +01:00
crypto crypto: Add spaces around operator 2021-01-29 17:07:53 +00:00
default-configs Testing, gdbstub and semihosting patches: 2021-01-18 12:10:20 +00:00
disas build-system: clean up TCG/TCI configury 2021-01-21 13:00:41 +01:00
docs spapr: Add PEF based confidential guest support 2021-02-08 16:57:38 +11:00
dtc@85e5d83984 Makefile: dtc: update, build the libfdt target 2020-06-16 14:49:05 +01:00
dump qapi: More complex uses of QAPI_LIST_APPEND 2021-01-28 08:08:45 +01:00
fpu softfloat: Define misc operations for bfloat16 2020-08-28 10:48:07 -07:00
fsdev meson: Declare have_virtfs_proxy_helper in main meson.build 2021-01-23 15:55:04 -05:00
gdb-xml target/riscv: Remove built-in GDB XML files for CSRs 2021-01-16 10:57:21 -08:00
hw spapr: Add PEF based confidential guest support 2021-02-08 16:57:38 +11:00
include spapr: Add PEF based confidential guest support 2021-02-08 16:57:38 +11:00
io Yank patches patches for 2021-01-13 2021-01-13 14:19:24 +00:00
libdecnumber qemu/: fix some comment spelling errors 2020-09-17 20:35:43 +02:00
linux-headers Update linux headers to 5.11-rc2 2021-01-21 11:19:45 +01:00
linux-user accel: replace struct CpusAccel with AccelOpsClass 2021-02-05 10:24:15 -10:00
meson@776acd2a80 submodules: bump meson to 0.55.3 2020-10-17 10:45:42 -04:00
migration qapi: More complex uses of QAPI_LIST_APPEND 2021-01-28 08:08:45 +01:00
monitor qmp: Resume OOB-enabled monitor before processing the request 2021-02-04 13:20:29 +01:00
nbd nbd/server: Quiesce coroutines on context switch 2021-01-20 14:48:54 -06:00
net Trivial patches 20210129 2021-01-29 10:10:43 +00:00
pc-bios meson.build: Detect bzip2 program 2021-01-23 15:55:07 -05:00
plugins cfi: Initial support for cfi-icall in QEMU 2021-01-02 21:03:35 +01:00
po configure: move gettext detection to meson.build 2021-01-02 21:03:09 +01:00
python python: add __repr__ to ConsoleSocket to aid debugging 2021-01-02 21:03:09 +01:00
qapi qapi: backup: disable copy_range by default 2021-01-26 14:36:37 +01:00
qga qapi: More complex uses of QAPI_LIST_APPEND 2021-01-28 08:08:45 +01:00
qobject qobject: braces {} are necessary for all arms of this statement 2021-02-04 13:20:29 +01:00
qom qom: Allow optional sugar props 2021-02-08 16:57:37 +11:00
replay Remove superfluous timer_del() calls 2021-01-08 15:13:38 +00:00
roms qboot: update to latest upstream 2020-11-20 10:48:53 -05:00
scripts simpletrace: build() missing 2 required positional arguments 2021-02-01 10:51:00 +00:00
scsi qapi: Use QAPI_LIST_APPEND in trivial cases 2021-01-28 08:08:45 +01:00
slirp@8f43a99191 slirp: update to fix CVE-2020-29129 CVE-2020-29130 2020-11-27 20:57:11 +04:00
softmmu confidential guest support: Introduce cgs "ready" flag 2021-02-08 16:57:38 +11:00
storage-daemon block: move blk_exp_close_all() to qemu_cleanup() 2021-02-02 13:23:47 +01:00
stubs Fix build with new yank feature by adding stubs 2021-01-18 10:04:31 +00:00
subprojects/libvhost-user build-sys: add libvhost-user missing dependencies 2021-01-23 09:26:41 -05:00
target spapr: Add PEF based confidential guest support 2021-02-08 16:57:38 +11:00
tcg tcg/tci: Remove TCG_CONST 2021-02-05 10:24:14 -10:00
tests pc,virtio,pci: fixes, features,code removal 2021-02-05 15:27:02 +00:00
tools virtiofsd: Add restart_syscall to the seccomp whitelist 2021-02-04 17:50:08 +00:00
trace trace: add meson custom_target() depend_files for tracetool 2021-02-01 10:50:55 +00:00
ui display/ui: add a callback to indicate GL state is flushed 2021-02-04 15:58:54 +01:00
util util/iov: make qemu_iovec_init_extended() honest 2021-02-03 08:00:33 -06:00
.cirrus.yml cirrus/msys2: Cache msys2 mingw in a better way. 2021-01-12 12:38:03 +01:00
.dir-locals.el
.editorconfig meson: rename included C source files to .c.inc 2020-08-21 06:18:30 -04:00
.exrc
.gdbinit
.gitattributes buildsys: Help git-diff adding .gitattributes config file 2020-11-18 09:33:16 +01:00
.gitignore Makefile: add GNU global tags support 2021-01-18 10:04:31 +00:00
.gitlab-ci.yml gitlab-ci.yml: Avoid recompiling the sources in the test jobs 2021-01-27 04:47:40 +01:00
.gitmodules gitmodules: add qemu.org vbootrom submodule 2020-09-23 13:44:59 +01:00
.gitpublish
.mailmap MAINTAINERS: chenhc@lemote.com -> chenhuacai@kernel.org 2020-12-13 16:00:58 +01:00
.patchew.yml
.readthedocs.yml readthedocs: build with Python 3.6 2020-10-05 16:30:45 +01:00
.shippable.yml shippable.yml: Remove jobs duplicated on Gitlab-CI 2021-01-18 10:04:31 +00:00
.travis.yml gitlab: migrate the minimal tools and unit tests from Travis 2021-01-18 10:04:31 +00:00
CODING_STYLE.rst CODING_STYLE.rst: Be less strict about 80 character limit 2020-12-13 17:51:33 +01:00
COPYING
COPYING.LIB
Kconfig Makefile: simplify MINIKCONF rules 2020-07-10 18:02:21 -04:00
Kconfig.host configure: Fix build dependencies with vhost-vdpa. 2020-09-29 02:15:24 -04:00
LICENSE tcg/LICENSE: Remove out of date claim about TCG subdirectory licensing 2019-11-11 15:11:21 +01:00
MAINTAINERS accel: introduce AccelCPUClass extending CPUClass 2021-02-05 10:24:15 -10:00
Makefile configure: replace --enable/disable-git-update with --with-git-submodules 2021-01-29 17:07:53 +00:00
README.rst CHANGELOG: remove disused file 2020-10-27 16:48:50 +01:00
VERSION Open 6.0 development tree 2020-12-08 21:04:57 +00:00
block.c block: move blk_exp_close_all() to qemu_cleanup() 2021-02-02 13:23:47 +01:00
blockdev-nbd.c nbd: Update qapi to support exporting multiple bitmaps 2020-10-30 15:10:15 -05:00
blockdev.c qapi: Use QAPI_LIST_APPEND in trivial cases 2021-01-28 08:08:45 +01:00
blockjob.c blockjob: add set_speed to BlockJobDriver 2021-01-26 14:36:37 +01:00
configure configure: Fix --enable-tcg-interpreter 2021-02-05 10:24:14 -10:00
cpu.c accel/tcg: split TCG-only code from cpu_exec_realizefn 2021-02-05 10:24:14 -10:00
cpus-common.c overall/alpha tcg cpus|hppa: Fix Lesser GPL version number 2020-11-15 16:43:54 +01:00
disas.c disas: Push const down through host disassembly 2021-01-07 05:09:42 -10:00
exec-vary.c nomaintainer: Fix Lesser GPL version number 2020-11-15 17:04:40 +01:00
gdbstub.c gdbstub: ensure we clean-up when terminated 2021-01-18 10:05:06 +00:00
gitdm.config
hmp-commands-info.hx replay: introduce info hmp/qmp command 2020-10-06 08:34:49 +02:00
hmp-commands.hx hmp: remove "change vnc TARGET" command 2021-01-23 15:55:07 -05:00
iothread.c qapi: Use QAPI_LIST_APPEND in trivial cases 2021-01-28 08:08:45 +01:00
job-qmp.c qapi: Use QAPI_LIST_APPEND in trivial cases 2021-01-28 08:08:45 +01:00
job.c job: call job_enter from job_pause 2021-01-26 14:36:37 +01:00
memory_ldst.c.inc nomaintainer: Fix Lesser GPL version number 2020-11-15 17:04:40 +01:00
meson.build trace: add meson custom_target() depend_files for tracetool 2021-02-01 10:50:55 +00:00
meson_options.txt meson: convert wixl detection to Meson 2021-01-23 15:55:05 -05:00
module-common.c
os-posix.c os: deprecate the -enable-fips option and QEMU's FIPS enforcement 2021-01-29 17:07:53 +00:00
os-win32.c vl: relocate paths to data directories 2020-09-30 19:11:36 +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 qemu-edid: drop cast 2020-10-14 06:05:56 +02:00
qemu-img-cmds.hx qemu-img: add support for rate limit in qemu-img convert 2020-10-27 15:26:20 +01:00
qemu-img.c qapi: Use QAPI_LIST_APPEND in trivial cases 2021-01-28 08:08:45 +01:00
qemu-io-cmds.c qemu-io: add preallocate mode parameter for truncate command 2020-12-18 12:35:55 +01:00
qemu-io.c trace: remove argument from trace_init_file 2020-11-11 13:08:09 +00:00
qemu-keymap.c
qemu-nbd.c block: move blk_exp_close_all() to qemu_cleanup() 2021-02-02 13:23:47 +01:00
qemu-options-wrapper.h
qemu-options.h
qemu-options.hx hostmem-file: add readonly=on|off option 2021-02-01 17:07:34 -05:00
qemu.nsi nsis: adjust for new MinGW paths 2021-01-23 15:55:05 -05:00
qemu.sasl
replication.c
replication.h
thunk.c overall usermode...: Fix Lesser GPL version number 2020-11-15 16:43:40 +01:00
trace-events trace-events: Fix attribution of trace points to source 2020-09-09 17:17:58 +01: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.


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


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