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