xref: /qemu/
Name Date Size #Lines LOC

..23-Feb-2020-

.github/H27-Apr-2020-

.gitlab-ci.d/H11-Jan-2021-

accel/H11-Jan-2021-

audio/H19-Jan-2021-

authz/H23-Nov-2020-

backends/H11-Jan-2021-

block/H19-Jan-2021-

bsd-user/H19-Jan-2021-

capstone/H15-Jan-2018-

chardev/H19-Jan-2021-

contrib/H12-Dec-2020-

crypto/H27-Oct-2020-

default-configs/H27-Oct-2020-

disas/H11-Jan-2021-

docs/H19-Jan-2021-

dtc/H15-Jan-2018-

dump/H27-Oct-2020-

fpu/H03-Sep-2020-

fsdev/H19-Jan-2021-

gdb-xml/H19-Jan-2021-

hw/H12-Dec-2020-

include/H12-Dec-2020-

io/H19-Jan-2021-

libdecnumber/H28-Sep-2020-

linux-headers/H12-May-2020-

linux-user/H19-Jan-2021-

meson/H24-Aug-2020-

migration/H19-Jan-2021-

monitor/H11-Jan-2021-

nbd/H23-Nov-2020-

net/H11-Jan-2021-

pc-bios/H23-Nov-2020-

plugins/H11-Jan-2021-

po/H11-Jan-2021-

python/H27-Oct-2020-

qapi/H19-Jan-2021-

qga/H11-Jan-2021-

qobject/H11-Jan-2021-

qom/H11-Jan-2021-

replay/H11-Jan-2021-

roms/H23-Nov-2020-

scripts/H19-Jan-2021-

scsi/H14-Nov-2020-

slirp/H05-May-2019-

softmmu/H19-Jan-2021-

storage-daemon/H19-Jan-2021-

stubs/H19-Jan-2021-

subprojects/libvhost-user/H12-Dec-2020-

target/H24-Aug-2020-

tcg/H19-Jan-2021-

tests/H19-Jan-2021-

tools/H11-Jan-2021-

trace/H11-Jan-2021-

ui/H19-Jan-2021-

util/H19-Jan-2021-

.cirrus.ymlH A D19-Jan-20216.2 KiB142136

.dir-locals.elH A D15-Jan-201875 32

.editorconfigH A D24-Aug-2020780 4535

.exrcH A D15-Jan-2018220 87

.gdbinitH A D15-Jan-2018326 97

.gitattributesH A D23-Nov-202046 32

.gitignoreH A D19-Jan-2021127 1312

.gitlab-ci.ymlH A D19-Jan-202117.4 KiB612560

.gitmodulesH A D28-Sep-20202.1 KiB6766

.gitpublishH A D18-Mar-20181.6 KiB5244

.mailmapH A D15-Dec-20208 KiB176170

.patchew.ymlH A D21-Jun-20198.4 KiB303283

.readthedocs.ymlH A D27-Oct-2020543 2116

.shippable.ymlH A D19-Jan-2021562 3635

.travis.ymlH A D19-Jan-202112.6 KiB465426

CODING_STYLE.rstH A D15-Dec-202022.6 KiB680487

COPYINGH A D15-Jan-201817.6 KiB340281

COPYING.LIBH A D20-Feb-201925.9 KiB

KconfigH A D17-Jul-202083 54

Kconfig.hostH A D27-Oct-2020493 4028

LICENSEH A D23-Nov-20191.1 KiB2820

MAINTAINERSH A D19-Jan-202172.7 KiB3,2682,925

MakefileH A D19-Jan-202111.3 KiB321233

README.rstH A D31-Oct-20205 KiB159107

VERSIONH A D12-Dec-20207 21

block.cH A D11-Jan-2021216 KiB7,2054,817

blockdev-nbd.cH A D14-Nov-20207.4 KiB274205

blockdev.cH A D15-Dec-2020116 KiB3,8212,999

blockjob.cH A D28-Sep-202015.2 KiB518378

configureH A D19-Jan-2021169 KiB6,6055,520

cpu.cH A D11-Jan-202111 KiB438335

cpus-common.cH A D23-Nov-202010.1 KiB355223

disas.cH A D11-Jan-202110.7 KiB399313

exec-vary.cH A D23-Nov-20203.5 KiB10941

gdbstub.cH A D19-Jan-202190.8 KiB3,5102,847

