Skip to content

Commit 52cae7f

Browse files
committed
kbuild: rust_is_available: add check for bindgen invocation
`scripts/rust_is_available.sh` calls `bindgen` with a special header in order to check whether the `libclang` version in use is suitable. However, the invocation itself may fail if, for instance, `bindgen` cannot locate `libclang`. This is fine for Kconfig (since the script will still fail and therefore disable Rust as it should), but it is pretty confusing for users of the `rustavailable` target given the error will be unrelated: ./scripts/rust_is_available.sh: 21: arithmetic expression: expecting primary: "100000 * + 100 * + " make: *** [Makefile:1816: rustavailable] Error 2 Instead, run the `bindgen` invocation independently in a previous step, saving its output and return code. If it fails, then show the user a proper error message. Otherwise, continue as usual with the saved output. Since the previous patch we show a reference to the docs, and the docs now explain how `bindgen` looks for `libclang`, thus the error message can leverage the documentation, avoiding duplication here (and making users aware of the setup guide in the documentation). Reported-by: Nick Desaulniers <[email protected]> Link: https://lore.kernel.org/rust-for-linux/CAKwvOdm5JT4wbdQQYuW+RT07rCi6whGBM2iUAyg8A1CmLXG6Nw@mail.gmail.com/ Reported-by: François Valenduc <[email protected]> Closes: Rust-for-Linux/linux#934 Reported-by: Alexandru Radovici <[email protected]> Closes: Rust-for-Linux/linux#921 Reported-by: Matthew Leach <[email protected]> Closes: https://lore.kernel.org/rust-for-linux/[email protected]/ Fixes: 78521f3 ("scripts: add `rust_is_available.sh`") Reviewed-by: Martin Rodriguez Reboredo <[email protected]> Reviewed-by: Masahiro Yamada <[email protected]> Reviewed-by: Nathan Chancellor <[email protected]> Link: https://lore.kernel.org/r/[email protected] Signed-off-by: Miguel Ojeda <[email protected]>
1 parent aac284b commit 52cae7f

File tree

1 file changed

+21
-1
lines changed

1 file changed

+21
-1
lines changed

scripts/rust_is_available.sh

+21-1
Original file line numberDiff line numberDiff line change
@@ -106,8 +106,28 @@ if [ "$rust_bindings_generator_cversion" -gt "$rust_bindings_generator_min_cvers
106106
fi
107107

108108
# Check that the `libclang` used by the Rust bindings generator is suitable.
109+
#
110+
# In order to do that, first invoke `bindgen` to get the `libclang` version
111+
# found by `bindgen`. This step may already fail if, for instance, `libclang`
112+
# is not found, thus inform the user in such a case.
113+
bindgen_libclang_output=$( \
114+
LC_ALL=C "$BINDGEN" $(dirname $0)/rust_is_available_bindgen_libclang.h 2>&1 >/dev/null
115+
) || bindgen_libclang_code=$?
116+
if [ -n "$bindgen_libclang_code" ]; then
117+
echo >&2 "***"
118+
echo >&2 "*** Running '$BINDGEN' to check the libclang version (used by the Rust"
119+
echo >&2 "*** bindings generator) failed with code $bindgen_libclang_code. This may be caused by"
120+
echo >&2 "*** a failure to locate libclang. See output and docs below for details:"
121+
echo >&2 "***"
122+
echo >&2 "$bindgen_libclang_output"
123+
echo >&2 "***"
124+
exit 1
125+
fi
126+
127+
# `bindgen` returned successfully, thus use the output to check that the version
128+
# of the `libclang` found by the Rust bindings generator is suitable.
109129
bindgen_libclang_version=$( \
110-
LC_ALL=C "$BINDGEN" $(dirname $0)/rust_is_available_bindgen_libclang.h 2>&1 >/dev/null \
130+
echo "$bindgen_libclang_output" \
111131
| grep -F 'clang version ' \
112132
| grep -oE '[0-9]+\.[0-9]+\.[0-9]+' \
113133
| head -n 1 \

0 commit comments

Comments
 (0)