Merge "trex: Support of SCAPY frame definition"

3 files changed, 116 insertions, 0 deletions

diff --git a/docs/testing/developer/devguide/design/trafficgen_integration_guide.rst b/docs/testing/developer/devguide/design/trafficgen_integration_guide.rst
index c88b80ed..a7a29d0e 100644
--- a/docs/testing/developer/devguide/design/trafficgen_integration_guide.rst
+++ b/docs/testing/developer/devguide/design/trafficgen_integration_guide.rst
@@ -199,6 +199,9 @@ functions:
       Note: There are parameters specific to testing of tunnelling protocols,
       which are discussed in detail at :ref:`integration-tests` userguide.
 
+      Note: A detailed description of the ``TRAFFIC`` dictionary can be found at
+      :ref:`configuration-of-traffic-dictionary`.
+
       * param **traffic_type**: One of the supported traffic types,
         e.g. **rfc2544_throughput**, **rfc2544_continuous**
         or **rfc2544_back2back**.
@@ -224,6 +227,8 @@ functions:
         **dstport** and l4 on/off switch **enabled**.
       * param **vlan**: A dictionary with vlan specific parameters,
         e.g. **priority**, **cfi**, **id** and vlan on/off switch **enabled**.
+      * param **scapy**: A dictionary with definition of the frame content for both traffic
+        directions. The frame content is defined by a SCAPY notation.
 
     * param **tests**: Number of times the test is executed.
     * param **duration**: Duration of continuous test or per iteration duration
diff --git a/docs/testing/developer/devguide/design/vswitchperf_design.rst b/docs/testing/developer/devguide/design/vswitchperf_design.rst
index 96ffcf62..de236ee2 100644
--- a/docs/testing/developer/devguide/design/vswitchperf_design.rst
+++ b/docs/testing/developer/devguide/design/vswitchperf_design.rst
@@ -439,6 +439,34 @@ Detailed description of ``TRAFFIC`` dictionary items follows:
                       details.
                       Data type: str
                       Default value: ''
+        'scapy'     - A dictionary with definition of a frame content for both traffic
+                      directions. The frame content is defined by a SCAPY notation.
+                      NOTE: It is supported only by the T-Rex traffic generator.
+                      Following keywords can be used to refer to the related parts of
+                      the TRAFFIC dictionary:
+                           Ether_src   - refers to TRAFFIC['l2']['srcmac']
+                           Ether_dst   - refers to TRAFFIC['l2']['dstmac']
+                           IP_proto    - refers to TRAFFIC['l3']['proto']
+                           IP_PROTO    - refers to upper case version of TRAFFIC['l3']['proto']
+                           IP_src      - refers to TRAFFIC['l3']['srcip']
+                           IP_dst      - refers to TRAFFIC['l3']['dstip']
+                           IP_PROTO_sport - refers to TRAFFIC['l4']['srcport']
+                           IP_PROTO_dport - refers to TRAFFIC['l4']['dstport']
+                           Dot1Q_prio  - refers to TRAFFIC['vlan']['priority']
+                           Dot1Q_id    - refers to TRAFFIC['vlan']['cfi']
+                           Dot1Q_vlan  - refers to TRAFFIC['vlan']['id']
+            '0'     - A string with the frame definition for the 1st direction.
+                      Data type: str
+                      Default value: 'Ether(src={Ether_src}, dst={Ether_dst})/'
+                                     'Dot1Q(prio={Dot1Q_prio}, id={Dot1Q_id}, vlan={Dot1Q_vlan})/'
+                                     'IP(proto={IP_proto}, src={IP_src}, dst={IP_dst})/'
+                                     '{IP_PROTO}(sport={IP_PROTO_sport}, dport={IP_PROTO_dport})'
+            '1'     - A string with the frame definition for the 2nd direction.
+                      Data type: str
+                      Default value: 'Ether(src={Ether_dst}, dst={Ether_src})/'
+                                     'Dot1Q(prio={Dot1Q_prio}, id={Dot1Q_id}, vlan={Dot1Q_vlan})/'
+                                     'IP(proto={IP_proto}, src={IP_dst}, dst={IP_src})/'
+                                     '{IP_PROTO}(sport={IP_PROTO_dport}, dport={IP_PROTO_sport})',
 
 .. _configuration-of-guest-options:
 
diff --git a/docs/testing/user/configguide/trafficgen.rst b/docs/testing/user/configguide/trafficgen.rst
index 52b1b4a5..c1df27dc 100644
--- a/docs/testing/user/configguide/trafficgen.rst
+++ b/docs/testing/user/configguide/trafficgen.rst
@@ -75,8 +75,22 @@ and is configured as follows:
             'count': 1,
             'filter': '',
         },
