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