trex: Support of SCAPY frame definition

T-Rex implementation in vsperf was improved to support:

* SCAPY frame definition, so additional network protocols
  can be generated by T-Rex and sent towards DUT
* VLAN configuration defined by TRAFFIC['vlan']
* enable or disable L2, L3, L4 and VLAN protocols
  as configured by TRAFFIC dictionary

VSPERF documentation was updated with examples of SCAPY
frame definition usage.

JIRA: VSPERF-565

Change-Id: Iff9baba47a1e83d321f6ba3c1c482965b9882241
Signed-off-by: Martin Klozik <martinx.klozik@intel.com>
Reviewed-by: Al Morton <acmorton@att.com>
Reviewed-by: Christian Trautman <ctrautma@redhat.com>
Reviewed-by: Sridhar Rao <sridhar.rao@spirent.com>
Reviewed-by: Trevor Cooper <trevor.cooper@intel.com>
Reviewed-by: Richard Elias <richardx.elias@intel.com>

2 files changed, 33 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: