Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

variable: return native Go pointers to bpf map memory #1607

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

ti-mo
Copy link
Collaborator

@ti-mo ti-mo commented Nov 7, 2024

Pending the proposal in golang/go#70224, here's the current API proposal for returning Go pointers to 'off-heap' bpf map memory:

func MemoryPointer[T any](mm *Memory, off uint64) (*T, error)
func VariablePointer[T any](v *Variable) (*T, error)

We need a bit of help from the Go runtime to manage the lifecycle of the underlying memory mapping. Currently, this mmaps over a piece of Go heap to allow the GC to track pointers into the bpf map memory, obviating the need for tying the mmap's lifetime to an ebpf.Memory. Instead, any Go pointers into the mmap will keep it alive, removing the risk of use-after-free.

Clearly, this involves some dark arts, so we're not comfortable pushing this on users since Collection.Variables is populated by default. Any change in the runtime or allocator may break this, and the fallout means Go programs segfaulting without any hint as to why, which is not acceptable.

--- Edit ---

Since the runtime.AddManualMemoryCleanup proposal may take a while to implement, land and ship in a Go version we target, I've revived the patch set and put the heap-mapping behaviour behind CollectionOptions.UnsafeVariableExperiment. MemoryPointer is yet unexported, since Map.Memory() is typically called directly by the user and we'd need to store the feature flag in *Map, which doesn't feel ideal.

Alternatively, we could go for an env feature flag instead of CollectionOptions (EBPFUNSAFEVARIABLES=true?), which would allow us to export MemoryPointer and transparantly switch between implementations.

@ti-mo ti-mo mentioned this pull request Feb 18, 2025
@ti-mo ti-mo changed the title [WIP] variable: return native Go pointers to underlying bpf map values variable: return native Go pointers to underlying bpf map values Feb 25, 2025
@ti-mo ti-mo changed the title variable: return native Go pointers to underlying bpf map values variable: return native Go pointers to bpf map memory Feb 27, 2025
@ti-mo ti-mo marked this pull request as ready for review February 27, 2025 15:48
@ti-mo ti-mo requested a review from a team as a code owner February 27, 2025 15:48
Comment on lines +264 to +269
func VariablePointer[T any](v *Variable) (*T, error) {
if err := checkVariable[T](v); err != nil {
return nil, fmt.Errorf("variable pointer %s: %w", v.name, err)
}
return memoryPointer[T](v.mm, v.offset)
}
Copy link
Contributor

@mejedi mejedi Mar 4, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It doesn't look like it is possible to support slices within the same API, does it?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants