xref: /linux/tools/testing/selftests/lib.mk (revision 2bd87951de659df3381ce083342aaf5b1ea24689)
1# This mimics the top-level Makefile. We do it explicitly here so that this
2# Makefile can operate with or without the kbuild infrastructure.
3ifneq ($(LLVM),)
4ifneq ($(filter %/,$(LLVM)),)
5LLVM_PREFIX := $(LLVM)
6else ifneq ($(filter -%,$(LLVM)),)
7LLVM_SUFFIX := $(LLVM)
8endif
9
10CLANG_TARGET_FLAGS_arm          := arm-linux-gnueabi
11CLANG_TARGET_FLAGS_arm64        := aarch64-linux-gnu
12CLANG_TARGET_FLAGS_hexagon      := hexagon-linux-musl
13CLANG_TARGET_FLAGS_i386         := i386-linux-gnu
14CLANG_TARGET_FLAGS_m68k         := m68k-linux-gnu
15CLANG_TARGET_FLAGS_mips         := mipsel-linux-gnu
16CLANG_TARGET_FLAGS_powerpc      := powerpc64le-linux-gnu
17CLANG_TARGET_FLAGS_riscv        := riscv64-linux-gnu
18CLANG_TARGET_FLAGS_s390         := s390x-linux-gnu
19CLANG_TARGET_FLAGS_x86          := x86_64-linux-gnu
20CLANG_TARGET_FLAGS_x86_64       := x86_64-linux-gnu
21CLANG_TARGET_FLAGS              := $(CLANG_TARGET_FLAGS_$(ARCH))
22
23ifeq ($(CROSS_COMPILE),)
24ifeq ($(CLANG_TARGET_FLAGS),)
25$(error Specify CROSS_COMPILE or add '--target=' option to lib.mk)
26else
27CLANG_FLAGS     += --target=$(CLANG_TARGET_FLAGS)
28endif # CLANG_TARGET_FLAGS
29else
30CLANG_FLAGS     += --target=$(notdir $(CROSS_COMPILE:%-=%))
31endif # CROSS_COMPILE
32
33CC := $(LLVM_PREFIX)clang$(LLVM_SUFFIX) $(CLANG_FLAGS) -fintegrated-as
34else
35CC := $(CROSS_COMPILE)gcc
36endif # LLVM
37
38ifeq (0,$(MAKELEVEL))
39    ifeq ($(OUTPUT),)
40	OUTPUT := $(shell pwd)
41	DEFAULT_INSTALL_HDR_PATH := 1
42    endif
43endif
44selfdir = $(realpath $(dir $(filter %/lib.mk,$(MAKEFILE_LIST))))
45top_srcdir = $(selfdir)/../../..
46
47# msg: emit succinct information message describing current building step
48# $1 - generic step name (e.g., CC, LINK, etc);
49# $2 - optional "flavor" specifier; if provided, will be emitted as [flavor];
50# $3 - target (assumed to be file); only file name will be emitted;
51# $4 - optional extra arg, emitted as-is, if provided.
52ifeq ($(V),1)
53Q =
54msg =
55else
56Q = @
57msg = @printf '  %-8s%s %s%s\n' "$(1)" "$(if $(2), [$(2)])" "$(notdir $(3))" "$(if $(4), $(4))";
58MAKEFLAGS += --no-print-directory
59endif
60
61ifeq ($(KHDR_INCLUDES),)
62KHDR_INCLUDES := -isystem $(top_srcdir)/usr/include
63endif
64
65# The following are built by lib.mk common compile rules.
66# TEST_CUSTOM_PROGS should be used by tests that require
67# custom build rule and prevent common build rule use.
68# TEST_PROGS are for test shell scripts.
69# TEST_CUSTOM_PROGS and TEST_PROGS will be run by common run_tests
70# and install targets. Common clean doesn't touch them.
71TEST_GEN_PROGS := $(patsubst %,$(OUTPUT)/%,$(TEST_GEN_PROGS))
72TEST_GEN_PROGS_EXTENDED := $(patsubst %,$(OUTPUT)/%,$(TEST_GEN_PROGS_EXTENDED))
73TEST_GEN_FILES := $(patsubst %,$(OUTPUT)/%,$(TEST_GEN_FILES))
74
75all: $(TEST_GEN_PROGS) $(TEST_GEN_PROGS_EXTENDED) $(TEST_GEN_FILES) \
76	$(if $(TEST_GEN_MODS_DIR),gen_mods_dir)
77
78define RUN_TESTS
79	BASE_DIR="$(selfdir)";			\
80	. $(selfdir)/kselftest/runner.sh;	\
81	if [ "X$(summary)" != "X" ]; then       \
82		per_test_logging=1;		\
83	fi;                                     \
84	run_many $(1)
85endef
86
87define INSTALL_INCLUDES
88	$(if $(TEST_INCLUDES), \
89		relative_files=""; \
90		for entry in $(TEST_INCLUDES); do \
91			entry_dir=$$(readlink -e "$$(dirname "$$entry")"); \
92			entry_name=$$(basename "$$entry"); \
93			relative_dir=$${entry_dir#"$$SRC_PATH"/}; \
94			if [ "$$relative_dir" = "$$entry_dir" ]; then \
95				echo "Error: TEST_INCLUDES entry \"$$entry\" not located inside selftests directory ($$SRC_PATH)" >&2; \
96				exit 1; \
97			fi; \
98			relative_files="$$relative_files $$relative_dir/$$entry_name"; \
99		done; \
100		cd $(SRC_PATH) && rsync -aR $$relative_files $(OBJ_PATH)/ \
101	)
102endef
103
104run_tests: all
105ifdef building_out_of_srctree
106	@if [ "X$(TEST_PROGS)$(TEST_PROGS_EXTENDED)$(TEST_FILES)$(TEST_GEN_MODS_DIR)" != "X" ]; then \
107		rsync -aq --copy-unsafe-links $(TEST_PROGS) $(TEST_PROGS_EXTENDED) $(TEST_FILES) $(TEST_GEN_MODS_DIR) $(OUTPUT); \
108	fi
109	@$(INSTALL_INCLUDES)
110	@if [ "X$(TEST_PROGS)" != "X" ]; then \
111		$(call RUN_TESTS, $(TEST_GEN_PROGS) $(TEST_CUSTOM_PROGS) \
112				  $(addprefix $(OUTPUT)/,$(TEST_PROGS))) ; \
113	else \
114		$(call RUN_TESTS, $(TEST_GEN_PROGS) $(TEST_CUSTOM_PROGS)); \
115	fi
116else
117	@$(call RUN_TESTS, $(TEST_GEN_PROGS) $(TEST_CUSTOM_PROGS) $(TEST_PROGS))
118endif
119
120gen_mods_dir:
121	$(Q)$(MAKE) -C $(TEST_GEN_MODS_DIR)
122
123clean_mods_dir:
124	$(Q)$(MAKE) -C $(TEST_GEN_MODS_DIR) clean
125
126define INSTALL_SINGLE_RULE
127	$(if $(INSTALL_LIST),@mkdir -p $(INSTALL_PATH))
128	$(if $(INSTALL_LIST),rsync -a --copy-unsafe-links $(INSTALL_LIST) $(INSTALL_PATH)/)
129endef
130
131define INSTALL_MODS_RULE
132	$(if $(INSTALL_LIST),@mkdir -p $(INSTALL_PATH)/$(INSTALL_LIST))
133	$(if $(INSTALL_LIST),rsync -a --copy-unsafe-links $(INSTALL_LIST)/*.ko $(INSTALL_PATH)/$(INSTALL_LIST))
134endef
135
136define INSTALL_RULE
137	$(eval INSTALL_LIST = $(TEST_PROGS)) $(INSTALL_SINGLE_RULE)
138	$(eval INSTALL_LIST = $(TEST_PROGS_EXTENDED)) $(INSTALL_SINGLE_RULE)
139	$(eval INSTALL_LIST = $(TEST_FILES)) $(INSTALL_SINGLE_RULE)
140	$(eval INSTALL_LIST = $(TEST_GEN_PROGS)) $(INSTALL_SINGLE_RULE)
141	$(eval INSTALL_LIST = $(TEST_CUSTOM_PROGS)) $(INSTALL_SINGLE_RULE)
142	$(eval INSTALL_LIST = $(TEST_GEN_PROGS_EXTENDED)) $(INSTALL_SINGLE_RULE)
143	$(eval INSTALL_LIST = $(TEST_GEN_FILES)) $(INSTALL_SINGLE_RULE)
144	$(eval INSTALL_LIST = $(notdir $(TEST_GEN_MODS_DIR))) $(INSTALL_MODS_RULE)
145	$(eval INSTALL_LIST = $(wildcard config settings)) $(INSTALL_SINGLE_RULE)
146endef
147
148install: all
149ifdef INSTALL_PATH
150	$(INSTALL_RULE)
151	$(INSTALL_INCLUDES)
152else
153	$(error Error: set INSTALL_PATH to use install)
154endif
155
156emit_tests:
157	for TEST in $(TEST_GEN_PROGS) $(TEST_CUSTOM_PROGS) $(TEST_PROGS); do \
158		BASENAME_TEST=`basename $$TEST`;	\
159		echo "$(COLLECTION):$$BASENAME_TEST";	\
160	done
161
162# define if isn't already. It is undefined in make O= case.
163ifeq ($(RM),)
164RM := rm -f
165endif
166
167define CLEAN
168	$(RM) -r $(TEST_GEN_PROGS) $(TEST_GEN_PROGS_EXTENDED) $(TEST_GEN_FILES) $(EXTRA_CLEAN)
169endef
170
171clean: $(if $(TEST_GEN_MODS_DIR),clean_mods_dir)
172	$(CLEAN)
173
174# Enables to extend CFLAGS and LDFLAGS from command line, e.g.
175# make USERCFLAGS=-Werror USERLDFLAGS=-static
176CFLAGS += $(USERCFLAGS)
177LDFLAGS += $(USERLDFLAGS)
178
179# When make O= with kselftest target from main level
180# the following aren't defined.
181#
182ifdef building_out_of_srctree
183LINK.c = $(CC) $(CFLAGS) $(CPPFLAGS) $(LDFLAGS) $(TARGET_ARCH)
184COMPILE.S = $(CC) $(ASFLAGS) $(CPPFLAGS) $(TARGET_ARCH) -c
185LINK.S = $(CC) $(ASFLAGS) $(CPPFLAGS) $(LDFLAGS) $(TARGET_ARCH)
186endif
187
188# Selftest makefiles can override those targets by setting
189# OVERRIDE_TARGETS = 1.
190ifeq ($(OVERRIDE_TARGETS),)
191LOCAL_HDRS += $(selfdir)/kselftest_harness.h $(selfdir)/kselftest.h
192$(OUTPUT)/%:%.c $(LOCAL_HDRS)
193	$(call msg,CC,,$@)
194	$(Q)$(LINK.c) $(filter-out $(LOCAL_HDRS),$^) $(LDLIBS) -o $@
195
196$(OUTPUT)/%.o:%.S
197	$(COMPILE.S) $^ -o $@
198
199$(OUTPUT)/%:%.S
200	$(LINK.S) $^ $(LDLIBS) -o $@
201endif
202
203.PHONY: run_tests all clean install emit_tests gen_mods_dir clean_mods_dir
204