QEMU main repository: Please see http://wiki.qemu.org/Contribute/SubmitAPatch for how to submit changes to QEMU. Pull Requests are ignored. Please only use release tarballs from the QEMU website. http://www.qemu.org
Go to file
John Snow 6832189fd7 python: drop pipenv
The pipenv tool was nice in theory, but in practice it's just too hard
to update selectively, and it makes using it a pain. The qemu.qmp repo
dropped pipenv support a while back and it's been functioning just fine,
so I'm backporting that change here to qemu.git.

Signed-off-by: John Snow <jsnow@redhat.com>
Message-id: 20230210003147.1309376-3-jsnow@redhat.com
Signed-off-by: John Snow <jsnow@redhat.com>
2023-02-22 23:35:03 -05:00
.github/workflows github: fix config mistake preventing repo lockdown commenting 2022-04-26 16:12:26 +01:00
.gitlab/issue_templates .gitlab/issue_templates: Move suggestions into comments 2022-12-15 15:19:24 +01:00
.gitlab-ci.d python: drop pipenv 2023-02-22 23:35:03 -05:00
accel Don't include headers already included by qemu/osdep.h 2023-02-08 07:28:05 +01:00
audio Fix non-first inclusions of qemu/osdep.h 2023-02-08 07:28:05 +01:00
authz configure, meson: convert pam detection to meson 2021-06-25 10:54:10 +02:00
backends Drop duplicate #include 2023-02-08 07:28:05 +01:00
block block/file-posix: don't use functions calling AIO_WAIT_WHILE in worker threads 2023-02-17 14:33:58 +01:00
bsd-user bsd-user/mmap: use TSA_NO_TSA to suppress clang TSA warnings in FreeBSD 2023-02-17 11:22:19 +01:00
chardev io: Add support for MSG_PEEK for socket channel 2023-02-06 19:22:56 +01:00
common-user common-user/host/ppc: Implement safe-syscall.inc.S 2023-01-23 14:39:48 -10:00
configs migration: Remove spurious files 2023-02-11 16:51:09 +01:00
contrib contrib/vhost-user-blk: Replace lseek64 with lseek 2022-12-21 07:32:24 -05:00
crypto crypto: TLS: introduce check_pending 2023-02-15 11:01:03 -05:00
disas target/riscv: update disas.c for xnor/orn/andn and slli.uw 2023-02-07 08:19:22 +10:00
docs Replace fork-based fuzzing with reboots. 2023-02-21 11:28:01 +00:00
dtc@b6910bec11 dtc: Update to version 1.6.1 2021-10-14 08:08:11 +02:00
dump Miscellaneous patches for 2022-12-14 2022-12-15 10:13:46 +00:00
ebpf ebpf: replace deprecated bpf_program__set_socket_filter 2022-07-06 11:39:09 +08:00
fpu softfloat: logB(0) should raise divideByZero exception 2022-10-17 10:28:35 +08:00
fsdev Don't include headers already included by qemu/osdep.h 2023-02-08 07:28:05 +01:00
gdb-xml gdb-xml: Fix size of EFER register on i386 architecture when debugged by GDB 2022-11-06 09:48:26 +01:00
gdbstub gdbstub: move guest debug support check to ops 2022-10-06 11:53:41 +01:00
hw -----BEGIN PGP SIGNATURE----- 2023-02-21 11:28:31 +00:00
include -----BEGIN PGP SIGNATURE----- 2023-02-21 11:28:31 +00:00
io io/channel-tls: fix handling of bigger read buffers 2023-02-15 11:01:04 -05:00
libdecnumber libdecnumber/dpd/decimal64: Fix compiler warning from Clang 15 2022-11-11 09:13:52 +01:00
linux-headers linux-headers: Update to v6.2-rc8 2023-02-16 12:13:46 -07:00
linux-user target/arm: Convert CPUARMState::eabi to boolean 2023-02-16 16:00:47 +00:00
meson@3a9b285a55 meson: require 0.61.3 2022-10-01 21:16:36 +02:00
migration migration: Rename res_{postcopy,precopy}_only 2023-02-15 20:04:30 +01:00
monitor monitor: Rename misc.c to hmp-target.c 2023-02-04 07:56:54 +01:00
nbd include/block: Untangle inclusion loops 2023-01-20 07:24:28 +01:00
net vdpa: fix VHOST_BACKEND_F_IOTLB_ASID flag check 2023-02-17 13:31:33 +08:00
pc-bios hw/misc/sga: Remove the deprecated "sga" device 2023-02-14 09:02:42 +01:00
plugins plugins: Iterate on cb_lists in qemu_plugin_user_exit 2023-02-02 11:48:20 +00:00
po po: add ukrainian translation 2022-07-05 10:15:49 +02:00
python python: drop pipenv 2023-02-22 23:35:03 -05:00
qapi net: stream: add a new option to automatically reconnect 2023-02-17 13:31:33 +08:00
qga qga: Clean up includes 2023-02-08 07:16:23 +01:00
qobject include/qapi: add g_autoptr support for qobject types 2022-04-06 10:50:38 +02:00
qom qom: Move HMP commands from monitor/ to qom/ 2023-02-04 07:56:54 +01:00
replay Miscellaneous patches for 2022-12-14 2022-12-15 10:13:46 +00:00
roms hw/misc/sga: Remove the deprecated "sga" device 2023-02-14 09:02:42 +01:00
scripts Remove C virtiofsd 2023-02-20 17:07:30 +00:00
scsi io: Add support for MSG_PEEK for socket channel 2023-02-06 19:22:56 +01:00
semihosting semihosting: add O_BINARY flag in host_open for NT compatibility 2023-02-02 11:48:20 +00:00
softmmu vl: catch [accel] entry without accelerator 2023-02-10 14:12:06 +01:00
stats stats: Move HMP commands from monitor/ to stats/ 2023-02-04 07:56:54 +01:00
storage-daemon monitor: Loosen coupling between misc.c and monitor.c slightly 2023-02-04 07:56:54 +01:00
stubs async: Register/unregister aiocontext in graph lock list 2022-12-15 16:07:43 +01:00
subprojects libvduse: Add extra compiler warnings 2023-01-11 10:44:35 +01:00
target target/arm: Move cpregs code out of cpu.h 2023-02-16 16:11:04 +00:00
tcg Don't include headers already included by qemu/osdep.h 2023-02-08 07:28:05 +01:00
tests python: drop pipenv 2023-02-22 23:35:03 -05:00
tools virtiofsd: Remove source 2023-02-16 18:15:08 +00:00
trace trace: Move HMP commands from monitor/ to trace/ 2023-02-04 07:56:54 +01:00
ui ui: remove deprecated 'password' option for SPICE 2023-02-15 11:14:58 -05:00
util hbitmap: fix hbitmap_status() return value for first dirty bit case 2023-02-17 14:34:24 +01:00
.cirrus.yml ci: Upgrade msys2 release to 20220603 2022-07-29 10:33:29 -07:00
.dir-locals.el
.editorconfig .editorconfig: update the automatic mode setting for Emacs 2021-03-10 15:34:11 +00:00
.exrc
.gdbinit .gdbinit: load QEMU sub-commands when gdb starts 2017-06-07 14:38:45 +01:00
.gitattributes gitattributes: Cover Objective-C source files 2022-03-29 00:15:14 +02:00
.gitignore .gitignore: add multiple items to .gitignore 2022-10-22 22:48:17 +02:00
.gitlab-ci.yml docs: Document GitLab custom CI/CD variables 2021-07-29 07:56:01 +02:00
.gitmodules hw/misc/sga: Remove the deprecated "sga" device 2023-02-14 09:02:42 +01:00
.gitpublish Add a git-publish configuration file 2018-03-05 09:03:17 +00:00
.mailmap mailmap: Fix Stefan Weil author email 2022-12-13 15:56:57 -05:00
.patchew.yml scripts/checkpatch: roll diff tweaking into checkpatch itself 2021-06-25 10:08:33 +01:00
.readthedocs.yml readthedocs: build with Python 3.6 2020-10-05 16:30:45 +01:00
.travis.yml travis.yml: Remove the generic addons section 2023-01-26 13:25:07 +01:00
block.c block: temporarily hold the new AioContext of bs_top in bdrv_append() 2023-02-17 14:33:58 +01:00
blockdev-nbd.c qapi block: Elide redundant has_FOO in generated C 2022-12-14 20:03:25 +01:00
blockdev.c block: Convert bdrv_is_inserted() to co_wrapper 2023-02-01 16:52:32 +01:00
blockjob.c include/block: Untangle inclusion loops 2023-01-20 07:24:28 +01:00
configure configure: Enable -Wthread-safety if present 2023-02-17 11:22:19 +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
cpu.c cpu: free cpu->tb_jmp_cache with RCU 2023-02-02 11:48:20 +00:00
cpus-common.c cpus: Introduce cpu_list_generation_id 2022-07-20 12:15:08 +01:00
disas.c target/loongarch: Enable the disassembler for host tcg 2023-01-23 15:36:36 -10:00
event-loop-base.c util/event-loop-base: Introduce options to set the thread pool size 2022-05-09 10:43:23 +01:00
gitdm.config contrib/gitdm: add a new interns group-map for GSoC/Outreachy work 2021-07-23 17:22:16 +01:00
hmp-commands-info.hx hmp: add virtio commands 2022-10-09 16:38:45 -04:00
hmp-commands.hx monitor: Move remaining HMP commands from misc.c to hmp-cmds.c 2023-02-04 07:56:54 +01:00
iothread.c error: Move ERRP_GUARD() to the beginning of the function 2022-12-14 16:19:35 +01:00
job-qmp.c qapi job: Elide redundant has_FOO in generated C 2022-12-14 20:04:47 +01:00
job.c block: remove bdrv_try_set_aio_context and replace it with bdrv_try_change_aio_context 2022-10-27 20:14:11 +02:00
Kconfig meson: Introduce target-specific Kconfig 2021-07-09 18:21:34 +02:00
Kconfig.host vfio-user: build library 2022-06-15 16:42:33 +01:00
LICENSE tcg/LICENSE: Remove out of date claim about TCG subdirectory licensing 2019-11-11 15:11:21 +01:00
MAINTAINERS VFIO updates 2023-02-16 2023-02-20 17:08:05 +00:00
Makefile Makefile: allow 'make uninstall' 2023-01-18 10:06:34 +01:00
memory_ldst.c.inc exec/memory_ldst: Use correct type sizes 2021-05-26 08:35:51 -07:00
meson_options.txt virtiofsd: Remove build and docs glue 2023-02-16 18:15:08 +00:00
meson.build Replace fork-based fuzzing with reboots. 2023-02-21 11:28:01 +00:00
module-common.c all: Clean up includes 2016-02-04 17:41:30 +00:00
os-posix.c Refactoring: refactor TFR() macro to RETRY_ON_EINTR() 2023-01-09 13:50:47 +01:00
os-win32.c Remove qemu-common.h include from most units 2022-04-06 14:31:55 +02:00
page-vary-common.c Remove qemu-common.h include from most units 2022-04-06 14:31:55 +02:00
page-vary.c include: move target page bits declaration to page-vary.h 2022-04-06 14:31:43 +02:00
qemu-bridge-helper.c qemu-bridge-helper: relocate path to default ACL 2020-09-30 19:11:36 +02:00
qemu-edid.c qemu-edid: Restrict input parameter -d to avoid division by zero 2022-10-12 13:38:15 +02:00
qemu-img-cmds.hx qemu-img: Unify [-b [-F]] documentation 2022-02-01 13:49:15 +01:00
qemu-img.c qemu-img: Change info key names for protocol nodes 2023-02-01 16:52:33 +01:00
qemu-io-cmds.c qemu-io: add -r option to register I/O buffer 2023-02-09 10:22:30 -05:00
qemu-io.c include: move qemu_*_exec_dir() to cutils 2022-05-28 11:42:56 +02:00
qemu-keymap.c qemu-keymap: Add license in generated files 2021-12-17 10:41:50 +01:00
qemu-nbd.c qapi block: Elide redundant has_FOO in generated C 2022-12-14 20:03:25 +01:00
qemu-options.hx net: stream: add a new option to automatically reconnect 2023-02-17 13:31:33 +08:00
qemu.nsi nsis installer: Fix mouse-over descriptions for emulators 2022-03-18 10:55:15 +00:00
qemu.sasl sasl: remove comment about obsolete kerberos versions 2021-06-14 13:28:50 +01:00
README.rst README.rst: fix link formatting 2022-08-04 13:44:21 +02:00
replication.c replication: move include out of root directory 2021-05-26 14:49:46 +02:00
trace-events accel/tcg: Remove trace events from trace-root.h 2022-12-20 17:11:12 -08:00
VERSION Open 8.0 development tree 2022-12-13 15:56:26 -05:00
version.rc configure: remove CONFIG_FILEVERSION and CONFIG_PRODUCTVERSION 2021-01-02 21:03:37 +01: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.


