varun-r-mallya/python-bpf
1
0
Fork 0
mirror of https://github.com/varun-r-mallya/Python-BPF.git synced 2026-02-07 13:40:59 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: Fix helpers and maps guide

Browse Source
This commit is contained in:
Pragyansh Chaturvedi
2026-01-29 02:54:46 +05:30
parent 581269e52b
commit aded125cba
2 changed files with 58 additions and 130 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
docs/user-guide/maps.md
View File

@ -6,6 +6,11 @@ Maps are BPF data structures that provide storage and communication mechanisms.
* Share data between multiple BPF programs
* Communicate with userspace applications
```{note}
**Work in Progress:** PythonBPF is under active development. We are constantly adding support for more map types, helpers, and kfuncs. Check back for updates!
```
For comprehensive documentation on BPF maps, see the [eBPF Maps documentation on ebpf.io](https://ebpf.io/what-is-ebpf/#maps).
## Map Types
PythonBPF supports several map types, each optimized for different use cases.
@ -14,6 +19,8 @@ PythonBPF supports several map types, each optimized for different use cases.
Hash maps provide efficient key-value storage with O(1) lookup time.
> **Linux Kernel Map Type:** `BPF_MAP_TYPE_HASH`
#### Definition
```python
@ -133,6 +140,8 @@ if __name__ == "__main__":
Perf event arrays are used to send data from BPF programs to userspace with high throughput.
> **Linux Kernel Map Type:** `BPF_MAP_TYPE_PERF_EVENT_ARRAY`
#### Definition
```python
@ -227,6 +236,8 @@ def LICENSE() -> str:
Ring buffers provide efficient, ordered event delivery with lower overhead than perf event arrays.
> **Linux Kernel Map Type:** `BPF_MAP_TYPE_RINGBUF`
#### Definition
```python