GPL/traffic_profiles/trex/trex-stl-dot1qip4-vlan1ip4src254ip4dst254.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 / DOT1Q / IP /
  28  - Direction 0 --> 1:
  29    - VLAN range:                    100
  30    - Source IP address range:       10.10.10.1 - 10.10.10.254
  31    - Destination IP address range:  20.20.20.1 - 20.20.20.254
  32  - Direction 1 --> 0:
  33    - VLAN range:                    200
  34    - Source IP address range:       20.20.20.1 - 20.20.20.254
  35    - Destination IP address range:  10.10.10.1 - 10.10.10.254
  36 """
  37
  38 from trex.stl.api import *
  39 from profile_trex_stateless_base_class import TrafficStreamsBaseClass
  40
  41
  42 class TrafficStreams(TrafficStreamsBaseClass):
  43     """Stream profile."""
  44
  45     def __init__(self):
  46         """Initialization and setting of streams' parameters."""
  47
  48         super(TrafficStreamsBaseClass, self).__init__()
  49
  50         # VLAN IDs
  51         self.p1_vlan_start = 100
  52         self.p2_vlan_start = 200
  53
  54         # IPs used in packet headers.
  55         self.p1_src_start_ip = u"10.10.10.1"
  56         self.p1_src_end_ip = u"10.10.10.254"
  57
  58         self.p1_dst_start_ip = u"20.20.20.1"
  59         self.p1_dst_end_ip = u"20.20.20.254"
  60
  61         self.p2_src_start_ip = u"20.20.20.1"
  62         self.p2_src_end_ip = u"20.20.20.254"
  63
  64         self.p2_dst_start_ip = u"10.10.10.1"
  65         self.p2_dst_end_ip = u"10.10.10.254"
  66
  67     def define_packets(self):
  68         """Defines the packets to be sent from the traffic generator.
  69
  70         Packet definition: | ETH | DOT1Q | IP |
  71
  72         :returns: Packets to be sent from the traffic generator.
  73         :rtype: tuple
  74         """
  75
  76         # Direction 0 --> 1
  77         base_pkt_a = (
  78             Ether() /
  79             Dot1Q(
  80                 vlan=self.p1_vlan_start
  81             ) /
  82             IP(
  83                 src=self.p1_src_start_ip,
  84                 dst=self.p1_dst_start_ip,
  85                 proto=61
  86             )
  87         )
  88         # Direction 1 --> 0
  89         base_pkt_b = (
  90             Ether() /
  91             Dot1Q(
  92                 vlan=self.p2_vlan_start
  93             ) /
  94             IP(
  95                 src=self.p2_src_start_ip,
  96                 dst=self.p2_dst_start_ip,
  97                 proto=61
  98             )
  99         )
 100
 101         # Direction 0 --> 1
 102         vm1 = STLScVmRaw(
 103             [
 104                 STLVmFlowVar(
 105                     name=u"ip_src",
 106                     min_value=self.p1_src_start_ip,
 107                     max_value=self.p1_src_end_ip,
 108                     size=4,
 109                     op=u"random"
 110                 ),
 111                 STLVmWrFlowVar(
 112                     fv_name=u"ip_src",
 113                     pkt_offset=u"IP.src"
 114                 ),
 115                 STLVmFlowVar(
 116                     name=u"ip_dst",
 117                     min_value=self.p1_dst_start_ip,
 118                     max_value=self.p1_dst_end_ip,
 119                     size=4,
 120                     op=u"random"
 121                 ),
 122                 STLVmWrFlowVar(
 123                     fv_name=u"ip_dst",
 124                     pkt_offset=u"IP.dst"
 125                 ),
 126                 STLVmFixIpv4(
 127                     offset=u"IP"
 128                 )
 129             ]
 130         )
 131         # Direction 1 --> 0
 132         vm2 = STLScVmRaw(
 133             [
 134               STLVmFlowVar(
 135                     name=u"ip_src",
 136                     min_value=self.p2_src_start_ip,
 137                     max_value=self.p2_src_end_ip,
 138                     size=4,
 139                     op=u"random"
 140                 ),
 141                 STLVmWrFlowVar(
 142                     fv_name=u"ip_src",
 143                     pkt_offset=u"IP.src"
 144                 ),
 145                 STLVmFlowVar(
 146                     name=u"ip_dst",
 147                     min_value=self.p2_dst_start_ip,
 148                     max_value=self.p2_dst_end_ip,
 149                     size=4,
 150                     op=u"random"
 151                 ),
 152                 STLVmWrFlowVar(
 153                     fv_name=u"ip_dst",
 154                     pkt_offset=u"IP.dst"
 155                 ),
 156                 STLVmFixIpv4(
 157                     offset=u"IP"
 158                 )
 159             ]
 160         )
 161
 162         return base_pkt_a, base_pkt_b, vm1, vm2
 163
 164
 165 def register():
 166     """Register this traffic profile to T-rex.
 167
 168     Do not change this function.
 169
 170     :returns: Traffic streams.
 171     :rtype: Object
 172     """
 173     return TrafficStreams()