CSIT-1425 Upgrade TRex to v2.54
[csit.git] / resources / traffic_profiles / trex / trex-sl-3n-dot1qip4-vlan10ip4src254ip4dst254.py
1 # Copyright (c) 2019 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 / DOT1Q / IP /
19  - Direction 0 --> 1:
20    - VLAN range:                    1 - 10
21    - Source IP address range:       10.0.0.1 - 10.0.0.254
22    - Destination IP address range:  20.0.0.1 - 20.0.0.254
23  - Direction 1 --> 0:
24    - VLAN range:                    1 - 10
25    - Source IP address range:       20.0.0.1 - 20.0.0.254
26    - Destination IP address range:  10.0.0.1 - 10.0.0.254
27 """
28
29 from trex.stl.api import *
30 from profile_trex_stateless_base_class import TrafficStreamsBaseClass
31
32
33 class TrafficStreams(TrafficStreamsBaseClass):
34     """Stream profile."""
35
36     def __init__(self):
37         """Initialization and setting of streams' parameters."""
38
39         super(TrafficStreamsBaseClass, self).__init__()
40
41         # VLAN IDs
42         self.vlans = 10
43
44         self.p1_vlan_start = 1
45         self.p1_vlan_end = self.p1_vlan_start + self.vlans - 1
46
47         self.p2_vlan_start = 1
48         self.p2_vlan_end = self.p2_vlan_start + self.vlans - 1
49
50
51         # IPs used in packet headers.
52         self.p1_src_start_ip = '10.0.0.1'
53         self.p1_src_end_ip = '10.0.0.254'
54
55         self.p1_dst_start_ip = '20.0.0.1'
56         self.p1_dst_end_ip = '20.0.0.254'
57
58         self.p2_src_start_ip = '20.0.0.1'
59         self.p2_src_end_ip = '20.0.0.254'
60
61         self.p2_dst_start_ip = '10.0.0.1'
62         self.p2_dst_end_ip = '10.0.0.254'
63
64     def define_packets(self):
65         """Defines the packets to be sent from the traffic generator.
66
67         Packet definition: | ETH | DOT1Q | IP |
68
69         :returns: Packets to be sent from the traffic generator.
70         :rtype: tuple
71         """
72
73         # Direction 0 --> 1
74         base_pkt_a = (Ether() /
75                       Dot1Q(vlan=self.p1_vlan_start) /
76                       IP(src=self.p1_src_start_ip,
77                          dst=self.p1_dst_start_ip,
78                          proto=61))
79         # Direction 1 --> 0
80         base_pkt_b = (Ether() /
81                       Dot1Q(vlan=self.p2_vlan_start) /
82                       IP(src=self.p2_src_start_ip,
83                          dst=self.p2_dst_start_ip,
84                          proto=61))
85
86         # Direction 0 --> 1
87         vm1 = STLScVmRaw([STLVmFlowVar(name="vlan",
88                                        min_value=self.p1_vlan_start,
89                                        max_value=self.p1_vlan_end,
90                                        size=2, op="inc"),
91                           STLVmWrFlowVar(fv_name="vlan",
92                                          pkt_offset="Dot1Q.vlan"),
93                           STLVmFlowVar(name="ip_src",
94                                        min_value=self.p1_src_start_ip,
95                                        max_value=self.p1_src_end_ip,
96                                        size=4, op="random"),
97                           STLVmWrFlowVar(fv_name="ip_src", pkt_offset="IP.src"),
98                           STLVmFlowVar(name="ip_dst",
99                                        min_value=self.p1_dst_start_ip,
100                                        max_value=self.p1_dst_end_ip,
101                                        size=4, op="random"),
102                           STLVmWrFlowVar(fv_name="ip_dst", pkt_offset="IP.dst"),
103                           STLVmFixIpv4(offset="IP")])
104         # Direction 1 --> 0
105         vm2 = STLScVmRaw([STLVmFlowVar(name="vlan",
106                                        min_value=self.p2_vlan_start,
107                                        max_value=self.p2_vlan_end,
108                                        size=2, op="inc"),
109                           STLVmWrFlowVar(fv_name="vlan",
110                                          pkt_offset="Dot1Q.vlan"),
111                           STLVmFlowVar(name="ip_src",
112                                        min_value=self.p2_src_start_ip,
113                                        max_value=self.p2_src_end_ip,
114                                        size=4, op="random"),
115                           STLVmWrFlowVar(fv_name="ip_src", pkt_offset="IP.src"),
116                           STLVmFlowVar(name="ip_dst",
117                                        min_value=self.p2_dst_start_ip,
118                                        max_value=self.p2_dst_end_ip,
119                                        size=4, op="random"),
120                           STLVmWrFlowVar(fv_name="ip_dst", pkt_offset="IP.dst"),
121                           STLVmFixIpv4(offset="IP")])
122
123         return base_pkt_a, base_pkt_b, vm1, vm2
124
125
126 def register():
127     """Register this traffic profile to T-rex.
128
129     Do not change this function.
130
131     :returns: Traffic streams.
132     :rtype: Object
133     """
134     return TrafficStreams()