Upgrade to T-rex v2.34
[csit.git] / resources / traffic_profiles / trex / trex-sl-3n-ethip4-ip4dst253.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:      20.20.20.2
21    - Destination IP address range: 2.1.1.2 - 2.1.1.254
22  - Direction 1 --> 0:
23    - Source IP address range:      10.10.10.2
24    - Destination IP address range: 1.1.1.2 - 1.1.1.254
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 = '20.20.20.2'
41         self.p1_dst_start_ip = '2.1.1.2'
42         self.p1_dst_end_ip = '2.1.1.254'
43
44         self.p2_src_start_ip = '10.10.10.2'
45         self.p2_dst_start_ip = '1.1.1.2'
46         self.p2_dst_end_ip = '1.1.1.254'
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() /
59                       IP(src=self.p1_src_start_ip,
60                          dst=self.p1_dst_start_ip,
61                          proto=61))
62         # Direction 1 --> 0
63         base_pkt_b = (Ether() /
64                       IP(src=self.p2_src_start_ip,
65                          dst=self.p2_dst_start_ip,
66                          proto=61))
67
68         # Direction 0 --> 1
69         vm1 = STLScVmRaw([STLVmFlowVar(name="dst",
70                                        min_value=self.p1_dst_start_ip,
71                                        max_value=self.p1_dst_end_ip,
72                                        size=4, op="inc"),
73                           STLVmWrFlowVar(fv_name="dst", pkt_offset="IP.dst"),
74                           STLVmFixIpv4(offset="IP")])
75         # Direction 1 --> 0
76         vm2 = STLScVmRaw([STLVmFlowVar(name="dst",
77                                        min_value=self.p2_dst_start_ip,
78                                        max_value=self.p2_dst_end_ip,
79                                        size=4, op="inc"),
80                           STLVmWrFlowVar(fv_name="dst", pkt_offset="IP.dst"),
81                           STLVmFixIpv4(offset="IP")])
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()