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