Apply minor improvements to methodology docs
[csit.git] / docs / report / dpdk_performance_tests / overview.rst
index e6abb53..212e202 100644 (file)
@@ -1,20 +1,19 @@
 Overview
 ========
 
 Overview
 ========
 
-For description of physical testbeds used for DPDK performance tests
-please refer to :ref:`tested_physical_topologies`.
-
-.. _tested_logical_topologies:
+DPDK performance test results are reported for all three physical
+testbed types present in FD.io labs: 3-Node Xeon Haswell (3n-hsw),
+3-Node Xeon Skylake (3n-skx), 2-Node Xeon Skylake (2n-skx) and installed
+NIC models. For description of physical testbeds used for DPDK
+performance tests please refer to :ref:`tested_physical_topologies`.
 
 Logical Topologies
 ------------------
 
 CSIT DPDK performance tests are executed on physical testbeds described
 
 Logical Topologies
 ------------------
 
 CSIT DPDK performance tests are executed on physical testbeds described
-in :ref:`tested_physical_topologies`. Based on the packet path thru
-server SUTs, three distinct logical topology types are used for DPDK DUT
-data plane testing:
-
-#. NIC-to-NIC switching topologies.
+in :ref:`tested_physical_topologies`. Based on the packet path through
+server SUTs, one distinct logical topology type is used for DPDK DUT
+data plane testing: NIC-to-NIC switching topology.
 
 NIC-to-NIC Switching
 ~~~~~~~~~~~~~~~~~~~~
 
 NIC-to-NIC Switching
 ~~~~~~~~~~~~~~~~~~~~
@@ -28,9 +27,10 @@ testbeds are shown in figures below.
     .. raw:: latex
 
         \begin{figure}[H]
     .. raw:: latex
 
         \begin{figure}[H]
-        \centering
-            \includesvg[width=0.90\textwidth]{../_tmp/src/vpp_performance_tests/logical-2n-nic2nic}
-            \label{fig:logical-2n-nic2nic}
+            \centering
+                \graphicspath{{../_tmp/src/vpp_performance_tests/}}
+                \includegraphics[width=0.90\textwidth]{logical-2n-nic2nic}
+                \label{fig:logical-2n-nic2nic}
         \end{figure}
 
 .. only:: html
         \end{figure}
 
 .. only:: html
@@ -45,9 +45,10 @@ testbeds are shown in figures below.
     .. raw:: latex
 
         \begin{figure}[H]
     .. raw:: latex
 
         \begin{figure}[H]
-        \centering
-            \includesvg[width=0.90\textwidth]{../_tmp/src/vpp_performance_tests/logical-3n-nic2nic}
-            \label{fig:logical-3n-nic2nic}
+            \centering
+                \graphicspath{{../_tmp/src/vpp_performance_tests/}}
+                \includegraphics[width=0.90\textwidth]{logical-3n-nic2nic}
+                \label{fig:logical-3n-nic2nic}
         \end{figure}
 
 .. only:: html
         \end{figure}
 
 .. only:: html
@@ -56,11 +57,11 @@ testbeds are shown in figures below.
         :alt: logical-3n-nic2nic
         :align: center
 
         :alt: logical-3n-nic2nic
         :align: center
 
-Server Systems Under Test (SUT) runs DPDK Testpmd/L3FWD application in
-Linux user-mode as a Device Under Test (DUT). Server Traffic Generator (TG)
-runs T-Rex application. Physical connectivity between SUTs and TG is provided
-using different drivers and NIC models that need to be tested for performance
-(packet/bandwidth throughput and latency).
+Server Systems Under Test (SUT) run DPDK Testpmd or L3fwd application in
+Linux user-mode as a Device Under Test (DUT). Server Traffic Generator
+(TG) runs T-Rex application. Physical connectivity between SUTs and TG
+is provided using different drivers and NIC models that need to be
+tested for performance (packet/bandwidth throughput and latency).
 
 From SUT and DUT perspectives, all performance tests involve forwarding
 packets between two physical Ethernet ports (10GE, 25GE, 40GE, 100GE).
 
 From SUT and DUT perspectives, all performance tests involve forwarding
 packets between two physical Ethernet ports (10GE, 25GE, 40GE, 100GE).
@@ -98,30 +99,23 @@ topologies and configurations:
   - 100% of discovered NDR throughput.
   - 100% of discovered PDR throughput.
 
   - 100% of discovered NDR throughput.
   - 100% of discovered PDR throughput.
 
-- Maximum Receive Rate (MRR): measure packet forwarding rate under the
+- Maximum Receive Rate (MRR): measured packet forwarding rate under the
   maximum load offered by traffic generator over a set trial duration,
   regardless of packet loss. Maximum load for specified Ethernet frame
   size is set to the bi-directional link rate.
 
   maximum load offered by traffic generator over a set trial duration,
   regardless of packet loss. Maximum load for specified Ethernet frame
   size is set to the bi-directional link rate.
 
-|csit-release| includes following performance test suites, listed per NIC type:
-
-- **L2IntLoop** - L2 Interface Loop forwarding any Ethernet frames between
-  two Interfaces.
-
-- **IPv4 Routed Forwarding** - L3 IP forwarding of Ethernet frames between
-  two Interfaces.
-
-Execution of performance tests takes time, especially the throughput
-tests. Due to limited HW testbed resources available within FD.io labs
-hosted by :abbr:`LF (Linux Foundation)`, the number of tests for some
-NIC models has been limited to few baseline tests.
-
-Performance Tests Naming
-------------------------
-
-FD.io |csit-release| follows a common structured naming convention for
-all performance and system functional tests, introduced in CSIT-17.01.
-
-The naming should be intuitive for majority of the tests. Complete
-description of FD.io CSIT test naming convention is provided on
-:ref:`csit_test_naming`.
+|csit-release| includes following DPDK Testpmd and L3fwd data plane
+functionality performance tested across a range of NIC drivers and NIC
+models:
+
++-----------------------+----------------------------------------------+
+| Functionality         | Description                                  |
++=======================+==============================================+
+| L2IntLoop             | L2 Interface Loop forwarding all Ethernet    |
+|                       | frames between two Interfaces.               |
++-----------------------+----------------------------------------------+
+| IPv4 Routed           | Longest Prefix Match (LPM) L3 IPv4           |
+| Forwarding            | forwarding of Ethernet frames between two    |
+|                       | Interfaces, with two /8 prefixes in lookup   |
+|                       | table.                                       |
++-----------------------+----------------------------------------------+