linux-kernel - [PATCH v2 5/6] kbuild: rust: warn if the out-of-tree compiler differs from the kernel one

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <20240902165535.1101978-6-ojeda@kernel.org>
Date: Mon,  2 Sep 2024 18:55:32 +0200
From: Miguel Ojeda <ojeda@...nel.org>
To: Miguel Ojeda <ojeda@...nel.org>,
	Alex Gaynor <alex.gaynor@...il.com>,
	Wedson Almeida Filho <wedsonaf@...il.com>,
	Masahiro Yamada <masahiroy@...nel.org>
Cc: Boqun Feng <boqun.feng@...il.com>,
	Gary Guo <gary@...yguo.net>,
	Björn Roy Baron <bjorn3_gh@...tonmail.com>,
	Benno Lossin <benno.lossin@...ton.me>,
	Andreas Hindborg <a.hindborg@...sung.com>,
	Alice Ryhl <aliceryhl@...gle.com>,
	rust-for-linux@...r.kernel.org,
	Nathan Chancellor <nathan@...nel.org>,
	Nicolas Schier <nicolas@...sle.eu>,
	linux-kbuild@...r.kernel.org,
	linux-kernel@...r.kernel.org,
	patches@...ts.linux.dev
Subject: [PATCH v2 5/6] kbuild: rust: warn if the out-of-tree compiler differs from the kernel one

For out-of-tree modules, in the C side, Kbuild warns if the C compiler
differs from the one used to build the kernel.

Do the same for Rust, except that we add the extra condition that Rust
support was enabled in the kernel.

For instance, the output will look like:

    warning: the Rust compiler differs from the one used to build the kernel
      The kernel was built by: rustc 1.78.0 (9b00956e5 2024-04-29)
      You are using:           rustc 1.79.0 (129f3b996 2024-06-10)

Note that the build will fail later anyway in such a case, since the
Rust compiler checks for incompatible Rust versions, e.g.:

      RUSTC [M] rust-out-of-tree-module/rust_out_of_tree.o
    error[E0514]: found crate `core` compiled by an incompatible version of rustc
      |
      = note: the following crate versions were found:
              crate `core` compiled by rustc 1.78.0 (9b00956e5 2024-04-29): rust/libcore.rmeta
      = help: please recompile that crate using this compiler (rustc 1.79.0 (129f3b996 2024-06-10)) (consider running `cargo clean` first)

Nevertheless, the added warning at the top should hopefully make the
situation clearer.

The extra condition on `CONFIG_RUST=y` is added since otherwise users
would get warnings when a Rust compiler is reachable, e.g. the most
likely case today is that they are building a C module for a kernel that
does not have Rust enabled.

However, if Rust was indeed enabled, then we do print the warning in
all cases, e.g. even if they are building a C module. While it may not
matter in some cases, it may still be a sign that something unexpectedly
changed in the environment they may want to be aware of:

    warning: the Rust compiler differs from the one used to build the kernel
      The kernel was built by: rustc 1.78.0 (9b00956e5 2024-04-29)
      You are using:           rustc 1.79.0 (129f3b996 2024-06-10)
      CC [M]  c-out-of-tree-module/c_out_of_tree.o

Note that the check will also trigger for cases where the user does not
have the Rust compiler installed, including when building a C module:

    warning: the Rust compiler differs from the one used to build the kernel
      The kernel was built by: rustc 1.78.0 (9b00956e5 2024-04-29)
      You are using:
      CC [M]  c-out-of-tree-module/c_out_of_tree.o

Suggested-by: Nicolas Schier <nicolas@...sle.eu>
Link: https://lore.kernel.org/rust-for-linux/20240817-heavy-dancing-whale-6ae13d@lindesnes/
Signed-off-by: Miguel Ojeda <ojeda@...nel.org>
---
 Makefile | 10 ++++++++--
 1 file changed, 8 insertions(+), 2 deletions(-)

diff --git a/Makefile b/Makefile
index 1883aeb919a4..e3fcc7028c5f 100644
--- a/Makefile
+++ b/Makefile
@@ -1794,14 +1794,20 @@ clean: private rm-files := $(KBUILD_EXTMOD)/Module.symvers $(KBUILD_EXTMOD)/modu
 	$(KBUILD_EXTMOD)/compile_commands.json
 
 PHONY += prepare
-# now expand this into a simple variable to reduce the cost of shell evaluations
+# now expand these into simple variables to reduce the cost of shell evaluations
 prepare: CC_VERSION_TEXT := $(CC_VERSION_TEXT)
+prepare: RUSTC_VERSION_TEXT := $(RUSTC_VERSION_TEXT)
 prepare:
 	@if [ "$(CC_VERSION_TEXT)" != "$(CONFIG_CC_VERSION_TEXT)" ]; then \
-		echo >&2 "warning: the compiler differs from the one used to build the kernel"; \
+		echo >&2 "warning: the C compiler differs from the one used to build the kernel"; \
 		echo >&2 "  The kernel was built by: $(CONFIG_CC_VERSION_TEXT)"; \
 		echo >&2 "  You are using:           $(CC_VERSION_TEXT)"; \
 	fi
+	@if [ "$(CONFIG_RUST)" = "y" -a "$(RUSTC_VERSION_TEXT)" != "$(CONFIG_RUSTC_VERSION_TEXT)" ]; then \
+		echo >&2 "warning: the Rust compiler differs from the one used to build the kernel"; \
+		echo >&2 "  The kernel was built by: $(CONFIG_RUSTC_VERSION_TEXT)"; \
+		echo >&2 "  You are using:           $(RUSTC_VERSION_TEXT)"; \
+	fi
 
 PHONY += help
 help:
-- 
2.46.0