| Message ID | 20230616001631.463536-1-ojeda@kernel.org (mailing list archive) |
|---|---|
| Headers | show |
| Series | `scripts/rust_is_available.sh` improvements | expand |
On Fri Jun 16, 2023 at 3:16 AM EEST, Miguel Ojeda wrote: > This is the patch series to improve `scripts/rust_is_available.sh`. > > The major addition in v2 is the test suite in the last commit. I added > it because I wanted to have a proper way to test any further changes to > it (such as the suggested `set --` idea to avoid forking by Masahiro), > and so that adding new checks was easier to justify too (i.e. vs. the > added complexity). > > In addition, there are also a few new checks in the script, to cover for > even some more cases, which hopefully make problematic setups easier to > identify and solve by users building the kernel. For instance, running > the script externally gives: > > $ scripts/rust_is_available.sh > *** > *** Environment variable 'RUSTC' is not set. > *** > *** This script is intended to be called from Kbuild. > *** Please use the 'rustavailable' target to call it instead. > *** Otherwise, the results may not be meaningful. > *** > *** Please see Documentation/rust/quick-start.rst for details > *** on how to set up the Rust support. > *** > > I also changed it to avoid setting `-e` as Masahiro suggested. > Similarly, I now check for `$RUSTC`, `$BINDGEN` and `$CC`, instead of > `$MAKEFLAGS`, as he also suggested (but I gave it their own error > message rather than use the `${CC?: is not set}` approach. This goes in > line with the reasons outlined above, i.e. trying to give users a clear > error of what step exactly failed). > > In the test suite I included previously problematic compiler version > strings we got reports for. The test suite covers all current branches > in the script, and we should keep it that way in the future. > > The patch series also include Masahiro's patch to remove the `-v` > option, as well as Russell's patch for supporting multiple arguments > in `$CC`. > > All in all, this should solve all the issues we got so far (unless I > have missed something) and improve things further with the new checks > plus the test suite to hopefully have an easier time in the future. > > Testers for this one are appreciated, especially if you have uncommon or > custom setups for building the kernel. I gave this patch series a spin and is a nice improvement when trying to use a broken setup. When previously I had: ./scripts/rust_is_available.sh: line 21: 100000 * + 100 * + : syntax error: operand expected (error token is "+ ") make: *** [Makefile:1883: rustavailable] Error 1 Now I have: *** *** Running 'bindgen' to check the libclang version (used by the Rust *** bindings generator) failed with code 101. This may be caused by *** a failure to locate libclang. See output and docs below for details: *** thread 'main' panicked at 'Unable to find libclang: "the `libclang` shared library at /opt/sdk/sysroots/x86_64-pokysdk-linux/usr/lib/libclang.so.14.0.3 could not be opened: /lib/x86_64-linux-gnu/libc.so.6: version `GLIBC_2.34' not found (required by /opt/idc23/sysroots/x86_64-pokysdk-linux/usr/lib/libclang.so.14.0.3)"', /home/heghedusrazvan/.cargo/registry/src/github.com-1ecc6299db9ec823/bindgen-0.56.0/src/lib.rs:1922:31 note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace *** *** *** Please see Documentation/rust/quick-start.rst for details *** on how to set up the Rust support. *** make: *** [Makefile:1883: rustavailable] Error 1 or: *** *** Rust compiler 'rustc' is too new. This may or may not work. *** Your version: 1.70.0 *** Expected version: 1.68.2 *** *** *** Running 'bindgen' to check the libclang version (used by the Rust *** bindings generator) failed with code 101. This may be caused by *** a failure to locate libclang. See output and docs below for details: *** thread 'main' panicked at 'Unable to find libclang: "the `libclang` shared library at /opt/sdk/sysroots/x86_64-pokysdk-linux/usr/lib/libclang.so.14.0.3 could not be opened: libncurses.so.5: cannot open shared object file: No such file or directory"', /root/.cargo/registry/src/index.crates.io-6f17d22bba15001f/bindgen-0.56.0/src/lib.rs:1922:31 note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace *** *** *** Please see Documentation/rust/quick-start.rst for details *** on how to set up the Rust support. *** make: *** [Makefile:1883: rustavailable] Error 1 -- Razvan > > This could go through either the Kbuild or the Rust tree. > > Masahiro Yamada (1): > kbuild: rust_is_available: remove -v option > > Miguel Ojeda (9): > docs: rust: add paragraph about finding a suitable `libclang` > kbuild: rust_is_available: print docs reference > kbuild: rust_is_available: add check for `bindgen` invocation > kbuild: rust_is_available: check that environment variables are set > kbuild: rust_is_available: fix confusion when a version appears in the > path > kbuild: rust_is_available: normalize version matching > kbuild: rust_is_available: handle failures calling `$RUSTC`/`$BINDGEN` > kbuild: rust_is_available: check that output looks as expected > kbuild: rust_is_available: add test suite > > Russell Currey (1): > kbuild: rust_is_available: fix version check when CC has multiple > arguments > > Documentation/rust/quick-start.rst | 17 ++ > Makefile | 4 +- > scripts/rust_is_available.sh | 233 +++++++++++++------ > scripts/rust_is_available_test.py | 346 +++++++++++++++++++++++++++++ > 4 files changed, 532 insertions(+), 68 deletions(-) > create mode 100755 scripts/rust_is_available_test.py > > > base-commit: 858fd168a95c5b9669aac8db6c14a9aeab446375 > -- > 2.41.0
On Fri, Jun 16, 2023 at 9:16 AM Miguel Ojeda <ojeda@kernel.org> wrote: > > This is the patch series to improve `scripts/rust_is_available.sh`. > > The major addition in v2 is the test suite in the last commit. I added > it because I wanted to have a proper way to test any further changes to > it (such as the suggested `set --` idea to avoid forking by Masahiro), > and so that adding new checks was easier to justify too (i.e. vs. the > added complexity). > > In addition, there are also a few new checks in the script, to cover for > even some more cases, which hopefully make problematic setups easier to > identify and solve by users building the kernel. For instance, running > the script externally gives: > > $ scripts/rust_is_available.sh > *** > *** Environment variable 'RUSTC' is not set. > *** > *** This script is intended to be called from Kbuild. > *** Please use the 'rustavailable' target to call it instead. > *** Otherwise, the results may not be meaningful. > *** > *** Please see Documentation/rust/quick-start.rst for details > *** on how to set up the Rust support. > *** > > I also changed it to avoid setting `-e` as Masahiro suggested. > Similarly, I now check for `$RUSTC`, `$BINDGEN` and `$CC`, instead of > `$MAKEFLAGS`, as he also suggested (but I gave it their own error > message rather than use the `${CC?: is not set}` approach. This goes in > line with the reasons outlined above, i.e. trying to give users a clear > error of what step exactly failed). > > In the test suite I included previously problematic compiler version > strings we got reports for. The test suite covers all current branches > in the script, and we should keep it that way in the future. > > The patch series also include Masahiro's patch to remove the `-v` > option, as well as Russell's patch for supporting multiple arguments > in `$CC`. > > All in all, this should solve all the issues we got so far (unless I > have missed something) and improve things further with the new checks > plus the test suite to hopefully have an easier time in the future. > > Testers for this one are appreciated, especially if you have uncommon or > custom setups for building the kernel. > > This could go through either the Kbuild or the Rust tree. Please feel free to apply it to the Rust tree. Perhaps I may add minor comments, but it is up to you. Best Regards Masahiro Yamada
On Fri, Jun 16, 2023 at 2:16 AM Miguel Ojeda <ojeda@kernel.org> wrote: > > This is the patch series to improve `scripts/rust_is_available.sh`. > > The major addition in v2 is the test suite in the last commit. I added > it because I wanted to have a proper way to test any further changes to > it (such as the suggested `set --` idea to avoid forking by Masahiro), > and so that adding new checks was easier to justify too (i.e. vs. the > added complexity). > > In addition, there are also a few new checks in the script, to cover for > even some more cases, which hopefully make problematic setups easier to > identify and solve by users building the kernel. For instance, running > the script externally gives: > > $ scripts/rust_is_available.sh > *** > *** Environment variable 'RUSTC' is not set. > *** > *** This script is intended to be called from Kbuild. > *** Please use the 'rustavailable' target to call it instead. > *** Otherwise, the results may not be meaningful. > *** > *** Please see Documentation/rust/quick-start.rst for details > *** on how to set up the Rust support. > *** > > I also changed it to avoid setting `-e` as Masahiro suggested. > Similarly, I now check for `$RUSTC`, `$BINDGEN` and `$CC`, instead of > `$MAKEFLAGS`, as he also suggested (but I gave it their own error > message rather than use the `${CC?: is not set}` approach. This goes in > line with the reasons outlined above, i.e. trying to give users a clear > error of what step exactly failed). > > In the test suite I included previously problematic compiler version > strings we got reports for. The test suite covers all current branches > in the script, and we should keep it that way in the future. > > The patch series also include Masahiro's patch to remove the `-v` > option, as well as Russell's patch for supporting multiple arguments > in `$CC`. > > All in all, this should solve all the issues we got so far (unless I > have missed something) and improve things further with the new checks > plus the test suite to hopefully have an easier time in the future. > > Testers for this one are appreciated, especially if you have uncommon or > custom setups for building the kernel. > > This could go through either the Kbuild or the Rust tree. Applied to `rust-next` -- thanks everyone! Cheers, Miguel
This is the patch series to improve `scripts/rust_is_available.sh`. The major addition in v2 is the test suite in the last commit. I added it because I wanted to have a proper way to test any further changes to it (such as the suggested `set --` idea to avoid forking by Masahiro), and so that adding new checks was easier to justify too (i.e. vs. the added complexity). In addition, there are also a few new checks in the script, to cover for even some more cases, which hopefully make problematic setups easier to identify and solve by users building the kernel. For instance, running the script externally gives: $ scripts/rust_is_available.sh *** *** Environment variable 'RUSTC' is not set. *** *** This script is intended to be called from Kbuild. *** Please use the 'rustavailable' target to call it instead. *** Otherwise, the results may not be meaningful. *** *** Please see Documentation/rust/quick-start.rst for details *** on how to set up the Rust support. *** I also changed it to avoid setting `-e` as Masahiro suggested. Similarly, I now check for `$RUSTC`, `$BINDGEN` and `$CC`, instead of `$MAKEFLAGS`, as he also suggested (but I gave it their own error message rather than use the `${CC?: is not set}` approach. This goes in line with the reasons outlined above, i.e. trying to give users a clear error of what step exactly failed). In the test suite I included previously problematic compiler version strings we got reports for. The test suite covers all current branches in the script, and we should keep it that way in the future. The patch series also include Masahiro's patch to remove the `-v` option, as well as Russell's patch for supporting multiple arguments in `$CC`. All in all, this should solve all the issues we got so far (unless I have missed something) and improve things further with the new checks plus the test suite to hopefully have an easier time in the future. Testers for this one are appreciated, especially if you have uncommon or custom setups for building the kernel. This could go through either the Kbuild or the Rust tree. Masahiro Yamada (1): kbuild: rust_is_available: remove -v option Miguel Ojeda (9): docs: rust: add paragraph about finding a suitable `libclang` kbuild: rust_is_available: print docs reference kbuild: rust_is_available: add check for `bindgen` invocation kbuild: rust_is_available: check that environment variables are set kbuild: rust_is_available: fix confusion when a version appears in the path kbuild: rust_is_available: normalize version matching kbuild: rust_is_available: handle failures calling `$RUSTC`/`$BINDGEN` kbuild: rust_is_available: check that output looks as expected kbuild: rust_is_available: add test suite Russell Currey (1): kbuild: rust_is_available: fix version check when CC has multiple arguments Documentation/rust/quick-start.rst | 17 ++ Makefile | 4 +- scripts/rust_is_available.sh | 233 +++++++++++++------ scripts/rust_is_available_test.py | 346 +++++++++++++++++++++++++++++ 4 files changed, 532 insertions(+), 68 deletions(-) create mode 100755 scripts/rust_is_available_test.py base-commit: 858fd168a95c5b9669aac8db6c14a9aeab446375