bpftime

(β˜… 1,554)

Userspace eBPF runtime for Observability, Network, GPU & General Extensions Framework

  • .clang-format
  • .gitattributes
  • .gitignore
  • .gitmodules
  • AGENTS.md
  • CITATION.cff
  • CLAUDE.md
  • CMakeLists.txt
  • CODE_OF_CONDUCT.md
  • codecov.yml
  • CONTRIBUTING.md
  • Dockerfile
  • installation.md
  • LICENSE
  • Makefile
  • README.md
  • usage.md

πŸš€ Installation Guide

1. Get the code
git clone https://github.com/eunomia-bpf/bpftime

Downloads the entire project code from GitHub to your computer.

cd bpftime

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker build -t bpftime .

Builds a runnable image based on the Dockerfile.

docker run -p 8080:80 bpftime

Runs the built image as an actual container.

βœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

3. CMake

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • CMake The tool used to generate build configuration.
  • C/C++ 컴파일러 Windows needs Visual Studio (Community edition, free), macOS needs Xcode Command Line Tools, Linux needs the gcc/g++ package.
mkdir build && cd build

Creates a folder to hold the build output and moves into it.

cmake ..

Analyzes the source code and generates build configuration files (must be run inside the build folder).

make

Compiles the code based on the generated build configuration to produce an executable.

βœ… Check that an executable was created inside the build folder, then run it directly (e.g. ./build/app_name).

4. Python

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.
pip install -r benchmark/requirements.txt

Installs the Python libraries listed in requirements.txt (or similar).

python <μ‹€ν–‰ν•  파일λͺ…>.py # READMEμ—μ„œ μ •ν™•ν•œ μ‹€ν–‰ 파일λͺ…을 ν™•μΈν•˜μ„Έμš”

Runs the Python script (or module).

βœ… If it runs without errors and prints output in the terminal, it worked.

5. Make

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Make Usually pre-installed on Linux/macOS. On Windows, install separately (e.g. via MSYS2 or WSL).
make -C example/malloc # Build the eBPF program example

Compiles the code based on the generated build configuration to produce an executable.

βœ… If it finishes without errors, it worked. Try running the generated executable directly.

Pulled directly from this repo's README.

// repository documentation