exports

type IfClusterIndex struct {
	// interface name
	InterfaceName string
	// node name
	NodeName string
}

type Iface struct {
	IfName      string
	IfMac       Mac
	IfIndex     int
	IfPci       PCIAddress
	IfPTPCaps   PTPCaps
	IfUp        bool
	IfMaster    string
	IfSlaveType string
}

type L2Info interface {
	// list of cluster interfaces indexed with a simple integer (X) for readability in the graph
	GetPtpIfList() []*PtpIf
	// list of unfiltered cluster interfaces indexed with a simple integer (X) for readability in the graph
	GetPtpIfListUnfiltered() map[string]*PtpIf
	// LANs identified in the graph
	GetLANs() *[][]int
	// List of port receiving PTP frames (assuming valid GM signal received)
	GetPortsGettingPTP() []*PtpIf
}

type Mac struct {
	Data string
}

type Neighbors struct {
	Local  Iface
	Remote map[string]bool
	// PTP Announce data received on this interface, keyed by grandmaster identity.
	// Multiple GMs may announce on the same LAN.
	PtpAnnounces map[string]*PtpAnnounceData `json:"ptpAnnounces,omitempty"`
}

type PCIAddress struct {
	Device, Function, Description, Subsystem string
}

type PTPCaps struct {
	HwRx, HwTx, HwRawClock bool
}

type PtpAnnounceData struct {
	DomainNumber            uint8  `json:"domainNumber"`
	GrandmasterPriority1    uint8  `json:"grandmasterPriority1"`
	ClockClass              uint8  `json:"clockClass"`
	ClockAccuracy           uint8  `json:"clockAccuracy"`
	OffsetScaledLogVariance uint16 `json:"offsetScaledLogVariance"`
	GrandmasterPriority2    uint8  `json:"grandmasterPriority2"`
	GrandmasterIdentity     string `json:"grandmasterIdentity"`
	StepsRemoved            uint16 `json:"stepsRemoved"`
	TimeSource              uint8  `json:"timeSource"`
}

type PtpIf struct {
	// Index of the interface in the cluster (node/interface name)
	IfClusterIndex
	// Interface
	Iface
	// PTP Announce data received on this interface, keyed by grandmaster identity.
	// nil if no announce received.
	Announces map[string]*PtpAnnounceData `json:"-"`
}

type SolverConfig interface {
	// problem definition
	InitProblem(string, [][][]int, []int)
	// L2 configuration
	SetL2Config(L2Info)
	// Run solver on problem
	Run(string)
	// Prints all solutions
	PrintAllSolutions()
	// Prints first solution only
	PrintFirstSolution()
	// map storing solutions
	GetSolutions() map[string]*[][]int
}