Updated documentation

Signed-off-by: Github Action <ubpf@users.noreply.github.com>
16 files changed
tree: db9f64e40ebc8c794af57d2e82c05668acec631d
  1. .github/
  2. aarch64_test/
  3. bin/
  4. cmake/
  5. external/
  6. search/
  7. test_framework/
  8. tests/
  9. ubpf/
  10. ubpf_plugin/
  11. vm/
  12. .gitignore
  13. .gitmodules
  14. .travis.yml
  15. bc_s.png
  16. bdwn.png
  17. closed.png
  18. CMakeLists.txt
  19. dir_93effe02d2e8dd09437fb49d0adaddf7.html
  20. dir_cf6c78462b393272f91793a3a49557d3.html
  21. doc.png
  22. doxygen.css
  23. doxygen.png
  24. doxygen.svg
  25. dynsections.js
  26. files.html
  27. folderclosed.png
  28. folderopen.png
  29. globals.html
  30. globals_defs.html
  31. globals_enum.html
  32. globals_eval.html
  33. globals_func.html
  34. globals_type.html
  35. index.html
  36. jquery.js
  37. LICENSE.txt
  38. mainpage_8dox.html
  39. menu.js
  40. menudata.js
  41. nav_f.png
  42. nav_g.png
  43. nav_h.png
  44. open.png
  45. README.md
  46. requirements.txt
  47. splitbar.png
  48. sync_off.png
  49. sync_on.png
  50. tab_a.png
  51. tab_b.png
  52. tab_h.png
  53. tab_s.png
  54. tabs.css
  55. ubpf_8h.html
  56. ubpf_8h_source.html


Userspace eBPF VM

Build Status Coverage Status


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).

Building with CMake

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

Running the tests

Linux and MacOS

cmake --build build --target test --


ctest --test-dir build

Building with make (Linux)

Run 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.

Running the tests (Linux)

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.

Before running the test (assuming Debian derived distro)

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

Running the test

make -C vm COVERAGE=1
nosetests -v   # run tests

After running the test

coveralls --gcov-options '\-lp' -i $PWD/vm/ubpf_vm.c -i $PWD/vm/ubpf_jit_x86_64.c -i $PWD/vm/ubpf_loader.c

Compiling C to eBPF

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 prog.o to ubpf_load_elf, or to the stdin of the vm/test binary.


Please fork the project on GitHub and open a pull request. You can run all the tests with nosetests.


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>.