CSIT-687: Directory structure reorganization
[csit.git] / resources / traffic_profiles / trex / trex-sl-3n-ethip4udp-2000u15p.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 / UDP
19  - Direction 0 --> 1:
20    - Source IP address range:      20.0.0.0 - 20.0.7.207
21    - Destination IP address range: 12.0.0.2
22    - Source UDP port range:        1024 - 1038
23    - Destination UDP port range:   1024
24  - Direction 1 --> 0:
25    - Source IP address range:      12.0.0.2
26    - Destination IP address range: 200.0.0.0
27    - Source UDP port range:        1024
28    - Destination UDP port range:   1024 - 31022
29 """
30
31 from trex_stl_lib.api import *
32 from profile_trex_stateless_base_class import TrafficStreamsBaseClass
33
34
35 class TrafficStreams(TrafficStreamsBaseClass):
36     """Stream profile."""
37
38     def __init__(self):
39         """Initialization and setting of streams' parameters."""
40
41         super(TrafficStreamsBaseClass, self).__init__()
42
43         # IPs used in packet headers.
44         self.p1_src_start_ip = '20.0.0.0'
45         self.p1_src_end_ip = '20.0.7.207'
46         self.p1_dst_start_ip = '12.0.0.2'
47
48         self.p2_src_start_ip = '12.0.0.2'
49         self.p2_src_end_ip = '12.0.0.2'
50         self.p2_dst_start_ip = '200.0.0.0'
51
52         # UDP ports used in packet headers.
53         self.p1_src_start_udp_port = 1024
54         self.p1_src_end_udp_port = 1038
55         self.p1_dst_start_udp_port = 1024
56
57         self.p2_src_start_udp_port = 1024
58         self.p2_dst_start_udp_port = 1024
59         self.p2_dst_end_udp_port = 31022
60
61     def define_packets(self):
62         """Defines the packets to be sent from the traffic generator.
63
64         Packet definition: | ETH | IP | UDP |
65
66         :returns: Packets to be sent from the traffic generator.
67         :rtype: tuple
68         """
69
70         # Direction 0 --> 1
71         base_pkt_a = (Ether() /
72                       IP(src=self.p1_src_start_ip,
73                          dst=self.p1_dst_start_ip,
74                          proto=17) /
75                       UDP(sport=self.p1_src_start_udp_port,
76                           dport=self.p1_dst_start_udp_port))
77         # Direction 1 --> 0
78         base_pkt_b = (Ether() /
79                       IP(src=self.p2_src_start_ip,
80                          dst=self.p2_dst_start_ip,
81                          proto=17) /
82                       UDP(sport=self.p2_src_start_udp_port,
83                           dport=self.p2_dst_start_udp_port))
84
85         # Direction 0 --> 1
86         vm1 = STLScVmRaw([
87             STLVmTupleGen(ip_min=self.p1_src_start_ip,
88                           ip_max=self.p1_src_end_ip,
89                           port_min=self.p1_src_start_udp_port,
90                           port_max=self.p1_src_end_udp_port,
91                           name="tuple"),
92             STLVmWrFlowVar(fv_name="tuple.ip", pkt_offset="IP.src"),
93             STLVmFixIpv4(offset="IP"),
94             STLVmWrFlowVar(fv_name="tuple.port", pkt_offset="UDP.sport")
95         ])
96         # Direction 0 --> 1
97         vm2 = STLScVmRaw([
98             STLVmFlowVar(name="dport",
99                          min_value=self.p2_dst_start_udp_port,
100                          max_value=self.p2_dst_end_udp_port,
101                          size=2, op="inc"),
102             STLVmWrFlowVar(fv_name="dport", pkt_offset="UDP.dport")
103         ])
104
105         return base_pkt_a, base_pkt_b, vm1, vm2
106
107
108 def register():
109     """Register this traffic profile to T-rex.
110
111     Do not change this function.
112
113     :return: Traffic streams.
114     :rtype: Object
115     """
116     return TrafficStreams()