Skip to main content

Python wrapper of libbpf to interact with bpf maps

Project description

Pybpfmaps

Simple standalone python library to interact with bpf/ebpf maps via libbpf bindings.

This project aims to ease communication with eBPF programs using eBPF maps.

Installation

pip install bpfmaps

No need for any other dependencies, because the libbpf binary is built from source inside the github action and included in the python package. You can verify its authenticity by comparing the hashes of the pypi package with the ones printed in the github action that released it.

Usage

import bpfmaps

my_map = bpfmaps.BPF_Map.get_map_by_name('some_global')
my_map[0] = 10

Contributing

Dependencies

To locally work on this project you need to get the libbpf binary and put it into src/bpfmaps/libbpf/

This can be done by extracting it from the pypi package or building from source:

git clone --recurse-submodules git@github.com:PeterStolz/pybpfmaps.git
cd pybpfmaps/dependencies/libbpf/src
OBJDIR=../../../src/bpfmaps/libbpf/ make
cd ../../../

To install the build dependencies you may run:

sudo apt-get update
sudo apt-get install clang llvm libelf-dev libpcap-dev gcc-multilib build-essential linux-libc-dev

Testing

This project uses pytest for testing and the tests for x.py are stored in the file test_x.py. As working with eBPF maps requires root you can execute the tests with:

sudo python3.10 -m pytest ./src

The tests may leave some bpf maps lying around, but they will perish after a reboot.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

bpfmaps-0.0.8.tar.gz (706.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

bpfmaps-0.0.8-py3-none-any.whl (709.2 kB view details)

Uploaded Python 3

File details

Details for the file bpfmaps-0.0.8.tar.gz.

File metadata

  • Download URL: bpfmaps-0.0.8.tar.gz
  • Upload date:
  • Size: 706.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.13

File hashes

Hashes for bpfmaps-0.0.8.tar.gz
Algorithm Hash digest
SHA256 aa61f0973a96cef3696aed8cc6fea7207cdfcc70017931e7424bc758faf46593
MD5 4b2d34f660dd99e997be5de615ba8c40
BLAKE2b-256 7e39cbcaaa4885eba33159b4e7b2e1ad1ba4cda4aa00684556795c51ca08e253

See more details on using hashes here.

File details

Details for the file bpfmaps-0.0.8-py3-none-any.whl.

File metadata

  • Download URL: bpfmaps-0.0.8-py3-none-any.whl
  • Upload date:
  • Size: 709.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.13

File hashes

Hashes for bpfmaps-0.0.8-py3-none-any.whl
Algorithm Hash digest
SHA256 9708cab27030cdfb25e0250cdc4417ddfe7570613ca521d1b0d59dc224f70032
MD5 9c073819bf2d8cffae3e8be007243b4c
BLAKE2b-256 5b45872f8c511e43e9f13d61d347e3ef7a3748c3bcb1615bdc26900a50d7765d

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page