manager

Dec 17, 2021

Changes in this version

type Options

+ ExcludedSections []string

type Probe

+ Ifindex int32

+ IfindexNetns uint64

+ Ifname string

type ProbeIdentificationPair

+ func (pip ProbeIdentificationPair) GetEBPFFuncName(isCopy bool) string

Feb 10, 2025

Changes in this version

type NetlinkSocket

+ func (ns *NetlinkSocket) DecreaseFilterCount(index int) int

+ func (ns *NetlinkSocket) IncreaseFilterCount(index int)

Jan 3, 2025

Changes in this version

type ConstantEditor

+ ValueCallback func(prog *ebpf.ProgramSpec) interface{}

+ func (ce *ConstantEditor) GetValue(prog *ebpf.ProgramSpec) interface{}

Dec 23, 2024

Changes in this version

type Options

+ RemoveRlimit bool

Oct 29, 2024

Changes in this version

type Manager

+ func (m *Manager) GetMapSpecs() (map[string]*ebpf.MapSpec, error)

Jul 10, 2024

Changes in this version

type Manager

+ func (m *Manager) CloneProgramWithSpecEditor(UID string, newProbe *Probe, constantsEditors []ConstantEditor, ...) error

Jul 8, 2024

Changes in this version

+ var ErrManagerELFLoaded = errors.New("the manager has already loaded the ELF data")

+ var ErrManagerNotELFLoaded = errors.New("the manager has not loaded the ELF data")

type Manager

+ func (m *Manager) LoadELF(elf io.ReaderAt) error

type PerfMap

+ func (m *PerfMap) Flush()

type PerfMapOptions

+ WakeupEvents int

type RingBuffer

+ func (rb *RingBuffer) Flush()

Jun 3, 2024

Changes in this version

+ var ErrProbeIDNotExist = errors.New("probe id file doesn't exist")

type Options

+ BypassEnabled bool

Apr 8, 2024

Changes in this version

type Options

+ KernelModuleBTFLoadFunc func(kmodName string) (*btf.Spec, error)

Jan 9, 2024

Changes in this version

+ type InstructionPatcherFunc func(m *Manager) error

type Manager

+ InstructionPatchers []InstructionPatcherFunc

Dec 7, 2023

Changes in this version

type PerfMap

+ func (m *PerfMap) Telemetry() (usage []uint64, lost []uint64)

type PerfMapOptions

+ TelemetryEnabled bool

type RingBuffer

+ func (rb *RingBuffer) Telemetry() (usage uint64, ok bool)

type RingBufferOptions

+ TelemetryEnabled bool

Nov 30, 2023

Changes in this version

type Manager

+ func (m *Manager) GetProgramSpecs() (map[string]*ebpf.ProgramSpec, error)

Nov 23, 2023

Changes in this version

type PerfMap

+ func (m *PerfMap) BufferSize() int

type RingBuffer

+ func (rb *RingBuffer) BufferSize() int

type RingBufferOptions

+ RecordGetter func() *ringbuf.Record

+ RecordHandler func(record *ringbuf.Record, ringBuffer *RingBuffer, manager *Manager)

Aug 21, 2023

Changes in this version

type Options

+ SkipPerfMapReaderStartup map[string]bool

+ SkipRingbufferReaderStartup map[string]bool

Aug 16, 2023

Changes in this version

+ type FunctionExcluder interface

+ CleanCaches func()

+ ShouldExcludeFunction func(name string, prog *ebpf.ProgramSpec) bool

type Options

+ AdditionalExcludedFunctionCollector FunctionExcluder

Aug 7, 2023

Changes in this version

type Manager

+ func (m *Manager) StopReaders(cleanup MapCleanupType) error

Jul 17, 2023

Changes in this version

type Probe

+ func (p *Probe) ID() uint32

Jun 27, 2023

Changes in this version

+ type AttachMethod uint32

+ const AttachMethodNotSet

+ const AttachWithPerfEventOpen

+ const AttachWithProbeEvents

type Manager

+ func (m *Manager) GetMaps() (map[string]*ebpf.Map, error)

+ func (m *Manager) GetPrograms() (map[string]*ebpf.Program, error)

type MapSpecEditor

