2016-07-20 20:31:29 +00:00
|
|
|
QEMU README
|
|
|
|
|
===========
|
2003-03-23 20:17:16 +00:00
|
|
|
|
2015-10-12 17:41:19 +00:00
|
|
|
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
|
2016-07-20 20:31:29 +00:00
|
|
|
========
|
2015-10-12 17:41:19 +00:00
|
|
|
|
|
|
|
|
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:
|
|
|
|
|
|
2016-07-20 20:31:29 +00:00
|
|
|
mkdir build
|
|
|
|
|
cd build
|
|
|
|
|
../configure
|
|
|
|
|
make
|
2015-10-12 17:41:19 +00:00
|
|
|
|
|
|
|
|
Additional information can also be found online via the QEMU website:
|
|
|
|
|
|
2017-11-21 12:04:35 +00:00
|
|
|
https://qemu.org/Hosts/Linux
|
|
|
|
|
https://qemu.org/Hosts/Mac
|
|
|
|
|
https://qemu.org/Hosts/W32
|
2015-10-12 17:41:19 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
Submitting patches
|
2016-07-20 20:31:29 +00:00
|
|
|
==================
|
2015-10-12 17:41:19 +00:00
|
|
|
|
|
|
|
|
The QEMU source code is maintained under the GIT version control system.
|
|
|
|
|
|
2017-11-21 12:04:34 +00:00
|
|
|
git clone git://git.qemu.org/qemu.git
|
2015-10-12 17:41:19 +00:00
|
|
|
|
|
|
|
|
When submitting patches, the preferred 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
|
|
|
|
|
|
2017-11-21 12:04:35 +00:00
|
|
|
https://qemu.org/Contribute/SubmitAPatch
|
|
|
|
|
https://qemu.org/Contribute/TrivialPatches
|
2015-10-12 17:41:19 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
Bug reporting
|
2016-07-20 20:31:29 +00:00
|
|
|
=============
|
2015-10-12 17:41:19 +00:00
|
|
|
|
|
|
|
|
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:
|
|
|
|
|
|
2016-07-20 20:31:29 +00:00
|
|
|
https://bugs.launchpad.net/qemu/
|
2015-10-12 17:41:19 +00:00
|
|
|
|
|
|
|
|
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:
|
|
|
|
|
|
2017-11-21 12:04:35 +00:00
|
|
|
https://qemu.org/Contribute/ReportABug
|
2015-10-12 17:41:19 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
Contact
|
2016-07-20 20:31:29 +00:00
|
|
|
=======
|
2015-10-12 17:41:19 +00:00
|
|
|
|
|
|
|
|
The QEMU community can be contacted in a number of ways, with the two
|
|
|
|
|
main methods being email and IRC
|
|
|
|
|
|
2016-07-20 20:31:29 +00:00
|
|
|
- qemu-devel@nongnu.org
|
2017-11-21 12:04:35 +00:00
|
|
|
https://lists.nongnu.org/mailman/listinfo/qemu-devel
|
2016-07-20 20:31:29 +00:00
|
|
|
- #qemu on irc.oftc.net
|
2015-10-12 17:41:19 +00:00
|
|
|
|
|
|
|
|
Information on additional methods of contacting the community can be
|
|
|
|
|
found online via the QEMU website:
|
|
|
|
|
|
2017-11-21 12:04:35 +00:00
|
|
|
https://qemu.org/Contribute/StartHere
|
2015-10-12 17:41:19 +00:00
|
|
|
|
2016-07-20 20:31:29 +00:00
|
|
|
-- End
|
