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