Skip to contentSkip to conversation

kbuild: rust: move `-Dwarnings` handling to `Makefile.extrawarn`

PATCH In review Miguel Ojeda 5 participants 16 messages May 19, 2024 – Jan 12, 2025

Subsystems (2)
lore
Share & tools
lore

Miguel Ojeda

author maintainer
#0 lore raw

PATCH 1/3 kbuild: rust: move `-Dwarnings` handling to `Makefile.extrawarn`

Following commit e88ca24319e4 ("kbuild: consolidate warning flags in scripts/Makefile.extrawarn"), move -Dwarnings handling into Makefile.extrawarn like C's -Werror.

No functional change intended.

---
 Makefile                   | 3 ---
 scripts/Makefile.extrawarn | 3 +++
 2 files changed, 3 insertions(+), 3 deletions(-)
Makefile +0 -3
index 763b6792d3d5..fba567a55607 100644
@@ -842,9 +842,6 @@ stackp-flags-$(CONFIG_STACKPROTECTOR_STRONG)      := -fstack-protector-strong
 
 KBUILD_CFLAGS += $(stackp-flags-y)
 
-KBUILD_RUSTFLAGS-$(CONFIG_WERROR) += -Dwarnings
-KBUILD_RUSTFLAGS += $(KBUILD_RUSTFLAGS-y)
-
 ifdef CONFIG_FRAME_POINTER
 KBUILD_CFLAGS	+= -fno-omit-frame-pointer -fno-optimize-sibling-calls
 KBUILD_RUSTFLAGS += -Cforce-frame-pointers=y
scripts/Makefile.extrawarn +3 -0
index 3ce5d503a6da..48114e91c386 100644
@@ -26,6 +26,9 @@ endif
 
 KBUILD_CPPFLAGS-$(CONFIG_WERROR) += -Werror
 KBUILD_CPPFLAGS += $(KBUILD_CPPFLAGS-y)
+KBUILD_RUSTFLAGS-$(CONFIG_WERROR) += -Dwarnings
+KBUILD_RUSTFLAGS += $(KBUILD_RUSTFLAGS-y)
+
 KBUILD_CFLAGS-$(CONFIG_CC_NO_ARRAY_BOUNDS) += -Wno-array-bounds
 
 ifdef CONFIG_CC_IS_CLANG
Signature · 1 line
2.45.1
author maintainer
#1 lore raw

PATCH 2/3 kbuild: rust: apply `CONFIG_WERROR` to all Rust targets

Make all Rust code (i.e. not just kernel code) respect CONFIG_WERROR, so that we keep everything warning clean.

In particular, this affects targets in rust/ (RUSTDOC H, RUSTC TL, RUSTDOC T, RUSTC T and RUSTC P), plus host programs and any others we may add later.

---
This one requires the rusttest warning cleanup at
https://lore.kernel.org/rust-for-linux/[email protected]/

 Makefile                   | 4 ++--
 scripts/Makefile.extrawarn | 4 ++--
 2 files changed, 4 insertions(+), 4 deletions(-)
Makefile +2 -2
index fba567a55607..2d0ea441cb9c 100644
@@ -469,7 +469,7 @@ export rust_common_flags := --edition=2021 \
 
 KBUILD_HOSTCFLAGS   := $(KBUILD_USERHOSTCFLAGS) $(HOST_LFS_CFLAGS) $(HOSTCFLAGS)
 KBUILD_HOSTCXXFLAGS := -Wall -O2 $(HOST_LFS_CFLAGS) $(HOSTCXXFLAGS)
-KBUILD_HOSTRUSTFLAGS := $(rust_common_flags) -O -Cstrip=debuginfo \
+KBUILD_HOSTRUSTFLAGS = $(rust_common_flags) -O -Cstrip=debuginfo \
 			-Zallow-features= $(HOSTRUSTFLAGS)
 KBUILD_HOSTLDFLAGS  := $(HOST_LFS_LDFLAGS) $(HOSTLDFLAGS)
 KBUILD_HOSTLDLIBS   := $(HOST_LFS_LIBS) $(HOSTLDLIBS)
@@ -560,7 +560,7 @@ KBUILD_CFLAGS += -fno-PIE
 KBUILD_CFLAGS += -fno-strict-aliasing
 
 KBUILD_CPPFLAGS := -D__KERNEL__
-KBUILD_RUSTFLAGS := $(rust_common_flags) \
+KBUILD_RUSTFLAGS = $(rust_common_flags) \
 		    -Cpanic=abort -Cembed-bitcode=n -Clto=n \
 		    -Cforce-unwind-tables=n -Ccodegen-units=1 \
 		    -Csymbol-mangling-version=v0 \
