GPL/traffic_profiles/trex/trex-stl-2n3n-ethip4-ip4src254-4c2n.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 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         # Service density parameters.
  51         self.nf_chains = 4
  52         self.nf_nodes = 2
  53
  54         # MACs used in packet headers.
  55         self.p1_dst_start_mac = u"52:54:00:00:00:01"
  56         self.p2_dst_start_mac = u"52:54:00:00:00:02"
  57
  58         # IPs used in packet headers.
  59         self.p1_src_start_ip = u"10.10.10.1"
  60         self.p1_src_end_ip = u"10.10.10.254"
  61         self.p1_dst_start_ip = u"20.20.20.1"
  62
  63         self.p2_src_start_ip = u"20.20.20.1"
  64         self.p2_src_end_ip = u"20.20.20.254"
  65         self.p2_dst_start_ip = u"10.10.10.1"
  66
  67     def define_packets(self):
  68         """Defines the packets to be sent from the traffic generator.
  69
  70         Packet definition: | ETH | 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                 dst=self.p1_dst_start_mac
  80             ) /
  81             IP(
  82                 src=self.p1_src_start_ip,
  83                 dst=self.p1_dst_start_ip,
  84                 proto=61
  85             )
  86         )
  87         # Direction 1 --> 0
  88         base_pkt_b = (
  89             Ether(
  90                 dst=self.p2_dst_start_mac
  91             ) /
  92             IP(
  93                 src=self.p2_src_start_ip,
  94                 dst=self.p2_dst_start_ip,
  95                 proto=61
  96             )
  97         )
  98
  99         # Direction 0 --> 1
 100         vm1 = STLScVmRaw(
 101             [
 102                 STLVmFlowVar(
 103                     name=u"mac_dst",
 104                     min_value=1,
 105                     max_value=self.nf_chains*self.nf_nodes,
 106                     size=1, step=self.nf_nodes,
 107                     op=u"inc"
 108                 ),
 109                 STLVmWrFlowVar(
 110                     fv_name=u"mac_dst",
 111                     pkt_offset=4),
 112                 STLVmFlowVar(
 113                     name=u"src",
 114                     min_value=self.p1_src_start_ip,
 115                     max_value=self.p1_src_end_ip,
 116                     size=4,
 117                     op=u"inc"
 118                 ),
 119                 STLVmWrFlowVar(
 120                     fv_name=u"src",
 121                     pkt_offset=u"IP.src"
 122                 ),
 123                 STLVmFixIpv4(
 124                     offset=u"IP"
 125                 )
 126             ]
 127         )
 128         # Direction 1 --> 0
 129         vm2 = STLScVmRaw(
 130             [
 131                 STLVmFlowVar(
 132                     name=u"mac_dst",
 133                     min_value=self.nf_nodes,
 134                     max_value=self.nf_chains*self.nf_nodes,
 135                     size=1,
 136                     step=self.nf_nodes,
 137                     op=u"inc"
 138                 ),
 139                 STLVmWrFlowVar(
 140                     fv_name=u"mac_dst",
 141                     pkt_offset=4
 142                 ),
 143                 STLVmFlowVar(
 144                     name=u"src",
 145                     min_value=self.p2_src_start_ip,
 146                     max_value=self.p2_src_end_ip,
 147                     size=4,
 148                     op=u"inc"
 149                 ),
 150                 STLVmWrFlowVar(
 151                     fv_name=u"src",
 152                     pkt_offset=u"IP.src"
 153                 ),
 154                 STLVmFixIpv4(
 155                     offset=u"IP"
 156                 )
 157             ]
 158         )
 159
 160         return base_pkt_a, base_pkt_b, vm1, vm2
 161
 162
 163 def register():
 164     """Register this traffic profile to T-rex.
 165
 166     Do not change this function.
 167
 168     :return: Traffic streams.
 169     :rtype: Object
 170     """
 171     return TrafficStreams()