CSIT-1425 Upgrade TRex to v2.54
[csit.git] / resources / traffic_profiles / trex / trex-sl-2n3n-ethip4-ip4src254-8c1n.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 / IP /
19  - Direction 0 --> 1:
20    - Destination MAC address: 52:54:00:00:nf_id:01
21    - Source IP address range:      10.10.10.1 - 10.10.10.254
22    - Destination IP address range: 20.20.20.1
23  - Direction 1 --> 0:
24     - Destination MAC address: 52:54:00:00:nf_id:02
25    - Source IP address range:      20.20.20.1 - 20.20.20.254
26    - Destination IP address range: 10.10.10.1
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         # Service density parameters.
42         self.nf_chains = 8
43         self.nf_nodes = 1
44
45         # MACs used in packet headers.
46         self.p1_dst_start_mac = '52:54:00:00:00:01'
47         self.p2_dst_start_mac = '52:54:00:00:00:02'
48
49         # IPs used in packet headers.
50         self.p1_src_start_ip = '10.10.10.1'
51         self.p1_src_end_ip = '10.10.10.254'
52         self.p1_dst_start_ip = '20.20.20.1'
53
54         self.p2_src_start_ip = '20.20.20.1'
55         self.p2_src_end_ip = '20.20.20.254'
56         self.p2_dst_start_ip = '10.10.10.1'
57
58     def define_packets(self):
59         """Defines the packets to be sent from the traffic generator.
60
61         Packet definition: | ETH | IP |
62
63         :returns: Packets to be sent from the traffic generator.
64         :rtype: tuple
65         """
66
67         # Direction 0 --> 1
68         base_pkt_a = (Ether(dst=self.p1_dst_start_mac) /
69                       IP(src=self.p1_src_start_ip,
70                          dst=self.p1_dst_start_ip,
71                          proto=61))
72         # Direction 1 --> 0
73         base_pkt_b = (Ether(dst=self.p2_dst_start_mac) /
74                       IP(src=self.p2_src_start_ip,
75                          dst=self.p2_dst_start_ip,
76                          proto=61))
77
78         # Direction 0 --> 1
79         vm1 = STLScVmRaw([STLVmFlowVar(name="mac_dst",
80                                        min_value=1,
81                                        max_value=self.nf_chains*self.nf_nodes,
82                                        size=1, step=self.nf_nodes, op="inc"),
83                           STLVmWrFlowVar(fv_name="mac_dst", pkt_offset=4),
84                           STLVmFlowVar(name="src",
85                                        min_value=self.p1_src_start_ip,
86                                        max_value=self.p1_src_end_ip,
87                                        size=4, op="inc"),
88                           STLVmWrFlowVar(fv_name="src", pkt_offset="IP.src"),
89                           STLVmFixIpv4(offset="IP")])
90         # Direction 1 --> 0
91         vm2 = STLScVmRaw([STLVmFlowVar(name="mac_dst",
92                                        min_value=self.nf_nodes,
93                                        max_value=self.nf_chains*self.nf_nodes,
94                                        size=1, step=self.nf_nodes, op="inc"),
95                           STLVmWrFlowVar(fv_name="mac_dst", pkt_offset=4),
96                           STLVmFlowVar(name="src",
97                                        min_value=self.p2_src_start_ip,
98                                        max_value=self.p2_src_end_ip,
99                                        size=4, op="inc"),
100                           STLVmWrFlowVar(fv_name="src", pkt_offset="IP.src"),
101                           STLVmFixIpv4(offset="IP")])
102
103         return base_pkt_a, base_pkt_b, vm1, vm2
104
105
106 def register():
107     """Register this traffic profile to T-rex.
108
109     Do not change this function.
110
111     :return: Traffic streams.
112     :rtype: Object
113     """
114     return TrafficStreams()