This project aims to create an Apache-licensed library for executing eBPF programs. The primary implementation of eBPF lives in the Linux kernel, but due to its GPL license it can't be used in many projects.
Linux documentation for the eBPF instruction set
Instruction set reference
This project includes an eBPF assembler, disassembler, interpreter (for all platforms), and JIT compiler (for x86-64 and Arm64 targets).
Before following any of the instructions below for building, testing, contributing, etc, please be sure to properly check out the source code which requires properly initializing submodules:
git submodule init git submodule update --recursive
Note: This works on Windows, Linux, and MacOS, provided the prerequisites are installed.
cmake -S . -B build -DUBPF_ENABLE_TESTS=true cmake --build build --config Debug
cmake --build build --target test --
ctest --test-dir build
make -C vm to build the VM. This produces a static library
libubpf.a and a simple executable used by the testsuite. After building the library you can install using
make -C vm install via either root or sudo.
To run the tests, you first need to build the vm code then use nosetests to execute the tests. Note: The tests have some dependencies that need to be present. See the .travis.yml for details.
sudo apt-get update sudo apt-get -y install python python-pip python-setuptools python-wheel python-nose python2 -m pip install --upgrade "pip<21.0" python2 -m pip install -r requirements.txt python2 -m pip install cpp-coveralls
make -C vm COVERAGE=1 nosetests -v # run tests
coveralls --gcov-options '\-lp' -i $PWD/vm/ubpf_vm.c -i $PWD/vm/ubpf_jit_x86_64.c -i $PWD/vm/ubpf_loader.c
You'll need Clang 3.7.
clang-3.7 -O2 -target bpf -c prog.c -o prog.o
You can then pass the contents of
ubpf_load_elf, or to the stdin of the
Please fork the project on GitHub and open a pull request. You can run all the tests with
Copyright 2015, Big Switch Networks, Inc. Licensed under the Apache License, Version 2.0 <LICENSE.txt or http://www.apache.org/licenses/LICENSE-2.0>.