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