xref: /openbmc/qemu/docs/about/build-platforms.rst (revision 44602af8)
1.. _Supported-build-platforms:
2
3Supported build platforms
4=========================
5
6QEMU aims to support building and executing on multiple host OS
7platforms. This appendix outlines which platforms are the major build
8targets. These platforms are used as the basis for deciding upon the
9minimum required versions of 3rd party software QEMU depends on. The
10supported platforms are the targets for automated testing performed by
11the project when patches are submitted for review, and tested before and
12after merge.
13
14If a platform is not listed here, it does not imply that QEMU won't
15work. If an unlisted platform has comparable software versions to a
16listed platform, there is every expectation that it will work. Bug
17reports are welcome for problems encountered on unlisted platforms
18unless they are clearly older vintage than what is described here.
19
20Note that when considering software versions shipped in distros as
21support targets, QEMU considers only the version number, and assumes the
22features in that distro match the upstream release with the same
23version. In other words, if a distro backports extra features to the
24software in their distro, QEMU upstream code will not add explicit
25support for those backports, unless the feature is auto-detectable in a
26manner that works for the upstream releases too.
27
28The `Repology`_ site is a useful resource to identify
29currently shipped versions of software in various operating systems,
30though it does not cover all distros listed below.
31
32Supported host architectures
33----------------------------
34
35Those hosts are officially supported, with various accelerators:
36
37  .. list-table::
38   :header-rows: 1
39
40   * - CPU Architecture
41     - Accelerators
42   * - Arm
43     - kvm (64 bit only), tcg, xen
44   * - MIPS
45     - kvm, tcg
46   * - PPC
47     - kvm, tcg
48   * - RISC-V
49     - tcg
50   * - s390x
51     - kvm, tcg
52   * - SPARC
53     - tcg
54   * - x86
55     - hax, hvf (64 bit only), kvm, nvmm, tcg, whpx (64 bit only), xen
56
57Other host architectures are not supported. It is possible to build QEMU system
58emulation on an unsupported host architecture using the configure
59``--enable-tcg-interpreter`` option to enable the TCI support, but note that
60this is very slow and is not recommended for normal use. QEMU user emulation
61requires host-specific support for signal handling, therefore TCI won't help
62on unsupported host architectures.
63
64Non-supported architectures may be removed in the future following the
65:ref:`deprecation process<Deprecated features>`.
66
67Linux OS, macOS, FreeBSD, NetBSD, OpenBSD
68-----------------------------------------
69
70The project aims to support the most recent major version at all times. Support
71for the previous major version will be dropped 2 years after the new major
72version is released or when the vendor itself drops support, whichever comes
73first. In this context, third-party efforts to extend the lifetime of a distro
74are not considered, even when they are endorsed by the vendor (eg. Debian LTS).
75
76For the purposes of identifying supported software versions available on Linux,
77the project will look at CentOS, Debian, Fedora, openSUSE, RHEL, SLES and
78Ubuntu LTS. Other distros will be assumed to ship similar software versions.
79
80For FreeBSD and OpenBSD, decisions will be made based on the contents of the
81respective ports repository, while NetBSD will use the pkgsrc repository.
82
83For macOS, `Homebrew`_ will be used, although `MacPorts`_ is expected to carry
84similar versions.
85
86Windows
87-------
88
89The project aims to support the two most recent versions of Windows that are
90still supported by the vendor. The minimum Windows API that is currently
91targeted is "Windows 8", so theoretically the QEMU binaries can still be run
92on older versions of Windows, too. However, such old versions of Windows are
93not tested anymore, so it is recommended to use one of the latest versions of
94Windows instead.
95
96The project supports building QEMU with current versions of the MinGW
97toolchain, either hosted on Linux (Debian/Fedora) or via `MSYS2`_ on Windows.
98A more recent Windows version is always preferred as it is less likely to have
99problems with building via MSYS2. The building process of QEMU involves some
100Python scripts that call os.symlink() which needs special attention for the
101build process to successfully complete. On newer versions of Windows 10,
102unprivileged accounts can create symlinks if Developer Mode is enabled.
103When Developer Mode is not available/enabled, the SeCreateSymbolicLinkPrivilege
104privilege is required, or the process must be run as an administrator.
105
106.. _Homebrew: https://brew.sh/
107.. _MacPorts: https://www.macports.org/
108.. _MSYS2: https://www.msys2.org/
109.. _Repology: https://repology.org/
110