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