vppinit

Documentation

Overview

Package vppinit contains initialization code for vpp

Index

• func InitLinks(ctx context.Context, vppConn api.Connection, deviceNames map[string]string, ...) error
• func LinkToSocket(ctx context.Context, vppConn api.Connection, tunnelIP net.IP, family AfType) (net.IP, error)
• func Must(tunnelIP net.IP, err error) net.IP
• func None(_ context.Context, _ api.Connection, tunnelIP net.IP) (net.IP, error)
• type AfPacketParams
  • func GetAfPacketValues(ctx context.Context) *AfPacketParams
• type AfType
• type AfXDPParams
  • func GetAfXdpValues(ctx context.Context) *AfXDPParams
• type Func
  • func (f *Func) Decode(value string) error
  • func (f *Func) Execute(ctx context.Context, vppConn api.Connection, tunnelIP net.IP) (net.IP, error)
• type Parameters
  • func (c *Parameters) String() string

Functions

func InitLinks

func InitLinks(ctx context.Context, vppConn api.Connection, deviceNames map[string]string, tunnelIP net.IP) error

InitLinks creates AF_PACKET interface if needed and put the given interfaces in promisc mode

func LinkToSocket

func LinkToSocket(ctx context.Context, vppConn api.Connection, tunnelIP net.IP, family AfType) (net.IP, error)

LinkToSocket - will link vpp via af_packet or af_xdp to the interface having the tunnelIP if tunnelIP is nil, it will find the interface for the default route and use that instead. It returns the resulting tunnelIP

func Must

func Must(tunnelIP net.IP, err error) net.IP

Must - simple wrapper to panic in the event of an error

func None

func None(_ context.Context, _ api.Connection, tunnelIP net.IP) (net.IP, error)

None - will perform no VPP initialization

Types

type AfPacketParams

type AfPacketParams struct {
	Mode             af_packet.AfPacketMode  `yaml:"mode"`
	RxFrameSize      uint32                  `yaml:"rxFrameSize"`
	TxFrameSize      uint32                  `yaml:"txFrameSize"`
	RxFramesPerBlock uint32                  `yaml:"rxFramesPerBlock"`
	TxFramesPerBlock uint32                  `yaml:"txFramesPerBlock"`
	NumRxQueues      uint16                  `yaml:"numRxQueues"`
	NumTxQueues      uint16                  `yaml:"numTxQueues"`
	Flags            af_packet.AfPacketFlags `yaml:"flags"`
}

AfPacketParams contains configuration parameters for AF_PACKET interface

func GetAfPacketValues

func GetAfPacketValues(ctx context.Context) *AfPacketParams

GetAfPacketValues get parameter values for af-packet interface creation

type AfType

type AfType uint32

AfType represents socket address family

const (
	// AfPacket - AF_PACKET
	AfPacket AfType = 0
	// AfXDP - AF_XDP
	AfXDP AfType = 1
)

type AfXDPParams

type AfXDPParams struct {
	Mode    af_xdp.AfXdpMode `yaml:"mode"`
	RxqSize uint16           `yaml:"rxqSize"`
	TxqSize uint16           `yaml:"txqSize"`
	Flags   af_xdp.AfXdpFlag `yaml:"flags"`
}

AfXDPParams contains configuration parameters for AF_XDP interface

func GetAfXdpValues

func GetAfXdpValues(ctx context.Context) *AfXDPParams

GetAfXdpValues get parameter values for af-xdp interface creation

type Func

type Func struct {
	// contains filtered or unexported fields
}

Func - vpp initialization function

func (*Func) Decode

func (f *Func) Decode(value string) error

Decode for envconfig to select correct vpp initialization function

func (*Func) Execute

func (f *Func) Execute(ctx context.Context, vppConn api.Connection, tunnelIP net.IP) (net.IP, error)

Execute vpp initialization function

type Parameters

type Parameters struct {
	AfPacket *AfPacketParams `yaml:"AF_PACKET"`
	AfXdp    *AfXDPParams    `yaml:"AF_XDP"`
}

Parameters contains parameters for various AF types

func (*Parameters) String

func (c *Parameters) String() string