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