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