+ Key btf.Type

+ KeySize uint32

+ Value btf.Type

+ ValueSize uint32

type MapSpecEditorFlag

+ const EditKeyValue

type Options

+ DefaultUprobeAttachMethod AttachMethod

+ ExcludedMaps []string

+ MapEditorsIgnoreMissingMaps bool

type Probe

+ UprobeAttachMethod AttachMethod

Mar 9, 2023

Changes in this version

type Manager

+ func (m *Manager) Pause() error

+ func (m *Manager) Resume() error

type Probe

+ func (p *Probe) Pause() error

+ func (p *Probe) Resume() error

Feb 3, 2023

Changes in this version

+ type NetlinkSocketCache struct

+ func NewNetlinkSocketCache() *NetlinkSocketCache

+ func (nsc *NetlinkSocketCache) GetNetlinkSocket(nsHandle uint64, nsID uint32) (*NetlinkSocket, error)

Jan 19, 2023

Changes in this version

+ var ErrMissingEditorFlags = errors.New("missing editor flags in map editor")

type Options

+ KeepKernelBTF bool

type Probe

+ func (p *Probe) GetKprobeType() string

+ func (p *Probe) GetUprobeType() string

Nov 1, 2022

Changes in this version

+ const Egress

+ const Exited

+ const Ingress

+ const MaxBPFClassifierNameLen

+ const MaxEventNameLen

+ const MinFunctionNameLen

+ const ProbeType

+ const RetProbeType

+ const Running

+ const UnknownProbeType

+ var BpfFlagActDirect = uint32(1)

+ var ErrCloneProbeRequired = errors.New("use CloneProbe to load 2 instances of the same program")

+ var ErrClosedFd = errors.New("use of closed file descriptor")

+ var ErrIdentificationPairInUse = errors.New("the provided identification pair already exists")

+ var ErrInterfaceNotSet = errors.New("interface not provided: at least one of IfIndex and IfName must be set")

+ var ErrKProbeHookPointNotExist = errors.New("the kprobe hook point doesn't exist")

+ var ErrKprobeIDNotExist = errors.New("kprobe id file doesn't exist")

+ var ErrManagerNotInitialized = errors.New("the manager must be initialized first")

+ var ErrManagerNotStarted = errors.New("the manager must be started first")

+ var ErrManagerRunning = errors.New("the manager is already running")

+ var ErrMapInitialized = errors.New("map already initialized")

+ var ErrMapNameInUse = errors.New("the provided map name is already taken")

+ var ErrMapNotInitialized = errors.New("the map must be initialized first")

+ var ErrMapNotRunning = errors.New("the map is not running")

+ var ErrNoNetworkDirection = errors.New("a valid network direction is required to attach a TC classifier")

+ var ErrNotSupported = errors.New("not supported")

+ var ErrPinnedObjectNotFound = errors.New("pinned object not found")

+ var ErrProbeNotInitialized = errors.New("the probe must be initialized first")

+ var ErrProbeRunning = errors.New("the probe is already running")

+ var ErrSectionFormat = errors.New("invalid section format")

+ var ErrSymbolNotFound = errors.New("symbol not found")

+ var ErrUnknownSection = errors.New("unknown section")

+ var ErrUnknownSectionOrFuncName = errors.New("unknown section or eBPF function name")

+ var ErrUprobeIDNotExist = errors.New("uprobe id file doesn't exist")

+ func BPF(cmd int, attr unsafe.Pointer, size uintptr) (uintptr, error)

+ func ConcatErrors(err1, err2 error) error

+ func FindFilterFunction(funcName string) (string, error)

+ func FindSymbolOffsets(path string, pattern *regexp.Regexp) ([]elf.Symbol, error)

+ func GenerateEventName(probeType, funcName, UID string, attachPID int) (string, error)

+ func GenerateTCFilterName(UID, sectionName string, attachPID int) (string, error)

+ func GetEnv(key string, dfault string, combineWith ...string) string

+ func GetSyscallFnName(name string) (string, error)

+ func GetSyscallFnNameWithSymFile(name string, symFile string) (string, error)

+ func GetTracepointID(category, name string) (int, error)

+ func Getpid() int

