xref: /linux/samples/bpf/Makefile (revision 7f71507851fc7764b36a3221839607d3a45c2025)
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
149TPROGS_CFLAGS += -Wall -O2
150TPROGS_CFLAGS += -Wmissing-prototypes
151TPROGS_CFLAGS += -Wstrict-prototypes
152TPROGS_CFLAGS += $(call try-run,\
153	printf "int main() { return 0; }" |\
154	$(CC) -Werror -fsanitize=bounds -x c - -o "$$TMP",-fsanitize=bounds,)
155
156TPROGS_CFLAGS += -I$(objtree)/usr/include
157TPROGS_CFLAGS += -I$(srctree)/tools/testing/selftests/bpf/
158TPROGS_CFLAGS += -I$(LIBBPF_INCLUDE)
159TPROGS_CFLAGS += -I$(srctree)/tools/include
160TPROGS_CFLAGS += -I$(srctree)/tools/perf
161TPROGS_CFLAGS += -I$(srctree)/tools/lib
162TPROGS_CFLAGS += -DHAVE_ATTR_TEST=0
163
164ifdef SYSROOT
165TPROGS_CFLAGS += --sysroot=$(SYSROOT)
166TPROGS_LDFLAGS := -L$(SYSROOT)/usr/lib
167endif
168
169TPROGS_LDLIBS			+= $(LIBBPF) -lelf -lz
170TPROGLDLIBS_xdp_router_ipv4	+= -lm -pthread
171TPROGLDLIBS_tracex4		+= -lrt
172TPROGLDLIBS_trace_output	+= -lrt
173TPROGLDLIBS_map_perf_test	+= -lrt
174
175# Allows pointing LLC/CLANG to a LLVM backend with bpf support, redefine on cmdline:
176# make M=samples/bpf LLC=~/git/llvm-project/llvm/build/bin/llc CLANG=~/git/llvm-project/llvm/build/bin/clang
177LLC ?= llc
178CLANG ?= clang
179OPT ?= opt
180LLVM_DIS ?= llvm-dis
181LLVM_OBJCOPY ?= llvm-objcopy
182LLVM_READELF ?= llvm-readelf
183BTF_PAHOLE ?= pahole
184
185# Detect that we're cross compiling and use the cross compiler
186ifdef CROSS_COMPILE
187CLANG_ARCH_ARGS = --target=$(notdir $(CROSS_COMPILE:%-=%))
188endif
189
190# Don't evaluate probes and warnings if we need to run make recursively
191ifneq ($(src),)
192HDR_PROBE := $(shell printf "$(pound)include <linux/types.h>\n struct list_head { int a; }; int main() { return 0; }" | \
193	$(CC) $(TPROGS_CFLAGS) $(TPROGS_LDFLAGS) -x c - \
194	-o /dev/null 2>/dev/null && echo okay)
195
196ifeq ($(HDR_PROBE),)
197$(warning WARNING: Detected possible issues with include path.)
198$(warning WARNING: Please install kernel headers locally (make headers_install).)
199endif
200
201BTF_LLC_PROBE := $(shell $(LLC) -march=bpf -mattr=help 2>&1 | grep dwarfris)
202BTF_PAHOLE_PROBE := $(shell $(BTF_PAHOLE) --help 2>&1 | grep BTF)
203BTF_OBJCOPY_PROBE := $(shell $(LLVM_OBJCOPY) --help 2>&1 | grep -i 'usage.*llvm')
204BTF_LLVM_PROBE := $(shell echo "int main() { return 0; }" | \
205			  $(CLANG) --target=bpf -O2 -g -c -x c - -o ./llvm_btf_verify.o; \
206			  $(LLVM_READELF) -S ./llvm_btf_verify.o | grep BTF; \
207			  /bin/rm -f ./llvm_btf_verify.o)
208
209BPF_EXTRA_CFLAGS += -fno-stack-protector
210ifneq ($(BTF_LLVM_PROBE),)
211	BPF_EXTRA_CFLAGS += -g
212else
213ifneq ($(and $(BTF_LLC_PROBE),$(BTF_PAHOLE_PROBE),$(BTF_OBJCOPY_PROBE)),)
214	BPF_EXTRA_CFLAGS += -g
215	LLC_FLAGS += -mattr=dwarfris
216	DWARF2BTF = y
217endif
218endif
219endif
220
221# Trick to allow make to be run from this directory
222all:
223	$(MAKE) -C ../../ M=$(CURDIR) BPF_SAMPLES_PATH=$(CURDIR)
224
225clean:
226	$(MAKE) -C ../../ M=$(CURDIR) clean
227	@find $(CURDIR) -type f -name '*~' -delete
228	@$(RM) -r $(CURDIR)/libbpf $(CURDIR)/bpftool
229
230$(LIBBPF): $(wildcard $(LIBBPF_SRC)/*.[ch] $(LIBBPF_SRC)/Makefile) | $(LIBBPF_OUTPUT)
231# Fix up variables inherited from Kbuild that tools/ build system won't like
232	$(MAKE) -C $(LIBBPF_SRC) RM='rm -rf' EXTRA_CFLAGS="$(TPROGS_CFLAGS)" \
233		LDFLAGS="$(TPROGS_LDFLAGS)" srctree=$(BPF_SAMPLES_PATH)/../../ \
234		O= OUTPUT=$(LIBBPF_OUTPUT)/ DESTDIR=$(LIBBPF_DESTDIR) prefix= \
235		$@ install_headers
236
237BPFTOOLDIR := $(TOOLS_PATH)/bpf/bpftool
238BPFTOOL_OUTPUT := $(abspath $(BPF_SAMPLES_PATH))/bpftool
239DEFAULT_BPFTOOL := $(BPFTOOL_OUTPUT)/bootstrap/bpftool
240BPFTOOL ?= $(DEFAULT_BPFTOOL)
241$(DEFAULT_BPFTOOL): $(wildcard $(BPFTOOLDIR)/*.[ch] $(BPFTOOLDIR)/Makefile) | $(BPFTOOL_OUTPUT)
242	$(MAKE) -C $(BPFTOOLDIR) srctree=$(BPF_SAMPLES_PATH)/../../ 		\
243		OUTPUT=$(BPFTOOL_OUTPUT)/ bootstrap
244
245$(LIBBPF_OUTPUT) $(BPFTOOL_OUTPUT):
246	$(call msg,MKDIR,$@)
247	$(Q)mkdir -p $@
248
249$(obj)/syscall_nrs.h:	$(obj)/syscall_nrs.s FORCE
250	$(call filechk,offsets,__SYSCALL_NRS_H__)
251
252targets += syscall_nrs.s
253clean-files += syscall_nrs.h
254
255FORCE:
256
257
258# Verify LLVM compiler tools are available and bpf target is supported by llc
259.PHONY: verify_cmds verify_target_bpf $(CLANG) $(LLC)
260
261verify_cmds: $(CLANG) $(LLC)
262	@for TOOL in $^ ; do \
263		if ! (which -- "$${TOOL}" > /dev/null 2>&1); then \
264			echo "*** ERROR: Cannot find LLVM tool $${TOOL}" ;\
265			exit 1; \
266		else true; fi; \
267	done
268
269verify_target_bpf: verify_cmds
270	@if ! (${LLC} -march=bpf -mattr=help > /dev/null 2>&1); then \
271		echo "*** ERROR: LLVM (${LLC}) does not support 'bpf' target" ;\
272		echo "   NOTICE: LLVM version >= 3.7.1 required" ;\
273		exit 2; \
274	else true; fi
275
276$(BPF_SAMPLES_PATH)/*.c: verify_target_bpf $(LIBBPF)
277$(src)/*.c: verify_target_bpf $(LIBBPF)
278
279libbpf_hdrs: $(LIBBPF)
280$(obj)/$(TRACE_HELPERS) $(obj)/$(CGROUP_HELPERS) $(obj)/$(XDP_SAMPLE): | libbpf_hdrs
281
282.PHONY: libbpf_hdrs
283
284$(obj)/xdp_router_ipv4_user.o: $(obj)/xdp_router_ipv4.skel.h
285
286$(obj)/tracex5.bpf.o: $(obj)/syscall_nrs.h
287$(obj)/hbm_out_kern.o: $(src)/hbm.h $(src)/hbm_kern.h
288$(obj)/hbm.o: $(src)/hbm.h
289$(obj)/hbm_edt_kern.o: $(src)/hbm.h $(src)/hbm_kern.h
290
291# Override includes for xdp_sample_user.o because $(srctree)/usr/include in
292# TPROGS_CFLAGS causes conflicts
293XDP_SAMPLE_CFLAGS += -Wall -O2 \
294		     -I$(src)/../../tools/include \
295		     -I$(src)/../../tools/include/uapi \
296		     -I$(LIBBPF_INCLUDE) \
297		     -I$(src)/../../tools/testing/selftests/bpf
298
299$(obj)/$(XDP_SAMPLE): TPROGS_CFLAGS = $(XDP_SAMPLE_CFLAGS) $(TPROGS_USER_CFLAGS)
300$(obj)/$(XDP_SAMPLE): $(src)/xdp_sample_user.h $(src)/xdp_sample_shared.h
301# Override includes for trace_helpers.o because __must_check won't be defined
302# in our include path.
303$(obj)/$(TRACE_HELPERS): TPROGS_CFLAGS := $(TPROGS_CFLAGS) -D__must_check=
304
305-include $(BPF_SAMPLES_PATH)/Makefile.target
306
307VMLINUX_BTF_PATHS ?= $(abspath $(if $(O),$(O)/vmlinux))				\
308		     $(abspath $(if $(KBUILD_OUTPUT),$(KBUILD_OUTPUT)/vmlinux))	\
309		     $(abspath ./vmlinux)
310VMLINUX_BTF ?= $(abspath $(firstword $(wildcard $(VMLINUX_BTF_PATHS))))
311
312$(obj)/vmlinux.h: $(VMLINUX_BTF) $(BPFTOOL)
313ifeq ($(VMLINUX_H),)
314ifeq ($(VMLINUX_BTF),)
315	$(error Cannot find a vmlinux for VMLINUX_BTF at any of "$(VMLINUX_BTF_PATHS)",\
316		build the kernel or set VMLINUX_BTF like "VMLINUX_BTF=/sys/kernel/btf/vmlinux" or VMLINUX_H variable)
317endif
318	$(Q)$(BPFTOOL) btf dump file $(VMLINUX_BTF) format c > $@
319else
320	$(Q)cp "$(VMLINUX_H)" $@
321endif
322
323clean-files += vmlinux.h
324
325# Get Clang's default includes on this system, as opposed to those seen by
326# '--target=bpf'. This fixes "missing" files on some architectures/distros,
327# such as asm/byteorder.h, asm/socket.h, asm/sockios.h, sys/cdefs.h etc.
328#
329# Use '-idirafter': Don't interfere with include mechanics except where the
330# build would have failed anyways.
331define get_sys_includes
332$(shell $(1) -v -E - </dev/null 2>&1 \
333        | sed -n '/<...> search starts here:/,/End of search list./{ s| \(/.*\)|-idirafter \1|p }') \
334$(shell $(1) -dM -E - </dev/null | grep '#define __riscv_xlen ' | sed 's/#define /-D/' | sed 's/ /=/')
335endef
336
337CLANG_SYS_INCLUDES = $(call get_sys_includes,$(CLANG))
338
339$(obj)/xdp_router_ipv4.bpf.o: $(obj)/xdp_sample.bpf.o
340
341$(obj)/%.bpf.o: $(src)/%.bpf.c $(obj)/vmlinux.h $(src)/xdp_sample.bpf.h $(src)/xdp_sample_shared.h
342	@echo "  CLANG-BPF " $@
343	$(Q)$(CLANG) -g -O2 --target=bpf -D__TARGET_ARCH_$(SRCARCH) \
344		-Wno-compare-distinct-pointer-types -I$(srctree)/include \
345		-I$(srctree)/samples/bpf -I$(srctree)/tools/include \
346		-I$(LIBBPF_INCLUDE) $(CLANG_SYS_INCLUDES) \
347		-c $(filter %.bpf.c,$^) -o $@
348
349LINKED_SKELS := xdp_router_ipv4.skel.h
350clean-files += $(LINKED_SKELS)
351
352xdp_router_ipv4.skel.h-deps := xdp_router_ipv4.bpf.o xdp_sample.bpf.o
353
354LINKED_BPF_SRCS := $(patsubst %.bpf.o,%.bpf.c,$(foreach skel,$(LINKED_SKELS),$($(skel)-deps)))
355
356BPF_SRCS_LINKED := $(notdir $(wildcard $(src)/*.bpf.c))
357BPF_OBJS_LINKED := $(patsubst %.bpf.c,$(obj)/%.bpf.o, $(BPF_SRCS_LINKED))
358BPF_SKELS_LINKED := $(addprefix $(obj)/,$(LINKED_SKELS))
359
360$(BPF_SKELS_LINKED): $(BPF_OBJS_LINKED) $(BPFTOOL)
361	@echo "  BPF GEN-OBJ " $(@:.skel.h=)
362	$(Q)$(BPFTOOL) gen object $(@:.skel.h=.lbpf.o) $(addprefix $(obj)/,$($(@F)-deps))
363	@echo "  BPF GEN-SKEL" $(@:.skel.h=)
364	$(Q)$(BPFTOOL) gen skeleton $(@:.skel.h=.lbpf.o) name $(notdir $(@:.skel.h=)) > $@
365
366# asm/sysreg.h - inline assembly used by it is incompatible with llvm.
367# But, there is no easy way to fix it, so just exclude it since it is
368# useless for BPF samples.
369# below we use long chain of commands, clang | opt | llvm-dis | llc,
370# to generate final object file. 'clang' compiles the source into IR
371# with native target, e.g., x64, arm64, etc. 'opt' does bpf CORE IR builtin
372# processing (llvm12) and IR optimizations. 'llvm-dis' converts
373# 'opt' output to IR, and finally 'llc' generates bpf byte code.
374$(obj)/%.o: $(src)/%.c
375	@echo "  CLANG-bpf " $@
376	$(Q)$(CLANG) $(NOSTDINC_FLAGS) $(LINUXINCLUDE) $(BPF_EXTRA_CFLAGS) \
377		-I$(obj) -I$(srctree)/tools/testing/selftests/bpf/ \
378		-I$(LIBBPF_INCLUDE) \
379		-D__KERNEL__ -D__BPF_TRACING__ -Wno-unused-value -Wno-pointer-sign \
380		-D__TARGET_ARCH_$(SRCARCH) -Wno-compare-distinct-pointer-types \
381		-Wno-gnu-variable-sized-type-not-at-end \
382		-Wno-address-of-packed-member -Wno-tautological-compare \
383		-Wno-unknown-warning-option $(CLANG_ARCH_ARGS) \
384		-fno-asynchronous-unwind-tables \
385		-I$(srctree)/samples/bpf/ -include asm_goto_workaround.h \
386		-O2 -emit-llvm -Xclang -disable-llvm-passes -c $< -o - | \
387		$(OPT) -O2 -mtriple=bpf-pc-linux | $(LLVM_DIS) | \
388		$(LLC) -march=bpf $(LLC_FLAGS) -filetype=obj -o $@
389ifeq ($(DWARF2BTF),y)
390	$(BTF_PAHOLE) -J $@
391endif
392