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