blob: cb60d05bee2f208a133e597c3127e71c09cd5852 [file] [log] [blame]
Pranith Kumarb95aae12016-07-20 16:31:29 -04001 QEMU README
2 ===========
bellard3ef693a2003-03-23 20:17:16 +00003
Daniel P. Berrange0a3c1902015-10-12 18:41:19 +01004QEMU is a generic and open source machine & userspace emulator and
5virtualizer.
6
7QEMU is capable of emulating a complete machine in software without any
8need for hardware virtualization support. By using dynamic translation,
9it achieves very good performance. QEMU can also integrate with the Xen
10and KVM hypervisors to provide emulated hardware while allowing the
11hypervisor to manage the CPU. With hypervisor support, QEMU can achieve
12near native performance for CPUs. When QEMU emulates CPUs directly it is
13capable of running operating systems made for one machine (e.g. an ARMv7
14board) on a different machine (e.g. an x86_64 PC board).
15
16QEMU is also capable of providing userspace API virtualization for Linux
17and BSD kernel interfaces. This allows binaries compiled against one
18architecture ABI (e.g. the Linux PPC64 ABI) to be run on a host using a
19different architecture ABI (e.g. the Linux x86_64 ABI). This does not
20involve any hardware emulation, simply CPU and syscall emulation.
21
22QEMU aims to fit into a variety of use cases. It can be invoked directly
23by users wishing to have full control over its behaviour and settings.
24It also aims to facilitate integration into higher level management
25layers, by providing a stable command line interface and monitor API.
26It is commonly invoked indirectly via the libvirt library when using
27open source applications such as oVirt, OpenStack and virt-manager.
28
29QEMU as a whole is released under the GNU General Public License,
30version 2. For full licensing details, consult the LICENSE file.
31
32
33Building
Pranith Kumarb95aae12016-07-20 16:31:29 -040034========
Daniel P. Berrange0a3c1902015-10-12 18:41:19 +010035
36QEMU is multi-platform software intended to be buildable on all modern
37Linux platforms, OS-X, Win32 (via the Mingw64 toolchain) and a variety
38of other UNIX targets. The simple steps to build QEMU are:
39
Pranith Kumarb95aae12016-07-20 16:31:29 -040040 mkdir build
41 cd build
42 ../configure
43 make
Daniel P. Berrange0a3c1902015-10-12 18:41:19 +010044
Daniel P. Berrange0a3c1902015-10-12 18:41:19 +010045Additional information can also be found online via the QEMU website:
46
Pranith Kumarb95aae12016-07-20 16:31:29 -040047 http://qemu-project.org/Hosts/Linux
Peter Maydellebee9df2016-10-31 17:01:30 +000048 http://qemu-project.org/Hosts/Mac
Pranith Kumarb95aae12016-07-20 16:31:29 -040049 http://qemu-project.org/Hosts/W32
Daniel P. Berrange0a3c1902015-10-12 18:41:19 +010050
51
52Submitting patches
Pranith Kumarb95aae12016-07-20 16:31:29 -040053==================
Daniel P. Berrange0a3c1902015-10-12 18:41:19 +010054
55The QEMU source code is maintained under the GIT version control system.
56
Pranith Kumarb95aae12016-07-20 16:31:29 -040057 git clone git://git.qemu-project.org/qemu.git
Daniel P. Berrange0a3c1902015-10-12 18:41:19 +010058
59When submitting patches, the preferred approach is to use 'git
60format-patch' and/or 'git send-email' to format & send the mail to the
61qemu-devel@nongnu.org mailing list. All patches submitted must contain
62a 'Signed-off-by' line from the author. Patches should follow the
63guidelines set out in the HACKING and CODING_STYLE files.
64
65Additional information on submitting patches can be found online via
66the QEMU website
67
Pranith Kumarb95aae12016-07-20 16:31:29 -040068 http://qemu-project.org/Contribute/SubmitAPatch
69 http://qemu-project.org/Contribute/TrivialPatches
Daniel P. Berrange0a3c1902015-10-12 18:41:19 +010070
71
72Bug reporting
Pranith Kumarb95aae12016-07-20 16:31:29 -040073=============
Daniel P. Berrange0a3c1902015-10-12 18:41:19 +010074
75The QEMU project uses Launchpad as its primary upstream bug tracker. Bugs
76found when running code built from QEMU git or upstream released sources
77should be reported via:
78
Pranith Kumarb95aae12016-07-20 16:31:29 -040079 https://bugs.launchpad.net/qemu/
Daniel P. Berrange0a3c1902015-10-12 18:41:19 +010080
81If using QEMU via an operating system vendor pre-built binary package, it
82is preferable to report bugs to the vendor's own bug tracker first. If
83the bug is also known to affect latest upstream code, it can also be
84reported via launchpad.
85
86For additional information on bug reporting consult:
87
Pranith Kumarb95aae12016-07-20 16:31:29 -040088 http://qemu-project.org/Contribute/ReportABug
Daniel P. Berrange0a3c1902015-10-12 18:41:19 +010089
90
91Contact
Pranith Kumarb95aae12016-07-20 16:31:29 -040092=======
Daniel P. Berrange0a3c1902015-10-12 18:41:19 +010093
94The QEMU community can be contacted in a number of ways, with the two
95main methods being email and IRC
96
Pranith Kumarb95aae12016-07-20 16:31:29 -040097 - qemu-devel@nongnu.org
98 http://lists.nongnu.org/mailman/listinfo/qemu-devel
99 - #qemu on irc.oftc.net
Daniel P. Berrange0a3c1902015-10-12 18:41:19 +0100100
101Information on additional methods of contacting the community can be
102found online via the QEMU website:
103
104 http://qemu-project.org/Contribute/StartHere
105
Pranith Kumarb95aae12016-07-20 16:31:29 -0400106-- End