xref: /openbmc/linux/tools/lib/bpf/Makefile (revision 82df5b73) 
1# SPDX-License-Identifier: (LGPL-2.1 OR BSD-2-Clause)
2# Most of this file is copied from tools/lib/traceevent/Makefile
3
4LIBBPF_VERSION := $(shell \
5	grep -oE '^LIBBPF_([0-9.]+)' libbpf.map | \
6	sort -rV | head -n1 | cut -d'_' -f2)
7LIBBPF_MAJOR_VERSION := $(firstword $(subst ., ,$(LIBBPF_VERSION)))
8
9MAKEFLAGS += --no-print-directory
10
11# This will work when bpf is built in tools env. where srctree
12# isn't set and when invoked from selftests build, where srctree
13# is a ".". building_out_of_srctree is undefined for in srctree
14# builds
15ifndef building_out_of_srctree
16srctree := $(patsubst %/,%,$(dir $(CURDIR)))
17srctree := $(patsubst %/,%,$(dir $(srctree)))
18srctree := $(patsubst %/,%,$(dir $(srctree)))
19#$(info Determined 'srctree' to be $(srctree))
20endif
21
22INSTALL = install
23
24# Use DESTDIR for installing into a different root directory.
25# This is useful for building a package. The program will be
26# installed in this directory as if it was the root directory.
27# Then the build tool can move it later.
28DESTDIR ?=
29DESTDIR_SQ = '$(subst ','\'',$(DESTDIR))'
30
31include $(srctree)/tools/scripts/Makefile.arch
32
33ifeq ($(LP64), 1)
34  libdir_relative = lib64
35else
36  libdir_relative = lib
37endif
38
39prefix ?= /usr/local
40libdir = $(prefix)/$(libdir_relative)
41man_dir = $(prefix)/share/man
42man_dir_SQ = '$(subst ','\'',$(man_dir))'
43
44export man_dir man_dir_SQ INSTALL
45export DESTDIR DESTDIR_SQ
46
47include $(srctree)/tools/scripts/Makefile.include
48
49# copy a bit from Linux kbuild
50
51ifeq ("$(origin V)", "command line")
52  VERBOSE = $(V)
53endif
54ifndef VERBOSE
55  VERBOSE = 0
56endif
57
58FEATURE_USER = .libbpf
59FEATURE_TESTS = libelf libelf-mmap zlib bpf reallocarray
60FEATURE_DISPLAY = libelf zlib bpf
61
62INCLUDES = -I. -I$(srctree)/tools/include -I$(srctree)/tools/arch/$(ARCH)/include/uapi -I$(srctree)/tools/include/uapi
63FEATURE_CHECK_CFLAGS-bpf = $(INCLUDES)
64
65check_feat := 1
66NON_CHECK_FEAT_TARGETS := clean TAGS tags cscope help
67ifdef MAKECMDGOALS
68ifeq ($(filter-out $(NON_CHECK_FEAT_TARGETS),$(MAKECMDGOALS)),)
69  check_feat := 0
70endif
71endif
72
73ifeq ($(check_feat),1)
74ifeq ($(FEATURES_DUMP),)
75include $(srctree)/tools/build/Makefile.feature
76else
77include $(FEATURES_DUMP)
78endif
79endif
80
81export prefix libdir src obj
82
83# Shell quotes
84libdir_SQ = $(subst ','\'',$(libdir))
85libdir_relative_SQ = $(subst ','\'',$(libdir_relative))
86
87OBJ		= $@
88N		=
89
90LIB_TARGET	= libbpf.a libbpf.so.$(LIBBPF_VERSION)
91LIB_FILE	= libbpf.a libbpf.so*
92PC_FILE		= libbpf.pc
93
94# Set compile option CFLAGS
95ifdef EXTRA_CFLAGS
96  CFLAGS := $(EXTRA_CFLAGS)
97else
98  CFLAGS := -g -Wall
99endif
100
101ifeq ($(feature-libelf-mmap), 1)
102  override CFLAGS += -DHAVE_LIBELF_MMAP_SUPPORT
103endif
104
105ifeq ($(feature-reallocarray), 0)
106  override CFLAGS += -DCOMPAT_NEED_REALLOCARRAY
107endif
108
109# Append required CFLAGS
110override CFLAGS += $(EXTRA_WARNINGS)
111override CFLAGS += -Werror -Wall
112override CFLAGS += -fPIC
113override CFLAGS += $(INCLUDES)
114override CFLAGS += -fvisibility=hidden
115override CFLAGS += -D_LARGEFILE64_SOURCE -D_FILE_OFFSET_BITS=64
116
117# flags specific for shared library
118SHLIB_FLAGS := -DSHARED
119
120ifeq ($(VERBOSE),1)
121  Q =
122else
123  Q = @
124endif
125
126# Disable command line variables (CFLAGS) override from top
127# level Makefile (perf), otherwise build Makefile will get
128# the same command line setup.
129MAKEOVERRIDES=
130
131all:
132
133export srctree OUTPUT CC LD CFLAGS V
134include $(srctree)/tools/build/Makefile.include
135
136SHARED_OBJDIR	:= $(OUTPUT)sharedobjs/
137STATIC_OBJDIR	:= $(OUTPUT)staticobjs/
138BPF_IN_SHARED	:= $(SHARED_OBJDIR)libbpf-in.o
139BPF_IN_STATIC	:= $(STATIC_OBJDIR)libbpf-in.o
140VERSION_SCRIPT	:= libbpf.map
141BPF_HELPER_DEFS	:= $(OUTPUT)bpf_helper_defs.h
142
143LIB_TARGET	:= $(addprefix $(OUTPUT),$(LIB_TARGET))
144LIB_FILE	:= $(addprefix $(OUTPUT),$(LIB_FILE))
145PC_FILE		:= $(addprefix $(OUTPUT),$(PC_FILE))
146
147TAGS_PROG := $(if $(shell which etags 2>/dev/null),etags,ctags)
148
149GLOBAL_SYM_COUNT = $(shell readelf -s --wide $(BPF_IN_SHARED) | \
150			   cut -d "@" -f1 | sed 's/_v[0-9]_[0-9]_[0-9].*//' | \
151			   sed 's/\[.*\]//' | \
152			   awk '/GLOBAL/ && /DEFAULT/ && !/UND/ {print $$NF}' | \
153			   sort -u | wc -l)
154VERSIONED_SYM_COUNT = $(shell readelf --dyn-syms --wide $(OUTPUT)libbpf.so | \
155			      grep -Eo '[^ ]+@LIBBPF_' | cut -d@ -f1 | sort -u | wc -l)
156
157CMD_TARGETS = $(LIB_TARGET) $(PC_FILE)
158
159all: fixdep
160	$(Q)$(MAKE) all_cmd
161
162all_cmd: $(CMD_TARGETS) check
163
164$(BPF_IN_SHARED): force elfdep zdep bpfdep $(BPF_HELPER_DEFS)
165	@(test -f ../../include/uapi/linux/bpf.h -a -f ../../../include/uapi/linux/bpf.h && ( \
166	(diff -B ../../include/uapi/linux/bpf.h ../../../include/uapi/linux/bpf.h >/dev/null) || \
167	echo "Warning: Kernel ABI header at 'tools/include/uapi/linux/bpf.h' differs from latest version at 'include/uapi/linux/bpf.h'" >&2 )) || true
168	@(test -f ../../include/uapi/linux/bpf_common.h -a -f ../../../include/uapi/linux/bpf_common.h && ( \
169	(diff -B ../../include/uapi/linux/bpf_common.h ../../../include/uapi/linux/bpf_common.h >/dev/null) || \
170	echo "Warning: Kernel ABI header at 'tools/include/uapi/linux/bpf_common.h' differs from latest version at 'include/uapi/linux/bpf_common.h'" >&2 )) || true
171	@(test -f ../../include/uapi/linux/netlink.h -a -f ../../../include/uapi/linux/netlink.h && ( \
172	(diff -B ../../include/uapi/linux/netlink.h ../../../include/uapi/linux/netlink.h >/dev/null) || \
173	echo "Warning: Kernel ABI header at 'tools/include/uapi/linux/netlink.h' differs from latest version at 'include/uapi/linux/netlink.h'" >&2 )) || true
174	@(test -f ../../include/uapi/linux/if_link.h -a -f ../../../include/uapi/linux/if_link.h && ( \
175	(diff -B ../../include/uapi/linux/if_link.h ../../../include/uapi/linux/if_link.h >/dev/null) || \
176	echo "Warning: Kernel ABI header at 'tools/include/uapi/linux/if_link.h' differs from latest version at 'include/uapi/linux/if_link.h'" >&2 )) || true
177	@(test -f ../../include/uapi/linux/if_xdp.h -a -f ../../../include/uapi/linux/if_xdp.h && ( \
178	(diff -B ../../include/uapi/linux/if_xdp.h ../../../include/uapi/linux/if_xdp.h >/dev/null) || \
179	echo "Warning: Kernel ABI header at 'tools/include/uapi/linux/if_xdp.h' differs from latest version at 'include/uapi/linux/if_xdp.h'" >&2 )) || true
180	$(Q)$(MAKE) $(build)=libbpf OUTPUT=$(SHARED_OBJDIR) CFLAGS="$(CFLAGS) $(SHLIB_FLAGS)"
181
182$(BPF_IN_STATIC): force elfdep zdep bpfdep $(BPF_HELPER_DEFS)
183	$(Q)$(MAKE) $(build)=libbpf OUTPUT=$(STATIC_OBJDIR)
184
185$(BPF_HELPER_DEFS): $(srctree)/tools/include/uapi/linux/bpf.h
186	$(QUIET_GEN)$(srctree)/scripts/bpf_helpers_doc.py --header \
187		--file $(srctree)/tools/include/uapi/linux/bpf.h > $(BPF_HELPER_DEFS)
188
189$(OUTPUT)libbpf.so: $(OUTPUT)libbpf.so.$(LIBBPF_VERSION)
190
191$(OUTPUT)libbpf.so.$(LIBBPF_VERSION): $(BPF_IN_SHARED)
192	$(QUIET_LINK)$(CC) $(LDFLAGS) \
193		--shared -Wl,-soname,libbpf.so.$(LIBBPF_MAJOR_VERSION) \
194		-Wl,--version-script=$(VERSION_SCRIPT) $^ -lelf -lz -o $@
195	@ln -sf $(@F) $(OUTPUT)libbpf.so
196	@ln -sf $(@F) $(OUTPUT)libbpf.so.$(LIBBPF_MAJOR_VERSION)
197
198$(OUTPUT)libbpf.a: $(BPF_IN_STATIC)
199	$(QUIET_LINK)$(RM) $@; $(AR) rcs $@ $^
200
201$(OUTPUT)libbpf.pc:
202	$(QUIET_GEN)sed -e "s|@PREFIX@|$(prefix)|" \
203		-e "s|@LIBDIR@|$(libdir_SQ)|" \
204		-e "s|@VERSION@|$(LIBBPF_VERSION)|" \
205		< libbpf.pc.template > $@
206
207check: check_abi
208
209check_abi: $(OUTPUT)libbpf.so
210	@if [ "$(GLOBAL_SYM_COUNT)" != "$(VERSIONED_SYM_COUNT)" ]; then	 \
211		echo "Warning: Num of global symbols in $(BPF_IN_SHARED)"	 \
212		     "($(GLOBAL_SYM_COUNT)) does NOT match with num of"	 \
213		     "versioned symbols in $^ ($(VERSIONED_SYM_COUNT))." \
214		     "Please make sure all LIBBPF_API symbols are"	 \
215		     "versioned in $(VERSION_SCRIPT)." >&2;		 \
216		readelf -s --wide $(BPF_IN_SHARED) |			 \
217		    cut -d "@" -f1 | sed 's/_v[0-9]_[0-9]_[0-9].*//' |	 \
218		    sed 's/\[.*\]//' |					 \
219		    awk '/GLOBAL/ && /DEFAULT/ && !/UND/ {print $$NF}'|  \
220		    sort -u > $(OUTPUT)libbpf_global_syms.tmp;		 \
221		readelf --dyn-syms --wide $(OUTPUT)libbpf.so |		 \
222		    grep -Eo '[^ ]+@LIBBPF_' | cut -d@ -f1 |		 \
223		    sort -u > $(OUTPUT)libbpf_versioned_syms.tmp; 	 \
224		diff -u $(OUTPUT)libbpf_global_syms.tmp			 \
225		     $(OUTPUT)libbpf_versioned_syms.tmp;		 \
226		rm $(OUTPUT)libbpf_global_syms.tmp			 \
227		   $(OUTPUT)libbpf_versioned_syms.tmp;			 \
228		exit 1;							 \
229	fi
230
231define do_install_mkdir
232	if [ ! -d '$(DESTDIR_SQ)$1' ]; then		\
233		$(INSTALL) -d -m 755 '$(DESTDIR_SQ)$1';	\
234	fi
235endef
236
237define do_install
238	if [ ! -d '$(DESTDIR_SQ)$2' ]; then		\
239		$(INSTALL) -d -m 755 '$(DESTDIR_SQ)$2';	\
240	fi;						\
241	$(INSTALL) $1 $(if $3,-m $3,) '$(DESTDIR_SQ)$2'
242endef
243
244install_lib: all_cmd
245	$(call QUIET_INSTALL, $(LIB_TARGET)) \
246		$(call do_install_mkdir,$(libdir_SQ)); \
247		cp -fpR $(LIB_FILE) $(DESTDIR)$(libdir_SQ)
248
249install_headers: $(BPF_HELPER_DEFS)
250	$(call QUIET_INSTALL, headers) \
251		$(call do_install,bpf.h,$(prefix)/include/bpf,644); \
252		$(call do_install,libbpf.h,$(prefix)/include/bpf,644); \
253		$(call do_install,btf.h,$(prefix)/include/bpf,644); \
254		$(call do_install,libbpf_util.h,$(prefix)/include/bpf,644); \
255		$(call do_install,libbpf_common.h,$(prefix)/include/bpf,644); \
256		$(call do_install,xsk.h,$(prefix)/include/bpf,644); \
257		$(call do_install,bpf_helpers.h,$(prefix)/include/bpf,644); \
258		$(call do_install,$(BPF_HELPER_DEFS),$(prefix)/include/bpf,644); \
259		$(call do_install,bpf_tracing.h,$(prefix)/include/bpf,644); \
260		$(call do_install,bpf_endian.h,$(prefix)/include/bpf,644); \
261		$(call do_install,bpf_core_read.h,$(prefix)/include/bpf,644);
262
263install_pkgconfig: $(PC_FILE)
264	$(call QUIET_INSTALL, $(PC_FILE)) \
265		$(call do_install,$(PC_FILE),$(libdir_SQ)/pkgconfig,644)
266
267install: install_lib install_pkgconfig install_headers
268
269### Cleaning rules
270
271config-clean:
272	$(call QUIET_CLEAN, config)
273	$(Q)$(MAKE) -C $(srctree)/tools/build/feature/ clean >/dev/null
274
275clean:
276	$(call QUIET_CLEAN, libbpf) $(RM) -rf $(CMD_TARGETS)		     \
277		*~ .*.d .*.cmd LIBBPF-CFLAGS $(BPF_HELPER_DEFS)		     \
278		$(SHARED_OBJDIR) $(STATIC_OBJDIR)			     \
279		$(addprefix $(OUTPUT),					     \
280			    *.o *.a *.so *.so.$(LIBBPF_MAJOR_VERSION) *.pc)
281	$(call QUIET_CLEAN, core-gen) $(RM) $(OUTPUT)FEATURE-DUMP.libbpf
282
283
284
285PHONY += force elfdep zdep bpfdep cscope tags
286force:
287
288elfdep:
289	@if [ "$(feature-libelf)" != "1" ]; then echo "No libelf found"; exit 1 ; fi
290
291zdep:
292	@if [ "$(feature-zlib)" != "1" ]; then echo "No zlib found"; exit 1 ; fi
293
294bpfdep:
295	@if [ "$(feature-bpf)" != "1" ]; then echo "BPF API too old"; exit 1 ; fi
296
297cscope:
298	ls *.c *.h > cscope.files
299	cscope -b -q -I $(srctree)/include -f cscope.out
300
301tags:
302	rm -f TAGS tags
303	ls *.c *.h | xargs $(TAGS_PROG) -a
304
305# Declare the contents of the .PHONY variable as phony.  We keep that
306# information in a variable so we can use it in if_changed and friends.
307.PHONY: $(PHONY)
308
309# Delete partially updated (corrupted) files on error
310.DELETE_ON_ERROR:
311