[linux-block.git] / tools / build / Makefile.feature

feature_dir := $(srctree)/tools/build/feature

ifneq ($(OUTPUT),)
  OUTPUT_FEATURES = $(OUTPUT)feature/
  $(shell mkdir -p $(OUTPUT_FEATURES))
endif

feature_check = $(eval $(feature_check_code))
define feature_check_code
  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)
endef

feature_set = $(eval $(feature_set_code))
define feature_set_code
  feature-$(1) := 1
endef

#
# Build the feature check binaries in parallel, ignore errors, ignore return value and suppress output:
#

#
# Note that this is not a complete list of all feature tests, just
# those that are typically built on a fully configured system.
#
# [ Feature tests not mentioned here have to be built explicitly in
#   the rule that uses them - an example for that is the 'bionic'
#   feature check. ]
#
FEATURE_TESTS_BASIC :=                  \
        backtrace                       \
        dwarf                           \
        dwarf_getlocations              \
        eventfd                         \
        fortify-source                  \
        sync-compare-and-swap           \
        get_current_dir_name            \
        glibc                           \
        gtk2                            \
        gtk2-infobar                    \
        libaudit                        \
        libbfd                          \
        libelf                          \
        libelf-getphdrnum               \
        libelf-gelf_getnote             \
        libelf-getshdrstrndx            \
        libelf-mmap                     \
        libnuma                         \
        numa_num_possible_cpus          \
        libperl                         \
        libpython                       \
        libpython-version               \
        libslang                        \
        libcrypto                       \
        libunwind                       \
        pthread-attr-setaffinity-np     \
        pthread-barrier     		\
        reallocarray                    \
        stackprotector-all              \
        timerfd                         \
        libdw-dwarf-unwind              \
        zlib                            \
        lzma                            \
        get_cpuid                       \
        bpf                             \
        sched_getcpu			\
        sdt				\
        setns				\
        libaio				\
        disassembler-four-args

# FEATURE_TESTS_BASIC + FEATURE_TESTS_EXTRA is the complete list
# of all feature tests
FEATURE_TESTS_EXTRA :=                  \
         bionic                         \
         compile-32                     \
         compile-x32                    \
         cplus-demangle                 \
         hello                          \
         libbabeltrace                  \
         libbfd-liberty                 \
         libbfd-liberty-z               \
         libopencsd                     \
         libunwind-x86                  \
         libunwind-x86_64               \
         libunwind-arm                  \
         libunwind-aarch64              \
         libunwind-debug-frame          \
         libunwind-debug-frame-arm      \
         libunwind-debug-frame-aarch64  \
         cxx                            \
         llvm                           \
         llvm-version                   \
         clang

FEATURE_TESTS ?= $(FEATURE_TESTS_BASIC)

ifeq ($(FEATURE_TESTS),all)
  FEATURE_TESTS := $(FEATURE_TESTS_BASIC) $(FEATURE_TESTS_EXTRA)
endif

FEATURE_DISPLAY ?=              \
         dwarf                  \
         dwarf_getlocations     \
         glibc                  \
         gtk2                   \
         libaudit               \
         libbfd                 \
         libelf                 \
         libnuma                \
         numa_num_possible_cpus \
         libperl                \
         libpython              \
         libslang               \
         libcrypto              \
         libunwind              \
         libdw-dwarf-unwind     \
         zlib                   \
         lzma                   \
         get_cpuid              \
         bpf			\
         libaio			\
         disassembler-four-args

# Set FEATURE_CHECK_(C|LD)FLAGS-all for all FEATURE_TESTS features.
# If in the future we need per-feature checks/flags for features not
# mentioned in this list we need to refactor this ;-).
set_test_all_flags = $(eval $(set_test_all_flags_code))
define set_test_all_flags_code
  FEATURE_CHECK_CFLAGS-all  += $(FEATURE_CHECK_CFLAGS-$(1))
  FEATURE_CHECK_LDFLAGS-all += $(FEATURE_CHECK_LDFLAGS-$(1))
endef

$(foreach feat,$(FEATURE_TESTS),$(call set_test_all_flags,$(feat)))

#
# Special fast-path for the 'all features are available' case:
#
$(call feature_check,all,$(MSG))

#
# Just in case the build freshly failed, make sure we print the
# feature matrix:
#
ifeq ($(feature-all), 1)
  #
  # test-all.c passed - just set all the core feature flags to 1:
  #
  $(foreach feat,$(FEATURE_TESTS),$(call feature_set,$(feat)))
  #
  # test-all.c does not comprise these tests, so we need to
  # for this case to get features proper values
  #
  $(call feature_check,compile-32)
  $(call feature_check,compile-x32)
  $(call feature_check,bionic)
  $(call feature_check,libbabeltrace)
