Merge branch 'feature/ebpf-example' into development

Author: ahuangfeng

.gitignore

@@ -15,6 +15,8 @@ sender_continuous
 client_continuous
 client_monitoring
 client_socket
+client_ebpf_user
+vmlinux.h
 
 docker/tmp
 

INSTALL.md

@@ -40,9 +40,11 @@ $ ./export.sh       # Optional: export LD_LIBRARY_PATH with /usr/local/lib in gl
 ### Configure options
 There are some custom `./configure` options : 
 - `--with-examples`: compile examples directory. Not compiled by default.
+- `--with-ebpf-example`: compile eBPF example. Not compiled by default. It check eBPF dependencies too.
 - `--with-test`: compile testdirectory. Not compiled by default.
 - `--with-pkgconfigdir=[/own_path/pkgconfig]`: overwrite pkgconfig directory to install .pc file [default: ${PREFIX}/lib/pkgconfig]
 - `--enable-tcmalloc`: enable compilation with tcmalloc instead of native malloc. tcmalloc should be installed first.
+- `--with-linux=[/own_path/linux/src]`: linux source code necesary for eBPF compilation [default: /usr/src/linux]. (On Ubuntu use /usr/src/<linux>-generic version)
 
 ## Uninstalling
 ```shell

README.md

@@ -209,6 +209,7 @@ There are some samples implemented during the development of the project [here](
 - `client_socket.c` : example using a custom socket instead of creating a new one from the library.
 - `sender_sample.c` : simple example for minimal usage of the sender library.
 - `sender_json.c` : sample reading a json file and sending the bytes by the library.
+- `eBPF/client_ebpf_user.c`: example with a custom eBPF load balancer.
 
 ## Docker
 See [Docker docs](docker)

configure.ac

@@ -27,7 +27,14 @@ AC_ARG_WITH([examples],
     [ with_examples=no ]
 )
 
+AC_ARG_WITH([ebpf-example],
+    [AS_HELP_STRING([--with-ebpf-example], [Build eBPF example])],
+    [ with_ebpf_example=yes ],
+    [ with_ebpf_example=no ]
+)
+
 AM_CONDITIONAL(EXAMPLES, test "x$with_examples" = "xyes")
+AM_CONDITIONAL(EBPF_EXAMPLE, test "x$with_ebpf_example" = "xyes")
 
 AC_ARG_WITH([test],
     [AS_HELP_STRING([--with-test], [Build test files])],
@@ -56,10 +63,60 @@ then
     AC_SUBST([EXTRA_LDFLAGS])
 fi
 
+dnl eBPF example
+if test "x$with_ebpf_example" = "xyes"
+then
+    AC_CHECK_LIB(bpf, bpf_object__find_map_by_name, [], [
+        echo "*** Error! You need to install libbpf first. ***"
+        exit -1
+    ])
+
+    AC_CHECK_PROG([CCLANG], [clang], [yes])
+    AS_IF([ test "x$CCLANG" != xyes ], [
+        echo "*** Error! eBPF needs CLANG as dependency. Please install it first. ***"
+        exit -1
+    ])
+    AC_CHECK_PROG([BPFTOOL], [bpftool], [yes])
+    AS_IF([ test "x$BPFTOOL" != xyes ], [
+        echo "*** Error! eBPF needs bpftool as dependency. Please install it first. ***"
+        exit -1
+    ])
+
+    AC_CHECK_FILE([/sys/kernel/btf/vmlinux], [], [
+        echo "*** Error! eBPF needs vmlinux to compile the eBPF program. ***"
+        exit -1
+    ])
+
+    AC_ARG_WITH([linux],
+        [AS_HELP_STRING([--with-linux], [Linux source headers [[default: /usr/src/linux]]])],
+        [LINUX_HEADERS="$withval"],
+        [LINUX_HEADERS=/usr/src/linux]
+    )
+    AC_SUBST([LINUX_HEADERS])
+    dnl linux source headers
+    AC_CHECK_FILES([
+        $LINUX_HEADERS/include/uapi/linux
+        $LINUX_HEADERS/arch/x86/include
+        $LINUX_HEADERS/arch/x86/include/generated
+        $LINUX_HEADERS/include
+        $LINUX_HEADERS/arch/x86/include/uapi
+        $LINUX_HEADERS/arch/x86/include/generated/uapi
+        $LINUX_HEADERS/include/uapi
+        $LINUX_HEADERS/include/generated/uapi
+        ], [], [
+            echo "*** Error! eBPFa needs linux source to compile the eBPF program. ***"
+            echo "*** Linux sources were not found in $LINUX_HEADERS ***"
+            exit -1
+        ]
+    )
+    dnl TODO: check for bpf dependencies
+fi
+
 AC_CONFIG_FILES([
     Makefile
     src/Makefile
     examples/Makefile
+    examples/eBPF/Makefile
     test/Makefile
     unyte-udp-notif.pc
 ])

examples/Makefile.am

@@ -1,5 +1,9 @@
 AM_LDFLAGS = $(EXTRA_LDFLAGS)
 
+if EBPF_EXAMPLE
+SUBDIRS = eBPF
+endif
+
 ACLOCAL_AMFLAGS = -I m4
 
 bin_PROGRAMS = client_monitoring client_sample client_socket sender_json sender_sample

examples/eBPF/Makefile.am

@@ -0,0 +1,26 @@
+AM_LDFLAGS = $(EXTRA_LDFLAGS)
+
+ACLOCAL_AMFLAGS = -I m4
+
+LINUX_SRC=$(LINUX_HEADERS)
+LINUX_H=-I$(LINUX_SRC)/arch/x86/include -I$(LINUX_SRC)/arch/x86/include/generated -I$(LINUX_SRC)/include -I$(LINUX_SRC)/arch/x86/include/uapi -I$(LINUX_SRC)/arch/x86/include/generated/uapi -I$(LINUX_SRC)/include/uapi -I$(LINUX_SRC)/include/generated/uapi
+EBPF_CLDFLAGS=-fcolor-diagnostics -D_FILE_OFFSET_BITS=64 -Wall -Winvalid-pch -g -fPIC -g -O2 -D__KERNEL__ -D__TARGET_ARCH_x86 --target=bpf -Wall -Wno-macro-redefined -D__BPF_TRACING__
+
+vmlinux.h:
+	bpftool btf dump file /sys/kernel/btf/vmlinux format c > $@
+
+reuseport_udp_kern.o: vmlinux.h
+	clang $(LINUX_H) $(EBPF_CLDFLAGS) -o $@ -c reuseport_udp_kern.c
+
+all-local: reuseport_udp_kern.o
+
+reuseport_udp_kern_odir = $(libdir)
+reuseport_udp_kern_o_DATA = \
+	reuseport_udp_kern.o \
+	$(NULL)
+
+bin_PROGRAMS = client_ebpf_user
+
+client_ebpf_user_SOURCES = client_ebpf_user.c
+client_ebpf_user_CFLAGS = -I$(srcdir)/../../src -Wextra -Wall -ansi -g -std=c11 -D_GNU_SOURCE -fPIC -pthread
+client_ebpf_user_LDADD = $(srcdir)/../../src/libunyte-udp-notif.la

examples/eBPF/README.md

@@ -0,0 +1,24 @@
+# eBPF example
+
+## Dependencies
+
+To use eBPF loadbalancing `Python3` is needed for eBPF compilation.
+
+On Ubuntu:
+```shell
+$ sudo apt install linux-headers-$(uname -r) clang libbpf-dev linux-tools-$(uname -r)
+```
+
+On Centos (tested on `Centos 8`):
+```shell
+$ sudo yum install kernel-headers clang
+$ sudo dnf --enablerepo=powertools install libbpf-devel
+$ sudo dnf install bpftool
+```
+
+## Install
+To build this directory, use the following options on `configure` script:
+- `--with-ebpf-example` and `--with-linux=<linux_headers_path>`
+```shell
+$ ./configure --with-ebpf-example --with-linux=/usr/src/linux
+```