Documentation
=============

Documentation can be found hosted online at
`<https://www.qemu.org/documentation/>`_. The documentation for the
current development version that is available at
`<https://www.qemu.org/docs/master/>`_ is generated from the ``docs/``
folder in the source tree, and is built by `Sphinx
<https://www.sphinx-doc.org/en/master/>`_.


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:


.. code-block:: shell

  mkdir build
  cd build
  ../configure
  make

Additional information can also be found online via the QEMU website:

* `<https://wiki.qemu.org/Hosts/Linux>`_
* `<https://wiki.qemu.org/Hosts/Mac>`_
* `<https://wiki.qemu.org/Hosts/W32>`_


Submitting patches
==================

The QEMU source code is maintained under the GIT version control system.

.. code-block:: shell

   git clone https://gitlab.com/qemu-project/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 `style section
<https://www.qemu.org/docs/master/devel/style.html>`_ of
the Developers Guide.

Additional information on submitting patches can be found online via
the QEMU website

* `<https://wiki.qemu.org/Contribute/SubmitAPatch>`_
* `<https://wiki.qemu.org/Contribute/TrivialPatches>`_

The QEMU website is also maintained under source control.

.. code-block:: shell

  git clone https://gitlab.com/qemu-project/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:

.. code-block:: shell

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

.. code-block:: shell

  $ 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 GitLab issues to track bugs. Bugs
found when running code built from QEMU git or upstream released sources
should be reported via:

* `<https://gitlab.com/qemu-project/qemu/-/issues>`_

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 GitLab.

For additional information on bug reporting consult:

* `<https://wiki.qemu.org/Contribute/ReportABug>`_


ChangeLog
=========

For version history and release notes, please visit
`<https://wiki.qemu.org/ChangeLog/>`_ or look at the git history for
more detailed information.


Contact
=======

The QEMU community can be contacted in a number of ways, with the two
main methods being email and IRC

* `<mailto: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://wiki.qemu.org/Contribute/StartHere>`_