Go to file
Peter Maydell 4dad0a9aa8 QOM queue, 2020-09-18
Fixes:
 * Error value corrections (Markus Armbruster)
 * Correct object_class_dynamic_cast_assert() documentation (Eduardo Habkost)
 * Ensure objects using QEMU_ALIGNED are properly aligned (Richard Henderson)
 
 QOM cleanups (Eduardo Habkost):
 * Rename some constants
 * Simplify parameters of OBJECT_DECLARE* macros
 * Additional DECLARE_*CHECKER* usage
 * Additional OBJECT_DECLARE_TYPE usage
 * Additional OBJECT_DECLARE_SIMPLE_TYPE usage
 -----BEGIN PGP SIGNATURE-----
 
 iQJIBAABCAAyFiEEWjIv1avE09usz9GqKAeTb5hNxaYFAl9lHGkUHGVoYWJrb3N0
 QHJlZGhhdC5jb20ACgkQKAeTb5hNxaayNA/7BTeopz5AVmt1nXe/OLE2/xjZw1y6
 WpguYVITR6IoBBJdLqj95CXKkYMtCiBUmMIcBS8JJqwzlbvMHOBbLAvcHNItcZcS
 r8gXjhsbxiOt7GY8HwEA+BdNtwup88NdT1siKxaNulQAAzs+4LUfg6A5FVr9GoF/
 Y4G9Qj+CmyKqJU8Pv4QVRix90PaUuRXXKyTuWeOR4sRweMRbqNgI6k9jYBlk/2FJ
 GQqkZb2azs7sxQjqqG/g8/uh+abot2EO2ksq+bt9HEh5ILi8M1QiylgIaHfzdrVD
 UloApsBPxsURCnrW9NWw4s74TTvUPom3Y0FwenHd+8zsgg2JUCc5V/p8HgUtazvh
 zaWDFYExoeW5hmjvtq2x7DhdaY80R5MjFuGvR4YfEg7YtT9LYxmq/xOJ6CK0PFbW
 BzYJ0xyT/w9JVUbV+ppxyZv+h/tH/pSjvR7CoBzvuw+OIDXFEaZYjPwQ8MN8v6Cl
 y+wsSZjaySB5OWCv9ENvoGagfV8QwMI6fl0vkFtzN+vyoV1mPJsfILSidm77KvMR
 sQbpcQUsmMcp5JBURiS9HPGSzcKzJPzEeq7NJPpMYDQoA5CqrA6bg5gIHjyG3Zb4
 OKpnS05ZmsUGs9p+006SAILM4BOqxTCFikn/hN2WeSVAdrwbtzx1izpuifkftoR7
 hXanH9zcfYdIPVE=
 =WDHr
 -----END PGP SIGNATURE-----

Merge remote-tracking branch 'remotes/ehabkost/tags/machine-next-pull-request' into staging

QOM queue, 2020-09-18

Fixes:
* Error value corrections (Markus Armbruster)
* Correct object_class_dynamic_cast_assert() documentation (Eduardo Habkost)
* Ensure objects using QEMU_ALIGNED are properly aligned (Richard Henderson)

QOM cleanups (Eduardo Habkost):
* Rename some constants
* Simplify parameters of OBJECT_DECLARE* macros
* Additional DECLARE_*CHECKER* usage
* Additional OBJECT_DECLARE_TYPE usage
* Additional OBJECT_DECLARE_SIMPLE_TYPE usage

# gpg: Signature made Fri 18 Sep 2020 21:45:29 BST
# gpg:                using RSA key 5A322FD5ABC4D3DBACCFD1AA2807936F984DC5A6
# gpg:                issuer "ehabkost@redhat.com"
# gpg: Good signature from "Eduardo Habkost <ehabkost@redhat.com>" [full]
# Primary key fingerprint: 5A32 2FD5 ABC4 D3DB ACCF  D1AA 2807 936F 984D C5A6

