Debian Codegraph @

tools/build/Makefile.feature

raw
1 # SPDX-License-Identifier: GPL-2.0-only
2 feature_dir := $(srctree)/tools/build/feature
3
4 ifneq ($(OUTPUT),)
5 OUTPUT_FEATURES = $(OUTPUT)feature/
6 $(shell mkdir -p $(OUTPUT_FEATURES))
7 endif
8
9 feature_check = $(eval $(feature_check_code))
10 define 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)
12 endef
13
14 feature_set = $(eval $(feature_set_code))
15 define feature_set_code
16 feature-$(1) := 1
17 endef
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 #
66 FEATURE_TESTS_BASIC := \
67 backtrace \
68 libdw \
69 eventfd \
70 fortify-source \
71 gettid \
72 glibc \
73 libbfd \
74 libbfd-threadsafe \
75 libelf \
76 libelf-getphdrnum \
77 libelf-gelf_getnote \
78 libelf-getshdrstrndx \
79 libelf-zstd \
80 libnuma \
81 numa_num_possible_cpus \
82 libpython \
83 libslang \
84 libtraceevent \
85 libcpupower \
86 pthread-attr-setaffinity-np \
87 pthread-barrier \
88 reallocarray \
89 stackprotector-all \
90 timerfd \
91 zlib \
92 lzma \
93 bpf \
94 scandirat \
95 sched_getcpu \
96 sdt \
97 setns \
98 libaio \
99 libzstd \
100 disassembler-four-args \
101 disassembler-init-styled \
102 file-handle \
103 libopenssl
104
105 # FEATURE_TESTS_BASIC + FEATURE_TESTS_EXTRA is the complete list
106 # of all feature tests
107 FEATURE_TESTS_EXTRA := \
108 bionic \
109 compile-32 \
110 compile-x32 \
111 cplus-demangle \
112 cxa-demangle \
113 gtk2 \
114 gtk2-infobar \
115 hello \
116 libbabeltrace \
117 libcapstone \
118 libbfd-liberty \
119 libbfd-liberty-z \
120 libopencsd \
121 libperl \
122 cxx \
123 llvm \
124 clang \
125 libbpf \
126 libpfm4 \
127 libdebuginfod \
128 clang-bpf-co-re \
129 bpftool-skeletons
130
131
132 FEATURE_TESTS ?= $(FEATURE_TESTS_BASIC)
133
134 ifeq ($(FEATURE_TESTS),all)
135 FEATURE_TESTS := $(FEATURE_TESTS_BASIC) $(FEATURE_TESTS_EXTRA)
136 endif
137
138 FEATURE_DISPLAY ?= \
139 libdw \
140 glibc \
141 libelf \
142 libnuma \
143 numa_num_possible_cpus \
144 libpython \
145 libcapstone \
146 llvm-perf \
147 zlib \
148 lzma \
149 bpf \
150 libaio \
151 libzstd \
152 libopenssl \
153 rust
154
155 #
156 # Declare group members of a feature to display the logical OR of the detection
157 # result instead of each member result.
158 #
159 FEATURE_GROUP_MEMBERS-libbfd = libbfd-liberty libbfd-liberty-z
160
161 #
162 # Declare list of feature dependency packages that provide pkg-config files.
163 #
164 FEATURE_PKG_CONFIG ?= \
165 libtraceevent \
166 libtracefs
167
168 feature_pkg_config = $(eval $(feature_pkg_config_code))
169 define feature_pkg_config_code
170 FEATURE_CHECK_CFLAGS-$(1) := $(shell $(PKG_CONFIG) --cflags $(1) 2>/dev/null)
171 FEATURE_CHECK_LDFLAGS-$(1) := $(shell $(PKG_CONFIG) --libs $(1) 2>/dev/null)
172 endef
173
174 # Set FEATURE_CHECK_(C|LD)FLAGS-$(package) for packages using pkg-config.
175 ifneq ($(PKG_CONFIG),)
176 $(foreach package,$(FEATURE_PKG_CONFIG),$(call feature_pkg_config,$(package)))
177 endif
178
179 # Set FEATURE_CHECK_(C|LD)FLAGS-all for all FEATURE_TESTS features.
180 # If in the future we need per-feature checks/flags for features not
181 # mentioned in this list we need to refactor this ;-).
182 set_test_all_flags = $(eval $(set_test_all_flags_code))
183 define set_test_all_flags_code
184 FEATURE_CHECK_CFLAGS-all += $(FEATURE_CHECK_CFLAGS-$(1))
185 FEATURE_CHECK_LDFLAGS-all += $(FEATURE_CHECK_LDFLAGS-$(1))
186 endef
187
188 $(foreach feat,$(FEATURE_TESTS),$(call set_test_all_flags,$(feat)))
189
190 #
191 # Special fast-path for the 'all features are available' case:
192 #
193 $(call feature_check,all,$(MSG))
194
195 #
196 # Just in case the build freshly failed, make sure we print the
197 # feature matrix:
198 #
199 ifeq ($(feature-all), 1)
200 #
201 # test-all.c passed - just set all the core feature flags to 1:
202 #
203 $(foreach feat,$(FEATURE_TESTS),$(call feature_set,$(feat)))
204 #
205 # test-all.c does not comprise these tests, so we need to
206 # for this case to get features proper values
207 #
208 $(call feature_check,compile-32)
209 $(call feature_check,compile-x32)
210 $(call feature_check,bionic)
211 $(call feature_check,libbabeltrace)
212 else
213 $(foreach feat,$(FEATURE_TESTS),$(call feature_check,$(feat)))
214 endif
215
216 #
217 # Print the result of the feature test:
218 #
219 feature_print_status = $(eval $(feature_print_status_code))
220
221 feature_group = $(eval $(feature_gen_group)) $(GROUP)
222
223 define feature_gen_group
224 GROUP := $(1)
225 ifneq ($(feature_verbose),1)
226 GROUP += $(FEATURE_GROUP_MEMBERS-$(1))
227 endif
228 endef
229
230 define feature_print_status_code
231 ifneq (,$(filter 1,$(foreach feat,$(call feature_group,$(feat)),$(feature-$(feat)))))
232 MSG = $(shell printf '...%40s: [ \033[32mon\033[m ]' $(1))
233 else
234 MSG = $(shell printf '...%40s: [ \033[31mOFF\033[m ]' $(1))
235 endif
236 endef
237
238 feature_print_text = $(eval $(feature_print_text_code))
239 define feature_print_text_code
240 MSG = $(shell printf '...%40s: %s' $(1) $(2))
241 endef
242
243 #
244 # generates feature value assignment for name, like:
245 # $(call feature_assign,libdw) == feature-libdw=1
246 #
247 feature_assign = feature-$(1)=$(feature-$(1))
248
249 FEATURE_DUMP_FILENAME = $(OUTPUT)FEATURE-DUMP$(FEATURE_USER)
250 FEATURE_DUMP := $(shell touch $(FEATURE_DUMP_FILENAME); cat $(FEATURE_DUMP_FILENAME))
251
252 feature_dump_check = $(eval $(feature_dump_check_code))
253 define feature_dump_check_code
254 ifeq ($(findstring $(1),$(FEATURE_DUMP)),)
255 $(2) := 1
256 endif
257 endef
258
259 #
260 # First check if any test from FEATURE_DISPLAY
261 # and set feature_display := 1 if it does
262 $(foreach feat,$(FEATURE_DISPLAY),$(call feature_dump_check,$(call feature_assign,$(feat)),feature_display))
263
264 #
265 # Now also check if any other test changed,
266 # so we force FEATURE-DUMP generation
267 $(foreach feat,$(FEATURE_TESTS),$(call feature_dump_check,$(call feature_assign,$(feat)),feature_dump_changed))
268
269 # The $(feature_display) controls the default detection message
270 # output. It's set if:
271 # - detected features differes from stored features from
272 # last build (in $(FEATURE_DUMP_FILENAME) file)
273 # - one of the $(FEATURE_DISPLAY) is not detected
274 # - VF is enabled
275
276 ifeq ($(feature_dump_changed),1)
277 $(shell rm -f $(FEATURE_DUMP_FILENAME))
278 $(foreach feat,$(FEATURE_TESTS),$(shell echo "$(call feature_assign,$(feat))" >> $(FEATURE_DUMP_FILENAME)))
279 endif
280
281 feature_display_check = $(eval $(feature_check_display_code))
282 define feature_check_display_code
283 ifneq ($(feature-$(1)), 1)
284 feature_display := 1
285 endif
286 endef
287
288 $(foreach feat,$(FEATURE_DISPLAY),$(call feature_display_check,$(feat)))
289
290 ifeq ($(VF),1)
291 feature_display := 1
292 feature_verbose := 1
293 endif
294
295 ifneq ($(feature_verbose),1)
296 #
297 # Determine the features to omit from the displayed message, as only the
298 # logical OR of the detection result will be shown.
299 #
300 FEATURE_OMIT := $(foreach feat,$(FEATURE_DISPLAY),$(FEATURE_GROUP_MEMBERS-$(feat)))
301 endif
302
303 feature_display_entries = $(eval $(feature_display_entries_code))
304 define feature_display_entries_code
305 ifeq ($(feature_display),1)
306 $$(info )
307 $$(info Auto-detecting system features:)
308 $(foreach feat,$(filter-out $(FEATURE_OMIT),$(FEATURE_DISPLAY)),$(call feature_print_status,$(feat),) $$(info $(MSG)))
309 endif
310
311 ifeq ($(feature_verbose),1)
312 $(eval TMP := $(filter-out $(FEATURE_DISPLAY),$(FEATURE_TESTS)))
313 $(foreach feat,$(TMP),$(call feature_print_status,$(feat),) $$(info $(MSG)))
314 endif
315 endef
316
317 ifeq ($(FEATURE_DISPLAY_DEFERRED),)
318 $(call feature_display_entries)
319 ifeq ($(feature_display),1)
320 $(info )
321 endif
322 endif