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