ipcache

Documentation

Overview

+groupName=maps

Index

• Constants
• type Key
  • func NewKey(ip net.IP, mask net.IPMask, clusterID uint8) Key
  • func (k *Key) New() bpf.MapKey
  • func (k Key) Prefix() netip.Prefix
  • func (k Key) String() string
• type Map
  • func IPCacheMap() *Map
  • func NewMap(name string) *Map
  • func (m *Map) GetMaxPrefixLengths() (ipv6, ipv4 int)
• type RemoteEndpointInfo
  • func (v *RemoteEndpointInfo) New() bpf.MapValue
  • 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"
)

Types

type Key

type Key struct {
	Prefixlen uint32 `align:"lpm_key"`
	Pad1      uint16 `align:"pad1"`
	ClusterID uint8  `align:"cluster_id"`
	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>

func NewKey

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

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

func (*Key) New

func (k *Key) New() bpf.MapKey

func (Key) Prefix

func (k Key) Prefix() netip.Prefix

func (Key) String

func (k Key) String() string

type Map

type Map struct {
	bpf.Map
}

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) 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_identity"`
	TunnelEndpoint   types.IPv4 `align:"tunnel_endpoint"`
	NodeID           uint16     `align:"node_id"`
	Key              uint8      `align:"key"`
	// contains filtered or unexported fields
}

RemoteEndpointInfo implements the bpf.MapValue interface. It contains the security identity of a remote endpoint.

func (*RemoteEndpointInfo) New

func (v *RemoteEndpointInfo) New() bpf.MapValue

func (*RemoteEndpointInfo) String

func (v *RemoteEndpointInfo) String() string