Python3: Migration of files under traffic-profiles/trex
[csit.git] / resources / traffic_profiles / trex / trex-sl-3n-ethip4-ip4dst400-4cnf.py
1 # Copyright (c) 2020 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.0.0.1
21    - Destination IP address range: 20.0.0.0 - 20.0.1.143
22  - Direction 1 --> 0:
23    - Source IP address range:      20.0.0.1
24    - Destination IP address range: 10.0.0.0 - 10.0.1.143
25 """
26
27 from trex.stl.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         self.p1_dst_start_mac = u"02:02:00:00:12:00"
40
41         self.p2_dst_start_mac = u"02:02:00:00:02:00"
42
43         # IPs used in packet headers.
44         self.p1_src_start_ip = u"10.0.0.1"
45         self.p1_dst_start_ip = u"20.0.0.0"
46         self.p1_dst_end_ip = u"20.0.1.143"
47
48         self.p2_src_start_ip = u"20.0.0.1"
49         self.p2_dst_start_ip = u"10.0.0.0"
50         self.p2_dst_end_ip = u"10.0.1.143"
51
52     def define_packets(self):
53         """Defines the packets to be sent from the traffic generator.
54
55         Packet definition: | ETH | IP |
56
57         :returns: Packets to be sent from the traffic generator.
58         :rtype: tuple
59         """
60
61         # Direction 0 --> 1
62         base_pkt_a = (
63             Ether(
64                 dst=self.p1_dst_start_mac
65             ) /
66             IP(
67                 src=self.p1_src_start_ip,
68                 dst=self.p1_dst_start_ip,
69                 proto=61
70             )
71         )
72         # Direction 1 --> 0
73         base_pkt_b = (
74             Ether(
75                 dst=self.p2_dst_start_mac
76             ) /
77             IP(
78                 src=self.p2_src_start_ip,
79                 dst=self.p2_dst_start_ip,
80                 proto=61
81             )
82         )
83
84         # Direction 0 --> 1
85         vm1 = STLScVmRaw(
86             [
87                 STLVmFlowVar(
88                     name=u"mac_dst",
89                     min_value=0,
90                     max_value=3,
91                     size=1,
92                     op=u"inc"
93                 ),
94                 STLVmFlowVar(
95                     name=u"dst",
96                     min_value=self.p1_dst_start_ip,
97                     max_value=self.p1_dst_end_ip,
98                     size=4,
99                     op=u"inc"
100                 ),
101                 STLVmWrFlowVar(
102                     fv_name=u"dst",
103                     pkt_offset=u"IP.dst"
104                 ),
105                 STLVmFixIpv4(
106                     offset=u"IP"
107                 )
108             ]
109         )
110         # Direction 1 --> 0
111         vm2 = STLScVmRaw(
112             [
113                 STLVmFlowVar(
114                     name=u"mac_dst",
115                     min_value=0,
116                     max_value=3,
117                     size=1,
118                     op=u"inc"
119                 ),
120                 STLVmWrFlowVar(
121                     fv_name=u"mac_dst",
122                     pkt_offset=5
123                 ),
124                 STLVmFlowVar(
125                     name=u"dst",
126                     min_value=self.p2_dst_start_ip,
127                     max_value=self.p2_dst_end_ip,
128                     size=4,
129                     op=u"inc"
130                 ),
131                 STLVmWrFlowVar(
132                     fv_name=u"dst",
133                     pkt_offset=u"IP.dst"
134                 ),
135                 STLVmFixIpv4(
136                     offset=u"IP"
137                 )
138             ]
139         )
140
141         return base_pkt_a, base_pkt_b, vm1, vm2
142
143
144 def register():
145     """Register this traffic profile to T-rex.
146
147     Do not change this function.
148
149     :return: Traffic streams.
150     :rtype: Object
151     """
152     return TrafficStreams()
153