From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id BBA0DC25B08 for ; Wed, 17 Aug 2022 20:18:47 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S241817AbiHQUSp (ORCPT ); Wed, 17 Aug 2022 16:18:45 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:48056 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S241813AbiHQUSl (ORCPT ); Wed, 17 Aug 2022 16:18:41 -0400 Received: from mail-pl1-x62a.google.com (mail-pl1-x62a.google.com [IPv6:2607:f8b0:4864:20::62a]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 4834E237E8 for ; Wed, 17 Aug 2022 13:18:38 -0700 (PDT) Received: by mail-pl1-x62a.google.com with SMTP id u22so4651904plq.12 for ; Wed, 17 Aug 2022 13:18:38 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=chromium.org; s=google; h=in-reply-to:content-disposition:mime-version:references:message-id :subject:cc:to:from:date:from:to:cc; bh=5Hp9E1q+IjAobUFj58w2iM0vbcOi4aEUuherVgXAHmM=; b=OmfuRjv+bwYcFtUJRfkCb5ZlmuYVDwEYUSRFS6rAT/u3RCA1oGRDezN1bG2WgU8RiH Ywa8ONAlXZ1YD56w8MwU80+GOgEmxGM2i3UNq0bb9rT6xHISScJaAcmvBuLzEcTXzNdN XVBUUhupHDCvYb4hpNZCqpaM3No0Zxq5zxIiU= X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=in-reply-to:content-disposition:mime-version:references:message-id :subject:cc:to:from:date:x-gm-message-state:from:to:cc; bh=5Hp9E1q+IjAobUFj58w2iM0vbcOi4aEUuherVgXAHmM=; b=JFW6xr9m0piQ6oPicDNr0Ef5SGQ7PpV3NQBYgtyaZg1zA/v6zrHiCgbbrY8Fx6oqvF ADEvP+k9Wd41TAcv2JcJaN2YyErNivZPOmlxfjDO36rcbU4v2TuqeR1ND81h7MRDo8oI iEe4uVp2K90Se/gPnKU6wKbuQq3u2u0bsKNil4g4NRFdNmpK9u96uMvdpm0XNbphwi9q PvQaKHYaVVnWEEIU9tCuJQYgyCLRl2gHHue3XdQQvuA7hhkKwVynTu9twerifg7K2o1i X+NjgZNIGwL4DBBN57WHdKkEiReu2Sf9xN1hcG85F3R7cdO7eXmpye3Rv5Zthxaqy9Z0 qHuQ== X-Gm-Message-State: ACgBeo01vXR72XqkQCSCrQzROeNb8WA8fsPqvYJgL4jG4GFjqBRIyXfr 8jyH4XZdrFHb21m5MpkFGsmzDw== X-Google-Smtp-Source: AA6agR7kpGsY32jz/OEhGyiuSqAoWNhaRI6RiaxLztDBXSjLkvNbNTkMQQZ17Gao952Y2adGHz7Iyg== X-Received: by 2002:a17:902:bd08:b0:16e:e00c:dd48 with SMTP id p8-20020a170902bd0800b0016ee00cdd48mr28116310pls.93.1660767517687; Wed, 17 Aug 2022 13:18:37 -0700 (PDT) Received: from www.outflux.net (smtp.outflux.net. [198.145.64.163]) by smtp.gmail.com with ESMTPSA id a3-20020aa79703000000b0052d4cb47339sm10852950pfg.151.2022.08.17.13.18.36 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 17 Aug 2022 13:18:37 -0700 (PDT) Date: Wed, 17 Aug 2022 13:18:36 -0700 From: Kees Cook To: Miguel Ojeda Cc: Linus Torvalds , Greg Kroah-Hartman , rust-for-linux@vger.kernel.org, linux-kernel@vger.kernel.org, linux-fsdevel@vger.kernel.org, patches@lists.linux.dev, Jarkko Sakkinen , Alex Gaynor , Wedson Almeida Filho , Finn Behrens , Miguel Cano , Tiago Lam , Boqun Feng , Gary Guo , =?iso-8859-1?Q?Bj=F6rn?= Roy Baron Subject: Re: [PATCH v9 20/27] scripts: add `rust_is_available.sh` Message-ID: <202208171317.F5D57135@keescook> References: <20220805154231.31257-1-ojeda@kernel.org> <20220805154231.31257-21-ojeda@kernel.org> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: <20220805154231.31257-21-ojeda@kernel.org> Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org On Fri, Aug 05, 2022 at 05:42:05PM +0200, Miguel Ojeda wrote: > This script tests whether the Rust toolchain requirements are in place > to enable Rust support. > > The build system will call it to set `CONFIG_RUST_IS_AVAILABLE` in > a later patch. > > It also has an option (`-v`) to explain what is missing, which is > useful to set up the development environment. This is used via > the `make rustavailable` target added in a later patch. > > Co-developed-by: Alex Gaynor > Signed-off-by: Alex Gaynor > Co-developed-by: Wedson Almeida Filho > Signed-off-by: Wedson Almeida Filho > Co-developed-by: Finn Behrens > Signed-off-by: Finn Behrens > Co-developed-by: Miguel Cano > Signed-off-by: Miguel Cano > Co-developed-by: Tiago Lam > Signed-off-by: Tiago Lam > Signed-off-by: Miguel Ojeda > --- > scripts/rust_is_available.sh | 160 +++++++++++++++++++ > scripts/rust_is_available_bindgen_libclang.h | 2 + > 2 files changed, 162 insertions(+) > create mode 100755 scripts/rust_is_available.sh > create mode 100644 scripts/rust_is_available_bindgen_libclang.h > > diff --git a/scripts/rust_is_available.sh b/scripts/rust_is_available.sh > new file mode 100755 > index 000000000000..aebbf1913970 > --- /dev/null > +++ b/scripts/rust_is_available.sh > @@ -0,0 +1,160 @@ > +#!/bin/sh > +# SPDX-License-Identifier: GPL-2.0 > +# > +# Tests whether a suitable Rust toolchain is available. > +# > +# Pass `-v` for human output and more checks (as warnings). > + > +set -e > + > +min_tool_version=$(dirname $0)/min-tool-version.sh > + > +# Convert the version string x.y.z to a canonical up-to-7-digits form. > +# > +# Note that this function uses one more digit (compared to other > +# instances in other version scripts) to give a bit more space to > +# `rustc` since it will reach 1.100.0 in late 2026. > +get_canonical_version() > +{ > + IFS=. > + set -- $1 > + echo $((100000 * $1 + 100 * $2 + $3)) > +} > + > +# Check that the Rust compiler exists. > +if ! command -v "$RUSTC" >/dev/null; then > + if [ "$1" = -v ]; then > + echo >&2 "***" > + echo >&2 "*** Rust compiler '$RUSTC' could not be found." > + echo >&2 "***" > + fi > + exit 1 > +fi > + > +# Check that the Rust bindings generator exists. > +if ! command -v "$BINDGEN" >/dev/null; then > + if [ "$1" = -v ]; then > + echo >&2 "***" > + echo >&2 "*** Rust bindings generator '$BINDGEN' could not be found." > + echo >&2 "***" > + fi > + exit 1 > +fi > + > +# Check that the Rust compiler version is suitable. > +# > +# Non-stable and distributions' versions may have a version suffix, e.g. `-dev`. > +rust_compiler_version=$( \ > + LC_ALL=C "$RUSTC" --version 2>/dev/null \ > + | head -n 1 \ > + | grep -oE '[0-9]+\.[0-9]+\.[0-9]+' \ > +) > +rust_compiler_min_version=$($min_tool_version rustc) I think the min-tool-version.sh changes from patch 23 should be moved into this patch. With that: Reviewed-by: Kees Cook -Kees > +rust_compiler_cversion=$(get_canonical_version $rust_compiler_version) > +rust_compiler_min_cversion=$(get_canonical_version $rust_compiler_min_version) > +if [ "$rust_compiler_cversion" -lt "$rust_compiler_min_cversion" ]; then > + if [ "$1" = -v ]; then > + echo >&2 "***" > + echo >&2 "*** Rust compiler '$RUSTC' is too old." > + echo >&2 "*** Your version: $rust_compiler_version" > + echo >&2 "*** Minimum version: $rust_compiler_min_version" > + echo >&2 "***" > + fi > + exit 1 > +fi > +if [ "$1" = -v ] && [ "$rust_compiler_cversion" -gt "$rust_compiler_min_cversion" ]; then > + echo >&2 "***" > + echo >&2 "*** Rust compiler '$RUSTC' is too new. This may or may not work." > + echo >&2 "*** Your version: $rust_compiler_version" > + echo >&2 "*** Expected version: $rust_compiler_min_version" > + echo >&2 "***" > +fi > + > +# Check that the Rust bindings generator is suitable. > +# > +# Non-stable and distributions' versions may have a version suffix, e.g. `-dev`. > +rust_bindings_generator_version=$( \ > + LC_ALL=C "$BINDGEN" --version 2>/dev/null \ > + | head -n 1 \ > + | grep -oE '[0-9]+\.[0-9]+\.[0-9]+' \ > +) > +rust_bindings_generator_min_version=$($min_tool_version bindgen) > +rust_bindings_generator_cversion=$(get_canonical_version $rust_bindings_generator_version) > +rust_bindings_generator_min_cversion=$(get_canonical_version $rust_bindings_generator_min_version) > +if [ "$rust_bindings_generator_cversion" -lt "$rust_bindings_generator_min_cversion" ]; then > + if [ "$1" = -v ]; then > + echo >&2 "***" > + echo >&2 "*** Rust bindings generator '$BINDGEN' is too old." > + echo >&2 "*** Your version: $rust_bindings_generator_version" > + echo >&2 "*** Minimum version: $rust_bindings_generator_min_version" > + echo >&2 "***" > + fi > + exit 1 > +fi > +if [ "$1" = -v ] && [ "$rust_bindings_generator_cversion" -gt "$rust_bindings_generator_min_cversion" ]; then > + echo >&2 "***" > + echo >&2 "*** Rust bindings generator '$BINDGEN' is too new. This may or may not work." > + echo >&2 "*** Your version: $rust_bindings_generator_version" > + echo >&2 "*** Expected version: $rust_bindings_generator_min_version" > + echo >&2 "***" > +fi > + > +# Check that the `libclang` used by the Rust bindings generator is suitable. > +bindgen_libclang_version=$( \ > + LC_ALL=C "$BINDGEN" $(dirname $0)/rust_is_available_bindgen_libclang.h 2>&1 >/dev/null \ > + | grep -F 'clang version ' \ > + | grep -oE '[0-9]+\.[0-9]+\.[0-9]+' \ > + | head -n 1 \ > +) > +bindgen_libclang_min_version=$($min_tool_version llvm) > +bindgen_libclang_cversion=$(get_canonical_version $bindgen_libclang_version) > +bindgen_libclang_min_cversion=$(get_canonical_version $bindgen_libclang_min_version) > +if [ "$bindgen_libclang_cversion" -lt "$bindgen_libclang_min_cversion" ]; then > + if [ "$1" = -v ]; then > + echo >&2 "***" > + echo >&2 "*** libclang (used by the Rust bindings generator '$BINDGEN') is too old." > + echo >&2 "*** Your version: $bindgen_libclang_version" > + echo >&2 "*** Minimum version: $bindgen_libclang_min_version" > + echo >&2 "***" > + fi > + exit 1 > +fi > + > +# If the C compiler is Clang, then we can also check whether its version > +# matches the `libclang` version used by the Rust bindings generator. > +# > +# In the future, we might be able to perform a full version check, see > +# https://github.com/rust-lang/rust-bindgen/issues/2138. > +if [ "$1" = -v ]; then > + cc_name=$($(dirname $0)/cc-version.sh "$CC" | cut -f1 -d' ') > + if [ "$cc_name" = Clang ]; then > + clang_version=$( \ > + LC_ALL=C "$CC" --version 2>/dev/null \ > + | sed -nE '1s:.*version ([0-9]+\.[0-9]+\.[0-9]+).*:\1:p' > + ) > + if [ "$clang_version" != "$bindgen_libclang_version" ]; then > + echo >&2 "***" > + echo >&2 "*** libclang (used by the Rust bindings generator '$BINDGEN')" > + echo >&2 "*** version does not match Clang's. This may be a problem." > + echo >&2 "*** libclang version: $bindgen_libclang_version" > + echo >&2 "*** Clang version: $clang_version" > + echo >&2 "***" > + fi > + fi > +fi > + > +# Check that the source code for the `core` standard library exists. > +# > +# `$KRUSTFLAGS` is passed in case the user added `--sysroot`. > +rustc_sysroot=$("$RUSTC" $KRUSTFLAGS --print sysroot) > +rustc_src=${RUST_LIB_SRC:-"$rustc_sysroot/lib/rustlib/src/rust/library"} > +rustc_src_core="$rustc_src/core/src/lib.rs" > +if [ ! -e "$rustc_src_core" ]; then > + if [ "$1" = -v ]; then > + echo >&2 "***" > + echo >&2 "*** Source code for the 'core' standard library could not be found" > + echo >&2 "*** at '$rustc_src_core'." > + echo >&2 "***" > + fi > + exit 1 > +fi > diff --git a/scripts/rust_is_available_bindgen_libclang.h b/scripts/rust_is_available_bindgen_libclang.h > new file mode 100644 > index 000000000000..0ef6db10d674 > --- /dev/null > +++ b/scripts/rust_is_available_bindgen_libclang.h > @@ -0,0 +1,2 @@ > +/* SPDX-License-Identifier: GPL-2.0 */ > +#pragma message("clang version " __clang_version__) > -- > 2.37.1 > -- Kees Cook