b67de91e0d
Commitcf60ccc330("cutils: Introduce bundle mechanism") introduced a Python script to populate a bundle directory using os.symlink() to point to the binaries in the pc-bios directory of the source tree. Commit882084a04a("datadir: Use bundle mechanism") removed previous logic in pc-bios/meson.build to create a link/copy of pc-bios binaries in the build tree so os.symlink() is the way to go. However os.symlink() may fail [1] on Windows if an unprivileged Windows user started the QEMU build process, which results in QEMU executables generated in the build tree not able to load the default BIOS/firmware images due to symbolic links not present in the bundle directory. This commits updates the documentation by adding such caveats for users who want to build QEMU on the Windows platform. [1] https://docs.python.org/3/library/os.html#os.symlink Signed-off-by: Bin Meng <bin.meng@windriver.com> Reviewed-by: Stefan Weil <sw@weilnetz.de> Reviewed-by: Akihiko Odaki <akihiko.odaki@gmail.com> Message-Id: <20220719135014.764981-1-bmeng.cn@gmail.com> Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
110 lines
4.6 KiB
ReStructuredText
110 lines
4.6 KiB
ReStructuredText
.. _Supported-build-platforms:
|
|
|
|
Supported build platforms
|
|
=========================
|
|
|
|
QEMU aims to support building and executing on multiple host OS
|
|
platforms. This appendix outlines which platforms are the major build
|
|
targets. These platforms are used as the basis for deciding upon the
|
|
minimum required versions of 3rd party software QEMU depends on. The
|
|
supported platforms are the targets for automated testing performed by
|
|
the project when patches are submitted for review, and tested before and
|
|
after merge.
|
|
|
|
If a platform is not listed here, it does not imply that QEMU won't
|
|
work. If an unlisted platform has comparable software versions to a
|
|
listed platform, there is every expectation that it will work. Bug
|
|
reports are welcome for problems encountered on unlisted platforms
|
|
unless they are clearly older vintage than what is described here.
|
|
|
|
Note that when considering software versions shipped in distros as
|
|
support targets, QEMU considers only the version number, and assumes the
|
|
features in that distro match the upstream release with the same
|
|
version. In other words, if a distro backports extra features to the
|
|
software in their distro, QEMU upstream code will not add explicit
|
|
support for those backports, unless the feature is auto-detectable in a
|
|
manner that works for the upstream releases too.
|
|
|
|
The `Repology`_ site is a useful resource to identify
|
|
currently shipped versions of software in various operating systems,
|
|
though it does not cover all distros listed below.
|
|
|
|
Supported host architectures
|
|
----------------------------
|
|
|
|
Those hosts are officially supported, with various accelerators:
|
|
|
|
.. list-table::
|
|
:header-rows: 1
|
|
|
|
* - CPU Architecture
|
|
- Accelerators
|
|
* - Arm
|
|
- kvm (64 bit only), tcg, xen
|
|
* - MIPS
|
|
- kvm, tcg
|
|
* - PPC
|
|
- kvm, tcg
|
|
* - RISC-V
|
|
- tcg
|
|
* - s390x
|
|
- kvm, tcg
|
|
* - SPARC
|
|
- tcg
|
|
* - x86
|
|
- hax, hvf (64 bit only), kvm, nvmm, tcg, whpx (64 bit only), xen
|
|
|
|
Other host architectures are not supported. It is possible to build QEMU system
|
|
emulation on an unsupported host architecture using the configure
|
|
``--enable-tcg-interpreter`` option to enable the TCI support, but note that
|
|
this is very slow and is not recommended for normal use. QEMU user emulation
|
|
requires host-specific support for signal handling, therefore TCI won't help
|
|
on unsupported host architectures.
|
|
|
|
Non-supported architectures may be removed in the future following the
|
|
:ref:`deprecation process<Deprecated features>`.
|
|
|
|
Linux OS, macOS, FreeBSD, NetBSD, OpenBSD
|
|
-----------------------------------------
|
|
|
|
The project aims to support the most recent major version at all times. Support
|
|
for the previous major version will be dropped 2 years after the new major
|
|
version is released or when the vendor itself drops support, whichever comes
|
|
first. In this context, third-party efforts to extend the lifetime of a distro
|
|
are not considered, even when they are endorsed by the vendor (eg. Debian LTS).
|
|
|
|
For the purposes of identifying supported software versions available on Linux,
|
|
the project will look at CentOS, Debian, Fedora, openSUSE, RHEL, SLES and
|
|
Ubuntu LTS. Other distros will be assumed to ship similar software versions.
|
|
|
|
For FreeBSD and OpenBSD, decisions will be made based on the contents of the
|
|
respective ports repository, while NetBSD will use the pkgsrc repository.
|
|
|
|
For macOS, `Homebrew`_ will be used, although `MacPorts`_ is expected to carry
|
|
similar versions.
|
|
|
|
Windows
|
|
-------
|
|
|
|
The project aims to support the two most recent versions of Windows that are
|
|
still supported by the vendor. The minimum Windows API that is currently
|
|
targeted is "Windows 8", so theoretically the QEMU binaries can still be run
|
|
on older versions of Windows, too. However, such old versions of Windows are
|
|
not tested anymore, so it is recommended to use one of the latest versions of
|
|
Windows instead.
|
|
|
|
The project supports building QEMU with current versions of the MinGW
|
|
toolchain, either hosted on Linux (Debian/Fedora) or via `MSYS2`_ on Windows.
|
|
A more recent Windows version is always preferred as it is less likely to have
|
|
problems with building via MSYS2. The building process of QEMU involves some
|
|
Python scripts that call os.symlink() which needs special attention for the
|
|
build process to successfully complete. On newer versions of Windows 10,
|
|
unprivileged accounts can create symlinks if Developer Mode is enabled.
|
|
When Developer Mode is not available/enabled, the SeCreateSymbolicLinkPrivilege
|
|
privilege is required, or the process must be run as an administrator.
|
|
|
|
.. _Homebrew: https://brew.sh/
|
|
.. _MacPorts: https://www.macports.org/
|
|
.. _MSYS2: https://www.msys2.org/
|
|
.. _Repology: https://repology.org/
|