Python-BPF
This is an LLVM IR generator for eBPF programs in Python. We use llvmlite to generate LLVM IR from pure Python. This is then compiled to LLVM object files, which can be loaded into the kernel for execution. We do not rely on BCC to do our compilation.
DO NOT USE IN PRODUCTION. IN DEVELOPMENT.
Video Demo
Video demo for code under demo/
Slide Deck
Slide deck explaining the project
Installation
- Have
clanginstalled. pip install pythonbpf
Usage
# pythonbpf_example.py
from pythonbpf import bpf, map, bpfglobal, section, compile
from pythonbpf.helpers import bpf_ktime_get_ns
from pythonbpf.maps import HashMap
from ctypes import c_void_p, c_int64, c_int32, c_uint64
@bpf
@map
def last() -> HashMap:
return HashMap(key=c_uint64, value=c_uint64, max_entries=1)
@bpf
@section("tracepoint/syscalls/sys_enter_execve")
def hello(ctx: c_void_p) -> c_int32:
print("entered")
return c_int32(0)
@bpf
@section("tracepoint/syscalls/sys_exit_execve")
def hello_again(ctx: c_void_p) -> c_int64:
print("exited")
key = 0
tsp = last().lookup(key)
print(tsp)
ts = bpf_ktime_get_ns()
return c_int64(0)
@bpf
@bpfglobal
def LICENSE() -> str:
return "GPL"
def some_normal_function():
print("normal function")
# compiles and dumps object file in the same directory
compile()
- Run
python pythonbpf_example.pyto get the compiled object file that can be then loaded into the kernel.
Development
- Make a virtual environment and activate it using
python3 -m venv .venv && source .venv/bin/activate. - Run
make installto install the required dependencies. - Run
maketo see the compilation output of the example. - Run
check.shto check if generated object file passes through the verifier inside the examples directory. - Run
makein theexamples/c-formdirectory to modify the example C BPF program to check the actual LLVM IR generated by clang.
Development Notes
- Run
./check.sh check execve2.o;in examples folder to check if the object code passes the verifier. - Run
./check.sh run execve2.o;in examples folder to run the object code usingbpftool.
Authors
Metadata
Release files for pythonbpf 0.1.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| pythonbpf-0.1.2.tar.gz | 26.7 kB | With provenance | Details for pythonbpf-0.1.2.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| pythonbpf-0.1.2-py3-none-any.whl | Python 3 | none | any | Details for pythonbpf-0.1.2-py3-none-any.whl |
Total release size: 56.6 kB
Release files / pythonbpf-0.1.2.tar.gz
| Download URL | pythonbpf-0.1.2.tar.gz |
|---|---|
| Size | 26.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
c52b0eae99ac4a9fd4c71b8c243f2be4ae85e22f1729704fd88ba5545c08306c
|
|
BLAKE2b-256 checksum How to use checksums |
34611018fd41e9da1cdfe4727d3b292f1bd2f7d7777e42811fe623861e485c8b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 21, 2025.
Transparency logRelease files / pythonbpf-0.1.2-py3-none-any.whl
| Download URL | pythonbpf-0.1.2-py3-none-any.whl |
|---|---|
| Size | 29.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
33f54e3e47d9436cdae1310b96efe518e88a6f343a844d3dbd72b8a288a3e109
|
|
BLAKE2b-256 checksum How to use checksums |
faea03a42434123e76f4f3f4b90730baa3631201d18e366557c81a21f7507c90
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 21, 2025.
Transparency logSecurity for pythonbpf 0.1.2
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
Full provenance
Both files in this release have been uploaded with provenance metadata.
Attestation for pythonbpf-0.1.2.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 21, 2025.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.