aboutsummaryrefslogtreecommitdiffstats
path: root/GPL/traffic_profiles/trex
diff options
context:
space:
mode:
authorJan Gelety <jgelety@cisco.com>2020-05-07 04:37:19 +0200
committerJan Gelety <jgelety@cisco.com>2020-07-23 21:59:13 +0200
commit38ba3408ef77161b61cd4be702d0c6e8fc36f8e5 (patch)
treece5ef9ae9e7c9b6d4498bc719ae33b04701aee81 /GPL/traffic_profiles/trex
parenta40195bdda6ec06af8479cfe7d3b3e11d4c9778f (diff)
T-Rex: Add advanced stateful mode
- provide base routines to run T-Rex in advanced stateful mode Change-Id: Ib0dc5f2919c370753335f6446860683dc4b12d93 Signed-off-by: Jan Gelety <jgelety@cisco.com>
Diffstat (limited to 'GPL/traffic_profiles/trex')
-rw-r--r--GPL/traffic_profiles/trex/profile_trex_astf_base_class.py129
-rw-r--r--GPL/traffic_profiles/trex/trex-astf-ethip4udp-1024h.py117
2 files changed, 246 insertions, 0 deletions
diff --git a/GPL/traffic_profiles/trex/profile_trex_astf_base_class.py b/GPL/traffic_profiles/trex/profile_trex_astf_base_class.py
new file mode 100644
index 0000000000..ed28ccbb78
--- /dev/null
+++ b/GPL/traffic_profiles/trex/profile_trex_astf_base_class.py
@@ -0,0 +1,129 @@
+# Copyright (c) 2020 Cisco and/or its affiliates.
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at:
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+"""Base class for profiles for T-rex advanced stateful (astf) traffic generator.
+"""
+
+from random import choices
+from string import ascii_letters
+
+from trex.astf.api import *
+
+
+class TrafficProfileBaseClass:
+ """Base class for profiles for T-rex astf traffic generator."""
+
+ STREAM_TABLE = {
+ u"IMIX_v4": [
+ {u"size": 60, u"pps": 28, u"isg": 0},
+ {u"size": 590, u"pps": 20, u"isg": 0.1},
+ {u"size": 1514, u"pps": 4, u"isg": 0.2}
+ ],
+ 'IMIX_v4_1': [
+ {u"size": 64, u"pps": 28, u"isg": 0},
+ {u"size": 570, u"pps": 16, u"isg": 0.1},
+ {u"size": 1518, u"pps": 4, u"isg": 0.2}
+ ]
+ }
+
+ def __init__(self):
+ # Default values of required parameters; can be overwritten in
+ # "get_profile" method.
+ self.framesize = 64
+ self._pcap_dir = u""
+
+ # If needed, add your own parameters.
+
+ @property
+ def pcap_dir(self):
+ """Pcap file directory.
+
+ If needed, implement your own algorithm.
+
+ :returns: Pcap file directory.
+ :rtype: str
+ """
+ return self._pcap_dir
+
+ def _gen_padding(self, current_length, required_length=0):
+ """Generate padding.
+
+ If needed, implement your own algorithm.
+
+ :param current_length: Current length of the packet.
+ :param required_length: Required length of the packet. If set to 0 then
+ self.framesize value is used.
+ :type current_length: int
+ :type required_length: int
+ :returns: The generated padding.
+ :rtype: str
+ """
+ # TODO: Add support for IMIX frame size;
+ # use random.randrange(0, len(self.STREAM_TABLE[self.framesize])) ?
+ if not required_length:
+ required_length = self.framesize
+
+ return str(choices(ascii_letters, k=required_length - current_length))
+
+ def define_profile(self):
+ """Define profile to be used by T-Rex astf traffic generator.
+
+ This method MUST return:
+
+ return ip_gen, templates, cap_list
+
+ templates or cap_list CAN be None.
+
+ :returns: IP generator and profile templates or list of pcap files for
+ traffic generator.
+ :rtype: tuple
+ """
+ raise NotImplementedError
+
+ def create_profile(self):
+ """Create traffic profile.
+
+ Implement your own traffic profiles.
+
+ :returns: Traffic profile.
+ :rtype: trex.astf.trex_astf_profile.ASTFProfile
+ """
+ ip_gen, templates, cap_list = self.define_profile()
+
+ # In most cases you will not have to change the code below:
+
+ # profile
+ profile = ASTFProfile(
+ default_ip_gen=ip_gen,
+ templates=templates,
+ cap_list=cap_list
+ )
+
+ return profile
+
+ def get_profile(self, **kwargs):
+ """Get traffic profile created by "create_profile" method.
+
+ If needed, add your own parameters.
+
+ :param kwargs: Key-value pairs used by "create_profile" method while
+ creating the profile.
+ :returns: Traffic profile.
+ :rtype: trex.astf.trex_astf_profile.ASTFProfile
+ """
+ self.framesize = kwargs[u"framesize"]
+ self._pcap_dir = kwargs.get(
+ u"pcap_dir",u"/opt/trex-core-2.73/scripts/avl"
+ )
+
+ return self.create_profile()
diff --git a/GPL/traffic_profiles/trex/trex-astf-ethip4udp-1024h.py b/GPL/traffic_profiles/trex/trex-astf-ethip4udp-1024h.py
new file mode 100644
index 0000000000..a010fe1613
--- /dev/null
+++ b/GPL/traffic_profiles/trex/trex-astf-ethip4udp-1024h.py
@@ -0,0 +1,117 @@
+# Copyright (c) 2020 Cisco and/or its affiliates.
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at:
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+"""Traffic profile for T-rex advanced stateful (astf) traffic generator.
+
+Traffic profile:
+ - Two streams sent in directions 0 --> 1 (client -> server, requests) and
+ 1 --> 0 (server -> client, responses) at the same time.
+ - Packet: ETH / IP / UDP
+ - Direction 0 --> 1:
+ - Source IP address range: 192.168.0.0 - 192.168.3.255
+ - Destination IP address range: 20.0.0.0 - 20.0.3.255
+ - Direction 1 --> 0:
+ - Source IP address range: destination IP address from packet received
+ on port 1
+ - Destination IP address range: source IP address from packet received
+ on port 1
+"""
+
+from trex.astf.api import *
+
+from profile_trex_astf_base_class import TrafficProfileBaseClass
+
+
+class TrafficProfile(TrafficProfileBaseClass):
+ """Traffic profile."""
+
+ def __init__(self):
+ """Initialization and setting of profile parameters."""
+
+ super(TrafficProfileBaseClass, self).__init__()
+
+ # IPs used in packet headers.
+ self.p1_src_start_ip = u"192.168.0.0"
+ self.p1_src_end_ip = u"192.168.3.255"
+ self.p1_dst_start_ip = u"20.0.0.0"
+ self.p1_dst_end_ip = u"20.0.3.255"
+
+ # UDP messages
+ self.udp_req = u"GET"
+ self.udp_res = u"ACK"
+
+ # Headers length
+ self.headers_size = 42 # 14B l2 + 20B ipv4 + 8B udp
+
+ def define_profile(self):
+ """Define profile to be used by advanced stateful traffic generator.
+
+ This method MUST return:
+ return ip_gen, templates, None
+
+ :returns: IP generator and profile templates ASTFProfile().
+ :rtype: tuple
+ """
+ self.udp_req += self._gen_padding(self.headers_size + len(self.udp_req))
+ self.udp_res += self._gen_padding(self.headers_size + len(self.udp_res))
+
+ # client commands
+ prog_c = ASTFProgram(stream=False)
+ prog_c.send_msg(self.udp_req) # size and fill not supported in v2.73
+ prog_c.recv_msg(1)
+
+ # server commands
+ prog_s = ASTFProgram(stream=False)
+ prog_s.recv_msg(1)
+ prog_s.send_msg(self.udp_res)
+
+ # ip generators
+ ip_gen_c = ASTFIPGenDist(
+ ip_range=[self.p1_src_start_ip, self.p1_src_end_ip],
+ distribution=u"seq"
+ )
+ ip_gen_s = ASTFIPGenDist(
+ ip_range=[self.p1_dst_start_ip, self.p1_dst_end_ip],
+ distribution=u"seq"
+ )
+ ip_gen = ASTFIPGen(
+ glob=ASTFIPGenGlobal(ip_offset=u"0.0.0.1"),
+ dist_client=ip_gen_c,
+ dist_server=ip_gen_s
+ )
+
+ # server association
+ s_assoc = ASTFAssociation(rules=ASTFAssociationRule(port=8080))
+
+ # template
+ temp_c = ASTFTCPClientTemplate(
+ program=prog_c,
+ ip_gen=ip_gen,
+ limit=64512, # TODO: set via input parameter ?
+ port=8080
+ )
+ temp_s = ASTFTCPServerTemplate(program=prog_s, assoc=s_assoc)
+ template = ASTFTemplate(client_template=temp_c, server_template=temp_s)
+
+ return ip_gen, template, None
+
+
+def register():
+ """Register this traffic profile to T-Rex.
+
+ Do not change this function.
+
+ :return: Traffic Profiles.
+ :rtype: Object
+ """
+ return TrafficProfile()