xref: /linux/tools/testing/selftests/Makefile (revision bbcf9cd1576752ebe8d618ad8c6500b7e262ffac)
1# SPDX-License-Identifier: GPL-2.0
2TARGETS = android
3TARGETS += arm64
4TARGETS += bpf
5TARGETS += breakpoints
6TARGETS += capabilities
7TARGETS += cgroup
8TARGETS += clone3
9TARGETS += core
10TARGETS += cpufreq
11TARGETS += cpu-hotplug
12TARGETS += drivers/dma-buf
13TARGETS += efivarfs
14TARGETS += exec
15TARGETS += filesystems
16TARGETS += filesystems/binderfs
17TARGETS += filesystems/epoll
18TARGETS += firmware
19TARGETS += fpu
20TARGETS += ftrace
21TARGETS += futex
22TARGETS += gpio
23TARGETS += intel_pstate
24TARGETS += ipc
25TARGETS += ir
26TARGETS += kcmp
27TARGETS += kexec
28TARGETS += kvm
29TARGETS += lib
30TARGETS += livepatch
31TARGETS += lkdtm
32TARGETS += membarrier
33TARGETS += memfd
34TARGETS += memory-hotplug
35TARGETS += mount
36TARGETS += mqueue
37TARGETS += net
38TARGETS += net/forwarding
39TARGETS += net/mptcp
40TARGETS += netfilter
41TARGETS += nsfs
42TARGETS += pidfd
43TARGETS += pid_namespace
44TARGETS += powerpc
45TARGETS += proc
46TARGETS += pstore
47TARGETS += ptrace
48TARGETS += openat2
49TARGETS += rseq
50TARGETS += rtc
51TARGETS += seccomp
52TARGETS += sigaltstack
53TARGETS += size
54TARGETS += sparc64
55TARGETS += splice
56TARGETS += static_keys
57TARGETS += sync
58TARGETS += sysctl
59TARGETS += tc-testing
60TARGETS += timens
61ifneq (1, $(quicktest))
62TARGETS += timers
63endif
64TARGETS += tmpfs
65TARGETS += tpm2
66TARGETS += user
67TARGETS += vm
68TARGETS += x86
69TARGETS += zram
70#Please keep the TARGETS list alphabetically sorted
71# Run "make quicktest=1 run_tests" or
72# "make quicktest=1 kselftest" from top level Makefile
73
74TARGETS_HOTPLUG = cpu-hotplug
75TARGETS_HOTPLUG += memory-hotplug
76
77# User can optionally provide a TARGETS skiplist.
78SKIP_TARGETS ?=
79ifneq ($(SKIP_TARGETS),)
80	TMP := $(filter-out $(SKIP_TARGETS), $(TARGETS))
81	override TARGETS := $(TMP)
82endif
83
84# User can set FORCE_TARGETS to 1 to require all targets to be successfully
85# built; make will fail if any of the targets cannot be built. If
86# FORCE_TARGETS is not set (the default), make will succeed if at least one
87# of the targets gets built.
88FORCE_TARGETS ?=
89
90# Clear LDFLAGS and MAKEFLAGS if called from main
91# Makefile to avoid test build failures when test
92# Makefile doesn't have explicit build rules.
93ifeq (1,$(MAKELEVEL))
94override LDFLAGS =
95override MAKEFLAGS =
96endif
97
98# Append kselftest to KBUILD_OUTPUT and O to avoid cluttering
99# KBUILD_OUTPUT with selftest objects and headers installed
100# by selftests Makefile or lib.mk.
101ifdef building_out_of_srctree
102override LDFLAGS =
103endif
104
105ifneq ($(O),)
106	BUILD := $(O)/kselftest
107else
108	ifneq ($(KBUILD_OUTPUT),)
109		BUILD := $(KBUILD_OUTPUT)/kselftest
110	else
111		BUILD := $(shell pwd)
112		DEFAULT_INSTALL_HDR_PATH := 1
113	endif
114endif
115
116# Prepare for headers install
117top_srcdir ?= ../../..
118include $(top_srcdir)/scripts/subarch.include
119ARCH           ?= $(SUBARCH)
120export KSFT_KHDR_INSTALL_DONE := 1
121export BUILD
122
123# build and run gpio when output directory is the src dir.
124# gpio has dependency on tools/gpio and builds tools/gpio
125# objects in the src directory in all cases making the src
126# repo dirty even when objects are relocated.
127ifneq (1,$(DEFAULT_INSTALL_HDR_PATH))
128	TMP := $(filter-out gpio, $(TARGETS))
129	TARGETS := $(TMP)
130endif
131
132# set default goal to all, so make without a target runs all, even when
133# all isn't the first target in the file.
134.DEFAULT_GOAL := all
135
136# Install headers here once for all tests. KSFT_KHDR_INSTALL_DONE
137# is used to avoid running headers_install from lib.mk.
138# Invoke headers install with --no-builtin-rules to avoid circular
139# dependency in "make kselftest" case. In this case, second level
140# make inherits builtin-rules which will use the rule generate
141# Makefile.o and runs into
142# "Circular Makefile.o <- prepare dependency dropped."
143# and headers_install fails and test compile fails.
144#
145# O= KBUILD_OUTPUT cases don't run into this error, since main Makefile
146# invokes them as sub-makes and --no-builtin-rules is not necessary,
147# but doesn't cause any failures. Keep it simple and use the same
148# flags in both cases.
149# Local build cases: "make kselftest", "make -C" - headers are installed
150# in the default INSTALL_HDR_PATH usr/include.
151khdr:
152ifeq (1,$(DEFAULT_INSTALL_HDR_PATH))
153	$(MAKE) --no-builtin-rules ARCH=$(ARCH) -C $(top_srcdir) headers_install
154else
155	$(MAKE) --no-builtin-rules INSTALL_HDR_PATH=$$BUILD/usr \
156		ARCH=$(ARCH) -C $(top_srcdir) headers_install
157endif
158
159all: khdr
160	@ret=1;							\
161	for TARGET in $(TARGETS); do				\
162		BUILD_TARGET=$$BUILD/$$TARGET;			\
163		mkdir $$BUILD_TARGET  -p;			\
164		$(MAKE) OUTPUT=$$BUILD_TARGET -C $$TARGET	\
165				$(if $(FORCE_TARGETS),|| exit);	\
166		ret=$$((ret * $$?));				\
167	done; exit $$ret;
168
169run_tests: all
170	@for TARGET in $(TARGETS); do \
171		BUILD_TARGET=$$BUILD/$$TARGET;	\
172		$(MAKE) OUTPUT=$$BUILD_TARGET -C $$TARGET run_tests;\
173	done;
174
175hotplug:
176	@for TARGET in $(TARGETS_HOTPLUG); do \
177		BUILD_TARGET=$$BUILD/$$TARGET;	\
178		$(MAKE) OUTPUT=$$BUILD_TARGET -C $$TARGET;\
179	done;
180
181run_hotplug: hotplug
182	@for TARGET in $(TARGETS_HOTPLUG); do \
183		BUILD_TARGET=$$BUILD/$$TARGET;	\
184		$(MAKE) OUTPUT=$$BUILD_TARGET -C $$TARGET run_full_test;\
185	done;
186
187clean_hotplug:
188	@for TARGET in $(TARGETS_HOTPLUG); do \
189		BUILD_TARGET=$$BUILD/$$TARGET;	\
190		$(MAKE) OUTPUT=$$BUILD_TARGET -C $$TARGET clean;\
191	done;
192
193run_pstore_crash:
194	$(MAKE) -C pstore run_crash
195
196# Use $BUILD as the default install root. $BUILD points to the
197# right output location for the following cases:
198# 1. output_dir=kernel_src
199# 2. a separate output directory is specified using O= KBUILD_OUTPUT
200# 3. a separate output directory is specified using KBUILD_OUTPUT
201# Avoid conflict with INSTALL_PATH set by the main Makefile
202#
203KSFT_INSTALL_PATH ?= $(BUILD)/kselftest_install
204KSFT_INSTALL_PATH := $(abspath $(KSFT_INSTALL_PATH))
205# Avoid changing the rest of the logic here and lib.mk.
206INSTALL_PATH := $(KSFT_INSTALL_PATH)
207ALL_SCRIPT := $(INSTALL_PATH)/run_kselftest.sh
208
209install: all
210ifdef INSTALL_PATH
211	@# Ask all targets to install their files
212	mkdir -p $(INSTALL_PATH)/kselftest
213	install -m 744 kselftest/module.sh $(INSTALL_PATH)/kselftest/
214	install -m 744 kselftest/runner.sh $(INSTALL_PATH)/kselftest/
215	install -m 744 kselftest/prefix.pl $(INSTALL_PATH)/kselftest/
216	@ret=1;	\
217	for TARGET in $(TARGETS); do \
218		BUILD_TARGET=$$BUILD/$$TARGET;	\
219		$(MAKE) OUTPUT=$$BUILD_TARGET -C $$TARGET INSTALL_PATH=$(INSTALL_PATH)/$$TARGET install \
220				$(if $(FORCE_TARGETS),|| exit);	\
221		ret=$$((ret * $$?));		\
222	done; exit $$ret;
223
224	@# Ask all targets to emit their test scripts
225	echo "#!/bin/sh" > $(ALL_SCRIPT)
226	echo "BASE_DIR=\$$(realpath \$$(dirname \$$0))" >> $(ALL_SCRIPT)
227	echo "cd \$$BASE_DIR" >> $(ALL_SCRIPT)
228	echo ". ./kselftest/runner.sh" >> $(ALL_SCRIPT)
229	echo "ROOT=\$$PWD" >> $(ALL_SCRIPT)
230	echo "if [ \"\$$1\" = \"--summary\" ]; then" >> $(ALL_SCRIPT)
231	echo "  logfile=\$$BASE_DIR/output.log" >> $(ALL_SCRIPT)
232	echo "  cat /dev/null > \$$logfile" >> $(ALL_SCRIPT)
233	echo "fi" >> $(ALL_SCRIPT)
234
235	@# While building run_kselftest.sh skip also non-existent TARGET dirs:
236	@# they could be the result of a build failure and should NOT be
237	@# included in the generated runlist.
238	for TARGET in $(TARGETS); do \
239		BUILD_TARGET=$$BUILD/$$TARGET;	\
240		[ ! -d $(INSTALL_PATH)/$$TARGET ] && echo "Skipping non-existent dir: $$TARGET" && continue; \
241		echo "[ -w /dev/kmsg ] && echo \"kselftest: Running tests in $$TARGET\" >> /dev/kmsg" >> $(ALL_SCRIPT); \
242		echo "cd $$TARGET" >> $(ALL_SCRIPT); \
243		echo -n "run_many" >> $(ALL_SCRIPT); \
244		echo -n "Emit Tests for $$TARGET\n"; \
245		$(MAKE) -s --no-print-directory OUTPUT=$$BUILD_TARGET -C $$TARGET emit_tests >> $(ALL_SCRIPT); \
246		echo "" >> $(ALL_SCRIPT);	    \
247		echo "cd \$$ROOT" >> $(ALL_SCRIPT); \
248	done;
249
250	chmod u+x $(ALL_SCRIPT)
251else
252	$(error Error: set INSTALL_PATH to use install)
253endif
254
255FORMAT ?= .gz
256TAR_PATH = $(abspath ${INSTALL_PATH}/kselftest-packages/kselftest.tar${FORMAT})
257gen_tar: install
258	@mkdir -p ${INSTALL_PATH}/kselftest-packages/
259	@tar caf ${TAR_PATH} --exclude=kselftest-packages -C ${INSTALL_PATH} .
260	@echo "Created ${TAR_PATH}"
261
262clean:
263	@for TARGET in $(TARGETS); do \
264		BUILD_TARGET=$$BUILD/$$TARGET;	\
265		$(MAKE) OUTPUT=$$BUILD_TARGET -C $$TARGET clean;\
266	done;
267
268.PHONY: khdr all run_tests hotplug run_hotplug clean_hotplug run_pstore_crash install clean gen_tar
269