xref: /linux/samples/bpf/Makefile (revision 643e2e259c2b25a2af0ae4c23c6e16586d9fd19c)
1# SPDX-License-Identifier: GPL-2.0
2
3BPF_SAMPLES_PATH ?= $(abspath $(src))
4TOOLS_PATH := $(BPF_SAMPLES_PATH)/../../tools
5
6pound := \#
7
8# List of programs to build
9tprogs-y := test_lru_dist
10tprogs-y += sock_example
11tprogs-y += fds_example
12tprogs-y += sockex1
13tprogs-y += sockex2
14tprogs-y += sockex3
15tprogs-y += tracex1
16tprogs-y += tracex3
17tprogs-y += tracex4
18tprogs-y += tracex5
19tprogs-y += tracex6
20tprogs-y += trace_output
21tprogs-y += lathist
22tprogs-y += offwaketime
23tprogs-y += spintest
24tprogs-y += map_perf_test
25tprogs-y += xdp_router_ipv4
26tprogs-y += trace_event
27tprogs-y += sampleip
28tprogs-y += tc_l2_redirect
29tprogs-y += lwt_len_hist
30tprogs-y += xdp_tx_iptunnel
31tprogs-y += test_map_in_map
32tprogs-y += per_socket_stats_example
33tprogs-y += syscall_tp
34tprogs-y += cpustat
35tprogs-y += xdp_adjust_tail
36tprogs-y += xdp_fwd
37tprogs-y += task_fd_query
38tprogs-y += ibumad
39tprogs-y += hbm
40
41# Libbpf dependencies
42LIBBPF_SRC = $(TOOLS_PATH)/lib/bpf
43LIBBPF_OUTPUT = $(abspath $(BPF_SAMPLES_PATH))/libbpf
44LIBBPF_DESTDIR = $(LIBBPF_OUTPUT)
45LIBBPF_INCLUDE = $(LIBBPF_DESTDIR)/include
46LIBBPF = $(LIBBPF_OUTPUT)/libbpf.a
47
48CGROUP_HELPERS := ../../tools/testing/selftests/bpf/cgroup_helpers.o
49TRACE_HELPERS := ../../tools/testing/selftests/bpf/trace_helpers.o
50XDP_SAMPLE := xdp_sample_user.o
51
52fds_example-objs := fds_example.o
53sockex1-objs := sockex1_user.o
54sockex2-objs := sockex2_user.o
55sockex3-objs := sockex3_user.o
56tracex1-objs := tracex1_user.o $(TRACE_HELPERS)
57tracex3-objs := tracex3_user.o
58tracex4-objs := tracex4_user.o
59tracex5-objs := tracex5_user.o $(TRACE_HELPERS)
60tracex6-objs := tracex6_user.o
61trace_output-objs := trace_output_user.o
62lathist-objs := lathist_user.o
63offwaketime-objs := offwaketime_user.o $(TRACE_HELPERS)
64spintest-objs := spintest_user.o $(TRACE_HELPERS)
65map_perf_test-objs := map_perf_test_user.o
66test_overhead-objs := test_overhead_user.o
67trace_event-objs := trace_event_user.o $(TRACE_HELPERS)
68sampleip-objs := sampleip_user.o $(TRACE_HELPERS)
69tc_l2_redirect-objs := tc_l2_redirect_user.o
70lwt_len_hist-objs := lwt_len_hist_user.o
71xdp_tx_iptunnel-objs := xdp_tx_iptunnel_user.o
72test_map_in_map-objs := test_map_in_map_user.o
73per_socket_stats_example-objs := cookie_uid_helper_example.o
74syscall_tp-objs := syscall_tp_user.o
75cpustat-objs := cpustat_user.o
76xdp_adjust_tail-objs := xdp_adjust_tail_user.o
77xdp_fwd-objs := xdp_fwd_user.o
78task_fd_query-objs := task_fd_query_user.o $(TRACE_HELPERS)
79ibumad-objs := ibumad_user.o
80hbm-objs := hbm.o $(CGROUP_HELPERS)
81
82xdp_router_ipv4-objs := xdp_router_ipv4_user.o $(XDP_SAMPLE)
83
84# Tell kbuild to always build the programs
85always-y := $(tprogs-y)
86always-y += sockex1_kern.o
87always-y += sockex2_kern.o
88always-y += sockex3_kern.o
89always-y += tracex1.bpf.o
90always-y += tracex3.bpf.o
91always-y += tracex4.bpf.o
92always-y += tracex5.bpf.o
93always-y += tracex6.bpf.o
94always-y += trace_output.bpf.o
95always-y += tcbpf1_kern.o
96always-y += tc_l2_redirect_kern.o
97always-y += lathist_kern.o
98always-y += offwaketime.bpf.o
99always-y += spintest.bpf.o
100always-y += map_perf_test.bpf.o
101always-y += parse_varlen.o parse_simple.o parse_ldabs.o
102always-y += trace_event_kern.o
103always-y += sampleip_kern.o
104always-y += lwt_len_hist.bpf.o
105always-y += xdp_tx_iptunnel_kern.o
106always-y += test_map_in_map.bpf.o
107always-y += tcp_synrto_kern.o
108always-y += tcp_rwnd_kern.o
109always-y += tcp_bufs_kern.o
110always-y += tcp_cong_kern.o
111always-y += tcp_iw_kern.o
112always-y += tcp_clamp_kern.o
113always-y += tcp_basertt_kern.o
114always-y += tcp_tos_reflect_kern.o
115always-y += tcp_dumpstats_kern.o
116always-y += xdp2skb_meta_kern.o
117always-y += syscall_tp_kern.o
118always-y += cpustat_kern.o
119always-y += xdp_adjust_tail_kern.o
120always-y += xdp_fwd_kern.o
121always-y += task_fd_query_kern.o
122always-y += ibumad_kern.o
123always-y += hbm_out_kern.o
124always-y += hbm_edt_kern.o
125
126TPROGS_CFLAGS = $(TPROGS_USER_CFLAGS)
127TPROGS_LDFLAGS = $(TPROGS_USER_LDFLAGS)
128
129ifeq ($(ARCH), arm)
130# Strip all except -D__LINUX_ARM_ARCH__ option needed to handle linux
131# headers when arm instruction set identification is requested.
132ARM_ARCH_SELECTOR := $(filter -D__LINUX_ARM_ARCH__%, $(KBUILD_CFLAGS))
133BPF_EXTRA_CFLAGS := $(ARM_ARCH_SELECTOR)
134TPROGS_CFLAGS += $(ARM_ARCH_SELECTOR)
135endif
136
137ifeq ($(ARCH), mips)
138TPROGS_CFLAGS += -D__SANE_USERSPACE_TYPES__
139ifdef CONFIG_MACH_LOONGSON64
140BPF_EXTRA_CFLAGS += -I$(srctree)/arch/mips/include/asm/mach-loongson64
141BPF_EXTRA_CFLAGS += -I$(srctree)/arch/mips/include/asm/mach-generic
142endif
143endif
144
145ifeq ($(ARCH), x86)
146BPF_EXTRA_CFLAGS += -fcf-protection
147endif
148
149COMMON_CFLAGS += -Wall -O2
150COMMON_CFLAGS += -Wmissing-prototypes
151COMMON_CFLAGS += -Wstrict-prototypes
152COMMON_CFLAGS += $(call try-run,\
153	printf "int main() { return 0; }" |\
154	$(CC) -Werror -fsanitize=bounds -x c - -o "$$TMP",-fsanitize=bounds,)
155
156TPROGS_CFLAGS += $(COMMON_CFLAGS)
157TPROGS_CFLAGS += -I$(objtree)/usr/include
158TPROGS_CFLAGS += -I$(srctree)/tools/testing/selftests/bpf/
159TPROGS_CFLAGS += -I$(LIBBPF_INCLUDE)
160TPROGS_CFLAGS += -I$(srctree)/tools/include
161TPROGS_CFLAGS += -I$(srctree)/tools/perf
162TPROGS_CFLAGS += -I$(srctree)/tools/lib
163TPROGS_CFLAGS += -DHAVE_ATTR_TEST=0
164
165ifdef SYSROOT
166COMMON_CFLAGS += --sysroot=$(SYSROOT)
167TPROGS_LDFLAGS := -L$(SYSROOT)/usr/lib
168endif
169
170TPROGS_LDLIBS			+= $(LIBBPF) -lelf -lz
171TPROGLDLIBS_xdp_router_ipv4	+= -lm -pthread
172TPROGLDLIBS_tracex4		+= -lrt
173TPROGLDLIBS_trace_output	+= -lrt
174TPROGLDLIBS_map_perf_test	+= -lrt
175
176# Allows pointing LLC/CLANG to a LLVM backend with bpf support, redefine on cmdline:
177# make M=samples/bpf LLC=~/git/llvm-project/llvm/build/bin/llc CLANG=~/git/llvm-project/llvm/build/bin/clang
178LLC ?= llc
179CLANG ?= clang
180OPT ?= opt
181LLVM_DIS ?= llvm-dis
182LLVM_OBJCOPY ?= llvm-objcopy
183LLVM_READELF ?= llvm-readelf
184BTF_PAHOLE ?= pahole
185
186# Detect that we're cross compiling and use the cross compiler
187ifdef CROSS_COMPILE
188CLANG_ARCH_ARGS = --target=$(notdir $(CROSS_COMPILE:%-=%))
189endif
190
191# Don't evaluate probes and warnings if we need to run make recursively
192ifneq ($(src),)
193HDR_PROBE := $(shell printf "$(pound)include <linux/types.h>\n struct list_head { int a; }; int main() { return 0; }" | \
194	$(CC) $(TPROGS_CFLAGS) $(TPROGS_LDFLAGS) -x c - \
195	-o /dev/null 2>/dev/null && echo okay)
196
197ifeq ($(HDR_PROBE),)
198$(warning WARNING: Detected possible issues with include path.)
199$(warning WARNING: Please install kernel headers locally (make headers_install).)
200endif
201
202BTF_LLC_PROBE := $(shell $(LLC) -march=bpf -mattr=help 2>&1 | grep dwarfris)
203BTF_PAHOLE_PROBE := $(shell $(BTF_PAHOLE) --help 2>&1 | grep BTF)
204BTF_OBJCOPY_PROBE := $(shell $(LLVM_OBJCOPY) --help 2>&1 | grep -i 'usage.*llvm')
205BTF_LLVM_PROBE := $(shell echo "int main() { return 0; }" | \
206			  $(CLANG) --target=bpf -O2 -g -c -x c - -o ./llvm_btf_verify.o; \
207			  $(LLVM_READELF) -S ./llvm_btf_verify.o | grep BTF; \
208			  /bin/rm -f ./llvm_btf_verify.o)
209
210BPF_EXTRA_CFLAGS += -fno-stack-protector
211ifneq ($(BTF_LLVM_PROBE),)
212	BPF_EXTRA_CFLAGS += -g
213else
214ifneq ($(and $(BTF_LLC_PROBE),$(BTF_PAHOLE_PROBE),$(BTF_OBJCOPY_PROBE)),)
215	BPF_EXTRA_CFLAGS += -g
216	LLC_FLAGS += -mattr=dwarfris
217	DWARF2BTF = y
218endif
219endif
220endif
221
222# Trick to allow make to be run from this directory
223all:
224	$(MAKE) -C ../../ M=$(CURDIR) BPF_SAMPLES_PATH=$(CURDIR)
225
226clean:
227	$(MAKE) -C ../../ M=$(CURDIR) clean
228	@find $(CURDIR) -type f -name '*~' -delete
229	@$(RM) -r $(CURDIR)/libbpf $(CURDIR)/bpftool
230
231$(LIBBPF): $(wildcard $(LIBBPF_SRC)/*.[ch] $(LIBBPF_SRC)/Makefile) | $(LIBBPF_OUTPUT)
232# Fix up variables inherited from Kbuild that tools/ build system won't like
233	$(MAKE) -C $(LIBBPF_SRC) RM='rm -rf' EXTRA_CFLAGS="$(COMMON_CFLAGS)" \
234		LDFLAGS="$(TPROGS_LDFLAGS)" srctree=$(BPF_SAMPLES_PATH)/../../ \
235		O= OUTPUT=$(LIBBPF_OUTPUT)/ DESTDIR=$(LIBBPF_DESTDIR) prefix= \
236		$@ install_headers
237
238BPFTOOLDIR := $(TOOLS_PATH)/bpf/bpftool
239BPFTOOL_OUTPUT := $(abspath $(BPF_SAMPLES_PATH))/bpftool
240DEFAULT_BPFTOOL := $(BPFTOOL_OUTPUT)/bootstrap/bpftool
241BPFTOOL ?= $(DEFAULT_BPFTOOL)
242$(DEFAULT_BPFTOOL): $(wildcard $(BPFTOOLDIR)/*.[ch] $(BPFTOOLDIR)/Makefile) | $(BPFTOOL_OUTPUT)
243	$(MAKE) -C $(BPFTOOLDIR) srctree=$(BPF_SAMPLES_PATH)/../../ 		\
244		OUTPUT=$(BPFTOOL_OUTPUT)/ bootstrap
245
246$(LIBBPF_OUTPUT) $(BPFTOOL_OUTPUT):
247	$(call msg,MKDIR,$@)
248	$(Q)mkdir -p $@
249
250$(obj)/syscall_nrs.h:	$(obj)/syscall_nrs.s FORCE
251	$(call filechk,offsets,__SYSCALL_NRS_H__)
252
253targets += syscall_nrs.s
254clean-files += syscall_nrs.h
255
256FORCE:
257
258
259# Verify LLVM compiler tools are available and bpf target is supported by llc
260.PHONY: verify_cmds verify_target_bpf $(CLANG) $(LLC)
261
262verify_cmds: $(CLANG) $(LLC)
263	@for TOOL in $^ ; do \
264		if ! (which -- "$${TOOL}" > /dev/null 2>&1); then \
265			echo "*** ERROR: Cannot find LLVM tool $${TOOL}" ;\
266			exit 1; \
267		else true; fi; \
268	done
269
270verify_target_bpf: verify_cmds
271	@if ! (${LLC} -march=bpf -mattr=help > /dev/null 2>&1); then \
272		echo "*** ERROR: LLVM (${LLC}) does not support 'bpf' target" ;\
273		echo "   NOTICE: LLVM version >= 3.7.1 required" ;\
274		exit 2; \
275	else true; fi
276
277$(BPF_SAMPLES_PATH)/*.c: verify_target_bpf $(LIBBPF)
278$(src)/*.c: verify_target_bpf $(LIBBPF)
279
280libbpf_hdrs: $(LIBBPF)
281$(obj)/$(TRACE_HELPERS) $(obj)/$(CGROUP_HELPERS) $(obj)/$(XDP_SAMPLE): | libbpf_hdrs
282
283.PHONY: libbpf_hdrs
284
285$(obj)/xdp_router_ipv4_user.o: $(obj)/xdp_router_ipv4.skel.h
286
287$(obj)/tracex5.bpf.o: $(obj)/syscall_nrs.h
288$(obj)/hbm_out_kern.o: $(src)/hbm.h $(src)/hbm_kern.h
289$(obj)/hbm.o: $(src)/hbm.h
290$(obj)/hbm_edt_kern.o: $(src)/hbm.h $(src)/hbm_kern.h
291
292# Override includes for xdp_sample_user.o because $(srctree)/usr/include in
293# TPROGS_CFLAGS causes conflicts
294XDP_SAMPLE_CFLAGS += -Wall -O2 \
295		     -I$(src)/../../tools/include \
296		     -I$(src)/../../tools/include/uapi \
297		     -I$(LIBBPF_INCLUDE) \
298		     -I$(src)/../../tools/testing/selftests/bpf
299
300$(obj)/$(XDP_SAMPLE): TPROGS_CFLAGS = $(XDP_SAMPLE_CFLAGS) $(TPROGS_USER_CFLAGS)
301$(obj)/$(XDP_SAMPLE): $(src)/xdp_sample_user.h $(src)/xdp_sample_shared.h
302# Override includes for trace_helpers.o because __must_check won't be defined
303# in our include path.
304$(obj)/$(TRACE_HELPERS): TPROGS_CFLAGS := $(TPROGS_CFLAGS) -D__must_check=
305
306-include $(BPF_SAMPLES_PATH)/Makefile.target
307
308VMLINUX_BTF_PATHS ?= $(abspath $(if $(O),$(O)/vmlinux))				\
309		     $(abspath $(if $(KBUILD_OUTPUT),$(KBUILD_OUTPUT)/vmlinux))	\
310		     $(abspath ./vmlinux)
311VMLINUX_BTF ?= $(abspath $(firstword $(wildcard $(VMLINUX_BTF_PATHS))))
312
313$(obj)/vmlinux.h: $(VMLINUX_BTF) $(BPFTOOL)
314ifeq ($(VMLINUX_H),)
315ifeq ($(VMLINUX_BTF),)
316	$(error Cannot find a vmlinux for VMLINUX_BTF at any of "$(VMLINUX_BTF_PATHS)",\
317		build the kernel or set VMLINUX_BTF like "VMLINUX_BTF=/sys/kernel/btf/vmlinux" or VMLINUX_H variable)
318endif
319	$(Q)$(BPFTOOL) btf dump file $(VMLINUX_BTF) format c > $@
320else
321	$(Q)cp "$(VMLINUX_H)" $@
322endif
323
324clean-files += vmlinux.h
325
326# Get Clang's default includes on this system, as opposed to those seen by
327# '--target=bpf'. This fixes "missing" files on some architectures/distros,
328# such as asm/byteorder.h, asm/socket.h, asm/sockios.h, sys/cdefs.h etc.
329#
330# Use '-idirafter': Don't interfere with include mechanics except where the
331# build would have failed anyways.
332define get_sys_includes
333$(shell $(1) -v -E - </dev/null 2>&1 \
334        | sed -n '/<...> search starts here:/,/End of search list./{ s| \(/.*\)|-idirafter \1|p }') \
335$(shell $(1) -dM -E - </dev/null | grep '#define __riscv_xlen ' | sed 's/#define /-D/' | sed 's/ /=/')
336endef
337
338CLANG_SYS_INCLUDES = $(call get_sys_includes,$(CLANG))
339
340$(obj)/xdp_router_ipv4.bpf.o: $(obj)/xdp_sample.bpf.o
341
342$(obj)/%.bpf.o: $(src)/%.bpf.c $(obj)/vmlinux.h $(src)/xdp_sample.bpf.h $(src)/xdp_sample_shared.h
343	@echo "  CLANG-BPF " $@
344	$(Q)$(CLANG) -g -O2 --target=bpf -D__TARGET_ARCH_$(SRCARCH) \
345		-Wno-compare-distinct-pointer-types -I$(srctree)/include \
346		-I$(srctree)/samples/bpf -I$(srctree)/tools/include \
347		-I$(LIBBPF_INCLUDE) $(CLANG_SYS_INCLUDES) \
348		-c $(filter %.bpf.c,$^) -o $@
349
350LINKED_SKELS := xdp_router_ipv4.skel.h
351clean-files += $(LINKED_SKELS)
352
353xdp_router_ipv4.skel.h-deps := xdp_router_ipv4.bpf.o xdp_sample.bpf.o
354
355LINKED_BPF_SRCS := $(patsubst %.bpf.o,%.bpf.c,$(foreach skel,$(LINKED_SKELS),$($(skel)-deps)))
356
357BPF_SRCS_LINKED := $(notdir $(wildcard $(src)/*.bpf.c))
358BPF_OBJS_LINKED := $(patsubst %.bpf.c,$(obj)/%.bpf.o, $(BPF_SRCS_LINKED))
359BPF_SKELS_LINKED := $(addprefix $(obj)/,$(LINKED_SKELS))
360
361$(BPF_SKELS_LINKED): $(BPF_OBJS_LINKED) $(BPFTOOL)
362	@echo "  BPF GEN-OBJ " $(@:.skel.h=)
363	$(Q)$(BPFTOOL) gen object $(@:.skel.h=.lbpf.o) $(addprefix $(obj)/,$($(@F)-deps))
364	@echo "  BPF GEN-SKEL" $(@:.skel.h=)
365	$(Q)$(BPFTOOL) gen skeleton $(@:.skel.h=.lbpf.o) name $(notdir $(@:.skel.h=)) > $@
366
367# asm/sysreg.h - inline assembly used by it is incompatible with llvm.
368# But, there is no easy way to fix it, so just exclude it since it is
369# useless for BPF samples.
370# below we use long chain of commands, clang | opt | llvm-dis | llc,
371# to generate final object file. 'clang' compiles the source into IR
372# with native target, e.g., x64, arm64, etc. 'opt' does bpf CORE IR builtin
373# processing (llvm12) and IR optimizations. 'llvm-dis' converts
374# 'opt' output to IR, and finally 'llc' generates bpf byte code.
375$(obj)/%.o: $(src)/%.c
376	@echo "  CLANG-bpf " $@
377	$(Q)$(CLANG) $(NOSTDINC_FLAGS) $(LINUXINCLUDE) $(BPF_EXTRA_CFLAGS) \
378		-I$(obj) -I$(srctree)/tools/testing/selftests/bpf/ \
379		-I$(LIBBPF_INCLUDE) \
380		-D__KERNEL__ -D__BPF_TRACING__ -Wno-unused-value -Wno-pointer-sign \
381		-D__TARGET_ARCH_$(SRCARCH) -Wno-compare-distinct-pointer-types \
382		-Wno-gnu-variable-sized-type-not-at-end \
383		-Wno-address-of-packed-member -Wno-tautological-compare \
384		-Wno-unknown-warning-option $(CLANG_ARCH_ARGS) \
385		-fno-asynchronous-unwind-tables \
386		-I$(srctree)/samples/bpf/ -include asm_goto_workaround.h \
387		-O2 -emit-llvm -Xclang -disable-llvm-passes -c $< -o - | \
388		$(OPT) -O2 -mtriple=bpf-pc-linux | $(LLVM_DIS) | \
389		$(LLC) -march=bpf $(LLC_FLAGS) -filetype=obj -o $@
390ifeq ($(DWARF2BTF),y)
391	$(BTF_PAHOLE) -J $@
392endif
393