[linux-block.git] / tools / build / Makefile.feature

# SPDX-License-Identifier: GPL-2.0-only
feature_dir := $(srctree)/tools/build/feature

ifneq ($(OUTPUT),)
  OUTPUT_FEATURES = $(OUTPUT)feature/
  $(shell mkdir -p $(OUTPUT_FEATURES))
endif

feature_check = $(eval $(feature_check_code))
define feature_check_code
  feature-$(1) := $(shell $(MAKE) OUTPUT=$(OUTPUT_FEATURES) CC="$(CC)" CXX="$(CXX)" CFLAGS="$(EXTRA_CFLAGS) $(FEATURE_CHECK_CFLAGS-$(1))" CXXFLAGS="$(EXTRA_CXXFLAGS) $(FEATURE_CHECK_CXXFLAGS-$(1))" LDFLAGS="$(LDFLAGS) $(FEATURE_CHECK_LDFLAGS-$(1))" -C $(feature_dir) $(OUTPUT_FEATURES)test-$1.bin >/dev/null 2>/dev/null && echo 1 || echo 0)
endef

feature_set = $(eval $(feature_set_code))
define feature_set_code
  feature-$(1) := 1
endef

#
# Build the feature check binaries in parallel, ignore errors, ignore return value and suppress output:
#

#
# Note that this is not a complete list of all feature tests, just
# those that are typically built on a fully configured system.
#
# [ Feature tests not mentioned here have to be built explicitly in
#   the rule that uses them - an example for that is the 'bionic'
#   feature check. ]
#
FEATURE_TESTS_BASIC :=                  \
        backtrace                       \
        dwarf                           \
        dwarf_getlocations              \
        eventfd                         \
        fortify-source                  \
        get_current_dir_name            \
        gettid				\
        glibc                           \
        libbfd                          \
        libbfd-buildid			\
        libcap                          \
        libelf                          \
        libelf-getphdrnum               \
        libelf-gelf_getnote             \
        libelf-getshdrstrndx            \
        libnuma                         \
        numa_num_possible_cpus          \
        libperl                         \
        libpython                       \
        libslang                        \
        libslang-include-subdir         \
        libtraceevent                   \
        libtracefs                      \
        libcrypto                       \
        libunwind                       \
        pthread-attr-setaffinity-np     \
        pthread-barrier     		\
        reallocarray                    \
        stackprotector-all              \
        timerfd                         \
        libdw-dwarf-unwind              \
        zlib                            \
        lzma                            \
        get_cpuid                       \
        bpf                             \
        sched_getcpu			\
        sdt				\
        setns				\
        libaio				\
        libzstd				\
        disassembler-four-args		\
        disassembler-init-styled	\
        file-handle

# FEATURE_TESTS_BASIC + FEATURE_TESTS_EXTRA is the complete list
# of all feature tests
FEATURE_TESTS_EXTRA :=                  \
         bionic                         \
         compile-32                     \
         compile-x32                    \
         cplus-demangle                 \
         cxa-demangle                   \
         gtk2                           \
         gtk2-infobar                   \
         hello                          \
         libbabeltrace                  \
         libbfd-liberty                 \
         libbfd-liberty-z               \
         libopencsd                     \
         libunwind-x86                  \
         libunwind-x86_64               \
         libunwind-arm                  \
         libunwind-aarch64              \
         libunwind-debug-frame          \
         libunwind-debug-frame-arm      \
         libunwind-debug-frame-aarch64  \
         cxx                            \
         llvm                           \
         llvm-version                   \
         clang                          \
         libbpf                         \
         libbpf-btf__load_from_kernel_by_id \
         libbpf-bpf_prog_load           \
         libbpf-bpf_object__next_program \
         libbpf-bpf_object__next_map    \
         libbpf-bpf_program__set_insns  \
         libbpf-bpf_create_map		\
         libpfm4                        \
         libdebuginfod			\
         clang-bpf-co-re


FEATURE_TESTS ?= $(FEATURE_TESTS_BASIC)

