xref: /linux/tools/testing/selftests/bpf/Makefile (revision 675f176b4dcc2b75adbcea7ba0e9a649527f53bd)
1# SPDX-License-Identifier: GPL-2.0
2include ../../../build/Build.include
3include ../../../scripts/Makefile.arch
4include ../../../scripts/Makefile.include
5
6CXX ?= $(CROSS_COMPILE)g++
7
8CURDIR := $(abspath .)
9TOOLSDIR := $(abspath ../../..)
10LIBDIR := $(TOOLSDIR)/lib
11BPFDIR := $(LIBDIR)/bpf
12TOOLSINCDIR := $(TOOLSDIR)/include
13BPFTOOLDIR := $(TOOLSDIR)/bpf/bpftool
14APIDIR := $(TOOLSINCDIR)/uapi
15GENDIR := $(abspath ../../../../include/generated)
16GENHDR := $(GENDIR)/autoconf.h
17HOSTPKG_CONFIG := pkg-config
18
19ifneq ($(wildcard $(GENHDR)),)
20  GENFLAGS := -DHAVE_GENHDR
21endif
22
23BPF_GCC		?= $(shell command -v bpf-gcc;)
24SAN_CFLAGS	?=
25SAN_LDFLAGS	?= $(SAN_CFLAGS)
26CFLAGS += -g -O0 -rdynamic -Wall -Werror $(GENFLAGS) $(SAN_CFLAGS)	\
27	  -I$(CURDIR) -I$(INCLUDE_DIR) -I$(GENDIR) -I$(LIBDIR)		\
28	  -I$(TOOLSINCDIR) -I$(APIDIR) -I$(OUTPUT)
29LDFLAGS += $(SAN_LDFLAGS)
30LDLIBS += -lelf -lz -lrt -lpthread
31
32# Silence some warnings when compiled with clang
33ifneq ($(LLVM),)
34CFLAGS += -Wno-unused-command-line-argument
35endif
36
37# Order correspond to 'make run_tests' order
38TEST_GEN_PROGS = test_verifier test_tag test_maps test_lru_map test_lpm_map test_progs \
39	test_verifier_log test_dev_cgroup \
40	test_sock test_sockmap get_cgroup_id_user \
41	test_cgroup_storage \
42	test_tcpnotify_user test_sysctl \
43	test_progs-no_alu32
44
45# Also test bpf-gcc, if present
46ifneq ($(BPF_GCC),)
47TEST_GEN_PROGS += test_progs-bpf_gcc
48endif
49
50TEST_GEN_FILES = test_lwt_ip_encap.bpf.o test_tc_edt.bpf.o
51TEST_FILES = xsk_prereqs.sh $(wildcard progs/btf_dump_test_case_*.c)
52
53# Order correspond to 'make run_tests' order
54TEST_PROGS := test_kmod.sh \
55	test_xdp_redirect.sh \
56	test_xdp_redirect_multi.sh \
57	test_xdp_meta.sh \
58	test_xdp_veth.sh \
59	test_offload.py \
60	test_sock_addr.sh \
61	test_tunnel.sh \
62	test_lwt_seg6local.sh \
63	test_lirc_mode2.sh \
64	test_skb_cgroup_id.sh \
65	test_flow_dissector.sh \
66	test_xdp_vlan_mode_generic.sh \
67	test_xdp_vlan_mode_native.sh \
68	test_lwt_ip_encap.sh \
69	test_tcp_check_syncookie.sh \
70	test_tc_tunnel.sh \
71	test_tc_edt.sh \
72	test_xdping.sh \
73	test_bpftool_build.sh \
74	test_bpftool.sh \
75	test_bpftool_metadata.sh \
76	test_doc_build.sh \
77	test_xsk.sh \
78	test_xdp_features.sh
79
80TEST_PROGS_EXTENDED := with_addr.sh \
81	with_tunnels.sh ima_setup.sh verify_sig_setup.sh \
82	test_xdp_vlan.sh test_bpftool.py
83
84# Compile but not part of 'make run_tests'
85TEST_GEN_PROGS_EXTENDED = test_sock_addr test_skb_cgroup_id_user \
86	flow_dissector_load test_flow_dissector test_tcp_check_syncookie_user \
87	test_lirc_mode2_user xdping test_cpp runqslower bench bpf_testmod.ko \
88	xskxceiver xdp_redirect_multi xdp_synproxy veristat xdp_hw_metadata \
89	xdp_features
90
91TEST_CUSTOM_PROGS = $(OUTPUT)/urandom_read $(OUTPUT)/sign-file
92TEST_GEN_FILES += liburandom_read.so
93
94# Emit succinct information message describing current building step
95# $1 - generic step name (e.g., CC, LINK, etc);
96# $2 - optional "flavor" specifier; if provided, will be emitted as [flavor];
97# $3 - target (assumed to be file); only file name will be emitted;
98# $4 - optional extra arg, emitted as-is, if provided.
99ifeq ($(V),1)
100Q =
101msg =
102else
103Q = @
104msg = @printf '  %-8s%s %s%s\n' "$(1)" "$(if $(2), [$(2)])" "$(notdir $(3))" "$(if $(4), $(4))";
105MAKEFLAGS += --no-print-directory
106submake_extras := feature_display=0
107endif
108
109# override lib.mk's default rules
110OVERRIDE_TARGETS := 1
111override define CLEAN
112	$(call msg,CLEAN)
113	$(Q)$(RM) -r $(TEST_GEN_PROGS)
114	$(Q)$(RM) -r $(TEST_GEN_PROGS_EXTENDED)
115	$(Q)$(RM) -r $(TEST_GEN_FILES)
116	$(Q)$(RM) -r $(EXTRA_CLEAN)
117	$(Q)$(MAKE) -C bpf_testmod clean
118	$(Q)$(MAKE) docs-clean
119endef
120
121include ../lib.mk
122
123SCRATCH_DIR := $(OUTPUT)/tools
124BUILD_DIR := $(SCRATCH_DIR)/build
125INCLUDE_DIR := $(SCRATCH_DIR)/include
126BPFOBJ := $(BUILD_DIR)/libbpf/libbpf.a
127ifneq ($(CROSS_COMPILE),)
128HOST_BUILD_DIR		:= $(BUILD_DIR)/host
129HOST_SCRATCH_DIR	:= $(OUTPUT)/host-tools
130HOST_INCLUDE_DIR	:= $(HOST_SCRATCH_DIR)/include
131else
132HOST_BUILD_DIR		:= $(BUILD_DIR)
133HOST_SCRATCH_DIR	:= $(SCRATCH_DIR)
134HOST_INCLUDE_DIR	:= $(INCLUDE_DIR)
135endif
136HOST_BPFOBJ := $(HOST_BUILD_DIR)/libbpf/libbpf.a
137RESOLVE_BTFIDS := $(HOST_BUILD_DIR)/resolve_btfids/resolve_btfids
138RUNQSLOWER_OUTPUT := $(BUILD_DIR)/runqslower/
139
140VMLINUX_BTF_PATHS ?= $(if $(O),$(O)/vmlinux)				\
141		     $(if $(KBUILD_OUTPUT),$(KBUILD_OUTPUT)/vmlinux)	\
142		     ../../../../vmlinux				\
143		     /sys/kernel/btf/vmlinux				\
144		     /boot/vmlinux-$(shell uname -r)
145VMLINUX_BTF ?= $(abspath $(firstword $(wildcard $(VMLINUX_BTF_PATHS))))
146ifeq ($(VMLINUX_BTF),)
147$(error Cannot find a vmlinux for VMLINUX_BTF at any of "$(VMLINUX_BTF_PATHS)")
148endif
149
150# Define simple and short `make test_progs`, `make test_sysctl`, etc targets
151# to build individual tests.
152# NOTE: Semicolon at the end is critical to override lib.mk's default static
153# rule for binaries.
154$(notdir $(TEST_GEN_PROGS)						\
155	 $(TEST_PROGS)							\
156	 $(TEST_PROGS_EXTENDED)						\
157	 $(TEST_GEN_PROGS_EXTENDED)					\
158	 $(TEST_CUSTOM_PROGS)): %: $(OUTPUT)/% ;
159
160# sort removes libbpf duplicates when not cross-building
161MAKE_DIRS := $(sort $(BUILD_DIR)/libbpf $(HOST_BUILD_DIR)/libbpf	       \
162	       $(HOST_BUILD_DIR)/bpftool $(HOST_BUILD_DIR)/resolve_btfids      \
163	       $(RUNQSLOWER_OUTPUT) $(INCLUDE_DIR))
164$(MAKE_DIRS):
165	$(call msg,MKDIR,,$@)
166	$(Q)mkdir -p $@
167
168$(OUTPUT)/%.o: %.c
169	$(call msg,CC,,$@)
170	$(Q)$(CC) $(CFLAGS) -c $(filter %.c,$^) $(LDLIBS) -o $@
171
172$(OUTPUT)/%:%.c
173	$(call msg,BINARY,,$@)
174	$(Q)$(LINK.c) $^ $(LDLIBS) -o $@
175
176# LLVM's ld.lld doesn't support all the architectures, so use it only on x86
177ifeq ($(SRCARCH),x86)
178LLD := lld
179else
180LLD := ld
181endif
182
183# Filter out -static for liburandom_read.so and its dependent targets so that static builds
184# do not fail. Static builds leave urandom_read relying on system-wide shared libraries.
185$(OUTPUT)/liburandom_read.so: urandom_read_lib1.c urandom_read_lib2.c
186	$(call msg,LIB,,$@)
187	$(Q)$(CLANG) $(filter-out -static,$(CFLAGS) $(LDFLAGS))   \
188		     $^ $(filter-out -static,$(LDLIBS))	     \
189		     -fuse-ld=$(LLD) -Wl,-znoseparate-code -Wl,--build-id=sha1 \
190		     -fPIC -shared -o $@
191
192$(OUTPUT)/urandom_read: urandom_read.c urandom_read_aux.c $(OUTPUT)/liburandom_read.so
193	$(call msg,BINARY,,$@)
194	$(Q)$(CLANG) $(filter-out -static,$(CFLAGS) $(LDFLAGS)) $(filter %.c,$^) \
195		     -lurandom_read $(filter-out -static,$(LDLIBS)) -L$(OUTPUT)  \
196		     -fuse-ld=$(LLD) -Wl,-znoseparate-code -Wl,--build-id=sha1 \
197		     -Wl,-rpath=. -o $@
198
199$(OUTPUT)/sign-file: ../../../../scripts/sign-file.c
200	$(call msg,SIGN-FILE,,$@)
201	$(Q)$(CC) $(shell $(HOSTPKG_CONFIG)--cflags libcrypto 2> /dev/null) \
202		  $< -o $@ \
203		  $(shell $(HOSTPKG_CONFIG) --libs libcrypto 2> /dev/null || echo -lcrypto)
204
205$(OUTPUT)/bpf_testmod.ko: $(VMLINUX_BTF) $(wildcard bpf_testmod/Makefile bpf_testmod/*.[ch])
206	$(call msg,MOD,,$@)
207	$(Q)$(RM) bpf_testmod/bpf_testmod.ko # force re-compilation
208	$(Q)$(MAKE) $(submake_extras) RESOLVE_BTFIDS=$(RESOLVE_BTFIDS) -C bpf_testmod
209	$(Q)cp bpf_testmod/bpf_testmod.ko $@
210
211DEFAULT_BPFTOOL := $(HOST_SCRATCH_DIR)/sbin/bpftool
212
213$(OUTPUT)/runqslower: $(BPFOBJ) | $(DEFAULT_BPFTOOL) $(RUNQSLOWER_OUTPUT)
214	$(Q)$(MAKE) $(submake_extras) -C $(TOOLSDIR)/bpf/runqslower	       \
215		    OUTPUT=$(RUNQSLOWER_OUTPUT) VMLINUX_BTF=$(VMLINUX_BTF)     \
216		    BPFTOOL_OUTPUT=$(HOST_BUILD_DIR)/bpftool/		       \
217		    BPFOBJ_OUTPUT=$(BUILD_DIR)/libbpf			       \
218		    BPFOBJ=$(BPFOBJ) BPF_INCLUDE=$(INCLUDE_DIR)		       \
219		    EXTRA_CFLAGS='-g -O0 $(SAN_CFLAGS)'			       \
220		    EXTRA_LDFLAGS='$(SAN_LDFLAGS)' &&			       \
221		    cp $(RUNQSLOWER_OUTPUT)runqslower $@
222
223TEST_GEN_PROGS_EXTENDED += $(DEFAULT_BPFTOOL)
224
225$(TEST_GEN_PROGS) $(TEST_GEN_PROGS_EXTENDED): $(BPFOBJ)
226
227CGROUP_HELPERS	:= $(OUTPUT)/cgroup_helpers.o
228TESTING_HELPERS	:= $(OUTPUT)/testing_helpers.o
229TRACE_HELPERS	:= $(OUTPUT)/trace_helpers.o
230CAP_HELPERS	:= $(OUTPUT)/cap_helpers.o
231
232$(OUTPUT)/test_dev_cgroup: $(CGROUP_HELPERS) $(TESTING_HELPERS)
233$(OUTPUT)/test_skb_cgroup_id_user: $(CGROUP_HELPERS) $(TESTING_HELPERS)
234$(OUTPUT)/test_sock: $(CGROUP_HELPERS) $(TESTING_HELPERS)
235$(OUTPUT)/test_sock_addr: $(CGROUP_HELPERS) $(TESTING_HELPERS)
236$(OUTPUT)/test_sockmap: $(CGROUP_HELPERS) $(TESTING_HELPERS)
237$(OUTPUT)/test_tcpnotify_user: $(CGROUP_HELPERS) $(TESTING_HELPERS) $(TRACE_HELPERS)
238$(OUTPUT)/get_cgroup_id_user: $(CGROUP_HELPERS) $(TESTING_HELPERS)
239$(OUTPUT)/test_cgroup_storage: $(CGROUP_HELPERS) $(TESTING_HELPERS)
240$(OUTPUT)/test_sock_fields: $(CGROUP_HELPERS) $(TESTING_HELPERS)
241$(OUTPUT)/test_sysctl: $(CGROUP_HELPERS) $(TESTING_HELPERS)
242$(OUTPUT)/test_tag: $(TESTING_HELPERS)
243$(OUTPUT)/test_lirc_mode2_user: $(TESTING_HELPERS)
244$(OUTPUT)/xdping: $(TESTING_HELPERS)
245$(OUTPUT)/flow_dissector_load: $(TESTING_HELPERS)
246$(OUTPUT)/test_maps: $(TESTING_HELPERS)
247$(OUTPUT)/test_verifier: $(TESTING_HELPERS) $(CAP_HELPERS)
248$(OUTPUT)/xsk.o: $(BPFOBJ)
249
250BPFTOOL ?= $(DEFAULT_BPFTOOL)
251$(DEFAULT_BPFTOOL): $(wildcard $(BPFTOOLDIR)/*.[ch] $(BPFTOOLDIR)/Makefile)    \
252		    $(HOST_BPFOBJ) | $(HOST_BUILD_DIR)/bpftool
253	$(Q)$(MAKE) $(submake_extras)  -C $(BPFTOOLDIR)			       \
254		    ARCH= CROSS_COMPILE= CC="$(HOSTCC)" LD="$(HOSTLD)" 	       \
255		    EXTRA_CFLAGS='-g -O0'				       \
256		    OUTPUT=$(HOST_BUILD_DIR)/bpftool/			       \
257		    LIBBPF_OUTPUT=$(HOST_BUILD_DIR)/libbpf/		       \
258		    LIBBPF_DESTDIR=$(HOST_SCRATCH_DIR)/			       \
259		    prefix= DESTDIR=$(HOST_SCRATCH_DIR)/ install-bin
260
261all: docs
262
263docs:
264	$(Q)RST2MAN_OPTS="--exit-status=1" $(MAKE) $(submake_extras)	\
265	            -f Makefile.docs					\
266	            prefix= OUTPUT=$(OUTPUT)/ DESTDIR=$(OUTPUT)/ $@
267
268docs-clean:
269	$(Q)$(MAKE) $(submake_extras)					\
270	            -f Makefile.docs					\
271	            prefix= OUTPUT=$(OUTPUT)/ DESTDIR=$(OUTPUT)/ $@
272
273$(BPFOBJ): $(wildcard $(BPFDIR)/*.[ch] $(BPFDIR)/Makefile)		       \
274	   $(APIDIR)/linux/bpf.h					       \
275	   | $(BUILD_DIR)/libbpf
276	$(Q)$(MAKE) $(submake_extras) -C $(BPFDIR) OUTPUT=$(BUILD_DIR)/libbpf/ \
277		    EXTRA_CFLAGS='-g -O0 $(SAN_CFLAGS)'			       \
278		    EXTRA_LDFLAGS='$(SAN_LDFLAGS)'			       \
279		    DESTDIR=$(SCRATCH_DIR) prefix= all install_headers
280
281ifneq ($(BPFOBJ),$(HOST_BPFOBJ))
282$(HOST_BPFOBJ): $(wildcard $(BPFDIR)/*.[ch] $(BPFDIR)/Makefile)		       \
283		$(APIDIR)/linux/bpf.h					       \
284		| $(HOST_BUILD_DIR)/libbpf
285	$(Q)$(MAKE) $(submake_extras) -C $(BPFDIR)                             \
286		    EXTRA_CFLAGS='-g -O0' ARCH= CROSS_COMPILE=		       \
287		    OUTPUT=$(HOST_BUILD_DIR)/libbpf/			       \
288		    CC="$(HOSTCC)" LD="$(HOSTLD)"			       \
289		    DESTDIR=$(HOST_SCRATCH_DIR)/ prefix= all install_headers
290endif
291
292$(INCLUDE_DIR)/vmlinux.h: $(VMLINUX_BTF) $(BPFTOOL) | $(INCLUDE_DIR)
293ifeq ($(VMLINUX_H),)
294	$(call msg,GEN,,$@)
295	$(Q)$(BPFTOOL) btf dump file $(VMLINUX_BTF) format c > $@
296else
297	$(call msg,CP,,$@)
298	$(Q)cp "$(VMLINUX_H)" $@
299endif
300
301$(RESOLVE_BTFIDS): $(HOST_BPFOBJ) | $(HOST_BUILD_DIR)/resolve_btfids	\
302		       $(TOOLSDIR)/bpf/resolve_btfids/main.c	\
303		       $(TOOLSDIR)/lib/rbtree.c			\
304		       $(TOOLSDIR)/lib/zalloc.c			\
305		       $(TOOLSDIR)/lib/string.c			\
306		       $(TOOLSDIR)/lib/ctype.c			\
307		       $(TOOLSDIR)/lib/str_error_r.c
308	$(Q)$(MAKE) $(submake_extras) -C $(TOOLSDIR)/bpf/resolve_btfids	\
309		CC="$(HOSTCC)" LD="$(HOSTLD)" AR="$(HOSTAR)" \
310		LIBBPF_INCLUDE=$(HOST_INCLUDE_DIR) \
311		OUTPUT=$(HOST_BUILD_DIR)/resolve_btfids/ BPFOBJ=$(HOST_BPFOBJ)
312
313# Get Clang's default includes on this system, as opposed to those seen by
314# '-target bpf'. This fixes "missing" files on some architectures/distros,
315# such as asm/byteorder.h, asm/socket.h, asm/sockios.h, sys/cdefs.h etc.
316#
317# Use '-idirafter': Don't interfere with include mechanics except where the
318# build would have failed anyways.
319define get_sys_includes
320$(shell $(1) $(2) -v -E - </dev/null 2>&1 \
321	| sed -n '/<...> search starts here:/,/End of search list./{ s| \(/.*\)|-idirafter \1|p }') \
322$(shell $(1) $(2) -dM -E - </dev/null | grep '__riscv_xlen ' | awk '{printf("-D__riscv_xlen=%d -D__BITS_PER_LONG=%d", $$3, $$3)}')
323endef
324
325# Determine target endianness.
326IS_LITTLE_ENDIAN = $(shell $(CC) -dM -E - </dev/null | \
327			grep 'define __BYTE_ORDER__ __ORDER_LITTLE_ENDIAN__')
328MENDIAN=$(if $(IS_LITTLE_ENDIAN),-mlittle-endian,-mbig-endian)
329
330ifneq ($(CROSS_COMPILE),)
331CLANG_TARGET_ARCH = --target=$(notdir $(CROSS_COMPILE:%-=%))
332endif
333
334CLANG_SYS_INCLUDES = $(call get_sys_includes,$(CLANG),$(CLANG_TARGET_ARCH))
335BPF_CFLAGS = -g -Werror -D__TARGET_ARCH_$(SRCARCH) $(MENDIAN) 		\
336	     -I$(INCLUDE_DIR) -I$(CURDIR) -I$(APIDIR)			\
337	     -I$(abspath $(OUTPUT)/../usr/include)
338
339CLANG_CFLAGS = $(CLANG_SYS_INCLUDES) \
340	       -Wno-compare-distinct-pointer-types
341
342$(OUTPUT)/test_l4lb_noinline.o: BPF_CFLAGS += -fno-inline
343$(OUTPUT)/test_xdp_noinline.o: BPF_CFLAGS += -fno-inline
344
345$(OUTPUT)/flow_dissector_load.o: flow_dissector_load.h
346$(OUTPUT)/cgroup_getset_retval_hooks.o: cgroup_getset_retval_hooks.h
347
348# Build BPF object using Clang
349# $1 - input .c file
350# $2 - output .o file
351# $3 - CFLAGS
352define CLANG_BPF_BUILD_RULE
353	$(call msg,CLNG-BPF,$(TRUNNER_BINARY),$2)
354	$(Q)$(CLANG) $3 -O2 -target bpf -c $1 -mcpu=v3 -o $2
355endef
356# Similar to CLANG_BPF_BUILD_RULE, but with disabled alu32
357define CLANG_NOALU32_BPF_BUILD_RULE
358	$(call msg,CLNG-BPF,$(TRUNNER_BINARY),$2)
359	$(Q)$(CLANG) $3 -O2 -target bpf -c $1 -mcpu=v2 -o $2
360endef
361# Build BPF object using GCC
362define GCC_BPF_BUILD_RULE
363	$(call msg,GCC-BPF,$(TRUNNER_BINARY),$2)
364	$(Q)$(BPF_GCC) $3 -O2 -c $1 -o $2
365endef
366
367SKEL_BLACKLIST := btf__% test_pinning_invalid.c test_sk_assign.c
368
369LINKED_SKELS := test_static_linked.skel.h linked_funcs.skel.h		\
370		linked_vars.skel.h linked_maps.skel.h 			\
371		test_subskeleton.skel.h test_subskeleton_lib.skel.h	\
372		test_usdt.skel.h
373
374LSKELS := fentry_test.c fexit_test.c fexit_sleep.c atomics.c 		\
375	trace_printk.c trace_vprintk.c map_ptr_kern.c 			\
376	core_kern.c core_kern_overflow.c test_ringbuf.c			\
377	test_ringbuf_map_key.c
378
379# Generate both light skeleton and libbpf skeleton for these
380LSKELS_EXTRA := test_ksyms_module.c test_ksyms_weak.c kfunc_call_test.c \
381	kfunc_call_test_subprog.c
382SKEL_BLACKLIST += $$(LSKELS)
383
384test_static_linked.skel.h-deps := test_static_linked1.bpf.o test_static_linked2.bpf.o
385linked_funcs.skel.h-deps := linked_funcs1.bpf.o linked_funcs2.bpf.o
386linked_vars.skel.h-deps := linked_vars1.bpf.o linked_vars2.bpf.o
387linked_maps.skel.h-deps := linked_maps1.bpf.o linked_maps2.bpf.o
388# In the subskeleton case, we want the test_subskeleton_lib.subskel.h file
389# but that's created as a side-effect of the skel.h generation.
390test_subskeleton.skel.h-deps := test_subskeleton_lib2.bpf.o test_subskeleton_lib.bpf.o test_subskeleton.bpf.o
391test_subskeleton_lib.skel.h-deps := test_subskeleton_lib2.bpf.o test_subskeleton_lib.bpf.o
392test_usdt.skel.h-deps := test_usdt.bpf.o test_usdt_multispec.bpf.o
393xsk_xdp_progs.skel.h-deps := xsk_xdp_progs.bpf.o
394xdp_hw_metadata.skel.h-deps := xdp_hw_metadata.bpf.o
395xdp_features.skel.h-deps := xdp_features.bpf.o
396
397LINKED_BPF_SRCS := $(patsubst %.bpf.o,%.c,$(foreach skel,$(LINKED_SKELS),$($(skel)-deps)))
398
399# Set up extra TRUNNER_XXX "temporary" variables in the environment (relies on
400# $eval()) and pass control to DEFINE_TEST_RUNNER_RULES.
401# Parameters:
402# $1 - test runner base binary name (e.g., test_progs)
403# $2 - test runner extra "flavor" (e.g., no_alu32, gcc-bpf, etc)
404define DEFINE_TEST_RUNNER
405
406TRUNNER_OUTPUT := $(OUTPUT)$(if $2,/)$2
407TRUNNER_BINARY := $1$(if $2,-)$2
408TRUNNER_TEST_OBJS := $$(patsubst %.c,$$(TRUNNER_OUTPUT)/%.test.o,	\
409				 $$(notdir $$(wildcard $(TRUNNER_TESTS_DIR)/*.c)))
410TRUNNER_EXTRA_OBJS := $$(patsubst %.c,$$(TRUNNER_OUTPUT)/%.o,		\
411				 $$(filter %.c,$(TRUNNER_EXTRA_SOURCES)))
412TRUNNER_EXTRA_HDRS := $$(filter %.h,$(TRUNNER_EXTRA_SOURCES))
413TRUNNER_TESTS_HDR := $(TRUNNER_TESTS_DIR)/tests.h
414TRUNNER_BPF_SRCS := $$(notdir $$(wildcard $(TRUNNER_BPF_PROGS_DIR)/*.c))
415TRUNNER_BPF_OBJS := $$(patsubst %.c,$$(TRUNNER_OUTPUT)/%.bpf.o, $$(TRUNNER_BPF_SRCS))
416TRUNNER_BPF_SKELS := $$(patsubst %.c,$$(TRUNNER_OUTPUT)/%.skel.h,	\
417				 $$(filter-out $(SKEL_BLACKLIST) $(LINKED_BPF_SRCS),\
418					       $$(TRUNNER_BPF_SRCS)))
419TRUNNER_BPF_LSKELS := $$(patsubst %.c,$$(TRUNNER_OUTPUT)/%.lskel.h, $$(LSKELS) $$(LSKELS_EXTRA))
420TRUNNER_BPF_SKELS_LINKED := $$(addprefix $$(TRUNNER_OUTPUT)/,$(LINKED_SKELS))
421TEST_GEN_FILES += $$(TRUNNER_BPF_OBJS)
422
423# Evaluate rules now with extra TRUNNER_XXX variables above already defined
424$$(eval $$(call DEFINE_TEST_RUNNER_RULES,$1,$2))
425
426endef
427
428# Using TRUNNER_XXX variables, provided by callers of DEFINE_TEST_RUNNER and
429# set up by DEFINE_TEST_RUNNER itself, create test runner build rules with:
430# $1 - test runner base binary name (e.g., test_progs)
431# $2 - test runner extra "flavor" (e.g., no_alu32, gcc-bpf, etc)
432define DEFINE_TEST_RUNNER_RULES
433
434ifeq ($($(TRUNNER_OUTPUT)-dir),)
435$(TRUNNER_OUTPUT)-dir := y
436$(TRUNNER_OUTPUT):
437	$$(call msg,MKDIR,,$$@)
438	$(Q)mkdir -p $$@
439endif
440
441# ensure we set up BPF objects generation rule just once for a given
442# input/output directory combination
443ifeq ($($(TRUNNER_BPF_PROGS_DIR)$(if $2,-)$2-bpfobjs),)
444$(TRUNNER_BPF_PROGS_DIR)$(if $2,-)$2-bpfobjs := y
445$(TRUNNER_BPF_OBJS): $(TRUNNER_OUTPUT)/%.bpf.o:				\
446		     $(TRUNNER_BPF_PROGS_DIR)/%.c			\
447		     $(TRUNNER_BPF_PROGS_DIR)/*.h			\
448		     $$(INCLUDE_DIR)/vmlinux.h				\
449		     $(wildcard $(BPFDIR)/bpf_*.h)			\
450		     $(wildcard $(BPFDIR)/*.bpf.h)			\
451		     | $(TRUNNER_OUTPUT) $$(BPFOBJ)
452	$$(call $(TRUNNER_BPF_BUILD_RULE),$$<,$$@,			\
453					  $(TRUNNER_BPF_CFLAGS))
454
455$(TRUNNER_BPF_SKELS): %.skel.h: %.bpf.o $(BPFTOOL) | $(TRUNNER_OUTPUT)
456	$$(call msg,GEN-SKEL,$(TRUNNER_BINARY),$$@)
457	$(Q)$$(BPFTOOL) gen object $$(<:.o=.linked1.o) $$<
458	$(Q)$$(BPFTOOL) gen object $$(<:.o=.linked2.o) $$(<:.o=.linked1.o)
459	$(Q)$$(BPFTOOL) gen object $$(<:.o=.linked3.o) $$(<:.o=.linked2.o)
460	$(Q)diff $$(<:.o=.linked2.o) $$(<:.o=.linked3.o)
461	$(Q)$$(BPFTOOL) gen skeleton $$(<:.o=.linked3.o) name $$(notdir $$(<:.bpf.o=)) > $$@
462	$(Q)$$(BPFTOOL) gen subskeleton $$(<:.o=.linked3.o) name $$(notdir $$(<:.bpf.o=)) > $$(@:.skel.h=.subskel.h)
463
464$(TRUNNER_BPF_LSKELS): %.lskel.h: %.bpf.o $(BPFTOOL) | $(TRUNNER_OUTPUT)
465	$$(call msg,GEN-SKEL,$(TRUNNER_BINARY),$$@)
466	$(Q)$$(BPFTOOL) gen object $$(<:.o=.llinked1.o) $$<
467	$(Q)$$(BPFTOOL) gen object $$(<:.o=.llinked2.o) $$(<:.o=.llinked1.o)
468	$(Q)$$(BPFTOOL) gen object $$(<:.o=.llinked3.o) $$(<:.o=.llinked2.o)
469	$(Q)diff $$(<:.o=.llinked2.o) $$(<:.o=.llinked3.o)
470	$(Q)$$(BPFTOOL) gen skeleton -L $$(<:.o=.llinked3.o) name $$(notdir $$(<:.bpf.o=_lskel)) > $$@
471
472$(TRUNNER_BPF_SKELS_LINKED): $(TRUNNER_BPF_OBJS) $(BPFTOOL) | $(TRUNNER_OUTPUT)
473	$$(call msg,LINK-BPF,$(TRUNNER_BINARY),$$(@:.skel.h=.bpf.o))
474	$(Q)$$(BPFTOOL) gen object $$(@:.skel.h=.linked1.o) $$(addprefix $(TRUNNER_OUTPUT)/,$$($$(@F)-deps))
475	$(Q)$$(BPFTOOL) gen object $$(@:.skel.h=.linked2.o) $$(@:.skel.h=.linked1.o)
476	$(Q)$$(BPFTOOL) gen object $$(@:.skel.h=.linked3.o) $$(@:.skel.h=.linked2.o)
477	$(Q)diff $$(@:.skel.h=.linked2.o) $$(@:.skel.h=.linked3.o)
478	$$(call msg,GEN-SKEL,$(TRUNNER_BINARY),$$@)
479	$(Q)$$(BPFTOOL) gen skeleton $$(@:.skel.h=.linked3.o) name $$(notdir $$(@:.skel.h=)) > $$@
480	$(Q)$$(BPFTOOL) gen subskeleton $$(@:.skel.h=.linked3.o) name $$(notdir $$(@:.skel.h=)) > $$(@:.skel.h=.subskel.h)
481endif
482
483# ensure we set up tests.h header generation rule just once
484ifeq ($($(TRUNNER_TESTS_DIR)-tests-hdr),)
485$(TRUNNER_TESTS_DIR)-tests-hdr := y
486$(TRUNNER_TESTS_HDR): $(TRUNNER_TESTS_DIR)/*.c
487	$$(call msg,TEST-HDR,$(TRUNNER_BINARY),$$@)
488	$$(shell (echo '/* Generated header, do not edit */';					\
489		  sed -n -E 's/^void (serial_)?test_([a-zA-Z0-9_]+)\((void)?\).*/DEFINE_TEST(\2)/p'	\
490			$(TRUNNER_TESTS_DIR)/*.c | sort ;	\
491		 ) > $$@)
492endif
493
494# compile individual test files
495# Note: we cd into output directory to ensure embedded BPF object is found
496$(TRUNNER_TEST_OBJS): $(TRUNNER_OUTPUT)/%.test.o:			\
497		      $(TRUNNER_TESTS_DIR)/%.c				\
498		      $(TRUNNER_EXTRA_HDRS)				\
499		      $(TRUNNER_BPF_OBJS)				\
500		      $(TRUNNER_BPF_SKELS)				\
501		      $(TRUNNER_BPF_LSKELS)				\
502		      $(TRUNNER_BPF_SKELS_LINKED)			\
503		      $$(BPFOBJ) | $(TRUNNER_OUTPUT)
504	$$(call msg,TEST-OBJ,$(TRUNNER_BINARY),$$@)
505	$(Q)cd $$(@D) && $$(CC) -I. $$(CFLAGS) -c $(CURDIR)/$$< $$(LDLIBS) -o $$(@F)
506
507$(TRUNNER_EXTRA_OBJS): $(TRUNNER_OUTPUT)/%.o:				\
508		       %.c						\
509		       $(TRUNNER_EXTRA_HDRS)				\
510		       $(TRUNNER_TESTS_HDR)				\
511		       $$(BPFOBJ) | $(TRUNNER_OUTPUT)
512	$$(call msg,EXT-OBJ,$(TRUNNER_BINARY),$$@)
513	$(Q)$$(CC) $$(CFLAGS) -c $$< $$(LDLIBS) -o $$@
514
515# non-flavored in-srctree builds receive special treatment, in particular, we
516# do not need to copy extra resources (see e.g. test_btf_dump_case())
517$(TRUNNER_BINARY)-extras: $(TRUNNER_EXTRA_FILES) | $(TRUNNER_OUTPUT)
518ifneq ($2:$(OUTPUT),:$(shell pwd))
519	$$(call msg,EXT-COPY,$(TRUNNER_BINARY),$(TRUNNER_EXTRA_FILES))
520	$(Q)rsync -aq $$^ $(TRUNNER_OUTPUT)/
521endif
522
523$(OUTPUT)/$(TRUNNER_BINARY): $(TRUNNER_TEST_OBJS)			\
524			     $(TRUNNER_EXTRA_OBJS) $$(BPFOBJ)		\
525			     $(RESOLVE_BTFIDS)				\
526			     | $(TRUNNER_BINARY)-extras
527	$$(call msg,BINARY,,$$@)
528	$(Q)$$(CC) $$(CFLAGS) $$(filter %.a %.o,$$^) $$(LDLIBS) -o $$@
529	$(Q)$(RESOLVE_BTFIDS) --btf $(TRUNNER_OUTPUT)/btf_data.bpf.o $$@
530	$(Q)ln -sf $(if $2,..,.)/tools/build/bpftool/bootstrap/bpftool \
531		   $(OUTPUT)/$(if $2,$2/)bpftool
532
533endef
534
535# Define test_progs test runner.
536TRUNNER_TESTS_DIR := prog_tests
537TRUNNER_BPF_PROGS_DIR := progs
538TRUNNER_EXTRA_SOURCES := test_progs.c cgroup_helpers.c trace_helpers.c	\
539			 network_helpers.c testing_helpers.c		\
540			 btf_helpers.c flow_dissector_load.h		\
541			 cap_helpers.c test_loader.c xsk.c
542TRUNNER_EXTRA_FILES := $(OUTPUT)/urandom_read $(OUTPUT)/bpf_testmod.ko	\
543		       $(OUTPUT)/liburandom_read.so			\
544		       $(OUTPUT)/xdp_synproxy				\
545		       $(OUTPUT)/sign-file				\
546		       ima_setup.sh 					\
547		       verify_sig_setup.sh				\
548		       $(wildcard progs/btf_dump_test_case_*.c)		\
549		       $(wildcard progs/*.bpf.o)
550TRUNNER_BPF_BUILD_RULE := CLANG_BPF_BUILD_RULE
551TRUNNER_BPF_CFLAGS := $(BPF_CFLAGS) $(CLANG_CFLAGS) -DENABLE_ATOMICS_TESTS
552$(eval $(call DEFINE_TEST_RUNNER,test_progs))
553
554# Define test_progs-no_alu32 test runner.
555TRUNNER_BPF_BUILD_RULE := CLANG_NOALU32_BPF_BUILD_RULE
556TRUNNER_BPF_CFLAGS := $(BPF_CFLAGS) $(CLANG_CFLAGS)
557$(eval $(call DEFINE_TEST_RUNNER,test_progs,no_alu32))
558
559# Define test_progs BPF-GCC-flavored test runner.
560ifneq ($(BPF_GCC),)
561TRUNNER_BPF_BUILD_RULE := GCC_BPF_BUILD_RULE
562TRUNNER_BPF_CFLAGS := $(BPF_CFLAGS) $(call get_sys_includes,gcc,)
563$(eval $(call DEFINE_TEST_RUNNER,test_progs,bpf_gcc))
564endif
565
566# Define test_maps test runner.
567TRUNNER_TESTS_DIR := map_tests
568TRUNNER_BPF_PROGS_DIR := progs
569TRUNNER_EXTRA_SOURCES := test_maps.c
570TRUNNER_EXTRA_FILES :=
571TRUNNER_BPF_BUILD_RULE := $$(error no BPF objects should be built)
572TRUNNER_BPF_CFLAGS :=
573$(eval $(call DEFINE_TEST_RUNNER,test_maps))
574
575# Define test_verifier test runner.
576# It is much simpler than test_maps/test_progs and sufficiently different from
577# them (e.g., test.h is using completely pattern), that it's worth just
578# explicitly defining all the rules explicitly.
579verifier/tests.h: verifier/*.c
580	$(shell ( cd verifier/; \
581		  echo '/* Generated header, do not edit */'; \
582		  echo '#ifdef FILL_ARRAY'; \
583		  ls *.c 2> /dev/null | sed -e 's@\(.*\)@#include \"\1\"@'; \
584		  echo '#endif' \
585		) > verifier/tests.h)
586$(OUTPUT)/test_verifier: test_verifier.c verifier/tests.h $(BPFOBJ) | $(OUTPUT)
587	$(call msg,BINARY,,$@)
588	$(Q)$(CC) $(CFLAGS) $(filter %.a %.o %.c,$^) $(LDLIBS) -o $@
589
590$(OUTPUT)/xskxceiver: xskxceiver.c $(OUTPUT)/xsk.o $(OUTPUT)/xsk_xdp_progs.skel.h $(BPFOBJ) | $(OUTPUT)
591	$(call msg,BINARY,,$@)
592	$(Q)$(CC) $(CFLAGS) $(filter %.a %.o %.c,$^) $(LDLIBS) -o $@
593
594$(OUTPUT)/xdp_hw_metadata: xdp_hw_metadata.c $(OUTPUT)/network_helpers.o $(OUTPUT)/xsk.o $(OUTPUT)/xdp_hw_metadata.skel.h | $(OUTPUT)
595	$(call msg,BINARY,,$@)
596	$(Q)$(CC) $(CFLAGS) $(filter %.a %.o %.c,$^) $(LDLIBS) -o $@
597
598$(OUTPUT)/xdp_features: xdp_features.c $(OUTPUT)/network_helpers.o $(OUTPUT)/xdp_features.skel.h | $(OUTPUT)
599	$(call msg,BINARY,,$@)
600	$(Q)$(CC) $(CFLAGS) $(filter %.a %.o %.c,$^) $(LDLIBS) -o $@
601
602# Make sure we are able to include and link libbpf against c++.
603$(OUTPUT)/test_cpp: test_cpp.cpp $(OUTPUT)/test_core_extern.skel.h $(BPFOBJ)
604	$(call msg,CXX,,$@)
605	$(Q)$(CXX) $(CFLAGS) $(filter %.a %.o %.cpp,$^) $(LDLIBS) -o $@
606
607# Benchmark runner
608$(OUTPUT)/bench_%.o: benchs/bench_%.c bench.h $(BPFOBJ)
609	$(call msg,CC,,$@)
610	$(Q)$(CC) $(CFLAGS) -O2 -c $(filter %.c,$^) $(LDLIBS) -o $@
611$(OUTPUT)/bench_rename.o: $(OUTPUT)/test_overhead.skel.h
612$(OUTPUT)/bench_trigger.o: $(OUTPUT)/trigger_bench.skel.h
613$(OUTPUT)/bench_ringbufs.o: $(OUTPUT)/ringbuf_bench.skel.h \
614			    $(OUTPUT)/perfbuf_bench.skel.h
615$(OUTPUT)/bench_bloom_filter_map.o: $(OUTPUT)/bloom_filter_bench.skel.h
616$(OUTPUT)/bench_bpf_loop.o: $(OUTPUT)/bpf_loop_bench.skel.h
617$(OUTPUT)/bench_strncmp.o: $(OUTPUT)/strncmp_bench.skel.h
618$(OUTPUT)/bench_bpf_hashmap_full_update.o: $(OUTPUT)/bpf_hashmap_full_update_bench.skel.h
619$(OUTPUT)/bench_local_storage.o: $(OUTPUT)/local_storage_bench.skel.h
620$(OUTPUT)/bench_local_storage_rcu_tasks_trace.o: $(OUTPUT)/local_storage_rcu_tasks_trace_bench.skel.h
621$(OUTPUT)/bench.o: bench.h testing_helpers.h $(BPFOBJ)
622$(OUTPUT)/bench: LDLIBS += -lm
623$(OUTPUT)/bench: $(OUTPUT)/bench.o \
624		 $(TESTING_HELPERS) \
625		 $(TRACE_HELPERS) \
626		 $(OUTPUT)/bench_count.o \
627		 $(OUTPUT)/bench_rename.o \
628		 $(OUTPUT)/bench_trigger.o \
629		 $(OUTPUT)/bench_ringbufs.o \
630		 $(OUTPUT)/bench_bloom_filter_map.o \
631		 $(OUTPUT)/bench_bpf_loop.o \
632		 $(OUTPUT)/bench_strncmp.o \
633		 $(OUTPUT)/bench_bpf_hashmap_full_update.o \
634		 $(OUTPUT)/bench_local_storage.o \
635		 $(OUTPUT)/bench_local_storage_rcu_tasks_trace.o
636	$(call msg,BINARY,,$@)
637	$(Q)$(CC) $(CFLAGS) $(LDFLAGS) $(filter %.a %.o,$^) $(LDLIBS) -o $@
638
639$(OUTPUT)/veristat.o: $(BPFOBJ)
640$(OUTPUT)/veristat: $(OUTPUT)/veristat.o
641	$(call msg,BINARY,,$@)
642	$(Q)$(CC) $(CFLAGS) $(LDFLAGS) $(filter %.a %.o,$^) $(LDLIBS) -o $@
643
644EXTRA_CLEAN := $(TEST_CUSTOM_PROGS) $(SCRATCH_DIR) $(HOST_SCRATCH_DIR)	\
645	prog_tests/tests.h map_tests/tests.h verifier/tests.h		\
646	feature bpftool							\
647	$(addprefix $(OUTPUT)/,*.o *.skel.h *.lskel.h *.subskel.h	\
648			       no_alu32 bpf_gcc bpf_testmod.ko		\
649			       liburandom_read.so)
650
651.PHONY: docs docs-clean
652
653# Delete partially updated (corrupted) files on error
654.DELETE_ON_ERROR:
655