+ func HostProc(combineWith ...string) string

+ func IsUnreferencedSymbol(err error) bool

+ func OpenAndListSymbols(path string) (*elf.File, []elf.Symbol, error)

+ func ReadKprobeEvents() (string, error)

+ func ReadUprobeEvents() (string, error)

+ func SanitizeUprobeAddresses(f *elf.File, syms []elf.Symbol)

+ type AllOf struct

+ Selectors []ProbesSelector

+ func (ao *AllOf) EditProbeIdentificationPair(old ProbeIdentificationPair, new ProbeIdentificationPair)

+ func (ao *AllOf) GetProbesIdentificationPairList() []ProbeIdentificationPair

+ func (ao *AllOf) RunValidator(manager *Manager) error

+ func (ao *AllOf) String() string

+ type BestEffort struct

+ Selectors []ProbesSelector

+ func (be *BestEffort) EditProbeIdentificationPair(old ProbeIdentificationPair, new ProbeIdentificationPair)

+ func (be *BestEffort) GetProbesIdentificationPairList() []ProbeIdentificationPair

+ func (be *BestEffort) RunValidator(manager *Manager) error

+ func (be *BestEffort) String() string

+ type ConstantEditor struct

+ BTFGlobalConstant bool

+ FailOnMissing bool

+ Name string

+ ProbeIdentificationPairs []ProbeIdentificationPair

+ Value interface{}

+ type Editor struct

+ ReferenceOffsets map[string][]int

+ func Edit(insns *asm.Instructions) *Editor

+ func (ed *Editor) RewriteConstant(symbol string, value uint64) error

+ type FD struct

+ func NewFD(value uint32) *FD

+ func (fd *FD) Close() error

+ func (fd *FD) Forget()

+ func (fd *FD) String() string

+ func (fd *FD) Value() (uint32, error)

+ type InnerOuterMapSpec struct

+ InnerMapName string

+ OuterMapName string

+ type KprobeAttachMethod uint32

+ const AttachKprobeMethodNotSet

+ const AttachKprobeWithKprobeEvents

+ const AttachKprobeWithPerfEventOpen

+ type Manager struct

+ DumpHandler func(manager *Manager, mapName string, currentMap *ebpf.Map) string

+ InstructionPatcher func(m *Manager) error

+ Maps []*Map

+ PerfMaps []*PerfMap

+ Probes []*Probe

+ RingBuffers []*RingBuffer

+ func (m *Manager) AddHook(UID string, newProbe *Probe) error

+ func (m *Manager) CleanupNetworkNamespace(nsID uint32) error

+ func (m *Manager) CloneMap(name string, newName string, options MapOptions) (*ebpf.Map, error)

+ func (m *Manager) ClonePerfRing(name string, newName string, options MapOptions, perfMapOptions PerfMapOptions) (*ebpf.Map, error)

+ func (m *Manager) CloneProgram(UID string, newProbe *Probe, constantsEditors []ConstantEditor, ...) error

+ func (m *Manager) DetachHook(id ProbeIdentificationPair) error

+ func (m *Manager) DumpMaps(maps ...string) (string, error)

+ func (m *Manager) GetMap(name string) (*ebpf.Map, bool, error)

+ func (m *Manager) GetMapSpec(name string) (*ebpf.MapSpec, bool, error)

+ func (m *Manager) GetNetlinkSocket(nsHandle uint64, nsID uint32) (*NetlinkSocket, error)

+ func (m *Manager) GetPerfMap(name string) (*PerfMap, bool)

+ func (m *Manager) GetProbe(id ProbeIdentificationPair) (*Probe, bool)

+ func (m *Manager) GetProgram(id ProbeIdentificationPair) ([]*ebpf.Program, bool, error)

+ func (m *Manager) GetProgramSpec(id ProbeIdentificationPair) ([]*ebpf.ProgramSpec, bool, error)

+ func (m *Manager) GetRingBuffer(name string) (*RingBuffer, bool)

+ func (m *Manager) Init(elf io.ReaderAt) error

+ func (m *Manager) InitWithOptions(elf io.ReaderAt, options Options) error

+ func (m *Manager) NewCachedNetlinkSocket(nsHandle uint64, nsID uint32) (*NetlinkSocket, error)

