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