otgflowhelpers will contain helper function to configure flows in OTG (…

…#3529) * otgflowhelpers will contain helper function to configure flows in OTG
openconfig · Oct 25, 2024 · 8346270 · 8346270
1 parent 9dbadd5
commit 8346270
Showing 1 changed file with 216 additions and 0 deletions.
diff --git a/internal/otg_helpers/otg_flow_helpers/otgflowhelpers.go b/internal/otg_helpers/otg_flow_helpers/otgflowhelpers.go
@@ -0,0 +1,216 @@
+// Package otgflowhelpers provides helper functions to create different flows on traffic generator.
+package otgflowhelpers
+
+import (
+	"github.com/open-traffic-generator/snappi/gosnappi"
+)
+
+// Iana Ethertype is the IANA Ethertype for MPLS, IPv4 and IPv6.
+const (
+	IanaMPLSEthertype = 34887
+	IanaIPv4Ethertype = 2048
+	IanaIPv6Ethertype = 34525
+)
+
+/*
+Flow is a struct to hold Flow parameters.
+TxNames and RxNames should be set to a valid OTG endpoint name.
+Creating basic IPv4 Flow.
+
+top = gosnappi.NewConfig()
+
+	FlowIPv4 = &Flow{
+	  TxNames:   []string{"interface1"},
+	  RxNames:   []string{"interface2"},
+	  FrameSize: 1500,
+	  FlowName:  "IPv4Flow",
+	  EthFlow:   &EthFlowParams{SrcMAC: "00:11:22:33:44:55", DstMAC: "00:11:22:33:44:66"},
+	  IPv4Flow:  &IPv4FlowParams{IPv4Src: "192.0.2.1", IPv4Dst: "192.0.2.129", IPv4DstCount: 10},
+	}
+
+FlowIPv4.CreateFlow(top)
+FlowIPv4.AddEthHeader()
+FlowIPv4.AddIPv4Header()
+*/
+type Flow struct {
+	TxNames   []string
+	RxNames   []string
+	FrameSize uint32
+	FlowName  string
+	VLANFlow  *VLANFlowParams
+	GREFlow   *GREFlowParams
+	EthFlow   *EthFlowParams
+	IPv4Flow  *IPv4FlowParams
+	IPv6Flow  *IPv6FlowParams
+	TCPFlow   *TCPFlowParams
+	UDPFlow   *UDPFlowParams
+	MPLSFlow  *MPLSFlowParams
+	flow      gosnappi.Flow
+}
+
+// GREFlowParams is a struct to hold Ethernet traffic parameters.
+type GREFlowParams struct {
+	Protocol uint32
+}
+
+// VLANFlowParams is a struct to hold VLAN traffic parameters.
+type VLANFlowParams struct {
+	VLANId uint32
+}
+
+// EthFlowParams is a struct to hold Ethernet traffic parameters.
+type EthFlowParams struct {
+	SrcMAC      string
+	DstMAC      string
+	SrcMACCount uint32
+}
+
+// IPv4FlowParams is a struct to hold IPv4 traffic parameters.
+type IPv4FlowParams struct {
+	IPv4Src      string
+	IPv4Dst      string
+	IPv4SrcCount uint32
+	IPv4DstCount uint32
+	TTL          uint32
+}
+
+// IPv6FlowParams is a struct to hold IPv6 traffic parameters.
+type IPv6FlowParams struct {
+	IPv6Src      string
+	IPv6Dst      string
+	IPv6SrcCount uint32
+	IPv6DstCount uint32
+	HopLimit     uint32
+}
+
+// TCPFlowParams is a struct to hold TCP traffic parameters.
+type TCPFlowParams struct {
+	TCPSrcPort  uint32
+	TCPDstPort  uint32
+	TCPSrcCount uint32
+	TCPDstCount uint32
+}
+
+// UDPFlowParams is a struct to hold UDP traffic parameters.
+type UDPFlowParams struct {
+	UDPSrcPort  uint32
+	UDPDstPort  uint32
+	UDPSrcCount uint32
+	UDPDstCount uint32
+}
+
+// MPLSFlowParams is a struct to hold MPLS traffic parameters.
+type MPLSFlowParams struct {
+	MPLSLabel uint32
+	MPLSExp   uint32
+}
+
+// CreateFlow defines Tx and Rx end points for traffic flow.
+func (f *Flow) CreateFlow(top gosnappi.Config) {
+	f.flow = top.Flows().Add().SetName(f.FlowName)
+	f.flow.Metrics().SetEnable(true)
+	f.flow.TxRx().Device().
+		SetTxNames(f.TxNames).
+		SetRxNames(f.RxNames)
+	f.flow.Size().SetFixed(f.FrameSize)
+}
+
+// AddEthHeader adds an Ethernet header to the flow.
+func (f *Flow) AddEthHeader() {
+	eth := f.flow.Packet().Add().Ethernet()
+	eth.Src().SetValue(f.EthFlow.SrcMAC)
+	eth.Dst().SetValue(f.EthFlow.DstMAC)
+}
+
+// AddGREHeader adds a GRE header to the flow.
+func (f *Flow) AddGREHeader() {
+	greHdr := f.flow.Packet().Add().Gre()
+	switch f.GREFlow.Protocol {
+	case IanaMPLSEthertype:
+		greHdr.Protocol().SetValue(IanaMPLSEthertype)
+	case IanaIPv4Ethertype:
+		greHdr.Protocol().SetValue(IanaIPv4Ethertype)
+	case IanaIPv6Ethertype:
+		greHdr.Protocol().SetValue(IanaIPv6Ethertype)
+	default:
+		greHdr.Protocol().SetValue(IanaIPv4Ethertype)
+	}
+}
+
+// AddVlanHeader adds a VLAN header to the flow.
+func (f *Flow) AddVlanHeader() {
+	f.flow.Packet().Add().Vlan().Id().SetValue(f.VLANFlow.VLANId)
+}
+
+// AddMPLSHeader adds an MPLS header to the flow.
+func (f *Flow) AddMPLSHeader() {
+	mplsHdr := f.flow.Packet().Add().Mpls()
+	mplsHdr.Label().SetValue(f.MPLSFlow.MPLSLabel)
+	mplsHdr.TrafficClass().SetValue(f.MPLSFlow.MPLSExp)
+}
+
+// AddIPv4Header adds an IPv4 header to the flow.
+func (f *Flow) AddIPv4Header() {
+	ipv4Hdr := f.flow.Packet().Add().Ipv4()
+	if f.IPv4Flow.IPv4SrcCount != 0 {
+		ipv4Hdr.Src().Increment().SetStart(f.IPv4Flow.IPv4Src).SetCount(f.IPv4Flow.IPv4SrcCount)
+	} else {
+		ipv4Hdr.Src().SetValue(f.IPv4Flow.IPv4Src)
+	}
+	if f.IPv4Flow.IPv4DstCount != 0 {
+		ipv4Hdr.Dst().Increment().SetStart(f.IPv4Flow.IPv4Dst).SetCount(f.IPv4Flow.IPv4DstCount)
+	} else {
+		ipv4Hdr.Dst().SetValue(f.IPv4Flow.IPv4Dst)
+	}
+	if f.IPv4Flow.TTL != 0 {
+		ipv4Hdr.TimeToLive().SetValue(f.IPv4Flow.TTL)
+	}
+}
+
+// AddIPv6Header adds an IPv6 header to the flow.
+func (f *Flow) AddIPv6Header() {
+	ipv6Hdr := f.flow.Packet().Add().Ipv6()
+	if f.IPv6Flow.IPv6SrcCount != 0 {
+		ipv6Hdr.Src().Increment().SetStart(f.IPv6Flow.IPv6Src).SetCount(f.IPv6Flow.IPv6SrcCount)
+	} else {
+		ipv6Hdr.Src().SetValue(f.IPv6Flow.IPv6Src)
+	}
+	if f.IPv6Flow.IPv6DstCount != 0 {
+		ipv6Hdr.Dst().Increment().SetStart(f.IPv6Flow.IPv6Dst).SetCount(f.IPv6Flow.IPv6DstCount)
+	} else {
+		ipv6Hdr.Dst().SetValue(f.IPv6Flow.IPv6Dst)
+	}
+	if f.IPv6Flow.HopLimit != 0 {
+		ipv6Hdr.HopLimit().SetValue(f.IPv6Flow.HopLimit)
+	}
+}
+
+// AddTCPHeader adds a TCP header to the flow.
+func (f *Flow) AddTCPHeader() {
+	tcpHdr := f.flow.Packet().Add().Tcp()
+	if f.TCPFlow.TCPSrcCount != 0 {
+		tcpHdr.SrcPort().Increment().SetStart(f.TCPFlow.TCPSrcPort).SetCount(f.TCPFlow.TCPSrcCount)
+	} else {
+		tcpHdr.SrcPort().SetValue(f.TCPFlow.TCPSrcPort)
+	}
+	if f.TCPFlow.TCPDstCount != 0 {
+		tcpHdr.DstPort().Increment().SetStart(f.TCPFlow.TCPDstPort).SetCount(f.TCPFlow.TCPDstCount)
+	} else {
+		tcpHdr.DstPort().SetValue(f.TCPFlow.TCPDstPort)
+	}
+}
+
+// AddUDPHeader adds a UDP header to the flow.
+func (f *Flow) AddUDPHeader() {
+	udpHdr := f.flow.Packet().Add().Udp()
+	if f.UDPFlow.UDPSrcCount != 0 {
+		udpHdr.SrcPort().Increment().SetStart(f.UDPFlow.UDPSrcPort).SetCount(f.UDPFlow.UDPSrcCount)
+	} else {
+		udpHdr.SrcPort().SetValue(f.UDPFlow.UDPSrcPort)
+	}
+	if f.UDPFlow.UDPDstCount != 0 {
+		udpHdr.DstPort().Increment().SetStart(f.UDPFlow.UDPDstPort).SetCount(f.UDPFlow.UDPDstCount)
+	} else {
+		udpHdr.DstPort().SetValue(f.UDPFlow.UDPDstPort)
+	}
+}