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