CSIT-1359: Add 3n-skx and 2n-skx comparisons to Report
[csit.git] / docs / tag_documentation.rst
index 0fac68b..33d38cf 100644 (file)
@@ -9,6 +9,16 @@ documentation.
 Topology TAGs
 -------------
 
+.. topic:: 2_NODE_DOUBLE_LINK_TOPO
+
+    2 nodes connected in a circular topology with two links interconnecting
+    the devices.
+
+.. topic:: 2_NODE_SINGLE_LINK_TOPO
+
+    2 nodes connected in a circular topology with at least one link
+    interconnecting devices.
+
 .. topic:: 3_NODE_DOUBLE_LINK_TOPO
 
     3 nodes connected in a circular topology with two links interconnecting
@@ -61,6 +71,10 @@ NIC model tags
 
     Intel X710 NIC.
 
+.. topic:: NIC_Intel-XXV710
+
+    Intel XXV710 NIC.
+
 .. topic:: NIC_Cisco-VIC-1227
 
     VIC-1227 by Cisco.
@@ -84,6 +98,54 @@ Scaling TAGs
 
     2x1,000,000 entries in single fib table
 
+.. topic:: L2BD_1
+
+    Test with 1 L2 bridge domain.
+
+.. topic:: L2BD_10
+
+    Test with 10 L2 bridge domains.
+
+.. topic:: L2BD_100
+
+    Test with 100 L2 bridge domains.
+
+.. topic:: L2BD_1K
+
+    Test with 1000 L2 bridge domains.
+
+.. topic:: VLAN_1
+
+    Test with 1 VLAN sub-interface.
+
+.. topic:: VLAN_10
+
+    Test with 10 VLAN sub-interfaces.
+
+.. topic:: VLAN_100
+
+    Test with 100 VLAN sub-interfaces.
+
+.. topic:: VLAN_1K
+
+    Test with 1000 VLAN sub-interfaces.
+
+.. topic:: VXLAN_1
+
+    Test with 1 VXLAN tunnel.
+
+.. topic:: VXLAN_10
+
+    Test with 10 VXLAN tunnels.
+
+.. topic:: VXLAN_100
+
+    Test with 100 VXLAN tunnels.
+
+.. topic:: VXLAN_1K
+
+    Test with 1000 VXLAN tunnels.
+
 .. topic:: TNL_1000
 
     IPSec in tunnel mode - 1000 tunnels.
@@ -137,42 +199,17 @@ Tags marking functional vs. performance of tests
 Performance testing tags
 ------------------------
 
-.. topic:: PDRDISC
-
-    Partial Drop Rate evaluation of single run result, with non-zero packet
-    loss tolerance (LT) expressed in percentage of packets transmitted.
-
-.. topic:: NDRDISC
-
-    Non Drop Rate evaluation of results. Loss acceptance of dropped packets is
-    set to zero lost packets.
-
 .. topic:: NDRPDR
 
     Single test finding both No Drop Rate and Partial Drop Rate simultaneously.
     The search is done by optimized algorithm which performs
     multiple trial runs at different durations and transmit rates.
 
-.. topic:: NDRCHK
-
-    Performance tests where TG verifies DUTs' throughput at ref-NDR (reference
-    Non Drop Rate) with zero packet loss tolerance.
-
-.. topic:: PDRCHK
-
-    Performance tests where TG verifies DUTs' throughput at ref-PDR (reference
-    Partial Drop Rate) with 0.5% loss tolerance.
-
 .. topic:: MRR
 
     Performance tests where TG sends the traffic at maximum rate (line rate)
     and reports total sent/received packets over performance trial duration.
 
-.. topic:: NDRPDRDISC
-
-    Find performance of DUT based on :rfc:`2544` with linear / binary / combined
-    search. (Previous LONG tests.)
-
 Ethernet frame size tags for performance tests
 ----------------------------------------------
 
@@ -184,6 +221,10 @@ Ethernet frame size tags for performance tests
 
     78B frames used for test.
 
+.. topic:: 114B
+
+    114B frames used for test.
+
 .. topic:: IMIX
 
     IMIX frame sequence (28x 64B, 16x 570B, 4x 1518B) used for test.
@@ -235,6 +276,11 @@ Test type tags
     L2BD baseline test cases, no encapsulation, no feature(s) configured in
     tests.
 
