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