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