74d409bdc8c7447a4aba1d8864467bbabd310921
[csit.git] / resources / traffic_profiles / trex / trex-sl-2n-dot1qip4asym-ip4src254.py
1 # Copyright (c) 2018 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  - Direction 0 --> 1:
19    - Packet:                       ETH / IP /
20    - Source IP address range:      10.10.10.1 - 10.10.10.254
21    - Destination IP address range: 20.20.20.1
22  - Direction 1 --> 0:
23    - Packet:                       ETH / DOT1Q / IP /
24    - Source IP address range:      20.20.20.1 - 20.20.20.254
25    - Destination IP address range: 10.10.10.1
26 """
27
28 from trex_stl_lib.api import *
29 from profile_trex_stateless_base_class import TrafficStreamsBaseClass
30
31
32 class TrafficStreams(TrafficStreamsBaseClass):
33     """Stream profile."""
34
35     def __init__(self):
36         """Initialization and setting of streams' parameters."""
37
38         super(TrafficStreamsBaseClass, self).__init__()
39
40         # VLAN ID
41         self.vlan_id = 10
42
43         # IPs used in packet headers.
44         self.p1_src_start_ip = '10.10.10.1'
45         self.p1_src_end_ip = '10.10.10.254'
46         self.p1_dst_start_ip = '20.20.20.1'
47
48         self.p2_src_start_ip = '20.20.20.1'
49         self.p2_src_end_ip = '20.20.20.254'
50         self.p2_dst_start_ip = '10.10.10.1'
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 = (Ether() /
63                       IP(src=self.p1_src_start_ip,
64                          dst=self.p1_dst_start_ip,
65                          proto=61))
66         # Direction 1 --> 0
67         base_pkt_b = (Ether() /
68                       Dot1Q(vlan=self.vlan_id) /
69                       IP(src=self.p2_src_start_ip,
70                          dst=self.p2_dst_start_ip,
71                          proto=61))
72
73         # Direction 0 --> 1
74         vm1 = STLScVmRaw([STLVmFlowVar(name="src",
75                                        min_value=self.p1_src_start_ip,
76                                        max_value=self.p1_src_end_ip,
77                                        size=4, op="inc"),
78                           STLVmWrFlowVar(fv_name="src", pkt_offset="IP.src"),
79                           STLVmFixIpv4(offset="IP")])
80         # Direction 1 --> 0
81         vm2 = STLScVmRaw([STLVmFlowVar(name="src",
82                                        min_value=self.p2_src_start_ip,
83                                        max_value=self.p2_src_end_ip,
84                                        size=4, op="inc"),
85                           STLVmWrFlowVar(fv_name="src", pkt_offset="IP.src"),
86                           STLVmFixIpv4(offset="IP")])
87
88         return base_pkt_a, base_pkt_b, vm1, vm2
89
90
91 def register():
92     """Register this traffic profile to T-rex.
93
94     Do not change this function.
95
96     :return: Traffic streams.
97     :rtype: Object
98     """
99     return TrafficStreams()