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