scripts/Makefile.extrawarn +2 -2
index 48114e91c386..990890821889 100644
@@ -26,8 +26,8 @@ endif
 
 KBUILD_CPPFLAGS-$(CONFIG_WERROR) += -Werror
 KBUILD_CPPFLAGS += $(KBUILD_CPPFLAGS-y)
-KBUILD_RUSTFLAGS-$(CONFIG_WERROR) += -Dwarnings
-KBUILD_RUSTFLAGS += $(KBUILD_RUSTFLAGS-y)
+rust_common_flags-$(CONFIG_WERROR) += -Dwarnings
+rust_common_flags += $(rust_common_flags-y)
 
 KBUILD_CFLAGS-$(CONFIG_CC_NO_ARRAY_BOUNDS) += -Wno-array-bounds
 

--
2.45.1

reviewer Reviewed-by on v1 2/3
#2 lore raw

Re: [PATCH 2/3] kbuild: rust: apply `CONFIG_WERROR` to all Rust targets

Quoted 9 lines · Miguel Ojeda

Make all Rust code (i.e. not just kernel code) respect CONFIG_WERROR, so that we keep everything warning clean.

In particular, this affects targets in rust/ (RUSTDOC H, RUSTC TL, RUSTDOC T, RUSTC T and RUSTC P), plus host programs and any others we may add later.

#3 lore raw

Re: [PATCH 2/3] kbuild: rust: apply `CONFIG_WERROR` to all Rust targets

In reply to Miguel Ojeda
Quoted 3 lines · Miguel Ojeda

Make all Rust code (i.e. not just kernel code) respect CONFIG_WERROR, so that we keep everything warning clean.

Rust started to do something different from C.

KBUILD_HOSTCFLAGS is not affected by any CONFIG option.

The reason is because HOSTCC is needed for building Kconfig. If the flags for HOSTCC is changed by a CONFIG option, it would be a chicken-egg problem.
Also, some host programs might be compiled even without .config at all. (e.g. scripts/unifdef)

I know Rust will not become a part of the core infrastructure of the build system, but IMHO, host programs should not be affected by any CONFIG option.

I do not like this patch.

Quoted 52 lines

In particular, this affects targets in rust/ (RUSTDOC H, RUSTC TL, RUSTDOC T, RUSTC T and RUSTC P), plus host programs and any others we may add later.

---
This one requires the rusttest warning cleanup at
https://lore.kernel.org/rust-for-linux/[email protected]/

 Makefile                   | 4 ++--
 scripts/Makefile.extrawarn | 4 ++--
 2 files changed, 4 insertions(+), 4 deletions(-)
Makefile +2 -2
index fba567a55607..2d0ea441cb9c 100644
@@ -469,7 +469,7 @@ export rust_common_flags := --edition=2021 \
 
 KBUILD_HOSTCFLAGS   := $(KBUILD_USERHOSTCFLAGS) $(HOST_LFS_CFLAGS) $(HOSTCFLAGS)
 KBUILD_HOSTCXXFLAGS := -Wall -O2 $(HOST_LFS_CFLAGS) $(HOSTCXXFLAGS)
-KBUILD_HOSTRUSTFLAGS := $(rust_common_flags) -O -Cstrip=debuginfo \
+KBUILD_HOSTRUSTFLAGS = $(rust_common_flags) -O -Cstrip=debuginfo \
                        -Zallow-features= $(HOSTRUSTFLAGS)
 KBUILD_HOSTLDFLAGS  := $(HOST_LFS_LDFLAGS) $(HOSTLDFLAGS)
 KBUILD_HOSTLDLIBS   := $(HOST_LFS_LIBS) $(HOSTLDLIBS)
@@ -560,7 +560,7 @@ KBUILD_CFLAGS += -fno-PIE
 KBUILD_CFLAGS += -fno-strict-aliasing
 
 KBUILD_CPPFLAGS := -D__KERNEL__
-KBUILD_RUSTFLAGS := $(rust_common_flags) \
+KBUILD_RUSTFLAGS = $(rust_common_flags) \
                    -Cpanic=abort -Cembed-bitcode=n -Clto=n \
                    -Cforce-unwind-tables=n -Ccodegen-units=1 \
                    -Csymbol-mangling-version=v0 \
scripts/Makefile.extrawarn +2 -3
index 48114e91c386..990890821889 100644
@@ -26,8 +26,8 @@ endif
 
 KBUILD_CPPFLAGS-$(CONFIG_WERROR) += -Werror
 KBUILD_CPPFLAGS += $(KBUILD_CPPFLAGS-y)
