tjh.dev
Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
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 libperl \
84 libpython \
85 libslang \
86 libtraceevent \
87 libtracefs \
88 libcpupower \
89 libcrypto \
90 libunwind \
91 pthread-attr-setaffinity-np \
92 pthread-barrier \
93 reallocarray \
94 stackprotector-all \
95 timerfd \
96 zlib \
97 lzma \
98 get_cpuid \
99 bpf \
100 scandirat \
101 sched_getcpu \
102 sdt \
103 setns \
104 libaio \
105 libzstd \
106 disassembler-four-args \
107 disassembler-init-styled \
108 file-handle
109
110# FEATURE_TESTS_BASIC + FEATURE_TESTS_EXTRA is the complete list
111# of all feature tests
112FEATURE_TESTS_EXTRA := \
113 bionic \
114 compile-32 \
115 compile-x32 \
116 cplus-demangle \
117 cxa-demangle \
118 gtk2 \
119 gtk2-infobar \
120 hello \
121 libbabeltrace \
122 libcapstone \
123 libbfd-liberty \
124 libbfd-liberty-z \
125 libopencsd \
126 cxx \
127 llvm \
128 clang \
129 libbpf \
130 libbpf-btf__load_from_kernel_by_id \
131 libbpf-bpf_prog_load \
132 libbpf-bpf_object__next_program \
133 libbpf-bpf_object__next_map \
134 libbpf-bpf_program__set_insns \
135 libbpf-bpf_create_map \
136 libpfm4 \
137 libdebuginfod \
138 clang-bpf-co-re \
139 bpftool-skeletons
140
141
142FEATURE_TESTS ?= $(FEATURE_TESTS_BASIC)
143
144ifeq ($(FEATURE_TESTS),all)
145 FEATURE_TESTS := $(FEATURE_TESTS_BASIC) $(FEATURE_TESTS_EXTRA)
146endif
147
148FEATURE_DISPLAY ?= \
149 libdw \
150 glibc \
151 libbfd \
152 libbfd-buildid \
153 libelf \
154 libnuma \
155 numa_num_possible_cpus \
156 libperl \
157 libpython \
158 libcrypto \
159 libunwind \
160 libcapstone \
161 llvm-perf \
162 zlib \
163 lzma \
164 get_cpuid \
165 bpf \
166 libaio \
167 libzstd
168
169#
170# Declare group members of a feature to display the logical OR of the detection
171# result instead of each member result.
172#
173FEATURE_GROUP_MEMBERS-libbfd = libbfd-liberty libbfd-liberty-z
174
175#
176# Declare list of feature dependency packages that provide pkg-config files.
177#
178FEATURE_PKG_CONFIG ?= \
179 libtraceevent \
180 libtracefs
181
182feature_pkg_config = $(eval $(feature_pkg_config_code))
183define feature_pkg_config_code
184 FEATURE_CHECK_CFLAGS-$(1) := $(shell $(PKG_CONFIG) --cflags $(1) 2>/dev/null)
185 FEATURE_CHECK_LDFLAGS-$(1) := $(shell $(PKG_CONFIG) --libs $(1) 2>/dev/null)
186endef
187
188# Set FEATURE_CHECK_(C|LD)FLAGS-$(package) for packages using pkg-config.
189ifneq ($(PKG_CONFIG),)
190 $(foreach package,$(FEATURE_PKG_CONFIG),$(call feature_pkg_config,$(package)))
191endif
192
193# Set FEATURE_CHECK_(C|LD)FLAGS-all for all FEATURE_TESTS features.
194# If in the future we need per-feature checks/flags for features not
195# mentioned in this list we need to refactor this ;-).
196set_test_all_flags = $(eval $(set_test_all_flags_code))
197define set_test_all_flags_code
198 FEATURE_CHECK_CFLAGS-all += $(FEATURE_CHECK_CFLAGS-$(1))
199 FEATURE_CHECK_LDFLAGS-all += $(FEATURE_CHECK_LDFLAGS-$(1))
200endef
201
202$(foreach feat,$(FEATURE_TESTS),$(call set_test_all_flags,$(feat)))
203
204#
205# Special fast-path for the 'all features are available' case:
206#
207$(call feature_check,all,$(MSG))
208
209#
210# Just in case the build freshly failed, make sure we print the
211# feature matrix:
212#
213ifeq ($(feature-all), 1)
214 #
215 # test-all.c passed - just set all the core feature flags to 1:
216 #
217 $(foreach feat,$(FEATURE_TESTS),$(call feature_set,$(feat)))
218 #
219 # test-all.c does not comprise these tests, so we need to
220 # for this case to get features proper values
221 #
222 $(call feature_check,compile-32)
223 $(call feature_check,compile-x32)
224 $(call feature_check,bionic)
225 $(call feature_check,libbabeltrace)
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 $(info )
334endif