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