-KBUILD_RUSTFLAGS-$(CONFIG_WERROR) += -Dwarnings
-KBUILD_RUSTFLAGS += $(KBUILD_RUSTFLAGS-y)
+rust_common_flags-$(CONFIG_WERROR) += -Dwarnings
+rust_common_flags += $(rust_common_flags-y)
 
 KBUILD_CFLAGS-$(CONFIG_CC_NO_ARRAY_BOUNDS) += -Wno-array-bounds
 
--
Quoted 1 line

2.45.1

--
Best Regards

Masahiro Yamada

#4 lore raw

Re: [PATCH 2/3] kbuild: rust: apply `CONFIG_WERROR` to all Rust targets

Quoted 11 lines · Masahiro Yamada

Rust started to do something different from C.

KBUILD_HOSTCFLAGS is not affected by any CONFIG option.

The reason is because HOSTCC is needed for building Kconfig. If the flags for HOSTCC is changed by a CONFIG option, it would be a chicken-egg problem.
Also, some host programs might be compiled even without .config at all. (e.g. scripts/unifdef)

Quoted 5 lines

I know Rust will not become a part of the core infrastructure of the build system, but IMHO, host programs should not be affected by any CONFIG option.

I do not like this patch.

Thanks Masahiro -- yeah, I can see how it makes sense for C host programs, and consistency with those may be best, even if it is not used for core infrastructure in the case of Rust.

Do you think it would be OK if we do it only for everything else, i.e. no host programs? That covers most of the Rust things so far and would have helped with the warning I linked above (which is why I would like to change this -- one can pass the flag manually, of course, but having more targets affected by CONFIG_WERROR means more developers will have it enabled and thus notice earlier).

(I am also thinking whether it could make sense to eventually explicitly mark the C host programs that would be exempt from CONFIG_WERROR so that we could apply it to everything else -- I guess it could be easy to get wrong and/or forget when new ones are added.)

Cheers,
Miguel

#5 lore raw

Re: [PATCH 2/3] kbuild: rust: apply `CONFIG_WERROR` to all Rust targets

Quoted 17 lines · Miguel Ojeda
Quoted 15 lines · Masahiro Yamada

Rust started to do something different from C.

KBUILD_HOSTCFLAGS is not affected by any CONFIG option.

The reason is because HOSTCC is needed for building Kconfig. If the flags for HOSTCC is changed by a CONFIG option, it would be a chicken-egg problem.
Also, some host programs might be compiled even without .config at all. (e.g. scripts/unifdef)

I know Rust will not become a part of the core infrastructure of the build system, but IMHO, host programs should not be affected by any CONFIG option.

Quoted 8 lines
Quoted 1 line

I do not like this patch.

Thanks Masahiro -- yeah, I can see how it makes sense for C host programs, and consistency with those may be best, even if it is not used for core infrastructure in the case of Rust.

Do you think it would be OK if we do it only for everything else, i.e. no host programs?

What does "everything else" mean exactly?

I just noticed that $(rust_common_flags) is passed not only to RUSTC but also to RUSTDOC.

It seems to be intentional because it explicitly says "requires kernel .config".

@echo ' rustdoc - Generate Rust documentation'
@echo ' (requires kernel .config)'

This is different from how other "make htmldocs" etc. work.

Why is the .config required for generating documentation?

Quoted 14 lines

That covers most of the Rust things so far and would
have helped with the warning I linked above (which is why I would like to change this -- one can pass the flag manually, of course, but having more targets affected by CONFIG_WERROR means more developers will have it enabled and thus notice earlier).

(I am also thinking whether it could make sense to eventually explicitly mark the C host programs that would be exempt from CONFIG_WERROR so that we could apply it to everything else -- I guess it could be easy to get wrong and/or forget when new ones are added.)

Cheers,
Miguel

Signature · 2 lines
Best Regards
Masahiro Yamada
#6 lore raw

Re: [PATCH 2/3] kbuild: rust: apply `CONFIG_WERROR` to all Rust targets

Quoted 2 lines · Masahiro Yamada

What does "everything else" mean exactly?

Everything but the host programs. Or as many targets as possible, if you think there are other cases that we should avoid.

Quoted 1 line

Why is the .config required for generating documentation?

rustdoc sees the code in a similar way as the compiler (it uses parts of the compiler); in particular, it processes conditional compilation like the compiler. So we need a given configuration to generate it.

Cheers,
Miguel

#7 lore raw

Re: [PATCH 2/3] kbuild: rust: apply `CONFIG_WERROR` to all Rust targets

Quoted 7 lines · Miguel Ojeda
Quoted 2 lines · Masahiro Yamada

