tools/lib/bpf/Makefile

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