GPL/traffic_profiles/trex/trex-stl-2n-ethip4-macsrc50kdst50k.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    - Source MAC address range:      ca:fe:00:00:00:00 - ca:fe:00:00:c3:4f
  31    - Destination MAC address range: fa:ce:00:00:00:00 - fa:ce:00:00:c3:4f
  32    - Source IP address range:       10.0.0.0 - 10.0.195.79
  33    - Destination IP address range:  20.0.0.0 - 20.0.195.79
  34  - Direction 1 --> 0:
  35    - Source MAC address range:      fa:ce:00:00:00:00 - fa:ce:00:00:c3:4f
  36    - Destination MAC address range: ca:fe:00:00:00:00 - ca:fe:00:00:c3:4f
  37    - Source IP address range:       20.0.0.0 - 20.0.195.79
  38    - Destination IP address range:  10.0.0.0 - 10.0.195.79
  39 """
  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         self.clients = 50000
  54
  55         # MACs used in packet headers.
  56         self.p1_src_start_mac = u"ca:fe:00:00:00:00" # mask: 00:00:FF:FF:FF:FF
  57         self.p1_dst_start_mac = u"fa:ce:00:00:00:00" # mask: 00:00:FF:FF:FF:FF
  58
  59         self.p2_src_start_mac = u"fa:ce:00:00:00:00" # mask: 00:00:FF:FF:FF:FF
  60         self.p2_dst_start_mac = u"ca:fe:00:00:00:00" # mask: 00:00:FF:FF:FF:FF
  61
  62         # IPs used in packet headers.
  63         self.p1_src_start_ip = u"10.0.0.0"
  64         self.p1_src_end_ip = u"10.0.195.79"
  65
  66         self.p1_dst_start_ip = u"20.0.0.0"
  67         self.p1_dst_end_ip = u"20.0.195.79"
  68
  69         self.p2_src_start_ip = u"20.0.0.0"
  70         self.p2_src_end_ip = u"20.0.195.79"
  71
  72         self.p2_dst_start_ip = u"10.0.0.0"
  73         self.p2_dst_end_ip = u"10.0.195.79"
  74
  75     def define_packets(self):
  76         """Defines the packets to be sent from the traffic generator.
  77
  78         Packet definition: | ETH | IP |
  79
  80         :returns: Packets to be sent from the traffic generator.
  81         :rtype: tuple
  82         """
  83
  84         # Direction 0 --> 1
  85         base_pkt_a = (
  86             Ether(
  87                 src=self.p1_src_start_mac,
  88                 dst=self.p1_dst_start_mac
  89             ) /
  90             IP(
  91                 src=self.p1_src_start_ip,
  92                 dst=self.p1_dst_start_ip,
  93                 proto=61
  94             )
  95         )
  96         # Direction 1 --> 0
  97         base_pkt_b = (
  98             Ether(
  99                 src=self.p2_src_start_mac,
 100                 dst=self.p2_dst_start_mac) /
 101             IP(
 102                 src=self.p2_src_start_ip,
 103                 dst=self.p2_dst_start_ip,
 104                 proto=61
 105             )
 106         )
 107
 108         # Direction 0 --> 1
 109         vm1 = STLScVmRaw(
 110             [
 111                 STLVmFlowVar(
 112                     name=u"mac_src",
 113                     min_value=0,
 114                     max_value=self.clients-1,
 115                     size=4,
 116                     op=u"inc"
 117                 ),
 118                 STLVmFlowVar(
 119                     name=u"mac_dst",
 120                     min_value=0,
 121                     max_value=self.clients-1,
 122                     size=4,
 123                     op=u"inc"
 124                 ),
 125                 STLVmWrFlowVar(
 126                     fv_name=u"mac_src",
 127                     pkt_offset= 8
 128                 ),
 129                 STLVmWrFlowVar(
 130                     fv_name=u"mac_dst",
 131                     pkt_offset= 2
 132                 ),
 133                 STLVmFlowVar(
 134                     name=u"ip_src",
 135                     min_value=self.p1_src_start_ip,
 136                     max_value=self.p1_src_end_ip,
 137                     size=4,
 138                     op=u"inc"
 139                 ),
 140                 STLVmWrFlowVar(
 141                     fv_name=u"ip_src",
 142                     pkt_offset=u"IP.src"
 143                 ),
 144                 STLVmFlowVar(
 145                     name=u"ip_dst",
 146                     min_value=self.p1_dst_start_ip,
 147                     max_value=self.p1_dst_end_ip,
 148                     size=4,
 149                     op=u"inc"
 150                 ),
 151                 STLVmWrFlowVar(
 152                     fv_name=u"ip_dst",
 153                     pkt_offset=u"IP.dst"
 154                 ),
 155                 STLVmFixIpv4(
 156                     offset=u"IP"
 157                 )
 158             ]
 159         )
 160         # Direction 1 --> 0
 161         vm2 = STLScVmRaw(
 162             [
 163                 STLVmFlowVar(
 164                     name=u"mac_src",
 165                     min_value=0,
 166                     max_value=self.clients-1,
 167                     size=4,
 168                     op=u"inc"
 169                 ),
 170                 STLVmFlowVar(
 171                     name=u"mac_dst",
 172                     min_value=0,
 173                     max_value=self.clients-1,
 174                     size=4,
 175                     op=u"inc"
 176                 ),
 177                 STLVmWrFlowVar(
 178                     fv_name=u"mac_src",
 179                     pkt_offset= 8
 180                 ),
 181                 STLVmWrFlowVar(
 182                     fv_name=u"mac_dst",
 183                     pkt_offset= 2
 184                 ),
 185                 STLVmFlowVar(
 186                     name=u"ip_src",
 187                     min_value=self.p2_src_start_ip,
 188                     max_value=self.p2_src_end_ip,
 189                     size=4,
 190                     op=u"inc"
 191                 ),
 192                 STLVmWrFlowVar(
 193                     fv_name=u"ip_src",
 194                     pkt_offset=u"IP.src"
 195                 ),
 196                 STLVmFlowVar(
 197                     name=u"ip_dst",
 198                     min_value=self.p2_dst_start_ip,
 199                     max_value=self.p2_dst_end_ip,
 200                     size=4,
 201                     op=u"inc"
 202                 ),
 203                 STLVmWrFlowVar(
 204                     fv_name=u"ip_dst",
 205                     pkt_offset=u"IP.dst"
 206                 ),
 207                 STLVmFixIpv4(
 208                     offset=u"IP"
 209                 )
 210             ]
 211         )
 212
 213         return base_pkt_a, base_pkt_b, vm1, vm2
 214
 215
 216 def register():
 217     """Register this traffic profile to T-rex.
 218
 219     Do not change this function.
 220
 221     :return: Traffic streams.
 222     :rtype: Object
 223     """
 224     return TrafficStreams()