What does "everything else" mean exactly?

Everything but the host programs. Or as many targets as possible, if you think there are other cases that we should avoid.

You can do this if rebuilding makes sense
when any CONFIG option is changed.

Quoted 6 lines
Quoted 1 line

Why is the .config required for generating documentation?

rustdoc sees the code in a similar way as the compiler (it uses parts of the compiler); in particular, it processes conditional compilation like the compiler. So we need a given configuration to generate it.

Surprising.

It potentially generates different documentations
depending on the .config file.

Signature · 2 lines
Best Regards
Masahiro Yamada
#8 lore raw

Re: [PATCH 2/3] kbuild: rust: apply `CONFIG_WERROR` to all Rust targets

Quoted 5 lines · Masahiro Yamada
Quoted 3 lines · Miguel Ojeda
Quoted 1 line · Masahiro Yamada
Quoted 8 lines
Quoted 4 lines
Quoted 1 line

What does "everything else" mean exactly?

Everything but the host programs. Or as many targets as possible, if you think there are other cases that we should avoid.

You can do this if rebuilding makes sense
when any CONFIG option is changed.

Not having the ability to make builds fail when clippy or rustdoc is issuing warnings is a big problem. I would very much like to have the option to make builds fail when these targets give warnings.

@Miguel: Should I look into exempting host programs, or do you already have an idea of how to implement?

Regarding host programs, it would be nice to set werror for those. How does C do this? Is W=e enough?

Best regards,
Andreas Hindborg

#9 lore raw

Re: [PATCH 2/3] kbuild: rust: apply `CONFIG_WERROR` to all Rust targets

Quoted 3 lines · Andreas Hindborg

@Miguel: Should I look into exempting host programs, or do you already have an idea of how to implement?

I will send a v2. I may take the chance to already apply the first patch into rust-next, since that could go in already.

Quoted 2 lines

Regarding host programs, it would be nice to set werror for those. How does C do this? Is W=e enough?

Neither CONFIG_WERROR nor W=e apply to C host programs.

However, you may already do:

make ... HOSTCFLAGS=-Werror

And for Rust:

make ... HOSTRUSTFLAGS=-Dwarnings

I could perhaps add that into the docs.

I hope that helps, and thanks for the tags!

Cheers,
Miguel

reviewer Reviewed-by Tested-by on v1 2/3
#10 lore raw

Re: [PATCH 2/3] kbuild: rust: apply `CONFIG_WERROR` to all Rust targets

In reply to Miguel Ojeda
Quoted 8 lines · Miguel Ojeda

Make all Rust code (i.e. not just kernel code) respect CONFIG_WERROR, so that we keep everything warning clean.

In particular, this affects targets in rust/ (RUSTDOC H, RUSTC TL, RUSTDOC T, RUSTC T and RUSTC P), plus host programs and any others we may add later.

Best regards,
Andreas Hindborg

author maintainer
#11 lore raw

PATCH 3/3 kbuild: rust: support `W=e` for Rust

In reply to Miguel Ojeda

With W=e, kernel C targets error out on warnings.

Add support for the same feature for Rust code, but take the opportunity to apply it for every Rust target (i.e. not just kernel code), so that it behaves like having set CONFIG_WERROR.

---
 scripts/Makefile.extrawarn | 1 +
 1 file changed, 1 insertion(+)
scripts/Makefile.extrawarn +1 -0
index 990890821889..214b5edce4f2 100644
@@ -206,5 +206,6 @@ endif
 ifneq ($(findstring e, $(KBUILD_EXTRA_WARN)),)
 
 KBUILD_CFLAGS += -Werror
+rust_common_flags += -Dwarnings
 
 endif
Signature · 1 line
2.45.1
reviewer Reviewed-by on v1 3/3
#12 lore raw

Re: [PATCH 3/3] kbuild: rust: support `W=e` for Rust

Quoted 8 lines · Miguel Ojeda

With W=e, kernel C targets error out on warnings.

Add support for the same feature for Rust code, but take the opportunity to apply it for every Rust target (i.e. not just kernel code), so that it behaves like having set CONFIG_WERROR.

reviewer Reviewed-by Tested-by on v1 3/3
#13 lore raw

Re: [PATCH 3/3] kbuild: rust: support `W=e` for Rust

In reply to Miguel Ojeda
Quoted 7 lines · Miguel Ojeda

With W=e, kernel C targets error out on warnings.

Add support for the same feature for Rust code, but take the opportunity to apply it for every Rust target (i.e. not just kernel code), so that it behaves like having set CONFIG_WERROR.

Best regards,
Andreas Hindborg