ifeq ($(FEATURE_TESTS),all)
  FEATURE_TESTS := $(FEATURE_TESTS_BASIC) $(FEATURE_TESTS_EXTRA)
endif

FEATURE_DISPLAY ?=              \
         dwarf                  \
         dwarf_getlocations     \
         glibc                  \
         libbfd                 \
         libbfd-buildid		\
         libcap                 \
         libelf                 \
         libnuma                \
         numa_num_possible_cpus \
         libperl                \
         libpython              \
         libcrypto              \
         libunwind              \
         libdw-dwarf-unwind     \
         zlib                   \
         lzma                   \
         get_cpuid              \
         bpf			\
         libaio			\
         libzstd

#
# Declare group members of a feature to display the logical OR of the detection
# result instead of each member result.
#
FEATURE_GROUP_MEMBERS-libbfd = libbfd-liberty libbfd-liberty-z

# Set FEATURE_CHECK_(C|LD)FLAGS-all for all FEATURE_TESTS features.
# If in the future we need per-feature checks/flags for features not
# mentioned in this list we need to refactor this ;-).
set_test_all_flags = $(eval $(set_test_all_flags_code))
define set_test_all_flags_code
  FEATURE_CHECK_CFLAGS-all  += $(FEATURE_CHECK_CFLAGS-$(1))
  FEATURE_CHECK_LDFLAGS-all += $(FEATURE_CHECK_LDFLAGS-$(1))
endef

$(foreach feat,$(FEATURE_TESTS),$(call set_test_all_flags,$(feat)))

#
# Special fast-path for the 'all features are available' case:
#
$(call feature_check,all,$(MSG))

#
# Just in case the build freshly failed, make sure we print the
# feature matrix:
#
ifeq ($(feature-all), 1)
  #
  # test-all.c passed - just set all the core feature flags to 1:
  #
  $(foreach feat,$(FEATURE_TESTS),$(call feature_set,$(feat)))
  #
  # test-all.c does not comprise these tests, so we need to
  # for this case to get features proper values
  #
  $(call feature_check,compile-32)
  $(call feature_check,compile-x32)
  $(call feature_check,bionic)
  $(call feature_check,libbabeltrace)
else
  $(foreach feat,$(FEATURE_TESTS),$(call feature_check,$(feat)))
endif

#
# Print the result of the feature test:
#
feature_print_status = $(eval $(feature_print_status_code))

feature_group = $(eval $(feature_gen_group)) $(GROUP)

define feature_gen_group
  GROUP := $(1)
  ifneq ($(feature_verbose),1)
    GROUP += $(FEATURE_GROUP_MEMBERS-$(1))
  endif
endef

define feature_print_status_code
  ifneq (,$(filter 1,$(foreach feat,$(call feature_group,$(feat)),$(feature-$(feat)))))
    MSG = $(shell printf '...%40s: [ \033[32mon\033[m  ]' $(1))
  else
    MSG = $(shell printf '...%40s: [ \033[31mOFF\033[m ]' $(1))
  endif
endef

feature_print_text = $(eval $(feature_print_text_code))
define feature_print_text_code
    MSG = $(shell printf '...%40s: %s' $(1) $(2))
endef

#
# generates feature value assignment for name, like:
#   $(call feature_assign,dwarf) == feature-dwarf=1
#
feature_assign = feature-$(1)=$(feature-$(1))

FEATURE_DUMP_FILENAME = $(OUTPUT)FEATURE-DUMP$(FEATURE_USER)
FEATURE_DUMP := $(shell touch $(FEATURE_DUMP_FILENAME); cat $(FEATURE_DUMP_FILENAME))

feature_dump_check = $(eval $(feature_dump_check_code))
define feature_dump_check_code
  ifeq ($(findstring $(1),$(FEATURE_DUMP)),)
    $(2) := 1
  endif
endef

#
# First check if any test from FEATURE_DISPLAY
# and set feature_display := 1 if it does
$(foreach feat,$(FEATURE_DISPLAY),$(call feature_dump_check,$(call feature_assign,$(feat)),feature_display))

