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