5dbc5fc803ca486ac338d3b00b818395e162ac07
[csit.git] / resources / traffic_profiles / trex / trex-sl-3n-ethip4-ip4dst40.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.0.39
22  - Direction 1 --> 0:
23    - Source IP address range:      20.0.0.1
24    - Destination IP address range: 10.0.0.0 - 10.0.0.39
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         # IPs used in packet headers.
40         self.p1_src_start_ip = u"10.0.0.1"
41         self.p1_dst_start_ip = u"20.0.0.0"
42         self.p1_dst_end_ip = u"20.0.0.39"
43
44         self.p2_src_start_ip = u"20.0.0.1"
45         self.p2_dst_start_ip = u"10.0.0.0"
46         self.p2_dst_end_ip = u"10.0.0.39"
47
48     def define_packets(self):
49         """Defines the packets to be sent from the traffic generator.
50
51         Packet definition: | ETH | IP |
52
53         :returns: Packets to be sent from the traffic generator.
54         :rtype: tuple
55         """
56
57         # Direction 0 --> 1
58         base_pkt_a = (
59             Ether() /
60             IP(
61                 src=self.p1_src_start_ip,
62                 dst=self.p1_dst_start_ip,
63                 proto=61
64             )
65         )
66         # Direction 1 --> 0
67         base_pkt_b = (
68             Ether() /
69             IP(
70                 src=self.p2_src_start_ip,
71                 dst=self.p2_dst_start_ip,
72                 proto=61
73             )
74         )
75
76         # Direction 0 --> 1
77         vm1 = STLScVmRaw(
78             [
79                 STLVmFlowVar(
80                     name=u"dst",
81                     min_value=self.p1_dst_start_ip,
82                     max_value=self.p1_dst_end_ip,
83                     size=4,
84                     op=u"inc"
85                 ),
86                 STLVmWrFlowVar(
87                     fv_name=u"dst",
88                     pkt_offset=u"IP.dst"
89                 ),
90                 STLVmFixIpv4(
91                     offset=u"IP"
92                 )
93             ]
94         )
95         # Direction 1 --> 0
96         vm2 = STLScVmRaw(
97             [
98                 STLVmFlowVar(
99                     name=u"dst",
100                     min_value=self.p2_dst_start_ip,
101                     max_value=self.p2_dst_end_ip,
102                     size=4,
103                     op=u"inc"
104                 ),
105                 STLVmWrFlowVar(
106                     fv_name=u"dst",
107                     pkt_offset=u"IP.dst"
108                 ),
109                 STLVmFixIpv4(
110                     offset=u"IP"
111                 )
112             ]
113         )
114
115         return base_pkt_a, base_pkt_b, vm1, vm2
116
117
118 def register():
119     """Register this traffic profile to T-rex.
120
121     Do not change this function.
122
123     :return: Traffic streams.
124     :rtype: Object
125     """
126     return TrafficStreams()