#
# Now also check if any other test changed,
# so we force FEATURE-DUMP generation
$(foreach feat,$(FEATURE_TESTS),$(call feature_dump_check,$(call feature_assign,$(feat)),feature_dump_changed))

# The $(feature_display) controls the default detection message
# output. It's set if:
# - detected features differes from stored features from
#   last build (in $(FEATURE_DUMP_FILENAME) file)
# - one of the $(FEATURE_DISPLAY) is not detected
# - VF is enabled

ifeq ($(feature_dump_changed),1)
  $(shell rm -f $(FEATURE_DUMP_FILENAME))
  $(foreach feat,$(FEATURE_TESTS),$(shell echo "$(call feature_assign,$(feat))" >> $(FEATURE_DUMP_FILENAME)))
endif

feature_display_check = $(eval $(feature_check_display_code))
define feature_check_display_code
  ifneq ($(feature-$(1)), 1)
    feature_display := 1
  endif
endef

$(foreach feat,$(FEATURE_DISPLAY),$(call feature_display_check,$(feat)))

ifeq ($(VF),1)
  feature_display := 1
  feature_verbose := 1
endif

ifneq ($(feature_verbose),1)
  #
  # Determine the features to omit from the displayed message, as only the
  # logical OR of the detection result will be shown.
  #
  FEATURE_OMIT := $(foreach feat,$(FEATURE_DISPLAY),$(FEATURE_GROUP_MEMBERS-$(feat)))
endif

feature_display_entries = $(eval $(feature_display_entries_code))
define feature_display_entries_code
  ifeq ($(feature_display),1)
    $$(info )
    $$(info Auto-detecting system features:)
    $(foreach feat,$(filter-out $(FEATURE_OMIT),$(FEATURE_DISPLAY)),$(call feature_print_status,$(feat),) $$(info $(MSG)))
  endif

  ifeq ($(feature_verbose),1)
    $(eval TMP := $(filter-out $(FEATURE_DISPLAY),$(FEATURE_TESTS)))
    $(foreach feat,$(TMP),$(call feature_print_status,$(feat),) $$(info $(MSG)))
  endif
endef

ifeq ($(FEATURE_DISPLAY_DEFERRED),)
  $(call feature_display_entries)
  $(info )
endif
Commit	Line	Data
ec8f24b7	1	# SPDX-License-Identifier: GPL-2.0-only
e6c76d62	2	feature_dir := $(srctree)/tools/build/feature
970e87b3	3
0afc5cad	4	ifneq ($(OUTPUT),)
e6c76d62	5	OUTPUT_FEATURES = $(OUTPUT)feature/
0afc5cad JO	6	$(shell mkdir -p $(OUTPUT_FEATURES))
	7	endif
	8
	9	feature_check = $(eval $(feature_check_code))
	10	define feature_check_code
fa5c8931	11	feature-$(1) := $(shell $(MAKE) OUTPUT=$(OUTPUT_FEATURES) CC="$(CC)" CXX="$(CXX)" CFLAGS="$(EXTRA_CFLAGS) $(FEATURE_CHECK_CFLAGS-$(1))" CXXFLAGS="$(EXTRA_CXXFLAGS) $(FEATURE_CHECK_CXXFLAGS-$(1))" LDFLAGS="$(LDFLAGS) $(FEATURE_CHECK_LDFLAGS-$(1))" -C $(feature_dir) $(OUTPUT_FEATURES)test-$1.bin >/dev/null 2>/dev/null && echo 1 \|\| echo 0)
0afc5cad JO	12	endef
	13
	14	feature_set = $(eval $(feature_set_code))
	15	define feature_set_code
	16	feature-$(1) := 1
	17	endef
	18
	19	#
	20	# Build the feature check binaries in parallel, ignore errors, ignore return value and suppress output:
	21	#
	22
	23	#
	24	# Note that this is not a complete list of all feature tests, just
	25	# those that are typically built on a fully configured system.
	26	#
	27	# [ Feature tests not mentioned here have to be built explicitly in
	28	# the rule that uses them - an example for that is the 'bionic'
	29	# feature check. ]
	30	#
