8e959c829d135eb95040f5a7a2772c5848bfb4b2
[csit.git] / resources / traffic_profiles / trex / trex-sl-3n-ethip4-macsrc10kip4src10k.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 MAC address range:     ca:fe:00:00:00:00 - ca:fe:00:00:27:0f
21    - Source IP address range:      10.0.0.2 - 10.0.39.17
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:00:27:0f
25    - Source IP address range:      20.0.0.2 - 20.0.39.17
26    - Destination IP address range: 10.0.0.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         self.clients = 10000
42
43         # MACs used in packet headers.
44         self.p1_src_start_mac = u"ca:fe:00:00:00:00"  # mask: 00:00:FF:FF:FF:FF
45
46         self.p2_src_start_mac = u"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 = u"10.0.0.2"
50         self.p1_src_end_ip = u"10.0.39.17"
51         self.p1_dst_start_ip = u"20.0.0.1"
52
53         self.p2_src_start_ip = u"20.0.0.2"
54         self.p2_src_end_ip = u"20.0.39.17"
55         self.p2_dst_start_ip = u"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 = (
68             Ether(
69                 src=self.p1_src_start_mac
70             ) /
71             IP(
72                 src=self.p1_src_start_ip,
73                 dst=self.p1_dst_start_ip,
74                 proto=61
75             )
76         )
77         # Direction 1 --> 0
78         base_pkt_b = (
79             Ether(
80                 src=self.p2_src_start_mac
81             ) /
82             IP(
83                 src=self.p2_src_start_ip,
84                 dst=self.p2_dst_start_ip,
85                 proto=61
86             )
87         )
88
89         # Direction 0 --> 1
90         vm1 = STLScVmRaw(
91             [
92                 STLVmFlowVar(
93                     name=u"mac_src",
94                     min_value=0,
95                     max_value=self.clients-1,
96                     size=4,
97                     op=u"inc"
98                 ),
99                 STLVmWrFlowVar(
100                     fv_name=u"mac_src",
101                     pkt_offset=8
102                 ),
103                 STLVmFlowVar(
104                     name=u"src",
105                     min_value=self.p1_src_start_ip,
106                     max_value=self.p1_src_end_ip,
107                     size=4,
108                     op=u"inc"
109                 ),
110                 STLVmWrFlowVar(
111                     fv_name=u"src",
112                     pkt_offset=u"IP.src"
113                 ),
114                 STLVmFixIpv4(
115                     offset=u"IP"
116                 )
117             ]
118         )
119         # Direction 1 --> 0
120         vm2 = STLScVmRaw(
121             [
122                 STLVmFlowVar(
123                     name=u"mac_src",
124                     min_value=0,
125                     max_value=self.clients-1,
126                     size=4,
127                     op=u"inc"
128                 ),
129                 STLVmWrFlowVar(
130                     fv_name=u"mac_src",
131                     pkt_offset=8
132                 ),
133                 STLVmFlowVar(
134                     name=u"src",
135                     min_value=self.p2_src_start_ip,
136                     max_value=self.p2_src_end_ip,
137                     size=4,
138                     op=u"inc"
139                 ),
140                 STLVmWrFlowVar(
141                     fv_name=u"src",
142                     pkt_offset=u"IP.src"
143                 ),
144                 STLVmFixIpv4(
145                     offset=u"IP"
146                 )
147             ]
148         )
149
150         return base_pkt_a, base_pkt_b, vm1, vm2
151
152
153 def register():
154     """Register this traffic profile to T-rex.
155
156     Do not change this function.
157
158     :returns: Traffic streams.
159     :rtype: Object
160     """
161     return TrafficStreams()