xref: /linux-6.15/tools/build/Makefile.feature (revision b40fbeb0) 
1# SPDX-License-Identifier: GPL-2.0-only
2feature_dir := $(srctree)/tools/build/feature
3
4ifneq ($(OUTPUT),)
5  OUTPUT_FEATURES = $(OUTPUT)feature/
6  $(shell mkdir -p $(OUTPUT_FEATURES))
7endif
8
9feature_check = $(eval $(feature_check_code))
10define feature_check_code
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)
12endef
13
14feature_set = $(eval $(feature_set_code))
15define feature_set_code
16  feature-$(1) := 1
17endef
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#
31FEATURE_TESTS_BASIC :=                  \
32        backtrace                       \
33        libdw                           \
34        eventfd                         \
35        fortify-source                  \
36        get_current_dir_name            \
37        gettid				\
38        glibc                           \
39        libbfd                          \
40        libbfd-buildid			\
41        libcap                          \
42        libelf                          \
43        libelf-getphdrnum               \
44        libelf-gelf_getnote             \
45        libelf-getshdrstrndx            \
46        libnuma                         \
47        numa_num_possible_cpus          \
48        libperl                         \
49        libpython                       \
50        libslang                        \
51        libslang-include-subdir         \
52        libtraceevent                   \
53        libtracefs                      \
54        libcpupower                     \
55        libcrypto                       \
56        libunwind                       \
57        pthread-attr-setaffinity-np     \
58        pthread-barrier     		\
59        reallocarray                    \
60        stackprotector-all              \
61        timerfd                         \
62        zlib                            \
63        lzma                            \
64        get_cpuid                       \
65        bpf                             \
66        scandirat			\
67        sched_getcpu			\
68        sdt				\
69        setns				\
70        libaio				\
71        libzstd				\
72        disassembler-four-args		\
73        disassembler-init-styled	\
74        file-handle
75
76# FEATURE_TESTS_BASIC + FEATURE_TESTS_EXTRA is the complete list
77# of all feature tests
78FEATURE_TESTS_EXTRA :=                  \
79         bionic                         \
80         compile-32                     \
81         compile-x32                    \
82         cplus-demangle                 \
83         cxa-demangle                   \
84         gtk2                           \
85         gtk2-infobar                   \
86         hello                          \
87         libbabeltrace                  \
88         libcapstone                    \
89         libbfd-liberty                 \
90         libbfd-liberty-z               \
91         libopencsd                     \
92         cxx                            \
93         llvm                           \
94         clang                          \
95         libbpf                         \
96         libbpf-btf__load_from_kernel_by_id \
97         libbpf-bpf_prog_load           \
98         libbpf-bpf_object__next_program \
99         libbpf-bpf_object__next_map    \
100         libbpf-bpf_program__set_insns  \
101         libbpf-bpf_create_map		\
102         libpfm4                        \
103         libdebuginfod			\
104         clang-bpf-co-re
105
106
107FEATURE_TESTS ?= $(FEATURE_TESTS_BASIC)
108
109ifeq ($(FEATURE_TESTS),all)
110  FEATURE_TESTS := $(FEATURE_TESTS_BASIC) $(FEATURE_TESTS_EXTRA)
111endif
112
113FEATURE_DISPLAY ?=              \
114         libdw                  \
115         glibc                  \
116         libbfd                 \
117         libbfd-buildid		\
118         libcap                 \
119         libelf                 \
120         libnuma                \
121         numa_num_possible_cpus \
122         libperl                \
123         libpython              \
124         libcrypto              \
125         libunwind              \
126         libcapstone            \
127         llvm-perf              \
128         zlib                   \
129         lzma                   \
130         get_cpuid              \
131         bpf			\
132         libaio			\
133         libzstd
134
135#
136# Declare group members of a feature to display the logical OR of the detection
137# result instead of each member result.
138#
139FEATURE_GROUP_MEMBERS-libbfd = libbfd-liberty libbfd-liberty-z
140
141#
142# Declare list of feature dependency packages that provide pkg-config files.
143#
144FEATURE_PKG_CONFIG ?=           \
145         libtraceevent          \
146         libtracefs
147
148feature_pkg_config = $(eval $(feature_pkg_config_code))
149define feature_pkg_config_code
150  FEATURE_CHECK_CFLAGS-$(1) := $(shell $(PKG_CONFIG) --cflags $(1) 2>/dev/null)
151  FEATURE_CHECK_LDFLAGS-$(1) := $(shell $(PKG_CONFIG) --libs $(1) 2>/dev/null)
152endef
153
154# Set FEATURE_CHECK_(C|LD)FLAGS-$(package) for packages using pkg-config.
155ifneq ($(PKG_CONFIG),)
156  $(foreach package,$(FEATURE_PKG_CONFIG),$(call feature_pkg_config,$(package)))
157endif
158
159# Set FEATURE_CHECK_(C|LD)FLAGS-all for all FEATURE_TESTS features.
160# If in the future we need per-feature checks/flags for features not
161# mentioned in this list we need to refactor this ;-).
162set_test_all_flags = $(eval $(set_test_all_flags_code))
163define set_test_all_flags_code
164  FEATURE_CHECK_CFLAGS-all  += $(FEATURE_CHECK_CFLAGS-$(1))
165  FEATURE_CHECK_LDFLAGS-all += $(FEATURE_CHECK_LDFLAGS-$(1))
166endef
167
168$(foreach feat,$(FEATURE_TESTS),$(call set_test_all_flags,$(feat)))
169
170#
171# Special fast-path for the 'all features are available' case:
172#
173$(call feature_check,all,$(MSG))
174
175#
176# Just in case the build freshly failed, make sure we print the
177# feature matrix:
178#
179ifeq ($(feature-all), 1)
180  #
181  # test-all.c passed - just set all the core feature flags to 1:
182  #
183  $(foreach feat,$(FEATURE_TESTS),$(call feature_set,$(feat)))
184  #
185  # test-all.c does not comprise these tests, so we need to
186  # for this case to get features proper values
187  #
188  $(call feature_check,compile-32)
189  $(call feature_check,compile-x32)
190  $(call feature_check,bionic)
191  $(call feature_check,libbabeltrace)
192else
193  $(foreach feat,$(FEATURE_TESTS),$(call feature_check,$(feat)))
194endif
195
196#
197# Print the result of the feature test:
198#
199feature_print_status = $(eval $(feature_print_status_code))
200
201feature_group = $(eval $(feature_gen_group)) $(GROUP)
202
203define feature_gen_group
204  GROUP := $(1)
205  ifneq ($(feature_verbose),1)
206    GROUP += $(FEATURE_GROUP_MEMBERS-$(1))
207  endif
208endef
209
210define feature_print_status_code
211  ifneq (,$(filter 1,$(foreach feat,$(call feature_group,$(feat)),$(feature-$(feat)))))
212    MSG = $(shell printf '...%40s: [ \033[32mon\033[m  ]' $(1))
213  else
214    MSG = $(shell printf '...%40s: [ \033[31mOFF\033[m ]' $(1))
215  endif
216endef
217
218feature_print_text = $(eval $(feature_print_text_code))
219define feature_print_text_code
220    MSG = $(shell printf '...%40s: %s' $(1) $(2))
221endef
222
223#
224# generates feature value assignment for name, like:
225#   $(call feature_assign,libdw) == feature-libdw=1
226#
227feature_assign = feature-$(1)=$(feature-$(1))
228
229FEATURE_DUMP_FILENAME = $(OUTPUT)FEATURE-DUMP$(FEATURE_USER)
230FEATURE_DUMP := $(shell touch $(FEATURE_DUMP_FILENAME); cat $(FEATURE_DUMP_FILENAME))
231
232feature_dump_check = $(eval $(feature_dump_check_code))
233define feature_dump_check_code
234  ifeq ($(findstring $(1),$(FEATURE_DUMP)),)
235    $(2) := 1
236  endif
237endef
238
239#
240# First check if any test from FEATURE_DISPLAY
241# and set feature_display := 1 if it does
242$(foreach feat,$(FEATURE_DISPLAY),$(call feature_dump_check,$(call feature_assign,$(feat)),feature_display))
243
244#
245# Now also check if any other test changed,
246# so we force FEATURE-DUMP generation
247$(foreach feat,$(FEATURE_TESTS),$(call feature_dump_check,$(call feature_assign,$(feat)),feature_dump_changed))
248
249# The $(feature_display) controls the default detection message
250# output. It's set if:
251# - detected features differes from stored features from
252#   last build (in $(FEATURE_DUMP_FILENAME) file)
253# - one of the $(FEATURE_DISPLAY) is not detected
254# - VF is enabled
255
256ifeq ($(feature_dump_changed),1)
257  $(shell rm -f $(FEATURE_DUMP_FILENAME))
258  $(foreach feat,$(FEATURE_TESTS),$(shell echo "$(call feature_assign,$(feat))" >> $(FEATURE_DUMP_FILENAME)))
259endif
260
261feature_display_check = $(eval $(feature_check_display_code))
262define feature_check_display_code
263  ifneq ($(feature-$(1)), 1)
264    feature_display := 1
265  endif
266endef
267
268$(foreach feat,$(FEATURE_DISPLAY),$(call feature_display_check,$(feat)))
269
270ifeq ($(VF),1)
271  feature_display := 1
272  feature_verbose := 1
273endif
274
275ifneq ($(feature_verbose),1)
276  #
277  # Determine the features to omit from the displayed message, as only the
278  # logical OR of the detection result will be shown.
279  #
280  FEATURE_OMIT := $(foreach feat,$(FEATURE_DISPLAY),$(FEATURE_GROUP_MEMBERS-$(feat)))
281endif
282
283feature_display_entries = $(eval $(feature_display_entries_code))
284define feature_display_entries_code
285  ifeq ($(feature_display),1)
286    $$(info )
287    $$(info Auto-detecting system features:)
288    $(foreach feat,$(filter-out $(FEATURE_OMIT),$(FEATURE_DISPLAY)),$(call feature_print_status,$(feat),) $$(info $(MSG)))
289  endif
290
291  ifeq ($(feature_verbose),1)
292    $(eval TMP := $(filter-out $(FEATURE_DISPLAY),$(FEATURE_TESTS)))
293    $(foreach feat,$(TMP),$(call feature_print_status,$(feat),) $$(info $(MSG)))
294  endif
295endef
296
297ifeq ($(FEATURE_DISPLAY_DEFERRED),)
298  $(call feature_display_entries)
299  $(info )
300endif
301