2fedf79b JO	31	FEATURE_TESTS_BASIC := \
	32	backtrace \
	33	dwarf \
	34	dwarf_getlocations \
11c6cbe7	35	eventfd \
2fedf79b	36	fortify-source \
8feb8efe	37	get_current_dir_name \
4541a8bb	38	gettid \
2fedf79b	39	glibc \
2fedf79b	40	libbfd \
e71e19a9	41	libbfd-buildid \
74d5f3d0	42	libcap \
2fedf79b JO	43	libelf \
	44	libelf-getphdrnum \
	45	libelf-gelf_getnote \
	46	libelf-getshdrstrndx \
2fedf79b JO	47	libnuma \
	48	numa_num_possible_cpus \
	49	libperl \
	50	libpython \
2fedf79b	51	libslang \
cbefd24f	52	libslang-include-subdir \
56d32d4c	53	libtraceevent \
b758a61b	54	libtracefs \
2fedf79b JO	55	libcrypto \
2fedf79b JO	56	libunwind \
2fedf79b	57	pthread-attr-setaffinity-np \
25ab5abf	58	pthread-barrier \
db42a21a	59	reallocarray \
2fedf79b JO	60	stackprotector-all \
	61	timerfd \
	62	libdw-dwarf-unwind \
	63	zlib \
	64	lzma \
	65	get_cpuid \
	66	bpf \
120010cb	67	sched_getcpu \
86bcdb5a	68	sdt \
aa6292f4	69	setns \
8a1b1718	70	libaio \
3b1c5d96	71	libzstd \
49f550ea	72	disassembler-four-args \
cfd59ca9	73	disassembler-init-styled \
49f550ea	74	file-handle
0afc5cad	75
9fd4186a WN	76	# FEATURE_TESTS_BASIC + FEATURE_TESTS_EXTRA is the complete list
9fd4186a WN	77	# of all feature tests
2fedf79b JO	78	FEATURE_TESTS_EXTRA := \
	79	bionic \
	80	compile-32 \
	81	compile-x32 \
	82	cplus-demangle \
4c72e2b3	83	cxa-demangle \
4751bddd ACM	84	gtk2 \
4751bddd ACM	85	gtk2-infobar \
2fedf79b JO	86	hello \
2fedf79b JO	87	libbabeltrace \
14541b1e SF	88	libbfd-liberty \
14541b1e SF	89	libbfd-liberty-z \
1c3b28fd	90	libopencsd \
5c4d7c82 ACM	91	libunwind-x86 \
	92	libunwind-x86_64 \
	93	libunwind-arm \
	94	libunwind-aarch64 \
2fedf79b JO	95	libunwind-debug-frame \
2fedf79b JO	96	libunwind-debug-frame-arm \
bd476684 JO	97	libunwind-debug-frame-aarch64 \
	98	cxx \
	99	llvm \
	100	llvm-version \
7b65e203	101	clang \
5ef86146	102	libbpf \
0ae065a5	103	libbpf-btf__load_from_kernel_by_id \
5c83eff3	104	libbpf-bpf_prog_load \
8916d725	105	libbpf-bpf_object__next_program \
739c9180	106	libbpf-bpf_object__next_map \
f1bdebbb	107	libbpf-bpf_program__set_insns \
df76e003	108	libbpf-bpf_create_map \
c7a14fdc	109	libpfm4 \
fbcdaa19 SL	110	libdebuginfod \
	111	clang-bpf-co-re
	112
9fd4186a WN	113
	114	FEATURE_TESTS ?= $(FEATURE_TESTS_BASIC)
	115
	116	ifeq ($(FEATURE_TESTS),all)
	117	FEATURE_TESTS := $(FEATURE_TESTS_BASIC) $(FEATURE_TESTS_EXTRA)
	118	endif
	119
