GPL/traffic_profiles/trex/trex-stl-2n3n-ethip4-ip4src254-4c2n.py

   1 # Copyright (c) 2020 Cisco and/or its affiliates.
   2 # Licensed under the Apache License, Version 2.0 (the "License");
   3 # you may not use this file except in compliance with the License.
   4 # You may obtain a copy of the License at:
   5 #
   6 #     http://www.apache.org/licenses/LICENSE-2.0
   7 #
   8 # Unless required by applicable law or agreed to in writing, software
   9 # distributed under the License is distributed on an "AS IS" BASIS,
  10 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  11 # See the License for the specific language governing permissions and
  12 # limitations under the License.
  13
  14 """Stream profile for T-rex traffic generator.
  15
  16 Stream profile:
  17  - Two streams sent in directions 0 --> 1 and 1 --> 0 at the same time.
  18  - Packet: ETH / IP /
  19  - Direction 0 --> 1:
  20    - Destination MAC address: 52:54:00:00:nf_id:01
  21    - Source IP address range:      10.10.10.1 - 10.10.10.254
  22    - Destination IP address range: 20.20.20.1
  23  - Direction 1 --> 0:
  24    - Destination MAC address: 52:54:00:00:nf_id:02
  25    - Source IP address range:      20.20.20.1 - 20.20.20.254
  26    - Destination IP address range: 10.10.10.1
  27 """
  28
  29 from trex.stl.api import *
  30 from profile_trex_stateless_base_class import TrafficStreamsBaseClass
  31
  32
  33 class TrafficStreams(TrafficStreamsBaseClass):
  34     """Stream profile."""
  35
  36     def __init__(self):
  37         """Initialization and setting of streams' parameters."""
  38
  39         super(TrafficStreamsBaseClass, self).__init__()
  40
  41         # Service density parameters.
  42         self.nf_chains = 4
  43         self.nf_nodes = 2
  44
  45         # MACs used in packet headers.
  46         self.p1_dst_start_mac = u"52:54:00:00:00:01"
  47         self.p2_dst_start_mac = u"52:54:00:00:00:02"
  48
  49         # IPs used in packet headers.
  50         self.p1_src_start_ip = u"10.10.10.1"
  51         self.p1_src_end_ip = u"10.10.10.254"
  52         self.p1_dst_start_ip = u"20.20.20.1"
  53
  54         self.p2_src_start_ip = u"20.20.20.1"
  55         self.p2_src_end_ip = u"20.20.20.254"
  56         self.p2_dst_start_ip = u"10.10.10.1"
  57
  58     def define_packets(self):
  59         """Defines the packets to be sent from the traffic generator.
  60
  61         Packet definition: | ETH | IP |
  62
  63         :returns: Packets to be sent from the traffic generator.
  64         :rtype: tuple
  65         """
  66
  67         # Direction 0 --> 1
  68         base_pkt_a = (
  69             Ether(
  70                 dst=self.p1_dst_start_mac
  71             ) /
  72             IP(
  73                 src=self.p1_src_start_ip,
  74                 dst=self.p1_dst_start_ip,
  75                 proto=61
  76             )
  77         )
  78         # Direction 1 --> 0
  79         base_pkt_b = (
  80             Ether(
  81                 dst=self.p2_dst_start_mac
  82             ) /
  83             IP(
  84                 src=self.p2_src_start_ip,
  85                 dst=self.p2_dst_start_ip,
  86                 proto=61
  87             )
  88         )
  89
  90         # Direction 0 --> 1
  91         vm1 = STLScVmRaw(
  92             [
  93                 STLVmFlowVar(
  94                     name=u"mac_dst",
  95                     min_value=1,
  96                     max_value=self.nf_chains*self.nf_nodes,
  97                     size=1, step=self.nf_nodes,
  98                     op=u"inc"
  99                 ),
 100                 STLVmWrFlowVar(
 101                     fv_name=u"mac_dst",
 102                     pkt_offset=4),
 103                 STLVmFlowVar(
 104                     name=u"src",
 105                     min_value=self.p1_src_start_ip,
 106                     max_value=self.p1_src_end_ip,
 107                     size=4,
 108                     op=u"inc"
 109                 ),
 110                 STLVmWrFlowVar(
 111                     fv_name=u"src",
 112                     pkt_offset=u"IP.src"
 113                 ),
 114                 STLVmFixIpv4(
 115                     offset=u"IP"
 116                 )
 117             ]
 118         )
 119         # Direction 1 --> 0
 120         vm2 = STLScVmRaw(
 121             [
 122                 STLVmFlowVar(
 123                     name=u"mac_dst",
 124                     min_value=self.nf_nodes,
 125                     max_value=self.nf_chains*self.nf_nodes,
 126                     size=1,
 127                     step=self.nf_nodes,
 128                     op=u"inc"
 129                 ),
 130                 STLVmWrFlowVar(
 131                     fv_name=u"mac_dst",
 132                     pkt_offset=4
 133                 ),
 134                 STLVmFlowVar(
 135                     name=u"src",
 136                     min_value=self.p2_src_start_ip,
 137                     max_value=self.p2_src_end_ip,
 138                     size=4,
 139                     op=u"inc"
 140                 ),
 141                 STLVmWrFlowVar(
 142                     fv_name=u"src",
 143                     pkt_offset=u"IP.src"
 144                 ),
 145                 STLVmFixIpv4(
 146                     offset=u"IP"
 147                 )
 148             ]
 149         )
 150
 151         return base_pkt_a, base_pkt_b, vm1, vm2
 152
 153
 154 def register():
 155     """Register this traffic profile to T-rex.
 156
 157     Do not change this function.
 158
 159     :return: Traffic streams.
 160     :rtype: Object
 161     """
 162     return TrafficStreams()