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