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