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