else
  $(foreach feat,$(FEATURE_TESTS),$(call feature_check,$(feat)))
endif

#
# Print the result of the feature test:
#
feature_print_status = $(eval $(feature_print_status_code)) $(info $(MSG))

define feature_print_status_code
  ifeq ($(feature-$(1)), 1)
    MSG = $(shell printf '...%30s: [ \033[32mon\033[m  ]' $(1))
  else
    MSG = $(shell printf '...%30s: [ \033[31mOFF\033[m ]' $(1))
  endif
endef

feature_print_text = $(eval $(feature_print_text_code)) $(info $(MSG))
define feature_print_text_code
    MSG = $(shell printf '...%30s: %s' $(1) $(2))
endef

#
# generates feature value assignment for name, like:
#   $(call feature_assign,dwarf) == feature-dwarf=1
#
feature_assign = feature-$(1)=$(feature-$(1))

FEATURE_DUMP_FILENAME = $(OUTPUT)FEATURE-DUMP$(FEATURE_USER)
FEATURE_DUMP := $(shell touch $(FEATURE_DUMP_FILENAME); cat $(FEATURE_DUMP_FILENAME))

feature_dump_check = $(eval $(feature_dump_check_code))
define feature_dump_check_code
  ifeq ($(findstring $(1),$(FEATURE_DUMP)),)
    $(2) := 1
  endif
endef

#
# First check if any test from FEATURE_DISPLAY
# and set feature_display := 1 if it does
$(foreach feat,$(FEATURE_DISPLAY),$(call feature_dump_check,$(call feature_assign,$(feat)),feature_display))

#
# Now also check if any other test changed,
# so we force FEATURE-DUMP generation
$(foreach feat,$(FEATURE_TESTS),$(call feature_dump_check,$(call feature_assign,$(feat)),feature_dump_changed))

# The $(feature_display) controls the default detection message
# output. It's set if:
# - detected features differes from stored features from
#   last build (in $(FEATURE_DUMP_FILENAME) file)
# - one of the $(FEATURE_DISPLAY) is not detected
# - VF is enabled

ifeq ($(feature_dump_changed),1)
  $(shell rm -f $(FEATURE_DUMP_FILENAME))
  $(foreach feat,$(FEATURE_TESTS),$(shell echo "$(call feature_assign,$(feat))" >> $(FEATURE_DUMP_FILENAME)))
endif

feature_display_check = $(eval $(feature_check_display_code))
define feature_check_display_code
  ifneq ($(feature-$(1)), 1)
    feature_display := 1
  endif
endef

$(foreach feat,$(FEATURE_DISPLAY),$(call feature_display_check,$(feat)))

ifeq ($(VF),1)
  feature_display := 1
  feature_verbose := 1
endif

ifeq ($(feature_display),1)
  $(info )
  $(info Auto-detecting system features:)
  $(foreach feat,$(FEATURE_DISPLAY),$(call feature_print_status,$(feat),))
  ifneq ($(feature_verbose),1)
    $(info )
  endif
endif

ifeq ($(feature_verbose),1)
  TMP := $(filter-out $(FEATURE_DISPLAY),$(FEATURE_TESTS))
  $(foreach feat,$(TMP),$(call feature_print_status,$(feat),))
  $(info )
endif
Commit	Line	Data
e6c76d62	1	feature_dir := $(srctree)/tools/build/feature
970e87b3	2
0afc5cad	3	ifneq ($(OUTPUT),)
e6c76d62	4	OUTPUT_FEATURES = $(OUTPUT)feature/
0afc5cad JO	5	$(shell mkdir -p $(OUTPUT_FEATURES))
	6	endif
	7
	8	feature_check = $(eval $(feature_check_code))
	9	define feature_check_code
87095f7d	10	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)
0afc5cad JO	11	endef
	12
	13	feature_set = $(eval $(feature_set_code))
	14	define feature_set_code
	15	feature-$(1) := 1
	16	endef
	17
	18	#
	19	# Build the feature check binaries in parallel, ignore errors, ignore return value and suppress output:
	20	#
	21
	22	#
	23	# Note that this is not a complete list of all feature tests, just
	24	# those that are typically built on a fully configured system.
	25	#
	26	# [ Feature tests not mentioned here have to be built explicitly in
	27	# the rule that uses them - an example for that is the 'bionic'
	28	# feature check. ]
	29	#