gitdm.configH A D24-Mar-20191.5 KiB5245

hmp-commands-info.hxH A D27-Oct-202019.2 KiB896764

hmp-commands.hxH A D11-Jan-202154.5 KiB1,8701,606

iothread.cH A D28-Sep-202010.6 KiB378265

job-qmp.cH A D24-Aug-20204.8 KiB193129

job.cH A D24-Aug-202024.6 KiB1,020775

memory_ldst.c.incH A D23-Nov-202015.7 KiB534490

meson.buildH A D19-Jan-202192.3 KiB2,5202,330

meson_options.txtH A D19-Jan-20216 KiB120113

module-common.cH A D15-Jan-2018113 118

os-posix.cH A D27-Oct-20208 KiB332249

os-win32.cH A D27-Oct-20202.2 KiB7433

qemu-bridge-helper.cH A D27-Oct-202011.9 KiB467345

qemu-edid.cH A D27-Oct-20203.6 KiB127112

qemu-img-cmds.hxH A D31-Oct-20205.5 KiB10184

qemu-img.cH A D11-Jan-2021162.3 KiB5,5474,680

qemu-io-cmds.cH A D11-Jan-202164.5 KiB2,5162,108

qemu-io.cH A D14-Nov-202018.4 KiB715616

qemu-keymap.cH A D21-Jun-20197.4 KiB257201

qemu-nbd.cH A D14-Nov-202035.9 KiB1,145993

qemu-options-wrapper.hH A D24-May-20181 KiB4128

qemu-options.hH A D15-Jan-20181.4 KiB377

qemu-options.hxH A D19-Jan-2021214.5 KiB5,1474,188

qemu.nsiH A D21-Mar-20207.9 KiB282234

qemu.saslH A D15-Jan-20181.8 KiB4540

replication.cH A D15-Jan-20182.5 KiB10877

replication.hH A D21-Jun-20195.2 KiB17625

thunk.cH A D23-Nov-202013.3 KiB481412

trace-eventsH A D28-Sep-20205.9 KiB158136

version.rcH A D11-Jan-2021867 3128

README.rst

1===========
2QEMU README
3===========
4
5QEMU 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
35========
36
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
41
42.. code-block:: shell
43
44  mkdir build
45  cd build
46  ../configure
47  make
48
49Additional information can also be found online via the QEMU website:
50
51* `<https://qemu.org/Hosts/Linux>`_
52* `<https://qemu.org/Hosts/Mac>`_
53* `<https://qemu.org/Hosts/W32>`_
54
55
56Submitting patches
57==================
58
59The QEMU source code is maintained under the GIT version control system.
60
61.. code-block:: shell
62
63   git clone https://git.qemu.org/git/qemu.git
64
65When submitting patches, one common approach is to use 'git
66format-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
69guidelines set out in the CODING_STYLE.rst file.
70
71Additional information on submitting patches can be found online via
72the QEMU website
73
74* `<https://qemu.org/Contribute/SubmitAPatch>`_
75* `<https://qemu.org/Contribute/TrivialPatches>`_
76
77The QEMU website is also maintained under source control.
78
79.. code-block:: shell
80
81  git clone https://git.qemu.org/git/qemu-web.git
82
83* `<https://www.qemu.org/2017/02/04/the-new-qemu-website-is-up/>`_
84
85A 'git-publish' utility was created to make above process less
86cumbersome, 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
94*  `<https://github.com/stefanha/git-publish>`_
95
96The workflow with 'git-publish' is:
97
98.. code-block:: shell
99
100  $ 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
109.. code-block:: shell
110
111  $ 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
118Bug reporting
119=============
120
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
125* `<https://bugs.launchpad.net/qemu/>`_
126
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
134* `<https://qemu.org/Contribute/ReportABug>`_
135
136
137ChangeLog
138=========
139
140For version history and release notes, please visit
141`<https://wiki.qemu.org/ChangeLog/>`_ or look at the git history for
142more detailed information.
143
144
145Contact
146=======
147
148The QEMU community can be contacted in a number of ways, with the two
149main methods being email and IRC
150
151* `<mailto:qemu-devel@nongnu.org>`_
152* `<https://lists.nongnu.org/mailman/listinfo/qemu-devel>`_
153* #qemu on irc.oftc.net
154
155Information on additional methods of contacting the community can be
156found online via the QEMU website:
157
158* `<https://qemu.org/Contribute/StartHere>`_
159