ptphelper

Documentation

Index

• func CheckLeaseDuration(namespace string, leaseDurationDefault int32, leaseDurationSNO int32) int
• func DisablePTPReferencePlugin() error
• func DiscoveryPTPConfiguration(namespace string) (masters, slaves []*ptpv1.PtpConfig)
• func EnablePTPEvent(apiVersion, configMapName string) error
• func EnablePTPReferencePlugin() error
• func GetClockIDForeign(ptpConfigName string, label *string, nodeName *string) (id string, err error)
• func GetClockIDMaster(ptpConfigName string, label *string, nodeName *string, isGM bool) (id string, err error)
• func GetFirstNode(ptpConfig *ptpv1.PtpConfig) (*string, error)
• func GetLabel(ptpConfig *ptpv1.PtpConfig) (*string, error)
• func GetListOfWPCEnabledInterfaces(nodeName string) ([]string, string)
• func GetMajorVersion(version string) (int, error)
• func GetMasterSlaveAttachedInterfaces(pod *v1core.Pod) []string
• func GetPTPConfigs(namespace string) ([]ptpv1.PtpConfig, []ptpv1.PtpConfig)
• func GetPTPPodWithPTPConfig(ptpConfig *ptpv1.PtpConfig) (aPtpPod *v1core.Pod, err error)
• func GetProfileLogID(ptpConfigName string, label *string, nodeName *string) (id string, err error)
• func GetProfileName(config *ptpv1.PtpConfig) (string, error)
• func GetPtpInterfacePerNode(nodeName string, ifList map[string]*l2exports.PtpIf) (out []string)
• func GetPtpMasterSlaveAttachedInterfaces(pod *v1core.Pod) []string
• func GetPtpOperatorVersion() (string, error)
• func GetPtpPodOnNode(nodeName string) (v1core.Pod, error)
• func IsClockUnderTestPod(aPod *v1core.Pod) (result bool, err error)
• func IsExternalGM() (out bool)
• func IsGrandMasterPod(aPod *v1core.Pod) (result bool, err error)
• func IsPTPEnabled(ethToolOutput *bytes.Buffer) bool
• func IsPtpMaster(ptp4lOpts, phc2sysOpts *string) bool
• func IsPtpSlave(ptp4lOpts, phc2sysOpts *string) bool
• func IsSecondaryBc(config *ptpv1.PtpConfig) bool
• func IsV1Api(version string) bool
• func MutateProfile(profile *ptpv1.PtpConfig, profileName, nodeName string) *ptpv1.PtpConfig
• func PtpDiscoveredInterfaceList(nodeName string) []string
• func PtpEventEnabled() int
• func ReplaceTestPod(pod *v1core.Pod, timeout time.Duration) (v1core.Pod, error)
• func RestartPTPDaemon()
• func RetrievePTPProfileLabels(configs []ptpv1.PtpConfig) string
• func SaveStoreEventsToFile(allEvents, filename string)
• func WaitForPtpDaemonToBeReady() int

Functions

func CheckLeaseDuration

func CheckLeaseDuration(namespace string, leaseDurationDefault int32, leaseDurationSNO int32) int

func DisablePTPReferencePlugin

func DisablePTPReferencePlugin() error

func DiscoveryPTPConfiguration

func DiscoveryPTPConfiguration(namespace string) (masters, slaves []*ptpv1.PtpConfig)

Returns the slave node label to be used in the test

func EnablePTPEvent

func EnablePTPEvent(apiVersion, configMapName string) error

EnablePTPEvent: if configMapName is passed, clean up the configMap when version changed

func EnablePTPReferencePlugin

func EnablePTPReferencePlugin() error

func GetClockIDForeign

func GetClockIDForeign(ptpConfigName string, label *string, nodeName *string) (id string, err error)

func GetClockIDMaster

func GetClockIDMaster(ptpConfigName string, label *string, nodeName *string, isGM bool) (id string, err error)

func GetFirstNode

func GetFirstNode(ptpConfig *ptpv1.PtpConfig) (*string, error)

gets the first nodename configured in the ptpconfig->spec->recommend

func GetLabel

func GetLabel(ptpConfig *ptpv1.PtpConfig) (*string, error)

Gets the first label configured in the ptpconfig->spec->recommend

func GetListOfWPCEnabledInterfaces

func GetListOfWPCEnabledInterfaces(nodeName string) ([]string, string)

func GetMajorVersion

func GetMajorVersion(version string) (int, error)

GetMajorVersion returns major version

func GetMasterSlaveAttachedInterfaces

func GetMasterSlaveAttachedInterfaces(pod *v1core.Pod) []string

func GetPTPConfigs

func GetPTPConfigs(namespace string) ([]ptpv1.PtpConfig, []ptpv1.PtpConfig)

Returns the slave node label to be used in the test, empty string label cound not be found

func GetPTPPodWithPTPConfig

func GetPTPPodWithPTPConfig(ptpConfig *ptpv1.PtpConfig) (aPtpPod *v1core.Pod, err error)

func GetProfileLogID

func GetProfileLogID(ptpConfigName string, label *string, nodeName *string) (id string, err error)

func GetProfileName

func GetProfileName(config *ptpv1.PtpConfig) (string, error)

Checks for DualNIC BC

func GetPtpInterfacePerNode

func GetPtpInterfacePerNode(nodeName string, ifList map[string]*l2exports.PtpIf) (out []string)

func GetPtpMasterSlaveAttachedInterfaces

func GetPtpMasterSlaveAttachedInterfaces(pod *v1core.Pod) []string

func GetPtpOperatorVersion

func GetPtpOperatorVersion() (string, error)

func GetPtpPodOnNode

func GetPtpPodOnNode(nodeName string) (v1core.Pod, error)

func IsClockUnderTestPod

func IsClockUnderTestPod(aPod *v1core.Pod) (result bool, err error)

returns true if the pod is running the clock under test

func IsExternalGM

func IsExternalGM() (out bool)

func IsGrandMasterPod

func IsGrandMasterPod(aPod *v1core.Pod) (result bool, err error)

returns true if the pod is running a grandmaster

func IsPTPEnabled

func IsPTPEnabled(ethToolOutput *bytes.Buffer) bool

This function parses ethtool command output and detect interfaces which supports ptp protocol

func IsPtpMaster

func IsPtpMaster(ptp4lOpts, phc2sysOpts *string) bool

Checks for Grand master

func IsPtpSlave

func IsPtpSlave(ptp4lOpts, phc2sysOpts *string) bool

Checks for OC

func IsSecondaryBc

func IsSecondaryBc(config *ptpv1.PtpConfig) bool

Checks for DualNIC BC

func IsV1Api

func IsV1Api(version string) bool

IsV1Api ...

func MutateProfile

func MutateProfile(profile *ptpv1.PtpConfig, profileName, nodeName string) *ptpv1.PtpConfig

func PtpDiscoveredInterfaceList

func PtpDiscoveredInterfaceList(nodeName string) []string

func PtpEventEnabled

func PtpEventEnabled() int

PtpEventEnabled returns 0 if event is not enabled, 1 for v1 API, 2 for v2 O-RAN Compliant API

func ReplaceTestPod

func ReplaceTestPod(pod *v1core.Pod, timeout time.Duration) (v1core.Pod, error)

func RestartPTPDaemon

func RestartPTPDaemon()

func RetrievePTPProfileLabels

func RetrievePTPProfileLabels(configs []ptpv1.PtpConfig) string

func SaveStoreEventsToFile

func SaveStoreEventsToFile(allEvents, filename string)

saves events to file

func WaitForPtpDaemonToBeReady

func WaitForPtpDaemonToBeReady() int