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