ebpf

Documentation

Overview

Package ebpf provides functions that allow golang programs to interact with ebpf maps by wrapping the cilium/ebpf library. +groupName=pkg

Index

• Constants
• Variables
• func GetOpenMaps() []*models.BPFMap
• type IterateCallback
• type Map
  • func GetMap(name string) *Map
  • func LoadPinnedMap(fileName string) (*Map, error)
  • func LoadRegisterMap(mapName string) (*Map, error)
  • func MapFromID(id int) (*Map, error)
  • func NewMap(spec *MapSpec) *Map
  • func (m *Map) GetModel() *models.BPFMap
  • func (m *Map) IterateWithCallback(key, value interface{}, cb IterateCallback) error
  • func (m *Map) OpenOrCreate() error
• type MapSpec
• type PinType

Constants

const (
	Hash       = ciliumebpf.Hash
	PerCPUHash = ciliumebpf.PerCPUHash
	Array      = ciliumebpf.Array
	HashOfMaps = ciliumebpf.HashOfMaps
	LPMTrie    = ciliumebpf.LPMTrie

	PinNone   = ciliumebpf.PinNone
	PinByName = ciliumebpf.PinByName
)

Variables

var (
	ErrKeyNotExist = ciliumebpf.ErrKeyNotExist
)

Functions

func GetOpenMaps

func GetOpenMaps() []*models.BPFMap

GetOpenMaps returns a slice of all open BPF maps. This is identical to calling GetMap() on all open maps.

Types

type IterateCallback

type IterateCallback func(key, value interface{})

IterateCallback represents the signature of the callback function expected by the IterateWithCallback method, which in turn is used to iterate all the keys/values of a map.

type Map

type Map struct {
	*ciliumebpf.Map
	// contains filtered or unexported fields
}

Map represents an eBPF map.

func GetMap

func GetMap(name string) *Map

GetMap returns the registered map with the given name or absolute path

func LoadPinnedMap

func LoadPinnedMap(fileName string) (*Map, error)

LoadPinnedMap wraps cilium/ebpf's LoadPinnedMap.

func LoadRegisterMap

func LoadRegisterMap(mapName string) (*Map, error)

LoadRegisterMap loads the specified map from a bpffs pin path and registers its handle in the package-global map register.

func MapFromID

func MapFromID(id int) (*Map, error)

func NewMap

func NewMap(spec *MapSpec) *Map

NewMap creates a new Map object.

func (*Map) GetModel

func (m *Map) GetModel() *models.BPFMap

GetModel returns a BPF map in the representation served via the API.

func (*Map) IterateWithCallback

func (m *Map) IterateWithCallback(key, value interface{}, cb IterateCallback) error

IterateWithCallback iterates through all the keys/values of a map, passing each key/value pair to the cb callback.

func (*Map) OpenOrCreate

func (m *Map) OpenOrCreate() error

OpenOrCreate tries to open or create the eBPF map identified by the spec in the Map object.

type MapSpec

type MapSpec = ciliumebpf.MapSpec

type PinType

type PinType = ciliumebpf.PinType