Go to file
Markus Armbruster d5938f29fe Clean up inclusion of sysemu/sysemu.h
In my "build everything" tree, changing sysemu/sysemu.h triggers a
recompile of some 5400 out of 6600 objects (not counting tests and
objects that don't depend on qemu/osdep.h).

Almost a third of its inclusions are actually superfluous.  Delete
them.  Downgrade two more to qapi/qapi-types-run-state.h, and move one
from char/serial.h to char/serial.c.

hw/semihosting/config.c, monitor/monitor.c, qdev-monitor.c, and
stubs/semihost.c define variables declared in sysemu/sysemu.h without
including it.  The compiler is cool with that, but include it anyway.

This doesn't reduce actual use much, as it's still included into
widely included headers.  The next commit will tackle that.

Signed-off-by: Markus Armbruster <armbru@redhat.com>
Reviewed-by: Alistair Francis <alistair.francis@wdc.com>
Message-Id: <20190812052359.30071-27-armbru@redhat.com>
Reviewed-by: Alex Bennée <alex.bennee@linaro.org>
2019-08-16 13:31:53 +02:00
accel Clean up inclusion of sysemu/sysemu.h 2019-08-16 13:31:53 +02:00
audio Include hw/hw.h exactly where needed 2019-08-16 13:31:52 +02:00
authz Include qemu/module.h where needed, drop it from qemu-common.h 2019-06-12 13:18:33 +02:00
backends Include hw/boards.h a bit less 2019-08-16 13:31:53 +02:00
block Clean up inclusion of sysemu/sysemu.h 2019-08-16 13:31:53 +02:00
bsd-user Include qemu-common.h exactly where needed 2019-06-12 13:20:20 +02:00
capstone@22ead3e0bf disas: Add capstone as submodule 2017-10-26 11:56:20 +02:00
chardev Include qemu/main-loop.h less 2019-08-16 13:31:52 +02:00
contrib contrib/elf2dmp: Build download.o with CURL_CFLAGS 2019-07-22 14:07:39 +01:00
crypto crypto: Fix LGPL information in the file headers 2019-07-19 14:21:25 +01:00
default-configs MIPS queue for July 2nd, 2019 2019-07-03 21:19:03 +01:00
disas disas/riscv: Fix rdinstreth constraint 2019-06-27 02:47:04 -07:00
docs virtio, pc: fixes, cleanups 2019-07-25 16:38:24 +01:00
dtc@88f18909db Update dtc/libfdt submodule to v1.4.7 2018-10-02 13:53:26 +10:00
dump Clean up inclusion of sysemu/sysemu.h 2019-08-16 13:31:53 +02:00
fpu hardfloat: fix float32/64 fused multiply-add 2019-03-25 10:35:32 +00:00
fsdev Include qemu/main-loop.h less 2019-08-16 13:31:52 +02:00
gdb-xml RISC-V: Add 64-bit gdb xml files. 2019-03-19 05:13:24 -07:00
hw Clean up inclusion of sysemu/sysemu.h 2019-08-16 13:31:53 +02:00
include Clean up inclusion of sysemu/sysemu.h 2019-08-16 13:31:53 +02:00
io Include qemu-common.h exactly where needed 2019-06-12 13:20:20 +02:00
libdecnumber build: remove CONFIG_LIBDECNUMBER 2017-10-16 18:03:52 +02:00
linux-headers linux-headers: sync with latest KVM headers from Linux 5.2 2019-06-21 13:23:47 +02:00
linux-user Include qemu/queue.h slightly less 2019-08-16 13:31:52 +02:00
migration Include hw/qdev-properties.h less 2019-08-16 13:31:53 +02:00
monitor Clean up inclusion of sysemu/sysemu.h 2019-08-16 13:31:53 +02:00
nbd Include qemu/main-loop.h less 2019-08-16 13:31:52 +02:00
net Clean up inclusion of sysemu/sysemu.h 2019-08-16 13:31:53 +02:00
pc-bios roms: Add OpenSBI version 0.4 2019-07-18 14:18:43 -07:00
po po/Makefile: Modern shell scripting (use $() instead of ``) 2018-10-24 07:39:10 +01:00
python/qemu iotests: Add @has_quit to vm.shutdown() 2019-07-19 13:19:17 +02:00
qapi Include qemu/queue.h slightly less 2019-08-16 13:31:52 +02:00
qga Include qemu-common.h exactly where needed 2019-06-12 13:20:20 +02:00
qobject qemu-common: Move qemu_isalnum() etc. to qemu/ctype.h 2019-06-11 20:22:09 +02:00
qom Clean up inclusion of sysemu/sysemu.h 2019-08-16 13:31:53 +02:00
replay Clean up inclusion of sysemu/sysemu.h 2019-08-16 13:31:53 +02:00
roms riscv: roms: Fix make rules for building sifive_u bios 2019-08-13 12:46:24 +01:00
scripts trace: Do not include qom/cpu.h into generated trace.h 2019-08-16 13:31:52 +02:00
scsi iscsi: base all handling of check condition on scsi_sense_to_errno 2019-07-15 11:20:42 +02:00
slirp@126c04acba slirp: update with CVE-2019-14378 fix 2019-08-02 15:14:56 +04:00
stubs Clean up inclusion of sysemu/sysemu.h 2019-08-16 13:31:53 +02:00
target Clean up inclusion of sysemu/sysemu.h 2019-08-16 13:31:53 +02:00
tcg Include qemu/main-loop.h less 2019-08-16 13:31:52 +02:00
tests Clean up inclusion of sysemu/sysemu.h 2019-08-16 13:31:53 +02:00
trace trace: Do not include qom/cpu.h into generated trace.h 2019-08-16 13:31:52 +02:00
ui Clean up inclusion of sysemu/sysemu.h 2019-08-16 13:31:53 +02:00
util Clean up inclusion of sysemu/sysemu.h 2019-08-16 13:31:53 +02:00
.cirrus.yml cirrus / travis: Add gnu-sed and bash for macOS and FreeBSD 2019-05-21 10:12:47 +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: add setting for shell scripts 2019-06-12 17:53:22 +01:00
.exrc qemu: add .exrc 2012-09-07 09:02:44 +03:00
.gdbinit .gdbinit: load QEMU sub-commands when gdb starts 2017-06-07 14:38:45 +01:00
.gitignore Makefile: install the edk2 firmware images and their descriptors 2019-04-17 15:38:35 +02:00
.gitlab-ci.yml gitlab-ci.yml: Test the TCG interpreter in a CI pipeline 2019-05-02 16:56:33 +02:00
.gitmodules roms: Add OpenSBI version 0.4 2019-07-18 14:18:43 -07:00
.gitpublish Add a git-publish configuration file 2018-03-05 09:03:17 +00:00
.mailmap maint: Grammar fix to mailmap 2018-12-11 18:35:54 +01:00
.patchew.yml ci: store Patchew configuration in the tree 2019-06-03 14:03:02 +02:00
.shippable.yml shippable: re-enable the windows cross builds 2019-07-23 15:53:25 +01:00
.travis.yml travis: enable travis_retry for check phase 2019-07-23 15:53:25 +01:00
arch_init.c Include qemu-common.h exactly where needed 2019-06-12 13:20:20 +02:00
balloon.c Clean up inclusion of exec/cpu-common.h 2019-08-16 13:31:52 +02:00
block.c Include qemu/main-loop.h less 2019-08-16 13:31:52 +02:00
blockdev-nbd.c Clean up inclusion of sysemu/sysemu.h 2019-08-16 13:31:53 +02:00
blockdev.c Include qemu/main-loop.h less 2019-08-16 13:31:52 +02:00
blockjob.c Include qemu/main-loop.h less 2019-08-16 13:31:52 +02:00
bootdevice.c fw_cfg: ignore suffixes in the bootdevice list dependent on machine class 2018-08-16 22:27:43 -03:00
bt-host.c all: Clean up includes 2016-02-04 17:41:30 +00:00
bt-vhci.c Include qemu-common.h exactly where needed 2019-06-12 13:20:20 +02:00
Changelog Use HTTPS for qemu.org and other domains 2017-11-21 13:34:13 +00:00
CODING_STYLE CODING_STYLE: indent example code as all others 2019-05-02 18:12:58 +02:00
configure target-arm queue: 2019-07-22 15:16:48 +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 qemu/queue.h: simplify reverse access to QTAILQ 2019-01-11 15:46:55 +01:00
cpus.c Include hw/hw.h exactly where needed 2019-08-16 13:31:52 +02:00
device_tree.c device_tree: Fix integer overflowing in load_device_tree() 2019-04-09 16:35:40 -07:00
device-hotplug.c Include hw/hw.h exactly where needed 2019-08-16 13:31:52 +02:00
disas.c Include qemu-common.h exactly where needed 2019-06-12 13:20:20 +02:00
dma-helpers.c block: explicitly acquire aiocontext in bottom halves that need it 2017-02-21 11:39:39 +00:00
exec.c numa: Move remaining NUMA declarations from sysemu.h to numa.h 2019-08-16 13:31:53 +02:00
gdbstub.c gdbstub: revert to previous set_reg behaviour 2019-07-10 10:54:46 +01:00
gitdm.config contrib: gitdm: add a mapping for Janus Technologies 2019-03-12 19:31:29 +00:00
HACKING HACKING: document preference for g_new instead of g_malloc 2018-05-20 08:32:09 +03:00
hmp-commands-info.hx {hmp, hw/pvrdma}: Expose device internals via monitor interface 2019-03-16 15:52:44 +02:00
hmp-commands.hx net/announce: Add HMP optional ID 2019-07-02 10:21:07 +08: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 Include qemu-common.h exactly where needed 2019-06-12 13:20:20 +02:00
job.c Include qemu-common.h exactly where needed 2019-06-12 13:20:20 +02:00
Kconfig.host kconfig: add dependencies on CONFIG_MSI_NONBROKEN 2019-03-18 09:39:57 +01:00
LICENSE roms: Add OpenSBI version 0.4 2019-07-18 14:18:43 -07:00
MAINTAINERS qapi: Split error.json off common.json 2019-08-16 13:31:51 +02:00
Makefile Makefile: remove DESTDIR from firmware file content 2019-08-03 09:52:32 +02:00
Makefile.objs dump: Move HMP command handlers to dump/ 2019-07-02 13:37:00 +02:00
Makefile.target configure: only link capstone to emulation targets 2019-07-19 12:52:04 +01:00
memory_ldst.inc.c exec: Fix MAP_RAM for cached access 2018-06-28 19:05:30 +02:00
memory_mapping.c Include qemu-common.h exactly where needed 2019-06-12 13:20:20 +02:00
memory.c Include hw/qdev-properties.h less 2019-08-16 13:31:53 +02:00
module-common.c all: Clean up includes 2016-02-04 17:41:30 +00:00
os-posix.c Include qemu-common.h exactly where needed 2019-06-12 13:20:20 +02:00
os-win32.c Include qemu-common.h exactly where needed 2019-06-12 13:20:20 +02:00
qdev-monitor.c Clean up inclusion of sysemu/sysemu.h 2019-08-16 13:31:53 +02:00
qemu-bridge-helper.c qemu-bridge-helper: move repeating code in parse_acl_file 2019-07-29 16:29:30 +08:00
qemu-deprecated.texi hw/riscv: Load OpenSBI as the default firmware 2019-07-18 14:18:45 -07:00
qemu-doc.texi docs: add Security chapter to the documentation 2019-05-10 10:53:52 +01:00
qemu-edid.c Include qemu-common.h exactly where needed 2019-06-12 13:20:20 +02:00
qemu-ga.texi doc: fix the configuration path 2019-05-03 13:03:04 +02:00
qemu-img-cmds.hx qemu-img: Add salvaging mode to convert 2019-06-14 14:16:57 +02:00
qemu-img.c Clean up inclusion of sysemu/sysemu.h 2019-08-16 13:31:53 +02:00
qemu-img.texi qemu-img: Add salvaging mode to convert 2019-06-14 14:16:57 +02:00
qemu-io-cmds.c qemu-io-cmds: use clock_gettime for benchmarking 2019-06-12 17:53:22 +01:00
qemu-io.c Include qemu-common.h exactly where needed 2019-06-12 13:20:20 +02:00
qemu-keymap.c Include qemu-common.h exactly where needed 2019-06-12 13:20:20 +02:00
qemu-nbd.c qemu-nbd: Do not close stderr 2019-06-13 08:50:47 -05:00
qemu-nbd.texi qemu-nbd: Add --pid-file option 2019-06-13 08:50:47 -05:00
qemu-option-trace.texi qemu-option-trace: -trace enable= is a pattern, not a file 2018-05-20 08:29:01 +03: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 vl.c: Add -smp, dies=* command line support and update doc 2019-07-05 17:08:04 -03:00
qemu-seccomp.c seccomp: report more useful errors from seccomp 2019-03-27 13:11:38 +01:00
qemu-tech.texi qemu-tech: Fix dangling @menu entries 2019-07-15 21:10:29 +02:00
qemu.nsi NSIS: Add missing firmware blobs 2019-07-23 15:53:25 +01:00
qemu.sasl Default to GSSAPI (Kerberos) instead of DIGEST-MD5 for SASL 2017-05-09 14:41:47 +01:00
qtest.c Include hw/qdev-properties.h less 2019-08-16 13:31:53 +02:00
README README: use 'https://' instead of 'git://' 2018-11-12 11:26:02 +00: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 contrib: add vhost-user-gpu 2019-05-29 06:30:45 +02: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 Move monitor.c to monitor/misc.c 2019-06-17 20:36:56 +02:00
VERSION Open 4.2 development tree 2019-08-15 17:20:55 +01:00
version.rc Use HTTPS for qemu.org and other domains 2017-11-21 13:34:13 +00:00
vl.c Include hw/qdev-properties.h less 2019-08-16 13:31:53 +02: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:

  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.

   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 HACKING and CODING_STYLE files.

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.

  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:

  $ 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:

  $ 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

 - 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

-- End