Upgrade to T-rex v2.34
[csit.git] / resources / traffic_profiles / trex / trex-sl-3n-ethip4-macsrc100kip4src100k.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 |
19  - Direction 0 --> 1:
20    - Source MAC address range:     ca:fe:00:00:00:00 - ca:fe:00:01:86:9f
21    - Source IP address range:      10.0.0.2 - 10.1.134.161
22    - Destination IP address range: 20.0.0.1
23  - Direction 1 --> 0:
24    - Source MAC address range:     fa:ce:00:00:00:00 - fa:ce:00:01:86:9f
25    - Source IP address range:      20.0.0.2 - 20.1.134.161
26    - Destination IP address range: 10.0.0.1
27 """
28
29 from trex_stl_lib.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         self.clients = 100000
42
43         # MACs used in packet headers.
44         self.p1_src_start_mac = 'ca:fe:00:00:00:00'  # mask: 00:00:FF:FF:FF:FF
45
46         self.p2_src_start_mac = 'fa:ce:00:00:00:00'  # mask: 00:00:FF:FF:FF:FF
47
48         # IPs used in packet headers.
49         self.p1_src_start_ip = '10.0.0.2'
50         self.p1_src_end_ip = '10.1.134.161'
51         self.p1_dst_start_ip = '20.0.0.1'
52
53         self.p2_src_start_ip = '20.0.0.2'
54         self.p2_src_end_ip = '20.1.134.161'
55         self.p2_dst_start_ip = '10.0.0.1'
56
57     def define_packets(self):
58         """Defines the packets to be sent from the traffic generator.
59
60         Packet definition: | ETH | IP |
61
62         :returns: Packets to be sent from the traffic generator.
63         :rtype: tuple
64         """
65
66         # Direction 0 --> 1
67         base_pkt_a = (Ether(src=self.p1_src_start_mac) /
68                       IP(src=self.p1_src_start_ip,
69                          dst=self.p1_dst_start_ip,
70                          proto=61))
71         # Direction 1 --> 0
72         base_pkt_b = (Ether(src=self.p2_src_start_mac) /
73                       IP(src=self.p2_src_start_ip,
74                          dst=self.p2_dst_start_ip,
75                          proto=61))
76
77         # Direction 0 --> 1
78         vm1 = STLScVmRaw([STLVmFlowVar(name="mac_src",
79                                        min_value=0,
80                                        max_value=self.clients-1,
81                                        size=4, op="inc"),
82                           STLVmWrFlowVar(fv_name="mac_src", pkt_offset=8),
83                           STLVmFlowVar(name="src",
84                                        min_value=self.p1_src_start_ip,
85                                        max_value=self.p1_src_end_ip,
86                                        size=4, op="inc"),
87                           STLVmWrFlowVar(fv_name="src", pkt_offset="IP.src"),
88                           STLVmFixIpv4(offset="IP")])
89         # Direction 1 --> 0
90         vm2 = STLScVmRaw([STLVmFlowVar(name="mac_src",
91                                        min_value=0,
92                                        max_value=self.clients-1,
93                                        size=4, op="inc"),
94                           STLVmWrFlowVar(fv_name="mac_src", pkt_offset=8),
95                           STLVmFlowVar(name="src",
96                                        min_value=self.p2_src_start_ip,
97                                        max_value=self.p2_src_end_ip,
98                                        size=4, op="inc"),
99                           STLVmWrFlowVar(fv_name="src", pkt_offset="IP.src"),
100                           STLVmFixIpv4(offset="IP")])
101
102         return base_pkt_a, base_pkt_b, vm1, vm2
103
104
105 def register():
106     """Register this traffic profile to T-rex.
107
108     Do not change this function.
109
110     :returns: Traffic streams.
111     :rtype: Object
112     """
113     return TrafficStreams()