+ func (m *Manager) NewMap(spec ebpf.MapSpec, options MapOptions) (*ebpf.Map, error)

+ func (m *Manager) NewPerfRing(spec ebpf.MapSpec, options MapOptions, perfMapOptions PerfMapOptions) (*ebpf.Map, error)

+ func (m *Manager) NewRingBuffer(spec ebpf.MapSpec, options MapOptions, ringBufferOptions RingBufferOptions) (*ebpf.Map, error)

+ func (m *Manager) RenameProbeIdentificationPair(oldID ProbeIdentificationPair, newID ProbeIdentificationPair) error

+ func (m *Manager) Start() error

+ func (m *Manager) Stop(cleanup MapCleanupType) error

+ func (m *Manager) UpdateActivatedProbes(selectors []ProbesSelector) error

+ func (m *Manager) UpdateMapRoutes(router ...MapRoute) error

+ func (m *Manager) UpdateTailCallRoutes(router ...TailCallRoute) error

+ type Map struct

+ Contents []ebpf.MapKV

+ Freeze bool

+ Name string

+ func (m *Map) Close(cleanup MapCleanupType) error

+ func (m *Map) Init(manager *Manager) error

+ type MapCleanupType int

+ const CleanAll

+ const CleanExternal

+ const CleanExternalEdited

+ const CleanExternalPinned

+ const CleanExternalPinnedAndEdited

+ const CleanInternal

+ const CleanInternalNotPinned

+ const CleanInternalPinned

+ type MapOptions struct

+ AlwaysCleanup bool

+ PinPath string

+ type MapRoute struct

+ Key interface{}

+ Map *ebpf.Map

+ RoutedName string

+ RoutingMapName string

+ type MapSpecEditor struct

+ EditorFlag MapSpecEditorFlag

+ Flags uint32

+ MaxEntries uint32

+ Type ebpf.MapType

+ type MapSpecEditorFlag uint

+ const EditFlags

+ const EditMaxEntries

+ const EditType

+ type NetlinkSocket struct

+ Sock *netlink.Handle

+ TCFilterCount map[int]int

+ func NewNetlinkSocket(nsHandle uint64) (*NetlinkSocket, error)

+ type OneOf struct

+ Selectors []ProbesSelector

+ func (oo *OneOf) EditProbeIdentificationPair(old ProbeIdentificationPair, new ProbeIdentificationPair)

+ func (oo *OneOf) GetProbesIdentificationPairList() []ProbeIdentificationPair

+ func (oo *OneOf) RunValidator(manager *Manager) error

+ func (oo *OneOf) String() string

+ type Options struct

+ ActivatedProbes []ProbesSelector

+ ConstantEditors []ConstantEditor

+ DefaultKProbeMaxActive int

+ DefaultKprobeAttachMethod KprobeAttachMethod

+ DefaultPerfRingBufferSize int

+ DefaultProbeRetry uint

+ DefaultProbeRetryDelay time.Duration

+ DefaultRingBufferSize int

+ DefaultWatermark int

+ ExcludedFunctions []string

+ InnerOuterMapSpecs []InnerOuterMapSpec

+ KeepUnmappedProgramSpecs bool

+ MapEditors map[string]*ebpf.Map

+ MapRouter []MapRoute

+ MapSpecEditors map[string]MapSpecEditor

+ RLimit *unix.Rlimit

+ SymFile string

+ TailCallRouter []TailCallRoute

+ VerifierOptions ebpf.CollectionOptions

+ type PerfMap struct

+ func (m *PerfMap) Init(manager *Manager) error

+ func (m *PerfMap) Pause() error

+ func (m *PerfMap) Resume() error

+ func (m *PerfMap) Start() error

+ func (m *PerfMap) Stop(cleanup MapCleanupType) error

+ type PerfMapOptions struct

+ DataHandler func(CPU int, data []byte, perfMap *PerfMap, manager *Manager)

+ LostHandler func(CPU int, count uint64, perfMap *PerfMap, manager *Manager)

+ PerfErrChan chan error

+ PerfRingBufferSize int

+ RecordGetter func() *perf.Record

