blob: 7497709291dc921877d768c779fe0f75f167777b [file] [log] [blame]
Daniel P. Berrangé336a7452019-08-23 17:09:24 +01001===========
2QEMU README
3===========
bellard3ef693a2003-03-23 20:17:16 +00004
Daniel P. Berrange0a3c1902015-10-12 18:41:19 +01005QEMU is a generic and open source machine & userspace emulator and
6virtualizer.
7
8QEMU is capable of emulating a complete machine in software without any
9need for hardware virtualization support. By using dynamic translation,
10it achieves very good performance. QEMU can also integrate with the Xen
11and KVM hypervisors to provide emulated hardware while allowing the
12hypervisor to manage the CPU. With hypervisor support, QEMU can achieve
13near native performance for CPUs. When QEMU emulates CPUs directly it is
14capable of running operating systems made for one machine (e.g. an ARMv7
15board) on a different machine (e.g. an x86_64 PC board).
16
17QEMU is also capable of providing userspace API virtualization for Linux
18and BSD kernel interfaces. This allows binaries compiled against one
19architecture ABI (e.g. the Linux PPC64 ABI) to be run on a host using a
20different architecture ABI (e.g. the Linux x86_64 ABI). This does not
21involve any hardware emulation, simply CPU and syscall emulation.
22
23QEMU aims to fit into a variety of use cases. It can be invoked directly
24by users wishing to have full control over its behaviour and settings.
25It also aims to facilitate integration into higher level management
26layers, by providing a stable command line interface and monitor API.
27It is commonly invoked indirectly via the libvirt library when using
28open source applications such as oVirt, OpenStack and virt-manager.
29
30QEMU as a whole is released under the GNU General Public License,
31version 2. For full licensing details, consult the LICENSE file.
32
33
34Building
Pranith Kumarb95aae12016-07-20 16:31:29 -040035========
Daniel P. Berrange0a3c1902015-10-12 18:41:19 +010036
37QEMU is multi-platform software intended to be buildable on all modern
38Linux platforms, OS-X, Win32 (via the Mingw64 toolchain) and a variety
39of other UNIX targets. The simple steps to build QEMU are:
40
Daniel P. Berrangé336a7452019-08-23 17:09:24 +010041
42.. code-block:: shell
43
Pranith Kumarb95aae12016-07-20 16:31:29 -040044 mkdir build
45 cd build
46 ../configure
47 make
Daniel P. Berrange0a3c1902015-10-12 18:41:19 +010048
Daniel P. Berrange0a3c1902015-10-12 18:41:19 +010049Additional information can also be found online via the QEMU website:
50
Daniel P. Berrangé336a7452019-08-23 17:09:24 +010051* `<https://qemu.org/Hosts/Linux>`_
52* `<https://qemu.org/Hosts/Mac>`_
53* `<https://qemu.org/Hosts/W32>`_
Daniel P. Berrange0a3c1902015-10-12 18:41:19 +010054
55
56Submitting patches
Pranith Kumarb95aae12016-07-20 16:31:29 -040057==================
Daniel P. Berrange0a3c1902015-10-12 18:41:19 +010058
59The QEMU source code is maintained under the GIT version control system.
60
Daniel P. Berrangé336a7452019-08-23 17:09:24 +010061.. code-block:: shell
62
Stefan Hajnoczic814b172018-11-08 11:15:24 +000063 git clone https://git.qemu.org/git/qemu.git
Daniel P. Berrange0a3c1902015-10-12 18:41:19 +010064
Fam Zheng23500c62018-02-26 11:03:26 +080065When submitting patches, one common approach is to use 'git
Daniel P. Berrange0a3c1902015-10-12 18:41:19 +010066format-patch' and/or 'git send-email' to format & send the mail to the
67qemu-devel@nongnu.org mailing list. All patches submitted must contain
68a 'Signed-off-by' line from the author. Patches should follow the
Daniel P. Berrangé637f3952019-08-23 17:12:05 +010069guidelines set out in the CODING_STYLE.rst file.
Daniel P. Berrange0a3c1902015-10-12 18:41:19 +010070
71Additional information on submitting patches can be found online via
72the QEMU website
73
Daniel P. Berrangé336a7452019-08-23 17:09:24 +010074* `<https://qemu.org/Contribute/SubmitAPatch>`_
75* `<https://qemu.org/Contribute/TrivialPatches>`_
Daniel P. Berrange0a3c1902015-10-12 18:41:19 +010076
Eric Blakea348f642017-11-29 09:25:10 -060077The QEMU website is also maintained under source control.
78
Daniel P. Berrangé336a7452019-08-23 17:09:24 +010079.. code-block:: shell
80
Stefan Hajnoczic814b172018-11-08 11:15:24 +000081 git clone https://git.qemu.org/git/qemu-web.git
Daniel P. Berrangé336a7452019-08-23 17:09:24 +010082
83* `<https://www.qemu.org/2017/02/04/the-new-qemu-website-is-up/>`_
Daniel P. Berrange0a3c1902015-10-12 18:41:19 +010084
Fam Zheng7c9e2742018-03-06 10:43:28 +080085A 'git-publish' utility was created to make above process less
Fam Zheng23500c62018-02-26 11:03:26 +080086cumbersome, and is highly recommended for making regular contributions,
87or even just for sending consecutive patch series revisions. It also
88requires a working 'git send-email' setup, and by default doesn't
89automate everything, so you may want to go through the above steps
90manually for once.
91
92For installation instructions, please go to
93
Daniel P. Berrangé336a7452019-08-23 17:09:24 +010094* `<https://github.com/stefanha/git-publish>`_
Fam Zheng23500c62018-02-26 11:03:26 +080095
96The workflow with 'git-publish' is:
97
Daniel P. Berrangé336a7452019-08-23 17:09:24 +010098.. code-block:: shell
99
Fam Zheng23500c62018-02-26 11:03:26 +0800100 $ git checkout master -b my-feature
101 $ # work on new commits, add your 'Signed-off-by' lines to each
102 $ git publish
103
104Your patch series will be sent and tagged as my-feature-v1 if you need to refer
105back to it in the future.
106
107Sending v2:
108
Daniel P. Berrangé336a7452019-08-23 17:09:24 +0100109.. code-block:: shell
110
Fam Zheng23500c62018-02-26 11:03:26 +0800111 $ git checkout my-feature # same topic branch
112 $ # making changes to the commits (using 'git rebase', for example)
113 $ git publish
114
115Your patch series will be sent with 'v2' tag in the subject and the git tip
116will be tagged as my-feature-v2.
117
Daniel P. Berrange0a3c1902015-10-12 18:41:19 +0100118Bug reporting
Pranith Kumarb95aae12016-07-20 16:31:29 -0400119=============
Daniel P. Berrange0a3c1902015-10-12 18:41:19 +0100120
121The QEMU project uses Launchpad as its primary upstream bug tracker. Bugs
122found when running code built from QEMU git or upstream released sources
123should be reported via:
124
Daniel P. Berrangé336a7452019-08-23 17:09:24 +0100125* `<https://bugs.launchpad.net/qemu/>`_
Daniel P. Berrange0a3c1902015-10-12 18:41:19 +0100126
127If using QEMU via an operating system vendor pre-built binary package, it
128is preferable to report bugs to the vendor's own bug tracker first. If
129the bug is also known to affect latest upstream code, it can also be
130reported via launchpad.
131
132For additional information on bug reporting consult:
133
Daniel P. Berrangé336a7452019-08-23 17:09:24 +0100134* `<https://qemu.org/Contribute/ReportABug>`_
Daniel P. Berrange0a3c1902015-10-12 18:41:19 +0100135
136
137Contact
Pranith Kumarb95aae12016-07-20 16:31:29 -0400138=======
Daniel P. Berrange0a3c1902015-10-12 18:41:19 +0100139
140The QEMU community can be contacted in a number of ways, with the two
141main methods being email and IRC
142
Daniel P. Berrangé336a7452019-08-23 17:09:24 +0100143* `<mailto:qemu-devel@nongnu.org>`_
144* `<https://lists.nongnu.org/mailman/listinfo/qemu-devel>`_
145* #qemu on irc.oftc.net
Daniel P. Berrange0a3c1902015-10-12 18:41:19 +0100146
147Information on additional methods of contacting the community can be
148found online via the QEMU website:
149
Daniel P. Berrangé336a7452019-08-23 17:09:24 +0100150* `<https://qemu.org/Contribute/StartHere>`_