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