* remotes/ehabkost/tags/machine-next-pull-request:
  Use OBJECT_DECLARE_SIMPLE_TYPE when possible
  Use OBJECT_DECLARE_TYPE when possible
  qom: Remove module_obj_name parameter from OBJECT_DECLARE* macros
  qom: Remove ParentClassType argument from OBJECT_DECLARE_SIMPLE_TYPE
  scripts/codeconverter: Update to latest version
  target/s390x: Set instance_align on S390CPU TypeInfo
  target/riscv: Set instance_align on RISCVCPU TypeInfo
  target/ppc: Set instance_align on PowerPCCPU TypeInfo
  target/arm: Set instance_align on CPUARM TypeInfo
  qom: Allow objects to be allocated with increased alignment
  qom: Correct error values in two contracts
  qom: Clean up object_property_get_enum()'s error value
  qom: Correct object_class_dynamic_cast_assert() documentation
  sifive: Use DECLARE_*CHECKER* macros
  sifive: Move QOM typedefs and add missing includes
  sifive_u: Rename memmap enum constants
  sifive_e: Rename memmap enum constants

Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
2020-09-21 18:55:39 +01: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 cross-compiling build tests 2020-09-07 12:34:17 +02:00
accel util: rename qemu_open() to qemu_open_old() 2020-09-16 10:33:48 +01:00
audio trace-events: Delete unused trace points 2020-09-09 17:17:02 +01:00
authz qom: Remove ParentClassType argument from OBJECT_DECLARE_SIMPLE_TYPE 2020-09-18 14:12:32 -04:00
backends Use OBJECT_DECLARE_SIMPLE_TYPE when possible 2020-09-18 14:12:32 -04:00
block block/file: switch to use qemu_open/qemu_create for improved errors 2020-09-16 10:33:48 +01:00
bsd-user meson: bsd-user 2020-08-21 06:30:38 -04:00
capstone@22ead3e0bf
chardev util: rename qemu_open() to qemu_open_old() 2020-09-16 10:33:48 +01:00
contrib plugins: move the more involved plugins to contrib 2020-09-10 10:47:03 +01:00
crypto qom: Remove ParentClassType argument from OBJECT_DECLARE_SIMPLE_TYPE 2020-09-18 14:12:32 -04:00
default-configs hw/arm: Add two NPCM7xx-based machines 2020-09-14 14:24:58 +01:00
disas configure: move disassembler configuration to meson 2020-09-08 11:43:16 +02:00
docs i386/kvm: correct the meaning of '0xffffffff' value for hv-spinlocks 2020-09-18 13:49:54 -04:00
dtc@85e5d83984 Makefile: dtc: update, build the libfdt target 2020-06-16 14:49:05 +01:00
dump util: rename qemu_open() to qemu_open_old() 2020-09-16 10:33:48 +01:00
fpu softfloat: Define misc operations for bfloat16 2020-08-28 10:48:07 -07:00
fsdev 9pfs: disable msize warning for synth driver 2020-09-15 12:12:03 +02:00
gdb-xml target/avr: CPU class: Add GDB support 2020-07-10 17:58:32 +02:00
hw Use OBJECT_DECLARE_SIMPLE_TYPE when possible 2020-09-18 14:12:32 -04:00
include QOM queue, 2020-09-18 2020-09-21 18:55:39 +01:00
io qom: Remove ParentClassType argument from OBJECT_DECLARE_SIMPLE_TYPE 2020-09-18 14:12:32 -04:00
libdecnumber meson: target 2020-08-21 06:30:35 -04:00
linux-headers linux-headers: update again to 5.8 2020-07-10 19:26:55 -04:00
linux-user linux-user: test, don't assert addr != test in pgb_reserved_va 2020-09-16 09:56:39 +01:00
meson@68ed748f84 meson: bump submodule to 0.55.1 2020-09-01 01:51:51 -04:00
migration Use OBJECT_DECLARE_SIMPLE_TYPE when possible 2020-09-18 14:12:32 -04:00
monitor monitor: simplify functions for getting a dup'd fdset entry 2020-09-16 10:33:48 +01:00
nbd nbd: Use CAF when looking for dirty bitmap 2020-09-07 12:31:31 +02:00
net Use OBJECT_DECLARE_SIMPLE_TYPE when possible 2020-09-18 14:12:32 -04:00
pc-bios seabios: add bios-microvm.bin binary 2020-09-17 14:16:19 +02:00
plugins meson: link emulators without Makefile.target 2020-08-21 06:30:40 -04:00
po meson: convert po/ 2020-08-21 06:30:45 -04:00
python/qemu python/qemu: Change ConsoleSocket to optionally drain socket. 2020-07-27 09:41:56 +01:00
qapi Block layer patches: 2020-09-11 14:47:49 +01:00
qga * Fix "readlink -f" problem in iotests on macOS (to fix the Cirrus-CI tests) 2020-09-17 13:38:08 +01:00
qobject libqemuutil, qapi, trace: convert to meson 2020-08-21 06:30:08 -04:00
qom qom: Allow objects to be allocated with increased alignment 2020-09-18 13:59:51 -04:00
replay meson: convert replay directory to Meson 2020-08-21 06:30:23 -04:00
roms seabios: add microvm config, update build rules 2020-09-17 14:16:19 +02:00
scripts QOM queue, 2020-09-18 2020-09-21 18:55:39 +01:00
scsi Use OBJECT_DECLARE_SIMPLE_TYPE when possible 2020-09-18 14:12:32 -04:00
slirp@ce94eba204 slirp: update to latest stable-4.2 branch 2020-07-28 18:27:59 +04:00
softmmu softmmu: Add missing trace-events file 2020-09-09 17:15:18 +01:00
storage-daemon meson: convert qemu-storage-daemon 2020-08-21 06:30:23 -04:00
stubs monitor: simplify functions for getting a dup'd fdset entry 2020-09-16 10:33:48 +01:00
target QOM queue, 2020-09-18 2020-09-21 18:55:39 +01:00
tcg tcg: Implement 256-bit dup for tcg_gen_gvec_dup_mem 2020-09-03 13:13:58 -07:00
tests QOM queue, 2020-09-18 2020-09-21 18:55:39 +01:00
tools meson: use meson datadir instead of qemu_datadir 2020-09-01 08:51:33 -04:00
trace meson: use meson datadir instead of qemu_datadir 2020-09-01 08:51:33 -04:00
ui qom: Remove module_obj_name parameter from OBJECT_DECLARE* macros 2020-09-18 14:12:32 -04:00
util * Fix "readlink -f" problem in iotests on macOS (to fix the Cirrus-CI tests) 2020-09-17 13:38:08 +01:00
.cirrus.yml cirrus: Building freebsd in a single shot 2020-09-16 12:15:07 +02:00
.dir-locals.el
.editorconfig meson: rename included C source files to .c.inc 2020-08-21 06:18:30 -04:00
.exrc
.gdbinit
.gitignore Simplify the .gitignore file 2020-09-16 08:41:06 +02:00
.gitlab-ci.yml configure: add [lm32|unicore32]-softmmu to deprecation logic 2020-09-16 10:07:01 +01:00
.gitmodules roms: Add virtual Boot ROM for NPCM7xx SoCs 2020-09-14 14:24:59 +01:00
.gitpublish
.mailmap mailmap: Add entry for Greg Kurz 2020-09-01 11:13:02 +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 configure: add [lm32|unicore32]-softmmu to deprecation logic 2020-09-16 10:07:01 +01:00
.travis.yml gitlab: create a build-deprecated target 2020-09-16 10:07:01 +01:00
block.c block: Leave BDS.backing_{file,format} constant 2020-09-07 12:31:31 +02:00
blockdev-nbd.c blockdev-nbd: Boxed argument type for nbd-server-add 2020-03-06 17:21:28 +01:00
blockdev.c blockdev: Fix active commit choice 2020-09-07 12:31:31 +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 CODING_STYLE.rst: flesh out our naming conventions. 2020-09-10 10:34:58 +01:00
configure configure: add [lm32|unicore32]-softmmu to deprecation logic 2020-09-16 10:07:01 +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 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 target/arm: Move start-powered-off property to generic CPUState 2020-09-08 10:08:42 +10: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 Use DECLARE_*CHECKER* macros 2020-09-09 09:27:09 -04: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 kconfig: fix comment referring to old Makefiles 2020-09-10 16:20:49 +02:00
LICENSE tcg/LICENSE: Remove out of date claim about TCG subdirectory licensing 2019-11-11 15:11:21 +01:00
MAINTAINERS roms: Add virtual Boot ROM for NPCM7xx SoCs 2020-09-14 14:24:59 +01:00
Makefile Makefile: remove obsolete edk2 exception from "clean" rule 2020-09-13 23:03:14 +02:00
memory_ldst.c.inc meson: rename included C source files to .c.inc 2020-08-21 06:18:30 -04:00
meson_options.txt meson: add description to options 2020-09-01 08:51:44 -04:00
meson.build meson: remove empty else and duplicated gio deps 2020-09-16 08:41:06 +02:00
module-common.c
os-posix.c util: rename qemu_open() to qemu_open_old() 2020-09-16 10:33:48 +01: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: Explicit number replaced by a constant 2020-09-15 11:05:13 +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 block: add missing socket_init() calls to tools 2020-09-02 16:47:39 -05:00
qemu-keymap.c Include qemu-common.h exactly where needed 2019-06-12 13:20:20 +02:00
qemu-nbd.c nbd: disable signals and forking on Windows builds 2020-09-02 16:48:21 -05:00
qemu-options-wrapper.h
qemu-options.h
qemu-options.hx qemu-options.hx: Fix typo for netdev documentation 2020-09-01 09:17:58 +02:00
qemu-seccomp.c seccomp: fix killing of whole process instead of thread 2020-09-15 12:56:26 +02:00
qemu.nsi qemu.nsi: Install Sphinx documentation 2020-03-09 16:45:00 +00:00
qemu.sasl
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
thunk.c linux-user: Add strace support for printing arguments for ioctls used for terminals and serial lines 2020-08-27 12:29:50 +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-events: Fix attribution of trace points to source 2020-09-09 17:17:58 +01:00
VERSION Open 5.2 development tree 2020-08-18 13:44:04 +01:00
version.rc
version.texi.in meson: build texi doc 2020-08-21 06:30:42 -04: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>`_