GPL/traffic_profiles/trex/trex-stl-3n-ethip4-ip4dst1000-2cnf.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.0.3.231
  32  - Direction 1 --> 0:
  33    - Source IP address range:      20.0.0.1
  34    - Destination IP address range: 10.0.0.0 - 10.0.3.231
  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         self.p1_dst_start_mac = u"02:02:00:00:12:00"
  50
  51         self.p2_dst_start_mac = u"02:02:00:00:02:00"
  52
  53         # IPs used in packet headers.
  54         self.p1_src_start_ip = u"10.0.0.1"
  55         self.p1_dst_start_ip = u"20.0.0.0"
  56         self.p1_dst_end_ip = u"20.0.3.231"
  57
  58         self.p2_src_start_ip = u"20.0.0.1"
  59         self.p2_dst_start_ip = u"10.0.0.0"
  60         self.p2_dst_end_ip = u"10.0.3.231"
  61
  62     def define_packets(self):
  63         """Defines the packets to be sent from the traffic generator.
  64
  65         Packet definition: | ETH | IP |
  66
  67         :returns: Packets to be sent from the traffic generator.
  68         :rtype: tuple
  69         """
  70
  71         # Direction 0 --> 1
  72         base_pkt_a = (
  73             Ether(
  74                 dst=self.p1_dst_start_mac
  75             ) /            IP(
  76                 src=self.p1_src_start_ip,
  77                 dst=self.p1_dst_start_ip,
  78                 proto=61
  79             )
  80         )
  81         # Direction 1 --> 0
  82         base_pkt_b = (
  83             Ether(
  84               dst=self.p2_dst_start_mac
  85             ) /
  86             IP(
  87               src=self.p2_src_start_ip,
  88               dst=self.p2_dst_start_ip,
  89               proto=61
  90             )
  91         )
  92
  93         # Direction 0 --> 1
  94         vm1 = STLScVmRaw(
  95             [
  96                 STLVmFlowVar(
  97                     name=u"mac_dst",
  98                     min_value=0,
  99                     max_value=1,
 100                     size=1,
 101                     op=u"inc"
 102                 ),
 103                 STLVmWrFlowVar(
 104                     fv_name=u"mac_dst",
 105                     pkt_offset=5
 106                 ),
 107                 STLVmFlowVar(
 108                     name=u"dst",
 109                     min_value=self.p1_dst_start_ip,
 110                     max_value=self.p1_dst_end_ip,
 111                     size=4,
 112                     op=u"inc"
 113                 ),
 114                 STLVmWrFlowVar(
 115                     fv_name=u"dst",
 116                     pkt_offset=u"IP.dst"
 117                 ),
 118                 STLVmFixIpv4(
 119                    offset=u"IP"
 120                 )
 121             ]
 122         )
 123         # Direction 1 --> 0
 124         vm2 = STLScVmRaw(
 125             [
 126                 STLVmFlowVar(
 127                     name=u"mac_dst",
 128                     min_value=0,
 129                     max_value=1,
 130                     size=1,
 131                     op=u"inc"
 132                 ),
 133                 STLVmWrFlowVar(
 134                     fv_name=u"mac_dst",
 135                     pkt_offset=5
 136                 ),
 137                 STLVmFlowVar(
 138                     name=u"dst",
 139                     min_value=self.p2_dst_start_ip,
 140                     max_value=self.p2_dst_end_ip,
 141                     size=4,
 142                     op=u"inc"
 143                 ),
 144                 STLVmWrFlowVar(
 145                     fv_name=u"dst",
 146                     pkt_offset=u"IP.dst"
 147                 ),
 148                 STLVmFixIpv4(
 149                     offset=u"IP"
 150                 )
 151             ]
 152         )
 153
 154         return base_pkt_a, base_pkt_b, vm1, vm2
 155
 156
 157 def register():
 158     """Register this traffic profile to T-rex.
 159
 160     Do not change this function.
 161
 162     :return: Traffic streams.
 163     :rtype: Object
 164     """
 165     return TrafficStreams()