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