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         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
  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          libbfd-liberty                 \
  89          libbfd-liberty-z               \
  90          libopencsd                     \
  91          libunwind-x86                  \
  92          libunwind-x86_64               \
  93          libunwind-arm                  \
  94          libunwind-aarch64              \
  95          libunwind-debug-frame          \
  96          libunwind-debug-frame-arm      \
  97          libunwind-debug-frame-aarch64  \
  98          cxx                            \
  99          llvm                           \
 100          llvm-version                   \
 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          dwarf                  \
 122          dwarf_getlocations     \
 123          glibc                  \
 124          libbfd                 \
 125          libbfd-buildid         \
 126          libcap                 \
 127          libelf                 \
 128          libnuma                \
 129          numa_num_possible_cpus \
 130          libperl                \
 131          libpython              \
 132          libcrypto              \
 133          libunwind              \
 134          libdw-dwarf-unwind     \
 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 # Set FEATURE_CHECK_(C|LD)FLAGS-all for all FEATURE_TESTS features.
 149 # If in the future we need per-feature checks/flags for features not
 150 # mentioned in this list we need to refactor this ;-).
 151 set_test_all_flags = $(eval $(set_test_all_flags_code))
 152 define set_test_all_flags_code
 153   FEATURE_CHECK_CFLAGS-all  += $(FEATURE_CHECK_CFLAGS-$(1))
 154   FEATURE_CHECK_LDFLAGS-all += $(FEATURE_CHECK_LDFLAGS-$(1))
 155 endef
 156
 157 $(foreach feat,$(FEATURE_TESTS),$(call set_test_all_flags,$(feat)))
 158
 159 #
 160 # Special fast-path for the 'all features are available' case:
 161 #
 162 $(call feature_check,all,$(MSG))
 163
 164 #
 165 # Just in case the build freshly failed, make sure we print the
 166 # feature matrix:
 167 #
 168 ifeq ($(feature-all), 1)
 169   #
 170   # test-all.c passed - just set all the core feature flags to 1:
 171   #
 172   $(foreach feat,$(FEATURE_TESTS),$(call feature_set,$(feat)))
 173   #
 174   # test-all.c does not comprise these tests, so we need to
 175   # for this case to get features proper values
 176   #
 177   $(call feature_check,compile-32)
 178   $(call feature_check,compile-x32)
 179   $(call feature_check,bionic)
 180   $(call feature_check,libbabeltrace)
 181 else
 182   $(foreach feat,$(FEATURE_TESTS),$(call feature_check,$(feat)))
 183 endif
 184
 185 #
 186 # Print the result of the feature test:
 187 #
 188 feature_print_status = $(eval $(feature_print_status_code))
 189
 190 feature_group = $(eval $(feature_gen_group)) $(GROUP)
 191
 192 define feature_gen_group
 193   GROUP := $(1)
 194   ifneq ($(feature_verbose),1)
 195     GROUP += $(FEATURE_GROUP_MEMBERS-$(1))
 196   endif
 197 endef
 198
 199 define feature_print_status_code
 200   ifneq (,$(filter 1,$(foreach feat,$(call feature_group,$(feat)),$(feature-$(feat)))))
 201     MSG = $(shell printf '...%40s: [ \033[32mon\033[m  ]' $(1))
 202   else
 203     MSG = $(shell printf '...%40s: [ \033[31mOFF\033[m ]' $(1))
 204   endif
 205 endef
 206
 207 feature_print_text = $(eval $(feature_print_text_code))
 208 define feature_print_text_code
 209     MSG = $(shell printf '...%40s: %s' $(1) $(2))
 210 endef
 211
 212 #
 213 # generates feature value assignment for name, like:
 214 #   $(call feature_assign,dwarf) == feature-dwarf=1
 215 #
 216 feature_assign = feature-$(1)=$(feature-$(1))
 217
 218 FEATURE_DUMP_FILENAME = $(OUTPUT)FEATURE-DUMP$(FEATURE_USER)
 219 FEATURE_DUMP := $(shell touch $(FEATURE_DUMP_FILENAME); cat $(FEATURE_DUMP_FILENAME))
 220
 221 feature_dump_check = $(eval $(feature_dump_check_code))
 222 define feature_dump_check_code
 223   ifeq ($(findstring $(1),$(FEATURE_DUMP)),)
 224     $(2) := 1
 225   endif
 226 endef
 227
 228 #
 229 # First check if any test from FEATURE_DISPLAY
 230 # and set feature_display := 1 if it does
 231 $(foreach feat,$(FEATURE_DISPLAY),$(call feature_dump_check,$(call feature_assign,$(feat)),feature_display))
 232
 233 #
 234 # Now also check if any other test changed,
 235 # so we force FEATURE-DUMP generation
 236 $(foreach feat,$(FEATURE_TESTS),$(call feature_dump_check,$(call feature_assign,$(feat)),feature_dump_changed))
 237
 238 # The $(feature_display) controls the default detection message
 239 # output. It's set if:
 240 # - detected features differes from stored features from
 241 #   last build (in $(FEATURE_DUMP_FILENAME) file)
 242 # - one of the $(FEATURE_DISPLAY) is not detected
 243 # - VF is enabled
 244
 245 ifeq ($(feature_dump_changed),1)
 246   $(shell rm -f $(FEATURE_DUMP_FILENAME))
 247   $(foreach feat,$(FEATURE_TESTS),$(shell echo "$(call feature_assign,$(feat))" >> $(FEATURE_DUMP_FILENAME)))
 248 endif
 249
 250 feature_display_check = $(eval $(feature_check_display_code))
 251 define feature_check_display_code
 252   ifneq ($(feature-$(1)), 1)
 253     feature_display := 1
 254   endif
 255 endef
 256
 257 $(foreach feat,$(FEATURE_DISPLAY),$(call feature_display_check,$(feat)))
 258
 259 ifeq ($(VF),1)
 260   feature_display := 1
 261   feature_verbose := 1
 262 endif
 263
 264 ifneq ($(feature_verbose),1)
 265   #
 266   # Determine the features to omit from the displayed message, as only the
 267   # logical OR of the detection result will be shown.
 268   #
 269   FEATURE_OMIT := $(foreach feat,$(FEATURE_DISPLAY),$(FEATURE_GROUP_MEMBERS-$(feat)))
 270 endif
 271
 272 feature_display_entries = $(eval $(feature_display_entries_code))
 273 define feature_display_entries_code
 274   ifeq ($(feature_display),1)
 275     $$(info )
 276     $$(info Auto-detecting system features:)
 277     $(foreach feat,$(filter-out $(FEATURE_OMIT),$(FEATURE_DISPLAY)),$(call feature_print_status,$(feat),) $$(info $(MSG)))
 278   endif
 279
 280   ifeq ($(feature_verbose),1)
 281     $(eval TMP := $(filter-out $(FEATURE_DISPLAY),$(FEATURE_TESTS)))
 282     $(foreach feat,$(TMP),$(call feature_print_status,$(feat),) $$(info $(MSG)))
 283   endif
 284 endef
 285
 286 ifeq ($(FEATURE_DISPLAY_DEFERRED),)
 287   $(call feature_display_entries)
 288   $(info )
 289 endif