GPL/traffic_profiles/trex/trex-stl-3n-ethip4-ip4dst1000000.py

   1 # Copyright (c) 2021 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
  16 # Apache 2.
  17 #
  18 # Unless required by applicable law or agreed to in writing, software
  19 # distributed under the License is distributed on an "AS IS" BASIS,
  20 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  21 # See the License for the specific language governing permissions and
  22 # limitations under the License.
  23
  24 """Stream profile for T-rex traffic generator.
  25
  26 Stream profile:
  27  - Two streams sent in directions 0 --> 1 and 1 --> 0 at the same time.
  28  - Packet: ETH / IP /
  29  - Direction 0 --> 1:
  30    - Source IP address range:      10.0.0.1
  31    - Destination IP address range: 20.0.0.0 - 20.15.66.63
  32  - Direction 1 --> 0:
  33    - Source IP address range:      20.0.0.1
  34    - Destination IP address range: 10.0.0.0 - 10.15.66.63
  35 """
  36
  37 from trex.stl.api import *
  38 from profile_trex_stateless_base_class import TrafficStreamsBaseClass
  39
  40
  41 class TrafficStreams(TrafficStreamsBaseClass):
  42     """Stream profile."""
  43
  44     def __init__(self):
  45         """Initialization and setting of streams' parameters."""
  46
  47         super(TrafficStreamsBaseClass, self).__init__()
  48
  49         # IPs used in packet headers.
  50         self.p1_src_start_ip = u"10.0.0.1"
  51         self.p1_dst_start_ip = u"20.0.0.0"
  52         self.p1_dst_end_ip = u"20.15.66.63"
  53
  54         self.p2_src_start_ip = u"20.0.0.1"
  55         self.p2_dst_start_ip = u"10.0.0.0"
  56         self.p2_dst_end_ip = u"10.15.66.63"
  57
  58     def define_packets(self):
  59         """Defines the packets to be sent from the traffic generator.
  60
  61         Packet definition: | ETH | IP |
  62
  63         :returns: Packets to be sent from the traffic generator.
  64         :rtype: tuple
  65         """
  66
  67         # Direction 0 --> 1
  68         base_pkt_a = (
  69             Ether() /
  70             IP(
  71                 src=self.p1_src_start_ip,
  72                 dst=self.p1_dst_start_ip,
  73                 proto=61
  74             )
  75         )
  76         # Direction 1 --> 0
  77         base_pkt_b = (
  78             Ether() /
  79             IP(
  80                 src=self.p2_src_start_ip,
  81                 dst=self.p2_dst_start_ip,
  82                 proto=61
  83             )
  84         )
  85
  86         # Direction 0 --> 1
  87         vm1 = STLScVmRaw(
  88             [
  89                 STLVmFlowVar(
  90                     name=u"dst",
  91                     min_value=self.p1_dst_start_ip,
  92                     max_value=self.p1_dst_end_ip,
  93                     size=4,
  94                     op=u"inc"
  95                 ),
  96                 STLVmWrFlowVar(
  97                     fv_name=u"dst",
  98                     pkt_offset=u"IP.dst"
  99                 ),
 100                 STLVmFixIpv4(
 101                     offset=u"IP"
 102                 )
 103             ]
 104         )
 105         # Direction 1 --> 0
 106         vm2 = STLScVmRaw(
 107             [
 108                 STLVmFlowVar(
 109                     name=u"dst",
 110                     min_value=self.p2_dst_start_ip,
 111                     max_value=self.p2_dst_end_ip,
 112                     size=4,
 113                     op=u"inc"
 114                 ),
 115                 STLVmWrFlowVar(
 116                     fv_name=u"dst",
 117                     pkt_offset=u"IP.dst"
 118                 ),
 119                 STLVmFixIpv4(
 120                     offset=u"IP"
 121                 )
 122             ]
 123         )
 124
 125         return base_pkt_a, base_pkt_b, vm1, vm2
 126
 127
 128 def register():
 129     """Register this traffic profile to T-rex.
 130
 131     Do not change this function.
 132
 133     :return: Traffic streams.
 134     :rtype: Object
 135     """
 136     return TrafficStreams()