projects/linux·blob master · refs

259 lines · 9.2 KiB

1#!/bin/sh
2# SPDX-License-Identifier: GPL-2.0
3#
4# Tests whether a suitable Rust toolchain is available.
5
6set -e
7
8min_tool_version=$(dirname $0)/min-tool-version.sh
9
10# Convert the version string x.y.z to a canonical up-to-7-digits form.
11#
12# Note that this function uses one more digit (compared to other
13# instances in other version scripts) to give a bit more space to
14# `rustc` since it will reach 1.100.0 in late 2026.
15get_canonical_version()
16{
17 IFS=.
18 set -- $1
19 echo $((100000 * $1 + 100 * $2 + $3))
20}
21
22# Print a reference to the Quick Start guide in the documentation.
23print_docs_reference()
24{
25 echo >&2 "***"
26 echo >&2 "*** Please see Documentation/rust/quick-start.rst for details"
27 echo >&2 "*** on how to set up the Rust support."
28 echo >&2 "***"
29}
30
31# Print an explanation about the fact that the script is meant to be called from Kbuild.
32print_kbuild_explanation()
33{
34 echo >&2 "***"
35 echo >&2 "*** This script is intended to be called from Kbuild."
36 echo >&2 "*** Please use the 'rustavailable' target to call it instead."
37 echo >&2 "*** Otherwise, the results may not be meaningful."
38 exit 1
39}
40
41# If the script fails for any reason, or if there was any warning, then
42# print a reference to the documentation on exit.
43warning=0
44trap 'if [ $? -ne 0 ] || [ $warning -ne 0 ]; then print_docs_reference; fi' EXIT
45
46# Check that the expected environment variables are set.
47if [ -z "${RUSTC+x}" ]; then
48 echo >&2 "***"
49 echo >&2 "*** Environment variable 'RUSTC' is not set."
50 print_kbuild_explanation
51fi
52
53if [ -z "${BINDGEN+x}" ]; then
54 echo >&2 "***"
55 echo >&2 "*** Environment variable 'BINDGEN' is not set."
56 print_kbuild_explanation
57fi
58
59if [ -z "${CC+x}" ]; then
60 echo >&2 "***"
61 echo >&2 "*** Environment variable 'CC' is not set."
62 print_kbuild_explanation
63fi
64
65# Check that the Rust compiler exists.
66if ! command -v "$RUSTC" >/dev/null; then
67 echo >&2 "***"
68 echo >&2 "*** Rust compiler '$RUSTC' could not be found."
69 echo >&2 "***"
70 exit 1
71fi
72
73# Check that the Rust bindings generator exists.
74if ! command -v "$BINDGEN" >/dev/null; then
75 echo >&2 "***"
76 echo >&2 "*** Rust bindings generator '$BINDGEN' could not be found."
77 echo >&2 "***"
78 exit 1
79fi
80
81# Check that the Rust compiler version is suitable.
82#
83# Non-stable and distributions' versions may have a version suffix, e.g. `-dev`.
84rust_compiler_output=$( \
85 LC_ALL=C "$RUSTC" --version 2>/dev/null
86) || rust_compiler_code=$?
87if [ -n "$rust_compiler_code" ]; then
88 echo >&2 "***"
89 echo >&2 "*** Running '$RUSTC' to check the Rust compiler version failed with"
90 echo >&2 "*** code $rust_compiler_code. See output and docs below for details:"
91 echo >&2 "***"
92 echo >&2 "$rust_compiler_output"
93 echo >&2 "***"
94 exit 1
95fi
96rust_compiler_version=$( \
97 echo "$rust_compiler_output" \
98 | sed -nE '1s:.*rustc ([0-9]+\.[0-9]+\.[0-9]+).*:\1:p'
99)
100if [ -z "$rust_compiler_version" ]; then
101 echo >&2 "***"
102 echo >&2 "*** Running '$RUSTC' to check the Rust compiler version did not return"
103 echo >&2 "*** an expected output. See output and docs below for details:"
104 echo >&2 "***"
105 echo >&2 "$rust_compiler_output"
106 echo >&2 "***"
107 exit 1
108fi
109rust_compiler_min_version=$($min_tool_version rustc)
110rust_compiler_cversion=$(get_canonical_version $rust_compiler_version)
111rust_compiler_min_cversion=$(get_canonical_version $rust_compiler_min_version)
112if [ "$rust_compiler_cversion" -lt "$rust_compiler_min_cversion" ]; then
113 echo >&2 "***"
114 echo >&2 "*** Rust compiler '$RUSTC' is too old."
115 echo >&2 "*** Your version: $rust_compiler_version"
116 echo >&2 "*** Minimum version: $rust_compiler_min_version"
117 echo >&2 "***"
118 exit 1
119fi
120
121# Check that the Rust bindings generator is suitable.
122#
123# Non-stable and distributions' versions may have a version suffix, e.g. `-dev`.
124rust_bindings_generator_output=$( \
125 LC_ALL=C "$BINDGEN" --version 2>/dev/null
126) || rust_bindings_generator_code=$?
127if [ -n "$rust_bindings_generator_code" ]; then
128 echo >&2 "***"
129 echo >&2 "*** Running '$BINDGEN' to check the Rust bindings generator version failed with"
130 echo >&2 "*** code $rust_bindings_generator_code. See output and docs below for details:"
131 echo >&2 "***"
132 echo >&2 "$rust_bindings_generator_output"
133 echo >&2 "***"
134 exit 1
135fi
136rust_bindings_generator_version=$( \
137 echo "$rust_bindings_generator_output" \
138 | sed -nE '1s:.*bindgen ([0-9]+\.[0-9]+\.[0-9]+).*:\1:p'
139)
140if [ -z "$rust_bindings_generator_version" ]; then
141 echo >&2 "***"
142 echo >&2 "*** Running '$BINDGEN' to check the bindings generator version did not return"
143 echo >&2 "*** an expected output. See output and docs below for details:"
144 echo >&2 "***"
145 echo >&2 "$rust_bindings_generator_output"
146 echo >&2 "***"
147 exit 1
148fi
149rust_bindings_generator_min_version=$($min_tool_version bindgen)
150rust_bindings_generator_cversion=$(get_canonical_version $rust_bindings_generator_version)
151rust_bindings_generator_min_cversion=$(get_canonical_version $rust_bindings_generator_min_version)
152if [ "$rust_bindings_generator_cversion" -lt "$rust_bindings_generator_min_cversion" ]; then
153 echo >&2 "***"
154 echo >&2 "*** Rust bindings generator '$BINDGEN' is too old."
155 echo >&2 "*** Your version: $rust_bindings_generator_version"
156 echo >&2 "*** Minimum version: $rust_bindings_generator_min_version"
157 echo >&2 "***"
158 exit 1
159fi
160
161# Check that the `libclang` used by the Rust bindings generator is suitable.
162#
163# In order to do that, first invoke `bindgen` to get the `libclang` version
164# found by `bindgen`. This step may already fail if, for instance, `libclang`
165# is not found, thus inform the user in such a case.
166bindgen_libclang_output=$( \
167 LC_ALL=C "$BINDGEN" $(dirname $0)/rust_is_available_bindgen_libclang.h 2>&1 >/dev/null
168) || bindgen_libclang_code=$?
169if [ -n "$bindgen_libclang_code" ]; then
170 echo >&2 "***"
171 echo >&2 "*** Running '$BINDGEN' to check the libclang version (used by the Rust"
172 echo >&2 "*** bindings generator) failed with code $bindgen_libclang_code. This may be caused by"
173 echo >&2 "*** a failure to locate libclang. See output and docs below for details:"
174 echo >&2 "***"
175 echo >&2 "$bindgen_libclang_output"
176 echo >&2 "***"
177 exit 1
178fi
179
180# `bindgen` returned successfully, thus use the output to check that the version
181# of the `libclang` found by the Rust bindings generator is suitable.
182#
183# Unlike other version checks, note that this one does not necessarily appear
184# in the first line of the output, thus no `sed` address is provided.
185bindgen_libclang_version=$( \
186 echo "$bindgen_libclang_output" \
187 | sed -nE 's:.*clang version ([0-9]+\.[0-9]+\.[0-9]+).*:\1:p'
188)
189if [ -z "$bindgen_libclang_version" ]; then
190 echo >&2 "***"
191 echo >&2 "*** Running '$BINDGEN' to check the libclang version (used by the Rust"
192 echo >&2 "*** bindings generator) did not return an expected output. See output"
193 echo >&2 "*** and docs below for details:"
194 echo >&2 "***"
195 echo >&2 "$bindgen_libclang_output"
196 echo >&2 "***"
197 exit 1
198fi
199bindgen_libclang_min_version=$($min_tool_version llvm)
200bindgen_libclang_cversion=$(get_canonical_version $bindgen_libclang_version)
201bindgen_libclang_min_cversion=$(get_canonical_version $bindgen_libclang_min_version)
202if [ "$bindgen_libclang_cversion" -lt "$bindgen_libclang_min_cversion" ]; then
203 echo >&2 "***"
204 echo >&2 "*** libclang (used by the Rust bindings generator '$BINDGEN') is too old."
205 echo >&2 "*** Your version: $bindgen_libclang_version"
206 echo >&2 "*** Minimum version: $bindgen_libclang_min_version"
207 echo >&2 "***"
208 exit 1
209fi
210
211if [ "$bindgen_libclang_cversion" -ge 2200000 ] &&
212 [ "$rust_bindings_generator_cversion" -lt 7201 ]; then
213 # Distributions may have patched the issue.
214 if ! "$BINDGEN" $(dirname $0)/rust_is_available_bindgen_libclang_22.h | grep -q 'pub foo'; then
215 echo >&2 "***"
216 echo >&2 "*** Rust bindings generator '$BINDGEN' < 0.72.1 together with libclang >= 22"
217 echo >&2 "*** may not work due to a bug (https://github.com/rust-lang/rust-bindgen/pull/3278)."
218 echo >&2 "*** Your bindgen version: $rust_bindings_generator_version"
219 echo >&2 "*** Your libclang version: $bindgen_libclang_version"
220 echo >&2 "***"
221 warning=1
222 fi
223fi
224
225# If the C compiler is Clang, then we can also check whether its version
226# matches the `libclang` version used by the Rust bindings generator.
227#
228# In the future, we might be able to perform a full version check, see
229# https://github.com/rust-lang/rust-bindgen/issues/2138.
230cc_name=$($(dirname $0)/cc-version.sh $CC | cut -f1 -d' ')
231if [ "$cc_name" = Clang ]; then
232 clang_version=$( \
233 LC_ALL=C $CC --version 2>/dev/null \
234 | sed -nE '1s:.*version ([0-9]+\.[0-9]+\.[0-9]+).*:\1:p'
235 )
236 if [ "$clang_version" != "$bindgen_libclang_version" ]; then
237 echo >&2 "***"
238 echo >&2 "*** libclang (used by the Rust bindings generator '$BINDGEN')"
239 echo >&2 "*** version does not match Clang's. This may be a problem."
240 echo >&2 "*** libclang version: $bindgen_libclang_version"
241 echo >&2 "*** Clang version: $clang_version"
242 echo >&2 "***"
243 warning=1
244 fi
245fi
246
247# Check that the source code for the `core` standard library exists.
248#
249# `$KRUSTFLAGS` is passed in case the user added `--sysroot`.
250rustc_sysroot=$("$RUSTC" $KRUSTFLAGS --print sysroot)
251rustc_src=${RUST_LIB_SRC:-"$rustc_sysroot/lib/rustlib/src/rust/library"}
252rustc_src_core="$rustc_src/core/src/lib.rs"
253if [ ! -e "$rustc_src_core" ]; then
254 echo >&2 "***"
255 echo >&2 "*** Source code for the 'core' standard library could not be found"
256 echo >&2 "*** at '$rustc_src_core'."
257 echo >&2 "***"
258 exit 1
259fi