networkhelper

type IPFamily int

type NetworkHelper interface {
	// SetLinkUp sets the administrative state of a link to "up"
	SetLinkUp(link string) error
	// GetLinkHardwareAddr returns the MAC address of a link.
	GetLinkHardwareAddr(link string) (net.HardwareAddr, error)
	// IsLinkVeth checks if a link is a veth device.
	IsLinkVeth(link string) (bool, error)
	// SetLinkHardwareAddr sets the MAC address of a link.
	SetLinkHardwareAddr(link string, hwaddr net.HardwareAddr) error
	// SetLinkDown sets the administrative state of a link to "down"
	SetLinkDown(link string) error
	// RenameLink renames a link to the given name
	RenameLink(link string, newName string) error
	// SetLinkIPAddress sets the IP address of a link
	SetLinkIPAddress(link string, ipNet *net.IPNet) error
	// LinkIPAddressExists checks whether a link has the given IP.
	LinkIPAddressExists(link string, ipNet *net.IPNet) (bool, error)
	// DeleteLinkIPAddress deletes the given IP of a link
	DeleteLinkIPAddress(link string, ipNet *net.IPNet) error
	// DeleteNeighbor deletes a neighbor
	DeleteNeighbor(ip net.IP, device string) error
	// NeighborExists checks whether a neighbor entry exists for the given IP.
	NeighborExists(ip net.IP, device string) (bool, error)
	// AddRoute adds a route
	AddRoute(network *net.IPNet, gateway net.IP, device string, metric *int, table *int) error
	// DeleteRoute deletes a route
	DeleteRoute(network *net.IPNet, gateway net.IP, device string) error
	// RouteExists checks whether a route exists
	RouteExists(network *net.IPNet, gateway net.IP, device string, table *int) (bool, error)
	// RouteList returns routes for device and the given IP family.
	// When table is non-nil, only routes in that routing table are returned.
	RouteList(device string, family IPFamily, table *int) ([]netlink.Route, error)
	// AddDummyLink adds a dummy link
	AddDummyLink(link string) error
	// DummyLinkExists checks if a dummy link exists
	DummyLinkExists(link string) (bool, error)
	// LinkExists checks if a link exists
	LinkExists(link string) (bool, error)
	// SetupVeth creates a veth pair in the target network namespace.
	SetupVeth(contIfaceName string, mtu int, requestedMac string, hostNS ns.NetNS) (net.Interface, net.Interface, error)
	// DelLinkByName deletes the link with the given name.
	DelLinkByName(name string) error
	// ValidateExpectedInterfaceIPs validates interface IPs against CNI result IPs.
	ValidateExpectedInterfaceIPs(ifName string, expectedIPs []*current.IPConfig) error
	// ValidateExpectedRoute validates routes from a CNI result.
	ValidateExpectedRoute(expectedRoutes []*cnitypes.Route) error
	// GetNS opens a network namespace.
	GetNS(nspath string) (ns.NetNS, error)
	// WithNetNSPath runs a function in the given network namespace.
	WithNetNSPath(nspath string, toRun func(ns.NetNS) error) error
	// GetHostPFMACAddressDPU returns the MAC address of the Host PF identified by pfID provided as input.
	// pfID is either "0" or "1". This function should only be called on the DPU.
	GetHostPFMACAddressDPU(pfID string) (net.HardwareAddr, error)
	// GetLinkIPAddresses returns the IP addresses of a link for the given IP family.
	GetLinkIPAddresses(link string, family IPFamily) ([]*net.IPNet, error)
	// GetGateway returns the gateway for the given network with the lower metric
	GetGateway(network *net.IPNet) (net.IP, error)
	// AddRule adds a rule in the routing policy database that controls the route selection algorithm
	AddRule(src *net.IPNet, table int, priority int) error
	// RuleExists checks whether a rule exists in the routing policy database that controls the route selection algorithm
	RuleExists(src *net.IPNet, table int, priority int) (bool, error)
	// GetPFRepresentorDPU returns PF representor on DPU for a host PF identified by its ID.
	GetPFRepresentorDPU(pfID string) (string, error)
	// GetVFRepresentorDPU returns VF representor on DPU for a host VF identified by pfID and vfIndex
	GetVFRepresentorDPU(pfID, vfIndex string) (string, error)
	// GetUplinkRepresentor gets a VF or PF PCI address (e.g '0000:03:00.4') and
	// returns the uplink representor netdev name for that VF or PF.
	GetUplinkRepresentor(pciAddress string) (string, error)
	// DevlinkPortList returns the list of devlink ports in the system
	DevlinkPortList() ([]*netlink.DevlinkPort, error)
	// GetVfRepresentorFromPortParams returns the VF representor netdev name for a given port parameters and VF index
	GetVfRepresentorFromPortParams(pp *sriovnet.RepresentorPortParams, vfIndex uint32) (string, error)
	// GetPfRepresentorFromPortParams returns the PF representor netdev name for a given port parameters
	GetPfRepresentorFromPortParams(pp *sriovnet.RepresentorPortParams) (string, error)
}