GPL/traffic_profiles/trex/trex-astf-ethip4tcp-16384h.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 """Traffic profile for T-rex advanced stateful (astf) traffic generator.
  24
  25 Traffic profile:
  26  - Two streams sent in directions 0 --> 1 (client -> server, requests) and
  27    1 --> 0 (server -> client, responses) at the same time.
  28  - Packet: ETH / IP / TCP
  29  - Direction 0 --> 1:
  30    - Source IP address range:      192.168.0.0 - 192.168.63.255
  31    - Destination IP address range: 20.0.0.0 - 20.0.63.255
  32  - Direction 1 --> 0:
  33    - Source IP address range:      destination IP address from packet received
  34      on port 1
  35    - Destination IP address range: source IP address from packet received
  36      on port 1
  37
  38 This is a profile for CPS tests, it only sets up and tears down TCP session.
  39 No delays, no data transfer.
  40 """
  41
  42 from trex.astf.api import *
  43 from profile_trex_astf_base_class import TrafficProfileBaseClass
  44
  45
  46 class TrafficProfile(TrafficProfileBaseClass):
  47     """Traffic profile."""
  48
  49     def __init__(self):
  50         """Initialization and setting of profile parameters."""
  51
  52         super(TrafficProfileBaseClass, self).__init__()
  53
  54         # IPs used in packet headers.
  55         self.p1_src_start_ip = u"192.168.0.0"
  56         self.p1_src_end_ip = u"192.168.63.255"
  57         self.p1_dst_start_ip = u"20.0.0.0"
  58         self.p1_dst_end_ip = u"20.0.63.255"
  59
  60         # Headers length; not used in this profile, just for the record of
  61         # header length for TCP packet with 0B payload
  62         self.headers_size = 58  # 14B l2 + 20B ipv4 + 24B tcp incl. 4B options
  63
  64     def define_profile(self):
  65         """Define profile to be used by advanced stateful traffic generator.
  66
  67         This method MUST return:
  68
  69             return ip_gen, templates, None
  70
  71         :returns: IP generator and profile templates for ASTFProfile().
  72         :rtype: tuple
  73         """
  74         # client commands
  75         prog_c = ASTFProgram()
  76         # send syn
  77         prog_c.connect()
  78         # receive syn-ack (0B sent in tcp syn-ack packet) and send ack
  79         prog_c.recv(0)
  80
  81         # server commands
  82         prog_s = ASTFProgram()
  83         # receive syn, send syn-ack
  84         prog_s.accept()
  85         # receive fin-ack, send ack + fin-ack
  86         prog_s.wait_for_peer_close()
  87
  88         # ip generators
  89         ip_gen_c = ASTFIPGenDist(
  90             ip_range=[self.p1_src_start_ip, self.p1_src_end_ip],
  91             distribution=u"seq"
  92         )
  93         ip_gen_s = ASTFIPGenDist(
  94             ip_range=[self.p1_dst_start_ip, self.p1_dst_end_ip],
  95             distribution=u"seq"
  96         )
  97         ip_gen = ASTFIPGen(
  98             glob=ASTFIPGenGlobal(ip_offset=u"0.0.0.1"),
  99             dist_client=ip_gen_c,
 100             dist_server=ip_gen_s
 101         )
 102
 103         # server association
 104         s_assoc = ASTFAssociation(rules=ASTFAssociationRule(port=8080))
 105
 106         # template
 107         temp_c = ASTFTCPClientTemplate(
 108             program=prog_c,
 109             ip_gen=ip_gen,
 110             limit=1032192,  # TODO: set via input parameter
 111             port=8080
 112         )
 113         temp_s = ASTFTCPServerTemplate(program=prog_s, assoc=s_assoc)
 114         template = ASTFTemplate(client_template=temp_c, server_template=temp_s)
 115
 116         return ip_gen, template, None
 117
 118
 119 def register():
 120     """Register this traffic profile to T-Rex.
 121
 122     Do not change this function.
 123
 124     :return: Traffic Profiles.
 125     :rtype: Object
 126     """
 127     return TrafficProfile()