Separate files needing GPL license
[csit.git] / GPL / traffic_profiles / trex / trex-sl-2n-dot1qip6asym-ip6src253.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  - Direction 0 --> 1:
19    - Packet: ETH / IPv6 /
20    - Source IP address range:      2001:1::2 - 2001:1::FE
21    - Destination IP address range: 2001:2::2
22  - Direction 1 --> 0:
23    - Packet: ETH / DOT1Q / IPv6 /
24    - Source IP address range:      2001:2::2 - 2001:2::FE
25    - Destination IP address range: 2001:1::2
26 """
27
28 from trex.stl.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 = u"2001:1::2"
45         self.p1_src_end_ip = u"2001:1::FE"
46         self.p1_dst_start_ip = u"2001:2::2"
47
48         self.p2_src_start_ip = u"2001:2::2"
49         self.p2_src_end_ip = u"2001:2::FE"
50         self.p2_dst_start_ip = u"2001:1::2"
51
52     def define_packets(self):
53         """Defines the packets to be sent from the traffic generator.
54
55         Packet definition: | ETH | IPv6 |
56
57         :returns: Packets to be sent from the traffic generator.
58         :rtype: tuple
59         """
60
61         base_p1, count_p1 = self._get_start_end_ipv6(
62             self.p1_src_start_ip,
63             self.p1_src_end_ip
64         )
65         base_p2, count_p2 = self._get_start_end_ipv6(
66             self.p2_src_start_ip,
67             self.p2_src_end_ip
68         )
69
70         # Direction 0 --> 1
71         base_pkt_a = (
72             Ether() /
73             IPv6(
74                 src=self.p1_src_start_ip,
75                 dst=self.p1_dst_start_ip
76             )
77         )
78         # Direction 1 --> 0
79         base_pkt_b = (
80             Ether() /
81             Dot1Q(
82                 vlan=self.vlan_id
83             ) /
84             IPv6(
85                 src=self.p2_src_start_ip,
86                 dst=self.p2_dst_start_ip
87             )
88         )
89
90         # Direction 0 --> 1
91         vm1 = STLScVmRaw(
92             [
93                 STLVmFlowVar(
94                     name=u"ipv6_src",
95                     min_value=base_p1,
96                     max_value=base_p1 + count_p1,
97                     size=8, op=u"inc"
98                 ),
99                 STLVmWrFlowVar(
100                     fv_name=u"ipv6_src",
101                     pkt_offset=u"IPv6.src",
102                     offset_fixup=8
103                 )
104             ]
105         )
106         # Direction 1 --> 0
107         vm2 = STLScVmRaw(
108             [
109                 STLVmFlowVar(
110                     name=u"ipv6_src",
111                     min_value=base_p2,
112                     max_value=base_p2 + count_p2,
113                     size=8, op=u"inc"
114                 ),
115                 STLVmWrFlowVar(
116                     fv_name=u"ipv6_src",
117                     pkt_offset=u"IPv6.src",
118                     offset_fixup=8
119                 )
120             ]
121         )
122
123         return base_pkt_a, base_pkt_b, vm1, vm2
124
125
126 def register():
127     """Register this traffic profile to T-rex.
128
129     Do not change this function.
130
131     :returns: Traffic streams.
132     :rtype: Object
133     """
134     return TrafficStreams()