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