GPL/traffic_profiles/trex/trex-stl-2n-ethip4-ip4dst1000000.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 / IP /
  28  - Direction 0 --> 1:
  29    - Source IP address range:      10.0.0.1
  30    - Destination IP address range: 20.0.0.0 - 20.15.66.63
  31  - Direction 1 --> 0:
  32    - Source IP address range:      20.0.0.1
  33    - Destination IP address range: 10.0.0.0 - 10.15.66.63
  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"10.0.0.1"
  50         self.p1_dst_start_ip = u"20.0.0.0"
  51         self.p1_dst_end_ip = u"20.15.66.63"
  52
  53         self.p2_src_start_ip = u"20.0.0.1"
  54         self.p2_dst_start_ip = u"10.0.0.0"
  55         self.p2_dst_end_ip = u"10.15.66.63"
  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           IP(
  70                 src=self.p1_src_start_ip,
  71                 dst=self.p1_dst_start_ip,
  72                 proto=61
  73             )
  74         )
  75         # Direction 1 --> 0
  76         base_pkt_b = (
  77           Ether() /
  78           IP(
  79                 src=self.p2_src_start_ip,
  80                 dst=self.p2_dst_start_ip,
  81                 proto=61
  82             )
  83         )
  84
  85         # Direction 0 --> 1
  86         vm1 = STLScVmRaw(
  87             [
  88                 STLVmFlowVar(
  89                     name="dst",
  90                     min_value=self.p1_dst_start_ip,
  91                     max_value=self.p1_dst_end_ip,
  92                     size=4,
  93                     op="inc"
  94                 ),
  95                 STLVmWrFlowVar(
  96                     fv_name="dst",
  97                     pkt_offset="IP.dst"
  98                 ),
  99                 STLVmFixIpv4(
 100                     offset="IP"
 101                 )
 102             ]
 103         )
 104         # Direction 1 --> 0
 105         vm2 = STLScVmRaw(
 106             [
 107                 STLVmFlowVar(
 108                     name="dst",
 109                     min_value=self.p2_dst_start_ip,
 110                     max_value=self.p2_dst_end_ip,
 111                     size=4,
 112                     op="inc"
 113                 ),
 114                 STLVmWrFlowVar(
 115                     fv_name="dst",
 116                     pkt_offset="IP.dst"
 117                 ),
 118                 STLVmFixIpv4(
 119                     offset="IP"
 120                 )
 121             ]
 122         )
 123
 124         return base_pkt_a, base_pkt_b, vm1, vm2
 125
 126
 127 def register():
 128     """Register this traffic profile to T-rex.
 129
 130     Do not change this function.
 131
 132     :return: Traffic streams.
 133     :rtype: Object
 134     """
 135     return TrafficStreams()