xref: /linux/tools/testing/selftests/bpf/Makefile (revision a85dd3a5170c8812cd835ea968ccadf0ebf1648e)
1# SPDX-License-Identifier: GPL-2.0
2include ../../../../scripts/Kbuild.include
3include ../../../scripts/Makefile.arch
4
5CURDIR := $(abspath .)
6TOOLSDIR := $(abspath ../../..)
7LIBDIR := $(TOOLSDIR)/lib
8BPFDIR := $(LIBDIR)/bpf
9TOOLSINCDIR := $(TOOLSDIR)/include
10BPFTOOLDIR := $(TOOLSDIR)/bpf/bpftool
11APIDIR := $(TOOLSINCDIR)/uapi
12GENDIR := $(abspath ../../../../include/generated)
13GENHDR := $(GENDIR)/autoconf.h
14
15ifneq ($(wildcard $(GENHDR)),)
16  GENFLAGS := -DHAVE_GENHDR
17endif
18
19CLANG		?= clang
20LLC		?= llc
21LLVM_OBJCOPY	?= llvm-objcopy
22BPF_GCC		?= $(shell command -v bpf-gcc;)
23CFLAGS += -g -Wall -O2 $(GENFLAGS) -I$(CURDIR) -I$(APIDIR)		\
24	  -I$(INCLUDE_DIR) -I$(GENDIR) -I$(LIBDIR) -I$(TOOLSINCDIR)	\
25	  -Dbpf_prog_load=bpf_prog_test_load				\
26	  -Dbpf_load_program=bpf_test_load_program
27LDLIBS += -lcap -lelf -lz -lrt -lpthread
28
29# Order correspond to 'make run_tests' order
30TEST_GEN_PROGS = test_verifier test_tag test_maps test_lru_map test_lpm_map test_progs \
31	test_align test_verifier_log test_dev_cgroup test_tcpbpf_user \
32	test_sock test_btf test_sockmap get_cgroup_id_user test_socket_cookie \
33	test_cgroup_storage \
34	test_netcnt test_tcpnotify_user test_sock_fields test_sysctl test_hashmap \
35	test_progs-no_alu32
36
37# Also test bpf-gcc, if present
38ifneq ($(BPF_GCC),)
39TEST_GEN_PROGS += test_progs-bpf_gcc
40endif
41
42TEST_GEN_FILES =
43TEST_FILES = test_lwt_ip_encap.o \
44	test_tc_edt.o
45
46# Order correspond to 'make run_tests' order
47TEST_PROGS := test_kmod.sh \
48	test_xdp_redirect.sh \
49	test_xdp_meta.sh \
50	test_xdp_veth.sh \
51	test_offload.py \
52	test_sock_addr.sh \
53	test_tunnel.sh \
54	test_lwt_seg6local.sh \
55	test_lirc_mode2.sh \
56	test_skb_cgroup_id.sh \
57	test_flow_dissector.sh \
58	test_xdp_vlan_mode_generic.sh \
59	test_xdp_vlan_mode_native.sh \
60	test_lwt_ip_encap.sh \
61	test_tcp_check_syncookie.sh \
62	test_tc_tunnel.sh \
63	test_tc_edt.sh \
64	test_xdping.sh \
65	test_bpftool_build.sh
66
67TEST_PROGS_EXTENDED := with_addr.sh \
68	with_tunnels.sh \
69	tcp_client.py \
70	tcp_server.py \
71	test_xdp_vlan.sh
72
73# Compile but not part of 'make run_tests'
74TEST_GEN_PROGS_EXTENDED = test_sock_addr test_skb_cgroup_id_user \
75	flow_dissector_load test_flow_dissector test_tcp_check_syncookie_user \
76	test_lirc_mode2_user xdping test_cpp runqslower
77
78TEST_CUSTOM_PROGS = urandom_read
79
80# Emit succinct information message describing current building step
81# $1 - generic step name (e.g., CC, LINK, etc);
82# $2 - optional "flavor" specifier; if provided, will be emitted as [flavor];
83# $3 - target (assumed to be file); only file name will be emitted;
84# $4 - optional extra arg, emitted as-is, if provided.
85ifeq ($(V),1)
86Q =
87msg =
88else
89Q = @
90msg = @printf '  %-8s%s %s%s\n' "$(1)" "$(if $(2), [$(2)])" "$(notdir $(3))" "$(if $(4), $(4))";
91MAKEFLAGS += --no-print-directory
92submake_extras := feature_display=0
93endif
94
95# override lib.mk's default rules
96OVERRIDE_TARGETS := 1
97override define CLEAN
98	$(call msg,CLEAN)
99	$(RM) -r $(TEST_GEN_PROGS) $(TEST_GEN_PROGS_EXTENDED) $(TEST_GEN_FILES) $(EXTRA_CLEAN)
100endef
101
102include ../lib.mk
103
104SCRATCH_DIR := $(OUTPUT)/tools
105BUILD_DIR := $(SCRATCH_DIR)/build
106INCLUDE_DIR := $(SCRATCH_DIR)/include
107BPFOBJ := $(BUILD_DIR)/libbpf/libbpf.a
108
109# Define simple and short `make test_progs`, `make test_sysctl`, etc targets
110# to build individual tests.
111# NOTE: Semicolon at the end is critical to override lib.mk's default static
112# rule for binaries.
113$(notdir $(TEST_GEN_PROGS)						\
114	 $(TEST_PROGS)							\
115	 $(TEST_PROGS_EXTENDED)						\
116	 $(TEST_GEN_PROGS_EXTENDED)					\
117	 $(TEST_CUSTOM_PROGS)): %: $(OUTPUT)/% ;
118
119$(OUTPUT)/%:%.c
120	$(call msg,BINARY,,$@)
121	$(LINK.c) $^ $(LDLIBS) -o $@
122
123$(OUTPUT)/urandom_read: urandom_read.c
124	$(call msg,BINARY,,$@)
125	$(CC) $(LDFLAGS) -o $@ $< $(LDLIBS) -Wl,--build-id
126
127$(OUTPUT)/test_stub.o: test_stub.c $(BPFOBJ)
128	$(call msg,CC,,$@)
129	$(CC) -c $(CFLAGS) -o $@ $<
130
131VMLINUX_BTF_PATHS := $(abspath ../../../../vmlinux)			\
132			       /sys/kernel/btf/vmlinux			\
133			       /boot/vmlinux-$(shell uname -r)
134VMLINUX_BTF:= $(firstword $(wildcard $(VMLINUX_BTF_PATHS)))
135$(OUTPUT)/runqslower: $(BPFOBJ)
136	$(Q)$(MAKE) $(submake_extras) -C $(TOOLSDIR)/bpf/runqslower	\
137		    OUTPUT=$(SCRATCH_DIR)/ VMLINUX_BTF=$(VMLINUX_BTF)   \
138		    BPFOBJ=$(BPFOBJ) BPF_INCLUDE=$(INCLUDE_DIR)
139
140$(TEST_GEN_PROGS) $(TEST_GEN_PROGS_EXTENDED): $(OUTPUT)/test_stub.o $(BPFOBJ)
141
142$(OUTPUT)/test_dev_cgroup: cgroup_helpers.c
143$(OUTPUT)/test_skb_cgroup_id_user: cgroup_helpers.c
144$(OUTPUT)/test_sock: cgroup_helpers.c
145$(OUTPUT)/test_sock_addr: cgroup_helpers.c
146$(OUTPUT)/test_socket_cookie: cgroup_helpers.c
147$(OUTPUT)/test_sockmap: cgroup_helpers.c
148$(OUTPUT)/test_tcpbpf_user: cgroup_helpers.c
149$(OUTPUT)/test_tcpnotify_user: cgroup_helpers.c trace_helpers.c
150$(OUTPUT)/get_cgroup_id_user: cgroup_helpers.c
151$(OUTPUT)/test_cgroup_storage: cgroup_helpers.c
152$(OUTPUT)/test_netcnt: cgroup_helpers.c
153$(OUTPUT)/test_sock_fields: cgroup_helpers.c
154$(OUTPUT)/test_sysctl: cgroup_helpers.c
155
156DEFAULT_BPFTOOL := $(SCRATCH_DIR)/sbin/bpftool
157BPFTOOL ?= $(DEFAULT_BPFTOOL)
158$(DEFAULT_BPFTOOL): $(BPFOBJ) | $(BUILD_DIR)/bpftool
159	$(Q)$(MAKE) $(submake_extras)  -C $(BPFTOOLDIR)			\
160		    OUTPUT=$(BUILD_DIR)/bpftool/			\
161		    prefix= DESTDIR=$(SCRATCH_DIR)/ install
162
163$(BPFOBJ): $(wildcard $(BPFDIR)/*.c $(BPFDIR)/*.h $(BPFDIR)/Makefile)          \
164	   ../../../include/uapi/linux/bpf.h                                   \
165	   | $(INCLUDE_DIR) $(BUILD_DIR)/libbpf
166	$(Q)$(MAKE) $(submake_extras) -C $(BPFDIR) OUTPUT=$(BUILD_DIR)/libbpf/ \
167		DESTDIR=$(SCRATCH_DIR) prefix= all install_headers
168
169$(BUILD_DIR)/libbpf $(BUILD_DIR)/bpftool $(INCLUDE_DIR):
170	$(call msg,MKDIR,,$@)
171	mkdir -p $@
172
173# Get Clang's default includes on this system, as opposed to those seen by
174# '-target bpf'. This fixes "missing" files on some architectures/distros,
175# such as asm/byteorder.h, asm/socket.h, asm/sockios.h, sys/cdefs.h etc.
176#
177# Use '-idirafter': Don't interfere with include mechanics except where the
178# build would have failed anyways.
179define get_sys_includes
180$(shell $(1) -v -E - </dev/null 2>&1 \
181	| sed -n '/<...> search starts here:/,/End of search list./{ s| \(/.*\)|-idirafter \1|p }')
182endef
183
184# Determine target endianness.
185IS_LITTLE_ENDIAN = $(shell $(CC) -dM -E - </dev/null | \
186			grep 'define __BYTE_ORDER__ __ORDER_LITTLE_ENDIAN__')
187MENDIAN=$(if $(IS_LITTLE_ENDIAN),-mlittle-endian,-mbig-endian)
188
189CLANG_SYS_INCLUDES = $(call get_sys_includes,$(CLANG))
190BPF_CFLAGS = -g -D__TARGET_ARCH_$(SRCARCH) $(MENDIAN) 			\
191	     -I$(INCLUDE_DIR) -I$(CURDIR) -I$(CURDIR)/include/uapi	\
192	     -I$(APIDIR) -I$(abspath $(OUTPUT)/../usr/include)
193
194CLANG_CFLAGS = $(CLANG_SYS_INCLUDES) \
195	       -Wno-compare-distinct-pointer-types
196
197$(OUTPUT)/test_l4lb_noinline.o: BPF_CFLAGS += -fno-inline
198$(OUTPUT)/test_xdp_noinline.o: BPF_CFLAGS += -fno-inline
199
200$(OUTPUT)/flow_dissector_load.o: flow_dissector_load.h
201
202# Build BPF object using Clang
203# $1 - input .c file
204# $2 - output .o file
205# $3 - CFLAGS
206# $4 - LDFLAGS
207define CLANG_BPF_BUILD_RULE
208	$(call msg,CLNG-LLC,$(TRUNNER_BINARY),$2)
209	($(CLANG) $3 -O2 -target bpf -emit-llvm				\
210		-c $1 -o - || echo "BPF obj compilation failed") | 	\
211	$(LLC) -mattr=dwarfris -march=bpf -mcpu=probe $4 -filetype=obj -o $2
212endef
213# Similar to CLANG_BPF_BUILD_RULE, but with disabled alu32
214define CLANG_NOALU32_BPF_BUILD_RULE
215	$(call msg,CLNG-LLC,$(TRUNNER_BINARY),$2)
216	($(CLANG) $3 -O2 -target bpf -emit-llvm				\
217		-c $1 -o - || echo "BPF obj compilation failed") | 	\
218	$(LLC) -march=bpf -mcpu=v2 $4 -filetype=obj -o $2
219endef
220# Similar to CLANG_BPF_BUILD_RULE, but using native Clang and bpf LLC
221define CLANG_NATIVE_BPF_BUILD_RULE
222	$(call msg,CLNG-BPF,$(TRUNNER_BINARY),$2)
223	($(CLANG) $3 -O2 -emit-llvm					\
224		-c $1 -o - || echo "BPF obj compilation failed") | 	\
225	$(LLC) -march=bpf -mcpu=probe $4 -filetype=obj -o $2
226endef
227# Build BPF object using GCC
228define GCC_BPF_BUILD_RULE
229	$(call msg,GCC-BPF,$(TRUNNER_BINARY),$2)
230	$(BPF_GCC) $3 $4 -O2 -c $1 -o $2
231endef
232
233SKEL_BLACKLIST := btf__% test_pinning_invalid.c
234
235# Set up extra TRUNNER_XXX "temporary" variables in the environment (relies on
236# $eval()) and pass control to DEFINE_TEST_RUNNER_RULES.
237# Parameters:
238# $1 - test runner base binary name (e.g., test_progs)
239# $2 - test runner extra "flavor" (e.g., no_alu32, gcc-bpf, etc)
240define DEFINE_TEST_RUNNER
241
242TRUNNER_OUTPUT := $(OUTPUT)$(if $2,/)$2
243TRUNNER_BINARY := $1$(if $2,-)$2
244TRUNNER_TEST_OBJS := $$(patsubst %.c,$$(TRUNNER_OUTPUT)/%.test.o,	\
245				 $$(notdir $$(wildcard $(TRUNNER_TESTS_DIR)/*.c)))
246TRUNNER_EXTRA_OBJS := $$(patsubst %.c,$$(TRUNNER_OUTPUT)/%.o,		\
247				 $$(filter %.c,$(TRUNNER_EXTRA_SOURCES)))
248TRUNNER_EXTRA_HDRS := $$(filter %.h,$(TRUNNER_EXTRA_SOURCES))
249TRUNNER_TESTS_HDR := $(TRUNNER_TESTS_DIR)/tests.h
250TRUNNER_BPF_SRCS := $$(notdir $$(wildcard $(TRUNNER_BPF_PROGS_DIR)/*.c))
251TRUNNER_BPF_OBJS := $$(patsubst %.c,$$(TRUNNER_OUTPUT)/%.o, $$(TRUNNER_BPF_SRCS))
252TRUNNER_BPF_SKELS := $$(patsubst %.c,$$(TRUNNER_OUTPUT)/%.skel.h,	\
253				 $$(filter-out $(SKEL_BLACKLIST),	\
254					       $$(TRUNNER_BPF_SRCS)))
255
256# Evaluate rules now with extra TRUNNER_XXX variables above already defined
257$$(eval $$(call DEFINE_TEST_RUNNER_RULES,$1,$2))
258
259endef
260
261# Using TRUNNER_XXX variables, provided by callers of DEFINE_TEST_RUNNER and
262# set up by DEFINE_TEST_RUNNER itself, create test runner build rules with:
263# $1 - test runner base binary name (e.g., test_progs)
264# $2 - test runner extra "flavor" (e.g., no_alu32, gcc-bpf, etc)
265define DEFINE_TEST_RUNNER_RULES
266
267ifeq ($($(TRUNNER_OUTPUT)-dir),)
268$(TRUNNER_OUTPUT)-dir := y
269$(TRUNNER_OUTPUT):
270	$$(call msg,MKDIR,,$$@)
271	mkdir -p $$@
272endif
273
274# ensure we set up BPF objects generation rule just once for a given
275# input/output directory combination
276ifeq ($($(TRUNNER_BPF_PROGS_DIR)$(if $2,-)$2-bpfobjs),)
277$(TRUNNER_BPF_PROGS_DIR)$(if $2,-)$2-bpfobjs := y
278$(TRUNNER_BPF_OBJS): $(TRUNNER_OUTPUT)/%.o:				\
279		     $(TRUNNER_BPF_PROGS_DIR)/%.c			\
280		     $(TRUNNER_BPF_PROGS_DIR)/*.h			\
281		     $$(BPFOBJ) | $(TRUNNER_OUTPUT)
282	$$(call $(TRUNNER_BPF_BUILD_RULE),$$<,$$@,			\
283					  $(TRUNNER_BPF_CFLAGS),	\
284					  $(TRUNNER_BPF_LDFLAGS))
285
286$(TRUNNER_BPF_SKELS): $(TRUNNER_OUTPUT)/%.skel.h:			\
287		      $(TRUNNER_OUTPUT)/%.o				\
288		      | $(BPFTOOL) $(TRUNNER_OUTPUT)
289	$$(call msg,GEN-SKEL,$(TRUNNER_BINARY),$$@)
290	$$(BPFTOOL) gen skeleton $$< > $$@
291endif
292
293# ensure we set up tests.h header generation rule just once
294ifeq ($($(TRUNNER_TESTS_DIR)-tests-hdr),)
295$(TRUNNER_TESTS_DIR)-tests-hdr := y
296$(TRUNNER_TESTS_HDR): $(TRUNNER_TESTS_DIR)/*.c
297	$$(call msg,TEST-HDR,$(TRUNNER_BINARY),$$@)
298	$$(shell ( cd $(TRUNNER_TESTS_DIR);				\
299		  echo '/* Generated header, do not edit */';		\
300		  ls *.c 2> /dev/null |					\
301			sed -e 's@\([^\.]*\)\.c@DEFINE_TEST(\1)@';	\
302		 ) > $$@)
303endif
304
305# compile individual test files
306# Note: we cd into output directory to ensure embedded BPF object is found
307$(TRUNNER_TEST_OBJS): $(TRUNNER_OUTPUT)/%.test.o:			\
308		      $(TRUNNER_TESTS_DIR)/%.c				\
309		      $(TRUNNER_EXTRA_HDRS)				\
310		      $(TRUNNER_BPF_OBJS)				\
311		      $(TRUNNER_BPF_SKELS)				\
312		      $$(BPFOBJ) | $(TRUNNER_OUTPUT)
313	$$(call msg,TEST-OBJ,$(TRUNNER_BINARY),$$@)
314	cd $$(@D) && $$(CC) $$(CFLAGS) -c $(CURDIR)/$$< $$(LDLIBS) -o $$(@F)
315
316$(TRUNNER_EXTRA_OBJS): $(TRUNNER_OUTPUT)/%.o:				\
317		       %.c						\
318		       $(TRUNNER_EXTRA_HDRS)				\
319		       $(TRUNNER_TESTS_HDR)				\
320		       $$(BPFOBJ) | $(TRUNNER_OUTPUT)
321	$$(call msg,EXT-OBJ,$(TRUNNER_BINARY),$$@)
322	$$(CC) $$(CFLAGS) -c $$< $$(LDLIBS) -o $$@
323
324# only copy extra resources if in flavored build
325$(TRUNNER_BINARY)-extras: $(TRUNNER_EXTRA_FILES) | $(TRUNNER_OUTPUT)
326ifneq ($2,)
327	$$(call msg,EXT-COPY,$(TRUNNER_BINARY),$(TRUNNER_EXTRA_FILES))
328	cp -a $$^ $(TRUNNER_OUTPUT)/
329endif
330
331$(OUTPUT)/$(TRUNNER_BINARY): $(TRUNNER_TEST_OBJS)			\
332			     $(TRUNNER_EXTRA_OBJS) $$(BPFOBJ)		\
333			     | $(TRUNNER_BINARY)-extras
334	$$(call msg,BINARY,,$$@)
335	$$(CC) $$(CFLAGS) $$(filter %.a %.o,$$^) $$(LDLIBS) -o $$@
336
337endef
338
339# Define test_progs test runner.
340TRUNNER_TESTS_DIR := prog_tests
341TRUNNER_BPF_PROGS_DIR := progs
342TRUNNER_EXTRA_SOURCES := test_progs.c cgroup_helpers.c trace_helpers.c	\
343			 flow_dissector_load.h
344TRUNNER_EXTRA_FILES := $(OUTPUT)/urandom_read				\
345		       $(wildcard progs/btf_dump_test_case_*.c)
346TRUNNER_BPF_BUILD_RULE := CLANG_BPF_BUILD_RULE
347TRUNNER_BPF_CFLAGS := $(BPF_CFLAGS) $(CLANG_CFLAGS)
348TRUNNER_BPF_LDFLAGS := -mattr=+alu32
349$(eval $(call DEFINE_TEST_RUNNER,test_progs))
350
351# Define test_progs-no_alu32 test runner.
352TRUNNER_BPF_BUILD_RULE := CLANG_NOALU32_BPF_BUILD_RULE
353TRUNNER_BPF_LDFLAGS :=
354$(eval $(call DEFINE_TEST_RUNNER,test_progs,no_alu32))
355
356# Define test_progs BPF-GCC-flavored test runner.
357ifneq ($(BPF_GCC),)
358TRUNNER_BPF_BUILD_RULE := GCC_BPF_BUILD_RULE
359TRUNNER_BPF_CFLAGS := $(BPF_CFLAGS) $(call get_sys_includes,gcc)
360TRUNNER_BPF_LDFLAGS :=
361$(eval $(call DEFINE_TEST_RUNNER,test_progs,bpf_gcc))
362endif
363
364# Define test_maps test runner.
365TRUNNER_TESTS_DIR := map_tests
366TRUNNER_BPF_PROGS_DIR := progs
367TRUNNER_EXTRA_SOURCES := test_maps.c
368TRUNNER_EXTRA_FILES :=
369TRUNNER_BPF_BUILD_RULE := $$(error no BPF objects should be built)
370TRUNNER_BPF_CFLAGS :=
371TRUNNER_BPF_LDFLAGS :=
372$(eval $(call DEFINE_TEST_RUNNER,test_maps))
373
374# Define test_verifier test runner.
375# It is much simpler than test_maps/test_progs and sufficiently different from
376# them (e.g., test.h is using completely pattern), that it's worth just
377# explicitly defining all the rules explicitly.
378verifier/tests.h: verifier/*.c
379	$(shell ( cd verifier/; \
380		  echo '/* Generated header, do not edit */'; \
381		  echo '#ifdef FILL_ARRAY'; \
382		  ls *.c 2> /dev/null | sed -e 's@\(.*\)@#include \"\1\"@'; \
383		  echo '#endif' \
384		) > verifier/tests.h)
385$(OUTPUT)/test_verifier: test_verifier.c verifier/tests.h $(BPFOBJ) | $(OUTPUT)
386	$(call msg,BINARY,,$@)
387	$(CC) $(CFLAGS) $(filter %.a %.o %.c,$^) $(LDLIBS) -o $@
388
389# Make sure we are able to include and link libbpf against c++.
390$(OUTPUT)/test_cpp: test_cpp.cpp $(OUTPUT)/test_core_extern.skel.h $(BPFOBJ)
391	$(call msg,CXX,,$@)
392	$(CXX) $(CFLAGS) $^ $(LDLIBS) -o $@
393
394EXTRA_CLEAN := $(TEST_CUSTOM_PROGS) $(SCRATCH_DIR)			\
395	prog_tests/tests.h map_tests/tests.h verifier/tests.h		\
396	feature								\
397	$(addprefix $(OUTPUT)/,*.o *.skel.h no_alu32 bpf_gcc)
398