Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
tjh.dev
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 pthread-attr-setaffinity-np \
91 pthread-barrier \
92 reallocarray \
93 stackprotector-all \
94 timerfd \
95 zlib \
96 lzma \
97 get_cpuid \
98 bpf \
99 scandirat \
100 sched_getcpu \
101 sdt \
102 setns \
103 libaio \
104 libzstd \
105 disassembler-four-args \
106 disassembler-init-styled \
107 file-handle
108
109# FEATURE_TESTS_BASIC + FEATURE_TESTS_EXTRA is the complete list
110# of all feature tests
111FEATURE_TESTS_EXTRA := \
112 bionic \
113 compile-32 \
114 compile-x32 \
115 cplus-demangle \
116 cxa-demangle \
117 gtk2 \
118 gtk2-infobar \
119 hello \
120 libbabeltrace \
121 libcapstone \
122 libbfd-liberty \
123 libbfd-liberty-z \
124 libopencsd \
125 cxx \
126 llvm \
127 clang \
128 libbpf \
129 libbpf-btf__load_from_kernel_by_id \
130 libbpf-bpf_prog_load \
131 libbpf-bpf_object__next_program \
132 libbpf-bpf_object__next_map \
133 libbpf-bpf_program__set_insns \
134 libbpf-bpf_create_map \
135 libpfm4 \
136 libdebuginfod \
137 clang-bpf-co-re \
138 bpftool-skeletons
139
140
141FEATURE_TESTS ?= $(FEATURE_TESTS_BASIC)
142
143ifeq ($(FEATURE_TESTS),all)
144 FEATURE_TESTS := $(FEATURE_TESTS_BASIC) $(FEATURE_TESTS_EXTRA)
145endif
146
147FEATURE_DISPLAY ?= \
148 libdw \
149 glibc \
150 libelf \
151 libnuma \
152 numa_num_possible_cpus \
153 libperl \
154 libpython \
155 libcrypto \
156 libcapstone \
157 llvm-perf \
158 zlib \
159 lzma \
160 get_cpuid \
161 bpf \
162 libaio \
163 libzstd
164
165#
166# Declare group members of a feature to display the logical OR of the detection
167# result instead of each member result.
168#
169FEATURE_GROUP_MEMBERS-libbfd = libbfd-liberty libbfd-liberty-z
170
171#
172# Declare list of feature dependency packages that provide pkg-config files.
173#
174FEATURE_PKG_CONFIG ?= \
175 libtraceevent \
176 libtracefs
177
178feature_pkg_config = $(eval $(feature_pkg_config_code))
179define feature_pkg_config_code
180 FEATURE_CHECK_CFLAGS-$(1) := $(shell $(PKG_CONFIG) --cflags $(1) 2>/dev/null)
181 FEATURE_CHECK_LDFLAGS-$(1) := $(shell $(PKG_CONFIG) --libs $(1) 2>/dev/null)
182endef
183
184# Set FEATURE_CHECK_(C|LD)FLAGS-$(package) for packages using pkg-config.
185ifneq ($(PKG_CONFIG),)
186 $(foreach package,$(FEATURE_PKG_CONFIG),$(call feature_pkg_config,$(package)))
187endif
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,libbabeltrace)
222else
223 $(foreach feat,$(FEATURE_TESTS),$(call feature_check,$(feat)))
224endif
225
226#
227# Print the result of the feature test:
228#
229feature_print_status = $(eval $(feature_print_status_code))
230
231feature_group = $(eval $(feature_gen_group)) $(GROUP)
232
233define feature_gen_group
234 GROUP := $(1)
235 ifneq ($(feature_verbose),1)
236 GROUP += $(FEATURE_GROUP_MEMBERS-$(1))
237 endif
238endef
239
240define feature_print_status_code
241 ifneq (,$(filter 1,$(foreach feat,$(call feature_group,$(feat)),$(feature-$(feat)))))
242 MSG = $(shell printf '...%40s: [ \033[32mon\033[m ]' $(1))
243 else
244 MSG = $(shell printf '...%40s: [ \033[31mOFF\033[m ]' $(1))
245 endif
246endef
247
248feature_print_text = $(eval $(feature_print_text_code))
249define feature_print_text_code
250 MSG = $(shell printf '...%40s: %s' $(1) $(2))
251endef
252
253#
254# generates feature value assignment for name, like:
255# $(call feature_assign,libdw) == feature-libdw=1
256#
257feature_assign = feature-$(1)=$(feature-$(1))
258
259FEATURE_DUMP_FILENAME = $(OUTPUT)FEATURE-DUMP$(FEATURE_USER)
260FEATURE_DUMP := $(shell touch $(FEATURE_DUMP_FILENAME); cat $(FEATURE_DUMP_FILENAME))
261
262feature_dump_check = $(eval $(feature_dump_check_code))
263define feature_dump_check_code
264 ifeq ($(findstring $(1),$(FEATURE_DUMP)),)
265 $(2) := 1
266 endif
267endef
268
269#
270# First check if any test from FEATURE_DISPLAY
271# and set feature_display := 1 if it does
272$(foreach feat,$(FEATURE_DISPLAY),$(call feature_dump_check,$(call feature_assign,$(feat)),feature_display))
273
274#
275# Now also check if any other test changed,
276# so we force FEATURE-DUMP generation
277$(foreach feat,$(FEATURE_TESTS),$(call feature_dump_check,$(call feature_assign,$(feat)),feature_dump_changed))
278
279# The $(feature_display) controls the default detection message
280# output. It's set if:
281# - detected features differes from stored features from
282# last build (in $(FEATURE_DUMP_FILENAME) file)
283# - one of the $(FEATURE_DISPLAY) is not detected
284# - VF is enabled
285
286ifeq ($(feature_dump_changed),1)
287 $(shell rm -f $(FEATURE_DUMP_FILENAME))
288 $(foreach feat,$(FEATURE_TESTS),$(shell echo "$(call feature_assign,$(feat))" >> $(FEATURE_DUMP_FILENAME)))
289endif
290
291feature_display_check = $(eval $(feature_check_display_code))
292define feature_check_display_code
293 ifneq ($(feature-$(1)), 1)
294 feature_display := 1
295 endif
296endef
297
298$(foreach feat,$(FEATURE_DISPLAY),$(call feature_display_check,$(feat)))
299
300ifeq ($(VF),1)
301 feature_display := 1
302 feature_verbose := 1
303endif
304
305ifneq ($(feature_verbose),1)
306 #
307 # Determine the features to omit from the displayed message, as only the
308 # logical OR of the detection result will be shown.
309 #
310 FEATURE_OMIT := $(foreach feat,$(FEATURE_DISPLAY),$(FEATURE_GROUP_MEMBERS-$(feat)))
311endif
312
313feature_display_entries = $(eval $(feature_display_entries_code))
314define feature_display_entries_code
315 ifeq ($(feature_display),1)
316 $$(info )
317 $$(info Auto-detecting system features:)
318 $(foreach feat,$(filter-out $(FEATURE_OMIT),$(FEATURE_DISPLAY)),$(call feature_print_status,$(feat),) $$(info $(MSG)))
319 endif
320
321 ifeq ($(feature_verbose),1)
322 $(eval TMP := $(filter-out $(FEATURE_DISPLAY),$(FEATURE_TESTS)))
323 $(foreach feat,$(TMP),$(call feature_print_status,$(feat),) $$(info $(MSG)))
324 endif
325endef
326
327ifeq ($(FEATURE_DISPLAY_DEFERRED),)
328 $(call feature_display_entries)
329 $(info )
330endif