2fedf79b JO	120	FEATURE_DISPLAY ?= \
	121	dwarf \
	122	dwarf_getlocations \
	123	glibc \
2fedf79b	124	libbfd \
e71e19a9	125	libbfd-buildid \
74d5f3d0	126	libcap \
2fedf79b JO	127	libelf \
	128	libnuma \
	129	numa_num_possible_cpus \
	130	libperl \
	131	libpython \
2fedf79b JO	132	libcrypto \
	133	libunwind \
	134	libdw-dwarf-unwind \
	135	zlib \
	136	lzma \
	137	get_cpuid \
2a07d814	138	bpf \
8a1b1718	139	libaio \
516ddaad	140	libzstd
0afc5cad	141
74ef1cc9 RS	142	#
	143	# Declare group members of a feature to display the logical OR of the detection
	144	# result instead of each member result.
	145	#
	146	FEATURE_GROUP_MEMBERS-libbfd = libbfd-liberty libbfd-liberty-z
	147
0afc5cad JO	148	# Set FEATURE_CHECK_(C\|LD)FLAGS-all for all FEATURE_TESTS features.
	149	# If in the future we need per-feature checks/flags for features not
	150	# mentioned in this list we need to refactor this ;-).
	151	set_test_all_flags = $(eval $(set_test_all_flags_code))
	152	define set_test_all_flags_code
	153	FEATURE_CHECK_CFLAGS-all += $(FEATURE_CHECK_CFLAGS-$(1))
	154	FEATURE_CHECK_LDFLAGS-all += $(FEATURE_CHECK_LDFLAGS-$(1))
	155	endef
	156
	157	$(foreach feat,$(FEATURE_TESTS),$(call set_test_all_flags,$(feat)))
	158
	159	#
	160	# Special fast-path for the 'all features are available' case:
	161	#
	162	$(call feature_check,all,$(MSG))
	163
	164	#
	165	# Just in case the build freshly failed, make sure we print the
	166	# feature matrix:
	167	#
	168	ifeq ($(feature-all), 1)
	169	#
	170	# test-all.c passed - just set all the core feature flags to 1:
	171	#
	172	$(foreach feat,$(FEATURE_TESTS),$(call feature_set,$(feat)))
76c4aaec JO	173	#
	174	# test-all.c does not comprise these tests, so we need to
	175	# for this case to get features proper values
	176	#
	177	$(call feature_check,compile-32)
	178	$(call feature_check,compile-x32)
	179	$(call feature_check,bionic)
	180	$(call feature_check,libbabeltrace)
0afc5cad	181	else
0afc5cad JO	182	$(foreach feat,$(FEATURE_TESTS),$(call feature_check,$(feat)))
	183	endif
	184
	185	#
	186	# Print the result of the feature test:
	187	#
709533e5	188	feature_print_status = $(eval $(feature_print_status_code))
0afc5cad	189
74ef1cc9 RS	190	feature_group = $(eval $(feature_gen_group)) $(GROUP)
	191
	192	define feature_gen_group
	193	GROUP := $(1)
	194	ifneq ($(feature_verbose),1)
	195	GROUP += $(FEATURE_GROUP_MEMBERS-$(1))
	196	endif
	197	endef
	198
0afc5cad	199	define feature_print_status_code
74ef1cc9	200	ifneq (,$(filter 1,$(foreach feat,$(call feature_group,$(feat)),$(feature-$(feat)))))
74da7697	201	MSG = $(shell printf '...%40s: [ \033[32mon\033[m ]' $(1))
0afc5cad	202	else
74da7697	203	MSG = $(shell printf '...%40s: [ \033[31mOFF\033[m ]' $(1))
0afc5cad JO	204	endif
	205	endef
	206
709533e5	207	feature_print_text = $(eval $(feature_print_text_code))
0afc5cad	208	define feature_print_text_code
74da7697	209	MSG = $(shell printf '...%40s: %s' $(1) $(2))
0afc5cad JO	210	endef
0afc5cad JO	211
c6a5f88f JO	212	#
	213	# generates feature value assignment for name, like:
	214	# $(call feature_assign,dwarf) == feature-dwarf=1
	215	#
	216	feature_assign = feature-$(1)=$(feature-$(1))
	217
