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