puntmgr

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

type Config struct {
	// InterconnectAllocCIDR defines network from which /30 subnets are allocated for use by VPP<->CNF interconnects.
	InterconnectAllocCIDR string `json:"interconnect-alloc-cidr"`
}

type Deps struct {
	infra.PluginDeps
	ServiceLabel servicelabel.ReaderAPI
	GRPCServer   grpc.Server
	CnfRegistry  cnfreg_plugin.CnfRegistryAPI
	IfPlugin     ifplugin.API
	NsPlugin     nsplugin.API
	CfgClient    client.GenericClient
	KVScheduler  kvs.KVScheduler
}

type InterconnectLink interface {
	// contains filtered or unexported methods
}

type InterconnectManager interface {
	// Add new VPP<->CNF/Linux interconnects needed for a given punt.
	// localTxn = configuration items to configure on this side (StoneWork / Standalone CNF)
	// remoteTxn = configuration items to configure on the side of the StoneWork module
	AddInterconnects(localTxn, remoteTxn client.ChangeRequest, puntId puntID, reqs []InterconnectReq,
		icType pb.PuntRequest_InterconnectType, enableGso bool, withMultiplex bool) (interconnects []*pb.PuntMetadata_Interconnect, err error)
	// Delete all VPP<->CNF/Linux interconnects created for a given punt.
	DelInterconnects(localTxn, remoteTxn client.ChangeRequest, puntId puntID) (err error)
	// GetLinuxVrfName returns the name used for Linux VRF device corresponding to the given VPP VRF.
	// Method is "static" in the sense that it can be called anytime, regardless of the internal state of the Manager.
	GetLinuxVrfName(vrf uint32) string
}

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

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

type NetNsRegistry interface {
	// Get ID representing network namespace referenced by a given microservice label.
	// Network namespace used by multiple microservices will have the same ID regardless of which ms label
	// is used to query it.
	GetNetNsID(msLabel string) (int, error)

	// Each learned network namespace is used by one or more microservices. Label of one of these
	// microservices is designated to represent the namespace.
	GetNetNsLabel(id int) (msLabel string, err error)
}

type Option func(plugin *Plugin)

type Plugin struct {
	pb.UnimplementedPuntManagerServer
	sync.Mutex

	Deps
	// contains filtered or unexported fields
}

type PuntHandler interface {
	// GetInterconnectReqs returns definitions of all interconnects which are required between VPP and CNF
	// for this punt request.
	GetInterconnectReqs(punt *pb.PuntRequest) []InterconnectReq

	// GetPuntDependencies returns dependencies that have to be satisfied before the punt can be added.
	GetPuntDependencies(punt *pb.PuntRequest) (deps []kvs.Dependency)

	// CanMultiplex enables interconnection multiplexing for this punting. It could be enabled in certain cases:
	// 1. two or more punts of this type can coexist even if they have the same vpp selector
	// 2. one or more punts of this type can coexist with other type of punts on the same (TAP-only)
	// interconnection if they all have the same vpp selector and cnf selector.
	// The TAP-backed interconnection is shared for multiple multiplexing punts with the same cnf selector
	// (same network namespace) and vpp selector.
	CanMultiplex() bool

	// ConfigurePunt prepares txn to (un)configures VPP-side of the punt.
	ConfigurePunt(txn client.ChangeRequest, puntId puntID, puntReq *pb.PuntRequest,
		interconnects []*pb.PuntMetadata_Interconnect, remove bool) error
}

type PuntManagerAPI interface {
	// GetPuntMetadata returns metadata about configured packet punt between VPP and the CNF.
	// If cnfMsLabel is empty then microservice label of this CNF is assumed (returned by ServiceLabel plugin).
	GetPuntMetadata(cnfMsLabel, key, label string) *pb.PuntMetadata
	// GetAllCNFPunts returns metadata of all punts created for the given CNF.
	// If cnfMsLabel is empty then microservice label of this CNF is assumed (returned by ServiceLabel plugin).
	GetAllCNFPunts(cnfMsLabel string) []*pb.PuntMetadata
	// AddPunt is used by StoneWork or standalone CNF to configure punt between VPP and the CNF.
	// If cnfMsLabel is empty then microservice label of this CNF is assumed (returned by ServiceLabel plugin).
	AddPunt(cnfMsLabel, key string, punt *pb.PuntRequest) error
	// DelPunt is used by StoneWork or standalone CNF to un-configure punt between VPP and the CNF.
	// If cnfMsLabel is empty then microservice label of this CNF is assumed (returned by ServiceLabel plugin).
	DelPunt(cnfMsLabel, key string, label string) error
	// GetPuntDependencies returns dependencies that have to be satisfied before the punt can be added.
	GetPuntDependencies(cnfMsLabel string, punt *pb.PuntRequest) (deps []kvs.Dependency)
}

type PuntManagerNamingAPI interface {
	// GetLinuxVrfName returns the name used for Linux VRF device corresponding to the given VPP VRF.
	// Method is "static" in the sense that it can be called anytime, regardless of the internal state of the plugin.
	// Deprecated: use Punt metadata that can be obtained using GetPuntMetadata().
	GetLinuxVrfName(vrf uint32) string
}