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