From 461c33b226da241fdb5944f42cccd60fe9918621 Mon Sep 17 00:00:00 2001 From: Martin Roth Date: Tue, 27 Sep 2022 18:13:48 -0600 Subject: coreboot: Add support for include-what-you-use The tool "include-what-you-use" analyzes each file's headers and makes recommendations for header files to add and remove. There are additional scripts as part of the package that will make these changes directly based on the recommendations, but due to the way coreboot compiles code in/out base on Kconfig options, this isn't really safe for the project to use. It is a good starting point though. To use, set the IWYU kconfig option, then build with the command: make -k Because this doesn't actually build any files, the -k option is needed or make will stop after looking at the first file. Signed-off-by: Martin Roth Change-Id: I084813f21a3c26cac1e4e134bf8a83eb8637ff63 Reviewed-on: https://review.coreboot.org/c/coreboot/+/67915 Tested-by: build bot (Jenkins) Reviewed-by: Elyes Haouas Reviewed-by: Julius Werner --- src/Kconfig | 6 ++++++ toolchain.inc | 15 +++++++++++++++ 2 files changed, 21 insertions(+) diff --git a/src/Kconfig b/src/Kconfig index 0d3879ecbf..c1afe26e5f 100644 --- a/src/Kconfig +++ b/src/Kconfig @@ -114,6 +114,12 @@ config CCACHE For details see https://ccache.samba.org. +config IWYU + bool "Test platform with include-what-you-use" + help + This runs each source file through the include-what-you-use tool + to check the header includes. + config FMD_GENPARSER bool "Generate flashmap descriptor parser using flex and bison" default n diff --git a/toolchain.inc b/toolchain.inc index 893f7d1a11..47c5fe9b85 100644 --- a/toolchain.inc +++ b/toolchain.inc @@ -32,6 +32,21 @@ HOSTCC:=CCC_CC="$(HOSTCC)" $(CC) HOSTCXX:=CCC_CXX="$(HOSTCXX)" $(CXX) endif +# include-what-you-use integration +ifeq ($(CONFIG_IWYU),y) + +IWYU:=$(word 1,$(wildcard $(addsuffix /iwyu,$(subst :, ,$(PATH))))) +ifeq ($(IWYU),) +$(error include-what-you-use selected, but not found in PATH) +endif + +$(foreach arch,$(ARCH_SUPPORTED), \ + $(eval CC_$(arch):=$(IWYU) )) + +CFLAGS_common := -Xiwyu --prefix_header_includes=remove -Xiwyu --no_comments -Xiwyu --no_fwd_decls $(CFLAGS_common) +NOCOMPILE := 1 +endif + COREBOOT_STANDARD_STAGES := decompressor bootblock verstage romstage ramstage MAP-decompressor := bootblock -- cgit v1.2.3