GPL/traffic_profiles/trex/trex-stl-3n-dot1qip4-vlan1kip4src254ip4dst254.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:                    1 - 1000
  30    - Source IP address range:       10.0.0.1 - 10.0.0.254
  31    - Destination IP address range:  20.0.0.1 - 20.0.0.254
  32  - Direction 1 --> 0:
  33    - VLAN range:                    1 - 1000
  34    - Source IP address range:       20.0.0.1 - 20.0.0.254
  35    - Destination IP address range:  10.0.0.1 - 10.0.0.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.vlans = 1000
  52
  53         self.p1_vlan_start = 1
  54         self.p1_vlan_end = self.p1_vlan_start + self.vlans - 1
  55
  56         self.p2_vlan_start = 1
  57         self.p2_vlan_end = self.p2_vlan_start + self.vlans - 1
  58
  59         # IPs used in packet headers.
  60         self.p1_src_start_ip = u"10.0.0.1"
  61         self.p1_src_end_ip = u"10.0.0.254"
  62
  63         self.p1_dst_start_ip = u"20.0.0.1"
  64         self.p1_dst_end_ip = u"20.0.0.254"
  65
  66         self.p2_src_start_ip = u"20.0.0.1"
  67         self.p2_src_end_ip = u"20.0.0.254"
  68
  69         self.p2_dst_start_ip = u"10.0.0.1"
  70         self.p2_dst_end_ip = u"10.0.0.254"
  71
  72     def define_packets(self):
  73         """Defines the packets to be sent from the traffic generator.
  74
  75         Packet definition: | ETH | DOT1Q | IP |
  76
  77         :returns: Packets to be sent from the traffic generator.
  78         :rtype: tuple
  79         """
  80
  81         # Direction 0 --> 1
  82         base_pkt_a = (
  83             Ether() /
  84             Dot1Q(
  85                 vlan=self.p1_vlan_start
  86             ) /
  87             IP(
  88                 src=self.p1_src_start_ip,
  89                 dst=self.p1_dst_start_ip,
  90                 proto=61
  91             )
  92         )
  93         # Direction 1 --> 0
  94         base_pkt_b = (
  95             Ether() /
  96             Dot1Q(
  97                 vlan=self.p2_vlan_start
  98             ) /
  99             IP(
 100                 src=self.p2_src_start_ip,
 101                 dst=self.p2_dst_start_ip,
 102                 proto=61
 103             )
 104         )
 105
 106         # Direction 0 --> 1
 107         vm1 = STLScVmRaw(
 108             [
 109                 STLVmFlowVar(
 110                     name=u"vlan",
 111                     min_value=self.p1_vlan_start,
 112                     max_value=self.p1_vlan_end,
 113                     size=2,
 114                     op=u"inc"
 115                 ),
 116                 STLVmWrFlowVar(
 117                     fv_name=u"vlan",
 118                     pkt_offset=u"Dot1Q.vlan"
 119                 ),
 120                 STLVmFlowVar(
 121                     name=u"ip_src",
 122                     min_value=self.p1_src_start_ip,
 123                     max_value=self.p1_src_end_ip,
 124                     size=4,
 125                     op=u"random"
 126                 ),
 127                 STLVmWrFlowVar(
 128                     fv_name=u"ip_src",
 129                     pkt_offset=u"IP.src"
 130                 ),
 131                 STLVmFlowVar(
 132                     name=u"ip_dst",
 133                     min_value=self.p1_dst_start_ip,
 134                     max_value=self.p1_dst_end_ip,
 135                     size=4,
 136                     op=u"random"
 137                 ),
 138                 STLVmWrFlowVar(
 139                     fv_name=u"ip_dst",
 140                     pkt_offset=u"IP.dst"
 141                 ),
 142                 STLVmFixIpv4(
 143                     offset=u"IP"
 144                 )
 145             ]
 146         )
 147         # Direction 1 --> 0
 148         vm2 = STLScVmRaw(
 149             [
 150                 STLVmFlowVar(
 151                     name=u"vlan",
 152                     min_value=self.p2_vlan_start,
 153                     max_value=self.p2_vlan_end,
 154                     size=2,
 155                     op=u"inc"
 156                 ),
 157                 STLVmWrFlowVar(
 158                     fv_name=u"vlan",
 159                     pkt_offset=u"Dot1Q.vlan"
 160                 ),
 161                 STLVmFlowVar(
 162                     name=u"ip_src",
 163                     min_value=self.p2_src_start_ip,
 164                     max_value=self.p2_src_end_ip,
 165                     size=4,
 166                     op=u"random"
 167                 ),
 168                 STLVmWrFlowVar(
 169                     fv_name=u"ip_src",
 170                     pkt_offset=u"IP.src"
 171                 ),
 172                 STLVmFlowVar(
 173                     name=u"ip_dst",
 174                     min_value=self.p2_dst_start_ip,
 175                     max_value=self.p2_dst_end_ip,
 176                     size=4,
 177                     op=u"random"
 178                 ),
 179                 STLVmWrFlowVar(
 180                     fv_name=u"ip_dst",
 181                     pkt_offset=u"IP.dst"
 182                 ),
 183                 STLVmFixIpv4(
 184                     offset=u"IP"
 185                 )
 186             ]
 187         )
 188
 189         return base_pkt_a, base_pkt_b, vm1, vm2
 190
 191
 192 def register():
 193     """Register this traffic profile to T-rex.
 194
 195     Do not change this function.
 196
 197     :returns: Traffic streams.
 198     :rtype: Object
 199     """
 200     return TrafficStreams()