lxcmap

Documentation

Overview

Package lxcmap represents the endpoints BPF map in the BPF programs. It is implemented as a hash table containing an entry for all local endpoints. The hashtable can be accessed through the key EndpointKey and points which points to the value EndpointInfo.

Index

• Constants
• Variables
• func AddHostEntry(ip net.IP) error
• func DeleteElement(f EndpointFrontend) []error
• func DeleteEntry(ip net.IP) error
• func DumpToMap() (map[string]*EndpointInfo, error)
• func SyncHostEntry(ip net.IP) (bool, error)
• func WriteEndpoint(f EndpointFrontend) error
• type EndpointFrontend
• type EndpointInfo
  • func (v *EndpointInfo) GetValuePtr() unsafe.Pointer
  • func (v *EndpointInfo) IsHost() bool
  • func (v *EndpointInfo) String() string
• type EndpointKey
  • func NewEndpointKey(ip net.IP) *EndpointKey
  • func (k EndpointKey) NewValue() bpf.MapValue
• type MAC
  • func ParseMAC(s string) (MAC, error)
  • func (m MAC) String() string

Constants

const (
	MapName = "cilium_lxc"

	// MaxEntries represents the maximum number of endpoints in the map
	MaxEntries = 65535

	// PortMapMax represents the maximum number of Ports Mapping per container.
	PortMapMax = 16
)

const (
	// EndpointFlagHost indicates that this endpoint represents the host
	EndpointFlagHost = 1
)

Variables

var (
	// LXCMap represents the BPF map for endpoints
	LXCMap = bpf.NewMap(MapName,
		bpf.MapTypeHash,
		int(unsafe.Sizeof(EndpointKey{})),
		int(unsafe.Sizeof(EndpointInfo{})),
		MaxEntries,
		0, 0,
		func(key []byte, value []byte) (bpf.MapKey, bpf.MapValue, error) {
			k, v := EndpointKey{}, EndpointInfo{}

			if err := bpf.ConvertKeyValue(key, value, &k, &v); err != nil {
				return nil, nil, err
			}

			return &k, &v, nil
		},
	).WithCache()
)

Functions

func AddHostEntry

func AddHostEntry(ip net.IP) error

AddHostEntry adds a special endpoint which represents the local host

func DeleteElement

func DeleteElement(f EndpointFrontend) []error

DeleteElement deletes the endpoint using all keys which represent the endpoint. It returns the number of errors encountered during deletion.

func DeleteEntry

func DeleteEntry(ip net.IP) error

DeleteEntry deletes a single map entry

func DumpToMap

func DumpToMap() (map[string]*EndpointInfo, error)

DumpToMap dumps the contents of the lxcmap into a map and returns it

func SyncHostEntry

func SyncHostEntry(ip net.IP) (bool, error)

SyncHostEntry checks if a host entry exists in the lxcmap and adds one if needed. Returns boolean indicating if a new entry was added and an error.

func WriteEndpoint

func WriteEndpoint(f EndpointFrontend) error

WriteEndpoint updates the BPF map with the endpoint information and links the endpoint information to all keys provided.

Types

type EndpointFrontend

type EndpointFrontend interface {
	// GetBPFKeys must return a slice of EndpointKey which all represent the endpoint
	GetBPFKeys() []*EndpointKey

	// GetBPFValue must return an EndpointInfo structure representing the frontend
	GetBPFValue() (*EndpointInfo, error)
}

EndpointFrontend is the interface to implement for an object to synchronize with the endpoint BPF map

type EndpointInfo

type EndpointInfo struct {
	IfIndex uint32 `align:"ifindex"`
	Unused  uint16 `align:"unused"`
	LxcID   uint16 `align:"lxc_id"`
	Flags   uint32 `align:"flags"`

	MAC     MAC       `align:"mac"`
	NodeMAC MAC       `align:"node_mac"`
	Pad     [4]uint32 `align:"pad"`
	// contains filtered or unexported fields
}

EndpointInfo represents the value of the endpoints BPF map.

Must be in sync with struct endpoint_info in <bpf/lib/common.h>

func (*EndpointInfo) GetValuePtr

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

GetValuePtr returns the unsafe pointer to the BPF value

func (*EndpointInfo) IsHost

func (v *EndpointInfo) IsHost() bool

IsHost returns true if the EndpointInfo represents a host IP

func (*EndpointInfo) String

func (v *EndpointInfo) String() string

String returns the human readable representation of an EndpointInfo

type EndpointKey

type EndpointKey struct {
	bpf.EndpointKey
}

func NewEndpointKey

func NewEndpointKey(ip net.IP) *EndpointKey

NewEndpointKey returns an EndpointKey based on the provided IP address. The address family is automatically detected

func (EndpointKey) NewValue

func (k EndpointKey) NewValue() bpf.MapValue

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

type MAC

type MAC uint64

MAC is the __u64 representation of a MAC address.

func ParseMAC

func ParseMAC(s string) (MAC, error)

ParseMAC parses s only as an IEEE 802 MAC-48.

func (MAC) String

func (m MAC) String() string