2fedf79b JO	30	FEATURE_TESTS_BASIC := \
	31	backtrace \
	32	dwarf \
	33	dwarf_getlocations \
11c6cbe7	34	eventfd \
2fedf79b JO	35	fortify-source \
2fedf79b JO	36	sync-compare-and-swap \
8feb8efe	37	get_current_dir_name \
2fedf79b JO	38	glibc \
	39	gtk2 \
	40	gtk2-infobar \
	41	libaudit \
	42	libbfd \
	43	libelf \
	44	libelf-getphdrnum \
	45	libelf-gelf_getnote \
	46	libelf-getshdrstrndx \
	47	libelf-mmap \
	48	libnuma \
	49	numa_num_possible_cpus \
	50	libperl \
	51	libpython \
	52	libpython-version \
	53	libslang \
	54	libcrypto \
	55	libunwind \
2fedf79b	56	pthread-attr-setaffinity-np \
25ab5abf	57	pthread-barrier \
db42a21a	58	reallocarray \
2fedf79b JO	59	stackprotector-all \
	60	timerfd \
	61	libdw-dwarf-unwind \
	62	zlib \
	63	lzma \
	64	get_cpuid \
	65	bpf \
120010cb	66	sched_getcpu \
86bcdb5a	67	sdt \
aa6292f4	68	setns \
8a1b1718 SL	69	libaio \
8a1b1718 SL	70	disassembler-four-args
0afc5cad	71
9fd4186a WN	72	# FEATURE_TESTS_BASIC + FEATURE_TESTS_EXTRA is the complete list
9fd4186a WN	73	# of all feature tests
2fedf79b JO	74	FEATURE_TESTS_EXTRA := \
	75	bionic \
	76	compile-32 \
	77	compile-x32 \
	78	cplus-demangle \
	79	hello \
	80	libbabeltrace \
14541b1e SF	81	libbfd-liberty \
14541b1e SF	82	libbfd-liberty-z \
1c3b28fd	83	libopencsd \
5c4d7c82 ACM	84	libunwind-x86 \
	85	libunwind-x86_64 \
	86	libunwind-arm \
	87	libunwind-aarch64 \
2fedf79b JO	88	libunwind-debug-frame \
2fedf79b JO	89	libunwind-debug-frame-arm \
bd476684 JO	90	libunwind-debug-frame-aarch64 \
	91	cxx \
	92	llvm \
	93	llvm-version \
	94	clang
9fd4186a WN	95
	96	FEATURE_TESTS ?= $(FEATURE_TESTS_BASIC)
	97
	98	ifeq ($(FEATURE_TESTS),all)
	99	FEATURE_TESTS := $(FEATURE_TESTS_BASIC) $(FEATURE_TESTS_EXTRA)
	100	endif
	101
2fedf79b JO	102	FEATURE_DISPLAY ?= \
	103	dwarf \
	104	dwarf_getlocations \
	105	glibc \
	106	gtk2 \
	107	libaudit \
	108	libbfd \
	109	libelf \
	110	libnuma \
	111	numa_num_possible_cpus \
	112	libperl \
	113	libpython \
	114	libslang \
	115	libcrypto \
	116	libunwind \
	117	libdw-dwarf-unwind \
	118	zlib \
	119	lzma \
	120	get_cpuid \
2a07d814	121	bpf \
8a1b1718 SL	122	libaio \
8a1b1718 SL	123	disassembler-four-args
0afc5cad JO	124
	125	# Set FEATURE_CHECK_(C\|LD)FLAGS-all for all FEATURE_TESTS features.
	126	# If in the future we need per-feature checks/flags for features not
	127	# mentioned in this list we need to refactor this ;-).
	128	set_test_all_flags = $(eval $(set_test_all_flags_code))
	129	define set_test_all_flags_code
	130	FEATURE_CHECK_CFLAGS-all += $(FEATURE_CHECK_CFLAGS-$(1))
	131	FEATURE_CHECK_LDFLAGS-all += $(FEATURE_CHECK_LDFLAGS-$(1))
	132	endef
	133
	134	$(foreach feat,$(FEATURE_TESTS),$(call set_test_all_flags,$(feat)))
	135
	136	#
	137	# Special fast-path for the 'all features are available' case:
	138	#
	139	$(call feature_check,all,$(MSG))
	140
	141	#
	142	# Just in case the build freshly failed, make sure we print the
	143	# feature matrix:
	144	#
	145	ifeq ($(feature-all), 1)
	146	#
	147	# test-all.c passed - just set all the core feature flags to 1:
	148	#
	149	$(foreach feat,$(FEATURE_TESTS),$(call feature_set,$(feat)))
