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