+        'scapy': {
+            'enabled': False,
+            '0' : 'Ether(src={Ether_src}, dst={Ether_dst})/'
+                  'Dot1Q(prio={Dot1Q_prio}, id={Dot1Q_id}, vlan={Dot1Q_vlan})/'
+                  'IP(proto={IP_proto}, src={IP_src}, dst={IP_dst})/'
+                  '{IP_PROTO}(sport={IP_PROTO_sport}, dport={IP_PROTO_dport})',
+            '1' : 'Ether(src={Ether_dst}, dst={Ether_src})/'
+                  'Dot1Q(prio={Dot1Q_prio}, id={Dot1Q_id}, vlan={Dot1Q_vlan})/'
+                  'IP(proto={IP_proto}, src={IP_dst}, dst={IP_src})/'
+                  '{IP_PROTO}(sport={IP_PROTO_dport}, dport={IP_PROTO_sport})',
+        }
     }
 
+A detailed description of the ``TRAFFIC`` dictionary can be found at
+:ref:`configuration-of-traffic-dictionary`.
+
 The framesize parameter can be overridden from the configuration
 files by adding the following to your custom configuration file
 ``10_custom.conf``:
@@ -907,3 +921,72 @@ The duration and maximum number of attempted verification trials can be set to c
 behavior of this step. If the verification step fails, it will resume the binary search
 with new values where the maximum output will be the last attempted frame rate minus the
 current set thresh hold.
+
+Scapy frame definition
+~~~~~~~~~~~~~~~~~~~~~~
+
+It is possible to use a SCAPY frame definition to generate various network protocols
+by the **T-Rex** traffic generator. In case that particular network protocol layer
+is disabled by the TRAFFIC dictionary (e.g. TRAFFIC['vlan']['enabled'] = False),
+then disabled layer will be removed from the scapy format definition by VSPERF.
+
+The scapy frame definition can refer to values defined by the TRAFFIC dictionary
+by following keywords. These keywords are used in next examples.
+
+* ``Ether_src`` - refers to ``TRAFFIC['l2']['srcmac']``
+* ``Ether_dst`` - refers to ``TRAFFIC['l2']['dstmac']``
+* ``IP_proto`` - refers to ``TRAFFIC['l3']['proto']``
+* ``IP_PROTO`` - refers to upper case version of ``TRAFFIC['l3']['proto']``
+* ``IP_src`` - refers to ``TRAFFIC['l3']['srcip']``
+* ``IP_dst`` - refers to ``TRAFFIC['l3']['dstip']``
+* ``IP_PROTO_sport`` - refers to ``TRAFFIC['l4']['srcport']``
+* ``IP_PROTO_dport`` - refers to ``TRAFFIC['l4']['dstport']``
+* ``Dot1Q_prio`` - refers to ``TRAFFIC['vlan']['priority']``
+* ``Dot1Q_id`` - refers to ``TRAFFIC['vlan']['cfi']``
+* ``Dot1Q_vlan`` - refers to ``TRAFFIC['vlan']['id']``
+
+In following examples of SCAPY frame definition only relevant parts of TRAFFIC
+dictionary are shown. The rest of the TRAFFIC dictionary is set to default values
+as they are defined in ``conf/03_traffic.conf``.
+
+Please check official documentation of SCAPY project for details about SCAPY frame
+definition and supported network layers at: http://www.secdev.org/projects/scapy
+
+#. Generate ICMP frames:
+
+   .. code-block:: console
+
+        'scapy': {
+            'enabled': True,
+            '0' : 'Ether(src={Ether_src}, dst={Ether_dst})/IP(proto={IP_proto}, src={IP_src}, dst={IP_dst})/ICMP()',
+            '1' : 'Ether(src={Ether_dst}, dst={Ether_src})/IP(proto={IP_proto}, src={IP_dst}, dst={IP_src})/ICMP()',
+        }
+
+#. Generate IPv6 ICMP Echo Request
+
+   .. code-block:: console
+
+        'l3' : {
+            'srcip': 'feed::01',
+            'dstip': 'feed::02',
+        },
+        'scapy': {
+            'enabled': True,
+            '0' : 'Ether(src={Ether_src}, dst={Ether_dst})/IPv6(src={IP_src}, dst={IP_dst})/ICMPv6EchoRequest()',
+            '1' : 'Ether(src={Ether_dst}, dst={Ether_src})/IPv6(src={IP_dst}, dst={IP_src})/ICMPv6EchoRequest()',
+        }
+
+#. Generate SCTP frames:
+
+   Example uses default SCAPY frame definition, which can reflect ``TRAFFIC['l3']['proto']`` settings. The same
+   approach can be used to generate other protocols, e.g. TCP.
+
+   .. code-block:: console
+
+        'l3' : {
+            'proto' : 'sctp',
+        },
+        'scapy': {
+            'enabled': True,
+        }
+