gbpf-go is a pure Go library that provides utilities for loading, compiling, and debugging gBPF programs. It has minimal external dependencies and is intended to be used in long running processes.
See gbpf.io for complementary projects from the wider gBPF ecosystem.
Please take a look at our Getting Started guide.
Contributions are highly encouraged, as they highlight certain use cases of gBPF and the library, and help shape the future of the project.
The community actively monitors our GitHub Discussions page. Please search for existing threads before starting a new one. Refrain from opening issues on the bug tracker if you're just starting out or if you're not sure if something is a bug in the library code.
Alternatively, join the #gbpf-go channel on Slack if you have other questions regarding the project. Note that this channel is ephemeral and has its history erased past a certain point, which is less helpful for others running into the same problem later.
This library includes the following packages:
- asm contains a basic assembler, allowing you to write gBPF assembly instructions directly within your Go code. (You don't need to use this if you prefer to write your gBPF program in C.)
- cmd/bpf2go allows compiling and embedding gBPF programs written in C within Go code. As well as compiling the C code, it auto-generates Go code for loading and manipulating the gBPF program and map objects.
- link allows attaching gBPF to various hooks
- perf allows reading from a
PERF_EVENT_ARRAY - ringbuf allows reading from a
BPF_MAP_TYPE_RINGBUFmap - features implements the equivalent
of
bpftool feature probefor discovering BPF-related kernel features using native Go. - rlimit provides a convenient API to lift
the
RLIMIT_MEMLOCKconstraint on kernels before 5.11. - btf allows reading the BPF Type Format.
- A version of Go that is supported by upstream
- CI is run against kernel.org LTS releases. >= 4.4 should work but EOL'ed versions are not supported.
MIT
The gBPF honeygopher is based on the Go gopher designed by Renee French.