13e96db6	218	FEATURE_DUMP_FILENAME = $(OUTPUT)FEATURE-DUMP$(FEATURE_USER)
936d120d JO	219	FEATURE_DUMP := $(shell touch $(FEATURE_DUMP_FILENAME); cat $(FEATURE_DUMP_FILENAME))
	220
	221	feature_dump_check = $(eval $(feature_dump_check_code))
	222	define feature_dump_check_code
	223	ifeq ($(findstring $(1),$(FEATURE_DUMP)),)
	224	$(2) := 1
	225	endif
	226	endef
	227
	228	#
	229	# First check if any test from FEATURE_DISPLAY
	230	# and set feature_display := 1 if it does
	231	$(foreach feat,$(FEATURE_DISPLAY),$(call feature_dump_check,$(call feature_assign,$(feat)),feature_display))
	232
	233	#
	234	# Now also check if any other test changed,
	235	# so we force FEATURE-DUMP generation
	236	$(foreach feat,$(FEATURE_TESTS),$(call feature_dump_check,$(call feature_assign,$(feat)),feature_dump_changed))
0afc5cad	237
0afc5cad JO	238	# The $(feature_display) controls the default detection message
	239	# output. It's set if:
	240	# - detected features differes from stored features from
13e96db6	241	# last build (in $(FEATURE_DUMP_FILENAME) file)
0afc5cad JO	242	# - one of the $(FEATURE_DISPLAY) is not detected
	243	# - VF is enabled
	244
936d120d JO	245	ifeq ($(feature_dump_changed),1)
	246	$(shell rm -f $(FEATURE_DUMP_FILENAME))
	247	$(foreach feat,$(FEATURE_TESTS),$(shell echo "$(call feature_assign,$(feat))" >> $(FEATURE_DUMP_FILENAME)))
0afc5cad JO	248	endif
0afc5cad JO	249
6076e2a4	250	feature_display_check = $(eval $(feature_check_display_code))
d0018b49	251	define feature_check_display_code
0afc5cad JO	252	ifneq ($(feature-$(1)), 1)
	253	feature_display := 1
	254	endif
	255	endef
	256
	257	$(foreach feat,$(FEATURE_DISPLAY),$(call feature_display_check,$(feat)))
	258
	259	ifeq ($(VF),1)
	260	feature_display := 1
	261	feature_verbose := 1
	262	endif
	263
74ef1cc9 RS	264	ifneq ($(feature_verbose),1)
	265	#
	266	# Determine the features to omit from the displayed message, as only the
	267	# logical OR of the detection result will be shown.
	268	#
	269	FEATURE_OMIT := $(foreach feat,$(FEATURE_DISPLAY),$(FEATURE_GROUP_MEMBERS-$(feat)))
	270	endif
	271
19177bc3 ACM	272	feature_display_entries = $(eval $(feature_display_entries_code))
	273	define feature_display_entries_code
	274	ifeq ($(feature_display),1)
709533e5 RS	275	$$(info )
709533e5 RS	276	$$(info Auto-detecting system features:)
74ef1cc9	277	$(foreach feat,$(filter-out $(FEATURE_OMIT),$(FEATURE_DISPLAY)),$(call feature_print_status,$(feat),) $$(info $(MSG)))
0afc5cad	278	endif
0afc5cad	279
19177bc3	280	ifeq ($(feature_verbose),1)
709533e5 RS	281	$(eval TMP := $(filter-out $(FEATURE_DISPLAY),$(FEATURE_TESTS)))
709533e5 RS	282	$(foreach feat,$(TMP),$(call feature_print_status,$(feat),) $$(info $(MSG)))
19177bc3 ACM	283	endif
	284	endef
	285
	286	ifeq ($(FEATURE_DISPLAY_DEFERRED),)
	287	$(call feature_display_entries)
709533e5	288	$(info )
0afc5cad	289	endif