+ RecordHandler func(record *perf.Record, perfMap *PerfMap, manager *Manager)

+ Watermark int

+ type Probe struct

+ BinaryPath string

+ CGroupPath string

+ CopyProgram bool

+ Enabled bool

+ HookFuncName string

+ IfIndex int

+ IfIndexNetns uint64

+ IfIndexNetnsID uint32

+ IfName string

+ KProbeMaxActive int

+ KeepProgramSpec bool

+ KprobeAttachMethod KprobeAttachMethod

+ MatchFuncName string

+ NetworkDirection TrafficType

+ PerfEventCPUCount int

+ PerfEventConfig int

+ PerfEventPID int

+ PerfEventType int

+ PinPath string

+ ProbeRetry uint

+ ProbeRetryDelay time.Duration

+ SampleFrequency int

+ SamplePeriod int

+ SocketFD int

+ SyscallFuncName string

+ TCCleanupQDisc bool

+ TCFilterHandle uint32

+ TCFilterPrio uint16

+ TCFilterProtocol uint16

+ TracepointCategory string

+ TracepointName string

+ UprobeOffset uint64

+ XDPAttachMode XdpAttachMode

+ func (p *Probe) Attach() error

+ func (p *Probe) Benchmark(in []byte, repeat int, reset func()) (uint32, time.Duration, error)

+ func (p *Probe) Copy() *Probe

+ func (p *Probe) Detach() error

+ func (p *Probe) GetEBPFFuncName() string

+ func (p *Probe) GetLastError() error

+ func (p *Probe) Init(manager *Manager) error

+ func (p *Probe) InitWithOptions(manager *Manager, manualLoadNeeded bool, checkPin bool) error

+ func (p *Probe) IsInitialized() bool

+ func (p *Probe) IsRunning() bool

+ func (p *Probe) IsTCFilterActive() bool

+ func (p *Probe) Program() *ebpf.Program

+ func (p *Probe) RenameProbeIdentificationPair(newID ProbeIdentificationPair) error

+ func (p *Probe) ResolveLink() (netlink.Link, error)

+ func (p *Probe) Stop() error

+ func (p *Probe) Test(in []byte) (uint32, []byte, error)

+ type ProbeIdentificationPair struct

+ EBPFFuncName string

+ EBPFSection string

+ UID string

+ func (pip ProbeIdentificationPair) EBPFDefinitionMatches(id ProbeIdentificationPair) bool

+ func (pip ProbeIdentificationPair) GetKprobeType() string

+ func (pip ProbeIdentificationPair) GetUprobeType() string

+ func (pip ProbeIdentificationPair) Matches(id ProbeIdentificationPair) bool

+ func (pip ProbeIdentificationPair) String() string

+ type ProbeSelector struct

+ func (ps *ProbeSelector) EditProbeIdentificationPair(old ProbeIdentificationPair, new ProbeIdentificationPair)

+ func (ps *ProbeSelector) GetProbesIdentificationPairList() []ProbeIdentificationPair

+ func (ps *ProbeSelector) RunValidator(manager *Manager) error

+ type ProbesSelector interface

+ EditProbeIdentificationPair func(old ProbeIdentificationPair, new ProbeIdentificationPair)

+ GetProbesIdentificationPairList func() []ProbeIdentificationPair

+ RunValidator func(manager *Manager) error

+ type RingBuffer struct

+ func (rb *RingBuffer) Init(manager *Manager) error

+ func (rb *RingBuffer) Start() error

+ func (rb *RingBuffer) Stop(cleanup MapCleanupType) error

+ type RingBufferOptions struct

+ DataHandler func(CPU int, data []byte, ringBuffer *RingBuffer, manager *Manager)

+ ErrChan chan error

+ RingBufferSize int

+ type TailCallRoute struct

+ Key uint32

+ ProbeIdentificationPair ProbeIdentificationPair

+ ProgArrayName string

+ Program *ebpf.Program

+ type TrafficType uint16

+ func (tt TrafficType) String() string

+ type XdpAttachMode int

+ const DefaultTCFilterPriority

+ const XdpAttachModeDrv

+ const XdpAttachModeHw

+ const XdpAttachModeNone

+ const XdpAttachModeSkb