CSIT-524: Traffic generator using python profiles
[csit.git] / resources / tools / t-rex / stream_profiles / trex-sl-2n-ethip4-ip4src253.py
1 # Copyright (c) 2017 Cisco and/or its affiliates.
2 # Licensed under the Apache License, Version 2.0 (the "License");
3 # you may not use this file except in compliance with the License.
4 # You may obtain a copy of the License at:
5 #
6 #     http://www.apache.org/licenses/LICENSE-2.0
7 #
8 # Unless required by applicable law or agreed to in writing, software
9 # distributed under the License is distributed on an "AS IS" BASIS,
10 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
11 # See the License for the specific language governing permissions and
12 # limitations under the License.
13
14 """Stream profile for T-rex traffic generator.
15
16 Stream profile:
17  - Two streams sent in directions 0 --> 1 and 1 --> 0 at the same time.
18  - Packet: ETH / IP /
19  - Direction 0 --> 1:
20    - Source IP address range:      10.10.10.2 - 10.10.10.254
21    - Destination IP address range: 20.20.20.2
22  - Direction 1 --> 0:
23    - Source IP address range:      20.20.20.2 - 20.20.20.254
24    - Destination IP address range: 10.10.10.2
25 """
26
27 from trex_stl_lib.api import *
28 from profile_trex_stateless_base_class import TrafficStreamsBaseClass
29
30
31 class TrafficStreams(TrafficStreamsBaseClass):
32     """Stream profile."""
33
34     def __init__(self):
35         """Initialization and setting of streams' parameters."""
36
37         super(TrafficStreamsBaseClass, self).__init__()
38
39         # IPs used in packet headers.
40         self.p1_src_start_ip = '10.10.10.2'
41         self.p1_src_end_ip = '10.10.10.254'
42         self.p1_dst_start_ip = '20.20.20.2'
43
44         self.p2_src_start_ip = '20.20.20.2'
45         self.p2_src_end_ip = '20.20.20.254'
46         self.p2_dst_start_ip = '10.10.10.2'
47
48     def define_packets(self):
49         """Defines the packets to be sent from the traffic generator.
50
51         Packet definition: | ETH | IP |
52
53         :returns: Packets to be sent from the traffic generator.
54         :rtype: tuple
55         """
56
57         # Direction 0 --> 1
58         base_pkt_a = Ether() / IP(src=self.p1_src_start_ip,
59                                   dst=self.p1_dst_start_ip,
60                                   proto=61)
61         # Direction 1 --> 0
62         base_pkt_b = Ether() / IP(src=self.p2_src_start_ip,
63                                   dst=self.p2_dst_start_ip,
64                                   proto=61)
65
66         # Direction 0 --> 1
67         vm1 = STLScVmRaw([STLVmFlowVar(name="src",
68                                        min_value=self.p1_src_start_ip,
69                                        max_value=self.p1_src_end_ip,
70                                        size=4, op="inc"),
71                           STLVmWrFlowVar(fv_name="src", pkt_offset="IP.src"),
72                           STLVmFixIpv4(offset="IP")],
73                          split_by_field="src")
74         # Direction 1 --> 0
75         vm2 = STLScVmRaw([STLVmFlowVar(name="src",
76                                        min_value=self.p2_src_start_ip,
77                                        max_value=self.p2_src_end_ip,
78                                        size=4, op="inc"),
79                           STLVmWrFlowVar(fv_name="src", pkt_offset="IP.src"),
80                           STLVmFixIpv4(offset="IP")],
81                          split_by_field="src")
82
83         return base_pkt_a, base_pkt_b, vm1, vm2
84
85
86 def register():
87     """Register this traffic profile to T-rex.
88
89     Do not change this function.
90
91     :return: Traffic streams.
92     :rtype: Object
93     """
94     return TrafficStreams()