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