76c4aaec JO	150	#
	151	# test-all.c does not comprise these tests, so we need to
	152	# for this case to get features proper values
	153	#
	154	$(call feature_check,compile-32)
	155	$(call feature_check,compile-x32)
	156	$(call feature_check,bionic)
	157	$(call feature_check,libbabeltrace)
0afc5cad	158	else
0afc5cad JO	159	$(foreach feat,$(FEATURE_TESTS),$(call feature_check,$(feat)))
	160	endif
	161
	162	#
	163	# Print the result of the feature test:
	164	#
	165	feature_print_status = $(eval $(feature_print_status_code)) $(info $(MSG))
	166
	167	define feature_print_status_code
	168	ifeq ($(feature-$(1)), 1)
	169	MSG = $(shell printf '...%30s: [ \033[32mon\033[m ]' $(1))
	170	else
	171	MSG = $(shell printf '...%30s: [ \033[31mOFF\033[m ]' $(1))
	172	endif
	173	endef
	174
	175	feature_print_text = $(eval $(feature_print_text_code)) $(info $(MSG))
	176	define feature_print_text_code
	177	MSG = $(shell printf '...%30s: %s' $(1) $(2))
	178	endef
	179
c6a5f88f JO	180	#
	181	# generates feature value assignment for name, like:
	182	# $(call feature_assign,dwarf) == feature-dwarf=1
	183	#
	184	feature_assign = feature-$(1)=$(feature-$(1))
	185
13e96db6	186	FEATURE_DUMP_FILENAME = $(OUTPUT)FEATURE-DUMP$(FEATURE_USER)
936d120d JO	187	FEATURE_DUMP := $(shell touch $(FEATURE_DUMP_FILENAME); cat $(FEATURE_DUMP_FILENAME))
	188
	189	feature_dump_check = $(eval $(feature_dump_check_code))
	190	define feature_dump_check_code
	191	ifeq ($(findstring $(1),$(FEATURE_DUMP)),)
	192	$(2) := 1
	193	endif
	194	endef
	195
	196	#
	197	# First check if any test from FEATURE_DISPLAY
	198	# and set feature_display := 1 if it does
	199	$(foreach feat,$(FEATURE_DISPLAY),$(call feature_dump_check,$(call feature_assign,$(feat)),feature_display))
	200
	201	#
	202	# Now also check if any other test changed,
	203	# so we force FEATURE-DUMP generation
	204	$(foreach feat,$(FEATURE_TESTS),$(call feature_dump_check,$(call feature_assign,$(feat)),feature_dump_changed))
0afc5cad	205
0afc5cad JO	206	# The $(feature_display) controls the default detection message
	207	# output. It's set if:
	208	# - detected features differes from stored features from
13e96db6	209	# last build (in $(FEATURE_DUMP_FILENAME) file)
0afc5cad JO	210	# - one of the $(FEATURE_DISPLAY) is not detected
	211	# - VF is enabled
	212
936d120d JO	213	ifeq ($(feature_dump_changed),1)
	214	$(shell rm -f $(FEATURE_DUMP_FILENAME))
	215	$(foreach feat,$(FEATURE_TESTS),$(shell echo "$(call feature_assign,$(feat))" >> $(FEATURE_DUMP_FILENAME)))
0afc5cad JO	216	endif
0afc5cad JO	217
6076e2a4	218	feature_display_check = $(eval $(feature_check_display_code))
d0018b49	219	define feature_check_display_code
0afc5cad JO	220	ifneq ($(feature-$(1)), 1)
	221	feature_display := 1
	222	endif
	223	endef
	224
	225	$(foreach feat,$(FEATURE_DISPLAY),$(call feature_display_check,$(feat)))
	226
	227	ifeq ($(VF),1)
	228	feature_display := 1
	229	feature_verbose := 1
	230	endif
	231
	232	ifeq ($(feature_display),1)
	233	$(info )
	234	$(info Auto-detecting system features:)
	235	$(foreach feat,$(FEATURE_DISPLAY),$(call feature_print_status,$(feat),))
0afc5cad JO	236	ifneq ($(feature_verbose),1)
	237	$(info )
	238	endif
	239	endif
	240
	241	ifeq ($(feature_verbose),1)
	242	TMP := $(filter-out $(FEATURE_DISPLAY),$(FEATURE_TESTS))
	243	$(foreach feat,$(TMP),$(call feature_print_status,$(feat),))
	244	$(info )
	245	endif