CSIT-524: Traffic generator using python profiles
[csit.git] / resources / tools / t-rex / stream_profiles / trex-sl-3n-ethip4udp-100u15p.py
diff --git a/resources/tools/t-rex/stream_profiles/trex-sl-3n-ethip4udp-100u15p.py b/resources/tools/t-rex/stream_profiles/trex-sl-3n-ethip4udp-100u15p.py
new file mode 100755 (executable)
index 0000000..87a5d30
--- /dev/null
@@ -0,0 +1,116 @@
+# Copyright (c) 2017 Cisco and/or its affiliates.
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at:
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+"""Stream profile for T-rex traffic generator.
+
+Stream profile:
+ - Two streams sent in directions 0 --> 1 and 1 --> 0 at the same time.
+ - Packet: ETH / IP / UDP
+ - Direction 0 --> 1:
+   - Source IP address range:      20.0.0.0 - 20.0.0.99
+   - Destination IP address range: 12.0.0.2
+   - Source UDP port range:        1024 - 1038
+   - Destination UDP port range:   1024
+ - Direction 1 --> 0:
+   - Source IP address range:      12.0.0.2
+   - Destination IP address range: 200.0.0.0
+   - Source UDP port range:        1024
+   - Destination UDP port range:   1024 - 2523
+"""
+
+from trex_stl_lib.api import *
+from profile_trex_stateless_base_class import TrafficStreamsBaseClass
+
+
+class TrafficStreams(TrafficStreamsBaseClass):
+    """Stream profile."""
+
+    def __init__(self):
+        """Initialization and setting of streams' parameters."""
+
+        super(TrafficStreamsBaseClass, self).__init__()
+
+        # IPs used in packet headers.
+        self.p1_src_start_ip = '20.0.0.0'
+        self.p1_src_end_ip = '20.0.0.99'
+        self.p1_dst_start_ip = '12.0.0.2'
+
+        self.p2_src_start_ip = '12.0.0.2'
+        self.p2_src_end_ip = '12.0.0.2'
+        self.p2_dst_start_ip = '200.0.0.0'
+
+        # UDP ports used in packet headers.
+        self.p1_src_start_udp_port = 1024
+        self.p1_src_end_udp_port = 1038
+        self.p1_dst_start_udp_port = 1024
+
+        self.p2_src_start_udp_port = 1024
+        self.p2_dst_start_udp_port = 1024
+        self.p2_dst_end_udp_port = 2523
+
+    def define_packets(self):
+        """Defines the packets to be sent from the traffic generator.
+
+        Packet definition: | ETH | IP | UDP |
+
+        :returns: Packets to be sent from the traffic generator.
+        :rtype: tuple
+        """
+
+        # Direction 0 --> 1
+        base_pkt_a = (Ether() /
+                      IP(src=self.p1_src_start_ip,
+                         dst=self.p1_dst_start_ip,
+                         proto=17) /
+                      UDP(sport=self.p1_src_start_udp_port,
+                          dport=self.p1_dst_start_udp_port))
+        # Direction 1 --> 0
+        base_pkt_b = (Ether() /
+                      IP(src=self.p2_src_start_ip,
+                         dst=self.p2_dst_start_ip,
+                         proto=17) /
+                      UDP(sport=self.p2_src_start_udp_port,
+                          dport=self.p2_dst_start_udp_port))
+
+        # Direction 0 --> 1
+        vm1 = STLScVmRaw([
+            STLVmTupleGen(ip_min=self.p1_src_start_ip,
+                          ip_max=self.p1_src_end_ip,
+                          port_min=self.p1_src_start_udp_port,
+                          port_max=self.p1_src_end_udp_port,
+                          name="tuple"),
+            STLVmWrFlowVar(fv_name="tuple.ip", pkt_offset="IP.src"),
+            STLVmFixIpv4(offset="IP"),
+            STLVmWrFlowVar(fv_name="tuple.port", pkt_offset="UDP.sport")
+        ])
+        # Direction 0 --> 1
+        vm2 = STLScVmRaw([
+            STLVmFlowVar(name="dport",
+                         min_value=self.p2_dst_start_udp_port,
+                         max_value=self.p2_dst_end_udp_port,
+                         size=2, op="inc"),
+            STLVmWrFlowVar(fv_name="dport", pkt_offset="UDP.dport")
+        ])
+
+        return base_pkt_a, base_pkt_b, vm1, vm2
+
+
+def register():
+    """Register this traffic profile to T-rex.
+
+    Do not change this function.
+
+    :return: Traffic streams.
+    :rtype: Object
+    """
+    return TrafficStreams()