xref: /openbmc/linux/tools/lib/bpf/Makefile (revision 9a6b55ac)
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 bpf reallocarray
60FEATURE_DISPLAY = libelf 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			   awk '/GLOBAL/ && /DEFAULT/ && !/UND/ {print $$NF}' | \
152			   sort -u | wc -l)
153VERSIONED_SYM_COUNT = $(shell readelf -s --wide $(OUTPUT)libbpf.so | \
154			      grep -Eo '[^ ]+@LIBBPF_' | cut -d@ -f1 | sort -u | wc -l)
155
156CMD_TARGETS = $(LIB_TARGET) $(PC_FILE)
157
158all: fixdep
159	$(Q)$(MAKE) all_cmd
160
161all_cmd: $(CMD_TARGETS) check
162
163$(BPF_IN_SHARED): force elfdep bpfdep $(BPF_HELPER_DEFS)
164	@(test -f ../../include/uapi/linux/bpf.h -a -f ../../../include/uapi/linux/bpf.h && ( \
165	(diff -B ../../include/uapi/linux/bpf.h ../../../include/uapi/linux/bpf.h >/dev/null) || \
166	echo "Warning: Kernel ABI header at 'tools/include/uapi/linux/bpf.h' differs from latest version at 'include/uapi/linux/bpf.h'" >&2 )) || true
167	@(test -f ../../include/uapi/linux/bpf_common.h -a -f ../../../include/uapi/linux/bpf_common.h && ( \
168	(diff -B ../../include/uapi/linux/bpf_common.h ../../../include/uapi/linux/bpf_common.h >/dev/null) || \
169	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
170	@(test -f ../../include/uapi/linux/netlink.h -a -f ../../../include/uapi/linux/netlink.h && ( \
171	(diff -B ../../include/uapi/linux/netlink.h ../../../include/uapi/linux/netlink.h >/dev/null) || \
172	echo "Warning: Kernel ABI header at 'tools/include/uapi/linux/netlink.h' differs from latest version at 'include/uapi/linux/netlink.h'" >&2 )) || true
173	@(test -f ../../include/uapi/linux/if_link.h -a -f ../../../include/uapi/linux/if_link.h && ( \
174	(diff -B ../../include/uapi/linux/if_link.h ../../../include/uapi/linux/if_link.h >/dev/null) || \
175	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
176	@(test -f ../../include/uapi/linux/if_xdp.h -a -f ../../../include/uapi/linux/if_xdp.h && ( \
177	(diff -B ../../include/uapi/linux/if_xdp.h ../../../include/uapi/linux/if_xdp.h >/dev/null) || \
178	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
179	$(Q)$(MAKE) $(build)=libbpf OUTPUT=$(SHARED_OBJDIR) CFLAGS="$(CFLAGS) $(SHLIB_FLAGS)"
180
181$(BPF_IN_STATIC): force elfdep bpfdep $(BPF_HELPER_DEFS)
182	$(Q)$(MAKE) $(build)=libbpf OUTPUT=$(STATIC_OBJDIR)
183
184$(BPF_HELPER_DEFS): $(srctree)/tools/include/uapi/linux/bpf.h
185	$(Q)$(srctree)/scripts/bpf_helpers_doc.py --header 		\
186		--file $(srctree)/tools/include/uapi/linux/bpf.h > $(BPF_HELPER_DEFS)
187
188$(OUTPUT)libbpf.so: $(OUTPUT)libbpf.so.$(LIBBPF_VERSION)
189
190$(OUTPUT)libbpf.so.$(LIBBPF_VERSION): $(BPF_IN_SHARED)
191	$(QUIET_LINK)$(CC) $(LDFLAGS) \
192		--shared -Wl,-soname,libbpf.so.$(LIBBPF_MAJOR_VERSION) \
193		-Wl,--version-script=$(VERSION_SCRIPT) $^ -lelf -o $@
194	@ln -sf $(@F) $(OUTPUT)libbpf.so
195	@ln -sf $(@F) $(OUTPUT)libbpf.so.$(LIBBPF_MAJOR_VERSION)
196
197$(OUTPUT)libbpf.a: $(BPF_IN_STATIC)
198	$(QUIET_LINK)$(RM) $@; $(AR) rcs $@ $^
199
200$(OUTPUT)libbpf.pc:
201	$(QUIET_GEN)sed -e "s|@PREFIX@|$(prefix)|" \
202		-e "s|@LIBDIR@|$(libdir_SQ)|" \
203		-e "s|@VERSION@|$(LIBBPF_VERSION)|" \
204		< libbpf.pc.template > $@
205
206check: check_abi
207
208check_abi: $(OUTPUT)libbpf.so
209	@if [ "$(GLOBAL_SYM_COUNT)" != "$(VERSIONED_SYM_COUNT)" ]; then	 \
210		echo "Warning: Num of global symbols in $(BPF_IN_SHARED)"	 \
211		     "($(GLOBAL_SYM_COUNT)) does NOT match with num of"	 \
212		     "versioned symbols in $^ ($(VERSIONED_SYM_COUNT))." \
213		     "Please make sure all LIBBPF_API symbols are"	 \
214		     "versioned in $(VERSION_SCRIPT)." >&2;		 \
215		readelf -s --wide $(BPF_IN_SHARED) |			 \
216		    cut -d "@" -f1 | sed 's/_v[0-9]_[0-9]_[0-9].*//' |	 \
217		    awk '/GLOBAL/ && /DEFAULT/ && !/UND/ {print $$NF}'|  \
218		    sort -u > $(OUTPUT)libbpf_global_syms.tmp;		 \
219		readelf -s --wide $(OUTPUT)libbpf.so |			 \
220		    grep -Eo '[^ ]+@LIBBPF_' | cut -d@ -f1 |		 \
221		    sort -u > $(OUTPUT)libbpf_versioned_syms.tmp; 	 \
222		diff -u $(OUTPUT)libbpf_global_syms.tmp			 \
223		     $(OUTPUT)libbpf_versioned_syms.tmp;		 \
224		rm $(OUTPUT)libbpf_global_syms.tmp			 \
225		   $(OUTPUT)libbpf_versioned_syms.tmp;			 \
226		exit 1;							 \
227	fi
228
229define do_install_mkdir
230	if [ ! -d '$(DESTDIR_SQ)$1' ]; then		\
231		$(INSTALL) -d -m 755 '$(DESTDIR_SQ)$1';	\
232	fi
233endef
234
235define do_install
236	if [ ! -d '$(DESTDIR_SQ)$2' ]; then		\
237		$(INSTALL) -d -m 755 '$(DESTDIR_SQ)$2';	\
238	fi;						\
239	$(INSTALL) $1 $(if $3,-m $3,) '$(DESTDIR_SQ)$2'
240endef
241
242install_lib: all_cmd
243	$(call QUIET_INSTALL, $(LIB_TARGET)) \
244		$(call do_install_mkdir,$(libdir_SQ)); \
245		cp -fpR $(LIB_FILE) $(DESTDIR)$(libdir_SQ)
246
247install_headers: $(BPF_HELPER_DEFS)
248	$(call QUIET_INSTALL, headers) \
249		$(call do_install,bpf.h,$(prefix)/include/bpf,644); \
250		$(call do_install,libbpf.h,$(prefix)/include/bpf,644); \
251		$(call do_install,btf.h,$(prefix)/include/bpf,644); \
252		$(call do_install,libbpf_util.h,$(prefix)/include/bpf,644); \
253		$(call do_install,xsk.h,$(prefix)/include/bpf,644); \
254		$(call do_install,bpf_helpers.h,$(prefix)/include/bpf,644); \
255		$(call do_install,$(BPF_HELPER_DEFS),$(prefix)/include/bpf,644); \
256		$(call do_install,bpf_tracing.h,$(prefix)/include/bpf,644); \
257		$(call do_install,bpf_endian.h,$(prefix)/include/bpf,644); \
258		$(call do_install,bpf_core_read.h,$(prefix)/include/bpf,644);
259
260install_pkgconfig: $(PC_FILE)
261	$(call QUIET_INSTALL, $(PC_FILE)) \
262		$(call do_install,$(PC_FILE),$(libdir_SQ)/pkgconfig,644)
263
264install: install_lib install_pkgconfig
265
266### Cleaning rules
267
268config-clean:
269	$(call QUIET_CLEAN, config)
270	$(Q)$(MAKE) -C $(srctree)/tools/build/feature/ clean >/dev/null
271
272clean:
273	$(call QUIET_CLEAN, libbpf) $(RM) -rf $(CMD_TARGETS) \
274		*.o *~ *.a *.so *.so.$(LIBBPF_MAJOR_VERSION) .*.d .*.cmd \
275		*.pc LIBBPF-CFLAGS $(BPF_HELPER_DEFS) \
276		$(SHARED_OBJDIR) $(STATIC_OBJDIR)
277	$(call QUIET_CLEAN, core-gen) $(RM) $(OUTPUT)FEATURE-DUMP.libbpf
278
279
280
281PHONY += force elfdep bpfdep cscope tags
282force:
283
284elfdep:
285	@if [ "$(feature-libelf)" != "1" ]; then echo "No libelf found"; exit 1 ; fi
286
287bpfdep:
288	@if [ "$(feature-bpf)" != "1" ]; then echo "BPF API too old"; exit 1 ; fi
289
290cscope:
291	ls *.c *.h > cscope.files
292	cscope -b -q -I $(srctree)/include -f cscope.out
293
294tags:
295	rm -f TAGS tags
296	ls *.c *.h | xargs $(TAGS_PROG) -a
297
298# Declare the contents of the .PHONY variable as phony.  We keep that
299# information in a variable so we can use it in if_changed and friends.
300.PHONY: $(PHONY)
301
302# Delete partially updated (corrupted) files on error
303.DELETE_ON_ERROR:
304