+.. topic:: L2PATCH
+
+    L2PATCH baseline test cases, no encapsulation, no feature(s) configured in
+    tests.
+
 .. topic:: SCALE
 
     Scale test cases.
@@ -251,6 +297,10 @@ Test type tags
 
     Functional test cases for TLDK.
 
+.. topic:: DMM
+
+    Functional test cases for DMM.
+
 .. topic:: TCP
 
     Tests which use TCP.
@@ -435,6 +485,22 @@ Interface tags
 
     All test cases which uses link bonding with load-balance mode l34.
 
+.. topic:: LBOND_1L
+
+    All test cases which uses one link for link bonding.
+
+.. topic:: LBOND_2L
+
+    All test cases which uses two links for link bonding.
+
+.. topic:: DRV_AVF
+
+    All test cases which uses Intel Adaptive Virtual Function (AVF) device
+    plugin for VPP. This plugins provides native device support for Intel AVF.
+    AVF is driver specification for current and future Intel Virtual Function
+    devices. In essence, today this driver can be used only with Intel
+    XL710 / X710 / XXV710 adapters.
+
 Feature tags
 ------------
 
@@ -578,10 +644,12 @@ Multi-threading tags
 
 .. topic:: STHREAD
 
-    All test cases using single poll mode thread.
+   *Dynamic tag*.
+   All test cases using single poll mode thread.
 
 .. topic:: MTHREAD
 
+   *Dynamic tag*.
     All test cases using more then one poll mode driver thread.
 
 .. topic:: 1NUMA
@@ -592,38 +660,61 @@ Multi-threading tags
 
     All test cases with packet processing on two sockets.
 
-.. topic:: SMT
+.. topic:: 1C
+
+    1 worker thread pinned to 1 dedicated physical core; or if HyperThreading is
+    enabled, 2 worker threads each pinned to a separate logical core within 1
+    dedicated physical core. Main thread pinned to core 1.
 
-    All test cases with symmetric Multi-Threading (HyperThreading) enabled.
+.. topic:: 2C
 
-.. topic:: NOSMT
+    2 worker threads pinned to 2 dedicated physical cores; or if HyperThreading
+    is enabled, 4 worker threads each pinned to a separate logical core within 2
+    dedicated physical cores. Main thread pinned to core 1.
 
-    All test cases with symmetric Multi-Threading (HyperThreading) disabled.
+.. topic:: 4C
+
+    4 worker threads pinned to 4 dedicated physical cores; or if HyperThreading
+    is enabled, 8 worker threads each pinned to a separate logical core within 4
+    dedicated physical cores. Main thread pinned to core 1.
 
 .. topic:: 1T1C
 
+   *Dynamic tag*.
     1 worker thread pinned to 1 dedicated physical core. 1 receive queue per
-    interface. Main thread pinned to core 0.
+    interface. Main thread pinned to core 1.
 
 .. topic:: 2T2C
 
+   *Dynamic tag*.
     2 worker threads pinned to 2 dedicated physical cores. 1 receive queue per
-    interface. Main thread pinned to core 0.
+    interface. Main thread pinned to core 1.
 
 .. topic:: 4T4C
 
+   *Dynamic tag*.
     4 worker threads pinned to 4 dedicated physical cores. 2 receive queues per
-    interface. Main thread pinned to core 0.
+    interface. Main thread pinned to core 1.
+
+.. topic:: 2T1C
+
+   *Dynamic tag*.
+    2 worker threads each pinned to a separate logical core within 1 dedicated
+    physical core. 1 receive queue per interface. Main thread pinned to core 1.
 
-.. topic:: 6T6C
+.. topic:: 4T2C
 
-    6 worker threads pinned to 6 dedicated physical cores. 3 receive queues per
-    interface. Main thread pinned to core 0.
+   *Dynamic tag*.
+    4 worker threads each pinned to a separate logical core within 2 dedicated
+    physical cores. 2 receive queues per interface. Main thread pinned to core
+    1.
 
-.. topic:: 8T8C
+.. topic:: 8T4C
 
-    8 worker threads pinned to 8 dedicated physical cores. 4 receive queues per
-    interface. Main thread pinned to core 0.
+   *Dynamic tag*.
+    8 worker threads each pinned to a separate logical core within 4 dedicated
+    physical cores. 4 receive queues per interface. Main thread pinned to core
+    1.
 
 Honeycomb tags
 --------------