From patchwork Mon Nov 18 17:23:54 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Pierrick Bouvier X-Patchwork-Id: 844106 Delivered-To: patch@linaro.org Received: by 2002:a05:6000:8b:b0:382:43a8:7b94 with SMTP id m11csp742166wrx; Mon, 18 Nov 2024 09:26:28 -0800 (PST) X-Forwarded-Encrypted: i=2; AJvYcCV1CjnMgNkHiQO7c5sklNCPBrVla2Lex6THob+/AE9UA5lHm2Bb8pJn+g5Bx2vuP1gqHeB/PQ==@linaro.org X-Google-Smtp-Source: AGHT+IGfqrVYX99Hs8HXD4hoYZUR6/r6TYsl564mMpc0sq5HBhYTM+Dbv100wlcf+4x9UpmyVpG3 X-Received: by 2002:a05:6214:300c:b0:6d4:12a8:8259 with SMTP id 6a1803df08f44-6d412a88b17mr97654676d6.48.1731950788167; Mon, 18 Nov 2024 09:26:28 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1731950788; cv=none; d=google.com; s=arc-20240605; b=UhrEp4QN++MbCems5WO1kg5mzV2phw+E4+RG4rsqkWt3mF9tS0ECUa0/9vumJgGDRp PAQkp2OLlPJgwSswNXJPlhXOVWIoMA3z+NOiI2GZPyOEv45voRjm2f2Ua2c0rzREB3b3 oCq3HX1aYCWAD/7Rzb0a0KC5jPaX906QdJUR0U3vOuB2xDDDFokGA4gU3OmNZAP+JgPj fiRir1/tuTE+WFprtO2J5v1hSOYMHK/P+kINrOVjXpVu7B9shHXGh1mAipjH4BByqJvU RNjFA80RUvY7AkCHRC0bxMwEphGkNx6BDNpE6tEiXGF3vCb7pABVuZz+W5t9fZ8eqT2o M/Ow== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20240605; h=sender:errors-to:list-subscribe:list-help:list-post:list-archive :list-unsubscribe:list-id:precedence:content-transfer-encoding :mime-version:references:in-reply-to:message-id:date:subject:cc:to :from:dkim-signature; bh=zrtTSIAZyM7Cil0D9jbVirGKiaDBwbsx28N7FRyo/s0=; fh=KiB2YZUctkIMKkMHF2PUf1Rh4nm6gUKgoo05gSvIuQI=; b=VQR62HWqeAoYt8hCHUqh8jYEPAvwdKK2dQjPR18jDKTSPcNSJ1QXC/bXV4qJw+PXDc RanqrLyV6zKRFB+ixip8v9d5u4tSOsLNnoUKMEeJEXcvjixshUHMnqq9+oXvXU1DAFkp k230QUGzACkPw0q4e+3muCHu3Hy6u2OO8Y+J+SwDBdX7av30DZ+WyLM2DxMluje+zjzx IEhD3Uadu3FgBo712dnU8p6T8TIupye8MXRSUhPrpLYUrriJq37c2iDQGroo+g862nE2 0MR3iV1zoPTAe3MkSGny4Fy5joOAWG6ehB+LCNapXqFWOMJlqGyLeOmcgKRSxHruyUD4 m0Jw==; dara=google.com ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b=emqFSxsR; spf=pass (google.com: domain of qemu-devel-bounces+patch=linaro.org@nongnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom="qemu-devel-bounces+patch=linaro.org@nongnu.org"; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=linaro.org; dara=neutral header.i=@linaro.org Return-Path: Received: from lists.gnu.org (lists.gnu.org. [209.51.188.17]) by mx.google.com with ESMTPS id 6a1803df08f44-6d40dc41b66si68106606d6.270.2024.11.18.09.26.27 for (version=TLS1_2 cipher=ECDHE-ECDSA-CHACHA20-POLY1305 bits=256/256); Mon, 18 Nov 2024 09:26:28 -0800 (PST) Received-SPF: pass (google.com: domain of qemu-devel-bounces+patch=linaro.org@nongnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; Authentication-Results: mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b=emqFSxsR; spf=pass (google.com: domain of qemu-devel-bounces+patch=linaro.org@nongnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom="qemu-devel-bounces+patch=linaro.org@nongnu.org"; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=linaro.org; dara=neutral header.i=@linaro.org Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1tD5UI-0008SF-M8; Mon, 18 Nov 2024 12:24:36 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1tD5U7-0008NI-GB for qemu-devel@nongnu.org; Mon, 18 Nov 2024 12:24:26 -0500 Received: from mail-pl1-x62e.google.com ([2607:f8b0:4864:20::62e]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1tD5U4-0002pE-As for qemu-devel@nongnu.org; Mon, 18 Nov 2024 12:24:23 -0500 Received: by mail-pl1-x62e.google.com with SMTP id d9443c01a7336-20cb47387ceso45685045ad.1 for ; Mon, 18 Nov 2024 09:24:19 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; t=1731950658; x=1732555458; darn=nongnu.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=zrtTSIAZyM7Cil0D9jbVirGKiaDBwbsx28N7FRyo/s0=; b=emqFSxsRVAIha6htF8B6UkweCjfATd5Z8P0Vo4URNt0ZcoDZR/40b867BWMVnjArse o6/QBsN66YZkLgCgMelAvsMcqdcsE+DKcamy5V8DAcnuL2WC9+Xfz1YMdnP5ZHLs7qpd 1AF5bucs2WlBsKYqRQTuRFkyuW3i0nGdr19lYSlfHaXX0Tz8x4xj5Dt0hp3piRaJnFyn FhcIjRf6WOcjtEMrzrochp3d0o0vY+CIy5NKz6L3pIasrYMqbrpMyxO3+rXwucVExWCF 2TxcSyoSckaN4HGmNqzLJKDMTwPSjvgNHshEKUMgAP1qzdzyI16YYUJU2PgN9B9zo2vN 7sPw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1731950658; x=1732555458; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=zrtTSIAZyM7Cil0D9jbVirGKiaDBwbsx28N7FRyo/s0=; b=LLSZoqt0oOTgTur+DzyGQ/6K4mS94fCMNpxshoN1T+Z0XkmHnjuz/AOyPhTDhf7mkb gbfzqQYgfnV1swPDpcNfr38a4yGTpP1U+TEKKX9T3HF9hmRy1kqwT+RuCWzBKq/GuU16 3gkCFOkuksRfWoZIK+LpR6MTnQTmHhT97sjieg8mtKCqklMSGYq5BZfrLOcsetlDBR50 ZA6mjuFTrIVdX7DJZT3iifV8psenusDNyULf2jxYLXCWhXQUjQtwg97+Xu00Rh/mrJ3S KIyLpKStTu8Y/Ejw98MN/cb5nnR9NUl/e56Y6x47fQ7IUWnIm57jtzVbxN+iV5wgxGpf rPZw== X-Gm-Message-State: AOJu0Yw8RSN+QwKDYPEIWzizNW2uponQqqXbCaWs9GegTXh/XLxK0XQf D0WjAXtPh7s/l69yhrlaXGjWEySxaFP7zH4u4mxfpK8xQe7Zn5hNK3jT7jGd8J3cf/kLUyhz+6S 4kEqabA== X-Received: by 2002:a17:902:da92:b0:20c:c694:f6c6 with SMTP id d9443c01a7336-211d0ed25e5mr183981405ad.49.1731950658440; Mon, 18 Nov 2024 09:24:18 -0800 (PST) Received: from linaro.. (216-180-64-156.dyn.novuscom.net. [216.180.64.156]) by smtp.gmail.com with ESMTPSA id d9443c01a7336-211d0f55d04sm59469765ad.264.2024.11.18.09.24.17 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 18 Nov 2024 09:24:18 -0800 (PST) From: Pierrick Bouvier To: qemu-devel@nongnu.org Cc: =?utf-8?q?Philippe_Mathieu-Daud=C3=A9?= , Richard Henderson , Andrew Melnychenko , =?utf-8?q?Daniel_P=2E_Berrang=C3=A9?= , Jason Wang , Thomas Huth , alex.bennee@linaro.org, Vladimir Sementsov-Ogievskiy , Fabiano Rosas , Kevin Wolf , Markus Armbruster , Eric Blake , qemu-arm@nongnu.org, Yuri Benditovich , manos.pitsidianakis@linaro.org, qemu-block@nongnu.org, Michael Roth , Konstantin Kostiuk , Paolo Bonzini , Peter Xu , gustavo.romero@linaro.org, Peter Maydell , Pierrick Bouvier Subject: [PATCH 4/7] docs/devel: add information on how to setup build environments Date: Mon, 18 Nov 2024 09:23:54 -0800 Message-Id: <20241118172357.475281-5-pierrick.bouvier@linaro.org> X-Mailer: git-send-email 2.39.5 In-Reply-To: <20241118172357.475281-1-pierrick.bouvier@linaro.org> References: <20241118172357.475281-1-pierrick.bouvier@linaro.org> MIME-Version: 1.0 Received-SPF: pass client-ip=2607:f8b0:4864:20::62e; envelope-from=pierrick.bouvier@linaro.org; helo=mail-pl1-x62e.google.com X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_NONE=-0.0001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: qemu-devel-bounces+patch=linaro.org@nongnu.org Sender: qemu-devel-bounces+patch=linaro.org@nongnu.org MacOS and Linux are straightforward, but Windows needs a bit more details. Signed-off-by: Pierrick Bouvier --- docs/about/build-platforms.rst | 4 +- docs/devel/build-environment.rst | 114 +++++++++++++++++++++++++++++++ docs/devel/index-build.rst | 1 + 3 files changed, 118 insertions(+), 1 deletion(-) create mode 100644 docs/devel/build-environment.rst diff --git a/docs/about/build-platforms.rst b/docs/about/build-platforms.rst index 6102f00aec0..c1ea53db834 100644 --- a/docs/about/build-platforms.rst +++ b/docs/about/build-platforms.rst @@ -29,6 +29,9 @@ 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. +You can find how to install build dependencies for different systems on the +:ref:`setup-build-env` page. + Supported host architectures ---------------------------- @@ -130,7 +133,6 @@ Optional build dependencies cross compilation using ``docker`` or ``podman``, or to use pre-built binaries distributed with QEMU. - Windows ------- diff --git a/docs/devel/build-environment.rst b/docs/devel/build-environment.rst new file mode 100644 index 00000000000..d9a66f5fcc6 --- /dev/null +++ b/docs/devel/build-environment.rst @@ -0,0 +1,114 @@ + +.. _setup-build-env: + +Setup build environment +======================= + +QEMU uses a lot of dependencies on the host system. glib2 is used everywhere in +the code base, and most of the other dependencies are optional. + +We present here simple instructions to enable native builds on most popular +systems. + +You can find additional instructions on `QEMU wiki `_: + +- `Linux `_ +- `MacOS `_ +- `Windows `_ +- `BSD `_ + +Linux +----- + +Fedora +++++++ + +:: + + sudo dnf update && sudo dnf builddep qemu + +Debian/Ubuntu ++++++++++++++ + +You first need to enable `Sources List `_. +Then, use apt to install dependencies: + +:: + + sudo apt update && sudo apt build-dep qemu + +MacOS +----- + +You first need to install `Homebrew `_. Then, use it to +install dependencies: + +:: + + brew update && brew install $(brew deps --include-build qemu) + +Windows +------- + +You first need to install `MSYS2 `_. +MSYS2 offers `different environments `_. +x86_64 environments are based on GCC, while aarch64 is based on Clang. + +We recommend to use MINGW64 for windows-x86_64 and CLANGARM64 for windows-aarch64 +(only available on windows-aarch64 hosts). + +Then, you can open a windows shell, and enter msys2 env using: + +:: + + c:/msys64/msys2_shell.cmd -defterm -here -no-start -mingw64 + # Replace -ucrt64 by -clangarm64 or -ucrt64 for other environments. + +MSYS2 package manager does not offer a built-in way to install build +dependencies. You can start with this list of packages using pacman: + +Note: Dependencies need to be installed again if you use a different MSYS2 +environment. + +:: + + # update MSYS2 itself, you need to reopen your shell at the end. + pacman -Syu + pacman -S \ + base-devel binutils bison diffutils flex git grep make sed \ + ${MINGW_PACKAGE_PREFIX}-toolchain \ + ${MINGW_PACKAGE_PREFIX}-glib2 \ + ${MINGW_PACKAGE_PREFIX}-gtk3 \ + ${MINGW_PACKAGE_PREFIX}-libnfs \ + ${MINGW_PACKAGE_PREFIX}-libssh \ + ${MINGW_PACKAGE_PREFIX}-ninja \ + ${MINGW_PACKAGE_PREFIX}-pixman \ + ${MINGW_PACKAGE_PREFIX}-pkgconf \ + ${MINGW_PACKAGE_PREFIX}-python \ + ${MINGW_PACKAGE_PREFIX}-SDL2 \ + ${MINGW_PACKAGE_PREFIX}-zstd + +If you want to install all dependencies, it's possible to use recipe used to +build QEMU in MSYS2 itself. + +:: + + pacman -S wget + wget https://raw.githubusercontent.com/msys2/MINGW-packages/refs/heads/master/mingw-w64-qemu/PKGBUILD + # Some packages may be missing for your environment, installation will still + # be done though. + makepkg -s PKGBUILD || true + +Build on windows-aarch64 +++++++++++++++++++++++++ + +When trying to cross compile meson for x86_64 using UCRT64 or MINGW64 env, +configure will run into an error because the cpu detected is not correct. + +Meson detects x86_64 processes emulated, so you need to manually set the cpu, +and force a cross compilation (with empty prefix). + +:: + + ./configure --cpu=x86_64 --cross-prefix= + diff --git a/docs/devel/index-build.rst b/docs/devel/index-build.rst index 0023953be36..0745c81a264 100644 --- a/docs/devel/index-build.rst +++ b/docs/devel/index-build.rst @@ -8,6 +8,7 @@ some of the basics if you are adding new files and targets to the build. :maxdepth: 3 build-system + build-environment kconfig docs qapi-code-gen