GPL/traffic_profiles/trex/trex-stl-3n-ethip6-ip6dst10000.py

   1 # Copyright (c) 2020 Cisco and/or its affiliates.
   2 #
   3 # SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
   4 #
   5 # Licensed under the Apache License 2.0 or
   6 # GNU General Public License v2.0 or later;  you may not use this file
   7 # except in compliance with one of these Licenses. You
   8 # may obtain a copy of the Licenses at:
   9 #
  10 #     http://www.apache.org/licenses/LICENSE-2.0
  11 #     https://www.gnu.org/licenses/old-licenses/gpl-2.0-standalone.html
  12 #
  13 # Note: If this file is linked with Scapy, which is GPLv2+, your use of it
  14 # must be under GPLv2+.  If at any point in the future it is no longer linked
  15 # with Scapy (or other GPLv2+ licensed software), you are free to choose Apache 2.
  16 #
  17 # Unless required by applicable law or agreed to in writing, software
  18 # distributed under the License is distributed on an "AS IS" BASIS,
  19 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  20 # See the License for the specific language governing permissions and
  21 # limitations under the License.
  22
  23 """Stream profile for T-rex traffic generator.
  24
  25 Stream profile:
  26  - Two streams sent in directions 0 --> 1 and 1 --> 0 at the same time.
  27  - Packet: ETH / IPv6 /
  28  - Direction 0 --> 1:
  29    - Source IP address range:      2001:1::1
  30    - Destination IP address range: 2001:2::0 - 2001:2::270F
  31  - Direction 1 --> 0:
  32    - Source IP address range:      2001:2::1
  33    - Destination IP address range: 2001:1::0 - 2001:1::270F
  34 """
  35
  36 from trex.stl.api import *
  37 from profile_trex_stateless_base_class import TrafficStreamsBaseClass
  38
  39
  40 class TrafficStreams(TrafficStreamsBaseClass):
  41     """Stream profile."""
  42
  43     def __init__(self):
  44         """Initialization and setting of streams' parameters."""
  45
  46         super(TrafficStreamsBaseClass, self).__init__()
  47
  48         # IPs used in packet headers.
  49         self.p1_src_start_ip = u"2001:1::1"
  50         self.p1_dst_start_ip = u"2001:2::0"
  51         self.p1_dst_end_ip = u"2001:2::270F"
  52
  53         self.p2_src_start_ip = u"2001:2::1"
  54         self.p2_dst_start_ip = u"2001:1::0"
  55         self.p2_dst_end_ip = u"2001:1::270F"
  56
  57     def define_packets(self):
  58         """Defines the packets to be sent from the traffic generator.
  59
  60         Packet definition: | ETH | IPv6 |
  61
  62         :returns: Packets to be sent from the traffic generator.
  63         :rtype: tuple
  64         """
  65
  66         base_p1, count_p1 = self._get_start_end_ipv6(
  67             self.p1_dst_start_ip,
  68             self.p1_dst_end_ip
  69         )
  70         base_p2, count_p2 = self._get_start_end_ipv6(
  71             self.p2_dst_start_ip,
  72             self.p2_dst_end_ip
  73         )
  74
  75         # Direction 0 --> 1
  76         base_pkt_a = (
  77             Ether() /
  78             IPv6(
  79                 src=self.p1_src_start_ip,
  80                 dst=self.p1_dst_start_ip
  81             )
  82         )
  83         # Direction 1 --> 0
  84         base_pkt_b = (
  85             Ether() /
  86             IPv6(
  87                 src=self.p2_src_start_ip,
  88                 dst=self.p2_dst_start_ip
  89             )
  90         )
  91
  92         # Direction 0 --> 1
  93         vm1 = STLScVmRaw(
  94             [
  95                 STLVmFlowVar(
  96                     name=u"ipv6_dst",
  97                     min_value=base_p1,
  98                     max_value=base_p1 + count_p1,
  99                     size=8,
 100                     op=u"inc"
 101                 ),
 102                 STLVmWrFlowVar(
 103                     fv_name=u"ipv6_dst",
 104                     pkt_offset=u"IPv6.dst",
 105                     offset_fixup=8
 106                 )
 107             ]
 108         )
 109         # Direction 1 --> 0
 110         vm2 = STLScVmRaw(
 111             [
 112                 STLVmFlowVar(
 113                     name=u"ipv6_dst",
 114                     min_value=base_p2,
 115                     max_value=base_p2 + count_p2,
 116                     size=8,
 117                     op=u"inc"
 118                 ),
 119                 STLVmWrFlowVar(
 120                     fv_name=u"ipv6_dst",
 121                     pkt_offset=u"IPv6.dst",
 122                     offset_fixup=8
 123                 )
 124             ]
 125         )
 126
 127         return base_pkt_a, base_pkt_b, vm1, vm2
 128
 129
 130 def register():
 131     """Register this traffic profile to T-rex.
 132
 133     Do not change this function.
 134
 135     :return: Traffic streams.
 136     :rtype: Object
 137     """
 138     return TrafficStreams()