tools/testing/selftests/bpf/Makefile

   1 # SPDX-License-Identifier: GPL-2.0
   2 include ../../../../scripts/Kbuild.include
   3 include ../../../scripts/Makefile.arch
   4
   5 CURDIR := $(abspath .)
   6 TOOLSDIR := $(abspath ../../..)
   7 LIBDIR := $(TOOLSDIR)/lib
   8 BPFDIR := $(LIBDIR)/bpf
   9 TOOLSINCDIR := $(TOOLSDIR)/include
  10 BPFTOOLDIR := $(TOOLSDIR)/bpf/bpftool
  11 APIDIR := $(TOOLSINCDIR)/uapi
  12 GENDIR := $(abspath ../../../../include/generated)
  13 GENHDR := $(GENDIR)/autoconf.h
  14
  15 ifneq ($(wildcard $(GENHDR)),)
  16   GENFLAGS := -DHAVE_GENHDR
  17 endif
  18
  19 CLANG           ?= clang
  20 LLC             ?= llc
  21 LLVM_OBJCOPY    ?= llvm-objcopy
  22 BPF_GCC         ?= $(shell command -v bpf-gcc;)
  23 CFLAGS += -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
  27 LDLIBS += -lcap -lelf -lz -lrt -lpthread
  28
  29 # Order correspond to 'make run_tests' order
  30 TEST_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
  38 ifneq ($(BPF_GCC),)
  39 TEST_GEN_PROGS += test_progs-bpf_gcc
  40 endif
  41
  42 TEST_GEN_FILES =
  43 TEST_FILES = test_lwt_ip_encap.o \
  44         test_tc_edt.o
  45
  46 # Order correspond to 'make run_tests' order
  47 TEST_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
  67 TEST_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'
  74 TEST_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
  78 TEST_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.
  85 ifeq ($(V),1)
  86 Q =
  87 msg =
  88 else
  89 Q = @
  90 msg = @printf '  %-8s%s %s%s\n' "$(1)" "$(if $(2), [$(2)])" "$(notdir $(3))" "$(if $(4), $(4))";
  91 MAKEFLAGS += --no-print-directory
  92 submake_extras := feature_display=0
  93 endif
  94
  95 # override lib.mk's default rules
  96 OVERRIDE_TARGETS := 1
  97 override define CLEAN
  98         $(call msg,CLEAN)
  99         $(RM) -r $(TEST_GEN_PROGS) $(TEST_GEN_PROGS_EXTENDED) $(TEST_GEN_FILES) $(EXTRA_CLEAN)
 100 endef
 101
 102 include ../lib.mk
 103
 104 SCRATCH_DIR := $(OUTPUT)/tools
 105 BUILD_DIR := $(SCRATCH_DIR)/build
 106 INCLUDE_DIR := $(SCRATCH_DIR)/include
 107 BPFOBJ := $(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
 131 VMLINUX_BTF_PATHS := $(abspath ../../../../vmlinux)                     \
 132                                /sys/kernel/btf/vmlinux                  \
 133                                /boot/vmlinux-$(shell uname -r)
 134 VMLINUX_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
 156 DEFAULT_BPFTOOL := $(SCRATCH_DIR)/sbin/bpftool
 157 BPFTOOL ?= $(DEFAULT_BPFTOOL)
 158 $(DEFAULT_BPFTOOL): $(wildcard $(BPFTOOLDIR)/*.[ch] $(BPFTOOLDIR)/Makefile)    \
 159                     $(BPFOBJ) | $(BUILD_DIR)/bpftool
 160         $(Q)$(MAKE) $(submake_extras)  -C $(BPFTOOLDIR)                        \
 161                     OUTPUT=$(BUILD_DIR)/bpftool/                               \
 162                     prefix= DESTDIR=$(SCRATCH_DIR)/ install
 163
 164 $(BPFOBJ): $(wildcard $(BPFDIR)/*.[ch] $(BPFDIR)/Makefile)                     \
 165            ../../../include/uapi/linux/bpf.h                                   \
 166            | $(INCLUDE_DIR) $(BUILD_DIR)/libbpf
 167         $(Q)$(MAKE) $(submake_extras) -C $(BPFDIR) OUTPUT=$(BUILD_DIR)/libbpf/ \
 168                     DESTDIR=$(SCRATCH_DIR) prefix= all install_headers
 169
 170 $(BUILD_DIR)/libbpf $(BUILD_DIR)/bpftool $(INCLUDE_DIR):
 171         $(call msg,MKDIR,,$@)
 172         mkdir -p $@
 173
 174 # Get Clang's default includes on this system, as opposed to those seen by
 175 # '-target bpf'. This fixes "missing" files on some architectures/distros,
 176 # such as asm/byteorder.h, asm/socket.h, asm/sockios.h, sys/cdefs.h etc.
 177 #
 178 # Use '-idirafter': Don't interfere with include mechanics except where the
 179 # build would have failed anyways.
 180 define get_sys_includes
 181 $(shell $(1) -v -E - </dev/null 2>&1 \
 182         | sed -n '/<...> search starts here:/,/End of search list./{ s| \(/.*\)|-idirafter \1|p }')
 183 endef
 184
 185 # Determine target endianness.
 186 IS_LITTLE_ENDIAN = $(shell $(CC) -dM -E - </dev/null | \
 187                         grep 'define __BYTE_ORDER__ __ORDER_LITTLE_ENDIAN__')
 188 MENDIAN=$(if $(IS_LITTLE_ENDIAN),-mlittle-endian,-mbig-endian)
 189
 190 CLANG_SYS_INCLUDES = $(call get_sys_includes,$(CLANG))
 191 BPF_CFLAGS = -g -D__TARGET_ARCH_$(SRCARCH) $(MENDIAN)                   \
 192              -I$(INCLUDE_DIR) -I$(CURDIR) -I$(CURDIR)/include/uapi      \
 193              -I$(APIDIR) -I$(abspath $(OUTPUT)/../usr/include)
 194
 195 CLANG_CFLAGS = $(CLANG_SYS_INCLUDES) \
 196                -Wno-compare-distinct-pointer-types
 197
 198 $(OUTPUT)/test_l4lb_noinline.o: BPF_CFLAGS += -fno-inline
 199 $(OUTPUT)/test_xdp_noinline.o: BPF_CFLAGS += -fno-inline
 200
 201 $(OUTPUT)/flow_dissector_load.o: flow_dissector_load.h
 202
 203 # Build BPF object using Clang
 204 # $1 - input .c file
 205 # $2 - output .o file
 206 # $3 - CFLAGS
 207 # $4 - LDFLAGS
 208 define CLANG_BPF_BUILD_RULE
 209         $(call msg,CLNG-LLC,$(TRUNNER_BINARY),$2)
 210         ($(CLANG) $3 -O2 -target bpf -emit-llvm                         \
 211                 -c $1 -o - || echo "BPF obj compilation failed") |      \
 212         $(LLC) -mattr=dwarfris -march=bpf -mcpu=probe $4 -filetype=obj -o $2
 213 endef
 214 # Similar to CLANG_BPF_BUILD_RULE, but with disabled alu32
 215 define CLANG_NOALU32_BPF_BUILD_RULE
 216         $(call msg,CLNG-LLC,$(TRUNNER_BINARY),$2)
 217         ($(CLANG) $3 -O2 -target bpf -emit-llvm                         \
 218                 -c $1 -o - || echo "BPF obj compilation failed") |      \
 219         $(LLC) -march=bpf -mcpu=v2 $4 -filetype=obj -o $2
 220 endef
 221 # Similar to CLANG_BPF_BUILD_RULE, but using native Clang and bpf LLC
 222 define CLANG_NATIVE_BPF_BUILD_RULE
 223         $(call msg,CLNG-BPF,$(TRUNNER_BINARY),$2)
 224         ($(CLANG) $3 -O2 -emit-llvm                                     \
 225                 -c $1 -o - || echo "BPF obj compilation failed") |      \
 226         $(LLC) -march=bpf -mcpu=probe $4 -filetype=obj -o $2
 227 endef
 228 # Build BPF object using GCC
 229 define GCC_BPF_BUILD_RULE
 230         $(call msg,GCC-BPF,$(TRUNNER_BINARY),$2)
 231         $(BPF_GCC) $3 $4 -O2 -c $1 -o $2
 232 endef
 233
 234 SKEL_BLACKLIST := btf__% test_pinning_invalid.c
 235
 236 # Set up extra TRUNNER_XXX "temporary" variables in the environment (relies on
 237 # $eval()) and pass control to DEFINE_TEST_RUNNER_RULES.
 238 # Parameters:
 239 # $1 - test runner base binary name (e.g., test_progs)
 240 # $2 - test runner extra "flavor" (e.g., no_alu32, gcc-bpf, etc)
 241 define DEFINE_TEST_RUNNER
 242
 243 TRUNNER_OUTPUT := $(OUTPUT)$(if $2,/)$2
 244 TRUNNER_BINARY := $1$(if $2,-)$2
 245 TRUNNER_TEST_OBJS := $$(patsubst %.c,$$(TRUNNER_OUTPUT)/%.test.o,       \
 246                                  $$(notdir $$(wildcard $(TRUNNER_TESTS_DIR)/*.c)))
 247 TRUNNER_EXTRA_OBJS := $$(patsubst %.c,$$(TRUNNER_OUTPUT)/%.o,           \
 248                                  $$(filter %.c,$(TRUNNER_EXTRA_SOURCES)))
 249 TRUNNER_EXTRA_HDRS := $$(filter %.h,$(TRUNNER_EXTRA_SOURCES))
 250 TRUNNER_TESTS_HDR := $(TRUNNER_TESTS_DIR)/tests.h
 251 TRUNNER_BPF_SRCS := $$(notdir $$(wildcard $(TRUNNER_BPF_PROGS_DIR)/*.c))
 252 TRUNNER_BPF_OBJS := $$(patsubst %.c,$$(TRUNNER_OUTPUT)/%.o, $$(TRUNNER_BPF_SRCS))
 253 TRUNNER_BPF_SKELS := $$(patsubst %.c,$$(TRUNNER_OUTPUT)/%.skel.h,       \
 254                                  $$(filter-out $(SKEL_BLACKLIST),       \
 255                                                $$(TRUNNER_BPF_SRCS)))
 256
 257 # Evaluate rules now with extra TRUNNER_XXX variables above already defined
 258 $$(eval $$(call DEFINE_TEST_RUNNER_RULES,$1,$2))
 259
 260 endef
 261
 262 # Using TRUNNER_XXX variables, provided by callers of DEFINE_TEST_RUNNER and
 263 # set up by DEFINE_TEST_RUNNER itself, create test runner build rules with:
 264 # $1 - test runner base binary name (e.g., test_progs)
 265 # $2 - test runner extra "flavor" (e.g., no_alu32, gcc-bpf, etc)
 266 define DEFINE_TEST_RUNNER_RULES
 267
 268 ifeq ($($(TRUNNER_OUTPUT)-dir),)
 269 $(TRUNNER_OUTPUT)-dir := y
 270 $(TRUNNER_OUTPUT):
 271         $$(call msg,MKDIR,,$$@)
 272         mkdir -p $$@
 273 endif
 274
 275 # ensure we set up BPF objects generation rule just once for a given
 276 # input/output directory combination
 277 ifeq ($($(TRUNNER_BPF_PROGS_DIR)$(if $2,-)$2-bpfobjs),)
 278 $(TRUNNER_BPF_PROGS_DIR)$(if $2,-)$2-bpfobjs := y
 279 $(TRUNNER_BPF_OBJS): $(TRUNNER_OUTPUT)/%.o:                             \
 280                      $(TRUNNER_BPF_PROGS_DIR)/%.c                       \
 281                      $(TRUNNER_BPF_PROGS_DIR)/*.h                       \
 282                      $$(BPFOBJ) | $(TRUNNER_OUTPUT)
 283         $$(call $(TRUNNER_BPF_BUILD_RULE),$$<,$$@,                      \
 284                                           $(TRUNNER_BPF_CFLAGS),        \
 285                                           $(TRUNNER_BPF_LDFLAGS))
 286
 287 $(TRUNNER_BPF_SKELS): $(TRUNNER_OUTPUT)/%.skel.h:                       \
 288                       $(TRUNNER_OUTPUT)/%.o                             \
 289                       | $(BPFTOOL) $(TRUNNER_OUTPUT)
 290         $$(call msg,GEN-SKEL,$(TRUNNER_BINARY),$$@)
 291         $$(BPFTOOL) gen skeleton $$< > $$@
 292 endif
 293
 294 # ensure we set up tests.h header generation rule just once
 295 ifeq ($($(TRUNNER_TESTS_DIR)-tests-hdr),)
 296 $(TRUNNER_TESTS_DIR)-tests-hdr := y
 297 $(TRUNNER_TESTS_HDR): $(TRUNNER_TESTS_DIR)/*.c
 298         $$(call msg,TEST-HDR,$(TRUNNER_BINARY),$$@)
 299         $$(shell ( cd $(TRUNNER_TESTS_DIR);                             \
 300                   echo '/* Generated header, do not edit */';           \
 301                   ls *.c 2> /dev/null |                                 \
 302                         sed -e 's@\([^\.]*\)\.c@DEFINE_TEST(\1)@';      \
 303                  ) > $$@)
 304 endif
 305
 306 # compile individual test files
 307 # Note: we cd into output directory to ensure embedded BPF object is found
 308 $(TRUNNER_TEST_OBJS): $(TRUNNER_OUTPUT)/%.test.o:                       \
 309                       $(TRUNNER_TESTS_DIR)/%.c                          \
 310                       $(TRUNNER_EXTRA_HDRS)                             \
 311                       $(TRUNNER_BPF_OBJS)                               \
 312                       $(TRUNNER_BPF_SKELS)                              \
 313                       $$(BPFOBJ) | $(TRUNNER_OUTPUT)
 314         $$(call msg,TEST-OBJ,$(TRUNNER_BINARY),$$@)
 315         cd $$(@D) && $$(CC) $$(CFLAGS) -c $(CURDIR)/$$< $$(LDLIBS) -o $$(@F)
 316
 317 $(TRUNNER_EXTRA_OBJS): $(TRUNNER_OUTPUT)/%.o:                           \
 318                        %.c                                              \
 319                        $(TRUNNER_EXTRA_HDRS)                            \
 320                        $(TRUNNER_TESTS_HDR)                             \
 321                        $$(BPFOBJ) | $(TRUNNER_OUTPUT)
 322         $$(call msg,EXT-OBJ,$(TRUNNER_BINARY),$$@)
 323         $$(CC) $$(CFLAGS) -c $$< $$(LDLIBS) -o $$@
 324
 325 # only copy extra resources if in flavored build
 326 $(TRUNNER_BINARY)-extras: $(TRUNNER_EXTRA_FILES) | $(TRUNNER_OUTPUT)
 327 ifneq ($2,)
 328         $$(call msg,EXT-COPY,$(TRUNNER_BINARY),$(TRUNNER_EXTRA_FILES))
 329         cp -a $$^ $(TRUNNER_OUTPUT)/
 330 endif
 331
 332 $(OUTPUT)/$(TRUNNER_BINARY): $(TRUNNER_TEST_OBJS)                       \
 333                              $(TRUNNER_EXTRA_OBJS) $$(BPFOBJ)           \
 334                              | $(TRUNNER_BINARY)-extras
 335         $$(call msg,BINARY,,$$@)
 336         $$(CC) $$(CFLAGS) $$(filter %.a %.o,$$^) $$(LDLIBS) -o $$@
 337
 338 endef
 339
 340 # Define test_progs test runner.
 341 TRUNNER_TESTS_DIR := prog_tests
 342 TRUNNER_BPF_PROGS_DIR := progs
 343 TRUNNER_EXTRA_SOURCES := test_progs.c cgroup_helpers.c trace_helpers.c  \
 344                          flow_dissector_load.h
 345 TRUNNER_EXTRA_FILES := $(OUTPUT)/urandom_read                           \
 346                        $(wildcard progs/btf_dump_test_case_*.c)
 347 TRUNNER_BPF_BUILD_RULE := CLANG_BPF_BUILD_RULE
 348 TRUNNER_BPF_CFLAGS := $(BPF_CFLAGS) $(CLANG_CFLAGS)
 349 TRUNNER_BPF_LDFLAGS := -mattr=+alu32
 350 $(eval $(call DEFINE_TEST_RUNNER,test_progs))
 351
 352 # Define test_progs-no_alu32 test runner.
 353 TRUNNER_BPF_BUILD_RULE := CLANG_NOALU32_BPF_BUILD_RULE
 354 TRUNNER_BPF_LDFLAGS :=
 355 $(eval $(call DEFINE_TEST_RUNNER,test_progs,no_alu32))
 356
 357 # Define test_progs BPF-GCC-flavored test runner.
 358 ifneq ($(BPF_GCC),)
 359 TRUNNER_BPF_BUILD_RULE := GCC_BPF_BUILD_RULE
 360 TRUNNER_BPF_CFLAGS := $(BPF_CFLAGS) $(call get_sys_includes,gcc)
 361 TRUNNER_BPF_LDFLAGS :=
 362 $(eval $(call DEFINE_TEST_RUNNER,test_progs,bpf_gcc))
 363 endif
 364
 365 # Define test_maps test runner.
 366 TRUNNER_TESTS_DIR := map_tests
 367 TRUNNER_BPF_PROGS_DIR := progs
 368 TRUNNER_EXTRA_SOURCES := test_maps.c
 369 TRUNNER_EXTRA_FILES :=
 370 TRUNNER_BPF_BUILD_RULE := $$(error no BPF objects should be built)
 371 TRUNNER_BPF_CFLAGS :=
 372 TRUNNER_BPF_LDFLAGS :=
 373 $(eval $(call DEFINE_TEST_RUNNER,test_maps))
 374
 375 # Define test_verifier test runner.
 376 # It is much simpler than test_maps/test_progs and sufficiently different from
 377 # them (e.g., test.h is using completely pattern), that it's worth just
 378 # explicitly defining all the rules explicitly.
 379 verifier/tests.h: verifier/*.c
 380         $(shell ( cd verifier/; \
 381                   echo '/* Generated header, do not edit */'; \
 382                   echo '#ifdef FILL_ARRAY'; \
 383                   ls *.c 2> /dev/null | sed -e 's@\(.*\)@#include \"\1\"@'; \
 384                   echo '#endif' \
 385                 ) > verifier/tests.h)
 386 $(OUTPUT)/test_verifier: test_verifier.c verifier/tests.h $(BPFOBJ) | $(OUTPUT)
 387         $(call msg,BINARY,,$@)
 388         $(CC) $(CFLAGS) $(filter %.a %.o %.c,$^) $(LDLIBS) -o $@
 389
 390 # Make sure we are able to include and link libbpf against c++.
 391 $(OUTPUT)/test_cpp: test_cpp.cpp $(OUTPUT)/test_core_extern.skel.h $(BPFOBJ)
 392         $(call msg,CXX,,$@)
 393         $(CXX) $(CFLAGS) $^ $(LDLIBS) -o $@
 394
 395 EXTRA_CLEAN := $(TEST_CUSTOM_PROGS) $(SCRATCH_DIR)                      \
 396         prog_tests/tests.h map_tests/tests.h verifier/tests.h           \
 397         feature                                                         \
 398         $(addprefix $(OUTPUT)/,*.o *.skel.h no_alu32 bpf_gcc)