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