ipcache

Documentation

Overview

+groupName=maps

Index

• Constants
• func BackedByLPM() bool
• func Reopen() error
• func SupportsDelete() bool
• type Key
  • func NewKey(ip net.IP, mask net.IPMask) Key
  • func (in *Key) DeepCopy() *Key
  • func (in *Key) DeepCopyInto(out *Key)
  • func (in *Key) DeepCopyMapKey() bpf.MapKey
  • func (k *Key) GetKeyPtr() unsafe.Pointer
  • func (k Key) IPNet() *net.IPNet
  • func (k Key) NewValue() bpf.MapValue
  • func (k Key) Prefix() netip.Prefix
  • func (k Key) String() string
• type Map
  • func IPCacheMap() *Map
  • func NewMap(name string) *Map
  • func (m *Map) DeleteWithOverwrite(k bpf.MapKey) error
  • func (m *Map) GetMaxPrefixLengths() (ipv6, ipv4 int)
• type RemoteEndpointInfo
  • func (in *RemoteEndpointInfo) DeepCopy() *RemoteEndpointInfo
  • func (in *RemoteEndpointInfo) DeepCopyInto(out *RemoteEndpointInfo)
  • func (in *RemoteEndpointInfo) DeepCopyMapValue() bpf.MapValue
  • func (v *RemoteEndpointInfo) GetValuePtr() unsafe.Pointer
  • func (v *RemoteEndpointInfo) String() string

Constants

const (
	// MaxEntries is the maximum number of keys that can be present in the
	// RemoteEndpointMap.
	MaxEntries = 512000

	// Name is the canonical name for the IPCache map on the filesystem.
	Name = "cilium_ipcache"
)

Functions

func BackedByLPM

func BackedByLPM() bool

BackedByLPM returns true if the IPCache is backed by a proper LPM implementation (provided by Linux kernels 4.11 or later), false otherwise.

func Reopen

func Reopen() error

Reopen attempts to close and re-open the IPCache map at the standard path on the filesystem.

func SupportsDelete

func SupportsDelete() bool

SupportsDelete determines whether the underlying kernel map type supports the delete operation.

Types

type Key

type Key struct {
	Prefixlen uint32 `align:"lpm_key"`
	Pad1      uint16 `align:"pad1"`
	Pad2      uint8  `align:"pad2"`
	Family    uint8  `align:"family"`
	// represents both IPv6 and IPv4 (in the lowest four bytes)
	IP types.IPv6 `align:"$union0"`
}

Key implements the bpf.MapKey interface.

Must be in sync with struct ipcache_key in <bpf/lib/maps.h> +k8s:deepcopy-gen=true +k8s:deepcopy-gen:interfaces=github.com/cilium/cilium/pkg/bpf.MapKey

func NewKey

func NewKey(ip net.IP, mask net.IPMask) Key

NewKey returns an Key based on the provided IP address and mask. The address family is automatically detected

func (*Key) DeepCopy

func (in *Key) DeepCopy() *Key

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Key.

func (*Key) DeepCopyInto

func (in *Key) DeepCopyInto(out *Key)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*Key) DeepCopyMapKey

func (in *Key) DeepCopyMapKey() bpf.MapKey

DeepCopyMapKey is an autogenerated deepcopy function, copying the receiver, creating a new bpf.MapKey.

func (*Key) GetKeyPtr

func (k *Key) GetKeyPtr() unsafe.Pointer

GetKeyPtr returns the unsafe pointer to the BPF key

func (Key) IPNet

func (k Key) IPNet() *net.IPNet

func (Key) NewValue

func (k Key) NewValue() bpf.MapValue

NewValue returns a new empty instance of the structure representing the BPF map value

func (Key) Prefix

func (k Key) Prefix() netip.Prefix

func (Key) String

func (k Key) String() string

type Map

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

Map represents an IPCache BPF map.

func IPCacheMap

func IPCacheMap() *Map

IPCacheMap gets the ipcache Map singleton. If it has not already been done, this also initializes the Map.

func NewMap

func NewMap(name string) *Map

NewMap instantiates a Map.

func (*Map) DeleteWithOverwrite

func (m *Map) DeleteWithOverwrite(k bpf.MapKey) error

DeleteWithOverwrite removes a key from the ipcache BPF map. If delete is not supported, the entry's value will be overwritten with zeroes to signify that it's an invalid entry.

func (*Map) GetMaxPrefixLengths

func (m *Map) GetMaxPrefixLengths() (ipv6, ipv4 int)

GetMaxPrefixLengths determines how many unique prefix lengths are supported simultaneously based on the underlying BPF map type in use.

type RemoteEndpointInfo

type RemoteEndpointInfo struct {
	SecurityIdentity uint32     `align:"sec_label"`
	TunnelEndpoint   types.IPv4 `align:"tunnel_endpoint"`

	Key uint8 `align:"key"`
	// contains filtered or unexported fields
}

RemoteEndpointInfo implements the bpf.MapValue interface. It contains the security identity of a remote endpoint. +k8s:deepcopy-gen=true +k8s:deepcopy-gen:interfaces=github.com/cilium/cilium/pkg/bpf.MapValue

func (*RemoteEndpointInfo) DeepCopy

func (in *RemoteEndpointInfo) DeepCopy() *RemoteEndpointInfo

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RemoteEndpointInfo.

func (*RemoteEndpointInfo) DeepCopyInto

func (in *RemoteEndpointInfo) DeepCopyInto(out *RemoteEndpointInfo)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*RemoteEndpointInfo) DeepCopyMapValue

func (in *RemoteEndpointInfo) DeepCopyMapValue() bpf.MapValue

DeepCopyMapValue is an autogenerated deepcopy function, copying the receiver, creating a new bpf.MapValue.

func (*RemoteEndpointInfo) GetValuePtr

func (v *RemoteEndpointInfo) GetValuePtr() unsafe.Pointer

GetValuePtr returns the unsafe pointer to the BPF value.

func (*RemoteEndpointInfo) String

func (v *RemoteEndpointInfo) String() string